Commit | Line | Data |
d6d29b9b |
1 | package Catalyst::Plugin::Static::Simple; |
d925e93e |
2 | use Moose::Role; |
aa5935f1 |
3 | use namespace::autoclean; |
d6d29b9b |
4 | |
9c5fb712 |
5 | use Plack::App::File; |
6 | use Catalyst::Utils; |
b1d96e3e |
7 | |
9c5fb712 |
8 | use Catalyst::Plugin::Static::Simple::Middleware; |
b108737b |
9 | |
9c5fb712 |
10 | our $VERSION = '0.32'; |
d6d29b9b |
11 | |
aa5935f1 |
12 | before setup_finalize => sub { |
9c5fb712 |
13 | my $app = shift; |
b108737b |
14 | |
ee1e7faf |
15 | my $config |
9c5fb712 |
16 | = $app->config->{'Plugin::Static::Simple'} |
17 | = $app->config->{'static'} |
ee1e7faf |
18 | = Catalyst::Utils::merge_hashes( |
9c5fb712 |
19 | $app->config->{'Plugin::Static::Simple'} || {}, |
20 | $app->config->{static} || {} |
ee1e7faf |
21 | ); |
b108737b |
22 | |
bdf5afa1 |
23 | $config->{dirs} ||= []; |
9c5fb712 |
24 | $config->{include_path} ||= [ $app->config->{root} ]; |
bdf5afa1 |
25 | $config->{ignore_extensions} ||= [ qw/tmpl tt tt2 html xhtml/ ]; |
26 | $config->{ignore_dirs} ||= []; |
9c5fb712 |
27 | $config->{debug} ||= $app->debug; |
b108737b |
28 | |
9c5fb712 |
29 | my $static_middleware = Catalyst::Plugin::Static::Simple::Middleware->new({ |
30 | config => $config, |
31 | cat_app => ref($app) || $app, |
32 | content_type => $app->_build_content_type_callback, |
33 | }); |
b108737b |
34 | |
9c5fb712 |
35 | $app->setup_middleware( $static_middleware ); |
36 | }; |
b108737b |
37 | |
9c5fb712 |
38 | sub _build_content_type_callback { |
39 | my ( $c ) = @_; |
d6d29b9b |
40 | |
ee1e7faf |
41 | my $config = $c->config->{'Plugin::Static::Simple'}; |
9c5fb712 |
42 | return sub { |
43 | my $full_path = shift; |
44 | my $mime_type; |
b108737b |
45 | |
9c5fb712 |
46 | if ( $config->{mime_types} && $full_path =~ /.*\.(\S{1,})$/xms ) { |
47 | $mime_type = $config->{mime_types}->{ $1 }; |
48 | } |
2cb3d585 |
49 | |
9c5fb712 |
50 | return $mime_type || Plack::MIME->mime_type($full_path) || 'text/plain'; |
2cb3d585 |
51 | } |
b1d96e3e |
52 | } |
53 | |
ab02ca0d |
54 | sub serve_static_file { |
55 | my ( $c, $full_path ) = @_; |
56 | |
9c5fb712 |
57 | my $res; |
b108737b |
58 | |
9c5fb712 |
59 | if(! -f $full_path ) { |
60 | $res = Catalyst::Plugin::Static::Simple::Middleware->return_404; |
61 | } else { |
62 | my $file_app = Plack::App::File->new( { |
63 | file => $full_path, |
64 | content_type => $c->_build_content_type_callback |
65 | } ); |
66 | $res = $file_app->call($c->req->env); |
b1d96e3e |
67 | } |
b108737b |
68 | |
9c5fb712 |
69 | $c->res->from_psgi_response($res); |
d6d29b9b |
70 | } |
b1d96e3e |
71 | |
72 | 1; |
9c5fb712 |
73 | |
b1d96e3e |
74 | __END__ |
75 | |
76 | =head1 NAME |
77 | |
78 | Catalyst::Plugin::Static::Simple - Make serving static pages painless. |
79 | |
80 | =head1 SYNOPSIS |
81 | |
b6fdf01d |
82 | package MyApp; |
83 | use Catalyst qw/ Static::Simple /; |
84 | MyApp->setup; |
b648683e |
85 | # that's it; static content is automatically served by Catalyst |
86 | # from the application's root directory, though you can configure |
87 | # things or bypass Catalyst entirely in a production environment |
88 | # |
89 | # one caveat: the files must be served from an absolute path |
6e89d83c |
90 | # (i.e. /images/foo.png) |
b1d96e3e |
91 | |
92 | =head1 DESCRIPTION |
93 | |
bc5b1283 |
94 | The Static::Simple plugin is designed to make serving static content in |
95 | your application during development quick and easy, without requiring a |
96 | single line of code from you. |
b1d96e3e |
97 | |
bc5b1283 |
98 | This plugin detects static files by looking at the file extension in the |
99 | URL (such as B<.css> or B<.png> or B<.js>). The plugin uses the |
100 | lightweight L<MIME::Types> module to map file extensions to |
101 | IANA-registered MIME types, and will serve your static files with the |
102 | correct MIME type directly to the browser, without being processed |
103 | through Catalyst. |
b1d96e3e |
104 | |
105 | Note that actions mapped to paths using periods (.) will still operate |
106 | properly. |
107 | |
200e206c |
108 | If the plugin can not find the file, the request is dispatched to your |
b108737b |
109 | application instead. This means you are responsible for generating a |
200e206c |
110 | C<404> error if your applicaton can not process the request: |
111 | |
112 | # handled by static::simple, not dispatched to your application |
113 | /images/exists.png |
aa5935f1 |
114 | |
200e206c |
115 | # static::simple will not find the file and let your application |
116 | # handle the request. You are responsible for generating a file |
117 | # or returning a 404 error |
118 | /images/does_not_exist.png |
119 | |
bc5b1283 |
120 | Though Static::Simple is designed to work out-of-the-box, you can tweak |
121 | the operation by adding various configuration options. In a production |
122 | environment, you will probably want to use your webserver to deliver |
123 | static content; for an example see L<USING WITH APACHE>, below. |
124 | |
41cac5ef |
125 | =head1 DEFAULT BEHAVIOUR |
bc5b1283 |
126 | |
127 | By default, Static::Simple will deliver all files having extensions |
128 | (that is, bits of text following a period (C<.>)), I<except> files |
129 | having the extensions C<tmpl>, C<tt>, C<tt2>, C<html>, and |
130 | C<xhtml>. These files, and all files without extensions, will be |
131 | processed through Catalyst. If L<MIME::Types> doesn't recognize an |
132 | extension, it will be served as C<text/plain>. |
133 | |
134 | To restate: files having the extensions C<tmpl>, C<tt>, C<tt2>, C<html>, |
135 | and C<xhtml> I<will not> be served statically by default, they will be |
136 | processed by Catalyst. Thus if you want to use C<.html> files from |
137 | within a Catalyst app as static files, you need to change the |
138 | configuration of Static::Simple. Note also that files having any other |
139 | extension I<will> be served statically, so if you're using any other |
140 | extension for template files, you should also change the configuration. |
141 | |
142 | Logging of static files is turned off by default. |
b1d96e3e |
143 | |
144 | =head1 ADVANCED CONFIGURATION |
145 | |
bc5b1283 |
146 | Configuration is completely optional and is specified within |
fa25e422 |
147 | C<MyApp-E<gt>config-E<gt>{Plugin::Static::Simple}>. If you use any of these options, |
86880b0d |
148 | this module will probably feel less "simple" to you! |
b1d96e3e |
149 | |
bc5b1283 |
150 | =head2 Enabling request logging |
2de14076 |
151 | |
bc5b1283 |
152 | Since Catalyst 5.50, logging of static requests is turned off by |
153 | default; static requests tend to clutter the log output and rarely |
154 | reveal anything useful. However, if you want to enable logging of static |
155 | requests, you can do so by setting |
fa25e422 |
156 | C<MyApp-E<gt>config-E<gt>{Plugin::Static::Simple}-E<gt>{logging}> to 1. |
2de14076 |
157 | |
2268e329 |
158 | =head2 Forcing directories into static mode |
b1d96e3e |
159 | |
bc5b1283 |
160 | Define a list of top-level directories beneath your 'root' directory |
161 | that should always be served in static mode. Regular expressions may be |
162 | specified using C<qr//>. |
b1d96e3e |
163 | |
a5d909f1 |
164 | MyApp->config( |
fa25e422 |
165 | 'Plugin::Static::Simple' => { |
a5d909f1 |
166 | dirs => [ |
167 | 'static', |
168 | qr/^(images|css)/, |
169 | ], |
170 | } |
171 | ); |
b1d96e3e |
172 | |
fa43d6b5 |
173 | =head2 Including additional directories |
b1d96e3e |
174 | |
175 | You may specify a list of directories in which to search for your static |
bc5b1283 |
176 | files. The directories will be searched in order and will return the |
177 | first file found. Note that your root directory is B<not> automatically |
178 | added to the search path when you specify an C<include_path>. You should |
179 | use C<MyApp-E<gt>config-E<gt>{root}> to add it. |
b1d96e3e |
180 | |
a5d909f1 |
181 | MyApp->config( |
fa25e422 |
182 | 'Plugin::Static::Simple' => { |
a5d909f1 |
183 | include_path => [ |
184 | '/path/to/overlay', |
185 | \&incpath_generator, |
186 | MyApp->config->{root}, |
187 | ], |
188 | }, |
189 | ); |
b108737b |
190 | |
bc5b1283 |
191 | With the above setting, a request for the file C</images/logo.jpg> will search |
b1d96e3e |
192 | for the following files, returning the first one found: |
193 | |
194 | /path/to/overlay/images/logo.jpg |
195 | /dynamic/path/images/logo.jpg |
196 | /your/app/home/root/images/logo.jpg |
b108737b |
197 | |
b1d96e3e |
198 | The include path can contain a subroutine reference to dynamically return a |
bc5b1283 |
199 | list of available directories. This method will receive the C<$c> object as a |
b1d96e3e |
200 | parameter and should return a reference to a list of directories. Errors can |
bc5b1283 |
201 | be reported using C<die()>. This method will be called every time a file is |
b1d96e3e |
202 | requested that appears to be a static file (i.e. it has an extension). |
203 | |
204 | For example: |
205 | |
206 | sub incpath_generator { |
207 | my $c = shift; |
a5d909f1 |
208 | |
b1d96e3e |
209 | if ( $c->session->{customer_dir} ) { |
210 | return [ $c->session->{customer_dir} ]; |
211 | } else { |
212 | die "No customer dir defined."; |
213 | } |
214 | } |
b108737b |
215 | |
8cc672a2 |
216 | =head2 Ignoring certain types of files |
217 | |
bc5b1283 |
218 | There are some file types you may not wish to serve as static files. |
219 | Most important in this category are your raw template files. By |
220 | default, files with the extensions C<tmpl>, C<tt>, C<tt2>, C<html>, and |
221 | C<xhtml> will be ignored by Static::Simple in the interest of security. |
222 | If you wish to define your own extensions to ignore, use the |
223 | C<ignore_extensions> option: |
8cc672a2 |
224 | |
a5d909f1 |
225 | MyApp->config( |
fa25e422 |
226 | 'Plugin::Static::Simple' => { |
a5d909f1 |
227 | ignore_extensions => [ qw/html asp php/ ], |
228 | }, |
229 | ); |
b108737b |
230 | |
8cc672a2 |
231 | =head2 Ignoring entire directories |
232 | |
bc5b1283 |
233 | To prevent an entire directory from being served statically, you can use |
234 | the C<ignore_dirs> option. This option contains a list of relative |
235 | directory paths to ignore. If using C<include_path>, the path will be |
236 | checked against every included path. |
8cc672a2 |
237 | |
a5d909f1 |
238 | MyApp->config( |
fa25e422 |
239 | 'Plugin::Static::Simple' => { |
a5d909f1 |
240 | ignore_dirs => [ qw/tmpl css/ ], |
241 | }, |
242 | ); |
b108737b |
243 | |
bc5b1283 |
244 | For example, if combined with the above C<include_path> setting, this |
245 | C<ignore_dirs> value will ignore the following directories if they exist: |
8cc672a2 |
246 | |
247 | /path/to/overlay/tmpl |
248 | /path/to/overlay/css |
249 | /dynamic/path/tmpl |
250 | /dynamic/path/css |
251 | /your/app/home/root/tmpl |
b108737b |
252 | /your/app/home/root/css |
b1d96e3e |
253 | |
2268e329 |
254 | =head2 Custom MIME types |
b1d96e3e |
255 | |
bc5b1283 |
256 | To override or add to the default MIME types set by the L<MIME::Types> |
257 | module, you may enter your own extension to MIME type mapping. |
b1d96e3e |
258 | |
a5d909f1 |
259 | MyApp->config( |
fa25e422 |
260 | 'Plugin::Static::Simple' => { |
a5d909f1 |
261 | mime_types => { |
262 | jpg => 'image/jpg', |
263 | png => 'image/png', |
264 | }, |
265 | }, |
266 | ); |
2268e329 |
267 | |
41cac5ef |
268 | =head2 Controlling caching with Expires header |
269 | |
270 | The files served by Static::Simple will have a Last-Modified header set, |
271 | which allows some browsers to cache them for a while. However if you want |
272 | to explicitly set an Expires header, such as to allow proxies to cache your |
273 | static content, then you can do so by setting the "expires" config option. |
274 | |
275 | The value indicates the number of seconds after access time to allow caching. |
276 | So a value of zero really means "don't cache at all", and any higher values |
277 | will keep the file around for that long. |
278 | |
279 | MyApp->config( |
fa25e422 |
280 | 'Plugin::Static::Simple' => { |
41cac5ef |
281 | expires => 3600, # Caching allowed for one hour. |
282 | }, |
283 | ); |
284 | |
d38d0ed6 |
285 | =head2 Compatibility with other plugins |
b1d96e3e |
286 | |
d38d0ed6 |
287 | Since version 0.12, Static::Simple plays nice with other plugins. It no |
bc5b1283 |
288 | longer short-circuits the C<prepare_action> stage as it was causing too |
289 | many compatibility issues with other plugins. |
b1d96e3e |
290 | |
2268e329 |
291 | =head2 Debugging information |
b1d96e3e |
292 | |
293 | Enable additional debugging information printed in the Catalyst log. This |
294 | is automatically enabled when running Catalyst in -Debug mode. |
295 | |
a5d909f1 |
296 | MyApp->config( |
fa25e422 |
297 | 'Plugin::Static::Simple' => { |
a5d909f1 |
298 | debug => 1, |
299 | }, |
300 | ); |
b108737b |
301 | |
2cb3d585 |
302 | =head1 USING WITH APACHE |
303 | |
6e89d83c |
304 | While Static::Simple will work just fine serving files through Catalyst |
305 | in mod_perl, for increased performance you may wish to have Apache |
306 | handle the serving of your static files directly. To do this, simply use |
307 | a dedicated directory for your static files and configure an Apache |
308 | Location block for that directory This approach is recommended for |
309 | production installations. |
2cb3d585 |
310 | |
6e89d83c |
311 | <Location /myapp/static> |
2cb3d585 |
312 | SetHandler default-handler |
313 | </Location> |
b1d96e3e |
314 | |
bc5b1283 |
315 | Using this approach Apache will bypass any handling of these directories |
316 | through Catalyst. You can leave Static::Simple as part of your |
317 | application, and it will continue to function on a development server, |
318 | or using Catalyst's built-in server. |
319 | |
6e89d83c |
320 | In practice, your Catalyst application is probably (i.e. should be) |
321 | structured in the recommended way (i.e., that generated by bootstrapping |
322 | the application with the C<catalyst.pl> script, with a main directory |
323 | under which is a C<lib/> directory for module files and a C<root/> |
324 | directory for templates and static files). Thus, unless you break up |
325 | this structure when deploying your app by moving the static files to a |
326 | different location in your filesystem, you will need to use an Alias |
327 | directive in Apache to point to the right place. You will then need to |
328 | add a Directory block to give permission for Apache to serve these |
329 | files. The final configuration will look something like this: |
330 | |
331 | Alias /myapp/static /filesystem/path/to/MyApp/root/static |
332 | <Directory /filesystem/path/to/MyApp/root/static> |
333 | allow from all |
334 | </Directory> |
335 | <Location /myapp/static> |
336 | SetHandler default-handler |
337 | </Location> |
338 | |
071c0042 |
339 | If you are running in a VirtualHost, you can just set the DocumentRoot |
b108737b |
340 | location to the location of your root directory; see |
071c0042 |
341 | L<Catalyst::Engine::Apache2::MP20>. |
342 | |
ab02ca0d |
343 | =head1 PUBLIC METHODS |
344 | |
345 | =head2 serve_static_file $file_path |
346 | |
347 | Will serve the file located in $file_path statically. This is useful when |
348 | you need to autogenerate them if they don't exist, or they are stored in a model. |
349 | |
350 | package MyApp::Controller::User; |
351 | |
352 | sub curr_user_thumb : PathPart("my_thumbnail.png") { |
353 | my ( $self, $c ) = @_; |
354 | my $file_path = $c->user->picture_thumbnail_path; |
355 | $c->serve_static_file($file_path); |
356 | } |
357 | |
033a7581 |
358 | =head1 INTERNAL EXTENDED METHODS |
359 | |
360 | Static::Simple extends the following steps in the Catalyst process. |
361 | |
b108737b |
362 | =head2 prepare_action |
033a7581 |
363 | |
bc5b1283 |
364 | C<prepare_action> is used to first check if the request path is a static |
365 | file. If so, we skip all other C<prepare_action> steps to improve |
366 | performance. |
033a7581 |
367 | |
368 | =head2 dispatch |
369 | |
bc5b1283 |
370 | C<dispatch> takes the file found during C<prepare_action> and writes it |
371 | to the output. |
033a7581 |
372 | |
373 | =head2 finalize |
374 | |
bc5b1283 |
375 | C<finalize> serves up final header information and displays any log |
376 | messages. |
033a7581 |
377 | |
378 | =head2 setup |
379 | |
bc5b1283 |
380 | C<setup> initializes all default values. |
033a7581 |
381 | |
d6d29b9b |
382 | =head1 SEE ALSO |
383 | |
b108737b |
384 | L<Catalyst>, L<Catalyst::Plugin::Static>, |
b1d96e3e |
385 | L<http://www.iana.org/assignments/media-types/> |
d6d29b9b |
386 | |
387 | =head1 AUTHOR |
388 | |
b1d96e3e |
389 | Andy Grundman, <andy@hybridized.org> |
d6d29b9b |
390 | |
fa43d6b5 |
391 | =head1 CONTRIBUTORS |
392 | |
393 | Marcus Ramberg, <mramberg@cpan.org> |
ab02ca0d |
394 | |
bc5b1283 |
395 | Jesse Sheidlower, <jester@panix.com> |
fa43d6b5 |
396 | |
ab02ca0d |
397 | Guillermo Roditi, <groditi@cpan.org> |
398 | |
9936ddfa |
399 | Florian Ragwitz, <rafl@debian.org> |
400 | |
401 | Tomas Doran, <bobtfish@bobtfish.net> |
402 | |
403 | Justin Wheeler (dnm) |
b108737b |
404 | |
7c97dd21 |
405 | Matt S Trout, <mst@shadowcat.co.uk> |
406 | |
41cac5ef |
407 | Toby Corkindale, <tjc@wintrmute.net> |
408 | |
9c5fb712 |
409 | Graeme Lawton <cpan@per.ly> |
410 | |
411 | Mark Ellis <markellis@cpan.org> |
412 | |
d6d29b9b |
413 | =head1 THANKS |
414 | |
415 | The authors of Catalyst::Plugin::Static: |
416 | |
417 | Sebastian Riedel |
418 | Christian Hansen |
419 | Marcus Ramberg |
420 | |
421 | For the include_path code from Template Toolkit: |
422 | |
423 | Andy Wardley |
424 | |
425 | =head1 COPYRIGHT |
426 | |
41cac5ef |
427 | Copyright (c) 2005 - 2011 |
1cc75f96 |
428 | the Catalyst::Plugin::Static::Simple L</AUTHOR> and L</CONTRIBUTORS> |
429 | as listed above. |
430 | |
431 | =head1 LICENSE |
432 | |
d6d29b9b |
433 | This program is free software, you can redistribute it and/or modify it under |
434 | the same terms as Perl itself. |
435 | |
436 | =cut |