dépôts / lhc / web / wiklou.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
history | raw | HEAD
Merge "objectcache: Fixes WinCache increment losing TTL."
[lhc/web/wiklou.git] / includes / filerepo / file / LocalFile.php
1 <?php
2 /**
3 * Local file in the wiki's own database.
4 *
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.
9 *
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.
14 *
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
19 *
20 * @file
21 * @ingroup FileAbstraction
22 */
23
24 use MediaWiki\Logger\LoggerFactory;
25 use Wikimedia\Rdbms\Database;
26 use Wikimedia\Rdbms\IDatabase;
27 use MediaWiki\MediaWikiServices;
28
29 /**
30 * Class to represent a local file in the wiki's own database
31 *
32 * Provides methods to retrieve paths (physical, logical, URL),
33 * to generate image thumbnails or for uploading.
34 *
35 * Note that only the repo object knows what its file class is called. You should
36 * never name a file class explictly outside of the repo class. Instead use the
37 * repo's factory functions to generate file objects, for example:
38 *
39 * RepoGroup::singleton()->getLocalRepo()->newFile( $title );
40 *
41 * The convenience functions wfLocalFile() and wfFindFile() should be sufficient
42 * in most cases.
43 *
44 * @ingroup FileAbstraction
45 */
46 class LocalFile extends File {
47 const VERSION = 11; // cache version
48
49 const CACHE_FIELD_MAX_LEN = 1000;
50
51 /** @var bool Does the file exist on disk? (loadFromXxx) */
52 protected $fileExists;
53
54 /** @var int Image width */
55 protected $width;
56
57 /** @var int Image height */
58 protected $height;
59
60 /** @var int Returned by getimagesize (loadFromXxx) */
61 protected $bits;
62
63 /** @var string MEDIATYPE_xxx (bitmap, drawing, audio...) */
64 protected $media_type;
65
66 /** @var string MIME type, determined by MimeAnalyzer::guessMimeType */
67 protected $mime;
68
69 /** @var int Size in bytes (loadFromXxx) */
70 protected $size;
71
72 /** @var string Handler-specific metadata */
73 protected $metadata;
74
75 /** @var string SHA-1 base 36 content hash */
76 protected $sha1;
77
78 /** @var bool Whether or not core data has been loaded from the database (loadFromXxx) */
79 protected $dataLoaded;
80
81 /** @var bool Whether or not lazy-loaded data has been loaded from the database */
82 protected $extraDataLoaded;
83
84 /** @var int Bitfield akin to rev_deleted */
85 protected $deleted;
86
87 /** @var string */
88 protected $repoClass = LocalRepo::class;
89
90 /** @var int Number of line to return by nextHistoryLine() (constructor) */
91 private $historyLine;
92
93 /** @var int Result of the query for the file's history (nextHistoryLine) */
94 private $historyRes;
95
96 /** @var string Major MIME type */
97 private $major_mime;
98
99 /** @var string Minor MIME type */
100 private $minor_mime;
101
102 /** @var string Upload timestamp */
103 private $timestamp;
104
105 /** @var User Uploader */
106 private $user;
107
108 /** @var string Description of current revision of the file */
109 private $description;
110
111 /** @var string TS_MW timestamp of the last change of the file description */
112 private $descriptionTouched;
113
114 /** @var bool Whether the row was upgraded on load */
115 private $upgraded;
116
117 /** @var bool Whether the row was scheduled to upgrade on load */
118 private $upgrading;
119
120 /** @var bool True if the image row is locked */
121 private $locked;
122
123 /** @var bool True if the image row is locked with a lock initiated transaction */
124 private $lockedOwnTrx;
125
126 /** @var bool True if file is not present in file system. Not to be cached in memcached */
127 private $missing;
128
129 // @note: higher than IDBAccessObject constants
130 const LOAD_ALL = 16; // integer; load all the lazy fields too (like metadata)
131
132 const ATOMIC_SECTION_LOCK = 'LocalFile::lockingTransaction';
133
134 /**
135 * Create a LocalFile from a title
136 * Do not call this except from inside a repo class.
137 *
138 * Note: $unused param is only here to avoid an E_STRICT
139 *
140 * @param Title $title
141 * @param FileRepo $repo
142 * @param null $unused
143 *
144 * @return self
145 */
146 static function newFromTitle( $title, $repo, $unused = null ) {
147 return new self( $title, $repo );
148 }
149
150 /**
151 * Create a LocalFile from a title
152 * Do not call this except from inside a repo class.
153 *
154 * @param stdClass $row
155 * @param FileRepo $repo
156 *
157 * @return self
158 */
159 static function newFromRow( $row, $repo ) {
160 $title = Title::makeTitle( NS_FILE, $row->img_name );
161 $file = new self( $title, $repo );
162 $file->loadFromRow( $row );
163
164 return $file;
165 }
166
167 /**
168 * Create a LocalFile from a SHA-1 key
169 * Do not call this except from inside a repo class.
170 *
171 * @param string $sha1 Base-36 SHA-1
172 * @param LocalRepo $repo
173 * @param string|bool $timestamp MW_timestamp (optional)
174 * @return bool|LocalFile
175 */
176 static function newFromKey( $sha1, $repo, $timestamp = false ) {
177 $dbr = $repo->getReplicaDB();
178
179 $conds = [ 'img_sha1' => $sha1 ];
180 if ( $timestamp ) {
181 $conds['img_timestamp'] = $dbr->timestamp( $timestamp );
182 }
183
184 $fileQuery = self::getQueryInfo();
185 $row = $dbr->selectRow(
186 $fileQuery['tables'], $fileQuery['fields'], $conds, __METHOD__, [], $fileQuery['joins']
187 );
188 if ( $row ) {
189 return self::newFromRow( $row, $repo );
190 } else {
191 return false;
192 }
193 }
194
195 /**
196 * Fields in the image table
197 * @deprecated since 1.31, use self::getQueryInfo() instead.
198 * @return string[]
199 */
200 static function selectFields() {
201 global $wgActorTableSchemaMigrationStage;
202
203 wfDeprecated( __METHOD__, '1.31' );
204 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW ) {
205 // If code is using this instead of self::getQueryInfo(), there's a
206 // decent chance it's going to try to directly access
207 // $row->img_user or $row->img_user_text and we can't give it
208 // useful values here once those aren't being used anymore.
209 throw new BadMethodCallException(
210 'Cannot use ' . __METHOD__
211 . ' when $wgActorTableSchemaMigrationStage has SCHEMA_COMPAT_READ_NEW'
212 );
213 }
214
215 return [
216 'img_name',
217 'img_size',
218 'img_width',
219 'img_height',
220 'img_metadata',
221 'img_bits',
222 'img_media_type',
223 'img_major_mime',
224 'img_minor_mime',
225 'img_user',
226 'img_user_text',
227 'img_actor' => 'NULL',
228 'img_timestamp',
229 'img_sha1',
230 ] + MediaWikiServices::getInstance()->getCommentStore()->getFields( 'img_description' );
231 }
232
233 /**
234 * Return the tables, fields, and join conditions to be selected to create
235 * a new localfile object.
236 * @since 1.31
237 * @param string[] $options
238 * - omit-lazy: Omit fields that are lazily cached.
239 * @return array[] With three keys:
240 * - tables: (string[]) to include in the `$table` to `IDatabase->select()`
241 * - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
242 * - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
243 */
244 public static function getQueryInfo( array $options = [] ) {
245 $commentQuery = MediaWikiServices::getInstance()->getCommentStore()->getJoin( 'img_description' );
246 $actorQuery = ActorMigration::newMigration()->getJoin( 'img_user' );
247 $ret = [
248 'tables' => [ 'image' ] + $commentQuery['tables'] + $actorQuery['tables'],
249 'fields' => [
250 'img_name',
251 'img_size',
252 'img_width',
253 'img_height',
254 'img_metadata',
255 'img_bits',
256 'img_media_type',
257 'img_major_mime',
258 'img_minor_mime',
259 'img_timestamp',
260 'img_sha1',
261 ] + $commentQuery['fields'] + $actorQuery['fields'],
262 'joins' => $commentQuery['joins'] + $actorQuery['joins'],
263 ];
264
265 if ( in_array( 'omit-nonlazy', $options, true ) ) {
266 // Internal use only for getting only the lazy fields
267 $ret['fields'] = [];
268 }
269 if ( !in_array( 'omit-lazy', $options, true ) ) {
270 // Note: Keep this in sync with self::getLazyCacheFields()
271 $ret['fields'][] = 'img_metadata';
272 }
273
274 return $ret;
275 }
276
277 /**
278 * Do not call this except from inside a repo class.
279 * @param Title $title
280 * @param FileRepo $repo
281 */
282 function __construct( $title, $repo ) {
283 parent::__construct( $title, $repo );
284
285 $this->metadata = '';
286 $this->historyLine = 0;
287 $this->historyRes = null;
288 $this->dataLoaded = false;
289 $this->extraDataLoaded = false;
290
291 $this->assertRepoDefined();
292 $this->assertTitleDefined();
293 }
294
295 /**
296 * Get the memcached key for the main data for this file, or false if
297 * there is no access to the shared cache.
298 * @return string|bool
299 */
300 function getCacheKey() {
301 return $this->repo->getSharedCacheKey( 'file', sha1( $this->getName() ) );
302 }
303
304 /**
305 * @param WANObjectCache $cache
306 * @return string[]
307 * @since 1.28
308 */
309 public function getMutableCacheKeys( WANObjectCache $cache ) {
310 return [ $this->getCacheKey() ];
311 }
312
313 /**
314 * Try to load file metadata from memcached, falling back to the database
315 */
316 private function loadFromCache() {
317 $this->dataLoaded = false;
318 $this->extraDataLoaded = false;
319
320 $key = $this->getCacheKey();
321 if ( !$key ) {
322 $this->loadFromDB( self::READ_NORMAL );
323
324 return;
325 }
326
327 $cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
328 $cachedValues = $cache->getWithSetCallback(
329 $key,
330 $cache::TTL_WEEK,
331 function ( $oldValue, &$ttl, array &$setOpts ) use ( $cache ) {
332 $setOpts += Database::getCacheSetOptions( $this->repo->getReplicaDB() );
333
334 $this->loadFromDB( self::READ_NORMAL );
335
336 $fields = $this->getCacheFields( '' );
337 $cacheVal['fileExists'] = $this->fileExists;
338 if ( $this->fileExists ) {
339 foreach ( $fields as $field ) {
340 $cacheVal[$field] = $this->$field;
341 }
342 }
343 $cacheVal['user'] = $this->user ? $this->user->getId() : 0;
344 $cacheVal['user_text'] = $this->user ? $this->user->getName() : '';
345 $cacheVal['actor'] = $this->user ? $this->user->getActorId() : null;
346
347 // Strip off excessive entries from the subset of fields that can become large.
348 // If the cache value gets to large it will not fit in memcached and nothing will
349 // get cached at all, causing master queries for any file access.
350 foreach ( $this->getLazyCacheFields( '' ) as $field ) {
351 if ( isset( $cacheVal[$field] )
352 && strlen( $cacheVal[$field] ) > 100 * 1024
353 ) {
354 unset( $cacheVal[$field] ); // don't let the value get too big
355 }
356 }
357
358 if ( $this->fileExists ) {
359 $ttl = $cache->adaptiveTTL( wfTimestamp( TS_UNIX, $this->timestamp ), $ttl );
360 } else {
361 $ttl = $cache::TTL_DAY;
362 }
363
364 return $cacheVal;
365 },
366 [ 'version' => self::VERSION ]
367 );
368
369 $this->fileExists = $cachedValues['fileExists'];
370 if ( $this->fileExists ) {
371 $this->setProps( $cachedValues );
372 }
373
374 $this->dataLoaded = true;
375 $this->extraDataLoaded = true;
376 foreach ( $this->getLazyCacheFields( '' ) as $field ) {
377 $this->extraDataLoaded = $this->extraDataLoaded && isset( $cachedValues[$field] );
378 }
379 }
380
381 /**
382 * Purge the file object/metadata cache
383 */
384 public function invalidateCache() {
385 $key = $this->getCacheKey();
386 if ( !$key ) {
387 return;
388 }
389
390 $this->repo->getMasterDB()->onTransactionPreCommitOrIdle(
391 function () use ( $key ) {
392 MediaWikiServices::getInstance()->getMainWANObjectCache()->delete( $key );
393 },
394 __METHOD__
395 );
396 }
397
398 /**
399 * Load metadata from the file itself
400 */
401 function loadFromFile() {
402 $props = $this->repo->getFileProps( $this->getVirtualUrl() );
403 $this->setProps( $props );
404 }
405
406 /**
407 * Returns the list of object properties that are included as-is in the cache.
408 * @param string $prefix Must be the empty string
409 * @return string[]
410 * @since 1.31 No longer accepts a non-empty $prefix
411 */
412 protected function getCacheFields( $prefix = 'img_' ) {
413 if ( $prefix !== '' ) {
414 throw new InvalidArgumentException(
415 __METHOD__ . ' with a non-empty prefix is no longer supported.'
416 );
417 }
418
419 // See self::getQueryInfo() for the fetching of the data from the DB,
420 // self::loadFromRow() for the loading of the object from the DB row,
421 // and self::loadFromCache() for the caching, and self::setProps() for
422 // populating the object from an array of data.
423 return [ 'size', 'width', 'height', 'bits', 'media_type',
424 'major_mime', 'minor_mime', 'metadata', 'timestamp', 'sha1', 'description' ];
425 }
426
427 /**
428 * Returns the list of object properties that are included as-is in the
429 * cache, only when they're not too big, and are lazily loaded by self::loadExtraFromDB().
430 * @param string $prefix Must be the empty string
431 * @return string[]
432 * @since 1.31 No longer accepts a non-empty $prefix
433 */
434 protected function getLazyCacheFields( $prefix = 'img_' ) {
435 if ( $prefix !== '' ) {
436 throw new InvalidArgumentException(
437 __METHOD__ . ' with a non-empty prefix is no longer supported.'
438 );
439 }
440
441 // Keep this in sync with the omit-lazy option in self::getQueryInfo().
442 return [ 'metadata' ];
443 }
444
445 /**
446 * Load file metadata from the DB
447 * @param int $flags
448 */
449 function loadFromDB( $flags = 0 ) {
450 $fname = static::class . '::' . __FUNCTION__;
451
452 # Unconditionally set loaded=true, we don't want the accessors constantly rechecking
453 $this->dataLoaded = true;
454 $this->extraDataLoaded = true;
455
456 $dbr = ( $flags & self::READ_LATEST )
457 ? $this->repo->getMasterDB()
458 : $this->repo->getReplicaDB();
459
460 $fileQuery = static::getQueryInfo();
461 $row = $dbr->selectRow(
462 $fileQuery['tables'],
463 $fileQuery['fields'],
464 [ 'img_name' => $this->getName() ],
465 $fname,
466 [],
467 $fileQuery['joins']
468 );
469
470 if ( $row ) {
471 $this->loadFromRow( $row );
472 } else {
473 $this->fileExists = false;
474 }
475 }
476
477 /**
478 * Load lazy file metadata from the DB.
479 * This covers fields that are sometimes not cached.
480 */
481 protected function loadExtraFromDB() {
482 $fname = static::class . '::' . __FUNCTION__;
483
484 # Unconditionally set loaded=true, we don't want the accessors constantly rechecking
485 $this->extraDataLoaded = true;
486
487 $fieldMap = $this->loadExtraFieldsWithTimestamp( $this->repo->getReplicaDB(), $fname );
488 if ( !$fieldMap ) {
489 $fieldMap = $this->loadExtraFieldsWithTimestamp( $this->repo->getMasterDB(), $fname );
490 }
491
492 if ( $fieldMap ) {
493 foreach ( $fieldMap as $name => $value ) {
494 $this->$name = $value;
495 }
496 } else {
497 throw new MWException( "Could not find data for image '{$this->getName()}'." );
498 }
499 }
500
501 /**
502 * @param IDatabase $dbr
503 * @param string $fname
504 * @return string[]|bool
505 */
506 private function loadExtraFieldsWithTimestamp( $dbr, $fname ) {
507 $fieldMap = false;
508
509 $fileQuery = self::getQueryInfo( [ 'omit-nonlazy' ] );
510 $row = $dbr->selectRow(
511 $fileQuery['tables'],
512 $fileQuery['fields'],
513 [
514 'img_name' => $this->getName(),
515 'img_timestamp' => $dbr->timestamp( $this->getTimestamp() ),
516 ],
517 $fname,
518 [],
519 $fileQuery['joins']
520 );
521 if ( $row ) {
522 $fieldMap = $this->unprefixRow( $row, 'img_' );
523 } else {
524 # File may have been uploaded over in the meantime; check the old versions
525 $fileQuery = OldLocalFile::getQueryInfo( [ 'omit-nonlazy' ] );
526 $row = $dbr->selectRow(
527 $fileQuery['tables'],
528 $fileQuery['fields'],
529 [
530 'oi_name' => $this->getName(),
531 'oi_timestamp' => $dbr->timestamp( $this->getTimestamp() ),
532 ],
533 $fname,
534 [],
535 $fileQuery['joins']
536 );
537 if ( $row ) {
538 $fieldMap = $this->unprefixRow( $row, 'oi_' );
539 }
540 }
541
542 if ( isset( $fieldMap['metadata'] ) ) {
543 $fieldMap['metadata'] = $this->repo->getReplicaDB()->decodeBlob( $fieldMap['metadata'] );
544 }
545
546 return $fieldMap;
547 }
548
549 /**
550 * @param array|object $row
551 * @param string $prefix
552 * @throws MWException
553 * @return array
554 */
555 protected function unprefixRow( $row, $prefix = 'img_' ) {
556 $array = (array)$row;
557 $prefixLength = strlen( $prefix );
558
559 // Sanity check prefix once
560 if ( substr( key( $array ), 0, $prefixLength ) !== $prefix ) {
561 throw new MWException( __METHOD__ . ': incorrect $prefix parameter' );
562 }
563
564 $decoded = [];
565 foreach ( $array as $name => $value ) {
566 $decoded[substr( $name, $prefixLength )] = $value;
567 }
568
569 return $decoded;
570 }
571
572 /**
573 * Decode a row from the database (either object or array) to an array
574 * with timestamps and MIME types decoded, and the field prefix removed.
575 * @param object $row
576 * @param string $prefix
577 * @throws MWException
578 * @return array
579 */
580 function decodeRow( $row, $prefix = 'img_' ) {
581 $decoded = $this->unprefixRow( $row, $prefix );
582
583 $decoded['description'] = MediaWikiServices::getInstance()->getCommentStore()
584 ->getComment( 'description', (object)$decoded )->text;
585
586 $decoded['user'] = User::newFromAnyId(
587 $decoded['user'] ?? null,
588 $decoded['user_text'] ?? null,
589 $decoded['actor'] ?? null
590 );
591 unset( $decoded['user_text'], $decoded['actor'] );
592
593 $decoded['timestamp'] = wfTimestamp( TS_MW, $decoded['timestamp'] );
594
595 $decoded['metadata'] = $this->repo->getReplicaDB()->decodeBlob( $decoded['metadata'] );
596
597 if ( empty( $decoded['major_mime'] ) ) {
598 $decoded['mime'] = 'unknown/unknown';
599 } else {
600 if ( !$decoded['minor_mime'] ) {
601 $decoded['minor_mime'] = 'unknown';
602 }
603 $decoded['mime'] = $decoded['major_mime'] . '/' . $decoded['minor_mime'];
604 }
605
606 // Trim zero padding from char/binary field
607 $decoded['sha1'] = rtrim( $decoded['sha1'], "\0" );
608
609 // Normalize some fields to integer type, per their database definition.
610 // Use unary + so that overflows will be upgraded to double instead of
611 // being trucated as with intval(). This is important to allow >2GB
612 // files on 32-bit systems.
613 foreach ( [ 'size', 'width', 'height', 'bits' ] as $field ) {
614 $decoded[$field] = +$decoded[$field];
615 }
616
617 return $decoded;
618 }
619
620 /**
621 * Load file metadata from a DB result row
622 *
623 * @param object $row
624 * @param string $prefix
625 */
626 function loadFromRow( $row, $prefix = 'img_' ) {
627 $this->dataLoaded = true;
628 $this->extraDataLoaded = true;
629
630 $array = $this->decodeRow( $row, $prefix );
631
632 foreach ( $array as $name => $value ) {
633 $this->$name = $value;
634 }
635
636 $this->fileExists = true;
637 $this->maybeUpgradeRow();
638 }
639
640 /**
641 * Load file metadata from cache or DB, unless already loaded
642 * @param int $flags
643 */
644 function load( $flags = 0 ) {
645 if ( !$this->dataLoaded ) {
646 if ( $flags & self::READ_LATEST ) {
647 $this->loadFromDB( $flags );
648 } else {
649 $this->loadFromCache();
650 }
651 }
652
653 if ( ( $flags & self::LOAD_ALL ) && !$this->extraDataLoaded ) {
654 // @note: loads on name/timestamp to reduce race condition problems
655 $this->loadExtraFromDB();
656 }
657 }
658
659 /**
660 * Upgrade a row if it needs it
661 */
662 function maybeUpgradeRow() {
663 global $wgUpdateCompatibleMetadata;
664
665 if ( wfReadOnly() || $this->upgrading ) {
666 return;
667 }
668
669 $upgrade = false;
670 if ( is_null( $this->media_type ) || $this->mime == 'image/svg' ) {
671 $upgrade = true;
672 } else {
673 $handler = $this->getHandler();
674 if ( $handler ) {
675 $validity = $handler->isMetadataValid( $this, $this->getMetadata() );
676 if ( $validity === MediaHandler::METADATA_BAD ) {
677 $upgrade = true;
678 } elseif ( $validity === MediaHandler::METADATA_COMPATIBLE ) {
679 $upgrade = $wgUpdateCompatibleMetadata;
680 }
681 }
682 }
683
684 if ( $upgrade ) {
685 $this->upgrading = true;
686 // Defer updates unless in auto-commit CLI mode
687 DeferredUpdates::addCallableUpdate( function () {
688 $this->upgrading = false; // avoid duplicate updates
689 try {
690 $this->upgradeRow();
691 } catch ( LocalFileLockError $e ) {
692 // let the other process handle it (or do it next time)
693 }
694 } );
695 }
696 }
697
698 /**
699 * @return bool Whether upgradeRow() ran for this object
700 */
701 function getUpgraded() {
702 return $this->upgraded;
703 }
704
705 /**
706 * Fix assorted version-related problems with the image row by reloading it from the file
707 */
708 function upgradeRow() {
709 $this->lock();
710
711 $this->loadFromFile();
712
713 # Don't destroy file info of missing files
714 if ( !$this->fileExists ) {
715 $this->unlock();
716 wfDebug( __METHOD__ . ": file does not exist, aborting\n" );
717
718 return;
719 }
720
721 $dbw = $this->repo->getMasterDB();
722 list( $major, $minor ) = self::splitMime( $this->mime );
723
724 if ( wfReadOnly() ) {
725 $this->unlock();
726
727 return;
728 }
729 wfDebug( __METHOD__ . ': upgrading ' . $this->getName() . " to the current schema\n" );
730
731 $dbw->update( 'image',
732 [
733 'img_size' => $this->size, // sanity
734 'img_width' => $this->width,
735 'img_height' => $this->height,
736 'img_bits' => $this->bits,
737 'img_media_type' => $this->media_type,
738 'img_major_mime' => $major,
739 'img_minor_mime' => $minor,
740 'img_metadata' => $dbw->encodeBlob( $this->metadata ),
741 'img_sha1' => $this->sha1,
742 ],
743 [ 'img_name' => $this->getName() ],
744 __METHOD__
745 );
746
747 $this->invalidateCache();
748
749 $this->unlock();
750 $this->upgraded = true; // avoid rework/retries
751 }
752
753 /**
754 * Set properties in this object to be equal to those given in the
755 * associative array $info. Only cacheable fields can be set.
756 * All fields *must* be set in $info except for getLazyCacheFields().
757 *
758 * If 'mime' is given, it will be split into major_mime/minor_mime.
759 * If major_mime/minor_mime are given, $this->mime will also be set.
760 *
761 * @param array $info
762 */
763 function setProps( $info ) {
764 $this->dataLoaded = true;
765 $fields = $this->getCacheFields( '' );
766 $fields[] = 'fileExists';
767
768 foreach ( $fields as $field ) {
769 if ( isset( $info[$field] ) ) {
770 $this->$field = $info[$field];
771 }
772 }
773
774 if ( isset( $info['user'] ) || isset( $info['user_text'] ) || isset( $info['actor'] ) ) {
775 $this->user = User::newFromAnyId(
776 $info['user'] ?? null,
777 $info['user_text'] ?? null,
778 $info['actor'] ?? null
779 );
780 }
781
782 // Fix up mime fields
783 if ( isset( $info['major_mime'] ) ) {
784 $this->mime = "{$info['major_mime']}/{$info['minor_mime']}";
785 } elseif ( isset( $info['mime'] ) ) {
786 $this->mime = $info['mime'];
787 list( $this->major_mime, $this->minor_mime ) = self::splitMime( $this->mime );
788 }
789 }
790
791 /** splitMime inherited */
792 /** getName inherited */
793 /** getTitle inherited */
794 /** getURL inherited */
795 /** getViewURL inherited */
796 /** getPath inherited */
797 /** isVisible inherited */
798
799 /**
800 * @return bool
801 */
802 function isMissing() {
803 if ( $this->missing === null ) {
804 list( $fileExists ) = $this->repo->fileExists( $this->getVirtualUrl() );
805 $this->missing = !$fileExists;
806 }
807
808 return $this->missing;
809 }
810
811 /**
812 * Return the width of the image
813 *
814 * @param int $page
815 * @return int
816 */
817 public function getWidth( $page = 1 ) {
818 $page = (int)$page;
819 if ( $page < 1 ) {
820 $page = 1;
821 }
822
823 $this->load();
824
825 if ( $this->isMultipage() ) {
826 $handler = $this->getHandler();
827 if ( !$handler ) {
828 return 0;
829 }
830 $dim = $handler->getPageDimensions( $this, $page );
831 if ( $dim ) {
832 return $dim['width'];
833 } else {
834 // For non-paged media, the false goes through an
835 // intval, turning failure into 0, so do same here.
836 return 0;
837 }
838 } else {
839 return $this->width;
840 }
841 }
842
843 /**
844 * Return the height of the image
845 *
846 * @param int $page
847 * @return int
848 */
849 public function getHeight( $page = 1 ) {
850 $page = (int)$page;
851 if ( $page < 1 ) {
852 $page = 1;
853 }
854
855 $this->load();
856
857 if ( $this->isMultipage() ) {
858 $handler = $this->getHandler();
859 if ( !$handler ) {
860 return 0;
861 }
862 $dim = $handler->getPageDimensions( $this, $page );
863 if ( $dim ) {
864 return $dim['height'];
865 } else {
866 // For non-paged media, the false goes through an
867 // intval, turning failure into 0, so do same here.
868 return 0;
869 }
870 } else {
871 return $this->height;
872 }
873 }
874
875 /**
876 * Returns user who uploaded the file
877 *
878 * @param string $type 'text', 'id', or 'object'
879 * @return int|string|User
880 * @since 1.31 Added 'object'
881 */
882 function getUser( $type = 'text' ) {
883 $this->load();
884
885 if ( $type === 'object' ) {
886 return $this->user;
887 } elseif ( $type === 'text' ) {
888 return $this->user->getName();
889 } elseif ( $type === 'id' ) {
890 return $this->user->getId();
891 }
892
893 throw new MWException( "Unknown type '$type'." );
894 }
895
896 /**
897 * Get short description URL for a file based on the page ID.
898 *
899 * @return string|null
900 * @throws MWException
901 * @since 1.27
902 */
903 public function getDescriptionShortUrl() {
904 $pageId = $this->title->getArticleID();
905
906 if ( $pageId !== null ) {
907 $url = $this->repo->makeUrl( [ 'curid' => $pageId ] );
908 if ( $url !== false ) {
909 return $url;
910 }
911 }
912 return null;
913 }
914
915 /**
916 * Get handler-specific metadata
917 * @return string
918 */
919 function getMetadata() {
920 $this->load( self::LOAD_ALL ); // large metadata is loaded in another step
921 return $this->metadata;
922 }
923
924 /**
925 * @return int
926 */
927 function getBitDepth() {
928 $this->load();
929
930 return (int)$this->bits;
931 }
932
933 /**
934 * Returns the size of the image file, in bytes
935 * @return int
936 */
937 public function getSize() {
938 $this->load();
939
940 return $this->size;
941 }
942
943 /**
944 * Returns the MIME type of the file.
945 * @return string
946 */
947 function getMimeType() {
948 $this->load();
949
950 return $this->mime;
951 }
952
953 /**
954 * Returns the type of the media in the file.
955 * Use the value returned by this function with the MEDIATYPE_xxx constants.
956 * @return string
957 */
958 function getMediaType() {
959 $this->load();
960
961 return $this->media_type;
962 }
963
964 /** canRender inherited */
965 /** mustRender inherited */
966 /** allowInlineDisplay inherited */
967 /** isSafeFile inherited */
968 /** isTrustedFile inherited */
969
970 /**
971 * Returns true if the file exists on disk.
972 * @return bool Whether file exist on disk.
973 */
974 public function exists() {
975 $this->load();
976
977 return $this->fileExists;
978 }
979
980 /** getTransformScript inherited */
981 /** getUnscaledThumb inherited */
982 /** thumbName inherited */
983 /** createThumb inherited */
984 /** transform inherited */
985
986 /** getHandler inherited */
987 /** iconThumb inherited */
988 /** getLastError inherited */
989
990 /**
991 * Get all thumbnail names previously generated for this file
992 * @param string|bool $archiveName Name of an archive file, default false
993 * @return array First element is the base dir, then files in that base dir.
994 */
995 function getThumbnails( $archiveName = false ) {
996 if ( $archiveName ) {
997 $dir = $this->getArchiveThumbPath( $archiveName );
998 } else {
999 $dir = $this->getThumbPath();
1000 }
1001
1002 $backend = $this->repo->getBackend();
1003 $files = [ $dir ];
1004 try {
1005 $iterator = $backend->getFileList( [ 'dir' => $dir ] );
1006 foreach ( $iterator as $file ) {
1007 $files[] = $file;
1008 }
1009 } catch ( FileBackendError $e ) {
1010 } // suppress (T56674)
1011
1012 return $files;
1013 }
1014
1015 /**
1016 * Refresh metadata in memcached, but don't touch thumbnails or CDN
1017 */
1018 function purgeMetadataCache() {
1019 $this->invalidateCache();
1020 }
1021
1022 /**
1023 * Delete all previously generated thumbnails, refresh metadata in memcached and purge the CDN.
1024 *
1025 * @param array $options An array potentially with the key forThumbRefresh.
1026 *
1027 * @note This used to purge old thumbnails by default as well, but doesn't anymore.
1028 */
1029 function purgeCache( $options = [] ) {
1030 // Refresh metadata cache
1031 $this->purgeMetadataCache();
1032
1033 // Delete thumbnails
1034 $this->purgeThumbnails( $options );
1035
1036 // Purge CDN cache for this file
1037 DeferredUpdates::addUpdate(
1038 new CdnCacheUpdate( [ $this->getUrl() ] ),
1039 DeferredUpdates::PRESEND
1040 );
1041 }
1042
1043 /**
1044 * Delete cached transformed files for an archived version only.
1045 * @param string $archiveName Name of the archived file
1046 */
1047 function purgeOldThumbnails( $archiveName ) {
1048 // Get a list of old thumbnails and URLs
1049 $files = $this->getThumbnails( $archiveName );
1050
1051 // Purge any custom thumbnail caches
1052 Hooks::run( 'LocalFilePurgeThumbnails', [ $this, $archiveName ] );
1053
1054 // Delete thumbnails
1055 $dir = array_shift( $files );
1056 $this->purgeThumbList( $dir, $files );
1057
1058 // Purge the CDN
1059 $urls = [];
1060 foreach ( $files as $file ) {
1061 $urls[] = $this->getArchiveThumbUrl( $archiveName, $file );
1062 }
1063 DeferredUpdates::addUpdate( new CdnCacheUpdate( $urls ), DeferredUpdates::PRESEND );
1064 }
1065
1066 /**
1067 * Delete cached transformed files for the current version only.
1068 * @param array $options
1069 */
1070 public function purgeThumbnails( $options = [] ) {
1071 $files = $this->getThumbnails();
1072 // Always purge all files from CDN regardless of handler filters
1073 $urls = [];
1074 foreach ( $files as $file ) {
1075 $urls[] = $this->getThumbUrl( $file );
1076 }
1077 array_shift( $urls ); // don't purge directory
1078
1079 // Give media handler a chance to filter the file purge list
1080 if ( !empty( $options['forThumbRefresh'] ) ) {
1081 $handler = $this->getHandler();
1082 if ( $handler ) {
1083 $handler->filterThumbnailPurgeList( $files, $options );
1084 }
1085 }
1086
1087 // Purge any custom thumbnail caches
1088 Hooks::run( 'LocalFilePurgeThumbnails', [ $this, false ] );
1089
1090 // Delete thumbnails
1091 $dir = array_shift( $files );
1092 $this->purgeThumbList( $dir, $files );
1093
1094 // Purge the CDN
1095 DeferredUpdates::addUpdate( new CdnCacheUpdate( $urls ), DeferredUpdates::PRESEND );
1096 }
1097
1098 /**
1099 * Prerenders a configurable set of thumbnails
1100 *
1101 * @since 1.28
1102 */
1103 public function prerenderThumbnails() {
1104 global $wgUploadThumbnailRenderMap;
1105
1106 $jobs = [];
1107
1108 $sizes = $wgUploadThumbnailRenderMap;
1109 rsort( $sizes );
1110
1111 foreach ( $sizes as $size ) {
1112 if ( $this->isVectorized() || $this->getWidth() > $size ) {
1113 $jobs[] = new ThumbnailRenderJob(
1114 $this->getTitle(),
1115 [ 'transformParams' => [ 'width' => $size ] ]
1116 );
1117 }
1118 }
1119
1120 if ( $jobs ) {
1121 JobQueueGroup::singleton()->lazyPush( $jobs );
1122 }
1123 }
1124
1125 /**
1126 * Delete a list of thumbnails visible at urls
1127 * @param string $dir Base dir of the files.
1128 * @param array $files Array of strings: relative filenames (to $dir)
1129 */
1130 protected function purgeThumbList( $dir, $files ) {
1131 $fileListDebug = strtr(
1132 var_export( $files, true ),
1133 [ "\n" => '' ]
1134 );
1135 wfDebug( __METHOD__ . ": $fileListDebug\n" );
1136
1137 $purgeList = [];
1138 foreach ( $files as $file ) {
1139 if ( $this->repo->supportsSha1URLs() ) {
1140 $reference = $this->getSha1();
1141 } else {
1142 $reference = $this->getName();
1143 }
1144
1145 # Check that the reference (filename or sha1) is part of the thumb name
1146 # This is a basic sanity check to avoid erasing unrelated directories
1147 if ( strpos( $file, $reference ) !== false
1148 || strpos( $file, "-thumbnail" ) !== false // "short" thumb name
1149 ) {
1150 $purgeList[] = "{$dir}/{$file}";
1151 }
1152 }
1153
1154 # Delete the thumbnails
1155 $this->repo->quickPurgeBatch( $purgeList );
1156 # Clear out the thumbnail directory if empty
1157 $this->repo->quickCleanDir( $dir );
1158 }
1159
1160 /** purgeDescription inherited */
1161 /** purgeEverything inherited */
1162
1163 /**
1164 * @param int|null $limit Optional: Limit to number of results
1165 * @param string|int|null $start Optional: Timestamp, start from
1166 * @param string|int|null $end Optional: Timestamp, end at
1167 * @param bool $inc
1168 * @return OldLocalFile[]
1169 */
1170 function getHistory( $limit = null, $start = null, $end = null, $inc = true ) {
1171 $dbr = $this->repo->getReplicaDB();
1172 $oldFileQuery = OldLocalFile::getQueryInfo();
1173
1174 $tables = $oldFileQuery['tables'];
1175 $fields = $oldFileQuery['fields'];
1176 $join_conds = $oldFileQuery['joins'];
1177 $conds = $opts = [];
1178 $eq = $inc ? '=' : '';
1179 $conds[] = "oi_name = " . $dbr->addQuotes( $this->title->getDBkey() );
1180
1181 if ( $start ) {
1182 $conds[] = "oi_timestamp <$eq " . $dbr->addQuotes( $dbr->timestamp( $start ) );
1183 }
1184
1185 if ( $end ) {
1186 $conds[] = "oi_timestamp >$eq " . $dbr->addQuotes( $dbr->timestamp( $end ) );
1187 }
1188
1189 if ( $limit ) {
1190 $opts['LIMIT'] = $limit;
1191 }
1192
1193 // Search backwards for time > x queries
1194 $order = ( !$start && $end !== null ) ? 'ASC' : 'DESC';
1195 $opts['ORDER BY'] = "oi_timestamp $order";
1196 $opts['USE INDEX'] = [ 'oldimage' => 'oi_name_timestamp' ];
1197
1198 // Avoid PHP 7.1 warning from passing $this by reference
1199 $localFile = $this;
1200 Hooks::run( 'LocalFile::getHistory', [ &$localFile, &$tables, &$fields,
1201 &$conds, &$opts, &$join_conds ] );
1202
1203 $res = $dbr->select( $tables, $fields, $conds, __METHOD__, $opts, $join_conds );
1204 $r = [];
1205
1206 foreach ( $res as $row ) {
1207 $r[] = $this->repo->newFileFromRow( $row );
1208 }
1209
1210 if ( $order == 'ASC' ) {
1211 $r = array_reverse( $r ); // make sure it ends up descending
1212 }
1213
1214 return $r;
1215 }
1216
1217 /**
1218 * Returns the history of this file, line by line.
1219 * starts with current version, then old versions.
1220 * uses $this->historyLine to check which line to return:
1221 * 0 return line for current version
1222 * 1 query for old versions, return first one
1223 * 2, ... return next old version from above query
1224 * @return bool
1225 */
1226 public function nextHistoryLine() {
1227 # Polymorphic function name to distinguish foreign and local fetches
1228 $fname = static::class . '::' . __FUNCTION__;
1229
1230 $dbr = $this->repo->getReplicaDB();
1231
1232 if ( $this->historyLine == 0 ) { // called for the first time, return line from cur
1233 $fileQuery = self::getQueryInfo();
1234 $this->historyRes = $dbr->select( $fileQuery['tables'],
1235 $fileQuery['fields'] + [
1236 'oi_archive_name' => $dbr->addQuotes( '' ),
1237 'oi_deleted' => 0,
1238 ],
1239 [ 'img_name' => $this->title->getDBkey() ],
1240 $fname,
1241 [],
1242 $fileQuery['joins']
1243 );
1244
1245 if ( $dbr->numRows( $this->historyRes ) == 0 ) {
1246 $this->historyRes = null;
1247
1248 return false;
1249 }
1250 } elseif ( $this->historyLine == 1 ) {
1251 $fileQuery = OldLocalFile::getQueryInfo();
1252 $this->historyRes = $dbr->select(
1253 $fileQuery['tables'],
1254 $fileQuery['fields'],
1255 [ 'oi_name' => $this->title->getDBkey() ],
1256 $fname,
1257 [ 'ORDER BY' => 'oi_timestamp DESC' ],
1258 $fileQuery['joins']
1259 );
1260 }
1261 $this->historyLine++;
1262
1263 return $dbr->fetchObject( $this->historyRes );
1264 }
1265
1266 /**
1267 * Reset the history pointer to the first element of the history
1268 */
1269 public function resetHistory() {
1270 $this->historyLine = 0;
1271
1272 if ( !is_null( $this->historyRes ) ) {
1273 $this->historyRes = null;
1274 }
1275 }
1276
1277 /** getHashPath inherited */
1278 /** getRel inherited */
1279 /** getUrlRel inherited */
1280 /** getArchiveRel inherited */
1281 /** getArchivePath inherited */
1282 /** getThumbPath inherited */
1283 /** getArchiveUrl inherited */
1284 /** getThumbUrl inherited */
1285 /** getArchiveVirtualUrl inherited */
1286 /** getThumbVirtualUrl inherited */
1287 /** isHashed inherited */
1288
1289 /**
1290 * Upload a file and record it in the DB
1291 * @param string|FSFile $src Source storage path, virtual URL, or filesystem path
1292 * @param string $comment Upload description
1293 * @param string $pageText Text to use for the new description page,
1294 * if a new description page is created
1295 * @param int|bool $flags Flags for publish()
1296 * @param array|bool $props File properties, if known. This can be used to
1297 * reduce the upload time when uploading virtual URLs for which the file
1298 * info is already known
1299 * @param string|bool $timestamp Timestamp for img_timestamp, or false to use the
1300 * current time
1301 * @param User|null $user User object or null to use $wgUser
1302 * @param string[] $tags Change tags to add to the log entry and page revision.
1303 * (This doesn't check $user's permissions.)
1304 * @param bool $createNullRevision Set to false to avoid creation of a null revision on file
1305 * upload, see T193621
1306 * @return Status On success, the value member contains the
1307 * archive name, or an empty string if it was a new file.
1308 */
1309 function upload( $src, $comment, $pageText, $flags = 0, $props = false,
1310 $timestamp = false, $user = null, $tags = [],
1311 $createNullRevision = true
1312 ) {
1313 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1314 return $this->readOnlyFatalStatus();
1315 } elseif ( MediaWikiServices::getInstance()->getRevisionStore()->isReadOnly() ) {
1316 // Check this in advance to avoid writing to FileBackend and the file tables,
1317 // only to fail on insert the revision due to the text store being unavailable.
1318 return $this->readOnlyFatalStatus();
1319 }
1320
1321 $srcPath = ( $src instanceof FSFile ) ? $src->getPath() : $src;
1322 if ( !$props ) {
1323 if ( FileRepo::isVirtualUrl( $srcPath )
1324 || FileBackend::isStoragePath( $srcPath )
1325 ) {
1326 $props = $this->repo->getFileProps( $srcPath );
1327 } else {
1328 $mwProps = new MWFileProps( MediaWikiServices::getInstance()->getMimeAnalyzer() );
1329 $props = $mwProps->getPropsFromPath( $srcPath, true );
1330 }
1331 }
1332
1333 $options = [];
1334 $handler = MediaHandler::getHandler( $props['mime'] );
1335 if ( $handler ) {
1336 $metadata = Wikimedia\quietCall( 'unserialize', $props['metadata'] );
1337
1338 if ( !is_array( $metadata ) ) {
1339 $metadata = [];
1340 }
1341
1342 $options['headers'] = $handler->getContentHeaders( $metadata );
1343 } else {
1344 $options['headers'] = [];
1345 }
1346
1347 // Trim spaces on user supplied text
1348 $comment = trim( $comment );
1349
1350 $this->lock();
1351 $status = $this->publish( $src, $flags, $options );
1352
1353 if ( $status->successCount >= 2 ) {
1354 // There will be a copy+(one of move,copy,store).
1355 // The first succeeding does not commit us to updating the DB
1356 // since it simply copied the current version to a timestamped file name.
1357 // It is only *preferable* to avoid leaving such files orphaned.
1358 // Once the second operation goes through, then the current version was
1359 // updated and we must therefore update the DB too.
1360 $oldver = $status->value;
1361 $uploadStatus = $this->recordUpload2(
1362 $oldver,
1363 $comment,
1364 $pageText,
1365 $props,
1366 $timestamp,
1367 $user,
1368 $tags,
1369 $createNullRevision
1370 );
1371 if ( !$uploadStatus->isOK() ) {
1372 if ( $uploadStatus->hasMessage( 'filenotfound' ) ) {
1373 // update filenotfound error with more specific path
1374 $status->fatal( 'filenotfound', $srcPath );
1375 } else {
1376 $status->merge( $uploadStatus );
1377 }
1378 }
1379 }
1380
1381 $this->unlock();
1382 return $status;
1383 }
1384
1385 /**
1386 * Record a file upload in the upload log and the image table
1387 * @param string $oldver
1388 * @param string $desc
1389 * @param string $license
1390 * @param string $copyStatus
1391 * @param string $source
1392 * @param bool $watch
1393 * @param string|bool $timestamp
1394 * @param User|null $user User object or null to use $wgUser
1395 * @return bool
1396 */
1397 function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '',
1398 $watch = false, $timestamp = false, User $user = null ) {
1399 if ( !$user ) {
1400 global $wgUser;
1401 $user = $wgUser;
1402 }
1403
1404 $pageText = SpecialUpload::getInitialPageText( $desc, $license, $copyStatus, $source );
1405
1406 if ( !$this->recordUpload2( $oldver, $desc, $pageText, false, $timestamp, $user )->isOK() ) {
1407 return false;
1408 }
1409
1410 if ( $watch ) {
1411 $user->addWatch( $this->getTitle() );
1412 }
1413
1414 return true;
1415 }
1416
1417 /**
1418 * Record a file upload in the upload log and the image table
1419 * @param string $oldver
1420 * @param string $comment
1421 * @param string $pageText
1422 * @param bool|array $props
1423 * @param string|bool $timestamp
1424 * @param null|User $user
1425 * @param string[] $tags
1426 * @param bool $createNullRevision Set to false to avoid creation of a null revision on file
1427 * upload, see T193621
1428 * @return Status
1429 */
1430 function recordUpload2(
1431 $oldver, $comment, $pageText, $props = false, $timestamp = false, $user = null, $tags = [],
1432 $createNullRevision = true
1433 ) {
1434 global $wgCommentTableSchemaMigrationStage, $wgActorTableSchemaMigrationStage;
1435
1436 if ( is_null( $user ) ) {
1437 global $wgUser;
1438 $user = $wgUser;
1439 }
1440
1441 $dbw = $this->repo->getMasterDB();
1442
1443 # Imports or such might force a certain timestamp; otherwise we generate
1444 # it and can fudge it slightly to keep (name,timestamp) unique on re-upload.
1445 if ( $timestamp === false ) {
1446 $timestamp = $dbw->timestamp();
1447 $allowTimeKludge = true;
1448 } else {
1449 $allowTimeKludge = false;
1450 }
1451
1452 $props = $props ?: $this->repo->getFileProps( $this->getVirtualUrl() );
1453 $props['description'] = $comment;
1454 $props['user'] = $user->getId();
1455 $props['user_text'] = $user->getName();
1456 $props['actor'] = $user->getActorId( $dbw );
1457 $props['timestamp'] = wfTimestamp( TS_MW, $timestamp ); // DB -> TS_MW
1458 $this->setProps( $props );
1459
1460 # Fail now if the file isn't there
1461 if ( !$this->fileExists ) {
1462 wfDebug( __METHOD__ . ": File " . $this->getRel() . " went missing!\n" );
1463
1464 return Status::newFatal( 'filenotfound', $this->getRel() );
1465 }
1466
1467 $dbw->startAtomic( __METHOD__ );
1468
1469 # Test to see if the row exists using INSERT IGNORE
1470 # This avoids race conditions by locking the row until the commit, and also
1471 # doesn't deadlock. SELECT FOR UPDATE causes a deadlock for every race condition.
1472 $commentStore = MediaWikiServices::getInstance()->getCommentStore();
1473 $commentFields = $commentStore->insert( $dbw, 'img_description', $comment );
1474 $actorMigration = ActorMigration::newMigration();
1475 $actorFields = $actorMigration->getInsertValues( $dbw, 'img_user', $user );
1476 $dbw->insert( 'image',
1477 [
1478 'img_name' => $this->getName(),
1479 'img_size' => $this->size,
1480 'img_width' => intval( $this->width ),
1481 'img_height' => intval( $this->height ),
1482 'img_bits' => $this->bits,
1483 'img_media_type' => $this->media_type,
1484 'img_major_mime' => $this->major_mime,
1485 'img_minor_mime' => $this->minor_mime,
1486 'img_timestamp' => $timestamp,
1487 'img_metadata' => $dbw->encodeBlob( $this->metadata ),
1488 'img_sha1' => $this->sha1
1489 ] + $commentFields + $actorFields,
1490 __METHOD__,
1491 'IGNORE'
1492 );
1493 $reupload = ( $dbw->affectedRows() == 0 );
1494
1495 if ( $reupload ) {
1496 $row = $dbw->selectRow(
1497 'image',
1498 [ 'img_timestamp', 'img_sha1' ],
1499 [ 'img_name' => $this->getName() ],
1500 __METHOD__,
1501 [ 'LOCK IN SHARE MODE' ]
1502 );
1503
1504 if ( $row && $row->img_sha1 === $this->sha1 ) {
1505 $dbw->endAtomic( __METHOD__ );
1506 wfDebug( __METHOD__ . ": File " . $this->getRel() . " already exists!\n" );
1507 $title = Title::newFromText( $this->getName(), NS_FILE );
1508 return Status::newFatal( 'fileexists-no-change', $title->getPrefixedText() );
1509 }
1510
1511 if ( $allowTimeKludge ) {
1512 # Use LOCK IN SHARE MODE to ignore any transaction snapshotting
1513 $lUnixtime = $row ? wfTimestamp( TS_UNIX, $row->img_timestamp ) : false;
1514 # Avoid a timestamp that is not newer than the last version
1515 # TODO: the image/oldimage tables should be like page/revision with an ID field
1516 if ( $lUnixtime && wfTimestamp( TS_UNIX, $timestamp ) <= $lUnixtime ) {
1517 sleep( 1 ); // fast enough re-uploads would go far in the future otherwise
1518 $timestamp = $dbw->timestamp( $lUnixtime + 1 );
1519 $this->timestamp = wfTimestamp( TS_MW, $timestamp ); // DB -> TS_MW
1520 }
1521 }
1522
1523 $tables = [ 'image' ];
1524 $fields = [
1525 'oi_name' => 'img_name',
1526 'oi_archive_name' => $dbw->addQuotes( $oldver ),
1527 'oi_size' => 'img_size',
1528 'oi_width' => 'img_width',
1529 'oi_height' => 'img_height',
1530 'oi_bits' => 'img_bits',
1531 'oi_timestamp' => 'img_timestamp',
1532 'oi_metadata' => 'img_metadata',
1533 'oi_media_type' => 'img_media_type',
1534 'oi_major_mime' => 'img_major_mime',
1535 'oi_minor_mime' => 'img_minor_mime',
1536 'oi_sha1' => 'img_sha1',
1537 ];
1538 $joins = [];
1539
1540 if ( $wgCommentTableSchemaMigrationStage <= MIGRATION_WRITE_BOTH ) {
1541 $fields['oi_description'] = 'img_description';
1542 }
1543 if ( $wgCommentTableSchemaMigrationStage >= MIGRATION_WRITE_BOTH ) {
1544 $fields['oi_description_id'] = 'img_description_id';
1545 }
1546
1547 if ( $wgCommentTableSchemaMigrationStage !== MIGRATION_OLD &&
1548 $wgCommentTableSchemaMigrationStage !== MIGRATION_NEW
1549 ) {
1550 // Upgrade any rows that are still old-style. Otherwise an upgrade
1551 // might be missed if a deletion happens while the migration script
1552 // is running.
1553 $res = $dbw->select(
1554 [ 'image' ],
1555 [ 'img_name', 'img_description' ],
1556 [
1557 'img_name' => $this->getName(),
1558 'img_description_id' => 0,
1559 ],
1560 __METHOD__
1561 );
1562 foreach ( $res as $row ) {
1563 $imgFields = $commentStore->insert( $dbw, 'img_description', $row->img_description );
1564 $dbw->update(
1565 'image',
1566 $imgFields,
1567 [ 'img_name' => $row->img_name ],
1568 __METHOD__
1569 );
1570 }
1571 }
1572
1573 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_OLD ) {
1574 $fields['oi_user'] = 'img_user';
1575 $fields['oi_user_text'] = 'img_user_text';
1576 }
1577 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW ) {
1578 $fields['oi_actor'] = 'img_actor';
1579 }
1580
1581 if (
1582 ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_BOTH ) === SCHEMA_COMPAT_WRITE_BOTH
1583 ) {
1584 // Upgrade any rows that are still old-style. Otherwise an upgrade
1585 // might be missed if a deletion happens while the migration script
1586 // is running.
1587 $res = $dbw->select(
1588 [ 'image' ],
1589 [ 'img_name', 'img_user', 'img_user_text' ],
1590 [ 'img_name' => $this->getName(), 'img_actor' => 0 ],
1591 __METHOD__
1592 );
1593 foreach ( $res as $row ) {
1594 $actorId = User::newFromAnyId( $row->img_user, $row->img_user_text, null )->getActorId( $dbw );
1595 $dbw->update(
1596 'image',
1597 [ 'img_actor' => $actorId ],
1598 [ 'img_name' => $row->img_name, 'img_actor' => 0 ],
1599 __METHOD__
1600 );
1601 }
1602 }
1603
1604 # (T36993) Note: $oldver can be empty here, if the previous
1605 # version of the file was broken. Allow registration of the new
1606 # version to continue anyway, because that's better than having
1607 # an image that's not fixable by user operations.
1608 # Collision, this is an update of a file
1609 # Insert previous contents into oldimage
1610 $dbw->insertSelect( 'oldimage', $tables, $fields,
1611 [ 'img_name' => $this->getName() ], __METHOD__, [], [], $joins );
1612
1613 # Update the current image row
1614 $dbw->update( 'image',
1615 [
1616 'img_size' => $this->size,
1617 'img_width' => intval( $this->width ),
1618 'img_height' => intval( $this->height ),
1619 'img_bits' => $this->bits,
1620 'img_media_type' => $this->media_type,
1621 'img_major_mime' => $this->major_mime,
1622 'img_minor_mime' => $this->minor_mime,
1623 'img_timestamp' => $timestamp,
1624 'img_metadata' => $dbw->encodeBlob( $this->metadata ),
1625 'img_sha1' => $this->sha1
1626 ] + $commentFields + $actorFields,
1627 [ 'img_name' => $this->getName() ],
1628 __METHOD__
1629 );
1630 }
1631
1632 $descTitle = $this->getTitle();
1633 $descId = $descTitle->getArticleID();
1634 $wikiPage = new WikiFilePage( $descTitle );
1635 $wikiPage->setFile( $this );
1636
1637 // Add the log entry...
1638 $logEntry = new ManualLogEntry( 'upload', $reupload ? 'overwrite' : 'upload' );
1639 $logEntry->setTimestamp( $this->timestamp );
1640 $logEntry->setPerformer( $user );
1641 $logEntry->setComment( $comment );
1642 $logEntry->setTarget( $descTitle );
1643 // Allow people using the api to associate log entries with the upload.
1644 // Log has a timestamp, but sometimes different from upload timestamp.
1645 $logEntry->setParameters(
1646 [
1647 'img_sha1' => $this->sha1,
1648 'img_timestamp' => $timestamp,
1649 ]
1650 );
1651 // Note we keep $logId around since during new image
1652 // creation, page doesn't exist yet, so log_page = 0
1653 // but we want it to point to the page we're making,
1654 // so we later modify the log entry.
1655 // For a similar reason, we avoid making an RC entry
1656 // now and wait until the page exists.
1657 $logId = $logEntry->insert();
1658
1659 if ( $descTitle->exists() ) {
1660 // Use own context to get the action text in content language
1661 $formatter = LogFormatter::newFromEntry( $logEntry );
1662 $formatter->setContext( RequestContext::newExtraneousContext( $descTitle ) );
1663 $editSummary = $formatter->getPlainActionText();
1664
1665 $nullRevision = $createNullRevision === false ? null : Revision::newNullRevision(
1666 $dbw,
1667 $descId,
1668 $editSummary,
1669 false,
1670 $user
1671 );
1672 if ( $nullRevision ) {
1673 $nullRevision->insertOn( $dbw );
1674 Hooks::run(
1675 'NewRevisionFromEditComplete',
1676 [ $wikiPage, $nullRevision, $nullRevision->getParentId(), $user ]
1677 );
1678 $wikiPage->updateRevisionOn( $dbw, $nullRevision );
1679 // Associate null revision id
1680 $logEntry->setAssociatedRevId( $nullRevision->getId() );
1681 }
1682
1683 $newPageContent = null;
1684 } else {
1685 // Make the description page and RC log entry post-commit
1686 $newPageContent = ContentHandler::makeContent( $pageText, $descTitle );
1687 }
1688
1689 # Defer purges, page creation, and link updates in case they error out.
1690 # The most important thing is that files and the DB registry stay synced.
1691 $dbw->endAtomic( __METHOD__ );
1692 $fname = __METHOD__;
1693
1694 # Do some cache purges after final commit so that:
1695 # a) Changes are more likely to be seen post-purge
1696 # b) They won't cause rollback of the log publish/update above
1697 DeferredUpdates::addUpdate(
1698 new AutoCommitUpdate(
1699 $dbw,
1700 __METHOD__,
1701 function () use (
1702 $reupload, $wikiPage, $newPageContent, $comment, $user,
1703 $logEntry, $logId, $descId, $tags, $fname
1704 ) {
1705 # Update memcache after the commit
1706 $this->invalidateCache();
1707
1708 $updateLogPage = false;
1709 if ( $newPageContent ) {
1710 # New file page; create the description page.
1711 # There's already a log entry, so don't make a second RC entry
1712 # CDN and file cache for the description page are purged by doEditContent.
1713 $status = $wikiPage->doEditContent(
1714 $newPageContent,
1715 $comment,
1716 EDIT_NEW | EDIT_SUPPRESS_RC,
1717 false,
1718 $user
1719 );
1720
1721 if ( isset( $status->value['revision'] ) ) {
1722 /** @var Revision $rev */
1723 $rev = $status->value['revision'];
1724 // Associate new page revision id
1725 $logEntry->setAssociatedRevId( $rev->getId() );
1726 }
1727 // This relies on the resetArticleID() call in WikiPage::insertOn(),
1728 // which is triggered on $descTitle by doEditContent() above.
1729 if ( isset( $status->value['revision'] ) ) {
1730 /** @var Revision $rev */
1731 $rev = $status->value['revision'];
1732 $updateLogPage = $rev->getPage();
1733 }
1734 } else {
1735 # Existing file page: invalidate description page cache
1736 $wikiPage->getTitle()->invalidateCache();
1737 $wikiPage->getTitle()->purgeSquid();
1738 # Allow the new file version to be patrolled from the page footer
1739 Article::purgePatrolFooterCache( $descId );
1740 }
1741
1742 # Update associated rev id. This should be done by $logEntry->insert() earlier,
1743 # but setAssociatedRevId() wasn't called at that point yet...
1744 $logParams = $logEntry->getParameters();
1745 $logParams['associated_rev_id'] = $logEntry->getAssociatedRevId();
1746 $update = [ 'log_params' => LogEntryBase::makeParamBlob( $logParams ) ];
1747 if ( $updateLogPage ) {
1748 # Also log page, in case where we just created it above
1749 $update['log_page'] = $updateLogPage;
1750 }
1751 $this->getRepo()->getMasterDB()->update(
1752 'logging',
1753 $update,
1754 [ 'log_id' => $logId ],
1755 $fname
1756 );
1757 $this->getRepo()->getMasterDB()->insert(
1758 'log_search',
1759 [
1760 'ls_field' => 'associated_rev_id',
1761 'ls_value' => $logEntry->getAssociatedRevId(),
1762 'ls_log_id' => $logId,
1763 ],
1764 $fname
1765 );
1766
1767 # Add change tags, if any
1768 if ( $tags ) {
1769 $logEntry->setTags( $tags );
1770 }
1771
1772 # Uploads can be patrolled
1773 $logEntry->setIsPatrollable( true );
1774
1775 # Now that the log entry is up-to-date, make an RC entry.
1776 $logEntry->publish( $logId );
1777
1778 # Run hook for other updates (typically more cache purging)
1779 Hooks::run( 'FileUpload', [ $this, $reupload, !$newPageContent ] );
1780
1781 if ( $reupload ) {
1782 # Delete old thumbnails
1783 $this->purgeThumbnails();
1784 # Remove the old file from the CDN cache
1785 DeferredUpdates::addUpdate(
1786 new CdnCacheUpdate( [ $this->getUrl() ] ),
1787 DeferredUpdates::PRESEND
1788 );
1789 } else {
1790 # Update backlink pages pointing to this title if created
1791 LinksUpdate::queueRecursiveJobsForTable(
1792 $this->getTitle(),
1793 'imagelinks',
1794 'upload-image',
1795 $user->getName()
1796 );
1797 }
1798
1799 $this->prerenderThumbnails();
1800 }
1801 ),
1802 DeferredUpdates::PRESEND
1803 );
1804
1805 if ( !$reupload ) {
1806 # This is a new file, so update the image count
1807 DeferredUpdates::addUpdate( SiteStatsUpdate::factory( [ 'images' => 1 ] ) );
1808 }
1809
1810 # Invalidate cache for all pages using this file
1811 DeferredUpdates::addUpdate(
1812 new HTMLCacheUpdate( $this->getTitle(), 'imagelinks', 'file-upload' )
1813 );
1814
1815 return Status::newGood();
1816 }
1817
1818 /**
1819 * Move or copy a file to its public location. If a file exists at the
1820 * destination, move it to an archive. Returns a Status object with
1821 * the archive name in the "value" member on success.
1822 *
1823 * The archive name should be passed through to recordUpload for database
1824 * registration.
1825 *
1826 * @param string|FSFile $src Local filesystem path or virtual URL to the source image
1827 * @param int $flags A bitwise combination of:
1828 * File::DELETE_SOURCE Delete the source file, i.e. move rather than copy
1829 * @param array $options Optional additional parameters
1830 * @return Status On success, the value member contains the
1831 * archive name, or an empty string if it was a new file.
1832 */
1833 function publish( $src, $flags = 0, array $options = [] ) {
1834 return $this->publishTo( $src, $this->getRel(), $flags, $options );
1835 }
1836
1837 /**
1838 * Move or copy a file to a specified location. Returns a Status
1839 * object with the archive name in the "value" member on success.
1840 *
1841 * The archive name should be passed through to recordUpload for database
1842 * registration.
1843 *
1844 * @param string|FSFile $src Local filesystem path or virtual URL to the source image
1845 * @param string $dstRel Target relative path
1846 * @param int $flags A bitwise combination of:
1847 * File::DELETE_SOURCE Delete the source file, i.e. move rather than copy
1848 * @param array $options Optional additional parameters
1849 * @return Status On success, the value member contains the
1850 * archive name, or an empty string if it was a new file.
1851 */
1852 function publishTo( $src, $dstRel, $flags = 0, array $options = [] ) {
1853 $srcPath = ( $src instanceof FSFile ) ? $src->getPath() : $src;
1854
1855 $repo = $this->getRepo();
1856 if ( $repo->getReadOnlyReason() !== false ) {
1857 return $this->readOnlyFatalStatus();
1858 }
1859
1860 $this->lock();
1861
1862 $archiveName = wfTimestamp( TS_MW ) . '!' . $this->getName();
1863 $archiveRel = $this->getArchiveRel( $archiveName );
1864
1865 if ( $repo->hasSha1Storage() ) {
1866 $sha1 = FileRepo::isVirtualUrl( $srcPath )
1867 ? $repo->getFileSha1( $srcPath )
1868 : FSFile::getSha1Base36FromPath( $srcPath );
1869 /** @var FileBackendDBRepoWrapper $wrapperBackend */
1870 $wrapperBackend = $repo->getBackend();
1871 $dst = $wrapperBackend->getPathForSHA1( $sha1 );
1872 $status = $repo->quickImport( $src, $dst );
1873 if ( $flags & File::DELETE_SOURCE ) {
1874 unlink( $srcPath );
1875 }
1876
1877 if ( $this->exists() ) {
1878 $status->value = $archiveName;
1879 }
1880 } else {
1881 $flags = $flags & File::DELETE_SOURCE ? LocalRepo::DELETE_SOURCE : 0;
1882 $status = $repo->publish( $srcPath, $dstRel, $archiveRel, $flags, $options );
1883
1884 if ( $status->value == 'new' ) {
1885 $status->value = '';
1886 } else {
1887 $status->value = $archiveName;
1888 }
1889 }
1890
1891 $this->unlock();
1892 return $status;
1893 }
1894
1895 /** getLinksTo inherited */
1896 /** getExifData inherited */
1897 /** isLocal inherited */
1898 /** wasDeleted inherited */
1899
1900 /**
1901 * Move file to the new title
1902 *
1903 * Move current, old version and all thumbnails
1904 * to the new filename. Old file is deleted.
1905 *
1906 * Cache purging is done; checks for validity
1907 * and logging are caller's responsibility
1908 *
1909 * @param Title $target New file name
1910 * @return Status
1911 */
1912 function move( $target ) {
1913 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1914 return $this->readOnlyFatalStatus();
1915 }
1916
1917 wfDebugLog( 'imagemove', "Got request to move {$this->name} to " . $target->getText() );
1918 $batch = new LocalFileMoveBatch( $this, $target );
1919
1920 $this->lock();
1921 $batch->addCurrent();
1922 $archiveNames = $batch->addOlds();
1923 $status = $batch->execute();
1924 $this->unlock();
1925
1926 wfDebugLog( 'imagemove', "Finished moving {$this->name}" );
1927
1928 // Purge the source and target files...
1929 $oldTitleFile = wfLocalFile( $this->title );
1930 $newTitleFile = wfLocalFile( $target );
1931 // To avoid slow purges in the transaction, move them outside...
1932 DeferredUpdates::addUpdate(
1933 new AutoCommitUpdate(
1934 $this->getRepo()->getMasterDB(),
1935 __METHOD__,
1936 function () use ( $oldTitleFile, $newTitleFile, $archiveNames ) {
1937 $oldTitleFile->purgeEverything();
1938 foreach ( $archiveNames as $archiveName ) {
1939 $oldTitleFile->purgeOldThumbnails( $archiveName );
1940 }
1941 $newTitleFile->purgeEverything();
1942 }
1943 ),
1944 DeferredUpdates::PRESEND
1945 );
1946
1947 if ( $status->isOK() ) {
1948 // Now switch the object
1949 $this->title = $target;
1950 // Force regeneration of the name and hashpath
1951 unset( $this->name );
1952 unset( $this->hashPath );
1953 }
1954
1955 return $status;
1956 }
1957
1958 /**
1959 * Delete all versions of the file.
1960 *
1961 * Moves the files into an archive directory (or deletes them)
1962 * and removes the database rows.
1963 *
1964 * Cache purging is done; logging is caller's responsibility.
1965 *
1966 * @param string $reason
1967 * @param bool $suppress
1968 * @param User|null $user
1969 * @return Status
1970 */
1971 function delete( $reason, $suppress = false, $user = null ) {
1972 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1973 return $this->readOnlyFatalStatus();
1974 }
1975
1976 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress, $user );
1977
1978 $this->lock();
1979 $batch->addCurrent();
1980 // Get old version relative paths
1981 $archiveNames = $batch->addOlds();
1982 $status = $batch->execute();
1983 $this->unlock();
1984
1985 if ( $status->isOK() ) {
1986 DeferredUpdates::addUpdate( SiteStatsUpdate::factory( [ 'images' => -1 ] ) );
1987 }
1988
1989 // To avoid slow purges in the transaction, move them outside...
1990 DeferredUpdates::addUpdate(
1991 new AutoCommitUpdate(
1992 $this->getRepo()->getMasterDB(),
1993 __METHOD__,
1994 function () use ( $archiveNames ) {
1995 $this->purgeEverything();
1996 foreach ( $archiveNames as $archiveName ) {
1997 $this->purgeOldThumbnails( $archiveName );
1998 }
1999 }
2000 ),
2001 DeferredUpdates::PRESEND
2002 );
2003
2004 // Purge the CDN
2005 $purgeUrls = [];
2006 foreach ( $archiveNames as $archiveName ) {
2007 $purgeUrls[] = $this->getArchiveUrl( $archiveName );
2008 }
2009 DeferredUpdates::addUpdate( new CdnCacheUpdate( $purgeUrls ), DeferredUpdates::PRESEND );
2010
2011 return $status;
2012 }
2013
2014 /**
2015 * Delete an old version of the file.
2016 *
2017 * Moves the file into an archive directory (or deletes it)
2018 * and removes the database row.
2019 *
2020 * Cache purging is done; logging is caller's responsibility.
2021 *
2022 * @param string $archiveName
2023 * @param string $reason
2024 * @param bool $suppress
2025 * @param User|null $user
2026 * @throws MWException Exception on database or file store failure
2027 * @return Status
2028 */
2029 function deleteOld( $archiveName, $reason, $suppress = false, $user = null ) {
2030 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
2031 return $this->readOnlyFatalStatus();
2032 }
2033
2034 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress, $user );
2035
2036 $this->lock();
2037 $batch->addOld( $archiveName );
2038 $status = $batch->execute();
2039 $this->unlock();
2040
2041 $this->purgeOldThumbnails( $archiveName );
2042 if ( $status->isOK() ) {
2043 $this->purgeDescription();
2044 }
2045
2046 DeferredUpdates::addUpdate(
2047 new CdnCacheUpdate( [ $this->getArchiveUrl( $archiveName ) ] ),
2048 DeferredUpdates::PRESEND
2049 );
2050
2051 return $status;
2052 }
2053
2054 /**
2055 * Restore all or specified deleted revisions to the given file.
2056 * Permissions and logging are left to the caller.
2057 *
2058 * May throw database exceptions on error.
2059 *
2060 * @param array $versions Set of record ids of deleted items to restore,
2061 * or empty to restore all revisions.
2062 * @param bool $unsuppress
2063 * @return Status
2064 */
2065 function restore( $versions = [], $unsuppress = false ) {
2066 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
2067 return $this->readOnlyFatalStatus();
2068 }
2069
2070 $batch = new LocalFileRestoreBatch( $this, $unsuppress );
2071
2072 $this->lock();
2073 if ( !$versions ) {
2074 $batch->addAll();
2075 } else {
2076 $batch->addIds( $versions );
2077 }
2078 $status = $batch->execute();
2079 if ( $status->isGood() ) {
2080 $cleanupStatus = $batch->cleanup();
2081 $cleanupStatus->successCount = 0;
2082 $cleanupStatus->failCount = 0;
2083 $status->merge( $cleanupStatus );
2084 }
2085
2086 $this->unlock();
2087 return $status;
2088 }
2089
2090 /** isMultipage inherited */
2091 /** pageCount inherited */
2092 /** scaleHeight inherited */
2093 /** getImageSize inherited */
2094
2095 /**
2096 * Get the URL of the file description page.
2097 * @return string
2098 */
2099 function getDescriptionUrl() {
2100 return $this->title->getLocalURL();
2101 }
2102
2103 /**
2104 * Get the HTML text of the description page
2105 * This is not used by ImagePage for local files, since (among other things)
2106 * it skips the parser cache.
2107 *
2108 * @param Language|null $lang What language to get description in (Optional)
2109 * @return string|false
2110 */
2111 function getDescriptionText( Language $lang = null ) {
2112 $store = MediaWikiServices::getInstance()->getRevisionStore();
2113 $revision = $store->getRevisionByTitle( $this->title, 0, Revision::READ_NORMAL );
2114 if ( !$revision ) {
2115 return false;
2116 }
2117
2118 $renderer = MediaWikiServices::getInstance()->getRevisionRenderer();
2119 $rendered = $renderer->getRenderedRevision( $revision, new ParserOptions( null, $lang ) );
2120
2121 if ( !$rendered ) {
2122 // audience check failed
2123 return false;
2124 }
2125
2126 $pout = $rendered->getRevisionParserOutput();
2127 return $pout->getText();
2128 }
2129
2130 /**
2131 * @param int $audience
2132 * @param User|null $user
2133 * @return string
2134 */
2135 function getDescription( $audience = self::FOR_PUBLIC, User $user = null ) {
2136 $this->load();
2137 if ( $audience == self::FOR_PUBLIC && $this->isDeleted( self::DELETED_COMMENT ) ) {
2138 return '';
2139 } elseif ( $audience == self::FOR_THIS_USER
2140 && !$this->userCan( self::DELETED_COMMENT, $user )
2141 ) {
2142 return '';
2143 } else {
2144 return $this->description;
2145 }
2146 }
2147
2148 /**
2149 * @return bool|string
2150 */
2151 function getTimestamp() {
2152 $this->load();
2153
2154 return $this->timestamp;
2155 }
2156
2157 /**
2158 * @return bool|string
2159 */
2160 public function getDescriptionTouched() {
2161 // The DB lookup might return false, e.g. if the file was just deleted, or the shared DB repo
2162 // itself gets it from elsewhere. To avoid repeating the DB lookups in such a case, we
2163 // need to differentiate between null (uninitialized) and false (failed to load).
2164 if ( $this->descriptionTouched === null ) {
2165 $cond = [
2166 'page_namespace' => $this->title->getNamespace(),
2167 'page_title' => $this->title->getDBkey()
2168 ];
2169 $touched = $this->repo->getReplicaDB()->selectField( 'page', 'page_touched', $cond, __METHOD__ );
2170 $this->descriptionTouched = $touched ? wfTimestamp( TS_MW, $touched ) : false;
2171 }
2172
2173 return $this->descriptionTouched;
2174 }
2175
2176 /**
2177 * @return string
2178 */
2179 function getSha1() {
2180 $this->load();
2181 // Initialise now if necessary
2182 if ( $this->sha1 == '' && $this->fileExists ) {
2183 $this->lock();
2184
2185 $this->sha1 = $this->repo->getFileSha1( $this->getPath() );
2186 if ( !wfReadOnly() && strval( $this->sha1 ) != '' ) {
2187 $dbw = $this->repo->getMasterDB();
2188 $dbw->update( 'image',
2189 [ 'img_sha1' => $this->sha1 ],
2190 [ 'img_name' => $this->getName() ],
2191 __METHOD__ );
2192 $this->invalidateCache();
2193 }
2194
2195 $this->unlock();
2196 }
2197
2198 return $this->sha1;
2199 }
2200
2201 /**
2202 * @return bool Whether to cache in RepoGroup (this avoids OOMs)
2203 */
2204 function isCacheable() {
2205 $this->load();
2206
2207 // If extra data (metadata) was not loaded then it must have been large
2208 return $this->extraDataLoaded
2209 && strlen( serialize( $this->metadata ) ) <= self::CACHE_FIELD_MAX_LEN;
2210 }
2211
2212 /**
2213 * @return Status
2214 * @since 1.28
2215 */
2216 public function acquireFileLock() {
2217 return Status::wrap( $this->getRepo()->getBackend()->lockFiles(
2218 [ $this->getPath() ], LockManager::LOCK_EX, 10
2219 ) );
2220 }
2221
2222 /**
2223 * @return Status
2224 * @since 1.28
2225 */
2226 public function releaseFileLock() {
2227 return Status::wrap( $this->getRepo()->getBackend()->unlockFiles(
2228 [ $this->getPath() ], LockManager::LOCK_EX
2229 ) );
2230 }
2231
2232 /**
2233 * Start an atomic DB section and lock the image for update
2234 * or increments a reference counter if the lock is already held
2235 *
2236 * This method should not be used outside of LocalFile/LocalFile*Batch
2237 *
2238 * @throws LocalFileLockError Throws an error if the lock was not acquired
2239 * @return bool Whether the file lock owns/spawned the DB transaction
2240 */
2241 public function lock() {
2242 if ( !$this->locked ) {
2243 $logger = LoggerFactory::getInstance( 'LocalFile' );
2244
2245 $dbw = $this->repo->getMasterDB();
2246 $makesTransaction = !$dbw->trxLevel();
2247 $dbw->startAtomic( self::ATOMIC_SECTION_LOCK );
2248 // T56736: use simple lock to handle when the file does not exist.
2249 // SELECT FOR UPDATE prevents changes, not other SELECTs with FOR UPDATE.
2250 // Also, that would cause contention on INSERT of similarly named rows.
2251 $status = $this->acquireFileLock(); // represents all versions of the file
2252 if ( !$status->isGood() ) {
2253 $dbw->endAtomic( self::ATOMIC_SECTION_LOCK );
2254 $logger->warning( "Failed to lock '{file}'", [ 'file' => $this->name ] );
2255
2256 throw new LocalFileLockError( $status );
2257 }
2258 // Release the lock *after* commit to avoid row-level contention.
2259 // Make sure it triggers on rollback() as well as commit() (T132921).
2260 $dbw->onTransactionResolution(
2261 function () use ( $logger ) {
2262 $status = $this->releaseFileLock();
2263 if ( !$status->isGood() ) {
2264 $logger->error( "Failed to unlock '{file}'", [ 'file' => $this->name ] );
2265 }
2266 },
2267 __METHOD__
2268 );
2269 // Callers might care if the SELECT snapshot is safely fresh
2270 $this->lockedOwnTrx = $makesTransaction;
2271 }
2272
2273 $this->locked++;
2274
2275 return $this->lockedOwnTrx;
2276 }
2277
2278 /**
2279 * Decrement the lock reference count and end the atomic section if it reaches zero
2280 *
2281 * This method should not be used outside of LocalFile/LocalFile*Batch
2282 *
2283 * The commit and loc release will happen when no atomic sections are active, which
2284 * may happen immediately or at some point after calling this
2285 */
2286 public function unlock() {
2287 if ( $this->locked ) {
2288 --$this->locked;
2289 if ( !$this->locked ) {
2290 $dbw = $this->repo->getMasterDB();
2291 $dbw->endAtomic( self::ATOMIC_SECTION_LOCK );
2292 $this->lockedOwnTrx = false;
2293 }
2294 }
2295 }
2296
2297 /**
2298 * @return Status
2299 */
2300 protected function readOnlyFatalStatus() {
2301 return $this->getRepo()->newFatal( 'filereadonlyerror', $this->getName(),
2302 $this->getRepo()->getName(), $this->getRepo()->getReadOnlyReason() );
2303 }
2304
2305 /**
2306 * Clean up any dangling locks
2307 */
2308 function __destruct() {
2309 $this->unlock();
2310 }
2311 } // LocalFile class
2312
2313 # ------------------------------------------------------------------------------
2314
2315 /**
2316 * Helper class for file deletion
2317 * @ingroup FileAbstraction
2318 */
2319 class LocalFileDeleteBatch {
2320 /** @var LocalFile */
2321 private $file;
2322
2323 /** @var string */
2324 private $reason;
2325
2326 /** @var array */
2327 private $srcRels = [];
2328
2329 /** @var array */
2330 private $archiveUrls = [];
2331
2332 /** @var array Items to be processed in the deletion batch */
2333 private $deletionBatch;
2334
2335 /** @var bool Whether to suppress all suppressable fields when deleting */
2336 private $suppress;
2337
2338 /** @var Status */
2339 private $status;
2340
2341 /** @var User */
2342 private $user;
2343
2344 /**
2345 * @param File $file
2346 * @param string $reason
2347 * @param bool $suppress
2348 * @param User|null $user
2349 */
2350 function __construct( File $file, $reason = '', $suppress = false, $user = null ) {
2351 $this->file = $file;
2352 $this->reason = $reason;
2353 $this->suppress = $suppress;
2354 if ( $user ) {
2355 $this->user = $user;
2356 } else {
2357 global $wgUser;
2358 $this->user = $wgUser;
2359 }
2360 $this->status = $file->repo->newGood();
2361 }
2362
2363 public function addCurrent() {
2364 $this->srcRels['.'] = $this->file->getRel();
2365 }
2366
2367 /**
2368 * @param string $oldName
2369 */
2370 public function addOld( $oldName ) {
2371 $this->srcRels[$oldName] = $this->file->getArchiveRel( $oldName );
2372 $this->archiveUrls[] = $this->file->getArchiveUrl( $oldName );
2373 }
2374
2375 /**
2376 * Add the old versions of the image to the batch
2377 * @return string[] List of archive names from old versions
2378 */
2379 public function addOlds() {
2380 $archiveNames = [];
2381
2382 $dbw = $this->file->repo->getMasterDB();
2383 $result = $dbw->select( 'oldimage',
2384 [ 'oi_archive_name' ],
2385 [ 'oi_name' => $this->file->getName() ],
2386 __METHOD__
2387 );
2388
2389 foreach ( $result as $row ) {
2390 $this->addOld( $row->oi_archive_name );
2391 $archiveNames[] = $row->oi_archive_name;
2392 }
2393
2394 return $archiveNames;
2395 }
2396
2397 /**
2398 * @return array
2399 */
2400 protected function getOldRels() {
2401 if ( !isset( $this->srcRels['.'] ) ) {
2402 $oldRels =& $this->srcRels;
2403 $deleteCurrent = false;
2404 } else {
2405 $oldRels = $this->srcRels;
2406 unset( $oldRels['.'] );
2407 $deleteCurrent = true;
2408 }
2409
2410 return [ $oldRels, $deleteCurrent ];
2411 }
2412
2413 /**
2414 * @return array
2415 */
2416 protected function getHashes() {
2417 $hashes = [];
2418 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
2419
2420 if ( $deleteCurrent ) {
2421 $hashes['.'] = $this->file->getSha1();
2422 }
2423
2424 if ( count( $oldRels ) ) {
2425 $dbw = $this->file->repo->getMasterDB();
2426 $res = $dbw->select(
2427 'oldimage',
2428 [ 'oi_archive_name', 'oi_sha1' ],
2429 [ 'oi_archive_name' => array_keys( $oldRels ),
2430 'oi_name' => $this->file->getName() ], // performance
2431 __METHOD__
2432 );
2433
2434 foreach ( $res as $row ) {
2435 if ( rtrim( $row->oi_sha1, "\0" ) === '' ) {
2436 // Get the hash from the file
2437 $oldUrl = $this->file->getArchiveVirtualUrl( $row->oi_archive_name );
2438 $props = $this->file->repo->getFileProps( $oldUrl );
2439
2440 if ( $props['fileExists'] ) {
2441 // Upgrade the oldimage row
2442 $dbw->update( 'oldimage',
2443 [ 'oi_sha1' => $props['sha1'] ],
2444 [ 'oi_name' => $this->file->getName(), 'oi_archive_name' => $row->oi_archive_name ],
2445 __METHOD__ );
2446 $hashes[$row->oi_archive_name] = $props['sha1'];
2447 } else {
2448 $hashes[$row->oi_archive_name] = false;
2449 }
2450 } else {
2451 $hashes[$row->oi_archive_name] = $row->oi_sha1;
2452 }
2453 }
2454 }
2455
2456 $missing = array_diff_key( $this->srcRels, $hashes );
2457
2458 foreach ( $missing as $name => $rel ) {
2459 $this->status->error( 'filedelete-old-unregistered', $name );
2460 }
2461
2462 foreach ( $hashes as $name => $hash ) {
2463 if ( !$hash ) {
2464 $this->status->error( 'filedelete-missing', $this->srcRels[$name] );
2465 unset( $hashes[$name] );
2466 }
2467 }
2468
2469 return $hashes;
2470 }
2471
2472 protected function doDBInserts() {
2473 global $wgCommentTableSchemaMigrationStage, $wgActorTableSchemaMigrationStage;
2474
2475 $now = time();
2476 $dbw = $this->file->repo->getMasterDB();
2477
2478 $commentStore = MediaWikiServices::getInstance()->getCommentStore();
2479 $actorMigration = ActorMigration::newMigration();
2480
2481 $encTimestamp = $dbw->addQuotes( $dbw->timestamp( $now ) );
2482 $encUserId = $dbw->addQuotes( $this->user->getId() );
2483 $encGroup = $dbw->addQuotes( 'deleted' );
2484 $ext = $this->file->getExtension();
2485 $dotExt = $ext === '' ? '' : ".$ext";
2486 $encExt = $dbw->addQuotes( $dotExt );
2487 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
2488
2489 // Bitfields to further suppress the content
2490 if ( $this->suppress ) {
2491 $bitfield = Revision::SUPPRESSED_ALL;
2492 } else {
2493 $bitfield = 'oi_deleted';
2494 }
2495
2496 if ( $deleteCurrent ) {
2497 $tables = [ 'image' ];
2498 $fields = [
2499 'fa_storage_group' => $encGroup,
2500 'fa_storage_key' => $dbw->conditional(
2501 [ 'img_sha1' => '' ],
2502 $dbw->addQuotes( '' ),
2503 $dbw->buildConcat( [ "img_sha1", $encExt ] )
2504 ),
2505 'fa_deleted_user' => $encUserId,
2506 'fa_deleted_timestamp' => $encTimestamp,
2507 'fa_deleted' => $this->suppress ? $bitfield : 0,
2508 'fa_name' => 'img_name',
2509 'fa_archive_name' => 'NULL',
2510 'fa_size' => 'img_size',
2511 'fa_width' => 'img_width',
2512 'fa_height' => 'img_height',
2513 'fa_metadata' => 'img_metadata',
2514 'fa_bits' => 'img_bits',
2515 'fa_media_type' => 'img_media_type',
2516 'fa_major_mime' => 'img_major_mime',
2517 'fa_minor_mime' => 'img_minor_mime',
2518 'fa_timestamp' => 'img_timestamp',
2519 'fa_sha1' => 'img_sha1'
2520 ];
2521 $joins = [];
2522
2523 $fields += array_map(
2524 [ $dbw, 'addQuotes' ],
2525 $commentStore->insert( $dbw, 'fa_deleted_reason', $this->reason )
2526 );
2527
2528 if ( $wgCommentTableSchemaMigrationStage <= MIGRATION_WRITE_BOTH ) {
2529 $fields['fa_description'] = 'img_description';
2530 }
2531 if ( $wgCommentTableSchemaMigrationStage >= MIGRATION_WRITE_BOTH ) {
2532 $fields['fa_description_id'] = 'img_description_id';
2533 }
2534
2535 if ( $wgCommentTableSchemaMigrationStage !== MIGRATION_OLD &&
2536 $wgCommentTableSchemaMigrationStage !== MIGRATION_NEW
2537 ) {
2538 // Upgrade any rows that are still old-style. Otherwise an upgrade
2539 // might be missed if a deletion happens while the migration script
2540 // is running.
2541 $res = $dbw->select(
2542 [ 'image' ],
2543 [ 'img_name', 'img_description' ],
2544 [
2545 'img_name' => $this->file->getName(),
2546 'img_description_id' => 0,
2547 ],
2548 __METHOD__
2549 );
2550 foreach ( $res as $row ) {
2551 $imgFields = $commentStore->insert( $dbw, 'img_description', $row->img_description );
2552 $dbw->update(
2553 'image',
2554 $imgFields,
2555 [ 'img_name' => $row->img_name ],
2556 __METHOD__
2557 );
2558 }
2559 }
2560
2561 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_OLD ) {
2562 $fields['fa_user'] = 'img_user';
2563 $fields['fa_user_text'] = 'img_user_text';
2564 }
2565 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_NEW ) {
2566 $fields['fa_actor'] = 'img_actor';
2567 }
2568
2569 if (
2570 ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_WRITE_BOTH ) === SCHEMA_COMPAT_WRITE_BOTH
2571 ) {
2572 // Upgrade any rows that are still old-style. Otherwise an upgrade
2573 // might be missed if a deletion happens while the migration script
2574 // is running.
2575 $res = $dbw->select(
2576 [ 'image' ],
2577 [ 'img_name', 'img_user', 'img_user_text' ],
2578 [ 'img_name' => $this->file->getName(), 'img_actor' => 0 ],
2579 __METHOD__
2580 );
2581 foreach ( $res as $row ) {
2582 $actorId = User::newFromAnyId( $row->img_user, $row->img_user_text, null )->getActorId( $dbw );
2583 $dbw->update(
2584 'image',
2585 [ 'img_actor' => $actorId ],
2586 [ 'img_name' => $row->img_name, 'img_actor' => 0 ],
2587 __METHOD__
2588 );
2589 }
2590 }
2591
2592 $dbw->insertSelect( 'filearchive', $tables, $fields,
2593 [ 'img_name' => $this->file->getName() ], __METHOD__, [], [], $joins );
2594 }
2595
2596 if ( count( $oldRels ) ) {
2597 $fileQuery = OldLocalFile::getQueryInfo();
2598 $res = $dbw->select(
2599 $fileQuery['tables'],
2600 $fileQuery['fields'],
2601 [
2602 'oi_name' => $this->file->getName(),
2603 'oi_archive_name' => array_keys( $oldRels )
2604 ],
2605 __METHOD__,
2606 [ 'FOR UPDATE' ],
2607 $fileQuery['joins']
2608 );
2609 $rowsInsert = [];
2610 if ( $res->numRows() ) {
2611 $reason = $commentStore->createComment( $dbw, $this->reason );
2612 foreach ( $res as $row ) {
2613 $comment = $commentStore->getComment( 'oi_description', $row );
2614 $user = User::newFromAnyId( $row->oi_user, $row->oi_user_text, $row->oi_actor );
2615 $rowsInsert[] = [
2616 // Deletion-specific fields
2617 'fa_storage_group' => 'deleted',
2618 'fa_storage_key' => ( $row->oi_sha1 === '' )
2619 ? ''
2620 : "{$row->oi_sha1}{$dotExt}",
2621 'fa_deleted_user' => $this->user->getId(),
2622 'fa_deleted_timestamp' => $dbw->timestamp( $now ),
2623 // Counterpart fields
2624 'fa_deleted' => $this->suppress ? $bitfield : $row->oi_deleted,
2625 'fa_name' => $row->oi_name,
2626 'fa_archive_name' => $row->oi_archive_name,
2627 'fa_size' => $row->oi_size,
2628 'fa_width' => $row->oi_width,
2629 'fa_height' => $row->oi_height,
2630 'fa_metadata' => $row->oi_metadata,
2631 'fa_bits' => $row->oi_bits,
2632 'fa_media_type' => $row->oi_media_type,
2633 'fa_major_mime' => $row->oi_major_mime,
2634 'fa_minor_mime' => $row->oi_minor_mime,
2635 'fa_timestamp' => $row->oi_timestamp,
2636 'fa_sha1' => $row->oi_sha1
2637 ] + $commentStore->insert( $dbw, 'fa_deleted_reason', $reason )
2638 + $commentStore->insert( $dbw, 'fa_description', $comment )
2639 + $actorMigration->getInsertValues( $dbw, 'fa_user', $user );
2640 }
2641 }
2642
2643 $dbw->insert( 'filearchive', $rowsInsert, __METHOD__ );
2644 }
2645 }
2646
2647 function doDBDeletes() {
2648 $dbw = $this->file->repo->getMasterDB();
2649 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
2650
2651 if ( count( $oldRels ) ) {
2652 $dbw->delete( 'oldimage',
2653 [
2654 'oi_name' => $this->file->getName(),
2655 'oi_archive_name' => array_keys( $oldRels )
2656 ], __METHOD__ );
2657 }
2658
2659 if ( $deleteCurrent ) {
2660 $dbw->delete( 'image', [ 'img_name' => $this->file->getName() ], __METHOD__ );
2661 }
2662 }
2663
2664 /**
2665 * Run the transaction
2666 * @return Status
2667 */
2668 public function execute() {
2669 $repo = $this->file->getRepo();
2670 $this->file->lock();
2671
2672 // Prepare deletion batch
2673 $hashes = $this->getHashes();
2674 $this->deletionBatch = [];
2675 $ext = $this->file->getExtension();
2676 $dotExt = $ext === '' ? '' : ".$ext";
2677
2678 foreach ( $this->srcRels as $name => $srcRel ) {
2679 // Skip files that have no hash (e.g. missing DB record, or sha1 field and file source)
2680 if ( isset( $hashes[$name] ) ) {
2681 $hash = $hashes[$name];
2682 $key = $hash . $dotExt;
2683 $dstRel = $repo->getDeletedHashPath( $key ) . $key;
2684 $this->deletionBatch[$name] = [ $srcRel, $dstRel ];
2685 }
2686 }
2687
2688 if ( !$repo->hasSha1Storage() ) {
2689 // Removes non-existent file from the batch, so we don't get errors.
2690 // This also handles files in the 'deleted' zone deleted via revision deletion.
2691 $checkStatus = $this->removeNonexistentFiles( $this->deletionBatch );
2692 if ( !$checkStatus->isGood() ) {
2693 $this->status->merge( $checkStatus );
2694 return $this->status;
2695 }
2696 $this->deletionBatch = $checkStatus->value;
2697
2698 // Execute the file deletion batch
2699 $status = $this->file->repo->deleteBatch( $this->deletionBatch );
2700 if ( !$status->isGood() ) {
2701 $this->status->merge( $status );
2702 }
2703 }
2704
2705 if ( !$this->status->isOK() ) {
2706 // Critical file deletion error; abort
2707 $this->file->unlock();
2708
2709 return $this->status;
2710 }
2711
2712 // Copy the image/oldimage rows to filearchive
2713 $this->doDBInserts();
2714 // Delete image/oldimage rows
2715 $this->doDBDeletes();
2716
2717 // Commit and return
2718 $this->file->unlock();
2719
2720 return $this->status;
2721 }
2722
2723 /**
2724 * Removes non-existent files from a deletion batch.
2725 * @param array $batch
2726 * @return Status
2727 */
2728 protected function removeNonexistentFiles( $batch ) {
2729 $files = $newBatch = [];
2730
2731 foreach ( $batch as $batchItem ) {
2732 list( $src, ) = $batchItem;
2733 $files[$src] = $this->file->repo->getVirtualUrl( 'public' ) . '/' . rawurlencode( $src );
2734 }
2735
2736 $result = $this->file->repo->fileExistsBatch( $files );
2737 if ( in_array( null, $result, true ) ) {
2738 return Status::newFatal( 'backend-fail-internal',
2739 $this->file->repo->getBackend()->getName() );
2740 }
2741
2742 foreach ( $batch as $batchItem ) {
2743 if ( $result[$batchItem[0]] ) {
2744 $newBatch[] = $batchItem;
2745 }
2746 }
2747
2748 return Status::newGood( $newBatch );
2749 }
2750 }
2751
2752 # ------------------------------------------------------------------------------
2753
2754 /**
2755 * Helper class for file undeletion
2756 * @ingroup FileAbstraction
2757 */
2758 class LocalFileRestoreBatch {
2759 /** @var LocalFile */
2760 private $file;
2761
2762 /** @var string[] List of file IDs to restore */
2763 private $cleanupBatch;
2764
2765 /** @var string[] List of file IDs to restore */
2766 private $ids;
2767
2768 /** @var bool Add all revisions of the file */
2769 private $all;
2770
2771 /** @var bool Whether to remove all settings for suppressed fields */
2772 private $unsuppress = false;
2773
2774 /**
2775 * @param File $file
2776 * @param bool $unsuppress
2777 */
2778 function __construct( File $file, $unsuppress = false ) {
2779 $this->file = $file;
2780 $this->cleanupBatch = [];
2781 $this->ids = [];
2782 $this->unsuppress = $unsuppress;
2783 }
2784
2785 /**
2786 * Add a file by ID
2787 * @param int $fa_id
2788 */
2789 public function addId( $fa_id ) {
2790 $this->ids[] = $fa_id;
2791 }
2792
2793 /**
2794 * Add a whole lot of files by ID
2795 * @param int[] $ids
2796 */
2797 public function addIds( $ids ) {
2798 $this->ids = array_merge( $this->ids, $ids );
2799 }
2800
2801 /**
2802 * Add all revisions of the file
2803 */
2804 public function addAll() {
2805 $this->all = true;
2806 }
2807
2808 /**
2809 * Run the transaction, except the cleanup batch.
2810 * The cleanup batch should be run in a separate transaction, because it locks different
2811 * rows and there's no need to keep the image row locked while it's acquiring those locks
2812 * The caller may have its own transaction open.
2813 * So we save the batch and let the caller call cleanup()
2814 * @return Status
2815 */
2816 public function execute() {
2817 /** @var Language */
2818 global $wgLang;
2819
2820 $repo = $this->file->getRepo();
2821 if ( !$this->all && !$this->ids ) {
2822 // Do nothing
2823 return $repo->newGood();
2824 }
2825
2826 $lockOwnsTrx = $this->file->lock();
2827
2828 $dbw = $this->file->repo->getMasterDB();
2829
2830 $commentStore = MediaWikiServices::getInstance()->getCommentStore();
2831 $actorMigration = ActorMigration::newMigration();
2832
2833 $status = $this->file->repo->newGood();
2834
2835 $exists = (bool)$dbw->selectField( 'image', '1',
2836 [ 'img_name' => $this->file->getName() ],
2837 __METHOD__,
2838 // The lock() should already prevents changes, but this still may need
2839 // to bypass any transaction snapshot. However, if lock() started the
2840 // trx (which it probably did) then snapshot is post-lock and up-to-date.
2841 $lockOwnsTrx ? [] : [ 'LOCK IN SHARE MODE' ]
2842 );
2843
2844 // Fetch all or selected archived revisions for the file,
2845 // sorted from the most recent to the oldest.
2846 $conditions = [ 'fa_name' => $this->file->getName() ];
2847
2848 if ( !$this->all ) {
2849 $conditions['fa_id'] = $this->ids;
2850 }
2851
2852 $arFileQuery = ArchivedFile::getQueryInfo();
2853 $result = $dbw->select(
2854 $arFileQuery['tables'],
2855 $arFileQuery['fields'],
2856 $conditions,
2857 __METHOD__,
2858 [ 'ORDER BY' => 'fa_timestamp DESC' ],
2859 $arFileQuery['joins']
2860 );
2861
2862 $idsPresent = [];
2863 $storeBatch = [];
2864 $insertBatch = [];
2865 $insertCurrent = false;
2866 $deleteIds = [];
2867 $first = true;
2868 $archiveNames = [];
2869
2870 foreach ( $result as $row ) {
2871 $idsPresent[] = $row->fa_id;
2872
2873 if ( $row->fa_name != $this->file->getName() ) {
2874 $status->error( 'undelete-filename-mismatch', $wgLang->timeanddate( $row->fa_timestamp ) );
2875 $status->failCount++;
2876 continue;
2877 }
2878
2879 if ( $row->fa_storage_key == '' ) {
2880 // Revision was missing pre-deletion
2881 $status->error( 'undelete-bad-store-key', $wgLang->timeanddate( $row->fa_timestamp ) );
2882 $status->failCount++;
2883 continue;
2884 }
2885
2886 $deletedRel = $repo->getDeletedHashPath( $row->fa_storage_key ) .
2887 $row->fa_storage_key;
2888 $deletedUrl = $repo->getVirtualUrl() . '/deleted/' . $deletedRel;
2889
2890 if ( isset( $row->fa_sha1 ) ) {
2891 $sha1 = $row->fa_sha1;
2892 } else {
2893 // old row, populate from key
2894 $sha1 = LocalRepo::getHashFromKey( $row->fa_storage_key );
2895 }
2896
2897 # Fix leading zero
2898 if ( strlen( $sha1 ) == 32 && $sha1[0] == '0' ) {
2899 $sha1 = substr( $sha1, 1 );
2900 }
2901
2902 if ( is_null( $row->fa_major_mime ) || $row->fa_major_mime == 'unknown'
2903 || is_null( $row->fa_minor_mime ) || $row->fa_minor_mime == 'unknown'
2904 || is_null( $row->fa_media_type ) || $row->fa_media_type == 'UNKNOWN'
2905 || is_null( $row->fa_metadata )
2906 ) {
2907 // Refresh our metadata
2908 // Required for a new current revision; nice for older ones too. :)
2909 $props = RepoGroup::singleton()->getFileProps( $deletedUrl );
2910 } else {
2911 $props = [
2912 'minor_mime' => $row->fa_minor_mime,
2913 'major_mime' => $row->fa_major_mime,
2914 'media_type' => $row->fa_media_type,
2915 'metadata' => $row->fa_metadata
2916 ];
2917 }
2918
2919 $comment = $commentStore->getComment( 'fa_description', $row );
2920 $user = User::newFromAnyId( $row->fa_user, $row->fa_user_text, $row->fa_actor );
2921 if ( $first && !$exists ) {
2922 // This revision will be published as the new current version
2923 $destRel = $this->file->getRel();
2924 $commentFields = $commentStore->insert( $dbw, 'img_description', $comment );
2925 $actorFields = $actorMigration->getInsertValues( $dbw, 'img_user', $user );
2926 $insertCurrent = [
2927 'img_name' => $row->fa_name,
2928 'img_size' => $row->fa_size,
2929 'img_width' => $row->fa_width,
2930 'img_height' => $row->fa_height,
2931 'img_metadata' => $props['metadata'],
2932 'img_bits' => $row->fa_bits,
2933 'img_media_type' => $props['media_type'],
2934 'img_major_mime' => $props['major_mime'],
2935 'img_minor_mime' => $props['minor_mime'],
2936 'img_timestamp' => $row->fa_timestamp,
2937 'img_sha1' => $sha1
2938 ] + $commentFields + $actorFields;
2939
2940 // The live (current) version cannot be hidden!
2941 if ( !$this->unsuppress && $row->fa_deleted ) {
2942 $status->fatal( 'undeleterevdel' );
2943 $this->file->unlock();
2944 return $status;
2945 }
2946 } else {
2947 $archiveName = $row->fa_archive_name;
2948
2949 if ( $archiveName == '' ) {
2950 // This was originally a current version; we
2951 // have to devise a new archive name for it.
2952 // Format is <timestamp of archiving>!<name>
2953 $timestamp = wfTimestamp( TS_UNIX, $row->fa_deleted_timestamp );
2954
2955 do {
2956 $archiveName = wfTimestamp( TS_MW, $timestamp ) . '!' . $row->fa_name;
2957 $timestamp++;
2958 } while ( isset( $archiveNames[$archiveName] ) );
2959 }
2960
2961 $archiveNames[$archiveName] = true;
2962 $destRel = $this->file->getArchiveRel( $archiveName );
2963 $insertBatch[] = [
2964 'oi_name' => $row->fa_name,
2965 'oi_archive_name' => $archiveName,
2966 'oi_size' => $row->fa_size,
2967 'oi_width' => $row->fa_width,
2968 'oi_height' => $row->fa_height,
2969 'oi_bits' => $row->fa_bits,
2970 'oi_timestamp' => $row->fa_timestamp,
2971 'oi_metadata' => $props['metadata'],
2972 'oi_media_type' => $props['media_type'],
2973 'oi_major_mime' => $props['major_mime'],
2974 'oi_minor_mime' => $props['minor_mime'],
2975 'oi_deleted' => $this->unsuppress ? 0 : $row->fa_deleted,
2976 'oi_sha1' => $sha1
2977 ] + $commentStore->insert( $dbw, 'oi_description', $comment )
2978 + $actorMigration->getInsertValues( $dbw, 'oi_user', $user );
2979 }
2980
2981 $deleteIds[] = $row->fa_id;
2982
2983 if ( !$this->unsuppress && $row->fa_deleted & File::DELETED_FILE ) {
2984 // private files can stay where they are
2985 $status->successCount++;
2986 } else {
2987 $storeBatch[] = [ $deletedUrl, 'public', $destRel ];
2988 $this->cleanupBatch[] = $row->fa_storage_key;
2989 }
2990
2991 $first = false;
2992 }
2993
2994 unset( $result );
2995
2996 // Add a warning to the status object for missing IDs
2997 $missingIds = array_diff( $this->ids, $idsPresent );
2998
2999 foreach ( $missingIds as $id ) {
3000 $status->error( 'undelete-missing-filearchive', $id );
3001 }
3002
3003 if ( !$repo->hasSha1Storage() ) {
3004 // Remove missing files from batch, so we don't get errors when undeleting them
3005 $checkStatus = $this->removeNonexistentFiles( $storeBatch );
3006 if ( !$checkStatus->isGood() ) {
3007 $status->merge( $checkStatus );
3008 return $status;
3009 }
3010 $storeBatch = $checkStatus->value;
3011
3012 // Run the store batch
3013 // Use the OVERWRITE_SAME flag to smooth over a common error
3014 $storeStatus = $this->file->repo->storeBatch( $storeBatch, FileRepo::OVERWRITE_SAME );
3015 $status->merge( $storeStatus );
3016
3017 if ( !$status->isGood() ) {
3018 // Even if some files could be copied, fail entirely as that is the
3019 // easiest thing to do without data loss
3020 $this->cleanupFailedBatch( $storeStatus, $storeBatch );
3021 $status->setOK( false );
3022 $this->file->unlock();
3023
3024 return $status;
3025 }
3026 }
3027
3028 // Run the DB updates
3029 // Because we have locked the image row, key conflicts should be rare.
3030 // If they do occur, we can roll back the transaction at this time with
3031 // no data loss, but leaving unregistered files scattered throughout the
3032 // public zone.
3033 // This is not ideal, which is why it's important to lock the image row.
3034 if ( $insertCurrent ) {
3035 $dbw->insert( 'image', $insertCurrent, __METHOD__ );
3036 }
3037
3038 if ( $insertBatch ) {
3039 $dbw->insert( 'oldimage', $insertBatch, __METHOD__ );
3040 }
3041
3042 if ( $deleteIds ) {
3043 $dbw->delete( 'filearchive',
3044 [ 'fa_id' => $deleteIds ],
3045 __METHOD__ );
3046 }
3047
3048 // If store batch is empty (all files are missing), deletion is to be considered successful
3049 if ( $status->successCount > 0 || !$storeBatch || $repo->hasSha1Storage() ) {
3050 if ( !$exists ) {
3051 wfDebug( __METHOD__ . " restored {$status->successCount} items, creating a new current\n" );
3052
3053 DeferredUpdates::addUpdate( SiteStatsUpdate::factory( [ 'images' => 1 ] ) );
3054
3055 $this->file->purgeEverything();
3056 } else {
3057 wfDebug( __METHOD__ . " restored {$status->successCount} as archived versions\n" );
3058 $this->file->purgeDescription();
3059 }
3060 }
3061
3062 $this->file->unlock();
3063
3064 return $status;
3065 }
3066
3067 /**
3068 * Removes non-existent files from a store batch.
3069 * @param array $triplets
3070 * @return Status
3071 */
3072 protected function removeNonexistentFiles( $triplets ) {
3073 $files = $filteredTriplets = [];
3074 foreach ( $triplets as $file ) {
3075 $files[$file[0]] = $file[0];
3076 }
3077
3078 $result = $this->file->repo->fileExistsBatch( $files );
3079 if ( in_array( null, $result, true ) ) {
3080 return Status::newFatal( 'backend-fail-internal',
3081 $this->file->repo->getBackend()->getName() );
3082 }
3083
3084 foreach ( $triplets as $file ) {
3085 if ( $result[$file[0]] ) {
3086 $filteredTriplets[] = $file;
3087 }
3088 }
3089
3090 return Status::newGood( $filteredTriplets );
3091 }
3092
3093 /**
3094 * Removes non-existent files from a cleanup batch.
3095 * @param string[] $batch
3096 * @return string[]
3097 */
3098 protected function removeNonexistentFromCleanup( $batch ) {
3099 $files = $newBatch = [];
3100 $repo = $this->file->repo;
3101
3102 foreach ( $batch as $file ) {
3103 $files[$file] = $repo->getVirtualUrl( 'deleted' ) . '/' .
3104 rawurlencode( $repo->getDeletedHashPath( $file ) . $file );
3105 }
3106
3107 $result = $repo->fileExistsBatch( $files );
3108
3109 foreach ( $batch as $file ) {
3110 if ( $result[$file] ) {
3111 $newBatch[] = $file;
3112 }
3113 }
3114
3115 return $newBatch;
3116 }
3117
3118 /**
3119 * Delete unused files in the deleted zone.
3120 * This should be called from outside the transaction in which execute() was called.
3121 * @return Status
3122 */
3123 public function cleanup() {
3124 if ( !$this->cleanupBatch ) {
3125 return $this->file->repo->newGood();
3126 }
3127
3128 $this->cleanupBatch = $this->removeNonexistentFromCleanup( $this->cleanupBatch );
3129
3130 $status = $this->file->repo->cleanupDeletedBatch( $this->cleanupBatch );
3131
3132 return $status;
3133 }
3134
3135 /**
3136 * Cleanup a failed batch. The batch was only partially successful, so
3137 * rollback by removing all items that were successfully copied.
3138 *
3139 * @param Status $storeStatus
3140 * @param array[] $storeBatch
3141 */
3142 protected function cleanupFailedBatch( $storeStatus, $storeBatch ) {
3143 $cleanupBatch = [];
3144
3145 foreach ( $storeStatus->success as $i => $success ) {
3146 // Check if this item of the batch was successfully copied
3147 if ( $success ) {
3148 // Item was successfully copied and needs to be removed again
3149 // Extract ($dstZone, $dstRel) from the batch
3150 $cleanupBatch[] = [ $storeBatch[$i][1], $storeBatch[$i][2] ];
3151 }
3152 }
3153 $this->file->repo->cleanupBatch( $cleanupBatch );
3154 }
3155 }
3156
3157 # ------------------------------------------------------------------------------
3158
3159 /**
3160 * Helper class for file movement
3161 * @ingroup FileAbstraction
3162 */
3163 class LocalFileMoveBatch {
3164 /** @var LocalFile */
3165 protected $file;
3166
3167 /** @var Title */
3168 protected $target;
3169
3170 protected $cur;
3171
3172 protected $olds;
3173
3174 protected $oldCount;
3175
3176 protected $archive;
3177
3178 /** @var IDatabase */
3179 protected $db;
3180
3181 /**
3182 * @param File $file
3183 * @param Title $target
3184 */
3185 function __construct( File $file, Title $target ) {
3186 $this->file = $file;
3187 $this->target = $target;
3188 $this->oldHash = $this->file->repo->getHashPath( $this->file->getName() );
3189 $this->newHash = $this->file->repo->getHashPath( $this->target->getDBkey() );
3190 $this->oldName = $this->file->getName();
3191 $this->newName = $this->file->repo->getNameFromTitle( $this->target );
3192 $this->oldRel = $this->oldHash . $this->oldName;
3193 $this->newRel = $this->newHash . $this->newName;
3194 $this->db = $file->getRepo()->getMasterDB();
3195 }
3196
3197 /**
3198 * Add the current image to the batch
3199 */
3200 public function addCurrent() {
3201 $this->cur = [ $this->oldRel, $this->newRel ];
3202 }
3203
3204 /**
3205 * Add the old versions of the image to the batch
3206 * @return string[] List of archive names from old versions
3207 */
3208 public function addOlds() {
3209 $archiveBase = 'archive';
3210 $this->olds = [];
3211 $this->oldCount = 0;
3212 $archiveNames = [];
3213
3214 $result = $this->db->select( 'oldimage',
3215 [ 'oi_archive_name', 'oi_deleted' ],
3216 [ 'oi_name' => $this->oldName ],
3217 __METHOD__,
3218 [ 'LOCK IN SHARE MODE' ] // ignore snapshot
3219 );
3220
3221 foreach ( $result as $row ) {
3222 $archiveNames[] = $row->oi_archive_name;
3223 $oldName = $row->oi_archive_name;
3224 $bits = explode( '!', $oldName, 2 );
3225
3226 if ( count( $bits ) != 2 ) {
3227 wfDebug( "Old file name missing !: '$oldName' \n" );
3228 continue;
3229 }
3230
3231 list( $timestamp, $filename ) = $bits;
3232
3233 if ( $this->oldName != $filename ) {
3234 wfDebug( "Old file name doesn't match: '$oldName' \n" );
3235 continue;
3236 }
3237
3238 $this->oldCount++;
3239
3240 // Do we want to add those to oldCount?
3241 if ( $row->oi_deleted & File::DELETED_FILE ) {
3242 continue;
3243 }
3244
3245 $this->olds[] = [
3246 "{$archiveBase}/{$this->oldHash}{$oldName}",
3247 "{$archiveBase}/{$this->newHash}{$timestamp}!{$this->newName}"
3248 ];
3249 }
3250
3251 return $archiveNames;
3252 }
3253
3254 /**
3255 * Perform the move.
3256 * @return Status
3257 */
3258 public function execute() {
3259 $repo = $this->file->repo;
3260 $status = $repo->newGood();
3261 $destFile = wfLocalFile( $this->target );
3262
3263 $this->file->lock();
3264 $destFile->lock(); // quickly fail if destination is not available
3265
3266 $triplets = $this->getMoveTriplets();
3267 $checkStatus = $this->removeNonexistentFiles( $triplets );
3268 if ( !$checkStatus->isGood() ) {
3269 $destFile->unlock();
3270 $this->file->unlock();
3271 $status->merge( $checkStatus ); // couldn't talk to file backend
3272 return $status;
3273 }
3274 $triplets = $checkStatus->value;
3275
3276 // Verify the file versions metadata in the DB.
3277 $statusDb = $this->verifyDBUpdates();
3278 if ( !$statusDb->isGood() ) {
3279 $destFile->unlock();
3280 $this->file->unlock();
3281 $statusDb->setOK( false );
3282
3283 return $statusDb;
3284 }
3285
3286 if ( !$repo->hasSha1Storage() ) {
3287 // Copy the files into their new location.
3288 // If a prior process fataled copying or cleaning up files we tolerate any
3289 // of the existing files if they are identical to the ones being stored.
3290 $statusMove = $repo->storeBatch( $triplets, FileRepo::OVERWRITE_SAME );
3291 wfDebugLog( 'imagemove', "Moved files for {$this->file->getName()}: " .
3292 "{$statusMove->successCount} successes, {$statusMove->failCount} failures" );
3293 if ( !$statusMove->isGood() ) {
3294 // Delete any files copied over (while the destination is still locked)
3295 $this->cleanupTarget( $triplets );
3296 $destFile->unlock();
3297 $this->file->unlock();
3298 wfDebugLog( 'imagemove', "Error in moving files: "
3299 . $statusMove->getWikiText( false, false, 'en' ) );
3300 $statusMove->setOK( false );
3301
3302 return $statusMove;
3303 }
3304 $status->merge( $statusMove );
3305 }
3306
3307 // Rename the file versions metadata in the DB.
3308 $this->doDBUpdates();
3309
3310 wfDebugLog( 'imagemove', "Renamed {$this->file->getName()} in database: " .
3311 "{$statusDb->successCount} successes, {$statusDb->failCount} failures" );
3312
3313 $destFile->unlock();
3314 $this->file->unlock();
3315
3316 // Everything went ok, remove the source files
3317 $this->cleanupSource( $triplets );
3318
3319 $status->merge( $statusDb );
3320
3321 return $status;
3322 }
3323
3324 /**
3325 * Verify the database updates and return a new Status indicating how
3326 * many rows would be updated.
3327 *
3328 * @return Status
3329 */
3330 protected function verifyDBUpdates() {
3331 $repo = $this->file->repo;
3332 $status = $repo->newGood();
3333 $dbw = $this->db;
3334
3335 $hasCurrent = $dbw->lockForUpdate(
3336 'image',
3337 [ 'img_name' => $this->oldName ],
3338 __METHOD__
3339 );
3340 $oldRowCount = $dbw->lockForUpdate(
3341 'oldimage',
3342 [ 'oi_name' => $this->oldName ],
3343 __METHOD__
3344 );
3345
3346 if ( $hasCurrent ) {
3347 $status->successCount++;
3348 } else {
3349 $status->failCount++;
3350 }
3351 $status->successCount += $oldRowCount;
3352 // T36934: oldCount is based on files that actually exist.
3353 // There may be more DB rows than such files, in which case $affected
3354 // can be greater than $total. We use max() to avoid negatives here.
3355 $status->failCount += max( 0, $this->oldCount - $oldRowCount );
3356 if ( $status->failCount ) {
3357 $status->error( 'imageinvalidfilename' );
3358 }
3359
3360 return $status;
3361 }
3362
3363 /**
3364 * Do the database updates and return a new Status indicating how
3365 * many rows where updated.
3366 */
3367 protected function doDBUpdates() {
3368 $dbw = $this->db;
3369
3370 // Update current image
3371 $dbw->update(
3372 'image',
3373 [ 'img_name' => $this->newName ],
3374 [ 'img_name' => $this->oldName ],
3375 __METHOD__
3376 );
3377
3378 // Update old images
3379 $dbw->update(
3380 'oldimage',
3381 [
3382 'oi_name' => $this->newName,
3383 'oi_archive_name = ' . $dbw->strreplace( 'oi_archive_name',
3384 $dbw->addQuotes( $this->oldName ), $dbw->addQuotes( $this->newName ) ),
3385 ],
3386 [ 'oi_name' => $this->oldName ],
3387 __METHOD__
3388 );
3389 }
3390
3391 /**
3392 * Generate triplets for FileRepo::storeBatch().
3393 * @return array[]
3394 */
3395 protected function getMoveTriplets() {
3396 $moves = array_merge( [ $this->cur ], $this->olds );
3397 $triplets = []; // The format is: (srcUrl, destZone, destUrl)
3398
3399 foreach ( $moves as $move ) {
3400 // $move: (oldRelativePath, newRelativePath)
3401 $srcUrl = $this->file->repo->getVirtualUrl() . '/public/' . rawurlencode( $move[0] );
3402 $triplets[] = [ $srcUrl, 'public', $move[1] ];
3403 wfDebugLog(
3404 'imagemove',
3405 "Generated move triplet for {$this->file->getName()}: {$srcUrl} :: public :: {$move[1]}"
3406 );
3407 }
3408
3409 return $triplets;
3410 }
3411
3412 /**
3413 * Removes non-existent files from move batch.
3414 * @param array $triplets
3415 * @return Status
3416 */
3417 protected function removeNonexistentFiles( $triplets ) {
3418 $files = [];
3419
3420 foreach ( $triplets as $file ) {
3421 $files[$file[0]] = $file[0];
3422 }
3423
3424 $result = $this->file->repo->fileExistsBatch( $files );
3425 if ( in_array( null, $result, true ) ) {
3426 return Status::newFatal( 'backend-fail-internal',
3427 $this->file->repo->getBackend()->getName() );
3428 }
3429
3430 $filteredTriplets = [];
3431 foreach ( $triplets as $file ) {
3432 if ( $result[$file[0]] ) {
3433 $filteredTriplets[] = $file;
3434 } else {
3435 wfDebugLog( 'imagemove', "File {$file[0]} does not exist" );
3436 }
3437 }
3438
3439 return Status::newGood( $filteredTriplets );
3440 }
3441
3442 /**
3443 * Cleanup a partially moved array of triplets by deleting the target
3444 * files. Called if something went wrong half way.
3445 * @param array[] $triplets
3446 */
3447 protected function cleanupTarget( $triplets ) {
3448 // Create dest pairs from the triplets
3449 $pairs = [];
3450 foreach ( $triplets as $triplet ) {
3451 // $triplet: (old source virtual URL, dst zone, dest rel)
3452 $pairs[] = [ $triplet[1], $triplet[2] ];
3453 }
3454
3455 $this->file->repo->cleanupBatch( $pairs );
3456 }
3457
3458 /**
3459 * Cleanup a fully moved array of triplets by deleting the source files.
3460 * Called at the end of the move process if everything else went ok.
3461 * @param array[] $triplets
3462 */
3463 protected function cleanupSource( $triplets ) {
3464 // Create source file names from the triplets
3465 $files = [];
3466 foreach ( $triplets as $triplet ) {
3467 $files[] = $triplet[0];
3468 }
3469
3470 $this->file->repo->cleanupBatch( $files );
3471 }
3472 }
3473
3474 class LocalFileLockError extends ErrorPageError {
3475 public function __construct( Status $status ) {
3476 parent::__construct(
3477 'actionfailed',
3478 $status->getMessage()
3479 );
3480 }
3481
3482 public function report() {
3483 global $wgOut;
3484 $wgOut->setStatusCode( 429 );
3485 parent::report();
3486 }
3487 }
Wiklou, le Wiki du Wiklou