MediaWiki  1.28.0
cleanupUploadStash.php
Go to the documentation of this file.
1 <?php
28 require_once __DIR__ . '/Maintenance.php';
29 
37 
38  public function __construct() {
39  parent::__construct();
40  $this->addDescription( 'Clean up abandoned files in temporary uploaded file stash' );
41  $this->setBatchSize( 50 );
42  }
43 
44  public function execute() {
46 
47  $repo = RepoGroup::singleton()->getLocalRepo();
48  $tempRepo = $repo->getTempRepo();
49 
50  $dbr = $repo->getSlaveDB();
51 
52  // how far back should this look for files to delete?
53  $cutoff = time() - $wgUploadStashMaxAge;
54 
55  $this->output( "Getting list of files to clean up...\n" );
56  $res = $dbr->select(
57  'uploadstash',
58  'us_key',
59  'us_timestamp < ' . $dbr->addQuotes( $dbr->timestamp( $cutoff ) ),
60  __METHOD__
61  );
62 
63  // Delete all registered stash files...
64  if ( $res->numRows() == 0 ) {
65  $this->output( "No stashed files to cleanup according to the DB.\n" );
66  } else {
67  // finish the read before starting writes.
68  $keys = [];
69  foreach ( $res as $row ) {
70  array_push( $keys, $row->us_key );
71  }
72 
73  $this->output( 'Removing ' . count( $keys ) . " file(s)...\n" );
74  // this could be done some other, more direct/efficient way, but using
75  // UploadStash's own methods means it's less likely to fall accidentally
76  // out-of-date someday
77  $stash = new UploadStash( $repo );
78 
79  $i = 0;
80  foreach ( $keys as $key ) {
81  $i++;
82  try {
83  $stash->getFile( $key, true );
84  $stash->removeFileNoAuth( $key );
85  } catch ( UploadStashException $ex ) {
86  $type = get_class( $ex );
87  $this->output( "Failed removing stashed upload with key: $key ($type)\n" );
88  }
89  if ( $i % 100 == 0 ) {
91  $this->output( "$i\n" );
92  }
93  }
94  $this->output( "$i done\n" );
95  }
96 
97  // Delete all the corresponding thumbnails...
98  $dir = $tempRepo->getZonePath( 'thumb' );
99  $iterator = $tempRepo->getBackend()->getFileList( [ 'dir' => $dir, 'adviseStat' => 1 ] );
100  $this->output( "Deleting old thumbnails...\n" );
101  $i = 0;
102  $batch = []; // operation batch
103  foreach ( $iterator as $file ) {
104  if ( wfTimestamp( TS_UNIX, $tempRepo->getFileTimestamp( "$dir/$file" ) ) < $cutoff ) {
105  $batch[] = [ 'op' => 'delete', 'src' => "$dir/$file" ];
106  if ( count( $batch ) >= $this->mBatchSize ) {
107  $this->doOperations( $tempRepo, $batch );
108  $i += count( $batch );
109  $batch = [];
110  $this->output( "$i\n" );
111  }
112  }
113  }
114  if ( count( $batch ) ) {
115  $this->doOperations( $tempRepo, $batch );
116  $i += count( $batch );
117  }
118  $this->output( "$i done\n" );
119 
120  // Apparently lots of stash files are not registered in the DB...
121  $dir = $tempRepo->getZonePath( 'public' );
122  $iterator = $tempRepo->getBackend()->getFileList( [ 'dir' => $dir, 'adviseStat' => 1 ] );
123  $this->output( "Deleting orphaned temp files...\n" );
124  if ( strpos( $dir, '/local-temp' ) === false ) { // sanity check
125  $this->error( "Temp repo is not using the temp container.", 1 ); // die
126  }
127  $i = 0;
128  $batch = []; // operation batch
129  foreach ( $iterator as $file ) {
130  if ( wfTimestamp( TS_UNIX, $tempRepo->getFileTimestamp( "$dir/$file" ) ) < $cutoff ) {
131  $batch[] = [ 'op' => 'delete', 'src' => "$dir/$file" ];
132  if ( count( $batch ) >= $this->mBatchSize ) {
133  $this->doOperations( $tempRepo, $batch );
134  $i += count( $batch );
135  $batch = [];
136  $this->output( "$i\n" );
137  }
138  }
139  }
140  if ( count( $batch ) ) {
141  $this->doOperations( $tempRepo, $batch );
142  $i += count( $batch );
143  }
144  $this->output( "$i done\n" );
145  }
146 
147  protected function doOperations( FileRepo $tempRepo, array $ops ) {
148  $status = $tempRepo->getBackend()->doQuickOperations( $ops );
149  if ( !$status->isOK() ) {
150  $this->error( print_r( $status->getErrorsArray(), true ) );
151  }
152  }
153 }
154 
155 $maintClass = "UploadStashCleanup";
156 require_once RUN_MAINTENANCE_IF_MAIN;
the array() calling protocol came about after MediaWiki 1.4rc1.
wfWaitForSlaves($ifWritesSince=null, $wiki=false, $cluster=false, $timeout=null)
Waits for the replica DBs to catch up to the master position.
$wgUploadStashMaxAge
The maximum age of temporary (incomplete) uploaded files.
doOperations(FileRepo $tempRepo, array $ops)
if(count($args)==0) $dir
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: maintenance.txt:39
require_once RUN_MAINTENANCE_IF_MAIN
Definition: maintenance.txt:50
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
getBackend()
Get the file backend instance.
Definition: FileRepo.php:215
const TS_UNIX
Unix time - the number of seconds since 1970-01-01 00:00:00 UTC.
Definition: defines.php:6
$batch
Definition: linkcache.txt:23
wfTimestamp($outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return true
Definition: hooks.txt:1936
$res
Definition: database.txt:21
static singleton()
Get a RepoGroup instance.
Definition: RepoGroup.php:59
Maintenance script to remove old or broken uploads from temporary uploaded file storage and clean up ...
addDescription($text)
Set the description text.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
output($out, $channel=null)
Throw some output to the user.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
UploadStash is intended to accomplish a few things:
Definition: UploadStash.php:54
int $mBatchSize
Batch size.
Definition: Maintenance.php:98
error($err, $die=0)
Throw an error to the user.
Base class for file repositories.
Definition: FileRepo.php:37
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
Definition: hooks.txt:1046
setBatchSize($s=0)
Set the batch size.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
Definition: hooks.txt:2491