X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst.pm;h=02f1216efe5a7af6853a8e00a97ebfd5c72ead0f;hb=a842f4920bb47e65459bd0ea5df3a21e1ea2497f;hp=81117c91e6d45b6f53d370155b9c3d3c0d90b5da;hpb=33108eafaedec785c7ebdef4eb65a8d935b3af55;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst.pm b/lib/Catalyst.pm index 81117c9..02f1216 100644 --- a/lib/Catalyst.pm +++ b/lib/Catalyst.pm @@ -1,23 +1,40 @@ package Catalyst; use strict; -use base 'Catalyst::Base'; +use base 'Catalyst::Component'; use bytes; -use UNIVERSAL::require; use Catalyst::Exception; use Catalyst::Log; use Catalyst::Request; use Catalyst::Request::Upload; use Catalyst::Response; use Catalyst::Utils; +use Catalyst::Controller; +use Devel::InnerPackage (); +use File::stat; +use Module::Pluggable::Object (); use NEXT; -use Text::ASCIITable; -use Path::Class; +use Text::SimpleTable (); +use Path::Class::Dir (); +use Path::Class::File (); use Time::HiRes qw/gettimeofday tv_interval/; -use URI; -use Scalar::Util qw/weaken/; +use URI (); +use URI::http; +use URI::https; +use Scalar::Util qw/weaken blessed/; +use Tree::Simple qw/use_weak_refs/; +use Tree::Simple::Visitor::FindByUID; +use attributes; +use utf8; +use Carp qw/croak carp/; -__PACKAGE__->mk_accessors(qw/counter depth request response state/); +BEGIN { require 5.008001; } + +__PACKAGE__->mk_accessors( + qw/counter request response state action stack namespace stats/ +); + +sub depth { scalar @{ shift->stack || [] }; } # Laziness++ *comp = \&component; @@ -32,16 +49,22 @@ our $COUNT = 1; our $START = time; our $RECURSION = 1000; our $DETACH = "catalyst_detach\n"; +our $GO = "catalyst_go\n"; -require Module::Pluggable::Fast; +__PACKAGE__->mk_classdata($_) + for qw/components arguments dispatcher engine log dispatcher_class + engine_class context_class request_class response_class stats_class + setup_finished/; -# Helper script generation -our $CATALYST_SCRIPT_GEN = 8; +__PACKAGE__->dispatcher_class('Catalyst::Dispatcher'); +__PACKAGE__->engine_class('Catalyst::Engine::CGI'); +__PACKAGE__->request_class('Catalyst::Request'); +__PACKAGE__->response_class('Catalyst::Response'); +__PACKAGE__->stats_class('Catalyst::Stats'); -__PACKAGE__->mk_classdata($_) - for qw/components arguments dispatcher engine log/; +# Remember to update this in Catalyst::Runtime as well! -our $VERSION = '5.49_01'; +our $VERSION = '5.7099_03'; sub import { my ( $class, @arguments ) = @_; @@ -54,7 +77,7 @@ sub import { unless ( $caller->isa('Catalyst') ) { no strict 'refs'; - push @{"$caller\::ISA"}, $class; + push @{"$caller\::ISA"}, $class, 'Catalyst::Controller'; } $caller->arguments( [@arguments] ); @@ -67,201 +90,767 @@ Catalyst - The Elegant MVC Web Application Framework =head1 SYNOPSIS - # use the helper to start a new application +See the L distribution for comprehensive +documentation and tutorials. + + # Install Catalyst::Devel for helpers and other development tools + # use the helper to create a new application catalyst.pl MyApp - cd MyApp # add models, views, controllers - script/myapp_create.pl model Something - script/myapp_create.pl view Stuff - script/myapp_create.pl controller Yada + script/myapp_create.pl model MyDatabase DBIC::Schema create=dynamic dbi:SQLite:/path/to/db + script/myapp_create.pl view MyTemplate TT + script/myapp_create.pl controller Search - # built in testserver + # built in testserver -- use -r to restart automatically on changes + # --help to see all available options script/myapp_server.pl - # command line interface + # command line testing interface script/myapp_test.pl /yada + ### in lib/MyApp.pm + use Catalyst qw/-Debug/; # include plugins here as well + + ### In lib/MyApp/Controller/Root.pm (autocreated) + sub foo : Global { # called for /foo, /foo/1, /foo/1/2, etc. + my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2 + $c->stash->{template} = 'foo.tt'; # set the template + # lookup something from db -- stash vars are passed to TT + $c->stash->{data} = + $c->model('Database::Foo')->search( { country => $args[0] } ); + if ( $c->req->params->{bar} ) { # access GET or POST parameters + $c->forward( 'bar' ); # process another action + # do something else after forward returns + } + } + + # The foo.tt TT template can use the stash data from the database + [% WHILE (item = data.next) %] + [% item.foo %] + [% END %] + + # called for /bar/of/soap, /bar/of/soap/10, etc. + sub bar : Path('/bar/of/soap') { ... } - use Catalyst; - - use Catalyst qw/My::Module My::OtherModule/; - - use Catalyst '-Debug'; - - use Catalyst qw/-Debug -Engine=CGI/; - - sub default : Private { $_[1]->res->output('Hello') } ); - - sub index : Path('/index.html') { + # called for all actions, from the top-most controller downwards + sub auto : Private { my ( $self, $c ) = @_; - $c->res->output('Hello'); - $c->forward('foo'); + if ( !$c->user_exists ) { # Catalyst::Plugin::Authentication + $c->res->redirect( '/login' ); # require login + return 0; # abort request and go immediately to end() + } + return 1; # success; carry on to next action + } + + # called after all actions are finished + sub end : Private { + my ( $self, $c ) = @_; + if ( scalar @{ $c->error } ) { ... } # handle errors + return if $c->res->body; # already have a response + $c->forward( 'MyApp::View::TT' ); # render template } - sub product : Regex('^product[_]*(\d*).html$') { + ### in MyApp/Controller/Foo.pm + # called for /foo/bar + sub bar : Local { ... } + + # called for /blargle + sub blargle : Global { ... } + + # an index action matches /foo, but not /foo/1, etc. + sub index : Private { ... } + + ### in MyApp/Controller/Foo/Bar.pm + # called for /foo/bar/baz + sub baz : Local { ... } + + # first Root auto is called, then Foo auto, then this + sub auto : Private { ... } + + # powerful regular expression paths are also possible + sub details : Regex('^product/(\w+)/details$') { my ( $self, $c ) = @_; - $c->stash->{template} = 'product.tt'; - $c->stash->{product} = $c->req->snippets->[0]; + # extract the (\w+) from the URI + my $product = $c->req->captures->[0]; } -See also L +See L for additional information. =head1 DESCRIPTION -The key concept of Catalyst is DRY (Don't Repeat Yourself). +Catalyst is a modern framework for making web applications without the +pain usually associated with this process. This document is a reference +to the main Catalyst application. If you are a new user, we suggest you +start with L or L. See L for more documentation. -Catalyst plugins can be loaded by naming them as arguments to the "use Catalyst" statement. -Omit the C prefix from the plugin name, -so C becomes C. +Catalyst plugins can be loaded by naming them as arguments to the "use +Catalyst" statement. Omit the C prefix from the +plugin name, i.e., C becomes +C. + + use Catalyst qw/My::Module/; - use Catalyst 'My::Module'; +If your plugin starts with a name other than C, you can +fully qualify the name by using a unary plus: -Special flags like -Debug and -Engine can also be specified as arguments when -Catalyst is loaded: + use Catalyst qw/ + My::Module + +Fully::Qualified::Plugin::Name + /; + +Special flags like C<-Debug> and C<-Engine> can also be specified as +arguments when Catalyst is loaded: use Catalyst qw/-Debug My::Module/; -The position of plugins and flags in the chain is important, because they are -loaded in exactly the order that they appear. +The position of plugins and flags in the chain is important, because +they are loaded in the order in which they appear. The following flags are supported: -=over 4 - -=item -Debug +=head2 -Debug -enables debug output, i.e.: +Enables debug output. You can also force this setting from the system +environment with CATALYST_DEBUG or _DEBUG. The environment +settings override the application, with _DEBUG having the highest +priority. - use Catalyst '-Debug'; +=head2 -Engine -this is equivalent to: +Forces Catalyst to use a specific engine. Omit the +C prefix of the engine name, i.e.: - use Catalyst; - sub debug { 1 } + use Catalyst qw/-Engine=CGI/; -=item -Dispatcher +=head2 -Home -Force Catalyst to use a specific dispatcher. +Forces Catalyst to use a specific home directory, e.g.: -=item -Engine + use Catalyst qw[-Home=/usr/mst]; -Force Catalyst to use a specific engine. -Omit the C prefix of the engine name, i.e.: +This can also be done in the shell environment by setting either the +C environment variable or C; where C +is replaced with the uppercased name of your application, any "::" in +the name will be replaced with underscores, e.g. MyApp::Web should use +MYAPP_WEB_HOME. If both variables are set, the MYAPP_HOME one will be used. - use Catalyst '-Engine=CGI'; +=head2 -Log -=item -Home +Specifies log level. -Force Catalyst to use a specific home directory. +=head2 -Stats -=item -Log +Enables statistics collection and reporting. You can also force this setting +from the system environment with CATALYST_STATS or _STATS. The +environment settings override the application, with _STATS having the +highest priority. -Specify log level. +e.g. -=back + use Catalyst qw/-Stats=1/ =head1 METHODS -=over 4 +=head2 INFORMATION ABOUT THE CURRENT REQUEST + +=head2 $c->action + +Returns a L object for the current action, which +stringifies to the action name. See L. + +=head2 $c->namespace + +Returns the namespace of the current action, i.e., the URI prefix +corresponding to the controller of the current action. For example: + + # in Controller::Foo::Bar + $c->namespace; # returns 'foo/bar'; + +=head2 $c->request -=item $c->comp($name) +=head2 $c->req -=item $c->component($name) +Returns the current L object, giving access to +information about the current client request (including parameters, +cookies, HTTP headers, etc.). See L. -Get a component object by name. +=head2 REQUEST FLOW HANDLING - $c->comp('MyApp::Model::MyModel')->do_stuff; +=head2 $c->forward( $action [, \@arguments ] ) + +=head2 $c->forward( $class, $method, [, \@arguments ] ) + +Forwards processing to another action, by its private name. If you give a +class name but no method, C is called. You may also optionally +pass arguments in an arrayref. The action will receive the arguments in +C<@_> and C<< $c->req->args >>. Upon returning from the function, +C<< $c->req->args >> will be restored to the previous values. + +Any data Ced from the action forwarded to, will be returned by the +call to forward. + + my $foodata = $c->forward('/foo'); + $c->forward('index'); + $c->forward(qw/MyApp::Model::DBIC::Foo do_stuff/); + $c->forward('MyApp::View::TT'); + +Note that forward implies an C<> around the call (actually +C does), thus de-fatalizing all 'dies' within the called +action. If you want C to propagate you need to do something like: + + $c->forward('foo'); + die $c->error if $c->error; + +Or make sure to always return true values from your actions and write +your code like this: + + $c->forward('foo') || return; =cut -sub component { - my $c = shift; +sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) } + +=head2 $c->detach( $action [, \@arguments ] ) + +=head2 $c->detach( $class, $method, [, \@arguments ] ) + +=head2 $c->detach() + +The same as C, but doesn't return to the previous action when +processing is finished. + +When called with no arguments it escapes the processing chain entirely. + +=cut + +sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) } + +=head2 $c->go( $action [, \@arguments ] ) + +=head2 $c->go( $class, $method, [, \@arguments ] ) + +Almost the same as C, but does a full dispatch, instead of just +calling the new C<$action> / C<$class-E$method>. This means that C, +C and the method you go to is called, just like a new request. + +C<$c-Estash> is kept unchanged. + +=cut + +sub go { my $c = shift; $c->dispatcher->go( $c, @_ ) } + +=head2 $c->response + +=head2 $c->res + +Returns the current L object, see there for details. + +=head2 $c->stash +Returns a hashref to the stash, which may be used to store data and pass +it between components during a request. You can also set hash keys by +passing arguments. The stash is automatically sent to the view. The +stash is cleared at the end of a request; it cannot be used for +persistent storage (for this you must use a session; see +L for a complete system integrated with +Catalyst). + + $c->stash->{foo} = $bar; + $c->stash( { moose => 'majestic', qux => 0 } ); + $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref + + # stash is automatically passed to the view for use in a template + $c->forward( 'MyApp::View::TT' ); + +=cut + +sub stash { + my $c = shift; if (@_) { + my $stash = @_ > 1 ? {@_} : $_[0]; + croak('stash takes a hash or hashref') unless ref $stash; + foreach my $key ( keys %$stash ) { + $c->{stash}->{$key} = $stash->{$key}; + } + } + return $c->{stash}; +} - my $name = shift; +=head2 $c->error - my $appclass = ref $c || $c; +=head2 $c->error($error, ...) - my @names = ( - $name, "${appclass}::${name}", - map { "${appclass}::${_}::${name}" } qw/M V C/ - ); +=head2 $c->error($arrayref) - foreach my $try (@names) { +Returns an arrayref containing error messages. If Catalyst encounters an +error while processing a request, it stores the error in $c->error. This +method should only be used to store fatal error messages. - if ( exists $c->components->{$try} ) { + my @error = @{ $c->error }; - return $c->components->{$try}; - } +Add a new error. + + $c->error('Something bad happened'); + +=cut + +sub error { + my $c = shift; + if ( $_[0] ) { + my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_]; + croak @$error unless ref $c; + push @{ $c->{error} }, @$error; + } + elsif ( defined $_[0] ) { $c->{error} = undef } + return $c->{error} || []; +} + + +=head2 $c->state + +Contains the return value of the last executed action. + +=head2 $c->clear_errors + +Clear errors. You probably don't want to clear the errors unless you are +implementing a custom error screen. + +This is equivalent to running + + $c->error(0); + +=cut + +sub clear_errors { + my $c = shift; + $c->error(0); +} + +# search components given a name and some prefixes +sub _comp_search_prefixes { + my ( $c, $name, @prefixes ) = @_; + my $appclass = ref $c || $c; + my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::'; + + # map the original component name to the sub part that we will search against + my %eligible = map { my $n = $_; $n =~ s{^$appclass\::[^:]+::}{}; $_ => $n; } + grep { /$filter/ } keys %{ $c->components }; + + # undef for a name will return all + return keys %eligible if !defined $name; + + my $query = ref $name ? $name : qr/^$name$/i; + my @result = grep { $eligible{$_} =~ m{$query} } keys %eligible; + + return map { $c->components->{ $_ } } @result if @result; + + # if we were given a regexp to search against, we're done. + return if ref $name; + + # regexp fallback + $query = qr/$name/i; + @result = map { $c->components->{ $_ } } grep { $eligible{ $_ } =~ m{$query} } keys %eligible; + + # no results? try against full names + if( !@result ) { + @result = map { $c->components->{ $_ } } grep { m{$query} } keys %eligible; + } + + # don't warn if we didn't find any results, it just might not exist + if( @result ) { + $c->log->warn( qq(Found results for "${name}" using regexp fallback.) ); + $c->log->warn( 'Relying on the regexp fallback behavior for component resolution is unreliable and unsafe.' ); + $c->log->warn( 'If you really want to search, pass in a regexp as the argument.' ); + } + + return @result; +} + +# Find possible names for a prefix +sub _comp_names { + my ( $c, @prefixes ) = @_; + my $appclass = ref $c || $c; + + my $filter = "^${appclass}::(" . join( '|', @prefixes ) . ')::'; + + my @names = map { s{$filter}{}; $_; } $c->_comp_search_prefixes( undef, @prefixes ); + return @names; +} + +# Filter a component before returning by calling ACCEPT_CONTEXT if available +sub _filter_component { + my ( $c, $comp, @args ) = @_; + + if ( eval { $comp->can('ACCEPT_CONTEXT'); } ) { + return $comp->ACCEPT_CONTEXT( $c, @args ); + } + + return $comp; +} + +=head2 COMPONENT ACCESSORS + +=head2 $c->controller($name) + +Gets a L instance by name. + + $c->controller('Foo')->do_stuff; + +If the name is omitted, will return the controller for the dispatched +action. + +If you want to search for controllers, pass in a regexp as the argument. + + # find all controllers that start with Foo + my @foo_controllers = $c->controller(qr{^Foo}); + + +=cut + +sub controller { + my ( $c, $name, @args ) = @_; + + if( $name ) { + my @result = $c->_comp_search_prefixes( $name, qw/Controller C/ ); + return map { $c->_filter_component( $_, @args ) } @result if ref $name; + return $c->_filter_component( $result[ 0 ], @args ); + } + + return $c->component( $c->action->class ); +} + +=head2 $c->model($name) + +Gets a L instance by name. + + $c->model('Foo')->do_stuff; + +Any extra arguments are directly passed to ACCEPT_CONTEXT. + +If the name is omitted, it will look for + - a model object in $c->stash->{current_model_instance}, then + - a model name in $c->stash->{current_model}, then + - a config setting 'default_model', or + - check if there is only one model, and return it if that's the case. + +If you want to search for models, pass in a regexp as the argument. + + # find all models that start with Foo + my @foo_models = $c->model(qr{^Foo}); + +=cut + +sub model { + my ( $c, $name, @args ) = @_; + + if( $name ) { + my @result = $c->_comp_search_prefixes( $name, qw/Model M/ ); + return map { $c->_filter_component( $_, @args ) } @result if ref $name; + return $c->_filter_component( $result[ 0 ], @args ); + } + + if (ref $c) { + return $c->stash->{current_model_instance} + if $c->stash->{current_model_instance}; + return $c->model( $c->stash->{current_model} ) + if $c->stash->{current_model}; + } + return $c->model( $c->config->{default_model} ) + if $c->config->{default_model}; + + my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/Model M/); + + if( $rest ) { + $c->log->warn( 'Calling $c->model() will return a random model unless you specify one of:' ); + $c->log->warn( '* $c->config->{default_model} # the name of the default model to use' ); + $c->log->warn( '* $c->stash->{current_model} # the name of the model to use for this request' ); + $c->log->warn( '* $c->stash->{current_model_instance} # the instance of the model to use for this request' ); + $c->log->warn( 'NB: in version 5.80, the "random" behavior will not work at all.' ); + } + + return $c->_filter_component( $comp ); +} + + +=head2 $c->view($name) + +Gets a L instance by name. + + $c->view('Foo')->do_stuff; + +Any extra arguments are directly passed to ACCEPT_CONTEXT. + +If the name is omitted, it will look for + - a view object in $c->stash->{current_view_instance}, then + - a view name in $c->stash->{current_view}, then + - a config setting 'default_view', or + - check if there is only one view, and return it if that's the case. + +If you want to search for views, pass in a regexp as the argument. + + # find all views that start with Foo + my @foo_views = $c->view(qr{^Foo}); + +=cut + +sub view { + my ( $c, $name, @args ) = @_; + + if( $name ) { + my @result = $c->_comp_search_prefixes( $name, qw/View V/ ); + return map { $c->_filter_component( $_, @args ) } @result if ref $name; + return $c->_filter_component( $result[ 0 ], @args ); + } + + if (ref $c) { + return $c->stash->{current_view_instance} + if $c->stash->{current_view_instance}; + return $c->view( $c->stash->{current_view} ) + if $c->stash->{current_view}; + } + return $c->view( $c->config->{default_view} ) + if $c->config->{default_view}; + + my( $comp, $rest ) = $c->_comp_search_prefixes( undef, qw/View V/); + + if( $rest ) { + $c->log->warn( 'Calling $c->view() will return a random view unless you specify one of:' ); + $c->log->warn( '* $c->config->{default_view} # the name of the default view to use' ); + $c->log->warn( '* $c->stash->{current_view} # the name of the view to use for this request' ); + $c->log->warn( '* $c->stash->{current_view_instance} # the instance of the view to use for this request' ); + $c->log->warn( 'NB: in version 5.80, the "random" behavior will not work at all.' ); + } + + return $c->_filter_component( $comp ); +} + +=head2 $c->controllers + +Returns the available names which can be passed to $c->controller + +=cut + +sub controllers { + my ( $c ) = @_; + return $c->_comp_names(qw/Controller C/); +} + +=head2 $c->models + +Returns the available names which can be passed to $c->model + +=cut + +sub models { + my ( $c ) = @_; + return $c->_comp_names(qw/Model M/); +} + + +=head2 $c->views + +Returns the available names which can be passed to $c->view + +=cut + +sub views { + my ( $c ) = @_; + return $c->_comp_names(qw/View V/); +} + +=head2 $c->comp($name) + +=head2 $c->component($name) + +Gets a component object by name. This method is not recommended, +unless you want to get a specific component by full +class. C<< $c->controller >>, C<< $c->model >>, and C<< $c->view >> +should be used instead. + +If C<$name> is a regexp, a list of components matched against the full +component name will be returned. + +=cut + +sub component { + my ( $c, $name, @args ) = @_; + + if( $name ) { + my $comps = $c->components; + + if( !ref $name ) { + # is it the exact name? + return $c->_filter_component( $comps->{ $name }, @args ) + if exists $comps->{ $name }; + + # perhaps we just omitted "MyApp"? + my $composed = ( ref $c || $c ) . "::${name}"; + return $c->_filter_component( $comps->{ $composed }, @args ) + if exists $comps->{ $composed }; + + # search all of the models, views and controllers + my( $comp ) = $c->_comp_search_prefixes( $name, qw/Model M Controller C View V/ ); + return $c->_filter_component( $comp, @args ) if $comp; } - foreach my $component ( keys %{ $c->components } ) { + # This is here so $c->comp( '::M::' ) works + my $query = ref $name ? $name : qr{$name}i; + + my @result = grep { m{$query} } keys %{ $c->components }; + return map { $c->_filter_component( $_, @args ) } @result if ref $name; - return $c->components->{$component} if $component =~ /$name/i; + if( $result[ 0 ] ) { + $c->log->warn( qq(Found results for "${name}" using regexp fallback.) ); + $c->log->warn( 'Relying on the regexp fallback behavior for component resolution' ); + $c->log->warn( 'is unreliable and unsafe. You have been warned' ); + return $c->_filter_component( $result[ 0 ], @args ); } + # I would expect to return an empty list here, but that breaks back-compat } + # fallback return sort keys %{ $c->components }; } -=item config +=head2 CLASS DATA AND HELPER CLASSES + +=head2 $c->config -Returns a hashref containing your applications settings. +Returns or takes a hashref containing the application's configuration. -=item debug + __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } ); + +You can also use a C, C or C config file +like myapp.yml in your applications home directory. See +L. + + --- + db: dsn:SQLite:foo.db -Overload to enable debug messages. =cut -sub debug { 0 } +sub config { + my $c = shift; -=item $c->detach( $command [, \@arguments ] ) + $c->log->warn("Setting config after setup has been run is not a good idea.") + if ( @_ and $c->setup_finished ); -Like C but doesn't return. + $c->NEXT::config(@_); +} + +=head2 $c->log + +Returns the logging object instance. Unless it is already set, Catalyst +sets this up with a L object. To use your own log class, +set the logger with the C<< __PACKAGE__->log >> method prior to calling +C<< __PACKAGE__->setup >>. + + __PACKAGE__->log( MyLogger->new ); + __PACKAGE__->setup; + +And later: + + $c->log->info( 'Now logging with my own logger!' ); + +Your log class should implement the methods described in +L. + + +=head2 $c->debug + +Overload to enable debug messages (same as -Debug option). + +Note that this is a static method, not an accessor and should be overloaded +by declaring "sub debug { 1 }" in your MyApp.pm, not by calling $c->debug(1). =cut -sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) } +sub debug { 0 } -=item $c->dispatcher +=head2 $c->dispatcher -Contains the dispatcher instance. -Stringifies to class. +Returns the dispatcher instance. Stringifies to class name. See +L. -=item $c->forward( $command [, \@arguments ] ) +=head2 $c->engine -Forward processing to a private action or a method from a class. -If you define a class without method it will default to process(). -also takes an optional arrayref containing arguments to be passed -to the new function. $c->req->args will be reset upon returning -from the function. +Returns the engine instance. Stringifies to the class name. See +L. - $c->forward('/foo'); - $c->forward('index'); - $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/); - $c->forward('MyApp::View::TT'); + +=head2 UTILITY METHODS + +=head2 $c->path_to(@path) + +Merges C<@path> with C<< $c->config->{home} >> and returns a +L object. + +For example: + + $c->path_to( 'db', 'sqlite.db' ); =cut -sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) } +sub path_to { + my ( $c, @path ) = @_; + my $path = Path::Class::Dir->new( $c->config->{home}, @path ); + if ( -d $path ) { return $path } + else { return Path::Class::File->new( $c->config->{home}, @path ) } +} + +=head2 $c->plugin( $name, $class, @args ) + +Helper method for plugins. It creates a classdata accessor/mutator and +loads and instantiates the given class. + + MyApp->plugin( 'prototype', 'HTML::Prototype' ); + + $c->prototype->define_javascript_functions; + +=cut + +sub plugin { + my ( $class, $name, $plugin, @args ) = @_; + $class->_register_plugin( $plugin, 1 ); + + eval { $plugin->import }; + $class->mk_classdata($name); + my $obj; + eval { $obj = $plugin->new(@args) }; + + if ($@) { + Catalyst::Exception->throw( message => + qq/Couldn't instantiate instant plugin "$plugin", "$@"/ ); + } -=item $c->setup + $class->$name($obj); + $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/) + if $class->debug; +} + +=head2 MyApp->setup -Setup. +Initializes the dispatcher and engine, loads any plugins, and loads the +model, view, and controller components. You may also specify an array +of plugins to load here, if you choose to not load them in the C line. - $c->setup; + MyApp->setup; + MyApp->setup( qw/-Debug/ ); =cut sub setup { my ( $class, @arguments ) = @_; + $class->log->warn("Running setup twice is not a good idea.") + if ( $class->setup_finished ); + unless ( $class->isa('Catalyst') ) { Catalyst::Exception->throw( @@ -289,11 +878,13 @@ sub setup { } } + $class->setup_home( delete $flags->{home} ); + $class->setup_log( delete $flags->{log} ); $class->setup_plugins( delete $flags->{plugins} ); $class->setup_dispatcher( delete $flags->{dispatcher} ); $class->setup_engine( delete $flags->{engine} ); - $class->setup_home( delete $flags->{home} ); + $class->setup_stats( delete $flags->{stats} ); for my $flag ( sort keys %{$flags} ) { @@ -305,29 +896,27 @@ sub setup { } } - $class->log->warn( "You are running an old helper script! " - . "Please update your scripts by regenerating the " - . "application and copying over the new scripts." ) - if ( $ENV{CATALYST_SCRIPT_GEN} - && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::CATALYST_SCRIPT_GEN ) ); + eval { require Catalyst::Devel; }; + if( !$@ && $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::Devel::CATALYST_SCRIPT_GEN ) ) { + $class->log->warn(<<"EOF"); +You are running an old script! - if ( $class->debug ) { + Please update by running (this will overwrite existing files): + catalyst.pl -force -scripts $class - my @plugins = (); + or (this will not overwrite existing files): + catalyst.pl -scripts $class - { - no strict 'refs'; - @plugins = grep { /^Catalyst::Plugin/ } @{"$class\::ISA"}; - } +EOF + } + + if ( $class->debug ) { + my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins; if (@plugins) { - my $t = Text::ASCIITable->new; - $t->setOptions( 'hide_HeadRow', 1 ); - $t->setOptions( 'hide_HeadLine', 1 ); - $t->setCols('Class'); - $t->setColWidth( 'Class', 75, 1 ); - $t->addRow($_) for @plugins; - $class->log->debug( "Loaded plugins:\n" . $t->draw ); + my $t = Text::SimpleTable->new(74); + $t->row($_) for @plugins; + $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" ); } my $dispatcher = $class->dispatcher; @@ -357,14 +946,13 @@ sub setup { $class->setup_components; if ( $class->debug ) { - my $t = Text::ASCIITable->new; - $t->setOptions( 'hide_HeadRow', 1 ); - $t->setOptions( 'hide_HeadLine', 1 ); - $t->setCols('Class'); - $t->setColWidth( 'Class', 75, 1 ); - $t->addRow($_) for sort keys %{ $class->components }; - $class->log->debug( "Loaded components:\n" . $t->draw ) - if ( @{ $t->{tbl_rows} } ); + my $t = Text::SimpleTable->new( [ 63, 'Class' ], [ 8, 'Type' ] ); + for my $comp ( sort keys %{ $class->components } ) { + my $type = ref $class->components->{$comp} ? 'instance' : 'class'; + $t->row( $comp, $type ); + } + $class->log->debug( "Loaded components:\n" . $t->draw . "\n" ) + if ( keys %{ $class->components } ); } # Add our self to components, since we are also a component @@ -373,187 +961,130 @@ sub setup { $class->setup_actions; if ( $class->debug ) { - my $name = $class->config->{name} || 'Application'; - $class->log->info("$name powered by Catalyst $Catalyst::VERSION"); - } - $class->log->_flush() if $class->log->can('_flush'); -} - -=item $c->uri_for($path) - -Merges path with $c->request->base for absolute uri's and with -$c->request->match for relative uri's, then returns a normalized -L object. - -=cut - -sub uri_for { - my ( $c, $path ) = @_; - my $base = $c->request->base->clone; - my $basepath = $base->path; - $basepath =~ s/\/$//; - $basepath .= '/'; - my $match = $c->request->match; - $match =~ s/^\///; - $match .= '/' if $match; - $match = '' if $path =~ /^\//; - $path =~ s/^\///; - return URI->new_abs( URI->new_abs( $path, "$basepath$match" ), $base ) - ->canonical; -} - -=item $c->error - -=item $c->error($error, ...) - -=item $c->error($arrayref) - -Returns an arrayref containing error messages. - - my @error = @{ $c->error }; - -Add a new error. - - $c->error('Something bad happened'); - -=cut - -sub error { - my $c = shift; - my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_]; - push @{ $c->{error} }, @$error; - return $c->{error}; -} - -=item $c->engine - -Contains the engine instance. -Stringifies to the class. - -=item $c->log - -Contains the logging object. Unless it is already set Catalyst sets this up with a -C object. To use your own log class: - - $c->log( MyLogger->new ); - $c->log->info("now logging with my own logger!"); - -Your log class should implement the methods described in the C -man page. - -=item $c->plugin( $name, $class, @args ) - -Instant plugins for Catalyst. -Classdata accessor/mutator will be created, class loaded and instantiated. - - MyApp->plugin( 'prototype', 'HTML::Prototype' ); - - $c->prototype->define_javascript_functions; - -=cut - -sub plugin { - my ( $class, $name, $plugin, @args ) = @_; - $plugin->require; - - if ( my $error = $UNIVERSAL::require::ERROR ) { - Catalyst::Exception->throw( - message => qq/Couldn't load instant plugin "$plugin", "$error"/ ); - } - - eval { $plugin->import }; - $class->mk_classdata($name); - my $obj; - eval { $obj = $plugin->new(@args) }; - - if ($@) { - Catalyst::Exception->throw( message => - qq/Couldn't instantiate instant plugin "$plugin", "$@"/ ); - } - - $class->$name($obj); - $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/) - if $class->debug; -} - -=item $c->request - -=item $c->req - -Returns a C object. - - my $req = $c->req; - -=item $c->response - -=item $c->res + my $name = $class->config->{name} || 'Application'; + $class->log->info("$name powered by Catalyst $Catalyst::VERSION"); + } + $class->log->_flush() if $class->log->can('_flush'); -Returns a C object. + $class->setup_finished(1); +} - my $res = $c->res; +=head2 $c->uri_for( $path, @args?, \%query_values? ) -=item $c->state +Merges path with C<< $c->request->base >> for absolute URIs and with +C<< $c->namespace >> for relative URIs, then returns a normalized L +object. If any args are passed, they are added at the end of the path. +If the last argument to C is a hash reference, it is assumed to +contain GET parameter key/value pairs, which will be appended to the URI +in standard fashion. -Contains the return value of the last executed action. +Note that uri_for is destructive to the passed hashref. Subsequent calls +with the same hashref may have unintended results. -=item $c->stash +Instead of C<$path>, you can also optionally pass a C<$action> object +which will be resolved to a path using +C<< $c->dispatcher->uri_for_action >>; if the first element of +C<@args> is an arrayref it is treated as a list of captures to be passed +to C. -Returns a hashref containing all your data. +=cut - print $c->stash->{foo}; +sub uri_for { + my ( $c, $path, @args ) = @_; + + if ( Scalar::Util::blessed($path) ) { # action object + my $captures = ( scalar @args && ref $args[0] eq 'ARRAY' + ? shift(@args) + : [] ); + $path = $c->dispatcher->uri_for_action($path, $captures); + return undef unless defined($path); + $path = '/' if $path eq ''; + } -Keys may be set in the stash by assigning to the hash reference, or by passing -either a single hash reference or a list of key/value pairs as arguments. + undef($path) if (defined $path && $path eq ''); -For example: + my $params = + ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} ); - $c->stash->{foo} ||= 'yada'; - $c->stash( { moose => 'majestic', qux => 0 } ); - $c->stash( bar => 1, gorch => 2 ); + carp "uri_for called with undef argument" if grep { ! defined $_ } @args; + s/([^$URI::uric])/$URI::Escape::escapes{$1}/go for @args; -=cut + unshift(@args, $path); -sub stash { - my $c = shift; - if (@_) { - my $stash = @_ > 1 ? {@_} : $_[0]; - while ( my ( $key, $val ) = each %$stash ) { - $c->{stash}->{$key} = $val; + unless (defined $path && $path =~ s!^/!!) { # in-place strip + my $namespace = $c->namespace; + if (defined $path) { # cheesy hack to handle path '../foo' + $namespace =~ s{(?:^|/)[^/]+$}{} while $args[0] =~ s{^\.\./}{}; } + unshift(@args, $namespace || ''); } - return $c->{stash}; + + # join args with '/', or a blank string + my $args = join('/', grep { defined($_) } @args); + $args =~ s/\?/%3F/g; # STUPID STUPID SPECIAL CASE + $args =~ s!^/!!; + my $base = $c->req->base; + my $class = ref($base); + $base =~ s{(?{$_}; + s/([;\/?:@&=+,\$\[\]%])/$URI::Escape::escapes{$1}/go; + s/ /+/g; + my $key = $_; + $val = '' unless defined $val; + (map { + $_ = "$_"; + utf8::encode( $_ ) if utf8::is_utf8($_); + # using the URI::Escape pattern here so utf8 chars survive + s/([^A-Za-z0-9\-_.!~*'() ])/$URI::Escape::escapes{$1}/go; + s/ /+/g; + "${key}=$_"; } ( ref $val eq 'ARRAY' ? @$val : $val )); + } @keys); + } + + my $res = bless(\"${base}${args}${query}", $class); + $res; } -=head1 $c->welcome_message +=head2 $c->welcome_message Returns the Catalyst welcome HTML page. =cut sub welcome_message { - my $c = shift; - my $name = $c->config->{name}; - my $logo = $c->uri_for('/static/images/catalyst_logo.png'); + my $c = shift; + my $name = $c->config->{name}; + my $logo = $c->uri_for('/static/images/catalyst_logo.png'); + my $prefix = Catalyst::Utils::appprefix( ref $c ); + $c->response->content_type('text/html; charset=utf-8'); return <<"EOF"; - + + + + $name on Catalyst $VERSION @@ -608,53 +1139,44 @@ sub welcome_message {
-

