use Moose;
use KiokuX::User::Util qw(crypt_password);
+use Text::Tradition::Error;
-extends 'KiokuX::Model';
+extends 'Text::Tradition::Directory';
+# extends 'KiokuX::Model';
use Text::Tradition::User;
-# use Text::Tradition::Directory;
+
+=head1 NAME
+
+Text::Tradition::UserStore - KiokuDB storage management for Users
+
+=head1 SYNOPSIS
+
+ my $userstore = Text::Tradition::UserStore->new(dsn => 'dbi:SQLite:foo.db');
+ my $newuser = $userstore->add_user({ username => 'fred',
+ password => 'somepassword' });
+
+ my $fetchuser = $userstore->find_user({ username => 'fred' });
+ if($fetchuser->check_password('somepassword')) {
+ ## login user or .. whatever
+ }
+
+ my $user = $userstore->deactivate_user({ username => 'fred' });
+ if(!$user->active) {
+ ## shouldnt be able to login etc
+ }
+
+=head1 DESCRIPTION
+
+A L<KiokuX::Model> for managing the storage and creation of
+L<Text::Tradition::User> objects. Subclass or replace this module in
+order to use a different source for stemmaweb users.
+
+=head2 ATTRIBUTES
+
+=head3 dsn
+
+Inherited from KiokuX::Model - dsn for the data store we are using.
+
+=head3 MIN_PASS_LEN
+
+Constant for the minimum password length when validating passwords,
+defaults to "8".
+
+=cut
has MIN_PASS_LEN => ( is => 'ro', isa => 'Num', default => sub { 8 } );
## XX_user, but leaving that way for now incase we merge this code
## into ::Directory for one-store.
-## To die or not to die, on error, this is the question.
+=head2 METHODS
+
+=head3 add_user
+
+Takes a hashref of C<username>, C<password>.
+
+Create a new user object, store in the KiokuDB backend, and return it.
+
+=cut
+
sub add_user {
my ($self, $userinfo) = @_;
- my $username = $userinfo->{username};
+ my $username = $userinfo->{url} || $userinfo->{username};
my $password = $userinfo->{password};
- return unless $username && $self->validate_password($password);
-
+ throw( "No username given" ) unless $username;
+ throw( "Invalid password - too short?" )
+ unless ( $self->validate_password($password) || $username =~ /^https?:/ );
+
my $user = Text::Tradition::User->new(
id => $username,
- password => crypt_password($password),
+ password => ($password ? crypt_password($password) : ''),
);
my $scope = $self->new_scope;
return $user;
}
+sub create_user {
+ my $self = shift;
+ return $self->add_user(@_);
+}
+
+=head3 find_user
+
+Takes a hashref of C<username>, optionally C<openid_identifier>.
+
+Fetches the user object for the given username and returns it.
+
+=cut
+
sub find_user {
my ($self, $userinfo) = @_;
- my $username = $userinfo->{username};
+ ## url or display?
+ # 'display' => 'castaway.myopenid.com',
+ # 'url' => 'http://castaway.myopenid.com/',
+ my $username = $userinfo->{url} || $userinfo->{username};
my $scope = $self->new_scope;
return $self->lookup(Text::Tradition::User->id_for_user($username));
}
+=head3 modify_user
+
+Takes a hashref of C<username> and C<password> (same as add_user).
+
+Retrieves the user, and updates it with the new information. Username
+changing is not currently supported. Returns the updated user object.
+Throws an error if user not found.
+
+=cut
+
sub modify_user {
my ($self, $userinfo) = @_;
my $username = $userinfo->{username};
my $password = $userinfo->{password};
- return unless $username && $self->validate_password($password);
+ throw( "Missing username or bad password" )
+ unless $username && $self->validate_password($password);
my $user = $self->find_user({ username => $username });
- return unless $user;
+ throw( "Could not find user $username" ) unless $user;
my $scope = $self->new_scope;
$user->password(crypt_password($password));
return $user;
}
+=head3 deactivate_user
+
+Takes a hashref of C<username>.
+
+Sets the users C<active> flag to false (0), and sets all traditions
+assigned to them to non-public, updates the storage and returns the
+deactivated user.
+
+Throws an error if user not found.
+
+=cut
+
sub deactivate_user {
my ($self, $userinfo) = @_;
my $username = $userinfo->{username};
- return if !$username;
+ throw( "Need to specify a username for deactivation" ) unless $username;
my $user = $self->find_user({ username => $username });
- return if !$user;
+ throw( "User $username not found" ) unless $user;
$user->active(0);
foreach my $tradition (@{ $user->traditions }) {
return $user;
}
+=head3 reactivate_user
+
+Takes a hashref of C<username>.
+
+Returns the user object if already activated. Activates (sets the
+active flag to true (1)), updates the storage and returns the user.
+
+Throws an error if the user is not found.
+
+=cut
+
sub reactivate_user {
my ($self, $userinfo) = @_;
my $username = $userinfo->{username};
- return if !$username;
+ throw( "Need to specify a username for reactivation" ) unless $username;
my $user = $self->find_user({ username => $username });
- return if !$user;
+ throw( "User $username not found" ) unless $user;
return $user if $user->active;
return $user;
}
+=head3 delete_user
+
+CAUTION: Delets actual data!
+
+Takes a hashref of C<username>.
+
+Throws an error if the user doesn't exist.
+
+Removes the user from the store and returns 1.
+
+=cut
+
sub delete_user {
my ($self, $userinfo) = @_;
my $username = $userinfo->{username};
- return if !$username;
+ throw( "Need to specify a username for deletion" ) unless $username;
my $user = $self->find_user({ username => $username });
- return if !$user;
+ throw( "User $username not found" ) unless $user;
my $scope = $self->new_scope;
return 1;
}
+=head3 validate_password
+
+Takes a password string. Returns true if it is longer than
+L</MIN_PASS_LEN>, false otherwise.
+
+Used internally by L</add_user>.
+
+=cut
+
sub validate_password {
my ($self, $password) = @_;
return 1;
}
+sub throw {
+ Text::Tradition::Error->throw(
+ 'ident' => 'UserStore error',
+ 'message' => $_[0],
+ );
+}
+
1;
projects / scpubgit/stemmatology.git / blobdiff