use Catalyst::Utils;
use namespace::autoclean;
-our $VERSION = '0.30';
+our $VERSION = '0.33';
has _static_file => ( is => 'rw' );
has _static_debug_message => ( is => 'rw', isa => ArrayRef[Str] );
+after setup_finalize => sub {
+ my $c = shift;
+
+ # New: Turn off new 'autoflush' flag in logger (see Catalyst::Log).
+ # This is needed to surpress output of debug log messages for
+ # static requests:
+ $c->log->autoflush(0) if $c->log->can('autoflush');
+};
+
before prepare_action => sub {
my $c = shift;
my $path = $c->req->path;
}
# Does the path have an extension?
- if ( $path =~ /.*\.(\S{1,})$/xms ) {
+ if ( $path =~ /\.([^\/\\]+)$/m ) {
# and does it exist?
$c->_locate_static_file( $path );
}
$c->log->warn("Deprecated 'static' config key used, please use the key 'Plugin::Static::Simple' instead")
if exists $c->config->{static};
+
+ if (exists $c->config->{static}->{include_path}) {
+ $c->config->{'Plugin::Static::Simple'}->{include_path} = [
+ @{$c->config->{'Plugin::Static::Simple'}->{include_path} || []},
+ @{delete $c->config->{static}->{include_path} || []}
+ ];
+ }
+
my $config
= $c->config->{'Plugin::Static::Simple'}
= $c->config->{'static'}
# load up a MIME::Types object, only loading types with
# at least 1 file extension
$config->{mime_types_obj} = MIME::Types->new( only_complete => 1 );
-
- # 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
=head1 ADVANCED CONFIGURATION
Configuration is completely optional and is specified within
-C<MyApp-E<gt>config-E<gt>{static}>. If you use any of these options,
+C<MyApp-E<gt>config-E<gt>{Plugin::Static::Simple}>. If you use any of these options,
this module will probably feel less "simple" to you!
=head2 Enabling request logging
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>{logging}> to 1.
+C<MyApp-E<gt>config-E<gt>{Plugin::Static::Simple}-E<gt>{logging}> to 1.
=head2 Forcing directories into static mode
specified using C<qr//>.
MyApp->config(
- static => {
+ 'Plugin::Static::Simple' => {
dirs => [
'static',
qr/^(images|css)/,
use C<MyApp-E<gt>config-E<gt>{root}> to add it.
MyApp->config(
- static => {
+ 'Plugin::Static::Simple' => {
include_path => [
'/path/to/overlay',
\&incpath_generator,
C<ignore_extensions> option:
MyApp->config(
- static => {
+ 'Plugin::Static::Simple' => {
ignore_extensions => [ qw/html asp php/ ],
},
);
checked against every included path.
MyApp->config(
- static => {
+ 'Plugin::Static::Simple' => {
ignore_dirs => [ qw/tmpl css/ ],
},
);
module, you may enter your own extension to MIME type mapping.
MyApp->config(
- static => {
+ 'Plugin::Static::Simple' => {
mime_types => {
jpg => 'image/jpg',
png => 'image/png',
will keep the file around for that long.
MyApp->config(
- static => {
+ 'Plugin::Static::Simple' => {
expires => 3600, # Caching allowed for one hour.
},
);
is automatically enabled when running Catalyst in -Debug mode.
MyApp->config(
- static => {
+ 'Plugin::Static::Simple' => {
debug => 1,
},
);
C<setup> initializes all default values.
+=head1 DEPRECATIONS
+
+The old style of configuration using the C<'static'> config key was deprecated
+in version 0.30. A warning will be issued if this is used, and the contents of
+the config at this key will be merged with the newer C<'Plugin::Static::Simple'>
+key.
+
+Be aware that if the C<'include_path'> key under C<'static'> exists at all, it
+will be merged with any content of the same key under
+C<'Plugin::Static::Simple'>. Be careful not to set this to a non-arrayref,
+therefore.
+
=head1 SEE ALSO
L<Catalyst>, L<Catalyst::Plugin::Static>,