classes/class.ilRbacReview.php

Go to the documentation of this file.

<?php
/*
        +-----------------------------------------------------------------------------+
        | ILIAS open source                                                           |
        +-----------------------------------------------------------------------------+
        | Copyright (c) 1998-2001 ILIAS open source, University of Cologne            |
        |                                                                             |
        | This program is free software; you can redistribute it and/or               |
        | modify it under the terms of the GNU General Public License                 |
        | as published by the Free Software Foundation; either version 2              |
        | of the License, or (at your option) any later version.                      |
        |                                                                             |
        | 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, write to the Free Software                 |
        | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
        +-----------------------------------------------------------------------------+
*/


class ilRbacReview
{
        var $log = null;

        function ilRbacReview()
        {
                global $ilDB,$ilErr,$ilias,$ilLog;

                $this->log =& $ilLog;

                // set db & error handler
                (isset($ilDB)) ? $this->ilDB =& $ilDB : $this->ilDB =& $ilias->db;
                
                if (!isset($ilErr))
                {
                        $ilErr = new ilErrorHandling();
                        $ilErr->setErrorHandling(PEAR_ERROR_CALLBACK,array($ilErr,'errorHandler'));
                }
                else
                {
                        $this->ilErr =& $ilErr;
                }
        }

        function roleExists($a_title,$a_id = 0)
        {
                if (empty($a_title))
                {
                        $message = get_class($this)."::roleExists(): No title given!";
                        $this->ilErr->raiseError($message,$this->ilErr->WARNING);
                }
                
                $clause = ($a_id) ? " AND obj_id != '".$a_id."'" : "";
                
                $q = "SELECT DISTINCT obj_id FROM object_data ".
                         "WHERE title ='".addslashes($a_title)."' ".
                         "AND type IN('role','rolt')".
                         $clause;
                $r = $this->ilDB->query($q);

                if ($r->numRows() == 1)
                {
                        return true;
                }
                else
                {
                        return false;
                }
        }

        function getParentRoles($a_path,$a_templates = false)
        {
                if (!isset($a_path) or !is_array($a_path))
                {
                        $message = get_class($this)."::getParentRoles(): No path given or wrong datatype!";
                        $this->ilErr->raiseError($message,$this->ilErr->WARNING);
                }

                $parentRoles = array();

                $child = $this->getAllRoleFolderIds();
                
                // CREATE IN() STATEMENT
                $in = " IN('";
                $in .= implode("','",$child);
                $in .= "') ";
                
                foreach ($a_path as $path)
                {
                        //TODO: move this to tree class !!!!
                        $q = "SELECT * FROM tree ".
                                 "WHERE child ".$in.
                                 "AND parent = '".$path."'";
                        $r = $this->ilDB->query($q);

                        while ($row = $r->fetchRow(DB_FETCHMODE_OBJECT))
                        {
                                $roles = $this->getRoleListByObject($row->child,$a_templates);

                                foreach ($roles as $role)
                                {
                                        $id = $role["obj_id"];
                                        // TODO: need a parent here?
                                        $role["parent"] = $row->child;
                                        $parentRoles[$id] = $role;
                                }
                        }
                }

                return $parentRoles;
        }

        function getParentRoleIds($a_endnode_id,$a_templates = false)
        {
                global $tree;

                if (!isset($a_endnode_id))
                {
                        $message = get_class($this)."::getParentRoleIds(): No node_id (ref_id) given!";
                        $this->ilErr->raiseError($message,$this->ilErr->WARNING);
                }
        
                $pathIds  = $tree->getPathId($a_endnode_id);

                // add system folder since it may not in the path
                $pathIds[0] = SYSTEM_FOLDER_ID;

                return $this->getParentRoles($pathIds,$a_templates);
        }

        function getRoleListByObject($a_ref_id,$a_templates = false)
        {
                if (!isset($a_ref_id) or !isset($a_templates))
                {
                        $message = get_class($this)."::getRoleListByObject(): Missing parameter!".
                                           "ref_id: ".$a_ref_id.
                                           "tpl_flag: ".$a_templates;
                        $this->ilErr->raiseError($message,$this->ilErr->WARNING);
                }

                $role_list = array();

                $where = $this->setTemplateFilter($a_templates);
        
                $q = "SELECT * FROM object_data ".
                         "JOIN rbac_fa ".$where.
                         "AND object_data.obj_id = rbac_fa.rol_id ".
                         "AND rbac_fa.parent = '".$a_ref_id."'";
                $r = $this->ilDB->query($q);

                while ($row = $r->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $role_list[] = fetchObjectData($row);
                }
                
                $role_list = $this->setRoleType($role_list);
                
                return $role_list;
        }
        
