From: Jakub Narebski <jnareb@gmail.com>
To: git@vger.kernel.org
Cc: John 'Warthog9' Hawley <warthog9@kernel.org>,
Petr Baudis <pasky@ucw.cz>,
admin@repo.or.cz, Jakub Narebski <jnareb@gmail.com>
Subject: [RFC PATCHv5 19/17] gitweb: Add beginnings of cache administration page
Date: Thu, 7 Oct 2010 00:02:04 +0200 [thread overview]
Message-ID: <1286402526-13143-20-git-send-email-jnareb@gmail.com> (raw)
In-Reply-To: <1286402526-13143-1-git-send-email-jnareb@gmail.com>
Currently it shows estimated size of cache, and provides link to
clearing cache.
Cache administration page is visible only on local computer; the same
is true with respect to ability to clear cache. Those are bare
beginnings of autorization framework.
Signed-off-by: Jakub Narebski <jnareb@gmail.com>
---
Differences from v4:
* action_is_cacheable() (is_cacheable() in previous version) now uses
%actions_info hash.
* Adding actions related to gitweb cache administration is now done in
configure_caching() subroutine.
* cache_admin_auth_ok() now returns true also for running gitweb as
script, when REMOTE_ADDR environment variable is not define. It
also covers situation where non-standard (not in RFC 3875)
SERVER_ADDR is not defined.
This is "frontend" (interface) patch for gitweb cache management.
This is very much work in progress, sent to git mailing list as a
proof of concept. Would something like that (perhaps with more
advanced authorization for admin) be useful?
The 'cache' page looks like this:
Cache location Size
------------------+---------+--------------
cache/gitweb 14 KiB [Clear cache]
------------------+---------+--------------
where '[Clear cache]' is a submit button.
gitweb/gitweb.perl | 119 ++++++++++++++++++++++++++++++++++++++++++++++++++--
1 files changed, 115 insertions(+), 4 deletions(-)
diff --git a/gitweb/gitweb.perl b/gitweb/gitweb.perl
index fee8739..c413797 100755
--- a/gitweb/gitweb.perl
+++ b/gitweb/gitweb.perl
@@ -24,6 +24,8 @@ use Encode;
use Fcntl qw(:mode :flock);
use File::Find qw();
use File::Basename qw(basename);
+use POSIX;
+
binmode STDOUT, ':utf8';
our $t0;
@@ -851,6 +853,10 @@ sub evaluate_actions_info {
map { $actions_info{$_}{'output_format'} = undef }
qw(blob_plain object);
$actions_info{'snapshot'}{'output_format'} = 'binary';
+
+ # specify uncacheable actions
+ map { $actions_info{$_}{'uncacheable'} = 1 }
+ qw(cache clear_cache);
}
sub action_outputs_html {
@@ -858,6 +864,11 @@ sub action_outputs_html {
return $actions_info{$action}{'output_format'} eq 'html';
}
+sub action_is_cacheable {
+ my $action = shift;
+ return !$actions_info{$action}{'uncacheable'};
+}
+
# fill %input_params with the CGI parameters. All values except for 'opt'
# should be single values, but opt can be an array. We should probably
# build an array of parameters that can be multi-valued, but since for the time
@@ -1178,12 +1189,13 @@ sub dispatch {
if (!defined($actions{$action})) {
die_error(400, "Unknown action");
}
- if ($action !~ m/^(?:opml|project_list|project_index)$/ &&
+ if ($action !~ m/^(?:opml|project_list|project_index|cache|clear_cache)$/ &&
!$project) {
die_error(400, "Project needed");
}
- if ($caching_enabled) {
+ if ($caching_enabled &&
+ action_is_cacheable($action)) {
# human readable key identifying gitweb output
my $output_key = href(-replay => 1, -full => 1, -path_info => 0);
@@ -1204,11 +1216,11 @@ sub run_request {
evaluate_uri();
evaluate_gitweb_config();
- evaluate_actions_info();
evaluate_git_version();
check_loadavg();
configure_caching()
if ($caching_enabled);
+ evaluate_actions_info();
# $projectroot and $projects_list might be set in gitweb config file
$projects_list ||= $projectroot;
@@ -1311,6 +1323,10 @@ sub configure_caching {
'depth' => $cache_options{'cache_depth'},
});
}
+
+ # some actions are available only if cache is turned on
+ $actions{'cache'} = \&git_cache_admin;
+ $actions{'clear_cache'} = \&git_cache_clear;
}
run();
@@ -3673,7 +3689,7 @@ sub git_header_html {
my $expires = shift;
my %opts = @_;
- my $title = get_page_title();
+ my $title = $opts{'-title'} || get_page_title();
my $content_type;
# require explicit support from the UA if we are to send the page as
# 'application/xhtml+xml', otherwise send it as plain old 'text/html'.
@@ -7325,3 +7341,98 @@ XML
</opml>
XML
}
+
+# see Number::Bytes::Human
+sub human_readable_size {
+ my $bytes = shift || return;
+
+ my @units = ('', 'KiB', 'MiB', 'GiB', 'TiB');
+ my $block = 1024;
+
+ my $x = $bytes;
+ my $unit;
+ foreach (@units) {
+ $unit = $_, last if POSIX::ceil($x) < $block;
+ $x /= $block;
+ }
+
+ my $num;
+ if ($x < 10.0) {
+ $num = sprintf("%.1f", POSIX::ceil($x*10)/10);
+ } else {
+ $num = sprintf("%d", POSIX::ceil($x));
+ }
+
+ return "$num $unit";
+}
+
+sub cache_admin_auth_ok {
+ if (defined $ENV{'REMOTE_ADDR'}) {
+ if (defined $ENV{'SERVER_ADDR'}) {
+ # SERVER_ADDR is not in RFC 3875
+ return $ENV{'SERVER_ADDR'} eq $ENV{'REMOTE_ADDR'};
+ } elsif ($ENV{'REMOTE_ADDR'} =~ m!^(?:127\.0\.0\.1|::1/128)$!) {
+ # localhost in IPv4 or IPv6
+ return 1;
+ }
+ } else {
+ # REMOTE_ADDR not defined, probably calling gitweb as script
+ return 1;
+ }
+
+ # restrict all but specified cases
+ return 0;
+}
+
+sub git_cache_admin {
+ $caching_enabled
+ or die_error(403, "Caching disabled");
+ cache_admin_auth_ok()
+ or die_error(403, "Cache administration not allowed");
+ $cache && ref($cache)
+ or die_error(500, "Cache is not present");
+
+ git_header_html(undef, undef,
+ -title => to_utf8($site_name) . " - Gitweb cache");
+
+ print <<'EOF_HTML';
+<table class="cache_admin">
+<tr><th>Cache location</th><th>Size</th><th> </th></tr>
+EOF_HTML
+ print '<tr class="light">' .
+ '<td class="path">' . esc_path($cache->path_to_namespace()) . '</td>' .
+ '<td>';
+ my $size;
+ $size = $cache->size() if (!defined $size && $cache->can('size'));
+ $size = $cache->get_size() if (!defined $size && $cache->can('get_size'));
+ if (defined $size) {
+ print human_readable_size($size);
+ }
+ print '</td><td>';
+ if ($cache->can('clear')) {
+ print $cgi->start_form({-method => "POST",
+ -action => $my_uri,
+ -enctype => CGI::URL_ENCODED}) .
+ $cgi->input({-name=>"a", -value=>"clear_cache", -type=>"hidden"}) .
+ $cgi->submit({-label => 'Clear cache'}) .
+ $cgi->end_form();
+ }
+ print <<'EOF_HTML';
+</td></tr>
+</table>
+EOF_HTML
+
+ git_footer_html();
+}
+
+sub git_cache_clear {
+ if (cache_admin_auth_ok() && $cache &&
+ $cgi->request_method() eq 'POST') {
+
+ $cache->clear();
+ }
+
+ #print "cleared";
+ print $cgi->redirect(-uri => href(action=>'cache', -full=>1),
+ -status => '303 See Other');
+}
--
1.7.3
next prev parent reply other threads:[~2010-10-06 22:04 UTC|newest]
Thread overview: 41+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-10-06 22:01 [PATCHv5 00/17] gitweb: Simple file based output caching Jakub Narebski
2010-10-06 22:01 ` [PATCHv5 01/17] t/test-lib.sh: Export also GIT_BUILD_DIR in test_external Jakub Narebski
2010-10-06 22:01 ` [PATCHv5 02/17] gitweb: Prepare for splitting gitweb Jakub Narebski
2010-10-06 22:01 ` [PATCHv5 03/17] gitweb/lib - Very simple file based cache Jakub Narebski
2010-10-06 22:41 ` Thomas Adam
2010-10-06 22:44 ` Ævar Arnfjörð Bjarmason
2010-10-06 22:46 ` Thomas Adam
2010-10-06 22:47 ` Ævar Arnfjörð Bjarmason
2010-10-06 23:00 ` Jakub Narebski
2010-10-06 23:12 ` Thomas Adam
2010-10-06 23:32 ` Jakub Narebski
2010-10-06 22:57 ` Ævar Arnfjörð Bjarmason
2010-10-06 23:46 ` Jakub Narebski
2010-10-06 22:01 ` [PATCHv5 04/17] gitweb/lib - Stat-based cache expiration Jakub Narebski
2010-10-06 22:01 ` [PATCHv5 05/17] gitweb/lib - Regenerate entry if the cache file has size of 0 Jakub Narebski
2010-10-06 22:01 ` [PATCHv5 06/17] gitweb/lib - Simple select(FH) based output capture Jakub Narebski
2010-10-06 22:52 ` Thomas Adam
2010-10-06 23:22 ` Jakub Narebski
2010-10-06 23:03 ` Ævar Arnfjörð Bjarmason
2010-10-06 23:26 ` Jakub Narebski
2010-10-06 22:01 ` [PATCHv5 07/17] gitweb/lib - Cache captured output (using get/set) Jakub Narebski
2010-10-06 22:01 ` [PATCHv5 08/17] gitweb: Add optional output caching Jakub Narebski
2010-10-06 22:46 ` Ævar Arnfjörð Bjarmason
2010-10-06 23:06 ` Jakub Narebski
2010-10-06 23:16 ` Ævar Arnfjörð Bjarmason
2010-10-06 22:01 ` [PATCHv5 09/17] gitweb/lib - Adaptive cache expiration time Jakub Narebski
2010-10-06 22:01 ` [PATCHv5 10/21] gitweb/lib - Use CHI compatibile (compute method) caching interface Jakub Narebski
2010-10-06 22:01 ` [PATCHv5 11/17] gitweb/lib - Use locking to avoid 'cache miss stampede' problem Jakub Narebski
2010-10-06 22:01 ` [PATCHv5 12/17] gitweb/lib - No need for File::Temp when locking Jakub Narebski
2010-10-06 22:01 ` [PATCHv5 13/17] gitweb/lib - Serve stale data when waiting for filling cache Jakub Narebski
2010-10-06 22:01 ` [PATCHv5 14/17] gitweb/lib - Regenerate (refresh) cache in background Jakub Narebski
2010-10-06 22:02 ` [PATCHv5 15/17] gitweb: Introduce %actions_info, gathering information about actions Jakub Narebski
2010-10-06 22:02 ` [PATCHv5/RFC 16/17] gitweb: Show appropriate "Generating..." page when regenerating cache Jakub Narebski
2010-10-06 22:02 ` [PATCHv5/RFC 17/17] gitweb: Add startup delay to activity indicator for cache Jakub Narebski
2010-10-06 22:02 ` [RFC/PATCHv5 18/17] gitweb/lib - Add clear() and size() methods to caching interface Jakub Narebski
2010-10-06 22:56 ` Thomas Adam
2010-10-06 22:02 ` Jakub Narebski [this message]
2010-10-06 22:02 ` [PoC PATCHv5 20/17] gitweb/lib - Benchmarking GitwebCache::SimpleFileCache (in t/9603/) Jakub Narebski
2010-10-06 22:02 ` [PoC PATCHv5 21/17] gitweb/lib - Alternate ways of capturing output Jakub Narebski
2010-10-10 20:32 ` [RFD] Possible improvements for output caching in gitweb Jakub Narebski
2010-10-24 21:34 ` [PATCHv5 00/17] gitweb: Simple file based output caching J.H.
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1286402526-13143-20-git-send-email-jnareb@gmail.com \
--to=jnareb@gmail.com \
--cc=admin@repo.or.cz \
--cc=git@vger.kernel.org \
--cc=pasky@ucw.cz \
--cc=warthog9@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).