Bug 6031 (feature request for __NOGALLERY__ on category pages) fixed
[lhc/web/wiklou.git] / includes / MagicWord.php
index 143666a..b5a58c2 100644 (file)
@@ -2,6 +2,7 @@
 /**
  * File for magic words
  * @package MediaWiki
+ * @subpackage Parser
  */
 
 /**
  */
 $wgMagicFound = false;
 
+/** Actual keyword to be used is set in Language.php */
 
-define('MAG_REDIRECT', 0);
-define('MAG_NOTOC', 1);
-define('MAG_START', 2);
-define('MAG_CURRENTMONTH', 3);
-define('MAG_CURRENTMONTHNAME', 4);
-define('MAG_CURRENTDAY', 5);
-define('MAG_CURRENTDAYNAME', 6);
-define('MAG_CURRENTYEAR', 7);
-define('MAG_CURRENTTIME', 8);
-define('MAG_NUMBEROFARTICLES', 9);
-define('MAG_CURRENTMONTHNAMEGEN', 10);
-define('MAG_MSG', 11);
-define('MAG_SUBST', 12);
-define('MAG_MSGNW', 13);
-define('MAG_NOEDITSECTION', 14);
-define('MAG_END', 15);
-define('MAG_IMG_THUMBNAIL',  16);
-define('MAG_IMG_RIGHT',      17);
-define('MAG_IMG_LEFT',       18);
-define('MAG_IMG_NONE',       19);
-define('MAG_IMG_WIDTH',      20);
-define('MAG_IMG_CENTER',      21);
-define('MAG_INT', 22);
-define('MAG_FORCETOC', 23);
-define('MAG_SITENAME', 24);
-define('MAG_NS', 25);
-define('MAG_LOCALURL', 26);
-define('MAG_LOCALURLE', 27);
-define('MAG_SERVER', 28);
-define('MAG_IMG_FRAMED', 29);
-define('MAG_PAGENAME', 30);
-define('MAG_PAGENAMEE', 31);
-define('MAG_NAMESPACE', 32);
-define('MAG_TOC', 33);
-define('MAG_GRAMMAR', 34);
-define('MAG_NOTITLECONVERT', 35);
-define('MAG_NOCONTENTCONVERT', 36);
-define('MAG_CURRENTWEEK', 37);
-define('MAG_CURRENTDOW', 38);
+$magicWords = array(
+       'MAG_REDIRECT',
+       'MAG_NOTOC',
+       'MAG_START',
+       'MAG_CURRENTMONTH',
+       'MAG_CURRENTMONTHNAME',
+       'MAG_CURRENTMONTHNAMEGEN',
+       'MAG_CURRENTMONTHABBREV',
+       'MAG_CURRENTDAY',
+       'MAG_CURRENTDAY2',
+       'MAG_CURRENTDAYNAME',
+       'MAG_CURRENTYEAR',
+       'MAG_CURRENTTIME',
+       'MAG_NUMBEROFARTICLES',
+       'MAG_SUBST',
+       'MAG_MSG',
+       'MAG_MSGNW',
+       'MAG_NOEDITSECTION',
+       'MAG_END',
+       'MAG_IMG_THUMBNAIL',
+       'MAG_IMG_RIGHT',
+       'MAG_IMG_LEFT',
+       'MAG_IMG_NONE',
+       'MAG_IMG_WIDTH',
+       'MAG_IMG_CENTER',
+       'MAG_INT',
+       'MAG_FORCETOC',
+       'MAG_SITENAME',
+       'MAG_NS',
+       'MAG_LOCALURL',
+       'MAG_LOCALURLE',
+       'MAG_SERVER',
+       'MAG_IMG_FRAMED',
+       'MAG_PAGENAME',
+       'MAG_PAGENAMEE',
+       'MAG_NAMESPACE',
+       'MAG_NAMESPACEE',
+       'MAG_TOC',
+       'MAG_GRAMMAR',
+       'MAG_NOTITLECONVERT',
+       'MAG_NOCONTENTCONVERT',
+       'MAG_CURRENTWEEK',
+       'MAG_CURRENTDOW',
+       'MAG_REVISIONID',
+       'MAG_SCRIPTPATH',
+       'MAG_SERVERNAME',
+       'MAG_NUMBEROFFILES',
+       'MAG_IMG_MANUALTHUMB',
+       'MAG_PLURAL',
+       'MAG_FULLURL',
+       'MAG_FULLURLE',
+       'MAG_LCFIRST',
+       'MAG_UCFIRST',
+       'MAG_LC',
+       'MAG_UC',
+       'MAG_FULLPAGENAME',
+       'MAG_FULLPAGENAMEE',
+       'MAG_RAW',
+       'MAG_SUBPAGENAME',
+       'MAG_SUBPAGENAMEE',
+       'MAG_DISPLAYTITLE',
+       'MAG_TALKSPACE',
+       'MAG_TALKSPACEE',
+       'MAG_SUBJECTSPACE',
+       'MAG_SUBJECTSPACEE',
+       'MAG_TALKPAGENAME',
+       'MAG_TALKPAGENAMEE',
+       'MAG_SUBJECTPAGENAME',
+       'MAG_SUBJECTPAGENAMEE', 
+       'MAG_NUMBEROFUSERS',
+       'MAG_RAWSUFFIX',
+       'MAG_NEWSECTIONLINK',
+       'MAG_NUMBEROFPAGES',
+       'MAG_CURRENTVERSION',
+       'MAG_BASEPAGENAME',
+       'MAG_BASEPAGENAMEE',
+       'MAG_URLENCODE',
+       'MAG_CURRENTTIMESTAMP',
+       'MAG_DIRECTIONMARK',
+       'MAG_LANGUAGE',
+       'MAG_CONTENTLANGUAGE',
+       'MAG_PAGESINNAMESPACE',
+       'MAG_NOGALLERY',
+);
+if ( ! defined( 'MEDIAWIKI_INSTALL' ) )
+       wfRunHooks( 'MagicWordMagicWords', array( &$magicWords ) );
+
+for ( $i = 0; $i < count( $magicWords ); ++$i )
+       define( $magicWords[$i], $i );
 
 $wgVariableIDs = array(
        MAG_CURRENTMONTH,
        MAG_CURRENTMONTHNAME,
+       MAG_CURRENTMONTHNAMEGEN,
+       MAG_CURRENTMONTHABBREV,
        MAG_CURRENTDAY,
+       MAG_CURRENTDAY2,
        MAG_CURRENTDAYNAME,
        MAG_CURRENTYEAR,
        MAG_CURRENTTIME,
        MAG_NUMBEROFARTICLES,
-       MAG_CURRENTMONTHNAMEGEN,
+       MAG_NUMBEROFFILES,
        MAG_SITENAME,
        MAG_SERVER,
+       MAG_SERVERNAME,
+       MAG_SCRIPTPATH,
        MAG_PAGENAME,
        MAG_PAGENAMEE,
+       MAG_FULLPAGENAME,
+       MAG_FULLPAGENAMEE,
        MAG_NAMESPACE,
+       MAG_NAMESPACEE,
        MAG_CURRENTWEEK,
-       MAG_CURRENTDOW
+       MAG_CURRENTDOW,
+       MAG_REVISIONID,
+       MAG_SUBPAGENAME,
+       MAG_SUBPAGENAMEE,
+       MAG_DISPLAYTITLE,
+       MAG_TALKSPACE,
+       MAG_TALKSPACEE,
+       MAG_SUBJECTSPACE,
+       MAG_SUBJECTSPACEE,
+       MAG_TALKPAGENAME,
+       MAG_TALKPAGENAMEE,
+       MAG_SUBJECTPAGENAME,
+       MAG_SUBJECTPAGENAMEE,
+       MAG_NUMBEROFUSERS,
+       MAG_RAWSUFFIX,
+       MAG_NEWSECTIONLINK,
+       MAG_NUMBEROFPAGES,
+       MAG_CURRENTVERSION,
+       MAG_BASEPAGENAME,
+       MAG_BASEPAGENAMEE,
+       MAG_URLENCODE,
+       MAG_CURRENTTIMESTAMP,
+       MAG_DIRECTIONMARK,
+       MAG_LANGUAGE,
+       MAG_CONTENTLANGUAGE,
+       MAG_PAGESINNAMESPACE,
 );