        function getAssignableRoles($a_templates = false,$a_internal_roles = false)
        {
                $role_list = array();

                $where = $this->setTemplateFilter($a_templates);

                $q = "SELECT DISTINCT * FROM object_data ".
                         "JOIN rbac_fa ".$where.
                         "AND object_data.obj_id = rbac_fa.rol_id ".
                         "AND rbac_fa.assign = 'y'";
                $r = $this->ilDB->query($q);

                while ($row = $r->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        //ifd $row->title
                        $role_list[] = fetchObjectData($row);
                }
                
                $role_list = $this->setRoleType($role_list);
                
                return $role_list;
        }

        function getAssignableChildRoles($a_ref_id)
        {
                global $tree;

                $roles_data = $this->getAssignableRoles();
                
                // Filter childs of node
                foreach($roles_data as $role)
                {
                        if($tree->isGrandChild($a_ref_id,$role['parent']))
                        {
                                $filtered[] = $role; 
                        }
                }
                return $filtered ? $filtered : array();
        }
        
        function setTemplateFilter($a_templates)
        {
                if ($a_templates === true)
                {
                         $where = "WHERE object_data.type IN ('role','rolt') ";         
                }
                else
                {
                        $where = "WHERE object_data.type = 'role' ";
                }
                
                return $where;
        }

        function setRoleType($a_role_list)
        {
                foreach ($a_role_list as $key => $val)
                {
                        // determine role type
                        if ($val["type"] == "rolt")
                        {
                                $a_role_list[$key]["role_type"] = "template";
                        }
                        else
                        {
                                if ($val["assign"] == "y")
                                {
                                        if ($val["parent"] == ROLE_FOLDER_ID)
                                        {
                                                $a_role_list[$key]["role_type"] = "global";
                                        }
                                        else
                                        {
                                                $a_role_list[$key]["role_type"] = "local";
                                        }
                                }
                                else
                                {
                                        $a_role_list[$key]["role_type"] = "linked";
                                }
                        }
                }
                
                return $a_role_list;
        }
        
        function assignedUsers($a_rol_id, $a_fields = NULL)
        {
                global $ilBench;
                
                $ilBench->start("RBAC", "review_assignedUsers");
                
                if (!isset($a_rol_id))
                {
                        $message = get_class($this)."::assignedUsers(): No role_id given!";
                        $this->ilErr->raiseError($message,$this->ilErr->WARNING);
                }
                
        $result_arr = array();

        if ($a_fields !== NULL and is_array($a_fields))
        {
            if (count($a_fields) == 0)
            {
                $select = "*";
            }
            else
            {
                if (($usr_id_field = array_search("usr_id",$a_fields)) !== false)
                    unset($a_fields[$usr_id_field]);

                $select = implode(",",$a_fields).",usr_data.usr_id";
            }

                $q = "SELECT ".$select." FROM usr_data ".
                 "LEFT JOIN rbac_ua ON usr_data.usr_id=rbac_ua.usr_id ".
                 "WHERE rbac_ua.rol_id='".$a_rol_id."'";
            $r = $this->ilDB->query($q);

            while ($row = $r->fetchRow(DB_FETCHMODE_ASSOC))
            {
                $result_arr[] = $row;
            }
        }
        else
        {
                    $q = "SELECT usr_id FROM rbac_ua WHERE rol_id='".$a_rol_id."'";
            $r = $this->ilDB->query($q);

            while ($row = $r->fetchRow(DB_FETCHMODE_ASSOC))
            {
                array_push($result_arr,$row["usr_id"]);
            }
        }
                
                $ilBench->stop("RBAC", "review_assignedUsers");

                return $result_arr;
        }

        function isAssigned($a_usr_id,$a_role_id)
        {
                return in_array($a_usr_id,$this->assignedUsers($a_role_id));
        }
        
        function assignedRoles($a_usr_id)
        {
                if (!isset($a_usr_id))
                {
                        $message = get_class($this)."::assignedRoles(): No user_id given!";
                        $this->ilErr->raiseError($message,$this->ilErr->WARNING);
                }

                $role_arr = array();
                
                $q = "SELECT rol_id FROM rbac_ua WHERE usr_id = '".$a_usr_id."'";
                $r = $this->ilDB->query($q);

                while ($row = $r->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $role_arr[] = $row->rol_id;
                }

                if (!count($role_arr))
                {
                        $message = get_class($this)."::assignedRoles(): No assigned roles found or user does not exist!";
                        $this->ilErr->raiseError($message,$this->ilErr->WARNING);
                }

                return $role_arr;
        }

