File Source for BitPermUser.php

<?php
/**
* $Header: /cvsroot/bitweaver/_bit_users/BitPermUser.php,v 1.51 2007/01/14 23:26:01 hiranchaudhuri Exp $
*
* Lib for user administration, groups and permissions
* This lib uses pear so the constructor requieres
* a pear DB object
* Copyright (c) 2004 bitweaver.org
* Copyright (c) 2003 tikwiki.org
* Copyright (c) 2002-2003, Luis Argerich, Garland Foster, Eduardo Polidor, et. al.
* All Rights Reserved. See copyright.txt for details and a complete list of authors.
* Licensed under the GNU LESSER GENERAL PUBLIC LICENSE. See license.txt for details
*
* $Id: BitPermUser.php,v 1.51 2007/01/14 23:26:01 hiranchaudhuri Exp $
* @package users
*/
/**
* required setup
*/
require_once( dirname( __FILE__ ).'/BitUser.php' );
/**
* Class that holds all information for a given user
*
* @author spider <spider@steelsun.com>
* @version $Revision: 1.51 $
* @package users
* @subpackage BitPermUser
*/
class BitPermUser extends BitUser {
# var $db; // The PEAR db object used to access the database
// change this to an email address to receive debug emails from the LDAP code
var $debug = false;
var $usergroups_cache;
var $groupperm_cache;
function BitPermUser( $pUserId=NULL, $pContentId=NULL ) {
BitUser::BitUser( $pUserId, $pContentId );
// Initialize caches
$this->usergroups_cache = array();
$this->groupperm_cache = array(array());
}
function assumeUser( $pUserId ) {
global $gBitUser, $user_cookie_site;
$ret = FALSE;
// make double sure the current logged in user has permission
if( $gBitUser->hasPermission( 'p_users_admin' ) ) {
$assumeUser = new BitPermUser( $pUserId );
$assumeUser->loadPermissions();
if( $assumeUser->hasPermission( 'p_users_admin' ) ) {
$this->mErrors['assume_user'] = tra( "User administrators cannot be assumed." );
} else {
$this->mDb->query( "UPDATE `".BIT_DB_PREFIX."users_cnxn` SET `user_id`=?, `assume_user_id`=? WHERE `cookie`=?", array( $pUserId, $gBitUser->mUserId, $_COOKIE[$user_cookie_site] ) );
$ret = TRUE;
}
}
return $ret;
}
function load( $pFull=FALSE, $pUserName=NULL ) {
if( BitUser::load( $pFull, $pUserName ) ) {
if( $pFull ) {
unset( $this->mPerms );
$this->loadGroups();
$this->loadPermissions();
}
}
return( $this->mUserId != NULL );
}
// Used to hide sensitive information when it is unneccessary (i.e. $gQueryUser)
function sanitizeUserInfo() {
if (!empty($this->mInfo)) {
if (!empty($this->mInfo['provpass'])) {
unset($this->mInfo['provpass']);
}
if (!empty($this->mInfo['hash'])) {
unset($this->mInfo['hash']);
}
if (!empty($this->mInfo['challenge'])) {
unset($this->mInfo['challenge']);
}
if (!empty($this->mInfo['user_password'])) {
unset($this->mInfo['user_password']);
}
}
}
function store( &$pParamHash ) {
global $gBitSystem;
// keep track of newUser before calling base class
$newUser = !$this->isRegistered();
$this->mDb->StartTrans();
if( BitUser::store( $pParamHash ) && $newUser ) {
$defaultGroups = $this->getDefaultGroup();
$this->addUserToGroup( $this->mUserId, $defaultGroups );
if( $gBitSystem->isFeatureActive( 'users_eponymous_groups' ) ) {
// Create a group just for this user, for permissions assignment.
$groupParams = array(
'user_id' => $this->mUserId,
'name' => $pParamHash['user_store']['login'],
'desc' => "Personal group for ".(!empty( $pParamHash['user_store']['real_name'] ) ? $pParamHash['user_store']['real_name'] : $pParamHash['user_store']['login'])
);
if( $this->storeGroup( $groupParams ) ) {
$this->addUserToGroup( $this->mUserId, $groupParams['group_id'] );
}
}
$this->load( TRUE );
}
$this->mDb->CompleteTrans();
return( count( $this->mErrors ) == 0 );
}
function groupExists( $pGroupName, $pUserId=ROOT_USER_ID ) {
static $rv = array();
if( !isset( $rv[$pUserId][$pGroupName] ) ) {
$bindVars = array( $pGroupName );
$whereSql = '';
if( $pUserId != '*' ) {
$whereSql = 'AND `user_id`=?';
$bindVars[] = $pUserId;
}
$query = "SELECT ug.`group_name`, ug.`group_id`, ug.`user_id`
FROM `".BIT_DB_PREFIX."users_groups` ug
WHERE `group_name`=? $whereSql";
if( $result = $this->mDb->getAssoc( $query, $bindVars ) ) {
if( empty( $rv[$pUserId] ) ) {
$rv[$pUserId] = array();
}
$rv[$pUserId][$pGroupName] = $result[$pGroupName];
} else {
$rv[$pUserId][$pGroupName]['group_id'] = NULL;
}
}
return( $rv[$pUserId][$pGroupName]['group_id'] );
}
/**
* removes user and associated private data
*
* @access public
* @return TRUE on success, FALSE on failure - mErrors will contain reason for failure
*/
function expunge() {
global $gBitSystem, $gBitUser;
if( $this->isValid() ) {
$this->mDb->StartTrans();
if( $this->mUserId == $gBitUser->mUserId ) {
$this->mDb->RollbackTrans();
$gBitSystem->fatalError( tra( 'You cannot delete yourself' ) );
} elseif( $this->mUserId != ANONYMOUS_USER_ID ) {
$userTables = array(
'users_groups_map',
);
foreach( $userTables as $table ) {
$query = "DELETE FROM `".BIT_DB_PREFIX.$table."` WHERE `user_id` = ?";
$result = $this->mDb->query( $query, array( $this->mUserId ) );
}
if( BitUser::expunge( $this->mUserId ) ) {
$this->mDb->CompleteTrans();
return TRUE;
} else {
$this->mDb->RollbackTrans();
}
} else {
$this->mDb->RollbackTrans();
$gBitSystem->fatalError( tra( 'The anonymous user cannot be deleted' ) );
}
}
return FALSE;
}
// =-=-=-=-=-=-=-=-=-=-=-= GROUP FUNCTIONS =-=-=-=-=-=-=-=-=-=-=-=-=-=-=
function loadGroups( $pForceRefresh = FALSE ) {
if( $this->isValid() ) {
$this->mGroups = $this->getGroups( NULL, $pForceRefresh );
}
}
function isInGroup( $pGroupMixed ) {
$ret = FALSE;
if( $this->isAdmin() ) {
$ret = TRUE;
} if( $this->isValid() ) {
if( empty( $this->mGroups ) ) {
$this->loadGroups();
}
if( preg_match( '/A-Za-z/', $pGroupMixed ) ) {
// Old style group name passed in
$ret = in_array( $pGroupMixed, $this->mGroups );
} else {
$ret = isset( $this->mGroups[$pGroupMixed] );
}
}
return $ret;
}
function getAllGroups( &$pListHash ) {
if( empty( $pListHash['sort_mode'] ) || $pListHash['sort_mode'] == 'name_asc' ) {
$pListHash['sort_mode'] = 'group_name_asc';
}
$this->prepGetList( $pListHash );
$sortMode = $this->mDb->convertSortmode( $pListHash['sort_mode'] );
if( !empty( $pListHash['find_groups'] ) ) {
$mid = " WHERE UPPER(`group_name`) like ?";
$bindvars[] = "%".strtoupper( $pListHash['find_groups'] )."%";
} elseif( !empty( $pListHash['find'] ) ) {
$mid = " WHERE UPPER(`group_name`) like ?";
$bindvars[] = "%".strtoupper( $pListHash['find'] )."%";
} else {
$mid = '';
$bindvars = array();
}
if (!empty($pListHash['hide_root_groups'])) {
if (strlen($mid) > 0) {
$mid .= ' AND `user_id` <> '.ROOT_USER_ID;
} else {
$mid = " WHERE `user_id` <> ".ROOT_USER_ID;
}
}
if ( !empty( $pListHash['is_public'] ) ) {
if (strlen($mid) > 0) {
$mid .= ' AND ';
} else {
$mid = 'WHERE ';
}
$mid .= '`is_public`= ?';
$bindvars[] = $pListHash['is_public'];
}
$query = "SELECT `user_id`, `group_id`, `group_name` , `group_desc`, `group_home`, `is_default`, `is_public`
FROM `".BIT_DB_PREFIX."users_groups` $mid
ORDER BY $sortMode";
$ret = array();
if( $rs = $this->mDb->query( $query, $bindvars ) ) {
while( $row = $rs->fetchRow() ) {
$groupId = $row['group_id'];
$ret[$groupId] = $row;
$ret[$groupId]['perms'] = $this->getGroupPermissions( $groupId );
$inc = array();
$this->getIncludedGroups( $groupId, $inc );
$ret[$groupId]['included'] = $inc;
}
}
$query_cant = "select count(*) from `".BIT_DB_PREFIX."users_groups` $mid";
$cant = $this->mDb->getOne($query_cant, $bindvars);
$retval = array();
$retval["data"] = $ret;
$retval["cant"] = $cant;
return $retval;
}
function getAllUserGroups( $pUserId=NULL ) {
if( empty( $pUserId ) ) {
$pUserId = $this->mUserId;
}
$sql = "SELECT ug.`group_id`, ug.* FROM `".BIT_DB_PREFIX."users_groups` ug
WHERE `user_id`=?
ORDER BY ug.`group_name` ASC";
return $this->mDb->getAssoc($sql, array( $pUserId ) );
}
function get_user_id( $pUserName ) {
if( !empty( $pUserName ) ) {
$id = $this->mDb->getOne("select `user_id` from `".BIT_DB_PREFIX."users_users` where `login`=?", array($pUserName));
$id = ($id === NULL) ? -1 : $id;
return $id;
}
}
/*
function get_included_groups($pGroupId) {
$query = "SELECT `include_group_id`, ug.`group_name`
FROM `".BIT_DB_PREFIX."users_groups_inclusion` ugi INNER JOIN `".BIT_DB_PREFIX."users_groups` ug ON (ug.`group_id`=ugi.`group_id`)
WHERE ugi.`group_id`=?";
return( $this->mDb->getAssoc( $query, array($pGroupId) ) );
}
function get_user_groups( $pUserId ) {
if (!@$this->verifyId($pUserId)) {
// For legacy calls still using $user as the parameter
$pUserId = $this->get_user_id($pUserId);
}
if (!isset($this->usergroups_cache[$pUserId])) {
//$userid = $this->get_user_id($user);
$query = "SELECT ug.`group_id`, ug.`group_name`
FROM `".BIT_DB_PREFIX."users_groups_map` ugm INNER JOIN `".BIT_DB_PREFIX."users_groups` ug ON (ug.`group_id`=ugm.`group_id`)
WHERE ugm.`user_id`=? OR ug.`group_name`='Anonymous'";
$ret = $this->mDb->getAssoc($query, array((int)$pUserId));
// cache it
$this->usergroups_cache[$pUserId] = $ret;
return $ret;
} else {
return $this->usergroups_cache[$pUserId];
}
}
*/
// we cannot remove the anonymous group
function remove_group($pGroupId) {
if( $pGroupId != ANONYMOUS_GROUP_ID ) {
$query = "DELETE FROM `".BIT_DB_PREFIX."users_groups_inclusion`
WHERE `group_id` = ? OR `include_group_id` = ?";
$result = $this->mDb->query($query, array($pGroupId, $pGroupId));
$query = "delete from `".BIT_DB_PREFIX."users_group_permissions` where `group_id` = ?";
$result = $this->mDb->query($query, array($pGroupId));
$query = "delete from `".BIT_DB_PREFIX."users_groups` where `group_id` = ?";
$result = $this->mDb->query($query, array($pGroupId));
return true;
}
}
function getGroups( $pUserId=NULL, $pForceRefresh = FALSE ) {
$pUserId = !empty( $pUserId ) ? $pUserId : $this->mUserId;
if (!isset($this->usergroups_cache[$pUserId]) || $pForceRefresh) {
$query = "SELECT ug.`group_id`, ug.`group_name`, ug.`user_id` as group_owner_user_id
FROM `".BIT_DB_PREFIX."users_groups_map` ugm INNER JOIN `".BIT_DB_PREFIX."users_groups` ug ON (ug.`group_id`=ugm.`group_id`)
WHERE ugm.`user_id`=? OR ugm.`group_id`=".ANONYMOUS_GROUP_ID;
$ret = $this->mDb->getAssoc($query, array((int)$pUserId));
if( $ret ) {
foreach( array_keys( $ret ) as $groupId ) {
$res = array();
$this->getIncludedGroups( $groupId, $res );
foreach( $res as $key=>$val) {
$ret[$key] = array('group_name' => $val);
}
}
}
// cache it
$this->usergroups_cache[$pUserId] = $ret;
return $ret;
} else {
return $this->usergroups_cache[$pUserId];
}
}
function getIncludedGroups( $pGroupId, &$pIncludes ) {
$query = "SELECT ugi.`include_group_id`, ug.`group_name`
FROM `".BIT_DB_PREFIX."users_groups_inclusion` ugi
INNER JOIN `".BIT_DB_PREFIX."users_groups` ug ON ( ugi.`include_group_id`=ug.`group_id` )
WHERE ugi.`group_id`=?";
$ret = $this->mDb->getAssoc($query, array($pGroupId));
if( $ret ) {
foreach( array_keys( $ret ) as $groupId ) {
if( empty( $pIncludes[$groupId] ) ) {
$pIncludes[$groupId] = $ret[$groupId];
$this->getIncludedGroups( $groupId, $pIncludes );
}
}
}
}
function addGroupInclusion( $pGroupId, $pIncludeId ) {
if( @BitBase::verifyId( $pGroupId ) && @BitBase::verifyId( $pIncludeId ) ) {
$query = "INSERT INTO `".BIT_DB_PREFIX."users_groups_inclusion` (`group_id`,`include_group_id`)
VALUES(?,?)";
$this->mDb->query($query, array($pGroupId, $pIncludeId));
}
}
function removeGroupInclusions( $pGroupId ) {
if( @BitBase::verifyId( $pGroupId ) ) {
$query = "DELETE FROM `".BIT_DB_PREFIX."users_groups_inclusion` where `group_id` = ?";
$result = $this->mDb->query($query, array($pGroupId));
}
return true;
}
// pass in pGroupId to make conditional function
function getDefaultGroup( $pGroupId=NULL ) {
$bindvars = NULL;
$whereSql = '';
if( !empty( $pGroupId ) ) {
$whereSql = "AND `group_id`=? ";
$bindvars = array( $pGroupId );
}
return( $this->mDb->getAssoc("select `group_id`, `group_name` from `".BIT_DB_PREFIX."users_groups` where `is_default` = 'y' $whereSql ", $bindvars ) );
}
function get_group_users( $pGroupId ) {
$query = "SELECT uu.`user_id` AS hash_key, uu.`login`, uu.`real_name`, uu.`user_id` FROM `".BIT_DB_PREFIX."users_users` uu INNER JOIN `".BIT_DB_PREFIX."users_groups_map` ug ON (uu.`user_id`=ug.`user_id`) WHERE `group_id`=?";
return( $this->mDb->getAssoc( $query, array( $pGroupId ) ) );
}
function getGroupHome( $pGroupId ) {
$ret = FALSE;
$query = "SELECT `group_home` FROM `".BIT_DB_PREFIX."users_groups` WHERE `group_id`=?";
$result = $this->mDb->query( $query,array( $pGroupId ) );
while($res = $result->fetchRow()) {
$ret = $res['group_home'];
}
return $ret;
}
function storeUserDefaultGroup( $pUserId, $pGroupId ) {
$query = "UPDATE `".BIT_DB_PREFIX."users_users` SET `default_group_id` = ?
WHERE `user_id` = ?";
$this->mDb->query($query, array( $

Source for file BitPermUser.php