MediaWiki  1.23.2
Go to the documentation of this file.
1 <?php
24 require_once __DIR__ . '/Maintenance.php';
32  public function __construct() {
33  parent::__construct();
34  $this->mDescription = "Performs some operations specific to SQLite database backend";
35  $this->addOption( 'vacuum', 'Clean up database by removing deleted pages. Decreases database file size' );
36  $this->addOption( 'integrity', 'Check database for integrity' );
37  $this->addOption( 'backup-to', 'Backup database to the given file', false, true );
38  $this->addOption( 'check-syntax', 'Check SQL file(s) for syntax errors', false, true );
39  }
47  public function getDbType() {
48  return Maintenance::DB_NONE;
49  }
51  public function execute() {
52  // Should work even if we use a non-SQLite database
53  if ( $this->hasOption( 'check-syntax' ) ) {
54  $this->checkSyntax();
55  return;
56  }
58  $this->db = wfGetDB( DB_MASTER );
60  if ( $this->db->getType() != 'sqlite' ) {
61  $this->error( "This maintenance script requires a SQLite database.\n" );
62  return;
63  }
65  if ( $this->hasOption( 'vacuum' ) ) {
66  $this->vacuum();
67  }
69  if ( $this->hasOption( 'integrity' ) ) {
70  $this->integrityCheck();
71  }
73  if ( $this->hasOption( 'backup-to' ) ) {
74  $this->backup( $this->getOption( 'backup-to' ) );
75  }
76  }
78  private function vacuum() {
79  $prevSize = filesize( $this->db->mDatabaseFile );
80  if ( $prevSize == 0 ) {
81  $this->error( "Can't vacuum an empty database.\n", true );
82  }
84  $this->output( 'VACUUM: ' );
85  if ( $this->db->query( 'VACUUM' ) ) {
86  clearstatcache();
87  $newSize = filesize( $this->db->mDatabaseFile );
88  $this->output( sprintf( "Database size was %d, now %d (%.1f%% reduction).\n",
89  $prevSize, $newSize, ( $prevSize - $newSize ) * 100.0 / $prevSize ) );
90  } else {
91  $this->output( 'Error\n' );
92  }
93  }
95  private function integrityCheck() {
96  $this->output( "Performing database integrity checks:\n" );
97  $res = $this->db->query( 'PRAGMA integrity_check' );
99  if ( !$res || $res->numRows() == 0 ) {
100  $this->error( "Error: integrity check query returned nothing.\n" );
101  return;
102  }
104  foreach ( $res as $row ) {
105  $this->output( $row->integrity_check );
106  }
107  }
109  private function backup( $fileName ) {
110  $this->output( "Backing up database:\n Locking..." );
111  $this->db->query( 'BEGIN IMMEDIATE TRANSACTION', __METHOD__ );
112  $ourFile = $this->db->mDatabaseFile;
113  $this->output( " Copying database file $ourFile to $fileName... " );
114  wfSuppressWarnings( false );
115  if ( !copy( $ourFile, $fileName ) ) {
116  $err = error_get_last();
117  $this->error( " {$err['message']}" );
118  }
119  wfSuppressWarnings( true );
120  $this->output( " Releasing lock...\n" );
121  $this->db->query( 'COMMIT TRANSACTION', __METHOD__ );
122  }
124  private function checkSyntax() {
125  if ( !Sqlite::IsPresent() ) {
126  $this->error( "Error: SQLite support not found\n" );
127  }
128  $files = array( $this->getOption( 'check-syntax' ) );
129  $files += $this->mArgs;
131  if ( $result === true ) {
132  $this->output( "SQL syntax check: no errors detected.\n" );
133  } else {
134  $this->error( "Error: $result\n" );
135  }
136  }
137 }
139 $maintClass = "SqliteMaintenance";
140 require_once RUN_MAINTENANCE_IF_MAIN;
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: Defines.php:56
Do the actual work.
Definition: sqlite.php:51
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
Definition: importImages.php:67
& wfGetDB( $db, $groups=array(), $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:3650
addOption( $name, $description, $required=false, $withArg=false, $shortName=false)
Add a parameter to the script.
Definition: Maintenance.php:169
wfSuppressWarnings( $end=false)
Reference-counted warning suppression.
Definition: GlobalFunctions.php:2387
Definition: maintenance.txt:50
backup( $fileName)
Definition: sqlite.php:109
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: maintenance.txt:39
Definition: sqlite.php:78
Default constructor.
Definition: sqlite.php:32
Definition: Maintenance.php:77
While we use database connection, this simple lie prevents useless –dbpass and –dbuser options from a...
Definition: sqlite.php:47
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.
const DB_NONE
Constants for DB access type.
Definition: Maintenance.php:57
Maintenance script that performs some operations specific to SQLite database backend.
Definition: sqlite.php:31
getOption( $name, $default=null)
Get an option, or return the default.
Definition: Maintenance.php:191
static checkSqlSyntax( $files)
Checks given files for correctness of SQL syntax.
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
error( $err, $die=0)
Throw an error to the user.
Definition: Maintenance.php:333
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: sqlite.php:124
Definition: database.txt:21
Definition: sqlite.php:95
Definition: sqlite.php:139