X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst.pm;h=15b3ea3e0d42f1f5c6ff7b12d4b837a255c16341;hp=49d8fc3449c8ce06c630b7f1ebf1e518668572cf;hb=496021a4740bcccf5b630f9fbd6f6bff0882dfc7;hpb=7f92deef6d24d2a7618ba679892189838fcb4dfd diff --git a/lib/Catalyst.pm b/lib/Catalyst.pm index 49d8fc3..15b3ea3 100644 --- a/lib/Catalyst.pm +++ b/lib/Catalyst.pm @@ -11,16 +11,21 @@ use Catalyst::Request::Upload; use Catalyst::Response; use Catalyst::Utils; use NEXT; -use Text::ASCIITable; +use Text::SimpleTable; use Path::Class; use Time::HiRes qw/gettimeofday tv_interval/; use URI; use Scalar::Util qw/weaken/; +use attributes; __PACKAGE__->mk_accessors( - qw/counter depth request response state action namespace/ + qw/counter request response state action stack namespace/ ); +attributes->import( __PACKAGE__, \&namespace, 'lvalue' ); + +sub depth { scalar @{ shift->stack || [] }; } + # Laziness++ *comp = \&component; *req = \&request; @@ -38,12 +43,18 @@ our $DETACH = "catalyst_detach\n"; require Module::Pluggable::Fast; # Helper script generation -our $CATALYST_SCRIPT_GEN = 9; +our $CATALYST_SCRIPT_GEN = 11; __PACKAGE__->mk_classdata($_) - for qw/components arguments dispatcher engine log/; + for qw/components arguments dispatcher engine log dispatcher_class + engine_class context_class request_class response_class/; + +__PACKAGE__->dispatcher_class('Catalyst::Dispatcher'); +__PACKAGE__->engine_class('Catalyst::Engine::CGI'); +__PACKAGE__->request_class('Catalyst::Request'); +__PACKAGE__->response_class('Catalyst::Response'); -our $VERSION = '5.49_02'; +our $VERSION = '5.5'; sub import { my ( $class, @arguments ) = @_; @@ -71,43 +82,84 @@ Catalyst - The Elegant MVC Web Application Framework # use the helper to start 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 Database DBIC dbi:SQLite:/path/to/db + script/myapp_create.pl view TT TT + script/myapp_create.pl controller Search - # built in testserver + # built in testserver -- use -r to restart automatically on changes script/myapp_server.pl - # command line interface + # command line testing interface script/myapp_test.pl /yada + ### in MyApp.pm + use Catalyst qw/-Debug/; # include plugins here as well + + 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} = + MyApp::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 ) = @_; + if ( !$c->user ) { + $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 ) = @_; - $c->res->output('Hello'); - $c->forward('foo'); + 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 MyApp 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->snippets->[0]; } -See also L +See L for additional information. =head1 DESCRIPTION @@ -115,19 +167,20 @@ The key concept of Catalyst is DRY (Don't Repeat Yourself). 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 'My::Module'; + use Catalyst qw/My::Module/; -Special flags like -Debug and -Engine can also be specified as arguments when -Catalyst is loaded: +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 exactly the order in which they appear. The following flags are supported: @@ -135,51 +188,170 @@ The following flags are supported: =item -Debug -enables debug output, i.e.: - - use Catalyst '-Debug'; - -this is equivalent to: - - use Catalyst; - sub debug { 1 } - -=item -Dispatcher - -Force Catalyst to use a specific dispatcher. +Enables debug output. =item -Engine -Force Catalyst to use a specific engine. -Omit the C prefix of the engine name, i.e.: +Forces Catalyst to use a specific engine. Omit the +C prefix of the engine name, i.e.: - use Catalyst '-Engine=CGI'; + use Catalyst qw/-Engine=CGI/; =item -Home -Force Catalyst to use a specific home directory. +Forces Catalyst to use a specific home directory, e.g.: + + use Catalyst qw[-Home=/usr/sri]; =item -Log -Specify log level. +Specifies log level. =back =head1 METHODS +=head2 Information about the current request + =over 4 =item $c->action -Accessor for the current action +Returns a L object for the current action, which +stringifies to the action name. See L. + +=item $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'; + +=item $c->request + +=item $c->req + +Returns the current L object. See +L. + +=back + +=head2 Processing and response to the current request + +=over 4 + +=item $c->forward( $action [, \@arguments ] ) + +=item $c->forward( $class, $method, [, \@arguments ] ) + +Forwards processing to a private action. 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-Ereq-Eargs>. Upon returning from the function, +C<$c-Ereq-Eargs> will be restored to the previous values. + + $c->forward('/foo'); + $c->forward('index'); + $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/); + $c->forward('MyApp::View::TT'); + +=cut + +sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) } + +=item $c->detach( $action [, \@arguments ] ) + +=item $c->detach( $class, $method, [, \@arguments ] ) + +The same as C, but doesn't return. + +=cut + +sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) } + +=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'); + +Clear errors. + + $c->error(0); + +=cut + +sub error { + my $c = shift; + if ( $_[0] ) { + my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_]; + push @{ $c->{error} }, @$error; + } + elsif ( defined $_[0] ) { $c->{error} = undef } + return $c->{error} || []; +} + +=item $c->response + +=item $c->res + +Returns the current L object. + +=item $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. + + $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::V::TT' ); + +=cut + +sub stash { + my $c = shift; + if (@_) { + my $stash = @_ > 1 ? {@_} : $_[0]; + while ( my ( $key, $val ) = each %$stash ) { + $c->{stash}->{$key} = $val; + } + } + return $c->{stash}; +} + +=item $c->state + +Contains the return value of the last executed action. + +=back + +=head2 Component Accessors + +=over 4 =item $c->comp($name) =item $c->component($name) -Get a component object by name. - - $c->comp('MyApp::Model::MyModel')->do_stuff; +Gets a component object by name. This method is no longer recommended, +unless you want to get a specific component by full +class. C<$c-Econtroller>, C<$c-Emodel>, and C<$c-Eview> +should be used instead. =cut @@ -194,7 +366,8 @@ sub component { my @names = ( $name, "${appclass}::${name}", - map { "${appclass}::${_}::${name}" } qw/M V C/ + map { "${appclass}::${_}::${name}" } + qw/Model M Controller C View V/ ); foreach my $try (@names) { @@ -215,55 +388,104 @@ sub component { return sort keys %{ $c->components }; } -=item config +=item $c->controller($name) -Returns a hashref containing your applications settings. +Gets a L instance by name. -=item debug + $c->controller('Foo')->do_stuff; -Overload to enable debug messages. +=cut + +sub controller { + my ( $c, $name ) = @_; + my $controller = $c->comp("Controller::$name"); + return $controller if $controller; + return $c->comp("C::$name"); +} + +=item $c->model($name) + +Gets a L instance by name. + + $c->model('Foo')->do_stuff; =cut -sub debug { 0 } +sub model { + my ( $c, $name ) = @_; + my $model = $c->comp("Model::$name"); + return $model if $model; + return $c->comp("M::$name"); +} + +=item $c->view($name) -=item $c->detach( $command [, \@arguments ] ) +Gets a L instance by name. -Like C but doesn't return. + $c->view('Foo')->do_stuff; =cut -sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) } +sub view { + my ( $c, $name ) = @_; + my $view = $c->comp("View::$name"); + return $view if $view; + return $c->comp("V::$name"); +} + +=back + +=head2 Class data and helper classes + +=over 4 + +=item $c->config + +Returns or takes a hashref containing the application's configuration. + + __PACKAGE__->config({ db => 'dsn:SQLite:foo.db' }); + +=item $c->debug + +Overload to enable debug messages (same as -Debug option). + +=cut + +sub debug { 0 } =item $c->dispatcher -Contains the dispatcher instance. -Stringifies to class. +Returns the dispatcher instance. Stringifies to class name. See +L. -=item $c->forward( $command [, \@arguments ] ) +=item $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'); +=item $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: + + $c->log( MyLogger->new ); + $c->log->info( 'Now logging with my own logger!' ); + +Your log class should implement the methods described in the +L man page. =cut -sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) } +=back -=item $c->namespace +=head2 Utility methods -Accessor to the namespace of the current action +=over 4 =item $c->path_to(@path) -Merges C<@path> with $c->config->{home} and returns a L object. +Merges C<@path> with C<$c-Econfig-E{home}> and returns a +L object. For example: @@ -278,11 +500,50 @@ sub path_to { else { return file( $c->config->{home}, @path ) } } -=item $c->setup +=item $c->plugin( $name, $class, @args ) -Setup. +Helper method for plugins. It creates a classdata accessor/mutator and +loads and instantiates the given class. - $c->setup; + 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 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 @@ -332,11 +593,13 @@ 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 ) ); + $class->log->warn( + <<"EOF") if ( $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::CATALYST_SCRIPT_GEN ) ); +You are running an old script! + + Please update by running: + catalyst.pl -nonew -scripts $class +EOF if ( $class->debug ) { @@ -348,12 +611,8 @@ sub setup { } 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; + my $t = Text::SimpleTable->new(76); + $t->row($_) for @plugins; $class->log->debug( "Loaded plugins:\n" . $t->draw ); } @@ -384,14 +643,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 }; + my $t = Text::SimpleTable->new( [ 65, '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 ) - if ( @{ $t->{tbl_rows} } ); + if ( keys %{ $class->components } ); } # Add our self to components, since we are also a component @@ -406,12 +664,12 @@ sub setup { $class->log->_flush() if $class->log->can('_flush'); } -=item $c->uri_for($path,[@args]) +=item $c->uri_for( $path, [ @args ] ) -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. +Merges path with C<$c-Erequest-Ebase> for absolute uri's and +with C<$c-Erequest-Ematch> for relative uri's, then returns a +normalized L object. If any args are passed, they are added at the +end of the path. =cut @@ -426,6 +684,7 @@ sub uri_for { # massage match, empty if absolute path $match =~ s/^\///; $match .= '/' if $match; + $path ||= ''; $match = '' if $path =~ /^\//; $path =~ s/^\///; @@ -435,135 +694,6 @@ sub uri_for { $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'); - -Clean errors. - - $c->error(0); - -=cut - -sub error { - my $c = shift; - if ( $_[0] ) { - my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_]; - push @{ $c->{error} }, @$error; - } - elsif ( defined $_[0] ) { $c->{error} = undef } - 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 - -Returns a C object. - - my $res = $c->res; - -=item $c->state - -Contains the return value of the last executed action. - -=item $c->stash - -Returns a hashref containing all your data. - - print $c->stash->{foo}; - -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. - -For example: - - $c->stash->{foo} ||= 'yada'; - $c->stash( { moose => 'majestic', qux => 0 } ); - $c->stash( bar => 1, gorch => 2 ); - -=cut - -sub stash { - my $c = shift; - if (@_) { - my $stash = @_ > 1 ? {@_} : $_[0]; - while ( my ( $key, $val ) = each %$stash ) { - $c->{stash}->{$key} = $val; - } - } - return $c->{stash}; -} - =item $c->welcome_message Returns the Catalyst welcome HTML page. @@ -575,20 +705,24 @@ sub welcome_message { 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 @@ -649,12 +784,12 @@ sub welcome_message {
-

