c8c4ba466b56f70a4c0208135d8edcfbebf0443c
[lhc/web/wiklou.git] / includes / skins / Skin.php
1 <?php
2 /**
3 * Base class for all skins.
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
19 *
20 * @file
21 */
22
23 /**
24 * @defgroup Skins Skins
25 */
26
27 /**
28 * The main skin class which provides methods and properties for all other skins.
29 *
30 * See docs/skin.txt for more information.
31 *
32 * @ingroup Skins
33 */
34 abstract class Skin extends ContextSource {
35 protected $skinname = null;
36 protected $mRelevantTitle = null;
37 protected $mRelevantUser = null;
38
39 /**
40 * @var string Stylesheets set to use. Subdirectory in skins/ where various stylesheets are
41 * located. Only needs to be set if you intend to use the getSkinStylePath() method.
42 */
43 public $stylename = null;
44
45 /**
46 * Fetch the set of available skins.
47 * @return array Associative array of strings
48 */
49 static function getSkinNames() {
50 return SkinFactory::getDefaultInstance()->getSkinNames();
51 }
52
53 /**
54 * Fetch the skinname messages for available skins.
55 * @return string[]
56 */
57 static function getSkinNameMessages() {
58 $messages = array();
59 foreach ( self::getSkinNames() as $skinKey => $skinName ) {
60 $messages[] = "skinname-$skinKey";
61 }
62 return $messages;
63 }
64
65 /**
66 * Fetch the list of user-selectable skins in regards to $wgSkipSkins.
67 * Useful for Special:Preferences and other places where you
68 * only want to show skins users _can_ use.
69 * @return string[]
70 * @since 1.23
71 */
72 public static function getAllowedSkins() {
73 global $wgSkipSkins;
74
75 $allowedSkins = self::getSkinNames();
76
77 foreach ( $wgSkipSkins as $skip ) {
78 unset( $allowedSkins[$skip] );
79 }
80
81 return $allowedSkins;
82 }
83
84 /**
85 * @deprecated since 1.23, use getAllowedSkins
86 * @return string[]
87 */
88 public static function getUsableSkins() {
89 wfDeprecated( __METHOD__, '1.23' );
90 return self::getAllowedSkins();
91 }
92
93 /**
94 * Normalize a skin preference value to a form that can be loaded.
95 *
96 * If a skin can't be found, it will fall back to the configured default ($wgDefaultSkin), or the
97 * hardcoded default ($wgFallbackSkin) if the default skin is unavailable too.
98 *
99 * @param string $key 'monobook', 'vector', etc.
100 * @return string
101 */
102 static function normalizeKey( $key ) {
103 global $wgDefaultSkin, $wgFallbackSkin;
104
105 $skinNames = Skin::getSkinNames();
106
107 // Make keys lowercase for case-insensitive matching.
108 $skinNames = array_change_key_case( $skinNames, CASE_LOWER );
109 $key = strtolower( $key );
110 $defaultSkin = strtolower( $wgDefaultSkin );
111 $fallbackSkin = strtolower( $wgFallbackSkin );
112
113 if ( $key == '' || $key == 'default' ) {
114 // Don't return the default immediately;
115 // in a misconfiguration we need to fall back.
116 $key = $defaultSkin;
117 }
118
119 if ( isset( $skinNames[$key] ) ) {
120 return $key;
121 }
122
123 // Older versions of the software used a numeric setting
124 // in the user preferences.
125 $fallback = array(
126 0 => $defaultSkin,
127 2 => 'cologneblue'
128 );
129
130 if ( isset( $fallback[$key] ) ) {
131 $key = $fallback[$key];
132 }
133
134 if ( isset( $skinNames[$key] ) ) {
135 return $key;
136 } elseif ( isset( $skinNames[$defaultSkin] ) ) {
137 return $defaultSkin;
138 } else {
139 return $fallbackSkin;
140 }
141 }
142
143 /**
144 * Factory method for loading a skin of a given type
145 * @param string $key 'monobook', 'vector', etc.
146 * @return Skin
147 * @deprecated since 1.24; Use SkinFactory instead
148 */
149 static function &newFromKey( $key ) {
150 wfDeprecated( __METHOD__, '1.24' );
151
152 $key = Skin::normalizeKey( $key );
153 $factory = SkinFactory::getDefaultInstance();
154
155 // normalizeKey() guarantees that a skin with this key will exist.
156 $skin = $factory->makeSkin( $key );
157 return $skin;
158 }
159
160 /**
161 * @return string Skin name
162 */
163 public function getSkinName() {
164 return $this->skinname;
165 }
166
167 /**
168 * @param OutputPage $out
169 */
170 function initPage( OutputPage $out ) {
171 wfProfileIn( __METHOD__ );
172
173 $this->preloadExistence();
174
175 wfProfileOut( __METHOD__ );
176 }
177
178 /**
179 * Defines the ResourceLoader modules that should be added to the skin
180 * It is recommended that skins wishing to override call parent::getDefaultModules()
181 * and substitute out any modules they wish to change by using a key to look them up
182 * @return array Array of modules with helper keys for easy overriding
183 */
184 public function getDefaultModules() {
185 global $wgIncludeLegacyJavaScript, $wgPreloadJavaScriptMwUtil, $wgUseAjax,
186 $wgAjaxWatch, $wgEnableAPI, $wgEnableWriteAPI;
187
188 $out = $this->getOutput();
189 $user = $out->getUser();
190 $modules = array(
191 // modules that enhance the page content in some way
192 'content' => array(
193 'mediawiki.page.ready',
194 ),
195 // modules that exist for legacy reasons
196 'legacy' => array(),
197 // modules relating to search functionality
198 'search' => array(),
199 // modules relating to functionality relating to watching an article
200 'watch' => array(),
201 // modules which relate to the current users preferences
202 'user' => array(),
203 );
204 if ( $wgIncludeLegacyJavaScript ) {
205 $modules['legacy'][] = 'mediawiki.legacy.wikibits';
206 }
207
208 if ( $wgPreloadJavaScriptMwUtil ) {
209 $modules['legacy'][] = 'mediawiki.util';
210 }
211
212 // Add various resources if required
213 if ( $wgUseAjax ) {
214 $modules['legacy'][] = 'mediawiki.legacy.ajax';
215
216 if ( $wgEnableAPI ) {
217 if ( $wgEnableWriteAPI && $wgAjaxWatch && $user->isLoggedIn()
218 && $user->isAllowed( 'writeapi' )
219 ) {
220 $modules['watch'][] = 'mediawiki.page.watch.ajax';
221 }
222
223 $modules['search'][] = 'mediawiki.searchSuggest';
224 }
225 }
226
227 if ( $user->getBoolOption( 'editsectiononrightclick' ) ) {
228 $modules['user'][] = 'mediawiki.action.view.rightClickEdit';
229 }
230
231 // Crazy edit-on-double-click stuff
232 if ( $out->isArticle() && $user->getOption( 'editondblclick' ) ) {
233 $modules['user'][] = 'mediawiki.action.view.dblClickEdit';
234 }
235 return $modules;
236 }
237
238 /**
239 * Preload the existence of three commonly-requested pages in a single query
240 */
241 function preloadExistence() {
242 $titles = array();
243
244 $user = $this->getUser();
245 $title = $this->getRelevantTitle();
246
247 // User/talk link
248 if ( $user->isLoggedIn() || $this->showIPinHeader() ) {
249 $titles[] = $user->getUserPage();
250 $titles[] = $user->getTalkPage();
251 }
252
253 // Other tab link
254 if ( $title->isSpecialPage() ) {
255 // nothing
256 } elseif ( $title->isTalkPage() ) {
257 $titles[] = $title->getSubjectPage();
258 } else {
259 $titles[] = $title->getTalkPage();
260 }
261
262 wfRunHooks( 'SkinPreloadExistence', array( &$titles, $this ) );
263
264 if ( count( $titles ) ) {
265 $lb = new LinkBatch( $titles );
266 $lb->setCaller( __METHOD__ );
267 $lb->execute();
268 }
269 }
270
271 /**
272 * Get the current revision ID
273 *
274 * @return int
275 */
276 public function getRevisionId() {
277 return $this->getOutput()->getRevisionId();
278 }
279
280 /**
281 * Whether the revision displayed is the latest revision of the page
282 *
283 * @return bool
284 */
285 public function isRevisionCurrent() {
286 $revID = $this->getRevisionId();
287 return $revID == 0 || $revID == $this->getTitle()->getLatestRevID();
288 }
289
290 /**
291 * Set the "relevant" title
292 * @see self::getRelevantTitle()
293 * @param Title $t
294 */
295 public function setRelevantTitle( $t ) {
296 $this->mRelevantTitle = $t;
297 }
298
299 /**
300 * Return the "relevant" title.
301 * A "relevant" title is not necessarily the actual title of the page.
302 * Special pages like Special:MovePage use set the page they are acting on
303 * as their "relevant" title, this allows the skin system to display things
304 * such as content tabs which belong to to that page instead of displaying
305 * a basic special page tab which has almost no meaning.
306 *
307 * @return Title
308 */
309 public function getRelevantTitle() {
310 if ( isset( $this->mRelevantTitle ) ) {
311 return $this->mRelevantTitle;
312 }
313 return $this->getTitle();
314 }
315
316 /**
317 * Set the "relevant" user
318 * @see self::getRelevantUser()
319 * @param User $u
320 */
321 public function setRelevantUser( $u ) {
322 $this->mRelevantUser = $u;
323 }
324
325 /**
326 * Return the "relevant" user.
327 * A "relevant" user is similar to a relevant title. Special pages like
328 * Special:Contributions mark the user which they are relevant to so that
329 * things like the toolbox can display the information they usually are only
330 * able to display on a user's userpage and talkpage.
331 * @return User
332 */
333 public function getRelevantUser() {
334 if ( isset( $this->mRelevantUser ) ) {
335 return $this->mRelevantUser;
336 }
337 $title = $this->getRelevantTitle();
338 if ( $title->hasSubjectNamespace( NS_USER ) ) {
339 $rootUser = $title->getRootText();
340 if ( User::isIP( $rootUser ) ) {
341 $this->mRelevantUser = User::newFromName( $rootUser, false );
342 } else {
343 $user = User::newFromName( $rootUser, false );
344 if ( $user && $user->isLoggedIn() ) {
345 $this->mRelevantUser = $user;
346 }
347 }
348 return $this->mRelevantUser;
349 }
350 return null;
351 }
352
353 /**
354 * Outputs the HTML generated by other functions.
355 * @param OutputPage $out
356 */
357 abstract function outputPage( OutputPage $out = null );
358
359 /**
360 * @param array $data
361 * @return string
362 */
363 static function makeVariablesScript( $data ) {
364 if ( $data ) {
365 return Html::inlineScript(
366 ResourceLoader::makeLoaderConditionalScript( ResourceLoader::makeConfigSetScript( $data ) )
367 );
368 } else {
369 return '';
370 }
371 }
372
373 /**
374 * Get the query to generate a dynamic stylesheet
375 *
376 * @return array
377 */
378 public static function getDynamicStylesheetQuery() {
379 global $wgSquidMaxage;
380
381 return array(
382 'action' => 'raw',
383 'maxage' => $wgSquidMaxage,
384 'usemsgcache' => 'yes',
385 'ctype' => 'text/css',
386 'smaxage' => $wgSquidMaxage,
387 );
388 }
389
390 /**
391 * Add skin specific stylesheets
392 * Calling this method with an $out of anything but the same OutputPage
393 * inside ->getOutput() is deprecated. The $out arg is kept
394 * for compatibility purposes with skins.
395 * @param OutputPage $out
396 * @todo delete
397 */
398 abstract function setupSkinUserCss( OutputPage $out );
399
400 /**
401 * TODO: document
402 * @param Title $title
403 * @return string
404 */
405 function getPageClasses( $title ) {
406 $numeric = 'ns-' . $title->getNamespace();
407
408 if ( $title->isSpecialPage() ) {
409 $type = 'ns-special';
410 // bug 23315: provide a class based on the canonical special page name without subpages
411 list( $canonicalName ) = SpecialPageFactory::resolveAlias( $title->getDBkey() );
412 if ( $canonicalName ) {
413 $type .= ' ' . Sanitizer::escapeClass( "mw-special-$canonicalName" );
414 } else {
415 $type .= ' mw-invalidspecialpage';
416 }
417 } elseif ( $title->isTalkPage() ) {
418 $type = 'ns-talk';
419 } else {
420 $type = 'ns-subject';
421 }
422
423 $name = Sanitizer::escapeClass( 'page-' . $title->getPrefixedText() );
424
425 return "$numeric $type $name";
426 }
427
428 /**
429 * Return values for <html> element
430 * @return array Array of associative name-to-value elements for <html> element
431 */
432 public function getHtmlElementAttributes() {
433 $lang = $this->getLanguage();
434 return array(
435 'lang' => $lang->getHtmlCode(),
436 'dir' => $lang->getDir(),
437 'class' => 'client-nojs',
438 );
439 }
440
441 /**
442 * This will be called by OutputPage::headElement when it is creating the
443 * "<body>" tag, skins can override it if they have a need to add in any
444 * body attributes or classes of their own.
445 * @param OutputPage $out
446 * @param array $bodyAttrs
447 */
448 function addToBodyAttributes( $out, &$bodyAttrs ) {
449 // does nothing by default
450 }
451
452 /**
453 * URL to the logo
454 * @return string
455 */
456 function getLogo() {
457 global $wgLogo;
458 return $wgLogo;
459 }
460
461 /**
462 * @return string
463 */
464 function getCategoryLinks() {
465 global $wgUseCategoryBrowser;
466
467 $out = $this->getOutput();
468 $allCats = $out->getCategoryLinks();
469
470 if ( !count( $allCats ) ) {
471 return '';
472 }
473
474 $embed = "<li>";
475 $pop = "</li>";
476
477 $s = '';
478 $colon = $this->msg( 'colon-separator' )->escaped();
479
480 if ( !empty( $allCats['normal'] ) ) {
481 $t = $embed . implode( "{$pop}{$embed}", $allCats['normal'] ) . $pop;
482
483 $msg = $this->msg( 'pagecategories' )->numParams( count( $allCats['normal'] ) )->escaped();
484 $linkPage = wfMessage( 'pagecategorieslink' )->inContentLanguage()->text();
485 $s .= '<div id="mw-normal-catlinks" class="mw-normal-catlinks">' .
486 Linker::link( Title::newFromText( $linkPage ), $msg )
487 . $colon . '<ul>' . $t . '</ul>' . '</div>';
488 }
489
490 # Hidden categories
491 if ( isset( $allCats['hidden'] ) ) {
492 if ( $this->getUser()->getBoolOption( 'showhiddencats' ) ) {
493 $class = ' mw-hidden-cats-user-shown';
494 } elseif ( $this->getTitle()->getNamespace() == NS_CATEGORY ) {
495 $class = ' mw-hidden-cats-ns-shown';
496 } else {
497 $class = ' mw-hidden-cats-hidden';
498 }
499
500 $s .= "<div id=\"mw-hidden-catlinks\" class=\"mw-hidden-catlinks$class\">" .
501 $this->msg( 'hidden-categories' )->numParams( count( $allCats['hidden'] ) )->escaped() .
502 $colon . '<ul>' . $embed . implode( "{$pop}{$embed}", $allCats['hidden'] ) . $pop . '</ul>' .
503 '</div>';
504 }
505
506 # optional 'dmoz-like' category browser. Will be shown under the list
507 # of categories an article belong to
508 if ( $wgUseCategoryBrowser ) {
509 $s .= '<br /><hr />';
510
511 # get a big array of the parents tree
512 $parenttree = $this->getTitle()->getParentCategoryTree();
513 # Skin object passed by reference cause it can not be
514 # accessed under the method subfunction drawCategoryBrowser
515 $tempout = explode( "\n", $this->drawCategoryBrowser( $parenttree ) );
516 # Clean out bogus first entry and sort them
517 unset( $tempout[0] );
518 asort( $tempout );
519 # Output one per line
520 $s .= implode( "<br />\n", $tempout );
521 }
522
523 return $s;
524 }
525
526 /**
527 * Render the array as a series of links.
528 * @param array $tree Categories tree returned by Title::getParentCategoryTree
529 * @return string Separated by &gt;, terminate with "\n"
530 */
531 function drawCategoryBrowser( $tree ) {
532 $return = '';
533
534 foreach ( $tree as $element => $parent ) {
535 if ( empty( $parent ) ) {
536 # element start a new list
537 $return .= "\n";
538 } else {
539 # grab the others elements
540 $return .= $this->drawCategoryBrowser( $parent ) . ' &gt; ';
541 }
542
543 # add our current element to the list
544 $eltitle = Title::newFromText( $element );
545 $return .= Linker::link( $eltitle, htmlspecialchars( $eltitle->getText() ) );
546 }
547
548 return $return;
549 }
550
551 /**
552 * @return string
553 */
554 function getCategories() {
555 $out = $this->getOutput();
556
557 $catlinks = $this->getCategoryLinks();
558
559 $classes = 'catlinks';
560
561 // Check what we're showing
562 $allCats = $out->getCategoryLinks();
563 $showHidden = $this->getUser()->getBoolOption( 'showhiddencats' ) ||
564 $this->getTitle()->getNamespace() == NS_CATEGORY;
565
566 if ( empty( $allCats['normal'] ) && !( !empty( $allCats['hidden'] ) && $showHidden ) ) {
567 $classes .= ' catlinks-allhidden';
568 }
569
570 return "<div id='catlinks' class='$classes'>{$catlinks}</div>";
571 }
572
573 /**
574 * This runs a hook to allow extensions placing their stuff after content
575 * and article metadata (e.g. categories).
576 * Note: This function has nothing to do with afterContent().
577 *
578 * This hook is placed here in order to allow using the same hook for all
579 * skins, both the SkinTemplate based ones and the older ones, which directly
580 * use this class to get their data.
581 *
582 * The output of this function gets processed in SkinTemplate::outputPage() for
583 * the SkinTemplate based skins, all other skins should directly echo it.
584 *
585 * @return string Empty by default, if not changed by any hook function.
586 */
587 protected function afterContentHook() {
588 $data = '';
589
590 if ( wfRunHooks( 'SkinAfterContent', array( &$data, $this ) ) ) {
591 // adding just some spaces shouldn't toggle the output
592 // of the whole <div/>, so we use trim() here
593 if ( trim( $data ) != '' ) {
594 // Doing this here instead of in the skins to
595 // ensure that the div has the same ID in all
596 // skins
597 $data = "<div id='mw-data-after-content'>\n" .
598 "\t$data\n" .
599 "</div>\n";
600 }
601 } else {
602 wfDebug( "Hook SkinAfterContent changed output processing.\n" );
603 }
604
605 return $data;
606 }
607
608 /**
609 * Generate debug data HTML for displaying at the bottom of the main content
610 * area.
611 * @return string HTML containing debug data, if enabled (otherwise empty).
612 */
613 protected function generateDebugHTML() {
614 return MWDebug::getHTMLDebugLog();
615 }
616
617 /**
618 * This gets called shortly before the "</body>" tag.
619 *
620 * @return string HTML-wrapped JS code to be put before "</body>"
621 */
622 function bottomScripts() {
623 // TODO and the suckage continues. This function is really just a wrapper around
624 // OutputPage::getBottomScripts() which takes a Skin param. This should be cleaned
625 // up at some point
626 $bottomScriptText = $this->getOutput()->getBottomScripts();
627 wfRunHooks( 'SkinAfterBottomScripts', array( $this, &$bottomScriptText ) );
628
629 return $bottomScriptText;
630 }
631
632 /**
633 * Text with the permalink to the source page,
634 * usually shown on the footer of a printed page
635 *
636 * @return string HTML text with an URL
637 */
638 function printSource() {
639 $oldid = $this->getRevisionId();
640 if ( $oldid ) {
641 $canonicalUrl = $this->getTitle()->getCanonicalURL( 'oldid=' . $oldid );
642 $url = htmlspecialchars( wfExpandIRI( $canonicalUrl ) );
643 } else {
644 // oldid not available for non existing pages
645 $url = htmlspecialchars( wfExpandIRI( $this->getTitle()->getCanonicalURL() ) );
646 }
647
648 return $this->msg( 'retrievedfrom', '<a dir="ltr" href="' . $url
649 . '">' . $url . '</a>' )->text();
650 }
651
652 /**
653 * @return string
654 */
655 function getUndeleteLink() {
656 $action = $this->getRequest()->getVal( 'action', 'view' );
657
658 if ( $this->getUser()->isAllowed( 'deletedhistory' ) &&
659 ( $this->getTitle()->getArticleID() == 0 || $action == 'history' ) ) {
660 $n = $this->getTitle()->isDeleted();
661
662 if ( $n ) {
663 if ( $this->getUser()->isAllowed( 'undelete' ) ) {
664 $msg = 'thisisdeleted';
665 } else {
666 $msg = 'viewdeleted';
667 }
668
669 return $this->msg( $msg )->rawParams(
670 Linker::linkKnown(
671 SpecialPage::getTitleFor( 'Undelete', $this->getTitle()->getPrefixedDBkey() ),
672 $this->msg( 'restorelink' )->numParams( $n )->escaped() )
673 )->text();
674 }
675 }
676
677 return '';
678 }
679
680 /**
681 * @return string
682 */
683 function subPageSubtitle() {
684 $out = $this->getOutput();
685 $subpages = '';
686
687 if ( !wfRunHooks( 'SkinSubPageSubtitle', array( &$subpages, $this, $out ) ) ) {
688 return $subpages;
689 }
690
691 if ( $out->isArticle() && MWNamespace::hasSubpages( $out->getTitle()->getNamespace() ) ) {
692 $ptext = $this->getTitle()->getPrefixedText();
693 if ( preg_match( '/\//', $ptext ) ) {
694 $links = explode( '/', $ptext );
695 array_pop( $links );
696 $c = 0;
697 $growinglink = '';
698 $display = '';
699 $lang = $this->getLanguage();
700
701 foreach ( $links as $link ) {
702 $growinglink .= $link;
703 $display .= $link;
704 $linkObj = Title::newFromText( $growinglink );
705
706 if ( is_object( $linkObj ) && $linkObj->isKnown() ) {
707 $getlink = Linker::linkKnown(
708 $linkObj,
709 htmlspecialchars( $display )
710 );
711
712 $c++;
713
714 if ( $c > 1 ) {
715 $subpages .= $lang->getDirMarkEntity() . $this->msg( 'pipe-separator' )->escaped();
716 } else {
717 $subpages .= '&lt; ';
718 }
719
720 $subpages .= $getlink;
721 $display = '';
722 } else {
723 $display .= '/';
724 }
725 $growinglink .= '/';
726 }
727 }
728 }
729
730 return $subpages;
731 }
732
733 /**
734 * Returns true if the IP should be shown in the header
735 * @return bool
736 */
737 function showIPinHeader() {
738 global $wgShowIPinHeader;
739 return $wgShowIPinHeader && session_id() != '';
740 }
741
742 /**
743 * @return string
744 */
745 function getSearchLink() {
746 $searchPage = SpecialPage::getTitleFor( 'Search' );
747 return $searchPage->getLocalURL();
748 }
749
750 /**
751 * @return string
752 */
753 function escapeSearchLink() {
754 return htmlspecialchars( $this->getSearchLink() );
755 }
756
757 /**
758 * @param string $type
759 * @return string
760 */
761 function getCopyright( $type = 'detect' ) {
762 global $wgRightsPage, $wgRightsUrl, $wgRightsText;
763
764 if ( $type == 'detect' ) {
765 if ( !$this->isRevisionCurrent()
766 && !$this->msg( 'history_copyright' )->inContentLanguage()->isDisabled()
767 ) {
768 $type = 'history';
769 } else {
770 $type = 'normal';
771 }
772 }
773
774 if ( $type == 'history' ) {
775 $msg = 'history_copyright';
776 } else {
777 $msg = 'copyright';
778 }
779
780 if ( $wgRightsPage ) {
781 $title = Title::newFromText( $wgRightsPage );
782 $link = Linker::linkKnown( $title, $wgRightsText );
783 } elseif ( $wgRightsUrl ) {
784 $link = Linker::makeExternalLink( $wgRightsUrl, $wgRightsText );
785 } elseif ( $wgRightsText ) {
786 $link = $wgRightsText;
787 } else {
788 # Give up now
789 return '';
790 }
791
792 // Allow for site and per-namespace customization of copyright notice.
793 // @todo Remove deprecated $forContent param from hook handlers and then remove here.
794 $forContent = true;
795
796 wfRunHooks(
797 'SkinCopyrightFooter',
798 array( $this->getTitle(), $type, &$msg, &$link, &$forContent )
799 );
800
801 return $this->msg( $msg )->rawParams( $link )->text();
802 }
803
804 /**
805 * @return null|string
806 */
807 function getCopyrightIcon() {
808 global $wgRightsUrl, $wgRightsText, $wgRightsIcon, $wgCopyrightIcon;
809
810 $out = '';
811
812 if ( $wgCopyrightIcon ) {
813 $out = $wgCopyrightIcon;
814 } elseif ( $wgRightsIcon ) {
815 $icon = htmlspecialchars( $wgRightsIcon );
816
817 if ( $wgRightsUrl ) {
818 $url = htmlspecialchars( $wgRightsUrl );
819 $out .= '<a href="' . $url . '">';
820 }
821
822 $text = htmlspecialchars( $wgRightsText );
823 $out .= "<img src=\"$icon\" alt=\"$text\" width=\"88\" height=\"31\" />";
824
825 if ( $wgRightsUrl ) {
826 $out .= '</a>';
827 }
828 }
829
830 return $out;
831 }
832
833 /**
834 * Gets the powered by MediaWiki icon.
835 * @return string
836 */
837 function getPoweredBy() {
838 global $wgResourceBasePath;
839
840 $url = htmlspecialchars( "$wgResourceBasePath/resources/assets/poweredby_mediawiki_88x31.png" );
841 $text = '<a href="//www.mediawiki.org/"><img src="' . $url
842 . '" height="31" width="88" alt="Powered by MediaWiki" /></a>';
843 wfRunHooks( 'SkinGetPoweredBy', array( &$text, $this ) );
844 return $text;
845 }
846
847 /**
848 * Get the timestamp of the latest revision, formatted in user language
849 *
850 * @return string
851 */
852 protected function lastModified() {
853 $timestamp = $this->getOutput()->getRevisionTimestamp();
854
855 # No cached timestamp, load it from the database
856 if ( $timestamp === null ) {
857 $timestamp = Revision::getTimestampFromId( $this->getTitle(), $this->getRevisionId() );
858 }
859
860 if ( $timestamp ) {
861 $d = $this->getLanguage()->userDate( $timestamp, $this->getUser() );
862 $t = $this->getLanguage()->userTime( $timestamp, $this->getUser() );
863 $s = ' ' . $this->msg( 'lastmodifiedat', $d, $t )->text();
864 } else {
865 $s = '';
866 }
867
868 if ( wfGetLB()->getLaggedSlaveMode() ) {
869 $s .= ' <strong>' . $this->msg( 'laggedslavemode' )->text() . '</strong>';
870 }
871
872 return $s;
873 }
874
875 /**
876 * @param string $align
877 * @return string
878 */
879 function logoText( $align = '' ) {
880 if ( $align != '' ) {
881 $a = " style='float: {$align};'";
882 } else {
883 $a = '';
884 }
885
886 $mp = $this->msg( 'mainpage' )->escaped();
887 $mptitle = Title::newMainPage();
888 $url = ( is_object( $mptitle ) ? htmlspecialchars( $mptitle->getLocalURL() ) : '' );
889
890 $logourl = $this->getLogo();
891 $s = "<a href='{$url}'><img{$a} src='{$logourl}' alt='[{$mp}]' /></a>";
892
893 return $s;
894 }
895
896 /**
897 * Renders a $wgFooterIcons icon according to the method's arguments
898 * @param array $icon The icon to build the html for, see $wgFooterIcons
899 * for the format of this array.
900 * @param bool|string $withImage Whether to use the icon's image or output
901 * a text-only footericon.
902 * @return string HTML
903 */
904 function makeFooterIcon( $icon, $withImage = 'withImage' ) {
905 if ( is_string( $icon ) ) {
906 $html = $icon;
907 } else { // Assuming array
908 $url = isset( $icon["url"] ) ? $icon["url"] : null;
909 unset( $icon["url"] );
910 if ( isset( $icon["src"] ) && $withImage === 'withImage' ) {
911 // do this the lazy way, just pass icon data as an attribute array
912 $html = Html::element( 'img', $icon );
913 } else {
914 $html = htmlspecialchars( $icon["alt"] );
915 }
916 if ( $url ) {
917 $html = Html::rawElement( 'a', array( "href" => $url ), $html );
918 }
919 }
920 return $html;
921 }
922
923 /**
924 * Gets the link to the wiki's main page.
925 * @return string
926 */
927 function mainPageLink() {
928 $s = Linker::linkKnown(
929 Title::newMainPage(),
930 $this->msg( 'mainpage' )->escaped()
931 );
932
933 return $s;
934 }
935
936 /**
937 * Returns an HTML link for use in the footer
938 * @param string $desc The i18n message key for the link text
939 * @param string $page The i18n message key for the page to link to
940 * @return string HTML anchor
941 */
942 public function footerLink( $desc, $page ) {
943 $section = new ProfileSection( __METHOD__ );
944 // if the link description has been set to "-" in the default language,
945 if ( $this->msg( $desc )->inContentLanguage()->isDisabled() ) {
946 // then it is disabled, for all languages.
947 return '';
948 } else {
949 // Otherwise, we display the link for the user, described in their
950 // language (which may or may not be the same as the default language),
951 // but we make the link target be the one site-wide page.
952 $title = Title::newFromText( $this->msg( $page )->inContentLanguage()->text() );
953
954 return Linker::linkKnown(
955 $title,
956 $this->msg( $desc )->escaped()
957 );
958 }
959 }
960
961 /**
962 * Gets the link to the wiki's privacy policy page.
963 * @return string HTML
964 */
965 function privacyLink() {
966 return $this->footerLink( 'privacy', 'privacypage' );
967 }
968
969 /**
970 * Gets the link to the wiki's about page.
971 * @return string HTML
972 */
973 function aboutLink() {
974 return $this->footerLink( 'aboutsite', 'aboutpage' );
975 }
976
977 /**
978 * Gets the link to the wiki's general disclaimers page.
979 * @return string HTML
980 */
981 function disclaimerLink() {
982 return $this->footerLink( 'disclaimers', 'disclaimerpage' );
983 }
984
985 /**
986 * Return URL options for the 'edit page' link.
987 * This may include an 'oldid' specifier, if the current page view is such.
988 *
989 * @return array
990 * @private
991 */
992 function editUrlOptions() {
993 $options = array( 'action' => 'edit' );
994
995 if ( !$this->isRevisionCurrent() ) {
996 $options['oldid'] = intval( $this->getRevisionId() );
997 }
998
999 return $options;
1000 }
1001
1002 /**
1003 * @param User|int $id
1004 * @return bool
1005 */
1006 function showEmailUser( $id ) {
1007 if ( $id instanceof User ) {
1008 $targetUser = $id;
1009 } else {
1010 $targetUser = User::newFromId( $id );
1011 }
1012
1013 # The sending user must have a confirmed email address and the target
1014 # user must have a confirmed email address and allow emails from users.
1015 return $this->getUser()->canSendEmail() &&
1016 $targetUser->canReceiveEmail();
1017 }
1018
1019 /**
1020 * This function previously returned a fully resolved style path URL to images or styles stored in
1021 * the legacy skins/common/ directory.
1022 *
1023 * That directory has been removed in 1.24 and the function always returns an empty string.
1024 *
1025 * @deprecated since 1.24
1026 * @param string $name The name or path of a skin resource file
1027 * @return string Empty string
1028 */
1029 function getCommonStylePath( $name ) {
1030 wfDeprecated( __METHOD__, '1.24' );
1031 return '';
1032 }
1033
1034 /**
1035 * Return a fully resolved style path url to images or styles stored in the current skins's folder.
1036 * This method returns a url resolved using the configured skin style path
1037 * and includes the style version inside of the url.
1038 *
1039 * Requires $stylename to be set, otherwise throws MWException.
1040 *
1041 * @param string $name The name or path of a skin resource file
1042 * @return string The fully resolved style path url including styleversion
1043 */
1044 function getSkinStylePath( $name ) {
1045 global $wgStylePath, $wgStyleVersion;
1046
1047 if ( $this->stylename === null ) {
1048 $class = get_class( $this );
1049 throw new MWException( "$class::\$stylename must be set to use getSkinStylePath()" );
1050 }
1051
1052 return "$wgStylePath/{$this->stylename}/$name?$wgStyleVersion";
1053 }
1054
1055 /* these are used extensively in SkinTemplate, but also some other places */
1056
1057 /**
1058 * @param string $urlaction
1059 * @return string
1060 */
1061 static function makeMainPageUrl( $urlaction = '' ) {
1062 $title = Title::newMainPage();
1063 self::checkTitle( $title, '' );
1064
1065 return $title->getLocalURL( $urlaction );
1066 }
1067
1068 /**
1069 * Make a URL for a Special Page using the given query and protocol.
1070 *
1071 * If $proto is set to null, make a local URL. Otherwise, make a full
1072 * URL with the protocol specified.
1073 *
1074 * @param string $name Name of the Special page
1075 * @param string $urlaction Query to append
1076 * @param string|null $proto Protocol to use or null for a local URL
1077 * @return string
1078 */
1079 static function makeSpecialUrl( $name, $urlaction = '', $proto = null ) {
1080 $title = SpecialPage::getSafeTitleFor( $name );
1081 if ( is_null( $proto ) ) {
1082 return $title->getLocalURL( $urlaction );
1083 } else {
1084 return $title->getFullURL( $urlaction, false, $proto );
1085 }
1086 }
1087
1088 /**
1089 * @param string $name
1090 * @param string $subpage
1091 * @param string $urlaction
1092 * @return string
1093 */
1094 static function makeSpecialUrlSubpage( $name, $subpage, $urlaction = '' ) {
1095 $title = SpecialPage::getSafeTitleFor( $name, $subpage );
1096 return $title->getLocalURL( $urlaction );
1097 }
1098
1099 /**
1100 * @param string $name
1101 * @param string $urlaction
1102 * @return string
1103 */
1104 static function makeI18nUrl( $name, $urlaction = '' ) {
1105 $title = Title::newFromText( wfMessage( $name )->inContentLanguage()->text() );
1106 self::checkTitle( $title, $name );
1107 return $title->getLocalURL( $urlaction );
1108 }
1109
1110 /**
1111 * @param string $name
1112 * @param string $urlaction
1113 * @return string
1114 */
1115 static function makeUrl( $name, $urlaction = '' ) {
1116 $title = Title::newFromText( $name );
1117 self::checkTitle( $title, $name );
1118
1119 return $title->getLocalURL( $urlaction );
1120 }
1121
1122 /**
1123 * If url string starts with http, consider as external URL, else
1124 * internal
1125 * @param string $name
1126 * @return string URL
1127 */
1128 static function makeInternalOrExternalUrl( $name ) {
1129 if ( preg_match( '/^(?i:' . wfUrlProtocols() . ')/', $name ) ) {
1130 return $name;
1131 } else {
1132 return self::makeUrl( $name );
1133 }
1134 }
1135
1136 /**
1137 * this can be passed the NS number as defined in Language.php
1138 * @param string $name
1139 * @param string $urlaction
1140 * @param int $namespace
1141 * @return string
1142 */
1143 static function makeNSUrl( $name, $urlaction = '', $namespace = NS_MAIN ) {
1144 $title = Title::makeTitleSafe( $namespace, $name );
1145 self::checkTitle( $title, $name );
1146
1147 return $title->getLocalURL( $urlaction );
1148 }
1149
1150 /**
1151 * these return an array with the 'href' and boolean 'exists'
1152 * @param string $name
1153 * @param string $urlaction
1154 * @return array
1155 */
1156 static function makeUrlDetails( $name, $urlaction = '' ) {
1157 $title = Title::newFromText( $name );
1158 self::checkTitle( $title, $name );
1159
1160 return array(
1161 'href' => $title->getLocalURL( $urlaction ),
1162 'exists' => $title->getArticleID() != 0,
1163 );
1164 }
1165
1166 /**
1167 * Make URL details where the article exists (or at least it's convenient to think so)
1168 * @param string $name Article name
1169 * @param string $urlaction
1170 * @return array
1171 */
1172 static function makeKnownUrlDetails( $name, $urlaction = '' ) {
1173 $title = Title::newFromText( $name );
1174 self::checkTitle( $title, $name );
1175
1176 return array(
1177 'href' => $title->getLocalURL( $urlaction ),
1178 'exists' => true
1179 );
1180 }
1181
1182 /**
1183 * make sure we have some title to operate on
1184 *
1185 * @param Title $title
1186 * @param string $name
1187 */
1188 static function checkTitle( &$title, $name ) {
1189 if ( !is_object( $title ) ) {
1190 $title = Title::newFromText( $name );
1191 if ( !is_object( $title ) ) {
1192 $title = Title::newFromText( '--error: link target missing--' );
1193 }
1194 }
1195 }
1196
1197 /**
1198 * Build an array that represents the sidebar(s), the navigation bar among them.
1199 *
1200 * BaseTemplate::getSidebar can be used to simplify the format and id generation in new skins.
1201 *
1202 * The format of the returned array is array( heading => content, ... ), where:
1203 * - heading is the heading of a navigation portlet. It is either:
1204 * - magic string to be handled by the skins ('SEARCH' / 'LANGUAGES' / 'TOOLBOX' / ...)
1205 * - a message name (e.g. 'navigation'), the message should be HTML-escaped by the skin
1206 * - plain text, which should be HTML-escaped by the skin
1207 * - content is the contents of the portlet. It is either:
1208 * - HTML text (<ul><li>...</li>...</ul>)
1209 * - array of link data in a format accepted by BaseTemplate::makeListItem()
1210 * - (for a magic string as a key, any value)
1211 *
1212 * Note that extensions can control the sidebar contents using the SkinBuildSidebar hook
1213 * and can technically insert anything in here; skin creators are expected to handle
1214 * values described above.
1215 *
1216 * @return array
1217 */
1218 function buildSidebar() {
1219 global $wgMemc, $wgEnableSidebarCache, $wgSidebarCacheExpiry;
1220 wfProfileIn( __METHOD__ );
1221
1222 $key = wfMemcKey( 'sidebar', $this->getLanguage()->getCode() );
1223
1224 if ( $wgEnableSidebarCache ) {
1225 $cachedsidebar = $wgMemc->get( $key );
1226 if ( $cachedsidebar ) {
1227 wfRunHooks( 'SidebarBeforeOutput', array( $this, &$cachedsidebar ) );
1228
1229 wfProfileOut( __METHOD__ );
1230 return $cachedsidebar;
1231 }
1232 }
1233
1234 $bar = array();
1235 $this->addToSidebar( $bar, 'sidebar' );
1236
1237 wfRunHooks( 'SkinBuildSidebar', array( $this, &$bar ) );
1238 if ( $wgEnableSidebarCache ) {
1239 $wgMemc->set( $key, $bar, $wgSidebarCacheExpiry );
1240 }
1241
1242 wfRunHooks( 'SidebarBeforeOutput', array( $this, &$bar ) );
1243
1244 wfProfileOut( __METHOD__ );
1245 return $bar;
1246 }
1247
1248 /**
1249 * Add content from a sidebar system message
1250 * Currently only used for MediaWiki:Sidebar (but may be used by Extensions)
1251 *
1252 * This is just a wrapper around addToSidebarPlain() for backwards compatibility
1253 *
1254 * @param array $bar
1255 * @param string $message
1256 */
1257 function addToSidebar( &$bar, $message ) {
1258 $this->addToSidebarPlain( $bar, wfMessage( $message )->inContentLanguage()->plain() );
1259 }
1260
1261 /**
1262 * Add content from plain text
1263 * @since 1.17
1264 * @param array $bar
1265 * @param string $text
1266 * @return array
1267 */
1268 function addToSidebarPlain( &$bar, $text ) {
1269 $lines = explode( "\n", $text );
1270
1271 $heading = '';
1272
1273 foreach ( $lines as $line ) {
1274 if ( strpos( $line, '*' ) !== 0 ) {
1275 continue;
1276 }
1277 $line = rtrim( $line, "\r" ); // for Windows compat
1278
1279 if ( strpos( $line, '**' ) !== 0 ) {
1280 $heading = trim( $line, '* ' );
1281 if ( !array_key_exists( $heading, $bar ) ) {
1282 $bar[$heading] = array();
1283 }
1284 } else {
1285 $line = trim( $line, '* ' );
1286
1287 if ( strpos( $line, '|' ) !== false ) { // sanity check
1288 $line = MessageCache::singleton()->transform( $line, false, null, $this->getTitle() );
1289 $line = array_map( 'trim', explode( '|', $line, 2 ) );
1290 if ( count( $line ) !== 2 ) {
1291 // Second sanity check, could be hit by people doing
1292 // funky stuff with parserfuncs... (bug 33321)
1293 continue;
1294 }
1295
1296 $extraAttribs = array();
1297
1298 $msgLink = $this->msg( $line[0] )->inContentLanguage();
1299 if ( $msgLink->exists() ) {
1300 $link = $msgLink->text();
1301 if ( $link == '-' ) {
1302 continue;
1303 }
1304 } else {
1305 $link = $line[0];
1306 }
1307 $msgText = $this->msg( $line[1] );
1308 if ( $msgText->exists() ) {
1309 $text = $msgText->text();
1310 } else {
1311 $text = $line[1];
1312 }
1313
1314 if ( preg_match( '/^(?i:' . wfUrlProtocols() . ')/', $link ) ) {
1315 $href = $link;
1316
1317 // Parser::getExternalLinkAttribs won't work here because of the Namespace things
1318 global $wgNoFollowLinks, $wgNoFollowDomainExceptions;
1319 if ( $wgNoFollowLinks && !wfMatchesDomainList( $href, $wgNoFollowDomainExceptions ) ) {
1320 $extraAttribs['rel'] = 'nofollow';
1321 }
1322
1323 global $wgExternalLinkTarget;
1324 if ( $wgExternalLinkTarget ) {
1325 $extraAttribs['target'] = $wgExternalLinkTarget;
1326 }
1327 } else {
1328 $title = Title::newFromText( $link );
1329
1330 if ( $title ) {
1331 $title = $title->fixSpecialName();
1332 $href = $title->getLinkURL();
1333 } else {
1334 $href = 'INVALID-TITLE';
1335 }
1336 }
1337
1338 $bar[$heading][] = array_merge( array(
1339 'text' => $text,
1340 'href' => $href,
1341 'id' => 'n-' . Sanitizer::escapeId( strtr( $line[1], ' ', '-' ), 'noninitial' ),
1342 'active' => false
1343 ), $extraAttribs );
1344 } else {
1345 continue;
1346 }
1347 }
1348 }
1349
1350 return $bar;
1351 }
1352
1353 /**
1354 * This function previously controlled whether the 'mediawiki.legacy.wikiprintable' module
1355 * should be loaded by OutputPage. That module no longer exists and the return value of this
1356 * method is ignored.
1357 *
1358 * If your skin doesn't provide its own print styles, the 'mediawiki.legacy.commonPrint' module
1359 * can be used instead (SkinTemplate-based skins do it automatically).
1360 *
1361 * @deprecated since 1.22
1362 * @return bool
1363 */
1364 public function commonPrintStylesheet() {
1365 wfDeprecated( __METHOD__, '1.22' );
1366 return false;
1367 }
1368
1369 /**
1370 * Gets new talk page messages for the current user and returns an
1371 * appropriate alert message (or an empty string if there are no messages)
1372 * @return string
1373 */
1374 function getNewtalks() {
1375
1376 $newMessagesAlert = '';
1377 $user = $this->getUser();
1378 $newtalks = $user->getNewMessageLinks();
1379 $out = $this->getOutput();
1380
1381 // Allow extensions to disable or modify the new messages alert
1382 if ( !wfRunHooks( 'GetNewMessagesAlert', array( &$newMessagesAlert, $newtalks, $user, $out ) ) ) {
1383 return '';
1384 }
1385 if ( $newMessagesAlert ) {
1386 return $newMessagesAlert;
1387 }
1388
1389 if ( count( $newtalks ) == 1 && $newtalks[0]['wiki'] === wfWikiID() ) {
1390 $uTalkTitle = $user->getTalkPage();
1391 $lastSeenRev = isset( $newtalks[0]['rev'] ) ? $newtalks[0]['rev'] : null;
1392 $nofAuthors = 0;
1393 if ( $lastSeenRev !== null ) {
1394 $plural = true; // Default if we have a last seen revision: if unknown, use plural
1395 $latestRev = Revision::newFromTitle( $uTalkTitle, false, Revision::READ_NORMAL );
1396 if ( $latestRev !== null ) {
1397 // Singular if only 1 unseen revision, plural if several unseen revisions.
1398 $plural = $latestRev->getParentId() !== $lastSeenRev->getId();
1399 $nofAuthors = $uTalkTitle->countAuthorsBetween(
1400 $lastSeenRev, $latestRev, 10, 'include_new' );
1401 }
1402 } else {
1403 // Singular if no revision -> diff link will show latest change only in any case
1404 $plural = false;
1405 }
1406 $plural = $plural ? 999 : 1;
1407 // 999 signifies "more than one revision". We don't know how many, and even if we did,
1408 // the number of revisions or authors is not necessarily the same as the number of
1409 // "messages".
1410 $newMessagesLink = Linker::linkKnown(
1411 $uTalkTitle,
1412 $this->msg( 'newmessageslinkplural' )->params( $plural )->escaped(),
1413 array(),
1414 array( 'redirect' => 'no' )
1415 );
1416
1417 $newMessagesDiffLink = Linker::linkKnown(
1418 $uTalkTitle,
1419 $this->msg( 'newmessagesdifflinkplural' )->params( $plural )->escaped(),
1420 array(),
1421 $lastSeenRev !== null
1422 ? array( 'oldid' => $lastSeenRev->getId(), 'diff' => 'cur' )
1423 : array( 'diff' => 'cur' )
1424 );
1425
1426 if ( $nofAuthors >= 1 && $nofAuthors <= 10 ) {
1427 $newMessagesAlert = $this->msg(
1428 'youhavenewmessagesfromusers',
1429 $newMessagesLink,
1430 $newMessagesDiffLink
1431 )->numParams( $nofAuthors, $plural );
1432 } else {
1433 // $nofAuthors === 11 signifies "11 or more" ("more than 10")
1434 $newMessagesAlert = $this->msg(
1435 $nofAuthors > 10 ? 'youhavenewmessagesmanyusers' : 'youhavenewmessages',
1436 $newMessagesLink,
1437 $newMessagesDiffLink
1438 )->numParams( $plural );
1439 }
1440 $newMessagesAlert = $newMessagesAlert->text();
1441 # Disable Squid cache
1442 $out->setSquidMaxage( 0 );
1443 } elseif ( count( $newtalks ) ) {
1444 $sep = $this->msg( 'newtalkseparator' )->escaped();
1445 $msgs = array();
1446
1447 foreach ( $newtalks as $newtalk ) {
1448 $msgs[] = Xml::element(
1449 'a',
1450 array( 'href' => $newtalk['link'] ), $newtalk['wiki']
1451 );
1452 }
1453 $parts = implode( $sep, $msgs );
1454 $newMessagesAlert = $this->msg( 'youhavenewmessagesmulti' )->rawParams( $parts )->escaped();
1455 $out->setSquidMaxage( 0 );
1456 }
1457
1458 return $newMessagesAlert;
1459 }
1460
1461 /**
1462 * Get a cached notice
1463 *
1464 * @param string $name Message name, or 'default' for $wgSiteNotice
1465 * @return string HTML fragment
1466 */
1467 private function getCachedNotice( $name ) {
1468 global $wgRenderHashAppend, $parserMemc, $wgContLang;
1469
1470 wfProfileIn( __METHOD__ );
1471
1472 $needParse = false;
1473
1474 if ( $name === 'default' ) {
1475 // special case
1476 global $wgSiteNotice;
1477 $notice = $wgSiteNotice;
1478 if ( empty( $notice ) ) {
1479 wfProfileOut( __METHOD__ );
1480 return false;
1481 }
1482 } else {
1483 $msg = $this->msg( $name )->inContentLanguage();
1484 if ( $msg->isDisabled() ) {
1485 wfProfileOut( __METHOD__ );
1486 return false;
1487 }
1488 $notice = $msg->plain();
1489 }
1490
1491 // Use the extra hash appender to let eg SSL variants separately cache.
1492 $key = wfMemcKey( $name . $wgRenderHashAppend );
1493 $cachedNotice = $parserMemc->get( $key );
1494 if ( is_array( $cachedNotice ) ) {
1495 if ( md5( $notice ) == $cachedNotice['hash'] ) {
1496 $notice = $cachedNotice['html'];
1497 } else {
1498 $needParse = true;
1499 }
1500 } else {
1501 $needParse = true;
1502 }
1503
1504 if ( $needParse ) {
1505 $parsed = $this->getOutput()->parse( $notice );
1506 $parserMemc->set( $key, array( 'html' => $parsed, 'hash' => md5( $notice ) ), 600 );
1507 $notice = $parsed;
1508 }
1509
1510 $notice = Html::rawElement( 'div', array( 'id' => 'localNotice',
1511 'lang' => $wgContLang->getHtmlCode(), 'dir' => $wgContLang->getDir() ), $notice );
1512 wfProfileOut( __METHOD__ );
1513 return $notice;
1514 }
1515
1516 /**
1517 * Get a notice based on page's namespace
1518 *
1519 * @return string HTML fragment
1520 */
1521 function getNamespaceNotice() {
1522 wfProfileIn( __METHOD__ );
1523
1524 $key = 'namespacenotice-' . $this->getTitle()->getNsText();
1525 $namespaceNotice = $this->getCachedNotice( $key );
1526 if ( $namespaceNotice && substr( $namespaceNotice, 0, 7 ) != '<p>&lt;' ) {
1527 $namespaceNotice = '<div id="namespacebanner">' . $namespaceNotice . '</div>';
1528 } else {
1529 $namespaceNotice = '';
1530 }
1531
1532 wfProfileOut( __METHOD__ );
1533 return $namespaceNotice;
1534 }
1535
1536 /**
1537 * Get the site notice
1538 *
1539 * @return string HTML fragment
1540 */
1541 function getSiteNotice() {
1542 wfProfileIn( __METHOD__ );
1543 $siteNotice = '';
1544
1545 if ( wfRunHooks( 'SiteNoticeBefore', array( &$siteNotice, $this ) ) ) {
1546 if ( is_object( $this->getUser() ) && $this->getUser()->isLoggedIn() ) {
1547 $siteNotice = $this->getCachedNotice( 'sitenotice' );
1548 } else {
1549 $anonNotice = $this->getCachedNotice( 'anonnotice' );
1550 if ( !$anonNotice ) {
1551 $siteNotice = $this->getCachedNotice( 'sitenotice' );
1552 } else {
1553 $siteNotice = $anonNotice;
1554 }
1555 }
1556 if ( !$siteNotice ) {
1557 $siteNotice = $this->getCachedNotice( 'default' );
1558 }
1559 }
1560
1561 wfRunHooks( 'SiteNoticeAfter', array( &$siteNotice, $this ) );
1562 wfProfileOut( __METHOD__ );
1563 return $siteNotice;
1564 }
1565
1566 /**
1567 * Create a section edit link. This supersedes editSectionLink() and
1568 * editSectionLinkForOther().
1569 *
1570 * @param Title $nt The title being linked to (may not be the same as
1571 * the current page, if the section is included from a template)
1572 * @param string $section The designation of the section being pointed to,
1573 * to be included in the link, like "&section=$section"
1574 * @param string $tooltip The tooltip to use for the link: will be escaped
1575 * and wrapped in the 'editsectionhint' message
1576 * @param string $lang Language code
1577 * @return string HTML to use for edit link
1578 */
1579 public function doEditSectionLink( Title $nt, $section, $tooltip = null, $lang = false ) {
1580 // HTML generated here should probably have userlangattributes
1581 // added to it for LTR text on RTL pages
1582
1583 $lang = wfGetLangObj( $lang );
1584
1585 $attribs = array();
1586 if ( !is_null( $tooltip ) ) {
1587 # Bug 25462: undo double-escaping.
1588 $tooltip = Sanitizer::decodeCharReferences( $tooltip );
1589 $attribs['title'] = wfMessage( 'editsectionhint' )->rawParams( $tooltip )
1590 ->inLanguage( $lang )->text();
1591 }
1592 $link = Linker::link( $nt, wfMessage( 'editsection' )->inLanguage( $lang )->text(),
1593 $attribs,
1594 array( 'action' => 'edit', 'section' => $section ),
1595 array( 'noclasses', 'known' )
1596 );
1597
1598 # Add the brackets and the span and run the hook.
1599 $result = '<span class="mw-editsection">'
1600 . '<span class="mw-editsection-bracket">[</span>'
1601 . $link
1602 . '<span class="mw-editsection-bracket">]</span>'
1603 . '</span>';
1604
1605 wfRunHooks( 'DoEditSectionLink', array( $this, $nt, $section, $tooltip, &$result, $lang ) );
1606 return $result;
1607 }
1608
1609 /**
1610 * Use PHP's magic __call handler to intercept legacy calls to the linker
1611 * for backwards compatibility.
1612 *
1613 * @param string $fname Name of called method
1614 * @param array $args Arguments to the method
1615 * @throws MWException
1616 * @return mixed
1617 */
1618 function __call( $fname, $args ) {
1619 $realFunction = array( 'Linker', $fname );
1620 if ( is_callable( $realFunction ) ) {
1621 wfDeprecated( get_class( $this ) . '::' . $fname, '1.21' );
1622 return call_user_func_array( $realFunction, $args );
1623 } else {
1624 $className = get_class( $this );
1625 throw new MWException( "Call to undefined method $className::$fname" );
1626 }
1627 }
1628
1629 }