includes/filerepo/LocalRepo.php

   1 <?php
   2 /**
   3  * Local repository that stores files in the local filesystem and registers them
   4  * in the wiki's own database.
   5  *
   6  * @file
   7  * @ingroup FileRepo
   8  */
   9
  10 /**
  11  * A repository that stores files in the local filesystem and registers them
  12  * in the wiki's own database. This is the most commonly used repository class.
  13  * @ingroup FileRepo
  14  */
  15 class LocalRepo extends FSRepo {
  16         var $fileFactory = array( 'LocalFile', 'newFromTitle' );
  17         var $fileFactoryKey = array( 'LocalFile', 'newFromKey' );
  18         var $oldFileFactory = array( 'OldLocalFile', 'newFromTitle' );
  19         var $oldFileFactoryKey = array( 'OldLocalFile', 'newFromKey' );
  20         var $fileFromRowFactory = array( 'LocalFile', 'newFromRow' );
  21         var $oldFileFromRowFactory = array( 'OldLocalFile', 'newFromRow' );
  22
  23         /**
  24          * @throws MWException
  25          * @param  $row
  26          * @return File
  27          */
  28         function newFileFromRow( $row ) {
  29                 if ( isset( $row->img_name ) ) {
  30                         return call_user_func( $this->fileFromRowFactory, $row, $this );
  31                 } elseif ( isset( $row->oi_name ) ) {
  32                         return call_user_func( $this->oldFileFromRowFactory, $row, $this );
  33                 } else {
  34                         throw new MWException( __METHOD__.': invalid row' );
  35                 }
  36         }
  37
  38         /**
  39          * @param $title
  40          * @param $archiveName
  41          * @return OldLocalFile
  42          */
  43         function newFromArchiveName( $title, $archiveName ) {
  44                 return OldLocalFile::newFromArchiveName( $title, $this, $archiveName );
  45         }
  46
  47         /**
  48          * Delete files in the deleted directory if they are not referenced in the
  49          * filearchive table. This needs to be done in the repo because it needs to
  50          * interleave database locks with file operations, which is potentially a
  51          * remote operation.
  52          *
  53          * @param $storageKeys array
  54          *
  55          * @return FileRepoStatus
  56          */
  57         function cleanupDeletedBatch( $storageKeys ) {
  58                 $root = $this->getZonePath( 'deleted' );
  59                 $dbw = $this->getMasterDB();
  60                 $status = $this->newGood();
  61                 $storageKeys = array_unique( $storageKeys );
  62                 foreach ( $storageKeys as $key ) {
  63                         $hashPath = $this->getDeletedHashPath( $key );
  64                         $path = "$root/$hashPath$key";
  65                         $dbw->begin();
  66                         // Check for usage in deleted/hidden files and pre-emptively
  67                         // lock the key to avoid any future use until we are finished.
  68                         $deleted = $this->deletedFileHasKey( $key, 'lock' );
  69                         $hidden = $this->hiddenFileHasKey( $key, 'lock' );
  70                         if ( !$deleted && !$hidden ) { // not in use now
  71                                 wfDebug( __METHOD__ . ": deleting $key\n" );
  72                                 wfSuppressWarnings();
  73                                 $unlink = unlink( $path );
  74                                 wfRestoreWarnings();
  75                                 if ( !$unlink ) {
  76                                         $status->error( 'undelete-cleanup-error', $path );
  77                                         $status->failCount++;
  78                                 }
  79                         } else {
  80                                 wfDebug( __METHOD__ . ": $key still in use\n" );
  81                                 $status->successCount++;
  82                         }
  83                         $dbw->commit();
  84                 }
  85                 return $status;
  86         }
  87
  88         /**
  89          * Check if a deleted (filearchive) file has this sha1 key
  90          * @param $key String File storage key (base-36 sha1 key with file extension)
  91          * @param $lock String|null Use "lock" to lock the row via FOR UPDATE
  92          * @return bool File with this key is in use
  93          */
  94         protected function deletedFileHasKey( $key, $lock = null ) {
  95                 $options = ( $lock === 'lock' ) ? array( 'FOR UPDATE' ) : array();
  96
  97                 $dbw = $this->getMasterDB();
  98                 return (bool)$dbw->selectField( 'filearchive', '1',
  99                         array( 'fa_storage_group' => 'deleted', 'fa_storage_key' => $key ),
 100                         __METHOD__, $options
 101                 );
 102         }
 103
 104         /**
 105          * Check if a hidden (revision delete) file has this sha1 key
 106          * @param $key String File storage key (base-36 sha1 key with file extension)
 107          * @param $lock String|null Use "lock" to lock the row via FOR UPDATE
 108          * @return bool File with this key is in use
 109          */
 110         protected function hiddenFileHasKey( $key, $lock = null ) {
 111                 $options = ( $lock === 'lock' ) ? array( 'FOR UPDATE' ) : array();
 112
 113                 $sha1 = self::getHashFromKey( $key );
 114                 $ext = File::normalizeExtension( substr( $key, strcspn( $key, '.' ) + 1 ) );
 115
 116                 $dbw = $this->getMasterDB();
 117                 return (bool)$dbw->selectField( 'oldimage', '1',
 118                         array( 'oi_sha1' => $sha1,
 119                                 'oi_archive_name ' . $dbw->buildLike( $dbw->anyString(), ".$ext" ),
 120                                 $dbw->bitAnd( 'oi_deleted', File::DELETED_FILE ) => File::DELETED_FILE ),
 121                         __METHOD__, array( 'FOR UPDATE' )
 122                 );
 123         }
 124
 125         /**
 126          * Gets the SHA1 hash from a storage key
 127          *
 128          * @param string $key
 129          * @return string
 130          */
 131         public static function getHashFromKey( $key ) {
 132                 return strtok( $key, '.' );
 133         }
 134
 135         /**
 136          * Checks if there is a redirect named as $title
 137          *
 138          * @param $title Title of file
 139          */
 140         function checkRedirect( $title ) {
 141                 global $wgMemc;
 142
 143                 if( is_string( $title ) ) {
 144                         $title = Title::newFromText( $title );
 145                 }
 146                 if( $title instanceof Title && $title->getNamespace() == NS_MEDIA ) {
 147                         $title = Title::makeTitle( NS_FILE, $title->getText() );
 148                 }
 149
 150                 $memcKey = $this->getSharedCacheKey( 'image_redirect', md5( $title->getDBkey() ) );
 151                 if ( $memcKey === false ) {
 152                         $memcKey = $this->getLocalCacheKey( 'image_redirect', md5( $title->getDBkey() ) );
 153                         $expiry = 300; // no invalidation, 5 minutes
 154                 } else {
 155                         $expiry = 86400; // has invalidation, 1 day
 156                 }
 157                 $cachedValue = $wgMemc->get( $memcKey );
 158                 if ( $cachedValue === ' '  || $cachedValue === '' ) {
 159                         // Does not exist
 160                         return false;
 161                 } elseif ( strval( $cachedValue ) !== '' ) {
 162                         return Title::newFromText( $cachedValue, NS_FILE );
 163                 } // else $cachedValue is false or null: cache miss
 164
 165                 $id = $this->getArticleID( $title );
 166                 if( !$id ) {
 167                         $wgMemc->set( $memcKey, " ", $expiry );
 168                         return false;
 169                 }
 170                 $dbr = $this->getSlaveDB();
 171                 $row = $dbr->selectRow(
 172                         'redirect',
 173                         array( 'rd_title', 'rd_namespace' ),
 174                         array( 'rd_from' => $id ),
 175                         __METHOD__
 176                 );
 177
 178                 if( $row && $row->rd_namespace == NS_FILE ) {
 179                         $targetTitle = Title::makeTitle( $row->rd_namespace, $row->rd_title );
 180                         $wgMemc->set( $memcKey, $targetTitle->getDBkey(), $expiry );
 181                         return $targetTitle;
 182                 } else {
 183                         $wgMemc->set( $memcKey, '', $expiry );
 184                         return false;
 185                 }
 186         }
 187
 188
 189         /**
 190          * Function link Title::getArticleID().
 191          * We can't say Title object, what database it should use, so we duplicate that function here.
 192          * @param $title Title
 193          */
 194         protected function getArticleID( $title ) {
 195                 if( !$title instanceof Title ) {
 196                         return 0;
 197                 }
 198                 $dbr = $this->getSlaveDB();
 199                 $id = $dbr->selectField(
 200                         'page', // Table
 201                         'page_id',      //Field
 202                         array(  //Conditions
 203                                 'page_namespace' => $title->getNamespace(),
 204                                 'page_title' => $title->getDBkey(),
 205                         ),
 206                         __METHOD__      //Function name
 207                 );
 208                 return $id;
 209         }
 210
 211         /**
 212          * Get an array or iterator of file objects for files that have a given
 213          * SHA-1 content hash.
 214          */
 215         function findBySha1( $hash ) {
 216                 $dbr = $this->getSlaveDB();
 217                 $res = $dbr->select(
 218                         'image',
 219                         LocalFile::selectFields(),
 220                         array( 'img_sha1' => $hash )
 221                 );
 222
 223                 $result = array();
 224                 foreach ( $res as $row ) {
 225                         $result[] = $this->newFileFromRow( $row );
 226                 }
 227                 $res->free();
 228
 229                 return $result;
 230         }
 231
 232         /**
 233          * Get a connection to the slave DB
 234          */
 235         function getSlaveDB() {
 236                 return wfGetDB( DB_SLAVE );
 237         }
 238
 239         /**
 240          * Get a connection to the master DB
 241          */
 242         function getMasterDB() {
 243                 return wfGetDB( DB_MASTER );
 244         }
 245
 246         /**
 247          * Get a key on the primary cache for this repository.
 248          * Returns false if the repository's cache is not accessible at this site.
 249          * The parameters are the parts of the key, as for wfMemcKey().
 250          */
 251         function getSharedCacheKey( /*...*/ ) {
 252                 $args = func_get_args();
 253                 return call_user_func_array( 'wfMemcKey', $args );
 254         }
 255
 256         /**
 257          * Invalidates image redirect cache related to that image
 258          *
 259          * @param $title Title of page
 260          */
 261         function invalidateImageRedirect( $title ) {
 262                 global $wgMemc;
 263                 $memcKey = $this->getSharedCacheKey( 'image_redirect', md5( $title->getDBkey() ) );
 264                 if ( $memcKey ) {
 265                         $wgMemc->delete( $memcKey );
 266                 }
 267         }
 268 }
 269