1 package Catalyst::Plugin::Static::Simple;
5 use base qw/Class::Accessor::Fast Class::Data::Inheritable/;
10 if ( Catalyst->VERSION le '5.33' ) {
14 our $VERSION = '0.10';
16 __PACKAGE__->mk_classdata( qw/_static_mime_types/ );
17 __PACKAGE__->mk_accessors( qw/_static_file
18 _static_debug_message/ );
20 # prepare_action is used to first check if the request path is a static file.
21 # If so, we skip all other prepare_action steps to improve performance.
24 my $path = $c->req->path;
26 # is the URI in a static-defined path?
27 foreach my $dir ( @{ $c->config->{static}->{dirs} } ) {
28 my $re = ( $dir =~ /^qr\//xms ) ? eval $dir : qr/^${dir}/;
30 $c->error( "Error compiling static dir regex '$dir': $@" );
33 if ( $c->_locate_static_file ) {
34 $c->_debug_msg( 'from static directory' )
35 if ( $c->config->{static}->{debug} );
38 $c->_debug_msg( "404: file not found: $path" )
39 if ( $c->config->{static}->{debug} );
40 $c->res->status( 404 );
46 # Does the path have an extension?
47 if ( $path =~ /.*\.(\S{1,})$/xms ) {
49 return if ( $c->_locate_static_file );
52 return $c->NEXT::ACTUAL::prepare_action(@_);
55 # dispatch takes the file found during prepare_action and serves it
59 return if ( $c->res->status != 200 );
61 if ( $c->_static_file ) {
62 if ( $c->config->{static}->{no_logs} && $c->log->can('abort') ) {
65 return $c->_serve_static;
68 return $c->NEXT::ACTUAL::dispatch(@_);
72 # finalize serves up final header information
76 # display all log messages
77 if ( $c->config->{static}->{debug} && scalar @{$c->_debug_msg} ) {
78 $c->log->debug( 'Static::Simple: ' .
79 join q{ }, @{$c->_debug_msg} );
82 if ( $c->res->status =~ /^(1\d\d|[23]04)$/xms ) {
83 $c->res->headers->remove_content_headers;
84 return $c->finalize_headers;
87 return $c->NEXT::ACTUAL::finalize(@_);
95 $c->config->{static}->{dirs} ||= [];
96 $c->config->{static}->{include_path} ||= [ $c->config->{root} ];
97 $c->config->{static}->{mime_types} ||= {};
98 $c->config->{static}->{ignore_extensions} ||= [ qw/tt tt2 html xhtml/ ];
99 $c->config->{static}->{ignore_dirs} ||= [];
100 $c->config->{static}->{debug} ||= $c->debug;
101 if ( ! defined $c->config->{static}->{no_logs} ) {
102 $c->config->{static}->{no_logs} = 1;
105 # load up a MIME::Types object, only loading types with
106 # at least 1 file extension
107 $c->_static_mime_types( MIME::Types->new( only_complete => 1 ) );
109 # preload the type index hash so it's not built on the first request
110 $c->_static_mime_types->create_type_index;
113 # Search through all included directories for the static file
114 # Based on Template Toolkit INCLUDE_PATH code
115 sub _locate_static_file {
118 my $path = $c->req->path;
120 my @ipaths = @{ $c->config->{static}->{include_path} };
122 my $count = 64; # maximum number of directories to search
125 while ( @ipaths && --$count) {
126 my $dir = shift @ipaths || next DIR_CHECK;
128 if ( ref $dir eq 'CODE' ) {
129 eval { $dpaths = &$dir( $c ) };
131 $c->log->error( 'Static::Simple: include_path error: ' . $@ );
133 unshift @ipaths, @$dpaths;
138 if ( -d $dir && -f $dir . '/' . $path ) {
140 # do we need to ignore the file?
141 for my $ignore ( @{ $c->config->{static}->{ignore_dirs} } ) {
143 if ( $path =~ /^$ignore\// ) {
144 $c->_debug_msg( "Ignoring directory `$ignore`" )
145 if ( $c->config->{static}->{debug} );
150 # do we need to ignore based on extension?
152 ( @{ $c->config->{static}->{ignore_extensions} } ) {
153 if ( $path =~ /.*\.${ignore_ext}$/ixms ) {
154 $c->_debug_msg( "Ignoring extension `$ignore_ext`" )
155 if ( $c->config->{static}->{debug} );
160 $c->_debug_msg( 'Serving ' . $dir . '/' . $path )
161 if ( $c->config->{static}->{debug} );
162 return $c->_static_file( $dir . '/' . $path );
173 my $path = $c->req->path;
174 my $type = $c->_ext_to_type;
176 my $full_path = $c->_static_file;
177 my $stat = stat $full_path;
179 # the below code all from C::P::Static
180 if ( $c->req->headers->if_modified_since ) {
181 if ( $c->req->headers->if_modified_since == $stat->mtime ) {
182 $c->res->status( 304 ); # Not Modified
183 $c->res->headers->remove_content_headers;
188 $c->res->headers->content_type( $type );
189 $c->res->headers->content_length( $stat->size );
190 $c->res->headers->last_modified( $stat->mtime );
192 if ( Catalyst->VERSION le '5.33' ) {
193 # old File::Slurp method
194 my $content = File::Slurp::read_file( $full_path );
195 $c->res->output( $content );
199 open my $fh, '<', $full_path
200 or Catalyst::Exception->throw(
201 message => "Unable to open $full_path for reading" );
202 while ( $fh->read( my $buffer, 4096 ) ) {
203 $c->res->write( $buffer );
211 # looks up the correct MIME type for the current file extension
214 my $path = $c->req->path;
216 if ( $path =~ /.*\.(\S{1,})$/xms ) {
218 my $user_types = $c->config->{static}->{mime_types};
219 my $type = $user_types->{$ext}
220 || $c->_static_mime_types->mimeTypeOf( $ext );
222 $c->_debug_msg( "as $type" )
223 if ( $c->config->{static}->{debug} );
227 $c->_debug_msg( "as text/plain (unknown extension $ext)" )
228 if ( $c->config->{static}->{debug} );
233 $c->_debug_msg( 'as text/plain (no extension)' )
234 if ( $c->config->{static}->{debug} );
240 my ( $c, $msg ) = @_;
242 if ( !defined $c->_static_debug_message ) {
243 $c->_static_debug_message( [] );
247 push @{ $c->_static_debug_message }, $msg;
250 return $c->_static_debug_message;
258 Catalyst::Plugin::Static::Simple - Make serving static pages painless.
263 MyApp->setup( qw/Static::Simple/ );
267 The Static::Simple plugin is designed to make serving static content in your
268 application during development quick and easy, without requiring a single
269 line of code from you.
271 It will detect static files used in your application by looking for file
272 extensions in the URI. By default, you can simply load this plugin and it
273 will immediately begin serving your static files with the correct MIME type.
274 The light-weight MIME::Types module is used to map file extensions to
275 IANA-registered MIME types.
277 Note that actions mapped to paths using periods (.) will still operate
280 You may further tweak the operation by adding configuration options, described
283 =head1 ADVANCED CONFIGURATION
285 Configuration is completely optional and is specified within
286 MyApp->config->{static}. If you use any of these options, the module will
287 probably feel less "simple" to you!
289 =head2 Aborting request logging
291 Since Catalyst 5.50, there has been added support for dropping logging for a
292 request. This is enabled by default for static files, as static requests tend
293 to clutter the log output. However, if you want logging of static requests,
294 you can enable it by setting MyApp->config->{static}->{no_logs} to 0.
296 =head2 Forcing directories into static mode
298 Define a list of top-level directories beneath your 'root' directory that
299 should always be served in static mode. Regular expressions may be
300 specified using qr//.
302 MyApp->config->{static}->{dirs} = [
307 =head2 Including additional directories
309 You may specify a list of directories in which to search for your static
310 files. The directories will be searched in order and will return the first
311 file found. Note that your root directory is B<not> automatically added to
312 the search path when you specify an include_path. You should use
313 MyApp->config->{root} to add it.
315 MyApp->config->{static}->{include_path} = [
318 MyApp->config->{root}
321 With the above setting, a request for the file /images/logo.jpg will search
322 for the following files, returning the first one found:
324 /path/to/overlay/images/logo.jpg
325 /dynamic/path/images/logo.jpg
326 /your/app/home/root/images/logo.jpg
328 The include path can contain a subroutine reference to dynamically return a
329 list of available directories. This method will receive the $c object as a
330 parameter and should return a reference to a list of directories. Errors can
331 be reported using die(). This method will be called every time a file is
332 requested that appears to be a static file (i.e. it has an extension).
336 sub incpath_generator {
339 if ( $c->session->{customer_dir} ) {
340 return [ $c->session->{customer_dir} ];
342 die "No customer dir defined.";
346 =head2 Ignoring certain types of files
348 There are some file types you may not wish to serve as static files. Most
349 important in this category are your raw template files. By default, files
350 with the extensions tt, tt2, html, and xhtml will be ignored by Static::Simple
351 in the interest of security. If you wish to define your own extensions to
352 ignore, use the ignore_extensions option:
354 MyApp->config->{static}->{ignore_extensions} = [ qw/tt tt2 html xhtml/ ];
356 =head2 Ignoring entire directories
358 To prevent an entire directory from being served statically, you can use the
359 ignore_dirs option. This option contains a list of relative directory paths
360 to ignore. If using include_path, the path will be checked against every
363 MyApp->config->{static}->{ignore_dirs} = [ qw/tmpl css/ ];
365 For example, if combined with the above include_path setting, this
366 ignore_dirs value will ignore the following directories if they exist:
368 /path/to/overlay/tmpl
372 /your/app/home/root/tmpl
373 /your/app/home/root/css
375 =head2 Custom MIME types
377 To override or add to the default MIME types set by the MIME::Types module,
378 you may enter your own extension to MIME type mapping.
380 MyApp->config->{static}->{mime_types} = {
385 =head2 Bypassing other plugins
387 This plugin checks for a static file in the prepare_action stage. If the
388 request is for a static file, it will bypass all remaining prepare_action
389 steps. This means that by placing Static::Simple before all other plugins,
390 they will not execute when a static file is found. This can be helpful by
391 skipping session cookie checks for example. Or, if you want some plugins
392 to run even on static files, list them before Static::Simple.
394 Currently, work done by plugins in any other prepare method will execute
397 =head2 Debugging information
399 Enable additional debugging information printed in the Catalyst log. This
400 is automatically enabled when running Catalyst in -Debug mode.
402 MyApp->config->{static}->{debug} = 1;
404 =head1 USING WITH APACHE
406 While Static::Simple will work just fine serving files through Catalyst in
407 mod_perl, for increased performance, you may wish to have Apache handle the
408 serving of your static files. To do this, simply use a dedicated directory
409 for your static files and configure an Apache Location block for that
410 directory. This approach is recommended for production installations.
413 SetHandler default-handler
418 L<Catalyst>, L<Catalyst::Plugin::Static>,
419 L<http://www.iana.org/assignments/media-types/>
423 Andy Grundman, <andy@hybridized.org>
427 Marcus Ramberg, <mramberg@cpan.org>
431 The authors of Catalyst::Plugin::Static:
437 For the include_path code from Template Toolkit:
443 This program is free software, you can redistribute it and/or modify it under
444 the same terms as Perl itself.