CRM/Utils/JS.php

   1 <?php
   2 /*
   3 +--------------------------------------------------------------------+
   4 | CiviCRM version 4.6                                                |
   5 +--------------------------------------------------------------------+
   6 | Copyright CiviCRM LLC (c) 2004-2015                                |
   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-2015
  33  * $Id$
  34  *
  35  */
  36 class CRM_Utils_JS {
  37   /**
  38    * Parse a javascript file for translatable strings.
  39    *
  40    * @param string $jsCode
  41    *   Raw Javascript code.
  42    * @return array
  43    *   Array of translatable strings
  44    */
  45   public static function parseStrings($jsCode) {
  46     $strings = array();
  47     // Match all calls to ts() in an array.
  48     // Note: \s also matches newlines with the 's' modifier.
  49     preg_match_all('~
  50       [^\w]ts\s*                                    # match "ts" with whitespace
  51       \(\s*                                         # match "(" argument list start
  52       ((?:(?:\'(?:\\\\\'|[^\'])*\'|"(?:\\\\"|[^"])*")(?:\s*\+\s*)?)+)\s*
  53       [,\)]                                         # match ")" or "," to finish
  54       ~sx', $jsCode, $matches);
  55     foreach ($matches[1] as $text) {
  56       $quote = $text[0];
  57       // Remove newlines
  58       $text = str_replace("\\\n", '', $text);
  59       // Unescape escaped quotes
  60       $text = str_replace('\\' . $quote, $quote, $text);
  61       // Remove end quotes
  62       $text = substr(ltrim($text, $quote), 0, -1);
  63       $strings[$text] = $text;
  64     }
  65     return array_values($strings);
  66   }
  67
  68   /**
  69    * Identify duplicate, adjacent, identical closures and consolidate them.
  70    *
  71    * Note that you can only dedupe closures if they are directly adjacent and
  72    * have exactly the same parameters.
  73    *
  74    * @param array $scripts
  75    *   Javascript source.
  76    * @param array $localVars
  77    *   Ordered list of JS vars to identify the start of a closure.
  78    * @param array $inputVals
  79    *   Ordered list of input values passed into the closure.
  80    * @return string
  81    *   Javascript source.
  82    */
  83   public static function dedupeClosures($scripts, $localVars, $inputVals) {
  84     // Example opening: (function (angular, $, _) {
  85     $opening = '\s*\(\s*function\s*\(\s*';
  86     $opening .= implode(',\s*', array_map(function ($v) {
  87       return preg_quote($v, '/');
  88     }, $localVars));
  89     $opening .= '\)\s*\{';
  90     $opening = '/^' . $opening . '/';
  91
  92     // Example closing: })(angular, CRM.$, CRM._);
  93     $closing = '\}\s*\)\s*\(\s*';
  94     $closing .= implode(',\s*', array_map(function ($v) {
  95       return preg_quote($v, '/');
  96     }, $inputVals));
  97     $closing .= '\);\s*';
  98     $closing = "/$closing\$/";
  99
 100     $scripts = array_values($scripts);
 101     for ($i = count($scripts) - 1; $i > 0; $i--) {
 102       if (preg_match($closing, $scripts[$i - 1]) && preg_match($opening, $scripts[$i])) {
 103         $scripts[$i - 1] = preg_replace($closing, '', $scripts[$i - 1]);
 104         $scripts[$i] = preg_replace($opening, '', $scripts[$i]);
 105       }
 106     }
 107
 108     return $scripts;
 109   }
 110
 111 }