[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3   * Raw page text accessor
   4   *
   5   * Copyright © 2004 Gabriel Wicke <[email protected]>
   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 <[email protected]>
  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      /**
  37       * @var bool Does the request include a gen=css|javascript parameter
  38       * @deprecated This used to be a string for "css" or "javascript" but
  39       * it is no longer used. Setting this parameter results in empty content
  40       * being served
  41       */
  42      private $gen = false;
  43  
  44  	public function getName() {
  45          return 'raw';
  46      }
  47  
  48  	public function requiresWrite() {
  49          return false;
  50      }
  51  
  52  	public function requiresUnblock() {
  53          return false;
  54      }
  55  
  56  	function onView() {
  57          $this->getOutput()->disable();
  58          $request = $this->getRequest();
  59          $config = $this->context->getConfig();
  60  
  61          if ( !$request->checkUrlExtension() ) {
  62              return;
  63          }
  64  
  65          if ( $this->getOutput()->checkLastModified( $this->page->getTouched() ) ) {
  66              return; // Client cache fresh and headers sent, nothing more to do.
  67          }
  68  
  69          # special case for 'generated' raw things: user css/js
  70          # This is deprecated and will only return empty content
  71          $gen = $request->getVal( 'gen' );
  72          $smaxage = $request->getIntOrNull( 'smaxage' );
  73  
  74          if ( $gen == 'css' || $gen == 'js' ) {
  75              $this->gen = true;
  76              if ( $smaxage === null ) {
  77                  $smaxage = $config->get( 'SquidMaxage' );
  78              }
  79          }
  80  
  81          $contentType = $this->getContentType();
  82  
  83          # Force caching for CSS and JS raw content, default: 5 minutes.
  84          # Note: If using a canonical url for userpage css/js, we send an HTCP purge.
  85          if ( $smaxage === null ) {
  86              if ( $contentType == 'text/css' || $contentType == 'text/javascript' ) {
  87                  $smaxage = intval( $config->get( 'ForcedRawSMaxage' ) );
  88              } else {
  89                  $smaxage = 0;
  90              }
  91          }
  92  
  93          $maxage = $request->getInt( 'maxage', $config->get( 'SquidMaxage' ) );
  94  
  95          $response = $request->response();
  96  
  97          $response->header( 'Content-type: ' . $contentType . '; charset=UTF-8' );
  98          # Output may contain user-specific data;
  99          # vary generated content for open sessions on private wikis
 100          $privateCache = !User::isEveryoneAllowed( 'read' ) && ( $smaxage == 0 || session_id() != '' );
 101          // Bug 53032 - make this private if user is logged in,
 102          // so we don't accidentally cache cookies
 103          $privateCache = $privateCache ?: $this->getUser()->isLoggedIn();
 104          # allow the client to cache this for 24 hours
 105          $mode = $privateCache ? 'private' : 'public';
 106          $response->header(
 107              'Cache-Control: ' . $mode . ', s-maxage=' . $smaxage . ', max-age=' . $maxage
 108          );
 109  
 110          $text = $this->getRawText();
 111  
 112          if ( $text === false && $contentType == 'text/x-wiki' ) {
 113              # Don't return a 404 response for CSS or JavaScript;
 114              # 404s aren't generally cached and it would create
 115              # extra hits when user CSS/JS are on and the user doesn't
 116              # have the pages.
 117              $response->header( 'HTTP/1.x 404 Not Found' );
 118          }
 119  
 120          if ( !wfRunHooks( 'RawPageViewBeforeOutput', array( &$this, &$text ) ) ) {
 121              wfDebug( __METHOD__ . ": RawPageViewBeforeOutput hook broke raw page output.\n" );
 122          }
 123  
 124          echo $text;
 125      }
 126  
 127      /**
 128       * Get the text that should be returned, or false if the page or revision
 129       * was not found.
 130       *
 131       * @return string|bool
 132       */
 133  	public function getRawText() {
 134          global $wgParser;
 135  
 136          # No longer used
 137          if ( $this->gen ) {
 138              return '';
 139          }
 140  
 141          $text = false;
 142          $title = $this->getTitle();
 143          $request = $this->getRequest();
 144  
 145          // If it's a MediaWiki message we can just hit the message cache
 146          if ( $request->getBool( 'usemsgcache' ) && $title->getNamespace() == NS_MEDIAWIKI ) {
 147              // The first "true" is to use the database, the second is to use
 148              // the content langue and the last one is to specify the message
 149              // key already contains the language in it ("/de", etc.).
 150              $text = MessageCache::singleton()->get( $title->getDBkey(), true, true, true );
 151              // If the message doesn't exist, return a blank
 152              if ( $text === false ) {
 153                  $text = '';
 154              }
 155          } else {
 156              // Get it from the DB
 157              $rev = Revision::newFromTitle( $title, $this->getOldId() );
 158              if ( $rev ) {
 159                  $lastmod = wfTimestamp( TS_RFC2822, $rev->getTimestamp() );
 160                  $request->response()->header( "Last-modified: $lastmod" );
 161  
 162                  // Public-only due to cache headers
 163                  $content = $rev->getContent();
 164  
 165                  if ( $content === null ) {
 166                      // revision not found (or suppressed)
 167                      $text = false;
 168                  } elseif ( !$content instanceof TextContent ) {
 169                      // non-text content
 170                      wfHttpError( 415, "Unsupported Media Type", "The requested page uses the content model `"
 171                          . $content->getModel() . "` which is not supported via this interface." );
 172                      die();
 173                  } else {
 174                      // want a section?
 175                      $section = $request->getIntOrNull( 'section' );
 176                      if ( $section !== null ) {
 177                          $content = $content->getSection( $section );
 178                      }
 179  
 180                      if ( $content === null || $content === false ) {
 181                          // section not found (or section not supported, e.g. for JS and CSS)
 182                          $text = false;
 183                      } else {
 184                          $text = $content->getNativeData();
 185                      }
 186                  }
 187              }
 188          }
 189  
 190          if ( $text !== false && $text !== '' && $request->getVal( 'templates' ) === 'expand' ) {
 191              $text = $wgParser->preprocess(
 192                  $text,
 193                  $title,
 194                  ParserOptions::newFromContext( $this->getContext() )
 195              );
 196          }
 197  
 198          return $text;
 199      }
 200  
 201      /**
 202       * Get the ID of the revision that should used to get the text.
 203       *
 204       * @return int
 205       */
 206  	public function getOldId() {
 207          $oldid = $this->getRequest()->getInt( 'oldid' );
 208          switch ( $this->getRequest()->getText( 'direction' ) ) {
 209              case 'next':
 210                  # output next revision, or nothing if there isn't one
 211                  $nextid = 0;
 212                  if ( $oldid ) {
 213                      $nextid = $this->getTitle()->getNextRevisionID( $oldid );
 214                  }
 215                  $oldid = $nextid ?: -1;
 216                  break;
 217              case 'prev':
 218                  # output previous revision, or nothing if there isn't one
 219                  if ( !$oldid ) {
 220                      # get the current revision so we can get the penultimate one
 221                      $oldid = $this->page->getLatest();
 222                  }
 223                  $previd = $this->getTitle()->getPreviousRevisionID( $oldid );
 224                  $oldid = $previd ?: -1;
 225                  break;
 226              case 'cur':
 227                  $oldid = 0;
 228                  break;
 229          }
 230  
 231          return $oldid;
 232      }
 233  
 234      /**
 235       * Get the content type to use for the response
 236       *
 237       * @return string
 238       */
 239  	public function getContentType() {
 240          $ctype = $this->getRequest()->getVal( 'ctype' );
 241  
 242          if ( $ctype == '' ) {
 243              $gen = $this->getRequest()->getVal( 'gen' );
 244              if ( $gen == 'js' ) {
 245                  $ctype = 'text/javascript';
 246              } elseif ( $gen == 'css' ) {
 247                  $ctype = 'text/css';
 248              }
 249          }
 250  
 251          $allowedCTypes = array( 'text/x-wiki', 'text/javascript', 'text/css', 'application/x-zope-edit' );
 252          if ( $ctype == '' || !in_array( $ctype, $allowedCTypes ) ) {
 253              $ctype = 'text/x-wiki';
 254          }
 255  
 256          return $ctype;
 257      }
 258  }