+if ( ! defined( 'MEDIAWIKI_INSTALL' ) )
+       wfRunHooks( 'MagicWordwgVariableIDs', array( &$wgVariableIDs ) );
 
 /**
  * This class encapsulates "magic words" such as #redirect, __NOTOC__, etc.
  * Usage:
  *     if (MagicWord::get( MAG_REDIRECT )->match( $text ) )
- * 
- * Possible future improvements: 
+ *
+ * Possible future improvements:
  *   * Simultaneous searching for a number of magic words
  *   * $wgMagicWords in shared memory
  *
- * Please avoid reading the data out of one of these objects and then writing 
+ * Please avoid reading the data out of one of these objects and then writing
  * special case code. If possible, add another match()-like function here.
  *
  * @package MediaWiki
  */
 class MagicWord {
        /**#@+
-        * @access private
+        * @private
         */
        var $mId, $mSynonyms, $mCaseSensitive, $mRegex;
        var $mRegexStart, $mBaseRegex, $mVariableRegex;
-       var $mModified; 
+       var $mModified;
        /**#@-*/
 
        function MagicWord($id = 0, $syn = '', $cs = false) {
@@ -108,9 +195,9 @@ class MagicWord {
         */
        function &get( $id ) {
                global $wgMagicWords;
-               
+
                if ( !is_array( $wgMagicWords ) ) {
-                       wfDebugDieBacktrace( "Incorrect initialisation order, \$wgMagicWords does not exist\n" );
+                       throw new MWException( "Incorrect initialisation order, \$wgMagicWords does not exist\n" );
                }
                if (!array_key_exists( $id, $wgMagicWords ) ) {
                        $mw = new MagicWord();
@@ -119,30 +206,38 @@ class MagicWord {
                }
                return $wgMagicWords[$id];
        }
-       
+
        # Initialises this object with an ID
        function load( $id ) {
-               global $wgContLang;             
+               global $wgContLang;
                $this->mId = $id;
                $wgContLang->getMagic( $this );
        }
-       
+
        /**
         * Preliminary initialisation
         * @private
         */
        function initRegex() {
-               $variableClass = Title::legalChars();
-               $escSyn = array_map( 'preg_quote', $this->mSynonyms );
+               #$variableClass = Title::legalChars();
+               # This was used for matching "$1" variables, but different uses of the feature will have
+               # different restrictions, which should be checked *after* the MagicWord has been matched,
+               # not here. - IMSoP
+               
+               $escSyn = array();
+               foreach ( $this->mSynonyms as $synonym )
+                       // In case a magic word contains /, like that's going to happen;)
+                       $escSyn[] = preg_quote( $synonym, '/' );
                $this->mBaseRegex = implode( '|', $escSyn );
+               
                $case = $this->mCaseSensitive ? '' : 'i';
                $this->mRegex = "/{$this->mBaseRegex}/{$case}";
-               $this->mRegexStart = "/^({$this->mBaseRegex})/{$case}";
-               $this->mVariableRegex = str_replace( "\\$1", "([$variableClass]*?)", $this->mRegex );
-               $this->mVariableStartToEndRegex = str_replace( "\\$1", "([$variableClass]*?)", 
-                       "/^({$this->mBaseRegex})$/{$case}" );
+               $this->mRegexStart = "/^(?:{$this->mBaseRegex})/{$case}";
+               $this->mVariableRegex = str_replace( "\\$1", "(.*?)", $this->mRegex );
+               $this->mVariableStartToEndRegex = str_replace( "\\$1", "(.*?)",
+                       "/^(?:{$this->mBaseRegex})$/{$case}" );
        }
-       
+
        /**
         * Gets a regex representing matching the word
         */
@@ -153,6 +248,18 @@ class MagicWord {
                return $this->mRegex;
        }
 
+       /**
+        * Gets the regexp case modifier to use, i.e. i or nothing, to be used if
+        * one is using MagicWord::getBaseRegex(), otherwise it'll be included in
+        * the complete expression
+        */
+       function getRegexCase() {
+               if ( $this->mRegex === '' )
+                       $this->initRegex();
+
+               return $this->mCaseSensitive ? '' : 'i';
+       }
+
        /**
         * Gets a regex matching the word, if it is at the string start
         */
@@ -172,7 +279,7 @@ class MagicWord {
                }
                return $this->mBaseRegex;
        }
-               
+
        /**
         * Returns true if the text contains the word
         * @return bool
@@ -196,13 +303,17 @@ class MagicWord {
         * is one.
         */
        function matchVariableStartToEnd( $text ) {
+               $matches = array();
                $matchcount = preg_match( $this->getVariableStartToEndRegex(), $text, $matches );
                if ( $matchcount == 0 ) {
                        return NULL;
-               } elseif ( count($matches) == 2 ) {
+               } elseif ( count($matches) == 1 ) {
                        return $matches[0];
                } else {
-                       return $matches[2];
+                       # multiple matched parts (variable match); some will be empty because of synonyms
+                       # the variable will be the second non-empty one so remove any blank elements and re-sort the indices
+                       $matches = array_values(array_filter($matches));
+                       return $matches[1];
                }
        }
 
@@ -223,14 +334,14 @@ class MagicWord {
                $wgMagicFound = false;
                $text = preg_replace_callback( $this->getRegexStart(), 'pregRemoveAndRecord', $text );
                return $wgMagicFound;
-       }               
+       }
 
 
        /**
         * Replaces the word with something else
         */
-       function replace( $replacement, $subject ) {
-               $res = preg_replace( $this->getRegex(), $replacement, $subject );
+       function replace( $replacement, $subject, $limit=-1 ) {
+               $res = preg_replace( $this->getRegex(), wfRegexReplacement( $replacement ), $subject, $limit );
                $this->mModified = !($res === $subject);
                return $res;
        }
@@ -241,7 +352,6 @@ class MagicWord {
         * Input word must contain $1
         */
        function substituteCallback( $text, $callback ) {
-               $regex = $this->getVariableRegex();
                $res = preg_replace_callback( $this->getVariableRegex(), $callback, $text );
                $this->mModified = !($res === $text);
                return $res;
@@ -253,7 +363,7 @@ class MagicWord {
        function getVariableRegex()     {
                if ( $this->mVariableRegex == '' ) {
                        $this->initRegex();
-               } 
+               }
                return $this->mVariableRegex;
        }
 
@@ -263,7 +373,7 @@ class MagicWord {
        function getVariableStartToEndRegex() {
                if ( $this->mVariableStartToEndRegex == '' ) {
                        $this->initRegex();
-               } 
+               }
                return $this->mVariableStartToEndRegex;
        }
 
@@ -275,7 +385,7 @@ class MagicWord {
        }
 
        /**
-        * Returns true if the last call to replace() or substituteCallback() 
+        * Returns true if the last call to replace() or substituteCallback()
         * returned a modified text, otherwise false.
         */
        function getWasModified(){
@@ -287,7 +397,7 @@ class MagicWord {
         * This method uses the php feature to do several replacements at the same time,
         * thereby gaining some efficiency. The result is placed in the out variable
         * $result. The return value is true if something was replaced.
-        * @static 
+        * @static
         **/
        function replaceMultiple( $magicarr, $subject, &$result ){
                $search = array();