New infrastructure for actions, as discussed on wikitech-l. Fairly huge commit.

[lhc/web/wiklou.git] / includes / MagicWord.php

diff --git a/includes/MagicWord.php b/includes/MagicWord.php
index dfc3e4f..f77d5f9 100644 (file)
--- a/includes/MagicWord.php
+++ b/includes/MagicWord.php
@@ -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',
@@ -176,20 +182,16 @@ 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__ );
@@ -270,13 +272,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 );
@@ -289,6 +291,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
         */
@@ -646,7 +665,6 @@ class MagicWordArray {
                }
                // This shouldn't happen either
                throw new MWException( __METHOD__.': parameter not found' );
-               return array( false, false );
        }
 
        /**
@@ -719,7 +737,7 @@ class MagicWordArray {
                                continue;
                        }
                        if ( preg_match( $regex, $text, $m ) ) {
-                               list( $id, $param ) = $this->parseMatch( $m );
+                               list( $id, ) = $this->parseMatch( $m );
                                if ( strlen( $m[0] ) >= strlen( $text ) ) {
                                        $text = '';
                                } else {