$name on Catalyst +

$name on Catalyst $VERSION

- + Catalyst Logo

Welcome to the wonderful world of Catalyst. This MVC @@ -669,13 +804,13 @@ sub welcome_message { perldoc Catalyst::Manual

What to do next?

Next it's time to write an actual application. Use the - helper scripts to generate controllers, - models and - views, + 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, + collection of plugins for Catalyst on CPAN, you are likely to find what you need there.

@@ -708,9 +843,11 @@ EOF =head1 INTERNAL METHODS +These methods are not meant to be used by end users. + =over 4 -=item $c->benchmark($coderef) +=item $c->benchmark( $coderef ) Takes a coderef with arguments and returns elapsed time as float. @@ -730,30 +867,37 @@ sub benchmark { =item $c->components -Contains the components. +Returns a hash of components. + +=item $c->context_class + +Returns or sets the context class. =item $c->counter -Returns a hashref containing coderefs and execution counts. -(Needed for deep recursion detection) +Returns a hashref containing coderefs and execution counts (needed for +deep recursion detection). =item $c->depth -Returns the actual forward depth. +Returns the number of actions on the current internal execution stack. =item $c->dispatch -Dispatch request to actions. +Dispatches a request to actions. =cut sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) } +=item $c->dispatcher_class -=item dump_these +Returns or sets the dispatcher class. -Returns a list of 2-element array references (name, structure) pairs that will -be dumped on the error page in debug mode. +=item $c->dump_these + +Returns a list of 2-element array references (name, structure) pairs +that will be dumped on the error page in debug mode. =cut @@ -762,10 +906,14 @@ sub dump_these { [ Request => $c->req ], [ Response => $c->res ], [ Stash => $c->stash ],; } -=item $c->execute($class, $coderef) +=item $c->engine_class + +Returns or sets the engine class. + +=item $c->execute( $class, $coderef ) -Execute a coderef in given class and catch exceptions. -Errors are available via $c->error. +Execute a coderef in given class and catch exceptions. Errors are available +via $c->error. =cut @@ -773,7 +921,11 @@ sub execute { my ( $c, $class, $code ) = @_; $class = $c->components->{$class} || $class; $c->state(0); - my $callsub = ( caller(1) )[3]; + + my $callsub = + ( caller(0) )[0]->isa('Catalyst::Action') + ? ( caller(2) )[3] + : ( caller(1) )[3]; my $action = ''; if ( $c->debug ) { @@ -791,31 +943,33 @@ sub execute { $action = "-> $action" if $callsub =~ /forward$/; } - $c->{depth}++; + push( @{ $c->stack }, $code ); eval { if ( $c->debug ) { my ( $elapsed, @state ) = $c->benchmark( $code, $class, $c, @{ $c->req->args } ); - push @{ $c->{stats} }, [ $action, sprintf( '%fs', $elapsed ) ]; + unless ( ( $code->name =~ /^_.*/ ) + && ( !$c->config->{show_internal_actions} ) ) + { + push @{ $c->{stats} }, [ $action, sprintf( '%fs', $elapsed ) ]; + } $c->state(@state); } else { $c->state( &$code( $class, $c, @{ $c->req->args } ) || 0 ); } }; - $c->{depth}--; + pop( @{ $c->stack } ); if ( my $error = $@ ) { - if ( $error eq $DETACH ) { die $DETACH if $c->{depth} > 1 } + if ( $error eq $DETACH ) { die $DETACH if $c->depth > 1 } else { unless ( ref $error ) { chomp $error; $error = qq/Caught exception "$error"/; } - - $c->log->error($error); $c->error($error); $c->state(0); } @@ -825,13 +979,17 @@ sub execute { =item $c->finalize -Finalize request. +Finalizes the request. =cut sub finalize { my $c = shift; + for my $error ( @{ $c->error } ) { + $c->log->error($error); + } + $c->finalize_uploads; # Error @@ -853,7 +1011,7 @@ sub finalize { =item $c->finalize_body -Finalize body. +Finalizes body. =cut @@ -861,7 +1019,7 @@ sub finalize_body { my $c = shift; $c->engine->finalize_body( $c, @_ ) } =item $c->finalize_cookies -Finalize cookies. +Finalizes cookies. =cut @@ -869,7 +1027,7 @@ sub finalize_cookies { my $c = shift; $c->engine->finalize_cookies( $c, @_ ) } =item $c->finalize_error -Finalize error. +Finalizes error. =cut @@ -877,7 +1035,7 @@ sub finalize_error { my $c = shift; $c->engine->finalize_error( $c, @_ ) } =item $c->finalize_headers -Finalize headers. +Finalizes headers. =cut @@ -918,7 +1076,7 @@ An alias for finalize_body. =item $c->finalize_read -Finalize the input after reading is complete. +Finalizes the input after reading is complete. =cut @@ -926,7 +1084,7 @@ sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) } =item $c->finalize_uploads -Finalize uploads. Cleans up any temporary files. +Finalizes uploads. Cleans up any temporary files. =cut @@ -934,15 +1092,16 @@ sub finalize_uploads { my $c = shift; $c->engine->finalize_uploads( $c, @_ ) } =item $c->get_action( $action, $namespace ) -Get an action in a given namespace. +Gets an action in a given namespace. =cut -sub get_action { my $c = shift; $c->dispatcher->get_action( $c, @_ ) } +sub get_action { my $c = shift; $c->dispatcher->get_action(@_) } =item $c->get_actions( $action, $namespace ) -Get all actions of a given name in a namespace and all base namespaces. +Gets all actions of a given name in a namespace and all parent +namespaces. =cut @@ -950,7 +1109,7 @@ sub get_actions { my $c = shift; $c->dispatcher->get_actions( $c, @_ ) } =item handle_request( $class, @arguments ) -Handles the request. +Called to handle each HTTP request. =cut @@ -975,12 +1134,9 @@ sub handle_request { $elapsed = sprintf '%f', $elapsed; my $av = sprintf '%.3f', ( $elapsed == 0 ? '??' : ( 1 / $elapsed ) ); - my $t = Text::ASCIITable->new; - $t->setCols( 'Action', 'Time' ); - $t->setColWidth( 'Action', 64, 1 ); - $t->setColWidth( 'Time', 9, 1 ); + my $t = Text::SimpleTable->new( [ 64, 'Action' ], [ 9, 'Time' ] ); - for my $stat (@stats) { $t->addRow( $stat->[0], $stat->[1] ) } + for my $stat (@stats) { $t->row( $stat->[0], $stat->[1] ) } $class->log->info( "Request took ${elapsed}s ($av/s)\n" . $t->draw ); } @@ -998,43 +1154,46 @@ sub handle_request { return $status; } -=item $c->prepare(@arguments) +=item $c->prepare( @arguments ) -Turns the engine-specific request( Apache, CGI ... ) -into a Catalyst context . +Creates a Catalyst context from an engine-specific request (Apache, CGI, +etc.). =cut sub prepare { my ( $class, @arguments ) = @_; - my $c = bless { - counter => {}, - depth => 0, - request => Catalyst::Request->new( - { - arguments => [], - body_parameters => {}, - cookies => {}, - headers => HTTP::Headers->new, - parameters => {}, - query_parameters => {}, - secure => 0, - snippets => [], - uploads => {} - } - ), - response => Catalyst::Response->new( - { - body => '', - cookies => {}, - headers => HTTP::Headers->new(), - status => 200 - } - ), - stash => {}, - state => 0 - }, $class; + $class->context_class( ref $class || $class ) unless $class->context_class; + my $c = $class->context_class->new( + { + counter => {}, + stack => [], + request => $class->request_class->new( + { + arguments => [], + body_parameters => {}, + cookies => {}, + headers => HTTP::Headers->new, + parameters => {}, + query_parameters => {}, + secure => 0, + snippets => [], + uploads => {} + } + ), + response => $class->response_class->new( + { + body => '', + cookies => {}, + headers => HTTP::Headers->new(), + status => 200 + } + ), + stash => {}, + state => 0 + } + ); # For on-demand data $c->request->{_context} = $c; @@ -1061,20 +1220,21 @@ sub prepare { # On-demand parsing $c->prepare_body unless $c->config->{parse_on_demand}; - $c->prepare_action; my $method = $c->req->method || ''; my $path = $c->req->path || ''; my $address = $c->req->address || ''; - $c->log->debug(qq/"$method" request for "$path" from $address/) + $c->log->debug(qq/"$method" request for "$path" from "$address"/) if $c->debug; + $c->prepare_action; + return $c; } =item $c->prepare_action -Prepare action. +Prepares action. =cut @@ -1082,7 +1242,7 @@ sub prepare_action { my $c = shift; $c->dispatcher->prepare_action( $c, @_ ) } =item $c->prepare_body -Prepare message body. +Prepares message body. =cut @@ -1098,15 +1258,11 @@ sub prepare_body { $c->prepare_uploads; if ( $c->debug && keys %{ $c->req->body_parameters } ) { - my $t = Text::ASCIITable->new; - $t->setCols( 'Key', 'Value' ); - $t->setColWidth( 'Key', 37, 1 ); - $t->setColWidth( 'Value', 36, 1 ); - $t->alignCol( 'Value', 'right' ); + my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] ); for my $key ( sort keys %{ $c->req->body_parameters } ) { my $param = $c->req->body_parameters->{$key}; my $value = defined($param) ? $param : ''; - $t->addRow( $key, + $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value ); } $c->log->debug( "Body Parameters are:\n" . $t->draw ); @@ -1115,7 +1271,7 @@ sub prepare_body { =item $c->prepare_body_chunk( $chunk ) -Prepare a chunk of data before sending it to HTTP::Body. +Prepares a chunk of data before sending it to L. =cut @@ -1126,7 +1282,7 @@ sub prepare_body_chunk { =item $c->prepare_body_parameters -Prepare body parameters. +Prepares body parameters. =cut @@ -1137,7 +1293,7 @@ sub prepare_body_parameters { =item $c->prepare_connection -Prepare connection. +Prepares connection. =cut @@ -1148,7 +1304,7 @@ sub prepare_connection { =item $c->prepare_cookies -Prepare cookies. +Prepares cookies. =cut @@ -1156,7 +1312,7 @@ sub prepare_cookies { my $c = shift; $c->engine->prepare_cookies( $c, @_ ) } =item $c->prepare_headers -Prepare headers. +Prepares headers. =cut @@ -1164,7 +1320,7 @@ sub prepare_headers { my $c = shift; $c->engine->prepare_headers( $c, @_ ) } =item $c->prepare_parameters -Prepare parameters. +Prepares parameters. =cut @@ -1176,7 +1332,7 @@ sub prepare_parameters { =item $c->prepare_path -Prepare path and base. +Prepares path and base. =cut @@ -1184,7 +1340,7 @@ sub prepare_path { my $c = shift; $c->engine->prepare_path( $c, @_ ) } =item $c->prepare_query_parameters -Prepare query parameters. +Prepares query parameters. =cut @@ -1194,15 +1350,11 @@ sub prepare_query_parameters { $c->engine->prepare_query_parameters( $c, @_ ); if ( $c->debug && keys %{ $c->request->query_parameters } ) { - my $t = Text::ASCIITable->new; - $t->setCols( 'Key', 'Value' ); - $t->setColWidth( 'Key', 37, 1 ); - $t->setColWidth( 'Value', 36, 1 ); - $t->alignCol( 'Value', 'right' ); + my $t = Text::SimpleTable->new( [ 37, 'Key' ], [ 36, 'Value' ] ); for my $key ( sort keys %{ $c->req->query_parameters } ) { my $param = $c->req->query_parameters->{$key}; my $value = defined($param) ? $param : ''; - $t->addRow( $key, + $t->row( $key, ref $value eq 'ARRAY' ? ( join ', ', @$value ) : $value ); } $c->log->debug( "Query Parameters are:\n" . $t->draw ); @@ -1211,7 +1363,7 @@ sub prepare_query_parameters { =item $c->prepare_read -Prepare the input for reading. +Prepares the input for reading. =cut @@ -1219,7 +1371,7 @@ sub prepare_read { my $c = shift; $c->engine->prepare_read( $c, @_ ) } =item $c->prepare_request -Prepare the engine request. +Prepares the engine request. =cut @@ -1227,7 +1379,7 @@ sub prepare_request { my $c = shift; $c->engine->prepare_request( $c, @_ ) } =item $c->prepare_uploads -Prepare uploads. +Prepares uploads. =cut @@ -1237,17 +1389,16 @@ sub prepare_uploads { $c->engine->prepare_uploads( $c, @_ ); if ( $c->debug && keys %{ $c->request->uploads } ) { - my $t = Text::ASCIITable->new; - $t->setCols( 'Key', 'Filename', 'Type', 'Size' ); - $t->setColWidth( 'Key', 12, 1 ); - $t->setColWidth( 'Filename', 28, 1 ); - $t->setColWidth( 'Type', 18, 1 ); - $t->setColWidth( 'Size', 9, 1 ); - $t->alignCol( 'Size', 'left' ); + my $t = Text::SimpleTable->new( + [ 12, 'Key' ], + [ 28, 'Filename' ], + [ 18, 'Type' ], + [ 9, 'Size' ] + ); for my $key ( sort keys %{ $c->request->uploads } ) { my $upload = $c->request->uploads->{$key}; for my $u ( ref $upload eq 'ARRAY' ? @{$upload} : ($upload) ) { - $t->addRow( $key, $u->filename, $u->type, $u->size ); + $t->row( $key, $u->filename, $u->type, $u->size ); } } $c->log->debug( "File Uploads are:\n" . $t->draw ); @@ -1256,19 +1407,28 @@ sub prepare_uploads { =item $c->prepare_write -Prepare the output for writing. +Prepares the output for writing. =cut sub prepare_write { my $c = shift; $c->engine->prepare_write( $c, @_ ) } +=item $c->request_class + +Returns or sets the request class. + +=item $c->response_class + +Returns or sets the response class. + =item $c->read( [$maxlength] ) -Read a chunk of data from the request body. This method is designed to be -used in a while loop, reading $maxlength bytes on every call. $maxlength -defaults to the size of the request if not specified. +Reads a chunk of data from the request body. This method is designed to +be used in a while loop, reading C<$maxlength> bytes on every call. +C<$maxlength> defaults to the size of the request if not specified. -You have to set MyApp->config->{parse_on_demand} to use this directly. +You have to set Cconfig-E{parse_on_demand}> to use this +directly. =cut @@ -1284,7 +1444,7 @@ sub run { my $c = shift; return $c->engine->run( $c, @_ ) } =item $c->set_action( $action, $code, $namespace, $attrs ) -Set an action in a given namespace. +Sets an action in a given namespace. =cut @@ -1292,7 +1452,7 @@ sub set_action { my $c = shift; $c->dispatcher->set_action( $c, @_ ) } =item $c->setup_actions($component) -Setup actions for a component. +Sets up actions for a component. =cut @@ -1300,7 +1460,7 @@ sub setup_actions { my $c = shift; $c->dispatcher->setup_actions( $c, @_ ) } =item $c->setup_components -Setup components. +Sets up components. =cut @@ -1310,7 +1470,7 @@ sub setup_components { my $callback = sub { my ( $component, $context ) = @_; - unless ( $component->isa('Catalyst::Base') ) { + unless ( $component->isa('Catalyst::Component') ) { return $component; } @@ -1363,6 +1523,8 @@ qq/Couldn't instantiate component "$component", "new() didn't return a object"/ =item $c->setup_dispatcher +Sets up dispatcher. + =cut sub setup_dispatcher { @@ -1382,7 +1544,7 @@ sub setup_dispatcher { } unless ($dispatcher) { - $dispatcher = 'Catalyst::Dispatcher'; + $dispatcher = $class->dispatcher_class; } $dispatcher->require; @@ -1398,6 +1560,8 @@ sub setup_dispatcher { =item $c->setup_engine +Sets up engine. + =cut sub setup_engine { @@ -1471,7 +1635,7 @@ sub setup_engine { } unless ($engine) { - $engine = 'Catalyst::Engine::CGI'; + $engine = $class->engine_class; } $engine->require; @@ -1481,45 +1645,47 @@ sub setup_engine { qq/Couldn't load engine "$engine" (maybe you forgot to install it?), "$@"/ ); } - + # check for old engines that are no longer compatible my $old_engine; - if ( $engine->isa('Catalyst::Engine::Apache') - && ! Catalyst::Engine::Apache->VERSION ) + if ( $engine->isa('Catalyst::Engine::Apache') + && !Catalyst::Engine::Apache->VERSION ) { $old_engine = 1; } - + elsif ( $engine->isa('Catalyst::Engine::Server::Base') - && Catalyst::Engine::Server->VERSION le '0.02' ) + && Catalyst::Engine::Server->VERSION le '0.02' ) { $old_engine = 1; } - - elsif ( $engine->isa('Catalyst::Engine::HTTP::POE') - && $engine->VERSION eq '0.01' ) + + elsif ($engine->isa('Catalyst::Engine::HTTP::POE') + && $engine->VERSION eq '0.01' ) { $old_engine = 1; } - - elsif ( $engine->isa('Catalyst::Engine::Zeus') - && $engine->VERSION eq '0.01' ) + + elsif ($engine->isa('Catalyst::Engine::Zeus') + && $engine->VERSION eq '0.01' ) { $old_engine = 1; } if ($old_engine) { Catalyst::Exception->throw( message => - qq/Engine "$engine" is not supported by this version of Catalyst/ + qq/Engine "$engine" is not supported by this version of Catalyst/ ); } - + # engine instance $class->engine( $engine->new ); } =item $c->setup_home +Sets up the home directory. + =cut sub setup_home { @@ -1545,6 +1711,8 @@ sub setup_home { =item $c->setup_log +Sets up log. + =cut sub setup_log { @@ -1554,7 +1722,14 @@ sub setup_log { $class->log( Catalyst::Log->new ); } - if ( $ENV{CATALYST_DEBUG} || $ENV{ uc($class) . '_DEBUG' } || $debug ) { + my $app_flag = Catalyst::Utils::class2env($class) . '_DEBUG'; + + if ( + ( defined( $ENV{CATALYST_DEBUG} ) || defined( $ENV{$app_flag} ) ) + ? ( $ENV{CATALYST_DEBUG} || $ENV{$app_flag} ) + : $debug + ) + { no strict 'refs'; *{"$class\::debug"} = sub { 1 }; $class->log->debug('Debug messages enabled'); @@ -1563,6 +1738,8 @@ sub setup_log { =item $c->setup_plugins +Sets up plugins. + =cut sub setup_plugins { @@ -1587,11 +1764,15 @@ sub setup_plugins { } } +=item $c->stack + +Returns the stack. + =item $c->write( $data ) -Writes $data to the output stream. When using this method directly, you will -need to manually set the Content-Length header to the length of your output -data, if known. +Writes $data to the output stream. When using this method directly, you +will need to manually set the C header to the length of +your output data, if known. =cut @@ -1606,8 +1787,8 @@ sub write { =item version -Returns the Catalyst version number. mostly useful for powered by messages -in template systems. +Returns the Catalyst version number. Mostly useful for "powered by" +messages in template systems. =cut @@ -1617,57 +1798,55 @@ sub version { return $Catalyst::VERSION } =head1 INTERNAL ACTIONS -Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO> -C<_ACTION> and C<_END>, these are by default not shown in the private -action table. - -But you can deactivate this with a config parameter. +Catalyst uses internal actions like C<_DISPATCH>, C<_BEGIN>, C<_AUTO>, +C<_ACTION>, and C<_END>. These are by default not shown in the private +action table, but you can make them visible with a config parameter. MyApp->config->{show_internal_actions} = 1; =head1 CASE SENSITIVITY -By default Catalyst is not case sensitive, so C becomes -C. - -But you can activate case sensitivity with a config parameter. +By default Catalyst is not case sensitive, so C is +mapped to C. You can activate case sensitivity with a config +parameter. MyApp->config->{case_sensitive} = 1; -So C becomes C. +This causes C to map to C. =head1 ON-DEMAND PARSER The request body is usually parsed at the beginning of a request, -but if you want to handle input yourself or speed things up a bit +but if you want to handle input yourself or speed things up a bit, you can enable on-demand parsing with a config parameter. MyApp->config->{parse_on_demand} = 1; =head1 PROXY SUPPORT -Many production servers operate using the common double-server approach, with -a lightweight frontend web server passing requests to a larger backend -server. An application running on the backend server must deal with two -problems: the remote user always appears to be '127.0.0.1' and the server's -hostname will appear to be 'localhost' regardless of the virtual host the -user connected through. +Many production servers operate using the common double-server approach, +with a lightweight frontend web server passing requests to a larger +backend server. An application running on the backend server must deal +with two problems: the remote user always appears to be C<127.0.0.1> and +the server's hostname will appear to be C regardless of the +virtual host that the user connected through. -Catalyst will automatically detect this situation when you are running both -the frontend and backend servers on the same machine. The following changes -are made to the request. +Catalyst will automatically detect this situation when you are running +the frontend and backend servers on the same machine. The following +changes are made to the request. - $c->req->address is set to the user's real IP address, as read from the - HTTP_X_FORWARDED_FOR header. + $c->req->address is set to the user's real IP address, as read from + the HTTP X-Forwarded-For header. - The host value for $c->req->base and $c->req->uri is set to the real host, - as read from the HTTP_X_FORWARDED_HOST header. + The host value for $c->req->base and $c->req->uri is set to the real + host, as read from the HTTP X-Forwarded-Host header. -Obviously, your web server must support these 2 headers for this to work. +Obviously, your web server must support these headers for this to work. -In a more complex server farm environment where you may have your frontend -proxy server(s) on different machines, you will need to set a configuration -option to tell Catalyst to read the proxied data from the headers. +In a more complex server farm environment where you may have your +frontend proxy server(s) on different machines, you will need to set a +configuration option to tell Catalyst to read the proxied data from the +headers. MyApp->config->{using_frontend_proxy} = 1; @@ -1678,12 +1857,12 @@ If you do not wish to use the proxy support at all, you may set: =head1 THREAD SAFETY Catalyst has been tested under Apache 2's threading mpm_worker, mpm_winnt, -and the standalone forking HTTP server on Windows. We believe the Catalyst +and the standalone forking HTTP server on Windows. We believe the Catalyst core to be thread-safe. If you plan to operate in a threaded environment, remember that all other -modules you are using must also be thread-safe. Some modules, most notably -DBD::SQLite, are not thread-safe. +modules you are using must also be thread-safe. Some modules, most notably +L, are not thread-safe. =head1 SUPPORT @@ -1691,7 +1870,7 @@ IRC: Join #catalyst on irc.perl.org. -Mailing-Lists: +Mailing Lists: http://lists.rawmode.org/mailman/listinfo/catalyst http://lists.rawmode.org/mailman/listinfo/catalyst-dev @@ -1700,19 +1879,25 @@ Web: http://catalyst.perl.org +Wiki: + + http://dev.catalyst.perl.org + =head1 SEE ALSO =over 4 =item L - The Catalyst Manual -=item L - Core Engine +=item L, L - Base classes for components + +=item L - Core engine -=item L - The Log Class. +=item L - Log class. -=item L - The Request Object +=item L - Request object -=item L - The Response Object +=item L - Response object =item L - The test suite. @@ -1736,6 +1921,8 @@ Arthur Bergman Autrijus Tang +Brian Cassidy + Christian Hansen Christopher Hicks @@ -1744,6 +1931,8 @@ Dan Sully Danijel Milicevic +David Kamholz + David Naughton Gary Ashton Jones @@ -1770,6 +1959,8 @@ Robert Sedlacek Sam Vilain +Sascha Kiefer + Tatsuhiko Miyagawa Ulf Edvinsson