david
28b02db2ea
git-svn-id: https://192.168.0.254/svn/Proyectos.Incam_SGD/tags/3.7.0.2_original@1 eb19766c-00d9-a042-a3a0-45cb8ec72764
412 lines
13 KiB
PHP
412 lines
13 KiB
PHP
<?php
|
|
/**
|
|
* $Id$
|
|
*
|
|
* Represents a Group as per the database table groups.
|
|
*
|
|
* KnowledgeTree Community Edition
|
|
* Document Management Made Simple
|
|
* Copyright (C) 2008, 2009 KnowledgeTree Inc.
|
|
*
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify it under
|
|
* the terms of the GNU General Public License version 3 as published by the
|
|
* Free Software Foundation.
|
|
*
|
|
* This program is distributed in the hope that it will be useful, but WITHOUT
|
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
|
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
|
|
* details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
* You can contact KnowledgeTree Inc., PO Box 7775 #87847, San Francisco,
|
|
* California 94120-7775, or email info@knowledgetree.com.
|
|
*
|
|
* The interactive user interfaces in modified source and object code versions
|
|
* of this program must display Appropriate Legal Notices, as required under
|
|
* Section 5 of the GNU General Public License version 3.
|
|
*
|
|
* In accordance with Section 7(b) of the GNU General Public License version 3,
|
|
* these Appropriate Legal Notices must retain the display of the "Powered by
|
|
* KnowledgeTree" logo and retain the original copyright notice. If the display of the
|
|
* logo is not reasonably feasible for technical reasons, the Appropriate Legal Notices
|
|
* must display the words "Powered by KnowledgeTree" and retain the original
|
|
* copyright notice.
|
|
* Contributor( s): ______________________________________
|
|
*/
|
|
|
|
require_once(KT_LIB_DIR . '/unitmanagement/Unit.inc');
|
|
require_once(KT_LIB_DIR . "/util/sanitize.inc");
|
|
|
|
class Group extends KTEntity {
|
|
|
|
/** primary key of current object */
|
|
var $iId;
|
|
/** group name */
|
|
var $sName;
|
|
/** is the group a unit admin */
|
|
var $bIsUnitAdmin;
|
|
/** is the group a sys admin */
|
|
var $bIsSysAdmin;
|
|
/** which unit the group belongs to */
|
|
var $iUnitId;
|
|
var $sAuthenticationDetails = null;
|
|
var $sAuthenticationDetails2 = null;
|
|
var $iAuthenticationSourceId = null;
|
|
|
|
function Group($sNewName = null, $bNewIsUnitAdmin = false, $bNewIsSysAdmin = false) {
|
|
$this->iId = -1;
|
|
$this->sName = $sNewName;
|
|
$this->bIsUnitAdmin = $bNewIsUnitAdmin;
|
|
$this->bIsSysAdmin = $bNewIsSysAdmin;
|
|
}
|
|
|
|
var $_aFieldToSelect = array(
|
|
'iId' => 'id',
|
|
'sName' => 'name',
|
|
'bIsUnitAdmin' => 'is_unit_admin',
|
|
'bIsSysAdmin' => 'is_sys_admin',
|
|
'iUnitId' => 'unit_id',
|
|
'sAuthenticationDetails' => 'authentication_details_s1',
|
|
'sAuthenticationDetails2' => 'authentication_details_s2',
|
|
'iAuthenticationSourceId' => 'authentication_source_id',
|
|
);
|
|
|
|
function _table () {
|
|
global $default;
|
|
return $default->groups_table;
|
|
}
|
|
|
|
// STATIC
|
|
function _ktentityOptions() {
|
|
return array(
|
|
'orderby' => 'name',
|
|
);
|
|
}
|
|
|
|
// }}}
|
|
|
|
// {{{ getters/setters
|
|
// ---------------
|
|
// Getters/setters
|
|
// ---------------
|
|
|
|
function getUnitAdmin() { return $this->bIsUnitAdmin; }
|
|
function setUnitAdmin($bNewValue) { $this->bIsUnitAdmin = $bNewValue; }
|
|
function getSysAdmin() { return $this->bIsSysAdmin; }
|
|
function setSysAdmin($bNewValue) { $this->bIsSysAdmin = $bNewValue; }
|
|
function getName() { return sanitizeForSQLtoHTML($this->sName); }
|
|
function setName($sNewValue) { $this->sName = sanitizeForSQL($sNewValue); }
|
|
function getUnitId() { return $this->iUnitId; }
|
|
function setUnitId($iNewValue) { $this->iUnitId = $iNewValue; }
|
|
function getAuthenticationDetails() { return $this->sAuthenticationDetails; }
|
|
function setAuthenticationDetails($mValue) { $this->sAuthenticationDetails = $mValue; }
|
|
function getAuthenticationDetails2() { return $this->sAuthenticationDetails2; }
|
|
function setAuthenticationDetails2($mValue) { $this->sAuthenticationDetails2 = $mValue; }
|
|
function getAuthenticationSourceId() { return $this->iAuthenticationSourceId; }
|
|
function setAuthenticationSourceId($mValue) { $this->iAuthenticationSourceId = $mValue; }
|
|
// }}}
|
|
|
|
|
|
/**
|
|
* Checks if this group has users mapped to it or not
|
|
*/
|
|
function hasUsers() {
|
|
global $default;
|
|
$sql = $default->db;
|
|
$sql->query(array("SELECT id FROM $default->users_groups_table WHERE group_id = ?", $this->iId));/*ok*/
|
|
$rows = $sql->num_rows();
|
|
if ($rows > 0) {
|
|
return true;
|
|
} else {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Static function.
|
|
* Given a groups primary key it will create a
|
|
* Group object and populate it with the
|
|
* corresponding database values
|
|
*
|
|
* @return Group populated Group object on successful query, false otherwise and set $_SESSION["errorMessage"]
|
|
*/
|
|
function & get($iId) {
|
|
return KTEntityUtil::get('Group', $iId);
|
|
}
|
|
|
|
/**
|
|
* Static function
|
|
* Get a list of web documents
|
|
*
|
|
* @param String Where clause (not required)
|
|
*
|
|
* @return Array array of Group objects, false otherwise and set $_SESSION["errorMessage"]
|
|
*/
|
|
function getList($sWhereClause = null, $aOptions = null) {
|
|
if(!is_array($aOptions)) $aOptions = array($aOptions);
|
|
$aOptions['orderby'] = KTUtil::arrayGet($aOptions, 'orderby', 'name');
|
|
if (is_null($sWhereClause)) {
|
|
$aOptions['cache'] = 'getList';
|
|
}
|
|
return KTEntityUtil::getList2('Group', $sWhereClause, $aOptions);
|
|
}
|
|
|
|
function &getByName($sName) {
|
|
$dict = array(
|
|
'name' => $sName,
|
|
);
|
|
return KTEntityUtil::getByDict('Group', $dict);
|
|
}
|
|
|
|
/**
|
|
* Returns an array of Users in this group.
|
|
*
|
|
* @param Boolean Return Disabled Users or Not (defaults false)
|
|
*
|
|
*/
|
|
function &getUsers($disabled = false) {
|
|
// legacy api.
|
|
return $this->getMembers($disabled);
|
|
}
|
|
|
|
function &getMembers($disabled = false) {
|
|
global $default;
|
|
require_once(KT_LIB_DIR . '/users/User.inc');
|
|
$sQuery = "SELECT user_id FROM $default->users_groups_table WHERE group_id = ?";
|
|
$aParams = array($this->getId());
|
|
$aUserIds = DBUtil::getResultArrayKey(array($sQuery, $aParams), "user_id");
|
|
$aMembers = array();
|
|
foreach ($aUserIds as $iUserId) {
|
|
$oUser = User::get($iUserId);
|
|
$is_disabled = ($disabled) ? false : $oUser->getDisabled();
|
|
if ((!PEAR::isError($oUser)) && ($oUser !== false) && !$is_disabled) {
|
|
$aMembers[] = $oUser;
|
|
}
|
|
}
|
|
|
|
return $aMembers;
|
|
}
|
|
|
|
function &getMemberGroups() {
|
|
global $default;
|
|
$sQuery = "SELECT member_group_id FROM $default->groups_groups_table WHERE parent_group_id = ?";
|
|
$aParams = array($this->getId());
|
|
$aGroupIds = DBUtil::getResultArrayKey(array($sQuery, $aParams), "member_group_id");
|
|
$aMembers = array();
|
|
foreach ($aGroupIds as $iGroupId) {
|
|
$oGroup = Group::get($iGroupId);
|
|
if ((!PEAR::isError($oUser)) && ($oGroup !== false)) {
|
|
$aMembers[] = $oGroup;
|
|
}
|
|
}
|
|
return $aMembers;
|
|
}
|
|
|
|
function &getParentGroups() {
|
|
global $default;
|
|
$sQuery = "SELECT parent_group_id FROM $default->groups_groups_table WHERE member_group_id = ?";
|
|
$aParams = array($this->getId());
|
|
$aGroupIds = DBUtil::getResultArrayKey(array($sQuery, $aParams), "parent_group_id");
|
|
$aParents = array();
|
|
foreach ($aGroupIds as $iGroupId) {
|
|
$oGroup = Group::get($iGroupId);
|
|
if ((!PEAR::isError($oUser)) && ($oGroup !== false)) {
|
|
$aParents[] = $oGroup;
|
|
}
|
|
}
|
|
return $aParents;
|
|
}
|
|
|
|
// {{{ hasMember
|
|
function hasMember($oUser) {
|
|
global $default;
|
|
$iUserId = KTUtil::getId($oUser);
|
|
|
|
$sQuery = "SELECT COUNT(*) AS number_of_entries FROM $default->users_groups_table
|
|
WHERE group_id = ? AND user_id = ?";
|
|
$aParams = array($this->getId(), $iUserId);
|
|
$res = (int)DBUtil::getOneResultKey(array($sQuery, $aParams), "number_of_entries");
|
|
if (PEAR::isError($res)) {
|
|
return $res;
|
|
}
|
|
if ($res === 1) {
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
// }}}
|
|
|
|
// {{{ setMembers
|
|
function setMembers($aUsers) {
|
|
$sTable = KTUtil::getTableName('users_groups');
|
|
$aParams = array(
|
|
"group_id" => $this->getId(),
|
|
);
|
|
$res = DBUtil::whereDelete($sTable, $aParams);
|
|
foreach ($aUsers as $iUserId) {
|
|
$iUserId = KTUtil::getId($iUserId);
|
|
$this->addMember($iUserId);
|
|
}
|
|
return;
|
|
}
|
|
// }}}
|
|
|
|
// {{{ addMember
|
|
function addMember($oUser) {
|
|
global $default;
|
|
if ($this->hasMember($oUser)) {
|
|
return true;
|
|
}
|
|
$aParams = array(
|
|
"user_id" => KTUtil::getId($oUser),
|
|
"group_id" => $this->getId(),
|
|
);
|
|
$res = DBUtil::autoInsert($default->users_groups_table, $aParams);
|
|
if (PEAR::isError($res)) {
|
|
return $res;
|
|
}
|
|
|
|
GroupUtil::clearGroupCacheForUser($oUser);
|
|
|
|
return true;
|
|
}
|
|
// }}}
|
|
|
|
// {{{ removeMember
|
|
function removeMember($oUser) {
|
|
global $default;
|
|
if (!$this->hasMember($oUser)) {
|
|
return true;
|
|
}
|
|
$aParams = array(
|
|
"user_id" => KTUtil::getId($oUser),
|
|
"group_id" => $this->getId(),
|
|
);
|
|
$res = DBUtil::whereDelete($default->users_groups_table, $aParams);
|
|
if (PEAR::isError($res)) {
|
|
return $res;
|
|
}
|
|
if ($this->hasMember($oUser)) {
|
|
return PEAR::raiseError(_kt("Tried to remove member from database, apparently successfully, but hasMember thinks they're still members?"));
|
|
}
|
|
return true;
|
|
}
|
|
// }}}
|
|
|
|
// {{{ addMemberGroup
|
|
function addMemberGroup($oGroup) {
|
|
global $default;
|
|
if ($this->hasMemberGroup($oGroup)) {
|
|
return true;
|
|
}
|
|
$aParams = array(
|
|
"parent_group_id" => $this->getId(),
|
|
"member_group_id" => $oGroup->getId(),
|
|
);
|
|
$res = DBUtil::autoInsert($default->groups_groups_table, $aParams);
|
|
if (PEAR::isError($res)) {
|
|
return $res;
|
|
}
|
|
return true;
|
|
}
|
|
// }}}
|
|
|
|
// {{{ removeMemberGroup
|
|
function removeMemberGroup($oGroup) {
|
|
global $default;
|
|
if (!$this->hasMemberGroup($oGroup)) {
|
|
return true;
|
|
}
|
|
$aParams = array(
|
|
"parent_group_id" => $this->getId(),
|
|
"member_group_id" => $oGroup->getId(),
|
|
);
|
|
$res = DBUtil::whereDelete($default->groups_groups_table, $aParams);
|
|
if (PEAR::isError($res)) {
|
|
return $res;
|
|
}
|
|
if ($this->hasMemberGroup($oGroup)) {
|
|
return PEAR::raiseError(_kt("An error occurred while removing the sub-group."));
|
|
}
|
|
return true;
|
|
}
|
|
// }}}
|
|
|
|
// {{{ hasMemberGroup
|
|
function hasMemberGroup($oGroup) {
|
|
global $default;
|
|
|
|
$sQuery = "SELECT COUNT(*) AS number_of_entries FROM $default->groups_groups_table
|
|
WHERE parent_group_id = ? AND member_group_id = ?";
|
|
$aParams = array($this->getId(), $oGroup->getId());
|
|
$res = (int)DBUtil::getOneResultKey(array($sQuery, $aParams), "number_of_entries");
|
|
if (PEAR::isError($res)) {
|
|
return $res;
|
|
}
|
|
if ($res === 1) {
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
// }}}
|
|
|
|
// getUnitAdministratorGroupsByUnit
|
|
function getUnitAdministratorGroupsByUnit($oUnit) {
|
|
$iUnitId = KTUtil::getId($oUnit);
|
|
return KTEntityUtil::getByDict('Group', array(
|
|
'is_unit_admin' => true,
|
|
'unit_id' => $iUnitId,
|
|
), array(
|
|
'multi' => 'true',
|
|
));
|
|
}
|
|
|
|
function getAdministratorGroups() {
|
|
return KTEntityUtil::getByDict('Group', array(
|
|
'is_sys_admin' => true,
|
|
), array(
|
|
'multi' => 'true',
|
|
));
|
|
}
|
|
|
|
function getByAuthenticationSource($oSource, $aOptions = null) {
|
|
$iSourceId = KTUtil::getId($oSource);
|
|
$aOptions = KTUtil::meldOptions($aOptions, array(
|
|
'multi' => true,
|
|
));
|
|
return KTEntityUtil::getByDict('Group', array(
|
|
'authentication_source_id' => $iSourceId,
|
|
), $aOptions);
|
|
}
|
|
|
|
function getByAuthenticationSourceAndDetails($oSource, $sDetails, $aOptions = null) {
|
|
$iSourceId = KTUtil::getId($oSource);
|
|
return KTEntityUtil::getByDict('Group', array(
|
|
'authentication_source_id' => $iSourceId,
|
|
'authentication_details_s1' => $sDetails,
|
|
), $aOptions);
|
|
}
|
|
|
|
|
|
function &createFromArray($aOptions) { return KTEntityUtil::createFromArray('Group', $aOptions); }
|
|
}
|
|
|
|
/**
|
|
* Static function
|
|
*
|
|
* Creates a Group object from an array
|
|
*
|
|
* @param Array Array of parameters. Must match order of parameters in constructor
|
|
*
|
|
* @return User user object
|
|
*/
|
|
function & groupCreateFromArray($aParameters) {
|
|
$oGroup = new Group($aParameters[0], $aParameters[1], $aParameters[2], $aParameters[3], $aParameters[4], $aParameters[5], $aParameters[6], $aParameters[7], $aParameters[8], $aParameters[9], $aParameters[10]);
|
|
return $oGroup;
|
|
}
|
|
|
|
?>
|