Go to the documentation of this file.
24 require_once __DIR__ .
'/Maintenance.php';
34 parent::__construct();
35 $this->
addDescription(
'Sync one file backend with another using the journal' );
36 $this->
addOption(
'src',
'Name of backend to sync from',
true,
true );
37 $this->
addOption(
'dst',
'Name of destination backend to sync',
false,
true );
38 $this->
addOption(
'start',
'Starting journal ID',
false,
true );
39 $this->
addOption(
'end',
'Ending journal ID',
false,
true );
40 $this->
addOption(
'posdir',
'Directory to read/record journal positions',
false,
true );
41 $this->
addOption(
'posdump',
'Just dump current journal position into the position dir.' );
42 $this->
addOption(
'postime',
'For position dumps, get the ID at this time',
false,
true );
43 $this->
addOption(
'backoff',
'Stop at entries younger than this age (sec).',
false,
true );
44 $this->
addOption(
'verbose',
'Verbose mode',
false,
false,
'v' );
52 $posFile = $posDir ? $posDir .
'/' .
wfWikiID() :
false;
57 $this->
error(
"Param posdir required!", 1 );
60 $id = (int)$src->getJournal()->getPositionAtTime( $this->
getOption(
'postime' ) );
61 $this->
output(
"Requested journal position is $id.\n" );
63 $id = (int)$src->getJournal()->getCurrentPosition();
64 $this->
output(
"Current journal position is $id.\n" );
66 if ( file_put_contents( $posFile, $id, LOCK_EX ) !==
false ) {
67 $this->
output(
"Saved journal position file.\n" );
69 $this->
output(
"Could not save journal position file.\n" );
79 $this->
error(
"Param dst required!", 1 );
84 if ( !$start && $posFile && is_dir( $posDir ) ) {
85 $start = is_file( $posFile )
86 ? (int)trim( file_get_contents( $posFile ) )
89 $startFromPosFile =
true;
91 $startFromPosFile =
false;
96 $end = (int)$src->getJournal()->getPositionAtTime(
$time );
101 $this->
output(
"Synchronizing backend '{$dst->getName()}' to '{$src->getName()}'...\n" );
102 $this->
output(
"Starting journal position is $start.\n" );
103 if ( is_finite( $end ) ) {
104 $this->
output(
"Ending journal position is $end.\n" );
108 $callback =
function ( $pos )
use ( $startFromPosFile, $posFile, $start ) {
109 if ( $startFromPosFile && $pos >= $start ) {
110 file_put_contents( $posFile, $pos, LOCK_EX );
115 $lastOKPos = $this->
syncBackends( $src, $dst, $start, $end, $callback );
118 if ( $startFromPosFile && $lastOKPos >= $start ) {
119 if ( file_put_contents( $posFile, $lastOKPos, LOCK_EX ) !==
false ) {
120 $this->
output(
"Updated journal position file.\n" );
122 $this->
output(
"Could not update journal position file.\n" );
126 if ( $lastOKPos ===
false ) {
128 $this->
output(
"No journal entries found.\n" );
130 $this->
output(
"No new journal entries found.\n" );
133 $this->
output(
"Stopped synchronization at journal position $lastOKPos.\n" );
158 if ( $start > $end ) {
159 $this->
error(
"Error: given starting ID greater than ending ID.", 1 );
164 $limit = min( $this->mBatchSize, $end - $start + 1 );
165 $this->
output(
"Doing id $start to " . ( $start +
$limit - 1 ) .
"...\n" );
169 if ( $first && !
count( $entries ) ) {
176 foreach ( $entries
as $entry ) {
177 if ( $entry[
'op'] !==
'null' ) {
178 $pathsInBatch[$entry[
'path']] = 1;
180 $lastPosInBatch = $entry[
'id'];
185 $lastOKPos = max( $lastOKPos, $lastPosInBatch );
186 $callback( $lastOKPos );
193 $this->
output(
"End of journal entries.\n" );
195 }
while ( $start && $start <= $end );
210 if ( !
count( $paths ) ) {
231 foreach ( $sPaths
as $i => $sPath ) {
232 $dPath = $dPaths[$i];
233 $sExists = $src->
fileExists( [
'src' => $sPath,
'latest' => 1 ] );
234 if ( $sExists ===
true ) {
235 if ( $this->
filesAreSame( $src, $dst, $sPath, $dPath ) ) {
241 $this->
error(
"Unable to sync '$dPath': could not get local copy." );
246 $fsFiles[] = $fsFile;
249 'dir' => dirname( $dPath ),
'bypassReadOnly' => 1 ] ) );
253 $ops[] = [
'op' =>
'store',
254 'src' => $fsFile->getPath(),
'dst' => $dPath,
'overwrite' => 1 ];
255 } elseif ( $sExists ===
false ) {
256 $ops[] = [
'op' =>
'delete',
'src' => $dPath,
'ignoreMissingSource' => 1 ];
258 $this->
error(
"Unable to sync '$dPath': could not stat file." );
265 $t_start = microtime(
true );
271 $elapsed_ms = floor( ( microtime(
true ) - $t_start ) * 1000 );
273 $this->
output(
"Synchronized these file(s) [{$elapsed_ms}ms]:\n" .
274 implode(
"\n", $dPaths ) .
"\n" );
289 '!^mwstore://([^/]+)!',
preloadFileStat(array $params)
Preload file stat information (concurrently if possible) into in-process cache.
Base class for all file backend classes (including multi-write backends).
addDescription( $text)
Set the description text.
getName()
Get the unique backend name.
execute()
Do the actual work.
getScopedFileLocks(array $paths, $type, StatusValue $status, $timeout=0)
Lock the files at the given storage paths in the backend.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
static escapeRegexReplacement( $string)
Escape a string to make it suitable for inclusion in a preg_replace() replacement parameter.
require_once RUN_MAINTENANCE_IF_MAIN
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Maintenance script that syncs one file backend to another based on the journal of later.
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
getFileSize(array $params)
Get the size (bytes) of a file at a storage path in the backend.
replaceNamePaths( $paths, FileBackend $backend)
Substitute the backend name of storage paths with that of a given one.
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
getFileSha1Base36(array $params)
Get a SHA-1 hash of the file at a storage path in the backend.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers please use GetContentModels hook to make them known to core if desired 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 inclusive $limit
filesAreSame(FileBackend $src, FileBackend $dst, $sPath, $dPath)
see documentation in includes Linker php for Linker::makeImageLink & $time
syncFileBatch(array $paths, FileBackend $src, FileBackend $dst)
Sync particular files of backend $src to the corresponding $dst backend files.
doQuickOperations(array $ops, array $opts=[])
Perform a set of independent file operations on some files.
wfWikiID()
Get an ASCII string identifying this wiki This is used as a prefix in memcached keys.
__construct()
Default constructor.
static newGood( $value=null)
Factory function for good results.
fileExists(array $params)
Check if a file exists at a storage path in the backend.
prepare(array $params)
Prepare a storage directory for usage.
syncBackends(FileBackend $src, FileBackend $dst, $start, $end, Closure $callback)
Sync $dst backend to $src backend based on the $src logs given after $start.
getOption( $name, $default=null)
Get an option, or return the default.
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
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return true
error( $err, $die=0)
Throw an error to the user.
output( $out, $channel=null)
Throw some output to the user.
getJournal()
Get the file journal object for this backend.
getLocalReference(array $params)
Returns a file system file, identical to the file at a storage path.
hasOption( $name)
Checks to see if a particular param exists.
the array() calling protocol came about after MediaWiki 1.4rc1.
setBatchSize( $s=0)
Set the batch size.