1 package Catalyst::Authentication::Store::DBIx::Class;
5 use base qw/Class::Accessor::Fast/;
11 __PACKAGE__->mk_accessors(qw/config/);
16 my ( $class, $config, $app ) = @_;
18 ## figure out if we are overriding the default store user class
19 $config->{'store_user_class'} = (exists($config->{'store_user_class'})) ? $config->{'store_user_class'} :
20 "Catalyst::Authentication::Store::DBIx::Class::User";
22 ## make sure the store class is loaded.
23 Catalyst::Utils::ensure_class_loaded( $config->{'store_user_class'} );
25 ## fields can be specified to be ignored during user location. This allows
26 ## the store to ignore certain fields in the authinfo hash.
28 $config->{'ignore_fields_in_find'} ||= [ ];
39 ## let's use DBICs get_columns method to return a hash and save / restore that
40 ## from the session. Then we can respond to get() calls, etc. in most cases without
41 ## resorting to a DB call. If user_object is called, THEN we can hit the DB and
42 ## return a real object.
44 my ( $self, $c, $frozenuser ) = @_;
46 # return $frozenuser if ref $frozenuser;
48 my $user = $self->config->{'store_user_class'}->new($self->{'config'}, $c);
49 return $user->from_session($frozenuser, $c);
53 my ($self, $c, $user) = @_;
55 return $user->for_session($c);
59 my ( $self, $authinfo, $c ) = @_;
61 my $user = $self->config->{'store_user_class'}->new($self->{'config'}, $c);
63 return $user->load($authinfo, $c);
69 # this can work as a class method on the user class
70 $self->config->{'store_user_class'}->supports( @_ );
73 sub auto_create_user {
74 my( $self, $authinfo, $c ) = @_;
75 my $res = $self->config->{'store_user_class'}->new($self->{'config'}, $c);
76 return $res->auto_create( $authinfo, $c );
79 sub auto_update_user {
80 my( $self, $authinfo, $c, $res ) = @_;
81 $res->auto_update( $authinfo, $c );
91 Catalyst::Authentication::Store::DBIx::Class - A storage class for Catalyst Authentication using DBIx::Class
95 This documentation refers to version 0.10.
101 Authorization::Roles/;
103 __PACKAGE__->config->{authentication} =
105 default_realm => 'members',
110 password_field => 'password',
111 password_type => 'clear'
114 class => 'DBIx::Class',
115 user_class => 'MyApp::User',
116 id_field => 'user_id',
117 role_relation => 'roles',
118 role_field => 'rolename',
127 my ( $self, $c ) = @_;
130 username => $c->req->params->username,
131 password => $c->req->params->password,
132 status => [ 'registered', 'loggedin', 'active']
138 if ( $c->check_user_roles( 'editor' ) ) {
144 The Catalyst::Authentication::Store::DBIx::Class class provides
145 access to authentication information stored in a database via DBIx::Class.
149 The DBIx::Class authentication store is activated by setting the store
150 config's B<class> element to DBIx::Class as shown above. See the
151 L<Catalyst::Plugin::Authentication> documentation for more details on
152 configuring the store.
154 The DBIx::Class storage module has several configuration options
157 __PACKAGE__->config->{authentication} =
159 default_realm => 'members',
166 class => 'DBIx::Class',
167 user_class => 'MyApp::User',
168 id_field => 'user_id',
169 role_relation => 'roles',
170 role_field => 'rolename',
171 ignore_fields_in_find => [ 'remote_name' ],
172 use_userdata_from_session => 1,
182 Class is part of the core Catalyst::Plugin::Authentication module, it
183 contains the class name of the store to be used.
187 Contains the class name (as passed to $c->model()) of the DBIx::Class schema
188 to use as the source for user information. This config item is B<REQUIRED>.
192 Contains the field name containing the unique identifier for a user. This is
193 used when storing and retrieving a user from the session. The value in this
194 field should correspond to a single user in the database. Defaults to 'id'.
198 If your role information is stored in the same table as the rest of your user
199 information, this item tells the module which field contains your role
200 information. The DBIx::Class authentication store expects the data in this
201 field to be a series of role names separated by some combination of spaces,
202 commas or pipe characters.
206 If your role information is stored in a separate table, this is the name of
207 the relation that will lead to the roles the user is in. If this is
208 specified then a role_field is also required. Also when using this method
209 it is expected that your role table will return one row for each role
214 This is the name of the field in the role table that contains the string
215 identifying the role.
217 =item ignore_fields_in_find
219 This item is an array containing fields that may be passed to the
220 $c->authenticate() routine (and therefore find_user in the storage class), but
221 which should be ignored when creating the DBIx::Class search to retrieve a
222 user. This makes it possible to avoid problems when a credential requires an
223 authinfo element whose name overlaps with a column name in your users table.
224 If this doesn't make sense to you, you probably don't need it.
226 =item use_userdata_from_session
228 Under normal circumstances, on each request the user's data is re-retrieved
229 from the database using the primary key for the user table. When this flag
230 is set in the configuration, it causes the DBIx::Class store to avoid this
231 database hit on session restore. Instead, the user object's column data
232 is retrieved from the session and used as-is.
234 B<NOTE>: Since the user object's column
235 data is only stored in the session during the initial authentication of
236 the user, turning this on can potentially lead to a situation where the data
237 in $c->user is different from what is stored the database. You can force
238 a reload of the data from the database at any time by calling $c->user->get_object(1);
239 Note that this will update $c->user for the remainder of this request.
240 It will NOT update the session. If you need to update the session
241 you should call $c->update_user_in_session() as well.
243 =item store_user_class
245 This allows you to override the authentication user class that the
246 DBIx::Class store module uses to perform it's work. Most of the
247 work done in this module is actually done by the user class,
248 L<Catalyst::Authentication::Store::DBIx::Class::User>, so
249 overriding this doesn't make much sense unless you are using your
250 own class to extend the functionality of the existing class.
251 Chances are you do not want to set this.
257 The L<Catalyst::Authentication::Store::DBIx::Class> storage module
258 is not called directly from application code. You interface with it
259 through the $c->authenticate() call.
261 There are three methods you can use to retrieve information from the DBIx::Class
262 storage module. They are Simple retrieval, and the advanced retrieval methods
263 Searchargs and Resultset.
265 =head2 Simple Retrieval
267 The first, and most common, method is simple retrieval. As it's name implies
268 simple retrieval allows you to simply to provide the column => value pairs
269 that should be used to locate the user in question. An example of this usage
272 if ($c->authenticate({
273 username => $c->req->params->{'username'},
274 password => $c->req->params->{'password'},
275 status => [ 'registered', 'active', 'loggedin']
278 # ... authenticated user code here
281 The above example would attempt to retrieve a user whose username column
282 matched the username provided, and whose status column matched one of the
283 values provided. These name => value pairs are used more or less directly in
284 the DBIx::Class' search() routine, so in most cases, you can use DBIx::Class
285 syntax to retrieve the user according to whatever rules you have.
287 NOTE: Because the password in most cases is encrypted - it is not used
288 directly but it's encryption and comparison with the value provided is usually
289 handled by the Password Credential. Part of the Password Credential's behavior
290 is to remove the password argument from the authinfo that is passed to the
291 storage module. See L<Catalyst::Authentication::Credential::Password>.
293 One thing you need to know about this retrieval method is that the name
294 portion of the pair is checked against the user class' column list. Pairs are
295 only used if a matching column is found. Other pairs will be ignored. This
296 means that you can only provide simple name-value pairs, and that some more
297 advanced DBIx::Class constructs, such as '-or', '-and', etc. are in most cases
298 not possible using this method. For queries that require this level of
299 functionality, see the 'searchargs' method below.
301 =head2 Advanced Retrieval
303 The Searchargs and Resultset retrieval methods are used when more advanced
304 features of the underlying L<DBIx::Class> schema are required. These methods
305 provide a direct interface with the DBIx::Class schema and therefore
306 require a better understanding of the DBIx::Class module.
308 =head3 The dbix_class key
310 Since the format of these arguments are often complex, they are not keys in
311 the base authinfo hash. Instead, both of these arguments are placed within
312 a hash attached to the store-specific 'dbix_class' key in the base $authinfo
313 hash. When the DBIx::Class authentication store sees the 'dbix_class' key
314 in the passed authinfo hash, all the other information in the authinfo hash
315 is ignored and only the values within the 'dbix_class' hash are used as
316 though they were passed directly within the authinfo hash. In other words, if
317 'dbix_class' is present, it replaces the authinfo hash for processing purposes.
319 The 'dbix_class' hash can be used to directly pass arguments to the
320 DBIx::Class authentication store. Reasons to do this are to avoid credential
321 modification of the authinfo hash, or to avoid overlap between credential and
322 store key names. It's a good idea to avoid using it in this way unless you are
323 sure you have an overlap/modification issue. However, the two advanced
324 retrieval methods, B<searchargs> and B<resultset>, require it's use, as they
325 are only processed as part of the 'dbix_class' hash
331 The B<searchargs> method of retrieval allows you to specify an arrayref containing
332 the two arguments to the search() method from L<DBIx::Class::ResultSet>. If provided,
333 all other args are ignored, and the search args provided are used directly to locate
334 the user. An example will probably make more sense:
336 if ($c->authenticate(
338 password => $password,
341 searchargs => [ { -or => [ username => $username,
343 clientid => $clientid ]
345 { prefetch => qw/ preferences / }
350 # do successful authentication actions here.
353 The above would allow authentication based on any of the three items -
354 username, email or clientid and would prefetch the data related to that user
355 from the preferences table. The searchargs array is passed directly to the
356 search() method associated with the user_class.
360 The B<resultset> method of retrieval allows you to directly specify a
361 resultset to be used for user retrieval. This allows you to create a resultset
362 within your login action and use it for retrieving the user. A simple example:
364 my $rs = $c->model('MyApp::User')->search({ email => $c->request->params->{'email'} });
365 ... # further $rs adjustments
367 if ($c->authenticate({
368 password => $password,
369 'dbix_class' => { resultset => $rs }
371 # do successful authentication actions here.
374 Be aware that the resultset method will not verify that you are passing a
375 resultset that is attached to the same user_class as specified in the config.
377 NOTE: All of these methods of user retrieval, including the resultset method,
378 consider the first row returned to be the matching user. In most cases there
379 will be only one matching row, but it is easy to produce multiple rows,
380 especially when using the advanced retrieval methods. Remember, what you get
381 when you use this module is what you would get when calling
384 NOTE ALSO: The user info used to save the user to the session and to retrieve
385 it is the same regardless of what method of retrieval was used. In short,
386 the value in the id field (see 'id_field' config item) is used to retrieve the
387 user from the database upon restoring from the session. When the DBIx::Class storage
388 module does this, it does so by doing a simple search using the id field. In other
389 words, it will not use the same arguments you used to request the user initially.
390 This is especially important to those using the advanced methods of user retrieval.
391 If you need more complicated logic when reviving the user from the session, you will
392 most likely want to subclass the L<Catalyst::Authentication::Store::DBIx::Class::User> class
393 and provide your own for_session and from_session routines.
400 There are no publicly exported routines in the DBIx::Class authentication
401 store (or indeed in most authentication stores) However, below is a
402 description of the routines required by L<Catalyst::Plugin::Authentication>
403 for all authentication stores. Please see the documentation for
404 L<Catalyst::Plugin::Authentication::Internals> for more information.
407 =head2 new ( $config, $app )
409 Constructs a new store object.
411 =head2 find_user ( $authinfo, $c )
413 Finds a user using the information provided in the $authinfo hashref and
414 returns the user, or undef on failure; This is usually called from the
415 Credential. This translates directly to a call to
416 L<Catalyst::Authentication::Store::DBIx::Class::User>'s load() method.
418 =head2 for_session ( $c, $user )
420 Prepares a user to be stored in the session. Currently returns the value of
421 the user's id field - (as indicated by the 'id_field' config element)
423 =head2 from_session ( $c, $frozenuser)
425 Revives a user from the session based on the info provided in $frozenuser.
426 Currently treats $frozenuser as an id and retrieves a user with a matching id.
430 Provides information about what the user object supports.
432 =head2 auto_update_user( $authinfo, $c, $res )
434 This method is called if the realm's auto_update_user setting is true. It
435 will delegate to the user object's C<auto_update> method.
437 =head2 auto_create_user( $authinfo, $c )
439 This method is called if the realm's auto_create_user setting is true. It
440 will delegate to the user class' (resultset) C<auto_create> method.
444 As of the current release, session storage consists of simply storing the user's
445 id in the session, and then using that same id to re-retrieve the users information
446 from the database upon restoration from the session. More dynamic storage of
447 user information in the session is intended for a future release.
449 =head1 BUGS AND LIMITATIONS
451 None known currently, please email the author if you find any.
455 L<Catalyst::Plugin::Authentication>, L<Catalyst::Plugin::Authentication::Internals>,
456 and L<Catalyst::Plugin::Authorization::Roles>
460 Jason Kuri (jayk@cpan.org)
464 Copyright (c) 2007 the aforementioned authors. All rights
465 reserved. This program is free software; you can redistribute
466 it and/or modify it under the same terms as Perl itself.