MyApp->config->{static}. If you use any of these options, the module
will probably feel less "simple" to you!
- 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)/,
- ];
-
- Including additional directories (experimental!)
- 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 not
- 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}
- ];
+ 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)/,
+ ];
+
+ Including additional directories (experimental!)
+ 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 not 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:
+ 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
+ /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).
+ 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:
+ For example:
- sub incpath_generator {
- my $c = shift;
+ sub incpath_generator {
+ my $c = shift;
- if ( $c->session->{customer_dir} ) {
- return [ $c->session->{customer_dir} ];
- } else {
- die "No customer dir defined.";
- }
+ if ( $c->session->{customer_dir} ) {
+ return [ $c->session->{customer_dir} ];
+ } else {
+ die "No customer dir defined.";
}
+ }
- 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.
+ 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',
- };
-
- Apache integration and performance
- 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.
-
- MyApp->config->{static}->{use_apache} = 1;
+ MyApp->config->{static}->{mime_types} = {
+ jpg => 'image/jpg',
+ png => 'image/png',
+ };
+
+ Apache integration and performance
+ 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.
+
+ 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!
+ 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!
+
+ siege -u http://server/static/css/10K.css -b -t 1M -c 1
+
+ For best static performance, you should still serve your static files
+ directly from Apache by defining a Location block similar to the
+ following:
- siege -u http://server/static/css/10K.css b -t 1M -c 1
+ <Location /static>
+ SetHandler default-handler
+ </Location>
- For best static performance, you should still serve your static
- files directly from Apache by defining a Location block similar to
- the following:
+ 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.
- <Location /static>
- SetHandler default-handler
- </Location>
+ Currently, work done by plugins in any other prepare method will execute
+ normally.
- Debugging information
- Enable additional debugging information printed in the Catalyst log.
- This is automatically enabled when running Catalyst in -Debug mode.
+ 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;
+ MyApp->config->{static}->{debug} = 1;
SEE ALSO
Catalyst, Catalyst::Plugin::Static,
<http://www.iana.org/assignments/media-types/>
AUTHOR
- Andy Grundman, "andy@hybridized.org"
+ Andy Grundman, <andy@hybridized.org>
THANKS
The authors of Catalyst::Plugin::Static:
use MIME::Types;
use NEXT;
-our $VERSION = '0.06';
+our $VERSION = '0.08';
-__PACKAGE__->mk_classdata( qw/_mime_types/ );
+__PACKAGE__->mk_classdata( qw/_static_mime_types/ );
__PACKAGE__->mk_accessors( qw/_static_file
- _apache_mode
- _debug_message/ );
+ _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 dispatch {
my $c = shift;
- return undef if ( $c->res->status == 404 );
+ return if ( $c->res->status != 200 );
if ( $c->_static_file ) {
return $c->_serve_static;
}
# return DECLINED when under mod_perl
- if ( $c->config->{static}->{use_apache} && $c->_apache_mode ) {
- my $engine = $c->_apache_mode;
+ 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;
# load up a MIME::Types object, only loading types with
# at least 1 file extension
- $c->_mime_types( MIME::Types->new( only_complete => 1 ) );
+ $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->_mime_types->create_type_index;
+ $c->_static_mime_types->create_type_index;
}
# Search through all included directories for the static file
}
}
- return undef;
+ return;
}
sub _serve_static {
else {
$c->_debug_msg( "DECLINED to Apache" )
if ( $c->config->{static}->{debug} );
- $c->_apache_mode( $engine );
- return undef;
+ $c->_static_apache_mode( $engine );
+ return;
}
}
}
# looks up the correct MIME type for the current file extension
sub _ext_to_type {
my $c = shift;
-
my $path = $c->req->path;
- my $type;
if ( $path =~ /.*\.(\S{1,})$/xms ) {
my $ext = $1;
my $user_types = $c->config->{static}->{mime_types};
- if ( $type = $user_types->{$ext}
- || $c->_mime_types->mimeTypeOf( $ext ) ) {
+ 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;
sub _debug_msg {
my ( $c, $msg ) = @_;
- if ( !defined $c->_debug_message ) {
- $c->_debug_message( [] );
+ if ( !defined $c->_static_debug_message ) {
+ $c->_static_debug_message( [] );
}
if ( $msg ) {
- push @{ $c->_debug_message }, $msg;
+ push @{ $c->_static_debug_message }, $msg;
}
- return $c->_debug_message;
+ return $c->_static_debug_message;
}
1;
MyApp->config->{static}. If you use any of these options, the module will
probably feel less "simple" to you!
-=over 4
-
-=item Forcing directories into static mode
+=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
qr/^(images|css)/,
];
-=item Including additional directories (experimental!)
+=head2 Including additional directories (experimental!)
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
}
}
-=item Custom MIME types
+=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.
jpg => 'image/jpg',
png => 'image/png',
};
-
-=item Apache integration and performance
+
+=head2 Apache integration and performance
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
<Location /static>
SetHandler default-handler
</Location>
-
-=item Bypassing other plugins
+
+=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
Currently, work done by plugins in any other prepare method will execute
normally.
-=item Debugging information
+=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;
-=back
-
=head1 SEE ALSO
L<Catalyst>, L<Catalyst::Plugin::Static>,
projects / catagits/Catalyst-Plugin-Static-Simple.git / commitdiff