4 * Contains the LanguageConverter class and ConverterRule class
7 * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License
12 * Base class for language conversion.
15 * @author Zhengzhu Feng <zhengzhu@gmail.com>
16 * @maintainers fdcn <fdcn64@gmail.com>, shinjiman <shinjiman@gmail.com>, PhiLiP <philip.npc@gmail.com>
18 class LanguageConverter
{
19 var $mMainLanguageCode;
20 var $mVariants, $mVariantFallbacks, $mVariantNames;
21 var $mTablesLoaded = false;
23 var $mNamespaceTables;
24 // 'bidirectional' 'unidirectional' 'disable' for each variant
29 var $mDescCodeSep = ':', $mDescVarSep = ';';
30 var $mUcfirst = false;
31 var $mConvRuleTitle = false;
36 var $mVarSeparatorPattern;
38 const CACHE_VERSION_KEY
= 'VERSION 6';
43 * @param $langobj The Language Object
44 * @param $maincode String: the main language code of this language
45 * @param $variants Array: the supported variants of this language
46 * @param $variantfallbacks Array: the fallback language of each variant
47 * @param $flags Array: defining the custom strings that maps to the flags
48 * @param $manualLevel Array: limit for supported variants
50 public function __construct( $langobj, $maincode,
52 $variantfallbacks = array(),
54 $manualLevel = array() ) {
55 $this->mLangObj
= $langobj;
56 $this->mMainLanguageCode
= $maincode;
58 global $wgDisabledVariants;
59 $this->mVariants
= array();
60 foreach ( $variants as $variant ) {
61 if ( !in_array( $variant, $wgDisabledVariants ) ) {
62 $this->mVariants
[] = $variant;
65 $this->mVariantFallbacks
= $variantfallbacks;
66 global $wgLanguageNames;
67 $this->mVariantNames
= $wgLanguageNames;
68 $this->mCacheKey
= wfMemcKey( 'conversiontables', $maincode );
70 // 'S' show converted text
71 // '+' add rules for alltext
72 // 'E' the gave flags is error
73 // these flags above are reserved for program
74 'A' => 'A', // add rule for convert code (all text convert)
75 'T' => 'T', // title convert
76 'R' => 'R', // raw content
77 'D' => 'D', // convert description (subclass implement)
78 '-' => '-', // remove convert (not implement)
79 'H' => 'H', // add rule for convert code
80 // (but no display in placed code )
81 'N' => 'N' // current variant name
83 $this->mFlags
= array_merge( $f, $flags );
84 foreach ( $this->mVariants
as $v ) {
85 if ( array_key_exists( $v, $manualLevel ) ) {
86 $this->mManualLevel
[$v] = $manualLevel[$v];
88 $this->mManualLevel
[$v] = 'bidirectional';
90 $this->mNamespaceTables
[$v] = array();
91 $this->mFlags
[$v] = $v;
98 function getVariants() {
99 return $this->mVariants
;
103 * In case some variant is not defined in the markup, we need
104 * to have some fallback. For example, in zh, normally people
105 * will define zh-hans and zh-hant, but less so for zh-sg or zh-hk.
106 * when zh-sg is preferred but not defined, we will pick zh-hans
107 * in this case. Right now this is only used by zh.
109 * @param $v String: the language code of the variant
110 * @return string array The code of the fallback language or false if there
113 public function getVariantFallbacks( $v ) {
114 if ( isset( $this->mVariantFallbacks
[$v] ) ) {
115 return $this->mVariantFallbacks
[$v];
117 return $this->mMainLanguageCode
;
121 * Get the title produced by the conversion rule.
124 function getConvRuleTitle() {
125 return $this->mConvRuleTitle
;
129 * Get preferred language variants.
130 * @param $fromUser Boolean: get it from $wgUser's preferences
131 * @param $fromHeader Boolean: get it from Accept-Language
132 * @return String: the preferred language code
134 public function getPreferredVariant( $fromUser = true, $fromHeader = false ) {
135 global $wgDefaultLanguageVariant;
137 $req = $this->getURLVariant();
139 if ( $fromUser && !$req ) {
140 $req = $this->getUserVariant();
143 if ( $fromHeader && !$req ) {
144 $req = $this->getHeaderVariant();
147 if ( $wgDefaultLanguageVariant && !$req ) {
148 $req = $this->validateVariant( $wgDefaultLanguageVariant );
151 // This function, unlike the other get*Variant functions, is
152 // not memoized (i.e. there return value is not cached) since
153 // new information might appear during processing after this
158 return $this->mMainLanguageCode
;
162 * Validate the variant
163 * @param $v String: the variant to validate
164 * @return Mixed: returns the variant if it is valid, null otherwise
166 function validateVariant( $v = null ) {
167 if ( $v !== null && in_array( $v, $this->mVariants
) ) {
174 * Get the variant specified in the URL
176 * @return Mixed: variant if one found, false otherwise.
178 function getURLVariant() {
182 if ( $this->mURLVariant
) {
183 return $this->mURLVariant
;
186 // see if the preference is set in the request
187 $ret = $wgRequest->getText( 'variant' );
190 $ret = $wgRequest->getVal( 'uselang' );
193 return $this->mURLVariant
= $this->validateVariant( $ret );
197 * Determine if the user has a variant set.
199 * @return Mixed: variant if one found, false otherwise.
201 function getUserVariant() {
205 // memoizing this function wreaks havoc on parserTest.php
206 /* if ( $this->mUserVariant ) { */
207 /* return $this->mUserVariant; */
210 // get language variant preference from logged in users
211 // Don't call this on stub objects because that causes infinite
212 // recursion during initialisation
213 if ( $wgUser->isLoggedIn() ) {
214 $ret = $wgUser->getOption( 'variant' );
217 // figure out user lang without constructing wgLang to avoid
218 // infinite recursion
219 $ret = $wgUser->getOption( 'language' );
222 return $this->mUserVariant
= $this->validateVariant( $ret );
227 * Determine the language variant from the Accept-Language header.
229 * @return Mixed: variant if one found, false otherwise.
231 function getHeaderVariant() {
235 if ( $this->mHeaderVariant
) {
236 return $this->mHeaderVariant
;
239 // see if some supported language variant is set in the
242 $acceptLanguage = $wgRequest->getHeader( 'Accept-Language' );
243 if ( !$acceptLanguage ) {
248 $result = StringUtils
::explode( ',', strtolower( $acceptLanguage ) );
249 $languages = array();
251 foreach ( $result as $elem ) {
252 // if $elem likes 'zh-cn;q=0.9'
253 if ( ( $posi = strpos( $elem, ';' ) ) !== false ) {
254 // get the real language code likes 'zh-cn'
255 $languages[] = substr( $elem, 0, $posi );
257 $languages[] = $elem;
261 $fallback_languages = array();
262 foreach ( $languages as $language ) {
264 $language = trim( $language );
265 $this->mHeaderVariant
= $this->validateVariant( $language );
266 if ( $this->mHeaderVariant
) {
270 // To see if there are fallbacks of current language.
271 // We record these fallback variants, and process
273 $fallbacks = $this->getVariantFallbacks( $language );
274 if ( is_string( $fallbacks ) ) {
275 $fallback_languages[] = $fallbacks;
276 } elseif ( is_array( $fallbacks ) ) {
277 $fallback_languages =
278 array_merge( $fallback_languages,
283 if ( !$this->mHeaderVariant
) {
284 // process fallback languages now
285 $fallback_languages = array_unique( $fallback_languages );
286 foreach ( $fallback_languages as $language ) {
287 $this->mHeaderVariant
= $this->validateVariant( $language );
288 if ( $this->mHeaderVariant
) {
294 return $this->mHeaderVariant
;
298 * Caption convert, base on preg_replace_callback.
300 * To convert text in "title" or "alt", like '<img alt="text" ... '
301 * or '<span title="text" ... '
303 * @return String like ' alt="yyyy"' or ' title="yyyy"'
306 function captionConvert( $matches ) {
307 $toVariant = $this->getPreferredVariant();
308 $title = $matches[1];
310 // we convert captions except URL
311 if ( !strpos( $text, '://' ) ) {
312 $text = $this->translate( $text, $toVariant );
314 return " $title=\"$text\"";
318 * Dictionary-based conversion.
320 * @param $text String: the text to be converted
321 * @param $toVariant String: the target language code
322 * @return String: the converted text
325 function autoConvert( $text, $toVariant = false ) {
326 $fname = 'LanguageConverter::autoConvert';
328 wfProfileIn( $fname );
330 if ( !$this->mTablesLoaded
) {
335 $toVariant = $this->getPreferredVariant();
341 /* we convert everything except:
342 1. html markups (anything between < and >)
344 3. place holders created by the parser
347 if ( isset( $wgParser ) && $wgParser->UniqPrefix() != '' ) {
348 $marker = '|' . $wgParser->UniqPrefix() . '[\-a-zA-Z0-9]+';
353 // this one is needed when the text is inside an html markup
354 $htmlfix = '|<[^>]+$|^[^<>]*>';
356 // disable convert to variants between <code></code> tags
357 $codefix = '<code>.+?<\/code>|';
358 // disable convertsion of <script type="text/javascript"> ... </script>
359 $scriptfix = '<script.*?>.*?<\/script>|';
360 // disable conversion of <pre xxxx> ... </pre>
361 $prefix = '<pre.*?>.*?<\/pre>|';
363 $reg = '/' . $codefix . $scriptfix . $prefix .
364 '<[^>]+>|&[a-zA-Z#][a-z0-9]+;' . $marker . $htmlfix . '/s';
366 $matches = preg_split( $reg, $text, - 1, PREG_SPLIT_OFFSET_CAPTURE
);
368 $m = array_shift( $matches );
370 $ret = $this->translate( $m[0], $toVariant );
371 $mstart = $m[1] +
strlen( $m[0] );
373 // enable convertsion of '<img alt="xxxx" ... '
374 // or '<span title="xxxx" ... '
375 $captionpattern = '/\s(title|alt)\s*=\s*"([\s\S]*?)"/';
380 foreach ( $matches as $m ) {
381 $mark = substr( $text, $mstart, $m[1] - $mstart );
382 $mark = preg_replace_callback( $captionpattern,
383 array( &$this, 'captionConvert' ),
385 // Let's convert the trtext only once,
386 // it would give us more performance improvement
388 $trtext .= $m[0] . $trtextmark;
389 $mstart = $m[1] +
strlen( $m[0] );
392 $trtext = $this->translate( $trtext, $toVariant );
393 $trtext = StringUtils
::explode( $trtextmark, $trtext );
394 foreach ( $trtext as $t ) {
395 $ret .= array_shift( $notrtext );
398 wfProfileOut( $fname );
403 * Translate a string to a variant.
404 * Doesn't process markup or do any of that other stuff, for that use
407 * @param $text String: text to convert
408 * @param $variant String: variant language code
409 * @return String: translated text
412 function translate( $text, $variant ) {
413 wfProfileIn( __METHOD__
);
414 // If $text is empty or only includes spaces, do nothing
415 // Otherwise translate it
416 if ( trim( $text ) ) {
417 if ( !$this->mTablesLoaded
) {
420 $text = $this->mTables
[$variant]->replace( $text );
422 wfProfileOut( __METHOD__
);
427 * Convert text to all supported variants.
429 * @param $text String: the text to be converted
430 * @return Array of string
432 public function autoConvertToAllVariants( $text ) {
433 $fname = 'LanguageConverter::autoConvertToAllVariants';
434 wfProfileIn( $fname );
435 if ( !$this->mTablesLoaded
) {
440 foreach ( $this->mVariants
as $variant ) {
441 $ret[$variant] = $this->translate( $text, $variant );
444 wfProfileOut( $fname );
449 * Convert link text to all supported variants.
451 * @param $text String: the text to be converted
452 * @return Array of string
454 public function convertLinkToAllVariants( $text ) {
455 if ( !$this->mTablesLoaded
) {
460 $tarray = StringUtils
::explode( '-{', $text );
463 foreach ( $tarray as $txt ) {
466 foreach ( $this->mVariants
as $variant ) {
467 $ret[$variant] = $this->translate( $txt, $variant );
472 $marked = explode( '}-', $txt, 2 );
474 foreach ( $this->mVariants
as $variant ) {
475 $ret[$variant] .= '-{' . $marked[0] . '}-';
476 if ( array_key_exists( 1, $marked ) ) {
477 $ret[$variant] .= $this->translate( $marked[1], $variant );
487 * Prepare manual conversion table.
490 function applyManualConv( $convRule ) {
491 // use syntax -{T|zh:TitleZh;zh-tw:TitleTw}- for custom
492 // conversion in title
493 $this->mConvRuleTitle
= $convRule->getTitle();
495 // apply manual conversion table to global table
496 $convTable = $convRule->getConvTable();
497 $action = $convRule->getRulesAction();
498 foreach ( $convTable as $variant => $pair ) {
499 if ( !$this->validateVariant( $variant ) ) {
503 if ( $action == 'add' ) {
504 foreach ( $pair as $from => $to ) {
505 // to ensure that $from and $to not be left blank
506 // so $this->translate() could always return a string
507 if ( $from ||
$to ) {
508 // more efficient than array_merge(), about 2.5 times.
509 $this->mTables
[$variant]->setPair( $from, $to );
512 } elseif ( $action == 'remove' ) {
513 $this->mTables
[$variant]->removeArray( $pair );
520 * @param $title String: the title included namespace
521 * @return Array of string
524 function convertNamespace( $title, $variant ) {
525 $splittitle = explode( ':', $title, 2 );
526 if ( count( $splittitle ) < 2 ) {
529 if ( isset( $this->mNamespaceTables
[$variant][$splittitle[0]] ) ) {
530 $splittitle[0] = $this->mNamespaceTables
[$variant][$splittitle[0]];
532 $ret = implode( ':', $splittitle );
537 * Convert text to different variants of a language. The automatic
538 * conversion is done in autoConvert(). Here we parse the text
539 * marked with -{}-, which specifies special conversions of the
540 * text that can not be accomplished in autoConvert().
542 * Syntax of the markup:
543 * -{code1:text1;code2:text2;...}- or
544 * -{flags|code1:text1;code2:text2;...}- or
545 * -{text}- in which case no conversion should take place for text
547 * @param $text String: text to be converted
548 * @return String: converted text
550 public function convert( $text ) {
551 global $wgDisableLangConversion;
552 if ( $wgDisableLangConversion ) return $text;
554 $variant = $this->getPreferredVariant();
556 return $this->recursiveConvertTopLevel( $text, $variant );
559 protected function recursiveConvertTopLevel( $text, $variant, $depth = 0 ) {
562 $length = strlen( $text );
563 while ( $startPos < $length ) {
565 $pos = strpos( $text, '-{', $startPos );
567 if ( $pos === false ) {
568 // No more markup, append final segment
569 $out .= $this->autoConvert( substr( $text, $startPos ), $variant );
575 // Append initial segment
576 $out .= $this->autoConvert( substr( $text, $startPos, $pos - $startPos ), $variant );
581 // Do recursive conversion
582 $out .= $this->recursiveConvertRule( $text, $variant, $startPos, $depth +
1 );
588 protected function recursiveConvertRule( $text, $variant, &$startPos, $depth = 0 ) {
589 // Quick sanity check (no function calls)
590 if ( $text[$startPos] !== '-' ||
$text[$startPos +
1] !== '{' ) {
591 throw new MWException( __METHOD__
.': invalid input string' );
596 $warningDone = false;
597 $length = strlen( $text );
599 while ( $startPos < $length ) {
601 preg_match( '/-\{|\}-/', $text, $m, PREG_OFFSET_CAPTURE
, $startPos );
611 // Append initial segment
612 $inner .= substr( $text, $startPos, $pos - $startPos );
620 if ( $depth >= $this->mMaxDepth
) {
622 if ( !$warningDone ) {
623 $inner .= '<span class="error">' .
624 wfMsgForContent( 'language-converter-depth-warning',
632 // Recursively parse another rule
633 $inner .= $this->recursiveConvertRule( $text, $variant, $startPos, $depth +
1 );
638 $rule = new ConverterRule( $inner, $this );
639 $rule->parse( $variant );
640 $this->applyManualConv( $rule );
641 return $rule->getDisplay();
643 throw new MWException( __METHOD__
.': invalid regex match' );
648 if ( $startPos < $length ) {
649 $inner .= substr( $text, $startPos );
652 return '-{' . $this->autoConvert( $inner, $variant );
656 * If a language supports multiple variants, it is
657 * possible that non-existing link in one variant
658 * actually exists in another variant. This function
659 * tries to find it. See e.g. LanguageZh.php
661 * @param $link String: the name of the link
662 * @param $nt Mixed: the title object of the link
663 * @param $ignoreOtherCond Boolean: to disable other conditions when
664 * we need to transclude a template or update a category's link
665 * @return Null, the input parameters may be modified upon return
667 public function findVariantLink( &$link, &$nt, $ignoreOtherCond = false ) {
668 # If the article has already existed, there is no need to
669 # check it again, otherwise it may cause a fault.
670 if ( is_object( $nt ) && $nt->exists() ) {
674 global $wgDisableLangConversion, $wgDisableTitleConversion, $wgRequest,
676 $isredir = $wgRequest->getText( 'redirect', 'yes' );
677 $action = $wgRequest->getText( 'action' );
678 $linkconvert = $wgRequest->getText( 'linkconvert', 'yes' );
679 $disableLinkConversion = $wgDisableLangConversion
680 ||
$wgDisableTitleConversion;
681 $linkBatch = new LinkBatch();
685 if ( $disableLinkConversion ||
686 ( !$ignoreOtherCond &&
689 ||
$action == 'submit'
690 ||
$linkconvert == 'no'
691 ||
$wgUser->getOption( 'noconvertlink' ) == 1 ) ) ) {
695 if ( is_object( $nt ) ) {
696 $ns = $nt->getNamespace();
699 $variants = $this->autoConvertToAllVariants( $link );
700 if ( $variants == false ) { // give up
706 foreach ( $variants as $v ) {
708 $varnt = Title
::newFromText( $v, $ns );
709 if ( !is_null( $varnt ) ) {
710 $linkBatch->addObj( $varnt );
716 // fetch all variants in single query
717 $linkBatch->execute();
719 foreach ( $titles as $varnt ) {
720 if ( $varnt->getArticleID() > 0 ) {
722 $link = $varnt->getText();
729 * Returns language specific hash options.
731 public function getExtraHashOptions() {
732 $variant = $this->getPreferredVariant();
733 return '!' . $variant ;
737 * Load default conversion tables.
738 * This method must be implemented in derived class.
742 function loadDefaultTables() {
743 $name = get_class( $this );
744 wfDie( "Must implement loadDefaultTables() method in class $name" );
748 * Load conversion tables either from the cache or the disk.
751 function loadTables( $fromcache = true ) {
753 if ( $this->mTablesLoaded
) {
756 wfProfileIn( __METHOD__
);
757 $this->mTablesLoaded
= true;
758 $this->mTables
= false;
760 wfProfileIn( __METHOD__
. '-cache' );
761 $this->mTables
= $wgMemc->get( $this->mCacheKey
);
762 wfProfileOut( __METHOD__
. '-cache' );
765 ||
!array_key_exists( self
::CACHE_VERSION_KEY
, $this->mTables
) ) {
766 wfProfileIn( __METHOD__
. '-recache' );
767 // not in cache, or we need a fresh reload.
768 // we will first load the default tables
769 // then update them using things in MediaWiki:Zhconversiontable/*
770 $this->loadDefaultTables();
771 foreach ( $this->mVariants
as $var ) {
772 $cached = $this->parseCachedTable( $var );
773 $this->mTables
[$var]->mergeArray( $cached );
776 $this->postLoadTables();
777 $this->mTables
[self
::CACHE_VERSION_KEY
] = true;
779 $wgMemc->set( $this->mCacheKey
, $this->mTables
, 43200 );
780 wfProfileOut( __METHOD__
. '-recache' );
782 wfProfileOut( __METHOD__
);
786 * Hook for post processig after conversion tables are loaded.
789 function postLoadTables() { }
792 * Reload the conversion tables.
796 function reloadTables() {
797 if ( $this->mTables
) {
798 unset( $this->mTables
);
800 $this->mTablesLoaded
= false;
801 $this->loadTables( false );
806 * Parse the conversion table stored in the cache.
808 * The tables should be in blocks of the following form:
815 * To make the tables more manageable, subpages are allowed
816 * and will be parsed recursively if $recursive == true.
819 function parseCachedTable( $code, $subpage = '', $recursive = true ) {
820 global $wgMessageCache;
821 static $parsed = array();
823 if ( !is_object( $wgMessageCache ) ) {
827 $key = 'Conversiontable/' . $code;
829 $key .= '/' . $subpage;
831 if ( array_key_exists( $key, $parsed ) ) {
835 if ( strpos( $code, '/' ) === false ) {
836 $txt = $wgMessageCache->get( 'Conversiontable', true, $code );
837 if( $txt === false ){
838 # FIXME: this method doesn't seem to be expecting
839 # this possible outcome...
840 $txt = '<Conversiontable>';
843 $title = Title
::makeTitleSafe( NS_MEDIAWIKI
,
844 "Conversiontable/$code" );
845 if ( $title && $title->exists() ) {
846 $article = new Article( $title );
847 $txt = $article->getContents();
853 // get all subpage links of the form
854 // [[MediaWiki:conversiontable/zh-xx/...|...]]
855 $linkhead = $this->mLangObj
->getNsText( NS_MEDIAWIKI
) .
857 $subs = StringUtils
::explode( '[[', $txt );
859 foreach ( $subs as $sub ) {
860 $link = explode( ']]', $sub, 2 );
861 if ( count( $link ) != 2 ) {
864 $b = explode( '|', $link[0], 2 );
865 $b = explode( '/', trim( $b[0] ), 3 );
866 if ( count( $b ) == 3 ) {
872 if ( $b[0] == $linkhead && $b[1] == $code ) {
873 $sublinks[] = $sublink;
878 // parse the mappings in this page
879 $blocks = StringUtils
::explode( '-{', $txt );
882 foreach ( $blocks as $block ) {
884 // Skip the part before the first -{
888 $mappings = explode( '}-', $block, 2 );
889 $stripped = str_replace( array( "'", '"', '*', '#' ), '',
891 $table = StringUtils
::explode( ';', $stripped );
892 foreach ( $table as $t ) {
893 $m = explode( '=>', $t, 3 );
894 if ( count( $m ) != 2 )
896 // trim any trailling comments starting with '//'
897 $tt = explode( '//', $m[1], 2 );
898 $ret[trim( $m[0] )] = trim( $tt[0] );
901 $parsed[$key] = true;
904 // recursively parse the subpages
906 foreach ( $sublinks as $link ) {
907 $s = $this->parseCachedTable( $code, $link, $recursive );
908 $ret = array_merge( $ret, $s );
912 if ( $this->mUcfirst
) {
913 foreach ( $ret as $k => $v ) {
914 $ret[Language
::ucfirst( $k )] = Language
::ucfirst( $v );
921 * Enclose a string with the "no conversion" tag. This is used by
922 * various functions in the Parser.
924 * @param $text String: text to be tagged for no conversion
925 * @param $noParse Unused (?)
926 * @return String: the tagged text
928 public function markNoConversion( $text, $noParse = false ) {
929 # don't mark if already marked
930 if ( strpos( $text, '-{' ) ||
strpos( $text, '}-' ) ) {
934 $ret = "-{R|$text}-";
939 * Convert the sorting key for category links. This should make different
940 * keys that are variants of each other map to the same key.
942 function convertCategoryKey( $key ) {
947 * Hook to refresh the cache of conversion tables when
948 * MediaWiki:conversiontable* is updated.
951 function OnArticleSaveComplete( $article, $user, $text, $summary, $isminor,
952 $iswatch, $section, $flags, $revision ) {
953 $titleobj = $article->getTitle();
954 if ( $titleobj->getNamespace() == NS_MEDIAWIKI
) {
955 $title = $titleobj->getDBkey();
956 $t = explode( '/', $title, 3 );
958 if ( $c > 1 && $t[0] == 'Conversiontable' ) {
959 if ( $this->validateVariant( $t[1] ) ) {
960 $this->reloadTables();
968 * Armour rendered math against conversion.
969 * Wrap math into rawoutput -{R| math }- syntax.
971 public function armourMath( $text ) {
972 // we need to convert '-{' and '}-' to '-{' and '}-'
973 // to avoid a unwanted '}-' appeared after the math-image.
974 $text = strtr( $text, array( '-{' => '-{', '}-' => '}-' ) );
975 $ret = "-{R|$text}-";
980 * Get the cached separator pattern for ConverterRule::parseRules()
982 function getVarSeparatorPattern() {
983 if ( is_null( $this->mVarSeparatorPattern
) ) {
984 // varsep_pattern for preg_split:
985 // text should be splited by ";" only if a valid variant
986 // name exist after the markup, for example:
987 // -{zh-hans:<span style="font-size:120%;">xxx</span>;zh-hant:\
988 // <span style="font-size:120%;">yyy</span>;}-
989 // we should split it as:
991 // [0] => 'zh-hans:<span style="font-size:120%;">xxx</span>'
992 // [1] => 'zh-hant:<span style="font-size:120%;">yyy</span>'
996 foreach ( $this->mVariants
as $variant ) {
997 // zh-hans:xxx;zh-hant:yyy
998 $pat .= $variant . '\s*:|';
999 // xxx=>zh-hans:yyy; xxx=>zh-hant:zzz
1000 $pat .= '[^;]*?=>\s*' . $variant . '\s*:|';
1003 $this->mVarSeparatorPattern
= $pat;
1005 return $this->mVarSeparatorPattern
;
1010 * Parser for rules of language conversion , parse rules in -{ }- tag.
1012 * @author fdcn <fdcn64@gmail.com>, PhiLiP <philip.npc@gmail.com>
1014 class ConverterRule
{
1015 var $mText; // original text in -{text}-
1016 var $mConverter; // LanguageConverter object
1017 var $mManualCodeError = '<strong class="error">code error!</strong>';
1018 var $mRuleDisplay = '';
1019 var $mRuleTitle = false;
1020 var $mRules = '';// string : the text of the rules
1021 var $mRulesAction = 'none';
1022 var $mFlags = array();
1023 var $mVariantFlags = array();
1024 var $mConvTable = array();
1025 var $mBidtable = array();// array of the translation in each variant
1026 var $mUnidtable = array();// array of the translation in each variant
1031 * @param $text String: the text between -{ and }-
1032 * @param $converter LanguageConverter object
1034 public function __construct( $text, $converter ) {
1035 $this->mText
= $text;
1036 $this->mConverter
= $converter;
1040 * Check if variants array in convert array.
1042 * @param $variants Array or string: variant language code
1043 * @return String: translated text
1045 public function getTextInBidtable( $variants ) {
1046 $variants = (array)$variants;
1050 foreach ( $variants as $variant ) {
1051 if ( isset( $this->mBidtable
[$variant] ) ) {
1052 return $this->mBidtable
[$variant];
1059 * Parse flags with syntax -{FLAG| ... }-
1062 function parseFlags() {
1063 $text = $this->mText
;
1065 $variantFlags = array();
1067 $sepPos = strpos( $text, '|' );
1068 if ( $sepPos !== false ) {
1069 $validFlags = $this->mConverter
->mFlags
;
1070 $f = StringUtils
::explode( ';', substr( $text, 0, $sepPos ) );
1071 foreach ( $f as $ff ) {
1073 if ( isset( $validFlags[$ff] ) ) {
1074 $flags[$validFlags[$ff]] = true;
1077 $text = strval( substr( $text, $sepPos +
1 ) );
1082 } elseif ( isset( $flags['R'] ) ) {
1083 $flags = array( 'R' => true );// remove other flags
1084 } elseif ( isset( $flags['N'] ) ) {
1085 $flags = array( 'N' => true );// remove other flags
1086 } elseif ( isset( $flags['-'] ) ) {
1087 $flags = array( '-' => true );// remove other flags
1088 } elseif ( count( $flags ) == 1 && isset( $flags['T'] ) ) {
1090 } elseif ( isset( $flags['H'] ) ) {
1091 // replace A flag, and remove other flags except T
1092 $temp = array( '+' => true, 'H' => true );
1093 if ( isset( $flags['T'] ) ) {
1096 if ( isset( $flags['D'] ) ) {
1101 if ( isset( $flags['A'] ) ) {
1105 if ( isset( $flags['D'] ) ) {
1106 unset( $flags['S'] );
1108 // try to find flags like "zh-hans", "zh-hant"
1109 // allow syntaxes like "-{zh-hans;zh-hant|XXXX}-"
1110 $variantFlags = array_intersect( array_keys( $flags ), $this->mConverter
->mVariants
);
1111 if ( $variantFlags ) {
1112 $variantFlags = array_flip( $variantFlags );
1116 $this->mVariantFlags
= $variantFlags;
1117 $this->mRules
= $text;
1118 $this->mFlags
= $flags;
1122 * Generate conversion table.
1125 function parseRules() {
1126 $rules = $this->mRules
;
1127 $flags = $this->mFlags
;
1128 $bidtable = array();
1129 $unidtable = array();
1130 $variants = $this->mConverter
->mVariants
;
1131 $varsep_pattern = $this->mConverter
->getVarSeparatorPattern();
1133 $choice = preg_split( $varsep_pattern, $rules );
1135 foreach ( $choice as $c ) {
1136 $v = explode( ':', $c, 2 );
1137 if ( count( $v ) != 2 ) {
1138 // syntax error, skip
1141 $to = trim( $v[1] );
1143 $u = explode( '=>', $v, 2 );
1144 // if $to is empty, strtr() could return a wrong result
1145 if ( count( $u ) == 1 && $to && in_array( $v, $variants ) ) {
1146 $bidtable[$v] = $to;
1147 } elseif ( count( $u ) == 2 ) {
1148 $from = trim( $u[0] );
1150 if ( array_key_exists( $v, $unidtable )
1151 && !is_array( $unidtable[$v] )
1153 && in_array( $v, $variants ) ) {
1154 $unidtable[$v] = array( $from => $to );
1155 } elseif ( $to && in_array( $v, $variants ) ) {
1156 $unidtable[$v][$from] = $to;
1159 // syntax error, pass
1160 if ( !isset( $this->mConverter
->mVariantNames
[$v] ) ) {
1161 $bidtable = array();
1162 $unidtable = array();
1166 $this->mBidtable
= $bidtable;
1167 $this->mUnidtable
= $unidtable;
1173 function getRulesDesc() {
1174 $codesep = $this->mConverter
->mDescCodeSep
;
1175 $varsep = $this->mConverter
->mDescVarSep
;
1177 foreach ( $this->mBidtable
as $k => $v ) {
1178 $text .= $this->mConverter
->mVariantNames
[$k] . "$codesep$v$varsep";
1180 foreach ( $this->mUnidtable
as $k => $a ) {
1181 foreach ( $a as $from => $to ) {
1182 $text .= $from . '⇒' . $this->mConverter
->mVariantNames
[$k] .
1183 "$codesep$to$varsep";
1190 * Parse rules conversion.
1193 function getRuleConvertedStr( $variant ) {
1194 $bidtable = $this->mBidtable
;
1195 $unidtable = $this->mUnidtable
;
1197 if ( count( $bidtable ) +
count( $unidtable ) == 0 ) {
1198 return $this->mRules
;
1200 // display current variant in bidirectional array
1201 $disp = $this->getTextInBidtable( $variant );
1202 // or display current variant in fallbacks
1204 $disp = $this->getTextInBidtable(
1205 $this->mConverter
->getVariantFallbacks( $variant ) );
1207 // or display current variant in unidirectional array
1208 if ( !$disp && array_key_exists( $variant, $unidtable ) ) {
1209 $disp = array_values( $unidtable[$variant] );
1212 // or display frist text under disable manual convert
1214 && $this->mConverter
->mManualLevel
[$variant] == 'disable' ) {
1215 if ( count( $bidtable ) > 0 ) {
1216 $disp = array_values( $bidtable );
1219 $disp = array_values( $unidtable );
1220 $disp = array_values( $disp[0] );
1229 * Generate conversion table for all text.
1232 function generateConvTable() {
1233 // Special case optimisation
1234 if ( !$this->mBidtable
&& !$this->mUnidtable
) {
1235 $this->mConvTable
= array();
1239 $bidtable = $this->mBidtable
;
1240 $unidtable = $this->mUnidtable
;
1241 $manLevel = $this->mConverter
->mManualLevel
;
1244 foreach ( $this->mConverter
->mVariants
as $v ) {
1245 /* for bidirectional array
1246 fill in the missing variants, if any,
1248 if ( !isset( $bidtable[$v] ) ) {
1250 $this->mConverter
->getVariantFallbacks( $v );
1251 $vf = $this->getTextInBidtable( $variantFallbacks );
1253 $bidtable[$v] = $vf;
1257 if ( isset( $bidtable[$v] ) ) {
1258 foreach ( $vmarked as $vo ) {
1259 // use syntax: -{A|zh:WordZh;zh-tw:WordTw}-
1260 // or -{H|zh:WordZh;zh-tw:WordTw}-
1261 // or -{-|zh:WordZh;zh-tw:WordTw}-
1262 // to introduce a custom mapping between
1263 // words WordZh and WordTw in the whole text
1264 if ( $manLevel[$v] == 'bidirectional' ) {
1265 $this->mConvTable
[$v][$bidtable[$vo]] = $bidtable[$v];
1267 if ( $manLevel[$vo] == 'bidirectional' ) {
1268 $this->mConvTable
[$vo][$bidtable[$v]] = $bidtable[$vo];
1273 /*for unidirectional array fill to convert tables */
1274 if ( ( $manLevel[$v] == 'bidirectional' ||
$manLevel[$v] == 'unidirectional' )
1275 && isset( $unidtable[$v] ) )
1277 if ( isset( $this->mConvTable
[$v] ) ) {
1278 $this->mConvTable
[$v] = array_merge( $this->mConvTable
[$v], $unidtable[$v] );
1280 $this->mConvTable
[$v] = $unidtable[$v];
1287 * Parse rules and flags.
1290 function parse( $variant = NULL ) {
1292 $variant = $this->mConverter
->getPreferredVariant();
1295 $variants = $this->mConverter
->mVariants
;
1296 $this->parseFlags();
1297 $flags = $this->mFlags
;
1299 // convert to specified variant
1300 // syntax: -{zh-hans;zh-hant[;...]|<text to convert>}-
1301 if ( $this->mVariantFlags
) {
1302 // check if current variant in flags
1303 if ( isset( $this->mVariantFlags
[$variant] ) ) {
1304 // then convert <text to convert> to current language
1305 $this->mRules
= $this->mConverter
->autoConvert( $this->mRules
,
1307 } else { // if current variant no in flags,
1308 // then we check its fallback variants.
1310 $this->mConverter
->getVariantFallbacks( $variant );
1311 foreach ( $variantFallbacks as $variantFallback ) {
1312 // if current variant's fallback exist in flags
1313 if ( isset( $this->mVariantFlags
[$variantFallback] ) ) {
1314 // then convert <text to convert> to fallback language
1316 $this->mConverter
->autoConvert( $this->mRules
,
1322 $this->mFlags
= $flags = array( 'R' => true );
1325 if ( !isset( $flags['R'] ) && !isset( $flags['N'] ) ) {
1326 // decode => HTML entities modified by Sanitizer::removeHTMLtags
1327 $this->mRules
= str_replace( '=>', '=>', $this->mRules
);
1328 $this->parseRules();
1330 $rules = $this->mRules
;
1332 if ( !$this->mBidtable
&& !$this->mUnidtable
) {
1333 if ( isset( $flags['+'] ) ||
isset( $flags['-'] ) ) {
1334 // fill all variants if text in -{A/H/-|text} without rules
1335 foreach ( $this->mConverter
->mVariants
as $v ) {
1336 $this->mBidtable
[$v] = $rules;
1338 } elseif ( !isset( $flags['N'] ) && !isset( $flags['T'] ) ) {
1339 $this->mFlags
= $flags = array( 'R' => true );
1343 $this->mRuleDisplay
= false;
1344 foreach ( $flags as $flag => $unused ) {
1347 // if we don't do content convert, still strip the -{}- tags
1348 $this->mRuleDisplay
= $rules;
1351 // process N flag: output current variant name
1352 $ruleVar = trim( $rules );
1353 if ( isset( $this->mConverter
->mVariantNames
[$ruleVar] ) ) {
1354 $this->mRuleDisplay
= $this->mConverter
->mVariantNames
[$ruleVar];
1356 $this->mRuleDisplay
= '';
1360 // process D flag: output rules description
1361 $this->mRuleDisplay
= $this->getRulesDesc();
1364 // process H,- flag or T only: output nothing
1365 $this->mRuleDisplay
= '';
1368 $this->mRulesAction
= 'remove';
1369 $this->mRuleDisplay
= '';
1372 $this->mRulesAction
= 'add';
1373 $this->mRuleDisplay
= '';
1376 $this->mRuleDisplay
= $this->getRuleConvertedStr( $variant );
1379 $this->mRuleTitle
= $this->getRuleConvertedStr( $variant );
1380 $this->mRuleDisplay
= '';
1383 // ignore unknown flags (but see error case below)
1386 if ( $this->mRuleDisplay
=== false ) {
1387 $this->mRuleDisplay
= $this->mManualCodeError
;
1390 $this->generateConvTable();
1396 function hasRules() {
1401 * Get display text on markup -{...}-
1404 function getDisplay() {
1405 return $this->mRuleDisplay
;
1409 * Get converted title.
1412 function getTitle() {
1413 return $this->mRuleTitle
;
1417 * Return how deal with conversion rules.
1420 function getRulesAction() {
1421 return $this->mRulesAction
;
1425 * Get conversion table. ( bidirectional and unidirectional
1426 * conversion table )
1429 function getConvTable() {
1430 return $this->mConvTable
;
1434 * Get conversion rules string.
1437 function getRules() {
1438 return $this->mRules
;
1442 * Get conversion flags.
1445 function getFlags() {
1446 return $this->mFlags
;