<?php
/**
* 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);
+$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',
+);
+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_NAMESPACE
+ MAG_FULLPAGENAME,
+ MAG_FULLPAGENAMEE,
+ MAG_NAMESPACE,
+ MAG_NAMESPACEE,
+ MAG_CURRENTWEEK,
+ MAG_CURRENTDOW,
+ MAG_REVISIONID,
+ MAG_SUBPAGENAME,
+ MAG_SUBPAGENAMEE
);
+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 {
- /*private*/ var $mId, $mSynonyms, $mCaseSensitive, $mRegex;
- /*private*/ var $mRegexStart, $mBaseRegex, $mVariableRegex;
- /*private*/ var $mModified;
+ /**#@+
+ * @access private
+ */
+ var $mId, $mSynonyms, $mCaseSensitive, $mRegex;
+ var $mRegexStart, $mBaseRegex, $mVariableRegex;
+ var $mModified;
+ /**#@-*/
function MagicWord($id = 0, $syn = '', $cs = false) {
$this->mId = $id;
*/
function &get( $id ) {
global $wgMagicWords;
-
+
if ( !is_array( $wgMagicWords ) ) {
wfDebugDieBacktrace( "Incorrect initialisation order, \$wgMagicWords does not exist\n" );
}
}
return $wgMagicWords[$id];
}
-
+
# Initialises this object with an ID
function load( $id ) {
- global $wgLang;
+ global $wgContLang;
$this->mId = $id;
- $wgLang->getMagic( $this );
+ $wgContLang->getMagic( $this );
}
-
+
/**
* Preliminary initialisation
- * @private
+ * @access 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
*/
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
*/
}
return $this->mBaseRegex;
}
-
+
/**
* Returns true if the text contains the word
* @return bool
* is one.
*/
function matchVariableStartToEnd( $text ) {
+ $matches = array();
$matchcount = preg_match( $this->getVariableStartToEndRegex(), $text, $matches );
if ( $matchcount == 0 ) {
return NULL;
} elseif ( count($matches) == 1 ) {
return $matches[0];
} else {
+ # 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];
}
}
$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 );
+ $res = preg_replace( $this->getRegex(), wfRegexReplacement( $replacement ), $subject );
$this->mModified = !($res === $subject);
return $res;
}
* 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;
function getVariableRegex() {
if ( $this->mVariableRegex == '' ) {
$this->initRegex();
- }
+ }
return $this->mVariableRegex;
}
function getVariableStartToEndRegex() {
if ( $this->mVariableStartToEndRegex == '' ) {
$this->initRegex();
- }
+ }
return $this->mVariableStartToEndRegex;
}
}
/**
- * 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(){
* 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();
/**
* Used in matchAndRemove()
- * @private
+ * @access private
**/
function pregRemoveAndRecord( $match ) {
global $wgMagicFound;
dépôts / lhc / web / wiklou.git / blobdiff