forkbb/app/Models/Pages/Admin/Update.php

<?php
/**
 * This file is part of the ForkBB <https://github.com/forkbb>.
 *
 * @copyright (c) Visman <mio.visman@yandex.ru, https://github.com/MioVisman>
 * @license   The MIT License (MIT)
 */

declare(strict_types=1);

namespace ForkBB\Models\Pages\Admin;

use ForkBB\Core\Config as CoreConfig;
use ForkBB\Core\Container;
use ForkBB\Core\Validator;
use ForkBB\Models\Page;
use ForkBB\Models\Pages\Admin;
use PDO;
use PDOException;
use RuntimeException;
use ForkBB\Core\Exceptions\ForkException;
use function \ForkBB\__;

class Update extends Admin
{
    const PHP_MIN                    = '7.3.0';
    const REV_MIN_FOR_UPDATE         = 42;
    const LATEST_REV_WITH_DB_CHANGES = 43;
    const LOCK_NAME                  = 'lock_update';
    const LOCk_TTL                   = 1800;
    const JSON_OPTIONS               = \JSON_UNESCAPED_SLASHES | \JSON_UNESCAPED_UNICODE | \JSON_THROW_ON_ERROR;
    const CONFIG_FILE                = 'main.php';

    protected $configFile;

    /**
     * Флаг проверки пароля
     * @var bool
     */
    protected $okPass;

    public function __construct(Container $container)
    {
        parent::__construct($container);

        $container->Lang->load('validator');
        $container->Lang->load('admin_update');

        $this->aIndex     = 'update';
        $this->httpStatus = 503;
        $this->onlinePos  = null;
        $this->nameTpl    = 'admin/form';
        $this->titleForm  = 'Update ForkBB';
        $this->classForm  = ['updateforkbb'];
        $this->configFile = $container->DIR_CONFIG . '/' . self::CONFIG_FILE;

        $this->header('Retry-After', '3600');
    }

    /**
     * Подготовка страницы к отображению
     */
    public function prepare(): void
    {
        $this->aNavigation = $this->aNavigation();
        $this->crumbs      = $this->crumbs(...$this->aCrumbs);
    }

    /**
     * Возвращает массив ссылок с описанием для построения навигации админки
     */
    protected function aNavigation(): array
    {
        return [
            'update' => [
                $this->c->Router->link('AdminUpdate'),
                __('Update ForkBB'),
            ],
        ];
    }

    /**
     * Возвращает страницу обслуживания с доп.сообщением
     */
    protected function returnMaintenance(bool $isStage = true): Page
    {
        $maintenance = $this->c->Maintenance;
        $maintenance->fIswev = ['w', 'Update script is running'];

        if ($isStage) {
            $maintenance->fIswev = ['e', 'Script runs error'];
        }

        return $maintenance;
    }

    /**
     * Проверяет наличие блокировки скрипта обновления
     */
    protected function hasLock(string $uid = null): bool
    {
        $lock = $this->c->Cache->get(self::LOCK_NAME);

        if (null === $uid) {
            return ! empty($lock);
        } else {
            return empty($lock) || ! \hash_equals($uid, (string) $lock);
        }
    }

    protected function setLock(string $uid = null): ?string
    {
        if (true === $this->hasLock($uid)) {
            return null;
        }

        if (null === $uid) {
            $uid = $this->c->Secury->randomHash(33);
        }

        $this->c->Cache->set(self::LOCK_NAME, $uid, self::LOCk_TTL);

        if (true === $this->hasLock($uid)) {
            return null;
        }

        return $uid;
    }

