class.ilFileObjectDatabaseObjective.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\File\Icon\IconDatabaseRepository;
use ILIAS\components\File\Settings\General;

class ilFileObjectDatabaseObjective implements ilDatabaseUpdateSteps
{
    private ?ilDBInterface $database = null;

    public function prepare(ilDBInterface $db): void
    {
        $this->database = $db;
    }

    public function step_1(): void
    {
        $this->abortIfNotPrepared();
        if ($this->database->tableExists('file_data')) {
            $this->database->addTableColumn(
                'file_data',
                'on_click_mode',
                [
                    'type' => 'integer',
                    'length' => '1',
                    'notnull' => '1',
                    'default' => ilObjFile::CLICK_MODE_DOWNLOAD,
                ]
            );
        }
    }

    public function step_2(): void
    {
        $this->abortIfNotPrepared();
        if (!$this->database->tableExists('file_data')) {
            return;
        }
        if ($this->database->tableColumnExists('file_data', 'downloads')) {
            return;
        }

        $this->database->addTableColumn(
            'file_data',
            'downloads',
            [
                'type' => 'integer',
                'length' => 8,
                'notnull' => false,
                'default' => 0 // will be adjusted in an update query.
            ]
        );

        $this->database->manipulate(
            "
            UPDATE file_data SET downloads = (
                SELECT COALESCE(SUM(read_event.read_count), 0) FROM read_event 
                    WHERE read_event.obj_id = file_data.file_id
            );
        "
        );
    }

    public function step_3(): void
    {
        $this->abortIfNotPrepared();

        $this->database->insert(
            'settings',
            [
                'module' => ['text', General::MODULE_NAME],
                'keyword' => ['text', General::F_SHOW_AMOUNT_OF_DOWNLOADS],
                'value' => ['text', '1'],
            ]
        );
    }

    public function step_4(): void
    {
        $this->abortIfNotPrepared();
        if (!$this->database->tableExists(IconDatabaseRepository::ICON_TABLE_NAME)) {
            $this->database->createTable(
                IconDatabaseRepository::ICON_TABLE_NAME,
                [
                    IconDatabaseRepository::ICON_RESOURCE_IDENTIFICATION => [
                        'type' => 'text',
                        'length' => 64,
                        'notnull' => true,
                        'default' => '',
                    ],
                    IconDatabaseRepository::ICON_ACTIVE => [
                        'type' => 'integer',
                        'length' => 1,
                        'notnull' => false,
                        'default' => 0,
                    ],
                    IconDatabaseRepository::IS_DEFAULT_ICON => [
                        'type' => 'integer',
                        'length' => 1,
                        'notnull' => false,
                        'default' => 0,
                    ]
                ]
            );
        }
        if (!$this->database->tableExists(IconDatabaseRepository::SUFFIX_TABLE_NAME)) {
            $this->database->createTable(
                IconDatabaseRepository::SUFFIX_TABLE_NAME,
                [
                    IconDatabaseRepository::ICON_RESOURCE_IDENTIFICATION => [
                        'type' => 'text',
                        'length' => 64,
                        'notnull' => true,
                        'default' => '',
                    ],
                    IconDatabaseRepository::SUFFIX => [
                        'type' => 'text',
                        'length' => 32,
                        'notnull' => false,
                        'default' => '',
                    ]
                ]
            );
        }
    }

    public function step_5(): void
    {
        // replace wrong suffixes. currently they are stored with e.g. icon_file_docx and should be docx.
        // update the whole table with a replace statement.
        $this->database->manipulate(
            "UPDATE il_file_icon_suffixes SET suffix = REPLACE(suffix, 'icon_file_', '') WHERE suffix LIKE 'icon_file_%';"
        );
    }

    public function step_6(): void
    {
        $this->abortIfNotPrepared();
        if (!$this->database->tableExists('file_data')) {
            return;
        }
        if ($this->database->tableColumnExists(
            'file_data',
            'important_info'
        )) {
            return;
        }
        $this->database->addTableColumn(
            'file_data',
            'important_info',
            [
                'type' => 'blob',
                'notnull' => false,
                'default' => null
            ]
        );
    }

    public function step_7(): void
    {
        $query = "UPDATE `object_data` SET `offline` = 0 WHERE `type` = \"file\" AND `offline` IS NULL";
        $this->database->manipulate($query);
    }

    private function abortIfNotPrepared(): void
    {
        if (null === $this->database) {
            throw new LogicException(self::class . "::prepare() must be called before db-update-steps execution.");
        }
    }
}