DataAccess/mysql/Permissions.php

Go to the documentation of this file.

<?php
// {{{ license

// +----------------------------------------------------------------------+
// | FastFrame Application Framework                                      |
// +----------------------------------------------------------------------+
// | Copyright (c) 2002-2006 The Codejanitor Group                        |
// +----------------------------------------------------------------------+
// | This source file is subject to the GNU Lesser Public License (LGPL), |
// | that is bundled with this package in the file LICENSE, and is        |
// | available at through the world-wide-web at                           |
// | http://www.fsf.org/copyleft/lesser.html                              |
// | If you did not receive a copy of the LGPL and are unable to          |
// | obtain it through the world-wide-web, you can get it by writing the  |
// | Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, |
// | MA 02111-1307, USA.                                                  |
// +----------------------------------------------------------------------+
// | Authors: Jason Rust <jrust@codejanitor.com>                          |
// +----------------------------------------------------------------------+

// }}}
// {{{ requires

require_once FASTFRAME_ROOT . 'lib/FastFrame/DataAccess.php';

// }}}
// {{{ class FF_DataAccess_Permissions_mysql 

// }}}
class FF_DataAccess_Permissions_mysql extends FF_DataAccess {
    // {{{ properties

    var $groupDataTable;

    var $userGroupsTable;

    var $objectsTable;

    var $userId;

    // }}}
    // {{{ constructor

    function FF_DataAccess_Permissions_mysql()
    {
        FF_DataAccess::FF_DataAccess();
        $this->table = $this->o_registry->getConfigParam('data/groups_table', 'perms_groups', 'permissions');
        $this->groupDataTable = $this->o_registry->getConfigParam('data/group_data_table', 'perms_group_data', 'permissions');
        $this->userGroupsTable = $this->o_registry->getConfigParam('data/user_groups_table', 'perms_user_groups', 'permissions');
        $this->objectsTable = $this->o_registry->getConfigParam('data/objects_table', 'perms_objects', 'permissions');
        $this->userId = FF_Auth::getCredential('userId');
    }

    // }}}
    // {{{ update()

    function update($in_data)
    {
        $a_perms = $in_data['perms'];
        unset($in_data['perms']);
        unset($in_data['created_date']);
        unset($in_data['creator_id']);
        $o_result =& parent::update($in_data);
        // delete all old perms first
        $s_stmt = $this->o_data->prepare("DELETE FROM $this->groupDataTable WHERE group_id = ?"); 
        if (DB::isError($result = $this->o_data->execute($s_stmt, $in_data['id']))) {
            $o_result->addMessage($result->getMessage());
            $o_result->setSuccess(false);
            return $o_result;
        }

        $this->_addPermissionData($in_data['id'], $a_perms, $o_result);
        return $o_result;
    }

    // }}}
    // {{{ add()

    function add($in_data)
    {
        $a_perms = $in_data['perms'];
        unset($in_data['perms']);
        $in_data['created_date'] = $this->timestampToISODate(time());
        $in_data['creator_id'] = $this->userId;
        $o_result =& parent::add($in_data);
        $this->_addPermissionData($in_data['id'], $a_perms, $o_result);
        return $o_result;
    }

    // }}}
    // {{{ remove()

    function remove($in_id)
    {
        $o_result =& parent::remove($in_id); 
        if (!$o_result->isSuccess()) {
            // If we can't delete the group, then don't try to remove the other data
            return $o_result;
        }

        $s_stmt = $this->o_data->prepare("DELETE FROM $this->groupDataTable WHERE group_id = ?");
        if (DB::isError($result = $this->o_data->execute($s_stmt, $in_id))) {
            $o_result->addMessage($result->getMessage());
            $o_result->setSuccess(false);
        }

        $s_stmt = $this->o_data->prepare("DELETE FROM $this->userGroupsTable WHERE group_id = ?");
        if (DB::isError($result = $this->o_data->execute($s_stmt, $in_id))) {
            $o_result->addMessage($result->getMessage());
            $o_result->setSuccess(false);
        }

        return $o_result;
    }

    // }}}
    // {{{ getDataByPrimaryKey()

    function getDataByPrimaryKey($in_id)
    {
        $a_data = parent::getDataByPrimaryKey($in_id);
        if (count($a_data) == 0) {
            return array();
        }

        $s_query = "SELECT permission, application FROM $this->groupDataTable 
                    WHERE group_id = ? ORDER BY application";

        if (DB::isError($result = $this->o_data->getAll($s_query, array($in_id)))) {
            return array();
        }

        $a_data['perms'] = $result;
        return $a_data;
    }

    // }}}
    // {{{ getPermCount()

    function getPermCount($in_perm, $in_app, $in_userId)
    {
        if (is_array($in_perm)) {
            $s_where = '';
            foreach ($in_perm as $s_perm) {
                $s_where .= sprintf('t2.permission = %s OR ', $this->o_data->quoteSmart($s_perm));
            }

            $s_where .= '0=1';
        }
        else {
            $s_where = sprintf('t2.permission = %s', $this->o_data->quoteSmart($in_perm));
        }

        $s_query = "SELECT COUNT(*) FROM $this->userGroupsTable AS t1 
                    INNER JOIN $this->groupDataTable AS t2 ON t1.group_id = t2.group_id
                    WHERE t1.user_id = ? AND t2.application = ? AND ($s_where)"; 

        if (DB::isError($result = $this->o_data->getOne($s_query, array($in_userId, $in_app)))) {
            return 0;
        }

        return $result;
    }

