skins/Vector.php

   1 <?php
   2 /**
   3  * Vector - Modern version of MonoBook with fresh look and many usability
   4  * improvements.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19  * http://www.gnu.org/copyleft/gpl.html
  20  *
  21  * @todo document
  22  * @file
  23  * @ingroup Skins
  24  */
  25
  26 if ( !defined( 'MEDIAWIKI' ) ) {
  27         die( -1 );
  28 }
  29
  30 /**
  31  * SkinTemplate class for Vector skin
  32  * @ingroup Skins
  33  */
  34 class SkinVector extends SkinTemplate {
  35
  36         protected static $bodyClasses = array( 'vector-animateLayout' );
  37
  38         var $skinname = 'vector', $stylename = 'vector',
  39                 $template = 'VectorTemplate', $useHeadElement = true;
  40
  41         /**
  42          * Initializes output page and sets up skin-specific parameters
  43          * @param $out OutputPage object to initialize
  44          */
  45         public function initPage( OutputPage $out ) {
  46                 global $wgLocalStylePath;
  47
  48                 parent::initPage( $out );
  49
  50                 // Append CSS which includes IE only behavior fixes for hover support -
  51                 // this is better than including this in a CSS fille since it doesn't
  52                 // wait for the CSS file to load before fetching the HTC file.
  53                 $min = $this->getRequest()->getFuzzyBool( 'debug' ) ? '' : '.min';
  54                 $out->addHeadItem( 'csshover',
  55                         '<!--[if lt IE 7]><style type="text/css">body{behavior:url("' .
  56                                 htmlspecialchars( $wgLocalStylePath ) .
  57                                 "/{$this->stylename}/csshover{$min}.htc\")}</style><![endif]-->"
  58                 );
  59
  60                 $out->addModules( 'skins.vector.js' );
  61         }
  62
  63         /**
  64          * Load skin and user CSS files in the correct order
  65          * fixes bug 22916
  66          * @param $out OutputPage object
  67          */
  68         function setupSkinUserCss( OutputPage $out ) {
  69                 parent::setupSkinUserCss( $out );
  70                 $out->addModuleStyles( 'skins.vector' );
  71         }
  72
  73         /**
  74          * Adds classes to the body element.
  75          *
  76          * @param $out OutputPage object
  77          * @param &$bodyAttrs Array of attributes that will be set on the body element
  78          */
  79         function addToBodyAttributes( $out, &$bodyAttrs ) {
  80                 if ( isset( $bodyAttrs['class'] ) && strlen( $bodyAttrs['class'] ) > 0 ) {
  81                         $bodyAttrs['class'] .= ' ' . implode( ' ', static::$bodyClasses );
  82                 } else {
  83                         $bodyAttrs['class'] = implode( ' ', static::$bodyClasses );
  84                 }
  85         }
  86 }
  87
  88 /**
  89  * QuickTemplate class for Vector skin
  90  * @ingroup Skins
  91  */
  92 class VectorTemplate extends BaseTemplate {
  93
  94         /* Functions */
  95
  96         /**
  97          * Outputs the entire contents of the (X)HTML page
  98          */
  99         public function execute() {
 100                 global $wgVectorUseIconWatch;
 101
 102                 // Build additional attributes for navigation urls
 103                 $nav = $this->data['content_navigation'];
 104
 105                 if ( $wgVectorUseIconWatch ) {
 106                         $mode = $this->getSkin()->getUser()->isWatched( $this->getSkin()->getRelevantTitle() ) ? 'unwatch' : 'watch';
 107                         if ( isset( $nav['actions'][$mode] ) ) {
 108                                 $nav['views'][$mode] = $nav['actions'][$mode];
 109                                 $nav['views'][$mode]['class'] = rtrim( 'icon ' . $nav['views'][$mode]['class'], ' ' );
 110                                 $nav['views'][$mode]['primary'] = true;
 111                                 unset( $nav['actions'][$mode] );
 112                         }
 113                 }
 114
 115                 $xmlID = '';
 116                 foreach ( $nav as $section => $links ) {
 117                         foreach ( $links as $key => $link ) {
 118                                 if ( $section == 'views' && !( isset( $link['primary'] ) && $link['primary'] ) ) {
 119                                         $link['class'] = rtrim( 'collapsible ' . $link['class'], ' ' );
 120                                 }
 121
 122                                 $xmlID = isset( $link['id'] ) ? $link['id'] : 'ca-' . $xmlID;
 123                                 $nav[$section][$key]['attributes'] =
 124                                         ' id="' . Sanitizer::escapeId( $xmlID ) . '"';
 125                                 if ( $link['class'] ) {
 126                                         $nav[$section][$key]['attributes'] .=
 127                                                 ' class="' . htmlspecialchars( $link['class'] ) . '"';
 128                                         unset( $nav[$section][$key]['class'] );
 129                                 }
 130                                 if ( isset( $link['tooltiponly'] ) && $link['tooltiponly'] ) {
 131                                         $nav[$section][$key]['key'] =
 132                                                 Linker::tooltip( $xmlID );
 133                                 } else {
 134                                         $nav[$section][$key]['key'] =
 135                                                 Xml::expandAttributes( Linker::tooltipAndAccesskeyAttribs( $xmlID ) );
 136                                 }
 137                         }
 138                 }
 139                 $this->data['namespace_urls'] = $nav['namespaces'];
 140                 $this->data['view_urls'] = $nav['views'];
 141                 $this->data['action_urls'] = $nav['actions'];
 142                 $this->data['variant_urls'] = $nav['variants'];
 143
 144                 // Reverse horizontally rendered navigation elements
 145                 if ( $this->data['rtl'] ) {
 146                         $this->data['view_urls'] =
 147                                 array_reverse( $this->data['view_urls'] );
 148                         $this->data['namespace_urls'] =
 149                                 array_reverse( $this->data['namespace_urls'] );
 150                         $this->data['personal_urls'] =
 151                                 array_reverse( $this->data['personal_urls'] );
 152                 }
 153                 // Output HTML Page
 154                 $this->html( 'headelement' );
 155 ?>
 156                 <div id="mw-page-base" class="noprint"></div>
 157                 <div id="mw-head-base" class="noprint"></div>
 158                 <!-- content -->
 159                 <div id="content" class="mw-body" role="main">
 160                         <a id="top"></a>
 161                         <div id="mw-js-message" style="display:none;"<?php $this->html( 'userlangattributes' ) ?>></div>
 162                         <?php if ( $this->data['sitenotice'] ) { ?>
 163                         <!-- sitenotice -->
 164                         <div id="siteNotice"><?php $this->html( 'sitenotice' ) ?></div>
 165                         <!-- /sitenotice -->
 166                         <?php } ?>
 167                         <!-- firstHeading -->
 168                         <h1 id="firstHeading" class="firstHeading" lang="<?php
 169                                 $this->data['pageLanguage'] = $this->getSkin()->getTitle()->getPageViewLanguage()->getCode();
 170                                 $this->html( 'pageLanguage' );
 171                         ?>"><span dir="auto"><?php $this->html( 'title' ) ?></span></h1>
 172                         <!-- /firstHeading -->
 173                         <!-- bodyContent -->
 174                         <div id="bodyContent">
 175                                 <?php if ( $this->data['isarticle'] ) { ?>
 176                                 <!-- tagline -->
 177                                 <div id="siteSub"><?php $this->msg( 'tagline' ) ?></div>
 178                                 <!-- /tagline -->
 179                                 <?php } ?>
 180                                 <!-- subtitle -->
 181                                 <div id="contentSub"<?php $this->html( 'userlangattributes' ) ?>><?php $this->html( 'subtitle' ) ?></div>
 182                                 <!-- /subtitle -->
 183                                 <?php if ( $this->data['undelete'] ) { ?>
 184                                 <!-- undelete -->
 185                                 <div id="contentSub2"><?php $this->html( 'undelete' ) ?></div>
 186                                 <!-- /undelete -->
 187                                 <?php } ?>
 188                                 <?php if ( $this->data['newtalk'] ) { ?>
 189                                 <!-- newtalk -->
 190                                 <div class="usermessage"><?php $this->html( 'newtalk' )  ?></div>
 191                                 <!-- /newtalk -->
 192                                 <?php } ?>
 193                                 <?php if ( $this->data['showjumplinks'] ) { ?>
 194                                 <!-- jumpto -->
 195                                 <div id="jump-to-nav" class="mw-jump">
 196                                         <?php $this->msg( 'jumpto' ) ?>
 197                                         <a href="#mw-navigation"><?php $this->msg( 'jumptonavigation' ) ?></a><?php $this->msg( 'comma-separator' ) ?>
 198                                         <a href="#p-search"><?php $this->msg( 'jumptosearch' ) ?></a>
 199                                 </div>
 200                                 <!-- /jumpto -->
 201                                 <?php } ?>
 202                                 <!-- bodycontent -->
 203                                 <?php $this->html( 'bodycontent' ) ?>
 204                                 <!-- /bodycontent -->
 205                                 <?php if ( $this->data['printfooter'] ) { ?>
 206                                 <!-- printfooter -->
 207                                 <div class="printfooter">
 208                                 <?php $this->html( 'printfooter' ); ?>
 209                                 </div>
 210                                 <!-- /printfooter -->
 211                                 <?php } ?>
 212                                 <?php if ( $this->data['catlinks'] ) { ?>
 213                                 <!-- catlinks -->
 214                                 <?php $this->html( 'catlinks' ); ?>
 215                                 <!-- /catlinks -->
 216                                 <?php } ?>
 217                                 <?php if ( $this->data['dataAfterContent'] ) { ?>
 218                                 <!-- dataAfterContent -->
 219                                 <?php $this->html( 'dataAfterContent' ); ?>
 220                                 <!-- /dataAfterContent -->
 221                                 <?php } ?>
 222                                 <div class="visualClear"></div>
 223                                 <!-- debughtml -->
 224                                 <?php $this->html( 'debughtml' ); ?>
 225                                 <!-- /debughtml -->
 226                         </div>
 227                         <!-- /bodyContent -->
 228                 </div>
 229                 <!-- /content -->
 230                 <div id="mw-navigation">
 231                         <h2><?php $this->msg( 'navigation-heading' ) ?></h2>
 232                         <!-- header -->
 233                         <div id="mw-head">
 234                                 <?php $this->renderNavigation( 'PERSONAL' ); ?>
 235                                 <div id="left-navigation">
 236                                         <?php $this->renderNavigation( array( 'NAMESPACES', 'VARIANTS' ) ); ?>
 237                                 </div>
 238                                 <div id="right-navigation">
 239                                         <?php $this->renderNavigation( array( 'VIEWS', 'ACTIONS', 'SEARCH' ) ); ?>
 240                                 </div>
 241                         </div>
 242                         <!-- /header -->
 243                         <!-- panel -->
 244                         <div id="mw-panel">
 245                                 <!-- logo -->
 246                                         <div id="p-logo" role="banner"><a style="background-image: url(<?php $this->text( 'logopath' ) ?>);" href="<?php echo htmlspecialchars( $this->data['nav_urls']['mainpage']['href'] ) ?>" <?php echo Xml::expandAttributes( Linker::tooltipAndAccesskeyAttribs( 'p-logo' ) ) ?>></a></div>
 247                                 <!-- /logo -->
 248                                 <?php $this->renderPortals( $this->data['sidebar'] ); ?>
 249                         </div>
 250                         <!-- /panel -->
 251                 </div>
 252                 <!-- footer -->
 253                 <div id="footer" role="contentinfo"<?php $this->html( 'userlangattributes' ) ?>>
 254                         <?php foreach ( $this->getFooterLinks() as $category => $links ) { ?>
 255                                 <ul id="footer-<?php echo $category ?>">
 256                                         <?php foreach ( $links as $link ) { ?>
 257                                                 <li id="footer-<?php echo $category ?>-<?php echo $link ?>"><?php $this->html( $link ) ?></li>
 258                                         <?php } ?>
 259                                 </ul>
 260                         <?php } ?>
 261                         <?php $footericons = $this->getFooterIcons( "icononly" );
 262                         if ( count( $footericons ) > 0 ) { ?>
 263                                 <ul id="footer-icons" class="noprint">
 264 <?php                   foreach ( $footericons as $blockName => $footerIcons ) { ?>
 265                                         <li id="footer-<?php echo htmlspecialchars( $blockName ); ?>ico">
 266 <?php                           foreach ( $footerIcons as $icon ) { ?>
 267                                                 <?php echo $this->getSkin()->makeFooterIcon( $icon ); ?>
 268
 269 <?php                           } ?>
 270                                         </li>
 271 <?php                   } ?>
 272                                 </ul>
 273                         <?php } ?>
 274                         <div style="clear:both"></div>
 275                 </div>
 276                 <!-- /footer -->
 277                 <?php $this->printTrail(); ?>
 278
 279         </body>
 280 </html>
 281 <?php
 282         }
 283
 284         /**
 285          * Render a series of portals
 286          *
 287          * @param $portals array
 288          */
 289         protected function renderPortals( $portals ) {
 290                 // Force the rendering of the following portals
 291                 if ( !isset( $portals['SEARCH'] ) ) {
 292                         $portals['SEARCH'] = true;
 293                 }
 294                 if ( !isset( $portals['TOOLBOX'] ) ) {
 295                         $portals['TOOLBOX'] = true;
 296                 }
 297                 if ( !isset( $portals['LANGUAGES'] ) ) {
 298                         $portals['LANGUAGES'] = true;
 299                 }
 300                 // Render portals
 301                 foreach ( $portals as $name => $content ) {
 302                         if ( $content === false ) {
 303                                 continue;
 304                         }
 305
 306                         echo "\n<!-- {$name} -->\n";
 307                         switch( $name ) {
 308                                 case 'SEARCH':
 309                                         break;
 310                                 case 'TOOLBOX':
 311                                         $this->renderPortal( 'tb', $this->getToolbox(), 'toolbox', 'SkinTemplateToolboxEnd' );
 312                                         break;
 313                                 case 'LANGUAGES':
 314                                         if ( $this->data['language_urls'] ) {
 315                                                 $this->renderPortal( 'lang', $this->data['language_urls'], 'otherlanguages' );
 316                                         }
 317                                         break;
 318                                 default:
 319                                         $this->renderPortal( $name, $content );
 320                                 break;
 321                         }
 322                         echo "\n<!-- /{$name} -->\n";
 323                 }
 324         }
 325
 326         /**
 327          * @param $name string
 328          * @param $content array
 329          * @param $msg null|string
 330          * @param $hook null|string|array
 331          */
 332         protected function renderPortal( $name, $content, $msg = null, $hook = null ) {
 333                 if ( $msg === null ) {
 334                         $msg = $name;
 335                 }
 336                 ?>
 337 <div class="portal" role="navigation" id='<?php echo Sanitizer::escapeId( "p-$name" ) ?>'<?php echo Linker::tooltip( 'p-' . $name ) ?>>
 338         <h3<?php $this->html( 'userlangattributes' ) ?>><?php $msgObj = wfMessage( $msg ); echo htmlspecialchars( $msgObj->exists() ? $msgObj->text() : $msg ); ?></h3>
 339         <div class="body">
 340 <?php
 341                 if ( is_array( $content ) ) { ?>
 342                 <ul>
 343 <?php
 344                         foreach ( $content as $key => $val ) { ?>
 345                         <?php echo $this->makeListItem( $key, $val ); ?>
 346
 347 <?php
 348                         }
 349                         if ( $hook !== null ) {
 350                                 wfRunHooks( $hook, array( &$this, true ) );
 351                         }
 352                         ?>
 353                 </ul>
 354 <?php
 355                 } else { ?>
 356                 <?php echo $content; /* Allow raw HTML block to be defined by extensions */ ?>
 357 <?php
 358                 } ?>
 359         </div>
 360 </div>
 361 <?php
 362         }
 363
 364         /**
 365          * Render one or more navigations elements by name, automatically reveresed
 366          * when UI is in RTL mode
 367          *
 368          * @param $elements array
 369          */
 370         protected function renderNavigation( $elements ) {
 371                 global $wgVectorUseSimpleSearch;
 372
 373                 // If only one element was given, wrap it in an array, allowing more
 374                 // flexible arguments
 375                 if ( !is_array( $elements ) ) {
 376                         $elements = array( $elements );
 377                 // If there's a series of elements, reverse them when in RTL mode
 378                 } elseif ( $this->data['rtl'] ) {
 379                         $elements = array_reverse( $elements );
 380                 }
 381                 // Render elements
 382                 foreach ( $elements as $name => $element ) {
 383                         echo "\n<!-- {$name} -->\n";
 384                         switch( $element ) {
 385                                 case 'NAMESPACES':
 386 ?>
 387 <div id="p-namespaces" role="navigation" class="vectorTabs<?php if ( count( $this->data['namespace_urls'] ) == 0 ) { echo ' emptyPortlet'; } ?>">
 388         <h3><?php $this->msg( 'namespaces' ) ?></h3>
 389         <ul<?php $this->html( 'userlangattributes' ) ?>>
 390                 <?php foreach ( $this->data['namespace_urls'] as $link ) { ?>
 391                         <li <?php echo $link['attributes'] ?>><span><a href="<?php echo htmlspecialchars( $link['href'] ) ?>" <?php echo $link['key'] ?>><?php echo htmlspecialchars( $link['text'] ) ?></a></span></li>
 392                 <?php } ?>
 393         </ul>
 394 </div>
 395 <?php
 396                                 break;
 397                                 case 'VARIANTS':
 398 ?>
 399 <div id="p-variants" role="navigation" class="vectorMenu<?php if ( count( $this->data['variant_urls'] ) == 0 ) { echo ' emptyPortlet'; } ?>">
 400         <h3 id="mw-vector-current-variant">
 401         <?php foreach ( $this->data['variant_urls'] as $link ) { ?>
 402                 <?php if ( stripos( $link['attributes'], 'selected' ) !== false ) { ?>
 403                         <?php echo htmlspecialchars( $link['text'] ) ?>
 404                 <?php } ?>
 405         <?php } ?>
 406         </h3>
 407         <h3><span><?php $this->msg( 'variants' ) ?></span><a href="#"></a></h3>
 408         <div class="menu">
 409                 <ul>
 410                         <?php foreach ( $this->data['variant_urls'] as $link ) { ?>
 411                                 <li<?php echo $link['attributes'] ?>><a href="<?php echo htmlspecialchars( $link['href'] ) ?>" lang="<?php echo htmlspecialchars( $link['lang'] ) ?>" hreflang="<?php echo htmlspecialchars( $link['hreflang'] ) ?>" <?php echo $link['key'] ?>><?php echo htmlspecialchars( $link['text'] ) ?></a></li>
 412                         <?php } ?>
 413                 </ul>
 414         </div>
 415 </div>
 416 <?php
 417                                 break;
 418                                 case 'VIEWS':
 419 ?>
 420 <div id="p-views" role="navigation" class="vectorTabs<?php if ( count( $this->data['view_urls'] ) == 0 ) { echo ' emptyPortlet'; } ?>">
 421         <h3><?php $this->msg( 'views' ) ?></h3>
 422         <ul<?php $this->html( 'userlangattributes' ) ?>>
 423                 <?php foreach ( $this->data['view_urls'] as $link ) { ?>
 424                         <li<?php echo $link['attributes'] ?>><span><a href="<?php echo htmlspecialchars( $link['href'] ) ?>" <?php echo $link['key'] ?>><?php
 425                                 // $link['text'] can be undefined - bug 27764
 426                                 if ( array_key_exists( 'text', $link ) ) {
 427                                         echo array_key_exists( 'img', $link ) ? '<img src="' . $link['img'] . '" alt="' . $link['text'] . '" />' : htmlspecialchars( $link['text'] );
 428                                 }
 429                                 ?></a></span></li>
 430                 <?php } ?>
 431         </ul>
 432 </div>
 433 <?php
 434                                 break;
 435                                 case 'ACTIONS':
 436 ?>
 437 <div id="p-cactions" role="navigation" class="vectorMenu<?php if ( count( $this->data['action_urls'] ) == 0 ) { echo ' emptyPortlet'; } ?>">
 438         <h3><span><?php $this->msg( 'actions' ) ?></span><a href="#"></a></h3>
 439         <div class="menu">
 440                 <ul<?php $this->html( 'userlangattributes' ) ?>>
 441                         <?php foreach ( $this->data['action_urls'] as $link ) { ?>
 442                                 <li<?php echo $link['attributes'] ?>><a href="<?php echo htmlspecialchars( $link['href'] ) ?>" <?php echo $link['key'] ?>><?php echo htmlspecialchars( $link['text'] ) ?></a></li>
 443                         <?php } ?>
 444                 </ul>
 445         </div>
 446 </div>
 447 <?php
 448                                 break;
 449                                 case 'PERSONAL':
 450 ?>
 451 <div id="p-personal" role="navigation" class="<?php if ( count( $this->data['personal_urls'] ) == 0 ) { echo ' emptyPortlet'; } ?>">
 452         <h3><?php $this->msg( 'personaltools' ) ?></h3>
 453         <ul<?php $this->html( 'userlangattributes' ) ?>>
 454 <?php
 455                                         $personalTools = $this->getPersonalTools();
 456                                         foreach ( $personalTools as $key => $item ) {
 457                                                 echo $this->makeListItem( $key, $item );
 458                                         }
 459 ?>
 460         </ul>
 461 </div>
 462 <?php
 463                                 break;
 464                                 case 'SEARCH':
 465 ?>
 466 <div id="p-search" role="search">
 467         <h3<?php $this->html( 'userlangattributes' ) ?>><label for="searchInput"><?php $this->msg( 'search' ) ?></label></h3>
 468         <form action="<?php $this->text( 'wgScript' ) ?>" id="searchform">
 469                 <?php if ( $wgVectorUseSimpleSearch && $this->getSkin()->getUser()->getOption( 'vector-simplesearch' ) ) { ?>
 470                 <div id="simpleSearch">
 471                         <?php if ( $this->data['rtl'] ) { ?>
 472                         <?php echo $this->makeSearchButton( 'image', array( 'id' => 'searchButton', 'src' => $this->getSkin()->getSkinStylePath( 'images/search-rtl.png' ), 'width' => '12', 'height' => '13' ) ); ?>
 473                         <?php } ?>
 474                         <?php echo $this->makeSearchInput( array( 'id' => 'searchInput', 'type' => 'text' ) ); ?>
 475                         <?php if ( !$this->data['rtl'] ) { ?>
 476                         <?php echo $this->makeSearchButton( 'image', array( 'id' => 'searchButton', 'src' => $this->getSkin()->getSkinStylePath( 'images/search-ltr.png' ), 'width' => '12', 'height' => '13' ) ); ?>
 477                         <?php } ?>
 478                 <?php } else { ?>
 479                 <div>
 480                         <?php echo $this->makeSearchInput( array( 'id' => 'searchInput' ) ); ?>
 481                         <?php echo $this->makeSearchButton( 'go', array( 'id' => 'searchGoButton', 'class' => 'searchButton' ) ); ?>
 482                         <?php echo $this->makeSearchButton( 'fulltext', array( 'id' => 'mw-searchButton', 'class' => 'searchButton' ) ); ?>
 483                 <?php } ?>
 484                         <input type='hidden' name="title" value="<?php $this->text( 'searchtitle' ) ?>"/>
 485                 </div>
 486         </form>
 487 </div>
 488 <?php
 489
 490                                 break;
 491                         }
 492                         echo "\n<!-- /{$name} -->\n";
 493                 }
 494         }
 495 }