MediaWiki  1.27.1
LCStoreCDB.php
Go to the documentation of this file.
1 <?php
23 
36 class LCStoreCDB implements LCStore {
37 
39  private $readers;
40 
42  private $writer;
43 
45  private $currentLang;
46 
48  private $directory;
49 
50  function __construct( $conf = [] ) {
52 
53  if ( isset( $conf['directory'] ) ) {
54  $this->directory = $conf['directory'];
55  } else {
57  }
58  }
59 
60  public function get( $code, $key ) {
61  if ( !isset( $this->readers[$code] ) ) {
62  $fileName = $this->getFileName( $code );
63 
64  $this->readers[$code] = false;
65  if ( file_exists( $fileName ) ) {
66  try {
67  $this->readers[$code] = Reader::open( $fileName );
68  } catch ( Exception $e ) {
69  wfDebug( __METHOD__ . ": unable to open cdb file for reading\n" );
70  }
71  }
72  }
73 
74  if ( !$this->readers[$code] ) {
75  return null;
76  } else {
77  $value = false;
78  try {
79  $value = $this->readers[$code]->get( $key );
80  } catch ( Exception $e ) {
81  wfDebug( __METHOD__ . ": \Cdb\Exception caught, error message was "
82  . $e->getMessage() . "\n" );
83  }
84  if ( $value === false ) {
85  return null;
86  }
87 
88  return unserialize( $value );
89  }
90  }
91 
92  public function startWrite( $code ) {
93  if ( !file_exists( $this->directory ) ) {
94  if ( !wfMkdirParents( $this->directory, null, __METHOD__ ) ) {
95  throw new MWException( "Unable to create the localisation store " .
96  "directory \"{$this->directory}\"" );
97  }
98  }
99 
100  // Close reader to stop permission errors on write
101  if ( !empty( $this->readers[$code] ) ) {
102  $this->readers[$code]->close();
103  }
104 
105  try {
106  $this->writer = Writer::open( $this->getFileName( $code ) );
107  } catch ( Exception $e ) {
108  throw new MWException( $e->getMessage() );
109  }
110  $this->currentLang = $code;
111  }
112 
113  public function finishWrite() {
114  // Close the writer
115  try {
116  $this->writer->close();
117  } catch ( Exception $e ) {
118  throw new MWException( $e->getMessage() );
119  }
120  $this->writer = null;
121  unset( $this->readers[$this->currentLang] );
122  $this->currentLang = null;
123  }
124 
125  public function set( $key, $value ) {
126  if ( is_null( $this->writer ) ) {
127  throw new MWException( __CLASS__ . ': must call startWrite() before calling set()' );
128  }
129  try {
130  $this->writer->set( $key, serialize( $value ) );
131  } catch ( Exception $e ) {
132  throw new MWException( $e->getMessage() );
133  }
134  }
135 
136  protected function getFileName( $code ) {
137  if ( strval( $code ) === '' || strpos( $code, '/' ) !== false ) {
138  throw new MWException( __METHOD__ . ": Invalid language \"$code\"" );
139  }
140 
141  return "{$this->directory}/l10n_cache-$code.cdb";
142  }
143 
144 }
magic word the default is to use $key to get the and $key value or $key value text $key value html to format the value $key
Definition: hooks.txt:2321
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
wfMkdirParents($dir, $mode=null, $caller=null)
Make directory, and make all parent directories if they don't exist.
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException'returning false will NOT prevent logging $e
Definition: hooks.txt:1932
LCStore implementation which stores data as a collection of CDB files in the directory given by $wgCa...
Definition: LCStoreCDB.php:36
string $currentLang
Current language code.
Definition: LCStoreCDB.php:45
$value
The most up to date schema for the tables in the database will always be tables sql in the maintenance directory
Definition: schema.txt:2
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
wfDebug($text, $dest= 'all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
$wgCacheDirectory
Directory for caching data in the local filesystem.
set($key, $value)
Set a key to a given value.
Definition: LCStoreCDB.php:125
unserialize($serialized)
Definition: ApiMessage.php:102
startWrite($code)
Start a write transaction.
Definition: LCStoreCDB.php:92
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub 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:762
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
__construct($conf=[])
Definition: LCStoreCDB.php:50
An extension writer
Definition: hooks.txt:51
finishWrite()
Finish a write transaction.
Definition: LCStoreCDB.php:113
Writer $writer
Definition: LCStoreCDB.php:42
serialize()
Definition: ApiMessage.php:94
bool string $directory
Cache directory.
Definition: LCStoreCDB.php:48
Reader[] $readers
Definition: LCStoreCDB.php:39
getFileName($code)
Definition: LCStoreCDB.php:136