MediaWiki  REL1_31
rebuildImages.php
Go to the documentation of this file.
1 <?php
33 require_once __DIR__ . '/Maintenance.php';
34 
36 
42 class ImageBuilder extends Maintenance {
43 
47  protected $dbw;
48 
49  function __construct() {
50  parent::__construct();
51 
53  // make sure to update old, but compatible img_metadata fields.
55 
56  $this->addDescription( 'Script to update image metadata records' );
57 
58  $this->addOption( 'missing', 'Check for files without associated database record' );
59  $this->addOption( 'dry-run', 'Only report, don\'t update the database' );
60  }
61 
62  public function execute() {
63  $this->dbw = $this->getDB( DB_MASTER );
64  $this->dryrun = $this->hasOption( 'dry-run' );
65  if ( $this->dryrun ) {
66  MediaWiki\MediaWikiServices::getInstance()->getReadOnlyMode()
67  ->setReason( 'Dry run mode, image upgrades are suppressed' );
68  }
69 
70  if ( $this->hasOption( 'missing' ) ) {
71  $this->crawlMissing();
72  } else {
73  $this->build();
74  }
75  }
76 
80  function getRepo() {
81  if ( !isset( $this->repo ) ) {
82  $this->repo = RepoGroup::singleton()->getLocalRepo();
83  }
84 
85  return $this->repo;
86  }
87 
88  function build() {
89  $this->buildImage();
90  $this->buildOldImage();
91  }
92 
93  function init( $count, $table ) {
94  $this->processed = 0;
95  $this->updated = 0;
96  $this->count = $count;
97  $this->startTime = microtime( true );
98  $this->table = $table;
99  }
100 
101  function progress( $updated ) {
102  $this->updated += $updated;
103  $this->processed++;
104  if ( $this->processed % 100 != 0 ) {
105  return;
106  }
107  $portion = $this->processed / $this->count;
108  $updateRate = $this->updated / $this->processed;
109 
110  $now = microtime( true );
111  $delta = $now - $this->startTime;
112  $estimatedTotalTime = $delta / $portion;
113  $eta = $this->startTime + $estimatedTotalTime;
114  $rate = $this->processed / $delta;
115 
116  $this->output( sprintf( "%s: %6.2f%% done on %s; ETA %s [%d/%d] %.2f/sec <%.2f%% updated>\n",
117  wfTimestamp( TS_DB, intval( $now ) ),
118  $portion * 100.0,
119  $this->table,
120  wfTimestamp( TS_DB, intval( $eta ) ),
121  $this->processed,
122  $this->count,
123  $rate,
124  $updateRate * 100.0 ) );
125  flush();
126  }
127 
128  function buildTable( $table, $key, $queryInfo, $callback ) {
129  $count = $this->dbw->selectField( $table, 'count(*)', '', __METHOD__ );
130  $this->init( $count, $table );
131  $this->output( "Processing $table...\n" );
132 
133  $result = $this->getDB( DB_REPLICA )->select(
134  $queryInfo['tables'], $queryInfo['fields'], [], __METHOD__, [], $queryInfo['joins']
135  );
136 
137  foreach ( $result as $row ) {
138  $update = call_user_func( $callback, $row, null );
139  if ( $update ) {
140  $this->progress( 1 );
141  } else {
142  $this->progress( 0 );
143  }
144  }
145  $this->output( "Finished $table... $this->updated of $this->processed rows updated\n" );
146  }
147 
148  function buildImage() {
149  $callback = [ $this, 'imageCallback' ];
150  $this->buildTable( 'image', 'img_name', LocalFile::getQueryInfo(), $callback );
151  }
152 
153  function imageCallback( $row, $copy ) {
154  // Create a File object from the row
155  // This will also upgrade it
156  $file = $this->getRepo()->newFileFromRow( $row );
157 
158  return $file->getUpgraded();
159  }
160 
161  function buildOldImage() {
162  $this->buildTable( 'oldimage', 'oi_archive_name', OldLocalFile::getQueryInfo(),
163  [ $this, 'oldimageCallback' ] );
164  }
165 
166  function oldimageCallback( $row, $copy ) {
167  // Create a File object from the row
168  // This will also upgrade it
169  if ( $row->oi_archive_name == '' ) {
170  $this->output( "Empty oi_archive_name for oi_name={$row->oi_name}\n" );
171 
172  return false;
173  }
174  $file = $this->getRepo()->newFileFromRow( $row );
175 
176  return $file->getUpgraded();
177  }
178 
179  function crawlMissing() {
180  $this->getRepo()->enumFiles( [ $this, 'checkMissingImage' ] );
181  }
182 
183  function checkMissingImage( $fullpath ) {
184  $filename = wfBaseName( $fullpath );
185  $row = $this->dbw->selectRow( 'image',
186  [ 'img_name' ],
187  [ 'img_name' => $filename ],
188  __METHOD__ );
189 
190  if ( !$row ) { // file not registered
191  $this->addMissingImage( $filename, $fullpath );
192  }
193  }
194 
195  function addMissingImage( $filename, $fullpath ) {
197 
198  $timestamp = $this->dbw->timestamp( $this->getRepo()->getFileTimestamp( $fullpath ) );
199 
200  $altname = $wgContLang->checkTitleEncoding( $filename );
201  if ( $altname != $filename ) {
202  if ( $this->dryrun ) {
203  $filename = $altname;
204  $this->output( "Estimating transcoding... $altname\n" );
205  } else {
206  # @todo FIXME: create renameFile()
207  $filename = $this->renameFile( $filename );
208  }
209  }
210 
211  if ( $filename == '' ) {
212  $this->output( "Empty filename for $fullpath\n" );
213 
214  return;
215  }
216  if ( !$this->dryrun ) {
217  $file = wfLocalFile( $filename );
218  if ( !$file->recordUpload(
219  '',
220  '(recovered file, missing upload log entry)',
221  '',
222  '',
223  '',
224  false,
225  $timestamp
226  ) ) {
227  $this->output( "Error uploading file $fullpath\n" );
228 
229  return;
230  }
231  }
232  $this->output( $fullpath . "\n" );
233  }
234 }
235 
237 require_once RUN_MAINTENANCE_IF_MAIN;
ImageBuilder\init
init( $count, $table)
Definition: rebuildImages.php:93
$wgUpdateCompatibleMetadata
$wgUpdateCompatibleMetadata
If to automatically update the img_metadata field if the metadata field is outdated but compatible wi...
Definition: DefaultSettings.php:698
ImageBuilder\buildOldImage
buildOldImage()
Definition: rebuildImages.php:161
RepoGroup\singleton
static singleton()
Get a RepoGroup instance.
Definition: RepoGroup.php:59
ImageBuilder\execute
execute()
Do the actual work.
Definition: rebuildImages.php:62
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
OldLocalFile\getQueryInfo
static getQueryInfo(array $options=[])
Return the tables, fields, and join conditions to be selected to create a new oldlocalfile object.
Definition: OldLocalFile.php:157
Maintenance\addDescription
addDescription( $text)
Set the description text.
Definition: Maintenance.php:291
wfTimestamp
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Definition: GlobalFunctions.php:1980
ImageBuilder
Maintenance script to update image metadata records.
Definition: rebuildImages.php:42
$maintClass
$maintClass
Definition: rebuildImages.php:236
wfBaseName
wfBaseName( $path, $suffix='')
Return the final portion of a pathname.
Definition: GlobalFunctions.php:2579
RUN_MAINTENANCE_IF_MAIN
require_once RUN_MAINTENANCE_IF_MAIN
Definition: maintenance.txt:50
ImageBuilder\getRepo
getRepo()
Definition: rebuildImages.php:80
Maintenance
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: maintenance.txt:39
$result
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1993
php
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
table
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global then executing the whole list after the page is displayed We don t do anything smart like collating updates to the same table or such because the list is almost always going to have just one item on if so it s not worth the trouble Since there is a job queue in the jobs table
Definition: deferred.txt:16
ImageBuilder\imageCallback
imageCallback( $row, $copy)
Definition: rebuildImages.php:153
Maintenance\addOption
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
Definition: Maintenance.php:219
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
DB_REPLICA
const DB_REPLICA
Definition: defines.php:25
DB_MASTER
const DB_MASTER
Definition: defines.php:26
MediaWiki\MediaWikiServices\getInstance
static getInstance()
Returns the global default instance of the top level service locator.
Definition: MediaWikiServices.php:109
ImageBuilder\checkMissingImage
checkMissingImage( $fullpath)
Definition: rebuildImages.php:183
ImageBuilder\__construct
__construct()
Default constructor.
Definition: rebuildImages.php:49
ImageBuilder\oldimageCallback
oldimageCallback( $row, $copy)
Definition: rebuildImages.php:166
ImageBuilder\crawlMissing
crawlMissing()
Definition: rebuildImages.php:179
LocalFile\getQueryInfo
static getQueryInfo(array $options=[])
Return the tables, fields, and join conditions to be selected to create a new localfile object.
Definition: LocalFile.php:243
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:22
ImageBuilder\buildTable
buildTable( $table, $key, $queryInfo, $callback)
Definition: rebuildImages.php:128
Maintenance\getDB
getDB( $db, $groups=[], $wiki=false)
Returns a database to be used by current maintenance script.
Definition: Maintenance.php:1309
ImageBuilder\addMissingImage
addMissingImage( $filename, $fullpath)
Definition: rebuildImages.php:195
ImageBuilder\$dbw
IMaintainableDatabase $dbw
Definition: rebuildImages.php:47
Maintenance\output
output( $out, $channel=null)
Throw some output to the user.
Definition: Maintenance.php:388
class
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:56
Maintenance\hasOption
hasOption( $name)
Checks to see if a particular param exists.
Definition: Maintenance.php:240
ImageBuilder\build
build()
Definition: rebuildImages.php:88
wfLocalFile
wfLocalFile( $title)
Get an object referring to a locally registered file.
Definition: GlobalFunctions.php:2864
ImageBuilder\progress
progress( $updated)
Definition: rebuildImages.php:101
Wikimedia\Rdbms\IMaintainableDatabase
Advanced database interface for IDatabase handles that include maintenance methods.
Definition: IMaintainableDatabase.php:38
ImageBuilder\buildImage
buildImage()
Definition: rebuildImages.php:148
$wgContLang
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the content language as $wgContLang
Definition: design.txt:57