class.ilDidacticTemplateLocalPolicyAction.php

Go to the documentation of this file.

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

include_once './Services/DidacticTemplate/classes/class.ilDidacticTemplateAction.php';

class ilDidacticTemplateLocalPolicyAction extends ilDidacticTemplateAction
{
        const TPL_ACTION_OVERWRITE = 1;
        const TPL_ACTION_INTERSECT = 2;
        const TPL_ACTION_ADD = 3;
        const TPL_ACTION_SUBTRACT = 4;
        const TPL_ACTION_UNION = 5;


        private $pattern = array();
        private $filter_type = self::FILTER_SOURCE_TITLE;
        private $role_template_type = self::TPL_ACTION_OVERWRITE;
        private $role_template_id = 0;


        public function  __construct($action_id = 0)
        {
                parent::__construct($action_id);
        }

        public function addFilterPattern(ilDidacticTemplateFilterPattern $pattern)
        {
                $this->pattern[] = $pattern;
        }

        public function setFilterPatterns(Array $patterns)
        {
                $this->pattern = $patterns;
        }

        public function getFilterPattern()
        {
                return $this->pattern;
        }

        public function setFilterType($a_type)
        {
                $this->filter_type = $a_type;
        }

        public function getFilterType()
        {
                return $this->filter_type;
        }

        public function setRoleTemplateType($a_tpl_type)
        {
                $this->role_template_type = $a_tpl_type;
        }

        public function getRoleTemplateType()
        {
                return $this->role_template_type;
        }

        public function setRoleTemplateId($a_id)
        {
                $this->role_template_id = $a_id;
        }

        public function getRoleTemplateId()
        {
                return $this->role_template_id;
        }

        public function save()
        {
                global $ilDB;

                parent::save();

                $query = 'INSERT INTO didactic_tpl_alp (action_id,filter_type,template_type,template_id) '.
                        'VALUES( '.
                        $ilDB->quote($this->getActionId(),'integer').', '.
                        $ilDB->quote($this->getFilterType(),'integer').', '.
                        $ilDB->quote($this->getRoleTemplateType(),'integer').', '.
                        $ilDB->quote($this->getRoleTemplateId(),'integer').' '.
                        ')';
                $ilDB->manipulate($query);

                foreach($this->getFilterPattern() as $pattern)
                {
                        /* @var ilDidacticTemplateFilterPattern $pattern */
                        $pattern->setParentId($this->getActionId());
                        $pattern->setParentType(self::PATTERN_PARENT_TYPE);
                        $pattern->save();
                }
        }

        public function delete()
        {
                global $ilDB;

                parent::delete();

                $query = 'DELETE FROM didactic_tpl_alp '.
                        'WHERE action_id  = '.$ilDB->quote($this->getActionId(),'integer');
                $ilDB->manipulate($query);

                foreach($this->getFilterPattern() as $pattern)
                {
                        $pattern->delete();
                }
                return true;
        }




        public function  apply()
        {
                $rbacreview = $GLOBALS['DIC']->rbac()->review();

                $source = $this->initSourceObject();
                // Create a role folder for the new local policies

                $roles = $this->filterRoles($source);

                // Create local policy for filtered roles
                foreach($roles as $role_id => $role)
                {
                        $this->getLogger()->debug('Apply to role: ' . $role['title']);

                        // No local policies for protected roles of higher context
                        if(
                                $rbacreview->isProtected($role['parent'], $role_id) &&
                                $role['parent'] != $source->getRefId()
                        )
                        {
                                $this->getLogger()->debug('Ignoring protected role.');
                                continue;
                        }
                        $this->createLocalPolicy($source,$role);
                }
                return true;
        }

        public function  revert()
        {
                global $rbacadmin,$tree;
                $rbacreview = $GLOBALS['DIC']->rbac()->review();

                $source = $this->initSourceObject();
                $roles = $this->filterRoles($source);

                // Delete local policy for filtered roles
                foreach($roles as $role_id => $role)
                {
                        // Do not delete local policies of auto genrated roles
                        if(!$rbacreview->isGlobalRole($role['obj_id']) and
                                $rbacreview->isAssignable($role['obj_id'],$source->getRefId()) and
                                $rbacreview->isSystemGeneratedRole($role['obj_id']))
                        {
                                $this->getLogger()->debug('Reverting local policy of auto generated role: ' . $role['title']);
                                $this->revertLocalPolicy($source, $role);
                        }
                        else
                        {
                                $this->getLogger()->debug('Reverting local policy and deleting local role: ' . $role['title']);

                                // delete local role and change exiting objects
                                $rbacadmin->deleteLocalRole($role_id,$source->getRefId());
                                // Change existing object
                                include_once './Services/AccessControl/classes/class.ilObjRole.php';
                                $role_obj = new ilObjRole($role_id);
                                
                                $protected = $rbacreview->isProtected($role['parent'], $role['rol_id']);
                                
                                $role_obj->changeExistingObjects(
                                        $source->getRefId(),
                                        $protected ? 
                                                ilObjRole::MODE_PROTECTED_DELETE_LOCAL_POLICIES : 
                                                ilObjRole::MODE_UNPROTECTED_DELETE_LOCAL_POLICIES,
                                        array('all')
                                );
                        }
                        
                }
                return true;
        }

