Added a first cut of the /atom action.
[catagits/Gitalist.git] / lib / Gitalist / Controller / Root.pm
CommitLineData
89de6a33 1package Gitalist::Controller::Root;
42fe5d11 2use Moose;
3use namespace::autoclean;
89de6a33 4
42fe5d11 5BEGIN { extends 'Catalyst::Controller' }
89de6a33 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
d17ce39c 13use IO::Capture::Stdout;
14use XML::Atom::Feed;
15use XML::Atom::Entry;
16use Sys::Hostname ();
17
89de6a33 18=head1 NAME
19
20Gitalist::Controller::Root - Root Controller for Gitalist
21
22=head1 DESCRIPTION
23
24[enter your description here]
25
26=head1 METHODS
27
28=cut
29
30=head2 index
31
32=cut
33
1625cd5f 34=head2 run_gitweb
35
f71a83ab 36The C<gitweb> shim. It should now only be explicitly accessible by
37modifying the URL.
1625cd5f 38
39=cut
40
e66db0fb 41sub run_gitweb {
86382b95 42 my ( $self, $c ) = @_;
43
e66db0fb 44 # XXX A slippery slope to be sure.
45 if($c->req->param('a')) {
46 my $capture = IO::Capture::Stdout->new();
47 $capture->start();
48 eval {
49 my $action = gitweb::main($c);
50 $action->();
51 };
52 $capture->stop();
5a2f0948 53
e66db0fb 54 use Data::Dumper;
55 die Dumper($@)
56 if $@;
5a2f0948 57
e66db0fb 58 my $output = join '', $capture->read;
59 $c->stash->{gitweb_output} = $output;
60 $c->stash->{template} = 'gitweb.tt2';
61 }
86382b95 62}
63
832cbc81 64sub _get_object {
b4b4d0fd 65 my($self, $c, $haveh) = @_;
9dc3b9a5 66
c1f608c8 67 my $h = $haveh || $c->req->param('h') || '';
0ee97fec 68 my $f = $c->req->param('f');
8dbe8024 69
1aad4e81 70 my $m = $c->stash->{Project};
71 my $pd = $m->path;
0ee97fec 72
9dc3b9a5 73 # Either use the provided h(ash) parameter, the f(ile) parameter or just use HEAD.
a7cc1ede 74 my $hash = ($h =~ /[^a-f0-9]/ ? $m->head_hash($h) : $h)
75 || ($f && $m->hash_by_path($f))
76 || $m->head_hash
9dc3b9a5 77 # XXX This could definitely use more context.
78 || Carp::croak("Couldn't find a hash for the commit object!");
79
a7cc1ede 80 my $commit = $m->get_object($hash)
81 or Carp::croak("Couldn't find a commit object for '$hash' in '$pd'!");
9dc3b9a5 82
83 return $commit;
84}
85
1625cd5f 86=head2 index
87
88Provides the project listing.
89
90=cut
91
86382b95 92sub index :Path :Args(0) {
7bc165b3 93 my ( $self, $c ) = @_;
94
95 $c->detach($c->req->param('a'))
96 if $c->req->param('a');
97
98 my @list = @{ $c->model()->projects };
99 die 'No projects found in '. $c->model->repo_dir
100 unless @list;
101
102 my $search = $c->req->param('s') || '';
103 if($search) {
104 @list = grep {
105 index($_->name, $search) > -1
106 or ( $_->description !~ /^Unnamed repository/ and index($_->description, $search) > -1 )
107 } @list
108 }
109
110 $c->stash(
111 search_text => $search,
112 projects => \@list,
113 action => 'index',
114 );
04d1d917 115}
116
790ce598 117=head2 summary
118
119A summary of what's happening in the repo.
120
121=cut
122
123sub summary : Local {
124 my ( $self, $c ) = @_;
b47ae2c0 125 my $project = $c->stash->{Project};
3bbb1202 126 $c->detach('error_404') unless $project;
832cbc81 127 my $commit = $self->_get_object($c);
c65cccc2 128 my @heads = @{$project->heads};
06281e11 129 my $maxitems = Gitalist->config->{paging}{summary} || 10;
790ce598 130 $c->stash(
131 commit => $commit,
4111e151 132 log_lines => [$project->list_revs(
133 sha1 => $commit->sha1,
06281e11 134 count => $maxitems,
fde5091f 135 )],
4111e151 136 refs => $project->references,
0969b411 137 heads => [ @heads[0 .. ($#heads < $maxitems ? $#heads : $maxitems)] ],
790ce598 138 action => 'summary',
06281e11 139 );
790ce598 140}
141
142=head2 heads
143
144The current list of heads (aka branches) in the repo.
145
146=cut
147
148sub heads : Local {
149 my ( $self, $c ) = @_;
b47ae2c0 150 my $project = $c->stash->{Project};
790ce598 151 $c->stash(
832cbc81 152 commit => $self->_get_object($c),
c65cccc2 153 heads => $project->heads,
790ce598 154 action => 'heads',
155 );
156}
157
1625cd5f 158=head2 blob
159
160The blob action i.e the contents of a file.
161
162=cut
163
295c9703 164sub blob : Local {
165 my ( $self, $c ) = @_;
8bb7649b 166 my $project = $c->stash->{Project};
c8870bd3 167 my $h = $c->req->param('h')
8bb7649b 168 || $project->hash_by_path($c->req->param('hb'), $c->req->param('f'))
c8870bd3 169 || die "No file or sha1 provided.";
170 my $hb = $c->req->param('hb')
8bb7649b 171 || $project->head_hash
c8870bd3 172 || die "Couldn't discern the corresponding head.";
173
f5da8e7a 174 my $filename = $c->req->param('f') || '';
175
295c9703 176 $c->stash(
77b5d22c 177 blob => $project->get_object($h)->content,
8bb7649b 178 head => $project->get_object($hb),
f5da8e7a 179 filename => $filename,
180 # XXX Hack hack hack, see View::SyntaxHighlight
181 language => ($filename =~ /\.p[lm]$/ ? 'Perl' : ''),
c8870bd3 182 action => 'blob',
295c9703 183 );
7e54e579 184
c8a42dd5 185 $c->forward('View::SyntaxHighlight')
186 unless $c->stash->{no_wrapper};
187}
188
189sub blob_plain : Local {
190 my($self, $c) = @_;
191
192 $c->stash(no_wrapper => 1);
193 $c->response->content_type('text/plain; charset=utf-8');
194
195 $c->forward('blob');
196}
197
198sub blobdiff_plain : Local {
199 my($self, $c) = @_;
200
201 $c->stash(no_wrapper => 1);
202 $c->response->content_type('text/plain; charset=utf-8');
203
204 $c->forward('blobdiff');
205
295c9703 206}
207
6cf4366a 208=head2 blobdiff
209
210Exposes a given diff of a blob.
211
212=cut
213
214sub blobdiff : Local {
215 my ( $self, $c ) = @_;
832cbc81 216 my $commit = $self->_get_object($c, $c->req->param('hb'));
6cf4366a 217 my $filename = $c->req->param('f')
218 || croak("No file specified!");
6cfcd548 219 my($tree, $patch) = $c->stash->{Project}->diff(
ad8884fc 220 commit => $commit,
ad8884fc 221 patch => 1,
c8a42dd5 222 parent => $c->req->param('hpb') || undef,
223 file => $filename,
6cf4366a 224 );
225 $c->stash(
226 commit => $commit,
ad8884fc 227 diff => $patch,
6cf4366a 228 # XXX Hack hack hack, see View::SyntaxHighlight
ad8884fc 229 blobs => [$patch->[0]->{diff}],
6cf4366a 230 language => 'Diff',
231 action => 'blobdiff',
232 );
233
c8a42dd5 234 $c->forward('View::SyntaxHighlight')
235 unless $c->stash->{no_wrapper};
6cf4366a 236}
237
1625cd5f 238=head2 commit
239
47495599 240Exposes a given commit.
1625cd5f 241
242=cut
243
1feb3d6b 244sub commit : Local {
d7c9a32f 245 my ( $self, $c ) = @_;
77edf882 246 my $project = $c->stash->{Project};
832cbc81 247 my $commit = $self->_get_object($c);
b7aca93a 248 $c->stash(
790ce598 249 commit => $commit,
77edf882 250 diff_tree => ($project->diff(commit => $commit))[0],
251 refs => $project->references,
790ce598 252 action => 'commit',
b7aca93a 253 );
d7c9a32f 254}
255
2247133f 256=head2 commitdiff
257
258Exposes a given diff of a commit.
259
260=cut
261
262sub commitdiff : Local {
263 my ( $self, $c ) = @_;
832cbc81 264 my $commit = $self->_get_object($c);
fc948aee 265 my($tree, $patch) = $c->stash->{Project}->diff(
ad8884fc 266 commit => $commit,
fc948aee 267 parent => $c->req->param('hp') || undef,
ad8884fc 268 patch => 1,
269 );
2247133f 270 $c->stash(
f5da8e7a 271 commit => $commit,
ad8884fc 272 diff_tree => $tree,
273 diff => $patch,
f5da8e7a 274 # XXX Hack hack hack, see View::SyntaxHighlight
ad8884fc 275 blobs => [map $_->{diff}, @$patch],
f5da8e7a 276 language => 'Diff',
277 action => 'commitdiff',
2247133f 278 );
f5da8e7a 279
c8a42dd5 280 $c->forward('View::SyntaxHighlight')
281 unless $c->stash->{no_wrapper};
282}
283
284sub commitdiff_plain : Local {
285 my($self, $c) = @_;
286
287 $c->stash(no_wrapper => 1);
288 $c->response->content_type('text/plain; charset=utf-8');
289
290 $c->forward('commitdiff');
2247133f 291}
292
47495599 293=head2 shortlog
294
295Expose an abbreviated log of a given sha1.
296
297=cut
298
299sub shortlog : Local {
300 my ( $self, $c ) = @_;
f740f8a9 301 my $project = $c->stash->{Project};
832cbc81 302 my $commit = $self->_get_object($c);
fde5091f 303 my %logargs = (
304 sha1 => $commit->sha1,
f740f8a9 305 count => Gitalist->config->{paging}{log} || 25,
63e220b9 306 ($c->req->param('f') ? (file => $c->req->param('f')) : ())
307 );
fde5091f 308
309 my $page = $c->req->param('pg') || 0;
310 $logargs{skip} = $c->req->param('pg') * $logargs{count}
311 if $c->req->param('pg');
312
47495599 313 $c->stash(
790ce598 314 commit => $commit,
f740f8a9 315 log_lines => [$project->list_revs(%logargs)],
316 refs => $project->references,
790ce598 317 action => 'shortlog',
b4b4d0fd 318 page => $page,
47495599 319 );
320}
321
790ce598 322=head2 log
323
324Calls shortlog internally. Perhaps that should be reversed ...
325
326=cut
327sub log : Local {
328 $_[0]->shortlog($_[1]);
329 $_[1]->stash->{action} = 'log';
330}
331
c8a42dd5 332# For legacy support.
333sub history : Local {
334 $_[0]->shortlog(@_[1 .. $#_]);
335}
336
b3fa97cd 337=head2 tree
338
339The tree of a given commit.
340
341=cut
342
343sub tree : Local {
344 my ( $self, $c ) = @_;
74af77a3 345 my $project = $c->stash->{Project};
832cbc81 346 my $commit = $self->_get_object($c, $c->req->param('hb'));
347 my $tree = $self->_get_object($c, $c->req->param('h') || $commit->tree_sha1);
b3fa97cd 348 $c->stash(
790ce598 349 commit => $commit,
b4b4d0fd 350 tree => $tree,
74af77a3 351 tree_list => [$project->list_tree($tree->sha1)],
832cbc81 352 path => $c->req->param('f') || '',
790ce598 353 action => 'tree',
b3fa97cd 354 );
355}
356
9dc3b9a5 357=head2 reflog
358
359Expose the local reflog. This may go away.
360
361=cut
362
363sub reflog : Local {
364 my ( $self, $c ) = @_;
d8abdf1c 365 my @log = $c->stash->{Project}->reflog(
9dc3b9a5 366 '--since=yesterday'
367 );
368
369 $c->stash(
370 log => \@log,
371 action => 'reflog',
372 );
373}
374
14664e1c 375sub search : Local {
4df2f62f 376 my($self, $c) = @_;
d8abdf1c 377 $c->stash(current_action => 'GitRepos');
378 my $project = $c->stash->{Project};
832cbc81 379 my $commit = $self->_get_object($c);
4df2f62f 380 # Lifted from /shortlog.
381 my %logargs = (
382 sha1 => $commit->sha1,
383 count => Gitalist->config->{paging}{log},
384 ($c->req->param('f') ? (file => $c->req->param('f')) : ()),
385 search => {
386 type => $c->req->param('type'),
387 text => $c->req->param('text'),
388 regexp => $c->req->param('regexp') || 0,
389 }
390 );
391
392 $c->stash(
393 commit => $commit,
d8abdf1c 394 results => [$project->list_revs(%logargs)],
4df2f62f 395 action => 'search',
396 # This could be added - page => $page,
397 );
14664e1c 398}
399
d17ce39c 400sub atom : Local {
401 my($self, $c) = @_;
402
403 my $feed = XML::Atom::Feed->new;
404
405 my $host = lc Sys::Hostname::hostname();
406 $feed->title($host . ' - ' . Gitalist->config->{name});
407 $feed->updated(~~DateTime->now);
408
409 my $project = $c->stash->{Project};
410 my %logargs = (
411 sha1 => $project->head_hash,
412 count => Gitalist->config->{paging}{log} || 25,
413 ($c->req->param('f') ? (file => $c->req->param('f')) : ())
414 );
415
416 my $mk_title = $c->stash->{short_cmt};
417 for my $commit ($project->list_revs(%logargs)) {
418 my $entry = XML::Atom::Entry->new;
419 $entry->title( $mk_title->($commit->comment) );
420 $entry->id($c->uri_for('commit', {h=>$commit->sha1}));
421 # XXX Needs work ...
422 $entry->content($commit->comment);
423 $feed->add_entry($entry);
424 }
425
426 $c->stash(
427 feed => $feed->as_xml,
428 no_wrapper => 1,
429 );
6cfcd548 430}
431
d17ce39c 432sub search_help : Local {
433 # FIXME - implement search_help
6cfcd548 434 Carp::croak "Not implemented.";
435}
436
437sub rss : Local {
438 # FIXME - implement rss
439 Carp::croak "Not implemented.";
440}
441
6cfcd548 442sub patch : Local {
443 # FIXME - implement patches
444 Carp::croak "Not implemented.";
445}
446
447sub patches : Local {
448 # FIXME - implement patches
449 Carp::croak "Not implemented.";
450}
451
452sub snapshot : Local {
453 # FIXME - implement snapshot
454 Carp::croak "Not implemented.";
455}
456
1625cd5f 457=head2 auto
458
459Populate the header and footer. Perhaps not the best location.
460
461=cut
462
04d1d917 463sub auto : Private {
4621ecf0 464 my($self, $c) = @_;
04d1d917 465
4621ecf0 466 # XXX Move these to a plugin!
467 $c->stash(
468 time_since => sub {
ef11b09e 469 return 'never' unless $_[0];
4621ecf0 470 return age_string(time - $_[0]->epoch);
471 },
472 short_cmt => sub {
473 my $cmt = shift;
474 my($line) = split /\n/, $cmt;
475 $line =~ s/^(.{70,80}\b).*/$1 …/;
476 return $line;
477 },
5cd9b9f9 478 abridged_description => sub {
479 join(' ', grep { defined } (split / /, shift)[0..10]);
480 },
4621ecf0 481 );
482
483 # Yes, this is hideous.
484 $self->header($c);
485 $self->footer($c);
04d1d917 486}
487
c5065c66 488# XXX This could probably be dropped altogether.
04d1d917 489use Gitalist::Util qw(to_utf8);
04d1d917 490# Formally git_header_html
491sub header {
492 my($self, $c) = @_;
493
c5065c66 494 my $title = $c->config->{sitename};
04d1d917 495
496 my $project = $c->req->param('project') || $c->req->param('p');
497 my $action = $c->req->param('action') || $c->req->param('a');
498 my $file_name = $c->req->param('filename') || $c->req->param('f');
c5065c66 499 if(defined $project) {
500 $title .= " - " . to_utf8($project);
501 if (defined $action) {
502 $title .= "/$action";
503 if (defined $file_name) {
504 $title .= " - " . $file_name;
505 if ($action eq "tree" && $file_name !~ m|/$|) {
506 $title .= "/";
507 }
508 }
509 }
510 }
511
1aad4e81 512 $c->stash->{version} = $Gitalist::VERSION;
a54e6cb0 513 # check git's version by running it on the first project in the list.
c5065c66 514 $c->stash->{title} = $title;
04d1d917 515
c5065c66 516 $c->stash->{stylesheet} = $c->config->{stylesheet} || 'gitweb.css';
04d1d917 517
c5065c66 518 $c->stash->{project} = $project;
04d1d917 519 my @links;
c5065c66 520 if($project) {
521 my %href_params = $self->feed_info($c);
522 $href_params{'-title'} ||= 'log';
04d1d917 523
c5065c66 524 foreach my $format qw(RSS Atom) {
525 my $type = lc($format);
04d1d917 526 push @links, {
c5065c66 527 rel => 'alternate',
528 title => "$project - $href_params{'-title'} - $format feed",
529
530 # XXX A bit hacky and could do with using gitweb::href() features
531 href => "?a=$type;p=$project",
532 type => "application/$type+xml"
04d1d917 533 }, {
c5065c66 534 rel => 'alternate',
535
536 # XXX This duplication also feels a bit awkward
537 title => "$project - $href_params{'-title'} - $format feed (no merges)",
538 href => "?a=$type;p=$project;opt=--no-merges",
539 type => "application/$type+xml"
04d1d917 540 };
c5065c66 541 }
542 } else {
04d1d917 543 push @links, {
c5065c66 544 rel => "alternate",
545 title => $c->config->{sitename}." projects list",
546 href => '?a=project_index',
547 type => "text/plain; charset=utf-8"
548 }, {
549 rel => "alternate",
550 title => $c->config->{sitename}." projects feeds",
551 href => '?a=opml',
552 type => "text/plain; charset=utf-8"
553 };
554 }
04d1d917 555
c5065c66 556 $c->stash->{favicon} = $c->config->{favicon};
04d1d917 557
c5065c66 558 # </head><body>
86382b95 559
c5065c66 560 $c->stash(
561 logo_url => $c->config->{logo_url},
562 logo_label => $c->config->{logo_label},
563 logo_img => $c->config->{logo},
564 home_link => $c->config->{home_link},
04d1d917 565 home_link_str => $c->config->{home_link_str},
c5065c66 566 );
04d1d917 567
3bbb1202 568 if (defined $project) {
569 eval {
570 $c->stash(Project => $c->model('GitRepos')->project($project));
571 };
572 if ($@) {
573 $c->detach('error_404');
574 }
b47ae2c0 575 $c->stash(
576 search_text => ( $c->req->param('s') ||
577 $c->req->param('searchtext') || ''),
578 search_hash => ( $c->req->param('hb') || $c->req->param('hashbase')
579 || $c->req->param('h') || $c->req->param('hash')
580 || 'HEAD' ),
c5065c66 581 );
582 }
6bb7c4dd 583 my $a_project = $c->stash->{Project} || $c->model()->projects->[0];
584 $c->stash->{git_version} = $a_project->run_cmd('--version');
04d1d917 585}
586
587# Formally git_footer_html
588sub footer {
589 my($self, $c) = @_;
590
c5065c66 591 my $feed_class = 'rss_logo';
04d1d917 592
593 my @feeds;
594 my $project = $c->req->param('project') || $c->req->param('p');
c5065c66 595 if(defined $project) {
d5cc37a4 596 (my $pstr = $project) =~ s[/?\.git$][];
c66193fb 597 my $descr = $c->stash->{project_description}
598 = $c->stash->{Project} ? $c->stash->{Project}->description : '';
04d1d917 599
c5065c66 600 my %href_params = $self->feed_info($c);
601 if (!%href_params) {
602 $feed_class .= ' generic';
603 }
604 $href_params{'-title'} ||= 'log';
04d1d917 605
606 @feeds = [
607 map +{
608 class => $feed_class,
609 title => "$href_params{'-title'} $_ feed",
610 href => "/?p=$project;a=\L$_",
611 name => lc $_,
c5065c66 612 }, qw(RSS Atom)
613 ];
614 } else {
04d1d917 615 @feeds = [
616 map {
617 class => $feed_class,
c5065c66 618 title => '',
619 href => "/?a=$_->[0]",
620 name => $_->[1],
621 }, [opml=>'OPML'],[project_index=>'TXT'],
622 ];
623 }
89de6a33 624}
625
04d1d917 626# XXX This feels wrong here, should probably be refactored.
627# returns hash to be passed to href to generate gitweb URL
628# in -title key it returns description of link
629sub feed_info {
630 my($self, $c) = @_;
631
c5065c66 632 my $format = shift || 'Atom';
633 my %res = (action => lc($format));
04d1d917 634
c5065c66 635 # feed links are possible only for project views
636 return unless $c->req->param('project');
04d1d917 637
c5065c66 638 # some views should link to OPML, or to generic project feed,
639 # or don't have specific feed yet (so they should use generic)
640 return if $c->req->param('action') =~ /^(?:tags|heads|forks|tag|search)$/x;
641
642 my $branch;
04d1d917 643 my $hash = $c->req->param('h') || $c->req->param('hash');
644 my $hash_base = $c->req->param('hb') || $c->req->param('hashbase');
c5065c66 645
646 # branches refs uses 'refs/heads/' prefix (fullname) to differentiate
647 # from tag links; this also makes possible to detect branch links
648 if ((defined $hash_base && $hash_base =~ m!^refs/heads/(.*)$!) ||
649 (defined $hash && $hash =~ m!^refs/heads/(.*)$!)) {
650 $branch = $1;
651 }
652
653 # find log type for feed description (title)
654 my $type = 'log';
04d1d917 655 my $file_name = $c->req->param('f') || $c->req->param('filename');
c5065c66 656 if (defined $file_name) {
657 $type = "history of $file_name";
658 $type .= "/" if $c->req->param('action') eq 'tree';
659 $type .= " on '$branch'" if (defined $branch);
660 } else {
661 $type = "log of $branch" if (defined $branch);
662 }
663
664 $res{-title} = $type;
665 $res{'hash'} = (defined $branch ? "refs/heads/$branch" : undef);
666 $res{'file_name'} = $file_name;
667
668 return %res;
04d1d917 669}
d9a9b56b 670
89de6a33 671=head2 end
672
673Attempt to render a view, if needed.
674
675=cut
676
fde5091f 677sub end : ActionClass('RenderView') {
1aad4e81 678 my ($self, $c) = @_;
679 # Give project views the current HEAD.
680 if ($c->stash->{Project}) {
681 $c->stash->{HEAD} = $c->stash->{Project}->head_hash;
682 }
1fd8159c 683}
d9a9b56b 684
4111e151 685sub error_404 :Private {
686 my ($self, $c) = @_;
687 $c->response->status(404);
688 $c->stash(
689 title => 'Page not found',
690 content => 'Page not found',
1aad4e81 691 );
4111e151 692}
693
1fd8159c 694sub age_string {
695 my $age = shift;
696 my $age_str;
697
698 if ($age > 60*60*24*365*2) {
699 $age_str = (int $age/60/60/24/365);
700 $age_str .= " years ago";
701 } elsif ($age > 60*60*24*(365/12)*2) {
702 $age_str = int $age/60/60/24/(365/12);
703 $age_str .= " months ago";
704 } elsif ($age > 60*60*24*7*2) {
705 $age_str = int $age/60/60/24/7;
706 $age_str .= " weeks ago";
707 } elsif ($age > 60*60*24*2) {
708 $age_str = int $age/60/60/24;
709 $age_str .= " days ago";
710 } elsif ($age > 60*60*2) {
711 $age_str = int $age/60/60;
712 $age_str .= " hours ago";
713 } elsif ($age > 60*2) {
714 $age_str = int $age/60;
715 $age_str .= " min ago";
716 } elsif ($age > 2) {
717 $age_str = int $age;
718 $age_str .= " sec ago";
719 } else {
720 $age_str .= " right now";
721 }
722 return $age_str;
7a88ffa4 723}
724
89de6a33 725=head1 AUTHOR
726
f71a83ab 727Dan Brook
89de6a33 728
729=head1 LICENSE
730
731This library is free software. You can redistribute it and/or modify
732it under the same terms as Perl itself.
733
734=cut
735
42fe5d11 736__PACKAGE__->meta->make_immutable;