Merge "Fix the Rubocop offense EmptyLinesAroundBody"
[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
172 $this->preloadExistence();
173
174 }
175
176 /**
177 * Defines the ResourceLoader modules that should be added to the skin
178 * It is recommended that skins wishing to override call parent::getDefaultModules()
179 * and substitute out any modules they wish to change by using a key to look them up
180 * @return array Array of modules with helper keys for easy overriding
181 */
182 public function getDefaultModules() {
183 global $wgIncludeLegacyJavaScript, $wgPreloadJavaScriptMwUtil, $wgUseAjax,
184 $wgAjaxWatch, $wgEnableAPI, $wgEnableWriteAPI;
185
186 $out = $this->getOutput();
187 $user = $out->getUser();
188 $modules = array(
189 // modules that enhance the page content in some way
190 'content' => array(
191 'mediawiki.page.ready',
192 ),
193 // modules that exist for legacy reasons
194 'legacy' => array(),
195 // modules relating to search functionality
196 'search' => array(),
197 // modules relating to functionality relating to watching an article
198 'watch' => array(),
199 // modules which relate to the current users preferences
200 'user' => array(),
201 );
202 if ( $wgIncludeLegacyJavaScript ) {
203 $modules['legacy'][] = 'mediawiki.legacy.wikibits';
204 }
205
206 if ( $wgPreloadJavaScriptMwUtil ) {
207 $modules['legacy'][] = 'mediawiki.util';
208 }
209
210 // Add various resources if required
211 if ( $wgUseAjax ) {
212 $modules['legacy'][] = 'mediawiki.legacy.ajax';
213
214 if ( $wgEnableAPI ) {
215 if ( $wgEnableWriteAPI && $wgAjaxWatch && $user->isLoggedIn()
216 && $user->isAllowed( 'writeapi' )
217 ) {
218 $modules['watch'][] = 'mediawiki.page.watch.ajax';
219 }
220
221 $modules['search'][] = 'mediawiki.searchSuggest';
222 }
223 }
224
225 if ( $user->getBoolOption( 'editsectiononrightclick' ) ) {
226 $modules['user'][] = 'mediawiki.action.view.rightClickEdit';
227 }
228
229 // Crazy edit-on-double-click stuff
230 if ( $out->isArticle() && $user->getOption( 'editondblclick' ) ) {
231 $modules['user'][] = 'mediawiki.action.view.dblClickEdit';
232 }
233 return $modules;
234 }
235
236 /**
237 * Preload the existence of three commonly-requested pages in a single query
238 */
239 function preloadExistence() {
240 $titles = array();
241
242 $user = $this->getUser();
243 $title = $this->getRelevantTitle();
244
245 // User/talk link
246 if ( $user->isLoggedIn() || $this->showIPinHeader() ) {
247 $titles[] = $user->getUserPage();
248 $titles[] = $user->getTalkPage();
249 }
250
251 // Other tab link
252 if ( $title->isSpecialPage() ) {
253 // nothing
254 } elseif ( $title->isTalkPage() ) {
255 $titles[] = $title->getSubjectPage();
256 } else {
257 $titles[] = $title->getTalkPage();
258 }
259
260 Hooks::run( 'SkinPreloadExistence', array( &$titles, $this ) );
261
262 if ( count( $titles ) ) {
263 $lb = new LinkBatch( $titles );
264 $lb->setCaller( __METHOD__ );
265 $lb->execute();
266 }
267 }
268
269 /**
270 * Get the current revision ID
271 *
272 * @return int
273 */
274 public function getRevisionId() {
275 return $this->getOutput()->getRevisionId();
276 }
277
278 /**
279 * Whether the revision displayed is the latest revision of the page
280 *
281 * @return bool
282 */
283 public function isRevisionCurrent() {
284 $revID = $this->getRevisionId();
285 return $revID == 0 || $revID == $this->getTitle()->getLatestRevID();
286 }
287
288 /**
289 * Set the "relevant" title
290 * @see self::getRelevantTitle()
291 * @param Title $t
292 */
293 public function setRelevantTitle( $t ) {
294 $this->mRelevantTitle = $t;
295 }
296
297 /**
298 * Return the "relevant" title.
299 * A "relevant" title is not necessarily the actual title of the page.
300 * Special pages like Special:MovePage use set the page they are acting on
301 * as their "relevant" title, this allows the skin system to display things
302 * such as content tabs which belong to to that page instead of displaying
303 * a basic special page tab which has almost no meaning.
304 *
305 * @return Title
306 */
307 public function getRelevantTitle() {
308 if ( isset( $this->mRelevantTitle ) ) {
309 return $this->mRelevantTitle;
310 }
311 return $this->getTitle();
312 }
313
314 /**
315 * Set the "relevant" user
316 * @see self::getRelevantUser()
317 * @param User $u
318 */
319 public function setRelevantUser( $u ) {
320 $this->mRelevantUser = $u;
321 }
322
323 /**
324 * Return the "relevant" user.
325 * A "relevant" user is similar to a relevant title. Special pages like
326 * Special:Contributions mark the user which they are relevant to so that
327 * things like the toolbox can display the information they usually are only
328 * able to display on a user's userpage and talkpage.
329 * @return User
330 */
331 public function getRelevantUser() {
332 if ( isset( $this->mRelevantUser ) ) {
333 return $this->mRelevantUser;
334 }
335 $title = $this->getRelevantTitle();
336 if ( $title->hasSubjectNamespace( NS_USER ) ) {
337 $rootUser = $title->getRootText();
338 if ( User::isIP( $rootUser ) ) {
339 $this->mRelevantUser = User::newFromName( $rootUser, false );
340 } else {
341 $user = User::newFromName( $rootUser, false );
342 if ( $user && $user->isLoggedIn() ) {
343 $this->mRelevantUser = $user;
344 }
345 }
346 return $this->mRelevantUser;
347 }
348 return null;
349 }
350
351 /**
352 * Outputs the HTML generated by other functions.
353 * @param OutputPage $out
354 */
355 abstract function outputPage( OutputPage $out = null );
356
357 /**
358 * @param array $data
359 * @return string
360 */
361 static function makeVariablesScript( $data ) {
362 if ( $data ) {
363 return Html::inlineScript(
364 ResourceLoader::makeLoaderConditionalScript( ResourceLoader::makeConfigSetScript( $data ) )
365 );
366 } else {
367 return '';
368 }
369 }
370
371 /**
372 * Get the query to generate a dynamic stylesheet
373 *
374 * @return array
375 */
376 public static function getDynamicStylesheetQuery() {
377 global $wgSquidMaxage;
378
379 return array(
380 'action' => 'raw',
381 'maxage' => $wgSquidMaxage,
382 'usemsgcache' => 'yes',
383 'ctype' => 'text/css',
384 'smaxage' => $wgSquidMaxage,
385 );
386 }
387
388 /**
389 * Add skin specific stylesheets
390 * Calling this method with an $out of anything but the same OutputPage
391 * inside ->getOutput() is deprecated. The $out arg is kept
392 * for compatibility purposes with skins.
393 * @param OutputPage $out
394 * @todo delete
395 */
396 abstract function setupSkinUserCss( OutputPage $out );
397
398 /**
399 * TODO: document
400 * @param Title $title
401 * @return string
402 */
403 function getPageClasses( $title ) {
404 $numeric = 'ns-' . $title->getNamespace();
405
406 if ( $title->isSpecialPage() ) {
407 $type = 'ns-special';
408 // bug 23315: provide a class based on the canonical special page name without subpages
409 list( $canonicalName ) = SpecialPageFactory::resolveAlias( $title->getDBkey() );
410 if ( $canonicalName ) {
411 $type .= ' ' . Sanitizer::escapeClass( "mw-special-$canonicalName" );
412 } else {
413 $type .= ' mw-invalidspecialpage';
414 }
415 } elseif ( $title->isTalkPage() ) {
416 $type = 'ns-talk';
417 } else {
418 $type = 'ns-subject';
419 }
420
421 $name = Sanitizer::escapeClass( 'page-' . $title->getPrefixedText() );
422
423 return "$numeric $type $name";
424 }
425
426 /**
427 * Return values for <html> element
428 * @return array Array of associative name-to-value elements for <html> element
429 */
430 public function getHtmlElementAttributes() {
431 $lang = $this->getLanguage();
432 return array(
433 'lang' => $lang->getHtmlCode(),
434 'dir' => $lang->getDir(),
435 'class' => 'client-nojs',
436 );
437 }
438
439 /**
440 * This will be called by OutputPage::headElement when it is creating the
441 * "<body>" tag, skins can override it if they have a need to add in any
442 * body attributes or classes of their own.
443 * @param OutputPage $out
444 * @param array $bodyAttrs
445 */
446 function addToBodyAttributes( $out, &$bodyAttrs ) {
447 // does nothing by default
448 }
449
450 /**
451 * URL to the logo
452 * @return string
453 */
454 function getLogo() {
455 global $wgLogo;
456 return $wgLogo;
457 }
458
459 /**
460 * @return string
461 */
462 function getCategoryLinks() {
463 global $wgUseCategoryBrowser;
464
465 $out = $this->getOutput();
466 $allCats = $out->getCategoryLinks();
467
468 if ( !count( $allCats ) ) {
469 return '';
470 }
471
472 $embed = "<li>";
473 $pop = "</li>";
474
475 $s = '';
476 $colon = $this->msg( 'colon-separator' )->escaped();
477
478 if ( !empty( $allCats['normal'] ) ) {
479 $t = $embed . implode( "{$pop}{$embed}", $allCats['normal'] ) . $pop;
480
481 $msg = $this->msg( 'pagecategories' )->numParams( count( $allCats['normal'] ) )->escaped();
482 $linkPage = wfMessage( 'pagecategorieslink' )->inContentLanguage()->text();
483 $title = Title::newFromText( $linkPage );
484 $link = $title ? Linker::link( $title, $msg ) : $msg;
485 $s .= '<div id="mw-normal-catlinks" class="mw-normal-catlinks">' .
486 $link . $colon . '<ul>' . $t . '</ul>' . '</div>';
487 }
488
489 # Hidden categories
490 if ( isset( $allCats['hidden'] ) ) {
491 if ( $this->getUser()->getBoolOption( 'showhiddencats' ) ) {
492 $class = ' mw-hidden-cats-user-shown';
493 } elseif ( $this->getTitle()->getNamespace() == NS_CATEGORY ) {
494 $class = ' mw-hidden-cats-ns-shown';
495 } else {
496 $class = ' mw-hidden-cats-hidden';
497 }
498
499 $s .= "<div id=\"mw-hidden-catlinks\" class=\"mw-hidden-catlinks$class\">" .
500 $this->msg( 'hidden-categories' )->numParams( count( $allCats['hidden'] ) )->escaped() .
501 $colon . '<ul>' . $embed . implode( "{$pop}{$embed}", $allCats['hidden'] ) . $pop . '</ul>' .
502 '</div>';
503 }
504
505 # optional 'dmoz-like' category browser. Will be shown under the list
506 # of categories an article belong to
507 if ( $wgUseCategoryBrowser ) {
508 $s .= '<br /><hr />';
509
510 # get a big array of the parents tree
511 $parenttree = $this->getTitle()->getParentCategoryTree();
512 # Skin object passed by reference cause it can not be
513 # accessed under the method subfunction drawCategoryBrowser
514 $tempout = explode( "\n", $this->drawCategoryBrowser( $parenttree ) );
515 # Clean out bogus first entry and sort them
516 unset( $tempout[0] );
517 asort( $tempout );
518 # Output one per line
519 $s .= implode( "<br />\n", $tempout );
520 }
521
522 return $s;
523 }
524
525 /**
526 * Render the array as a series of links.
527 * @param array $tree Categories tree returned by Title::getParentCategoryTree
528 * @return string Separated by &gt;, terminate with "\n"
529 */
530 function drawCategoryBrowser( $tree ) {
531 $return = '';
532
533 foreach ( $tree as $element => $parent ) {
534 if ( empty( $parent ) ) {
535 # element start a new list
536 $return .= "\n";
537 } else {
538 # grab the others elements
539 $return .= $this->drawCategoryBrowser( $parent ) . ' &gt; ';
540 }
541
542 # add our current element to the list
543 $eltitle = Title::newFromText( $element );
544 $return .= Linker::link( $eltitle, htmlspecialchars( $eltitle->getText() ) );
545 }
546
547 return $return;
548 }
549
550 /**
551 * @return string
552 */
553 function getCategories() {
554 $out = $this->getOutput();
555
556 $catlinks = $this->getCategoryLinks();
557
558 $classes = 'catlinks';
559
560 // Check what we're showing
561 $allCats = $out->getCategoryLinks();
562 $showHidden = $this->getUser()->getBoolOption( 'showhiddencats' ) ||
563 $this->getTitle()->getNamespace() == NS_CATEGORY;
564
565 if ( empty( $allCats['normal'] ) && !( !empty( $allCats['hidden'] ) && $showHidden ) ) {
566 $classes .= ' catlinks-allhidden';
567 }
568
569 return "<div id='catlinks' class='$classes'>{$catlinks}</div>";
570 }
571
572 /**
573 * This runs a hook to allow extensions placing their stuff after content
574 * and article metadata (e.g. categories).
575 * Note: This function has nothing to do with afterContent().
576 *
577 * This hook is placed here in order to allow using the same hook for all
578 * skins, both the SkinTemplate based ones and the older ones, which directly
579 * use this class to get their data.
580 *
581 * The output of this function gets processed in SkinTemplate::outputPage() for
582 * the SkinTemplate based skins, all other skins should directly echo it.
583 *
584 * @return string Empty by default, if not changed by any hook function.
585 */
586 protected function afterContentHook() {
587 $data = '';
588
589 if ( Hooks::run( 'SkinAfterContent', array( &$data, $this ) ) ) {
590 // adding just some spaces shouldn't toggle the output
591 // of the whole <div/>, so we use trim() here
592 if ( trim( $data ) != '' ) {
593 // Doing this here instead of in the skins to
594 // ensure that the div has the same ID in all
595 // skins
596 $data = "<div id='mw-data-after-content'>\n" .
597 "\t$data\n" .
598 "</div>\n";
599 }
600 } else {
601 wfDebug( "Hook SkinAfterContent changed output processing.\n" );
602 }
603
604 return $data;
605 }
606
607 /**
608 * Generate debug data HTML for displaying at the bottom of the main content
609 * area.
610 * @return string HTML containing debug data, if enabled (otherwise empty).
611 */
612 protected function generateDebugHTML() {
613 return MWDebug::getHTMLDebugLog();
614 }
615
616 /**
617 * This gets called shortly before the "</body>" tag.
618 *
619 * @return string HTML-wrapped JS code to be put before "</body>"
620 */
621 function bottomScripts() {
622 // TODO and the suckage continues. This function is really just a wrapper around
623 // OutputPage::getBottomScripts() which takes a Skin param. This should be cleaned
624 // up at some point
625 $bottomScriptText = $this->getOutput()->getBottomScripts();
626 Hooks::run( 'SkinAfterBottomScripts', array( $this, &$bottomScriptText ) );
627
628 return $bottomScriptText;
629 }
630
631 /**
632 * Text with the permalink to the source page,
633 * usually shown on the footer of a printed page
634 *
635 * @return string HTML text with an URL
636 */
637 function printSource() {
638 $oldid = $this->getRevisionId();
639 if ( $oldid ) {
640 $canonicalUrl = $this->getTitle()->getCanonicalURL( 'oldid=' . $oldid );
641 $url = htmlspecialchars( wfExpandIRI( $canonicalUrl ) );
642 } else {
643 // oldid not available for non existing pages
644 $url = htmlspecialchars( wfExpandIRI( $this->getTitle()->getCanonicalURL() ) );
645 }
646
647 return $this->msg( 'retrievedfrom' )
648 ->rawParams( '<a dir="ltr" href="' . $url. '">' . $url . '</a>' )
649 ->parse();
650 }
651
652 /**
653 * @return string HTML
654 */
655 function getUndeleteLink() {
656 $action = $this->getRequest()->getVal( 'action', 'view' );
657
658 if ( $this->getTitle()->userCan( 'deletedhistory', $this->getUser() ) &&
659 ( !$this->getTitle()->exists() || $action == 'history' ) ) {
660 $n = $this->getTitle()->isDeleted();
661
662 if ( $n ) {
663 if ( $this->getTitle()->quickUserCan( 'undelete', $this->getUser() ) ) {
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 )->escaped();
674 }
675 }
676
677 return '';
678 }
679
680 /**
681 * @return string
682 */
683 function subPageSubtitle() {
684 $out = $this->getOutput();
685 $subpages = '';
686
687 if ( !Hooks::run( '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 Hooks::run(
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 $url1 = htmlspecialchars( "$wgResourceBasePath/resources/assets/poweredby_mediawiki_88x31.png" );
841 $url1_5 = htmlspecialchars( "$wgResourceBasePath/resources/assets/poweredby_mediawiki_132x47.png" );
842 $url2 = htmlspecialchars( "$wgResourceBasePath/resources/assets/poweredby_mediawiki_176x62.png" );
843 $text = '<a href="//www.mediawiki.org/"><img src="' . $url1
844 . '" srcset="' . $url1_5 . ' 1.5x, ' . $url2 . ' 2x" '
845 . 'height="31" width="88" alt="Powered by MediaWiki" /></a>';
846 Hooks::run( 'SkinGetPoweredBy', array( &$text, $this ) );
847 return $text;
848 }
849
850 /**
851 * Get the timestamp of the latest revision, formatted in user language
852 *
853 * @return string
854 */
855 protected function lastModified() {
856 $timestamp = $this->getOutput()->getRevisionTimestamp();
857
858 # No cached timestamp, load it from the database
859 if ( $timestamp === null ) {
860 $timestamp = Revision::getTimestampFromId( $this->getTitle(), $this->getRevisionId() );
861 }
862
863 if ( $timestamp ) {
864 $d = $this->getLanguage()->userDate( $timestamp, $this->getUser() );
865 $t = $this->getLanguage()->userTime( $timestamp, $this->getUser() );
866 $s = ' ' . $this->msg( 'lastmodifiedat', $d, $t )->parse();
867 } else {
868 $s = '';
869 }
870
871 if ( wfGetLB()->getLaggedSlaveMode() ) {
872 $s .= ' <strong>' . $this->msg( 'laggedslavemode' )->parse() . '</strong>';
873 }
874
875 return $s;
876 }
877
878 /**
879 * @param string $align
880 * @return string
881 */
882 function logoText( $align = '' ) {
883 if ( $align != '' ) {
884 $a = " style='float: {$align};'";
885 } else {
886 $a = '';
887 }
888
889 $mp = $this->msg( 'mainpage' )->escaped();
890 $mptitle = Title::newMainPage();
891 $url = ( is_object( $mptitle ) ? htmlspecialchars( $mptitle->getLocalURL() ) : '' );
892
893 $logourl = $this->getLogo();
894 $s = "<a href='{$url}'><img{$a} src='{$logourl}' alt='[{$mp}]' /></a>";
895
896 return $s;
897 }
898
899 /**
900 * Renders a $wgFooterIcons icon according to the method's arguments
901 * @param array $icon The icon to build the html for, see $wgFooterIcons
902 * for the format of this array.
903 * @param bool|string $withImage Whether to use the icon's image or output
904 * a text-only footericon.
905 * @return string HTML
906 */
907 function makeFooterIcon( $icon, $withImage = 'withImage' ) {
908 if ( is_string( $icon ) ) {
909 $html = $icon;
910 } else { // Assuming array
911 $url = isset( $icon["url"] ) ? $icon["url"] : null;
912 unset( $icon["url"] );
913 if ( isset( $icon["src"] ) && $withImage === 'withImage' ) {
914 // do this the lazy way, just pass icon data as an attribute array
915 $html = Html::element( 'img', $icon );
916 } else {
917 $html = htmlspecialchars( $icon["alt"] );
918 }
919 if ( $url ) {
920 $html = Html::rawElement( 'a', array( "href" => $url ), $html );
921 }
922 }
923 return $html;
924 }
925
926 /**
927 * Gets the link to the wiki's main page.
928 * @return string
929 */
930 function mainPageLink() {
931 $s = Linker::linkKnown(
932 Title::newMainPage(),
933 $this->msg( 'mainpage' )->escaped()
934 );
935
936 return $s;
937 }
938
939 /**
940 * Returns an HTML link for use in the footer
941 * @param string $desc The i18n message key for the link text
942 * @param string $page The i18n message key for the page to link to
943 * @return string HTML anchor
944 */
945 public function footerLink( $desc, $page ) {
946 // if the link description has been set to "-" in the default language,
947 if ( $this->msg( $desc )->inContentLanguage()->isDisabled() ) {
948 // then it is disabled, for all languages.
949 return '';
950 } else {
951 // Otherwise, we display the link for the user, described in their
952 // language (which may or may not be the same as the default language),
953 // but we make the link target be the one site-wide page.
954 $title = Title::newFromText( $this->msg( $page )->inContentLanguage()->text() );
955
956 if ( !$title ) {
957 return '';
958 }
959
960 return Linker::linkKnown(
961 $title,
962 $this->msg( $desc )->escaped()
963 );
964 }
965 }
966
967 /**
968 * Gets the link to the wiki's privacy policy page.
969 * @return string HTML
970 */
971 function privacyLink() {
972 return $this->footerLink( 'privacy', 'privacypage' );
973 }
974
975 /**
976 * Gets the link to the wiki's about page.
977 * @return string HTML
978 */
979 function aboutLink() {
980 return $this->footerLink( 'aboutsite', 'aboutpage' );
981 }
982
983 /**
984 * Gets the link to the wiki's general disclaimers page.
985 * @return string HTML
986 */
987 function disclaimerLink() {
988 return $this->footerLink( 'disclaimers', 'disclaimerpage' );
989 }
990
991 /**
992 * Return URL options for the 'edit page' link.
993 * This may include an 'oldid' specifier, if the current page view is such.
994 *
995 * @return array
996 * @private
997 */
998 function editUrlOptions() {
999 $options = array( 'action' => 'edit' );
1000
1001 if ( !$this->isRevisionCurrent() ) {
1002 $options['oldid'] = intval( $this->getRevisionId() );
1003 }
1004
1005 return $options;
1006 }
1007
1008 /**
1009 * @param User|int $id
1010 * @return bool
1011 */
1012 function showEmailUser( $id ) {
1013 if ( $id instanceof User ) {
1014 $targetUser = $id;
1015 } else {
1016 $targetUser = User::newFromId( $id );
1017 }
1018
1019 # The sending user must have a confirmed email address and the target
1020 # user must have a confirmed email address and allow emails from users.
1021 return $this->getUser()->canSendEmail() &&
1022 $targetUser->canReceiveEmail();
1023 }
1024
1025 /**
1026 * This function previously returned a fully resolved style path URL to images or styles stored in
1027 * the legacy skins/common/ directory.
1028 *
1029 * That directory has been removed in 1.24 and the function always returns an empty string.
1030 *
1031 * @deprecated since 1.24
1032 * @param string $name The name or path of a skin resource file
1033 * @return string Empty string
1034 */
1035 function getCommonStylePath( $name ) {
1036 wfDeprecated( __METHOD__, '1.24' );
1037 return '';
1038 }
1039
1040 /**
1041 * Return a fully resolved style path url to images or styles stored in the current skins's folder.
1042 * This method returns a url resolved using the configured skin style path
1043 * and includes the style version inside of the url.
1044 *
1045 * Requires $stylename to be set, otherwise throws MWException.
1046 *
1047 * @param string $name The name or path of a skin resource file
1048 * @return string The fully resolved style path url including styleversion
1049 * @throws MWException
1050 */
1051 function getSkinStylePath( $name ) {
1052 global $wgStylePath, $wgStyleVersion;
1053
1054 if ( $this->stylename === null ) {
1055 $class = get_class( $this );
1056 throw new MWException( "$class::\$stylename must be set to use getSkinStylePath()" );
1057 }
1058
1059 return "$wgStylePath/{$this->stylename}/$name?$wgStyleVersion";
1060 }
1061
1062 /* these are used extensively in SkinTemplate, but also some other places */
1063
1064 /**
1065 * @param string $urlaction
1066 * @return string
1067 */
1068 static function makeMainPageUrl( $urlaction = '' ) {
1069 $title = Title::newMainPage();
1070 self::checkTitle( $title, '' );
1071
1072 return $title->getLocalURL( $urlaction );
1073 }
1074
1075 /**
1076 * Make a URL for a Special Page using the given query and protocol.
1077 *
1078 * If $proto is set to null, make a local URL. Otherwise, make a full
1079 * URL with the protocol specified.
1080 *
1081 * @param string $name Name of the Special page
1082 * @param string $urlaction Query to append
1083 * @param string|null $proto Protocol to use or null for a local URL
1084 * @return string
1085 */
1086 static function makeSpecialUrl( $name, $urlaction = '', $proto = null ) {
1087 $title = SpecialPage::getSafeTitleFor( $name );
1088 if ( is_null( $proto ) ) {
1089 return $title->getLocalURL( $urlaction );
1090 } else {
1091 return $title->getFullURL( $urlaction, false, $proto );
1092 }
1093 }
1094
1095 /**
1096 * @param string $name
1097 * @param string $subpage
1098 * @param string $urlaction
1099 * @return string
1100 */
1101 static function makeSpecialUrlSubpage( $name, $subpage, $urlaction = '' ) {
1102 $title = SpecialPage::getSafeTitleFor( $name, $subpage );
1103 return $title->getLocalURL( $urlaction );
1104 }
1105
1106 /**
1107 * @param string $name
1108 * @param string $urlaction
1109 * @return string
1110 */
1111 static function makeI18nUrl( $name, $urlaction = '' ) {
1112 $title = Title::newFromText( wfMessage( $name )->inContentLanguage()->text() );
1113 self::checkTitle( $title, $name );
1114 return $title->getLocalURL( $urlaction );
1115 }
1116
1117 /**
1118 * @param string $name
1119 * @param string $urlaction
1120 * @return string
1121 */
1122 static function makeUrl( $name, $urlaction = '' ) {
1123 $title = Title::newFromText( $name );
1124 self::checkTitle( $title, $name );
1125
1126 return $title->getLocalURL( $urlaction );
1127 }
1128
1129 /**
1130 * If url string starts with http, consider as external URL, else
1131 * internal
1132 * @param string $name
1133 * @return string URL
1134 */
1135 static function makeInternalOrExternalUrl( $name ) {
1136 if ( preg_match( '/^(?i:' . wfUrlProtocols() . ')/', $name ) ) {
1137 return $name;
1138 } else {
1139 return self::makeUrl( $name );
1140 }
1141 }
1142
1143 /**
1144 * this can be passed the NS number as defined in Language.php
1145 * @param string $name
1146 * @param string $urlaction
1147 * @param int $namespace
1148 * @return string
1149 */
1150 static function makeNSUrl( $name, $urlaction = '', $namespace = NS_MAIN ) {
1151 $title = Title::makeTitleSafe( $namespace, $name );
1152 self::checkTitle( $title, $name );
1153
1154 return $title->getLocalURL( $urlaction );
1155 }
1156
1157 /**
1158 * these return an array with the 'href' and boolean 'exists'
1159 * @param string $name
1160 * @param string $urlaction
1161 * @return array
1162 */
1163 static function makeUrlDetails( $name, $urlaction = '' ) {
1164 $title = Title::newFromText( $name );
1165 self::checkTitle( $title, $name );
1166
1167 return array(
1168 'href' => $title->getLocalURL( $urlaction ),
1169 'exists' => $title->isKnown(),
1170 );
1171 }
1172
1173 /**
1174 * Make URL details where the article exists (or at least it's convenient to think so)
1175 * @param string $name Article name
1176 * @param string $urlaction
1177 * @return array
1178 */
1179 static function makeKnownUrlDetails( $name, $urlaction = '' ) {
1180 $title = Title::newFromText( $name );
1181 self::checkTitle( $title, $name );
1182
1183 return array(
1184 'href' => $title->getLocalURL( $urlaction ),
1185 'exists' => true
1186 );
1187 }
1188
1189 /**
1190 * make sure we have some title to operate on
1191 *
1192 * @param Title $title
1193 * @param string $name
1194 */
1195 static function checkTitle( &$title, $name ) {
1196 if ( !is_object( $title ) ) {
1197 $title = Title::newFromText( $name );
1198 if ( !is_object( $title ) ) {
1199 $title = Title::newFromText( '--error: link target missing--' );
1200 }
1201 }
1202 }
1203
1204 /**
1205 * Build an array that represents the sidebar(s), the navigation bar among them.
1206 *
1207 * BaseTemplate::getSidebar can be used to simplify the format and id generation in new skins.
1208 *
1209 * The format of the returned array is array( heading => content, ... ), where:
1210 * - heading is the heading of a navigation portlet. It is either:
1211 * - magic string to be handled by the skins ('SEARCH' / 'LANGUAGES' / 'TOOLBOX' / ...)
1212 * - a message name (e.g. 'navigation'), the message should be HTML-escaped by the skin
1213 * - plain text, which should be HTML-escaped by the skin
1214 * - content is the contents of the portlet. It is either:
1215 * - HTML text (<ul><li>...</li>...</ul>)
1216 * - array of link data in a format accepted by BaseTemplate::makeListItem()
1217 * - (for a magic string as a key, any value)
1218 *
1219 * Note that extensions can control the sidebar contents using the SkinBuildSidebar hook
1220 * and can technically insert anything in here; skin creators are expected to handle
1221 * values described above.
1222 *
1223 * @return array
1224 */
1225 function buildSidebar() {
1226 global $wgMemc, $wgEnableSidebarCache, $wgSidebarCacheExpiry;
1227
1228 $key = wfMemcKey( 'sidebar', $this->getLanguage()->getCode() );
1229
1230 if ( $wgEnableSidebarCache ) {
1231 $cachedsidebar = $wgMemc->get( $key );
1232 if ( $cachedsidebar ) {
1233 Hooks::run( 'SidebarBeforeOutput', array( $this, &$cachedsidebar ) );
1234
1235 return $cachedsidebar;
1236 }
1237 }
1238
1239 $bar = array();
1240 $this->addToSidebar( $bar, 'sidebar' );
1241
1242 Hooks::run( 'SkinBuildSidebar', array( $this, &$bar ) );
1243 if ( $wgEnableSidebarCache ) {
1244 $wgMemc->set( $key, $bar, $wgSidebarCacheExpiry );
1245 }
1246
1247 Hooks::run( 'SidebarBeforeOutput', array( $this, &$bar ) );
1248
1249 return $bar;
1250 }
1251
1252 /**
1253 * Add content from a sidebar system message
1254 * Currently only used for MediaWiki:Sidebar (but may be used by Extensions)
1255 *
1256 * This is just a wrapper around addToSidebarPlain() for backwards compatibility
1257 *
1258 * @param array $bar
1259 * @param string $message
1260 */
1261 function addToSidebar( &$bar, $message ) {
1262 $this->addToSidebarPlain( $bar, wfMessage( $message )->inContentLanguage()->plain() );
1263 }
1264
1265 /**
1266 * Add content from plain text
1267 * @since 1.17
1268 * @param array $bar
1269 * @param string $text
1270 * @return array
1271 */
1272 function addToSidebarPlain( &$bar, $text ) {
1273 $lines = explode( "\n", $text );
1274
1275 $heading = '';
1276
1277 foreach ( $lines as $line ) {
1278 if ( strpos( $line, '*' ) !== 0 ) {
1279 continue;
1280 }
1281 $line = rtrim( $line, "\r" ); // for Windows compat
1282
1283 if ( strpos( $line, '**' ) !== 0 ) {
1284 $heading = trim( $line, '* ' );
1285 if ( !array_key_exists( $heading, $bar ) ) {
1286 $bar[$heading] = array();
1287 }
1288 } else {
1289 $line = trim( $line, '* ' );
1290
1291 if ( strpos( $line, '|' ) !== false ) { // sanity check
1292 $line = MessageCache::singleton()->transform( $line, false, null, $this->getTitle() );
1293 $line = array_map( 'trim', explode( '|', $line, 2 ) );
1294 if ( count( $line ) !== 2 ) {
1295 // Second sanity check, could be hit by people doing
1296 // funky stuff with parserfuncs... (bug 33321)
1297 continue;
1298 }
1299
1300 $extraAttribs = array();
1301
1302 $msgLink = $this->msg( $line[0] )->inContentLanguage();
1303 if ( $msgLink->exists() ) {
1304 $link = $msgLink->text();
1305 if ( $link == '-' ) {
1306 continue;
1307 }
1308 } else {
1309 $link = $line[0];
1310 }
1311 $msgText = $this->msg( $line[1] );
1312 if ( $msgText->exists() ) {
1313 $text = $msgText->text();
1314 } else {
1315 $text = $line[1];
1316 }
1317
1318 if ( preg_match( '/^(?i:' . wfUrlProtocols() . ')/', $link ) ) {
1319 $href = $link;
1320
1321 // Parser::getExternalLinkAttribs won't work here because of the Namespace things
1322 global $wgNoFollowLinks, $wgNoFollowDomainExceptions;
1323 if ( $wgNoFollowLinks && !wfMatchesDomainList( $href, $wgNoFollowDomainExceptions ) ) {
1324 $extraAttribs['rel'] = 'nofollow';
1325 }
1326
1327 global $wgExternalLinkTarget;
1328 if ( $wgExternalLinkTarget ) {
1329 $extraAttribs['target'] = $wgExternalLinkTarget;
1330 }
1331 } else {
1332 $title = Title::newFromText( $link );
1333
1334 if ( $title ) {
1335 $title = $title->fixSpecialName();
1336 $href = $title->getLinkURL();
1337 } else {
1338 $href = 'INVALID-TITLE';
1339 }
1340 }
1341
1342 $bar[$heading][] = array_merge( array(
1343 'text' => $text,
1344 'href' => $href,
1345 'id' => 'n-' . Sanitizer::escapeId( strtr( $line[1], ' ', '-' ), 'noninitial' ),
1346 'active' => false
1347 ), $extraAttribs );
1348 } else {
1349 continue;
1350 }
1351 }
1352 }
1353
1354 return $bar;
1355 }
1356
1357 /**
1358 * This function previously controlled whether the 'mediawiki.legacy.wikiprintable' module
1359 * should be loaded by OutputPage. That module no longer exists and the return value of this
1360 * method is ignored.
1361 *
1362 * If your skin doesn't provide its own print styles, the 'mediawiki.legacy.commonPrint' module
1363 * can be used instead (SkinTemplate-based skins do it automatically).
1364 *
1365 * @deprecated since 1.22
1366 * @return bool
1367 */
1368 public function commonPrintStylesheet() {
1369 wfDeprecated( __METHOD__, '1.22' );
1370 return false;
1371 }
1372
1373 /**
1374 * Gets new talk page messages for the current user and returns an
1375 * appropriate alert message (or an empty string if there are no messages)
1376 * @return string
1377 */
1378 function getNewtalks() {
1379
1380 $newMessagesAlert = '';
1381 $user = $this->getUser();
1382 $newtalks = $user->getNewMessageLinks();
1383 $out = $this->getOutput();
1384
1385 // Allow extensions to disable or modify the new messages alert
1386 if ( !Hooks::run( 'GetNewMessagesAlert', array( &$newMessagesAlert, $newtalks, $user, $out ) ) ) {
1387 return '';
1388 }
1389 if ( $newMessagesAlert ) {
1390 return $newMessagesAlert;
1391 }
1392
1393 if ( count( $newtalks ) == 1 && $newtalks[0]['wiki'] === wfWikiID() ) {
1394 $uTalkTitle = $user->getTalkPage();
1395 $lastSeenRev = isset( $newtalks[0]['rev'] ) ? $newtalks[0]['rev'] : null;
1396 $nofAuthors = 0;
1397 if ( $lastSeenRev !== null ) {
1398 $plural = true; // Default if we have a last seen revision: if unknown, use plural
1399 $latestRev = Revision::newFromTitle( $uTalkTitle, false, Revision::READ_NORMAL );
1400 if ( $latestRev !== null ) {
1401 // Singular if only 1 unseen revision, plural if several unseen revisions.
1402 $plural = $latestRev->getParentId() !== $lastSeenRev->getId();
1403 $nofAuthors = $uTalkTitle->countAuthorsBetween(
1404 $lastSeenRev, $latestRev, 10, 'include_new' );
1405 }
1406 } else {
1407 // Singular if no revision -> diff link will show latest change only in any case
1408 $plural = false;
1409 }
1410 $plural = $plural ? 999 : 1;
1411 // 999 signifies "more than one revision". We don't know how many, and even if we did,
1412 // the number of revisions or authors is not necessarily the same as the number of
1413 // "messages".
1414 $newMessagesLink = Linker::linkKnown(
1415 $uTalkTitle,
1416 $this->msg( 'newmessageslinkplural' )->params( $plural )->escaped(),
1417 array(),
1418 array( 'redirect' => 'no' )
1419 );
1420
1421 $newMessagesDiffLink = Linker::linkKnown(
1422 $uTalkTitle,
1423 $this->msg( 'newmessagesdifflinkplural' )->params( $plural )->escaped(),
1424 array(),
1425 $lastSeenRev !== null
1426 ? array( 'oldid' => $lastSeenRev->getId(), 'diff' => 'cur' )
1427 : array( 'diff' => 'cur' )
1428 );
1429
1430 if ( $nofAuthors >= 1 && $nofAuthors <= 10 ) {
1431 $newMessagesAlert = $this->msg(
1432 'youhavenewmessagesfromusers',
1433 $newMessagesLink,
1434 $newMessagesDiffLink
1435 )->numParams( $nofAuthors, $plural );
1436 } else {
1437 // $nofAuthors === 11 signifies "11 or more" ("more than 10")
1438 $newMessagesAlert = $this->msg(
1439 $nofAuthors > 10 ? 'youhavenewmessagesmanyusers' : 'youhavenewmessages',
1440 $newMessagesLink,
1441 $newMessagesDiffLink
1442 )->numParams( $plural );
1443 }
1444 $newMessagesAlert = $newMessagesAlert->text();
1445 # Disable Squid cache
1446 $out->setSquidMaxage( 0 );
1447 } elseif ( count( $newtalks ) ) {
1448 $sep = $this->msg( 'newtalkseparator' )->escaped();
1449 $msgs = array();
1450
1451 foreach ( $newtalks as $newtalk ) {
1452 $msgs[] = Xml::element(
1453 'a',
1454 array( 'href' => $newtalk['link'] ), $newtalk['wiki']
1455 );
1456 }
1457 $parts = implode( $sep, $msgs );
1458 $newMessagesAlert = $this->msg( 'youhavenewmessagesmulti' )->rawParams( $parts )->escaped();
1459 $out->setSquidMaxage( 0 );
1460 }
1461
1462 return $newMessagesAlert;
1463 }
1464
1465 /**
1466 * Get a cached notice
1467 *
1468 * @param string $name Message name, or 'default' for $wgSiteNotice
1469 * @return string HTML fragment
1470 */
1471 private function getCachedNotice( $name ) {
1472 global $wgRenderHashAppend, $parserMemc, $wgContLang;
1473
1474 $needParse = false;
1475
1476 if ( $name === 'default' ) {
1477 // special case
1478 global $wgSiteNotice;
1479 $notice = $wgSiteNotice;
1480 if ( empty( $notice ) ) {
1481 return false;
1482 }
1483 } else {
1484 $msg = $this->msg( $name )->inContentLanguage();
1485 if ( $msg->isDisabled() ) {
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 return $notice;
1513 }
1514
1515 /**
1516 * Get a notice based on page's namespace
1517 *
1518 * @return string HTML fragment
1519 */
1520 function getNamespaceNotice() {
1521
1522 $key = 'namespacenotice-' . $this->getTitle()->getNsText();
1523 $namespaceNotice = $this->getCachedNotice( $key );
1524 if ( $namespaceNotice && substr( $namespaceNotice, 0, 7 ) != '<p>&lt;' ) {
1525 $namespaceNotice = '<div id="namespacebanner">' . $namespaceNotice . '</div>';
1526 } else {
1527 $namespaceNotice = '';
1528 }
1529
1530 return $namespaceNotice;
1531 }
1532
1533 /**
1534 * Get the site notice
1535 *
1536 * @return string HTML fragment
1537 */
1538 function getSiteNotice() {
1539 $siteNotice = '';
1540
1541 if ( Hooks::run( 'SiteNoticeBefore', array( &$siteNotice, $this ) ) ) {
1542 if ( is_object( $this->getUser() ) && $this->getUser()->isLoggedIn() ) {
1543 $siteNotice = $this->getCachedNotice( 'sitenotice' );
1544 } else {
1545 $anonNotice = $this->getCachedNotice( 'anonnotice' );
1546 if ( !$anonNotice ) {
1547 $siteNotice = $this->getCachedNotice( 'sitenotice' );
1548 } else {
1549 $siteNotice = $anonNotice;
1550 }
1551 }
1552 if ( !$siteNotice ) {
1553 $siteNotice = $this->getCachedNotice( 'default' );
1554 }
1555 }
1556
1557 Hooks::run( 'SiteNoticeAfter', array( &$siteNotice, $this ) );
1558 return $siteNotice;
1559 }
1560
1561 /**
1562 * Create a section edit link. This supersedes editSectionLink() and
1563 * editSectionLinkForOther().
1564 *
1565 * @param Title $nt The title being linked to (may not be the same as
1566 * the current page, if the section is included from a template)
1567 * @param string $section The designation of the section being pointed to,
1568 * to be included in the link, like "&section=$section"
1569 * @param string $tooltip The tooltip to use for the link: will be escaped
1570 * and wrapped in the 'editsectionhint' message
1571 * @param string $lang Language code
1572 * @return string HTML to use for edit link
1573 */
1574 public function doEditSectionLink( Title $nt, $section, $tooltip = null, $lang = false ) {
1575 // HTML generated here should probably have userlangattributes
1576 // added to it for LTR text on RTL pages
1577
1578 $lang = wfGetLangObj( $lang );
1579
1580 $attribs = array();
1581 if ( !is_null( $tooltip ) ) {
1582 # Bug 25462: undo double-escaping.
1583 $tooltip = Sanitizer::decodeCharReferences( $tooltip );
1584 $attribs['title'] = wfMessage( 'editsectionhint' )->rawParams( $tooltip )
1585 ->inLanguage( $lang )->text();
1586 }
1587
1588 $links = array(
1589 'editsection' => array(
1590 'text' => wfMessage( 'editsection' )->inLanguage( $lang )->text(),
1591 'targetTitle' => $nt,
1592 'attribs' => $attribs,
1593 'query' => array( 'action' => 'edit', 'section' => $section ),
1594 'options' => array( 'noclasses', 'known' )
1595 )
1596 );
1597
1598 Hooks::run( 'SkinEditSectionLinks', array( $this, $nt, $section, $tooltip, &$links, $lang ) );
1599
1600 $result = '<span class="mw-editsection"><span class="mw-editsection-bracket">[</span>';
1601
1602 $linksHtml = array();
1603 foreach ( $links as $k => $linkDetails ) {
1604 $linksHtml[] = Linker::link(
1605 $linkDetails['targetTitle'],
1606 $linkDetails['text'],
1607 $linkDetails['attribs'],
1608 $linkDetails['query'],
1609 $linkDetails['options']
1610 );
1611 }
1612
1613 $result .= implode(
1614 '<span class="mw-editsection-divider">'
1615 . wfMessage( 'pipe-separator' )->inLanguage( $lang )->text()
1616 . '</span>',
1617 $linksHtml
1618 );
1619
1620 $result .= '<span class="mw-editsection-bracket">]</span></span>';
1621
1622 Hooks::run( 'DoEditSectionLink', array( $this, $nt, $section, $tooltip, &$result, $lang ) );
1623 return $result;
1624 }
1625
1626 /**
1627 * Use PHP's magic __call handler to intercept legacy calls to the linker
1628 * for backwards compatibility.
1629 *
1630 * @param string $fname Name of called method
1631 * @param array $args Arguments to the method
1632 * @throws MWException
1633 * @return mixed
1634 */
1635 function __call( $fname, $args ) {
1636 $realFunction = array( 'Linker', $fname );
1637 if ( is_callable( $realFunction ) ) {
1638 wfDeprecated( get_class( $this ) . '::' . $fname, '1.21' );
1639 return call_user_func_array( $realFunction, $args );
1640 } else {
1641 $className = get_class( $this );
1642 throw new MWException( "Call to undefined method $className::$fname" );
1643 }
1644 }
1645
1646 }