class.ilMailDatabaseUpdateSteps.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilMailDatabaseUpdateSteps implements ilDatabaseUpdateSteps
{
    protected ilDBInterface $db;

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

    public function step_1(): void
    {
        if ($this->db->tableExists('mail') && $this->db->tableColumnExists('mail', 'm_email')) {
            $this->db->dropTableColumn('mail', 'm_email');
        }
    }

    public function step_2(): void
    {
        $result = $this->db->queryF('SELECT value FROM settings WHERE module = %s AND keyword = %s', ['text', 'text'], ['common', 'mail_system_sys_signature']);
        $row = $this->db->fetchAssoc($result);
        if (isset($row['value']) && $row['value'] !== '') {
            $new_value = str_replace(['[CLIENT_NAME]', '[CLIENT_DESC]', '[CLIENT_URL]'], ['[INSTALLATION_NAME]', '[INSTALLATION_DESC]', '[ILIAS_URL]'], $row['value']);
            if ($new_value !== $row['value']) {
                $this->db->manipulateF(
                    'UPDATE settings SET value = %s WHERE module = %s AND keyword = %s',
                    ['text', 'text', 'text'],
                    [$new_value, 'common', 'mail_system_sys_signature']
                );
            }
        }
    }

    public function step_3(): void
    {
        $result = $this->db->query("SELECT tpl_id, m_message FROM mail_man_tpl WHERE m_message LIKE '%[CLIENT_NAME]%'");
        while ($row = $this->db->fetchAssoc($result)) {
            if (isset($row['m_message'], $row['tpl_id']) && $row['m_message'] !== '' && $row['tpl_id'] !== '') {
                $new_value = str_replace('[CLIENT_NAME]', '[INSTALLATION_NAME]', $row['m_message']);
                if ($new_value !== $row['m_message']) {
                    $this->db->manipulateF(
                        'UPDATE mail_man_tpl SET m_message = %s WHERE tpl_id = %s',
                        ['text', 'text'],
                        [$new_value, $row['tpl_id']]
                    );
                }
            }
        }
    }

    public function step_4(): void
    {
        $result = $this->db->query("SELECT lang, type, body FROM mail_template WHERE body LIKE '%[CLIENT_NAME]%'");
        while ($row = $this->db->fetchAssoc($result)) {
            if (isset($row['lang'], $row['type'], $row['body']) && $row['body'] !== '') {
                $new_value = str_replace('[CLIENT_NAME]', '[INSTALLATION_NAME]', $row['body']);
                if ($new_value !== $row['body']) {
                    $this->db->manipulateF(
                        'UPDATE mail_template SET body = %s WHERE lang = %s AND type = %s',
                        ['text', 'text', 'text'],
                        [$new_value, $row['lang'], $row['type']]
                    );
                }
            }
        }
    }

    public function step_5(): void
    {
        if ($this->db->tableExists('mail_options') && $this->db->tableColumnExists('mail_options', 'linebreak')) {
            $this->db->dropTableColumn('mail_options', 'linebreak');
        }
    }

    public function step_6(): void
    {
        if (!$this->db->tableColumnExists('mail_options', 'absence_status')) {
            $this->db->addTableColumn(
                'mail_options',
                'absence_status',
                [
                    'type' => 'integer',
                    'length' => 1,
                    'notnull' => true,
                    'default' => 0
                ]
            );
        }
    }

    public function step_7(): void
    {
        if (!$this->db->tableColumnExists('mail_options', 'absent_from')) {
            $this->db->addTableColumn(
                'mail_options',
                'absent_from',
                [
                    'type' => 'integer',
                    'length' => 8,
                    'notnull' => true,
                    'default' => 0
                ]
            );
        }
    }

    public function step_8(): void
    {
        if (!$this->db->tableColumnExists('mail_options', 'absent_until')) {
            $this->db->addTableColumn(
                'mail_options',
                'absent_until',
                [
                        'type' => 'integer',
                        'length' => 8,
                        'notnull' => true,
                        'default' => 0
                    ]
            );
        }
    }

    public function step_9(): void
    {
        if (!$this->db->tableColumnExists('mail_options', 'absence_ar_body')) {
            $this->db->addTableColumn(
                'mail_options',
                'absence_ar_body',
                [
                    'type' => 'clob',
                    'notnull' => false,
                    'default' => null
                ]
            );
        }
    }

