X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2FOutputPage.php;h=e565d8caca56fbfd408b3dfd3aafaa5e14682f32;hb=be8ce87825ae5d415fee2a1ee992184ed2f44a90;hp=508aacea93c04044236bed2239915366ff713aca;hpb=5b2bf3c49cfb2b49d93d832915aed342acda0594;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/OutputPage.php b/includes/OutputPage.php index 508aacea93..e565d8caca 100644 --- a/includes/OutputPage.php +++ b/includes/OutputPage.php @@ -4,57 +4,199 @@ if ( !defined( 'MEDIAWIKI' ) ) { } /** + * This class should be covered by a general architecture document which does + * not exist as of january 2011. This is one of the Core class and should + * be read at least once by any new developers. + * + * This class is used to prepare the final rendering. A skin is then + * applied to the output parameters (links, javascript, html, categories ...). + * + * Another class (fixme) handle sending the whole page to the client. + * + * Some comments comes from a pairing session between Zak Greant and Ashar Voultoiz + * in november 2010. + * * @todo document */ class OutputPage { - var $mMetatags = array(), $mKeywords = array(), $mLinktags = array(); + // should be private. Used with addMeta() which add + var $mMetatags = array(); + + // most of the time the first 10 links to an article + var $mKeywords = array(); + + var $mLinktags = array(); + + // additional stylesheets. Looks like this is for extensions. Might be replaced by ressource loader. var $mExtStyles = array(); - var $mPagetitle = '', $mBodytext = ''; + + // should be private. We got set/get accessors. Set the HTML title + var $mPagetitle = ''; + + // Contains all of the content. Should be private we got set/get accessors and the append() method. + var $mBodytext = ''; /** * Holds the debug lines that will be outputted as comments in page source if * $wgDebugComments is enabled. See also $wgShowDebug. * TODO: make a getter method for this */ - public $mDebugtext = ''; + public $mDebugtext = ''; // TODO: we might want to replace it by wfDebug() wfDebugLog() + + // should be private. Stores contents of tg + var $mHTMLtitle = ''; + + // should be private. Is the displayed content related to the source of the corresponding wiki article. + var $mIsarticle = true; + + /* + * should be private. We have to set isPrintable(). Some pages should + * never be printed (ex: redirections. + */ + var $mPrintable = false; + + /* + * Should be private. We have set/get/append methods. + * + * Contains the article subtitle. + * + * Example: 'From Wikipedia, the free encyclopedia' + */ + var $mSubtitle = ''; + + var $mRedirect = ''; + var $mStatusCode; + + // mLastModified and mEtag are used for sending cache control. + // The whole caching system should probably be moved in its own class. + var $mLastModified = ''; + + /* + * Should be private. No getter but used in sendCacheControl(); + * Contains an HTTP Entity Tags (see RFC 2616 section 3.13) which is used + * as a unique identifier for the content. It is later used by the client + * to compare its cache version with the server version. Client sends + * headers If-Match and If-None-Match containing its local cache ETAG value. + * + * To get more information, you will have to look at HTTP1/1 protocols which + * is properly described in RFC 2616 : http://tools.ietf.org/html/rfc2616 + */ + var $mETag = false; + + var $mCategoryLinks = array(); + var $mCategories = array(); + + // Should be private. Associative array mapping language code to the page name + var $mLanguageLinks = array(); + + /* + * Should be private. Used for javascript (or VB?) + * We should split js / css. + * mScripts content is inserted as is in <head> by Skin. This might contains + * either a link to a stylesheet or inline css. + */ + var $mScripts = ''; + var $mInlineStyles = ''; // ??? + + // + var $mLinkColours; + + /** + * Used by skin template. + * Example: $tpl->set( 'displaytitle', $out->mPageLinkTitle ); + */ + var $mPageLinkTitle = ''; - var $mHTMLtitle = '', $mIsarticle = true, $mPrintable = false; - var $mSubtitle = '', $mRedirect = '', $mStatusCode; - var $mLastModified = '', $mETag = false; - var $mCategoryLinks = array(), $mCategories = array(), $mLanguageLinks = array(); + // Array of <head> elements. Parser might add its own headers! + var $mHeadItems = array(); - var $mScripts = '', $mLinkColours, $mPageLinkTitle = '', $mHeadItems = array(); + // Next variables probably comes from the ressource loader @todo FIXME var $mModules = array(), $mModuleScripts = array(), $mModuleStyles = array(), $mModuleMessages = array(); var $mResourceLoader; + + /** @fixme is this still used ?*/ var $mInlineMsg = array(); var $mTemplateIds = array(); + // Initialized with a global value. Let us override it. + // Should probably get deleted / rewritten ... var $mAllowUserJs; + + /* + * This was for the old skins and for users with 640x480 screen. + * Please note old sckins are still used and might prove useful for + * users having old computers or visually impaired. + */ var $mSuppressQuickbar = false; + + /** + * @EasterEgg I just love the name for this self documenting variable. + * @todo document + */ var $mDoNothing = false; + + // Parser related. var $mContainsOldMagic = 0, $mContainsNewMagic = 0; + + /* + * should be private. Has get/set methods properly documented. + * Stores "article flag" toggle. + */ var $mIsArticleRelated = true; - protected $mParserOptions = null; // lazy initialised, use parserOptions() + // lazy initialised, use parserOptions() + protected $mParserOptions = null; + + /* + * Handles the atom / rss links. + * We probably only support atom in 2011. + * Looks like a private variable. + */ var $mFeedLinks = array(); + // Gwicke work on squid caching? Roughly from 2003. var $mEnableClientCache = true; + + /* + * Flag if output should only contain the body of the article. + * Should be private. + */ var $mArticleBodyOnly = false; var $mNewSectionLink = false; var $mHideNewSectionLink = false; + + /* + * Comes from the parser. This was probably made to laod CSS/JS only + * if we had <gallery>. Used directly in CategoryPage.php + * Looks like resource loader can replace this. + */ var $mNoGallery = false; + + // should be private. var $mPageTitleActionText = ''; var $mParseWarnings = array(); + + // Cache stuff. Looks like mEnableClientCache var $mSquidMaxage = 0; + + // @todo document + var $mPreventClickjacking = true; + + // should be private. To include the variable {{REVISIONID}} var $mRevisionId = null; + + // Stores a Title object. protected $mTitle = null; /** * An array of stylesheet filenames (relative from skins path), with options * for CSS media, IE conditions, and RTL/LTR direction. * For internal use; add settings in the skin via $this->addStyle() + * + * Style again! This seems like a code duplication since we already have + * mStyles. This is what makes OpenSource amazing. */ var $styles = array(); @@ -232,7 +374,7 @@ class OutputPage { * @return Array of module names */ public function getModules() { - return $this->mModules; + return array_values( array_unique( $this->mModules ) ); } /** @@ -251,7 +393,7 @@ class OutputPage { * @return array of module names */ public function getModuleScripts() { - return $this->mModuleScripts; + return array_values( array_unique( $this->mModuleScripts ) ); } /** @@ -271,7 +413,7 @@ class OutputPage { * @return Array of module names */ public function getModuleStyles() { - return $this->mModuleStyles; + return array_values( array_unique( $this->mModuleStyles ) ); } /** @@ -291,7 +433,7 @@ class OutputPage { * @return Array of module names */ public function getModuleMessages() { - return $this->mModuleMessages; + return array_values( array_unique( $this->mModuleMessages ) ); } /** @@ -999,14 +1141,6 @@ class OutputPage { $this->mDebugtext .= $text; } - /** - * @deprecated use parserOptions() instead - */ - public function setParserOptions( $options ) { - wfDeprecated( __METHOD__ ); - return $this->parserOptions( $options ); - } - /** * Get/set the ParserOptions object to use for wikitext parsing * @@ -1117,43 +1251,6 @@ class OutputPage { wfProfileOut( __METHOD__ ); } - /** - * Add wikitext to the buffer, assuming that this is the primary text for a page view - * Saves the text into the parser cache if possible. - * - * @param $text String: wikitext - * @param $article Article object - * @param $cache Boolean - * @deprecated Use Article::outputWikitext - */ - public function addPrimaryWikiText( $text, $article, $cache = true ) { - global $wgParser; - - wfDeprecated( __METHOD__ ); - - $popts = $this->parserOptions(); - $popts->setTidy( true ); - $parserOutput = $wgParser->parse( - $text, $article->mTitle, - $popts, true, true, $this->mRevisionId - ); - $popts->setTidy( false ); - if ( $cache && $article && $parserOutput->isCacheable() ) { - $parserCache = ParserCache::singleton(); - $parserCache->save( $parserOutput, $article, $popts ); - } - - $this->addParserOutput( $parserOutput ); - } - - /** - * @deprecated use addWikiTextTidy() - */ - public function addSecondaryWikiText( $text, $linestart = true ) { - wfDeprecated( __METHOD__ ); - $this->addWikiTextTitleTidy( $text, $this->getTitle(), $linestart ); - } - /** * Add a ParserOutput object, but without Html * @@ -1226,24 +1323,44 @@ class OutputPage { * @param $interface Boolean: use interface language ($wgLang instead of * $wgContLang) while parsing language sensitive magic * words like GRAMMAR and PLURAL + * @param $language Language object: target language object, will override + * $interface * @return String: HTML */ - public function parse( $text, $linestart = true, $interface = false ) { + public function parse( $text, $linestart = true, $interface = false, $language = null ) { + // Check one for one common cause for parser state resetting + $callers = wfGetAllCallers( 10 ); + if ( strpos( $callers, 'Parser::extensionSubstitution' ) !== false ) { + throw new MWException( "wfMsg* function with parsing cannot be used " . + "inside a tag hook. Should use parser->recursiveTagParse() instead" ); + } + global $wgParser; + if( is_null( $this->getTitle() ) ) { throw new MWException( 'Empty $mTitle in ' . __METHOD__ ); } + $popts = $this->parserOptions(); if ( $interface ) { $popts->setInterfaceMessage( true ); } + if ( $language !== null ) { + $oldLang = $popts->setTargetLanguage( $language ); + } + $parserOutput = $wgParser->parse( $text, $this->getTitle(), $popts, $linestart, true, $this->mRevisionId ); + if ( $interface ) { $popts->setInterfaceMessage( false ); } + if ( $language !== null ) { + $popts->setTargetLanguage( $oldLang ); + } + return $parserOutput->getText(); } @@ -1268,24 +1385,6 @@ class OutputPage { return $parsed; } - /** - * @deprecated - * - * @param $article Article - * @return Boolean: true if successful, else false. - */ - public function tryParserCache( &$article ) { - wfDeprecated( __METHOD__ ); - $parserOutput = ParserCache::singleton()->get( $article, $article->getParserOptions() ); - - if ( $parserOutput !== false ) { - $this->addParserOutput( $parserOutput ); - return true; - } else { - return false; - } - } - /** * Set the value of the "s-maxage" part of the "Cache-control" HTTP header * @@ -1426,7 +1525,7 @@ class OutputPage { continue; } else { $aloption[] = 'string-contains=' . $variant; - + // IE and some other browsers use another form of language code // in their Accept-Language header, like "zh-CN" or "zh-TW". // We should handle these too. @@ -1442,6 +1541,41 @@ class OutputPage { } } + /** + * Set a flag which will cause an X-Frame-Options header appropriate for + * edit pages to be sent. The header value is controlled by + * $wgEditPageFrameOptions. + * + * This is the default for special pages. If you display a CSRF-protected + * form on an ordinary view page, then you need to call this function. + */ + public function preventClickjacking( $enable = true ) { + $this->mPreventClickjacking = $enable; + } + + /** + * Turn off frame-breaking. Alias for $this->preventClickjacking(false). + * This can be called from pages which do not contain any CSRF-protected + * HTML form. + */ + public function allowClickjacking() { + $this->mPreventClickjacking = false; + } + + /** + * Get the X-Frame-Options header value (without the name part), or false + * if there isn't one. This is used by Skin to determine whether to enable + * JavaScript frame-breaking, for clients that don't support X-Frame-Options. + */ + public function getFrameOptions() { + global $wgBreakFrames, $wgEditPageFrameOptions; + if ( $wgBreakFrames ) { + return 'DENY'; + } elseif ( $this->mPreventClickjacking && $wgEditPageFrameOptions ) { + return $wgEditPageFrameOptions; + } + } + /** * Send cache control HTTP headers */ @@ -1578,7 +1712,6 @@ class OutputPage { global $wgLanguageCode, $wgDebugRedirects, $wgMimeType; global $wgUseAjax, $wgAjaxWatch; global $wgEnableMWSuggest, $wgUniversalEditButton; - global $wgArticle; if( $this->mDoNothing ) { return; @@ -1617,8 +1750,7 @@ class OutputPage { $sk = $wgUser->getSkin(); // Add base resources - $this->addModules( array( 'mediawiki.legacy.wikibits' ) ); - $this->addModules( array( 'mediawiki.util' ) ); + $this->addModules( array( 'mediawiki.legacy.wikibits', 'mediawiki.util' ) ); // Add various resources if required if ( $wgUseAjax ) { @@ -1627,7 +1759,7 @@ class OutputPage { wfRunHooks( 'AjaxAddScript', array( &$this ) ); if( $wgAjaxWatch && $wgUser->isLoggedIn() ) { - $this->addModules( 'mediawiki.legacy.ajaxwatch' ); + $this->addModules( 'mediawiki.action.watch.ajax' ); } if ( $wgEnableMWSuggest && !$wgUser->getOption( 'disablesuggest', false ) ) { @@ -1640,7 +1772,7 @@ class OutputPage { } if( $wgUniversalEditButton ) { - if( isset( $wgArticle ) && $this->getTitle() && $this->getTitle()->quickUserCan( 'edit' ) + if( $this->isArticleRelated() && $this->getTitle() && $this->getTitle()->quickUserCan( 'edit' ) && ( $this->getTitle()->exists() || $this->getTitle()->quickUserCan( 'create' ) ) ) { // Original UniversalEditButton $msg = wfMsg( 'edit' ); @@ -1666,6 +1798,12 @@ class OutputPage { $wgRequest->response()->header( "Content-type: $wgMimeType; charset={$wgOutputEncoding}" ); $wgRequest->response()->header( 'Content-language: ' . $wgLanguageCode ); + // Prevent framing, if requested + $frameOptions = $this->getFrameOptions(); + if ( $frameOptions ) { + $wgRequest->response()->header( "X-Frame-Options: $frameOptions" ); + } + if ( $this->mArticleBodyOnly ) { $this->out( $this->mBodytext ); } else { @@ -1702,32 +1840,6 @@ class OutputPage { print $outs; } - /** - * @todo document - */ - public static function setEncodings() { - global $wgInputEncoding, $wgOutputEncoding; - - $wgInputEncoding = strtolower( $wgInputEncoding ); - - if ( empty( $_SERVER['HTTP_ACCEPT_CHARSET'] ) ) { - $wgOutputEncoding = strtolower( $wgOutputEncoding ); - return; - } - $wgOutputEncoding = $wgInputEncoding; - } - - /** - * @deprecated use wfReportTime() instead. - * - * @return String - */ - public function reportTime() { - wfDeprecated( __METHOD__ ); - $time = wfReportTime(); - return $time; - } - /** * Produce a "user is blocked" page. * @@ -1818,9 +1930,7 @@ class OutputPage { $this->mRedirect = ''; $this->mBodytext = ''; - array_unshift( $params, 'parse' ); - array_unshift( $params, $msg ); - $this->addHTML( call_user_func_array( 'wfMsgExt', $params ) ); + $this->addWikiMsgArray( $msg, $params ); $this->returnToMain(); } @@ -1905,7 +2015,7 @@ class OutputPage { $this->setPageTitle( wfMsg( 'loginreqtitle' ) ); $this->setHtmlTitle( wfMsg( 'errorpagetitle' ) ); $this->setRobotPolicy( 'noindex,nofollow' ); - $this->setArticleFlag( false ); + $this->setArticleRelated( false ); $loginTitle = SpecialPage::getTitleFor( 'Userlogin' ); $loginLink = $skin->link( @@ -2065,53 +2175,6 @@ class OutputPage { $this->addModules( 'mediawiki.legacy.password' ); } - /** @deprecated */ - public function errorpage( $title, $msg ) { - wfDeprecated( __METHOD__ ); - throw new ErrorPageError( $title, $msg ); - } - - /** @deprecated */ - public function databaseError( $fname, $sql, $error, $errno ) { - throw new MWException( "OutputPage::databaseError is obsolete\n" ); - } - - /** @deprecated */ - public function fatalError( $message ) { - wfDeprecated( __METHOD__ ); - throw new FatalError( $message ); - } - - /** @deprecated */ - public function unexpectedValueError( $name, $val ) { - wfDeprecated( __METHOD__ ); - throw new FatalError( wfMsg( 'unexpected', $name, $val ) ); - } - - /** @deprecated */ - public function fileCopyError( $old, $new ) { - wfDeprecated( __METHOD__ ); - throw new FatalError( wfMsg( 'filecopyerror', $old, $new ) ); - } - - /** @deprecated */ - public function fileRenameError( $old, $new ) { - wfDeprecated( __METHOD__ ); - throw new FatalError( wfMsg( 'filerenameerror', $old, $new ) ); - } - - /** @deprecated */ - public function fileDeleteError( $name ) { - wfDeprecated( __METHOD__ ); - throw new FatalError( wfMsg( 'filedeleteerror', $name ) ); - } - - /** @deprecated */ - public function fileNotFoundError( $name ) { - wfDeprecated( __METHOD__ ); - throw new FatalError( wfMsg( 'filenotfound', $name ) ); - } - public function showFatalError( $message ) { $this->setPageTitle( wfMsg( 'internalerror' ) ); $this->setRobotPolicy( 'noindex,nofollow' ); @@ -2232,12 +2295,9 @@ class OutputPage { $ret .= implode( "\n", array( $this->getHeadLinks( $sk ), - $this->buildCssLinks(), - $this->getHeadItems(), + $this->buildCssLinks( $sk ), + $this->getHeadItems() ) ); - if ( $sk->usercss ) { - $ret .= Html::inlineStyle( $sk->usercss ); - } if ( $wgUseTrackbacks && $this->isArticleRelated() ) { $ret .= $this->getTitle()->trackbackRDF(); @@ -2309,7 +2369,7 @@ class OutputPage { */ protected function makeResourceLoaderLink( Skin $skin, $modules, $only, $useESI = false ) { global $wgUser, $wgLang, $wgLoadScript, $wgResourceLoaderUseESI, - $wgResourceLoaderInlinePrivateModules; + $wgResourceLoaderInlinePrivateModules, $wgRequest; // Lazy-load ResourceLoader // TODO: Should this be a static function of ResourceLoader instead? // TODO: Divide off modules starting with "user", and add the user parameter to them @@ -2319,17 +2379,24 @@ class OutputPage { 'skin' => $skin->getSkinName(), 'only' => $only, ); - + // Propagate printable and handheld parameters if present + if ( $wgRequest->getBool( 'printable' ) ) { + $query['printable'] = 1; + } + if ( $wgRequest->getBool( 'handheld' ) ) { + $query['handheld'] = 1; + } + if ( !count( $modules ) ) { return ''; } - + if ( count( $modules ) > 1 ) { // Remove duplicate module requests $modules = array_unique( (array) $modules ); // Sort module names so requests are more uniform sort( $modules ); - + if ( ResourceLoader::inDebugMode() ) { // Recursively call us for every item $links = ''; @@ -2339,7 +2406,7 @@ class OutputPage { return $links; } } - + // Create keyed-by-group list of module objects from modules list $groups = array(); $resourceLoader = $this->getResourceLoader(); @@ -2436,10 +2503,10 @@ class OutputPage { // Modules requests - let the client calculate dependencies and batch requests as it likes if ( $this->getModules() ) { - $modules = FormatJson::encode( $this->getModules() ); $scripts .= Html::inlineScript( ResourceLoader::makeLoaderConditionalScript( - "mediaWiki.loader.load( {$modules} ); mediaWiki.loader.go();" + Xml::encodeJsCall( 'mediaWiki.loader.load', array( $this->getModules() ) ) . + Xml::encodeJsCall( 'mediaWiki.loader.go', array() ) ) ) . "\n"; } @@ -2458,7 +2525,7 @@ class OutputPage { $action = $wgRequest->getVal( 'action', 'view' ); if( $this->mTitle && $this->mTitle->isJsSubpage() && $sk->userCanPreview( $action ) ) { # XXX: additional security check/prompt? - $this->addInlineScript( $wgRequest->getText( 'wpTextbox1' ) ); + $scripts .= Html::inlineScript( "\n" . $wgRequest->getText( 'wpTextbox1' ) . "\n" ) . "\n"; } else { $scripts .= $this->makeResourceLoaderLink( $sk, array( 'user', 'user.options' ), 'scripts' @@ -2469,7 +2536,7 @@ class OutputPage { if ( !$userOptionsAdded ) { $scripts .= $this->makeResourceLoaderLink( $sk, 'user.options', 'scripts' ); } - + return $scripts; } @@ -2587,15 +2654,6 @@ class OutputPage { } } } - - // Add styles to tags, pushing user modules to the end - $styles = array( array(), array() ); - foreach ( $this->getModuleStyles() as $module ) { - $styles[strpos( 'user', $module ) === 0 ? 1 : 0][] = $module; - } - $tags[] = $this->makeResourceLoaderLink( $sk, $styles[0], 'styles' ); - $tags[] = $this->makeResourceLoaderLink( $sk, $styles[1], 'styles' ); - return implode( "\n", $tags ); } @@ -2646,15 +2704,42 @@ class OutputPage { * @param $style_css Mixed: inline CSS */ public function addInlineStyle( $style_css ){ - $this->mScripts .= Html::inlineStyle( $style_css ); + $this->mInlineStyles .= Html::inlineStyle( $style_css ); } /** * Build a set of <link>s for the stylesheets specified in the $this->styles array. * These will be applied to various media & IE conditionals. + * @param $sk Skin object */ - public function buildCssLinks() { - return implode( "\n", $this->buildCssLinksArray() ); + public function buildCssLinks( $sk ) { + $ret = ''; + // Add ResourceLoader styles + // Split the styles into three groups + $styles = array( 'other' => array(), 'user' => array(), 'site' => array() ); + $resourceLoader = $this->getResourceLoader(); + foreach ( $this->getModuleStyles() as $name ) { + $group = $resourceLoader->getModule( $name )->getGroup(); + // Modules in groups named "other" or anything different than "user" or "site" will + // be placed in the "other" group + $styles[isset( $styles[$group] ) ? $group : 'other'][] = $name; + } + + // We want site and user styles to override dynamically added styles from modules, but we want + // dynamically added styles to override statically added styles from other modules. So the order + // has to be other, dynamic, site, user + // Add statically added styles for other modules + $ret .= $this->makeResourceLoaderLink( $sk, $styles['other'], 'styles' ); + // Add normal styles added through addStyle()/addInlineStyle() here + $ret .= implode( "\n", $this->buildCssLinksArray() ) . $this->mInlineStyles; + // Add marker tag to mark the place where the client-side loader should inject dynamic styles + // We use a <meta> tag with a made-up name for this because that's valid HTML + $ret .= Html::element( 'meta', array( 'name' => 'ResourceLoaderDynamicStyles', 'content' => '' ) ); + // Add site and user styles + $ret .= $this->makeResourceLoaderLink( + $sk, array_merge( $styles['site'], $styles['user'] ), 'styles' + ); + return $ret; } public function buildCssLinksArray() { @@ -2685,7 +2770,7 @@ class OutputPage { } if( isset( $options['media'] ) ) { - $media = $this->transformCssMedia( $options['media'] ); + $media = self::transformCssMedia( $options['media'] ); if( is_null( $media ) ) { return ''; } @@ -2717,7 +2802,7 @@ class OutputPage { * @param $media String: current value of the "media" attribute * @return String: modified value of the "media" attribute */ - function transformCssMedia( $media ) { + public static function transformCssMedia( $media ) { global $wgRequest, $wgHandheldForIPhone; // Switch in on-screen display for media testing @@ -2866,7 +2951,7 @@ class OutputPage { * @param $modules Array: list of jQuery modules which should be loaded * @return Array: the list of modules which were not loaded. * @since 1.16 - * @deprecated No longer needed as of 1.17 + * @deprecated @since 1.17 */ public function includeJQuery( $modules = array() ) { return array();