X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FGitalist.pm;h=435f7e1751f4f5c57108578a6734693ac38b0f42;hb=4916e60728a5d9642e45cf6957758f110b94803b;hp=dfe77eb039a97bc655a650d3710663524f018f0a;hpb=63f34424aa7e8203cda280b1262c2ae541261afa;p=catagits%2FGitalist.git diff --git a/lib/Gitalist.pm b/lib/Gitalist.pm index dfe77eb..435f7e1 100644 --- a/lib/Gitalist.pm +++ b/lib/Gitalist.pm @@ -11,37 +11,57 @@ use Catalyst qw/ Unicode::Encoding Static::Simple StackTrace + SubRequest /; -our $VERSION = '0.000001'; +our $VERSION = '0.002007'; $VERSION = eval $VERSION; __PACKAGE__->config( name => 'Gitalist', default_view => 'Default', - default_model => 'GitRepos', + default_model => 'CollectionOfRepos', + use_request_uri_for_path => 1, + disable_component_resolution_regex_fallback => 1, ); __PACKAGE__->setup(); +after prepare_path => sub { + my ($ctx) = @_; + if ($ctx->req->param('a')) { + $ctx->request->uri->path('/legacy' . $ctx->request->uri->path); + } +}; + around uri_for => sub { my ($orig, $c) = (shift, shift); - my $project_name = $c->stash->{'Project'} && $c->stash->{'Project'}->name; - my $hash = ref($_[-1]) eq 'HASH' ? pop @_ : {}; - my $params = Catalyst::Utils::merge_hashes( - { p => $hash->{p} || $project_name }, - $hash, - ); - delete $params->{p} unless defined $params->{p} && length $params->{p}; - (my $uri = $c->$orig(@_, $params)) - =~ tr[&][;]; + my $uri = $c->$orig(@_); + $$uri =~ tr[&][;] if defined $uri; return $uri; }; +around uri_for_action => sub { + my ($orig, $c) = (shift, shift); + my $uri = $c->$orig(@_); + $$uri =~ s[/fragment\b][] if defined $uri; + return $uri; +}; + +sub uri_with { + my ($self, @args) = @_; + my $uri = $self->request->uri_with(@args); + # Wow this awful. + $uri =~ s[/fragment\b][]; + return $uri; +} + 1; __END__ +=encoding UTF-8 + =head1 NAME Gitalist - A modern git web viewer @@ -53,7 +73,7 @@ Gitalist - A modern git web viewer =head1 INSTALL As Gitalist follows the usual Perl module format the usual approach -for installation should work e.g. +for installation should work, e.g.: perl Makefile.PL make @@ -64,65 +84,207 @@ or cpan -i Gitalist -You can also check gitalist out from git and run it, in this case you'll additionally -need the author modules, but no configuration will be needed as it will default to looking +You can also L +and run it, in this case you'll additionally need the author modules, +but no configuration will be needed as it will default to looking for repositories the directory above the checkout. =head1 DESCRIPTION -Gitalist is a web frontend for git repositories based on gitweb.cgi -and backed by Catalyst. +Gitalist is a web frontend for git repositories based on +L and backed by +L. =head2 History -This project started off as an attempt to port gitweb.cgi to a +This project started off as an attempt to port I to a Catalyst app in a piecemeal fashion. As it turns out, thanks largely -to Florian Ragwitz's earlier effort, it was easier to use gitweb.cgi +to Florian Ragwitz's earlier effort, it was easier to use I as a template for building a new Catalyst application. -=head1 CONFIGURATION +=head1 GETTING GITALIST + +You can install Gitalist from CPAN in the usual way: + + cpan -i Gitalist + +Alternatively, you can get Gitalist using git. + +The canonical repository for the master branch is: + + git://git.shadowcat.co.uk/catagits/Gitalist.git + +Gitalist is also mirrored to GitHub at L, +and a number of people have active forks +with branches and/or new features in the master branch. + +=head1 BOOTSTRAPPING + +As of C<0.002001> Gitalist can now be bootstrapped to run out of its +own directory by installing its prerequisites locally with the help of +L. So instead of installing the prerequisites to the +system path with CPAN they are installed under the Gitalist directory. + +To do this clone Gitalist from the L or grab a snapshot from broquaint's GitHub repository: + + https://github.com/broquaint/Gitalist/downloads + +With the source acquired and unpacked run the following from within the +Gitalist directory: + + perl script/bootstrap.pl + +This will install the necessary modules for the build process which in +turn installs the prerequisites locally. + +B The relevant bootstrap scripts aren't available in the CPAN dist +as the bootstrap scripts should not be installed. + +=head1 INITIAL CONFIGURATION + +Gitalist is configured using L. The supplied sample +configuration is in L format, however it is possible to configure +Gitalist using other config file formats (such as YAML) if you prefer. + +=head2 WHEN CHECKING GITALIST OUT OF GIT + +Gitalist from git includes a minimal C, which sets the repository +directory to one directory higher than the Gitalist repository. + +This means that if you check Gitalist out next to your other git checkouts, then starting +the demo server needs no parameters at all: + + Gitalist [master]$ ./script/gitalist_server.pl + You can connect to your server at http://localhost:3000 + +=head2 FOR CPAN INSTALLS Gitalist can be supplied with a config file by setting the C<< GITALIST_CONFIG >> environment variable to point to a configuration file. -A default configuration is installed along with gitalist, which is complete except -for a repository directory. You can get a copy of this configuration by running: +If you install Gitalist from CPAN, a default configuration is installed along with gitalist, +which is complete except for a repository directory. You can get a copy of this configuration +by running: cp `perl -Ilib -MGitalist -e'print Gitalist->path_to("gitalist.conf")'` gitalist.conf -adding a repos_dir path and then setting C<< GITALIST_CONFIG >>. +You can then edit this configuration, adding a C path and customising +other settings as desired. + +You can then start the Gitalist demo server by setting C<< GITALIST_CONFIG >>. For example: + + GITALIST_CONFIG=/usr/local/etc/gitalist.conf gitalist_server.pl Alternatively, if you only want to set a repository directory and are otherwise happy with -the default configuration, then you can set the C<< GITALIST_REPOS_DIR >> environment -variable, or pass the C<< --repos_dir >> flag to any of the scripts. +the default configuration, then you can set the C<< GITALIST_REPO_DIR >> environment +variable, or pass the C<< --repo_dir >> flag to any of the scripts. + + GITALIST_REPO_DIR=/home/myuser/code/git gitalist_server.pl + gitalist_server.pl --repo_dir home/myuser/code/git + +The C<< GITALIST_REPO_DIR >> environment variable will override the repository directory set +in configuration, and will itself be overridden by he C<< --repo_dir >> flag. + +=head1 RUNNING + +Once you have followed the instructions above to install and configure Gitalist, you may want +to run it in a more production facing environment than using the single threaded developement +server. + +The recommended deployment method for Gitalist is FastCGI, although Gitalist can also be run +under L or as pure Perl with L. + +Assuming that you have installed Gitalist's dependencies into a L, and you +are running from a git checkout, adding a trivial FCGI script as C