JavaScriptFFS.php

Go to the documentation of this file.

<?php

abstract class JavaScriptFFS extends SimpleFFS {
    public function getFileExtensions() {
        return array( '.js' );
    }

    abstract protected function transformKey( $key );

    abstract protected function header( $code, $authors );

    abstract protected function footer();

    public function readFromVariable( $data ) {
        /* Parse authors list */
        $authors = preg_replace( "#/\* Translators\:\n(.*?)\n \*/(.*)#s", '$1', $data );
        if ( $authors === $data ) {
            $authors = array();
        } else {
            $authors = explode( "\n", $authors );
            $count = count( $authors );
            for ( $i = 0; $i < $count; $i++ ) {
                // Each line should look like " *  - Translatorname"
                $authors[$i] = substr( $authors[$i], 6 );
            }
        }

        /* Pre-processing of messages */

        $dataStart = strpos( $data, '{' );
        $dataEnd = strrpos( $data, '}' );

        $data = substr( $data, $dataStart + 1, $dataEnd - $dataStart - 1 );

        $data = preg_replace( '#^(\s*?)//(.*?)$#m', '', $data );

        $data = preg_replace( "#\'\,\n#", "\",\n", $data );

        $data = trim( $data );

        $data = explode( "\",\n", $data );

        $messages = array();
        foreach ( $data as $segment ) {
            $segment .= '"';

            $segment = str_replace( '"+', '" +', $segment );
            $segment = explode( '" +', $segment );
            $count = count( $segment );
            for ( $i = 0; $i < $count; $i++ ) {
                $segment[$i] = ltrim( ltrim( $segment[$i] ), '"' );
            }
            $segment = implode( $segment );

            $segment = preg_replace( "#\:(\s+)[\\\"\']#", ': "', $segment );

            $segments = explode( ': "', $segment );

            $key = trim( trim( $segments[0] ), "'\"" );
            $value = trim( trim( $segments[1] ), "'\"" );

            $messages[$key] = self::unescapeJsString( $value );
        }

        $messages = $this->group->getMangler()->mangle( $messages );

        return array(
            'AUTHORS' => $authors,
            'MESSAGES' => $messages
        );
    }

    public function writeReal( MessageCollection $collection ) {
        $header = $this->header( $collection->code, $collection->getAuthors() );

        $mangler = $this->group->getMangler();

        $body = '';
        foreach ( $collection as $message ) {
            if ( strlen( $message->translation() ) === 0 ) {
                continue;
            }

            $key = $mangler->unmangle( $message->key() );
            $key = $this->transformKey( Xml::escapeJsString( $key ) );

            $translation = Xml::escapeJsString( $message->translation() );

            $body .= "\t{$key}: \"{$translation}\",\n";
        }

        if ( strlen( $body ) === 0 ) {
            return false;
        }

        $body = substr( $body, 0, -2 );
        $body .= "\n";

        return $header . $body . $this->footer();
    }

    protected function authorsList( $authors ) {
        if ( count( $authors ) === 0 ) {
            return '';
        }

        $authorsList = '';
        foreach ( $authors as $author ) {
            $authorsList .= " *  - $author\n";
        }

        // Remove trailing newline, and return.
        return substr( " * Translators:\n$authorsList", 0, -1 );
    }

    protected static function unescapeJsString( $string ) {
        // See ECMA 262 section 7.8.4 for string literal format
        $pairs = array(
            "\\" => "\\\\",
            "\"" => "\\\"",
            "'" => "\\'",
            "\n" => "\\n",
            "\r" => "\\r",

            // To avoid closing the element or CDATA section.
            "<" => "\\x3c",
            ">" => "\\x3e",

            // To avoid any complaints about bad entity refs.
            "&" => "\\x26",

            /*
             * Work around https://bugzilla.mozilla.org/show_bug.cgi?id=274152
             * Encode certain Unicode formatting chars so affected
             * versions of Gecko do not misinterpret our strings;
             * this is a common problem with Farsi text.
             */
            "\xe2\x80\x8c" => "\\u200c", // ZERO WIDTH NON-JOINER
            "\xe2\x80\x8d" => "\\u200d", // ZERO WIDTH JOINER
        );
        $pairs = array_flip( $pairs );

        return strtr( $string, $pairs );
    }
}

class ShapadoJsFFS extends JavaScriptFFS {

    protected function transformKey( $key ) {
        return $key;
    }

    protected function header( $code, $authors ) {
        global $wgSitename;

        $name = TranslateUtils::getLanguageName( $code );
        $native = TranslateUtils::getLanguageName( $code, $code );
        $authorsList = $this->authorsList( $authors );

        return <<<EOT
var I18n = {

EOT;
    }

    protected function footer() {
        return "};\n\n";
    }
}