class.ilObjectCustomIconImpl.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2018 ILIAS open source, Extended GPL, see docs/LICENSE */
 
use ILIAS\Filesystem\Filesystem;
use ILIAS\FileUpload\FileUpload;
 
class ilObjectCustomIconImpl implements \ilObjectCustomIcon
{
    const ICON_BASENAME = 'icon_custom';
 
    protected $webDirectory;
 
    protected $upload;
 
    protected $config;
 
    protected $objId;
 
    public function __construct(Filesystem $webDirectory, FileUpload $uploadService, \ilCustomIconObjectConfiguration $config, int $objId)
    {
        $this->objId = $objId;
 
        $this->webDirectory = $webDirectory;
        $this->upload = $uploadService;
        $this->config = $config;
    }
 
    protected function getObjId() : int
    {
        return $this->objId;
    }
 
    public function copy(int $targetObjId)
    {
        if (!$this->exists()) {
            \ilContainer::_writeContainerSetting($targetObjId, 'icon_custom', 0);
            return;
        }
 
        try {
            $this->webDirectory->copy(
                $this->getRelativePath(),
                preg_replace(
                    '/(' . $this->config->getSubDirectoryPrefix() . ')(\d*)\/(.*)$/',
                    '${1}' . $targetObjId . '/${3}',
                    $this->getRelativePath()
                )
            );
 
            \ilContainer::_writeContainerSetting($targetObjId, 'icon_custom', 1);
        } catch (\Exception $e) {
            \ilContainer::_writeContainerSetting($targetObjId, 'icon_custom', 0);
        }
    }
 
    public function delete()
    {
        if ($this->webDirectory->hasDir($this->getIconDirectory())) {
            try {
                $this->webDirectory->deleteDir($this->getIconDirectory());
            } catch (\Exception $e) {
            }
        }
 
        \ilContainer::_deleteContainerSettings($this->getObjId(), 'icon_custom');
    }
 
    public function getSupportedFileExtensions() : array
    {
        return $this->config->getSupportedFileExtensions();
    }
 
    public function saveFromSourceFile(string $sourceFilePath)
    {
        $this->createCustomIconDirectory();
 
        $fileName = $this->getRelativePath();
 
        if ($this->webDirectory->has($fileName)) {
            $this->webDirectory->delete($fileName);
        }
 
        $this->webDirectory->copy($sourceFilePath, $fileName);
 
        $this->persistIconState($fileName);
    }
 
    public function saveFromHttpRequest()
    {
        $this->createCustomIconDirectory();
 
        $fileName = $this->getRelativePath();
 
        if ($this->webDirectory->has($fileName)) {
            $this->webDirectory->delete($fileName);
        }
 
        if ($this->upload->hasUploads() && !$this->upload->hasBeenProcessed()) {
            $this->upload->process();
 
            $result = array_values($this->upload->getResults())[0];
            if ($result->getStatus() == \ILIAS\FileUpload\DTO\ProcessingStatus::OK) {
                $this->upload->moveOneFileTo(
                    $result,
                    $this->getIconDirectory(),
                    \ILIAS\FileUpload\Location::WEB,
                    $this->getIconFileName(),
                    true
                );
            }
 
            foreach ($this->config->getUploadPostProcessors() as $processor) {
                $processor->process($fileName);
            }
        }
 
        $this->persistIconState($fileName);
    }
 
    protected function persistIconState(string $fileName)
    {
        if ($this->webDirectory->has($fileName)) {
            \ilContainer::_writeContainerSetting($this->getObjId(), 'icon_custom', 1);
        } else {
            \ilContainer::_writeContainerSetting($this->getObjId(), 'icon_custom', 0);
        }
    }
 
    public function remove()
    {
        $fileName = $this->getRelativePath();
 
        if ($this->webDirectory->has($fileName)) {
            $this->webDirectory->delete($fileName);
        }
 
        \ilContainer::_writeContainerSetting($this->getObjId(), 'icon_custom', 0);
    }
 
    protected function createCustomIconDirectory()
    {
        $iconDirectory = $this->getIconDirectory();
 
        if (!$this->webDirectory->has(dirname($iconDirectory))) {
            $this->webDirectory->createDir(dirname($iconDirectory));
        }
 
        if (!$this->webDirectory->has($iconDirectory)) {
            $this->webDirectory->createDir($iconDirectory);
        }
    }
 
    protected function getIconDirectory() : string
    {
        return implode(DIRECTORY_SEPARATOR, [
            $this->config->getBaseDirectory(),
            $this->config->getSubDirectoryPrefix() . $this->getObjId()
        ]);
    }
 
    protected function getIconFileName() : string
    {
        return self::ICON_BASENAME . '.' . $this->config->getTargetFileExtension();
    }
 
    protected function getRelativePath() : string
    {
        return implode(DIRECTORY_SEPARATOR, [
            $this->getIconDirectory(),
            $this->getIconFileName()
        ]);
    }
 
    public function exists() : bool
    {
        if (!\ilContainer::_lookupContainerSetting($this->getObjId(), 'icon_custom', 0)) {
            return false;
        }
 
        return $this->webDirectory->has($this->getRelativePath());
    }
 
    public function getFullPath() : string
    {
        // TODO: Currently there is no option to get the relative base directory of a filesystem
        return implode(DIRECTORY_SEPARATOR, [
            \ilUtil::getWebspaceDir(),
            $this->getRelativePath()
        ]);
    }
 
    public function createFromImportDir($source_dir)
    {
        $target_dir = implode(DIRECTORY_SEPARATOR, [
            \ilUtil::getWebspaceDir(),
            $this->getIconDirectory()
        ]);
        ilUtil::rCopy($source_dir, $target_dir);
        $this->persistIconState($this->getRelativePath());
    }
}