=head2 Enable debug status in the environment
Normally you enable the debugging info by adding the C<-Debug> flag to
-your C<use Catalyst> statement (or C<__PACKAGE__->setup(qw/-Debug/)
-). However, you can also enable it using environment variable, so you
-can (for example) get debug info without modifying your application
-scripts. Just set C<CATALYST_DEBUG> or C<E<lt>MYAPPE<gt>_DEBUG> to a
-true value.
+your C<use Catalyst> statement . However, you can also enable it using
+environment variable, so you can (for example) get debug info without
+modifying your application scripts. Just set C<CATALYST_DEBUG> or
+C<E<lt>MYAPPE<gt>_DEBUG> to a true value.
=head2 Sessions
=head3 EXAMPLE
- use parent qw/Catalyst/;
- __PACKAGE__->setup( qw/
+ package MyApp;
+ use Moose;
+ use namespace::autoclean;
+
+ use Catalyst qw/
Session
Session::Store::FastMmap
Session::State::Cookie
- /;)
-
-
+ /;
+ extends 'Catalyst';
+ __PACKAGE__->setup;
+
+ package MyApp::Controller::Foo;
+ use Moose;
+ use namespace::autoclean;
+ BEGIN { extends 'Catalyst::Controller';
## Write data into the session
sub add_item : Local {
}
}
-
-=head2 Role-based Authorization
-
-For more advanced access control, you may want to consider using role-based
-authorization. This means you can assign different roles to each user, e.g.
-"user", "admin", etc.
-
-The C<login> and C<logout> methods and view template are exactly the same as
-in the previous example.
-
-The L<Catalyst::Plugin::Authorization::Roles> plugin is required when
-implementing roles:
-
- use parent qw/Catalyst/;
- __PACKAGE__->setup (qw/
- Authentication
- Authentication::Credential::Password
- Authentication::Store::Htpasswd
- Authorization::Roles
- /);
-
-Roles are implemented automatically when using
-L<Catalyst::Authentication::Store::Htpasswd>:
-
- # no additional role configuration required
- __PACKAGE__->config->{authentication}{htpasswd} = "passwdfile";
-
-Or can be set up manually when using L<Catalyst::Authentication::Store::DBIC>:
-
- # Authorization using a many-to-many role relationship
- __PACKAGE__->config->{authorization}{dbic} = {
- 'role_class' => 'My::Model::DBIC::Role',
- 'role_field' => 'name',
- 'user_role_user_field' => 'user',
-
- # DBIx::Class only (omit if using Class::DBI)
- 'role_rel' => 'user_role',
-
- # Class::DBI only, (omit if using DBIx::Class)
- 'user_role_class' => 'My::Model::CDBI::UserRole'
- 'user_role_role_field' => 'role',
- };
-
-To restrict access to any action, you can use the C<check_user_roles> method:
-
- sub restricted : Local {
- my ( $self, $c ) = @_;
-
- $c->detach("unauthorized")
- unless $c->check_user_roles( "admin" );
-
- # do something restricted here
- }
-
-You can also use the C<assert_user_roles> method. This just gives an
-error if the current user does not have one of the required roles:
-
- sub also_restricted : Global {
- my ( $self, $c ) = @_;
- $c->assert_user_roles( qw/ user admin / );
- }
-
=head2 Authentication/Authorization
This is done in several steps:
=head3 Logging in
When you have chosen your modules, all you need to do is call the C<<
-$c->login >> method. If called with no parameters, it will try to find
+$c->authenticate >> method. If called with no parameters, it will try to find
suitable parameters, such as B<username> and B<password>, or you can
pass it these values.
=head3 EXAMPLE
- use parent qw/Catalyst/;
- __PACKAGE__->setup( qw/Authentication
- Authentication::Credential::Password
- Authentication::Store::Htpasswd
- Authorization::Roles/);
+ package MyApp;
+ use Moose;
+ use namespace::autoclean;
+ extends qw/Catalyst/;
+ use Catalyst qw/
+ Authentication
+ Authorization::Roles
+ /;
- __PACKAGE__->config->{authentication}{htpasswd} = "passwdfile";
+ __PACKAGE__->config(
+ authentication => {
+ default_realm => 'test',
+ realms => {
+ test => {
+ credential => {
+ class => 'Password',
+ password_field => 'password',
+ password_type => 'self_check',
+ },
+ store => {
+ class => 'Htpasswd',
+ file => 'htpasswd',
+ },
+ },
+ },
+ },
+ );
+ package MyApp::Controller::Root;
+ use Moose;
+ use namespace::autoclean;
+
+ BEGIN { extends 'Catalyst::Controller' }
+
+ __PACKAGE__->config(namespace => '');
+
sub login : Local {
my ($self, $c) = @_;
if ( my $user = $c->req->param("user")
and my $password = $c->req->param("password") )
{
- if ( $c->login( $user, $password ) ) {
+ if ( $c->authenticate( username => $user, password => $password ) ) {
$c->res->body( "hello " . $c->user->name );
} else {
# login incorrect
modifying one's database, which can be problematic if one forgets to
use the testing instead of production database.
-e.g.,
-
- use Catalyst::Plugin::Authentication::Store::Minimal::Backend;
-
- # Sets up the user `test_user' with password `test_pass'
- MyApp->default_auth_store(
- Catalyst::Plugin::Authentication::Store::Minimal::Backend->new({
- test_user => { password => 'test_pass' },
- })
- );
-
-Now, your test code can call C<$c->login('test_user', 'test_pass')> and
-successfully login, without messing with the database at all.
+Alternatively, if you want to authenticate real users, but not have to worry about
+their passwords, you can use L<Catalyst::Authentication::Credential::Testing>
+to force all users to authenticate with a global password.
=head3 More information
-L<http://search.cpan.org/perldoc?Catalyst::Plugin::Authentication> has a longer explanation.
+L<Catalyst::Plugin::Authentication> has a longer explanation.
=head2 Authorization
control checks. Let's load it:
use parent qw/Catalyst/;
- __PACKAGE__->setup(qw/
- Authentication # yadda yadda
- Authorization::Roles
- /);
+ use Catalyst qw/
+ Authentication
+ Authorization::Roles
+ /;
And now our action should look like this:
sub connection {
my ($self, @rest) = @_;
$self->next::method(@rest);
- # $self is now a live My::Schema object, complete with DB connection
+ # $self is now a live My::Schema object, complete with DB connection
$self->ACCESSORNAME1([ $self->resultset('RESULTSOURCEMONIKER')->all ]);
$self->ACCESSORNAME2([ $self->resultset('RESULTSOURCEMONIKER')->search({ COLUMN => { '<' => '30' } })->all ]);
3. Add the XMLRPC plugin to MyApp.pm
- __PACKAGE__->setup( qw/-Debug Static::Simple XMLRPC/);
+ use Catalyst qw/-Debug Static::Simple XMLRPC/;
4. Add an API controller
my ( $self, $c, $a, $b ) = @_;
return RPC::XML::int->new( $a + $b );
}
-
-
=head1 Views
=over
-=item
+=item
INCLUDE_PATH defines the directories that Template Toolkit should search
for the template files.
L<http://search.cpan.org/perldoc?Template>
-=head2 Adding RSS feeds
+=head2 Adding RSS feeds
Adding RSS feeds to your Catalyst applications is simple. We'll see two
different aproaches here, but the basic premise is that you forward to
$c->stash->{template}='rss.tt';
}
-Then you need a template. Here's the one from Agave:
+Then you need a template. Here's the one from Agave:
<?xml version="1.0" encoding="UTF-8"?>
<rss version="2.0" xmlns:dc="http://purl.org/dc/elements/1.1/">
[% WHILE (post = posts.next) %]
<item>
<title>[% post.title %]</title>
- <description>[% post.formatted_teaser|html%]</description>
+ <description>[% post.formatted_teaser|html%]</description>
<pubDate>[% post.pub_date %]</pubDate>
<guid>[% post.full_uri %]</guid>
<link>[% post.full_uri %]</link>
</item>
[% END %]
</channel>
- </rss>
+ </rss>
=head3 Using XML::Feed
}
A little more code in the controller, but with this approach you're
-pretty sure to get something that validates.
+pretty sure to get something that validates.
Note that for both of the above aproaches, you'll need to set the
content type like this:
sub render : ActionClass('RenderView') { }
- sub end : Private {
+ sub end : Private {
my ( $self, $c ) = @_;
$c->forward('render');
# do stuff here
}
-
+
=head2 Action Types
=head3 Introduction
sub my_handles : Path('/handles') { .. }
-becomes
+becomes
http://localhost:3000/handles
+See also: L<Catalyst::DispatchType::Path>
+
=item Local
When using a Local attribute, no parameters are needed, instead, the
http://localhost:3000/handles
-and
+and
http://localhost:3000/handles_and_other_parts
etc.
+See also: L<Catalyst::DispatchType::Regex>
+
=item LocalRegex
A LocalRegex is similar to a Regex, except it only matches below the current
etc.
+=item Chained
+
+See L<Catalyst::DispatchType::Chained> for a description of how the chained
+dispatch type works.
+
=item Private
Last but not least, there is the Private attribute, which allows you
works for all unknown URLs, in this controller namespace, or every one
if put directly into MyApp.pm.
-=item index
+=item index
The index action is called when someone tries to visit the exact
namespace of your controller. If index, default and matching Path
sub begin : Private { .. }
-is called once when
+is called once when
http://localhost:3000/bucket/(anything)?
called. (In contrast, only one of the begin/end/default actions will
be called, the relevant one).
- package MyApp.pm;
+ package MyApp::Controller::Root;
sub auto : Private { .. }
-and
+and
sub auto : Private { .. }
-will both be called when visiting
+will both be called when visiting
http://localhost:3000/bucket/(anything)?
=head3 A word of warning
-Due to possible namespace conflicts with Plugins, it is advised to
-only put the pre-defined Private actions in your main MyApp.pm file,
-all others should go in a Controller module.
+You can put root actions in your main MyApp.pm file, but this is deprecated,
+please put your actions into your Root controller.
=head3 More Information
-L<http://search.cpan.org/author/SRI/Catalyst-5.61/lib/Catalyst/Manual/Intro.pod>
-
L<http://dev.catalyst.perl.org/wiki/FlowChart>
+=head2 DRY Controllers with Chained actions.
+
+Imagine that you would like the following paths in your application:
+
+=over
+
+=item B</cd/<ID>/track/<ID>>
+
+Displays info on a particular track.
+
+In the case of a multi-volume CD, this is the track sequence.
+
+=item B</cd/<ID>/volume/<ID>/track/<ID>>
+
+Displays info on a track on a specific volume.
+
+=back
+
+Here is some example code, showing how to do this with chained controllers:
+
+ package CD::Controller;
+ use base qw/Catalyst::Controller/;
+
+ sub root : Chained('/') PathPart('/cd') CaptureArgs(1) {
+ my ($self, $c, $cd_id) = @_;
+ $c->stash->{cd_id} = $cd_id;
+ $c->stash->{cd} = $self->model('CD')->find_by_id($cd_id);
+ }
+
+ sub trackinfo : Chained('track') PathPart('') Args(0) RenderView {
+ my ($self, $c) = @_;
+ }
+
+ package CD::Controller::ByTrackSeq;
+ use base qw/CD::Controller/;
+
+ sub track : Chained('root') PathPart('track') CaptureArgs(1) {
+ my ($self, $c, $track_seq) = @_;
+ $c->stash->{track} = $self->stash->{cd}->find_track_by_seq($track_seq);
+ }
+
+ package CD::Controller::ByTrackVolNo;
+ use base qw/CD::Controller/;
+
+ sub volume : Chained('root') PathPart('volume') CaptureArgs(1) {
+ my ($self, $c, $volume) = @_;
+ $c->stash->{volume} = $volume;
+ }
+
+ sub track : Chained('volume') PathPart('track') CaptureArgs(1) {
+ my ($self, $c, $track_no) = @_;
+ $c->stash->{track} = $self->stash->{cd}->find_track_by_vol_and_track_no(
+ $c->stash->{volume}, $track_no
+ );
+ }
+
+Note that adding other actions (i.e. chain endpoints) which operate on a track
+is simply a matter of adding a new sub to CD::Controller - no code is duplicated,
+even though there are two different methods of looking up a track.
+
+This technique can be expanded as needed to fulfil your requirements - for example,
+if you inherit the first action of a chain from a base class, then mixing in a
+different base class can be used to duplicate an entire URL hieratchy at a different
+point within your application.
+
=head2 Component-based Subrequests
See L<Catalyst::Plugin::SubRequest>.
$c->req->args([qw/arg1 arg2 arg3/]);
$c->forward('/wherever');
-(See the L<Catalyst::Manual::Intro> Flow_Control section for more
+(See the L<Catalyst::Manual::Intro> Flow_Control section for more
information on passing arguments via C<forward>.)
+=head2 Chained dispatch using base classes, and inner packages.
+
+ package MyApp::Controller::Base;
+ use base qw/Catalyst::Controller/;
+
+ sub key1 : Chained('/')
=head1 Deployment
=head4 1. Install Catalyst::Engine::Apache
-You should install the latest versions of both Catalyst and
+You should install the latest versions of both Catalyst and
Catalyst::Engine::Apache. The Apache engines were separated from the
Catalyst core in version 5.50 to allow for updates to the engine without
requiring a new Catalyst release.
PerlSwitches -I/var/www/MyApp/lib
PerlModule MyApp
-
+
<Location />
SetHandler modperl
PerlResponseHandler MyApp
SetHandler modperl
PerlResponseHandler MyApp
</Location>
-
+
When running this way, it is best to make use of the C<uri_for> method in
Catalyst for constructing correct links.
<Location /static>
SetHandler default-handler
</Location>
-
+
This will let all files within root/static be handled directly by Apache. In
a two-tiered setup, the frontend server should handle static files.
The configuration to do this on the frontend will vary.
=head3 Cons
+You may have to disable mod_deflate. If you experience page hangs with
+mod_fastcgi then remove deflate.load and deflate.conf from mods-enabled/
+
=head4 More complex environment
With FastCGI, there are more things to monitor and more processes running
FastCgiServer /var/www/MyApp/script/myapp_fastcgi.pl -processes 3
Alias /myapp/ /var/www/MyApp/script/myapp_fastcgi.pl/
-
+
# Or, run at the root
Alias / /var/www/MyApp/script/myapp_fastcgi.pl/
-
+
The above commands will launch 3 app processes and make the app available at
/myapp/
First, launch your app as a standalone server listening on a socket.
script/myapp_fastcgi.pl -l /tmp/myapp.socket -n 5 -p /tmp/myapp.pid -d
-
+
You can also listen on a TCP port if your web server is not on the same
machine.
script/myapp_fastcgi.pl -l :8080 -n 5 -p /tmp/myapp.pid -d
-
+
You will probably want to write an init script to handle starting/stopping
of the app using the pid file.
FastCgiExternalServer /tmp/myapp.fcgi -socket /tmp/myapp.socket
Alias /myapp/ /tmp/myapp.fcgi/
-
+
# Or, run at the root
Alias / /tmp/myapp.fcgi/
-
+
=head3 More Info
L<Catalyst::Engine::FastCGI>.
ProxyPass / http://localhost:8080/
ProxyPassReverse / http://localhost:8080/
- # This is optional if you'd like to show a custom error page
+ # This is optional if you'd like to show a custom error page
# if the proxy is not available
ErrorDocument 502 /static/error_pages/http502.html
% perl Makefile.PL
% make catalyst_par
+You can customise the PAR creation process by special "catalyst_par_*" commands
+available from L<Module::Install::Catalyst>. You can add these commands in your
+Makefile.PL just before the line containing "catalyst;"
+
+ #Makefile.PL example with extra PAR options
+ use inc::Module::Install;
+
+ name 'MyApp';
+ all_from 'lib\MyApp.pm';
+
+ requires 'Catalyst::Runtime' => '5.80005';
+ <snip>
+ ...
+ <snip>
+
+ catalyst_par_core(1); # bundle perl core modules in the resulting PAR
+ catalyst_par_multiarch(1); # build a multi-architecture PAR file
+ catalyst_par_classes(qw/
+ Some::Additional::Module
+ Some::Other::Module
+ /); # specify additional modules you want to be included into PAR
+ catalyst;
+
+ install_script glob('script/*.pl');
+ auto_install;
+ WriteAll;
+
Congratulations! Your package "myapp.par" is ready, the following
steps are just optional.
Using the plugin is as simple as setting your use line in MyApp.pm to include:
- __PACKAGE__->setup( qw/Static::Simple/);
+ use Catalyst qw/Static::Simple/;
and already files will be served.
MyApp->config->{static}->{include_path} = [
MyApp->config->{root},
- '/path/to/my/files'
+ '/path/to/my/files'
];
When you override include_path, it will not automatically append the
be replaced easily:
MyApp->config->{static}->{ignore_extensions} = [
- qw/tmpl tt tt2 html xhtml/
+ qw/tmpl tt tt2 html xhtml/
];
=item Ignoring directories
In your main application class (MyApp.pm), load the plugin:
- __PACKAGE__->setup( qw/-Debug FormValidator Static OtherPlugin/);
+ use Catalyst qw/-Debug FormValidator Static OtherPlugin/;
You will also need to make sure your end method does I<not> forward
static content to the view, perhaps like this:
sub end : Private {
my ( $self, $c ) = @_;
- $c->forward( 'MyApp::View::TT' )
+ $c->forward( 'MyApp::View::TT' )
unless ( $c->res->body || !$c->stash->{template} );
}
application for a cache because the source document changes
infrequently but may be viewed many times.
- __PACKAGE__->setup( qw/Cache::FileCache/);
-
+ use Catalyst qw/Cache::FileCache/;
+
...
-
+
use File::stat;
sub render_pod : Local {
my ( self, $c ) = @_;
-
+
# the cache is keyed on the filename and the modification time
# to check for updates to the file.
my $file = $c->path_to( 'root', '2005', '11.pod' );
my $mtime = ( stat $file )->mtime;
-
+
my $cached_pod = $c->cache->get("$file $mtime");
if ( !$cached_pod ) {
$cached_pod = do_slow_pod_rendering();
}
$c->stash->{pod} = $cached_pod;
}
-
+
We could actually cache the result forever, but using a value such as 12 hours
allows old entries to be automatically expired when they are no longer needed.
sub front_page : Path('/') {
my ( $self, $c ) = @_;
-
+
$c->forward( 'get_news_articles' );
$c->forward( 'build_lots_of_boxes' );
$c->forward( 'more_slow_stuff' );
-
+
$c->stash->{template} = 'index.tt';
}
We can add the PageCache plugin to speed things up.
- __PACKAGE__->setup( qw/Cache::FileCache PageCache/);
-
+ use Catalyst qw/Cache::FileCache PageCache/;
+
sub front_page : Path ('/') {
my ( $self, $c ) = @_;
-
+
$c->cache_page( 300 );
-
+
# same processing as above
}
-
+
Now the entire output of the front page, from <html> to </html>, will be
cached for 5 minutes. After 5 minutes, the next request will rebuild the
page and it will be re-cached.
headers for the cached page.
MyApp->config->{page_cache}->{set_http_headers} = 1;
-
+
This would now set the following headers so proxies and browsers may cache
the content themselves.
Cache-Control: max-age=($expire_time - time)
Expires: $expire_time
Last-Modified: $cache_created_time
-
+
=head3 Template Caching
Template Toolkit provides support for caching compiled versions of your
still be automatically detected.
package MyApp::View::TT;
-
+
use strict;
use warnings;
use base 'Catalyst::View::TT';
-
+
__PACKAGE__->config(
COMPILE_DIR => '/tmp/template_cache',
);
-
+
1;
-
+
=head3 More Info
See the documentation for each cache plugin for more details and other
=head2 Testing
-Catalyst provides a convenient way of testing your application during
+Catalyst provides a convenient way of testing your application during
development and before deployment in a real environment.
-C<Catalyst::Test> makes it possible to run the same tests both locally
+C<Catalyst::Test> makes it possible to run the same tests both locally
(without an external daemon) and against a remote server via HTTP.
=head3 Tests
=item C<02pod.t>
-Verifies that all POD is free from errors. Only executed if the C<TEST_POD>
+Verifies that all POD is free from errors. Only executed if the C<TEST_POD>
environment variable is true.
=item C<03podcoverage.t>
=back
-C<request> returns an instance of C<HTTP::Response> and C<get> returns the
+C<request> returns an instance of C<HTTP::Response> and C<get> returns the
content (body) of the response.
=head3 Running tests locally
mundus:~/MyApp chansen$ CATALYST_DEBUG=0 TEST_POD=1 prove --lib lib/ t/
- t/01app............ok
- t/02pod............ok
- t/03podcoverage....ok
+ t/01app............ok
+ t/02pod............ok
+ t/03podcoverage....ok
All tests successful.
Files=3, Tests=4, 2 wallclock secs ( 1.60 cusr + 0.36 csys = 1.96 CPU)
-
+
C<CATALYST_DEBUG=0> ensures that debugging is off; if it's enabled you
will see debug logs between tests.
=head3 Running tests remotely
mundus:~/MyApp chansen$ CATALYST_SERVER=http://localhost:3000/ prove --lib lib/ t/01app.t
- t/01app....ok
+ t/01app....ok
All tests successful.
Files=1, Tests=2, 0 wallclock secs ( 0.40 cusr + 0.01 csys = 0.41 CPU)
-C<CATALYST_SERVER=http://localhost:3000/> is the absolute deployment URI of
-your application. In C<CGI> or C<FastCGI> it should be the host and path
+C<CATALYST_SERVER=http://localhost:3000/> is the absolute deployment URI of
+your application. In C<CGI> or C<FastCGI> it should be the host and path
to the script.
=head3 C<Test::WWW::Mechanize> and Catalyst
=head1 AUTHORS
-Sebastian Riedel C<sri@oook.de>
-
-Danijel Milicevic C<me@danijel.de>
-
-Viljo Marrandi C<vilts@yahoo.com>
-
-Marcus Ramberg C<mramberg@cpan.org>
-
-Jesse Sheidlower C<jester@panix.com>
-
-Andy Grundman C<andy@hybridized.org>
-
-Chisel Wright C<pause@herlpacker.co.uk>
-
-Will Hawes C<info@whawes.co.uk>
-
-Gavin Henry C<ghenry@perl.me.uk>
-
-Kieren Diment C<kd@totaldatasolution.com>
+Catalyst Contributors, see Catalyst.pm
=head1 COPYRIGHT
-This document is free, you can redistribute it and/or modify it
-under the same terms as Perl itself.
+This library is free software. You can redistribute it and/or modify it under
+the same terms as Perl itself.
+=cut