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
24 * Wrapper object for MediaWiki's localization functions,
25 * to be passed to the template engine.
30 class MediaWiki_I18N
{
31 var $_context = array();
33 function set( $varName, $value ) {
34 $this->_context
[$varName] = $value;
37 function translate( $value ) {
38 wfProfileIn( __METHOD__
);
40 // Hack for i18n:attributes in PHPTAL 1.0.0 dev version as of 2004-10-23
41 $value = preg_replace( '/^string:/', '', $value );
43 $value = wfMsg( $value );
44 // interpolate variables
46 while( preg_match( '/\$([0-9]*?)/sm', $value, $m ) ) {
47 list( $src, $var ) = $m;
49 $varValue = $this->_context
[$var];
51 $value = str_replace( $src, $varValue, $value );
53 wfProfileOut( __METHOD__
);
59 * Template-filler skin base class
60 * Formerly generic PHPTal (http://phptal.sourceforge.net/) skin
61 * Based on Brion's smarty skin
62 * @copyright Copyright © Gabriel Wicke -- http://www.aulinx.de/
64 * @todo Needs some serious refactoring into functions that correspond
65 * to the computations individual esi snippets need. Most importantly no body
66 * parsing for most of those of course.
70 class SkinTemplate
extends Skin
{
76 * Name of our skin, it probably needs to be all lower case. Child classes
77 * should override the default.
79 var $skinname = 'monobook';
82 * Stylesheets set to use. Subdirectory in skins/ where various stylesheets
83 * are located. Child classes should override the default.
85 var $stylename = 'monobook';
88 * For QuickTemplate, the name of the subclass which will actually fill the
89 * template. Child classes should override the default.
91 var $template = 'QuickTemplate';
94 * Whether this skin use OutputPage::headElement() to generate the <head>
97 var $useHeadElement = false;
102 * Add specific styles for this skin
104 * @param $out OutputPage
106 function setupSkinUserCss( OutputPage
$out ) {
107 $out->addModuleStyles( array( 'mediawiki.legacy.shared', 'mediawiki.legacy.commonPrint' ) );
111 * Create the template engine object; we feed it a bunch of data
112 * and eventually it spits out some HTML. Should have interface
113 * roughly equivalent to PHPTAL 0.7.
115 * @param $classname String
116 * @param $repository string: subdirectory where we keep template files
117 * @param $cache_dir string
118 * @return QuickTemplate
121 function setupTemplate( $classname, $repository = false, $cache_dir = false ) {
122 return new $classname();
126 * initialize various variables and generate the template
128 * @param $out OutputPage
130 function outputPage( OutputPage
$out=null ) {
132 global $wgScript, $wgStylePath;
133 global $wgMimeType, $wgJsMimeType;
134 global $wgXhtmlDefaultNamespace, $wgXhtmlNamespaces, $wgHtml5Version;
135 global $wgDisableCounters, $wgSitename, $wgLogo, $wgHideInterlanguageLinks;
136 global $wgMaxCredits, $wgShowCreditsIfMax;
137 global $wgPageShowWatchingUsers;
138 global $wgDebugComments;
139 global $wgArticlePath, $wgScriptPath, $wgServer;
141 wfProfileIn( __METHOD__
);
142 Profiler
::instance()->setTemplated( true );
145 if ( $out !== null ) {
146 // @todo Add wfDeprecated in 1.20
147 $oldContext = $this->getContext();
148 $this->setContext( $out->getContext() );
151 $out = $this->getOutput();
152 $request = $this->getRequest();
153 $user = $this->getUser();
154 $title = $this->getTitle();
156 wfProfileIn( __METHOD__
. '-init' );
157 $this->initPage( $out );
159 $tpl = $this->setupTemplate( $this->template
, 'skins' );
160 wfProfileOut( __METHOD__
. '-init' );
162 wfProfileIn( __METHOD__
. '-stuff' );
163 $this->thispage
= $title->getPrefixedDBkey();
164 $this->titletxt
= $title->getPrefixedText();
165 $this->userpage
= $user->getUserPage()->getPrefixedText();
167 if ( !$request->wasPosted() ) {
168 $query = $request->getValues();
169 unset( $query['title'] );
170 unset( $query['returnto'] );
171 unset( $query['returntoquery'] );
173 $this->thisquery
= wfArrayToCGI( $query );
174 $this->loggedin
= $user->isLoggedIn();
175 $this->username
= $user->getName();
177 if ( $this->loggedin ||
$this->showIPinHeader() ) {
178 $this->userpageUrlDetails
= self
::makeUrlDetails( $this->userpage
);
180 # This won't be used in the standard skins, but we define it to preserve the interface
181 # To save time, we check for existence
182 $this->userpageUrlDetails
= self
::makeKnownUrlDetails( $this->userpage
);
185 wfProfileOut( __METHOD__
. '-stuff' );
187 wfProfileIn( __METHOD__
. '-stuff-head' );
188 if ( !$this->useHeadElement
) {
189 $tpl->set( 'pagecss', false );
190 $tpl->set( 'usercss', false );
192 $tpl->set( 'userjs', false );
193 $tpl->set( 'userjsprev', false );
195 $tpl->set( 'jsvarurl', false );
197 $tpl->setRef( 'xhtmldefaultnamespace', $wgXhtmlDefaultNamespace );
198 $tpl->set( 'xhtmlnamespaces', $wgXhtmlNamespaces );
199 $tpl->set( 'html5version', $wgHtml5Version );
200 $tpl->set( 'headlinks', $out->getHeadLinks() );
201 $tpl->set( 'csslinks', $out->buildCssLinks() );
202 $tpl->set( 'pageclass', $this->getPageClasses( $title ) );
203 $tpl->set( 'skinnameclass', ( 'skin-' . Sanitizer
::escapeClass( $this->getSkinName() ) ) );
205 wfProfileOut( __METHOD__
. '-stuff-head' );
207 wfProfileIn( __METHOD__
. '-stuff2' );
208 $tpl->set( 'title', $out->getPageTitle() );
209 $tpl->set( 'pagetitle', $out->getHTMLTitle() );
210 $tpl->set( 'displaytitle', $out->mPageLinkTitle
);
212 $tpl->setRef( 'thispage', $this->thispage
);
213 $tpl->setRef( 'titleprefixeddbkey', $this->thispage
);
214 $tpl->set( 'titletext', $title->getText() );
215 $tpl->set( 'articleid', $title->getArticleID() );
217 $tpl->set( 'isarticle', $out->isArticle() );
219 $subpagestr = $this->subPageSubtitle();
220 if ( $subpagestr !== '' ) {
221 $subpagestr = '<span class="subpages">' . $subpagestr . '</span>';
223 $tpl->set( 'subtitle', $subpagestr . $out->getSubtitle() );
225 $undelete = $this->getUndeleteLink();
226 if ( $undelete === '' ) {
227 $tpl->set( 'undelete', '' );
229 $tpl->set( 'undelete', '<span class="subpages">' . $undelete . '</span>' );
232 $tpl->set( 'catlinks', $this->getCategories() );
233 if( $out->isSyndicated() ) {
235 foreach( $out->getSyndicationLinks() as $format => $link ) {
236 $feeds[$format] = array(
237 'text' => $this->msg( "feed-$format" )->text(),
241 $tpl->setRef( 'feeds', $feeds );
243 $tpl->set( 'feeds', false );
246 $tpl->setRef( 'mimetype', $wgMimeType );
247 $tpl->setRef( 'jsmimetype', $wgJsMimeType );
248 $tpl->set( 'charset', 'UTF-8' );
249 $tpl->setRef( 'wgScript', $wgScript );
250 $tpl->setRef( 'skinname', $this->skinname
);
251 $tpl->set( 'skinclass', get_class( $this ) );
252 $tpl->setRef( 'skin', $this );
253 $tpl->setRef( 'stylename', $this->stylename
);
254 $tpl->set( 'printable', $out->isPrintable() );
255 $tpl->set( 'handheld', $request->getBool( 'handheld' ) );
256 $tpl->setRef( 'loggedin', $this->loggedin
);
257 $tpl->set( 'notspecialpage', !$title->isSpecialPage() );
258 /* XXX currently unused, might get useful later
259 $tpl->set( 'editable', ( !$title->isSpecialPage() ) );
260 $tpl->set( 'exists', $title->getArticleID() != 0 );
261 $tpl->set( 'watch', $title->userIsWatching() ? 'unwatch' : 'watch' );
262 $tpl->set( 'protect', count( $title->isProtected() ) ? 'unprotect' : 'protect' );
263 $tpl->set( 'helppage', $this->msg( 'helppage' )->text() );
265 $tpl->set( 'searchaction', $this->escapeSearchLink() );
266 $tpl->set( 'searchtitle', SpecialPage
::getTitleFor( 'Search' )->getPrefixedDBKey() );
267 $tpl->set( 'search', trim( $request->getVal( 'search' ) ) );
268 $tpl->setRef( 'stylepath', $wgStylePath );
269 $tpl->setRef( 'articlepath', $wgArticlePath );
270 $tpl->setRef( 'scriptpath', $wgScriptPath );
271 $tpl->setRef( 'serverurl', $wgServer );
272 $tpl->setRef( 'logopath', $wgLogo );
273 $tpl->setRef( 'sitename', $wgSitename );
275 $lang = $this->getLanguage();
276 $userlang = $lang->getHtmlCode();
277 $userdir = $lang->getDir();
279 $tpl->set( 'lang', $userlang );
280 $tpl->set( 'dir', $userdir );
281 $tpl->set( 'rtl', $lang->isRTL() );
283 $tpl->set( 'capitalizeallnouns', $lang->capitalizeAllNouns() ?
' capitalize-all-nouns' : '' );
284 $tpl->set( 'showjumplinks', $user->getOption( 'showjumplinks' ) );
285 $tpl->set( 'username', $this->loggedin ?
$this->username
: null );
286 $tpl->setRef( 'userpage', $this->userpage
);
287 $tpl->setRef( 'userpageurl', $this->userpageUrlDetails
['href'] );
288 $tpl->set( 'userlang', $userlang );
290 // Users can have their language set differently than the
291 // content of the wiki. For these users, tell the web browser
292 // that interface elements are in a different language.
293 $tpl->set( 'userlangattributes', '' );
294 $tpl->set( 'specialpageattributes', '' ); # obsolete
296 if ( $userlang !== $wgContLang->getHtmlCode() ||
$userdir !== $wgContLang->getDir() ) {
297 $escUserlang = htmlspecialchars( $userlang );
298 $escUserdir = htmlspecialchars( $userdir );
299 // Attributes must be in double quotes because htmlspecialchars() doesn't
300 // escape single quotes
301 $attrs = " lang=\"$escUserlang\" dir=\"$escUserdir\"";
302 $tpl->set( 'userlangattributes', $attrs );
305 wfProfileOut( __METHOD__
. '-stuff2' );
307 wfProfileIn( __METHOD__
. '-stuff3' );
308 $tpl->set( 'newtalk', $this->getNewtalks() );
309 $tpl->set( 'logo', $this->logoText() );
311 $tpl->set( 'copyright', false );
312 $tpl->set( 'viewcount', false );
313 $tpl->set( 'lastmod', false );
314 $tpl->set( 'credits', false );
315 $tpl->set( 'numberofwatchingusers', false );
316 if ( $out->isArticle() && $title->exists() ) {
317 if ( $this->isRevisionCurrent() ) {
318 if ( !$wgDisableCounters ) {
319 $viewcount = $this->getWikiPage()->getCount();
321 $tpl->set( 'viewcount', $this->msg( 'viewcount' )->numParams( $viewcount )->parse() );
325 if( $wgPageShowWatchingUsers ) {
326 $dbr = wfGetDB( DB_SLAVE
);
327 $num = $dbr->selectField( 'watchlist', 'COUNT(*)',
328 array( 'wl_title' => $title->getDBkey(), 'wl_namespace' => $title->getNamespace() ),
332 $tpl->set( 'numberofwatchingusers',
333 $this->msg( 'number_of_watching_users_pageview' )->numParams( $num )->parse()
338 if ( $wgMaxCredits != 0 ) {
339 $tpl->set( 'credits', Action
::factory( 'credits', $this->getWikiPage(),
340 $this->getContext() )->getCredits( $wgMaxCredits, $wgShowCreditsIfMax ) );
342 $tpl->set( 'lastmod', $this->lastModified() );
345 $tpl->set( 'copyright', $this->getCopyright() );
347 wfProfileOut( __METHOD__
. '-stuff3' );
349 wfProfileIn( __METHOD__
. '-stuff4' );
350 $tpl->set( 'copyrightico', $this->getCopyrightIcon() );
351 $tpl->set( 'poweredbyico', $this->getPoweredBy() );
352 $tpl->set( 'disclaimer', $this->disclaimerLink() );
353 $tpl->set( 'privacy', $this->privacyLink() );
354 $tpl->set( 'about', $this->aboutLink() );
356 $tpl->set( 'footerlinks', array(
360 'numberofwatchingusers',
371 global $wgFooterIcons;
372 $tpl->set( 'footericons', $wgFooterIcons );
373 foreach ( $tpl->data
['footericons'] as $footerIconsKey => &$footerIconsBlock ) {
374 if ( count( $footerIconsBlock ) > 0 ) {
375 foreach ( $footerIconsBlock as &$footerIcon ) {
376 if ( isset( $footerIcon['src'] ) ) {
377 if ( !isset( $footerIcon['width'] ) ) {
378 $footerIcon['width'] = 88;
380 if ( !isset( $footerIcon['height'] ) ) {
381 $footerIcon['height'] = 31;
386 unset( $tpl->data
['footericons'][$footerIconsKey] );
390 if ( $wgDebugComments ) {
391 $tpl->setRef( 'debug', $out->mDebugtext
);
393 $tpl->set( 'debug', '' );
396 $tpl->set( 'sitenotice', $this->getSiteNotice() );
397 $tpl->set( 'bottomscripts', $this->bottomScripts() );
398 $tpl->set( 'printfooter', $this->printSource() );
400 # An ID that includes the actual body text; without categories, contentSub, ...
401 $realBodyAttribs = array( 'id' => 'mw-content-text' );
403 # Add a mw-content-ltr/rtl class to be able to style based on text direction
404 # when the content is different from the UI language, i.e.:
405 # not for special pages or file pages AND only when viewing AND if the page exists
406 # (or is in MW namespace, because that has default content)
407 if( !in_array( $title->getNamespace(), array( NS_SPECIAL
, NS_FILE
) ) &&
408 in_array( $request->getVal( 'action', 'view' ), array( 'view', 'historysubmit' ) ) &&
409 ( $title->exists() ||
$title->getNamespace() == NS_MEDIAWIKI
) ) {
410 $pageLang = $title->getPageLanguage();
411 $realBodyAttribs['lang'] = $pageLang->getHtmlCode();
412 $realBodyAttribs['dir'] = $pageLang->getDir();
413 $realBodyAttribs['class'] = 'mw-content-'.$pageLang->getDir();
416 $out->mBodytext
= Html
::rawElement( 'div', $realBodyAttribs, $out->mBodytext
);
417 $tpl->setRef( 'bodytext', $out->mBodytext
);
420 $language_urls = array();
422 if ( !$wgHideInterlanguageLinks ) {
423 foreach( $out->getLanguageLinks() as $l ) {
424 $tmp = explode( ':', $l, 2 );
425 $class = 'interwiki-' . $tmp[0];
427 $nt = Title
::newFromText( $l );
429 $ilLangName = Language
::fetchLanguageName( $nt->getInterwiki() );
430 if ( strval( $ilLangName ) === '' ) {
433 $ilLangName = $this->getLanguage()->ucfirst( $ilLangName );
435 $language_urls[] = array(
436 'href' => $nt->getFullURL(),
437 'text' => $ilLangName,
438 'title' => $nt->getText(),
440 'lang' => $nt->getInterwiki(),
441 'hreflang' => $nt->getInterwiki(),
446 if( count( $language_urls ) ) {
447 $tpl->setRef( 'language_urls', $language_urls );
449 $tpl->set( 'language_urls', false );
451 wfProfileOut( __METHOD__
. '-stuff4' );
453 wfProfileIn( __METHOD__
. '-stuff5' );
455 $tpl->set( 'personal_urls', $this->buildPersonalUrls() );
456 $content_navigation = $this->buildContentNavigationUrls();
457 $content_actions = $this->buildContentActionUrls( $content_navigation );
458 $tpl->setRef( 'content_navigation', $content_navigation );
459 $tpl->setRef( 'content_actions', $content_actions );
461 $tpl->set( 'sidebar', $this->buildSidebar() );
462 $tpl->set( 'nav_urls', $this->buildNavUrls() );
464 // Set the head scripts near the end, in case the above actions resulted in added scripts
465 if ( $this->useHeadElement
) {
466 $tpl->set( 'headelement', $out->headElement( $this ) );
468 $tpl->set( 'headscripts', $out->getHeadScripts() . $out->getHeadItems() );
471 $tpl->set( 'debughtml', $this->generateDebugHTML() );
472 $tpl->set( 'reporttime', wfReportTime() );
474 // original version by hansm
475 if( !wfRunHooks( 'SkinTemplateOutputPageBeforeExec', array( &$this, &$tpl ) ) ) {
476 wfDebug( __METHOD__
. ": Hook SkinTemplateOutputPageBeforeExec broke outputPage execution!\n" );
479 // Set the bodytext to another key so that skins can just output it on it's own
480 // and output printfooter and debughtml separately
481 $tpl->set( 'bodycontent', $tpl->data
['bodytext'] );
483 // Append printfooter and debughtml onto bodytext so that skins that were already
484 // using bodytext before they were split out don't suddenly start not outputting information
485 $tpl->data
['bodytext'] .= Html
::rawElement( 'div', array( 'class' => 'printfooter' ), "\n{$tpl->data['printfooter']}" ) . "\n";
486 $tpl->data
['bodytext'] .= $tpl->data
['debughtml'];
488 // allow extensions adding stuff after the page content.
489 // See Skin::afterContentHook() for further documentation.
490 $tpl->set( 'dataAfterContent', $this->afterContentHook() );
491 wfProfileOut( __METHOD__
. '-stuff5' );
494 wfProfileIn( __METHOD__
. '-execute' );
495 $res = $tpl->execute();
496 wfProfileOut( __METHOD__
. '-execute' );
498 // result may be an error
499 $this->printOrError( $res );
502 $this->setContext( $oldContext );
504 wfProfileOut( __METHOD__
);
508 * Output the string, or print error message if it's
509 * an error object of the appropriate type.
510 * For the base class, assume strings all around.
515 function printOrError( $str ) {
520 * Output a boolean indiciating if buildPersonalUrls should output separate
521 * login and create account links or output a combined link
522 * By default we simply return a global config setting that affects most skins
523 * This is setup as a method so that like with $wgLogo and getLogo() a skin
524 * can override this setting and always output one or the other if it has
525 * a reason it can't output one of the two modes.
528 function useCombinedLoginLink() {
529 global $wgUseCombinedLoginLink;
530 return $wgUseCombinedLoginLink;
534 * build array of urls for personal toolbar
537 protected function buildPersonalUrls() {
538 $title = $this->getTitle();
539 $request = $this->getRequest();
540 $pageurl = $title->getLocalURL();
541 wfProfileIn( __METHOD__
);
543 /* set up the default links for the personal toolbar */
544 $personal_urls = array();
546 # Due to bug 32276, if a user does not have read permissions,
547 # $this->getTitle() will just give Special:Badtitle, which is
548 # not especially useful as a returnto parameter. Use the title
549 # from the request instead, if there was one.
550 $page = Title
::newFromURL( $request->getVal( 'title', '' ) );
551 $page = $request->getVal( 'returnto', $page );
553 if ( strval( $page ) !== '' ) {
554 $a['returnto'] = $page;
555 $query = $request->getVal( 'returntoquery', $this->thisquery
);
557 $a['returntoquery'] = $query;
560 $returnto = wfArrayToCGI( $a );
561 if( $this->loggedin
) {
562 $personal_urls['userpage'] = array(
563 'text' => $this->username
,
564 'href' => &$this->userpageUrlDetails
['href'],
565 'class' => $this->userpageUrlDetails
['exists'] ?
false : 'new',
566 'active' => ( $this->userpageUrlDetails
['href'] == $pageurl )
568 $usertalkUrlDetails = $this->makeTalkUrlDetails( $this->userpage
);
569 $personal_urls['mytalk'] = array(
570 'text' => $this->msg( 'mytalk' )->text(),
571 'href' => &$usertalkUrlDetails['href'],
572 'class' => $usertalkUrlDetails['exists'] ?
false : 'new',
573 'active' => ( $usertalkUrlDetails['href'] == $pageurl )
575 $href = self
::makeSpecialUrl( 'Preferences' );
576 $personal_urls['preferences'] = array(
577 'text' => $this->msg( 'mypreferences' )->text(),
579 'active' => ( $href == $pageurl )
581 $href = self
::makeSpecialUrl( 'Watchlist' );
582 $personal_urls['watchlist'] = array(
583 'text' => $this->msg( 'mywatchlist' )->text(),
585 'active' => ( $href == $pageurl )
588 # We need to do an explicit check for Special:Contributions, as we
589 # have to match both the title, and the target, which could come
590 # from request values (Special:Contributions?target=Jimbo_Wales)
591 # or be specified in "sub page" form
592 # (Special:Contributions/Jimbo_Wales). The plot
593 # thickens, because the Title object is altered for special pages,
594 # so it doesn't contain the original alias-with-subpage.
595 $origTitle = Title
::newFromText( $request->getText( 'title' ) );
596 if( $origTitle instanceof Title
&& $origTitle->isSpecialPage() ) {
597 list( $spName, $spPar ) = SpecialPageFactory
::resolveAlias( $origTitle->getText() );
598 $active = $spName == 'Contributions'
599 && ( ( $spPar && $spPar == $this->username
)
600 ||
$request->getText( 'target' ) == $this->username
);
605 $href = self
::makeSpecialUrlSubpage( 'Contributions', $this->username
);
606 $personal_urls['mycontris'] = array(
607 'text' => $this->msg( 'mycontris' )->text(),
611 $personal_urls['logout'] = array(
612 'text' => $this->msg( 'userlogout' )->text(),
613 'href' => self
::makeSpecialUrl( 'Userlogout',
614 // userlogout link must always contain an & character, otherwise we might not be able
615 // to detect a buggy precaching proxy (bug 17790)
616 $title->isSpecial( 'Preferences' ) ?
'noreturnto' : $returnto
621 $useCombinedLoginLink = $this->useCombinedLoginLink();
622 $loginlink = $this->getUser()->isAllowed( 'createaccount' ) && $useCombinedLoginLink
623 ?
'nav-login-createaccount'
625 $is_signup = $request->getText('type') == "signup";
627 # anonlogin & login are the same
629 'text' => $this->msg( $loginlink )->text(),
630 'href' => self
::makeSpecialUrl( 'Userlogin', $returnto ),
631 'active' => $title->isSpecial( 'Userlogin' ) && ( $loginlink == "nav-login-createaccount" ||
!$is_signup )
633 if ( $this->getUser()->isAllowed( 'createaccount' ) && !$useCombinedLoginLink ) {
634 $createaccount_url = array(
635 'text' => $this->msg( 'createaccount' )->text(),
636 'href' => self
::makeSpecialUrl( 'Userlogin', "$returnto&type=signup" ),
637 'active' => $title->isSpecial( 'Userlogin' ) && $is_signup
640 global $wgServer, $wgSecureLogin;
641 if( substr( $wgServer, 0, 5 ) === 'http:' && $wgSecureLogin ) {
642 $title = SpecialPage
::getTitleFor( 'Userlogin' );
643 $https_url = preg_replace( '/^http:/', 'https:', $title->getFullURL() );
644 $login_url['href'] = $https_url;
645 # @todo FIXME: Class depends on skin
646 $login_url['class'] = 'link-https';
647 if ( isset($createaccount_url) ) {
648 $https_url = preg_replace( '/^http:/', 'https:',
649 $title->getFullURL("type=signup") );
650 $createaccount_url['href'] = $https_url;
651 # @todo FIXME: Class depends on skin
652 $createaccount_url['class'] = 'link-https';
656 if ( isset( $createaccount_url ) ) {
657 $personal_urls['createaccount'] = $createaccount_url;
660 if( $this->showIPinHeader() ) {
661 $href = &$this->userpageUrlDetails
['href'];
662 $personal_urls['anonuserpage'] = array(
663 'text' => $this->username
,
665 'class' => $this->userpageUrlDetails
['exists'] ?
false : 'new',
666 'active' => ( $pageurl == $href )
668 $usertalkUrlDetails = $this->makeTalkUrlDetails( $this->userpage
);
669 $href = &$usertalkUrlDetails['href'];
670 $personal_urls['anontalk'] = array(
671 'text' => $this->msg( 'anontalk' )->text(),
673 'class' => $usertalkUrlDetails['exists'] ?
false : 'new',
674 'active' => ( $pageurl == $href )
676 $personal_urls['anonlogin'] = $login_url;
678 $personal_urls['login'] = $login_url;
682 wfRunHooks( 'PersonalUrls', array( &$personal_urls, &$title ) );
683 wfProfileOut( __METHOD__
);
684 return $personal_urls;
689 * @param $title Title
690 * @param $message String message key
691 * @param $selected Bool
692 * @param $query String
693 * @param $checkEdit Bool
696 function tabAction( $title, $message, $selected, $query = '', $checkEdit = false ) {
699 $classes[] = 'selected';
701 if( $checkEdit && !$title->isKnown() ) {
703 $query = 'action=edit&redlink=1';
706 // wfMessageFallback will nicely accept $message as an array of fallbacks
707 // or just a single key
708 $msg = wfMessageFallback( $message )->setContext( $this->getContext() );
709 if ( is_array($message) ) {
710 // for hook compatibility just keep the last message name
711 $message = end($message);
713 if ( $msg->exists() ) {
714 $text = $msg->text();
717 $text = $wgContLang->getFormattedNsText(
718 MWNamespace
::getSubject( $title->getNamespace() ) );
722 if( !wfRunHooks( 'SkinTemplateTabAction', array( &$this,
723 $title, $message, $selected, $checkEdit,
724 &$classes, &$query, &$text, &$result ) ) ) {
729 'class' => implode( ' ', $classes ),
731 'href' => $title->getLocalUrl( $query ),
735 function makeTalkUrlDetails( $name, $urlaction = '' ) {
736 $title = Title
::newFromText( $name );
737 if( !is_object( $title ) ) {
738 throw new MWException( __METHOD__
. " given invalid pagename $name" );
740 $title = $title->getTalkPage();
741 self
::checkTitle( $title, $name );
743 'href' => $title->getLocalURL( $urlaction ),
744 'exists' => $title->getArticleID() != 0,
748 function makeArticleUrlDetails( $name, $urlaction = '' ) {
749 $title = Title
::newFromText( $name );
750 $title= $title->getSubjectPage();
751 self
::checkTitle( $title, $name );
753 'href' => $title->getLocalURL( $urlaction ),
754 'exists' => $title->getArticleID() != 0,
759 * a structured array of links usually used for the tabs in a skin
761 * There are 4 standard sections
762 * namespaces: Used for namespace tabs like special, page, and talk namespaces
763 * views: Used for primary page views like read, edit, history
764 * actions: Used for most extra page actions like deletion, protection, etc...
765 * variants: Used to list the language variants for the page
767 * Each section's value is a key/value array of links for that section.
768 * The links themseves have these common keys:
769 * - class: The css classes to apply to the tab
770 * - text: The text to display on the tab
771 * - href: The href for the tab to point to
772 * - rel: An optional rel= for the tab's link
773 * - redundant: If true the tab will be dropped in skins using content_actions
774 * this is useful for tabs like "Read" which only have meaning in skins that
775 * take special meaning from the grouped structure of content_navigation
777 * Views also have an extra key which can be used:
778 * - primary: If this is not true skins like vector may try to hide the tab
779 * when the user has limited space in their browser window
781 * content_navigation using code also expects these ids to be present on the
782 * links, however these are usually automatically generated by SkinTemplate
783 * itself and are not necessary when using a hook. The only things these may
784 * matter to are people modifying content_navigation after it's initial creation:
785 * - id: A "preferred" id, most skins are best off outputting this preferred id for best compatibility
786 * - tooltiponly: This is set to true for some tabs in cases where the system
787 * believes that the accesskey should not be added to the tab.
791 protected function buildContentNavigationUrls() {
792 global $wgDisableLangConversion;
794 wfProfileIn( __METHOD__
);
796 $title = $this->getRelevantTitle(); // Display tabs for the relevant title rather than always the title itself
797 $onPage = $title->equals($this->getTitle());
799 $out = $this->getOutput();
800 $request = $this->getRequest();
801 $user = $this->getUser();
803 $content_navigation = array(
804 'namespaces' => array(),
806 'actions' => array(),
807 'variants' => array()
811 $action = $request->getVal( 'action', 'view' );
813 $userCanRead = $title->quickUserCan( 'read', $user );
815 $preventActiveTabs = false;
816 wfRunHooks( 'SkinTemplatePreventOtherActiveTabs', array( &$this, &$preventActiveTabs ) );
818 // Checks if page is some kind of content
819 if( $title->canExist() ) {
820 // Gets page objects for the related namespaces
821 $subjectPage = $title->getSubjectPage();
822 $talkPage = $title->getTalkPage();
824 // Determines if this is a talk page
825 $isTalk = $title->isTalkPage();
827 // Generates XML IDs from namespace names
828 $subjectId = $title->getNamespaceKey( '' );
830 if ( $subjectId == 'main' ) {
833 $talkId = "{$subjectId}_talk";
836 $skname = $this->skinname
;
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 if ( $userCanRead ) {
853 // Adds view view link
854 if ( $title->exists() ) {
855 $content_navigation['views']['view'] = $this->tabAction(
856 $isTalk ?
$talkPage : $subjectPage,
857 array( "$skname-view-view", 'view' ),
858 ( $onPage && ($action == 'view' ||
$action == 'purge' ) ), '', true
860 $content_navigation['views']['view']['redundant'] = true; // signal to hide this from simple content_actions
863 wfProfileIn( __METHOD__
. '-edit' );
865 // Checks if user can edit the current page if it exists or create it otherwise
866 if ( $title->quickUserCan( 'edit', $user ) && ( $title->exists() ||
$title->quickUserCan( 'create', $user ) ) ) {
867 // Builds CSS class for talk page links
868 $isTalkClass = $isTalk ?
' istalk' : '';
869 // Whether the user is editing the page
870 $isEditing = $onPage && ( $action == 'edit' ||
$action == 'submit' );
871 // Whether to show the "Add a new section" tab
872 // Checks if this is a current rev of talk page and is not forced to be hidden
873 $showNewSection = !$out->forceHideNewSectionLink()
874 && ( ( $isTalk && $this->isRevisionCurrent() ) ||
$out->showNewSectionLink() );
875 $section = $request->getVal( 'section' );
877 $msgKey = $title->exists() ||
( $title->getNamespace() == NS_MEDIAWIKI
&& $title->getDefaultMessageText() !== false ) ?
879 $content_navigation['views']['edit'] = array(
880 'class' => ( $isEditing && ( $section !== 'new' ||
!$showNewSection ) ?
'selected' : '' ) . $isTalkClass,
881 'text' => wfMessageFallback( "$skname-view-$msgKey", $msgKey )->setContext( $this->getContext() )->text(),
882 'href' => $title->getLocalURL( $this->editUrlOptions() ),
883 'primary' => true, // don't collapse this in vector
887 if ( $showNewSection ) {
888 // Adds new section link
889 //$content_navigation['actions']['addsection']
890 $content_navigation['views']['addsection'] = array(
891 'class' => ( $isEditing && $section == 'new' ) ?
'selected' : false,
892 'text' => wfMessageFallback( "$skname-action-addsection", 'addsection' )->setContext( $this->getContext() )->text(),
893 'href' => $title->getLocalURL( 'action=edit§ion=new' )
896 // Checks if the page has some kind of viewable content
897 } elseif ( $title->hasSourceText() ) {
898 // Adds view source view link
899 $content_navigation['views']['viewsource'] = array(
900 'class' => ( $onPage && $action == 'edit' ) ?
'selected' : false,
901 'text' => wfMessageFallback( "$skname-action-viewsource", 'viewsource' )->setContext( $this->getContext() )->text(),
902 'href' => $title->getLocalURL( $this->editUrlOptions() ),
903 'primary' => true, // don't collapse this in vector
906 wfProfileOut( __METHOD__
. '-edit' );
908 wfProfileIn( __METHOD__
. '-live' );
909 // Checks if the page exists
910 if ( $title->exists() ) {
911 // Adds history view link
912 $content_navigation['views']['history'] = array(
913 'class' => ( $onPage && $action == 'history' ) ?
'selected' : false,
914 'text' => wfMessageFallback( "$skname-view-history", 'history_short' )->setContext( $this->getContext() )->text(),
915 'href' => $title->getLocalURL( 'action=history' ),
919 if ( $title->quickUserCan( 'delete', $user ) ) {
920 $content_navigation['actions']['delete'] = array(
921 'class' => ( $onPage && $action == 'delete' ) ?
'selected' : false,
922 'text' => wfMessageFallback( "$skname-action-delete", 'delete' )->setContext( $this->getContext() )->text(),
923 'href' => $title->getLocalURL( 'action=delete' )
927 if ( $title->quickUserCan( 'move', $user ) ) {
928 $moveTitle = SpecialPage
::getTitleFor( 'Movepage', $title->getPrefixedDBkey() );
929 $content_navigation['actions']['move'] = array(
930 'class' => $this->getTitle()->isSpecial( 'Movepage' ) ?
'selected' : false,
931 'text' => wfMessageFallback( "$skname-action-move", 'move' )->setContext( $this->getContext() )->text(),
932 'href' => $moveTitle->getLocalURL()
936 // article doesn't exist or is deleted
937 if ( $user->isAllowed( 'deletedhistory' ) ) {
938 $n = $title->isDeleted();
940 $undelTitle = SpecialPage
::getTitleFor( 'Undelete' );
941 // If the user can't undelete but can view deleted history show them a "View .. deleted" tab instead
942 $msgKey = $user->isAllowed( 'undelete' ) ?
'undelete' : 'viewdeleted';
943 $content_navigation['actions']['undelete'] = array(
944 'class' => $this->getTitle()->isSpecial( 'Undelete' ) ?
'selected' : false,
945 'text' => wfMessageFallback( "$skname-action-$msgKey", "{$msgKey}_short" )
946 ->setContext( $this->getContext() )->numParams( $n )->text(),
947 'href' => $undelTitle->getLocalURL( array( 'target' => $title->getPrefixedDBkey() ) )
953 if ( $title->getNamespace() !== NS_MEDIAWIKI
&& $title->quickUserCan( 'protect', $user ) ) {
954 $mode = $title->isProtected() ?
'unprotect' : 'protect';
955 $content_navigation['actions'][$mode] = array(
956 'class' => ( $onPage && $action == $mode ) ?
'selected' : false,
957 'text' => wfMessageFallback( "$skname-action-$mode", $mode )->setContext( $this->getContext() )->text(),
958 'href' => $title->getLocalURL( "action=$mode" )
962 wfProfileOut( __METHOD__
. '-live' );
964 // Checks if the user is logged in
965 if ( $this->loggedin
) {
967 * The following actions use messages which, if made particular to
968 * the any specific skins, would break the Ajax code which makes this
969 * action happen entirely inline. Skin::makeGlobalVariablesScript
970 * defines a set of messages in a javascript object - and these
971 * messages are assumed to be global for all skins. Without making
972 * a change to that procedure these messages will have to remain as
973 * the global versions.
975 $mode = $title->userIsWatching() ?
'unwatch' : 'watch';
976 $token = WatchAction
::getWatchToken( $title, $user, $mode );
977 $content_navigation['actions'][$mode] = array(
978 'class' => $onPage && ( $action == 'watch' ||
$action == 'unwatch' ) ?
'selected' : false,
979 'text' => $this->msg( $mode )->text(), // uses 'watch' or 'unwatch' message
980 'href' => $title->getLocalURL( array( 'action' => $mode, 'token' => $token ) )
985 wfRunHooks( 'SkinTemplateNavigation', array( &$this, &$content_navigation ) );
987 if ( $userCanRead && !$wgDisableLangConversion ) {
988 $pageLang = $title->getPageLanguage();
989 // Gets list of language variants
990 $variants = $pageLang->getVariants();
991 // Checks that language conversion is enabled and variants exist
992 // And if it is not in the special namespace
993 if( count( $variants ) > 1 ) {
994 // Gets preferred variant (note that user preference is
995 // only possible for wiki content language variant)
996 $preferred = $pageLang->getPreferredVariant();
997 // Loops over each variant
998 foreach( $variants as $code ) {
999 // Gets variant name from language code
1000 $varname = $pageLang->getVariantname( $code );
1001 // Checks if the variant is marked as disabled
1002 if( $varname == 'disable' ) {
1003 // Skips this variant
1006 // Appends variant link
1007 $content_navigation['variants'][] = array(
1008 'class' => ( $code == $preferred ) ?
'selected' : false,
1010 'href' => $title->getLocalURL( array( 'variant' => $code ) ),
1018 // If it's not content, it's got to be a special page
1019 $content_navigation['namespaces']['special'] = array(
1020 'class' => 'selected',
1021 'text' => $this->msg( 'nstab-special' )->text(),
1022 'href' => $request->getRequestURL(), // @bug 2457, 2510
1023 'context' => 'subject'
1026 wfRunHooks( 'SkinTemplateNavigation::SpecialPage',
1027 array( &$this, &$content_navigation ) );
1030 // Equiv to SkinTemplateContentActions
1031 wfRunHooks( 'SkinTemplateNavigation::Universal', array( &$this, &$content_navigation ) );
1033 // Setup xml ids and tooltip info
1034 foreach ( $content_navigation as $section => &$links ) {
1035 foreach ( $links as $key => &$link ) {
1037 if ( isset( $link['context'] ) && $link['context'] == 'subject' ) {
1038 $xmlID = 'ca-nstab-' . $xmlID;
1039 } elseif ( isset( $link['context'] ) && $link['context'] == 'talk' ) {
1041 } elseif ( $section == "variants" ) {
1042 $xmlID = 'ca-varlang-' . $xmlID;
1044 $xmlID = 'ca-' . $xmlID;
1046 $link['id'] = $xmlID;
1050 # We don't want to give the watch tab an accesskey if the
1051 # page is being edited, because that conflicts with the
1052 # accesskey on the watch checkbox. We also don't want to
1053 # give the edit tab an accesskey, because that's fairly su-
1054 # perfluous and conflicts with an accesskey (Ctrl-E) often
1055 # used for editing in Safari.
1056 if( in_array( $action, array( 'edit', 'submit' ) ) ) {
1057 if ( isset($content_navigation['views']['edit']) ) {
1058 $content_navigation['views']['edit']['tooltiponly'] = true;
1060 if ( isset($content_navigation['actions']['watch']) ) {
1061 $content_navigation['actions']['watch']['tooltiponly'] = true;
1063 if ( isset($content_navigation['actions']['unwatch']) ) {
1064 $content_navigation['actions']['unwatch']['tooltiponly'] = true;
1068 wfProfileOut( __METHOD__
);
1070 return $content_navigation;
1074 * an array of edit links by default used for the tabs
1078 function buildContentActionUrls( $content_navigation ) {
1080 wfProfileIn( __METHOD__
);
1082 // content_actions has been replaced with content_navigation for backwards
1083 // compatibility and also for skins that just want simple tabs content_actions
1084 // is now built by flattening the content_navigation arrays into one
1086 $content_actions = array();
1088 foreach ( $content_navigation as $links ) {
1090 foreach ( $links as $key => $value ) {
1092 if ( isset($value["redundant"]) && $value["redundant"] ) {
1093 // Redundant tabs are dropped from content_actions
1097 // content_actions used to have ids built using the "ca-$key" pattern
1098 // so the xmlID based id is much closer to the actual $key that we want
1099 // for that reason we'll just strip out the ca- if present and use
1100 // the latter potion of the "id" as the $key
1101 if ( isset($value["id"]) && substr($value["id"], 0, 3) == "ca-" ) {
1102 $key = substr($value["id"], 3);
1105 if ( isset($content_actions[$key]) ) {
1106 wfDebug( __METHOD__
. ": Found a duplicate key for $key while flattening content_navigation into content_actions." );
1110 $content_actions[$key] = $value;
1116 wfProfileOut( __METHOD__
);
1118 return $content_actions;
1122 * build array of common navigation links
1126 protected function buildNavUrls() {
1127 global $wgUploadNavigationUrl;
1129 wfProfileIn( __METHOD__
);
1131 $out = $this->getOutput();
1132 $request = $this->getRequest();
1134 $nav_urls = array();
1135 $nav_urls['mainpage'] = array( 'href' => self
::makeMainPageUrl() );
1136 if( $wgUploadNavigationUrl ) {
1137 $nav_urls['upload'] = array( 'href' => $wgUploadNavigationUrl );
1138 } elseif( UploadBase
::isEnabled() && UploadBase
::isAllowed( $this->getUser() ) === true ) {
1139 $nav_urls['upload'] = array( 'href' => self
::makeSpecialUrl( 'Upload' ) );
1141 $nav_urls['upload'] = false;
1143 $nav_urls['specialpages'] = array( 'href' => self
::makeSpecialUrl( 'Specialpages' ) );
1145 $nav_urls['print'] = false;
1146 $nav_urls['permalink'] = false;
1147 $nav_urls['whatlinkshere'] = false;
1148 $nav_urls['recentchangeslinked'] = false;
1149 $nav_urls['contributions'] = false;
1150 $nav_urls['log'] = false;
1151 $nav_urls['blockip'] = false;
1152 $nav_urls['emailuser'] = false;
1154 // A print stylesheet is attached to all pages, but nobody ever
1155 // figures that out. :) Add a link...
1156 if( $out->isArticle() ) {
1157 if ( !$out->isPrintable() ) {
1158 $nav_urls['print'] = array(
1159 'text' => $this->msg( 'printableversion' )->text(),
1160 'href' => $this->getTitle()->getLocalURL(
1161 $request->appendQueryValue( 'printable', 'yes', true ) )
1165 // Also add a "permalink" while we're at it
1166 $revid = $this->getRevisionId();
1168 $nav_urls['permalink'] = array(
1169 'text' => $this->msg( 'permalink' )->text(),
1170 'href' => $out->getTitle()->getLocalURL( "oldid=$revid" )
1174 // Use the copy of revision ID in case this undocumented, shady hook tries to mess with internals
1175 wfRunHooks( 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink',
1176 array( &$this, &$nav_urls, &$revid, &$revid ) );
1179 if ( $out->isArticleRelated() ) {
1180 $nav_urls['whatlinkshere'] = array(
1181 'href' => SpecialPage
::getTitleFor( 'Whatlinkshere', $this->thispage
)->getLocalUrl()
1183 if ( $this->getTitle()->getArticleID() ) {
1184 $nav_urls['recentchangeslinked'] = array(
1185 'href' => SpecialPage
::getTitleFor( 'Recentchangeslinked', $this->thispage
)->getLocalUrl()
1190 $user = $this->getRelevantUser();
1192 $rootUser = $user->getName();
1194 $nav_urls['contributions'] = array(
1195 'href' => self
::makeSpecialUrlSubpage( 'Contributions', $rootUser )
1198 $logPage = SpecialPage
::getTitleFor( 'Log' );
1199 $nav_urls['log'] = array(
1200 'href' => $logPage->getLocalUrl( array( 'user' => $rootUser ) )
1203 if ( $this->getUser()->isAllowed( 'block' ) ) {
1204 $nav_urls['blockip'] = array(
1205 'href' => self
::makeSpecialUrlSubpage( 'Block', $rootUser )
1209 if ( $this->showEmailUser( $user ) ) {
1210 $nav_urls['emailuser'] = array(
1211 'href' => self
::makeSpecialUrlSubpage( 'Emailuser', $rootUser )
1216 wfProfileOut( __METHOD__
);
1221 * Generate strings used for xml 'id' names
1225 function getNameSpaceKey() {
1226 return $this->getTitle()->getNamespaceKey();
1229 public function commonPrintStylesheet() {
1235 * Generic wrapper for template functions, with interface
1236 * compatible with what we use of PHPTAL 0.7.
1239 abstract class QuickTemplate
{
1243 public function QuickTemplate() {
1244 $this->data
= array();
1245 $this->translator
= new MediaWiki_I18N();
1249 * Sets the value $value to $name
1253 public function set( $name, $value ) {
1254 $this->data
[$name] = $value;
1261 public function setRef( $name, &$value ) {
1262 $this->data
[$name] =& $value;
1268 public function setTranslator( &$t ) {
1269 $this->translator
= &$t;
1273 * Main function, used by classes that subclass QuickTemplate
1274 * to show the actual HTML output
1276 abstract public function execute();
1281 function text( $str ) {
1282 echo htmlspecialchars( $this->data
[$str] );
1288 function jstext( $str ) {
1289 echo Xml
::escapeJsString( $this->data
[$str] );
1295 function html( $str ) {
1296 echo $this->data
[$str];
1302 function msg( $str ) {
1303 echo htmlspecialchars( $this->translator
->translate( $str ) );
1309 function msgHtml( $str ) {
1310 echo $this->translator
->translate( $str );
1314 * An ugly, ugly hack.
1317 function msgWiki( $str ) {
1320 $text = $this->translator
->translate( $str );
1321 echo $wgOut->parse( $text );
1328 function haveData( $str ) {
1329 return isset( $this->data
[$str] );
1337 function haveMsg( $str ) {
1338 $msg = $this->translator
->translate( $str );
1339 return ( $msg != '-' ) && ( $msg != '' ); # ????
1343 * Get the Skin object related to this object
1345 * @return Skin object
1347 public function getSkin() {
1348 return $this->data
['skin'];
1353 * New base template for a skin's template extended from QuickTemplate
1354 * this class features helper methods that provide common ways of interacting
1355 * with the data stored in the QuickTemplate
1357 abstract class BaseTemplate
extends QuickTemplate
{
1360 * Get a Message object with its context set
1362 * @param $name string message name
1365 public function getMsg( $name ) {
1366 return $this->getSkin()->msg( $name );
1369 function msg( $str ) {
1370 echo $this->getMsg( $str )->escaped();
1373 function msgHtml( $str ) {
1374 echo $this->getMsg( $str )->text();
1377 function msgWiki( $str ) {
1378 echo $this->getMsg( $str )->parseAsBlock();
1382 * Create an array of common toolbox items from the data in the quicktemplate
1383 * stored by SkinTemplate.
1384 * The resulting array is built acording to a format intended to be passed
1385 * through makeListItem to generate the html.
1388 function getToolbox() {
1389 wfProfileIn( __METHOD__
);
1392 if ( isset( $this->data
['nav_urls']['whatlinkshere'] ) && $this->data
['nav_urls']['whatlinkshere'] ) {
1393 $toolbox['whatlinkshere'] = $this->data
['nav_urls']['whatlinkshere'];
1394 $toolbox['whatlinkshere']['id'] = 't-whatlinkshere';
1396 if ( isset( $this->data
['nav_urls']['recentchangeslinked'] ) && $this->data
['nav_urls']['recentchangeslinked'] ) {
1397 $toolbox['recentchangeslinked'] = $this->data
['nav_urls']['recentchangeslinked'];
1398 $toolbox['recentchangeslinked']['msg'] = 'recentchangeslinked-toolbox';
1399 $toolbox['recentchangeslinked']['id'] = 't-recentchangeslinked';
1401 if ( isset( $this->data
['feeds'] ) && $this->data
['feeds'] ) {
1402 $toolbox['feeds']['id'] = 'feedlinks';
1403 $toolbox['feeds']['links'] = array();
1404 foreach ( $this->data
['feeds'] as $key => $feed ) {
1405 $toolbox['feeds']['links'][$key] = $feed;
1406 $toolbox['feeds']['links'][$key]['id'] = "feed-$key";
1407 $toolbox['feeds']['links'][$key]['rel'] = 'alternate';
1408 $toolbox['feeds']['links'][$key]['type'] = "application/{$key}+xml";
1409 $toolbox['feeds']['links'][$key]['class'] = 'feedlink';
1412 foreach ( array( 'contributions', 'log', 'blockip', 'emailuser', 'upload', 'specialpages' ) as $special ) {
1413 if ( isset( $this->data
['nav_urls'][$special] ) && $this->data
['nav_urls'][$special] ) {
1414 $toolbox[$special] = $this->data
['nav_urls'][$special];
1415 $toolbox[$special]['id'] = "t-$special";
1418 if ( isset( $this->data
['nav_urls']['print'] ) && $this->data
['nav_urls']['print'] ) {
1419 $toolbox['print'] = $this->data
['nav_urls']['print'];
1420 $toolbox['print']['rel'] = 'alternate';
1421 $toolbox['print']['msg'] = 'printableversion';
1423 if ( isset( $this->data
['nav_urls']['permalink'] ) && $this->data
['nav_urls']['permalink'] ) {
1424 $toolbox['permalink'] = $this->data
['nav_urls']['permalink'];
1425 if( $toolbox['permalink']['href'] === '' ) {
1426 unset( $toolbox['permalink']['href'] );
1427 $toolbox['ispermalink']['tooltiponly'] = true;
1428 $toolbox['ispermalink']['id'] = 't-ispermalink';
1429 $toolbox['ispermalink']['msg'] = 'permalink';
1431 $toolbox['permalink']['id'] = 't-permalink';
1434 wfRunHooks( 'BaseTemplateToolbox', array( &$this, &$toolbox ) );
1435 wfProfileOut( __METHOD__
);
1440 * Create an array of personal tools items from the data in the quicktemplate
1441 * stored by SkinTemplate.
1442 * The resulting array is built acording to a format intended to be passed
1443 * through makeListItem to generate the html.
1444 * This is in reality the same list as already stored in personal_urls
1445 * however it is reformatted so that you can just pass the individual items
1446 * to makeListItem instead of hardcoding the element creation boilerplate.
1449 function getPersonalTools() {
1450 $personal_tools = array();
1451 foreach( $this->data
['personal_urls'] as $key => $ptool ) {
1452 # The class on a personal_urls item is meant to go on the <a> instead
1453 # of the <li> so we have to use a single item "links" array instead
1454 # of using most of the personal_url's keys directly
1455 $personal_tools[$key] = array();
1456 $personal_tools[$key]["links"][] = array();
1457 $personal_tools[$key]["links"][0]["single-id"] = $personal_tools[$key]["id"] = "pt-$key";
1458 if ( isset($ptool["active"]) ) {
1459 $personal_tools[$key]["active"] = $ptool["active"];
1461 foreach ( array("href", "class", "text") as $k ) {
1462 if ( isset($ptool[$k]) )
1463 $personal_tools[$key]["links"][0][$k] = $ptool[$k];
1466 return $personal_tools;
1469 function getSidebar( $options = array() ) {
1470 // Force the rendering of the following portals
1471 $sidebar = $this->data
['sidebar'];
1472 if ( !isset( $sidebar['SEARCH'] ) ) {
1473 $sidebar['SEARCH'] = true;
1475 if ( !isset( $sidebar['TOOLBOX'] ) ) {
1476 $sidebar['TOOLBOX'] = true;
1478 if ( !isset( $sidebar['LANGUAGES'] ) ) {
1479 $sidebar['LANGUAGES'] = true;
1482 if ( !isset( $options['search'] ) ||
$options['search'] !== true ) {
1483 unset( $sidebar['SEARCH'] );
1485 if ( isset( $options['toolbox'] ) && $options['toolbox'] === false ) {
1486 unset( $sidebar['TOOLBOX'] );
1488 if ( isset( $options['languages'] ) && $options['languages'] === false ) {
1489 unset( $sidebar['LANGUAGES'] );
1493 foreach ( $sidebar as $boxName => $content ) {
1494 if ( $content === false ) {
1497 switch ( $boxName ) {
1499 // Search is a special case, skins should custom implement this
1500 $boxes[$boxName] = array(
1502 'header' => $this->getMsg( 'search' )->text(),
1503 'generated' => false,
1508 $msgObj = $this->getMsg( 'toolbox' );
1509 $boxes[$boxName] = array(
1511 'header' => $msgObj->exists() ?
$msgObj->text() : 'toolbox',
1512 'generated' => false,
1513 'content' => $this->getToolbox(),
1517 if ( $this->data
['language_urls'] ) {
1518 $msgObj = $this->getMsg( 'otherlanguages' );
1519 $boxes[$boxName] = array(
1521 'header' => $msgObj->exists() ?
$msgObj->text() : 'otherlanguages',
1522 'generated' => false,
1523 'content' => $this->data
['language_urls'],
1528 $msgObj = $this->getMsg( $boxName );
1529 $boxes[$boxName] = array(
1530 'id' => "p-$boxName",
1531 'header' => $msgObj->exists() ?
$msgObj->text() : $boxName,
1532 'generated' => true,
1533 'content' => $content,
1539 // HACK: Compatibility with extensions still using SkinTemplateToolboxEnd
1540 $hookContents = null;
1541 if ( isset( $boxes['TOOLBOX'] ) ) {
1543 // We pass an extra 'true' at the end so extensions using BaseTemplateToolbox
1544 // can abort and avoid outputting double toolbox links
1545 wfRunHooks( 'SkinTemplateToolboxEnd', array( &$this, true ) );
1546 $hookContents = ob_get_contents();
1548 if ( !trim( $hookContents ) ) {
1549 $hookContents = null;
1554 if ( isset( $options['htmlOnly'] ) && $options['htmlOnly'] === true ) {
1555 foreach ( $boxes as $boxName => $box ) {
1556 if ( is_array( $box['content'] ) ) {
1558 foreach ( $box['content'] as $key => $val ) {
1559 $content .= "\n " . $this->makeListItem( $key, $val );
1561 // HACK, shove the toolbox end onto the toolbox if we're rendering itself
1562 if ( $hookContents ) {
1563 $content .= "\n $hookContents";
1566 $content .= "\n</ul>\n";
1567 $boxes[$boxName]['content'] = $content;
1571 if ( $hookContents ) {
1572 $boxes['TOOLBOXEND'] = array(
1573 'id' => "p-toolboxend",
1574 'header' => $boxes['TOOLBOX']['header'],
1575 'generated' => false,
1576 'content' => "<ul>{$hookContents}</ul>",
1578 // HACK: Make sure that TOOLBOXEND is sorted next to TOOLBOX
1580 foreach ( $boxes as $key => $box ) {
1581 if ( $key === 'TOOLBOXEND' ) {
1584 $boxes2[$key] = $box;
1585 if ( $key === 'TOOLBOX' ) {
1586 $boxes2['TOOLBOXEND'] = $boxes['TOOLBOXEND'];
1598 * Makes a link, usually used by makeListItem to generate a link for an item
1599 * in a list used in navigation lists, portlets, portals, sidebars, etc...
1601 * $key is a string, usually a key from the list you are generating this link from
1602 * $item is an array containing some of a specific set of keys.
1603 * The text of the link will be generated either from the contents of the "text"
1604 * key in the $item array, if a "msg" key is present a message by that name will
1605 * be used, and if neither of those are set the $key will be used as a message name.
1606 * If a "href" key is not present makeLink will just output htmlescaped text.
1607 * The href, id, class, rel, and type keys are used as attributes for the link if present.
1608 * If an "id" or "single-id" (if you don't want the actual id to be output on the link)
1609 * is present it will be used to generate a tooltip and accesskey for the link.
1610 * If you don't want an accesskey, set $item['tooltiponly'] = true;
1611 * $options can be used to affect the output of a link:
1612 * You can use a text-wrapper key to specify a list of elements to wrap the
1613 * text of a link in. This should be an array of arrays containing a 'tag' and
1614 * optionally an 'attributes' key. If you only have one element you don't need
1615 * to wrap it in another array. eg: To use <a><span>...</span></a> in all links
1616 * use array( 'text-wrapper' => array( 'tag' => 'span' ) ) for your options.
1617 * A link-class key can be used to specify additional classes to apply to all links.
1618 * A link-fallback can be used to specify a tag to use instead of <a> if there is
1619 * no link. eg: If you specify 'link-fallback' => 'span' than any non-link will
1620 * output a <span> instead of just text.
1623 function makeLink( $key, $item, $options = array() ) {
1624 if ( isset( $item['text'] ) ) {
1625 $text = $item['text'];
1627 $text = $this->translator
->translate( isset( $item['msg'] ) ?
$item['msg'] : $key );
1630 $html = htmlspecialchars( $text );
1632 if ( isset( $options['text-wrapper'] ) ) {
1633 $wrapper = $options['text-wrapper'];
1634 if ( isset( $wrapper['tag'] ) ) {
1635 $wrapper = array( $wrapper );
1637 while ( count( $wrapper ) > 0 ) {
1638 $element = array_pop( $wrapper );
1639 $html = Html
::rawElement( $element['tag'], isset( $element['attributes'] ) ?
$element['attributes'] : null, $html );
1643 if ( isset( $item['href'] ) ||
isset( $options['link-fallback'] ) ) {
1645 foreach ( array( 'single-id', 'text', 'msg', 'tooltiponly' ) as $k ) {
1646 unset( $attrs[$k] );
1649 if ( isset( $item['id'] ) && !isset( $item['single-id'] ) ) {
1650 $item['single-id'] = $item['id'];
1652 if ( isset( $item['single-id'] ) ) {
1653 if ( isset( $item['tooltiponly'] ) && $item['tooltiponly'] ) {
1654 $title = Linker
::titleAttrib( $item['single-id'] );
1655 if ( $title !== false ) {
1656 $attrs['title'] = $title;
1659 $tip = Linker
::tooltipAndAccesskeyAttribs( $item['single-id'] );
1660 if ( isset( $tip['title'] ) && $tip['title'] !== false ) {
1661 $attrs['title'] = $tip['title'];
1663 if ( isset( $tip['accesskey'] ) && $tip['accesskey'] !== false ) {
1664 $attrs['accesskey'] = $tip['accesskey'];
1668 if ( isset( $options['link-class'] ) ) {
1669 if ( isset( $attrs['class'] ) ) {
1670 $attrs['class'] .= " {$options['link-class']}";
1672 $attrs['class'] = $options['link-class'];
1675 $html = Html
::rawElement( isset( $attrs['href'] ) ?
'a' : $options['link-fallback'], $attrs, $html );
1682 * Generates a list item for a navigation, portlet, portal, sidebar... etc list
1683 * $key is a string, usually a key from the list you are generating this link from
1684 * $item is an array of list item data containing some of a specific set of keys.
1685 * The "id" and "class" keys will be used as attributes for the list item,
1686 * if "active" contains a value of true a "active" class will also be appended to class.
1687 * If you want something other than a <li> you can pass a tag name such as
1688 * "tag" => "span" in the $options array to change the tag used.
1689 * link/content data for the list item may come in one of two forms
1690 * A "links" key may be used, in which case it should contain an array with
1691 * a list of links to include inside the list item, see makeLink for the format
1692 * of individual links array items.
1693 * Otherwise the relevant keys from the list item $item array will be passed
1694 * to makeLink instead. Note however that "id" and "class" are used by the
1695 * list item directly so they will not be passed to makeLink
1696 * (however the link will still support a tooltip and accesskey from it)
1697 * If you need an id or class on a single link you should include a "links"
1698 * array with just one link item inside of it.
1699 * $options is also passed on to makeLink calls
1702 function makeListItem( $key, $item, $options = array() ) {
1703 if ( isset( $item['links'] ) ) {
1705 foreach ( $item['links'] as $linkKey => $link ) {
1706 $html .= $this->makeLink( $linkKey, $link, $options );
1710 // These keys are used by makeListItem and shouldn't be passed on to the link
1711 foreach ( array( 'id', 'class', 'active', 'tag' ) as $k ) {
1714 if ( isset( $item['id'] ) ) {
1715 // The id goes on the <li> not on the <a> for single links
1716 // but makeSidebarLink still needs to know what id to use when
1717 // generating tooltips and accesskeys.
1718 $link['single-id'] = $item['id'];
1720 $html = $this->makeLink( $key, $link, $options );
1724 foreach ( array( 'id', 'class' ) as $attr ) {
1725 if ( isset( $item[$attr] ) ) {
1726 $attrs[$attr] = $item[$attr];
1729 if ( isset( $item['active'] ) && $item['active'] ) {
1730 if ( !isset( $attrs['class'] ) ) {
1731 $attrs['class'] = '';
1733 $attrs['class'] .= ' active';
1734 $attrs['class'] = trim( $attrs['class'] );
1736 return Html
::rawElement( isset( $options['tag'] ) ?
$options['tag'] : 'li', $attrs, $html );
1739 function makeSearchInput( $attrs = array() ) {
1743 'value' => isset( $this->data
['search'] ) ?
$this->data
['search'] : '',
1745 $realAttrs = array_merge( $realAttrs, Linker
::tooltipAndAccesskeyAttribs( 'search' ), $attrs );
1746 return Html
::element( 'input', $realAttrs );
1749 function makeSearchButton( $mode, $attrs = array() ) {
1756 'value' => $this->translator
->translate(
1757 $mode == 'go' ?
'searcharticle' : 'searchbutton' ),
1759 $realAttrs = array_merge(
1761 Linker
::tooltipAndAccesskeyAttribs( "search-$mode" ),
1764 return Html
::element( 'input', $realAttrs );
1766 $buttonAttrs = array(
1770 $buttonAttrs = array_merge(
1772 Linker
::tooltipAndAccesskeyAttribs( 'search-fulltext' ),
1775 unset( $buttonAttrs['src'] );
1776 unset( $buttonAttrs['alt'] );
1778 'src' => $attrs['src'],
1779 'alt' => isset( $attrs['alt'] )
1781 : $this->translator
->translate( 'searchbutton' ),
1783 return Html
::rawElement( 'button', $buttonAttrs, Html
::element( 'img', $imgAttrs ) );
1785 throw new MWException( 'Unknown mode passed to BaseTemplate::makeSearchButton' );
1790 * Returns an array of footerlinks trimmed down to only those footer links that
1792 * If you pass "flat" as an option then the returned array will be a flat array
1793 * of footer icons instead of a key/value array of footerlinks arrays broken
1794 * up into categories.
1795 * @return array|mixed
1797 function getFooterLinks( $option = null ) {
1798 $footerlinks = $this->data
['footerlinks'];
1800 // Reduce footer links down to only those which are being used
1801 $validFooterLinks = array();
1802 foreach( $footerlinks as $category => $links ) {
1803 $validFooterLinks[$category] = array();
1804 foreach( $links as $link ) {
1805 if( isset( $this->data
[$link] ) && $this->data
[$link] ) {
1806 $validFooterLinks[$category][] = $link;
1809 if ( count( $validFooterLinks[$category] ) <= 0 ) {
1810 unset( $validFooterLinks[$category] );
1814 if ( $option == 'flat' ) {
1815 // fold footerlinks into a single array using a bit of trickery
1816 $validFooterLinks = call_user_func_array(
1818 array_values( $validFooterLinks )
1822 return $validFooterLinks;
1826 * Returns an array of footer icons filtered down by options relevant to how
1827 * the skin wishes to display them.
1828 * If you pass "icononly" as the option all footer icons which do not have an
1829 * image icon set will be filtered out.
1830 * If you pass "nocopyright" then MediaWiki's copyright icon will not be included
1831 * in the list of footer icons. This is mostly useful for skins which only
1832 * display the text from footericons instead of the images and don't want a
1833 * duplicate copyright statement because footerlinks already rendered one.
1836 function getFooterIcons( $option = null ) {
1837 // Generate additional footer icons
1838 $footericons = $this->data
['footericons'];
1840 if ( $option == 'icononly' ) {
1841 // Unset any icons which don't have an image
1842 foreach ( $footericons as &$footerIconsBlock ) {
1843 foreach ( $footerIconsBlock as $footerIconKey => $footerIcon ) {
1844 if ( !is_string( $footerIcon ) && !isset( $footerIcon['src'] ) ) {
1845 unset( $footerIconsBlock[$footerIconKey] );
1849 // Redo removal of any empty blocks
1850 foreach ( $footericons as $footerIconsKey => &$footerIconsBlock ) {
1851 if ( count( $footerIconsBlock ) <= 0 ) {
1852 unset( $footericons[$footerIconsKey] );
1855 } elseif ( $option == 'nocopyright' ) {
1856 unset( $footericons['copyright']['copyright'] );
1857 if ( count( $footericons['copyright'] ) <= 0 ) {
1858 unset( $footericons['copyright'] );
1862 return $footericons;
1866 * Output the basic end-page trail including bottomscripts, reporttime, and
1867 * debug stuff. This should be called right before outputting the closing
1868 * body and html tags.
1870 function printTrail() { ?
>
1871 <?php
$this->html('bottomscripts'); /* JS call to runBodyOnloadHook */ ?
>
1872 <?php
$this->html('reporttime') ?
>
1873 <?php
if ( $this->data
['debug'] ): ?
>
1875 <?php
$this->text( 'debug' ); ?
>