3 Catalyst::Manual::Tutorial::Authentication - Catalyst Tutorial - Part 5: Authentication
8 This is B<Part 5 of 10> for the Catalyst tutorial.
10 L<Tutorial Overview|Catalyst::Manual::Tutorial>
16 L<Introduction|Catalyst::Manual::Tutorial::Intro>
20 L<Catalyst Basics|Catalyst::Manual::Tutorial::CatalystBasics>
24 L<More Catalyst Basics|Catalyst::Manual::Tutorial::MoreCatalystBasics>
28 L<Basic CRUD|Catalyst::Manual::Tutorial::BasicCRUD>
36 L<Authorization|Catalyst::Manual::Tutorial::Authorization>
40 L<Debugging|Catalyst::Manual::Tutorial::Debugging>
44 L<Testing|Catalyst::Manual::Tutorial::Testing>
48 L<Advanced CRUD|Catalyst::Manual::Tutorial::AdvancedCRUD>
52 L<Appendices|Catalyst::Manual::Tutorial::Appendices>
59 Now that we finally have a simple yet functional application, we can
60 focus on providing authentication (with authorization coming next in
63 This part of the tutorial is divided into two main sections: 1) basic,
64 cleartext authentication and 2) hash-based authentication.
66 You can checkout the source code for this example from the catalyst
67 subversion repository as per the instructions in
68 L<Catalyst::Manual::Tutorial::Intro>
70 =head1 BASIC AUTHENTICATION
72 This section explores how to add authentication logic to a Catalyst
76 =head2 Add Users and Roles to the Database
78 First, we add both user and role information to the database (we will
79 add the role information here although it will not be used until the
80 authorization section, Part 5). Create a new SQL script file by opening
81 C<myapp02.sql> in your editor and insert:
84 -- Add users and roles tables, along with a many-to-many join table
87 id INTEGER PRIMARY KEY,
96 id INTEGER PRIMARY KEY,
99 CREATE TABLE user_roles (
102 PRIMARY KEY (user_id, role_id)
105 -- Load up some initial test data
107 INSERT INTO users VALUES (1, 'test01', 'mypass', 't01@na.com', 'Joe', 'Blow', 1);
108 INSERT INTO users VALUES (2, 'test02', 'mypass', 't02@na.com', 'Jane', 'Doe', 1);
109 INSERT INTO users VALUES (3, 'test03', 'mypass', 't03@na.com', 'No', 'Go', 0);
110 INSERT INTO roles VALUES (1, 'user');
111 INSERT INTO roles VALUES (2, 'admin');
112 INSERT INTO user_roles VALUES (1, 1);
113 INSERT INTO user_roles VALUES (1, 2);
114 INSERT INTO user_roles VALUES (2, 1);
115 INSERT INTO user_roles VALUES (3, 1);
117 Then load this into the C<myapp.db> database with the following command:
119 $ sqlite3 myapp.db < myapp02.sql
122 =head2 Add User and Role Information to DBIC Schema
124 Although we could manually edit the DBIC schema information to include
125 the new tables added in the previous step, let's use the C<create=static>
126 option on the DBIC model helper to do most of the work for us:
128 $ script/myapp_create.pl model DB DBIC::Schema MyApp::Schema create=static dbi:SQLite:myapp.db
129 $ ls lib/MyApp/Schema
130 Authors.pm BookAuthors.pm Books.pm Roles.pm UserRoles.pm Users.pm
132 Notice how the helper has added three new table-specific result source
133 files to the C<lib/MyApp/Schema/MyApp> directory. And, more
134 importantly, even if there were changes to the existing result source
135 files, those changes would have only been written above the C<# DO NOT
136 MODIFY THIS OR ANYTHING ABOVE!> comment and your hand-editted
137 enhancements would have been preserved.
140 Speaking of "hand-editted enhancements," we should now add
141 relationship information to the three new result source files. Edit
142 each of these files and add the following information between the C<#
143 DO NOT MODIFY THIS OR ANYTHING ABOVE!> comment and the closing C<1;>:
145 C<lib/MyApp/Schema/Users.pm>:
153 # 1) Name of relationship, DBIC will create accessor with this name
154 # 2) Name of the model class referenced by this relationship
155 # 3) Column name in *foreign* table
156 __PACKAGE__->has_many(map_user_role => 'MyApp::Schema::UserRoles', 'user_id');
160 # 1) Name of relationship, DBIC will create accessor with this name
161 # 2) Name of has_many() relationship this many_to_many() is shortcut for
162 # 3) Name of belongs_to() relationship in model class of has_many() above
163 # You must already have the has_many() defined to use a many_to_many().
164 __PACKAGE__->many_to_many(roles => 'map_user_role', 'role');
167 C<lib/MyApp/Schema/Roles.pm>:
175 # 1) Name of relationship, DBIC will create accessor with this name
176 # 2) Name of the model class referenced by this relationship
177 # 3) Column name in *foreign* table
178 __PACKAGE__->has_many(map_user_role => 'MyApp::Schema::UserRoles', 'role_id');
181 C<lib/MyApp/Schema/UserRoles.pm>:
189 # 1) Name of relationship, DBIC will create accessor with this name
190 # 2) Name of the model class referenced by this relationship
191 # 3) Column name in *this* table
192 __PACKAGE__->belongs_to(user => 'MyApp::Schema::Users', 'user_id');
196 # 1) Name of relationship, DBIC will create accessor with this name
197 # 2) Name of the model class referenced by this relationship
198 # 3) Column name in *this* table
199 __PACKAGE__->belongs_to(role => 'MyApp::Schema::Roles', 'role_id');
202 The code for these three sets of updates is obviously very similar to
203 the edits we made to the C<Books>, C<Authors>, and C<BookAuthors>
204 classes created in Part 3.
206 Note that we do not need to make any change to the
207 C<lib/MyApp/Schema.pm> schema file. It simple tells DBIC to
208 load all of the result source files it finds in below the
209 C<lib/MyApp/Schema> directory, so it will automatically pick
210 up our new table information.
213 =head2 Sanity-Check Reload of Development Server
215 We aren't ready to try out the authentication just yet; we only want
216 to do a quick check to be sure our model loads correctly. Press
217 C<Ctrl-C> to kill the previous server instance (if it's still running)
220 $ script/myapp_server.pl
222 Look for the three new model objects in the startup debug output:
225 .-------------------------------------------------------------------+----------.
227 +-------------------------------------------------------------------+----------+
228 | MyApp::Controller::Books | instance |
229 | MyApp::Controller::Root | instance |
230 | MyApp::Model::DB | instance |
231 | MyApp::Model::DB::Author | class |
232 | MyApp::Model::DB::Books | class |
233 | MyApp::Model::DB::BookAuthors | class |
234 | MyApp::Model::DB::Roles | class |
235 | MyApp::Model::DB::Users | class |
236 | MyApp::Model::DB::UserRoles | class |
237 | MyApp::View::TT | instance |
238 '-------------------------------------------------------------------+----------'
241 Again, notice that your "result source" classes have been "re-loaded"
242 by Catalyst under C<MyApp::Model>.
245 =head2 Include Authentication and Session Plugins
247 Edit C<lib/MyApp.pm> and update it as follows (everything below
248 C<StackTrace> is new):
260 Session::Store::FastMmap
261 Session::State::Cookie
264 The C<Authentication> plugin supports Authentication while the
265 C<Session> plugins are required to maintain state across multiple HTTP
268 Note that the only required Authentication class is the main one. This
269 is a change that occurred in version 0.09999_01 of the
270 C<Authentication> plugin. You B<do not need> to specify a particular
271 Authentication::Store or Authentication::Credential plugin. Instead,
272 indicate the Store and Credential you want to use in your application
273 configuration (see below).
275 Note that there are several options for
276 L<Session::Store|Catalyst::Plugin::Session::Store>
277 (L<Session::Store::FastMmap|Catalyst::Plugin::Session::Store::FastMmap>
278 is generally a good choice if you are on Unix; try
279 L<Session::Store::File|Catalyst::Plugin::Session::Store::File> if you
280 are on Win32) -- consult
281 L<Session::Store|Catalyst::Plugin::Session::Store> and its subclasses
282 for additional information and options (for example to use a database-
283 backed session store).
286 =head2 Configure Authentication
288 Although C<__PACKAGE__-E<gt>config(name =E<gt> 'value');> is still
289 supported, newer Catalyst applications tend to place all configuration
290 information in C<myapp.conf> and automatically load this information
291 into C<MyApp-E<gt>config> using the
292 L<ConfigLoader|Catalyst::Plugin::ConfigLoader> plugin.
294 First, as noted in Part 3 of the tutorial, Catalyst has recently
295 switched from a default config file format of YAML to
296 C<Config::General> (an apache-like format). In case you are using
297 a version of Catalyst earlier than v5.7014, delete the C<myapp.yml>
298 file and simply follow the directions below to create a new
301 Here, we need to load several parameters that tell
302 L<Catalyst::Plugin::Authentication|Catalyst::Plugin::Authentication>
303 where to locate information in your database. To do this, edit the
304 C<myapp.conf> file and update it to match:
312 # Note this first definition would be the same as setting
313 # __PACKAGE__->config->{authentication}->{realms}->{dbic}
314 # ->{credential} = 'Password' in lib/MyApp.pm
316 # Specify that we are going to do password-based auth
318 # This is the name of the field in the users table with the
319 # password stored in it
320 password_field password
321 # We are using an unencrypted password now
325 # Use DBIC to retrieve username, password & role information
327 # This is the model object created by Catalyst::Model::DBIC
328 # from your schema (you created 'MyApp::Schema::User' but as
329 # the Catalyst startup debug messages show, it was loaded as
330 # 'MyApp::Model::DB::Users').
331 # NOTE: Omit 'MyApp::Model' here just as you would when using
332 # '$c->model("DB::Users)'
334 # This is the name of the field in your 'users' table that
335 # contains the user's name
342 Inline comments in the code above explain how each field is being used.
344 Note that you can use many other config file formats with catalyst.
345 See L<Catalyst::Plugin::ConfigLoader|Catalyst::Plugin::ConfigLoader>
348 =head2 Add Login and Logout Controllers
350 Use the Catalyst create script to create two stub controller files:
352 $ script/myapp_create.pl controller Login
353 $ script/myapp_create.pl controller Logout
355 B<NOTE:> You could easily use a single controller here. For example,
356 you could have a C<User> controller with both C<login> and C<logout>
357 actions. Remember, Catalyst is designed to be very flexible, and leaves
358 such matters up to you, the designer and programmer.
360 Then open C<lib/MyApp/Controller/Login.pm>, locate the C<sub index :
361 Private> method (this was automatically inserted by the helpers when we
362 created the Login controller above), and delete this line:
364 $c->response->body('Matched MyApp::Controller::Login in Login.');
366 Then update it to match:
374 sub index : Private {
377 # Get the username and password from form
378 my $username = $c->request->params->{username} || "";
379 my $password = $c->request->params->{password} || "";
381 # If the username and password values were found in form
382 if ($username && $password) {
383 # Attempt to log the user in
384 if ($c->authenticate({ username => $username,
385 password => $password} )) {
386 # If successful, then let them use the application
387 $c->response->redirect($c->uri_for('/books/list'));
390 # Set an error message
391 $c->stash->{error_msg} = "Bad username or password.";
395 # If either of above don't work out, send to the login page
396 $c->stash->{template} = 'login.tt2';
399 This controller fetches the C<username> and C<password> values from the
400 login form and attempts to authenticate the user. If successful, it
401 redirects the user to the book list page. If the login fails, the user
402 will stay at the login page but receive an error message. If the
403 C<username> and C<password> values are not present in the form, the
404 user will be taken to the empty login form.
406 Note that we could have used something like C<sub default :Private>;
407 however, the use of C<default> actions is discouraged because it does
408 not receive path args as with other actions. The recommended practice
409 is to only use C<default> in C<MyApp::Controller::Root>.
411 Another option would be to use something like
412 C<sub base :Path :Args(0) {...}> (where the C<...> refers to the login
413 code shown in C<sub index : Private> above). We are using C<sub base
414 :Path :Args(0) {...}> here to specifically match the URL C</login>.
415 C<Path> actions (aka, "literal actions") create URI matches relative to
416 the namespace of the controller where they are defined. Although
417 C<Path> supports arguments that allow relative and absolute paths to be
418 defined, here we use an empty C<Path> definition to match on just the
419 name of the controller itself. The method name, C<base>, is arbitrary.
420 We make the match even more specific with the C<:Args(0)> action
421 modifier -- this forces the match on I<only> C</login>, not
422 C</login/somethingelse>.
424 Next, update the corresponding method in
425 C<lib/MyApp/Controller/Logout.pm> to match:
433 sub index : Private {
436 # Clear the user's state
439 # Send the user to the starting point
440 $c->response->redirect($c->uri_for('/'));
443 As with the login controller, be sure to delete the
444 C<$c->response->body('Matched MyApp::Controller::Logout in Logout.');>
445 line of the C<sub index>.
448 =head2 Add a Login Form TT Template Page
450 Create a login form by opening C<root/src/login.tt2> and inserting:
452 [% META title = 'Login' %]
455 <form method="post" action=" [% Catalyst.uri_for('/login') %] ">
459 <td><input type="text" name="username" size="40" /></td>
463 <td><input type="password" name="password" size="40" /></td>
466 <td colspan="2"><input type="submit" name="submit" value="Submit" /></td>
472 =head2 Add Valid User Check
474 We need something that provides enforcement for the authentication
475 mechanism -- a I<global> mechanism that prevents users who have not
476 passed authentication from reaching any pages except the login page.
477 This is generally done via an C<auto> action/method (prior to Catalyst
478 v5.66, this sort of thing would go in C<MyApp.pm>, but starting in
479 v5.66, the preferred location is C<lib/MyApp/Controller/Root.pm>).
481 Edit the existing C<lib/MyApp/Controller/Root.pm> class file and insert
482 the following method:
486 Check if there is a user and, if not, forward to login page
490 # Note that 'auto' runs after 'begin' but before your actions and that
491 # 'auto' "chain" (all from application path to most specific class are run)
492 # See the 'Actions' section of 'Catalyst::Manual::Intro' for more info.
496 # Allow unauthenticated users to reach the login page. This
497 # allows anauthenticated users to reach any action in the Login
498 # controller. To lock it down to a single action, we could use:
499 # if ($c->action eq $c->controller('Login')->action_for('index'))
500 # to only allow unauthenticated access to the C<index> action we
502 if ($c->controller eq $c->controller('Login')) {
506 # If a user doesn't exist, force login
507 if (!$c->user_exists) {
508 # Dump a log message to the development server debug output
509 $c->log->debug('***Root::auto User not found, forwarding to /login');
510 # Redirect the user to the login page
511 $c->response->redirect($c->uri_for('/login'));
512 # Return 0 to cancel 'post-auto' processing and prevent use of application
516 # User found, so return 1 to continue with processing after this 'auto'
521 B<Note:> Catalyst provides a number of different types of actions,
522 such as C<Local>, C<Regex>, C<Private> and the new C<Path>. You
523 should refer to L<Catalyst::Manual::Intro|Catalyst::Manual::Intro> for
524 a more detailed explanation, but the following bullet points provide a
531 The majority of application have traditionally use C<Local> actions
532 for items that respond to user requests and C<Private> actions for
533 those that do not directly respond to user input.
537 Newer Catalyst applications tend to use C<Path> actions and the
538 C<Args> attribute because of their power and flexibility. You can
539 specify the path to match relative to the namespace of the current
540 module as an argument to C<Path>. For example C<Path('list')> in
541 C<lib/MyApp/Controller/Books.pm> would match on the URL
542 C<http://localhost:3000/books/list> but C<Path('/list')> would
543 match on C<http://localhost:3000/list>.
547 Automatic "chaining" of actions by the dispatcher is a powerful
548 feature that allows multiple methods to handle a single URL. See
549 L<Catalyst::DispatchType::Chained|Catalyst::DispatchType::Chained>
550 for more information on chained actions.
554 There are five types of build-in C<Private> actions: C<begin>, C<end>,
555 C<default>, C<index>, and C<auto>.
559 With C<begin>, C<end>, C<default>, C<index> private actions, only the
560 most specific action of each type will be called. For example, if you
561 define a C<begin> action in your controller it will I<override> a
562 C<begin> action in your application/root controller -- I<only> the
563 action in your controller will be called.
567 Unlike the other actions where only a single method is called for each
568 request, I<every> auto action along the chain of namespaces will be
569 called. Each C<auto> action will be called I<from the application/root
570 controller down through the most specific class>.
574 By placing the authentication enforcement code inside the C<auto> method
575 of C<lib/MyApp/Controller/Root.pm> (or C<lib/MyApp.pm>), it will be
576 called for I<every> request that is received by the entire application.
579 =head2 Displaying Content Only to Authenticated Users
581 Let's say you want to provide some information on the login page that
582 changes depending on whether the user has authenticated yet. To do
583 this, open C<root/src/login.tt2> in your editor and add the following
584 lines to the bottom of the file:
588 # This code illustrates how certain parts of the TT
589 # template will only be shown to users who have logged in
591 [% IF Catalyst.user_exists %]
592 Please Note: You are already logged in as '[% Catalyst.user.username %]'.
593 You can <a href="[% Catalyst.uri_for('/logout') %]">logout</a> here.
595 You need to log in to use this application.
598 Note that this whole block is a comment because the "#" appears
599 immediate after the "[%" (with no spaces in between). Although it
600 can be a handy way to temporarily "comment out" a whole block of
601 TT code, it's probably a little too subtle for use in "normal"
606 Although most of the code is comments, the middle few lines provide a
607 "you are already logged in" reminder if the user returns to the login
608 page after they have already authenticated. For users who have not yet
609 authenticated, a "You need to log in..." message is displayed (note the
610 use of an IF-THEN-ELSE construct in TT).
613 =head2 Try Out Authentication
615 Press C<Ctrl-C> to kill the previous server instance (if it's still
616 running) and restart it:
618 $ script/myapp_server.pl
620 B<IMPORTANT NOTE:> If you are having issues with authentication on
621 Internet Explorer, be sure to check the system clocks on both your
622 server and client machines. Internet Explorer is very picky about
623 timestamps for cookies. Note that you can quickly sync an Ubuntu
624 system with the following command:
626 sudo ntpdate ntp.ubuntu.com
628 Now trying going to L<http://localhost:3000/books/list> and you should
629 be redirected to the login page, hitting Shift+Reload if necessary (the
630 "You are already logged in" message should I<not> appear -- if it does,
631 click the C<logout> button and try again). Note the C<***Root::auto User
632 not found...> debug message in the development server output. Enter
633 username C<test01> and password C<mypass>, and you should be taken to
636 Open C<root/src/books/list.tt2> and add the following lines to the
637 bottom (below the closing </table> tag):
640 <a href="[% Catalyst.uri_for('/login') %]">Login</a>
641 <a href="[% Catalyst.uri_for('form_create') %]">Create</a>
644 Reload your browser and you should now see a "Login" and "Create" links
645 at the bottom of the page (as mentioned earlier, you can update template
646 files without reloading the development server). Click the first link
647 to return to the login page. This time you I<should> see the "You are
648 already logged in" message.
650 Finally, click the C<You can logout here> link on the C</login> page.
651 You should stay at the login page, but the message should change to "You
652 need to log in to use this application."
655 =head1 USING PASSWORD HASHES
657 In this section we increase the security of our system by converting
658 from cleartext passwords to SHA-1 password hashes.
660 B<Note:> This section is optional. You can skip it and the rest of the
661 tutorial will function normally.
663 Note that even with the techniques shown in this section, the browser
664 still transmits the passwords in cleartext to your application. We are
665 just avoiding the I<storage> of cleartext passwords in the database by
666 using a SHA-1 hash. If you are concerned about cleartext passwords
667 between the browser and your application, consider using SSL/TLS, made
668 easy with the Catalyst plugin Catalyst::Plugin:RequireSSL.
671 =head2 Get a SHA-1 Hash for the Password
673 Catalyst uses the C<Digest> module to support a variety of hashing
674 algorithms. Here we will use SHA-1 (SHA = Secure Hash Algorithm).
675 First, we should compute the SHA-1 hash for the "mypass" password we are
676 using. The following command-line Perl script provides a "quick and
677 dirty" way to do this:
679 $ perl -MDigest::SHA -e 'print Digest::SHA::sha1_hex("mypass"), "\n"'
680 e727d1464ae12436e899a726da5b2f11d8381b26
683 B<Note:> If you are following along in Ubuntu, you will need to install
684 C<Digest::SHA> with the following command to run the example code above:
686 sudo apt-get install libdigest-sha-perl
688 B<Note:> You should probably modify this code for production use to
689 not read the password from the command line. By having the script
690 prompt for the cleartext password, it avoids having the password linger
691 in forms such as your C<.bash_history> files (assuming you are using
692 BASH as your shell). An example of such a script can be found in
696 =head2 Switch to SHA-1 Password Hashes in the Database
698 Next, we need to change the C<password> column of our C<users> table to
699 store this hash value vs. the existing cleartext password. Open
700 C<myapp03.sql> in your editor and enter:
703 -- Convert passwords to SHA-1 hashes
705 UPDATE users SET password = 'e727d1464ae12436e899a726da5b2f11d8381b26' WHERE id = 1;
706 UPDATE users SET password = 'e727d1464ae12436e899a726da5b2f11d8381b26' WHERE id = 2;
707 UPDATE users SET password = 'e727d1464ae12436e899a726da5b2f11d8381b26' WHERE id = 3;
709 Then use the following command to update the SQLite database:
711 $ sqlite3 myapp.db < myapp03.sql
713 B<Note:> We are using SHA-1 hashes here, but many other hashing
714 algorithms are supported. See C<Digest> for more information.
717 =head2 Enable SHA-1 Hash Passwords in
718 C<Catalyst::Plugin::Authentication::Store::DBIC>
720 Edit C<myapp.conf> and update it to match (the C<password_type> and
721 C<password_hash_type> are new, everything else is the same):
729 # Note this first definition would be the same as setting
730 # __PACKAGE__->config->{authentication}->{realms}->{dbic}
731 # ->{credential} = 'Password' in lib/MyApp.pm
733 # Specify that we are going to do password-based auth
735 # This is the name of the field in the users table with the
736 # password stored in it
737 password_field password
738 # Switch to more secure hashed passwords
740 # Use the SHA-1 hashing algorithm
741 password_hash_type SHA-1
744 # Use DBIC to retrieve username, password & role information
746 # This is the model object created by Catalyst::Model::DBIC
747 # from your schema (you created 'MyApp::Schema::User' but as
748 # the Catalyst startup debug messages show, it was loaded as
749 # 'MyApp::Model::DB::Users').
750 # NOTE: Omit 'MyApp::Model' here just as you would when using
751 # '$c->model("DB::Users)'
753 # This is the name of the field in your 'users' table that
754 # contains the user's name
761 =head2 Try Out the Hashed Passwords
763 Press C<Ctrl-C> to kill the previous server instance (if it's still
764 running) and restart it:
766 $ script/myapp_server.pl
768 You should now be able to go to L<http://localhost:3000/books/list> and
769 login as before. When done, click the "Logout" link on the login page
770 (or point your browser at L<http://localhost:3000/logout>).
773 =head1 USING THE SESSION FOR FLASH
775 As discussed in Part 3 of the tutorial, C<flash> allows you to set
776 variables in a way that is very similar to C<stash>, but it will
777 remain set across multiple requests. Once the value is read, it
778 is cleared (unless reset). Although C<flash> has nothing to do with
779 authentication, it does leverage the same session plugins. Now that
780 those plugins are enabled, let's go back and improve the "delete
781 and redirect with query parameters" code seen at the end of the
782 L<Basic CRUD|Catalyst::Manual::Tutorial::BasicCRUD> part of the
785 First, open C<lib/MyApp/Controller/Books.pm> and modify C<sub delete>
786 to match the following (everything after the model search line of code
796 # $id = primary key of book to delete
797 my ($self, $c, $id) = @_;
799 # Search for the book and then delete it
800 $c->model('DB::Books')->search({id => $id})->delete_all;
802 # Use 'flash' to save information across requests until it's read
803 $c->flash->{status_msg} = "Book deleted";
805 # Redirect the user back to the list page
806 $c->response->redirect($c->uri_for('/books/list'));
809 Next, open C<root/lib/site/layout> and update the TT code to pull from
810 flash vs. the C<status_msg> query parameter:
812 <div id="header">[% PROCESS site/header %]</div>
815 <span class="message">[% status_msg || Catalyst.flash.status_msg %]</span>
816 <span class="error">[% error_msg %]</span>
820 <div id="footer">[% PROCESS site/footer %]</div>
825 Restart the development server and point your browser to
826 L<http://localhost:3000/books/url_create/Test/1/4> to create an extra
827 several books. Click the "Return to list" link and delete one of the
828 "Test" books you just added. The C<flash> mechanism should retain our
829 "Book deleted" status message across the redirect.
831 B<NOTE:> While C<flash> will save information across multiple requests,
832 I<it does get cleared the first time it is read>. In general, this is
833 exactly what you want -- the C<flash> message will get displayed on
834 the next screen where it's appropriate, but it won't "keep showing up"
835 after that first time (unless you reset it). Please refer to
836 L<Catalyst::Plugin::Session|Catalyst::Plugin::Session> for additional
839 =head2 Switch To Flash-To-Stash
841 Although the a use of flash above is certainly an improvement over the
842 C<status_msg> we employed in Part 4 of the tutorial, the C<status_msg
843 || Catalyst.flash.status_msg> statement is a little ugly. A nice
844 alternative is to use the C<flash_to_stash> feature that automatically
845 copies the content of flash to stash. This makes your code controller
846 and template code work regardless of where it was directly access, a
847 forward, or a redirect. To enable C<flash_to_stash>, you can either
848 set the value in C<lib/MyApp.pm> by changing the default
849 C<__PACKAGE__-E<gt>config> setting to something like:
853 session => {flash_to_stash => 1}
856 B<or> add the following to C<myapp.conf>:
862 The C<__PACKAGE__-E<gt>config> option is probably preferable here
863 since it's not something you will want to change at runtime without it
864 possibly breaking some of your code.
866 Then edit C<root/lib/site/layout> and change the C<status_msg> line
867 to look like the following:
869 <span class="message">[% status_msg %]</span>
871 Restart the development server and go to
872 L<http://localhost:3000/books/list> in your browser. Delete another
873 of the "Test" books you added in the previous step. Flash should still
874 maintain the status message across the redirect even though you are no
875 longer explicitly accessing C<Catalyst.flash>.
880 Kennedy Clark, C<hkclark@gmail.com>
882 Please report any errors, issues or suggestions to the author. The
883 most recent version of the Catalyst Tutorial can be found at
884 L<http://dev.catalyst.perl.org/repos/Catalyst/trunk/Catalyst-Manual/lib/Catalyst/Manual/Tutorial/>.
886 Copyright 2006, Kennedy Clark, under Creative Commons License
887 (L<http://creativecommons.org/licenses/by-nc-sa/2.5/>).