MediaWiki REL1_31
LCStoreCDB.php
Go to the documentation of this file.
1<?php
20use Cdb\Exception;
21use Cdb\Reader;
22use Cdb\Writer;
23
36class LCStoreCDB implements LCStore {
37
39 private $readers;
40
42 private $writer;
43
45 private $currentLang;
46
48 private $directory;
49
50 function __construct( $conf = [] ) {
51 global $wgCacheDirectory;
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}
serialize()
unserialize( $serialized)
$wgCacheDirectory
Directory for caching data in the local filesystem.
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
wfMkdirParents( $dir, $mode=null, $caller=null)
Make directory, and make all parent directories if they don't exist.
LCStore implementation which stores data as a collection of CDB files in the directory given by $wgCa...
bool string $directory
Cache directory.
string $currentLang
Current language code.
Writer $writer
startWrite( $code)
Start a write transaction.
getFileName( $code)
Reader[] $readers
__construct( $conf=[])
finishWrite()
Finish a write transaction.
MediaWiki exception.
An extension writer
Definition hooks.txt:51
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:865
returning false will NOT prevent logging $e
Definition hooks.txt:2176
Interface for the persistence layer of LocalisationCache.
Definition LCStore.php:38
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