MediaWiki REL1_32
purgeParserCache.php
Go to the documentation of this file.
1<?php
25require __DIR__ . '/Maintenance.php';
26
28
36
37 private $usleep = 0;
38
39 function __construct() {
40 parent::__construct();
41 $this->addDescription( "Remove old objects from the parser cache. " .
42 "This only works when the parser cache is in an SQL database." );
43 $this->addOption( 'expiredate', 'Delete objects expiring before this date.', false, true );
44 $this->addOption(
45 'age',
46 'Delete objects created more than this many seconds ago, assuming ' .
47 '$wgParserCacheExpireTime has remained consistent.',
48 false,
49 true );
50 $this->addOption( 'msleep', 'Milliseconds to sleep between purge chunks', false, true );
51 }
52
53 function execute() {
55
56 $inputDate = $this->getOption( 'expiredate' );
57 $inputAge = $this->getOption( 'age' );
58 if ( $inputDate !== null ) {
59 $date = wfTimestamp( TS_MW, strtotime( $inputDate ) );
60 } elseif ( $inputAge !== null ) {
61 $date = wfTimestamp( TS_MW, time() + $wgParserCacheExpireTime - intval( $inputAge ) );
62 } else {
63 $this->fatalError( "Must specify either --expiredate or --age" );
64 return;
65 }
66 $this->usleep = 1e3 * $this->getOption( 'msleep', 0 );
67
68 $english = Language::factory( 'en' );
69 $this->output( "Deleting objects expiring before " .
70 $english->timeanddate( $date ) . "\n" );
71
72 $pc = MediaWikiServices::getInstance()->getParserCache()->getCacheStorage();
73 $success = $pc->deleteObjectsExpiringBefore( $date, [ $this, 'showProgressAndWait' ] );
74 if ( !$success ) {
75 $this->fatalError( "\nCannot purge this kind of parser cache." );
76 }
77 $this->showProgressAndWait( 100 );
78 $this->output( "\nDone\n" );
79 }
80
81 public function showProgressAndWait( $percent ) {
82 usleep( $this->usleep ); // avoid lag; T150124
83
84 $percentString = sprintf( "%.2f", $percent );
85 if ( $percentString === $this->lastProgress ) {
86 return;
87 }
88 $this->lastProgress = $percentString;
89
90 $stars = floor( $percent / 2 );
91 $this->output( '[' . str_repeat( '*', $stars ) . str_repeat( '.', 50 - $stars ) . '] ' .
92 "$percentString%\r" );
93 }
94}
95
96$maintClass = PurgeParserCache::class;
97require_once RUN_MAINTENANCE_IF_MAIN;
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
$wgParserCacheExpireTime
The expiry time for the parser cache, in seconds.
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
output( $out, $channel=null)
Throw some output to the user.
addDescription( $text)
Set the description text.
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
getOption( $name, $default=null)
Get an option, or return the default.
fatalError( $msg, $exitCode=1)
Output a message and terminate the current script.
MediaWikiServices is the service locator for the application scope of MediaWiki.
Maintenance script to remove old objects from the parser cache.
execute()
Do the actual work.
__construct()
Default constructor.
showProgressAndWait( $percent)
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:37
require_once RUN_MAINTENANCE_IF_MAIN