Current File : //data/www_bck/varak.net_bck/havranipapuce.varak.net/languages/Language.php
<?php
/**
* Internationalisation code.
*
* 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
* @ingroup Language
*/
/**
* @defgroup Language Language
*/
if ( !defined( 'MEDIAWIKI' ) ) {
echo "This file is part of MediaWiki, it is not a valid entry point.\n";
exit( 1 );
}
if ( function_exists( 'mb_strtoupper' ) ) {
mb_internal_encoding( 'UTF-8' );
}
/**
* Internationalisation code
* @ingroup Language
*/
class Language {
/**
* @var LanguageConverter
*/
public $mConverter;
public $mVariants, $mCode, $mLoaded = false;
public $mMagicExtensions = array(), $mMagicHookDone = false;
private $mHtmlCode = null, $mParentLanguage = false;
public $dateFormatStrings = array();
public $mExtendedSpecialPageAliases;
protected $namespaceNames, $mNamespaceIds, $namespaceAliases;
/**
* ReplacementArray object caches
*/
public $transformData = array();
/**
* @var LocalisationCache
*/
static public $dataCache;
static public $mLangObjCache = array();
static public $mWeekdayMsgs = array(
'sunday', 'monday', 'tuesday', 'wednesday', 'thursday',
'friday', 'saturday'
);
static public $mWeekdayAbbrevMsgs = array(
'sun', 'mon', 'tue', 'wed', 'thu', 'fri', 'sat'
);
static public $mMonthMsgs = array(
'january', 'february', 'march', 'april', 'may_long', 'june',
'july', 'august', 'september', 'october', 'november',
'december'
);
static public $mMonthGenMsgs = array(
'january-gen', 'february-gen', 'march-gen', 'april-gen', 'may-gen', 'june-gen',
'july-gen', 'august-gen', 'september-gen', 'october-gen', 'november-gen',
'december-gen'
);
static public $mMonthAbbrevMsgs = array(
'jan', 'feb', 'mar', 'apr', 'may', 'jun', 'jul', 'aug',
'sep', 'oct', 'nov', 'dec'
);
static public $mIranianCalendarMonthMsgs = array(
'iranian-calendar-m1', 'iranian-calendar-m2', 'iranian-calendar-m3',
'iranian-calendar-m4', 'iranian-calendar-m5', 'iranian-calendar-m6',
'iranian-calendar-m7', 'iranian-calendar-m8', 'iranian-calendar-m9',
'iranian-calendar-m10', 'iranian-calendar-m11', 'iranian-calendar-m12'
);
static public $mHebrewCalendarMonthMsgs = array(
'hebrew-calendar-m1', 'hebrew-calendar-m2', 'hebrew-calendar-m3',
'hebrew-calendar-m4', 'hebrew-calendar-m5', 'hebrew-calendar-m6',
'hebrew-calendar-m7', 'hebrew-calendar-m8', 'hebrew-calendar-m9',
'hebrew-calendar-m10', 'hebrew-calendar-m11', 'hebrew-calendar-m12',
'hebrew-calendar-m6a', 'hebrew-calendar-m6b'
);
static public $mHebrewCalendarMonthGenMsgs = array(
'hebrew-calendar-m1-gen', 'hebrew-calendar-m2-gen', 'hebrew-calendar-m3-gen',
'hebrew-calendar-m4-gen', 'hebrew-calendar-m5-gen', 'hebrew-calendar-m6-gen',
'hebrew-calendar-m7-gen', 'hebrew-calendar-m8-gen', 'hebrew-calendar-m9-gen',
'hebrew-calendar-m10-gen', 'hebrew-calendar-m11-gen', 'hebrew-calendar-m12-gen',
'hebrew-calendar-m6a-gen', 'hebrew-calendar-m6b-gen'
);
static public $mHijriCalendarMonthMsgs = array(
'hijri-calendar-m1', 'hijri-calendar-m2', 'hijri-calendar-m3',
'hijri-calendar-m4', 'hijri-calendar-m5', 'hijri-calendar-m6',
'hijri-calendar-m7', 'hijri-calendar-m8', 'hijri-calendar-m9',
'hijri-calendar-m10', 'hijri-calendar-m11', 'hijri-calendar-m12'
);
/**
* @since 1.20
* @var array
*/
static public $durationIntervals = array(
'millennia' => 31556952000,
'centuries' => 3155695200,
'decades' => 315569520,
'years' => 31556952, // 86400 * ( 365 + ( 24 * 3 + 25 ) / 400 )
'weeks' => 604800,
'days' => 86400,
'hours' => 3600,
'minutes' => 60,
'seconds' => 1,
);
/**
* Cache for language fallbacks.
* @see Language::getFallbacksIncludingSiteLanguage
* @since 1.21
* @var array
*/
static private $fallbackLanguageCache = array();
/**
* Cache for language names
* @var MapCacheLRU|null
*/
static private $languageNameCache;
/**
* Get a cached or new language object for a given language code
* @param string $code
* @return Language
*/
static function factory( $code ) {
global $wgDummyLanguageCodes, $wgLangObjCacheSize;
if ( isset( $wgDummyLanguageCodes[$code] ) ) {
$code = $wgDummyLanguageCodes[$code];
}
// get the language object to process
$langObj = isset( self::$mLangObjCache[$code] )
? self::$mLangObjCache[$code]
: self::newFromCode( $code );
// merge the language object in to get it up front in the cache
self::$mLangObjCache = array_merge( array( $code => $langObj ), self::$mLangObjCache );
// get rid of the oldest ones in case we have an overflow
self::$mLangObjCache = array_slice( self::$mLangObjCache, 0, $wgLangObjCacheSize, true );
return $langObj;
}
/**
* Create a language object for a given language code
* @param string $code
* @throws MWException
* @return Language
*/
protected static function newFromCode( $code ) {
// Protect against path traversal below
if ( !Language::isValidCode( $code )
|| strcspn( $code, ":/\\\000" ) !== strlen( $code )
) {
throw new MWException( "Invalid language code \"$code\"" );
}
if ( !Language::isValidBuiltInCode( $code ) ) {
// It's not possible to customise this code with class files, so
// just return a Language object. This is to support uselang= hacks.
$lang = new Language;
$lang->setCode( $code );
return $lang;
}
// Check if there is a language class for the code
$class = self::classFromCode( $code );
self::preloadLanguageClass( $class );
if ( class_exists( $class ) ) {
$lang = new $class;
return $lang;
}
// Keep trying the fallback list until we find an existing class
$fallbacks = Language::getFallbacksFor( $code );
foreach ( $fallbacks as $fallbackCode ) {
if ( !Language::isValidBuiltInCode( $fallbackCode ) ) {
throw new MWException( "Invalid fallback '$fallbackCode' in fallback sequence for '$code'" );
}
$class = self::classFromCode( $fallbackCode );
self::preloadLanguageClass( $class );
if ( class_exists( $class ) ) {
$lang = Language::newFromCode( $fallbackCode );
$lang->setCode( $code );
return $lang;
}
}
throw new MWException( "Invalid fallback sequence for language '$code'" );
}
/**
* Checks whether any localisation is available for that language tag
* in MediaWiki (MessagesXx.php exists).
*
* @param string $code Language tag (in lower case)
* @return bool Whether language is supported
* @since 1.21
*/
public static function isSupportedLanguage( $code ) {
return self::isValidBuiltInCode( $code )
&& ( is_readable( self::getMessagesFileName( $code ) )
|| is_readable( self::getJsonMessagesFileName( $code ) )
);
}
/**
* Returns true if a language code string is a well-formed language tag
* according to RFC 5646.
* This function only checks well-formedness; it doesn't check that
* language, script or variant codes actually exist in the repositories.
*
* Based on regexes by Mark Davis of the Unicode Consortium:
* http://unicode.org/repos/cldr/trunk/tools/java/org/unicode/cldr/util/data/langtagRegex.txt
*
* @param string $code
* @param bool $lenient Whether to allow '_' as separator. The default is only '-'.
*
* @return bool
* @since 1.21
*/
public static function isWellFormedLanguageTag( $code, $lenient = false ) {
$alpha = '[a-z]';
$digit = '[0-9]';
$alphanum = '[a-z0-9]';
$x = 'x'; # private use singleton
$singleton = '[a-wy-z]'; # other singleton
$s = $lenient ? '[-_]' : '-';
$language = "$alpha{2,8}|$alpha{2,3}$s$alpha{3}";
$script = "$alpha{4}"; # ISO 15924
$region = "(?:$alpha{2}|$digit{3})"; # ISO 3166-1 alpha-2 or UN M.49
$variant = "(?:$alphanum{5,8}|$digit$alphanum{3})";
$extension = "$singleton(?:$s$alphanum{2,8})+";
$privateUse = "$x(?:$s$alphanum{1,8})+";
# Define certain grandfathered codes, since otherwise the regex is pretty useless.
# Since these are limited, this is safe even later changes to the registry --
# the only oddity is that it might change the type of the tag, and thus
# the results from the capturing groups.
# http://www.iana.org/assignments/language-subtag-registry
$grandfathered = "en{$s}GB{$s}oed"
. "|i{$s}(?:ami|bnn|default|enochian|hak|klingon|lux|mingo|navajo|pwn|tao|tay|tsu)"
. "|no{$s}(?:bok|nyn)"
. "|sgn{$s}(?:BE{$s}(?:fr|nl)|CH{$s}de)"
. "|zh{$s}min{$s}nan";
$variantList = "$variant(?:$s$variant)*";
$extensionList = "$extension(?:$s$extension)*";
$langtag = "(?:($language)"
. "(?:$s$script)?"
. "(?:$s$region)?"
. "(?:$s$variantList)?"
. "(?:$s$extensionList)?"
. "(?:$s$privateUse)?)";
# The final breakdown, with capturing groups for each of these components
# The variants, extensions, grandfathered, and private-use may have interior '-'
$root = "^(?:$langtag|$privateUse|$grandfathered)$";
return (bool)preg_match( "/$root/", strtolower( $code ) );
}
/**
* Returns true if a language code string is of a valid form, whether or
* not it exists. This includes codes which are used solely for
* customisation via the MediaWiki namespace.
*
* @param string $code
*
* @return bool
*/
public static function isValidCode( $code ) {
static $cache = array();
if ( isset( $cache[$code] ) ) {
return $cache[$code];
}
// People think language codes are html safe, so enforce it.
// Ideally we should only allow a-zA-Z0-9-
// but, .+ and other chars are often used for {{int:}} hacks
// see bugs 37564, 37587, 36938
$cache[$code] =
strcspn( $code, ":/\\\000&<>'\"" ) === strlen( $code )
&& !preg_match( MediaWikiTitleCodec::getTitleInvalidRegex(), $code );
return $cache[$code];
}
/**
* Returns true if a language code is of a valid form for the purposes of
* internal customisation of MediaWiki, via Messages*.php or *.json.
*
* @param string $code
*
* @throws MWException
* @since 1.18
* @return bool
*/
public static function isValidBuiltInCode( $code ) {
if ( !is_string( $code ) ) {
if ( is_object( $code ) ) {
$addmsg = " of class " . get_class( $code );
} else {
$addmsg = '';
}
$type = gettype( $code );
throw new MWException( __METHOD__ . " must be passed a string, $type given$addmsg" );
}
return (bool)preg_match( '/^[a-z0-9-]{2,}$/', $code );
}
/**
* Returns true if a language code is an IETF tag known to MediaWiki.
*
* @param string $tag
*
* @since 1.21
* @return bool
*/
public static function isKnownLanguageTag( $tag ) {
static $coreLanguageNames;
// Quick escape for invalid input to avoid exceptions down the line
// when code tries to process tags which are not valid at all.
if ( !self::isValidBuiltInCode( $tag ) ) {
return false;
}
if ( $coreLanguageNames === null ) {
global $IP;
include "$IP/languages/Names.php";
}
if ( isset( $coreLanguageNames[$tag] )
|| self::fetchLanguageName( $tag, $tag ) !== ''
) {
return true;
}
return false;
}
/**
* @param string $code
* @return string Name of the language class
*/
public static function classFromCode( $code ) {
if ( $code == 'en' ) {
return 'Language';
} else {
return 'Language' . str_replace( '-', '_', ucfirst( $code ) );
}
}
/**
* Includes language class files
*
* @param string $class Name of the language class
*/
public static function preloadLanguageClass( $class ) {
global $IP;
if ( $class === 'Language' ) {
return;
}
if ( file_exists( "$IP/languages/classes/$class.php" ) ) {
include_once "$IP/languages/classes/$class.php";
}
}
/**
* Get the LocalisationCache instance
*
* @return LocalisationCache
*/
public static function getLocalisationCache() {
if ( is_null( self::$dataCache ) ) {
global $wgLocalisationCacheConf;
$class = $wgLocalisationCacheConf['class'];
self::$dataCache = new $class( $wgLocalisationCacheConf );
}
return self::$dataCache;
}
function __construct() {
$this->mConverter = new FakeConverter( $this );
// Set the code to the name of the descendant
if ( get_class( $this ) == 'Language' ) {
$this->mCode = 'en';
} else {
$this->mCode = str_replace( '_', '-', strtolower( substr( get_class( $this ), 8 ) ) );
}
self::getLocalisationCache();
}
/**
* Reduce memory usage
*/
function __destruct() {
foreach ( $this as $name => $value ) {
unset( $this->$name );
}
}
/**
* Hook which will be called if this is the content language.
* Descendants can use this to register hook functions or modify globals
*/
function initContLang() {
}
/**
* @return array
* @since 1.19
*/
function getFallbackLanguages() {
return self::getFallbacksFor( $this->mCode );
}
/**
* Exports $wgBookstoreListEn
* @return array
*/
function getBookstoreList() {
return self::$dataCache->getItem( $this->mCode, 'bookstoreList' );
}
/**
* Returns an array of localised namespaces indexed by their numbers. If the namespace is not
* available in localised form, it will be included in English.
*
* @return array
*/
public function getNamespaces() {
if ( is_null( $this->namespaceNames ) ) {
global $wgMetaNamespace, $wgMetaNamespaceTalk, $wgExtraNamespaces;
$this->namespaceNames = self::$dataCache->getItem( $this->mCode, 'namespaceNames' );
$validNamespaces = MWNamespace::getCanonicalNamespaces();
$this->namespaceNames = $wgExtraNamespaces + $this->namespaceNames + $validNamespaces;
$this->namespaceNames[NS_PROJECT] = $wgMetaNamespace;
if ( $wgMetaNamespaceTalk ) {
$this->namespaceNames[NS_PROJECT_TALK] = $wgMetaNamespaceTalk;
} else {
$talk = $this->namespaceNames[NS_PROJECT_TALK];
$this->namespaceNames[NS_PROJECT_TALK] =
$this->fixVariableInNamespace( $talk );
}
# Sometimes a language will be localised but not actually exist on this wiki.
foreach ( $this->namespaceNames as $key => $text ) {
if ( !isset( $validNamespaces[$key] ) ) {
unset( $this->namespaceNames[$key] );
}
}
# The above mixing may leave namespaces out of canonical order.
# Re-order by namespace ID number...
ksort( $this->namespaceNames );
Hooks::run( 'LanguageGetNamespaces', array( &$this->namespaceNames ) );
}
return $this->namespaceNames;
}
/**
* Arbitrarily set all of the namespace names at once. Mainly used for testing
* @param array $namespaces Array of namespaces (id => name)
*/
public function setNamespaces( array $namespaces ) {
$this->namespaceNames = $namespaces;
$this->mNamespaceIds = null;
}
/**
* Resets all of the namespace caches. Mainly used for testing
*/
public function resetNamespaces() {
$this->namespaceNames = null;
$this->mNamespaceIds = null;
$this->namespaceAliases = null;
}
/**
* A convenience function that returns the same thing as
* getNamespaces() except with the array values changed to ' '
* where it found '_', useful for producing output to be displayed
* e.g. in <select> forms.
*
* @return array
*/
function getFormattedNamespaces() {
$ns = $this->getNamespaces();
foreach ( $ns as $k => $v ) {
$ns[$k] = strtr( $v, '_', ' ' );
}
return $ns;
}
/**
* Get a namespace value by key
* <code>
* $mw_ns = $wgContLang->getNsText( NS_MEDIAWIKI );
* echo $mw_ns; // prints 'MediaWiki'
* </code>
*
* @param int $index The array key of the namespace to return
* @return string|bool String if the namespace value exists, otherwise false
*/
function getNsText( $index ) {
$ns = $this->getNamespaces();
return isset( $ns[$index] ) ? $ns[$index] : false;
}
/**
* A convenience function that returns the same thing as
* getNsText() except with '_' changed to ' ', useful for
* producing output.
*
* <code>
* $mw_ns = $wgContLang->getFormattedNsText( NS_MEDIAWIKI_TALK );
* echo $mw_ns; // prints 'MediaWiki talk'
* </code>
*
* @param int $index The array key of the namespace to return
* @return string Namespace name without underscores (empty string if namespace does not exist)
*/
function getFormattedNsText( $index ) {
$ns = $this->getNsText( $index );
return strtr( $ns, '_', ' ' );
}
/**
* Returns gender-dependent namespace alias if available.
* See https://www.mediawiki.org/wiki/Manual:$wgExtraGenderNamespaces
* @param int $index Namespace index
* @param string $gender Gender key (male, female... )
* @return string
* @since 1.18
*/
function getGenderNsText( $index, $gender ) {
global $wgExtraGenderNamespaces;
$ns = $wgExtraGenderNamespaces +
(array)self::$dataCache->getItem( $this->mCode, 'namespaceGenderAliases' );
return isset( $ns[$index][$gender] ) ? $ns[$index][$gender] : $this->getNsText( $index );
}
/**
* Whether this language uses gender-dependent namespace aliases.
* See https://www.mediawiki.org/wiki/Manual:$wgExtraGenderNamespaces
* @return bool
* @since 1.18
*/
function needsGenderDistinction() {
global $wgExtraGenderNamespaces, $wgExtraNamespaces;
if ( count( $wgExtraGenderNamespaces ) > 0 ) {
// $wgExtraGenderNamespaces overrides everything
return true;
} elseif ( isset( $wgExtraNamespaces[NS_USER] ) && isset( $wgExtraNamespaces[NS_USER_TALK] ) ) {
/// @todo There may be other gender namespace than NS_USER & NS_USER_TALK in the future
// $wgExtraNamespaces overrides any gender aliases specified in i18n files
return false;
} else {
// Check what is in i18n files
$aliases = self::$dataCache->getItem( $this->mCode, 'namespaceGenderAliases' );
return count( $aliases ) > 0;
}
}
/**
* Get a namespace key by value, case insensitive.
* Only matches namespace names for the current language, not the
* canonical ones defined in Namespace.php.
*
* @param string $text
* @return int|bool An integer if $text is a valid value otherwise false
*/
function getLocalNsIndex( $text ) {
$lctext = $this->lc( $text );
$ids = $this->getNamespaceIds();
return isset( $ids[$lctext] ) ? $ids[$lctext] : false;
}
/**
* @return array
*/
function getNamespaceAliases() {
if ( is_null( $this->namespaceAliases ) ) {
$aliases = self::$dataCache->getItem( $this->mCode, 'namespaceAliases' );
if ( !$aliases ) {
$aliases = array();
} else {
foreach ( $aliases as $name => $index ) {
if ( $index === NS_PROJECT_TALK ) {
unset( $aliases[$name] );
$name = $this->fixVariableInNamespace( $name );
$aliases[$name] = $index;
}
}
}
global $wgExtraGenderNamespaces;
$genders = $wgExtraGenderNamespaces +
(array)self::$dataCache->getItem( $this->mCode, 'namespaceGenderAliases' );
foreach ( $genders as $index => $forms ) {
foreach ( $forms as $alias ) {
$aliases[$alias] = $index;
}
}
# Also add converted namespace names as aliases, to avoid confusion.
$convertedNames = array();
foreach ( $this->getVariants() as $variant ) {
if ( $variant === $this->mCode ) {
continue;
}
foreach ( $this->getNamespaces() as $ns => $_ ) {
$convertedNames[$this->getConverter()->convertNamespace( $ns, $variant )] = $ns;
}
}
$this->namespaceAliases = $aliases + $convertedNames;
}
return $this->namespaceAliases;
}
/**
* @return array
*/
function getNamespaceIds() {
if ( is_null( $this->mNamespaceIds ) ) {
global $wgNamespaceAliases;
# Put namespace names and aliases into a hashtable.
# If this is too slow, then we should arrange it so that it is done
# before caching. The catch is that at pre-cache time, the above
# class-specific fixup hasn't been done.
$this->mNamespaceIds = array();
foreach ( $this->getNamespaces() as $index => $name ) {
$this->mNamespaceIds[$this->lc( $name )] = $index;
}
foreach ( $this->getNamespaceAliases() as $name => $index ) {
$this->mNamespaceIds[$this->lc( $name )] = $index;
}
if ( $wgNamespaceAliases ) {
foreach ( $wgNamespaceAliases as $name => $index ) {
$this->mNamespaceIds[$this->lc( $name )] = $index;
}
}
}
return $this->mNamespaceIds;
}
/**
* Get a namespace key by value, case insensitive. Canonical namespace
* names override custom ones defined for the current language.
*
* @param string $text
* @return int|bool An integer if $text is a valid value otherwise false
*/
function getNsIndex( $text ) {
$lctext = $this->lc( $text );
$ns = MWNamespace::getCanonicalIndex( $lctext );
if ( $ns !== null ) {
return $ns;
}
$ids = $this->getNamespaceIds();
return isset( $ids[$lctext] ) ? $ids[$lctext] : false;
}
/**
* short names for language variants used for language conversion links.
*
* @param string $code
* @param bool $usemsg Use the "variantname-xyz" message if it exists
* @return string
*/
function getVariantname( $code, $usemsg = true ) {
$msg = "variantname-$code";
if ( $usemsg && wfMessage( $msg )->exists() ) {
return $this->getMessageFromDB( $msg );
}
$name = self::fetchLanguageName( $code );
if ( $name ) {
return $name; # if it's defined as a language name, show that
} else {
# otherwise, output the language code
return $code;
}
}
/**
* @deprecated since 1.24, doesn't handle conflicting aliases. Use
* SpecialPageFactory::getLocalNameFor instead.
* @param string $name
* @return string
*/
function specialPage( $name ) {
$aliases = $this->getSpecialPageAliases();
if ( isset( $aliases[$name][0] ) ) {
$name = $aliases[$name][0];
}
return $this->getNsText( NS_SPECIAL ) . ':' . $name;
}
/**
* @return array
*/
function getDatePreferences() {
return self::$dataCache->getItem( $this->mCode, 'datePreferences' );
}
/**
* @return array
*/
function getDateFormats() {
return self::$dataCache->getItem( $this->mCode, 'dateFormats' );
}
/**
* @return array|string
*/
function getDefaultDateFormat() {
$df = self::$dataCache->getItem( $this->mCode, 'defaultDateFormat' );
if ( $df === 'dmy or mdy' ) {
global $wgAmericanDates;
return $wgAmericanDates ? 'mdy' : 'dmy';
} else {
return $df;
}
}
/**
* @return array
*/
function getDatePreferenceMigrationMap() {
return self::$dataCache->getItem( $this->mCode, 'datePreferenceMigrationMap' );
}
/**
* @param string $image
* @return array|null
*/
function getImageFile( $image ) {
return self::$dataCache->getSubitem( $this->mCode, 'imageFiles', $image );
}
/**
* @return array
* @since 1.24
*/
function getImageFiles() {
return self::$dataCache->getItem( $this->mCode, 'imageFiles' );
}
/**
* @return array
*/
function getExtraUserToggles() {
return (array)self::$dataCache->getItem( $this->mCode, 'extraUserToggles' );
}
/**
* @param string $tog
* @return string
*/
function getUserToggle( $tog ) {
return $this->getMessageFromDB( "tog-$tog" );
}
/**
* Get native language names, indexed by code.
* Only those defined in MediaWiki, no other data like CLDR.
* If $customisedOnly is true, only returns codes with a messages file
*
* @param bool $customisedOnly
*
* @return array
* @deprecated since 1.20, use fetchLanguageNames()
*/
public static function getLanguageNames( $customisedOnly = false ) {
return self::fetchLanguageNames( null, $customisedOnly ? 'mwfile' : 'mw' );
}
/**
* Get translated language names. This is done on best effort and
* by default this is exactly the same as Language::getLanguageNames.
* The CLDR extension provides translated names.
* @param string $code Language code.
* @return array Language code => language name
* @since 1.18.0
* @deprecated since 1.20, use fetchLanguageNames()
*/
public static function getTranslatedLanguageNames( $code ) {
return self::fetchLanguageNames( $code, 'all' );
}
/**
* Get an array of language names, indexed by code.
* @param null|string $inLanguage Code of language in which to return the names
* Use null for autonyms (native names)
* @param string $include One of:
* 'all' all available languages
* 'mw' only if the language is defined in MediaWiki or wgExtraLanguageNames (default)
* 'mwfile' only if the language is in 'mw' *and* has a message file
* @return array Language code => language name
* @since 1.20
*/
public static function fetchLanguageNames( $inLanguage = null, $include = 'mw' ) {
$cacheKey = $inLanguage === null ? 'null' : $inLanguage;
$cacheKey .= ":$include";
if ( self::$languageNameCache === null ) {
self::$languageNameCache = new MapCacheLRU( 20 );
}
if ( self::$languageNameCache->has( $cacheKey ) ) {
$ret = self::$languageNameCache->get( $cacheKey );
} else {
$ret = self::fetchLanguageNamesUncached( $inLanguage, $include );
self::$languageNameCache->set( $cacheKey, $ret );
}
return $ret;
}
/**
* Uncached helper for fetchLanguageNames
* @param null|string $inLanguage Code of language in which to return the names
* Use null for autonyms (native names)
* @param string $include One of:
* 'all' all available languages
* 'mw' only if the language is defined in MediaWiki or wgExtraLanguageNames (default)
* 'mwfile' only if the language is in 'mw' *and* has a message file
* @return array Language code => language name
*/
private static function fetchLanguageNamesUncached( $inLanguage = null, $include = 'mw' ) {
global $wgExtraLanguageNames;
static $coreLanguageNames;
if ( $coreLanguageNames === null ) {
global $IP;
include "$IP/languages/Names.php";
}
// If passed an invalid language code to use, fallback to en
if ( $inLanguage !== null && !Language::isValidCode( $inLanguage ) ) {
$inLanguage = 'en';
}
$names = array();
if ( $inLanguage ) {
# TODO: also include when $inLanguage is null, when this code is more efficient
Hooks::run( 'LanguageGetTranslatedLanguageNames', array( &$names, $inLanguage ) );
}
$mwNames = $wgExtraLanguageNames + $coreLanguageNames;
foreach ( $mwNames as $mwCode => $mwName ) {
# - Prefer own MediaWiki native name when not using the hook
# - For other names just add if not added through the hook
if ( $mwCode === $inLanguage || !isset( $names[$mwCode] ) ) {
$names[$mwCode] = $mwName;
}
}
if ( $include === 'all' ) {
ksort( $names );
return $names;
}
$returnMw = array();
$coreCodes = array_keys( $mwNames );
foreach ( $coreCodes as $coreCode ) {
$returnMw[$coreCode] = $names[$coreCode];
}
if ( $include === 'mwfile' ) {
$namesMwFile = array();
# We do this using a foreach over the codes instead of a directory
# loop so that messages files in extensions will work correctly.
foreach ( $returnMw as $code => $value ) {
if ( is_readable( self::getMessagesFileName( $code ) )
|| is_readable( self::getJsonMessagesFileName( $code ) )
) {
$namesMwFile[$code] = $names[$code];
}
}
ksort( $namesMwFile );
return $namesMwFile;
}
ksort( $returnMw );
# 'mw' option; default if it's not one of the other two options (all/mwfile)
return $returnMw;
}
/**
* @param string $code The code of the language for which to get the name
* @param null|string $inLanguage Code of language in which to return the name (null for autonyms)
* @param string $include 'all', 'mw' or 'mwfile'; see fetchLanguageNames()
* @return string Language name or empty
* @since 1.20
*/
public static function fetchLanguageName( $code, $inLanguage = null, $include = 'all' ) {
$code = strtolower( $code );
$array = self::fetchLanguageNames( $inLanguage, $include );
return !array_key_exists( $code, $array ) ? '' : $array[$code];
}
/**
* Get a message from the MediaWiki namespace.
*
* @param string $msg Message name
* @return string
*/
function getMessageFromDB( $msg ) {
return $this->msg( $msg )->text();
}
/**
* Get message object in this language. Only for use inside this class.
*
* @param string $msg Message name
* @return Message
*/
protected function msg( $msg ) {
return wfMessage( $msg )->inLanguage( $this );
}
/**
* Get the native language name of $code.
* Only if defined in MediaWiki, no other data like CLDR.
* @param string $code
* @return string
* @deprecated since 1.20, use fetchLanguageName()
*/
function getLanguageName( $code ) {
return self::fetchLanguageName( $code );
}
/**
* @param string $key
* @return string
*/
function getMonthName( $key ) {
return $this->getMessageFromDB( self::$mMonthMsgs[$key - 1] );
}
/**
* @return array
*/
function getMonthNamesArray() {
$monthNames = array( '' );
for ( $i = 1; $i < 13; $i++ ) {
$monthNames[] = $this->getMonthName( $i );
}
return $monthNames;
}
/**
* @param string $key
* @return string
*/
function getMonthNameGen( $key ) {
return $this->getMessageFromDB( self::$mMonthGenMsgs[$key - 1] );
}
/**
* @param string $key
* @return string
*/
function getMonthAbbreviation( $key ) {
return $this->getMessageFromDB( self::$mMonthAbbrevMsgs[$key - 1] );
}
/**
* @return array
*/
function getMonthAbbreviationsArray() {
$monthNames = array( '' );
for ( $i = 1; $i < 13; $i++ ) {
$monthNames[] = $this->getMonthAbbreviation( $i );
}
return $monthNames;
}
/**
* @param string $key
* @return string
*/
function getWeekdayName( $key ) {
return $this->getMessageFromDB( self::$mWeekdayMsgs[$key - 1] );
}
/**
* @param string $key
* @return string
*/
function getWeekdayAbbreviation( $key ) {
return $this->getMessageFromDB( self::$mWeekdayAbbrevMsgs[$key - 1] );
}
/**
* @param string $key
* @return string
*/
function getIranianCalendarMonthName( $key ) {
return $this->getMessageFromDB( self::$mIranianCalendarMonthMsgs[$key - 1] );
}
/**
* @param string $key
* @return string
*/
function getHebrewCalendarMonthName( $key ) {
return $this->getMessageFromDB( self::$mHebrewCalendarMonthMsgs[$key - 1] );
}
/**
* @param string $key
* @return string
*/
function getHebrewCalendarMonthNameGen( $key ) {
return $this->getMessageFromDB( self::$mHebrewCalendarMonthGenMsgs[$key - 1] );
}
/**
* @param string $key
* @return string
*/
function getHijriCalendarMonthName( $key ) {
return $this->getMessageFromDB( self::$mHijriCalendarMonthMsgs[$key - 1] );
}
/**
* Pass through result from $dateTimeObj->format()
* @param DateTime|bool|null &$dateTimeObj
* @param string $ts
* @param DateTimeZone|bool|null $zone
* @param string $code
* @return string
*/
private static function dateTimeObjFormat( &$dateTimeObj, $ts, $zone, $code ) {
if ( !$dateTimeObj ) {
$dateTimeObj = DateTime::createFromFormat(
'YmdHis', $ts, $zone ?: new DateTimeZone( 'UTC' )
);
}
return $dateTimeObj->format( $code );
}
/**
* This is a workalike of PHP's date() function, but with better
* internationalisation, a reduced set of format characters, and a better
* escaping format.
*
* Supported format characters are dDjlNwzWFmMntLoYyaAgGhHiscrUeIOPTZ. See
* the PHP manual for definitions. There are a number of extensions, which
* start with "x":
*
* xn Do not translate digits of the next numeric format character
* xN Toggle raw digit (xn) flag, stays set until explicitly unset
* xr Use roman numerals for the next numeric format character
* xh Use hebrew numerals for the next numeric format character
* xx Literal x
* xg Genitive month name
*
* xij j (day number) in Iranian calendar
* xiF F (month name) in Iranian calendar
* xin n (month number) in Iranian calendar
* xiy y (two digit year) in Iranian calendar
* xiY Y (full year) in Iranian calendar
*
* xjj j (day number) in Hebrew calendar
* xjF F (month name) in Hebrew calendar
* xjt t (days in month) in Hebrew calendar
* xjx xg (genitive month name) in Hebrew calendar
* xjn n (month number) in Hebrew calendar
* xjY Y (full year) in Hebrew calendar
*
* xmj j (day number) in Hijri calendar
* xmF F (month name) in Hijri calendar
* xmn n (month number) in Hijri calendar
* xmY Y (full year) in Hijri calendar
*
* xkY Y (full year) in Thai solar calendar. Months and days are
* identical to the Gregorian calendar
* xoY Y (full year) in Minguo calendar or Juche year.
* Months and days are identical to the
* Gregorian calendar
* xtY Y (full year) in Japanese nengo. Months and days are
* identical to the Gregorian calendar
*
* Characters enclosed in double quotes will be considered literal (with
* the quotes themselves removed). Unmatched quotes will be considered
* literal quotes. Example:
*
* "The month is" F => The month is January
* i's" => 20'11"
*
* Backslash escaping is also supported.
*
* Input timestamp is assumed to be pre-normalized to the desired local
* time zone, if any. Note that the format characters crUeIOPTZ will assume
* $ts is UTC if $zone is not given.
*
* @param string $format
* @param string $ts 14-character timestamp
* YYYYMMDDHHMMSS
* 01234567890123
* @param DateTimeZone $zone Timezone of $ts
* @param[out] int $ttl The amount of time (in seconds) the output may be cached for.
* Only makes sense if $ts is the current time.
* @todo handling of "o" format character for Iranian, Hebrew, Hijri & Thai?
*
* @throws MWException
* @return string
*/
function sprintfDate( $format, $ts, DateTimeZone $zone = null, &$ttl = null ) {
$s = '';
$raw = false;
$roman = false;
$hebrewNum = false;
$dateTimeObj = false;
$rawToggle = false;
$iranian = false;
$hebrew = false;
$hijri = false;
$thai = false;
$minguo = false;
$tenno = false;
$usedSecond = false;
$usedMinute = false;
$usedHour = false;
$usedAMPM = false;
$usedDay = false;
$usedWeek = false;
$usedMonth = false;
$usedYear = false;
$usedISOYear = false;
$usedIsLeapYear = false;
$usedHebrewMonth = false;
$usedIranianMonth = false;
$usedHijriMonth = false;
$usedHebrewYear = false;
$usedIranianYear = false;
$usedHijriYear = false;
$usedTennoYear = false;
if ( strlen( $ts ) !== 14 ) {
throw new MWException( __METHOD__ . ": The timestamp $ts should have 14 characters" );
}
if ( !ctype_digit( $ts ) ) {
throw new MWException( __METHOD__ . ": The timestamp $ts should be a number" );
}
$formatLength = strlen( $format );
for ( $p = 0; $p < $formatLength; $p++ ) {
$num = false;
$code = $format[$p];
if ( $code == 'x' && $p < $formatLength - 1 ) {
$code .= $format[++$p];
}
if ( ( $code === 'xi'
|| $code === 'xj'
|| $code === 'xk'
|| $code === 'xm'
|| $code === 'xo'
|| $code === 'xt' )
&& $p < $formatLength - 1 ) {
$code .= $format[++$p];
}
switch ( $code ) {
case 'xx':
$s .= 'x';
break;
case 'xn':
$raw = true;
break;
case 'xN':
$rawToggle = !$rawToggle;
break;
case 'xr':
$roman = true;
break;
case 'xh':
$hebrewNum = true;
break;
case 'xg':
$usedMonth = true;
$s .= $this->getMonthNameGen( substr( $ts, 4, 2 ) );
break;
case 'xjx':
$usedHebrewMonth = true;
if ( !$hebrew ) {
$hebrew = self::tsToHebrew( $ts );
}
$s .= $this->getHebrewCalendarMonthNameGen( $hebrew[1] );
break;
case 'd':
$usedDay = true;
$num = substr( $ts, 6, 2 );
break;
case 'D':
$usedDay = true;
$s .= $this->getWeekdayAbbreviation(
Language::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 'w' ) + 1
);
break;
case 'j':
$usedDay = true;
$num = intval( substr( $ts, 6, 2 ) );
break;
case 'xij':
$usedDay = true;
if ( !$iranian ) {
$iranian = self::tsToIranian( $ts );
}
$num = $iranian[2];
break;
case 'xmj':
$usedDay = true;
if ( !$hijri ) {
$hijri = self::tsToHijri( $ts );
}
$num = $hijri[2];
break;
case 'xjj':
$usedDay = true;
if ( !$hebrew ) {
$hebrew = self::tsToHebrew( $ts );
}
$num = $hebrew[2];
break;
case 'l':
$usedDay = true;
$s .= $this->getWeekdayName(
Language::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 'w' ) + 1
);
break;
case 'F':
$usedMonth = true;
$s .= $this->getMonthName( substr( $ts, 4, 2 ) );
break;
case 'xiF':
$usedIranianMonth = true;
if ( !$iranian ) {
$iranian = self::tsToIranian( $ts );
}
$s .= $this->getIranianCalendarMonthName( $iranian[1] );
break;
case 'xmF':
$usedHijriMonth = true;
if ( !$hijri ) {
$hijri = self::tsToHijri( $ts );
}
$s .= $this->getHijriCalendarMonthName( $hijri[1] );
break;
case 'xjF':
$usedHebrewMonth = true;
if ( !$hebrew ) {
$hebrew = self::tsToHebrew( $ts );
}
$s .= $this->getHebrewCalendarMonthName( $hebrew[1] );
break;
case 'm':
$usedMonth = true;
$num = substr( $ts, 4, 2 );
break;
case 'M':
$usedMonth = true;
$s .= $this->getMonthAbbreviation( substr( $ts, 4, 2 ) );
break;
case 'n':
$usedMonth = true;
$num = intval( substr( $ts, 4, 2 ) );
break;
case 'xin':
$usedIranianMonth = true;
if ( !$iranian ) {
$iranian = self::tsToIranian( $ts );
}
$num = $iranian[1];
break;
case 'xmn':
$usedHijriMonth = true;
if ( !$hijri ) {
$hijri = self::tsToHijri ( $ts );
}
$num = $hijri[1];
break;
case 'xjn':
$usedHebrewMonth = true;
if ( !$hebrew ) {
$hebrew = self::tsToHebrew( $ts );
}
$num = $hebrew[1];
break;
case 'xjt':
$usedHebrewMonth = true;
if ( !$hebrew ) {
$hebrew = self::tsToHebrew( $ts );
}
$num = $hebrew[3];
break;
case 'Y':
$usedYear = true;
$num = substr( $ts, 0, 4 );
break;
case 'xiY':
$usedIranianYear = true;
if ( !$iranian ) {
$iranian = self::tsToIranian( $ts );
}
$num = $iranian[0];
break;
case 'xmY':
$usedHijriYear = true;
if ( !$hijri ) {
$hijri = self::tsToHijri( $ts );
}
$num = $hijri[0];
break;
case 'xjY':
$usedHebrewYear = true;
if ( !$hebrew ) {
$hebrew = self::tsToHebrew( $ts );
}
$num = $hebrew[0];
break;
case 'xkY':
$usedYear = true;
if ( !$thai ) {
$thai = self::tsToYear( $ts, 'thai' );
}
$num = $thai[0];
break;
case 'xoY':
$usedYear = true;
if ( !$minguo ) {
$minguo = self::tsToYear( $ts, 'minguo' );
}
$num = $minguo[0];
break;
case 'xtY':
$usedTennoYear = true;
if ( !$tenno ) {
$tenno = self::tsToYear( $ts, 'tenno' );
}
$num = $tenno[0];
break;
case 'y':
$usedYear = true;
$num = substr( $ts, 2, 2 );
break;
case 'xiy':
$usedIranianYear = true;
if ( !$iranian ) {
$iranian = self::tsToIranian( $ts );
}
$num = substr( $iranian[0], -2 );
break;
case 'a':
$usedAMPM = true;
$s .= intval( substr( $ts, 8, 2 ) ) < 12 ? 'am' : 'pm';
break;
case 'A':
$usedAMPM = true;
$s .= intval( substr( $ts, 8, 2 ) ) < 12 ? 'AM' : 'PM';
break;
case 'g':
$usedHour = true;
$h = substr( $ts, 8, 2 );
$num = $h % 12 ? $h % 12 : 12;
break;
case 'G':
$usedHour = true;
$num = intval( substr( $ts, 8, 2 ) );
break;
case 'h':
$usedHour = true;
$h = substr( $ts, 8, 2 );
$num = sprintf( '%02d', $h % 12 ? $h % 12 : 12 );
break;
case 'H':
$usedHour = true;
$num = substr( $ts, 8, 2 );
break;
case 'i':
$usedMinute = true;
$num = substr( $ts, 10, 2 );
break;
case 's':
$usedSecond = true;
$num = substr( $ts, 12, 2 );
break;
case 'c':
case 'r':
$usedSecond = true;
// fall through
case 'e':
case 'O':
case 'P':
case 'T':
$s .= Language::dateTimeObjFormat( $dateTimeObj, $ts, $zone, $code );
break;
case 'w':
case 'N':
case 'z':
$usedDay = true;
$num = Language::dateTimeObjFormat( $dateTimeObj, $ts, $zone, $code );
break;
case 'W':
$usedWeek = true;
$num = Language::dateTimeObjFormat( $dateTimeObj, $ts, $zone, $code );
break;
case 't':
$usedMonth = true;
$num = Language::dateTimeObjFormat( $dateTimeObj, $ts, $zone, $code );
break;
case 'L':
$usedIsLeapYear = true;
$num = Language::dateTimeObjFormat( $dateTimeObj, $ts, $zone, $code );
break;
case 'o':
$usedISOYear = true;
$num = Language::dateTimeObjFormat( $dateTimeObj, $ts, $zone, $code );
break;
case 'U':
$usedSecond = true;
// fall through
case 'I':
case 'Z':
$num = Language::dateTimeObjFormat( $dateTimeObj, $ts, $zone, $code );
break;
case '\\':
# Backslash escaping
if ( $p < $formatLength - 1 ) {
$s .= $format[++$p];
} else {
$s .= '\\';
}
break;
case '"':
# Quoted literal
if ( $p < $formatLength - 1 ) {
$endQuote = strpos( $format, '"', $p + 1 );
if ( $endQuote === false ) {
# No terminating quote, assume literal "
$s .= '"';
} else {
$s .= substr( $format, $p + 1, $endQuote - $p - 1 );
$p = $endQuote;
}
} else {
# Quote at end of string, assume literal "
$s .= '"';
}
break;
default:
$s .= $format[$p];
}
if ( $num !== false ) {
if ( $rawToggle || $raw ) {
$s .= $num;
$raw = false;
} elseif ( $roman ) {
$s .= Language::romanNumeral( $num );
$roman = false;
} elseif ( $hebrewNum ) {
$s .= self::hebrewNumeral( $num );
$hebrewNum = false;
} else {
$s .= $this->formatNum( $num, true );
}
}
}
if ( $usedSecond ) {
$ttl = 1;
} elseif ( $usedMinute ) {
$ttl = 60 - substr( $ts, 12, 2 );
} elseif ( $usedHour ) {
$ttl = 3600 - substr( $ts, 10, 2 ) * 60 - substr( $ts, 12, 2 );
} elseif ( $usedAMPM ) {
$ttl = 43200 - ( substr( $ts, 8, 2 ) % 12 ) * 3600 -
substr( $ts, 10, 2 ) * 60 - substr( $ts, 12, 2 );
} elseif (
$usedDay ||
$usedHebrewMonth ||
$usedIranianMonth ||
$usedHijriMonth ||
$usedHebrewYear ||
$usedIranianYear ||
$usedHijriYear ||
$usedTennoYear
) {
// @todo Someone who understands the non-Gregorian calendars
// should write proper logic for them so that they don't need purged every day.
$ttl = 86400 - substr( $ts, 8, 2 ) * 3600 -
substr( $ts, 10, 2 ) * 60 - substr( $ts, 12, 2 );
} else {
$possibleTtls = array();
$timeRemainingInDay = 86400 - substr( $ts, 8, 2 ) * 3600 -
substr( $ts, 10, 2 ) * 60 - substr( $ts, 12, 2 );
if ( $usedWeek ) {
$possibleTtls[] =
( 7 - Language::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 'N' ) ) * 86400 +
$timeRemainingInDay;
} elseif ( $usedISOYear ) {
// December 28th falls on the last ISO week of the year, every year.
// The last ISO week of a year can be 52 or 53.
$lastWeekOfISOYear = DateTime::createFromFormat(
'Ymd',
substr( $ts, 0, 4 ) . '1228',
$zone ?: new DateTimeZone( 'UTC' )
)->format( 'W' );
$currentISOWeek = Language::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 'W' );
$weeksRemaining = $lastWeekOfISOYear - $currentISOWeek;
$timeRemainingInWeek =
( 7 - Language::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 'N' ) ) * 86400
+ $timeRemainingInDay;
$possibleTtls[] = $weeksRemaining * 604800 + $timeRemainingInWeek;
}
if ( $usedMonth ) {
$possibleTtls[] =
( Language::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 't' ) -
substr( $ts, 6, 2 ) ) * 86400
+ $timeRemainingInDay;
} elseif ( $usedYear ) {
$possibleTtls[] =
( Language::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 'L' ) + 364 -
Language::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 'z' ) ) * 86400
+ $timeRemainingInDay;
} elseif ( $usedIsLeapYear ) {
$year = substr( $ts, 0, 4 );
$timeRemainingInYear =
( Language::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 'L' ) + 364 -
Language::dateTimeObjFormat( $dateTimeObj, $ts, $zone, 'z' ) ) * 86400
+ $timeRemainingInDay;
$mod = $year % 4;
if ( $mod || ( !( $year % 100 ) && $year % 400 ) ) {
// this isn't a leap year. see when the next one starts
$nextCandidate = $year - $mod + 4;
if ( $nextCandidate % 100 || !( $nextCandidate % 400 ) ) {
$possibleTtls[] = ( $nextCandidate - $year - 1 ) * 365 * 86400 +
$timeRemainingInYear;
} else {
$possibleTtls[] = ( $nextCandidate - $year + 3 ) * 365 * 86400 +
$timeRemainingInYear;
}
} else {
// this is a leap year, so the next year isn't
$possibleTtls[] = $timeRemainingInYear;
}
}
if ( $possibleTtls ) {
$ttl = min( $possibleTtls );
}
}
return $s;
}
private static $GREG_DAYS = array( 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 );
private static $IRANIAN_DAYS = array( 31, 31, 31, 31, 31, 31, 30, 30, 30, 30, 30, 29 );
/**
* Algorithm by Roozbeh Pournader and Mohammad Toossi to convert
* Gregorian dates to Iranian dates. Originally written in C, it
* is released under the terms of GNU Lesser General Public
* License. Conversion to PHP was performed by Niklas Laxström.
*
* Link: http://www.farsiweb.info/jalali/jalali.c
*
* @param string $ts
*
* @return string
*/
private static function tsToIranian( $ts ) {
$gy = substr( $ts, 0, 4 ) -1600;
$gm = substr( $ts, 4, 2 ) -1;
$gd = substr( $ts, 6, 2 ) -1;
# Days passed from the beginning (including leap years)
$gDayNo = 365 * $gy
+ floor( ( $gy + 3 ) / 4 )
- floor( ( $gy + 99 ) / 100 )
+ floor( ( $gy + 399 ) / 400 );
// Add days of the past months of this year
for ( $i = 0; $i < $gm; $i++ ) {
$gDayNo += self::$GREG_DAYS[$i];
}
// Leap years
if ( $gm > 1 && ( ( $gy % 4 === 0 && $gy % 100 !== 0 || ( $gy % 400 == 0 ) ) ) ) {
$gDayNo++;
}
// Days passed in current month
$gDayNo += (int)$gd;
$jDayNo = $gDayNo - 79;
$jNp = floor( $jDayNo / 12053 );
$jDayNo %= 12053;
$jy = 979 + 33 * $jNp + 4 * floor( $jDayNo / 1461 );
$jDayNo %= 1461;
if ( $jDayNo >= 366 ) {
$jy += floor( ( $jDayNo - 1 ) / 365 );
$jDayNo = floor( ( $jDayNo - 1 ) % 365 );
}
for ( $i = 0; $i < 11 && $jDayNo >= self::$IRANIAN_DAYS[$i]; $i++ ) {
$jDayNo -= self::$IRANIAN_DAYS[$i];
}
$jm = $i + 1;
$jd = $jDayNo + 1;
return array( $jy, $jm, $jd );
}
/**
* Converting Gregorian dates to Hijri dates.
*
* Based on a PHP-Nuke block by Sharjeel which is released under GNU/GPL license
*
* @see http://phpnuke.org/modules.php?name=News&file=article&sid=8234&mode=thread&order=0&thold=0
*
* @param string $ts
*
* @return string
*/
private static function tsToHijri( $ts ) {
$year = substr( $ts, 0, 4 );
$month = substr( $ts, 4, 2 );
$day = substr( $ts, 6, 2 );
$zyr = $year;
$zd = $day;
$zm = $month;
$zy = $zyr;
if (
( $zy > 1582 ) || ( ( $zy == 1582 ) && ( $zm > 10 ) ) ||
( ( $zy == 1582 ) && ( $zm == 10 ) && ( $zd > 14 ) )
) {
$zjd = (int)( ( 1461 * ( $zy + 4800 + (int)( ( $zm - 14 ) / 12 ) ) ) / 4 ) +
(int)( ( 367 * ( $zm - 2 - 12 * ( (int)( ( $zm - 14 ) / 12 ) ) ) ) / 12 ) -
(int)( ( 3 * (int)( ( ( $zy + 4900 + (int)( ( $zm - 14 ) / 12 ) ) / 100 ) ) ) / 4 ) +
$zd - 32075;
} else {
$zjd = 367 * $zy - (int)( ( 7 * ( $zy + 5001 + (int)( ( $zm - 9 ) / 7 ) ) ) / 4 ) +
(int)( ( 275 * $zm ) / 9 ) + $zd + 1729777;
}
$zl = $zjd -1948440 + 10632;
$zn = (int)( ( $zl - 1 ) / 10631 );
$zl = $zl - 10631 * $zn + 354;
$zj = ( (int)( ( 10985 - $zl ) / 5316 ) ) * ( (int)( ( 50 * $zl ) / 17719 ) ) +
( (int)( $zl / 5670 ) ) * ( (int)( ( 43 * $zl ) / 15238 ) );
$zl = $zl - ( (int)( ( 30 - $zj ) / 15 ) ) * ( (int)( ( 17719 * $zj ) / 50 ) ) -
( (int)( $zj / 16 ) ) * ( (int)( ( 15238 * $zj ) / 43 ) ) + 29;
$zm = (int)( ( 24 * $zl ) / 709 );
$zd = $zl - (int)( ( 709 * $zm ) / 24 );
$zy = 30 * $zn + $zj - 30;
return array( $zy, $zm, $zd );
}
/**
* Converting Gregorian dates to Hebrew dates.
*
* Based on a JavaScript code by Abu Mami and Yisrael Hersch
* (abu-mami@kaluach.net, http://www.kaluach.net), who permitted
* to translate the relevant functions into PHP and release them under
* GNU GPL.
*
* The months are counted from Tishrei = 1. In a leap year, Adar I is 13
* and Adar II is 14. In a non-leap year, Adar is 6.
*
* @param string $ts
*
* @return string
*/
private static function tsToHebrew( $ts ) {
# Parse date
$year = substr( $ts, 0, 4 );
$month = substr( $ts, 4, 2 );
$day = substr( $ts, 6, 2 );
# Calculate Hebrew year
$hebrewYear = $year + 3760;
# Month number when September = 1, August = 12
$month += 4;
if ( $month > 12 ) {
# Next year
$month -= 12;
$year++;
$hebrewYear++;
}
# Calculate day of year from 1 September
$dayOfYear = $day;
for ( $i = 1; $i < $month; $i++ ) {
if ( $i == 6 ) {
# February
$dayOfYear += 28;
# Check if the year is leap
if ( $year % 400 == 0 || ( $year % 4 == 0 && $year % 100 > 0 ) ) {
$dayOfYear++;
}
} elseif ( $i == 8 || $i == 10 || $i == 1 || $i == 3 ) {
$dayOfYear += 30;
} else {
$dayOfYear += 31;
}
}
# Calculate the start of the Hebrew year
$start = self::hebrewYearStart( $hebrewYear );
# Calculate next year's start
if ( $dayOfYear <= $start ) {
# Day is before the start of the year - it is the previous year
# Next year's start
$nextStart = $start;
# Previous year
$year--;
$hebrewYear--;
# Add days since previous year's 1 September
$dayOfYear += 365;
if ( ( $year % 400 == 0 ) || ( $year % 100 != 0 && $year % 4 == 0 ) ) {
# Leap year
$dayOfYear++;
}
# Start of the new (previous) year
$start = self::hebrewYearStart( $hebrewYear );
} else {
# Next year's start
$nextStart = self::hebrewYearStart( $hebrewYear + 1 );
}
# Calculate Hebrew day of year
$hebrewDayOfYear = $dayOfYear - $start;
# Difference between year's days
$diff = $nextStart - $start;
# Add 12 (or 13 for leap years) days to ignore the difference between
# Hebrew and Gregorian year (353 at least vs. 365/6) - now the
# difference is only about the year type
if ( ( $year % 400 == 0 ) || ( $year % 100 != 0 && $year % 4 == 0 ) ) {
$diff += 13;
} else {
$diff += 12;
}
# Check the year pattern, and is leap year
# 0 means an incomplete year, 1 means a regular year, 2 means a complete year
# This is mod 30, to work on both leap years (which add 30 days of Adar I)
# and non-leap years
$yearPattern = $diff % 30;
# Check if leap year
$isLeap = $diff >= 30;
# Calculate day in the month from number of day in the Hebrew year
# Don't check Adar - if the day is not in Adar, we will stop before;
# if it is in Adar, we will use it to check if it is Adar I or Adar II
$hebrewDay = $hebrewDayOfYear;
$hebrewMonth = 1;
$days = 0;
while ( $hebrewMonth <= 12 ) {
# Calculate days in this month
if ( $isLeap && $hebrewMonth == 6 ) {
# Adar in a leap year
if ( $isLeap ) {
# Leap year - has Adar I, with 30 days, and Adar II, with 29 days
$days = 30;
if ( $hebrewDay <= $days ) {
# Day in Adar I
$hebrewMonth = 13;
} else {
# Subtract the days of Adar I
$hebrewDay -= $days;
# Try Adar II
$days = 29;
if ( $hebrewDay <= $days ) {
# Day in Adar II
$hebrewMonth = 14;
}
}
}
} elseif ( $hebrewMonth == 2 && $yearPattern == 2 ) {
# Cheshvan in a complete year (otherwise as the rule below)
$days = 30;
} elseif ( $hebrewMonth == 3 && $yearPattern == 0 ) {
# Kislev in an incomplete year (otherwise as the rule below)
$days = 29;
} else {
# Odd months have 30 days, even have 29
$days = 30 - ( $hebrewMonth - 1 ) % 2;
}
if ( $hebrewDay <= $days ) {
# In the current month
break;
} else {
# Subtract the days of the current month
$hebrewDay -= $days;
# Try in the next month
$hebrewMonth++;
}
}
return array( $hebrewYear, $hebrewMonth, $hebrewDay, $days );
}
/**
* This calculates the Hebrew year start, as days since 1 September.
* Based on Carl Friedrich Gauss algorithm for finding Easter date.
* Used for Hebrew date.
*
* @param int $year
*
* @return string
*/
private static function hebrewYearStart( $year ) {
$a = intval( ( 12 * ( $year - 1 ) + 17 ) % 19 );
$b = intval( ( $year - 1 ) % 4 );
$m = 32.044093161144 + 1.5542417966212 * $a + $b / 4.0 - 0.0031777940220923 * ( $year - 1 );
if ( $m < 0 ) {
$m--;
}
$Mar = intval( $m );
if ( $m < 0 ) {
$m++;
}
$m -= $Mar;
$c = intval( ( $Mar + 3 * ( $year - 1 ) + 5 * $b + 5 ) % 7 );
if ( $c == 0 && $a > 11 && $m >= 0.89772376543210 ) {
$Mar++;
} elseif ( $c == 1 && $a > 6 && $m >= 0.63287037037037 ) {
$Mar += 2;
} elseif ( $c == 2 || $c == 4 || $c == 6 ) {
$Mar++;
}
$Mar += intval( ( $year - 3761 ) / 100 ) - intval( ( $year - 3761 ) / 400 ) - 24;
return $Mar;
}
/**
* Algorithm to convert Gregorian dates to Thai solar dates,
* Minguo dates or Minguo dates.
*
* Link: http://en.wikipedia.org/wiki/Thai_solar_calendar
* http://en.wikipedia.org/wiki/Minguo_calendar
* http://en.wikipedia.org/wiki/Japanese_era_name
*
* @param string $ts 14-character timestamp
* @param string $cName Calender name
* @return array Converted year, month, day
*/
private static function tsToYear( $ts, $cName ) {
$gy = substr( $ts, 0, 4 );
$gm = substr( $ts, 4, 2 );
$gd = substr( $ts, 6, 2 );
if ( !strcmp( $cName, 'thai' ) ) {
# Thai solar dates
# Add 543 years to the Gregorian calendar
# Months and days are identical
$gy_offset = $gy + 543;
} elseif ( ( !strcmp( $cName, 'minguo' ) ) || !strcmp( $cName, 'juche' ) ) {
# Minguo dates
# Deduct 1911 years from the Gregorian calendar
# Months and days are identical
$gy_offset = $gy - 1911;
} elseif ( !strcmp( $cName, 'tenno' ) ) {
# Nengō dates up to Meiji period
# Deduct years from the Gregorian calendar
# depending on the nengo periods
# Months and days are identical
if ( ( $gy < 1912 )
|| ( ( $gy == 1912 ) && ( $gm < 7 ) )
|| ( ( $gy == 1912 ) && ( $gm == 7 ) && ( $gd < 31 ) )
) {
# Meiji period
$gy_gannen = $gy - 1868 + 1;
$gy_offset = $gy_gannen;
if ( $gy_gannen == 1 ) {
$gy_offset = '元';
}
$gy_offset = '明治' . $gy_offset;
} elseif (
( ( $gy == 1912 ) && ( $gm == 7 ) && ( $gd == 31 ) ) ||
( ( $gy == 1912 ) && ( $gm >= 8 ) ) ||
( ( $gy > 1912 ) && ( $gy < 1926 ) ) ||
( ( $gy == 1926 ) && ( $gm < 12 ) ) ||
( ( $gy == 1926 ) && ( $gm == 12 ) && ( $gd < 26 ) )
) {
# Taishō period
$gy_gannen = $gy - 1912 + 1;
$gy_offset = $gy_gannen;
if ( $gy_gannen == 1 ) {
$gy_offset = '元';
}
$gy_offset = '大正' . $gy_offset;
} elseif (
( ( $gy == 1926 ) && ( $gm == 12 ) && ( $gd >= 26 ) ) ||
( ( $gy > 1926 ) && ( $gy < 1989 ) ) ||
( ( $gy == 1989 ) && ( $gm == 1 ) && ( $gd < 8 ) )
) {
# Shōwa period
$gy_gannen = $gy - 1926 + 1;
$gy_offset = $gy_gannen;
if ( $gy_gannen == 1 ) {
$gy_offset = '元';
}
$gy_offset = '昭和' . $gy_offset;
} else {
# Heisei period
$gy_gannen = $gy - 1989 + 1;
$gy_offset = $gy_gannen;
if ( $gy_gannen == 1 ) {
$gy_offset = '元';
}
$gy_offset = '平成' . $gy_offset;
}
} else {
$gy_offset = $gy;
}
return array( $gy_offset, $gm, $gd );
}
/**
* Roman number formatting up to 10000
*
* @param int $num
*
* @return string
*/
static function romanNumeral( $num ) {
static $table = array(
array( '', 'I', 'II', 'III', 'IV', 'V', 'VI', 'VII', 'VIII', 'IX', 'X' ),
array( '', 'X', 'XX', 'XXX', 'XL', 'L', 'LX', 'LXX', 'LXXX', 'XC', 'C' ),
array( '', 'C', 'CC', 'CCC', 'CD', 'D', 'DC', 'DCC', 'DCCC', 'CM', 'M' ),
array( '', 'M', 'MM', 'MMM', 'MMMM', 'MMMMM', 'MMMMMM', 'MMMMMMM',
'MMMMMMMM', 'MMMMMMMMM', 'MMMMMMMMMM' )
);
$num = intval( $num );
if ( $num > 10000 || $num <= 0 ) {
return $num;
}
$s = '';
for ( $pow10 = 1000, $i = 3; $i >= 0; $pow10 /= 10, $i-- ) {
if ( $num >= $pow10 ) {
$s .= $table[$i][(int)floor( $num / $pow10 )];
}
$num = $num % $pow10;
}
return $s;
}
/**
* Hebrew Gematria number formatting up to 9999
*
* @param int $num
*
* @return string
*/
static function hebrewNumeral( $num ) {
static $table = array(
array( '', 'א', 'ב', 'ג', 'ד', 'ה', 'ו', 'ז', 'ח', 'ט', 'י' ),
array( '', 'י', 'כ', 'ל', 'מ', 'נ', 'ס', 'ע', 'פ', 'צ', 'ק' ),
array( '', 'ק', 'ר', 'ש', 'ת', 'תק', 'תר', 'תש', 'תת', 'תתק', 'תתר' ),
array( '', 'א', 'ב', 'ג', 'ד', 'ה', 'ו', 'ז', 'ח', 'ט', 'י' )
);
$num = intval( $num );
if ( $num > 9999 || $num <= 0 ) {
return $num;
}
$s = '';
for ( $pow10 = 1000, $i = 3; $i >= 0; $pow10 /= 10, $i-- ) {
if ( $num >= $pow10 ) {
if ( $num == 15 || $num == 16 ) {
$s .= $table[0][9] . $table[0][$num - 9];
$num = 0;
} else {
$s .= $table[$i][intval( ( $num / $pow10 ) )];
if ( $pow10 == 1000 ) {
$s .= "'";
}
}
}
$num = $num % $pow10;
}
if ( strlen( $s ) == 2 ) {
$str = $s . "'";
} else {
$str = substr( $s, 0, strlen( $s ) - 2 ) . '"';
$str .= substr( $s, strlen( $s ) - 2, 2 );
}
$start = substr( $str, 0, strlen( $str ) - 2 );
$end = substr( $str, strlen( $str ) - 2 );
switch ( $end ) {
case 'כ':
$str = $start . 'ך';
break;
case 'מ':
$str = $start . 'ם';
break;
case 'נ':
$str = $start . 'ן';
break;
case 'פ':
$str = $start . 'ף';
break;
case 'צ':
$str = $start . 'ץ';
break;
}
return $str;
}
/**
* Used by date() and time() to adjust the time output.
*
* @param string $ts The time in date('YmdHis') format
* @param mixed $tz Adjust the time by this amount (default false, mean we
* get user timecorrection setting)
* @return int
*/
function userAdjust( $ts, $tz = false ) {
global $wgUser, $wgLocalTZoffset;
if ( $tz === false ) {
$tz = $wgUser->getOption( 'timecorrection' );
}
$data = explode( '|', $tz, 3 );
if ( $data[0] == 'ZoneInfo' ) {
wfSuppressWarnings();
$userTZ = timezone_open( $data[2] );
wfRestoreWarnings();
if ( $userTZ !== false ) {
$date = date_create( $ts, timezone_open( 'UTC' ) );
date_timezone_set( $date, $userTZ );
$date = date_format( $date, 'YmdHis' );
return $date;
}
# Unrecognized timezone, default to 'Offset' with the stored offset.
$data[0] = 'Offset';
}
if ( $data[0] == 'System' || $tz == '' ) {
# Global offset in minutes.
$minDiff = $wgLocalTZoffset;
} elseif ( $data[0] == 'Offset' ) {
$minDiff = intval( $data[1] );
} else {
$data = explode( ':', $tz );
if ( count( $data ) == 2 ) {
$data[0] = intval( $data[0] );
$data[1] = intval( $data[1] );
$minDiff = abs( $data[0] ) * 60 + $data[1];
if ( $data[0] < 0 ) {
$minDiff = -$minDiff;
}
} else {
$minDiff = intval( $data[0] ) * 60;
}
}
# No difference ? Return time unchanged
if ( 0 == $minDiff ) {
return $ts;
}
wfSuppressWarnings(); // E_STRICT system time bitching
# Generate an adjusted date; take advantage of the fact that mktime
# will normalize out-of-range values so we don't have to split $minDiff
# into hours and minutes.
$t = mktime( (
(int)substr( $ts, 8, 2 ) ), # Hours
(int)substr( $ts, 10, 2 ) + $minDiff, # Minutes
(int)substr( $ts, 12, 2 ), # Seconds
(int)substr( $ts, 4, 2 ), # Month
(int)substr( $ts, 6, 2 ), # Day
(int)substr( $ts, 0, 4 ) ); # Year
$date = date( 'YmdHis', $t );
wfRestoreWarnings();
return $date;
}
/**
* This is meant to be used by time(), date(), and timeanddate() to get
* the date preference they're supposed to use, it should be used in
* all children.
*
*<code>
* function timeanddate([...], $format = true) {
* $datePreference = $this->dateFormat($format);
* [...]
* }
*</code>
*
* @param int|string|bool $usePrefs If true, the user's preference is used
* if false, the site/language default is used
* if int/string, assumed to be a format.
* @return string
*/
function dateFormat( $usePrefs = true ) {
global $wgUser;
if ( is_bool( $usePrefs ) ) {
if ( $usePrefs ) {
$datePreference = $wgUser->getDatePreference();
} else {
$datePreference = (string)User::getDefaultOption( 'date' );
}
} else {
$datePreference = (string)$usePrefs;
}
// return int
if ( $datePreference == '' ) {
return 'default';
}
return $datePreference;
}
/**
* Get a format string for a given type and preference
* @param string $type May be date, time or both
* @param string $pref The format name as it appears in Messages*.php
*
* @since 1.22 New type 'pretty' that provides a more readable timestamp format
*
* @return string
*/
function getDateFormatString( $type, $pref ) {
if ( !isset( $this->dateFormatStrings[$type][$pref] ) ) {
if ( $pref == 'default' ) {
$pref = $this->getDefaultDateFormat();
$df = self::$dataCache->getSubitem( $this->mCode, 'dateFormats', "$pref $type" );
} else {
$df = self::$dataCache->getSubitem( $this->mCode, 'dateFormats', "$pref $type" );
if ( $type === 'pretty' && $df === null ) {
$df = $this->getDateFormatString( 'date', $pref );
}
if ( $df === null ) {
$pref = $this->getDefaultDateFormat();
$df = self::$dataCache->getSubitem( $this->mCode, 'dateFormats', "$pref $type" );
}
}
$this->dateFormatStrings[$type][$pref] = $df;
}
return $this->dateFormatStrings[$type][$pref];
}
/**
* @param string $ts The time format which needs to be turned into a
* date('YmdHis') format with wfTimestamp(TS_MW,$ts)
* @param bool $adj Whether to adjust the time output according to the
* user configured offset ($timecorrection)
* @param mixed $format True to use user's date format preference
* @param string|bool $timecorrection The time offset as returned by
* validateTimeZone() in Special:Preferences
* @return string
*/
function date( $ts, $adj = false, $format = true, $timecorrection = false ) {
$ts = wfTimestamp( TS_MW, $ts );
if ( $adj ) {
$ts = $this->userAdjust( $ts, $timecorrection );
}
$df = $this->getDateFormatString( 'date', $this->dateFormat( $format ) );
return $this->sprintfDate( $df, $ts );
}
/**
* @param string $ts The time format which needs to be turned into a
* date('YmdHis') format with wfTimestamp(TS_MW,$ts)
* @param bool $adj Whether to adjust the time output according to the
* user configured offset ($timecorrection)
* @param mixed $format True to use user's date format preference
* @param string|bool $timecorrection The time offset as returned by
* validateTimeZone() in Special:Preferences
* @return string
*/
function time( $ts, $adj = false, $format = true, $timecorrection = false ) {
$ts = wfTimestamp( TS_MW, $ts );
if ( $adj ) {
$ts = $this->userAdjust( $ts, $timecorrection );
}
$df = $this->getDateFormatString( 'time', $this->dateFormat( $format ) );
return $this->sprintfDate( $df, $ts );
}
/**
* @param string $ts The time format which needs to be turned into a
* date('YmdHis') format with wfTimestamp(TS_MW,$ts)
* @param bool $adj Whether to adjust the time output according to the
* user configured offset ($timecorrection)
* @param mixed $format What format to return, if it's false output the
* default one (default true)
* @param string|bool $timecorrection The time offset as returned by
* validateTimeZone() in Special:Preferences
* @return string
*/
function timeanddate( $ts, $adj = false, $format = true, $timecorrection = false ) {
$ts = wfTimestamp( TS_MW, $ts );
if ( $adj ) {
$ts = $this->userAdjust( $ts, $timecorrection );
}
$df = $this->getDateFormatString( 'both', $this->dateFormat( $format ) );
return $this->sprintfDate( $df, $ts );
}
/**
* Takes a number of seconds and turns it into a text using values such as hours and minutes.
*
* @since 1.20
*
* @param int $seconds The amount of seconds.
* @param array $chosenIntervals The intervals to enable.
*
* @return string
*/
public function formatDuration( $seconds, array $chosenIntervals = array() ) {
$intervals = $this->getDurationIntervals( $seconds, $chosenIntervals );
$segments = array();
foreach ( $intervals as $intervalName => $intervalValue ) {
// Messages: duration-seconds, duration-minutes, duration-hours, duration-days, duration-weeks,
// duration-years, duration-decades, duration-centuries, duration-millennia
$message = wfMessage( 'duration-' . $intervalName )->numParams( $intervalValue );
$segments[] = $message->inLanguage( $this )->escaped();
}
return $this->listToText( $segments );
}
/**
* Takes a number of seconds and returns an array with a set of corresponding intervals.
* For example 65 will be turned into array( minutes => 1, seconds => 5 ).
*
* @since 1.20
*
* @param int $seconds The amount of seconds.
* @param array $chosenIntervals The intervals to enable.
*
* @return array
*/
public function getDurationIntervals( $seconds, array $chosenIntervals = array() ) {
if ( empty( $chosenIntervals ) ) {
$chosenIntervals = array(
'millennia',
'centuries',
'decades',
'years',
'days',
'hours',
'minutes',
'seconds'
);
}
$intervals = array_intersect_key( self::$durationIntervals, array_flip( $chosenIntervals ) );
$sortedNames = array_keys( $intervals );
$smallestInterval = array_pop( $sortedNames );
$segments = array();
foreach ( $intervals as $name => $length ) {
$value = floor( $seconds / $length );
if ( $value > 0 || ( $name == $smallestInterval && empty( $segments ) ) ) {
$seconds -= $value * $length;
$segments[$name] = $value;
}
}
return $segments;
}
/**
* Internal helper function for userDate(), userTime() and userTimeAndDate()
*
* @param string $type Can be 'date', 'time' or 'both'
* @param string $ts The time format which needs to be turned into a
* date('YmdHis') format with wfTimestamp(TS_MW,$ts)
* @param User $user User object used to get preferences for timezone and format
* @param array $options Array, can contain the following keys:
* - 'timecorrection': time correction, can have the following values:
* - true: use user's preference
* - false: don't use time correction
* - int: value of time correction in minutes
* - 'format': format to use, can have the following values:
* - true: use user's preference
* - false: use default preference
* - string: format to use
* @since 1.19
* @return string
*/
private function internalUserTimeAndDate( $type, $ts, User $user, array $options ) {
$ts = wfTimestamp( TS_MW, $ts );
$options += array( 'timecorrection' => true, 'format' => true );
if ( $options['timecorrection'] !== false ) {
if ( $options['timecorrection'] === true ) {
$offset = $user->getOption( 'timecorrection' );
} else {
$offset = $options['timecorrection'];
}
$ts = $this->userAdjust( $ts, $offset );
}
if ( $options['format'] === true ) {
$format = $user->getDatePreference();
} else {
$format = $options['format'];
}
$df = $this->getDateFormatString( $type, $this->dateFormat( $format ) );
return $this->sprintfDate( $df, $ts );
}
/**
* Get the formatted date for the given timestamp and formatted for
* the given user.
*
* @param mixed $ts Mixed: the time format which needs to be turned into a
* date('YmdHis') format with wfTimestamp(TS_MW,$ts)
* @param User $user User object used to get preferences for timezone and format
* @param array $options Array, can contain the following keys:
* - 'timecorrection': time correction, can have the following values:
* - true: use user's preference
* - false: don't use time correction
* - int: value of time correction in minutes
* - 'format': format to use, can have the following values:
* - true: use user's preference
* - false: use default preference
* - string: format to use
* @since 1.19
* @return string
*/
public function userDate( $ts, User $user, array $options = array() ) {
return $this->internalUserTimeAndDate( 'date', $ts, $user, $options );
}
/**
* Get the formatted time for the given timestamp and formatted for
* the given user.
*
* @param mixed $ts The time format which needs to be turned into a
* date('YmdHis') format with wfTimestamp(TS_MW,$ts)
* @param User $user User object used to get preferences for timezone and format
* @param array $options Array, can contain the following keys:
* - 'timecorrection': time correction, can have the following values:
* - true: use user's preference
* - false: don't use time correction
* - int: value of time correction in minutes
* - 'format': format to use, can have the following values:
* - true: use user's preference
* - false: use default preference
* - string: format to use
* @since 1.19
* @return string
*/
public function userTime( $ts, User $user, array $options = array() ) {
return $this->internalUserTimeAndDate( 'time', $ts, $user, $options );
}
/**
* Get the formatted date and time for the given timestamp and formatted for
* the given user.
*
* @param mixed $ts The time format which needs to be turned into a
* date('YmdHis') format with wfTimestamp(TS_MW,$ts)
* @param User $user User object used to get preferences for timezone and format
* @param array $options Array, can contain the following keys:
* - 'timecorrection': time correction, can have the following values:
* - true: use user's preference
* - false: don't use time correction
* - int: value of time correction in minutes
* - 'format': format to use, can have the following values:
* - true: use user's preference
* - false: use default preference
* - string: format to use
* @since 1.19
* @return string
*/
public function userTimeAndDate( $ts, User $user, array $options = array() ) {
return $this->internalUserTimeAndDate( 'both', $ts, $user, $options );
}
/**
* Convert an MWTimestamp into a pretty human-readable timestamp using
* the given user preferences and relative base time.
*
* DO NOT USE THIS FUNCTION DIRECTLY. Instead, call MWTimestamp::getHumanTimestamp
* on your timestamp object, which will then call this function. Calling
* this function directly will cause hooks to be skipped over.
*
* @see MWTimestamp::getHumanTimestamp
* @param MWTimestamp $ts Timestamp to prettify
* @param MWTimestamp $relativeTo Base timestamp
* @param User $user User preferences to use
* @return string Human timestamp
* @since 1.22
*/
public function getHumanTimestamp( MWTimestamp $ts, MWTimestamp $relativeTo, User $user ) {
$diff = $ts->diff( $relativeTo );
$diffDay = (bool)( (int)$ts->timestamp->format( 'w' ) -
(int)$relativeTo->timestamp->format( 'w' ) );
$days = $diff->days ?: (int)$diffDay;
if ( $diff->invert || $days > 5
&& $ts->timestamp->format( 'Y' ) !== $relativeTo->timestamp->format( 'Y' )
) {
// Timestamps are in different years: use full timestamp
// Also do full timestamp for future dates
/**
* @todo FIXME: Add better handling of future timestamps.
*/
$format = $this->getDateFormatString( 'both', $user->getDatePreference() ?: 'default' );
$ts = $this->sprintfDate( $format, $ts->getTimestamp( TS_MW ) );
} elseif ( $days > 5 ) {
// Timestamps are in same year, but more than 5 days ago: show day and month only.
$format = $this->getDateFormatString( 'pretty', $user->getDatePreference() ?: 'default' );
$ts = $this->sprintfDate( $format, $ts->getTimestamp( TS_MW ) );
} elseif ( $days > 1 ) {
// Timestamp within the past week: show the day of the week and time
$format = $this->getDateFormatString( 'time', $user->getDatePreference() ?: 'default' );
$weekday = self::$mWeekdayMsgs[$ts->timestamp->format( 'w' )];
// Messages:
// sunday-at, monday-at, tuesday-at, wednesday-at, thursday-at, friday-at, saturday-at
$ts = wfMessage( "$weekday-at" )
->inLanguage( $this )
->params( $this->sprintfDate( $format, $ts->getTimestamp( TS_MW ) ) )
->text();
} elseif ( $days == 1 ) {
// Timestamp was yesterday: say 'yesterday' and the time.
$format = $this->getDateFormatString( 'time', $user->getDatePreference() ?: 'default' );
$ts = wfMessage( 'yesterday-at' )
->inLanguage( $this )
->params( $this->sprintfDate( $format, $ts->getTimestamp( TS_MW ) ) )
->text();
} elseif ( $diff->h > 1 || $diff->h == 1 && $diff->i > 30 ) {
// Timestamp was today, but more than 90 minutes ago: say 'today' and the time.
$format = $this->getDateFormatString( 'time', $user->getDatePreference() ?: 'default' );
$ts = wfMessage( 'today-at' )
->inLanguage( $this )
->params( $this->sprintfDate( $format, $ts->getTimestamp( TS_MW ) ) )
->text();
// From here on in, the timestamp was soon enough ago so that we can simply say
// XX units ago, e.g., "2 hours ago" or "5 minutes ago"
} elseif ( $diff->h == 1 ) {
// Less than 90 minutes, but more than an hour ago.
$ts = wfMessage( 'hours-ago' )->inLanguage( $this )->numParams( 1 )->text();
} elseif ( $diff->i >= 1 ) {
// A few minutes ago.
$ts = wfMessage( 'minutes-ago' )->inLanguage( $this )->numParams( $diff->i )->text();
} elseif ( $diff->s >= 30 ) {
// Less than a minute, but more than 30 sec ago.
$ts = wfMessage( 'seconds-ago' )->inLanguage( $this )->numParams( $diff->s )->text();
} else {
// Less than 30 seconds ago.
$ts = wfMessage( 'just-now' )->text();
}
return $ts;
}
/**
* @param string $key
* @return array|null
*/
function getMessage( $key ) {
return self::$dataCache->getSubitem( $this->mCode, 'messages', $key );
}
/**
* @return array
*/
function getAllMessages() {
return self::$dataCache->getItem( $this->mCode, 'messages' );
}
/**
* @param string $in
* @param string $out
* @param string $string
* @return string
*/
function iconv( $in, $out, $string ) {
# This is a wrapper for iconv in all languages except esperanto,
# which does some nasty x-conversions beforehand
# Even with //IGNORE iconv can whine about illegal characters in
# *input* string. We just ignore those too.
# REF: http://bugs.php.net/bug.php?id=37166
# REF: https://bugzilla.wikimedia.org/show_bug.cgi?id=16885
wfSuppressWarnings();
$text = iconv( $in, $out . '//IGNORE', $string );
wfRestoreWarnings();
return $text;
}
// callback functions for uc(), lc(), ucwords(), ucwordbreaks()
/**
* @param array $matches
* @return mixed|string
*/
function ucwordbreaksCallbackAscii( $matches ) {
return $this->ucfirst( $matches[1] );
}
/**
* @param array $matches
* @return string
*/
function ucwordbreaksCallbackMB( $matches ) {
return mb_strtoupper( $matches[0] );
}
/**
* @param array $matches
* @return string
*/
function ucCallback( $matches ) {
list( $wikiUpperChars ) = self::getCaseMaps();
return strtr( $matches[1], $wikiUpperChars );
}
/**
* @param array $matches
* @return string
*/
function lcCallback( $matches ) {
list( , $wikiLowerChars ) = self::getCaseMaps();
return strtr( $matches[1], $wikiLowerChars );
}
/**
* @param array $matches
* @return string
*/
function ucwordsCallbackMB( $matches ) {
return mb_strtoupper( $matches[0] );
}
/**
* @param array $matches
* @return string
*/
function ucwordsCallbackWiki( $matches ) {
list( $wikiUpperChars ) = self::getCaseMaps();
return strtr( $matches[0], $wikiUpperChars );
}
/**
* Make a string's first character uppercase
*
* @param string $str
*
* @return string
*/
function ucfirst( $str ) {
$o = ord( $str );
if ( $o < 96 ) { // if already uppercase...
return $str;
} elseif ( $o < 128 ) {
return ucfirst( $str ); // use PHP's ucfirst()
} else {
// fall back to more complex logic in case of multibyte strings
return $this->uc( $str, true );
}
}
/**
* Convert a string to uppercase
*
* @param string $str
* @param bool $first
*
* @return string
*/
function uc( $str, $first = false ) {
if ( function_exists( 'mb_strtoupper' ) ) {
if ( $first ) {
if ( $this->isMultibyte( $str ) ) {
return mb_strtoupper( mb_substr( $str, 0, 1 ) ) . mb_substr( $str, 1 );
} else {
return ucfirst( $str );
}
} else {
return $this->isMultibyte( $str ) ? mb_strtoupper( $str ) : strtoupper( $str );
}
} else {
if ( $this->isMultibyte( $str ) ) {
$x = $first ? '^' : '';
return preg_replace_callback(
"/$x([a-z]|[\\xc0-\\xff][\\x80-\\xbf]*)/",
array( $this, 'ucCallback' ),
$str
);
} else {
return $first ? ucfirst( $str ) : strtoupper( $str );
}
}
}
/**
* @param string $str
* @return mixed|string
*/
function lcfirst( $str ) {
$o = ord( $str );
if ( !$o ) {
return strval( $str );
} elseif ( $o >= 128 ) {
return $this->lc( $str, true );
} elseif ( $o > 96 ) {
return $str;
} else {
$str[0] = strtolower( $str[0] );
return $str;
}
}
/**
* @param string $str
* @param bool $first
* @return mixed|string
*/
function lc( $str, $first = false ) {
if ( function_exists( 'mb_strtolower' ) ) {
if ( $first ) {
if ( $this->isMultibyte( $str ) ) {
return mb_strtolower( mb_substr( $str, 0, 1 ) ) . mb_substr( $str, 1 );
} else {
return strtolower( substr( $str, 0, 1 ) ) . substr( $str, 1 );
}
} else {
return $this->isMultibyte( $str ) ? mb_strtolower( $str ) : strtolower( $str );
}
} else {
if ( $this->isMultibyte( $str ) ) {
$x = $first ? '^' : '';
return preg_replace_callback(
"/$x([A-Z]|[\\xc0-\\xff][\\x80-\\xbf]*)/",
array( $this, 'lcCallback' ),
$str
);
} else {
return $first ? strtolower( substr( $str, 0, 1 ) ) . substr( $str, 1 ) : strtolower( $str );
}
}
}
/**
* @param string $str
* @return bool
*/
function isMultibyte( $str ) {
return (bool)preg_match( '/[\x80-\xff]/', $str );
}
/**
* @param string $str
* @return mixed|string
*/
function ucwords( $str ) {
if ( $this->isMultibyte( $str ) ) {
$str = $this->lc( $str );
// regexp to find first letter in each word (i.e. after each space)
$replaceRegexp = "/^([a-z]|[\\xc0-\\xff][\\x80-\\xbf]*)| ([a-z]|[\\xc0-\\xff][\\x80-\\xbf]*)/";
// function to use to capitalize a single char
if ( function_exists( 'mb_strtoupper' ) ) {
return preg_replace_callback(
$replaceRegexp,
array( $this, 'ucwordsCallbackMB' ),
$str
);
} else {
return preg_replace_callback(
$replaceRegexp,
array( $this, 'ucwordsCallbackWiki' ),
$str
);
}
} else {
return ucwords( strtolower( $str ) );
}
}
/**
* capitalize words at word breaks
*
* @param string $str
* @return mixed
*/
function ucwordbreaks( $str ) {
if ( $this->isMultibyte( $str ) ) {
$str = $this->lc( $str );
// since \b doesn't work for UTF-8, we explicitely define word break chars
$breaks = "[ \-\(\)\}\{\.,\?!]";
// find first letter after word break
$replaceRegexp = "/^([a-z]|[\\xc0-\\xff][\\x80-\\xbf]*)|" .
"$breaks([a-z]|[\\xc0-\\xff][\\x80-\\xbf]*)/";
if ( function_exists( 'mb_strtoupper' ) ) {
return preg_replace_callback(
$replaceRegexp,
array( $this, 'ucwordbreaksCallbackMB' ),
$str
);
} else {
return preg_replace_callback(
$replaceRegexp,
array( $this, 'ucwordsCallbackWiki' ),
$str
);
}
} else {
return preg_replace_callback(
'/\b([\w\x80-\xff]+)\b/',
array( $this, 'ucwordbreaksCallbackAscii' ),
$str
);
}
}
/**
* Return a case-folded representation of $s
*
* This is a representation such that caseFold($s1)==caseFold($s2) if $s1
* and $s2 are the same except for the case of their characters. It is not
* necessary for the value returned to make sense when displayed.
*
* Do *not* perform any other normalisation in this function. If a caller
* uses this function when it should be using a more general normalisation
* function, then fix the caller.
*
* @param string $s
*
* @return string
*/
function caseFold( $s ) {
return $this->uc( $s );
}
/**
* @param string $s
* @return string
*/
function checkTitleEncoding( $s ) {
if ( is_array( $s ) ) {
throw new MWException( 'Given array to checkTitleEncoding.' );
}
if ( StringUtils::isUtf8( $s ) ) {
return $s;
}
return $this->iconv( $this->fallback8bitEncoding(), 'utf-8', $s );
}
/**
* @return array
*/
function fallback8bitEncoding() {
return self::$dataCache->getItem( $this->mCode, 'fallback8bitEncoding' );
}
/**
* Most writing systems use whitespace to break up words.
* Some languages such as Chinese don't conventionally do this,
* which requires special handling when breaking up words for
* searching etc.
*
* @return bool
*/
function hasWordBreaks() {
return true;
}
/**
* Some languages such as Chinese require word segmentation,
* Specify such segmentation when overridden in derived class.
*
* @param string $string
* @return string
*/
function segmentByWord( $string ) {
return $string;
}
/**
* Some languages have special punctuation need to be normalized.
* Make such changes here.
*
* @param string $string
* @return string
*/
function normalizeForSearch( $string ) {
return self::convertDoubleWidth( $string );
}
/**
* convert double-width roman characters to single-width.
* range: ff00-ff5f ~= 0020-007f
*
* @param string $string
*
* @return string
*/
protected static function convertDoubleWidth( $string ) {
static $full = null;
static $half = null;
if ( $full === null ) {
$fullWidth = "０１２３４５６７８９ＡＢＣＤＥＦＧＨＩＪＫＬＭＮＯＰＱＲＳＴＵＶＷＸＹＺａｂｃｄｅｆｇｈｉｊｋｌｍｎｏｐｑｒｓｔｕｖｗｘｙｚ";
$halfWidth = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
$full = str_split( $fullWidth, 3 );
$half = str_split( $halfWidth );
}
$string = str_replace( $full, $half, $string );
return $string;
}
/**
* @param string $string
* @param string $pattern
* @return string
*/
protected static function insertSpace( $string, $pattern ) {
$string = preg_replace( $pattern, " $1 ", $string );
$string = preg_replace( '/ +/', ' ', $string );
return $string;
}
/**
* @param array $termsArray
* @return array
*/
function convertForSearchResult( $termsArray ) {
# some languages, e.g. Chinese, need to do a conversion
# in order for search results to be displayed correctly
return $termsArray;
}
/**
* Get the first character of a string.
*
* @param string $s
* @return string
*/
function firstChar( $s ) {
$matches = array();
preg_match(
'/^([\x00-\x7f]|[\xc0-\xdf][\x80-\xbf]|' .
'[\xe0-\xef][\x80-\xbf]{2}|[\xf0-\xf7][\x80-\xbf]{3})/',
$s,
$matches
);
if ( isset( $matches[1] ) ) {
if ( strlen( $matches[1] ) != 3 ) {
return $matches[1];
}
// Break down Hangul syllables to grab the first jamo
$code = UtfNormal\Utils::utf8ToCodepoint( $matches[1] );
if ( $code < 0xac00 || 0xd7a4 <= $code ) {
return $matches[1];
} elseif ( $code < 0xb098 ) {
return "\xe3\x84\xb1";
} elseif ( $code < 0xb2e4 ) {
return "\xe3\x84\xb4";
} elseif ( $code < 0xb77c ) {
return "\xe3\x84\xb7";
} elseif ( $code < 0xb9c8 ) {
return "\xe3\x84\xb9";
} elseif ( $code < 0xbc14 ) {
return "\xe3\x85\x81";
} elseif ( $code < 0xc0ac ) {
return "\xe3\x85\x82";
} elseif ( $code < 0xc544 ) {
return "\xe3\x85\x85";
} elseif ( $code < 0xc790 ) {
return "\xe3\x85\x87";
} elseif ( $code < 0xcc28 ) {
return "\xe3\x85\x88";
} elseif ( $code < 0xce74 ) {
return "\xe3\x85\x8a";
} elseif ( $code < 0xd0c0 ) {
return "\xe3\x85\x8b";
} elseif ( $code < 0xd30c ) {
return "\xe3\x85\x8c";
} elseif ( $code < 0xd558 ) {
return "\xe3\x85\x8d";
} else {
return "\xe3\x85\x8e";
}
} else {
return '';
}
}
function initEncoding() {
# Some languages may have an alternate char encoding option
# (Esperanto X-coding, Japanese furigana conversion, etc)
# If this language is used as the primary content language,
# an override to the defaults can be set here on startup.
}
/**
* @param string $s
* @return string
*/
function recodeForEdit( $s ) {
# For some languages we'll want to explicitly specify
# which characters make it into the edit box raw
# or are converted in some way or another.
global $wgEditEncoding;
if ( $wgEditEncoding == '' || $wgEditEncoding == 'UTF-8' ) {
return $s;
} else {
return $this->iconv( 'UTF-8', $wgEditEncoding, $s );
}
}
/**
* @param string $s
* @return string
*/
function recodeInput( $s ) {
# Take the previous into account.
global $wgEditEncoding;
if ( $wgEditEncoding != '' ) {
$enc = $wgEditEncoding;
} else {
$enc = 'UTF-8';
}
if ( $enc == 'UTF-8' ) {
return $s;
} else {
return $this->iconv( $enc, 'UTF-8', $s );
}
}
/**
* Convert a UTF-8 string to normal form C. In Malayalam and Arabic, this
* also cleans up certain backwards-compatible sequences, converting them
* to the modern Unicode equivalent.
*
* This is language-specific for performance reasons only.
*
* @param string $s
*
* @return string
*/
function normalize( $s ) {
global $wgAllUnicodeFixes;
$s = UtfNormal\Validator::cleanUp( $s );
if ( $wgAllUnicodeFixes ) {
$s = $this->transformUsingPairFile( 'normalize-ar.ser', $s );
$s = $this->transformUsingPairFile( 'normalize-ml.ser', $s );
}
return $s;
}
/**
* Transform a string using serialized data stored in the given file (which
* must be in the serialized subdirectory of $IP). The file contains pairs
* mapping source characters to destination characters.
*
* The data is cached in process memory. This will go faster if you have the
* FastStringSearch extension.
*
* @param string $file
* @param string $string
*
* @throws MWException
* @return string
*/
function transformUsingPairFile( $file, $string ) {
if ( !isset( $this->transformData[$file] ) ) {
$data = wfGetPrecompiledData( $file );
if ( $data === false ) {
throw new MWException( __METHOD__ . ": The transformation file $file is missing" );
}
$this->transformData[$file] = new ReplacementArray( $data );
}
return $this->transformData[$file]->replace( $string );
}
/**
* For right-to-left language support
*
* @return bool
*/
function isRTL() {
return self::$dataCache->getItem( $this->mCode, 'rtl' );
}
/**
* Return the correct HTML 'dir' attribute value for this language.
* @return string
*/
function getDir() {
return $this->isRTL() ? 'rtl' : 'ltr';
}
/**
* Return 'left' or 'right' as appropriate alignment for line-start
* for this language's text direction.
*
* Should be equivalent to CSS3 'start' text-align value....
*
* @return string
*/
function alignStart() {
return $this->isRTL() ? 'right' : 'left';
}
/**
* Return 'right' or 'left' as appropriate alignment for line-end
* for this language's text direction.
*
* Should be equivalent to CSS3 'end' text-align value....
*
* @return string
*/
function alignEnd() {
return $this->isRTL() ? 'left' : 'right';
}
/**
* A hidden direction mark (LRM or RLM), depending on the language direction.
* Unlike getDirMark(), this function returns the character as an HTML entity.
* This function should be used when the output is guaranteed to be HTML,
* because it makes the output HTML source code more readable. When
* the output is plain text or can be escaped, getDirMark() should be used.
*
* @param bool $opposite Get the direction mark opposite to your language
* @return string
* @since 1.20
*/
function getDirMarkEntity( $opposite = false ) {
if ( $opposite ) {
return $this->isRTL() ? '‎' : '‏';
}
return $this->isRTL() ? '‏' : '‎';
}
/**
* A hidden direction mark (LRM or RLM), depending on the language direction.
* This function produces them as invisible Unicode characters and
* the output may be hard to read and debug, so it should only be used
* when the output is plain text or can be escaped. When the output is
* HTML, use getDirMarkEntity() instead.
*
* @param bool $opposite Get the direction mark opposite to your language
* @return string
*/
function getDirMark( $opposite = false ) {
$lrm = "\xE2\x80\x8E"; # LEFT-TO-RIGHT MARK, commonly abbreviated LRM
$rlm = "\xE2\x80\x8F"; # RIGHT-TO-LEFT MARK, commonly abbreviated RLM
if ( $opposite ) {
return $this->isRTL() ? $lrm : $rlm;
}
return $this->isRTL() ? $rlm : $lrm;
}
/**
* @return array
*/
function capitalizeAllNouns() {
return self::$dataCache->getItem( $this->mCode, 'capitalizeAllNouns' );
}
/**
* An arrow, depending on the language direction.
*
* @param string $direction The direction of the arrow: forwards (default),
* backwards, left, right, up, down.
* @return string
*/
function getArrow( $direction = 'forwards' ) {
switch ( $direction ) {
case 'forwards':
return $this->isRTL() ? '←' : '→';
case 'backwards':
return $this->isRTL() ? '→' : '←';
case 'left':
return '←';
case 'right':
return '→';
case 'up':
return '↑';
case 'down':
return '↓';
}
}
/**
* To allow "foo[[bar]]" to extend the link over the whole word "foobar"
*
* @return bool
*/
function linkPrefixExtension() {
return self::$dataCache->getItem( $this->mCode, 'linkPrefixExtension' );
}
/**
* Get all magic words from cache.
* @return array
*/
function getMagicWords() {
return self::$dataCache->getItem( $this->mCode, 'magicWords' );
}
/**
* Run the LanguageGetMagic hook once.
*/
protected function doMagicHook() {
if ( $this->mMagicHookDone ) {
return;
}
$this->mMagicHookDone = true;
Hooks::run( 'LanguageGetMagic', array( &$this->mMagicExtensions, $this->getCode() ) );
}
/**
* Fill a MagicWord object with data from here
*
* @param MagicWord $mw
*/
function getMagic( $mw ) {
// Saves a function call
if ( !$this->mMagicHookDone ) {
$this->doMagicHook();
}
if ( isset( $this->mMagicExtensions[$mw->mId] ) ) {
$rawEntry = $this->mMagicExtensions[$mw->mId];
} else {
$rawEntry = self::$dataCache->getSubitem(
$this->mCode, 'magicWords', $mw->mId );
}
if ( !is_array( $rawEntry ) ) {
wfWarn( "\"$rawEntry\" is not a valid magic word for \"$mw->mId\"" );
} else {
$mw->mCaseSensitive = $rawEntry[0];
$mw->mSynonyms = array_slice( $rawEntry, 1 );
}
}
/**
* Add magic words to the extension array
*
* @param array $newWords
*/
function addMagicWordsByLang( $newWords ) {
$fallbackChain = $this->getFallbackLanguages();
$fallbackChain = array_reverse( $fallbackChain );
foreach ( $fallbackChain as $code ) {
if ( isset( $newWords[$code] ) ) {
$this->mMagicExtensions = $newWords[$code] + $this->mMagicExtensions;
}
}
}
/**
* Get special page names, as an associative array
* canonical name => array of valid names, including aliases
* @return array
*/
function getSpecialPageAliases() {
// Cache aliases because it may be slow to load them
if ( is_null( $this->mExtendedSpecialPageAliases ) ) {
// Initialise array
$this->mExtendedSpecialPageAliases =
self::$dataCache->getItem( $this->mCode, 'specialPageAliases' );
Hooks::run( 'LanguageGetSpecialPageAliases',
array( &$this->mExtendedSpecialPageAliases, $this->getCode() ) );
}
return $this->mExtendedSpecialPageAliases;
}
/**
* Italic is unsuitable for some languages
*
* @param string $text The text to be emphasized.
* @return string
*/
function emphasize( $text ) {
return "<em>$text</em>";
}
/**
* Normally we output all numbers in plain en_US style, that is
* 293,291.235 for twohundredninetythreethousand-twohundredninetyone
* point twohundredthirtyfive. However this is not suitable for all
* languages, some such as Punjabi want ੨੯੩,੨੯੫.੨੩੫ and others such as
* Icelandic just want to use commas instead of dots, and dots instead
* of commas like "293.291,235".
*
* An example of this function being called:
* <code>
* wfMessage( 'message' )->numParams( $num )->text()
* </code>
*
* See $separatorTransformTable on MessageIs.php for
* the , => . and . => , implementation.
*
* @todo check if it's viable to use localeconv() for the decimal separator thing.
* @param int|float $number The string to be formatted, should be an integer
* or a floating point number.
* @param bool $nocommafy Set to true for special numbers like dates
* @return string
*/
public function formatNum( $number, $nocommafy = false ) {
global $wgTranslateNumerals;
if ( !$nocommafy ) {
$number = $this->commafy( $number );
$s = $this->separatorTransformTable();
if ( $s ) {
$number = strtr( $number, $s );
}
}
if ( $wgTranslateNumerals ) {
$s = $this->digitTransformTable();
if ( $s ) {
$number = strtr( $number, $s );
}
}
return $number;
}
/**
* Front-end for non-commafied formatNum
*
* @param int|float $number The string to be formatted, should be an integer
* or a floating point number.
* @since 1.21
* @return string
*/
public function formatNumNoSeparators( $number ) {
return $this->formatNum( $number, true );
}
/**
* @param string $number
* @return string
*/
public function parseFormattedNumber( $number ) {
$s = $this->digitTransformTable();
if ( $s ) {
// eliminate empty array values such as ''. (bug 64347)
$s = array_filter( $s );
$number = strtr( $number, array_flip( $s ) );
}
$s = $this->separatorTransformTable();
if ( $s ) {
// eliminate empty array values such as ''. (bug 64347)
$s = array_filter( $s );
$number = strtr( $number, array_flip( $s ) );
}
$number = strtr( $number, array( ',' => '' ) );
return $number;
}
/**
* Adds commas to a given number
* @since 1.19
* @param mixed $number
* @return string
*/
function commafy( $number ) {
$digitGroupingPattern = $this->digitGroupingPattern();
if ( $number === null ) {
return '';
}
if ( !$digitGroupingPattern || $digitGroupingPattern === "###,###,###" ) {
// default grouping is at thousands, use the same for ###,###,### pattern too.
return strrev( (string)preg_replace( '/(\d{3})(?=\d)(?!\d*\.)/', '$1,', strrev( $number ) ) );
} else {
// Ref: http://cldr.unicode.org/translation/number-patterns
$sign = "";
if ( intval( $number ) < 0 ) {
// For negative numbers apply the algorithm like positive number and add sign.
$sign = "-";
$number = substr( $number, 1 );
}
$integerPart = array();
$decimalPart = array();
$numMatches = preg_match_all( "/(#+)/", $digitGroupingPattern, $matches );
preg_match( "/\d+/", $number, $integerPart );
preg_match( "/\.\d*/", $number, $decimalPart );
$groupedNumber = ( count( $decimalPart ) > 0 ) ? $decimalPart[0] : "";
if ( $groupedNumber === $number ) {
// the string does not have any number part. Eg: .12345
return $sign . $groupedNumber;
}
$start = $end = ($integerPart) ? strlen( $integerPart[0] ) : 0;
while ( $start > 0 ) {
$match = $matches[0][$numMatches - 1];
$matchLen = strlen( $match );
$start = $end - $matchLen;
if ( $start < 0 ) {
$start = 0;
}
$groupedNumber = substr( $number, $start, $end -$start ) . $groupedNumber;
$end = $start;
if ( $numMatches > 1 ) {
// use the last pattern for the rest of the number
$numMatches--;
}
if ( $start > 0 ) {
$groupedNumber = "," . $groupedNumber;
}
}
return $sign . $groupedNumber;
}
}
/**
* @return string
*/
function digitGroupingPattern() {
return self::$dataCache->getItem( $this->mCode, 'digitGroupingPattern' );
}
/**
* @return array
*/
function digitTransformTable() {
return self::$dataCache->getItem( $this->mCode, 'digitTransformTable' );
}
/**
* @return array
*/
function separatorTransformTable() {
return self::$dataCache->getItem( $this->mCode, 'separatorTransformTable' );
}
/**
* Take a list of strings and build a locale-friendly comma-separated
* list, using the local comma-separator message.
* The last two strings are chained with an "and".
* NOTE: This function will only work with standard numeric array keys (0, 1, 2…)
*
* @param string[] $l
* @return string
*/
function listToText( array $l ) {
$m = count( $l ) - 1;
if ( $m < 0 ) {
return '';
}
if ( $m > 0 ) {
$and = $this->msg( 'and' )->escaped();
$space = $this->msg( 'word-separator' )->escaped();
if ( $m > 1 ) {
$comma = $this->msg( 'comma-separator' )->escaped();
}
}
$s = $l[$m];
for ( $i = $m - 1; $i >= 0; $i-- ) {
if ( $i == $m - 1 ) {
$s = $l[$i] . $and . $space . $s;
} else {
$s = $l[$i] . $comma . $s;
}
}
return $s;
}
/**
* Take a list of strings and build a locale-friendly comma-separated
* list, using the local comma-separator message.
* @param string[] $list Array of strings to put in a comma list
* @return string
*/
function commaList( array $list ) {
return implode(
wfMessage( 'comma-separator' )->inLanguage( $this )->escaped(),
$list
);
}
/**
* Take a list of strings and build a locale-friendly semicolon-separated
* list, using the local semicolon-separator message.
* @param string[] $list Array of strings to put in a semicolon list
* @return string
*/
function semicolonList( array $list ) {
return implode(
wfMessage( 'semicolon-separator' )->inLanguage( $this )->escaped(),
$list
);
}
/**
* Same as commaList, but separate it with the pipe instead.
* @param string[] $list Array of strings to put in a pipe list
* @return string
*/
function pipeList( array $list ) {
return implode(
wfMessage( 'pipe-separator' )->inLanguage( $this )->escaped(),
$list
);
}
/**
* Truncate a string to a specified length in bytes, appending an optional
* string (e.g. for ellipses)
*
* The database offers limited byte lengths for some columns in the database;
* multi-byte character sets mean we need to ensure that only whole characters
* are included, otherwise broken characters can be passed to the user
*
* If $length is negative, the string will be truncated from the beginning
*
* @param string $string String to truncate
* @param int $length Maximum length (including ellipses)
* @param string $ellipsis String to append to the truncated text
* @param bool $adjustLength Subtract length of ellipsis from $length.
* $adjustLength was introduced in 1.18, before that behaved as if false.
* @return string
*/
function truncate( $string, $length, $ellipsis = '...', $adjustLength = true ) {
# Use the localized ellipsis character
if ( $ellipsis == '...' ) {
$ellipsis = wfMessage( 'ellipsis' )->inLanguage( $this )->escaped();
}
# Check if there is no need to truncate
if ( $length == 0 ) {
return $ellipsis; // convention
} elseif ( strlen( $string ) <= abs( $length ) ) {
return $string; // no need to truncate
}
$stringOriginal = $string;
# If ellipsis length is >= $length then we can't apply $adjustLength
if ( $adjustLength && strlen( $ellipsis ) >= abs( $length ) ) {
$string = $ellipsis; // this can be slightly unexpected
# Otherwise, truncate and add ellipsis...
} else {
$eLength = $adjustLength ? strlen( $ellipsis ) : 0;
if ( $length > 0 ) {
$length -= $eLength;
$string = substr( $string, 0, $length ); // xyz...
$string = $this->removeBadCharLast( $string );
$string = rtrim( $string );
$string = $string . $ellipsis;
} else {
$length += $eLength;
$string = substr( $string, $length ); // ...xyz
$string = $this->removeBadCharFirst( $string );
$string = ltrim( $string );
$string = $ellipsis . $string;
}
}
# Do not truncate if the ellipsis makes the string longer/equal (bug 22181).
# This check is *not* redundant if $adjustLength, due to the single case where
# LEN($ellipsis) > ABS($limit arg); $stringOriginal could be shorter than $string.
if ( strlen( $string ) < strlen( $stringOriginal ) ) {
return $string;
} else {
return $stringOriginal;
}
}
/**
* Remove bytes that represent an incomplete Unicode character
* at the end of string (e.g. bytes of the char are missing)
*
* @param string $string
* @return string
*/
protected function removeBadCharLast( $string ) {
if ( $string != '' ) {
$char = ord( $string[strlen( $string ) - 1] );
$m = array();
if ( $char >= 0xc0 ) {
# We got the first byte only of a multibyte char; remove it.
$string = substr( $string, 0, -1 );
} elseif ( $char >= 0x80 &&
preg_match( '/^(.*)(?:[\xe0-\xef][\x80-\xbf]|' .
'[\xf0-\xf7][\x80-\xbf]{1,2})$/', $string, $m )
) {
# We chopped in the middle of a character; remove it
$string = $m[1];
}
}
return $string;
}
/**
* Remove bytes that represent an incomplete Unicode character
* at the start of string (e.g. bytes of the char are missing)
*
* @param string $string
* @return string
*/
protected function removeBadCharFirst( $string ) {
if ( $string != '' ) {
$char = ord( $string[0] );
if ( $char >= 0x80 && $char < 0xc0 ) {
# We chopped in the middle of a character; remove the whole thing
$string = preg_replace( '/^[\x80-\xbf]+/', '', $string );
}
}
return $string;
}
/**
* Truncate a string of valid HTML to a specified length in bytes,
* appending an optional string (e.g. for ellipses), and return valid HTML
*
* This is only intended for styled/linked text, such as HTML with
* tags like <span> and <a>, were the tags are self-contained (valid HTML).
* Also, this will not detect things like "display:none" CSS.
*
* Note: since 1.18 you do not need to leave extra room in $length for ellipses.
*
* @param string $text HTML string to truncate
* @param int $length (zero/positive) Maximum length (including ellipses)
* @param string $ellipsis String to append to the truncated text
* @return string
*/
function truncateHtml( $text, $length, $ellipsis = '...' ) {
# Use the localized ellipsis character
if ( $ellipsis == '...' ) {
$ellipsis = wfMessage( 'ellipsis' )->inLanguage( $this )->escaped();
}
# Check if there is clearly no need to truncate
if ( $length <= 0 ) {
return $ellipsis; // no text shown, nothing to format (convention)
} elseif ( strlen( $text ) <= $length ) {
return $text; // string short enough even *with* HTML (short-circuit)
}
$dispLen = 0; // innerHTML legth so far
$testingEllipsis = false; // checking if ellipses will make string longer/equal?
$tagType = 0; // 0-open, 1-close
$bracketState = 0; // 1-tag start, 2-tag name, 0-neither
$entityState = 0; // 0-not entity, 1-entity
$tag = $ret = ''; // accumulated tag name, accumulated result string
$openTags = array(); // open tag stack
$maybeState = null; // possible truncation state
$textLen = strlen( $text );
$neLength = max( 0, $length - strlen( $ellipsis ) ); // non-ellipsis len if truncated
for ( $pos = 0; true; ++$pos ) {
# Consider truncation once the display length has reached the maximim.
# We check if $dispLen > 0 to grab tags for the $neLength = 0 case.
# Check that we're not in the middle of a bracket/entity...
if ( $dispLen && $dispLen >= $neLength && $bracketState == 0 && !$entityState ) {
if ( !$testingEllipsis ) {
$testingEllipsis = true;
# Save where we are; we will truncate here unless there turn out to
# be so few remaining characters that truncation is not necessary.
if ( !$maybeState ) { // already saved? ($neLength = 0 case)
$maybeState = array( $ret, $openTags ); // save state
}
} elseif ( $dispLen > $length && $dispLen > strlen( $ellipsis ) ) {
# String in fact does need truncation, the truncation point was OK.
list( $ret, $openTags ) = $maybeState; // reload state
$ret = $this->removeBadCharLast( $ret ); // multi-byte char fix
$ret .= $ellipsis; // add ellipsis
break;
}
}
if ( $pos >= $textLen ) {
break; // extra iteration just for above checks
}
# Read the next char...
$ch = $text[$pos];
$lastCh = $pos ? $text[$pos - 1] : '';
$ret .= $ch; // add to result string
if ( $ch == '<' ) {
$this->truncate_endBracket( $tag, $tagType, $lastCh, $openTags ); // for bad HTML
$entityState = 0; // for bad HTML
$bracketState = 1; // tag started (checking for backslash)
} elseif ( $ch == '>' ) {
$this->truncate_endBracket( $tag, $tagType, $lastCh, $openTags );
$entityState = 0; // for bad HTML
$bracketState = 0; // out of brackets
} elseif ( $bracketState == 1 ) {
if ( $ch == '/' ) {
$tagType = 1; // close tag (e.g. "</span>")
} else {
$tagType = 0; // open tag (e.g. "<span>")
$tag .= $ch;
}
$bracketState = 2; // building tag name
} elseif ( $bracketState == 2 ) {
if ( $ch != ' ' ) {
$tag .= $ch;
} else {
// Name found (e.g. "<a href=..."), add on tag attributes...
$pos += $this->truncate_skip( $ret, $text, "<>", $pos + 1 );
}
} elseif ( $bracketState == 0 ) {
if ( $entityState ) {
if ( $ch == ';' ) {
$entityState = 0;
$dispLen++; // entity is one displayed char
}
} else {
if ( $neLength == 0 && !$maybeState ) {
// Save state without $ch. We want to *hit* the first
// display char (to get tags) but not *use* it if truncating.
$maybeState = array( substr( $ret, 0, -1 ), $openTags );
}
if ( $ch == '&' ) {
$entityState = 1; // entity found, (e.g. " ")
} else {
$dispLen++; // this char is displayed
// Add the next $max display text chars after this in one swoop...
$max = ( $testingEllipsis ? $length : $neLength ) - $dispLen;
$skipped = $this->truncate_skip( $ret, $text, "<>&", $pos + 1, $max );
$dispLen += $skipped;
$pos += $skipped;
}
}
}
}
// Close the last tag if left unclosed by bad HTML
$this->truncate_endBracket( $tag, $text[$textLen - 1], $tagType, $openTags );
while ( count( $openTags ) > 0 ) {
$ret .= '</' . array_pop( $openTags ) . '>'; // close open tags
}
return $ret;
}
/**
* truncateHtml() helper function
* like strcspn() but adds the skipped chars to $ret
*
* @param string $ret
* @param string $text
* @param string $search
* @param int $start
* @param null|int $len
* @return int
*/
private function truncate_skip( &$ret, $text, $search, $start, $len = null ) {
if ( $len === null ) {
$len = -1; // -1 means "no limit" for strcspn
} elseif ( $len < 0 ) {
$len = 0; // sanity
}
$skipCount = 0;
if ( $start < strlen( $text ) ) {
$skipCount = strcspn( $text, $search, $start, $len );
$ret .= substr( $text, $start, $skipCount );
}
return $skipCount;
}
/**
* truncateHtml() helper function
* (a) push or pop $tag from $openTags as needed
* (b) clear $tag value
* @param string &$tag Current HTML tag name we are looking at
* @param int $tagType (0-open tag, 1-close tag)
* @param string $lastCh Character before the '>' that ended this tag
* @param array &$openTags Open tag stack (not accounting for $tag)
*/
private function truncate_endBracket( &$tag, $tagType, $lastCh, &$openTags ) {
$tag = ltrim( $tag );
if ( $tag != '' ) {
if ( $tagType == 0 && $lastCh != '/' ) {
$openTags[] = $tag; // tag opened (didn't close itself)
} elseif ( $tagType == 1 ) {
if ( $openTags && $tag == $openTags[count( $openTags ) - 1] ) {
array_pop( $openTags ); // tag closed
}
}
$tag = '';
}
}
/**
* Grammatical transformations, needed for inflected languages
* Invoked by putting {{grammar:case|word}} in a message
*
* @param string $word
* @param string $case
* @return string
*/
function convertGrammar( $word, $case ) {
global $wgGrammarForms;
if ( isset( $wgGrammarForms[$this->getCode()][$case][$word] ) ) {
return $wgGrammarForms[$this->getCode()][$case][$word];
}
return $word;
}
/**
* Get the grammar forms for the content language
* @return array Array of grammar forms
* @since 1.20
*/
function getGrammarForms() {
global $wgGrammarForms;
if ( isset( $wgGrammarForms[$this->getCode()] )
&& is_array( $wgGrammarForms[$this->getCode()] )
) {
return $wgGrammarForms[$this->getCode()];
}
return array();
}
/**
* Provides an alternative text depending on specified gender.
* Usage {{gender:username|masculine|feminine|unknown}}.
* username is optional, in which case the gender of current user is used,
* but only in (some) interface messages; otherwise default gender is used.
*
* If no forms are given, an empty string is returned. If only one form is
* given, it will be returned unconditionally. These details are implied by
* the caller and cannot be overridden in subclasses.
*
* If three forms are given, the default is to use the third (unknown) form.
* If fewer than three forms are given, the default is to use the first (masculine) form.
* These details can be overridden in subclasses.
*
* @param string $gender
* @param array $forms
*
* @return string
*/
function gender( $gender, $forms ) {
if ( !count( $forms ) ) {
return '';
}
$forms = $this->preConvertPlural( $forms, 2 );
if ( $gender === 'male' ) {
return $forms[0];
}
if ( $gender === 'female' ) {
return $forms[1];
}
return isset( $forms[2] ) ? $forms[2] : $forms[0];
}
/**
* Plural form transformations, needed for some languages.
* For example, there are 3 form of plural in Russian and Polish,
* depending on "count mod 10". See [[w:Plural]]
* For English it is pretty simple.
*
* Invoked by putting {{plural:count|wordform1|wordform2}}
* or {{plural:count|wordform1|wordform2|wordform3}}
*
* Example: {{plural:{{NUMBEROFARTICLES}}|article|articles}}
*
* @param int $count Non-localized number
* @param array $forms Different plural forms
* @return string Correct form of plural for $count in this language
*/
function convertPlural( $count, $forms ) {
// Handle explicit n=pluralform cases
$forms = $this->handleExplicitPluralForms( $count, $forms );
if ( is_string( $forms ) ) {
return $forms;
}
if ( !count( $forms ) ) {
return '';
}
$pluralForm = $this->getPluralRuleIndexNumber( $count );
$pluralForm = min( $pluralForm, count( $forms ) - 1 );
return $forms[$pluralForm];
}
/**
* Handles explicit plural forms for Language::convertPlural()
*
* In {{PLURAL:$1|0=nothing|one|many}}, 0=nothing will be returned if $1 equals zero.
* If an explicitly defined plural form matches the $count, then
* string value returned, otherwise array returned for further consideration
* by CLDR rules or overridden convertPlural().
*
* @since 1.23
*
* @param int $count Non-localized number
* @param array $forms Different plural forms
*
* @return array|string
*/
protected function handleExplicitPluralForms( $count, array $forms ) {
foreach ( $forms as $index => $form ) {
if ( preg_match( '/\d+=/i', $form ) ) {
$pos = strpos( $form, '=' );
if ( substr( $form, 0, $pos ) === (string)$count ) {
return substr( $form, $pos + 1 );
}
unset( $forms[$index] );
}
}
return array_values( $forms );
}
/**
* Checks that convertPlural was given an array and pads it to requested
* amount of forms by copying the last one.
*
* @param array $forms Array of forms given to convertPlural
* @param int $count How many forms should there be at least
* @return array Padded array of forms or an exception if not an array
*/
protected function preConvertPlural( /* Array */ $forms, $count ) {
while ( count( $forms ) < $count ) {
$forms[] = $forms[count( $forms ) - 1];
}
return $forms;
}
/**
* @todo Maybe translate block durations. Note that this function is somewhat misnamed: it
* deals with translating the *duration* ("1 week", "4 days", etc), not the expiry time
* (which is an absolute timestamp). Please note: do NOT add this blindly, as it is used
* on old expiry lengths recorded in log entries. You'd need to provide the start date to
* match up with it.
*
* @param string $str The validated block duration in English
* @return string Somehow translated block duration
* @see LanguageFi.php for example implementation
*/
function translateBlockExpiry( $str ) {
$duration = SpecialBlock::getSuggestedDurations( $this );
foreach ( $duration as $show => $value ) {
if ( strcmp( $str, $value ) == 0 ) {
return htmlspecialchars( trim( $show ) );
}
}
if ( wfIsInfinity( $str ) ) {
foreach ( $duration as $show => $value ) {
if ( wfIsInfinity( $value ) ) {
return htmlspecialchars( trim( $show ) );
}
}
}
// If all else fails, return a standard duration or timestamp description.
$time = strtotime( $str, 0 );
if ( $time === false ) { // Unknown format. Return it as-is in case.
return $str;
} elseif ( $time !== strtotime( $str, 1 ) ) { // It's a relative timestamp.
// $time is relative to 0 so it's a duration length.
return $this->formatDuration( $time );
} else { // It's an absolute timestamp.
if ( $time === 0 ) {
// wfTimestamp() handles 0 as current time instead of epoch.
return $this->timeanddate( '19700101000000' );
} else {
return $this->timeanddate( $time );
}
}
}
/**
* languages like Chinese need to be segmented in order for the diff
* to be of any use
*
* @param string $text
* @return string
*/
public function segmentForDiff( $text ) {
return $text;
}
/**
* and unsegment to show the result
*
* @param string $text
* @return string
*/
public function unsegmentForDiff( $text ) {
return $text;
}
/**
* Return the LanguageConverter used in the Language
*
* @since 1.19
* @return LanguageConverter
*/
public function getConverter() {
return $this->mConverter;
}
/**
* convert text to all supported variants
*
* @param string $text
* @return array
*/
public function autoConvertToAllVariants( $text ) {
return $this->mConverter->autoConvertToAllVariants( $text );
}
/**
* convert text to different variants of a language.
*
* @param string $text
* @return string
*/
public function convert( $text ) {
return $this->mConverter->convert( $text );
}
/**
* Convert a Title object to a string in the preferred variant
*
* @param Title $title
* @return string
*/
public function convertTitle( $title ) {
return $this->mConverter->convertTitle( $title );
}
/**
* Convert a namespace index to a string in the preferred variant
*
* @param int $ns
* @return string
*/
public function convertNamespace( $ns ) {
return $this->mConverter->convertNamespace( $ns );
}
/**
* Check if this is a language with variants
*
* @return bool
*/
public function hasVariants() {
return count( $this->getVariants() ) > 1;
}
/**
* Check if the language has the specific variant
*
* @since 1.19
* @param string $variant
* @return bool
*/
public function hasVariant( $variant ) {
return (bool)$this->mConverter->validateVariant( $variant );
}
/**
* Put custom tags (e.g. -{ }-) around math to prevent conversion
*
* @param string $text
* @return string
* @deprecated since 1.22 is no longer used
*/
public function armourMath( $text ) {
return $this->mConverter->armourMath( $text );
}
/**
* Perform output conversion on a string, and encode for safe HTML output.
* @param string $text Text to be converted
* @param bool $isTitle Whether this conversion is for the article title
* @return string
* @todo this should get integrated somewhere sane
*/
public function convertHtml( $text, $isTitle = false ) {
return htmlspecialchars( $this->convert( $text, $isTitle ) );
}
/**
* @param string $key
* @return string
*/
public function convertCategoryKey( $key ) {
return $this->mConverter->convertCategoryKey( $key );
}
/**
* Get the list of variants supported by this language
* see sample implementation in LanguageZh.php
*
* @return array An array of language codes
*/
public function getVariants() {
return $this->mConverter->getVariants();
}
/**
* @return string
*/
public function getPreferredVariant() {
return $this->mConverter->getPreferredVariant();
}
/**
* @return string
*/
public function getDefaultVariant() {
return $this->mConverter->getDefaultVariant();
}
/**
* @return string
*/
public function getURLVariant() {
return $this->mConverter->getURLVariant();
}
/**
* If a language supports multiple variants, it is
* possible that non-existing link in one variant
* actually exists in another variant. this function
* tries to find it. See e.g. LanguageZh.php
* The input parameters may be modified upon return
*
* @param string &$link The name of the link
* @param Title &$nt The title object of the link
* @param bool $ignoreOtherCond To disable other conditions when
* we need to transclude a template or update a category's link
*/
public function findVariantLink( &$link, &$nt, $ignoreOtherCond = false ) {
$this->mConverter->findVariantLink( $link, $nt, $ignoreOtherCond );
}
/**
* returns language specific options used by User::getPageRenderHash()
* for example, the preferred language variant
*
* @return string
*/
function getExtraHashOptions() {
return $this->mConverter->getExtraHashOptions();
}
/**
* For languages that support multiple variants, the title of an
* article may be displayed differently in different variants. this
* function returns the apporiate title defined in the body of the article.
*
* @return string
*/
public function getParsedTitle() {
return $this->mConverter->getParsedTitle();
}
/**
* Prepare external link text for conversion. When the text is
* a URL, it shouldn't be converted, and it'll be wrapped in
* the "raw" tag (-{R| }-) to prevent conversion.
*
* This function is called "markNoConversion" for historical
* reasons.
*
* @param string $text Text to be used for external link
* @param bool $noParse Wrap it without confirming it's a real URL first
* @return string The tagged text
*/
public function markNoConversion( $text, $noParse = false ) {
// Excluding protocal-relative URLs may avoid many false positives.
if ( $noParse || preg_match( '/^(?:' . wfUrlProtocolsWithoutProtRel() . ')/', $text ) ) {
return $this->mConverter->markNoConversion( $text );
} else {
return $text;
}
}
/**
* A regular expression to match legal word-trailing characters
* which should be merged onto a link of the form [[foo]]bar.
*
* @return string
*/
public function linkTrail() {
return self::$dataCache->getItem( $this->mCode, 'linkTrail' );
}
/**
* A regular expression character set to match legal word-prefixing
* characters which should be merged onto a link of the form foo[[bar]].
*
* @return string
*/
public function linkPrefixCharset() {
return self::$dataCache->getItem( $this->mCode, 'linkPrefixCharset' );
}
/**
* @deprecated since 1.24, will be removed in 1.25
* @return Language
*/
function getLangObj() {
wfDeprecated( __METHOD__, '1.24' );
return $this;
}
/**
* Get the "parent" language which has a converter to convert a "compatible" language
* (in another variant) to this language (eg. zh for zh-cn, but not en for en-gb).
*
* @return Language|null
* @since 1.22
*/
public function getParentLanguage() {
if ( $this->mParentLanguage !== false ) {
return $this->mParentLanguage;
}
$pieces = explode( '-', $this->getCode() );
$code = $pieces[0];
if ( !in_array( $code, LanguageConverter::$languagesWithVariants ) ) {
$this->mParentLanguage = null;
return null;
}
$lang = Language::factory( $code );
if ( !$lang->hasVariant( $this->getCode() ) ) {
$this->mParentLanguage = null;
return null;
}
$this->mParentLanguage = $lang;
return $lang;
}
/**
* Get the RFC 3066 code for this language object
*
* NOTE: The return value of this function is NOT HTML-safe and must be escaped with
* htmlspecialchars() or similar
*
* @return string
*/
public function getCode() {
return $this->mCode;
}
/**
* Get the code in Bcp47 format which we can use
* inside of html lang="" tags.
*
* NOTE: The return value of this function is NOT HTML-safe and must be escaped with
* htmlspecialchars() or similar.
*
* @since 1.19
* @return string
*/
public function getHtmlCode() {
if ( is_null( $this->mHtmlCode ) ) {
$this->mHtmlCode = wfBCP47( $this->getCode() );
}
return $this->mHtmlCode;
}
/**
* @param string $code
*/
public function setCode( $code ) {
$this->mCode = $code;
// Ensure we don't leave incorrect cached data lying around
$this->mHtmlCode = null;
$this->mParentLanguage = false;
}
/**
* Get the name of a file for a certain language code
* @param string $prefix Prepend this to the filename
* @param string $code Language code
* @param string $suffix Append this to the filename
* @throws MWException
* @return string $prefix . $mangledCode . $suffix
*/
public static function getFileName( $prefix = 'Language', $code, $suffix = '.php' ) {
if ( !self::isValidBuiltInCode( $code ) ) {
throw new MWException( "Invalid language code \"$code\"" );
}
return $prefix . str_replace( '-', '_', ucfirst( $code ) ) . $suffix;
}
/**
* Get the language code from a file name. Inverse of getFileName()
* @param string $filename $prefix . $languageCode . $suffix
* @param string $prefix Prefix before the language code
* @param string $suffix Suffix after the language code
* @return string Language code, or false if $prefix or $suffix isn't found
*/
public static function getCodeFromFileName( $filename, $prefix = 'Language', $suffix = '.php' ) {
$m = null;
preg_match( '/' . preg_quote( $prefix, '/' ) . '([A-Z][a-z_]+)' .
preg_quote( $suffix, '/' ) . '/', $filename, $m );
if ( !count( $m ) ) {
return false;
}
return str_replace( '_', '-', strtolower( $m[1] ) );
}
/**
* @param string $code
* @return string
*/
public static function getMessagesFileName( $code ) {
global $IP;
$file = self::getFileName( "$IP/languages/messages/Messages", $code, '.php' );
Hooks::run( 'Language::getMessagesFileName', array( $code, &$file ) );
return $file;
}
/**
* @param string $code
* @return string
* @since 1.23
*/
public static function getJsonMessagesFileName( $code ) {
global $IP;
if ( !self::isValidBuiltInCode( $code ) ) {
throw new MWException( "Invalid language code \"$code\"" );
}
return "$IP/languages/i18n/$code.json";
}
/**
* @param string $code
* @return string
*/
public static function getClassFileName( $code ) {
global $IP;
return self::getFileName( "$IP/languages/classes/Language", $code, '.php' );
}
/**
* Get the first fallback for a given language.
*
* @param string $code
*
* @return bool|string
*/
public static function getFallbackFor( $code ) {
if ( $code === 'en' || !Language::isValidBuiltInCode( $code ) ) {
return false;
} else {
$fallbacks = self::getFallbacksFor( $code );
$first = array_shift( $fallbacks );
return $first;
}
}
/**
* Get the ordered list of fallback languages.
*
* @since 1.19
* @param string $code Language code
* @return array
*/
public static function getFallbacksFor( $code ) {
if ( $code === 'en' || !Language::isValidBuiltInCode( $code ) ) {
return array();
} else {
$v = self::getLocalisationCache()->getItem( $code, 'fallback' );
$v = array_map( 'trim', explode( ',', $v ) );
if ( $v[count( $v ) - 1] !== 'en' ) {
$v[] = 'en';
}
return $v;
}
}
/**
* Get the ordered list of fallback languages, ending with the fallback
* language chain for the site language.
*
* @since 1.22
* @param string $code Language code
* @return array Array( fallbacks, site fallbacks )
*/
public static function getFallbacksIncludingSiteLanguage( $code ) {
global $wgLanguageCode;
// Usually, we will only store a tiny number of fallback chains, so we
// keep them in static memory.
$cacheKey = "{$code}-{$wgLanguageCode}";
if ( !array_key_exists( $cacheKey, self::$fallbackLanguageCache ) ) {
$fallbacks = self::getFallbacksFor( $code );
// Append the site's fallback chain, including the site language itself
$siteFallbacks = self::getFallbacksFor( $wgLanguageCode );
array_unshift( $siteFallbacks, $wgLanguageCode );
// Eliminate any languages already included in the chain
$siteFallbacks = array_diff( $siteFallbacks, $fallbacks );
self::$fallbackLanguageCache[$cacheKey] = array( $fallbacks, $siteFallbacks );
}
return self::$fallbackLanguageCache[$cacheKey];
}
/**
* Get all messages for a given language
* WARNING: this may take a long time. If you just need all message *keys*
* but need the *contents* of only a few messages, consider using getMessageKeysFor().
*
* @param string $code
*
* @return array
*/
public static function getMessagesFor( $code ) {
return self::getLocalisationCache()->getItem( $code, 'messages' );
}
/**
* Get a message for a given language
*
* @param string $key
* @param string $code
*
* @return string
*/
public static function getMessageFor( $key, $code ) {
return self::getLocalisationCache()->getSubitem( $code, 'messages', $key );
}
/**
* Get all message keys for a given language. This is a faster alternative to
* array_keys( Language::getMessagesFor( $code ) )
*
* @since 1.19
* @param string $code Language code
* @return array Array of message keys (strings)
*/
public static function getMessageKeysFor( $code ) {
return self::getLocalisationCache()->getSubItemList( $code, 'messages' );
}
/**
* @param string $talk
* @return mixed
*/
function fixVariableInNamespace( $talk ) {
if ( strpos( $talk, '$1' ) === false ) {
return $talk;
}
global $wgMetaNamespace;
$talk = str_replace( '$1', $wgMetaNamespace, $talk );
# Allow grammar transformations
# Allowing full message-style parsing would make simple requests
# such as action=raw much more expensive than they need to be.
# This will hopefully cover most cases.
$talk = preg_replace_callback( '/{{grammar:(.*?)\|(.*?)}}/i',
array( &$this, 'replaceGrammarInNamespace' ), $talk );
return str_replace( ' ', '_', $talk );
}
/**
* @param string $m
* @return string
*/
function replaceGrammarInNamespace( $m ) {
return $this->convertGrammar( trim( $m[2] ), trim( $m[1] ) );
}
/**
* @throws MWException
* @return array
*/
static function getCaseMaps() {
static $wikiUpperChars, $wikiLowerChars;
if ( isset( $wikiUpperChars ) ) {
return array( $wikiUpperChars, $wikiLowerChars );
}
$arr = wfGetPrecompiledData( 'Utf8Case.ser' );
if ( $arr === false ) {
throw new MWException(
"Utf8Case.ser is missing, please run \"make\" in the serialized directory\n" );
}
$wikiUpperChars = $arr['wikiUpperChars'];
$wikiLowerChars = $arr['wikiLowerChars'];
return array( $wikiUpperChars, $wikiLowerChars );
}
/**
* Decode an expiry (block, protection, etc) which has come from the DB
*
* @todo FIXME: why are we returnings DBMS-dependent strings???
*
* @param string $expiry Database expiry String
* @param bool|int $format True to process using language functions, or TS_ constant
* to return the expiry in a given timestamp
* @return string
* @since 1.18
*/
public function formatExpiry( $expiry, $format = true ) {
static $infinity;
if ( $infinity === null ) {
$infinity = wfGetDB( DB_SLAVE )->getInfinity();
}
if ( $expiry == '' || $expiry == $infinity ) {
return $format === true
? $this->getMessageFromDB( 'infiniteblock' )
: $infinity;
} else {
return $format === true
? $this->timeanddate( $expiry, /* User preference timezone */ true )
: wfTimestamp( $format, $expiry );
}
}
/**
* @todo Document
* @param int|float $seconds
* @param array $format Optional
* If $format['avoid'] === 'avoidseconds': don't mention seconds if $seconds >= 1 hour.
* If $format['avoid'] === 'avoidminutes': don't mention seconds/minutes if $seconds > 48 hours.
* If $format['noabbrevs'] is true: use 'seconds' and friends instead of 'seconds-abbrev'
* and friends.
* For backwards compatibility, $format may also be one of the strings 'avoidseconds'
* or 'avoidminutes'.
* @return string
*/
function formatTimePeriod( $seconds, $format = array() ) {
if ( !is_array( $format ) ) {
$format = array( 'avoid' => $format ); // For backwards compatibility
}
if ( !isset( $format['avoid'] ) ) {
$format['avoid'] = false;
}
if ( !isset( $format['noabbrevs'] ) ) {
$format['noabbrevs'] = false;
}
$secondsMsg = wfMessage(
$format['noabbrevs'] ? 'seconds' : 'seconds-abbrev' )->inLanguage( $this );
$minutesMsg = wfMessage(
$format['noabbrevs'] ? 'minutes' : 'minutes-abbrev' )->inLanguage( $this );
$hoursMsg = wfMessage(
$format['noabbrevs'] ? 'hours' : 'hours-abbrev' )->inLanguage( $this );
$daysMsg = wfMessage(
$format['noabbrevs'] ? 'days' : 'days-abbrev' )->inLanguage( $this );
if ( round( $seconds * 10 ) < 100 ) {
$s = $this->formatNum( sprintf( "%.1f", round( $seconds * 10 ) / 10 ) );
$s = $secondsMsg->params( $s )->text();
} elseif ( round( $seconds ) < 60 ) {
$s = $this->formatNum( round( $seconds ) );
$s = $secondsMsg->params( $s )->text();
} elseif ( round( $seconds ) < 3600 ) {
$minutes = floor( $seconds / 60 );
$secondsPart = round( fmod( $seconds, 60 ) );
if ( $secondsPart == 60 ) {
$secondsPart = 0;
$minutes++;
}
$s = $minutesMsg->params( $this->formatNum( $minutes ) )->text();
$s .= ' ';
$s .= $secondsMsg->params( $this->formatNum( $secondsPart ) )->text();
} elseif ( round( $seconds ) <= 2 * 86400 ) {
$hours = floor( $seconds / 3600 );
$minutes = floor( ( $seconds - $hours * 3600 ) / 60 );
$secondsPart = round( $seconds - $hours * 3600 - $minutes * 60 );
if ( $secondsPart == 60 ) {
$secondsPart = 0;
$minutes++;
}
if ( $minutes == 60 ) {
$minutes = 0;
$hours++;
}
$s = $hoursMsg->params( $this->formatNum( $hours ) )->text();
$s .= ' ';
$s .= $minutesMsg->params( $this->formatNum( $minutes ) )->text();
if ( !in_array( $format['avoid'], array( 'avoidseconds', 'avoidminutes' ) ) ) {
$s .= ' ' . $secondsMsg->params( $this->formatNum( $secondsPart ) )->text();
}
} else {
$days = floor( $seconds / 86400 );
if ( $format['avoid'] === 'avoidminutes' ) {
$hours = round( ( $seconds - $days * 86400 ) / 3600 );
if ( $hours == 24 ) {
$hours = 0;
$days++;
}
$s = $daysMsg->params( $this->formatNum( $days ) )->text();
$s .= ' ';
$s .= $hoursMsg->params( $this->formatNum( $hours ) )->text();
} elseif ( $format['avoid'] === 'avoidseconds' ) {
$hours = floor( ( $seconds - $days * 86400 ) / 3600 );
$minutes = round( ( $seconds - $days * 86400 - $hours * 3600 ) / 60 );
if ( $minutes == 60 ) {
$minutes = 0;
$hours++;
}
if ( $hours == 24 ) {
$hours = 0;
$days++;
}
$s = $daysMsg->params( $this->formatNum( $days ) )->text();
$s .= ' ';
$s .= $hoursMsg->params( $this->formatNum( $hours ) )->text();
$s .= ' ';
$s .= $minutesMsg->params( $this->formatNum( $minutes ) )->text();
} else {
$s = $daysMsg->params( $this->formatNum( $days ) )->text();
$s .= ' ';
$s .= $this->formatTimePeriod( $seconds - $days * 86400, $format );
}
}
return $s;
}
/**
* Format a bitrate for output, using an appropriate
* unit (bps, kbps, Mbps, Gbps, Tbps, Pbps, Ebps, Zbps or Ybps) according to
* the magnitude in question.
*
* This use base 1000. For base 1024 use formatSize(), for another base
* see formatComputingNumbers().
*
* @param int $bps
* @return string
*/
function formatBitrate( $bps ) {
return $this->formatComputingNumbers( $bps, 1000, "bitrate-$1bits" );
}
/**
* @param int $size Size of the unit
* @param int $boundary Size boundary (1000, or 1024 in most cases)
* @param string $messageKey Message key to be uesd
* @return string
*/
function formatComputingNumbers( $size, $boundary, $messageKey ) {
if ( $size <= 0 ) {
return str_replace( '$1', $this->formatNum( $size ),
$this->getMessageFromDB( str_replace( '$1', '', $messageKey ) )
);
}
$sizes = array( '', 'kilo', 'mega', 'giga', 'tera', 'peta', 'exa', 'zeta', 'yotta' );
$index = 0;
$maxIndex = count( $sizes ) - 1;
while ( $size >= $boundary && $index < $maxIndex ) {
$index++;
$size /= $boundary;
}
// For small sizes no decimal places necessary
$round = 0;
if ( $index > 1 ) {
// For MB and bigger two decimal places are smarter
$round = 2;
}
$msg = str_replace( '$1', $sizes[$index], $messageKey );
$size = round( $size, $round );
$text = $this->getMessageFromDB( $msg );
return str_replace( '$1', $this->formatNum( $size ), $text );
}
/**
* Format a size in bytes for output, using an appropriate
* unit (B, KB, MB, GB, TB, PB, EB, ZB or YB) according to the magnitude in question
*
* This method use base 1024. For base 1000 use formatBitrate(), for
* another base see formatComputingNumbers()
*
* @param int $size Size to format
* @return string Plain text (not HTML)
*/
function formatSize( $size ) {
return $this->formatComputingNumbers( $size, 1024, "size-$1bytes" );
}
/**
* Make a list item, used by various special pages
*
* @param string $page Page link
* @param string $details HTML safe text between brackets
* @param bool $oppositedm Add the direction mark opposite to your
* language, to display text properly
* @return HTML escaped string
*/
function specialList( $page, $details, $oppositedm = true ) {
if ( !$details ) {
return $page;
}
$dirmark = ( $oppositedm ? $this->getDirMark( true ) : '' ) . $this->getDirMark();
return
$page .
$dirmark .
$this->msg( 'word-separator' )->escaped() .
$this->msg( 'parentheses' )->rawParams( $details )->escaped();
}
/**
* Generate (prev x| next x) (20|50|100...) type links for paging
*
* @param Title $title Title object to link
* @param int $offset
* @param int $limit
* @param array $query Optional URL query parameter string
* @param bool $atend Optional param for specified if this is the last page
* @return string
*/
public function viewPrevNext( Title $title, $offset, $limit,
array $query = array(), $atend = false
) {
// @todo FIXME: Why on earth this needs one message for the text and another one for tooltip?
# Make 'previous' link
$prev = wfMessage( 'prevn' )->inLanguage( $this )->title( $title )->numParams( $limit )->text();
if ( $offset > 0 ) {
$plink = $this->numLink( $title, max( $offset - $limit, 0 ), $limit,
$query, $prev, 'prevn-title', 'mw-prevlink' );
} else {
$plink = htmlspecialchars( $prev );
}
# Make 'next' link
$next = wfMessage( 'nextn' )->inLanguage( $this )->title( $title )->numParams( $limit )->text();
if ( $atend ) {
$nlink = htmlspecialchars( $next );
} else {
$nlink = $this->numLink( $title, $offset + $limit, $limit,
$query, $next, 'nextn-title', 'mw-nextlink' );
}
# Make links to set number of items per page
$numLinks = array();
foreach ( array( 20, 50, 100, 250, 500 ) as $num ) {
$numLinks[] = $this->numLink( $title, $offset, $num,
$query, $this->formatNum( $num ), 'shown-title', 'mw-numlink' );
}
return wfMessage( 'viewprevnext' )->inLanguage( $this )->title( $title
)->rawParams( $plink, $nlink, $this->pipeList( $numLinks ) )->escaped();
}
/**
* Helper function for viewPrevNext() that generates links
*
* @param Title $title Title object to link
* @param int $offset
* @param int $limit
* @param array $query Extra query parameters
* @param string $link Text to use for the link; will be escaped
* @param string $tooltipMsg Name of the message to use as tooltip
* @param string $class Value of the "class" attribute of the link
* @return string HTML fragment
*/
private function numLink( Title $title, $offset, $limit, array $query, $link,
$tooltipMsg, $class
) {
$query = array( 'limit' => $limit, 'offset' => $offset ) + $query;
$tooltip = wfMessage( $tooltipMsg )->inLanguage( $this )->title( $title )
->numParams( $limit )->text();
return Html::element( 'a', array( 'href' => $title->getLocalURL( $query ),
'title' => $tooltip, 'class' => $class ), $link );
}
/**
* Get the conversion rule title, if any.
*
* @return string
*/
public function getConvRuleTitle() {
return $this->mConverter->getConvRuleTitle();
}
/**
* Get the compiled plural rules for the language
* @since 1.20
* @return array Associative array with plural form, and plural rule as key-value pairs
*/
public function getCompiledPluralRules() {
$pluralRules = self::$dataCache->getItem( strtolower( $this->mCode ), 'compiledPluralRules' );
$fallbacks = Language::getFallbacksFor( $this->mCode );
if ( !$pluralRules ) {
foreach ( $fallbacks as $fallbackCode ) {
$pluralRules = self::$dataCache->getItem( strtolower( $fallbackCode ), 'compiledPluralRules' );
if ( $pluralRules ) {
break;
}
}
}
return $pluralRules;
}
/**
* Get the plural rules for the language
* @since 1.20
* @return array Associative array with plural form number and plural rule as key-value pairs
*/
public function getPluralRules() {
$pluralRules = self::$dataCache->getItem( strtolower( $this->mCode ), 'pluralRules' );
$fallbacks = Language::getFallbacksFor( $this->mCode );
if ( !$pluralRules ) {
foreach ( $fallbacks as $fallbackCode ) {
$pluralRules = self::$dataCache->getItem( strtolower( $fallbackCode ), 'pluralRules' );
if ( $pluralRules ) {
break;
}
}
}
return $pluralRules;
}
/**
* Get the plural rule types for the language
* @since 1.22
* @return array Associative array with plural form number and plural rule type as key-value pairs
*/
public function getPluralRuleTypes() {
$pluralRuleTypes = self::$dataCache->getItem( strtolower( $this->mCode ), 'pluralRuleTypes' );
$fallbacks = Language::getFallbacksFor( $this->mCode );
if ( !$pluralRuleTypes ) {
foreach ( $fallbacks as $fallbackCode ) {
$pluralRuleTypes = self::$dataCache->getItem( strtolower( $fallbackCode ), 'pluralRuleTypes' );
if ( $pluralRuleTypes ) {
break;
}
}
}
return $pluralRuleTypes;
}
/**
* Find the index number of the plural rule appropriate for the given number
* @param int $number
* @return int The index number of the plural rule
*/
public function getPluralRuleIndexNumber( $number ) {
$pluralRules = $this->getCompiledPluralRules();
$form = CLDRPluralRuleEvaluator::evaluateCompiled( $number, $pluralRules );
return $form;
}
/**
* Find the plural rule type appropriate for the given number
* For example, if the language is set to Arabic, getPluralType(5) should
* return 'few'.
* @since 1.22
* @param int $number
* @return string The name of the plural rule type, e.g. one, two, few, many
*/
public function getPluralRuleType( $number ) {
$index = $this->getPluralRuleIndexNumber( $number );
$pluralRuleTypes = $this->getPluralRuleTypes();
if ( isset( $pluralRuleTypes[$index] ) ) {
return $pluralRuleTypes[$index];
} else {
return 'other';
}
}
}
Mini Shell