1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999
|
<?php
/**
* @file
* @ingroup Cache
*/
/**
*
*/
define( 'MSG_LOAD_TIMEOUT', 60 );
define( 'MSG_LOCK_TIMEOUT', 10 );
define( 'MSG_WAIT_TIMEOUT', 10 );
define( 'MSG_CACHE_VERSION', 1 );
/**
* Message cache
* Performs various MediaWiki namespace-related functions
* @ingroup Cache
*/
class MessageCache {
/**
* Process local cache of loaded messages that are defined in
* MediaWiki namespace. First array level is a language code,
* second level is message key and the values are either message
* content prefixed with space, or !NONEXISTENT for negative
* caching.
*/
protected $mCache;
// Should mean that database cannot be used, but check
protected $mDisable;
/// Lifetime for cache, used by object caching
protected $mExpiry;
/**
* Message cache has it's own parser which it uses to transform
* messages.
*/
protected $mParserOptions, $mParser;
/// Variable for tracking which variables are already loaded
protected $mLoadedLanguages = array();
/**
* Used for automatic detection of most used messages.
*/
protected $mRequestedMessages = array();
/**
* How long the message request counts are stored. Longer period gives
* better sample, but also takes longer to adapt changes. The counts
* are aggregrated per day, regardless of the value of this variable.
*/
protected static $mAdaptiveDataAge = 604800; // Is 7*24*3600
/**
* Filter the tail of less used messages that are requested more seldom
* than this factor times the number of request of most requested message.
* These messages are not loaded in the default set, but are still cached
* individually on demand with the normal cache expiry time.
*/
protected static $mAdaptiveInclusionThreshold = 0.05;
/**
* Singleton instance
*
* @var MessageCache
*/
private static $instance;
/**
* @var bool
*/
protected $mInParser = false;
/**
* Get the signleton instance of this class
*
* @since 1.18
* @return MessageCache object
*/
public static function singleton() {
if ( is_null( self::$instance ) ) {
global $wgUseDatabaseMessages, $wgMsgCacheExpiry;
self::$instance = new self( wfGetMessageCacheStorage(), $wgUseDatabaseMessages, $wgMsgCacheExpiry );
}
return self::$instance;
}
/**
* Destroy the singleton instance
*
* @since 1.18
*/
public static function destroyInstance() {
self::$instance = null;
}
function __construct( $memCached, $useDB, $expiry ) {
if ( !$memCached ) {
$memCached = wfGetCache( CACHE_NONE );
}
$this->mMemc = $memCached;
$this->mDisable = !$useDB;
$this->mExpiry = $expiry;
}
/**
* ParserOptions is lazy initialised.
*
* @return ParserOptions
*/
function getParserOptions() {
if ( !$this->mParserOptions ) {
$this->mParserOptions = new ParserOptions;
}
return $this->mParserOptions;
}
/**
* Try to load the cache from a local file.
* Actual format of the file depends on the $wgLocalMessageCacheSerialized
* setting.
*
* @param $hash String: the hash of contents, to check validity.
* @param $code Mixed: Optional language code, see documenation of load().
* @return false on failure.
*/
function loadFromLocal( $hash, $code ) {
global $wgCacheDirectory, $wgLocalMessageCacheSerialized;
$filename = "$wgCacheDirectory/messages-" . wfWikiID() . "-$code";
# Check file existence
wfSuppressWarnings();
$file = fopen( $filename, 'r' );
wfRestoreWarnings();
if ( !$file ) {
return false; // No cache file
}
if ( $wgLocalMessageCacheSerialized ) {
// Check to see if the file has the hash specified
$localHash = fread( $file, 32 );
if ( $hash === $localHash ) {
// All good, get the rest of it
$serialized = '';
while ( !feof( $file ) ) {
$serialized .= fread( $file, 100000 );
}
fclose( $file );
return $this->setCache( unserialize( $serialized ), $code );
} else {
fclose( $file );
return false; // Wrong hash
}
} else {
$localHash = substr( fread( $file, 40 ), 8 );
fclose( $file );
if ( $hash != $localHash ) {
return false; // Wrong hash
}
# Require overwrites the member variable or just shadows it?
require( $filename );
return $this->setCache( $this->mCache, $code );
}
}
/**
* Save the cache to a local file.
*/
function saveToLocal( $serialized, $hash, $code ) {
global $wgCacheDirectory;
$filename = "$wgCacheDirectory/messages-" . wfWikiID() . "-$code";
wfMkdirParents( $wgCacheDirectory, null, __METHOD__ ); // might fail
wfSuppressWarnings();
$file = fopen( $filename, 'w' );
wfRestoreWarnings();
if ( !$file ) {
wfDebug( "Unable to open local cache file for writing\n" );
return;
}
fwrite( $file, $hash . $serialized );
fclose( $file );
wfSuppressWarnings();
chmod( $filename, 0666 );
wfRestoreWarnings();
}
function saveToScript( $array, $hash, $code ) {
global $wgCacheDirectory;
$filename = "$wgCacheDirectory/messages-" . wfWikiID() . "-$code";
$tempFilename = $filename . '.tmp';
wfMkdirParents( $wgCacheDirectory, null, __METHOD__ ); // might fail
wfSuppressWarnings();
$file = fopen( $tempFilename, 'w' );
wfRestoreWarnings();
if ( !$file ) {
wfDebug( "Unable to open local cache file for writing\n" );
return;
}
fwrite( $file, "<?php\n//$hash\n\n \$this->mCache = array(" );
foreach ( $array as $key => $message ) {
$key = $this->escapeForScript( $key );
$message = $this->escapeForScript( $message );
fwrite( $file, "'$key' => '$message',\n" );
}
fwrite( $file, ");\n?>" );
fclose( $file);
rename( $tempFilename, $filename );
}
function escapeForScript( $string ) {
$string = str_replace( '\\', '\\\\', $string );
$string = str_replace( '\'', '\\\'', $string );
return $string;
}
/**
* Set the cache to $cache, if it is valid. Otherwise set the cache to false.
*
* @return bool
*/
function setCache( $cache, $code ) {
if ( isset( $cache['VERSION'] ) && $cache['VERSION'] == MSG_CACHE_VERSION ) {
$this->mCache[$code] = $cache;
return true;
} else {
return false;
}
}
/**
* Loads messages from caches or from database in this order:
* (1) local message cache (if $wgUseLocalMessageCache is enabled)
* (2) memcached
* (3) from the database.
*
* When succesfully loading from (2) or (3), all higher level caches are
* updated for the newest version.
*
* Nothing is loaded if member variable mDisable is true, either manually
* set by calling code or if message loading fails (is this possible?).
*
* Returns true if cache is already populated or it was succesfully populated,
* or false if populating empty cache fails. Also returns true if MessageCache
* is disabled.
*
* @param $code String: language to which load messages
*/
function load( $code = false ) {
global $wgUseLocalMessageCache;
if( !is_string( $code ) ) {
# This isn't really nice, so at least make a note about it and try to
# fall back
wfDebug( __METHOD__ . " called without providing a language code\n" );
$code = 'en';
}
# Don't do double loading...
if ( isset( $this->mLoadedLanguages[$code] ) ) {
return true;
}
# 8 lines of code just to say (once) that message cache is disabled
if ( $this->mDisable ) {
static $shownDisabled = false;
if ( !$shownDisabled ) {
wfDebug( __METHOD__ . ": disabled\n" );
$shownDisabled = true;
}
return true;
}
# Loading code starts
wfProfileIn( __METHOD__ );
$success = false; # Keep track of success
$where = array(); # Debug info, delayed to avoid spamming debug log too much
$cacheKey = wfMemcKey( 'messages', $code ); # Key in memc for messages
# (1) local cache
# Hash of the contents is stored in memcache, to detect if local cache goes
# out of date (due to update in other thread?)
if ( $wgUseLocalMessageCache ) {
wfProfileIn( __METHOD__ . '-fromlocal' );
$hash = $this->mMemc->get( wfMemcKey( 'messages', $code, 'hash' ) );
if ( $hash ) {
$success = $this->loadFromLocal( $hash, $code );
if ( $success ) $where[] = 'got from local cache';
}
wfProfileOut( __METHOD__ . '-fromlocal' );
}
# (2) memcache
# Fails if nothing in cache, or in the wrong version.
if ( !$success ) {
wfProfileIn( __METHOD__ . '-fromcache' );
$cache = $this->mMemc->get( $cacheKey );
$success = $this->setCache( $cache, $code );
if ( $success ) {
$where[] = 'got from global cache';
$this->saveToCaches( $cache, false, $code );
}
wfProfileOut( __METHOD__ . '-fromcache' );
}
# (3)
# Nothing in caches... so we need create one and store it in caches
if ( !$success ) {
$where[] = 'cache is empty';
$where[] = 'loading from database';
$this->lock( $cacheKey );
# Limit the concurrency of loadFromDB to a single process
# This prevents the site from going down when the cache expires
$statusKey = wfMemcKey( 'messages', $code, 'status' );
$success = $this->mMemc->add( $statusKey, 'loading', MSG_LOAD_TIMEOUT );
if ( $success ) {
$cache = $this->loadFromDB( $code );
$success = $this->setCache( $cache, $code );
}
if ( $success ) {
$success = $this->saveToCaches( $cache, true, $code );
if ( $success ) {
$this->mMemc->delete( $statusKey );
} else {
$this->mMemc->set( $statusKey, 'error', 60 * 5 );
wfDebug( "MemCached set error in MessageCache: restart memcached server!\n" );
}
}
$this->unlock($cacheKey);
}
if ( !$success ) {
# Bad luck... this should not happen
$where[] = 'loading FAILED - cache is disabled';
$info = implode( ', ', $where );
wfDebug( __METHOD__ . ": Loading $code... $info\n" );
$this->mDisable = true;
$this->mCache = false;
} else {
# All good, just record the success
$info = implode( ', ', $where );
wfDebug( __METHOD__ . ": Loading $code... $info\n" );
$this->mLoadedLanguages[$code] = true;
}
wfProfileOut( __METHOD__ );
return $success;
}
/**
* Loads cacheable messages from the database. Messages bigger than
* $wgMaxMsgCacheEntrySize are assigned a special value, and are loaded
* on-demand from the database later.
*
* @param $code String: language code.
* @return Array: loaded messages for storing in caches.
*/
function loadFromDB( $code ) {
wfProfileIn( __METHOD__ );
global $wgMaxMsgCacheEntrySize, $wgLanguageCode, $wgAdaptiveMessageCache;
$dbr = wfGetDB( DB_SLAVE );
$cache = array();
# Common conditions
$conds = array(
'page_is_redirect' => 0,
'page_namespace' => NS_MEDIAWIKI,
);
$mostused = array();
if ( $wgAdaptiveMessageCache ) {
$mostused = $this->getMostUsedMessages();
if ( $code !== $wgLanguageCode ) {
foreach ( $mostused as $key => $value ) {
$mostused[$key] = "$value/$code";
}
}
}
if ( count( $mostused ) ) {
$conds['page_title'] = $mostused;
} elseif ( $code !== $wgLanguageCode ) {
$conds[] = 'page_title' . $dbr->buildLike( $dbr->anyString(), "/$code" );
} else {
# Effectively disallows use of '/' character in NS_MEDIAWIKI for uses
# other than language code.
$conds[] = 'page_title NOT' . $dbr->buildLike( $dbr->anyString(), '/', $dbr->anyString() );
}
# Conditions to fetch oversized pages to ignore them
$bigConds = $conds;
$bigConds[] = 'page_len > ' . intval( $wgMaxMsgCacheEntrySize );
# Load titles for all oversized pages in the MediaWiki namespace
$res = $dbr->select( 'page', 'page_title', $bigConds, __METHOD__ . "($code)-big" );
foreach ( $res as $row ) {
$cache[$row->page_title] = '!TOO BIG';
}
# Conditions to load the remaining pages with their contents
$smallConds = $conds;
$smallConds[] = 'page_latest=rev_id';
$smallConds[] = 'rev_text_id=old_id';
$smallConds[] = 'page_len <= ' . intval( $wgMaxMsgCacheEntrySize );
$res = $dbr->select(
array( 'page', 'revision', 'text' ),
array( 'page_title', 'old_text', 'old_flags' ),
$smallConds,
__METHOD__ . "($code)-small"
);
foreach ( $res as $row ) {
$text = Revision::getRevisionText( $row );
if( $text === false ) {
// Failed to fetch data; possible ES errors?
// Store a marker to fetch on-demand as a workaround...
$entry = '!TOO BIG';
wfDebugLog( 'MessageCache', __METHOD__ . ": failed to load message page text for {$row->page_title} ($code)" );
} else {
$entry = ' ' . $text;
}
$cache[$row->page_title] = $entry;
}
foreach ( $mostused as $key ) {
if ( !isset( $cache[$key] ) ) {
$cache[$key] = '!NONEXISTENT';
}
}
$cache['VERSION'] = MSG_CACHE_VERSION;
wfProfileOut( __METHOD__ );
return $cache;
}
/**
* Updates cache as necessary when message page is changed
*
* @param $title String: name of the page changed.
* @param $text Mixed: new contents of the page.
*/
public function replace( $title, $text ) {
global $wgMaxMsgCacheEntrySize;
wfProfileIn( __METHOD__ );
if ( $this->mDisable ) {
wfProfileOut( __METHOD__ );
return;
}
list( $msg, $code ) = $this->figureMessage( $title );
$cacheKey = wfMemcKey( 'messages', $code );
$this->load( $code );
$this->lock( $cacheKey );
$titleKey = wfMemcKey( 'messages', 'individual', $title );
if ( $text === false ) {
# Article was deleted
$this->mCache[$code][$title] = '!NONEXISTENT';
$this->mMemc->delete( $titleKey );
} elseif ( strlen( $text ) > $wgMaxMsgCacheEntrySize ) {
# Check for size
$this->mCache[$code][$title] = '!TOO BIG';
$this->mMemc->set( $titleKey, ' ' . $text, $this->mExpiry );
} else {
$this->mCache[$code][$title] = ' ' . $text;
$this->mMemc->delete( $titleKey );
}
# Update caches
$this->saveToCaches( $this->mCache[$code], true, $code );
$this->unlock( $cacheKey );
// Also delete cached sidebar... just in case it is affected
$codes = array( $code );
if ( $code === 'en' ) {
// Delete all sidebars, like for example on action=purge on the
// sidebar messages
$codes = array_keys( Language::getLanguageNames() );
}
global $wgMemc;
foreach ( $codes as $code ) {
$sidebarKey = wfMemcKey( 'sidebar', $code );
$wgMemc->delete( $sidebarKey );
}
// Update the message in the message blob store
global $wgContLang;
MessageBlobStore::updateMessage( $wgContLang->lcfirst( $msg ) );
wfRunHooks( 'MessageCacheReplace', array( $title, $text ) );
wfProfileOut( __METHOD__ );
}
/**
* Shortcut to update caches.
*
* @param $cache Array: cached messages with a version.
* @param $memc Bool: Wether to update or not memcache.
* @param $code String: Language code.
* @return False on somekind of error.
*/
protected function saveToCaches( $cache, $memc = true, $code = false ) {
wfProfileIn( __METHOD__ );
global $wgUseLocalMessageCache, $wgLocalMessageCacheSerialized;
$cacheKey = wfMemcKey( 'messages', $code );
if ( $memc ) {
$success = $this->mMemc->set( $cacheKey, $cache, $this->mExpiry );
} else {
$success = true;
}
# Save to local cache
if ( $wgUseLocalMessageCache ) {
$serialized = serialize( $cache );
$hash = md5( $serialized );
$this->mMemc->set( wfMemcKey( 'messages', $code, 'hash' ), $hash, $this->mExpiry );
if ($wgLocalMessageCacheSerialized) {
$this->saveToLocal( $serialized, $hash, $code );
} else {
$this->saveToScript( $cache, $hash, $code );
}
}
wfProfileOut( __METHOD__ );
return $success;
}
/**
* Represents a write lock on the messages key
*
* @param $key string
*
* @return Boolean: success
*/
function lock( $key ) {
$lockKey = $key . ':lock';
for ( $i = 0; $i < MSG_WAIT_TIMEOUT && !$this->mMemc->add( $lockKey, 1, MSG_LOCK_TIMEOUT ); $i++ ) {
sleep( 1 );
}
return $i >= MSG_WAIT_TIMEOUT;
}
function unlock( $key ) {
$lockKey = $key . ':lock';
$this->mMemc->delete( $lockKey );
}
/**
* Get a message from either the content language or the user language.
*
* @param $key String: the message cache key
* @param $useDB Boolean: get the message from the DB, false to use only
* the localisation
* @param $langcode String: code of the language to get the message for, if
* it is a valid code create a language for that language,
* if it is a string but not a valid code then make a basic
* language object, if it is a false boolean then use the
* current users language (as a fallback for the old
* parameter functionality), or if it is a true boolean
* then use the wikis content language (also as a
* fallback).
* @param $isFullKey Boolean: specifies whether $key is a two part key
* "msg/lang".
*
* @return string|false
*/
function get( $key, $useDB = true, $langcode = true, $isFullKey = false ) {
global $wgLanguageCode, $wgContLang;
if ( is_int( $key ) ) {
// "Non-string key given" exception sometimes happens for numerical strings that become ints somewhere on their way here
$key = strval( $key );
}
if ( !is_string( $key ) ) {
throw new MWException( 'Non-string key given' );
}
if ( strval( $key ) === '' ) {
# Shortcut: the empty key is always missing
return false;
}
$lang = wfGetLangObj( $langcode );
if ( !$lang ) {
throw new MWException( "Bad lang code $langcode given" );
}
$langcode = $lang->getCode();
$message = false;
# Normalise title-case input (with some inlining)
$lckey = str_replace( ' ', '_', $key );
if ( ord( $key ) < 128 ) {
$lckey[0] = strtolower( $lckey[0] );
$uckey = ucfirst( $lckey );
} else {
$lckey = $wgContLang->lcfirst( $lckey );
$uckey = $wgContLang->ucfirst( $lckey );
}
/**
* Record each message request, but only once per request.
* This information is not used unless $wgAdaptiveMessageCache
* is enabled.
*/
$this->mRequestedMessages[$uckey] = true;
# Try the MediaWiki namespace
if( !$this->mDisable && $useDB ) {
$title = $uckey;
if( !$isFullKey && ( $langcode != $wgLanguageCode ) ) {
$title .= '/' . $langcode;
}
$message = $this->getMsgFromNamespace( $title, $langcode );
}
# Try the array in the language object
if ( $message === false ) {
$message = $lang->getMessage( $lckey );
if ( is_null( $message ) ) {
$message = false;
}
}
# Try the array of another language
if( $message === false ) {
$parts = explode( '/', $lckey );
# We may get calls for things that are http-urls from sidebar
# Let's not load nonexistent languages for those
# They usually have more than one slash.
if ( count( $parts ) == 2 && $parts[1] !== '' ) {
$message = Language::getMessageFor( $parts[0], $parts[1] );
if ( is_null( $message ) ) {
$message = false;
}
}
}
# Is this a custom message? Try the default language in the db...
if( ( $message === false || $message === '-' ) &&
!$this->mDisable && $useDB &&
!$isFullKey && ( $langcode != $wgLanguageCode ) ) {
$message = $this->getMsgFromNamespace( $uckey, $wgLanguageCode );
}
# Final fallback
if( $message === false ) {
return false;
}
# Fix whitespace
$message = strtr( $message,
array(
# Fix for trailing whitespace, removed by textarea
' ' => ' ',
# Fix for NBSP, converted to space by firefox
' ' => "\xc2\xa0",
' ' => "\xc2\xa0",
) );
return $message;
}
/**
* Get a message from the MediaWiki namespace, with caching. The key must
* first be converted to two-part lang/msg form if necessary.
*
* @param $title String: Message cache key with initial uppercase letter.
* @param $code String: code denoting the language to try.
*
* @return string|false
*/
function getMsgFromNamespace( $title, $code ) {
global $wgAdaptiveMessageCache;
$this->load( $code );
if ( isset( $this->mCache[$code][$title] ) ) {
$entry = $this->mCache[$code][$title];
if ( substr( $entry, 0, 1 ) === ' ' ) {
return substr( $entry, 1 );
} elseif ( $entry === '!NONEXISTENT' ) {
return false;
} elseif( $entry === '!TOO BIG' ) {
// Fall through and try invididual message cache below
}
} else {
// XXX: This is not cached in process cache, should it?
$message = false;
wfRunHooks( 'MessagesPreLoad', array( $title, &$message ) );
if ( $message !== false ) {
return $message;
}
/**
* If message cache is in normal mode, it is guaranteed
* (except bugs) that there is always entry (or placeholder)
* in the cache if message exists. Thus we can do minor
* performance improvement and return false early.
*/
if ( !$wgAdaptiveMessageCache ) {
return false;
}
}
# Try the individual message cache
$titleKey = wfMemcKey( 'messages', 'individual', $title );
$entry = $this->mMemc->get( $titleKey );
if ( $entry ) {
if ( substr( $entry, 0, 1 ) === ' ' ) {
$this->mCache[$code][$title] = $entry;
return substr( $entry, 1 );
} elseif ( $entry === '!NONEXISTENT' ) {
$this->mCache[$code][$title] = '!NONEXISTENT';
return false;
} else {
# Corrupt/obsolete entry, delete it
$this->mMemc->delete( $titleKey );
}
}
# Try loading it from the database
$revision = Revision::newFromTitle( Title::makeTitle( NS_MEDIAWIKI, $title ) );
if ( $revision ) {
$message = $revision->getText();
if ($message === false) {
// A possibly temporary loading failure.
wfDebugLog( 'MessageCache', __METHOD__ . ": failed to load message page text for {$title->getDbKey()} ($code)" );
} else {
$this->mCache[$code][$title] = ' ' . $message;
$this->mMemc->set( $titleKey, ' ' . $message, $this->mExpiry );
}
} else {
$message = false;
$this->mCache[$code][$title] = '!NONEXISTENT';
$this->mMemc->set( $titleKey, '!NONEXISTENT', $this->mExpiry );
}
return $message;
}
/**
* @param $message string
* @param $interface bool
* @param $language
* @param $title Title
* @return string
*/
function transform( $message, $interface = false, $language = null, $title = null ) {
// Avoid creating parser if nothing to transform
if( strpos( $message, '{{' ) === false ) {
return $message;
}
if ( $this->mInParser ) {
return $message;
}
$parser = $this->getParser();
if ( $parser ) {
$popts = $this->getParserOptions();
$popts->setInterfaceMessage( $interface );
$popts->setTargetLanguage( $language );
$userlang = $popts->setUserLang( $language );
$this->mInParser = true;
$message = $parser->transformMsg( $message, $popts, $title );
$this->mInParser = false;
$popts->setUserLang( $userlang );
}
return $message;
}
/**
* @return Parser
*/
function getParser() {
global $wgParser, $wgParserConf;
if ( !$this->mParser && isset( $wgParser ) ) {
# Do some initialisation so that we don't have to do it twice
$wgParser->firstCallInit();
# Clone it and store it
$class = $wgParserConf['class'];
if ( $class == 'Parser_DiffTest' ) {
# Uncloneable
$this->mParser = new $class( $wgParserConf );
} else {
$this->mParser = clone $wgParser;
}
}
return $this->mParser;
}
/**
* @param $text string
* @param $title Title
* @param $linestart bool
* @param $interface bool
* @param $language
* @return ParserOutput
*/
public function parse( $text, $title = null, $linestart = true, $interface = false, $language = null ) {
if ( $this->mInParser ) {
return htmlspecialchars( $text );
}
$parser = $this->getParser();
$popts = $this->getParserOptions();
$popts->setInterfaceMessage( $interface );
$popts->setTargetLanguage( $language );
wfProfileIn( __METHOD__ );
if ( !$title || !$title instanceof Title ) {
global $wgTitle;
$title = $wgTitle;
}
// Sometimes $wgTitle isn't set either...
if ( !$title ) {
# It's not uncommon having a null $wgTitle in scripts. See r80898
# Create a ghost title in such case
$title = Title::newFromText( 'Dwimmerlaik' );
}
$this->mInParser = true;
$res = $parser->parse( $text, $title, $popts, $linestart );
$this->mInParser = false;
wfProfileOut( __METHOD__ );
return $res;
}
function disable() {
$this->mDisable = true;
}
function enable() {
$this->mDisable = false;
}
/**
* Clear all stored messages. Mainly used after a mass rebuild.
*/
function clear() {
$langs = Language::getLanguageNames( false );
foreach ( array_keys($langs) as $code ) {
# Global cache
$this->mMemc->delete( wfMemcKey( 'messages', $code ) );
# Invalidate all local caches
$this->mMemc->delete( wfMemcKey( 'messages', $code, 'hash' ) );
}
$this->mLoadedLanguages = array();
}
/**
* @param $key
* @return array
*/
public function figureMessage( $key ) {
global $wgLanguageCode;
$pieces = explode( '/', $key );
if( count( $pieces ) < 2 ) {
return array( $key, $wgLanguageCode );
}
$lang = array_pop( $pieces );
$validCodes = Language::getLanguageNames();
if( !array_key_exists( $lang, $validCodes ) ) {
return array( $key, $wgLanguageCode );
}
$message = implode( '/', $pieces );
return array( $message, $lang );
}
public static function logMessages() {
wfProfileIn( __METHOD__ );
global $wgAdaptiveMessageCache;
if ( !$wgAdaptiveMessageCache || !self::$instance instanceof MessageCache ) {
wfProfileOut( __METHOD__ );
return;
}
$cachekey = wfMemckey( 'message-profiling' );
$cache = wfGetCache( CACHE_DB );
$data = $cache->get( $cachekey );
if ( !$data ) {
$data = array();
}
$age = self::$mAdaptiveDataAge;
$filterDate = substr( wfTimestamp( TS_MW, time() - $age ), 0, 8 );
foreach ( array_keys( $data ) as $key ) {
if ( $key < $filterDate ) {
unset( $data[$key] );
}
}
$index = substr( wfTimestampNow(), 0, 8 );
if ( !isset( $data[$index] ) ) {
$data[$index] = array();
}
foreach ( self::$instance->mRequestedMessages as $message => $_ ) {
if ( !isset( $data[$index][$message] ) ) {
$data[$index][$message] = 0;
}
$data[$index][$message]++;
}
$cache->set( $cachekey, $data );
wfProfileOut( __METHOD__ );
}
/**
* @return array
*/
public function getMostUsedMessages() {
wfProfileIn( __METHOD__ );
$cachekey = wfMemcKey( 'message-profiling' );
$cache = wfGetCache( CACHE_DB );
$data = $cache->get( $cachekey );
if ( !$data ) {
wfProfileOut( __METHOD__ );
return array();
}
$list = array();
foreach( $data as $messages ) {
foreach( $messages as $message => $count ) {
$key = $message;
if ( !isset( $list[$key] ) ) {
$list[$key] = 0;
}
$list[$key] += $count;
}
}
$max = max( $list );
foreach ( $list as $message => $count ) {
if ( $count < intval( $max * self::$mAdaptiveInclusionThreshold ) ) {
unset( $list[$message] );
}
}
wfProfileOut( __METHOD__ );
return array_keys( $list );
}
/**
* Get all message keys stored in the message cache for a given language.
* If $code is the content language code, this will return all message keys
* for which MediaWiki:msgkey exists. If $code is another language code, this
* will ONLY return message keys for which MediaWiki:msgkey/$code exists.
* @param $code string
* @return array of message keys (strings)
*/
public function getAllMessageKeys( $code ) {
global $wgContLang;
$this->load( $code );
if ( !isset( $this->mCache[$code] ) ) {
// Apparently load() failed
return null;
}
$cache = $this->mCache[$code]; // Copy the cache
unset( $cache['VERSION'] ); // Remove the VERSION key
$cache = array_diff( $cache, array( '!NONEXISTENT' ) ); // Remove any !NONEXISTENT keys
// Keys may appear with a capital first letter. lcfirst them.
return array_map( array( $wgContLang, 'lcfirst' ), array_keys( $cache ) );
}
}
|