    /**
     * Подготавливает данные для страницы обновления форума
     */
    public function view(array $args, string $method): Page
    {
        if (true === $this->hasLock()) {
            return $this->returnMaintenance(false);
        }

        if (
            'POST' === $method
            && empty($this->fIswev)
        ) {
            $v = $this->c->Validator->reset()
                ->addValidators([
                    'check_pass' => [$this, 'vCheckPass'],
                ])->addRules([
                    'token'                 => 'token:AdminUpdate',
                    'dbpass'                => 'exist|string|check_pass',
                    'o_maintenance_message' => 'required|string:trim|max:65000 bytes|html',
                ])->addAliases([
                    'dbpass'                => 'Database password',
                    'o_maintenance_message' => 'Maintenance message',
                ])->addMessages([
                ]);

                if (
                    $v->validation($_POST)
                    && $this->okPass
                ) {
                    $e = null;

                    // версия PHP
                    if (
                        null === $e
                        && \version_compare(\PHP_VERSION, self::PHP_MIN, '<')
                    ) {
                        $e = __(['You are running error', 'PHP', \PHP_VERSION, $this->c->FORK_REVISION, self::PHP_MIN]);
                    }

                    // база не от ForkBB или старая ревизия
                    if (
                        null === $e
                        && $this->c->config->i_fork_revision < self::REV_MIN_FOR_UPDATE
                    ) {
                        $e = 'Version mismatch error';
                    }

                    // загрузка и проверка конфига
                    if (null === $e) {
                        try {
                            $coreConfig = new CoreConfig($this->configFile);
                        } catch (ForkException $excp) {
                            $e = $excp->getMessage();
                        }
                    }

                    // проверка доступности базы данных на изменения
                    if (
                        null === $e
                        && $this->c->config->i_fork_revision < self::LATEST_REV_WITH_DB_CHANGES
                    ) {
                        $testTable = '::test_tb_for_update';

                        if (
                            null === $e
                            && true === $this->c->DB->tableExists($testTable)
                        ) {
                            $e = ['The %s table already exists. Delete it.', $testTable];
                        }

                        $schema = [
                            'FIELDS' => [
                                'id' => ['SERIAL', false],
                            ],
                            'PRIMARY KEY' => ['id'],
                        ];
                        if (
                            null === $e
                            && false === $this->c->DB->createTable($testTable, $schema)
                        ) {
                            $e = ['Unable to create %s table', $testTable];
                        }

                        if (
                            null === $e
                            && false === $this->c->DB->addField($testTable, 'test_field', 'VARCHAR(80)', false, '')
                        ) {
                            $e = ['Unable to add test_field field to %s table', $testTable];
                        }

                        $sql = "INSERT INTO {$testTable} (test_field) VALUES ('TEST_VALUE')";
                        if (
                            null === $e
                            && false === $this->c->DB->exec($sql)
                        ) {
                            $e = ['Unable to insert line to %s table', $testTable];
                        }

                        if (
                            null === $e
                            && false === $this->c->DB->dropField($testTable, 'test_field')
                        ) {
                            $e = ['Unable to drop test_field field from %s table', $testTable];
                        }

                        if (
                            null === $e
                            && false === $this->c->DB->dropTable($testTable)
                        ) {
                            $e = ['Unable to drop %s table', $testTable];
                        }
                    }

                    if (null !== $e) {
                        return $this->c->Message->message($e, true, 503);
                    }

                    $uid = $this->setLock();

                    if (null === $uid) {
                        $this->fIswev = ['e', 'Unable to write update lock'];
                    } else {
                        $this->c->config->o_maintenance_message = $v->o_maintenance_message;

                        $this->c->config->save();

                        return $this->c->Redirect->page('AdminUpdateStage', ['uid' => $uid, 'stage' => 1]);
                    }
                } else {
                    $this->fIswev = $v->getErrors();
                }
        } else {
            $v = null;
        }

        $this->form = $this->form($v);

        return $this;
    }

    /**
     * Проверяет пароль базы
     */
    public function vCheckPass(Validator $v, string $dbpass): string
    {
        $this->okPass = true;

        if (\substr($this->c->DB_DSN, 0, 6) === 'sqlite') {
            if (! \hash_equals($this->c->DB_DSN, "sqlite:{$dbpass}")) {
                $this->okPass = false;

                $v->addError(['Invalid file error', self::CONFIG_FILE]);
            }
        } else {
            if (! \hash_equals($this->c->DB_PASSWORD, $dbpass)) {
                $this->okPass = false;

                $v->addError(['Invalid password error', self::CONFIG_FILE]);
            }
        }

        return $dbpass;
    }

    /**
     * Формирует массив для формы
     */
    protected function form(?Validator $v): array
    {
        return [
            'action' => $this->c->Router->link('AdminUpdate'),
            'hidden' => [
                'token' => $this->c->Csrf->create('AdminUpdate'),
            ],
            'sets'   => [
                'update-info' => [
                    'info' => [
                        [
                            'value' => __('Update message'),
                        ],
                    ],
                ],
                'update' => [
                    'legend' => 'Update ForkBB',
                    'fields' => [
                        'dbpass' => [
                            'type'     => 'password',
                            'value'    => '',
                            'caption'  => 'Database password',
                            'help'     => 'Database password note',
                        ],
                        'o_maintenance_message' => [
                            'type'     => 'textarea',
                            'value'    => $v->o_maintenance_message ?? $this->c->config->o_maintenance_message,
                            'caption'  => 'Maintenance message',
                            'help'     => 'Maintenance message info',
                            'required' => true,
                        ],
                    ],
                ],
                'member-info' => [
                    'info' => [
                        [
                            'value' => __('Members message'),
                        ],
                    ],
                ],
            ],
            'btns'   => [
                'start' => [
                    'type'  => 'submit',
                    'value' => __('Start update'),
                ],
            ],
        ];
    }

