MediaWiki  master
LCStoreDB.php
Go to the documentation of this file.
1 <?php
24 
29 class LCStoreDB implements LCStore {
31  private $currentLang;
33  private $writesDone = false;
35  private $dbw;
37  private $batch = [];
39  private $readOnly = false;
41  private $server;
42 
43  public function __construct( $params ) {
44  $this->server = $params['server'] ?? [];
45  }
46 
47  public function get( $code, $key ) {
48  if ( $this->server || $this->writesDone ) {
49  // If a server configuration map is specified, always used that connection
50  // for reads and writes. Otherwise, if writes occurred in finishWrite(), make
51  // sure those changes are always visible.
52  $db = $this->getWriteConnection();
53  } else {
54  $db = wfGetDB( DB_REPLICA );
55  }
56 
57  $value = $db->selectField(
58  'l10n_cache',
59  'lc_value',
60  [ 'lc_lang' => $code, 'lc_key' => $key ],
61  __METHOD__
62  );
63 
64  return ( $value !== false ) ? unserialize( $db->decodeBlob( $value ) ) : null;
65  }
66 
67  public function startWrite( $code ) {
68  if ( $this->readOnly ) {
69  return;
70  } elseif ( !$code ) {
71  throw new MWException( __METHOD__ . ": Invalid language \"$code\"" );
72  }
73 
74  $dbw = $this->getWriteConnection();
75  $this->readOnly = $dbw->isReadOnly();
76 
77  $this->currentLang = $code;
78  $this->batch = [];
79  }
80 
81  public function finishWrite() {
82  if ( $this->readOnly ) {
83  return;
84  } elseif ( is_null( $this->currentLang ) ) {
85  throw new MWException( __CLASS__ . ': must call startWrite() before finishWrite()' );
86  }
87 
88  $trxProfiler = Profiler::instance()->getTransactionProfiler();
89  $oldSilenced = $trxProfiler->setSilenced( true );
90  try {
91  $dbw = $this->getWriteConnection();
92  $dbw->startAtomic( __METHOD__ );
93  try {
94  $dbw->delete( 'l10n_cache', [ 'lc_lang' => $this->currentLang ], __METHOD__ );
95  foreach ( array_chunk( $this->batch, 500 ) as $rows ) {
96  $dbw->insert( 'l10n_cache', $rows, __METHOD__ );
97  }
98  $this->writesDone = true;
99  } catch ( DBQueryError $e ) {
100  if ( $dbw->wasReadOnlyError() ) {
101  $this->readOnly = true; // just avoid site down time
102  } else {
103  throw $e;
104  }
105  }
106  $dbw->endAtomic( __METHOD__ );
107  } finally {
108  $trxProfiler->setSilenced( $oldSilenced );
109  }
110 
111  $this->currentLang = null;
112  $this->batch = [];
113  }
114 
115  public function set( $key, $value ) {
116  if ( $this->readOnly ) {
117  return;
118  } elseif ( is_null( $this->currentLang ) ) {
119  throw new MWException( __CLASS__ . ': must call startWrite() before set()' );
120  }
121 
122  $dbw = $this->getWriteConnection();
123 
124  $this->batch[] = [
125  'lc_lang' => $this->currentLang,
126  'lc_key' => $key,
127  'lc_value' => $dbw->encodeBlob( serialize( $value ) )
128  ];
129  }
130 
134  private function getWriteConnection() {
135  if ( !$this->dbw ) {
136  if ( $this->server ) {
137  $this->dbw = Database::factory( $this->server['type'], $this->server );
138  if ( !$this->dbw ) {
139  throw new MWException( __CLASS__ . ': failed to obtain a DB connection' );
140  }
141  } else {
142  $this->dbw = wfGetDB( DB_MASTER );
143  }
144  }
145 
146  return $this->dbw;
147  }
148 }
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction $rows
Definition: hooks.txt:2627
array $batch
Definition: LCStoreDB.php:37
serialize()
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
getWriteConnection()
Definition: LCStoreDB.php:134
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2153
static instance()
Singleton.
Definition: Profiler.php:62
insert( $table, $a, $fname=__METHOD__, $options=[])
INSERT wrapper, inserts an array into a table.
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
$value
IDatabase null $dbw
Definition: LCStoreDB.php:35
endAtomic( $fname=__METHOD__)
Ends an atomic section of SQL statements.
encodeBlob( $b)
Some DBMSs have a special format for inserting into blob fields, they don&#39;t allow simple quoted strin...
string $currentLang
Definition: LCStoreDB.php:31
const DB_MASTER
Definition: defines.php:26
linkcache txt The LinkCache class maintains a list of article titles and the information about whether or not the article exists in the database This is used to mark up links when displaying a page If the same link appears more than once on any page then it only has to be looked up once In most cases link lookups are done in batches with the LinkBatch class or the equivalent in so the link cache is mostly useful for short snippets of parsed and for links in the navigation areas of the skin The link cache was formerly used to track links used in a document for the purposes of updating the link tables This application is now deprecated To create a batch
Definition: linkcache.txt:14
finishWrite()
Finish a write transaction.
Definition: LCStoreDB.php:81
wasReadOnlyError()
Determines if the last failure was due to the database being read-only.
$params
unserialize( $serialized)
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:773
__construct( $params)
Definition: LCStoreDB.php:43
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable & $code
Definition: hooks.txt:773
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
bool $writesDone
Definition: LCStoreDB.php:33
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
Interface for the persistence layer of LocalisationCache.
Definition: LCStore.php:38
bool $readOnly
Definition: LCStoreDB.php:39
startAtomic( $fname=__METHOD__, $cancelable=self::ATOMIC_NOT_CANCELABLE)
Begin an atomic section of SQL statements.
array $server
Server configuration map.
Definition: LCStoreDB.php:41
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 and we might be restricted by PHP settings such as safe mode or open_basedir We cannot assume that the software even has read access anywhere useful Many shared hosts run all users web applications under the same so they can t rely on Unix and must forbid reads to even standard directories like tmp lest users read each others files We cannot assume that the user has the ability to install or run any programs not written as web accessible PHP scripts Since anything that works on cheap shared hosting will work if you have shell or root access MediaWiki s design is based around catering to the lowest common denominator Although we support higher end setups as the way many things work by default is tailored toward shared hosting These defaults are unconventional from the point of view of and they certainly aren t ideal for someone who s installing MediaWiki as MediaWiki does not conform to normal Unix filesystem layout Hopefully we ll offer direct support for standard layouts in the but for now *any change to the location of files is unsupported *Moving things and leaving symlinks will *probably *not break but it is *strongly *advised not to try any more intrusive changes to get MediaWiki to conform more closely to your filesystem hierarchy Any such attempt will almost certainly result in unnecessary bugs The standard recommended location to install relative to the web is it should be possible to enable the appropriate rewrite rules by if you can reconfigure the web server
const DB_REPLICA
Definition: defines.php:25
LCStore implementation which uses the standard DB functions to store data.
Definition: LCStoreDB.php:29
delete( $table, $conds, $fname=__METHOD__)
DELETE query wrapper.
startWrite( $code)
Start a write transaction.
Definition: LCStoreDB.php:67