MediaWiki REL1_30
purgeList.php
Go to the documentation of this file.
1<?php
24require_once __DIR__ . '/Maintenance.php';
25
31class PurgeList extends Maintenance {
32 public function __construct() {
33 parent::__construct();
34 $this->addDescription( 'Send purge requests for listed pages to squid' );
35 $this->addOption( 'purge', 'Whether to update page_touched.', false, false );
36 $this->addOption( 'namespace', 'Namespace number', false, true );
37 $this->addOption( 'all', 'Purge all pages', false, false );
38 $this->addOption( 'delay', 'Number of seconds to delay between each purge', false, true );
39 $this->addOption( 'verbose', 'Show more output', false, false, 'v' );
40 $this->setBatchSize( 100 );
41 }
42
43 public function execute() {
44 if ( $this->hasOption( 'all' ) ) {
45 $this->purgeNamespace( false );
46 } elseif ( $this->hasOption( 'namespace' ) ) {
47 $this->purgeNamespace( intval( $this->getOption( 'namespace' ) ) );
48 } else {
49 $this->doPurge();
50 }
51 $this->output( "Done!\n" );
52 }
53
57 private function doPurge() {
58 $stdin = $this->getStdin();
59 $urls = [];
60
61 while ( !feof( $stdin ) ) {
62 $page = trim( fgets( $stdin ) );
63 if ( preg_match( '%^https?://%', $page ) ) {
64 $urls[] = $page;
65 } elseif ( $page !== '' ) {
66 $title = Title::newFromText( $page );
67 if ( $title ) {
68 $url = $title->getInternalURL();
69 $this->output( "$url\n" );
70 $urls[] = $url;
71 if ( $this->getOption( 'purge' ) ) {
72 $title->invalidateCache();
73 }
74 } else {
75 $this->output( "(Invalid title '$page')\n" );
76 }
77 }
78 }
79 $this->output( "Purging " . count( $urls ) . " urls\n" );
80 $this->sendPurgeRequest( $urls );
81 }
82
88 private function purgeNamespace( $namespace = false ) {
89 $dbr = $this->getDB( DB_REPLICA );
90 $startId = 0;
91 if ( $namespace === false ) {
92 $conds = [];
93 } else {
94 $conds = [ 'page_namespace' => $namespace ];
95 }
96 while ( true ) {
97 $res = $dbr->select( 'page',
98 [ 'page_id', 'page_namespace', 'page_title' ],
99 $conds + [ 'page_id > ' . $dbr->addQuotes( $startId ) ],
100 __METHOD__,
101 [
102 'LIMIT' => $this->mBatchSize,
103 'ORDER BY' => 'page_id'
104
105 ]
106 );
107 if ( !$res->numRows() ) {
108 break;
109 }
110 $urls = [];
111 foreach ( $res as $row ) {
112 $title = Title::makeTitle( $row->page_namespace, $row->page_title );
113 $url = $title->getInternalURL();
114 $urls[] = $url;
115 $startId = $row->page_id;
116 }
117 $this->sendPurgeRequest( $urls );
118 }
119 }
120
125 private function sendPurgeRequest( $urls ) {
126 if ( $this->hasOption( 'delay' ) ) {
127 $delay = floatval( $this->getOption( 'delay' ) );
128 foreach ( $urls as $url ) {
129 if ( $this->hasOption( 'verbose' ) ) {
130 $this->output( $url . "\n" );
131 }
132 $u = new CdnCacheUpdate( [ $url ] );
133 $u->doUpdate();
134 usleep( $delay * 1e6 );
135 }
136 } else {
137 if ( $this->hasOption( 'verbose' ) ) {
138 $this->output( implode( "\n", $urls ) . "\n" );
139 }
140 $u = new CdnCacheUpdate( $urls );
141 $u->doUpdate();
142 }
143 }
144}
145
146$maintClass = "PurgeList";
147require_once RUN_MAINTENANCE_IF_MAIN;
Handles purging appropriate CDN URLs given a title (or titles)
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
getStdin( $len=null)
Return input from stdin.
getDB( $db, $groups=[], $wiki=false)
Returns a database to be used by current maintenance script.
hasOption( $name)
Checks to see if a particular param exists.
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.
setBatchSize( $s=0)
Set the batch size.
Maintenance script that sends purge requests for listed pages to squid.
Definition purgeList.php:31
execute()
Do the actual work.
Definition purgeList.php:43
__construct()
Default constructor.
Definition purgeList.php:32
sendPurgeRequest( $urls)
Helper to purge an array of $urls.
purgeNamespace( $namespace=false)
Purge a namespace or all pages.
Definition purgeList.php:88
doPurge()
Purge URL coming from stdin.
Definition purgeList.php:57
if(! $regexes) $dbr
Definition cleanup.php:94
$res
Definition database.txt:21
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any and then calling output() to send it all. It could be easily changed to send incrementally if that becomes useful
require_once RUN_MAINTENANCE_IF_MAIN
$maintClass
const DB_REPLICA
Definition defines.php:25