class.ilMDCopyrightSelectionEntry.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\MetaData\Copyright\Renderer;
use ILIAS\MetaData\Copyright\CopyrightData;
use ILIAS\Data\URI;
use ILIAS\MetaData\Copyright\CopyrightDataInterface;
use ILIAS\MetaData\Copyright\NullCopyrightData;

class ilMDCopyrightSelectionEntry
{
    protected ilLogger $logger;
    protected ilDBInterface $db;

    private int $entry_id;
    private string $title = '';
    private string $description = '';
    private string $copyright = '';
    private bool $costs = false;
    private string $language = '';
    private bool $copyright_and_other_restrictions = true;
    private int $usage = 0;

    protected bool $outdated = false;

    protected int $order_position = 0;

    protected CopyrightDataInterface $copyright_data;

    public function __construct(int $a_entry_id)
    {
        global $DIC;

        $this->logger = $DIC->logger()->meta();
        $this->db = $DIC->database();
        $this->entry_id = $a_entry_id;
        $this->read();
    }

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

        $ilDB = $DIC->database();

        $query = "SELECT entry_id FROM il_md_cpr_selections ORDER BY is_default DESC, position ASC";
        $res = $ilDB->query($query);

        $entries = [];
        while ($row = $ilDB->fetchObject($res)) {
            $entries[] = new ilMDCopyrightSelectionEntry((int) $row->entry_id);
        }
        return $entries;
    }

    public static function lookupCopyyrightTitle(string $a_cp_string): string
    {
        global $DIC;

        $ilDB = $DIC->database();

        if (!$entry_id = self::_extractEntryId($a_cp_string)) {
            return $a_cp_string;
        }

        $query = "SELECT title FROM il_md_cpr_selections " .
            "WHERE entry_id = " . $ilDB->quote($entry_id, ilDBConstants::T_INTEGER) . " ";
        $res = $ilDB->query($query);
        $row = $ilDB->fetchObject($res);
        return $row->title ?? '';
    }

    protected static function getCopyrightDataFromRow(stdClass $row): CopyrightDataInterface
    {
        return new CopyrightData(
            $row->full_name ?? '',
            !empty($row->link ?? '') ? new URI($row->link) : null,
            !empty($row->image_link ?? '') ? new URI($row->image_link) : null,
            $row->alt_text ?? ''
        );
    }

    protected static function renderCopyrightFromRow(stdClass $row): string
    {
        global $DIC;

        $renderer = new Renderer(
            $DIC->ui()->factory()
        );
        $ui_renderer = $DIC->ui()->renderer();

        $data = self::getCopyrightDataFromRow($row);
        return $ui_renderer->render($renderer->toUIComponents($data));
    }

    public static function _lookupCopyright(string $a_cp_string): string
    {
        global $DIC;

        $ilDB = $DIC->database();

        if (!$entry_id = self::_extractEntryId($a_cp_string)) {
            return $a_cp_string;
        }

        $query = "SELECT full_name, link, image_link, alt_text FROM il_md_cpr_selections " .
            "WHERE entry_id = " . $ilDB->quote($entry_id, ilDBConstants::T_INTEGER) . " ";
        $res = $ilDB->query($query);
        $row = $ilDB->fetchObject($res);

        return self::renderCopyrightFromRow($row);
    }

    public static function _lookupCopyrightForExport(string $a_cp_string): string
    {
        global $DIC;

        $ilDB = $DIC->database();

        if (!$entry_id = self::_extractEntryId($a_cp_string)) {
            return $a_cp_string;
        }

        $query = "SELECT full_name, link, image_link, alt_text FROM il_md_cpr_selections " .
            "WHERE entry_id = " . $ilDB->quote($entry_id, ilDBConstants::T_INTEGER) . " ";
        $res = $ilDB->query($query);
        $row = $ilDB->fetchObject($res);

        $data = self::getCopyrightDataFromRow($row);

        return (string) ($data->link() ?? $data->fullName());
    }

    public static function lookupCopyrightFromImport(string $copyright_text): int
    {
        global $DIC;

        $db = $DIC->database();

        // url should be made to match regardless of scheme
        $normalized_copyright = str_replace('https://', 'http://', $copyright_text);
        $matches_by_name = null;

        $query = 'SELECT entry_id, full_name, link, image_link, alt_text FROM il_md_cpr_selections';
        $res = $db->query($query);
        while ($row = $db->fetchObject($res)) {
            $entry_id = (int) $row->entry_id;
            $data = self::getCopyrightDataFromRow($row);

            $entry_link = (string) $data->link();
            $normalized_link = str_replace('https://', 'http://', $entry_link);
            if ($normalized_link !== '' && str_contains($normalized_copyright, $normalized_link)) {
                return $entry_id;
            }

            if (
                is_null($matches_by_name) &&
                trim($copyright_text) === trim($data->fullName())
            ) {
                $matches_by_name = $entry_id;
            }
        }

        if (!is_null($matches_by_name)) {
            return $matches_by_name;
        }
        return 0;
    }

    public static function _extractEntryId(string $a_cp_string): int
    {
        if (!preg_match('/il_copyright_entry__([0-9]+)__([0-9]+)/', $a_cp_string, $matches)) {
            return 0;
        }
        if ($matches[1] != IL_INST_ID) {
            return 0;
        }
        return (int) ($matches[2] ?? 0);
    }

    public static function isEntry($a_cp_string): bool
    {
        if (!preg_match('/il_copyright_entry__([0-9]+)__([0-9]+)/', $a_cp_string)) {
            return false;
        }
        return true;
    }

    public function getUsage(): int
    {
        return $this->usage;
    }

    public function getEntryId(): int
    {
        return $this->entry_id;
    }

    public function getIsDefault(): bool
    {
        $query = "SELECT is_default FROM il_md_cpr_selections " .
            "WHERE entry_id = " . $this->db->quote($this->entry_id, 'integer');

        $res = $this->db->query($query);
        $row = $this->db->fetchAssoc($res);

        return (bool) ($row['is_default'] ?? false);
    }

    public function setOutdated(bool $a_value): void
    {
        $this->outdated = $a_value;
    }

    public function getOutdated(): bool
    {
        return $this->outdated;
    }

    public static function getDefault(): int
    {
        global $DIC;

        $db = $DIC->database();

        $query = "SELECT entry_id FROM il_md_cpr_selections " .
            "WHERE is_default = " . $db->quote(1, 'integer');

        $res = $db->query($query);
        $row = $db->fetchAssoc($res);

        return (int) $row['entry_id'];
    }

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

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

    public function setDescription(string $a_desc): void
    {
        $this->description = $a_desc;
    }

    public function getDescription(): string
    {
        return $this->description;
    }

    public function getCopyrightData(): CopyrightDataInterface
    {
        if (isset($this->copyright_data)) {
            return $this->copyright_data;
        }
        return new NullCopyrightData();
    }

    public function setCopyrightData(
        string $full_name,
        ?URI $link,
        ?URI $image_link,
        string $alt_text
    ): void {
        $this->copyright_data = new CopyrightData(
            $full_name,
            $link,
            $image_link,
            $alt_text
        );
    }

    public function setCopyright(string $a_copyright): void
    {
        $this->copyright = $a_copyright;
    }

    public function getCopyright(): string
    {
        return $this->copyright;
    }

    public function setCosts(bool $a_costs): void
    {
        $this->costs = $a_costs;
    }

    public function getCosts(): bool
    {
        return $this->costs;
    }

    public function setLanguage(string $a_lang_key): void
    {
        $this->language = $a_lang_key;
    }

    public function getLanguage(): string
    {
        return $this->language;
    }

    public function setCopyrightAndOtherRestrictions(bool $a_status): void
    {
        $this->copyright_and_other_restrictions = $a_status;
    }

    public function getCopyrightAndOtherRestrictions(): bool
    {
        return $this->copyright_and_other_restrictions;
    }

    public function setOrderPosition(int $a_position): void
    {
        $this->order_position = $a_position;
    }

    public function getOrderPosition(): int
    {
        return $this->order_position;
    }

    protected function getNextOrderPosition(): int
    {
        $query = "SELECT count(entry_id) total FROM il_md_cpr_selections";
        $res = $this->db->query($query);
        $row = $this->db->fetchAssoc($res);

        return $row['total'] + 1;
    }

    public function add(): bool
    {
        $next_id = $this->db->nextId('il_md_cpr_selections');

        $this->db->insert('il_md_cpr_selections', array(
            'entry_id' => array('integer', $next_id),
            'title' => array('text', $this->getTitle()),
            'description' => array('clob', $this->getDescription()),
            'full_name' => array('clob', $this->getCopyrightData()->fullName()),
            'link' => array('clob', (string) $this->getCopyrightData()->link()),
            'image_link' => array('clob', (string) $this->getCopyrightData()->imageLink()),
            'alt_text' => array('clob', $this->getCopyrightData()->altText()),
            'language' => array('text', $this->getLanguage()),
            'costs' => array('integer', $this->getCosts()),
            'cpr_restrictions' => array('integer', $this->getCopyrightAndOtherRestrictions()),
            'position' => array('integer', $this->getNextOrderPosition())
        ));
        $this->entry_id = $next_id;
        return true;
    }

    public function update(): bool
    {
        $this->db->update('il_md_cpr_selections', array(
            'title' => array('text', $this->getTitle()),
            'description' => array('clob', $this->getDescription()),
            'full_name' => array('clob', $this->getCopyrightData()->fullName()),
            'link' => array('clob', (string) $this->getCopyrightData()->link()),
            'image_link' => array('clob', (string) $this->getCopyrightData()->imageLink()),
            'alt_text' => array('clob', $this->getCopyrightData()->altText()),
            'language' => array('text', $this->getLanguage()),
            'costs' => array('integer', $this->getCosts()),
            'cpr_restrictions' => array('integer', $this->getCopyrightAndOtherRestrictions()),
            'outdated' => array('integer', $this->getOutdated()),
            'position' => array('integer', $this->getOrderPosition())
        ), array(
            'entry_id' => array('integer', $this->getEntryId())
        ));
        return true;
    }

    public function delete(): void
    {
        $query = "DELETE FROM il_md_cpr_selections " .
            "WHERE entry_id = " . $this->db->quote($this->getEntryId(), 'integer') . " ";
        $res = $this->db->manipulate($query);
    }

    public function validate(): bool
    {
        return $this->getTitle() !== '';
    }

    private function read(): void
    {
        $query = "SELECT * FROM il_md_cpr_selections " .
            "WHERE entry_id = " . $this->db->quote($this->entry_id, 'integer') . " " .
            "ORDER BY is_default DESC, position ASC ";

        $res = $this->db->query($query);
        while ($row = $this->db->fetchObject($res)) {
            $this->setTitle($row->title ?? '');
            $this->setDescription($row->description ?? '');

            $data = self::getCopyrightDataFromRow($row);
            $this->setCopyrightData(
                $data->fullName(),
                $data->link(),
                $data->imageLink(),
                $data->altText()
            );
            $this->setCopyright(self::renderCopyrightFromRow($row));

            $this->setLanguage($row->language);
            $this->setCosts((bool) $row->costs);
            $this->setOutdated((bool) $row->outdated);
            $this->setOrderPosition((int) $row->position);
            // Fixed
            $this->setCopyrightAndOtherRestrictions(true);
        }

        $query = "SELECT count(meta_rights_id) used FROM il_meta_rights " .
            "WHERE description = " . $this->db->quote(
                'il_copyright_entry__' . IL_INST_ID . '__' . $this->getEntryId(),
                'text'
            );

        $res = $this->db->query($query);
        $row = $this->db->fetchObject($res);
        $this->usage = (int) ($row->used ?? 0);
    }

    public static function createIdentifier(int $a_entry_id): string
    {
        return 'il_copyright_entry__' . IL_INST_ID . '__' . $a_entry_id;
    }
}