Loading...
Helix SwarmHelix Swarm
Loading...

ParserFunctions.php

  • //
  • guest/
  • sam_stafford/
  • mediawiki/
  • extensions/
  • ParserFunctions/
  • ParserFunctions.php #1
  • View
  • Commits
  • Open Download .zip Download (15 KB) 
  1. <?php
  2.  
  3. if ( !defined( 'MEDIAWIKI' ) ) {
  4. 	die( 'This file is a MediaWiki extension, it is not a valid entry point' );
  5. }
  6.  
  7. $wgExtensionFunctions[] = 'wfSetupParserFunctions';
  8. $wgExtensionCredits['parserhook'][] = array(
  9. 	'name' => 'ParserFunctions',
  10. 	'url' => 'http://meta.wikimedia.org/wiki/ParserFunctions',
  11. 	'author' => 'Tim Starling',
  12. 	'description' => 'Enhance parser with logical functions',
  13. );
  14.  
  15. $wgHooks['LanguageGetMagic'][]       = 'wfParserFunctionsLanguageGetMagic';
  16. $wgHooks['ParserLimitReport'][]      = 'wfParserFunctionsLimitReport';
  17.  
  18. $wgMaxIfExistCount = 100;
  19.  
  20. class ExtParserFunctions {
  21. 	var $mExprParser;
  22. 	var $mTimeCache = array();
  23. 	var $mTimeChars = 0;
  24. 	var $mMaxTimeChars = 6000; # ~10 seconds
  25.  
  26. 	function clearState(&$parser) {
  27. 		$this->mTimeChars = 0;
  28. 		$parser->pf_ifexist_count = 0;
  29. 		$parser->pf_ifexist_breakdown = array();
  30. 		return true;
  31. 	}
  32.  
  33. 	function &getExprParser() {
  34. 		if ( !isset( $this->mExpr ) ) {
  35. 			if ( !class_exists( 'ExprParser' ) ) {
  36. 				require( dirname( __FILE__ ) . '/Expr.php' );
  37. 			}
  38. 			$this->mExprParser = new ExprParser;
  39. 		}
  40. 		return $this->mExprParser;
  41. 	}
  42.  
  43. 	function expr( &$parser, $expr = '' ) {
  44. 		try {
  45. 			return $this->getExprParser()->doExpression( $expr );
  46. 		} catch(ExprError $e) {
  47. 			return $e->getMessage();
  48. 		}
  49. 	}
  50.  
  51. 	function ifexpr( &$parser, $expr = '', $then = '', $else = '' ) {
  52. 		try{
  53. 			if($this->getExprParser()->doExpression( $expr )) {
  54. 				return $then;
  55. 			} else {
  56. 				return $else;
  57. 			}
  58. 		} catch (ExprError $e){
  59. 			return $e->getMessage();
  60. 		}
  61. 	}
  62.  
  63. 	function ifexprObj( $parser, $frame, $args ) {
  64. 		$expr = isset( $args[0] ) ? trim( $frame->expand( $args[0] ) ) : '';
  65. 		$then = isset( $args[1] ) ? $args[1] : '';
  66. 		$else = isset( $args[2] ) ? $args[2] : '';
  67. 		$result = $this->ifexpr( $parser, $expr, $then, $else );
  68. 		if ( is_object( $result ) ) {
  69. 			$result = trim( $frame->expand( $result ) );
  70. 		}
  71. 		return $result;
  72. 	}
  73.  
  74. 	function ifHook( &$parser, $test = '', $then = '', $else = '' ) {
  75. 		if ( $test !== '' ) {
  76. 			return $then;
  77. 		} else {
  78. 			return $else;
  79. 		}
  80. 	}
  81.  
  82. 	function ifObj( &$parser, $frame, $args ) {
  83. 		$test = isset( $args[0] ) ? trim( $frame->expand( $args[0] ) ) : '';
  84. 		if ( $test !== '' ) {
  85. 			return isset( $args[1] ) ? trim( $frame->expand( $args[1] ) ) : '';
  86. 		} else {
  87. 			return isset( $args[2] ) ? trim( $frame->expand( $args[2] ) ) : '';
  88. 		}
  89. 	}
  90.  
  91. 	function ifeq( &$parser, $left = '', $right = '', $then = '', $else = '' ) {
  92. 		if ( $left == $right ) {
  93. 			return $then;
  94. 		} else {
  95. 			return $else;
  96. 		}
  97. 	}
  98.  
  99. 	function ifeqObj( &$parser, $frame, $args ) {
  100. 		$left = isset( $args[0] ) ? trim( $frame->expand( $args[0] ) ) : '';
  101. 		$right = isset( $args[1] ) ? trim( $frame->expand( $args[1] ) ) : '';
  102. 		if ( $left == $right ) {
  103. 			return isset( $args[2] ) ? trim( $frame->expand( $args[2] ) ) : '';
  104. 		} else {
  105. 			return isset( $args[3] ) ? trim( $frame->expand( $args[3] ) ) : '';
  106. 		}
  107. 	}
  108.  
  109. 	function switchHook( &$parser /*,...*/ ) {
  110. 		$args = func_get_args();
  111. 		array_shift( $args );
  112. 		$primary = trim(array_shift($args));
  113. 		$found = false;
  114. 		$parts = null;
  115. 		$default = null;
  116. 		$mwDefault =& MagicWord::get( 'default' );
  117. 		foreach( $args as $arg ) {
  118. 			$parts = array_map( 'trim', explode( '=', $arg, 2 ) );
  119. 			if ( count( $parts ) == 2 ) {
  120. 				# Found "="
  121. 				if ( $found || $parts[0] == $primary ) {
  122. 					# Found a match, return now
  123. 					return $parts[1];
  124. 				} else {
  125. 					if ( $mwDefault->matchStartAndRemove( $parts[0] ) ) {
  126. 						$default = $parts[1];
  127. 					} # else wrong case, continue
  128. 				}
  129. 			} elseif ( count( $parts ) == 1 ) {
  130. 				# Multiple input, single output
  131. 				# If the value matches, set a flag and continue
  132. 				if ( $parts[0] == $primary ) {
  133. 					$found = true;
  134. 				}
  135. 			} # else RAM corruption due to cosmic ray?
  136. 		}
  137. 		# Default case
  138. 		# Check if the last item had no = sign, thus specifying the default case
  139. 		if ( count( $parts ) == 1) {
  140. 			return $parts[0];
  141. 		} elseif ( !is_null( $default ) ) {
  142. 			return $default;
  143. 		} else {
  144. 			return '';
  145. 		}
  146. 	}
  147.  
  148. 	function switchObj( $parser, $frame, $args ) {
  149. 		if ( count( $args ) == 0 ) {
  150. 			return '';
  151. 		}
  152. 		$primary = trim( $frame->expand( array_shift( $args ) ) );
  153. 		$found = false;
  154. 		$default = null;
  155. 		$lastItemHadNoEquals = false;
  156. 		$mwDefault =& MagicWord::get( 'default' );
  157. 		foreach ( $args as $arg ) {
  158. 			list( $nameNode, $index, $valueNode ) = $frame->splitBraceNode( $arg );
  159. 			if ( $index === '' ) {
  160. 				# Found "="
  161. 				$lastItemHadNoEquals = false;
  162. 				$test = trim( $frame->expand( $nameNode ) );
  163. 				if ( $found ) {
  164. 					# Multiple input match
  165. 					return trim( $frame->expand( $valueNode ) );
  166. 				} else {
  167. 					$test = trim( $frame->expand( $nameNode ) );
  168. 					if ( $test == $primary ) {
  169. 						# Found a match, return now
  170. 						return trim( $frame->expand( $valueNode ) );
  171. 					} else {
  172. 						if ( $mwDefault->matchStartAndRemove( $test ) ) {
  173. 							$default = $valueNode;
  174. 						} # else wrong case, continue
  175. 					}
  176. 				}
  177. 			} else {
  178. 				# Multiple input, single output
  179. 				# If the value matches, set a flag and continue
  180. 				$lastItemHadNoEquals = true;
  181. 				$test = trim( $frame->expand( $valueNode ) );
  182. 				if ( $test == $primary ) {
  183. 					$found = true;
  184. 				}
  185. 			}
  186. 		}
  187. 		# Default case
  188. 		# Check if the last item had no = sign, thus specifying the default case
  189. 		if ( $lastItemHadNoEquals ) {
  190. 			return $test;
  191. 		} elseif ( !is_null( $default ) ) {
  192. 			return trim( $frame->expand( $default ) );
  193. 		} else {
  194. 			return '';
  195. 		}
  196. 	}
  197.  
  198. 	/**
  199. 	 * Returns the absolute path to a subpage, relative to the current article
  200. 	 * title. Treats titles as slash-separated paths.
  201. 	 *
  202. 	 * Following subpage link syntax instead of standard path syntax, an 
  203. 	 * initial slash is treated as a relative path, and vice versa.
  204. 	 */
  205. 	public function rel2abs( &$parser , $to = '' , $from = '' ) {
  206.  
  207. 		$from = trim($from);
  208. 		if( $from == '' ) {
  209. 			$from = $parser->getTitle()->getPrefixedText();
  210. 		}
  211.  
  212. 		$to = rtrim( $to , ' /' );
  213.  
  214. 		// if we have an empty path, or just one containing a dot
  215. 		if( $to == '' || $to == '.' ) {
  216. 			return $from;
  217. 		}
  218.  
  219. 		// if the path isn't relative
  220. 		if ( substr( $to , 0 , 1) != '/' &&
  221. 		 substr( $to , 0 , 2) != './' &&
  222. 		 substr( $to , 0 , 3) != '../' &&
  223. 		 $to != '..' )
  224. 		{
  225. 			$from = '';
  226. 		}
  227. 		// Make a long path, containing both, enclose it in /.../
  228. 		$fullPath = '/' . $from . '/' .  $to . '/';
  229.  
  230. 		// remove redundant current path dots
  231. 		$fullPath = preg_replace( '!/(\./)+!', '/', $fullPath );
  232.  
  233. 		// remove double slashes
  234. 		$fullPath = preg_replace( '!/{2,}!', '/', $fullPath );
  235.  
  236. 		// remove the enclosing slashes now
  237. 		$fullPath = trim( $fullPath , '/' );
  238. 		$exploded = explode ( '/' , $fullPath );
  239. 		$newExploded = array();
  240.  
  241. 		foreach ( $exploded as $current ) {
  242. 			if( $current == '..' ) { // removing one level
  243. 				if( !count( $newExploded ) ){
  244. 					// attempted to access a node above root node
  245. 					return '<strong class="error">' . wfMsgForContent( 'pfunc_rel2abs_invalid_depth', $fullPath ) . '</strong>';
  246. 				}
  247. 				// remove last level from the stack
  248. 				array_pop( $newExploded );
  249. 			} else {
  250. 				// add the current level to the stack
  251. 				$newExploded[] = $current;
  252. 			}
  253. 		}
  254.  
  255. 		// we can now join it again
  256. 		return implode( '/' , $newExploded );
  257. 	}
  258.  
  259. 	function incrementIfexistCount( $parser, $frame ) {
  260. 		// Don't let this be called more than a certain number of times. It tends to make the database explode.
  261. 		global $wgMaxIfExistCount;
  262. 		$parser->pf_ifexist_count++;
  263. 		if ( $frame ) {
  264. 			$pdbk = $frame->getPDBK( 1 );
  265. 			if ( !isset( $parser->pf_ifexist_breakdown[$pdbk] ) ) {
  266. 				$parser->pf_ifexist_breakdown[$pdbk] = 0;
  267. 			}
  268. 			$parser->pf_ifexist_breakdown[$pdbk] ++;
  269. 		}
  270. 		return $parser->pf_ifexist_count <= $wgMaxIfExistCount;
  271. 	}
  272.  
  273. 	function ifexist( &$parser, $title = '', $then = '', $else = '' ) {
  274. 		return $this->ifexistCommon( $parser, false, $title, $then, $else );
  275. 	}
  276.  
  277. 	function ifexistCommon( &$parser, $frame, $title = '', $then = '', $else = '' ) {
  278. 		$title = Title::newFromText( $title );
  279. 		if ( $title ) {
  280. 			/* If namespace is specified as NS_MEDIA, then we want to check the physical file,
  281. 			 * not the "description" page.
  282. 			 */
  283. 			if( $title->getNamespace() == NS_MEDIA ) {
  284. 				if ( !$this->incrementIfexistCount( $parser, $frame ) ) {
  285. 					return $else;
  286. 				}
  287. 				$file = wfFindFile($title);
  288. 				if ( !$file ) {
  289. 					return $else;
  290. 				}
  291. 				$parser->mOutput->addImage($file->getName());
  292. 				return $file->exists() ? $then : $else;
  293. 			} else {
  294. 				$pdbk = $title->getPrefixedDBkey();
  295. 				$lc = LinkCache::singleton();
  296. 				if ( $lc->getGoodLinkID( $pdbk ) ) {
  297. 					return $then;
  298. 				} elseif ( $lc->isBadLink( $pdbk ) ) {
  299. 					return $else;
  300. 				}
  301. 				if ( !$this->incrementIfexistCount( $parser, $frame ) ) {
  302. 					return $else;
  303. 				}
  304.  
  305. 				$id = $title->getArticleID();
  306. 				$parser->mOutput->addLink( $title, $id );
  307. 				if ( $id ) {
  308. 					return $then;
  309. 				}
  310. 			}
  311. 		}
  312. 		return $else;
  313. 	}
  314.  
  315. 	function ifexistObj( &$parser, $frame, $args ) {
  316. 		$title = isset( $args[0] ) ? trim( $frame->expand( $args[0] ) ) : '';
  317. 		$then = isset( $args[1] ) ? $args[1] : null;
  318. 		$else = isset( $args[2] ) ? $args[2] : null;
  319.  
  320. 		$result = $this->ifexistCommon( $parser, $frame, $title, $then, $else );
  321. 		if ( $result === null ) {
  322. 			return '';
  323. 		} else {
  324. 			return trim( $frame->expand( $result ) );
  325. 		}
  326. 	}
  327.  
  328. 	function time( &$parser, $format = '', $date = '', $local = false ) {
  329. 		global $wgContLang, $wgLocaltimezone;
  330. 		if ( isset( $this->mTimeCache[$format][$date][$local] ) ) {
  331. 			return $this->mTimeCache[$format][$date][$local];
  332. 		}
  333.  
  334. 		if ( $date !== '' ) {
  335. 			$unix = @strtotime( $date );
  336. 		} else {
  337. 			$unix = time();
  338. 		}
  339.  
  340. 		if ( $unix == -1 || $unix == false ) {
  341. 			$result = '<strong class="error">' . wfMsgForContent( 'pfunc_time_error' ) . '</strong>';
  342. 		} else {
  343. 			$this->mTimeChars += strlen( $format );
  344. 			if ( $this->mTimeChars > $this->mMaxTimeChars ) {
  345. 				return '<strong class="error">' . wfMsgForContent( 'pfunc_time_too_long' ) . '</strong>';
  346. 			} else {
  347. 				if ( $local ) {
  348. 					# Use the time zone
  349. 					if ( isset( $wgLocaltimezone ) ) {
  350. 						$oldtz = getenv( 'TZ' );
  351. 						putenv( 'TZ='.$wgLocaltimezone );
  352. 					}
  353. 					wfSuppressWarnings(); // E_STRICT system time bitching
  354. 					$ts = date( 'YmdHis', $unix );
  355. 					wfRestoreWarnings();
  356. 					if ( isset( $wgLocaltimezone ) ) {
  357. 						putenv( 'TZ='.$oldtz );
  358. 					}
  359. 				} else {
  360. 					$ts = wfTimestamp( TS_MW, $unix );
  361. 				}
  362. 				if ( method_exists( $wgContLang, 'sprintfDate' ) ) {
  363. 					$result = $wgContLang->sprintfDate( $format, $ts );
  364. 				} else {
  365. 					if ( !class_exists( 'SprintfDateCompat' ) ) {
  366. 						require( dirname( __FILE__ ) . '/SprintfDateCompat.php' );
  367. 					}
  368.  
  369. 					$result = SprintfDateCompat::sprintfDate( $format, $ts );
  370. 				}
  371. 			}
  372. 		}
  373. 		$this->mTimeCache[$format][$date][$local] = $result;
  374. 		return $result;
  375. 	}
  376. 	
  377. 	function localTime( &$parser, $format = '', $date = '' ) {
  378. 		return $this->time( $parser, $format, $date, true );
  379. 	}
  380. 	
  381. 	/**
  382. 	 * Obtain a specified number of slash-separated parts of a title,
  383. 	 * e.g. {{#titleparts:Hello/World|1}} => "Hello"
  384. 	 *
  385. 	 * @param Parser $parser Parent parser
  386. 	 * @param string $title Title to split
  387. 	 * @param int $parts Number of parts to keep
  388. 	 * @param int $offset Offset starting at 1
  389. 	 * @return string
  390. 	 */
  391. 	public function titleparts( $parser, $title = '', $parts = 0, $offset = 0) {
  392. 		$parts = intval( $parts );
  393. 		$offset = intval( $offset );
  394. 		$ntitle = Title::newFromText( $title );
  395. 		if ( $ntitle instanceof Title ) {
  396. 			$bits = explode( '/', $ntitle->getPrefixedText(), 25 );
  397. 			if ( count( $bits ) <= 0 ) {
  398. 				 return $ntitle->getPrefixedText();
  399. 			} else {
  400. 				if ( $offset > 0 ) {
  401. 					--$offset;
  402. 				}
  403. 				if ( $parts == 0 ) {
  404. 					return implode( '/', array_slice( $bits, $offset ) );
  405. 				} else {
  406. 					return implode( '/', array_slice( $bits, $offset, $parts ) );
  407. 				}
  408. 			}
  409. 		} else {
  410. 			return $title;
  411. 		}
  412. 	}
  413. 	
  414. 	function afterTidy( &$parser, &$text ) {
  415. 		global $wgMaxIfExistCount;
  416. 		if ( $parser->pf_ifexist_count > $wgMaxIfExistCount ) {
  417. 			if ( is_callable( array( $parser->mOutput, 'addWarning' ) ) ) {
  418. 				$warning = wfMsg( 'pfunc_ifexist_warning', $parser->pf_ifexist_count, $wgMaxIfExistCount );
  419. 				$parser->mOutput->addWarning( $warning );
  420. 				$cat = Title::makeTitleSafe( NS_CATEGORY, wfMsg( 'pfunc_max_ifexist_category' ) );
  421. 				if ( $cat ) {
  422. 					$parser->mOutput->addCategory( $cat->getDBkey(), $parser->getDefaultSort() );
  423. 				}
  424. 			}
  425. 		}
  426. 		return true;
  427. 	}
  428. }
  429.  
  430. function wfSetupParserFunctions() {
  431. 	global $wgParser, $wgMessageCache, $wgExtParserFunctions, $wgMessageCache, $wgHooks;
  432.  
  433. 	$wgExtParserFunctions = new ExtParserFunctions;
  434.  
  435. 	// Check for SFH_OBJECT_ARGS capability
  436. 	if ( class_exists( 'StubObject' ) && !StubObject::isRealObject( $wgParser ) ) {
  437. 		$wgParser->_unstub();
  438. 	}
  439. 	if ( defined( get_class( $wgParser ) . '::SFH_OBJECT_ARGS' ) ) {
  440. 		// These functions accept DOM-style arguments
  441. 		$wgParser->setFunctionHook( 'if', array( &$wgExtParserFunctions, 'ifObj' ), SFH_OBJECT_ARGS );
  442. 		$wgParser->setFunctionHook( 'ifeq', array( &$wgExtParserFunctions, 'ifeqObj' ), SFH_OBJECT_ARGS );
  443. 		$wgParser->setFunctionHook( 'switch', array( &$wgExtParserFunctions, 'switchObj' ), SFH_OBJECT_ARGS );
  444. 		$wgParser->setFunctionHook( 'ifexist', array( &$wgExtParserFunctions, 'ifexistObj' ), SFH_OBJECT_ARGS );
  445. 		$wgParser->setFunctionHook( 'ifexpr', array( &$wgExtParserFunctions, 'ifexprObj' ), SFH_OBJECT_ARGS );
  446. 	} else {
  447. 		$wgParser->setFunctionHook( 'if', array( &$wgExtParserFunctions, 'ifHook' ) );
  448. 		$wgParser->setFunctionHook( 'ifeq', array( &$wgExtParserFunctions, 'ifeq' ) );
  449. 		$wgParser->setFunctionHook( 'switch', array( &$wgExtParserFunctions, 'switchHook' ) );
  450. 		$wgParser->setFunctionHook( 'ifexist', array( &$wgExtParserFunctions, 'ifexist' ) );
  451. 		$wgParser->setFunctionHook( 'ifexpr', array( &$wgExtParserFunctions, 'ifexpr' ) );
  452. 	}
  453.  
  454. 	$wgParser->setFunctionHook( 'expr', array( &$wgExtParserFunctions, 'expr' ) );
  455. 	$wgParser->setFunctionHook( 'time', array( &$wgExtParserFunctions, 'time' ) );
  456. 	$wgParser->setFunctionHook( 'timel', array( &$wgExtParserFunctions, 'localTime' ) );
  457. 	$wgParser->setFunctionHook( 'rel2abs', array( &$wgExtParserFunctions, 'rel2abs' ) );
  458. 	$wgParser->setFunctionHook( 'titleparts', array( &$wgExtParserFunctions, 'titleparts' ) );
  459. 	
  460. 	require_once( dirname( __FILE__ ) . '/ParserFunctions.i18n.php' );
  461. 	foreach( efParserFunctionsMessages() as $lang => $messages )
  462. 		$wgMessageCache->addMessages( $messages, $lang );
  463.  
  464. 	$wgHooks['ParserClearState'][] = array( &$wgExtParserFunctions, 'clearState' );
  465. 	$wgHooks['ParserAfterTidy'][] = array( &$wgExtParserFunctions, 'afterTidy' );
  466. }
  467.  
  468. function wfParserFunctionsLanguageGetMagic( &$magicWords, $langCode ) {
  469. 	require_once( dirname( __FILE__ ) . '/ParserFunctions.i18n.php' );
  470. 	foreach( efParserFunctionsWords( $langCode ) as $word => $trans )
  471. 		$magicWords[$word] = $trans;
  472. 	return true;
  473. }
  474.  
  475. function wfParserFunctionsLimitReport( $parser, &$report ) {
  476. 	global $wgMaxIfExistCount;
  477. 	if ( isset( $parser->pf_ifexist_count ) ) {
  478. 		$report .= "#ifexist count: {$parser->pf_ifexist_count}/$wgMaxIfExistCount\n";
  479. 	}
  480. 	return true;
  481. }
# Change User Description Committed
#1 6192 Sam Stafford A handful of Mediawiki extensions, skins, and whatnot.
 Not all of
these are aut...hored by me, but I want them all in one place and I need
to keep track of any tweaks made. «		 17 years ago