class.ilObjFileListGUI.php

Go to the documentation of this file.

<?php

use ILIAS\File\Capabilities\CapabilityCollection;
use ILIAS\File\Icon\IconDatabaseRepository;
use ILIAS\ResourceStorage\Services;
use ILIAS\components\WOPI\Discovery\ActionDBRepository;
use ILIAS\File\Capabilities\Capabilities;
use ILIAS\File\Capabilities\CapabilityBuilder;
use ILIAS\File\Capabilities\Context;

class ilObjFileListGUI extends ilObjectListGUI
{
    use ilObjFileSecureString;

    private ilObjFileInfoRepository $file_info;
    private CapabilityBuilder $capability_builder;
    private ?CapabilityCollection $capabilities = null;
    private Context $capability_context;
    protected string $title;
    private IconDatabaseRepository $icon_repo;
    private Services $irss;

    public function __construct(int $context = self::CONTEXT_REPOSITORY)
    {
        global $DIC;
        $this->capability_context = new Context(
            0,
            0,
            match($context) {
                self::CONTEXT_REPOSITORY => Context::CONTEXT_REPO,
                self::CONTEXT_WORKSPACE => Context::CONTEXT_WORKSPACE,
                self::CONTEXT_SEARCH => Context::CONTEXT_SEARCH,
                default => Context::CONTEXT_REPO,
            }
        );

        parent::__construct($context);

        $DIC->language()->loadLanguageModule('wopi');
        $this->file_info = new ilObjFileInfoRepository();
        $this->capability_builder = new CapabilityBuilder(
            $this->file_info,
            $this->access,
            $this->ctrl,
            new ActionDBRepository($DIC->database()),
            $DIC->http(),
            $DIC['static_url.uri_builder']
        );
    }

    protected function updateContext(): void
    {
        $this->capability_context = $this->capability_context
            ->withCallingId($this->ref_id ?? 0)
            ->withObjectId($this->obj_id ?? 0);
    }

    public function insertCommands(): void
    {
    }

    #[\Override]
    public function init(): void
    {
        $this->delete_enabled = true;
        $this->cut_enabled = true;
        $this->copy_enabled = true;
        $this->subscribe_enabled = true;
        $this->link_enabled = true;
        $this->info_screen_enabled = false;
        $this->type = ilObjFile::OBJECT_TYPE;
        $this->gui_class_name = ilObjFileGUI::class;
        $this->icon_repo = new IconDatabaseRepository();

        $this->substitutions = ilAdvancedMDSubstitution::_getInstanceByObjectType($this->type);
        if ($this->substitutions->isActive()) {
            $this->substitutions_enabled = true;
        }

        $this->commands = ilObjFileAccess::_getCommands();
        $this->updateContext();
    }

    #[\Override]
    public function getCommands(): array
    {
        $this->updateContext();
        $this->capabilities = $this->capability_builder->get($this->capability_context);

        $best = $this->capabilities->getBest();

        $default_key = null;

        foreach ($this->commands as $key => $command) {
            if ($command['cmd'] === $best->getCapability()->value) {
                $default_key = $key;
                $this->commands[$key]['default'] = true;
            }
        }

        // we put a copy of the default command to the array, since otherwise its not rendered in the dropdown
        if ($default_key !== null) {
            $command_copy = $this->commands[$default_key];
            $command_copy['default'] = false;

            $commands = [];

            foreach ($this->commands as $key => $command) {
                if ($key === $default_key) {
                    $commands[] = $command_copy;
                }
                $commands[] = $command;
            }
            $this->commands = $commands;
        }

        return parent::getCommands();
    }

