Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
6b83d5bd | 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
6a488035 TO |
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 | +--------------------------------------------------------------------+ | |
e70a7fc0 | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * Parse Javascript content and extract translatable strings. | |
30 | * | |
31 | * @package CRM | |
6b83d5bd | 32 | * @copyright CiviCRM LLC (c) 2004-2019 |
6a488035 TO |
33 | */ |
34 | class CRM_Utils_JS { | |
6714d8d2 | 35 | |
6a488035 | 36 | /** |
fe482240 | 37 | * Parse a javascript file for translatable strings. |
6a488035 | 38 | * |
77855840 TO |
39 | * @param string $jsCode |
40 | * Raw Javascript code. | |
a6c01b45 | 41 | * @return array |
16b10e64 | 42 | * Array of translatable strings |
6a488035 TO |
43 | */ |
44 | public static function parseStrings($jsCode) { | |
be2fb01f | 45 | $strings = []; |
6a488035 TO |
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 | } | |
96025800 | 66 | |
ad295ca9 TO |
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 | ||
b047e061 TO |
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 | ||
232624b1 | 129 | } |