From: Roan Kattouw Date: Sun, 20 Jan 2008 13:09:32 +0000 (+0000) Subject: * Refactoring ApiQueryImageInfo to use new File::loadHistory() interface. No change... X-Git-Tag: 1.31.0-rc.0~49887 X-Git-Url: https://git.cyclocoop.org/%28%28?a=commitdiff_plain;h=01a2ae7561614a6540117e275ad02bfed8d538b4;p=lhc%2Fweb%2Fwiklou.git * Refactoring ApiQueryImageInfo to use new File::loadHistory() interface. No change in user-observed behavior --- diff --git a/includes/api/ApiQueryImageInfo.php b/includes/api/ApiQueryImageInfo.php index b52062d0f1..f0a92143bf 100644 --- a/includes/api/ApiQueryImageInfo.php +++ b/includes/api/ApiQueryImageInfo.php @@ -42,20 +42,20 @@ class ApiQueryImageInfo extends ApiQueryBase { public function execute() { $params = $this->extractRequestParams(); - $history = $params['history']; - $prop = array_flip($params['prop']); - $fld_timestamp = isset($prop['timestamp']); - $fld_user = isset($prop['user']); - $fld_comment = isset($prop['comment']); - $fld_url = isset($prop['url']); - $fld_size = isset($prop['size']); - $fld_sha1 = isset($prop['sha1']); - $fld_metadata = isset($prop['metadata']); + $this->fld_timestamp = isset($prop['timestamp']); + $this->fld_user = isset($prop['user']); + $this->fld_comment = isset($prop['comment']); + $this->fld_url = isset($prop['url']); + $this->fld_size = isset($prop['size']); + $this->fld_sha1 = isset($prop['sha1']); + $this->fld_metadata = isset($prop['metadata']); if($params['urlheight'] != -1 && $params['urlwidth'] == -1) $this->dieUsage("iiurlheight cannot be used without iiurlwidth", 'iiurlwidth'); - $scale = $params['urlwidth'] != -1; + $this->scale = $params['urlwidth'] != -1; + $this->urlwidth = $params['urlwidth']; + $this->urlheight = $params['urlheight']; $pageIds = $this->getPageSet()->getAllTitlesByNamespace(); if (!empty($pageIds[NS_IMAGE])) { @@ -70,59 +70,21 @@ class ApiQueryImageInfo extends ApiQueryBase { } else { $repository = $img->getRepoName(); - - $isCur = true; - $count = 0; - while($line = $img->nextHistoryLine()) { // assignment - # FIXME: Limiting to 500 because it's unlimited right now - # 500+ image histories are scarce, but this has DoS potential - # FileRepo.php should be fixed - if($count++ == 500) - break; - $row = get_object_vars( $line ); - $vals = array(); - $prefix = $isCur ? 'img' : 'oi'; - - if ($fld_timestamp) - $vals['timestamp'] = wfTimestamp(TS_ISO_8601, $row["${prefix}_timestamp"]); - if ($fld_user) { - $vals['user'] = $row["${prefix}_user_text"]; - if(!$row["${prefix}_user"]) - $vals['anon'] = ''; - } - if ($fld_size) { - $vals['size'] = intval($row["{$prefix}_size"]); - $vals['width'] = intval($row["{$prefix}_width"]); - $vals['height'] = intval($row["{$prefix}_height"]); - } - if ($fld_url) { - if($scale && $isCur) { - $vals['url'] = $img->createThumb($params['urlwidth'], $params['urlheight']); - } else { - $vals['url'] = $isCur ? $img->getURL() : $img->getArchiveUrl($row["oi_archive_name"]); - } - } - if ($fld_comment) - $vals['comment'] = $row["{$prefix}_description"]; - - if ($fld_sha1) - $vals['sha1'] = wfBaseConvert($row["{$prefix}_sha1"], 36, 16, 40); - - if ($fld_metadata) { - $metadata = unserialize($row["{$prefix}_metadata"]); - $vals['metadata'] = $metadata ? $metadata : null; - $this->getResult()->setIndexedTagName_recursive($vals['metadata'], 'meta'); - } - - $data[] = $vals; - - if (!$history) // Stop after the first line. - break; - - $isCur = false; + + // Get information about the current version first + // Check that the current version is within the start-end boundaries + if((is_null($params['start']) || $img->getTimestamp() <= $params['start']) && + (is_null($params['end']) || $img->getTimestamp() >= $params['end'])) { + $data[] = $this->getInfo($img); } - $img->resetHistory(); + // Now get the old revisions + if($params['limit'] > 1) { + $oldies = $img->getHistory($params['limit'] - 1, $params['start'], $params['end']); + if(!empty($oldies)) + foreach($oldies as $oldie) + $data[] = $this->getInfo($oldie); + } } $this->getResult()->addValue(array( @@ -135,6 +97,44 @@ class ApiQueryImageInfo extends ApiQueryBase { } } + /** + * Get result information for an image revision + * @param File f The image + * @return array Result array + */ + protected function getInfo($f) { + $vals = array(); + if($this->fld_timestamp) + $vals['timestamp'] = wfTimestamp(TS_ISO_8601, $f->getTimestamp()); + if($this->fld_user) { + $vals['user'] = $f->getUser(); + if(!$f->getUser('id')) + $vals['anon'] = ''; + } + if($this->fld_size) { + $vals['size'] = $f->getSize(); + $vals['width'] = $f->getWidth(); + $vals['height'] = $f->getHeight(); + } + if($this->fld_url) { + if($this->scale) { + $vals['url'] = $f->createThumb($this->urlwidth, $this->urlheight); + } else { + $vals['url'] = $f->getURL(); + } + } + if($this->fld_comment) + $vals['comment'] = $f->getDescription(); + if($this->fld_sha1) + $vals['sha1'] = $f->getSha1(); + if($this->fld_metadata) { + $metadata = unserialize($f->getMetadata()); + $vals['metadata'] = $metadata ? $metadata : null; + $this->getResult()->setIndexedTagName_recursive($vals['metadata'], 'meta'); + } + return $vals; + } + protected function getAllowedParams() { return array ( 'prop' => array ( @@ -150,7 +150,19 @@ class ApiQueryImageInfo extends ApiQueryBase { 'metadata' ) ), - 'history' => false, + 'limit' => array( + ApiBase :: PARAM_TYPE => 'limit', + ApiBase :: PARAM_DFLT => 1, + ApiBase :: PARAM_MIN => 1, + ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1, + ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2 + ), + 'start' => array( + ApiBase :: PARAM_TYPE => 'timestamp' + ), + 'end' => array( + ApiBase :: PARAM_TYPE => 'timestamp' + ), 'urlwidth' => array( ApiBase :: PARAM_TYPE => 'integer', ApiBase :: PARAM_DFLT => -1 @@ -165,7 +177,9 @@ class ApiQueryImageInfo extends ApiQueryBase { protected function getParamDescription() { return array ( 'prop' => 'What image information to get.', - 'history' => 'Include upload history', + 'limit' => 'How many image revisions to return', + 'start' => 'Timestamp to start listing from', + 'end' => 'Timestamp to stop listing at', 'urlwidth' => 'If iiprop=url is set, a URL to an image scaled to this width will be returned. Only the current version of the image can be scaled.', 'urlheight' => 'Similar to iiurlwidth. Cannot be used without iiurlwidth', ); @@ -180,7 +194,7 @@ class ApiQueryImageInfo extends ApiQueryBase { protected function getExamples() { return array ( 'api.php?action=query&titles=Image:Albert%20Einstein%20Head.jpg&prop=imageinfo', - 'api.php?action=query&titles=Image:Test.jpg&prop=imageinfo&iihistory&iiprop=timestamp|user|url', + 'api.php?action=query&titles=Image:Test.jpg&prop=imageinfo&iilimit=50&iiend=20071231235959&iiprop=timestamp|user|url', ); }