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

Fixed whitespace screwing up POD

Browse source
This commit is contained in:
Wouter van Oijen 2006-05-20 08:43:16 +00:00
parent a880b058a5
commit 448448e451
2 changed files with 182 additions and 187 deletions
Download patch file Download diff file Expand all files Collapse all files

228
lib/WebGUI/Auth.pm
View file

@ -72,28 +72,28 @@ Validates the username passed in.
=cut =cut
sub _isValidUsername { sub _isValidUsername {
my $self = shift; my $self = shift;
my $username = shift; my $username = shift;
my $error = ""; my $error = "";
return 1 if($self->userId ne "1" && $self->session->user->username eq $username); return 1 if($self->userId ne "1" && $self->session->user->username eq $username);
my $i18n = WebGUI::International->new($self->session); my $i18n = WebGUI::International->new($self->session);
if ($username =~ /^\s/ || $username =~ /\s$/) { if ($username =~ /^\s/ || $username =~ /\s$/) {
$error .= '<li>'.$i18n->get(724).'</li>'; $error .= '<li>'.$i18n->get(724).'</li>';
} }
if ($username eq "") { if ($username eq "") {
$error .= '<li>'.$i18n->get(725).'</li>'; $error .= '<li>'.$i18n->get(725).'</li>';
} }
$self->error($error); $self->error($error);
return $error eq ""; return $error eq "";
} }
#------------------------------------------------------------------- #-------------------------------------------------------------------
sub _logLogin { sub _logLogin {
my $self = shift; my $self = shift;
$self->session->db->write("insert into userLoginLog values (".$self->session->db->quote($_[0]).",".$self->session->db->quote($_[1]).",".$self->session->datetime->time()."," $self->session->db->write("insert into userLoginLog values (".$self->session->db->quote($_[0]).",".$self->session->db->quote($_[1]).",".$self->session->datetime->time().","
.$self->session->db->quote($self->session->env->get("REMOTE_ADDR")).",".$self->session->db->quote($self->session->env->get("HTTP_USER_AGENT")).")"); .$self->session->db->quote($self->session->env->get("REMOTE_ADDR")).",".$self->session->db->quote($self->session->env->get("HTTP_USER_AGENT")).")");
} }
@ -106,7 +106,7 @@ Creates elements for the add user form specific to this Authentication Method.
=cut =cut
sub addUserForm { sub addUserForm {
#Added for interface purposes only. Needs to be implemented in the subclass. #Added for interface purposes only. Needs to be implemented in the subclass.
} }
#------------------------------------------------------------------- #-------------------------------------------------------------------
@ -118,8 +118,8 @@ Saves user elements unique to this authentication method
=cut =cut
sub addUserFormSave { sub addUserFormSave {
my $self = shift; my $self = shift;
$self->saveParams(($_[1] || $self->userId),$self->authMethod,$_[0]); $self->saveParams(($_[1] || $self->userId),$self->authMethod,$_[0]);
} }
#------------------------------------------------------------------- #-------------------------------------------------------------------
@ -131,24 +131,24 @@ Superclass method that performs standard login routines. This method returns tr
=cut =cut
sub authenticate { sub authenticate {
my $self = shift; my $self = shift;
my $username = shift; my $username = shift;
my $i18n = WebGUI::International->new($self->session); my $i18n = WebGUI::International->new($self->session);
my $user = $self->session->db->quickHashRef("select userId,authMethod,status from users where username=".$self->session->db->quote($username)); my $user = $self->session->db->quickHashRef("select userId,authMethod,status from users where username=".$self->session->db->quote($username));
my $uid = $user->{userId}; my $uid = $user->{userId};
#If userId does not exist or is not active, fail login #If userId does not exist or is not active, fail login
if(!$uid){ if (!$uid) {
$self->error($i18n->get(68)); $self->error($i18n->get(68));
return 0; return 0;
} elsif($user->{status} ne 'Active'){ } elsif($user->{status} ne 'Active') {
$self->error($i18n->get(820)); $self->error($i18n->get(820));
$self->_logLogin($uid, "failure"); $self->_logLogin($uid, "failure");
return 0; return 0;
} }
#Set User Id #Set User Id
$self->user(WebGUI::User->new($self->session,$uid)); $self->user(WebGUI::User->new($self->session,$uid));
return 1; return 1;
} }
#------------------------------------------------------------------- #-------------------------------------------------------------------
@ -164,9 +164,9 @@ Gets or sets the authMethod in the Auth Object
=cut =cut
sub authMethod { sub authMethod {
my $self = shift; my $self = shift;
return $self->{authMethod} if(!$_[0]); return $self->{authMethod} if(!$_[0]);
$self->{authMethod} = $_[0]; $self->{authMethod} = $_[0];
} }
#------------------------------------------------------------------- #-------------------------------------------------------------------
@ -200,10 +200,10 @@ sub createAccount {
$vars->{'create.form.profile'} = WebGUI::Operation::Profile::getRequiredProfileFields($self->session); $vars->{'create.form.profile'} = WebGUI::Operation::Profile::getRequiredProfileFields($self->session);
$vars->{'create.form.submit'} = WebGUI::Form::submit($self->session,{}); $vars->{'create.form.submit'} = WebGUI::Form::submit($self->session,{});
$vars->{'create.form.footer'} = WebGUI::Form::formFooter($self->session,); $vars->{'create.form.footer'} = WebGUI::Form::formFooter($self->session,);
$vars->{'login.url'} = $self->session->url->page('op=auth;method=init'); $vars->{'login.url'} = $self->session->url->page('op=auth;method=init');
$vars->{'login.label'} = $i18n->get(58); $vars->{'login.label'} = $i18n->get(58);
$vars->{'login.url'} = $self->session->url->page('op=auth;method=init'); $vars->{'login.url'} = $self->session->url->page('op=auth;method=init');
$vars->{'login.label'} = $i18n->get(58); $vars->{'login.label'} = $i18n->get(58);
@ -333,8 +333,8 @@ Removes the user's authentication parameters from the database for all authentic
=cut =cut
sub deleteParams { sub deleteParams {
my $self = shift; my $self = shift;
$self->session->db->write("delete from authentication where userId=".$self->session->db->quote($self->userId)); $self->session->db->write("delete from authentication where userId=".$self->session->db->quote($self->userId));
} }
#------------------------------------------------------------------- #-------------------------------------------------------------------
@ -354,25 +354,25 @@ Array ref of template vars from subclass
=cut =cut
sub displayAccount { sub displayAccount {
my $self = shift; my $self = shift;
my $method = $_[0]; my $method = $_[0];
my $vars = $_[1]; my $vars = $_[1];
my $i18n = WebGUI::International->new($self->session); my $i18n = WebGUI::International->new($self->session);
$vars->{title} = $i18n->get(61); $vars->{title} = $i18n->get(61);
$vars->{'account.form.header'} = WebGUI::Form::formHeader($self->session,{}); $vars->{'account.form.header'} = WebGUI::Form::formHeader($self->session,{});
$vars->{'account.form.header'} .= WebGUI::Form::hidden($self->session,{"name"=>"op","value"=>"auth"}); $vars->{'account.form.header'} .= WebGUI::Form::hidden($self->session,{"name"=>"op","value"=>"auth"});
$vars->{'account.form.header'} .= WebGUI::Form::hidden($self->session,{"name"=>"method","value"=>$method}); $vars->{'account.form.header'} .= WebGUI::Form::hidden($self->session,{"name"=>"method","value"=>$method});
if($self->session->setting->get("useKarma")){ if ($self->session->setting->get("useKarma")) {
$vars->{'account.form.karma'} = $self->session->user->karma; $vars->{'account.form.karma'} = $self->session->user->karma;
$vars->{'account.form.karma.label'} = $i18n->get(537); $vars->{'account.form.karma.label'} = $i18n->get(537);
} }
$vars->{'account.form.submit'} = WebGUI::Form::submit($self->session,{}); $vars->{'account.form.submit'} = WebGUI::Form::submit($self->session,{});
$vars->{'account.form.footer'} = WebGUI::Form::formFooter($self->session,); $vars->{'account.form.footer'} = WebGUI::Form::formFooter($self->session,);
$vars->{'account.options'} = WebGUI::Operation::Shared::accountOptions($self->session); $vars->{'account.options'} = WebGUI::Operation::Shared::accountOptions($self->session);
return WebGUI::Asset::Template->new($self->session,$self->getAccountTemplateId)->process($vars); return WebGUI::Asset::Template->new($self->session,$self->getAccountTemplateId)->process($vars);
} }
#------------------------------------------------------------------- #-------------------------------------------------------------------
@ -429,7 +429,7 @@ Creates user form elements specific to this Auth Method.
=cut =cut
sub editUserForm { sub editUserForm {
#Added for interface purposes only. Needs to be implemented in the subclass. #Added for interface purposes only. Needs to be implemented in the subclass.
} }
#------------------------------------------------------------------- #-------------------------------------------------------------------
@ -441,8 +441,8 @@ Saves user elements unique to this authentication method
=cut =cut
sub editUserFormSave { sub editUserFormSave {
my $self = shift; my $self = shift;
$self->saveParams($self->userId,$self->authMethod,$_[0]); $self->saveParams($self->userId,$self->authMethod,$_[0]);
} }
#------------------------------------------------------------------- #-------------------------------------------------------------------
@ -454,9 +454,9 @@ Sets or returns the error currently stored in the object
=cut =cut
sub error { sub error {
my $self = shift; my $self = shift;
return $self->{error} if (!$_[0]); return $self->{error} if (!$_[0]);
$self->{error} = $_[0]; $self->{error} = $_[0];
} }
#------------------------------------------------------------------- #-------------------------------------------------------------------
@ -504,7 +504,7 @@ Returns a hash reference with the user's authentication information. This metho
=cut =cut
sub getParams { sub getParams {
my $self = shift; my $self = shift;
my $userId = $_[0] || $self->userId; my $userId = $_[0] || $self->userId;
my $authMethod = $_[1] || $self->authMethod; my $authMethod = $_[1] || $self->authMethod;
return $self->session->db->buildHashRef("select fieldName, fieldData from authentication where userId=".$self->session->db->quote($userId)." and authMethod=".$self->session->db->quote($authMethod)); return $self->session->db->buildHashRef("select fieldName, fieldData from authentication where userId=".$self->session->db->quote($userId)." and authMethod=".$self->session->db->quote($authMethod));
@ -539,8 +539,8 @@ Override this method in your subclass to change the initialization for custom au
=cut =cut
sub init { sub init {
my $self = shift; my $self = shift;
return $self->displayLogin; return $self->displayLogin;
} }
#------------------------------------------------------------------- #-------------------------------------------------------------------
@ -552,8 +552,8 @@ Returns whether or not a method is callable
=cut =cut
sub isCallable { sub isCallable {
my $self = shift; my $self = shift;
return isIn($_[0],@{$self->{callable}}) return isIn($_[0],@{$self->{callable}})
} }
@ -567,20 +567,20 @@ Authentication should always happen in the subclass routine.
=cut =cut
sub login { sub login {
my $self = shift; my $self = shift;
my ($cmd, $uid, $u, $authMethod,$msg,$userData,$expireDate); my ($cmd, $uid, $u, $authMethod,$msg,$userData,$expireDate);
#Create a new user #Create a new user
$uid = $self->userId; $uid = $self->userId;
$u = WebGUI::User->new($self->session,$uid); $u = WebGUI::User->new($self->session,$uid);
$self->session->user({user=>$u}); $self->session->user({user=>$u});
$u->karma($self->session->setting->get("karmaPerLogin"),"Login","Just for logging in.") if ($self->session->setting->get("useKarma")); $u->karma($self->session->setting->get("karmaPerLogin"),"Login","Just for logging in.") if ($self->session->setting->get("useKarma"));
$self->_logLogin($uid,"success"); $self->_logLogin($uid,"success");
if ($self->session->scratch->get("redirectAfterLogin")) { if ($self->session->scratch->get("redirectAfterLogin")) {
$self->session->http->setRedirect($self->session->scratch->get("redirectAfterLogin")); $self->session->http->setRedirect($self->session->scratch->get("redirectAfterLogin"));
$self->session->scratch->delete("redirectAfterLogin"); $self->session->scratch->delete("redirectAfterLogin");
} }
return ""; return "";
} }
#------------------------------------------------------------------- #-------------------------------------------------------------------
@ -593,11 +593,11 @@ Superclass method that performs standard logout routines.
sub logout { sub logout {
my $self = shift; my $self = shift;
$self->session->var->end($self->session->var->get("sessionId")); $self->session->var->end($self->session->var->get("sessionId"));
$self->session->user({userId=>'1'}); $self->session->user({userId=>'1'});
my $u = WebGUI::User->new($self->session,1); my $u = WebGUI::User->new($self->session,1);
$self->{user} = $u; $self->{user} = $u;
return ""; return "";
} }
#------------------------------------------------------------------- #-------------------------------------------------------------------
@ -650,13 +650,11 @@ Sets or returns the Profile hash for a user.
=cut =cut
sub profile { sub profile {
my $self = shift; my $self = shift;
return $self->{profile} if ($_[0]); return $self->{profile} if ($_[0]);
$self->{profile} = $_[0]; $self->{profile} = $_[0];
} }
#------------------------------------------------------------------- #-------------------------------------------------------------------
sub session { sub session {
@ -678,9 +676,9 @@ Array reference containing a list of methods for this authentication instance th
=cut =cut
sub setCallable { sub setCallable {
my $self = shift; my $self = shift;
my @callable = @{$self->{callable}}; my @callable = @{$self->{callable}};
@callable = (@callable,@{$_[0]}); @callable = (@callable,@{$_[0]});
} }
#------------------------------------------------------------------- #-------------------------------------------------------------------
@ -704,12 +702,12 @@ A hash reference containing parameter names and values to be saved.
=cut =cut
sub saveParams { sub saveParams {
my $self = shift; my $self = shift;
my ($uid, $authMethod, $data) = @_; my ($uid, $authMethod, $data) = @_;
foreach (keys %{$data}) { foreach (keys %{$data}) {
$self->session->db->write("delete from authentication where userId=".$self->session->db->quote($uid)." and authMethod=".$self->session->db->quote($authMethod)." and fieldName=".$self->session->db->quote($_)); $self->session->db->write("delete from authentication where userId=".$self->session->db->quote($uid)." and authMethod=".$self->session->db->quote($authMethod)." and fieldName=".$self->session->db->quote($_));
$self->session->db->write("insert into authentication (userId,authMethod,fieldData,fieldName) values (".$self->session->db->quote($uid).",".$self->session->db->quote($authMethod).",".$self->session->db->quote($data->{$_}).",".$self->session->db->quote($_).")"); $self->session->db->write("insert into authentication (userId,authMethod,fieldData,fieldName) values (".$self->session->db->quote($uid).",".$self->session->db->quote($authMethod).",".$self->session->db->quote($data->{$_}).",".$self->session->db->quote($_).")");
} }
} }
#------------------------------------------------------------------- #-------------------------------------------------------------------
@ -721,9 +719,9 @@ Sets or Returns the user object stored in the wobject
=cut =cut
sub user { sub user {
my $self = shift; my $self = shift;
return $self->{user} if (!$_[0]); return $self->{user} if (!$_[0]);
$self->{user} = $_[0]; $self->{user} = $_[0];
} }
#------------------------------------------------------------------- #-------------------------------------------------------------------
@ -735,9 +733,9 @@ Returns the userId currently stored in the object
=cut =cut
sub userId { sub userId {
my $self = shift; my $self = shift;
my $u = $self->user; my $u = $self->user;
return $u->userId; return $u->userId;
} }
#------------------------------------------------------------------- #-------------------------------------------------------------------
@ -749,9 +747,9 @@ Returns the username currently stored in the object
=cut =cut
sub username { sub username {
my $self = shift; my $self = shift;
my $u = $self->user; my $u = $self->user;
return $u->username; return $u->username;
} }
#------------------------------------------------------------------- #-------------------------------------------------------------------
@ -763,21 +761,21 @@ Validates the a username.
=cut =cut
sub validUsername { sub validUsername {
my $self = shift; my $self = shift;
my $username = shift; my $username = shift;
WebGUI::Macro::negate(\$username); WebGUI::Macro::negate(\$username);
my $error = ""; my $error = "";
if($self->_isDuplicateUsername($username)){ if ($self->_isDuplicateUsername($username)) {
$error .= $self->error; $error .= $self->error;
} }
if(!$self->_isValidUsername($username)){ if (!$self->_isValidUsername($username)) {
$error .= $self->error; $error .= $self->error;
} }
$self->error($error); $self->error($error);
return $error eq ""; return $error eq "";
} }
#------------------------------------------------------------------- #-------------------------------------------------------------------
@ -789,9 +787,9 @@ Sets or Returns a warning in the object
=cut =cut
sub warning { sub warning {
my $self = shift; my $self = shift;
return $self->{warning} if (!$_[0]); return $self->{warning} if (!$_[0]);
$self->{warning} = $_[0]; $self->{warning} = $_[0];
} }
1; 1;

3
lib/WebGUI/Storage.pm
View file

@ -685,7 +685,6 @@ sub getUrl {
return $url; return $url;
} }
#------------------------------------------------------------------- #-------------------------------------------------------------------
=head2 renameFile ( filename, newFilename ) =head2 renameFile ( filename, newFilename )
@ -817,5 +816,3 @@ sub untar {
1; 1;