Use IContextSource instead of RequestContext inside type hints and instanceof checks...
[lhc/web/wiklou.git] / includes / OutputPage.php
1 <?php
2 if ( !defined( 'MEDIAWIKI' ) ) {
3 die( 1 );
4 }
5
6 /**
7 * This class should be covered by a general architecture document which does
8 * not exist as of January 2011. This is one of the Core classes and should
9 * be read at least once by any new developers.
10 *
11 * This class is used to prepare the final rendering. A skin is then
12 * applied to the output parameters (links, javascript, html, categories ...).
13 *
14 * @todo FIXME: Another class handles sending the whole page to the client.
15 *
16 * Some comments comes from a pairing session between Zak Greant and Ashar Voultoiz
17 * in November 2010.
18 *
19 * @todo document
20 */
21 class OutputPage extends ContextSource {
22 /// Should be private. Used with addMeta() which adds <meta>
23 var $mMetatags = array();
24
25 /// <meta keyworkds="stuff"> most of the time the first 10 links to an article
26 var $mKeywords = array();
27
28 var $mLinktags = array();
29
30 /// Additional stylesheets. Looks like this is for extensions. Might be replaced by resource loader.
31 var $mExtStyles = array();
32
33 /// Should be private - has getter and setter. Contains the HTML title
34 var $mPagetitle = '';
35
36 /// Contains all of the <body> content. Should be private we got set/get accessors and the append() method.
37 var $mBodytext = '';
38
39 /**
40 * Holds the debug lines that will be output as comments in page source if
41 * $wgDebugComments is enabled. See also $wgShowDebug.
42 * TODO: make a getter method for this
43 */
44 public $mDebugtext = ''; // TODO: we might want to replace it by wfDebug() wfDebugLog()
45
46 /// Should be private. Stores contents of <title> tag
47 var $mHTMLtitle = '';
48
49 /// Should be private. Is the displayed content related to the source of the corresponding wiki article.
50 var $mIsarticle = false;
51
52 /**
53 * Should be private. Has get/set methods properly documented.
54 * Stores "article flag" toggle.
55 */
56 var $mIsArticleRelated = true;
57
58 /**
59 * Should be private. We have to set isPrintable(). Some pages should
60 * never be printed (ex: redirections).
61 */
62 var $mPrintable = false;
63
64 /**
65 * Should be private. We have set/get/append methods.
66 *
67 * Contains the page subtitle. Special pages usually have some links here.
68 * Don't confuse with site subtitle added by skins.
69 */
70 var $mSubtitle = '';
71
72 var $mRedirect = '';
73 var $mStatusCode;
74
75 /**
76 * mLastModified and mEtag are used for sending cache control.
77 * The whole caching system should probably be moved into its own class.
78 */
79 var $mLastModified = '';
80
81 /**
82 * Should be private. No getter but used in sendCacheControl();
83 * Contains an HTTP Entity Tags (see RFC 2616 section 3.13) which is used
84 * as a unique identifier for the content. It is later used by the client
85 * to compare its cached version with the server version. Client sends
86 * headers If-Match and If-None-Match containing its locally cached ETAG value.
87 *
88 * To get more information, you will have to look at HTTP/1.1 protocol which
89 * is properly described in RFC 2616 : http://tools.ietf.org/html/rfc2616
90 */
91 var $mETag = false;
92
93 var $mCategoryLinks = array();
94 var $mCategories = array();
95
96 /// Should be private. Array of Interwiki Prefixed (non DB key) Titles (e.g. 'fr:Test page')
97 var $mLanguageLinks = array();
98
99 /**
100 * Should be private. Used for JavaScript (pre resource loader)
101 * We should split js / css.
102 * mScripts content is inserted as is in <head> by Skin. This might contains
103 * either a link to a stylesheet or inline css.
104 */
105 var $mScripts = '';
106
107 /**
108 * Inline CSS styles. Use addInlineStyle() sparsingly
109 */
110 var $mInlineStyles = '';
111
112 //
113 var $mLinkColours;
114
115 /**
116 * Used by skin template.
117 * Example: $tpl->set( 'displaytitle', $out->mPageLinkTitle );
118 */
119 var $mPageLinkTitle = '';
120
121 /// Array of elements in <head>. Parser might add its own headers!
122 var $mHeadItems = array();
123
124 // @todo FIXME: Next variables probably comes from the resource loader
125 var $mModules = array(), $mModuleScripts = array(), $mModuleStyles = array(), $mModuleMessages = array();
126 var $mResourceLoader;
127
128 /** @todo FIXME: Is this still used ?*/
129 var $mInlineMsg = array();
130
131 var $mTemplateIds = array();
132 var $mImageTimeKeys = array();
133
134 var $mRedirectCode = '';
135
136 var $mFeedLinksAppendQuery = null;
137
138 # What level of 'untrustworthiness' is allowed in CSS/JS modules loaded on this page?
139 # @see ResourceLoaderModule::$origin
140 # ResourceLoaderModule::ORIGIN_ALL is assumed unless overridden;
141 protected $mAllowedModules = array(
142 ResourceLoaderModule::TYPE_COMBINED => ResourceLoaderModule::ORIGIN_ALL,
143 );
144
145 /**
146 * @EasterEgg I just love the name for this self documenting variable.
147 * @todo document
148 */
149 var $mDoNothing = false;
150
151 // Parser related.
152 var $mContainsOldMagic = 0, $mContainsNewMagic = 0;
153
154 /// lazy initialised, use parserOptions()
155 protected $mParserOptions = null;
156
157 /**
158 * Handles the atom / rss links.
159 * We probably only support atom in 2011.
160 * Looks like a private variable.
161 * @see $wgAdvertisedFeedTypes
162 */
163 var $mFeedLinks = array();
164
165 // Gwicke work on squid caching? Roughly from 2003.
166 var $mEnableClientCache = true;
167
168 /**
169 * Flag if output should only contain the body of the article.
170 * Should be private.
171 */
172 var $mArticleBodyOnly = false;
173
174 var $mNewSectionLink = false;
175 var $mHideNewSectionLink = false;
176
177 /**
178 * Comes from the parser. This was probably made to load CSS/JS only
179 * if we had <gallery>. Used directly in CategoryPage.php
180 * Looks like resource loader can replace this.
181 */
182 var $mNoGallery = false;
183
184 // should be private.
185 var $mPageTitleActionText = '';
186 var $mParseWarnings = array();
187
188 // Cache stuff. Looks like mEnableClientCache
189 var $mSquidMaxage = 0;
190
191 // @todo document
192 var $mPreventClickjacking = true;
193
194 /// should be private. To include the variable {{REVISIONID}}
195 var $mRevisionId = null;
196
197 var $mFileVersion = null;
198
199 /**
200 * An array of stylesheet filenames (relative from skins path), with options
201 * for CSS media, IE conditions, and RTL/LTR direction.
202 * For internal use; add settings in the skin via $this->addStyle()
203 *
204 * Style again! This seems like a code duplication since we already have
205 * mStyles. This is what makes OpenSource amazing.
206 */
207 var $styles = array();
208
209 /**
210 * Whether jQuery is already handled.
211 */
212 protected $mJQueryDone = false;
213
214 private $mIndexPolicy = 'index';
215 private $mFollowPolicy = 'follow';
216 private $mVaryHeader = array(
217 'Accept-Encoding' => array( 'list-contains=gzip' ),
218 'Cookie' => null
219 );
220
221 /**
222 * Constructor for OutputPage. This should not be called directly.
223 * Instead a new RequestContext should be created and it will implicitly create
224 * a OutputPage tied to that context.
225 */
226 function __construct( IContextSource $context = null ) {
227 if ( $context === null ) {
228 # Extensions should use `new RequestContext` instead of `new OutputPage` now.
229 wfDeprecated( __METHOD__ );
230 } else {
231 $this->setContext( $context );
232 }
233 }
234
235 /**
236 * Redirect to $url rather than displaying the normal page
237 *
238 * @param $url String: URL
239 * @param $responsecode String: HTTP status code
240 */
241 public function redirect( $url, $responsecode = '302' ) {
242 # Strip newlines as a paranoia check for header injection in PHP<5.1.2
243 $this->mRedirect = str_replace( "\n", '', $url );
244 $this->mRedirectCode = $responsecode;
245 }
246
247 /**
248 * Get the URL to redirect to, or an empty string if not redirect URL set
249 *
250 * @return String
251 */
252 public function getRedirect() {
253 return $this->mRedirect;
254 }
255
256 /**
257 * Set the HTTP status code to send with the output.
258 *
259 * @param $statusCode Integer
260 */
261 public function setStatusCode( $statusCode ) {
262 $this->mStatusCode = $statusCode;
263 }
264
265 /**
266 * Add a new <meta> tag
267 * To add an http-equiv meta tag, precede the name with "http:"
268 *
269 * @param $name String tag name
270 * @param $val String tag value
271 */
272 function addMeta( $name, $val ) {
273 array_push( $this->mMetatags, array( $name, $val ) );
274 }
275
276 /**
277 * Add a keyword or a list of keywords in the page header
278 *
279 * @param $text String or array of strings
280 */
281 function addKeyword( $text ) {
282 if( is_array( $text ) ) {
283 $this->mKeywords = array_merge( $this->mKeywords, $text );
284 } else {
285 array_push( $this->mKeywords, $text );
286 }
287 }
288
289 /**
290 * Add a new \<link\> tag to the page header
291 *
292 * @param $linkarr Array: associative array of attributes.
293 */
294 function addLink( $linkarr ) {
295 array_push( $this->mLinktags, $linkarr );
296 }
297
298 /**
299 * Add a new \<link\> with "rel" attribute set to "meta"
300 *
301 * @param $linkarr Array: associative array mapping attribute names to their
302 * values, both keys and values will be escaped, and the
303 * "rel" attribute will be automatically added
304 */
305 function addMetadataLink( $linkarr ) {
306 $linkarr['rel'] = $this->getMetadataAttribute();
307 $this->addLink( $linkarr );
308 }
309
310 /**
311 * Get the value of the "rel" attribute for metadata links
312 *
313 * @return String
314 */
315 public function getMetadataAttribute() {
316 # note: buggy CC software only reads first "meta" link
317 static $haveMeta = false;
318 if ( $haveMeta ) {
319 return 'alternate meta';
320 } else {
321 $haveMeta = true;
322 return 'meta';
323 }
324 }
325
326 /**
327 * Add raw HTML to the list of scripts (including \<script\> tag, etc.)
328 *
329 * @param $script String: raw HTML
330 */
331 function addScript( $script ) {
332 $this->mScripts .= $script . "\n";
333 }
334
335 /**
336 * Register and add a stylesheet from an extension directory.
337 *
338 * @param $url String path to sheet. Provide either a full url (beginning
339 * with 'http', etc) or a relative path from the document root
340 * (beginning with '/'). Otherwise it behaves identically to
341 * addStyle() and draws from the /skins folder.
342 */
343 public function addExtensionStyle( $url ) {
344 array_push( $this->mExtStyles, $url );
345 }
346
347 /**
348 * Get all styles added by extensions
349 *
350 * @return Array
351 */
352 function getExtStyle() {
353 return $this->mExtStyles;
354 }
355
356 /**
357 * Add a JavaScript file out of skins/common, or a given relative path.
358 *
359 * @param $file String: filename in skins/common or complete on-server path
360 * (/foo/bar.js)
361 * @param $version String: style version of the file. Defaults to $wgStyleVersion
362 */
363 public function addScriptFile( $file, $version = null ) {
364 global $wgStylePath, $wgStyleVersion;
365 // See if $file parameter is an absolute URL or begins with a slash
366 if( substr( $file, 0, 1 ) == '/' || preg_match( '#^[a-z]*://#i', $file ) ) {
367 $path = $file;
368 } else {
369 $path = "{$wgStylePath}/common/{$file}";
370 }
371 if ( is_null( $version ) )
372 $version = $wgStyleVersion;
373 $this->addScript( Html::linkedScript( wfAppendQuery( $path, $version ) ) );
374 }
375
376 /**
377 * Add a self-contained script tag with the given contents
378 *
379 * @param $script String: JavaScript text, no <script> tags
380 */
381 public function addInlineScript( $script ) {
382 $this->mScripts .= Html::inlineScript( "\n$script\n" ) . "\n";
383 }
384
385 /**
386 * Get all registered JS and CSS tags for the header.
387 *
388 * @return String
389 */
390 function getScript() {
391 return $this->mScripts . $this->getHeadItems();
392 }
393
394 /**
395 * Filter an array of modules to remove insufficiently trustworthy members, and modules
396 * which are no longer registered (eg a page is cached before an extension is disabled)
397 * @param $modules Array
398 * @param $position String if not null, only return modules with this position
399 * @param $type string
400 * @return Array
401 */
402 protected function filterModules( $modules, $position = null, $type = ResourceLoaderModule::TYPE_COMBINED ){
403 $resourceLoader = $this->getResourceLoader();
404 $filteredModules = array();
405 foreach( $modules as $val ){
406 $module = $resourceLoader->getModule( $val );
407 if( $module instanceof ResourceLoaderModule
408 && $module->getOrigin() <= $this->getAllowedModules( $type )
409 && ( is_null( $position ) || $module->getPosition() == $position ) )
410 {
411 $filteredModules[] = $val;
412 }
413 }
414 return $filteredModules;
415 }
416
417 /**
418 * Get the list of modules to include on this page
419 *
420 * @param $filter Bool whether to filter out insufficiently trustworthy modules
421 * @param $position String if not null, only return modules with this position
422 * @param $param string
423 * @return Array of module names
424 */
425 public function getModules( $filter = false, $position = null, $param = 'mModules' ) {
426 $modules = array_values( array_unique( $this->$param ) );
427 return $filter
428 ? $this->filterModules( $modules, $position )
429 : $modules;
430 }
431
432 /**
433 * Add one or more modules recognized by the resource loader. Modules added
434 * through this function will be loaded by the resource loader when the
435 * page loads.
436 *
437 * @param $modules Mixed: module name (string) or array of module names
438 */
439 public function addModules( $modules ) {
440 $this->mModules = array_merge( $this->mModules, (array)$modules );
441 }
442
443 /**
444 * Get the list of module JS to include on this page
445 *
446 * @param $filter
447 * @param $position
448 *
449 * @return array of module names
450 */
451 public function getModuleScripts( $filter = false, $position = null ) {
452 return $this->getModules( $filter, $position, 'mModuleScripts' );
453 }
454
455 /**
456 * Add only JS of one or more modules recognized by the resource loader. Module
457 * scripts added through this function will be loaded by the resource loader when
458 * the page loads.
459 *
460 * @param $modules Mixed: module name (string) or array of module names
461 */
462 public function addModuleScripts( $modules ) {
463 $this->mModuleScripts = array_merge( $this->mModuleScripts, (array)$modules );
464 }
465
466 /**
467 * Get the list of module CSS to include on this page
468 *
469 * @param $filter
470 * @param $position
471 *
472 * @return Array of module names
473 */
474 public function getModuleStyles( $filter = false, $position = null ) {
475 return $this->getModules( $filter, $position, 'mModuleStyles' );
476 }
477
478 /**
479 * Add only CSS of one or more modules recognized by the resource loader. Module
480 * styles added through this function will be loaded by the resource loader when
481 * the page loads.
482 *
483 * @param $modules Mixed: module name (string) or array of module names
484 */
485 public function addModuleStyles( $modules ) {
486 $this->mModuleStyles = array_merge( $this->mModuleStyles, (array)$modules );
487 }
488
489 /**
490 * Get the list of module messages to include on this page
491 *
492 * @param $filter
493 * @param $position
494 *
495 * @return Array of module names
496 */
497 public function getModuleMessages( $filter = false, $position = null ) {
498 return $this->getModules( $filter, $position, 'mModuleMessages' );
499 }
500
501 /**
502 * Add only messages of one or more modules recognized by the resource loader.
503 * Module messages added through this function will be loaded by the resource
504 * loader when the page loads.
505 *
506 * @param $modules Mixed: module name (string) or array of module names
507 */
508 public function addModuleMessages( $modules ) {
509 $this->mModuleMessages = array_merge( $this->mModuleMessages, (array)$modules );
510 }
511
512 /**
513 * Get an array of head items
514 *
515 * @return Array
516 */
517 function getHeadItemsArray() {
518 return $this->mHeadItems;
519 }
520
521 /**
522 * Get all header items in a string
523 *
524 * @return String
525 */
526 function getHeadItems() {
527 $s = '';
528 foreach ( $this->mHeadItems as $item ) {
529 $s .= $item;
530 }
531 return $s;
532 }
533
534 /**
535 * Add or replace an header item to the output
536 *
537 * @param $name String: item name
538 * @param $value String: raw HTML
539 */
540 public function addHeadItem( $name, $value ) {
541 $this->mHeadItems[$name] = $value;
542 }
543
544 /**
545 * Check if the header item $name is already set
546 *
547 * @param $name String: item name
548 * @return Boolean
549 */
550 public function hasHeadItem( $name ) {
551 return isset( $this->mHeadItems[$name] );
552 }
553
554 /**
555 * Set the value of the ETag HTTP header, only used if $wgUseETag is true
556 *
557 * @param $tag String: value of "ETag" header
558 */
559 function setETag( $tag ) {
560 $this->mETag = $tag;
561 }
562
563 /**
564 * Set whether the output should only contain the body of the article,
565 * without any skin, sidebar, etc.
566 * Used e.g. when calling with "action=render".
567 *
568 * @param $only Boolean: whether to output only the body of the article
569 */
570 public function setArticleBodyOnly( $only ) {
571 $this->mArticleBodyOnly = $only;
572 }
573
574 /**
575 * Return whether the output will contain only the body of the article
576 *
577 * @return Boolean
578 */
579 public function getArticleBodyOnly() {
580 return $this->mArticleBodyOnly;
581 }
582
583 /**
584 * checkLastModified tells the client to use the client-cached page if
585 * possible. If sucessful, the OutputPage is disabled so that
586 * any future call to OutputPage->output() have no effect.
587 *
588 * Side effect: sets mLastModified for Last-Modified header
589 *
590 * @param $timestamp string
591 *
592 * @return Boolean: true iff cache-ok headers was sent.
593 */
594 public function checkLastModified( $timestamp ) {
595 global $wgCachePages, $wgCacheEpoch;
596
597 if ( !$timestamp || $timestamp == '19700101000000' ) {
598 wfDebug( __METHOD__ . ": CACHE DISABLED, NO TIMESTAMP\n" );
599 return false;
600 }
601 if( !$wgCachePages ) {
602 wfDebug( __METHOD__ . ": CACHE DISABLED\n", false );
603 return false;
604 }
605 if( $this->getUser()->getOption( 'nocache' ) ) {
606 wfDebug( __METHOD__ . ": USER DISABLED CACHE\n", false );
607 return false;
608 }
609
610 $timestamp = wfTimestamp( TS_MW, $timestamp );
611 $modifiedTimes = array(
612 'page' => $timestamp,
613 'user' => $this->getUser()->getTouched(),
614 'epoch' => $wgCacheEpoch
615 );
616 wfRunHooks( 'OutputPageCheckLastModified', array( &$modifiedTimes ) );
617
618 $maxModified = max( $modifiedTimes );
619 $this->mLastModified = wfTimestamp( TS_RFC2822, $maxModified );
620
621 if( empty( $_SERVER['HTTP_IF_MODIFIED_SINCE'] ) ) {
622 wfDebug( __METHOD__ . ": client did not send If-Modified-Since header\n", false );
623 return false;
624 }
625
626 # Make debug info
627 $info = '';
628 foreach ( $modifiedTimes as $name => $value ) {
629 if ( $info !== '' ) {
630 $info .= ', ';
631 }
632 $info .= "$name=" . wfTimestamp( TS_ISO_8601, $value );
633 }
634
635 # IE sends sizes after the date like this:
636 # Wed, 20 Aug 2003 06:51:19 GMT; length=5202
637 # this breaks strtotime().
638 $clientHeader = preg_replace( '/;.*$/', '', $_SERVER["HTTP_IF_MODIFIED_SINCE"] );
639
640 wfSuppressWarnings(); // E_STRICT system time bitching
641 $clientHeaderTime = strtotime( $clientHeader );
642 wfRestoreWarnings();
643 if ( !$clientHeaderTime ) {
644 wfDebug( __METHOD__ . ": unable to parse the client's If-Modified-Since header: $clientHeader\n" );
645 return false;
646 }
647 $clientHeaderTime = wfTimestamp( TS_MW, $clientHeaderTime );
648
649 wfDebug( __METHOD__ . ": client sent If-Modified-Since: " .
650 wfTimestamp( TS_ISO_8601, $clientHeaderTime ) . "\n", false );
651 wfDebug( __METHOD__ . ": effective Last-Modified: " .
652 wfTimestamp( TS_ISO_8601, $maxModified ) . "\n", false );
653 if( $clientHeaderTime < $maxModified ) {
654 wfDebug( __METHOD__ . ": STALE, $info\n", false );
655 return false;
656 }
657
658 # Not modified
659 # Give a 304 response code and disable body output
660 wfDebug( __METHOD__ . ": NOT MODIFIED, $info\n", false );
661 ini_set( 'zlib.output_compression', 0 );
662 $this->getRequest()->response()->header( "HTTP/1.1 304 Not Modified" );
663 $this->sendCacheControl();
664 $this->disable();
665
666 // Don't output a compressed blob when using ob_gzhandler;
667 // it's technically against HTTP spec and seems to confuse
668 // Firefox when the response gets split over two packets.
669 wfClearOutputBuffers();
670
671 return true;
672 }
673
674 /**
675 * Override the last modified timestamp
676 *
677 * @param $timestamp String: new timestamp, in a format readable by
678 * wfTimestamp()
679 */
680 public function setLastModified( $timestamp ) {
681 $this->mLastModified = wfTimestamp( TS_RFC2822, $timestamp );
682 }
683
684 /**
685 * Set the robot policy for the page: <http://www.robotstxt.org/meta.html>
686 *
687 * @param $policy String: the literal string to output as the contents of
688 * the meta tag. Will be parsed according to the spec and output in
689 * standardized form.
690 * @return null
691 */
692 public function setRobotPolicy( $policy ) {
693 $policy = Article::formatRobotPolicy( $policy );
694
695 if( isset( $policy['index'] ) ) {
696 $this->setIndexPolicy( $policy['index'] );
697 }
698 if( isset( $policy['follow'] ) ) {
699 $this->setFollowPolicy( $policy['follow'] );
700 }
701 }
702
703 /**
704 * Set the index policy for the page, but leave the follow policy un-
705 * touched.
706 *
707 * @param $policy string Either 'index' or 'noindex'.
708 * @return null
709 */
710 public function setIndexPolicy( $policy ) {
711 $policy = trim( $policy );
712 if( in_array( $policy, array( 'index', 'noindex' ) ) ) {
713 $this->mIndexPolicy = $policy;
714 }
715 }
716
717 /**
718 * Set the follow policy for the page, but leave the index policy un-
719 * touched.
720 *
721 * @param $policy String: either 'follow' or 'nofollow'.
722 * @return null
723 */
724 public function setFollowPolicy( $policy ) {
725 $policy = trim( $policy );
726 if( in_array( $policy, array( 'follow', 'nofollow' ) ) ) {
727 $this->mFollowPolicy = $policy;
728 }
729 }
730
731 /**
732 * Set the new value of the "action text", this will be added to the
733 * "HTML title", separated from it with " - ".
734 *
735 * @param $text String: new value of the "action text"
736 */
737 public function setPageTitleActionText( $text ) {
738 $this->mPageTitleActionText = $text;
739 }
740
741 /**
742 * Get the value of the "action text"
743 *
744 * @return String
745 */
746 public function getPageTitleActionText() {
747 if ( isset( $this->mPageTitleActionText ) ) {
748 return $this->mPageTitleActionText;
749 }
750 }
751
752 /**
753 * "HTML title" means the contents of <title>.
754 * It is stored as plain, unescaped text and will be run through htmlspecialchars in the skin file.
755 *
756 * @param $name string
757 */
758 public function setHTMLTitle( $name ) {
759 $this->mHTMLtitle = $name;
760 }
761
762 /**
763 * Return the "HTML title", i.e. the content of the <title> tag.
764 *
765 * @return String
766 */
767 public function getHTMLTitle() {
768 return $this->mHTMLtitle;
769 }
770
771 /**
772 * "Page title" means the contents of \<h1\>. It is stored as a valid HTML fragment.
773 * This function allows good tags like \<sup\> in the \<h1\> tag, but not bad tags like \<script\>.
774 * This function automatically sets \<title\> to the same content as \<h1\> but with all tags removed.
775 * Bad tags that were escaped in \<h1\> will still be escaped in \<title\>, and good tags like \<i\> will be dropped entirely.
776 *
777 * @param $name string
778 */
779 public function setPageTitle( $name ) {
780 # change "<script>foo&bar</script>" to "&lt;script&gt;foo&amp;bar&lt;/script&gt;"
781 # but leave "<i>foobar</i>" alone
782 $nameWithTags = Sanitizer::normalizeCharReferences( Sanitizer::removeHTMLtags( $name ) );
783 $this->mPagetitle = $nameWithTags;
784
785 # change "<i>foo&amp;bar</i>" to "foo&bar"
786 $this->setHTMLTitle( wfMsg( 'pagetitle', Sanitizer::stripAllTags( $nameWithTags ) ) );
787 }
788
789 /**
790 * Return the "page title", i.e. the content of the \<h1\> tag.
791 *
792 * @return String
793 */
794 public function getPageTitle() {
795 return $this->mPagetitle;
796 }
797
798 /**
799 * Set the Title object to use
800 *
801 * @param $t Title object
802 */
803 public function setTitle( Title $t ) {
804 $this->getContext()->setTitle( $t );
805 }
806
807
808 /**
809 * Replace the subtile with $str
810 *
811 * @param $str String: new value of the subtitle
812 */
813 public function setSubtitle( $str ) {
814 $this->mSubtitle = /*$this->parse(*/ $str /*)*/; // @bug 2514
815 }
816
817 /**
818 * Add $str to the subtitle
819 *
820 * @param $str String to add to the subtitle
821 */
822 public function appendSubtitle( $str ) {
823 $this->mSubtitle .= /*$this->parse(*/ $str /*)*/; // @bug 2514
824 }
825
826 /**
827 * Get the subtitle
828 *
829 * @return String
830 */
831 public function getSubtitle() {
832 return $this->mSubtitle;
833 }
834
835 /**
836 * Set the page as printable, i.e. it'll be displayed with with all
837 * print styles included
838 */
839 public function setPrintable() {
840 $this->mPrintable = true;
841 }
842
843 /**
844 * Return whether the page is "printable"
845 *
846 * @return Boolean
847 */
848 public function isPrintable() {
849 return $this->mPrintable;
850 }
851
852 /**
853 * Disable output completely, i.e. calling output() will have no effect
854 */
855 public function disable() {
856 $this->mDoNothing = true;
857 }
858
859 /**
860 * Return whether the output will be completely disabled
861 *
862 * @return Boolean
863 */
864 public function isDisabled() {
865 return $this->mDoNothing;
866 }
867
868 /**
869 * Show an "add new section" link?
870 *
871 * @return Boolean
872 */
873 public function showNewSectionLink() {
874 return $this->mNewSectionLink;
875 }
876
877 /**
878 * Forcibly hide the new section link?
879 *
880 * @return Boolean
881 */
882 public function forceHideNewSectionLink() {
883 return $this->mHideNewSectionLink;
884 }
885
886 /**
887 * Add or remove feed links in the page header
888 * This is mainly kept for backward compatibility, see OutputPage::addFeedLink()
889 * for the new version
890 * @see addFeedLink()
891 *
892 * @param $show Boolean: true: add default feeds, false: remove all feeds
893 */
894 public function setSyndicated( $show = true ) {
895 if ( $show ) {
896 $this->setFeedAppendQuery( false );
897 } else {
898 $this->mFeedLinks = array();
899 }
900 }
901
902 /**
903 * Add default feeds to the page header
904 * This is mainly kept for backward compatibility, see OutputPage::addFeedLink()
905 * for the new version
906 * @see addFeedLink()
907 *
908 * @param $val String: query to append to feed links or false to output
909 * default links
910 */
911 public function setFeedAppendQuery( $val ) {
912 global $wgAdvertisedFeedTypes;
913
914 $this->mFeedLinks = array();
915
916 foreach ( $wgAdvertisedFeedTypes as $type ) {
917 $query = "feed=$type";
918 if ( is_string( $val ) ) {
919 $query .= '&' . $val;
920 }
921 $this->mFeedLinks[$type] = $this->getTitle()->getLocalURL( $query );
922 }
923 }
924
925 /**
926 * Add a feed link to the page header
927 *
928 * @param $format String: feed type, should be a key of $wgFeedClasses
929 * @param $href String: URL
930 */
931 public function addFeedLink( $format, $href ) {
932 global $wgAdvertisedFeedTypes;
933
934 if ( in_array( $format, $wgAdvertisedFeedTypes ) ) {
935 $this->mFeedLinks[$format] = $href;
936 }
937 }
938
939 /**
940 * Should we output feed links for this page?
941 * @return Boolean
942 */
943 public function isSyndicated() {
944 return count( $this->mFeedLinks ) > 0;
945 }
946
947 /**
948 * Return URLs for each supported syndication format for this page.
949 * @return array associating format keys with URLs
950 */
951 public function getSyndicationLinks() {
952 return $this->mFeedLinks;
953 }
954
955 /**
956 * Will currently always return null
957 *
958 * @return null
959 */
960 public function getFeedAppendQuery() {
961 return $this->mFeedLinksAppendQuery;
962 }
963
964 /**
965 * Set whether the displayed content is related to the source of the
966 * corresponding article on the wiki
967 * Setting true will cause the change "article related" toggle to true
968 *
969 * @param $v Boolean
970 */
971 public function setArticleFlag( $v ) {
972 $this->mIsarticle = $v;
973 if ( $v ) {
974 $this->mIsArticleRelated = $v;
975 }
976 }
977
978 /**
979 * Return whether the content displayed page is related to the source of
980 * the corresponding article on the wiki
981 *
982 * @return Boolean
983 */
984 public function isArticle() {
985 return $this->mIsarticle;
986 }
987
988 /**
989 * Set whether this page is related an article on the wiki
990 * Setting false will cause the change of "article flag" toggle to false
991 *
992 * @param $v Boolean
993 */
994 public function setArticleRelated( $v ) {
995 $this->mIsArticleRelated = $v;
996 if ( !$v ) {
997 $this->mIsarticle = false;
998 }
999 }
1000
1001 /**
1002 * Return whether this page is related an article on the wiki
1003 *
1004 * @return Boolean
1005 */
1006 public function isArticleRelated() {
1007 return $this->mIsArticleRelated;
1008 }
1009
1010 /**
1011 * Add new language links
1012 *
1013 * @param $newLinkArray Associative array mapping language code to the page
1014 * name
1015 */
1016 public function addLanguageLinks( $newLinkArray ) {
1017 $this->mLanguageLinks += $newLinkArray;
1018 }
1019
1020 /**
1021 * Reset the language links and add new language links
1022 *
1023 * @param $newLinkArray Associative array mapping language code to the page
1024 * name
1025 */
1026 public function setLanguageLinks( $newLinkArray ) {
1027 $this->mLanguageLinks = $newLinkArray;
1028 }
1029
1030 /**
1031 * Get the list of language links
1032 *
1033 * @return Array of Interwiki Prefixed (non DB key) Titles (e.g. 'fr:Test page')
1034 */
1035 public function getLanguageLinks() {
1036 return $this->mLanguageLinks;
1037 }
1038
1039 /**
1040 * Add an array of categories, with names in the keys
1041 *
1042 * @param $categories Array mapping category name => sort key
1043 */
1044 public function addCategoryLinks( $categories ) {
1045 global $wgContLang;
1046
1047 if ( !is_array( $categories ) || count( $categories ) == 0 ) {
1048 return;
1049 }
1050
1051 # Add the links to a LinkBatch
1052 $arr = array( NS_CATEGORY => $categories );
1053 $lb = new LinkBatch;
1054 $lb->setArray( $arr );
1055
1056 # Fetch existence plus the hiddencat property
1057 $dbr = wfGetDB( DB_SLAVE );
1058 $res = $dbr->select( array( 'page', 'page_props' ),
1059 array( 'page_id', 'page_namespace', 'page_title', 'page_len', 'page_is_redirect', 'page_latest', 'pp_value' ),
1060 $lb->constructSet( 'page', $dbr ),
1061 __METHOD__,
1062 array(),
1063 array( 'page_props' => array( 'LEFT JOIN', array( 'pp_propname' => 'hiddencat', 'pp_page = page_id' ) ) )
1064 );
1065
1066 # Add the results to the link cache
1067 $lb->addResultToCache( LinkCache::singleton(), $res );
1068
1069 # Set all the values to 'normal'. This can be done with array_fill_keys in PHP 5.2.0+
1070 $categories = array_combine(
1071 array_keys( $categories ),
1072 array_fill( 0, count( $categories ), 'normal' )
1073 );
1074
1075 # Mark hidden categories
1076 foreach ( $res as $row ) {
1077 if ( isset( $row->pp_value ) ) {
1078 $categories[$row->page_title] = 'hidden';
1079 }
1080 }
1081
1082 # Add the remaining categories to the skin
1083 if ( wfRunHooks( 'OutputPageMakeCategoryLinks', array( &$this, $categories, &$this->mCategoryLinks ) ) ) {
1084 foreach ( $categories as $category => $type ) {
1085 $origcategory = $category;
1086 $title = Title::makeTitleSafe( NS_CATEGORY, $category );
1087 $wgContLang->findVariantLink( $category, $title, true );
1088 if ( $category != $origcategory ) {
1089 if ( array_key_exists( $category, $categories ) ) {
1090 continue;
1091 }
1092 }
1093 $text = $wgContLang->convertHtml( $title->getText() );
1094 $this->mCategories[] = $title->getText();
1095 $this->mCategoryLinks[$type][] = Linker::link( $title, $text );
1096 }
1097 }
1098 }
1099
1100 /**
1101 * Reset the category links (but not the category list) and add $categories
1102 *
1103 * @param $categories Array mapping category name => sort key
1104 */
1105 public function setCategoryLinks( $categories ) {
1106 $this->mCategoryLinks = array();
1107 $this->addCategoryLinks( $categories );
1108 }
1109
1110 /**
1111 * Get the list of category links, in a 2-D array with the following format:
1112 * $arr[$type][] = $link, where $type is either "normal" or "hidden" (for
1113 * hidden categories) and $link a HTML fragment with a link to the category
1114 * page
1115 *
1116 * @return Array
1117 */
1118 public function getCategoryLinks() {
1119 return $this->mCategoryLinks;
1120 }
1121
1122 /**
1123 * Get the list of category names this page belongs to
1124 *
1125 * @return Array of strings
1126 */
1127 public function getCategories() {
1128 return $this->mCategories;
1129 }
1130
1131 /**
1132 * Do not allow scripts which can be modified by wiki users to load on this page;
1133 * only allow scripts bundled with, or generated by, the software.
1134 */
1135 public function disallowUserJs() {
1136 $this->reduceAllowedModules(
1137 ResourceLoaderModule::TYPE_SCRIPTS,
1138 ResourceLoaderModule::ORIGIN_CORE_INDIVIDUAL
1139 );
1140 }
1141
1142 /**
1143 * Return whether user JavaScript is allowed for this page
1144 * @deprecated since 1.18 Load modules with ResourceLoader, and origin and
1145 * trustworthiness is identified and enforced automagically.
1146 * @return Boolean
1147 */
1148 public function isUserJsAllowed() {
1149 return $this->getAllowedModules( ResourceLoaderModule::TYPE_SCRIPTS ) >= ResourceLoaderModule::ORIGIN_USER_INDIVIDUAL;
1150 }
1151
1152 /**
1153 * Show what level of JavaScript / CSS untrustworthiness is allowed on this page
1154 * @see ResourceLoaderModule::$origin
1155 * @param $type String ResourceLoaderModule TYPE_ constant
1156 * @return Int ResourceLoaderModule ORIGIN_ class constant
1157 */
1158 public function getAllowedModules( $type ){
1159 if( $type == ResourceLoaderModule::TYPE_COMBINED ){
1160 return min( array_values( $this->mAllowedModules ) );
1161 } else {
1162 return isset( $this->mAllowedModules[$type] )
1163 ? $this->mAllowedModules[$type]
1164 : ResourceLoaderModule::ORIGIN_ALL;
1165 }
1166 }
1167
1168 /**
1169 * Set the highest level of CSS/JS untrustworthiness allowed
1170 * @param $type String ResourceLoaderModule TYPE_ constant
1171 * @param $level Int ResourceLoaderModule class constant
1172 */
1173 public function setAllowedModules( $type, $level ){
1174 $this->mAllowedModules[$type] = $level;
1175 }
1176
1177 /**
1178 * As for setAllowedModules(), but don't inadvertantly make the page more accessible
1179 * @param $type String
1180 * @param $level Int ResourceLoaderModule class constant
1181 */
1182 public function reduceAllowedModules( $type, $level ){
1183 $this->mAllowedModules[$type] = min( $this->getAllowedModules($type), $level );
1184 }
1185
1186 /**
1187 * Prepend $text to the body HTML
1188 *
1189 * @param $text String: HTML
1190 */
1191 public function prependHTML( $text ) {
1192 $this->mBodytext = $text . $this->mBodytext;
1193 }
1194
1195 /**
1196 * Append $text to the body HTML
1197 *
1198 * @param $text String: HTML
1199 */
1200 public function addHTML( $text ) {
1201 $this->mBodytext .= $text;
1202 }
1203
1204 /**
1205 * Clear the body HTML
1206 */
1207 public function clearHTML() {
1208 $this->mBodytext = '';
1209 }
1210
1211 /**
1212 * Get the body HTML
1213 *
1214 * @return String: HTML
1215 */
1216 public function getHTML() {
1217 return $this->mBodytext;
1218 }
1219
1220 /**
1221 * Add $text to the debug output
1222 *
1223 * @param $text String: debug text
1224 */
1225 public function debug( $text ) {
1226 $this->mDebugtext .= $text;
1227 }
1228
1229 /**
1230 * Get/set the ParserOptions object to use for wikitext parsing
1231 *
1232 * @param $options either the ParserOption to use or null to only get the
1233 * current ParserOption object
1234 * @return ParserOptions object
1235 */
1236 public function parserOptions( $options = null ) {
1237 if ( !$this->mParserOptions ) {
1238 $this->mParserOptions = new ParserOptions;
1239 $this->mParserOptions->setEditSection( false );
1240 }
1241 return wfSetVar( $this->mParserOptions, $options );
1242 }
1243
1244 /**
1245 * Set the revision ID which will be seen by the wiki text parser
1246 * for things such as embedded {{REVISIONID}} variable use.
1247 *
1248 * @param $revid Mixed: an positive integer, or null
1249 * @return Mixed: previous value
1250 */
1251 public function setRevisionId( $revid ) {
1252 $val = is_null( $revid ) ? null : intval( $revid );
1253 return wfSetVar( $this->mRevisionId, $val );
1254 }
1255
1256 /**
1257 * Get the displayed revision ID
1258 *
1259 * @return Integer
1260 */
1261 public function getRevisionId() {
1262 return $this->mRevisionId;
1263 }
1264
1265 /**
1266 * Set the displayed file version
1267 *
1268 * @param $file File|false
1269 * @return Mixed: previous value
1270 */
1271 public function setFileVersion( $file ) {
1272 $val = null;
1273 if ( $file instanceof File && $file->exists() ) {
1274 $val = array( 'time' => $file->getTimestamp(), 'sha1' => $file->getSha1() );
1275 }
1276 return wfSetVar( $this->mFileVersion, $val, true );
1277 }
1278
1279 /**
1280 * Get the displayed file version
1281 *
1282 * @return Array|null ('time' => MW timestamp, 'sha1' => sha1)
1283 */
1284 public function getFileVersion() {
1285 return $this->mFileVersion;
1286 }
1287
1288 /**
1289 * Get the templates used on this page
1290 *
1291 * @return Array (namespace => dbKey => revId)
1292 * @since 1.18
1293 */
1294 public function getTemplateIds() {
1295 return $this->mTemplateIds;
1296 }
1297
1298 /**
1299 * Get the files used on this page
1300 *
1301 * @return Array (dbKey => array('time' => MW timestamp or null, 'sha1' => sha1 or ''))
1302 * @since 1.18
1303 */
1304 public function getFileSearchOptions() {
1305 return $this->mImageTimeKeys;
1306 }
1307
1308 /**
1309 * Convert wikitext to HTML and add it to the buffer
1310 * Default assumes that the current page title will be used.
1311 *
1312 * @param $text String
1313 * @param $linestart Boolean: is this the start of a line?
1314 * @param $interface Boolean: is this text in the user interface language?
1315 */
1316 public function addWikiText( $text, $linestart = true, $interface = true ) {
1317 $title = $this->getTitle(); // Work arround E_STRICT
1318 $this->addWikiTextTitle( $text, $title, $linestart, /*tidy*/false, $interface );
1319 }
1320
1321 /**
1322 * Add wikitext with a custom Title object
1323 *
1324 * @param $text String: wikitext
1325 * @param $title Title object
1326 * @param $linestart Boolean: is this the start of a line?
1327 */
1328 public function addWikiTextWithTitle( $text, &$title, $linestart = true ) {
1329 $this->addWikiTextTitle( $text, $title, $linestart );
1330 }
1331
1332 /**
1333 * Add wikitext with a custom Title object and
1334 *
1335 * @param $text String: wikitext
1336 * @param $title Title object
1337 * @param $linestart Boolean: is this the start of a line?
1338 */
1339 function addWikiTextTitleTidy( $text, &$title, $linestart = true ) {
1340 $this->addWikiTextTitle( $text, $title, $linestart, true );
1341 }
1342
1343 /**
1344 * Add wikitext with tidy enabled
1345 *
1346 * @param $text String: wikitext
1347 * @param $linestart Boolean: is this the start of a line?
1348 */
1349 public function addWikiTextTidy( $text, $linestart = true ) {
1350 $title = $this->getTitle();
1351 $this->addWikiTextTitleTidy( $text, $title, $linestart );
1352 }
1353
1354 /**
1355 * Add wikitext with a custom Title object
1356 *
1357 * @param $text String: wikitext
1358 * @param $title Title object
1359 * @param $linestart Boolean: is this the start of a line?
1360 * @param $tidy Boolean: whether to use tidy
1361 * @param $interface Boolean: whether it is an interface message
1362 * (for example disables conversion)
1363 */
1364 public function addWikiTextTitle( $text, &$title, $linestart, $tidy = false, $interface = false ) {
1365 global $wgParser;
1366
1367 wfProfileIn( __METHOD__ );
1368
1369 wfIncrStats( 'pcache_not_possible' );
1370
1371 $popts = $this->parserOptions();
1372 $oldTidy = $popts->setTidy( $tidy );
1373 $popts->setInterfaceMessage( (bool) $interface );
1374
1375 $parserOutput = $wgParser->parse(
1376 $text, $title, $popts,
1377 $linestart, true, $this->mRevisionId
1378 );
1379
1380 $popts->setTidy( $oldTidy );
1381
1382 $this->addParserOutput( $parserOutput );
1383
1384 wfProfileOut( __METHOD__ );
1385 }
1386
1387 /**
1388 * Add a ParserOutput object, but without Html
1389 *
1390 * @param $parserOutput ParserOutput object
1391 */
1392 public function addParserOutputNoText( &$parserOutput ) {
1393 $this->mLanguageLinks += $parserOutput->getLanguageLinks();
1394 $this->addCategoryLinks( $parserOutput->getCategories() );
1395 $this->mNewSectionLink = $parserOutput->getNewSection();
1396 $this->mHideNewSectionLink = $parserOutput->getHideNewSection();
1397
1398 $this->mParseWarnings = $parserOutput->getWarnings();
1399 if ( !$parserOutput->isCacheable() ) {
1400 $this->enableClientCache( false );
1401 }
1402 $this->mNoGallery = $parserOutput->getNoGallery();
1403 $this->mHeadItems = array_merge( $this->mHeadItems, $parserOutput->getHeadItems() );
1404 $this->addModules( $parserOutput->getModules() );
1405 $this->addModuleScripts( $parserOutput->getModuleScripts() );
1406 $this->addModuleStyles( $parserOutput->getModuleStyles() );
1407 $this->addModuleMessages( $parserOutput->getModuleMessages() );
1408
1409 // Template versioning...
1410 foreach ( (array)$parserOutput->getTemplateIds() as $ns => $dbks ) {
1411 if ( isset( $this->mTemplateIds[$ns] ) ) {
1412 $this->mTemplateIds[$ns] = $dbks + $this->mTemplateIds[$ns];
1413 } else {
1414 $this->mTemplateIds[$ns] = $dbks;
1415 }
1416 }
1417 // File versioning...
1418 foreach ( (array)$parserOutput->getFileSearchOptions() as $dbk => $data ) {
1419 $this->mImageTimeKeys[$dbk] = $data;
1420 }
1421
1422 // Hooks registered in the object
1423 global $wgParserOutputHooks;
1424 foreach ( $parserOutput->getOutputHooks() as $hookInfo ) {
1425 list( $hookName, $data ) = $hookInfo;
1426 if ( isset( $wgParserOutputHooks[$hookName] ) ) {
1427 call_user_func( $wgParserOutputHooks[$hookName], $this, $parserOutput, $data );
1428 }
1429 }
1430
1431 wfRunHooks( 'OutputPageParserOutput', array( &$this, $parserOutput ) );
1432 }
1433
1434 /**
1435 * Add a ParserOutput object
1436 *
1437 * @param $parserOutput ParserOutput
1438 */
1439 function addParserOutput( &$parserOutput ) {
1440 $this->addParserOutputNoText( $parserOutput );
1441 $text = $parserOutput->getText();
1442 wfRunHooks( 'OutputPageBeforeHTML', array( &$this, &$text ) );
1443 $this->addHTML( $text );
1444 }
1445
1446
1447 /**
1448 * Add the output of a QuickTemplate to the output buffer
1449 *
1450 * @param $template QuickTemplate
1451 */
1452 public function addTemplate( &$template ) {
1453 ob_start();
1454 $template->execute();
1455 $this->addHTML( ob_get_contents() );
1456 ob_end_clean();
1457 }
1458
1459 /**
1460 * Parse wikitext and return the HTML.
1461 *
1462 * @param $text String
1463 * @param $linestart Boolean: is this the start of a line?
1464 * @param $interface Boolean: use interface language ($wgLang instead of
1465 * $wgContLang) while parsing language sensitive magic
1466 * words like GRAMMAR and PLURAL. This also disables
1467 * LanguageConverter.
1468 * @param $language Language object: target language object, will override
1469 * $interface
1470 * @return String: HTML
1471 */
1472 public function parse( $text, $linestart = true, $interface = false, $language = null ) {
1473 global $wgParser;
1474
1475 if( is_null( $this->getTitle() ) ) {
1476 throw new MWException( 'Empty $mTitle in ' . __METHOD__ );
1477 }
1478
1479 $popts = $this->parserOptions();
1480 if ( $interface ) {
1481 $popts->setInterfaceMessage( true );
1482 }
1483 if ( $language !== null ) {
1484 $oldLang = $popts->setTargetLanguage( $language );
1485 }
1486
1487 $parserOutput = $wgParser->parse(
1488 $text, $this->getTitle(), $popts,
1489 $linestart, true, $this->mRevisionId
1490 );
1491
1492 if ( $interface ) {
1493 $popts->setInterfaceMessage( false );
1494 }
1495 if ( $language !== null ) {
1496 $popts->setTargetLanguage( $oldLang );
1497 }
1498
1499 return $parserOutput->getText();
1500 }
1501
1502 /**
1503 * Parse wikitext, strip paragraphs, and return the HTML.
1504 *
1505 * @param $text String
1506 * @param $linestart Boolean: is this the start of a line?
1507 * @param $interface Boolean: use interface language ($wgLang instead of
1508 * $wgContLang) while parsing language sensitive magic
1509 * words like GRAMMAR and PLURAL
1510 * @return String: HTML
1511 */
1512 public function parseInline( $text, $linestart = true, $interface = false ) {
1513 $parsed = $this->parse( $text, $linestart, $interface );
1514
1515 $m = array();
1516 if ( preg_match( '/^<p>(.*)\n?<\/p>\n?/sU', $parsed, $m ) ) {
1517 $parsed = $m[1];
1518 }
1519
1520 return $parsed;
1521 }
1522
1523 /**
1524 * Set the value of the "s-maxage" part of the "Cache-control" HTTP header
1525 *
1526 * @param $maxage Integer: maximum cache time on the Squid, in seconds.
1527 */
1528 public function setSquidMaxage( $maxage ) {
1529 $this->mSquidMaxage = $maxage;
1530 }
1531
1532 /**
1533 * Use enableClientCache(false) to force it to send nocache headers
1534 *
1535 * @param $state bool
1536 *
1537 * @return bool
1538 */
1539 public function enableClientCache( $state ) {
1540 return wfSetVar( $this->mEnableClientCache, $state );
1541 }
1542
1543 /**
1544 * Get the list of cookies that will influence on the cache
1545 *
1546 * @return Array
1547 */
1548 function getCacheVaryCookies() {
1549 global $wgCookiePrefix, $wgCacheVaryCookies;
1550 static $cookies;
1551 if ( $cookies === null ) {
1552 $cookies = array_merge(
1553 array(
1554 "{$wgCookiePrefix}Token",
1555 "{$wgCookiePrefix}LoggedOut",
1556 session_name()
1557 ),
1558 $wgCacheVaryCookies
1559 );
1560 wfRunHooks( 'GetCacheVaryCookies', array( $this, &$cookies ) );
1561 }
1562 return $cookies;
1563 }
1564
1565 /**
1566 * Return whether this page is not cacheable because "useskin" or "uselang"
1567 * URL parameters were passed.
1568 *
1569 * @return Boolean
1570 */
1571 function uncacheableBecauseRequestVars() {
1572 $request = $this->getRequest();
1573 return $request->getText( 'useskin', false ) === false
1574 && $request->getText( 'uselang', false ) === false;
1575 }
1576
1577 /**
1578 * Check if the request has a cache-varying cookie header
1579 * If it does, it's very important that we don't allow public caching
1580 *
1581 * @return Boolean
1582 */
1583 function haveCacheVaryCookies() {
1584 $cookieHeader = $this->getRequest()->getHeader( 'cookie' );
1585 if ( $cookieHeader === false ) {
1586 return false;
1587 }
1588 $cvCookies = $this->getCacheVaryCookies();
1589 foreach ( $cvCookies as $cookieName ) {
1590 # Check for a simple string match, like the way squid does it
1591 if ( strpos( $cookieHeader, $cookieName ) !== false ) {
1592 wfDebug( __METHOD__ . ": found $cookieName\n" );
1593 return true;
1594 }
1595 }
1596 wfDebug( __METHOD__ . ": no cache-varying cookies found\n" );
1597 return false;
1598 }
1599
1600 /**
1601 * Add an HTTP header that will influence on the cache
1602 *
1603 * @param $header String: header name
1604 * @param $option Array|null
1605 * @todo FIXME: Document the $option parameter; it appears to be for
1606 * X-Vary-Options but what format is acceptable?
1607 */
1608 public function addVaryHeader( $header, $option = null ) {
1609 if ( !array_key_exists( $header, $this->mVaryHeader ) ) {
1610 $this->mVaryHeader[$header] = (array)$option;
1611 } elseif( is_array( $option ) ) {
1612 if( is_array( $this->mVaryHeader[$header] ) ) {
1613 $this->mVaryHeader[$header] = array_merge( $this->mVaryHeader[$header], $option );
1614 } else {
1615 $this->mVaryHeader[$header] = $option;
1616 }
1617 }
1618 $this->mVaryHeader[$header] = array_unique( $this->mVaryHeader[$header] );
1619 }
1620
1621 /**
1622 * Get a complete X-Vary-Options header
1623 *
1624 * @return String
1625 */
1626 public function getXVO() {
1627 $cvCookies = $this->getCacheVaryCookies();
1628
1629 $cookiesOption = array();
1630 foreach ( $cvCookies as $cookieName ) {
1631 $cookiesOption[] = 'string-contains=' . $cookieName;
1632 }
1633 $this->addVaryHeader( 'Cookie', $cookiesOption );
1634
1635 $headers = array();
1636 foreach( $this->mVaryHeader as $header => $option ) {
1637 $newheader = $header;
1638 if( is_array( $option ) ) {
1639 $newheader .= ';' . implode( ';', $option );
1640 }
1641 $headers[] = $newheader;
1642 }
1643 $xvo = 'X-Vary-Options: ' . implode( ',', $headers );
1644
1645 return $xvo;
1646 }
1647
1648 /**
1649 * bug 21672: Add Accept-Language to Vary and XVO headers
1650 * if there's no 'variant' parameter existed in GET.
1651 *
1652 * For example:
1653 * /w/index.php?title=Main_page should always be served; but
1654 * /w/index.php?title=Main_page&variant=zh-cn should never be served.
1655 */
1656 function addAcceptLanguage() {
1657 global $wgContLang;
1658 if( !$this->getRequest()->getCheck( 'variant' ) && $wgContLang->hasVariants() ) {
1659 $variants = $wgContLang->getVariants();
1660 $aloption = array();
1661 foreach ( $variants as $variant ) {
1662 if( $variant === $wgContLang->getCode() ) {
1663 continue;
1664 } else {
1665 $aloption[] = 'string-contains=' . $variant;
1666
1667 // IE and some other browsers use another form of language code
1668 // in their Accept-Language header, like "zh-CN" or "zh-TW".
1669 // We should handle these too.
1670 $ievariant = explode( '-', $variant );
1671 if ( count( $ievariant ) == 2 ) {
1672 $ievariant[1] = strtoupper( $ievariant[1] );
1673 $ievariant = implode( '-', $ievariant );
1674 $aloption[] = 'string-contains=' . $ievariant;
1675 }
1676 }
1677 }
1678 $this->addVaryHeader( 'Accept-Language', $aloption );
1679 }
1680 }
1681
1682 /**
1683 * Set a flag which will cause an X-Frame-Options header appropriate for
1684 * edit pages to be sent. The header value is controlled by
1685 * $wgEditPageFrameOptions.
1686 *
1687 * This is the default for special pages. If you display a CSRF-protected
1688 * form on an ordinary view page, then you need to call this function.
1689 *
1690 * @param $enable bool
1691 */
1692 public function preventClickjacking( $enable = true ) {
1693 $this->mPreventClickjacking = $enable;
1694 }
1695
1696 /**
1697 * Turn off frame-breaking. Alias for $this->preventClickjacking(false).
1698 * This can be called from pages which do not contain any CSRF-protected
1699 * HTML form.
1700 */
1701 public function allowClickjacking() {
1702 $this->mPreventClickjacking = false;
1703 }
1704
1705 /**
1706 * Get the X-Frame-Options header value (without the name part), or false
1707 * if there isn't one. This is used by Skin to determine whether to enable
1708 * JavaScript frame-breaking, for clients that don't support X-Frame-Options.
1709 *
1710 * @return string
1711 */
1712 public function getFrameOptions() {
1713 global $wgBreakFrames, $wgEditPageFrameOptions;
1714 if ( $wgBreakFrames ) {
1715 return 'DENY';
1716 } elseif ( $this->mPreventClickjacking && $wgEditPageFrameOptions ) {
1717 return $wgEditPageFrameOptions;
1718 }
1719 }
1720
1721 /**
1722 * Send cache control HTTP headers
1723 */
1724 public function sendCacheControl() {
1725 global $wgUseSquid, $wgUseESI, $wgUseETag, $wgSquidMaxage, $wgUseXVO;
1726
1727 $response = $this->getRequest()->response();
1728 if ( $wgUseETag && $this->mETag ) {
1729 $response->header( "ETag: $this->mETag" );
1730 }
1731
1732 $this->addAcceptLanguage();
1733
1734 # don't serve compressed data to clients who can't handle it
1735 # maintain different caches for logged-in users and non-logged in ones
1736 $response->header( 'Vary: ' . join( ', ', array_keys( $this->mVaryHeader ) ) );
1737
1738 if ( $wgUseXVO ) {
1739 # Add an X-Vary-Options header for Squid with Wikimedia patches
1740 $response->header( $this->getXVO() );
1741 }
1742
1743 if( !$this->uncacheableBecauseRequestVars() && $this->mEnableClientCache ) {
1744 if(
1745 $wgUseSquid && session_id() == '' && !$this->isPrintable() &&
1746 $this->mSquidMaxage != 0 && !$this->haveCacheVaryCookies()
1747 )
1748 {
1749 if ( $wgUseESI ) {
1750 # We'll purge the proxy cache explicitly, but require end user agents
1751 # to revalidate against the proxy on each visit.
1752 # Surrogate-Control controls our Squid, Cache-Control downstream caches
1753 wfDebug( __METHOD__ . ": proxy caching with ESI; {$this->mLastModified} **\n", false );
1754 # start with a shorter timeout for initial testing
1755 # header( 'Surrogate-Control: max-age=2678400+2678400, content="ESI/1.0"');
1756 $response->header( 'Surrogate-Control: max-age='.$wgSquidMaxage.'+'.$this->mSquidMaxage.', content="ESI/1.0"');
1757 $response->header( 'Cache-Control: s-maxage=0, must-revalidate, max-age=0' );
1758 } else {
1759 # We'll purge the proxy cache for anons explicitly, but require end user agents
1760 # to revalidate against the proxy on each visit.
1761 # IMPORTANT! The Squid needs to replace the Cache-Control header with
1762 # Cache-Control: s-maxage=0, must-revalidate, max-age=0
1763 wfDebug( __METHOD__ . ": local proxy caching; {$this->mLastModified} **\n", false );
1764 # start with a shorter timeout for initial testing
1765 # header( "Cache-Control: s-maxage=2678400, must-revalidate, max-age=0" );
1766 $response->header( 'Cache-Control: s-maxage='.$this->mSquidMaxage.', must-revalidate, max-age=0' );
1767 }
1768 } else {
1769 # We do want clients to cache if they can, but they *must* check for updates
1770 # on revisiting the page.
1771 wfDebug( __METHOD__ . ": private caching; {$this->mLastModified} **\n", false );
1772 $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
1773 $response->header( "Cache-Control: private, must-revalidate, max-age=0" );
1774 }
1775 if($this->mLastModified) {
1776 $response->header( "Last-Modified: {$this->mLastModified}" );
1777 }
1778 } else {
1779 wfDebug( __METHOD__ . ": no caching **\n", false );
1780
1781 # In general, the absence of a last modified header should be enough to prevent
1782 # the client from using its cache. We send a few other things just to make sure.
1783 $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
1784 $response->header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' );
1785 $response->header( 'Pragma: no-cache' );
1786 }
1787 }
1788
1789 /**
1790 * Get the message associed with the HTTP response code $code
1791 *
1792 * @param $code Integer: status code
1793 * @return String or null: message or null if $code is not in the list of
1794 * messages
1795 *
1796 * @deprecated since 1.18 Use HttpStatus::getMessage() instead.
1797 */
1798 public static function getStatusMessage( $code ) {
1799 wfDeprecated( __METHOD__ );
1800 return HttpStatus::getMessage( $code );
1801 }
1802
1803 /**
1804 * Finally, all the text has been munged and accumulated into
1805 * the object, let's actually output it:
1806 */
1807 public function output() {
1808 global $wgLanguageCode, $wgDebugRedirects, $wgMimeType;
1809
1810 if( $this->mDoNothing ) {
1811 return;
1812 }
1813
1814 wfProfileIn( __METHOD__ );
1815
1816 $response = $this->getRequest()->response();
1817
1818 if ( $this->mRedirect != '' ) {
1819 # Standards require redirect URLs to be absolute
1820 $this->mRedirect = wfExpandUrl( $this->mRedirect, PROTO_CURRENT );
1821 if( $this->mRedirectCode == '301' || $this->mRedirectCode == '303' ) {
1822 if( !$wgDebugRedirects ) {
1823 $message = HttpStatus::getMessage( $this->mRedirectCode );
1824 $response->header( "HTTP/1.1 {$this->mRedirectCode} $message" );
1825 }
1826 $this->mLastModified = wfTimestamp( TS_RFC2822 );
1827 }
1828 $this->sendCacheControl();
1829
1830 $response->header( "Content-Type: text/html; charset=utf-8" );
1831 if( $wgDebugRedirects ) {
1832 $url = htmlspecialchars( $this->mRedirect );
1833 print "<html>\n<head>\n<title>Redirect</title>\n</head>\n<body>\n";
1834 print "<p>Location: <a href=\"$url\">$url</a></p>\n";
1835 print "</body>\n</html>\n";
1836 } else {
1837 $response->header( 'Location: ' . $this->mRedirect );
1838 }
1839 wfProfileOut( __METHOD__ );
1840 return;
1841 } elseif ( $this->mStatusCode ) {
1842 $message = HttpStatus::getMessage( $this->mStatusCode );
1843 if ( $message ) {
1844 $response->header( 'HTTP/1.1 ' . $this->mStatusCode . ' ' . $message );
1845 }
1846 }
1847
1848 # Buffer output; final headers may depend on later processing
1849 ob_start();
1850
1851 $response->header( "Content-type: $wgMimeType; charset=UTF-8" );
1852 $response->header( 'Content-language: ' . $wgLanguageCode );
1853
1854 // Prevent framing, if requested
1855 $frameOptions = $this->getFrameOptions();
1856 if ( $frameOptions ) {
1857 $response->header( "X-Frame-Options: $frameOptions" );
1858 }
1859
1860 if ( $this->mArticleBodyOnly ) {
1861 $this->out( $this->mBodytext );
1862 } else {
1863 $this->addDefaultModules();
1864
1865 $sk = $this->getSkin();
1866
1867 // Hook that allows last minute changes to the output page, e.g.
1868 // adding of CSS or Javascript by extensions.
1869 wfRunHooks( 'BeforePageDisplay', array( &$this, &$sk ) );
1870
1871 wfProfileIn( 'Output-skin' );
1872 $sk->outputPage();
1873 wfProfileOut( 'Output-skin' );
1874 }
1875
1876 $this->sendCacheControl();
1877 ob_end_flush();
1878 wfProfileOut( __METHOD__ );
1879 }
1880
1881 /**
1882 * Actually output something with print().
1883 *
1884 * @param $ins String: the string to output
1885 */
1886 public function out( $ins ) {
1887 print $ins;
1888 }
1889
1890 /**
1891 * Produce a "user is blocked" page.
1892 * @deprecated since 1.18
1893 */
1894 function blockedPage() {
1895 throw new UserBlockedError( $this->getUser()->mBlock );
1896 }
1897
1898 /**
1899 * Output a standard error page
1900 *
1901 * showErrorPage( 'titlemsg', 'pagetextmsg', array( 'param1', 'param2' ) );
1902 * showErrorPage( 'titlemsg', $messageObject );
1903 *
1904 * @param $title String: message key for page title
1905 * @param $msg Mixed: message key (string) for page text, or a Message object
1906 * @param $params Array: message parameters; ignored if $msg is a Message object
1907 */
1908 public function showErrorPage( $title, $msg, $params = array() ) {
1909 if ( $this->getTitle() ) {
1910 $this->mDebugtext .= 'Original title: ' . $this->getTitle()->getPrefixedText() . "\n";
1911 }
1912 $this->setPageTitle( wfMsg( $title ) );
1913 $this->setHTMLTitle( wfMsg( 'errorpagetitle' ) );
1914 $this->setRobotPolicy( 'noindex,nofollow' );
1915 $this->setArticleRelated( false );
1916 $this->enableClientCache( false );
1917 $this->mRedirect = '';
1918 $this->mBodytext = '';
1919
1920 if ( $msg instanceof Message ){
1921 $this->addHTML( $msg->parse() );
1922 } else {
1923 $this->addWikiMsgArray( $msg, $params );
1924 }
1925
1926 $this->returnToMain();
1927 }
1928
1929 /**
1930 * Output a standard permission error page
1931 *
1932 * @param $errors Array: error message keys
1933 * @param $action String: action that was denied or null if unknown
1934 */
1935 public function showPermissionsErrorPage( $errors, $action = null ) {
1936 $this->mDebugtext .= 'Original title: ' .
1937 $this->getTitle()->getPrefixedText() . "\n";
1938 $this->setPageTitle( wfMsg( 'permissionserrors' ) );
1939 $this->setHTMLTitle( wfMsg( 'permissionserrors' ) );
1940 $this->setRobotPolicy( 'noindex,nofollow' );
1941 $this->setArticleRelated( false );
1942 $this->enableClientCache( false );
1943 $this->mRedirect = '';
1944 $this->mBodytext = '';
1945 $this->addWikiText( $this->formatPermissionsErrorMessage( $errors, $action ) );
1946 }
1947
1948 /**
1949 * Display an error page indicating that a given version of MediaWiki is
1950 * required to use it
1951 *
1952 * @param $version Mixed: the version of MediaWiki needed to use the page
1953 */
1954 public function versionRequired( $version ) {
1955 $this->setPageTitle( wfMsg( 'versionrequired', $version ) );
1956 $this->setHTMLTitle( wfMsg( 'versionrequired', $version ) );
1957 $this->setRobotPolicy( 'noindex,nofollow' );
1958 $this->setArticleRelated( false );
1959 $this->mBodytext = '';
1960
1961 $this->addWikiMsg( 'versionrequiredtext', $version );
1962 $this->returnToMain();
1963 }
1964
1965 /**
1966 * Display an error page noting that a given permission bit is required.
1967 * @deprecated since 1.18, just throw the exception directly
1968 * @param $permission String: key required
1969 */
1970 public function permissionRequired( $permission ) {
1971 throw new PermissionsError( $permission );
1972 }
1973
1974 /**
1975 * Produce the stock "please login to use the wiki" page
1976 */
1977 public function loginToUse() {
1978 if( $this->getUser()->isLoggedIn() ) {
1979 throw new PermissionsError( 'read' );
1980 }
1981
1982 $this->setPageTitle( wfMsg( 'loginreqtitle' ) );
1983 $this->setHtmlTitle( wfMsg( 'errorpagetitle' ) );
1984 $this->setRobotPolicy( 'noindex,nofollow' );
1985 $this->setArticleRelated( false );
1986
1987 $loginTitle = SpecialPage::getTitleFor( 'Userlogin' );
1988 $loginLink = Linker::linkKnown(
1989 $loginTitle,
1990 wfMsgHtml( 'loginreqlink' ),
1991 array(),
1992 array( 'returnto' => $this->getTitle()->getPrefixedText() )
1993 );
1994 $this->addHTML( wfMessage( 'loginreqpagetext' )->rawParams( $loginLink )->parse() .
1995 "\n<!--" . $this->getTitle()->getPrefixedUrl() . '-->' );
1996
1997 # Don't return to the main page if the user can't read it
1998 # otherwise we'll end up in a pointless loop
1999 $mainPage = Title::newMainPage();
2000 if( $mainPage->userCanRead() ) {
2001 $this->returnToMain( null, $mainPage );
2002 }
2003 }
2004
2005 /**
2006 * Format a list of error messages
2007 *
2008 * @param $errors Array of arrays returned by Title::getUserPermissionsErrors
2009 * @param $action String: action that was denied or null if unknown
2010 * @return String: the wikitext error-messages, formatted into a list.
2011 */
2012 public function formatPermissionsErrorMessage( $errors, $action = null ) {
2013 if ( $action == null ) {
2014 $text = wfMsgNoTrans( 'permissionserrorstext', count( $errors ) ) . "\n\n";
2015 } else {
2016 $action_desc = wfMsgNoTrans( "action-$action" );
2017 $text = wfMsgNoTrans(
2018 'permissionserrorstext-withaction',
2019 count( $errors ),
2020 $action_desc
2021 ) . "\n\n";
2022 }
2023
2024 if ( count( $errors ) > 1 ) {
2025 $text .= '<ul class="permissions-errors">' . "\n";
2026
2027 foreach( $errors as $error ) {
2028 $text .= '<li>';
2029 $text .= call_user_func_array( 'wfMsgNoTrans', $error );
2030 $text .= "</li>\n";
2031 }
2032 $text .= '</ul>';
2033 } else {
2034 $text .= "<div class=\"permissions-errors\">\n" .
2035 call_user_func_array( 'wfMsgNoTrans', reset( $errors ) ) .
2036 "\n</div>";
2037 }
2038
2039 return $text;
2040 }
2041
2042 /**
2043 * Display a page stating that the Wiki is in read-only mode,
2044 * and optionally show the source of the page that the user
2045 * was trying to edit. Should only be called (for this
2046 * purpose) after wfReadOnly() has returned true.
2047 *
2048 * For historical reasons, this function is _also_ used to
2049 * show the error message when a user tries to edit a page
2050 * they are not allowed to edit. (Unless it's because they're
2051 * blocked, then we show blockedPage() instead.) In this
2052 * case, the second parameter should be set to true and a list
2053 * of reasons supplied as the third parameter.
2054 *
2055 * @todo Needs to be split into multiple functions.
2056 *
2057 * @param $source String: source code to show (or null).
2058 * @param $protected Boolean: is this a permissions error?
2059 * @param $reasons Array: list of reasons for this error, as returned by Title::getUserPermissionsErrors().
2060 * @param $action String: action that was denied or null if unknown
2061 */
2062 public function readOnlyPage( $source = null, $protected = false, $reasons = array(), $action = null ) {
2063 global $wgEnableInterwikiTranscluding, $wgEnableInterwikiTemplatesTracking;
2064
2065 $this->setRobotPolicy( 'noindex,nofollow' );
2066 $this->setArticleRelated( false );
2067
2068 // If no reason is given, just supply a default "I can't let you do
2069 // that, Dave" message. Should only occur if called by legacy code.
2070 if ( $protected && empty( $reasons ) ) {
2071 $reasons[] = array( 'badaccess-group0' );
2072 }
2073
2074 if ( !empty( $reasons ) ) {
2075 // Permissions error
2076 if( $source ) {
2077 $this->setPageTitle( wfMsg( 'viewsource' ) );
2078 $this->setSubtitle(
2079 wfMsg( 'viewsourcefor', Linker::linkKnown( $this->getTitle() ) )
2080 );
2081 } else {
2082 $this->setPageTitle( wfMsg( 'badaccess' ) );
2083 }
2084 $this->addWikiText( $this->formatPermissionsErrorMessage( $reasons, $action ) );
2085 } else {
2086 // Wiki is read only
2087 throw new ReadOnlyError;
2088 }
2089
2090 // Show source, if supplied
2091 if( is_string( $source ) ) {
2092 $this->addWikiMsg( 'viewsourcetext' );
2093
2094 $pageLang = $this->getTitle()->getPageLanguage();
2095 $params = array(
2096 'id' => 'wpTextbox1',
2097 'name' => 'wpTextbox1',
2098 'cols' => $this->getUser()->getOption( 'cols' ),
2099 'rows' => $this->getUser()->getOption( 'rows' ),
2100 'readonly' => 'readonly',
2101 'lang' => $pageLang->getCode(),
2102 'dir' => $pageLang->getDir(),
2103 );
2104 $this->addHTML( Html::element( 'textarea', $params, $source ) );
2105
2106 // Show templates used by this article
2107 $article = new Article( $this->getTitle() );
2108 $templates = Linker::formatTemplates( $article->getUsedTemplates() );
2109 $this->addHTML( "<div class='templatesUsed'>
2110 $templates
2111 </div>
2112 " );
2113 if ( $wgEnableInterwikiTranscluding && $wgEnableInterwikiTemplatesTracking ) {
2114 $distantTemplates = Linker::formatDistantTemplates( $article->getUsedDistantTemplates() );
2115 $this->addHTML( "<div class='distantTemplatesUsed'>
2116 $distantTemplates
2117 </div>
2118 " );
2119 }
2120 }
2121
2122 # If the title doesn't exist, it's fairly pointless to print a return
2123 # link to it. After all, you just tried editing it and couldn't, so
2124 # what's there to do there?
2125 if( $this->getTitle()->exists() ) {
2126 $this->returnToMain( null, $this->getTitle() );
2127 }
2128 }
2129
2130 /**
2131 * Turn off regular page output and return an error reponse
2132 * for when rate limiting has triggered.
2133 */
2134 public function rateLimited() {
2135 throw new ThrottledError;
2136 }
2137
2138 /**
2139 * Show a warning about slave lag
2140 *
2141 * If the lag is higher than $wgSlaveLagCritical seconds,
2142 * then the warning is a bit more obvious. If the lag is
2143 * lower than $wgSlaveLagWarning, then no warning is shown.
2144 *
2145 * @param $lag Integer: slave lag
2146 */
2147 public function showLagWarning( $lag ) {
2148 global $wgSlaveLagWarning, $wgSlaveLagCritical;
2149 if( $lag >= $wgSlaveLagWarning ) {
2150 $message = $lag < $wgSlaveLagCritical
2151 ? 'lag-warn-normal'
2152 : 'lag-warn-high';
2153 $wrap = Html::rawElement( 'div', array( 'class' => "mw-{$message}" ), "\n$1\n" );
2154 $this->wrapWikiMsg( "$wrap\n", array( $message, $this->getContext()->getLang()->formatNum( $lag ) ) );
2155 }
2156 }
2157
2158 public function showFatalError( $message ) {
2159 $this->setPageTitle( wfMsg( 'internalerror' ) );
2160 $this->setRobotPolicy( 'noindex,nofollow' );
2161 $this->setArticleRelated( false );
2162 $this->enableClientCache( false );
2163 $this->mRedirect = '';
2164 $this->mBodytext = $message;
2165 }
2166
2167 public function showUnexpectedValueError( $name, $val ) {
2168 $this->showFatalError( wfMsg( 'unexpected', $name, $val ) );
2169 }
2170
2171 public function showFileCopyError( $old, $new ) {
2172 $this->showFatalError( wfMsg( 'filecopyerror', $old, $new ) );
2173 }
2174
2175 public function showFileRenameError( $old, $new ) {
2176 $this->showFatalError( wfMsg( 'filerenameerror', $old, $new ) );
2177 }
2178
2179 public function showFileDeleteError( $name ) {
2180 $this->showFatalError( wfMsg( 'filedeleteerror', $name ) );
2181 }
2182
2183 public function showFileNotFoundError( $name ) {
2184 $this->showFatalError( wfMsg( 'filenotfound', $name ) );
2185 }
2186
2187 /**
2188 * Add a "return to" link pointing to a specified title
2189 *
2190 * @param $title Title to link
2191 * @param $query String query string
2192 * @param $text String text of the link (input is not escaped)
2193 */
2194 public function addReturnTo( $title, $query = array(), $text = null ) {
2195 $this->addLink( array( 'rel' => 'next', 'href' => $title->getFullURL() ) );
2196 $link = wfMsgHtml(
2197 'returnto',
2198 Linker::link( $title, $text, array(), $query )
2199 );
2200 $this->addHTML( "<p id=\"mw-returnto\">{$link}</p>\n" );
2201 }
2202
2203 /**
2204 * Add a "return to" link pointing to a specified title,
2205 * or the title indicated in the request, or else the main page
2206 *
2207 * @param $unused No longer used
2208 * @param $returnto Title or String to return to
2209 * @param $returntoquery String: query string for the return to link
2210 */
2211 public function returnToMain( $unused = null, $returnto = null, $returntoquery = null ) {
2212 if ( $returnto == null ) {
2213 $returnto = $this->getRequest()->getText( 'returnto' );
2214 }
2215
2216 if ( $returntoquery == null ) {
2217 $returntoquery = $this->getRequest()->getText( 'returntoquery' );
2218 }
2219
2220 if ( $returnto === '' ) {
2221 $returnto = Title::newMainPage();
2222 }
2223
2224 if ( is_object( $returnto ) ) {
2225 $titleObj = $returnto;
2226 } else {
2227 $titleObj = Title::newFromText( $returnto );
2228 }
2229 if ( !is_object( $titleObj ) ) {
2230 $titleObj = Title::newMainPage();
2231 }
2232
2233 $this->addReturnTo( $titleObj, $returntoquery );
2234 }
2235
2236 /**
2237 * @param $sk Skin The given Skin
2238 * @param $includeStyle Boolean: unused
2239 * @return String: The doctype, opening <html>, and head element.
2240 */
2241 public function headElement( Skin $sk, $includeStyle = true ) {
2242 global $wgContLang, $wgUseTrackbacks;
2243 $userdir = $this->getLang()->getDir();
2244 $sitedir = $wgContLang->getDir();
2245
2246 if ( $sk->commonPrintStylesheet() ) {
2247 $this->addModuleStyles( 'mediawiki.legacy.wikiprintable' );
2248 }
2249
2250 $ret = Html::htmlHeader( array( 'lang' => $this->getLang()->getCode(), 'dir' => $userdir, 'class' => 'client-nojs' ) );
2251
2252 if ( $this->getHTMLTitle() == '' ) {
2253 $this->setHTMLTitle( wfMsg( 'pagetitle', $this->getPageTitle() ) );
2254 }
2255
2256 $openHead = Html::openElement( 'head' );
2257 if ( $openHead ) {
2258 # Don't bother with the newline if $head == ''
2259 $ret .= "$openHead\n";
2260 }
2261
2262 $ret .= Html::element( 'title', null, $this->getHTMLTitle() ) . "\n";
2263
2264 $ret .= implode( "\n", array(
2265 $this->getHeadLinks( null, true ),
2266 $this->buildCssLinks(),
2267 $this->getHeadScripts(),
2268 $this->getHeadItems()
2269 ) );
2270
2271 if ( $wgUseTrackbacks && $this->isArticleRelated() ) {
2272 $ret .= $this->getTitle()->trackbackRDF();
2273 }
2274
2275 $closeHead = Html::closeElement( 'head' );
2276 if ( $closeHead ) {
2277 $ret .= "$closeHead\n";
2278 }
2279
2280 $bodyAttrs = array();
2281
2282 # Classes for LTR/RTL directionality support
2283 $bodyAttrs['class'] = "mediawiki $userdir sitedir-$sitedir";
2284
2285 if ( $this->getContext()->getLang()->capitalizeAllNouns() ) {
2286 # A <body> class is probably not the best way to do this . . .
2287 $bodyAttrs['class'] .= ' capitalize-all-nouns';
2288 }
2289 $bodyAttrs['class'] .= ' ' . $sk->getPageClasses( $this->getTitle() );
2290 $bodyAttrs['class'] .= ' skin-' . Sanitizer::escapeClass( $sk->getSkinName() );
2291
2292 $sk->addToBodyAttributes( $this, $bodyAttrs ); // Allow skins to add body attributes they need
2293 wfRunHooks( 'OutputPageBodyAttributes', array( $this, $sk, &$bodyAttrs ) );
2294
2295 $ret .= Html::openElement( 'body', $bodyAttrs ) . "\n";
2296
2297 return $ret;
2298 }
2299
2300 /**
2301 * Add the default ResourceLoader modules to this object
2302 */
2303 private function addDefaultModules() {
2304 global $wgIncludeLegacyJavaScript, $wgUseAjax, $wgAjaxWatch, $wgEnableMWSuggest;
2305
2306 // Add base resources
2307 $this->addModules( array(
2308 'mediawiki.user',
2309 'mediawiki.util',
2310 'mediawiki.page.startup',
2311 'mediawiki.page.ready',
2312 ) );
2313 if ( $wgIncludeLegacyJavaScript ){
2314 $this->addModules( 'mediawiki.legacy.wikibits' );
2315 }
2316
2317 // Add various resources if required
2318 if ( $wgUseAjax ) {
2319 $this->addModules( 'mediawiki.legacy.ajax' );
2320
2321 wfRunHooks( 'AjaxAddScript', array( &$this ) );
2322
2323 if( $wgAjaxWatch && $this->getUser()->isLoggedIn() ) {
2324 $this->addModules( 'mediawiki.action.watch.ajax' );
2325 }
2326
2327 if ( $wgEnableMWSuggest && !$this->getUser()->getOption( 'disablesuggest', false ) ) {
2328 $this->addModules( 'mediawiki.legacy.mwsuggest' );
2329 }
2330 }
2331
2332 if ( $this->getUser()->getBoolOption( 'editsectiononrightclick' ) ) {
2333 $this->addModules( 'mediawiki.action.view.rightClickEdit' );
2334 }
2335
2336 # Crazy edit-on-double-click stuff
2337 if ( $this->isArticle() && $this->getUser()->getOption( 'editondblclick' ) ) {
2338 $this->addModules( 'mediawiki.action.view.dblClickEdit' );
2339 }
2340 }
2341
2342 /**
2343 * Get a ResourceLoader object associated with this OutputPage
2344 *
2345 * @return ResourceLoader
2346 */
2347 public function getResourceLoader() {
2348 if ( is_null( $this->mResourceLoader ) ) {
2349 $this->mResourceLoader = new ResourceLoader();
2350 }
2351 return $this->mResourceLoader;
2352 }
2353
2354 /**
2355 * TODO: Document
2356 * @param $modules Array/string with the module name(s)
2357 * @param $only String ResourceLoaderModule TYPE_ class constant
2358 * @param $useESI boolean
2359 * @param $extraQuery Array with extra query parameters to add to each request. array( param => value )
2360 * @return string html <script> and <style> tags
2361 */
2362 protected function makeResourceLoaderLink( $modules, $only, $useESI = false, array $extraQuery = array() ) {
2363 global $wgLoadScript, $wgResourceLoaderUseESI,
2364 $wgResourceLoaderInlinePrivateModules;
2365
2366 if ( !count( $modules ) ) {
2367 return '';
2368 }
2369
2370 if ( count( $modules ) > 1 ) {
2371 // Remove duplicate module requests
2372 $modules = array_unique( (array) $modules );
2373 // Sort module names so requests are more uniform
2374 sort( $modules );
2375
2376 if ( ResourceLoader::inDebugMode() ) {
2377 // Recursively call us for every item
2378 $links = '';
2379 foreach ( $modules as $name ) {
2380 $links .= $this->makeResourceLoaderLink( $name, $only, $useESI );
2381 }
2382 return $links;
2383 }
2384 }
2385
2386 // Create keyed-by-group list of module objects from modules list
2387 $groups = array();
2388 $resourceLoader = $this->getResourceLoader();
2389 foreach ( (array) $modules as $name ) {
2390 $module = $resourceLoader->getModule( $name );
2391 # Check that we're allowed to include this module on this page
2392 if ( ( $module->getOrigin() > $this->getAllowedModules( ResourceLoaderModule::TYPE_SCRIPTS )
2393 && $only == ResourceLoaderModule::TYPE_SCRIPTS )
2394 || ( $module->getOrigin() > $this->getAllowedModules( ResourceLoaderModule::TYPE_STYLES )
2395 && $only == ResourceLoaderModule::TYPE_STYLES )
2396 )
2397 {
2398 continue;
2399 }
2400
2401 $group = $module->getGroup();
2402 if ( !isset( $groups[$group] ) ) {
2403 $groups[$group] = array();
2404 }
2405 $groups[$group][$name] = $module;
2406 }
2407
2408 $links = '';
2409 foreach ( $groups as $group => $modules ) {
2410 // Special handling for user-specific groups
2411 $user = null;
2412 if ( ( $group === 'user' || $group === 'private' ) && $this->getUser()->isLoggedIn() ) {
2413 $user = $this->getUser()->getName();
2414 }
2415
2416 // Create a fake request based on the one we are about to make so modules return
2417 // correct timestamp and emptiness data
2418 $query = ResourceLoader::makeLoaderQuery(
2419 array(), // modules; not determined yet
2420 $this->getContext()->getLang()->getCode(),
2421 $this->getSkin()->getSkinName(),
2422 $user,
2423 null, // version; not determined yet
2424 ResourceLoader::inDebugMode(),
2425 $only === ResourceLoaderModule::TYPE_COMBINED ? null : $only,
2426 $this->isPrintable(),
2427 $this->getRequest()->getBool( 'handheld' ),
2428 $extraQuery
2429 );
2430 $context = new ResourceLoaderContext( $resourceLoader, new FauxRequest( $query ) );
2431 // Drop modules that know they're empty
2432 foreach ( $modules as $key => $module ) {
2433 if ( $module->isKnownEmpty( $context ) ) {
2434 unset( $modules[$key] );
2435 }
2436 }
2437 // If there are no modules left, skip this group
2438 if ( $modules === array() ) {
2439 continue;
2440 }
2441
2442 // Support inlining of private modules if configured as such
2443 if ( $group === 'private' && $wgResourceLoaderInlinePrivateModules ) {
2444 if ( $only == ResourceLoaderModule::TYPE_STYLES ) {
2445 $links .= Html::inlineStyle(
2446 $resourceLoader->makeModuleResponse( $context, $modules )
2447 );
2448 } else {
2449 $links .= Html::inlineScript(
2450 ResourceLoader::makeLoaderConditionalScript(
2451 $resourceLoader->makeModuleResponse( $context, $modules )
2452 )
2453 );
2454 }
2455 $links .= "\n";
2456 continue;
2457 }
2458 // Special handling for the user group; because users might change their stuff
2459 // on-wiki like user pages, or user preferences; we need to find the highest
2460 // timestamp of these user-changable modules so we can ensure cache misses on change
2461 // This should NOT be done for the site group (bug 27564) because anons get that too
2462 // and we shouldn't be putting timestamps in Squid-cached HTML
2463 $version = null;
2464 if ( $group === 'user' ) {
2465 // Get the maximum timestamp
2466 $timestamp = 1;
2467 foreach ( $modules as $module ) {
2468 $timestamp = max( $timestamp, $module->getModifiedTime( $context ) );
2469 }
2470 // Add a version parameter so cache will break when things change
2471 $version = wfTimestamp( TS_ISO_8601_BASIC, $timestamp );
2472 }
2473
2474 $url = ResourceLoader::makeLoaderURL(
2475 array_keys( $modules ),
2476 $this->getContext()->getLang()->getCode(),
2477 $this->getSkin()->getSkinName(),
2478 $user,
2479 $version,
2480 ResourceLoader::inDebugMode(),
2481 $only === ResourceLoaderModule::TYPE_COMBINED ? null : $only,
2482 $this->isPrintable(),
2483 $this->getRequest()->getBool( 'handheld' ),
2484 $extraQuery
2485 );
2486 if ( $useESI && $wgResourceLoaderUseESI ) {
2487 $esi = Xml::element( 'esi:include', array( 'src' => $url ) );
2488 if ( $only == ResourceLoaderModule::TYPE_STYLES ) {
2489 $link = Html::inlineStyle( $esi );
2490 } else {
2491 $link = Html::inlineScript( $esi );
2492 }
2493 } else {
2494 // Automatically select style/script elements
2495 if ( $only === ResourceLoaderModule::TYPE_STYLES ) {
2496 $link = Html::linkedStyle( $url );
2497 } else {
2498 $link = Html::linkedScript( $url );
2499 }
2500 }
2501
2502 if( $group == 'noscript' ){
2503 $links .= Html::rawElement( 'noscript', array(), $link ) . "\n";
2504 } else {
2505 $links .= $link . "\n";
2506 }
2507 }
2508 return $links;
2509 }
2510
2511 /**
2512 * JS stuff to put in the <head>. This is the startup module, config
2513 * vars and modules marked with position 'top'
2514 *
2515 * @return String: HTML fragment
2516 */
2517 function getHeadScripts() {
2518 // Startup - this will immediately load jquery and mediawiki modules
2519 $scripts = $this->makeResourceLoaderLink( 'startup', ResourceLoaderModule::TYPE_SCRIPTS, true );
2520
2521 // Load config before anything else
2522 $scripts .= Html::inlineScript(
2523 ResourceLoader::makeLoaderConditionalScript(
2524 ResourceLoader::makeConfigSetScript( $this->getJSVars() )
2525 )
2526 );
2527
2528 // Script and Messages "only" requests marked for top inclusion
2529 // Messages should go first
2530 $scripts .= $this->makeResourceLoaderLink( $this->getModuleMessages( true, 'top' ), ResourceLoaderModule::TYPE_MESSAGES );
2531 $scripts .= $this->makeResourceLoaderLink( $this->getModuleScripts( true, 'top' ), ResourceLoaderModule::TYPE_SCRIPTS );
2532
2533 // Modules requests - let the client calculate dependencies and batch requests as it likes
2534 // Only load modules that have marked themselves for loading at the top
2535 $modules = $this->getModules( true, 'top' );
2536 if ( $modules ) {
2537 $scripts .= Html::inlineScript(
2538 ResourceLoader::makeLoaderConditionalScript(
2539 Xml::encodeJsCall( 'mw.loader.load', array( $modules ) )
2540 )
2541 );
2542 }
2543
2544 return $scripts;
2545 }
2546
2547 /**
2548 * JS stuff to put at the bottom of the <body>: modules marked with position 'bottom',
2549 * legacy scripts ($this->mScripts), user preferences, site JS and user JS
2550 *
2551 * @return string
2552 */
2553 function getBottomScripts() {
2554 global $wgUseSiteJs, $wgAllowUserJs;
2555
2556 // Script and Messages "only" requests marked for bottom inclusion
2557 // Messages should go first
2558 $scripts = $this->makeResourceLoaderLink( $this->getModuleMessages( true, 'bottom' ), ResourceLoaderModule::TYPE_MESSAGES );
2559 $scripts .= $this->makeResourceLoaderLink( $this->getModuleScripts( true, 'bottom' ), ResourceLoaderModule::TYPE_SCRIPTS );
2560
2561 // Modules requests - let the client calculate dependencies and batch requests as it likes
2562 // Only load modules that have marked themselves for loading at the bottom
2563 $modules = $this->getModules( true, 'bottom' );
2564 if ( $modules ) {
2565 $scripts .= Html::inlineScript(
2566 ResourceLoader::makeLoaderConditionalScript(
2567 Xml::encodeJsCall( 'mw.loader.load', array( $modules ) )
2568 )
2569 );
2570 }
2571
2572 // Legacy Scripts
2573 $scripts .= "\n" . $this->mScripts;
2574
2575 $userScripts = array( 'user.options', 'user.tokens' );
2576
2577 // Add site JS if enabled
2578 if ( $wgUseSiteJs ) {
2579 $scripts .= $this->makeResourceLoaderLink( 'site', ResourceLoaderModule::TYPE_SCRIPTS );
2580 if( $this->getUser()->isLoggedIn() ){
2581 $userScripts[] = 'user.groups';
2582 }
2583 }
2584
2585 // Add user JS if enabled
2586 if ( $wgAllowUserJs && $this->getUser()->isLoggedIn() ) {
2587 if( $this->getTitle() && $this->getTitle()->isJsSubpage() && $this->userCanPreview() ) {
2588 # XXX: additional security check/prompt?
2589 // We're on a preview of a JS subpage
2590 // Exclude this page from the user module in case it's in there (bug 26283)
2591 $scripts .= $this->makeResourceLoaderLink( 'user', ResourceLoaderModule::TYPE_SCRIPTS, false,
2592 array( 'excludepage' => $this->getTitle()->getPrefixedDBkey() )
2593 );
2594 // Load the previewed JS
2595 $scripts .= Html::inlineScript( "\n" . $this->getRequest()->getText( 'wpTextbox1' ) . "\n" ) . "\n";
2596 } else {
2597 // Include the user module normally
2598 // We can't do $userScripts[] = 'user'; because the user module would end up
2599 // being wrapped in a closure, so load it raw like 'site'
2600 $scripts .= $this->makeResourceLoaderLink( 'user', ResourceLoaderModule::TYPE_SCRIPTS );
2601 }
2602 }
2603 $scripts .= $this->makeResourceLoaderLink( $userScripts, ResourceLoaderModule::TYPE_COMBINED );
2604
2605 return $scripts;
2606 }
2607
2608 /**
2609 * Get an array containing global JS variables
2610 *
2611 * Do not add things here which can be evaluated in
2612 * ResourceLoaderStartupScript - in other words, without state.
2613 * You will only be adding bloat to the page and causing page caches to
2614 * have to be purged on configuration changes.
2615 */
2616 protected function getJSVars() {
2617 global $wgUseAjax, $wgEnableMWSuggest, $wgContLang;
2618
2619 $title = $this->getTitle();
2620 $ns = $title->getNamespace();
2621 $nsname = MWNamespace::exists( $ns ) ? MWNamespace::getCanonicalName( $ns ) : $title->getNsText();
2622 if ( $ns == NS_SPECIAL ) {
2623 list( $canonicalName, /*...*/ ) = SpecialPageFactory::resolveAlias( $title->getDBkey() );
2624 } else {
2625 $canonicalName = false; # bug 21115
2626 }
2627
2628 $vars = array(
2629 'wgCanonicalNamespace' => $nsname,
2630 'wgCanonicalSpecialPageName' => $canonicalName,
2631 'wgNamespaceNumber' => $title->getNamespace(),
2632 'wgPageName' => $title->getPrefixedDBKey(),
2633 'wgTitle' => $title->getText(),
2634 'wgCurRevisionId' => $title->getLatestRevID(),
2635 'wgArticleId' => $title->getArticleId(),
2636 'wgIsArticle' => $this->isArticle(),
2637 'wgAction' => $this->getRequest()->getText( 'action', 'view' ),
2638 'wgUserName' => $this->getUser()->isAnon() ? null : $this->getUser()->getName(),
2639 'wgUserGroups' => $this->getUser()->getEffectiveGroups(),
2640 'wgCategories' => $this->getCategories(),
2641 'wgBreakFrames' => $this->getFrameOptions() == 'DENY',
2642 );
2643 if ( $wgContLang->hasVariants() ) {
2644 $vars['wgUserVariant'] = $wgContLang->getPreferredVariant();
2645 }
2646 foreach ( $title->getRestrictionTypes() as $type ) {
2647 $vars['wgRestriction' . ucfirst( $type )] = $title->getRestrictions( $type );
2648 }
2649 if ( $wgUseAjax && $wgEnableMWSuggest && !$this->getUser()->getOption( 'disablesuggest', false ) ) {
2650 $vars['wgSearchNamespaces'] = SearchEngine::userNamespaces( $this->getUser() );
2651 }
2652 if ( $title->isMainPage() ) {
2653 $vars['wgIsMainPage'] = true;
2654 }
2655
2656 // Allow extensions to add their custom variables to the global JS variables
2657 wfRunHooks( 'MakeGlobalVariablesScript', array( &$vars, &$this ) );
2658
2659 return $vars;
2660 }
2661
2662 /**
2663 * To make it harder for someone to slip a user a fake
2664 * user-JavaScript or user-CSS preview, a random token
2665 * is associated with the login session. If it's not
2666 * passed back with the preview request, we won't render
2667 * the code.
2668 *
2669 * @return bool
2670 */
2671 public function userCanPreview() {
2672 if ( $this->getRequest()->getVal( 'action' ) != 'submit'
2673 || !$this->getRequest()->wasPosted()
2674 || !$this->getUser()->matchEditToken(
2675 $this->getRequest()->getVal( 'wpEditToken' ) )
2676 ) {
2677 return false;
2678 }
2679 if ( !$this->getTitle()->isJsSubpage() && !$this->getTitle()->isCssSubpage() ) {
2680 return false;
2681 }
2682
2683 return !count( $this->getTitle()->getUserPermissionsErrors( 'edit', $this->getUser() ) );
2684 }
2685
2686 /**
2687 * @param $unused Unused
2688 * @param $addContentType bool
2689 *
2690 * @return string HTML tag links to be put in the header.
2691 */
2692 public function getHeadLinks( $unused = null, $addContentType = false ) {
2693 global $wgUniversalEditButton, $wgFavicon, $wgAppleTouchIcon, $wgEnableAPI,
2694 $wgSitename, $wgVersion, $wgHtml5, $wgMimeType,
2695 $wgFeed, $wgOverrideSiteFeed, $wgAdvertisedFeedTypes,
2696 $wgDisableLangConversion, $wgCanonicalLanguageLinks, $wgContLang,
2697 $wgRightsPage, $wgRightsUrl;
2698
2699 $tags = array();
2700
2701 if ( $addContentType ) {
2702 if ( $wgHtml5 ) {
2703 # More succinct than <meta http-equiv=Content-Type>, has the
2704 # same effect
2705 $tags[] = Html::element( 'meta', array( 'charset' => 'UTF-8' ) );
2706 } else {
2707 $tags[] = Html::element( 'meta', array(
2708 'http-equiv' => 'Content-Type',
2709 'content' => "$wgMimeType; charset=UTF-8"
2710 ) );
2711 $tags[] = Html::element( 'meta', array( // bug 15835
2712 'http-equiv' => 'Content-Style-Type',
2713 'content' => 'text/css'
2714 ) );
2715 }
2716 }
2717
2718 $tags[] = Html::element( 'meta', array(
2719 'name' => 'generator',
2720 'content' => "MediaWiki $wgVersion",
2721 ) );
2722
2723 $p = "{$this->mIndexPolicy},{$this->mFollowPolicy}";
2724 if( $p !== 'index,follow' ) {
2725 // http://www.robotstxt.org/wc/meta-user.html
2726 // Only show if it's different from the default robots policy
2727 $tags[] = Html::element( 'meta', array(
2728 'name' => 'robots',
2729 'content' => $p,
2730 ) );
2731 }
2732
2733 if ( count( $this->mKeywords ) > 0 ) {
2734 $strip = array(
2735 "/<.*?" . ">/" => '',
2736 "/_/" => ' '
2737 );
2738 $tags[] = Html::element( 'meta', array(
2739 'name' => 'keywords',
2740 'content' => preg_replace(
2741 array_keys( $strip ),
2742 array_values( $strip ),
2743 implode( ',', $this->mKeywords )
2744 )
2745 ) );
2746 }
2747
2748 foreach ( $this->mMetatags as $tag ) {
2749 if ( 0 == strcasecmp( 'http:', substr( $tag[0], 0, 5 ) ) ) {
2750 $a = 'http-equiv';
2751 $tag[0] = substr( $tag[0], 5 );
2752 } else {
2753 $a = 'name';
2754 }
2755 $tags[] = Html::element( 'meta',
2756 array(
2757 $a => $tag[0],
2758 'content' => $tag[1]
2759 )
2760 );
2761 }
2762
2763 foreach ( $this->mLinktags as $tag ) {
2764 $tags[] = Html::element( 'link', $tag );
2765 }
2766
2767 # Universal edit button
2768 if ( $wgUniversalEditButton ) {
2769 if ( $this->isArticleRelated() && $this->getTitle() && $this->getTitle()->quickUserCan( 'edit' )
2770 && ( $this->getTitle()->exists() || $this->getTitle()->quickUserCan( 'create' ) ) ) {
2771 // Original UniversalEditButton
2772 $msg = wfMsg( 'edit' );
2773 $tags[] = Html::element( 'link', array(
2774 'rel' => 'alternate',
2775 'type' => 'application/x-wiki',
2776 'title' => $msg,
2777 'href' => $this->getTitle()->getLocalURL( 'action=edit' )
2778 ) );
2779 // Alternate edit link
2780 $tags[] = Html::element( 'link', array(
2781 'rel' => 'edit',
2782 'title' => $msg,
2783 'href' => $this->getTitle()->getLocalURL( 'action=edit' )
2784 ) );
2785 }
2786 }
2787
2788 # Generally the order of the favicon and apple-touch-icon links
2789 # should not matter, but Konqueror (3.5.9 at least) incorrectly
2790 # uses whichever one appears later in the HTML source. Make sure
2791 # apple-touch-icon is specified first to avoid this.
2792 if ( $wgAppleTouchIcon !== false ) {
2793 $tags[] = Html::element( 'link', array( 'rel' => 'apple-touch-icon', 'href' => $wgAppleTouchIcon ) );
2794 }
2795
2796 if ( $wgFavicon !== false ) {
2797 $tags[] = Html::element( 'link', array( 'rel' => 'shortcut icon', 'href' => $wgFavicon ) );
2798 }
2799
2800 # OpenSearch description link
2801 $tags[] = Html::element( 'link', array(
2802 'rel' => 'search',
2803 'type' => 'application/opensearchdescription+xml',
2804 'href' => wfScript( 'opensearch_desc' ),
2805 'title' => wfMsgForContent( 'opensearch-desc' ),
2806 ) );
2807
2808 if ( $wgEnableAPI ) {
2809 # Real Simple Discovery link, provides auto-discovery information
2810 # for the MediaWiki API (and potentially additional custom API
2811 # support such as WordPress or Twitter-compatible APIs for a
2812 # blogging extension, etc)
2813 $tags[] = Html::element( 'link', array(
2814 'rel' => 'EditURI',
2815 'type' => 'application/rsd+xml',
2816 // Output a protocol-relative URL here if $wgServer is protocol-relative
2817 // Whether RSD accepts relative or protocol-relative URLs is completely undocumented, though
2818 'href' => wfExpandUrl( wfAppendQuery( wfScript( 'api' ), array( 'action' => 'rsd' ) ), PROTO_RELATIVE ),
2819 ) );
2820 }
2821
2822 # Language variants
2823 if ( !$wgDisableLangConversion && $wgCanonicalLanguageLinks
2824 && $wgContLang->hasVariants() ) {
2825
2826 $urlvar = $wgContLang->getURLVariant();
2827
2828 if ( !$urlvar ) {
2829 $variants = $wgContLang->getVariants();
2830 foreach ( $variants as $_v ) {
2831 $tags[] = Html::element( 'link', array(
2832 'rel' => 'alternate',
2833 'hreflang' => $_v,
2834 'href' => $this->getTitle()->getLocalURL( '', $_v ) )
2835 );
2836 }
2837 } else {
2838 $tags[] = Html::element( 'link', array(
2839 'rel' => 'canonical',
2840 'href' => $this->getTitle()->getCanonicalUrl()
2841 ) );
2842 }
2843 }
2844
2845 # Copyright
2846 $copyright = '';
2847 if ( $wgRightsPage ) {
2848 $copy = Title::newFromText( $wgRightsPage );
2849
2850 if ( $copy ) {
2851 $copyright = $copy->getLocalURL();
2852 }
2853 }
2854
2855 if ( !$copyright && $wgRightsUrl ) {
2856 $copyright = $wgRightsUrl;
2857 }
2858
2859 if ( $copyright ) {
2860 $tags[] = Html::element( 'link', array(
2861 'rel' => 'copyright',
2862 'href' => $copyright )
2863 );
2864 }
2865
2866 # Feeds
2867 if ( $wgFeed ) {
2868 foreach( $this->getSyndicationLinks() as $format => $link ) {
2869 # Use the page name for the title. In principle, this could
2870 # lead to issues with having the same name for different feeds
2871 # corresponding to the same page, but we can't avoid that at
2872 # this low a level.
2873
2874 $tags[] = $this->feedLink(
2875 $format,
2876 $link,
2877 # Used messages: 'page-rss-feed' and 'page-atom-feed' (for an easier grep)
2878 wfMsg( "page-{$format}-feed", $this->getTitle()->getPrefixedText() )
2879 );
2880 }
2881
2882 # Recent changes feed should appear on every page (except recentchanges,
2883 # that would be redundant). Put it after the per-page feed to avoid
2884 # changing existing behavior. It's still available, probably via a
2885 # menu in your browser. Some sites might have a different feed they'd
2886 # like to promote instead of the RC feed (maybe like a "Recent New Articles"
2887 # or "Breaking news" one). For this, we see if $wgOverrideSiteFeed is defined.
2888 # If so, use it instead.
2889
2890 $rctitle = SpecialPage::getTitleFor( 'Recentchanges' );
2891
2892 if ( $wgOverrideSiteFeed ) {
2893 foreach ( $wgOverrideSiteFeed as $type => $feedUrl ) {
2894 // Note, this->feedLink escapes the url.
2895 $tags[] = $this->feedLink(
2896 $type,
2897 $feedUrl,
2898 wfMsg( "site-{$type}-feed", $wgSitename )
2899 );
2900 }
2901 } elseif ( $this->getTitle()->getPrefixedText() != $rctitle->getPrefixedText() ) {
2902 foreach ( $wgAdvertisedFeedTypes as $format ) {
2903 $tags[] = $this->feedLink(
2904 $format,
2905 $rctitle->getLocalURL( "feed={$format}" ),
2906 wfMsg( "site-{$format}-feed", $wgSitename ) # For grep: 'site-rss-feed', 'site-atom-feed'.
2907 );
2908 }
2909 }
2910 }
2911 return implode( "\n", $tags );
2912 }
2913
2914 /**
2915 * Generate a <link rel/> for a feed.
2916 *
2917 * @param $type String: feed type
2918 * @param $url String: URL to the feed
2919 * @param $text String: value of the "title" attribute
2920 * @return String: HTML fragment
2921 */
2922 private function feedLink( $type, $url, $text ) {
2923 return Html::element( 'link', array(
2924 'rel' => 'alternate',
2925 'type' => "application/$type+xml",
2926 'title' => $text,
2927 'href' => $url )
2928 );
2929 }
2930
2931 /**
2932 * Add a local or specified stylesheet, with the given media options.
2933 * Meant primarily for internal use...
2934 *
2935 * @param $style String: URL to the file
2936 * @param $media String: to specify a media type, 'screen', 'printable', 'handheld' or any.
2937 * @param $condition String: for IE conditional comments, specifying an IE version
2938 * @param $dir String: set to 'rtl' or 'ltr' for direction-specific sheets
2939 */
2940 public function addStyle( $style, $media = '', $condition = '', $dir = '' ) {
2941 $options = array();
2942 // Even though we expect the media type to be lowercase, but here we
2943 // force it to lowercase to be safe.
2944 if( $media ) {
2945 $options['media'] = $media;
2946 }
2947 if( $condition ) {
2948 $options['condition'] = $condition;
2949 }
2950 if( $dir ) {
2951 $options['dir'] = $dir;
2952 }
2953 $this->styles[$style] = $options;
2954 }
2955
2956 /**
2957 * Adds inline CSS styles
2958 * @param $style_css Mixed: inline CSS
2959 * @param $flip String: Set to 'flip' to flip the CSS if needed
2960 */
2961 public function addInlineStyle( $style_css, $flip = 'noflip' ) {
2962 if( $flip === 'flip' && $this->getLang()->isRTL() ) {
2963 # If wanted, and the interface is right-to-left, flip the CSS
2964 $style_css = CSSJanus::transform( $style_css, true, false );
2965 }
2966 $this->mInlineStyles .= Html::inlineStyle( $style_css );
2967 }
2968
2969 /**
2970 * Build a set of <link>s for the stylesheets specified in the $this->styles array.
2971 * These will be applied to various media & IE conditionals.
2972 *
2973 * @return string
2974 */
2975 public function buildCssLinks() {
2976 global $wgUseSiteCss, $wgAllowUserCss, $wgAllowUserCssPrefs;
2977
2978 $this->getSkin()->setupSkinUserCss( $this );
2979
2980 // Add ResourceLoader styles
2981 // Split the styles into four groups
2982 $styles = array( 'other' => array(), 'user' => array(), 'site' => array(), 'private' => array(), 'noscript' => array() );
2983 $otherTags = ''; // Tags to append after the normal <link> tags
2984 $resourceLoader = $this->getResourceLoader();
2985
2986 $moduleStyles = $this->getModuleStyles();
2987
2988 // Per-site custom styles
2989 if ( $wgUseSiteCss ) {
2990 $moduleStyles[] = 'site';
2991 $moduleStyles[] = 'noscript';
2992 if( $this->getUser()->isLoggedIn() ){
2993 $moduleStyles[] = 'user.groups';
2994 }
2995 }
2996
2997 // Per-user custom styles
2998 if ( $wgAllowUserCss ) {
2999 if ( $this->getTitle()->isCssSubpage() && $this->userCanPreview() ) {
3000 // We're on a preview of a CSS subpage
3001 // Exclude this page from the user module in case it's in there (bug 26283)
3002 $otherTags .= $this->makeResourceLoaderLink( 'user', ResourceLoaderModule::TYPE_STYLES, false,
3003 array( 'excludepage' => $this->getTitle()->getPrefixedDBkey() )
3004 );
3005 // Load the previewed CSS
3006 $otherTags .= Html::inlineStyle( $this->getRequest()->getText( 'wpTextbox1' ) );
3007 } else {
3008 // Load the user styles normally
3009 $moduleStyles[] = 'user';
3010 }
3011 }
3012
3013 // Per-user preference styles
3014 if ( $wgAllowUserCssPrefs ) {
3015 $moduleStyles[] = 'user.options';
3016 }
3017
3018 foreach ( $moduleStyles as $name ) {
3019 $group = $resourceLoader->getModule( $name )->getGroup();
3020 // Modules in groups named "other" or anything different than "user", "site" or "private"
3021 // will be placed in the "other" group
3022 $styles[isset( $styles[$group] ) ? $group : 'other'][] = $name;
3023 }
3024
3025 // We want site, private and user styles to override dynamically added styles from modules, but we want
3026 // dynamically added styles to override statically added styles from other modules. So the order
3027 // has to be other, dynamic, site, private, user
3028 // Add statically added styles for other modules
3029 $ret = $this->makeResourceLoaderLink( $styles['other'], ResourceLoaderModule::TYPE_STYLES );
3030 // Add normal styles added through addStyle()/addInlineStyle() here
3031 $ret .= implode( "\n", $this->buildCssLinksArray() ) . $this->mInlineStyles;
3032 // Add marker tag to mark the place where the client-side loader should inject dynamic styles
3033 // We use a <meta> tag with a made-up name for this because that's valid HTML
3034 $ret .= Html::element( 'meta', array( 'name' => 'ResourceLoaderDynamicStyles', 'content' => '' ) ) . "\n";
3035
3036 // Add site, private and user styles
3037 // 'private' at present only contains user.options, so put that before 'user'
3038 // Any future private modules will likely have a similar user-specific character
3039 foreach ( array( 'site', 'noscript', 'private', 'user' ) as $group ) {
3040 $ret .= $this->makeResourceLoaderLink( $styles[$group],
3041 ResourceLoaderModule::TYPE_STYLES
3042 );
3043 }
3044
3045 // Add stuff in $otherTags (previewed user CSS if applicable)
3046 $ret .= $otherTags;
3047 return $ret;
3048 }
3049
3050 /**
3051 * @return Array
3052 */
3053 public function buildCssLinksArray() {
3054 $links = array();
3055
3056 // Add any extension CSS
3057 foreach ( $this->mExtStyles as $url ) {
3058 $this->addStyle( $url );
3059 }
3060 $this->mExtStyles = array();
3061
3062 foreach( $this->styles as $file => $options ) {
3063 $link = $this->styleLink( $file, $options );
3064 if( $link ) {
3065 $links[$file] = $link;
3066 }
3067 }
3068 return $links;
3069 }
3070
3071 /**
3072 * Generate \<link\> tags for stylesheets
3073 *
3074 * @param $style String: URL to the file
3075 * @param $options Array: option, can contain 'condition', 'dir', 'media'
3076 * keys
3077 * @return String: HTML fragment
3078 */
3079 protected function styleLink( $style, $options ) {
3080 if( isset( $options['dir'] ) ) {
3081 if( $this->getLang()->getDir() != $options['dir'] ) {
3082 return '';
3083 }
3084 }
3085
3086 if( isset( $options['media'] ) ) {
3087 $media = self::transformCssMedia( $options['media'] );
3088 if( is_null( $media ) ) {
3089 return '';
3090 }
3091 } else {
3092 $media = 'all';
3093 }
3094
3095 if( substr( $style, 0, 1 ) == '/' ||
3096 substr( $style, 0, 5 ) == 'http:' ||
3097 substr( $style, 0, 6 ) == 'https:' ) {
3098 $url = $style;
3099 } else {
3100 global $wgStylePath, $wgStyleVersion;
3101 $url = $wgStylePath . '/' . $style . '?' . $wgStyleVersion;
3102 }
3103
3104 $link = Html::linkedStyle( $url, $media );
3105
3106 if( isset( $options['condition'] ) ) {
3107 $condition = htmlspecialchars( $options['condition'] );
3108 $link = "<!--[if $condition]>$link<![endif]-->";
3109 }
3110 return $link;
3111 }
3112
3113 /**
3114 * Transform "media" attribute based on request parameters
3115 *
3116 * @param $media String: current value of the "media" attribute
3117 * @return String: modified value of the "media" attribute
3118 */
3119 public static function transformCssMedia( $media ) {
3120 global $wgRequest, $wgHandheldForIPhone;
3121
3122 // Switch in on-screen display for media testing
3123 $switches = array(
3124 'printable' => 'print',
3125 'handheld' => 'handheld',
3126 );
3127 foreach( $switches as $switch => $targetMedia ) {
3128 if( $wgRequest->getBool( $switch ) ) {
3129 if( $media == $targetMedia ) {
3130 $media = '';
3131 } elseif( $media == 'screen' ) {
3132 return null;
3133 }
3134 }
3135 }
3136
3137 // Expand longer media queries as iPhone doesn't grok 'handheld'
3138 if( $wgHandheldForIPhone ) {
3139 $mediaAliases = array(
3140 'screen' => 'screen and (min-device-width: 481px)',
3141 'handheld' => 'handheld, only screen and (max-device-width: 480px)',
3142 );
3143
3144 if( isset( $mediaAliases[$media] ) ) {
3145 $media = $mediaAliases[$media];
3146 }
3147 }
3148
3149 return $media;
3150 }
3151
3152 /**
3153 * Add a wikitext-formatted message to the output.
3154 * This is equivalent to:
3155 *
3156 * $wgOut->addWikiText( wfMsgNoTrans( ... ) )
3157 */
3158 public function addWikiMsg( /*...*/ ) {
3159 $args = func_get_args();
3160 $name = array_shift( $args );
3161 $this->addWikiMsgArray( $name, $args );
3162 }
3163
3164 /**
3165 * Add a wikitext-formatted message to the output.
3166 * Like addWikiMsg() except the parameters are taken as an array
3167 * instead of a variable argument list.
3168 *
3169 * $options is passed through to wfMsgExt(), see that function for details.
3170 *
3171 * @param $name string
3172 * @param $args array
3173 * @param $options array
3174 */
3175 public function addWikiMsgArray( $name, $args, $options = array() ) {
3176 $options[] = 'parse';
3177 $text = wfMsgExt( $name, $options, $args );
3178 $this->addHTML( $text );
3179 }
3180
3181 /**
3182 * This function takes a number of message/argument specifications, wraps them in
3183 * some overall structure, and then parses the result and adds it to the output.
3184 *
3185 * In the $wrap, $1 is replaced with the first message, $2 with the second, and so
3186 * on. The subsequent arguments may either be strings, in which case they are the
3187 * message names, or arrays, in which case the first element is the message name,
3188 * and subsequent elements are the parameters to that message.
3189 *
3190 * The special named parameter 'options' in a message specification array is passed
3191 * through to the $options parameter of wfMsgExt().
3192 *
3193 * Don't use this for messages that are not in users interface language.
3194 *
3195 * For example:
3196 *
3197 * $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>", 'some-error' );
3198 *
3199 * Is equivalent to:
3200 *
3201 * $wgOut->addWikiText( "<div class='error'>\n" . wfMsgNoTrans( 'some-error' ) . "\n</div>" );
3202 *
3203 * The newline after opening div is needed in some wikitext. See bug 19226.
3204 *
3205 * @param $wrap string
3206 */
3207 public function wrapWikiMsg( $wrap /*, ...*/ ) {
3208 $msgSpecs = func_get_args();
3209 array_shift( $msgSpecs );
3210 $msgSpecs = array_values( $msgSpecs );
3211 $s = $wrap;
3212 foreach ( $msgSpecs as $n => $spec ) {
3213 $options = array();
3214 if ( is_array( $spec ) ) {
3215 $args = $spec;
3216 $name = array_shift( $args );
3217 if ( isset( $args['options'] ) ) {
3218 $options = $args['options'];
3219 unset( $args['options'] );
3220 }
3221 } else {
3222 $args = array();
3223 $name = $spec;
3224 }
3225 $s = str_replace( '$' . ( $n + 1 ), wfMsgExt( $name, $options, $args ), $s );
3226 }
3227 $this->addWikiText( $s );
3228 }
3229
3230 /**
3231 * Include jQuery core. Use this to avoid loading it multiple times
3232 * before we get a usable script loader.
3233 *
3234 * @param $modules Array: list of jQuery modules which should be loaded
3235 * @return Array: the list of modules which were not loaded.
3236 * @since 1.16
3237 * @deprecated since 1.17
3238 */
3239 public function includeJQuery( $modules = array() ) {
3240 return array();
3241 }
3242
3243 }