MediaWiki  master
sqlite.php
Go to the documentation of this file.
1 <?php
24 require_once __DIR__ . '/Maintenance.php';
25 
32  public function __construct() {
33  parent::__construct();
34  $this->addDescription( 'Performs some operations specific to SQLite database backend' );
35  $this->addOption(
36  'vacuum',
37  'Clean up database by removing deleted pages. Decreases database file size'
38  );
39  $this->addOption( 'integrity', 'Check database for integrity' );
40  $this->addOption( 'backup-to', 'Backup database to the given file', false, true );
41  $this->addOption( 'check-syntax', 'Check SQL file(s) for syntax errors', false, true );
42  }
43 
50  public function getDbType() {
51  return Maintenance::DB_NONE;
52  }
53 
54  public function execute() {
55  // Should work even if we use a non-SQLite database
56  if ( $this->hasOption( 'check-syntax' ) ) {
57  $this->checkSyntax();
58 
59  return;
60  }
61 
62  $this->db = $this->getDB( DB_MASTER );
63 
64  if ( $this->db->getType() != 'sqlite' ) {
65  $this->error( "This maintenance script requires a SQLite database.\n" );
66 
67  return;
68  }
69 
70  if ( $this->hasOption( 'vacuum' ) ) {
71  $this->vacuum();
72  }
73 
74  if ( $this->hasOption( 'integrity' ) ) {
75  $this->integrityCheck();
76  }
77 
78  if ( $this->hasOption( 'backup-to' ) ) {
79  $this->backup( $this->getOption( 'backup-to' ) );
80  }
81  }
82 
83  private function vacuum() {
84  $prevSize = filesize( $this->db->getDbFilePath() );
85  if ( $prevSize == 0 ) {
86  $this->fatalError( "Can't vacuum an empty database.\n" );
87  }
88 
89  $this->output( 'VACUUM: ' );
90  if ( $this->db->query( 'VACUUM' ) ) {
91  clearstatcache();
92  $newSize = filesize( $this->db->getDbFilePath() );
93  $this->output( sprintf( "Database size was %d, now %d (%.1f%% reduction).\n",
94  $prevSize, $newSize, ( $prevSize - $newSize ) * 100.0 / $prevSize ) );
95  } else {
96  $this->output( 'Error\n' );
97  }
98  }
99 
100  private function integrityCheck() {
101  $this->output( "Performing database integrity checks:\n" );
102  $res = $this->db->query( 'PRAGMA integrity_check' );
103 
104  if ( !$res || $res->numRows() == 0 ) {
105  $this->error( "Error: integrity check query returned nothing.\n" );
106 
107  return;
108  }
109 
110  foreach ( $res as $row ) {
111  $this->output( $row->integrity_check );
112  }
113  }
114 
115  private function backup( $fileName ) {
116  $this->output( "Backing up database:\n Locking..." );
117  $this->db->query( 'BEGIN IMMEDIATE TRANSACTION', __METHOD__ );
118  $ourFile = $this->db->getDbFilePath();
119  $this->output( " Copying database file $ourFile to $fileName... " );
120  Wikimedia\suppressWarnings();
121  if ( !copy( $ourFile, $fileName ) ) {
122  $err = error_get_last();
123  $this->error( " {$err['message']}" );
124  }
125  Wikimedia\restoreWarnings();
126  $this->output( " Releasing lock...\n" );
127  $this->db->query( 'COMMIT TRANSACTION', __METHOD__ );
128  }
129 
130  private function checkSyntax() {
131  if ( !Sqlite::isPresent() ) {
132  $this->error( "Error: SQLite support not found\n" );
133  }
134  $files = [ $this->getOption( 'check-syntax' ) ];
135  $files = array_merge( $files, $this->mArgs );
136  $result = Sqlite::checkSqlSyntax( $files );
137  if ( $result === true ) {
138  $this->output( "SQL syntax check: no errors detected.\n" );
139  } else {
140  $this->error( "Error: $result\n" );
141  }
142  }
143 }
144 
146 require_once RUN_MAINTENANCE_IF_MAIN;
backup( $fileName)
Definition: sqlite.php:115
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 copy
Definition: LICENSE.txt:10
Maintenance script that performs some operations specific to SQLite database backend.
Definition: sqlite.php:31
const DB_NONE
Constants for DB access type.
Definition: Maintenance.php:85
error( $err, $die=0)
Throw an error to the user.
getOption( $name, $default=null)
Get an option, or return the default.
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: maintenance.txt:39
getDbType()
While we use database connection, this simple lie prevents useless –dbpass and –dbuser options from...
Definition: sqlite.php:50
hasOption( $name)
Checks to see if a particular option exists.
require_once RUN_MAINTENANCE_IF_MAIN
Definition: maintenance.txt:50
const DB_MASTER
Definition: defines.php:26
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. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\*-\*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. '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 '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 '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 '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. '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 IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() '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 Sanitizer::validateEmail(), 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 '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:Array with elements of the form "language:title" in the order that they will be output. & $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. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. 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:1970
$res
Definition: database.txt:21
$maintClass
Definition: sqlite.php:145
addDescription( $text)
Set the description text.
output( $out, $channel=null)
Throw some output to the user.
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
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
Definition: injection.txt:35
static isPresent()
Checks whether PHP has SQLite support.
Definition: sqlite.inc:38
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
fatalError( $msg, $exitCode=1)
Output a message and terminate the current script.
static checkSqlSyntax( $files)
Checks given files for correctness of SQL syntax.
Definition: sqlite.inc:50
getDB( $db, $groups=[], $dbDomain=false)
Returns a database to be used by current maintenance script.