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