class.ilDidacticTemplateBlockRoleAction.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 ilDidacticTemplateBlockRoleAction extends ilDidacticTemplateAction
{
    const FILTER_SOURCE_TITLE = 1;
    const FILTER_SOURCE_OBJ_ID = 2;
    const FILTER_PARENT_ROLES = 3;

    const PATTERN_PARENT_TYPE = 'action';


    private $pattern = array();
    private $filter_type = self::FILTER_SOURCE_TITLE;

    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 save()
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        parent::save();

        $query = 'INSERT INTO didactic_tpl_abr (action_id,filter_type) ' .
            'VALUES( ' .
            $ilDB->quote($this->getActionId(), 'integer') . ', ' .
            $ilDB->quote($this->getFilterType(), '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 $DIC;

        $ilDB = $DIC['ilDB'];

        parent::delete();

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

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




    public function apply()
    {
        $source = $this->initSourceObject();
        $roles = $this->filterRoles($source);

        // Create local policy for filtered roles
        foreach ($roles as $role_id => $role) {
            $this->blockRole($role_id, $source);
        }
        return true;
    }

    protected function blockRole($a_role_id, $source)
    {
        global $DIC;

        $rbacadmin = $DIC['rbacadmin'];
        $rbacreview = $DIC['rbacreview'];
        
        // Set assign to 'y' only if it is a local role
        $assign = $rbacreview->isAssignable($a_role_id, $source->getRefId()) ? 'y' : 'n';

        // Delete permissions
        $rbacadmin->revokeSubtreePermissions($source->getRefId(), $a_role_id);

        // Delete template permissions
        $rbacadmin->deleteSubtreeTemplates($source->getRefId(), $a_role_id);

        $rbacadmin->assignRoleToFolder(
            $a_role_id,
            $source->getRefId(),
            $assign
        );
        return true;
    }

    public function revert()
    {
        $source = $this->initSourceObject();
        $roles = $this->filterRoles($source);

        // Create local policy for filtered roles
        foreach ($roles as $role_id => $role) {
            $this->deleteLocalPolicy($role_id, $source);
        }
        return true;
    }

    protected function deleteLocalPolicy($a_role_id, $source)
    {
        global $DIC;

        $rbacreview = $DIC['rbacreview'];
        $rbacadmin = $DIC['rbacadmin'];

        // Create role folder if it does not exist
        //$rolf = $rbacreview->getRoleFolderIdOfObject($source->getRefId());

        if ($rbacreview->getRoleFolderOfRole($a_role_id) == $source->getRefId()) {
            ilLoggerFactory::getLogger('otpl')->debug('Ignoring local role: ' . ilObject::_lookupTitle($a_role_id));
            return false;
        }

        $rbacadmin->deleteLocalRole($a_role_id, $source->getRefId());

        // Change existing object
        include_once './Services/AccessControl/classes/class.ilObjRole.php';
        $role = new ilObjRole($a_role_id);
        $role->changeExistingObjects(
            $source->getRefId(),
            ilObjRole::MODE_UNPROTECTED_DELETE_LOCAL_POLICIES,
            array('all')
        );
        
        return true;
    }


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

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

        switch ($this->getFilterType()) {
            case self::FILTER_SOURCE_OBJ_ID:
                $writer->xmlStartTag('roleFilter', ['source' => 'objId']);
                break;

            case self::FILTER_SOURCE_TITLE:
                $writer->xmlStartTag('roleFilter', ['source' => 'title']);
                break;

            case self::FILTER_PARENT_ROLES:
                $writer->xmlStartTag('roleFilter', ['source' => 'parentRoles']);
                break;

            default:
                $writer->xmlStartTag('roleFilter', ['source' => 'title']);
                break;

        }

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

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

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

    public function read()
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

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

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

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