includes/filerepo/file/ArchivedFile.php

   1 <?php
   2 /**
   3  * Deleted file in the 'filearchive' table.
   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\MediaWikiServices;
  25
  26 /**
  27  * Class representing a row of the 'filearchive' table
  28  *
  29  * @ingroup FileAbstraction
  30  */
  31 class ArchivedFile {
  32         /** @var int Filearchive row ID */
  33         private $id;
  34
  35         /** @var string File name */
  36         private $name;
  37
  38         /** @var string FileStore storage group */
  39         private $group;
  40
  41         /** @var string FileStore SHA-1 key */
  42         private $key;
  43
  44         /** @var int File size in bytes */
  45         private $size;
  46
  47         /** @var int Size in bytes */
  48         private $bits;
  49
  50         /** @var int Width */
  51         private $width;
  52
  53         /** @var int Height */
  54         private $height;
  55
  56         /** @var string Metadata string */
  57         private $metadata;
  58
  59         /** @var string MIME type */
  60         private $mime;
  61
  62         /** @var string Media type */
  63         private $media_type;
  64
  65         /** @var string Upload description */
  66         private $description;
  67
  68         /** @var User|null Uploader */
  69         private $user;
  70
  71         /** @var string Time of upload */
  72         private $timestamp;
  73
  74         /** @var bool Whether or not all this has been loaded from the database (loadFromXxx) */
  75         private $dataLoaded;
  76
  77         /** @var int Bitfield akin to rev_deleted */
  78         private $deleted;
  79
  80         /** @var string SHA-1 hash of file content */
  81         private $sha1;
  82
  83         /** @var int|false Number of pages of a multipage document, or false for
  84          * documents which aren't multipage documents
  85          */
  86         private $pageCount;
  87
  88         /** @var string Original base filename */
  89         private $archive_name;
  90
  91         /** @var MediaHandler */
  92         protected $handler;
  93
  94         /** @var Title */
  95         protected $title; # image title
  96
  97         /**
  98          * @throws MWException
  99          * @param Title $title
 100          * @param int $id
 101          * @param string $key
 102          * @param string $sha1
 103          */
 104         function __construct( $title, $id = 0, $key = '', $sha1 = '' ) {
 105                 $this->id = -1;
 106                 $this->title = false;
 107                 $this->name = false;
 108                 $this->group = 'deleted'; // needed for direct use of constructor
 109                 $this->key = '';
 110                 $this->size = 0;
 111                 $this->bits = 0;
 112                 $this->width = 0;
 113                 $this->height = 0;
 114                 $this->metadata = '';
 115                 $this->mime = "unknown/unknown";
 116                 $this->media_type = '';
 117                 $this->description = '';
 118                 $this->user = null;
 119                 $this->timestamp = null;
 120                 $this->deleted = 0;
 121                 $this->dataLoaded = false;
 122                 $this->exists = false;
 123                 $this->sha1 = '';
 124
 125                 if ( $title instanceof Title ) {
 126                         $this->title = File::normalizeTitle( $title, 'exception' );
 127                         $this->name = $title->getDBkey();
 128                 }
 129
 130                 if ( $id ) {
 131                         $this->id = $id;
 132                 }
 133
 134                 if ( $key ) {
 135                         $this->key = $key;
 136                 }
 137
 138                 if ( $sha1 ) {
 139                         $this->sha1 = $sha1;
 140                 }
 141
 142                 if ( !$id && !$key && !( $title instanceof Title ) && !$sha1 ) {
 143                         throw new MWException( "No specifications provided to ArchivedFile constructor." );
 144                 }
 145         }
 146
 147         /**
 148          * Loads a file object from the filearchive table
 149          * @throws MWException
 150          * @return bool|null True on success or null
 151          */
 152         public function load() {
 153                 if ( $this->dataLoaded ) {
 154                         return true;
 155                 }
 156                 $conds = [];
 157
 158                 if ( $this->id > 0 ) {
 159                         $conds['fa_id'] = $this->id;
 160                 }
 161                 if ( $this->key ) {
 162                         $conds['fa_storage_group'] = $this->group;
 163                         $conds['fa_storage_key'] = $this->key;
 164                 }
 165                 if ( $this->title ) {
 166                         $conds['fa_name'] = $this->title->getDBkey();
 167                 }
 168                 if ( $this->sha1 ) {
 169                         $conds['fa_sha1'] = $this->sha1;
 170                 }
 171
 172                 if ( $conds === [] ) {
 173                         throw new MWException( "No specific information for retrieving archived file" );
 174                 }
 175
 176                 if ( !$this->title || $this->title->getNamespace() == NS_FILE ) {
 177                         $this->dataLoaded = true; // set it here, to have also true on miss
 178                         $dbr = wfGetDB( DB_REPLICA );
 179                         $fileQuery = self::getQueryInfo();
 180                         $row = $dbr->selectRow(
 181                                 $fileQuery['tables'],
 182                                 $fileQuery['fields'],
 183                                 $conds,
 184                                 __METHOD__,
 185                                 [ 'ORDER BY' => 'fa_timestamp DESC' ],
 186                                 $fileQuery['joins']
 187                         );
 188                         if ( !$row ) {
 189                                 // this revision does not exist?
 190                                 return null;
 191                         }
 192
 193                         // initialize fields for filestore image object
 194                         $this->loadFromRow( $row );
 195                 } else {
 196                         throw new MWException( 'This title does not correspond to an image page.' );
 197                 }
 198                 $this->exists = true;
 199
 200                 return true;
 201         }
 202
 203         /**
 204          * Loads a file object from the filearchive table
 205          *
 206          * @param stdClass $row
 207          * @return ArchivedFile
 208          */
 209         public static function newFromRow( $row ) {
 210                 $file = new ArchivedFile( Title::makeTitle( NS_FILE, $row->fa_name ) );
 211                 $file->loadFromRow( $row );
 212
 213                 return $file;
 214         }
 215
 216         /**
 217          * Fields in the filearchive table
 218          * @deprecated since 1.31, use self::getQueryInfo() instead.
 219          * @return string[]
 220          */
 221         static function selectFields() {
 222                 global $wgActorTableSchemaMigrationStage;
 223
 224                 if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW ) {
 225                         // If code is using this instead of self::getQueryInfo(), there's a
 226                         // decent chance it's going to try to directly access
 227                         // $row->fa_user or $row->fa_user_text and we can't give it
 228                         // useful values here once those aren't being used anymore.
 229                         throw new BadMethodCallException(
 230                                 'Cannot use ' . __METHOD__
 231                                         . ' when $wgActorTableSchemaMigrationStage has SCHEMA_COMPAT_READ_NEW'
 232                         );
 233                 }
 234
 235                 wfDeprecated( __METHOD__, '1.31' );
 236                 return [
 237                         'fa_id',
 238                         'fa_name',
 239                         'fa_archive_name',
 240                         'fa_storage_key',
 241                         'fa_storage_group',
 242                         'fa_size',
 243                         'fa_bits',
 244                         'fa_width',
 245                         'fa_height',
 246                         'fa_metadata',
 247                         'fa_media_type',
 248                         'fa_major_mime',
 249                         'fa_minor_mime',
 250                         'fa_user',
 251                         'fa_user_text',
 252                         'fa_actor' => 'NULL',
 253                         'fa_timestamp',
 254                         'fa_deleted',
 255                         'fa_deleted_timestamp', /* Used by LocalFileRestoreBatch */
 256                         'fa_sha1',
 257                 ] + MediaWikiServices::getInstance()->getCommentStore()->getFields( 'fa_description' );
 258         }
 259
 260         /**
 261          * Return the tables, fields, and join conditions to be selected to create
 262          * a new archivedfile object.
 263          * @since 1.31
 264          * @return array[] With three keys:
 265          *   - tables: (string[]) to include in the `$table` to `IDatabase->select()`
 266          *   - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
 267          *   - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
 268          */
 269         public static function getQueryInfo() {
 270                 $commentQuery = MediaWikiServices::getInstance()->getCommentStore()->getJoin( 'fa_description' );
 271                 $actorQuery = ActorMigration::newMigration()->getJoin( 'fa_user' );
 272                 return [
 273                         'tables' => [ 'filearchive' ] + $commentQuery['tables'] + $actorQuery['tables'],
 274                         'fields' => [
 275                                 'fa_id',
 276                                 'fa_name',
 277                                 'fa_archive_name',
 278                                 'fa_storage_key',
 279                                 'fa_storage_group',
 280                                 'fa_size',
 281                                 'fa_bits',
 282                                 'fa_width',
 283                                 'fa_height',
 284                                 'fa_metadata',
 285                                 'fa_media_type',
 286                                 'fa_major_mime',
 287                                 'fa_minor_mime',
 288                                 'fa_timestamp',
 289                                 'fa_deleted',
 290                                 'fa_deleted_timestamp', /* Used by LocalFileRestoreBatch */
 291                                 'fa_sha1',
 292                         ] + $commentQuery['fields'] + $actorQuery['fields'],
 293                         'joins' => $commentQuery['joins'] + $actorQuery['joins'],
 294                 ];
 295         }
 296
 297         /**
 298          * Load ArchivedFile object fields from a DB row.
 299          *
 300          * @param stdClass $row Object database row
 301          * @since 1.21
 302          */
 303         public function loadFromRow( $row ) {
 304                 $this->id = intval( $row->fa_id );
 305                 $this->name = $row->fa_name;
 306                 $this->archive_name = $row->fa_archive_name;
 307                 $this->group = $row->fa_storage_group;
 308                 $this->key = $row->fa_storage_key;
 309                 $this->size = $row->fa_size;
 310                 $this->bits = $row->fa_bits;
 311                 $this->width = $row->fa_width;
 312                 $this->height = $row->fa_height;
 313                 $this->metadata = $row->fa_metadata;
 314                 $this->mime = "$row->fa_major_mime/$row->fa_minor_mime";
 315                 $this->media_type = $row->fa_media_type;
 316                 $this->description = MediaWikiServices::getInstance()->getCommentStore()
 317                         // Legacy because $row may have come from self::selectFields()
 318                         ->getCommentLegacy( wfGetDB( DB_REPLICA ), 'fa_description', $row )->text;
 319                 $this->user = User::newFromAnyId( $row->fa_user, $row->fa_user_text, $row->fa_actor );
 320                 $this->timestamp = $row->fa_timestamp;
 321                 $this->deleted = $row->fa_deleted;
 322                 if ( isset( $row->fa_sha1 ) ) {
 323                         $this->sha1 = $row->fa_sha1;
 324                 } else {
 325                         // old row, populate from key
 326                         $this->sha1 = LocalRepo::getHashFromKey( $this->key );
 327                 }
 328                 if ( !$this->title ) {
 329                         $this->title = Title::makeTitleSafe( NS_FILE, $row->fa_name );
 330                 }
 331         }
 332
 333         /**
 334          * Return the associated title object
 335          *
 336          * @return Title
 337          */
 338         public function getTitle() {
 339                 if ( !$this->title ) {
 340                         $this->load();
 341                 }
 342                 return $this->title;
 343         }
 344
 345         /**
 346          * Return the file name
 347          *
 348          * @return string
 349          */
 350         public function getName() {
 351                 if ( $this->name === false ) {
 352                         $this->load();
 353                 }
 354
 355                 return $this->name;
 356         }
 357
 358         /**
 359          * @return int
 360          */
 361         public function getID() {
 362                 $this->load();
 363
 364                 return $this->id;
 365         }
 366
 367         /**
 368          * @return bool
 369          */
 370         public function exists() {
 371                 $this->load();
 372
 373                 return $this->exists;
 374         }
 375
 376         /**
 377          * Return the FileStore key
 378          * @return string
 379          */
 380         public function getKey() {
 381                 $this->load();
 382
 383                 return $this->key;
 384         }
 385
 386         /**
 387          * Return the FileStore key (overriding base File class)
 388          * @return string
 389          */
 390         public function getStorageKey() {
 391                 return $this->getKey();
 392         }
 393
 394         /**
 395          * Return the FileStore storage group
 396          * @return string
 397          */
 398         public function getGroup() {
 399                 return $this->group;
 400         }
 401
 402         /**
 403          * Return the width of the image
 404          * @return int
 405          */
 406         public function getWidth() {
 407                 $this->load();
 408
 409                 return $this->width;
 410         }
 411
 412         /**
 413          * Return the height of the image
 414          * @return int
 415          */
 416         public function getHeight() {
 417                 $this->load();
 418
 419                 return $this->height;
 420         }
 421
 422         /**
 423          * Get handler-specific metadata
 424          * @return string
 425          */
 426         public function getMetadata() {
 427                 $this->load();
 428
 429                 return $this->metadata;
 430         }
 431
 432         /**
 433          * Return the size of the image file, in bytes
 434          * @return int
 435          */
 436         public function getSize() {
 437                 $this->load();
 438
 439                 return $this->size;
 440         }
 441
 442         /**
 443          * Return the bits of the image file, in bytes
 444          * @return int
 445          */
 446         public function getBits() {
 447                 $this->load();
 448
 449                 return $this->bits;
 450         }
 451
 452         /**
 453          * Returns the MIME type of the file.
 454          * @return string
 455          */
 456         public function getMimeType() {
 457                 $this->load();
 458
 459                 return $this->mime;
 460         }
 461
 462         /**
 463          * Get a MediaHandler instance for this file
 464          * @return MediaHandler
 465          */
 466         function getHandler() {
 467                 if ( !isset( $this->handler ) ) {
 468                         $this->handler = MediaHandler::getHandler( $this->getMimeType() );
 469                 }
 470
 471                 return $this->handler;
 472         }
 473
 474         /**
 475          * Returns the number of pages of a multipage document, or false for
 476          * documents which aren't multipage documents
 477          * @return bool|int
 478          */
 479         function pageCount() {
 480                 if ( !isset( $this->pageCount ) ) {
 481                         // @FIXME: callers expect File objects
 482                         if ( $this->getHandler() && $this->handler->isMultiPage( $this ) ) {
 483                                 $this->pageCount = $this->handler->pageCount( $this );
 484                         } else {
 485                                 $this->pageCount = false;
 486                         }
 487                 }
 488
 489                 return $this->pageCount;
 490         }
 491
 492         /**
 493          * Return the type of the media in the file.
 494          * Use the value returned by this function with the MEDIATYPE_xxx constants.
 495          * @return string
 496          */
 497         public function getMediaType() {
 498                 $this->load();
 499
 500                 return $this->media_type;
 501         }
 502
 503         /**
 504          * Return upload timestamp.
 505          *
 506          * @return string
 507          */
 508         public function getTimestamp() {
 509                 $this->load();
 510
 511                 return wfTimestamp( TS_MW, $this->timestamp );
 512         }
 513
 514         /**
 515          * Get the SHA-1 base 36 hash of the file
 516          *
 517          * @return string
 518          * @since 1.21
 519          */
 520         function getSha1() {
 521                 $this->load();
 522
 523                 return $this->sha1;
 524         }
 525
 526         /**
 527          * Returns ID or name of user who uploaded the file
 528          *
 529          * @note Prior to MediaWiki 1.23, this method always
 530          *   returned the user id, and was inconsistent with
 531          *   the rest of the file classes.
 532          * @param string $type 'text', 'id', or 'object'
 533          * @return int|string|User|null
 534          * @throws MWException
 535          * @since 1.31 added 'object'
 536          */
 537         public function getUser( $type = 'text' ) {
 538                 $this->load();
 539
 540                 if ( $type === 'object' ) {
 541                         return $this->user;
 542                 } elseif ( $type === 'text' ) {
 543                         return $this->user ? $this->user->getName() : '';
 544                 } elseif ( $type === 'id' ) {
 545                         return $this->user ? $this->user->getId() : 0;
 546                 }
 547
 548                 throw new MWException( "Unknown type '$type'." );
 549         }
 550
 551         /**
 552          * Return upload description.
 553          *
 554          * @return string|int
 555          */
 556         public function getDescription() {
 557                 $this->load();
 558                 if ( $this->isDeleted( File::DELETED_COMMENT ) ) {
 559                         return 0;
 560                 } else {
 561                         return $this->description;
 562                 }
 563         }
 564
 565         /**
 566          * Return the user ID of the uploader.
 567          *
 568          * @return int
 569          */
 570         public function getRawUser() {
 571                 return $this->getUser( 'id' );
 572         }
 573
 574         /**
 575          * Return the user name of the uploader.
 576          *
 577          * @return string
 578          */
 579         public function getRawUserText() {
 580                 return $this->getUser( 'text' );
 581         }
 582
 583         /**
 584          * Return upload description.
 585          *
 586          * @return string
 587          */
 588         public function getRawDescription() {
 589                 $this->load();
 590
 591                 return $this->description;
 592         }
 593
 594         /**
 595          * Returns the deletion bitfield
 596          * @return int
 597          */
 598         public function getVisibility() {
 599                 $this->load();
 600
 601                 return $this->deleted;
 602         }
 603
 604         /**
 605          * for file or revision rows
 606          *
 607          * @param int $field One of DELETED_* bitfield constants
 608          * @return bool
 609          */
 610         public function isDeleted( $field ) {
 611                 $this->load();
 612
 613                 return ( $this->deleted & $field ) == $field;
 614         }
 615
 616         /**
 617          * Determine if the current user is allowed to view a particular
 618          * field of this FileStore image file, if it's marked as deleted.
 619          * @param int $field
 620          * @param null|User $user User object to check, or null to use $wgUser
 621          * @return bool
 622          */
 623         public function userCan( $field, User $user = null ) {
 624                 $this->load();
 625
 626                 $title = $this->getTitle();
 627                 return Revision::userCanBitfield( $this->deleted, $field, $user, $title ?: null );
 628         }
 629 }