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

CRM-20254: add cache buster string for custom CSS #9980

Merged
merged 4 commits into from
Mar 16, 2017
Merged

CRM-20254: add cache buster string for custom CSS #9980

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6f12c6e
CRM-20254: add cache buster string for custom CSS and improve query s…
mickadoo Mar 14, 2017
595caa4
CRM-20254: set cache buster code for tests
mickadoo Mar 14, 2017
03449a5
CRM-20254: simplify adding cache code logic. remove useless test case
mickadoo Mar 15, 2017
33603e1
CRM-20254: code style changes
mickadoo Mar 15, 2017
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
16 changes: 14 additions & 2 deletions CRM/Core/Resources.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -500,7 +500,7 @@ public function getUrl($ext, $file = NULL, $addCacheCode = FALSE) {
$file = '';
}
if ($addCacheCode) {
$file .= '?r=' . $this->getCacheCode();
$file = $this->addCacheCode($file);
}
// TODO consider caching results
$base = $this->paths->hasVariable($ext)
Expand Down Expand Up @@ -643,7 +643,8 @@ public function addCoreStyles($region = 'html-header') {
// Load custom or core css
$config = CRM_Core_Config::singleton();
if (!empty($config->customCSSURL)) {
$this->addStyleUrl($config->customCSSURL, 99, $region);
$customCSSURL = $this->addCacheCode($config->customCSSURL);
$this->addStyleUrl($customCSSURL, 99, $region);
}
if (!Civi::settings()->get('disable_core_css')) {
$this->addStyleFile('civicrm', 'css/civicrm.css', -99, $region);
Expand Down Expand Up @@ -881,4 +882,15 @@ private function resolveFileName(&$fileName, $extName) {
}
}

/**
* @param string $url
* @return string
*/
public function addCacheCode($url) {
$hasQuery = strpos($url, '?') !== FALSE;
$operator = $hasQuery ? '&' : '?';

return $url . $operator . 'r=' . $this->cacheCode;
}

}
37 changes: 37 additions & 0 deletions tests/phpunit/CRM/Core/ResourcesTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,11 @@ class CRM_Core_ResourcesTest extends CiviUnitTestCase {
*/
protected $mapper;

/**
* @var string for testing cache buster generation
*/
protected $cacheBusterString = 'xBkdk3';

protected $originalRequest;
protected $originalGet;

Expand Down Expand Up @@ -348,4 +353,36 @@ public function _createMapper(CRM_Utils_Cache_Interface $cache = NULL, $cacheKey
return array($basedir, $c, $mapper);
}

/**
* @param string $url
* @param string $expected
*
* @dataProvider urlForCacheCodeProvider
*/
public function testAddingCacheCode($url, $expected) {
$resources = CRM_Core_Resources::singleton();
$resources->setCacheCode($this->cacheBusterString);
$this->assertEquals($expected, $resources->addCacheCode($url));
}

/**
* @return array
*/
public function urlForCacheCodeProvider() {
return array(
array(
'http://www.civicrm.org',
'http://www.civicrm.org?r=' . $this->cacheBusterString,
),
array(
'www.civicrm.org/custom.css?foo=bar',
'www.civicrm.org/custom.css?foo=bar&r=' . $this->cacheBusterString,
),
array(
'civicrm.org/custom.css?car=blue&foo=bar',
'civicrm.org/custom.css?car=blue&foo=bar&r=' . $this->cacheBusterString,
),
);
}

}