lib/Gitalist.pm

   1 package Gitalist;
   2 use Moose;
   3 BEGIN { require 5.008006; }
   4 use Catalyst::Runtime 5.80;
   5 use namespace::autoclean;
   6
   7 extends 'Catalyst';
   8
   9 use Catalyst qw/
  10                 ConfigLoader
  11                 Unicode::Encoding
  12                 Static::Simple
  13                 StackTrace
  14                 SubRequest
  15 /;
  16
  17 our $VERSION = '0.003004';
  18 $VERSION = eval $VERSION;
  19
  20 __PACKAGE__->config(
  21     name => 'Gitalist',
  22     default_view => 'Default',
  23     default_model => 'CollectionOfRepos',
  24     use_request_uri_for_path => 1,
  25     disable_component_resolution_regex_fallback => 1,
  26 );
  27
  28 __PACKAGE__->setup();
  29
  30 after prepare_path => sub {
  31     my ($ctx) = @_;
  32     my $path = $ctx->req->uri->path;
  33     if ($ctx->req->param('a')) {
  34         $ctx->req->uri->path("/legacy$path");
  35     }
  36
  37     if($path =~ s/[.]json$// && $ctx->req->content_type eq 'application/json') {
  38         $ctx->req->uri->path($path);
  39     }
  40 };
  41
  42 around uri_for => sub {
  43   my ($orig, $c) = (shift, shift);
  44   my $uri = $c->$orig(@_);
  45   $$uri =~ tr[&][;] if defined $uri;
  46   return $uri;
  47 };
  48
  49 sub uri_with {
  50   my ($self, @args) = @_;
  51   my $uri = $self->request->uri_with(@args);
  52   # Wow this awful.
  53   $uri =~ s[/fragment\b][];
  54   return $uri;
  55 }
  56
  57 1;
  58
  59 __END__
  60
  61 =encoding UTF-8
  62
  63 =head1 NAME
  64
  65 Gitalist - A modern git web viewer
  66
  67 =head1 SYNOPSIS
  68
  69     perl script/gitalist_server.pl --repo_dir /home/me/code/git
  70
  71 =head1 INSTALL
  72
  73 As Gitalist follows the usual Perl module format the usual approach
  74 for installation should work, e.g.:
  75
  76     perl Makefile.PL
  77     make
  78     make test
  79     make install
  80
  81 or
  82
  83     cpan -i Gitalist
  84
  85 You can also L<check Gitalist out from its git repository|/"GETTING GITALIST">
  86 and run it, in this case you'll additionally need the author modules,
  87 but no configuration will be needed as it will default to looking
  88 for repositories the directory above the checkout.
  89
  90 =head1 DESCRIPTION
  91
  92 Gitalist is a web frontend for git repositories based on
  93 L<gitweb.cgi|https://git.wiki.kernel.org/index.php/Gitweb> and backed by
  94 L<Catalyst>.
  95
  96 =head2 History
  97
  98 This project started off as an attempt to port I<gitweb.cgi> to a
  99 Catalyst app in a piecemeal fashion. As it turns out, thanks largely
 100 to Florian Ragwitz's earlier effort, it was easier to use I<gitweb.cgi>
 101 as a template for building a new Catalyst application.
 102
 103 =head1 GETTING GITALIST
 104
 105 You can install Gitalist from CPAN in the usual way:
 106
 107     cpan -i Gitalist
 108
 109 Alternatively, you can get Gitalist using git.
 110
 111 The canonical repository for the master branch is:
 112
 113     git://git.shadowcat.co.uk/catagits/Gitalist.git
 114
 115 Gitalist is also mirrored to GitHub at L<https://github.com/broquaint/Gitalist>,
 116 and a number of people have active forks
 117 with branches and/or new features in the master branch.
 118
 119 =head1 BOOTSTRAPPING
 120
 121 As of C<0.002001> Gitalist can now be bootstrapped to run out of its
 122 own directory by installing its prerequisites locally with the help of
 123 L<local::lib>. So instead of installing the prerequisites to the
 124 system path with CPAN they are installed under the Gitalist directory.
 125
 126 To do this clone Gitalist from the L<Shadowcat repository mentioned
 127 above|/"GETTING GITALIST"> or grab a snapshot from broquaint's GitHub repository:
 128
 129     https://github.com/broquaint/Gitalist/downloads
 130
 131 With the source acquired and unpacked run the following from within the
 132 Gitalist directory:
 133
 134     perl script/bootstrap.pl
 135
 136 This will install the necessary modules for the build process which in
 137 turn installs the prerequisites locally.
 138
 139 B<NB:> The relevant bootstrap scripts aren't available in the CPAN dist
 140 as the bootstrap scripts should not be installed.
 141
 142 =head1 INITIAL CONFIGURATION
 143
 144 Gitalist is configured using L<Catalyst::Plugin::Configloader>. The supplied sample
 145 configuration is in L<Config::General> format, however it is possible to configure
 146 Gitalist using other config file formats (such as YAML) if you prefer.
 147
 148 =head2 WHEN CHECKING GITALIST OUT OF GIT
 149
 150 Gitalist from git includes a minimal C<gitalist_local.conf>, which sets the repository
 151 directory to one directory higher than the Gitalist repository.
 152
 153 This means that if you check Gitalist out next to your other git checkouts, then starting
 154 the demo server needs no parameters at all:
 155
 156     Gitalist [master]$ perl script/gitalist_server.pl
 157     You can connect to your server at http://localhost:3000
 158
 159 =head2 FOR CPAN INSTALLS
 160
 161 Gitalist can be supplied with a config file by setting the C<< GITALIST_CONFIG >>
 162 environment variable to point to a configuration file.
 163
 164 If you install Gitalist from CPAN, a default configuration is installed along with gitalist,
 165 which is complete except for a repository directory. You can get a copy of this configuration
 166 by running:
 167
 168   cp `perl -Ilib -MGitalist -e'print Gitalist->path_to("gitalist.conf")'` gitalist.conf
 169
 170 You can then edit this configuration, adding a C<repo_dir> path and customising
 171 other settings as desired.
 172
 173 You can then start the Gitalist demo server by setting C<< GITALIST_CONFIG >>. For example:
 174
 175     GITALIST_CONFIG=/usr/local/etc/gitalist.conf gitalist_server.pl
 176
 177 Alternatively, if you only want to set a repository directory and are otherwise happy with
 178 the default configuration, then you can set the C<< GITALIST_REPO_DIR >> environment
 179 variable, or pass the C<< --repo_dir >> flag to any of the scripts.
 180
 181     GITALIST_REPO_DIR=/home/myuser/code/git gitalist_server.pl
 182     gitalist_server.pl --repo_dir home/myuser/code/git
 183
 184 The C<< GITALIST_REPO_DIR >> environment variable will override the repository directory set
 185 in configuration, and will itself be overridden by he C<< --repo_dir >> flag.
 186
 187 =head1 RUNNING
 188
 189 Once you have followed the instructions above to install and configure Gitalist, you may want
 190 to run it in a more production facing environment than using the single threaded developement
 191 server.
 192
 193 The recommended deployment method for Gitalist is FastCGI, although Gitalist can also be run
 194 under L<mod_perl|https://perl.apache.org/> or as pure Perl with L<Catalyst::Engine::PreFork>.
 195
 196 Assuming that you have installed Gitalist's dependencies into a L<local::lib>, and you
 197 are running from a git checkout, adding a trivial FCGI script as C<script/gitalist.fcgi>
 198 (this file is specifically in C<.gitignore> so you can have your own copy):
 199
 200     #!/bin/sh
 201     exec /home/t0m/public_html/Gitalist/script/gitalist_fastcgi.pl
 202
 203 This example can be seen live here:
 204
 205     http://example.gitalist.com
 206
 207 =head2 Plack
 208
 209 If you would like to run Gitalist under L<Plack> then one need only
 210 make use of L<plackup|search.cpan.org/perldoc?plackup> and the
 211 C<.psgi> found under C<scripts/>:
 212
 213     plackup script/gitalist_app.psgi
 214
 215 =head1 CONFIGURATION
 216
 217 The Gitalist config is loaded with L<Catalyst::Plugin::ConfigLoader>
 218 and the available config options are:
 219
 220 =head2 Model::CollectionOfRepos
 221
 222 =over
 223
 224 =item git
 225
 226 Path to the C<git> binary.
 227
 228 =item repo_dir
 229
 230 A directory containing the directories to show.
 231
 232 =item repos
 233
 234 A list of directories containing repositories to show.
 235
 236 =item search_recursively
 237
 238 A boolean indicating whether to always search recursively for
 239 repositories within C<repo_dir>.
 240
 241 =item whitelist
 242
 243 Path a file containing a list of repositories that can be shown. Each
 244 line in the file will represent the name of a repo to show e.g
 245
 246   Gitalist
 247   some-bare-repo.git
 248
 249 This is compatible with C<gitweb>'s C<projects.list>.
 250
 251 =item export_ok
 252
 253 If provided every must contain a file of the same name to be
 254 visible. This is similar to C<gitweb>'s functionality.
 255
 256 =back
 257
 258 =head2 paging
 259
 260 =over
 261
 262 =item log
 263
 264 The number of commits to show in the summary, shortlog and longlog views.
 265
 266 =back
 267
 268 =head2 FASTCGI
 269
 270 Running Gitalist in FastCGI mode requires a webserver with FastCGI
 271 support (such as apache with L<mod_fcgi|http://www.fastcgi.com/drupal/node/3>
 272 or L<mod_fcgid|https://httpd.apache.org/mod_fcgid/>). Below is a sample
 273 configuration using Apache2 with mod_fcgid in a dynamic configuration
 274 (as opposed to static or standalone mode). More information on these modes and
 275 their configuration can be found at L<Catalyst::Engine::FastCGI/"Standalone server mode">.
 276
 277 In Apache's F<mime.conf>, add C<AddHandler fcgid-script .fcgi>
 278 (or C<AddHandler fastcgi-script .fcgi> for mod_fcgi).
 279
 280 And a quick VirtualHost configuration:
 281
 282     <VirtualHost *:80>
 283         ServerName gitalist.yourdomain.com
 284         DocumentRoot /path/to/gitalist.fcgi
 285         <Directory "/path/to/gitalist.fcgi">
 286             AllowOverride all
 287             Options +ExecCGI -MultiViews +SymLinksIfOwnerMatch
 288             Order allow,deny
 289             Allow from all
 290         </Directory>
 291
 292         # Tell Apache this is a FastCGI application
 293         <Files gitalist.fcgi>
 294             #change the below to fastcgi-script if using mod_fcgi
 295             SetHandler fcgid-script
 296         </Files>
 297     </VirtualHost>
 298
 299 Now to access your Gitalist instance, you'll go to
 300 C<gitalist.yourdomain.com/gitalist.fcgi/> (B<do not forget that trailing> C</>).
 301 If you'd like a different URL, of course, you'll likely want to use
 302 L<mod_rewrite|https://httpd.apache.org/docs/mod/mod_rewrite.html> or equivalent.
 303
 304 If you find the need to do some troubleshooting, you can call
 305 C<http://url_to_gitalist.fcgi?dump_info=1> and/or add export C<GITALIST_DEBUG=1>
 306 to the top of your F<gitalist.fcgi> file (just below the shebang line).
 307
 308 Also, note that Apache will refuse C<%2F> in Gitalist URLs
 309 unless configured otherwise. Make sure C<AllowEncodedSlashes On>
 310 is in your F<httpd.conf> file in order for this to run smoothly.
 311
 312 =head1 CONTRIBUTING
 313
 314 Patches are welcome, please feel free to fork on github and send pull requests, send patches
 315 from git format-patch to the bug tracker, or host your own copy of gitalist somewhere and
 316 ask us to pull from it.
 317
 318 =head1 SUPPORT
 319
 320 Gitalist has an active irc community in C<#gitalist> on irc.perl.org, please feel free to stop
 321 by and ask questions, report bugs or installation issues or generally for a chat about where
 322 we plan to go with the project.
 323
 324 =head1 SEE ALSO
 325
 326 L<Gitalist::Controller::Root>
 327
 328 L<Gitalist::Git::Repository>
 329
 330 L<Catalyst>
 331
 332 =head1 AUTHORS AND COPYRIGHT
 333
 334   Catalyst application:
 335     © 2009 Venda Ltd and Dan Brook <broq@cpan.org>
 336     © 2009, Tom Doran <bobtfish@bobtfish.net>
 337     © 2009, Zac Stevens <zts@cryptocracy.com>
 338
 339   Original gitweb.cgi from which this was derived:
 340     © 2005-2006, Kay Sievers <kay.sievers@vrfy.org>
 341     © 2005, Christian Gierke
 342
 343   Model based on http://github.com/rafl/gitweb
 344     © 2008, Florian Ragwitz
 345
 346 =head1 LICENSE
 347
 348 Licensed under GNU GPL v2