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=ccdc85ec63551f8f8d917b1ce0ca6e0097b53d5d;hb=496021a4740bcccf5b630f9fbd6f6bff0882dfc7;hpb=b304b69e0bfefe7624baf1c4f95c50c3b8335d5c diff --git a/lib/Catalyst.pm b/lib/Catalyst.pm index ccdc85e..15b3ea3 100644 --- a/lib/Catalyst.pm +++ b/lib/Catalyst.pm @@ -54,7 +54,7 @@ __PACKAGE__->engine_class('Catalyst::Engine::CGI'); __PACKAGE__->request_class('Catalyst::Request'); __PACKAGE__->response_class('Catalyst::Response'); -our $VERSION = '5.49_04'; +our $VERSION = '5.5'; sub import { my ( $class, @arguments ) = @_; @@ -98,17 +98,18 @@ Catalyst - The Elegant MVC Web Application Framework 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/on you/ for /foo/on/you - $c->stash->{template} = 'foo.tt'; + 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; + $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 easily use the stash data from the database + # The foo.tt TT template can use the stash data from the database [% WHILE (item = data.next) %] [% item.foo %] [% END %] @@ -116,20 +117,17 @@ Catalyst - The Elegant MVC Web Application Framework # called for /bar/of/soap, /bar/of/soap/10, etc. sub bar : Path('/bar/of/soap') { ... } - # called for / and only /, no other args - sub baz : Path { ... } - - # called for all actions, from the top-most controller inwards + # 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; + return 1; # success; carry on to next action } - # called after the main action is finished + # called after all actions are finished sub end : Private { my ( $self, $c ) = @_; if ( scalar @{ $c->error } ) { ... } # handle errors @@ -141,8 +139,11 @@ Catalyst - The Elegant MVC Web Application Framework # called for /foo/bar sub bar : Local { ... } - # overrides /foo, but not /foo/1, etc. - sub index : Path { ... } + # 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 @@ -166,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, i.e., -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/; -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: @@ -190,14 +192,16 @@ Enables debug output. =item -Engine -Forces 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 qw/-Engine=CGI/; =item -Home -Forces 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 @@ -213,20 +217,23 @@ Specifies log level. =item $c->action -Returns a L object for the current action, which stringifies to the action name. +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. +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. - - my $req = $c->req; +Returns the current L object. See +L. =back @@ -238,11 +245,11 @@ Returns the current L object. =item $c->forward( $class, $method, [, \@arguments ] ) -Forwards processing to a private action. If you give a class name but -no method, process() is called. You may also optionally pass arguments -in an arrayref. The action will receive the arguments in @_ and $c->req->args. -Upon returning from the function, $c->req->args will be restored to the previous -values. +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'); @@ -299,13 +306,13 @@ sub error { Returns the current L object. - my $res = $c->res; - =item $c->stash -Returns a hashref to the stash, which may be used to store data and pass it -between components. You can also set hash keys by passing arguments. The -stash is automatically sent to the view. +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 } ); @@ -341,8 +348,10 @@ Contains the return value of the last executed action. =item $c->component($name) -Gets a component object by name. This method is no longer recommended. -$c->controller, $c->model, and $c->view should be used instead. +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 @@ -357,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) { @@ -445,22 +455,24 @@ sub debug { 0 } =item $c->dispatcher -Returns the dispatcher instance. Stringifies to class name. +Returns the dispatcher instance. Stringifies to class name. See +L. =item $c->engine -Returns the engine instance. Stringifies to the class name. +Returns the engine instance. Stringifies to the class name. See +L. =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: +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!' ); + $c->log->info( 'Now logging with my own logger!' ); -Your log class should implement the methods described in the L -man page. +Your log class should implement the methods described in the +L man page. =cut @@ -472,7 +484,8 @@ man page. =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: @@ -489,8 +502,8 @@ sub path_to { =item $c->plugin( $name, $class, @args ) -Helper method for plugins. It creates a classdata accessor/mutator and loads -and instantiates the given class. +Helper method for plugins. It creates a classdata accessor/mutator and +loads and instantiates the given class. MyApp->plugin( 'prototype', 'HTML::Prototype' ); @@ -525,9 +538,9 @@ sub plugin { =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 'use Catalyst' -line. +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/ ); @@ -653,10 +666,10 @@ EOF =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 @@ -830,6 +843,8 @@ EOF =head1 INTERNAL METHODS +These methods are not meant to be used by end users. + =over 4 =item $c->benchmark( $coderef ) @@ -860,8 +875,8 @@ 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 @@ -879,10 +894,10 @@ sub dispatch { my $c = shift; $c->dispatcher->dispatch( $c, @_ ) } Returns or sets the dispatcher class. -=item dump_these +=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. +Returns a list of 2-element array references (name, structure) pairs +that will be dumped on the error page in debug mode. =cut @@ -1069,7 +1084,7 @@ sub finalize_read { my $c = shift; $c->engine->finalize_read( $c, @_ ) } =item $c->finalize_uploads -Finalizes uploads. Cleans up any temporary files. +Finalizes uploads. Cleans up any temporary files. =cut @@ -1085,7 +1100,8 @@ sub get_action { my $c = shift; $c->dispatcher->get_action(@_) } =item $c->get_actions( $action, $namespace ) -Gets all actions of a given name in a namespace and all parent namespaces. +Gets all actions of a given name in a namespace and all parent +namespaces. =cut @@ -1140,8 +1156,8 @@ sub handle_request { =item $c->prepare( @arguments ) -Creates a Catalyst context from an engine-specific request -(Apache, CGI, etc.). +Creates a Catalyst context from an engine-specific request (Apache, CGI, +etc.). =cut @@ -1204,14 +1220,15 @@ 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; } @@ -1406,11 +1423,12 @@ Returns or sets the response class. =item $c->read( [$maxlength] ) -Reads 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 @@ -1505,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 { @@ -1540,6 +1560,8 @@ sub setup_dispatcher { =item $c->setup_engine +Sets up engine. + =cut sub setup_engine { @@ -1662,6 +1684,8 @@ qq/Couldn't load engine "$engine" (maybe you forgot to install it?), "$@"/ =item $c->setup_home +Sets up the home directory. + =cut sub setup_home { @@ -1687,6 +1711,8 @@ sub setup_home { =item $c->setup_log +Sets up log. + =cut sub setup_log { @@ -1712,6 +1738,8 @@ sub setup_log { =item $c->setup_plugins +Sets up plugins. + =cut sub setup_plugins { @@ -1742,9 +1770,9 @@ 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 @@ -1759,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 @@ -1770,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; @@ -1831,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 @@ -1844,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 @@ -1865,13 +1891,13 @@ Wiki: =item L, L - Base classes for components -=item L - Core Engine +=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.