X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FPlugin%2FStatic%2FSimple.pm;h=7dbf37e9fcae1cebda642e39425ce34363351226;hb=0495a29318d1867ec261ad7eb40192fdb12383e7;hp=76e8f28dcad91b8b0bf4d3e5999a740c9dde8f8c;hpb=bdf5afa14743fca1e60cb98add07c3405478ea8c;p=catagits%2FCatalyst-Plugin-Static-Simple.git diff --git a/lib/Catalyst/Plugin/Static/Simple.pm b/lib/Catalyst/Plugin/Static/Simple.pm index 76e8f28..7dbf37e 100644 --- a/lib/Catalyst/Plugin/Static/Simple.pm +++ b/lib/Catalyst/Plugin/Static/Simple.pm @@ -8,7 +8,7 @@ use File::Spec (); use IO::File (); use MIME::Types (); -our $VERSION = '0.15'; +our $VERSION = '0.20'; __PACKAGE__->mk_accessors( qw/_static_file _static_debug_message/ ); @@ -21,18 +21,24 @@ sub prepare_action { # is the URI in a static-defined path? foreach my $dir ( @{ $config->{dirs} } ) { - my $re = ( $dir =~ m{^qr/}xms ) ? eval $dir : qr/^${dir}/; + 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( $path ) ) { + 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 $config->{debug}; $c->res->status( 404 ); + $c->res->content_type( 'text/html' ); } } } @@ -70,11 +76,6 @@ sub finalize { $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(@_); } @@ -96,6 +97,7 @@ sub setup { $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 @@ -108,7 +110,7 @@ sub setup { # Search through all included directories for the static file # Based on Template Toolkit INCLUDE_PATH code sub _locate_static_file { - my ( $c, $path ) = @_; + my ( $c, $path, $in_static_dir ) = @_; $path = File::Spec->catdir( File::Spec->no_upwards( File::Spec->splitdir( $path ) ) @@ -135,22 +137,25 @@ sub _locate_static_file { $dir =~ s/(\/|\\)$//xms; if ( -d $dir && -f $dir . '/' . $path ) { - # 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; + # 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; + # 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; + } } } @@ -167,7 +172,7 @@ sub _locate_static_file { sub _serve_static { my $c = shift; - my $full_path = $c->_static_file; + my $full_path = shift || $c->_static_file; my $type = $c->_ext_to_type( $full_path ); my $stat = stat $full_path; @@ -196,6 +201,26 @@ 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, $full_path ) = @_; @@ -248,9 +273,12 @@ 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 + # 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 + # (ie. /images/foo.png) =head1 DESCRIPTION @@ -304,7 +332,7 @@ 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. +Cconfig-E{static}-E{logging}> to 1. =head2 Forcing directories into static mode @@ -427,6 +455,21 @@ 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 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. @@ -463,8 +506,11 @@ Andy Grundman, =head1 CONTRIBUTORS Marcus Ramberg, + Jesse Sheidlower, +Guillermo Roditi, + =head1 THANKS The authors of Catalyst::Plugin::Static: