class.ilBadgeImageTemplate.php

Go to the documentation of this file.

<?php

use ILIAS\FileUpload\Exception\IllegalStateException;
use ILIAS\ResourceStorage\Services;
use ILIAS\FileUpload\FileUpload;
use ILIAS\Badge\ilBadgeImage;
use ILIAS\ResourceStorage\Identification\ResourceIdentification;

class ilBadgeImageTemplate
{
    protected ilDBInterface $db;
    protected int $id = 0;
    protected string $title = "";
    protected string $image = "";
    protected ?string $image_rid = "";
    protected ?array $types = null;
    protected Services $resource_storage;
    protected FileUpload $upload_service;
    protected ilGlobalTemplateInterface $main_template;

    public function __construct(?int $a_id = null)
    {
        global $DIC;

        $this->resource_storage = $DIC->resourceStorage();
        $this->upload_service = $DIC->upload();
        $this->main_template = $DIC->ui()->mainTemplate();
        $this->db = $DIC->database();
        if ($a_id) {
            $this->read($a_id);
        }
    }

    public static function getInstances(): array
    {
        global $DIC;

        $ilDB = $DIC->database();

        $res = array();

        $types = array();
        $set = $ilDB->query("SELECT * FROM badge_image_templ_type");
        while ($row = $ilDB->fetchAssoc($set)) {
            $types[$row["tmpl_id"]][] = $row["type_id"];
        }

        $set = $ilDB->query("SELECT * FROM badge_image_template" .
            " ORDER BY title");
        while ($row = $ilDB->fetchAssoc($set)) {
            $row["types"] = (array) ($types[$row["id"]] ?? null);

            $obj = new self();
            $obj->importDBRow($row);
            $res[] = $obj;
        }

        return $res;
    }

    public static function getInstancesByType(string $a_type_unique_id): array
    {
        $res = [];

        foreach (self::getInstances() as $tmpl) {
            if (!count($tmpl->getTypes()) || in_array($a_type_unique_id, $tmpl->getTypes(), true)) {
                $res[] = $tmpl;
            }
        }

        return $res;
    }


    //
    // setter/getter
    //

    protected function setId(int $a_id): void
    {
        $this->id = $a_id;
    }

    public function getId(): int
    {
        return $this->id;
    }

    public function setTitle(string $a_value): void
    {
        $this->title = trim($a_value);
    }

    public function getTitle(): string
    {
        return $this->title;
    }

    protected function setImage(?string $a_value): void
    {
        if ($a_value !== null) {
            $this->image = trim($a_value);
        }
    }

    public function getTypes(): ?array
    {
        return $this->types;
    }

    public function setTypes(?array $types = null): void
    {
        $this->types = is_array($types)
            ? array_unique($types)
            : null;
    }

    public function getImage(): string
    {
        return $this->image;
    }

    public function uploadImage(array $a_upload_meta): void
    {
        if ($this->getId() &&
            $a_upload_meta["tmp_name"]) {
            $path = $this->getFilePath($this->getId());

            $filename = ilFileUtils::getValidFilename($a_upload_meta["name"]);

            $exp = explode(".", $filename);
            $suffix = strtolower(array_pop($exp));
            $tgt = $path . "img" . $this->getId() . "." . $suffix;

            if (ilFileUtils::moveUploadedFile($a_upload_meta["tmp_name"], "img" . $this->getId() . "." . $suffix, $tgt)) {
                $this->setImage($filename);
                $this->update();
            }
        }
    }

    public function processImageUpload(ilBadgeImageTemplate $badge): void
    {
        try {
            if (!$this->upload_service->hasBeenProcessed()) {
                $this->upload_service->process();
            }
            if ($this->upload_service->hasUploads()) {
                $array_result = $this->upload_service->getResults();
                $array_result = array_pop($array_result);
                if ($array_result->getName() !== '') {
                    $this->resource_storage->manage()->remove(new ResourceIdentification($badge->getImageRid()), new ilBadgeFileStakeholder());
                    $stakeholder = new ilBadgeFileStakeholder();
                    $identification = $this->resource_storage->manage()->upload($array_result, $stakeholder);
                    $this->resource_storage->flavours()->ensure($identification, new \ilBadgePictureDefinition());
                    $badge->setImageRid($identification);
                    $badge->update();
                }
            }
        } catch (IllegalStateException $e) {
            $this->main_template->setOnScreenMessage('failure', $e->getMessage(), true);
        }
    }

    public function getImagePath(): string
    {
        if ($this->getId()) {
            if (is_file($this->getFilePath($this->getId()) . "img" . $this->getId())) { // formerly (early 5.2 versino), images have been uploaded with no suffix
                return $this->getFilePath($this->getId()) . "img" . $this->getId();
            }

            $exp = explode(".", $this->getImage());
            $suffix = strtolower(array_pop($exp));
            return $this->getFilePath($this->getId()) . "img" . $this->getId() . "." . $suffix;
        }
        return "";
    }

