-
Notifications
You must be signed in to change notification settings - Fork 1.4k
/
LocalFile.php
2612 lines (2288 loc) · 77.7 KB
/
LocalFile.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
use MediaWiki\CommentStore\CommentStoreComment;
use MediaWiki\Context\RequestContext;
use MediaWiki\Deferred\AutoCommitUpdate;
use MediaWiki\Deferred\DeferredUpdates;
use MediaWiki\Deferred\LinksUpdate\LinksUpdate;
use MediaWiki\Deferred\SiteStatsUpdate;
use MediaWiki\FileRepo\File\FileSelectQueryBuilder;
use MediaWiki\Logger\LoggerFactory;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\Permissions\Authority;
use MediaWiki\Status\Status;
use MediaWiki\Title\Title;
use MediaWiki\User\UserIdentity;
use MediaWiki\User\UserIdentityValue;
use Wikimedia\FileBackend\FileBackend;
use Wikimedia\Rdbms\Blob;
use Wikimedia\Rdbms\Database;
use Wikimedia\Rdbms\IReadableDatabase;
use Wikimedia\Rdbms\IResultWrapper;
use Wikimedia\Rdbms\SelectQueryBuilder;
/**
* Local file in the wiki's own database.
*
* Provides methods to retrieve paths (physical, logical, URL),
* to generate image thumbnails or for uploading.
*
* Note that only the repo object knows what its file class is called. You should
* never name a file class explicitly outside of the repo class. Instead use the
* repo's factory functions to generate file objects, for example:
*
* RepoGroup::singleton()->getLocalRepo()->newFile( $title );
*
* Consider the services container below;
*
* $services = MediaWikiServices::getInstance();
*
* The convenience services $services->getRepoGroup()->getLocalRepo()->newFile()
* and $services->getRepoGroup()->findFile() should be sufficient in most cases.
*
* @TODO: DI - Instead of using MediaWikiServices::getInstance(), a service should
* ideally accept a RepoGroup in its constructor and then, use $this->repoGroup->findFile()
* and $this->repoGroup->getLocalRepo()->newFile().
*
* @stable to extend
* @ingroup FileAbstraction
*/
class LocalFile extends File {
private const VERSION = 13; // cache version
private const CACHE_FIELD_MAX_LEN = 1000;
/** @var string Metadata serialization: empty string. This is a compact non-legacy format. */
private const MDS_EMPTY = 'empty';
/** @var string Metadata serialization: some other string */
private const MDS_LEGACY = 'legacy';
/** @var string Metadata serialization: PHP serialize() */
private const MDS_PHP = 'php';
/** @var string Metadata serialization: JSON */
private const MDS_JSON = 'json';
/** @var int Maximum number of pages for which to trigger render jobs */
private const MAX_PAGE_RENDER_JOBS = 50;
/** @var bool Does the file exist on disk? (loadFromXxx) */
protected $fileExists;
/** @var int Image width */
protected $width;
/** @var int Image height */
protected $height;
/** @var int Returned by getimagesize (loadFromXxx) */
protected $bits;
/** @var string MEDIATYPE_xxx (bitmap, drawing, audio...) */
protected $media_type;
/** @var string MIME type, determined by MimeAnalyzer::guessMimeType */
protected $mime;
/** @var int Size in bytes (loadFromXxx) */
protected $size;
/** @var array Unserialized metadata */
protected $metadataArray = [];
/**
* One of the MDS_* constants, giving the format of the metadata as stored
* in the DB, or null if the data was not loaded from the DB.
*
* @var string|null
*/
protected $metadataSerializationFormat;
/** @var string[] Map of metadata item name to blob address */
protected $metadataBlobs = [];
/**
* Map of metadata item name to blob address for items that exist but
* have not yet been loaded into $this->metadataArray
*
* @var string[]
*/
protected $unloadedMetadataBlobs = [];
/** @var string SHA-1 base 36 content hash */
protected $sha1;
/** @var bool Whether or not core data has been loaded from the database (loadFromXxx) */
protected $dataLoaded = false;
/** @var bool Whether or not lazy-loaded data has been loaded from the database */
protected $extraDataLoaded = false;
/** @var int Bitfield akin to rev_deleted */
protected $deleted;
/** @var string */
protected $repoClass = LocalRepo::class;
/** @var int Number of line to return by nextHistoryLine() (constructor) */
private $historyLine = 0;
/** @var IResultWrapper|null Result of the query for the file's history (nextHistoryLine) */
private $historyRes = null;
/** @var string Major MIME type */
private $major_mime;
/** @var string Minor MIME type */
private $minor_mime;
/** @var string Upload timestamp */
private $timestamp;
/** @var UserIdentity|null Uploader */
private $user;
/** @var string Description of current revision of the file */
private $description;
/** @var string TS_MW timestamp of the last change of the file description */
private $descriptionTouched;
/** @var bool Whether the row was upgraded on load */
private $upgraded;
/** @var bool Whether the row was scheduled to upgrade on load */
private $upgrading;
/** @var int If >= 1 the image row is locked */
private $locked;
/** @var bool True if the image row is locked with a lock initiated transaction */
private $lockedOwnTrx;
/** @var bool True if file is not present in file system. Not to be cached in memcached */
private $missing;
/** @var MetadataStorageHelper */
private $metadataStorageHelper;
// @note: higher than IDBAccessObject constants
private const LOAD_ALL = 16; // integer; load all the lazy fields too (like metadata)
private const ATOMIC_SECTION_LOCK = 'LocalFile::lockingTransaction';
/**
* Create a LocalFile from a title
* Do not call this except from inside a repo class.
*
* Note: $unused param is only here to avoid an E_STRICT
*
* @stable to override
*
* @param Title $title
* @param LocalRepo $repo
* @param null $unused
*
* @return static
*/
public static function newFromTitle( $title, $repo, $unused = null ) {
return new static( $title, $repo );
}
/**
* Create a LocalFile from a title
* Do not call this except from inside a repo class.
*
* @stable to override
*
* @param stdClass $row
* @param LocalRepo $repo
*
* @return static
*/
public static function newFromRow( $row, $repo ) {
$title = Title::makeTitle( NS_FILE, $row->img_name );
$file = new static( $title, $repo );
$file->loadFromRow( $row );
return $file;
}
/**
* Create a LocalFile from a SHA-1 key
* Do not call this except from inside a repo class.
*
* @stable to override
*
* @param string $sha1 Base-36 SHA-1
* @param LocalRepo $repo
* @param string|false $timestamp MW_timestamp (optional)
* @return static|false
*/
public static function newFromKey( $sha1, $repo, $timestamp = false ) {
$dbr = $repo->getReplicaDB();
$queryBuilder = FileSelectQueryBuilder::newForFile( $dbr );
$queryBuilder->where( [ 'img_sha1' => $sha1 ] );
if ( $timestamp ) {
$queryBuilder->andWhere( [ 'img_timestamp' => $dbr->timestamp( $timestamp ) ] );
}
$row = $queryBuilder->caller( __METHOD__ )->fetchRow();
if ( $row ) {
return static::newFromRow( $row, $repo );
} else {
return false;
}
}
/**
* Return the tables, fields, and join conditions to be selected to create
* a new localfile object.
*
* Since 1.34, img_user and img_user_text have not been present in the
* database, but they continue to be available in query results as
* aliases.
*
* @since 1.31
* @stable to override
*
* @deprecated since 1.41 use FileSelectQueryBuilder instead
* @param string[] $options
* - omit-lazy: Omit fields that are lazily cached.
* @return array[] With three keys:
* - tables: (string[]) to include in the `$table` to `IDatabase->select()` or `SelectQueryBuilder::tables`
* - fields: (string[]) to include in the `$vars` to `IDatabase->select()` or `SelectQueryBuilder::fields`
* - joins: (array) to include in the `$join_conds` to `IDatabase->select()` or `SelectQueryBuilder::joinConds`
* @phan-return array{tables:string[],fields:string[],joins:array}
*/
public static function getQueryInfo( array $options = [] ) {
$dbr = MediaWikiServices::getInstance()->getConnectionProvider()->getReplicaDatabase();
$queryInfo = FileSelectQueryBuilder::newForFile( $dbr, $options )->getQueryInfo();
// needs remapping...
return [
'tables' => $queryInfo['tables'],
'fields' => $queryInfo['fields'],
'joins' => $queryInfo['join_conds'],
];
}
/**
* Do not call this except from inside a repo class.
* @stable to call
*
* @param Title $title
* @param LocalRepo $repo
*/
public function __construct( $title, $repo ) {
parent::__construct( $title, $repo );
$this->metadataStorageHelper = new MetadataStorageHelper( $repo );
$this->assertRepoDefined();
$this->assertTitleDefined();
}
/**
* @return LocalRepo|false
*/
public function getRepo() {
return $this->repo;
}
/**
* Get the memcached key for the main data for this file, or false if
* there is no access to the shared cache.
* @stable to override
* @return string|false
*/
protected function getCacheKey() {
return $this->repo->getSharedCacheKey( 'file', sha1( $this->getName() ) );
}
/**
* Try to load file metadata from memcached, falling back to the database
*/
private function loadFromCache() {
$this->dataLoaded = false;
$this->extraDataLoaded = false;
$key = $this->getCacheKey();
if ( !$key ) {
$this->loadFromDB( IDBAccessObject::READ_NORMAL );
return;
}
$cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
$cachedValues = $cache->getWithSetCallback(
$key,
$cache::TTL_WEEK,
function ( $oldValue, &$ttl, array &$setOpts ) use ( $cache ) {
$setOpts += Database::getCacheSetOptions( $this->repo->getReplicaDB() );
$this->loadFromDB( IDBAccessObject::READ_NORMAL );
$fields = $this->getCacheFields( '' );
$cacheVal = [];
$cacheVal['fileExists'] = $this->fileExists;
if ( $this->fileExists ) {
foreach ( $fields as $field ) {
$cacheVal[$field] = $this->$field;
}
}
if ( $this->user ) {
$cacheVal['user'] = $this->user->getId();
$cacheVal['user_text'] = $this->user->getName();
}
// Don't cache metadata items stored as blobs, since they tend to be large
if ( $this->metadataBlobs ) {
$cacheVal['metadata'] = array_diff_key(
$this->metadataArray, $this->metadataBlobs );
// Save the blob addresses
$cacheVal['metadataBlobs'] = $this->metadataBlobs;
} else {
$cacheVal['metadata'] = $this->metadataArray;
}
// Strip off excessive entries from the subset of fields that can become large.
// If the cache value gets too large and might not fit in the cache,
// causing repeat database queries for each access to the file.
foreach ( $this->getLazyCacheFields( '' ) as $field ) {
if ( isset( $cacheVal[$field] )
&& strlen( serialize( $cacheVal[$field] ) ) > 100 * 1024
) {
unset( $cacheVal[$field] ); // don't let the value get too big
if ( $field === 'metadata' ) {
unset( $cacheVal['metadataBlobs'] );
}
}
}
if ( $this->fileExists ) {
$ttl = $cache->adaptiveTTL( (int)wfTimestamp( TS_UNIX, $this->timestamp ), $ttl );
} else {
$ttl = $cache::TTL_DAY;
}
return $cacheVal;
},
[ 'version' => self::VERSION ]
);
$this->fileExists = $cachedValues['fileExists'];
if ( $this->fileExists ) {
$this->setProps( $cachedValues );
}
$this->dataLoaded = true;
$this->extraDataLoaded = true;
foreach ( $this->getLazyCacheFields( '' ) as $field ) {
$this->extraDataLoaded = $this->extraDataLoaded && isset( $cachedValues[$field] );
}
}
/**
* Purge the file object/metadata cache
*/
public function invalidateCache() {
$key = $this->getCacheKey();
if ( !$key ) {
return;
}
$this->repo->getPrimaryDB()->onTransactionPreCommitOrIdle(
static function () use ( $key ) {
MediaWikiServices::getInstance()->getMainWANObjectCache()->delete( $key );
},
__METHOD__
);
}
/**
* Load metadata from the file itself
*
* @internal
* @param string|null $path The path or virtual URL to load from, or null
* to use the previously stored file.
*/
public function loadFromFile( $path = null ) {
$props = $this->repo->getFileProps( $path ?? $this->getVirtualUrl() );
$this->setProps( $props );
}
/**
* Returns the list of object properties that are included as-is in the cache.
* @stable to override
* @param string $prefix Must be the empty string
* @return string[]
* @since 1.31 No longer accepts a non-empty $prefix
*/
protected function getCacheFields( $prefix = 'img_' ) {
if ( $prefix !== '' ) {
throw new InvalidArgumentException(
__METHOD__ . ' with a non-empty prefix is no longer supported.'
);
}
// See self::getQueryInfo() for the fetching of the data from the DB,
// self::loadFromRow() for the loading of the object from the DB row,
// and self::loadFromCache() for the caching, and self::setProps() for
// populating the object from an array of data.
return [ 'size', 'width', 'height', 'bits', 'media_type',
'major_mime', 'minor_mime', 'timestamp', 'sha1', 'description' ];
}
/**
* Returns the list of object properties that are included as-is in the
* cache, only when they're not too big, and are lazily loaded by self::loadExtraFromDB().
* @param string $prefix Must be the empty string
* @return string[]
* @since 1.31 No longer accepts a non-empty $prefix
*/
protected function getLazyCacheFields( $prefix = 'img_' ) {
if ( $prefix !== '' ) {
throw new InvalidArgumentException(
__METHOD__ . ' with a non-empty prefix is no longer supported.'
);
}
// Keep this in sync with the omit-lazy option in self::getQueryInfo().
return [ 'metadata' ];
}
/**
* Load file metadata from the DB
* @stable to override
* @param int $flags
*/
protected function loadFromDB( $flags = 0 ) {
$fname = static::class . '::' . __FUNCTION__;
# Unconditionally set loaded=true, we don't want the accessors constantly rechecking
$this->dataLoaded = true;
$this->extraDataLoaded = true;
$dbr = ( $flags & IDBAccessObject::READ_LATEST )
? $this->repo->getPrimaryDB()
: $this->repo->getReplicaDB();
$queryBuilder = FileSelectQueryBuilder::newForFile( $dbr );
$queryBuilder->where( [ 'img_name' => $this->getName() ] );
$row = $queryBuilder->caller( $fname )->fetchRow();
if ( $row ) {
$this->loadFromRow( $row );
} else {
$this->fileExists = false;
}
}
/**
* Load lazy file metadata from the DB.
* This covers fields that are sometimes not cached.
* @stable to override
*/
protected function loadExtraFromDB() {
if ( !$this->title ) {
return; // Avoid hard failure when the file does not exist. T221812
}
$fname = static::class . '::' . __FUNCTION__;
# Unconditionally set loaded=true, we don't want the accessors constantly rechecking
$this->extraDataLoaded = true;
$db = $this->repo->getReplicaDB();
$fieldMap = $this->loadExtraFieldsWithTimestamp( $db, $fname );
if ( !$fieldMap ) {
$db = $this->repo->getPrimaryDB();
$fieldMap = $this->loadExtraFieldsWithTimestamp( $db, $fname );
}
if ( $fieldMap ) {
if ( isset( $fieldMap['metadata'] ) ) {
$this->loadMetadataFromDbFieldValue( $db, $fieldMap['metadata'] );
}
} else {
throw new RuntimeException( "Could not find data for image '{$this->getName()}'." );
}
}
/**
* @param IReadableDatabase $dbr
* @param string $fname
* @return string[]|false
*/
private function loadExtraFieldsWithTimestamp( IReadableDatabase $dbr, $fname ) {
$fieldMap = false;
$queryBuilder = FileSelectQueryBuilder::newForFile( $dbr, [ 'omit-nonlazy' ] );
$queryBuilder->where( [ 'img_name' => $this->getName() ] )
->andWhere( [ 'img_timestamp' => $dbr->timestamp( $this->getTimestamp() ) ] );
$row = $queryBuilder->caller( $fname )->fetchRow();
if ( $row ) {
$fieldMap = $this->unprefixRow( $row, 'img_' );
} else {
# File may have been uploaded over in the meantime; check the old versions
$queryBuilder = FileSelectQueryBuilder::newForOldFile( $dbr, [ 'omit-nonlazy' ] );
$row = $queryBuilder->where( [ 'oi_name' => $this->getName() ] )
->andWhere( [ 'oi_timestamp' => $dbr->timestamp( $this->getTimestamp() ) ] )
->caller( __METHOD__ )->fetchRow();
if ( $row ) {
$fieldMap = $this->unprefixRow( $row, 'oi_' );
}
}
return $fieldMap;
}
/**
* @param array|stdClass $row
* @param string $prefix
* @return array
*/
protected function unprefixRow( $row, $prefix = 'img_' ) {
$array = (array)$row;
$prefixLength = strlen( $prefix );
// Double check prefix once
if ( substr( array_key_first( $array ), 0, $prefixLength ) !== $prefix ) {
throw new InvalidArgumentException( __METHOD__ . ': incorrect $prefix parameter' );
}
$decoded = [];
foreach ( $array as $name => $value ) {
$decoded[substr( $name, $prefixLength )] = $value;
}
return $decoded;
}
/**
* Load file metadata from a DB result row
* @stable to override
*
* Passing arbitrary fields in the row and expecting them to be translated
* to property names on $this is deprecated since 1.37. Instead, override
* loadFromRow(), and clone and unset the extra fields before passing them
* to the parent.
*
* After the deprecation period has passed, extra fields will be ignored,
* and the deprecation warning will be removed.
*
* @param stdClass $row
* @param string $prefix
*/
public function loadFromRow( $row, $prefix = 'img_' ) {
$this->dataLoaded = true;
$unprefixed = $this->unprefixRow( $row, $prefix );
$this->name = $unprefixed['name'];
$this->media_type = $unprefixed['media_type'];
$services = MediaWikiServices::getInstance();
$this->description = $services->getCommentStore()
->getComment( "{$prefix}description", $row )->text;
$this->user = $services->getUserFactory()->newFromAnyId(
$unprefixed['user'] ?? null,
$unprefixed['user_text'] ?? null,
$unprefixed['actor'] ?? null
);
$this->timestamp = wfTimestamp( TS_MW, $unprefixed['timestamp'] );
$this->loadMetadataFromDbFieldValue(
$this->repo->getReplicaDB(), $unprefixed['metadata'] );
if ( empty( $unprefixed['major_mime'] ) ) {
$this->major_mime = 'unknown';
$this->minor_mime = 'unknown';
$this->mime = 'unknown/unknown';
} else {
if ( !$unprefixed['minor_mime'] ) {
$unprefixed['minor_mime'] = 'unknown';
}
$this->major_mime = $unprefixed['major_mime'];
$this->minor_mime = $unprefixed['minor_mime'];
$this->mime = $unprefixed['major_mime'] . '/' . $unprefixed['minor_mime'];
}
// Trim zero padding from char/binary field
$this->sha1 = rtrim( $unprefixed['sha1'], "\0" );
// Normalize some fields to integer type, per their database definition.
// Use unary + so that overflows will be upgraded to double instead of
// being truncated as with intval(). This is important to allow > 2 GiB
// files on 32-bit systems.
$this->size = +$unprefixed['size'];
$this->width = +$unprefixed['width'];
$this->height = +$unprefixed['height'];
$this->bits = +$unprefixed['bits'];
// Check for extra fields (deprecated since MW 1.37)
$extraFields = array_diff(
array_keys( $unprefixed ),
[
'name', 'media_type', 'description_text', 'description_data',
'description_cid', 'user', 'user_text', 'actor', 'timestamp',
'metadata', 'major_mime', 'minor_mime', 'sha1', 'size', 'width',
'height', 'bits'
]
);
if ( $extraFields ) {
wfDeprecatedMsg(
'Passing extra fields (' .
implode( ', ', $extraFields )
. ') to ' . __METHOD__ . ' was deprecated in MediaWiki 1.37. ' .
'Property assignment will be removed in a later version.',
'1.37' );
foreach ( $extraFields as $field ) {
$this->$field = $unprefixed[$field];
}
}
$this->fileExists = true;
}
/**
* Load file metadata from cache or DB, unless already loaded
* @stable to override
* @param int $flags
*/
public function load( $flags = 0 ) {
if ( !$this->dataLoaded ) {
if ( $flags & IDBAccessObject::READ_LATEST ) {
$this->loadFromDB( $flags );
} else {
$this->loadFromCache();
}
}
if ( ( $flags & self::LOAD_ALL ) && !$this->extraDataLoaded ) {
// @note: loads on name/timestamp to reduce race condition problems
$this->loadExtraFromDB();
}
}
/**
* Upgrade a row if it needs it
* @internal
*/
public function maybeUpgradeRow() {
if ( MediaWikiServices::getInstance()->getReadOnlyMode()->isReadOnly() || $this->upgrading ) {
return;
}
$upgrade = false;
$reserialize = false;
if ( $this->media_type === null || $this->mime == 'image/svg' ) {
$upgrade = true;
} else {
$handler = $this->getHandler();
if ( $handler ) {
$validity = $handler->isFileMetadataValid( $this );
if ( $validity === MediaHandler::METADATA_BAD ) {
$upgrade = true;
} elseif ( $validity === MediaHandler::METADATA_COMPATIBLE
&& $this->repo->isMetadataUpdateEnabled()
) {
$upgrade = true;
} elseif ( $this->repo->isJsonMetadataEnabled()
&& $this->repo->isMetadataReserializeEnabled()
) {
if ( $this->repo->isSplitMetadataEnabled() && $this->isMetadataOversize() ) {
$reserialize = true;
} elseif ( $this->metadataSerializationFormat !== self::MDS_EMPTY &&
$this->metadataSerializationFormat !== self::MDS_JSON ) {
$reserialize = true;
}
}
}
}
if ( $upgrade || $reserialize ) {
$this->upgrading = true;
// Defer updates unless in auto-commit CLI mode
DeferredUpdates::addCallableUpdate( function () use ( $upgrade ) {
$this->upgrading = false; // avoid duplicate updates
try {
if ( $upgrade ) {
$this->upgradeRow();
} else {
$this->reserializeMetadata();
}
} catch ( LocalFileLockError $e ) {
// let the other process handle it (or do it next time)
}
} );
}
}
/**
* @return bool Whether upgradeRow() ran for this object
*/
public function getUpgraded() {
return $this->upgraded;
}
/**
* Fix assorted version-related problems with the image row by reloading it from the file
* @stable to override
*/
public function upgradeRow() {
$dbw = $this->repo->getPrimaryDB();
// Make a DB query condition that will fail to match the image row if the
// image was reuploaded while the upgrade was in process.
$freshnessCondition = [ 'img_timestamp' => $dbw->timestamp( $this->getTimestamp() ) ];
$this->loadFromFile();
# Don't destroy file info of missing files
if ( !$this->fileExists ) {
wfDebug( __METHOD__ . ": file does not exist, aborting" );
return;
}
[ $major, $minor ] = self::splitMime( $this->mime );
wfDebug( __METHOD__ . ': upgrading ' . $this->getName() . " to the current schema" );
$dbw->newUpdateQueryBuilder()
->update( 'image' )
->set( [
'img_size' => $this->size,
'img_width' => $this->width,
'img_height' => $this->height,
'img_bits' => $this->bits,
'img_media_type' => $this->media_type,
'img_major_mime' => $major,
'img_minor_mime' => $minor,
'img_metadata' => $this->getMetadataForDb( $dbw ),
'img_sha1' => $this->sha1,
] )
->where( [ 'img_name' => $this->getName() ] )
->andWhere( $freshnessCondition )
->caller( __METHOD__ )->execute();
$this->invalidateCache();
$this->upgraded = true; // avoid rework/retries
}
/**
* Write the metadata back to the database with the current serialization
* format.
*/
protected function reserializeMetadata() {
if ( MediaWikiServices::getInstance()->getReadOnlyMode()->isReadOnly() ) {
return;
}
$dbw = $this->repo->getPrimaryDB();
$dbw->newUpdateQueryBuilder()
->update( 'image' )
->set( [ 'img_metadata' => $this->getMetadataForDb( $dbw ) ] )
->where( [
'img_name' => $this->name,
'img_timestamp' => $dbw->timestamp( $this->timestamp ),
] )
->caller( __METHOD__ )->execute();
$this->upgraded = true;
}
/**
* Set properties in this object to be equal to those given in the
* associative array $info. Only cacheable fields can be set.
* All fields *must* be set in $info except for getLazyCacheFields().
*
* If 'mime' is given, it will be split into major_mime/minor_mime.
* If major_mime/minor_mime are given, $this->mime will also be set.
*
* @stable to override
* @param array $info
*/
protected function setProps( $info ) {
$this->dataLoaded = true;
$fields = $this->getCacheFields( '' );
$fields[] = 'fileExists';
foreach ( $fields as $field ) {
if ( isset( $info[$field] ) ) {
$this->$field = $info[$field];
}
}
// Only our own cache sets these properties, so they both should be present.
if ( isset( $info['user'] ) &&
isset( $info['user_text'] ) &&
$info['user_text'] !== ''
) {
$this->user = new UserIdentityValue( $info['user'], $info['user_text'] );
}
// Fix up mime fields
if ( isset( $info['major_mime'] ) ) {
$this->mime = "{$info['major_mime']}/{$info['minor_mime']}";
} elseif ( isset( $info['mime'] ) ) {
$this->mime = $info['mime'];
[ $this->major_mime, $this->minor_mime ] = self::splitMime( $this->mime );
}
if ( isset( $info['metadata'] ) ) {
if ( is_string( $info['metadata'] ) ) {
$this->loadMetadataFromString( $info['metadata'] );
} elseif ( is_array( $info['metadata'] ) ) {
$this->metadataArray = $info['metadata'];
if ( isset( $info['metadataBlobs'] ) ) {
$this->metadataBlobs = $info['metadataBlobs'];
$this->unloadedMetadataBlobs = array_diff_key(
$this->metadataBlobs,
$this->metadataArray
);
} else {
$this->metadataBlobs = [];
$this->unloadedMetadataBlobs = [];
}
} else {
$logger = LoggerFactory::getInstance( 'LocalFile' );
$logger->warning( __METHOD__ . ' given invalid metadata of type ' .
gettype( $info['metadata'] ) );
$this->metadataArray = [];
}
$this->extraDataLoaded = true;
}
}
/** splitMime inherited */
/** getName inherited */
/** getTitle inherited */
/** getURL inherited */
/** getViewURL inherited */
/** getPath inherited */
/** isVisible inherited */
/**
* Checks if this file exists in its parent repo, as referenced by its
* virtual URL.
* @stable to override
*
* @return bool
*/
public function isMissing() {
if ( $this->missing === null ) {
$fileExists = $this->repo->fileExists( $this->getVirtualUrl() );
$this->missing = !$fileExists;
}
return $this->missing;
}
/**
* Return the width of the image
* @stable to override
*
* @param int $page
* @return int
*/
public function getWidth( $page = 1 ) {
$page = (int)$page;
if ( $page < 1 ) {
$page = 1;
}
$this->load();
if ( $this->isMultipage() ) {
$handler = $this->getHandler();
if ( !$handler ) {
return 0;
}
$dim = $handler->getPageDimensions( $this, $page );
if ( $dim ) {
return $dim['width'];
} else {
// For non-paged media, the false goes through an
// intval, turning failure into 0, so do same here.
return 0;
}
} else {
return $this->width;
}
}
/**
* Return the height of the image
* @stable to override
*
* @param int $page
* @return int
*/
public function getHeight( $page = 1 ) {
$page = (int)$page;
if ( $page < 1 ) {
$page = 1;
}
$this->load();
if ( $this->isMultipage() ) {
$handler = $this->getHandler();
if ( !$handler ) {
return 0;
}
$dim = $handler->getPageDimensions( $this, $page );
if ( $dim ) {
return $dim['height'];
} else {
// For non-paged media, the false goes through an
// intval, turning failure into 0, so do same here.
return 0;
}
} else {
return $this->height;
}
}
/**
* Get short description URL for a file based on the page ID.
* @stable to override
*
* @return string|null
* @since 1.27
*/
public function getDescriptionShortUrl() {
if ( !$this->title ) {
return null; // Avoid hard failure when the file does not exist. T221812
}
$pageId = $this->title->getArticleID();
if ( $pageId ) {
$url = $this->repo->makeUrl( [ 'curid' => $pageId ] );
if ( $url !== false ) {
return $url;
}
}
return null;
}
/**
* Get handler-specific metadata as a serialized string
*
* @deprecated since 1.37 use getMetadataArray() or getMetadataItem()
* @return string
*/
public function getMetadata() {