Maintenance script that syncs one file backend to another based on the journal of later. More...
Public Member Functions | |
| __construct () | |
| execute () | |
 Public Member Functions inherited from Maintenance | |
| __construct () | |
| Default constructor. More... | |
| checkRequiredExtensions () | |
| Verify that the required extensions are installed. More... | |
| cleanupChanneled () | |
| Clean up channeled output. More... | |
| clearParamsAndArgs () | |
| Clear all params and arguments. More... | |
| execute () | |
| Do the actual work. More... | |
| finalSetup () | |
| Handle some last-minute setup here. More... | |
| getConfig () | |
| getDbType () | |
| Does the script need different DB access? By default, we give Maintenance scripts normal rights to the DB. More... | |
| getName () | |
| Get the script's name. More... | |
| globals () | |
| Potentially debug globals. More... | |
| isQuiet () | |
| loadParamsAndArgs ($self=null, $opts=null, $args=null) | |
| Process command line arguments $mOptions becomes an array with keys set to the option names $mArgs becomes a zero-based array containing the non-option arguments. More... | |
| loadSettings () | |
| Generic setup for most installs. More... | |
| loadWithArgv ($argv) | |
| Load params and arguments from a given array of command-line arguments. More... | |
| memoryLimit () | |
| Normally we disable the memory_limit when running admin scripts. More... | |
| outputChanneled ($msg, $channel=null) | |
| Message outputter with channeled message support. More... | |
| purgeRedundantText ($delete=true) | |
| Support function for cleaning up redundant text records. More... | |
| runChild ($maintClass, $classFile=null) | |
| Run a child maintenance script. More... | |
| setConfig (Config $config) | |
| setDB (IDatabase $db) | |
| Sets database object to be returned by getDB(). More... | |
| setup () | |
| Do some sanity checking and basic setup. More... | |
| updateSearchIndex ($maxLockTime, $callback, $dbw, $results) | |
| Perform a search index update with locking. More... | |
| updateSearchIndexForPage ($dbw, $pageId) | |
| Update the searchindex table for a given pageid. More... | |
Protected Member Functions | |
| filesAreSame (FileBackend $src, FileBackend $dst, $sPath, $dPath) | |
| replaceNamePaths ($paths, FileBackend $backend) | |
| Substitute the backend name of storage paths with that of a given one. More... | |
| syncBackends (FileBackend $src, FileBackend $dst, $start, $end, Closure $callback) | |
| Sync $dst backend to $src backend based on the $src logs given after $start. More... | |
| syncFileBatch (array $paths, FileBackend $src, FileBackend $dst) | |
| Sync particular files of backend $src to the corresponding $dst backend files. More... | |
| Protected Member Functions inherited from Maintenance | |
| activateProfiler () | |
| Activate the profiler (assuming $wgProfiler is set) More... | |
| addArg ($arg, $description, $required=true) | |
| Add some args that are needed. More... | |
| addDefaultParams () | |
| Add the default parameters to the scripts. More... | |
| addDescription ($text) | |
| Set the description text. More... | |
| addOption ($name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false) | |
| Add a parameter to the script. More... | |
| adjustMemoryLimit () | |
| Adjusts PHP's memory limit to better suit our needs, if needed. More... | |
| afterFinalSetup () | |
| Execute a callback function at the end of initialisation. More... | |
| beginTransaction (IDatabase $dbw, $fname) | |
| Begin a transcation on a DB. More... | |
| commitTransaction (IDatabase $dbw, $fname) | |
| Commit the transcation on a DB handle and wait for slaves to catch up. More... | |
| deleteOption ($name) | |
| Remove an option. More... | |
| error ($err, $die=0) | |
| Throw an error to the user. More... | |
| getArg ($argId=0, $default=null) | |
| Get an argument. More... | |
| getDB ($db, $groups=[], $wiki=false) | |
| Returns a database to be used by current maintenance script. More... | |
| getDir () | |
| Get the maintenance directory. More... | |
| getOption ($name, $default=null) | |
| Get an option, or return the default. More... | |
| getStdin ($len=null) | |
| Return input from stdin. More... | |
| hasArg ($argId=0) | |
| Does a given argument exist? More... | |
| hasOption ($name) | |
| Checks to see if a particular param exists. More... | |
| loadSpecialVars () | |
| Handle the special variables that are global to all scripts. More... | |
| maybeHelp ($force=false) | |
| Maybe show the help. More... | |
| output ($out, $channel=null) | |
| Throw some output to the user. More... | |
| requireExtension ($name) | |
| Indicate that the specified extension must be loaded before the script can run. More... | |
| rollbackTransaction (IDatabase $dbw, $fname) | |
| Rollback the transcation on a DB handle. More... | |
| setBatchSize ($s=0) | |
| Set the batch size. More... | |
| validateParamsAndArgs () | |
| Run some validation checks on the params, etc. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from Maintenance | |
| static | posix_isatty ($fd) |
| Wrapper for posix_isatty() We default as considering stdin a tty (for nice readline methods) but treating stout as not a tty to avoid color codes. More... | |
| static | readconsole ($prompt= '> ') |
| Prompt the console for input. More... | |
| static | shouldExecute () |
| Should we execute the maintenance script, or just allow it to be included as a standalone class? It checks that the call stack only includes this function and "requires" (meaning was called from the file scope) More... | |
| Public Attributes inherited from Maintenance | |
| resource | $fileHandle |
| Used when creating separate schema files. More... | |
| $mDbPass | |
| array | $orderedOptions = [] |
| Used to read the options in the order they were passed. More... | |
| const | DB_ADMIN = 2 |
| const | DB_NONE = 0 |
| Constants for DB access type. More... | |
| const | DB_STD = 1 |
| const | STDIN_ALL = 'all' |
| Protected Attributes inherited from Maintenance | |
| $mArgList = [] | |
| $mArgs = [] | |
| int | $mBatchSize = null |
| Batch size. More... | |
| $mDbUser | |
| $mDescription = '' | |
| $mInputLoaded = false | |
| $mOptions = [] | |
| $mParams = [] | |
| $mQuiet = false | |
| $mSelf | |
| $mShortParamsMap = [] | |
Detailed Description
Maintenance script that syncs one file backend to another based on the journal of later.
Definition at line 32 of file syncFileBackend.php.
Constructor & Destructor Documentation
| SyncFileBackend::__construct | ( | ) |
Definition at line 33 of file syncFileBackend.php.
References Maintenance\addDescription(), Maintenance\addOption(), and Maintenance\setBatchSize().
Member Function Documentation
| SyncFileBackend::execute | ( | ) |
Definition at line 48 of file syncFileBackend.php.
References $time, Maintenance\error(), Maintenance\getOption(), Maintenance\hasOption(), Maintenance\isQuiet(), Maintenance\output(), print, FileBackendGroup\singleton(), syncBackends(), use, and wfWikiID().
|
protected |
Definition at line 295 of file syncFileBackend.php.
References FileBackend\getFileSha1Base36(), and FileBackend\getFileSize().
Referenced by syncFileBatch().
|
protected |
Substitute the backend name of storage paths with that of a given one.
- Parameters
-
array | string $paths List of paths or single string path FileBackend $backend
- Returns
- array|string
Definition at line 287 of file syncFileBackend.php.
References FileBackend\getName().
Referenced by syncFileBatch().
|
protected |
Sync $dst backend to $src backend based on the $src logs given after $start.
Returns the journal entry ID this advanced to and handled (inclusive).
- Parameters
-
FileBackend $src FileBackend $dst int $start Starting journal position int $end Starting journal position Closure $callback Callback to update any position file
- Returns
- int|bool Journal entry ID or false if there are none
Definition at line 152 of file syncFileBackend.php.
References $limit, $status, as, Maintenance\error(), FileBackend\getJournal(), Maintenance\output(), syncFileBatch(), and true.
Referenced by execute().
|
protected |
Sync particular files of backend $src to the corresponding $dst backend files.
- Parameters
-
array $paths FileBackend $src FileBackend $dst
- Returns
- Status
Definition at line 208 of file syncFileBackend.php.
References $status, as, FileBackend\doQuickOperations(), Maintenance\error(), FileBackend\fileExists(), filesAreSame(), FileBackend\getLocalReference(), FileBackend\getName(), Maintenance\getOption(), FileBackend\getScopedFileLocks(), LockManager\LOCK_EX, LockManager\LOCK_UW, Status\newGood(), Maintenance\output(), FileBackend\preloadFileStat(), FileBackend\prepare(), and replaceNamePaths().
Referenced by syncBackends().
The documentation for this class was generated from the following file:
- maintenance/syncFileBackend.php
