X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst.pm;h=6f1848a4db3502333a02f5e0e66faea5cf8f423e;hp=8470aba85a7bc2d7e0f762b7a61ade7526540536;hb=85d9fce671016c9040775c8b4458cf9c72ec2208;hpb=8c11318848e17f92027484614d393b6ebd365f7d diff --git a/lib/Catalyst.pm b/lib/Catalyst.pm index 8470aba..6f1848a 100644 --- a/lib/Catalyst.pm +++ b/lib/Catalyst.pm @@ -1,26 +1,43 @@ 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::SimpleTable; -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/; + +BEGIN { require 5.008001; } __PACKAGE__->mk_accessors( - qw/counter depth request response state action namespace/ + qw/counter request response state action stack namespace stats/ ); +attributes->import( __PACKAGE__, \&namespace, 'lvalue' ); + +sub depth { scalar @{ shift->stack || [] }; } + # Laziness++ *comp = \&component; *req = \&request; @@ -35,15 +52,18 @@ our $START = time; our $RECURSION = 1000; our $DETACH = "catalyst_detach\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 setup_finished/; -# Helper script generation -our $CATALYST_SCRIPT_GEN = 10; +__PACKAGE__->dispatcher_class('Catalyst::Dispatcher'); +__PACKAGE__->engine_class('Catalyst::Engine::CGI'); +__PACKAGE__->request_class('Catalyst::Request'); +__PACKAGE__->response_class('Catalyst::Response'); -__PACKAGE__->mk_classdata($_) - for qw/components arguments dispatcher engine log/; +# Remember to update this in Catalyst::Runtime as well! -our $VERSION = '5.49_03'; +our $VERSION = '5.7008'; sub import { my ( $class, @arguments ) = @_; @@ -56,7 +76,7 @@ sub import { unless ( $caller->isa('Catalyst') ) { no strict 'refs'; - push @{"$caller\::ISA"}, $class; + push @{"$caller\::ISA"}, $class, 'Catalyst::Controller'; } $caller->arguments( [@arguments] ); @@ -69,495 +89,894 @@ 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 +=head2 -Debug -=item -Debug +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. -enables debug output, i.e.: +=head2 -Engine - use Catalyst '-Debug'; +Forces Catalyst to use a specific engine. Omit the +C prefix of the engine name, i.e.: -this is equivalent to: + use Catalyst qw/-Engine=CGI/; - use Catalyst; - sub debug { 1 } +=head2 -Home -=item -Dispatcher +Forces Catalyst to use a specific home directory, e.g.: -Force Catalyst to use a specific dispatcher. + use Catalyst qw[-Home=/usr/mst]; -=item -Engine +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. -Force Catalyst to use a specific engine. -Omit the C prefix of the engine name, i.e.: +=head2 -Log - use Catalyst '-Engine=CGI'; +Specifies log level. -=item -Home +=head1 METHODS -Force Catalyst to use a specific home directory. +=head2 INFORMATION ABOUT THE CURRENT REQUEST -=item -Log +=head2 $c->action -Specify log level. +Returns a L object for the current action, which +stringifies to the action name. See L. -=back +=head2 $c->namespace -=head1 METHODS +Returns the namespace of the current action, i.e., the URI prefix +corresponding to the controller of the current action. For example: -=over 4 + # in Controller::Foo::Bar + $c->namespace; # returns 'foo/bar'; -=item $c->action +=head2 $c->request -Accessor for the current action +=head2 $c->req -=item $c->comp($name) +Returns the current L object, giving access to +information about the current client request (including parameters, +cookies, HTTP headers, etc.). See L. -=item $c->component($name) +=head2 REQUEST FLOW HANDLING -Get a component object by name. +=head2 $c->forward( $action [, \@arguments ] ) - $c->comp('MyApp::Model::MyModel')->do_stuff; +=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, @_ ) } - if (@_) { +=head2 $c->detach( $action [, \@arguments ] ) - my $name = shift; +=head2 $c->detach( $class, $method, [, \@arguments ] ) - my $appclass = ref $c || $c; +=head2 $c->detach() - my @names = ( - $name, "${appclass}::${name}", - map { "${appclass}::${_}::${name}" } qw/M V C/ - ); +The same as C, but doesn't return to the previous action when +processing is finished. - foreach my $try (@names) { +When called with no arguments it escapes the processing chain entirely. - if ( exists $c->components->{$try} ) { +=cut - return $c->components->{$try}; - } +sub detach { my $c = shift; $c->dispatcher->detach( $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}; +} - foreach my $component ( keys %{ $c->components } ) { +=head2 $c->error + +=head2 $c->error($error, ...) + +=head2 $c->error($arrayref) + +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. + + my @error = @{ $c->error }; + +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 via regex +sub _comp_search { + my ( $c, @names ) = @_; + + foreach my $name (@names) { + foreach my $component ( keys %{ $c->components } ) { return $c->components->{$component} if $component =~ /$name/i; } + } + + return undef; +} + +# try explicit component names +sub _comp_explicit { + my ( $c, @names ) = @_; + foreach my $try (@names) { + return $c->components->{$try} if ( exists $c->components->{$try} ); } - return sort keys %{ $c->components }; + return undef; +} + +# like component, but try just these prefixes before regex searching, +# and do not try to return "sort keys %{ $c->components }" +sub _comp_prefixes { + my ( $c, $name, @prefixes ) = @_; + + my $appclass = ref $c || $c; + + my @names = map { "${appclass}::${_}::${name}" } @prefixes; + + my $comp = $c->_comp_explicit(@names); + return $comp if defined($comp); + $comp = $c->_comp_search($name); + return $comp; +} + +# Find possible names for a prefix + +sub _comp_names { + my ( $c, @prefixes ) = @_; + + my $appclass = ref $c || $c; + + my @pre = map { "${appclass}::${_}::" } @prefixes; + + my @names; + + COMPONENT: foreach my $comp ($c->component) { + foreach my $p (@pre) { + if ($comp =~ s/^$p//) { + push(@names, $comp); + next COMPONENT; + } + } + } + + return @names; } -=item config +# Return a component if only one matches. +sub _comp_singular { + my ( $c, @prefixes ) = @_; + + my $appclass = ref $c || $c; + + my ( $comp, $rest ) = + map { $c->_comp_search("^${appclass}::${_}::") } @prefixes; + return $comp unless $rest; +} -Returns a hashref containing your applications settings. +# 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 ); + } + else { return $comp } +} -=item debug +=head2 COMPONENT ACCESSORS -Overload to enable debug messages. +=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. =cut -sub debug { 0 } +sub controller { + my ( $c, $name, @args ) = @_; + return $c->_filter_component( $c->_comp_prefixes( $name, qw/Controller C/ ), + @args ) + if ($name); + return $c->component( $c->action->class ); +} -=item $c->detach( $command [, \@arguments ] ) +=head2 $c->model($name) -Like C but doesn't return. +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. =cut -sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) } +sub model { + my ( $c, $name, @args ) = @_; + return $c->_filter_component( $c->_comp_prefixes( $name, qw/Model M/ ), + @args ) + if $name; + 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}; + return $c->_filter_component( $c->_comp_singular(qw/Model M/) ); -=item $c->dispatcher +} -Contains the dispatcher instance. -Stringifies to class. +=head2 $c->controllers -=item $c->forward( $command [, \@arguments ] ) +Returns the available names which can be passed to $c->controller -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. +=cut - $c->forward('/foo'); - $c->forward('index'); - $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/); - $c->forward('MyApp::View::TT'); +sub controllers { + my ( $c ) = @_; + return $c->_comp_names(qw/Controller C/); +} + + +=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. =cut -sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) } +sub view { + my ( $c, $name, @args ) = @_; + return $c->_filter_component( $c->_comp_prefixes( $name, qw/View V/ ), + @args ) + if $name; + 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}; + return $c->_filter_component( $c->_comp_singular(qw/View V/) ); +} -=item $c->namespace +=head2 $c->models -Accessor to the namespace of the current action +Returns the available names which can be passed to $c->model -=item $c->path_to(@path) +=cut -Merges C<@path> with $c->config->{home} and returns a L object. +sub models { + my ( $c ) = @_; + return $c->_comp_names(qw/Model M/); +} -For example: - $c->path_to( 'db', 'sqlite.db' ); +=head2 $c->views + +Returns the available names which can be passed to $c->view =cut -sub path_to { - my ( $c, @path ) = @_; - my $path = dir( $c->config->{home}, @path ); - if ( -d $path ) { return $path } - else { return file( $c->config->{home}, @path ) } +sub views { + my ( $c ) = @_; + return $c->_comp_names(qw/View V/); } -=item $c->setup +=head2 $c->comp($name) -Setup. +=head2 $c->component($name) - $c->setup; +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. =cut -sub setup { - my ( $class, @arguments ) = @_; +sub component { + my $c = shift; - unless ( $class->isa('Catalyst') ) { + if (@_) { - Catalyst::Exception->throw( - message => qq/'$class' does not inherit from Catalyst/ ); - } + my $name = shift; - if ( $class->arguments ) { - @arguments = ( @arguments, @{ $class->arguments } ); - } + my $appclass = ref $c || $c; - # Process options - my $flags = {}; + my @names = ( + $name, "${appclass}::${name}", + map { "${appclass}::${_}::${name}" } + qw/Model M Controller C View V/ + ); - foreach (@arguments) { + my $comp = $c->_comp_explicit(@names); + return $c->_filter_component( $comp, @_ ) if defined($comp); - if (/^-Debug$/) { - $flags->{log} = - ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug'; - } - elsif (/^-(\w+)=?(.*)$/) { - $flags->{ lc $1 } = $2; - } - else { - push @{ $flags->{plugins} }, $_; - } + $comp = $c->_comp_search($name); + return $c->_filter_component( $comp, @_ ) if defined($comp); } - $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} ); + return sort keys %{ $c->components }; +} - for my $flag ( sort keys %{$flags} ) { - if ( my $code = $class->can( 'setup_' . $flag ) ) { - &$code( $class, delete $flags->{$flag} ); - } - else { - $class->log->warn(qq/Unknown flag "$flag"/); - } - } - $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 ) ); +=head2 CLASS DATA AND HELPER CLASSES - if ( $class->debug ) { +=head2 $c->config - my @plugins = (); +Returns or takes a hashref containing the application's configuration. - { - no strict 'refs'; - @plugins = grep { /^Catalyst::Plugin/ } @{"$class\::ISA"}; - } + __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } ); - if (@plugins) { - my $t = Text::SimpleTable->new(76); - $t->row($_) for @plugins; - $class->log->debug( "Loaded plugins:\n" . $t->draw ); - } +You can also use a C, C or C config file +like myapp.yml in your applications home directory. See +L. - my $dispatcher = $class->dispatcher; - my $engine = $class->engine; - my $home = $class->config->{home}; + --- + db: dsn:SQLite:foo.db - $class->log->debug(qq/Loaded dispatcher "$dispatcher"/); - $class->log->debug(qq/Loaded engine "$engine"/); - $home - ? ( -d $home ) - ? $class->log->debug(qq/Found home "$home"/) - : $class->log->debug(qq/Home "$home" doesn't exist/) - : $class->log->debug(q/Couldn't find home/); - } +=cut - # Call plugins setup - { - no warnings qw/redefine/; - local *setup = sub { }; - $class->setup; - } +sub config { + my $c = shift; - # Initialize our data structure - $class->components( {} ); + $c->log->warn("Setting config after setup has been run is not a good idea.") + if ( @_ and $c->setup_finished ); - $class->setup_components; + $c->NEXT::config(@_); +} - if ( $class->debug ) { - my $t = Text::SimpleTable->new(76); - $t->row($_) for sort keys %{ $class->components }; - $class->log->debug( "Loaded components:\n" . $t->draw ) - if ( keys %{ $class->components } ); - } +=head2 $c->log - # Add our self to components, since we are also a component - $class->components->{$class} = $class; +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 >>. - $class->setup_actions; + __PACKAGE__->log( MyLogger->new ); + __PACKAGE__->setup; - 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'); -} +And later: + + $c->log->info( 'Now logging with my own logger!' ); -=item $c->uri_for($path,[@args]) +Your log class should implement the methods described in +L. -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. If any args are passed, they are added at the end -of the path. + +=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 uri_for { - my ( $c, $path, @args ) = @_; - my $base = $c->request->base->clone; - my $basepath = $base->path; - $basepath =~ s/\/$//; - $basepath .= '/'; - my $match = $c->request->match; - - # massage match, empty if absolute path - $match =~ s/^\///; - $match .= '/' if $match; - $path ||= ''; - $match = '' if $path =~ /^\//; - $path =~ s/^\///; +sub debug { 0 } - # join args with '/', or a blank string - my $args = ( scalar @args ? '/' . join( '/', @args ) : '' ); - return URI->new_abs( URI->new_abs( "$path$args", "$basepath$match" ), - $base )->canonical; -} +=head2 $c->dispatcher -=item $c->error +Returns the dispatcher instance. Stringifies to class name. See +L. -=item $c->error($error, ...) +=head2 $c->engine -=item $c->error($arrayref) +Returns the engine instance. Stringifies to the class name. See +L. -Returns an arrayref containing error messages. - my @error = @{ $c->error }; +=head2 UTILITY METHODS -Add a new error. +=head2 $c->path_to(@path) - $c->error('Something bad happened'); +Merges C<@path> with C<< $c->config->{home} >> and returns a +L object. -Clean errors. +For example: - $c->error(0); + $c->path_to( 'db', 'sqlite.db' ); =cut -sub error { - my $c = shift; - if ( $_[0] ) { - my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_]; - push @{ $c->{error} }, @$error; +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", "$@"/ ); } - elsif ( defined $_[0] ) { $c->{error} = undef } - return $c->{error} || []; + + $class->$name($obj); + $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/) + if $class->debug; } -=item $c->engine +=head2 MyApp->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. + + 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( + message => qq/'$class' does not inherit from Catalyst/ ); + } + + if ( $class->arguments ) { + @arguments = ( @arguments, @{ $class->arguments } ); + } + + # Process options + my $flags = {}; + + foreach (@arguments) { + + if (/^-Debug$/) { + $flags->{log} = + ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug'; + } + elsif (/^-(\w+)=?(.*)$/) { + $flags->{ lc $1 } = $2; + } + else { + push @{ $flags->{plugins} }, $_; + } + } -Contains the engine instance. -Stringifies to the class. + $class->setup_home( delete $flags->{home} ); -=item $c->log + $class->setup_log( delete $flags->{log} ); + $class->setup_plugins( delete $flags->{plugins} ); + $class->setup_dispatcher( delete $flags->{dispatcher} ); + $class->setup_engine( delete $flags->{engine} ); -Contains the logging object. Unless it is already set Catalyst sets this up with a -C object. To use your own log class: + for my $flag ( sort keys %{$flags} ) { - $c->log( MyLogger->new ); - $c->log->info("now logging with my own logger!"); + if ( my $code = $class->can( 'setup_' . $flag ) ) { + &$code( $class, delete $flags->{$flag} ); + } + else { + $class->log->warn(qq/Unknown flag "$flag"/); + } + } -Your log class should implement the methods described in the C -man page. + 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! -=item $c->plugin( $name, $class, @args ) + Please update by running (this will overwrite existing files): + catalyst.pl -force -scripts $class -Instant plugins for Catalyst. -Classdata accessor/mutator will be created, class loaded and instantiated. + or (this will not overwrite existing files): + catalyst.pl -scripts $class - MyApp->plugin( 'prototype', 'HTML::Prototype' ); +EOF + } + + if ( $class->debug ) { + my @plugins = map { "$_ " . ( $_->VERSION || '' ) } $class->registered_plugins; - $c->prototype->define_javascript_functions; + if (@plugins) { + my $t = Text::SimpleTable->new(74); + $t->row($_) for @plugins; + $class->log->debug( "Loaded plugins:\n" . $t->draw . "\n" ); + } -=cut + my $dispatcher = $class->dispatcher; + my $engine = $class->engine; + my $home = $class->config->{home}; -sub plugin { - my ( $class, $name, $plugin, @args ) = @_; - $plugin->require; + $class->log->debug(qq/Loaded dispatcher "$dispatcher"/); + $class->log->debug(qq/Loaded engine "$engine"/); - if ( my $error = $UNIVERSAL::require::ERROR ) { - Catalyst::Exception->throw( - message => qq/Couldn't load instant plugin "$plugin", "$error"/ ); + $home + ? ( -d $home ) + ? $class->log->debug(qq/Found home "$home"/) + : $class->log->debug(qq/Home "$home" doesn't exist/) + : $class->log->debug(q/Couldn't find home/); } - 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", "$@"/ ); + # Call plugins setup + { + no warnings qw/redefine/; + local *setup = sub { }; + $class->setup; } - $class->$name($obj); - $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/) - if $class->debug; -} - -=item $c->request + # Initialize our data structure + $class->components( {} ); -=item $c->req + $class->setup_components; -Returns a C object. + if ( $class->debug ) { + 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 } ); + } - my $req = $c->req; + # Add our self to components, since we are also a component + $class->components->{$class} = $class; -=item $c->response + $class->setup_actions; -=item $c->res + 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'); -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. +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. -=item $c->stash +=cut -Returns a hashref containing all your data. +sub uri_for { + my ( $c, $path, @args ) = @_; - print $c->stash->{foo}; + 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{(?{$_}; + $val = '' unless defined $val; + (map { + $_ = "$_"; + utf8::encode( $_ ); + # 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; } -=item $c->welcome_message +=head2 $c->welcome_message Returns the Catalyst welcome HTML page. @@ -574,8 +993,8 @@ sub welcome_message { "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> - - + + $name on Catalyst $VERSION