1 package Catalyst::Plugin::Static::Simple;
8 use MooseX::Types::Moose qw/ArrayRef Str/;
9 use namespace::autoclean;
11 our $VERSION = '0.28';
13 has _static_file => ( is => 'rw' );
14 has _static_debug_message => ( is => 'rw', isa => ArrayRef[Str] );
16 before prepare_action => sub {
18 my $path = $c->req->path;
19 my $config = $c->config->{static};
21 $path =~ s/%([0-9A-Fa-f]{2})/chr(hex($1))/eg;
23 # is the URI in a static-defined path?
24 foreach my $dir ( @{ $config->{dirs} } ) {
25 my $dir_re = quotemeta $dir;
27 # strip trailing slashes, they'll be added in our regex
32 if ( $dir =~ m{^qr/}xms ) {
36 $c->error( "Error compiling static dir regex '$dir': $@" );
40 $re = qr{^${dir_re}/};
44 if ( $c->_locate_static_file( $path, 1 ) ) {
45 $c->_debug_msg( 'from static directory' )
48 $c->_debug_msg( "404: file not found: $path" )
50 $c->res->status( 404 );
51 $c->res->content_type( 'text/html' );
56 # Does the path have an extension?
57 if ( $path =~ /.*\.(\S{1,})$/xms ) {
59 $c->_locate_static_file( $path );
63 around dispatch => sub {
67 return if ( $c->res->status != 200 );
69 if ( $c->_static_file ) {
70 if ( $c->config->{static}{no_logs} && $c->log->can('abort') ) {
73 return $c->_serve_static;
80 before finalize => sub {
83 # display all log messages
84 if ( $c->config->{static}{debug} && scalar @{$c->_debug_msg} ) {
85 $c->log->debug( 'Static::Simple: ' . join q{ }, @{$c->_debug_msg} );
89 before setup_finalize => sub {
92 my $config = $c->config->{static} ||= {};
94 $config->{dirs} ||= [];
95 $config->{include_path} ||= [ $c->config->{root} ];
96 $config->{mime_types} ||= {};
97 $config->{ignore_extensions} ||= [ qw/tmpl tt tt2 html xhtml/ ];
98 $config->{ignore_dirs} ||= [];
99 $config->{debug} ||= $c->debug;
100 $config->{no_logs} = 1 unless defined $config->{no_logs};
101 $config->{no_logs} = 0 if $config->{logging};
103 # load up a MIME::Types object, only loading types with
104 # at least 1 file extension
105 $config->{mime_types_obj} = MIME::Types->new( only_complete => 1 );
107 # preload the type index hash so it's not built on the first request
108 $config->{mime_types_obj}->create_type_index;
111 # Search through all included directories for the static file
112 # Based on Template Toolkit INCLUDE_PATH code
113 sub _locate_static_file {
114 my ( $c, $path, $in_static_dir ) = @_;
116 $path = File::Spec->catdir(
117 File::Spec->no_upwards( File::Spec->splitdir( $path ) )
120 my $config = $c->config->{static};
121 my @ipaths = @{ $config->{include_path} };
123 my $count = 64; # maximum number of directories to search
126 while ( @ipaths && --$count) {
127 my $dir = shift @ipaths || next DIR_CHECK;
129 if ( ref $dir eq 'CODE' ) {
130 eval { $dpaths = &$dir( $c ) };
132 $c->log->error( 'Static::Simple: include_path error: ' . $@ );
134 unshift @ipaths, @$dpaths;
138 $dir =~ s/(\/|\\)$//xms;
139 if ( -d $dir && -f $dir . '/' . $path ) {
141 # Don't ignore any files in static dirs defined with 'dirs'
142 unless ( $in_static_dir ) {
143 # do we need to ignore the file?
144 for my $ignore ( @{ $config->{ignore_dirs} } ) {
145 $ignore =~ s{(/|\\)$}{};
146 if ( $path =~ /^$ignore(\/|\\)/ ) {
147 $c->_debug_msg( "Ignoring directory `$ignore`" )
153 # do we need to ignore based on extension?
154 for my $ignore_ext ( @{ $config->{ignore_extensions} } ) {
155 if ( $path =~ /.*\.${ignore_ext}$/ixms ) {
156 $c->_debug_msg( "Ignoring extension `$ignore_ext`" )
163 $c->_debug_msg( 'Serving ' . $dir . '/' . $path )
165 return $c->_static_file( $dir . '/' . $path );
176 my $full_path = shift || $c->_static_file;
177 my $type = $c->_ext_to_type( $full_path );
178 my $stat = stat $full_path;
180 $c->res->headers->content_type( $type );
181 $c->res->headers->content_length( $stat->size );
182 $c->res->headers->last_modified( $stat->mtime );
184 my $fh = IO::File->new( $full_path, 'r' );
187 $c->res->body( $fh );
190 Catalyst::Exception->throw(
191 message => "Unable to open $full_path for reading" );
197 sub serve_static_file {
198 my ( $c, $full_path ) = @_;
200 my $config = $c->config->{static} ||= {};
202 if ( -e $full_path ) {
203 $c->_debug_msg( "Serving static file: $full_path" )
207 $c->_debug_msg( "404: file not found: $full_path" )
209 $c->res->status( 404 );
210 $c->res->content_type( 'text/html' );
214 $c->_serve_static( $full_path );
217 # looks up the correct MIME type for the current file extension
219 my ( $c, $full_path ) = @_;
221 my $config = $c->config->{static};
223 if ( $full_path =~ /.*\.(\S{1,})$/xms ) {
225 my $type = $config->{mime_types}{$ext}
226 || $config->{mime_types_obj}->mimeTypeOf( $ext );
228 $c->_debug_msg( "as $type" ) if $config->{debug};
229 return ( ref $type ) ? $type->type : $type;
232 $c->_debug_msg( "as text/plain (unknown extension $ext)" )
238 $c->_debug_msg( 'as text/plain (no extension)' )
245 my ( $c, $msg ) = @_;
247 if ( !defined $c->_static_debug_message ) {
248 $c->_static_debug_message( [] );
252 push @{ $c->_static_debug_message }, $msg;
255 return $c->_static_debug_message;
263 Catalyst::Plugin::Static::Simple - Make serving static pages painless.
268 use Catalyst qw/ Static::Simple /;
270 # that's it; static content is automatically served by Catalyst
271 # from the application's root directory, though you can configure
272 # things or bypass Catalyst entirely in a production environment
274 # one caveat: the files must be served from an absolute path
275 # (i.e. /images/foo.png)
279 The Static::Simple plugin is designed to make serving static content in
280 your application during development quick and easy, without requiring a
281 single line of code from you.
283 This plugin detects static files by looking at the file extension in the
284 URL (such as B<.css> or B<.png> or B<.js>). The plugin uses the
285 lightweight L<MIME::Types> module to map file extensions to
286 IANA-registered MIME types, and will serve your static files with the
287 correct MIME type directly to the browser, without being processed
290 Note that actions mapped to paths using periods (.) will still operate
293 If the plugin can not find the file, the request is dispatched to your
294 application instead. This means you are responsible for generating a
295 C<404> error if your applicaton can not process the request:
297 # handled by static::simple, not dispatched to your application
300 # static::simple will not find the file and let your application
301 # handle the request. You are responsible for generating a file
302 # or returning a 404 error
303 /images/does_not_exist.png
305 Though Static::Simple is designed to work out-of-the-box, you can tweak
306 the operation by adding various configuration options. In a production
307 environment, you will probably want to use your webserver to deliver
308 static content; for an example see L<USING WITH APACHE>, below.
310 =head1 DEFAULT BEHAVIOR
312 By default, Static::Simple will deliver all files having extensions
313 (that is, bits of text following a period (C<.>)), I<except> files
314 having the extensions C<tmpl>, C<tt>, C<tt2>, C<html>, and
315 C<xhtml>. These files, and all files without extensions, will be
316 processed through Catalyst. If L<MIME::Types> doesn't recognize an
317 extension, it will be served as C<text/plain>.
319 To restate: files having the extensions C<tmpl>, C<tt>, C<tt2>, C<html>,
320 and C<xhtml> I<will not> be served statically by default, they will be
321 processed by Catalyst. Thus if you want to use C<.html> files from
322 within a Catalyst app as static files, you need to change the
323 configuration of Static::Simple. Note also that files having any other
324 extension I<will> be served statically, so if you're using any other
325 extension for template files, you should also change the configuration.
327 Logging of static files is turned off by default.
329 =head1 ADVANCED CONFIGURATION
331 Configuration is completely optional and is specified within
332 C<MyApp-E<gt>config-E<gt>{static}>. If you use any of these options,
333 this module will probably feel less "simple" to you!
335 =head2 Enabling request logging
337 Since Catalyst 5.50, logging of static requests is turned off by
338 default; static requests tend to clutter the log output and rarely
339 reveal anything useful. However, if you want to enable logging of static
340 requests, you can do so by setting
341 C<MyApp-E<gt>config-E<gt>{static}-E<gt>{logging}> to 1.
343 =head2 Forcing directories into static mode
345 Define a list of top-level directories beneath your 'root' directory
346 that should always be served in static mode. Regular expressions may be
347 specified using C<qr//>.
358 =head2 Including additional directories
360 You may specify a list of directories in which to search for your static
361 files. The directories will be searched in order and will return the
362 first file found. Note that your root directory is B<not> automatically
363 added to the search path when you specify an C<include_path>. You should
364 use C<MyApp-E<gt>config-E<gt>{root}> to add it.
371 MyApp->config->{root},
376 With the above setting, a request for the file C</images/logo.jpg> will search
377 for the following files, returning the first one found:
379 /path/to/overlay/images/logo.jpg
380 /dynamic/path/images/logo.jpg
381 /your/app/home/root/images/logo.jpg
383 The include path can contain a subroutine reference to dynamically return a
384 list of available directories. This method will receive the C<$c> object as a
385 parameter and should return a reference to a list of directories. Errors can
386 be reported using C<die()>. This method will be called every time a file is
387 requested that appears to be a static file (i.e. it has an extension).
391 sub incpath_generator {
394 if ( $c->session->{customer_dir} ) {
395 return [ $c->session->{customer_dir} ];
397 die "No customer dir defined.";
401 =head2 Ignoring certain types of files
403 There are some file types you may not wish to serve as static files.
404 Most important in this category are your raw template files. By
405 default, files with the extensions C<tmpl>, C<tt>, C<tt2>, C<html>, and
406 C<xhtml> will be ignored by Static::Simple in the interest of security.
407 If you wish to define your own extensions to ignore, use the
408 C<ignore_extensions> option:
412 ignore_extensions => [ qw/html asp php/ ],
416 =head2 Ignoring entire directories
418 To prevent an entire directory from being served statically, you can use
419 the C<ignore_dirs> option. This option contains a list of relative
420 directory paths to ignore. If using C<include_path>, the path will be
421 checked against every included path.
425 ignore_dirs => [ qw/tmpl css/ ],
429 For example, if combined with the above C<include_path> setting, this
430 C<ignore_dirs> value will ignore the following directories if they exist:
432 /path/to/overlay/tmpl
436 /your/app/home/root/tmpl
437 /your/app/home/root/css
439 =head2 Custom MIME types
441 To override or add to the default MIME types set by the L<MIME::Types>
442 module, you may enter your own extension to MIME type mapping.
453 =head2 Compatibility with other plugins
455 Since version 0.12, Static::Simple plays nice with other plugins. It no
456 longer short-circuits the C<prepare_action> stage as it was causing too
457 many compatibility issues with other plugins.
459 =head2 Debugging information
461 Enable additional debugging information printed in the Catalyst log. This
462 is automatically enabled when running Catalyst in -Debug mode.
470 =head1 USING WITH APACHE
472 While Static::Simple will work just fine serving files through Catalyst
473 in mod_perl, for increased performance you may wish to have Apache
474 handle the serving of your static files directly. To do this, simply use
475 a dedicated directory for your static files and configure an Apache
476 Location block for that directory This approach is recommended for
477 production installations.
479 <Location /myapp/static>
480 SetHandler default-handler
483 Using this approach Apache will bypass any handling of these directories
484 through Catalyst. You can leave Static::Simple as part of your
485 application, and it will continue to function on a development server,
486 or using Catalyst's built-in server.
488 In practice, your Catalyst application is probably (i.e. should be)
489 structured in the recommended way (i.e., that generated by bootstrapping
490 the application with the C<catalyst.pl> script, with a main directory
491 under which is a C<lib/> directory for module files and a C<root/>
492 directory for templates and static files). Thus, unless you break up
493 this structure when deploying your app by moving the static files to a
494 different location in your filesystem, you will need to use an Alias
495 directive in Apache to point to the right place. You will then need to
496 add a Directory block to give permission for Apache to serve these
497 files. The final configuration will look something like this:
499 Alias /myapp/static /filesystem/path/to/MyApp/root/static
500 <Directory /filesystem/path/to/MyApp/root/static>
503 <Location /myapp/static>
504 SetHandler default-handler
507 If you are running in a VirtualHost, you can just set the DocumentRoot
508 location to the location of your root directory; see
509 L<Catalyst::Engine::Apache2::MP20>.
511 =head1 PUBLIC METHODS
513 =head2 serve_static_file $file_path
515 Will serve the file located in $file_path statically. This is useful when
516 you need to autogenerate them if they don't exist, or they are stored in a model.
518 package MyApp::Controller::User;
520 sub curr_user_thumb : PathPart("my_thumbnail.png") {
521 my ( $self, $c ) = @_;
522 my $file_path = $c->user->picture_thumbnail_path;
523 $c->serve_static_file($file_path);
526 =head1 INTERNAL EXTENDED METHODS
528 Static::Simple extends the following steps in the Catalyst process.
530 =head2 prepare_action
532 C<prepare_action> is used to first check if the request path is a static
533 file. If so, we skip all other C<prepare_action> steps to improve
538 C<dispatch> takes the file found during C<prepare_action> and writes it
543 C<finalize> serves up final header information and displays any log
548 C<setup> initializes all default values.
552 L<Catalyst>, L<Catalyst::Plugin::Static>,
553 L<http://www.iana.org/assignments/media-types/>
557 Andy Grundman, <andy@hybridized.org>
561 Marcus Ramberg, <mramberg@cpan.org>
563 Jesse Sheidlower, <jester@panix.com>
565 Guillermo Roditi, <groditi@cpan.org>
567 Florian Ragwitz, <rafl@debian.org>
569 Tomas Doran, <bobtfish@bobtfish.net>
573 Matt S Trout, <mst@shadowcat.co.uk>
577 The authors of Catalyst::Plugin::Static:
583 For the include_path code from Template Toolkit:
589 Copyright (c) 2005 - 2009
590 the Catalyst::Plugin::Static::Simple L</AUTHOR> and L</CONTRIBUTORS>
595 This program is free software, you can redistribute it and/or modify it under
596 the same terms as Perl itself.