3 * Base class for template-based skins
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.
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.
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
23 if ( !defined( 'MEDIAWIKI' ) ) {
28 * Wrapper object for MediaWiki's localization functions,
29 * to be passed to the template engine.
34 class MediaWiki_I18N
{
35 var $_context = array();
37 function set( $varName, $value ) {
38 $this->_context
[$varName] = $value;
41 function translate( $value ) {
42 wfProfileIn( __METHOD__
);
44 // Hack for i18n:attributes in PHPTAL 1.0.0 dev version as of 2004-10-23
45 $value = preg_replace( '/^string:/', '', $value );
47 $value = wfMsg( $value );
48 // interpolate variables
50 while( preg_match( '/\$([0-9]*?)/sm', $value, $m ) ) {
51 list( $src, $var ) = $m;
53 $varValue = $this->_context
[$var];
55 $value = str_replace( $src, $varValue, $value );
57 wfProfileOut( __METHOD__
);
63 * Template-filler skin base class
64 * Formerly generic PHPTal (http://phptal.sourceforge.net/) skin
65 * Based on Brion's smarty skin
66 * @copyright Copyright © Gabriel Wicke -- http://www.aulinx.de/
68 * @todo Needs some serious refactoring into functions that correspond
69 * to the computations individual esi snippets need. Most importantly no body
70 * parsing for most of those of course.
74 class SkinTemplate
extends Skin
{
80 * Name of our skin, it probably needs to be all lower case. Child classes
81 * should override the default.
83 var $skinname = 'monobook';
86 * Stylesheets set to use. Subdirectory in skins/ where various stylesheets
87 * are located. Child classes should override the default.
89 var $stylename = 'monobook';
92 * For QuickTemplate, the name of the subclass which will actually fill the
93 * template. Child classes should override the default.
95 var $template = 'QuickTemplate';
98 * Whether this skin use OutputPage::headElement() to generate the <head>
101 var $useHeadElement = false;
106 * Add specific styles for this skin
108 * @param $out OutputPage
110 function setupSkinUserCss( OutputPage
$out ) {
111 $out->addModuleStyles( array( 'mediawiki.legacy.shared', 'mediawiki.legacy.commonPrint' ) );
115 * Create the template engine object; we feed it a bunch of data
116 * and eventually it spits out some HTML. Should have interface
117 * roughly equivalent to PHPTAL 0.7.
119 * @param $classname String
120 * @param $repository string: subdirectory where we keep template files
121 * @param $cache_dir string
122 * @return QuickTemplate
125 function setupTemplate( $classname, $repository = false, $cache_dir = false ) {
126 return new $classname();
130 * initialize various variables and generate the template
132 * @param $out OutputPage
134 function outputPage( OutputPage
$out=null ) {
136 global $wgScript, $wgStylePath;
137 global $wgMimeType, $wgJsMimeType;
138 global $wgXhtmlDefaultNamespace, $wgXhtmlNamespaces, $wgHtml5Version;
139 global $wgDisableCounters, $wgSitename, $wgLogo, $wgHideInterlanguageLinks;
140 global $wgMaxCredits, $wgShowCreditsIfMax;
141 global $wgPageShowWatchingUsers;
142 global $wgUseTrackbacks, $wgUseSiteJs, $wgDebugComments;
143 global $wgArticlePath, $wgScriptPath, $wgServer;
145 wfProfileIn( __METHOD__
);
146 Profiler
::instance()->setTemplated( true );
149 if ( $out !== null ) {
150 // @todo Add wfDeprecated in 1.20
151 $oldContext = $this->getContext();
152 $this->setContext( $out->getContext() );
155 $out = $this->getOutput();
156 $request = $this->getRequest();
157 $user = $this->getUser();
159 wfProfileIn( __METHOD__
. '-init' );
160 $this->initPage( $out );
162 $tpl = $this->setupTemplate( $this->template
, 'skins' );
163 wfProfileOut( __METHOD__
. '-init' );
165 wfProfileIn( __METHOD__
. '-stuff' );
166 $this->thispage
= $this->getTitle()->getPrefixedDBkey();
167 $this->userpage
= $user->getUserPage()->getPrefixedText();
169 if ( !$request->wasPosted() ) {
170 $query = $request->getValues();
171 unset( $query['title'] );
172 unset( $query['returnto'] );
173 unset( $query['returntoquery'] );
175 $this->thisquery
= wfArrayToCGI( $query );
176 $this->loggedin
= $user->isLoggedIn();
177 $this->username
= $user->getName();
179 if ( $user->isLoggedIn() ||
$this->showIPinHeader() ) {
180 $this->userpageUrlDetails
= self
::makeUrlDetails( $this->userpage
);
182 # This won't be used in the standard skins, but we define it to preserve the interface
183 # To save time, we check for existence
184 $this->userpageUrlDetails
= self
::makeKnownUrlDetails( $this->userpage
);
187 $this->titletxt
= $this->getTitle()->getPrefixedText();
188 wfProfileOut( __METHOD__
. '-stuff' );
190 wfProfileIn( __METHOD__
. '-stuff-head' );
191 if ( !$this->useHeadElement
) {
192 $tpl->set( 'pagecss', false );
193 $tpl->set( 'usercss', false );
195 $this->userjs
= $this->userjsprev
= false;
196 # @todo FIXME: This is the only use of OutputPage::isUserJsAllowed() anywhere; can we
197 # get rid of it? For that matter, why is any of this here at all?
198 $this->setupUserJs( $out->isUserJsAllowed() );
199 $tpl->setRef( 'userjs', $this->userjs
);
200 $tpl->setRef( 'userjsprev', $this->userjsprev
);
203 $jsCache = $this->loggedin ?
'&smaxage=0' : '';
204 $tpl->set( 'jsvarurl',
206 "action=raw$jsCache&gen=js&useskin=" .
207 urlencode( $this->getSkinName() ) ) );
209 $tpl->set( 'jsvarurl', false );
212 $tpl->setRef( 'xhtmldefaultnamespace', $wgXhtmlDefaultNamespace );
213 $tpl->set( 'xhtmlnamespaces', $wgXhtmlNamespaces );
214 $tpl->set( 'html5version', $wgHtml5Version );
215 $tpl->set( 'headlinks', $out->getHeadLinks() );
216 $tpl->set( 'csslinks', $out->buildCssLinks() );
218 if( $wgUseTrackbacks && $out->isArticleRelated() ) {
219 $tpl->set( 'trackbackhtml', $out->getTitle()->trackbackRDF() );
221 $tpl->set( 'trackbackhtml', null );
224 $tpl->set( 'pageclass', $this->getPageClasses( $this->getTitle() ) );
225 $tpl->set( 'skinnameclass', ( 'skin-' . Sanitizer
::escapeClass( $this->getSkinName() ) ) );
227 wfProfileOut( __METHOD__
. '-stuff-head' );
229 wfProfileIn( __METHOD__
. '-stuff2' );
230 $tpl->set( 'title', $out->getPageTitle() );
231 $tpl->set( 'pagetitle', $out->getHTMLTitle() );
232 $tpl->set( 'displaytitle', $out->mPageLinkTitle
);
234 $tpl->set( 'titleprefixeddbkey', $this->getTitle()->getPrefixedDBKey() );
235 $tpl->set( 'titletext', $this->getTitle()->getText() );
236 $tpl->set( 'articleid', $this->getTitle()->getArticleId() );
238 $tpl->set( 'isarticle', $out->isArticle() );
240 $tpl->setRef( 'thispage', $this->thispage
);
241 $subpagestr = $this->subPageSubtitle();
243 'subtitle', !empty( $subpagestr ) ?
244 '<span class="subpages">' . $subpagestr . '</span>' . $out->getSubtitle() :
247 $undelete = $this->getUndeleteLink();
249 'undelete', !empty( $undelete ) ?
250 '<span class="subpages">' . $undelete . '</span>' :
254 $tpl->set( 'catlinks', $this->getCategories() );
255 if( $out->isSyndicated() ) {
257 foreach( $out->getSyndicationLinks() as $format => $link ) {
258 $feeds[$format] = array(
259 'text' => wfMsg( "feed-$format" ),
263 $tpl->setRef( 'feeds', $feeds );
265 $tpl->set( 'feeds', false );
268 $tpl->setRef( 'mimetype', $wgMimeType );
269 $tpl->setRef( 'jsmimetype', $wgJsMimeType );
270 $tpl->set( 'charset', 'UTF-8' );
271 $tpl->setRef( 'wgScript', $wgScript );
272 $tpl->setRef( 'skinname', $this->skinname
);
273 $tpl->set( 'skinclass', get_class( $this ) );
274 $tpl->setRef( 'stylename', $this->stylename
);
275 $tpl->set( 'printable', $out->isPrintable() );
276 $tpl->set( 'handheld', $request->getBool( 'handheld' ) );
277 $tpl->setRef( 'loggedin', $this->loggedin
);
278 $tpl->set( 'notspecialpage', $this->getTitle()->getNamespace() != NS_SPECIAL
);
279 /* XXX currently unused, might get useful later
280 $tpl->set( 'editable', ( $this->getTitle()->getNamespace() != NS_SPECIAL ) );
281 $tpl->set( 'exists', $this->getTitle()->getArticleID() != 0 );
282 $tpl->set( 'watch', $this->getTitle()->userIsWatching() ? 'unwatch' : 'watch' );
283 $tpl->set( 'protect', count( $this->getTitle()->isProtected() ) ? 'unprotect' : 'protect' );
284 $tpl->set( 'helppage', wfMsg( 'helppage' ) );
286 $tpl->set( 'searchaction', $this->escapeSearchLink() );
287 $tpl->set( 'searchtitle', SpecialPage
::getTitleFor( 'Search' )->getPrefixedDBKey() );
288 $tpl->set( 'search', trim( $request->getVal( 'search' ) ) );
289 $tpl->setRef( 'stylepath', $wgStylePath );
290 $tpl->setRef( 'articlepath', $wgArticlePath );
291 $tpl->setRef( 'scriptpath', $wgScriptPath );
292 $tpl->setRef( 'serverurl', $wgServer );
293 $tpl->setRef( 'logopath', $wgLogo );
294 $tpl->setRef( 'sitename', $wgSitename );
296 $contentlang = $wgContLang->getCode();
297 $contentdir = $wgContLang->getDir();
298 $userlang = $this->getLang()->getCode();
299 $userdir = $this->getLang()->getDir();
301 $tpl->set( 'lang', $userlang );
302 $tpl->set( 'dir', $userdir );
303 $tpl->set( 'rtl', $this->getLang()->isRTL() );
305 $tpl->set( 'capitalizeallnouns', $this->getLang()->capitalizeAllNouns() ?
' capitalize-all-nouns' : '' );
306 $tpl->set( 'showjumplinks', $user->getOption( 'showjumplinks' ) );
307 $tpl->set( 'username', $user->isAnon() ?
null : $this->username
);
308 $tpl->setRef( 'userpage', $this->userpage
);
309 $tpl->setRef( 'userpageurl', $this->userpageUrlDetails
['href'] );
310 $tpl->set( 'userlang', $userlang );
312 // Users can have their language set differently than the
313 // content of the wiki. For these users, tell the web browser
314 // that interface elements are in a different language.
315 $tpl->set( 'userlangattributes', '' );
316 $tpl->set( 'specialpageattributes', '' ); # obsolete
318 if ( $userlang !== $contentlang ||
$userdir !== $contentdir ) {
319 $attrs = " lang='$userlang' dir='$userdir'";
320 $tpl->set( 'userlangattributes', $attrs );
323 wfProfileOut( __METHOD__
. '-stuff2' );
325 wfProfileIn( __METHOD__
. '-stuff3' );
326 $tpl->set( 'newtalk', $this->getNewtalks() );
327 $tpl->setRef( 'skin', $this );
328 $tpl->set( 'logo', $this->logoText() );
330 $tpl->set( 'copyright', false );
331 $tpl->set( 'viewcount', false );
332 $tpl->set( 'lastmod', false );
333 $tpl->set( 'credits', false );
334 $tpl->set( 'numberofwatchingusers', false );
335 if ( $out->isArticle() && $this->getTitle()->exists() ) {
336 if ( $this->isRevisionCurrent() ) {
337 $article = new Article( $this->getTitle(), 0 );
338 if ( !$wgDisableCounters ) {
339 $viewcount = $this->getLang()->formatNum( $article->getCount() );
341 $tpl->set( 'viewcount', wfMsgExt( 'viewcount', array( 'parseinline' ), $viewcount ) );
345 if( $wgPageShowWatchingUsers ) {
346 $dbr = wfGetDB( DB_SLAVE
);
347 $num = $dbr->selectField( 'watchlist', 'COUNT(*)',
348 array( 'wl_title' => $this->getTitle()->getDBkey(), 'wl_namespace' => $this->getTitle()->getNamespace() ),
352 $tpl->set( 'numberofwatchingusers',
353 wfMsgExt( 'number_of_watching_users_pageview', array( 'parseinline' ),
354 $this->getLang()->formatNum( $num ) )
359 if ( $wgMaxCredits != 0 ) {
360 $tpl->set( 'credits', Action
::factory( 'credits', $article )->getCredits( $wgMaxCredits, $wgShowCreditsIfMax ) );
362 $tpl->set( 'lastmod', $this->lastModified( $article ) );
365 $tpl->set( 'copyright', $this->getCopyright() );
367 wfProfileOut( __METHOD__
. '-stuff3' );
369 wfProfileIn( __METHOD__
. '-stuff4' );
370 $tpl->set( 'copyrightico', $this->getCopyrightIcon() );
371 $tpl->set( 'poweredbyico', $this->getPoweredBy() );
372 $tpl->set( 'disclaimer', $this->disclaimerLink() );
373 $tpl->set( 'privacy', $this->privacyLink() );
374 $tpl->set( 'about', $this->aboutLink() );
376 $tpl->set( 'footerlinks', array(
380 'numberofwatchingusers',
391 global $wgFooterIcons;
392 $tpl->set( 'footericons', $wgFooterIcons );
393 foreach ( $tpl->data
['footericons'] as $footerIconsKey => &$footerIconsBlock ) {
394 if ( count( $footerIconsBlock ) > 0 ) {
395 foreach ( $footerIconsBlock as &$footerIcon ) {
396 if ( isset( $footerIcon['src'] ) ) {
397 if ( !isset( $footerIcon['width'] ) ) {
398 $footerIcon['width'] = 88;
400 if ( !isset( $footerIcon['height'] ) ) {
401 $footerIcon['height'] = 31;
406 unset( $tpl->data
['footericons'][$footerIconsKey] );
410 if ( $wgDebugComments ) {
411 $tpl->setRef( 'debug', $out->mDebugtext
);
413 $tpl->set( 'debug', '' );
416 $tpl->set( 'reporttime', wfReportTime() );
417 $tpl->set( 'sitenotice', $this->getSiteNotice() );
418 $tpl->set( 'bottomscripts', $this->bottomScripts() );
419 $tpl->set( 'printfooter', $this->printSource() );
421 # Add a <div class="mw-content-ltr/rtl"> around the body text
422 # not for special pages or file pages AND only when viewing AND if the page exists
423 # (or is in MW namespace, because that has default content)
424 if( !in_array( $this->getTitle()->getNamespace(), array( NS_SPECIAL
, NS_FILE
) ) &&
425 in_array( $request->getVal( 'action', 'view' ), array( 'view', 'historysubmit' ) ) &&
426 ( $this->getTitle()->exists() ||
$this->getTitle()->getNamespace() == NS_MEDIAWIKI
) ) {
427 $pageLang = $this->getTitle()->getPageLanguage();
428 $realBodyAttribs = array( 'lang' => $pageLang->getCode(), 'dir' => $pageLang->getDir(),
429 'class' => 'mw-content-'.$pageLang->getDir() );
430 $out->mBodytext
= Html
::rawElement( 'div', $realBodyAttribs, $out->mBodytext
);
433 $tpl->setRef( 'bodytext', $out->mBodytext
);
436 $language_urls = array();
438 if ( !$wgHideInterlanguageLinks ) {
439 foreach( $out->getLanguageLinks() as $l ) {
440 $tmp = explode( ':', $l, 2 );
441 $class = 'interwiki-' . $tmp[0];
443 $nt = Title
::newFromText( $l );
445 $language_urls[] = array(
446 'href' => $nt->getFullURL(),
447 'text' => ( $wgContLang->getLanguageName( $nt->getInterwiki() ) != '' ?
448 $wgContLang->getLanguageName( $nt->getInterwiki() ) : $l ),
449 'title' => $nt->getText(),
455 if( count( $language_urls ) ) {
456 $tpl->setRef( 'language_urls', $language_urls );
458 $tpl->set( 'language_urls', false );
460 wfProfileOut( __METHOD__
. '-stuff4' );
462 wfProfileIn( __METHOD__
. '-stuff5' );
464 $tpl->set( 'personal_urls', $this->buildPersonalUrls() );
465 $content_navigation = $this->buildContentNavigationUrls();
466 $content_actions = $this->buildContentActionUrls( $content_navigation );
467 $tpl->setRef( 'content_navigation', $content_navigation );
468 $tpl->setRef( 'content_actions', $content_actions );
470 $tpl->set( 'sidebar', $this->buildSidebar() );
471 $tpl->set( 'nav_urls', $this->buildNavUrls() );
473 // Set the head scripts near the end, in case the above actions resulted in added scripts
474 if ( $this->useHeadElement
) {
475 $tpl->set( 'headelement', $out->headElement( $this ) );
477 $tpl->set( 'headscripts', $out->getScript() );
480 $tpl->set( 'debughtml', $this->generateDebugHTML() );
482 // original version by hansm
483 if( !wfRunHooks( 'SkinTemplateOutputPageBeforeExec', array( &$this, &$tpl ) ) ) {
484 wfDebug( __METHOD__
. ": Hook SkinTemplateOutputPageBeforeExec broke outputPage execution!\n" );
487 // Set the bodytext to another key so that skins can just output it on it's own
488 // and output printfooter and debughtml separately
489 $tpl->set( 'bodycontent', $tpl->data
['bodytext'] );
491 // Append printfooter and debughtml onto bodytext so that skins that were already
492 // using bodytext before they were split out don't suddenly start not outputting information
493 $tpl->data
['bodytext'] .= Html
::rawElement( 'div', array( 'class' => 'printfooter' ), "\n{$tpl->data['printfooter']}" ) . "\n";
494 $tpl->data
['bodytext'] .= $tpl->data
['debughtml'];
496 // allow extensions adding stuff after the page content.
497 // See Skin::afterContentHook() for further documentation.
498 $tpl->set( 'dataAfterContent', $this->afterContentHook() );
499 wfProfileOut( __METHOD__
. '-stuff5' );
502 wfProfileIn( __METHOD__
. '-execute' );
503 $res = $tpl->execute();
504 wfProfileOut( __METHOD__
. '-execute' );
506 // result may be an error
507 $this->printOrError( $res );
510 $this->setContext( $oldContext );
512 wfProfileOut( __METHOD__
);
516 * Output the string, or print error message if it's
517 * an error object of the appropriate type.
518 * For the base class, assume strings all around.
523 function printOrError( $str ) {
528 * Output a boolean indiciating if buildPersonalUrls should output separate
529 * login and create account links or output a combined link
530 * By default we simply return a global config setting that affects most skins
531 * This is setup as a method so that like with $wgLogo and getLogo() a skin
532 * can override this setting and always output one or the other if it has
533 * a reason it can't output one of the two modes.
535 function useCombinedLoginLink() {
536 global $wgUseCombinedLoginLink;
537 return $wgUseCombinedLoginLink;
541 * build array of urls for personal toolbar
544 protected function buildPersonalUrls() {
545 $title = $this->getTitle();
546 $request = $this->getRequest();
547 $pageurl = $title->getLocalURL();
548 wfProfileIn( __METHOD__
);
550 /* set up the default links for the personal toolbar */
551 $personal_urls = array();
553 $page = $request->getVal( 'returnto', $this->thispage
);
554 $query = $request->getVal( 'returntoquery', $this->thisquery
);
555 $a = array( 'returnto' => $page );
557 $a['returntoquery'] = $query;
559 $returnto = wfArrayToCGI( $a );
560 if( $this->loggedin
) {
561 $personal_urls['userpage'] = array(
562 'text' => $this->username
,
563 'href' => &$this->userpageUrlDetails
['href'],
564 'class' => $this->userpageUrlDetails
['exists'] ?
false : 'new',
565 'active' => ( $this->userpageUrlDetails
['href'] == $pageurl )
567 $usertalkUrlDetails = $this->makeTalkUrlDetails( $this->userpage
);
568 $personal_urls['mytalk'] = array(
569 'text' => wfMsg( 'mytalk' ),
570 'href' => &$usertalkUrlDetails['href'],
571 'class' => $usertalkUrlDetails['exists'] ?
false : 'new',
572 'active' => ( $usertalkUrlDetails['href'] == $pageurl )
574 $href = self
::makeSpecialUrl( 'Preferences' );
575 $personal_urls['preferences'] = array(
576 'text' => wfMsg( 'mypreferences' ),
578 'active' => ( $href == $pageurl )
580 $href = self
::makeSpecialUrl( 'Watchlist' );
581 $personal_urls['watchlist'] = array(
582 'text' => wfMsg( 'mywatchlist' ),
584 'active' => ( $href == $pageurl )
587 # We need to do an explicit check for Special:Contributions, as we
588 # have to match both the title, and the target (which could come
589 # from request values or be specified in "sub page" form. The plot
590 # thickens, because $wgTitle is altered for special pages, so doesn't
591 # contain the original alias-with-subpage.
592 $origTitle = Title
::newFromText( $request->getText( 'title' ) );
593 if( $origTitle instanceof Title
&& $origTitle->getNamespace() == NS_SPECIAL
) {
594 list( $spName, $spPar ) = SpecialPageFactory
::resolveAlias( $origTitle->getText() );
595 $active = $spName == 'Contributions'
596 && ( ( $spPar && $spPar == $this->username
)
597 ||
$request->getText( 'target' ) == $this->username
);
602 $href = self
::makeSpecialUrlSubpage( 'Contributions', $this->username
);
603 $personal_urls['mycontris'] = array(
604 'text' => wfMsg( 'mycontris' ),
608 $personal_urls['logout'] = array(
609 'text' => wfMsg( 'userlogout' ),
610 'href' => self
::makeSpecialUrl( 'Userlogout',
611 // userlogout link must always contain an & character, otherwise we might not be able
612 // to detect a buggy precaching proxy (bug 17790)
613 $title->isSpecial( 'Preferences' ) ?
'noreturnto' : $returnto
618 $useCombinedLoginLink = $this->useCombinedLoginLink();
619 $loginlink = $this->getUser()->isAllowed( 'createaccount' ) && $useCombinedLoginLink
620 ?
'nav-login-createaccount'
622 $is_signup = $request->getText('type') == "signup";
624 # anonlogin & login are the same
626 'text' => wfMsg( $loginlink ),
627 'href' => self
::makeSpecialUrl( 'Userlogin', $returnto ),
628 'active' => $title->isSpecial( 'Userlogin' ) && ( $loginlink == "nav-login-createaccount" ||
!$is_signup )
630 if ( $this->getUser()->isAllowed( 'createaccount' ) && !$useCombinedLoginLink ) {
631 $createaccount_url = array(
632 'text' => wfMsg( 'createaccount' ),
633 'href' => self
::makeSpecialUrl( 'Userlogin', "$returnto&type=signup" ),
634 'active' => $title->isSpecial( 'Userlogin' ) && $is_signup
637 global $wgServer, $wgSecureLogin;
638 if( substr( $wgServer, 0, 5 ) === 'http:' && $wgSecureLogin ) {
639 $title = SpecialPage
::getTitleFor( 'Userlogin' );
640 $https_url = preg_replace( '/^http:/', 'https:', $title->getFullURL() );
641 $login_url['href'] = $https_url;
642 # @todo FIXME: Class depends on skin
643 $login_url['class'] = 'link-https';
644 if ( isset($createaccount_url) ) {
645 $https_url = preg_replace( '/^http:/', 'https:',
646 $title->getFullURL("type=signup") );
647 $createaccount_url['href'] = $https_url;
648 # @todo FIXME: Class depends on skin
649 $createaccount_url['class'] = 'link-https';
654 if( $this->showIPinHeader() ) {
655 $href = &$this->userpageUrlDetails
['href'];
656 $personal_urls['anonuserpage'] = array(
657 'text' => $this->username
,
659 'class' => $this->userpageUrlDetails
['exists'] ?
false : 'new',
660 'active' => ( $pageurl == $href )
662 $usertalkUrlDetails = $this->makeTalkUrlDetails( $this->userpage
);
663 $href = &$usertalkUrlDetails['href'];
664 $personal_urls['anontalk'] = array(
665 'text' => wfMsg( 'anontalk' ),
667 'class' => $usertalkUrlDetails['exists'] ?
false : 'new',
668 'active' => ( $pageurl == $href )
670 $personal_urls['anonlogin'] = $login_url;
672 $personal_urls['login'] = $login_url;
674 if ( isset($createaccount_url) ) {
675 $personal_urls['createaccount'] = $createaccount_url;
679 wfRunHooks( 'PersonalUrls', array( &$personal_urls, &$title ) );
680 wfProfileOut( __METHOD__
);
681 return $personal_urls;
686 * @param $title Title
687 * @param $message String message key
688 * @param $selected Bool
689 * @param $query String
690 * @param $checkEdit Bool
693 function tabAction( $title, $message, $selected, $query = '', $checkEdit = false ) {
696 $classes[] = 'selected';
698 if( $checkEdit && !$title->isKnown() ) {
700 $query = 'action=edit&redlink=1';
703 // wfMessageFallback will nicely accept $message as an array of fallbacks
704 // or just a single key
705 $msg = wfMessageFallback( $message );
706 if ( is_array($message) ) {
707 // for hook compatibility just keep the last message name
708 $message = end($message);
710 if ( $msg->exists() ) {
711 $text = $msg->text();
714 $text = $wgContLang->getFormattedNsText(
715 MWNamespace
::getSubject( $title->getNamespace() ) );
719 if( !wfRunHooks( 'SkinTemplateTabAction', array( &$this,
720 $title, $message, $selected, $checkEdit,
721 &$classes, &$query, &$text, &$result ) ) ) {
726 'class' => implode( ' ', $classes ),
728 'href' => $title->getLocalUrl( $query ),
732 function makeTalkUrlDetails( $name, $urlaction = '' ) {
733 $title = Title
::newFromText( $name );
734 if( !is_object( $title ) ) {
735 throw new MWException( __METHOD__
. " given invalid pagename $name" );
737 $title = $title->getTalkPage();
738 self
::checkTitle( $title, $name );
740 'href' => $title->getLocalURL( $urlaction ),
741 'exists' => $title->getArticleID() != 0,
745 function makeArticleUrlDetails( $name, $urlaction = '' ) {
746 $title = Title
::newFromText( $name );
747 $title= $title->getSubjectPage();
748 self
::checkTitle( $title, $name );
750 'href' => $title->getLocalURL( $urlaction ),
751 'exists' => $title->getArticleID() != 0,
756 * a structured array of links usually used for the tabs in a skin
758 * There are 4 standard sections
759 * namespaces: Used for namespace tabs like special, page, and talk namespaces
760 * views: Used for primary page views like read, edit, history
761 * actions: Used for most extra page actions like deletion, protection, etc...
762 * variants: Used to list the language variants for the page
764 * Each section's value is a key/value array of links for that section.
765 * The links themseves have these common keys:
766 * - class: The css classes to apply to the tab
767 * - text: The text to display on the tab
768 * - href: The href for the tab to point to
769 * - rel: An optional rel= for the tab's link
770 * - redundant: If true the tab will be dropped in skins using content_actions
771 * this is useful for tabs like "Read" which only have meaning in skins that
772 * take special meaning from the grouped structure of content_navigation
774 * Views also have an extra key which can be used:
775 * - primary: If this is not true skins like vector may try to hide the tab
776 * when the user has limited space in their browser window
778 * content_navigation using code also expects these ids to be present on the
779 * links, however these are usually automatically generated by SkinTemplate
780 * itself and are not necessary when using a hook. The only things these may
781 * matter to are people modifying content_navigation after it's initial creation:
782 * - id: A "preferred" id, most skins are best off outputting this preferred id for best compatibility
783 * - tooltiponly: This is set to true for some tabs in cases where the system
784 * believes that the accesskey should not be added to the tab.
788 protected function buildContentNavigationUrls() {
789 global $wgDisableLangConversion;
791 wfProfileIn( __METHOD__
);
793 $title = $this->getRelevantTitle(); // Display tabs for the relevant title rather than always the title itself
794 $onPage = $title->equals($this->getTitle());
796 $out = $this->getOutput();
797 $request = $this->getRequest();
798 $user = $this->getUser();
800 $content_navigation = array(
801 'namespaces' => array(),
803 'actions' => array(),
804 'variants' => array()
808 $action = $request->getVal( 'action', 'view' );
809 $section = $request->getVal( 'section' );
811 $userCanRead = $title->userCanRead();
812 $skname = $this->skinname
;
814 $preventActiveTabs = false;
815 wfRunHooks( 'SkinTemplatePreventOtherActiveTabs', array( &$this, &$preventActiveTabs ) );
817 // Checks if page is some kind of content
818 if( $title->getNamespace() != NS_SPECIAL
) {
819 // Gets page objects for the related namespaces
820 $subjectPage = $title->getSubjectPage();
821 $talkPage = $title->getTalkPage();
823 // Determines if this is a talk page
824 $isTalk = $title->isTalkPage();
826 // Generates XML IDs from namespace names
827 $subjectId = $title->getNamespaceKey( '' );
829 if ( $subjectId == 'main' ) {
832 $talkId = "{$subjectId}_talk";
835 // Adds namespace links
836 $subjectMsg = array( "nstab-$subjectId" );
837 if ( $subjectPage->isMainPage() ) {
838 array_unshift($subjectMsg, 'mainpage-nstab');
840 $content_navigation['namespaces'][$subjectId] = $this->tabAction(
841 $subjectPage, $subjectMsg, !$isTalk && !$preventActiveTabs, '', $userCanRead
843 $content_navigation['namespaces'][$subjectId]['context'] = 'subject';
844 $content_navigation['namespaces'][$talkId] = $this->tabAction(
845 $talkPage, array( "nstab-$talkId", 'talk' ), $isTalk && !$preventActiveTabs, '', $userCanRead
847 $content_navigation['namespaces'][$talkId]['context'] = 'talk';
849 // Adds view view link
850 if ( $title->exists() && $userCanRead ) {
851 $content_navigation['views']['view'] = $this->tabAction(
852 $isTalk ?
$talkPage : $subjectPage,
853 array( "$skname-view-view", 'view' ),
854 ( $onPage && ($action == 'view' ||
$action == 'purge' ) ), '', true
856 $content_navigation['views']['view']['redundant'] = true; // signal to hide this from simple content_actions
859 wfProfileIn( __METHOD__
. '-edit' );
861 // Checks if user can...
863 // read and edit the current page
864 $userCanRead && $title->quickUserCan( 'edit' ) &&
868 // or they can create one here
869 $title->quickUserCan( 'create' )
872 // Builds CSS class for talk page links
873 $isTalkClass = $isTalk ?
' istalk' : '';
875 // Determines if we're in edit mode
878 ( $action == 'edit' ||
$action == 'submit' ) &&
879 ( $section != 'new' )
881 $msgKey = $title->exists() ||
( $title->getNamespace() == NS_MEDIAWIKI
&& $title->getDefaultMessageText() !== false ) ?
883 $content_navigation['views']['edit'] = array(
884 'class' => ( $selected ?
'selected' : '' ) . $isTalkClass,
885 'text' => wfMessageFallback( "$skname-view-$msgKey", $msgKey )->text(),
886 'href' => $title->getLocalURL( $this->editUrlOptions() ),
887 'primary' => true, // don't collapse this in vector
889 // Checks if this is a current rev of talk page and we should show a new
891 if ( ( $isTalk && $this->isRevisionCurrent() ) ||
( $out->showNewSectionLink() ) ) {
892 // Checks if we should ever show a new section link
893 if ( !$out->forceHideNewSectionLink() ) {
894 // Adds new section link
895 //$content_navigation['actions']['addsection']
896 $content_navigation['views']['addsection'] = array(
897 'class' => $section == 'new' ?
'selected' : false,
898 'text' => wfMessageFallback( "$skname-action-addsection", 'addsection' )->text(),
899 'href' => $title->getLocalURL( 'action=edit§ion=new' )
903 // Checks if the page has some kind of viewable content
904 } elseif ( $title->hasSourceText() && $userCanRead ) {
905 // Adds view source view link
906 $content_navigation['views']['viewsource'] = array(
907 'class' => ( $onPage && $action == 'edit' ) ?
'selected' : false,
908 'text' => wfMessageFallback( "$skname-action-viewsource", 'viewsource' )->text(),
909 'href' => $title->getLocalURL( $this->editUrlOptions() ),
910 'primary' => true, // don't collapse this in vector
913 wfProfileOut( __METHOD__
. '-edit' );
915 wfProfileIn( __METHOD__
. '-live' );
917 // Checks if the page exists
918 if ( $title->exists() && $userCanRead ) {
919 // Adds history view link
920 $content_navigation['views']['history'] = array(
921 'class' => ( $onPage && $action == 'history' ) ?
'selected' : false,
922 'text' => wfMessageFallback( "$skname-view-history", 'history_short' )->text(),
923 'href' => $title->getLocalURL( 'action=history' ),
927 if( $user->isAllowed( 'delete' ) ) {
928 $content_navigation['actions']['delete'] = array(
929 'class' => ( $onPage && $action == 'delete' ) ?
'selected' : false,
930 'text' => wfMessageFallback( "$skname-action-delete", 'delete' )->text(),
931 'href' => $title->getLocalURL( 'action=delete' )
934 if ( $title->quickUserCan( 'move' ) ) {
935 $moveTitle = SpecialPage
::getTitleFor( 'Movepage', $title->getPrefixedDBkey() );
936 $content_navigation['actions']['move'] = array(
937 'class' => $this->getTitle()->isSpecial( 'Movepage' ) ?
'selected' : false,
938 'text' => wfMessageFallback( "$skname-action-move", 'move' )->text(),
939 'href' => $moveTitle->getLocalURL()
943 if ( $title->getNamespace() !== NS_MEDIAWIKI
&& $user->isAllowed( 'protect' ) ) {
944 $mode = !$title->isProtected() ?
'protect' : 'unprotect';
945 $content_navigation['actions'][$mode] = array(
946 'class' => ( $onPage && $action == $mode ) ?
'selected' : false,
947 'text' => wfMessageFallback( "$skname-action-$mode", $mode )->text(),
948 'href' => $title->getLocalURL( "action=$mode" )
952 // article doesn't exist or is deleted
953 if ( $user->isAllowed( 'deletedhistory' ) ) {
954 $n = $title->isDeleted();
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 ->params( $this->getLang()->formatNum( $n ) )->text(),
963 'href' => $undelTitle->getLocalURL( array( 'target' => $title->getPrefixedDBkey() ) )
968 if ( $title->getNamespace() !== NS_MEDIAWIKI
&& $user->isAllowed( 'protect' ) ) {
969 $mode = !$title->getRestrictions( 'create' ) ?
'protect' : 'unprotect';
970 $content_navigation['actions'][$mode] = array(
971 'class' => ( $onPage && $action == $mode ) ?
'selected' : false,
972 'text' => wfMessageFallback( "$skname-action-$mode", $mode )->text(),
973 'href' => $title->getLocalURL( "action=$mode" )
977 wfProfileOut( __METHOD__
. '-live' );
979 // Checks if the user is logged in
980 if ( $this->loggedin
) {
982 * The following actions use messages which, if made particular to
983 * the any specific skins, would break the Ajax code which makes this
984 * action happen entirely inline. Skin::makeGlobalVariablesScript
985 * defines a set of messages in a javascript object - and these
986 * messages are assumed to be global for all skins. Without making
987 * a change to that procedure these messages will have to remain as
988 * the global versions.
990 $mode = $title->userIsWatching() ?
'unwatch' : 'watch';
991 $token = WatchAction
::getWatchToken( $title, $user, $mode );
992 $content_navigation['actions'][$mode] = array(
993 'class' => $onPage && ( $action == 'watch' ||
$action == 'unwatch' ) ?
'selected' : false,
994 'text' => wfMsg( $mode ), // uses 'watch' or 'unwatch' message
995 'href' => $title->getLocalURL( array( 'action' => $mode, 'token' => $token ) )
999 wfRunHooks( 'SkinTemplateNavigation', array( &$this, &$content_navigation ) );
1001 // If it's not content, it's got to be a special page
1002 $content_navigation['namespaces']['special'] = array(
1003 'class' => 'selected',
1004 'text' => wfMsg( 'nstab-special' ),
1005 'href' => $request->getRequestURL(), // @bug 2457, 2510
1006 'context' => 'subject'
1009 wfRunHooks( 'SkinTemplateNavigation::SpecialPage',
1010 array( &$this, &$content_navigation ) );
1013 if ( !$wgDisableLangConversion && $title->getNamespace() != NS_SPECIAL
) {
1014 $pageLang = $title->getPageLanguage();
1015 // Gets list of language variants
1016 $variants = $pageLang->getVariants();
1017 // Checks that language conversion is enabled and variants exist
1018 // And if it is not in the special namespace
1019 if( count( $variants ) > 1 ) {
1020 // Gets preferred variant (note that user preference is
1021 // only possible for wiki content language variant)
1022 $preferred = $pageLang->getPreferredVariant();
1023 // Loops over each variant
1024 foreach( $variants as $code ) {
1025 // Gets variant name from language code
1026 $varname = $pageLang->getVariantname( $code );
1027 // Checks if the variant is marked as disabled
1028 if( $varname == 'disable' ) {
1029 // Skips this variant
1032 // Appends variant link
1033 $content_navigation['variants'][] = array(
1034 'class' => ( $code == $preferred ) ?
'selected' : false,
1036 'href' => $title->getLocalURL( '', $code )
1042 // Equiv to SkinTemplateContentActions
1043 wfRunHooks( 'SkinTemplateNavigation::Universal', array( &$this, &$content_navigation ) );
1045 // Setup xml ids and tooltip info
1046 foreach ( $content_navigation as $section => &$links ) {
1047 foreach ( $links as $key => &$link ) {
1049 if ( isset( $link['context'] ) && $link['context'] == 'subject' ) {
1050 $xmlID = 'ca-nstab-' . $xmlID;
1051 } elseif ( isset( $link['context'] ) && $link['context'] == 'talk' ) {
1053 } elseif ( $section == "variants" ) {
1054 $xmlID = 'ca-varlang-' . $xmlID;
1056 $xmlID = 'ca-' . $xmlID;
1058 $link['id'] = $xmlID;
1062 # We don't want to give the watch tab an accesskey if the
1063 # page is being edited, because that conflicts with the
1064 # accesskey on the watch checkbox. We also don't want to
1065 # give the edit tab an accesskey, because that's fairly su-
1066 # perfluous and conflicts with an accesskey (Ctrl-E) often
1067 # used for editing in Safari.
1068 if( in_array( $action, array( 'edit', 'submit' ) ) ) {
1069 if ( isset($content_navigation['views']['edit']) ) {
1070 $content_navigation['views']['edit']['tooltiponly'] = true;
1072 if ( isset($content_navigation['actions']['watch']) ) {
1073 $content_navigation['actions']['watch']['tooltiponly'] = true;
1075 if ( isset($content_navigation['actions']['unwatch']) ) {
1076 $content_navigation['actions']['unwatch']['tooltiponly'] = true;
1080 wfProfileOut( __METHOD__
);
1082 return $content_navigation;
1086 * an array of edit links by default used for the tabs
1090 function buildContentActionUrls( $content_navigation ) {
1092 wfProfileIn( __METHOD__
);
1094 // content_actions has been replaced with content_navigation for backwards
1095 // compatibility and also for skins that just want simple tabs content_actions
1096 // is now built by flattening the content_navigation arrays into one
1098 $content_actions = array();
1100 foreach ( $content_navigation as $links ) {
1102 foreach ( $links as $key => $value ) {
1104 if ( isset($value["redundant"]) && $value["redundant"] ) {
1105 // Redundant tabs are dropped from content_actions
1109 // content_actions used to have ids built using the "ca-$key" pattern
1110 // so the xmlID based id is much closer to the actual $key that we want
1111 // for that reason we'll just strip out the ca- if present and use
1112 // the latter potion of the "id" as the $key
1113 if ( isset($value["id"]) && substr($value["id"], 0, 3) == "ca-" ) {
1114 $key = substr($value["id"], 3);
1117 if ( isset($content_actions[$key]) ) {
1118 wfDebug( __METHOD__
. ": Found a duplicate key for $key while flattening content_navigation into content_actions." );
1122 $content_actions[$key] = $value;
1128 wfProfileOut( __METHOD__
);
1130 return $content_actions;
1134 * build array of common navigation links
1138 protected function buildNavUrls() {
1139 global $wgUseTrackbacks;
1140 global $wgUploadNavigationUrl;
1142 wfProfileIn( __METHOD__
);
1144 $out = $this->getOutput();
1145 $request = $this->getRequest();
1147 $nav_urls = array();
1148 $nav_urls['mainpage'] = array( 'href' => self
::makeMainPageUrl() );
1149 if( $wgUploadNavigationUrl ) {
1150 $nav_urls['upload'] = array( 'href' => $wgUploadNavigationUrl );
1151 } elseif( UploadBase
::isEnabled() && UploadBase
::isAllowed( $this->getUser() ) === true ) {
1152 $nav_urls['upload'] = array( 'href' => self
::makeSpecialUrl( 'Upload' ) );
1154 $nav_urls['upload'] = false;
1156 $nav_urls['specialpages'] = array( 'href' => self
::makeSpecialUrl( 'Specialpages' ) );
1158 // default permalink to being off, will override it as required below.
1159 $nav_urls['permalink'] = false;
1161 // A print stylesheet is attached to all pages, but nobody ever
1162 // figures that out. :) Add a link...
1163 if( $out->isArticle() ) {
1164 if ( !$out->isPrintable() ) {
1165 $nav_urls['print'] = array(
1166 'text' => wfMsg( 'printableversion' ),
1167 'href' => $this->getTitle()->getLocalURL(
1168 $request->appendQueryValue( 'printable', 'yes', true ) )
1172 // Also add a "permalink" while we're at it
1173 $revid = $this->getRevisionId();
1175 $nav_urls['permalink'] = array(
1176 'text' => wfMsg( 'permalink' ),
1177 'href' => $out->getTitle()->getLocalURL( "oldid=$revid" )
1181 // Use the copy of revision ID in case this undocumented, shady hook tries to mess with internals
1182 wfRunHooks( 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink',
1183 array( &$this, &$nav_urls, &$revid, &$revid ) );
1186 if( $this->getTitle()->getNamespace() != NS_SPECIAL
) {
1187 $wlhTitle = SpecialPage
::getTitleFor( 'Whatlinkshere', $this->thispage
);
1188 $nav_urls['whatlinkshere'] = array(
1189 'href' => $wlhTitle->getLocalUrl()
1191 if( $this->getTitle()->getArticleId() ) {
1192 $rclTitle = SpecialPage
::getTitleFor( 'Recentchangeslinked', $this->thispage
);
1193 $nav_urls['recentchangeslinked'] = array(
1194 'href' => $rclTitle->getLocalUrl()
1197 $nav_urls['recentchangeslinked'] = false;
1199 if( $wgUseTrackbacks )
1200 $nav_urls['trackbacklink'] = array(
1201 'href' => $out->getTitle()->trackbackURL()
1205 $user = $this->getRelevantUser();
1207 $id = $user->getID();
1208 $ip = $user->isAnon();
1209 $rootUser = $user->getName();
1216 if( $id ||
$ip ) { # both anons and non-anons have contribs list
1217 $nav_urls['contributions'] = array(
1218 'href' => self
::makeSpecialUrlSubpage( 'Contributions', $rootUser )
1222 $logPage = SpecialPage
::getTitleFor( 'Log' );
1223 $nav_urls['log'] = array(
1224 'href' => $logPage->getLocalUrl(
1231 $nav_urls['log'] = false;
1234 if ( $this->getUser()->isAllowed( 'block' ) ) {
1235 $nav_urls['blockip'] = array(
1236 'href' => self
::makeSpecialUrlSubpage( 'Block', $rootUser )
1239 $nav_urls['blockip'] = false;
1242 $nav_urls['contributions'] = false;
1243 $nav_urls['log'] = false;
1244 $nav_urls['blockip'] = false;
1246 $nav_urls['emailuser'] = false;
1247 if( $this->showEmailUser( $id ) ) {
1248 $nav_urls['emailuser'] = array(
1249 'href' => self
::makeSpecialUrlSubpage( 'Emailuser', $rootUser )
1252 wfProfileOut( __METHOD__
);
1257 * Generate strings used for xml 'id' names
1261 function getNameSpaceKey() {
1262 return $this->getTitle()->getNamespaceKey();
1267 * @todo FIXME: Why is this duplicated in/from OutputPage::getHeadScripts()??
1269 function setupUserJs( $allowUserJs ) {
1270 global $wgJsMimeType;
1271 wfProfileIn( __METHOD__
);
1273 if( $allowUserJs && $this->loggedin
) {
1274 if( $this->getTitle()->isJsSubpage() and $this->getOutput()->userCanPreview() ) {
1275 # XXX: additional security check/prompt?
1276 $this->userjsprev
= '/*<![CDATA[*/ ' . $this->getRequest()->getText( 'wpTextbox1' ) . ' /*]]>*/';
1278 $this->userjs
= self
::makeUrl( $this->userpage
. '/' . $this->skinname
. '.js', 'action=raw&ctype=' . $wgJsMimeType );
1281 wfProfileOut( __METHOD__
);
1284 public function commonPrintStylesheet() {
1290 * Generic wrapper for template functions, with interface
1291 * compatible with what we use of PHPTAL 0.7.
1294 abstract class QuickTemplate
{
1298 public function QuickTemplate() {
1299 $this->data
= array();
1300 $this->translator
= new MediaWiki_I18N();
1304 * Sets the value $value to $name
1308 public function set( $name, $value ) {
1309 $this->data
[$name] = $value;
1316 public function setRef( $name, &$value ) {
1317 $this->data
[$name] =& $value;
1323 public function setTranslator( &$t ) {
1324 $this->translator
= &$t;
1328 * Main function, used by classes that subclass QuickTemplate
1329 * to show the actual HTML output
1331 abstract public function execute();
1336 function text( $str ) {
1337 echo htmlspecialchars( $this->data
[$str] );
1343 function jstext( $str ) {
1344 echo Xml
::escapeJsString( $this->data
[$str] );
1350 function html( $str ) {
1351 echo $this->data
[$str];
1357 function msg( $str ) {
1358 echo htmlspecialchars( $this->translator
->translate( $str ) );
1364 function msgHtml( $str ) {
1365 echo $this->translator
->translate( $str );
1369 * An ugly, ugly hack.
1372 function msgWiki( $str ) {
1375 $text = $this->translator
->translate( $str );
1376 echo $wgOut->parse( $text );
1382 function haveData( $str ) {
1383 return isset( $this->data
[$str] );
1391 function haveMsg( $str ) {
1392 $msg = $this->translator
->translate( $str );
1393 return ( $msg != '-' ) && ( $msg != '' ); # ????
1397 * Get the Skin object related to this object
1399 * @return Skin object
1401 public function getSkin() {
1402 return $this->data
['skin'];
1407 * New base template for a skin's template extended from QuickTemplate
1408 * this class features helper methods that provide common ways of interacting
1409 * with the data stored in the QuickTemplate
1411 abstract class BaseTemplate
extends QuickTemplate
{
1414 * Create an array of common toolbox items from the data in the quicktemplate
1415 * stored by SkinTemplate.
1416 * The resulting array is built acording to a format intended to be passed
1417 * through makeListItem to generate the html.
1419 function getToolbox() {
1420 wfProfileIn( __METHOD__
);
1423 if ( $this->data
['notspecialpage'] ) {
1424 $toolbox['whatlinkshere'] = $this->data
['nav_urls']['whatlinkshere'];
1425 $toolbox['whatlinkshere']['id'] = 't-whatlinkshere';
1426 if ( $this->data
['nav_urls']['recentchangeslinked'] ) {
1427 $toolbox['recentchangeslinked'] = $this->data
['nav_urls']['recentchangeslinked'];
1428 $toolbox['recentchangeslinked']['msg'] = 'recentchangeslinked-toolbox';
1429 $toolbox['recentchangeslinked']['id'] = 't-recentchangeslinked';
1432 if( isset( $this->data
['nav_urls']['trackbacklink'] ) && $this->data
['nav_urls']['trackbacklink'] ) {
1433 $toolbox['trackbacklink'] = $this->data
['nav_urls']['trackbacklink'];
1434 $toolbox['trackbacklink']['id'] = 't-trackbacklink';
1436 if ( $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';
1447 foreach ( array( 'contributions', 'log', 'blockip', 'emailuser', 'upload', 'specialpages' ) as $special ) {
1448 if ( $this->data
['nav_urls'][$special] ) {
1449 $toolbox[$special] = $this->data
['nav_urls'][$special];
1450 $toolbox[$special]['id'] = "t-$special";
1453 if ( !empty( $this->data
['nav_urls']['print']['href'] ) ) {
1454 $toolbox['print'] = $this->data
['nav_urls']['print'];
1455 $toolbox['print']['rel'] = 'alternate';
1456 $toolbox['print']['msg'] = 'printableversion';
1458 if( $this->data
['nav_urls']['permalink'] ) {
1459 $toolbox['permalink'] = $this->data
['nav_urls']['permalink'];
1460 if( $toolbox['permalink']['href'] === '' ) {
1461 unset( $toolbox['permalink']['href'] );
1462 $toolbox['ispermalink']['tooltiponly'] = true;
1463 $toolbox['ispermalink']['id'] = 't-ispermalink';
1464 $toolbox['ispermalink']['msg'] = 'permalink';
1466 $toolbox['permalink']['id'] = 't-permalink';
1469 wfRunHooks( 'BaseTemplateToolbox', array( &$this, &$toolbox ) );
1470 wfProfileOut( __METHOD__
);
1475 * Create an array of personal tools items from the data in the quicktemplate
1476 * stored by SkinTemplate.
1477 * The resulting array is built acording to a format intended to be passed
1478 * through makeListItem to generate the html.
1479 * This is in reality the same list as already stored in personal_urls
1480 * however it is reformatted so that you can just pass the individual items
1481 * to makeListItem instead of hardcoding the element creation boilerplate.
1483 function getPersonalTools() {
1484 $personal_tools = array();
1485 foreach( $this->data
['personal_urls'] as $key => $ptool ) {
1486 # The class on a personal_urls item is meant to go on the <a> instead
1487 # of the <li> so we have to use a single item "links" array instead
1488 # of using most of the personal_url's keys directly
1489 $personal_tools[$key] = array();
1490 $personal_tools[$key]["links"][] = array();
1491 $personal_tools[$key]["links"][0]["single-id"] = $personal_tools[$key]["id"] = "pt-$key";
1492 if ( isset($ptool["active"]) ) {
1493 $personal_tools[$key]["active"] = $ptool["active"];
1495 foreach ( array("href", "class", "text") as $k ) {
1496 if ( isset($ptool[$k]) )
1497 $personal_tools[$key]["links"][0][$k] = $ptool[$k];
1500 return $personal_tools;
1503 function getSidebar( $options = array() ) {
1504 // Force the rendering of the following portals
1505 $sidebar = $this->data
['sidebar'];
1506 if ( !isset( $sidebar['SEARCH'] ) ) {
1507 $sidebar['SEARCH'] = true;
1509 if ( !isset( $sidebar['TOOLBOX'] ) ) {
1510 $sidebar['TOOLBOX'] = true;
1512 if ( !isset( $sidebar['LANGUAGES'] ) ) {
1513 $sidebar['LANGUAGES'] = true;
1516 if ( !isset( $options['search'] ) ||
$options['search'] !== true ) {
1517 unset( $sidebar['SEARCH'] );
1519 if ( isset( $options['toolbox'] ) && $options['toolbox'] === false ) {
1520 unset( $sidebar['TOOLBOX'] );
1522 if ( isset( $options['languages'] ) && $options['languages'] === false ) {
1523 unset( $sidebar['LANGUAGES'] );
1527 foreach ( $sidebar as $boxName => $content ) {
1528 if ( $content === false ) {
1531 switch ( $boxName ) {
1533 // Search is a special case, skins should custom implement this
1534 $boxes[$boxName] = array(
1536 'header' => wfMessage( 'search' )->text(),
1537 'generated' => false,
1542 $msgObj = wfMessage( 'toolbox' );
1543 $boxes[$boxName] = array(
1545 'header' => $msgObj->exists() ?
$msgObj->text() : 'toolbox',
1546 'generated' => false,
1547 'content' => $this->getToolbox(),
1551 if ( $this->data
['language_urls'] ) {
1552 $msgObj = wfMessage( 'otherlanguages' );
1553 $boxes[$boxName] = array(
1555 'header' => $msgObj->exists() ?
$msgObj->text() : 'otherlanguages',
1556 'generated' => false,
1557 'content' => $this->data
['language_urls'],
1562 $msgObj = wfMessage( $boxName );
1563 $boxes[$boxName] = array(
1564 'id' => "p-$boxName",
1565 'header' => $msgObj->exists() ?
$msgObj->text() : $boxName,
1566 'generated' => true,
1567 'content' => $content,
1573 // HACK: Compatibility with extensions still using SkinTemplateToolboxEnd
1574 $hookContents = null;
1575 if ( isset( $boxes['TOOLBOX'] ) ) {
1577 // We pass an extra 'true' at the end so extensions using BaseTemplateToolbox
1578 // can abort and avoid outputting double toolbox links
1579 wfRunHooks( 'SkinTemplateToolboxEnd', array( &$this, true ) );
1580 $hookContents = ob_get_contents();
1582 if ( !trim( $hookContents ) ) {
1583 $hookContents = null;
1588 if ( isset( $options['htmlOnly'] ) && $options['htmlOnly'] === true ) {
1589 foreach ( $boxes as $boxName => $box ) {
1590 if ( is_array( $box['content'] ) ) {
1592 foreach ( $box['content'] as $key => $val ) {
1593 $content .= "\n " . $this->makeListItem( $key, $val );
1595 // HACK, shove the toolbox end onto the toolbox if we're rendering itself
1596 if ( $hookContents ) {
1597 $content .= "\n $hookContents";
1600 $content .= "\n</ul>\n";
1601 $boxes[$boxName]['content'] = $content;
1605 if ( $hookContents ) {
1606 $boxes['TOOLBOXEND'] = array(
1607 'id' => "p-toolboxend",
1608 'header' => $boxes['TOOLBOX']['header'],
1609 'generated' => false,
1610 'content' => "<ul>{$hookContents}</ul>",
1612 // HACK: Make sure that TOOLBOXEND is sorted next to TOOLBOX
1614 foreach ( $boxes as $key => $box ) {
1615 if ( $key === 'TOOLBOXEND' ) {
1618 $boxes2[$key] = $box;
1619 if ( $key === 'TOOLBOX' ) {
1620 $boxes2['TOOLBOXEND'] = $boxes['TOOLBOXEND'];
1632 * Makes a link, usually used by makeListItem to generate a link for an item
1633 * in a list used in navigation lists, portlets, portals, sidebars, etc...
1635 * $key is a string, usually a key from the list you are generating this link from
1636 * $item is an array containing some of a specific set of keys.
1637 * The text of the link will be generated either from the contents of the "text"
1638 * key in the $item array, if a "msg" key is present a message by that name will
1639 * be used, and if neither of those are set the $key will be used as a message name.
1640 * If a "href" key is not present makeLink will just output htmlescaped text.
1641 * The href, id, class, rel, and type keys are used as attributes for the link if present.
1642 * If an "id" or "single-id" (if you don't want the actual id to be output on the link)
1643 * is present it will be used to generate a tooltip and accesskey for the link.
1644 * If you don't want an accesskey, set $item['tooltiponly'] = true;
1645 * $options can be used to affect the output of a link:
1646 * You can use a text-wrapper key to specify a list of elements to wrap the
1647 * text of a link in. This should be an array of arrays containing a 'tag' and
1648 * optionally an 'attributes' key. If you only have one element you don't need
1649 * to wrap it in another array. eg: To use <a><span>...</span></a> in all links
1650 * use array( 'text-wrapper' => array( 'tag' => 'span' ) ) for your options.
1651 * A link-class key can be used to specify additional classes to apply to all links.
1652 * A link-fallback can be used to specify a tag to use instead of <a> if there is
1653 * no link. eg: If you specify 'link-fallback' => 'span' than any non-link will
1654 * output a <span> instead of just text.
1656 function makeLink( $key, $item, $options = array() ) {
1657 if ( isset( $item['text'] ) ) {
1658 $text = $item['text'];
1660 $text = $this->translator
->translate( isset( $item['msg'] ) ?
$item['msg'] : $key );
1663 $html = htmlspecialchars( $text );
1665 if ( isset( $options['text-wrapper'] ) ) {
1666 $wrapper = $options['text-wrapper'];
1667 if ( isset( $wrapper['tag'] ) ) {
1668 $wrapper = array( $wrapper );
1670 while ( count( $wrapper ) > 0 ) {
1671 $element = array_pop( $wrapper );
1672 $html = Html
::rawElement( $element['tag'], isset( $element['attributes'] ) ?
$element['attributes'] : null, $html );
1676 if ( isset( $item['href'] ) ||
isset( $options['link-fallback'] ) ) {
1678 foreach ( array( 'single-id', 'text', 'msg', 'tooltiponly' ) as $k ) {
1679 unset( $attrs[$k] );
1682 if ( isset( $item['id'] ) && !isset( $item['single-id'] ) ) {
1683 $item['single-id'] = $item['id'];
1685 if ( isset( $item['single-id'] ) ) {
1686 if ( isset( $item['tooltiponly'] ) && $item['tooltiponly'] ) {
1687 $title = Linker
::titleAttrib( $item['single-id'] );
1688 if ( $title !== false ) {
1689 $attrs['title'] = $title;
1692 $tip = Linker
::tooltipAndAccesskeyAttribs( $item['single-id'] );
1693 if ( isset( $tip['title'] ) && $tip['title'] !== false ) {
1694 $attrs['title'] = $tip['title'];
1696 if ( isset( $tip['accesskey'] ) && $tip['accesskey'] !== false ) {
1697 $attrs['accesskey'] = $tip['accesskey'];
1701 if ( isset( $options['link-class'] ) ) {
1702 if ( isset( $attrs['class'] ) ) {
1703 $attrs['class'] .= " {$options['link-class']}";
1705 $attrs['class'] = $options['link-class'];
1708 $html = Html
::rawElement( isset( $attrs['href'] ) ?
'a' : $options['link-fallback'], $attrs, $html );
1715 * Generates a list item for a navigation, portlet, portal, sidebar... etc list
1716 * $key is a string, usually a key from the list you are generating this link from
1717 * $item is an array of list item data containing some of a specific set of keys.
1718 * The "id" and "class" keys will be used as attributes for the list item,
1719 * if "active" contains a value of true a "active" class will also be appended to class.
1720 * If you want something other than a <li> you can pass a tag name such as
1721 * "tag" => "span" in the $options array to change the tag used.
1722 * link/content data for the list item may come in one of two forms
1723 * A "links" key may be used, in which case it should contain an array with
1724 * a list of links to include inside the list item, see makeLink for the format
1725 * of individual links array items.
1726 * Otherwise the relevant keys from the list item $item array will be passed
1727 * to makeLink instead. Note however that "id" and "class" are used by the
1728 * list item directly so they will not be passed to makeLink
1729 * (however the link will still support a tooltip and accesskey from it)
1730 * If you need an id or class on a single link you should include a "links"
1731 * array with just one link item inside of it.
1732 * $options is also passed on to makeLink calls
1734 function makeListItem( $key, $item, $options = array() ) {
1735 if ( isset( $item['links'] ) ) {
1737 foreach ( $item['links'] as $linkKey => $link ) {
1738 $html .= $this->makeLink( $linkKey, $link, $options );
1742 // These keys are used by makeListItem and shouldn't be passed on to the link
1743 foreach ( array( 'id', 'class', 'active', 'tag' ) as $k ) {
1746 if ( isset( $item['id'] ) ) {
1747 // The id goes on the <li> not on the <a> for single links
1748 // but makeSidebarLink still needs to know what id to use when
1749 // generating tooltips and accesskeys.
1750 $link['single-id'] = $item['id'];
1752 $html = $this->makeLink( $key, $link, $options );
1756 foreach ( array( 'id', 'class' ) as $attr ) {
1757 if ( isset( $item[$attr] ) ) {
1758 $attrs[$attr] = $item[$attr];
1761 if ( isset( $item['active'] ) && $item['active'] ) {
1762 if ( !isset( $attrs['class'] ) ) {
1763 $attrs['class'] = '';
1765 $attrs['class'] .= ' active';
1766 $attrs['class'] = trim( $attrs['class'] );
1768 return Html
::rawElement( isset( $options['tag'] ) ?
$options['tag'] : 'li', $attrs, $html );
1771 function makeSearchInput( $attrs = array() ) {
1775 'value' => isset( $this->data
['search'] ) ?
$this->data
['search'] : '',
1777 $realAttrs = array_merge( $realAttrs, Linker
::tooltipAndAccesskeyAttribs( 'search' ), $attrs );
1778 return Html
::element( 'input', $realAttrs );
1781 function makeSearchButton( $mode, $attrs = array() ) {
1788 'value' => $this->translator
->translate(
1789 $mode == 'go' ?
'searcharticle' : 'searchbutton' ),
1791 $realAttrs = array_merge(
1793 Linker
::tooltipAndAccesskeyAttribs( "search-$mode" ),
1796 return Html
::element( 'input', $realAttrs );
1798 $buttonAttrs = array(
1802 $buttonAttrs = array_merge(
1804 Linker
::tooltipAndAccesskeyAttribs( 'search-fulltext' ),
1807 unset( $buttonAttrs['src'] );
1808 unset( $buttonAttrs['alt'] );
1810 'src' => $attrs['src'],
1811 'alt' => isset( $attrs['alt'] )
1813 : $this->translator
->translate( 'searchbutton' ),
1815 return Html
::rawElement( 'button', $buttonAttrs, Html
::element( 'img', $imgAttrs ) );
1817 throw new MWException( 'Unknown mode passed to BaseTemplate::makeSearchButton' );
1822 * Returns an array of footerlinks trimmed down to only those footer links that
1824 * If you pass "flat" as an option then the returned array will be a flat array
1825 * of footer icons instead of a key/value array of footerlinks arrays broken
1826 * up into categories.
1828 function getFooterLinks( $option = null ) {
1829 $footerlinks = $this->data
['footerlinks'];
1831 // Reduce footer links down to only those which are being used
1832 $validFooterLinks = array();
1833 foreach( $footerlinks as $category => $links ) {
1834 $validFooterLinks[$category] = array();
1835 foreach( $links as $link ) {
1836 if( isset( $this->data
[$link] ) && $this->data
[$link] ) {
1837 $validFooterLinks[$category][] = $link;
1840 if ( count( $validFooterLinks[$category] ) <= 0 ) {
1841 unset( $validFooterLinks[$category] );
1845 if ( $option == 'flat' ) {
1846 // fold footerlinks into a single array using a bit of trickery
1847 $validFooterLinks = call_user_func_array(
1849 array_values( $validFooterLinks )
1853 return $validFooterLinks;
1857 * Returns an array of footer icons filtered down by options relevant to how
1858 * the skin wishes to display them.
1859 * If you pass "icononly" as the option all footer icons which do not have an
1860 * image icon set will be filtered out.
1861 * If you pass "nocopyright" then MediaWiki's copyright icon will not be included
1862 * in the list of footer icons. This is mostly useful for skins which only
1863 * display the text from footericons instead of the images and don't want a
1864 * duplicate copyright statement because footerlinks already rendered one.
1866 function getFooterIcons( $option = null ) {
1867 // Generate additional footer icons
1868 $footericons = $this->data
['footericons'];
1870 if ( $option == 'icononly' ) {
1871 // Unset any icons which don't have an image
1872 foreach ( $footericons as &$footerIconsBlock ) {
1873 foreach ( $footerIconsBlock as $footerIconKey => $footerIcon ) {
1874 if ( !is_string( $footerIcon ) && !isset( $footerIcon['src'] ) ) {
1875 unset( $footerIconsBlock[$footerIconKey] );
1879 // Redo removal of any empty blocks
1880 foreach ( $footericons as $footerIconsKey => &$footerIconsBlock ) {
1881 if ( count( $footerIconsBlock ) <= 0 ) {
1882 unset( $footericons[$footerIconsKey] );
1885 } elseif ( $option == 'nocopyright' ) {
1886 unset( $footericons['copyright']['copyright'] );
1887 if ( count( $footericons['copyright'] ) <= 0 ) {
1888 unset( $footericons['copyright'] );
1892 return $footericons;
1896 * Output the basic end-page trail including bottomscripts, reporttime, and
1897 * debug stuff. This should be called right before outputting the closing
1898 * body and html tags.
1900 function printTrail() { ?
>
1901 <?php
$this->html('bottomscripts'); /* JS call to runBodyOnloadHook */ ?
>
1902 <?php
$this->html('reporttime') ?
>
1903 <?php
if ( $this->data
['debug'] ): ?
>
1905 <?php
$this->text( 'debug' ); ?
>