X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Manual.git;a=blobdiff_plain;f=lib%2FCatalyst%2FManual%2FTutorial%2F05_Authentication.pod;h=024a9f94156b216f96ef3a71c5cde425ee04b10d;hp=5628b1986dd7e19a79c65dd204e2f88e4399b544;hb=b6e53c1ca5bfa271bfce99e0f42a56c8fd4df4be;hpb=cc0ef55e7569cf9746bdeaaebbc0b72ddcd97467 diff --git a/lib/Catalyst/Manual/Tutorial/05_Authentication.pod b/lib/Catalyst/Manual/Tutorial/05_Authentication.pod index 5628b19..024a9f9 100644 --- a/lib/Catalyst/Manual/Tutorial/05_Authentication.pod +++ b/lib/Catalyst/Manual/Tutorial/05_Authentication.pod @@ -58,14 +58,15 @@ L Now that we finally have a simple yet functional application, we can focus on providing authentication (with authorization coming next in -Chapter 6). +L). -This chapter of the tutorial is divided into two main sections: 1) basic, -cleartext authentication and 2) hash-based authentication. +This chapter of the tutorial is divided into two main sections: 1) +basic, cleartext authentication and 2) hash-based authentication. -You can checkout the source code for this example from the catalyst -subversion repository as per the instructions in -L. +Source code for the tutorial in included in the F directory +of the Tutorial Virtual machine (one subdirectory per chapter). There +are also instructions for downloading the code in +L. =head1 BASIC AUTHENTICATION @@ -78,13 +79,14 @@ application. First, we add both user and role information to the database (we will add the role information here although it will not be used until the -authorization section, Chapter 6). Create a new SQL script file by opening -C in your editor and insert: +authorization section, Chapter 6). Create a new SQL script file by +opening C in your editor and insert: -- - -- Add user and role tables, along with a many-to-many join table + -- Add users and role tables, along with a many-to-many join table -- - CREATE TABLE user ( + PRAGMA foreign_keys = ON; + CREATE TABLE users ( id INTEGER PRIMARY KEY, username TEXT, password TEXT, @@ -98,16 +100,16 @@ C in your editor and insert: role TEXT ); CREATE TABLE user_role ( - user_id INTEGER, - role_id INTEGER, + user_id INTEGER REFERENCES users(id) ON DELETE CASCADE ON UPDATE CASCADE, + role_id INTEGER REFERENCES role(id) ON DELETE CASCADE ON UPDATE CASCADE, PRIMARY KEY (user_id, role_id) ); -- -- Load up some initial test data -- - INSERT INTO user VALUES (1, 'test01', 'mypass', 't01@na.com', 'Joe', 'Blow', 1); - INSERT INTO user VALUES (2, 'test02', 'mypass', 't02@na.com', 'Jane', 'Doe', 1); - INSERT INTO user VALUES (3, 'test03', 'mypass', 't03@na.com', 'No', 'Go', 0); + INSERT INTO users VALUES (1, 'test01', 'mypass', 't01@na.com', 'Joe', 'Blow', 1); + INSERT INTO users VALUES (2, 'test02', 'mypass', 't02@na.com', 'Jane', 'Doe', 1); + INSERT INTO users VALUES (3, 'test03', 'mypass', 't03@na.com', 'No', 'Go', 0); INSERT INTO role VALUES (1, 'user'); INSERT INTO role VALUES (2, 'admin'); INSERT INTO user_role VALUES (1, 1); @@ -119,112 +121,78 @@ Then load this into the C database with the following command: $ sqlite3 myapp.db < myapp02.sql + =head2 Add User and Role Information to DBIC Schema Although we could manually edit the DBIC schema information to include -the new tables added in the previous step, let's use the C -option on the DBIC model helper to do most of the work for us: +the new tables added in the previous step, let's use the +C option on the DBIC model helper to do most of the work +for us: $ script/myapp_create.pl model DB DBIC::Schema MyApp::Schema \ - create=static components=TimeStamp dbi:SQLite:myapp.db - exists "/root/dev/MyApp/script/../lib/MyApp/Model" - exists "/root/dev/MyApp/script/../t" - Dumping manual schema for MyApp::Schema to directory /root/dev/MyApp/script/../lib ... + create=static components=TimeStamp dbi:SQLite:myapp.db \ + on_connect_do="PRAGMA foreign_keys = ON" + exists "/home/catalyst/dev/MyApp/script/../lib/MyApp/Model" + exists "/home/catalyst/dev/MyApp/script/../t" + Dumping manual schema for MyApp::Schema to directory /home/catalyst/dev/MyApp/script/../lib ... Schema dump completed. - exists "/root/dev/MyApp/script/../lib/MyApp/Model/DB.pm" + exists "/home/catalyst/dev/MyApp/script/../lib/MyApp/Model/DB.pm" $ $ ls lib/MyApp/Schema/Result Author.pm BookAuthor.pm Book.pm Role.pm User.pm UserRole.pm -Notice how the helper has added three new table-specific result source +Notice how the helper has added three new table-specific Result Source files to the C directory. And, more importantly, even if there were changes to the existing result source -files, those changes would have only been written above the C<# DO NOT -MODIFY THIS OR ANYTHING ABOVE!> comment and your hand-edited +files, those changes would have only been written above the +C<# DO NOT MODIFY THIS OR ANYTHING ABOVE!> comment and your hand-edited enhancements would have been preserved. -Speaking of "hand-editted enhancements," we should now add -relationship information to the three new result source files. Edit -each of these files and add the following information between the C<# -DO NOT MODIFY THIS OR ANYTHING ABOVE!> comment and the closing C<1;>: - -C: +Speaking of "hand-edited enhancements," we should now add the +C relationship information to the User Result Source file. +As with the Book, BookAuthor, and Author files in +L, +L has automatically created the C +and C relationships for the new User, UserRole, and Role +tables. However, as a convenience for mapping Users to their assigned +roles (see L), +we will also manually add a C relationship. Edit +C add the following information between +the C<# DO NOT MODIFY THIS OR ANYTHING ABOVE!> comment and the closing +C<1;>: - # - # Set relationships: - # - - # has_many(): - # args: - # 1) Name of relationship, DBIC will create accessor with this name - # 2) Name of the model class referenced by this relationship - # 3) Column name in *foreign* table (aka, foreign key in peer table) - __PACKAGE__->has_many(map_user_roles => 'MyApp::Schema::Result::UserRole', 'user_id'); - # many_to_many(): # args: # 1) Name of relationship, DBIC will create accessor with this name # 2) Name of has_many() relationship this many_to_many() is shortcut for # 3) Name of belongs_to() relationship in model class of has_many() above # You must already have the has_many() defined to use a many_to_many(). - __PACKAGE__->many_to_many(roles => 'map_user_roles', 'role'); - - -C: - - # - # Set relationships: - # - - # has_many(): - # args: - # 1) Name of relationship, DBIC will create accessor with this name - # 2) Name of the model class referenced by this relationship - # 3) Column name in *foreign* table (aka, foreign key in peer table) - __PACKAGE__->has_many(map_user_roles => 'MyApp::Schema::Result::UserRole', 'role_id'); - - -C: - - # - # Set relationships: - # - - # belongs_to(): - # args: - # 1) Name of relationship, DBIC will create accessor with this name - # 2) Name of the model class referenced by this relationship - # 3) Column name in *this* table - __PACKAGE__->belongs_to(user => 'MyApp::Schema::Result::User', 'user_id'); - - # belongs_to(): - # args: - # 1) Name of relationship, DBIC will create accessor with this name - # 2) Name of the model class referenced by this relationship - # 3) Column name in *this* table - __PACKAGE__->belongs_to(role => 'MyApp::Schema::Result::Role', 'role_id'); + __PACKAGE__->many_to_many(roles => 'user_roles', 'role'); -The code for these three sets of updates is obviously very similar to -the edits we made to the C, C, and C -classes created in Chapter 3. +The code for this update is obviously very similar to the edits we made +to the C and C classes created in +L with one +exception: we only defined the C relationship in one +direction. Whereas we felt that we would want to map Authors to Books +B Books to Authors, here we are only adding the convenience +C in the Users to Roles direction. Note that we do not need to make any change to the -C schema file. It simply tells DBIC to load all -of the Result Class and ResultSet Class files it finds in below the -C directory, so it will automatically pick up our -new table information. +C schema file. It simply tells DBIC to load all of +the Result Class and ResultSet Class files it finds below the +C directory, so it will automatically pick up our new +table information. -=head2 Sanity-Check Reload of Development Server +=head2 Sanity-Check of the Development Server Reload -We aren't ready to try out the authentication just yet; we only want -to do a quick check to be sure our model loads correctly. Press -C to kill the previous server instance (if it's still running) -and restart it: - - $ script/myapp_server.pl - -Look for the three new model objects in the startup debug output: +We aren't ready to try out the authentication just yet; we only want to +do a quick check to be sure our model loads correctly. Assuming that you +are following along and using the "-r" option on C, +then the development server should automatically reload (if not, press +C to break out of the server if it's running and then enter +C