    // }}}
    // {{{ updateUserGroups()

    function updateUserGroups($in_data, $in_noRemoveOld = false)
    {
        $o_result = new FF_Result();
        $this->removeUserGroups($in_data['user_id'], $o_result, ($in_noRemoveOld ? $in_data['groups'] : array()));
        if (!$o_result->isSuccess()) {
            return $o_result;
        }

        foreach ($in_data['groups'] as $s_groupId) {
            $result = $this->o_data->autoExecute($this->userGroupsTable, 
                    array('user_id' => $in_data['user_id'], 'group_id' => $s_groupId));

            if (DB::isError($result)) {
                $o_result->addMessage($result->getMessage());
                $o_result->setSuccess(false);
            }
        }

        return $o_result;
    }

    // }}}
    // {{{ removeUserGroups()

    function removeUserGroups($in_userId, &$in_resultObj, $in_groups)
    {
        $s_grpFilter = '1=1';
        if (count($in_groups)) {
            $s_grpFilter = '(group_id = ' . implode(' OR group_id = ', $in_groups) . ')';
        }

        $s_stmt = $this->o_data->prepare("DELETE FROM $this->userGroupsTable WHERE user_id = ? AND $s_grpFilter"); 
        if (DB::isError($result = $this->o_data->execute($s_stmt, $in_userId))) {
            $in_resultObj->addMessage($result->getMessage());
            $in_resultObj->setSuccess(false);
        }

        return $in_resultObj;
    }

    // }}}
    // {{{ doesObjectHaveOwnerType()

    function doesObjectHaveOwnerType($in_objectId, $in_module, $in_perm, $in_type)
    {
        if (is_null($in_objectId)) {
            return true; 
        }

        $s_query = "SELECT COUNT(*) FROM $this->objectsTable 
                    WHERE object_id = ? AND app = ? AND module = ? AND perm = ? AND owner_type = ?";

        return $this->o_data->getOne($s_query, 
                array($in_objectId, $this->o_registry->getCurrentApp(), $in_module, $in_perm, $in_type));
    }

    // }}}
    // {{{ getObjectUserIds()

    function getObjectUserIds($in_objectId, $in_module, $in_perm, $in_getGroups)
    {
        if (is_null($in_objectId)) {
            return array();
        }

        $s_query = "SELECT owner_id FROM $this->objectsTable
                    WHERE object_id = ? AND app = ? AND module = ? AND perm = ? AND owner_type = ?";

        $s_type = $in_getGroups ? PERMS_TYPE_GROUP : PERMS_TYPE_USER;
        return $this->o_data->getCol($s_query, 0,
                array($in_objectId, $this->o_registry->getCurrentApp(), $in_module, $in_perm, $s_type));
    }

    // }}}
    // {{{ saveObjectPerm()
    
    function saveObjectPerm($in_data, &$in_result)
    {
        $result = $this->o_data->autoExecute($this->objectsTable, $in_data);
        if (DB::isError($result)) {
            $in_result->addMessage($result->getMessage());
            $in_result->setSuccess(false);
        }
    }

    // }}}
    // {{{ removeObjectPerms()

