package Catalyst::Plugin::Static::Simple;
use strict;
+use warnings;
use base qw/Class::Accessor::Fast Class::Data::Inheritable/;
-use File::Slurp;
use File::stat;
+use File::Spec::Functions qw/catdir no_upwards splitdir/;
+use IO::File;
use MIME::Types;
use NEXT;
-our $VERSION = '0.09';
+our $VERSION = '0.13';
__PACKAGE__->mk_classdata( qw/_static_mime_types/ );
__PACKAGE__->mk_accessors( qw/_static_file
- _static_apache_mode
_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;
}
if ( $path =~ $re ) {
if ( $c->_locate_static_file ) {
- $c->_debug_msg( "from static directory" )
+ $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 );
+ $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;
}
}
-# 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( " ", @{$c->_debug_msg} ) );
- }
-
- # return DECLINED when under mod_perl
- if ( $c->config->{static}->{use_apache} && $c->_static_apache_mode ) {
- my $engine = $c->_static_apache_mode;
- no strict 'subs';
- if ( $engine == 13 ) {
- return Apache::Constants::DECLINED;
- }
- elsif ( $engine == 19 ) {
- return Apache::Const::DECLINED;
- }
- elsif ( $engine == 20 ) {
- return Apache2::Const::DECLINED;
- }
+ $c->log->debug( 'Static::Simple: ' . join q{ }, @{$c->_debug_msg} );
}
if ( $c->res->status =~ /^(1\d\d|[23]04)$/xms ) {
$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 html xhtml/ ];
+ $c->config->{static}->{ignore_extensions}
+ ||= [ qw/tmpl tt tt2 html xhtml/ ];
$c->config->{static}->{ignore_dirs} ||= [];
- $c->config->{static}->{use_apache} ||= 0;
$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
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;
if ( ref $dir eq 'CODE' ) {
eval { $dpaths = &$dir( $c ) };
if ($@) {
- $c->log->error( "Static::Simple: include_path error: " . $@ );
+ $c->log->error( 'Static::Simple: include_path error: ' . $@ );
} else {
- unshift( @ipaths, @$dpaths );
+ unshift @ipaths, @$dpaths;
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;
my $c = shift;
my $path = $c->req->path;
-
- # abort if running under mod_perl
- # note that we do not use the Apache method if the user has defined
- # custom MIME types or is using include paths, as Apache would not know
- # about them
- APACHE_CHECK:
- {
- if ( $c->config->{static}->{use_apache} ) {
- # check engine version
- last APACHE_CHECK unless $c->engine =~ /Apache::MP(\d{2})/xms;
- my $engine = $1;
-
- # skip if we have user-defined MIME types
- last APACHE_CHECK if keys %{ $c->config->{static}->{mime_types} };
-
- # skip if the file is in a user-defined include path
- last APACHE_CHECK if $c->_static_file
- ne $c->config->{root} . '/' . $path;
-
- # check that Apache will serve the correct file
- if ( $c->apache->document_root ne $c->config->{root} ) {
- $c->log->warn( 'Static::Simple: Your Apache DocumentRoot'
- . ' must be set to ' . $c->config->{root}
- . ' to use the Apache feature. Yours is'
- . ' currently ' . $c->apache->document_root
- );
- }
- else {
- $c->_debug_msg( 'DECLINED to Apache' )
- if ( $c->config->{static}->{debug} );
- $c->_static_apache_mode( $engine );
- return;
- }
- }
- }
-
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;
- }
- }
+ my $stat = stat $full_path;
- my $content = read_file( $full_path );
$c->res->headers->content_type( $type );
$c->res->headers->content_length( $stat->size );
$c->res->headers->last_modified( $stat->mtime );
- $c->res->output( $content );
+
+ if ( Catalyst->VERSION le '5.33' ) {
+ # old File::Slurp method
+ my $content = File::Slurp::read_file( $full_path );
+ $c->res->body( $content );
+ }
+ else {
+ # new method, pass an IO::File object to body
+ my $fh = IO::File->new( $full_path, 'r' );
+ if ( defined $fh ) {
+ binmode $fh;
+ $c->res->body( $fh );
+ }
+ else {
+ Catalyst::Exception->throw(
+ message => "Unable to open $full_path for reading" );
+ }
+ }
+
return 1;
}
if ( $type ) {
$c->_debug_msg( "as $type" )
if ( $c->config->{static}->{debug} );
- return $type;
+ return ( ref $type ) ? $type->type : $type;
}
else {
$c->_debug_msg( "as text/plain (unknown extension $ext)" )
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<MIME::Types> 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<USING WITH APACHE>, below.
+
+=head1 DEFAULT BEHAVIOR
+
+By default, Static::Simple will deliver all files having extensions
+(that is, bits of text following a period (C<.>)), I<except> files
+having the extensions C<tmpl>, C<tt>, C<tt2>, C<html>, and
+C<xhtml>. These files, and all files without extensions, will be
+processed through Catalyst. If L<MIME::Types> doesn't recognize an
+extension, it will be served as C<text/plain>.
+
+To restate: files having the extensions C<tmpl>, C<tt>, C<tt2>, C<html>,
+and C<xhtml> I<will not> 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<will> 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
+C<MyApp-E<gt>config-E<gt>{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
+C<MyApp-E<gt>config-E<gt>{static}-E<gt>{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<qr//>.
MyApp->config->{static}->{dirs} = [
'static',
=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<not> 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<not> automatically
+added to the search path when you specify an C<include_path>. You should
+use C<MyApp-E<gt>config-E<gt>{root}> to add it.
MyApp->config->{static}->{include_path} = [
'/path/to/overlay',
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</images/logo.jpg> will search
for the following files, returning the first one found:
/path/to/overlay/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
+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<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:
=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, 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<tmpl>, C<tt>, C<tt2>, C<html>, and
+C<xhtml> will be ignored by Static::Simple in the interest of security.
+If you wish to define your own extensions to ignore, use the
+C<ignore_extensions> option:
- MyApp->config->{static}->{ignore_extensions} = [ qw/tt 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<ignore_dirs> option. This option contains a list of relative
+directory paths to ignore. If using C<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:
+For example, if combined with the above C<include_path> setting, this
+C<ignore_dirs> value will ignore the following directories if they exist:
/path/to/overlay/tmpl
/path/to/overlay/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.
+To override or add to the default MIME types set by the L<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 Apache integration and performance
+=head2 Compatibility with other plugins
-Optionally, when running under mod_perl, Static::Simple can return DECLINED
-on static files to allow Apache to serve the file. A check is first done to
-make sure that Apache's DocumentRoot matches your Catalyst root, and that you
-are not using any custom MIME types or multiple roots. To enable the Apache
-support, you can set the following option.
+Since version 0.12, Static::Simple plays nice with other plugins. It no
+longer short-circuits the C<prepare_action> stage as it was causing too
+many compatibility issues with other plugins.
- MyApp->config->{static}->{use_apache} = 1;
-
-By default this option is disabled because after several benchmarks it
-appears that just serving the file from Catalyst is the better option. On a
-3K file, Catalyst appears to be around 25% faster, and is 42% faster on a 10K
-file. My benchmarking was done using the following 'siege' command, so other
-benchmarks would be welcome!
+=head2 Debugging information
+
+Enable additional debugging information printed in the Catalyst log. This
+is automatically enabled when running Catalyst in -Debug mode.
- siege -u http://server/static/css/10K.css -b -t 1M -c 1
+ MyApp->config->{static}->{debug} = 1;
+
+=head1 USING WITH APACHE
-For best static performance, you should still serve your static files directly
-from Apache by defining a Location block similar to the following:
+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.
<Location /static>
SetHandler default-handler
</Location>
-=head2 Bypassing other plugins
+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.
-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.
+=head1 INTERNAL EXTENDED METHODS
-Currently, work done by plugins in any other prepare method will execute
-normally.
+Static::Simple extends the following steps in the Catalyst process.
-=head2 Debugging information
+=head2 prepare_action
-Enable additional debugging information printed in the Catalyst log. This
-is automatically enabled when running Catalyst in -Debug mode.
+C<prepare_action> is used to first check if the request path is a static
+file. If so, we skip all other C<prepare_action> steps to improve
+performance.
- MyApp->config->{static}->{debug} = 1;
+=head2 dispatch
+
+C<dispatch> takes the file found during C<prepare_action> and writes it
+to the output.
+
+=head2 finalize
+
+C<finalize> serves up final header information and displays any log
+messages.
+
+=head2 setup
+
+C<setup> initializes all default values.
=head1 SEE ALSO
=head1 CONTRIBUTORS
Marcus Ramberg, <mramberg@cpan.org>
+Jesse Sheidlower, <jester@panix.com>
=head1 THANKS
projects / catagits/Catalyst-Plugin-Static-Simple.git / blobdiff