<?php
+/**
+ * Options for the PHP parser
+ *
+ * @file
+ * @ingroup Parser
+ */
/**
* Set options of the Parser
* @todo document
* @ingroup Parser
*/
-class ParserOptions
-{
+class ParserOptions {
# All variables are supposed to be private in theory, although in practise this is not the case.
- var $mUseTeX; # Use texvc to expand <math> tags
var $mUseDynamicDates; # Use DateFormatter to format dates
var $mInterwikiMagic; # Interlanguage links are removed and returned in an array
var $mAllowExternalImages; # Allow external images inline
var $mAllowExternalImagesFrom; # If not, any exception?
- var $mSkin; # Reference to the preferred skin
- var $mDateFormat; # Date format index
- var $mEditSection; # Create "edit section" links
- var $mNumberHeadings; # Automatically number headings
+ var $mEnableImageWhitelist; # If not or it doesn't match, should we check an on-wiki whitelist?
+ var $mDateFormat = null; # Date format index
+ var $mEditSection = true; # Create "edit section" links
var $mAllowSpecialInclusion; # Allow inclusion of special pages
- var $mTidy; # Ask for tidy cleanup
- var $mInterfaceMessage; # Which lang to call for PLURAL and GRAMMAR
- var $mTargetLanguage; # Overrides above setting with arbitrary language
+ var $mTidy = false; # Ask for tidy cleanup
+ var $mInterfaceMessage = false; # Which lang to call for PLURAL and GRAMMAR
+ var $mTargetLanguage = null; # Overrides above setting with arbitrary language
var $mMaxIncludeSize; # Maximum size of template expansions, in bytes
var $mMaxPPNodeCount; # Maximum number of nodes touched by PPFrame::expand()
var $mMaxPPExpandDepth; # Maximum recursion depth in PPFrame::expand()
var $mMaxTemplateDepth; # Maximum recursion depth for templates within templates
- var $mRemoveComments; # Remove HTML comments. ONLY APPLIES TO PREPROCESS OPERATIONS
- var $mTemplateCallback; # Callback for template fetching
- var $mEnableLimitReport; # Enable limit report in an HTML comment on output
+ var $mRemoveComments = true; # Remove HTML comments. ONLY APPLIES TO PREPROCESS OPERATIONS
+ var $mTemplateCallback = # Callback for template fetching
+ array( 'Parser', 'statelessFetchTemplate' );
+ var $mEnableLimitReport = false; # Enable limit report in an HTML comment on output
var $mTimestamp; # Timestamp used for {{CURRENTDAY}} etc.
+ var $mExternalLinkTarget; # Target attribute for external links
+ var $mCleanSignatures; #
+ var $mPreSaveTransform = true; # Transform wiki markup when saving the page.
+
+ var $mNumberHeadings; # Automatically number headings
+ var $mMath; # User math preference (as integer)
+ var $mThumbSize; # Thumb size preferred by the user.
+ private $mStubThreshold; # Maximum article size of an article to be marked as "stub"
+ var $mUserLang; # Language code of the User language.
+
+ /**
+ * @var User
+ */
+ var $mUser; # Stored user object
+ var $mIsPreview = false; # Parsing the page for a "preview" operation
+ var $mIsSectionPreview = false; # Parsing the page for a "preview" operation on a single section
+ var $mIsPrintable = false; # Parsing the printable version of the page
+
+ var $mExtraKey = ''; # Extra key that should be present in the caching key.
- var $mUser; # Stored user object, just used to initialise the skin
+ protected $onAccessCallback = null;
- function getUseTeX() { return $this->mUseTeX; }
function getUseDynamicDates() { return $this->mUseDynamicDates; }
function getInterwikiMagic() { return $this->mInterwikiMagic; }
function getAllowExternalImages() { return $this->mAllowExternalImages; }
function getAllowExternalImagesFrom() { return $this->mAllowExternalImagesFrom; }
+ function getEnableImageWhitelist() { return $this->mEnableImageWhitelist; }
function getEditSection() { return $this->mEditSection; }
- function getNumberHeadings() { return $this->mNumberHeadings; }
+ function getNumberHeadings() { $this->optionUsed( 'numberheadings' );
+ return $this->mNumberHeadings; }
function getAllowSpecialInclusion() { return $this->mAllowSpecialInclusion; }
function getTidy() { return $this->mTidy; }
function getInterfaceMessage() { return $this->mInterfaceMessage; }
function getTargetLanguage() { return $this->mTargetLanguage; }
function getMaxIncludeSize() { return $this->mMaxIncludeSize; }
function getMaxPPNodeCount() { return $this->mMaxPPNodeCount; }
+ function getMaxPPExpandDepth() { return $this->mMaxPPExpandDepth; }
function getMaxTemplateDepth() { return $this->mMaxTemplateDepth; }
function getRemoveComments() { return $this->mRemoveComments; }
function getTemplateCallback() { return $this->mTemplateCallback; }
function getEnableLimitReport() { return $this->mEnableLimitReport; }
+ function getCleanSignatures() { return $this->mCleanSignatures; }
+ function getExternalLinkTarget() { return $this->mExternalLinkTarget; }
+ function getMath() { $this->optionUsed( 'math' );
+ return $this->mMath; }
+ function getThumbSize() { $this->optionUsed( 'thumbsize' );
+ return $this->mThumbSize; }
+ function getStubThreshold() { $this->optionUsed( 'stubthreshold' );
+ return $this->mStubThreshold; }
- function getSkin() {
- if ( !isset( $this->mSkin ) ) {
- $this->mSkin = $this->mUser->getSkin();
- }
- return $this->mSkin;
+ function getIsPreview() { return $this->mIsPreview; }
+ function getIsSectionPreview() { return $this->mIsSectionPreview; }
+ function getIsPrintable() { $this->optionUsed( 'printable' );
+ return $this->mIsPrintable; }
+ function getUser() { return $this->mUser; }
+ function getPreSaveTransform() { return $this->mPreSaveTransform; }
+
+ /**
+ * @param $title Title
+ * @return Skin
+ * @deprecated since 1.18 Use Linker::* instead
+ */
+ function getSkin( $title = null ) {
+ wfDeprecated( __METHOD__ );
+ return new DummyLinker;
}
function getDateFormat() {
+ $this->optionUsed( 'dateformat' );
if ( !isset( $this->mDateFormat ) ) {
$this->mDateFormat = $this->mUser->getDatePreference();
}
return $this->mTimestamp;
}
- function setUseTeX( $x ) { return wfSetVar( $this->mUseTeX, $x ); }
+ /**
+ * You shouldn't use this. Really. $parser->getFunctionLang() is all you need.
+ * Using this fragments the cache and is discouraged. Yes, {{int: }} uses this,
+ * producing inconsistent tables (Bug 14404).
+ * @return String Language code
+ * @since 1.17
+ */
+ function getUserLang() {
+ $this->optionUsed( 'userlang' );
+ return $this->mUserLang;
+ }
+
function setUseDynamicDates( $x ) { return wfSetVar( $this->mUseDynamicDates, $x ); }
function setInterwikiMagic( $x ) { return wfSetVar( $this->mInterwikiMagic, $x ); }
function setAllowExternalImages( $x ) { return wfSetVar( $this->mAllowExternalImages, $x ); }
function setAllowExternalImagesFrom( $x ) { return wfSetVar( $this->mAllowExternalImagesFrom, $x ); }
+ function setEnableImageWhitelist( $x ) { return wfSetVar( $this->mEnableImageWhitelist, $x ); }
function setDateFormat( $x ) { return wfSetVar( $this->mDateFormat, $x ); }
function setEditSection( $x ) { return wfSetVar( $this->mEditSection, $x ); }
function setNumberHeadings( $x ) { return wfSetVar( $this->mNumberHeadings, $x ); }
function setAllowSpecialInclusion( $x ) { return wfSetVar( $this->mAllowSpecialInclusion, $x ); }
- function setTidy( $x ) { return wfSetVar( $this->mTidy, $x); }
+ function setTidy( $x ) { return wfSetVar( $this->mTidy, $x ); }
function setSkin( $x ) { $this->mSkin = $x; }
- function setInterfaceMessage( $x ) { return wfSetVar( $this->mInterfaceMessage, $x); }
- function setTargetLanguage( $x ) { return wfSetVar( $this->mTargetLanguage, $x); }
+ function setInterfaceMessage( $x ) { return wfSetVar( $this->mInterfaceMessage, $x ); }
+ function setTargetLanguage( $x ) { return wfSetVar( $this->mTargetLanguage, $x, true ); }
function setMaxIncludeSize( $x ) { return wfSetVar( $this->mMaxIncludeSize, $x ); }
function setMaxPPNodeCount( $x ) { return wfSetVar( $this->mMaxPPNodeCount, $x ); }
function setMaxTemplateDepth( $x ) { return wfSetVar( $this->mMaxTemplateDepth, $x ); }
function setTemplateCallback( $x ) { return wfSetVar( $this->mTemplateCallback, $x ); }
function enableLimitReport( $x = true ) { return wfSetVar( $this->mEnableLimitReport, $x ); }
function setTimestamp( $x ) { return wfSetVar( $this->mTimestamp, $x ); }
+ function setCleanSignatures( $x ) { return wfSetVar( $this->mCleanSignatures, $x ); }
+ function setExternalLinkTarget( $x ) { return wfSetVar( $this->mExternalLinkTarget, $x ); }
+ function setMath( $x ) { return wfSetVar( $this->mMath, $x ); }
+ function setUserLang( $x ) {
+ if ( $x instanceof Language ) {
+ $x = $x->getCode();
+ }
+ return wfSetVar( $this->mUserLang, $x );
+ }
+ function setThumbSize( $x ) { return wfSetVar( $this->mThumbSize, $x ); }
+ function setStubThreshold( $x ) { return wfSetVar( $this->mStubThreshold, $x ); }
+ function setPreSaveTransform( $x ) { return wfSetVar( $this->mPreSaveTransform, $x ); }
+
+ function setIsPreview( $x ) { return wfSetVar( $this->mIsPreview, $x ); }
+ function setIsSectionPreview( $x ) { return wfSetVar( $this->mIsSectionPreview, $x ); }
+ function setIsPrintable( $x ) { return wfSetVar( $this->mIsPrintable, $x ); }
+
+ /**
+ * Extra key that should be present in the parser cache key.
+ */
+ function addExtraKey( $key ) {
+ $this->mExtraKey .= '!' . $key;
+ }
function __construct( $user = null ) {
$this->initialiseFromUser( $user );
/**
* Get parser options
- * @static
+ *
+ * @param $user User object
+ * @return ParserOptions object
*/
static function newFromUser( $user ) {
return new ParserOptions( $user );
/** Get user options */
function initialiseFromUser( $userInput ) {
- global $wgUseTeX, $wgUseDynamicDates, $wgInterwikiMagic, $wgAllowExternalImages;
- global $wgAllowExternalImagesFrom, $wgAllowSpecialInclusion, $wgMaxArticleSize;
- global $wgMaxPPNodeCount, $wgMaxTemplateDepth, $wgMaxPPExpandDepth;
- $fname = 'ParserOptions::initialiseFromUser';
- wfProfileIn( $fname );
+ global $wgUseDynamicDates, $wgInterwikiMagic, $wgAllowExternalImages;
+ global $wgAllowExternalImagesFrom, $wgEnableImageWhitelist, $wgAllowSpecialInclusion, $wgMaxArticleSize;
+ global $wgMaxPPNodeCount, $wgMaxTemplateDepth, $wgMaxPPExpandDepth, $wgCleanSignatures;
+ global $wgExternalLinkTarget, $wgLang;
+
+ wfProfileIn( __METHOD__ );
+
if ( !$userInput ) {
global $wgUser;
if ( isset( $wgUser ) ) {
$this->mUser = $user;
- $this->mUseTeX = $wgUseTeX;
$this->mUseDynamicDates = $wgUseDynamicDates;
$this->mInterwikiMagic = $wgInterwikiMagic;
$this->mAllowExternalImages = $wgAllowExternalImages;
$this->mAllowExternalImagesFrom = $wgAllowExternalImagesFrom;
- $this->mSkin = null; # Deferred
- $this->mDateFormat = null; # Deferred
- $this->mEditSection = true;
- $this->mNumberHeadings = $user->getOption( 'numberheadings' );
+ $this->mEnableImageWhitelist = $wgEnableImageWhitelist;
$this->mAllowSpecialInclusion = $wgAllowSpecialInclusion;
- $this->mTidy = false;
- $this->mInterfaceMessage = false;
- $this->mTargetLanguage = null; // default depends on InterfaceMessage setting
$this->mMaxIncludeSize = $wgMaxArticleSize * 1024;
$this->mMaxPPNodeCount = $wgMaxPPNodeCount;
$this->mMaxPPExpandDepth = $wgMaxPPExpandDepth;
$this->mMaxTemplateDepth = $wgMaxTemplateDepth;
- $this->mRemoveComments = true;
- $this->mTemplateCallback = array( 'Parser', 'statelessFetchTemplate' );
- $this->mEnableLimitReport = false;
- wfProfileOut( $fname );
+ $this->mCleanSignatures = $wgCleanSignatures;
+ $this->mExternalLinkTarget = $wgExternalLinkTarget;
+
+ $this->mNumberHeadings = $user->getOption( 'numberheadings' );
+ $this->mMath = $user->getOption( 'math' );
+ $this->mThumbSize = $user->getOption( 'thumbsize' );
+ $this->mStubThreshold = $user->getStubThreshold();
+ $this->mUserLang = $wgLang->getCode();
+
+ wfProfileOut( __METHOD__ );
+ }
+
+ /**
+ * Registers a callback for tracking which ParserOptions which are used.
+ * This is a private API with the parser.
+ */
+ function registerWatcher( $callback ) {
+ $this->onAccessCallback = $callback;
+ }
+
+ /**
+ * Called when an option is accessed.
+ */
+ protected function optionUsed( $optionName ) {
+ if ( $this->onAccessCallback ) {
+ call_user_func( $this->onAccessCallback, $optionName );
+ }
+ }
+
+ /**
+ * Returns the full array of options that would have been used by
+ * in 1.16.
+ * Used to get the old parser cache entries when available.
+ */
+ public static function legacyOptions() {
+ global $wgUseDynamicDates;
+ $legacyOpts = array( 'math', 'stubthreshold', 'numberheadings', 'userlang', 'thumbsize', 'editsection', 'printable' );
+ if ( $wgUseDynamicDates ) {
+ $legacyOpts[] = 'dateformat';
+ }
+ return $legacyOpts;
+ }
+
+ /**
+ * Generate a hash string with the values set on these ParserOptions
+ * for the keys given in the array.
+ * This will be used as part of the hash key for the parser cache,
+ * so users sharign the options with vary for the same page share
+ * the same cached data safely.
+ *
+ * Replaces User::getPageRenderingHash()
+ *
+ * Extensions which require it should install 'PageRenderingHash' hook,
+ * which will give them a chance to modify this key based on their own
+ * settings.
+ *
+ * @since 1.17
+ * @return \string Page rendering hash
+ */
+ public function optionsHash( $forOptions ) {
+ global $wgContLang, $wgRenderHashAppend;
+
+ $confstr = '';
+
+ if ( in_array( 'math', $forOptions ) ) {
+ $confstr .= $this->mMath;
+ } else {
+ $confstr .= '*';
+ }
+
+
+ // Space assigned for the stubthreshold but unused
+ // since it disables the parser cache, its value will always
+ // be 0 when this function is called by parsercache.
+ if ( in_array( 'stubthreshold', $forOptions ) ) {
+ $confstr .= '!' . $this->mStubThreshold;
+ } else {
+ $confstr .= '!*' ;
+ }
+
+ if ( in_array( 'dateformat', $forOptions ) ) {
+ $confstr .= '!' . $this->getDateFormat();
+ }
+
+ if ( in_array( 'numberheadings', $forOptions ) ) {
+ $confstr .= '!' . ( $this->mNumberHeadings ? '1' : '' );
+ } else {
+ $confstr .= '!*';
+ }
+
+ if ( in_array( 'userlang', $forOptions ) ) {
+ $confstr .= '!' . $this->mUserLang;
+ } else {
+ $confstr .= '!*';
+ }
+
+ if ( in_array( 'thumbsize', $forOptions ) ) {
+ $confstr .= '!' . $this->mThumbSize;
+ } else {
+ $confstr .= '!*';
+ }
+
+ // add in language specific options, if any
+ // @todo FIXME: This is just a way of retrieving the url/user preferred variant
+ $confstr .= $wgContLang->getExtraHashOptions();
+
+ $confstr .= $wgRenderHashAppend;
+
+ if ( !in_array( 'editsection', $forOptions ) ) {
+ $confstr .= '!*';
+ } elseif ( !$this->mEditSection ) {
+ $confstr .= '!edit=0';
+ }
+
+ if ( $this->mIsPrintable && in_array( 'printable', $forOptions ) ) {
+ $confstr .= '!printable=1';
+ }
+
+ if ( $this->mExtraKey != '' )
+ $confstr .= $this->mExtraKey;
+
+ // Give a chance for extensions to modify the hash, if they have
+ // extra options or other effects on the parser cache.
+ wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
+
+ // Make it a valid memcached key fragment
+ $confstr = str_replace( ' ', '_', $confstr );
+
+ return $confstr;
}
}
dépôts / lhc / web / wiklou.git / blobdiff