3 * Old file in the oldimage 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 to represent a file in the oldimage table
27 * @ingroup FileAbstraction
29 class OldLocalFile
extends LocalFile
{
30 /** @var string Timestamp */
31 protected $requestedTime;
33 /** @var string Archive name */
34 protected $archive_name;
36 const CACHE_VERSION
= 1;
37 const MAX_CACHE_ROWS
= 20;
41 * @param FileRepo $repo
42 * @param null|int $time Timestamp or null
43 * @return OldLocalFile
46 static function newFromTitle( $title, $repo, $time = null ) {
47 # The null default value is only here to avoid an E_STRICT
48 if ( $time === null ) {
49 throw new MWException( __METHOD__
. ' got null for $time parameter' );
52 return new self( $title, $repo, $time, null );
57 * @param FileRepo $repo
58 * @param string $archiveName
59 * @return OldLocalFile
61 static function newFromArchiveName( $title, $repo, $archiveName ) {
62 return new self( $title, $repo, null, $archiveName );
66 * @param stdClass $row
67 * @param FileRepo $repo
68 * @return OldLocalFile
70 static function newFromRow( $row, $repo ) {
71 $title = Title
::makeTitle( NS_FILE
, $row->oi_name
);
72 $file = new self( $title, $repo, null, $row->oi_archive_name
);
73 $file->loadFromRow( $row, 'oi_' );
79 * Create a OldLocalFile from a SHA-1 key
80 * Do not call this except from inside a repo class.
82 * @param string $sha1 base-36 SHA-1
83 * @param LocalRepo $repo
84 * @param string|bool $timestamp MW_timestamp (optional)
86 * @return bool|OldLocalFile
88 static function newFromKey( $sha1, $repo, $timestamp = false ) {
89 $dbr = $repo->getSlaveDB();
91 $conds = array( 'oi_sha1' => $sha1 );
93 $conds['oi_timestamp'] = $dbr->timestamp( $timestamp );
96 $row = $dbr->selectRow( 'oldimage', self
::selectFields(), $conds, __METHOD__
);
98 return self
::newFromRow( $row, $repo );
105 * Fields in the oldimage table
108 static function selectFields() {
130 * @param Title $title
131 * @param FileRepo $repo
132 * @param string $time Timestamp or null to load by archive name
133 * @param string $archiveName archive name or null to load by timestamp
134 * @throws MWException
136 function __construct( $title, $repo, $time, $archiveName ) {
137 parent
::__construct( $title, $repo );
138 $this->requestedTime
= $time;
139 $this->archive_name
= $archiveName;
140 if ( is_null( $time ) && is_null( $archiveName ) ) {
141 throw new MWException( __METHOD__
. ': must specify at least one of $time or $archiveName' );
148 function getCacheKey() {
155 function getArchiveName() {
156 if ( !isset( $this->archive_name
) ) {
160 return $this->archive_name
;
173 function isVisible() {
174 return $this->exists() && !$this->isDeleted( File
::DELETED_FILE
);
177 function loadFromDB() {
178 wfProfileIn( __METHOD__
);
180 $this->dataLoaded
= true;
181 $dbr = $this->repo
->getSlaveDB();
182 $conds = array( 'oi_name' => $this->getName() );
183 if ( is_null( $this->requestedTime
) ) {
184 $conds['oi_archive_name'] = $this->archive_name
;
186 $conds['oi_timestamp'] = $dbr->timestamp( $this->requestedTime
);
188 $row = $dbr->selectRow( 'oldimage', $this->getCacheFields( 'oi_' ),
189 $conds, __METHOD__
, array( 'ORDER BY' => 'oi_timestamp DESC' ) );
191 $this->loadFromRow( $row, 'oi_' );
193 $this->fileExists
= false;
196 wfProfileOut( __METHOD__
);
200 * Load lazy file metadata from the DB
202 protected function loadExtraFromDB() {
203 wfProfileIn( __METHOD__
);
205 $this->extraDataLoaded
= true;
206 $dbr = $this->repo
->getSlaveDB();
207 $conds = array( 'oi_name' => $this->getName() );
208 if ( is_null( $this->requestedTime
) ) {
209 $conds['oi_archive_name'] = $this->archive_name
;
211 $conds['oi_timestamp'] = $dbr->timestamp( $this->requestedTime
);
213 // In theory the file could have just been renamed/deleted...oh well
214 $row = $dbr->selectRow( 'oldimage', $this->getLazyCacheFields( 'oi_' ),
215 $conds, __METHOD__
, array( 'ORDER BY' => 'oi_timestamp DESC' ) );
217 if ( !$row ) { // fallback to master
218 $dbr = $this->repo
->getMasterDB();
219 $row = $dbr->selectRow( 'oldimage', $this->getLazyCacheFields( 'oi_' ),
220 $conds, __METHOD__
, array( 'ORDER BY' => 'oi_timestamp DESC' ) );
224 foreach ( $this->unprefixRow( $row, 'oi_' ) as $name => $value ) {
225 $this->$name = $value;
228 wfProfileOut( __METHOD__
);
229 throw new MWException( "Could not find data for image '{$this->archive_name}'." );
232 wfProfileOut( __METHOD__
);
236 * @param string $prefix
239 function getCacheFields( $prefix = 'img_' ) {
240 $fields = parent
::getCacheFields( $prefix );
241 $fields[] = $prefix . 'archive_name';
242 $fields[] = $prefix . 'deleted';
251 return 'archive/' . $this->getHashPath() . $this->getArchiveName();
257 function getUrlRel() {
258 return 'archive/' . $this->getHashPath() . rawurlencode( $this->getArchiveName() );
261 function upgradeRow() {
262 wfProfileIn( __METHOD__
);
263 $this->loadFromFile();
265 # Don't destroy file info of missing files
266 if ( !$this->fileExists
) {
267 wfDebug( __METHOD__
. ": file does not exist, aborting\n" );
268 wfProfileOut( __METHOD__
);
273 $dbw = $this->repo
->getMasterDB();
274 list( $major, $minor ) = self
::splitMime( $this->mime
);
276 wfDebug( __METHOD__
. ': upgrading ' . $this->archive_name
. " to the current schema\n" );
277 $dbw->update( 'oldimage',
279 'oi_size' => $this->size
, // sanity
280 'oi_width' => $this->width
,
281 'oi_height' => $this->height
,
282 'oi_bits' => $this->bits
,
283 'oi_media_type' => $this->media_type
,
284 'oi_major_mime' => $major,
285 'oi_minor_mime' => $minor,
286 'oi_metadata' => $this->metadata
,
287 'oi_sha1' => $this->sha1
,
289 'oi_name' => $this->getName(),
290 'oi_archive_name' => $this->archive_name
),
293 wfProfileOut( __METHOD__
);
297 * @param int $field One of DELETED_* bitfield constants for file or
301 function isDeleted( $field ) {
304 return ( $this->deleted
& $field ) == $field;
308 * Returns bitfield value
311 function getVisibility() {
314 return (int)$this->deleted
;
318 * Determine if the current user is allowed to view a particular
319 * field of this image file, if it's marked as deleted.
322 * @param User|null $user User object to check, or null to use $wgUser
325 function userCan( $field, User
$user = null ) {
328 return Revision
::userCanBitfield( $this->deleted
, $field, $user );
332 * Upload a file directly into archive. Generally for Special:Import.
334 * @param string $srcPath File system path of the source file
335 * @param string $archiveName Full archive name of the file, in the form
336 * $timestamp!$filename, where $filename must match $this->getName()
337 * @param string $timestamp
338 * @param string $comment
341 * @return FileRepoStatus
343 function uploadOld( $srcPath, $archiveName, $timestamp, $comment, $user, $flags = 0 ) {
346 $dstRel = 'archive/' . $this->getHashPath() . $archiveName;
347 $status = $this->publishTo( $srcPath, $dstRel,
348 $flags & File
::DELETE_SOURCE ? FileRepo
::DELETE_SOURCE
: 0
351 if ( $status->isGood() ) {
352 if ( !$this->recordOldUpload( $srcPath, $archiveName, $timestamp, $comment, $user ) ) {
353 $status->fatal( 'filenotfound', $srcPath );
363 * Record a file upload in the oldimage table, without adding log entries.
365 * @param string $srcPath File system path to the source file
366 * @param string $archiveName The archive name of the file
367 * @param string $timestamp
368 * @param string $comment Upload comment
369 * @param User $user User who did this upload
372 function recordOldUpload( $srcPath, $archiveName, $timestamp, $comment, $user ) {
373 $dbw = $this->repo
->getMasterDB();
374 $dbw->begin( __METHOD__
);
376 $dstPath = $this->repo
->getZonePath( 'public' ) . '/' . $this->getRel();
377 $props = $this->repo
->getFileProps( $dstPath );
378 if ( !$props['fileExists'] ) {
382 $dbw->insert( 'oldimage',
384 'oi_name' => $this->getName(),
385 'oi_archive_name' => $archiveName,
386 'oi_size' => $props['size'],
387 'oi_width' => intval( $props['width'] ),
388 'oi_height' => intval( $props['height'] ),
389 'oi_bits' => $props['bits'],
390 'oi_timestamp' => $dbw->timestamp( $timestamp ),
391 'oi_description' => $comment,
392 'oi_user' => $user->getId(),
393 'oi_user_text' => $user->getName(),
394 'oi_metadata' => $props['metadata'],
395 'oi_media_type' => $props['media_type'],
396 'oi_major_mime' => $props['major_mime'],
397 'oi_minor_mime' => $props['minor_mime'],
398 'oi_sha1' => $props['sha1'],
402 $dbw->commit( __METHOD__
);