Improving extendibility of the sidebar improvements, css adding, and also JS variables.
[lhc/web/wiklou.git] / skins / Modern.php
index 3f4fd44..bfbc0a8 100644 (file)
@@ -3,7 +3,8 @@
  * Modern skin, derived from monobook template.
  *
  * @todo document
- * @addtogroup Skins
+ * @file
+ * @ingroup Skins
  */
 
 if( !defined( 'MEDIAWIKI' ) )
@@ -12,9 +13,18 @@ if( !defined( 'MEDIAWIKI' ) )
 /**
  * Inherit main code from SkinTemplate, set the CSS and template filter.
  * @todo document
- * @addtogroup Skins
+ * @ingroup Skins
  */
 class SkinModern extends SkinTemplate {
+       /*
+        * We don't like the default getPoweredBy, the icon clashes with the 
+        * skin L&F.
+        */
+       function getPoweredBy() {
+       global  $wgVersion;
+               return "<div class='mw_poweredby'>Powered by MediaWiki $wgVersion</div>";
+       }
+
        function initPage( &$out ) {
                SkinTemplate::initPage( $out );
                $this->skinname  = 'modern';
@@ -25,9 +35,10 @@ class SkinModern extends SkinTemplate {
 
 /**
  * @todo document
- * @addtogroup Skins
+ * @ingroup Skins
  */
 class ModernTemplate extends QuickTemplate {
+       var $skin;
        /**
         * Template filter callback for Modern skin.
         * Takes an associative array of data set from a SkinTemplate-based
@@ -38,7 +49,7 @@ class ModernTemplate extends QuickTemplate {
         */
        function execute() {
                global $wgUser;
-               $skin = $wgUser->getSkin();
+               $this->skin = $skin = $wgUser->getSkin();
 
                // Suppress warnings to prevent notices about missing indexes in $this->data
                wfSuppressWarnings();
@@ -52,10 +63,12 @@ class ModernTemplate extends QuickTemplate {
                <meta http-equiv="Content-Type" content="<?php $this->text('mimetype') ?>; charset=<?php $this->text('charset') ?>" />
                <?php $this->html('headlinks') ?>
                <title><?php $this->text('pagetitle') ?></title>
+               <?php if(empty($this->data['printable']) ) { ?>
                <style type="text/css" media="screen, projection">/*<![CDATA[*/
                        @import "<?php $this->text('stylepath') ?>/common/shared.css?<?php echo $GLOBALS['wgStyleVersion'] ?>";
                        @import "<?php $this->text('stylepath') ?>/<?php $this->text('stylename') ?>/main.css?<?php echo $GLOBALS['wgStyleVersion'] ?>";
                /*]]>*/</style>
+               <?php } ?>
                <link rel="stylesheet" type="text/css" <?php if(empty($this->data['printable']) ) { ?>media="print"<?php } ?> href="<?php $this->text('stylepath') ?>/<?php $this->text('stylename') ?>/print.css?<?php echo $GLOBALS['wgStyleVersion'] ?>" />
                <!--[if lt IE 7]><meta http-equiv="imagetoolbar" content="no" /><![endif]-->
                
@@ -126,47 +139,117 @@ class ModernTemplate extends QuickTemplate {
                <div id="contentSub"><?php $this->html('subtitle') ?></div>
 
                <?php if($this->data['undelete']) { ?><div id="contentSub2"><?php     $this->html('undelete') ?></div><?php } ?>
-               <?php if($this->data['showjumplinks']) { ?><div id="jump-to-nav"><?php $this->msg('jumpto') ?> <a href="#column-one"><?php $this->msg('jumptonavigation') ?></a>, <a href="#searchInput"><?php $this->msg('jumptosearch') ?></a></div><?php } ?>
+               <?php if($this->data['showjumplinks']) { ?><div id="jump-to-nav"><?php $this->msg('jumpto') ?> <a href="#mw_portlets"><?php $this->msg('jumptonavigation') ?></a>, <a href="#searchInput"><?php $this->msg('jumptosearch') ?></a></div><?php } ?>
 
                <?php $this->html('bodytext') ?>
                <div class='mw_clear'></div>
-               <?php if($this->data['catlinks']) { ?><?php       $this->html('catlinks') ?><?php } ?>
+               <?php if($this->data['catlinks']) { $this->html('catlinks'); } ?>
        </div><!-- mw_contentholder -->
        </div><!-- mw_content -->
        </div><!-- mw_contentwrapper -->
 
        <div id="mw_portlets">
 
-       <!-- other portlets -->
-       <?php foreach ($this->data['sidebar'] as $bar => $cont) { ?>
-       <div class='portlet' id='p-<?php echo Sanitizer::escapeId($bar) ?>'<?php echo $skin->tooltip('p-'.$bar) ?>>
-               <h5><?php $out = wfMsg( $bar ); if (wfEmptyMsg($bar, $out)) echo $bar; else echo $out; ?></h5>
-               <div class='pBody'>
+       <!-- portlets -->
+       <?php 
+               $sidebar = $this->data['sidebar'];              
+               if ( !isset( $sidebar['SEARCH'] ) ) $sidebar['SEARCH'] = true;
+               if ( !isset( $sidebar['TOOLBOX'] ) ) $sidebar['TOOLBOX'] = true;
+               if ( !isset( $sidebar['LANGUAGES'] ) ) $sidebar['LANGUAGES'] = true;
+               
+               foreach ($sidebar as $boxName => $cont) {
+                       if ( $boxName == 'SEARCH' ) {
+                               $this->searchBox();
+                       } elseif ( $boxName == 'TOOLBOX' ) {
+                               $this->toolbox();
+                       } elseif ( $boxName == 'LANGUAGES' ) {
+                               $this->languageBox();
+                       } else {
+                               if( wfRunHooks( 'SkinSidebarOutputSpecialBox', array( &$this, $boxName, $cont ) ) ) {
+                                       # If no hook returned false, then output a normal box
+                                       $this->customBox( $boxName, $cont );
+                               }
+                       }
+               }
+       ?>
+
+       </div><!-- mw_portlets -->
+
+
+       </div><!-- main -->
+
+       <div class="mw_clear"></div>
+
+       <!-- personal portlet -->
+       <div class="portlet" id="p-personal">
+               <h5><?php $this->msg('personaltools') ?></h5>
+               <div class="pBody">
                        <ul>
-<?php                  foreach($cont as $key => $val) { ?>
-                               <li id="<?php echo Sanitizer::escapeId($val['id']) ?>"<?php
-                                       if ( $val['active'] ) { ?> class="active" <?php }
-                               ?>><a href="<?php echo htmlspecialchars($val['href']) ?>"<?php echo $skin->tooltipAndAccesskey($val['id']) ?>><?php echo htmlspecialchars($val['text']) ?></a></li>
+<?php                  foreach($this->data['personal_urls'] as $key => $item) { ?>
+                               <li id="pt-<?php echo Sanitizer::escapeId($key) ?>"<?php
+                                       if ($item['active']) { ?> class="active"<?php } ?>><a href="<?php
+                               echo htmlspecialchars($item['href']) ?>"<?php echo $skin->tooltipAndAccesskey('pt-'.$key) ?><?php
+                               if(!empty($item['class'])) { ?> class="<?php
+                               echo htmlspecialchars($item['class']) ?>"<?php } ?>><?php
+                               echo htmlspecialchars($item['text']) ?></a></li>
 <?php                  } ?>
                        </ul>
-               </div><!-- pBody -->
-       </div><!-- portlet -->
-       <?php } ?>
+               </div>
+       </div>
 
+
+       <!-- footer --> 
+       <div id="footer">
+                       <ul id="f-list">
+<?php
+               $footerlinks = array(
+                       'lastmod', 'viewcount', 'numberofwatchingusers', 'credits', 'copyright',
+                       'privacy', 'about', 'disclaimer', 'tagline',
+               );
+               foreach( $footerlinks as $aLink ) {
+                       if( isset( $this->data[$aLink] ) && $this->data[$aLink] ) {
+?>                             <li id="<?php echo$aLink?>"><?php $this->html($aLink) ?></li>
+<?php          }
+               }
+?>
+                       </ul>
+               <?php echo $this->html("poweredbyico"); ?>
+       </div>
+
+       <?php $this->html('bottomscripts'); /* JS call to runBodyOnloadHook */ ?>
+<?php $this->html('reporttime') ?>
+<?php if ( $this->data['debug'] ): ?>
+<!-- Debug output:
+<?php $this->text( 'debug' ); ?>
+-->
+<?php endif; ?>
+</body></html>
+<?php
+       wfRestoreWarnings();
+       } // end of execute() method
+
+       /*************************************************************************************************/
+       function searchBox() {
+?>
        <!-- search -->
        <div id="p-search" class="portlet">
                <h5><label for="searchInput"><?php $this->msg('search') ?></label></h5>
                <div id="searchBody" class="pBody">
                        <form action="<?php $this->text('searchaction') ?>" id="searchform"><div>
-                               <input id="searchInput" name="search" type="text"<?php echo $skin->tooltipAndAccesskey('search');
+                               <input id="searchInput" name="search" type="text"<?php echo $this->skin->tooltipAndAccesskey('search');
                                        if( isset( $this->data['search'] ) ) {
                                                ?> value="<?php $this->text('search') ?>"<?php } ?> />
-                               <input type='submit' name="go" class="searchButton" id="searchGoButton" value="<?php $this->msg('searcharticle') ?>"<?php echo $skin->tooltipAndAccesskey( 'search-go' ); ?> />&nbsp;
-                               <input type='submit' name="fulltext" class="searchButton" id="mw-searchButton" value="<?php $this->msg('searchbutton') ?>"<?php echo $skin->tooltipAndAccesskey( 'search-fulltext' ); ?> />
+                               <input type='submit' name="go" class="searchButton" id="searchGoButton" value="<?php $this->msg('searcharticle') ?>"<?php echo $this->skin->tooltipAndAccesskey( 'search-go' ); ?> />&nbsp;
+                               <input type='submit' name="fulltext" class="searchButton" id="mw-searchButton" value="<?php $this->msg('searchbutton') ?>"<?php echo $this->skin->tooltipAndAccesskey( 'search-fulltext' ); ?> />
                        </div></form>
                </div><!-- pBody -->
        </div><!-- portlet -->
+<?php
+       }
 
+       /*************************************************************************************************/
+       function toolbox() {
+?>
        <!-- toolbox -->
        <div class="portlet" id="p-tb">
                <h5><?php $this->msg('toolbox') ?></h5>
@@ -176,23 +259,23 @@ class ModernTemplate extends QuickTemplate {
                if($this->data['notspecialpage']) { ?>
                                <li id="t-whatlinkshere"><a href="<?php
                                echo htmlspecialchars($this->data['nav_urls']['whatlinkshere']['href'])
-                               ?>"<?php echo $skin->tooltipAndAccesskey('t-whatlinkshere') ?>><?php $this->msg('whatlinkshere') ?></a></li>
+                               ?>"<?php echo $this->skin->tooltipAndAccesskey('t-whatlinkshere') ?>><?php $this->msg('whatlinkshere') ?></a></li>
 <?php
                        if( $this->data['nav_urls']['recentchangeslinked'] ) { ?>
                                <li id="t-recentchangeslinked"><a href="<?php
                                echo htmlspecialchars($this->data['nav_urls']['recentchangeslinked']['href'])
-                               ?>"<?php echo $skin->tooltipAndAccesskey('t-recentchangeslinked') ?>><?php $this->msg('recentchangeslinked') ?></a></li>
+                               ?>"<?php echo $this->skin->tooltipAndAccesskey('t-recentchangeslinked') ?>><?php $this->msg('recentchangeslinked') ?></a></li>
 <?php          }
                }
                if(isset($this->data['nav_urls']['trackbacklink'])) { ?>
                        <li id="t-trackbacklink"><a href="<?php
                                echo htmlspecialchars($this->data['nav_urls']['trackbacklink']['href'])
-                               ?>"<?php echo $skin->tooltipAndAccesskey('t-trackbacklink') ?>><?php $this->msg('trackbacklink') ?></a></li>
+                               ?>"<?php echo $this->skin->tooltipAndAccesskey('t-trackbacklink') ?>><?php $this->msg('trackbacklink') ?></a></li>
 <?php  }
                if($this->data['feeds']) { ?>
                        <li id="feedlinks"><?php foreach($this->data['feeds'] as $key => $feed) {
                                        ?><span id="feed-<?php echo Sanitizer::escapeId($key) ?>"><a href="<?php
-                                       echo htmlspecialchars($feed['href']) ?>"<?php echo $skin->tooltipAndAccesskey('feed-'.$key) ?>><?php echo htmlspecialchars($feed['text'])?></a>&nbsp;</span>
+                                       echo htmlspecialchars($feed['href']) ?>"<?php echo $this->skin->tooltipAndAccesskey('feed-'.$key) ?>><?php echo htmlspecialchars($feed['text'])?></a>&nbsp;</span>
                                        <?php } ?></li><?php
                }
 
@@ -200,26 +283,32 @@ class ModernTemplate extends QuickTemplate {
 
                        if($this->data['nav_urls'][$special]) {
                                ?><li id="t-<?php echo $special ?>"><a href="<?php echo htmlspecialchars($this->data['nav_urls'][$special]['href'])
-                               ?>"<?php echo $skin->tooltipAndAccesskey('t-'.$special) ?>><?php $this->msg($special) ?></a></li>
+                               ?>"<?php echo $this->skin->tooltipAndAccesskey('t-'.$special) ?>><?php $this->msg($special) ?></a></li>
 <?php          }
                }
 
                if(!empty($this->data['nav_urls']['print']['href'])) { ?>
                                <li id="t-print"><a href="<?php echo htmlspecialchars($this->data['nav_urls']['print']['href'])
-                               ?>"<?php echo $skin->tooltipAndAccesskey('t-print') ?>><?php $this->msg('printableversion') ?></a></li><?php
+                               ?>"<?php echo $this->skin->tooltipAndAccesskey('t-print') ?>><?php $this->msg('printableversion') ?></a></li><?php
                }
 
                if(!empty($this->data['nav_urls']['permalink']['href'])) { ?>
                                <li id="t-permalink"><a href="<?php echo htmlspecialchars($this->data['nav_urls']['permalink']['href'])
-                               ?>"<?php echo $skin->tooltipAndAccesskey('t-permalink') ?>><?php $this->msg('permalink') ?></a></li><?php
+                               ?>"<?php echo $this->skin->tooltipAndAccesskey('t-permalink') ?>><?php $this->msg('permalink') ?></a></li><?php
                } elseif ($this->data['nav_urls']['permalink']['href'] === '') { ?>
-                               <li id="t-ispermalink"<?php echo $skin->tooltip('t-ispermalink') ?>><?php $this->msg('permalink') ?></li><?php
+                               <li id="t-ispermalink"<?php echo $this->skin->tooltip('t-ispermalink') ?>><?php $this->msg('permalink') ?></li><?php
                }
-?>
-                       </ul>
+
+               wfRunHooks( 'SkinTemplateToolboxEnd', array( &$this ) );
+?>                     </ul>
                </div><!-- pBody -->
        </div><!-- portlet -->
+<?php
+       }
 
+       /*************************************************************************************************/
+       function languageBox() {
+?>
        <!-- languages -->
 <?php
                if( $this->data['language_urls'] ) { ?>
@@ -234,60 +323,34 @@ class ModernTemplate extends QuickTemplate {
                        </ul>
                </div><!-- pBody -->
        </div><!-- portlet -->
-<?php  } ?>
-
-       </div><!-- mw_portlets -->
-
-
-       </div><!-- main -->
-
-       <div class="mw_clear"></div>
+<?php
+               }
+       }
 
-       <!-- personal portlet -->
-       <div class="portlet" id="p-personal">
-               <h5><?php $this->msg('personaltools') ?></h5>
-               <div class="pBody">
+       /*************************************************************************************************/
+       function customBox( $bar, $cont ) {
+?>
+               <div class='generated-sidebar portlet' id='p-<?php echo Sanitizer::escapeId($bar) ?>'<?php echo $this->skin->tooltip('p-'.$bar) ?>>
+               <h5><?php $out = wfMsg( $bar ); if (wfEmptyMsg($bar, $out)) echo $bar; else echo $out; ?></h5>
+               <div class='pBody'>
+<?php   if ( is_array( $cont ) ) { ?>
                        <ul>
-<?php                  foreach($this->data['personal_urls'] as $key => $item) { ?>
-                               <li id="pt-<?php echo Sanitizer::escapeId($key) ?>"<?php
-                                       if ($item['active']) { ?> class="active"<?php } ?>><a href="<?php
-                               echo htmlspecialchars($item['href']) ?>"<?php echo $skin->tooltipAndAccesskey('pt-'.$key) ?><?php
-                               if(!empty($item['class'])) { ?> class="<?php
-                               echo htmlspecialchars($item['class']) ?>"<?php } ?>><?php
-                               echo htmlspecialchars($item['text']) ?></a></li>
+<?php                  foreach($cont as $key => $val) { ?>
+                               <li id="<?php echo Sanitizer::escapeId($val['id']) ?>"<?php
+                                       if ( $val['active'] ) { ?> class="active" <?php }
+                               ?>><a href="<?php echo htmlspecialchars($val['href']) ?>"<?php echo $this->skin->tooltipAndAccesskey($val['id']) ?>><?php echo htmlspecialchars($val['text']) ?></a></li>
 <?php                  } ?>
                        </ul>
-               </div>
-       </div>
-
-
-       <!-- footer --> 
-       <div id="footer">
-                       <ul id="f-list">
-<?php
-               $footerlinks = array(
-                       'lastmod', 'viewcount', 'numberofwatchingusers', 'credits', 'copyright',
-                       'privacy', 'about', 'disclaimer', 'tagline',
-               );
-               foreach( $footerlinks as $aLink ) {
-                       if( isset( $this->data[$aLink] ) && $this->data[$aLink] ) {
-?>                             <li id="<?php echo$aLink?>"><?php $this->html($aLink) ?></li>
-<?php          }
-               }
+<?php   } else {
+                       # allow raw HTML block to be defined by extensions
+                       print $cont;
+               } 
 ?>
-                       </ul>
-       </div>
-
-       <?php $this->html('bottomscripts'); /* JS call to runBodyOnloadHook */ ?>
-<?php $this->html('reporttime') ?>
-<?php if ( $this->data['debug'] ): ?>
-<!-- Debug output:
-<?php $this->text( 'debug' ); ?>
--->
-<?php endif; ?>
-</body></html>
+               </div><!-- pBody -->
+       </div><!-- portlet -->
 <?php
-       wfRestoreWarnings();
-       } // end of execute() method
+       }
+
 } // end of class
-?>
+
+