Implemented param tracking for hook users, feels a bit hackish
[lhc/web/wiklou.git] / includes / MagicWord.php
index f159937..d30f7cc 100644 (file)
@@ -1,6 +1,7 @@
 <?php
 /**
  * File for magic words
+ *
  * See docs/magicword.txt
  *
  * @file
@@ -29,9 +30,13 @@ class MagicWord {
        /**#@+
         * @private
         */
-       var $mId, $mSynonyms, $mCaseSensitive, $mRegex;
-       var $mRegexStart, $mBaseRegex, $mVariableRegex;
-       var $mModified, $mFound;
+       var $mId, $mSynonyms, $mCaseSensitive;
+       var $mRegex = '';
+       var $mRegexStart = '';
+       var $mBaseRegex = '';
+       var $mVariableRegex = '';
+       var $mModified = false;
+       var $mFound = false;
 
        static public $mVariableIDsInitialised = false;
        static public $mVariableIDs = array(
@@ -60,6 +65,7 @@ class MagicWord {
                'numberofarticles',
                'numberoffiles',
                'numberofedits',
+               'articlepath',
                'sitename',
                'server',
                'servername',
@@ -79,6 +85,7 @@ class MagicWord {
                'revisionday',
                'revisionday2',
                'revisionmonth',
+               'revisionmonth1',
                'revisionyear',
                'revisiontimestamp',
                'revisionuser',
@@ -175,20 +182,15 @@ class MagicWord {
 
        /**#@-*/
 
-       function __construct($id = 0, $syn = '', $cs = false) {
+       function __construct($id = 0, $syn = array(), $cs = false) {
                $this->mId = $id;
                $this->mSynonyms = (array)$syn;
                $this->mCaseSensitive = $cs;
-               $this->mRegex = '';
-               $this->mRegexStart = '';
-               $this->mVariableRegex = '';
-               $this->mVariableStartToEndRegex = '';
-               $this->mModified = false;
        }
 
        /**
         * Factory: creates an object representing an ID
-        * @static
+        * @return MagicWord
         */
        static function &get( $id ) {
                wfProfileIn( __METHOD__ );
@@ -269,13 +271,13 @@ class MagicWord {
         * @private
         */
        function initRegex() {
-               #$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
+               // Sort the synonyms by length, descending, so that the longest synonym
+               // matches in precedence to the shortest
+               $synonyms = $this->mSynonyms;
+               usort( $synonyms, array( $this, 'compareStringLength' ) );
 
                $escSyn = array();
-               foreach ( $this->mSynonyms as $synonym )
+               foreach ( $synonyms as $synonym )
                        // In case a magic word contains /, like that's going to happen;)
                        $escSyn[] = preg_quote( $synonym, '/' );
                $this->mBaseRegex = implode( '|', $escSyn );
@@ -288,6 +290,23 @@ class MagicWord {
                        "/^(?:{$this->mBaseRegex})$/{$case}" );
        }
 
+       /**
+        * A comparison function that returns -1, 0 or 1 depending on whether the 
+        * first string is longer, the same length or shorter than the second 
+        * string.
+        */
+       function compareStringLength( $s1, $s2 ) {
+               $l1 = strlen( $s1 );
+               $l2 = strlen( $s2 );
+               if ( $l1 < $l2 ) {
+                       return 1;
+               } elseif ( $l1 > $l2 ) {
+                       return -1;
+               } else {
+                       return 0;
+               }
+       }
+
        /**
         * Gets a regex representing matching the word
         */
@@ -461,6 +480,7 @@ class MagicWord {
         * thereby gaining some efficiency. The result is placed in the out variable
         * $result. The return value is true if something was replaced.
         * @static
+        * @todo Should this be static? It doesn't seem to be used at all
         **/
        function replaceMultiple( $magicarr, $subject, &$result ){
                $search = array();
@@ -513,7 +533,6 @@ class MagicWordArray {
         * Add a magic word by name
         */
        public function add( $name ) {
-               global $wgContLang;
                $this->names[] = $name;
                $this->hash = $this->baseRegex = $this->regex = null;
        }
@@ -570,7 +589,7 @@ class MagicWordArray {
        }
 
        /**
-        * Get an unanchored regex
+        * Get an unanchored regex that does not match parameters
         */
        function getRegex() {
                if ( is_null( $this->regex ) ) {
@@ -587,29 +606,29 @@ class MagicWordArray {
        }
 
        /**
-        * Get a regex for matching variables
+        * Get a regex for matching variables with parameters
         */
        function getVariableRegex() {
                return str_replace( "\\$1", "(.*?)", $this->getRegex() );
        }
 
        /**
-        * Get a regex for matching a prefix. Does not match parameters.
+        * Get a regex anchored to the start of the string that does not match parameters
         */
        function getRegexStart() {
                $base = $this->getBaseRegex();
                $newRegex = array( '', '' );
                if ( $base[0] !== '' ) {
-                       $newRegex[0] = str_replace( "\\$1", "", "/^(?:{$base[0]})/iuS" );
+                       $newRegex[0] = "/^(?:{$base[0]})/iuS";
                }
                if ( $base[1] !== '' ) {
-                       $newRegex[1] = str_replace( "\\$1", "", "/^(?:{$base[1]})/S" );
+                       $newRegex[1] = "/^(?:{$base[1]})/S"; 
                }
                return $newRegex;
        }
 
        /**
-        * Get an anchored regex for matching variables
+        * Get an anchored regex for matching variables with parameters
         */
        function getVariableStartToEndRegex() {
                $base = $this->getBaseRegex();
@@ -646,7 +665,6 @@ class MagicWordArray {
                }
                // This shouldn't happen either
                throw new MWException( __METHOD__.': parameter not found' );
-               return array( false, false );
        }
 
        /**
@@ -656,7 +674,6 @@ class MagicWordArray {
         * Both elements are false if there was no match.
         */
        public function matchVariableStartToEnd( $text ) {
-               global $wgContLang;
                $regexes = $this->getVariableStartToEndRegex();
                foreach ( $regexes as $regex ) {
                        if ( $regex !== '' ) {
@@ -708,22 +725,27 @@ class MagicWordArray {
        }
 
        /**
-        * Returns the magic word id removed from the start, or false
-        * does not match parameters.
+        * Return the ID of the magic word at the start of $text, and remove
+        * the prefix from $text.
+        * Return false if no match found and $text is not modified.
+        * Does not match parameters.
         */
        public function matchStartAndRemove( &$text ) {
-               $found = FALSE;
                $regexes = $this->getRegexStart();
                foreach ( $regexes as $regex ) {
                        if ( $regex === '' ) {
                                continue;
                        }
-                       preg_match_all( $regex, $text, $matches, PREG_SET_ORDER );
-                       foreach ( $matches as $m ) {
-                               list( $found, $param ) = $this->parseMatch( $m );
+                       if ( preg_match( $regex, $text, $m ) ) {
+                               list( $id, ) = $this->parseMatch( $m );
+                               if ( strlen( $m[0] ) >= strlen( $text ) ) {
+                                       $text = '';
+                               } else {
+                                       $text = substr( $text, strlen( $m[0] ) );
+                               }
+                               return $id;
                        }
-                       $text = preg_replace( $regex, '', $text );
                }
-               return $found;
+               return false;
        }
 }