1 package Catalyst::Authentication::Store::DBIx::Class::User;
4 use namespace::autoclean;
5 extends 'Catalyst::Authentication::User';
7 use List::MoreUtils 'all';
10 has 'config' => (is => 'rw');
11 has 'resultset' => (is => 'rw');
12 has '_user' => (is => 'rw');
13 has '_roles' => (is => 'rw');
16 my ( $class, $config, $c) = @_;
18 $config->{user_model} = $config->{user_class}
19 unless defined $config->{user_model};
22 resultset => $c->model($config->{'user_model'}),
30 Catalyst::Exception->throw(
31 "\$c->model('${ \$self->config->{user_model} }') did not return a resultset."
32 . " Did you set user_model correctly?"
33 ) unless $self->{resultset};
35 $self->config->{'id_field'} = [$self->{'resultset'}->result_source->primary_columns]
36 unless exists $self->config->{'id_field'};
38 $self->config->{'id_field'} = [$self->config->{'id_field'}]
39 unless ref $self->config->{'id_field'} eq 'ARRAY';
41 Catalyst::Exception->throw(
43 . join(q{,} => @{ $self->config->{'id_field'} })
44 . " but user table has no column by that name!"
45 ) unless all { $self->{'resultset'}->result_source->has_column($_) } @{ $self->config->{'id_field'} };
47 ## if we have lazyloading turned on - we should not query the DB unless something gets read.
48 ## that's the idea anyway - still have to work out how to manage that - so for now we always force
50 $self->config->{lazyload} = 0;
52 # if (!$self->config->{lazyload}) {
53 # return $self->load_user($authinfo, $c);
55 # ## what do we do with a lazyload?
56 # ## presumably this is coming out of session storage.
57 # ## use $authinfo to fill in the user in that case?
65 my ($self, $authinfo, $c) = @_;
67 my $dbix_class_config = 0;
69 if (exists($authinfo->{'dbix_class'})) {
70 $authinfo = $authinfo->{'dbix_class'};
71 $dbix_class_config = 1;
74 ## User can provide an arrayref containing the arguments to search on the user class.
75 ## or even provide a prepared resultset, allowing maximum flexibility for user retreival.
76 ## these options are only available when using the dbix_class authinfo hash.
77 if ($dbix_class_config && exists($authinfo->{'resultset'})) {
78 $self->_user($authinfo->{'resultset'}->first);
79 } elsif ($dbix_class_config && exists($authinfo->{'searchargs'})) {
80 $self->_user($self->resultset->search(@{$authinfo->{'searchargs'}})->first);
82 ## merge the ignore fields array into a hash - so we can do an easy check while building the query
83 my %ignorefields = map { $_ => 1} @{$self->config->{'ignore_fields_in_find'}};
86 # now we walk all the fields passed in, and build up a search hash.
87 foreach my $key (grep {!$ignorefields{$_}} keys %{$authinfo}) {
88 if ($self->resultset->result_source->has_column($key)) {
89 $searchargs->{$key} = $authinfo->{$key};
92 if (keys %{$searchargs}) {
93 $self->_user($self->resultset->search($searchargs)->first);
95 Catalyst::Exception->throw(
96 "Failed to load user data. You passed [" . join(',', keys %{$authinfo}) . "]"
97 . " to authenticate() but your user source (" . $self->config->{'user_model'} . ")"
98 . " only has these columns: [" . join( ",", $self->resultset->result_source->columns ) . "]"
99 . " Check your authenticate() call."
104 if ($self->get_object) {
112 sub supported_features {
123 my ( $self ) = shift;
124 ## this used to load @wantedroles - but that doesn't seem to be used by the roles plugin, so I dropped it.
126 ## shortcut if we have already retrieved them
127 if (ref $self->_roles eq 'ARRAY') {
128 return(@{$self->_roles});
132 if (exists($self->config->{'role_column'})) {
133 my $role_data = $self->get($self->config->{'role_column'});
135 @roles = split /[\s,\|]+/, $self->get($self->config->{'role_column'});
137 $self->_roles(\@roles);
138 } elsif (exists($self->config->{'role_relation'})) {
139 my $relation = $self->config->{'role_relation'};
140 if ($self->_user->$relation->result_source->has_column($self->config->{'role_field'})) {
142 $_->get_column($self->config->{role_field})
143 } $self->_user->$relation->search(undef, {
144 columns => [ $self->config->{role_field} ]
146 $self->_roles(\@roles);
148 Catalyst::Exception->throw("role table does not have a column called " . $self->config->{'role_field'});
151 Catalyst::Exception->throw("user->roles accessed, but no role configuration found");
154 return @{$self->_roles};
160 #return $self->get($self->config->{'id_field'});
162 #my $frozenuser = $self->_user->result_source->schema->freeze( $self->_user );
165 my %userdata = $self->_user->get_columns();
170 my ($self, $frozenuser, $c) = @_;
172 #my $obj = $self->resultset->result_source->schema->thaw( $frozenuser );
175 #if (!exists($self->config->{'use_userdata_from_session'}) || $self->config->{'use_userdata_from_session'} == 0) {
176 # $self->_user->discard_changes();
181 ## if use_userdata_from_session is defined in the config, we fill in the user data from the session.
182 if (exists($self->config->{'use_userdata_from_session'}) && $self->config->{'use_userdata_from_session'} != 0) {
183 my $obj = $self->resultset->new_result({ %$frozenuser });
189 if (ref $frozenuser eq 'HASH') {
191 map { ($_ => $frozenuser->{$_}) }
192 @{ $self->config->{id_field} }
196 return $self->load( { $self->config->{'id_field'} => $frozenuser }, $c);
200 my ($self, $field) = @_;
202 if (my $code = $self->_user->can($field)) {
203 return $self->_user->$code;
205 elsif (my $accessor =
206 try { $self->_user->result_source->column_info($field)->{accessor} }) {
207 return $self->_user->$accessor;
209 # XXX this should probably throw
215 my ($self, $force) = @_;
218 $self->_user->discard_changes;
225 my ($self, $force) = @_;
227 return $self->get_object($force);
232 $self->_user( $self->resultset->auto_create( @_ ) );
238 $self->_user->auto_update( @_ );
243 return $self->SUPER::can(@_) || do {
245 if (my $code = $self->_user->can($method)) {
246 sub { shift->_user->$code(@_) }
247 } elsif (my $accessor =
248 try { $self->_user->result_source->column_info($method)->{accessor} }) {
249 sub { shift->_user->$accessor }
258 (my $method) = (our $AUTOLOAD =~ /([^:]+)$/);
259 return if $method eq "DESTROY";
261 if (my $code = $self->_user->can($method)) {
262 return $self->_user->$code(@_);
264 elsif (my $accessor =
265 try { $self->_user->result_source->column_info($method)->{accessor} }) {
266 return $self->_user->$accessor(@_);
268 # XXX this should also throw
273 __PACKAGE__->meta->make_immutable(inline_constructor => 0);
280 Catalyst::Authentication::Store::DBIx::Class::User - The backing user
281 class for the Catalyst::Authentication::Store::DBIx::Class storage
286 This documentation refers to version 0.1300.
290 Internal - not used directly, please see
291 L<Catalyst::Authentication::Store::DBIx::Class> for details on how to
292 use this module. If you need more information than is present there, read the
299 The Catalyst::Authentication::Store::DBIx::Class::User class implements user storage
300 connected to an underlying DBIx::Class schema object.
302 =head1 SUBROUTINES / METHODS
308 =head2 load ( $authinfo, $c )
310 Retrieves a user from storage using the information provided in $authinfo.
312 =head2 supported_features
314 Indicates the features supported by this class. These are currently Roles and Session.
318 Returns an array of roles associated with this user, if roles are configured for this user class.
322 Returns a serialized user for storage in the session.
326 Revives a serialized user from storage in the session.
328 =head2 get ( $fieldname )
330 Returns the value of $fieldname for the user in question. Roughly translates to a call to
331 the DBIx::Class::Row's get_column( $fieldname ) routine.
335 Retrieves the DBIx::Class object that corresponds to this user
339 Synonym for get_object
343 This is called when the auto_create_user option is turned on in
344 Catalyst::Plugin::Authentication and a user matching the authinfo provided is not found.
345 By default, this will call the C<auto_create()> method of the resultset associated
346 with this object. It is up to you to implement that method.
350 This is called when the auto_update_user option is turned on in
351 Catalyst::Plugin::Authentication. Note that by default the DBIx::Class store
352 uses every field in the authinfo hash to match the user. This means any
353 information you provide with the intent to update must be ignored during the
354 user search process. Otherwise the information will most likely cause the user
355 record to not be found. To ignore fields in the search process, you
356 have to add the fields you wish to update to the 'ignore_fields_in_find'
357 authinfo element. Alternately, you can use one of the advanced row retrieval
358 methods (searchargs or resultset).
360 By default, auto_update will call the C<auto_update()> method of the
361 DBIx::Class::Row object associated with the user. It is up to you to implement
362 that method (probably in your schema file)
364 =head1 BUGS AND LIMITATIONS
366 None known currently, please email the author if you find any.
370 Jason Kuri (jayk@cpan.org)
374 Matt S Trout (mst) <mst@shadowcat.co.uk>
376 (fixes wrt can/AUTOLOAD sponsored by L<http://reask.com/>)
380 Copyright (c) 2007-2010 the aforementioned authors. All rights
381 reserved. This program is free software; you can redistribute
382 it and/or modify it under the same terms as Perl itself.