MediaWiki  REL1_31
MessageBlobStore.php
Go to the documentation of this file.
1 <?php
26 use Psr\Log\LoggerAwareInterface;
27 use Psr\Log\LoggerInterface;
28 use Psr\Log\NullLogger;
30 
37 class MessageBlobStore implements LoggerAwareInterface {
38 
39  /* @var ResourceLoader|null */
40  private $resourceloader;
41 
45  protected $logger;
46 
50  protected $wanCache;
51 
56  public function __construct( ResourceLoader $rl = null, LoggerInterface $logger = null ) {
57  $this->resourceloader = $rl;
58  $this->logger = $logger ?: new NullLogger();
59  $this->wanCache = ObjectCache::getMainWANInstance();
60  }
61 
66  public function setLogger( LoggerInterface $logger ) {
67  $this->logger = $logger;
68  }
69 
78  public function getBlob( ResourceLoaderModule $module, $lang ) {
79  $blobs = $this->getBlobs( [ $module->getName() => $module ], $lang );
80  return $blobs[$module->getName()];
81  }
82 
91  public function getBlobs( array $modules, $lang ) {
92  // Each cache key for a message blob by module name and language code also has a generic
93  // check key without language code. This is used to invalidate any and all language subkeys
94  // that exist for a module from the updateMessage() method.
96  $checkKeys = [
97  // Global check key, see clear()
98  $cache->makeKey( __CLASS__ )
99  ];
100  $cacheKeys = [];
101  foreach ( $modules as $name => $module ) {
102  $cacheKey = $this->makeCacheKey( $module, $lang );
103  $cacheKeys[$name] = $cacheKey;
104  // Per-module check key, see updateMessage()
105  $checkKeys[$cacheKey][] = $cache->makeKey( __CLASS__, $name );
106  }
107  $curTTLs = [];
108  $result = $cache->getMulti( array_values( $cacheKeys ), $curTTLs, $checkKeys );
109 
110  $blobs = [];
111  foreach ( $modules as $name => $module ) {
112  $key = $cacheKeys[$name];
113  if ( !isset( $result[$key] ) || $curTTLs[$key] === null || $curTTLs[$key] < 0 ) {
114  $blobs[$name] = $this->recacheMessageBlob( $key, $module, $lang );
115  } else {
116  // Use unexpired cache
117  $blobs[$name] = $result[$key];
118  }
119  }
120  return $blobs;
121  }
122 
127  public function get( ResourceLoader $resourceLoader, $modules, $lang ) {
128  return $this->getBlobs( $modules, $lang );
129  }
130 
137  private function makeCacheKey( ResourceLoaderModule $module, $lang ) {
138  $messages = array_values( array_unique( $module->getMessages() ) );
139  sort( $messages );
140  return $this->wanCache->makeKey( __CLASS__, $module->getName(), $lang,
141  md5( json_encode( $messages ) )
142  );
143  }
144 
152  protected function recacheMessageBlob( $cacheKey, ResourceLoaderModule $module, $lang ) {
153  $blob = $this->generateMessageBlob( $module, $lang );
155  $cache->set( $cacheKey, $blob,
156  // Add part of a day to TTL to avoid all modules expiring at once
157  $cache::TTL_WEEK + mt_rand( 0, $cache::TTL_DAY ),
158  Database::getCacheSetOptions( wfGetDB( DB_REPLICA ) )
159  );
160  return $blob;
161  }
162 
169  public function updateMessage( $key ) {
170  $moduleNames = $this->getResourceLoader()->getModulesByMessage( $key );
171  foreach ( $moduleNames as $moduleName ) {
172  // Uses a holdoff to account for database replica DB lag (for MessageCache)
173  $this->wanCache->touchCheckKey( $this->wanCache->makeKey( __CLASS__, $moduleName ) );
174  }
175  }
176 
181  public function clear() {
183  // Disable holdoff because this invalidates all modules and also not needed since
184  // LocalisationCache is stored outside the database and doesn't have lag.
185  $cache->touchCheckKey( $cache->makeKey( __CLASS__ ), $cache::HOLDOFF_NONE );
186  }
187 
192  protected function getResourceLoader() {
193  // Back-compat: This class supports instantiation without a ResourceLoader object.
194  // Lazy-initialise this property because most callers don't need it.
195  if ( $this->resourceloader === null ) {
196  $this->logger->warning( __CLASS__ . ' created without a ResourceLoader instance' );
197  $this->resourceloader = new ResourceLoader();
198  }
199  return $this->resourceloader;
200  }
201 
208  protected function fetchMessage( $key, $lang ) {
209  $message = wfMessage( $key )->inLanguage( $lang );
210  $value = $message->plain();
211  if ( !$message->exists() ) {
212  $this->logger->warning( 'Failed to find {messageKey} ({lang})', [
213  'messageKey' => $key,
214  'lang' => $lang,
215  ] );
216  }
217  return $value;
218  }
219 
227  private function generateMessageBlob( ResourceLoaderModule $module, $lang ) {
228  $messages = [];
229  foreach ( $module->getMessages() as $key ) {
230  $messages[$key] = $this->fetchMessage( $key, $lang );
231  }
232 
233  $json = FormatJson::encode( (object)$messages );
234  // @codeCoverageIgnoreStart
235  if ( $json === false ) {
236  $this->logger->warning( 'Failed to encode message blob for {module} ({lang})', [
237  'module' => $module->getName(),
238  'lang' => $lang,
239  ] );
240  $json = '{}';
241  }
242  // codeCoverageIgnoreEnd
243  return $json;
244  }
245 }
MessageBlobStore\getResourceLoader
getResourceLoader()
Definition: MessageBlobStore.php:192
Wikimedia\Rdbms\Database
Relational database abstraction object.
Definition: Database.php:48
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
wfMessage
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt
array
the array() calling protocol came about after MediaWiki 1.4rc1.
$lang
if(!isset( $args[0])) $lang
Definition: testCompression.php:33
MessageBlobStore\fetchMessage
fetchMessage( $key, $lang)
Definition: MessageBlobStore.php:208
MessageBlobStore\clear
clear()
Invalidate cache keys for all known modules.
Definition: MessageBlobStore.php:181
$resourceLoader
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 you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext such as when responding to a resource loader request or generating HTML output & $resourceLoader
Definition: hooks.txt:2818
$result
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=(\d*-\d*)") 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. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) '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 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) '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! 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:1993
php
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:37
FormatJson\encode
static encode( $value, $pretty=false, $escaping=0)
Returns the JSON representation of a value.
Definition: FormatJson.php:127
MessageBlobStore\updateMessage
updateMessage( $key)
Invalidate cache keys for modules using this message key.
Definition: MessageBlobStore.php:169
$blob
$blob
Definition: testCompression.php:65
MessageBlobStore\__construct
__construct(ResourceLoader $rl=null, LoggerInterface $logger=null)
Definition: MessageBlobStore.php:56
wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:2812
MessageBlobStore\$resourceloader
$resourceloader
Definition: MessageBlobStore.php:40
$modules
$modules
Definition: HTMLFormElement.php:12
DB_REPLICA
const DB_REPLICA
Definition: defines.php:25
MessageBlobStore\$logger
LoggerInterface $logger
Definition: MessageBlobStore.php:45
$value
$value
Definition: styleTest.css.php:45
MessageBlobStore\setLogger
setLogger(LoggerInterface $logger)
Definition: MessageBlobStore.php:66
WANObjectCache
Multi-datacenter aware caching interface.
Definition: WANObjectCache.php:87
ResourceLoaderModule\getMessages
getMessages()
Get the messages needed for this module.
Definition: ResourceLoaderModule.php:305
MessageBlobStore\makeCacheKey
makeCacheKey(ResourceLoaderModule $module, $lang)
Definition: MessageBlobStore.php:137
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
ResourceLoaderModule
Abstraction for ResourceLoader modules, with name registration and maxage functionality.
Definition: ResourceLoaderModule.php:35
ResourceLoader
Dynamic JavaScript and CSS resource loading system.
Definition: ResourceLoader.php:38
$cache
$cache
Definition: mcc.php:33
ObjectCache\getMainWANInstance
static getMainWANInstance()
Get the main WAN cache object.
Definition: ObjectCache.php:380
MessageBlobStore\generateMessageBlob
generateMessageBlob(ResourceLoaderModule $module, $lang)
Generate the message blob for a given module in a given language.
Definition: MessageBlobStore.php:227
as
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:22
MessageBlobStore\getBlobs
getBlobs(array $modules, $lang)
Get the message blobs for a set of modules.
Definition: MessageBlobStore.php:91
MessageBlobStore
This class generates message blobs for use by ResourceLoader modules.
Definition: MessageBlobStore.php:37
MessageBlobStore\$wanCache
WANObjectCache $wanCache
Definition: MessageBlobStore.php:50
MessageBlobStore\getBlob
getBlob(ResourceLoaderModule $module, $lang)
Get the message blob for a module.
Definition: MessageBlobStore.php:78
ResourceLoaderModule\getName
getName()
Get this module's name.
Definition: ResourceLoaderModule.php:102
$messages
$messages
Definition: LogTests.i18n.php:8
MessageBlobStore\recacheMessageBlob
recacheMessageBlob( $cacheKey, ResourceLoaderModule $module, $lang)
Definition: MessageBlobStore.php:152