summaryrefslogtreecommitdiff
path: root/maintenance/purgeList.php
blob: 85a7aae2b9cda45d7f058f99fcf35dc3a71d876e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
<?php
/**
 * Send purge requests for listed pages to squid
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @ingroup Maintenance
 */

require_once( dirname( __FILE__ ) . '/Maintenance.php' );

class PurgeList extends Maintenance {
	public function __construct() {
		parent::__construct();
		$this->mDescription = "Send purge requests for listed pages to squid";
		$this->addOption( 'purge', 'Whether to update page_touched.' , false, false );
		$this->addOption( 'namespace', 'Namespace number', false, true );
		$this->setBatchSize( 100 );
	}

	public function execute() {
		if( $this->hasOption( 'namespace' ) ) {
			$this->purgeNamespace();
		} else {
			$this->purgeList();
		}
		$this->output( "Done!\n" );
	}

	/** Purge URL coming from stdin */
	private function purgeList() {
		$stdin = $this->getStdin();
		$urls = array();

		while ( !feof( $stdin ) ) {
			$page = trim( fgets( $stdin ) );
			if ( substr( $page, 0, 7 ) == 'http://' ) {
				$urls[] = $page;
			} elseif ( $page !== '' ) {
				$title = Title::newFromText( $page );
				if ( $title ) {
					$url = $title->getInternalUrl();
					$this->output( "$url\n" );
					$urls[] = $url;
					if ( $this->getOption( 'purge' ) ) {
						$title->invalidateCache();
					}
				} else {
					$this->output( "(Invalid title '$page')\n" );
				}
			}
		}
		$this->sendPurgeRequest( $urls );
	}

	/** Purge a namespace given by --namespace */
	private function purgeNamespace() {
		$dbr = wfGetDB( DB_SLAVE );
		$ns = $dbr->addQuotes( $this->getOption( 'namespace') );

		$result = $dbr->select(
			array( 'page' ),
			array( 'page_namespace', 'page_title' ),
			array( "page_namespace = $ns" ),
			__METHOD__,
			array( 'ORDER BY' => 'page_id' )
		);

		$start   = 0;
		$end = $dbr->numRows( $result );
		$this->output( "Will purge $end pages from namespace $ns\n" );

		# Do remaining chunk
		$end += $this->mBatchSize - 1;
		$blockStart = $start;
		$blockEnd = $start + $this->mBatchSize - 1;

		while( $blockEnd <= $end ) {
			# Select pages we will purge:
			$result = $dbr->select(
				array( 'page' ),
				array( 'page_namespace', 'page_title' ),
				array( "page_namespace = $ns" ),
				__METHOD__,
				array( # conditions
					'ORDER BY' => 'page_id',
					'LIMIT'    => $this->mBatchSize,
					'OFFSET'   => $blockStart,
				)
			);
			# Initialize/reset URLs to be purged
			$urls = array();
			foreach( $result as $row ) {
				$title = Title::makeTitle( $row->page_namespace, $row->page_title );
				$url = $title->getInternalUrl();
				$urls[] = $url;
			}

			$this->sendPurgeRequest( $urls );

			$blockStart += $this->mBatchSize;
			$blockEnd   += $this->mBatchSize;
		}
	}

	/**
	 * Helper to purge an array of $urls
	 * @param $urls array List of URLS to purge from squids
	 */
	private function sendPurgeRequest( $urls ) {
		$this->output( "Purging " . count( $urls ). " urls\n" );
		$u = new SquidUpdate( $urls );
		$u->doUpdate();
	}

}

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