$name on Catalyst +

$name on Catalyst $VERSION

- + Catalyst Logo

-

Welcome to the wonderful world of Catalyst. - This MVC framework will make web development - something you had never expected it to be: - Fun, rewarding and quick.

+

Welcome to the world of Catalyst. + This MVC + framework will make web development something you had + never expected it to be: Fun, rewarding, and quick.

What to do now?

That really depends on what you want to do. We do, however, provide you with a few starting points.

If you want to jump right into web development with Catalyst - you might want to check out the documentation.

- 
perldoc Catalyst::Manual
-perldoc Catalyst::Manual::Intro
-

If you would like some background information on the - MVC-pattern, these links might be of help to you.

- + you might want to start with a tutorial.

+
perldoc Catalyst::Manual::Tutorial
+
+

Afterwards you can go on to check out a more complete look at our features.

+
+perldoc Catalyst::Manual::Intro
+
+

What to do next?

-

Next you need to create an actual application. Use the - helper scripts for what they are worth, they can save you - a lot of work getting everything set up. Also, be sure to - check out the vast array of plugins for Catalyst on CPAN. - They can handle everything from A to Z - , and a whole lot in between.

+

Next it's time to write an actual application. Use the + helper scripts to generate controllers, + models, and + views; + they can save you a lot of work.

+ 
script/${prefix}_create.pl -help
+

Also, be sure to check out the vast and growing + collection of plugins for Catalyst on CPAN; + you are likely to find what you need there. +

+

Need help?

-

Catalyst has a very active community. The main places to get - in touch are these.

+

Catalyst has a very active community. Here are the main places to + get in touch with us.