CRM/Utils/JS.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  * Parse Javascript content and extract translatable strings.
  14  *
  15  * @package CRM
  16  * @copyright CiviCRM LLC https://civicrm.org/licensing
  17  */
  18 class CRM_Utils_JS {
  19
  20   /**
  21    * Parse a javascript file for translatable strings.
  22    *
  23    * @param string $jsCode
  24    *   Raw Javascript code.
  25    * @return array
  26    *   Array of translatable strings
  27    */
  28   public static function parseStrings($jsCode) {
  29     $strings = [];
  30     // Match all calls to ts() in an array.
  31     // Note: \s also matches newlines with the 's' modifier.
  32     preg_match_all('~
  33       [^\w]ts\s*                                    # match "ts" with whitespace
  34       \(\s*                                         # match "(" argument list start
  35       ((?:(?:\'(?:\\\\\'|[^\'])*\'|"(?:\\\\"|[^"])*")(?:\s*\+\s*)?)+)\s*
  36       [,\)]                                         # match ")" or "," to finish
  37       ~sx', $jsCode, $matches);
  38     foreach ($matches[1] as $text) {
  39       $quote = $text[0];
  40       // Remove newlines
  41       $text = str_replace("\\\n", '', $text);
  42       // Unescape escaped quotes
  43       $text = str_replace('\\' . $quote, $quote, $text);
  44       // Remove end quotes
  45       $text = substr(ltrim($text, $quote), 0, -1);
  46       $strings[$text] = $text;
  47     }
  48     return array_values($strings);
  49   }
  50
  51   /**
  52    * Identify duplicate, adjacent, identical closures and consolidate them.
  53    *
  54    * Note that you can only dedupe closures if they are directly adjacent and
  55    * have exactly the same parameters.
  56    *
  57    * Also dedupes the "use strict" directive as it is only meaningful at the beginning of a closure.
  58    *
  59    * @param array $scripts
  60    *   Javascript source.
  61    * @param array $localVars
  62    *   Ordered list of JS vars to identify the start of a closure.
  63    * @param array $inputVals
  64    *   Ordered list of input values passed into the closure.
  65    * @return string[]
  66    *   Javascript source.
  67    */
  68   public static function dedupeClosures($scripts, $localVars, $inputVals) {
  69     // Example opening: (function (angular, $, _) {
  70     $opening = '\s*\(\s*function\s*\(\s*';
  71     $opening .= implode(',\s*', array_map(function ($v) {
  72       return preg_quote($v, '/');
  73     }, $localVars));
  74     $opening .= '\)\s*\{';
  75     $opening = '/^' . $opening . '\s*(?:"use strict";\s|\'use strict\';\s)?/';
  76
  77     // Example closing: })(angular, CRM.$, CRM._);
  78     $closing = '\}\s*\)\s*\(\s*';
  79     $closing .= implode(',\s*', array_map(function ($v) {
  80       return preg_quote($v, '/');
  81     }, $inputVals));
  82     $closing .= '\);\s*';
  83     $closing = "/$closing\$/";
  84
  85     $scripts = array_values($scripts);
  86     for ($i = count($scripts) - 1; $i > 0; $i--) {
  87       if (preg_match($closing, $scripts[$i - 1]) && preg_match($opening, $scripts[$i])) {
  88         $scripts[$i - 1] = preg_replace($closing, '', $scripts[$i - 1]);
  89         $scripts[$i] = preg_replace($opening, '', $scripts[$i]);
  90       }
  91     }
  92
  93     return $scripts;
  94   }
  95
  96   /**
  97    * This is a primitive comment stripper. It doesn't catch all comments
  98    * and falls short of minification, but it doesn't munge Angular injections
  99    * and is fast enough to run synchronously (without caching).
 100    *
 101    * At time of writing, running this against the Angular modules, this impl
 102    * of stripComments currently adds 10-20ms and cuts ~7%.
 103    *
 104    * Please be extremely cautious about extending this. If you want better
 105    * minification, you should probably remove this implementation,
 106    * import a proper JSMin implementation, and cache its output.
 107    *
 108    * @param string $script
 109    * @return string
 110    */
 111   public static function stripComments($script) {
 112     return preg_replace("#^\\s*//[^\n]*$(?:\r\n|\n)?#m", "", $script);
 113   }
 114
 115   /**
 116    * Decodes a js variable (not necessarily strict json but valid js) into a php variable.
 117    *
 118    * This is similar to using json_decode($js, TRUE) but more forgiving about syntax.
 119    *
 120    * ex. {a: 'Apple', 'b': "Banana", c: [1, 2, 3]}
 121    * Returns: [
 122    *   'a' => 'Apple',
 123    *   'b' => 'Banana',
 124    *   'c' => [1, 2, 3],
 125    * ]
 126    *
 127    * @param string $js
 128    * @param bool $throwException
 129    * @return mixed
 130    * @throws CRM_Core_Exception
 131    */
 132   public static function decode($js, $throwException = FALSE) {
 133     $js = trim($js);
 134     $first = substr($js, 0, 1);
 135     $last = substr($js, -1);
 136     if ($first === "'" && $last === "'") {
 137       $js = self::convertSingleQuoteString($js, $throwException);
 138     }
 139     elseif (($first === '{' && $last === '}') || ($first === '[' && $last === ']')) {
 140       $obj = self::getRawProps($js);
 141       foreach ($obj as $idx => $item) {
 142         $obj[$idx] = self::decode($item, $throwException);
 143       }
 144       return $obj;
 145     }
 146     $result = json_decode($js);
 147     if ($throwException && $result === NULL && $js !== 'null') {
 148       throw new CRM_Core_Exception(json_last_error_msg());
 149     }
 150     return $result;
 151   }
 152
 153   /**
 154    * @param string $str
 155    * @param bool $throwException
 156    * @return string|null
 157    * @throws CRM_Core_Exception
 158    */
 159   public static function convertSingleQuoteString(string $str, $throwException) {
 160     // json_decode can only handle double quotes around strings, so convert single-quoted strings
 161     $backslash = chr(0) . 'backslash' . chr(0);
 162     $str = str_replace(['\\\\', '\\"', '"', '\\&', '\\/', $backslash], [$backslash, '"', '\\"', '&', '/', '\\'], substr($str, 1, -1));
 163     // Ensure the string doesn't terminate early by checking that all single quotes are escaped
 164     $pos = -1;
 165     while (($pos = strpos($str, "'", $pos + 1)) !== FALSE) {
 166       if (($pos - strlen(rtrim(substr($str, 0, $pos)))) % 2) {
 167         if ($throwException) {
 168           throw new CRM_Core_Exception('Invalid string passed to CRM_Utils_JS::decode');
 169         }
 170         return NULL;
 171       }
 172     }
 173     return '"' . $str . '"';
 174   }
 175
 176   /**
 177    * Encodes a variable to js notation (not strict json) suitable for e.g. an angular attribute.
 178    *
 179    * Like json_encode() but the output looks more like native javascript,
 180    * with single quotes around strings and no unnecessary quotes around object keys.
 181    *
 182    * Ex input: [
 183    *   'a' => 'Apple',
 184    *   'b' => 'Banana',
 185    *   'c' => [1, 2, 3],
 186    * ]
 187    * Ex output: {a: 'Apple', b: 'Banana', c: [1, 2, 3]}
 188    *
 189    * @param mixed $value
 190    * @return string
 191    */
 192   public static function encode($value) {
 193     if (is_array($value)) {
 194       return self::writeObject($value, TRUE);
 195     }
 196     $result = json_encode($value, JSON_UNESCAPED_SLASHES);
 197     // Convert double-quotes around string to single quotes
 198     if (is_string($value) && substr($result, 0, 1) === '"' && substr($result, -1) === '"') {
 199       $backslash = chr(0) . 'backslash' . chr(0);
 200       return "'" . str_replace(['\\\\', '\\"', "'", $backslash], [$backslash, '"', "\\'", '\\\\'], substr($result, 1, -1)) . "'";
 201     }
 202     return $result;
 203   }
 204
 205   /**
 206    * Gets the properties of a javascript object/array WITHOUT decoding them.
 207    *
 208    * Useful when the object might contain js functions, expressions, etc. which cannot be decoded.
 209    * Returns an array with keys as property names and values as raw strings of js.
 210    *
 211    * Ex Input: {foo: getFoo(arg), 'bar': function() {return "bar";}}
 212    * Returns: [
 213    *   'foo' => 'getFoo(arg)',
 214    *   'bar' => 'function() {return "bar";}',
 215    * ]
 216    *
 217    * @param $js
 218    * @return array
 219    * @throws Exception
 220    */
 221   public static function getRawProps($js) {
 222     $js = trim($js);
 223     if (!is_string($js) || $js === '' || !($js[0] === '{' || $js[0] === '[')) {
 224       throw new Exception("Invalid js object string passed to CRM_Utils_JS::getRawProps");
 225     }
 226     $chars = str_split(substr($js, 1));
 227     $isEscaped = $quote = NULL;
 228     $type = $js[0] === '{' ? 'object' : 'array';
 229     $key = $type == 'array' ? 0 : NULL;
 230     $item = '';
 231     $end = strlen($js) - 2;
 232     $quotes = ['"', "'", '/'];
 233     $brackets = [
 234       '}' => '{',
 235       ')' => '(',
 236       ']' => '[',
 237       ':' => '?',
 238     ];
 239     $enclosures = array_fill_keys($brackets, 0);
 240     $result = [];
 241     foreach ($chars as $index => $char) {
 242       if (!$isEscaped && in_array($char, $quotes, TRUE)) {
 243         // Open quotes, taking care not to mistake the division symbol for opening a regex
 244         if (!$quote && !($char == '/' && preg_match('{[\w)]\s*$}', $item))) {
 245           $quote = $char;
 246         }
 247         // Close quotes
 248         elseif ($char === $quote) {
 249           $quote = NULL;
 250         }
 251       }
 252       if (!$quote) {
 253         // Delineates property key
 254         if ($char == ':' && !array_filter($enclosures) && !$key) {
 255           $key = $item;
 256           $item = '';
 257           continue;
 258         }
 259         // Delineates property value
 260         if (($char == ',' || $index == $end) && !array_filter($enclosures) && isset($key) && trim($item) !== '') {
 261           // Trim, unquote, and unescape characters in key
 262           if ($type == 'object') {
 263             $key = trim($key);
 264             $key = in_array($key[0], $quotes) ? self::decode($key) : $key;
 265           }
 266           $result[$key] = trim($item);
 267           $key = $type == 'array' ? $key + 1 : NULL;
 268           $item = '';
 269           continue;
 270         }
 271         // Open brackets - we'll ignore delineators inside
 272         if (isset($enclosures[$char])) {
 273           $enclosures[$char]++;
 274         }
 275         // Close brackets
 276         if (isset($brackets[$char]) && $enclosures[$brackets[$char]]) {
 277           $enclosures[$brackets[$char]]--;
 278         }
 279       }
 280       $item .= $char;
 281       // We are escaping the next char if this is a backslash not preceded by an odd number of backslashes
 282       $isEscaped = $char === '\\' && ((strlen($item) - strlen(rtrim($item, '\\'))) % 2);
 283     }
 284     return $result;
 285   }
 286
 287   /**
 288    * Converts a php array to javascript object/array notation (not strict JSON).
 289    *
 290    * Does not encode keys unless they contain special characters.
 291    * Does not encode values by default, so either specify $encodeValues = TRUE,
 292    * or pass strings of valid js/json as values (per output from getRawProps).
 293    * @see CRM_Utils_JS::getRawProps
 294    *
 295    * @param array $obj
 296    * @param bool $encodeValues
 297    * @return string
 298    */
 299   public static function writeObject($obj, $encodeValues = FALSE) {
 300     $js = [];
 301     $brackets = isset($obj[0]) && array_keys($obj) === range(0, count($obj) - 1) ? ['[', ']'] : ['{', '}'];
 302     foreach ($obj as $key => $val) {
 303       if ($encodeValues) {
 304         $val = self::encode($val);
 305       }
 306       if ($brackets[0] == '{') {
 307         // Enclose the key in quotes unless it is purely alphanumeric
 308         if (preg_match('/\W/', $key)) {
 309           // Prefer single quotes
 310           $key = preg_match('/^[\w "]+$/', $key) ? "'" . $key . "'" : json_encode($key, JSON_UNESCAPED_SLASHES);
 311         }
 312         $js[] = "$key: $val";
 313       }
 314       else {
 315         $js[] = $val;
 316       }
 317     }
 318     return $brackets[0] . implode(', ', $js) . $brackets[1];
 319   }
 320
 321 }