MediaWiki  master
MessageBlobStore.php
Go to the documentation of this file.
1 <?php
28 
35 class MessageBlobStore implements LoggerAwareInterface {
36 
37  /* @var ResourceLoader */
38  private $resourceloader;
39 
43  protected $logger;
44 
48  protected $wanCache;
49 
54  public function __construct( ResourceLoader $rl, LoggerInterface $logger = null ) {
55  $this->resourceloader = $rl;
56  $this->logger = $logger ?: new NullLogger();
57  $this->wanCache = MediaWikiServices::getInstance()->getMainWANObjectCache();
58  }
59 
64  public function setLogger( LoggerInterface $logger ) {
65  $this->logger = $logger;
66  }
67 
76  public function getBlob( ResourceLoaderModule $module, $lang ) {
77  $blobs = $this->getBlobs( [ $module->getName() => $module ], $lang );
78  return $blobs[$module->getName()];
79  }
80 
89  public function getBlobs( array $modules, $lang ) {
90  // Each cache key for a message blob by module name and language code also has a generic
91  // check key without language code. This is used to invalidate any and all language subkeys
92  // that exist for a module from the updateMessage() method.
94  $checkKeys = [
95  // Global check key, see clear()
96  $cache->makeGlobalKey( __CLASS__ )
97  ];
98  $cacheKeys = [];
99  foreach ( $modules as $name => $module ) {
100  $cacheKey = $this->makeCacheKey( $module, $lang );
101  $cacheKeys[$name] = $cacheKey;
102  // Per-module check key, see updateMessage()
103  $checkKeys[$cacheKey][] = $cache->makeKey( __CLASS__, $name );
104  }
105  $curTTLs = [];
106  $result = $cache->getMulti( array_values( $cacheKeys ), $curTTLs, $checkKeys );
107 
108  $blobs = [];
109  foreach ( $modules as $name => $module ) {
110  $key = $cacheKeys[$name];
111  if ( !isset( $result[$key] ) || $curTTLs[$key] === null || $curTTLs[$key] < 0 ) {
112  $blobs[$name] = $this->recacheMessageBlob( $key, $module, $lang );
113  } else {
114  // Use unexpired cache
115  $blobs[$name] = $result[$key];
116  }
117  }
118  return $blobs;
119  }
120 
127  private function makeCacheKey( ResourceLoaderModule $module, $lang ) {
128  $messages = array_values( array_unique( $module->getMessages() ) );
129  sort( $messages );
130  return $this->wanCache->makeKey( __CLASS__, $module->getName(), $lang,
131  md5( json_encode( $messages ) )
132  );
133  }
134 
142  protected function recacheMessageBlob( $cacheKey, ResourceLoaderModule $module, $lang ) {
143  $blob = $this->generateMessageBlob( $module, $lang );
145  $cache->set( $cacheKey, $blob,
146  // Add part of a day to TTL to avoid all modules expiring at once
147  $cache::TTL_WEEK + mt_rand( 0, $cache::TTL_DAY ),
148  Database::getCacheSetOptions( wfGetDB( DB_REPLICA ) )
149  );
150  return $blob;
151  }
152 
159  public function updateMessage( $key ) {
160  $moduleNames = $this->getResourceLoader()->getModulesByMessage( $key );
161  foreach ( $moduleNames as $moduleName ) {
162  // Uses a holdoff to account for database replica DB lag (for MessageCache)
163  $this->wanCache->touchCheckKey( $this->wanCache->makeKey( __CLASS__, $moduleName ) );
164  }
165  }
166 
171  public function clear() {
173  // Disable hold-off because:
174  // - LocalisationCache is populated by messages on-disk and don't have DB lag,
175  // thus there is no need for hold off. We only clear it after new localisation
176  // updates are known to be deployed to all servers.
177  // - This global check key invalidates message blobs for all modules for all wikis
178  // in cache contexts (e.g. languages, skins). Setting a hold-off on this key could
179  // cause a cache stampede since no values would be stored for several seconds.
180  $cache->touchCheckKey( $cache->makeGlobalKey( __CLASS__ ), $cache::HOLDOFF_NONE );
181  }
182 
187  protected function getResourceLoader() {
188  return $this->resourceloader;
189  }
190 
197  protected function fetchMessage( $key, $lang ) {
198  $message = wfMessage( $key )->inLanguage( $lang );
199  if ( !$message->exists() ) {
200  $this->logger->warning( 'Failed to find {messageKey} ({lang})', [
201  'messageKey' => $key,
202  'lang' => $lang,
203  ] );
204  $value = null;
205  } else {
206  $value = $message->plain();
207  }
208  return $value;
209  }
210 
218  private function generateMessageBlob( ResourceLoaderModule $module, $lang ) {
219  $messages = [];
220  foreach ( $module->getMessages() as $key ) {
221  $value = $this->fetchMessage( $key, $lang );
222  if ( $value !== null ) {
223  $messages[$key] = $value;
224  }
225  }
226 
227  $json = FormatJson::encode( (object)$messages );
228  // @codeCoverageIgnoreStart
229  if ( $json === false ) {
230  $this->logger->warning( 'Failed to encode message blob for {module} ({lang})', [
231  'module' => $module->getName(),
232  'lang' => $lang,
233  ] );
234  $json = '{}';
235  }
236  // codeCoverageIgnoreEnd
237  return $json;
238  }
239 }
This class generates message blobs for use by ResourceLoader modules.
getMessages()
Get the messages needed for this module.
Abstraction for ResourceLoader modules, with name registration and maxage functionality.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
fetchMessage( $key, $lang)
if(!isset( $args[0])) $lang
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
$value
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 MediaWikiServices
Definition: injection.txt:23
static encode( $value, $pretty=false, $escaping=0)
Returns the JSON representation of a value.
Definition: FormatJson.php:115
setLogger(LoggerInterface $logger)
WANObjectCache $wanCache
recacheMessageBlob( $cacheKey, ResourceLoaderModule $module, $lang)
LoggerInterface $logger
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=(\*-\*)") 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. '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 '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 since 1.28! 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:1969
$modules
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 use $formDescriptor instead 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
getBlobs(array $modules, $lang)
Get the message blobs for a set of modules.
$cache
Definition: mcc.php:33
clear()
Invalidate cache keys for all known modules.
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:767
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
makeCacheKey(ResourceLoaderModule $module, $lang)
updateMessage( $key)
Invalidate cache keys for modules using this message key.
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
generateMessageBlob(ResourceLoaderModule $module, $lang)
Generate the message blob for a given module in a given language.
getBlob(ResourceLoaderModule $module, $lang)
Get the message blob for a module.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
$messages
const DB_REPLICA
Definition: defines.php:25
__construct(ResourceLoader $rl, LoggerInterface $logger=null)
getName()
Get this module&#39;s name.