RteAcronymButtonRenamedToAbbreviation.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Rtehtmlarea\Hook\Install;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

use TYPO3\CMS\Install\Updates\AbstractUpdate;

class RteAcronymButtonRenamedToAbbreviation extends AbstractUpdate
{
    protected $title = 'Rte "acronym" button renamed to "abbreviation"';

    public function checkForUpdate(&$description)
    {
        $result = false;

        $pages = $this->getPagesWithDeprecatedRteProperties($dbQueries, $customMessages);
        $pagesCount = count($pages);
        $description = '<p>The RTE "acronym" button is deprecated and replaced by the "abbreviation" button since TYPO3 CMS 7.0.</p>' . LF . '<p>Page TSconfig currently includes the string "acronym" on <strong>' . strval($pagesCount) . '&nbsp;pages</strong>  (including deleted and hidden pages).</p>' . LF;
        if ($pagesCount) {
            $pagesUids = [];
            foreach ($pages as $page) {
                $pagesUids[] = $page['uid'];
            }
            $description .= '<p>Pages id\'s: ' . implode(', ', $pagesUids) . '</p>';
        }
        if ($pagesCount) {
            $updateablePages = $this->findUpdateablePagesWithDeprecatedRteProperties($pages);
            if (!empty($updateablePages)) {
                $description .= '<p>This wizard will perform automatic replacement of the string "acronym" by the string "abbreviation" on the Page TSconfig of <strong>' . strval(count($updateablePages)) . '&nbsp;pages</strong> (including deleted and hidden):</p>' . LF;
            }
            $result = true;
        } else {
            // if we found no occurrence of deprecated settings and wizard was already executed, then
            // we do not show up anymore
            if ($this->isWizardDone()) {
                $result = false;
            }
        }
        $description .= '<p>Only page records are searched for the string "acronym". However, such string may also be used in BE group and BE user records. These are not searched nor updated by this wizard.</p>'
            . LF . '<p>Page TSconfig may also be included from external files. These are not updated by this wizard. If required, the update will need to be done manually.</p>'
            . LF . '<p>Note that this string replacement will apply to all contents of PageTSconfig.</p>'
            . LF . '<p>Note that the configuration of RTE processing options (RTE.default.proc) may also include the string "acronym".</p>';

        return $result;
    }

    public function performUpdate(array &$dbQueries, &$customMessages)
    {
        $customMessages = '';
        $pages = $this->getPagesWithDeprecatedRteProperties($dbQueries, $customMessages);
        if (empty($customMessages)) {
            $pagesCount = count($pages);
            if ($pagesCount) {
                $updateablePages = $this->findUpdateablePagesWithDeprecatedRteProperties($pages);
                if (!empty($updateablePages)) {
                    $this->updatePages($updateablePages, $dbQueries, $customMessages);
                    // If the update was successful
                    if (empty($customMessages)) {
                        if (count($updateablePages) !== $pagesCount) {
                            $customMessages = 'Some deprecated Page TSconfig properties were found. However, the wizard was unable to automatically replace all the deprecated properties found. Some properties will have to be replaced manually.';
                        }
                    }
                } else {
                    $customMessages = 'Some deprecated Page TSconfig properties were found. However, the wizard was unable to automatically replace any of the deprecated properties found. These properties will have to be replaced manually.';
                }
            }
        }
        $this->markWizardAsDone();
        return empty($customMessages);
    }

    protected function getPagesWithDeprecatedRteProperties(&$dbQueries, &$customMessages)
    {
        $db = $this->getDatabaseConnection();
        $fields = 'uid, TSconfig';
        $table = 'pages';
        $where = 'TSconfig LIKE BINARY ' . $db->fullQuoteStr('%acronym%', 'pages');
        $res = $db->exec_SELECTquery($fields, $table, $where);
        $dbQueries[] = str_replace(LF, ' ', $db->debug_lastBuiltQuery);
        if ($db->sql_error()) {
            $customMessages = 'SQL-ERROR: ' . htmlspecialchars($db->sql_error());
        }
        $pages = [];
        while ($row = $db->sql_fetch_assoc($res)) {
            $pages[] = $row;
        }
        return $pages;
    }

    protected function findUpdateablePagesWithDeprecatedRteProperties(&$pages)
    {
        foreach ($pages as $index => $page) {
            $updatedPageTSConfig = str_replace('acronym', 'abbreviation', $page['TSconfig']);
            if ($updatedPageTSConfig == $page['TSconfig']) {
                unset($pages[$index]);
            } else {
                $pages[$index]['TSconfig'] = $updatedPageTSConfig;
            }
        }
        return $pages;
    }

    protected function updatePages($pages, &$dbQueries, &$customMessages)
    {
        $db = $this->getDatabaseConnection();
        foreach ($pages as $page) {
            $table = 'pages';
            $where = 'uid =' . $page['uid'];
            $field_values = [
                'TSconfig' => $page['TSconfig']
            ];
            $db->exec_UPDATEquery($table, $where, $field_values);
            $dbQueries[] = str_replace(LF, ' ', $db->debug_lastBuiltQuery);
            if ($db->sql_error()) {
                $customMessages .= 'SQL-ERROR: ' . htmlspecialchars($db->sql_error()) . LF . LF;
            }
        }
    }
}