Merge pull request #6385 from eileenmcnaughton/cleanup

[civicrm-core.git] / CRM / Utils / JS.php

diff --git a/CRM/Utils/JS.php b/CRM/Utils/JS.php
index f631a2b09abed46b3377d53426f25c8926b378e9..63d6d85d7989603f1bd1b3eff139b80b1e091650 100644 (file)
--- a/CRM/Utils/JS.php
+++ b/CRM/Utils/JS.php
@@ -1,10 +1,9 @@
 <?php
-
 /*
 +--------------------------------------------------------------------+
 | CiviCRM version 4.6                                                |
 +--------------------------------------------------------------------+
-| Copyright CiviCRM LLC (c) 2004-2014                                |
+| Copyright CiviCRM LLC (c) 2004-2015                                |
 +--------------------------------------------------------------------+
 | This file is a part of CiviCRM.                                    |
 |                                                                    |
@@ -24,22 +23,24 @@
 | GNU Affero General Public License or the licensing of CiviCRM,     |
 | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
 +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  * Parse Javascript content and extract translatable strings.
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2014
+ * @copyright CiviCRM LLC (c) 2004-2015
  * $Id$
  *
  */
 class CRM_Utils_JS {
   /**
-   * Parse a javascript file for translatable strings
+   * Parse a javascript file for translatable strings.
    *
-   * @param string $jsCode raw Javascript code
-   * @return array of translatable strings
+   * @param string $jsCode
+   *   Raw Javascript code.
+   * @return array
+   *   Array of translatable strings
    */
   public static function parseStrings($jsCode) {
     $strings = array();
@@ -63,4 +64,67 @@ class CRM_Utils_JS {
     }
     return array_values($strings);
   }
+
+  /**
+   * Identify duplicate, adjacent, identical closures and consolidate them.
+   *
+   * Note that you can only dedupe closures if they are directly adjacent and
+   * have exactly the same parameters.
+   *
+   * @param array $scripts
+   *   Javascript source.
+   * @param array $localVars
+   *   Ordered list of JS vars to identify the start of a closure.
+   * @param array $inputVals
+   *   Ordered list of input values passed into the closure.
+   * @return string
+   *   Javascript source.
+   */
+  public static function dedupeClosures($scripts, $localVars, $inputVals) {
+    // Example opening: (function (angular, $, _) {
+    $opening = '\s*\(\s*function\s*\(\s*';
+    $opening .= implode(',\s*', array_map(function ($v) {
+      return preg_quote($v, '/');
+    }, $localVars));
+    $opening .= '\)\s*\{';
+    $opening = '/^' . $opening . '/';
+
+    // Example closing: })(angular, CRM.$, CRM._);
+    $closing = '\}\s*\)\s*\(\s*';
+    $closing .= implode(',\s*', array_map(function ($v) {
+      return preg_quote($v, '/');
+    }, $inputVals));
+    $closing .= '\);\s*';
+    $closing = "/$closing\$/";
+
+    $scripts = array_values($scripts);
+    for ($i = count($scripts) - 1; $i > 0; $i--) {
+      if (preg_match($closing, $scripts[$i - 1]) && preg_match($opening, $scripts[$i])) {
+        $scripts[$i - 1] = preg_replace($closing, '', $scripts[$i - 1]);
+        $scripts[$i] = preg_replace($opening, '', $scripts[$i]);
+      }
+    }
+
+    return $scripts;
+  }
+
+  /**
+   * This is a primitive comment stripper. It doesn't catch all comments
+   * and falls short of minification, but it doesn't munge Angular injections
+   * and is fast enough to run synchronously (without caching).
+   *
+   * At time of writing, running this against the Angular modules, this impl
+   * of stripComments currently adds 10-20ms and cuts ~7%.
+   *
+   * Please be extremely cautious about extending this. If you want better
+   * minification, you should probably remove this implementation,
+   * import a proper JSMin implementation, and cache its output.
+   *
+   * @param string $script
+   * @return string
+   */
+  public static function stripComments($script) {
+    return preg_replace(":^\\s*//[^\n]+$:m", "", $script);
+  }
+
 }