LocalRepo.php

Go to the documentation of this file.

<?php
class LocalRepo extends FileRepo {
        var $fileFactory           = array( 'LocalFile'   , 'newFromTitle' );
        var $fileFactoryKey        = array( 'LocalFile'   , 'newFromKey'   );
        var $fileFromRowFactory    = array( 'LocalFile'   , 'newFromRow'   );
        var $oldFileFactory        = array( 'OldLocalFile', 'newFromTitle' );
        var $oldFileFactoryKey     = array( 'OldLocalFile', 'newFromKey'   );
        var $oldFileFromRowFactory = array( 'OldLocalFile', 'newFromRow'   );

        function newFileFromRow( $row ) {
                if ( isset( $row->img_name ) ) {
                        return call_user_func( $this->fileFromRowFactory, $row, $this );
                } elseif ( isset( $row->oi_name ) ) {
                        return call_user_func( $this->oldFileFromRowFactory, $row, $this );
                } else {
                        throw new MWException( __METHOD__.': invalid row' );
                }
        }

        function newFromArchiveName( $title, $archiveName ) {
                return OldLocalFile::newFromArchiveName( $title, $this, $archiveName );
        }

        function cleanupDeletedBatch( array $storageKeys ) {
                $backend = $this->backend; // convenience
                $root = $this->getZonePath( 'deleted' );
                $dbw = $this->getMasterDB();
                $status = $this->newGood();
                $storageKeys = array_unique( $storageKeys );
                foreach ( $storageKeys as $key ) {
                        $hashPath = $this->getDeletedHashPath( $key );
                        $path = "$root/$hashPath$key";
                        $dbw->begin( __METHOD__ );
                        // Check for usage in deleted/hidden files and pre-emptively
                        // lock the key to avoid any future use until we are finished.
                        $deleted = $this->deletedFileHasKey( $key, 'lock' );
                        $hidden = $this->hiddenFileHasKey( $key, 'lock' );
                        if ( !$deleted && !$hidden ) { // not in use now
                                wfDebug( __METHOD__ . ": deleting $key\n" );
                                $op = array( 'op' => 'delete', 'src' => $path );
                                if ( !$backend->doOperation( $op )->isOK() ) {
                                        $status->error( 'undelete-cleanup-error', $path );
                                        $status->failCount++;
                                }
                        } else {
                                wfDebug( __METHOD__ . ": $key still in use\n" );
                                $status->successCount++;
                        }
                        $dbw->commit( __METHOD__ );
                }
                return $status;
        }

        protected function deletedFileHasKey( $key, $lock = null ) {
                $options = ( $lock === 'lock' ) ? array( 'FOR UPDATE' ) : array();

                $dbw = $this->getMasterDB();
                return (bool)$dbw->selectField( 'filearchive', '1',
                        array( 'fa_storage_group' => 'deleted', 'fa_storage_key' => $key ),
                        __METHOD__, $options
                );
        }

        protected function hiddenFileHasKey( $key, $lock = null ) {
                $options = ( $lock === 'lock' ) ? array( 'FOR UPDATE' ) : array();

                $sha1 = self::getHashFromKey( $key );
                $ext = File::normalizeExtension( substr( $key, strcspn( $key, '.' ) + 1 ) );

                $dbw = $this->getMasterDB();
                return (bool)$dbw->selectField( 'oldimage', '1',
                        array( 'oi_sha1' => $sha1,
                                'oi_archive_name ' . $dbw->buildLike( $dbw->anyString(), ".$ext" ),
                                $dbw->bitAnd( 'oi_deleted', File::DELETED_FILE ) => File::DELETED_FILE ),
                        __METHOD__, $options
                );
        }

        public static function getHashFromKey( $key ) {
                return strtok( $key, '.' );
        }

        function checkRedirect( Title $title ) {
                global $wgMemc;

                $title = File::normalizeTitle( $title, 'exception' );

                $memcKey = $this->getSharedCacheKey( 'image_redirect', md5( $title->getDBkey() ) );
                if ( $memcKey === false ) {
                        $memcKey = $this->getLocalCacheKey( 'image_redirect', md5( $title->getDBkey() ) );
                        $expiry = 300; // no invalidation, 5 minutes
                } else {
                        $expiry = 86400; // has invalidation, 1 day
                }
                $cachedValue = $wgMemc->get( $memcKey );
                if ( $cachedValue === ' '  || $cachedValue === '' ) {
                        // Does not exist
                        return false;
                } elseif ( strval( $cachedValue ) !== '' ) {
                        return Title::newFromText( $cachedValue, NS_FILE );
                } // else $cachedValue is false or null: cache miss

                $id = $this->getArticleID( $title );
                if( !$id ) {
                        $wgMemc->set( $memcKey, " ", $expiry );
                        return false;
                }
                $dbr = $this->getSlaveDB();
                $row = $dbr->selectRow(
                        'redirect',
                        array( 'rd_title', 'rd_namespace' ),
                        array( 'rd_from' => $id ),
                        __METHOD__
                );

                if( $row && $row->rd_namespace == NS_FILE ) {
                        $targetTitle = Title::makeTitle( $row->rd_namespace, $row->rd_title );
                        $wgMemc->set( $memcKey, $targetTitle->getDBkey(), $expiry );
                        return $targetTitle;
                } else {
                        $wgMemc->set( $memcKey, '', $expiry );
                        return false;
                }
        }

        protected function getArticleID( $title ) {
                if( !$title instanceof Title ) {
                        return 0;
                }
                $dbr = $this->getSlaveDB();
                $id = $dbr->selectField(
                        'page', // Table
                        'page_id',  //Field
                        array(  //Conditions
                                'page_namespace' => $title->getNamespace(),
                                'page_title' => $title->getDBkey(),
                        ),
                        __METHOD__  //Function name
                );
                return $id;
        }

        function findBySha1( $hash ) {
                $dbr = $this->getSlaveDB();
                $res = $dbr->select(
                        'image',
                        LocalFile::selectFields(),
                        array( 'img_sha1' => $hash ),
                        __METHOD__,
                        array( 'ORDER BY' => 'img_name' )
                );
                
                $result = array();
                foreach ( $res as $row ) {
                        $result[] = $this->newFileFromRow( $row );
                }
                $res->free();

                return $result;
        }

        function findBySha1s( array $hashes ) {
                if( !count( $hashes ) ) {
                        return array(); //empty parameter
                }

                $dbr = $this->getSlaveDB();
                $res = $dbr->select(
                        'image',
                        LocalFile::selectFields(),
                        array( 'img_sha1' => $hashes ),
                        __METHOD__,
                        array( 'ORDER BY' => 'img_name' )
                );

                $result = array();
                foreach ( $res as $row ) {
                        $file = $this->newFileFromRow( $row );
                        $result[$file->getSha1()][] = $file;
                }
                $res->free();

                return $result;
        }

        function getSlaveDB() {
                return wfGetDB( DB_SLAVE );
        }

        function getMasterDB() {
                return wfGetDB( DB_MASTER );
        }

        function getSharedCacheKey( /*...*/ ) {
                $args = func_get_args();
                return call_user_func_array( 'wfMemcKey', $args );
        }

        function invalidateImageRedirect( Title $title ) {
                global $wgMemc;
                $memcKey = $this->getSharedCacheKey( 'image_redirect', md5( $title->getDBkey() ) );
                if ( $memcKey ) {
                        $wgMemc->delete( $memcKey );
                }
        }
}