X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FGitalist.pm;h=1be66c8e1fd9022194b2e7915c7e30425de678bb;hb=c4ed9eb3e84a91c85a05c44a6c149a5ca0628f28;hp=7538376c87e5cfe09c577bd814a6830f3b9b6ead;hpb=4666d5c7808a05b70242119f24c72a479fd732f7;p=catagits%2FGitalist.git diff --git a/lib/Gitalist.pm b/lib/Gitalist.pm index 7538376..1be66c8 100644 --- a/lib/Gitalist.pm +++ b/lib/Gitalist.pm @@ -1,69 +1,217 @@ package Gitalist; - -use strict; -use warnings; - +use Moose; +BEGIN { require 5.008006; } use Catalyst::Runtime 5.80; +use namespace::autoclean; -# Set flags and add plugins for the application -# -# -Debug: activates the debug mode for very useful log messages -# ConfigLoader: will load the configuration from a Config::General file in the -# application's home directory -# Static::Simple: will serve static files from the application's root -# directory +extends 'Catalyst'; -use parent qw/Catalyst/; -use Catalyst qw/-Debug +use Catalyst qw/ ConfigLoader - Static::Simple/; -our $VERSION = '0.01'; + Unicode::Encoding + Static::Simple + StackTrace + SubRequest +/; -# Bring in the libified gitweb.cgi. -use gitweb; - -# Configure the application. -# -# Note that settings in gitalist.conf (or other external -# configuration file that you set up manually) take precedence -# over this when using ConfigLoader. Thus configuration -# details given here can function as a default configuration, -# with an external configuration file acting as an override for -# local deployment. +our $VERSION = '0.000006_01'; +$VERSION = eval $VERSION; __PACKAGE__->config( - name => 'Gitalist', - default_view => 'Default', + name => 'Gitalist', + default_view => 'Default', + default_model => 'CollectionOfRepos', ); -# Start the application __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 $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__ + =head1 NAME -Gitalist - Catalyst based application +Gitalist - A modern git web viewer =head1 SYNOPSIS - script/gitalist_server.pl + script/gitalist_server.pl --repo_dir /home/me/code/git + +=head1 INSTALL + +As Gitalist follows the usual Perl module format the usual approach +for installation should work e.g. + + perl Makefile.PL + make + make test + make install + +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 +for repositories the directory above the checkout. =head1 DESCRIPTION -[enter your description here] +Gitalist is a web frontend for git repositories based on gitweb.cgi +and backed by Catalyst. + +=head2 History + +This project started off as an attempt to port gitweb.cgi 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 +as a template for building a new Catalyst application. + +=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, and a number of people have active forks +with branches and/or new features in the master branch. + +=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. + +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 + +You can then edit this confg, adding a repos_dir 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_REPO_DIR >> environment +variable, or pass the C<< --repos_dir >> flag to any of the scripts. + + GITALIST_REPO_DIR=/home/myuser/code/git gitalist_server.pl + gitalist_server.pl --repos_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<< --repos_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 mod_perl 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