X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FPlugin%2FStatic%2FSimple.pm;h=e15a9dea68570276bcc41656e82a71573db126ce;hb=6e89d83c40a25202d31ac9f9d8386ddab1f1c0a4;hp=fedd30901e9c42625db5fc5a85ce738d90d7cd3a;hpb=48791b6652128391faa9882b0aa3df0d04177757;p=catagits%2FCatalyst-Plugin-Static-Simple.git diff --git a/lib/Catalyst/Plugin/Static/Simple.pm b/lib/Catalyst/Plugin/Static/Simple.pm index fedd309..e15a9de 100644 --- a/lib/Catalyst/Plugin/Static/Simple.pm +++ b/lib/Catalyst/Plugin/Static/Simple.pm @@ -4,35 +4,41 @@ 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; +use File::Spec (); +use IO::File (); +use MIME::Types (); -our $VERSION = '0.13'; +our $VERSION = '0.20'; -__PACKAGE__->mk_classdata( qw/_static_mime_types/ ); -__PACKAGE__->mk_accessors( qw/_static_file - _static_debug_message/ ); +__PACKAGE__->mk_accessors( qw/_static_file _static_debug_message/ ); sub prepare_action { my $c = shift; my $path = $c->req->path; + my $config = $c->config->{static}; + + $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}/; + 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 = ( $dir =~ m{^qr/}xms ) ? eval $dir : qr{^${dir_re}/}; if ($@) { $c->error( "Error compiling static dir regex '$dir': $@" ); } if ( $path =~ $re ) { - if ( $c->_locate_static_file ) { + if ( $c->_locate_static_file( $path, 1 ) ) { $c->_debug_msg( 'from static directory' ) - if ( $c->config->{static}->{debug} ); + if $config->{debug}; } else { $c->_debug_msg( "404: file not found: $path" ) - if ( $c->config->{static}->{debug} ); + if $config->{debug}; $c->res->status( 404 ); + $c->res->content_type( 'text/html' ); } } } @@ -40,7 +46,7 @@ sub prepare_action { # Does the path have an extension? if ( $path =~ /.*\.(\S{1,})$/xms ) { # and does it exist? - $c->_locate_static_file; + $c->_locate_static_file( $path ); } return $c->NEXT::ACTUAL::prepare_action(@_); @@ -52,7 +58,7 @@ sub dispatch { return if ( $c->res->status != 200 ); if ( $c->_static_file ) { - if ( $c->config->{static}->{no_logs} && $c->log->can('abort') ) { + if ( $c->config->{static}{no_logs} && $c->log->can('abort') ) { $c->log->abort( 1 ); } return $c->_serve_static; @@ -66,15 +72,10 @@ sub finalize { my $c = shift; # display all log messages - if ( $c->config->{static}->{debug} && scalar @{$c->_debug_msg} ) { + if ( $c->config->{static}{debug} && scalar @{$c->_debug_msg} ) { $c->log->debug( 'Static::Simple: ' . join q{ }, @{$c->_debug_msg} ); } - if ( $c->res->status =~ /^(1\d\d|[23]04)$/xms ) { - $c->res->headers->remove_content_headers; - return $c->finalize_headers; - } - return $c->NEXT::ACTUAL::finalize(@_); } @@ -87,33 +88,36 @@ sub setup { 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/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; - } + my $config = $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 ) ); + $config->{mime_types_obj} = 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}->create_type_index; } # Search through all included directories for the static file # Based on Template Toolkit INCLUDE_PATH code sub _locate_static_file { - my $c = shift; + my ( $c, $path, $in_static_dir ) = @_; - my $path = catdir( no_upwards( splitdir( $c->req->path ) ) ); + $path = File::Spec->catdir( + File::Spec->no_upwards( File::Spec->splitdir( $path ) ) + ); - my @ipaths = @{ $c->config->{static}->{include_path} }; + my $config = $c->config->{static}; + my @ipaths = @{ $config->{include_path} }; my $dpaths; my $count = 64; # maximum number of directories to search @@ -133,28 +137,30 @@ sub _locate_static_file { $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(\/|\\)/ ) { - $c->_debug_msg( "Ignoring directory `$ignore`" ) - if ( $c->config->{static}->{debug} ); - next DIR_CHECK; + # 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 - ( @{ $c->config->{static}->{ignore_extensions} } ) { + # 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 ( $c->config->{static}->{debug} ); + if $config->{debug}; next DIR_CHECK; } + } } $c->_debug_msg( 'Serving ' . $dir . '/' . $path ) - if ( $c->config->{static}->{debug} ); + if $config->{debug}; return $c->_static_file( $dir . '/' . $path ); } } @@ -165,12 +171,10 @@ sub _locate_static_file { sub _serve_static { my $c = shift; - - my $path = $c->req->path; - my $type = $c->_ext_to_type; - - my $full_path = $c->_static_file; - my $stat = stat $full_path; + + my $full_path = shift || $c->_static_file; + my $type = $c->_ext_to_type( $full_path ); + my $stat = stat $full_path; $c->res->headers->content_type( $type ); $c->res->headers->content_length( $stat->size ); @@ -197,30 +201,49 @@ sub _serve_static { return 1; } +sub serve_static_file { + my ( $c, $full_path ) = @_; + + my $config = $c->config->{static} ||= {}; + + 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; + my ( $c, $full_path ) = @_; - if ( $path =~ /.*\.(\S{1,})$/xms ) { + my $config = $c->config->{static}; + + 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} ); + $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'; } } @@ -250,43 +273,72 @@ 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 + # 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. +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{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', @@ -296,10 +348,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', @@ -307,7 +359,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 @@ -315,9 +367,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: @@ -334,26 +386,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 tmpl, 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/tmpl tt tt2 html xhtml/ ]; + = [ 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 @@ -364,8 +417,8 @@ 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', @@ -375,8 +428,8 @@ you may enter your own extension to MIME type mapping. =head2 Compatibility with other plugins Since version 0.12, Static::Simple plays nice with other plugins. It no -longer short-circuits the prepare_action stage as it was causing too many -compatibility issues with other plugins. +longer short-circuits the C stage as it was causing too +many compatibility issues with other plugins. =head2 Debugging information @@ -387,37 +440,79 @@ is automatically enabled when running Catalyst in -Debug mode. =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. 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. +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 +=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 -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. +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 -dispatch takes the file found during prepare_action and writes it to the -output. +C takes the file found during C and writes it +to the output. =head2 finalize -finalize serves up final header information and displays any log messages. +C serves up final header information and displays any log +messages. =head2 setup -setup initializes all default values. +C initializes all default values. =head1 SEE ALSO @@ -432,6 +527,10 @@ Andy Grundman, Marcus Ramberg, +Jesse Sheidlower, + +Guillermo Roditi, + =head1 THANKS The authors of Catalyst::Plugin::Static: