Proyectos de Subversion Moodle

<?php

// This file is part of Moodle - http://moodle.org/

//

// Moodle is free software: you can redistribute it and/or modify

// it under the terms of the GNU General Public License as published by

// the Free Software Foundation, either version 3 of the License, or

// (at your option) any later version.

//

// Moodle is distributed in the hope that it will be useful,

// but WITHOUT ANY WARRANTY; without even the implied warranty of

// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

// GNU General Public License for more details.

//

// You should have received a copy of the GNU General Public License

// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**

 * Language string based on David Mudrak langstring from local_amos.

 *

 * @package    tool_customlang

 * @copyright  2020 Ferran Recio <ferran@moodle.com>

 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

 */

namespace tool_customlang\local\mlang;

use moodle_exception;

use stdclass;

/**

 * Class containing a lang string cleaned.

 *

 * @package    tool_customlang

 * @copyright  2020 Ferran Recio <ferran@moodle.com>

 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

 */

/**

 * Represents a single string

 */

class langstring {

    /** @var string identifier */

    public $id = null;

    /** @var string */

    public $text = '';

    /** @var int the time stamp when this string was saved */

    public $timemodified = null;

    /** @var bool is deleted */

    public $deleted = false;

    /** @var stdclass extra information about the string */

    public $extra = null;

    /**

     * Class constructor.

     *

     * @param string $id string identifier

     * @param string $text string text

     * @param int $timemodified

     * @param int $deleted

     * @param stdclass $extra

     */

    public function __construct(string $id, string $text = '', int $timemodified = null,

            int $deleted = 0, stdclass $extra = null) {

        if (is_null($timemodified)) {

            $timemodified = time();

        }

        $this->id           = $id;

        $this->text         = $text;

        $this->timemodified = $timemodified;

        $this->deleted      = $deleted;

        $this->extra        = $extra;

    }

    /**

     * Given a string text, returns it being formatted properly for storing in AMOS repository.

     *

     * Note: This method is taken directly from local_amos as it is highly tested and robust.

     * The Moodle 1.x part is keep on puspose to make it easier the copy paste from both codes.

     * This could change in the future when AMOS stop suporting the 1.x langstrings.

     *

     * We need to know for what branch the string should be prepared due to internal changes in

     * format required by get_string()

     * - for get_string() in Moodle 1.6 - 1.9 use $format == 1

     * - for get_string() in Moodle 2.0 and higher use $format == 2

     *

     * Typical usages of this methods:

     *  $t = langstring::fix_syntax($t);          // sanity new translations of 2.x strings

     *  $t = langstring::fix_syntax($t, 1);       // sanity legacy 1.x strings

     *  $t = langstring::fix_syntax($t, 2, 1);    // convert format of 1.x strings into 2.x

     *

     * Backward converting 2.x format into 1.x is not supported

     *

     * @param string $text string text to be fixed

     * @param int $format target get_string() format version

     * @param int $from which format version does the text come from, defaults to the same as $format

     * @return string

     */

    public static function fix_syntax(string $text, int $format = 2, ?int $from = null): string {

        if (is_null($from)) {

            $from = $format;

        }

        // Common filter.

        $clean = trim($text);

        $search = [

            // Remove \r if it is part of \r\n.

            '/\r(?=\n)/',

            // Control characters to be replaced with \n

            // LINE TABULATION, FORM FEED, CARRIAGE RETURN, END OF TRANSMISSION BLOCK,

            // END OF MEDIUM, SUBSTITUTE, BREAK PERMITTED HERE, NEXT LINE, START OF STRING,

            // STRING TERMINATOR and Unicode character categorys Zl and Zp.

            '/[\x{0B}-\r\x{17}\x{19}\x{1A}\x{82}\x{85}\x{98}\x{9C}\p{Zl}\p{Zp}]/u',

            // Control characters to be removed

            // NULL, ENQUIRY, ACKNOWLEDGE, BELL, SHIFT {OUT,IN}, DATA LINK ESCAPE,

            // DEVICE CONTROL {ONE,TWO,THREE,FOUR}, NEGATIVE ACKNOWLEDGE, SYNCHRONOUS IDLE, ESCAPE,

            // DELETE, PADDING CHARACTER, HIGH OCTET PRESET, NO BREAK HERE, INDEX,

            // {START,END} OF SELECTED AREA, CHARACTER TABULATION {SET,WITH JUSTIFICATION},

            // LINE TABULATION SET, PARTIAL LINE {FORWARD,BACKWARD}, REVERSE LINE FEED,

            // SINGLE SHIFT {TWO,THREE}, DEVICE CONTROL STRING, PRIVATE USE {ONE,TWO},

            // SET TRANSMIT STATE, MESSAGE WAITING, {START,END} OF GUARDED AREA,

            // {SINGLE {GRAPHIC,} CHARACTER,CONTROL SEQUENCE} INTRODUCER, OPERATING SYSTEM COMMAND,

            // PRIVACY MESSAGE, APPLICATION PROGRAM COMMAND, ZERO WIDTH {,NO-BREAK} SPACE,

            // REPLACEMENT CHARACTER.

            '/[\0\x{05}-\x{07}\x{0E}-\x{16}\x{1B}\x{7F}\x{80}\x{81}\x{83}\x{84}\x{86}-\x{93}\x{95}-\x{97}\x{99}-\x{9B}\x{9D}-\x{9F}\x{200B}\x{FEFF}\x{FFFD}]++/u',

            // Remove trailing whitespace at the end of lines in a multiline string.

            '/[ \t]+(?=\n)/',

        ];

        $replace = [

            '',

            "\n",

            '',

            '',

        ];

        $clean = preg_replace($search, $replace, $clean);

        if (($format === 2) && ($from === 2)) {

            // Sanity translations of 2.x strings.

            $clean = preg_replace("/\n{3,}/", "\n\n\n", $clean); // Collapse runs of blank lines.

        } else if (($format === 2) && ($from === 1)) {

            // Convert 1.x string into 2.x format.

            $clean = preg_replace("/\n{3,}/", "\n\n\n", $clean); // Collapse runs of blank lines.

            $clean = preg_replace('/%+/', '%', $clean); // Collapse % characters.

            $clean = str_replace('\$', '@@@___XXX_ESCAPED_DOLLAR__@@@', $clean); // Remember for later.

            $clean = str_replace("\\", '', $clean); // Delete all slashes.

            $clean = preg_replace('/(^|[^{])\$a\b(\->[a-zA-Z0-9_]+)?/', '\\1{$a\\2}', $clean); // Wrap placeholders.

            $clean = str_replace('@@@___XXX_ESCAPED_DOLLAR__@@@', '$', $clean);

            $clean = str_replace('$', '$', $clean);

        } else if (($format === 1) && ($from === 1)) {

            // Sanity legacy 1.x strings.

            $clean = preg_replace("/\n{3,}/", "\n\n", $clean); // Collapse runs of blank lines.

            $clean = str_replace('\$', '@@@___XXX_ESCAPED_DOLLAR__@@@', $clean);

            $clean = str_replace("\\", '', $clean); // Delete all slashes.

            $clean = str_replace('$', '\$', $clean); // Escape all embedded variables.

            // Unescape placeholders: only $a and $a->something are allowed. All other $variables are left escaped.

            $clean = preg_replace('/\\\\\$a\b(\->[a-zA-Z0-9_]+)?/', '$a\\1', $clean); // Unescape placeholders.

            $clean = str_replace('@@@___XXX_ESCAPED_DOLLAR__@@@', '\$', $clean);

            $clean = str_replace('"', "\\\"", $clean); // Add slashes for ".

            $clean = preg_replace('/%+/', '%', $clean); // Collapse % characters.

            $clean = str_replace('%', '%%', $clean); // Duplicate %.

        } else {

            throw new moodle_exception('Unknown get_string() format version');

        }

        return $clean;

    }

}