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