Added jquery.json library to core.
[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 $page = $wgRequest->getVal( 'returnto', $this->thisurl );
570 $query = $wgRequest->getVal( 'returntoquery', $this->thisquery );
571 $returnto = wfArrayToCGI( array( 'returnto' => $page ) );
572 if( $this->thisquery != '' ) {
573 $returnto .= "&returntoquery=$query";
574 }
575 if( $this->loggedin ) {
576 $personal_urls['userpage'] = array(
577 'text' => $this->username,
578 'href' => &$this->userpageUrlDetails['href'],
579 'class' => $this->userpageUrlDetails['exists'] ? false : 'new',
580 'active' => ( $this->userpageUrlDetails['href'] == $pageurl )
581 );
582 $usertalkUrlDetails = $this->makeTalkUrlDetails( $this->userpage );
583 $personal_urls['mytalk'] = array(
584 'text' => wfMsg( 'mytalk' ),
585 'href' => &$usertalkUrlDetails['href'],
586 'class' => $usertalkUrlDetails['exists'] ? false : 'new',
587 'active' => ( $usertalkUrlDetails['href'] == $pageurl )
588 );
589 $href = self::makeSpecialUrl( 'Preferences' );
590 $personal_urls['preferences'] = array(
591 'text' => wfMsg( 'mypreferences' ),
592 'href' => $href,
593 'active' => ( $href == $pageurl )
594 );
595 $href = self::makeSpecialUrl( 'Watchlist' );
596 $personal_urls['watchlist'] = array(
597 'text' => wfMsg( 'mywatchlist' ),
598 'href' => $href,
599 'active' => ( $href == $pageurl )
600 );
601
602 # We need to do an explicit check for Special:Contributions, as we
603 # have to match both the title, and the target (which could come
604 # from request values or be specified in "sub page" form. The plot
605 # thickens, because $wgTitle is altered for special pages, so doesn't
606 # contain the original alias-with-subpage.
607 $origTitle = Title::newFromText( $wgRequest->getText( 'title' ) );
608 if( $origTitle instanceof Title && $origTitle->getNamespace() == NS_SPECIAL ) {
609 list( $spName, $spPar ) = SpecialPageFactory::resolveAlias( $origTitle->getText() );
610 $active = $spName == 'Contributions'
611 && ( ( $spPar && $spPar == $this->username )
612 || $wgRequest->getText( 'target' ) == $this->username );
613 } else {
614 $active = false;
615 }
616
617 $href = self::makeSpecialUrlSubpage( 'Contributions', $this->username );
618 $personal_urls['mycontris'] = array(
619 'text' => wfMsg( 'mycontris' ),
620 'href' => $href,
621 'active' => $active
622 );
623 $personal_urls['logout'] = array(
624 'text' => wfMsg( 'userlogout' ),
625 'href' => self::makeSpecialUrl( 'Userlogout',
626 // userlogout link must always contain an & character, otherwise we might not be able
627 // to detect a buggy precaching proxy (bug 17790)
628 $title->isSpecial( 'Preferences' ) ? 'noreturnto' : $returnto
629 ),
630 'active' => false
631 );
632 } else {
633 global $wgUser;
634 $useCombinedLoginLink = $this->useCombinedLoginLink();
635 $loginlink = $wgUser->isAllowed( 'createaccount' ) && $useCombinedLoginLink
636 ? 'nav-login-createaccount'
637 : 'login';
638 $is_signup = $wgRequest->getText('type') == "signup";
639
640 # anonlogin & login are the same
641 $login_url = array(
642 'text' => wfMsg( $loginlink ),
643 'href' => self::makeSpecialUrl( 'Userlogin', $returnto ),
644 'active' => $title->isSpecial( 'Userlogin' ) && ( $loginlink == "nav-login-createaccount" || !$is_signup )
645 );
646 if ( $wgUser->isAllowed( 'createaccount' ) && !$useCombinedLoginLink ) {
647 $createaccount_url = array(
648 'text' => wfMsg( 'createaccount' ),
649 'href' => self::makeSpecialUrl( 'Userlogin', "$returnto&type=signup" ),
650 'active' => $title->isSpecial( 'Userlogin' ) && $is_signup
651 );
652 }
653 global $wgProto, $wgSecureLogin;
654 if( $wgProto === 'http' && $wgSecureLogin ) {
655 $title = SpecialPage::getTitleFor( 'Userlogin' );
656 $https_url = preg_replace( '/^http:/', 'https:', $title->getFullURL() );
657 $login_url['href'] = $https_url;
658 $login_url['class'] = 'link-https'; # FIXME class depends on skin
659 if ( isset($createaccount_url) ) {
660 $https_url = preg_replace( '/^http:/', 'https:', $title->getFullURL("type=signup") );
661 $createaccount_url['href'] = $https_url;
662 $createaccount_url['class'] = 'link-https'; # FIXME class depends on skin
663 }
664 }
665
666
667 if( $this->showIPinHeader() ) {
668 $href = &$this->userpageUrlDetails['href'];
669 $personal_urls['anonuserpage'] = array(
670 'text' => $this->username,
671 'href' => $href,
672 'class' => $this->userpageUrlDetails['exists'] ? false : 'new',
673 'active' => ( $pageurl == $href )
674 );
675 $usertalkUrlDetails = $this->makeTalkUrlDetails( $this->userpage );
676 $href = &$usertalkUrlDetails['href'];
677 $personal_urls['anontalk'] = array(
678 'text' => wfMsg( 'anontalk' ),
679 'href' => $href,
680 'class' => $usertalkUrlDetails['exists'] ? false : 'new',
681 'active' => ( $pageurl == $href )
682 );
683 $personal_urls['anonlogin'] = $login_url;
684 } else {
685 $personal_urls['login'] = $login_url;
686 }
687 if ( isset($createaccount_url) ) {
688 $personal_urls['createaccount'] = $createaccount_url;
689 }
690 }
691
692 wfRunHooks( 'PersonalUrls', array( &$personal_urls, &$title ) );
693 wfProfileOut( __METHOD__ );
694 return $personal_urls;
695 }
696
697 /**
698 * TODO document
699 * @param $title Title
700 * @param $message String message key
701 * @param $selected Bool
702 * @param $query String
703 * @param $checkEdit Bool
704 * @return array
705 */
706 function tabAction( $title, $message, $selected, $query = '', $checkEdit = false ) {
707 $classes = array();
708 if( $selected ) {
709 $classes[] = 'selected';
710 }
711 if( $checkEdit && !$title->isKnown() ) {
712 $classes[] = 'new';
713 $query = 'action=edit&redlink=1';
714 }
715
716 // wfMessageFallback will nicely accept $message as an array of fallbacks
717 // or just a single key
718 $msg = wfMessageFallback( $message );
719 if ( is_array($message) ) {
720 // for hook compatibility just keep the last message name
721 $message = end($message);
722 }
723 if ( $msg->exists() ) {
724 $text = $msg->text();
725 } else {
726 global $wgContLang;
727 $text = $wgContLang->getFormattedNsText( MWNamespace::getSubject( $title->getNamespace() ) );
728 }
729
730 $result = array();
731 if( !wfRunHooks( 'SkinTemplateTabAction', array( &$this,
732 $title, $message, $selected, $checkEdit,
733 &$classes, &$query, &$text, &$result ) ) ) {
734 return $result;
735 }
736
737 return array(
738 'class' => implode( ' ', $classes ),
739 'text' => $text,
740 'href' => $title->getLocalUrl( $query ),
741 'primary' => true );
742 }
743
744 function makeTalkUrlDetails( $name, $urlaction = '' ) {
745 $title = Title::newFromText( $name );
746 if( !is_object( $title ) ) {
747 throw new MWException( __METHOD__ . " given invalid pagename $name" );
748 }
749 $title = $title->getTalkPage();
750 self::checkTitle( $title, $name );
751 return array(
752 'href' => $title->getLocalURL( $urlaction ),
753 'exists' => $title->getArticleID() != 0,
754 );
755 }
756
757 function makeArticleUrlDetails( $name, $urlaction = '' ) {
758 $title = Title::newFromText( $name );
759 $title= $title->getSubjectPage();
760 self::checkTitle( $title, $name );
761 return array(
762 'href' => $title->getLocalURL( $urlaction ),
763 'exists' => $title->getArticleID() != 0,
764 );
765 }
766
767 /**
768 * a structured array of links usually used for the tabs in a skin
769 *
770 * There are 4 standard sections
771 * namespaces: Used for namespace tabs like special, page, and talk namespaces
772 * views: Used for primary page views like read, edit, history
773 * actions: Used for most extra page actions like deletion, protection, etc...
774 * variants: Used to list the language variants for the page
775 *
776 * Each section's value is a key/value array of links for that section.
777 * The links themseves have these common keys:
778 * - class: The css classes to apply to the tab
779 * - text: The text to display on the tab
780 * - href: The href for the tab to point to
781 * - rel: An optional rel= for the tab's link
782 * - redundant: If true the tab will be dropped in skins using content_actions
783 * this is useful for tabs like "Read" which only have meaning in skins that
784 * take special meaning from the grouped structure of content_navigation
785 *
786 * Views also have an extra key which can be used:
787 * - primary: If this is not true skins like vector may try to hide the tab
788 * when the user has limited space in their browser window
789 *
790 * content_navigation using code also expects these ids to be present on the
791 * links, however these are usually automatically generated by SkinTemplate
792 * itself and are not necessary when using a hook. The only things these may
793 * matter to are people modifying content_navigation after it's initial creation:
794 * - id: A "preferred" id, most skins are best off outputting this preferred id for best compatibility
795 * - tooltiponly: This is set to true for some tabs in cases where the system
796 * believes that the accesskey should not be added to the tab.
797 *
798 * @return array
799 */
800 protected function buildContentNavigationUrls( OutputPage $out ) {
801 global $wgContLang, $wgLang, $wgUser, $wgRequest;
802 global $wgDisableLangConversion;
803
804 wfProfileIn( __METHOD__ );
805
806 $title = $this->getRelevantTitle(); // Display tabs for the relevant title rather than always the title itself
807 $onPage = $title->equals($this->getTitle());
808
809 $content_navigation = array(
810 'namespaces' => array(),
811 'views' => array(),
812 'actions' => array(),
813 'variants' => array()
814 );
815
816 // parameters
817 $action = $wgRequest->getVal( 'action', 'view' );
818 $section = $wgRequest->getVal( 'section' );
819
820 $userCanRead = $title->userCanRead();
821 $skname = $this->skinname;
822
823 $preventActiveTabs = false;
824 wfRunHooks( 'SkinTemplatePreventOtherActiveTabs', array( &$this, &$preventActiveTabs ) );
825
826 // Checks if page is some kind of content
827 if( $title->getNamespace() != NS_SPECIAL ) {
828 // Gets page objects for the related namespaces
829 $subjectPage = $title->getSubjectPage();
830 $talkPage = $title->getTalkPage();
831
832 // Determines if this is a talk page
833 $isTalk = $title->isTalkPage();
834
835 // Generates XML IDs from namespace names
836 $subjectId = $title->getNamespaceKey( '' );
837
838 if ( $subjectId == 'main' ) {
839 $talkId = 'talk';
840 } else {
841 $talkId = "{$subjectId}_talk";
842 }
843
844 // Adds namespace links
845 $subjectMsg = array( "nstab-$subjectId" );
846 if ( $subjectPage->isMainPage() ) {
847 array_unshift($subjectMsg, 'mainpage-nstab');
848 }
849 $content_navigation['namespaces'][$subjectId] = $this->tabAction(
850 $subjectPage, $subjectMsg, !$isTalk && !$preventActiveTabs, '', $userCanRead
851 );
852 $content_navigation['namespaces'][$subjectId]['context'] = 'subject';
853 $content_navigation['namespaces'][$talkId] = $this->tabAction(
854 $talkPage, array( "nstab-$talkId", 'talk' ), $isTalk && !$preventActiveTabs, '', $userCanRead
855 );
856 $content_navigation['namespaces'][$talkId]['context'] = 'talk';
857
858 // Adds view view link
859 if ( $title->exists() && $userCanRead ) {
860 $content_navigation['views']['view'] = $this->tabAction(
861 $isTalk ? $talkPage : $subjectPage,
862 array( "$skname-view-view", 'view' ),
863 ( $onPage && ($action == 'view' || $action == 'purge' ) ), '', true
864 );
865 $content_navigation['views']['view']['redundant'] = true; // signal to hide this from simple content_actions
866 }
867
868 wfProfileIn( __METHOD__ . '-edit' );
869
870 // Checks if user can...
871 if (
872 // read and edit the current page
873 $userCanRead && $title->quickUserCan( 'edit' ) &&
874 (
875 // if it exists
876 $title->exists() ||
877 // or they can create one here
878 $title->quickUserCan( 'create' )
879 )
880 ) {
881 // Builds CSS class for talk page links
882 $isTalkClass = $isTalk ? ' istalk' : '';
883
884 // Determines if we're in edit mode
885 $selected = (
886 $onPage &&
887 ( $action == 'edit' || $action == 'submit' ) &&
888 ( $section != 'new' )
889 );
890 $msgKey = $title->exists() || ( $title->getNamespace() == NS_MEDIAWIKI && !wfEmptyMsg( $title->getText() ) ) ?
891 "edit" : "create";
892 $content_navigation['views']['edit'] = array(
893 'class' => ( $selected ? 'selected' : '' ) . $isTalkClass,
894 'text' => wfMessageFallback( "$skname-view-$msgKey", $msgKey )->text(),
895 'href' => $title->getLocalURL( $this->editUrlOptions() ),
896 'primary' => true, // don't collapse this in vector
897 );
898 // Checks if this is a current rev of talk page and we should show a new
899 // section link
900 if ( ( $isTalk && $this->isRevisionCurrent() ) || ( $out->showNewSectionLink() ) ) {
901 // Checks if we should ever show a new section link
902 if ( !$out->forceHideNewSectionLink() ) {
903 // Adds new section link
904 //$content_navigation['actions']['addsection']
905 $content_navigation['views']['addsection'] = array(
906 'class' => $section == 'new' ? 'selected' : false,
907 'text' => wfMessageFallback( "$skname-action-addsection", 'addsection' )->text(),
908 'href' => $title->getLocalURL( 'action=edit&section=new' )
909 );
910 }
911 }
912 // Checks if the page has some kind of viewable content
913 } elseif ( $title->hasSourceText() && $userCanRead ) {
914 // Adds view source view link
915 $content_navigation['views']['viewsource'] = array(
916 'class' => ( $onPage && $action == 'edit' ) ? 'selected' : false,
917 'text' => wfMessageFallback( "$skname-action-viewsource", 'viewsource' )->text(),
918 'href' => $title->getLocalURL( $this->editUrlOptions() ),
919 'primary' => true, // don't collapse this in vector
920 );
921 }
922 wfProfileOut( __METHOD__ . '-edit' );
923
924 wfProfileIn( __METHOD__ . '-live' );
925
926 // Checks if the page exists
927 if ( $title->exists() && $userCanRead ) {
928 // Adds history view link
929 $content_navigation['views']['history'] = array(
930 'class' => ( $onPage && $action == 'history' ) ? 'selected' : false,
931 'text' => wfMessageFallback( "$skname-view-history", 'history_short' )->text(),
932 'href' => $title->getLocalURL( 'action=history' ),
933 'rel' => 'archives',
934 );
935
936 if( $wgUser->isAllowed( 'delete' ) ) {
937 $content_navigation['actions']['delete'] = array(
938 'class' => ( $onPage && $action == 'delete' ) ? 'selected' : false,
939 'text' => wfMessageFallback( "$skname-action-delete", 'delete' )->text(),
940 'href' => $title->getLocalURL( 'action=delete' )
941 );
942 }
943 if ( $title->quickUserCan( 'move' ) ) {
944 $moveTitle = SpecialPage::getTitleFor( 'Movepage', $title->getPrefixedDBkey() );
945 $content_navigation['actions']['move'] = array(
946 'class' => $this->getTitle()->isSpecial( 'Movepage' ) ? 'selected' : false,
947 'text' => wfMessageFallback( "$skname-action-move", 'move' )->text(),
948 'href' => $moveTitle->getLocalURL()
949 );
950 }
951
952 if ( $title->getNamespace() !== NS_MEDIAWIKI && $wgUser->isAllowed( 'protect' ) ) {
953 $mode = !$title->isProtected() ? 'protect' : 'unprotect';
954 $content_navigation['actions'][$mode] = array(
955 'class' => ( $onPage && $action == $mode ) ? 'selected' : false,
956 'text' => wfMessageFallback( "$skname-action-$mode", $mode )->text(),
957 'href' => $title->getLocalURL( "action=$mode" )
958 );
959 }
960 } else {
961 // article doesn't exist or is deleted
962 if ( $wgUser->isAllowed( 'deletedhistory' ) ) {
963 $n = $title->isDeleted();
964 if( $n ) {
965 $undelTitle = SpecialPage::getTitleFor( 'Undelete' );
966 // If the user can't undelete but can view deleted history show them a "View .. deleted" tab instead
967 $msgKey = $wgUser->isAllowed( 'undelete' ) ? 'undelete' : 'viewdeleted';
968 $content_navigation['actions']['undelete'] = array(
969 'class' => $this->getTitle()->isSpecial( 'Undelete' ) ? 'selected' : false,
970 'text' => wfMessageFallback( "$skname-action-$msgKey", "{$msgKey}_short" )
971 ->params( $wgLang->formatNum( $n ) )->text(),
972 'href' => $undelTitle->getLocalURL( array( 'target' => $title->getPrefixedDBkey() ) )
973 );
974 }
975 }
976
977 if ( $title->getNamespace() !== NS_MEDIAWIKI && $wgUser->isAllowed( 'protect' ) ) {
978 $mode = !$title->getRestrictions( 'create' ) ? 'protect' : 'unprotect';
979 $content_navigation['actions'][$mode] = array(
980 'class' => ( $onPage && $action == $mode ) ? 'selected' : false,
981 'text' => wfMessageFallback( "$skname-action-$mode", $mode )->text(),
982 'href' => $title->getLocalURL( "action=$mode" )
983 );
984 }
985 }
986 wfProfileOut( __METHOD__ . '-live' );
987
988 // Checks if the user is logged in
989 if ( $this->loggedin ) {
990 /**
991 * The following actions use messages which, if made particular to
992 * the any specific skins, would break the Ajax code which makes this
993 * action happen entirely inline. Skin::makeGlobalVariablesScript
994 * defines a set of messages in a javascript object - and these
995 * messages are assumed to be global for all skins. Without making
996 * a change to that procedure these messages will have to remain as
997 * the global versions.
998 */
999 $mode = $title->userIsWatching() ? 'unwatch' : 'watch';
1000 $content_navigation['actions'][$mode] = array(
1001 'class' => $onPage && ( $action == 'watch' || $action == 'unwatch' ) ? 'selected' : false,
1002 'text' => wfMsg( $mode ), // uses 'watch' or 'unwatch' message
1003 'href' => $title->getLocalURL( 'action=' . $mode )
1004 );
1005 }
1006
1007 wfRunHooks( 'SkinTemplateNavigation', array( &$this, &$content_navigation ) );
1008 } else {
1009 // If it's not content, it's got to be a special page
1010 $content_navigation['namespaces']['special'] = array(
1011 'class' => 'selected',
1012 'text' => wfMsg( 'nstab-special' ),
1013 'href' => $wgRequest->getRequestURL(), // @bug 2457, 2510
1014 'context' => 'subject'
1015 );
1016
1017 wfRunHooks( 'SkinTemplateNavigation::SpecialPage', array( &$this, &$content_navigation ) );
1018 }
1019
1020 // Gets list of language variants
1021 $variants = $wgContLang->getVariants();
1022 // Checks that language conversion is enabled and variants exist
1023 if( !$wgDisableLangConversion && count( $variants ) > 1 ) {
1024 // Gets preferred variant
1025 $preferred = $wgContLang->getPreferredVariant();
1026 // Loops over each variant
1027 foreach( $variants as $code ) {
1028 // Gets variant name from language code
1029 $varname = $wgContLang->getVariantname( $code );
1030 // Checks if the variant is marked as disabled
1031 if( $varname == 'disable' ) {
1032 // Skips this variant
1033 continue;
1034 }
1035 // Appends variant link
1036 $content_navigation['variants'][] = array(
1037 'class' => ( $code == $preferred ) ? 'selected' : false,
1038 'text' => $varname,
1039 'href' => $title->getLocalURL( '', $code )
1040 );
1041 }
1042 }
1043
1044 // Equiv to SkinTemplateContentActions
1045 wfRunHooks( 'SkinTemplateNavigation::Universal', array( &$this, &$content_navigation ) );
1046
1047 // Setup xml ids and tooltip info
1048 foreach ( $content_navigation as $section => &$links ) {
1049 foreach ( $links as $key => &$link ) {
1050 $xmlID = $key;
1051 if ( isset( $link['context'] ) && $link['context'] == 'subject' ) {
1052 $xmlID = 'ca-nstab-' . $xmlID;
1053 } elseif ( isset( $link['context'] ) && $link['context'] == 'talk' ) {
1054 $xmlID = 'ca-talk';
1055 } elseif ( $section == "variants" ) {
1056 $xmlID = 'ca-varlang-' . $xmlID;
1057 } else {
1058 $xmlID = 'ca-' . $xmlID;
1059 }
1060 $link['id'] = $xmlID;
1061 }
1062 }
1063
1064 # We don't want to give the watch tab an accesskey if the
1065 # page is being edited, because that conflicts with the
1066 # accesskey on the watch checkbox. We also don't want to
1067 # give the edit tab an accesskey, because that's fairly su-
1068 # perfluous and conflicts with an accesskey (Ctrl-E) often
1069 # used for editing in Safari.
1070 if( in_array( $action, array( 'edit', 'submit' ) ) ) {
1071 if ( isset($content_navigation['views']['edit']) ) {
1072 $content_navigation['views']['edit']['tooltiponly'] = true;
1073 }
1074 if ( isset($content_navigation['actions']['watch']) ) {
1075 $content_navigation['actions']['watch']['tooltiponly'] = true;
1076 }
1077 if ( isset($content_navigation['actions']['unwatch']) ) {
1078 $content_navigation['actions']['unwatch']['tooltiponly'] = true;
1079 }
1080 }
1081
1082 wfProfileOut( __METHOD__ );
1083
1084 return $content_navigation;
1085 }
1086
1087 /**
1088 * an array of edit links by default used for the tabs
1089 * @return array
1090 * @private
1091 */
1092 function buildContentActionUrls( $content_navigation ) {
1093
1094 wfProfileIn( __METHOD__ );
1095
1096 // content_actions has been replaced with content_navigation for backwards
1097 // compatibility and also for skins that just want simple tabs content_actions
1098 // is now built by flattening the content_navigation arrays into one
1099
1100 $content_actions = array();
1101
1102 foreach ( $content_navigation as $links ) {
1103
1104 foreach ( $links as $key => $value ) {
1105
1106 if ( isset($value["redundant"]) && $value["redundant"] ) {
1107 // Redundant tabs are dropped from content_actions
1108 continue;
1109 }
1110
1111 // content_actions used to have ids built using the "ca-$key" pattern
1112 // so the xmlID based id is much closer to the actual $key that we want
1113 // for that reason we'll just strip out the ca- if present and use
1114 // the latter potion of the "id" as the $key
1115 if ( isset($value["id"]) && substr($value["id"], 0, 3) == "ca-" ) {
1116 $key = substr($value["id"], 3);
1117 }
1118
1119 if ( isset($content_actions[$key]) ) {
1120 wfDebug( __METHOD__ . ": Found a duplicate key for $key while flattening content_navigation into content_actions." );
1121 continue;
1122 }
1123
1124 $content_actions[$key] = $value;
1125
1126 }
1127
1128 }
1129
1130 wfProfileOut( __METHOD__ );
1131
1132 return $content_actions;
1133 }
1134
1135 /**
1136 * build array of common navigation links
1137 * @return array
1138 * @private
1139 */
1140 protected function buildNavUrls( OutputPage $out ) {
1141 global $wgUseTrackbacks, $wgUser, $wgRequest;
1142 global $wgUploadNavigationUrl;
1143
1144 wfProfileIn( __METHOD__ );
1145
1146 $action = $wgRequest->getVal( 'action', 'view' );
1147
1148 $nav_urls = array();
1149 $nav_urls['mainpage'] = array( 'href' => self::makeMainPageUrl() );
1150 if( $wgUploadNavigationUrl ) {
1151 $nav_urls['upload'] = array( 'href' => $wgUploadNavigationUrl );
1152 } elseif( UploadBase::isEnabled() && UploadBase::isAllowed( $wgUser ) === true ) {
1153 $nav_urls['upload'] = array( 'href' => self::makeSpecialUrl( 'Upload' ) );
1154 } else {
1155 $nav_urls['upload'] = false;
1156 }
1157 $nav_urls['specialpages'] = array( 'href' => self::makeSpecialUrl( 'Specialpages' ) );
1158
1159 // default permalink to being off, will override it as required below.
1160 $nav_urls['permalink'] = false;
1161
1162 // A print stylesheet is attached to all pages, but nobody ever
1163 // figures that out. :) Add a link...
1164 if( $this->iscontent && ( $action == 'view' || $action == 'purge' ) ) {
1165 if ( !$out->isPrintable() ) {
1166 $nav_urls['print'] = array(
1167 'text' => wfMsg( 'printableversion' ),
1168 'href' => $this->getTitle()->getLocalURL( $wgRequest->appendQueryValue( 'printable', 'yes', true ) )
1169 );
1170 }
1171
1172 // Also add a "permalink" while we're at it
1173 if ( $this->mRevisionId ) {
1174 $nav_urls['permalink'] = array(
1175 'text' => wfMsg( 'permalink' ),
1176 'href' => $out->getTitle()->getLocalURL( "oldid=$this->mRevisionId" )
1177 );
1178 }
1179
1180 // Copy in case this undocumented, shady hook tries to mess with internals
1181 $revid = $this->mRevisionId;
1182 wfRunHooks( 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink', array( &$this, &$nav_urls, &$revid, &$revid ) );
1183 }
1184
1185 if( $this->getTitle()->getNamespace() != NS_SPECIAL ) {
1186 $wlhTitle = SpecialPage::getTitleFor( 'Whatlinkshere', $this->thispage );
1187 $nav_urls['whatlinkshere'] = array(
1188 'href' => $wlhTitle->getLocalUrl()
1189 );
1190 if( $this->getTitle()->getArticleId() ) {
1191 $rclTitle = SpecialPage::getTitleFor( 'Recentchangeslinked', $this->thispage );
1192 $nav_urls['recentchangeslinked'] = array(
1193 'href' => $rclTitle->getLocalUrl()
1194 );
1195 } else {
1196 $nav_urls['recentchangeslinked'] = false;
1197 }
1198 if( $wgUseTrackbacks )
1199 $nav_urls['trackbacklink'] = array(
1200 'href' => $out->getTitle()->trackbackURL()
1201 );
1202 }
1203
1204 $user = $this->getRelevantUser();
1205 if ( $user ) {
1206 $id = $user->getID();
1207 $ip = $user->isAnon();
1208 $rootUser = $user->getName();
1209 } else {
1210 $id = 0;
1211 $ip = false;
1212 $rootUser = null;
1213 }
1214
1215 if( $id || $ip ) { # both anons and non-anons have contribs list
1216 $nav_urls['contributions'] = array(
1217 'href' => self::makeSpecialUrlSubpage( 'Contributions', $rootUser )
1218 );
1219
1220 if( $id ) {
1221 $logPage = SpecialPage::getTitleFor( 'Log' );
1222 $nav_urls['log'] = array(
1223 'href' => $logPage->getLocalUrl(
1224 array(
1225 'user' => $rootUser
1226 )
1227 )
1228 );
1229 } else {
1230 $nav_urls['log'] = false;
1231 }
1232
1233 if ( $wgUser->isAllowed( 'block' ) ) {
1234 $nav_urls['blockip'] = array(
1235 'href' => self::makeSpecialUrlSubpage( 'Block', $rootUser )
1236 );
1237 } else {
1238 $nav_urls['blockip'] = false;
1239 }
1240 } else {
1241 $nav_urls['contributions'] = false;
1242 $nav_urls['log'] = false;
1243 $nav_urls['blockip'] = false;
1244 }
1245 $nav_urls['emailuser'] = false;
1246 if( $this->showEmailUser( $id ) ) {
1247 $nav_urls['emailuser'] = array(
1248 'href' => self::makeSpecialUrlSubpage( 'Emailuser', $rootUser )
1249 );
1250 }
1251 wfProfileOut( __METHOD__ );
1252 return $nav_urls;
1253 }
1254
1255 /**
1256 * Generate strings used for xml 'id' names
1257 * @return string
1258 * @private
1259 */
1260 function getNameSpaceKey() {
1261 return $this->getTitle()->getNamespaceKey();
1262 }
1263
1264 /**
1265 * @private
1266 * FIXME: why is this duplicated in/from OutputPage::getHeadScripts()??
1267 */
1268 function setupUserJs( $allowUserJs ) {
1269 global $wgRequest, $wgJsMimeType;
1270 wfProfileIn( __METHOD__ );
1271
1272 $action = $wgRequest->getVal( 'action', 'view' );
1273
1274 if( $allowUserJs && $this->loggedin ) {
1275 if( $this->getTitle()->isJsSubpage() and $this->userCanPreview( $action ) ) {
1276 # XXX: additional security check/prompt?
1277 $this->userjsprev = '/*<![CDATA[*/ ' . $wgRequest->getText( 'wpTextbox1' ) . ' /*]]>*/';
1278 } else {
1279 $this->userjs = self::makeUrl( $this->userpage . '/' . $this->skinname . '.js', 'action=raw&ctype=' . $wgJsMimeType );
1280 }
1281 }
1282 wfProfileOut( __METHOD__ );
1283 }
1284
1285 /**
1286 * Code for extensions to hook into to provide per-page CSS, see
1287 * extensions/PageCSS/PageCSS.php for an implementation of this.
1288 *
1289 * @private
1290 */
1291 function setupPageCss() {
1292 wfProfileIn( __METHOD__ );
1293 $out = false;
1294 wfRunHooks( 'SkinTemplateSetupPageCss', array( &$out ) );
1295 wfProfileOut( __METHOD__ );
1296 return $out;
1297 }
1298
1299 public function commonPrintStylesheet() {
1300 return false;
1301 }
1302 }
1303
1304 /**
1305 * Generic wrapper for template functions, with interface
1306 * compatible with what we use of PHPTAL 0.7.
1307 * @ingroup Skins
1308 */
1309 abstract class QuickTemplate {
1310 /**
1311 * Constructor
1312 */
1313 public function QuickTemplate() {
1314 $this->data = array();
1315 $this->translator = new MediaWiki_I18N();
1316 }
1317
1318 /**
1319 * Sets the value $value to $name
1320 * @param $name
1321 * @param $value
1322 */
1323 public function set( $name, $value ) {
1324 $this->data[$name] = $value;
1325 }
1326
1327 /**
1328 * @param $name
1329 * @param $value
1330 */
1331 public function setRef( $name, &$value ) {
1332 $this->data[$name] =& $value;
1333 }
1334
1335 /**
1336 * @param $t
1337 */
1338 public function setTranslator( &$t ) {
1339 $this->translator = &$t;
1340 }
1341
1342 /**
1343 * Main function, used by classes that subclass QuickTemplate
1344 * to show the actual HTML output
1345 */
1346 abstract public function execute();
1347
1348 /**
1349 * @private
1350 */
1351 function text( $str ) {
1352 echo htmlspecialchars( $this->data[$str] );
1353 }
1354
1355 /**
1356 * @private
1357 */
1358 function jstext( $str ) {
1359 echo Xml::escapeJsString( $this->data[$str] );
1360 }
1361
1362 /**
1363 * @private
1364 */
1365 function html( $str ) {
1366 echo $this->data[$str];
1367 }
1368
1369 /**
1370 * @private
1371 */
1372 function msg( $str ) {
1373 echo htmlspecialchars( $this->translator->translate( $str ) );
1374 }
1375
1376 /**
1377 * @private
1378 */
1379 function msgHtml( $str ) {
1380 echo $this->translator->translate( $str );
1381 }
1382
1383 /**
1384 * An ugly, ugly hack.
1385 * @private
1386 */
1387 function msgWiki( $str ) {
1388 global $wgParser, $wgOut;
1389
1390 $text = $this->translator->translate( $str );
1391 $parserOutput = $wgParser->parse( $text, $wgOut->getTitle(),
1392 $wgOut->parserOptions(), true );
1393 echo $parserOutput->getText();
1394 }
1395
1396 /**
1397 * @private
1398 */
1399 function haveData( $str ) {
1400 return isset( $this->data[$str] );
1401 }
1402
1403 /**
1404 * @private
1405 */
1406 function haveMsg( $str ) {
1407 $msg = $this->translator->translate( $str );
1408 return ( $msg != '-' ) && ( $msg != '' ); # ????
1409 }
1410
1411 /**
1412 * Get the Skin object related to this object
1413 *
1414 * @return Skin object
1415 */
1416 public function getSkin() {
1417 return $this->data['skin'];
1418 }
1419 }
1420
1421 /**
1422 * New base template for a skin's template extended from QuickTemplate
1423 * this class features helper methods that provide common ways of interacting
1424 * with the data stored in the QuickTemplate
1425 */
1426 abstract class BaseTemplate extends QuickTemplate {
1427
1428 /**
1429 * Create an array of common toolbox items from the data in the quicktemplate
1430 * stored by SkinTemplate.
1431 * The resulting array is built acording to a format intended to be passed
1432 * through makeListItem to generate the html.
1433 */
1434 function getToolbox() {
1435 wfProfileIn( __METHOD__ );
1436
1437 $toolbox = array();
1438 if ( $this->data['notspecialpage'] ) {
1439 $toolbox['whatlinkshere'] = $this->data['nav_urls']['whatlinkshere'];
1440 $toolbox['whatlinkshere']['id'] = 't-whatlinkshere';
1441 if ( $this->data['nav_urls']['recentchangeslinked'] ) {
1442 $toolbox['recentchangeslinked'] = $this->data['nav_urls']['recentchangeslinked'];
1443 $toolbox['recentchangeslinked']['msg'] = 'recentchangeslinked-toolbox';
1444 $toolbox['recentchangeslinked']['id'] = 't-recentchangeslinked';
1445 }
1446 }
1447 if( isset( $this->data['nav_urls']['trackbacklink'] ) && $this->data['nav_urls']['trackbacklink'] ) {
1448 $toolbox['trackbacklink'] = $this->data['nav_urls']['trackbacklink'];
1449 $toolbox['trackbacklink']['id'] = 't-trackbacklink';
1450 }
1451 if ( $this->data['feeds'] ) {
1452 $toolbox['feeds']['id'] = 'feedlinks';
1453 $toolbox['feeds']['links'] = array();
1454 foreach ( $this->data['feeds'] as $key => $feed ) {
1455 $toolbox['feeds']['links'][$key] = $feed;
1456 $toolbox['feeds']['links'][$key]['id'] = "feed-$key";
1457 $toolbox['feeds']['links'][$key]['rel'] = 'alternate';
1458 $toolbox['feeds']['links'][$key]['type'] = "application/{$key}+xml";
1459 $toolbox['feeds']['links'][$key]['class'] = 'feedlink';
1460 }
1461 }
1462 foreach ( array( 'contributions', 'log', 'blockip', 'emailuser', 'upload', 'specialpages' ) as $special ) {
1463 if ( $this->data['nav_urls'][$special] ) {
1464 $toolbox[$special] = $this->data['nav_urls'][$special];
1465 $toolbox[$special]['id'] = "t-$special";
1466 }
1467 }
1468 if ( !empty( $this->data['nav_urls']['print']['href'] ) ) {
1469 $toolbox['print'] = $this->data['nav_urls']['print'];
1470 $toolbox['print']['rel'] = 'alternate';
1471 $toolbox['print']['msg'] = 'printableversion';
1472 }
1473 if( $this->data['nav_urls']['permalink'] ) {
1474 $toolbox['permalink'] = $this->data['nav_urls']['permalink'];
1475 if( $toolbox['permalink']['href'] === '' ) {
1476 unset( $toolbox['permalink']['href'] );
1477 $toolbox['ispermalink']['tooltiponly'] = true;
1478 $toolbox['ispermalink']['id'] = 't-ispermalink';
1479 $toolbox['ispermalink']['msg'] = 'permalink';
1480 } else {
1481 $toolbox['permalink']['id'] = 't-permalink';
1482 }
1483 }
1484 wfRunHooks( 'BaseTemplateToolbox', array( &$this, &$toolbox ) );
1485 wfProfileOut( __METHOD__ );
1486 return $toolbox;
1487 }
1488
1489 /**
1490 * Create an array of personal tools items from the data in the quicktemplate
1491 * stored by SkinTemplate.
1492 * The resulting array is built acording to a format intended to be passed
1493 * through makeListItem to generate the html.
1494 * This is in reality the same list as already stored in personal_urls
1495 * however it is reformatted so that you can just pass the individual items
1496 * to makeListItem instead of hardcoding the element creation boilerplate.
1497 */
1498 function getPersonalTools() {
1499 $personal_tools = array();
1500 foreach( $this->data['personal_urls'] as $key => $ptool ) {
1501 # The class on a personal_urls item is meant to go on the <a> instead
1502 # of the <li> so we have to use a single item "links" array instead
1503 # of using most of the personal_url's keys directly
1504 $personal_tools[$key] = array();
1505 $personal_tools[$key]["links"][] = array();
1506 $personal_tools[$key]["links"][0]["single-id"] = $personal_tools[$key]["id"] = "pt-$key";
1507 if ( isset($ptool["active"]) ) {
1508 $personal_tools[$key]["active"] = $ptool["active"];
1509 }
1510 foreach ( array("href", "class", "text") as $k ) {
1511 if ( isset($ptool[$k]) )
1512 $personal_tools[$key]["links"][0][$k] = $ptool[$k];
1513 }
1514 }
1515 return $personal_tools;
1516 }
1517
1518 /**
1519 * Makes a link, usually used by makeListItem to generate a link for an item
1520 * in a list used in navigation lists, portlets, portals, sidebars, etc...
1521 *
1522 * $key is a string, usually a key from the list you are generating this link from
1523 * $item is an array containing some of a specific set of keys.
1524 * The text of the link will be generated either from the contents of the "text"
1525 * key in the $item array, if a "msg" key is present a message by that name will
1526 * be used, and if neither of those are set the $key will be used as a message name.
1527 * If a "href" key is not present makeLink will just output htmlescaped text.
1528 * The href, id, class, rel, and type keys are used as attributes for the link if present.
1529 * If an "id" or "single-id" (if you don't want the actual id to be output on the link)
1530 * is present it will be used to generate a tooltip and accesskey for the link.
1531 * If you don't want an accesskey, set $item['tooltiponly'] = true;
1532 */
1533 function makeLink( $key, $item ) {
1534 if ( isset( $item['text'] ) ) {
1535 $text = $item['text'];
1536 } else {
1537 $text = $this->translator->translate( isset( $item['msg'] ) ? $item['msg'] : $key );
1538 }
1539
1540 if ( !isset( $item['href'] ) ) {
1541 return htmlspecialchars( $text );
1542 }
1543
1544 $attrs = array();
1545 foreach ( array( 'href', 'id', 'class', 'rel', 'type' ) as $attr ) {
1546 if ( isset( $item[$attr] ) ) {
1547 $attrs[$attr] = $item[$attr];
1548 }
1549 }
1550
1551 if ( isset( $item['id'] ) ) {
1552 $item['single-id'] = $item['id'];
1553 }
1554 if ( isset( $item['single-id'] ) ) {
1555 if ( isset( $item['tooltiponly'] ) && $item['tooltiponly'] ) {
1556 $attrs['title'] = $this->skin->titleAttrib( $item['single-id'] );
1557 if ( $attrs['title'] === false ) {
1558 unset( $attrs['title'] );
1559 }
1560 } else {
1561 $attrs = array_merge(
1562 $attrs,
1563 $this->skin->tooltipAndAccesskeyAttribs( $item['single-id'] )
1564 );
1565 }
1566 }
1567
1568 return Html::element( 'a', $attrs, $text );
1569 }
1570
1571 /**
1572 * Generates a list item for a navigation, portlet, portal, sidebar... etc list
1573 * $key is a string, usually a key from the list you are generating this link from
1574 * $item is an array of list item data containing some of a specific set of keys.
1575 * The "id" and "class" keys will be used as attributes for the list item,
1576 * if "active" contains a value of true a "active" class will also be appended to class.
1577 * If you want something other than a <li> you can pass a tag name such as
1578 * "tag" => "span" in the $options array to change the tag used.
1579 * link/content data for the list item may come in one of two forms
1580 * A "links" key may be used, in which case it should contain an array with
1581 * a list of links to include inside the list item, see makeLink for the format
1582 * of individual links array items.
1583 * Otherwise the relevant keys from the list item $item array will be passed
1584 * to makeLink instead. Note however that "id" and "class" are used by the
1585 * list item directly so they will not be passed to makeLink
1586 * (however the link will still support a tooltip and accesskey from it)
1587 * If you need an id or class on a single link you should include a "links"
1588 * array with just one link item inside of it.
1589 */
1590 function makeListItem( $key, $item, $options = array() ) {
1591 if ( isset( $item['links'] ) ) {
1592 $html = '';
1593 foreach ( $item['links'] as $linkKey => $link ) {
1594 $html .= $this->makeLink( $linkKey, $link );
1595 }
1596 } else {
1597 $link = array();
1598 foreach ( array( 'text', 'msg', 'href', 'rel', 'type', 'tooltiponly' ) as $k ) {
1599 if ( isset( $item[$k] ) ) {
1600 $link[$k] = $item[$k];
1601 }
1602 }
1603 if ( isset( $item['id'] ) ) {
1604 // The id goes on the <li> not on the <a> for single links
1605 // but makeSidebarLink still needs to know what id to use when
1606 // generating tooltips and accesskeys.
1607 $link['single-id'] = $item['id'];
1608 }
1609 $html = $this->makeLink( $key, $link );
1610 }
1611
1612 $attrs = array();
1613 foreach ( array( 'id', 'class' ) as $attr ) {
1614 if ( isset( $item[$attr] ) ) {
1615 $attrs[$attr] = $item[$attr];
1616 }
1617 }
1618 if ( isset( $item['active'] ) && $item['active'] ) {
1619 if ( !isset( $attrs['class'] ) ) {
1620 $attrs['class'] = '';
1621 }
1622 $attrs['class'] .= ' active';
1623 $attrs['class'] = trim( $attrs['class'] );
1624 }
1625 return Html::rawElement( isset( $options['tag'] ) ? $options['tag'] : 'li', $attrs, $html );
1626 }
1627
1628 function makeSearchInput( $attrs = array() ) {
1629 $realAttrs = array(
1630 'type' => 'search',
1631 'name' => 'search',
1632 'value' => isset( $this->data['search'] ) ? $this->data['search'] : '',
1633 );
1634 $realAttrs = array_merge( $realAttrs, $this->skin->tooltipAndAccesskeyAttribs( 'search' ), $attrs );
1635 return Html::element( 'input', $realAttrs );
1636 }
1637
1638 function makeSearchButton( $mode, $attrs = array() ) {
1639 switch( $mode ) {
1640 case 'go':
1641 case 'fulltext':
1642 $realAttrs = array(
1643 'type' => 'submit',
1644 'name' => $mode,
1645 'value' => $this->translator->translate( $mode == 'go' ? 'searcharticle' : 'searchbutton' ),
1646 );
1647 $realAttrs = array_merge(
1648 $realAttrs,
1649 $this->skin->tooltipAndAccesskeyAttribs( "search-$mode" ),
1650 $attrs
1651 );
1652 return Html::element( 'input', $realAttrs );
1653 case 'image':
1654 $buttonAttrs = array(
1655 'type' => 'submit',
1656 'name' => 'button',
1657 );
1658 $buttonAttrs = array_merge(
1659 $buttonAttrs,
1660 $this->skin->tooltipAndAccesskeyAttribs( 'search-fulltext' ),
1661 $attrs
1662 );
1663 unset( $buttonAttrs['src'] );
1664 unset( $buttonAttrs['alt'] );
1665 $imgAttrs = array(
1666 'src' => $attrs['src'],
1667 'alt' => isset( $attrs['alt'] ) ? $attrs['alt'] : $this->translator->translate( 'searchbutton' ),
1668 );
1669 return Html::rawElement( 'button', $buttonAttrs, Html::element( 'img', $imgAttrs ) );
1670 default:
1671 throw new MWException( 'Unknown mode passed to BaseTemplate::makeSearchButton' );
1672 }
1673 }
1674
1675 /**
1676 * Returns an array of footerlinks trimmed down to only those footer links that
1677 * are valid.
1678 * If you pass "flat" as an option then the returned array will be a flat array
1679 * of footer icons instead of a key/value array of footerlinks arrays broken
1680 * up into categories.
1681 */
1682 function getFooterLinks( $option = null ) {
1683 $footerlinks = $this->data['footerlinks'];
1684
1685 // Reduce footer links down to only those which are being used
1686 $validFooterLinks = array();
1687 foreach( $footerlinks as $category => $links ) {
1688 $validFooterLinks[$category] = array();
1689 foreach( $links as $link ) {
1690 if( isset( $this->data[$link] ) && $this->data[$link] ) {
1691 $validFooterLinks[$category][] = $link;
1692 }
1693 }
1694 if ( count( $validFooterLinks[$category] ) <= 0 ) {
1695 unset( $validFooterLinks[$category] );
1696 }
1697 }
1698
1699 if ( $option == 'flat' ) {
1700 // fold footerlinks into a single array using a bit of trickery
1701 $validFooterLinks = call_user_func_array(
1702 'array_merge',
1703 array_values( $validFooterLinks )
1704 );
1705 }
1706
1707 return $validFooterLinks;
1708 }
1709
1710 /**
1711 * Returns an array of footer icons filtered down by options relevant to how
1712 * the skin wishes to display them.
1713 * If you pass "icononly" as the option all footer icons which do not have an
1714 * image icon set will be filtered out.
1715 * If you pass "nocopyright" then MediaWiki's copyright icon will not be included
1716 * in the list of footer icons. This is mostly useful for skins which only
1717 * display the text from footericons instead of the images and don't want a
1718 * duplicate copyright statement because footerlinks already rendered one.
1719 */
1720 function getFooterIcons( $option = null ) {
1721 // Generate additional footer icons
1722 $footericons = $this->data['footericons'];
1723
1724 if ( $option == 'icononly' ) {
1725 // Unset any icons which don't have an image
1726 foreach ( $footericons as &$footerIconsBlock ) {
1727 foreach ( $footerIconsBlock as $footerIconKey => $footerIcon ) {
1728 if ( !is_string( $footerIcon ) && !isset( $footerIcon['src'] ) ) {
1729 unset( $footerIconsBlock[$footerIconKey] );
1730 }
1731 }
1732 }
1733 // Redo removal of any empty blocks
1734 foreach ( $footericons as $footerIconsKey => &$footerIconsBlock ) {
1735 if ( count( $footerIconsBlock ) <= 0 ) {
1736 unset( $footericons[$footerIconsKey] );
1737 }
1738 }
1739 } elseif ( $option == 'nocopyright' ) {
1740 unset( $footericons['copyright']['copyright'] );
1741 if ( count( $footericons['copyright'] ) <= 0 ) {
1742 unset( $footericons['copyright'] );
1743 }
1744 }
1745
1746 return $footericons;
1747 }
1748
1749 /**
1750 * Output the basic end-page trail including bottomscripts, reporttime, and
1751 * debug stuff. This should be called right before outputting the closing
1752 * body and html tags.
1753 */
1754 function printTrail() { ?>
1755 <?php $this->html('bottomscripts'); /* JS call to runBodyOnloadHook */ ?>
1756 <?php $this->html('reporttime') ?>
1757 <?php if ( $this->data['debug'] ): ?>
1758 <!-- Debug output:
1759 <?php $this->text( 'debug' ); ?>
1760
1761 -->
1762 <?php endif;
1763 }
1764
1765 }
1766