3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * Parse Javascript content and extract translatable strings.
32 * @copyright CiviCRM LLC (c) 2004-2019
37 * Parse a javascript file for translatable strings.
39 * @param string $jsCode
40 * Raw Javascript code.
42 * Array of translatable strings
44 public static function parseStrings($jsCode) {
46 // Match all calls to ts() in an array.
47 // Note: \s also matches newlines with the 's' modifier.
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) {
57 $text = str_replace("\\\n", '', $text);
58 // Unescape escaped quotes
59 $text = str_replace('\\' . $quote, $quote, $text);
61 $text = substr(ltrim($text, $quote), 0, -1);
62 $strings[$text] = $text;
64 return array_values($strings);
68 * Identify duplicate, adjacent, identical closures and consolidate them.
70 * Note that you can only dedupe closures if they are directly adjacent and
71 * have exactly the same parameters.
73 * @param array $scripts
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.
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, '/');
88 $opening .= '\)\s*\{';
89 $opening = '/^' . $opening . '/';
91 // Example closing: })(angular, CRM.$, CRM._);
92 $closing = '\}\s*\)\s*\(\s*';
93 $closing .= implode(',\s*', array_map(function ($v) {
94 return preg_quote($v, '/');
97 $closing = "/$closing\$/";
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]);
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).
115 * At time of writing, running this against the Angular modules, this impl
116 * of stripComments currently adds 10-20ms and cuts ~7%.
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.
122 * @param string $script
125 public static function stripComments($script) {
126 return preg_replace(":^\\s*//[^\n]+$:m", "", $script);
130 * Decodes a js variable (not necessarily strict json but valid js) into a php variable.
132 * This is similar to using json_decode($js, TRUE) but more forgiving about syntax.
134 * ex. {a: 'Apple', 'b': "Banana", c: [1, 2, 3]}
144 public static function decode($js) {
146 $first = substr($js, 0, 1);
147 $last = substr($js, -1);
148 if ($last === $first && ($first === "'" ||
$first === '"')) {
149 // Use a temp placeholder for escaped backslashes
150 return str_replace(['\\\\', "\\'", '\\"', '\\&', '\\/', '**backslash**'], ['**backslash**', "'", '"', '&', '/', '\\'], substr($js, 1, -1));
152 if (($first === '{' && $last === '}') ||
($first === '[' && $last === ']')) {
153 $obj = self
::getRawProps($js);
154 foreach ($obj as $idx => $item) {
155 $obj[$idx] = self
::decode($item);
159 return json_decode($js);
163 * Gets the properties of a javascript object/array WITHOUT decoding them.
165 * Useful when the object might contain js functions, expressions, etc. which cannot be decoded.
166 * Returns an array with keys as property names and values as raw strings of js.
168 * Ex Input: {foo: getFoo(arg), 'bar': function() {return "bar";}}
170 * 'foo' => 'getFoo(arg)',
171 * 'bar' => 'function() {return "bar";}',
178 public static function getRawProps($js) {
180 if (!is_string($js) ||
$js === '' ||
!($js[0] === '{' ||
$js[0] === '[')) {
181 throw new Exception("Invalid js object string passed to CRM_Utils_JS::getRawProps");
183 $chars = str_split(substr($js, 1));
184 $isEscaped = $quote = NULL;
185 $type = $js[0] === '{' ?
'object' : 'array';
186 $key = $type == 'array' ?
0 : NULL;
188 $end = strlen($js) - 2;
189 $quotes = ['"', "'", '/'];
196 $enclosures = array_fill_keys($brackets, 0);
198 foreach ($chars as $index => $char) {
199 if (!$isEscaped && in_array($char, $quotes, TRUE)) {
200 // Open quotes, taking care not to mistake the division symbol for opening a regex
201 if (!$quote && !($char == '/' && preg_match('{[\w)]\s*$}', $item))) {
205 elseif ($char === $quote) {
210 // Delineates property key
211 if ($char == ':' && !array_filter($enclosures) && !$key) {
216 // Delineates property value
217 if (($char == ',' ||
$index == $end) && !array_filter($enclosures) && isset($key) && trim($item) !== '') {
218 // Trim, unquote, and unescape characters in key
219 if ($type == 'object') {
221 $key = in_array($key[0], $quotes) ? self
::decode($key) : $key;
223 $result[$key] = trim($item);
224 $key = $type == 'array' ?
$key +
1 : NULL;
228 // Open brackets - we'll ignore delineators inside
229 if (isset($enclosures[$char])) {
230 $enclosures[$char]++
;
233 if (isset($brackets[$char]) && $enclosures[$brackets[$char]]) {
234 $enclosures[$brackets[$char]]--;
238 // We are escaping the next char if this is a backslash not preceded by an odd number of backslashes
239 $isEscaped = $char === '\\' && ((strlen($item) - strlen(rtrim($item, '\\'))) %
2);
245 * Converts a php array to javascript object/array notation (not strict JSON).
247 * Does not encode keys unless they contain special characters.
248 * Does not encode values by default, so either specify $encodeValues = TRUE,
249 * or pass strings of valid js/json as values (per output from getRawProps).
250 * @see CRM_Utils_JS::getRawProps
253 * @param bool $encodeValues
256 public static function writeObject($obj, $encodeValues = FALSE) {
258 $brackets = isset($obj[0]) && array_keys($obj) === range(0, count($obj) - 1) ?
['[', ']'] : ['{', '}'];
259 foreach ($obj as $key => $val) {
261 $val = json_encode($val, JSON_UNESCAPED_SLASHES
);
263 if ($brackets[0] == '{') {
264 // Enclose the key in quotes unless it is purely alphanumeric
265 if (preg_match('/\W/', $key)) {
266 // Prefer single quotes
267 $key = preg_match('/^[\w "]+$/', $key) ?
"'" . $key . "'" : json_encode($key, JSON_UNESCAPED_SLASHES
);
269 $js[] = "$key: $val";
275 return $brackets[0] . implode(', ', $js) . $brackets[1];