Moved header & footer logic into the templates.
Dan Brook [Fri, 20 Nov 2009 12:03:37 +0000 (12:03 +0000)]
lib/Gitalist/Controller/Root.pm
root/_footer_feeds.tt2 [new file with mode: 0644]
root/_header_feeds.tt2 [new file with mode: 0644]
root/blob.tt2
root/default.tt2
root/heads.tt2
root/nav/search.tt2
root/static/css/site.css
root/tree.tt2
t/03legacy_uri.t

index f04abb0..d295155 100644 (file)
@@ -499,8 +499,22 @@ Populate the header and footer. Perhaps not the best location.
 sub auto : Private {
   my($self, $c) = @_;
 
-  # XXX Move these to a plugin!
+  my $project = $c->req->param('p');
+  if (defined $project) {
+    eval {
+      $c->stash(Project => $c->model('GitRepos')->project($project));
+    };
+    if ($@) {
+      $c->detach('error_404');
+    }
+  }
+
+  my $a_project = $c->stash->{Project} || $c->model()->projects->[0];
   $c->stash(
+    git_version => $a_project->run_cmd('--version'),
+    version     => $Gitalist::VERSION,
+
+    # XXX Move these to a plugin!
     time_since => sub {
       return 'never' unless $_[0];
       return age_string(time - $_[0]->epoch);
@@ -515,193 +529,6 @@ sub auto : Private {
         join(' ', grep { defined } (split / /, shift)[0..10]);
     },
   );
-
-  # Yes, this is hideous.
-  $self->header($c);
-  $self->footer($c);
-}
-
-# XXX This could probably be dropped altogether.
-use Gitalist::Util qw(to_utf8);
-# Formally git_header_html
-sub header {
-  my($self, $c) = @_;
-
-  my $title = $c->config->{sitename};
-
-  my $project   = $c->req->param('project')  || $c->req->param('p');
-  my $action    = $c->req->param('action')   || $c->req->param('a');
-  my $file_name = $c->req->param('filename') || $c->req->param('f');
-  if(defined $project) {
-    $title .= " - " . to_utf8($project);
-    if (defined $action) {
-      $title .= "/$action";
-      if (defined $file_name) {
-        $title .= " - " . $file_name;
-        if ($action eq "tree" && $file_name !~ m|/$|) {
-          $title .= "/";
-        }
-      }
-    }
-  }
-
-  $c->stash->{version}     = $Gitalist::VERSION;
-  # check git's version by running it on the first project in the list.
-  $c->stash->{title}       = $title;
-
-  $c->stash->{stylesheet} = $c->config->{stylesheet} || 'gitweb.css';
-
-  $c->stash->{project} = $project;
-  my @links;
-  if($project) {
-    my %href_params = $self->feed_info($c);
-    $href_params{'-title'} ||= 'log';
-
-    foreach my $format qw(RSS Atom) {
-      my $type = lc($format);
-      push @links, {
-        rel   => 'alternate',
-        title => "$project - $href_params{'-title'} - $format feed",
-
-        # XXX A bit hacky and could do with using gitweb::href() features
-        href  => "?a=$type;p=$project",
-        type  => "application/$type+xml"
-        }, {
-        rel   => 'alternate',
-
-        # XXX This duplication also feels a bit awkward
-        title => "$project - $href_params{'-title'} - $format feed (no merges)",
-        href  => "?a=$type;p=$project;opt=--no-merges",
-        type  => "application/$type+xml"
-        };
-    }
-  } else {
-    push @links, {
-      rel => "alternate",
-      title => $c->config->{sitename}." projects list",
-      href => '?a=project_index',
-      type => "text/plain; charset=utf-8"
-      }, {
-      rel => "alternate",
-      title => $c->config->{sitename}." projects feeds",
-      href => '?a=opml',
-      type => "text/plain; charset=utf-8"
-      };
-  }
-
-  $c->stash->{favicon} = $c->config->{favicon};
-
-  # </head><body>
-
-  $c->stash(
-    logo_url      => $c->config->{logo_url},
-    logo_label    => $c->config->{logo_label},
-    logo_img      => $c->config->{logo},
-    home_link     => $c->config->{home_link},
-    home_link_str => $c->config->{home_link_str},
-    );
-
-  if (defined $project) {
-      eval {
-          $c->stash(Project => $c->model('GitRepos')->project($project));
-      };
-      if ($@) {
-          $c->detach('error_404');
-      }
-      $c->stash(
-          search_text => ( $c->req->param('s') ||
-                               $c->req->param('searchtext') || ''),
-          search_hash => ( $c->req->param('hb') || $c->req->param('hashbase')
-                               || $c->req->param('h')  || $c->req->param('hash')
-                                   || 'HEAD' ),
-      );
-  }
-  my $a_project = $c->stash->{Project} || $c->model()->projects->[0];
-  $c->stash->{git_version} = $a_project->run_cmd('--version');
-}
-
-# Formally git_footer_html
-sub footer {
-  my($self, $c) = @_;
-
-  my $feed_class = 'rss_logo';
-
-  my @feeds;
-  my $project = $c->req->param('project')  || $c->req->param('p');
-  if(defined $project) {
-    (my $pstr = $project) =~ s[/?\.git$][];
-    my $descr = $c->stash->{project_description}
-            = $c->stash->{Project} ? $c->stash->{Project}->description : '';
-
-    my %href_params = $self->feed_info($c);
-    if (!%href_params) {
-      $feed_class .= ' generic';
-    }
-    $href_params{'-title'} ||= 'log';
-
-    @feeds = [
-      map +{
-        class => $feed_class,
-        title => "$href_params{'-title'} $_ feed",
-        href  => "/?p=$project;a=\L$_",
-        name  => lc $_,
-        }, qw(RSS Atom)
-      ];
-  } else {
-    @feeds = [
-      map {
-        class => $feed_class,
-          title => '',
-          href  => "/?a=$_->[0]",
-          name  => $_->[1],
-        }, [opml=>'OPML'],[project_index=>'TXT'],
-      ];
-  }
-}
-
-# XXX This feels wrong here, should probably be refactored.
-# returns hash to be passed to href to generate gitweb URL
-# in -title key it returns description of link
-sub feed_info {
-  my($self, $c) = @_;
-
-  my $format = shift || 'Atom';
-  my %res = (action => lc($format));
-
-  # feed links are possible only for project views
-  return unless $c->req->param('project');
-
-  # some views should link to OPML, or to generic project feed,
-  # or don't have specific feed yet (so they should use generic)
-  return if $c->req->param('action') =~ /^(?:tags|heads|forks|tag|search)$/x;
-
-  my $branch;
-  my $hash = $c->req->param('h')  || $c->req->param('hash');
-  my $hash_base = $c->req->param('hb') || $c->req->param('hashbase');
-
-  # branches refs uses 'refs/heads/' prefix (fullname) to differentiate
-  # from tag links; this also makes possible to detect branch links
-  if ((defined $hash_base && $hash_base =~ m!^refs/heads/(.*)$!) ||
-    (defined $hash      && $hash      =~ m!^refs/heads/(.*)$!)) {
-    $branch = $1;
-  }
-
-  # find log type for feed description (title)
-  my $type = 'log';
-  my $file_name = $c->req->param('f') || $c->req->param('filename');
-  if (defined $file_name) {
-    $type  = "history of $file_name";
-    $type .= "/" if $c->req->param('action') eq 'tree';
-    $type .= " on '$branch'" if (defined $branch);
-  } else {
-    $type = "log of $branch" if (defined $branch);
-  }
-
-  $res{-title} = $type;
-  $res{'hash'} = (defined $branch ? "refs/heads/$branch" : undef);
-  $res{'file_name'} = $file_name;
-
-  return %res;
 }
 
 =head2 end
@@ -728,36 +555,44 @@ sub error_404 :Private {
 }
 
 sub age_string {
-       my $age = shift;
-       my $age_str;
-
-       if ($age > 60*60*24*365*2) {
-               $age_str = (int $age/60/60/24/365);
-               $age_str .= " years ago";
-       } elsif ($age > 60*60*24*(365/12)*2) {
-               $age_str = int $age/60/60/24/(365/12);
-               $age_str .= " months ago";
-       } elsif ($age > 60*60*24*7*2) {
-               $age_str = int $age/60/60/24/7;
-               $age_str .= " weeks ago";
-       } elsif ($age > 60*60*24*2) {
-               $age_str = int $age/60/60/24;
-               $age_str .= " days ago";
-       } elsif ($age > 60*60*2) {
-               $age_str = int $age/60/60;
-               $age_str .= " hours ago";
-       } elsif ($age > 60*2) {
-               $age_str = int $age/60;
-               $age_str .= " min ago";
-       } elsif ($age > 2) {
-               $age_str = int $age;
-               $age_str .= " sec ago";
-       } else {
-               $age_str .= " right now";
-       }
-       return $age_str;
+  my $age = shift;
+  my $age_str;
+
+  if ( $age > 60 * 60 * 24 * 365 * 2 ) {
+    $age_str  = ( int $age / 60 / 60 / 24 / 365 );
+    $age_str .= " years ago";
+  }
+  elsif ( $age > 60 * 60 * 24 * ( 365 / 12 ) * 2 ) {
+    $age_str  = int $age / 60 / 60 / 24 / ( 365 / 12 );
+    $age_str .= " months ago";
+  }
+  elsif ( $age > 60 * 60 * 24 * 7 * 2 ) {
+    $age_str  = int $age / 60 / 60 / 24 / 7;
+    $age_str .= " weeks ago";
+  }
+  elsif ( $age > 60 * 60 * 24 * 2 ) {
+    $age_str  = int $age / 60 / 60 / 24;
+    $age_str .= " days ago";
+  }
+  elsif ( $age > 60 * 60 * 2 ) {
+    $age_str  = int $age / 60 / 60;
+    $age_str .= " hours ago";
+  }
+  elsif ( $age > 60 * 2 ) {
+    $age_str  = int $age / 60;
+    $age_str .= " min ago";
+  }
+  elsif ( $age > 2 ) {
+    $age_str  = int $age;
+    $age_str .= " sec ago";
+  }
+  else {
+    $age_str .= " right now";
+  }
+  return $age_str;
 }
 
+
 =head1 AUTHOR
 
 Dan Brook
diff --git a/root/_footer_feeds.tt2 b/root/_footer_feeds.tt2
new file mode 100644 (file)
index 0000000..0e50cf8
--- /dev/null
@@ -0,0 +1,32 @@
+  [% IF Project %]
+    [%-
+      has_branch = c.req.param('h').match('^(refs/heads/.*)') || c.req.param('hb').match('^(refs/heads/.*)');
+      branch     = has_branch.0 || '';
+      feed_title = 'log';
+      feed_fn    = c.req.param('f');
+      IF feed_fn;
+        title = 'history of ' _ c.req.param('filename');
+        title = title _ (branch ? ' on ' _ branch : '');
+      ELSE;
+        title = title _ (branch ? ' of ' _ branch : '');
+      END;
+
+      feed_args = { h = branch || c.req.param('h') || c.req.param('hb') || 'HEAD' };
+      IF feed_fn; feed_args.f = feed_fn; END;
+    -%]
+    <a
+      class="rss_logo"
+      title="[% feed_title %]"
+      href="[% c.uri_for('rss', feed_args) %]">RSS</a>
+    <a
+      class="rss_logo"
+      title="[% feed_title %]"
+      href="[% c.uri_for('atom', feed_args) %]">Atom</a>
+  [% ELSE %]
+    <a
+      class="rss_logo"
+      href="[% c.uri_for('opml') %]">OPML</a>
+    <a
+      class="rss_logo"
+      href="[% c.uri_for('project_index') %]">TXT</a>
+  [% END %]
diff --git a/root/_header_feeds.tt2 b/root/_header_feeds.tt2
new file mode 100644 (file)
index 0000000..5982b16
--- /dev/null
@@ -0,0 +1,28 @@
+  [% IF Project %]
+  <!-- XXX Missing the no-merges links -->
+  <link
+    rel="alternate"
+    title="[% Project.name %] - [% title %] Atom feed"
+    href="[% c.uri_for('atom') %]"
+    type="application/atom+xml"
+  >
+  <link
+    rel="alternate"
+    title="[% Project.name %] - [% title %] RSS feed"
+    href="[% c.uri_for('rss') %]"
+    type="application/rss+xml"
+  >
+  [% ELSE %]
+  <link
+    rel="alternate"
+    title="[% c.config.sitename %] Git projects list"
+    href="[% c.uri_for('project_index') %]"
+    type="text/plain; charset=utf-8"
+  > 
+  <link
+    rel="alternate"
+    title="[% c.config.sitename %] Git projects feeds"
+    href="[% c.uri_for('opml') %]"
+    type="text/x-opml"
+  >
+  [% END %]
index 4798ee1..3a49fed 100644 (file)
@@ -7,7 +7,7 @@
 </div>
 [% END %]
 <div class='path'>
- <a href="[% c.uri_for("tree", {hb=head.sha1}) %]">[% project %]</a>
+ <a href="[% c.uri_for("tree", {hb=head.sha1}) %]">[% Project.name %]</a>
  [% # XXX The last part should link to blob_plain (or something) but doesn't ATM
     FOREACH part IN filename.split('/') %]
  / <a href="[% c.uri_for("tree", {hb=head.sha1}) %]">[% part %]</a>
index 9043219..af0ed15 100644 (file)
@@ -7,23 +7,24 @@
   <meta charset="utf-8">
   <meta name="generator" content="gitweb/[% version %] git/[% git_version %][% mod_perl_version %]"/>
   <meta name="robots" content="index, nofollow"/>
-  <title>[% title | html %] (Gitalist)</title>
-  [% IF baseurl %]
-  <base href="[% baseurl %]">
-  [% END %]
+  <title>[%-
+    title = BLOCK;
+      c.config.sitename;
+      IF Project; ' - ' _ Project.name | html; END;
+      IF action;  ' / ' _ action; END;
+      IF filename; ' - ' _ filename | html; END;
+      IF action && action == 'tree'; '/'; END;
+    END;
+    title;
+  -%] (Gitalist)</title>
+  [% INCLUDE '_header_feeds.tt2' %]
   <link rel="stylesheet" href="[% c.uri_for('/static/css/blueprint/screen.css') %]" type="text/css" media="screen, projection">
   <link rel="stylesheet" href="[% c.uri_for('/static/css/blueprint/print.css') %]" type="text/css" media="print">
   <!--[if lt IE 8]>
     <link rel="stylesheet" href="[% c.uri_for('/static/css/blueprint/ie.css') %]" type="text/css" media="screen, projection">
   <![endif]-->  
   <link rel="stylesheet" type="text/css" href="[% c.uri_for('/static/css/site.css') %]">
-  [% FOR link IN links %]
-  <link rel="[% link.rel %]" title="[% link.title %]" href="[% link.href %]" type="[% link.type %]" >
-  [% END %]
-  [% IF favicon %]
-  <link rel="shortcut icon" href="[% favicon %]" type="image/png">
-  [% END %]
+  <link rel="shortcut icon" href="[% c.uri_for('git-favicon.png') %]" type="image/png">
 </head>
 
 <body>
 [% site_header %]
 
 <div id="page-header">
-  <a title="[% logo_label | url %]" href="[% logo_url | url %]">
-   <img src="logo.png" alt="git" class="logo">
+  <a title="git homepage" href="http://git-scm.org">
+   <img src="[% c.uri_for('/logo.png') %]" alt="git" class="logo">
   </a>
-  <a href="[% home_link | url %]">[% home_link_str %]</a>
-  [%- IF project %]
-  / <a href="[% c.uri_for('summary') %]">[% project %]</a>
+  <a href="[% c.uri_for('/') %]">A Gitalist</a>
+  [%- IF Project %]
+  / <a href="[% c.uri_for('summary') %]">[% Project.name %]</a>
   [% IF action;  " / " _ action; END;
   END %]
 [%
-  IF project;
+  IF Project;
     INCLUDE 'nav/search.tt2';
   END;
 # / git_header_html
 %]
 </div>
 
-[%- # git_footer_html
--%]
 <div id="page-footer">
-[% IF project AND project_description %]
-  <div class="page_footer_text">[% project_description | html %]</div>
-[% END %]
-[% FOR feed IN feeds %]
-    <a class="[% feed.class %]" title="[% feed.title %]" href="[% feed.href %]">[% feed.name %]</a>
+[% IF Project %]
+  [% Project.description | html %]
 [% END %]
+[% INCLUDE '_footer_feeds.tt2' %]
 </div>
 
-[% site_footer %]
-
 </body>
 </html>
 [%- END -%]
index 86c8cec..5161cbd 100644 (file)
@@ -1,7 +1,7 @@
 [% INCLUDE 'nav/actions.tt2' object = commit %]
 
 <div>
-[% project %]
+[% Project.name %]
 </div>
 
 [% INCLUDE '_heads.tt2' %]
index 09f30e4..42aeaea 100644 (file)
@@ -1,6 +1,6 @@
 <div id="page-search">
   <form method="get" action="[% c.uri_for('search') %]" enctype="application/x-www-form-urlencoded">
-  <input name="p" type="hidden" value="[% project %]" />
+  <input name="p" type="hidden" value="[% Project.name %]" />
   <input name="a" type="hidden" value="search" />
   <input name="h" type="hidden" value="[% commit.sha1 %]" />
   <input name="f" type="hidden" value="[% c.req.param('f') %]" />
@@ -12,8 +12,8 @@
       <option value="grep">grep</option>
       <option value="pickaxe">pickaxe</option>
       -->
-  </select><sup><a href="/search_help?p=[% project %]">?</a></sup> search:
-  <input type="text" name="text" value="[% search_text %]"/>
+  </select><sup><a href="[% c.uri_for('search_help') %]">?</a></sup> search:
+  <input type="text" name="text" value="[% c.req.param('s') %]"/>
   <span title="Extended regular expression"><label><input type="checkbox" name="regexp" value="1" />re</label></span>
   </form>
 </div>
index 36be7dd..69b14c8 100644 (file)
@@ -232,3 +232,23 @@ span.refs span.head {
 span.refs a {
   text-decoration: none;
 }
+
+a.rss_logo {
+       float: right;
+       padding: 3px 0px;
+       width: 35px;
+       line-height: 10px;
+       border: 1px solid;
+       border-color: #fcc7a5 #7d3302 #3e1a01 #ff954e;
+       color: #ffffff;
+       background-color: #ff6600;
+       font-weight: bold;
+       font-family: sans-serif;
+       font-size: 70%;
+       text-align: center;
+       text-decoration: none;
+}
+
+a.rss_logo:hover {
+       background-color: #ee5500;
+}
index a69a6fa..b82a117 100644 (file)
@@ -6,7 +6,7 @@
 
 [% IF path -%]
 <div>
- <a href='[% c.uri_for("tree", {hb=commit.sha1}) %]'>[% project %]</a>
+ <a href='[% c.uri_for("tree", {hb=commit.sha1}) %]'>[% Project.name %]</a>
  [% fullpath = ''-%]
  [% FOREACH part IN path.split('/') -%]
  / <a href='[% c.uri_for("tree", {h=tree.sha1, hb=commit.sha1, f=fullpath _ part}) %]'>[% part %]</a>
index 35b86fe..a2722a1 100644 (file)
@@ -232,6 +232,19 @@ test('/', 'a=rss;h=refs/heads/master');
 test('/', 'a=rss;h=refs/heads/master;opt=--no-merges');
 test('/', 'a=rss;opt=--no-merges');
 
+TODO: {
+  local $TODO = 'The project_index action is yet to be implemented';
+  test('/', 'a=project_index');
+}
+TODO: {
+  local $TODO = 'The opml action is yet to be implemented';
+  test('/', 'a=opml');
+}
+TODO: {
+  local $TODO = 'The tags action is yet to be implemented';
+  test('/', 'a=tags');
+}
+
 done_testing;
 
 sub test_uri {