CRM/Utils/JS.php

   1 <?php
   2 /*
   3 +--------------------------------------------------------------------+
   4 | CiviCRM version 5                                                  |
   5 +--------------------------------------------------------------------+
   6 | Copyright CiviCRM LLC (c) 2004-2019                                |
   7 +--------------------------------------------------------------------+
   8 | This file is a part of CiviCRM.                                    |
   9 |                                                                    |
  10 | CiviCRM is free software; you can copy, modify, and distribute it  |
  11 | under the terms of the GNU Affero General Public License           |
  12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13 |                                                                    |
  14 | CiviCRM is distributed in the hope that it will be useful, but     |
  15 | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17 | See the GNU Affero General Public License for more details.        |
  18 |                                                                    |
  19 | You should have received a copy of the GNU Affero General Public   |
  20 | License and the CiviCRM Licensing Exception along                  |
  21 | with this program; if not, contact CiviCRM LLC                     |
  22 | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23 | GNU Affero General Public License or the licensing of CiviCRM,     |
  24 | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25 +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  * Parse Javascript content and extract translatable strings.
  30  *
  31  * @package CRM
  32  * @copyright CiviCRM LLC (c) 2004-2019
  33  */
  34 class CRM_Utils_JS {
  35
  36   /**
  37    * Parse a javascript file for translatable strings.
  38    *
  39    * @param string $jsCode
  40    *   Raw Javascript code.
  41    * @return array
  42    *   Array of translatable strings
  43    */
  44   public static function parseStrings($jsCode) {
  45     $strings = [];
  46     // Match all calls to ts() in an array.
  47     // Note: \s also matches newlines with the 's' modifier.
  48     preg_match_all('~
  49       [^\w]ts\s*                                    # match "ts" with whitespace
  50       \(\s*                                         # match "(" argument list start
  51       ((?:(?:\'(?:\\\\\'|[^\'])*\'|"(?:\\\\"|[^"])*")(?:\s*\+\s*)?)+)\s*
  52       [,\)]                                         # match ")" or "," to finish
  53       ~sx', $jsCode, $matches);
  54     foreach ($matches[1] as $text) {
  55       $quote = $text[0];
  56       // Remove newlines
  57       $text = str_replace("\\\n", '', $text);
  58       // Unescape escaped quotes
  59       $text = str_replace('\\' . $quote, $quote, $text);
  60       // Remove end quotes
  61       $text = substr(ltrim($text, $quote), 0, -1);
  62       $strings[$text] = $text;
  63     }
  64     return array_values($strings);
  65   }
  66
  67   /**
  68    * Identify duplicate, adjacent, identical closures and consolidate them.
  69    *
  70    * Note that you can only dedupe closures if they are directly adjacent and
  71    * have exactly the same parameters.
  72    *
  73    * @param array $scripts
  74    *   Javascript source.
  75    * @param array $localVars
  76    *   Ordered list of JS vars to identify the start of a closure.
  77    * @param array $inputVals
  78    *   Ordered list of input values passed into the closure.
  79    * @return string
  80    *   Javascript source.
  81    */
  82   public static function dedupeClosures($scripts, $localVars, $inputVals) {
  83     // Example opening: (function (angular, $, _) {
  84     $opening = '\s*\(\s*function\s*\(\s*';
  85     $opening .= implode(',\s*', array_map(function ($v) {
  86       return preg_quote($v, '/');
  87     }, $localVars));
  88     $opening .= '\)\s*\{';
  89     $opening = '/^' . $opening . '/';
  90
  91     // Example closing: })(angular, CRM.$, CRM._);
  92     $closing = '\}\s*\)\s*\(\s*';
  93     $closing .= implode(',\s*', array_map(function ($v) {
  94       return preg_quote($v, '/');
  95     }, $inputVals));
  96     $closing .= '\);\s*';
  97     $closing = "/$closing\$/";
  98
  99     $scripts = array_values($scripts);
 100     for ($i = count($scripts) - 1; $i > 0; $i--) {
 101       if (preg_match($closing, $scripts[$i - 1]) && preg_match($opening, $scripts[$i])) {
 102         $scripts[$i - 1] = preg_replace($closing, '', $scripts[$i - 1]);
 103         $scripts[$i] = preg_replace($opening, '', $scripts[$i]);
 104       }
 105     }
 106
 107     return $scripts;
 108   }
 109
 110   /**
 111    * This is a primitive comment stripper. It doesn't catch all comments
 112    * and falls short of minification, but it doesn't munge Angular injections
 113    * and is fast enough to run synchronously (without caching).
 114    *
 115    * At time of writing, running this against the Angular modules, this impl
 116    * of stripComments currently adds 10-20ms and cuts ~7%.
 117    *
 118    * Please be extremely cautious about extending this. If you want better
 119    * minification, you should probably remove this implementation,
 120    * import a proper JSMin implementation, and cache its output.
 121    *
 122    * @param string $script
 123    * @return string
 124    */
 125   public static function stripComments($script) {
 126     return preg_replace(":^\\s*//[^\n]+$:m", "", $script);
 127   }
 128
 129   /**
 130    * Decodes a js object (not necessarily strict json but valid js) into an array or primitive type
 131    *
 132    * ex. {a: 'Apple', 'b': "Banana", c: [1, 2, 3]}
 133    *
 134    * @param string $js
 135    * @return mixed
 136    */
 137   public static function decode($js) {
 138     if (!class_exists('Services_JSON')) {
 139       require_once 'packages/OpenFlashChart/php-ofc-library/JSON.php';
 140     }
 141     $codec = new Services_JSON();
 142     $result = $codec->decode($js);
 143     // Converts stdClass to array
 144     return json_decode(json_encode($result), TRUE);
 145   }
 146
 147   /**
 148    * Gets the properties of a javascript object WITHOUT decoding them.
 149    *
 150    * Useful when the object might contain js functions, expressions, etc. which cannot be decoded.
 151    * Returns an array with keys as property names and values as raw strings of js.
 152    *
 153    * Ex: {foo: getFoo(arg), bar: function() {return "bar"}}
 154    * Returns [
 155    *   'foo' => 'getFoo(arg)',
 156    *   'bar' => 'function() {return "bar"}',
 157    * ]
 158    *
 159    * @param $js
 160    * @return array
 161    * @throws \Exception
 162    */
 163   public static function getObjectProps($js) {
 164     $js = trim($js);
 165     if (!is_string($js) || !($js[0] === '{')) {
 166       throw new Exception("Invalid js object string passed to CRM_Utils_JS::getObjectProps");
 167     }
 168     $chars = str_split(substr($js, 1));
 169     $prev = NULL;
 170     $key = NULL;
 171     $quote = NULL;
 172     $item = '';
 173     $length = strlen($js) - 2;
 174     $quotes = ['"', "'"];
 175     $enclosures = [
 176       '{' => 0,
 177       '(' => 0,
 178       '[' => 0,
 179     ];
 180     $closers = [
 181       '}' => '{',
 182       ')' => '(',
 183       ']' => '[',
 184     ];
 185     $result = [];
 186     foreach ($chars as $index => $char) {
 187       // Open quotes - we'll ignore everything inside
 188       if (in_array($char, $quotes) && $prev != '\\' && !$quote) {
 189         $quote = $char;
 190       }
 191       // Close quotes
 192       elseif (in_array($char, $quotes) && $prev != '\\' && $char === $quote) {
 193         $quote = NULL;
 194       }
 195       if (!$quote) {
 196         // Skip opening whitespace between properties
 197         if ($char === ' ' && !strlen($item)) {
 198           $prev = $char;
 199           continue;
 200         }
 201         // Delineates property key
 202         if ($char == ':' && !array_filter($enclosures)) {
 203           $key = $item;
 204           $item = '';
 205           $prev = $char;
 206           continue;
 207         }
 208         // Delineates property value
 209         if (($char == ',' || ($char == '}' && $index == $length)) && !array_filter($enclosures) && isset($key)) {
 210           $result[trim(trim($key), '"\'')] = $item;
 211           $item = '';
 212           $prev = $char;
 213           continue;
 214         }
 215         // Open brackets - we'll ignore delineators inside
 216         if (isset($enclosures[$char])) {
 217           $enclosures[$char]++;
 218         }
 219         // Close brackets
 220         if (isset($closers[$char]) && $enclosures[$closers[$char]]) {
 221           $enclosures[$closers[$char]]--;
 222         }
 223       }
 224       $item .= $char;
 225       $prev = $char;
 226     }
 227     return $result;
 228   }
 229
 230 }