        function isAssignable($a_rol_id, $a_ref_id)
        {
                global $ilBench;

                $ilBench->start("RBAC", "review_isAssignable");

                // exclude system role from rbac
                if ($a_rol_id == SYSTEM_ROLE_ID)
                {
                        $ilBench->stop("RBAC", "review_isAssignable");

                        return true;
                }

                if (!isset($a_rol_id) or !isset($a_ref_id))
                {
                        $message = get_class($this)."::isAssignable(): Missing parameter!".
                                           " role_id: ".$a_rol_id." ,ref_id: ".$a_ref_id;
                        $this->ilErr->raiseError($message,$this->ilErr->WARNING);
                }
                
                $q = "SELECT * FROM rbac_fa ".
                         "WHERE rol_id = '".$a_rol_id."' ".
                         "AND parent = '".$a_ref_id."'";
                $row = $this->ilDB->getRow($q);

                $ilBench->stop("RBAC", "review_isAssignable");

                return $row->assign == 'y' ? true : false;
        }

        function getFoldersAssignedToRole($a_rol_id, $a_assignable = false)
        {
                if (!isset($a_rol_id))
                {
                        $message = get_class($this)."::getFoldersAssignedToRole(): No role_id given!";
                        $this->ilErr->raiseError($message,$this->ilErr->WARNING);
                }
                
                if ($a_assignable)
                {
                        $where = " AND assign ='y'";
                }

                $q = "SELECT DISTINCT parent FROM rbac_fa ".
                         "WHERE rol_id = '".$a_rol_id."'".$where;
                $r = $this->ilDB->query($q);

                while ($row = $r->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $folders[] = $row->parent;
                }

                return $folders ? $folders : array();
        }

        function getRolesOfRoleFolder($a_ref_id,$a_nonassignable = true)
        {
                global $ilBench;
                
                $ilBench->start("RBAC", "review_getRolesOfRoleFolder");

                if (!isset($a_ref_id))
                {
                        $message = get_class($this)."::getRolesOfRoleFolder(): No ref_id given!";
                        $this->ilErr->raiseError($message,$this->ilErr->WARNING);
                }
                
                if ($a_nonassignable === false)
                {
                        $and = " AND assign='y'";
                }

                $q = "SELECT rol_id FROM rbac_fa ".
                         "WHERE parent = '".$a_ref_id."'".
                         $and;
                $r = $this->ilDB->query($q);

                while ($row = $r->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $rol_id[] = $row->rol_id;
                }

                $ilBench->stop("RBAC", "review_getRolesOfRoleFolder");

                return $rol_id ? $rol_id : array();
        }
        
        function getGlobalRoles()
        {
                return $this->getRolesOfRoleFolder(ROLE_FOLDER_ID,false);
        }

        function getGlobalRolesArray()
        {
                foreach($this->getRolesOfRoleFolder(ROLE_FOLDER_ID,false) as $role_id)
                {
                        $ga[] = array('obj_id'          => $role_id,
                                                  'role_type'   => 'global');
                }
                return $ga ? $ga : array();
        }

        function getGlobalAssignableRoles()
        {
                include_once './classes/class.ilObjRole.php';

                foreach($this->getGlobalRoles() as $role_id)
                {
                        if(ilObjRole::_getAssignUsersStatus($role_id))
                        {
                                $ga[] = array('obj_id' => $role_id,
                                                          'role_type' => 'global');
                        }
                }
                return $ga ? $ga : array();
        }

        function getAllRoleFolderIds()
        {
                $parent = array();
                
                $q = "SELECT DISTINCT parent FROM rbac_fa";
                $r = $this->ilDB->query($q);

                while ($row = $r->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $parent[] = $row->parent;
                }

                return $parent;
        }

        function getRoleFolderOfObject($a_ref_id)
        {
                global $tree,$ilBench;
                
                $ilBench->start("RBAC", "review_getRoleFolderOfObject");
                
                if (!isset($a_ref_id))
                {
                        $message = get_class($this)."::getRoleFolderOfObject(): No ref_id given!";
                        $this->ilErr->raiseError($message,$this->ilErr->WARNING);
                }

                $childs = $tree->getChildsByType($a_ref_id,"rolf");

                $ilBench->stop("RBAC", "review_getRoleFolderOfObject");

                return $childs[0] ? $childs[0] : array();
        }

        function getOperationsOfRole($a_rol_id,$a_type,$a_parent = 0)
        {
                if (!isset($a_rol_id) or !isset($a_type))
                {
                        $message = get_class($this)."::getOperationsOfRole(): Missing Parameter!".
                                           "role_id: ".$a_rol_id.
                                           "type: ".$a_type.
                                           "parent_id: ".$a_parent;
                        $this->ilErr->raiseError($message,$this->ilErr->WARNING);
                }

                $ops_arr = array();

                // if no rolefolder id is given, assume global role folder as target
                if ($a_parent == 0)
                {
                        $a_parent = ROLE_FOLDER_ID;
                }
                
                $q = "SELECT ops_id FROM rbac_templates ".
                         "WHERE type ='".$a_type."' ".
                         "AND rol_id = '".$a_rol_id."' ".
                         "AND parent = '".$a_parent."'";
                $r  = $this->ilDB->query($q);

                while ($row = $r->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $ops_arr[] = $row->ops_id;
                }

                return $ops_arr;
        }
        
