CapabilityBuilder.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\File\Capabilities;

use ILIAS\HTTP\Services;
use ILIAS\Services\WOPI\Discovery\ActionRepository;
use ILIAS\File\Capabilities\Check\Download;
use ILIAS\File\Capabilities\Check\EditContent;
use ILIAS\File\Capabilities\Check\Manage;
use ILIAS\File\Capabilities\Check\Unzip;
use ILIAS\File\Capabilities\Check\ViewContent;
use ILIAS\File\Capabilities\Check\None;
use ILIAS\File\Capabilities\Check\Info;
use ILIAS\File\Capabilities\Check\Edit;
use ILIAS\File\Capabilities\Check\Check;
use ILIAS\File\Capabilities\Check\CheckHelpers;
use ILIAS\File\Capabilities\Check\ForcedInfo;

class CapabilityBuilder
{
    protected array $cache = [];
    private array $checks = [];

    public function __construct(
        private \ilObjFileInfoRepository $file_info_repository,
        private \ilAccessHandler $access,
        private \ilCtrlInterface $ctrl,
        private ActionRepository $action_repository,
        private Services $http,
        private ?TypeResolver $type_resolver = null,
        private ?\ilWorkspaceAccessHandler $workspace_access_handler = null
    ) {
        $this->checks = [
            new ForcedInfo(),
            new Download(),
            new Edit(),
            new EditContent(),
            new Info(),
            new Manage(),
            new None(),
            new Unzip(),
            new ViewContent(),
        ];
        $this->type_resolver = $this->type_resolver ?? new CoreTypeResolver();
        $this->workspace_access_handler = $this->workspace_access_handler ?? new \ilWorkspaceAccessHandler();
    }

    public function get(Context $context): CapabilityCollection
    {
        if (isset($this->cache[$context->getNode()])) {
            return $this->cache[$context->getNode()];
        }

        $capabilities = [
            new Capability(Capabilities::FORCED_INFO_PAGE, ...Permissions::ANY()),
            new Capability(Capabilities::VIEW_EXTERNAL, Permissions::VIEW_CONTENT),
            new Capability(Capabilities::EDIT_EXTERNAL, Permissions::EDIT_CONTENT),
            new Capability(Capabilities::DOWNLOAD, Permissions::READ),
            new Capability(Capabilities::MANAGE_VERSIONS, Permissions::WRITE),
            new Capability(Capabilities::EDIT_SETTINGS, Permissions::WRITE),
            new Capability(Capabilities::INFO_PAGE, ...Permissions::ANY()),
            new Capability(Capabilities::NONE, Permissions::NONE),
            new Capability(Capabilities::UNZIP, Permissions::WRITE),
        ];

        if ($this->type_resolver->resolveTypeByObjectId($context->getObjectId()) !== 'file') {
            return new CapabilityCollection($capabilities);
        }

        $info = $this->file_info_repository->getByObjectId($context->getObjectId());
        $helpers = new CheckHelpers(
            $this->access,
            $this->ctrl,
            $this->action_repository,
            $this->http,
            $this->workspace_access_handler
        );

        $calling_id = $context->getCallingId();

        if ($calling_id > 0) {
            $this->ctrl->setParameterByClass(\ilObjFileGUI::class, 'ref_id', $calling_id);
        }

        foreach ($capabilities as $capability) {
            foreach ($this->checks as $check) {
                if ($check->canUnlock() === $capability->getCapability()) {
                    $capability = $check->maybeUnlock($capability, $helpers, $info, $context);
                    $capability = $check->maybeBuildURI($capability, $helpers, $context);
                }
            }
        }
        return $this->cache[$context->getNode()] = new CapabilityCollection($capabilities);
    }

}