Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

(dev/core#316) Fix crash on Memcache systems when session key involves whitespace #12653

Merged
merged 8 commits into from
Aug 14, 2018
Merged

(dev/core#316) Fix crash on Memcache systems when session key involves whitespace #12653

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
ca5b7e5
Issue #316: Exclude spaces from cache keys for Memcache compatibility
xurizaemon Aug 9, 2018
45be097
Avoid calling Cache::cleanKey() twice in quick succession
xurizaemon Aug 9, 2018
7740172
Issue #316: Update tests for whitespace escaping
xurizaemon Aug 10, 2018
063fb28
Issue #316: Expand cache key test coverage with emoji
xurizaemon Aug 10, 2018
aba30e1
Issue #316: Ensure Container caches have safe prefixes
xurizaemon Aug 10, 2018
7094ba9
Issue #316: Update long string cache key test results
xurizaemon Aug 10, 2018
821c700
(NFC) CRM_Utils_Cache::create - Update docblock for 'name' param
totten Aug 10, 2018
1c73869
dev/core#316 - Update long string cache key test results
totten Aug 10, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions CRM/Core/BAO/Cache.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,15 +73,16 @@ public static function &getItem($group, $path, $componentID = NULL) {
$argString = "CRM_CT_{$group}_{$path}_{$componentID}";
if (!array_key_exists($argString, self::$_cache)) {
$cache = CRM_Utils_Cache::singleton();
self::$_cache[$argString] = $cache->get(self::cleanKey($argString));
$cleanKey = self::cleanKey($argString);
self::$_cache[$argString] = $cache->get($cleanKey);
if (!self::$_cache[$argString]) {
$table = self::getTableName();
$where = self::whereCache($group, $path, $componentID);
$rawData = CRM_Core_DAO::singleValueQuery("SELECT data FROM $table WHERE $where");
$data = $rawData ? self::decode($rawData) : NULL;

self::$_cache[$argString] = $data;
$cache->set(self::cleanKey($argString), self::$_cache[$argString]);
$cache->set($cleanKey, self::$_cache[$argString]);
}
}
return self::$_cache[$argString];
Expand All @@ -106,7 +107,8 @@ public static function &getItems($group, $componentID = NULL) {
$argString = "CRM_CT_CI_{$group}_{$componentID}";
if (!array_key_exists($argString, self::$_cache)) {
$cache = CRM_Utils_Cache::singleton();
self::$_cache[$argString] = $cache->get(self::cleanKey($argString));
$cleanKey = self::cleanKey($argString);
self::$_cache[$argString] = $cache->get($cleanKey);
if (!self::$_cache[$argString]) {
$table = self::getTableName();
$where = self::whereCache($group, NULL, $componentID);
Expand All @@ -119,7 +121,7 @@ public static function &getItems($group, $componentID = NULL) {
$dao->free();

self::$_cache[$argString] = $result;
$cache->set(self::cleanKey($argString), self::$_cache[$argString]);
$cache->set($cleanKey, self::$_cache[$argString]);
}
}

Expand Down Expand Up @@ -448,7 +450,7 @@ public static function cleanKey($key) {
return $escape . md5($key);
}

$r = preg_replace_callback(';[^A-Za-z0-9_\. ];', function($m) use ($escape) {
$r = preg_replace_callback(';[^A-Za-z0-9_\.];', function($m) use ($escape) {
return $escape . dechex(ord($m[0]));
}, $key);

Expand Down
7 changes: 7 additions & 0 deletions CRM/Utils/Cache.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,9 @@ public static function getCacheSettings($cachePlugin) {
* @param array $params
* Array with keys:
* - name: string, unique symbolic name.
* For a naming convention, use `snake_case` or `CamelCase` to maximize
* portability/cleanliness. Any other punctuation or whitespace
* should function correctly, but it can be harder to inspect/debug.
* - type: array|string, list of acceptable cache types, in order of preference.
* - prefetch: bool, whether to prefetch all data in cache (if possible).
* @return CRM_Utils_Cache_Interface
Expand All @@ -184,6 +187,10 @@ public static function getCacheSettings($cachePlugin) {
public static function create($params = array()) {
$types = (array) $params['type'];

if (!empty($params['name'])) {
$params['name'] = CRM_Core_BAO_Cache::cleanKey($params['name']);
}

foreach ($types as $type) {
switch ($type) {
case '*memory*':
Expand Down
11 changes: 7 additions & 4 deletions tests/phpunit/CRM/Core/BAO/CacheTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,11 +84,14 @@ public function testSetGetItem($originalValue) {

public function getCleanKeyExamples() {
$es = [];
$es[] = ['hello_world and other.planets', 'hello_world and other.planets']; // allowed chars
$es[] = ['hello_world and/other.planets', 'hello_world-20and-2fother.planets']; // allowed chars
$es[] = ['hello/world+-#@{}', 'hello-2fworld-2b-2d-23-40-7b-7d']; // escaped chars
$es[] = ['123456789 123456789 123456789 123456789 123456789 123456789 123', '123456789 123456789 123456789 123456789 123456789 123456789 123']; // long but allowed
$es[] = ['123456789 123456789 123456789 123456789 123456789 123456789 1234', '-2a008e182a4dcd1a78f405f30119e5f2']; // too long, md5 fallback
$es[] = ['123456789 /23456789 +23456789 -23456789 123456789 123456789', '-1b6baab5961431ed443ab321f5dfa0fb']; // too long, md5 fallback
$es[] = ["LF-\nTAB-\tCR-\remojiskull💀", 'LF-2d-aTAB-2d-9CR-2d-demojiskull-f0-9f-92-80']; // short with emoji
$es[] = ["LF-\nTAB-\tCR-\remojibomb💣emojiskull💀", '-5d9324e052f6e10240dce5029c5e8525']; // long with emoji
$es[] = ['123456789 123456789 123456789 123456789 123456789 123', '123456789-20123456789-20123456789-20123456789-20123456789-20123']; // spaces are escaped
$es[] = ['123456789_123456789_123456789_123456789_123456789_123456789_123', '123456789_123456789_123456789_123456789_123456789_123456789_123']; // long but allowed
$es[] = ['123456789_123456789_123456789_123456789_123456789_123456789_1234', '-e02b981aff954fdcc9a81c25f5ec9681']; // too long, md5 fallback
$es[] = ['123456789-/23456789-+23456789--23456789_123456789_123456789', '-43b6dec1026187ae6f6a8fe4d56ab22e']; // too long, md5 fallback
return $es;
}

Expand Down