Skip to content

Commit

Permalink
Merge branch 'jn/ctags-more'
Browse files Browse the repository at this point in the history 
* jn/ctags-more:
  gitweb: Optional grouping of projects by category
  gitweb: Modularized git_get_project_description to be more generic
  gitweb: Split git_project_list_body in two functions
  • Loading branch information
Junio C Hamano committed May 26, 2011
2 parents 0a2a5d8 + d940c90 commit 229e72d
Show file tree
Hide file tree
Showing 4 changed files with 152 additions and 46 deletions.
16 changes: 16 additions & 0 deletions gitweb/README
View file
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,15 @@ not include variables usually directly set during build):
full description is available as 'title' attribute (usually shown on
mouseover). By default set to 25, which might be too small if you
use long project descriptions.
* $projects_list_group_categories
Enables the grouping of projects by category on the project list page.
The category of a project is determined by the $GIT_DIR/category
file or the 'gitweb.category' variable in its repository configuration.
Disabled by default.
* $project_list_default_category
Default category for projects for which none is specified. If set
to the empty string, such projects will remain uncategorized and
listed at the top, above categorized projects.
* @git_base_url_list
List of git base URLs used for URL to where fetch project from, shown
in project summary page. Full URL is "$git_base_url/$project".
Expand Down Expand Up @@ -314,6 +323,13 @@ You can use the following files in repository:
from the template during repository creation. You can use the
gitweb.description repo configuration variable, but the file takes
precedence.
* category (or gitweb.category)
Singe line category of a project, used to group projects if
$projects_list_group_categories is enabled. By default (file and
configuration variable absent), uncategorized projects are put in
the $project_list_default_category category. You can use the
gitweb.category repo configuration variable, but the file takes
precedence.
* cloneurl (or multiple-valued gitweb.url)
File with repository URL (used for clone and fetch), one per line.
Displayed in the project summary page. You can use multiple-valued
Expand Down
167 changes: 121 additions & 46 deletions gitweb/gitweb.perl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,14 @@ sub evaluate_uri {
# the width (in characters) of the projects list "Description" column
our $projects_list_description_width = 25;

# group projects by category on the projects list
# (enabled if this variable evaluates to true)
our $projects_list_group_categories = 0;

# default category if none specified
# (leave the empty string for no category)
our $project_list_default_category = "";

# default order of projects list
# valid values are none, project, descr, owner, and age
our $default_projects_order = "project";
Expand Down Expand Up @@ -2574,20 +2582,34 @@ sub git_get_path_by_hash {
## ......................................................................
## git utility functions, directly accessing git repository

sub git_get_project_description {
my $path = shift;
# get the value of config variable either from file named as the variable
# itself in the repository ($GIT_DIR/$name file), or from gitweb.$name
# configuration variable in the repository config file.
sub git_get_file_or_project_config {
my ($path, $name) = @_;

$git_dir = "$projectroot/$path";
open my $fd, '<', "$git_dir/description"
or return git_get_project_config('description');
my $descr = <$fd>;
open my $fd, '<', "$git_dir/$name"
or return git_get_project_config($name);
my $conf = <$fd>;
close $fd;
if (defined $descr) {
chomp $descr;
if (defined $conf) {
chomp $conf;
}
return $descr;
return $conf;
}

sub git_get_project_description {
my $path = shift;
return git_get_file_or_project_config($path, 'description');
}

sub git_get_project_category {
my $path = shift;
return git_get_file_or_project_config($path, 'category');
}


# supported formats:
# * $GIT_DIR/ctags/<tagname> file (in 'ctags' subdirectory)
# - if its contents is a number, use it as tag weight,
Expand Down Expand Up @@ -4881,8 +4903,9 @@ sub git_patchset_body {

# . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

# fills project list info (age, description, owner, forks) for each
# project in the list, removing invalid projects from returned list
# fills project list info (age, description, owner, category, forks)
# for each project in the list, removing invalid projects from
# returned list
# NOTE: modifies $projlist, but does not remove entries from it
sub fill_project_list_info {
my $projlist = shift;
Expand All @@ -4908,6 +4931,12 @@ sub fill_project_list_info {
if ($show_ctags) {
$pr->{'ctags'} = git_get_project_ctags($pr->{'path'});
}
if ($projects_list_group_categories && !defined $pr->{'category'}) {
my $cat = git_get_project_category($pr->{'path'}) ||
$project_list_default_category;
$pr->{'category'} = to_utf8($cat);
}

push @projects, $pr;
}

Expand Down Expand Up @@ -4935,6 +4964,23 @@ sub sort_projects_list {
return @projects;
}

# returns a hash of categories, containing the list of project
# belonging to each category
sub build_projlist_by_category {
my ($projlist, $from, $to) = @_;
my %categories;

$from = 0 unless defined $from;
$to = $#$projlist if (!defined $to || $#$projlist < $to);

for (my $i = $from; $i <= $to; $i++) {
my $pr = $projlist->[$i];
push @{$categories{ $pr->{'category'} }}, $pr;
}

return wantarray ? %categories : \%categories;
}

# print 'sort by' <th> element, generating 'sort by $name' replay link
# if that order is not selected
sub print_sort_th {
Expand All @@ -4958,6 +5004,55 @@ sub format_sort_th {
return $sort_th;
}

sub git_project_list_rows {
my ($projlist, $from, $to, $check_forks) = @_;

$from = 0 unless defined $from;
$to = $#$projlist if (!defined $to || $#$projlist < $to);

my $alternate = 1;
for (my $i = $from; $i <= $to; $i++) {
my $pr = $projlist->[$i];

if ($alternate) {
print "<tr class=\"dark\">\n";
} else {
print "<tr class=\"light\">\n";
}
$alternate ^= 1;

if ($check_forks) {
print "<td>";
if ($pr->{'forks'}) {
my $nforks = scalar @{$pr->{'forks'}};
if ($nforks > 0) {
print $cgi->a({-href => href(project=>$pr->{'path'}, action=>"forks"),
-title => "$nforks forks"}, "+");
} else {
print $cgi->span({-title => "$nforks forks"}, "+");
}
}
print "</td>\n";
}
print "<td>" . $cgi->a({-href => href(project=>$pr->{'path'}, action=>"summary"),
-class => "list"}, esc_html($pr->{'path'})) . "</td>\n" .
"<td>" . $cgi->a({-href => href(project=>$pr->{'path'}, action=>"summary"),
-class => "list", -title => $pr->{'descr_long'}},
esc_html($pr->{'descr'})) . "</td>\n" .
"<td><i>" . chop_and_escape_str($pr->{'owner'}, 15) . "</i></td>\n";
print "<td class=\"". age_class($pr->{'age'}) . "\">" .
(defined $pr->{'age_string'} ? $pr->{'age_string'} : "No commits") . "</td>\n" .
"<td class=\"link\">" .
$cgi->a({-href => href(project=>$pr->{'path'}, action=>"summary")}, "summary") . " | " .
$cgi->a({-href => href(project=>$pr->{'path'}, action=>"shortlog")}, "shortlog") . " | " .
$cgi->a({-href => href(project=>$pr->{'path'}, action=>"log")}, "log") . " | " .
$cgi->a({-href => href(project=>$pr->{'path'}, action=>"tree")}, "tree") .
($pr->{'forks'} ? " | " . $cgi->a({-href => href(project=>$pr->{'path'}, action=>"forks")}, "forks") : '') .
"</td>\n" .
"</tr>\n";
}
}

sub git_project_list_body {
# actually uses global variable $project
my ($projlist, $order, $from, $to, $extra, $no_header) = @_;
Expand Down Expand Up @@ -5013,47 +5108,27 @@ sub git_project_list_body {
print "<th></th>\n" . # for links
"</tr>\n";
}
my $alternate = 1;
for (my $i = $from; $i <= $to; $i++) {
my $pr = $projects[$i];

if ($alternate) {
print "<tr class=\"dark\">\n";
} else {
print "<tr class=\"light\">\n";
}
$alternate ^= 1;

if ($check_forks) {
print "<td>";
if ($pr->{'forks'}) {
my $nforks = scalar @{$pr->{'forks'}};
if ($nforks > 0) {
print $cgi->a({-href => href(project=>$pr->{'path'}, action=>"forks"),
-title => "$nforks forks"}, "+");
} else {
print $cgi->span({-title => "$nforks forks"}, "+");
if ($projects_list_group_categories) {
# only display categories with projects in the $from-$to window
@projects = sort {$a->{'category'} cmp $b->{'category'}} @projects[$from..$to];
my %categories = build_projlist_by_category(\@projects, $from, $to);
foreach my $cat (sort keys %categories) {
unless ($cat eq "") {
print "<tr>\n";
if ($check_forks) {
print "<td></td>\n";
}
print "<td class=\"category\" colspan=\"5\">".esc_html($cat)."</td>\n";
print "</tr>\n";
}
print "</td>\n";

git_project_list_rows($categories{$cat}, undef, undef, $check_forks);
}
print "<td>" . $cgi->a({-href => href(project=>$pr->{'path'}, action=>"summary"),
-class => "list"}, esc_html($pr->{'path'})) . "</td>\n" .
"<td>" . $cgi->a({-href => href(project=>$pr->{'path'}, action=>"summary"),
-class => "list", -title => $pr->{'descr_long'}},
esc_html($pr->{'descr'})) . "</td>\n" .
"<td><i>" . chop_and_escape_str($pr->{'owner'}, 15) . "</i></td>\n";
print "<td class=\"". age_class($pr->{'age'}) . "\">" .
(defined $pr->{'age_string'} ? $pr->{'age_string'} : "No commits") . "</td>\n" .
"<td class=\"link\">" .
$cgi->a({-href => href(project=>$pr->{'path'}, action=>"summary")}, "summary") . " | " .
$cgi->a({-href => href(project=>$pr->{'path'}, action=>"shortlog")}, "shortlog") . " | " .
$cgi->a({-href => href(project=>$pr->{'path'}, action=>"log")}, "log") . " | " .
$cgi->a({-href => href(project=>$pr->{'path'}, action=>"tree")}, "tree") .
($pr->{'forks'} ? " | " . $cgi->a({-href => href(project=>$pr->{'path'}, action=>"forks")}, "forks") : '') .
"</td>\n" .
"</tr>\n";
} else {
git_project_list_rows(\@projects, $from, $to, $check_forks);
}

if (defined $extra) {
print "<tr>\n";
if ($check_forks) {
Expand Down
7 changes: 7 additions & 0 deletions gitweb/static/gitweb.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -295,6 +295,13 @@ td.current_head {
text-decoration: underline;
}

td.category {
background-color: #d9d8d1;
border-top: 1px solid #000000;
border-left: 1px solid #000000;
font-weight: bold;
}

table.diff_tree span.file_status.new {
color: #008000;
}
Expand Down
8 changes: 8 additions & 0 deletions t/t9500-gitweb-standalone-no-errors.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -644,4 +644,12 @@ test_expect_success \
'ctags: search projects by non existent tag' \
'gitweb_run "by_tag=non-existent"'

# ----------------------------------------------------------------------
# categories

test_expect_success \
'categories: projects list, only default category' \
'echo "\$projects_list_group_categories = 1;" >>gitweb_config.perl &&
gitweb_run'

test_done

0 comments on commit 229e72d

Please sign in to comment.