DataAccess/pgsql/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';

// }}}
// {{{ constants

define('PERMS_READ', 'READ');
define('PERMS_EDIT', 'EDIT');
define('PERMS_DELETE', 'DELETE');

// }}}
// {{{ class FF_DataAccess_Permissions_pgsql 

// }}}
class FF_DataAccess_Permissions_pgsql extends FF_DataAccess {
    // {{{ properties

    var $groupDataTable;

    var $userGroupsTable;

    var $objectsTable;

    var $userId;

    // }}}
    // {{{ constructor

    function FF_DataAccess_Permissions_pgsql()
    {
        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)
    {
        $o_result = new FF_Result();
        $s_query = sprintf('UPDATE %s (name, description) VALUES (%s, %s) WHERE id = %s', 
                $this->table,
                $this->o_data->quoteSmart($in_data['name']),
                $this->o_data->quoteSmart($in_data['description']),
                $in_data['id']);

        if (DB::isError($result = $this->o_data->query($s_query))) {
            $o_result->addMessage($result->getMessage());
            $o_result->setSuccess(false);
            return $o_result;
        }

        // delete all old perms first
        $s_query = sprintf('DELETE FROM %s WHERE group_id = %s', 
                $this->groupDataTable, $in_data['id']);

        if (DB::isError($result = $this->o_data->query($s_query))) {
            $o_result->addMessage($result->getMessage());
            $o_result->setSuccess(false);
            return $o_result;
        }

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

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

    function add($in_data)
    {
        $o_result = new FF_Result();
        $s_query = sprintf('INSERT INTO %s (id, name, description, creator_id, created_date) VALUES (%s, %s, %s, %s, NOW())', 
                $this->table,
                $in_data['id'],
                $this->o_data->quoteSmart($in_data['name']),
                $this->o_data->quoteSmart($in_data['description']),
                $this->o_data->quoteSmart($this->userId));

        if (DB::isError($result = $this->o_data->query($s_query))) {
            $o_result->addMessage($result->getMessage());
            $o_result->setSuccess(false);
            return $o_result;
        }

        $this->_addPermissionData($in_data['id'], $in_data['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_query = sprintf('DELETE FROM %s WHERE group_id = %s', 
                $this->groupDataTable, $in_id);

        if (DB::isError($result = $this->o_data->query($s_query))) {
            $o_result->addMessage($result->getMessage());
            $o_result->setSuccess(false);
        }

        $s_query = sprintf('DELETE FROM %s WHERE group_id = %s', 
                $this->userGroupsTable, $in_id);

        if (DB::isError($result = $this->o_data->query($s_query))) {
            $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 = sprintf('SELECT permission, application FROM %s WHERE group_id = %s ORDER BY application', 
                $this->groupDataTable, $in_id);

        if (DB::isError($result = $this->o_data->getAll($s_query))) {
            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';
        }
        else {
            $s_where = sprintf('t2.permission = %s', $this->o_data->quoteSmart($in_perm));
        }

        $s_query = sprintf('SELECT COUNT(*) FROM %s AS t1 
                            INNER JOIN %s AS t2 ON t1.group_id = t2.group_id
                            WHERE t1.user_id = %s AND t2.application = %s AND (%s)', 
                            $this->userGroupsTable,
                            $this->groupDataTable,
                            $this->o_data->quoteSmart($in_userId),
                            $this->o_data->quoteSmart($in_app),
                            $s_where);

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

        return $result;
    }

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

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

        foreach ($in_data['groups'] as $s_groupId) {
            $s_query = sprintf('INSERT INTO %s (user_id, group_id) VALUES (%s, %s)', 
                    $this->userGroupsTable,
                    $in_data['user_id'],
                    $this->o_data->quoteSmart($s_groupId));

            if (DB::isError($result = $this->o_data->query($s_query))) {
                $o_result->addMessage($result->getMessage());
                $o_result->setSuccess(false);
            }
        }

        return $o_result;
    }

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

    function removeUserGroups($in_userId, &$in_resultObj)
    {
        $s_query = sprintf('DELETE FROM %s WHERE user_id = %s', 
                $this->userGroupsTable, $in_userId);

        if (DB::isError($result = $this->o_data->query($s_query))) {
            $in_resultObj->addMessage($result->getMessage());
            $in_resultObj->setSuccess(false);
        }

        return $in_resultObj;
    }

    // }}}
    // {{{ getObjectPerms()

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

        $s_query = sprintf('SELECT owner_id FROM %s 
                            WHERE object_id = %s AND app =%s AND module = %s AND perm = %s AND owner_is_group = %s',
                            $this->objectsTable,
                            $in_objectId,
                            $this->o_data->quoteSmart($this->o_registry->getCurrentApp()),
                            $this->o_data->quoteSmart($in_module),
                            $this->o_data->quoteSmart($in_perm),
                            $this->o_data->quoteSmart($this->boolToScalar($in_getGroups)));

        return $this->o_data->getCol($s_query, 0);
    }

    // }}}
    // {{{ saveObjectPerm()
    
    function saveObjectPerm($in_data, &$in_result)
    {
        $s_query = sprintf('INSERT INTO %s (object_id, app, module, perm, owner_id, owner_is_group) VALUES (%s, %s, %s, %s, %s, %s)', 
                $this->objectsTable,
                $this->o_data->quoteSmart($in_data['object_id']),
                $this->o_data->quoteSmart($in_data['app']),
                $this->o_data->quoteSmart($in_data['module']),
                $this->o_data->quoteSmart($in_data['perm']),
                $this->o_data->quoteSmart($in_data['owner_id']),
                $this->o_data->quoteSmart($this->boolToScalar($in_data['owner_is_group'])));

        if (DB::isError($result = $this->o_data->query($s_query))) {
            $in_result->addMessage($result->getMessage());
            $in_result->setSuccess(false);
        }
    }

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

    function removeObjectPerms($in_objectId, $in_app, $in_module, &$in_result)
    {
        $s_query = sprintf('DELETE FROM %s WHERE object_id = %s AND app = %s AND module = %s',
                $this->objectsTable,
                $this->o_data->quoteSmart($in_objectId),
                $this->o_data->quoteSmart($in_app),
                $this->o_data->quoteSmart($in_module));

        if (DB::isError($result = $this->o_data->query($s_query))) {
            $in_result->addMessage($result->getMessage());
            $in_result->setSuccess(false);
        }
    }

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

    function getAllGroups()
    {
        $s_query = sprintf('SELECT id, name FROM %s', $this->table);
        return $this->o_data->getAssoc($s_query);
    }

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

    function getUserGroups($in_userId)
    {
        $s_query = sprintf('SELECT group_id FROM %s WHERE user_id = %s', 
                 $this->userGroupsTable, $in_userId);

        return $this->o_data->getCol($s_query, 0);
    }

    // }}}
    // {{{ getUsersInGroup()

    function getUsersInGroup($in_groupId)
    {
        if (is_null($in_groupId)) {
            return array();
        }

        $s_profileTable = $this->o_registry->getConfigParam('data/table', 'profile', 'profile');
        $s_query = sprintf('SELECT user_id, username FROM %s 
                            INNER JOIN %s ON user_id = id WHERE group_id = %s', 
                 $this->userGroupsTable, $s_profileTable, $in_groupId);

        return $this->o_data->getAssoc($s_query);
    }

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

    function _addPermissionData($in_id, $in_data, &$in_resultObj)
    {
        // now save the permissions data
        foreach ($in_data as $a_permData) {
            $s_query = sprintf('INSERT INTO %s (group_id, permission, application) VALUES (%s, %s, %s)', 
                    $this->groupDataTable,
                    $in_id,
                    $this->o_data->quoteSmart($a_permData['permission']),
                    $this->o_data->quoteSmart($a_permData['application']));

            if (DB::isError($result = $this->o_data->query($s_query))) {
                $in_resultObj->addMessage($result->getMessage());
                $in_resultObj->setSuccess(false);
                return;
            }
        }
    }

    // }}}
}
?>

---