oqapi/webgui
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Adding new API to User. get update enable disable

Browse source
This commit is contained in:
Doug Bell 2009-05-14 22:16:50 +00:00
parent 774c499d2d
commit 93819cda0c
2 changed files with 414 additions and 78 deletions
Download patch file Download diff file Expand all files Collapse all files

333
lib/WebGUI/User.pm
View file

@ -39,20 +39,29 @@ This package provides an object-oriented way of managing WebGUI users as well as
$u = WebGUI::User->newByEmail($session, $email); $u = WebGUI::User->newByEmail($session, $email);
$u = WebGUI::User->newByUsername($session, $username); $u = WebGUI::User->newByUsername($session, $username);
$authMethod = $u->authMethod("WebGUI"); # Get data
$dateCreated = $u->dateCreated; $authMethod = $u->get("authMethod");
$karma = $u->karma; $dateCreated = $u->get("dateCreated");
$lastUpdated = $u->lastUpdated; $karma = $u->karma;
$languagePreference = $u->profileField("language",1); $lastUpdated = $u->get("lastUpdated");
$referringAffiliate = $u->referringAffiliate; $languagePreference = $u->get("language");
$status = $u->status("somestatus"); $referringAffiliate = $u->get("referringAffiliate");
$username = $u->username("jonboy"); $status = $u->get("status");
$arrayRef = $u->getGroups; $username = $u->get("username");
$member = $u->isInGroup($groupId); $arrayRef = $u->getGroups;
$isMember = $u->isInGroup($groupId);
# Update data
$u->update({
username => "m_bolton",
firstName => "Mike",
likesSoftPop => 1,
});
$u->addToGroups(\@arr); $u->addToGroups(\@arr);
$u->deleteFromGroups(\@arr); $u->deleteFromGroups(\@arr);
$u->delete; $u->delete;
$u->enable;
$u->disable;
WebGUI::User->validUserId($session, $userId); WebGUI::User->validUserId($session, $userId);
@ -173,6 +182,8 @@ sub acceptsFriendsRequests {
=head2 authMethod ( [ value ] ) =head2 authMethod ( [ value ] )
DEPRECATED! Use get("authMethod") and update({ authMethod => "value })
Returns the authentication method for this user. Returns the authentication method for this user.
=head3 value =head3 value
@ -186,13 +197,9 @@ sub authMethod {
$self = shift; $self = shift;
$value = shift; $value = shift;
if (defined $value) { if (defined $value) {
$self->uncache; $self->update({ authMethod => $value });
$self->{_user}{"authMethod"} = $value;
$self->{_user}{"lastUpdated"} =$self->session->datetime->time();
$self->session->db->write("update users set authMethod=".$self->session->db->quote($value).",
lastUpdated=".$self->session->datetime->time()." where userId=".$self->session->db->quote($self->{_userId}));
} }
return $self->{_user}{"authMethod"}; return $self->get("authMethod");
} }
#------------------------------------------------------------------- #-------------------------------------------------------------------
@ -298,12 +305,15 @@ sub canViewField {
=head2 dateCreated ( ) =head2 dateCreated ( )
DEPRECATED! Use get("dateCreated") instead
Returns the epoch for when this user was created. Returns the epoch for when this user was created.
=cut =cut
sub dateCreated { sub dateCreated {
return $_[0]->{_user}{dateCreated}; my ( $self ) = @_;
return $self->get("dateCreated");
} }
#------------------------------------------------------------------- #-------------------------------------------------------------------
@ -377,6 +387,48 @@ sub DESTROY {
undef $self; undef $self;
} }
#----------------------------------------------------------------------------
=head2 disable ( [options] )
Disable the user. C<options> is an optional hashref with the following keys:
bySelf - If true, the user is disabling themselves
=cut
sub disable {
my ( $self, $options ) = @_;
my $session = $self->session;
my $db = $session->db;
if ( $options->{bySelf} ) {
$self->update({ status => "Selfdestructed" });
}
else {
$self->update({ status => "Deactivated" });
# Remove sessions
my $rs = $db->read("select sessionId from userSession where userId=?",[$self->{_userId}]);
while (my ($id) = $rs->array) {
$db->write("delete from userSessionScratch where sessionId=?",[$id]);
}
$db->write("delete from userSession where userId=?",[$self->{_userId}]);
}
}
#----------------------------------------------------------------------------
=head2 enable ( )
Enable the user.
=cut
sub enable {
my ( $self ) = @_;
$self->update({ status => "Active" });
}
#------------------------------------------------------------------- #-------------------------------------------------------------------
@ -423,6 +475,64 @@ sub friends {
return $myFriends; return $myFriends;
} }
#----------------------------------------------------------------------------
=head2 get ( [field] )
Get properties for this user. If C<field> is defined, will return the value
of the field. Otherwise, returns a hash reference of all properties and profile
fields.
=cut
sub get {
my ( $self, $field ) = @_;
my $session = $self->session;
if ( $field ) {
if ( exists $self->{_user}->{$field} ) {
return $self->{_user}->{$field};
}
else {
if ( !WebGUI::ProfileField->exists( $session, $field ) ) {
return;
}
# XXX Should the defaults be set in new() ...
if ( !exists $self->{_profile}->{$field} ) {
my $default = $session->db->quickScalar("SELECT dataDefault FROM userProfileField WHERE fieldName=?", [$field]);
$self->{_profile}{$field}
= WebGUI::Operation::Shared::secureEval($session, $default);
$self->cache; # XXX ... Because we cache them here!
}
if (ref $self->{_profile}{$field} eq 'ARRAY') {
##Return a scalar, that is a string with all the defaults
return join ',', @{ $self->{_profile}{$field} };
}
return $self->{_profile}->{$field};
}
}
# Create a safe copy of everything to return
my %properties = (
%{$self->{_user}},
%{$self->{_profile}},
);
# Add any missing fields
my %default = $session->db->buildHash(
"SELECT fieldName, dataDefault FROM userProfileField",
);
for my $key ( keys %default ) {
if ( !exists $properties{$key} ) {
$properties{$key}
= WebGUI::Operation::Shared::secureEval($session, $default{$key});
}
}
return \%properties;
}
#------------------------------------------------------------------- #-------------------------------------------------------------------
=head2 getFirstName ( ) =head2 getFirstName ( )
@ -502,6 +612,19 @@ sub getGroupIdsRecursive {
return [ keys %groupIds ]; return [ keys %groupIds ];
} }
#----------------------------------------------------------------------------
=head2 getId ( )
Get the user's ID
=cut
sub getId {
my ( $self ) = @_;
return $self->{_userId};
}
#------------------------------------------------------------------- #-------------------------------------------------------------------
=head2 getInboxAddresses ( ) =head2 getInboxAddresses ( )
@ -764,6 +887,8 @@ A description of why this user's karma was modified. For instance it could be "M
=cut =cut
# NOTE: Should this be called "addKarma" instead?
sub karma { sub karma {
my $self = shift; my $self = shift;
my $amount = shift; my $amount = shift;
@ -782,12 +907,15 @@ sub karma {
=head2 lastUpdated ( ) =head2 lastUpdated ( )
DEPRECATED! Use get("lastUpdated")
Returns the epoch for when this user was last modified. Returns the epoch for when this user was last modified.
=cut =cut
sub lastUpdated { sub lastUpdated {
return $_[0]->{_user}{lastUpdated}; my ( $self ) = @_;
return $self->get('lastUpdated');
} }
#------------------------------------------------------------------- #-------------------------------------------------------------------
@ -830,11 +958,15 @@ sub new {
[$user{userId}] [$user{userId}]
); );
delete $profile{userId}; delete $profile{userId};
delete $profile{wg_privacySettings};
# remove undefined fields so they will fall back on defaults when requested # Fill in dataDefault
my $default = $session->db->buildHashRef(
"SELECT fieldName, dataDefault FROM userProfileField"
);
for my $key (keys %profile) { for my $key (keys %profile) {
if (!defined $profile{$key} || $profile{$key} eq '') { if (!defined $profile{$key} || $profile{$key} eq '') {
delete $profile{$key}; delete $profile{$key}
} }
} }
@ -912,6 +1044,8 @@ sub newByUsername {
=head2 profileField ( fieldName [, value ] ) =head2 profileField ( fieldName [, value ] )
DEPRECATED! Use get(fieldName) and update({ fieldName => "value" })
Returns a profile field's value. If "value" is specified, it also sets the field to that value. Returns a profile field's value. If "value" is specified, it also sets the field to that value.
=head3 fieldName =head3 fieldName
@ -928,33 +1062,12 @@ sub profileField {
my $self = shift; my $self = shift;
my $fieldName = shift; my $fieldName = shift;
my $value = shift; my $value = shift;
my $db = $self->session->db;
return "" if ($fieldName eq "wg_privacySettings"); # this is a special internal field, don't try to process it.
if (!exists $self->{_profile}{$fieldName} && !$self->session->db->quickScalar("SELECT COUNT(*) FROM userProfileField WHERE fieldName = ?", [$fieldName])) {
$self->session->errorHandler->warn("No such profile field: $fieldName");
return undef;
}
if (defined $value) { if (defined $value) {
$self->uncache; $self->update({ $fieldName => $value });
$self->{_profile}{$fieldName} = $value;
$db->write(
"UPDATE userProfileData SET ".$db->dbh->quote_identifier($fieldName)."=? WHERE userId=?",
[$value, $self->{_userId}]
);
my $time = $self->session->datetime->time;
$self->{_user}{"lastUpdated"} = $time;
$self->session->db->write("update users set lastUpdated=? where userId=?", [$time, $self->{_userId}]);
} }
elsif (!exists $self->{_profile}{$fieldName}) {
my $default = $self->session->db->quickScalar("SELECT dataDefault FROM userProfileField WHERE fieldName=?", [$fieldName]); return $self->get($fieldName);
$self->{_profile}{$fieldName} = WebGUI::Operation::Shared::secureEval($self->session, $default);
$self->cache;
}
if (ref $self->{_profile}{$fieldName} eq 'ARRAY') {
##Return a scalar, that is a string with all the defaults
return join ',', @{ $self->{_profile}{$fieldName} };
}
return $self->{_profile}{$fieldName};
} }
#------------------------------------------------------------------- #-------------------------------------------------------------------
@ -991,6 +1104,8 @@ sub profileIsViewable {
=head2 referringAffiliate ( [ value ] ) =head2 referringAffiliate ( [ value ] )
DEPRECATED! Use get("referringAffiliate") and update({ referringAffiliate => "value" })
Returns the unique identifier of the affiliate that referred this user to the site. Returns the unique identifier of the affiliate that referred this user to the site.
=head3 value =head3 value
@ -1003,13 +1118,9 @@ sub referringAffiliate {
my $self = shift; my $self = shift;
my $value = shift; my $value = shift;
if (defined $value) { if (defined $value) {
$self->uncache; $self->update({ "referringAffiliate" => $value });
$self->{_user}{"referringAffiliate"} = $value;
$self->{_user}{"lastUpdated"} =$self->session->datetime->time();
$self->session->db->write("update users set referringAffiliate=".$self->session->db->quote($value).",
lastUpdated=".$self->session->datetime->time()." where userId=".$self->session->db->quote($self->userId));
} }
return $self->{_user}{"referringAffiliate"}; return $self->get("referringAffiliate");
} }
#------------------------------------------------------------------- #-------------------------------------------------------------------
@ -1025,7 +1136,6 @@ sub session {
return $self->{_session}; return $self->{_session};
} }
#------------------------------------------------------------------- #-------------------------------------------------------------------
=head2 setProfileFieldPrivacySetting ( settings ) =head2 setProfileFieldPrivacySetting ( settings )
@ -1068,6 +1178,8 @@ sub setProfileFieldPrivacySetting {
=head2 status ( [ value ] ) =head2 status ( [ value ] )
DEPRECATED! Use get("status") and enable() and disable() instead
Returns the status of the user. Returns the status of the user.
=head3 value =head3 value
@ -1083,20 +1195,17 @@ sub status {
my $self = shift; my $self = shift;
my $value = shift; my $value = shift;
if (defined $value) { if (defined $value) {
$self->uncache; if ( $value eq "Active" ) {
$self->{_user}{"status"} = $value; $self->enable;
$self->{_user}{"lastUpdated"} =$self->session->datetime->time(); }
$self->session->db->write("update users set status=".$self->session->db->quote($value).", elsif ( $value eq "Selfdestructed" ) {
lastUpdated=".$self->session->datetime->time()." where userId=".$self->session->db->quote($self->userId)); $self->disable({ bySelf => 1 });
if ($value eq 'Deactivated') { }
my $rs = $self->session->db->read("select sessionId from userSession where userId=?",[$self->{_userId}]); elsif ( $value eq "Deactivated" ) {
while (my ($id) = $rs->array) { $self->disable;
$self->session->db->write("delete from userSessionScratch where sessionId=?",[$id]); }
}
$self->session->db->write("delete from userSession where userId=?",[$self->{_userId}]);
}
} }
return $self->{_user}{"status"}; return $self->get("status");
} }
#------------------------------------------------------------------- #-------------------------------------------------------------------
@ -1113,10 +1222,87 @@ sub uncache {
$cache->delete; $cache->delete;
} }
#----------------------------------------------------------------------------
=head2 update ( properties )
Update properties for the user. C<properties> is a hash reference of user properties
and/or profile fields.
Valid user properties:
authMethod
dateCreated
friendsGroup
karma - NOTE: To add karma, use the karma() method
lastUpdated
referringAffiliate
status - One of "Activated", "Deactivated", or "Selfdestructed"
username
Anything else is a profile field.
=cut
sub update {
my ( $self, $properties ) = @_;
my $session = $self->session;
my $db = $session->db;
# Make a safe copy of properties, we'll be deleting from it
$properties = { %$properties };
$self->uncache;
$properties->{lastUpdated} ||= time;
# $self->{_user} contains all fields in `users` table
my @userFields = ();
my @userValues = ();
for my $key ( keys %{$self->{_user}} ) {
if ( exists $properties->{$key} ) {
# Delete the value because it's not a profile field
my $value = delete $properties->{$key};
push @userFields, $db->dbh->quote_identifier( $key ) . " = ?";
push @userValues, $value;
$self->{_user}->{$key} = $value;
}
}
# No matter what we update properties
my $userFields = join ", ", @userFields;
$db->write(
"UPDATE users SET $userFields WHERE userId=?",
[@userValues, $self->{_userId}]
);
# Everything else must be a profile field
my @profileFields = ();
my @profileValues = ();
for my $key ( keys %{$properties} ) {
if (!exists $self->{_profile}{$key} && !WebGUI::ProfileField->exists($session,$key)) {
$self->session->errorHandler->warn("No such profile field: $key");
next;
}
push @profileFields, $db->dbh->quote_identifier( $key ) . " = ?";
push @profileValues, $properties->{ $key };
$self->{_profile}->{$key} = $properties->{ $key };
}
if ( @profileFields ) {
my $profileFields = join ", ", @profileFields;
$db->write(
"UPDATE userProfileData SET $profileFields WHERE userId=?",
[@profileValues, $self->{_userId}]
);
}
return;
}
#------------------------------------------------------------------- #-------------------------------------------------------------------
=head2 updateProfileFields ( profile ) =head2 updateProfileFields ( profile )
DEPRECATED! Use update(profile)
Saves profile data to a user's profile. Does not validate any of the data. Saves profile data to a user's profile. Does not validate any of the data.
=head3 profile =head3 profile
@ -1129,15 +1315,14 @@ sub updateProfileFields {
my $self = shift; my $self = shift;
my $profile = shift; my $profile = shift;
foreach my $fieldName (keys %{$profile}) { $self->update($profile);
$self->profileField($fieldName,$profile->{$fieldName});
}
} }
#------------------------------------------------------------------- #-------------------------------------------------------------------
=head2 username ( [ value ] ) =head2 username ( [ value ] )
DEPRECATED! Use get("username") and update({ username => "value" }) instead.
Returns the username. Returns the username.
=head3 value =head3 value
@ -1150,25 +1335,23 @@ sub username {
my $self = shift; my $self = shift;
my $value = shift; my $value = shift;
if (defined $value) { if (defined $value) {
$self->uncache; $self->update({ username => $value });
$self->{_user}{"username"} = $value;
$self->{_user}{"lastUpdated"} = $self->session->datetime->time();
$self->session->db->write("update users set username=?, lastUpdated=? where userId=?",
[$value, $self->session->datetime->time(), $self->userId]);
} }
return $self->{_user}{"username"}; return $self->get("username");
} }
#------------------------------------------------------------------- #-------------------------------------------------------------------
=head2 userId ( ) =head2 userId ( )
DEPRECATED: Use getId() instead!
Returns the userId for this user. Returns the userId for this user.
=cut =cut
sub userId { sub userId {
return $_[0]->{_userId}; return $_[0]->getId;
} }
#------------------------------------------------------------------- #-------------------------------------------------------------------