    /**
     * Обновляет форум
     */
    public function stage(array $args, string $method): Page
    {
        try {
            $uid = $this->setLock($args['uid']);

            if (null === $uid) {
                return $this->returnMaintenance();
            }

            $stage = \max($args['stage'], $this->c->config->i_fork_revision);

            do {
                if (\method_exists($this, 'stageNumber' . $stage)) {
                    $start = $this->{'stageNumber' . $stage}($args);

                    if (null === $start) {
                        ++$stage;
                    }

                    return $this->c->Redirect->page(
                        'AdminUpdateStage',
                        ['uid' => $uid, 'stage' => $stage, 'start' => $start]
                    )->message(['Stage %1$s (%2$s)', $stage, (int) $start]);
                }

                ++$stage;
            } while ($stage < $this->c->FORK_REVISION);

            $this->c->config->i_fork_revision = $this->c->FORK_REVISION;

            $this->c->config->save();

            if (true !== $this->c->Cache->clear()) {
                throw new RuntimeException('Unable to clear cache');
            }

            return $this->c->Redirect->page('Index')->message('Successfully updated');
        } catch (ForkException $excp) {
            return $this->c->Message->message($excp->getMessage(), true, 503);
        }
    }

#    /**
#     * Выполняет определенный шаг обновления
#     *
#     * Возвращает null, если шаг выпонен
#     * Возвращает положительный int, если требуется продолжить выполнение шага
#     */
#    protected function stageNumber1(array $args): ?int
#    {
#        $coreConfig = new CoreConfig($this->configFile);
#
#        $coreConfig->add(
#            'multiple=>AdminUsersRecalculate',
#            '\\ForkBB\\Models\\Pages\\Admin\\Users\\Recalculate::class',
#            'AdminUsersNew'
#        );
#
#        $coreConfig->save();
#
#        return null;
#    }

    /**
     * rev.42 to rev.43
     */
    protected function stageNumber42(array $args): ?int
    {
        $query = 'DELETE FROM ::users WHERE id=1';

        $this->c->DB->exec($query);

        $query = 'UPDATE ::forums SET last_poster_id=0 WHERE last_poster_id=1';

        $this->c->DB->exec($query);

        $query = 'UPDATE ::online SET user_id=0 WHERE user_id=1';

        $this->c->DB->exec($query);

        $query = 'UPDATE ::pm_posts SET poster_id=0 WHERE poster_id=1';

        $this->c->DB->exec($query);

        $query = 'UPDATE ::pm_topics SET poster_id=0 WHERE poster_id=1';

        $this->c->DB->exec($query);

        $query = 'UPDATE ::pm_topics SET target_id=0 WHERE target_id=1';

        $this->c->DB->exec($query);

        $query = 'UPDATE ::posts SET poster_id=0 WHERE poster_id=1';

        $this->c->DB->exec($query);

        $query = 'UPDATE ::posts SET editor_id=0 WHERE editor_id=1';

        $this->c->DB->exec($query);

        $query = 'UPDATE ::reports SET reported_by=0 WHERE reported_by=1';

        $this->c->DB->exec($query);

        $query = 'UPDATE ::reports SET zapped_by=0 WHERE zapped_by=1';

        $this->c->DB->exec($query);

        $query = 'UPDATE ::topics SET poster_id=0 WHERE poster_id=1';

        $this->c->DB->exec($query);

        $query = 'UPDATE ::topics SET last_poster_id=0 WHERE last_poster_id=1';

        $this->c->DB->exec($query);

        $query = 'UPDATE ::warnings SET poster_id=0 WHERE poster_id=1';

        $this->c->DB->exec($query);

        $coreConfig = new CoreConfig($this->configFile);

        $coreConfig->add(
            'shared=>Groups/save',
            '\\ForkBB\\Models\\Group\\Save::class',
            'Group/save'
        );

        $coreConfig->add(
            'shared=>Groups/perm',
            '\\ForkBB\\Models\\Group\\Perm::class',
            'Group/save'
        );

        $coreConfig->add(
            'shared=>Groups/delete',
            '\\ForkBB\\Models\\Group\\Delete::class',
            'Group/save'
        );

        $result = $coreConfig->delete('shared=>Group/delete');
        $result = $coreConfig->delete('shared=>Group/perm');
        $result = $coreConfig->delete('shared=>Group/save');

        $coreConfig->save();

        $this->c->config->a_guest_set = [
            'show_smilies' => 1,
            'show_sig'     => 1,
            'show_avatars' => 1,
            'show_img'     => 1,
            'show_img_sig' => 1,
        ];

        $this->c->config->save();

        return null;
    }

