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  * @ingroup Maintenance
  24  */
  25
  26 require_once __DIR__ . '/Maintenance.php';
  27
  28 /**
  29  * Maintenance script to refresh file headers from metadata
  30  *
  31  * @ingroup Maintenance
  32  */
  33 class RefreshFileHeaders extends Maintenance {
  34         function __construct() {
  35                 parent::__construct();
  36                 $this->addDescription( 'Script to update file HTTP headers' );
  37                 $this->addOption( 'verbose', 'Output information about each file.', false, false, 'v' );
  38                 $this->addOption( 'start', 'Name of file to start with', false, true );
  39                 $this->addOption( 'end', 'Name of file to end with', false, true );
  40                 $this->addOption( 'media_type', 'Media type to filter for', false, true );
  41                 $this->addOption( 'major_mime', 'Major mime type to filter for', false, true );
  42                 $this->addOption( 'minor_mime', 'Minor mime type to filter for', false, true );
  43                 $this->addOption(
  44                         'refreshContentType',
  45                         'Set true to refresh file content type from mime data in db',
  46                         false,
  47                         false
  48                 );
  49                 $this->setBatchSize( 200 );
  50         }
  51
  52         public function execute() {
  53                 $repo = RepoGroup::singleton()->getLocalRepo();
  54                 $start = str_replace( ' ', '_', $this->getOption( 'start', '' ) ); // page on img_name
  55                 $end = str_replace( ' ', '_', $this->getOption( 'end', '' ) ); // page on img_name
  56                  // filter by img_media_type
  57                 $media_type = str_replace( ' ', '_', $this->getOption( 'media_type', '' ) );
  58                  // filter by img_major_mime
  59                 $major_mime = str_replace( ' ', '_', $this->getOption( 'major_mime', '' ) );
  60                  // filter by img_minor_mime
  61                 $minor_mime = str_replace( ' ', '_', $this->getOption( 'minor_mime', '' ) );
  62
  63                 $count = 0;
  64                 $dbr = $this->getDB( DB_REPLICA );
  65
  66                 $fileQuery = LocalFile::getQueryInfo();
  67
  68                 do {
  69                         $conds = [ "img_name > {$dbr->addQuotes( $start )}" ];
  70
  71                         if ( strlen( $end ) ) {
  72                                 $conds[] = "img_name <= {$dbr->addQuotes( $end )}";
  73                         }
  74
  75                         if ( strlen( $media_type ) ) {
  76                                 $conds[] = "img_media_type = {$dbr->addQuotes( $media_type )}";
  77                         }
  78
  79                         if ( strlen( $major_mime ) ) {
  80                                 $conds[] = "img_major_mime = {$dbr->addQuotes( $major_mime )}";
  81                         }
  82
  83                         if ( strlen( $minor_mime ) ) {
  84                                 $conds[] = "img_minor_mime = {$dbr->addQuotes( $minor_mime )}";
  85                         }
  86
  87                         $res = $dbr->select( $fileQuery['tables'],
  88                                 $fileQuery['fields'],
  89                                 $conds,
  90                                 __METHOD__,
  91                                 [
  92                                         'LIMIT' => $this->getBatchSize(),
  93                                         'ORDER BY' => 'img_name ASC'
  94                                 ],
  95                                 $fileQuery['joins']
  96                         );
  97
  98                         if ( $res->numRows() > 0 ) {
  99                                 $row1 = $res->current();
 100                                 $this->output( "Processing next {$res->numRows()} row(s) starting with {$row1->img_name}.\n" );
 101                                 $res->rewind();
 102                         }
 103
 104                         $backendOperations = [];
 105
 106                         foreach ( $res as $row ) {
 107                                 $file = $repo->newFileFromRow( $row );
 108                                 $headers = $file->getContentHeaders();
 109                                 if ( $this->getOption( 'refreshContentType', false ) ) {
 110                                         $headers['Content-Type'] = $row->img_major_mime . '/' . $row->img_minor_mime;
 111                                 }
 112
 113                                 if ( count( $headers ) ) {
 114                                         $backendOperations[] = [
 115                                                 'op' => 'describe', 'src' => $file->getPath(), 'headers' => $headers
 116                                         ];
 117                                 }
 118
 119                                 // Do all of the older file versions...
 120                                 foreach ( $file->getHistory() as $oldFile ) {
 121                                         $headers = $oldFile->getContentHeaders();
 122                                         if ( count( $headers ) ) {
 123                                                 $backendOperations[] = [
 124                                                         'op' => 'describe', 'src' => $oldFile->getPath(), 'headers' => $headers
 125                                                 ];
 126                                         }
 127                                 }
 128
 129                                 if ( $this->hasOption( 'verbose' ) ) {
 130                                         $this->output( "Queued headers update for file '{$row->img_name}'.\n" );
 131                                 }
 132
 133                                 $start = $row->img_name; // advance
 134                         }
 135
 136                         $backendOperationsCount = count( $backendOperations );
 137                         $count += $backendOperationsCount;
 138
 139                         $this->output( "Updating headers for {$backendOperationsCount} file(s).\n" );
 140                         $this->updateFileHeaders( $repo, $backendOperations );
 141                 } while ( $res->numRows() === $this->getBatchSize() );
 142
 143                 $this->output( "Done. Updated headers for $count file(s).\n" );
 144         }
 145
 146         /**
 147          * @param LocalRepo $repo
 148          * @param array $backendOperations
 149          */
 150         protected function updateFileHeaders( $repo, $backendOperations ) {
 151                 $status = $repo->getBackend()->doQuickOperations( $backendOperations );
 152
 153                 if ( !$status->isGood() ) {
 154                         $this->error( "Encountered error: " . print_r( $status, true ) );
 155                 }
 156         }
 157 }
 158
 159 $maintClass = RefreshFileHeaders::class;
 160 require_once RUN_MAINTENANCE_IF_MAIN;