Board of Trustees vote
[lhc/web/wiklou.git] / includes / OutputPage.php
index b112034..e859ed2 100644 (file)
@@ -1,7 +1,7 @@
 <?php
 # See design.doc
 
-if($wgUseTeX) include_once( "Math.php" );
+if($wgUseTeX) require_once( "Math.php" );
 
 class OutputPage {
        var $mHeaders, $mCookies, $mMetatags, $mKeywords;
@@ -16,7 +16,9 @@ class OutputPage {
        var $mContainsOldMagic, $mContainsNewMagic; 
        var $mIsArticleRelated;
        var $mParserOptions;
-
+       var $mShowFeedLinks = false;
+       var $mEnableClientCache = true;
+       
        function OutputPage()
        {
                $this->mHeaders = $this->mCookies = $this->mMetatags =
@@ -32,6 +34,7 @@ class OutputPage {
                $this->mDoNothing = false;
                $this->mContainsOldMagic = $this->mContainsNewMagic = 0;
                $this->mParserOptions = ParserOptions::newFromUser( $temp = NULL );
+               $this->mSquidMaxage = 0;
        }
 
        function addHeader( $name, $val ) { array_push( $this->mHeaders, "$name: $val" ) ; }
@@ -41,7 +44,19 @@ class OutputPage {
        # To add an http-equiv meta tag, precede the name with "http:"
        function addMeta( $name, $val ) { array_push( $this->mMetatags, array( $name, $val ) ); }
        function addKeyword( $text ) { array_push( $this->mKeywords, $text ); }
-       function addLink( $rel, $rev, $target ) { array_push( $this->mLinktags, array( $rel, $rev, $target ) ); }
+       
+       function addLink( $linkarr ) {
+               # $linkarr should be an associative array of attributes. We'll escape on output.
+               array_push( $this->mLinktags, $linkarr );
+       }
+
+       function addMetadataLink( $linkarr ) {
+               # note: buggy CC software only reads first "meta" link
+               static $haveMeta = false;
+               $linkarr["rel"] = ($haveMeta) ? "alternate meta" : "meta";
+               $this->addLink( $linkarr );
+               $haveMeta = true;
+       }
 
        # checkLastModified tells the client to use the client-cached page if
        # possible. If sucessful, the OutputPage is disabled so that
@@ -63,11 +78,11 @@ class OutputPage {
                        wfDebug( "USER DISABLED CACHE\n", false );
                        return;
                }
-               
-                $lastmod = gmdate( "D, j M Y H:i:s", wfTimestamp2Unix(
-                       max( $timestamp, $wgUser->mTouched ) ) ) . " GMT";
-               
-               if( !empty( $_SERVER["HTTP_IF_MODIFIED_SINCE"] ) ) {
+
+               $lastmod = gmdate( "D, j M Y H:i:s", wfTimestamp2Unix(
+                 max( $timestamp, $wgUser->mTouched ) ) ) . " GMT";
+
+        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().
@@ -94,15 +109,51 @@ class OutputPage {
                }
        }
 
+       function getPageTitleActionText () {
+               global $action;
+               switch($action) {
+                       case 'edit':
+                               return  wfMsg('edit');
+                       case 'history':
+                               return wfMsg('history_short');
+                       case 'protect':
+                               return wfMsg('unprotect');
+                       case 'unprotect':
+                               return wfMsg('unprotect');
+                       case 'delete':
+                               return wfMsg('delete');
+                       case 'watch':
+                               return wfMsg('watch');
+                       case 'unwatch':
+                               return wfMsg('unwatch');
+                       case 'submit':
+                               return wfMsg('preview');
+                       default:
+                               return '';
+               }
+       }
        function setRobotpolicy( $str ) { $this->mRobotpolicy = $str; }
-       function setHTMLtitle( $name ) { $this->mHTMLtitle = $name; }
-       function setPageTitle( $name ) { $this->mPagetitle = $name; }
+       function setHTMLTitle( $name ) {$this->mHTMLtitle = $name; }
+       function setPageTitle( $name ) {
+               global $action;
+               $this->mPagetitle = $name;
+               if(!empty($action)) {
+                       $taction =  $this->getPageTitleActionText();
+                       if( !empty( $taction ) ) {
+                               $name .= " - $taction";
+                       }
+               }
+               $this->setHTMLTitle( $name . " - " . wfMsg( "wikititlesuffix" ) );
+       }
+       function getHTMLTitle() { return $this->mHTMLtitle; }
        function getPageTitle() { return $this->mPagetitle; }
        function setSubtitle( $str ) { $this->mSubtitle = $str; }
        function getSubtitle() { return $this->mSubtitle; }
        function isArticle() { return $this->mIsarticle; }
        function setPrintable() { $this->mPrintable = true; }
        function isPrintable() { return $this->mPrintable; }
+       function setSyndicated( $show = true ) { $this->mShowFeedLinks = $show; }
+       function isSyndicated() { return $this->mShowFeedLinks; }
        function setOnloadHandler( $js ) { $this->mOnloadHandler = $js; }
        function getOnloadHandler() { return $this->mOnloadHandler; }
        function disable() { $this->mDoNothing = true; }
@@ -173,15 +224,19 @@ class OutputPage {
 
        # Set the maximum cache time on the Squid in seconds
        function setSquidMaxage( $maxage ) {
-               global $wgSquidMaxage;
-               $wgSquidMaxage = $maxage;
+               $this->mSquidMaxage = $maxage;
+       }
+       
+       # Use enableClientCache(false) to force it to send nocache headers
+       function enableClientCache( $state ) {
+               return wfSetVar( $this->mEnableClientCache, $state );
        }
        
        function sendCacheControl() {
-               global $wgUseSquid, $wgUseESI, $wgSquidMaxage;
+               global $wgUseSquid, $wgUseESI;
                # FIXME: This header may cause trouble with some versions of Internet Explorer
                header( "Vary: Accept-Encoding, Cookie" );
-               if( $this->mLastModified != "" ) {
+               if( $this->mEnableClientCache && $this->mLastModified != "" ) {
                        if( $wgUseSquid && ! isset( $_COOKIE[ini_get( "session.name") ] ) && 
                          ! $this->isPrintable() ) 
                        {
@@ -192,7 +247,7 @@ class OutputPage {
                                        wfDebug( "** proxy caching with ESI; {$this->mLastModified} **\n", false );
                                        # start with a shorter timeout for initial testing
                                        # header( 'Surrogate-Control: max-age=2678400+2678400, content="ESI/1.0"');
-                                       header( 'Surrogate-Control: max-age='.$wgSquidMaxage.'+'.$wgSquidMaxage.', content="ESI/1.0"');
+                                       header( 'Surrogate-Control: max-age='.$wgSquidMaxage.'+'.$this->mSquidMaxage.', content="ESI/1.0"');
                                        header( 'Cache-Control: s-maxage=0, must-revalidate, max-age=0' );
                                } else {
                                        # We'll purge the proxy cache for anons explicitly, but require end user agents
@@ -202,7 +257,7 @@ class OutputPage {
                                        wfDebug( "** local proxy caching; {$this->mLastModified} **\n", false );
                                        # start with a shorter timeout for initial testing
                                        # header( "Cache-Control: s-maxage=2678400, must-revalidate, max-age=0" );
-                                       header( 'Cache-Control: s-maxage='.$wgSquidMaxage.', must-revalidate, max-age=0' );
+                                       header( 'Cache-Control: s-maxage='.$this->mSquidMaxage.', must-revalidate, max-age=0' );
                                }
                        } else {
                                # We do want clients to cache if they can, but they *must* check for updates
@@ -214,10 +269,12 @@ class OutputPage {
                        header( "Last-modified: {$this->mLastModified}" );
                } else {
                        wfDebug( "** no caching **\n", false );
+
+                       # In general, the absence of a last modified header should be enough to prevent
+                       # the client from using its cache. We send a few other things just to make sure.
                        header( "Expires: -1" );
-                       header( "Cache-Control: no-cache" );
+                       header( "Cache-Control: no-cache, no-store, max-age=0, must-revalidate" );
                        header( "Pragma: no-cache" );
-                       header( "Last-modified: " . gmdate( "D, j M Y H:i:s" ) . " GMT" );
                }
        }
        
@@ -228,7 +285,7 @@ class OutputPage {
        {
                global $wgUser, $wgLang, $wgDebugComments, $wgCookieExpiration;
                global $wgInputEncoding, $wgOutputEncoding, $wgLanguageCode;
-               global $wgDebugRedirects;
+               global $wgDebugRedirects, $wgMimeType;
                if( $this->mDoNothing ){
                        return;
                }
@@ -247,8 +304,7 @@ class OutputPage {
                                if( !$wgDebugRedirects ) {
                                        header("HTTP/1.1 {$this->mRedirectCode} Moved Permanently");
                                }
-                               $this->mLastModified = gmdate( "D, j M Y H:i:s", wfTimestamp2Unix(
-                                       max( $timestamp, $wgUser->mTouched ) ) ) . " GMT";
+                               $this->mLastModified = gmdate( "D, j M Y H:i:s" ) . " GMT";
                        }
                         
                        $this->sendCacheControl();
@@ -267,7 +323,7 @@ class OutputPage {
                
                $this->sendCacheControl();
                
-               header( "Content-type: text/html; charset={$wgOutputEncoding}" );
+               header( "Content-type: $wgMimeType; charset={$wgOutputEncoding}" );
                header( "Content-language: {$wgLanguageCode}" );
 
                $exp = time() + $wgCookieExpiration;
@@ -362,13 +418,14 @@ class OutputPage {
 
                $this->mDebugtext .= "Original title: " .
                  $wgTitle->getPrefixedText() . "\n";
-               $this->setHTMLTitle( wfMsg( "errorpagetitle" ) );
                $this->setPageTitle( wfMsg( $title ) );
+               $this->setHTMLTitle( wfMsg( "errorpagetitle" ) );
                $this->setRobotpolicy( "noindex,nofollow" );
                $this->setArticleRelated( false );
+               $this->enableClientCache( false );
 
                $this->mBodytext = "";
-               $this->addHTML( "<p>" . wfMsg( $msg ) . "\n" );
+               $this->addHTML( "<p>" . wfMsg( $msg ) . "</p>\n" );
                $this->returnToMain( false );
 
                $this->output();
@@ -379,8 +436,8 @@ class OutputPage {
        {
                global $wgUser;
 
-               $this->setHTMLTitle( wfMsg( "errorpagetitle" ) );
                $this->setPageTitle( wfMsg( "sysoptitle" ) );
+               $this->setHTMLTitle( wfMsg( "errorpagetitle" ) );
                $this->setRobotpolicy( "noindex,nofollow" );
                $this->setArticleRelated( false );
                $this->mBodytext = "";
@@ -395,8 +452,8 @@ class OutputPage {
        {
                global $wgUser;
 
-               $this->setHTMLTitle( wfMsg( "errorpagetitle" ) );
                $this->setPageTitle( wfMsg( "developertitle" ) );
+               $this->setHTMLTitle( wfMsg( "errorpagetitle" ) );
                $this->setRobotpolicy( "noindex,nofollow" );
                $this->setArticleRelated( false );
                $this->mBodytext = "";
@@ -411,8 +468,8 @@ class OutputPage {
        {
                global $wgUser, $wgTitle, $wgLang;
 
-               $this->setHTMLTitle( wfMsg( "errorpagetitle" ) );
                $this->setPageTitle( wfMsg( "loginreqtitle" ) );
+               $this->setHTMLTitle( wfMsg( "errorpagetitle" ) );
                $this->setRobotpolicy( "noindex,nofollow" );
                $this->setArticleFlag( false );
                $this->mBodytext = "";
@@ -434,6 +491,7 @@ class OutputPage {
                $this->setPageTitle( wfMsgNoDB( "databaseerror" ) );
                $this->setRobotpolicy( "noindex,nofollow" );
                $this->setArticleRelated( false );
+               $this->enableClientCache( false );
 
                if ( $wgCommandLineMode ) {
                        $msg = wfMsgNoDB( "dberrortextcl" );
@@ -459,7 +517,7 @@ class OutputPage {
                wfAbruptExit();
        }
 
-       function readOnlyPage( $source = "", $protected = false )
+       function readOnlyPage( $source = null, $protected = false )
        {
                global $wgUser, $wgReadOnlyFile;
 
@@ -472,13 +530,16 @@ class OutputPage {
                } else {
                        $this->setPageTitle( wfMsg( "readonly" ) );
                        $reason = file_get_contents( $wgReadOnlyFile );
-                       $this->addHTML( wfMsg( "readonlytext", $reason ) );
+                       $this->addWikiText( wfMsg( "readonlytext", $reason ) );
                }
                
-               if($source) {
+               if( is_string( $source ) ) {
+                       if( strcmp( $source, "" ) == 0 ) {
+                               $source = wfMsg( "noarticletext" );
+                       }
                        $rows = $wgUser->getOption( "rows" );
                        $cols = $wgUser->getOption( "cols" );
-                       $text .= "</p>\n<textarea cols='$cols' rows='$rows' readonly>" .
+                       $text = "\n<textarea cols='$cols' rows='$rows' readonly='readonly'>" .
                                htmlspecialchars( $source ) . "\n</textarea>";
                        $this->addHTML( $text );
                }
@@ -491,6 +552,7 @@ class OutputPage {
                $this->setPageTitle( wfMsg( "internalerror" ) );
                $this->setRobotpolicy( "noindex,nofollow" );
                $this->setArticleRelated( false );
+               $this->enableClientCache( false );
 
                $this->mBodytext = $message;
                $this->output();
@@ -522,9 +584,13 @@ class OutputPage {
                $this->fatalError( wfMsg( "filenotfound", $name ) );
        }
 
-       function returnToMain( $auto = true )
+       function returnToMain( $auto = true, $returnto = NULL )
        {
-               global $wgUser, $wgOut, $returnto;
+               global $wgUser, $wgOut, $wgRequest;
+               
+               if ( $returnto == NULL ) {
+                       $returnto = $wgRequest->getText( 'returnto' );
+               }
 
                $sk = $wgUser->getSkin();
                if ( "" == $returnto ) {
@@ -534,24 +600,79 @@ class OutputPage {
 
                $r = wfMsg( "returnto", $link );
                if ( $auto ) {
-                       $wgOut->addMeta( "http:Refresh", "10;url=" .
-                         wfLocalUrlE( wfUrlencode( $returnto ) ) );
+                       $titleObj = Title::newFromText( $returnto );
+                       $wgOut->addMeta( "http:Refresh", "10;url=" . $titleObj->escapeFullURL() );
                }
-               $wgOut->addHTML( "\n<p>$r\n" );
+               $wgOut->addHTML( "\n<p>$r</p>\n" );
+       }
+
+       # This function takes the existing and broken links for the page
+       # and uses the first 10 of them for META keywords
+       function addMetaTags ()
+       {
+               global $wgLinkCache , $wgOut ;
+               $good = array_keys ( $wgLinkCache->mGoodLinks ) ;
+               $bad = array_keys ( $wgLinkCache->mBadLinks ) ;
+               $a = array_merge ( $good , $bad ) ;
+               $a = array_slice ( $a , 0 , 10 ) ; # 10 keywords max
+               $a = implode ( "," , $a ) ;
+               $strip = array(
+                       "/<.*?>/" => '',
+                       "/[_]/" => ' '
+               );
+               $a = htmlspecialchars(preg_replace(array_keys($strip), array_values($strip),$a ));
+               
+               $wgOut->addMeta ( "KEYWORDS" , $a ) ;
        }
 
        /* private */ function headElement()
        {
-               global $wgDocType, $wgDTD, $wgUser, $wgLanguageCode, $wgOutputEncoding, $wgLang;
+               global $wgDocType, $wgDTD, $wgLanguageCode, $wgOutputEncoding, $wgMimeType;
+               global $wgUser, $wgLang, $wgRequest;
 
-               $ret = "<!DOCTYPE HTML PUBLIC \"$wgDocType\"\n        \"$wgDTD\">\n";
+               $xml = ($wgMimeType == 'text/xml');
+               if( $xml ) {
+                       $ret = "<" . "?xml version=\"1.0\" encoding=\"$wgOutputEncoding\" ?" . ">\n";
+               } else {
+                       $ret = "";
+               }
+               
+               $ret .= "<!DOCTYPE html PUBLIC \"$wgDocType\"\n        \"$wgDTD\">\n";
 
                if ( "" == $this->mHTMLtitle ) {
-                       $this->mHTMLtitle = $this->mPagetitle;
+                       $this->mHTMLtitle = wfMsg( "pagetitle", $this->mPagetitle );
+               }
+               if( $xml ) {
+                       $xmlbits = "xmlns=\"http://www.w3.org/1999/xhtml\" xml:lang=\"en\"";
+               } else {
+                       $xmlbits = "";
                }
                $rtl = $wgLang->isRTL() ? " dir='RTL'" : "";
-               $ret .= "<html lang=\"$wgLanguageCode\"$rtl><head><title>{$this->mHTMLtitle}</title>\n";
-               array_push( $this->mMetatags, array( "http:Content-type", "text/html; charset={$wgOutputEncoding}" ) );
+               $ret .= "<html $xmlbits lang=\"$wgLanguageCode\" $rtl>\n";
+               $ret .= "<head>\n<title>" . htmlspecialchars( $this->mHTMLtitle ) . "</title>\n";
+               array_push( $this->mMetatags, array( "http:Content-type", "$wgMimeType; charset={$wgOutputEncoding}" ) );
+               
+               $ret .= $this->getHeadLinks();
+               global $wgStylePath;
+               if( $this->isPrintable() ) {
+                       $media = "";
+               } else {
+                       $media = "media='print'";
+               }
+               $printsheet = htmlspecialchars( "$wgStylePath/wikiprintable.css" );
+               $ret .= "<link rel='stylesheet' type='text/css' $media href='$printsheet' />\n";
+
+               $sk = $wgUser->getSkin();
+               $ret .= $sk->getHeadScripts();
+               $ret .= $sk->getUserStyles();
+
+               $ret .= "</head>\n";
+               return $ret;
+       }
+       
+       function getHeadLinks() {
+               global $wgRequest, $wgStylePath;
+               $ret = "";
                foreach ( $this->mMetatags as $tag ) {
                        if ( 0 == strcasecmp( "http:", substr( $tag[0], 0, 5 ) ) ) {
                                $a = "http-equiv";
@@ -559,27 +680,37 @@ class OutputPage {
                        } else {
                                $a = "name";
                        }
-                       $ret .= "<meta $a=\"{$tag[0]}\" content=\"{$tag[1]}\">\n";
+                       $ret .= "<meta $a=\"{$tag[0]}\" content=\"{$tag[1]}\" />\n";
                }
                $p = $this->mRobotpolicy;
                if ( "" == $p ) { $p = "index,follow"; }
-               $ret .= "<meta name=\"robots\" content=\"$p\">\n";
+               $ret .= "<meta name=\"robots\" content=\"$p\" />\n";
 
                if ( count( $this->mKeywords ) > 0 ) {
+                       $strip = array(
+                               "/<.*?>/" => '',
+                               "/[_]/" => ' '
+                       );
                        $ret .= "<meta name=\"keywords\" content=\"" .
-                         implode( ",", $this->mKeywords ) . "\">\n";
+                         htmlspecialchars(preg_replace(array_keys($strip), array_values($strip),implode( ",", $this->mKeywords ))) . "\" />\n";
                }
                foreach ( $this->mLinktags as $tag ) {
-                       $ret .= "<link ";
-                       if ( "" != $tag[0] ) { $ret .= "rel=\"{$tag[0]}\" "; }
-                       if ( "" != $tag[1] ) { $ret .= "rev=\"{$tag[1]}\" "; }
-                       $ret .= "href=\"{$tag[2]}\">\n";
+                       $ret .= "<link";
+                       foreach( $tag as $attr => $val ) {
+                               $ret .= " $attr=\"" . htmlspecialchars( $val ) . "\"";
+                       }
+                       $ret .= " />\n";
                }
-               $sk = $wgUser->getSkin();
-               $ret .= $sk->getHeadScripts();
-               $ret .= $sk->getUserStyles();
-
-               $ret .= "</head>\n";
+               if( $this->isSyndicated() ) {
+                       # FIXME: centralize the mime-type and name information in Feed.php
+                       $link = $wgRequest->escapeAppendQuery( "feed=rss" );
+                       $ret .= "<link rel='alternate' type='application/rss+xml' title='RSS 2.0' href='$link' />\n";
+                       $link = $wgRequest->escapeAppendQuery( "feed=atom" );
+                       $ret .= "<link rel='alternate' type='application/rss+atom' title='Atom 0.3' href='$link' />\n";
+               }
+               # FIXME: get these working
+               # $fix = htmlspecialchars( $wgStylePath . "/ie-png-fix.js" );
+               # $ret .= "<!--[if gte IE 5.5000]><script type='text/javascript' src='$fix'></script><![endif]-->";
                return $ret;
        }
 }