24require_once __DIR__ .
'/Maintenance.php';
42 parent::__construct();
44 $this->
addOption(
'src',
'Backend containing the source files',
true,
true );
45 $this->
addOption(
'dst',
'Backend where files should be copied to',
true,
true );
46 $this->
addOption(
'containers',
'Pipe separated list of containers',
true,
true );
47 $this->
addOption(
'subdir',
'Only do items in this child directory',
false,
true );
48 $this->
addOption(
'ratefile',
'File to check periodically for batch size',
false,
true );
49 $this->
addOption(
'prestat',
'Stat the destination files first (try to use listings)' );
50 $this->
addOption(
'skiphash',
'Skip SHA-1 sync checks for files' );
51 $this->
addOption(
'missingonly',
'Only copy files missing from destination listing' );
52 $this->
addOption(
'syncviadelete',
'Delete destination files missing from source listing' );
53 $this->
addOption(
'utf8only',
'Skip source files that do not have valid UTF-8 names' );
60 $containers = explode(
'|', $this->
getOption(
'containers' ) );
61 $subDir = rtrim( $this->
getOption(
'subdir',
'' ),
'/' );
63 $rateFile = $this->
getOption(
'ratefile' );
65 foreach ( $containers as $container ) {
66 if ( $subDir !=
'' ) {
67 $backendRel =
"$container/$subDir";
68 $this->
output(
"Doing container '$container', directory '$subDir'...\n" );
70 $backendRel = $container;
71 $this->
output(
"Doing container '$container'...\n" );
74 if ( $this->
hasOption(
'missingonly' ) ) {
75 $this->
output(
"\tBuilding list of missing files..." );
77 $this->
output( count( $srcPathsRel ) .
" file(s) need to be copied.\n" );
79 $srcPathsRel = $src->getFileList( [
80 'dir' => $src->getRootStoragePath() .
"/$backendRel",
83 if ( $srcPathsRel ===
null ) {
84 $this->
error(
"Could not list files in $container.", 1 );
90 $this->
output(
"\tBuilding destination stat cache..." );
91 $dstPathsRel = $dst->getFileList( [
92 'dir' => $dst->getRootStoragePath() .
"/$backendRel",
95 if ( $dstPathsRel ===
null ) {
96 $this->
error(
"Could not list files in $container.", 1 );
98 $this->statCache = [];
99 foreach ( $dstPathsRel as $dstPathRel ) {
100 $path = $dst->getRootStoragePath() .
"/$backendRel/$dstPathRel";
101 $this->statCache[sha1( $path )] = $dst->getFileStat( [
'src' => $path ] );
103 $this->
output(
"done [" . count( $this->statCache ) .
" file(s)]\n" );
106 $this->
output(
"\tCopying file(s)...\n" );
109 foreach ( $srcPathsRel as $srcPathRel ) {
111 if ( $rateFile && ( !$count || ( $count % 500 ) == 0 ) ) {
112 $this->mBatchSize = max( 1, (
int)file_get_contents( $rateFile ) );
113 $this->
output(
"\tBatch size is now {$this->mBatchSize}.\n" );
115 $batchPaths[$srcPathRel] = 1;
116 if ( count( $batchPaths ) >= $this->mBatchSize ) {
117 $this->
copyFileBatch( array_keys( $batchPaths ), $backendRel, $src, $dst );
122 if ( count( $batchPaths ) ) {
123 $this->
copyFileBatch( array_keys( $batchPaths ), $backendRel, $src, $dst );
126 $this->
output(
"\tCopied $count file(s).\n" );
128 if ( $this->
hasOption(
'syncviadelete' ) ) {
129 $this->
output(
"\tBuilding list of excess destination files..." );
131 $this->
output( count( $delPathsRel ) .
" file(s) need to be deleted.\n" );
133 $this->
output(
"\tDeleting file(s)...\n" );
136 foreach ( $delPathsRel as $delPathRel ) {
138 if ( $rateFile && ( !$count || ( $count % 500 ) == 0 ) ) {
139 $this->mBatchSize = max( 1, (
int)file_get_contents( $rateFile ) );
140 $this->
output(
"\tBatch size is now {$this->mBatchSize}.\n" );
142 $batchPaths[$delPathRel] = 1;
143 if ( count( $batchPaths ) >= $this->mBatchSize ) {
144 $this->
delFileBatch( array_keys( $batchPaths ), $backendRel, $dst );
149 if ( count( $batchPaths ) ) {
150 $this->
delFileBatch( array_keys( $batchPaths ), $backendRel, $dst );
154 $this->
output(
"\tDeleted $count file(s).\n" );
157 if ( $subDir !=
'' ) {
158 $this->
output(
"Finished container '$container', directory '$subDir'.\n" );
160 $this->
output(
"Finished container '$container'.\n" );
164 $this->
output(
"Done.\n" );
176 if ( $srcPathsRel ===
null ) {
177 $this->
error(
"Could not list files in source container.", 1 );
179 $dstPathsRel = $dst->getFileList( [
180 'dir' => $dst->getRootStoragePath() .
"/$backendRel" ] );
181 if ( $dstPathsRel ===
null ) {
182 $this->
error(
"Could not list files in destination container.", 1 );
185 $relFilesDstSha1 = [];
186 foreach ( $dstPathsRel as $dstPathRel ) {
187 $relFilesDstSha1[sha1( $dstPathRel )] = 1;
189 unset( $dstPathsRel );
191 $missingPathsRel = [];
192 foreach ( $srcPathsRel as $srcPathRel ) {
193 if ( !isset( $relFilesDstSha1[sha1( $srcPathRel )] ) ) {
194 $missingPathsRel[] = $srcPathRel;
197 unset( $srcPathsRel );
199 return $missingPathsRel;
218 if ( $this->
hasOption(
'missingonly' ) ) {
220 foreach ( $srcPathsRel as $srcPathRel ) {
223 $t_start = microtime(
true );
225 $elapsed_ms = floor( ( microtime(
true ) - $t_start ) * 1000 );
226 $this->
output(
"\n\tDownloaded these file(s) [{$elapsed_ms}ms]:\n\t" .
227 implode(
"\n\t", $srcPaths ) .
"\n\n" );
231 foreach ( $srcPathsRel as $srcPathRel ) {
233 $dstPath = $dst->getRootStoragePath() .
"/$backendRel/$srcPathRel";
234 if ( $this->
hasOption(
'utf8only' ) && !mb_check_encoding( $srcPath,
'UTF-8' ) ) {
235 $this->
error(
"$wikiId: Detected illegal (non-UTF8) path for $srcPath." );
237 } elseif ( !$this->
hasOption(
'missingonly' )
238 && $this->
filesAreSame( $src, $dst, $srcPath, $dstPath )
240 $this->
output(
"\tAlready have $srcPathRel.\n" );
243 $fsFile = array_key_exists( $srcPath, $fsFiles )
248 if ( $src->
fileExists( [
'src' => $srcPath,
'latest' => 1 ] ) ===
false ) {
249 $this->
error(
"$wikiId: File '$srcPath' was listed but does not exist." );
251 $this->
error(
"$wikiId: Could not get local copy of $srcPath." );
254 } elseif ( !$fsFile->exists() ) {
258 $this->
error(
"$wikiId: Detected possible illegal path for $srcPath." );
261 $fsFiles[] = $fsFile;
263 $status = $dst->prepare( [
'dir' => dirname( $dstPath ),
'bypassReadOnly' => 1 ] );
265 $this->
error( print_r(
$status->getErrorsArray(),
true ) );
266 $this->
error(
"$wikiId: Could not copy $srcPath to $dstPath.", 1 );
268 $ops[] = [
'op' =>
'store',
269 'src' => $fsFile->getPath(),
'dst' => $dstPath,
'overwrite' => 1 ];
270 $copiedRel[] = $srcPathRel;
274 $t_start = microtime(
true );
275 $status = $dst->doQuickOperations( $ops, [
'bypassReadOnly' => 1 ] );
278 $status = $dst->doQuickOperations( $ops, [
'bypassReadOnly' => 1 ] );
280 $elapsed_ms = floor( ( microtime(
true ) - $t_start ) * 1000 );
282 $this->
error( print_r(
$status->getErrorsArray(),
true ) );
283 $this->
error(
"$wikiId: Could not copy file batch.", 1 );
284 } elseif ( count( $copiedRel ) ) {
285 $this->
output(
"\n\tCopied these file(s) [{$elapsed_ms}ms]:\n\t" .
286 implode(
"\n\t", $copiedRel ) .
"\n\n" );
301 $wikiId = $dst->getWikiId();
304 foreach ( $dstPathsRel as $dstPathRel ) {
305 $dstPath = $dst->getRootStoragePath() .
"/$backendRel/$dstPathRel";
306 $ops[] = [
'op' =>
'delete',
'src' => $dstPath ];
307 $deletedRel[] = $dstPathRel;
311 $t_start = microtime(
true );
312 $status = $dst->doQuickOperations( $ops, [
'bypassReadOnly' => 1 ] );
315 $status = $dst->doQuickOperations( $ops, [
'bypassReadOnly' => 1 ] );
317 $elapsed_ms = floor( ( microtime(
true ) - $t_start ) * 1000 );
319 $this->
error( print_r(
$status->getErrorsArray(),
true ) );
320 $this->
error(
"$wikiId: Could not delete file batch.", 1 );
321 } elseif ( count( $deletedRel ) ) {
322 $this->
output(
"\n\tDeleted these file(s) [{$elapsed_ms}ms]:\n\t" .
323 implode(
"\n\t", $deletedRel ) .
"\n\n" );
335 $skipHash = $this->
hasOption(
'skiphash' );
336 $srcStat = $src->
getFileStat( [
'src' => $sPath ] );
337 $dPathSha1 = sha1( $dPath );
338 if ( $this->statCache !==
null ) {
340 $dstStat = isset( $this->statCache[$dPathSha1] )
341 ? $this->statCache[$dPathSha1]
344 $dstStat = $dst->getFileStat( [
'src' => $dPath ] );
349 && is_array( $dstStat )
350 && $srcStat[
'size'] === $dstStat[
'size']
355 } elseif ( isset( $srcStat[
'md5'] ) && isset( $dstStat[
'md5'] ) ) {
359 $same = ( $srcStat[
'md5'] === $dstStat[
'md5'] );
360 } elseif ( $skipHash ) {
365 $same = ( $srcStat[
'mtime'] <= $dstStat[
'mtime'] );
370 === $dst->getFileSha1Base36( [
'src' => $dPath,
'latest' => 1 ] ) );
Copy all files in one container of one backend to another.
__construct()
Default constructor.
filesAreSame(FileBackend $src, FileBackend $dst, $sPath, $dPath)
array null $statCache
(path sha1 => stat) Pre-computed dst stat entries from listings
delFileBatch(array $dstPathsRel, $backendRel, FileBackend $dst)
execute()
Do the actual work.
getListingDiffRel(FileBackend $src, FileBackend $dst, $backendRel)
copyFileBatch(array $srcPathsRel, $backendRel, FileBackend $src, FileBackend $dst)
Base class for all file backend classes (including multi-write backends).
getFileList(array $params)
Get an iterator to list all stored files under a storage directory.
getFileSha1Base36(array $params)
Get a SHA-1 hash of the file at a storage path in the backend.
clearCache(array $paths=null)
Invalidate any in-process file stat and property cache.
getFileStat(array $params)
Get quick information about a file at a storage path in the backend.
fileExists(array $params)
Check if a file exists at a storage path in the backend.
getRootStoragePath()
Get the root storage path of this backend.
getWikiId()
Alias to getDomainId()
getLocalReferenceMulti(array $params)
Like getLocalReference() except it takes an array of storage paths and returns a map of storage paths...
getLocalReference(array $params)
Returns a file system file, identical to the file at a storage path.
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
hasOption( $name)
Checks to see if a particular param exists.
addDescription( $text)
Set the description text.
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
getOption( $name, $default=null)
Get an option, or return the default.
setBatchSize( $s=0)
Set the batch size.
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any and then calling output() to send it all. It could be easily changed to send incrementally if that becomes useful
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults error
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action or null $user:User who performed the tagging when the tagging is subsequent to the action or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy: boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
require_once RUN_MAINTENANCE_IF_MAIN