X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FEngine.pm;h=b477b4c5921e499f84db979c0a9fe1e482746c08;hb=f8568ac8fb1ae94ac4ed01a5ac1812b93af422be;hp=358a9402c3a616e2422a9c430edfeb8859438758;hpb=748161c4ad23fb071c9906201f98d7aaaad29222;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Engine.pm b/lib/Catalyst/Engine.pm index 358a940..b477b4c 100644 --- a/lib/Catalyst/Engine.pm +++ b/lib/Catalyst/Engine.pm @@ -6,7 +6,10 @@ use UNIVERSAL::require; use Data::Dumper; use HTML::Entities; use HTTP::Headers; +use Memoize; use Time::HiRes qw/gettimeofday tv_interval/; +use Tree::Simple; +use Tree::Simple::Visitor::FindByPath; use Catalyst::Request; use Catalyst::Response; @@ -14,11 +17,13 @@ require Module::Pluggable::Fast; $Data::Dumper::Terse = 1; -__PACKAGE__->mk_classdata($_) for qw/actions components/; -__PACKAGE__->mk_accessors(qw/request response/); +__PACKAGE__->mk_classdata($_) for qw/actions components tree/; +__PACKAGE__->mk_accessors(qw/request response state/); __PACKAGE__->actions( - { plain => {}, regex => {}, compiled => {}, reverse => {} } ); + { plain => {}, private => {}, regex => {}, compiled => [], reverse => {} } +); +__PACKAGE__->tree( Tree::Simple->new( 0, Tree::Simple->ROOT ) ); *comp = \&component; *req = \&request; @@ -27,6 +32,8 @@ __PACKAGE__->actions( our $COUNT = 1; our $START = time; +memoize('_class2prefix'); + =head1 NAME Catalyst::Engine - The Catalyst Engine @@ -37,88 +44,11 @@ See L. =head1 DESCRIPTION -=head2 METHODS - -=head3 action - -Add one or more actions. - - $c->action( '!foo' => sub { $_[1]->res->output('Foo!') } ); - -Get an action's class and coderef. - - my ($class, $code) = @{ $c->action('foo') }; - -Get a list of available actions. - - my @actions = $c->action; +=head1 METHODS -It also automatically calls setup() if needed. +=over 4 -See L for more informations about actions. - -=cut - -sub action { - my $self = shift; - $self->setup unless $self->components; - $self->actions( {} ) unless $self->actions; - my $action; - $_[1] ? ( $action = {@_} ) : ( $action = shift ); - if ( ref $action eq 'HASH' ) { - while ( my ( $name, $code ) = each %$action ) { - my $class = caller(0); - if ( $name =~ /^\/(.*)\/$/ ) { - my $regex = $1; - $self->actions->{compiled}->{qr/$regex/} = $name; - $self->actions->{regex}->{$name} = [ $class, $code ]; - } - elsif ( $name =~ /^\?(.*)$/ ) { - $name = $1; - $name = _prefix( $class, $name ); - $self->actions->{plain}->{$name} = [ $class, $code ]; - } - elsif ( $name =~ /^\!\?(.*)$/ ) { - $name = $1; - $name = _prefix( $class, $name ); - $name = "\!$name"; - $self->actions->{plain}->{$name} = [ $class, $code ]; - } - else { $self->actions->{plain}->{$name} = [ $class, $code ] } - $self->actions->{reverse}->{"$code"} = $name; - $self->log->debug(qq/"$class" defined "$name" as "$code"/) - if $self->debug; - } - } - elsif ($action) { - if ( my $p = $self->actions->{plain}->{$action} ) { return [$p] } - elsif ( my $r = $self->actions->{regex}->{$action} ) { return [$r] } - else { - for my $regex ( keys %{ $self->actions->{compiled} } ) { - my $name = $self->actions->{compiled}->{$regex}; - if ( $action =~ $regex ) { - my @snippets; - for my $i ( 1 .. 9 ) { - no strict 'refs'; - last unless ${$i}; - push @snippets, ${$i}; - } - return [ $self->actions->{regex}->{$name}, - $name, \@snippets ]; - } - } - } - return 0; - } - else { - return ( - keys %{ $self->actions->{plain} }, - keys %{ $self->actions->{regex} } - ); - } -} - -=head3 benchmark +=item $c->benchmark($coderef) Takes a coderef with arguments and returns elapsed time as float. @@ -136,7 +66,9 @@ sub benchmark { return wantarray ? ( $elapsed, @return ) : $elapsed; } -=head3 component / comp +=item $c->comp($name) + +=item $c->component($name) Get a component object by name. @@ -160,26 +92,30 @@ sub component { } } -=head3 errors +=item $c->error -Returns an arrayref containing errors messages. +=item $c->error($error, ...) - my @errors = @{ $c->errors }; +=item $c->error($arrayref) + +Returns an arrayref containing error messages. + + my @error = @{ $c->error }; Add a new error. - $c->errors('Something bad happened'); + $c->error('Something bad happened'); =cut -sub errors { +sub error { my $c = shift; - my $errors = ref $_[0] eq 'ARRAY' ? $_[0] : [@_]; - push @{ $c->{errors} }, @$errors; - return $c->{errors}; + my $error = ref $_[0] eq 'ARRAY' ? $_[0] : [@_]; + push @{ $c->{error} }, @$error; + return $c->{error}; } -=head3 finalize +=item $c->finalize Finalize request. @@ -187,13 +123,20 @@ Finalize request. sub finalize { my $c = shift; - if ( !$c->res->output || $#{ $c->errors } >= 0 ) { + + if ( my $location = $c->res->redirect ) { + $c->log->debug(qq/Redirecting to "$location"/) if $c->debug; + $c->res->headers->header( Location => $location ); + $c->res->status(302); + } + + if ( !$c->res->output || $#{ $c->error } >= 0 ) { $c->res->headers->content_type('text/html'); my $name = $c->config->{name} || 'Catalyst Application'; - my ( $title, $errors, $infos ); + my ( $title, $error, $infos ); if ( $c->debug ) { - $errors = join '
', @{ $c->errors }; - $errors ||= 'No output'; + $error = join '
', @{ $c->error }; + $error ||= 'No output'; $title = $name = "$name on Catalyst $Catalyst::VERSION"; my $req = encode_entities Dumper $c->req; my $res = encode_entities Dumper $c->res; @@ -209,9 +152,9 @@ sub finalize { } else { - $title = $name; - $errors = ''; - $infos = <<""; + $title = $name; + $error = ''; + $infos = <<"";
 (en) Please come back later
 (de) Bitte versuchen sie es spaeter nocheinmal
@@ -245,7 +188,7 @@ sub finalize {
                 margin: 10px;
                 -moz-border-radius: 10px;
             }
-            div.errors {
+            div.error {
                 background-color: #977;
                 border: 1px solid #755;
                 padding: 8px;
@@ -272,7 +215,7 @@ sub finalize {
     
     
         
-
$errors
+
$error
$infos
$name
@@ -280,18 +223,13 @@ sub finalize { } - if ( my $location = $c->res->redirect ) { - $c->log->debug(qq/Redirecting to "$location"/) if $c->debug; - $c->res->headers->header( Location => $location ); - $c->res->status(302); - } $c->res->headers->content_length( length $c->res->output ); my $status = $c->finalize_headers; $c->finalize_output; return $status; } -=head3 finalize_headers +=item $c->finalize_headers Finalize headers. @@ -299,7 +237,7 @@ Finalize headers. sub finalize_headers { } -=head3 finalize_output +=item $c->finalize_output Finalize output. @@ -307,13 +245,13 @@ Finalize output. sub finalize_output { } -=head3 forward +=item $c->forward($command) -Forward processing to a private/public action or a method from a class. +Forward processing to a private action or a method from a class. If you define a class without method it will default to process(). - $c->forward('!foo'); - $c->forward('index.html'); + $c->forward('foo'); + $c->forward('index'); $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/); $c->forward('MyApp::View::TT'); @@ -326,42 +264,21 @@ sub forward { $c->log->debug('Nothing to forward to') if $c->debug; return 0; } - if ( $command =~ /^\?(.*)$/ ) { - $command = $1; - my $caller = caller(0); - $command = _prefix( $caller, $command ); - } - elsif ( $command =~ /^\!\?(.*)$/ ) { - $command = $1; - my $caller = caller(0); - $command = _prefix( $caller, $command ); - $command = "\!$command"; - } - elsif ( $command =~ /^\!(.*)$/ ) { - my $try = $1; - my $caller = caller(0); - my $prefix = _class2prefix($caller); - $try = "!$prefix/$command"; - $command = $try if $c->actions->{plain}->{$try}; - } - my ( $class, $code ); - if ( my $action = $c->action($command) ) { - if ( $action->[2] ) { - $c->log->debug(qq/Couldn't forward "$command" to regex action/) - if $c->debug; - return 0; - } - ( $class, $code ) = @{ $action->[0] }; - } - else { - $class = $command; + my $caller = caller(0); + my $namespace = '/'; + if ( $command =~ /^\/(.*)$/ ) { $command = $1 } + else { $namespace = _class2prefix($caller) || '/' } + my $results = $c->get_action( $command, $namespace ); + unless ( @{$results} ) { + my $class = $command; if ( $class =~ /[^\w\:]/ ) { $c->log->debug(qq/Couldn't forward to "$class"/) if $c->debug; return 0; } my $method = shift || 'process'; - if ( $code = $class->can($method) ) { + if ( my $code = $class->can($method) ) { $c->actions->{reverse}->{"$code"} = "$class->$method"; + $results = [ [ [ $class, $code ] ] ]; } else { $c->log->debug(qq/Couldn't forward to "$class->$method"/) @@ -369,57 +286,107 @@ sub forward { return 0; } } - $class = $c->components->{$class} || $class; - return $c->process( $class, $code ); + for my $result ( @{$results} ) { + $c->state( $c->execute( @{ $result->[0] } ) ); + } + return $c->state; +} + +=item $c->get_action( $action, $namespace ) + +Get an action in a given namespace. + +=cut + +sub get_action { + my ( $c, $action, $namespace ) = @_; + $namespace ||= ''; + if ($namespace) { + $namespace = '' if $namespace eq '/'; + my $parent = $c->tree; + my @results; + my $result = $c->actions->{private}->{ $parent->getUID }->{$action}; + push @results, [$result] if $result; + my $visitor = Tree::Simple::Visitor::FindByPath->new; + for my $part ( split '/', $namespace ) { + $visitor->setSearchPath($part); + $parent->accept($visitor); + my $child = $visitor->getResult; + my $uid = $child->getUID if $child; + my $match = $c->actions->{private}->{$uid}->{$action} if $uid; + if ($match) { + $action eq 'end' ? unshift @results, [$match] : push @results, + [$match]; + } + $parent = $child if $child; + } + return \@results; + } + elsif ( my $p = $c->actions->{plain}->{$action} ) { return [ [$p] ] } + elsif ( my $r = $c->actions->{regex}->{$action} ) { return [ [$r] ] } + else { + for my $i ( 0 .. $#{ $c->actions->{compiled} } ) { + my $name = $c->actions->{compiled}->[$i]->[0]; + my $regex = $c->actions->{compiled}->[$i]->[1]; + if ( $action =~ $regex ) { + my @snippets; + for my $i ( 1 .. 9 ) { + no strict 'refs'; + last unless ${$i}; + push @snippets, ${$i}; + } + return [ [ $c->actions->{regex}->{$name}, $name, \@snippets ] ]; + } + } + } + return []; } -=head3 handler +=item $c->handler( $class, $r ) Handles the request. =cut -sub handler { +sub handler ($$) { my ( $class, $r ) = @_; # Always expect worst case! my $status = -1; eval { my $handler = sub { - my $c = $class->prepare($r); - if ( my $action = $c->action( $c->req->action ) ) { - my ( $begin, $end ); - my $class = ${ $action->[0] }[0]; - my $prefix = _class2prefix($class); - if ($prefix) { - if ( $c->actions->{plain}->{"\!$prefix/begin"} ) { - $begin = "\!$prefix/begin"; - } - elsif ( $c->actions->{plain}->{'!begin'} ) { - $begin = '!begin'; - } - if ( $c->actions->{plain}->{"\!$prefix/end"} ) { - $end = "\!$prefix/end"; - } - elsif ( $c->actions->{plain}->{'!end'} ) { $end = '!end' } + my $c = $class->prepare($r); + my $action = $c->req->action; + my $namespace = ''; + $namespace = ( join( '/', @{ $c->req->args } ) || '/' ) + if $action eq 'default'; + unless ($namespace) { + if ( my $result = $c->get_action($action) ) { + $namespace = _class2prefix( $result->[0]->[0]->[0] ); } - else { - if ( $c->actions->{plain}->{'!begin'} ) { - $begin = '!begin'; - } - if ( $c->actions->{plain}->{'!end'} ) { $end = '!end' } + } + my $default = $action eq 'default' ? $namespace : undef; + my $results = $c->get_action( $action, $default ); + $namespace ||= '/'; + if ( @{$results} ) { + for my $begin ( @{ $c->get_action( 'begin', $namespace ) } ) { + $c->state( $c->execute( @{ $begin->[0] } ) ); + } + for my $result ( @{ $c->get_action( $action, $default ) } ) { + $c->state( $c->execute( @{ $result->[0] } ) ); + last unless $default; + } + for my $end ( @{ $c->get_action( 'end', $namespace ) } ) { + $c->state( $c->execute( @{ $end->[0] } ) ); } - $c->forward($begin) if $begin; - $c->forward( $c->req->action ) if $c->req->action; - $c->forward($end) if $end; } else { - my $action = $c->req->path; - my $error = $action - ? qq/Unknown resource "$action"/ + my $path = $c->req->path; + my $error = $path + ? qq/Unknown resource "$path"/ : "No default action defined"; $c->log->error($error) if $c->debug; - $c->errors($error); + $c->error($error); } return $c->finalize; }; @@ -440,9 +407,10 @@ sub handler { return $status; } -=head3 prepare +=item $c->prepare($r) -Turns the request (Apache, CGI...) into a Catalyst context. +Turns the engine-specific request( Apache, CGI ... ) +into a Catalyst context . =cut @@ -462,7 +430,8 @@ sub prepare { response => Catalyst::Response->new( { cookies => {}, headers => HTTP::Headers->new, status => 200 } ), - stash => {} + stash => {}, + state => 0 }, $class; if ( $c->debug ) { my $secs = time - $START || 1; @@ -476,16 +445,29 @@ sub prepare { $c->prepare_path; $c->prepare_cookies; $c->prepare_headers; - my $method = $c->req->method; - my $path = $c->req->path; - $c->log->debug(qq/"$method" request for "$path"/) if $c->debug; + $c->prepare_connection; + my $method = $c->req->method || ''; + my $path = $c->req->path || ''; + my $hostname = $c->req->hostname || ''; + my $address = $c->req->address || ''; + $c->log->debug(qq/"$method" request for "$path" from $hostname($address)/) + if $c->debug; $c->prepare_action; $c->prepare_parameters; + + if ( $c->debug && keys %{ $c->req->params } ) { + my @params; + for my $key ( keys %{ $c->req->params } ) { + my $value = $c->req->params->{$key} || ''; + push @params, "$key=$value"; + } + $c->log->debug( 'Parameters are "' . join( ' ', @params ) . '"' ); + } $c->prepare_uploads; return $c; } -=head3 prepare_action +=item $c->prepare_action Prepare action. @@ -498,7 +480,7 @@ sub prepare_action { $c->req->args( \my @args ); while (@path) { $path = join '/', @path; - if ( my $result = $c->action($path) ) { + if ( my $result = ${ $c->get_action($path) }[0] ) { # It's a regex if ($#$result) { @@ -522,23 +504,22 @@ sub prepare_action { unshift @args, pop @path; } unless ( $c->req->action ) { - my $prefix = $c->req->args->[0]; - if ( $prefix && $c->actions->{plain}->{"\!$prefix/default"} ) { - $c->req->match(''); - $c->req->action("\!$prefix/default"); - $c->log->debug('Using prefixed default action') if $c->debug; - } - elsif ( $c->actions->{plain}->{'!default'} ) { - $c->req->match(''); - $c->req->action('!default'); - $c->log->debug('Using default action') if $c->debug; - } + $c->req->action('default'); + $c->req->match(''); } $c->log->debug( 'Arguments are "' . join( '/', @args ) . '"' ) if ( $c->debug && @args ); } -=head3 prepare_cookies; +=item $c->prepare_connection + +Prepare connection. + +=cut + +sub prepare_connection { } + +=item $c->prepare_cookies Prepare cookies. @@ -546,7 +527,7 @@ Prepare cookies. sub prepare_cookies { } -=head3 prepare_headers +=item $c->prepare_headers Prepare headers. @@ -554,7 +535,7 @@ Prepare headers. sub prepare_headers { } -=head3 prepare_parameters +=item $c->prepare_parameters Prepare parameters. @@ -562,7 +543,7 @@ Prepare parameters. sub prepare_parameters { } -=head3 prepare_path +=item $c->prepare_path Prepare path and base. @@ -570,7 +551,7 @@ Prepare path and base. sub prepare_path { } -=head3 prepare_request +=item $c->prepare_request Prepare the engine request. @@ -578,7 +559,7 @@ Prepare the engine request. sub prepare_request { } -=head3 prepare_uploads +=item $c->prepare_uploads Prepare uploads. @@ -586,74 +567,163 @@ Prepare uploads. sub prepare_uploads { } -=head3 process +=item $c->execute($class, $coderef) -Process a coderef in given class and catch exceptions. -Errors are available via $c->errors. +Execute a coderef in given class and catch exceptions. +Errors are available via $c->error. =cut -sub process { +sub execute { my ( $c, $class, $code ) = @_; - my $status; + $class = $c->comp($class) || $class; + $c->state(0); eval { if ( $c->debug ) { my $action = $c->actions->{reverse}->{"$code"} || "$code"; - my $elapsed; - ( $elapsed, $status ) = + my ( $elapsed, @state ) = $c->benchmark( $code, $class, $c, @{ $c->req->args } ); $c->log->info( sprintf qq/Processing "$action" took %fs/, $elapsed ) if $c->debug; + $c->state(@state); } - else { $status = &$code( $class, $c, @{ $c->req->args } ) } + else { $c->state( &$code( $class, $c, @{ $c->req->args } ) ) } }; if ( my $error = $@ ) { chomp $error; $error = qq/Caught exception "$error"/; $c->log->error($error); - $c->errors($error) if $c->debug; - return 0; + $c->error($error) if $c->debug; + $c->state(0); } - return $status; + return $c->state; } -=head3 remove_action +=item $c->run -Remove an action. - - $c->remove_action('!foo'); +Starts the engine. =cut -sub remove_action { - my ( $self, $action ) = @_; - if ( delete $self->actions->{regex}->{$action} ) { - while ( my ( $regex, $name ) = each %{ $self->actions->{compiled} } ) { - if ( $name eq $action ) { - delete $self->actions->{compiled}->{$regex}; - last; - } - } - } - else { - delete $self->actions->{plain}->{$action}; - } -} +sub run { } + +=item $c->request -=head3 request (req) +=item $c->req Returns a C object. my $req = $c->req; -=head3 response (res) +=item $c->response + +=item $c->res Returns a C object. my $res = $c->res; -=head3 setup +=item $c->set_action( $action, $code, $namespace, $attrs ) + +Set an action in a given namespace. + +=cut + +sub set_action { + my ( $c, $method, $code, $namespace, $attrs ) = @_; + + my $prefix = _class2prefix($namespace) || ''; + my $action = 0; + my $public = 0; + my $regex = 0; + my $arg = ''; + my $absolute = 0; + + for my $attr ( @{$attrs} ) { + if ( $attr =~ /^Action$/ ) { + $action++; + $arg = $1 if $1; + } + elsif ( $attr =~ /^Path\((.+)\)$/i ) { + $arg = $1; + $public++; + } + elsif ( $attr =~ /^Public$/i ) { + $public++; + } + elsif ( $attr =~ /^Private$/i ) { + $action++; + } + elsif ( $attr =~ /Regex(?:\((.+)\))?$/i ) { + $regex++; + $action++; + $arg = $1 if $1; + } + elsif ( $attr =~ /Absolute(?:\((.+)\))?$/i ) { + $action++; + $absolute++; + $public++; + $arg = $1 if $1; + } + elsif ( $attr =~ /Relative(?:\((.+)\))?$/i ) { + $action++; + $public++; + $arg = $1 if $1; + } + } + + return unless $action; + + my $parent = $c->tree; + my $visitor = Tree::Simple::Visitor::FindByPath->new; + for my $part ( split '/', $prefix ) { + $visitor->setSearchPath($part); + $parent->accept($visitor); + my $child = $visitor->getResult; + unless ($child) { + $child = $parent->addChild( Tree::Simple->new($part) ); + $visitor->setSearchPath($part); + $parent->accept($visitor); + $child = $visitor->getResult; + } + $parent = $child; + } + my $uid = $parent->getUID; + $c->actions->{private}->{$uid}->{$method} = [ $namespace, $code ]; + my $forward = $prefix ? "$prefix/$method" : $method; + $c->log->debug(qq|Private "/$forward" is "$namespace->$method"|) + if $c->debug; + + $arg =~ s/^\w+//; + $arg =~ s/\w+$//; + if ( $arg =~ /^'(.*)'$/ ) { $arg = $1 } + if ( $arg =~ /^"(.*)"$/ ) { $arg = $1 } + + my $reverse = $prefix ? "$method ($prefix)" : $method; + + if ($public) { + my $is_absolute = 0; + $is_absolute = 1 if $absolute; + if ( $arg =~ /^\/(.+)/ ) { + $arg = $1; + $is_absolute = 1; + } + my $name = + $is_absolute ? ( $arg || $method ) : "$prefix/" . ( $arg || $method ); + $c->actions->{plain}->{$name} = [ $namespace, $code ]; + $c->log->debug(qq|Public "/$name" is "/$forward"|) if $c->debug; + } + if ($regex) { + push @{ $c->actions->{compiled} }, [ $arg, qr#$arg# ]; + $c->actions->{regex}->{$arg} = [ $namespace, $code ]; + $c->log->debug(qq|Public "$arg" is "/$forward"|) if $c->debug; + } + + $c->actions->{reverse}->{"$code"} = $reverse; +} + +=item $class->setup Setup. @@ -670,7 +740,29 @@ sub setup { } } -=head3 setup_components +=item $class->setup_actions($component) + +Setup actions for a component. + +=cut + +sub setup_actions { + my ( $self, $comp ) = @_; + $comp = ref $comp || $comp; + for my $action ( @{ $comp->_cache } ) { + my ( $code, $attrs ) = @{$action}; + my $name = ''; + no strict 'refs'; + for my $sym ( values %{ $comp . '::' } ) { + if ( *{$sym}{CODE} && *{$sym}{CODE} == $code ) { + $name = *{$sym}{NAME}; + $self->set_action( $name, $code, $comp, $attrs ); + } + } + } +} + +=item $class->setup_components Setup components. @@ -696,9 +788,11 @@ sub setup_components { $self->log->error( qq/Couldn't initialize "Module::Pluggable::Fast", "$error"/); } + $self->setup_actions($self); $self->components( {} ); - for my $component ( $self->_components($self) ) { - $self->components->{ ref $component } = $component; + for my $comp ( $self->_components($self) ) { + $self->components->{ ref $comp } = $comp; + $self->setup_actions($comp); } $self->log->debug( 'Initialized components "' . join( ' ', keys %{ $self->components } ) @@ -706,7 +800,7 @@ sub setup_components { if $self->debug; } -=head3 stash +=item $c->stash Returns a hashref containing all your data. @@ -734,13 +828,15 @@ sub _prefix { } sub _class2prefix { - my $class = shift; - $class =~ /^.*::[(M)(Model)(V)(View)(C)(Controller)]+::(.*)$/; - my $prefix = lc $1 || ''; - $prefix =~ s/\:\:/_/g; + my $class = shift || ''; + $class =~ /^.*::([MVC]|Model|View|Controller)?::(.*)$/; + my $prefix = lc $2 || ''; + $prefix =~ s/\:\:/\//g; return $prefix; } +=back + =head1 AUTHOR Sebastian Riedel, C