Maintenance script that compress the text of a wiki. More...
Public Member Functions | |
| __construct () | |
| Default constructor. More... | |
| execute () | |
| Do the actual work. More... | |
 Public Member Functions inherited from Maintenance | |
| checkRequiredExtensions () | |
| Verify that the required extensions are installed. More... | |
| cleanupChanneled () | |
| Clean up channeled output. More... | |
| clearParamsAndArgs () | |
| Clear all params and arguments. 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... | |
| setAgentAndTriggers () | |
| Set triggers like when to try to run deferred updates. 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... | |
Public Attributes | |
| const | LS_CHUNKED = 1 |
| Option to load revisions in chunks. More... | |
| const | LS_INDIVIDUAL = 0 |
| Option to load each revision individually. 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' |
Private Member Functions | |
| compressOldPages ( $start=0, $extdb='') | |
| Fetch the text row-by-row to 'compressPage' function for compression. More... | |
| compressPage ( $row, $extdb) | |
| Compress the text in gzip format. More... | |
| compressWithConcat ( $startId, $maxChunkSize, $beginDate, $endDate, $extdb="", $maxPageId=false) | |
| Compress the text in chunks after concatenating the revisions. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from Maintenance | |
| static | getTermSize () |
| Get the terminal size as a two-element array where the first element is the width (number of columns) and the second element is the height (number of rows). More... | |
| 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 | requireTestsAutoloader () |
| Call this to set up the autoloader to allow classes to be used from the tests directory. More... | |
| static | setLBFactoryTriggers (LBFactory $LBFactory) |
| 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... | |
| 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 replica DBs 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... | |
| 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 compress the text of a wiki.
Definition at line 51 of file compressOld.php.
Constructor & Destructor Documentation
◆ __construct()
| CompressOld::__construct | ( | ) |
Default constructor.
Children should call this first if implementing their own constructors
Reimplemented from Maintenance.
Definition at line 62 of file compressOld.php.
References Maintenance\addDescription(), and Maintenance\addOption().
Member Function Documentation
◆ compressOldPages()
|
private |
Fetch the text row-by-row to 'compressPage' function for compression.
- Parameters
-
int $start string $extdb
Definition at line 149 of file compressOld.php.
References $last, $res, as, compressPage(), DB_MASTER, Maintenance\getDB(), and Maintenance\output().
Referenced by execute().
◆ compressPage()
|
private |
Compress the text in gzip format.
- Parameters
-
stdClass $row string $extdb
- Returns
- bool
Definition at line 186 of file compressOld.php.
References $flags, DB_MASTER, Maintenance\error(), Maintenance\getDB(), and ExternalStoreDB\store().
Referenced by compressOldPages().
◆ compressWithConcat()
|
private |
Compress the text in chunks after concatenating the revisions.
- Parameters
-
int $startId int $maxChunkSize string $beginDate string $endDate string $extdb bool | int $maxPageId
- Returns
- bool
Definition at line 233 of file compressOld.php.
References $dbr, $tables, as, Maintenance\beginTransaction(), Maintenance\commitTransaction(), captcha-old\count, DB_MASTER, DB_REPLICA, Maintenance\error(), Maintenance\getDB(), Revision\getRevisionText(), LS_CHUNKED, Title\makeTitle(), Maintenance\output(), serialize(), HistoryBlobStub\setLocation(), and wfWaitForSlaves().
Referenced by execute().
◆ execute()
| CompressOld::execute | ( | ) |
Do the actual work.
All child classes will need to implement this
Reimplemented from Maintenance.
Definition at line 103 of file compressOld.php.
References $success, $type, $wgDBname, compressOldPages(), compressWithConcat(), Maintenance\error(), Maintenance\getOption(), global, and Maintenance\output().
Member Data Documentation
◆ LS_CHUNKED
| const CompressOld::LS_CHUNKED = 1 |
Option to load revisions in chunks.
Definition at line 60 of file compressOld.php.
Referenced by compressWithConcat().
◆ LS_INDIVIDUAL
| const CompressOld::LS_INDIVIDUAL = 0 |
Option to load each revision individually.
Definition at line 55 of file compressOld.php.
The documentation for this class was generated from the following file:
- maintenance/storage/compressOld.php
