Merge "Add non DBMS depending SQL tests for DatabaseBase"
[lhc/web/wiklou.git] / includes / SkinTemplate.php
1 <?php
2 /**
3 * Base class for template-based 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 * Wrapper object for MediaWiki's localization functions,
25 * to be passed to the template engine.
26 *
27 * @private
28 * @ingroup Skins
29 */
30 class MediaWiki_I18N {
31 var $_context = array();
32
33 function set( $varName, $value ) {
34 $this->_context[$varName] = $value;
35 }
36
37 function translate( $value ) {
38 wfProfileIn( __METHOD__ );
39
40 // Hack for i18n:attributes in PHPTAL 1.0.0 dev version as of 2004-10-23
41 $value = preg_replace( '/^string:/', '', $value );
42
43 $value = wfMessage( $value )->text();
44 // interpolate variables
45 $m = array();
46 while( preg_match( '/\$([0-9]*?)/sm', $value, $m ) ) {
47 list( $src, $var ) = $m;
48 wfSuppressWarnings();
49 $varValue = $this->_context[$var];
50 wfRestoreWarnings();
51 $value = str_replace( $src, $varValue, $value );
52 }
53 wfProfileOut( __METHOD__ );
54 return $value;
55 }
56 }
57
58 /**
59 * Template-filler skin base class
60 * Formerly generic PHPTal (http://phptal.sourceforge.net/) skin
61 * Based on Brion's smarty skin
62 * @copyright Copyright © Gabriel Wicke -- http://www.aulinx.de/
63 *
64 * @todo Needs some serious refactoring into functions that correspond
65 * to the computations individual esi snippets need. Most importantly no body
66 * parsing for most of those of course.
67 *
68 * @ingroup Skins
69 */
70 class SkinTemplate extends Skin {
71 /**#@+
72 * @private
73 */
74
75 /**
76 * Name of our skin, it probably needs to be all lower case. Child classes
77 * should override the default.
78 */
79 var $skinname = 'monobook';
80
81 /**
82 * Stylesheets set to use. Subdirectory in skins/ where various stylesheets
83 * are located. Child classes should override the default.
84 */
85 var $stylename = 'monobook';
86
87 /**
88 * For QuickTemplate, the name of the subclass which will actually fill the
89 * template. Child classes should override the default.
90 */
91 var $template = 'QuickTemplate';
92
93 /**
94 * Whether this skin use OutputPage::headElement() to generate the "<head>"
95 * tag
96 */
97 var $useHeadElement = false;
98
99 /**#@-*/
100
101 /**
102 * Add specific styles for this skin
103 *
104 * @param $out OutputPage
105 */
106 function setupSkinUserCss( OutputPage $out ) {
107 $out->addModuleStyles( array( 'mediawiki.legacy.shared', 'mediawiki.legacy.commonPrint' ) );
108 }
109
110 /**
111 * Create the template engine object; we feed it a bunch of data
112 * and eventually it spits out some HTML. Should have interface
113 * roughly equivalent to PHPTAL 0.7.
114 *
115 * @param $classname String
116 * @param string $repository subdirectory where we keep template files
117 * @param $cache_dir string
118 * @return QuickTemplate
119 * @private
120 */
121 function setupTemplate( $classname, $repository = false, $cache_dir = false ) {
122 return new $classname();
123 }
124
125 /**
126 * initialize various variables and generate the template
127 *
128 * @param $out OutputPage
129 */
130 function outputPage( OutputPage $out = null ) {
131 global $wgContLang;
132 global $wgScript, $wgStylePath;
133 global $wgMimeType, $wgJsMimeType;
134 global $wgXhtmlDefaultNamespace, $wgXhtmlNamespaces, $wgHtml5Version;
135 global $wgDisableCounters, $wgSitename, $wgLogo, $wgHideInterlanguageLinks;
136 global $wgMaxCredits, $wgShowCreditsIfMax;
137 global $wgPageShowWatchingUsers;
138 global $wgArticlePath, $wgScriptPath, $wgServer;
139
140 wfProfileIn( __METHOD__ );
141 Profiler::instance()->setTemplated( true );
142
143 $oldContext = null;
144 if ( $out !== null ) {
145 // @todo Add wfDeprecated in 1.20
146 $oldContext = $this->getContext();
147 $this->setContext( $out->getContext() );
148 }
149
150 $out = $this->getOutput();
151 $request = $this->getRequest();
152 $user = $this->getUser();
153 $title = $this->getTitle();
154
155 wfProfileIn( __METHOD__ . '-init' );
156 $this->initPage( $out );
157
158 $tpl = $this->setupTemplate( $this->template, 'skins' );
159 wfProfileOut( __METHOD__ . '-init' );
160
161 wfProfileIn( __METHOD__ . '-stuff' );
162 $this->thispage = $title->getPrefixedDBkey();
163 $this->titletxt = $title->getPrefixedText();
164 $this->userpage = $user->getUserPage()->getPrefixedText();
165 $query = array();
166 if ( !$request->wasPosted() ) {
167 $query = $request->getValues();
168 unset( $query['title'] );
169 unset( $query['returnto'] );
170 unset( $query['returntoquery'] );
171 }
172 $this->thisquery = wfArrayToCgi( $query );
173 $this->loggedin = $user->isLoggedIn();
174 $this->username = $user->getName();
175
176 if ( $this->loggedin || $this->showIPinHeader() ) {
177 $this->userpageUrlDetails = self::makeUrlDetails( $this->userpage );
178 } else {
179 # This won't be used in the standard skins, but we define it to preserve the interface
180 # To save time, we check for existence
181 $this->userpageUrlDetails = self::makeKnownUrlDetails( $this->userpage );
182 }
183
184 wfProfileOut( __METHOD__ . '-stuff' );
185
186 wfProfileIn( __METHOD__ . '-stuff-head' );
187 if ( !$this->useHeadElement ) {
188 $tpl->set( 'pagecss', false );
189 $tpl->set( 'usercss', false );
190
191 $tpl->set( 'userjs', false );
192 $tpl->set( 'userjsprev', false );
193
194 $tpl->set( 'jsvarurl', false );
195
196 $tpl->setRef( 'xhtmldefaultnamespace', $wgXhtmlDefaultNamespace );
197 $tpl->set( 'xhtmlnamespaces', $wgXhtmlNamespaces );
198 $tpl->set( 'html5version', $wgHtml5Version );
199 $tpl->set( 'headlinks', $out->getHeadLinks() );
200 $tpl->set( 'csslinks', $out->buildCssLinks() );
201 $tpl->set( 'pageclass', $this->getPageClasses( $title ) );
202 $tpl->set( 'skinnameclass', ( 'skin-' . Sanitizer::escapeClass( $this->getSkinName() ) ) );
203 }
204 wfProfileOut( __METHOD__ . '-stuff-head' );
205
206 wfProfileIn( __METHOD__ . '-stuff2' );
207 $tpl->set( 'title', $out->getPageTitle() );
208 $tpl->set( 'pagetitle', $out->getHTMLTitle() );
209 $tpl->set( 'displaytitle', $out->mPageLinkTitle );
210
211 $tpl->setRef( 'thispage', $this->thispage );
212 $tpl->setRef( 'titleprefixeddbkey', $this->thispage );
213 $tpl->set( 'titletext', $title->getText() );
214 $tpl->set( 'articleid', $title->getArticleID() );
215
216 $tpl->set( 'isarticle', $out->isArticle() );
217
218 $subpagestr = $this->subPageSubtitle();
219 if ( $subpagestr !== '' ) {
220 $subpagestr = '<span class="subpages">' . $subpagestr . '</span>';
221 }
222 $tpl->set( 'subtitle', $subpagestr . $out->getSubtitle() );
223
224 $undelete = $this->getUndeleteLink();
225 if ( $undelete === '' ) {
226 $tpl->set( 'undelete', '' );
227 } else {
228 $tpl->set( 'undelete', '<span class="subpages">' . $undelete . '</span>' );
229 }
230
231 $tpl->set( 'catlinks', $this->getCategories() );
232 if( $out->isSyndicated() ) {
233 $feeds = array();
234 foreach( $out->getSyndicationLinks() as $format => $link ) {
235 $feeds[$format] = array(
236 'text' => $this->msg( "feed-$format" )->text(),
237 'href' => $link
238 );
239 }
240 $tpl->setRef( 'feeds', $feeds );
241 } else {
242 $tpl->set( 'feeds', false );
243 }
244
245 $tpl->setRef( 'mimetype', $wgMimeType );
246 $tpl->setRef( 'jsmimetype', $wgJsMimeType );
247 $tpl->set( 'charset', 'UTF-8' );
248 $tpl->setRef( 'wgScript', $wgScript );
249 $tpl->setRef( 'skinname', $this->skinname );
250 $tpl->set( 'skinclass', get_class( $this ) );
251 $tpl->setRef( 'skin', $this );
252 $tpl->setRef( 'stylename', $this->stylename );
253 $tpl->set( 'printable', $out->isPrintable() );
254 $tpl->set( 'handheld', $request->getBool( 'handheld' ) );
255 $tpl->setRef( 'loggedin', $this->loggedin );
256 $tpl->set( 'notspecialpage', !$title->isSpecialPage() );
257 /* XXX currently unused, might get useful later
258 $tpl->set( 'editable', ( !$title->isSpecialPage() ) );
259 $tpl->set( 'exists', $title->getArticleID() != 0 );
260 $tpl->set( 'watch', $user->isWatched( $title ) ? 'unwatch' : 'watch' );
261 $tpl->set( 'protect', count( $title->isProtected() ) ? 'unprotect' : 'protect' );
262 $tpl->set( 'helppage', $this->msg( 'helppage' )->text() );
263 */
264 $tpl->set( 'searchaction', $this->escapeSearchLink() );
265 $tpl->set( 'searchtitle', SpecialPage::getTitleFor( 'Search' )->getPrefixedDBkey() );
266 $tpl->set( 'search', trim( $request->getVal( 'search' ) ) );
267 $tpl->setRef( 'stylepath', $wgStylePath );
268 $tpl->setRef( 'articlepath', $wgArticlePath );
269 $tpl->setRef( 'scriptpath', $wgScriptPath );
270 $tpl->setRef( 'serverurl', $wgServer );
271 $tpl->setRef( 'logopath', $wgLogo );
272 $tpl->setRef( 'sitename', $wgSitename );
273
274 $userLang = $this->getLanguage();
275 $userLangCode = $userLang->getHtmlCode();
276 $userLangDir = $userLang->getDir();
277
278 $tpl->set( 'lang', $userLangCode );
279 $tpl->set( 'dir', $userLangDir );
280 $tpl->set( 'rtl', $userLang->isRTL() );
281
282 $tpl->set( 'capitalizeallnouns', $userLang->capitalizeAllNouns() ? ' capitalize-all-nouns' : '' );
283 $tpl->set( 'showjumplinks', $user->getOption( 'showjumplinks' ) );
284 $tpl->set( 'username', $this->loggedin ? $this->username : null );
285 $tpl->setRef( 'userpage', $this->userpage );
286 $tpl->setRef( 'userpageurl', $this->userpageUrlDetails['href'] );
287 $tpl->set( 'userlang', $userLangCode );
288
289 // Users can have their language set differently than the
290 // content of the wiki. For these users, tell the web browser
291 // that interface elements are in a different language.
292 $tpl->set( 'userlangattributes', '' );
293 $tpl->set( 'specialpageattributes', '' ); # obsolete
294
295 if ( $userLangCode !== $wgContLang->getHtmlCode() || $userLangDir !== $wgContLang->getDir() ) {
296 $escUserlang = htmlspecialchars( $userLangCode );
297 $escUserdir = htmlspecialchars( $userLangDir );
298 // Attributes must be in double quotes because htmlspecialchars() doesn't
299 // escape single quotes
300 $attrs = " lang=\"$escUserlang\" dir=\"$escUserdir\"";
301 $tpl->set( 'userlangattributes', $attrs );
302 }
303
304 wfProfileOut( __METHOD__ . '-stuff2' );
305
306 wfProfileIn( __METHOD__ . '-stuff3' );
307 $tpl->set( 'newtalk', $this->getNewtalks() );
308 $tpl->set( 'logo', $this->logoText() );
309
310 $tpl->set( 'copyright', false );
311 $tpl->set( 'viewcount', false );
312 $tpl->set( 'lastmod', false );
313 $tpl->set( 'credits', false );
314 $tpl->set( 'numberofwatchingusers', false );
315 if ( $out->isArticle() && $title->exists() ) {
316 if ( $this->isRevisionCurrent() ) {
317 if ( !$wgDisableCounters ) {
318 $viewcount = $this->getWikiPage()->getCount();
319 if ( $viewcount ) {
320 $tpl->set( 'viewcount', $this->msg( 'viewcount' )->numParams( $viewcount )->parse() );
321 }
322 }
323
324 if ( $wgPageShowWatchingUsers ) {
325 $dbr = wfGetDB( DB_SLAVE );
326 $num = $dbr->selectField( 'watchlist', 'COUNT(*)',
327 array( 'wl_title' => $title->getDBkey(), 'wl_namespace' => $title->getNamespace() ),
328 __METHOD__
329 );
330 if ( $num > 0 ) {
331 $tpl->set( 'numberofwatchingusers',
332 $this->msg( 'number_of_watching_users_pageview' )->numParams( $num )->parse()
333 );
334 }
335 }
336
337 if ( $wgMaxCredits != 0 ) {
338 $tpl->set( 'credits', Action::factory( 'credits', $this->getWikiPage(),
339 $this->getContext() )->getCredits( $wgMaxCredits, $wgShowCreditsIfMax ) );
340 } else {
341 $tpl->set( 'lastmod', $this->lastModified() );
342 }
343 }
344 $tpl->set( 'copyright', $this->getCopyright() );
345 }
346 wfProfileOut( __METHOD__ . '-stuff3' );
347
348 wfProfileIn( __METHOD__ . '-stuff4' );
349 $tpl->set( 'copyrightico', $this->getCopyrightIcon() );
350 $tpl->set( 'poweredbyico', $this->getPoweredBy() );
351 $tpl->set( 'disclaimer', $this->disclaimerLink() );
352 $tpl->set( 'privacy', $this->privacyLink() );
353 $tpl->set( 'about', $this->aboutLink() );
354
355 $tpl->set( 'footerlinks', array(
356 'info' => array(
357 'lastmod',
358 'viewcount',
359 'numberofwatchingusers',
360 'credits',
361 'copyright',
362 ),
363 'places' => array(
364 'privacy',
365 'about',
366 'disclaimer',
367 ),
368 ) );
369
370 global $wgFooterIcons;
371 $tpl->set( 'footericons', $wgFooterIcons );
372 foreach ( $tpl->data['footericons'] as $footerIconsKey => &$footerIconsBlock ) {
373 if ( count( $footerIconsBlock ) > 0 ) {
374 foreach ( $footerIconsBlock as &$footerIcon ) {
375 if ( isset( $footerIcon['src'] ) ) {
376 if ( !isset( $footerIcon['width'] ) ) {
377 $footerIcon['width'] = 88;
378 }
379 if ( !isset( $footerIcon['height'] ) ) {
380 $footerIcon['height'] = 31;
381 }
382 }
383 }
384 } else {
385 unset( $tpl->data['footericons'][$footerIconsKey] );
386 }
387 }
388
389 $tpl->set( 'sitenotice', $this->getSiteNotice() );
390 $tpl->set( 'bottomscripts', $this->bottomScripts() );
391 $tpl->set( 'printfooter', $this->printSource() );
392
393 # An ID that includes the actual body text; without categories, contentSub, ...
394 $realBodyAttribs = array( 'id' => 'mw-content-text' );
395
396 # Add a mw-content-ltr/rtl class to be able to style based on text direction
397 # when the content is different from the UI language, i.e.:
398 # not for special pages or file pages AND only when viewing AND if the page exists
399 # (or is in MW namespace, because that has default content)
400 if ( !in_array( $title->getNamespace(), array( NS_SPECIAL, NS_FILE ) ) &&
401 Action::getActionName( $this ) === 'view' &&
402 ( $title->exists() || $title->getNamespace() == NS_MEDIAWIKI ) ) {
403 $pageLang = $title->getPageViewLanguage();
404 $realBodyAttribs['lang'] = $pageLang->getHtmlCode();
405 $realBodyAttribs['dir'] = $pageLang->getDir();
406 $realBodyAttribs['class'] = 'mw-content-' . $pageLang->getDir();
407 }
408
409 $out->mBodytext = Html::rawElement( 'div', $realBodyAttribs, $out->mBodytext );
410 $tpl->setRef( 'bodytext', $out->mBodytext );
411
412 # Language links
413 $language_urls = array();
414
415 if ( !$wgHideInterlanguageLinks ) {
416 foreach( $out->getLanguageLinks() as $languageLinkText ) {
417 $languageLinkParts = explode( ':', $languageLinkText, 2 );
418 $class = 'interwiki-' . $languageLinkParts[0];
419 unset( $languageLinkParts );
420 $languageLinkTitle = Title::newFromText( $languageLinkText );
421 if ( $languageLinkTitle ) {
422 $ilInterwikiCode = $languageLinkTitle->getInterwiki();
423 $ilLangName = Language::fetchLanguageName( $ilInterwikiCode );
424
425 if ( strval( $ilLangName ) === '' ) {
426 $ilLangName = $languageLinkText;
427 } else {
428 $ilLangName = $this->formatLanguageName( $ilLangName );
429 }
430
431 $language_urls[] = array(
432 'href' => $languageLinkTitle->getFullURL(),
433 'text' => $ilLangName,
434 'title' => $languageLinkTitle->getText(),
435 'class' => $class,
436 'lang' => $ilInterwikiCode,
437 'hreflang' => $ilInterwikiCode
438 );
439 }
440 }
441 }
442 if ( count( $language_urls ) ) {
443 $tpl->setRef( 'language_urls', $language_urls );
444 } else {
445 $tpl->set( 'language_urls', false );
446 }
447 wfProfileOut( __METHOD__ . '-stuff4' );
448
449 wfProfileIn( __METHOD__ . '-stuff5' );
450 # Personal toolbar
451 $tpl->set( 'personal_urls', $this->buildPersonalUrls() );
452 $content_navigation = $this->buildContentNavigationUrls();
453 $content_actions = $this->buildContentActionUrls( $content_navigation );
454 $tpl->setRef( 'content_navigation', $content_navigation );
455 $tpl->setRef( 'content_actions', $content_actions );
456
457 $tpl->set( 'sidebar', $this->buildSidebar() );
458 $tpl->set( 'nav_urls', $this->buildNavUrls() );
459
460 // Set the head scripts near the end, in case the above actions resulted in added scripts
461 if ( $this->useHeadElement ) {
462 $tpl->set( 'headelement', $out->headElement( $this ) );
463 } else {
464 $tpl->set( 'headscripts', $out->getHeadScripts() . $out->getHeadItems() );
465 }
466
467 $tpl->set( 'debug', '' );
468 $tpl->set( 'debughtml', $this->generateDebugHTML() );
469 $tpl->set( 'reporttime', wfReportTime() );
470
471 // original version by hansm
472 if( !wfRunHooks( 'SkinTemplateOutputPageBeforeExec', array( &$this, &$tpl ) ) ) {
473 wfDebug( __METHOD__ . ": Hook SkinTemplateOutputPageBeforeExec broke outputPage execution!\n" );
474 }
475
476 // Set the bodytext to another key so that skins can just output it on it's own
477 // and output printfooter and debughtml separately
478 $tpl->set( 'bodycontent', $tpl->data['bodytext'] );
479
480 // Append printfooter and debughtml onto bodytext so that skins that were already
481 // using bodytext before they were split out don't suddenly start not outputting information
482 $tpl->data['bodytext'] .= Html::rawElement( 'div', array( 'class' => 'printfooter' ), "\n{$tpl->data['printfooter']}" ) . "\n";
483 $tpl->data['bodytext'] .= $tpl->data['debughtml'];
484
485 // allow extensions adding stuff after the page content.
486 // See Skin::afterContentHook() for further documentation.
487 $tpl->set( 'dataAfterContent', $this->afterContentHook() );
488 wfProfileOut( __METHOD__ . '-stuff5' );
489
490 // execute template
491 wfProfileIn( __METHOD__ . '-execute' );
492 $res = $tpl->execute();
493 wfProfileOut( __METHOD__ . '-execute' );
494
495 // result may be an error
496 $this->printOrError( $res );
497
498 if ( $oldContext ) {
499 $this->setContext( $oldContext );
500 }
501 wfProfileOut( __METHOD__ );
502 }
503
504 /**
505 * Format language name for use in sidebar interlanguage links list.
506 * By default it is capitalized.
507 *
508 * @param string $name Language name, e.g. "English" or "español"
509 * @return string
510 * @private
511 */
512 function formatLanguageName( $name ) {
513 return $this->getLanguage()->ucfirst( $name );
514 }
515
516 /**
517 * Output the string, or print error message if it's
518 * an error object of the appropriate type.
519 * For the base class, assume strings all around.
520 *
521 * @param $str Mixed
522 * @private
523 */
524 function printOrError( $str ) {
525 echo $str;
526 }
527
528 /**
529 * Output a boolean indicating if buildPersonalUrls should output separate
530 * login and create account links or output a combined link
531 * By default we simply return a global config setting that affects most skins
532 * This is setup as a method so that like with $wgLogo and getLogo() a skin
533 * can override this setting and always output one or the other if it has
534 * a reason it can't output one of the two modes.
535 * @return bool
536 */
537 function useCombinedLoginLink() {
538 global $wgUseCombinedLoginLink;
539 return $wgUseCombinedLoginLink;
540 }
541
542 /**
543 * build array of urls for personal toolbar
544 * @return array
545 */
546 protected function buildPersonalUrls() {
547 global $wgSecureLogin;
548
549 $title = $this->getTitle();
550 $request = $this->getRequest();
551 $pageurl = $title->getLocalURL();
552 wfProfileIn( __METHOD__ );
553
554 /* set up the default links for the personal toolbar */
555 $personal_urls = array();
556
557 # Due to bug 32276, if a user does not have read permissions,
558 # $this->getTitle() will just give Special:Badtitle, which is
559 # not especially useful as a returnto parameter. Use the title
560 # from the request instead, if there was one.
561 if ( $this->getUser()->isAllowed( 'read' ) ) {
562 $page = $this->getTitle();
563 } else {
564 $page = Title::newFromText( $request->getVal( 'title', '' ) );
565 }
566 $page = $request->getVal( 'returnto', $page );
567 $a = array();
568 if ( strval( $page ) !== '' ) {
569 $a['returnto'] = $page;
570 $query = $request->getVal( 'returntoquery', $this->thisquery );
571 if( $query != '' ) {
572 $a['returntoquery'] = $query;
573 }
574 }
575
576 if ( $wgSecureLogin && $request->detectProtocol() === 'https' ) {
577 $a['wpStickHTTPS'] = true;
578 }
579
580 $returnto = wfArrayToCgi( $a );
581 if( $this->loggedin ) {
582 $personal_urls['userpage'] = array(
583 'text' => $this->username,
584 'href' => &$this->userpageUrlDetails['href'],
585 'class' => $this->userpageUrlDetails['exists'] ? false : 'new',
586 'active' => ( $this->userpageUrlDetails['href'] == $pageurl ),
587 'dir' => 'auto'
588 );
589 $usertalkUrlDetails = $this->makeTalkUrlDetails( $this->userpage );
590 $personal_urls['mytalk'] = array(
591 'text' => $this->msg( 'mytalk' )->text(),
592 'href' => &$usertalkUrlDetails['href'],
593 'class' => $usertalkUrlDetails['exists'] ? false : 'new',
594 'active' => ( $usertalkUrlDetails['href'] == $pageurl )
595 );
596 $href = self::makeSpecialUrl( 'Preferences' );
597 $personal_urls['preferences'] = array(
598 'text' => $this->msg( 'mypreferences' )->text(),
599 'href' => $href,
600 'active' => ( $href == $pageurl )
601 );
602 $href = self::makeSpecialUrl( 'Watchlist' );
603 $personal_urls['watchlist'] = array(
604 'text' => $this->msg( 'mywatchlist' )->text(),
605 'href' => $href,
606 'active' => ( $href == $pageurl )
607 );
608
609 # We need to do an explicit check for Special:Contributions, as we
610 # have to match both the title, and the target, which could come
611 # from request values (Special:Contributions?target=Jimbo_Wales)
612 # or be specified in "sub page" form
613 # (Special:Contributions/Jimbo_Wales). The plot
614 # thickens, because the Title object is altered for special pages,
615 # so it doesn't contain the original alias-with-subpage.
616 $origTitle = Title::newFromText( $request->getText( 'title' ) );
617 if( $origTitle instanceof Title && $origTitle->isSpecialPage() ) {
618 list( $spName, $spPar ) = SpecialPageFactory::resolveAlias( $origTitle->getText() );
619 $active = $spName == 'Contributions'
620 && ( ( $spPar && $spPar == $this->username )
621 || $request->getText( 'target' ) == $this->username );
622 } else {
623 $active = false;
624 }
625
626 $href = self::makeSpecialUrlSubpage( 'Contributions', $this->username );
627 $personal_urls['mycontris'] = array(
628 'text' => $this->msg( 'mycontris' )->text(),
629 'href' => $href,
630 'active' => $active
631 );
632 $personal_urls['logout'] = array(
633 'text' => $this->msg( 'userlogout' )->text(),
634 'href' => self::makeSpecialUrl( 'Userlogout',
635 // userlogout link must always contain an & character, otherwise we might not be able
636 // to detect a buggy precaching proxy (bug 17790)
637 $title->isSpecial( 'Preferences' ) ? 'noreturnto' : $returnto
638 ),
639 'active' => false
640 );
641 } else {
642 $useCombinedLoginLink = $this->useCombinedLoginLink();
643 $loginlink = $this->getUser()->isAllowed( 'createaccount' ) && $useCombinedLoginLink
644 ? 'nav-login-createaccount'
645 : 'login';
646 $is_signup = $request->getText( 'type' ) == 'signup';
647
648 # anonlogin & login are the same
649 $proto = $wgSecureLogin ? PROTO_HTTPS : null;
650
651 $login_id = $this->showIPinHeader() ? 'anonlogin' : 'login';
652 $login_url = array(
653 'text' => $this->msg( $loginlink )->text(),
654 'href' => self::makeSpecialUrl( 'Userlogin', $returnto, $proto ),
655 'active' => $title->isSpecial( 'Userlogin' ) && ( $loginlink == 'nav-login-createaccount' || !$is_signup ),
656 'class' => $wgSecureLogin ? 'link-https' : ''
657 );
658 $createaccount_url = array(
659 'text' => $this->msg( 'createaccount' )->text(),
660 'href' => self::makeSpecialUrl( 'Userlogin', "$returnto&type=signup", $proto ),
661 'active' => $title->isSpecial( 'Userlogin' ) && $is_signup,
662 'class' => $wgSecureLogin ? 'link-https' : ''
663 );
664
665 if( $this->showIPinHeader() ) {
666 $href = &$this->userpageUrlDetails['href'];
667 $personal_urls['anonuserpage'] = array(
668 'text' => $this->username,
669 'href' => $href,
670 'class' => $this->userpageUrlDetails['exists'] ? false : 'new',
671 'active' => ( $pageurl == $href )
672 );
673 $usertalkUrlDetails = $this->makeTalkUrlDetails( $this->userpage );
674 $href = &$usertalkUrlDetails['href'];
675 $personal_urls['anontalk'] = array(
676 'text' => $this->msg( 'anontalk' )->text(),
677 'href' => $href,
678 'class' => $usertalkUrlDetails['exists'] ? false : 'new',
679 'active' => ( $pageurl == $href )
680 );
681 }
682
683 if ( $this->getUser()->isAllowed( 'createaccount' ) && !$useCombinedLoginLink ) {
684 $personal_urls['createaccount'] = $createaccount_url;
685 }
686
687 $personal_urls[$login_id] = $login_url;
688 }
689
690 wfRunHooks( 'PersonalUrls', array( &$personal_urls, &$title ) );
691 wfProfileOut( __METHOD__ );
692 return $personal_urls;
693 }
694
695 /**
696 * Builds an array with tab definition
697 *
698 * @param Title $title page where the tab links to
699 * @param string|array $message message key or an array of message keys (will fall back)
700 * @param boolean $selected display the tab as selected
701 * @param string $query query string attached to tab URL
702 * @param boolean $checkEdit check if $title exists and mark with .new if one doesn't
703 *
704 * @return array
705 */
706 function tabAction( $title, $message, $selected, $query = '', $checkEdit = false ) {
707 $classes = array();
708 if( $selected ) {
709 $classes[] = 'selected';
710 }
711 if( $checkEdit && !$title->isKnown() ) {
712 $classes[] = 'new';
713 if ( $query !== '' ) {
714 $query = 'action=edit&redlink=1&' . $query;
715 } else {
716 $query = 'action=edit&redlink=1';
717 }
718 }
719
720 // wfMessageFallback will nicely accept $message as an array of fallbacks
721 // or just a single key
722 $msg = wfMessageFallback( $message )->setContext( $this->getContext() );
723 if ( is_array( $message ) ) {
724 // for hook compatibility just keep the last message name
725 $message = end( $message );
726 }
727 if ( $msg->exists() ) {
728 $text = $msg->text();
729 } else {
730 global $wgContLang;
731 $text = $wgContLang->getFormattedNsText(
732 MWNamespace::getSubject( $title->getNamespace() ) );
733 }
734
735 $result = array();
736 if( !wfRunHooks( 'SkinTemplateTabAction', array( &$this,
737 $title, $message, $selected, $checkEdit,
738 &$classes, &$query, &$text, &$result ) ) ) {
739 return $result;
740 }
741
742 return array(
743 'class' => implode( ' ', $classes ),
744 'text' => $text,
745 'href' => $title->getLocalURL( $query ),
746 'primary' => true );
747 }
748
749 function makeTalkUrlDetails( $name, $urlaction = '' ) {
750 $title = Title::newFromText( $name );
751 if( !is_object( $title ) ) {
752 throw new MWException( __METHOD__ . " given invalid pagename $name" );
753 }
754 $title = $title->getTalkPage();
755 self::checkTitle( $title, $name );
756 return array(
757 'href' => $title->getLocalURL( $urlaction ),
758 'exists' => $title->getArticleID() != 0,
759 );
760 }
761
762 function makeArticleUrlDetails( $name, $urlaction = '' ) {
763 $title = Title::newFromText( $name );
764 $title = $title->getSubjectPage();
765 self::checkTitle( $title, $name );
766 return array(
767 'href' => $title->getLocalURL( $urlaction ),
768 'exists' => $title->getArticleID() != 0,
769 );
770 }
771
772 /**
773 * a structured array of links usually used for the tabs in a skin
774 *
775 * There are 4 standard sections
776 * namespaces: Used for namespace tabs like special, page, and talk namespaces
777 * views: Used for primary page views like read, edit, history
778 * actions: Used for most extra page actions like deletion, protection, etc...
779 * variants: Used to list the language variants for the page
780 *
781 * Each section's value is a key/value array of links for that section.
782 * The links themselves have these common keys:
783 * - class: The css classes to apply to the tab
784 * - text: The text to display on the tab
785 * - href: The href for the tab to point to
786 * - rel: An optional rel= for the tab's link
787 * - redundant: If true the tab will be dropped in skins using content_actions
788 * this is useful for tabs like "Read" which only have meaning in skins that
789 * take special meaning from the grouped structure of content_navigation
790 *
791 * Views also have an extra key which can be used:
792 * - primary: If this is not true skins like vector may try to hide the tab
793 * when the user has limited space in their browser window
794 *
795 * content_navigation using code also expects these ids to be present on the
796 * links, however these are usually automatically generated by SkinTemplate
797 * itself and are not necessary when using a hook. The only things these may
798 * matter to are people modifying content_navigation after it's initial creation:
799 * - id: A "preferred" id, most skins are best off outputting this preferred id for best compatibility
800 * - tooltiponly: This is set to true for some tabs in cases where the system
801 * believes that the accesskey should not be added to the tab.
802 *
803 * @return array
804 */
805 protected function buildContentNavigationUrls() {
806 global $wgDisableLangConversion;
807
808 wfProfileIn( __METHOD__ );
809
810 // Display tabs for the relevant title rather than always the title itself
811 $title = $this->getRelevantTitle();
812 $onPage = $title->equals( $this->getTitle() );
813
814 $out = $this->getOutput();
815 $request = $this->getRequest();
816 $user = $this->getUser();
817
818 $content_navigation = array(
819 'namespaces' => array(),
820 'views' => array(),
821 'actions' => array(),
822 'variants' => array()
823 );
824
825 // parameters
826 $action = $request->getVal( 'action', 'view' );
827
828 $userCanRead = $title->quickUserCan( 'read', $user );
829
830 $preventActiveTabs = false;
831 wfRunHooks( 'SkinTemplatePreventOtherActiveTabs', array( &$this, &$preventActiveTabs ) );
832
833 // Checks if page is some kind of content
834 if( $title->canExist() ) {
835 // Gets page objects for the related namespaces
836 $subjectPage = $title->getSubjectPage();
837 $talkPage = $title->getTalkPage();
838
839 // Determines if this is a talk page
840 $isTalk = $title->isTalkPage();
841
842 // Generates XML IDs from namespace names
843 $subjectId = $title->getNamespaceKey( '' );
844
845 if ( $subjectId == 'main' ) {
846 $talkId = 'talk';
847 } else {
848 $talkId = "{$subjectId}_talk";
849 }
850
851 $skname = $this->skinname;
852
853 // Adds namespace links
854 $subjectMsg = array( "nstab-$subjectId" );
855 if ( $subjectPage->isMainPage() ) {
856 array_unshift( $subjectMsg, 'mainpage-nstab' );
857 }
858 $content_navigation['namespaces'][$subjectId] = $this->tabAction(
859 $subjectPage, $subjectMsg, !$isTalk && !$preventActiveTabs, '', $userCanRead
860 );
861 $content_navigation['namespaces'][$subjectId]['context'] = 'subject';
862 $content_navigation['namespaces'][$talkId] = $this->tabAction(
863 $talkPage, array( "nstab-$talkId", 'talk' ), $isTalk && !$preventActiveTabs, '', $userCanRead
864 );
865 $content_navigation['namespaces'][$talkId]['context'] = 'talk';
866
867 if ( $userCanRead ) {
868 // Adds view view link
869 if ( $title->exists() ) {
870 $content_navigation['views']['view'] = $this->tabAction(
871 $isTalk ? $talkPage : $subjectPage,
872 array( "$skname-view-view", 'view' ),
873 ( $onPage && ( $action == 'view' || $action == 'purge' ) ), '', true
874 );
875 // signal to hide this from simple content_actions
876 $content_navigation['views']['view']['redundant'] = true;
877 }
878
879 wfProfileIn( __METHOD__ . '-edit' );
880
881 // Checks if user can edit the current page if it exists or create it otherwise
882 if ( $title->quickUserCan( 'edit', $user ) && ( $title->exists() || $title->quickUserCan( 'create', $user ) ) ) {
883 // Builds CSS class for talk page links
884 $isTalkClass = $isTalk ? ' istalk' : '';
885 // Whether the user is editing the page
886 $isEditing = $onPage && ( $action == 'edit' || $action == 'submit' );
887 // Whether to show the "Add a new section" tab
888 // Checks if this is a current rev of talk page and is not forced to be hidden
889 $showNewSection = !$out->forceHideNewSectionLink()
890 && ( ( $isTalk && $this->isRevisionCurrent() ) || $out->showNewSectionLink() );
891 $section = $request->getVal( 'section' );
892
893 $msgKey = $title->exists() || ( $title->getNamespace() == NS_MEDIAWIKI && $title->getDefaultMessageText() !== false ) ?
894 'edit' : 'create';
895 $content_navigation['views']['edit'] = array(
896 'class' => ( $isEditing && ( $section !== 'new' || !$showNewSection ) ? 'selected' : '' ) . $isTalkClass,
897 'text' => wfMessageFallback( "$skname-view-$msgKey", $msgKey )->setContext( $this->getContext() )->text(),
898 'href' => $title->getLocalURL( $this->editUrlOptions() ),
899 'primary' => true, // don't collapse this in vector
900 );
901
902 // section link
903 if ( $showNewSection ) {
904 // Adds new section link
905 //$content_navigation['actions']['addsection']
906 $content_navigation['views']['addsection'] = array(
907 'class' => ( $isEditing && $section == 'new' ) ? 'selected' : false,
908 'text' => wfMessageFallback( "$skname-action-addsection", 'addsection' )->setContext( $this->getContext() )->text(),
909 'href' => $title->getLocalURL( 'action=edit&section=new' )
910 );
911 }
912 // Checks if the page has some kind of viewable content
913 } elseif ( $title->hasSourceText() ) {
914 // Adds view source view link
915 $content_navigation['views']['viewsource'] = array(
916 'class' => ( $onPage && $action == 'edit' ) ? 'selected' : false,
917 'text' => wfMessageFallback( "$skname-action-viewsource", 'viewsource' )->setContext( $this->getContext() )->text(),
918 'href' => $title->getLocalURL( $this->editUrlOptions() ),
919 'primary' => true, // don't collapse this in vector
920 );
921 }
922 wfProfileOut( __METHOD__ . '-edit' );
923
924 wfProfileIn( __METHOD__ . '-live' );
925 // Checks if the page exists
926 if ( $title->exists() ) {
927 // Adds history view link
928 $content_navigation['views']['history'] = array(
929 'class' => ( $onPage && $action == 'history' ) ? 'selected' : false,
930 'text' => wfMessageFallback( "$skname-view-history", 'history_short' )->setContext( $this->getContext() )->text(),
931 'href' => $title->getLocalURL( 'action=history' ),
932 'rel' => 'archives',
933 );
934
935 if ( $title->quickUserCan( 'delete', $user ) ) {
936 $content_navigation['actions']['delete'] = array(
937 'class' => ( $onPage && $action == 'delete' ) ? 'selected' : false,
938 'text' => wfMessageFallback( "$skname-action-delete", 'delete' )->setContext( $this->getContext() )->text(),
939 'href' => $title->getLocalURL( 'action=delete' )
940 );
941 }
942
943 if ( $title->quickUserCan( 'move', $user ) ) {
944 $moveTitle = SpecialPage::getTitleFor( 'Movepage', $title->getPrefixedDBkey() );
945 $content_navigation['actions']['move'] = array(
946 'class' => $this->getTitle()->isSpecial( 'Movepage' ) ? 'selected' : false,
947 'text' => wfMessageFallback( "$skname-action-move", 'move' )->setContext( $this->getContext() )->text(),
948 'href' => $moveTitle->getLocalURL()
949 );
950 }
951 } else {
952 // article doesn't exist or is deleted
953 if ( $user->isAllowed( 'deletedhistory' ) ) {
954 $n = $title->isDeleted();
955 if ( $n ) {
956 $undelTitle = SpecialPage::getTitleFor( 'Undelete' );
957 // If the user can't undelete but can view deleted history show them a "View .. deleted" tab instead
958 $msgKey = $user->isAllowed( 'undelete' ) ? 'undelete' : 'viewdeleted';
959 $content_navigation['actions']['undelete'] = array(
960 'class' => $this->getTitle()->isSpecial( 'Undelete' ) ? 'selected' : false,
961 'text' => wfMessageFallback( "$skname-action-$msgKey", "{$msgKey}_short" )
962 ->setContext( $this->getContext() )->numParams( $n )->text(),
963 'href' => $undelTitle->getLocalURL( array( 'target' => $title->getPrefixedDBkey() ) )
964 );
965 }
966 }
967 }
968
969 if ( $title->getNamespace() !== NS_MEDIAWIKI && $title->quickUserCan( 'protect', $user ) && $title->getRestrictionTypes() ) {
970 $mode = $title->isProtected() ? 'unprotect' : 'protect';
971 $content_navigation['actions'][$mode] = array(
972 'class' => ( $onPage && $action == $mode ) ? 'selected' : false,
973 'text' => wfMessageFallback( "$skname-action-$mode", $mode )->setContext( $this->getContext() )->text(),
974 'href' => $title->getLocalURL( "action=$mode" )
975 );
976 }
977
978 wfProfileOut( __METHOD__ . '-live' );
979
980 // Checks if the user is logged in
981 if ( $this->loggedin ) {
982 /**
983 * The following actions use messages which, if made particular to
984 * the any specific skins, would break the Ajax code which makes this
985 * action happen entirely inline. Skin::makeGlobalVariablesScript
986 * defines a set of messages in a javascript object - and these
987 * messages are assumed to be global for all skins. Without making
988 * a change to that procedure these messages will have to remain as
989 * the global versions.
990 */
991 $mode = $user->isWatched( $title ) ? 'unwatch' : 'watch';
992 $token = WatchAction::getWatchToken( $title, $user, $mode );
993 $content_navigation['actions'][$mode] = array(
994 'class' => $onPage && ( $action == 'watch' || $action == 'unwatch' ) ? 'selected' : false,
995 // uses 'watch' or 'unwatch' message
996 'text' => $this->msg( $mode )->text(),
997 'href' => $title->getLocalURL( array( 'action' => $mode, 'token' => $token ) )
998 );
999 }
1000 }
1001
1002 wfRunHooks( 'SkinTemplateNavigation', array( &$this, &$content_navigation ) );
1003
1004 if ( $userCanRead && !$wgDisableLangConversion ) {
1005 $pageLang = $title->getPageLanguage();
1006 // Gets list of language variants
1007 $variants = $pageLang->getVariants();
1008 // Checks that language conversion is enabled and variants exist
1009 // And if it is not in the special namespace
1010 if ( count( $variants ) > 1 ) {
1011 // Gets preferred variant (note that user preference is
1012 // only possible for wiki content language variant)
1013 $preferred = $pageLang->getPreferredVariant();
1014 if ( Action::getActionName( $this ) === 'view' ) {
1015 $params = $request->getQueryValues();
1016 unset( $params['title'] );
1017 } else {
1018 $params = array();
1019 }
1020 // Loops over each variant
1021 foreach( $variants as $code ) {
1022 // Gets variant name from language code
1023 $varname = $pageLang->getVariantname( $code );
1024 // Appends variant link
1025 $content_navigation['variants'][] = array(
1026 'class' => ( $code == $preferred ) ? 'selected' : false,
1027 'text' => $varname,
1028 'href' => $title->getLocalURL( array( 'variant' => $code ) + $params ),
1029 'lang' => $code,
1030 'hreflang' => $code
1031 );
1032 }
1033 }
1034 }
1035 } else {
1036 // If it's not content, it's got to be a special page
1037 $content_navigation['namespaces']['special'] = array(
1038 'class' => 'selected',
1039 'text' => $this->msg( 'nstab-special' )->text(),
1040 'href' => $request->getRequestURL(), // @see: bug 2457, bug 2510
1041 'context' => 'subject'
1042 );
1043
1044 wfRunHooks( 'SkinTemplateNavigation::SpecialPage',
1045 array( &$this, &$content_navigation ) );
1046 }
1047
1048 // Equiv to SkinTemplateContentActions
1049 wfRunHooks( 'SkinTemplateNavigation::Universal', array( &$this, &$content_navigation ) );
1050
1051 // Setup xml ids and tooltip info
1052 foreach ( $content_navigation as $section => &$links ) {
1053 foreach ( $links as $key => &$link ) {
1054 $xmlID = $key;
1055 if ( isset( $link['context'] ) && $link['context'] == 'subject' ) {
1056 $xmlID = 'ca-nstab-' . $xmlID;
1057 } elseif ( isset( $link['context'] ) && $link['context'] == 'talk' ) {
1058 $xmlID = 'ca-talk';
1059 } elseif ( $section == 'variants' ) {
1060 $xmlID = 'ca-varlang-' . $xmlID;
1061 } else {
1062 $xmlID = 'ca-' . $xmlID;
1063 }
1064 $link['id'] = $xmlID;
1065 }
1066 }
1067
1068 # We don't want to give the watch tab an accesskey if the
1069 # page is being edited, because that conflicts with the
1070 # accesskey on the watch checkbox. We also don't want to
1071 # give the edit tab an accesskey, because that's fairly
1072 # superfluous and conflicts with an accesskey (Ctrl-E) often
1073 # used for editing in Safari.
1074 if ( in_array( $action, array( 'edit', 'submit' ) ) ) {
1075 if ( isset( $content_navigation['views']['edit'] ) ) {
1076 $content_navigation['views']['edit']['tooltiponly'] = true;
1077 }
1078 if ( isset( $content_navigation['actions']['watch'] ) ) {
1079 $content_navigation['actions']['watch']['tooltiponly'] = true;
1080 }
1081 if ( isset( $content_navigation['actions']['unwatch'] ) ) {
1082 $content_navigation['actions']['unwatch']['tooltiponly'] = true;
1083 }
1084 }
1085
1086 wfProfileOut( __METHOD__ );
1087
1088 return $content_navigation;
1089 }
1090
1091 /**
1092 * an array of edit links by default used for the tabs
1093 * @return array
1094 * @private
1095 */
1096 function buildContentActionUrls( $content_navigation ) {
1097
1098 wfProfileIn( __METHOD__ );
1099
1100 // content_actions has been replaced with content_navigation for backwards
1101 // compatibility and also for skins that just want simple tabs content_actions
1102 // is now built by flattening the content_navigation arrays into one
1103
1104 $content_actions = array();
1105
1106 foreach ( $content_navigation as $links ) {
1107
1108 foreach ( $links as $key => $value ) {
1109
1110 if ( isset( $value['redundant'] ) && $value['redundant'] ) {
1111 // Redundant tabs are dropped from content_actions
1112 continue;
1113 }
1114
1115 // content_actions used to have ids built using the "ca-$key" pattern
1116 // so the xmlID based id is much closer to the actual $key that we want
1117 // for that reason we'll just strip out the ca- if present and use
1118 // the latter potion of the "id" as the $key
1119 if ( isset( $value['id'] ) && substr( $value['id'], 0, 3 ) == 'ca-' ) {
1120 $key = substr( $value['id'], 3 );
1121 }
1122
1123 if ( isset( $content_actions[$key] ) ) {
1124 wfDebug( __METHOD__ . ": Found a duplicate key for $key while flattening content_navigation into content_actions." );
1125 continue;
1126 }
1127
1128 $content_actions[$key] = $value;
1129
1130 }
1131
1132 }
1133
1134 wfProfileOut( __METHOD__ );
1135
1136 return $content_actions;
1137 }
1138
1139 /**
1140 * build array of common navigation links
1141 * @return array
1142 * @private
1143 */
1144 protected function buildNavUrls() {
1145 global $wgUploadNavigationUrl;
1146
1147 wfProfileIn( __METHOD__ );
1148
1149 $out = $this->getOutput();
1150 $request = $this->getRequest();
1151
1152 $nav_urls = array();
1153 $nav_urls['mainpage'] = array( 'href' => self::makeMainPageUrl() );
1154 if( $wgUploadNavigationUrl ) {
1155 $nav_urls['upload'] = array( 'href' => $wgUploadNavigationUrl );
1156 } elseif( UploadBase::isEnabled() && UploadBase::isAllowed( $this->getUser() ) === true ) {
1157 $nav_urls['upload'] = array( 'href' => self::makeSpecialUrl( 'Upload' ) );
1158 } else {
1159 $nav_urls['upload'] = false;
1160 }
1161 $nav_urls['specialpages'] = array( 'href' => self::makeSpecialUrl( 'Specialpages' ) );
1162
1163 $nav_urls['print'] = false;
1164 $nav_urls['permalink'] = false;
1165 $nav_urls['info'] = false;
1166 $nav_urls['whatlinkshere'] = false;
1167 $nav_urls['recentchangeslinked'] = false;
1168 $nav_urls['contributions'] = false;
1169 $nav_urls['log'] = false;
1170 $nav_urls['blockip'] = false;
1171 $nav_urls['emailuser'] = false;
1172 $nav_urls['userrights'] = false;
1173
1174 // A print stylesheet is attached to all pages, but nobody ever
1175 // figures that out. :) Add a link...
1176 if ( $out->isArticle() ) {
1177 if ( !$out->isPrintable() ) {
1178 $nav_urls['print'] = array(
1179 'text' => $this->msg( 'printableversion' )->text(),
1180 'href' => $this->getTitle()->getLocalURL(
1181 $request->appendQueryValue( 'printable', 'yes', true ) )
1182 );
1183 }
1184
1185 // Also add a "permalink" while we're at it
1186 $revid = $this->getRevisionId();
1187 if ( $revid ) {
1188 $nav_urls['permalink'] = array(
1189 'text' => $this->msg( 'permalink' )->text(),
1190 'href' => $this->getTitle()->getLocalURL( "oldid=$revid" )
1191 );
1192 }
1193
1194 // Use the copy of revision ID in case this undocumented, shady hook tries to mess with internals
1195 wfRunHooks( 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink',
1196 array( &$this, &$nav_urls, &$revid, &$revid ) );
1197 }
1198
1199 if ( $out->isArticleRelated() ) {
1200 $nav_urls['whatlinkshere'] = array(
1201 'href' => SpecialPage::getTitleFor( 'Whatlinkshere', $this->thispage )->getLocalURL()
1202 );
1203
1204 $nav_urls['info'] = array(
1205 'text' => $this->msg( 'pageinfo-toolboxlink' )->text(),
1206 'href' => $this->getTitle()->getLocalURL( "action=info" )
1207 );
1208
1209 if ( $this->getTitle()->getArticleID() ) {
1210 $nav_urls['recentchangeslinked'] = array(
1211 'href' => SpecialPage::getTitleFor( 'Recentchangeslinked', $this->thispage )->getLocalURL()
1212 );
1213 }
1214 }
1215
1216 $user = $this->getRelevantUser();
1217 if ( $user ) {
1218 $rootUser = $user->getName();
1219
1220 $nav_urls['contributions'] = array(
1221 'text' => $this->msg( 'contributions', $rootUser )->text(),
1222 'href' => self::makeSpecialUrlSubpage( 'Contributions', $rootUser )
1223 );
1224
1225 $nav_urls['log'] = array(
1226 'href' => self::makeSpecialUrlSubpage( 'Log', $rootUser )
1227 );
1228
1229 if ( $this->getUser()->isAllowed( 'block' ) ) {
1230 $nav_urls['blockip'] = array(
1231 'href' => self::makeSpecialUrlSubpage( 'Block', $rootUser )
1232 );
1233 }
1234
1235 if ( $this->showEmailUser( $user ) ) {
1236 $nav_urls['emailuser'] = array(
1237 'href' => self::makeSpecialUrlSubpage( 'Emailuser', $rootUser )
1238 );
1239 }
1240
1241 $sur = new UserrightsPage;
1242 if ( $sur->userCanExecute( $this->getUser() ) ) {
1243 $nav_urls['userrights'] = array(
1244 'href' => self::makeSpecialUrlSubpage( 'Userrights', $rootUser )
1245 );
1246 }
1247 }
1248
1249 wfProfileOut( __METHOD__ );
1250 return $nav_urls;
1251 }
1252
1253 /**
1254 * Generate strings used for xml 'id' names
1255 * @return string
1256 * @private
1257 */
1258 function getNameSpaceKey() {
1259 return $this->getTitle()->getNamespaceKey();
1260 }
1261
1262 public function commonPrintStylesheet() {
1263 return false;
1264 }
1265 }
1266
1267 /**
1268 * Generic wrapper for template functions, with interface
1269 * compatible with what we use of PHPTAL 0.7.
1270 * @ingroup Skins
1271 */
1272 abstract class QuickTemplate {
1273 /**
1274 * Constructor
1275 */
1276 function __construct() {
1277 $this->data = array();
1278 $this->translator = new MediaWiki_I18N();
1279 }
1280
1281 /**
1282 * Sets the value $value to $name
1283 * @param $name
1284 * @param $value
1285 */
1286 public function set( $name, $value ) {
1287 $this->data[$name] = $value;
1288 }
1289
1290 /**
1291 * @param $name
1292 * @param $value
1293 */
1294 public function setRef( $name, &$value ) {
1295 $this->data[$name] =& $value;
1296 }
1297
1298 /**
1299 * @param $t
1300 */
1301 public function setTranslator( &$t ) {
1302 $this->translator = &$t;
1303 }
1304
1305 /**
1306 * Main function, used by classes that subclass QuickTemplate
1307 * to show the actual HTML output
1308 */
1309 abstract public function execute();
1310
1311 /**
1312 * @private
1313 */
1314 function text( $str ) {
1315 echo htmlspecialchars( $this->data[$str] );
1316 }
1317
1318 /**
1319 * @private
1320 * @deprecated since 1.21; use Xml::encodeJsVar() or Xml::encodeJsCall() instead
1321 */
1322 function jstext( $str ) {
1323 wfDeprecated( __METHOD__, '1.21' );
1324 echo Xml::escapeJsString( $this->data[$str] );
1325 }
1326
1327 /**
1328 * @private
1329 */
1330 function html( $str ) {
1331 echo $this->data[$str];
1332 }
1333
1334 /**
1335 * @private
1336 */
1337 function msg( $str ) {
1338 echo htmlspecialchars( $this->translator->translate( $str ) );
1339 }
1340
1341 /**
1342 * @private
1343 */
1344 function msgHtml( $str ) {
1345 echo $this->translator->translate( $str );
1346 }
1347
1348 /**
1349 * An ugly, ugly hack.
1350 * @private
1351 */
1352 function msgWiki( $str ) {
1353 global $wgOut;
1354
1355 $text = $this->translator->translate( $str );
1356 echo $wgOut->parse( $text );
1357 }
1358
1359 /**
1360 * @private
1361 * @return bool
1362 */
1363 function haveData( $str ) {
1364 return isset( $this->data[$str] );
1365 }
1366
1367 /**
1368 * @private
1369 *
1370 * @return bool
1371 */
1372 function haveMsg( $str ) {
1373 $msg = $this->translator->translate( $str );
1374 return ( $msg != '-' ) && ( $msg != '' ); # ????
1375 }
1376
1377 /**
1378 * Get the Skin object related to this object
1379 *
1380 * @return Skin object
1381 */
1382 public function getSkin() {
1383 return $this->data['skin'];
1384 }
1385 }
1386
1387 /**
1388 * New base template for a skin's template extended from QuickTemplate
1389 * this class features helper methods that provide common ways of interacting
1390 * with the data stored in the QuickTemplate
1391 */
1392 abstract class BaseTemplate extends QuickTemplate {
1393
1394 /**
1395 * Get a Message object with its context set
1396 *
1397 * @param string $name message name
1398 * @return Message
1399 */
1400 public function getMsg( $name ) {
1401 return $this->getSkin()->msg( $name );
1402 }
1403
1404 function msg( $str ) {
1405 echo $this->getMsg( $str )->escaped();
1406 }
1407
1408 function msgHtml( $str ) {
1409 echo $this->getMsg( $str )->text();
1410 }
1411
1412 function msgWiki( $str ) {
1413 echo $this->getMsg( $str )->parseAsBlock();
1414 }
1415
1416 /**
1417 * Create an array of common toolbox items from the data in the quicktemplate
1418 * stored by SkinTemplate.
1419 * The resulting array is built according to a format intended to be passed
1420 * through makeListItem to generate the html.
1421 * @return array
1422 */
1423 function getToolbox() {
1424 wfProfileIn( __METHOD__ );
1425
1426 $toolbox = array();
1427 if ( isset( $this->data['nav_urls']['whatlinkshere'] ) && $this->data['nav_urls']['whatlinkshere'] ) {
1428 $toolbox['whatlinkshere'] = $this->data['nav_urls']['whatlinkshere'];
1429 $toolbox['whatlinkshere']['id'] = 't-whatlinkshere';
1430 }
1431 if ( isset( $this->data['nav_urls']['recentchangeslinked'] ) && $this->data['nav_urls']['recentchangeslinked'] ) {
1432 $toolbox['recentchangeslinked'] = $this->data['nav_urls']['recentchangeslinked'];
1433 $toolbox['recentchangeslinked']['msg'] = 'recentchangeslinked-toolbox';
1434 $toolbox['recentchangeslinked']['id'] = 't-recentchangeslinked';
1435 }
1436 if ( isset( $this->data['feeds'] ) && $this->data['feeds'] ) {
1437 $toolbox['feeds']['id'] = 'feedlinks';
1438 $toolbox['feeds']['links'] = array();
1439 foreach ( $this->data['feeds'] as $key => $feed ) {
1440 $toolbox['feeds']['links'][$key] = $feed;
1441 $toolbox['feeds']['links'][$key]['id'] = "feed-$key";
1442 $toolbox['feeds']['links'][$key]['rel'] = 'alternate';
1443 $toolbox['feeds']['links'][$key]['type'] = "application/{$key}+xml";
1444 $toolbox['feeds']['links'][$key]['class'] = 'feedlink';
1445 }
1446 }
1447 foreach ( array( 'contributions', 'log', 'blockip', 'emailuser', 'userrights', 'upload', 'specialpages' ) as $special ) {
1448 if ( isset( $this->data['nav_urls'][$special] ) && $this->data['nav_urls'][$special] ) {
1449 $toolbox[$special] = $this->data['nav_urls'][$special];
1450 $toolbox[$special]['id'] = "t-$special";
1451 }
1452 }
1453 if ( isset( $this->data['nav_urls']['print'] ) && $this->data['nav_urls']['print'] ) {
1454 $toolbox['print'] = $this->data['nav_urls']['print'];
1455 $toolbox['print']['id'] = 't-print';
1456 $toolbox['print']['rel'] = 'alternate';
1457 $toolbox['print']['msg'] = 'printableversion';
1458 }
1459 if ( isset( $this->data['nav_urls']['permalink'] ) && $this->data['nav_urls']['permalink'] ) {
1460 $toolbox['permalink'] = $this->data['nav_urls']['permalink'];
1461 if ( $toolbox['permalink']['href'] === '' ) {
1462 unset( $toolbox['permalink']['href'] );
1463 $toolbox['ispermalink']['tooltiponly'] = true;
1464 $toolbox['ispermalink']['id'] = 't-ispermalink';
1465 $toolbox['ispermalink']['msg'] = 'permalink';
1466 } else {
1467 $toolbox['permalink']['id'] = 't-permalink';
1468 }
1469 }
1470 if ( isset( $this->data['nav_urls']['info'] ) && $this->data['nav_urls']['info'] ) {
1471 $toolbox['info'] = $this->data['nav_urls']['info'];
1472 $toolbox['info']['id'] = 't-info';
1473 }
1474
1475 wfRunHooks( 'BaseTemplateToolbox', array( &$this, &$toolbox ) );
1476 wfProfileOut( __METHOD__ );
1477 return $toolbox;
1478 }
1479
1480 /**
1481 * Create an array of personal tools items from the data in the quicktemplate
1482 * stored by SkinTemplate.
1483 * The resulting array is built according to a format intended to be passed
1484 * through makeListItem to generate the html.
1485 * This is in reality the same list as already stored in personal_urls
1486 * however it is reformatted so that you can just pass the individual items
1487 * to makeListItem instead of hardcoding the element creation boilerplate.
1488 * @return array
1489 */
1490 function getPersonalTools() {
1491 $personal_tools = array();
1492 foreach ( $this->data['personal_urls'] as $key => $plink ) {
1493 # The class on a personal_urls item is meant to go on the <a> instead
1494 # of the <li> so we have to use a single item "links" array instead
1495 # of using most of the personal_url's keys directly.
1496 $ptool = array(
1497 'links' => array(
1498 array( 'single-id' => "pt-$key" ),
1499 ),
1500 'id' => "pt-$key",
1501 );
1502 if ( isset( $plink['active'] ) ) {
1503 $ptool['active'] = $plink['active'];
1504 }
1505 foreach ( array( 'href', 'class', 'text' ) as $k ) {
1506 if ( isset( $plink[$k] ) )
1507 $ptool['links'][0][$k] = $plink[$k];
1508 }
1509 $personal_tools[$key] = $ptool;
1510 }
1511 return $personal_tools;
1512 }
1513
1514 function getSidebar( $options = array() ) {
1515 // Force the rendering of the following portals
1516 $sidebar = $this->data['sidebar'];
1517 if ( !isset( $sidebar['SEARCH'] ) ) {
1518 $sidebar['SEARCH'] = true;
1519 }
1520 if ( !isset( $sidebar['TOOLBOX'] ) ) {
1521 $sidebar['TOOLBOX'] = true;
1522 }
1523 if ( !isset( $sidebar['LANGUAGES'] ) ) {
1524 $sidebar['LANGUAGES'] = true;
1525 }
1526
1527 if ( !isset( $options['search'] ) || $options['search'] !== true ) {
1528 unset( $sidebar['SEARCH'] );
1529 }
1530 if ( isset( $options['toolbox'] ) && $options['toolbox'] === false ) {
1531 unset( $sidebar['TOOLBOX'] );
1532 }
1533 if ( isset( $options['languages'] ) && $options['languages'] === false ) {
1534 unset( $sidebar['LANGUAGES'] );
1535 }
1536
1537 $boxes = array();
1538 foreach ( $sidebar as $boxName => $content ) {
1539 if ( $content === false ) {
1540 continue;
1541 }
1542 switch ( $boxName ) {
1543 case 'SEARCH':
1544 // Search is a special case, skins should custom implement this
1545 $boxes[$boxName] = array(
1546 'id' => 'p-search',
1547 'header' => $this->getMsg( 'search' )->text(),
1548 'generated' => false,
1549 'content' => true,
1550 );
1551 break;
1552 case 'TOOLBOX':
1553 $msgObj = $this->getMsg( 'toolbox' );
1554 $boxes[$boxName] = array(
1555 'id' => 'p-tb',
1556 'header' => $msgObj->exists() ? $msgObj->text() : 'toolbox',
1557 'generated' => false,
1558 'content' => $this->getToolbox(),
1559 );
1560 break;
1561 case 'LANGUAGES':
1562 if ( $this->data['language_urls'] ) {
1563 $msgObj = $this->getMsg( 'otherlanguages' );
1564 $boxes[$boxName] = array(
1565 'id' => 'p-lang',
1566 'header' => $msgObj->exists() ? $msgObj->text() : 'otherlanguages',
1567 'generated' => false,
1568 'content' => $this->data['language_urls'],
1569 );
1570 }
1571 break;
1572 default:
1573 $msgObj = $this->getMsg( $boxName );
1574 $boxes[$boxName] = array(
1575 'id' => "p-$boxName",
1576 'header' => $msgObj->exists() ? $msgObj->text() : $boxName,
1577 'generated' => true,
1578 'content' => $content,
1579 );
1580 break;
1581 }
1582 }
1583
1584 // HACK: Compatibility with extensions still using SkinTemplateToolboxEnd
1585 $hookContents = null;
1586 if ( isset( $boxes['TOOLBOX'] ) ) {
1587 ob_start();
1588 // We pass an extra 'true' at the end so extensions using BaseTemplateToolbox
1589 // can abort and avoid outputting double toolbox links
1590 wfRunHooks( 'SkinTemplateToolboxEnd', array( &$this, true ) );
1591 $hookContents = ob_get_contents();
1592 ob_end_clean();
1593 if ( !trim( $hookContents ) ) {
1594 $hookContents = null;
1595 }
1596 }
1597 // END hack
1598
1599 if ( isset( $options['htmlOnly'] ) && $options['htmlOnly'] === true ) {
1600 foreach ( $boxes as $boxName => $box ) {
1601 if ( is_array( $box['content'] ) ) {
1602 $content = '<ul>';
1603 foreach ( $box['content'] as $key => $val ) {
1604 $content .= "\n " . $this->makeListItem( $key, $val );
1605 }
1606 // HACK, shove the toolbox end onto the toolbox if we're rendering itself
1607 if ( $hookContents ) {
1608 $content .= "\n $hookContents";
1609 }
1610 // END hack
1611 $content .= "\n</ul>\n";
1612 $boxes[$boxName]['content'] = $content;
1613 }
1614 }
1615 } else {
1616 if ( $hookContents ) {
1617 $boxes['TOOLBOXEND'] = array(
1618 'id' => 'p-toolboxend',
1619 'header' => $boxes['TOOLBOX']['header'],
1620 'generated' => false,
1621 'content' => "<ul>{$hookContents}</ul>",
1622 );
1623 // HACK: Make sure that TOOLBOXEND is sorted next to TOOLBOX
1624 $boxes2 = array();
1625 foreach ( $boxes as $key => $box ) {
1626 if ( $key === 'TOOLBOXEND' ) {
1627 continue;
1628 }
1629 $boxes2[$key] = $box;
1630 if ( $key === 'TOOLBOX' ) {
1631 $boxes2['TOOLBOXEND'] = $boxes['TOOLBOXEND'];
1632 }
1633 }
1634 $boxes = $boxes2;
1635 // END hack
1636 }
1637 }
1638
1639 return $boxes;
1640 }
1641
1642 /**
1643 * Makes a link, usually used by makeListItem to generate a link for an item
1644 * in a list used in navigation lists, portlets, portals, sidebars, etc...
1645 *
1646 * @param string $key usually a key from the list you are generating this
1647 * link from.
1648 * @param array $item contains some of a specific set of keys.
1649 *
1650 * The text of the link will be generated either from the contents of the
1651 * "text" key in the $item array, if a "msg" key is present a message by
1652 * that name will be used, and if neither of those are set the $key will be
1653 * used as a message name.
1654 *
1655 * If a "href" key is not present makeLink will just output htmlescaped text.
1656 * The "href", "id", "class", "rel", and "type" keys are used as attributes
1657 * for the link if present.
1658 *
1659 * If an "id" or "single-id" (if you don't want the actual id to be output
1660 * on the link) is present it will be used to generate a tooltip and
1661 * accesskey for the link.
1662 *
1663 * If you don't want an accesskey, set $item['tooltiponly'] = true;
1664 *
1665 * @param array $options can be used to affect the output of a link.
1666 * Possible options are:
1667 * - 'text-wrapper' key to specify a list of elements to wrap the text of
1668 * a link in. This should be an array of arrays containing a 'tag' and
1669 * optionally an 'attributes' key. If you only have one element you don't
1670 * need to wrap it in another array. eg: To use <a><span>...</span></a>
1671 * in all links use array( 'text-wrapper' => array( 'tag' => 'span' ) )
1672 * for your options.
1673 * - 'link-class' key can be used to specify additional classes to apply
1674 * to all links.
1675 * - 'link-fallback' can be used to specify a tag to use instead of "<a>"
1676 * if there is no link. eg: If you specify 'link-fallback' => 'span' than
1677 * any non-link will output a "<span>" instead of just text.
1678 *
1679 * @return string
1680 */
1681 function makeLink( $key, $item, $options = array() ) {
1682 if ( isset( $item['text'] ) ) {
1683 $text = $item['text'];
1684 } else {
1685 $text = $this->translator->translate( isset( $item['msg'] ) ? $item['msg'] : $key );
1686 }
1687
1688 $html = htmlspecialchars( $text );
1689
1690 if ( isset( $options['text-wrapper'] ) ) {
1691 $wrapper = $options['text-wrapper'];
1692 if ( isset( $wrapper['tag'] ) ) {
1693 $wrapper = array( $wrapper );
1694 }
1695 while ( count( $wrapper ) > 0 ) {
1696 $element = array_pop( $wrapper );
1697 $html = Html::rawElement( $element['tag'], isset( $element['attributes'] ) ? $element['attributes'] : null, $html );
1698 }
1699 }
1700
1701 if ( isset( $item['href'] ) || isset( $options['link-fallback'] ) ) {
1702 $attrs = $item;
1703 foreach ( array( 'single-id', 'text', 'msg', 'tooltiponly' ) as $k ) {
1704 unset( $attrs[$k] );
1705 }
1706
1707 if ( isset( $item['id'] ) && !isset( $item['single-id'] ) ) {
1708 $item['single-id'] = $item['id'];
1709 }
1710 if ( isset( $item['single-id'] ) ) {
1711 if ( isset( $item['tooltiponly'] ) && $item['tooltiponly'] ) {
1712 $title = Linker::titleAttrib( $item['single-id'] );
1713 if ( $title !== false ) {
1714 $attrs['title'] = $title;
1715 }
1716 } else {
1717 $tip = Linker::tooltipAndAccesskeyAttribs( $item['single-id'] );
1718 if ( isset( $tip['title'] ) && $tip['title'] !== false ) {
1719 $attrs['title'] = $tip['title'];
1720 }
1721 if ( isset( $tip['accesskey'] ) && $tip['accesskey'] !== false ) {
1722 $attrs['accesskey'] = $tip['accesskey'];
1723 }
1724 }
1725 }
1726 if ( isset( $options['link-class'] ) ) {
1727 if ( isset( $attrs['class'] ) ) {
1728 $attrs['class'] .= " {$options['link-class']}";
1729 } else {
1730 $attrs['class'] = $options['link-class'];
1731 }
1732 }
1733 $html = Html::rawElement( isset( $attrs['href'] ) ? 'a' : $options['link-fallback'], $attrs, $html );
1734 }
1735
1736 return $html;
1737 }
1738
1739 /**
1740 * Generates a list item for a navigation, portlet, portal, sidebar... list
1741 *
1742 * @param $key string, usually a key from the list you are generating this link from.
1743 * @param $item array, of list item data containing some of a specific set of keys.
1744 * The "id" and "class" keys will be used as attributes for the list item,
1745 * if "active" contains a value of true a "active" class will also be appended to class.
1746 *
1747 * @param $options array
1748 *
1749 * If you want something other than a "<li>" you can pass a tag name such as
1750 * "tag" => "span" in the $options array to change the tag used.
1751 * link/content data for the list item may come in one of two forms
1752 * A "links" key may be used, in which case it should contain an array with
1753 * a list of links to include inside the list item, see makeLink for the
1754 * format of individual links array items.
1755 *
1756 * Otherwise the relevant keys from the list item $item array will be passed
1757 * to makeLink instead. Note however that "id" and "class" are used by the
1758 * list item directly so they will not be passed to makeLink
1759 * (however the link will still support a tooltip and accesskey from it)
1760 * If you need an id or class on a single link you should include a "links"
1761 * array with just one link item inside of it.
1762 * $options is also passed on to makeLink calls
1763 *
1764 * @return string
1765 */
1766 function makeListItem( $key, $item, $options = array() ) {
1767 if ( isset( $item['links'] ) ) {
1768 $html = '';
1769 foreach ( $item['links'] as $linkKey => $link ) {
1770 $html .= $this->makeLink( $linkKey, $link, $options );
1771 }
1772 } else {
1773 $link = $item;
1774 // These keys are used by makeListItem and shouldn't be passed on to the link
1775 foreach ( array( 'id', 'class', 'active', 'tag' ) as $k ) {
1776 unset( $link[$k] );
1777 }
1778 if ( isset( $item['id'] ) && !isset( $item['single-id'] ) ) {
1779 // The id goes on the <li> not on the <a> for single links
1780 // but makeSidebarLink still needs to know what id to use when
1781 // generating tooltips and accesskeys.
1782 $link['single-id'] = $item['id'];
1783 }
1784 $html = $this->makeLink( $key, $link, $options );
1785 }
1786
1787 $attrs = array();
1788 foreach ( array( 'id', 'class' ) as $attr ) {
1789 if ( isset( $item[$attr] ) ) {
1790 $attrs[$attr] = $item[$attr];
1791 }
1792 }
1793 if ( isset( $item['active'] ) && $item['active'] ) {
1794 if ( !isset( $attrs['class'] ) ) {
1795 $attrs['class'] = '';
1796 }
1797 $attrs['class'] .= ' active';
1798 $attrs['class'] = trim( $attrs['class'] );
1799 }
1800 return Html::rawElement( isset( $options['tag'] ) ? $options['tag'] : 'li', $attrs, $html );
1801 }
1802
1803 function makeSearchInput( $attrs = array() ) {
1804 $realAttrs = array(
1805 'type' => 'search',
1806 'name' => 'search',
1807 'value' => isset( $this->data['search'] ) ? $this->data['search'] : '',
1808 );
1809 $realAttrs = array_merge( $realAttrs, Linker::tooltipAndAccesskeyAttribs( 'search' ), $attrs );
1810 return Html::element( 'input', $realAttrs );
1811 }
1812
1813 function makeSearchButton( $mode, $attrs = array() ) {
1814 switch( $mode ) {
1815 case 'go':
1816 case 'fulltext':
1817 $realAttrs = array(
1818 'type' => 'submit',
1819 'name' => $mode,
1820 'value' => $this->translator->translate(
1821 $mode == 'go' ? 'searcharticle' : 'searchbutton' ),
1822 );
1823 $realAttrs = array_merge(
1824 $realAttrs,
1825 Linker::tooltipAndAccesskeyAttribs( "search-$mode" ),
1826 $attrs
1827 );
1828 return Html::element( 'input', $realAttrs );
1829 case 'image':
1830 $buttonAttrs = array(
1831 'type' => 'submit',
1832 'name' => 'button',
1833 );
1834 $buttonAttrs = array_merge(
1835 $buttonAttrs,
1836 Linker::tooltipAndAccesskeyAttribs( 'search-fulltext' ),
1837 $attrs
1838 );
1839 unset( $buttonAttrs['src'] );
1840 unset( $buttonAttrs['alt'] );
1841 unset( $buttonAttrs['width'] );
1842 unset( $buttonAttrs['height'] );
1843 $imgAttrs = array(
1844 'src' => $attrs['src'],
1845 'alt' => isset( $attrs['alt'] )
1846 ? $attrs['alt']
1847 : $this->translator->translate( 'searchbutton' ),
1848 'width' => isset( $attrs['width'] ) ? $attrs['width'] : null,
1849 'height' => isset( $attrs['height'] ) ? $attrs['height'] : null,
1850 );
1851 return Html::rawElement( 'button', $buttonAttrs, Html::element( 'img', $imgAttrs ) );
1852 default:
1853 throw new MWException( 'Unknown mode passed to BaseTemplate::makeSearchButton' );
1854 }
1855 }
1856
1857 /**
1858 * Returns an array of footerlinks trimmed down to only those footer links that
1859 * are valid.
1860 * If you pass "flat" as an option then the returned array will be a flat array
1861 * of footer icons instead of a key/value array of footerlinks arrays broken
1862 * up into categories.
1863 * @return array|mixed
1864 */
1865 function getFooterLinks( $option = null ) {
1866 $footerlinks = $this->data['footerlinks'];
1867
1868 // Reduce footer links down to only those which are being used
1869 $validFooterLinks = array();
1870 foreach( $footerlinks as $category => $links ) {
1871 $validFooterLinks[$category] = array();
1872 foreach( $links as $link ) {
1873 if( isset( $this->data[$link] ) && $this->data[$link] ) {
1874 $validFooterLinks[$category][] = $link;
1875 }
1876 }
1877 if ( count( $validFooterLinks[$category] ) <= 0 ) {
1878 unset( $validFooterLinks[$category] );
1879 }
1880 }
1881
1882 if ( $option == 'flat' ) {
1883 // fold footerlinks into a single array using a bit of trickery
1884 $validFooterLinks = call_user_func_array(
1885 'array_merge',
1886 array_values( $validFooterLinks )
1887 );
1888 }
1889
1890 return $validFooterLinks;
1891 }
1892
1893 /**
1894 * Returns an array of footer icons filtered down by options relevant to how
1895 * the skin wishes to display them.
1896 * If you pass "icononly" as the option all footer icons which do not have an
1897 * image icon set will be filtered out.
1898 * If you pass "nocopyright" then MediaWiki's copyright icon will not be included
1899 * in the list of footer icons. This is mostly useful for skins which only
1900 * display the text from footericons instead of the images and don't want a
1901 * duplicate copyright statement because footerlinks already rendered one.
1902 * @return
1903 */
1904 function getFooterIcons( $option = null ) {
1905 // Generate additional footer icons
1906 $footericons = $this->data['footericons'];
1907
1908 if ( $option == 'icononly' ) {
1909 // Unset any icons which don't have an image
1910 foreach ( $footericons as &$footerIconsBlock ) {
1911 foreach ( $footerIconsBlock as $footerIconKey => $footerIcon ) {
1912 if ( !is_string( $footerIcon ) && !isset( $footerIcon['src'] ) ) {
1913 unset( $footerIconsBlock[$footerIconKey] );
1914 }
1915 }
1916 }
1917 // Redo removal of any empty blocks
1918 foreach ( $footericons as $footerIconsKey => &$footerIconsBlock ) {
1919 if ( count( $footerIconsBlock ) <= 0 ) {
1920 unset( $footericons[$footerIconsKey] );
1921 }
1922 }
1923 } elseif ( $option == 'nocopyright' ) {
1924 unset( $footericons['copyright']['copyright'] );
1925 if ( count( $footericons['copyright'] ) <= 0 ) {
1926 unset( $footericons['copyright'] );
1927 }
1928 }
1929
1930 return $footericons;
1931 }
1932
1933 /**
1934 * Output the basic end-page trail including bottomscripts, reporttime, and
1935 * debug stuff. This should be called right before outputting the closing
1936 * body and html tags.
1937 */
1938 function printTrail() { ?>
1939 <?php $this->html( 'bottomscripts' ); /* JS call to runBodyOnloadHook */ ?>
1940 <?php $this->html( 'reporttime' ) ?>
1941 <?php echo MWDebug::getDebugHTML( $this->getSkin()->getContext() );
1942 }
1943
1944 }