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=81117c91e6d45b6f53d370155b9c3d3c0d90b5da;hb=496021a4740bcccf5b630f9fbd6f6bff0882dfc7;hpb=33108eafaedec785c7ebdef4eb65a8d935b3af55 diff --git a/lib/Catalyst.pm b/lib/Catalyst.pm index 81117c9..15b3ea3 100644 --- a/lib/Catalyst.pm +++ b/lib/Catalyst.pm @@ -11,13 +11,20 @@ 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/); +__PACKAGE__->mk_accessors( + qw/counter request response state action stack namespace/ +); + +attributes->import( __PACKAGE__, \&namespace, 'lvalue' ); + +sub depth { scalar @{ shift->stack || [] }; } # Laziness++ *comp = \&component; @@ -36,12 +43,18 @@ our $DETACH = "catalyst_detach\n"; require Module::Pluggable::Fast; # Helper script generation -our $CATALYST_SCRIPT_GEN = 8; +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/; -our $VERSION = '5.49_01'; +__PACKAGE__->dispatcher_class('Catalyst::Dispatcher'); +__PACKAGE__->engine_class('Catalyst::Engine::CGI'); +__PACKAGE__->request_class('Catalyst::Request'); +__PACKAGE__->response_class('Catalyst::Response'); + +our $VERSION = '5.5'; sub import { my ( $class, @arguments ) = @_; @@ -69,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 ) = @_; - $c->res->output('Hello'); - $c->forward('foo'); + 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 ) = @_; + 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 @@ -113,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: @@ -133,37 +188,159 @@ The following flags are supported: =item -Debug -enables debug output, i.e.: +Enables debug output. - use Catalyst '-Debug'; +=item -Engine -this is equivalent to: +Forces Catalyst to use a specific engine. Omit the +C prefix of the engine name, i.e.: - use Catalyst; - sub debug { 1 } + use Catalyst qw/-Engine=CGI/; -=item -Dispatcher +=item -Home -Force Catalyst to use a specific dispatcher. +Forces Catalyst to use a specific home directory, e.g.: -=item -Engine + use Catalyst qw[-Home=/usr/sri]; -Force Catalyst to use a specific engine. -Omit the C prefix of the engine name, i.e.: +=item -Log - use Catalyst '-Engine=CGI'; +Specifies log level. -=item -Home +=back -Force Catalyst to use a specific home directory. +=head1 METHODS -=item -Log +=head2 Information about the current request + +=over 4 -Specify log level. +=item $c->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 -=head1 METHODS +=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 @@ -171,9 +348,10 @@ Specify log level. =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 @@ -188,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) { @@ -209,53 +388,162 @@ sub component { return sort keys %{ $c->components }; } -=item config +=item $c->controller($name) + +Gets a L instance by name. -Returns a hashref containing your applications settings. + $c->controller('Foo')->do_stuff; -=item debug +=cut + +sub controller { + my ( $c, $name ) = @_; + my $controller = $c->comp("Controller::$name"); + return $controller if $controller; + return $c->comp("C::$name"); +} -Overload to enable debug messages. +=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->engine -=item $c->forward( $command [, \@arguments ] ) +Returns the engine instance. Stringifies to the class name. See +L. -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. +=item $c->log - $c->forward('/foo'); - $c->forward('index'); - $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/); - $c->forward('MyApp::View::TT'); +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 + +=head2 Utility methods -=item $c->setup +=over 4 -Setup. +=item $c->path_to(@path) - $c->setup; +Merges C<@path> with C<$c-Econfig-E{home}> and returns a +L object. + +For example: + + $c->path_to( 'db', 'sqlite.db' ); + +=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 ) } +} + +=item $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 ) = @_; + $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 @@ -305,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 ) { @@ -321,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 ); } @@ -357,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 @@ -379,175 +664,65 @@ sub setup { $class->log->_flush() if $class->log->can('_flush'); } -=item $c->uri_for($path) +=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. +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 sub uri_for { - my ( $c, $path ) = @_; + 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/^\///; - return URI->new_abs( URI->new_abs( $path, "$basepath$match" ), $base ) - ->canonical; -} - -=item $c->error - -=item $c->error($error, ...) - -=item $c->error($arrayref) - -Returns an arrayref containing error messages. - - my @error = @{ $c->error }; - -Add a new error. - - $c->error('Something bad happened'); - -=cut - -sub error { - my $c = shift; - my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_]; - push @{ $c->{error} }, @$error; - return $c->{error}; -} - -=item $c->engine - -Contains the engine instance. -Stringifies to the class. - -=item $c->log - -Contains the logging object. Unless it is already set Catalyst sets this up with a -C object. To use your own log class: - - $c->log( MyLogger->new ); - $c->log->info("now logging with my own logger!"); - -Your log class should implement the methods described in the C -man page. - -=item $c->plugin( $name, $class, @args ) - -Instant plugins for Catalyst. -Classdata accessor/mutator will be created, class loaded and instantiated. - MyApp->plugin( 'prototype', 'HTML::Prototype' ); - - $c->prototype->define_javascript_functions; - -=cut - -sub plugin { - my ( $class, $name, $plugin, @args ) = @_; - $plugin->require; - - if ( my $error = $UNIVERSAL::require::ERROR ) { - Catalyst::Exception->throw( - message => qq/Couldn't load instant plugin "$plugin", "$error"/ ); - } - - eval { $plugin->import }; - $class->mk_classdata($name); - my $obj; - eval { $obj = $plugin->new(@args) }; - - if ($@) { - Catalyst::Exception->throw( message => - qq/Couldn't instantiate instant plugin "$plugin", "$@"/ ); - } - - $class->$name($obj); - $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/) - if $class->debug; -} - -=item $c->request - -=item $c->req - -Returns a C object. - - my $req = $c->req; - -=item $c->response - -=item $c->res - -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}; + # 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; } -=head1 $c->welcome_message +=item $c->welcome_message Returns the Catalyst welcome HTML page. =cut sub welcome_message { - my $c = shift; - my $name = $c->config->{name}; - my $logo = $c->uri_for('/static/images/catalyst_logo.png'); + my $c = shift; + my $name = $c->config->{name}; + my $logo = $c->uri_for('/static/images/catalyst_logo.png'); + my $prefix = Catalyst::Utils::appprefix( ref $c ); + $c->response->content_type('text/html; charset=utf-8'); return <<"EOF"; - + + + + $name on Catalyst $VERSION @@ -608,53 +784,39 @@ sub welcome_message {
-

$name on Catalyst +

$name on Catalyst $VERSION

- + Catalyst Logo

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

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

What to do now?

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

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

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

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

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

What to do next?

-

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

+

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

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

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

+

Need help?

-

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

+

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