]> scripts.mit.edu Git - autoinstallsdev/mediawiki.git/blobdiff - languages/LanguageConverter.php
MediaWiki 1.15.0
[autoinstallsdev/mediawiki.git] / languages / LanguageConverter.php
index 43f33ae68b5207e869e7a09dd2a208a493823423..dcfb8bae137ad283bb8330e31897d2d6b13a37fb 100644 (file)
 <?php
+
 /**
-  * @addtogroup Language
-  *
-  * @author Zhengzhu Feng <zhengzhu@gmail.com>
-  * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License
-  */
+ * Contains the LanguageConverter class and ConverterRule class
+ * @ingroup Language
+ *
+ * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License
+ * @file
+ */
 
+/**
+ * base class for language convert
+ * @ingroup Language
+ *
+ * @author Zhengzhu Feng <zhengzhu@gmail.com>
+ * @maintainers fdcn <fdcn64@gmail.com>, shinjiman <shinjiman@gmail.com>, PhiLiP <philip.npc@gmail.com>
+ */
 class LanguageConverter {
        var $mPreferredVariant='';
        var $mMainLanguageCode;
-       var $mVariants, $mVariantFallbacks;
+       var $mVariants, $mVariantFallbacks, $mVariantNames;
        var $mTablesLoaded = false;
        var $mTables;
+       var $mManualAddTables;
+       var $mManualRemoveTables;
+       var $mNamespaceTables;
        var $mTitleDisplay='';
        var $mDoTitleConvert=true, $mDoContentConvert=true;
+       var $mManualLevel; // 'bidirectional' 'unidirectional' 'disable' for each variants
        var $mTitleFromFlag = false;
        var $mCacheKey;
        var $mLangObj;
        var $mMarkup;
        var $mFlags;
+       var $mDescCodeSep = ':',$mDescVarSep = ';';
        var $mUcfirst = false;
+
+       const CACHE_VERSION_KEY = 'VERSION 6';
+
        /**
-     * Constructor
+        * Constructor
         *
-     * @param string $maincode the main language code of this language
-     * @param array $variants the supported variants of this language
-     * @param array $variantfallback the fallback language of each variant
-     * @param array $markup array defining the markup used for manual conversion
+        * @param string $maincode the main language code of this language
+        * @param array $variants the supported variants of this language
+        * @param array $variantfallback the fallback language of each variant
+        * @param array $markup array defining the markup used for manual conversion
         * @param array $flags array defining the custom strings that maps to the flags
-     * @access public
-     */
+        * @param array $manualLevel limit for supported variants
+        * @public
+        */
        function __construct($langobj, $maincode,
                                                                $variants=array(),
                                                                $variantfallbacks=array(),
                                                                $markup=array(),
-                                                               $flags = array()) {
+                                                               $flags = array(),
+                                                               $manualLevel = array() ) {
                $this->mLangObj = $langobj;
                $this->mMainLanguageCode = $maincode;
                $this->mVariants = $variants;
                $this->mVariantFallbacks = $variantfallbacks;
+               global $wgLanguageNames;
+               $this->mVariantNames = $wgLanguageNames;
                $this->mCacheKey = wfMemcKey( 'conversiontables', $maincode );
-               $m = array('begin'=>'-{', 'flagsep'=>'|', 'codesep'=>':',
-                                  'varsep'=>';', 'end'=>'}-');
+               $m = array(
+                       'begin'=>'-{', 
+                       'flagsep'=>'|',
+                       'unidsep'=>'=>', //for unidirectional conversion
+                       'codesep'=>':',
+                       'varsep'=>';',
+                       'end'=>'}-'
+               );
                $this->mMarkup = array_merge($m, $markup);
-               $f = array('A'=>'A', 'T'=>'T', 'R' => 'R');
+               $f = array( 
+                       // 'S' show converted text
+                       // '+' add rules for alltext
+                       // 'E' the gave flags is error
+                       // these flags above are reserved for program
+                       'A'=>'A',       // add rule for convert code (all text convert)
+                       'T'=>'T',       // title convert
+                       'R'=>'R',       // raw content
+                       'D'=>'D',       // convert description (subclass implement)
+                       '-'=>'-',       // remove convert (not implement)
+                       'H'=>'H',       // add rule for convert code (but no display in placed code )
+                       'N'=>'N'        // current variant name
+               );
                $this->mFlags = array_merge($f, $flags);
+               foreach( $this->mVariants as $v) {
+                       $this->mManualLevel[$v]=array_key_exists($v,$manualLevel)
+                                                               ?$manualLevel[$v]
+                                                               :'bidirectional';
+                       $this->mManualAddTables[$v] = array();
+                       $this->mManualRemoveTables[$v] = array();
+                       $this->mNamespaceTables[$v] = array();
+                       $this->mFlags[$v] = $v;
+               }
        }
 
        /**
-     * @access public
-     */
+        * @public
+        */
        function getVariants() {
                return $this->mVariants;
        }
@@ -57,31 +105,45 @@ class LanguageConverter {
        /**
         * in case some variant is not defined in the markup, we need
         * to have some fallback. for example, in zh, normally people
-        * will define zh-cn and zh-tw, but less so for zh-sg or zh-hk.
-        * when zh-sg is preferred but not defined, we will pick zh-cn
+        * will define zh-hans and zh-hant, but less so for zh-sg or zh-hk.
+        * 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 string $v the language code of the variant
-        * @return string the code of the fallback language or false if there is no fallback
-     * @private
-       */
-       function getVariantFallback($v) {
-               return $this->mVariantFallbacks[$v];
+        * @return string array the code of the fallback language or false if there is no fallback
+        * @public
+        */
+       function getVariantFallbacks($v) {
+               if( isset( $this->mVariantFallbacks[$v] ) ) {
+                       return $this->mVariantFallbacks[$v];
+               }
+               return $this->mMainLanguageCode;
        }
 
-
        /**
         * get preferred language variants.
         * @param boolean $fromUser Get it from $wgUser's preferences
-     * @return string the preferred language code
-     * @access public
-       */
+        * @return string the preferred language code
+        * @public
+        */
        function getPreferredVariant( $fromUser = true ) {
                global $wgUser, $wgRequest, $wgVariantArticlePath, $wgDefaultLanguageVariant;
 
                if($this->mPreferredVariant)
                        return $this->mPreferredVariant;
 
+               // figure out user lang without constructing wgLang to avoid infinite recursion
+               if( $fromUser )
+                       $defaultUserLang = $wgUser->getOption( 'language' );
+               else
+                       $defaultUserLang = $this->mMainLanguageCode;
+               $userLang = $wgRequest->getVal( 'uselang', $defaultUserLang );
+               // see if interface language is same as content, if not, prevent conversion
+               if( ! in_array( $userLang, $this->mVariants ) ){ 
+                       $this->mPreferredVariant = $this->mMainLanguageCode; // no conversion
+                       return $this->mPreferredVariant;
+               }
+
                // see if the preference is set in the request
                $req = $wgRequest->getText( 'variant' );
                if( in_array( $req, $this->mVariants ) ) {
@@ -126,7 +188,8 @@ class LanguageConverter {
                                $header = str_replace( '_', '-', strtolower($_SERVER["HTTP_ACCEPT_LANGUAGE"]));
                                $zh = strstr($header, $pv.'-');
                                if($zh) {
-                                       $pv = substr($zh,0,5);
+                                       $ary = split("[,;]",$zh);
+                                       $pv = $ary[0];
                                }
                        }
                        // don't try to return bad variant
@@ -137,15 +200,34 @@ class LanguageConverter {
                return $this->mMainLanguageCode;
 
        }
+       
+       /**
+        * caption convert, base on preg_replace_callback
+        *
+        * to convert text in "title" or "alt", like '<img alt="text" ... '
+        * or '<span title="text" ... '
+        *
+        * @return string like ' alt="yyyy"' or ' title="yyyy"'
+        * @private
+        */
+       function captionConvert( $matches ) {
+               $toVariant = $this->getPreferredVariant();
+               $title = $matches[1];
+               $text  = $matches[2];
+               // we convert captions except URL
+               if( !strpos( $text, '://' ) )
+                       $text = $this->translate($text, $toVariant);
+               return " $title=\"$text\"";
+       }
 
        /**
-     * dictionary-based conversion
-     *
-     * @param string $text the text to be converted
-     * @param string $toVariant the target language code
-     * @return string the converted text
-     * @private
-     */
+        * dictionary-based conversion
+        *
+        * @param string $text the text to be converted
+        * @param string $toVariant the target language code
+        * @return string the converted text
+        * @private
+        */
        function autoConvert($text, $toVariant=false) {
                $fname="LanguageConverter::autoConvert";
 
@@ -165,9 +247,9 @@ class LanguageConverter {
                   3. place holders created by the parser
                */
                global $wgParser;
-               if (isset($wgParser))
+               if (isset($wgParser) && $wgParser->UniqPrefix()!=''){
                        $marker = '|' . $wgParser->UniqPrefix() . '[\-a-zA-Z0-9]+';
-               else
+               else
                        $marker = "";
 
                // this one is needed when the text is inside an html markup
@@ -177,17 +259,24 @@ class LanguageConverter {
                $codefix = '<code>.+?<\/code>|';
                // disable convertsion of <script type="text/javascript"> ... </script>
                $scriptfix = '<script.*?>.*?<\/script>|';
+               // disable conversion of <pre xxxx> ... </pre>
+               $prefix = '<pre.*?>.*?<\/pre>|';
+
+               $reg = '/'.$codefix . $scriptfix . $prefix . '<[^>]+>|&[a-zA-Z#][a-z0-9]+;' . $marker . $htmlfix . '/s';
 
-               $reg = '/'.$codefix . $scriptfix . '<[^>]+>|&[a-zA-Z#][a-z0-9]+;' . $marker . $htmlfix . '/s';
-       
                $matches = preg_split($reg, $text, -1, PREG_SPLIT_OFFSET_CAPTURE);
 
                $m = array_shift($matches);
 
                $ret = $this->translate($m[0], $toVariant);
                $mstart = $m[1]+strlen($m[0]);
+               
+               // enable convertsion of '<img alt="xxxx" ... ' or '<span title="xxxx" ... '
+               $captionpattern  = '/\s(title|alt)\s*=\s*"([\s\S]*?)"/';
                foreach($matches as $m) {
-                       $ret .= substr($text, $mstart, $m[1]-$mstart);
+                       $mark = substr($text, $mstart, $m[1]-$mstart);
+                       $mark = preg_replace_callback($captionpattern, array(&$this, 'captionConvert'), $mark);
+                       $ret .= $mark;
                        $ret .= $this->translate($m[0], $toVariant);
                        $mstart = $m[1] + strlen($m[0]);
                }
@@ -202,6 +291,7 @@ class LanguageConverter {
         * @param string $text Text to convert
         * @param string $variant Variant language code
         * @return string Translated text
+        * @private
         */
        function translate( $text, $variant ) {
                wfProfileIn( __METHOD__ );
@@ -213,12 +303,12 @@ class LanguageConverter {
        }
 
        /**
-     * convert text to all supported variants
-     *
-     * @param string $text the text to be converted
-     * @return array of string
-     * @public
-     */
+        * convert text to all supported variants
+        *
+        * @param string $text the text to be converted
+        * @return array of string
+        * @public
+        */
        function autoConvertToAllVariants($text) {
                $fname="LanguageConverter::autoConvertToAllVariants";
                wfProfileIn( $fname );
@@ -235,12 +325,12 @@ class LanguageConverter {
        }
 
        /**
-     * convert link text to all supported variants
-     *
-     * @param string $text the text to be converted
-     * @return array of string
-     * @public
-     */
+        * convert link text to all supported variants
+        *
+        * @param string $text the text to be converted
+        * @return array of string
+        * @public
+        */
        function convertLinkToAllVariants($text) {
                if( !$this->mTablesLoaded )
                        $this->loadTables();
@@ -265,10 +355,60 @@ class LanguageConverter {
 
                return $ret;
        }
+       
+       /**
+        * prepare manual conversion table
+        * @private
+        */
+       function prepareManualConv( $convRule ){
+               // use syntax -{T|zh:TitleZh;zh-tw:TitleTw}- for custom conversion in title
+               $title = $convRule->getTitle();
+               if( $title ){
+                       $this->mTitleFromFlag = true;
+                       $this->mTitleDisplay =  $title;
+               }
 
+               //apply manual conversion table to global table
+               $convTable = $convRule->getConvTable();
+               $action = $convRule->getRulesAction();
+               foreach( $convTable as $v => $t ) {
+                       if( !in_array( $v, $this->mVariants ) )continue;
+                       if( $action=="add" ) {
+                               foreach( $t as $from => $to ) {
+                                       // to ensure that $from and $to not be left blank
+                                       // so $this->translate() could always return a string
+                                       if ( $from || $to )
+                                               // more efficient than array_merge(), about 2.5 times.
+                                               $this->mManualAddTables[$v][$from] = $to;
+                               }
+                       }
+                       elseif ( $action == "remove" ) {
+                               foreach ( $t as $from=>$to ) {
+                                       if ( $from || $to )
+                                               $this->mManualRemoveTables[$v][$from] = $to;
+                               }
+                       }
+               }
+       }
+
+       /**
+        * apply manual conversion from $this->mManualAddTables and $this->mManualRemoveTables
+        * @private
+        */
+       function applyManualConv(){
+               //apply manual conversion table to global table
+               foreach($this->mVariants as $v) {
+                       if (count($this->mManualAddTables[$v]) > 0) {
+                               $this->mTables[$v]->mergeArray($this->mManualAddTables[$v]);
+                       }
+                       if (count($this->mManualRemoveTables[$v]) > 0)
+                               $this->mTables[$v]->removeArray($this->mManualRemoveTables[$v]);
+               }
+       }
 
        /**
         * Convert text using a parser object for context
+        * @public
         */
        function parserConvert( $text, &$parser ) {
                global $wgDisableLangConversion;
@@ -279,48 +419,62 @@ class LanguageConverter {
                        return $text;
                }
 
-               if($wgDisableLangConversion)
+               if ( $wgDisableLangConversion )
                        return $text;
 
                $text = $this->convert( $text );
-               $parser->mOutput->setTitleText( $this->mTitleDisplay );
+
+               if ( $this->mTitleFromFlag )
+                       $parser->mOutput->setTitleText( $this->mTitleDisplay );
                return $text;
        }
-
+       
        /**
-        *  Parse flags with syntax -{FLAG| ... }-
-        *
+        * convert namespace
+        * @param string $title the title included namespace
+        * @return array of string
+        * @private
         */
-       function parseFlags($marked){
-                       $flags = array();
-
-                       // process flag only if the flag is valid
-                       if(strlen($marked) < 2 || !(in_array($marked[0],$this->mFlags) && $marked[1]=='|' ) )
-                               return array($marked,array());
+       function convertNamespace( $title, $variant ) {
+               $splittitle = explode( ':', $title );
+               if (count($splittitle) < 2)
+                       return $title;
+               if ( isset( $this->mNamespaceTables[$variant][$splittitle[0]] ) )
+                       $splittitle[0] = $this->mNamespaceTables[$variant][$splittitle[0]];
+               $ret = implode(':', $splittitle );
+               return $ret;
+       }
 
-                       $tt = explode($this->mMarkup['flagsep'], $marked, 2);
+       /**
+        * convert title
+        * @private
+        */
+       function convertTitle( $text, $variant ){
+               global $wgDisableTitleConversion, $wgUser;
 
-                       if(sizeof($tt) == 2) {
-                               $f = explode($this->mMarkup['varsep'], $tt[0]);
-                               foreach($f as $ff) {
-                                       $ff = trim($ff);
-                                       if(array_key_exists($ff, $this->mFlags) &&
-                                               !array_key_exists($this->mFlags[$ff], $flags))
-                                               $flags[] = $this->mFlags[$ff];
-                               }
-                               $rules = $tt[1];
-                       }
-                       else
-                               $rules = $marked;
+               // check for global param and __NOTC__ tag
+               if( $wgDisableTitleConversion || !$this->mDoTitleConvert || $wgUser->getOption('noconvertlink') == 1 ) {
+                       $this->mTitleDisplay = $text;
+                       return $text;
+               }
 
-                       if( !in_array('R',$flags) ){
-                               //FIXME: may cause trouble here...
-                               //strip &nbsp; since it interferes with the parsing, plus,
-                               //all spaces should be stripped in this tag anyway.
-                               $rules = str_replace('&nbsp;', '', $rules);
-                       }
+               // use the title from the T flag if any
+               if( $this->mTitleFromFlag ){
+                       $this->mTitleFromFlag = false;
+                       return $this->mTitleDisplay;
+               }
 
-                       return array($rules,$flags);
+               global $wgRequest;
+               $isredir = $wgRequest->getText( 'redirect', 'yes' );
+               $action = $wgRequest->getText( 'action' );
+               $linkconvert = $wgRequest->getText( 'linkconvert', 'yes' );
+               if ( $isredir == 'no' || $action == 'edit' || $action == 'submit' || $linkconvert == 'no' ) {
+                       return $text;
+               } else {
+                       $text = $this->convertNamespace( $text, $variant );
+                       $this->mTitleDisplay = $this->convert( $text );
+                       return $this->mTitleDisplay;
+               }
        }
 
        /**
@@ -331,168 +485,65 @@ class LanguageConverter {
         *
         * syntax of the markup:
         * -{code1:text1;code2:text2;...}-  or
+        * -{flags|code1:text1;code2:text2;...}-  or
         * -{text}- in which case no conversion should take place for text
-     *
-     * @param string $text text to be converted
-     * @param bool $isTitle whether this conversion is for the article title
-     * @return string converted text
-     * @access public
-     */
-       function convert( $text , $isTitle=false) {
-               $mw =& MagicWord::get( 'notitleconvert'   );
+        *
+        * @param string $text text to be converted
+        * @param bool $isTitle whether this conversion is for the article title
+        * @return string converted text
+        * @public
+        */
+       function convert( $text, $isTitle = false ) {
+
+               $mw =& MagicWord::get( 'notitleconvert' );
                if( $mw->matchAndRemove( $text ) )
                        $this->mDoTitleConvert = false;
-
-               $mw =& MagicWord::get( 'nocontentconvert'   );
+               $mw =& MagicWord::get( 'nocontentconvert' );
                if( $mw->matchAndRemove( $text ) ) {
                        $this->mDoContentConvert = false;
                }
 
                // no conversion if redirecting
-               $mw =& MagicWord::get( 'redirect'   );
-               if( $mw->matchStart( $text ))
+               $mw =& MagicWord::get( 'redirect' );
+               if( $mw->matchStart( $text ) )
                        return $text;
 
-               if( $isTitle ) {
-
-                       // use the title from the T flag if any
-                       if($this->mTitleFromFlag){
-                               $this->mTitleFromFlag = false;
-                               return $this->mTitleDisplay;
-                       }
-
-                       // check for __NOTC__ tag
-                       if( !$this->mDoTitleConvert ) {
-                               $this->mTitleDisplay = $text;
-                               return $text;
-                       }
-
-                       global $wgRequest;
-                       $isredir = $wgRequest->getText( 'redirect', 'yes' );
-                       $action = $wgRequest->getText( 'action' );
-                       if ( $isredir == 'no' || $action == 'edit' ) {
-                               return $text;
-                       }
-                       else {
-                               $this->mTitleDisplay = $this->convert($text);
-                               return $this->mTitleDisplay;
-                       }
-               }
-
                $plang = $this->getPreferredVariant();
-               if( isset( $this->mVariantFallbacks[$plang] ) ) {
-                       $fallback = $this->mVariantFallbacks[$plang];
-               } else {
-                       $fallback = $this->mMainLanguageCode;
-               }
-
-               $tarray = explode($this->mMarkup['begin'], $text);
-               $tfirst = array_shift($tarray);
-               if($this->mDoContentConvert) 
-                       $text = $this->autoConvert($tfirst);
-               else
-                       $text = $tfirst;
-               foreach($tarray as $txt) {      
-                       $marked = explode($this->mMarkup['end'], $txt, 2);
 
-                       // strip the flags from syntax like -{T| ... }-
-                       list($rules,$flags) = $this->parseFlags($marked[0]);
-
-                       // proces R flag: output raw content of -{ ... }-
-                       if( in_array('R',$flags) ){
-                               $disp = $rules;
-                       } else if( $this->mDoContentConvert){
-                               // parse the contents -{ ... }- 
-                               $carray = $this->parseManualRule($rules, $flags);
-
-                               $disp = '';
-                               if(array_key_exists($plang, $carray)) {
-                                       $disp = $carray[$plang];
-                               } else if(array_key_exists($fallback, $carray)) {
-                                       $disp = $carray[$fallback];
-                               }
-                       } else{
-                               // if we don't do content convert, still strip the -{}- tags
-                               $disp = $rules;
-                               $flags = array();
-                       }
+               // for title convertion
+               if ( $isTitle ) return $this->convertTitle( $text, $plang );
 
-                       if($disp) {
-                               // use syntax -{T|zh:TitleZh;zh-tw:TitleTw}- for custom conversion in title
-                               if(in_array('T',  $flags)){
-                                       $this->mTitleFromFlag = true;
-                                       $this->mTitleDisplay = $disp;
-                               }
-                               else
-                                       $text .= $disp;
-
-                               // use syntax -{A|zh:WordZh;zh-tw:WordTw}- to introduce a custom mapping between
-                               // words WordZh and WordTw in the whole text 
-                               if(in_array('A', $flags)) {
-
-                                       /* fill in the missing variants, if any,
-                                           with fallbacks */
-                                       foreach($this->mVariants as $v) {
-                                               if(!array_key_exists($v, $carray)) {
-                                                       $vf = $this->getVariantFallback($v);
-                                                       if(array_key_exists($vf, $carray))
-                                                               $carray[$v] = $carray[$vf];
-                                               }
-                                       }
+               $tarray = StringUtils::explode( $this->mMarkup['end'], $text );
+               $text = '';
 
-                                       foreach($this->mVariants as $vfrom) {
-                                               if(!array_key_exists($vfrom, $carray))
-                                                       continue;
-                                               foreach($this->mVariants as $vto) {
-                                                       if($vfrom == $vto)
-                                                               continue;
-                                                       if(!array_key_exists($vto, $carray))
-                                                               continue;
-                                                       $this->mTables[$vto]->setPair($carray[$vfrom], $carray[$vto]);
-                                               }
-                                       }
-                               }
+               $marks = array();
+               foreach ( $tarray as $txt ) {
+                       $marked = explode( $this->mMarkup['begin'], $txt, 2 );
+                       if ( array_key_exists( 1, $marked ) ) {
+                               $crule = new ConverterRule($marked[1], $this);
+                               $crule->parse( $plang );
+                               $marked[1] = $crule->getDisplay();
+                               $this->prepareManualConv( $crule );
                        }
-                       else {
+                       else
+                               $marked[0] .= $this->mMarkup['end'];
+                       array_push( $marks, $marked );
+               }
+               $this->applyManualConv();
+               foreach ( $marks as $marked ) {
+                       if( $this->mDoContentConvert )
+                               $text .= $this->autoConvert( $marked[0], $plang );
+                       else
                                $text .= $marked[0];
-                       }
-                       if(array_key_exists(1, $marked)){
-                               if( $this->mDoContentConvert )
-                                       $text .= $this->autoConvert($marked[1]);
-                               else
-                                       $text .= $marked[1];
-                       }
+                       if( array_key_exists( 1, $marked ) )
+                               $text .= $marked[1];
                }
+               // Remove the last delimiter (wasn't real)
+               $text = substr( $text, 0, -strlen( $this->mMarkup['end'] ) );
 
                return $text;
        }
 
-       /**
-        * parse the manually marked conversion rule
-        * @param string $rule the text of the rule
-        * @return array of the translation in each variant
-        * @private
-        */
-       function parseManualRule($rules, $flags=array()) {
-
-               $choice = explode($this->mMarkup['varsep'], $rules);
-               $carray = array();
-               if(sizeof($choice) == 1) {
-                       /* a single choice */
-                       foreach($this->mVariants as $v)
-                               $carray[$v] = $choice[0];
-               }
-               else {
-                       foreach($choice as $c) {
-                               $v = explode($this->mMarkup['codesep'], $c);
-                               if(sizeof($v) != 2) // syntax error, skip
-                                       continue;
-                               $carray[trim($v[0])] = trim($v[1]);
-                       }
-               }
-               return $carray;
-       }
-
        /**
         * if a language supports multiple variants, it is
         * possible that non-existing link in one variant
@@ -501,15 +552,25 @@ class LanguageConverter {
         *
         * @param string $link the name of the link
         * @param mixed $nt the title object of the link
+        * @param boolean $ignoreOtherCond: to disable other conditions when
+        *      we need to transclude a template or update a category's link
         * @return null the input parameters may be modified upon return
-     * @access public
+        * @public
         */
-       function findVariantLink( &$link, &$nt ) {
-               global $wgDisableLangConversion;
+       function findVariantLink( &$link, &$nt, $ignoreOtherCond = false ) {
+               global $wgDisableLangConversion, $wgDisableTitleConversion, $wgRequest, $wgUser;
+               $isredir = $wgRequest->getText( 'redirect', 'yes' );
+               $action = $wgRequest->getText( 'action' );
+               $linkconvert = $wgRequest->getText( 'linkconvert', 'yes' );
+               $disableLinkConversion = $wgDisableLangConversion || $wgDisableTitleConversion;
                $linkBatch = new LinkBatch();
 
                $ns=NS_MAIN;
 
+               if ( $disableLinkConversion || ( !$ignoreOtherCond && ( $isredir == 'no' || $action == 'edit'
+                       || $action == 'submit' || $linkconvert == 'no' || $wgUser->getOption('noconvertlink') == 1 ) ) )
+                       return;
+
                if(is_object($nt))
                        $ns = $nt->getNamespace();
 
@@ -535,37 +596,36 @@ class LanguageConverter {
                foreach( $titles as $varnt ) {
                        if( $varnt->getArticleID() > 0 ) {
                                $nt = $varnt;
-                               if( !$wgDisableLangConversion )
-                                       $link = $v;
+                               $link = $varnt->getText();
                                break;
                        }
                }
        }
 
     /**
-     * returns language specific hash options
-     *
-     * @access public
-     */
+        * returns language specific hash options
+        *
+        * @public
+        */
        function getExtraHashOptions() {
                $variant = $this->getPreferredVariant();
                return '!' . $variant ;
        }
 
     /**
-     * get title text as defined in the body of the article text
-     *
-     * @access public
-     */
+        * get title text as defined in the body of the article text
+        *
+        * @public
+        */
        function getParsedTitle() {
                return $this->mTitleDisplay;
        }
 
        /**
-     * a write lock to the cache
-     *
-     * @private
-     */
+        * a write lock to the cache
+        *
+        * @private
+        */
        function lockCache() {
                global $wgMemc;
                $success = false;
@@ -578,10 +638,10 @@ class LanguageConverter {
        }
 
        /**
-     * unlock cache
-     *
-     * @private
-     */
+        * unlock cache
+        *
+        * @private
+        */
        function unlockCache() {
                global $wgMemc;
                $wgMemc->delete($this->mCacheKey . "lock");
@@ -589,20 +649,20 @@ class LanguageConverter {
 
 
        /**
-     * Load default conversion tables
-     * This method must be implemented in derived class
-     *
-     * @private
-     */
+        * Load default conversion tables
+        * This method must be implemented in derived class
+        *
+        * @private
+        */
        function loadDefaultTables() {
                $name = get_class($this);
                wfDie("Must implement loadDefaultTables() method in class $name");
        }
 
        /**
-     * load conversion tables either from the cache or the disk
-     * @private
-     */
+        * load conversion tables either from the cache or the disk
+        * @private
+        */
        function loadTables($fromcache=true) {
                global $wgMemc;
                if( $this->mTablesLoaded )
@@ -615,7 +675,7 @@ class LanguageConverter {
                        $this->mTables = $wgMemc->get( $this->mCacheKey );
                        wfProfileOut( __METHOD__.'-cache' );
                }
-               if ( !$this->mTables || !isset( $this->mTables['VERSION 2'] ) ) {
+               if ( !$this->mTables || !isset( $this->mTables[self::CACHE_VERSION_KEY] ) ) {
                        wfProfileIn( __METHOD__.'-recache' );
                        // not in cache, or we need a fresh reload.
                        // we will first load the default tables
@@ -627,7 +687,7 @@ class LanguageConverter {
                        }
 
                        $this->postLoadTables();
-                       $this->mTables['VERSION 2'] = true;
+                       $this->mTables[self::CACHE_VERSION_KEY] = true;
 
                        if($this->lockCache()) {
                                $wgMemc->set($this->mCacheKey, $this->mTables, 43200);
@@ -639,16 +699,16 @@ class LanguageConverter {
        }
 
     /**
-     * Hook for post processig after conversion tables are loaded
-     *
-     */
+        * Hook for post processig after conversion tables are loaded
+        *
+        */
        function postLoadTables() {}
 
     /**
-     * Reload the conversion tables
-     *
-     * @private
-     */
+        * Reload the conversion tables
+        *
+        * @private
+        */
        function reloadTables() {
                if($this->mTables)
                        unset($this->mTables);
@@ -658,20 +718,18 @@ class LanguageConverter {
 
 
        /**
-     * parse the conversion table stored in the cache
-     *
-     * the tables should be in blocks of the following form:
-
-     *         -{
-     *                 word => word ;
-     *                 word => word ;
-     *                 ...
-     *         }-
-     *
-     * to make the tables more manageable, subpages are allowed
-     * and will be parsed recursively if $recursive=true
-     *
-     * @private
+        * parse the conversion table stored in the cache
+        *
+        * the tables should be in blocks of the following form:
+        *              -{
+        *                      word => word ;
+        *                      word => word ;
+        *                      ...
+        *              }-
+        *
+        *      to make the tables more manageable, subpages are allowed
+        *      and will be parsed recursively if $recursive=true
+        *
         */
        function parseCachedTable($code, $subpage='', $recursive=true) {
                global $wgMessageCache;
@@ -687,8 +745,17 @@ class LanguageConverter {
                if(array_key_exists($key, $parsed))
                        return array();
 
-
-               $txt = $wgMessageCache->get( $key, true, true, true );
+               if ( strpos( $code, '/' ) === false ) {
+                       $txt = $wgMessageCache->get( 'Conversiontable', true, $code );
+               } else {
+                       $title = Title::makeTitleSafe( NS_MEDIAWIKI, "Conversiontable/$code" );
+                       if ( $title && $title->exists() ) {
+                               $article = new Article( $title );
+                               $txt = $article->getContents();
+                       } else {
+                               $txt = '';
+                       }
+               }
 
                // get all subpage links of the form
                // [[MediaWiki:conversiontable/zh-xx/...|...]]
@@ -754,37 +821,33 @@ class LanguageConverter {
         *
         * @param string $text text to be tagged for no conversion
         * @return string the tagged text
-       */
+        * @public
+        */
        function markNoConversion($text, $noParse=false) {
                # don't mark if already marked
                if(strpos($text, $this->mMarkup['begin']) ||
                   strpos($text, $this->mMarkup['end']))
                        return $text;
 
-               $ret = $this->mMarkup['begin'] . $text . $this->mMarkup['end'];
+               $ret = $this->mMarkup['begin'] .'R|'. $text . $this->mMarkup['end'];
                return $ret;
        }
 
        /**
         * convert the sorting key for category links. this should make different
         * keys that are variants of each other map to the same key
-       */
+        */
        function convertCategoryKey( $key ) {
                return $key;
        }
        /**
-     * hook to refresh the cache of conversion tables when
-     * MediaWiki:conversiontable* is updated
-     * @private
-       */
+        * hook to refresh the cache of conversion tables when
+        * MediaWiki:conversiontable* is updated
+        * @private
+        */
        function OnArticleSaveComplete($article, $user, $text, $summary, $isminor, $iswatch, $section, $flags, $revision) {
                $titleobj = $article->getTitle();
                if($titleobj->getNamespace() == NS_MEDIAWIKI) {
-            /*
-                       global $wgContLang; // should be an LanguageZh.
-                       if(get_class($wgContLang) != 'languagezh')
-                               return true;
-            */
                        $title = $titleobj->getDBkey();
                        $t = explode('/', $title, 3);
                        $c = count($t);
@@ -800,13 +863,429 @@ class LanguageConverter {
        /** 
         * Armour rendered math against conversion
         * Wrap math into rawoutput -{R| math }- syntax
+        * @public
         */
        function armourMath($text){ 
                $ret = $this->mMarkup['begin'] . 'R|' . $text . $this->mMarkup['end'];
                return $ret;
        }
+}
 
+/**
+ * parser for rules of language conversion , parse rules in -{ }- tag
+ * @ingroup Language
+ * @author fdcn <fdcn64@gmail.com>, PhiLiP <philip.npc@gmail.com>
+ */
+class ConverterRule {
+       var $mText; // original text in -{text}-
+       var $mConverter; // LanguageConverter object 
+       var $mManualCodeError='<strong class="error">code error!</strong>';
+       var $mRuleDisplay = '',$mRuleTitle=false;
+       var $mRules = '';// string : the text of the rules
+       var $mRulesAction = 'none';
+       var $mFlags = array();
+       var $mConvTable = array();
+       var $mBidtable = array();// array of the translation in each variant
+       var $mUnidtable = array();// array of the translation in each variant
 
-}
+       /**
+        * Constructor
+        *
+        * @param string $text the text between -{ and }-
+        * @param object $converter a  LanguageConverter object 
+        * @access public
+        */
+       function __construct($text,$converter){
+               $this->mText = $text;
+               $this->mConverter=$converter;
+               foreach($converter->mVariants as $v){
+                       $this->mConvTable[$v]=array();
+               }
+       }
+
+       /**
+        * check if variants array in convert array
+        *
+        * @param string $variant Variant language code
+        * @return string Translated text
+        * @public
+        */
+       function getTextInBidtable($variants){
+               if(is_string($variants)){ $variants=array($variants); }
+               if(!is_array($variants)) return false;
+               foreach ($variants as $variant){
+                       if(array_key_exists($variant, $this->mBidtable)){
+                               return $this->mBidtable[$variant];
+                       }
+               }
+               return false;
+       }
+       
+       /**
+        * Parse flags with syntax -{FLAG| ... }-
+        * @private
+        */
+       function parseFlags(){
+               $text = $this->mText;
+               if(strlen($text) < 2 ) {
+                       $this->mFlags = array( 'R' );
+                       $this->mRules = $text;
+                       return;
+               }
 
+               $flags = array();
+               $markup = $this->mConverter->mMarkup;
+               $validFlags = $this->mConverter->mFlags;
+               $variants = $this->mConverter->mVariants;
+
+               $tt = explode($markup['flagsep'], $text, 2);
+               if(count($tt) == 2) {
+                       $f = explode($markup['varsep'], $tt[0]);
+                       foreach($f as $ff) {
+                               $ff = trim($ff);
+                               if(array_key_exists($ff, $validFlags) &&
+                                                       !in_array($validFlags[$ff], $flags))
+                                       $flags[] = $validFlags[$ff];
+                       }
+                       $rules = $tt[1];
+               } else {
+                       $rules = $text;
+               }
 
+               //check flags
+               if( in_array('R',$flags) ){
+                       $flags = array('R');// remove other flags
+               } elseif ( in_array('N',$flags) ){
+                       $flags = array('N');// remove other flags
+               } elseif ( in_array('-',$flags) ){
+                       $flags = array('-');// remove other flags
+               } elseif (count($flags)==1 && $flags[0]=='T'){
+                       $flags[]='H'; 
+               } elseif ( in_array('H',$flags) ){
+                       // replace A flag, and remove other flags except T
+                       $temp=array('+','H');
+                       if(in_array('T',$flags)) $temp[] = 'T';
+                       if(in_array('D',$flags)) $temp[] = 'D';
+                       $flags = $temp;
+               } else {
+                       if ( in_array('A',$flags) ) {
+                               $flags[]='+';
+                               $flags[]='S';
+                       }
+                       if ( in_array('D',$flags) )
+                               $flags=array_diff($flags,array('S'));
+                       $flags_temp = array();
+                       foreach ($variants as $variant) {
+                               // try to find flags like "zh-hans", "zh-hant"
+                               // allow syntaxes like "-{zh-hans;zh-hant|XXXX}-"
+                               if ( in_array($variant, $flags) )
+                                       $flags_temp[] = $variant;
+                       }
+                       if ( count($flags_temp) !== 0 )
+                               $flags = $flags_temp;
+               }
+               if ( count($flags) == 0 )
+                       $flags = array('S');
+               $this->mRules=$rules;
+               $this->mFlags=$flags;
+       }
+       
+       /**
+        * generate conversion table
+        * @private
+        */
+       function parseRules() {
+               $rules = $this->mRules;
+               $flags = $this->mFlags;
+               $bidtable = array();
+               $unidtable = array();
+               $markup = $this->mConverter->mMarkup;
+               $variants = $this->mConverter->mVariants;
+
+               // varsep_pattern for preg_split:
+               // 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>;}-
+               // we should split it as:
+               //  array(
+               //        [0] => 'zh-hans:<span style="font-size:120%;">xxx</span>'
+               //        [1] => 'zh-hant:<span style="font-size:120%;">yyy</span>'
+               //        [2] => ''
+               //       )
+               $varsep_pattern = '/' . $markup['varsep'] . '\s*' . '(?=';
+               foreach( $variants as $variant ) {
+                       $varsep_pattern .= $variant . '\s*' . $markup['codesep'] . '|'; // zh-hans:xxx;zh-hant:yyy
+                       $varsep_pattern .= '[^;]*?' . $markup['unidsep'] . '\s*' . $variant
+                                                       . '\s*' . $markup['codesep'] . '|'; // xxx=>zh-hans:yyy; xxx=>zh-hant:zzz
+               }
+               $varsep_pattern .= '\s*$)/';
+
+               $choice = preg_split($varsep_pattern, $rules);
+
+               foreach( $choice as $c ) {
+                       $v  = explode($markup['codesep'], $c, 2);
+                       if( count($v) != 2 ) 
+                               continue;// syntax error, skip
+                       $to = trim($v[1]);
+                       $v  = trim($v[0]);
+                       $u  = explode($markup['unidsep'], $v);
+                       // if $to is empty, strtr() could return a wrong result
+                       if( count($u) == 1 && $to && in_array( $v, $variants ) ) {
+                               $bidtable[$v] = $to;
+                       } else if(count($u) == 2){
+                               $from = trim($u[0]);
+                               $v    = trim($u[1]);
+                               if( array_key_exists( $v, $unidtable ) && !is_array( $unidtable[$v] )
+                                       && $to && in_array( $v, $variants ) )
+                                       $unidtable[$v] = array( $from=>$to );
+                               elseif ( $to && in_array( $v, $variants ) )
+                                       $unidtable[$v][$from] = $to;
+                       }
+                       // syntax error, pass
+                       if ( !array_key_exists( $v, $this->mConverter->mVariantNames ) ){
+                               $bidtable = array();
+                               $unidtable = array();
+                               break;
+                       }
+               }
+               $this->mBidtable = $bidtable;
+               $this->mUnidtable = $unidtable;
+       }
+
+       /**
+        * @private
+        */
+       function getRulesDesc(){
+               $codesep = $this->mConverter->mDescCodeSep;
+               $varsep = $this->mConverter->mDescVarSep;
+               $text='';
+               foreach($this->mBidtable as $k => $v)
+                       $text .= $this->mConverter->mVariantNames[$k]."$codesep$v$varsep";
+               foreach($this->mUnidtable as $k => $a)
+                       foreach($a as $from=>$to)
+                               $text.=$from.'⇒'.$this->mConverter->mVariantNames[$k]."$codesep$to$varsep";
+               return $text;
+       }
+
+       /**
+        *  Parse rules conversion
+        * @private
+        */
+       function getRuleConvertedStr($variant,$doConvert){
+               $bidtable = $this->mBidtable;
+               $unidtable = $this->mUnidtable;
+
+               if( count($bidtable) + count($unidtable) == 0 ){
+                       return $this->mRules;
+               } elseif ($doConvert){// the text converted 
+                       // display current variant in bidirectional array
+                       $disp = $this->getTextInBidtable($variant);
+                       // or display current variant in fallbacks
+                       if(!$disp)
+                               $disp = $this->getTextInBidtable(
+                                               $this->mConverter->getVariantFallbacks($variant));
+                       // or display current variant in unidirectional array
+                       if(!$disp && array_key_exists($variant,$unidtable)){
+                               $disp = array_values($unidtable[$variant]);
+                               $disp = $disp[0];
+                       }
+                       // or display frist text under disable manual convert
+                       if(!$disp && $this->mConverter->mManualLevel[$variant]=='disable') {
+                               if(count($bidtable)>0){
+                                       $disp = array_values($bidtable);
+                                       $disp = $disp[0];
+                               } else {
+                                       $disp = array_values($unidtable);
+                                       $disp = array_values($disp[0]);
+                                       $disp = $disp[0];
+                               }
+                       }
+                       return $disp;
+               } else {// no convert
+                       return $this->mRules;
+               }
+       }
+
+       /**
+        * generate conversion table for all text
+        * @private
+        */
+       function generateConvTable(){
+               $flags = $this->mFlags;
+               $bidtable = $this->mBidtable;
+               $unidtable = $this->mUnidtable;
+               $manLevel = $this->mConverter->mManualLevel;
+
+               $vmarked=array();
+               foreach($this->mConverter->mVariants as $v) {
+                       /* for bidirectional array
+                               fill in the missing variants, if any,
+                               with fallbacks */
+                       if(!array_key_exists($v, $bidtable)) {
+                               $variantFallbacks = $this->mConverter->getVariantFallbacks($v);
+                               $vf = $this->getTextInBidtable($variantFallbacks);
+                               if($vf) $bidtable[$v] = $vf;
+                       }
+
+                       if(array_key_exists($v,$bidtable)){
+                               foreach($vmarked as $vo){
+                                       // use syntax: -{A|zh:WordZh;zh-tw:WordTw}- 
+                                       // or -{H|zh:WordZh;zh-tw:WordTw}- or -{-|zh:WordZh;zh-tw:WordTw}-
+                                       // to introduce a custom mapping between
+                                       // words WordZh and WordTw in the whole text 
+                                       if($manLevel[$v]=='bidirectional'){
+                                               $this->mConvTable[$v][$bidtable[$vo]]=$bidtable[$v];
+                                       }
+                                       if($manLevel[$vo]=='bidirectional'){
+                                               $this->mConvTable[$vo][$bidtable[$v]]=$bidtable[$vo];
+                                       }
+                               }
+                               $vmarked[]=$v;
+                       }
+                       /*for unidirectional array
+                               fill to convert tables */
+                       $allow_unid = $manLevel[$v]=='bidirectional' 
+                                       || $manLevel[$v]=='unidirectional';
+                       if($allow_unid && array_key_exists($v,$unidtable)){
+                               $ct=$this->mConvTable[$v];
+                               $this->mConvTable[$v] = array_merge($ct,$unidtable[$v]);
+                       }
+               }
+       }
+
+       /**
+        * Parse rules and flags
+        * @public
+        */
+       function parse($variant){
+               if(!$variant)
+                       $variant = $this->mConverter->getPreferredVariant();
+
+               $variants = $this->mConverter->mVariants;
+               $this->parseFlags();
+               $flags = $this->mFlags;
+
+               // convert to specified variant
+               // syntax: -{zh-hans;zh-hant[;...]|<text to convert>}-
+               if( count( array_diff( $flags, $variants ) ) == 0 and count( $flags ) != 0 ) {
+                       if ( in_array( $variant, $flags ) ) // check if current variant in flags
+                               // then convert <text to convert> to current language
+                               $this->mRules = $this->mConverter->autoConvert( $this->mRules, $variant );
+                       else { // if current variant no in flags,
+                                  // then we check its fallback variants.
+                               $variantFallbacks = $this->mConverter->getVariantFallbacks($variant);
+                               foreach ( $variantFallbacks as $variantFallback ) {
+                                       // if current variant's fallback exist in flags
+                                       if ( in_array( $variantFallback, $flags ) ) {
+                                               // then convert <text to convert> to fallback language
+                                               $this->mRules = $this->mConverter->autoConvert( $this->mRules, $variantFallback );
+                                               break;
+                                       }
+                               }
+                       }
+                       $this->mFlags = $flags = array('R');
+               }
+
+               if( !in_array( 'R', $flags ) || !in_array( 'N', $flags ) ) {
+                       // decode => HTML entities modified by Sanitizer::removeHTMLtags 
+                       $this->mRules = str_replace('=&gt;','=>',$this->mRules);
+
+                       $this->parseRules();
+               }
+               $rules = $this->mRules;
+
+               if( count( $this->mBidtable ) == 0 && count( $this->mUnidtable ) == 0 ){
+                       if(in_array('+',$flags) || in_array('-',$flags))
+                               // fill all variants if text in -{A/H/-|text} without rules
+                               foreach($this->mConverter->mVariants as $v)
+                                       $this->mBidtable[$v] = $rules;
+                       elseif (!in_array('N',$flags) && !in_array('T',$flags) )
+                               $this->mFlags = $flags = array('R');
+               }
+
+               if( in_array('R',$flags) ) {
+                       // if we don't do content convert, still strip the -{}- tags
+                       $this->mRuleDisplay = $rules;
+               } elseif ( in_array('N',$flags) ){
+                       // proces N flag: output current variant name
+                       $this->mRuleDisplay = $this->mConverter->mVariantNames[trim($rules)];
+               } elseif ( in_array('D',$flags) ){
+                       // proces D flag: output rules description
+                       $this->mRuleDisplay = $this->getRulesDesc();
+               } elseif ( in_array('H',$flags) || in_array('-',$flags) ) {
+                       // proces H,- flag or T only: output nothing
+                       $this->mRuleDisplay = '';
+               } elseif ( in_array('S',$flags) ){
+                       $this->mRuleDisplay = $this->getRuleConvertedStr($variant,
+                                                       $this->mConverter->mDoContentConvert);
+               } else {
+                       $this->mRuleDisplay= $this->mManualCodeError;
+               }
+               // proces T flag
+               if ( in_array('T',$flags) ) {
+                       $this->mRuleTitle = $this->getRuleConvertedStr($variant,
+                                                       $this->mConverter->mDoTitleConvert);
+               }
+
+               if (in_array('-', $flags))
+                       $this->mRulesAction='remove';
+               if (in_array('+', $flags))
+                       $this->mRulesAction='add';
+               
+               $this->generateConvTable();
+       }
+       
+       /**
+        * @public
+        */
+       function hasRules(){
+               // TODO:
+       }
+
+       /**
+        * get display text on markup -{...}-
+        * @public
+        */
+       function getDisplay(){
+               return $this->mRuleDisplay;
+       }
+       /**
+        * get converted title
+        * @public
+        */
+       function getTitle(){
+               return $this->mRuleTitle;
+       }
+
+       /**
+        * return how deal with conversion rules
+        * @public
+        */
+       function getRulesAction(){
+               return $this->mRulesAction;
+       }
+
+       /**
+        * get conversion table ( bidirectional and unidirectional conversion table )
+        * @public
+        */
+       function getConvTable(){
+               return $this->mConvTable;
+       }
+
+       /**
+        * get conversion rules string
+        * @public
+        */
+       function getRules(){
+               return $this->mRules;
+       }
+
+       /**
+        * get conversion flags
+        * @public
+        */
+       function getFlags(){
+               return $this->mFlags;
+       }
+}