    protected function getFilePath(
        int $a_id,
        ?string $a_subdir = null
    ): string {
        $storage = new ilFSStorageBadgeImageTemplate($a_id);
        $storage->create();

        $path = $storage->getAbsolutePath() . "/";

        if ($a_subdir) {
            $path .= $a_subdir . "/";

            if (!is_dir($path)) {
                mkdir($path);
            }
        }

        return $path;
    }


    //
    // crud
    //

    protected function read(int $a_id): void
    {
        $ilDB = $this->db;

        $set = $ilDB->query("SELECT * FROM badge_image_template" .
            " WHERE id = " . $ilDB->quote($a_id, "integer"));
        if ($ilDB->numRows($set)) {
            $row = $ilDB->fetchAssoc($set);
            $row["types"] = $this->readTypes($a_id);
            $this->importDBRow($row);
        }
    }

    protected function readTypes(int $a_id): ?array
    {
        $ilDB = $this->db;

        $res = array();

        $set = $ilDB->query("SELECT * FROM badge_image_templ_type WHERE tmpl_id = " . $ilDB->quote($a_id, "integer"));
        while ($row = $ilDB->fetchAssoc($set)) {
            $res[] = $row["type_id"];
        }

        if (!count($res)) {
            $res = null;
        }

        return $res;
    }

    protected function importDBRow(array $a_row): void
    {
        $this->setId($a_row["id"]);
        $this->setTitle($a_row["title"]);
        if (isset($a_row["image"])) {
            $this->setImage($a_row["image"]);
        }
        if (isset($a_row["image_rid"])) {
            $this->setImageRid($a_row["image_rid"]);
        }
        $this->setTypes($a_row["types"]);
    }

    public function create(): void
    {
        $ilDB = $this->db;

        if ($this->getId()) {
            $this->update();
            return;
        }

        $id = $ilDB->nextId("badge_image_template");
        $this->setId($id);

        $fields = $this->getPropertiesForStorage();
        $fields["id"] = array("integer", $id);

        $ilDB->insert("badge_image_template", $fields);

        $this->saveTypes();
    }

    public function update(): void
    {
        $ilDB = $this->db;

        if (!$this->getId()) {
            $this->create();
            return;
        }

        $fields = $this->getPropertiesForStorage();

        $ilDB->update(
            "badge_image_template",
            $fields,
            array("id" => array("integer", $this->getId()))
        );

        $this->saveTypes();
    }

    public function delete(): void
    {
        $ilDB = $this->db;

        if (!$this->getId()) {
            return;
        }

        $path = $this->getFilePath($this->getId());
        ilFileUtils::delDir($path);

        $ilDB->manipulate("DELETE FROM badge_image_template" .
            " WHERE id = " . $ilDB->quote($this->getId(), "integer"));
    }

    protected function getPropertiesForStorage(): array
    {
        return [
            "title" => ["text", $this->getTitle()],
            "image" => ["text", $this->getImage()],
            "image_rid" => ["text", $this->getImageRid()]
        ];
    }

    protected function saveTypes(): void
    {
        $ilDB = $this->db;

        if ($this->getId()) {
            $ilDB->manipulate("DELETE FROM badge_image_templ_type" .
                " WHERE tmpl_id = " . $ilDB->quote($this->getId(), "integer"));

            if ($this->getTypes()) {
                foreach ($this->getTypes() as $type) {
                    $fields = array(
                        "tmpl_id" => array("integer", $this->getId()),
                        "type_id" => array("text", $type)
                    );
                    $ilDB->insert("badge_image_templ_type", $fields);
                }
            }
        }
    }

    public function getImageRid(): ?string
    {
        return $this->image_rid;
    }

    public function setImageRid(?string $image_rid = null): void
    {
        $this->image_rid = $image_rid;
    }

    public function getImageFromResourceId(
        int $size = ilBadgeImage::IMAGE_SIZE_XS
    ): string {
        $image_src = '';

        if ($this->getImageRid()) {
            $identification = $this->resource_storage->manage()->find($this->getImageRid());
            if ($identification !== null) {
                $flavour = $this->resource_storage->flavours()->get($identification, new ilBadgePictureDefinition());
                $urls = $this->resource_storage->consume()->flavourUrls($flavour)->getURLsAsArray();
                if (count($urls) === ilBadgeImage::IMAGE_URL_COUNT && isset($urls[$size])) {
                    $image_src = $urls[$size];
                }
            }
        } elseif ($this->getImage()) {
            $image_src = ilWACSignedPath::signFile($this->getImagePath());
        }

        return $image_src;
    }
}