367 lines
10 KiB
Perl
367 lines
10 KiB
Perl
package WebGUI::Privilege;
|
|
|
|
=head1 LEGAL
|
|
|
|
-------------------------------------------------------------------
|
|
WebGUI is Copyright 2001-2002 Plain Black LLC.
|
|
-------------------------------------------------------------------
|
|
Please read the legal notices (docs/legal.txt) and the license
|
|
(docs/license.txt) that came with this distribution before using
|
|
this software.
|
|
-------------------------------------------------------------------
|
|
http://www.plainblack.com info@plainblack.com
|
|
-------------------------------------------------------------------
|
|
|
|
=cut
|
|
|
|
use strict;
|
|
use Tie::CPHash;
|
|
use WebGUI::International;
|
|
use WebGUI::Operation::Account ();
|
|
use WebGUI::Session;
|
|
use WebGUI::SQL;
|
|
use WebGUI::URL;
|
|
|
|
=head1 NAME
|
|
|
|
Package WebGUI::Privilege
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
use WebGUI::Privilege;
|
|
$html = WebGUI::Privilege::adminOnly();
|
|
$boolean = WebGUI::Privilege::canEditPage();
|
|
$boolean = WebGUI::Privilege::canViewPage();
|
|
$html = WebGUI::Privilege::insufficient();
|
|
$boolean = WebGUI::Privilege::isInGroup($groupId);
|
|
$html = WebGUI::Privilege::noAccess();
|
|
$html = WebGUI::Privilege::notMember();
|
|
$html = WebGUI::Privilege::vitalComponent();
|
|
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
This package provides access to the WebGUI security system
|
|
and security messages.
|
|
|
|
=head1 FUNCTIONS
|
|
|
|
These functions are available from this package:
|
|
|
|
=cut
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 adminOnly ( )
|
|
|
|
Returns a message stating that this functionality can only be used
|
|
by administrators. This method also sets the HTTP header status to
|
|
401.
|
|
|
|
=cut
|
|
|
|
sub adminOnly {
|
|
if($session{env}{MOD_PERL}) {
|
|
my $r = Apache->request;
|
|
if(defined($r)) {
|
|
$r->custom_response(401, '<!--Admin Only-->' );
|
|
$r->status(401);
|
|
}
|
|
} else {
|
|
$session{header}{status} = 401;
|
|
}
|
|
my ($output, $sth, @data);
|
|
$output = '<h1>'.WebGUI::International::get(35).'</h1>';
|
|
$output .= WebGUI::International::get(36);
|
|
$output .= '<ul>';
|
|
$sth = WebGUI::SQL->read("select users.username,users.userId from users,groupings where users.userId=groupings.userId and groupings.groupId=3 order by users.username");
|
|
while (@data = $sth->array) {
|
|
$output .= '<li><a href="'.WebGUI::URL::page('op=viewProfile&uid='.$data[1]).'">'.$data[0].'</a>';
|
|
}
|
|
$sth->finish;
|
|
$output .= '</ul><p>';
|
|
return $output;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 canEditPage ( [ pageId ] )
|
|
|
|
Returns a boolean (0|1) value signifying that the user has the
|
|
required privileges.
|
|
|
|
=item pageId
|
|
|
|
The unique identifier for the page that you wish to check the
|
|
privileges on. Defaults to the current page id.
|
|
|
|
=cut
|
|
|
|
sub canEditPage {
|
|
my ($isContentManager,%page);
|
|
tie %page, 'Tie::CPHash';
|
|
if ($_[0] ne "") {
|
|
%page = WebGUI::SQL->quickHash("select ownerId,ownerEdit,worldEdit,groupId,groupEdit from page where pageId=$_[0]");
|
|
} else {
|
|
%page = %{$session{page}};
|
|
}
|
|
$isContentManager = isInGroup(4);
|
|
if ($page{worldEdit} && $isContentManager) {
|
|
return 1;
|
|
} elsif ($session{user}{userId} eq $page{ownerId} && $page{ownerEdit} && $isContentManager) {
|
|
return 1;
|
|
} elsif (isInGroup($page{groupId}) && $page{groupEdit} && $isContentManager) {
|
|
return 1;
|
|
} elsif (isInGroup(3)) { # admin check
|
|
return 1;
|
|
} else {
|
|
return 0;
|
|
}
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 canViewPage ( [ pageId ] )
|
|
|
|
Returns a boolean (0|1) value signifying that the user has the
|
|
required privileges. Always returns true for Admins and users that
|
|
have the rights to edit this page.
|
|
|
|
=item pageId
|
|
|
|
The unique identifier for the page that you wish to check the
|
|
privileges on. Defaults to the current page id.
|
|
|
|
=cut
|
|
|
|
sub canViewPage {
|
|
my (%page, $inDateRange);
|
|
tie %page, 'Tie::CPHash';
|
|
if ($_[0] eq "") {
|
|
%page = %{$session{page}};
|
|
} else {
|
|
%page = WebGUI::SQL->quickHash("select ownerId,ownerView,groupId,groupView,worldView,startDate,endDate
|
|
from page where pageId=$_[0]");
|
|
}
|
|
if ($page{startDate} < time() && $page{endDate} > time()) {
|
|
$inDateRange = 1;
|
|
}
|
|
if ($page{worldView} && $inDateRange) {
|
|
return 1;
|
|
} elsif ($session{user}{userId} eq $page{ownerId} && $page{ownerView} && $inDateRange) {
|
|
return 1;
|
|
} elsif (isInGroup($page{groupId}) && $page{groupView} && $inDateRange) {
|
|
return 1;
|
|
} elsif (isInGroup(3)) { # admin check
|
|
return 1;
|
|
} elsif (canEditPage($_[0])) {
|
|
return 1;
|
|
} else {
|
|
return 0;
|
|
}
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 insufficient ( )
|
|
|
|
Returns a message stating that the user does not have the required
|
|
privileges to perform the operation they requested. This method
|
|
also sets the HTTP header status to 401.
|
|
|
|
=cut
|
|
|
|
sub insufficient {
|
|
if($session{env}{MOD_PERL}) {
|
|
my $r = Apache->request;
|
|
if(defined($r)) {
|
|
$r->custom_response(401, '<!--Insufficient Privileges-->' );
|
|
$r->status(401);
|
|
}
|
|
} else {
|
|
$session{header}{status} = 401;
|
|
}
|
|
my ($output);
|
|
$output = '<h1>'.WebGUI::International::get(37).'</h1>';
|
|
$output .= WebGUI::International::get(38);
|
|
$output .= '<p>';
|
|
$output = WebGUI::Macro::process($output);
|
|
return $output;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 isInGroup ( groupId [ , userId ] )
|
|
|
|
Returns a boolean (0|1) value signifying that the user has the
|
|
required privileges. Always returns true for Admins.
|
|
|
|
=item groupId
|
|
|
|
The group that you wish to verify against the user.
|
|
|
|
=item userId
|
|
|
|
The user that you wish to verify against the group. Defaults to the
|
|
currently logged in user.
|
|
|
|
=cut
|
|
|
|
sub isInGroup {
|
|
my ($gid, $uid, @data, %group, %user, $groupId);
|
|
($gid, $uid) = @_;
|
|
$uid = $session{user}{userId} if ($uid eq "");
|
|
### The "Everyone" group automatically returns true.
|
|
if ($gid == 7) {
|
|
return 1;
|
|
}
|
|
### The "Visitor" group returns false, unless the user is visitor.
|
|
if ($gid == 1) {
|
|
if ($uid == 1) {
|
|
return 1;
|
|
} else {
|
|
return 0;
|
|
}
|
|
}
|
|
### The "Registered Users" group returns true if user is not visitor.
|
|
if ($gid==2 && $uid != 1) {
|
|
return 1;
|
|
}
|
|
### Use session to cache multiple lookups of the same group.
|
|
if ($session{isInGroup}{$gid} || $session{isInGroup}{3}) {
|
|
return 1;
|
|
} elsif ($session{isInGroup}{$gid} eq "0") {
|
|
return 0;
|
|
} else {
|
|
$session{isInGroup}{$gid} = 0;
|
|
}
|
|
### Lookup the actual grouping.
|
|
@data = WebGUI::SQL->quickArray("select count(*) from groupings where groupId='$gid' and userId='$uid' and expireDate>".time());
|
|
if ($data[0] > 0 && $uid != 1) {
|
|
$session{isInGroup}{$gid} = 1;
|
|
return 1;
|
|
}
|
|
### Get data for auxillary checks.
|
|
tie %group, 'Tie::CPHash';
|
|
%group = WebGUI::SQL->quickHash("select karmaThreshold from groups where groupId='$gid'");
|
|
### Check karma levels.
|
|
if ($session{setting}{useKarma}) {
|
|
tie %user, 'Tie::CPHash';
|
|
%user = WebGUI::SQL->quickHash("select karma from users where userId='$uid'");
|
|
if ($user{karma} >= $group{karmaThreshold}) {
|
|
$session{isInGroup}{$gid} = 1;
|
|
return 1;
|
|
}
|
|
}
|
|
### Admins can do anything!
|
|
if ($gid != 3 && $session{isInGroup}{3} eq "") {
|
|
$session{isInGroup}{3} = isInGroup(3, $uid);
|
|
if ($session{isInGroup}{3}) {
|
|
$session{isInGroup}{$gid} = 1;
|
|
return 1;
|
|
}
|
|
}
|
|
### Check for groups of groups.
|
|
@data = WebGUI::SQL->buildArray("select groupId from groupGroupings where inGroup=$gid");
|
|
foreach $groupId (@data) {
|
|
$session{isInGroup}{$groupId} = isInGroup($groupId, $uid);
|
|
if ($session{isInGroup}{$groupId}) {
|
|
$session{isInGroup}{$gid} = 1;
|
|
return 1;
|
|
}
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 noAccess ( )
|
|
|
|
Returns a message stating that the user does not have the privileges
|
|
necessary to access this page. This method also sets the HTTP header
|
|
status to 401.
|
|
|
|
=cut
|
|
|
|
sub noAccess {
|
|
if($session{env}{MOD_PERL}) {
|
|
my $r = Apache->request;
|
|
if(defined($r)) {
|
|
$r->custom_response(401, '<!--No Access-->' );
|
|
$r->status(401);
|
|
}
|
|
} else {
|
|
$session{header}{status} = 401;
|
|
}
|
|
my ($output);
|
|
if ($session{user}{userId} <= 1) {
|
|
$output = WebGUI::Operation::Account::www_displayAccount();
|
|
} else {
|
|
$output = '<h1>'.WebGUI::International::get(37).'</h1>';
|
|
$output .= WebGUI::International::get(39);
|
|
$output .= '<p>';
|
|
}
|
|
return $output;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 notMember ( )
|
|
|
|
Returns a message stating that the user they requested information
|
|
about is no longer active on this server. This method also sets the
|
|
HTTP header status to 400.
|
|
|
|
=cut
|
|
|
|
sub notMember {
|
|
if($session{env}{MOD_PERL}) {
|
|
my $r = Apache->request;
|
|
if(defined($r)) {
|
|
$r->custom_response(400, '<!--Not A Member-->' );
|
|
$r->status(400);
|
|
}
|
|
} else {
|
|
$session{header}{status} = 400;
|
|
}
|
|
my ($output);
|
|
$output = '<h1>'.WebGUI::International::get(345).'</h1>';
|
|
$output .= WebGUI::International::get(346);
|
|
$output .= '<p>';
|
|
return $output;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 vitalComponent ( )
|
|
|
|
Returns a message stating that the user made a request to delete
|
|
something that should never delete. This method also sets the HTTP
|
|
header status to 403.
|
|
|
|
=cut
|
|
|
|
sub vitalComponent {
|
|
if($session{env}{MOD_PERL}) {
|
|
my $r = Apache->request;
|
|
if(defined($r)) {
|
|
$r->custom_response(403, '<!--Vital Component-->' );
|
|
$r->status(403);
|
|
}
|
|
} else {
|
|
$session{header}{status} = 403;
|
|
}
|
|
my ($output);
|
|
$output = '<h1>'.WebGUI::International::get(40).'</h1>';
|
|
$output .= WebGUI::International::get(41);
|
|
$output .= '<p>';
|
|
return $output;
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1;
|
|
|