        function getRoleOperationsOnObject($a_role_id,$a_ref_id)
        {
                $query = "SELECT * FROM rbac_pa ".
                        "WHERE rol_id = '".$a_role_id."' ".
                        "AND ref_id = '".$a_ref_id."'";

                $res = $this->ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $ops = unserialize(stripslashes($row->ops_id));
                }

                return $ops ? $ops : array();
        }

        function getOperationsOnType($a_typ_id)
        {
                if (!isset($a_typ_id))
                {
                        $message = get_class($this)."::getOperationsOnType(): No type_id given!";
                        $this->ilErr->raiseError($message,$this->ilErr->WARNING);
                }

                $q = "SELECT * FROM rbac_ta WHERE typ_id = '".$a_typ_id."'";
                $r = $this->ilDB->query($q);

                while($row = $r->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $ops_id[] = $row->ops_id;
                }

                return $ops_id ? $ops_id : array();
        }

        function getObjectsWithStopedInheritance($a_rol_id)
        {
                $tree = new ilTree(ROOT_FOLDER_ID);

                if (!isset($a_rol_id))
                {
                        $message = get_class($this)."::getObjectsWithStopedInheritance(): No role_id given!";
                        $this->ilErr->raiseError($message,$this->ilErr->WARNING);
                }
                        
                $all_rolf_ids = $this->getFoldersAssignedToRole($a_rol_id,false);

                foreach ($all_rolf_ids as $rolf_id)
                {
                        $parent[] = $tree->getParentId($rolf_id);
                }

                return $parent ? $parent : array();
        }

        function isDeleted($a_node_id)
        {
                $q = "SELECT tree FROM tree WHERE child ='".$a_node_id."'";
                $r = $this->ilDB->query($q);
                
                $row = $r->fetchRow(DB_FETCHMODE_OBJECT);
                
                if (!$row)
                {
                        $message = sprintf('%s::isDeleted(): Role folder with ref_id %s not found!',
                                                           get_class($this),
                                                           $a_node_id);
                        $this->log->write($message,$this->log->FATAL);

                        return true;
                }

                // rolefolder is deleted
                if ($row->tree < 0)
                {
                        return true;
                }
                
                return false;
        }

        function getRolesByFilter($a_filter = 0,$a_user_id = 0)
        {
        $assign = "y";

                switch($a_filter)
                {
            // all (assignable) roles
            case 1:
                                return $this->getAssignableRoles();
                                break;

            // all (assignable) global roles
            case 2:
                                $where = "WHERE rbac_fa.rol_id IN ";
                                $where .= '(';
                                $where .= implode(',',$this->getGlobalRoles());
                                $where .= ')';
                                break;

            // all (assignable) local roles
            case 3:
            case 4:
            case 5:
                                $where = "WHERE rbac_fa.rol_id NOT IN ";
                                $where .= '(';
                                $where .= implode(',',$this->getGlobalRoles());
                                $where .= ')';
                                break;
                                
            // all role templates
            case 6:
                                $where = "WHERE object_data.type = 'rolt'";
                                $assign = "n";
                                break;

            // only assigned roles, handled by ilObjUserGUI::roleassignmentObject()
            case 0:
                        default:
                if (!$a_user_id) return array();
                
                                $where = "WHERE rbac_fa.rol_id IN ";
                                $where .= '(';
                                $where .= implode(',',$this->assignedRoles($a_user_id));
                                $where .= ')';
                break;
                }
                
                $roles = array();

                $q = "SELECT DISTINCT * FROM object_data ".
                         "JOIN rbac_fa ".$where.
                         "AND object_data.obj_id = rbac_fa.rol_id ".
                         "AND rbac_fa.assign = '".$assign."'";
                $r = $this->ilDB->query($q);

                while ($row = $r->fetchRow(DB_FETCHMODE_OBJECT))
                {
            $prefix = (substr($row->title,0,3) == "il_") ? true : false;

            // all (assignable) internal local roles only
            if ($a_filter == 4 and !$prefix)
                        {
                continue;
            }

            // all (assignable) non internal local roles only
                        if ($a_filter == 5 and $prefix)
                        {
                continue;
            }
            
                        $roles[] = fetchObjectData($row);
                }

                $roles = $this->setRoleType($roles);

                return $roles ? $roles : array();
        }
} // END class.ilRbacReview
?>