* Document a bit
[lhc/web/wiklou.git] / includes / Skin.php
index 4b5cdc0..4c5cca2 100644 (file)
@@ -24,7 +24,7 @@ class Skin extends Linker {
        /**#@-*/
        protected $mRevisionId; // The revision ID we're looking at, null if not applicable.
        protected $skinname = 'standard';
-       // @fixme Should be protected :-\
+       // @todo Fixme: should be protected :-\
        var $mTitle = null;
 
        /** Constructor, call parent constructor */
@@ -355,17 +355,18 @@ class Skin extends Linker {
                        # Weird back-compat stuff.
                        $skinName = $skinName['skinname'];
                }
-               global $wgScript, $wgTitle, $wgStylePath, $wgUser;
+               global $wgScript, $wgTitle, $wgStylePath, $wgUser, $wgScriptExtension;
                global $wgArticlePath, $wgScriptPath, $wgServer, $wgContLang, $wgLang;
-               global $wgCanonicalNamespaceNames, $wgOut, $wgArticle;
+               global $wgOut, $wgArticle;
                global $wgBreakFrames, $wgRequest, $wgVariantArticlePath, $wgActionPaths;
                global $wgUseAjax, $wgAjaxWatch;
                global $wgVersion, $wgEnableAPI, $wgEnableWriteAPI;
-               global $wgRestrictionTypes, $wgLivePreview;
+               global $wgRestrictionTypes;
                global $wgMWSuggestTemplate, $wgDBname, $wgEnableMWSuggest;
+               global $wgSitename;
 
                $ns = $wgTitle->getNamespace();
-               $nsname = isset( $wgCanonicalNamespaceNames[ $ns ] ) ? $wgCanonicalNamespaceNames[ $ns ] : $wgTitle->getNsText();
+               $nsname = MWNamespace::exists( $ns ) ? MWNamespace::getCanonicalName( $ns ) : $wgTitle->getNsText();
                $separatorTransTable = $wgContLang->separatorTransformTable();
                $separatorTransTable = $separatorTransTable ? $separatorTransTable : array();
                $compactSeparatorTransTable = array(
@@ -383,22 +384,25 @@ class Skin extends Linker {
                $vars = array(
                        'skin' => $skinName,
                        'stylepath' => $wgStylePath,
+                       'urlprotocols' => wfUrlProtocols(),
                        'wgArticlePath' => $wgArticlePath,
                        'wgScriptPath' => $wgScriptPath,
+                       'wgScriptExtension' => $wgScriptExtension,
                        'wgScript' => $wgScript,
                        'wgVariantArticlePath' => $wgVariantArticlePath,
                        'wgActionPaths' => (object)$wgActionPaths,
                        'wgServer' => $wgServer,
                        'wgCanonicalNamespace' => $nsname,
-                       'wgCanonicalSpecialPageName' => SpecialPage::resolveAlias( $wgTitle->getDBkey() ),
+                       'wgCanonicalSpecialPageName' => $ns == NS_SPECIAL ?
+                               SpecialPage::resolveAlias( $wgTitle->getDBkey() ) : false, # bug 21115
                        'wgNamespaceNumber' => $wgTitle->getNamespace(),
                        'wgPageName' => $wgTitle->getPrefixedDBKey(),
                        'wgTitle' => $wgTitle->getText(),
                        'wgAction' => $wgRequest->getText( 'action', 'view' ),
                        'wgArticleId' => $wgTitle->getArticleId(),
                        'wgIsArticle' => $wgOut->isArticle(),
-                       'wgUserName' => $wgUser->isAnon() ? NULL : $wgUser->getName(),
-                       'wgUserGroups' => $wgUser->isAnon() ? NULL : $wgUser->getEffectiveGroups(),
+                       'wgUserName' => $wgUser->isAnon() ? null : $wgUser->getName(),
+                       'wgUserGroups' => $wgUser->isAnon() ? null : $wgUser->getEffectiveGroups(),
                        'wgUserLanguage' => $wgLang->getCode(),
                        'wgContentLanguage' => $wgContLang->getCode(),
                        'wgBreakFrames' => $wgBreakFrames,
@@ -411,16 +415,17 @@ class Skin extends Linker {
                        'wgMainPageTitle' => $mainPage ? $mainPage->getPrefixedText() : null,
                        'wgFormattedNamespaces' => $wgContLang->getFormattedNamespaces(),
                        'wgNamespaceIds' => $wgContLang->getNamespaceIds(),
+                       'wgSiteName' => $wgSitename,
+                       'wgCategories' => $wgOut->getCategories(),
                );
                if ( $wgContLang->hasVariants() ) {
                        $vars['wgUserVariant'] = $wgContLang->getPreferredVariant();
                }
 
                //if on upload page output the extension list & js_upload
-               if( SpecialPage::resolveAlias( $wgTitle->getDBkey() ) ==  "Upload" ){
+               if( SpecialPage::resolveAlias( $wgTitle->getDBkey() ) ==  "Upload" ) {
                        global $wgFileExtensions, $wgAjaxUploadInterface;
-                       $vars['wgFileExtensions']        = $wgFileExtensions;
-                       $vars['wgAjaxUploadInterface'] = $wgAjaxUploadInterface;
+                       $vars['wgFileExtensions'] = $wgFileExtensions;
                }
 
                if( $wgUseAjax && $wgEnableMWSuggest && !$wgUser->getOption( 'disablesuggest', false ) ){
@@ -433,16 +438,10 @@ class Skin extends Linker {
                foreach( $wgRestrictionTypes as $type )
                        $vars['wgRestriction' . ucfirst( $type )] = $wgTitle->getRestrictions( $type );
 
-               if ( $wgLivePreview && $wgUser->getOption( 'uselivepreview' ) ) {
-                       $vars['wgLivepreviewMessageLoading'] = wfMsg( 'livepreview-loading' );
-                       $vars['wgLivepreviewMessageReady']   = wfMsg( 'livepreview-ready' );
-                       $vars['wgLivepreviewMessageFailed']  = wfMsg( 'livepreview-failed' );
-                       $vars['wgLivepreviewMessageError']   = wfMsg( 'livepreview-error' );
-               }
-
                if ( $wgOut->isArticleRelated() && $wgUseAjax && $wgAjaxWatch && $wgUser->isLoggedIn() ) {
                        $msgs = (object)array();
-                       foreach ( array( 'watch', 'unwatch', 'watching', 'unwatching' ) as $msgName ) {
+                       foreach ( array( 'watch', 'unwatch', 'watching', 'unwatching', 
+                               'tooltip-ca-watch', 'tooltip-ca-unwatch' ) as $msgName ) {
                                $msgs->{$msgName . 'Msg'} = wfMsg( $msgName );
                        }
                        $vars['wgAjaxWatch'] = $msgs;
@@ -453,42 +452,6 @@ class Skin extends Linker {
 
                return self::makeVariablesScript( $vars );
        }
-       /**
-        * Return a random selection of the scripts we want in the header, 
-        * according to no particular rhyme or reason.  Various other scripts are 
-        * returned from a haphazard assortment of other functions scattered over 
-        * various files.  This entire hackish system needs to be burned to the 
-        * ground and rebuilt.
-        *
-        * @param $out OutputPage object, should be $wgOut
-        *
-        * @return string Raw HTML to output to <head>
-        */
-       function getHeadScripts( OutputPage $out ) {
-               global $wgStylePath, $wgUser, $wgJsMimeType, $wgStyleVersion, $wgOut;
-               global $wgUseSiteJs;
-
-               $vars = self::makeGlobalVariablesScript( $this->getSkinName() );
-
-               //moved wikibits to be called earlier on
-               //$out->addScriptFile( "{$wgStylePath}/common/wikibits.js" );
-               if( $wgUseSiteJs ) {
-                       $jsCache = $wgUser->isLoggedIn() ? '&smaxage=0' : '';
-                       $wgOut->addScriptFile(  self::makeUrl( '-',
-                                       "action=raw$jsCache&gen=js&useskin=" .
-                                       urlencode( $this->getSkinName() )
-                                       )
-                               );
-               }
-               if( $out->isUserJsAllowed() && $wgUser->isLoggedIn() ) {
-                       $userpage = $wgUser->getUserPage();
-                       $userjs =  self::makeUrl(
-                               $userpage->getPrefixedText().'/'.$this->getSkinName().'.js',
-                               'action=raw&ctype='.$wgJsMimeType );
-                       $wgOut->addScriptFile( $userjs );
-               }
-               return $vars . "\n" . $out->mScripts;
-       }
 
        /**
         * To make it harder for someone to slip a user a fake
@@ -499,9 +462,8 @@ class Skin extends Linker {
         *
         * @param string $action
         * @return bool
-        * @private
         */
-       function userCanPreview( $action ) {
+       public function userCanPreview( $action ) {
                global $wgRequest, $wgUser;
 
                if( $action != 'submit' )
@@ -527,15 +489,15 @@ class Skin extends Linker {
         * top.  For now Monobook.js will be maintained, but it should be consi-
         * dered deprecated.
         *
-        * @param force_skin  lets you override the skin name
+        * @param $force_skin string If set, overrides the skin name
         *
         * @return string
         */
-       public function generateUserJs( $skinName = null) {
+       public function generateUserJs( $skinName = null ) {
                global $wgStylePath;
 
                wfProfileIn( __METHOD__ );
-               if(!$skinName){
+               if( !$skinName ) {
                        $skinName =     $this->getSkinName();
                }
 
@@ -551,7 +513,7 @@ class Skin extends Linker {
                $s .= "\n\n/* MediaWiki:".ucfirst( $skinName ).".js */\n";
                // avoid inclusion of non defined user JavaScript (with custom skins only)
                // by checking for default message content
-               $msgKey = ucfirst( $skinName ).'.js';
+               $msgKey = ucfirst( $skinName ) . '.js';
                $userJS = wfMsgForContent( $msgKey );
                if ( !wfEmptyMsg( $msgKey, $userJS ) ) {
                        $s .= $userJS;
@@ -585,7 +547,7 @@ class Skin extends Linker {
                if( $wgUser->getOption( 'highlightbroken' ) ) {
                        $s .= "a.new, #quickbar a.new { color: #CC2200; }\n";
                } else {
-                       $s .= <<<END
+                       $s .= <<<CSS
 a.new, #quickbar a.new,
 a.stub, #quickbar a.stub {
        color: inherit;
@@ -598,7 +560,7 @@ a.stub:after, #quickbar a.stub:after {
        content: "!";
        color: #772233;
 }
-END;
+CSS;
                }
                if( $wgUser->getOption( 'justify' ) ) {
                        $s .= "#article, #bodyContent, #mw_content { text-align: justify; }\n";
@@ -673,9 +635,8 @@ END;
                        $action = $wgRequest->getVal( 'action' );
                        # If we're previewing the CSS page, use it
                        if( $this->mTitle->isCssSubpage() && $this->userCanPreview( $action ) ) {
-                               $previewCss = $wgRequest->getText( 'wpTextbox1' );
                                // @FIXME: properly escape the cdata!
-                               $this->usercss = "/*<![CDATA[*/\n" . $previewCss . "/*]]>*/";
+                               $out->addInlineStyle( $wgRequest->getText( 'wpTextbox1' ) );
                        } else {
                                $out->addStyle( self::makeUrl( $this->userpage . '/' . $this->getSkinName() .'.css',
                                        'action=raw&ctype=text/css' ) );
@@ -897,11 +858,17 @@ END;
        }
 
        function getCategories() {
-               $catlinks=$this->getCategoryLinks();
+               $catlinks = $this->getCategoryLinks();
 
                $classes = 'catlinks';
 
-               if( strpos( $catlinks, '<div id="mw-normal-catlinks">' ) === false ) {
+               // Check what we're showing
+               global $wgOut, $wgUser;
+               $allCats = $wgOut->getCategoryLinks();
+               $showHidden = $wgUser->getBoolOption( 'showhiddencats' ) ||
+                                               $this->mTitle->getNamespace() == NS_CATEGORY;
+
+               if( empty($allCats['normal']) && !( !empty($allCats['hidden']) && $showHidden ) ) {
                        $classes .= ' catlinks-allhidden';
                }
 
@@ -955,13 +922,48 @@ END;
        protected function generateDebugHTML() {
                global $wgShowDebug, $wgOut;
                if ( $wgShowDebug ) {
-                       $listInternals = str_replace( "\n", "</li>\n<li>", htmlspecialchars( $wgOut->mDebugtext ) );
-                       return "\n<hr>\n<strong>Debug data:</strong><ul style=\"font-family:monospace;\"><li>" .
-                               $listInternals . "</li></ul>\n";
+                       $listInternals = $this->formatDebugHTML( $wgOut->mDebugtext );
+                       return "\n<hr />\n<strong>Debug data:</strong><ul style=\"font-family:monospace;\" id=\"mw-debug-html\">" .
+                               $listInternals . "</ul>\n";
                }
                return '';
        }
 
+       private function formatDebugHTML( $debugText ) {
+               $lines = explode( "\n", $debugText );
+               $curIdent = 0;
+               $ret = '<li>';
+               foreach( $lines as $line ) {
+                       $m = array();
+                       $display = ltrim( $line );
+                       $ident = strlen( $line ) - strlen( $display );
+                       $diff = $ident - $curIdent;
+
+                       if ( $display == '' )
+                               $display = "\xc2\xa0";
+
+                       if ( !$ident && $diff < 0 && substr( $display, 0, 9 ) != 'Entering ' && substr( $display, 0, 8 ) != 'Exiting ' ) {
+                               $ident = $curIdent;
+                               $diff = 0;
+                               $display = '<span style="background:yellow;">' . htmlspecialchars( $display ) . '</span>';
+                       } else {
+                               $display = htmlspecialchars( $display );
+                       }
+
+                       if ( $diff < 0 )
+                               $ret .= str_repeat( "</li></ul>\n", -$diff ) . "</li><li>\n";
+                       elseif ( $diff == 0 )
+                               $ret .= "</li><li>\n";
+                       else
+                               $ret .= str_repeat( "<ul><li>\n", $diff );
+                       $ret .= $display . "\n";
+
+                       $curIdent = $ident;
+               }
+               $ret .= str_repeat( '</li></ul>', $curIdent ) . '</li>';
+               return $ret;
+       }
+
        /**
         * This gets called shortly before the </body> tag.
         * @return String HTML to be put before </body>
@@ -1125,7 +1127,7 @@ END;
                global $wgOut;
 
                $sub = $wgOut->getSubtitle();
-               if ( '' == $sub ) {
+               if ( $sub == '' ) {
                        global $wgExtraSubtitle;
                        $sub = wfMsgExt( 'tagline', 'parsemag' ) . $wgExtraSubtitle;
                }
@@ -1528,7 +1530,7 @@ END;
        }
 
        function logoText( $align = '' ) {
-               if ( '' != $align ) {
+               if ( $align != '' ) {
                        $a = " align='{$align}'";
                } else {
                        $a = '';
@@ -1837,7 +1839,7 @@ END;
                        $url = $nt->escapeFullURL();
                        $text = $wgContLang->getLanguageName( $nt->getInterwiki() );
 
-                       if ( '' == $text ) { $text = $l; }
+                       if ( $text == '' ) { $text = $l; }
                        $style = $this->getExternalLinkAttributes();
                        $s .= "<a href=\"{$url}\"{$style}>{$text}</a>";
                }
@@ -2025,7 +2027,22 @@ END;
                }
 
                $bar = array();
-               $lines = explode( "\n", wfMsgForContent( 'sidebar' ) );
+               $this->addToSidebar( $bar, 'sidebar' );
+
+               wfRunHooks( 'SkinBuildSidebar', array( $this, &$bar ) );
+               if ( $wgEnableSidebarCache ) $parserMemc->set( $key, $bar, $wgSidebarCacheExpiry );
+               wfProfileOut( __METHOD__ );
+               return $bar;
+       }
+       /**
+        * Add content from a sidebar system message
+        * Currently only used for MediaWiki:Sidebar (but may be used by Extensions)
+        * 
+        * @param &$bar array
+        * @param $message String
+        */
+       function addToSidebar( &$bar, $message ) {
+               $lines = explode( "\n", wfMsgForContent( $message ) );
                $heading = '';
                foreach( $lines as $line ) {
                        if( strpos( $line, '*' ) !== 0 )
@@ -2067,10 +2084,6 @@ END;
                                } else { continue; }
                        }
                }
-               wfRunHooks( 'SkinBuildSidebar', array( $this, &$bar ) );
-               if ( $wgEnableSidebarCache ) $parserMemc->set( $key, $bar, $wgSidebarCacheExpiry );
-               wfProfileOut( __METHOD__ );
-               return $bar;
        }
 
        /**