From: Andy Grundman Date: Wed, 19 Oct 2005 21:15:58 +0000 (+0000) Subject: Added Static::Simple to core X-Git-Tag: 5.7099_04~1179 X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=commitdiff_plain;h=a9b789391bb4098d5f13c878d99e09ae71cd4f89 Added Static::Simple to core --- diff --git a/Build.PL b/Build.PL index 13a2357..0c29696 100644 --- a/Build.PL +++ b/Build.PL @@ -17,6 +17,7 @@ my $build = Module::Build->new( 'HTTP::Request' => 0, 'HTTP::Response' => 0, 'LWP::UserAgent' => 0, + 'MIME::Types' => 0, 'Module::Pluggable::Fast' => 0.16, 'NEXT' => 0, 'Path::Class' => 0.09, diff --git a/Changes b/Changes index c0f76a8..fb09dd6 100644 --- a/Changes +++ b/Changes @@ -1,6 +1,9 @@ Tis file documents the revision history for Perl extension Catalyst. 5.50 + - Added a new welcome screen. + - Included Catalyst buttons and icons in helper. + - Added Static::Simple plugin to core. - Added self restarting test server - Added filename to debug output for uploaded files. - Fixed forwarding with embedded arguments. diff --git a/MANIFEST b/MANIFEST index 4082355..4c75f11 100644 --- a/MANIFEST +++ b/MANIFEST @@ -23,6 +23,7 @@ lib/Catalyst/Manual/SuccessStories.pod lib/Catalyst/Manual/Troubleshooting.pod lib/Catalyst/Manual/Tutorial.pod lib/Catalyst/Manual/WritingPlugins.pod +lib/Catalyst/Plugin/Static/Simple.pm lib/Catalyst/Request.pm lib/Catalyst/Request/Upload.pm lib/Catalyst/Response.pm diff --git a/lib/Catalyst/Plugin/Static/Simple.pm b/lib/Catalyst/Plugin/Static/Simple.pm new file mode 100644 index 0000000..d432f5f --- /dev/null +++ b/lib/Catalyst/Plugin/Static/Simple.pm @@ -0,0 +1,445 @@ +package Catalyst::Plugin::Static::Simple; + +use strict; +use warnings; +use base qw/Class::Accessor::Fast Class::Data::Inheritable/; +use File::stat; +use MIME::Types; +use NEXT; + +if ( Catalyst->VERSION le '5.33' ) { + require File::Slurp; +} + +our $VERSION = '0.10'; + +__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; + + # 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': $@" ); + } + if ( $path =~ $re ) { + 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; + } + } + } + + # Does the path have an extension? + if ( $path =~ /.*\.(\S{1,})$/xms ) { + # and does it exist? + return if ( $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; + + return if ( $c->res->status != 200 ); + + if ( $c->_static_file ) { + if ( $c->config->{static}->{no_logs} && $c->log->can('abort') ) { + $c->log->abort( 1 ); + } + return $c->_serve_static; + } + else { + return $c->NEXT::ACTUAL::dispatch(@_); + } +} + +# finalize serves up final header information +sub finalize { + my $c = shift; + + # display all log messages + 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(@_); +} + +sub setup { + my $c = shift; + + $c->NEXT::setup(@_); + + $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_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 + $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; +} + +# 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 $dpaths; + my $count = 64; # maximum number of directories to search + + DIR_CHECK: + while ( @ipaths && --$count) { + 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: ' . $@ ); + } else { + unshift @ipaths, @$dpaths; + next DIR_CHECK; + } + } else { + $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; + } + } + + # do we need to ignore based on extension? + for my $ignore_ext + ( @{ $c->config->{static}->{ignore_extensions} } ) { + if ( $path =~ /.*\.${ignore_ext}$/ixms ) { + $c->_debug_msg( "Ignoring extension `$ignore_ext`" ) + if ( $c->config->{static}->{debug} ); + next DIR_CHECK; + } + } + + $c->_debug_msg( 'Serving ' . $dir . '/' . $path ) + if ( $c->config->{static}->{debug} ); + return $c->_static_file( $dir . '/' . $path ); + } + } + } + + return; +} + +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; + + # 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 ); + + if ( Catalyst->VERSION le '5.33' ) { + # old File::Slurp method + my $content = File::Slurp::read_file( $full_path ); + $c->res->output( $content ); + } + else { + # new write method + open my $fh, '<', $full_path + or Catalyst::Exception->throw( + message => "Unable to open $full_path for reading" ); + while ( $fh->read( my $buffer, 4096 ) ) { + $c->res->write( $buffer ); + } + close $fh; + } + + return 1; +} + +# 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 $ext = $1; + my $user_types = $c->config->{static}->{mime_types}; + my $type = $user_types->{$ext} + || $c->_static_mime_types->mimeTypeOf( $ext ); + if ( $type ) { + $c->_debug_msg( "as $type" ) + if ( $c->config->{static}->{debug} ); + return $type; + } + else { + $c->_debug_msg( "as text/plain (unknown extension $ext)" ) + if ( $c->config->{static}->{debug} ); + return 'text/plain'; + } + } + else { + $c->_debug_msg( 'as text/plain (no extension)' ) + if ( $c->config->{static}->{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; +} + +1; +__END__ + +=head1 NAME + +Catalyst::Plugin::Static::Simple - Make serving static pages painless. + +=head1 SYNOPSIS + + use Catalyst; + MyApp->setup( qw/Static::Simple/ ); + +=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. + +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. + +Note that actions mapped to paths using periods (.) will still operate +properly. + +You may further tweak the operation by adding configuration options, described +below. + +=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! + +=head2 Aborting 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. + +=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//. + + MyApp->config->{static}->{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 +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 +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 +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 { + die "No customer dir defined."; + } + } + +=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: + + MyApp->config->{static}->{ignore_extensions} = [ qw/tt tt2 html xhtml/ ]; + +=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. + + 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: + + /path/to/overlay/tmpl + /path/to/overlay/css + /dynamic/path/tmpl + /dynamic/path/css + /your/app/home/root/tmpl + /your/app/home/root/css + +=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. + + 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. + +Currently, work done by plugins in any other prepare method will execute +normally. + +=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; + +=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. + + + SetHandler default-handler + + +=head1 SEE ALSO + +L, L, +L + +=head1 AUTHOR + +Andy Grundman, + +=head1 CONTRIBUTORS + +Marcus Ramberg, + +=head1 THANKS + +The authors of Catalyst::Plugin::Static: + + Sebastian Riedel + Christian Hansen + Marcus Ramberg + +For the include_path code from Template Toolkit: + + Andy Wardley + +=head1 COPYRIGHT + +This program is free software, you can redistribute it and/or modify it under +the same terms as Perl itself. + +=cut