3 * Deleted file in the 'filearchive' table.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @ingroup FileAbstraction
25 * Class representing a row of the 'filearchive' table
27 * @ingroup FileAbstraction
33 var $id, # filearchive row ID
35 $group, # FileStore storage group
36 $key, # FileStore sha1 key
37 $size, # file dimensions
38 $bits, # size in bytes
41 $metadata, # metadata string
43 $media_type, # media type
44 $description, # upload description
45 $user, # user ID of uploader
46 $user_text, # user name of uploader
47 $timestamp, # time of upload
48 $dataLoaded, # Whether or not all this has been loaded from the database (loadFromXxx)
49 $deleted, # Bitfield akin to rev_deleted
50 $sha1, # sha1 hash of file content
61 var $title; # image title
71 function __construct( $title, $id=0, $key='' ) {
75 $this->group
= 'deleted'; // needed for direct use of constructor
82 $this->mime
= "unknown/unknown";
83 $this->media_type
= '';
84 $this->description
= '';
86 $this->user_text
= '';
87 $this->timestamp
= null;
89 $this->dataLoaded
= false;
90 $this->exists
= false;
93 if( $title instanceof Title
) {
94 $this->title
= File
::normalizeTitle( $title, 'exception' );
95 $this->name
= $title->getDBkey();
106 if ( !$id && !$key && !( $title instanceof Title
) ) {
107 throw new MWException( "No specifications provided to ArchivedFile constructor." );
112 * Loads a file object from the filearchive table
113 * @throws MWException
114 * @return bool|null True on success or null
116 public function load() {
117 if ( $this->dataLoaded
) {
122 if( $this->id
> 0 ) {
123 $conds['fa_id'] = $this->id
;
126 $conds['fa_storage_group'] = $this->group
;
127 $conds['fa_storage_key'] = $this->key
;
130 $conds['fa_name'] = $this->title
->getDBkey();
133 if( !count($conds)) {
134 throw new MWException( "No specific information for retrieving archived file" );
137 if( !$this->title ||
$this->title
->getNamespace() == NS_FILE
) {
138 $this->dataLoaded
= true; // set it here, to have also true on miss
139 $dbr = wfGetDB( DB_SLAVE
);
140 $row = $dbr->selectRow( 'filearchive',
163 array( 'ORDER BY' => 'fa_timestamp DESC')
166 // this revision does not exist?
170 // initialize fields for filestore image object
171 $this->loadFromRow( $row );
173 throw new MWException( 'This title does not correspond to an image page.' );
175 $this->exists
= true;
181 * Loads a file object from the filearchive table
185 * @return ArchivedFile
187 public static function newFromRow( $row ) {
188 $file = new ArchivedFile( Title
::makeTitle( NS_FILE
, $row->fa_name
) );
189 $file->loadFromRow( $row );
194 * Load ArchivedFile object fields from a DB row.
196 * @param $row Object database row
199 public function loadFromRow( $row ) {
200 $this->id
= intval($row->fa_id
);
201 $this->name
= $row->fa_name
;
202 $this->archive_name
= $row->fa_archive_name
;
203 $this->group
= $row->fa_storage_group
;
204 $this->key
= $row->fa_storage_key
;
205 $this->size
= $row->fa_size
;
206 $this->bits
= $row->fa_bits
;
207 $this->width
= $row->fa_width
;
208 $this->height
= $row->fa_height
;
209 $this->metadata
= $row->fa_metadata
;
210 $this->mime
= "$row->fa_major_mime/$row->fa_minor_mime";
211 $this->media_type
= $row->fa_media_type
;
212 $this->description
= $row->fa_description
;
213 $this->user
= $row->fa_user
;
214 $this->user_text
= $row->fa_user_text
;
215 $this->timestamp
= $row->fa_timestamp
;
216 $this->deleted
= $row->fa_deleted
;
217 if( isset( $row->fa_sha1
) ) {
218 $this->sha1
= $row->fa_sha1
;
220 // old row, populate from key
221 $this->sha1
= LocalRepo
::getHashFromKey( $this->key
);
226 * Return the associated title object
230 public function getTitle() {
235 * Return the file name
239 public function getName() {
246 public function getID() {
254 public function exists() {
256 return $this->exists
;
260 * Return the FileStore key
263 public function getKey() {
269 * Return the FileStore key (overriding base File class)
272 public function getStorageKey() {
273 return $this->getKey();
277 * Return the FileStore storage group
280 public function getGroup() {
285 * Return the width of the image
288 public function getWidth() {
294 * Return the height of the image
297 public function getHeight() {
299 return $this->height
;
303 * Get handler-specific metadata
306 public function getMetadata() {
308 return $this->metadata
;
312 * Return the size of the image file, in bytes
315 public function getSize() {
321 * Return the bits of the image file, in bytes
324 public function getBits() {
330 * Returns the mime type of the file.
333 public function getMimeType() {
339 * Get a MediaHandler instance for this file
340 * @return MediaHandler
342 function getHandler() {
343 if ( !isset( $this->handler
) ) {
344 $this->handler
= MediaHandler
::getHandler( $this->getMimeType() );
346 return $this->handler
;
350 * Returns the number of pages of a multipage document, or false for
351 * documents which aren't multipage documents
353 function pageCount() {
354 if ( !isset( $this->pageCount
) ) {
355 if ( $this->getHandler() && $this->handler
->isMultiPage( $this ) ) {
356 $this->pageCount
= $this->handler
->pageCount( $this );
358 $this->pageCount
= false;
361 return $this->pageCount
;
365 * Return the type of the media in the file.
366 * Use the value returned by this function with the MEDIATYPE_xxx constants.
369 public function getMediaType() {
371 return $this->media_type
;
375 * Return upload timestamp.
379 public function getTimestamp() {
381 return wfTimestamp( TS_MW
, $this->timestamp
);
385 * Get the SHA-1 base 36 hash of the file
396 * Return the user ID of the uploader.
400 public function getUser() {
402 if( $this->isDeleted( File
::DELETED_USER
) ) {
410 * Return the user name of the uploader.
414 public function getUserText() {
416 if( $this->isDeleted( File
::DELETED_USER
) ) {
419 return $this->user_text
;
424 * Return upload description.
428 public function getDescription() {
430 if( $this->isDeleted( File
::DELETED_COMMENT
) ) {
433 return $this->description
;
438 * Return the user ID of the uploader.
442 public function getRawUser() {
448 * Return the user name of the uploader.
452 public function getRawUserText() {
454 return $this->user_text
;
458 * Return upload description.
462 public function getRawDescription() {
464 return $this->description
;
468 * Returns the deletion bitfield
471 public function getVisibility() {
473 return $this->deleted
;
477 * for file or revision rows
479 * @param $field Integer: one of DELETED_* bitfield constants
482 public function isDeleted( $field ) {
484 return ($this->deleted
& $field) == $field;
488 * Determine if the current user is allowed to view a particular
489 * field of this FileStore image file, if it's marked as deleted.
490 * @param $field Integer
491 * @param $user User object to check, or null to use $wgUser
494 public function userCan( $field, User
$user = null ) {
496 return Revision
::userCanBitfield( $this->deleted
, $field, $user );