    function removeObjectPerms($in_objectId, $in_app, $in_module, &$in_result)
    {
        $s_stmt = $this->o_data->prepare("DELETE FROM $this->objectsTable 
                                          WHERE object_id = ? AND app = ? AND module = ?");
        if (DB::isError($result = $this->o_data->execute($s_stmt, array($in_objectId, $in_app, $in_module)))) {
            $in_result->addMessage($result->getMessage());
            $in_result->setSuccess(false);
        }
    }

    // }}}
    // {{{ getUsersForObject()

    function getUsersForObject($in_objectId, $in_perm, $in_module, $in_getEmails = false)
    {
        $o_dao =& FF_DataAccess::factory('Profile', 'profile');
        if ($in_objectId != 'any' && 
            $this->doesObjectHaveOwnerType($in_objectId, $in_module, $in_perm, PERMS_TYPE_PUBLIC)) {
            $a_users = $o_dao->getAllProfiles();
        }
        else {
            if ($in_objectId == 'any') {
                $s_objWhere = '1=1';
            }
            else {
                $s_objWhere = 'po.object_id = ' . $this->o_data->quoteSmart($in_objectId);
            }

            $s_profileTable = $this->o_registry->getConfigParam('data/profile_table', 'profile', 'profile');
            $s_field = $in_getEmails ? 'p.email' : 'CONCAT(p.firstname, " ", p.lastname)';
            $s_query = "SELECT DISTINCT(p.id), $s_field
                        FROM $this->objectsTable as po
                        LEFT JOIN $this->userGroupsTable AS pug ON po.owner_id = pug.group_id AND po.owner_type = ? 
                        LEFT JOIN $s_profileTable AS p ON (po.owner_id = p.id AND po.owner_type = ?) OR
                            (pug.user_id = p.id AND po.owner_type = ?)
                        WHERE p.is_inactive = 0 AND $s_objWhere AND po.owner_type \!= ? AND po.perm = ? AND po.app = ? AND po.module = ?
                        ORDER BY p.firstname";

            $a_users = $this->o_data->getAssoc($s_query, false, 
                    array(PERMS_TYPE_GROUP, PERMS_TYPE_USER, PERMS_TYPE_GROUP, PERMS_TYPE_CREATOR,
                        $in_perm, $this->o_registry->getCurrentApp(), $in_module));
        }

        if ($in_getEmails) {
            $a_users += $o_dao->getEmailByUsername($this->o_registry->getConfigParam('perms/superusers', array(), 'permissions'));
        }
        else {
            $a_users += $o_dao->getFullNameByUsername($this->o_registry->getConfigParam('perms/superusers', array(), 'permissions'));
        }

        return $a_users;
    }
    
    // }}}
    // {{{ getObjectsForUser()

    function getObjectsForUser($in_fields, $in_orderBy, $in_table, $in_userId, $in_perm, $in_module)
    {
        static $b_super;
        if (!isset($b_super)) {
            $o_perms =& FF_Perms::factory();
            $b_super = $o_perms->isSuperUser();
        }

        if ($b_super) {
            $s_query = "SELECT " . implode(',', $in_fields) . " FROM $in_table ORDER BY $in_orderBy";
            $a_params = array();
        }
        else {
            $s_query = "SELECT " . implode(',', $in_fields) . " FROM $in_table 
                        INNER JOIN $this->objectsTable AS po ON id = po.object_id AND app = ? AND module = ?
                        LEFT JOIN $this->userGroupsTable AS pug ON po.owner_type = ? AND po.owner_id = pug.group_id
                        WHERE po.perm = ? AND
                          ( po.owner_type = ? OR 
                            (po.owner_type = ? AND po.owner_id = ?) OR 
                            (po.owner_type = ? AND pug.user_id = ?)
                          )
                        GROUP BY id ORDER BY $in_orderBy";
            $a_params = array($this->o_registry->getCurrentApp(), $in_module, 
                    PERMS_TYPE_GROUP, $in_perm, PERMS_TYPE_PUBLIC, 
                    PERMS_TYPE_USER, $in_userId, PERMS_TYPE_GROUP, $in_userId);
        }

        if (count($in_fields) == 1) {
            return $this->o_data->getCol($s_query, 0, $a_params);
        }
        elseif (count($in_fields) == 2) {
            return $this->o_data->getAssoc($s_query, false, $a_params);
        }
        else {
            return $this->o_data->getAll($s_query, $a_params);
        }
    }

    // }}}
    // {{{ hasObjectPerm()

    function hasObjectPerm($in_objectId, $in_perm, $in_module, $in_app, $in_userId)
    {
        $s_query = "SELECT po.owner_type FROM $this->objectsTable AS po
                    LEFT JOIN $this->userGroupsTable AS pug ON po.owner_type = ? AND po.owner_id = pug.group_id
                    WHERE po.object_id = ? AND po.perm = ? AND po.app = ? AND po.module = ? AND
                      (po.owner_type = ? OR 
                        (po.owner_type = ? AND po.owner_id = ?) OR 
                        (po.owner_type = ? AND pug.user_id = ?) OR
                        (po.owner_type = ?)
                      )
                    -- ensures that creator perms are only given if no others exist
                    ORDER BY owner_type ASC
                    LIMIT 1";

        return $this->o_data->getOne($s_query, array(PERMS_TYPE_GROUP,
                    $in_objectId, $in_perm, $in_app, $in_module,
                    PERMS_TYPE_PUBLIC, PERMS_TYPE_USER, $in_userId,
                    PERMS_TYPE_GROUP, $in_userId, PERMS_TYPE_CREATOR));
    }

    // }}}
    // {{{ getAllGroups()

    function getAllGroups()
    {
        $s_query = "SELECT id, name FROM $this->table ORDER BY name";
        return $this->o_data->getAssoc($s_query);
    }

    // }}}
    // {{{ getUserGroups()

    function getUserGroups($in_userId)
    {
        $s_query = "SELECT group_id FROM $this->userGroupsTable WHERE user_id = ?"; 
        return $this->o_data->getCol($s_query, 0, $in_userId);
    }

    // }}}
    // {{{ _addPermissionData()

    function _addPermissionData($in_id, $in_data, &$in_resultObj)
    {
        // now save the permissions data
        $a_data = array();
        foreach ($in_data as $a_permData) {
            $a_data[] = array($in_id, $a_permData['permission'], $a_permData['application']);
        }

        $s_stmt = $this->o_data->autoPrepare($this->groupDataTable, array('group_id', 'permission', 'application'));
        if (DB::isError($result = $this->o_data->executeMultiple($s_stmt, $a_data))) {
            $in_resultObj->addMessage($result->getMessage());
            $in_resultObj->setSuccess(false);
        }
    }

    // }}}
}
?>

---