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->getReplicaDB();
91 $conds = [ '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
106 * @todo Deprecate this in favor of a method that returns tables and joins
107 * as well, and use CommentStore::getJoin().
110 static function selectFields() {
127 ] + CommentStore
::newKey( 'oi_description' )->getFields();
131 * @param Title $title
132 * @param FileRepo $repo
133 * @param string $time Timestamp or null to load by archive name
134 * @param string $archiveName Archive name or null to load by timestamp
135 * @throws MWException
137 function __construct( $title, $repo, $time, $archiveName ) {
138 parent
::__construct( $title, $repo );
139 $this->requestedTime
= $time;
140 $this->archive_name
= $archiveName;
141 if ( is_null( $time ) && is_null( $archiveName ) ) {
142 throw new MWException( __METHOD__
. ': must specify at least one of $time or $archiveName' );
149 function getCacheKey() {
156 function getArchiveName() {
157 if ( !isset( $this->archive_name
) ) {
161 return $this->archive_name
;
174 function isVisible() {
175 return $this->exists() && !$this->isDeleted( File
::DELETED_FILE
);
178 function loadFromDB( $flags = 0 ) {
179 $this->dataLoaded
= true;
181 $dbr = ( $flags & self
::READ_LATEST
)
182 ?
$this->repo
->getMasterDB()
183 : $this->repo
->getReplicaDB();
185 $conds = [ 'oi_name' => $this->getName() ];
186 if ( is_null( $this->requestedTime
) ) {
187 $conds['oi_archive_name'] = $this->archive_name
;
189 $conds['oi_timestamp'] = $dbr->timestamp( $this->requestedTime
);
191 $row = $dbr->selectRow( 'oldimage', $this->getCacheFields( 'oi_' ),
192 $conds, __METHOD__
, [ 'ORDER BY' => 'oi_timestamp DESC' ] );
194 $this->loadFromRow( $row, 'oi_' );
196 $this->fileExists
= false;
201 * Load lazy file metadata from the DB
203 protected function loadExtraFromDB() {
204 $this->extraDataLoaded
= true;
205 $dbr = $this->repo
->getReplicaDB();
206 $conds = [ 'oi_name' => $this->getName() ];
207 if ( is_null( $this->requestedTime
) ) {
208 $conds['oi_archive_name'] = $this->archive_name
;
210 $conds['oi_timestamp'] = $dbr->timestamp( $this->requestedTime
);
212 // In theory the file could have just been renamed/deleted...oh well
213 $row = $dbr->selectRow( 'oldimage', $this->getLazyCacheFields( 'oi_' ),
214 $conds, __METHOD__
, [ 'ORDER BY' => 'oi_timestamp DESC' ] );
216 if ( !$row ) { // fallback to master
217 $dbr = $this->repo
->getMasterDB();
218 $row = $dbr->selectRow( 'oldimage', $this->getLazyCacheFields( 'oi_' ),
219 $conds, __METHOD__
, [ 'ORDER BY' => 'oi_timestamp DESC' ] );
223 foreach ( $this->unprefixRow( $row, 'oi_' ) as $name => $value ) {
224 $this->$name = $value;
227 throw new MWException( "Could not find data for image '{$this->archive_name}'." );
232 * @param string $prefix
235 function getCacheFields( $prefix = 'img_' ) {
236 $fields = parent
::getCacheFields( $prefix );
237 $fields[] = $prefix . 'archive_name';
238 $fields[] = $prefix . 'deleted';
247 return 'archive/' . $this->getHashPath() . $this->getArchiveName();
253 function getUrlRel() {
254 return 'archive/' . $this->getHashPath() . rawurlencode( $this->getArchiveName() );
257 function upgradeRow() {
258 $this->loadFromFile();
260 # Don't destroy file info of missing files
261 if ( !$this->fileExists
) {
262 wfDebug( __METHOD__
. ": file does not exist, aborting\n" );
267 $dbw = $this->repo
->getMasterDB();
268 list( $major, $minor ) = self
::splitMime( $this->mime
);
270 wfDebug( __METHOD__
. ': upgrading ' . $this->archive_name
. " to the current schema\n" );
271 $dbw->update( 'oldimage',
273 'oi_size' => $this->size
, // sanity
274 'oi_width' => $this->width
,
275 'oi_height' => $this->height
,
276 'oi_bits' => $this->bits
,
277 'oi_media_type' => $this->media_type
,
278 'oi_major_mime' => $major,
279 'oi_minor_mime' => $minor,
280 'oi_metadata' => $this->metadata
,
281 'oi_sha1' => $this->sha1
,
283 'oi_name' => $this->getName(),
284 'oi_archive_name' => $this->archive_name
],
290 * @param int $field One of DELETED_* bitfield constants for file or
294 function isDeleted( $field ) {
297 return ( $this->deleted
& $field ) == $field;
301 * Returns bitfield value
304 function getVisibility() {
307 return (int)$this->deleted
;
311 * Determine if the current user is allowed to view a particular
312 * field of this image file, if it's marked as deleted.
315 * @param User|null $user User object to check, or null to use $wgUser
318 function userCan( $field, User
$user = null ) {
321 return Revision
::userCanBitfield( $this->deleted
, $field, $user );
325 * Upload a file directly into archive. Generally for Special:Import.
327 * @param string $srcPath File system path of the source file
328 * @param string $archiveName Full archive name of the file, in the form
329 * $timestamp!$filename, where $filename must match $this->getName()
330 * @param string $timestamp
331 * @param string $comment
335 function uploadOld( $srcPath, $archiveName, $timestamp, $comment, $user ) {
338 $dstRel = 'archive/' . $this->getHashPath() . $archiveName;
339 $status = $this->publishTo( $srcPath, $dstRel );
341 if ( $status->isGood() ) {
342 if ( !$this->recordOldUpload( $srcPath, $archiveName, $timestamp, $comment, $user ) ) {
343 $status->fatal( 'filenotfound', $srcPath );
353 * Record a file upload in the oldimage table, without adding log entries.
355 * @param string $srcPath File system path to the source file
356 * @param string $archiveName The archive name of the file
357 * @param string $timestamp
358 * @param string $comment Upload comment
359 * @param User $user User who did this upload
362 protected function recordOldUpload( $srcPath, $archiveName, $timestamp, $comment, $user ) {
363 $dbw = $this->repo
->getMasterDB();
365 $dstPath = $this->repo
->getZonePath( 'public' ) . '/' . $this->getRel();
366 $props = $this->repo
->getFileProps( $dstPath );
367 if ( !$props['fileExists'] ) {
371 $commentFields = CommentStore
::newKey( 'oi_description' )->insert( $dbw, $comment );
372 $dbw->insert( 'oldimage',
374 'oi_name' => $this->getName(),
375 'oi_archive_name' => $archiveName,
376 'oi_size' => $props['size'],
377 'oi_width' => intval( $props['width'] ),
378 'oi_height' => intval( $props['height'] ),
379 'oi_bits' => $props['bits'],
380 'oi_timestamp' => $dbw->timestamp( $timestamp ),
381 'oi_user' => $user->getId(),
382 'oi_user_text' => $user->getName(),
383 'oi_metadata' => $props['metadata'],
384 'oi_media_type' => $props['media_type'],
385 'oi_major_mime' => $props['major_mime'],
386 'oi_minor_mime' => $props['minor_mime'],
387 'oi_sha1' => $props['sha1'],
388 ] +
$commentFields, __METHOD__
395 * If archive name is an empty string, then file does not "exist"
397 * This is the case for a couple files on Wikimedia servers where
398 * the old version is "lost".
401 public function exists() {
402 $archiveName = $this->getArchiveName();
403 if ( $archiveName === '' ||
!is_string( $archiveName ) ) {
406 return parent
::exists();