dépôts / lhc / web / wiklou.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
history | raw | HEAD
Revert "Release notes for aacdb664a10"
[lhc/web/wiklou.git] / includes / OutputPage.php
1 <?php
2 /**
3 * Preparation for the final page rendering.
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
19 *
20 * @file
21 */
22
23 /**
24 * This class should be covered by a general architecture document which does
25 * not exist as of January 2011. This is one of the Core classes and should
26 * be read at least once by any new developers.
27 *
28 * This class is used to prepare the final rendering. A skin is then
29 * applied to the output parameters (links, javascript, html, categories ...).
30 *
31 * @todo FIXME: Another class handles sending the whole page to the client.
32 *
33 * Some comments comes from a pairing session between Zak Greant and Antoine Musso
34 * in November 2010.
35 *
36 * @todo document
37 */
38 class OutputPage extends ContextSource {
39 /** @var array Should be private. Used with addMeta() which adds "<meta>" */
40 protected $mMetatags = array();
41
42 /** @var array */
43 protected $mLinktags = array();
44
45 /** @var bool */
46 protected $mCanonicalUrl = false;
47
48 /**
49 * @var array Additional stylesheets. Looks like this is for extensions.
50 * Might be replaced by resource loader.
51 */
52 protected $mExtStyles = array();
53
54 /**
55 * @var string Should be private - has getter and setter. Contains
56 * the HTML title */
57 public $mPagetitle = '';
58
59 /**
60 * @var string Contains all of the "<body>" content. Should be private we
61 * got set/get accessors and the append() method.
62 */
63 public $mBodytext = '';
64
65 /**
66 * Holds the debug lines that will be output as comments in page source if
67 * $wgDebugComments is enabled. See also $wgShowDebug.
68 * @deprecated since 1.20; use MWDebug class instead.
69 */
70 public $mDebugtext = '';
71
72 /** @var string Stores contents of "<title>" tag */
73 private $mHTMLtitle = '';
74
75 /**
76 * @var bool Is the displayed content related to the source of the
77 * corresponding wiki article.
78 */
79 private $mIsarticle = false;
80
81 /** @var bool Stores "article flag" toggle. */
82 private $mIsArticleRelated = true;
83
84 /**
85 * @var bool We have to set isPrintable(). Some pages should
86 * never be printed (ex: redirections).
87 */
88 private $mPrintable = false;
89
90 /**
91 * @var array Contains the page subtitle. Special pages usually have some
92 * links here. Don't confuse with site subtitle added by skins.
93 */
94 private $mSubtitle = array();
95
96 /** @var string */
97 public $mRedirect = '';
98
99 /** @var int */
100 protected $mStatusCode;
101
102 /**
103 * @var string Variable mLastModified and mEtag are used for sending cache control.
104 * The whole caching system should probably be moved into its own class.
105 */
106 protected $mLastModified = '';
107
108 /**
109 * Contains an HTTP Entity Tags (see RFC 2616 section 3.13) which is used
110 * as a unique identifier for the content. It is later used by the client
111 * to compare its cached version with the server version. Client sends
112 * headers If-Match and If-None-Match containing its locally cached ETAG value.
113 *
114 * To get more information, you will have to look at HTTP/1.1 protocol which
115 * is properly described in RFC 2616 : http://tools.ietf.org/html/rfc2616
116 */
117 private $mETag = false;
118
119 /** @var array */
120 protected $mCategoryLinks = array();
121
122 /** @var array */
123 protected $mCategories = array();
124
125 /** @var array */
126 protected $mIndicators = array();
127
128 /** @var array Array of Interwiki Prefixed (non DB key) Titles (e.g. 'fr:Test page') */
129 private $mLanguageLinks = array();
130
131 /**
132 * Used for JavaScript (pre resource loader)
133 * @todo We should split JS / CSS.
134 * mScripts content is inserted as is in "<head>" by Skin. This might
135 * contain either a link to a stylesheet or inline CSS.
136 */
137 private $mScripts = '';
138
139 /** @var string Inline CSS styles. Use addInlineStyle() sparingly */
140 protected $mInlineStyles = '';
141
142 /** @todo Unused? */
143 private $mLinkColours;
144
145 /**
146 * @var string Used by skin template.
147 * Example: $tpl->set( 'displaytitle', $out->mPageLinkTitle );
148 */
149 public $mPageLinkTitle = '';
150
151 /** @var array Array of elements in "<head>". Parser might add its own headers! */
152 protected $mHeadItems = array();
153
154 // @todo FIXME: Next 5 variables probably come from the resource loader
155
156 /** @var array */
157 protected $mModules = array();
158
159 /** @var array */
160 protected $mModuleScripts = array();
161
162 /** @var array */
163 protected $mModuleStyles = array();
164
165 /** @var array */
166 protected $mModuleMessages = array();
167
168 /** @var ResourceLoader */
169 protected $mResourceLoader;
170
171 /** @var array */
172 protected $mJsConfigVars = array();
173
174 /** @var array */
175 protected $mTemplateIds = array();
176
177 /** @var array */
178 protected $mImageTimeKeys = array();
179
180 /** @var string */
181 public $mRedirectCode = '';
182
183 protected $mFeedLinksAppendQuery = null;
184
185 /** @var array
186 * What level of 'untrustworthiness' is allowed in CSS/JS modules loaded on this page?
187 * @see ResourceLoaderModule::$origin
188 * ResourceLoaderModule::ORIGIN_ALL is assumed unless overridden;
189 */
190 protected $mAllowedModules = array(
191 ResourceLoaderModule::TYPE_COMBINED => ResourceLoaderModule::ORIGIN_ALL,
192 );
193
194 /** @var bool Whether output is disabled. If this is true, the 'output' method will do nothing. */
195 protected $mDoNothing = false;
196
197 // Parser related.
198
199 /** @var int */
200 protected $mContainsNewMagic = 0;
201
202 /**
203 * lazy initialised, use parserOptions()
204 * @var ParserOptions
205 */
206 protected $mParserOptions = null;
207
208 /**
209 * Handles the Atom / RSS links.
210 * We probably only support Atom in 2011.
211 * @see $wgAdvertisedFeedTypes
212 */
213 private $mFeedLinks = array();
214
215 // Gwicke work on squid caching? Roughly from 2003.
216 protected $mEnableClientCache = true;
217
218 /** @var bool Flag if output should only contain the body of the article. */
219 private $mArticleBodyOnly = false;
220
221 /** @var bool */
222 protected $mNewSectionLink = false;
223
224 /** @var bool */
225 protected $mHideNewSectionLink = false;
226
227 /**
228 * @var bool Comes from the parser. This was probably made to load CSS/JS
229 * only if we had "<gallery>". Used directly in CategoryPage.php.
230 * Looks like resource loader can replace this.
231 */
232 public $mNoGallery = false;
233
234 /** @var string */
235 private $mPageTitleActionText = '';
236
237 /** @var array */
238 private $mParseWarnings = array();
239
240 /** @var int Cache stuff. Looks like mEnableClientCache */
241 protected $mSquidMaxage = 0;
242
243 /**
244 * @var bool Controls if anti-clickjacking / frame-breaking headers will
245 * be sent. This should be done for pages where edit actions are possible.
246 * Setters: $this->preventClickjacking() and $this->allowClickjacking().
247 */
248 protected $mPreventClickjacking = true;
249
250 /** @var int To include the variable {{REVISIONID}} */
251 private $mRevisionId = null;
252
253 /** @var string */
254 private $mRevisionTimestamp = null;
255
256 /** @var array */
257 protected $mFileVersion = null;
258
259 /**
260 * @var array An array of stylesheet filenames (relative from skins path),
261 * with options for CSS media, IE conditions, and RTL/LTR direction.
262 * For internal use; add settings in the skin via $this->addStyle()
263 *
264 * Style again! This seems like a code duplication since we already have
265 * mStyles. This is what makes Open Source amazing.
266 */
267 protected $styles = array();
268
269 /**
270 * Whether jQuery is already handled.
271 */
272 protected $mJQueryDone = false;
273
274 private $mIndexPolicy = 'index';
275 private $mFollowPolicy = 'follow';
276 private $mVaryHeader = array(
277 'Accept-Encoding' => array( 'list-contains=gzip' ),
278 );
279
280 /**
281 * If the current page was reached through a redirect, $mRedirectedFrom contains the Title
282 * of the redirect.
283 *
284 * @var Title
285 */
286 private $mRedirectedFrom = null;
287
288 /**
289 * Additional key => value data
290 */
291 private $mProperties = array();
292
293 /**
294 * @var string|null ResourceLoader target for load.php links. If null, will be omitted
295 */
296 private $mTarget = null;
297
298 /**
299 * @var bool Whether parser output should contain table of contents
300 */
301 private $mEnableTOC = true;
302
303 /**
304 * @var bool Whether parser output should contain section edit links
305 */
306 private $mEnableSectionEditLinks = true;
307
308 /**
309 * Constructor for OutputPage. This should not be called directly.
310 * Instead a new RequestContext should be created and it will implicitly create
311 * a OutputPage tied to that context.
312 * @param IContextSource|null $context
313 */
314 function __construct( IContextSource $context = null ) {
315 if ( $context === null ) {
316 # Extensions should use `new RequestContext` instead of `new OutputPage` now.
317 wfDeprecated( __METHOD__, '1.18' );
318 } else {
319 $this->setContext( $context );
320 }
321 }
322
323 /**
324 * Redirect to $url rather than displaying the normal page
325 *
326 * @param string $url URL
327 * @param string $responsecode HTTP status code
328 */
329 public function redirect( $url, $responsecode = '302' ) {
330 # Strip newlines as a paranoia check for header injection in PHP<5.1.2
331 $this->mRedirect = str_replace( "\n", '', $url );
332 $this->mRedirectCode = $responsecode;
333 }
334
335 /**
336 * Get the URL to redirect to, or an empty string if not redirect URL set
337 *
338 * @return string
339 */
340 public function getRedirect() {
341 return $this->mRedirect;
342 }
343
344 /**
345 * Set the HTTP status code to send with the output.
346 *
347 * @param int $statusCode
348 */
349 public function setStatusCode( $statusCode ) {
350 $this->mStatusCode = $statusCode;
351 }
352
353 /**
354 * Add a new "<meta>" tag
355 * To add an http-equiv meta tag, precede the name with "http:"
356 *
357 * @param string $name Tag name
358 * @param string $val Tag value
359 */
360 function addMeta( $name, $val ) {
361 array_push( $this->mMetatags, array( $name, $val ) );
362 }
363
364 /**
365 * Returns the current <meta> tags
366 *
367 * @since 1.25
368 * @return array
369 */
370 public function getMetaTags() {
371 return $this->mMetatags;
372 }
373
374 /**
375 * Add a new \<link\> tag to the page header.
376 *
377 * Note: use setCanonicalUrl() for rel=canonical.
378 *
379 * @param array $linkarr Associative array of attributes.
380 */
381 function addLink( array $linkarr ) {
382 array_push( $this->mLinktags, $linkarr );
383 }
384
385 /**
386 * Returns the current <link> tags
387 *
388 * @since 1.25
389 * @return array
390 */
391 public function getLinkTags() {
392 return $this->mLinktags;
393 }
394
395 /**
396 * Add a new \<link\> with "rel" attribute set to "meta"
397 *
398 * @param array $linkarr Associative array mapping attribute names to their
399 * values, both keys and values will be escaped, and the
400 * "rel" attribute will be automatically added
401 */
402 function addMetadataLink( array $linkarr ) {
403 $linkarr['rel'] = $this->getMetadataAttribute();
404 $this->addLink( $linkarr );
405 }
406
407 /**
408 * Set the URL to be used for the <link rel=canonical>. This should be used
409 * in preference to addLink(), to avoid duplicate link tags.
410 * @param string $url
411 */
412 function setCanonicalUrl( $url ) {
413 $this->mCanonicalUrl = $url;
414 }
415
416 /**
417 * Returns the URL to be used for the <link rel=canonical> if
418 * one is set.
419 *
420 * @since 1.25
421 * @return bool|string
422 */
423 public function getCanonicalUrl() {
424 return $this->mCanonicalUrl;
425 }
426
427 /**
428 * Get the value of the "rel" attribute for metadata links
429 *
430 * @return string
431 */
432 public function getMetadataAttribute() {
433 # note: buggy CC software only reads first "meta" link
434 static $haveMeta = false;
435 if ( $haveMeta ) {
436 return 'alternate meta';
437 } else {
438 $haveMeta = true;
439 return 'meta';
440 }
441 }
442
443 /**
444 * Add raw HTML to the list of scripts (including \<script\> tag, etc.)
445 *
446 * @param string $script Raw HTML
447 */
448 function addScript( $script ) {
449 $this->mScripts .= $script . "\n";
450 }
451
452 /**
453 * Register and add a stylesheet from an extension directory.
454 *
455 * @param string $url Path to sheet. Provide either a full url (beginning
456 * with 'http', etc) or a relative path from the document root
457 * (beginning with '/'). Otherwise it behaves identically to
458 * addStyle() and draws from the /skins folder.
459 */
460 public function addExtensionStyle( $url ) {
461 array_push( $this->mExtStyles, $url );
462 }
463
464 /**
465 * Get all styles added by extensions
466 *
467 * @return array
468 */
469 function getExtStyle() {
470 return $this->mExtStyles;
471 }
472
473 /**
474 * Add a JavaScript file out of skins/common, or a given relative path.
475 *
476 * @param string $file Filename in skins/common or complete on-server path
477 * (/foo/bar.js)
478 * @param string $version Style version of the file. Defaults to $wgStyleVersion
479 */
480 public function addScriptFile( $file, $version = null ) {
481 // See if $file parameter is an absolute URL or begins with a slash
482 if ( substr( $file, 0, 1 ) == '/' || preg_match( '#^[a-z]*://#i', $file ) ) {
483 $path = $file;
484 } else {
485 $path = $this->getConfig()->get( 'StylePath' ) . "/common/{$file}";
486 }
487 if ( is_null( $version ) ) {
488 $version = $this->getConfig()->get( 'StyleVersion' );
489 }
490 $this->addScript( Html::linkedScript( wfAppendQuery( $path, $version ) ) );
491 }
492
493 /**
494 * Add a self-contained script tag with the given contents
495 *
496 * @param string $script JavaScript text, no "<script>" tags
497 */
498 public function addInlineScript( $script ) {
499 $this->mScripts .= Html::inlineScript( "\n$script\n" ) . "\n";
500 }
501
502 /**
503 * Get all registered JS and CSS tags for the header.
504 *
505 * @return string
506 * @deprecated since 1.24 Use OutputPage::headElement to build the full header.
507 */
508 function getScript() {
509 wfDeprecated( __METHOD__, '1.24' );
510 return $this->mScripts . $this->getHeadItems();
511 }
512
513 /**
514 * Filter an array of modules to remove insufficiently trustworthy members, and modules
515 * which are no longer registered (eg a page is cached before an extension is disabled)
516 * @param array $modules
517 * @param string|null $position If not null, only return modules with this position
518 * @param string $type
519 * @return array
520 */
521 protected function filterModules( array $modules, $position = null,
522 $type = ResourceLoaderModule::TYPE_COMBINED
523 ) {
524 $resourceLoader = $this->getResourceLoader();
525 $filteredModules = array();
526 foreach ( $modules as $val ) {
527 $module = $resourceLoader->getModule( $val );
528 if ( $module instanceof ResourceLoaderModule
529 && $module->getOrigin() <= $this->getAllowedModules( $type )
530 && ( is_null( $position ) || $module->getPosition() == $position )
531 && ( !$this->mTarget || in_array( $this->mTarget, $module->getTargets() ) )
532 ) {
533 $filteredModules[] = $val;
534 }
535 }
536 return $filteredModules;
537 }
538
539 /**
540 * Get the list of modules to include on this page
541 *
542 * @param bool $filter Whether to filter out insufficiently trustworthy modules
543 * @param string|null $position If not null, only return modules with this position
544 * @param string $param
545 * @return array Array of module names
546 */
547 public function getModules( $filter = false, $position = null, $param = 'mModules' ) {
548 $modules = array_values( array_unique( $this->$param ) );
549 return $filter
550 ? $this->filterModules( $modules, $position )
551 : $modules;
552 }
553
554 /**
555 * Add one or more modules recognized by the resource loader. Modules added
556 * through this function will be loaded by the resource loader when the
557 * page loads.
558 *
559 * @param string|array $modules Module name (string) or array of module names
560 */
561 public function addModules( $modules ) {
562 $this->mModules = array_merge( $this->mModules, (array)$modules );
563 }
564
565 /**
566 * Get the list of module JS to include on this page
567 *
568 * @param bool $filter
569 * @param string|null $position
570 *
571 * @return array Array of module names
572 */
573 public function getModuleScripts( $filter = false, $position = null ) {
574 return $this->getModules( $filter, $position, 'mModuleScripts' );
575 }
576
577 /**
578 * Add only JS of one or more modules recognized by the resource loader. Module
579 * scripts added through this function will be loaded by the resource loader when
580 * the page loads.
581 *
582 * @param string|array $modules Module name (string) or array of module names
583 */
584 public function addModuleScripts( $modules ) {
585 $this->mModuleScripts = array_merge( $this->mModuleScripts, (array)$modules );
586 }
587
588 /**
589 * Get the list of module CSS to include on this page
590 *
591 * @param bool $filter
592 * @param string|null $position
593 *
594 * @return array Array of module names
595 */
596 public function getModuleStyles( $filter = false, $position = null ) {
597 return $this->getModules( $filter, $position, 'mModuleStyles' );
598 }
599
600 /**
601 * Add only CSS of one or more modules recognized by the resource loader.
602 *
603 * Module styles added through this function will be added using standard link CSS
604 * tags, rather than as a combined Javascript and CSS package. Thus, they will
605 * load when JavaScript is disabled (unless CSS also happens to be disabled).
606 *
607 * @param string|array $modules Module name (string) or array of module names
608 */
609 public function addModuleStyles( $modules ) {
610 $this->mModuleStyles = array_merge( $this->mModuleStyles, (array)$modules );
611 }
612
613 /**
614 * Get the list of module messages to include on this page
615 *
616 * @param bool $filter
617 * @param string|null $position
618 *
619 * @return array Array of module names
620 */
621 public function getModuleMessages( $filter = false, $position = null ) {
622 return $this->getModules( $filter, $position, 'mModuleMessages' );
623 }
624
625 /**
626 * Add only messages of one or more modules recognized by the resource loader.
627 * Module messages added through this function will be loaded by the resource
628 * loader when the page loads.
629 *
630 * @param string|array $modules Module name (string) or array of module names
631 */
632 public function addModuleMessages( $modules ) {
633 $this->mModuleMessages = array_merge( $this->mModuleMessages, (array)$modules );
634 }
635
636 /**
637 * @return null|string ResourceLoader target
638 */
639 public function getTarget() {
640 return $this->mTarget;
641 }
642
643 /**
644 * Sets ResourceLoader target for load.php links. If null, will be omitted
645 *
646 * @param string|null $target
647 */
648 public function setTarget( $target ) {
649 $this->mTarget = $target;
650 }
651
652 /**
653 * Get an array of head items
654 *
655 * @return array
656 */
657 function getHeadItemsArray() {
658 return $this->mHeadItems;
659 }
660
661 /**
662 * Get all header items in a string
663 *
664 * @return string
665 * @deprecated since 1.24 Use OutputPage::headElement or
666 * if absolutely necessary use OutputPage::getHeadItemsArray
667 */
668 function getHeadItems() {
669 wfDeprecated( __METHOD__, '1.24' );
670 $s = '';
671 foreach ( $this->mHeadItems as $item ) {
672 $s .= $item;
673 }
674 return $s;
675 }
676
677 /**
678 * Add or replace an header item to the output
679 *
680 * @param string $name Item name
681 * @param string $value Raw HTML
682 */
683 public function addHeadItem( $name, $value ) {
684 $this->mHeadItems[$name] = $value;
685 }
686
687 /**
688 * Check if the header item $name is already set
689 *
690 * @param string $name Item name
691 * @return bool
692 */
693 public function hasHeadItem( $name ) {
694 return isset( $this->mHeadItems[$name] );
695 }
696
697 /**
698 * Set the value of the ETag HTTP header, only used if $wgUseETag is true
699 *
700 * @param string $tag Value of "ETag" header
701 */
702 function setETag( $tag ) {
703 $this->mETag = $tag;
704 }
705
706 /**
707 * Set whether the output should only contain the body of the article,
708 * without any skin, sidebar, etc.
709 * Used e.g. when calling with "action=render".
710 *
711 * @param bool $only Whether to output only the body of the article
712 */
713 public function setArticleBodyOnly( $only ) {
714 $this->mArticleBodyOnly = $only;
715 }
716
717 /**
718 * Return whether the output will contain only the body of the article
719 *
720 * @return bool
721 */
722 public function getArticleBodyOnly() {
723 return $this->mArticleBodyOnly;
724 }
725
726 /**
727 * Set an additional output property
728 * @since 1.21
729 *
730 * @param string $name
731 * @param mixed $value
732 */
733 public function setProperty( $name, $value ) {
734 $this->mProperties[$name] = $value;
735 }
736
737 /**
738 * Get an additional output property
739 * @since 1.21
740 *
741 * @param string $name
742 * @return mixed Property value or null if not found
743 */
744 public function getProperty( $name ) {
745 if ( isset( $this->mProperties[$name] ) ) {
746 return $this->mProperties[$name];
747 } else {
748 return null;
749 }
750 }
751
752 /**
753 * checkLastModified tells the client to use the client-cached page if
754 * possible. If successful, the OutputPage is disabled so that
755 * any future call to OutputPage->output() have no effect.
756 *
757 * Side effect: sets mLastModified for Last-Modified header
758 *
759 * @param string $timestamp
760 *
761 * @return bool True if cache-ok headers was sent.
762 */
763 public function checkLastModified( $timestamp ) {
764 if ( !$timestamp || $timestamp == '19700101000000' ) {
765 wfDebug( __METHOD__ . ": CACHE DISABLED, NO TIMESTAMP\n" );
766 return false;
767 }
768 $config = $this->getConfig();
769 if ( !$config->get( 'CachePages' ) ) {
770 wfDebug( __METHOD__ . ": CACHE DISABLED\n" );
771 return false;
772 }
773
774 $timestamp = wfTimestamp( TS_MW, $timestamp );
775 $modifiedTimes = array(
776 'page' => $timestamp,
777 'user' => $this->getUser()->getTouched(),
778 'epoch' => $config->get( 'CacheEpoch' )
779 );
780 if ( $config->get( 'UseSquid' ) ) {
781 // bug 44570: the core page itself may not change, but resources might
782 $modifiedTimes['sepoch'] = wfTimestamp( TS_MW, time() - $config->get( 'SquidMaxage' ) );
783 }
784 Hooks::run( 'OutputPageCheckLastModified', array( &$modifiedTimes ) );
785
786 $maxModified = max( $modifiedTimes );
787 $this->mLastModified = wfTimestamp( TS_RFC2822, $maxModified );
788
789 $clientHeader = $this->getRequest()->getHeader( 'If-Modified-Since' );
790 if ( $clientHeader === false ) {
791 wfDebug( __METHOD__ . ": client did not send If-Modified-Since header\n", 'log' );
792 return false;
793 }
794
795 # IE sends sizes after the date like this:
796 # Wed, 20 Aug 2003 06:51:19 GMT; length=5202
797 # this breaks strtotime().
798 $clientHeader = preg_replace( '/;.*$/', '', $clientHeader );
799
800 wfSuppressWarnings(); // E_STRICT system time bitching
801 $clientHeaderTime = strtotime( $clientHeader );
802 wfRestoreWarnings();
803 if ( !$clientHeaderTime ) {
804 wfDebug( __METHOD__
805 . ": unable to parse the client's If-Modified-Since header: $clientHeader\n" );
806 return false;
807 }
808 $clientHeaderTime = wfTimestamp( TS_MW, $clientHeaderTime );
809
810 # Make debug info
811 $info = '';
812 foreach ( $modifiedTimes as $name => $value ) {
813 if ( $info !== '' ) {
814 $info .= ', ';
815 }
816 $info .= "$name=" . wfTimestamp( TS_ISO_8601, $value );
817 }
818
819 wfDebug( __METHOD__ . ": client sent If-Modified-Since: " .
820 wfTimestamp( TS_ISO_8601, $clientHeaderTime ) . "\n", 'log' );
821 wfDebug( __METHOD__ . ": effective Last-Modified: " .
822 wfTimestamp( TS_ISO_8601, $maxModified ) . "\n", 'log' );
823 if ( $clientHeaderTime < $maxModified ) {
824 wfDebug( __METHOD__ . ": STALE, $info\n", 'log' );
825 return false;
826 }
827
828 # Not modified
829 # Give a 304 response code and disable body output
830 wfDebug( __METHOD__ . ": NOT MODIFIED, $info\n", 'log' );
831 ini_set( 'zlib.output_compression', 0 );
832 $this->getRequest()->response()->header( "HTTP/1.1 304 Not Modified" );
833 $this->sendCacheControl();
834 $this->disable();
835
836 // Don't output a compressed blob when using ob_gzhandler;
837 // it's technically against HTTP spec and seems to confuse
838 // Firefox when the response gets split over two packets.
839 wfClearOutputBuffers();
840
841 return true;
842 }
843
844 /**
845 * Override the last modified timestamp
846 *
847 * @param string $timestamp New timestamp, in a format readable by
848 * wfTimestamp()
849 */
850 public function setLastModified( $timestamp ) {
851 $this->mLastModified = wfTimestamp( TS_RFC2822, $timestamp );
852 }
853
854 /**
855 * Set the robot policy for the page: <http://www.robotstxt.org/meta.html>
856 *
857 * @param string $policy The literal string to output as the contents of
858 * the meta tag. Will be parsed according to the spec and output in
859 * standardized form.
860 * @return null
861 */
862 public function setRobotPolicy( $policy ) {
863 $policy = Article::formatRobotPolicy( $policy );
864
865 if ( isset( $policy['index'] ) ) {
866 $this->setIndexPolicy( $policy['index'] );
867 }
868 if ( isset( $policy['follow'] ) ) {
869 $this->setFollowPolicy( $policy['follow'] );
870 }
871 }
872
873 /**
874 * Set the index policy for the page, but leave the follow policy un-
875 * touched.
876 *
877 * @param string $policy Either 'index' or 'noindex'.
878 * @return null
879 */
880 public function setIndexPolicy( $policy ) {
881 $policy = trim( $policy );
882 if ( in_array( $policy, array( 'index', 'noindex' ) ) ) {
883 $this->mIndexPolicy = $policy;
884 }
885 }
886
887 /**
888 * Set the follow policy for the page, but leave the index policy un-
889 * touched.
890 *
891 * @param string $policy Either 'follow' or 'nofollow'.
892 * @return null
893 */
894 public function setFollowPolicy( $policy ) {
895 $policy = trim( $policy );
896 if ( in_array( $policy, array( 'follow', 'nofollow' ) ) ) {
897 $this->mFollowPolicy = $policy;
898 }
899 }
900
901 /**
902 * Set the new value of the "action text", this will be added to the
903 * "HTML title", separated from it with " - ".
904 *
905 * @param string $text New value of the "action text"
906 */
907 public function setPageTitleActionText( $text ) {
908 $this->mPageTitleActionText = $text;
909 }
910
911 /**
912 * Get the value of the "action text"
913 *
914 * @return string
915 */
916 public function getPageTitleActionText() {
917 return $this->mPageTitleActionText;
918 }
919
920 /**
921 * "HTML title" means the contents of "<title>".
922 * It is stored as plain, unescaped text and will be run through htmlspecialchars in the skin file.
923 *
924 * @param string|Message $name
925 */
926 public function setHTMLTitle( $name ) {
927 if ( $name instanceof Message ) {
928 $this->mHTMLtitle = $name->setContext( $this->getContext() )->text();
929 } else {
930 $this->mHTMLtitle = $name;
931 }
932 }
933
934 /**
935 * Return the "HTML title", i.e. the content of the "<title>" tag.
936 *
937 * @return string
938 */
939 public function getHTMLTitle() {
940 return $this->mHTMLtitle;
941 }
942
943 /**
944 * Set $mRedirectedFrom, the Title of the page which redirected us to the current page.
945 *
946 * @param Title $t
947 */
948 public function setRedirectedFrom( $t ) {
949 $this->mRedirectedFrom = $t;
950 }
951
952 /**
953 * "Page title" means the contents of \<h1\>. It is stored as a valid HTML
954 * fragment. This function allows good tags like \<sup\> in the \<h1\> tag,
955 * but not bad tags like \<script\>. This function automatically sets
956 * \<title\> to the same content as \<h1\> but with all tags removed. Bad
957 * tags that were escaped in \<h1\> will still be escaped in \<title\>, and
958 * good tags like \<i\> will be dropped entirely.
959 *
960 * @param string|Message $name
961 */
962 public function setPageTitle( $name ) {
963 if ( $name instanceof Message ) {
964 $name = $name->setContext( $this->getContext() )->text();
965 }
966
967 # change "<script>foo&bar</script>" to "&lt;script&gt;foo&amp;bar&lt;/script&gt;"
968 # but leave "<i>foobar</i>" alone
969 $nameWithTags = Sanitizer::normalizeCharReferences( Sanitizer::removeHTMLtags( $name ) );
970 $this->mPagetitle = $nameWithTags;
971
972 # change "<i>foo&amp;bar</i>" to "foo&bar"
973 $this->setHTMLTitle(
974 $this->msg( 'pagetitle' )->rawParams( Sanitizer::stripAllTags( $nameWithTags ) )
975 ->inContentLanguage()
976 );
977 }
978
979 /**
980 * Return the "page title", i.e. the content of the \<h1\> tag.
981 *
982 * @return string
983 */
984 public function getPageTitle() {
985 return $this->mPagetitle;
986 }
987
988 /**
989 * Set the Title object to use
990 *
991 * @param Title $t
992 */
993 public function setTitle( Title $t ) {
994 $this->getContext()->setTitle( $t );
995 }
996
997 /**
998 * Replace the subtitle with $str
999 *
1000 * @param string|Message $str New value of the subtitle. String should be safe HTML.
1001 */
1002 public function setSubtitle( $str ) {
1003 $this->clearSubtitle();
1004 $this->addSubtitle( $str );
1005 }
1006
1007 /**
1008 * Add $str to the subtitle
1009 *
1010 * @deprecated since 1.19; use addSubtitle() instead
1011 * @param string|Message $str String or Message to add to the subtitle
1012 */
1013 public function appendSubtitle( $str ) {
1014 $this->addSubtitle( $str );
1015 }
1016
1017 /**
1018 * Add $str to the subtitle
1019 *
1020 * @param string|Message $str String or Message to add to the subtitle. String should be safe HTML.
1021 */
1022 public function addSubtitle( $str ) {
1023 if ( $str instanceof Message ) {
1024 $this->mSubtitle[] = $str->setContext( $this->getContext() )->parse();
1025 } else {
1026 $this->mSubtitle[] = $str;
1027 }
1028 }
1029
1030 /**
1031 * Build message object for a subtitle containing a backlink to a page
1032 *
1033 * @param Title $title Title to link to
1034 * @param array $query Array of additional parameters to include in the link
1035 * @return Message
1036 * @since 1.25
1037 */
1038 public static function buildBacklinkSubtitle( Title $title, $query = array() ) {
1039 if ( $title->isRedirect() ) {
1040 $query['redirect'] = 'no';
1041 }
1042 return wfMessage( 'backlinksubtitle' )
1043 ->rawParams( Linker::link( $title, null, array(), $query ) );
1044 }
1045
1046 /**
1047 * Add a subtitle containing a backlink to a page
1048 *
1049 * @param Title $title Title to link to
1050 * @param array $query Array of additional parameters to include in the link
1051 */
1052 public function addBacklinkSubtitle( Title $title, $query = array() ) {
1053 $this->addSubtitle( self::buildBacklinkSubtitle( $title, $query ) );
1054 }
1055
1056 /**
1057 * Clear the subtitles
1058 */
1059 public function clearSubtitle() {
1060 $this->mSubtitle = array();
1061 }
1062
1063 /**
1064 * Get the subtitle
1065 *
1066 * @return string
1067 */
1068 public function getSubtitle() {
1069 return implode( "<br />\n\t\t\t\t", $this->mSubtitle );
1070 }
1071
1072 /**
1073 * Set the page as printable, i.e. it'll be displayed with all
1074 * print styles included
1075 */
1076 public function setPrintable() {
1077 $this->mPrintable = true;
1078 }
1079
1080 /**
1081 * Return whether the page is "printable"
1082 *
1083 * @return bool
1084 */
1085 public function isPrintable() {
1086 return $this->mPrintable;
1087 }
1088
1089 /**
1090 * Disable output completely, i.e. calling output() will have no effect
1091 */
1092 public function disable() {
1093 $this->mDoNothing = true;
1094 }
1095
1096 /**
1097 * Return whether the output will be completely disabled
1098 *
1099 * @return bool
1100 */
1101 public function isDisabled() {
1102 return $this->mDoNothing;
1103 }
1104
1105 /**
1106 * Show an "add new section" link?
1107 *
1108 * @return bool
1109 */
1110 public function showNewSectionLink() {
1111 return $this->mNewSectionLink;
1112 }
1113
1114 /**
1115 * Forcibly hide the new section link?
1116 *
1117 * @return bool
1118 */
1119 public function forceHideNewSectionLink() {
1120 return $this->mHideNewSectionLink;
1121 }
1122
1123 /**
1124 * Add or remove feed links in the page header
1125 * This is mainly kept for backward compatibility, see OutputPage::addFeedLink()
1126 * for the new version
1127 * @see addFeedLink()
1128 *
1129 * @param bool $show True: add default feeds, false: remove all feeds
1130 */
1131 public function setSyndicated( $show = true ) {
1132 if ( $show ) {
1133 $this->setFeedAppendQuery( false );
1134 } else {
1135 $this->mFeedLinks = array();
1136 }
1137 }
1138
1139 /**
1140 * Add default feeds to the page header
1141 * This is mainly kept for backward compatibility, see OutputPage::addFeedLink()
1142 * for the new version
1143 * @see addFeedLink()
1144 *
1145 * @param string $val Query to append to feed links or false to output
1146 * default links
1147 */
1148 public function setFeedAppendQuery( $val ) {
1149 $this->mFeedLinks = array();
1150
1151 foreach ( $this->getConfig()->get( 'AdvertisedFeedTypes' ) as $type ) {
1152 $query = "feed=$type";
1153 if ( is_string( $val ) ) {
1154 $query .= '&' . $val;
1155 }
1156 $this->mFeedLinks[$type] = $this->getTitle()->getLocalURL( $query );
1157 }
1158 }
1159
1160 /**
1161 * Add a feed link to the page header
1162 *
1163 * @param string $format Feed type, should be a key of $wgFeedClasses
1164 * @param string $href URL
1165 */
1166 public function addFeedLink( $format, $href ) {
1167 if ( in_array( $format, $this->getConfig()->get( 'AdvertisedFeedTypes' ) ) ) {
1168 $this->mFeedLinks[$format] = $href;
1169 }
1170 }
1171
1172 /**
1173 * Should we output feed links for this page?
1174 * @return bool
1175 */
1176 public function isSyndicated() {
1177 return count( $this->mFeedLinks ) > 0;
1178 }
1179
1180 /**
1181 * Return URLs for each supported syndication format for this page.
1182 * @return array Associating format keys with URLs
1183 */
1184 public function getSyndicationLinks() {
1185 return $this->mFeedLinks;
1186 }
1187
1188 /**
1189 * Will currently always return null
1190 *
1191 * @return null
1192 */
1193 public function getFeedAppendQuery() {
1194 return $this->mFeedLinksAppendQuery;
1195 }
1196
1197 /**
1198 * Set whether the displayed content is related to the source of the
1199 * corresponding article on the wiki
1200 * Setting true will cause the change "article related" toggle to true
1201 *
1202 * @param bool $v
1203 */
1204 public function setArticleFlag( $v ) {
1205 $this->mIsarticle = $v;
1206 if ( $v ) {
1207 $this->mIsArticleRelated = $v;
1208 }
1209 }
1210
1211 /**
1212 * Return whether the content displayed page is related to the source of
1213 * the corresponding article on the wiki
1214 *
1215 * @return bool
1216 */
1217 public function isArticle() {
1218 return $this->mIsarticle;
1219 }
1220
1221 /**
1222 * Set whether this page is related an article on the wiki
1223 * Setting false will cause the change of "article flag" toggle to false
1224 *
1225 * @param bool $v
1226 */
1227 public function setArticleRelated( $v ) {
1228 $this->mIsArticleRelated = $v;
1229 if ( !$v ) {
1230 $this->mIsarticle = false;
1231 }
1232 }
1233
1234 /**
1235 * Return whether this page is related an article on the wiki
1236 *
1237 * @return bool
1238 */
1239 public function isArticleRelated() {
1240 return $this->mIsArticleRelated;
1241 }
1242
1243 /**
1244 * Add new language links
1245 *
1246 * @param array $newLinkArray Associative array mapping language code to the page
1247 * name
1248 */
1249 public function addLanguageLinks( array $newLinkArray ) {
1250 $this->mLanguageLinks += $newLinkArray;
1251 }
1252
1253 /**
1254 * Reset the language links and add new language links
1255 *
1256 * @param array $newLinkArray Associative array mapping language code to the page
1257 * name
1258 */
1259 public function setLanguageLinks( array $newLinkArray ) {
1260 $this->mLanguageLinks = $newLinkArray;
1261 }
1262
1263 /**
1264 * Get the list of language links
1265 *
1266 * @return array Array of Interwiki Prefixed (non DB key) Titles (e.g. 'fr:Test page')
1267 */
1268 public function getLanguageLinks() {
1269 return $this->mLanguageLinks;
1270 }
1271
1272 /**
1273 * Add an array of categories, with names in the keys
1274 *
1275 * @param array $categories Mapping category name => sort key
1276 */
1277 public function addCategoryLinks( array $categories ) {
1278 global $wgContLang;
1279
1280 if ( !is_array( $categories ) || count( $categories ) == 0 ) {
1281 return;
1282 }
1283
1284 # Add the links to a LinkBatch
1285 $arr = array( NS_CATEGORY => $categories );
1286 $lb = new LinkBatch;
1287 $lb->setArray( $arr );
1288
1289 # Fetch existence plus the hiddencat property
1290 $dbr = wfGetDB( DB_SLAVE );
1291 $fields = array( 'page_id', 'page_namespace', 'page_title', 'page_len',
1292 'page_is_redirect', 'page_latest', 'pp_value' );
1293
1294 if ( $this->getConfig()->get( 'ContentHandlerUseDB' ) ) {
1295 $fields[] = 'page_content_model';
1296 }
1297
1298 $res = $dbr->select( array( 'page', 'page_props' ),
1299 $fields,
1300 $lb->constructSet( 'page', $dbr ),
1301 __METHOD__,
1302 array(),
1303 array( 'page_props' => array( 'LEFT JOIN', array(
1304 'pp_propname' => 'hiddencat',
1305 'pp_page = page_id'
1306 ) ) )
1307 );
1308
1309 # Add the results to the link cache
1310 $lb->addResultToCache( LinkCache::singleton(), $res );
1311
1312 # Set all the values to 'normal'.
1313 $categories = array_fill_keys( array_keys( $categories ), 'normal' );
1314
1315 # Mark hidden categories
1316 foreach ( $res as $row ) {
1317 if ( isset( $row->pp_value ) ) {
1318 $categories[$row->page_title] = 'hidden';
1319 }
1320 }
1321
1322 # Add the remaining categories to the skin
1323 if ( Hooks::run(
1324 'OutputPageMakeCategoryLinks',
1325 array( &$this, $categories, &$this->mCategoryLinks ) )
1326 ) {
1327 foreach ( $categories as $category => $type ) {
1328 $origcategory = $category;
1329 $title = Title::makeTitleSafe( NS_CATEGORY, $category );
1330 if ( !$title ) {
1331 continue;
1332 }
1333 $wgContLang->findVariantLink( $category, $title, true );
1334 if ( $category != $origcategory && array_key_exists( $category, $categories ) ) {
1335 continue;
1336 }
1337 $text = $wgContLang->convertHtml( $title->getText() );
1338 $this->mCategories[] = $title->getText();
1339 $this->mCategoryLinks[$type][] = Linker::link( $title, $text );
1340 }
1341 }
1342 }
1343
1344 /**
1345 * Reset the category links (but not the category list) and add $categories
1346 *
1347 * @param array $categories Mapping category name => sort key
1348 */
1349 public function setCategoryLinks( array $categories ) {
1350 $this->mCategoryLinks = array();
1351 $this->addCategoryLinks( $categories );
1352 }
1353
1354 /**
1355 * Get the list of category links, in a 2-D array with the following format:
1356 * $arr[$type][] = $link, where $type is either "normal" or "hidden" (for
1357 * hidden categories) and $link a HTML fragment with a link to the category
1358 * page
1359 *
1360 * @return array
1361 */
1362 public function getCategoryLinks() {
1363 return $this->mCategoryLinks;
1364 }
1365
1366 /**
1367 * Get the list of category names this page belongs to
1368 *
1369 * @return array Array of strings
1370 */
1371 public function getCategories() {
1372 return $this->mCategories;
1373 }
1374
1375 /**
1376 * Add an array of indicators, with their identifiers as array
1377 * keys and HTML contents as values.
1378 *
1379 * In case of duplicate keys, existing values are overwritten.
1380 *
1381 * @param array $indicators
1382 * @since 1.25
1383 */
1384 public function setIndicators( array $indicators ) {
1385 $this->mIndicators = $indicators + $this->mIndicators;
1386 // Keep ordered by key
1387 ksort( $this->mIndicators );
1388 }
1389
1390 /**
1391 * Get the indicators associated with this page.
1392 *
1393 * The array will be internally ordered by item keys.
1394 *
1395 * @return array Keys: identifiers, values: HTML contents
1396 * @since 1.25
1397 */
1398 public function getIndicators() {
1399 return $this->mIndicators;
1400 }
1401
1402 /**
1403 * Adds help link with an icon via page indicators.
1404 * @param string $to
1405 * @param bool $overrideBaseUrl
1406 * @since 1.25
1407 */
1408 public function addHelpLink( $to, $overrideBaseUrl = false ) {
1409 $this->addModuleStyles( 'mediawiki.helplink' );
1410 $text = $this->msg( 'helppage-top-gethelp' )->escaped();
1411
1412 if ( $overrideBaseUrl ) {
1413 $helpUrl = $to;
1414 } else {
1415 $toUrlencoded = wfUrlencode( str_replace( ' ', '_', $to ) );
1416 $helpUrl = "//www.mediawiki.org/wiki/Special:MyLanguage/$toUrlencoded";
1417 }
1418 $link = Html::rawElement(
1419 'a',
1420 array(
1421 'href' => $helpUrl,
1422 'target' => '_blank',
1423 'class' => 'mw-helplink',
1424 ),
1425 $text
1426 );
1427
1428 $this->setIndicators( array( 'mw-helplink' => $link ) );
1429 }
1430
1431 /**
1432 * Do not allow scripts which can be modified by wiki users to load on this page;
1433 * only allow scripts bundled with, or generated by, the software.
1434 * Site-wide styles are controlled by a config setting, since they can be
1435 * used to create a custom skin/theme, but not user-specific ones.
1436 *
1437 * @todo this should be given a more accurate name
1438 */
1439 public function disallowUserJs() {
1440 $this->reduceAllowedModules(
1441 ResourceLoaderModule::TYPE_SCRIPTS,
1442 ResourceLoaderModule::ORIGIN_CORE_INDIVIDUAL
1443 );
1444
1445 // Site-wide styles are controlled by a config setting, see bug 71621
1446 // for background on why. User styles are never allowed.
1447 if ( $this->getConfig()->get( 'AllowSiteCSSOnRestrictedPages' ) ) {
1448 $styleOrigin = ResourceLoaderModule::ORIGIN_USER_SITEWIDE;
1449 } else {
1450 $styleOrigin = ResourceLoaderModule::ORIGIN_CORE_INDIVIDUAL;
1451 }
1452 $this->reduceAllowedModules(
1453 ResourceLoaderModule::TYPE_STYLES,
1454 $styleOrigin
1455 );
1456 }
1457
1458 /**
1459 * Show what level of JavaScript / CSS untrustworthiness is allowed on this page
1460 * @see ResourceLoaderModule::$origin
1461 * @param string $type ResourceLoaderModule TYPE_ constant
1462 * @return int ResourceLoaderModule ORIGIN_ class constant
1463 */
1464 public function getAllowedModules( $type ) {
1465 if ( $type == ResourceLoaderModule::TYPE_COMBINED ) {
1466 return min( array_values( $this->mAllowedModules ) );
1467 } else {
1468 return isset( $this->mAllowedModules[$type] )
1469 ? $this->mAllowedModules[$type]
1470 : ResourceLoaderModule::ORIGIN_ALL;
1471 }
1472 }
1473
1474 /**
1475 * Set the highest level of CSS/JS untrustworthiness allowed
1476 *
1477 * @deprecated since 1.24 Raising level of allowed untrusted content is no longer supported.
1478 * Use reduceAllowedModules() instead
1479 * @param string $type ResourceLoaderModule TYPE_ constant
1480 * @param int $level ResourceLoaderModule class constant
1481 */
1482 public function setAllowedModules( $type, $level ) {
1483 wfDeprecated( __METHOD__, '1.24' );
1484 $this->reduceAllowedModules( $type, $level );
1485 }
1486
1487 /**
1488 * Limit the highest level of CSS/JS untrustworthiness allowed.
1489 *
1490 * If passed the same or a higher level than the current level of untrustworthiness set, the
1491 * level will remain unchanged.
1492 *
1493 * @param string $type
1494 * @param int $level ResourceLoaderModule class constant
1495 */
1496 public function reduceAllowedModules( $type, $level ) {
1497 $this->mAllowedModules[$type] = min( $this->getAllowedModules( $type ), $level );
1498 }
1499
1500 /**
1501 * Prepend $text to the body HTML
1502 *
1503 * @param string $text HTML
1504 */
1505 public function prependHTML( $text ) {
1506 $this->mBodytext = $text . $this->mBodytext;
1507 }
1508
1509 /**
1510 * Append $text to the body HTML
1511 *
1512 * @param string $text HTML
1513 */
1514 public function addHTML( $text ) {
1515 $this->mBodytext .= $text;
1516 }
1517
1518 /**
1519 * Shortcut for adding an Html::element via addHTML.
1520 *
1521 * @since 1.19
1522 *
1523 * @param string $element
1524 * @param array $attribs
1525 * @param string $contents
1526 */
1527 public function addElement( $element, array $attribs = array(), $contents = '' ) {
1528 $this->addHTML( Html::element( $element, $attribs, $contents ) );
1529 }
1530
1531 /**
1532 * Clear the body HTML
1533 */
1534 public function clearHTML() {
1535 $this->mBodytext = '';
1536 }
1537
1538 /**
1539 * Get the body HTML
1540 *
1541 * @return string HTML
1542 */
1543 public function getHTML() {
1544 return $this->mBodytext;
1545 }
1546
1547 /**
1548 * Get/set the ParserOptions object to use for wikitext parsing
1549 *
1550 * @param ParserOptions|null $options Either the ParserOption to use or null to only get the
1551 * current ParserOption object
1552 * @return ParserOptions
1553 */
1554 public function parserOptions( $options = null ) {
1555 if ( !$this->mParserOptions ) {
1556 $this->mParserOptions = ParserOptions::newFromContext( $this->getContext() );
1557 $this->mParserOptions->setEditSection( false );
1558 }
1559 return wfSetVar( $this->mParserOptions, $options );
1560 }
1561
1562 /**
1563 * Set the revision ID which will be seen by the wiki text parser
1564 * for things such as embedded {{REVISIONID}} variable use.
1565 *
1566 * @param int|null $revid An positive integer, or null
1567 * @return mixed Previous value
1568 */
1569 public function setRevisionId( $revid ) {
1570 $val = is_null( $revid ) ? null : intval( $revid );
1571 return wfSetVar( $this->mRevisionId, $val );
1572 }
1573
1574 /**
1575 * Get the displayed revision ID
1576 *
1577 * @return int
1578 */
1579 public function getRevisionId() {
1580 return $this->mRevisionId;
1581 }
1582
1583 /**
1584 * Set the timestamp of the revision which will be displayed. This is used
1585 * to avoid a extra DB call in Skin::lastModified().
1586 *
1587 * @param string|null $timestamp
1588 * @return mixed Previous value
1589 */
1590 public function setRevisionTimestamp( $timestamp ) {
1591 return wfSetVar( $this->mRevisionTimestamp, $timestamp );
1592 }
1593
1594 /**
1595 * Get the timestamp of displayed revision.
1596 * This will be null if not filled by setRevisionTimestamp().
1597 *
1598 * @return string|null
1599 */
1600 public function getRevisionTimestamp() {
1601 return $this->mRevisionTimestamp;
1602 }
1603
1604 /**
1605 * Set the displayed file version
1606 *
1607 * @param File|bool $file
1608 * @return mixed Previous value
1609 */
1610 public function setFileVersion( $file ) {
1611 $val = null;
1612 if ( $file instanceof File && $file->exists() ) {
1613 $val = array( 'time' => $file->getTimestamp(), 'sha1' => $file->getSha1() );
1614 }
1615 return wfSetVar( $this->mFileVersion, $val, true );
1616 }
1617
1618 /**
1619 * Get the displayed file version
1620 *
1621 * @return array|null ('time' => MW timestamp, 'sha1' => sha1)
1622 */
1623 public function getFileVersion() {
1624 return $this->mFileVersion;
1625 }
1626
1627 /**
1628 * Get the templates used on this page
1629 *
1630 * @return array (namespace => dbKey => revId)
1631 * @since 1.18
1632 */
1633 public function getTemplateIds() {
1634 return $this->mTemplateIds;
1635 }
1636
1637 /**
1638 * Get the files used on this page
1639 *
1640 * @return array (dbKey => array('time' => MW timestamp or null, 'sha1' => sha1 or ''))
1641 * @since 1.18
1642 */
1643 public function getFileSearchOptions() {
1644 return $this->mImageTimeKeys;
1645 }
1646
1647 /**
1648 * Convert wikitext to HTML and add it to the buffer
1649 * Default assumes that the current page title will be used.
1650 *
1651 * @param string $text
1652 * @param bool $linestart Is this the start of a line?
1653 * @param bool $interface Is this text in the user interface language?
1654 * @throws MWException
1655 */
1656 public function addWikiText( $text, $linestart = true, $interface = true ) {
1657 $title = $this->getTitle(); // Work around E_STRICT
1658 if ( !$title ) {
1659 throw new MWException( 'Title is null' );
1660 }
1661 $this->addWikiTextTitle( $text, $title, $linestart, /*tidy*/false, $interface );
1662 }
1663
1664 /**
1665 * Add wikitext with a custom Title object
1666 *
1667 * @param string $text Wikitext
1668 * @param Title $title
1669 * @param bool $linestart Is this the start of a line?
1670 */
1671 public function addWikiTextWithTitle( $text, &$title, $linestart = true ) {
1672 $this->addWikiTextTitle( $text, $title, $linestart );
1673 }
1674
1675 /**
1676 * Add wikitext with a custom Title object and tidy enabled.
1677 *
1678 * @param string $text Wikitext
1679 * @param Title $title
1680 * @param bool $linestart Is this the start of a line?
1681 */
1682 function addWikiTextTitleTidy( $text, &$title, $linestart = true ) {
1683 $this->addWikiTextTitle( $text, $title, $linestart, true );
1684 }
1685
1686 /**
1687 * Add wikitext with tidy enabled
1688 *
1689 * @param string $text Wikitext
1690 * @param bool $linestart Is this the start of a line?
1691 */
1692 public function addWikiTextTidy( $text, $linestart = true ) {
1693 $title = $this->getTitle();
1694 $this->addWikiTextTitleTidy( $text, $title, $linestart );
1695 }
1696
1697 /**
1698 * Add wikitext with a custom Title object
1699 *
1700 * @param string $text Wikitext
1701 * @param Title $title
1702 * @param bool $linestart Is this the start of a line?
1703 * @param bool $tidy Whether to use tidy
1704 * @param bool $interface Whether it is an interface message
1705 * (for example disables conversion)
1706 */
1707 public function addWikiTextTitle( $text, Title $title, $linestart,
1708 $tidy = false, $interface = false
1709 ) {
1710 global $wgParser;
1711
1712 $popts = $this->parserOptions();
1713 $oldTidy = $popts->setTidy( $tidy );
1714 $popts->setInterfaceMessage( (bool)$interface );
1715
1716 $parserOutput = $wgParser->getFreshParser()->parse(
1717 $text, $title, $popts,
1718 $linestart, true, $this->mRevisionId
1719 );
1720
1721 $popts->setTidy( $oldTidy );
1722
1723 $this->addParserOutput( $parserOutput );
1724
1725 }
1726
1727 /**
1728 * Add a ParserOutput object, but without Html.
1729 *
1730 * @deprecated since 1.24, use addParserOutputMetadata() instead.
1731 * @param ParserOutput $parserOutput
1732 */
1733 public function addParserOutputNoText( $parserOutput ) {
1734 $this->addParserOutputMetadata( $parserOutput );
1735 }
1736
1737 /**
1738 * Add all metadata associated with a ParserOutput object, but without the actual HTML. This
1739 * includes categories, language links, ResourceLoader modules, effects of certain magic words,
1740 * and so on.
1741 *
1742 * @since 1.24
1743 * @param ParserOutput $parserOutput
1744 */
1745 public function addParserOutputMetadata( $parserOutput ) {
1746 $this->mLanguageLinks += $parserOutput->getLanguageLinks();
1747 $this->addCategoryLinks( $parserOutput->getCategories() );
1748 $this->setIndicators( $parserOutput->getIndicators() );
1749 $this->mNewSectionLink = $parserOutput->getNewSection();
1750 $this->mHideNewSectionLink = $parserOutput->getHideNewSection();
1751
1752 $this->mParseWarnings = $parserOutput->getWarnings();
1753 if ( !$parserOutput->isCacheable() ) {
1754 $this->enableClientCache( false );
1755 }
1756 $this->mNoGallery = $parserOutput->getNoGallery();
1757 $this->mHeadItems = array_merge( $this->mHeadItems, $parserOutput->getHeadItems() );
1758 $this->addModules( $parserOutput->getModules() );
1759 $this->addModuleScripts( $parserOutput->getModuleScripts() );
1760 $this->addModuleStyles( $parserOutput->getModuleStyles() );
1761 $this->addModuleMessages( $parserOutput->getModuleMessages() );
1762 $this->addJsConfigVars( $parserOutput->getJsConfigVars() );
1763 $this->mPreventClickjacking = $this->mPreventClickjacking
1764 || $parserOutput->preventClickjacking();
1765
1766 // Template versioning...
1767 foreach ( (array)$parserOutput->getTemplateIds() as $ns => $dbks ) {
1768 if ( isset( $this->mTemplateIds[$ns] ) ) {
1769 $this->mTemplateIds[$ns] = $dbks + $this->mTemplateIds[$ns];
1770 } else {
1771 $this->mTemplateIds[$ns] = $dbks;
1772 }
1773 }
1774 // File versioning...
1775 foreach ( (array)$parserOutput->getFileSearchOptions() as $dbk => $data ) {
1776 $this->mImageTimeKeys[$dbk] = $data;
1777 }
1778
1779 // Hooks registered in the object
1780 $parserOutputHooks = $this->getConfig()->get( 'ParserOutputHooks' );
1781 foreach ( $parserOutput->getOutputHooks() as $hookInfo ) {
1782 list( $hookName, $data ) = $hookInfo;
1783 if ( isset( $parserOutputHooks[$hookName] ) ) {
1784 call_user_func( $parserOutputHooks[$hookName], $this, $parserOutput, $data );
1785 }
1786 }
1787
1788 // Link flags are ignored for now, but may in the future be
1789 // used to mark individual language links.
1790 $linkFlags = array();
1791 Hooks::run( 'LanguageLinks', array( $this->getTitle(), &$this->mLanguageLinks, &$linkFlags ) );
1792 Hooks::run( 'OutputPageParserOutput', array( &$this, $parserOutput ) );
1793 }
1794
1795 /**
1796 * Add the HTML and enhancements for it (like ResourceLoader modules) associated with a
1797 * ParserOutput object, without any other metadata.
1798 *
1799 * @since 1.24
1800 * @param ParserOutput $parserOutput
1801 */
1802 public function addParserOutputContent( $parserOutput ) {
1803 $this->addParserOutputText( $parserOutput );
1804
1805 $this->addModules( $parserOutput->getModules() );
1806 $this->addModuleScripts( $parserOutput->getModuleScripts() );
1807 $this->addModuleStyles( $parserOutput->getModuleStyles() );
1808 $this->addModuleMessages( $parserOutput->getModuleMessages() );
1809
1810 $this->addJsConfigVars( $parserOutput->getJsConfigVars() );
1811 }
1812
1813 /**
1814 * Add the HTML associated with a ParserOutput object, without any metadata.
1815 *
1816 * @since 1.24
1817 * @param ParserOutput $parserOutput
1818 */
1819 public function addParserOutputText( $parserOutput ) {
1820 $text = $parserOutput->getText();
1821 Hooks::run( 'OutputPageBeforeHTML', array( &$this, &$text ) );
1822 $this->addHTML( $text );
1823 }
1824
1825 /**
1826 * Add everything from a ParserOutput object.
1827 *
1828 * @param ParserOutput $parserOutput
1829 */
1830 function addParserOutput( $parserOutput ) {
1831 $this->addParserOutputMetadata( $parserOutput );
1832 $parserOutput->setTOCEnabled( $this->mEnableTOC );
1833
1834 // Touch section edit links only if not previously disabled
1835 if ( $parserOutput->getEditSectionTokens() ) {
1836 $parserOutput->setEditSectionTokens( $this->mEnableSectionEditLinks );
1837 }
1838
1839 $this->addParserOutputText( $parserOutput );
1840 }
1841
1842 /**
1843 * Add the output of a QuickTemplate to the output buffer
1844 *
1845 * @param QuickTemplate $template
1846 */
1847 public function addTemplate( &$template ) {
1848 $this->addHTML( $template->getHTML() );
1849 }
1850
1851 /**
1852 * Parse wikitext and return the HTML.
1853 *
1854 * @param string $text
1855 * @param bool $linestart Is this the start of a line?
1856 * @param bool $interface Use interface language ($wgLang instead of
1857 * $wgContLang) while parsing language sensitive magic words like GRAMMAR and PLURAL.
1858 * This also disables LanguageConverter.
1859 * @param Language $language Target language object, will override $interface
1860 * @throws MWException
1861 * @return string HTML
1862 */
1863 public function parse( $text, $linestart = true, $interface = false, $language = null ) {
1864 global $wgParser;
1865
1866 if ( is_null( $this->getTitle() ) ) {
1867 throw new MWException( 'Empty $mTitle in ' . __METHOD__ );
1868 }
1869
1870 $popts = $this->parserOptions();
1871 if ( $interface ) {
1872 $popts->setInterfaceMessage( true );
1873 }
1874 if ( $language !== null ) {
1875 $oldLang = $popts->setTargetLanguage( $language );
1876 }
1877
1878 $parserOutput = $wgParser->getFreshParser()->parse(
1879 $text, $this->getTitle(), $popts,
1880 $linestart, true, $this->mRevisionId
1881 );
1882
1883 if ( $interface ) {
1884 $popts->setInterfaceMessage( false );
1885 }
1886 if ( $language !== null ) {
1887 $popts->setTargetLanguage( $oldLang );
1888 }
1889
1890 return $parserOutput->getText();
1891 }
1892
1893 /**
1894 * Parse wikitext, strip paragraphs, and return the HTML.
1895 *
1896 * @param string $text
1897 * @param bool $linestart Is this the start of a line?
1898 * @param bool $interface Use interface language ($wgLang instead of
1899 * $wgContLang) while parsing language sensitive magic
1900 * words like GRAMMAR and PLURAL
1901 * @return string HTML
1902 */
1903 public function parseInline( $text, $linestart = true, $interface = false ) {
1904 $parsed = $this->parse( $text, $linestart, $interface );
1905 return Parser::stripOuterParagraph( $parsed );
1906 }
1907
1908 /**
1909 * Set the value of the "s-maxage" part of the "Cache-control" HTTP header
1910 *
1911 * @param int $maxage Maximum cache time on the Squid, in seconds.
1912 */
1913 public function setSquidMaxage( $maxage ) {
1914 $this->mSquidMaxage = $maxage;
1915 }
1916
1917 /**
1918 * Use enableClientCache(false) to force it to send nocache headers
1919 *
1920 * @param bool $state
1921 *
1922 * @return bool
1923 */
1924 public function enableClientCache( $state ) {
1925 return wfSetVar( $this->mEnableClientCache, $state );
1926 }
1927
1928 /**
1929 * Get the list of cookies that will influence on the cache
1930 *
1931 * @return array
1932 */
1933 function getCacheVaryCookies() {
1934 static $cookies;
1935 if ( $cookies === null ) {
1936 $config = $this->getConfig();
1937 $cookies = array_merge(
1938 array(
1939 $config->get( 'CookiePrefix' ) . 'Token',
1940 $config->get( 'CookiePrefix' ) . 'LoggedOut',
1941 "forceHTTPS",
1942 session_name()
1943 ),
1944 $config->get( 'CacheVaryCookies' )
1945 );
1946 Hooks::run( 'GetCacheVaryCookies', array( $this, &$cookies ) );
1947 }
1948 return $cookies;
1949 }
1950
1951 /**
1952 * Check if the request has a cache-varying cookie header
1953 * If it does, it's very important that we don't allow public caching
1954 *
1955 * @return bool
1956 */
1957 function haveCacheVaryCookies() {
1958 $cookieHeader = $this->getRequest()->getHeader( 'cookie' );
1959 if ( $cookieHeader === false ) {
1960 return false;
1961 }
1962 $cvCookies = $this->getCacheVaryCookies();
1963 foreach ( $cvCookies as $cookieName ) {
1964 # Check for a simple string match, like the way squid does it
1965 if ( strpos( $cookieHeader, $cookieName ) !== false ) {
1966 wfDebug( __METHOD__ . ": found $cookieName\n" );
1967 return true;
1968 }
1969 }
1970 wfDebug( __METHOD__ . ": no cache-varying cookies found\n" );
1971 return false;
1972 }
1973
1974 /**
1975 * Add an HTTP header that will influence on the cache
1976 *
1977 * @param string $header Header name
1978 * @param array|null $option
1979 * @todo FIXME: Document the $option parameter; it appears to be for
1980 * X-Vary-Options but what format is acceptable?
1981 */
1982 public function addVaryHeader( $header, $option = null ) {
1983 if ( !array_key_exists( $header, $this->mVaryHeader ) ) {
1984 $this->mVaryHeader[$header] = (array)$option;
1985 } elseif ( is_array( $option ) ) {
1986 if ( is_array( $this->mVaryHeader[$header] ) ) {
1987 $this->mVaryHeader[$header] = array_merge( $this->mVaryHeader[$header], $option );
1988 } else {
1989 $this->mVaryHeader[$header] = $option;
1990 }
1991 }
1992 $this->mVaryHeader[$header] = array_unique( (array)$this->mVaryHeader[$header] );
1993 }
1994
1995 /**
1996 * Return a Vary: header on which to vary caches. Based on the keys of $mVaryHeader,
1997 * such as Accept-Encoding or Cookie
1998 *
1999 * @return string
2000 */
2001 public function getVaryHeader() {
2002 return 'Vary: ' . join( ', ', array_keys( $this->mVaryHeader ) );
2003 }
2004
2005 /**
2006 * Get a complete X-Vary-Options header
2007 *
2008 * @return string
2009 */
2010 public function getXVO() {
2011 $cvCookies = $this->getCacheVaryCookies();
2012
2013 $cookiesOption = array();
2014 foreach ( $cvCookies as $cookieName ) {
2015 $cookiesOption[] = 'string-contains=' . $cookieName;
2016 }
2017 $this->addVaryHeader( 'Cookie', $cookiesOption );
2018
2019 $headers = array();
2020 foreach ( $this->mVaryHeader as $header => $option ) {
2021 $newheader = $header;
2022 if ( is_array( $option ) && count( $option ) > 0 ) {
2023 $newheader .= ';' . implode( ';', $option );
2024 }
2025 $headers[] = $newheader;
2026 }
2027 $xvo = 'X-Vary-Options: ' . implode( ',', $headers );
2028
2029 return $xvo;
2030 }
2031
2032 /**
2033 * bug 21672: Add Accept-Language to Vary and XVO headers
2034 * if there's no 'variant' parameter existed in GET.
2035 *
2036 * For example:
2037 * /w/index.php?title=Main_page should always be served; but
2038 * /w/index.php?title=Main_page&variant=zh-cn should never be served.
2039 */
2040 function addAcceptLanguage() {
2041 $title = $this->getTitle();
2042 if ( !$title instanceof Title ) {
2043 return;
2044 }
2045
2046 $lang = $title->getPageLanguage();
2047 if ( !$this->getRequest()->getCheck( 'variant' ) && $lang->hasVariants() ) {
2048 $variants = $lang->getVariants();
2049 $aloption = array();
2050 foreach ( $variants as $variant ) {
2051 if ( $variant === $lang->getCode() ) {
2052 continue;
2053 } else {
2054 $aloption[] = 'string-contains=' . $variant;
2055
2056 // IE and some other browsers use BCP 47 standards in
2057 // their Accept-Language header, like "zh-CN" or "zh-Hant".
2058 // We should handle these too.
2059 $variantBCP47 = wfBCP47( $variant );
2060 if ( $variantBCP47 !== $variant ) {
2061 $aloption[] = 'string-contains=' . $variantBCP47;
2062 }
2063 }
2064 }
2065 $this->addVaryHeader( 'Accept-Language', $aloption );
2066 }
2067 }
2068
2069 /**
2070 * Set a flag which will cause an X-Frame-Options header appropriate for
2071 * edit pages to be sent. The header value is controlled by
2072 * $wgEditPageFrameOptions.
2073 *
2074 * This is the default for special pages. If you display a CSRF-protected
2075 * form on an ordinary view page, then you need to call this function.
2076 *
2077 * @param bool $enable
2078 */
2079 public function preventClickjacking( $enable = true ) {
2080 $this->mPreventClickjacking = $enable;
2081 }
2082
2083 /**
2084 * Turn off frame-breaking. Alias for $this->preventClickjacking(false).
2085 * This can be called from pages which do not contain any CSRF-protected
2086 * HTML form.
2087 */
2088 public function allowClickjacking() {
2089 $this->mPreventClickjacking = false;
2090 }
2091
2092 /**
2093 * Get the prevent-clickjacking flag
2094 *
2095 * @since 1.24
2096 * @return bool
2097 */
2098 public function getPreventClickjacking() {
2099 return $this->mPreventClickjacking;
2100 }
2101
2102 /**
2103 * Get the X-Frame-Options header value (without the name part), or false
2104 * if there isn't one. This is used by Skin to determine whether to enable
2105 * JavaScript frame-breaking, for clients that don't support X-Frame-Options.
2106 *
2107 * @return string
2108 */
2109 public function getFrameOptions() {
2110 $config = $this->getConfig();
2111 if ( $config->get( 'BreakFrames' ) ) {
2112 return 'DENY';
2113 } elseif ( $this->mPreventClickjacking && $config->get( 'EditPageFrameOptions' ) ) {
2114 return $config->get( 'EditPageFrameOptions' );
2115 }
2116 return false;
2117 }
2118
2119 /**
2120 * Send cache control HTTP headers
2121 */
2122 public function sendCacheControl() {
2123 $response = $this->getRequest()->response();
2124 $config = $this->getConfig();
2125 if ( $config->get( 'UseETag' ) && $this->mETag ) {
2126 $response->header( "ETag: $this->mETag" );
2127 }
2128
2129 $this->addVaryHeader( 'Cookie' );
2130 $this->addAcceptLanguage();
2131
2132 # don't serve compressed data to clients who can't handle it
2133 # maintain different caches for logged-in users and non-logged in ones
2134 $response->header( $this->getVaryHeader() );
2135
2136 if ( $config->get( 'UseXVO' ) ) {
2137 # Add an X-Vary-Options header for Squid with Wikimedia patches
2138 $response->header( $this->getXVO() );
2139 }
2140
2141 if ( $this->mEnableClientCache ) {
2142 if (
2143 $config->get( 'UseSquid' ) && session_id() == '' && !$this->isPrintable() &&
2144 $this->mSquidMaxage != 0 && !$this->haveCacheVaryCookies()
2145 ) {
2146 if ( $config->get( 'UseESI' ) ) {
2147 # We'll purge the proxy cache explicitly, but require end user agents
2148 # to revalidate against the proxy on each visit.
2149 # Surrogate-Control controls our Squid, Cache-Control downstream caches
2150 wfDebug( __METHOD__ . ": proxy caching with ESI; {$this->mLastModified} **\n", 'log' );
2151 # start with a shorter timeout for initial testing
2152 # header( 'Surrogate-Control: max-age=2678400+2678400, content="ESI/1.0"');
2153 $response->header( 'Surrogate-Control: max-age=' . $config->get( 'SquidMaxage' )
2154 . '+' . $this->mSquidMaxage . ', content="ESI/1.0"' );
2155 $response->header( 'Cache-Control: s-maxage=0, must-revalidate, max-age=0' );
2156 } else {
2157 # We'll purge the proxy cache for anons explicitly, but require end user agents
2158 # to revalidate against the proxy on each visit.
2159 # IMPORTANT! The Squid needs to replace the Cache-Control header with
2160 # Cache-Control: s-maxage=0, must-revalidate, max-age=0
2161 wfDebug( __METHOD__ . ": local proxy caching; {$this->mLastModified} **\n", 'log' );
2162 # start with a shorter timeout for initial testing
2163 # header( "Cache-Control: s-maxage=2678400, must-revalidate, max-age=0" );
2164 $response->header( 'Cache-Control: s-maxage=' . $this->mSquidMaxage
2165 . ', must-revalidate, max-age=0' );
2166 }
2167 } else {
2168 # We do want clients to cache if they can, but they *must* check for updates
2169 # on revisiting the page.
2170 wfDebug( __METHOD__ . ": private caching; {$this->mLastModified} **\n", 'log' );
2171 $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
2172 $response->header( "Cache-Control: private, must-revalidate, max-age=0" );
2173 }
2174 if ( $this->mLastModified ) {
2175 $response->header( "Last-Modified: {$this->mLastModified}" );
2176 }
2177 } else {
2178 wfDebug( __METHOD__ . ": no caching **\n", 'log' );
2179
2180 # In general, the absence of a last modified header should be enough to prevent
2181 # the client from using its cache. We send a few other things just to make sure.
2182 $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
2183 $response->header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' );
2184 $response->header( 'Pragma: no-cache' );
2185 }
2186 }
2187
2188 /**
2189 * Finally, all the text has been munged and accumulated into
2190 * the object, let's actually output it:
2191 */
2192 public function output() {
2193 if ( $this->mDoNothing ) {
2194 return;
2195 }
2196
2197 $response = $this->getRequest()->response();
2198 $config = $this->getConfig();
2199
2200 if ( $this->mRedirect != '' ) {
2201 # Standards require redirect URLs to be absolute
2202 $this->mRedirect = wfExpandUrl( $this->mRedirect, PROTO_CURRENT );
2203
2204 $redirect = $this->mRedirect;
2205 $code = $this->mRedirectCode;
2206
2207 if ( Hooks::run( "BeforePageRedirect", array( $this, &$redirect, &$code ) ) ) {
2208 if ( $code == '301' || $code == '303' ) {
2209 if ( !$config->get( 'DebugRedirects' ) ) {
2210 $message = HttpStatus::getMessage( $code );
2211 $response->header( "HTTP/1.1 $code $message" );
2212 }
2213 $this->mLastModified = wfTimestamp( TS_RFC2822 );
2214 }
2215 if ( $config->get( 'VaryOnXFP' ) ) {
2216 $this->addVaryHeader( 'X-Forwarded-Proto' );
2217 }
2218 $this->sendCacheControl();
2219
2220 $response->header( "Content-Type: text/html; charset=utf-8" );
2221 if ( $config->get( 'DebugRedirects' ) ) {
2222 $url = htmlspecialchars( $redirect );
2223 print "<html>\n<head>\n<title>Redirect</title>\n</head>\n<body>\n";
2224 print "<p>Location: <a href=\"$url\">$url</a></p>\n";
2225 print "</body>\n</html>\n";
2226 } else {
2227 $response->header( 'Location: ' . $redirect );
2228 }
2229 }
2230
2231 return;
2232 } elseif ( $this->mStatusCode ) {
2233 $message = HttpStatus::getMessage( $this->mStatusCode );
2234 if ( $message ) {
2235 $response->header( 'HTTP/1.1 ' . $this->mStatusCode . ' ' . $message );
2236 }
2237 }
2238
2239 # Buffer output; final headers may depend on later processing
2240 ob_start();
2241
2242 $response->header( 'Content-type: ' . $config->get( 'MimeType' ) . '; charset=UTF-8' );
2243 $response->header( 'Content-language: ' . $config->get( 'LanguageCode' ) );
2244
2245 // Avoid Internet Explorer "compatibility view" in IE 8-10, so that
2246 // jQuery etc. can work correctly.
2247 $response->header( 'X-UA-Compatible: IE=Edge' );
2248
2249 // Prevent framing, if requested
2250 $frameOptions = $this->getFrameOptions();
2251 if ( $frameOptions ) {
2252 $response->header( "X-Frame-Options: $frameOptions" );
2253 }
2254
2255 if ( $this->mArticleBodyOnly ) {
2256 echo $this->mBodytext;
2257 } else {
2258
2259 $sk = $this->getSkin();
2260 // add skin specific modules
2261 $modules = $sk->getDefaultModules();
2262
2263 // enforce various default modules for all skins
2264 $coreModules = array(
2265 // keep this list as small as possible
2266 'mediawiki.page.startup',
2267 'mediawiki.user',
2268 );
2269
2270 // Support for high-density display images if enabled
2271 if ( $config->get( 'ResponsiveImages' ) ) {
2272 $coreModules[] = 'mediawiki.hidpi';
2273 }
2274
2275 $this->addModules( $coreModules );
2276 foreach ( $modules as $group ) {
2277 $this->addModules( $group );
2278 }
2279 MWDebug::addModules( $this );
2280
2281 // Hook that allows last minute changes to the output page, e.g.
2282 // adding of CSS or Javascript by extensions.
2283 Hooks::run( 'BeforePageDisplay', array( &$this, &$sk ) );
2284
2285 $sk->outputPage();
2286 }
2287
2288 // This hook allows last minute changes to final overall output by modifying output buffer
2289 Hooks::run( 'AfterFinalPageOutput', array( $this ) );
2290
2291 $this->sendCacheControl();
2292
2293 ob_end_flush();
2294
2295 }
2296
2297 /**
2298 * Actually output something with print.
2299 *
2300 * @param string $ins The string to output
2301 * @deprecated since 1.22 Use echo yourself.
2302 */
2303 public function out( $ins ) {
2304 wfDeprecated( __METHOD__, '1.22' );
2305 print $ins;
2306 }
2307
2308 /**
2309 * Produce a "user is blocked" page.
2310 * @deprecated since 1.18
2311 */
2312 function blockedPage() {
2313 throw new UserBlockedError( $this->getUser()->mBlock );
2314 }
2315
2316 /**
2317 * Prepare this object to display an error page; disable caching and
2318 * indexing, clear the current text and redirect, set the page's title
2319 * and optionally an custom HTML title (content of the "<title>" tag).
2320 *
2321 * @param string|Message $pageTitle Will be passed directly to setPageTitle()
2322 * @param string|Message $htmlTitle Will be passed directly to setHTMLTitle();
2323 * optional, if not passed the "<title>" attribute will be
2324 * based on $pageTitle
2325 */
2326 public function prepareErrorPage( $pageTitle, $htmlTitle = false ) {
2327 $this->setPageTitle( $pageTitle );
2328 if ( $htmlTitle !== false ) {
2329 $this->setHTMLTitle( $htmlTitle );
2330 }
2331 $this->setRobotPolicy( 'noindex,nofollow' );
2332 $this->setArticleRelated( false );
2333 $this->enableClientCache( false );
2334 $this->mRedirect = '';
2335 $this->clearSubtitle();
2336 $this->clearHTML();
2337 }
2338
2339 /**
2340 * Output a standard error page
2341 *
2342 * showErrorPage( 'titlemsg', 'pagetextmsg' );
2343 * showErrorPage( 'titlemsg', 'pagetextmsg', array( 'param1', 'param2' ) );
2344 * showErrorPage( 'titlemsg', $messageObject );
2345 * showErrorPage( $titleMessageObject, $messageObject );
2346 *
2347 * @param string|Message $title Message key (string) for page title, or a Message object
2348 * @param string|Message $msg Message key (string) for page text, or a Message object
2349 * @param array $params Message parameters; ignored if $msg is a Message object
2350 */
2351 public function showErrorPage( $title, $msg, $params = array() ) {
2352 if ( !$title instanceof Message ) {
2353 $title = $this->msg( $title );
2354 }
2355
2356 $this->prepareErrorPage( $title );
2357
2358 if ( $msg instanceof Message ) {
2359 if ( $params !== array() ) {
2360 trigger_error( 'Argument ignored: $params. The message parameters argument '
2361 . 'is discarded when the $msg argument is a Message object instead of '
2362 . 'a string.', E_USER_NOTICE );
2363 }
2364 $this->addHTML( $msg->parseAsBlock() );
2365 } else {
2366 $this->addWikiMsgArray( $msg, $params );
2367 }
2368
2369 $this->returnToMain();
2370 }
2371
2372 /**
2373 * Output a standard permission error page
2374 *
2375 * @param array $errors Error message keys
2376 * @param string $action Action that was denied or null if unknown
2377 */
2378 public function showPermissionsErrorPage( array $errors, $action = null ) {
2379 // For some action (read, edit, create and upload), display a "login to do this action"
2380 // error if all of the following conditions are met:
2381 // 1. the user is not logged in
2382 // 2. the only error is insufficient permissions (i.e. no block or something else)
2383 // 3. the error can be avoided simply by logging in
2384 if ( in_array( $action, array( 'read', 'edit', 'createpage', 'createtalk', 'upload' ) )
2385 && $this->getUser()->isAnon() && count( $errors ) == 1 && isset( $errors[0][0] )
2386 && ( $errors[0][0] == 'badaccess-groups' || $errors[0][0] == 'badaccess-group0' )
2387 && ( User::groupHasPermission( 'user', $action )
2388 || User::groupHasPermission( 'autoconfirmed', $action ) )
2389 ) {
2390 $displayReturnto = null;
2391
2392 # Due to bug 32276, if a user does not have read permissions,
2393 # $this->getTitle() will just give Special:Badtitle, which is
2394 # not especially useful as a returnto parameter. Use the title
2395 # from the request instead, if there was one.
2396 $request = $this->getRequest();
2397 $returnto = Title::newFromURL( $request->getVal( 'title', '' ) );
2398 if ( $action == 'edit' ) {
2399 $msg = 'whitelistedittext';
2400 $displayReturnto = $returnto;
2401 } elseif ( $action == 'createpage' || $action == 'createtalk' ) {
2402 $msg = 'nocreatetext';
2403 } elseif ( $action == 'upload' ) {
2404 $msg = 'uploadnologintext';
2405 } else { # Read
2406 $msg = 'loginreqpagetext';
2407 $displayReturnto = Title::newMainPage();
2408 }
2409
2410 $query = array();
2411
2412 if ( $returnto ) {
2413 $query['returnto'] = $returnto->getPrefixedText();
2414
2415 if ( !$request->wasPosted() ) {
2416 $returntoquery = $request->getValues();
2417 unset( $returntoquery['title'] );
2418 unset( $returntoquery['returnto'] );
2419 unset( $returntoquery['returntoquery'] );
2420 $query['returntoquery'] = wfArrayToCgi( $returntoquery );
2421 }
2422 }
2423 $loginLink = Linker::linkKnown(
2424 SpecialPage::getTitleFor( 'Userlogin' ),
2425 $this->msg( 'loginreqlink' )->escaped(),
2426 array(),
2427 $query
2428 );
2429
2430 $this->prepareErrorPage( $this->msg( 'loginreqtitle' ) );
2431 $this->addHTML( $this->msg( $msg )->rawParams( $loginLink )->parse() );
2432
2433 # Don't return to a page the user can't read otherwise
2434 # we'll end up in a pointless loop
2435 if ( $displayReturnto && $displayReturnto->userCan( 'read', $this->getUser() ) ) {
2436 $this->returnToMain( null, $displayReturnto );
2437 }
2438 } else {
2439 $this->prepareErrorPage( $this->msg( 'permissionserrors' ) );
2440 $this->addWikiText( $this->formatPermissionsErrorMessage( $errors, $action ) );
2441 }
2442 }
2443
2444 /**
2445 * Display an error page indicating that a given version of MediaWiki is
2446 * required to use it
2447 *
2448 * @param mixed $version The version of MediaWiki needed to use the page
2449 */
2450 public function versionRequired( $version ) {
2451 $this->prepareErrorPage( $this->msg( 'versionrequired', $version ) );
2452
2453 $this->addWikiMsg( 'versionrequiredtext', $version );
2454 $this->returnToMain();
2455 }
2456
2457 /**
2458 * Display an error page noting that a given permission bit is required.
2459 * @deprecated since 1.18, just throw the exception directly
2460 * @param string $permission Key required
2461 * @throws PermissionsError
2462 */
2463 public function permissionRequired( $permission ) {
2464 throw new PermissionsError( $permission );
2465 }
2466
2467 /**
2468 * Produce the stock "please login to use the wiki" page
2469 *
2470 * @deprecated since 1.19; throw the exception directly
2471 */
2472 public function loginToUse() {
2473 throw new PermissionsError( 'read' );
2474 }
2475
2476 /**
2477 * Format a list of error messages
2478 *
2479 * @param array $errors Array of arrays returned by Title::getUserPermissionsErrors
2480 * @param string $action Action that was denied or null if unknown
2481 * @return string The wikitext error-messages, formatted into a list.
2482 */
2483 public function formatPermissionsErrorMessage( array $errors, $action = null ) {
2484 if ( $action == null ) {
2485 $text = $this->msg( 'permissionserrorstext', count( $errors ) )->plain() . "\n\n";
2486 } else {
2487 $action_desc = $this->msg( "action-$action" )->plain();
2488 $text = $this->msg(
2489 'permissionserrorstext-withaction',
2490 count( $errors ),
2491 $action_desc
2492 )->plain() . "\n\n";
2493 }
2494
2495 if ( count( $errors ) > 1 ) {
2496 $text .= '<ul class="permissions-errors">' . "\n";
2497
2498 foreach ( $errors as $error ) {
2499 $text .= '<li>';
2500 $text .= call_user_func_array( array( $this, 'msg' ), $error )->plain();
2501 $text .= "</li>\n";
2502 }
2503 $text .= '</ul>';
2504 } else {
2505 $text .= "<div class=\"permissions-errors\">\n" .
2506 call_user_func_array( array( $this, 'msg' ), reset( $errors ) )->plain() .
2507 "\n</div>";
2508 }
2509
2510 return $text;
2511 }
2512
2513 /**
2514 * Display a page stating that the Wiki is in read-only mode.
2515 * Should only be called after wfReadOnly() has returned true.
2516 *
2517 * Historically, this function was used to show the source of the page that the user
2518 * was trying to edit and _also_ permissions error messages. The relevant code was
2519 * moved into EditPage in 1.19 (r102024 / d83c2a431c2a) and removed here in 1.25.
2520 *
2521 * @deprecated since 1.25; throw the exception directly
2522 * @throws ReadOnlyError
2523 */
2524 public function readOnlyPage() {
2525 if ( func_num_args() > 0 ) {
2526 throw new MWException( __METHOD__ . ' no longer accepts arguments since 1.25.' );
2527 }
2528
2529 throw new ReadOnlyError;
2530 }
2531
2532 /**
2533 * Turn off regular page output and return an error response
2534 * for when rate limiting has triggered.
2535 *
2536 * @deprecated since 1.25; throw the exception directly
2537 */
2538 public function rateLimited() {
2539 wfDeprecated( __METHOD__, '1.25' );
2540 throw new ThrottledError;
2541 }
2542
2543 /**
2544 * Show a warning about slave lag
2545 *
2546 * If the lag is higher than $wgSlaveLagCritical seconds,
2547 * then the warning is a bit more obvious. If the lag is
2548 * lower than $wgSlaveLagWarning, then no warning is shown.
2549 *
2550 * @param int $lag Slave lag
2551 */
2552 public function showLagWarning( $lag ) {
2553 $config = $this->getConfig();
2554 if ( $lag >= $config->get( 'SlaveLagWarning' ) ) {
2555 $message = $lag < $config->get( 'SlaveLagCritical' )
2556 ? 'lag-warn-normal'
2557 : 'lag-warn-high';
2558 $wrap = Html::rawElement( 'div', array( 'class' => "mw-{$message}" ), "\n$1\n" );
2559 $this->wrapWikiMsg( "$wrap\n", array( $message, $this->getLanguage()->formatNum( $lag ) ) );
2560 }
2561 }
2562
2563 public function showFatalError( $message ) {
2564 $this->prepareErrorPage( $this->msg( 'internalerror' ) );
2565
2566 $this->addHTML( $message );
2567 }
2568
2569 public function showUnexpectedValueError( $name, $val ) {
2570 $this->showFatalError( $this->msg( 'unexpected', $name, $val )->text() );
2571 }
2572
2573 public function showFileCopyError( $old, $new ) {
2574 $this->showFatalError( $this->msg( 'filecopyerror', $old, $new )->text() );
2575 }
2576
2577 public function showFileRenameError( $old, $new ) {
2578 $this->showFatalError( $this->msg( 'filerenameerror', $old, $new )->text() );
2579 }
2580
2581 public function showFileDeleteError( $name ) {
2582 $this->showFatalError( $this->msg( 'filedeleteerror', $name )->text() );
2583 }
2584
2585 public function showFileNotFoundError( $name ) {
2586 $this->showFatalError( $this->msg( 'filenotfound', $name )->text() );
2587 }
2588
2589 /**
2590 * Add a "return to" link pointing to a specified title
2591 *
2592 * @param Title $title Title to link
2593 * @param array $query Query string parameters
2594 * @param string $text Text of the link (input is not escaped)
2595 * @param array $options Options array to pass to Linker
2596 */
2597 public function addReturnTo( $title, array $query = array(), $text = null, $options = array() ) {
2598 $link = $this->msg( 'returnto' )->rawParams(
2599 Linker::link( $title, $text, array(), $query, $options ) )->escaped();
2600 $this->addHTML( "<p id=\"mw-returnto\">{$link}</p>\n" );
2601 }
2602
2603 /**
2604 * Add a "return to" link pointing to a specified title,
2605 * or the title indicated in the request, or else the main page
2606 *
2607 * @param mixed $unused
2608 * @param Title|string $returnto Title or String to return to
2609 * @param string $returntoquery Query string for the return to link
2610 */
2611 public function returnToMain( $unused = null, $returnto = null, $returntoquery = null ) {
2612 if ( $returnto == null ) {
2613 $returnto = $this->getRequest()->getText( 'returnto' );
2614 }
2615
2616 if ( $returntoquery == null ) {
2617 $returntoquery = $this->getRequest()->getText( 'returntoquery' );
2618 }
2619
2620 if ( $returnto === '' ) {
2621 $returnto = Title::newMainPage();
2622 }
2623
2624 if ( is_object( $returnto ) ) {
2625 $titleObj = $returnto;
2626 } else {
2627 $titleObj = Title::newFromText( $returnto );
2628 }
2629 if ( !is_object( $titleObj ) ) {
2630 $titleObj = Title::newMainPage();
2631 }
2632
2633 $this->addReturnTo( $titleObj, wfCgiToArray( $returntoquery ) );
2634 }
2635
2636 /**
2637 * @param Skin $sk The given Skin
2638 * @param bool $includeStyle Unused
2639 * @return string The doctype, opening "<html>", and head element.
2640 */
2641 public function headElement( Skin $sk, $includeStyle = true ) {
2642 global $wgContLang;
2643
2644 $userdir = $this->getLanguage()->getDir();
2645 $sitedir = $wgContLang->getDir();
2646
2647 $ret = Html::htmlHeader( $sk->getHtmlElementAttributes() );
2648
2649 if ( $this->getHTMLTitle() == '' ) {
2650 $this->setHTMLTitle( $this->msg( 'pagetitle', $this->getPageTitle() )->inContentLanguage() );
2651 }
2652
2653 $openHead = Html::openElement( 'head' );
2654 if ( $openHead ) {
2655 # Don't bother with the newline if $head == ''
2656 $ret .= "$openHead\n";
2657 }
2658
2659 if ( !Html::isXmlMimeType( $this->getConfig()->get( 'MimeType' ) ) ) {
2660 // Add <meta charset="UTF-8">
2661 // This should be before <title> since it defines the charset used by
2662 // text including the text inside <title>.
2663 // The spec recommends defining XHTML5's charset using the XML declaration
2664 // instead of meta.
2665 // Our XML declaration is output by Html::htmlHeader.
2666 // http://www.whatwg.org/html/semantics.html#attr-meta-http-equiv-content-type
2667 // http://www.whatwg.org/html/semantics.html#charset
2668 $ret .= Html::element( 'meta', array( 'charset' => 'UTF-8' ) ) . "\n";
2669 }
2670
2671 $ret .= Html::element( 'title', null, $this->getHTMLTitle() ) . "\n";
2672
2673 foreach ( $this->getHeadLinksArray() as $item ) {
2674 $ret .= $item . "\n";
2675 }
2676
2677 // No newline after buildCssLinks since makeResourceLoaderLink did that already
2678 $ret .= $this->buildCssLinks();
2679
2680 $ret .= $this->getHeadScripts() . "\n";
2681
2682 foreach ( $this->mHeadItems as $item ) {
2683 $ret .= $item . "\n";
2684 }
2685
2686 $closeHead = Html::closeElement( 'head' );
2687 if ( $closeHead ) {
2688 $ret .= "$closeHead\n";
2689 }
2690
2691 $bodyClasses = array();
2692 $bodyClasses[] = 'mediawiki';
2693
2694 # Classes for LTR/RTL directionality support
2695 $bodyClasses[] = $userdir;
2696 $bodyClasses[] = "sitedir-$sitedir";
2697
2698 if ( $this->getLanguage()->capitalizeAllNouns() ) {
2699 # A <body> class is probably not the best way to do this . . .
2700 $bodyClasses[] = 'capitalize-all-nouns';
2701 }
2702
2703 $bodyClasses[] = $sk->getPageClasses( $this->getTitle() );
2704 $bodyClasses[] = 'skin-' . Sanitizer::escapeClass( $sk->getSkinName() );
2705 $bodyClasses[] =
2706 'action-' . Sanitizer::escapeClass( Action::getActionName( $this->getContext() ) );
2707
2708 $bodyAttrs = array();
2709 // While the implode() is not strictly needed, it's used for backwards compatibility
2710 // (this used to be built as a string and hooks likely still expect that).
2711 $bodyAttrs['class'] = implode( ' ', $bodyClasses );
2712
2713 // Allow skins and extensions to add body attributes they need
2714 $sk->addToBodyAttributes( $this, $bodyAttrs );
2715 Hooks::run( 'OutputPageBodyAttributes', array( $this, $sk, &$bodyAttrs ) );
2716
2717 $ret .= Html::openElement( 'body', $bodyAttrs ) . "\n";
2718
2719 return $ret;
2720 }
2721
2722 /**
2723 * Get a ResourceLoader object associated with this OutputPage
2724 *
2725 * @return ResourceLoader
2726 */
2727 public function getResourceLoader() {
2728 if ( is_null( $this->mResourceLoader ) ) {
2729 $this->mResourceLoader = new ResourceLoader( $this->getConfig() );
2730 }
2731 return $this->mResourceLoader;
2732 }
2733
2734 /**
2735 * @todo Document
2736 * @param array|string $modules One or more module names
2737 * @param string $only ResourceLoaderModule TYPE_ class constant
2738 * @param bool $useESI
2739 * @param array $extraQuery Array with extra query parameters to add to each
2740 * request. array( param => value ).
2741 * @param bool $loadCall If true, output an (asynchronous) mw.loader.load()
2742 * call rather than a "<script src='...'>" tag.
2743 * @return string The html "<script>", "<link>" and "<style>" tags
2744 */
2745 public function makeResourceLoaderLink( $modules, $only, $useESI = false,
2746 array $extraQuery = array(), $loadCall = false
2747 ) {
2748 $modules = (array)$modules;
2749
2750 $links = array(
2751 'html' => '',
2752 'states' => array(),
2753 );
2754
2755 if ( !count( $modules ) ) {
2756 return $links;
2757 }
2758
2759 if ( count( $modules ) > 1 ) {
2760 // Remove duplicate module requests
2761 $modules = array_unique( $modules );
2762 // Sort module names so requests are more uniform
2763 sort( $modules );
2764
2765 if ( ResourceLoader::inDebugMode() ) {
2766 // Recursively call us for every item
2767 foreach ( $modules as $name ) {
2768 $link = $this->makeResourceLoaderLink( $name, $only, $useESI );
2769 $links['html'] .= $link['html'];
2770 $links['states'] += $link['states'];
2771 }
2772 return $links;
2773 }
2774 }
2775
2776 if ( !is_null( $this->mTarget ) ) {
2777 $extraQuery['target'] = $this->mTarget;
2778 }
2779
2780 // Create keyed-by-source and then keyed-by-group list of module objects from modules list
2781 $sortedModules = array();
2782 $resourceLoader = $this->getResourceLoader();
2783 $resourceLoaderUseESI = $this->getConfig()->get( 'ResourceLoaderUseESI' );
2784 foreach ( $modules as $name ) {
2785 $module = $resourceLoader->getModule( $name );
2786 # Check that we're allowed to include this module on this page
2787 if ( !$module
2788 || ( $module->getOrigin() > $this->getAllowedModules( ResourceLoaderModule::TYPE_SCRIPTS )
2789 && $only == ResourceLoaderModule::TYPE_SCRIPTS )
2790 || ( $module->getOrigin() > $this->getAllowedModules( ResourceLoaderModule::TYPE_STYLES )
2791 && $only == ResourceLoaderModule::TYPE_STYLES )
2792 || ( $module->getOrigin() > $this->getAllowedModules( ResourceLoaderModule::TYPE_COMBINED )
2793 && $only == ResourceLoaderModule::TYPE_COMBINED )
2794 || ( $this->mTarget && !in_array( $this->mTarget, $module->getTargets() ) )
2795 ) {
2796 continue;
2797 }
2798
2799 $sortedModules[$module->getSource()][$module->getGroup()][$name] = $module;
2800 }
2801
2802 foreach ( $sortedModules as $source => $groups ) {
2803 foreach ( $groups as $group => $grpModules ) {
2804 // Special handling for user-specific groups
2805 $user = null;
2806 if ( ( $group === 'user' || $group === 'private' ) && $this->getUser()->isLoggedIn() ) {
2807 $user = $this->getUser()->getName();
2808 }
2809
2810 // Create a fake request based on the one we are about to make so modules return
2811 // correct timestamp and emptiness data
2812 $query = ResourceLoader::makeLoaderQuery(
2813 array(), // modules; not determined yet
2814 $this->getLanguage()->getCode(),
2815 $this->getSkin()->getSkinName(),
2816 $user,
2817 null, // version; not determined yet
2818 ResourceLoader::inDebugMode(),
2819 $only === ResourceLoaderModule::TYPE_COMBINED ? null : $only,
2820 $this->isPrintable(),
2821 $this->getRequest()->getBool( 'handheld' ),
2822 $extraQuery
2823 );
2824 $context = new ResourceLoaderContext( $resourceLoader, new FauxRequest( $query ) );
2825
2826 // Extract modules that know they're empty and see if we have one or more
2827 // raw modules
2828 $isRaw = false;
2829 foreach ( $grpModules as $key => $module ) {
2830 // Inline empty modules: since they're empty, just mark them as 'ready' (bug 46857)
2831 // If we're only getting the styles, we don't need to do anything for empty modules.
2832 if ( $module->isKnownEmpty( $context ) ) {
2833 unset( $grpModules[$key] );
2834 if ( $only !== ResourceLoaderModule::TYPE_STYLES ) {
2835 $links['states'][$key] = 'ready';
2836 }
2837 }
2838
2839 $isRaw |= $module->isRaw();
2840 }
2841
2842 // If there are no non-empty modules, skip this group
2843 if ( count( $grpModules ) === 0 ) {
2844 continue;
2845 }
2846
2847 // Inline private modules. These can't be loaded through load.php for security
2848 // reasons, see bug 34907. Note that these modules should be loaded from
2849 // getHeadScripts() before the first loader call. Otherwise other modules can't
2850 // properly use them as dependencies (bug 30914)
2851 if ( $group === 'private' ) {
2852 if ( $only == ResourceLoaderModule::TYPE_STYLES ) {
2853 $links['html'] .= Html::inlineStyle(
2854 $resourceLoader->makeModuleResponse( $context, $grpModules )
2855 );
2856 } else {
2857 $links['html'] .= Html::inlineScript(
2858 ResourceLoader::makeLoaderConditionalScript(
2859 $resourceLoader->makeModuleResponse( $context, $grpModules )
2860 )
2861 );
2862 }
2863 $links['html'] .= "\n";
2864 continue;
2865 }
2866
2867 // Special handling for the user group; because users might change their stuff
2868 // on-wiki like user pages, or user preferences; we need to find the highest
2869 // timestamp of these user-changeable modules so we can ensure cache misses on change
2870 // This should NOT be done for the site group (bug 27564) because anons get that too
2871 // and we shouldn't be putting timestamps in Squid-cached HTML
2872 $version = null;
2873 if ( $group === 'user' ) {
2874 // Get the maximum timestamp
2875 $timestamp = 1;
2876 foreach ( $grpModules as $module ) {
2877 $timestamp = max( $timestamp, $module->getModifiedTime( $context ) );
2878 }
2879 // Add a version parameter so cache will break when things change
2880 $query['version'] = wfTimestamp( TS_ISO_8601_BASIC, $timestamp );
2881 }
2882
2883 $query['modules'] = ResourceLoader::makePackedModulesString( array_keys( $grpModules ) );
2884 $moduleContext = new ResourceLoaderContext( $resourceLoader, new FauxRequest( $query ) );
2885 $url = $resourceLoader->createLoaderURL( $source, $moduleContext, $extraQuery );
2886
2887 if ( $useESI && $resourceLoaderUseESI ) {
2888 $esi = Xml::element( 'esi:include', array( 'src' => $url ) );
2889 if ( $only == ResourceLoaderModule::TYPE_STYLES ) {
2890 $link = Html::inlineStyle( $esi );
2891 } else {
2892 $link = Html::inlineScript( $esi );
2893 }
2894 } else {
2895 // Automatically select style/script elements
2896 if ( $only === ResourceLoaderModule::TYPE_STYLES ) {
2897 $link = Html::linkedStyle( $url );
2898 } elseif ( $loadCall ) {
2899 $link = Html::inlineScript(
2900 ResourceLoader::makeLoaderConditionalScript(
2901 Xml::encodeJsCall( 'mw.loader.load', array( $url, 'text/javascript', true ) )
2902 )
2903 );
2904 } else {
2905 $link = Html::linkedScript( $url );
2906 if ( !$context->getRaw() && !$isRaw ) {
2907 // Wrap only=script / only=combined requests in a conditional as
2908 // browsers not supported by the startup module would unconditionally
2909 // execute this module. Otherwise users will get "ReferenceError: mw is
2910 // undefined" or "jQuery is undefined" from e.g. a "site" module.
2911 $link = Html::inlineScript(
2912 ResourceLoader::makeLoaderConditionalScript(
2913 Xml::encodeJsCall( 'document.write', array( $link ) )
2914 )
2915 );
2916 }
2917
2918 // For modules requested directly in the html via <link> or <script>,
2919 // tell mw.loader they are being loading to prevent duplicate requests.
2920 foreach ( $grpModules as $key => $module ) {
2921 // Don't output state=loading for the startup module..
2922 if ( $key !== 'startup' ) {
2923 $links['states'][$key] = 'loading';
2924 }
2925 }
2926 }
2927 }
2928
2929 if ( $group == 'noscript' ) {
2930 $links['html'] .= Html::rawElement( 'noscript', array(), $link ) . "\n";
2931 } else {
2932 $links['html'] .= $link . "\n";
2933 }
2934 }
2935 }
2936
2937 return $links;
2938 }
2939
2940 /**
2941 * Build html output from an array of links from makeResourceLoaderLink.
2942 * @param array $links
2943 * @return string HTML
2944 */
2945 protected static function getHtmlFromLoaderLinks( array $links ) {
2946 $html = '';
2947 $states = array();
2948 foreach ( $links as $link ) {
2949 if ( !is_array( $link ) ) {
2950 $html .= $link;
2951 } else {
2952 $html .= $link['html'];
2953 $states += $link['states'];
2954 }
2955 }
2956
2957 if ( count( $states ) ) {
2958 $html = Html::inlineScript(
2959 ResourceLoader::makeLoaderConditionalScript(
2960 ResourceLoader::makeLoaderStateScript( $states )
2961 )
2962 ) . "\n" . $html;
2963 }
2964
2965 return $html;
2966 }
2967
2968 /**
2969 * JS stuff to put in the "<head>". This is the startup module, config
2970 * vars and modules marked with position 'top'
2971 *
2972 * @return string HTML fragment
2973 */
2974 function getHeadScripts() {
2975 // Startup - this will immediately load jquery and mediawiki modules
2976 $links = array();
2977 $links[] = $this->makeResourceLoaderLink( 'startup', ResourceLoaderModule::TYPE_SCRIPTS, true );
2978
2979 // Load config before anything else
2980 $links[] = Html::inlineScript(
2981 ResourceLoader::makeLoaderConditionalScript(
2982 ResourceLoader::makeConfigSetScript( $this->getJSVars() )
2983 )
2984 );
2985
2986 // Load embeddable private modules before any loader links
2987 // This needs to be TYPE_COMBINED so these modules are properly wrapped
2988 // in mw.loader.implement() calls and deferred until mw.user is available
2989 $embedScripts = array( 'user.options', 'user.tokens' );
2990 $links[] = $this->makeResourceLoaderLink( $embedScripts, ResourceLoaderModule::TYPE_COMBINED );
2991
2992 // Scripts and messages "only" requests marked for top inclusion
2993 // Messages should go first
2994 $links[] = $this->makeResourceLoaderLink(
2995 $this->getModuleMessages( true, 'top' ),
2996 ResourceLoaderModule::TYPE_MESSAGES
2997 );
2998 $links[] = $this->makeResourceLoaderLink(
2999 $this->getModuleScripts( true, 'top' ),
3000 ResourceLoaderModule::TYPE_SCRIPTS
3001 );
3002
3003 // Modules requests - let the client calculate dependencies and batch requests as it likes
3004 // Only load modules that have marked themselves for loading at the top
3005 $modules = $this->getModules( true, 'top' );
3006 if ( $modules ) {
3007 $links[] = Html::inlineScript(
3008 ResourceLoader::makeLoaderConditionalScript(
3009 Xml::encodeJsCall( 'mw.loader.load', array( $modules ) )
3010 )
3011 );
3012 }
3013
3014 if ( $this->getConfig()->get( 'ResourceLoaderExperimentalAsyncLoading' ) ) {
3015 $links[] = $this->getScriptsForBottomQueue( true );
3016 }
3017
3018 return self::getHtmlFromLoaderLinks( $links );
3019 }
3020
3021 /**
3022 * JS stuff to put at the 'bottom', which can either be the bottom of the
3023 * "<body>" or the bottom of the "<head>" depending on
3024 * $wgResourceLoaderExperimentalAsyncLoading: modules marked with position
3025 * 'bottom', legacy scripts ($this->mScripts), user preferences, site JS
3026 * and user JS.
3027 *
3028 * @param bool $inHead If true, this HTML goes into the "<head>",
3029 * if false it goes into the "<body>".
3030 * @return string
3031 */
3032 function getScriptsForBottomQueue( $inHead ) {
3033 // Scripts and messages "only" requests marked for bottom inclusion
3034 // If we're in the <head>, use load() calls rather than <script src="..."> tags
3035 // Messages should go first
3036 $links = array();
3037 $links[] = $this->makeResourceLoaderLink( $this->getModuleMessages( true, 'bottom' ),
3038 ResourceLoaderModule::TYPE_MESSAGES, /* $useESI = */ false, /* $extraQuery = */ array(),
3039 /* $loadCall = */ $inHead
3040 );
3041 $links[] = $this->makeResourceLoaderLink( $this->getModuleScripts( true, 'bottom' ),
3042 ResourceLoaderModule::TYPE_SCRIPTS, /* $useESI = */ false, /* $extraQuery = */ array(),
3043 /* $loadCall = */ $inHead
3044 );
3045
3046 // Modules requests - let the client calculate dependencies and batch requests as it likes
3047 // Only load modules that have marked themselves for loading at the bottom
3048 $modules = $this->getModules( true, 'bottom' );
3049 if ( $modules ) {
3050 $links[] = Html::inlineScript(
3051 ResourceLoader::makeLoaderConditionalScript(
3052 Xml::encodeJsCall( 'mw.loader.load', array( $modules, null, true ) )
3053 )
3054 );
3055 }
3056
3057 // Legacy Scripts
3058 $links[] = "\n" . $this->mScripts;
3059
3060 // Add site JS if enabled
3061 $links[] = $this->makeResourceLoaderLink( 'site', ResourceLoaderModule::TYPE_SCRIPTS,
3062 /* $useESI = */ false, /* $extraQuery = */ array(), /* $loadCall = */ $inHead
3063 );
3064
3065 // Add user JS if enabled
3066 if ( $this->getConfig()->get( 'AllowUserJs' )
3067 && $this->getUser()->isLoggedIn()
3068 && $this->getTitle()
3069 && $this->getTitle()->isJsSubpage()
3070 && $this->userCanPreview()
3071 ) {
3072 # XXX: additional security check/prompt?
3073 // We're on a preview of a JS subpage
3074 // Exclude this page from the user module in case it's in there (bug 26283)
3075 $links[] = $this->makeResourceLoaderLink( 'user', ResourceLoaderModule::TYPE_SCRIPTS, false,
3076 array( 'excludepage' => $this->getTitle()->getPrefixedDBkey() ), $inHead
3077 );
3078 // Load the previewed JS
3079 $links[] = Html::inlineScript( "\n"
3080 . $this->getRequest()->getText( 'wpTextbox1' ) . "\n" ) . "\n";
3081
3082 // FIXME: If the user is previewing, say, ./vector.js, his ./common.js will be loaded
3083 // asynchronously and may arrive *after* the inline script here. So the previewed code
3084 // may execute before ./common.js runs. Normally, ./common.js runs before ./vector.js...
3085 } else {
3086 // Include the user module normally, i.e., raw to avoid it being wrapped in a closure.
3087 $links[] = $this->makeResourceLoaderLink( 'user', ResourceLoaderModule::TYPE_SCRIPTS,
3088 /* $useESI = */ false, /* $extraQuery = */ array(), /* $loadCall = */ $inHead
3089 );
3090 }
3091
3092 // Group JS is only enabled if site JS is enabled.
3093 $links[] = $this->makeResourceLoaderLink( 'user.groups', ResourceLoaderModule::TYPE_COMBINED,
3094 /* $useESI = */ false, /* $extraQuery = */ array(), /* $loadCall = */ $inHead
3095 );
3096
3097 return self::getHtmlFromLoaderLinks( $links );
3098 }
3099
3100 /**
3101 * JS stuff to put at the bottom of the "<body>"
3102 * @return string
3103 */
3104 function getBottomScripts() {
3105 // Optimise jQuery ready event cross-browser.
3106 // This also enforces $.isReady to be true at </body> which fixes the
3107 // mw.loader bug in Firefox with using document.write between </body>
3108 // and the DOMContentReady event (bug 47457).
3109 $html = Html::inlineScript( 'if(window.jQuery)jQuery.ready();' );
3110
3111 if ( !$this->getConfig()->get( 'ResourceLoaderExperimentalAsyncLoading' ) ) {
3112 $html .= $this->getScriptsForBottomQueue( false );
3113 }
3114
3115 return $html;
3116 }
3117
3118 /**
3119 * Get the javascript config vars to include on this page
3120 *
3121 * @return array Array of javascript config vars
3122 * @since 1.23
3123 */
3124 public function getJsConfigVars() {
3125 return $this->mJsConfigVars;
3126 }
3127
3128 /**
3129 * Add one or more variables to be set in mw.config in JavaScript
3130 *
3131 * @param string|array $keys Key or array of key/value pairs
3132 * @param mixed $value [optional] Value of the configuration variable
3133 */
3134 public function addJsConfigVars( $keys, $value = null ) {
3135 if ( is_array( $keys ) ) {
3136 foreach ( $keys as $key => $value ) {
3137 $this->mJsConfigVars[$key] = $value;
3138 }
3139 return;
3140 }
3141
3142 $this->mJsConfigVars[$keys] = $value;
3143 }
3144
3145 /**
3146 * Get an array containing the variables to be set in mw.config in JavaScript.
3147 *
3148 * Do not add things here which can be evaluated in ResourceLoaderStartUpModule
3149 * - in other words, page-independent/site-wide variables (without state).
3150 * You will only be adding bloat to the html page and causing page caches to
3151 * have to be purged on configuration changes.
3152 * @return array
3153 */
3154 public function getJSVars() {
3155 global $wgContLang;
3156
3157 $curRevisionId = 0;
3158 $articleId = 0;
3159 $canonicalSpecialPageName = false; # bug 21115
3160
3161 $title = $this->getTitle();
3162 $ns = $title->getNamespace();
3163 $canonicalNamespace = MWNamespace::exists( $ns )
3164 ? MWNamespace::getCanonicalName( $ns )
3165 : $title->getNsText();
3166
3167 $sk = $this->getSkin();
3168 // Get the relevant title so that AJAX features can use the correct page name
3169 // when making API requests from certain special pages (bug 34972).
3170 $relevantTitle = $sk->getRelevantTitle();
3171 $relevantUser = $sk->getRelevantUser();
3172
3173 if ( $ns == NS_SPECIAL ) {
3174 list( $canonicalSpecialPageName, /*...*/ ) =
3175 SpecialPageFactory::resolveAlias( $title->getDBkey() );
3176 } elseif ( $this->canUseWikiPage() ) {
3177 $wikiPage = $this->getWikiPage();
3178 $curRevisionId = $wikiPage->getLatest();
3179 $articleId = $wikiPage->getId();
3180 }
3181
3182 $lang = $title->getPageLanguage();
3183
3184 // Pre-process information
3185 $separatorTransTable = $lang->separatorTransformTable();
3186 $separatorTransTable = $separatorTransTable ? $separatorTransTable : array();
3187 $compactSeparatorTransTable = array(
3188 implode( "\t", array_keys( $separatorTransTable ) ),
3189 implode( "\t", $separatorTransTable ),
3190 );
3191 $digitTransTable = $lang->digitTransformTable();
3192 $digitTransTable = $digitTransTable ? $digitTransTable : array();
3193 $compactDigitTransTable = array(
3194 implode( "\t", array_keys( $digitTransTable ) ),
3195 implode( "\t", $digitTransTable ),
3196 );
3197
3198 $user = $this->getUser();
3199
3200 $vars = array(
3201 'wgCanonicalNamespace' => $canonicalNamespace,
3202 'wgCanonicalSpecialPageName' => $canonicalSpecialPageName,
3203 'wgNamespaceNumber' => $title->getNamespace(),
3204 'wgPageName' => $title->getPrefixedDBkey(),
3205 'wgTitle' => $title->getText(),
3206 'wgCurRevisionId' => $curRevisionId,
3207 'wgRevisionId' => (int)$this->getRevisionId(),
3208 'wgArticleId' => $articleId,
3209 'wgIsArticle' => $this->isArticle(),
3210 'wgIsRedirect' => $title->isRedirect(),
3211 'wgAction' => Action::getActionName( $this->getContext() ),
3212 'wgUserName' => $user->isAnon() ? null : $user->getName(),
3213 'wgUserGroups' => $user->getEffectiveGroups(),
3214 'wgCategories' => $this->getCategories(),
3215 'wgBreakFrames' => $this->getFrameOptions() == 'DENY',
3216 'wgPageContentLanguage' => $lang->getCode(),
3217 'wgPageContentModel' => $title->getContentModel(),
3218 'wgSeparatorTransformTable' => $compactSeparatorTransTable,
3219 'wgDigitTransformTable' => $compactDigitTransTable,
3220 'wgDefaultDateFormat' => $lang->getDefaultDateFormat(),
3221 'wgMonthNames' => $lang->getMonthNamesArray(),
3222 'wgMonthNamesShort' => $lang->getMonthAbbreviationsArray(),
3223 'wgRelevantPageName' => $relevantTitle->getPrefixedDBkey(),
3224 'wgRelevantArticleId' => $relevantTitle->getArticleId(),
3225 );
3226
3227 if ( $user->isLoggedIn() ) {
3228 $vars['wgUserId'] = $user->getId();
3229 $vars['wgUserEditCount'] = $user->getEditCount();
3230 $userReg = wfTimestampOrNull( TS_UNIX, $user->getRegistration() );
3231 $vars['wgUserRegistration'] = $userReg !== null ? ( $userReg * 1000 ) : null;
3232 // Get the revision ID of the oldest new message on the user's talk
3233 // page. This can be used for constructing new message alerts on
3234 // the client side.
3235 $vars['wgUserNewMsgRevisionId'] = $user->getNewMessageRevisionId();
3236 }
3237
3238 if ( $wgContLang->hasVariants() ) {
3239 $vars['wgUserVariant'] = $wgContLang->getPreferredVariant();
3240 }
3241 // Same test as SkinTemplate
3242 $vars['wgIsProbablyEditable'] = $title->quickUserCan( 'edit', $user )
3243 && ( $title->exists() || $title->quickUserCan( 'create', $user ) );
3244
3245 foreach ( $title->getRestrictionTypes() as $type ) {
3246 $vars['wgRestriction' . ucfirst( $type )] = $title->getRestrictions( $type );
3247 }
3248
3249 if ( $title->isMainPage() ) {
3250 $vars['wgIsMainPage'] = true;
3251 }
3252
3253 if ( $this->mRedirectedFrom ) {
3254 $vars['wgRedirectedFrom'] = $this->mRedirectedFrom->getPrefixedDBkey();
3255 }
3256
3257 if ( $relevantUser ) {
3258 $vars['wgRelevantUserName'] = $relevantUser->getName();
3259 }
3260
3261 // Allow extensions to add their custom variables to the mw.config map.
3262 // Use the 'ResourceLoaderGetConfigVars' hook if the variable is not
3263 // page-dependant but site-wide (without state).
3264 // Alternatively, you may want to use OutputPage->addJsConfigVars() instead.
3265 Hooks::run( 'MakeGlobalVariablesScript', array( &$vars, $this ) );
3266
3267 // Merge in variables from addJsConfigVars last
3268 return array_merge( $vars, $this->getJsConfigVars() );
3269 }
3270
3271 /**
3272 * To make it harder for someone to slip a user a fake
3273 * user-JavaScript or user-CSS preview, a random token
3274 * is associated with the login session. If it's not
3275 * passed back with the preview request, we won't render
3276 * the code.
3277 *
3278 * @return bool
3279 */
3280 public function userCanPreview() {
3281 if ( $this->getRequest()->getVal( 'action' ) != 'submit'
3282 || !$this->getRequest()->wasPosted()
3283 || !$this->getUser()->matchEditToken(
3284 $this->getRequest()->getVal( 'wpEditToken' ) )
3285 ) {
3286 return false;
3287 }
3288 if ( !$this->getTitle()->isJsSubpage() && !$this->getTitle()->isCssSubpage() ) {
3289 return false;
3290 }
3291 if ( !$this->getTitle()->isSubpageOf( $this->getUser()->getUserPage() ) ) {
3292 // Don't execute another user's CSS or JS on preview (T85855)
3293 return false;
3294 }
3295
3296 return !count( $this->getTitle()->getUserPermissionsErrors( 'edit', $this->getUser() ) );
3297 }
3298
3299 /**
3300 * @return array Array in format "link name or number => 'link html'".
3301 */
3302 public function getHeadLinksArray() {
3303 global $wgVersion;
3304
3305 $tags = array();
3306 $config = $this->getConfig();
3307
3308 $canonicalUrl = $this->mCanonicalUrl;
3309
3310 $tags['meta-generator'] = Html::element( 'meta', array(
3311 'name' => 'generator',
3312 'content' => "MediaWiki $wgVersion",
3313 ) );
3314
3315 if ( $config->get( 'ReferrerPolicy' ) !== false ) {
3316 $tags['meta-referrer'] = Html::element( 'meta', array(
3317 'name' => 'referrer',
3318 'content' => $config->get( 'ReferrerPolicy' )
3319 ) );
3320 }
3321
3322 $p = "{$this->mIndexPolicy},{$this->mFollowPolicy}";
3323 if ( $p !== 'index,follow' ) {
3324 // http://www.robotstxt.org/wc/meta-user.html
3325 // Only show if it's different from the default robots policy
3326 $tags['meta-robots'] = Html::element( 'meta', array(
3327 'name' => 'robots',
3328 'content' => $p,
3329 ) );
3330 }
3331
3332 foreach ( $this->mMetatags as $tag ) {
3333 if ( 0 == strcasecmp( 'http:', substr( $tag[0], 0, 5 ) ) ) {
3334 $a = 'http-equiv';
3335 $tag[0] = substr( $tag[0], 5 );
3336 } else {
3337 $a = 'name';
3338 }
3339 $tagName = "meta-{$tag[0]}";
3340 if ( isset( $tags[$tagName] ) ) {
3341 $tagName .= $tag[1];
3342 }
3343 $tags[$tagName] = Html::element( 'meta',
3344 array(
3345 $a => $tag[0],
3346 'content' => $tag[1]
3347 )
3348 );
3349 }
3350
3351 foreach ( $this->mLinktags as $tag ) {
3352 $tags[] = Html::element( 'link', $tag );
3353 }
3354
3355 # Universal edit button
3356 if ( $config->get( 'UniversalEditButton' ) && $this->isArticleRelated() ) {
3357 $user = $this->getUser();
3358 if ( $this->getTitle()->quickUserCan( 'edit', $user )
3359 && ( $this->getTitle()->exists() || $this->getTitle()->quickUserCan( 'create', $user ) ) ) {
3360 // Original UniversalEditButton
3361 $msg = $this->msg( 'edit' )->text();
3362 $tags['universal-edit-button'] = Html::element( 'link', array(
3363 'rel' => 'alternate',
3364 'type' => 'application/x-wiki',
3365 'title' => $msg,
3366 'href' => $this->getTitle()->getEditURL(),
3367 ) );
3368 // Alternate edit link
3369 $tags['alternative-edit'] = Html::element( 'link', array(
3370 'rel' => 'edit',
3371 'title' => $msg,
3372 'href' => $this->getTitle()->getEditURL(),
3373 ) );
3374 }
3375 }
3376
3377 # Generally the order of the favicon and apple-touch-icon links
3378 # should not matter, but Konqueror (3.5.9 at least) incorrectly
3379 # uses whichever one appears later in the HTML source. Make sure
3380 # apple-touch-icon is specified first to avoid this.
3381 if ( $config->get( 'AppleTouchIcon' ) !== false ) {
3382 $tags['apple-touch-icon'] = Html::element( 'link', array(
3383 'rel' => 'apple-touch-icon',
3384 'href' => $config->get( 'AppleTouchIcon' )
3385 ) );
3386 }
3387
3388 if ( $config->get( 'Favicon' ) !== false ) {
3389 $tags['favicon'] = Html::element( 'link', array(
3390 'rel' => 'shortcut icon',
3391 'href' => $config->get( 'Favicon' )
3392 ) );
3393 }
3394
3395 # OpenSearch description link
3396 $tags['opensearch'] = Html::element( 'link', array(
3397 'rel' => 'search',
3398 'type' => 'application/opensearchdescription+xml',
3399 'href' => wfScript( 'opensearch_desc' ),
3400 'title' => $this->msg( 'opensearch-desc' )->inContentLanguage()->text(),
3401 ) );
3402
3403 if ( $config->get( 'EnableAPI' ) ) {
3404 # Real Simple Discovery link, provides auto-discovery information
3405 # for the MediaWiki API (and potentially additional custom API
3406 # support such as WordPress or Twitter-compatible APIs for a
3407 # blogging extension, etc)
3408 $tags['rsd'] = Html::element( 'link', array(
3409 'rel' => 'EditURI',
3410 'type' => 'application/rsd+xml',
3411 // Output a protocol-relative URL here if $wgServer is protocol-relative
3412 // Whether RSD accepts relative or protocol-relative URLs is completely undocumented, though
3413 'href' => wfExpandUrl( wfAppendQuery(
3414 wfScript( 'api' ),
3415 array( 'action' => 'rsd' ) ),
3416 PROTO_RELATIVE
3417 ),
3418 ) );
3419 }
3420
3421 # Language variants
3422 if ( !$config->get( 'DisableLangConversion' ) ) {
3423 $lang = $this->getTitle()->getPageLanguage();
3424 if ( $lang->hasVariants() ) {
3425 $variants = $lang->getVariants();
3426 foreach ( $variants as $_v ) {
3427 $tags["variant-$_v"] = Html::element( 'link', array(
3428 'rel' => 'alternate',
3429 'hreflang' => wfBCP47( $_v ),
3430 'href' => $this->getTitle()->getLocalURL( array( 'variant' => $_v ) ) )
3431 );
3432 }
3433 }
3434 # x-default link per https://support.google.com/webmasters/answer/189077?hl=en
3435 $tags["variant-x-default"] = Html::element( 'link', array(
3436 'rel' => 'alternate',
3437 'hreflang' => 'x-default',
3438 'href' => $this->getTitle()->getLocalURL() ) );
3439 }
3440
3441 # Copyright
3442 $copyright = '';
3443 if ( $config->get( 'RightsPage' ) ) {
3444 $copy = Title::newFromText( $config->get( 'RightsPage' ) );
3445
3446 if ( $copy ) {
3447 $copyright = $copy->getLocalURL();
3448 }
3449 }
3450
3451 if ( !$copyright && $config->get( 'RightsUrl' ) ) {
3452 $copyright = $config->get( 'RightsUrl' );
3453 }
3454
3455 if ( $copyright ) {
3456 $tags['copyright'] = Html::element( 'link', array(
3457 'rel' => 'copyright',
3458 'href' => $copyright )
3459 );
3460 }
3461
3462 # Feeds
3463 if ( $config->get( 'Feed' ) ) {
3464 foreach ( $this->getSyndicationLinks() as $format => $link ) {
3465 # Use the page name for the title. In principle, this could
3466 # lead to issues with having the same name for different feeds
3467 # corresponding to the same page, but we can't avoid that at
3468 # this low a level.
3469
3470 $tags[] = $this->feedLink(
3471 $format,
3472 $link,
3473 # Used messages: 'page-rss-feed' and 'page-atom-feed' (for an easier grep)
3474 $this->msg( "page-{$format}-feed", $this->getTitle()->getPrefixedText() )->text()
3475 );
3476 }
3477
3478 # Recent changes feed should appear on every page (except recentchanges,
3479 # that would be redundant). Put it after the per-page feed to avoid
3480 # changing existing behavior. It's still available, probably via a
3481 # menu in your browser. Some sites might have a different feed they'd
3482 # like to promote instead of the RC feed (maybe like a "Recent New Articles"
3483 # or "Breaking news" one). For this, we see if $wgOverrideSiteFeed is defined.
3484 # If so, use it instead.
3485 $sitename = $config->get( 'Sitename' );
3486 if ( $config->get( 'OverrideSiteFeed' ) ) {
3487 foreach ( $config->get( 'OverrideSiteFeed' ) as $type => $feedUrl ) {
3488 // Note, this->feedLink escapes the url.
3489 $tags[] = $this->feedLink(
3490 $type,
3491 $feedUrl,
3492 $this->msg( "site-{$type}-feed", $sitename )->text()
3493 );
3494 }
3495 } elseif ( !$this->getTitle()->isSpecial( 'Recentchanges' ) ) {
3496 $rctitle = SpecialPage::getTitleFor( 'Recentchanges' );
3497 foreach ( $config->get( 'AdvertisedFeedTypes' ) as $format ) {
3498 $tags[] = $this->feedLink(
3499 $format,
3500 $rctitle->getLocalURL( array( 'feed' => $format ) ),
3501 # For grep: 'site-rss-feed', 'site-atom-feed'
3502 $this->msg( "site-{$format}-feed", $sitename )->text()
3503 );
3504 }
3505 }
3506 }
3507
3508 # Canonical URL
3509 if ( $config->get( 'EnableCanonicalServerLink' ) ) {
3510 if ( $canonicalUrl !== false ) {
3511 $canonicalUrl = wfExpandUrl( $canonicalUrl, PROTO_CANONICAL );
3512 } else {
3513 $reqUrl = $this->getRequest()->getRequestURL();
3514 $canonicalUrl = wfExpandUrl( $reqUrl, PROTO_CANONICAL );
3515 }
3516 }
3517 if ( $canonicalUrl !== false ) {
3518 $tags[] = Html::element( 'link', array(
3519 'rel' => 'canonical',
3520 'href' => $canonicalUrl
3521 ) );
3522 }
3523
3524 return $tags;
3525 }
3526
3527 /**
3528 * @return string HTML tag links to be put in the header.
3529 * @deprecated since 1.24 Use OutputPage::headElement or if you have to,
3530 * OutputPage::getHeadLinksArray directly.
3531 */
3532 public function getHeadLinks() {
3533 wfDeprecated( __METHOD__, '1.24' );
3534 return implode( "\n", $this->getHeadLinksArray() );
3535 }
3536
3537 /**
3538 * Generate a "<link rel/>" for a feed.
3539 *
3540 * @param string $type Feed type
3541 * @param string $url URL to the feed
3542 * @param string $text Value of the "title" attribute
3543 * @return string HTML fragment
3544 */
3545 private function feedLink( $type, $url, $text ) {
3546 return Html::element( 'link', array(
3547 'rel' => 'alternate',
3548 'type' => "application/$type+xml",
3549 'title' => $text,
3550 'href' => $url )
3551 );
3552 }
3553
3554 /**
3555 * Add a local or specified stylesheet, with the given media options.
3556 * Meant primarily for internal use...
3557 *
3558 * @param string $style URL to the file
3559 * @param string $media To specify a media type, 'screen', 'printable', 'handheld' or any.
3560 * @param string $condition For IE conditional comments, specifying an IE version
3561 * @param string $dir Set to 'rtl' or 'ltr' for direction-specific sheets
3562 */
3563 public function addStyle( $style, $media = '', $condition = '', $dir = '' ) {
3564 $options = array();
3565 // Even though we expect the media type to be lowercase, but here we
3566 // force it to lowercase to be safe.
3567 if ( $media ) {
3568 $options['media'] = $media;
3569 }
3570 if ( $condition ) {
3571 $options['condition'] = $condition;
3572 }
3573 if ( $dir ) {
3574 $options['dir'] = $dir;
3575 }
3576 $this->styles[$style] = $options;
3577 }
3578
3579 /**
3580 * Adds inline CSS styles
3581 * @param mixed $style_css Inline CSS
3582 * @param string $flip Set to 'flip' to flip the CSS if needed
3583 */
3584 public function addInlineStyle( $style_css, $flip = 'noflip' ) {
3585 if ( $flip === 'flip' && $this->getLanguage()->isRTL() ) {
3586 # If wanted, and the interface is right-to-left, flip the CSS
3587 $style_css = CSSJanus::transform( $style_css, true, false );
3588 }
3589 $this->mInlineStyles .= Html::inlineStyle( $style_css ) . "\n";
3590 }
3591
3592 /**
3593 * Build a set of "<link>" elements for the stylesheets specified in the $this->styles array.
3594 * These will be applied to various media & IE conditionals.
3595 *
3596 * @return string
3597 */
3598 public function buildCssLinks() {
3599 global $wgContLang;
3600
3601 $this->getSkin()->setupSkinUserCss( $this );
3602
3603 // Add ResourceLoader styles
3604 // Split the styles into these groups
3605 $styles = array(
3606 'other' => array(),
3607 'user' => array(),
3608 'site' => array(),
3609 'private' => array(),
3610 'noscript' => array()
3611 );
3612 $links = array();
3613 $otherTags = ''; // Tags to append after the normal <link> tags
3614 $resourceLoader = $this->getResourceLoader();
3615
3616 $moduleStyles = $this->getModuleStyles();
3617
3618 // Per-site custom styles
3619 $moduleStyles[] = 'site';
3620 $moduleStyles[] = 'noscript';
3621 $moduleStyles[] = 'user.groups';
3622
3623 // Per-user custom styles
3624 if ( $this->getConfig()->get( 'AllowUserCss' ) && $this->getTitle()->isCssSubpage()
3625 && $this->userCanPreview()
3626 ) {
3627 // We're on a preview of a CSS subpage
3628 // Exclude this page from the user module in case it's in there (bug 26283)
3629 $link = $this->makeResourceLoaderLink( 'user', ResourceLoaderModule::TYPE_STYLES, false,
3630 array( 'excludepage' => $this->getTitle()->getPrefixedDBkey() )
3631 );
3632 $otherTags .= $link['html'];
3633
3634 // Load the previewed CSS
3635 // If needed, Janus it first. This is user-supplied CSS, so it's
3636 // assumed to be right for the content language directionality.
3637 $previewedCSS = $this->getRequest()->getText( 'wpTextbox1' );
3638 if ( $this->getLanguage()->getDir() !== $wgContLang->getDir() ) {
3639 $previewedCSS = CSSJanus::transform( $previewedCSS, true, false );
3640 }
3641 $otherTags .= Html::inlineStyle( $previewedCSS ) . "\n";
3642 } else {
3643 // Load the user styles normally
3644 $moduleStyles[] = 'user';
3645 }
3646
3647 // Per-user preference styles
3648 $moduleStyles[] = 'user.cssprefs';
3649
3650 foreach ( $moduleStyles as $name ) {
3651 $module = $resourceLoader->getModule( $name );
3652 if ( !$module ) {
3653 continue;
3654 }
3655 $group = $module->getGroup();
3656 // Modules in groups different than the ones listed on top (see $styles assignment)
3657 // will be placed in the "other" group
3658 $styles[isset( $styles[$group] ) ? $group : 'other'][] = $name;
3659 }
3660
3661 // We want site, private and user styles to override dynamically added
3662 // styles from modules, but we want dynamically added styles to override
3663 // statically added styles from other modules. So the order has to be
3664 // other, dynamic, site, private, user. Add statically added styles for
3665 // other modules
3666 $links[] = $this->makeResourceLoaderLink( $styles['other'], ResourceLoaderModule::TYPE_STYLES );
3667 // Add normal styles added through addStyle()/addInlineStyle() here
3668 $links[] = implode( "\n", $this->buildCssLinksArray() ) . $this->mInlineStyles;
3669 // Add marker tag to mark the place where the client-side loader should inject dynamic styles
3670 // We use a <meta> tag with a made-up name for this because that's valid HTML
3671 $links[] = Html::element(
3672 'meta',
3673 array( 'name' => 'ResourceLoaderDynamicStyles', 'content' => '' )
3674 ) . "\n";
3675
3676 // Add site, private and user styles
3677 // 'private' at present only contains user.options, so put that before 'user'
3678 // Any future private modules will likely have a similar user-specific character
3679 foreach ( array( 'site', 'noscript', 'private', 'user' ) as $group ) {
3680 $links[] = $this->makeResourceLoaderLink( $styles[$group],
3681 ResourceLoaderModule::TYPE_STYLES
3682 );
3683 }
3684
3685 // Add stuff in $otherTags (previewed user CSS if applicable)
3686 return self::getHtmlFromLoaderLinks( $links ) . $otherTags;
3687 }
3688
3689 /**
3690 * @return array
3691 */
3692 public function buildCssLinksArray() {
3693 $links = array();
3694
3695 // Add any extension CSS
3696 foreach ( $this->mExtStyles as $url ) {
3697 $this->addStyle( $url );
3698 }
3699 $this->mExtStyles = array();
3700
3701 foreach ( $this->styles as $file => $options ) {
3702 $link = $this->styleLink( $file, $options );
3703 if ( $link ) {
3704 $links[$file] = $link;
3705 }
3706 }
3707 return $links;
3708 }
3709
3710 /**
3711 * Generate \<link\> tags for stylesheets
3712 *
3713 * @param string $style URL to the file
3714 * @param array $options Option, can contain 'condition', 'dir', 'media' keys
3715 * @return string HTML fragment
3716 */
3717 protected function styleLink( $style, array $options ) {
3718 if ( isset( $options['dir'] ) ) {
3719 if ( $this->getLanguage()->getDir() != $options['dir'] ) {
3720 return '';
3721 }
3722 }
3723
3724 if ( isset( $options['media'] ) ) {
3725 $media = self::transformCssMedia( $options['media'] );
3726 if ( is_null( $media ) ) {
3727 return '';
3728 }
3729 } else {
3730 $media = 'all';
3731 }
3732
3733 if ( substr( $style, 0, 1 ) == '/' ||
3734 substr( $style, 0, 5 ) == 'http:' ||
3735 substr( $style, 0, 6 ) == 'https:' ) {
3736 $url = $style;
3737 } else {
3738 $config = $this->getConfig();
3739 $url = $config->get( 'StylePath' ) . '/' . $style . '?' . $config->get( 'StyleVersion' );
3740 }
3741
3742 $link = Html::linkedStyle( $url, $media );
3743
3744 if ( isset( $options['condition'] ) ) {
3745 $condition = htmlspecialchars( $options['condition'] );
3746 $link = "<!--[if $condition]>$link<![endif]-->";
3747 }
3748 return $link;
3749 }
3750
3751 /**
3752 * Transform "media" attribute based on request parameters
3753 *
3754 * @param string $media Current value of the "media" attribute
3755 * @return string Modified value of the "media" attribute, or null to skip
3756 * this stylesheet
3757 */
3758 public static function transformCssMedia( $media ) {
3759 global $wgRequest;
3760
3761 // http://www.w3.org/TR/css3-mediaqueries/#syntax
3762 $screenMediaQueryRegex = '/^(?:only\s+)?screen\b/i';
3763
3764 // Switch in on-screen display for media testing
3765 $switches = array(
3766 'printable' => 'print',
3767 'handheld' => 'handheld',
3768 );
3769 foreach ( $switches as $switch => $targetMedia ) {
3770 if ( $wgRequest->getBool( $switch ) ) {
3771 if ( $media == $targetMedia ) {
3772 $media = '';
3773 } elseif ( preg_match( $screenMediaQueryRegex, $media ) === 1 ) {
3774 // This regex will not attempt to understand a comma-separated media_query_list
3775 //
3776 // Example supported values for $media:
3777 // 'screen', 'only screen', 'screen and (min-width: 982px)' ),
3778 // Example NOT supported value for $media:
3779 // '3d-glasses, screen, print and resolution > 90dpi'
3780 //
3781 // If it's a print request, we never want any kind of screen stylesheets
3782 // If it's a handheld request (currently the only other choice with a switch),
3783 // we don't want simple 'screen' but we might want screen queries that
3784 // have a max-width or something, so we'll pass all others on and let the
3785 // client do the query.
3786 if ( $targetMedia == 'print' || $media == 'screen' ) {
3787 return null;
3788 }
3789 }
3790 }
3791 }
3792
3793 return $media;
3794 }
3795
3796 /**
3797 * Add a wikitext-formatted message to the output.
3798 * This is equivalent to:
3799 *
3800 * $wgOut->addWikiText( wfMessage( ... )->plain() )
3801 */
3802 public function addWikiMsg( /*...*/ ) {
3803 $args = func_get_args();
3804 $name = array_shift( $args );
3805 $this->addWikiMsgArray( $name, $args );
3806 }
3807
3808 /**
3809 * Add a wikitext-formatted message to the output.
3810 * Like addWikiMsg() except the parameters are taken as an array
3811 * instead of a variable argument list.
3812 *
3813 * @param string $name
3814 * @param array $args
3815 */
3816 public function addWikiMsgArray( $name, $args ) {
3817 $this->addHTML( $this->msg( $name, $args )->parseAsBlock() );
3818 }
3819
3820 /**
3821 * This function takes a number of message/argument specifications, wraps them in
3822 * some overall structure, and then parses the result and adds it to the output.
3823 *
3824 * In the $wrap, $1 is replaced with the first message, $2 with the second,
3825 * and so on. The subsequent arguments may be either
3826 * 1) strings, in which case they are message names, or
3827 * 2) arrays, in which case, within each array, the first element is the message
3828 * name, and subsequent elements are the parameters to that message.
3829 *
3830 * Don't use this for messages that are not in the user's interface language.
3831 *
3832 * For example:
3833 *
3834 * $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>", 'some-error' );
3835 *
3836 * Is equivalent to:
3837 *
3838 * $wgOut->addWikiText( "<div class='error'>\n"
3839 * . wfMessage( 'some-error' )->plain() . "\n</div>" );
3840 *
3841 * The newline after the opening div is needed in some wikitext. See bug 19226.
3842 *
3843 * @param string $wrap
3844 */
3845 public function wrapWikiMsg( $wrap /*, ...*/ ) {
3846 $msgSpecs = func_get_args();
3847 array_shift( $msgSpecs );
3848 $msgSpecs = array_values( $msgSpecs );
3849 $s = $wrap;
3850 foreach ( $msgSpecs as $n => $spec ) {
3851 if ( is_array( $spec ) ) {
3852 $args = $spec;
3853 $name = array_shift( $args );
3854 if ( isset( $args['options'] ) ) {
3855 unset( $args['options'] );
3856 wfDeprecated(
3857 'Adding "options" to ' . __METHOD__ . ' is no longer supported',
3858 '1.20'
3859 );
3860 }
3861 } else {
3862 $args = array();
3863 $name = $spec;
3864 }
3865 $s = str_replace( '$' . ( $n + 1 ), $this->msg( $name, $args )->plain(), $s );
3866 }
3867 $this->addWikiText( $s );
3868 }
3869
3870 /**
3871 * Include jQuery core. Use this to avoid loading it multiple times
3872 * before we get a usable script loader.
3873 *
3874 * @param array $modules List of jQuery modules which should be loaded
3875 * @return array The list of modules which were not loaded.
3876 * @since 1.16
3877 * @deprecated since 1.17
3878 */
3879 public function includeJQuery( array $modules = array() ) {
3880 return array();
3881 }
3882
3883 /**
3884 * Enables/disables TOC, doesn't override __NOTOC__
3885 * @param bool $flag
3886 * @since 1.22
3887 */
3888 public function enableTOC( $flag = true ) {
3889 $this->mEnableTOC = $flag;
3890 }
3891
3892 /**
3893 * @return bool
3894 * @since 1.22
3895 */
3896 public function isTOCEnabled() {
3897 return $this->mEnableTOC;
3898 }
3899
3900 /**
3901 * Enables/disables section edit links, doesn't override __NOEDITSECTION__
3902 * @param bool $flag
3903 * @since 1.23
3904 */
3905 public function enableSectionEditLinks( $flag = true ) {
3906 $this->mEnableSectionEditLinks = $flag;
3907 }
3908
3909 /**
3910 * @return bool
3911 * @since 1.23
3912 */
3913 public function sectionEditLinksEnabled() {
3914 return $this->mEnableSectionEditLinks;
3915 }
3916
3917 /**
3918 * Add ResourceLoader module styles for OOUI and set up the PHP implementation of it for use with
3919 * MediaWiki and this OutputPage instance.
3920 *
3921 * @since 1.25
3922 */
3923 public function enableOOUI() {
3924 OOUI\Theme::setSingleton( new OOUI\MediaWikiTheme() );
3925 OOUI\Element::setDefaultDir( $this->getLanguage()->getDir() );
3926 $this->addModuleStyles( 'oojs-ui.styles' );
3927 }
3928 }
Wiklou, le Wiki du Wiklou