minor refactoring
[lhc/web/wiklou.git] / includes / SkinTemplate.php
index 187d9a8..bbbcff0 100644 (file)
@@ -88,10 +88,11 @@ class SkinTemplate extends Skin {
        var $template;
 
        /**
-        * An array of strings representing extra CSS files to load.  May include:
-        * 'IE', 'IE50', 'IE55', 'IE60', 'IE70', 'rtl'.
+        * An array of stylesheet filenames (relative from skins path), with options
+        * for CSS media, IE conditions, and RTL/LTR direction.
+        * For internal use; add settings in the skin via $this->addStyle()
         */
-       var $cssfiles;
+       var $styles = array();
 
        /**#@-*/
 
@@ -107,7 +108,9 @@ class SkinTemplate extends Skin {
                $this->skinname  = 'monobook';
                $this->stylename = 'monobook';
                $this->template  = 'QuickTemplate';
-               $this->cssfiles = array();
+
+               $this->addStyle( 'common/shared.css', 'screen' );
+               $this->addStyle( 'common/commonPrint.css', 'print' );
        }
 
        /**
@@ -139,7 +142,7 @@ class SkinTemplate extends Skin {
                global $wgDisableCounters, $wgLogo, $action, $wgFeedClasses, $wgHideInterlanguageLinks;
                global $wgMaxCredits, $wgShowCreditsIfMax;
                global $wgPageShowWatchingUsers;
-               global $wgUseTrackbacks;
+               global $wgUseTrackbacks, $wgUseSiteJs;
                global $wgArticlePath, $wgScriptPath, $wgServer, $wgLang, $wgCanonicalNamespaceNames;
 
                wfProfileIn( __METHOD__ );
@@ -179,7 +182,7 @@ class SkinTemplate extends Skin {
                }
 
                $this->usercss =  $this->userjs = $this->userjsprev = false;
-               $this->setupUserCss();
+               $this->setupUserCss( $out->getExtStyle() );
                $this->setupUserJs( $out->isUserJsAllowed() );
                $this->titletxt = $this->mTitle->getPrefixedText();
                wfProfileOut( __METHOD__."-stuff" );
@@ -188,7 +191,8 @@ class SkinTemplate extends Skin {
                $tpl->set( 'title', $wgOut->getPageTitle() );
                $tpl->set( 'pagetitle', $wgOut->getHTMLTitle() );
                $tpl->set( 'displaytitle', $wgOut->mPageLinkTitle );
-               $tpl->set( 'pageclass', Sanitizer::escapeClass( 'page-'.$this->mTitle->getPrefixedText() ) );
+               $tpl->set( 'pageclass', $this->getPageClasses( $this->mTitle ) );
+               $tpl->set( 'skinnameclass', ( "skin-" . Sanitizer::escapeClass( $this->getSkinName ( ) ) ) );
 
                $nsname = isset( $wgCanonicalNamespaceNames[ $this->mTitle->getNamespace() ] ) ?
                          $wgCanonicalNamespaceNames[ $this->mTitle->getNamespace() ] :
@@ -247,8 +251,9 @@ class SkinTemplate extends Skin {
                $tpl->set( 'skinclass', get_class( $this ) );
                $tpl->setRef( 'stylename', $this->stylename );
                $tpl->set( 'printable', $wgRequest->getBool( 'printable' ) );
+               $tpl->set( 'handheld', $wgRequest->getBool( 'handheld' ) );
+               $tpl->set( 'csslinks', $this->buildCssLinks() );
                $tpl->setRef( 'loggedin', $this->loggedin );
-               $tpl->set('nsclass', 'ns-'.$this->mTitle->getNamespace());
                $tpl->set('notspecialpage', $this->mTitle->getNamespace() != NS_SPECIAL);
                /* XXX currently unused, might get useful later
                $tpl->set( "editable", ($this->mTitle->getNamespace() != NS_SPECIAL ) );
@@ -274,12 +279,10 @@ class SkinTemplate extends Skin {
                $tpl->setRef( 'userpageurl', $this->userpageUrlDetails['href']);
                $tpl->set( 'userlang', $wgLang->getCode() );
                $tpl->set( 'pagecss', $this->setupPageCss() );
-               $tpl->set( 'printcss', $this->getPrintCss() );
                $tpl->setRef( 'usercss', $this->usercss);
                $tpl->setRef( 'userjs', $this->userjs);
                $tpl->setRef( 'userjsprev', $this->userjsprev);
-               global $wgUseSiteJs;
-               if ($wgUseSiteJs) {
+               if( $wgUseSiteJs ) {
                        $jsCache = $this->loggedin ? '&smaxage=0' : '';
                        $tpl->set( 'jsvarurl',
                                self::makeUrl('-',
@@ -326,7 +329,7 @@ class SkinTemplate extends Skin {
 
                wfProfileIn( __METHOD__."-stuff3" );
                $tpl->setRef( 'newtalk', $ntl );
-               $tpl->setRef( 'skin', $this);
+               $tpl->setRef( 'skin', $this );
                $tpl->set( 'logo', $this->logoText() );
                if ( $wgOut->isArticle() and (!isset( $oldid ) or isset( $diff )) and
                        $wgArticle and 0 != $wgArticle->getID() )
@@ -367,11 +370,10 @@ class SkinTemplate extends Skin {
 
                        $this->credits = false;
 
-                       if (isset($wgMaxCredits) && $wgMaxCredits != 0) {
-                               require_once("Credits.php");
-                               $this->credits = getCredits($wgArticle, $wgMaxCredits, $wgShowCreditsIfMax);
+                       if( $wgMaxCredits != 0 ){
+                               $this->credits = Credits::getCredits( $wgArticle, $wgMaxCredits, $wgShowCreditsIfMax );
                        } else {
-                               $tpl->set('lastmod', $this->lastModified());
+                               $tpl->set( 'lastmod', $this->lastModified() );
                        }
 
                        $tpl->setRef( 'credits', $this->credits );
@@ -452,6 +454,10 @@ class SkinTemplate extends Skin {
                        wfDebug( __METHOD__ . ': Hook SkinTemplateOutputPageBeforeExec broke outputPage execution!' );
                }
 
+               // allow extensions adding stuff after the page content.
+               // See Skin::afterContentHook() for further documentation.
+               $tpl->set ('dataAfterContent', $this->afterContentHook());
+
                // execute template
                wfProfileIn( __METHOD__."-execute" );
                $res = $tpl->execute();
@@ -700,7 +706,7 @@ class SkinTemplate extends Skin {
                        wfProfileOut( __METHOD__."-edit" );
 
                        wfProfileIn( __METHOD__."-live" );
-                       if ( $this->mTitle->getArticleId() ) {
+                       if ( $this->mTitle->exists() ) {
 
                                $content_actions['history'] = array(
                                        'class' => ($action == 'history') ? 'selected' : false,
@@ -725,7 +731,7 @@ class SkinTemplate extends Skin {
                                }
 
                                if ( $this->mTitle->getNamespace() !== NS_MEDIAWIKI && $wgUser->isAllowed( 'protect' ) ) {
-                                       if(!$this->mTitle->isProtected()){
+                                       if( !$this->mTitle->isProtected() ){
                                                $content_actions['protect'] = array(
                                                        'class' => ($action == 'protect') ? 'selected' : false,
                                                        'text' => wfMsg('protect'),
@@ -959,61 +965,64 @@ class SkinTemplate extends Skin {
        /**
         * @private
         */
-       function setupUserCss() {
-               wfProfileIn( __METHOD__ );
+       function setupUserCss( $extCSS = array() ) {
+               global $wgRequest, $wgAllowUserCss, $wgUseSiteCss, $wgContLang, $wgSquidMaxage, $wgStylePath, $wgUser;
 
-               global $wgRequest, $wgAllowUserCss, $wgUseSiteCss, 
-                       $wgContLang, $wgSquidMaxage, $wgStylePath, $wgUser, $wgOut;
+               wfProfileIn( __METHOD__ );
 
-               $sitecss = '';
-               $usercss = '';
-               $siteargs = '&maxage=' . $wgSquidMaxage;
+               $siteargs = array(
+                       'action' => 'raw',
+                       'maxage' => $wgSquidMaxage,
+               );
                if( $this->loggedin ) {
                        // Ensure that logged-in users' generated CSS isn't clobbered
                        // by anons' publicly cacheable generated CSS.
-                       $siteargs .= '&smaxage=0';
+                       $siteargs['smaxage'] = '0';
+                       $siteargs['ts'] = $wgUser->mTouched;
+               }
+               
+               // Add any extension CSS
+               foreach( $extCSS as $tag ) {
+                       $this->addStyle( $tag['href'] );
+               }
+
+               // If we use the site's dynamic CSS, throw that in, too
+               // Per-site custom styles
+               if ( $wgUseSiteCss ) {
+                       $query = wfArrayToCGI( array(
+                               'usemsgcache' => 'yes',
+                               'ctype' => 'text/css',
+                               'smaxage' => $wgSquidMaxage
+                       ) + $siteargs );
+                       $this->addStyle( self::makeNSUrl( 'Common.css', $query, NS_MEDIAWIKI ) );
+                       $this->addStyle( self::makeNSUrl( ucfirst( $this->skinname ) . '.css', $query, NS_MEDIAWIKI ),
+                               'screen' );
                }
 
-               # Add user-specific code if this is a user and we allow that kind of thing
+               // Per-user styles based on preferences
+               $siteargs['gen'] = 'css';
+               if( ( $us = $wgRequest->getVal( 'useskin', '' ) ) !== '' )
+                       $siteargs['useskin'] = $us;
+               $this->addStyle( self::makeUrl( '-', wfArrayToCGI( $siteargs ) ), 'screen' );
 
+               // Per-user custom style pages
                if ( $wgAllowUserCss && $this->loggedin ) {
-                       $action = $wgRequest->getText('action');
+                       $action = $wgRequest->getVal('action');
 
                        # if we're previewing the CSS page, use it
-                       if( $this->mTitle->isCssSubpage() and $this->userCanPreview( $action ) ) {
-                               $siteargs = "&smaxage=0&maxage=0";
-                               $usercss = $wgRequest->getText('wpTextbox1');
+                       if( $this->mTitle->isCssSubpage() && $this->userCanPreview( $action ) ) {
+                               $previewCss = $wgRequest->getText('wpTextbox1');
+
+                               /// @fixme properly escape the cdata!
+                               $this->usercss = "/*<![CDATA[*/\n" .
+                                       $previewCss .
+                                       "/*]]>*/";
                        } else {
-                               $usercss = '@import "' .
-                                 self::makeUrl($this->userpage . '/'.$this->skinname.'.css',
-                                                                'action=raw&ctype=text/css') . '";' ."\n";
+                               $this->addStyle( self::makeUrl($this->userpage . '/'.$this->skinname.'.css',
+                                                                'action=raw&ctype=text/css'), 'screen' );
                        }
-
-                       $siteargs .= '&ts=' . $wgUser->mTouched;
-               }
-
-               if( $wgContLang->isRTL() && in_array( 'rtl', $this->cssfiles ) ) {
-                       global $wgStyleVersion;
-                       $sitecss .= "@import \"$wgStylePath/$this->stylename/rtl.css?$wgStyleVersion\";\n";
                }
 
-               # If we use the site's dynamic CSS, throw that in, too
-               if ( $wgUseSiteCss ) {
-                       $query = "usemsgcache=yes&action=raw&ctype=text/css&smaxage=$wgSquidMaxage";
-                       $skinquery = '';
-                       if (($us = $wgRequest->getVal('useskin', '')) !== '')
-                               $skinquery = "&useskin=$us";
-                       $sitecss .= '@import "' . self::makeNSUrl( 'Common.css', $query, NS_MEDIAWIKI) . '";' . "\n";
-                       $sitecss .= '@import "' . self::makeNSUrl( ucfirst( $this->skinname ) . '.css', $query, NS_MEDIAWIKI ) . '";' . "\n";
-                       $sitecss .= '@import "' . self::makeUrl( '-', "action=raw&gen=css$siteargs$skinquery" ) . '";' . "\n";
-                       if( $wgOut->isPrintable()) $sitecss .= '@import "' . self::makeNSUrl( 'Print.css', $query, NS_MEDIAWIKI) . '";' . "\n";
-               }
-
-               # If we use any dynamic CSS, make a little CDATA block out of it.
-
-               if ( !empty($sitecss) || !empty($usercss) ) {
-                       $this->usercss = "/*<![CDATA[*/\n" . $sitecss . $usercss . '/*]]>*/';
-               }
                wfProfileOut( __METHOD__ );
        }
 
@@ -1064,17 +1073,6 @@ class SkinTemplate extends Skin {
                return $s;
        }
 
-       /**
-        * Returns the print stylesheet for this skin.  In all default skins this
-        * is just commonPrint.css, but third-party skins may want to modify it.
-        *
-        * @return string
-        */
-       protected function getPrintCss() {
-               global $wgStylePath;
-               return $wgStylePath . "/common/commonPrint.css";
-       }
-
        /**
         * This returns MediaWiki:Common.js and MediaWiki:[Skinname].js concate-
         * nated together.  For some bizarre reason, it does *not* return any
@@ -1104,6 +1102,119 @@ class SkinTemplate extends Skin {
                wfProfileOut( __METHOD__ );
                return $s;
        }
+
+       /**
+        * Add a local or specified stylesheet, with the given media options.
+        * Meant primarily for internal use...
+        *
+        * @param $media -- to specify a media type, 'screen', 'printable', 'handheld' or any.
+        * @param $conditional -- for IE conditional comments, specifying an IE version
+        * @param $dir -- set to 'rtl' or 'ltr' for direction-specific sheets
+        */
+       public function addStyle( $style, $media='', $condition='', $dir='' ) {
+               $options = array();
+               if( $media )
+                       $options['media'] = $media;
+               if( $condition )
+                       $options['condition'] = $condition;
+               if( $dir )
+                       $options['dir'] = $dir;
+               $this->styles[$style] = $options;
+       }
+
+       /**
+        * Build a set of <link>s for the stylesheets specified in the $this->styles array.
+        * These will be applied to various media & IE conditionals.
+        */
+       protected function buildCssLinks() {
+               $links = array();
+               foreach( $this->styles as $file => $options ) {
+                       $link = $this->styleLink( $file, $options );
+                       if( $link )
+                               $links[] = $link;
+               }
+
+               return implode( "\n\t\t", $links );
+       }
+
+       protected function styleLink( $style, $options ) {
+               global $wgRequest;
+
+               if( isset( $options['dir'] ) ) {
+                       global $wgContLang;
+                       $siteDir = $wgContLang->isRTL() ? 'rtl' : 'ltr';
+                       if( $siteDir != $options['dir'] )
+                               return '';
+               }
+
+               if( isset( $options['media'] ) ) {
+                       $media = $this->transformCssMedia( $options['media'] );
+                       if( is_null( $media ) ) {
+                               return '';
+                       }
+               } else {
+                       $media = '';
+               }
+
+               if( substr( $style, 0, 1 ) == '/' ||
+                       substr( $style, 0, 5 ) == 'http:' ||
+                       substr( $style, 0, 6 ) == 'https:' ) {
+                       $url = $style;
+               } else {
+                       global $wgStylePath, $wgStyleVersion;
+                       $url = $wgStylePath . '/' . $style . '?' . $wgStyleVersion;
+               }
+
+               $attribs = array(
+                       'rel' => 'stylesheet',
+                       'href' => $url,
+                       'type' => 'text/css' );
+               if( $media ) {
+                       $attribs['media'] = $media;
+               }
+
+               $link = Xml::element( 'link', $attribs );
+
+               if( isset( $options['condition'] ) ) {
+                       $condition = htmlspecialchars( $options['condition'] );
+                       $link = "<!--[if $condition]>$link<![endif]-->";
+               }
+               return $link;
+       }
+
+       function transformCssMedia( $media ) {
+               global $wgRequest, $wgHandheldForIPhone;
+
+               // Switch in on-screen display for media testing
+               $switches = array(
+                       'printable' => 'print',
+                       'handheld' => 'handheld',
+               );
+               foreach( $switches as $switch => $targetMedia ) {
+                       if( $wgRequest->getBool( $switch ) ) {
+                               if( $media == $targetMedia ) {
+                                       $media = '';
+                               } elseif( $media == 'screen' ) {
+                                       return null;
+                               }
+                       }
+               }
+
+               // Expand longer media queries as iPhone doesn't grok 'handheld'
+               if( $wgHandheldForIPhone ) {
+                       $mediaAliases = array(
+                               'screen' => 'screen and (min-device-width: 481px)',
+                               'handheld' => 'handheld, only screen and (max-device-width: 480px)',
+                       );
+
+                       if( isset( $mediaAliases[$media] ) ) {
+                               $media = $mediaAliases[$media];
+                       }
+               }
+
+               return $media;
+       }
+
 }
 
 /**