    /**
     * rev.43 to rev.44
     */
    protected function stageNumber43(array $args): ?int
    {
        $config = $this->c->config;

        $config->i_timeout_visit       = $config->o_timeout_visit ?? 3600;
        $config->i_timeout_online      = $config->o_timeout_online ?? 900;
        $config->i_redirect_delay      = $config->o_redirect_delay ?? 1;
        $config->b_show_user_info      = '1' == $config->o_show_user_info ? 1 : 0;
        $config->b_show_post_count     = '1' == $config->o_show_post_count ? 1 : 0;
        $config->b_smilies_sig         = '1' == $config->o_smilies_sig ? 1 : 0;
        $config->b_smilies             = '1' == $config->o_smilies ? 1 : 0;
        $config->b_make_links          = '1' == $config->o_make_links ? 1 : 0;
        $config->b_quickpost           = '1' == $config->o_quickpost ? 1 : 0;
        $config->b_users_online        = '1' == $config->o_users_online ? 1 : 0;
        $config->b_censoring           = '1' == $config->o_censoring ? 1 : 0;
        $config->b_show_dot            = '1' == $config->o_show_dot ? 1 : 0;
        $config->b_topic_views         = '1' == $config->o_topic_views ? 1 : 0;
        $config->b_regs_report         = '1' == $config->o_regs_report ? 1 : 0;
        $config->b_avatars             = '1' == $config->o_avatars ? 1 : 0;
        $config->b_forum_subscriptions = '1' == $config->o_forum_subscriptions ? 1 : 0;
        $config->b_topic_subscriptions = '1' == $config->o_topic_subscriptions ? 1 : 0;
        $config->b_smtp_ssl            = '1' == $config->o_smtp_ssl ? 1 : 0;
        $config->b_regs_allow          = '1' == $config->o_regs_allow ? 1 : 0;
        $config->b_announcement        = '1' == $config->o_announcement ? 1 : 0;
        $config->b_rules               = '1' == $config->o_rules ? 1 : 0;
        $config->b_maintenance         = '1' == $config->o_maintenance ? 1 : 0;
        $config->b_default_dst         = '1' == $config->o_default_dst ? 1 : 0;
        $config->b_message_bbcode      = '1' == $config->p_message_bbcode ? 1 : 0;
        $config->b_message_all_caps    = '1' == $config->p_message_all_caps ? 1 : 0;
        $config->b_subject_all_caps    = '1' == $config->p_subject_all_caps ? 1 : 0;
        $config->b_sig_all_caps        = '1' == $config->p_sig_all_caps ? 1 : 0;
        $config->b_sig_bbcode          = '1' == $config->p_sig_bbcode ? 1 : 0;
        $config->b_force_guest_email   = '1' == $config->p_force_guest_email ? 1 : 0;

        unset($config->p_force_guest_email);
        unset($config->p_sig_bbcode);
        unset($config->p_sig_all_caps);
        unset($config->p_subject_all_caps);
        unset($config->p_message_all_caps);
        unset($config->p_message_bbcode);
        unset($config->o_default_dst);
        unset($config->o_maintenance);
        unset($config->o_rules);
        unset($config->o_announcement);
        unset($config->o_regs_allow);
        unset($config->o_smtp_ssl);
        unset($config->o_topic_subscriptions);
        unset($config->o_forum_subscriptions);
        unset($config->o_avatars);
        unset($config->o_regs_report);
        unset($config->o_topic_views);
        unset($config->o_show_dot);
        unset($config->o_timeout_visit);
        unset($config->o_timeout_online);
        unset($config->o_redirect_delay);
        unset($config->o_show_user_info);
        unset($config->o_show_post_count);
        unset($config->o_smilies_sig);
        unset($config->o_smilies);
        unset($config->o_make_links);
        unset($config->o_quickpost);
        unset($config->o_users_online);
        unset($config->o_censoring);
        unset($config->o_quickjump);
        unset($config->o_search_all_forums);

        $config->save();

        return null;
    }

