X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Plugin-Static-Simple.git;a=blobdiff_plain;f=lib%2FCatalyst%2FPlugin%2FStatic%2FSimple.pm;h=ef6aee2e34ea6c0a25d56723f85a4605149bc241;hp=352b442aa50128b945fc7aa12360729ac340d234;hb=5c87f754780c60e8b0d05240a5b9e1673ce124d3;hpb=fa43d6b569075865b4f14f1dbabea61645eb55a0 diff --git a/lib/Catalyst/Plugin/Static/Simple.pm b/lib/Catalyst/Plugin/Static/Simple.pm old mode 100644 new mode 100755 index 352b442..ef6aee2 --- a/lib/Catalyst/Plugin/Static/Simple.pm +++ b/lib/Catalyst/Plugin/Static/Simple.pm @@ -1,260 +1,286 @@ package Catalyst::Plugin::Static::Simple; -use strict; -use base qw/Class::Accessor::Fast Class::Data::Inheritable/; -use File::Slurp; +use Moose::Role; use File::stat; -use MIME::Types; -use NEXT; +use File::Spec (); +use IO::File (); +use MIME::Types (); +use Catalyst::Utils; +use namespace::autoclean; -our $VERSION = '0.09'; +our $VERSION = '0.36'; -__PACKAGE__->mk_classdata( qw/_static_mime_types/ ); -__PACKAGE__->mk_accessors( qw/_static_file - _static_apache_mode - _static_debug_message/ ); +has _static_file => ( is => 'rw' ); +has _static_debug_message => ( is => 'rw', isa => 'ArrayRef[Str]' ); -# prepare_action is used to first check if the request path is a static file. -# If so, we skip all other prepare_action steps to improve performance. -sub prepare_action { +after setup_finalize => sub { + my $c = shift; + + # New: Turn off new 'autoflush' flag in logger (see Catalyst::Log). + # This is needed to surpress output of debug log messages for + # static requests: + $c->log->autoflush(0) if $c->log->can('autoflush'); +}; + +before prepare_action => sub { my $c = shift; my $path = $c->req->path; + my $config = $c->config->{'Plugin::Static::Simple'}; + + $path =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg; # is the URI in a static-defined path? - foreach my $dir ( @{ $c->config->{static}->{dirs} } ) { - my $re = ( $dir =~ /^qr\//xms ) ? eval $dir : qr/^${dir}/; - if ($@) { - $c->error( "Error compiling static dir regex '$dir': $@" ); + foreach my $dir ( @{ $config->{dirs} } ) { + my $dir_re = quotemeta $dir; + + # strip trailing slashes, they'll be added in our regex + $dir_re =~ s{/$}{}; + + my $re; + + if ( $dir =~ m{^qr/}xms ) { + $re = eval $dir; + + if ($@) { + $c->error( "Error compiling static dir regex '$dir': $@" ); + } } + else { + $re = qr{^${dir_re}/}; + } + if ( $path =~ $re ) { - if ( $c->_locate_static_file ) { - $c->_debug_msg( "from static directory" ) - if ( $c->config->{static}->{debug} ); - return; + if ( $c->_locate_static_file( $path, 1 ) ) { + $c->_debug_msg( 'from static directory' ) + if $config->{debug}; } else { $c->_debug_msg( "404: file not found: $path" ) - if ( $c->config->{static}->{debug} ); + if $config->{debug}; $c->res->status( 404 ); - return; + $c->res->content_type( 'text/html' ); } } } - + # Does the path have an extension? - if ( $path =~ /.*\.(\S{1,})$/xms ) { + if ( $path =~ /\.([^\/\\]+)$/m ) { # and does it exist? - return if ( $c->_locate_static_file ); + $c->_locate_static_file( $path ); } - - return $c->NEXT::prepare_action(@_); -} +}; -# dispatch takes the file found during prepare_action and serves it -sub dispatch { +around dispatch => sub { + my $orig = shift; my $c = shift; - + return if ( $c->res->status != 200 ); - + if ( $c->_static_file ) { - if ( $c->config->{static}->{no_logs} ) { - if ( $c->log->can('abort') ) { $c->log->abort(1) ; } - } + if ( $c->config->{'Plugin::Static::Simple'}->{no_logs} && $c->log->can('abort') ) { + $c->log->abort( 1 ); + } return $c->_serve_static; } else { - return $c->NEXT::dispatch(@_); + return $c->$orig(@_); } -} +}; -# finalize serves up final header information -sub finalize { +before finalize => sub { my $c = shift; - + # display all log messages - if ( $c->config->{static}->{debug} && scalar @{$c->_debug_msg} ) { - $c->log->debug( "Static::Simple: Serving " . - join( " ", @{$c->_debug_msg} ) ); - } - - # return DECLINED when under mod_perl - if ( $c->config->{static}->{use_apache} && $c->_static_apache_mode ) { - my $engine = $c->_static_apache_mode; - no strict 'subs'; - if ( $engine == 13 ) { - return Apache::Constants::DECLINED; - } - elsif ( $engine == 19 ) { - return Apache::Const::DECLINED; - } - elsif ( $engine == 20 ) { - return Apache2::Const::DECLINED; - } - } - - if ( $c->res->status =~ /^(1\d\d|[23]04)$/xms ) { - $c->res->headers->remove_content_headers; - return $c->finalize_headers; + if ( $c->config->{'Plugin::Static::Simple'}->{debug} && scalar @{$c->_debug_msg} ) { + $c->log->debug( 'Static::Simple: ' . join q{ }, @{$c->_debug_msg} ); } - - return $c->NEXT::finalize(@_); -} +}; -sub setup { +before setup_finalize => sub { my $c = shift; + + $c->log->warn("Deprecated 'static' config key used, please use the key 'Plugin::Static::Simple' instead") + if exists $c->config->{static}; + + if (exists $c->config->{static}->{include_path}) { + $c->config->{'Plugin::Static::Simple'}->{include_path} = [ + @{$c->config->{'Plugin::Static::Simple'}->{include_path} || []}, + @{delete $c->config->{static}->{include_path} || []} + ]; + } - $c->NEXT::setup(@_); - - $c->config->{static}->{dirs} ||= []; - $c->config->{static}->{include_path} ||= [ $c->config->{root} ]; - $c->config->{static}->{mime_types} ||= {}; - $c->config->{static}->{use_apache} ||= 0; - $c->config->{static}->{debug} ||= $c->debug; - $c->config->{static}->{no_logs} ||= 1; - + my $config + = $c->config->{'Plugin::Static::Simple'} + = $c->config->{'static'} + = Catalyst::Utils::merge_hashes( + $c->config->{'Plugin::Static::Simple'} || {}, + $c->config->{static} || {} + ); + + $config->{dirs} ||= []; + $config->{include_path} ||= [ $c->config->{root} ]; + $config->{mime_types} ||= {}; + $config->{ignore_extensions} ||= [ qw/tmpl tt tt2 html xhtml/ ]; + $config->{ignore_dirs} ||= []; + $config->{debug} ||= $c->debug; + $config->{no_logs} = 1 unless defined $config->{no_logs}; + $config->{no_logs} = 0 if $config->{logging}; + # load up a MIME::Types object, only loading types with # at least 1 file extension - $c->_static_mime_types( MIME::Types->new( only_complete => 1 ) ); - - # preload the type index hash so it's not built on the first request - $c->_static_mime_types->create_type_index; -} + $config->{mime_types_obj} = MIME::Types->new( only_complete => 1 ); +}; # Search through all included directories for the static file # Based on Template Toolkit INCLUDE_PATH code sub _locate_static_file { - my $c = shift; - - my $path = $c->req->path; - - my @ipaths = @{ $c->config->{static}->{include_path} }; + my ( $c, $path, $in_static_dir ) = @_; + + $path = File::Spec->catdir( + File::Spec->no_upwards( File::Spec->splitdir( $path ) ) + ); + + my $config = $c->config->{'Plugin::Static::Simple'}; + my @ipaths = @{ $config->{include_path} }; my $dpaths; my $count = 64; # maximum number of directories to search - + + DIR_CHECK: while ( @ipaths && --$count) { - my $dir = shift @ipaths || next; - + my $dir = shift @ipaths || next DIR_CHECK; + if ( ref $dir eq 'CODE' ) { eval { $dpaths = &$dir( $c ) }; if ($@) { - $c->log->error( "Static::Simple: include_path error: " . $@ ); + $c->log->error( 'Static::Simple: include_path error: ' . $@ ); } else { - unshift( @ipaths, @$dpaths ); - next; + unshift @ipaths, @$dpaths; + next DIR_CHECK; } } else { - $dir =~ s/\/$//xms; + $dir =~ s/(\/|\\)$//xms; if ( -d $dir && -f $dir . '/' . $path ) { - $c->_debug_msg( $dir . "/" . $path ) - if ( $c->config->{static}->{debug} ); + + # Don't ignore any files in static dirs defined with 'dirs' + unless ( $in_static_dir ) { + # do we need to ignore the file? + for my $ignore ( @{ $config->{ignore_dirs} } ) { + $ignore =~ s{(/|\\)$}{}; + if ( $path =~ /^$ignore(\/|\\)/ ) { + $c->_debug_msg( "Ignoring directory `$ignore`" ) + if $config->{debug}; + next DIR_CHECK; + } + } + + # do we need to ignore based on extension? + for my $ignore_ext ( @{ $config->{ignore_extensions} } ) { + if ( $path =~ /.*\.${ignore_ext}$/ixms ) { + $c->_debug_msg( "Ignoring extension `$ignore_ext`" ) + if $config->{debug}; + next DIR_CHECK; + } + } + } + + $c->_debug_msg( 'Serving ' . $dir . '/' . $path ) + if $config->{debug}; return $c->_static_file( $dir . '/' . $path ); } } } - + return; } sub _serve_static { my $c = shift; - - my $path = $c->req->path; - - # abort if running under mod_perl - # note that we do not use the Apache method if the user has defined - # custom MIME types or is using include paths, as Apache would not know - # about them - APACHE_CHECK: - { - if ( $c->config->{static}->{use_apache} ) { - # check engine version - last APACHE_CHECK unless $c->engine =~ /Apache::MP(\d{2})/xms; - my $engine = $1; - - # skip if we have user-defined MIME types - last APACHE_CHECK if keys %{ $c->config->{static}->{mime_types} }; - - # skip if the file is in a user-defined include path - last APACHE_CHECK if $c->_static_file - ne $c->config->{root} . '/' . $path; - - # check that Apache will serve the correct file - if ( $c->apache->document_root ne $c->config->{root} ) { - $c->log->warn( "Static::Simple: Your Apache DocumentRoot" - . " must be set to " . $c->config->{root} - . " to use the Apache feature. Yours is" - . " currently " . $c->apache->document_root - ); - } - else { - $c->_debug_msg( "DECLINED to Apache" ) - if ( $c->config->{static}->{debug} ); - $c->_static_apache_mode( $engine ); - return; - } - } - } - - my $type = $c->_ext_to_type; - - my $full_path = $c->_static_file; - my $stat = stat( $full_path ); - - # the below code all from C::P::Static - if ( $c->req->headers->if_modified_since ) { - if ( $c->req->headers->if_modified_since == $stat->mtime ) { - $c->res->status( 304 ); # Not Modified - $c->res->headers->remove_content_headers; - return 1; - } - } + my $config = $c->config->{'Plugin::Static::Simple'}; + + my $full_path = shift || $c->_static_file; + my $type = $c->_ext_to_type( $full_path ); + my $stat = stat $full_path; - my $content = read_file( $full_path ); $c->res->headers->content_type( $type ); $c->res->headers->content_length( $stat->size ); $c->res->headers->last_modified( $stat->mtime ); - $c->res->output( $content ); + # Tell Firefox & friends its OK to cache, even over SSL: + $c->res->headers->header('Cache-control' => 'public'); + # Optionally, set a fixed expiry time: + if ($config->{expires}) { + $c->res->headers->expires(time() + $config->{expires}); + } + + my $fh = IO::File->new( $full_path, 'r' ); + if ( defined $fh ) { + binmode $fh; + $c->res->body( $fh ); + } + else { + Catalyst::Exception->throw( + message => "Unable to open $full_path for reading" ); + } + return 1; } +sub serve_static_file { + my ( $c, $full_path ) = @_; + + my $config = $c->config->{'Plugin::Static::Simple'}; + + if ( -e $full_path ) { + $c->_debug_msg( "Serving static file: $full_path" ) + if $config->{debug}; + } + else { + $c->_debug_msg( "404: file not found: $full_path" ) + if $config->{debug}; + $c->res->status( 404 ); + $c->res->content_type( 'text/html' ); + return; + } + + $c->_serve_static( $full_path ); +} + # looks up the correct MIME type for the current file extension sub _ext_to_type { - my $c = shift; - my $path = $c->req->path; - - if ( $path =~ /.*\.(\S{1,})$/xms ) { + my ( $c, $full_path ) = @_; + + my $config = $c->config->{'Plugin::Static::Simple'}; + + if ( $full_path =~ /.*\.(\S{1,})$/xms ) { my $ext = $1; - my $user_types = $c->config->{static}->{mime_types}; - my $type = $user_types->{$ext} - || $c->_static_mime_types->mimeTypeOf( $ext ); + my $type = $config->{mime_types}{$ext} + || $config->{mime_types_obj}->mimeTypeOf( $ext ); if ( $type ) { - $c->_debug_msg( "as $type" ) - if ( $c->config->{static}->{debug} ); - return $type; + $c->_debug_msg( "as $type" ) if $config->{debug}; + return ( ref $type ) ? $type->type : $type; } else { $c->_debug_msg( "as text/plain (unknown extension $ext)" ) - if ( $c->config->{static}->{debug} ); + if $config->{debug}; return 'text/plain'; } } else { $c->_debug_msg( 'as text/plain (no extension)' ) - if ( $c->config->{static}->{debug} ); + if $config->{debug}; return 'text/plain'; } } sub _debug_msg { my ( $c, $msg ) = @_; - + if ( !defined $c->_static_debug_message ) { $c->_static_debug_message( [] ); } - + if ( $msg ) { push @{ $c->_static_debug_message }, $msg; } - + return $c->_static_debug_message; } @@ -267,83 +293,133 @@ Catalyst::Plugin::Static::Simple - Make serving static pages painless. =head1 SYNOPSIS - use Catalyst; - MyApp->setup( qw/Static::Simple/ ); + package MyApp; + use Catalyst qw/ Static::Simple /; + MyApp->setup; + # that's it; static content is automatically served by Catalyst + # from the application's root directory, though you can configure + # things or bypass Catalyst entirely in a production environment + # + # one caveat: the files must be served from an absolute path + # (i.e. /images/foo.png) =head1 DESCRIPTION -The Static::Simple plugin is designed to make serving static content in your -application during development quick and easy, without requiring a single -line of code from you. +The Static::Simple plugin is designed to make serving static content in +your application during development quick and easy, without requiring a +single line of code from you. -It will detect static files used in your application by looking for file -extensions in the URI. By default, you can simply load this plugin and it -will immediately begin serving your static files with the correct MIME type. -The light-weight MIME::Types module is used to map file extensions to -IANA-registered MIME types. +This plugin detects static files by looking at the file extension in the +URL (such as B<.css> or B<.png> or B<.js>). The plugin uses the +lightweight L module to map file extensions to +IANA-registered MIME types, and will serve your static files with the +correct MIME type directly to the browser, without being processed +through Catalyst. Note that actions mapped to paths using periods (.) will still operate properly. -You may further tweak the operation by adding configuration options, described -below. +If the plugin can not find the file, the request is dispatched to your +application instead. This means you are responsible for generating a +C<404> error if your application can not process the request: + + # handled by static::simple, not dispatched to your application + /images/exists.png + + # static::simple will not find the file and let your application + # handle the request. You are responsible for generating a file + # or returning a 404 error + /images/does_not_exist.png + +Though Static::Simple is designed to work out-of-the-box, you can tweak +the operation by adding various configuration options. In a production +environment, you will probably want to use your webserver to deliver +static content; for an example see L, below. + +=head1 DEFAULT BEHAVIOUR + +By default, Static::Simple will deliver all files having extensions +(that is, bits of text following a period (C<.>)), I files +having the extensions C, C, C, C, and +C. These files, and all files without extensions, will be +processed through Catalyst. If L doesn't recognize an +extension, it will be served as C. + +To restate: files having the extensions C, C, C, C, +and C I be served statically by default, they will be +processed by Catalyst. Thus if you want to use C<.html> files from +within a Catalyst app as static files, you need to change the +configuration of Static::Simple. Note also that files having any other +extension I be served statically, so if you're using any other +extension for template files, you should also change the configuration. + +Logging of static files is turned off by default. =head1 ADVANCED CONFIGURATION -Configuration is completely optional and is specified within -MyApp->config->{static}. If you use any of these options, the module will -probably feel less "simple" to you! +Configuration is completely optional and is specified within +Cconfig-E{Plugin::Static::Simple}>. If you use any of these options, +this module will probably feel less "simple" to you! -=head2 Aborting request logging +=head2 Enabling request logging -With Catalyst 5.50, there has been added support for dropping logging for a -request. We've turned this on by default, as static logging tends to clutter -the Log API, however, if you want logging of static requests, you can easily -turn it on by setting MyApp->config->{static}->{no_logs} to 0. +Since Catalyst 5.50, logging of static requests is turned off by +default; static requests tend to clutter the log output and rarely +reveal anything useful. However, if you want to enable logging of static +requests, you can do so by setting +Cconfig-E{Plugin::Static::Simple}-E{logging}> to 1. =head2 Forcing directories into static mode -Define a list of top-level directories beneath your 'root' directory that -should always be served in static mode. Regular expressions may be -specified using qr//. +Define a list of top-level directories beneath your 'root' directory +that should always be served in static mode. Regular expressions may be +specified using C. - MyApp->config->{static}->{dirs} = [ - 'static', - qr/^(images|css)/, - ]; + MyApp->config( + 'Plugin::Static::Simple' => { + dirs => [ + 'static', + qr/^(images|css)/, + ], + } + ); =head2 Including additional directories You may specify a list of directories in which to search for your static -files. The directories will be searched in order and will return the first -file found. Note that your root directory is B automatically added to -the search path when you specify an include_path. You should use -MyApp->config->{root} to add it. - - MyApp->config->{static}->{include_path} = [ - '/path/to/overlay', - \&incpath_generator, - MyApp->config->{root} - ]; - -With the above setting, a request for the file /images/logo.jpg will search +files. The directories will be searched in order and will return the +first file found. Note that your root directory is B automatically +added to the search path when you specify an C. You should +use Cconfig-E{root}> to add it. + + MyApp->config( + 'Plugin::Static::Simple' => { + include_path => [ + '/path/to/overlay', + \&incpath_generator, + MyApp->config->{root}, + ], + }, + ); + +With the above setting, a request for the file C will search for the following files, returning the first one found: /path/to/overlay/images/logo.jpg /dynamic/path/images/logo.jpg /your/app/home/root/images/logo.jpg - + The include path can contain a subroutine reference to dynamically return a -list of available directories. This method will receive the $c object as a +list of available directories. This method will receive the C<$c> object as a parameter and should return a reference to a list of directories. Errors can -be reported using die(). This method will be called every time a file is +be reported using C. This method will be called every time a file is requested that appears to be a static file (i.e. it has an extension). For example: sub incpath_generator { my $c = shift; - + if ( $c->session->{customer_dir} ) { return [ $c->session->{customer_dir} ]; } else { @@ -351,63 +427,187 @@ For example: } } -=head2 Custom MIME types +=head2 Ignoring certain types of files -To override or add to the default MIME types set by the MIME::Types module, -you may enter your own extension to MIME type mapping. +There are some file types you may not wish to serve as static files. +Most important in this category are your raw template files. By +default, files with the extensions C, C, C, C, and +C will be ignored by Static::Simple in the interest of security. +If you wish to define your own extensions to ignore, use the +C option: - MyApp->config->{static}->{mime_types} = { - jpg => 'image/jpg', - png => 'image/png', - }; + MyApp->config( + 'Plugin::Static::Simple' => { + ignore_extensions => [ qw/html asp php/ ], + }, + ); -=head2 Apache integration and performance +=head2 Ignoring entire directories -Optionally, when running under mod_perl, Static::Simple can return DECLINED -on static files to allow Apache to serve the file. A check is first done to -make sure that Apache's DocumentRoot matches your Catalyst root, and that you -are not using any custom MIME types or multiple roots. To enable the Apache -support, you can set the following option. +To prevent an entire directory from being served statically, you can use +the C option. This option contains a list of relative +directory paths to ignore. If using C, the path will be +checked against every included path. - MyApp->config->{static}->{use_apache} = 1; - -By default this option is disabled because after several benchmarks it -appears that just serving the file from Catalyst is the better option. On a -3K file, Catalyst appears to be around 25% faster, and is 42% faster on a 10K -file. My benchmarking was done using the following 'siege' command, so other -benchmarks would be welcome! + MyApp->config( + 'Plugin::Static::Simple' => { + ignore_dirs => [ qw/tmpl css/ ], + }, + ); - siege -u http://server/static/css/10K.css -b -t 1M -c 1 +For example, if combined with the above C setting, this +C value will ignore the following directories if they exist: -For best static performance, you should still serve your static files directly -from Apache by defining a Location block similar to the following: + /path/to/overlay/tmpl + /path/to/overlay/css + /dynamic/path/tmpl + /dynamic/path/css + /your/app/home/root/tmpl + /your/app/home/root/css - - SetHandler default-handler - +=head2 Custom MIME types + +To override or add to the default MIME types set by the L +module, you may enter your own extension to MIME type mapping. + + MyApp->config( + 'Plugin::Static::Simple' => { + mime_types => { + jpg => 'image/jpg', + png => 'image/png', + }, + }, + ); + +=head2 Controlling caching with Expires header + +The files served by Static::Simple will have a Last-Modified header set, +which allows some browsers to cache them for a while. However if you want +to explicitly set an Expires header, such as to allow proxies to cache your +static content, then you can do so by setting the "expires" config option. + +The value indicates the number of seconds after access time to allow caching. +So a value of zero really means "don't cache at all", and any higher values +will keep the file around for that long. -=head2 Bypassing other plugins + MyApp->config( + 'Plugin::Static::Simple' => { + expires => 3600, # Caching allowed for one hour. + }, + ); -This plugin checks for a static file in the prepare_action stage. If the -request is for a static file, it will bypass all remaining prepare_action -steps. This means that by placing Static::Simple before all other plugins, -they will not execute when a static file is found. This can be helpful by -skipping session cookie checks for example. Or, if you want some plugins -to run even on static files, list them before Static::Simple. +=head2 Compatibility with other plugins -Currently, work done by plugins in any other prepare method will execute -normally. +Since version 0.12, Static::Simple plays nice with other plugins. It no +longer short-circuits the C stage as it was causing too +many compatibility issues with other plugins. =head2 Debugging information Enable additional debugging information printed in the Catalyst log. This is automatically enabled when running Catalyst in -Debug mode. - MyApp->config->{static}->{debug} = 1; + MyApp->config( + 'Plugin::Static::Simple' => { + debug => 1, + }, + ); + +=head1 USING WITH APACHE + +While Static::Simple will work just fine serving files through Catalyst +in mod_perl, for increased performance you may wish to have Apache +handle the serving of your static files directly. To do this, simply use +a dedicated directory for your static files and configure an Apache +Location block for that directory This approach is recommended for +production installations. + + + SetHandler default-handler + + +Using this approach Apache will bypass any handling of these directories +through Catalyst. You can leave Static::Simple as part of your +application, and it will continue to function on a development server, +or using Catalyst's built-in server. + +In practice, your Catalyst application is probably (i.e. should be) +structured in the recommended way (i.e., that generated by bootstrapping +the application with the C script, with a main directory +under which is a C directory for module files and a C +directory for templates and static files). Thus, unless you break up +this structure when deploying your app by moving the static files to a +different location in your filesystem, you will need to use an Alias +directive in Apache to point to the right place. You will then need to +add a Directory block to give permission for Apache to serve these +files. The final configuration will look something like this: + + Alias /myapp/static /filesystem/path/to/MyApp/root/static + + allow from all + + + SetHandler default-handler + + +If you are running in a VirtualHost, you can just set the DocumentRoot +location to the location of your root directory; see +L. + +=head1 PUBLIC METHODS + +=head2 serve_static_file $file_path + +Will serve the file located in $file_path statically. This is useful when +you need to autogenerate them if they don't exist, or they are stored in a model. + + package MyApp::Controller::User; + + sub curr_user_thumb : PathPart("my_thumbnail.png") { + my ( $self, $c ) = @_; + my $file_path = $c->user->picture_thumbnail_path; + $c->serve_static_file($file_path); + } + +=head1 INTERNAL EXTENDED METHODS + +Static::Simple extends the following steps in the Catalyst process. + +=head2 prepare_action + +C is used to first check if the request path is a static +file. If so, we skip all other C steps to improve +performance. + +=head2 dispatch + +C takes the file found during C and writes it +to the output. + +=head2 finalize + +C serves up final header information and displays any log +messages. + +=head2 setup + +C initializes all default values. + +=head1 DEPRECATIONS + +The old style of configuration using the C<'static'> config key was deprecated +in version 0.30. A warning will be issued if this is used, and the contents of +the config at this key will be merged with the newer C<'Plugin::Static::Simple'> +key. + +Be aware that if the C<'include_path'> key under C<'static'> exists at all, it +will be merged with any content of the same key under +C<'Plugin::Static::Simple'>. Be careful not to set this to a non-arrayref, +therefore. =head1 SEE ALSO -L, L, +L, L, L =head1 AUTHOR @@ -418,6 +618,20 @@ Andy Grundman, Marcus Ramberg, +Jesse Sheidlower, + +Guillermo Roditi, + +Florian Ragwitz, + +Tomas Doran, + +Justin Wheeler (dnm) + +Matt S Trout, + +Toby Corkindale, + =head1 THANKS The authors of Catalyst::Plugin::Static: @@ -432,6 +646,12 @@ For the include_path code from Template Toolkit: =head1 COPYRIGHT +Copyright (c) 2005 - 2011 +the Catalyst::Plugin::Static::Simple L and L +as listed above. + +=head1 LICENSE + This program is free software, you can redistribute it and/or modify it under the same terms as Perl itself.