Don't use public-audience-only function
[lhc/web/wiklou.git] / includes / OutputPage.php
index 9fcac1b..74feac9 100644 (file)
@@ -35,6 +35,13 @@ class OutputPage {
        var $mSquidMaxage = 0;
        var $mRevisionId = null;
 
+       /**
+        * 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 $styles = array();
+
        private $mIndexPolicy = 'index';
        private $mFollowPolicy = 'follow';
 
@@ -65,18 +72,19 @@ class OutputPage {
         */
        function setStatusCode( $statusCode ) { $this->mStatusCode = $statusCode; }
 
-       # To add an http-equiv meta tag, precede the name with "http:"
-       function addMeta( $name, $val ) { array_push( $this->mMetatags, array( $name, $val ) ); }
+       /**
+        * Add a new <meta> tag
+        * To add an http-equiv meta tag, precede the name with "http:"
+        *
+        * @param $name tag name
+        * @param $val tag value
+        */
+       function addMeta( $name, $val ) {
+               array_push( $this->mMetatags, array( $name, $val ) );
+       }
+
        function addKeyword( $text ) { array_push( $this->mKeywords, $text ); }
        function addScript( $script ) { $this->mScripts .= "\t\t".$script; }
-       function addStyle( $style ) {
-               global $wgStylePath, $wgStyleVersion;
-               $this->addLink(
-                               array(
-                                       'rel' => 'stylesheet',
-                                       'href' => $wgStylePath . '/' . $style . '?' . $wgStyleVersion,
-                                       'type' => 'text/css' ) );
-       }
        
        function addExtensionStyle( $url ) {
                $linkarr = array( 'rel' => 'stylesheet', 'href' => $url, 'type' => 'text/css' );
@@ -153,62 +161,87 @@ class OutputPage {
         * possible. If sucessful, the OutputPage is disabled so that
         * any future call to OutputPage->output() have no effect.
         *
+        * Side effect: sets mLastModified for Last-Modified header
+        *
         * @return bool True iff cache-ok headers was sent.
         */
        function checkLastModified ( $timestamp ) {
                global $wgCachePages, $wgCacheEpoch, $wgUser, $wgRequest;
-
+               
                if ( !$timestamp || $timestamp == '19700101000000' ) {
                        wfDebug( __METHOD__ . ": CACHE DISABLED, NO TIMESTAMP\n" );
-                       return;
+                       return false;
                }
                if( !$wgCachePages ) {
                        wfDebug( __METHOD__ . ": CACHE DISABLED\n", false );
-                       return;
+                       return false;
                }
                if( $wgUser->getOption( 'nocache' ) ) {
                        wfDebug( __METHOD__ . ": USER DISABLED CACHE\n", false );
-                       return;
+                       return false;
                }
 
-               $timestamp=wfTimestamp(TS_MW,$timestamp);
-               $lastmod = wfTimestamp( TS_RFC2822, max( $timestamp, $wgUser->mTouched, $wgCacheEpoch ) );
+               $timestamp = wfTimestamp( TS_MW, $timestamp );
+               $modifiedTimes = array(
+                       'page' => $timestamp,
+                       'user' => $wgUser->getTouched(),
+                       'epoch' => $wgCacheEpoch
+               );
+               wfRunHooks( 'OutputPageCheckLastModified', array( &$modifiedTimes ) );
 
-               if( !empty( $_SERVER['HTTP_IF_MODIFIED_SINCE'] ) ) {
-                       # IE sends sizes after the date like this:
-                       # Wed, 20 Aug 2003 06:51:19 GMT; length=5202
-                       # this breaks strtotime().
-                       $modsince = preg_replace( '/;.*$/', '', $_SERVER["HTTP_IF_MODIFIED_SINCE"] );
+               $maxModified = max( $modifiedTimes );
+               $this->mLastModified = wfTimestamp( TS_RFC2822, $maxModified );
 
-                       wfSuppressWarnings(); // E_STRICT system time bitching
-                       $modsinceTime = strtotime( $modsince );
-                       wfRestoreWarnings();
+               if( empty( $_SERVER['HTTP_IF_MODIFIED_SINCE'] ) ) {
+                       wfDebug( __METHOD__ . ": client did not send If-Modified-Since header\n", false );
+                       return false;
+               }
 
-                       $ismodsince = wfTimestamp( TS_MW, $modsinceTime ? $modsinceTime : 1 );
-                       wfDebug( __METHOD__ . ": -- client send If-Modified-Since: " . $modsince . "\n", false );
-                       wfDebug( __METHOD__ . ": --  we might send Last-Modified : $lastmod\n", false );
-                       if( ($ismodsince >= $timestamp ) && $wgUser->validateCache( $ismodsince ) && $ismodsince >= $wgCacheEpoch ) {
-                               # Make sure you're in a place you can leave when you call us!
-                               $wgRequest->response()->header( "HTTP/1.0 304 Not Modified" );
-                               $this->mLastModified = $lastmod;
-                               $this->sendCacheControl();
-                               wfDebug( __METHOD__ . ": CACHED client: $ismodsince ; user: $wgUser->mTouched ; page: $timestamp ; site $wgCacheEpoch\n", false );
-                               $this->disable();
+               # Make debug info
+               $info = '';
+               foreach ( $modifiedTimes as $name => $value ) {
+                       if ( $info !== '' ) {
+                               $info .= ', ';
+                       }
+                       $info .= "$name=" . wfTimestamp( TS_ISO_8601, $value );
+               }
 
-                               // Don't output a compressed blob when using ob_gzhandler;
-                               // it's technically against HTTP spec and seems to confuse
-                               // Firefox when the response gets split over two packets.
-                               wfClearOutputBuffers();
+               # IE sends sizes after the date like this:
+               # Wed, 20 Aug 2003 06:51:19 GMT; length=5202
+               # this breaks strtotime().
+               $clientHeader = preg_replace( '/;.*$/', '', $_SERVER["HTTP_IF_MODIFIED_SINCE"] );
 
-                               return true;
-                       } else {
-                               wfDebug( __METHOD__ . ": READY  client: $ismodsince ; user: $wgUser->mTouched ; page: $timestamp ; site $wgCacheEpoch\n", false );
-                               $this->mLastModified = $lastmod;
-                       }
-               } else {
-                       wfDebug( __METHOD__ . ": client did not send If-Modified-Since header\n", false );
-                       $this->mLastModified = $lastmod;
+               wfSuppressWarnings(); // E_STRICT system time bitching
+               $clientHeaderTime = strtotime( $clientHeader );
+               wfRestoreWarnings();
+               if ( !$clientHeaderTime ) {
+                       wfDebug( __METHOD__ . ": unable to parse the client's If-Modified-Since header: $clientHeader\n" );
+                       return false;
+               }
+               $clientHeaderTime = wfTimestamp( TS_MW, $clientHeaderTime );
+
+               wfDebug( __METHOD__ . ": client sent If-Modified-Since: " . 
+                       wfTimestamp( TS_ISO_8601, $clientHeaderTime ) . "\n", false );
+               wfDebug( __METHOD__ . ": effective Last-Modified: " . 
+                       wfTimestamp( TS_ISO_8601, $maxModified ) . "\n", false );
+               if( $clientHeaderTime < $maxModified ) {
+                       wfDebug( __METHOD__ . ": STALE, $info\n", false );
+                       return false;
                }
+
+               # Not modified
+               # Give a 304 response code and disable body output 
+               wfDebug( __METHOD__ . ": NOT MODIFIED, $info\n", false );
+               $wgRequest->response()->header( "HTTP/1.1 304 Not Modified" );
+               $this->sendCacheControl();
+               $this->disable();
+
+               // Don't output a compressed blob when using ob_gzhandler;
+               // it's technically against HTTP spec and seems to confuse
+               // Firefox when the response gets split over two packets.
+               wfClearOutputBuffers();
+
+               return true;
        }
 
        function setPageTitleActionText( $text ) {
@@ -393,6 +426,7 @@ class OutputPage {
        public function disallowUserJs() { $this->mAllowUserJs = false; }
        public function isUserJsAllowed() { return $this->mAllowUserJs; }
 
+       public function prependHTML( $text ) { $this->mBodytext = $text . $this->mBodytext; }
        public function addHTML( $text ) { $this->mBodytext .= $text; }
        public function clearHTML() { $this->mBodytext = ''; }
        public function getHTML() { return $this->mBodytext; }
@@ -421,6 +455,10 @@ class OutputPage {
                $val = is_null( $revid ) ? null : intval( $revid );
                return wfSetVar( $this->mRevisionId, $val );
        }
+       
+       public function getRevisionId() {
+               return $this->mRevisionId;
+       }
 
        /**
         * Convert wikitext to HTML and add it to the buffer
@@ -734,7 +772,9 @@ class OutputPage {
                                $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
                                $response->header( "Cache-Control: private, must-revalidate, max-age=0" );
                        }
-                       if($this->mLastModified) $response->header( "Last-modified: {$this->mLastModified}" );
+                       if($this->mLastModified) {
+                               $response->header( "Last-Modified: {$this->mLastModified}" );
+                       }
                } else {
                        wfDebug( __METHOD__ . ": no caching **\n", false );
 
@@ -753,8 +793,9 @@ class OutputPage {
        public function output() {
                global $wgUser, $wgOutputEncoding, $wgRequest;
                global $wgContLanguageCode, $wgDebugRedirects, $wgMimeType;
-               global $wgJsMimeType, $wgUseAjax, $wgAjaxSearch, $wgAjaxWatch;
-               global $wgEnableMWSuggest;
+               global $wgJsMimeType, $wgUseAjax, $wgAjaxWatch;
+               global $wgEnableMWSuggest, $wgUniversalEditButton;
+               global $wgArticle, $wgTitle;
 
                if( $this->mDoNothing ){
                        return;
@@ -848,11 +889,6 @@ class OutputPage {
 
                        wfRunHooks( 'AjaxAddScript', array( &$this ) );
 
-                       if( $wgAjaxSearch && $wgUser->getBoolOption( 'ajaxsearch' ) ) {
-                               $this->addScriptFile( 'ajaxsearch.js' );
-                               $this->addScript( "<script type=\"{$wgJsMimeType}\">hookEvent(\"load\", sajax_onload);</script>\n" );
-                       }
-
                        if( $wgAjaxWatch && $wgUser->isLoggedIn() ) {
                                $this->addScriptFile( 'ajaxwatch.js' );
                        }
@@ -866,6 +902,25 @@ class OutputPage {
                        $this->addScriptFile( 'rightclickedit.js' );
                }
 
+               if( $wgUniversalEditButton ) {
+                       if( isset( $wgArticle ) && isset( $wgTitle ) && $wgTitle->quickUserCan( 'edit' )
+                               && ( $wgTitle->exists() || $wgTitle->quickUserCan( 'create' ) ) ) {
+                               // Original UniversalEditButton
+                               $this->addLink( array(
+                                       'rel' => 'alternate',
+                                       'type' => 'application/x-wiki',
+                                       'title' => wfMsg( 'edit' ),
+                                       'href' => $wgTitle->getFullURL( 'action=edit' )
+                               ) );
+                               // Alternate edit link
+                               $this->addLink( array(
+                                       'rel' => 'edit',
+                                       'title' => wfMsg( 'edit' ),
+                                       'href' => $wgTitle->getFullURL( 'action=edit' )
+                               ) );
+                       }
+               }
+               
                # Buffer output; final headers may depend on later processing
                ob_start();
 
@@ -1149,8 +1204,8 @@ class OutputPage {
                if ($action == null) {
                        $text = wfMsgNoTrans( 'permissionserrorstext', count($errors)). "\n\n";
                } else {
-                       $action_desc = wfMsg( "right-$action" );
-                       $action_desc[0] = strtolower($action_desc[0]);
+                       global $wgLang;
+                       $action_desc = wfMsg( "action-$action" );
                        $text = wfMsgNoTrans( 'permissionserrorstext-withaction', count($errors), $action_desc ) . "\n\n";
                }
 
@@ -1216,7 +1271,7 @@ class OutputPage {
                        // Wiki is read only
                        $this->setPageTitle( wfMsg( 'readonly' ) );
                        $reason = wfReadOnlyReason();
-                       $this->addWikiMsg( 'readonlytext', $reason );
+                       $this->wrapWikiMsg( '<div class="mw-readonly-error">$1</div>', array( 'readonlytext', $reason ) );
                }
 
                // Show source, if supplied
@@ -1382,15 +1437,19 @@ class OutputPage {
        /**
         * @return string The doctype, opening <html>, and head element.
         */
-       public function headElement() {
+       public function headElement( Skin $sk ) {
                global $wgDocType, $wgDTD, $wgContLanguageCode, $wgOutputEncoding, $wgMimeType;
                global $wgXhtmlDefaultNamespace, $wgXhtmlNamespaces;
                global $wgUser, $wgContLang, $wgUseTrackbacks, $wgTitle, $wgStyleVersion;
 
+               $this->addMeta( "http:Content-type", "$wgMimeType; charset={$wgOutputEncoding}" );
+               $this->addStyle( 'common/wikiprintable.css', 'print' );
+               $sk->setupUserCss( $this );
+
+               $ret = '';
+
                if( $wgMimeType == 'text/xml' || $wgMimeType == 'application/xhtml+xml' || $wgMimeType == 'application/xml' ) {
-                       $ret = "<?xml version=\"1.0\" encoding=\"$wgOutputEncoding\" ?>\n";
-               } else {
-                       $ret = '';
+                       $ret .= "<?xml version=\"1.0\" encoding=\"$wgOutputEncoding\" ?>\n";
                }
 
                $ret .= "<!DOCTYPE html PUBLIC \"$wgDocType\"\n        \"$wgDTD\">\n";
@@ -1405,29 +1464,17 @@ class OutputPage {
                        $ret .= "xmlns:{$tag}=\"{$ns}\" ";
                }
                $ret .= "xml:lang=\"$wgContLanguageCode\" lang=\"$wgContLanguageCode\" $rtl>\n";
-               $ret .= "<head>\n<title>" . htmlspecialchars( $this->getHTMLTitle() ) . "</title>\n";
-               $this->addMeta( "http:Content-type", "$wgMimeType; charset={$wgOutputEncoding}" );
-               
-               $ret .= $this->getHeadLinks();
-               global $wgStylePath;
-               if( $this->isPrintable() ) {
-                       $media = '';
-               } else {
-                       $media = "media='print'";
+               $ret .= "<head>\n<title>" . htmlspecialchars( $this->getHTMLTitle() ) . "</title>\n\t\t";
+               $ret .= implode( "\t\t", array(
+                       $this->getHeadLinks(),
+                       $this->buildCssLinks(),
+                       $sk->getHeadScripts( $this->mAllowUserJs ),
+                       $this->mScripts,
+                       $this->getHeadItems(),
+               ));
+               if( $sk->usercss ){
+                       $ret .= "<style type='text/css'>{$sk->usercss}</style>";
                }
-               $printsheet = htmlspecialchars( "$wgStylePath/common/wikiprintable.css?$wgStyleVersion" );
-               $ret .= "<link rel='stylesheet' type='text/css' $media href='$printsheet' />\n";
-
-               $sk = $wgUser->getSkin();
-               // Load order here is key
-               $ret .= $sk->getHeadScripts( $this->mAllowUserJs );
-               $ret .= $this->mScripts;
-               $ret .= $sk->getSiteStyles();
-               foreach( $this->mExtStyles as $tag ) {
-                       $ret .= Xml::element( 'link', $tag ) . "\n";
-               }
-               $ret .= $sk->getUserStyles();
-               $ret .= $this->getHeadItems();
 
                if ($wgUseTrackbacks && $this->isArticleRelated())
                        $ret .= $wgTitle->trackbackRDF();
@@ -1505,7 +1552,7 @@ class OutputPage {
                        # or "Breaking news" one). For this, we see if $wgOverrideSiteFeed is defined.
                        # If so, use it instead.
                        
-                       global $wgOverrideSiteFeed, $wgSitename;
+                       global $wgOverrideSiteFeed, $wgSitename, $wgFeedClasses;
                        $rctitle = SpecialPage::getTitleFor( 'Recentchanges' );
                        
                        if ( $wgOverrideSiteFeed ) {
@@ -1517,14 +1564,12 @@ class OutputPage {
                                }
                        }
                        else if ( $wgTitle->getPrefixedText() != $rctitle->getPrefixedText() ) {
-                               $tags[] = $this->feedLink(
-                                       'rss',
-                                       $rctitle->getFullURL( 'feed=rss' ),
-                                       wfMsg( 'site-rss-feed', $wgSitename ) );
-                               $tags[] = $this->feedLink(
-                                       'atom',
-                                       $rctitle->getFullURL( 'feed=atom' ),
-                                       wfMsg( 'site-atom-feed', $wgSitename ) );
+                               foreach( $wgFeedClasses as $format => $class ) {
+                                       $tags[] = $this->feedLink(
+                                               $format,
+                                               $rctitle->getFullURL( "feed={$format}" ),
+                                               wfMsg( "site-{$format}-feed", $wgSitename ) ); # For grep: 'site-rss-feed', 'site-atom-feed'.
+                               }
                        }
                }
 
@@ -1564,6 +1609,118 @@ class OutputPage {
                        'href' => $url ) );
        }
 
+       /**
+        * 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.
+        */
+       public 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;
+       }
+
        /**
         * Turn off regular page output and return an error reponse
         * for when rate limiting has triggered.