MediaWiki  1.23.2
pruneFileCache.php
Go to the documentation of this file.
1 <?php
24 require_once __DIR__ . '/Maintenance.php';
25 
31 class PruneFileCache extends Maintenance {
32 
34 
35  public function __construct() {
36  parent::__construct();
37  $this->mDescription = "Build file cache for content pages";
38  $this->addOption( 'agedays', 'How many days old files must be in order to delete', true, true );
39  $this->addOption( 'subdir', 'Prune one $wgFileCacheDirectory subdirectory name', false, true );
40  }
41 
42  public function execute() {
43  global $wgUseFileCache, $wgFileCacheDirectory;
44 
45  if ( !$wgUseFileCache ) {
46  $this->error( "Nothing to do -- \$wgUseFileCache is disabled.", true );
47  }
48 
49  $age = $this->getOption( 'agedays' );
50  if ( !ctype_digit( $age ) ) {
51  $this->error( "Non-integer 'age' parameter given.", true );
52  }
53  // Delete items with a TS older than this
54  $this->minSurviveTimestamp = time() - ( 86400 * $age );
55 
56  $dir = $wgFileCacheDirectory;
57  if ( !is_dir( $dir ) ) {
58  $this->error( "Nothing to do -- \$wgFileCacheDirectory directory not found.", true );
59  }
60 
61  $subDir = $this->getOption( 'subdir' );
62  if ( $subDir !== null ) {
63  if ( !is_dir( "$dir/$subDir" ) ) {
64  $this->error( "The specified subdirectory `$subDir` does not exist.", true );
65  }
66  $this->output( "Pruning `$dir/$subDir` directory...\n" );
67  $this->prune_directory( "$dir/$subDir", 'report' );
68  $this->output( "Done pruning `$dir/$subDir` directory\n" );
69  } else {
70  $this->output( "Pruning `$dir` directory...\n" );
71  // Note: don't prune things like .cdb files on the top level!
72  $this->prune_directory( $dir, 'report' );
73  $this->output( "Done pruning `$dir` directory\n" );
74  }
75  }
76 
81  protected function prune_directory( $dir, $report = false ) {
82  $tsNow = time();
83  $dirHandle = opendir( $dir );
84  while ( false !== ( $file = readdir( $dirHandle ) ) ) {
85  // Skip ".", "..", and also any dirs or files like ".svn" or ".htaccess"
86  if ( $file[0] != "." ) {
87  $path = $dir . '/' . $file; // absolute
88  if ( is_dir( $path ) ) {
89  if ( $report === 'report' ) {
90  $this->output( "Scanning `$path`...\n" );
91  }
92  $this->prune_directory( $path );
93  } else {
94  $mts = filemtime( $path );
95  // Sanity check the file extension against known cache types
96  if ( $mts < $this->minSurviveTimestamp
97  && preg_match( '/\.(?:html|cache)(?:\.gz)?$/', $file )
98  && unlink( $path )
99  ) {
100  $daysOld = round( ( $tsNow - $mts ) / 86400, 2 );
101  $this->output( "Deleted `$path` [days=$daysOld]\n" );
102  }
103  }
104  }
105  }
106  closedir( $dirHandle );
107  }
108 }
109 
110 $maintClass = "PruneFileCache";
111 require_once RUN_MAINTENANCE_IF_MAIN;
php
skin txt MediaWiki includes four core it has been set as the default in MediaWiki since the replacing Monobook it had been been the default skin since before being replaced by Vector largely rewritten in while keeping its appearance Several legacy skins were removed in the as the burden of supporting them became too heavy to bear Those in etc for skin dependent CSS etc for skin dependent JavaScript These can also be customised on a per user by etc This feature has led to a wide variety of user styles becoming that gallery is a good place to ending in php
Definition: skin.txt:62
PruneFileCache\prune_directory
prune_directory( $dir, $report=false)
Definition: pruneFileCache.php:81
Maintenance\addOption
addOption( $name, $description, $required=false, $withArg=false, $shortName=false)
Add a parameter to the script.
Definition: Maintenance.php:169
RUN_MAINTENANCE_IF_MAIN
require_once RUN_MAINTENANCE_IF_MAIN
Definition: maintenance.txt:50
Maintenance
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: maintenance.txt:39
PruneFileCache\execute
execute()
Do the actual work.
Definition: pruneFileCache.php:42
PruneFileCache\$minSurviveTimestamp
$minSurviveTimestamp
Definition: pruneFileCache.php:33
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
$maintClass
$maintClass
Definition: pruneFileCache.php:110
$file
if(PHP_SAPI !='cli') $file
Definition: UtfNormalTest2.php:30
PruneFileCache\__construct
__construct()
Default constructor.
Definition: pruneFileCache.php:35
Maintenance\getOption
getOption( $name, $default=null)
Get an option, or return the default.
Definition: Maintenance.php:191
$dir
if(count( $args)==0) $dir
Definition: importImages.php:49
$path
$path
Definition: NoLocalSettings.php:35
Maintenance\error
error( $err, $die=0)
Throw an error to the user.
Definition: Maintenance.php:333
Maintenance\output
output( $out, $channel=null)
Throw some output to the user.
Definition: Maintenance.php:314
PruneFileCache
Maintenance script that prunes file cache for pages, objects, resources, etc.
Definition: pruneFileCache.php:31