typo

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

diff --git a/includes/MagicWord.php b/includes/MagicWord.php
index f0ed86d..bb7b7c1 100644 (file)
--- a/includes/MagicWord.php
+++ b/includes/MagicWord.php
@@ -1,4 +1,4 @@
-<?
+<?php
 
 # This class encapsulates "magic words" such as #redirect, __NOTOC__, etc.
 # Usage:
@@ -13,6 +13,54 @@
 
 /*private*/ $wgMagicFound = false;
 
+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_NAMESPACE", 31);
+
+$wgVariableIDs = array(
+       MAG_CURRENTMONTH,
+       MAG_CURRENTMONTHNAME,
+       MAG_CURRENTDAY,
+       MAG_CURRENTDAYNAME,
+       MAG_CURRENTYEAR,
+       MAG_CURRENTTIME,
+       MAG_NUMBEROFARTICLES,
+       MAG_CURRENTMONTHNAMEGEN,
+    MAG_SITENAME,
+       MAG_SERVER,
+       MAG_PAGENAME,
+       MAG_NAMESPACE
+);
+
 class MagicWord {
        /*private*/ var $mId, $mSynonyms, $mCaseSensitive, $mRegex;
        /*private*/ var $mRegexStart, $mBaseRegex, $mVariableRegex;
@@ -26,6 +74,7 @@ class MagicWord {
                $this->mRegex = "";
                $this->mRegexStart = "";
                $this->mVariableRegex = "";
+               $this->mVariableStartToEndRegex = "";
                $this->mModified = false;
        }
 
@@ -53,12 +102,15 @@ class MagicWord {
        # Preliminary initialisation
        /* private */ function initRegex()
        {
+               $variableClass = Title::legalChars();
                $escSyn = array_map( "preg_quote", $this->mSynonyms );
                $this->mBaseRegex = implode( "|", $escSyn );
                $case = $this->mCaseSensitive ? "" : "i";
                $this->mRegex = "/{$this->mBaseRegex}/{$case}";
                $this->mRegexStart = "/^{$this->mBaseRegex}/{$case}";
-               $this->mVariableRegex = str_replace( "\\$1", "([A-Za-z0-9_\-]*)", $this->mRegex );
+               $this->mVariableRegex = str_replace( "\\$1", "([$variableClass]*?)", $this->mRegex );
+               $this->mVariableStartToEndRegex = str_replace( "\\$1", "([$variableClass]*?)", 
+                       "/^({$this->mBaseRegex})$/{$case}" );
        }
        
        # Gets a regex representing matching the word
@@ -79,7 +131,7 @@ class MagicWord {
                }
                return $this->mRegexStart;
        }
-       
+
        # regex without the slashes and what not
        function getBaseRegex()
        {
@@ -100,6 +152,22 @@ class MagicWord {
                return preg_match( $this->getRegexStart(), $text );
        }
 
+       # Returns NULL if there's no match, the value of $1 otherwise
+       # The return code is the matched string, if there's no variable
+       # part in the regex and the matched variable part ($1) if there
+       # is one.
+       function matchVariableStartToEnd( $text ) {
+               $matchcount = preg_match( $this->getVariableStartToEndRegex(), $text, $matches );
+               if ( $matchcount == 0 ) {
+                       return NULL;
+               } elseif ( count($matches) == 1 ) {
+                       return $matches[0];
+               } else {
+                       return $matches[1];
+               }
+       }
+
+
        # Returns true if the text matches the word, and alters the
        # input string, removing all instances of the word
        function matchAndRemove( &$text )
@@ -110,6 +178,14 @@ class MagicWord {
                return $wgMagicFound;
        }
 
+       function matchStartAndRemove( &$text ) {
+               global $wgMagicFound;
+               $wgMagicFound = false;
+               $text = preg_replace_callback( $this->getRegexStart(), "pregRemoveAndRecord", $text );
+               return $wgMagicFound;
+       }               
+
+
        # Replaces the word with something else
        function replace( $replacement, $subject )
        {
@@ -137,6 +213,15 @@ class MagicWord {
                return $this->mVariableRegex;
        }
 
+       # Matches the entire string, where $1 is a wildcard
+       function getVariableStartToEndRegex()
+       {
+               if ( $this->mVariableStartToEndRegex == "" ) {
+                       $this->initRegex();
+               } 
+               return $this->mVariableStartToEndRegex;
+       }
+
        # Accesses the synonym list directly
        function getSynonym( $i ) {
                return $this->mSynonyms[$i];
@@ -165,6 +250,14 @@ class MagicWord {
                $result = preg_replace( $search, $replace, $subject );
                return !($result === $subject);
        }
+
+       # Adds all the synonyms of this MagicWord to an array, to allow quick lookup in a list of magic words
+       function addToArray( &$array, $value ) 
+       {
+               foreach ( $this->mSynonyms as $syn ) {
+                       $array[$syn] = $value;
+               }
+       }
 }
 
 # Used in matchAndRemove()