1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
|
<?php
# Message cache
# Performs various useful MediaWiki namespace-related functions
define( "MSG_LOAD_TIMEOUT", 60);
define( "MSG_LOCK_TIMEOUT", 10);
define( "MSG_WAIT_TIMEOUT", 10);
class MessageCache
{
var $mCache, $mUseCache, $mDisable, $mExpiry;
var $mMemcKey, $mKeys, $mParserOptions, $mParser;
var $mExtensionMessages;
var $mInitialised = false;
function initialise( &$memCached, $useDB, $expiry, $memcPrefix ) {
$this->mUseCache = !is_null( $memCached );
$this->mMemc = &$memCached;
$this->mDisable = !$useDB;
$this->mExpiry = $expiry;
$this->mDisableTransform = false;
$this->mMemcKey = "$memcPrefix:messages";
$this->mKeys = false; # initialised on demand
$this->mInitialised = true;
$this->mParserOptions = ParserOptions::newFromUser( $u=NULL );
$this->mParser = new Parser;
$this->load();
}
# Loads messages either from memcached or the database, if not disabled
# On error, quietly switches to a fallback mode
# Returns false for a reportable error, true otherwise
function load() {
global $wgAllMessagesEn;
if ( $this->mDisable ) {
wfDebug( "MessageCache::load(): disabled\n" );
return true;
}
$success = true;
if ( $this->mUseCache ) {
$this->mCache = $this->mMemc->get( $this->mMemcKey );
# If there's nothing in memcached, load all the messages from the database
if ( !$this->mCache ) {
wfDebug( "MessageCache::load(): loading all messages\n" );
$this->lock();
# Other threads don't need to load the messages if another thread is doing it.
$success = $this->mMemc->set( $this->mMemcKey, "loading", MSG_LOAD_TIMEOUT );
if ( $success ) {
$this->loadFromDB();
# Save in memcached
# Keep trying if it fails, this is kind of important
for ( $i=0; $i<20 && !$this->mMemc->set( $this->mMemcKey, $this->mCache, $this->mExpiry ); $i++ ) {
usleep(mt_rand(500000,1500000));
}
if ( $i == 20 ) {
$this->mMemc->set( $this->mMemcKey, "error", 86400 );
wfDebug( "MemCached set error in MessageCache: restart memcached server!\n" );
}
}
$this->unlock();
}
if ( !is_array( $this->mCache ) ) {
wfMsg( "MessageCache::load(): individual message mode\n" );
# If it is 'loading' or 'error', switch to individual message mode, otherwise disable
# Causing too much DB load, disabling -- TS
$this->mDisable = true;
/*
if ( $this->mCache == "loading" ) {
$this->mUseCache = false;
} elseif ( $this->mCache == "error" ) {
$this->mUseCache = false;
$success = false;
} else {
$this->mDisable = true;
$success = false;
}*/
$this->mCache = false;
}
}
return $success;
}
# Loads all cacheable messages from the database
function loadFromDB()
{
$fname = "MessageCache::loadFromDB";
$dbr =& wfGetDB( DB_SLAVE );
$res = $dbr->select( 'cur',
array( 'cur_title', 'cur_text' ),
array( 'cur_is_redirect' => 0, 'cur_namespace' => NS_MEDIAWIKI ),
$fname
);
$this->mCache = array();
for ( $row = $dbr->fetchObject( $res ); $row; $row = $dbr->fetchObject( $res ) ) {
$this->mCache[$row->cur_title] = $row->cur_text;
}
$dbr->freeResult( $res );
}
# Not really needed anymore
function getKeys() {
global $wgAllMessagesEn, $wgLang;
if ( !$this->mKeys ) {
$this->mKeys = array();
foreach ( $wgAllMessagesEn as $key => $value ) {
array_push( $this->mKeys, $wgLang->ucfirst( $key ) );
}
}
return $this->mKeys;
}
# Obsolete
function isCacheable( $key ) {
return true;
/*
global $wgAllMessagesEn, $wgLang;
return array_key_exists( $wgLang->lcfirst( $key ), $wgAllMessagesEn ) ||
array_key_exists( $key, $wgAllMessagesEn );
*/
}
function replace( $title, $text ) {
$this->lock();
$this->load();
if ( is_array( $this->mCache ) ) {
$this->mCache[$title] = $text;
$this->mMemc->set( $this->mMemcKey, $this->mCache, $this->mExpiry );
}
$this->unlock();
}
# Returns success
# Represents a write lock on the messages key
function lock() {
if ( !$this->mUseCache ) {
return true;
}
$lockKey = $this->mMemcKey . "lock";
for ($i=0; $i < MSG_WAIT_TIMEOUT && !$this->mMemc->add( $lockKey, 1, MSG_LOCK_TIMEOUT ); $i++ ) {
sleep(1);
}
return $i >= MSG_WAIT_TIMEOUT;
}
function unlock() {
if ( !$this->mUseCache ) {
return;
}
$lockKey = $this->mMemcKey . "lock";
$this->mMemc->delete( $lockKey );
}
function get( $key, $useDB ) {
global $wgLang, $wgLanguageCode;
# If uninitialised, someone is trying to call this halfway through Setup.php
if ( !$this->mInitialised ) {
return "<$key>";
}
$message = false;
if ( !$this->mDisable ) {
$title = $wgLang->ucfirst( $key );
# Try the cache
if ( $this->mUseCache && $this->mCache && array_key_exists( $title, $this->mCache ) ) {
$message = $this->mCache[$title];
}
# If it wasn't in the cache, load each message from the DB individually
if ( !$message && $useDB) {
$dbr =& wfGetDB( DB_SLAVE );
$result = $dbr->getArray( "cur", array("cur_text"),
array( "cur_namespace" => NS_MEDIAWIKI, "cur_title" => $title ),
"MessageCache::get" );
if ( $result ) {
$message = $result->cur_text;
}
}
}
# Try the extension array
if ( !$message ) {
$message = @$this->mExtensionMessages[$key];
}
# Try the array in $wgLang
if ( !$message ) {
$message = $wgLang->getMessage( $key );
}
# Try the English array
if ( !$message && $wgLanguageCode != "en" ) {
$message = Language::getMessage( $key );
}
# Final fallback
if ( !$message ) {
$message = "<$key>";
}
# Replace brace tags
$message = $this->transform( $message );
return $message;
}
function transform( $message ) {
if( !$this->mDisableTransform ) {
if ( strstr( $message, "{{" ) !== false ) {
$message = $this->mParser->transformMsg( $message, $this->mParserOptions );
}
}
return $message;
}
function disable() { $this->mDisable = true; }
function enable() { $this->mDisable = false; }
function disableTransform() { $this->mDisableTransform = true; }
function addMessage( $key, $value ) {
$this->mExtensionMessages[$key] = $value;
}
function addMessages( $messages ) {
foreach ( $messages as $key => $value ) {
$this->mExtensionMessages[$key] = $value;
}
}
}
?>
|
