languages/LanguageConverter.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  * @ingroup Language
  20  */
  21
  22 /**
  23  * Base class for language conversion.
  24  * @ingroup Language
  25  *
  26  * @author Zhengzhu Feng <zhengzhu@gmail.com>
  27  * @author fdcn <fdcn64@gmail.com>
  28  * @author shinjiman <shinjiman@gmail.com>
  29  * @author PhiLiP <philip.npc@gmail.com>
  30  */
  31 class LanguageConverter {
  32         /**
  33          * languages supporting variants
  34          * @since 1.20
  35          * @var array
  36          */
  37         static public $languagesWithVariants = array(
  38                 'gan',
  39                 'iu',
  40                 'kk',
  41                 'ku',
  42                 'shi',
  43                 'sr',
  44                 'tg',
  45                 'uz',
  46                 'zh',
  47         );
  48
  49         public $mMainLanguageCode;
  50         public $mVariants, $mVariantFallbacks, $mVariantNames;
  51         public $mTablesLoaded = false;
  52         public $mTables;
  53         // 'bidirectional' 'unidirectional' 'disable' for each variant
  54         public $mManualLevel;
  55
  56         /**
  57          * @var string Memcached key name
  58          */
  59         public $mCacheKey;
  60
  61         public $mLangObj;
  62         public $mFlags;
  63         public $mDescCodeSep = ':', $mDescVarSep = ';';
  64         public $mUcfirst = false;
  65         public $mConvRuleTitle = false;
  66         public $mURLVariant;
  67         public $mUserVariant;
  68         public $mHeaderVariant;
  69         public $mMaxDepth = 10;
  70         public $mVarSeparatorPattern;
  71
  72         const CACHE_VERSION_KEY = 'VERSION 7';
  73
  74         /**
  75          * Constructor
  76          *
  77          * @param Language $langobj
  78          * @param string $maincode The main language code of this language
  79          * @param array $variants The supported variants of this language
  80          * @param array $variantfallbacks The fallback language of each variant
  81          * @param array $flags Defining the custom strings that maps to the flags
  82          * @param array $manualLevel Limit for supported variants
  83          */
  84         public function __construct( $langobj, $maincode, $variants = array(),
  85                                                                 $variantfallbacks = array(), $flags = array(),
  86                                                                 $manualLevel = array() ) {
  87                 global $wgDisabledVariants;
  88                 $this->mLangObj = $langobj;
  89                 $this->mMainLanguageCode = $maincode;
  90                 $this->mVariants = array_diff( $variants, $wgDisabledVariants );
  91                 $this->mVariantFallbacks = $variantfallbacks;
  92                 $this->mVariantNames = Language::fetchLanguageNames();
  93                 $this->mCacheKey = wfMemcKey( 'conversiontables', $maincode );
  94                 $defaultflags = array(
  95                         // 'S' show converted text
  96                         // '+' add rules for alltext
  97                         // 'E' the gave flags is error
  98                         // these flags above are reserved for program
  99                         'A' => 'A',       // add rule for convert code (all text convert)
 100                         'T' => 'T',       // title convert
 101                         'R' => 'R',       // raw content
 102                         'D' => 'D',       // convert description (subclass implement)
 103                         '-' => '-',       // remove convert (not implement)
 104                         'H' => 'H',       // add rule for convert code (but no display in placed code)
 105                         'N' => 'N'        // current variant name
 106                 );
 107                 $this->mFlags = array_merge( $defaultflags, $flags );
 108                 foreach ( $this->mVariants as $v ) {
 109                         if ( array_key_exists( $v, $manualLevel ) ) {
 110                                 $this->mManualLevel[$v] = $manualLevel[$v];
 111                         } else {
 112                                 $this->mManualLevel[$v] = 'bidirectional';
 113                         }
 114                         $this->mFlags[$v] = $v;
 115                 }
 116         }
 117
 118         /**
 119          * Get all valid variants.
 120          * Call this instead of using $this->mVariants directly.
 121          *
 122          * @return array Contains all valid variants
 123          */
 124         public function getVariants() {
 125                 return $this->mVariants;
 126         }
 127
 128         /**
 129          * In case some variant is not defined in the markup, we need
 130          * to have some fallback. For example, in zh, normally people
 131          * will define zh-hans and zh-hant, but less so for zh-sg or zh-hk.
 132          * when zh-sg is preferred but not defined, we will pick zh-hans
 133          * in this case. Right now this is only used by zh.
 134          *
 135          * @param string $variant The language code of the variant
 136          * @return string|array The code of the fallback language or the
 137          *   main code if there is no fallback
 138          */
 139         public function getVariantFallbacks( $variant ) {
 140                 if ( isset( $this->mVariantFallbacks[$variant] ) ) {
 141                         return $this->mVariantFallbacks[$variant];
 142                 }
 143                 return $this->mMainLanguageCode;
 144         }
 145
 146         /**
 147          * Get the title produced by the conversion rule.
 148          * @return string The converted title text
 149          */
 150         public function getConvRuleTitle() {
 151                 return $this->mConvRuleTitle;
 152         }
 153
 154         /**
 155          * Get preferred language variant.
 156          * @return string The preferred language code
 157          */
 158         public function getPreferredVariant() {
 159                 global $wgDefaultLanguageVariant, $wgUser;
 160
 161                 $req = $this->getURLVariant();
 162
 163                 if ( $wgUser->isLoggedIn() && !$req ) {
 164                         $req = $this->getUserVariant();
 165                 } elseif ( !$req ) {
 166                         $req = $this->getHeaderVariant();
 167                 }
 168
 169                 if ( $wgDefaultLanguageVariant && !$req ) {
 170                         $req = $this->validateVariant( $wgDefaultLanguageVariant );
 171                 }
 172
 173                 // This function, unlike the other get*Variant functions, is
 174                 // not memoized (i.e. there return value is not cached) since
 175                 // new information might appear during processing after this
 176                 // is first called.
 177                 if ( $this->validateVariant( $req ) ) {
 178                         return $req;
 179                 }
 180                 return $this->mMainLanguageCode;
 181         }
 182
 183         /**
 184          * Get default variant.
 185          * This function would not be affected by user's settings
 186          * @return string The default variant code
 187          */
 188         public function getDefaultVariant() {
 189                 global $wgDefaultLanguageVariant;
 190
 191                 $req = $this->getURLVariant();
 192
 193                 if ( !$req ) {
 194                         $req = $this->getHeaderVariant();
 195                 }
 196
 197                 if ( $wgDefaultLanguageVariant && !$req ) {
 198                         $req = $this->validateVariant( $wgDefaultLanguageVariant );
 199                 }
 200
 201                 if ( $req ) {
 202                         return $req;
 203                 }
 204                 return $this->mMainLanguageCode;
 205         }
 206
 207         /**
 208          * Validate the variant
 209          * @param string $variant The variant to validate
 210          * @return mixed Returns the variant if it is valid, null otherwise
 211          */
 212         public function validateVariant( $variant = null ) {
 213                 if ( $variant !== null && in_array( $variant, $this->mVariants ) ) {
 214                         return $variant;
 215                 }
 216                 return null;
 217         }
 218
 219         /**
 220          * Get the variant specified in the URL
 221          *
 222          * @return mixed Variant if one found, false otherwise.
 223          */
 224         public function getURLVariant() {
 225                 global $wgRequest;
 226
 227                 if ( $this->mURLVariant ) {
 228                         return $this->mURLVariant;
 229                 }
 230
 231                 // see if the preference is set in the request
 232                 $ret = $wgRequest->getText( 'variant' );
 233
 234                 if ( !$ret ) {
 235                         $ret = $wgRequest->getVal( 'uselang' );
 236                 }
 237
 238                 $this->mURLVariant = $this->validateVariant( $ret );
 239                 return $this->mURLVariant;
 240         }
 241
 242         /**
 243          * Determine if the user has a variant set.
 244          *
 245          * @return mixed Variant if one found, false otherwise.
 246          */
 247         protected function getUserVariant() {
 248                 global $wgUser, $wgContLang;
 249
 250                 // memoizing this function wreaks havoc on parserTest.php
 251                 /*
 252                 if ( $this->mUserVariant ) {
 253                         return $this->mUserVariant;
 254                 }
 255                 */
 256
 257                 // Get language variant preference from logged in users
 258                 // Don't call this on stub objects because that causes infinite
 259                 // recursion during initialisation
 260                 if ( $wgUser->isLoggedIn() ) {
 261                         if ( $this->mMainLanguageCode == $wgContLang->getCode() ) {
 262                                 $ret = $wgUser->getOption( 'variant' );
 263                         } else {
 264                                 $ret = $wgUser->getOption( 'variant-' . $this->mMainLanguageCode );
 265                         }
 266                 } else {
 267                         // figure out user lang without constructing wgLang to avoid
 268                         // infinite recursion
 269                         $ret = $wgUser->getOption( 'language' );
 270                 }
 271
 272                 $this->mUserVariant = $this->validateVariant( $ret );
 273                 return $this->mUserVariant;
 274         }
 275
 276         /**
 277          * Determine the language variant from the Accept-Language header.
 278          *
 279          * @return mixed Variant if one found, false otherwise.
 280          */
 281         protected function getHeaderVariant() {
 282                 global $wgRequest;
 283
 284                 if ( $this->mHeaderVariant ) {
 285                         return $this->mHeaderVariant;
 286                 }
 287
 288                 // see if some supported language variant is set in the
 289                 // HTTP header.
 290                 $languages = array_keys( $wgRequest->getAcceptLang() );
 291                 if ( empty( $languages ) ) {
 292                         return null;
 293                 }
 294
 295                 $fallbackLanguages = array();
 296                 foreach ( $languages as $language ) {
 297                         $this->mHeaderVariant = $this->validateVariant( $language );
 298                         if ( $this->mHeaderVariant ) {
 299                                 break;
 300                         }
 301
 302                         // To see if there are fallbacks of current language.
 303                         // We record these fallback variants, and process
 304                         // them later.
 305                         $fallbacks = $this->getVariantFallbacks( $language );
 306                         if ( is_string( $fallbacks ) && $fallbacks !== $this->mMainLanguageCode ) {
 307                                 $fallbackLanguages[] = $fallbacks;
 308                         } elseif ( is_array( $fallbacks ) ) {
 309                                 $fallbackLanguages =
 310                                         array_merge( $fallbackLanguages, $fallbacks );
 311                         }
 312                 }
 313
 314                 if ( !$this->mHeaderVariant ) {
 315                         // process fallback languages now
 316                         $fallback_languages = array_unique( $fallbackLanguages );
 317                         foreach ( $fallback_languages as $language ) {
 318                                 $this->mHeaderVariant = $this->validateVariant( $language );
 319                                 if ( $this->mHeaderVariant ) {
 320                                         break;
 321                                 }
 322                         }
 323                 }
 324
 325                 return $this->mHeaderVariant;
 326         }
 327
 328         /**
 329          * Dictionary-based conversion.
 330          * This function would not parse the conversion rules.
 331          * If you want to parse rules, try to use convert() or
 332          * convertTo().
 333          *
 334          * @param string $text The text to be converted
 335          * @param bool|string $toVariant The target language code
 336          * @return string The converted text
 337          */
 338         public function autoConvert( $text, $toVariant = false ) {
 339
 340                 $this->loadTables();
 341
 342                 if ( !$toVariant ) {
 343                         $toVariant = $this->getPreferredVariant();
 344                         if ( !$toVariant ) {
 345                                 return $text;
 346                         }
 347                 }
 348
 349                 if ( $this->guessVariant( $text, $toVariant ) ) {
 350                         return $text;
 351                 }
 352
 353                 /* we convert everything except:
 354                    1. HTML markups (anything between < and >)
 355                    2. HTML entities
 356                    3. placeholders created by the parser
 357                 */
 358                 global $wgParser;
 359                 if ( isset( $wgParser ) && $wgParser->UniqPrefix() != '' ) {
 360                         $marker = '|' . $wgParser->UniqPrefix() . '[\-a-zA-Z0-9]+';
 361                 } else {
 362                         $marker = '';
 363                 }
 364
 365                 // this one is needed when the text is inside an HTML markup
 366                 $htmlfix = '|<[^>]+$|^[^<>]*>';
 367
 368                 // disable convert to variants between <code> tags
 369                 $codefix = '<code>.+?<\/code>|';
 370                 // disable conversion of <script> tags
 371                 $scriptfix = '<script.*?>.*?<\/script>|';
 372                 // disable conversion of <pre> tags
 373                 $prefix = '<pre.*?>.*?<\/pre>|';
 374
 375                 $reg = '/' . $codefix . $scriptfix . $prefix .
 376                         '<[^>]+>|&[a-zA-Z#][a-z0-9]+;' . $marker . $htmlfix . '/s';
 377                 $startPos = 0;
 378                 $sourceBlob = '';
 379                 $literalBlob = '';
 380
 381                 // Guard against delimiter nulls in the input
 382                 $text = str_replace( "\000", '', $text );
 383
 384                 $markupMatches = null;
 385                 $elementMatches = null;
 386                 while ( $startPos < strlen( $text ) ) {
 387                         if ( preg_match( $reg, $text, $markupMatches, PREG_OFFSET_CAPTURE, $startPos ) ) {
 388                                 $elementPos = $markupMatches[0][1];
 389                                 $element = $markupMatches[0][0];
 390                         } else {
 391                                 $elementPos = strlen( $text );
 392                                 $element = '';
 393                         }
 394
 395                         // Queue the part before the markup for translation in a batch
 396                         $sourceBlob .= substr( $text, $startPos, $elementPos - $startPos ) . "\000";
 397
 398                         // Advance to the next position
 399                         $startPos = $elementPos + strlen( $element );
 400
 401                         // Translate any alt or title attributes inside the matched element
 402                         if ( $element !== ''
 403                                 && preg_match( '/^(<[^>\s]*)\s([^>]*)(.*)$/', $element, $elementMatches )
 404                         ) {
 405                                 $attrs = Sanitizer::decodeTagAttributes( $elementMatches[2] );
 406                                 $changed = false;
 407                                 foreach ( array( 'title', 'alt' ) as $attrName ) {
 408                                         if ( !isset( $attrs[$attrName] ) ) {
 409                                                 continue;
 410                                         }
 411                                         $attr = $attrs[$attrName];
 412                                         // Don't convert URLs
 413                                         if ( !strpos( $attr, '://' ) ) {
 414                                                 $attr = $this->recursiveConvertTopLevel( $attr, $toVariant );
 415                                         }
 416
 417                                         // Remove HTML tags to avoid disrupting the layout
 418                                         $attr = preg_replace( '/<[^>]+>/', '', $attr );
 419                                         if ( $attr !== $attrs[$attrName] ) {
 420                                                 $attrs[$attrName] = $attr;
 421                                                 $changed = true;
 422                                         }
 423                                 }
 424                                 if ( $changed ) {
 425                                         $element = $elementMatches[1] . Html::expandAttributes( $attrs ) .
 426                                                 $elementMatches[3];
 427                                 }
 428                         }
 429                         $literalBlob .= $element . "\000";
 430                 }
 431
 432                 // Do the main translation batch
 433                 $translatedBlob = $this->translate( $sourceBlob, $toVariant );
 434
 435                 // Put the output back together
 436                 $translatedIter = StringUtils::explode( "\000", $translatedBlob );
 437                 $literalIter = StringUtils::explode( "\000", $literalBlob );
 438                 $output = '';
 439                 while ( $translatedIter->valid() && $literalIter->valid() ) {
 440                         $output .= $translatedIter->current();
 441                         $output .= $literalIter->current();
 442                         $translatedIter->next();
 443                         $literalIter->next();
 444                 }
 445
 446                 return $output;
 447         }
 448
 449         /**
 450          * Translate a string to a variant.
 451          * Doesn't parse rules or do any of that other stuff, for that use
 452          * convert() or convertTo().
 453          *
 454          * @param string $text Text to convert
 455          * @param string $variant Variant language code
 456          * @return string Translated text
 457          */
 458         public function translate( $text, $variant ) {
 459                 // If $text is empty or only includes spaces, do nothing
 460                 // Otherwise translate it
 461                 if ( trim( $text ) ) {
 462                         $this->loadTables();
 463                         $text = $this->mTables[$variant]->replace( $text );
 464                 }
 465                 return $text;
 466         }
 467
 468         /**
 469          * Call translate() to convert text to all valid variants.
 470          *
 471          * @param string $text The text to be converted
 472          * @return array Variant => converted text
 473          */
 474         public function autoConvertToAllVariants( $text ) {
 475                 $this->loadTables();
 476
 477                 $ret = array();
 478                 foreach ( $this->mVariants as $variant ) {
 479                         $ret[$variant] = $this->translate( $text, $variant );
 480                 }
 481
 482                 return $ret;
 483         }
 484
 485         /**
 486          * Apply manual conversion rules.
 487          *
 488          * @param ConverterRule $convRule
 489          */
 490         protected function applyManualConv( $convRule ) {
 491                 // Use syntax -{T|zh-cn:TitleCN; zh-tw:TitleTw}- to custom
 492                 // title conversion.
 493                 // Bug 24072: $mConvRuleTitle was overwritten by other manual
 494                 // rule(s) not for title, this breaks the title conversion.
 495                 $newConvRuleTitle = $convRule->getTitle();
 496                 if ( $newConvRuleTitle ) {
 497                         // So I add an empty check for getTitle()
 498                         $this->mConvRuleTitle = $newConvRuleTitle;
 499                 }
 500
 501                 // merge/remove manual conversion rules to/from global table
 502                 $convTable = $convRule->getConvTable();
 503                 $action = $convRule->getRulesAction();
 504                 foreach ( $convTable as $variant => $pair ) {
 505                         if ( !$this->validateVariant( $variant ) ) {
 506                                 continue;
 507                         }
 508
 509                         if ( $action == 'add' ) {
 510                                 foreach ( $pair as $from => $to ) {
 511                                         // to ensure that $from and $to not be left blank
 512                                         // so $this->translate() could always return a string
 513                                         if ( $from || $to ) {
 514                                                 // more efficient than array_merge(), about 2.5 times.
 515                                                 $this->mTables[$variant]->setPair( $from, $to );
 516                                         }
 517                                 }
 518                         } elseif ( $action == 'remove' ) {
 519                                 $this->mTables[$variant]->removeArray( $pair );
 520                         }
 521                 }
 522         }
 523
 524         /**
 525          * Auto convert a Title object to a readable string in the
 526          * preferred variant.
 527          *
 528          * @param Title $title A object of Title
 529          * @return string Converted title text
 530          */
 531         public function convertTitle( $title ) {
 532                 $variant = $this->getPreferredVariant();
 533                 $index = $title->getNamespace();
 534                 if ( $index !== NS_MAIN ) {
 535                         $text = $this->convertNamespace( $index, $variant ) . ':';
 536                 } else {
 537                         $text = '';
 538                 }
 539                 $text .= $this->translate( $title->getText(), $variant );
 540                 return $text;
 541         }
 542
 543         /**
 544          * Get the namespace display name in the preferred variant.
 545          *
 546          * @param int $index Namespace id
 547          * @param string|null $variant Variant code or null for preferred variant
 548          * @return string Namespace name for display
 549          */
 550         public function convertNamespace( $index, $variant = null ) {
 551                 if ( $variant === null ) {
 552                         $variant = $this->getPreferredVariant();
 553                 }
 554                 if ( $index === NS_MAIN ) {
 555                         return '';
 556                 } else {
 557                         // First check if a message gives a converted name in the target variant.
 558                         $nsConvMsg = wfMessage( 'conversion-ns' . $index )->inLanguage( $variant );
 559                         if ( $nsConvMsg->exists() ) {
 560                                 return $nsConvMsg->plain();
 561                         }
 562                         // Then check if a message gives a converted name in content language
 563                         // which needs extra translation to the target variant.
 564                         $nsConvMsg = wfMessage( 'conversion-ns' . $index )->inContentLanguage();
 565                         if ( $nsConvMsg->exists() ) {
 566                                 return $this->translate( $nsConvMsg->plain(), $variant );
 567                         }
 568                         // No message exists, retrieve it from the target variant's namespace names.
 569                         $langObj = $this->mLangObj->factory( $variant );
 570                         return $langObj->getFormattedNsText( $index );
 571                 }
 572         }
 573
 574         /**
 575          * Convert text to different variants of a language. The automatic
 576          * conversion is done in autoConvert(). Here we parse the text
 577          * marked with -{}-, which specifies special conversions of the
 578          * text that can not be accomplished in autoConvert().
 579          *
 580          * Syntax of the markup:
 581          * -{code1:text1;code2:text2;...}-  or
 582          * -{flags|code1:text1;code2:text2;...}-  or
 583          * -{text}- in which case no conversion should take place for text
 584          *
 585          * @param string $text Text to be converted
 586          * @return string Converted text
 587          */
 588         public function convert( $text ) {
 589                 $variant = $this->getPreferredVariant();
 590                 return $this->convertTo( $text, $variant );
 591         }
 592
 593         /**
 594          * Same as convert() except a extra parameter to custom variant.
 595          *
 596          * @param string $text Text to be converted
 597          * @param string $variant The target variant code
 598          * @return string Converted text
 599          */
 600         public function convertTo( $text, $variant ) {
 601                 global $wgDisableLangConversion;
 602                 if ( $wgDisableLangConversion ) {
 603                         return $text;
 604                 }
 605                 // Reset converter state for a new converter run.
 606                 $this->mConvRuleTitle = false;
 607                 return $this->recursiveConvertTopLevel( $text, $variant );
 608         }
 609
 610         /**
 611          * Recursively convert text on the outside. Allow to use nested
 612          * markups to custom rules.
 613          *
 614          * @param string $text Text to be converted
 615          * @param string $variant The target variant code
 616          * @param int $depth Depth of recursion
 617          * @return string Converted text
 618          */
 619         protected function recursiveConvertTopLevel( $text, $variant, $depth = 0 ) {
 620                 $startPos = 0;
 621                 $out = '';
 622                 $length = strlen( $text );
 623                 $shouldConvert = !$this->guessVariant( $text, $variant );
 624
 625                 while ( $startPos < $length ) {
 626                         $pos = strpos( $text, '-{', $startPos );
 627
 628                         if ( $pos === false ) {
 629                                 // No more markup, append final segment
 630                                 $fragment = substr( $text, $startPos );
 631                                 $out .= $shouldConvert ? $this->autoConvert( $fragment, $variant ) : $fragment;
 632                                 return $out;
 633                         }
 634
 635                         // Markup found
 636                         // Append initial segment
 637                         $fragment = substr( $text, $startPos, $pos - $startPos );
 638                         $out .= $shouldConvert ? $this->autoConvert( $fragment, $variant ) : $fragment;
 639
 640                         // Advance position
 641                         $startPos = $pos;
 642
 643                         // Do recursive conversion
 644                         $out .= $this->recursiveConvertRule( $text, $variant, $startPos, $depth + 1 );
 645                 }
 646
 647                 return $out;
 648         }
 649
 650         /**
 651          * Recursively convert text on the inside.
 652          *
 653          * @param string $text Text to be converted
 654          * @param string $variant The target variant code
 655          * @param int $startPos
 656          * @param int $depth Depth of recursion
 657          *
 658          * @throws MWException
 659          * @return string Converted text
 660          */
 661         protected function recursiveConvertRule( $text, $variant, &$startPos, $depth = 0 ) {
 662                 // Quick sanity check (no function calls)
 663                 if ( $text[$startPos] !== '-' || $text[$startPos + 1] !== '{' ) {
 664                         throw new MWException( __METHOD__ . ': invalid input string' );
 665                 }
 666
 667                 $startPos += 2;
 668                 $inner = '';
 669                 $warningDone = false;
 670                 $length = strlen( $text );
 671
 672                 while ( $startPos < $length ) {
 673                         $m = false;
 674                         preg_match( '/-\{|\}-/', $text, $m, PREG_OFFSET_CAPTURE, $startPos );
 675                         if ( !$m ) {
 676                                 // Unclosed rule
 677                                 break;
 678                         }
 679
 680                         $token = $m[0][0];
 681                         $pos = $m[0][1];
 682
 683                         // Markup found
 684                         // Append initial segment
 685                         $inner .= substr( $text, $startPos, $pos - $startPos );
 686
 687                         // Advance position
 688                         $startPos = $pos;
 689
 690                         switch ( $token ) {
 691                                 case '-{':
 692                                         // Check max depth
 693                                         if ( $depth >= $this->mMaxDepth ) {
 694                                                 $inner .= '-{';
 695                                                 if ( !$warningDone ) {
 696                                                         $inner .= '<span class="error">' .
 697                                                                 wfMessage( 'language-converter-depth-warning' )
 698                                                                         ->numParams( $this->mMaxDepth )->inContentLanguage()->text() .
 699                                                                 '</span>';
 700                                                         $warningDone = true;
 701                                                 }
 702                                                 $startPos += 2;
 703                                                 continue;
 704                                         }
 705                                         // Recursively parse another rule
 706                                         $inner .= $this->recursiveConvertRule( $text, $variant, $startPos, $depth + 1 );
 707                                         break;
 708                                 case '}-':
 709                                         // Apply the rule
 710                                         $startPos += 2;
 711                                         $rule = new ConverterRule( $inner, $this );
 712                                         $rule->parse( $variant );
 713                                         $this->applyManualConv( $rule );
 714                                         return $rule->getDisplay();
 715                                 default:
 716                                         throw new MWException( __METHOD__ . ': invalid regex match' );
 717                         }
 718                 }
 719
 720                 // Unclosed rule
 721                 if ( $startPos < $length ) {
 722                         $inner .= substr( $text, $startPos );
 723                 }
 724                 $startPos = $length;
 725                 return '-{' . $this->autoConvert( $inner, $variant );
 726         }
 727
 728         /**
 729          * If a language supports multiple variants, it is possible that
 730          * non-existing link in one variant actually exists in another variant.
 731          * This function tries to find it. See e.g. LanguageZh.php
 732          * The input parameters may be modified upon return
 733          *
 734          * @param string &$link The name of the link
 735          * @param Title &$nt The title object of the link
 736          * @param bool $ignoreOtherCond To disable other conditions when
 737          *   we need to transclude a template or update a category's link
 738          */
 739         public function findVariantLink( &$link, &$nt, $ignoreOtherCond = false ) {
 740                 # If the article has already existed, there is no need to
 741                 # check it again, otherwise it may cause a fault.
 742                 if ( is_object( $nt ) && $nt->exists() ) {
 743                         return;
 744                 }
 745
 746                 global $wgDisableLangConversion, $wgDisableTitleConversion, $wgRequest;
 747                 $isredir = $wgRequest->getText( 'redirect', 'yes' );
 748                 $action = $wgRequest->getText( 'action' );
 749                 if ( $action == 'edit' && $wgRequest->getBool( 'redlink' ) ) {
 750                         $action = 'view';
 751                 }
 752                 $linkconvert = $wgRequest->getText( 'linkconvert', 'yes' );
 753                 $disableLinkConversion = $wgDisableLangConversion
 754                         || $wgDisableTitleConversion;
 755                 $linkBatch = new LinkBatch();
 756
 757                 $ns = NS_MAIN;
 758
 759                 if ( $disableLinkConversion ||
 760                         ( !$ignoreOtherCond &&
 761                                 ( $isredir == 'no'
 762                                         || $action == 'edit'
 763                                         || $action == 'submit'
 764                                         || $linkconvert == 'no' ) ) ) {
 765                         return;
 766                 }
 767
 768                 if ( is_object( $nt ) ) {
 769                         $ns = $nt->getNamespace();
 770                 }
 771
 772                 $variants = $this->autoConvertToAllVariants( $link );
 773                 if ( !$variants ) { // give up
 774                         return;
 775                 }
 776
 777                 $titles = array();
 778
 779                 foreach ( $variants as $v ) {
 780                         if ( $v != $link ) {
 781                                 $varnt = Title::newFromText( $v, $ns );
 782                                 if ( !is_null( $varnt ) ) {
 783                                         $linkBatch->addObj( $varnt );
 784                                         $titles[] = $varnt;
 785                                 }
 786                         }
 787                 }
 788
 789                 // fetch all variants in single query
 790                 $linkBatch->execute();
 791
 792                 foreach ( $titles as $varnt ) {
 793                         if ( $varnt->getArticleID() > 0 ) {
 794                                 $nt = $varnt;
 795                                 $link = $varnt->getText();
 796                                 break;
 797                         }
 798                 }
 799         }
 800
 801         /**
 802          * Returns language specific hash options.
 803          *
 804          * @return string
 805          */
 806         public function getExtraHashOptions() {
 807                 $variant = $this->getPreferredVariant();
 808
 809                 return '!' . $variant;
 810         }
 811
 812         /**
 813          * Guess if a text is written in a variant. This should be implemented in subclasses.
 814          *
 815          * @param string $text The text to be checked
 816          * @param string $variant Language code of the variant to be checked for
 817          * @return bool True if $text appears to be written in $variant, false if not
 818          *
 819          * @author Nikola Smolenski <smolensk@eunet.rs>
 820          * @since 1.19
 821          */
 822         public function guessVariant( $text, $variant ) {
 823                 return false;
 824         }
 825
 826         /**
 827          * Load default conversion tables.
 828          * This method must be implemented in derived class.
 829          *
 830          * @private
 831          * @throws MWException
 832          */
 833         function loadDefaultTables() {
 834                 $name = get_class( $this );
 835
 836                 throw new MWException( "Must implement loadDefaultTables() method in class $name" );
 837         }
 838
 839         /**
 840          * Load conversion tables either from the cache or the disk.
 841          * @private
 842          * @param bool $fromCache Load from memcached? Defaults to true.
 843          */
 844         function loadTables( $fromCache = true ) {
 845                 global $wgLanguageConverterCacheType;
 846
 847                 if ( $this->mTablesLoaded ) {
 848                         return;
 849                 }
 850
 851                 $this->mTablesLoaded = true;
 852                 $this->mTables = false;
 853                 $cache = ObjectCache::getInstance( $wgLanguageConverterCacheType );
 854                 if ( $fromCache ) {
 855                         wfProfileIn( __METHOD__ . '-cache' );
 856                         $this->mTables = $cache->get( $this->mCacheKey );
 857                         wfProfileOut( __METHOD__ . '-cache' );
 858                 }
 859                 if ( !$this->mTables || !array_key_exists( self::CACHE_VERSION_KEY, $this->mTables ) ) {
 860                         wfProfileIn( __METHOD__ . '-recache' );
 861                         // not in cache, or we need a fresh reload.
 862                         // We will first load the default tables
 863                         // then update them using things in MediaWiki:Conversiontable/*
 864                         $this->loadDefaultTables();
 865                         foreach ( $this->mVariants as $var ) {
 866                                 $cached = $this->parseCachedTable( $var );
 867                                 $this->mTables[$var]->mergeArray( $cached );
 868                         }
 869
 870                         $this->postLoadTables();
 871                         $this->mTables[self::CACHE_VERSION_KEY] = true;
 872
 873                         $cache->set( $this->mCacheKey, $this->mTables, 43200 );
 874                         wfProfileOut( __METHOD__ . '-recache' );
 875                 }
 876         }
 877
 878         /**
 879          * Hook for post processing after conversion tables are loaded.
 880          */
 881         function postLoadTables() {
 882         }
 883
 884         /**
 885          * Reload the conversion tables.
 886          *
 887          * @private
 888          */
 889         function reloadTables() {
 890                 if ( $this->mTables ) {
 891                         unset( $this->mTables );
 892                 }
 893
 894                 $this->mTablesLoaded = false;
 895                 $this->loadTables( false );
 896         }
 897
 898         /**
 899          * Parse the conversion table stored in the cache.
 900          *
 901          * The tables should be in blocks of the following form:
 902          *              -{
 903          *                      word => word ;
 904          *                      word => word ;
 905          *                      ...
 906          *              }-
 907          *
 908          * To make the tables more manageable, subpages are allowed
 909          * and will be parsed recursively if $recursive == true.
 910          *
 911          * @param string $code Language code
 912          * @param string $subpage Subpage name
 913          * @param bool $recursive Parse subpages recursively? Defaults to true.
 914          *
 915          * @return array
 916          */
 917         function parseCachedTable( $code, $subpage = '', $recursive = true ) {
 918                 static $parsed = array();
 919
 920                 $key = 'Conversiontable/' . $code;
 921                 if ( $subpage ) {
 922                         $key .= '/' . $subpage;
 923                 }
 924                 if ( array_key_exists( $key, $parsed ) ) {
 925                         return array();
 926                 }
 927
 928                 $parsed[$key] = true;
 929
 930                 if ( $subpage === '' ) {
 931                         $txt = MessageCache::singleton()->getMsgFromNamespace( $key, $code );
 932                 } else {
 933                         $txt = false;
 934                         $title = Title::makeTitleSafe( NS_MEDIAWIKI, $key );
 935                         if ( $title && $title->exists() ) {
 936                                 $revision = Revision::newFromTitle( $title );
 937                                 if ( $revision ) {
 938                                         if ( $revision->getContentModel() == CONTENT_MODEL_WIKITEXT ) {
 939                                                 $txt = $revision->getContent( Revision::RAW )->getNativeData();
 940                                         }
 941
 942                                         // @todo in the future, use a specialized content model, perhaps based on json!
 943                                 }
 944                         }
 945                 }
 946
 947                 # Nothing to parse if there's no text
 948                 if ( $txt === false || $txt === null || $txt === '' ) {
 949                         return array();
 950                 }
 951
 952                 // get all subpage links of the form
 953                 // [[MediaWiki:Conversiontable/zh-xx/...|...]]
 954                 $linkhead = $this->mLangObj->getNsText( NS_MEDIAWIKI ) .
 955                         ':Conversiontable';
 956                 $subs = StringUtils::explode( '[[', $txt );
 957                 $sublinks = array();
 958                 foreach ( $subs as $sub ) {
 959                         $link = explode( ']]', $sub, 2 );
 960                         if ( count( $link ) != 2 ) {
 961                                 continue;
 962                         }
 963                         $b = explode( '|', $link[0], 2 );
 964                         $b = explode( '/', trim( $b[0] ), 3 );
 965                         if ( count( $b ) == 3 ) {
 966                                 $sublink = $b[2];
 967                         } else {
 968                                 $sublink = '';
 969                         }
 970
 971                         if ( $b[0] == $linkhead && $b[1] == $code ) {
 972                                 $sublinks[] = $sublink;
 973                         }
 974                 }
 975
 976                 // parse the mappings in this page
 977                 $blocks = StringUtils::explode( '-{', $txt );
 978                 $ret = array();
 979                 $first = true;
 980                 foreach ( $blocks as $block ) {
 981                         if ( $first ) {
 982                                 // Skip the part before the first -{
 983                                 $first = false;
 984                                 continue;
 985                         }
 986                         $mappings = explode( '}-', $block, 2 );
 987                         $stripped = str_replace( array( "'", '"', '*', '#' ), '', $mappings[0] );
 988                         $table = StringUtils::explode( ';', $stripped );
 989                         foreach ( $table as $t ) {
 990                                 $m = explode( '=>', $t, 3 );
 991                                 if ( count( $m ) != 2 ) {
 992                                         continue;
 993                                 }
 994                                 // trim any trailling comments starting with '//'
 995                                 $tt = explode( '//', $m[1], 2 );
 996                                 $ret[trim( $m[0] )] = trim( $tt[0] );
 997                         }
 998                 }
 999
1000                 // recursively parse the subpages
1001                 if ( $recursive ) {
1002                         foreach ( $sublinks as $link ) {
1003                                 $s = $this->parseCachedTable( $code, $link, $recursive );
1004                                 $ret = array_merge( $ret, $s );
1005                         }
1006                 }
1007
1008                 if ( $this->mUcfirst ) {
1009                         foreach ( $ret as $k => $v ) {
1010                                 $ret[$this->mLangObj->ucfirst( $k )] = $this->mLangObj->ucfirst( $v );
1011                         }
1012                 }
1013                 return $ret;
1014         }
1015
1016         /**
1017          * Enclose a string with the "no conversion" tag. This is used by
1018          * various functions in the Parser.
1019          *
1020          * @param string $text Text to be tagged for no conversion
1021          * @param bool $noParse Unused
1022          * @return string The tagged text
1023          */
1024         public function markNoConversion( $text, $noParse = false ) {
1025                 # don't mark if already marked
1026                 if ( strpos( $text, '-{' ) || strpos( $text, '}-' ) ) {
1027                         return $text;
1028                 }
1029
1030                 $ret = "-{R|$text}-";
1031                 return $ret;
1032         }
1033
1034         /**
1035          * Convert the sorting key for category links. This should make different
1036          * keys that are variants of each other map to the same key.
1037          *
1038          * @param string $key
1039          *
1040          * @return string
1041          */
1042         function convertCategoryKey( $key ) {
1043                 return $key;
1044         }
1045
1046         /**
1047          * Hook to refresh the cache of conversion tables when
1048          * MediaWiki:Conversiontable* is updated.
1049          * @private
1050          *
1051          * @param WikiPage $page
1052          * @param User $user User object for the current user
1053          * @param Content $content New page content
1054          * @param string $summary Edit summary of the edit
1055          * @param bool $isMinor Was the edit marked as minor?
1056          * @param null $isWatch Unused.
1057          * @param null $section Unused.
1058          * @param int $flags Bitfield
1059          * @param Revision|null $revision New Revision object or null
1060          * @return bool True
1061          */
1062         function OnPageContentSaveComplete( $page, $user, $content, $summary, $isMinor,
1063                         $isWatch, $section, $flags, $revision ) {
1064                 $titleobj = $page->getTitle();
1065                 if ( $titleobj->getNamespace() == NS_MEDIAWIKI ) {
1066                         $title = $titleobj->getDBkey();
1067                         $t = explode( '/', $title, 3 );
1068                         $c = count( $t );
1069                         if ( $c > 1 && $t[0] == 'Conversiontable' ) {
1070                                 if ( $this->validateVariant( $t[1] ) ) {
1071                                         $this->reloadTables();
1072                                 }
1073                         }
1074                 }
1075                 return true;
1076         }
1077
1078         /**
1079          * Armour rendered math against conversion.
1080          * Escape special chars in parsed math text. (in most cases are img elements)
1081          *
1082          * @param string $text Text to armour against conversion
1083          * @return string Armoured text where { and } have been converted to
1084          *   &#123; and &#125;
1085          * @deprecated since 1.22 is no longer used
1086          */
1087         public function armourMath( $text ) {
1088                 // convert '-{' and '}-' to '-&#123;' and '&#125;-' to prevent
1089                 // any unwanted markup appearing in the math image tag.
1090                 $text = strtr( $text, array( '-{' => '-&#123;', '}-' => '&#125;-' ) );
1091                 return $text;
1092         }
1093
1094         /**
1095          * Get the cached separator pattern for ConverterRule::parseRules()
1096          * @return string
1097          */
1098         function getVarSeparatorPattern() {
1099                 if ( is_null( $this->mVarSeparatorPattern ) ) {
1100                         // varsep_pattern for preg_split:
1101                         // text should be splited by ";" only if a valid variant
1102                         // name exist after the markup, for example:
1103                         //  -{zh-hans:<span style="font-size:120%;">xxx</span>;zh-hant:\
1104                         //      <span style="font-size:120%;">yyy</span>;}-
1105                         // we should split it as:
1106                         //  array(
1107                         //        [0] => 'zh-hans:<span style="font-size:120%;">xxx</span>'
1108                         //        [1] => 'zh-hant:<span style="font-size:120%;">yyy</span>'
1109                         //        [2] => ''
1110                         //       )
1111                         $pat = '/;\s*(?=';
1112                         foreach ( $this->mVariants as $variant ) {
1113                                 // zh-hans:xxx;zh-hant:yyy
1114                                 $pat .= $variant . '\s*:|';
1115                                 // xxx=>zh-hans:yyy; xxx=>zh-hant:zzz
1116                                 $pat .= '[^;]*?=>\s*' . $variant . '\s*:|';
1117                         }
1118                         $pat .= '\s*$)/';
1119                         $this->mVarSeparatorPattern = $pat;
1120                 }
1121                 return $this->mVarSeparatorPattern;
1122         }
1123 }