X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FPlugin%2FStatic%2FSimple.pm;h=4f1a1c959553d8dd87d3e92a024e5829a06a8857;hb=aa5935f174f36400df9ec6a656abbd7f4fdfa844;hp=005bc79da1a5857c3a4fd12ce46302277fd66af9;hpb=9936ddfaf8d03e14c37f00a9b21a8a078cd97648;p=catagits%2FCatalyst-Plugin-Static-Simple.git diff --git a/lib/Catalyst/Plugin/Static/Simple.pm b/lib/Catalyst/Plugin/Static/Simple.pm index 005bc79..4f1a1c9 100644 --- a/lib/Catalyst/Plugin/Static/Simple.pm +++ b/lib/Catalyst/Plugin/Static/Simple.pm @@ -1,19 +1,18 @@ package Catalyst::Plugin::Static::Simple; -use strict; -use warnings; -use base qw/Class::Accessor::Fast Class::Data::Inheritable/; +use Moose::Role; use File::stat; use File::Spec (); use IO::File (); use MIME::Types (); -use MRO::Compat; +use namespace::autoclean; -our $VERSION = '0.25'; +our $VERSION = '0.26'; -__PACKAGE__->mk_accessors( qw/_static_file _static_debug_message/ ); +has _static_file => ( is => 'rw' ); +has _static_debug_message => ( is => 'rw', isa => 'Str' ); -sub prepare_action { +before prepare_action => sub { my $c = shift; my $path = $c->req->path; my $config = $c->config->{static}; @@ -58,11 +57,9 @@ sub prepare_action { # and does it exist? $c->_locate_static_file( $path ); } +}; - return $c->next::method(@_); -} - -sub dispatch { +override dispatch => sub { my $c = shift; return if ( $c->res->status != 200 ); @@ -74,26 +71,22 @@ sub dispatch { return $c->_serve_static; } else { - return $c->next::method(@_); + return super; } -} +}; -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: ' . join q{ }, @{$c->_debug_msg} ); } +}; - return $c->next::method(@_); -} - -sub setup { +before setup_finalize => sub { my $c = shift; - $c->maybe::next::method(@_); - my $config = $c->config->{static} ||= {}; $config->{dirs} ||= []; @@ -111,7 +104,7 @@ sub setup { # preload the type index hash so it's not built on the first request $config->{mime_types_obj}->create_type_index; -} +}; # Search through all included directories for the static file # Based on Template Toolkit INCLUDE_PATH code @@ -301,7 +294,7 @@ C<404> error if your applicaton 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 @@ -351,10 +344,14 @@ 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( + static => { + dirs => [ + 'static', + qr/^(images|css)/, + ], + } + ); =head2 Including additional directories @@ -364,11 +361,15 @@ 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', - \&incpath_generator, - MyApp->config->{root} - ]; + MyApp->config( + static => { + 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: @@ -387,7 +388,7 @@ For example: sub incpath_generator { my $c = shift; - + if ( $c->session->{customer_dir} ) { return [ $c->session->{customer_dir} ]; } else { @@ -404,8 +405,11 @@ 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/html asp php/ ]; + MyApp->config( + static => { + ignore_extensions => [ qw/html asp php/ ], + }, + ); =head2 Ignoring entire directories @@ -414,7 +418,11 @@ 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/ ]; + MyApp->config( + static => { + ignore_dirs => [ qw/tmpl css/ ], + }, + ); For example, if combined with the above C setting, this C value will ignore the following directories if they exist: @@ -431,10 +439,14 @@ C value will ignore the following directories if they exist: 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', - }; + MyApp->config( + static => { + mime_types => { + jpg => 'image/jpg', + png => 'image/png', + }, + }, + ); =head2 Compatibility with other plugins @@ -447,7 +459,11 @@ many compatibility issues with other plugins. 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( + static => { + debug => 1, + }, + ); =head1 USING WITH APACHE