class.ilClaimingPermissionHelper.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2013 ILIAS open source, Extended GPL, see docs/LICENSE */

abstract class ilClaimingPermissionHelper
{
        protected $user_id; // [int]
        protected $ref_id; // [int]
        protected $map; // [array]
        protected $context_ids; // [array]
        protected $plugins; // [array]
        
        protected static $instances; // [array]
                
        
        // constructor
        
        protected function __construct($a_user_id, $a_ref_id)
        {               
                $this->setUserId($a_user_id);
                $this->setRefId($a_ref_id);
                $this->map = $this->buildPermissionMap();
                $this->reset();
        }
        
        public static function getInstance($a_user_id = null, $a_ref_id = null)
        {
                global $ilUser;
                
                if(!$a_user_id)
                {
                        $a_user_id = $ilUser->getId();
                }       
                if(!$a_ref_id)
                {
                        $a_ref_id = (int)$_REQUEST["ref_id"];
                }       
                if(!isset(self::$instances[$a_user_id][$a_ref_id]))
                {
                        self::$instances[$a_user_id][$a_ref_id] = new static($a_user_id, $a_ref_id);
                }
                return self::$instances[$a_user_id][$a_ref_id];
        }
        
        public function reset()
        {
                $this->context_ids = array();
        }
        
        
        // properties
        
        protected function setUserId($a_value)
        {
                $this->user_id = (int)$a_value;
        }
        
        protected function getUserId()
        {
                return $this->user_id;
        }
                
        protected function setRefId($a_value)
        {
                $this->ref_id = (int)$a_value;
        }
        
        protected function getRefId()
        {
                return $this->ref_id;
        }
        
        
        // caching
        
        abstract protected function readContextIds($a_context_type);
        
        
        // permissions
        
        abstract protected function buildPermissionMap();
                
        protected function isValidContextAndAction($a_context_type, $a_context_id, $a_action_id, $a_action_sub_id = null)
        {       
                $valid = false;
                
                if(array_key_exists($a_context_type, $this->map))
                {
                        if(!$a_action_sub_id)
                        {
                                if(in_array($a_action_id, $this->map[$a_context_type]["actions"]))
                                {
                                        $valid = true;
                                }
                        }
                        else
                        {
                                if(array_key_exists($a_action_id, $this->map[$a_context_type]["subactions"]) &&
                                        in_array($a_action_sub_id, $this->map[$a_context_type]["subactions"][$a_action_id]))
                                {
                                        $valid = true;
                                }
                        }
                }
                
                if($valid && 
                        $a_context_id && 
                        !in_array($a_context_id, $this->getValidContextIds($a_context_type)))
                {
                        $valid = false;
                }
                
                if(DEVMODE && !$valid)
                {
                        trigger_error("INVALID permission context - ".$a_context_type.":".$a_context_id.":".$a_action_id.":".$a_action_sub_id, E_USER_WARNING);
                }
                
                return $valid;
        }
        
        protected function getValidContextIds($a_context_type)
        {
                if(!array_key_exists($a_context_type, $this->context_ids))
                {
                        $this->context_ids[$a_context_type] = $this->readContextIds($a_context_type);                   
                }       
                return (array)$this->context_ids[$a_context_type];
        }
                        
        public function hasPermission($a_context_type, $a_context_id, $a_action_id, $a_action_sub_id = null)
        {
                if($this->isValidContextAndAction($a_context_type, $a_context_id, $a_action_id, $a_action_sub_id))
                {
                        return $this->checkPermission($a_context_type, $a_context_id, $a_action_id, $a_action_sub_id);
                }                       
                // :TODO: exception?
        }
        
        public function hasPermissions($a_context_type, $a_context_id, array $a_action_ids)
        {               
                $res = array();
                
                foreach($a_action_ids as $action_id)
                {                       
                        if(is_array($action_id))
                        {
                                $action_sub_id = $action_id[1];
                                $action_id = $action_id[0];
                                
                                $res[$action_id][$action_sub_id] = $this->hasPermission($a_context_type, $a_context_id, $action_id, $action_sub_id);
                        }
                        else
                        {
                                $res[$action_id] = $this->hasPermission($a_context_type, $a_context_id, $action_id);
                        }                       
                }
        
                return $res;
        }
        
        protected function checkPermission($a_context_type, $a_context_id, $a_action_id, $a_action_sub_id = null)
        {               
                return ($this->checkRBAC() && 
                        $this->checkPlugins($a_context_type, $a_context_id, $a_action_id, $a_action_sub_id));
        }
        
        protected function checkRBAC()
        {
                global $ilAccess;
                
                // we are currently only supporting write operations
                return $ilAccess->checkAccessOfUser($this->getUserId(), "write", "", $this->getRefId());                
        }
        
        abstract protected function getActivePlugins();
        
        protected function checkPlugins($a_context_type, $a_context_id, $a_action_id, $a_action_sub_id = null)
        {               
                $valid = true;
                
                if(!is_array($this->plugins))
                {
                        $this->plugins = (array)$this->getActivePlugins();      
                }
                
                foreach($this->plugins as $plugin)
                {               
                        if(!$plugin->checkPermission($this->getUserId(), $a_context_type, $a_context_id, $a_action_id, $a_action_sub_id))
                        {                       
                                $valid = false;
                                break;
                        }
                }               
                
                return $valid;           
        }               
}

?>