    public function step_10(): void
    {
        if (!$this->db->tableColumnExists('mail_options', 'absence_ar_subject')) {
            $this->db->addTableColumn(
                'mail_options',
                'absence_ar_subject',
                [
                    'type' => 'text',
                    'length' => 255,
                    'notnull' => false,
                    'default' => null
                ]
            );
        }
    }

    public function step_11(): void
    {
        if (!$this->db->tableExists('mail_auto_responder')) {
            $this->db->createTable(
                'mail_auto_responder',
                [
                    'sender_id' => [
                        'type' => 'integer',
                        'length' => 8,
                        'notnull' => true
                    ],
                    'receiver_id' => [
                        'type' => 'integer',
                        'length' => 8,
                        'notnull' => true
                    ],
                    'sent_time' => [
                        'type' => 'timestamp',
                        'notnull' => true
                    ]
                ]
            );
            $this->db->addPrimaryKey('mail_auto_responder', ['sender_id', 'receiver_id']);
        }
    }

    public function step_12(): void
    {
        $settings = [
            'mail_system_sys_signature',
            'mail_system_usr_from_name',
        ];

        foreach ($settings as $keyword) {
            $res = $this->db->queryF(
                "SELECT value FROM settings WHERE keyword = %s AND value IS NOT NULL AND value != ''",
                [ilDBConstants::T_TEXT],
                [$keyword]
            );
            if ($this->db->numRows($res) === 1) {
                $value = $this->db->fetchAssoc($res)['value'] ?? '';
                if ($value === '') {
                    return;
                }

                $value = preg_replace(
                    '/\[([A-Z_]+?)\]/',
                    '{{$1}}',
                    $value
                );

                $this->db->manipulateF(
                    'UPDATE settings SET value = %s WHERE keyword = %s',
                    [ilDBConstants::T_TEXT, ilDBConstants::T_TEXT],
                    [$value, $keyword]
                );
            }
        }
    }

    public function step_13(): void
    {
        if ($this->db->tableExists("mail_tpl_ctx")) {
            $query = "UPDATE mail_tpl_ctx SET " . PHP_EOL
                . " component = REPLACE(component, 'Modules', 'components/ILIAS') " . PHP_EOL
                . " WHERE component LIKE ('Modules/%')";

            $this->db->manipulate($query);
        }
    }

    public function step_14(): void
    {
        if ($this->db->tableExists("mail_tpl_ctx")) {
            $query = "UPDATE mail_tpl_ctx SET " . PHP_EOL
                . " path = REPLACE(path, 'Modules', 'components/ILIAS') " . PHP_EOL
                . " WHERE component LIKE ('Modules/%')" . PHP_EOL
                . " AND path IS NOT NULL";

            $this->db->manipulate($query);
        }
    }

    public function step_15(): void
    {
        $res = $this->db->queryF(
            "SELECT value FROM settings WHERE keyword = %s AND value IS NOT NULL AND value != ''",
            [ilDBConstants::T_TEXT],
            ['mail_system_sys_signature']
        );
        if ($this->db->numRows($res) === 1) {
            $value = $this->db->fetchAssoc($res)['value'] ?? '';
            $sys_general_signature = preg_replace('/(\s?\*\s?){2,}/', "\n\n-- \n", $value);
            // replace [] with {{}}
            $sys_general_signature = preg_replace('/\[([A-Z_]+?)\]/', '{{$1}}', $sys_general_signature);
            $sys_general_signature = str_replace(
                ['CLIENT_URL', 'CLIENT'],
                ['ILIAS_URL', 'INSTALLATION'],
                $sys_general_signature
            );
            $this->db->manipulateF(
                'DELETE FROM settings WHERE keyword = %s',
                [ilDBConstants::T_TEXT],
                ['mail_system_sys_signature']
            );
        }
        $this->db->insert('settings', [
            'module' => ['text', 'common'],
            'keyword' => ['text', 'mail_system_sys_general_signature'],
            'value' => [
                'text',
                $sys_general_signature ?? "\n\n-- \n{{INSTALLATION_NAME}}\n{{INSTALLATION_DESC}}\n{{ILIAS_URL}}\n"
            ],
        ]);
        $this->db->insert('settings', [
            'module' => ['text', 'common'],
            'keyword' => ['text', 'mail_system_usr_general_signature'],
            'value' => ['text', "\n\n-- \nThis mail was sent by {{USER_FULLNAME}} from {{INSTALLATION_NAME}}\n"],
        ]);
    }
}