        public function getType()
        {
                return self::TYPE_LOCAL_POLICY;
        }

        public function  toXml(ilXmlWriter $writer)
        {
                $writer->xmlStartTag('localPolicyAction');

                switch($this->getFilterType())
                {
                        case self::FILTER_SOURCE_TITLE:
                                $writer->xmlStartTag('roleFilter',array('source' => 'title'));
                                break;

                        case self::FILTER_SOURCE_OBJ_ID:
                                $writer->xmlStartTag('roleFilter',array('source' => 'objId'));
                                break;

                }

                foreach($this->getFilterPattern() as $pattern)
                {
                        $pattern->toXml($writer);
                }
                $writer->xmlEndTag('roleFilter');

                $il_role_id = 'il_'.IL_INST_ID.'_'.ilObject::_lookupType($this->getRoleTemplateId()).'_'.$this->getRoleTemplateId();

                switch($this->getRoleTemplateType())
                {
                        case self::TPL_ACTION_OVERWRITE:
                                $writer->xmlStartTag(
                                        'localPolicyTemplate',
                                        array(
                                                'type'  => 'overwrite',
                                                'id'    => $il_role_id
                                        )
                                );
                                break;

                        case self::TPL_ACTION_INTERSECT:
                                $writer->xmlStartTag(
                                        'localPolicyTemplate',
                                        array(
                                                'type'  => 'intersect',
                                                'id'    => $il_role_id
                                        )
                                );
                                break;

                        case self::TPL_ACTION_UNION:
                                $writer->xmlStartTag(
                                        'localPolicyTemplate',
                                        array(
                                                'type'  => 'union',
                                                'id'    => $il_role_id
                                        )
                                );
                                break;
                }

                include_once './Services/AccessControl/classes/class.ilRoleXmlExport.php';
                $exp = new ilRoleXmlExport();
                $exp->setMode(ilRoleXmlExport::MODE_DTPL);
                $exp->addRole($this->getRoleTemplateId(), ROLE_FOLDER_ID);
                $exp->write();
                $writer->appendXML($exp->xmlDumpMem(FALSE));
                $writer->xmlEndTag('localPolicyTemplate');
                $writer->xmlEndTag('localPolicyAction');
                return void;
        }

        public function  __clone()
        {
                parent::__clone();

                // Clone patterns
                $cloned = array();
                foreach($this->getFilterPattern() as $pattern)
                {
                        $clones[] = clone $pattern;
                }
                $this->setFilterPatterns($clones);
        }

        public function read()
        {
                global $ilDB;

                if(!parent::read())
                {
                        return false;
                }

                $query = 'SELECT * FROM didactic_tpl_alp '.
                        'WHERE action_id = '.$ilDB->quote($this->getActionId());
                $res = $ilDB->query($query);
                while($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT))
                {
                        $this->setFilterType($row->filter_type);
                        $this->setRoleTemplateType($row->template_type);
                        $this->setRoleTemplateId($row->template_id);
                }

