<?php
-
/**
* Contains the LanguageConverter class and ConverterRule class
- * @ingroup Language
*
- * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License
+ * This program 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 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
* @file
+ * @ingroup Language
*/
/**
var $mVariants, $mVariantFallbacks, $mVariantNames;
var $mTablesLoaded = false;
var $mTables;
- var $mNamespaceTables;
// 'bidirectional' 'unidirectional' 'disable' for each variant
var $mManualLevel;
var $mCacheKey;
$variantfallbacks = array(),
$flags = array(),
$manualLevel = array() ) {
+ global $wgDisabledVariants, $wgLanguageNames;
$this->mLangObj = $langobj;
$this->mMainLanguageCode = $maincode;
-
- global $wgDisabledVariants;
- $this->mVariants = array();
- foreach ( $variants as $variant ) {
- if ( !in_array( $variant, $wgDisabledVariants ) ) {
- $this->mVariants[] = $variant;
- }
- }
+ $this->mVariants = array_diff( $variants, $wgDisabledVariants );
$this->mVariantFallbacks = $variantfallbacks;
- global $wgLanguageNames;
$this->mVariantNames = $wgLanguageNames;
$this->mCacheKey = wfMemcKey( 'conversiontables', $maincode );
- $f = array(
+ $defaultflags = array(
// 'S' show converted text
// '+' add rules for alltext
// 'E' the gave flags is error
'D' => 'D', // convert description (subclass implement)
'-' => '-', // remove convert (not implement)
'H' => 'H', // add rule for convert code
- // (but no display in placed code )
+ // (but no display in placed code )
'N' => 'N' // current variant name
);
- $this->mFlags = array_merge( $f, $flags );
+ $this->mFlags = array_merge( $defaultflags, $flags );
foreach ( $this->mVariants as $v ) {
if ( array_key_exists( $v, $manualLevel ) ) {
$this->mManualLevel[$v] = $manualLevel[$v];
} else {
$this->mManualLevel[$v] = 'bidirectional';
}
- $this->mNamespaceTables[$v] = array();
$this->mFlags[$v] = $v;
}
}
/**
- * @public
+ * Get all valid variants.
+ * Call this instead of using $this->mVariants directly.
+ *
+ * @return Array: contains all valid variants
*/
- function getVariants() {
+ public function getVariants() {
return $this->mVariants;
}
* when zh-sg is preferred but not defined, we will pick zh-hans
* in this case. Right now this is only used by zh.
*
- * @param $v String: the language code of the variant
- * @return string array The code of the fallback language or false if there
- * is no fallback
+ * @param $variant String: the language code of the variant
+ * @return String: The code of the fallback language or the
+ * main code if there is no fallback
*/
- public function getVariantFallbacks( $v ) {
- if ( isset( $this->mVariantFallbacks[$v] ) ) {
- return $this->mVariantFallbacks[$v];
+ public function getVariantFallbacks( $variant ) {
+ if ( isset( $this->mVariantFallbacks[$variant] ) ) {
+ return $this->mVariantFallbacks[$variant];
}
return $this->mMainLanguageCode;
}
/**
* Get the title produced by the conversion rule.
- * @returns String
+ * @return String: The converted title text
*/
- function getConvRuleTitle() {
+ public function getConvRuleTitle() {
return $this->mConvRuleTitle;
}
/**
- * Get preferred language variants.
- * @param $fromUser Boolean: get it from $wgUser's preferences
- * @param $fromHeader Boolean: get it from Accept-Language
+ * Get preferred language variant.
* @return String: the preferred language code
*/
- public function getPreferredVariant( $fromUser = true, $fromHeader = false ) {
- global $wgDefaultLanguageVariant;
+ public function getPreferredVariant() {
+ global $wgDefaultLanguageVariant, $wgUser;
$req = $this->getURLVariant();
- if ( $fromUser && !$req ) {
+ if ( $wgUser->isLoggedIn() && !$req ) {
$req = $this->getUserVariant();
}
- if ( $fromHeader && !$req ) {
+ elseif ( !$req ) {
$req = $this->getHeaderVariant();
}
return $this->mMainLanguageCode;
}
+ /**
+ * Get default variant.
+ * This function would not be affected by user's settings or headers
+ * @return String: the default variant code
+ */
+ public function getDefaultVariant() {
+ global $wgDefaultLanguageVariant;
+
+ $req = $this->getURLVariant();
+
+ if ( $wgDefaultLanguageVariant && !$req ) {
+ $req = $this->validateVariant( $wgDefaultLanguageVariant );
+ }
+
+ if ( $req ) {
+ return $req;
+ }
+ return $this->mMainLanguageCode;
+ }
+
/**
* Validate the variant
- * @param $v String: the variant to validate
+ * @param $variant String: the variant to validate
* @return Mixed: returns the variant if it is valid, null otherwise
*/
- function validateVariant( $v = null ) {
- if ( $v !== null && in_array( $v, $this->mVariants ) ) {
- return $v;
+ protected function validateVariant( $variant = null ) {
+ if ( $variant !== null &&
+ in_array( $variant, $this->mVariants ) ) {
+ return $variant;
}
return null;
}
*
* @return Mixed: variant if one found, false otherwise.
*/
- function getURLVariant() {
+ public function getURLVariant() {
global $wgRequest;
- $ret = null;
if ( $this->mURLVariant ) {
return $this->mURLVariant;
*
* @return Mixed: variant if one found, false otherwise.
*/
- function getUserVariant() {
+ protected function getUserVariant() {
global $wgUser;
- $ret = null;
// memoizing this function wreaks havoc on parserTest.php
/* if ( $this->mUserVariant ) { */
return $this->mUserVariant = $this->validateVariant( $ret );
}
-
/**
* Determine the language variant from the Accept-Language header.
*
* @return Mixed: variant if one found, false otherwise.
*/
- function getHeaderVariant() {
+ protected function getHeaderVariant() {
global $wgRequest;
- $ret = null;
if ( $this->mHeaderVariant ) {
return $this->mHeaderVariant;
// see if some supported language variant is set in the
// http header.
-
- $acceptLanguage = $wgRequest->getHeader( 'Accept-Language' );
- if ( !$acceptLanguage ) {
+ $languages = array_keys( $wgRequest->getAcceptLang() );
+ if ( empty( $languages ) ) {
return null;
}
- // explode by comma
- $result = StringUtils::explode( ',', strtolower( $acceptLanguage ) );
- $languages = array();
-
- foreach ( $result as $elem ) {
- // if $elem likes 'zh-cn;q=0.9'
- if ( ( $posi = strpos( $elem, ';' ) ) !== false ) {
- // get the real language code likes 'zh-cn'
- $languages[] = substr( $elem, 0, $posi );
- } else {
- $languages[] = $elem;
- }
- }
-
$fallback_languages = array();
foreach ( $languages as $language ) {
- // strip whitespace
- $language = trim( $language );
$this->mHeaderVariant = $this->validateVariant( $language );
if ( $this->mHeaderVariant ) {
break;
* or '<span title="text" ... '
*
* @return String like ' alt="yyyy"' or ' title="yyyy"'
- * @private
*/
- function captionConvert( $matches ) {
+ protected function captionConvert( $matches ) {
$toVariant = $this->getPreferredVariant();
$title = $matches[1];
$text = $matches[2];
/**
* Dictionary-based conversion.
+ * This function would not parse the conversion rules.
+ * If you want to parse rules, try to use convert() or
+ * convertTo().
*
* @param $text String: the text to be converted
* @param $toVariant String: the target language code
* @return String: the converted text
- * @private
*/
- function autoConvert( $text, $toVariant = false ) {
- $fname = 'LanguageConverter::autoConvert';
+ public function autoConvert( $text, $toVariant = false ) {
+ wfProfileIn( __METHOD__ );
- wfProfileIn( $fname );
-
- if ( !$this->mTablesLoaded ) {
- $this->loadTables();
- }
+ $this->loadTables();
if ( !$toVariant ) {
$toVariant = $this->getPreferredVariant();
$ret .= array_shift( $notrtext );
$ret .= $t;
}
- wfProfileOut( $fname );
+ wfProfileOut( __METHOD__ );
return $ret;
}
/**
* Translate a string to a variant.
- * Doesn't process markup or do any of that other stuff, for that use
- * convert().
+ * Doesn't parse rules or do any of that other stuff, for that use
+ * convert() or convertTo().
*
* @param $text String: text to convert
* @param $variant String: variant language code
* @return String: translated text
- * @private
*/
- function translate( $text, $variant ) {
+ protected function translate( $text, $variant ) {
wfProfileIn( __METHOD__ );
// If $text is empty or only includes spaces, do nothing
// Otherwise translate it
if ( trim( $text ) ) {
- if ( !$this->mTablesLoaded ) {
- $this->loadTables();
- }
+ $this->loadTables();
$text = $this->mTables[$variant]->replace( $text );
}
wfProfileOut( __METHOD__ );
}
/**
- * Convert text to all supported variants.
+ * Call translate() to convert text to all valid variants.
*
* @param $text String: the text to be converted
- * @return Array of string
+ * @return Array: variant => converted text
*/
public function autoConvertToAllVariants( $text ) {
- $fname = 'LanguageConverter::autoConvertToAllVariants';
- wfProfileIn( $fname );
- if ( !$this->mTablesLoaded ) {
- $this->loadTables();
- }
+ wfProfileIn( __METHOD__ );
+ $this->loadTables();
$ret = array();
foreach ( $this->mVariants as $variant ) {
$ret[$variant] = $this->translate( $text, $variant );
}
- wfProfileOut( $fname );
+ wfProfileOut( __METHOD__ );
return $ret;
}
/**
- * Convert link text to all supported variants.
+ * Convert link text to all valid variants.
+ * In the first, this function only convert text outside the
+ * "-{" "}-" markups. Since the "{" and "}" are not allowed in
+ * titles, the text will get all converted always.
+ * So I removed this feature and deprecated the function.
*
* @param $text String: the text to be converted
- * @return Array of string
+ * @return Array: variant => converted text
+ * @deprecated Use autoConvertToAllVariants() instead
*/
public function convertLinkToAllVariants( $text ) {
- if ( !$this->mTablesLoaded ) {
- $this->loadTables();
- }
-
- $ret = array();
- $tarray = StringUtils::explode( '-{', $text );
- $first = true;
-
- foreach ( $tarray as $txt ) {
- if ( $first ) {
- $first = false;
- foreach ( $this->mVariants as $variant ) {
- $ret[$variant] = $this->translate( $txt, $variant );
- }
- continue;
- }
-
- $marked = explode( '}-', $txt, 2 );
-
- foreach ( $this->mVariants as $variant ) {
- $ret[$variant] .= '-{' . $marked[0] . '}-';
- if ( array_key_exists( 1, $marked ) ) {
- $ret[$variant] .= $this->translate( $marked[1], $variant );
- }
- }
-
- }
-
- return $ret;
+ return $this->autoConvertToAllVariants( $text );
}
/**
- * Prepare manual conversion table.
- * @private
+ * Apply manual conversion rules.
+ *
+ * @param $convRule Object: Object of ConverterRule
*/
- function applyManualConv( $convRule ) {
- // use syntax -{T|zh:TitleZh;zh-tw:TitleTw}- for custom
- // conversion in title
- $this->mConvRuleTitle = $convRule->getTitle();
-
- // apply manual conversion table to global table
+ protected function applyManualConv( $convRule ) {
+ // Use syntax -{T|zh-cn:TitleCN; zh-tw:TitleTw}- to custom
+ // title conversion.
+ // Bug 24072: $mConvRuleTitle was overwritten by other manual
+ // rule(s) not for title, this breaks the title conversion.
+ $newConvRuleTitle = $convRule->getTitle();
+ if ( $newConvRuleTitle ) {
+ // So I add an empty check for getTitle()
+ $this->mConvRuleTitle = $newConvRuleTitle;
+ }
+
+ // merge/remove manual conversion rules to/from global table
$convTable = $convRule->getConvTable();
$action = $convRule->getRulesAction();
foreach ( $convTable as $variant => $pair ) {
}
/**
- * Convert namespace.
- * @param $title String: the title included namespace
- * @return Array of string
- * @private
+ * Auto convert a Title object to a readable string in the
+ * preferred variant.
+ *
+ *@param $title Object: a object of Title
+ *@return String: converted title text
*/
- function convertNamespace( $title, $variant ) {
- $splittitle = explode( ':', $title, 2 );
- if ( count( $splittitle ) < 2 ) {
- return $title;
- }
- if ( isset( $this->mNamespaceTables[$variant][$splittitle[0]] ) ) {
- $splittitle[0] = $this->mNamespaceTables[$variant][$splittitle[0]];
+ public function convertTitle( $title ) {
+ $variant = $this->getPreferredVariant();
+ $index = $title->getNamespace();
+ if ( $index === NS_MAIN ) {
+ $text = '';
+ } else {
+ // first let's check if a message has given us a converted name
+ $nsConvKey = 'conversion-ns' . $index;
+ if ( !wfEmptyMsg( $nsConvKey ) ) {
+ $text = wfMsgForContentNoTrans( $nsConvKey );
+ } else {
+ // the message does not exist, try retrieve it from the current
+ // variant's namespace names.
+ $langObj = $this->mLangObj->factory( $variant );
+ $text = $langObj->getFormattedNsText( $index );
+ }
+ $text .= ':';
}
- $ret = implode( ':', $splittitle );
- return $ret;
+ $text .= $title->getText();
+ $text = $this->translate( $text, $variant );
+ return $text;
}
/**
* @param $text String: text to be converted
* @return String: converted text
*/
- public function convert( $text, $istitle = false ) {
- global $wgDisableLangConversion;
- if ( $wgDisableLangConversion ) return $text;
-
+ public function convert( $text ) {
$variant = $this->getPreferredVariant();
+ return $this->convertTo( $text, $variant );
+ }
- if( $istitle ) {
- $text = $this->convertNamespace( $text, $variant );
- }
-
+ /**
+ * Same as convert() except a extra parameter to custom variant.
+ *
+ * @param $text String: text to be converted
+ * @param $variant String: the target variant code
+ * @return String: converted text
+ */
+ public function convertTo( $text, $variant ) {
+ global $wgDisableLangConversion;
+ if ( $wgDisableLangConversion ) return $text;
return $this->recursiveConvertTopLevel( $text, $variant );
}
+ /**
+ * Recursively convert text on the outside. Allow to use nested
+ * markups to custom rules.
+ *
+ * @param $text String: text to be converted
+ * @param $variant String: the target variant code
+ * @param $depth Integer: depth of recursion
+ * @return String: converted text
+ */
protected function recursiveConvertTopLevel( $text, $variant, $depth = 0 ) {
$startPos = 0;
$out = '';
$length = strlen( $text );
while ( $startPos < $length ) {
- $m = false;
$pos = strpos( $text, '-{', $startPos );
-
+
if ( $pos === false ) {
// No more markup, append final segment
$out .= $this->autoConvert( substr( $text, $startPos ), $variant );
- $startPos = $length;
return $out;
}
return $out;
}
+ /**
+ * Recursively convert text on the inside.
+ *
+ * @param $text String: text to be converted
+ * @param $variant String: the target variant code
+ * @param $depth Integer: depth of recursion
+ * @return String: converted text
+ */
protected function recursiveConvertRule( $text, $variant, &$startPos, $depth = 0 ) {
// Quick sanity check (no function calls)
if ( $text[$startPos] !== '-' || $text[$startPos + 1] !== '{' ) {
- throw new MWException( __METHOD__.': invalid input string' );
+ throw new MWException( __METHOD__ . ': invalid input string' );
}
$startPos += 2;
$inner .= '-{';
if ( !$warningDone ) {
$inner .= '<span class="error">' .
- wfMsgForContent( 'language-converter-depth-warning',
+ wfMsgForContent( 'language-converter-depth-warning',
$this->mMaxDepth ) .
'</span>';
$warningDone = true;
$this->applyManualConv( $rule );
return $rule->getDisplay();
default:
- throw new MWException( __METHOD__.': invalid regex match' );
+ throw new MWException( __METHOD__ . ': invalid regex match' );
}
}
* @param $link String: the name of the link
* @param $nt Mixed: the title object of the link
* @param $ignoreOtherCond Boolean: to disable other conditions when
- * we need to transclude a template or update a category's link
+ * we need to transclude a template or update a category's link
* @return Null, the input parameters may be modified upon return
*/
public function findVariantLink( &$link, &$nt, $ignoreOtherCond = false ) {
}
$variants = $this->autoConvertToAllVariants( $link );
- if ( $variants == false ) { // give up
+ if ( !$variants ) { // give up
return;
}
}
}
- /**
+ /**
* Returns language specific hash options.
*/
public function getExtraHashOptions() {
* @private
*/
function loadTables( $fromcache = true ) {
- global $wgMemc;
if ( $this->mTablesLoaded ) {
return;
}
+ global $wgMemc;
wfProfileIn( __METHOD__ );
$this->mTablesLoaded = true;
$this->mTables = false;
wfProfileOut( __METHOD__ );
}
- /**
+ /**
* Hook for post processig after conversion tables are loaded.
*
*/
function postLoadTables() { }
- /**
+ /**
* Reload the conversion tables.
*
* @private
if ( strpos( $code, '/' ) === false ) {
$txt = $wgMessageCache->get( 'Conversiontable', true, $code );
- if( $txt === false ){
+ if ( $txt === false ) {
# FIXME: this method doesn't seem to be expecting
# this possible outcome...
$txt = '<Conversiontable>';
}
}
-
// parse the mappings in this page
$blocks = StringUtils::explode( '-{', $txt );
$ret = array();
}
$parsed[$key] = true;
-
// recursively parse the subpages
if ( $recursive ) {
foreach ( $sublinks as $link ) {
if ( $this->mUcfirst ) {
foreach ( $ret as $k => $v ) {
- $ret[Language::ucfirst( $k )] = Language::ucfirst( $v );
+ $ret[$this->mLangObj->ucfirst( $k )] = $this->mLangObj->ucfirst( $v );
}
}
return $ret;
// text should be splited by ";" only if a valid variant
// name exist after the markup, for example:
// -{zh-hans:<span style="font-size:120%;">xxx</span>;zh-hant:\
- // <span style="font-size:120%;">yyy</span>;}-
+ // <span style="font-size:120%;">yyy</span>;}-
// we should split it as:
// array(
// [0] => 'zh-hans:<span style="font-size:120%;">xxx</span>'
*/
function parseRules() {
$rules = $this->mRules;
- $flags = $this->mFlags;
$bidtable = array();
$unidtable = array();
$variants = $this->mConverter->mVariants;
$bidtable[$v] = $to;
} elseif ( count( $u ) == 2 ) {
$from = trim( $u[0] );
- $v = trim( $u[1] );
+ $v = trim( $u[1] );
if ( array_key_exists( $v, $unidtable )
&& !is_array( $unidtable[$v] )
&& $to
}
/*for unidirectional array fill to convert tables */
if ( ( $manLevel[$v] == 'bidirectional' || $manLevel[$v] == 'unidirectional' )
- && isset( $unidtable[$v] ) )
+ && isset( $unidtable[$v] ) )
{
if ( isset( $this->mConvTable[$v] ) ) {
$this->mConvTable[$v] = array_merge( $this->mConvTable[$v], $unidtable[$v] );
$variant = $this->mConverter->getPreferredVariant();
}
- $variants = $this->mConverter->mVariants;
$this->parseFlags();
$flags = $this->mFlags;