159
t/User.t
View file

@ -20,7 +20,7 @@ use WebGUI::Cache;
use WebGUI::User; use WebGUI::User;
use WebGUI::ProfileField; use WebGUI::ProfileField;
use Test::More tests => 203; # increment this value for each test you create use Test::More tests => 211; # increment this value for each test you create
use Test::Deep; use Test::Deep;
use Data::Dumper; use Data::Dumper;
@ -54,6 +54,16 @@ foreach my $groupId (2,7) {
ok($user->isInGroup($groupId), "User added to group $groupId by default"); ok($user->isInGroup($groupId), "User added to group $groupId by default");
} }
################################################################
#
# enable/disable
#
################################################################
# NOTE: enable/disable replaces all functionality of the status() method.
# We're keeping status() until we can remove it later
# Enable/disable is tested by the status()
#Let's check the status method #Let's check the status method
$user->status('Active'); $user->status('Active');
$lastUpdate = time(); $lastUpdate = time();
@ -63,9 +73,152 @@ cmp_ok(abs($user->lastUpdated-$lastUpdate), '<=', 1, 'lastUpdated() -- status ch
$user->status('Selfdestructed'); $user->status('Selfdestructed');
is($user->status, "Selfdestructed", 'status("Selfdestructed")'); is($user->status, "Selfdestructed", 'status("Selfdestructed")');
# Deactivation user deletes all sessions and scratches
my $newSession = WebGUI::Session->open( WebGUI::Test->root, WebGUI::Test->file );
$newSession->user({ user => $user });
$newSession->scratch->set("hasStapler" => "no");
$user->status('Deactivated'); $user->status('Deactivated');
is($user->status, "Deactivated", 'status("Deactivated")'); is($user->status, "Deactivated", 'status("Deactivated")');
ok(
!$session->db->quickScalar("SELECT COUNT(*) from userSession where userId=?",[$user->userId]),
"Deactivating user deletes all sessions",
);
ok(
!$session->db->quickScalar("SELECT COUNT(*) FROM userSessionScratch WHERE sessionId=?",[$session->getId]),
"Deactivating user deletes all user session scratch",
);
$newSession->close;
################################################################
#
# get/update
#
################################################################
# NOTE: get/set replaces the following methods, but we're leaving
# the tests for the deprecated methods until they get removed, since
# they test the get/update methods thoroughly
# - authMethod
# - dateCreated
# - lastUpdated
# - profileField
# - referringAffiliate
# - status
# - updateProfileFields
# - username
# - getId
my $now = time;
$user->update({
username => "jlumbe",
firstName => "John",
lastName => "Lumbergh",
lastUpdated => $now,
});
is(
$session->db->quickScalar("SELECT username FROM users WHERE userId=?",[$user->getId]),
"jlumbe",
"update() updates username",
);
is(
$user->get('username'),
"jlumbe",
"update() updates get('username')",
);
is(
$session->db->quickScalar("SELECT lastUpdated FROM users WHERE userId=?",[$user->getId]),
$now,
"update() updates lastUpdated",
);
is(
$user->get('lastUpdated'),
$now,
"update() updates get('lastUpdated')",
);
is(
$session->db->quickScalar("SELECT firstName FROM userProfileData WHERE userId=?",[$user->getId]),
"John",
"update() updates profile firstName",
);
is(
$user->get('firstName'),
"John",
"update() updates get('firstName')",
);
is(
$session->db->quickScalar("SELECT lastName FROM userProfileData WHERE userId=?",[$user->getId]),
"Lumbergh",
"update() updates profile lastName",
);
is(
$user->get('lastName'),
"Lumbergh",
"update() updates get('lastName')",
);
sleep 1;
ok(
eval { $user->update({ lastNameIsNotExistingInThisContext => "Lumberg" }); 1; },
"update() doesn't die with invalid field",
);
ok(
$session->db->quickScalar("SELECT lastUpdated FROM users WHERE userId=?",[$user->getId])
> $now,
"update() updates lastUpdated automatically",
);
ok(
$user->get('lastUpdated') > $now,
"update() updates get('lastUpdated') automatically",
);
$user->update({ lastName => "Lumberg" }),
is(
$session->db->quickScalar("SELECT lastName FROM userProfileData WHERE userId=?",[$user->getId]),
"Lumberg",
"update() updates lastName again",
);
is(
$user->get("lastName"),
"Lumberg",
"update() updates get('lastName') again",
);
# get w/o arguments returns hashref of everything
my $expectValues = {
username => "jlumbe",
firstName => "John",
lastName => "Lumberg",
status => "Deactivated",
timeZone => 'America/Chicago',
gender => 'neuter',
toolbar => 'useLanguageDefault',
};
# expects all user properties and all profile fields
my @expectFields = (
$session->db->buildArray('DESCRIBE users'),
$session->db->buildArray('SELECT fieldName FROM userProfileField'),
);
cmp_deeply(
[keys %{$user->get}], bag(@expectFields),
"get() contains all properties and profileFields",
);
cmp_deeply(
$user->get, superhashof($expectValues),
"get() contains known correct values",
);
################################################################ ################################################################
# #
# profileField # profileField
@ -85,9 +238,9 @@ is($user->profileField('notAProfileField'), undef, 'getting non-existant profile
my $newProfileField = WebGUI::ProfileField->create($session, 'testField', {dataDefault => 'this is a test'}); my $newProfileField = WebGUI::ProfileField->create($session, 'testField', {dataDefault => 'this is a test'});
is($user->profileField('testField'), 'this is a test', 'getting profile fields not cached in the user object returns the profile field default'); is($user->profileField('testField'), 'this is a test', 'getting profile fields not cached in the user object returns the profile field default');
is($user->profileField('wg_privacySettings'), '', '... wg_privacySettings may not be retrieved'); ok(!$user->profileField('wg_privacySettings'), '... wg_privacySettings may not be retrieved');
$user->profileField('wg_privacySettings', '{"email"=>"all"}'); $user->profileField('wg_privacySettings', '{"email"=>"all"}');
is($user->profileField('wg_privacySettings'), '', '... wg_privacySettings may not be set'); ok(!$user->profileField('wg_privacySettings'), '... wg_privacySettings may not be set');
################################################################ ################################################################
# #