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 (or file)
120 * @param $repository string: subdirectory where we keep template files
121 * @param $cache_dir string
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 ) {
135 global $wgArticle, $wgUser, $wgLang, $wgContLang;
136 global $wgScript, $wgStylePath, $wgLanguageCode;
137 global $wgMimeType, $wgJsMimeType, $wgOutputEncoding, $wgRequest;
138 global $wgXhtmlDefaultNamespace, $wgXhtmlNamespaces, $wgHtml5Version;
139 global $wgDisableCounters, $wgLogo, $wgHideInterlanguageLinks;
140 global $wgMaxCredits, $wgShowCreditsIfMax;
141 global $wgPageShowWatchingUsers;
142 global $wgUseTrackbacks, $wgUseSiteJs, $wgDebugComments;
143 global $wgArticlePath, $wgScriptPath, $wgServer, $wgProfiler;
145 wfProfileIn( __METHOD__
);
146 if ( is_object( $wgProfiler ) ) {
147 $wgProfiler->setTemplated( true );
150 $oldid = $wgRequest->getVal( 'oldid' );
151 $diff = $wgRequest->getVal( 'diff' );
152 $action = $wgRequest->getVal( 'action', 'view' );
154 wfProfileIn( __METHOD__
. '-init' );
155 $this->initPage( $out );
158 $tpl = $this->setupTemplate( $this->template
, 'skins' );
160 #if ( $wgUseDatabaseMessages ) { // uncomment this to fall back to GetText
161 $tpl->setTranslator( new MediaWiki_I18N() );
163 wfProfileOut( __METHOD__
. '-init' );
165 wfProfileIn( __METHOD__
. '-stuff' );
166 $this->thispage
= $this->mTitle
->getPrefixedDBkey();
167 $this->thisurl
= $this->mTitle
->getPrefixedURL();
169 if ( !$wgRequest->wasPosted() ) {
170 $query = $wgRequest->getValues();
171 unset( $query['title'] );
172 unset( $query['returnto'] );
173 unset( $query['returntoquery'] );
175 $this->thisquery
= wfUrlencode( wfArrayToCGI( $query ) );
176 $this->loggedin
= $wgUser->isLoggedIn();
177 $this->iscontent
= ( $this->mTitle
->getNamespace() != NS_SPECIAL
);
178 $this->iseditable
= ( $this->iscontent
and !( $action == 'edit' or $action == 'submit' ) );
179 $this->username
= $wgUser->getName();
181 if ( $wgUser->isLoggedIn() ||
$this->showIPinHeader() ) {
182 $this->userpageUrlDetails
= self
::makeUrlDetails( $this->userpage
);
184 # This won't be used in the standard skins, but we define it to preserve the interface
185 # To save time, we check for existence
186 $this->userpageUrlDetails
= self
::makeKnownUrlDetails( $this->userpage
);
189 $this->titletxt
= $this->mTitle
->getPrefixedText();
190 wfProfileOut( __METHOD__
. '-stuff' );
192 wfProfileIn( __METHOD__
. '-stuff-head' );
193 if ( $this->useHeadElement
) {
194 $pagecss = $this->setupPageCss();
196 $out->addInlineStyle( $pagecss );
198 $this->setupUserCss( $out );
200 $tpl->set( 'pagecss', $this->setupPageCss() );
201 $tpl->setRef( 'usercss', $this->usercss
);
203 $this->userjs
= $this->userjsprev
= false;
204 $this->setupUserJs( $out->isUserJsAllowed() );
205 $tpl->setRef( 'userjs', $this->userjs
);
206 $tpl->setRef( 'userjsprev', $this->userjsprev
);
209 $jsCache = $this->loggedin ?
'&smaxage=0' : '';
210 $tpl->set( 'jsvarurl',
212 "action=raw$jsCache&gen=js&useskin=" .
213 urlencode( $this->getSkinName() ) ) );
215 $tpl->set( 'jsvarurl', false );
218 $tpl->setRef( 'xhtmldefaultnamespace', $wgXhtmlDefaultNamespace );
219 $tpl->set( 'xhtmlnamespaces', $wgXhtmlNamespaces );
220 $tpl->set( 'html5version', $wgHtml5Version );
221 $tpl->set( 'headlinks', $out->getHeadLinks( $this ) );
222 $tpl->set( 'csslinks', $out->buildCssLinks( $this ) );
224 if( $wgUseTrackbacks && $out->isArticleRelated() ) {
225 $tpl->set( 'trackbackhtml', $out->getTitle()->trackbackRDF() );
227 $tpl->set( 'trackbackhtml', null );
230 wfProfileOut( __METHOD__
. '-stuff-head' );
232 wfProfileIn( __METHOD__
. '-stuff2' );
233 $tpl->set( 'title', $out->getPageTitle() );
234 $tpl->set( 'pagetitle', $out->getHTMLTitle() );
235 $tpl->set( 'displaytitle', $out->mPageLinkTitle
);
236 $tpl->set( 'pageclass', $this->getPageClasses( $this->mTitle
) );
237 $tpl->set( 'skinnameclass', ( 'skin-' . Sanitizer
::escapeClass( $this->getSkinName() ) ) );
239 $nsname = MWNamespace
::exists( $this->mTitle
->getNamespace() ) ?
240 MWNamespace
::getCanonicalName( $this->mTitle
->getNamespace() ) :
241 $this->mTitle
->getNsText();
243 $tpl->set( 'nscanonical', $nsname );
244 $tpl->set( 'nsnumber', $this->mTitle
->getNamespace() );
245 $tpl->set( 'titleprefixeddbkey', $this->mTitle
->getPrefixedDBKey() );
246 $tpl->set( 'titletext', $this->mTitle
->getText() );
247 $tpl->set( 'articleid', $this->mTitle
->getArticleId() );
248 $tpl->set( 'currevisionid', $this->mTitle
->getLatestRevID() );
250 $tpl->set( 'isarticle', $out->isArticle() );
252 $tpl->setRef( 'thispage', $this->thispage
);
253 $subpagestr = $this->subPageSubtitle();
255 'subtitle', !empty( $subpagestr ) ?
256 '<span class="subpages">' . $subpagestr . '</span>' . $out->getSubtitle() :
259 $undelete = $this->getUndeleteLink();
261 'undelete', !empty( $undelete ) ?
262 '<span class="subpages">' . $undelete . '</span>' :
266 $tpl->set( 'catlinks', $this->getCategories() );
267 if( $out->isSyndicated() ) {
269 foreach( $out->getSyndicationLinks() as $format => $link ) {
270 $feeds[$format] = array(
271 'text' => wfMsg( "feed-$format" ),
275 $tpl->setRef( 'feeds', $feeds );
277 $tpl->set( 'feeds', false );
280 $tpl->setRef( 'mimetype', $wgMimeType );
281 $tpl->setRef( 'jsmimetype', $wgJsMimeType );
282 $tpl->setRef( 'charset', $wgOutputEncoding );
283 $tpl->setRef( 'wgScript', $wgScript );
284 $tpl->setRef( 'skinname', $this->skinname
);
285 $tpl->set( 'skinclass', get_class( $this ) );
286 $tpl->setRef( 'stylename', $this->stylename
);
287 $tpl->set( 'printable', $out->isPrintable() );
288 $tpl->set( 'handheld', $wgRequest->getBool( 'handheld' ) );
289 $tpl->setRef( 'loggedin', $this->loggedin
);
290 $tpl->set( 'notspecialpage', $this->mTitle
->getNamespace() != NS_SPECIAL
);
291 /* XXX currently unused, might get useful later
292 $tpl->set( 'editable', ( $this->mTitle->getNamespace() != NS_SPECIAL ) );
293 $tpl->set( 'exists', $this->mTitle->getArticleID() != 0 );
294 $tpl->set( 'watch', $this->mTitle->userIsWatching() ? 'unwatch' : 'watch' );
295 $tpl->set( 'protect', count( $this->mTitle->isProtected() ) ? 'unprotect' : 'protect' );
296 $tpl->set( 'helppage', wfMsg( 'helppage' ) );
298 $tpl->set( 'searchaction', $this->escapeSearchLink() );
299 $tpl->set( 'searchtitle', SpecialPage
::getTitleFor( 'Search' )->getPrefixedDBKey() );
300 $tpl->set( 'search', trim( $wgRequest->getVal( 'search' ) ) );
301 $tpl->setRef( 'stylepath', $wgStylePath );
302 $tpl->setRef( 'articlepath', $wgArticlePath );
303 $tpl->setRef( 'scriptpath', $wgScriptPath );
304 $tpl->setRef( 'serverurl', $wgServer );
305 $tpl->setRef( 'logopath', $wgLogo );
308 $tpl->set( 'lang', $lang->getCode() );
309 $tpl->set( 'dir', $lang->getDir() );
310 $tpl->set( 'rtl', $lang->isRTL() );
312 $tpl->set( 'capitalizeallnouns', $wgLang->capitalizeAllNouns() ?
' capitalize-all-nouns' : '' );
313 $tpl->set( 'showjumplinks', $wgUser->getOption( 'showjumplinks' ) );
314 $tpl->set( 'username', $wgUser->isAnon() ?
null : $this->username
);
315 $tpl->setRef( 'userpage', $this->userpage
);
316 $tpl->setRef( 'userpageurl', $this->userpageUrlDetails
['href'] );
317 $tpl->set( 'userlang', $wgLang->getCode() );
319 // Users can have their language set differently than the
320 // content of the wiki. For these users, tell the web browser
321 // that interface elements are in a different language.
322 $tpl->set( 'userlangattributes', '' );
323 $tpl->set( 'specialpageattributes', '' );
325 $lang = $wgLang->getCode();
326 $dir = $wgLang->getDir();
327 if ( $lang !== $wgContLang->getCode() ||
$dir !== $wgContLang->getDir() ) {
328 $attrs = " lang='$lang' dir='$dir'";
330 $tpl->set( 'userlangattributes', $attrs );
332 // The content of SpecialPages should be presented in the
333 // user's language. Content of regular pages should not be touched.
334 if( $this->mTitle
->isSpecialPage() ) {
335 $tpl->set( 'specialpageattributes', $attrs );
339 $newtalks = $this->getNewtalks();
341 wfProfileOut( __METHOD__
. '-stuff2' );
343 wfProfileIn( __METHOD__
. '-stuff3' );
344 $tpl->setRef( 'newtalk', $newtalks );
345 $tpl->setRef( 'skin', $this );
346 $tpl->set( 'logo', $this->logoText() );
347 if ( $out->isArticle() && ( !isset( $oldid ) ||
isset( $diff ) ) &&
348 $this->mTitle
->exists() ){
349 if ( !$wgDisableCounters ) {
350 $viewcount = $wgLang->formatNum( $wgArticle->getCount() );
352 $tpl->set( 'viewcount', wfMsgExt( 'viewcount', array( 'parseinline' ), $viewcount ) );
354 $tpl->set( 'viewcount', false );
357 $tpl->set( 'viewcount', false );
360 if( $wgPageShowWatchingUsers ) {
361 $dbr = wfGetDB( DB_SLAVE
);
362 $res = $dbr->select( 'watchlist',
363 array( 'COUNT(*) AS n' ),
364 array( 'wl_title' => $dbr->strencode( $this->mTitle
->getDBkey() ), 'wl_namespace' => $this->mTitle
->getNamespace() ),
367 $x = $dbr->fetchObject( $res );
368 $numberofwatchingusers = $x->n
;
369 if( $numberofwatchingusers > 0 ) {
370 $tpl->set( 'numberofwatchingusers',
371 wfMsgExt( 'number_of_watching_users_pageview', array( 'parseinline' ),
372 $wgLang->formatNum( $numberofwatchingusers ) )
375 $tpl->set( 'numberofwatchingusers', false );
378 $tpl->set( 'numberofwatchingusers', false );
381 $tpl->set( 'copyright', $this->getCopyright() );
383 $this->credits
= false;
385 if( $wgMaxCredits != 0 ){
386 $this->credits
= Credits
::getCredits( $wgArticle, $wgMaxCredits, $wgShowCreditsIfMax );
388 $tpl->set( 'lastmod', $this->lastModified() );
391 $tpl->setRef( 'credits', $this->credits
);
393 } elseif ( isset( $oldid ) && !isset( $diff ) ) {
394 $tpl->set( 'copyright', $this->getCopyright() );
395 $tpl->set( 'viewcount', false );
396 $tpl->set( 'lastmod', false );
397 $tpl->set( 'credits', false );
398 $tpl->set( 'numberofwatchingusers', false );
400 $tpl->set( 'copyright', false );
401 $tpl->set( 'viewcount', false );
402 $tpl->set( 'lastmod', false );
403 $tpl->set( 'credits', false );
404 $tpl->set( 'numberofwatchingusers', false );
406 wfProfileOut( __METHOD__
. '-stuff3' );
408 wfProfileIn( __METHOD__
. '-stuff4' );
409 $tpl->set( 'copyrightico', $this->getCopyrightIcon() );
410 $tpl->set( 'poweredbyico', $this->getPoweredBy() );
411 $tpl->set( 'disclaimer', $this->disclaimerLink() );
412 $tpl->set( 'privacy', $this->privacyLink() );
413 $tpl->set( 'about', $this->aboutLink() );
415 $tpl->set( 'footerlinks', array(
419 'numberofwatchingusers',
430 global $wgFooterIcons;
431 $tpl->set( 'footericons', $wgFooterIcons );
432 foreach ( $tpl->data
['footericons'] as $footerIconsKey => &$footerIconsBlock ) {
433 if ( count( $footerIconsBlock ) > 0 ) {
434 foreach ( $footerIconsBlock as &$footerIcon ) {
435 if ( isset( $footerIcon['src'] ) ) {
436 if ( !isset( $footerIcon['width'] ) ) {
437 $footerIcon['width'] = 88;
439 if ( !isset( $footerIcon['height'] ) ) {
440 $footerIcon['height'] = 31;
445 unset( $tpl->data
['footericons'][$footerIconsKey] );
449 if ( $wgDebugComments ) {
450 $tpl->setRef( 'debug', $out->mDebugtext
);
452 $tpl->set( 'debug', '' );
455 $tpl->set( 'reporttime', wfReportTime() );
456 $tpl->set( 'sitenotice', wfGetSiteNotice() );
457 $tpl->set( 'bottomscripts', $this->bottomScripts( $out ) );
459 $printfooter = "<div class=\"printfooter\">\n" . $this->printSource() . "</div>\n";
460 global $wgBetterDirectionality;
461 if ( $wgBetterDirectionality ) {
462 $realBodyAttribs = array( 'lang' => $wgLanguageCode, 'dir' => $wgContLang->getDir() );
463 $out->mBodytext
= Html
::rawElement( 'div', $realBodyAttribs, $out->mBodytext
);
465 $out->mBodytext
.= $printfooter . $this->generateDebugHTML();
466 $tpl->setRef( 'bodytext', $out->mBodytext
);
469 $language_urls = array();
471 if ( !$wgHideInterlanguageLinks ) {
472 foreach( $out->getLanguageLinks() as $l ) {
473 $tmp = explode( ':', $l, 2 );
474 $class = 'interwiki-' . $tmp[0];
476 $nt = Title
::newFromText( $l );
478 $language_urls[] = array(
479 'href' => $nt->getFullURL(),
480 'text' => ( $wgContLang->getLanguageName( $nt->getInterwiki() ) != '' ?
481 $wgContLang->getLanguageName( $nt->getInterwiki() ) : $l ),
482 'title' => $nt->getText(),
488 if( count( $language_urls ) ) {
489 $tpl->setRef( 'language_urls', $language_urls );
491 $tpl->set( 'language_urls', false );
493 wfProfileOut( __METHOD__
. '-stuff4' );
495 wfProfileIn( __METHOD__
. '-stuff5' );
497 $tpl->set( 'personal_urls', $this->buildPersonalUrls() );
498 $content_navigation = $this->buildContentNavigationUrls();
499 $content_actions = $this->buildContentActionUrls( $content_navigation );
500 $tpl->setRef( 'content_navigation', $content_navigation );
501 $tpl->setRef( 'content_actions', $content_actions );
503 $tpl->set( 'sidebar', $this->buildSidebar() );
504 $tpl->set( 'nav_urls', $this->buildNavUrls() );
506 // Set the head scripts near the end, in case the above actions resulted in added scripts
507 if ( $this->useHeadElement
) {
508 $tpl->set( 'headelement', $out->headElement( $this ) );
510 $tpl->set( 'headscripts', $out->getScript() );
513 // original version by hansm
514 if( !wfRunHooks( 'SkinTemplateOutputPageBeforeExec', array( &$this, &$tpl ) ) ) {
515 wfDebug( __METHOD__
. ": Hook SkinTemplateOutputPageBeforeExec broke outputPage execution!\n" );
518 // allow extensions adding stuff after the page content.
519 // See Skin::afterContentHook() for further documentation.
520 $tpl->set( 'dataAfterContent', $this->afterContentHook() );
521 wfProfileOut( __METHOD__
. '-stuff5' );
524 wfProfileIn( __METHOD__
. '-execute' );
525 $res = $tpl->execute();
526 wfProfileOut( __METHOD__
. '-execute' );
528 // result may be an error
529 $this->printOrError( $res );
530 wfProfileOut( __METHOD__
);
534 * Output the string, or print error message if it's
535 * an error object of the appropriate type.
536 * For the base class, assume strings all around.
541 function printOrError( $str ) {
546 * Output a boolean indiciating if buildPersonalUrls should output separate
547 * login and create account links or output a combined link
548 * By default we simply return a global config setting that affects most skins
549 * This is setup as a method so that like with $wgLogo and getLogo() a skin
550 * can override this setting and always output one or the other if it has
551 * a reason it can't output one of the two modes.
553 function useCombinedLoginLink() {
554 global $wgUseCombinedLoginLink;
555 return $wgUseCombinedLoginLink;
559 * build array of urls for personal toolbar
563 function buildPersonalUrls() {
564 global $wgOut, $wgRequest;
566 $title = $wgOut->getTitle();
567 $pageurl = $title->getLocalURL();
568 wfProfileIn( __METHOD__
);
570 /* set up the default links for the personal toolbar */
571 $personal_urls = array();
572 $page = $wgRequest->getVal( 'returnto', $this->thisurl
);
573 $query = $wgRequest->getVal( 'returntoquery', $this->thisquery
);
574 $returnto = "returnto=$page";
575 if( $this->thisquery
!= '' ) {
576 $returnto .= "&returntoquery=$query";
578 if( $this->loggedin
) {
579 $personal_urls['userpage'] = array(
580 'text' => $this->username
,
581 'href' => &$this->userpageUrlDetails
['href'],
582 'class' => $this->userpageUrlDetails
['exists'] ?
false : 'new',
583 'active' => ( $this->userpageUrlDetails
['href'] == $pageurl )
585 $usertalkUrlDetails = $this->makeTalkUrlDetails( $this->userpage
);
586 $personal_urls['mytalk'] = array(
587 'text' => wfMsg( 'mytalk' ),
588 'href' => &$usertalkUrlDetails['href'],
589 'class' => $usertalkUrlDetails['exists'] ?
false : 'new',
590 'active' => ( $usertalkUrlDetails['href'] == $pageurl )
592 $href = self
::makeSpecialUrl( 'Preferences' );
593 $personal_urls['preferences'] = array(
594 'text' => wfMsg( 'mypreferences' ),
596 'active' => ( $href == $pageurl )
598 $href = self
::makeSpecialUrl( 'Watchlist' );
599 $personal_urls['watchlist'] = array(
600 'text' => wfMsg( 'mywatchlist' ),
602 'active' => ( $href == $pageurl )
605 # We need to do an explicit check for Special:Contributions, as we
606 # have to match both the title, and the target (which could come
607 # from request values or be specified in "sub page" form. The plot
608 # thickens, because $wgTitle is altered for special pages, so doesn't
609 # contain the original alias-with-subpage.
610 $origTitle = Title
::newFromText( $wgRequest->getText( 'title' ) );
611 if( $origTitle instanceof Title
&& $origTitle->getNamespace() == NS_SPECIAL
) {
612 list( $spName, $spPar ) =
613 SpecialPage
::resolveAliasWithSubpage( $origTitle->getText() );
614 $active = $spName == 'Contributions'
615 && ( ( $spPar && $spPar == $this->username
)
616 ||
$wgRequest->getText( 'target' ) == $this->username
);
621 $href = self
::makeSpecialUrlSubpage( 'Contributions', $this->username
);
622 $personal_urls['mycontris'] = array(
623 'text' => wfMsg( 'mycontris' ),
627 $personal_urls['logout'] = array(
628 'text' => wfMsg( 'userlogout' ),
629 'href' => self
::makeSpecialUrl( 'Userlogout',
630 $title->isSpecial( 'Preferences' ) ?
'' : $returnto
636 $useCombinedLoginLink = $this->useCombinedLoginLink();
637 $loginlink = $wgUser->isAllowed( 'createaccount' ) && $useCombinedLoginLink
638 ?
'nav-login-createaccount'
640 $is_signup = $wgRequest->getText('type') == "signup";
642 # anonlogin & login are the same
644 'text' => wfMsg( $loginlink ),
645 'href' => self
::makeSpecialUrl( 'Userlogin', $returnto ),
646 'active' => $title->isSpecial( 'Userlogin' ) && ( $loginlink == "nav-login-createaccount" ||
!$is_signup )
648 if ( $wgUser->isAllowed( 'createaccount' ) && !$useCombinedLoginLink ) {
649 $createaccount_url = array(
650 'text' => wfMsg( 'createaccount' ),
651 'href' => self
::makeSpecialUrl( 'Userlogin', "$returnto&type=signup" ),
652 'active' => $title->isSpecial( 'Userlogin' ) && $is_signup
655 global $wgProto, $wgSecureLogin;
656 if( $wgProto === 'http' && $wgSecureLogin ) {
657 $title = SpecialPage
::getTitleFor( 'Userlogin' );
658 $https_url = preg_replace( '/^http:/', 'https:', $title->getFullURL() );
659 $login_url['href'] = $https_url;
660 $login_url['class'] = 'link-https'; # FIXME class depends on skin
661 if ( isset($createaccount_url) ) {
662 $https_url = preg_replace( '/^http:/', 'https:', $title->getFullURL("type=signup") );
663 $createaccount_url['href'] = $https_url;
664 $createaccount_url['class'] = 'link-https'; # FIXME class depends on skin
669 if( $this->showIPinHeader() ) {
670 $href = &$this->userpageUrlDetails
['href'];
671 $personal_urls['anonuserpage'] = array(
672 'text' => $this->username
,
674 'class' => $this->userpageUrlDetails
['exists'] ?
false : 'new',
675 'active' => ( $pageurl == $href )
677 $usertalkUrlDetails = $this->makeTalkUrlDetails( $this->userpage
);
678 $href = &$usertalkUrlDetails['href'];
679 $personal_urls['anontalk'] = array(
680 'text' => wfMsg( 'anontalk' ),
682 'class' => $usertalkUrlDetails['exists'] ?
false : 'new',
683 'active' => ( $pageurl == $href )
685 $personal_urls['anonlogin'] = $login_url;
686 if ( isset($createaccount_url) ) {
687 $personal_urls['createaccount'] = $createaccount_url;
690 $personal_urls['login'] = $login_url;
694 wfRunHooks( 'PersonalUrls', array( &$personal_urls, &$title ) );
695 wfProfileOut( __METHOD__
);
696 return $personal_urls;
699 function tabAction( $title, $message, $selected, $query = '', $checkEdit = false ) {
702 $classes[] = 'selected';
704 if( $checkEdit && !$title->isKnown() ) {
706 $query = 'action=edit&redlink=1';
709 // wfMessageFallback will nicely accept $message as an array of fallbacks
710 // or just a single key
711 $msg = wfMessageFallback( $message );
712 if ( is_array($message) ) {
713 // for hook compatibility just keep the last message name
714 $message = end($message);
716 if ( $msg->exists() ) {
717 $text = $msg->plain();
720 $text = $wgContLang->getFormattedNsText( MWNamespace
::getSubject( $title->getNamespace() ) );
724 if( !wfRunHooks( 'SkinTemplateTabAction', array( &$this,
725 $title, $message, $selected, $checkEdit,
726 &$classes, &$query, &$text, &$result ) ) ) {
731 'class' => implode( ' ', $classes ),
733 'href' => $title->getLocalUrl( $query ),
737 function makeTalkUrlDetails( $name, $urlaction = '' ) {
738 $title = Title
::newFromText( $name );
739 if( !is_object( $title ) ) {
740 throw new MWException( __METHOD__
. " given invalid pagename $name" );
742 $title = $title->getTalkPage();
743 self
::checkTitle( $title, $name );
745 'href' => $title->getLocalURL( $urlaction ),
746 'exists' => $title->getArticleID() != 0,
750 function makeArticleUrlDetails( $name, $urlaction = '' ) {
751 $title = Title
::newFromText( $name );
752 $title= $title->getSubjectPage();
753 self
::checkTitle( $title, $name );
755 'href' => $title->getLocalURL( $urlaction ),
756 'exists' => $title->getArticleID() != 0,
761 * a structured array of links usually used for the tabs in a skin
763 * There are 4 standard sections
764 * namespaces: Used for namespace tabs like special, page, and talk namespaces
765 * views: Used for primary page views like read, edit, history
766 * actions: Used for most extra page actions like deletion, protection, etc...
767 * variants: Used to list the language variants for the page
769 * Each section's value is a key/value array of links for that section.
770 * The links themseves have these common keys:
771 * - class: The css classes to apply to the tab
772 * - text: The text to display on the tab
773 * - href: The href for the tab to point to
774 * - rel: An optional rel= for the tab's link
775 * - redundant: If true the tab will be dropped in skins using content_actions
776 * this is useful for tabs like "Read" which only have meaning in skins that
777 * take special meaning from the grouped structure of content_navigation
779 * Views also have an extra key which can be used:
780 * - primary: If this is not true skins like vector may try to hide the tab
781 * when the user has limited space in their browser window
783 * content_navigation using code also expects these ids to be present on the
784 * links, however these are usually automatically generated by SkinTemplate
785 * itself and are not necessary when using a hook. The only things these may
786 * matter to are people modifying content_navigation after it's initial creation:
787 * - id: A "preferred" id, most skins are best off outputting this preferred id for best compatibility
788 * - tooltiponly: This is set to true for some tabs in cases where the system
789 * believes that the accesskey should not be added to the tab.
794 function buildContentNavigationUrls() {
795 global $wgContLang, $wgLang, $wgOut, $wgUser, $wgRequest;
796 global $wgDisableLangConversion;
798 wfProfileIn( __METHOD__
);
800 $title = $this->getRelevantTitle(); // Display tabs for the relevant title rather than always the title itself
801 $onPage = $title->equals($this->mTitle
);
803 $content_navigation = array(
804 'namespaces' => array(),
806 'actions' => array(),
807 'variants' => array()
811 $action = $wgRequest->getVal( 'action', 'view' );
812 $section = $wgRequest->getVal( 'section' );
814 $userCanRead = $title->userCanRead();
815 $skname = $this->skinname
;
817 $preventActiveTabs = false;
818 wfRunHooks( 'SkinTemplatePreventOtherActiveTabs', array( &$this, &$preventActiveTabs ) );
820 // Checks if page is some kind of content
821 if( $title->getNamespace() != NS_SPECIAL
) {
822 // Gets page objects for the related namespaces
823 $subjectPage = $title->getSubjectPage();
824 $talkPage = $title->getTalkPage();
826 // Determines if this is a talk page
827 $isTalk = $title->isTalkPage();
829 // Generates XML IDs from namespace names
830 $subjectId = $title->getNamespaceKey( '' );
832 if ( $subjectId == 'main' ) {
835 $talkId = "{$subjectId}_talk";
838 // Adds namespace links
839 $subjectMsg = array( "nstab-$subjectId" );
840 if ( $subjectPage->isMainPage() ) {
841 array_unshift($subjectMsg, 'mainpage-nstab');
843 $content_navigation['namespaces'][$subjectId] = $this->tabAction(
844 $subjectPage, $subjectMsg, !$isTalk && !$preventActiveTabs, '', $userCanRead
846 $content_navigation['namespaces'][$subjectId]['context'] = 'subject';
847 $content_navigation['namespaces'][$talkId] = $this->tabAction(
848 $talkPage, array( "nstab-$talkId", 'talk' ), $isTalk && !$preventActiveTabs, '', $userCanRead
850 $content_navigation['namespaces'][$talkId]['context'] = 'talk';
852 // Adds view view link
853 if ( $title->exists() && $userCanRead ) {
854 $content_navigation['views']['view'] = $this->tabAction(
855 $isTalk ?
$talkPage : $subjectPage,
856 array( "$skname-view-view", 'view' ),
857 ( $onPage && ($action == 'view' ||
$action == 'purge' ) ), '', true
859 $content_navigation['views']['view']['redundant'] = true; // signal to hide this from simple content_actions
862 wfProfileIn( __METHOD__
. '-edit' );
864 // Checks if user can...
866 // read and edit the current page
867 $userCanRead && $title->quickUserCan( 'edit' ) &&
871 // or they can create one here
872 $title->quickUserCan( 'create' )
875 // Builds CSS class for talk page links
876 $isTalkClass = $isTalk ?
' istalk' : '';
878 // Determines if we're in edit mode
881 ( $action == 'edit' ||
$action == 'submit' ) &&
882 ( $section != 'new' )
884 $msgKey = $title->exists() ||
( $title->getNamespace() == NS_MEDIAWIKI
&& !wfEmptyMsg( $title->getText() ) ) ?
886 $content_navigation['views']['edit'] = array(
887 'class' => ( $selected ?
'selected' : '' ) . $isTalkClass,
888 'text' => wfMessageFallback( "$skname-view-$msgKey", $msgKey )->plain(),
889 'href' => $title->getLocalURL( $this->editUrlOptions() ),
890 'primary' => true, // don't collapse this in vector
892 // Checks if this is a current rev of talk page and we should show a new
894 if ( ( $isTalk && $this->isRevisionCurrent() ) ||
( $wgOut->showNewSectionLink() ) ) {
895 // Checks if we should ever show a new section link
896 if ( !$wgOut->forceHideNewSectionLink() ) {
897 // Adds new section link
898 //$content_navigation['actions']['addsection']
899 $content_navigation['views']['addsection'] = array(
900 'class' => $section == 'new' ?
'selected' : false,
901 'text' => wfMessageFallback( "$skname-action-addsection", 'addsection' )->plain(),
902 'href' => $title->getLocalURL( 'action=edit§ion=new' )
906 // Checks if the page has some kind of viewable content
907 } elseif ( $title->hasSourceText() && $userCanRead ) {
908 // Adds view source view link
909 $content_navigation['views']['viewsource'] = array(
910 'class' => ( $onPage && $action == 'edit' ) ?
'selected' : false,
911 'text' => wfMessageFallback( "$skname-action-viewsource", 'viewsource' )->plain(),
912 'href' => $title->getLocalURL( $this->editUrlOptions() ),
913 'primary' => true, // don't collapse this in vector
916 wfProfileOut( __METHOD__
. '-edit' );
918 wfProfileIn( __METHOD__
. '-live' );
920 // Checks if the page exists
921 if ( $title->exists() && $userCanRead ) {
922 // Adds history view link
923 $content_navigation['views']['history'] = array(
924 'class' => ( $onPage && $action == 'history' ) ?
'selected' : false,
925 'text' => wfMessageFallback( "$skname-view-history", 'history_short' )->plain(),
926 'href' => $title->getLocalURL( 'action=history' ),
930 if( $wgUser->isAllowed( 'delete' ) ) {
931 $content_navigation['actions']['delete'] = array(
932 'class' => ( $onPage && $action == 'delete' ) ?
'selected' : false,
933 'text' => wfMessageFallback( "$skname-action-delete", 'delete' )->plain(),
934 'href' => $title->getLocalURL( 'action=delete' )
937 if ( $title->quickUserCan( 'move' ) ) {
938 $moveTitle = SpecialPage
::getTitleFor( 'Movepage', $title->getPrefixedDBkey() );
939 $content_navigation['actions']['move'] = array(
940 'class' => $this->mTitle
->isSpecial( 'Movepage' ) ?
'selected' : false,
941 'text' => wfMessageFallback( "$skname-action-move", 'move' )->plain(),
942 'href' => $moveTitle->getLocalURL()
946 if ( $title->getNamespace() !== NS_MEDIAWIKI
&& $wgUser->isAllowed( 'protect' ) ) {
947 $mode = !$title->isProtected() ?
'protect' : 'unprotect';
948 $content_navigation['actions'][$mode] = array(
949 'class' => ( $onPage && $action == $mode ) ?
'selected' : false,
950 'text' => wfMessageFallback( "$skname-action-$mode", $mode )->plain(),
951 'href' => $title->getLocalURL( "action=$mode" )
955 // article doesn't exist or is deleted
956 if ( $wgUser->isAllowed( 'deletedhistory' ) ) {
957 $n = $title->isDeleted();
959 $undelTitle = SpecialPage
::getTitleFor( 'Undelete' );
960 // If the user can't undelete but can view deleted history show them a "View .. deleted" tab instead
961 $msgKey = $wgUser->isAllowed( 'undelete' ) ?
'undelete' : 'viewdeleted';
962 $content_navigation['actions']['undelete'] = array(
963 'class' => $this->mTitle
->isSpecial( 'Undelete' ) ?
'selected' : false,
964 'text' => wfMessageFallback( "$skname-action-$msgKey", "{$msgKey}_short" )
965 ->params( $wgLang->formatNum( $n ) )->text(),
966 'href' => $undelTitle->getLocalURL( array( 'target' => $title->getPrefixedDBkey() ) )
971 if ( $title->getNamespace() !== NS_MEDIAWIKI
&& $wgUser->isAllowed( 'protect' ) ) {
972 $mode = !$title->getRestrictions( 'create' ) ?
'protect' : 'unprotect';
973 $content_navigation['actions'][$mode] = array(
974 'class' => ( $onPage && $action == $mode ) ?
'selected' : false,
975 'text' => wfMessageFallback( "$skname-action-$mode", $mode )->plain(),
976 'href' => $title->getLocalURL( "action=$mode" )
980 wfProfileOut( __METHOD__
. '-live' );
982 // Checks if the user is logged in
983 if ( $this->loggedin
) {
985 * The following actions use messages which, if made particular to
986 * the any specific skins, would break the Ajax code which makes this
987 * action happen entirely inline. Skin::makeGlobalVariablesScript
988 * defines a set of messages in a javascript object - and these
989 * messages are assumed to be global for all skins. Without making
990 * a change to that procedure these messages will have to remain as
991 * the global versions.
993 $mode = $title->userIsWatching() ?
'unwatch' : 'watch';
994 $content_navigation['actions'][$mode] = array(
995 'class' => $onPage && ( $action == 'watch' ||
$action == 'unwatch' ) ?
'selected' : false,
996 'text' => wfMsg( $mode ), // uses 'watch' or 'unwatch' message
997 'href' => $title->getLocalURL( 'action=' . $mode )
1001 wfRunHooks( 'SkinTemplateNavigation', array( &$this, &$content_navigation ) );
1003 // If it's not content, it's got to be a special page
1004 $content_navigation['namespaces']['special'] = array(
1005 'class' => 'selected',
1006 'text' => wfMsg( 'nstab-special' ),
1007 'href' => $wgRequest->getRequestURL(), // @bug 2457, 2510
1008 'context' => 'subject'
1011 wfRunHooks( 'SkinTemplateNavigation::SpecialPage', array( &$this, &$content_navigation ) );
1014 // Gets list of language variants
1015 $variants = $wgContLang->getVariants();
1016 // Checks that language conversion is enabled and variants exist
1017 if( !$wgDisableLangConversion && count( $variants ) > 1 ) {
1018 // Gets preferred variant
1019 $preferred = $wgContLang->getPreferredVariant();
1020 // Loops over each variant
1021 foreach( $variants as $code ) {
1022 // Gets variant name from language code
1023 $varname = $wgContLang->getVariantname( $code );
1024 // Checks if the variant is marked as disabled
1025 if( $varname == 'disable' ) {
1026 // Skips this variant
1029 // Appends variant link
1030 $content_navigation['variants'][] = array(
1031 'class' => ( $code == $preferred ) ?
'selected' : false,
1033 'href' => $title->getLocalURL( '', $code )
1038 // Equiv to SkinTemplateContentActions
1039 wfRunHooks( 'SkinTemplateNavigation::Universal', array( &$this, &$content_navigation ) );
1041 // Setup xml ids and tooltip info
1042 foreach ( $content_navigation as $section => &$links ) {
1043 foreach ( $links as $key => &$link ) {
1045 if ( isset( $link['context'] ) && $link['context'] == 'subject' ) {
1046 $xmlID = 'ca-nstab-' . $xmlID;
1047 } elseif ( isset( $link['context'] ) && $link['context'] == 'talk' ) {
1049 } elseif ( $section == "variants" ) {
1050 $xmlID = 'ca-varlang-' . $xmlID;
1052 $xmlID = 'ca-' . $xmlID;
1054 $link['id'] = $xmlID;
1058 # We don't want to give the watch tab an accesskey if the
1059 # page is being edited, because that conflicts with the
1060 # accesskey on the watch checkbox. We also don't want to
1061 # give the edit tab an accesskey, because that's fairly su-
1062 # perfluous and conflicts with an accesskey (Ctrl-E) often
1063 # used for editing in Safari.
1064 if( in_array( $action, array( 'edit', 'submit' ) ) ) {
1065 if ( isset($content_navigation['views']['edit']) ) {
1066 $content_navigation['views']['edit']['tooltiponly'] = true;
1068 if ( isset($content_navigation['actions']['watch']) ) {
1069 $content_navigation['actions']['watch']['tooltiponly'] = true;
1071 if ( isset($content_navigation['actions']['unwatch']) ) {
1072 $content_navigation['actions']['unwatch']['tooltiponly'] = true;
1076 wfProfileOut( __METHOD__
);
1078 return $content_navigation;
1082 * an array of edit links by default used for the tabs
1086 function buildContentActionUrls( $content_navigation ) {
1088 wfProfileIn( __METHOD__
);
1090 // content_actions has been replaced with content_navigation for backwards
1091 // compatibility and also for skins that just want simple tabs content_actions
1092 // is now built by flattening the content_navigation arrays into one
1094 $content_actions = array();
1096 foreach ( $content_navigation as $section => $links ) {
1098 foreach ( $links as $key => $value ) {
1100 if ( isset($value["redundant"]) && $value["redundant"] ) {
1101 // Redundant tabs are dropped from content_actions
1105 // content_actions used to have ids built using the "ca-$key" pattern
1106 // so the xmlID based id is much closer to the actual $key that we want
1107 // for that reason we'll just strip out the ca- if present and use
1108 // the latter potion of the "id" as the $key
1109 if ( isset($value["id"]) && substr($value["id"], 0, 3) == "ca-" ) {
1110 $key = substr($value["id"], 3);
1113 if ( isset($content_actions[$key]) ) {
1114 wfDebug( __METHOD__
. ": Found a duplicate key for $key while flattening content_navigation into content_actions." );
1118 $content_actions[$key] = $value;
1124 wfProfileOut( __METHOD__
);
1126 return $content_actions;
1130 * build array of common navigation links
1134 function buildNavUrls() {
1135 global $wgUseTrackbacks, $wgOut, $wgUser, $wgRequest;
1136 global $wgUploadNavigationUrl;
1138 wfProfileIn( __METHOD__
);
1140 $action = $wgRequest->getVal( 'action', 'view' );
1142 $nav_urls = array();
1143 $nav_urls['mainpage'] = array( 'href' => self
::makeMainPageUrl() );
1144 if( $wgUploadNavigationUrl ) {
1145 $nav_urls['upload'] = array( 'href' => $wgUploadNavigationUrl );
1146 } elseif( UploadBase
::isEnabled() && UploadBase
::isAllowed( $wgUser ) === true ) {
1147 $nav_urls['upload'] = array( 'href' => self
::makeSpecialUrl( 'Upload' ) );
1149 $nav_urls['upload'] = false;
1151 $nav_urls['specialpages'] = array( 'href' => self
::makeSpecialUrl( 'Specialpages' ) );
1153 // default permalink to being off, will override it as required below.
1154 $nav_urls['permalink'] = false;
1156 // A print stylesheet is attached to all pages, but nobody ever
1157 // figures that out. :) Add a link...
1158 if( $this->iscontent
&& ( $action == 'view' ||
$action == 'purge' ) ) {
1159 if ( !$wgOut->isPrintable() ) {
1160 $nav_urls['print'] = array(
1161 'text' => wfMsg( 'printableversion' ),
1162 'href' => $wgRequest->appendQuery( 'printable=yes' )
1166 // Also add a "permalink" while we're at it
1167 if ( $this->mRevisionId
) {
1168 $nav_urls['permalink'] = array(
1169 'text' => wfMsg( 'permalink' ),
1170 'href' => $wgOut->getTitle()->getLocalURL( "oldid=$this->mRevisionId" )
1174 // Copy in case this undocumented, shady hook tries to mess with internals
1175 $revid = $this->mRevisionId
;
1176 wfRunHooks( 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink', array( &$this, &$nav_urls, &$revid, &$revid ) );
1179 if( $this->mTitle
->getNamespace() != NS_SPECIAL
) {
1180 $wlhTitle = SpecialPage
::getTitleFor( 'Whatlinkshere', $this->thispage
);
1181 $nav_urls['whatlinkshere'] = array(
1182 'href' => $wlhTitle->getLocalUrl()
1184 if( $this->mTitle
->getArticleId() ) {
1185 $rclTitle = SpecialPage
::getTitleFor( 'Recentchangeslinked', $this->thispage
);
1186 $nav_urls['recentchangeslinked'] = array(
1187 'href' => $rclTitle->getLocalUrl()
1190 $nav_urls['recentchangeslinked'] = false;
1192 if( $wgUseTrackbacks )
1193 $nav_urls['trackbacklink'] = array(
1194 'href' => $wgOut->getTitle()->trackbackURL()
1198 if ( $user = $this->getRelevantUser() ) {
1199 $id = $user->getID();
1200 $ip = $user->isAnon();
1201 $rootUser = $user->getName();
1207 if( $id ||
$ip ) { # both anons and non-anons have contribs list
1208 $nav_urls['contributions'] = array(
1209 'href' => self
::makeSpecialUrlSubpage( 'Contributions', $rootUser )
1213 $logPage = SpecialPage
::getTitleFor( 'Log' );
1214 $nav_urls['log'] = array(
1215 'href' => $logPage->getLocalUrl(
1222 $nav_urls['log'] = false;
1225 if ( $wgUser->isAllowed( 'block' ) ) {
1226 $nav_urls['blockip'] = array(
1227 'href' => self
::makeSpecialUrlSubpage( 'Blockip', $rootUser )
1230 $nav_urls['blockip'] = false;
1233 $nav_urls['contributions'] = false;
1234 $nav_urls['log'] = false;
1235 $nav_urls['blockip'] = false;
1237 $nav_urls['emailuser'] = false;
1238 if( $this->showEmailUser( $id ) ) {
1239 $nav_urls['emailuser'] = array(
1240 'href' => self
::makeSpecialUrlSubpage( 'Emailuser', $rootUser )
1243 wfProfileOut( __METHOD__
);
1248 * Generate strings used for xml 'id' names
1252 function getNameSpaceKey() {
1253 return $this->mTitle
->getNamespaceKey();
1259 function setupUserJs( $allowUserJs ) {
1260 global $wgRequest, $wgJsMimeType;
1261 wfProfileIn( __METHOD__
);
1263 $action = $wgRequest->getVal( 'action', 'view' );
1265 if( $allowUserJs && $this->loggedin
) {
1266 if( $this->mTitle
->isJsSubpage() and $this->userCanPreview( $action ) ) {
1267 # XXX: additional security check/prompt?
1268 $this->userjsprev
= '/*<![CDATA[*/ ' . $wgRequest->getText( 'wpTextbox1' ) . ' /*]]>*/';
1270 $this->userjs
= self
::makeUrl( $this->userpage
. '/' . $this->skinname
. '.js', 'action=raw&ctype=' . $wgJsMimeType );
1273 wfProfileOut( __METHOD__
);
1277 * Code for extensions to hook into to provide per-page CSS, see
1278 * extensions/PageCSS/PageCSS.php for an implementation of this.
1282 function setupPageCss() {
1283 wfProfileIn( __METHOD__
);
1285 wfRunHooks( 'SkinTemplateSetupPageCss', array( &$out ) );
1286 wfProfileOut( __METHOD__
);
1290 public function commonPrintStylesheet() {
1296 * Generic wrapper for template functions, with interface
1297 * compatible with what we use of PHPTAL 0.7.
1300 abstract class QuickTemplate
{
1304 public function QuickTemplate() {
1305 $this->data
= array();
1306 $this->translator
= new MediaWiki_I18N();
1310 * Sets the value $value to $name
1314 public function set( $name, $value ) {
1315 $this->data
[$name] = $value;
1322 public function setRef( $name, &$value ) {
1323 $this->data
[$name] =& $value;
1329 public function setTranslator( &$t ) {
1330 $this->translator
= &$t;
1334 * Main function, used by classes that subclass QuickTemplate
1335 * to show the actual HTML output
1337 abstract public function execute();
1342 function text( $str ) {
1343 echo htmlspecialchars( $this->data
[$str] );
1349 function jstext( $str ) {
1350 echo Xml
::escapeJsString( $this->data
[$str] );
1356 function html( $str ) {
1357 echo $this->data
[$str];
1363 function msg( $str ) {
1364 echo htmlspecialchars( $this->translator
->translate( $str ) );
1370 function msgHtml( $str ) {
1371 echo $this->translator
->translate( $str );
1375 * An ugly, ugly hack.
1378 function msgWiki( $str ) {
1379 global $wgParser, $wgOut;
1381 $text = $this->translator
->translate( $str );
1382 $parserOutput = $wgParser->parse( $text, $wgOut->getTitle(),
1383 $wgOut->parserOptions(), true );
1384 echo $parserOutput->getText();
1390 function haveData( $str ) {
1391 return isset( $this->data
[$str] );
1397 function haveMsg( $str ) {
1398 $msg = $this->translator
->translate( $str );
1399 return ( $msg != '-' ) && ( $msg != '' ); # ????
1403 * Get the Skin object related to this object
1405 * @return Skin object
1407 public function getSkin() {
1408 return $this->data
['skin'];
1413 * New base template for a skin's template extended from QuickTemplate
1414 * this class features helper methods that provide common ways of interacting
1415 * with the data stored in the QuickTemplate
1417 abstract class BaseTemplate
extends QuickTemplate
{
1420 * Create an array of common toolbox items from the data in the quicktemplate
1421 * stored by SkinTemplate.
1422 * The resulting array is built acording to a format intended to be passed
1423 * through makeListItem to generate the html.
1425 function getToolbox() {
1426 wfProfileIn( __METHOD__
);
1429 if ( $this->data
['notspecialpage'] ) {
1430 $toolbox['whatlinkshere'] = $this->data
['nav_urls']['whatlinkshere'];
1431 $toolbox['whatlinkshere']['id'] = 't-whatlinkshere';
1432 if ( $this->data
['nav_urls']['recentchangeslinked'] ) {
1433 $toolbox['recentchangeslinked'] = $this->data
['nav_urls']['recentchangeslinked'];
1434 $toolbox['recentchangeslinked']['msg'] = 'recentchangeslinked-toolbox';
1435 $toolbox['recentchangeslinked']['id'] = 't-recentchangeslinked';
1438 if( isset( $this->data
['nav_urls']['trackbacklink'] ) && $this->data
['nav_urls']['trackbacklink'] ) {
1439 $toolbox['trackbacklink'] = $this->data
['nav_urls']['trackbacklink'];
1440 $toolbox['trackbacklink']['id'] = 't-trackbacklink';
1442 if ( $this->data
['feeds'] ) {
1443 $toolbox['feeds']['id'] = 'feedlinks';
1444 $toolbox['feeds']['links'] = array();
1445 foreach ( $this->data
['feeds'] as $key => $feed ) {
1446 $toolbox['feeds']['links'][$key] = $feed;
1447 $toolbox['feeds']['links'][$key]['id'] = "feed-$key";
1448 $toolbox['feeds']['links'][$key]['rel'] = 'alternate';
1449 $toolbox['feeds']['links'][$key]['type'] = "application/{$key}+xml";
1450 $toolbox['feeds']['links'][$key]['class'] = 'feedlink';
1453 foreach ( array( 'contributions', 'log', 'blockip', 'emailuser', 'upload', 'specialpages' ) as $special ) {
1454 if ( $this->data
['nav_urls'][$special] ) {
1455 $toolbox[$special] = $this->data
['nav_urls'][$special];
1456 $toolbox[$special]['id'] = "t-$special";
1459 if ( !empty( $this->data
['nav_urls']['print']['href'] ) ) {
1460 $toolbox['print'] = $this->data
['nav_urls']['print'];
1461 $toolbox['print']['rel'] = 'alternate';
1462 $toolbox['print']['msg'] = 'printableversion';
1464 if ( !empty( $this->data
['nav_urls']['permalink']['href'] ) ) {
1465 $toolbox['permalink'] = $this->data
['nav_urls']['permalink'];
1466 $toolbox['permalink']['id'] = 't-permalink';
1467 } elseif ( $this->data
['nav_urls']['permalink']['href'] === '' ) {
1468 $toolbox['permalink'] = $this->data
['nav_urls']['permalink'];
1469 unset( $toolbox['permalink']['href'] );
1470 $toolbox['ispermalink']['tooltiponly'] = true;
1471 $toolbox['ispermalink']['id'] = 't-ispermalink';
1472 $toolbox['ispermalink']['msg'] = 'permalink';
1474 wfRunHooks( 'BaseTemplateToolbox', array( &$this, &$toolbox ) );
1475 wfProfileOut( __METHOD__
);
1480 * Create an array of personal tools items from the data in the quicktemplate
1481 * stored by SkinTemplate.
1482 * The resulting array is built acording to a format intended to be passed
1483 * through makeListItem to generate the html.
1484 * This is in reality the same list as already stored in personal_urls
1485 * however it is reformatted so that you can just pass the individual items
1486 * to makeListItem instead of hardcoding the element creation boilerplate.
1488 function getPersonalTools() {
1489 $personal_tools = array();
1490 foreach( $this->data
['personal_urls'] as $key => $ptool ) {
1491 # The class on a personal_urls item is meant to go on the <a> instead
1492 # of the <li> so we have to use a single item "links" array instead
1493 # of using most of the personal_url's keys directly
1494 $personal_tools[$key] = array();
1495 $personal_tools[$key]["links"][] = array();
1496 $personal_tools[$key]["links"][0]["single-id"] = $personal_tools[$key]["id"] = "pt-$key";
1497 if ( isset($ptool["active"]) ) {
1498 $personal_tools[$key]["active"] = $ptool["active"];
1500 foreach ( array("href", "class", "text") as $k ) {
1501 if ( isset($ptool[$k]) )
1502 $personal_tools[$key]["links"][0][$k] = $ptool[$k];
1505 return $personal_tools;
1509 * Makes a link, usually used by makeListItem to generate a link for an item
1510 * in a list used in navigation lists, portlets, portals, sidebars, etc...
1512 * $key is a string, usually a key from the list you are generating this link from
1513 * $item is an array containing some of a specific set of keys.
1514 * The text of the link will be generated either from the contents of the "text"
1515 * key in the $item array, if a "msg" key is present a message by that name will
1516 * be used, and if neither of those are set the $key will be used as a message name.
1517 * If a "href" key is not present makeLink will just output htmlescaped text.
1518 * The href, id, class, rel, and type keys are used as attributes for the link if present.
1519 * If an "id" or "single-id" (if you don't want the actual id to be output on the link)
1520 * is present it will be used to generate a tooltip and accesskey for the link.
1521 * If you don't want an accesskey, set $item['tooltiponly'] = true;
1523 function makeLink( $key, $item ) {
1524 if ( isset( $item['text'] ) ) {
1525 $text = $item['text'];
1527 $text = $this->translator
->translate( isset( $item['msg'] ) ?
$item['msg'] : $key );
1530 if ( !isset( $item['href'] ) ) {
1531 return htmlspecialchars( $text );
1535 foreach ( array( 'href', 'id', 'class', 'rel', 'type' ) as $attr ) {
1536 if ( isset( $item[$attr] ) ) {
1537 $attrs[$attr] = $item[$attr];
1541 if ( isset( $item['id'] ) ) {
1542 $item['single-id'] = $item['id'];
1544 if ( isset( $item['single-id'] ) ) {
1545 if ( isset( $item['tooltiponly'] ) && $item['tooltiponly'] ) {
1546 $attrs['title'] = $this->skin
->titleAttrib( $item['single-id'] );
1547 if ( $attrs['title'] === false ) {
1548 unset( $attrs['title'] );
1551 $attrs = array_merge(
1553 $this->skin
->tooltipAndAccesskeyAttribs( $item['single-id'] )
1558 return Html
::element( 'a', $attrs, $text );
1562 * Generates a list item for a navigation, portlet, portal, sidebar... etc list
1563 * $key is a string, usually a key from the list you are generating this link from
1564 * $item is an array of list item data containing some of a specific set of keys.
1565 * The "id" and "class" keys will be used as attributes for the list item,
1566 * if "active" contains a value of true a "active" class will also be appended to class.
1567 * If you want something other than a <li> you can pass a tag name such as
1568 * "tag" => "span" in the $options array to change the tag used.
1569 * link/content data for the list item may come in one of two forms
1570 * A "links" key may be used, in which case it should contain an array with
1571 * a list of links to include inside the list item, see makeLink for the format
1572 * of individual links array items.
1573 * Otherwise the relevant keys from the list item $item array will be passed
1574 * to makeLink instead. Note however that "id" and "class" are used by the
1575 * list item directly so they will not be passed to makeLink
1576 * (however the link will still support a tooltip and accesskey from it)
1577 * If you need an id or class on a single link you should include a "links"
1578 * array with just one link item inside of it.
1580 function makeListItem( $key, $item, $options = array() ) {
1581 if ( isset( $item['links'] ) ) {
1583 foreach ( $item['links'] as $linkKey => $link ) {
1584 $html .= $this->makeLink( $linkKey, $link );
1588 foreach ( array( 'text', 'msg', 'href', 'rel', 'type', 'tooltiponly' ) as $k ) {
1589 if ( isset( $item[$k] ) ) {
1590 $link[$k] = $item[$k];
1593 if ( isset( $item['id'] ) ) {
1594 // The id goes on the <li> not on the <a> for single links
1595 // but makeSidebarLink still needs to know what id to use when
1596 // generating tooltips and accesskeys.
1597 $link['single-id'] = $item['id'];
1599 $html = $this->makeLink( $key, $link );
1603 foreach ( array( 'id', 'class' ) as $attr ) {
1604 if ( isset( $item[$attr] ) ) {
1605 $attrs[$attr] = $item[$attr];
1608 if ( isset( $item['active'] ) && $item['active'] ) {
1609 if ( !isset( $attrs['class'] ) ) {
1610 $attrs['class'] = '';
1612 $attrs['class'] .= ' active';
1613 $attrs['class'] = trim( $attrs['class'] );
1615 return Html
::rawElement( isset( $options['tag'] ) ?
$options['tag'] : 'li', $attrs, $html );
1618 function makeSearchInput( $attrs = array() ) {
1622 'value' => isset( $this->data
['search'] ) ?
$this->data
['search'] : '',
1624 $realAttrs = array_merge( $realAttrs, $this->skin
->tooltipAndAccesskeyAttribs( 'search' ), $attrs );
1625 return Html
::element( 'input', $realAttrs );
1628 function makeSearchButton( $mode, $attrs = array() ) {
1635 'value' => $this->translator
->translate( $mode == 'go' ?
'searcharticle' : 'searchbutton' ),
1637 $realAttrs = array_merge(
1639 $this->skin
->tooltipAndAccesskeyAttribs( "search-$mode" ),
1642 return Html
::element( 'input', $realAttrs );
1644 $buttonAttrs = array(
1648 $buttonAttrs = array_merge(
1650 $this->skin
->tooltipAndAccesskeyAttribs( 'search-fulltext' ),
1653 unset( $buttonAttrs['src'] );
1654 unset( $buttonAttrs['alt'] );
1656 'src' => $attrs['src'],
1657 'alt' => isset( $attrs['alt'] ) ?
$attrs['alt'] : $this->translator
->translate( 'searchbutton' ),
1659 return Html
::rawElement( 'button', $buttonAttrs, Html
::element( 'img', $imgAttrs ) );
1661 throw new MWException( 'Unknown mode passed to BaseTemplate::makeSearchButton' );
1666 * Returns an array of footerlinks trimmed down to only those footer links that
1668 * If you pass "flat" as an option then the returned array will be a flat array
1669 * of footer icons instead of a key/value array of footerlinks arrays broken
1670 * up into categories.
1672 function getFooterLinks( $option = null ) {
1673 $footerlinks = $this->data
['footerlinks'];
1675 // Reduce footer links down to only those which are being used
1676 $validFooterLinks = array();
1677 foreach( $footerlinks as $category => $links ) {
1678 $validFooterLinks[$category] = array();
1679 foreach( $links as $link ) {
1680 if( isset( $this->data
[$link] ) && $this->data
[$link] ) {
1681 $validFooterLinks[$category][] = $link;
1684 if ( count( $validFooterLinks[$category] ) <= 0 ) {
1685 unset( $validFooterLinks[$category] );
1689 if ( $option == 'flat' ) {
1690 // fold footerlinks into a single array using a bit of trickery
1691 $validFooterLinks = call_user_func_array(
1693 array_values( $validFooterLinks )
1697 return $validFooterLinks;
1701 * Returns an array of footer icons filtered down by options relevant to how
1702 * the skin wishes to display them.
1703 * If you pass "icononly" as the option all footer icons which do not have an
1704 * image icon set will be filtered out.
1705 * If you pass "nocopyright" then MediaWiki's copyright icon will not be included
1706 * in the list of footer icons. This is mostly useful for skins which only
1707 * display the text from footericons instead of the images and don't want a
1708 * duplicate copyright statement because footerlinks already rendered one.
1710 function getFooterIcons( $option = null ) {
1711 // Generate additional footer icons
1712 $footericons = $this->data
['footericons'];
1714 if ( $option == 'icononly' ) {
1715 // Unset any icons which don't have an image
1716 foreach ( $footericons as $footerIconsKey => &$footerIconsBlock ) {
1717 foreach ( $footerIconsBlock as $footerIconKey => $footerIcon ) {
1718 if ( !is_string( $footerIcon ) && !isset( $footerIcon['src'] ) ) {
1719 unset( $footerIconsBlock[$footerIconKey] );
1723 // Redo removal of any empty blocks
1724 foreach ( $footericons as $footerIconsKey => &$footerIconsBlock ) {
1725 if ( count( $footerIconsBlock ) <= 0 ) {
1726 unset( $footericons[$footerIconsKey] );
1729 } elseif ( $option == 'nocopyright' ) {
1730 $footericons = $this->data
['footericons'];
1731 unset( $footericons['copyright']['copyright'] );
1732 if ( count( $footericons['copyright'] ) <= 0 ) {
1733 unset( $footericons['copyright'] );
1737 return $footericons;
1741 * Output the basic end-page trail including bottomscripts, reporttime, and
1742 * debug stuff. This should be called right before outputting the closing
1743 * body and html tags.
1745 function printTrail() { ?
>
1746 <?php
$this->html('bottomscripts'); /* JS call to runBodyOnloadHook */ ?
>
1747 <?php
$this->html('reporttime') ?
>
1748 <?php
if ( $this->data
['debug'] ): ?
>
1750 <?php
$this->text( 'debug' ); ?
>