Merge pull request #9980 from mickadoo/CRM-20254-cache-busting-custom…

…-css CRM-20254: add cache buster string for custom CSS
civicrm · Mar 16, 2017 · d90703e · d90703e
2 parents 43e3832 + 33603e1
commit d90703e
Show file tree

Hide file tree

Showing 2 changed files with 51 additions and 2 deletions.
diff --git a/CRM/Core/Resources.php b/CRM/Core/Resources.php
@@ -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)
@@ -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);
@@ -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;
+  }
+
 }
diff --git a/tests/phpunit/CRM/Core/ResourcesTest.php b/tests/phpunit/CRM/Core/ResourcesTest.php
@@ -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;
 
@@ -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,
+      ),
+    );
+  }
+
 }