includes/actions/RawAction.php

   1 <?php
   2 /**
   3  * Raw page text accessor
   4  *
   5  * Copyright © 2004 Gabriel Wicke <wicke@wikidev.net>
   6  * http://wikidev.net/
   7  *
   8  * Based on HistoryAction and SpecialExport
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License along
  21  * with this program; if not, write to the Free Software Foundation, Inc.,
  22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  23  * http://www.gnu.org/copyleft/gpl.html
  24  *
  25  * @author Gabriel Wicke <wicke@wikidev.net>
  26  * @file
  27  */
  28
  29 /**
  30  * A simple method to retrieve the plain source of an article,
  31  * using "action=raw" in the GET request string.
  32  *
  33  * @ingroup Actions
  34  */
  35 class RawAction extends FormlessAction {
  36         private $mGen;
  37
  38         public function getName() {
  39                 return 'raw';
  40         }
  41
  42         public function requiresWrite() {
  43                 return false;
  44         }
  45
  46         public function requiresUnblock() {
  47                 return false;
  48         }
  49
  50         function onView() {
  51                 $this->getOutput()->disable();
  52                 $request = $this->getRequest();
  53                 $config = $this->context->getConfig();
  54
  55                 if ( !$request->checkUrlExtension() ) {
  56                         return;
  57                 }
  58
  59                 if ( $this->getOutput()->checkLastModified( $this->page->getTouched() ) ) {
  60                         return; // Client cache fresh and headers sent, nothing more to do.
  61                 }
  62
  63                 # special case for 'generated' raw things: user css/js
  64                 # This is deprecated and will only return empty content
  65                 $gen = $request->getVal( 'gen' );
  66                 $smaxage = $request->getIntOrNull( 'smaxage' );
  67
  68                 if ( $gen == 'css' || $gen == 'js' ) {
  69                         $this->mGen = $gen;
  70                         if ( $smaxage === null ) {
  71                                 $smaxage = $config->get( 'SquidMaxage' );
  72                         }
  73                 } else {
  74                         $this->mGen = false;
  75                 }
  76
  77                 $contentType = $this->getContentType();
  78
  79                 # Force caching for CSS and JS raw content, default: 5 minutes.
  80                 # Note: If using a canonical url for userpage css/js, we send an HTCP purge.
  81                 if ( $smaxage === null ) {
  82                         if ( $contentType == 'text/css' || $contentType == 'text/javascript' ) {
  83                                 $smaxage = intval( $config->get( 'ForcedRawSMaxage' ) );
  84                         } else {
  85                                 $smaxage = 0;
  86                         }
  87                 }
  88
  89                 $maxage = $request->getInt( 'maxage', $config->get( 'SquidMaxage' ) );
  90
  91                 $response = $request->response();
  92
  93                 $response->header( 'Content-type: ' . $contentType . '; charset=UTF-8' );
  94                 # Output may contain user-specific data;
  95                 # vary generated content for open sessions on private wikis
  96                 $privateCache = !User::isEveryoneAllowed( 'read' ) && ( $smaxage == 0 || session_id() != '' );
  97                 // Bug 53032 - make this private if user is logged in,
  98                 // so we don't accidentally cache cookies
  99                 $privateCache = $privateCache ?: $this->getUser()->isLoggedIn();
 100                 # allow the client to cache this for 24 hours
 101                 $mode = $privateCache ? 'private' : 'public';
 102                 $response->header(
 103                         'Cache-Control: ' . $mode . ', s-maxage=' . $smaxage . ', max-age=' . $maxage
 104                 );
 105
 106                 $text = $this->getRawText();
 107
 108                 if ( $text === false && $contentType == 'text/x-wiki' ) {
 109                         # Don't return a 404 response for CSS or JavaScript;
 110                         # 404s aren't generally cached and it would create
 111                         # extra hits when user CSS/JS are on and the user doesn't
 112                         # have the pages.
 113                         $response->header( 'HTTP/1.x 404 Not Found' );
 114                 }
 115
 116                 if ( !wfRunHooks( 'RawPageViewBeforeOutput', array( &$this, &$text ) ) ) {
 117                         wfDebug( __METHOD__ . ": RawPageViewBeforeOutput hook broke raw page output.\n" );
 118                 }
 119
 120                 echo $text;
 121         }
 122
 123         /**
 124          * Get the text that should be returned, or false if the page or revision
 125          * was not found.
 126          *
 127          * @return string|bool
 128          */
 129         public function getRawText() {
 130                 global $wgParser;
 131
 132                 # No longer used
 133                 if ( $this->mGen ) {
 134                         return '';
 135                 }
 136
 137                 $text = false;
 138                 $title = $this->getTitle();
 139                 $request = $this->getRequest();
 140
 141                 // If it's a MediaWiki message we can just hit the message cache
 142                 if ( $request->getBool( 'usemsgcache' ) && $title->getNamespace() == NS_MEDIAWIKI ) {
 143                         // The first "true" is to use the database, the second is to use
 144                         // the content langue and the last one is to specify the message
 145                         // key already contains the language in it ("/de", etc.).
 146                         $text = MessageCache::singleton()->get( $title->getDBkey(), true, true, true );
 147                         // If the message doesn't exist, return a blank
 148                         if ( $text === false ) {
 149                                 $text = '';
 150                         }
 151                 } else {
 152                         // Get it from the DB
 153                         $rev = Revision::newFromTitle( $title, $this->getOldId() );
 154                         if ( $rev ) {
 155                                 $lastmod = wfTimestamp( TS_RFC2822, $rev->getTimestamp() );
 156                                 $request->response()->header( "Last-modified: $lastmod" );
 157
 158                                 // Public-only due to cache headers
 159                                 $content = $rev->getContent();
 160
 161                                 if ( $content === null ) {
 162                                         // revision not found (or suppressed)
 163                                         $text = false;
 164                                 } elseif ( !$content instanceof TextContent ) {
 165                                         // non-text content
 166                                         wfHttpError( 415, "Unsupported Media Type", "The requested page uses the content model `"
 167                                                 . $content->getModel() . "` which is not supported via this interface." );
 168                                         die();
 169                                 } else {
 170                                         // want a section?
 171                                         $section = $request->getIntOrNull( 'section' );
 172                                         if ( $section !== null ) {
 173                                                 $content = $content->getSection( $section );
 174                                         }
 175
 176                                         if ( $content === null || $content === false ) {
 177                                                 // section not found (or section not supported, e.g. for JS and CSS)
 178                                                 $text = false;
 179                                         } else {
 180                                                 $text = $content->getNativeData();
 181                                         }
 182                                 }
 183                         }
 184                 }
 185
 186                 if ( $text !== false && $text !== '' && $request->getVal( 'templates' ) === 'expand' ) {
 187                         $text = $wgParser->preprocess(
 188                                 $text,
 189                                 $title,
 190                                 ParserOptions::newFromContext( $this->getContext() )
 191                         );
 192                 }
 193
 194                 return $text;
 195         }
 196
 197         /**
 198          * Get the ID of the revision that should used to get the text.
 199          *
 200          * @return int
 201          */
 202         public function getOldId() {
 203                 $oldid = $this->getRequest()->getInt( 'oldid' );
 204                 switch ( $this->getRequest()->getText( 'direction' ) ) {
 205                         case 'next':
 206                                 # output next revision, or nothing if there isn't one
 207                                 $nextid = 0;
 208                                 if ( $oldid ) {
 209                                         $nextid = $this->getTitle()->getNextRevisionID( $oldid );
 210                                 }
 211                                 $oldid = $nextid ?: -1;
 212                                 break;
 213                         case 'prev':
 214                                 # output previous revision, or nothing if there isn't one
 215                                 if ( !$oldid ) {
 216                                         # get the current revision so we can get the penultimate one
 217                                         $oldid = $this->page->getLatest();
 218                                 }
 219                                 $previd = $this->getTitle()->getPreviousRevisionID( $oldid );
 220                                 $oldid = $previd ?: -1;
 221                                 break;
 222                         case 'cur':
 223                                 $oldid = 0;
 224                                 break;
 225                 }
 226
 227                 return $oldid;
 228         }
 229
 230         /**
 231          * Get the content type to use for the response
 232          *
 233          * @return string
 234          */
 235         public function getContentType() {
 236                 $ctype = $this->getRequest()->getVal( 'ctype' );
 237
 238                 if ( $ctype == '' ) {
 239                         $gen = $this->getRequest()->getVal( 'gen' );
 240                         if ( $gen == 'js' ) {
 241                                 $ctype = 'text/javascript';
 242                         } elseif ( $gen == 'css' ) {
 243                                 $ctype = 'text/css';
 244                         }
 245                 }
 246
 247                 $allowedCTypes = array( 'text/x-wiki', 'text/javascript', 'text/css', 'application/x-zope-edit' );
 248                 if ( $ctype == '' || !in_array( $ctype, $allowedCTypes ) ) {
 249                         $ctype = 'text/x-wiki';
 250                 }
 251
 252                 return $ctype;
 253         }
 254 }