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=28000569c5a8858e6300f5e0521b21083104ee3b;hp=cab5625295c4eba7a40f73552d8eb8f018d655d7;hb=bc5b1283f309cb32d734f2009bc0832ab76c8868;hpb=12f0babf59bc9f449905b2f6ac15b61d44c8d685 diff --git a/lib/Catalyst/Plugin/Static/Simple.pm b/lib/Catalyst/Plugin/Static/Simple.pm index cab5625..2800056 100644 --- a/lib/Catalyst/Plugin/Static/Simple.pm +++ b/lib/Catalyst/Plugin/Static/Simple.pm @@ -4,22 +4,17 @@ use strict; use warnings; use base qw/Class::Accessor::Fast Class::Data::Inheritable/; use File::stat; +use File::Spec::Functions qw/catdir no_upwards splitdir/; use IO::File; use MIME::Types; use NEXT; -if ( Catalyst->VERSION le '5.33' ) { - require File::Slurp; -} - -our $VERSION = '0.11'; +our $VERSION = '0.13'; __PACKAGE__->mk_classdata( qw/_static_mime_types/ ); __PACKAGE__->mk_accessors( qw/_static_file _static_debug_message/ ); -# 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 { my $c = shift; my $path = $c->req->path; @@ -34,12 +29,10 @@ sub prepare_action { if ( $c->_locate_static_file ) { $c->_debug_msg( 'from static directory' ) if ( $c->config->{static}->{debug} ); - return; } else { $c->_debug_msg( "404: file not found: $path" ) if ( $c->config->{static}->{debug} ); $c->res->status( 404 ); - return; } } } @@ -47,13 +40,12 @@ sub prepare_action { # Does the path have an extension? if ( $path =~ /.*\.(\S{1,})$/xms ) { # and does it exist? - return if ( $c->_locate_static_file ); + $c->_locate_static_file; } return $c->NEXT::ACTUAL::prepare_action(@_); } -# dispatch takes the file found during prepare_action and serves it sub dispatch { my $c = shift; @@ -70,7 +62,6 @@ sub dispatch { } } -# finalize serves up final header information sub finalize { my $c = shift; @@ -92,15 +83,20 @@ sub setup { $c->NEXT::setup(@_); + if ( Catalyst->VERSION le '5.33' ) { + require File::Slurp; + } + $c->config->{static}->{dirs} ||= []; $c->config->{static}->{include_path} ||= [ $c->config->{root} ]; $c->config->{static}->{mime_types} ||= {}; - $c->config->{static}->{ignore_extensions} ||= [ qw/tt tt2 html xhtml/ ]; + $c->config->{static}->{ignore_extensions} + ||= [ qw/tmpl tt tt2 html xhtml/ ]; $c->config->{static}->{ignore_dirs} ||= []; $c->config->{static}->{debug} ||= $c->debug; if ( ! defined $c->config->{static}->{no_logs} ) { $c->config->{static}->{no_logs} = 1; - } + } # load up a MIME::Types object, only loading types with # at least 1 file extension @@ -115,7 +111,7 @@ sub setup { sub _locate_static_file { my $c = shift; - my $path = $c->req->path; + my $path = catdir( no_upwards( splitdir( $c->req->path ) ) ); my @ipaths = @{ $c->config->{static}->{include_path} }; my $dpaths; @@ -134,13 +130,13 @@ sub _locate_static_file { next DIR_CHECK; } } else { - $dir =~ s/\/$//xms; + $dir =~ s/(\/|\\)$//xms; if ( -d $dir && -f $dir . '/' . $path ) { # do we need to ignore the file? for my $ignore ( @{ $c->config->{static}->{ignore_dirs} } ) { - $ignore =~ s{/$}{}; - if ( $path =~ /^$ignore\// ) { + $ignore =~ s{(/|\\)$}{}; + if ( $path =~ /^$ignore(\/|\\)/ ) { $c->_debug_msg( "Ignoring directory `$ignore`" ) if ( $c->config->{static}->{debug} ); next DIR_CHECK; @@ -176,15 +172,6 @@ sub _serve_static { 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; - } - } - $c->res->headers->content_type( $type ); $c->res->headers->content_length( $stat->size ); $c->res->headers->last_modified( $stat->mtime ); @@ -198,7 +185,7 @@ sub _serve_static { # new method, pass an IO::File object to body my $fh = IO::File->new( $full_path, 'r' ); if ( defined $fh ) { - $fh->binmode; + binmode $fh; $c->res->body( $fh ); } else { @@ -263,43 +250,69 @@ Catalyst::Plugin::Static::Simple - Make serving static pages painless. use Catalyst; MyApp->setup( qw/Static::Simple/ ); + # that's it; static content is automatically served by + # Catalyst, though you can configure things or bypass + # Catalyst entirely in a production environment =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. +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 BEHAVIOR + +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{static}>. If you use any of these options, +this module will probably feel less "simple" to you! -=head2 Aborting request logging +=head2 Enabling request logging -Since Catalyst 5.50, there has been added support for dropping logging for a -request. This is enabled by default for static files, as static requests tend -to clutter the log output. However, if you want logging of static requests, -you can enable it 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{static}-E{no_logs}> to 0. =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', @@ -309,10 +322,10 @@ specified using qr//. =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. +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->{static}->{include_path} = [ '/path/to/overlay', @@ -320,7 +333,7 @@ MyApp->config->{root} to add it. MyApp->config->{root} ]; -With the above setting, a request for the file /images/logo.jpg will search +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 @@ -328,9 +341,9 @@ for the following files, returning the first one found: /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: @@ -347,25 +360,27 @@ For example: =head2 Ignoring certain types of files -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 tt, tt2, html, and xhtml will be ignored by Static::Simple -in the interest of security. If you wish to define your own extensions to -ignore, use the ignore_extensions option: +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}->{ignore_extensions} = [ qw/tt tt2 html xhtml/ ]; + MyApp->config->{static}->{ignore_extensions} + = [ qw/html asp php/ ]; =head2 Ignoring entire directories -To prevent an entire directory from being served statically, you can use the -ignore_dirs option. This option contains a list of relative directory paths -to ignore. If using include_path, the path will be checked against every -included path. +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}->{ignore_dirs} = [ qw/tmpl css/ ]; -For example, if combined with the above include_path setting, this -ignore_dirs value will ignore the following directories if they exist: +For example, if combined with the above C setting, this +C value will ignore the following directories if they exist: /path/to/overlay/tmpl /path/to/overlay/css @@ -376,25 +391,19 @@ ignore_dirs value will ignore the following directories if they exist: =head2 Custom MIME types -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. +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->{static}->{mime_types} = { jpg => 'image/jpg', png => 'image/png', }; -=head2 Bypassing other plugins - -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 @@ -415,6 +424,35 @@ 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. + +=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 SEE ALSO L, L, @@ -427,6 +465,7 @@ Andy Grundman, =head1 CONTRIBUTORS Marcus Ramberg, +Jesse Sheidlower, =head1 THANKS