                // Read filter
                include_once './Services/DidacticTemplate/classes/class.ilDidacticTemplateFilterPatternFactory.php';
                foreach(ilDidacticTemplateFilterPatternFactory::lookupPatternsByParentId($this->getActionId(),self::PATTERN_PARENT_TYPE) as $pattern)
                {
                        $this->addFilterPattern($pattern);
                }
        }


        protected function createLocalPolicy(ilObject $source, $role)
        {
                global $rbacreview, $rbacadmin;
                
                // fetch role information
                $role_data = array();
                foreach($rbacreview->getParentRoleIds($source->getRefId()) as $role_id => $tmp_role)
                {
                        if($role_id == $role['obj_id'])
                        {
                                $role_data = $tmp_role;
                        }
                }
                
                // Add local policy
                if(!$rbacreview->isRoleAssignedToObject($role['obj_id'],$source->getRefId()))
                {
                        $GLOBALS['DIC']->rbac()->admin()->assignRoleToFolder(
                                $role['obj_id'],
                                $source->getRefId(),
                                'n'
                        );
                }
                
                // do nothing if role is protected in higher context
                if(
                        $GLOBALS['DIC']->rbac()->review()->isProtected($source->getRefId(),$role['obj_id'])
                )
                {
                        $GLOBALS['DIC']->logger()->otpl()->info('Ignoring protected role: ' . $role['title']);
                        return true;
                }

                switch($this->getRoleTemplateType())
                {
                        case self::TPL_ACTION_UNION:

                                ilLoggerFactory::getLogger('otpl')->info('Using ilRbacAdmin::copyRolePermissionUnion()');
                                $rbacadmin->copyRolePermissionUnion(
                                        $role_data['obj_id'],
                                        $role_data['parent'],
                                        $this->getRoleTemplateId(),
                                        ROLE_FOLDER_ID,
                                        $role_data['obj_id'],
                                        $source->getRefId()
                                );
                                break;

                        case self::TPL_ACTION_OVERWRITE:

                                ilLoggerFactory::getLogger('otpl')->info('Using ilRbacAdmin::copyRoleTemplatePermission()');
                                $rbacadmin->copyRoleTemplatePermissions(
                                        $this->getRoleTemplateId(),
                                        ROLE_FOLDER_ID,
                                        $source->getRefId(),
                                        $role_data['obj_id'],
                                        true
                                );
                                break;

                        case self::TPL_ACTION_INTERSECT:

                                ilLoggerFactory::getLogger('otpl')->info('Using ilRbacAdmin::copyRolePermissionIntersection()'. $this->getRoleTemplateId());
                                $rbacadmin->copyRolePermissionIntersection(
                                        $role_data['obj_id'],
                                        $role_data['parent'],
                                        $this->getRoleTemplateId(),
                                        ROLE_FOLDER_ID,
                                        $source->getRefId(),
                                        $role_data['obj_id']
                                );
                                break;

                }

                // Change existing object
                include_once './Services/AccessControl/classes/class.ilObjRole.php';
                $role_obj = new ilObjRole($role_data['obj_id']);
                $role_obj->changeExistingObjects(
                        $source->getRefId(),
                        $role_data['protected'] ? ilObjRole::MODE_PROTECTED_DELETE_LOCAL_POLICIES : ilObjRole::MODE_UNPROTECTED_DELETE_LOCAL_POLICIES,
                        array('all')
                );

                return true;
        }

        protected function revertLocalPolicy(ilObject $source, $role)
        {
                global $rbacadmin, $rbacreview, $ilDB;

                ilLoggerFactory::getLogger('otpl')->info('Reverting policy for role '. $role['title']);
                // Local policies can only be reverted for auto generated roles. Otherwise the
                // original role settings are unknown
                if(substr($role['title'],0,3) != 'il_')
                {
                        ilLoggerFactory::getLogger('otpl')->warning('Cannot revert local policy for role '. $role['title']);
                        return false;
                }


                // No local policies
                if(!$rbacreview->getLocalPolicies($source->getRefId()))
                {
                        return false;
                }

                $exploded_title = explode('_',$role['title']);
                $rolt_title = $exploded_title[0].'_'.$exploded_title[1].'_'.$exploded_title[2];

                // Lookup role template
                $query = 'SELECT obj_id FROM object_data '.
                        'WHERE title = '.$ilDB->quote($rolt_title,'text').' '.
                        'AND type = '.$ilDB->quote('rolt','text');
                $res = $ilDB->query($query);
                while($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT))
                {
                        $rolt_id = $row->obj_id;
                }

                // No template found
                if(!$rolt_id)
                {
                        return false;
                }

                $rbacadmin->copyRoleTemplatePermissions(
                        $rolt_id,
                        ROLE_FOLDER_ID,
                        $source->getRefId(),
                        $role['obj_id'],
                        true
                );

                // Change existing object
                include_once './Services/AccessControl/classes/class.ilObjRole.php';
                $role_obj = new ilObjRole($role['obj_id']);
                $role_obj->changeExistingObjects(
                        $source->getRefId(),
                        $role['protected'] ? ilObjRole::MODE_PROTECTED_DELETE_LOCAL_POLICIES : ilObjRole::MODE_UNPROTECTED_DELETE_LOCAL_POLICIES,
                        array('all')
                );
        }
}
?>