cleanupUploadStash.php

Go to the documentation of this file.

<?php
require_once( __DIR__ . '/Maintenance.php' );

class UploadStashCleanup extends Maintenance {

        public function __construct() {
                parent::__construct();
                $this->mDescription = "Clean up abandoned files in temporary uploaded file stash";
        }

        public function execute() {
                global $wgUploadStashMaxAge;

                $repo = RepoGroup::singleton()->getLocalRepo();
                $tempRepo = $repo->getTempRepo();

                $dbr = $repo->getSlaveDb();

                // how far back should this look for files to delete?
                $cutoff = time() - $wgUploadStashMaxAge;

                $this->output( "Getting list of files to clean up...\n" );
                $res = $dbr->select(
                        'uploadstash',
                        'us_key',
                        'us_timestamp < ' . $dbr->addQuotes( $dbr->timestamp( $cutoff ) ),
                        __METHOD__
                );

                // Delete all registered stash files...
                if ( $res->numRows() == 0 ) {
                        $this->output( "No stashed files to cleanup according to the DB.\n" );
                } else {
                        // finish the read before starting writes.
                        $keys = array();
                        foreach( $res as $row ) {
                                array_push( $keys, $row->us_key );
                        }

                        $this->output( 'Removing ' . count( $keys ) . " file(s)...\n" );
                        // this could be done some other, more direct/efficient way, but using
                        // UploadStash's own methods means it's less likely to fall accidentally
                        // out-of-date someday
                        $stash = new UploadStash( $repo );

                        $i = 0;
                        foreach( $keys as $key ) {
                                $i++;
                                try {
                                        $stash->getFile( $key, true );
                                        $stash->removeFileNoAuth( $key );
                                } catch ( UploadStashBadPathException $ex ) {
                                        $this->output( "Failed removing stashed upload with key: $key\n"  );
                                } catch ( UploadStashZeroLengthFileException $ex ) {
                                        $this->output( "Failed removing stashed upload with key: $key\n"  );
                                }
                                if ( $i % 100 == 0 ) {
                                        $this->output( "$i\n" );
                                }
                        }
                        $this->output( "$i done\n" );
                }

                // Delete all the corresponding thumbnails...
                $dir      = $tempRepo->getZonePath( 'thumb' );
                $iterator = $tempRepo->getBackend()->getFileList( array( 'dir' => $dir ) );
                $this->output( "Deleting old thumbnails...\n" );
                $i = 0;
                foreach ( $iterator as $file ) {
                        if ( wfTimestamp( TS_UNIX, $tempRepo->getFileTimestamp( "$dir/$file" ) ) < $cutoff ) {
                                $status = $tempRepo->quickPurge( "$dir/$file" );
                                if ( !$status->isOK() ) {
                                        $this->error( print_r( $status->getErrorsArray(), true ) );
                                }
                                if ( ( ++$i % 100 ) == 0 ) {
                                        $this->output( "$i\n" );
                                }
                        }
                }
                $this->output( "$i done\n" );

                // Apparently lots of stash files are not registered in the DB...
                $dir      = $tempRepo->getZonePath( 'public' );
                $iterator = $tempRepo->getBackend()->getFileList( array( 'dir' => $dir ) );
                $this->output( "Deleting orphaned temp files...\n" );
                if ( strpos( $dir, '/local-temp' ) === false ) { // sanity check
                        $this->error( "Temp repo is not using the temp container.", 1 ); // die
                }
                $i = 0;
                foreach ( $iterator as $file ) {
                        // Absolute sanity check for stashed files and file segments
                        if ( !preg_match( '#(^\d{14}!|\.\d+\.\w+\.\d+$)#', basename( $file ) ) ) {
                                $this->output( "Skipped non-stash $file\n" );
                                continue;
                        }
                        if ( wfTimestamp( TS_UNIX, $tempRepo->getFileTimestamp( "$dir/$file" ) ) < $cutoff ) {
                                $status = $tempRepo->quickPurge( "$dir/$file" );
                                if ( !$status->isOK() ) {
                                        $this->error( print_r( $status->getErrorsArray(), true ) );
                                }
                                if ( ( ++$i % 100 ) == 0 ) {
                                        $this->output( "$i\n" );
                                }
                        }
                }
                $this->output( "$i done\n" );
        }
}

$maintClass = "UploadStashCleanup";
require_once( RUN_MAINTENANCE_IF_MAIN );