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