    /**
     * rev.44 to rev.45
     */
    protected function stageNumber44(array $args): ?int
    {
        if (! $this->c->DB->query('SELECT id FROM ::bbcode WHERE bb_tag=?s', ['from'])->fetchColumn()) {
            $bbcodes = include $this->c->DIR_CONFIG . '/defaultBBCode.php';

            foreach ($bbcodes as $bbcode) {
                if ('from' !== $bbcode['tag']) {
                    continue;
                }

                $vars = [
                    ':tag'       => $bbcode['tag'],
                    ':structure' => \json_encode($bbcode, self::JSON_OPTIONS),
                ];
                $query = 'INSERT INTO ::bbcode (bb_tag, bb_edit, bb_delete, bb_structure)
                    VALUES(?s:tag, 1, 0, ?s:structure)';

                $this->c->DB->exec($query, $vars);
            }
        }

        return null;
    }

    /**
     * rev.45 to rev.46
     */
    protected function stageNumber45(array $args): ?int
    {
        $coreConfig = new CoreConfig($this->configFile);

        $coreConfig->add(
            'shared=>Cache=>reset_mark',
            '\'%DB_DSN% %DB_PREFIX%\'',
            'cache_dir'
        );

        $coreConfig->save();

        // чтобы кэш не был сброшен до завершения обновления
        $hash = \sha1($this->c->DB_DSN . ' ' . $this->c->DB_PREFIX);

        $this->c->Cache->set('reset_mark_hash', $hash);

        return null;
    }

    /**
     * rev.46 to rev.47
     */
    protected function stageNumber46(array $args): ?int
    {
        $coreConfig = new CoreConfig($this->configFile);

        $coreConfig->add(
            'shared=>Mail=>ssl',
            '\'%config.b_smtp_ssl%\''
        );

        $coreConfig->save();

        return null;
    }

    /**
     * rev.47 to rev.48
     */
    protected function stageNumber47(array $args): ?int
    {
        $config = $this->c->config;

        $config->s_РЕГИСТР = 'Ok';

        $config->save();

        $coreConfig = new CoreConfig($this->configFile);

        $coreConfig->add(
            'shared=>Config/insensitive',
            '\\ForkBB\\Models\\Config\\Insensitive::class',
            'Config/save'
        );

        $coreConfig->save();

        return null;
    }

    /**
     * rev.48 to rev.49
     */
    protected function stageNumber48(array $args): ?int
    {
        $coreConfig = new CoreConfig($this->configFile);

        $coreConfig->add(
            'DATE_FORMATS',
            ['\'Y-m-d\'', '\'d M Y\'', '\'Y-m-d\'', '\'Y-d-m\'', '\'d-m-Y\'', '\'m-d-Y\'', '\'M j Y\'', '\'jS M Y\''],
            'HTTP_HEADERS'
        );

        $coreConfig->add(
            'TIME_FORMATS',
            ['\'H:i:s\'', '\'H:i\'', '\'H:i:s\'', '\'H:i\'', '\'g:i:s a\'', '\'g:i a\''],
            'DATE_FORMATS'
        );

        $coreConfig->add(
            'shared=>%DIR_VIEWS%',
            '\'%DIR_APP%/templates\'',
            'DB'
        );

        $coreConfig->add(
            'shared=>%DIR_LOG%',
            '\'%DIR_APP%/log\'',
            'DB'
        );

        $coreConfig->add(
            'shared=>%DIR_LANG%',
            '\'%DIR_APP%/lang\'',
            'DB'
        );

        $coreConfig->add(
            'shared=>%DIR_CONFIG%',
            '\'%DIR_APP%/config\'',
            'DB'
        );

        $coreConfig->add(
            'shared=>%DIR_CACHE%',
            '\'%DIR_APP%/cache\'',
            'DB'
        );

        $coreConfig->add(
            'shared=>%DIR_APP%',
            '\'%DIR_ROOT%/app\'',
            'DB'
        );

        $coreConfig->add(
            'shared=>%DIR_PUBLIC%',
            '\'%DIR_ROOT%/public\'',
            'DB'
        );

        $coreConfig->add(
            'shared=>%DIR_ROOT%',
            '\\realpath(__DIR__ . \'/../..\')',
            'DB'
        );

        $coreConfig->add(
            'shared=>HTMLCleaner=>config',
            '\'%DIR_CONFIG%/jevix.default.php\''
        );

        $coreConfig->save();

        return null;
    }
}