Merge "Make sure all functions in Database.php are documented"
[lhc/web/wiklou.git] / maintenance / refreshFileHeaders.php
1 <?php
2 /**
3 * Refresh file headers from metadata.
4 *
5 * Usage: php refreshFileHeaders.php
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20 * http://www.gnu.org/copyleft/gpl.html
21 *
22 * @file
23 * @author Aaron Schulz
24 * @ingroup Maintenance
25 */
26
27 require_once __DIR__ . '/Maintenance.php';
28
29 /**
30 * Maintenance script to refresh file headers from metadata
31 *
32 * @ingroup Maintenance
33 */
34 class RefreshFileHeaders extends Maintenance {
35 function __construct() {
36 parent::__construct();
37 $this->addDescription( 'Script to update file HTTP headers' );
38 $this->addOption( 'verbose', 'Output information about each file.', false, false, 'v' );
39 $this->addOption( 'start', 'Name of file to start with', false, true );
40 $this->addOption( 'end', 'Name of file to end with', false, true );
41 $this->setBatchSize( 200 );
42 }
43
44 public function execute() {
45 $repo = RepoGroup::singleton()->getLocalRepo();
46 $start = str_replace( ' ', '_', $this->getOption( 'start', '' ) ); // page on img_name
47 $end = str_replace( ' ', '_', $this->getOption( 'end', '' ) ); // page on img_name
48
49 $count = 0;
50 $dbr = $this->getDB( DB_REPLICA );
51 do {
52 $conds = [ "img_name > {$dbr->addQuotes( $start )}" ];
53 if ( strlen( $end ) ) {
54 $conds[] = "img_name <= {$dbr->addQuotes( $end )}";
55 }
56 $res = $dbr->select( 'image', '*', $conds,
57 __METHOD__, [ 'LIMIT' => $this->mBatchSize, 'ORDER BY' => 'img_name ASC' ] );
58
59 if ( $res->numRows() > 0 ) {
60 $row1 = $res->current();
61 $this->output( "Processing next {$res->numRows()} row(s) starting with {$row1->img_name}.\n" );
62 $res->rewind();
63 }
64
65 foreach ( $res as $row ) {
66 $file = $repo->newFileFromRow( $row );
67 $headers = $file->getContentHeaders();
68 if ( count( $headers ) ) {
69 $this->updateFileHeaders( $file, $headers );
70 }
71 // Do all of the older file versions...
72 foreach ( $file->getHistory() as $oldFile ) {
73 $headers = $oldFile->getContentHeaders();
74 if ( count( $headers ) ) {
75 $this->updateFileHeaders( $oldFile, $headers );
76 }
77 }
78 if ( $this->hasOption( 'verbose' ) ) {
79 $this->output( "Updated headers for file '{$row->img_name}'.\n" );
80 }
81 ++$count;
82 $start = $row->img_name; // advance
83 }
84 } while ( $res->numRows() === $this->mBatchSize );
85
86 $this->output( "Done. Updated headers for $count file(s).\n" );
87 }
88
89 protected function updateFileHeaders( File $file, array $headers ) {
90 $status = $file->getRepo()->getBackend()->describe( [
91 'src' => $file->getPath(), 'headers' => $headers
92 ] );
93 if ( !$status->isGood() ) {
94 $this->error( "Encountered error: " . print_r( $status, true ) );
95 }
96 }
97 }
98
99 $maintClass = 'RefreshFileHeaders';
100 require_once RUN_MAINTENANCE_IF_MAIN;