Merge "Correct case for the "MediaWiki:Revdelete-reason-dropdown" link in Special...
[lhc/web/wiklou.git] / includes / api / ApiQueryRevisions.php
index 0031a52..1a5ad17 100644 (file)
  * @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.
@@ -84,8 +79,8 @@ class ApiQueryRevisions extends ApiQueryBase {
                if ( !$wgUser->isAllowed( 'rollback' ) ) {
                        return false;
                }
-               return $wgUser->editToken( array( $title->getPrefixedText(),
-                                               $rev->getUserText() ) );
+               return $wgUser->getEditToken(
+                       array( $title->getPrefixedText(), $rev->getUserText() ) );
        }
 
        public function execute() {
@@ -136,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;
                                }
@@ -159,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'];
@@ -196,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' );
@@ -228,6 +224,13 @@ class ApiQueryRevisions extends ApiQueryBase {
                        }
                }
 
+               // add user name, if needed
+               if ( $this->fld_user ) {
+                       $this->addTables( 'user' );
+                       $this->addJoinConds( array( 'user' => Revision::userJoinCond() ) );
+                       $this->addFields( Revision::selectUserFields() );
+               }
+
                // Bug 24166 - API error when using rvprop=tags
                $this->addTables( 'revision' );
 
@@ -252,14 +255,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 );
                        }
 
@@ -294,7 +297,7 @@ class ApiQueryRevisions extends ApiQueryBase {
                        $this->addWhereFld( 'rev_id', array_keys( $revs ) );
 
                        if ( !is_null( $params['continue'] ) ) {
-                               $this->addWhere( "rev_id >= '" . intval( $params['continue'] ) . "'" );
+                               $this->addWhere( 'rev_id >= ' . intval( $params['continue'] ) );
                        }
                        $this->addOption( 'ORDER BY', 'rev_id' );
 
@@ -326,12 +329,15 @@ class ApiQueryRevisions extends ApiQueryBase {
                                $pageid = intval( $cont[0] );
                                $revid = intval( $cont[1] );
                                $this->addWhere(
-                                       "rev_page > '$pageid' OR " .
-                                       "(rev_page = '$pageid' AND " .
-                                       "rev_id >= '$revid')"
+                                       "rev_page > $pageid OR " .
+                                       "(rev_page = $pageid AND " .
+                                       "rev_id >= $revid)"
                                );
                        }
-                       $this->addOption( 'ORDER BY', 'rev_page, rev_id' );
+                       $this->addOption( 'ORDER BY', array(
+                               'rev_page',
+                               'rev_id'
+                       ));
 
                        // assumption testing -- we should never get more then $pageCount rows.
                        $limit = $pageCount;
@@ -409,8 +415,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 ) {
@@ -424,8 +442,7 @@ class ApiQueryRevisions extends ApiQueryBase {
                                }
 
                                if ( $this->fld_parsedcomment ) {
-                                       global $wgUser;
-                                       $vals['parsedcomment'] = $wgUser->getSkin()->formatComment( $comment, $title );
+                                       $vals['parsedcomment'] = Linker::formatComment( $comment, $title );
                                }
                        }
                }
@@ -468,7 +485,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();
@@ -479,10 +496,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 ) {
-                               $text = $wgParser->parse( $text, $title, new ParserOptions() )->getText();
+                               $text = $wgParser->parse( $text, $title, ParserOptions::newFromContext( $this->getContext() ) )->getText();
                        }
                        ApiResult::setContent( $vals, $text );
                } elseif ( $this->fld_content ) {
@@ -494,11 +511,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();
                                }
@@ -537,6 +556,7 @@ class ApiQueryRevisions extends ApiQueryBase {
                                        'user',
                                        'userid',
                                        'size',
+                                       'sha1',
                                        'comment',
                                        'parsedcomment',
                                        'content',
@@ -599,7 +619,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',
@@ -610,9 +631,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' => $this->getDirectionDescription( $p ),
-                       '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.',
@@ -627,6 +648,66 @@ class ApiQueryRevisions extends ApiQueryBase {
                );
        }
 
+       public function getResultProperties() {
+               $props = array(
+                       '' => array(),
+                       'ids' => array(
+                               'revid' => 'integer',
+                               'parentid' => array(
+                                       ApiBase::PROP_TYPE => 'integer',
+                                       ApiBase::PROP_NULLABLE => true
+                               )
+                       ),
+                       'flags' => array(
+                               'minor' => 'boolean'
+                       ),
+                       'user' => array(
+                               'userhidden' => 'boolean',
+                               'user' => 'string',
+                               'anon' => 'boolean'
+                       ),
+                       'userid' => array(
+                               'userhidden' => 'boolean',
+                               'userid' => 'integer',
+                               'anon' => 'boolean'
+                       ),
+                       'timestamp' => array(
+                               'timestamp' => 'timestamp'
+                       ),
+                       'size' => array(
+                               'size' => 'integer'
+                       ),
+                       'sha1' => array(
+                               'sha1' => 'string'
+                       ),
+                       'comment' => array(
+                               'commenthidden' => 'boolean',
+                               'comment' => array(
+                                       ApiBase::PROP_TYPE => 'string',
+                                       ApiBase::PROP_NULLABLE => true
+                               )
+                       ),
+                       'parsedcomment' => array(
+                               'commenthidden' => 'boolean',
+                               'parsedcomment' => array(
+                                       ApiBase::PROP_TYPE => 'string',
+                                       ApiBase::PROP_NULLABLE => true
+                               )
+                       ),
+                       'content' => array(
+                               '*' => array(
+                                       ApiBase::PROP_TYPE => 'string',
+                                       ApiBase::PROP_NULLABLE => true
+                               ),
+                               'texthidden' => 'boolean'
+                       )
+               );
+
+               self::addTokenProperties( $props, $this->getTokenFunctions() );
+
+               return $props;
+       }
+
        public function getDescription() {
                return array(
                        'Get revision information',
@@ -653,13 +734,13 @@ class ApiQueryRevisions extends ApiQueryBase {
 
        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',
@@ -669,7 +750,7 @@ class ApiQueryRevisions extends ApiQueryBase {
        }
 
        public function getHelpUrls() {
-               return 'http://www.mediawiki.org/wiki/API:Properties#revisions_.2F_rv';
+               return 'https://www.mediawiki.org/wiki/API:Properties#revisions_.2F_rv';
        }
 
        public function getVersion() {