TranslateUtils.php

Go to the documentation of this file.

<?php
class TranslateUtils {
    public static function title( $message, $code, $ns = NS_MEDIAWIKI ) {
        // Cache some amount of titles for speed.
        static $cache = array();
        $key = $ns . ':' . $message;

        if ( !isset( $cache[$key] ) ) {
            $cache[$key] = Title::capitalize( $message, $ns );
        }

        if ( $code ) {
            return $cache[$key] . '/' . $code;
        } else {
            return $cache[$key];
        }
    }

    public static function figureMessage( $text ) {
        $pos = strrpos( $text, '/' );
        $code = substr( $text, $pos + 1 );
        $key = substr( $text, 0, $pos );

        return array( $key, $code );
    }

    public static function getMessageContent( $key, $language, $namespace = NS_MEDIAWIKI ) {
        $title = self::title( $key, $language, $namespace );
        $data = self::getContents( array( $title ), $namespace );

        return isset( $data[$title][0] ) ? $data[$title][0] : null;
    }

    public static function getContents( $titles, $namespace ) {
        $dbr = wfGetDB( DB_SLAVE );
        $rows = $dbr->select( array( 'page', 'revision', 'text' ),
            array( 'page_title', 'old_text', 'old_flags', 'rev_user_text' ),
            array(
                'page_namespace' => $namespace,
                'page_latest=rev_id',
                'rev_text_id=old_id',
                'page_title' => $titles
            ),
            __METHOD__
        );

        $titles = array();
        foreach ( $rows as $row ) {
            $titles[$row->page_title] = array(
                Revision::getRevisionText( $row ),
                $row->rev_user_text
            );
        }
        $rows->free();

        return $titles;
    }

    public static function translationChanges( $hours = 24, $bots = false, $ns = null ) {
        global $wgTranslateMessageNamespaces;

        $dbr = wfGetDB( DB_SLAVE );
        $recentchanges = $dbr->tableName( 'recentchanges' );
        $hours = intval( $hours );
        $cutoff_unixtime = time() - ( $hours * 3600 );
        $cutoff = $dbr->timestamp( $cutoff_unixtime );

        $namespaces = $dbr->makeList( $wgTranslateMessageNamespaces );
        if ( $ns ) {
            $namespaces = $dbr->makeList( $ns );
        }

        $fields = 'rc_title, rc_timestamp, rc_user_text, rc_namespace';

        // @todo Raw SQL
        $sql = "SELECT $fields, substring_index(rc_title, '/', -1) as lang FROM $recentchanges " .
            "WHERE rc_timestamp >= '{$cutoff}' " .
            ( $bots ? '' : 'AND rc_bot = 0 ' ) .
            "AND rc_namespace in ($namespaces) " .
            "ORDER BY lang ASC, rc_timestamp DESC";

        $res = $dbr->query( $sql, __METHOD__ );
        $rows = iterator_to_array( $res );

        return $rows;
    }

    /* Some other helpers for output */

    public static function getLanguageName( $code, $language = 'en' ) {
        $languages = TranslateUtils::getLanguageNames( $language );

        if ( isset( $languages[$code] ) ) {
            return $languages[$code];
        } else {
            return $code;
        }
    }

    public static function languageSelector( $language, $selectedId ) {
        $selector = self::getLanguageSelector( $language );
        $selector->setDefault( $selectedId );
        $selector->setAttribute( 'id', 'language' );
        $selector->setAttribute( 'name', 'language' );

        return $selector->getHtml();
    }

    public static function getLanguageSelector( $language, $labelOption = false ) {
        $languages = self::getLanguageNames( $language );
        ksort( $languages );

        $selector = new XmlSelect();
        if ( $labelOption !== false ) {
            $selector->addOption( $labelOption, '-' );
        }

        foreach ( $languages as $code => $name ) {
            $selector->addOption( "$code - $name", $code );
        }

        return $selector;
    }

    public static function getLanguageNames( /*string */$code ) {
        if ( is_callable( array( 'Language', 'fetchLanguageNames' ) ) ) {
            $languageNames = Language::fetchLanguageNames( $code, 'mw' ); // since 1.20
        } elseif ( is_callable( array( 'LanguageNames', 'getNames' ) ) ) {
            $languageNames = LanguageNames::getNames( $code,
                LanguageNames::FALLBACK_NORMAL,
                LanguageNames::LIST_MW
            );
        } else {
            $languageNames = Language::getLanguageNames( false );
        }

        // Remove languages with deprecated codes (bug 35475)
        global $wgDummyLanguageCodes;

        foreach ( array_keys( $wgDummyLanguageCodes ) as $dummyLanguageCode ) {
            unset( $languageNames[$dummyLanguageCode] );
        }

        wfRunHooks( 'TranslateSupportedLanguages', array( &$languageNames, $code ) );

        return $languageNames;
    }

