X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst.pm;h=73214df03c42b6c2cc3d78b3d202f7a25e8d8f09;hb=052a2d89ac696b137f1456a339a77c1607dfe544;hp=81117c91e6d45b6f53d370155b9c3d3c0d90b5da;hpb=33108eafaedec785c7ebdef4eb65a8d935b3af55;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst.pm b/lib/Catalyst.pm index 81117c9..73214df 100644 --- a/lib/Catalyst.pm +++ b/lib/Catalyst.pm @@ -1,7 +1,7 @@ package Catalyst; use strict; -use base 'Catalyst::Base'; +use base 'Catalyst::Component'; use bytes; use UNIVERSAL::require; use Catalyst::Exception; @@ -10,14 +10,28 @@ use Catalyst::Request; use Catalyst::Request::Upload; use Catalyst::Response; use Catalyst::Utils; +use Catalyst::Controller; +use File::stat; use NEXT; -use Text::ASCIITable; -use Path::Class; +use Text::SimpleTable; +use Path::Class::Dir; +use Path::Class::File; use Time::HiRes qw/gettimeofday tv_interval/; use URI; -use Scalar::Util qw/weaken/; +use 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/; -__PACKAGE__->mk_accessors(qw/counter depth request response state/); +__PACKAGE__->mk_accessors( + qw/counter request response state action stack namespace stats/ +); + +attributes->import( __PACKAGE__, \&namespace, 'lvalue' ); + +sub depth { scalar @{ shift->stack || [] }; } # Laziness++ *comp = \&component; @@ -36,12 +50,18 @@ our $DETACH = "catalyst_detach\n"; require Module::Pluggable::Fast; # Helper script generation -our $CATALYST_SCRIPT_GEN = 8; +our $CATALYST_SCRIPT_GEN = 27; __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 setup_finished/; + +__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_01'; +our $VERSION = '5.6900'; sub import { my ( $class, @arguments ) = @_; @@ -54,7 +74,7 @@ sub import { unless ( $caller->isa('Catalyst') ) { no strict 'refs'; - push @{"$caller\::ISA"}, $class; + push @{"$caller\::ISA"}, $class, 'Catalyst::Controller'; } $caller->arguments( [@arguments] ); @@ -67,384 +87,603 @@ Catalyst - The Elegant MVC Web Application Framework =head1 SYNOPSIS - # use the helper to start a new application + # 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 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 lib/MyApp.pm + use Catalyst qw/-Debug/; # include plugins here as well + + ### In libMyApp/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 ) = @_; + 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 ) = @_; - $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 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->snippets->[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/; + +If your plugin starts with a name other than C, you can +fully qualify the name by using a unary plus: - use Catalyst 'My::Module'; + use Catalyst qw/ + My::Module + +Fully::Qualified::Plugin::Name + /; -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: -=over 4 +=head2 -Debug -=item -Debug +Enables debug output. -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/sri]; -=item -Engine +=head2 -Log -Force Catalyst to use a specific engine. -Omit the C prefix of the engine name, i.e.: +Specifies log level. - use Catalyst '-Engine=CGI'; +=head1 METHODS -=item -Home +=head2 INFORMATION ABOUT THE CURRENT REQUEST -Force Catalyst to use a specific home directory. +=head2 $c->action -=item -Log +Returns a L object for the current action, which +stringifies to the action name. See L. -Specify log level. +=head2 $c->namespace -=back +Returns the namespace of the current action, i.e., the uri prefix +corresponding to the controller of the current action. For example: -=head1 METHODS + # in Controller::Foo::Bar + $c->namespace; # returns 'foo/bar'; -=over 4 +=head2 $c->request -=item $c->comp($name) +=head2 $c->req -=item $c->component($name) +Returns the current L object. See +L. -Get a component object by name. +=head2 REQUEST FLOW HANDLING - $c->comp('MyApp::Model::MyModel')->do_stuff; +=head2 $c->forward( $action [, \@arguments ] ) -=cut +=head2 $c->forward( $class, $method, [, \@arguments ] ) -sub component { - my $c = shift; +Forwards processing to another action, by it's 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-Ereq-Eargs>. Upon returning from the function, +C<$c-Ereq-Eargs> will be restored to the previous values. - if (@_) { +Any data Ced from the action forwarded to, will be returned by the +call to forward. - my $name = shift; + my $foodata = $c->forward('/foo'); + $c->forward('index'); + $c->forward(qw/MyApp::Model::DBIC::Foo do_stuff/); + $c->forward('MyApp::View::TT'); - my $appclass = ref $c || $c; +Note that forward implies an C<> around the call (well, actually +C does), thus de-fatalizing all 'dies' within the called action. If +you want C to propagate you need to do something like: - my @names = ( - $name, "${appclass}::${name}", - map { "${appclass}::${_}::${name}" } qw/M V C/ - ); + $c->forward('foo'); + die $c->error if $c->error; - foreach my $try (@names) { +Or make sure to always return true values from your actions and write your code +like this: - if ( exists $c->components->{$try} ) { + $c->forward('foo') || return; - return $c->components->{$try}; - } - } +=cut - foreach my $component ( keys %{ $c->components } ) { +sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) } - return $c->components->{$component} if $component =~ /$name/i; - } +=head2 $c->detach( $action [, \@arguments ] ) - } +=head2 $c->detach( $class, $method, [, \@arguments ] ) - return sort keys %{ $c->components }; -} +The same as C, but doesn't return to the previous action when +processing is finished. -=item config +=cut -Returns a hashref containing your applications settings. +sub detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) } -=item debug +=head2 $c->response -Overload to enable debug messages. +=head2 $c->res -=cut +Returns the current L object. -sub debug { 0 } +=head2 $c->stash -=item $c->detach( $command [, \@arguments ] ) +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. -Like C but doesn't return. + $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 detach { my $c = shift; $c->dispatcher->detach( $c, @_ ) } +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->dispatcher +=head2 $c->error -Contains the dispatcher instance. -Stringifies to class. +=head2 $c->error($error, ...) -=item $c->forward( $command [, \@arguments ] ) +=head2 $c->error($arrayref) -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 an arrayref containing error messages. If Catalyst encounters an +error while processing a request, it stores the error in $c->error. This +method should not be used to store non-fatal error messages. - $c->forward('/foo'); - $c->forward('index'); - $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/); - $c->forward('MyApp::View::TT'); + my @error = @{ $c->error }; + +Add a new error. + + $c->error('Something bad happened'); =cut -sub forward { my $c = shift; $c->dispatcher->forward( $c, @_ ) } +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 -=item $c->setup +Clear errors. You probably don't want to clear the errors unless you are +implementing a custom error screen. -Setup. +This is equivalent to running - $c->setup; + $c->error(0); =cut -sub setup { - my ( $class, @arguments ) = @_; +sub clear_errors { + my $c = shift; + $c->error(0); +} - unless ( $class->isa('Catalyst') ) { - Catalyst::Exception->throw( - message => qq/'$class' does not inherit from Catalyst/ ); + + +# 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; + } } - if ( $class->arguments ) { - @arguments = ( @arguments, @{ $class->arguments } ); + 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} ); } - # Process options - my $flags = {}; + return undef; +} - foreach (@arguments) { +# 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 ) = @_; - if (/^-Debug$/) { - $flags->{log} = - ( $flags->{log} ) ? 'debug,' . $flags->{log} : 'debug'; - } - elsif (/^-(\w+)=?(.*)$/) { - $flags->{ lc $1 } = $2; - } - else { - push @{ $flags->{plugins} }, $_; + 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; + } } } - $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 @names; +} - for my $flag ( sort keys %{$flags} ) { +# Return a component if only one matches. +sub _comp_singular { + my ( $c, @prefixes ) = @_; - if ( my $code = $class->can( 'setup_' . $flag ) ) { - &$code( $class, delete $flags->{$flag} ); - } - else { - $class->log->warn(qq/Unknown flag "$flag"/); - } + my $appclass = ref $c || $c; + + my ( $comp, $rest ) = + map { $c->_comp_search("^${appclass}::${_}::") } @prefixes; + return $comp unless $rest; +} + +# 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 } +} - $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 COMPONENT ACCESSORS - if ( $class->debug ) { +=head2 $c->controller($name) - my @plugins = (); +Gets a L instance by name. - { - no strict 'refs'; - @plugins = grep { /^Catalyst::Plugin/ } @{"$class\::ISA"}; - } + $c->controller('Foo')->do_stuff; - if (@plugins) { - my $t = Text::ASCIITable->new; - $t->setOptions( 'hide_HeadRow', 1 ); - $t->setOptions( 'hide_HeadLine', 1 ); - $t->setCols('Class'); - $t->setColWidth( 'Class', 75, 1 ); - $t->addRow($_) for @plugins; - $class->log->debug( "Loaded plugins:\n" . $t->draw ); - } +If name is omitted, will return the controller for the dispatched action. - my $dispatcher = $class->dispatcher; - my $engine = $class->engine; - my $home = $class->config->{home}; +=cut - $class->log->debug(qq/Loaded dispatcher "$dispatcher"/); - $class->log->debug(qq/Loaded engine "$engine"/); +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 ); +} - $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/); - } +=head2 $c->model($name) - # Call plugins setup - { - no warnings qw/redefine/; - local *setup = sub { }; - $class->setup; - } +Gets a L instance by name. - # Initialize our data structure - $class->components( {} ); + $c->model('Foo')->do_stuff; - $class->setup_components; +If the name is omitted, it will look for a config setting 'default_model', +or check if there is only one model, and forward to it if that's the case. - if ( $class->debug ) { - my $t = Text::ASCIITable->new; - $t->setOptions( 'hide_HeadRow', 1 ); - $t->setOptions( 'hide_HeadLine', 1 ); - $t->setCols('Class'); - $t->setColWidth( 'Class', 75, 1 ); - $t->addRow($_) for sort keys %{ $class->components }; - $class->log->debug( "Loaded components:\n" . $t->draw ) - if ( @{ $t->{tbl_rows} } ); - } +=cut - # Add our self to components, since we are also a component - $class->components->{$class} = $class; +sub model { + my ( $c, $name, @args ) = @_; + return $c->_filter_component( $c->_comp_prefixes( $name, qw/Model M/ ), + @args ) + if $name; + return $c->component( $c->config->{default_model} ) + if $c->config->{default_model}; + return $c->_filter_component( $c->_comp_singular(qw/Model M/), @args ); - $class->setup_actions; +} - if ( $class->debug ) { - my $name = $class->config->{name} || 'Application'; - $class->log->info("$name powered by Catalyst $Catalyst::VERSION"); - } - $class->log->_flush() if $class->log->can('_flush'); +=head2 $c->controllers + +Returns the available names which can be passed to $c->controller + +=cut + +sub controllers { + my ( $c ) = @_; + return $c->_comp_names(qw/Controller C/); } -=item $c->uri_for($path) -Merges path with $c->request->base for absolute uri's and with -$c->request->match for relative uri's, then returns a normalized -L object. +=head2 $c->view($name) + +Gets a L instance by name. + + $c->view('Foo')->do_stuff; + +If the name is omitted, it will look for a config setting 'default_view', +or check if there is only one view, and forward to it if that's the case. =cut -sub uri_for { - my ( $c, $path ) = @_; - my $base = $c->request->base->clone; - my $basepath = $base->path; - $basepath =~ s/\/$//; - $basepath .= '/'; - my $match = $c->request->match; - $match =~ s/^\///; - $match .= '/' if $match; - $match = '' if $path =~ /^\//; - $path =~ s/^\///; - return URI->new_abs( URI->new_abs( $path, "$basepath$match" ), $base ) - ->canonical; +sub view { + my ( $c, $name, @args ) = @_; + return $c->_filter_component( $c->_comp_prefixes( $name, qw/View V/ ), + @args ) + if $name; + return $c->component( $c->config->{default_view} ) + if $c->config->{default_view}; + return $c->_filter_component( $c->_comp_singular(qw/View V/) ); } -=item $c->error +=head2 $c->models -=item $c->error($error, ...) +Returns the available names which can be passed to $c->model -=item $c->error($arrayref) +=cut -Returns an arrayref containing error messages. +sub models { + my ( $c ) = @_; + return $c->_comp_names(qw/Model M/); +} - my @error = @{ $c->error }; -Add a new error. +=head2 $c->views - $c->error('Something bad happened'); +Returns the available names which can be passed to $c->view =cut -sub error { +sub views { + my ( $c ) = @_; + return $c->_comp_names(qw/View V/); +} + +=head2 $c->comp($name) + +=head2 $c->component($name) + +Gets a component object by name. This method is 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 + +sub component { + my $c = shift; + + if (@_) { + + my $name = shift; + + my $appclass = ref $c || $c; + + my @names = ( + $name, "${appclass}::${name}", + map { "${appclass}::${_}::${name}" } + qw/Model M Controller C View V/ + ); + + my $comp = $c->_comp_explicit(@names); + return $c->_filter_component( $comp, @_ ) if defined($comp); + + $comp = $c->_comp_search($name); + return $c->_filter_component( $comp, @_ ) if defined($comp); + } + + return sort keys %{ $c->components }; +} + + + +=head2 CLASS DATA AND HELPER CLASSES + +=head2 $c->config + +Returns or takes a hashref containing the application's configuration. + + __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } ); + +You can also use a L config file like myapp.yml in your +applications home directory. + + --- + db: dsn:SQLite:foo.db + + +=cut + +sub config { my $c = shift; - my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_]; - push @{ $c->{error} }, @$error; - return $c->{error}; + + $c->log->warn("Setting config after setup has been run is not a good idea.") + if ( @_ and $c->setup_finished ); + + $c->NEXT::config(@_); } -=item $c->engine +=head2 $c->log + +Returns the logging object instance. Unless it is already set, Catalyst sets +this up with a L object. To use your own log class, set the +logger with the C<< __PACKAGE__->log >> method prior to calling +C<< __PACKAGE__->setup >>. + + __PACKAGE__->log( MyLogger->new ); + __PACKAGE__->setup; -Contains the engine instance. -Stringifies to the class. +And later: -=item $c->log + $c->log->info( 'Now logging with my own logger!' ); -Contains the logging object. Unless it is already set Catalyst sets this up with a -C object. To use your own log class: +Your log class should implement the methods described in the +L man page. - $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. +=head2 $c->debug -=item $c->plugin( $name, $class, @args ) +Overload to enable debug messages (same as -Debug option). -Instant plugins for Catalyst. -Classdata accessor/mutator will be created, class loaded and instantiated. +=cut + +sub debug { 0 } + +=head2 $c->dispatcher + +Returns the dispatcher instance. Stringifies to class name. See +L. + +=head2 $c->engine + +Returns the engine instance. Stringifies to the class name. See +L. + + +=head2 UTILITY METHODS + +=head2 $c->path_to(@path) + +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 = 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' ); @@ -454,12 +693,7 @@ Classdata accessor/mutator will be created, class loaded and instantiated. 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"/ ); - } + $class->_register_plugin( $plugin, 1 ); eval { $plugin->import }; $class->mk_classdata($name); @@ -471,83 +705,224 @@ sub plugin { qq/Couldn't instantiate instant plugin "$plugin", "$@"/ ); } - $class->$name($obj); - $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/) - if $class->debug; -} + $class->$name($obj); + $class->log->debug(qq/Initialized instant plugin "$plugin" as "$name"/) + if $class->debug; +} + +=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 ) = @_; + + 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} }, $_; + } + } + + $class->setup_home( delete $flags->{home} ); + + $class->setup_log( delete $flags->{log} ); + $class->setup_plugins( delete $flags->{plugins} ); + $class->setup_dispatcher( delete $flags->{dispatcher} ); + $class->setup_engine( delete $flags->{engine} ); + + 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( + <<"EOF") if ( $ENV{CATALYST_SCRIPT_GEN} && ( $ENV{CATALYST_SCRIPT_GEN} < $Catalyst::CATALYST_SCRIPT_GEN ) ); +You are running an old script! + + Please update by running (this will overwrite existing files): + catalyst.pl -force -scripts $class -=item $c->request + or (this will not overwrite existing files): + catalyst.pl -scripts $class +EOF -=item $c->req + if ( $class->debug ) { -Returns a C object. + my @plugins = (); - my $req = $c->req; + { + no strict 'refs'; + @plugins = + map { $_ . ' ' . ( $_->VERSION || '' ) } + grep { /^Catalyst::Plugin/ } @{"$class\::ISA"}; + } -=item $c->response + if (@plugins) { + my $t = Text::SimpleTable->new(76); + $t->row($_) for @plugins; + $class->log->debug( "Loaded plugins:\n" . $t->draw ); + } -=item $c->res + my $dispatcher = $class->dispatcher; + my $engine = $class->engine; + my $home = $class->config->{home}; -Returns a C object. + $class->log->debug(qq/Loaded dispatcher "$dispatcher"/); + $class->log->debug(qq/Loaded engine "$engine"/); - my $res = $c->res; + $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/); + } -=item $c->state + # Call plugins setup + { + no warnings qw/redefine/; + local *setup = sub { }; + $class->setup; + } -Contains the return value of the last executed action. + # Initialize our data structure + $class->components( {} ); -=item $c->stash + $class->setup_components; -Returns a hashref containing all your data. + if ( $class->debug ) { + 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 ( keys %{ $class->components } ); + } - print $c->stash->{foo}; + # Add our self to components, since we are also a component + $class->components->{$class} = $class; -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. + $class->setup_actions; -For example: + 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'); - $c->stash->{foo} ||= 'yada'; - $c->stash( { moose => 'majestic', qux => 0 } ); - $c->stash( bar => 1, gorch => 2 ); + $class->setup_finished(1); +} + +=head2 $c->uri_for( $path, @args?, \%query_values? ) + +Merges path with C<$c-Erequest-Ebase> for absolute uri's and +with C<$c-Enamespace> for relative uri's, 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 uri_for is a hash reference, +it is assumed to contain GET parameter key/value pairs, which will be +appended to the URI in standard fashion. =cut -sub stash { - my $c = shift; - if (@_) { - my $stash = @_ > 1 ? {@_} : $_[0]; - while ( my ( $key, $val ) = each %$stash ) { - $c->{stash}->{$key} = $val; - } - } - return $c->{stash}; +sub uri_for { + my ( $c, $path, @args ) = @_; + my $base = $c->request->base->clone; + my $basepath = $base->path; + $basepath =~ s/\/$//; + $basepath .= '/'; + my $namespace = $c->namespace; + + # massage namespace, empty if absolute path + $namespace =~ s/^\///; + $namespace .= '/' if $namespace; + $path ||= ''; + $namespace = '' if $path =~ /^\//; + $path =~ s/^\///; + + my $params = + ( scalar @args && ref $args[$#args] eq 'HASH' ? pop @args : {} ); + + for my $value ( values %$params ) { + my $isa_ref = ref $value; + if( $isa_ref and $isa_ref ne 'ARRAY' ) { + croak( "Non-array reference ($isa_ref) passed to uri_for()" ); + } + utf8::encode( $_ ) for grep { defined } $isa_ref ? @$value : $value; + }; + + # join args with '/', or a blank string + my $args = ( scalar @args ? '/' . join( '/', @args ) : '' ); + $args =~ s/^\/// unless $path; + my $res = + URI->new_abs( URI->new_abs( "$path$args", "$basepath$namespace" ), $base ) + ->canonical; + $res->query_form(%$params); + $res; } -=head1 $c->welcome_message +=head2 $c->welcome_message Returns the Catalyst welcome HTML page. =cut sub welcome_message { - my $c = shift; - my $name = $c->config->{name}; - my $logo = $c->uri_for('/static/images/catalyst_logo.png'); + my $c = shift; + my $name = $c->config->{name}; + my $logo = $c->uri_for('/static/images/catalyst_logo.png'); + my $prefix = Catalyst::Utils::appprefix( ref $c ); + $c->response->content_type('text/html; charset=utf-8'); return <<"EOF"; - + + + + $name on Catalyst $VERSION @@ -608,53 +984,40 @@ 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::Tutorial
+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.