Commit | Line | Data |
cb93c9d7 |
1 | =head1 NAME |
2 | |
3 | Catalyst::Manual::Cookbook - Cooking with Catalyst |
4 | |
5 | =head1 DESCRIPTION |
6 | |
7 | Yummy code like your mum used to bake! |
8 | |
9 | =head1 RECIPES |
10 | |
11 | =head1 Basics |
12 | |
c718cfb6 |
13 | These recipes cover some basic stuff that is worth knowing for |
14 | catalyst developers. |
cb93c9d7 |
15 | |
16 | =head2 Delivering a Custom Error Page |
17 | |
18 | By default, Catalyst will display its own error page whenever it |
19 | encounters an error in your application. When running under C<-Debug> |
c718cfb6 |
20 | mode, the error page is a useful screen including the error message |
21 | and L<Data::Dump> output of the relevant parts of the C<$c> context |
22 | object. When not in C<-Debug>, users see a simple "Please come back |
23 | later" screen. |
cb93c9d7 |
24 | |
c718cfb6 |
25 | To use a custom error page, use a special C<end> method to |
26 | short-circuit the error processing. The following is an example; you |
27 | might want to adjust it further depending on the needs of your |
28 | application (for example, any calls to C<fillform> will probably need |
29 | to go into this C<end> method; see L<Catalyst::Plugin::FillInForm>). |
cb93c9d7 |
30 | |
31 | sub end : Private { |
32 | my ( $self, $c ) = @_; |
33 | |
34 | if ( scalar @{ $c->error } ) { |
35 | $c->stash->{errors} = $c->error; |
36 | $c->stash->{template} = 'errors.tt'; |
37 | $c->forward('MyApp::View::TT'); |
38 | $c->error(0); |
39 | } |
40 | |
41 | return 1 if $c->response->status =~ /^3\d\d$/; |
42 | return 1 if $c->response->body; |
43 | |
44 | unless ( $c->response->content_type ) { |
45 | $c->response->content_type('text/html; charset=utf-8'); |
46 | } |
47 | |
48 | $c->forward('MyApp::View::TT'); |
49 | } |
50 | |
51 | You can manually set errors in your code to trigger this page by calling |
52 | |
53 | $c->error( 'You broke me!' ); |
54 | |
55 | =head2 Disable statistics |
56 | |
c718cfb6 |
57 | Just add this line to your application class if you don't want those |
58 | nifty statistics in your debug messages. |
cb93c9d7 |
59 | |
60 | sub Catalyst::Log::info { } |
61 | |
62 | =head2 Enable debug status in the environment |
63 | |
64 | Normally you enable the debugging info by adding the C<-Debug> flag to |
65 | your C<use Catalyst> statement. However, you can also enable it using |
66 | environment variable, so you can (for example) get debug info without |
67 | modifying your application scripts. Just set C<CATALYST_DEBUG> or |
68 | C<E<lt>MYAPPE<gt>_DEBUG> to a true value. |
69 | |
70 | =head2 Sessions |
71 | |
c718cfb6 |
72 | When you have your users identified, you will want to somehow remember |
73 | that fact, to save them from having to identify themselves for every |
74 | single page. One way to do this is to send the username and password |
75 | parameters in every single page, but that's ugly, and won't work for |
76 | static pages. |
cb93c9d7 |
77 | |
c718cfb6 |
78 | Sessions are a method of saving data related to some transaction, and |
79 | giving the whole collection a single ID. This ID is then given to the |
80 | user to return to us on every page they visit while logged in. The |
81 | usual way to do this is using a browser cookie. |
cb93c9d7 |
82 | |
83 | Catalyst uses two types of plugins to represent sessions: |
84 | |
85 | =head3 State |
86 | |
c718cfb6 |
87 | A State module is used to keep track of the state of the session |
88 | between the users browser, and your application. |
cb93c9d7 |
89 | |
c718cfb6 |
90 | A common example is the Cookie state module, which sends the browser a |
91 | cookie containing the session ID. It will use default value for the |
92 | cookie name and domain, so will "just work" when used. |
cb93c9d7 |
93 | |
94 | =head3 Store |
95 | |
c718cfb6 |
96 | A Store module is used to hold all the data relating to your session, |
97 | for example the users ID, or the items for their shopping cart. You |
98 | can store data in memory (FastMmap), in a file (File) or in a database |
99 | (DBI). |
cb93c9d7 |
100 | |
101 | =head3 Authentication magic |
102 | |
103 | If you have included the session modules in your application, the |
104 | Authentication modules will automagically use your session to save and |
105 | retrieve the user data for you. |
106 | |
107 | =head3 Using a session |
108 | |
109 | Once the session modules are loaded, the session is available as C<< |
c718cfb6 |
110 | $c->session >>, and can be writen to and read from as a simple hash |
111 | reference. |
cb93c9d7 |
112 | |
113 | =head3 EXAMPLE |
114 | |
115 | use Catalyst qw/ |
116 | Session |
117 | Session::Store::FastMmap |
118 | Session::State::Cookie |
119 | /; |
120 | |
121 | |
122 | ## Write data into the session |
123 | |
124 | sub add_item : Local { |
125 | my ( $self, $c ) = @_; |
126 | |
127 | my $item_id = $c->req->param("item"); |
128 | |
129 | push @{ $c->session->{items} }, $item_id; |
130 | |
131 | } |
132 | |
133 | ## A page later we retrieve the data from the session: |
134 | |
135 | sub get_items : Local { |
136 | my ( $self, $c ) = @_; |
137 | |
138 | $c->stash->{items_to_display} = $c->session->{items}; |
139 | |
140 | } |
141 | |
142 | |
143 | =head3 More information |
144 | |
145 | L<http://search.cpan.org/dist/Catalyst-Plugin-Session> |
146 | |
147 | L<http://search.cpan.org/dist/Catalyst-Plugin-Session-State-Cookie> |
148 | |
149 | L<http://search.cpan.org/dist/Catalyst-Plugin-Session-State-URI> |
150 | |
151 | L<http://search.cpan.org/dist/Catalyst-Plugin-Session-Store-FastMmap> |
152 | |
153 | L<http://search.cpan.org/dist/Catalyst-Plugin-Session-Store-File> |
154 | |
155 | L<http://search.cpan.org/dist/Catalyst-Plugin-Session-Store-DBI> |
156 | |
157 | =head2 Configure your application |
158 | |
159 | You configure your application with the C<config> method in your |
160 | application class. This can be hard-coded, or brought in from a |
161 | separate configuration file. |
162 | |
163 | =head3 Using YAML |
164 | |
165 | YAML is a method for creating flexible and readable configuration |
c718cfb6 |
166 | files. It's a great way to keep your Catalyst application |
167 | configuration in one easy-to-understand location. |
cb93c9d7 |
168 | |
169 | In your application class (e.g. C<lib/MyApp.pm>): |
170 | |
171 | use YAML; |
172 | # application setup |
173 | __PACKAGE__->config( YAML::LoadFile(__PACKAGE__->config->{'home'} . '/myapp.yml') ); |
174 | __PACKAGE__->setup; |
175 | |
176 | Now create C<myapp.yml> in your application home: |
177 | |
178 | --- #YAML:1.0 |
179 | # DO NOT USE TABS FOR INDENTATION OR label/value SEPARATION!!! |
180 | name: MyApp |
181 | |
182 | # session; perldoc Catalyst::Plugin::Session::FastMmap |
183 | session: |
184 | expires: '3600' |
185 | rewrite: '0' |
186 | storage: '/tmp/myapp.session' |
187 | |
188 | # emails; perldoc Catalyst::Plugin::Email |
189 | # this passes options as an array :( |
190 | email: |
191 | - SMTP |
192 | - localhost |
193 | |
194 | This is equivalent to: |
195 | |
196 | # configure base package |
197 | __PACKAGE__->config( name => MyApp ); |
198 | # configure authentication |
199 | __PACKAGE__->config->{authentication} = { |
200 | user_class => 'MyApp::Model::MyDB::Customer', |
201 | ... |
202 | }; |
203 | # configure sessions |
204 | __PACKAGE__->config->{session} = { |
205 | expires => 3600, |
206 | ... |
207 | }; |
208 | # configure email sending |
209 | __PACKAGE__->config->{email} = [qw/SMTP localhost/]; |
210 | |
211 | See also L<YAML>. |
212 | |
213 | =head1 Skipping your VCS's directories |
214 | |
215 | Catalyst uses Module::Pluggable to load Models, Views and Controllers. |
216 | Module::Pluggable will scan through all directories and load modules |
217 | it finds. Sometimes you might want to skip some of these directories, |
218 | for example when your version control system makes a subdirectory with |
219 | meta-information in every version-controlled directory. While |
220 | Catalyst skips subversion and CVS directories already, there are other |
221 | source control systems. Here is the configuration you need to add |
222 | their directories to the list to skip. |
223 | |
224 | You can make catalyst skip these directories using the Catalyst config: |
225 | |
226 | # Configure the application |
227 | __PACKAGE__->config( |
228 | name => 'MyApp', |
229 | setup_components => { except => qr/SCCS/ }, |
230 | ); |
231 | |
232 | See the Module::Pluggable manual page for more information on B<except> |
233 | and other options. |
234 | |
235 | =head1 Users and Access Control |
236 | |
237 | Most multiuser, and some single user web applications require that |
238 | users identify themselves, and the application is often required to |
239 | define those roles. The recipes below describe some ways of doing |
240 | this. |
241 | |
242 | =head2 Authentication (logging in) |
243 | |
244 | This is extensively covered in other documentation; see in particular |
245 | L<Catalyst::Plugin::Authentication> and the Authentication chapter |
246 | of the Tutorial at L<Catalyst::Manual::Tutorial::Authorization>. |
247 | |
248 | =head2 Pass-through login (and other actions) |
249 | |
250 | An easy way of having assorted actions that occur during the processing |
251 | of a request that are orthogonal to its actual purpose - logins, silent |
252 | commands etc. Provide actions for these, but when they're required for |
253 | something else fill e.g. a form variable __login and have a sub begin |
254 | like so: |
255 | |
256 | sub begin : Private { |
257 | my ($self, $c) = @_; |
258 | foreach my $action (qw/login docommand foo bar whatever/) { |
259 | if ($c->req->params->{"__${action}"}) { |
260 | $c->forward($action); |
261 | } |
262 | } |
263 | } |
264 | |
265 | |
266 | =head2 Role-based Authorization |
267 | |
268 | For more advanced access control, you may want to consider using role-based |
269 | authorization. This means you can assign different roles to each user, e.g. |
270 | "user", "admin", etc. |
271 | |
272 | The C<login> and C<logout> methods and view template are exactly the same as |
273 | in the previous example. |
274 | |
275 | The L<Catalyst::Plugin::Authorization::Roles> plugin is required when |
276 | implementing roles: |
277 | |
278 | use Catalyst qw/ |
279 | Authentication |
280 | Authentication::Credential::Password |
281 | Authentication::Store::Htpasswd |
282 | Authorization::Roles |
283 | /; |
284 | |
285 | Roles are implemented automatically when using |
286 | L<Catalyst::Authentication::Store::Htpasswd>: |
287 | |
288 | # no additional role configuration required |
289 | __PACKAGE__->config->{authentication}{htpasswd} = "passwdfile"; |
290 | |
291 | Or can be set up manually when using L<Catalyst::Authentication::Store::DBIC>: |
292 | |
293 | # Authorization using a many-to-many role relationship |
294 | __PACKAGE__->config->{authorization}{dbic} = { |
295 | 'role_class' => 'My::Model::DBIC::Role', |
296 | 'role_field' => 'name', |
297 | 'user_role_user_field' => 'user', |
298 | |
299 | # DBIx::Class only (omit if using Class::DBI) |
300 | 'role_rel' => 'user_role', |
301 | |
302 | # Class::DBI only, (omit if using DBIx::Class) |
303 | 'user_role_class' => 'My::Model::CDBI::UserRole' |
304 | 'user_role_role_field' => 'role', |
305 | }; |
306 | |
307 | To restrict access to any action, you can use the C<check_user_roles> method: |
308 | |
309 | sub restricted : Local { |
310 | my ( $self, $c ) = @_; |
311 | |
312 | $c->detach("unauthorized") |
313 | unless $c->check_user_roles( "admin" ); |
314 | |
315 | # do something restricted here |
316 | } |
317 | |
c718cfb6 |
318 | You can also use the C<assert_user_roles> method. This just gives an |
319 | error if the current user does not have one of the required roles: |
cb93c9d7 |
320 | |
321 | sub also_restricted : Global { |
322 | my ( $self, $c ) = @_; |
323 | $c->assert_user_roles( qw/ user admin / ); |
324 | } |
325 | |
326 | =head2 Authentication/Authorization |
327 | |
328 | This is done in several steps: |
329 | |
330 | =over 4 |
331 | |
332 | =item Verification |
333 | |
334 | Getting the user to identify themselves, by giving you some piece of |
c718cfb6 |
335 | information known only to you and the user. Then you can assume that |
336 | the user is who they say they are. This is called B<credential |
337 | verification>. |
cb93c9d7 |
338 | |
339 | =item Authorization |
340 | |
c718cfb6 |
341 | Making sure the user only accesses functions you want them to |
342 | access. This is done by checking the verified users data against your |
343 | internal list of groups, or allowed persons for the current page. |
cb93c9d7 |
344 | |
345 | =back |
346 | |
347 | =head3 Modules |
348 | |
c718cfb6 |
349 | The Catalyst Authentication system is made up of many interacting |
350 | modules, to give you the most flexibility possible. |
cb93c9d7 |
351 | |
352 | =head4 Credential verifiers |
353 | |
c718cfb6 |
354 | A Credential module tables the user input, and passes it to a Store, |
355 | or some other system, for verification. Typically, a user object is |
356 | created by either this module or the Store and made accessible by a |
357 | C<< $c->user >> call. |
cb93c9d7 |
358 | |
359 | Examples: |
360 | |
361 | Password - Simple username/password checking. |
362 | HTTPD - Checks using basic HTTP auth. |
363 | TypeKey - Check using the typekey system. |
364 | |
365 | =head3 Storage backends |
366 | |
c718cfb6 |
367 | A Storage backend contains the actual data representing the users. It |
368 | is queried by the credential verifiers. Updating the store is not done |
369 | within this system, you will need to do it yourself. |
cb93c9d7 |
370 | |
371 | Examples: |
372 | |
373 | DBIC - Storage using a database. |
374 | Minimal - Storage using a simple hash (for testing). |
375 | |
376 | =head3 User objects |
377 | |
c718cfb6 |
378 | A User object is created by either the storage backend or the |
379 | credential verifier, and filled with the retrieved user information. |
cb93c9d7 |
380 | |
381 | Examples: |
382 | |
383 | Hash - A simple hash of keys and values. |
384 | |
385 | =head3 ACL authorization |
386 | |
c718cfb6 |
387 | ACL stands for Access Control List. The ACL plugin allows you to |
388 | regulate access on a path by path basis, by listing which users, or |
389 | roles, have access to which paths. |
cb93c9d7 |
390 | |
391 | =head3 Roles authorization |
392 | |
c718cfb6 |
393 | Authorization by roles is for assigning users to groups, which can |
394 | then be assigned to ACLs, or just checked when needed. |
cb93c9d7 |
395 | |
396 | =head3 Logging in |
397 | |
398 | When you have chosen your modules, all you need to do is call the C<< |
399 | $c->login >> method. If called with no parameters, it will try to find |
c718cfb6 |
400 | suitable parameters, such as B<username> and B<password>, or you can |
401 | pass it these values. |
cb93c9d7 |
402 | |
403 | =head3 Checking roles |
404 | |
c718cfb6 |
405 | Role checking is done by using the C<< $c->check_user_roles >> method, |
406 | this will check using the currently logged in user (via C<< $c->user |
407 | >>). You pass it the name of a role to check, and it returns true if |
408 | the user is a member. |
cb93c9d7 |
409 | |
410 | =head3 EXAMPLE |
411 | |
412 | use Catalyst qw/Authentication |
413 | Authentication::Credential::Password |
414 | Authentication::Store::Htpasswd |
415 | Authorization::Roles/; |
416 | |
417 | __PACKAGE__->config->{authentication}{htpasswd} = "passwdfile"; |
418 | |
419 | sub login : Local { |
420 | my ($self, $c) = @_; |
421 | |
422 | if ( my $user = $c->req->param("user") |
423 | and my $password = $c->req->param("password") ) |
424 | { |
425 | if ( $c->login( $user, $password ) ) { |
426 | $c->res->body( "hello " . $c->user->name ); |
427 | } else { |
428 | # login incorrect |
429 | } |
430 | } |
431 | else { |
432 | # invalid form input |
433 | } |
434 | } |
435 | |
436 | sub restricted : Local { |
437 | my ( $self, $c ) = @_; |
438 | |
439 | $c->detach("unauthorized") |
440 | unless $c->check_user_roles( "admin" ); |
441 | |
442 | # do something restricted here |
443 | } |
444 | |
445 | =head3 Using authentication in a testing environment |
446 | |
c718cfb6 |
447 | Ideally, to write tests for authentication/authorization code one |
448 | would first set up a test database with known data, then use |
449 | L<Test::WWW::Mechanize::Catalyst> to simulate a user logging |
450 | in. Unfortunately the former can be rather awkward, which is why it's |
451 | a good thing that the authentication framework is so flexible. |
cb93c9d7 |
452 | |
c718cfb6 |
453 | Instead of using a test database, one can simply change the |
454 | authentication store to something a bit easier to deal with in a |
455 | testing environment. Additionally, this has the advantage of not |
456 | modifying one's database, which can be problematic if one forgets to |
457 | use the testing instead of production database. |
cb93c9d7 |
458 | |
459 | e.g., |
460 | |
461 | use Catalyst::Plugin::Authentication::Store::Minimal::Backend; |
462 | |
463 | # Sets up the user `test_user' with password `test_pass' |
464 | MyApp->default_auth_store( |
465 | Catalyst::Plugin::Authentication::Store::Minimal::Backend->new({ |
466 | test_user => { password => 'test_pass' }, |
467 | }) |
468 | ); |
469 | |
470 | Now, your test code can call C<$c->login('test_user', 'test_pass')> and |
471 | successfully login, without messing with the database at all. |
472 | |
473 | =head3 More information |
474 | |
475 | L<http://search.cpan.org/perldoc?Catalyst::Plugin::Authentication> has a longer explanation. |
476 | |
477 | =head2 Authorization |
478 | |
479 | =head3 Introduction |
480 | |
c718cfb6 |
481 | Authorization is the step that comes after |
482 | authentication. Authentication establishes that the user agent is |
483 | really representing the user we think it's representing, and then |
484 | authorization determines what this user is allowed to do. |
cb93c9d7 |
485 | |
486 | =head3 Role Based Access Control |
487 | |
c718cfb6 |
488 | Under role based access control each user is allowed to perform any |
489 | number of roles. For example, at a zoo no one but specially trained |
490 | personnel can enter the moose cage (Mynd you, møøse bites kan be |
491 | pretty nasti!). For example: |
cb93c9d7 |
492 | |
493 | package Zoo::Controller::MooseCage; |
494 | |
495 | sub feed_moose : Local { |
496 | my ( $self, $c ) = @_; |
497 | |
498 | $c->model( "Moose" )->eat( $c->req->param("food") ); |
499 | } |
500 | |
c718cfb6 |
501 | With this action, anyone can just come into the moose cage and feed |
502 | the moose, which is a very dangerous thing. We need to restrict this |
503 | action, so that only a qualified moose feeder can perform that action. |
cb93c9d7 |
504 | |
c718cfb6 |
505 | The Authorization::Roles plugin let's us perform role based access |
506 | control checks. Let's load it: |
cb93c9d7 |
507 | |
508 | use Catalyst qw/ |
509 | Authentication # yadda yadda |
510 | Authorization::Roles |
511 | /; |
512 | |
513 | And now our action should look like this: |
514 | |
515 | sub feed_moose : Local { |
516 | my ( $self, $c ) = @_; |
517 | |
518 | if ( $c->check_roles( "moose_feeder" ) ) { |
519 | $c->model( "Moose" )->eat( $c->req->param("food") ); |
520 | } else { |
521 | $c->stash->{error} = "unauthorized"; |
522 | } |
523 | } |
524 | |
c718cfb6 |
525 | This checks C<< $c->user >>, and only if the user has B<all> the roles |
526 | in the list, a true value is returned. |
cb93c9d7 |
527 | |
c718cfb6 |
528 | C<check_roles> has a sister method, C<assert_roles>, which throws an |
529 | exception if any roles are missing. |
cb93c9d7 |
530 | |
531 | Some roles that might actually make sense in, say, a forum application: |
532 | |
533 | =over 4 |
534 | |
535 | =item * |
536 | |
537 | administrator |
538 | |
539 | =item * |
540 | |
541 | moderator |
542 | |
543 | =back |
544 | |
c718cfb6 |
545 | each with a distinct task (system administration versus content |
546 | administration). |
cb93c9d7 |
547 | |
548 | =head3 Access Control Lists |
549 | |
550 | Checking for roles all the time can be tedious and error prone. |
551 | |
c718cfb6 |
552 | The Authorization::ACL plugin let's us declare where we'd like checks |
553 | to be done automatically for us. |
cb93c9d7 |
554 | |
555 | For example, we may want to completely block out anyone who isn't a |
556 | C<moose_feeder> from the entire C<MooseCage> controller: |
557 | |
558 | Zoo->deny_access_unless( "/moose_cage", [qw/moose_feeder/] ); |
559 | |
c718cfb6 |
560 | The role list behaves in the same way as C<check_roles>. However, the |
561 | ACL plugin isn't limited to just interacting with the Roles plugin. We |
562 | can use a code reference instead. For example, to allow either moose |
563 | trainers or moose feeders into the moose cage, we can create a more |
564 | complex check: |
cb93c9d7 |
565 | |
566 | Zoo->deny_access_unless( "/moose_cage", sub { |
567 | my $c = shift; |
568 | $c->check_roles( "moose_trainer" ) || $c->check_roles( "moose_feeder" ); |
569 | }); |
570 | |
c718cfb6 |
571 | The more specific a role, the earlier it will be checked. Let's say |
572 | moose feeders are now restricted to only the C<feed_moose> action, |
573 | while moose trainers get access everywhere: |
cb93c9d7 |
574 | |
575 | Zoo->deny_access_unless( "/moose_cage", [qw/moose_trainer/] ); |
576 | Zoo->allow_access_if( "/moose_cage/feed_moose", [qw/moose_feeder/]); |
577 | |
c718cfb6 |
578 | When the C<feed_moose> action is accessed the second check will be |
579 | made. If the user is a C<moose_feeder>, then access will be |
580 | immediately granted. Otherwise, the next rule in line will be tested - |
581 | the one checking for a C<moose_trainer>. If this rule is not |
582 | satisfied, access will be immediately denied. |
cb93c9d7 |
583 | |
c718cfb6 |
584 | Rules applied to the same path will be checked in the order they were |
585 | added. |
cb93c9d7 |
586 | |
c718cfb6 |
587 | Lastly, handling access denial events is done by creating an |
588 | C<access_denied> private action: |
cb93c9d7 |
589 | |
590 | sub access_denied : Private { |
591 | my ( $self, $c, $action ) = @_; |
cb93c9d7 |
592 | } |
593 | |
c718cfb6 |
594 | This action works much like auto, in that it is inherited across |
595 | namespaces (not like object oriented code). This means that the |
596 | C<access_denied> action which is B<nearest> to the action which was |
597 | blocked will be triggered. |
cb93c9d7 |
598 | |
c718cfb6 |
599 | If this action does not exist, an error will be thrown, which you can |
600 | clean up in your C<end> private action instead. |
cb93c9d7 |
601 | |
c718cfb6 |
602 | Also, it's important to note that if you restrict access to "/" then |
603 | C<end>, C<default>, etc will also be restricted. |
cb93c9d7 |
604 | |
605 | MyApp->acl_allow_root_internals; |
606 | |
607 | will create rules that permit access to C<end>, C<begin>, and C<auto> in the |
608 | root of your app (but not in any other controller). |
609 | |
610 | =head1 Models |
611 | |
612 | Models are where application data belongs. Catalyst is exteremely |
613 | flexible with the kind of models that it can use. The recipes here |
614 | are just the start. |
615 | |
616 | =head2 Using existing DBIC (etc.) classes with Catalyst |
617 | |
c718cfb6 |
618 | Many people have existing Model classes that they would like to use |
619 | with Catalyst (or, conversely, they want to write Catalyst models that |
620 | can be used outside of Catalyst, e.g. in a cron job). It's trivial to |
621 | write a simple component in Catalyst that slurps in an outside Model: |
cb93c9d7 |
622 | |
623 | package MyApp::Model::DB; |
624 | use base qw/Catalyst::Model::DBIC::Schema/; |
625 | __PACKAGE__->config( |
626 | schema_class => 'Some::DBIC::Schema', |
627 | connect_info => ['dbi:SQLite:foo.db', '', '', {AutoCommit=>1}]; |
628 | ); |
629 | 1; |
630 | |
631 | and that's it! Now C<Some::DBIC::Schema> is part of your |
632 | Cat app as C<MyApp::Model::DB>. |
633 | |
634 | =head2 DBIx::Class as a Catalyst Model |
635 | |
636 | See L<Catalyst::Model::DBIC::Schema>. |
637 | |
638 | =head2 XMLRPC |
639 | |
640 | Unlike SOAP, XMLRPC is a very simple (and imo elegant) web-services |
641 | protocol, exchanging small XML messages like these: |
642 | |
643 | Request: |
644 | |
645 | POST /api HTTP/1.1 |
646 | TE: deflate,gzip;q=0.3 |
647 | Connection: TE, close |
648 | Accept: text/xml |
649 | Accept: multipart/* |
650 | Host: 127.0.0.1:3000 |
651 | User-Agent: SOAP::Lite/Perl/0.60 |
652 | Content-Length: 192 |
653 | Content-Type: text/xml |
654 | |
655 | <?xml version="1.0" encoding="UTF-8"?> |
656 | <methodCall> |
657 | <methodName>add</methodName> |
658 | <params> |
659 | <param><value><int>1</int></value></param> |
660 | <param><value><int>2</int></value></param> |
661 | </params> |
662 | </methodCall> |
663 | |
664 | Response: |
665 | |
666 | Connection: close |
667 | Date: Tue, 20 Dec 2005 07:45:55 GMT |
668 | Content-Length: 133 |
669 | Content-Type: text/xml |
670 | Status: 200 |
671 | X-Catalyst: 5.70 |
672 | |
673 | <?xml version="1.0" encoding="us-ascii"?> |
674 | <methodResponse> |
675 | <params> |
676 | <param><value><int>3</int></value></param> |
677 | </params> |
678 | </methodResponse> |
679 | |
680 | Now follow these few steps to implement the application: |
681 | |
682 | 1. Install Catalyst (5.61 or later), Catalyst::Plugin::XMLRPC (0.06 or |
683 | later) and SOAP::Lite (for XMLRPCsh.pl). |
684 | |
685 | 2. Create an application framework: |
686 | |
687 | % catalyst.pl MyApp |
688 | ... |
689 | % cd MyApp |
690 | |
691 | 3. Add the XMLRPC plugin to MyApp.pm |
692 | |
693 | use Catalyst qw/-Debug Static::Simple XMLRPC/; |
694 | |
695 | 4. Add an API controller |
696 | |
697 | % ./script/myapp_create.pl controller API |
698 | |
699 | 5. Add a XMLRPC redispatch method and an add method with Remote |
700 | attribute to lib/MyApp/Controller/API.pm |
701 | |
702 | sub default : Private { |
703 | my ( $self, $c ) = @_; |
704 | $c->xmlrpc; |
705 | } |
706 | |
707 | sub add : Remote { |
708 | my ( $self, $c, $a, $b ) = @_; |
709 | return $a + $b; |
710 | } |
711 | |
712 | The default action is the entry point for each XMLRPC request. It will |
713 | redispatch every request to methods with Remote attribute in the same |
714 | class. |
715 | |
716 | The C<add> method is not a traditional action; it has no private or |
717 | public path. Only the XMLRPC dispatcher knows it exists. |
718 | |
719 | 6. That's it! You have built your first web service. Let's test it with |
720 | XMLRPCsh.pl (part of SOAP::Lite): |
721 | |
722 | % ./script/myapp_server.pl |
723 | ... |
724 | % XMLRPCsh.pl http://127.0.0.1:3000/api |
725 | Usage: method[(parameters)] |
726 | > add( 1, 2 ) |
727 | --- XMLRPC RESULT --- |
728 | '3' |
729 | |
730 | =head3 Tip |
731 | |
732 | Your return data type is usually auto-detected, but you can easily |
733 | enforce a specific one. |
734 | |
735 | sub add : Remote { |
736 | my ( $self, $c, $a, $b ) = @_; |
737 | return RPC::XML::int->new( $a + $b ); |
738 | } |
739 | |
740 | |
741 | |
742 | =head1 Views |
743 | |
744 | Views pertain to the display of your application. As with models, |
745 | catalyst is uncommonly flexible. The recipes below are just a start. |
746 | |
747 | =head2 Catalyst::View::TT |
748 | |
749 | One of the first things you probably want to do when starting a new |
750 | Catalyst application is set up your View. Catalyst doesn't care how you |
751 | display your data; you can choose to generate HTML, PDF files, or plain |
752 | text if you wanted. |
753 | |
754 | Most Catalyst applications use a template system to generate their HTML, |
755 | and though there are several template systems available, Template |
756 | Toolkit is probably the most popular. |
757 | |
758 | Once again, the Catalyst developers have done all the hard work, and |
759 | made things easy for the rest of us. Catalyst::View::TT provides the |
760 | interface to Template Toolkit, and provides Helpers which let us set it |
761 | up that much more easily. |
762 | |
763 | =head3 Creating your View |
764 | |
765 | Catalyst::View::TT provides two different helpers for us to use: TT and |
766 | TTSite. |
767 | |
768 | =head4 TT |
769 | |
770 | Create a basic Template Toolkit View using the provided helper script: |
771 | |
772 | script/myapp_create.pl view TT TT |
773 | |
774 | This will create lib/MyApp/View/MyView.pm, which is going to be pretty |
775 | empty to start. However, it sets everything up that you need to get |
776 | started. You can now define which template you want and forward to your |
777 | view. For instance: |
778 | |
779 | sub hello : Local { |
780 | my ( $self, $c ) = @_; |
781 | |
782 | $c->stash->{template} = 'hello.tt'; |
783 | |
784 | $c->forward( $c->view('TT') ); |
785 | } |
786 | |
787 | In practice you wouldn't do the forwarding manually, but would |
788 | use L<Catalyst::Action::RenderView>. |
789 | |
790 | =head4 TTSite |
791 | |
792 | Although the TT helper does create a functional, working view, you may |
793 | find yourself having to create the same template files and changing the |
794 | same options every time you create a new application. The TTSite helper |
795 | saves us even more time by creating the basic templates and setting some |
796 | common options for us. |
797 | |
798 | Once again, you can use the helper script: |
799 | |
800 | script/myapp_create.pl view TT TTSite |
801 | |
802 | This time, the helper sets several options for us in the generated View. |
803 | |
804 | __PACKAGE__->config({ |
805 | CATALYST_VAR => 'Catalyst', |
806 | INCLUDE_PATH => [ |
807 | MyApp->path_to( 'root', 'src' ), |
808 | MyApp->path_to( 'root', 'lib' ) |
809 | ], |
810 | PRE_PROCESS => 'config/main', |
811 | WRAPPER => 'site/wrapper', |
812 | ERROR => 'error.tt2', |
813 | TIMER => 0 |
814 | }); |
815 | |
816 | =over |
817 | |
818 | =item |
819 | |
820 | INCLUDE_PATH defines the directories that Template Toolkit should search |
821 | for the template files. |
822 | |
823 | =item |
824 | |
825 | PRE_PROCESS is used to process configuration options which are common to |
826 | every template file. |
827 | |
828 | =item |
829 | |
830 | WRAPPER is a file which is processed with each template, usually used to |
831 | easily provide a common header and footer for every page. |
832 | |
833 | =back |
834 | |
835 | In addition to setting these options, the TTSite helper also created the |
836 | template and config files for us! In the 'root' directory, you'll notice |
837 | two new directories: src and lib. |
838 | |
839 | Several configuration files in root/lib/config are called by PRE_PROCESS. |
840 | |
841 | The files in root/lib/site are the site-wide templates, called by |
842 | WRAPPER, and display the html framework, control the layout, and provide |
843 | the templates for the header and footer of your page. Using the template |
844 | organization provided makes it much easier to standardize pages and make |
845 | changes when they are (inevitably) needed. |
846 | |
847 | The template files that you will create for your application will go |
848 | into root/src, and you don't need to worry about putting the the <html> |
849 | or <head> sections; just put in the content. The WRAPPER will the rest |
850 | of the page around your template for you. |
851 | |
852 | |
853 | =head3 $c->stash |
854 | |
855 | Of course, having the template system include the header and footer for |
856 | you isn't all that we want our templates to do. We need to be able to |
857 | put data into our templates, and have it appear where and how we want |
858 | it, right? That's where the stash comes in. |
859 | |
860 | In our controllers, we can add data to the stash, and then access it |
861 | from the template. For instance: |
862 | |
863 | sub hello : Local { |
864 | my ( $self, $c ) = @_; |
865 | |
866 | $c->stash->{name} = 'Adam'; |
867 | |
868 | $c->stash->{template} = 'hello.tt'; |
869 | |
870 | $c->forward( $c->view('TT') ); |
871 | } |
872 | |
873 | Then, in hello.tt: |
874 | |
875 | <strong>Hello, [% name %]!</strong> |
876 | |
877 | When you view this page, it will display "Hello, Adam!" |
878 | |
879 | All of the information in your stash is available, by its name/key, in |
880 | your templates. And your data don't have to be plain, old, boring |
881 | scalars. You can pass array references and hash references, too. |
882 | |
883 | In your controller: |
884 | |
885 | sub hello : Local { |
886 | my ( $self, $c ) = @_; |
887 | |
888 | $c->stash->{names} = [ 'Adam', 'Dave', 'John' ]; |
889 | |
890 | $c->stash->{template} = 'hello.tt'; |
891 | |
892 | $c->forward( $c->view('TT') ); |
893 | } |
894 | |
895 | In hello.tt: |
896 | |
897 | [% FOREACH name IN names %] |
898 | <strong>Hello, [% name %]!</strong><br /> |
899 | [% END %] |
900 | |
901 | This allowed us to loop through each item in the arrayref, and display a |
902 | line for each name that we have. |
903 | |
904 | This is the most basic usage, but Template Toolkit is quite powerful, |
905 | and allows you to truly keep your presentation logic separate from the |
906 | rest of your application. |
907 | |
908 | =head3 $c->uri_for() |
909 | |
910 | One of my favorite things about Catalyst is the ability to move an |
911 | application around without having to worry that everything is going to |
912 | break. One of the areas that used to be a problem was with the http |
913 | links in your template files. For example, suppose you have an |
914 | application installed at http://www.domain.com/Calendar. The links point |
915 | to "/Calendar", "/Calendar/2005", "/Calendar/2005/10", etc. If you move |
916 | the application to be at http://www.mydomain.com/Tools/Calendar, then |
917 | all of those links will suddenly break. |
918 | |
919 | That's where $c->uri_for() comes in. This function will merge its |
920 | parameters with either the base location for the app, or its current |
921 | namespace. Let's take a look at a couple of examples. |
922 | |
923 | In your template, you can use the following: |
924 | |
925 | <a href="[% c.uri_for('/login') %]">Login Here</a> |
926 | |
c718cfb6 |
927 | Although the parameter starts with a forward slash, this is relative |
928 | to the application root, not the webserver root. This is important to |
929 | remember. So, if your application is installed at |
930 | http://www.domain.com/Calendar, then the link would be |
931 | http://www.mydomain.com/Calendar/Login. If you move your application |
932 | to a different domain or path, then that link will still be correct. |
cb93c9d7 |
933 | |
934 | Likewise, |
935 | |
936 | <a href="[% c.uri_for('2005','10', '24') %]">October, 24 2005</a> |
937 | |
c718cfb6 |
938 | The first parameter does NOT have a forward slash, and so it will be |
939 | relative to the current namespace. If the application is installed at |
940 | http://www.domain.com/Calendar. and if the template is called from |
941 | MyApp::Controller::Display, then the link would become |
942 | http://www.domain.com/Calendar/Display/2005/10/24. |
943 | |
944 | If you want to link to a parent uri of your current namespace you can |
945 | prefix the arguments with multiple '../': |
946 | |
947 | <a href="[% c.uri_for('../../view', stashed_object.id) %]">User view</a> |
cb93c9d7 |
948 | |
c718cfb6 |
949 | Once again, this allows you to move your application around without |
950 | having to worry about broken links. But there's something else, as |
951 | well. Since the links are generated by uri_for, you can use the same |
952 | template file by several different controllers, and each controller |
953 | will get the links that its supposed to. Since we believe in Don't |
954 | Repeat Yourself, this is particularly helpful if you have common |
955 | elements in your site that you want to keep in one file. |
cb93c9d7 |
956 | |
957 | Further Reading: |
958 | |
959 | L<http://search.cpan.org/perldoc?Catalyst> |
960 | |
961 | L<http://search.cpan.org/perldoc?Catalyst%3A%3AView%3A%3ATT> |
962 | |
963 | L<http://search.cpan.org/perldoc?Template> |
964 | |
965 | =head2 Adding RSS feeds |
966 | |
967 | Adding RSS feeds to your Catalyst applications is simple. We'll see two |
968 | different aproaches here, but the basic premise is that you forward to |
969 | the normal view action first to get the objects, then handle the output |
970 | differently. |
971 | |
972 | =head3 Using TT templates |
973 | |
974 | This is the aproach used in Agave (L<http://dev.rawmode.org/>). |
975 | |
976 | sub rss : Local { |
977 | my ($self,$c) = @_; |
978 | $c->forward('view'); |
979 | $c->stash->{template}='rss.tt'; |
980 | } |
981 | |
982 | Then you need a template. Here's the one from Agave: |
983 | |
984 | <?xml version="1.0" encoding="UTF-8"?> |
985 | <rss version="2.0" xmlns:dc="http://purl.org/dc/elements/1.1/"> |
986 | <channel> |
987 | <title>[ [% blog.name || c.config.name || "Agave" %] ] RSS Feed</title> |
988 | <link>[% base %]</link> |
989 | <description>Recent posts</description> |
990 | <language>en-us</language> |
991 | <ttl>40</ttl> |
992 | [% WHILE (post = posts.next) %] |
993 | <item> |
994 | <title>[% post.title %]</title> |
995 | <description>[% post.formatted_teaser|html%]</description> |
996 | <pubDate>[% post.pub_date %]</pubDate> |
997 | <guid>[% post.full_uri %]</guid> |
998 | <link>[% post.full_uri %]</link> |
999 | <dc:creator>[% post.author.screenname %]</dc:creator> |
1000 | </item> |
1001 | [% END %] |
1002 | </channel> |
1003 | </rss> |
1004 | |
1005 | =head3 Using XML::Feed |
1006 | |
1007 | A more robust solution is to use XML::Feed, as was done in the Catalyst |
1008 | Advent Calendar. Assuming we have a C<view> action that populates |
1009 | 'entries' with some DBIx::Class iterator, the code would look something |
1010 | like this: |
1011 | |
1012 | sub rss : Local { |
1013 | my ($self,$c) = @_; |
1014 | $c->forward('view'); # get the entries |
1015 | |
1016 | my $feed = XML::Feed->new('RSS'); |
1017 | $feed->title( $c->config->{name} . ' RSS Feed' ); |
1018 | $feed->link( $c->req->base ); # link to the site. |
1019 | $feed->description('Catalyst advent calendar'); Some description |
1020 | |
1021 | # Process the entries |
1022 | while( my $entry = $c->stash->{entries}->next ) { |
1023 | my $feed_entry = XML::Feed::Entry->new('RSS'); |
1024 | $feed_entry->title($entry->title); |
1025 | $feed_entry->link( $c->uri_for($entry->link) ); |
1026 | $feed_entry->issued( DateTime->from_epoch(epoch => $entry->created) ); |
1027 | $feed->add_entry($feed_entry); |
1028 | } |
1029 | $c->res->body( $feed->as_xml ); |
1030 | } |
1031 | |
1032 | A little more code in the controller, but with this approach you're |
1033 | pretty sure to get something that validates. |
1034 | |
1035 | Note that for both of the above aproaches, you'll need to set the |
1036 | content type like this: |
1037 | |
1038 | $c->res->content_type('application/rss+xml'); |
1039 | |
1040 | =head3 Final words |
1041 | |
1042 | You could generalize the second variant easily by replacing 'RSS' with a |
1043 | variable, so you can generate Atom feeds with the same code. |
1044 | |
1045 | Now, go ahead and make RSS feeds for all your stuff. The world *needs* |
1046 | updates on your goldfish! |
1047 | |
1048 | =head2 Forcing the browser to download content |
1049 | |
1050 | Sometimes you need your application to send content for download. For |
1051 | example, you can generate a comma-separated values (CSV) file for your |
1052 | users to download and import into their spreadsheet program. |
1053 | |
1054 | Let's say you have an C<Orders> controller which generates a CSV file |
1055 | in the C<export> action (i.e., C<http://localhost:3000/orders/export>): |
1056 | |
1057 | sub export : Local Args(0) { |
1058 | my ( $self, $c ) = @_; |
1059 | |
1060 | # In a real application, you'd generate this from the database |
1061 | my $csv = "1,5.99\n2,29.99\n3,3.99\n"; |
1062 | |
1063 | $c->res->content_type('text/comma-separated-values'); |
1064 | $c->res->body($csv); |
1065 | } |
1066 | |
1067 | Normally the browser uses the last part of the URI to generate a |
1068 | filename for data it cannot display. In this case your browser would |
1069 | likely ask you to save a file named C<export>. |
1070 | |
1071 | Luckily you can have the browser download the content with a specific |
1072 | filename by setting the C<Content-Disposition> header: |
1073 | |
1074 | my $filename = 'Important Orders.csv'; |
1075 | $c->res->header('Content-Disposition', qq[attachment; filename="$filename"]); |
1076 | |
1077 | Note the use of quotes around the filename; this ensures that any |
1078 | spaces in the filename are handled by the browser. |
1079 | |
1080 | Put this right before calling C<< $c->res->body >> and your browser |
1081 | will download a file named C<Important Orders.csv> instead of |
1082 | C<export>. |
1083 | |
1084 | You can also use this to have the browser download content which it |
1085 | normally displays, such as JPEG images or even HTML. Just be sure to |
1086 | set the appropriate content type and disposition. |
1087 | |
1088 | |
1089 | =head1 Controllers |
1090 | |
1091 | Controllers are the main point of communication between the web server |
1092 | and your application. Here we explore some aspects of how they work. |
1093 | |
1094 | =head2 Extending RenderView (formerly DefaultEnd) |
1095 | |
1096 | The recommended approach for an C<end> action is to use |
1097 | L<Catalyst::Action::RenderView> (taking the place of |
1098 | L<Catalyst::Plugin::DefaultEnd>), which does what you usually need. |
1099 | However there are times when you need to add a bit to it, but don't want |
1100 | to write your own C<end> action. |
1101 | |
1102 | You can extend it like this: |
1103 | |
1104 | To add something to an C<end> action that is called before rendering |
1105 | (this is likely to be what you want), simply place it in the C<end> |
1106 | method: |
1107 | |
1108 | sub end : ActionClass('RenderView') { |
1109 | my ( $self, $c ) = @_; |
1110 | # do stuff here; the RenderView action is called afterwards |
1111 | } |
1112 | |
1113 | To add things to an C<end> action that are called I<after> rendering, |
1114 | you can set it up like this: |
1115 | |
1116 | sub render : ActionClass('RenderView') { } |
1117 | |
1118 | sub end : Private { |
1119 | my ( $self, $c ) = @_; |
1120 | $c->forward('render'); |
1121 | # do stuff here |
1122 | } |
1123 | |
1124 | =head2 Action Types |
1125 | |
1126 | =head3 Introduction |
1127 | |
c718cfb6 |
1128 | A Catalyst application is driven by one or more Controller |
1129 | modules. There are a number of ways that Catalyst can decide which of |
1130 | the methods in your controller modules it should call. Controller |
1131 | methods are also called actions, because they determine how your |
1132 | catalyst application should (re-)act to any given URL. When the |
1133 | application is started up, catalyst looks at all your actions, and |
1134 | decides which URLs they map to. |
cb93c9d7 |
1135 | |
1136 | =head3 Type attributes |
1137 | |
1138 | Each action is a normal method in your controller, except that it has an |
1139 | L<attribute|http://search.cpan.org/~nwclark/perl-5.8.7/lib/attributes.pm> |
1140 | attached. These can be one of several types. |
1141 | |
1142 | Assume our Controller module starts with the following package declaration: |
1143 | |
1144 | package MyApp::Controller::Buckets; |
1145 | |
1146 | and we are running our application on localhost, port 3000 (the test |
1147 | server default). |
1148 | |
1149 | =over 4 |
1150 | |
1151 | =item Path |
1152 | |
1153 | A Path attribute also takes an argument, this can be either a relative |
c718cfb6 |
1154 | or an absolute path. A relative path will be relative to the |
1155 | controller namespace, an absolute path will represent an exact |
1156 | matching URL. |
cb93c9d7 |
1157 | |
1158 | sub my_handles : Path('handles') { .. } |
1159 | |
1160 | becomes |
1161 | |
1162 | http://localhost:3000/buckets/handles |
1163 | |
1164 | and |
1165 | |
1166 | sub my_handles : Path('/handles') { .. } |
1167 | |
1168 | becomes |
1169 | |
1170 | http://localhost:3000/handles |
1171 | |
1172 | =item Local |
1173 | |
c718cfb6 |
1174 | When using a Local attribute, no parameters are needed, instead, the |
1175 | name of the action is matched in the URL. The namespaces created by |
1176 | the name of the controller package is always part of the URL. |
cb93c9d7 |
1177 | |
1178 | sub my_handles : Local { .. } |
1179 | |
1180 | becomes |
1181 | |
1182 | http://localhost:3000/buckets/my_handles |
1183 | |
1184 | =item Global |
1185 | |
c718cfb6 |
1186 | A Global attribute is similar to a Local attribute, except that the |
1187 | namespace of the controller is ignored, and matching starts at root. |
cb93c9d7 |
1188 | |
1189 | sub my_handles : Global { .. } |
1190 | |
1191 | becomes |
1192 | |
1193 | http://localhost:3000/my_handles |
1194 | |
1195 | =item Regex |
1196 | |
c718cfb6 |
1197 | By now you should have figured that a Regex attribute is just what it |
1198 | sounds like. This one takes a regular expression, and matches starting |
1199 | from root. These differ from the rest as they can match multiple URLs. |
cb93c9d7 |
1200 | |
1201 | sub my_handles : Regex('^handles') { .. } |
1202 | |
1203 | matches |
1204 | |
1205 | http://localhost:3000/handles |
1206 | |
1207 | and |
1208 | |
1209 | http://localhost:3000/handles_and_other_parts |
1210 | |
1211 | etc. |
1212 | |
1213 | =item LocalRegex |
1214 | |
1215 | A LocalRegex is similar to a Regex, except it only matches below the current |
1216 | controller namespace. |
1217 | |
1218 | sub my_handles : LocalRegex(^handles') { .. } |
1219 | |
1220 | matches |
1221 | |
1222 | http://localhost:3000/buckets/handles |
1223 | |
1224 | and |
1225 | |
1226 | http://localhost:3000/buckets/handles_and_other_parts |
1227 | |
1228 | etc. |
1229 | |
1230 | =item Private |
1231 | |
c718cfb6 |
1232 | Last but not least, there is the Private attribute, which allows you |
1233 | to create your own internal actions, which can be forwarded to, but |
1234 | won't be matched as URLs. |
cb93c9d7 |
1235 | |
1236 | sub my_handles : Private { .. } |
1237 | |
1238 | becomes nothing at all.. |
1239 | |
c718cfb6 |
1240 | Catalyst also predefines some special Private actions, which you can |
1241 | override, these are: |
cb93c9d7 |
1242 | |
1243 | =over 4 |
1244 | |
1245 | =item default |
1246 | |
c718cfb6 |
1247 | The default action will be called, if no other matching action is |
1248 | found. If you don't have one of these in your namespace, or any sub |
1249 | part of your namespace, you'll get an error page instead. If you want |
1250 | to find out where it was the user was trying to go, you can look in |
1251 | the request object using C<< $c->req->path >>. |
cb93c9d7 |
1252 | |
1253 | sub default : Private { .. } |
1254 | |
c718cfb6 |
1255 | works for all unknown URLs, in this controller namespace, or every one |
1256 | if put directly into MyApp.pm. |
cb93c9d7 |
1257 | |
1258 | =item index |
1259 | |
c718cfb6 |
1260 | The index action is called when someone tries to visit the exact |
1261 | namespace of your controller. If index, default and matching Path |
1262 | actions are defined, then index will be used instead of default and |
1263 | Path. |
cb93c9d7 |
1264 | |
1265 | sub index : Private { .. } |
1266 | |
1267 | becomes |
1268 | |
1269 | http://localhost:3000/buckets |
1270 | |
1271 | =item begin |
1272 | |
c718cfb6 |
1273 | The begin action is called at the beginning of every request involving |
1274 | this namespace directly, before other matching actions are called. It |
1275 | can be used to set up variables/data for this particular part of your |
1276 | app. A single begin action is called, its always the one most relevant |
1277 | to the current namespace. |
cb93c9d7 |
1278 | |
1279 | sub begin : Private { .. } |
1280 | |
1281 | is called once when |
1282 | |
1283 | http://localhost:3000/bucket/(anything)? |
1284 | |
1285 | is visited. |
1286 | |
1287 | =item end |
1288 | |
c718cfb6 |
1289 | Like begin, this action is always called for the namespace it is in, |
1290 | after every other action has finished. It is commonly used to forward |
1291 | processing to the View component. A single end action is called, its |
1292 | always the one most relevant to the current namespace. |
cb93c9d7 |
1293 | |
1294 | |
1295 | sub end : Private { .. } |
1296 | |
1297 | is called once after any actions when |
1298 | |
1299 | http://localhost:3000/bucket/(anything)? |
1300 | |
1301 | is visited. |
1302 | |
1303 | =item auto |
1304 | |
c718cfb6 |
1305 | Lastly, the auto action is magic in that B<every> auto action in the |
1306 | chain of paths up to and including the ending namespace, will be |
1307 | called. (In contrast, only one of the begin/end/default actions will |
1308 | be called, the relevant one). |
cb93c9d7 |
1309 | |
1310 | package MyApp.pm; |
1311 | sub auto : Private { .. } |
1312 | |
1313 | and |
1314 | |
1315 | sub auto : Private { .. } |
1316 | |
1317 | will both be called when visiting |
1318 | |
1319 | http://localhost:3000/bucket/(anything)? |
1320 | |
1321 | =back |
1322 | |
1323 | =back |
1324 | |
1325 | =head3 A word of warning |
1326 | |
c718cfb6 |
1327 | Due to possible namespace conflicts with Plugins, it is advised to |
1328 | only put the pre-defined Private actions in your main MyApp.pm file, |
1329 | all others should go in a Controller module. |
cb93c9d7 |
1330 | |
1331 | =head3 More Information |
1332 | |
1333 | L<http://search.cpan.org/author/SRI/Catalyst-5.61/lib/Catalyst/Manual/Intro.pod> |
1334 | |
1335 | L<http://dev.catalyst.perl.org/wiki/FlowChart> |
1336 | |
1337 | =head2 Component-based Subrequests |
1338 | |
1339 | See L<Catalyst::Plugin::SubRequest>. |
1340 | |
1341 | =head2 File uploads |
1342 | |
1343 | =head3 Single file upload with Catalyst |
1344 | |
1345 | To implement uploads in Catalyst, you need to have a HTML form similar to |
1346 | this: |
1347 | |
1348 | <form action="/upload" method="post" enctype="multipart/form-data"> |
1349 | <input type="hidden" name="form_submit" value="yes"> |
1350 | <input type="file" name="my_file"> |
1351 | <input type="submit" value="Send"> |
1352 | </form> |
1353 | |
1354 | It's very important not to forget C<enctype="multipart/form-data"> in |
1355 | the form. |
1356 | |
1357 | Catalyst Controller module 'upload' action: |
1358 | |
1359 | sub upload : Global { |
1360 | my ($self, $c) = @_; |
1361 | |
1362 | if ( $c->request->parameters->{form_submit} eq 'yes' ) { |
1363 | |
1364 | if ( my $upload = $c->request->upload('my_file') ) { |
1365 | |
1366 | my $filename = $upload->filename; |
1367 | my $target = "/tmp/upload/$filename"; |
1368 | |
1369 | unless ( $upload->link_to($target) || $upload->copy_to($target) ) { |
1370 | die( "Failed to copy '$filename' to '$target': $!" ); |
1371 | } |
1372 | } |
1373 | } |
1374 | |
1375 | $c->stash->{template} = 'file_upload.html'; |
1376 | } |
1377 | |
1378 | =head3 Multiple file upload with Catalyst |
1379 | |
1380 | Code for uploading multiple files from one form needs a few changes: |
1381 | |
1382 | The form should have this basic structure: |
1383 | |
1384 | <form action="/upload" method="post" enctype="multipart/form-data"> |
1385 | <input type="hidden" name="form_submit" value="yes"> |
1386 | <input type="file" name="file1" size="50"><br> |
1387 | <input type="file" name="file2" size="50"><br> |
1388 | <input type="file" name="file3" size="50"><br> |
1389 | <input type="submit" value="Send"> |
1390 | </form> |
1391 | |
1392 | And in the controller: |
1393 | |
1394 | sub upload : Local { |
1395 | my ($self, $c) = @_; |
1396 | |
1397 | if ( $c->request->parameters->{form_submit} eq 'yes' ) { |
1398 | |
1399 | for my $field ( $c->req->upload ) { |
1400 | |
1401 | my $upload = $c->req->upload($field); |
1402 | my $filename = $upload->filename; |
1403 | my $target = "/tmp/upload/$filename"; |
1404 | |
1405 | unless ( $upload->link_to($target) || $upload->copy_to($target) ) { |
1406 | die( "Failed to copy '$filename' to '$target': $!" ); |
1407 | } |
1408 | } |
1409 | } |
1410 | |
1411 | $c->stash->{template} = 'file_upload.html'; |
1412 | } |
1413 | |
1414 | C<for my $field ($c-E<gt>req->upload)> loops automatically over all file |
1415 | input fields and gets input names. After that is basic file saving code, |
1416 | just like in single file upload. |
1417 | |
1418 | Notice: C<die>ing might not be what you want to do, when an error |
1419 | occurs, but it works as an example. A better idea would be to store |
1420 | error C<$!> in $c->stash->{error} and show a custom error template |
1421 | displaying this message. |
1422 | |
1423 | For more information about uploads and usable methods look at |
1424 | L<Catalyst::Request::Upload> and L<Catalyst::Request>. |
1425 | |
1426 | =head2 Forwarding with arguments |
1427 | |
1428 | Sometimes you want to pass along arguments when forwarding to another |
1429 | action. As of version 5.30, arguments can be passed in the call to |
1430 | C<forward>; in earlier versions, you can manually set the arguments in |
1431 | the Catalyst Request object: |
1432 | |
1433 | # version 5.30 and later: |
1434 | $c->forward('/wherever', [qw/arg1 arg2 arg3/]); |
1435 | |
1436 | # pre-5.30 |
1437 | $c->req->args([qw/arg1 arg2 arg3/]); |
1438 | $c->forward('/wherever'); |
1439 | |
1440 | (See the L<Catalyst::Manual::Intro> Flow_Control section for more |
1441 | information on passing arguments via C<forward>.) |
1442 | |
1443 | |
1444 | =head1 Deployment |
1445 | |
1446 | The recipes below describe aspects of the deployment process, |
1447 | including web server engines and tips to improve application efficiency. |
1448 | |
1449 | =head2 mod_perl Deployment |
1450 | |
1451 | mod_perl is the best solution for many applications, but we'll list some pros |
1452 | and cons so you can decide for yourself. The other production deployment |
1453 | option is FastCGI, for which see below. |
1454 | |
1455 | =head3 Pros |
1456 | |
1457 | =head4 Speed |
1458 | |
1459 | mod_perl is very fast and your app will benefit from being loaded in memory |
1460 | within each Apache process. |
1461 | |
1462 | =head4 Shared memory for multiple apps |
1463 | |
1464 | If you need to run several Catalyst apps on the same server, mod_perl will |
1465 | share the memory for common modules. |
1466 | |
1467 | =head3 Cons |
1468 | |
1469 | =head4 Memory usage |
1470 | |
1471 | Since your application is fully loaded in memory, every Apache process will |
1472 | be rather large. This means a large Apache process will be tied up while |
1473 | serving static files, large files, or dealing with slow clients. For this |
1474 | reason, it is best to run a two-tiered web architecture with a lightweight |
1475 | frontend server passing dynamic requests to a large backend mod_perl |
1476 | server. |
1477 | |
1478 | =head4 Reloading |
1479 | |
1480 | Any changes made to the core code of your app require a full Apache restart. |
1481 | Catalyst does not support Apache::Reload or StatINC. This is another good |
1482 | reason to run a frontend web server where you can set up an |
1483 | C<ErrorDocument 502> page to report that your app is down for maintenance. |
1484 | |
1485 | =head4 Cannot run multiple versions of the same app |
1486 | |
1487 | It is not possible to run two different versions of the same application in |
1488 | the same Apache instance because the namespaces will collide. |
1489 | |
1490 | =head4 Setup |
1491 | |
1492 | Now that we have that out of the way, let's talk about setting up mod_perl |
1493 | to run a Catalyst app. |
1494 | |
1495 | =head4 1. Install Catalyst::Engine::Apache |
1496 | |
1497 | You should install the latest versions of both Catalyst and |
1498 | Catalyst::Engine::Apache. The Apache engines were separated from the |
1499 | Catalyst core in version 5.50 to allow for updates to the engine without |
1500 | requiring a new Catalyst release. |
1501 | |
1502 | =head4 2. Install Apache with mod_perl |
1503 | |
1504 | Both Apache 1.3 and Apache 2 are supported, although Apache 2 is highly |
1505 | recommended. With Apache 2, make sure you are using the prefork MPM and not |
1506 | the worker MPM. The reason for this is that many Perl modules are not |
1507 | thread-safe and may have problems running within the threaded worker |
1508 | environment. Catalyst is thread-safe however, so if you know what you're |
1509 | doing, you may be able to run using worker. |
1510 | |
1511 | In Debian, the following commands should get you going. |
1512 | |
1513 | apt-get install apache2-mpm-prefork |
1514 | apt-get install libapache2-mod-perl2 |
1515 | |
1516 | =head4 3. Configure your application |
1517 | |
1518 | Every Catalyst application will automagically become a mod_perl handler |
1519 | when run within mod_perl. This makes the configuration extremely easy. |
1520 | Here is a basic Apache 2 configuration. |
1521 | |
1522 | PerlSwitches -I/var/www/MyApp/lib |
1523 | PerlModule MyApp |
1524 | |
1525 | <Location /> |
1526 | SetHandler modperl |
1527 | PerlResponseHandler MyApp |
1528 | </Location> |
1529 | |
1530 | The most important line here is C<PerlModule MyApp>. This causes mod_perl |
1531 | to preload your entire application into shared memory, including all of your |
1532 | controller, model, and view classes and configuration. If you have -Debug |
1533 | mode enabled, you will see the startup output scroll by when you first |
1534 | start Apache. |
1535 | |
1536 | For an example Apache 1.3 configuration, please see the documentation for |
1537 | L<Catalyst::Engine::Apache::MP13>. |
1538 | |
1539 | =head3 Test It |
1540 | |
1541 | That's it, your app is now a full-fledged mod_perl application! Try it out |
1542 | by going to http://your.server.com/. |
1543 | |
1544 | =head3 Other Options |
1545 | |
1546 | =head4 Non-root location |
1547 | |
1548 | You may not always want to run your app at the root of your server or virtual |
1549 | host. In this case, it's a simple change to run at any non-root location |
1550 | of your choice. |
1551 | |
1552 | <Location /myapp> |
1553 | SetHandler modperl |
1554 | PerlResponseHandler MyApp |
1555 | </Location> |
1556 | |
1557 | When running this way, it is best to make use of the C<uri_for> method in |
1558 | Catalyst for constructing correct links. |
1559 | |
1560 | =head4 Static file handling |
1561 | |
1562 | Static files can be served directly by Apache for a performance boost. |
1563 | |
1564 | DocumentRoot /var/www/MyApp/root |
1565 | <Location /static> |
1566 | SetHandler default-handler |
1567 | </Location> |
1568 | |
1569 | This will let all files within root/static be handled directly by Apache. In |
1570 | a two-tiered setup, the frontend server should handle static files. |
1571 | The configuration to do this on the frontend will vary. |
1572 | |
3cca8359 |
1573 | The same is accomplished in lighttpd with the following snippet: |
1574 | |
1575 | $HTTP["url"] !~ "^/(?:img/|static/|css/|favicon.ico$)" { |
1576 | fastcgi.server = ( |
1577 | "" => ( |
1578 | "MyApp" => ( |
1579 | "socket" => "/tmp/myapp.socket", |
1580 | "check-local" => "disable", |
1581 | ) |
1582 | ) |
1583 | ) |
1584 | } |
1585 | |
1586 | Which serves everything in the img, static, css directories |
1587 | statically, as well as the favicon file. |
1588 | |
c1c35b01 |
1589 | Note the path of the application needs to be stated explicitly in the |
1590 | web server configuration for both these recipes. |
3cca8359 |
1591 | |
cb93c9d7 |
1592 | =head2 Catalyst on shared hosting |
1593 | |
1594 | So, you want to put your Catalyst app out there for the whole world to |
1595 | see, but you don't want to break the bank. There is an answer - if you |
1596 | can get shared hosting with FastCGI and a shell, you can install your |
1597 | Catalyst app in a local directory on your shared host. First, run |
1598 | |
1599 | perl -MCPAN -e shell |
1600 | |
1601 | and go through the standard CPAN configuration process. Then exit out |
1602 | without installing anything. Next, open your .bashrc and add |
1603 | |
1604 | export PATH=$HOME/local/bin:$HOME/local/script:$PATH |
1605 | perlversion=`perl -v | grep 'built for' | awk '{print $4}' | sed -e 's/v//;'` |
1606 | export PERL5LIB=$HOME/local/share/perl/$perlversion:$HOME/local/lib/perl/$perlversion:$HOME/local/lib:$PERL5LIB |
1607 | |
1608 | and log out, then back in again (or run C<". .bashrc"> if you |
1609 | prefer). Finally, edit C<.cpan/CPAN/MyConfig.pm> and add |
1610 | |
1611 | 'make_install_arg' => qq[SITEPREFIX=$ENV{HOME}/local], |
1612 | 'makepl_arg' => qq[INSTALLDIRS=site install_base=$ENV{HOME}/local], |
1613 | |
1614 | Now you can install the modules you need using CPAN as normal; they |
1615 | will be installed into your local directory, and perl will pick them |
1616 | up. Finally, change directory into the root of your virtual host and |
1617 | symlink your application's script directory in: |
1618 | |
1619 | cd path/to/mydomain.com |
1620 | ln -s ~/lib/MyApp/script script |
1621 | |
1622 | And add the following lines to your .htaccess file (assuming the server |
1623 | is setup to handle .pl as fcgi - you may need to rename the script to |
1624 | myapp_fastcgi.fcgi and/or use a SetHandler directive): |
1625 | |
1626 | RewriteEngine On |
1627 | RewriteCond %{REQUEST_URI} !^/?script/myapp_fastcgi.pl |
1628 | RewriteRule ^(.*)$ script/myapp_fastcgi.pl/$1 [PT,L] |
1629 | |
1630 | Now C<http://mydomain.com/> should now Just Work. Congratulations, now |
1631 | you can tell your friends about your new website (or in our case, tell |
1632 | the client it's time to pay the invoice :) ) |
1633 | |
1634 | =head2 FastCGI Deployment |
1635 | |
1636 | FastCGI is a high-performance extension to CGI. It is suitable |
1637 | for production environments. |
1638 | |
1639 | =head3 Pros |
1640 | |
1641 | =head4 Speed |
1642 | |
1643 | FastCGI performs equally as well as mod_perl. Don't let the 'CGI' fool you; |
1644 | your app runs as multiple persistent processes ready to receive connections |
1645 | from the web server. |
1646 | |
1647 | =head4 App Server |
1648 | |
1649 | When using external FastCGI servers, your application runs as a standalone |
1650 | application server. It may be restarted independently from the web server. |
1651 | This allows for a more robust environment and faster reload times when |
1652 | pushing new app changes. The frontend server can even be configured to |
1653 | display a friendly "down for maintenance" page while the application is |
1654 | restarting. |
1655 | |
1656 | =head4 Load-balancing |
1657 | |
1658 | You can launch your application on multiple backend servers and allow the |
1659 | frontend web server to load-balance between all of them. And of course, if |
1660 | one goes down, your app continues to run fine. |
1661 | |
1662 | =head4 Multiple versions of the same app |
1663 | |
1664 | Each FastCGI application is a separate process, so you can run different |
1665 | versions of the same app on a single server. |
1666 | |
1667 | =head4 Can run with threaded Apache |
1668 | |
1669 | Since your app is not running inside of Apache, the faster mpm_worker module |
1670 | can be used without worrying about the thread safety of your application. |
1671 | |
1672 | =head3 Cons |
1673 | |
1674 | =head4 More complex environment |
1675 | |
1676 | With FastCGI, there are more things to monitor and more processes running |
1677 | than when using mod_perl. |
1678 | |
1679 | =head3 Setup |
1680 | |
1681 | =head4 1. Install Apache with mod_fastcgi |
1682 | |
1683 | mod_fastcgi for Apache is a third party module, and can be found at |
1684 | L<http://www.fastcgi.com/>. It is also packaged in many distributions, |
1685 | for example, libapache2-mod-fastcgi in Debian. |
1686 | |
1687 | =head4 2. Configure your application |
1688 | |
1689 | # Serve static content directly |
1690 | DocumentRoot /var/www/MyApp/root |
1691 | Alias /static /var/www/MyApp/root/static |
1692 | |
1693 | FastCgiServer /var/www/MyApp/script/myapp_fastcgi.pl -processes 3 |
1694 | Alias /myapp/ /var/www/MyApp/script/myapp_fastcgi.pl/ |
1695 | |
1696 | # Or, run at the root |
1697 | Alias / /var/www/MyApp/script/myapp_fastcgi.pl/ |
1698 | |
1699 | The above commands will launch 3 app processes and make the app available at |
1700 | /myapp/ |
1701 | |
1702 | =head3 Standalone server mode |
1703 | |
1704 | While not as easy as the previous method, running your app as an external |
1705 | server gives you much more flexibility. |
1706 | |
1707 | First, launch your app as a standalone server listening on a socket. |
1708 | |
1709 | script/myapp_fastcgi.pl -l /tmp/myapp.socket -n 5 -p /tmp/myapp.pid -d |
1710 | |
1711 | You can also listen on a TCP port if your web server is not on the same |
1712 | machine. |
1713 | |
1714 | script/myapp_fastcgi.pl -l :8080 -n 5 -p /tmp/myapp.pid -d |
1715 | |
1716 | You will probably want to write an init script to handle starting/stopping |
1717 | of the app using the pid file. |
1718 | |
1719 | Now, we simply configure Apache to connect to the running server. |
1720 | |
1721 | # 502 is a Bad Gateway error, and will occur if the backend server is down |
1722 | # This allows us to display a friendly static page that says "down for |
1723 | # maintenance" |
1724 | Alias /_errors /var/www/MyApp/root/error-pages |
1725 | ErrorDocument 502 /_errors/502.html |
1726 | |
31bdf270 |
1727 | FastCgiExternalServer /tmp/myapp.fcgi -socket /tmp/myapp.socket |
1728 | Alias /myapp/ /tmp/myapp.fcgi/ |
cb93c9d7 |
1729 | |
1730 | # Or, run at the root |
31bdf270 |
1731 | Alias / /tmp/myapp.fcgi/ |
cb93c9d7 |
1732 | |
1733 | =head3 More Info |
1734 | |
1735 | L<Catalyst::Engine::FastCGI>. |
1736 | |
1737 | =head2 Development server deployment |
1738 | |
1739 | The development server is a mini web server written in perl. If you |
1740 | expect a low number of hits or you don't need mod_perl/FastCGI speed, |
1741 | you could use the development server as the application server with a |
ad2a47ab |
1742 | lightweight proxy web server at the front. However, consider using |
1743 | L<Catalyst::Engine::HTTP::POE> for this kind of deployment instead, since |
1744 | it can better handle multiple concurrent requests without forking, or can |
1745 | prefork a set number of servers for improved performance. |
cb93c9d7 |
1746 | |
1747 | =head3 Pros |
1748 | |
1749 | As this is an application server setup, the pros are the same as |
1750 | FastCGI (with the exception of speed). |
1751 | It is also: |
1752 | |
1753 | =head4 Simple |
1754 | |
1755 | The development server is what you create your code on, so if it works |
1756 | here, it should work in production! |
1757 | |
1758 | =head3 Cons |
1759 | |
1760 | =head4 Speed |
1761 | |
1762 | Not as fast as mod_perl or FastCGI. Needs to fork for each request |
1763 | that comes in - make sure static files are served by the web server to |
1764 | save forking. |
1765 | |
1766 | =head3 Setup |
1767 | |
1768 | =head4 Start up the development server |
1769 | |
ad2a47ab |
1770 | script/myapp_server.pl -p 8080 -k -f -pidfile=/tmp/myapp.pid |
cb93c9d7 |
1771 | |
1772 | You will probably want to write an init script to handle stop/starting |
1773 | the app using the pid file. |
1774 | |
1775 | =head4 Configuring Apache |
1776 | |
1777 | Make sure mod_proxy is enabled and add: |
1778 | |
1779 | # Serve static content directly |
1780 | DocumentRoot /var/www/MyApp/root |
1781 | Alias /static /var/www/MyApp/root/static |
1782 | |
1783 | ProxyRequests Off |
1784 | <Proxy *> |
1785 | Order deny,allow |
1786 | Allow from all |
1787 | </Proxy> |
1788 | ProxyPass / http://localhost:8080/ |
1789 | ProxyPassReverse / http://localhost:8080/ |
1790 | |
1791 | You can wrap the above within a VirtualHost container if you want |
1792 | different apps served on the same host. |
1793 | |
1794 | =head2 Quick deployment: Building PAR Packages |
1795 | |
1796 | You have an application running on your development box, but then you |
1797 | have to quickly move it to another one for |
1798 | demonstration/deployment/testing... |
1799 | |
1800 | PAR packages can save you from a lot of trouble here. They are usual Zip |
1801 | files that contain a blib tree; you can even include all prereqs and a |
1802 | perl interpreter by setting a few flags! |
1803 | |
1804 | =head3 Follow these few points to try it out! |
1805 | |
1806 | 1. Install Catalyst and PAR 0.89 (or later) |
1807 | |
1808 | % perl -MCPAN -e 'install Catalyst' |
1809 | ... |
1810 | % perl -MCPAN -e 'install PAR' |
1811 | ... |
1812 | |
1813 | 2. Create a application |
1814 | |
1815 | % catalyst.pl MyApp |
1816 | ... |
1817 | % cd MyApp |
1818 | |
1819 | Recent versions of Catalyst (5.62 and up) include |
1820 | L<Module::Install::Catalyst>, which simplifies the process greatly. From the shell in your application directory: |
1821 | |
1822 | % perl Makefile.PL |
1823 | % make catalyst_par |
1824 | |
1825 | Congratulations! Your package "myapp.par" is ready, the following |
1826 | steps are just optional. |
1827 | |
1828 | 3. Test your PAR package with "parl" (no typo) |
1829 | |
1830 | % parl myapp.par |
1831 | Usage: |
1832 | [parl] myapp[.par] [script] [arguments] |
1833 | |
1834 | Examples: |
1835 | parl myapp.par myapp_server.pl -r |
1836 | myapp myapp_cgi.pl |
1837 | |
1838 | Available scripts: |
1839 | myapp_cgi.pl |
1840 | myapp_create.pl |
1841 | myapp_fastcgi.pl |
1842 | myapp_server.pl |
1843 | myapp_test.pl |
1844 | |
1845 | % parl myapp.par myapp_server.pl |
1846 | You can connect to your server at http://localhost:3000 |
1847 | |
1848 | Yes, this nifty little starter application gets automatically included. |
1849 | You can also use "catalyst_par_script('myapp_server.pl')" to set a |
1850 | default script to execute. |
1851 | |
1852 | 6. Want to create a binary that includes the Perl interpreter? |
1853 | |
1854 | % pp -o myapp myapp.par |
1855 | % ./myapp myapp_server.pl |
1856 | You can connect to your server at http://localhost:3000 |
1857 | |
1858 | =head2 Serving static content |
1859 | |
1860 | Serving static content in Catalyst used to be somewhat tricky; the use |
1861 | of L<Catalyst::Plugin::Static::Simple> makes everything much easier. |
1862 | This plugin will automatically serve your static content during development, |
1863 | but allows you to easily switch to Apache (or other server) in a |
1864 | production environment. |
1865 | |
1866 | =head3 Introduction to Static::Simple |
1867 | |
1868 | Static::Simple is a plugin that will help to serve static content for your |
1869 | application. By default, it will serve most types of files, excluding some |
1870 | standard Template Toolkit extensions, out of your B<root> file directory. All |
1871 | files are served by path, so if B<images/me.jpg> is requested, then |
1872 | B<root/images/me.jpg> is found and served. |
1873 | |
1874 | =head3 Usage |
1875 | |
1876 | Using the plugin is as simple as setting your use line in MyApp.pm to include: |
1877 | |
1878 | use Catalyst qw/Static::Simple/; |
1879 | |
1880 | and already files will be served. |
1881 | |
1882 | =head3 Configuring |
1883 | |
1884 | Static content is best served from a single directory within your root |
1885 | directory. Having many different directories such as C<root/css> and |
1886 | C<root/images> requires more code to manage, because you must separately |
1887 | identify each static directory--if you decide to add a C<root/js> |
1888 | directory, you'll need to change your code to account for it. In |
1889 | contrast, keeping all static directories as subdirectories of a main |
1890 | C<root/static> directory makes things much easier to manage. Here's an |
1891 | example of a typical root directory structure: |
1892 | |
1893 | root/ |
1894 | root/content.tt |
1895 | root/controller/stuff.tt |
1896 | root/header.tt |
1897 | root/static/ |
1898 | root/static/css/main.css |
1899 | root/static/images/logo.jpg |
1900 | root/static/js/code.js |
1901 | |
1902 | |
1903 | All static content lives under C<root/static>, with everything else being |
1904 | Template Toolkit files. |
1905 | |
1906 | =over 4 |
1907 | |
1908 | =item Include Path |
1909 | |
1910 | You may of course want to change the default locations, and make |
1911 | Static::Simple look somewhere else, this is as easy as: |
1912 | |
1913 | MyApp->config->{static}->{include_path} = [ |
1914 | MyApp->config->{root}, |
1915 | '/path/to/my/files' |
1916 | ]; |
1917 | |
1918 | When you override include_path, it will not automatically append the |
1919 | normal root path, so you need to add it yourself if you still want |
1920 | it. These will be searched in order given, and the first matching file |
1921 | served. |
1922 | |
1923 | =item Static directories |
1924 | |
1925 | If you want to force some directories to be only static, you can set |
1926 | them using paths relative to the root dir, or regular expressions: |
1927 | |
1928 | MyApp->config->{static}->{dirs} = [ |
1929 | 'static', |
1930 | qr/^(images|css)/, |
1931 | ]; |
1932 | |
1933 | =item File extensions |
1934 | |
1935 | By default, the following extensions are not served (that is, they will |
1936 | be processed by Catalyst): B<tmpl, tt, tt2, html, xhtml>. This list can |
1937 | be replaced easily: |
1938 | |
1939 | MyApp->config->{static}->{ignore_extensions} = [ |
1940 | qw/tmpl tt tt2 html xhtml/ |
1941 | ]; |
1942 | |
1943 | =item Ignoring directories |
1944 | |
1945 | Entire directories can be ignored. If used with include_path, |
1946 | directories relative to the include_path dirs will also be ignored: |
1947 | |
1948 | MyApp->config->{static}->{ignore_dirs} = [ qw/tmpl css/ ]; |
1949 | |
1950 | =back |
1951 | |
1952 | =head3 More information |
1953 | |
1954 | L<http://search.cpan.org/dist/Catalyst-Plugin-Static-Simple/> |
1955 | |
1956 | =head3 Serving manually with the Static plugin with HTTP::Daemon (myapp_server.pl) |
1957 | |
1958 | In some situations you might want to control things more directly, |
1959 | using L<Catalyst::Plugin::Static>. |
1960 | |
1961 | In your main application class (MyApp.pm), load the plugin: |
1962 | |
1963 | use Catalyst qw/-Debug FormValidator Static OtherPlugin/; |
1964 | |
1965 | You will also need to make sure your end method does I<not> forward |
1966 | static content to the view, perhaps like this: |
1967 | |
1968 | sub end : Private { |
1969 | my ( $self, $c ) = @_; |
1970 | |
1971 | $c->forward( 'MyApp::View::TT' ) |
1972 | unless ( $c->res->body || !$c->stash->{template} ); |
1973 | } |
1974 | |
1975 | This code will only forward to the view if a template has been |
1976 | previously defined by a controller and if there is not already data in |
1977 | C<$c-E<gt>res-E<gt>body>. |
1978 | |
1979 | Next, create a controller to handle requests for the /static path. Use |
1980 | the Helper to save time. This command will create a stub controller as |
1981 | C<lib/MyApp/Controller/Static.pm>. |
1982 | |
1983 | $ script/myapp_create.pl controller Static |
1984 | |
1985 | Edit the file and add the following methods: |
1986 | |
1987 | # serve all files under /static as static files |
1988 | sub default : Path('/static') { |
1989 | my ( $self, $c ) = @_; |
1990 | |
1991 | # Optional, allow the browser to cache the content |
1992 | $c->res->headers->header( 'Cache-Control' => 'max-age=86400' ); |
1993 | |
1994 | $c->serve_static; # from Catalyst::Plugin::Static |
1995 | } |
1996 | |
1997 | # also handle requests for /favicon.ico |
1998 | sub favicon : Path('/favicon.ico') { |
1999 | my ( $self, $c ) = @_; |
2000 | |
2001 | $c->serve_static; |
2002 | } |
2003 | |
2004 | You can also define a different icon for the browser to use instead of |
2005 | favicon.ico by using this in your HTML header: |
2006 | |
2007 | <link rel="icon" href="/static/myapp.ico" type="image/x-icon" /> |
2008 | |
2009 | =head3 Common problems with the Static plugin |
2010 | |
2011 | The Static plugin makes use of the C<shared-mime-info> package to |
2012 | automatically determine MIME types. This package is notoriously |
2013 | difficult to install, especially on win32 and OS X. For OS X the easiest |
2014 | path might be to install Fink, then use C<apt-get install |
2015 | shared-mime-info>. Restart the server, and everything should be fine. |
2016 | |
2017 | Make sure you are using the latest version (>= 0.16) for best |
2018 | results. If you are having errors serving CSS files, or if they get |
2019 | served as text/plain instead of text/css, you may have an outdated |
2020 | shared-mime-info version. You may also wish to simply use the following |
2021 | code in your Static controller: |
2022 | |
2023 | if ($c->req->path =~ /css$/i) { |
2024 | $c->serve_static( "text/css" ); |
2025 | } else { |
2026 | $c->serve_static; |
2027 | } |
2028 | |
2029 | =head3 Serving Static Files with Apache |
2030 | |
2031 | When using Apache, you can bypass Catalyst and any Static |
2032 | plugins/controllers controller by intercepting requests for the |
2033 | C<root/static> path at the server level. All that is required is to |
2034 | define a DocumentRoot and add a separate Location block for your static |
2035 | content. Here is a complete config for this application under mod_perl |
2036 | 1.x: |
2037 | |
2038 | <Perl> |
2039 | use lib qw(/var/www/MyApp/lib); |
2040 | </Perl> |
2041 | PerlModule MyApp |
2042 | |
2043 | <VirtualHost *> |
2044 | ServerName myapp.example.com |
2045 | DocumentRoot /var/www/MyApp/root |
2046 | <Location /> |
2047 | SetHandler perl-script |
2048 | PerlHandler MyApp |
2049 | </Location> |
2050 | <LocationMatch "/(static|favicon.ico)"> |
2051 | SetHandler default-handler |
2052 | </LocationMatch> |
2053 | </VirtualHost> |
2054 | |
2055 | And here's a simpler example that'll get you started: |
2056 | |
2057 | Alias /static/ "/my/static/files/" |
2058 | <Location "/static"> |
2059 | SetHandler none |
2060 | </Location> |
2061 | |
2062 | =head2 Caching |
2063 | |
2064 | Catalyst makes it easy to employ several different types of caching to |
2065 | speed up your applications. |
2066 | |
2067 | =head3 Cache Plugins |
2068 | |
2069 | There are three wrapper plugins around common CPAN cache modules: |
2070 | Cache::FastMmap, Cache::FileCache, and Cache::Memcached. These can be |
2071 | used to cache the result of slow operations. |
2072 | |
2073 | This very page you're viewing makes use of the FileCache plugin to cache the |
2074 | rendered XHTML version of the source POD document. This is an ideal |
2075 | application for a cache because the source document changes infrequently but |
2076 | may be viewed many times. |
2077 | |
2078 | use Catalyst qw/Cache::FileCache/; |
2079 | |
2080 | ... |
2081 | |
2082 | use File::stat; |
2083 | sub render_pod : Local { |
2084 | my ( self, $c ) = @_; |
2085 | |
2086 | # the cache is keyed on the filename and the modification time |
2087 | # to check for updates to the file. |
2088 | my $file = $c->path_to( 'root', '2005', '11.pod' ); |
2089 | my $mtime = ( stat $file )->mtime; |
2090 | |
2091 | my $cached_pod = $c->cache->get("$file $mtime"); |
2092 | if ( !$cached_pod ) { |
2093 | $cached_pod = do_slow_pod_rendering(); |
2094 | # cache the result for 12 hours |
2095 | $c->cache->set( "$file $mtime", $cached_pod, '12h' ); |
2096 | } |
2097 | $c->stash->{pod} = $cached_pod; |
2098 | } |
2099 | |
2100 | We could actually cache the result forever, but using a value such as 12 hours |
2101 | allows old entries to be automatically expired when they are no longer needed. |
2102 | |
2103 | =head3 Page Caching |
2104 | |
2105 | Another method of caching is to cache the entire HTML page. While this is |
2106 | traditionally handled by a front-end proxy server like Squid, the Catalyst |
2107 | PageCache plugin makes it trivial to cache the entire output from |
2108 | frequently-used or slow actions. |
2109 | |
2110 | Many sites have a busy content-filled front page that might look something |
2111 | like this. It probably takes a while to process, and will do the exact same |
2112 | thing for every single user who views the page. |
2113 | |
2114 | sub front_page : Path('/') { |
2115 | my ( $self, $c ) = @_; |
2116 | |
2117 | $c->forward( 'get_news_articles' ); |
2118 | $c->forward( 'build_lots_of_boxes' ); |
2119 | $c->forward( 'more_slow_stuff' ); |
2120 | |
2121 | $c->stash->{template} = 'index.tt'; |
2122 | } |
2123 | |
2124 | We can add the PageCache plugin to speed things up. |
2125 | |
2126 | use Catalyst qw/Cache::FileCache PageCache/; |
2127 | |
2128 | sub front_page : Path ('/') { |
2129 | my ( $self, $c ) = @_; |
2130 | |
2131 | $c->cache_page( 300 ); |
2132 | |
2133 | # same processing as above |
2134 | } |
2135 | |
2136 | Now the entire output of the front page, from <html> to </html>, will be |
2137 | cached for 5 minutes. After 5 minutes, the next request will rebuild the |
2138 | page and it will be re-cached. |
2139 | |
2140 | Note that the page cache is keyed on the page URI plus all parameters, so |
2141 | requests for / and /?foo=bar will result in different cache items. Also, |
2142 | only GET requests will be cached by the plugin. |
2143 | |
2144 | You can even get that front-end Squid proxy to help out by enabling HTTP |
2145 | headers for the cached page. |
2146 | |
2147 | MyApp->config->{page_cache}->{set_http_headers} = 1; |
2148 | |
2149 | This would now set the following headers so proxies and browsers may cache |
2150 | the content themselves. |
2151 | |
2152 | Cache-Control: max-age=($expire_time - time) |
2153 | Expires: $expire_time |
2154 | Last-Modified: $cache_created_time |
2155 | |
2156 | =head3 Template Caching |
2157 | |
2158 | Template Toolkit provides support for caching compiled versions of your |
2159 | templates. To enable this in Catalyst, use the following configuration. |
2160 | TT will cache compiled templates keyed on the file mtime, so changes will |
2161 | still be automatically detected. |
2162 | |
2163 | package MyApp::View::TT; |
2164 | |
2165 | use strict; |
2166 | use warnings; |
2167 | use base 'Catalyst::View::TT'; |
2168 | |
2169 | __PACKAGE__->config( |
2170 | COMPILE_DIR => '/tmp/template_cache', |
2171 | ); |
2172 | |
2173 | 1; |
2174 | |
2175 | =head3 More Info |
2176 | |
2177 | See the documentation for each cache plugin for more details and other |
2178 | available configuration options. |
2179 | |
2180 | L<Catalyst::Plugin::Cache::FastMmap> |
2181 | L<Catalyst::Plugin::Cache::FileCache> |
2182 | L<Catalyst::Plugin::Cache::Memcached> |
2183 | L<Catalyst::Plugin::PageCache> |
2184 | L<http://search.cpan.org/dist/Template-Toolkit/lib/Template/Manual/Config.pod#Caching_and_Compiling_Options> |
2185 | |
2186 | =head1 Testing |
2187 | |
2188 | Testing is an integral part of the web application development |
2189 | process. Tests make multi developer teams easier to coordinate, and |
2190 | they help ensure that there are no nasty surprises after upgrades or |
2191 | alterations. |
2192 | |
2193 | =head2 Testing |
2194 | |
2195 | Catalyst provides a convenient way of testing your application during |
2196 | development and before deployment in a real environment. |
2197 | |
2198 | C<Catalyst::Test> makes it possible to run the same tests both locally |
2199 | (without an external daemon) and against a remote server via HTTP. |
2200 | |
2201 | =head3 Tests |
2202 | |
2203 | Let's examine a skeleton application's C<t/> directory: |
2204 | |
2205 | mundus:~/MyApp chansen$ ls -l t/ |
2206 | total 24 |
2207 | -rw-r--r-- 1 chansen chansen 95 18 Dec 20:50 01app.t |
2208 | -rw-r--r-- 1 chansen chansen 190 18 Dec 20:50 02pod.t |
2209 | -rw-r--r-- 1 chansen chansen 213 18 Dec 20:50 03podcoverage.t |
2210 | |
2211 | =over 4 |
2212 | |
2213 | =item C<01app.t> |
2214 | |
2215 | Verifies that the application loads, compiles, and returns a successful |
2216 | response. |
2217 | |
2218 | =item C<02pod.t> |
2219 | |
2220 | Verifies that all POD is free from errors. Only executed if the C<TEST_POD> |
2221 | environment variable is true. |
2222 | |
2223 | =item C<03podcoverage.t> |
2224 | |
2225 | Verifies that all methods/functions have POD coverage. Only executed if the |
2226 | C<TEST_POD> environment variable is true. |
2227 | |
2228 | =back |
2229 | |
2230 | =head3 Creating tests |
2231 | |
2232 | mundus:~/MyApp chansen$ cat t/01app.t | perl -ne 'printf( "%2d %s", $., $_ )' |
2233 | 1 use Test::More tests => 2; |
2234 | 2 use_ok( Catalyst::Test, 'MyApp' ); |
2235 | 3 |
2236 | 4 ok( request('/')->is_success ); |
2237 | |
2238 | The first line declares how many tests we are going to run, in this case |
2239 | two. The second line tests and loads our application in test mode. The |
2240 | fourth line verifies that our application returns a successful response. |
2241 | |
2242 | C<Catalyst::Test> exports two functions, C<request> and C<get>. Each can |
2243 | take three different arguments: |
2244 | |
2245 | =over 4 |
2246 | |
2247 | =item A string which is a relative or absolute URI. |
2248 | |
2249 | request('/my/path'); |
2250 | request('http://www.host.com/my/path'); |
2251 | |
2252 | =item An instance of C<URI>. |
2253 | |
2254 | request( URI->new('http://www.host.com/my/path') ); |
2255 | |
2256 | =item An instance of C<HTTP::Request>. |
2257 | |
2258 | request( HTTP::Request->new( GET => 'http://www.host.com/my/path') ); |
2259 | |
2260 | =back |
2261 | |
2262 | C<request> returns an instance of C<HTTP::Response> and C<get> returns the |
2263 | content (body) of the response. |
2264 | |
2265 | =head3 Running tests locally |
2266 | |
2267 | mundus:~/MyApp chansen$ CATALYST_DEBUG=0 TEST_POD=1 prove --lib lib/ t/ |
2268 | t/01app............ok |
2269 | t/02pod............ok |
2270 | t/03podcoverage....ok |
2271 | All tests successful. |
2272 | Files=3, Tests=4, 2 wallclock secs ( 1.60 cusr + 0.36 csys = 1.96 CPU) |
2273 | |
2274 | C<CATALYST_DEBUG=0> ensures that debugging is off; if it's enabled you |
2275 | will see debug logs between tests. |
2276 | |
2277 | C<TEST_POD=1> enables POD checking and coverage. |
2278 | |
2279 | C<prove> A command-line tool that makes it easy to run tests. You can |
2280 | find out more about it from the links below. |
2281 | |
2282 | =head3 Running tests remotely |
2283 | |
2284 | mundus:~/MyApp chansen$ CATALYST_SERVER=http://localhost:3000/ prove --lib lib/ t/01app.t |
2285 | t/01app....ok |
2286 | All tests successful. |
2287 | Files=1, Tests=2, 0 wallclock secs ( 0.40 cusr + 0.01 csys = 0.41 CPU) |
2288 | |
2289 | C<CATALYST_SERVER=http://localhost:3000/> is the absolute deployment URI of |
2290 | your application. In C<CGI> or C<FastCGI> it should be the host and path |
2291 | to the script. |
2292 | |
2293 | =head3 C<Test::WWW::Mechanize> and Catalyst |
2294 | |
2295 | Be sure to check out C<Test::WWW::Mechanize::Catalyst>. It makes it easy to |
2296 | test HTML, forms and links. A short example of usage: |
2297 | |
2298 | use Test::More tests => 6; |
2299 | use_ok( Test::WWW::Mechanize::Catalyst, 'MyApp' ); |
2300 | |
2301 | my $mech = Test::WWW::Mechanize::Catalyst->new; |
2302 | $mech->get_ok("http://localhost/", 'Got index page'); |
2303 | $mech->title_like( qr/^MyApp on Catalyst/, 'Got right index title' ); |
2304 | ok( $mech->find_link( text_regex => qr/^Wiki/i ), 'Found link to Wiki' ); |
2305 | ok( $mech->find_link( text_regex => qr/^Mailing-List/i ), 'Found link to Mailing-List' ); |
2306 | ok( $mech->find_link( text_regex => qr/^IRC channel/i ), 'Found link to IRC channel' ); |
2307 | |
2308 | =head3 Further Reading |
2309 | |
2310 | =over 4 |
2311 | |
2312 | =item Catalyst::Test |
2313 | |
2314 | L<http://search.cpan.org/dist/Catalyst/lib/Catalyst/Test.pm> |
2315 | |
2316 | =item Test::WWW::Mechanize::Catalyst |
2317 | |
2318 | L<http://search.cpan.org/dist/Test-WWW-Mechanize-Catalyst/lib/Test/WWW/Mechanize/Catalyst.pm> |
2319 | |
2320 | =item Test::WWW::Mechanize |
2321 | |
2322 | L<http://search.cpan.org/dist/Test-WWW-Mechanize/Mechanize.pm> |
2323 | |
2324 | =item WWW::Mechanize |
2325 | |
2326 | L<http://search.cpan.org/dist/WWW-Mechanize/lib/WWW/Mechanize.pm> |
2327 | |
2328 | =item LWP::UserAgent |
2329 | |
2330 | L<http://search.cpan.org/dist/libwww-perl/lib/LWP/UserAgent.pm> |
2331 | |
2332 | =item HTML::Form |
2333 | |
2334 | L<http://search.cpan.org/dist/libwww-perl/lib/HTML/Form.pm> |
2335 | |
2336 | =item HTTP::Message |
2337 | |
2338 | L<http://search.cpan.org/dist/libwww-perl/lib/HTTP/Message.pm> |
2339 | |
2340 | =item HTTP::Request |
2341 | |
2342 | L<http://search.cpan.org/dist/libwww-perl/lib/HTTP/Request.pm> |
2343 | |
2344 | =item HTTP::Request::Common |
2345 | |
2346 | L<http://search.cpan.org/dist/libwww-perl/lib/HTTP/Request/Common.pm> |
2347 | |
2348 | =item HTTP::Response |
2349 | |
2350 | L<http://search.cpan.org/dist/libwww-perl/lib/HTTP/Response.pm> |
2351 | |
2352 | =item HTTP::Status |
2353 | |
2354 | L<http://search.cpan.org/dist/libwww-perl/lib/HTTP/Status.pm> |
2355 | |
2356 | =item URI |
2357 | |
2358 | L<http://search.cpan.org/dist/URI/URI.pm> |
2359 | |
2360 | =item Test::More |
2361 | |
2362 | L<http://search.cpan.org/dist/Test-Simple/lib/Test/More.pm> |
2363 | |
2364 | =item Test::Pod |
2365 | |
2366 | L<http://search.cpan.org/dist/Test-Pod/Pod.pm> |
2367 | |
2368 | =item Test::Pod::Coverage |
2369 | |
2370 | L<http://search.cpan.org/dist/Test-Pod-Coverage/Coverage.pm> |
2371 | |
2372 | =item prove (Test::Harness) |
2373 | |
2374 | L<http://search.cpan.org/dist/Test-Harness/bin/prove> |
2375 | |
2376 | =back |
2377 | |
2378 | =head3 More Information |
2379 | |
2380 | L<http://search.cpan.org/perldoc?Catalyst::Plugin::Authorization::Roles> |
2381 | L<http://search.cpan.org/perldoc?Catalyst::Plugin::Authorization::ACL> |
2382 | |
2383 | =head1 AUTHORS |
2384 | |
2385 | Sebastian Riedel C<sri@oook.de> |
2386 | |
2387 | Danijel Milicevic C<me@danijel.de> |
2388 | |
2389 | Viljo Marrandi C<vilts@yahoo.com> |
2390 | |
2391 | Marcus Ramberg C<mramberg@cpan.org> |
2392 | |
2393 | Jesse Sheidlower C<jester@panix.com> |
2394 | |
2395 | Andy Grundman C<andy@hybridized.org> |
2396 | |
2397 | Chisel Wright C<pause@herlpacker.co.uk> |
2398 | |
2399 | Will Hawes C<info@whawes.co.uk> |
2400 | |
2401 | Gavin Henry C<ghenry@perl.me.uk> |
2402 | |
2403 | Kieren Diment C<kd@totaldatasolution.com> |
2404 | |
2405 | =head1 COPYRIGHT |
2406 | |
2407 | This document is free, you can redistribute it and/or modify it |
2408 | under the same terms as Perl itself. |
2409 | |