CmdPermission.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\Repository\Permission;
 
abstract class CmdPermission implements CmdPermissionInterface
{
    public function __construct(
        protected \ilLanguage $lng,
        protected ?\ilGlobalTemplateInterface $tpl = null,
        protected ?\ilCtrlInterface $ctrl = null,
    ) {
    }
 
    public function isRequestCommandPermitted(): bool
    {
        if (is_null($this->ctrl)) {
            return false;
        }
        if (!$this->isRequestMultiCommand()) {
            return $this->isCommandPermitted(
                $this->getRequestCommand(),
                $this->getRequestNodeId(),
                (string) $this?->getRequestEntity()->getType(),
                (string) $this?->getRequestEntity()->getId()
            );
        } else {
            return $this->isCommandPermittedMulti(
                $this->getRequestCommand(),
                $this->getRequestNodeId(),
                (string) $this?->getRequestEntity()->getType(),
                (array) $this?->getRequestEntity()->getId()
            );
        }
    }
 
    public function isRequestMultiCommand(): bool
    {
        return is_array($this?->getRequestEntity()->getId());
    }
 
    public function isTableCommandPermitted(string $cmd, string $entity_id): bool
    {
        if (is_null($this->ctrl)) {
            return false;
        }
        return $this->isCommandPermitted(
            $cmd,
            $this->getRequestNodeId(),
            (string) $this?->getRequestEntity()->getType(),
            $entity_id
        );
    }
 
    public function isCommandPermittedMulti(
        string $cmd,
        int $node_id,
        string $entity,
        array $entity_ids
    ): bool {
        return array_all(
            $entity_ids,
            fn($entity_id) => $this->isCommandPermitted($cmd, $node_id, $entity, $entity_id)
        );
    }
 
 
    public function getPermittedCommand(): string
    {
        if ($this->isRequestCommandPermitted()) {
            return $this->getRequestCommand();
        }
        return "";
    }
 
    public function getRequestCommand(): string
    {
        return $this->ctrl->getCmd($this->getDefaultCommand());
    }
 
    protected function isClass(string $class): bool
    {
        if (is_null($this->ctrl)) {
            return false;
        }
        $cmd_class = $this->ctrl->getCmdClass();
        return $cmd_class === strtolower($class);
    }
 
    public function getDefaultCommand(): string
    {
        return "";
    }
 
 
    public function checkCommand(string $cmd, int $node_id, string $entity, string $entity_id = ""): void
    {
        if (!$this->isCommandPermitted($cmd, $node_id, $entity, $entity_id)) {
            throw new \ILIAS\Repository\Permission\ilNoCmdPermissionException("No permission to execute command $cmd on $entity $entity_id");
        }
    }
 
    protected function cmdEntity(
        string $type,
        string|array $id = ""
    ): CmdEntity {
        return new CmdEntity(
            $type,
            $id
        );
    }
 
    public function forwardPermitted(
        object $from_gui,
        object $to_gui
    ): mixed {
        if (is_null($this->ctrl)) {
            return null;
        }
        if ($this->isForwardPermitted(get_class($from_gui), get_class($to_gui))) {
            return $this->ctrl->forwardCommand($to_gui);
        }
        if ($this->access->checkAccess("read", "", ROOT_FOLDER_ID)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('permission_denied'), true);
            $this->ctrl->setParameterByClass("ilRepositoryGUI", "ref_id", ROOT_FOLDER_ID);
            $this->ctrl->redirectByClass("ilRepositoryGUI");
        }
        throw new \ilPermissionException($this->lng->txt("permission_denied"));
    }
 
    public function classImplementsMethodDirectly(string $className, string $method): bool
    {
        try {
            $class = new \ReflectionClass($className);
        } catch (\Exception $e) {
            return false;
        }
 
        return $class->hasMethod($method)
            && $class->getMethod($method)->getDeclaringClass()->getName() === $class->getName();
    }
}