    public static function messageKeyToGroup( $namespace, $key ) {
        $groups = self::messageKeyToGroups( $namespace, $key );

        return count( $groups ) ? $groups[0] : null;
    }

    public static function messageKeyToGroups( $namespace, $key ) {
        $mi = MessageIndex::singleton()->retrieve();
        $normkey = self::normaliseKey( $namespace, $key );

        if ( isset( $mi[$normkey] ) ) {
            return (array)$mi[$normkey];
        } else {
            return array();
        }
    }

    public static function normaliseKey( $namespace, $key ) {
        $key = lcfirst( $key );

        return strtr( "$namespace:$key", " ", "_" );
    }

    public static function fieldset( $legend, $contents, $attributes = array() ) {
        return Xml::openElement( 'fieldset', $attributes ) .
            Xml::tags( 'legend', null, $legend ) . $contents .
            Xml::closeElement( 'fieldset' );
    }

    public static function convertWhiteSpaceToHTML( $msg ) {
        $msg = htmlspecialchars( $msg );
        $msg = preg_replace( '/^ /m', '&#160;', $msg );
        $msg = preg_replace( '/ $/m', '&#160;', $msg );
        $msg = preg_replace( '/  /', '&#160; ', $msg );
        $msg = str_replace( "\n", '<br />', $msg );

        return $msg;
    }

    public static function assetPath( $path ) {
        global $wgExtensionAssetsPath;

        return "$wgExtensionAssetsPath/Translate/$path";
    }

    public static function cacheFile( $filename ) {
        global $wgTranslateCacheDirectory, $wgCacheDirectory;

        if ( $wgTranslateCacheDirectory !== false ) {
            $dir = $wgTranslateCacheDirectory;
        } elseif ( $wgCacheDirectory !== false ) {
            $dir = $wgCacheDirectory;
        } else {
            throw new MWException( "\$wgCacheDirectory must be configured" );
        }

        return "$dir/$filename";
    }

    public static function groupSelector( $default = false ) {
        $groups = MessageGroups::getAllGroups();
        $selector = new XmlSelect( 'group', 'group', $default );

        foreach ( $groups as $id => $class ) {
            if ( MessageGroups::getGroup( $id )->exists() ) {
                $selector->addOption( $class->getLabel(), $id );
            }
        }

        return $selector;
    }

    public static function addSpecialHelpLink( OutputPage $out, $to, $overrideBaseUrl = false ) {
        $out->addModules( 'ext.translate.helplink' );
        $text = wfMessage( 'translate-gethelp' )->escaped();

        if ( $overrideBaseUrl ) {
            $helpUrl = $to;
        } else {
            $helpUrl = "//www.mediawiki.org/wiki/Special:MyLanguage/$to";
        }

        $link = Html::rawElement(
            'a',
            array(
                'href' => $helpUrl,
                'target' => '_blank'
            ),
            "$text" );
        $wrapper = Html::rawElement( 'div', array( 'class' => 'mw-translate-helplink' ), $link );
        $out->addHtml( $wrapper );
    }

    public static function getTokenAction( $token ) {
        global $wgVersion;
        $method = "action=tokens&type=$token";
        if ( version_compare( $wgVersion, '1.20', '<' ) ) {
            $method = "action=query&prop=info&intoken=$token&titles=Token";
        }

        return $method;
    }

    public static function getPlaceholder() {
        static $i = 0;

        return "\x7fUNIQ" . dechex( mt_rand( 0, 0x7fffffff ) ) .
            dechex( mt_rand( 0, 0x7fffffff ) ) . '-' . $i++;
    }

    public static function getIcon( MessageGroup $g, $size ) {
        $icon = $g->getIcon();
        if ( substr( $icon, 0, 7 ) !== 'wiki://' ) {
            return null;
        }

        $formats = array();

        $filename = substr( $icon, 7 );
        $file = wfFindFile( $filename );
        if ( !$file ) {
            wfWarn( "Unknown message group icon file $icon" );

            return null;
        }

        if ( $file->isVectorized() ) {
            $formats['vector'] = $file->getFullUrl();
        }

        $formats['raster'] = $file->createThumb( $size, $size );

        return $formats;
    }

    public static function parseLanguageCodes( $codes ) {
        $langs = array_map( 'trim', explode( ',', $codes ) );
        if ( $langs[0] === '*' ) {
            $languages = Language::fetchLanguageNames();
            ksort( $languages );
            $langs = array_keys( $languages );
        }

        return $langs;
    }
}