MediaWiki  1.23.8
Go to the documentation of this file.
1 <?php
33 require_once __DIR__ . '/Maintenance.php';
40 class ImageBuilder extends Maintenance {
45  protected $dbw;
47  function __construct() {
48  parent::__construct();
50  global $wgUpdateCompatibleMetadata;
51  //make sure to update old, but compatible img_metadata fields.
52  $wgUpdateCompatibleMetadata = true;
54  $this->mDescription = 'Script to update image metadata records';
56  $this->addOption( 'missing', 'Check for files without associated database record' );
57  $this->addOption( 'dry-run', 'Only report, don\'t update the database' );
58  }
60  public function execute() {
61  $this->dbw = wfGetDB( DB_MASTER );
62  $this->maxLag = 10; # if slaves are lagged more than 10 secs, wait
63  $this->dryrun = $this->hasOption( 'dry-run' );
64  if ( $this->dryrun ) {
65  $GLOBALS['wgReadOnly'] = 'Dry run mode, image upgrades are suppressed';
66  }
68  if ( $this->hasOption( 'missing' ) ) {
69  $this->crawlMissing();
70  } else {
71  $this->build();
72  }
73  }
78  function getRepo() {
79  if ( !isset( $this->repo ) ) {
80  $this->repo = RepoGroup::singleton()->getLocalRepo();
81  }
82  return $this->repo;
83  }
85  function build() {
86  $this->buildImage();
87  $this->buildOldImage();
88  }
90  function init( $count, $table ) {
91  $this->processed = 0;
92  $this->updated = 0;
93  $this->count = $count;
94  $this->startTime = microtime( true );
95  $this->table = $table;
96  }
98  function progress( $updated ) {
99  $this->updated += $updated;
100  $this->processed++;
101  if ( $this->processed % 100 != 0 ) {
102  return;
103  }
104  $portion = $this->processed / $this->count;
105  $updateRate = $this->updated / $this->processed;
107  $now = microtime( true );
108  $delta = $now - $this->startTime;
109  $estimatedTotalTime = $delta / $portion;
110  $eta = $this->startTime + $estimatedTotalTime;
111  $rate = $this->processed / $delta;
113  $this->output( sprintf( "%s: %6.2f%% done on %s; ETA %s [%d/%d] %.2f/sec <%.2f%% updated>\n",
114  wfTimestamp( TS_DB, intval( $now ) ),
115  $portion * 100.0,
116  $this->table,
117  wfTimestamp( TS_DB, intval( $eta ) ),
118  $this->processed,
119  $this->count,
120  $rate,
121  $updateRate * 100.0 ) );
122  flush();
123  }
125  function buildTable( $table, $key, $callback ) {
126  $count = $this->dbw->selectField( $table, 'count(*)', '', __METHOD__ );
127  $this->init( $count, $table );
128  $this->output( "Processing $table...\n" );
130  $result = wfGetDB( DB_SLAVE )->select( $table, '*', array(), __METHOD__ );
132  foreach ( $result as $row ) {
133  $update = call_user_func( $callback, $row, null );
134  if ( $update ) {
135  $this->progress( 1 );
136  } else {
137  $this->progress( 0 );
138  }
139  }
140  $this->output( "Finished $table... $this->updated of $this->processed rows updated\n" );
141  }
143  function buildImage() {
144  $callback = array( $this, 'imageCallback' );
145  $this->buildTable( 'image', 'img_name', $callback );
146  }
148  function imageCallback( $row, $copy ) {
149  // Create a File object from the row
150  // This will also upgrade it
151  $file = $this->getRepo()->newFileFromRow( $row );
152  return $file->getUpgraded();
153  }
155  function buildOldImage() {
156  $this->buildTable( 'oldimage', 'oi_archive_name', array( $this, 'oldimageCallback' ) );
157  }
159  function oldimageCallback( $row, $copy ) {
160  // Create a File object from the row
161  // This will also upgrade it
162  if ( $row->oi_archive_name == '' ) {
163  $this->output( "Empty oi_archive_name for oi_name={$row->oi_name}\n" );
164  return false;
165  }
166  $file = $this->getRepo()->newFileFromRow( $row );
167  return $file->getUpgraded();
168  }
170  function crawlMissing() {
171  $this->getRepo()->enumFiles( array( $this, 'checkMissingImage' ) );
172  }
174  function checkMissingImage( $fullpath ) {
175  $filename = wfBaseName( $fullpath );
176  $row = $this->dbw->selectRow( 'image',
177  array( 'img_name' ),
178  array( 'img_name' => $filename ),
179  __METHOD__ );
181  if ( !$row ) { // file not registered
182  $this->addMissingImage( $filename, $fullpath );
183  }
184  }
186  function addMissingImage( $filename, $fullpath ) {
189  $timestamp = $this->dbw->timestamp( $this->getRepo()->getFileTimestamp( $fullpath ) );
191  $altname = $wgContLang->checkTitleEncoding( $filename );
192  if ( $altname != $filename ) {
193  if ( $this->dryrun ) {
194  $filename = $altname;
195  $this->output( "Estimating transcoding... $altname\n" );
196  } else {
197  # @todo FIXME: create renameFile()
198  $filename = $this->renameFile( $filename );
199  }
200  }
202  if ( $filename == '' ) {
203  $this->output( "Empty filename for $fullpath\n" );
204  return;
205  }
206  if ( !$this->dryrun ) {
207  $file = wfLocalFile( $filename );
208  if ( !$file->recordUpload(
209  '',
210  '(recovered file, missing upload log entry)',
211  '',
212  '',
213  '',
214  false,
215  $timestamp
216  )
217  ) {
218  $this->output( "Error uploading file $fullpath\n" );
219  return;
220  }
221  }
222  $this->output( $fullpath . "\n" );
223  }
224 }
226 $maintClass = 'ImageBuilder';
227 require_once RUN_MAINTENANCE_IF_MAIN;
init( $count, $table)
Definition: rebuildImages.php:89
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. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. $reader:XMLReader object $logInfo:Array of information Return false to stop further processing of the tag 'ImportHandlePageXMLTag':When parsing a XML tag in a page. $reader:XMLReader object $pageInfo:Array of information Return false to stop further processing of the tag 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information Return false to stop further processing of the tag 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. $reader:XMLReader object Return false to stop further processing of the tag 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. $reader:XMLReader object $revisionInfo:Array of information Return false to stop further processing of the tag '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 '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. '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 '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 '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 wfIsTrustedProxy() $ip:IP being check $result:Change this value to override the result of wfIsTrustedProxy() '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 User::isValidEmailAddr(), 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. '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 '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) '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:Associative array mapping language codes to prefixed links of the form "language:title". & $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. 'LinkBegin':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:1528
Definition: rebuildImages.php:154
Definition: Defines.php:56
static singleton()
Get a RepoGroup instance.
Definition: RepoGroup.php:53
Do the actual work.
Definition: rebuildImages.php:59
skin txt MediaWiki includes four core it has been set as the default in MediaWiki since the replacing Monobook it had been been the default skin since before being replaced by Vector largely rewritten in while keeping its appearance Several legacy skins were removed in the as the burden of supporting them became too heavy to bear Those in etc for skin dependent CSS etc for skin dependent JavaScript These can also be customised on a per user by etc This feature has led to a wide variety of user styles becoming that gallery is a good place to ending in php
Definition: skin.txt:62
& wfGetDB( $db, $groups=array(), $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:3659
if( $limit) $timestamp
Definition: importImages.php:104
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Definition: GlobalFunctions.php:2483
addOption( $name, $description, $required=false, $withArg=false, $shortName=false)
Add a parameter to the script.
Definition: Maintenance.php:169
Maintenance script to update image metadata records.
Definition: rebuildImages.php:40
Definition: rebuildImages.php:225
wfBaseName( $path, $suffix='')
Return the final portion of a pathname.
Definition: GlobalFunctions.php:3302
Definition: maintenance.txt:50
Definition: rebuildImages.php:77
const TS_DB
Definition: GlobalFunctions.php:2436
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: maintenance.txt:39
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:56
buildTable( $table, $key, $callback)
Definition: rebuildImages.php:124
Definition: importImages.php:40
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:11
imageCallback( $row, $copy)
Definition: rebuildImages.php:147
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
Database abstraction object.
Definition: Database.php:219
checkMissingImage( $fullpath)
Definition: rebuildImages.php:173
Default constructor.
Definition: rebuildImages.php:46
oldimageCallback( $row, $copy)
Definition: rebuildImages.php:158
if(PHP_SAPI !='cli') $file
Definition: UtfNormalTest2.php:30
Definition: rebuildImages.php:169
Definition: UtfNormalTest2.php:96
const DB_SLAVE
Definition: Defines.php:55
The ContentHandler facility adds support for arbitrary content types on wiki instead of relying on wikitext for everything It was introduced in MediaWiki Each kind of and so on Built in content types are
Definition: contenthandler.txt:5
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:9
addMissingImage( $filename, $fullpath)
Definition: rebuildImages.php:185
output( $out, $channel=null)
Throw some output to the user.
Definition: Maintenance.php:314
hasOption( $name)
Checks to see if a particular param exists.
Definition: Maintenance.php:181
Definition: rebuildImages.php:84
wfLocalFile( $title)
Get an object referring to a locally registered file.
Definition: GlobalFunctions.php:3713
progress( $updated)
Definition: rebuildImages.php:97
Definition: rebuildImages.php:142
Definition: ComposerHookHandler.php:6
DatabaseBase $dbw
Definition: rebuildImages.php:44