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
24 use MediaWiki\MediaWikiServices
;
27 * Class to represent a file in the oldimage table
29 * @ingroup FileAbstraction
31 class OldLocalFile
extends LocalFile
{
32 /** @var string|int Timestamp */
33 protected $requestedTime;
35 /** @var string Archive name */
36 protected $archive_name;
38 const CACHE_VERSION
= 1;
39 const MAX_CACHE_ROWS
= 20;
43 * @param FileRepo $repo
44 * @param string|int|null $time
48 static function newFromTitle( $title, $repo, $time = null ) {
49 # The null default value is only here to avoid an E_STRICT
50 if ( $time === null ) {
51 throw new MWException( __METHOD__
. ' got null for $time parameter' );
54 return new self( $title, $repo, $time, null );
59 * @param FileRepo $repo
60 * @param string $archiveName
63 static function newFromArchiveName( $title, $repo, $archiveName ) {
64 return new self( $title, $repo, null, $archiveName );
68 * @param stdClass $row
69 * @param FileRepo $repo
72 static function newFromRow( $row, $repo ) {
73 $title = Title
::makeTitle( NS_FILE
, $row->oi_name
);
74 $file = new self( $title, $repo, null, $row->oi_archive_name
);
75 $file->loadFromRow( $row, 'oi_' );
81 * Create a OldLocalFile from a SHA-1 key
82 * Do not call this except from inside a repo class.
84 * @param string $sha1 Base-36 SHA-1
85 * @param LocalRepo $repo
86 * @param string|bool $timestamp MW_timestamp (optional)
88 * @return bool|OldLocalFile
90 static function newFromKey( $sha1, $repo, $timestamp = false ) {
91 $dbr = $repo->getReplicaDB();
93 $conds = [ 'oi_sha1' => $sha1 ];
95 $conds['oi_timestamp'] = $dbr->timestamp( $timestamp );
98 $fileQuery = self
::getQueryInfo();
99 $row = $dbr->selectRow(
100 $fileQuery['tables'], $fileQuery['fields'], $conds, __METHOD__
, [], $fileQuery['joins']
103 return self
::newFromRow( $row, $repo );
110 * Fields in the oldimage table
111 * @deprecated since 1.31, use self::getQueryInfo() instead.
114 static function selectFields() {
115 global $wgActorTableSchemaMigrationStage;
117 wfDeprecated( __METHOD__
, '1.31' );
118 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW
) {
119 // If code is using this instead of self::getQueryInfo(), there's a
120 // decent chance it's going to try to directly access
121 // $row->oi_user or $row->oi_user_text and we can't give it
122 // useful values here once those aren't being used anymore.
123 throw new BadMethodCallException(
124 'Cannot use ' . __METHOD__
125 . ' when $wgActorTableSchemaMigrationStage has SCHEMA_COMPAT_READ_NEW'
142 'oi_actor' => 'NULL',
146 ] + MediaWikiServices
::getInstance()->getCommentStore()->getFields( 'oi_description' );
150 * Return the tables, fields, and join conditions to be selected to create
151 * a new oldlocalfile object.
153 * @param string[] $options
154 * - omit-lazy: Omit fields that are lazily cached.
155 * @return array[] With three keys:
156 * - tables: (string[]) to include in the `$table` to `IDatabase->select()`
157 * - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
158 * - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
160 public static function getQueryInfo( array $options = [] ) {
161 $commentQuery = MediaWikiServices
::getInstance()->getCommentStore()->getJoin( 'oi_description' );
162 $actorQuery = ActorMigration
::newMigration()->getJoin( 'oi_user' );
164 'tables' => [ 'oldimage' ] +
$commentQuery['tables'] +
$actorQuery['tables'],
178 ] +
$commentQuery['fields'] +
$actorQuery['fields'],
179 'joins' => $commentQuery['joins'] +
$actorQuery['joins'],
182 if ( in_array( 'omit-nonlazy', $options, true ) ) {
183 // Internal use only for getting only the lazy fields
186 if ( !in_array( 'omit-lazy', $options, true ) ) {
187 // Note: Keep this in sync with self::getLazyCacheFields()
188 $ret['fields'][] = 'oi_metadata';
195 * @param Title $title
196 * @param FileRepo $repo
197 * @param string|int|null $time Timestamp or null to load by archive name
198 * @param string|null $archiveName Archive name or null to load by timestamp
199 * @throws MWException
201 function __construct( $title, $repo, $time, $archiveName ) {
202 parent
::__construct( $title, $repo );
203 $this->requestedTime
= $time;
204 $this->archive_name
= $archiveName;
205 if ( is_null( $time ) && is_null( $archiveName ) ) {
206 throw new MWException( __METHOD__
. ': must specify at least one of $time or $archiveName' );
213 function getCacheKey() {
220 function getArchiveName() {
221 if ( !isset( $this->archive_name
) ) {
225 return $this->archive_name
;
238 function isVisible() {
239 return $this->exists() && !$this->isDeleted( File
::DELETED_FILE
);
242 function loadFromDB( $flags = 0 ) {
243 $this->dataLoaded
= true;
245 $dbr = ( $flags & self
::READ_LATEST
)
246 ?
$this->repo
->getMasterDB()
247 : $this->repo
->getReplicaDB();
249 $conds = [ 'oi_name' => $this->getName() ];
250 if ( is_null( $this->requestedTime
) ) {
251 $conds['oi_archive_name'] = $this->archive_name
;
253 $conds['oi_timestamp'] = $dbr->timestamp( $this->requestedTime
);
255 $fileQuery = static::getQueryInfo();
256 $row = $dbr->selectRow(
257 $fileQuery['tables'],
258 $fileQuery['fields'],
261 [ 'ORDER BY' => 'oi_timestamp DESC' ],
265 $this->loadFromRow( $row, 'oi_' );
267 $this->fileExists
= false;
272 * Load lazy file metadata from the DB
274 protected function loadExtraFromDB() {
275 $this->extraDataLoaded
= true;
276 $dbr = $this->repo
->getReplicaDB();
277 $conds = [ 'oi_name' => $this->getName() ];
278 if ( is_null( $this->requestedTime
) ) {
279 $conds['oi_archive_name'] = $this->archive_name
;
281 $conds['oi_timestamp'] = $dbr->timestamp( $this->requestedTime
);
283 $fileQuery = static::getQueryInfo( [ 'omit-nonlazy' ] );
284 // In theory the file could have just been renamed/deleted...oh well
285 $row = $dbr->selectRow(
286 $fileQuery['tables'],
287 $fileQuery['fields'],
290 [ 'ORDER BY' => 'oi_timestamp DESC' ],
294 if ( !$row ) { // fallback to master
295 $dbr = $this->repo
->getMasterDB();
296 $row = $dbr->selectRow(
297 $fileQuery['tables'],
298 $fileQuery['fields'],
301 [ 'ORDER BY' => 'oi_timestamp DESC' ],
307 foreach ( $this->unprefixRow( $row, 'oi_' ) as $name => $value ) {
308 $this->$name = $value;
311 throw new MWException( "Could not find data for image '{$this->archive_name}'." );
316 protected function getCacheFields( $prefix = 'img_' ) {
317 $fields = parent
::getCacheFields( $prefix );
318 $fields[] = $prefix . 'archive_name';
319 $fields[] = $prefix . 'deleted';
328 return 'archive/' . $this->getHashPath() . $this->getArchiveName();
334 function getUrlRel() {
335 return 'archive/' . $this->getHashPath() . rawurlencode( $this->getArchiveName() );
338 function upgradeRow() {
339 $this->loadFromFile();
341 # Don't destroy file info of missing files
342 if ( !$this->fileExists
) {
343 wfDebug( __METHOD__
. ": file does not exist, aborting\n" );
348 $dbw = $this->repo
->getMasterDB();
349 list( $major, $minor ) = self
::splitMime( $this->mime
);
351 wfDebug( __METHOD__
. ': upgrading ' . $this->archive_name
. " to the current schema\n" );
352 $dbw->update( 'oldimage',
354 'oi_size' => $this->size
, // sanity
355 'oi_width' => $this->width
,
356 'oi_height' => $this->height
,
357 'oi_bits' => $this->bits
,
358 'oi_media_type' => $this->media_type
,
359 'oi_major_mime' => $major,
360 'oi_minor_mime' => $minor,
361 'oi_metadata' => $this->metadata
,
362 'oi_sha1' => $this->sha1
,
364 'oi_name' => $this->getName(),
365 'oi_archive_name' => $this->archive_name
],
371 * @param int $field One of DELETED_* bitfield constants for file or
375 function isDeleted( $field ) {
378 return ( $this->deleted
& $field ) == $field;
382 * Returns bitfield value
385 function getVisibility() {
388 return (int)$this->deleted
;
392 * Determine if the current user is allowed to view a particular
393 * field of this image file, if it's marked as deleted.
396 * @param User|null $user User object to check, or null to use $wgUser
399 function userCan( $field, User
$user = null ) {
402 return Revision
::userCanBitfield( $this->deleted
, $field, $user );
406 * Upload a file directly into archive. Generally for Special:Import.
408 * @param string $srcPath File system path of the source file
409 * @param string $archiveName Full archive name of the file, in the form
410 * $timestamp!$filename, where $filename must match $this->getName()
411 * @param string $timestamp
412 * @param string $comment
416 function uploadOld( $srcPath, $archiveName, $timestamp, $comment, $user ) {
419 $dstRel = 'archive/' . $this->getHashPath() . $archiveName;
420 $status = $this->publishTo( $srcPath, $dstRel );
422 if ( $status->isGood() ) {
423 if ( !$this->recordOldUpload( $srcPath, $archiveName, $timestamp, $comment, $user ) ) {
424 $status->fatal( 'filenotfound', $srcPath );
434 * Record a file upload in the oldimage table, without adding log entries.
436 * @param string $srcPath File system path to the source file
437 * @param string $archiveName The archive name of the file
438 * @param string $timestamp
439 * @param string $comment Upload comment
440 * @param User $user User who did this upload
443 protected function recordOldUpload( $srcPath, $archiveName, $timestamp, $comment, $user ) {
444 $dbw = $this->repo
->getMasterDB();
446 $dstPath = $this->repo
->getZonePath( 'public' ) . '/' . $this->getRel();
447 $props = $this->repo
->getFileProps( $dstPath );
448 if ( !$props['fileExists'] ) {
452 $commentFields = MediaWikiServices
::getInstance()->getCommentStore()
453 ->insert( $dbw, 'oi_description', $comment );
454 $actorFields = ActorMigration
::newMigration()->getInsertValues( $dbw, 'oi_user', $user );
455 $dbw->insert( 'oldimage',
457 'oi_name' => $this->getName(),
458 'oi_archive_name' => $archiveName,
459 'oi_size' => $props['size'],
460 'oi_width' => intval( $props['width'] ),
461 'oi_height' => intval( $props['height'] ),
462 'oi_bits' => $props['bits'],
463 'oi_timestamp' => $dbw->timestamp( $timestamp ),
464 'oi_metadata' => $props['metadata'],
465 'oi_media_type' => $props['media_type'],
466 'oi_major_mime' => $props['major_mime'],
467 'oi_minor_mime' => $props['minor_mime'],
468 'oi_sha1' => $props['sha1'],
469 ] +
$commentFields +
$actorFields, __METHOD__
476 * If archive name is an empty string, then file does not "exist"
478 * This is the case for a couple files on Wikimedia servers where
479 * the old version is "lost".
482 public function exists() {
483 $archiveName = $this->getArchiveName();
484 if ( $archiveName === '' ||
!is_string( $archiveName ) ) {
487 return parent
::exists();