Initial import
This commit is contained in:
Yung Han Khoe
parent
606d4c12e9
commit
3c176de33a
1 changed files with 419 additions and 0 deletions
419
lib/WebGUI/Asset/Wobject/UserList.pm
Normal file
419
lib/WebGUI/Asset/Wobject/UserList.pm
Normal file
|
|
@ -0,0 +1,419 @@
|
|||
package WebGUI::Asset::Wobject::UserList;
|
||||
|
||||
#$VERSION = "2.0.0";
|
||||
|
||||
use strict;
|
||||
use warnings;
|
||||
use HTML::Entities;
|
||||
use Tie::CPHash;
|
||||
use Tie::IxHash;
|
||||
use WebGUI::Utility;
|
||||
use WebGUI::Asset::Wobject;
|
||||
use WebGUI::Operation::Shared;
|
||||
use WebGUI::International;
|
||||
|
||||
our @ISA = qw(WebGUI::Asset::Wobject);
|
||||
|
||||
=head1 LEGAL
|
||||
|
||||
Copyright 2004-2008 United Knowledge
|
||||
|
||||
See the doc/license-UserList.txt file for licensing information.
|
||||
|
||||
http://www.unitedknowledge.nl
|
||||
developmentinfo@unitedknowledge.nl
|
||||
|
||||
=head1 NAME
|
||||
|
||||
Package WebGUI::Asset::Wobject::UserList
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
This wobject gives a list of webgui users.
|
||||
The username is always shown.
|
||||
The userId is only shown in Admin mode.
|
||||
The wobject also checks the publicProfile and publicEmail setting for each user.
|
||||
|
||||
=head1 SYNOPSIS
|
||||
|
||||
my $wobject = WebGUI::Wobject::UserList->new(\%properties);
|
||||
|
||||
$text = $wobject->name;
|
||||
|
||||
$html = $wobject->www_edit;
|
||||
$html = $wobject->www_view;
|
||||
|
||||
=cut
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getAlphabetSearchLoop ( )
|
||||
|
||||
Returns an array ref that contains tmpl_vars for the Alphabet Search.
|
||||
|
||||
=cut
|
||||
|
||||
sub getAlphabetSearchLoop {
|
||||
my $self = shift;
|
||||
my $fieldName = shift;
|
||||
my $alphabet = shift;
|
||||
my (@alphabet, @alphabetLoop);
|
||||
$alphabet ||= "a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u,v,w,x,y,z";
|
||||
@alphabet = split(/,/,$alphabet);
|
||||
foreach my $letter (@alphabet){
|
||||
my $htmlEncodedLetter = encode_entities($letter);
|
||||
#print "adding letter ".$letter.",htmlEncodedLetter: $htmlEncodedLetter<br>";
|
||||
my $searchURL = "?searchExact_".$fieldName."=".$letter."%25";
|
||||
my $hasResults = $self->session->db->quickScalar("select if ("
|
||||
."(select count(*) from userProfileData where lastName like '".$letter."%')<>0, 1, 0)");
|
||||
push @alphabetLoop, {
|
||||
label => $htmlEncodedLetter || $letter,
|
||||
hasResults => $hasResults,
|
||||
searchURL => $searchURL,
|
||||
}
|
||||
}
|
||||
return \@alphabetLoop;
|
||||
}
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 definition ( properties )
|
||||
|
||||
Defines wobject properties for UserList instances.
|
||||
|
||||
=head3 properties
|
||||
|
||||
A hash reference containing the properties of this wobject.
|
||||
|
||||
=cut
|
||||
|
||||
sub definition {
|
||||
my $class = shift;
|
||||
my $session = shift;
|
||||
my $definition = shift;
|
||||
my %properties;
|
||||
my $i18n = WebGUI::International->new($session, 'Asset_UserList');
|
||||
tie %properties, 'Tie::IxHash';
|
||||
%properties = (
|
||||
templateId =>{
|
||||
fieldType=>"template",
|
||||
defaultValue=>'UserListTmpl0000001',
|
||||
namespace=>'UserList',
|
||||
tab=>"display",
|
||||
},
|
||||
|
||||
showGroupId=>{
|
||||
fieldType=>"group",
|
||||
defaultValue=>"",
|
||||
label=>$i18n->get("Group to show"),
|
||||
tab=>"display",
|
||||
},
|
||||
hideGroupId=>{
|
||||
fieldType=>"group",
|
||||
defaultValue=>"",
|
||||
label=>$i18n->get("Group to hide"),
|
||||
tab=>"display",
|
||||
},
|
||||
usersPerPage=>{
|
||||
fieldType=>"integer",
|
||||
defaultValue=>"25",
|
||||
tab=>"display",
|
||||
label=>'Users per Page',
|
||||
},
|
||||
alphabet=>{
|
||||
fieldType=>"text",
|
||||
defaultValue=>"",
|
||||
tab=>"display",
|
||||
label=>'Alphabet',
|
||||
},
|
||||
);
|
||||
|
||||
push(@{$definition}, {
|
||||
assetName=>"UserList",
|
||||
icon=>'userlist.gif',
|
||||
autoGenerateForms=>1,
|
||||
tableName=>'UserList',
|
||||
className=>'WebGUI::Asset::Wobject::UserList',
|
||||
properties=>\%properties
|
||||
});
|
||||
return $class->SUPER::definition($session, $definition);
|
||||
}
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 getEditForm ( )
|
||||
|
||||
Returns a tab form containing the properties of this wobject.
|
||||
|
||||
=cut
|
||||
|
||||
sub getEditForm {
|
||||
my $self = shift;
|
||||
my $tabform = $self->SUPER::getEditForm();
|
||||
|
||||
my $i18n = WebGUI::International->new($self->session, "Asset_UserList");
|
||||
|
||||
return $tabform;
|
||||
}
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 isInGroup ( [ groupId ] )
|
||||
|
||||
Returns a boolean (0|1) value signifying that the user has the required privileges. Always returns true for Admins.
|
||||
The UserList Wobject has its own isInGroup method for performance reasons, instead of using the WebGUI::User API.
|
||||
To use the API a User object would have to be created for every user. This in turn would mean to unnessecary hits on the
|
||||
database.
|
||||
|
||||
=head3 groupId
|
||||
|
||||
The group that you wish to verify against the user. Defaults to group with Id 3 (the Admin group).
|
||||
|
||||
=cut
|
||||
|
||||
sub isInGroup {
|
||||
my (@data, $groupId);
|
||||
my ($self, $gid, $uid, $secondRun) = @_;
|
||||
$gid = 3 unless (defined $gid);
|
||||
### The following several checks are to increase performance. If this section were removed, everything would continue to work as normal.
|
||||
#my $eh = $self->session->errorHandler;
|
||||
#$eh->warn("Group Id is: $gid for ".$tgroup->name);
|
||||
return 1 if ($gid eq '7'); # everyone is in the everyone group
|
||||
return 1 if ($gid eq '1' && $uid eq '1'); # visitors are in the visitors group
|
||||
return 1 if ($gid eq '2' && $uid ne '1'); # if you're not a visitor, then you're a registered user
|
||||
### Get data for auxillary checks.
|
||||
my $isInGroup = $self->session->stow->get("isInGroup");
|
||||
### Look to see if we've already looked up this group.
|
||||
return $isInGroup->{$uid}{$gid} if exists $isInGroup->{$uid}{$gid};
|
||||
### Lookup the actual groupings.
|
||||
my $group = WebGUI::Group->new($self->session,$gid);
|
||||
# Cope with non-existant groups. Default to the admin group if the groupId is invalid.
|
||||
$group = WebGUI::Group->new($self->session, 3) unless $group;
|
||||
### Check for groups of groups.
|
||||
my $users = $group->getAllUsers();
|
||||
foreach my $user (@{$users}) {
|
||||
$isInGroup->{$user}{$gid} = 1;
|
||||
if ($uid eq $user) {
|
||||
$self->session->stow->set("isInGroup",$isInGroup);
|
||||
return 1;
|
||||
}
|
||||
}
|
||||
$isInGroup->{$uid}{$gid} = 0;
|
||||
$self->session->stow->set("isInGroup",$isInGroup);
|
||||
return 0;
|
||||
}
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 prepareView ( )
|
||||
|
||||
See WebGUI::Asset::prepareView() for details.
|
||||
|
||||
=cut
|
||||
|
||||
sub prepareView {
|
||||
my $self = shift;
|
||||
$self->SUPER::prepareView();
|
||||
my $templateId = $self->get("templateId");
|
||||
if ($self->session->form->process("overrideTemplateId") ne "") {
|
||||
$templateId = $self->session->form->process("overrideTemplateId");
|
||||
}
|
||||
my $template = WebGUI::Asset::Template->new($self->session, $templateId);
|
||||
$template->prepare;
|
||||
$self->{_viewTemplate} = $template;
|
||||
}
|
||||
|
||||
#-------------------------------------------------------------------
|
||||
|
||||
=head2 view ( )
|
||||
|
||||
=cut
|
||||
|
||||
sub view {
|
||||
|
||||
my $self = shift;
|
||||
my $i18n = WebGUI::International->new($self->session, "Asset_UserList");
|
||||
my (%var, @users, @profileField_loop, @profileFields,@profileFieldNames);
|
||||
my ($defaultPublicProfile, $defaultPublicEmail, $user, $sth, $sql, $profileField);
|
||||
my $error = $self->session->errorHandler;
|
||||
my $start_time = time();
|
||||
|
||||
# $error->info("time :".(time() - $start_time));
|
||||
|
||||
$sth = $self->session->db->read("SELECT field.fieldName, field.label, field.sequenceNumber "
|
||||
."FROM userProfileField as field "
|
||||
."left join userProfileCategory as category USING(profileCategoryId) "
|
||||
."ORDER BY category.sequenceNumber, field.sequenceNumber");
|
||||
while ($profileField = $sth->hashRef){
|
||||
my $label = WebGUI::Operation::Shared::secureEval($self->session,$profileField->{label});
|
||||
push(@profileFields, {
|
||||
"fieldName"=>$profileField->{fieldName},
|
||||
"label"=>$label,
|
||||
"sequenceNumber"=>$profileField->{sequenceNumber},
|
||||
});
|
||||
push(@profileFieldNames, $profileField->{fieldName});
|
||||
$var{'profileField_'.$profileField->{fieldName}.'_label'} = $label;
|
||||
}
|
||||
|
||||
# $error->info("selected profile fields, time :".(time() - $start_time));
|
||||
$sql = "select distinct users.userId, users.userName, userProfileData.publicProfile, userProfileData.publicEmail ";
|
||||
|
||||
foreach my $profileField (@profileFields){
|
||||
$sql .= ", userProfileData.$profileField->{fieldName}";
|
||||
}
|
||||
$sql .= " from users";
|
||||
$sql .= " left join userProfileData using(userId) where users.userId != '1'";
|
||||
|
||||
# $error->info("creating constraint, time :".(time() - $start_time));
|
||||
my $constraint;
|
||||
if ($self->session->form->process('search')){
|
||||
$constraint = "(".join(' or ', map {'userProfileData.'.$_->{fieldName}.' like "%'.$self->session->form->process('search').'%"'} @profileFields).")";
|
||||
}elsif ($self->session->form->process('searchExact')){
|
||||
$constraint = "(".join(' or ', map {'userProfileData.'.$_->{fieldName}.' like "'.$self->session->form->process('searchExact').'"'} @profileFields).")";
|
||||
}else{
|
||||
my @profileSearchFields = ();
|
||||
my @profileSearchExactFields = ();
|
||||
foreach my $profileField (@profileFields){
|
||||
if ($self->session->form->process('search_'.$profileField->{fieldName})){
|
||||
push(@profileSearchFields,$profileField);
|
||||
}
|
||||
if ($self->session->form->process('searchExact_'.$profileField->{fieldName})){
|
||||
push(@profileSearchExactFields,$profileField);
|
||||
}
|
||||
}
|
||||
my $searchType = $self->session->form->process('searchType') || 'or';
|
||||
if (scalar(@profileSearchFields) > 0){
|
||||
$constraint = "(".join(' '.$searchType.' ', map {'userProfileData.'.$_->{fieldName}.' like "%'
|
||||
.$self->session->form->process('search_'.$_->{fieldName}).'%"'} @profileSearchFields).")";
|
||||
foreach my $profileSearchField (@profileSearchFields){
|
||||
}
|
||||
}
|
||||
if (scalar(@profileSearchExactFields) > 0){
|
||||
$constraint = "(".join(' '.$searchType.' ', map {'userProfileData.'.$_->{fieldName}.' like"'
|
||||
.$self->session->form->process('searchExact_'.$_->{fieldName}).'"'} @profileSearchExactFields).")";
|
||||
}
|
||||
}
|
||||
$sql .= " and ".$constraint if ($constraint);
|
||||
|
||||
# $error->info("created constraint, time :".(time() - $start_time));
|
||||
|
||||
my $formOrderBy = $self->session->form->process('orderBy');
|
||||
my $orderBy = 'userName';
|
||||
my $orderType = $self->session->form->process('orderType') || 'asc';
|
||||
|
||||
my @orderByUserProperties = ('dateCreated', 'lastUpdated', 'karma', 'userId');
|
||||
if ($formOrderBy){
|
||||
if(isIn($formOrderBy,@profileFieldNames)){
|
||||
$orderBy = $formOrderBy;
|
||||
}elsif(isIn($formOrderBy,@orderByUserProperties)){
|
||||
$orderBy = 'users.'.$formOrderBy;
|
||||
}
|
||||
}
|
||||
$sql .= " order by ".$orderBy." ".$orderType;
|
||||
|
||||
($defaultPublicProfile) = $self->session->db->quickArray("SELECT dataDefault FROM userProfileField WHERE fieldName='publicProfile'");
|
||||
($defaultPublicEmail) = $self->session->db->quickArray("SELECT dataDefault FROM userProfileField WHERE fieldName='publicEmail'");
|
||||
|
||||
my $paginatePage = $self->session->form->param('pn') || 1;
|
||||
my $currentUrl = $self->getUrl();
|
||||
foreach ($self->session->form->param) {
|
||||
unless ($_ eq "pn" || $_ eq "op" || $_ eq "func" || $_ =~ /identifier/i || $_ =~ /password/i) {
|
||||
$currentUrl = $self->session->url->append($currentUrl, $self->session->url->escape($_)
|
||||
.'='.$self->session->url->escape($self->session->form->process($_)));
|
||||
}
|
||||
}
|
||||
|
||||
my $p = WebGUI::Paginator->new($self->session,$currentUrl,$self->getValue("usersPerPage"), undef, $paginatePage);
|
||||
|
||||
# $error->info("reading from database, time :".(time() - $start_time));
|
||||
$sth = $self->session->db->read($sql);
|
||||
# $error->info("users read from database, time :".(time() - $start_time));
|
||||
my @visibleUsers;
|
||||
while (my $user = $sth->hashRef){
|
||||
my $showGroupId = $self->get("showGroupId");
|
||||
if ($showGroupId eq '0' || ($showGroupId && $self->isInGroup($showGroupId,$user->{userId}))){
|
||||
unless ($self->get("hideGroupId") ne '0' && $self->isInGroup($self->get("hideGroupId"),$user->{userId})){
|
||||
push(@visibleUsers,$user);
|
||||
}
|
||||
}
|
||||
}
|
||||
# $error->info("applied group constraints, time :".(time() - $start_time));
|
||||
$p->setDataByArrayRef(\@visibleUsers);
|
||||
my $users = $p->getPageData($paginatePage);
|
||||
# $error->info("set data by page, time :".(time() - $start_time));
|
||||
foreach my $user (@$users){
|
||||
if ($user->{publicProfile} eq "1" || ($user->{publicProfile} eq "" && $defaultPublicProfile eq "1")){
|
||||
my (@profileFieldValues);
|
||||
my %userProperties;
|
||||
my $emailNotPublic;
|
||||
$emailNotPublic = 1 if ($user->{publicEmail} eq "0" || ($user->{publicEmail} eq "" && $defaultPublicEmail ne "1"));
|
||||
foreach my $profileField (@profileFields){
|
||||
if ($profileField->{fieldName} eq "email" && $emailNotPublic){
|
||||
push (@profileFieldValues, {
|
||||
"profile.emailNotPublic"=>1,
|
||||
});
|
||||
}else{
|
||||
push (@profileFieldValues, {
|
||||
"profile.value"=>$user->{$profileField->{fieldName}},
|
||||
});
|
||||
$userProperties{$profileField->{fieldName}.'_value'} = $user->{$profileField->{fieldName}};
|
||||
my $profileFieldName = $profileField->{fieldName};
|
||||
$profileFieldName =~ s/ /_/g;
|
||||
$userProperties{"user.profile.".$profileFieldName.".value"} = $user->{$profileField->{fieldName}};
|
||||
}
|
||||
}
|
||||
$userProperties{"user.profile.emailNotPublic"} = $emailNotPublic;
|
||||
$userProperties{"user.id"} = $user->{userId};
|
||||
$userProperties{"user.name"} = $user->{userName};
|
||||
$userProperties{"user.profile_loop"} = \@profileFieldValues;
|
||||
push(@users,\%userProperties);
|
||||
}else{
|
||||
push(@users, {
|
||||
"user.id"=>$user->{userId},
|
||||
"user.name"=>$user->{userName},
|
||||
});
|
||||
}
|
||||
}
|
||||
# $error->info("created tmpl vars for users, time :".(time() - $start_time));
|
||||
foreach my $profileField (@profileFields){
|
||||
push (@profileField_loop, {
|
||||
"profileField.label"=>WebGUI::Operation::Shared::secureEval($self->session,$profileField->{label}),
|
||||
});
|
||||
}
|
||||
$var{"numberOfProfileFields"} = scalar(@profileFields);
|
||||
$var{"profileNotPublic.message"} = $i18n->get("Profile not public");
|
||||
$var{"emailNotPublic.message"} = $i18n->get("Email not public");
|
||||
$var{profileField_loop} = \@profileField_loop;
|
||||
$var{user_loop} = \@users;
|
||||
$p->appendTemplateVars(\%var);
|
||||
|
||||
$var{searchFormHeader} = WebGUI::Form::formHeader($self->session,{action => $self->getUrl});
|
||||
$var{'searchFormTypeOr'} = WebGUI::Form::hidden($self->session, {name=>'searchType', value=>'or'});
|
||||
$var{'searchFormTypeAnd'} = WebGUI::Form::hidden($self->session, {name=>'searchType', value=>'and'});
|
||||
$var{'searchFormTypeSelect'} = WebGUI::Form::selectBox($self->session,{
|
||||
name=>'searchType',
|
||||
value=>'or',
|
||||
options=> {
|
||||
'or' => 'or',
|
||||
'and' => 'and',
|
||||
}
|
||||
});
|
||||
|
||||
$var{'searchFormQuery.label'} = $i18n->get('query');
|
||||
$var{'searchFormQuery.form'} = WebGUI::Form::text($self->session,{
|
||||
name=>'search',
|
||||
value=>$self->session->form->process("search"),
|
||||
});
|
||||
|
||||
$var{searchFormSubmit} = WebGUI::Form::submit($self->session,{value => "Search"});
|
||||
$var{searchFormFooter} = WebGUI::Form::formFooter($self->session);
|
||||
$var{alphabetSearchLoop} = $self->getAlphabetSearchLoop("lastName",$self->get("alphabet"));
|
||||
|
||||
# $error->info("global tmpl_vars created, time :".(time() - $start_time));
|
||||
my $out = $self->processTemplate(\%var,$self->get("templateId"));
|
||||
$out = $self->processStyle($out) if ($self->session->form->process("func") eq "list");
|
||||
# $error->info("done, going to return output, time :".(time() - $start_time));
|
||||
return $out;
|
||||
}
|
||||
|
||||
1;
|
||||
Loading…
Add table
Add a link
Reference in a new issue