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 variable (not necessarily strict json but valid js) into a php variable.
 131    *
 132    * This is similar to using json_decode($js, TRUE) but more forgiving about syntax.
 133    *
 134    * ex. {a: 'Apple', 'b': "Banana", c: [1, 2, 3]}
 135    * Returns: [
 136    *   'a' => 'Apple',
 137    *   'b' => 'Banana',
 138    *   'c' => [1, 2, 3],
 139    * ]
 140    *
 141    * @param string $js
 142    * @return mixed
 143    */
 144   public static function decode($js) {
 145     $js = trim($js);
 146     if ($js[0] === "'" || $js[0] === '"') {
 147       // Use a temp placeholder for escaped backslashes
 148       return str_replace(['\\\\', "\\'", '\\"', '\\&', '\\/', '**backslash**'], ['**backslash**', "'", '"', '&', '/', '\\'], substr($js, 1, -1));
 149     }
 150     if ($js[0] === '{' || $js[0] === '[') {
 151       $obj = self::getRawProps($js);
 152       foreach ($obj as $idx => $item) {
 153         $obj[$idx] = self::decode($item);
 154       }
 155       return $obj;
 156     }
 157     return json_decode($js);
 158   }
 159
 160   /**
 161    * Gets the properties of a javascript object/array WITHOUT decoding them.
 162    *
 163    * Useful when the object might contain js functions, expressions, etc. which cannot be decoded.
 164    * Returns an array with keys as property names and values as raw strings of js.
 165    *
 166    * Ex Input: {foo: getFoo(arg), 'bar': function() {return "bar";}}
 167    * Returns: [
 168    *   'foo' => 'getFoo(arg)',
 169    *   'bar' => 'function() {return "bar";}',
 170    * ]
 171    *
 172    * @param $js
 173    * @return array
 174    * @throws \Exception
 175    */
 176   public static function getRawProps($js) {
 177     $js = trim($js);
 178     if (!is_string($js) || $js === '' || !($js[0] === '{' || $js[0] === '[')) {
 179       throw new Exception("Invalid js object string passed to CRM_Utils_JS::getRawProps");
 180     }
 181     $chars = str_split(substr($js, 1));
 182     $isEscaped = $quote = NULL;
 183     $type = $js[0] === '{' ? 'object' : 'array';
 184     $key = $type == 'array' ? 0 : NULL;
 185     $item = '';
 186     $end = strlen($js) - 2;
 187     $quotes = ['"', "'", '/'];
 188     $brackets = [
 189       '}' => '{',
 190       ')' => '(',
 191       ']' => '[',
 192       ':' => '?',
 193     ];
 194     $enclosures = array_fill_keys($brackets, 0);
 195     $result = [];
 196     foreach ($chars as $index => $char) {
 197       if (!$isEscaped && in_array($char, $quotes, TRUE)) {
 198         // Open quotes, taking care not to mistake the division symbol for opening a regex
 199         if (!$quote && !($char == '/' && preg_match('{[\w)]\s*$}', $item))) {
 200           $quote = $char;
 201         }
 202         // Close quotes
 203         elseif ($char === $quote) {
 204           $quote = NULL;
 205         }
 206       }
 207       if (!$quote) {
 208         // Delineates property key
 209         if ($char == ':' && !array_filter($enclosures) && !$key) {
 210           $key = $item;
 211           $item = '';
 212           continue;
 213         }
 214         // Delineates property value
 215         if (($char == ',' || $index == $end) && !array_filter($enclosures) && isset($key) && trim($item) !== '') {
 216           // Trim, unquote, and unescape characters in key
 217           if ($type == 'object') {
 218             $key = trim($key);
 219             $key = in_array($key[0], $quotes) ? self::decode($key) : $key;
 220           }
 221           $result[$key] = trim($item);
 222           $key = $type == 'array' ? $key + 1 : NULL;
 223           $item = '';
 224           continue;
 225         }
 226         // Open brackets - we'll ignore delineators inside
 227         if (isset($enclosures[$char])) {
 228           $enclosures[$char]++;
 229         }
 230         // Close brackets
 231         if (isset($brackets[$char]) && $enclosures[$brackets[$char]]) {
 232           $enclosures[$brackets[$char]]--;
 233         }
 234       }
 235       $item .= $char;
 236       // We are escaping the next char if this is a backslash not preceded by an odd number of backslashes
 237       $isEscaped = $char === '\\' && ((strlen($item) - strlen(rtrim($item, '\\'))) % 2);
 238     }
 239     return $result;
 240   }
 241
 242   /**
 243    * Converts a php array to javascript object/array notation (not strict JSON).
 244    *
 245    * Does not encode keys unless they contain special characters.
 246    * Does not encode values by default, so either specify $encodeValues = TRUE,
 247    * or pass strings of valid js/json as values (per output from getRawProps).
 248    * @see CRM_Utils_JS::getRawProps
 249    *
 250    * @param array $obj
 251    * @param bool $encodeValues
 252    * @return string
 253    */
 254   public static function writeObject($obj, $encodeValues = FALSE) {
 255     $js = [];
 256     $brackets = isset($obj[0]) && array_keys($obj) === range(0, count($obj) - 1) ? ['[', ']'] : ['{', '}'];
 257     foreach ($obj as $key => $val) {
 258       if ($encodeValues) {
 259         $val = json_encode($val, JSON_UNESCAPED_SLASHES);
 260       }
 261       if ($brackets[0] == '{') {
 262         // Enclose the key in quotes unless it is purely alphanumeric
 263         if (preg_match('/\W/', $key)) {
 264           // Prefer single quotes
 265           $key = preg_match('/^[\w "]+$/', $key) ? "'" . $key . "'" : json_encode($key, JSON_UNESCAPED_SLASHES);
 266         }
 267         $js[] = "$key: $val";
 268       }
 269       else {
 270         $js[] = $val;
 271       }
 272     }
 273     return $brackets[0] . implode(', ', $js) . $brackets[1];
 274   }
 275
 276 }