MediaWiki REL1_32
ApiQueryFilearchive.php
Go to the documentation of this file.
1<?php
28
35
36 public function __construct( ApiQuery $query, $moduleName ) {
37 parent::__construct( $query, $moduleName, 'fa' );
38 }
39
40 public function execute() {
41 // Before doing anything at all, let's check permissions
42 $this->checkUserRightsAny( 'deletedhistory' );
43
44 $user = $this->getUser();
45 $db = $this->getDB();
46 $commentStore = CommentStore::getStore();
47
49
50 $prop = array_flip( $params['prop'] );
51 $fld_sha1 = isset( $prop['sha1'] );
52 $fld_timestamp = isset( $prop['timestamp'] );
53 $fld_user = isset( $prop['user'] );
54 $fld_size = isset( $prop['size'] );
55 $fld_dimensions = isset( $prop['dimensions'] );
56 $fld_description = isset( $prop['description'] ) || isset( $prop['parseddescription'] );
57 $fld_mime = isset( $prop['mime'] );
58 $fld_mediatype = isset( $prop['mediatype'] );
59 $fld_metadata = isset( $prop['metadata'] );
60 $fld_bitdepth = isset( $prop['bitdepth'] );
61 $fld_archivename = isset( $prop['archivename'] );
62
63 $fileQuery = ArchivedFile::getQueryInfo();
64 $this->addTables( $fileQuery['tables'] );
65 $this->addFields( $fileQuery['fields'] );
66 $this->addJoinConds( $fileQuery['joins'] );
67
68 if ( !is_null( $params['continue'] ) ) {
69 $cont = explode( '|', $params['continue'] );
70 $this->dieContinueUsageIf( count( $cont ) != 3 );
71 $op = $params['dir'] == 'descending' ? '<' : '>';
72 $cont_from = $db->addQuotes( $cont[0] );
73 $cont_timestamp = $db->addQuotes( $db->timestamp( $cont[1] ) );
74 $cont_id = (int)$cont[2];
75 $this->dieContinueUsageIf( $cont[2] !== (string)$cont_id );
76 $this->addWhere( "fa_name $op $cont_from OR " .
77 "(fa_name = $cont_from AND " .
78 "(fa_timestamp $op $cont_timestamp OR " .
79 "(fa_timestamp = $cont_timestamp AND " .
80 "fa_id $op= $cont_id )))"
81 );
82 }
83
84 // Image filters
85 $dir = ( $params['dir'] == 'descending' ? 'older' : 'newer' );
86 $from = ( $params['from'] === null ? null : $this->titlePartToKey( $params['from'], NS_FILE ) );
87 $to = ( $params['to'] === null ? null : $this->titlePartToKey( $params['to'], NS_FILE ) );
88 $this->addWhereRange( 'fa_name', $dir, $from, $to );
89 if ( isset( $params['prefix'] ) ) {
90 $this->addWhere( 'fa_name' . $db->buildLike(
91 $this->titlePartToKey( $params['prefix'], NS_FILE ),
92 $db->anyString() ) );
93 }
94
95 $sha1Set = isset( $params['sha1'] );
96 $sha1base36Set = isset( $params['sha1base36'] );
97 if ( $sha1Set || $sha1base36Set ) {
98 $sha1 = false;
99 if ( $sha1Set ) {
100 $sha1 = strtolower( $params['sha1'] );
101 if ( !$this->validateSha1Hash( $sha1 ) ) {
102 $this->dieWithError( 'apierror-invalidsha1hash' );
103 }
104 $sha1 = Wikimedia\base_convert( $sha1, 16, 36, 31 );
105 } elseif ( $sha1base36Set ) {
106 $sha1 = strtolower( $params['sha1base36'] );
107 if ( !$this->validateSha1Base36Hash( $sha1 ) ) {
108 $this->dieWithError( 'apierror-invalidsha1base36hash' );
109 }
110 }
111 if ( $sha1 ) {
112 $this->addWhereFld( 'fa_sha1', $sha1 );
113 }
114 }
115
116 // Exclude files this user can't view.
117 if ( !$user->isAllowed( 'deletedtext' ) ) {
118 $bitmask = File::DELETED_FILE;
119 } elseif ( !$user->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
121 } else {
122 $bitmask = 0;
123 }
124 if ( $bitmask ) {
125 $this->addWhere( $this->getDB()->bitAnd( 'fa_deleted', $bitmask ) . " != $bitmask" );
126 }
127
128 $limit = $params['limit'];
129 $this->addOption( 'LIMIT', $limit + 1 );
130 $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
131 $this->addOption( 'ORDER BY', [
132 'fa_name' . $sort,
133 'fa_timestamp' . $sort,
134 'fa_id' . $sort,
135 ] );
136
137 $res = $this->select( __METHOD__ );
138
139 $count = 0;
140 $result = $this->getResult();
141 foreach ( $res as $row ) {
142 if ( ++$count > $limit ) {
143 // We've reached the one extra which shows that there are
144 // additional pages to be had. Stop here...
146 'continue', "$row->fa_name|$row->fa_timestamp|$row->fa_id"
147 );
148 break;
149 }
150
151 $file = [];
152 $file['id'] = (int)$row->fa_id;
153 $file['name'] = $row->fa_name;
154 $title = Title::makeTitle( NS_FILE, $row->fa_name );
155 self::addTitleInfo( $file, $title );
156
157 if ( $fld_description &&
158 RevisionRecord::userCanBitfield( $row->fa_deleted, File::DELETED_COMMENT, $user )
159 ) {
160 $file['description'] = $commentStore->getComment( 'fa_description', $row )->text;
161 if ( isset( $prop['parseddescription'] ) ) {
162 $file['parseddescription'] = Linker::formatComment(
163 $file['description'], $title );
164 }
165 }
166 if ( $fld_user &&
167 RevisionRecord::userCanBitfield( $row->fa_deleted, File::DELETED_USER, $user )
168 ) {
169 $file['userid'] = (int)$row->fa_user;
170 $file['user'] = $row->fa_user_text;
171 }
172 if ( $fld_sha1 ) {
173 $file['sha1'] = Wikimedia\base_convert( $row->fa_sha1, 36, 16, 40 );
174 }
175 if ( $fld_timestamp ) {
176 $file['timestamp'] = wfTimestamp( TS_ISO_8601, $row->fa_timestamp );
177 }
178 if ( $fld_size || $fld_dimensions ) {
179 $file['size'] = $row->fa_size;
180
181 $pageCount = ArchivedFile::newFromRow( $row )->pageCount();
182 if ( $pageCount !== false ) {
183 $file['pagecount'] = $pageCount;
184 }
185
186 $file['height'] = $row->fa_height;
187 $file['width'] = $row->fa_width;
188 }
189 if ( $fld_mediatype ) {
190 $file['mediatype'] = $row->fa_media_type;
191 }
192 if ( $fld_metadata ) {
193 $file['metadata'] = $row->fa_metadata
195 : null;
196 }
197 if ( $fld_bitdepth ) {
198 $file['bitdepth'] = $row->fa_bits;
199 }
200 if ( $fld_mime ) {
201 $file['mime'] = "$row->fa_major_mime/$row->fa_minor_mime";
202 }
203 if ( $fld_archivename && !is_null( $row->fa_archive_name ) ) {
204 $file['archivename'] = $row->fa_archive_name;
205 }
206
207 if ( $row->fa_deleted & File::DELETED_FILE ) {
208 $file['filehidden'] = true;
209 }
210 if ( $row->fa_deleted & File::DELETED_COMMENT ) {
211 $file['commenthidden'] = true;
212 }
213 if ( $row->fa_deleted & File::DELETED_USER ) {
214 $file['userhidden'] = true;
215 }
216 if ( $row->fa_deleted & File::DELETED_RESTRICTED ) {
217 // This file is deleted for normal admins
218 $file['suppressed'] = true;
219 }
220
221 $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $file );
222 if ( !$fit ) {
224 'continue', "$row->fa_name|$row->fa_timestamp|$row->fa_id"
225 );
226 break;
227 }
228 }
229
230 $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'fa' );
231 }
232
233 public function getAllowedParams() {
234 return [
235 'from' => null,
236 'to' => null,
237 'prefix' => null,
238 'dir' => [
239 ApiBase::PARAM_DFLT => 'ascending',
241 'ascending',
242 'descending'
243 ]
244 ],
245 'sha1' => null,
246 'sha1base36' => null,
247 'prop' => [
248 ApiBase::PARAM_DFLT => 'timestamp',
251 'sha1',
252 'timestamp',
253 'user',
254 'size',
255 'dimensions',
256 'description',
257 'parseddescription',
258 'mime',
259 'mediatype',
260 'metadata',
261 'bitdepth',
262 'archivename',
263 ],
265 ],
266 'limit' => [
268 ApiBase::PARAM_TYPE => 'limit',
272 ],
273 'continue' => [
274 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
275 ],
276 ];
277 }
278
279 protected function getExamplesMessages() {
280 return [
281 'action=query&list=filearchive'
282 => 'apihelp-query+filearchive-example-simple',
283 ];
284 }
285
286 public function getHelpUrls() {
287 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Filearchive';
288 }
289}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
unserialize( $serialized)
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right,...
Definition ApiBase.php:96
checkUserRightsAny( $rights, $user=null)
Helper function for permission-denied errors.
Definition ApiBase.php:2095
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition ApiBase.php:90
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition ApiBase.php:1987
dieContinueUsageIf( $condition)
Die with the 'badcontinue' error.
Definition ApiBase.php:2155
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition ApiBase.php:87
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition ApiBase.php:48
const PARAM_HELP_MSG_PER_VALUE
((string|array|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg...
Definition ApiBase.php:157
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition ApiBase.php:99
const LIMIT_BIG1
Fast query, standard limit.
Definition ApiBase.php:252
getResult()
Get the result object.
Definition ApiBase.php:659
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition ApiBase.php:770
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition ApiBase.php:124
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition ApiBase.php:254
getModuleName()
Get the name of the module being executed by this instance.
Definition ApiBase.php:539
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition ApiBase.php:51
This is a base class for all Query modules.
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
setContinueEnumParameter( $paramName, $paramValue)
Set a query-continue value.
validateSha1Base36Hash( $hash)
addWhereRange( $field, $dir, $start, $end, $sort=true)
Add a WHERE clause corresponding to a range, and an ORDER BY clause to sort in the right direction.
validateSha1Hash( $hash)
addFields( $value)
Add a set of fields to select to the internal array.
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
getDB()
Get the Query database connection (read-only)
addJoinConds( $join_conds)
Add a set of JOIN conditions to the internal array.
addWhereFld( $field, $value)
Equivalent to addWhere(array($field => $value))
titlePartToKey( $titlePart, $namespace=NS_MAIN)
Convert an input title or title prefix into a dbkey.
addWhere( $value)
Add a set of WHERE clauses to the internal array.
Query module to enumerate all deleted files.
__construct(ApiQuery $query, $moduleName)
getExamplesMessages()
Returns usage examples for this module.
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
getHelpUrls()
Return links to more detailed help pages about the module.
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
static processMetaData( $metadata, $result)
This is the main query class.
Definition ApiQuery.php:36
static getQueryInfo()
Return the tables, fields, and join conditions to be selected to create a new archivedfile object.
static newFromRow( $row)
Loads a file object from the filearchive table.
const DELETED_COMMENT
Definition File.php:54
const DELETED_RESTRICTED
Definition File.php:56
const DELETED_FILE
Definition File.php:53
const DELETED_USER
Definition File.php:55
static formatComment( $comment, $title=null, $local=false, $wikiId=null)
This function is called by all recent changes variants, by the page history, and by the user contribu...
Definition Linker.php:1088
Page revision base class.
We use the convention $dbr for read and $dbw for write to help you keep track of whether the database object is a the world will explode Or to be a subsequent write query which succeeded on the master may fail when replicated to the slave due to a unique key collision Replication on the slave will stop and it may take hours to repair the database and get it back online Setting read_only in my cnf on the slave will avoid this but given the dire we prefer to have as many checks as possible We provide a but the wrapper functions like select() and insert() are usually more convenient. They take care of things like table prefixes and escaping for you. If you really need to make your own SQL
$res
Definition database.txt:21
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
const NS_FILE
Definition Defines.php:70
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED since 1.16! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition hooks.txt:2042
namespace and then decline to actually register it file or subcat img or subcat $title
Definition hooks.txt:994
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition hooks.txt:1656
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition hooks.txt:247
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37
$sort
$params