[FileBackend] Added getScopedLocksForOps() function.
[lhc/web/wiklou.git] / includes / api / ApiQueryRevisions.php
index 2208c5b..fa58bdf 100644 (file)
@@ -1,6 +1,6 @@
 <?php
 /**
- * API for MediaWiki 1.8+
+ *
  *
  * Created on Sep 7, 2006
  *
  * @file
  */
 
-if ( !defined( 'MEDIAWIKI' ) ) {
-       // Eclipse helper - will be ignored in production
-       require_once( 'ApiQueryBase.php' );
-}
-
 /**
  * A query action to enumerate revisions of a given page, or show top revisions of multiple pages.
  * Various pieces of information may be shown - flags, comments, and the actual wiki markup of the rev.
@@ -39,7 +34,7 @@ if ( !defined( 'MEDIAWIKI' ) ) {
 class ApiQueryRevisions extends ApiQueryBase {
 
        private $diffto, $difftotext, $expandTemplates, $generateXML, $section,
-               $token;
+               $token, $parseContent;
 
        public function __construct( $query, $moduleName ) {
                parent::__construct( $query, $moduleName, 'rv' );
@@ -73,12 +68,19 @@ class ApiQueryRevisions extends ApiQueryBase {
                return $this->tokenFunctions;
        }
 
+       /**
+        * @param $pageid
+        * @param $title Title
+        * @param $rev Revision
+        * @return bool|String
+        */
        public static function getRollbackToken( $pageid, $title, $rev ) {
                global $wgUser;
                if ( !$wgUser->isAllowed( 'rollback' ) ) {
                        return false;
                }
-               return Token::prepare( array( $title->getPrefixedText(), $rev->getUserText() ) );
+               return $wgUser->getEditToken(
+                       array( $title->getPrefixedText(), $rev->getUserText() ) );
        }
 
        public function execute() {
@@ -118,8 +120,7 @@ class ApiQueryRevisions extends ApiQueryBase {
                                $params['diffto'] = 0;
                        }
                        if ( ( !ctype_digit( $params['diffto'] ) || $params['diffto'] < 0 )
-                                       && $params['diffto'] != 'prev' && $params['diffto'] != 'next' )
-                       {
+                                       && $params['diffto'] != 'prev' && $params['diffto'] != 'next' ) {
                                $this->dieUsage( 'rvdiffto must be set to a non-negative number, "prev", "next" or "cur"', 'diffto' );
                        }
                        // Check whether the revision exists and is readable,
@@ -130,7 +131,7 @@ class ApiQueryRevisions extends ApiQueryBase {
                                if ( !$difftoRev ) {
                                        $this->dieUsageMsg( array( 'nosuchrevid', $params['diffto'] ) );
                                }
-                               if ( !$difftoRev->userCan( Revision::DELETED_TEXT ) ) {
+                               if ( $difftoRev->isDeleted( Revision::DELETED_TEXT ) ) {
                                        $this->setWarning( "Couldn't diff to r{$difftoRev->getID()}: content is hidden" );
                                        $params['diffto'] = null;
                                }
@@ -153,6 +154,7 @@ class ApiQueryRevisions extends ApiQueryBase {
                $this->fld_comment = isset ( $prop['comment'] );
                $this->fld_parsedcomment = isset ( $prop['parsedcomment'] );
                $this->fld_size = isset ( $prop['size'] );
+               $this->fld_sha1 = isset ( $prop['sha1'] );
                $this->fld_userid = isset( $prop['userid'] );
                $this->fld_user = isset ( $prop['user'] );
                $this->token = $params['token'];
@@ -168,7 +170,6 @@ class ApiQueryRevisions extends ApiQueryBase {
                        $this->getResult()->setParsedLimit( $this->getModuleName(), $limit );
                }
 
-               
                if ( !is_null( $this->token ) || $pageCount > 0 ) {
                        $this->addFields( Revision::selectPageFields() );
                }
@@ -191,7 +192,7 @@ class ApiQueryRevisions extends ApiQueryBase {
                if ( isset( $prop['content'] ) || !is_null( $this->difftotext ) ) {
                        // For each page we will request, the user must have read rights for that page
                        foreach ( $pageSet->getGoodTitles() as $title ) {
-                               if ( !$title->userCanRead() ) {
+                               if ( !$title->userCan( 'read' ) ) {
                                        $this->dieUsage(
                                                'The current user is not allowed to read ' . $title->getPrefixedText(),
                                                'accessdenied' );
@@ -223,10 +224,9 @@ class ApiQueryRevisions extends ApiQueryBase {
                        }
                }
 
-               //Bug 24166 - API error when using rvprop=tags
+               // Bug 24166 - API error when using rvprop=tags
                $this->addTables( 'revision' );
 
-
                if ( $enumRevMode ) {
                        // This is mostly to prevent parameter errors (and optimize SQL?)
                        if ( !is_null( $params['startid'] ) && !is_null( $params['start'] ) ) {
@@ -248,14 +248,14 @@ class ApiQueryRevisions extends ApiQueryBase {
                        // one row with the same timestamp for the same page.
                        // The order needs to be the same as start parameter to avoid SQL filesort.
                        if ( is_null( $params['startid'] ) && is_null( $params['endid'] ) ) {
-                               $this->addWhereRange( 'rev_timestamp', $params['dir'],
+                               $this->addTimestampWhereRange( 'rev_timestamp', $params['dir'],
                                        $params['start'], $params['end'] );
                        } else {
                                $this->addWhereRange( 'rev_id', $params['dir'],
                                        $params['startid'], $params['endid'] );
                                // One of start and end can be set
                                // If neither is set, this does nothing
-                               $this->addWhereRange( 'rev_timestamp', $params['dir'],
+                               $this->addTimestampWhereRange( 'rev_timestamp', $params['dir'],
                                        $params['start'], $params['end'], false );
                        }
 
@@ -405,8 +405,20 @@ class ApiQueryRevisions extends ApiQueryBase {
                        $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $revision->getTimestamp() );
                }
 
-               if ( $this->fld_size && !is_null( $revision->getSize() ) ) {
-                       $vals['size'] = intval( $revision->getSize() );
+               if ( $this->fld_size ) {
+                       if ( !is_null( $revision->getSize() ) ) {
+                               $vals['size'] = intval( $revision->getSize() );
+                       } else {
+                               $vals['size'] = 0;
+                       }
+               }
+
+               if ( $this->fld_sha1 ) {
+                       if ( $revision->getSha1() != '' ) {
+                               $vals['sha1'] = wfBaseConvert( $revision->getSha1(), 36, 16, 40 );
+                       } else {
+                               $vals['sha1'] = '';
+                       }
                }
 
                if ( $this->fld_comment || $this->fld_parsedcomment ) {
@@ -420,8 +432,7 @@ class ApiQueryRevisions extends ApiQueryBase {
                                }
 
                                if ( $this->fld_parsedcomment ) {
-                                       global $wgUser;
-                                       $vals['parsedcomment'] = $wgUser->getSkin()->formatComment( $comment, $title );
+                                       $vals['parsedcomment'] = Linker::formatComment( $comment, $title );
                                }
                        }
                }
@@ -464,7 +475,7 @@ class ApiQueryRevisions extends ApiQueryBase {
                }
                if ( $this->fld_content && !$revision->isDeleted( Revision::DELETED_TEXT ) ) {
                        if ( $this->generateXML ) {
-                               $wgParser->startExternalParse( $title, new ParserOptions(), OT_PREPROCESS );
+                               $wgParser->startExternalParse( $title, ParserOptions::newFromContext( $this->getContext() ), OT_PREPROCESS );
                                $dom = $wgParser->preprocessToDom( $text );
                                if ( is_callable( array( $dom, 'saveXML' ) ) ) {
                                        $xml = $dom->saveXML();
@@ -475,30 +486,10 @@ class ApiQueryRevisions extends ApiQueryBase {
 
                        }
                        if ( $this->expandTemplates && !$this->parseContent ) {
-                               $text = $wgParser->preprocess( $text, $title, new ParserOptions() );
+                               $text = $wgParser->preprocess( $text, $title, ParserOptions::newFromContext( $this->getContext() ) );
                        }
                        if ( $this->parseContent ) {
-                               global $wgEnableParserCache;
-                       
-                               $popts = new ParserOptions();
-                               $popts->setTidy( true );
-                               
-                               $articleObj = new Article( $title );
-
-                               $p_result = false;
-                               $pcache = ParserCache::singleton();
-                               if ( $wgEnableParserCache ) {
-                                       $p_result = $pcache->get( $articleObj, $popts );
-                               }
-                               if ( !$p_result ) {
-                                       $p_result = $wgParser->parse( $text, $title, $popts );
-
-                                       if ( $wgEnableParserCache ) {
-                                               $pcache->save( $p_result, $articleObj, $popts );
-                                       }
-                               }
-                               
-                               $text = $p_result->getText();
+                               $text = $wgParser->parse( $text, $title, ParserOptions::newFromContext( $this->getContext() ) )->getText();
                        }
                        ApiResult::setContent( $vals, $text );
                } elseif ( $this->fld_content ) {
@@ -510,11 +501,13 @@ class ApiQueryRevisions extends ApiQueryBase {
                        static $n = 0; // Number of uncached diffs we've had
                        if ( $n < $wgAPIMaxUncachedDiffs ) {
                                $vals['diff'] = array();
+                               $context = new DerivativeContext( $this->getContext() );
+                               $context->setTitle( $title );
                                if ( !is_null( $this->difftotext ) ) {
-                                       $engine = new DifferenceEngine( $title );
+                                       $engine = new DifferenceEngine( $context );
                                        $engine->setText( $text, $this->difftotext );
                                } else {
-                                       $engine = new DifferenceEngine( $title, $revision->getID(), $this->diffto );
+                                       $engine = new DifferenceEngine( $context, $revision->getID(), $this->diffto );
                                        $vals['diff']['from'] = $engine->getOldid();
                                        $vals['diff']['to'] = $engine->getNewid();
                                }
@@ -553,6 +546,7 @@ class ApiQueryRevisions extends ApiQueryBase {
                                        'user',
                                        'userid',
                                        'size',
+                                       'sha1',
                                        'comment',
                                        'parsedcomment',
                                        'content',
@@ -615,7 +609,8 @@ class ApiQueryRevisions extends ApiQueryBase {
                                ' timestamp      - The timestamp of the revision',
                                ' user           - User that made the revision',
                                ' userid         - User id of revision creator',
-                               ' size           - Length of the revision',
+                               ' size           - Length (bytes) of the revision',
+                               ' sha1           - SHA-1 (base 16) of the revision',
                                ' comment        - Comment by the user for revision',
                                ' parsedcomment  - Parsed comment by the user for the revision',
                                ' content        - Text of the revision',
@@ -626,9 +621,9 @@ class ApiQueryRevisions extends ApiQueryBase {
                        'endid' => 'Stop revision enumeration on this revid (enum)',
                        'start' => 'From which revision timestamp to start enumeration (enum)',
                        'end' => 'Enumerate up to this timestamp (enum)',
-                       'dir' => 'Direction of enumeration - towards "newer" or "older" revisions (enum)',
-                       'user' => 'Only include revisions made by user',
-                       'excludeuser' => 'Exclude revisions made by user',
+                       'dir' => $this->getDirectionDescription( $p, ' (enum)' ),
+                       'user' => 'Only include revisions made by user (enum)',
+                       'excludeuser' => 'Exclude revisions made by user (enum)',
                        'expandtemplates' => 'Expand templates in revision content',
                        'generatexml' => 'Generate XML parse tree for revision content',
                        'parse' => 'Parse revision content. For performance reasons if this option is used, rvlimit is enforced to 1.',
@@ -646,7 +641,7 @@ class ApiQueryRevisions extends ApiQueryBase {
        public function getDescription() {
                return array(
                        'Get revision information',
-                       'This module may be used in several ways:',
+                       'May be used in several ways:',
                        ' 1) Get data about a set of pages (last revision), by setting titles or pageids parameter',
                        ' 2) Get revisions for one given page, by using titles/pageids with start/end/limit params',
                        ' 3) Get data about a set of revisions by setting their IDs with revids parameter',
@@ -667,15 +662,15 @@ class ApiQueryRevisions extends ApiQueryBase {
                ) );
        }
 
-       protected function getExamples() {
+       public function getExamples() {
                return array(
-                       'Get data with content for the last revision of titles "API" and "Main Page":',
+                       'Get data with content for the last revision of titles "API" and "Main Page"',
                        '  api.php?action=query&prop=revisions&titles=API|Main%20Page&rvprop=timestamp|user|comment|content',
-                       'Get last 5 revisions of the "Main Page":',
+                       'Get last 5 revisions of the "Main Page"',
                        '  api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment',
-                       'Get first 5 revisions of the "Main Page":',
+                       'Get first 5 revisions of the "Main Page"',
                        '  api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvdir=newer',
-                       'Get first 5 revisions of the "Main Page" made after 2006-05-01:',
+                       'Get first 5 revisions of the "Main Page" made after 2006-05-01',
                        '  api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvdir=newer&rvstart=20060501000000',
                        'Get first 5 revisions of the "Main Page" that were not made made by anonymous user "127.0.0.1"',
                        '  api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvexcludeuser=127.0.0.1',
@@ -684,6 +679,10 @@ class ApiQueryRevisions extends ApiQueryBase {
                );
        }
 
+       public function getHelpUrls() {
+               return 'https://www.mediawiki.org/wiki/API:Properties#revisions_.2F_rv';
+       }
+
        public function getVersion() {
                return __CLASS__ . ': $Id$';
        }