0ffe341629
== Ungroup file blocks Remove `@ingroup` from `@file` blocks and keep only the class block. This matches similar changes previously applied to API, Skins, Profile, and ResourceLoader. This helps make the API documentation easier to navigate. E.g. Modules -> Language in the sidebar of <https://doc.wikimedia.org/mediawiki-core/master/php/> as well as <https://doc.wikimedia.org/mediawiki-core/master/php/group__Language.html> These are currently cluttered with tons of duplicate entries for files and classes both. We only need to group files that aren't also documented as a class (e.g. message files, entry points, other scripts or files that we mainly consider a data file). This has the helpful side-effect that we don't encourage duplication of the class description (or worse, place useful docs only in the file block), and makes the class files consistently start with a mentally ignorable block. Basically, unless there's something other than a class, don't describe or group the file itself. == Missing group Various classes in this subtree were missing the `Language` group, or were using different group from before T225756. == Subgroup For ease of navigation, move Converter subclasses to a group called "Languages", which for documentation purposes is a subgroup of "Language". The next commit does the same for Messages* files, and Language subclasses (done separately for ease of review). Change-Id: I301f471f86ba2dee924fece29a16dc3c20b5bebe
129 lines
3.3 KiB
PHP
129 lines
3.3 KiB
PHP
<?php
|
|
/**
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
*/
|
|
|
|
/**
|
|
* LocalisationCache optimised for loading many languages at once.
|
|
*
|
|
* Used by maintenance/rebuildLocalisationCache.php.
|
|
*
|
|
* @ingroup Language
|
|
*/
|
|
class LocalisationCacheBulkLoad extends LocalisationCache {
|
|
|
|
/**
|
|
* A cache of the contents of data files.
|
|
* Core files are serialized to avoid using ~1GB of RAM during a recache.
|
|
*/
|
|
private $fileCache = [];
|
|
|
|
/**
|
|
* Most recently used languages. Uses the linked-list aspect of PHP hashtables
|
|
* to keep the most recently used language codes at the end of the array, and
|
|
* the language codes that are ready to be deleted at the beginning.
|
|
*/
|
|
private $mruLangs = [];
|
|
|
|
/**
|
|
* Maximum number of languages that may be loaded into $this->data
|
|
*/
|
|
private $maxLoadedLangs = 10;
|
|
|
|
/**
|
|
* @param string $fileName
|
|
* @param string $fileType
|
|
* @return array|mixed
|
|
*/
|
|
protected function readPHPFile( $fileName, $fileType ) {
|
|
$serialize = $fileType === 'core';
|
|
if ( !isset( $this->fileCache[$fileName][$fileType] ) ) {
|
|
$data = parent::readPHPFile( $fileName, $fileType );
|
|
|
|
if ( $serialize ) {
|
|
$encData = serialize( $data );
|
|
} else {
|
|
$encData = $data;
|
|
}
|
|
|
|
$this->fileCache[$fileName][$fileType] = $encData;
|
|
|
|
return $data;
|
|
} elseif ( $serialize ) {
|
|
return unserialize( $this->fileCache[$fileName][$fileType] );
|
|
} else {
|
|
return $this->fileCache[$fileName][$fileType];
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param string $code
|
|
* @param string $key
|
|
* @return mixed
|
|
*/
|
|
public function getItem( $code, $key ) {
|
|
unset( $this->mruLangs[$code] );
|
|
$this->mruLangs[$code] = true;
|
|
|
|
return parent::getItem( $code, $key );
|
|
}
|
|
|
|
/**
|
|
* @param string $code
|
|
* @param string $key
|
|
* @param string $subkey
|
|
* @return mixed
|
|
*/
|
|
public function getSubitem( $code, $key, $subkey ) {
|
|
unset( $this->mruLangs[$code] );
|
|
$this->mruLangs[$code] = true;
|
|
|
|
return parent::getSubitem( $code, $key, $subkey );
|
|
}
|
|
|
|
/**
|
|
* @param string $code
|
|
*/
|
|
public function recache( $code ) {
|
|
parent::recache( $code );
|
|
unset( $this->mruLangs[$code] );
|
|
$this->mruLangs[$code] = true;
|
|
$this->trimCache();
|
|
}
|
|
|
|
/**
|
|
* @param string $code
|
|
*/
|
|
public function unload( $code ) {
|
|
unset( $this->mruLangs[$code] );
|
|
parent::unload( $code );
|
|
}
|
|
|
|
/**
|
|
* Unload cached languages until there are less than $this->maxLoadedLangs
|
|
*/
|
|
protected function trimCache() {
|
|
while ( count( $this->data ) > $this->maxLoadedLangs && count( $this->mruLangs ) ) {
|
|
reset( $this->mruLangs );
|
|
$code = key( $this->mruLangs );
|
|
wfDebug( __METHOD__ . ": unloading $code" );
|
|
$this->unload( $code );
|
|
}
|
|
}
|
|
|
|
}
|