    #[\Override]
    public function getCommandLink(string $cmd): string
    {
        $this->updateContext();
        $this->capabilities = $this->capability_builder->get($this->capability_context);

        $needed_capability = Capabilities::fromCommand($cmd);
        $capability = $this->capabilities->get($needed_capability);
        if ($capability === false || !$capability->isUnlocked()) {
            return '';
        }

        switch ($this->context) {
            case self::CONTEXT_REPOSITORY:
                return (string) $capability->getURI();
            case self::CONTEXT_WORKSPACE:
                $this->ctrl->setParameterByClass(ilObjFileGUI::class, 'wsp_id', $this->ref_id);
                if ($cmd === "sendfile" && !ilObjFileAccess::_shouldDownloadDirectly($this->obj_id)) {
                    return $this->ctrl->getLinkTargetByClass(
                        ilObjFileGUI::class,
                        Capabilities::INFO_PAGE->value
                    );
                }
                break;
        }

        return parent::getCommandLink($cmd);
    }



    #[\Override]
    public function getTitle(): string
    {
        return $this->file_info->getByObjectId($this->obj_id)->getListTitle();
    }

    public function stripTitleOfFileExtension(string $a_title): string
    {
        return $this->secure(preg_replace('/\.[^.]*$/', '', $a_title));
    }

    #[\Override]
    public function getCommandFrame(string $cmd): string
    {
        $this->updateContext();
        $info = $this->file_info->getByObjectId($this->obj_id);

        if ($cmd === Capabilities::DOWNLOAD->value) {
            return $info->shouldDeliverInline() ? '_blank' : '';
        }

        return '';
    }

    #[\Override]
    public function getIconImageType(): string
    {
        return $this->file_info->getByObjectId($this->obj_id)->shouldDeliverInline()
            ? $this->type . '_inline'
            : $this->type;
    }

    #[\Override]
    public function getProperties(): array
    {
        global $DIC;

        $this->capabilities = $this->capability_builder->get($this->capability_context);

        $props = parent::getProperties();

        $info = $this->file_info->getByObjectId($this->obj_id);

        $props[] = [
            "alert" => false,
            "property" => $DIC->language()->txt("type"),
            "value" => $info->getSuffix(),
            'propertyNameVisible' => false,
        ];

        $props[] = [
            "alert" => false,
            "property" => $DIC->language()->txt("size"),
            "value" => (string) $info->getFileSize(),
            'propertyNameVisible' => false,
        ];

        $version = $info->getVersion();
        if ($version > 1) {
            // add versions link
            if ($this->capabilities->get(Capabilities::MANAGE_VERSIONS)->isUnlocked()) {
                $link = $this->getCommandLink("versions");
                $value = "<a href=\"$link\">" . $DIC->language()->txt("version") . ": $version</a>";
            } else {
                $value = $DIC->language()->txt("version") . ": $version";
            }
            $props[] = [
                "alert" => false,
                "property" => $DIC->language()->txt("version"),
                "value" => $value,
                "propertyNameVisible" => false
            ];
        }

        $props[] = [
            "alert" => false,
            "property" => $DIC->language()->txt("last_update"),
            "value" => ilDatePresentation::formatDate(
                new ilDateTime($info->getCreationDate()->format('U'), IL_CAL_UNIX)
            ),
            'propertyNameVisible' => false,
        ];

        if ($info->getPageCount() !== null && $info->getPageCount() > 0) {
            $props[] = [
                "alert" => false,
                "property" => $DIC->language()->txt("page_count"),
                "value" => $info->getPageCount(),
                'propertyNameVisible' => true,
            ];
        }

        return $props;
    }

    #[\Override]
    public function getCommandImage($a_cmd): string
    {
        return "";
    }

    #[\Override]
    public function checkCommandAccess(
        string $permission,
        string $cmd,
        int $ref_id,
        string $type,
        ?int $obj_id = null
    ): bool {
        $this->updateContext();

        $this->capability_context = $this->capability_context
            ->withCallingId($ref_id)
            ->withObjectId($obj_id ?? $this->capability_context->getObjectId());

        // LP settings only in repository
        if ($this->context !== self::CONTEXT_REPOSITORY && $permission === "edit_learning_progress") {
            return false;
        }

        $this->capabilities = $this->capability_builder->get($this->capability_context);

        $capability = Capabilities::fromCommand($cmd);
        $additional_check = $this->capabilities->get($capability)->isUnlocked();

        return $additional_check && parent::checkCommandAccess(
            $permission,
            $cmd,
            $ref_id,
            $type,
            $obj_id
        );
    }

}