lib/Gitalist/Controller/Root.pm

   1 package Gitalist::Controller::Root;
   2 use Moose;
   3 use namespace::autoclean;
   4
   5 BEGIN { extends 'Catalyst::Controller' }
   6
   7 #
   8 # Sets the actions in this controller to be registered with no prefix
   9 # so they function identically to actions created in MyApp.pm
  10 #
  11 __PACKAGE__->config->{namespace} = '';
  12
  13 =head1 NAME
  14
  15 Gitalist::Controller::Root - Root Controller for Gitalist
  16
  17 =head1 DESCRIPTION
  18
  19 [enter your description here]
  20
  21 =head1 METHODS
  22
  23 =cut
  24
  25 =head2 index
  26
  27 =cut
  28
  29 use IO::Capture::Stdout;
  30
  31 =head2 run_gitweb
  32
  33 The C<gitweb> shim. It should now only be explicitly accessible by
  34 modifying the URL.
  35
  36 =cut
  37
  38 sub run_gitweb {
  39   my ( $self, $c ) = @_;
  40
  41   # XXX A slippery slope to be sure.
  42   if($c->req->param('a')) {
  43     my $capture = IO::Capture::Stdout->new();
  44     $capture->start();
  45     eval {
  46       my $action = gitweb::main($c);
  47       $action->();
  48     };
  49     $capture->stop();
  50
  51     use Data::Dumper;
  52     die Dumper($@)
  53       if $@;
  54
  55     my $output = join '', $capture->read;
  56     $c->stash->{gitweb_output} = $output;
  57     $c->stash->{template} = 'gitweb.tt2';
  58   }
  59 }
  60
  61 sub _get_commit {
  62   my($self, $c, $haveh) = @_;
  63
  64   my $h = $haveh || $c->req->param('h') || '';
  65   my $f = $c->req->param('f');
  66   my $m = $c->model();
  67
  68   # Either use the provided h(ash) parameter, the f(ile) parameter or just use HEAD.
  69   my $hash = ($h =~ /[^a-f0-9]/ ? $m->head_hash($h) : $h)
  70           || ($f && $m->hash_by_path($f))
  71           || $m->head_hash
  72           # XXX This could definitely use more context.
  73           || Carp::croak("Couldn't find a hash for the commit object!");
  74
  75
  76   (my $pd = $m->project_dir( $m->project )) =~ s{/\.git$}();
  77   my $commit = $m->get_object($hash)
  78     or Carp::croak("Couldn't find a commit object for '$hash' in '$pd'!");
  79
  80   return $commit;
  81 }
  82
  83 =head2 index
  84
  85 Provides the project listing.
  86
  87 =cut
  88
  89 sub index :Path :Args(0) {
  90   my ( $self, $c ) = @_;
  91   $c->stash(current_model => 'GitRepos');
  92   # Leave actions up to gitweb at this point.
  93   return $self->run_gitweb($c)
  94     if $c->req->param('a');
  95
  96   my $list = $c->model()->list_projects;
  97   unless(@$list) {
  98     die "No projects found in ". $c->model->repo_dir;
  99   }
 100
 101   $c->stash(
 102     searchtext => $c->req->param('searchtext') || '',
 103     projects   => $list,
 104     action     => 'index',
 105   );
 106 }
 107
 108 =head2 summary
 109
 110 A summary of what's happening in the repo.
 111
 112 =cut
 113
 114 sub summary : Local {
 115   my ( $self, $c ) = @_;
 116
 117   my $commit = $self->_get_commit($c);
 118   $c->stash(
 119     commit    => $commit,
 120     info      => $c->model()->project_info($c->model()->project),
 121     log_lines => [$c->model()->list_revs(
 122       sha1 => $commit->sha1, count => Gitalist->config->{paging}{summary}
 123     )],
 124     refs      => $c->model()->references,
 125     heads     => [$c->model()->heads],
 126     action    => 'summary',
 127   );
 128 }
 129
 130 =head2 heads
 131
 132 The current list of heads (aka branches) in the repo.
 133
 134 =cut
 135
 136 sub heads : Local {
 137   my ( $self, $c ) = @_;
 138
 139   $c->stash(
 140     commit => $self->_get_commit($c),
 141     heads  => [$c->model()->heads],
 142     action => 'heads',
 143   );
 144 }
 145
 146 =head2 blob
 147
 148 The blob action i.e the contents of a file.
 149
 150 =cut
 151
 152 sub blob : Local {
 153   my ( $self, $c ) = @_;
 154
 155   my $h  = $c->req->param('h')
 156        || $c->model()->hash_by_path($c->req->param('f'))
 157        || die "No file or sha1 provided.";
 158   my $hb = $c->req->param('hb')
 159        || $c->model()->head_hash
 160        || die "Couldn't discern the corresponding head.";
 161
 162   my $filename = $c->req->param('f') || '';
 163
 164   $c->stash(
 165     blob     => $c->model()->get_object($h)->content,
 166     head     => $c->model()->get_object($hb),
 167     filename => $filename,
 168     # XXX Hack hack hack, see View::SyntaxHighlight
 169     language => ($filename =~ /\.p[lm]$/ ? 'Perl' : ''),
 170     action   => 'blob',
 171   );
 172
 173   $c->forward('View::SyntaxHighlight');
 174 }
 175
 176 =head2 blobdiff
 177
 178 Exposes a given diff of a blob.
 179
 180 =cut
 181
 182 sub blobdiff : Local {
 183   my ( $self, $c ) = @_;
 184
 185   my $commit = $self->_get_commit($c);
 186   my $filename = $c->req->param('f')
 187               || croak("No file specified!");
 188   my($tree, $patch) = $c->model()->diff(
 189     commit => $commit,
 190     parent => $c->req->param('hp') || '',
 191     file   => $filename,
 192     patch  => 1,
 193   );
 194   $c->stash(
 195     commit    => $commit,
 196     diff      => $patch,
 197     # XXX Hack hack hack, see View::SyntaxHighlight
 198     blobs     => [$patch->[0]->{diff}],
 199     language  => 'Diff',
 200     action    => 'blobdiff',
 201   );
 202
 203   $c->forward('View::SyntaxHighlight');
 204 }
 205
 206 =head2 commit
 207
 208 Exposes a given commit.
 209
 210 =cut
 211
 212 sub commit : Local {
 213   my ( $self, $c ) = @_;
 214
 215   my $commit = $self->_get_commit($c);
 216   $c->stash(
 217       commit      => $commit,
 218       diff_tree   => ($c->model()->diff(commit => $commit))[0],
 219       refs      => $c->model()->references,
 220       action      => 'commit',
 221   );
 222 }
 223
 224 =head2 commitdiff
 225
 226 Exposes a given diff of a commit.
 227
 228 =cut
 229
 230 sub commitdiff : Local {
 231   my ( $self, $c ) = @_;
 232
 233   my $commit = $self->_get_commit($c);
 234   my($tree, $patch) = $c->model()->diff(
 235       commit => $commit,
 236       parent => $c->req->param('hp') || '',
 237       patch  => 1,
 238   );
 239   $c->stash(
 240     commit    => $commit,
 241     diff_tree => $tree,
 242     diff      => $patch,
 243     # XXX Hack hack hack, see View::SyntaxHighlight
 244     blobs     => [map $_->{diff}, @$patch],
 245     language  => 'Diff',
 246     action    => 'commitdiff',
 247   );
 248
 249   $c->forward('View::SyntaxHighlight');
 250 }
 251
 252 =head2 shortlog
 253
 254 Expose an abbreviated log of a given sha1.
 255
 256 =cut
 257
 258 sub shortlog : Local {
 259   my ( $self, $c ) = @_;
 260
 261   my $commit  = $self->_get_commit($c);
 262   my %logargs = (
 263       sha1   => $commit->sha1,
 264       count  => Gitalist->config->{paging}{log},
 265       ($c->req->param('f') ? (file => $c->req->param('f')) : ())
 266   );
 267
 268   my $page = $c->req->param('pg') || 0;
 269   $logargs{skip} = $c->req->param('pg') * $logargs{count}
 270     if $c->req->param('pg');
 271
 272   $c->stash(
 273       commit    => $commit,
 274       log_lines => [$c->model()->list_revs(%logargs)],
 275       refs      => $c->model()->references,
 276       action    => 'shortlog',
 277       page      => $page,
 278   );
 279 }
 280
 281 =head2 log
 282
 283 Calls shortlog internally. Perhaps that should be reversed ...
 284
 285 =cut
 286 sub log : Local {
 287     $_[0]->shortlog($_[1]);
 288     $_[1]->stash->{action} = 'log';
 289 }
 290
 291 =head2 tree
 292
 293 The tree of a given commit.
 294
 295 =cut
 296
 297 sub tree : Local {
 298   my ( $self, $c ) = @_;
 299
 300   my $commit = $self->_get_commit($c, $c->req->param('hb'));
 301   my $tree   = $c->model()->get_object($c->req->param('h') || $commit->tree_sha1);
 302   $c->stash(
 303       # XXX Useful defaults needed ...
 304       commit    => $commit,
 305       tree      => $tree,
 306       tree_list => [$c->model()->list_tree($tree->sha1)],
 307           path      => $c->req->param('f') || '',
 308       action    => 'tree',
 309   );
 310 }
 311
 312 =head2 reflog
 313
 314 Expose the local reflog. This may go away.
 315
 316 =cut
 317
 318 sub reflog : Local {
 319   my ( $self, $c ) = @_;
 320
 321   my @log = $c->model()->reflog(
 322       '--since=yesterday'
 323   );
 324
 325   $c->stash(
 326       log    => \@log,
 327       action => 'reflog',
 328   );
 329 }
 330
 331 sub search : Local {
 332   my($self, $c) = @_;
 333
 334   my $commit  = $self->_get_commit($c);
 335   # Lifted from /shortlog.
 336   my %logargs = (
 337     sha1   => $commit->sha1,
 338     count  => Gitalist->config->{paging}{log},
 339     ($c->req->param('f') ? (file => $c->req->param('f')) : ()),
 340         search => {
 341           type   => $c->req->param('type'),
 342           text   => $c->req->param('text'),
 343           regexp => $c->req->param('regexp') || 0,
 344     }
 345   );
 346
 347   $c->stash(
 348       commit  => $commit,
 349       results => [$c->model()->list_revs(%logargs)],
 350       action  => 'search',
 351           # This could be added - page      => $page,
 352   );
 353 }
 354
 355 sub search_help : Local {
 356     Carp::croak "Not implemented.";
 357 }
 358
 359 =head2 auto
 360
 361 Populate the header and footer. Perhaps not the best location.
 362
 363 =cut
 364
 365 sub auto : Private {
 366   my($self, $c) = @_;
 367
 368   # XXX Move these to a plugin!
 369   $c->stash(
 370     time_since => sub {
 371       return age_string(time - $_[0]->epoch);
 372     },
 373     short_cmt => sub {
 374       my $cmt = shift;
 375       my($line) = split /\n/, $cmt;
 376       $line =~ s/^(.{70,80}\b).*/$1 …/;
 377       return $line;
 378     },
 379   );
 380
 381   # Yes, this is hideous.
 382   $self->header($c);
 383   $self->footer($c);
 384 }
 385
 386 # XXX This could probably be dropped altogether.
 387 use Gitalist::Util qw(to_utf8);
 388 # Formally git_header_html
 389 sub header {
 390   my($self, $c) = @_;
 391
 392   my $title = $c->config->{sitename};
 393
 394   my $project   = $c->req->param('project')  || $c->req->param('p');
 395   my $action    = $c->req->param('action')   || $c->req->param('a');
 396   my $file_name = $c->req->param('filename') || $c->req->param('f');
 397   if(defined $project) {
 398     $title .= " - " . to_utf8($project);
 399     if (defined $action) {
 400       $title .= "/$action";
 401       if (defined $file_name) {
 402         $title .= " - " . $file_name;
 403         if ($action eq "tree" && $file_name !~ m|/$|) {
 404           $title .= "/";
 405         }
 406       }
 407     }
 408   }
 409
 410   $c->stash->{version}     = $c->config->{version};
 411   $c->stash->{git_version} = $c->model()->run_cmd('--version');
 412   $c->stash->{title}       = $title;
 413
 414   #$c->stash->{baseurl} = $ENV{PATH_INFO} && uri_escape($base_url);
 415   $c->stash->{stylesheet} = $c->config->{stylesheet} || 'gitweb.css';
 416
 417   $c->stash->{project} = $project;
 418   my @links;
 419   if($project) {
 420     my %href_params = $self->feed_info($c);
 421     $href_params{'-title'} ||= 'log';
 422
 423     foreach my $format qw(RSS Atom) {
 424       my $type = lc($format);
 425       push @links, {
 426         rel   => 'alternate',
 427         title => "$project - $href_params{'-title'} - $format feed",
 428
 429         # XXX A bit hacky and could do with using gitweb::href() features
 430         href  => "?a=$type;p=$project",
 431         type  => "application/$type+xml"
 432         }, {
 433         rel   => 'alternate',
 434
 435         # XXX This duplication also feels a bit awkward
 436         title => "$project - $href_params{'-title'} - $format feed (no merges)",
 437         href  => "?a=$type;p=$project;opt=--no-merges",
 438         type  => "application/$type+xml"
 439         };
 440     }
 441   } else {
 442     push @links, {
 443       rel => "alternate",
 444       title => $c->config->{sitename}." projects list",
 445       href => '?a=project_index',
 446       type => "text/plain; charset=utf-8"
 447       }, {
 448       rel => "alternate",
 449       title => $c->config->{sitename}." projects feeds",
 450       href => '?a=opml',
 451       type => "text/plain; charset=utf-8"
 452       };
 453   }
 454
 455   $c->stash->{favicon} = $c->config->{favicon};
 456
 457   # </head><body>
 458
 459   $c->stash(
 460     logo_url      => $c->config->{logo_url},
 461     logo_label    => $c->config->{logo_label},
 462     logo_img      => $c->config->{logo},
 463     home_link     => $c->config->{home_link},
 464     home_link_str => $c->config->{home_link_str},
 465     );
 466
 467   if(defined $project) {
 468     $c->stash(
 469       search_text => ( $c->req->param('s') || $c->req->param('searchtext') || ''),
 470       search_hash => ( $c->req->param('hb') || $c->req->param('hashbase')
 471           || $c->req->param('h')  || $c->req->param('hash')
 472           || 'HEAD' ),
 473       );
 474   }
 475 }
 476
 477 # Formally git_footer_html
 478 sub footer {
 479   my($self, $c) = @_;
 480
 481   my $feed_class = 'rss_logo';
 482
 483   my @feeds;
 484   my $project = $c->req->param('project')  || $c->req->param('p');
 485   if(defined $project) {
 486     (my $pstr = $project) =~ s[/?\.git$][];
 487     my $descr = $c->model()->project_info($project)->{description};
 488     $c->stash->{project_description} = defined $descr
 489       ? $descr
 490       : '';
 491
 492     my %href_params = $self->feed_info($c);
 493     if (!%href_params) {
 494       $feed_class .= ' generic';
 495     }
 496     $href_params{'-title'} ||= 'log';
 497
 498     @feeds = [
 499       map +{
 500         class => $feed_class,
 501         title => "$href_params{'-title'} $_ feed",
 502         href  => "/?p=$project;a=\L$_",
 503         name  => lc $_,
 504         }, qw(RSS Atom)
 505       ];
 506   } else {
 507     @feeds = [
 508       map {
 509         class => $feed_class,
 510           title => '',
 511           href  => "/?a=$_->[0]",
 512           name  => $_->[1],
 513         }, [opml=>'OPML'],[project_index=>'TXT'],
 514       ];
 515   }
 516 }
 517
 518 # XXX This feels wrong here, should probably be refactored.
 519 # returns hash to be passed to href to generate gitweb URL
 520 # in -title key it returns description of link
 521 sub feed_info {
 522   my($self, $c) = @_;
 523
 524   my $format = shift || 'Atom';
 525   my %res = (action => lc($format));
 526
 527   # feed links are possible only for project views
 528   return unless $c->req->param('project');
 529
 530   # some views should link to OPML, or to generic project feed,
 531   # or don't have specific feed yet (so they should use generic)
 532   return if $c->req->param('action') =~ /^(?:tags|heads|forks|tag|search)$/x;
 533
 534   my $branch;
 535   my $hash = $c->req->param('h')  || $c->req->param('hash');
 536   my $hash_base = $c->req->param('hb') || $c->req->param('hashbase');
 537
 538   # branches refs uses 'refs/heads/' prefix (fullname) to differentiate
 539   # from tag links; this also makes possible to detect branch links
 540   if ((defined $hash_base && $hash_base =~ m!^refs/heads/(.*)$!) ||
 541     (defined $hash      && $hash      =~ m!^refs/heads/(.*)$!)) {
 542     $branch = $1;
 543   }
 544
 545   # find log type for feed description (title)
 546   my $type = 'log';
 547   my $file_name = $c->req->param('f') || $c->req->param('filename');
 548   if (defined $file_name) {
 549     $type  = "history of $file_name";
 550     $type .= "/" if $c->req->param('action') eq 'tree';
 551     $type .= " on '$branch'" if (defined $branch);
 552   } else {
 553     $type = "log of $branch" if (defined $branch);
 554   }
 555
 556   $res{-title} = $type;
 557   $res{'hash'} = (defined $branch ? "refs/heads/$branch" : undef);
 558   $res{'file_name'} = $file_name;
 559
 560   return %res;
 561 }
 562
 563 =head2 end
 564
 565 Attempt to render a view, if needed.
 566
 567 =cut
 568
 569 sub end : ActionClass('RenderView') {
 570   my ($self, $c) = @_;
 571   # Give project views the current HEAD.
 572   if ($c->stash->{project}) {
 573       $c->stash->{HEAD} = $c->model()->head_hash;
 574   }
 575 }
 576
 577 sub age_string {
 578         my $age = shift;
 579         my $age_str;
 580
 581         if ($age > 60*60*24*365*2) {
 582                 $age_str = (int $age/60/60/24/365);
 583                 $age_str .= " years ago";
 584         } elsif ($age > 60*60*24*(365/12)*2) {
 585                 $age_str = int $age/60/60/24/(365/12);
 586                 $age_str .= " months ago";
 587         } elsif ($age > 60*60*24*7*2) {
 588                 $age_str = int $age/60/60/24/7;
 589                 $age_str .= " weeks ago";
 590         } elsif ($age > 60*60*24*2) {
 591                 $age_str = int $age/60/60/24;
 592                 $age_str .= " days ago";
 593         } elsif ($age > 60*60*2) {
 594                 $age_str = int $age/60/60;
 595                 $age_str .= " hours ago";
 596         } elsif ($age > 60*2) {
 597                 $age_str = int $age/60;
 598                 $age_str .= " min ago";
 599         } elsif ($age > 2) {
 600                 $age_str = int $age;
 601                 $age_str .= " sec ago";
 602         } else {
 603                 $age_str .= " right now";
 604         }
 605         return $age_str;
 606 }
 607
 608 =head1 AUTHOR
 609
 610 Dan Brook
 611
 612 =head1 LICENSE
 613
 614 This library is free software. You can redistribute it and/or modify
 615 it under the same terms as Perl itself.
 616
 617 =cut
 618
 619 __PACKAGE__->meta->make_immutable;