2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
3 /*********************************************************************************
4 * SugarCRM Community Edition is a customer relationship management program developed by
5 * SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
7 * This program is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU Affero General Public License version 3 as published by the
9 * Free Software Foundation with the addition of the following permission added
10 * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
11 * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
12 * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
14 * This program is distributed in the hope that it will be useful, but WITHOUT
15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16 * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
19 * You should have received a copy of the GNU Affero General Public License along with
20 * this program; if not, see http://www.gnu.org/licenses or write to the Free
21 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
24 * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
25 * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
27 * The interactive user interfaces in modified source and object code versions
28 * of this program must display Appropriate Legal Notices, as required under
29 * Section 5 of the GNU Affero General Public License version 3.
31 * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
32 * these Appropriate Legal Notices must retain the display of the "Powered by
33 * SugarCRM" logo. If the display of the logo is not reasonably feasible for
34 * technical reasons, the Appropriate Legal Notices must display the words
35 * "Powered by SugarCRM".
36 ********************************************************************************/
43 * This method returns a predefined array.
44 * The array holds the location of files/folders to be excluded
45 * if a prefix is passed in, then it is prepended to the key value in the array
46 * @prefix string to be prepended to key value in array
48 function get_exclude_files($prefix = ''){
49 //add slash to prefix if it is not empty
51 $prefix = $prefix . '/';
53 //add prefix to key if it was passed in
54 $compress_exempt_files = array(
55 $prefix.'cache' => 'cache',
56 $prefix.'include/javascript/tiny_mce' => 'include/javascript/tiny_mce',
57 $prefix.'include/javascript/yui' => 'include/javascript/yui',
58 $prefix.'include/javascript/yui-old' => 'include/javascript/yui-old',
59 $prefix.'include/javascript/ext-1.1.1' => 'include/javascript/ext-1.1.1',
60 $prefix.'include/javascript/ext-2.0' => 'include/javascript/ext-2.0',
61 $prefix.'include/javascript/tiny_mce' => 'include/javascript/tiny_mce',
62 $prefix.'modules/Emails' => 'modules/Emails',
63 $prefix.'jssource' => 'jssource',
64 $prefix.'modules/ModuleBuilder' => 'modules/ModuleBuilder',
67 return $compress_exempt_files;
73 /**ConcatenateFiles($from_path)
75 * This method takes in a string value of the root directory to begin processing
76 * it uses the predefined array of groupings to create a concatenated file for each grouping
77 * and places the concatenated file in root directory
78 * @from_path root directory where processing should take place
80 function ConcatenateFiles($from_path){
82 $js_groupings = array();
83 if(isset($_REQUEST['root_directory'])){
84 require('jssource/JSGroupings.php');
86 require('JSGroupings.php');
88 //get array with file sources to concatenate
89 $file_groups = $js_groupings;//from JSGroupings.php;
90 $files_opened = array();
93 //for each item in array, concatenate the source files
94 foreach($file_groups as $fg){
96 //process each group array
97 foreach($fg as $loc=>$trgt){
99 $loc = $from_path.'/'.$loc;
100 $trgt = $from_path.'/'.$trgt;
102 //check to see that source file exists, that it is a file, and is readable
103 if(file_exists($loc) && is_file($loc) && is_readable($loc)){
104 $currPerm = fileperms($loc);
105 //check to see if target exists, if it does then open file
106 if(file_exists($trgt)){
107 if(in_array($trgt, $files_opened)){
109 if(function_exists('sugar_fopen')){
110 $trgt_handle = sugar_fopen($trgt, 'a');
112 $trgt_handle = fopen($trgt, 'a');
116 if(function_exists('sugar_fopen')){
117 $trgt_handle = sugar_fopen($trgt, 'w');
119 $trgt_handle = fopen($trgt, 'w');
124 //create and open target file
125 if(function_exists('sugar_fopen')){
126 $trgt_handle = @sugar_fopen($trgt, 'w');
128 $trgt_handle = @fopen($trgt, 'w');
131 // todo: make this failure more friendly. Ideally, it will display a
132 // warning to admin users and revert back to displaying all of the
133 // Javascript files insted of displaying the minified versions.
134 if ($trgt_handle === false) {
135 $target_directory = dirname($trgt);
136 $base_name = realpath(dirname(__FILE__) . '/..') . '/';
137 $target_directory = substr($target_directory, strlen($base_name));
138 sugar_die("please make sure {$target_directory} is writable\n");
142 $files_opened[] = $trgt;
144 //make sure we have handles to both source and target file
146 $buffer = file_get_contents($loc);
147 $buffer .= "// End of File $relpath
150 $num = fwrite($trgt_handle, $buffer);
153 //log error, file did not get appended
154 echo "Error while concatenating file $loc to target file $trgt \n";
157 fclose($trgt_handle);
163 //set permissions on this file
164 if(!empty($currPerm) && $currPerm !== false){
165 //if we can retrieve permissions from target files, use same
166 //permission on concatenated file
167 if(function_exists('sugar_chmod')){
168 @sugar_chmod($trgt, $currPerm);
170 @chmod($trgt, $currPerm);
173 //no permissions could be retrieved, so set to 777
174 if(function_exists('sugar_chmod')){
175 @sugar_chmod($trgt, 0777);
184 function create_backup_folder($bu_path){
185 $bu_path = str_replace('\\', '/', $bu_path);
186 //get path after root
187 $jpos = strpos($bu_path,'jssource');
189 $process_path = $bu_path;
191 $process_path = substr($bu_path, $jpos);
192 $prefix_process_path = substr($bu_path, 0, $jpos-1);
194 //get rest of directories into array
195 $bu_dir_arr = explode('/', $process_path);
197 //iterate through each directory and create if needed
199 foreach($bu_dir_arr as $bu_dir){
200 if(!file_exists($prefix_process_path.'/'.$bu_dir)){
201 if(function_exists('sugar_mkdir')){
202 sugar_mkdir($prefix_process_path.'/'.$bu_dir);
204 mkdir($prefix_process_path.'/'.$bu_dir);
207 $prefix_process_path = $prefix_process_path.'/'.$bu_dir;
216 * This method will call jsmin libraries to minify passed in files
217 * This method takes in 2 string values of the files to process
218 * Processing will back up javascript files and then minify the original javascript.
219 * Back up javascript files will have an added .src extension
220 * @from_path file name and path to be processed
221 * @to_path file name and path to be used to place newly compressed contents
223 function CompressFiles($from_path,$to_path){
224 if(!defined('JSMIN_AS_LIB')){
225 define('JSMIN_AS_LIB', true);
227 //assumes jsmin.php is in same directory
228 if(isset($_REQUEST['root_directory']) || defined('INSTANCE_PATH')){
229 require_once('jssource/jsmin.php');
231 require_once('jsmin.php');
236 //check to make sure from path and to path are not empty
237 if(isset($from_path) && !empty($from_path)&&isset($to_path) && !empty($to_path)){
239 $ReadNextLine = true;
240 // Output a minified version of example.js.
241 if(file_exists($from_path) && is_file($from_path)){
242 //read in license script
243 if(function_exists('sugar_fopen')){
244 $file_handle = sugar_fopen($from_path, 'r');
246 $file_handle = fopen($from_path, 'r');
251 //Read the file until you hit a line with code. This is meant to retrieve
252 //the initial license string found in the beginning comments of js code.
253 while (!feof($file_handle) && $ReadNextLine) {
254 $newLine = fgets($file_handle, 4096);
255 $newLine = trim($newLine);
256 //See if line contains open or closing comments
258 //if opening comments are found, set $beg to true
259 if(strpos($newLine, '/*')!== false){
263 //if closing comments are found, set $beg to false
264 if(strpos($newLine, '*/')!== false){
268 //if line is not empty (has code) set the boolean to false
269 if(! empty($newLine)){$ReadNextLine = false;}
270 //If we are in a comment block, then set boolean back to true
272 $ReadNextLine = true;
273 //add new line to license string
274 $lic_str .=trim($newLine).$nl;
276 //if we are here it means that uncommented and non blank line has been reached
277 //Check to see that ReadNextLine is true, if so then add the last line collected
278 //make sure the last line is either the end to a comment block, or starts with '//'
279 //else do not add as it is live code.
280 if(!empty($newLine) && ((strpos($newLine, '*/')!== false) || ($newLine{0}.$newLine{1}== '//'))){
281 //add new line to license string
284 //set to false because $beg is false, which means the comment block has ended
285 $ReadNextLine = false;
292 fclose($file_handle);
295 //place license string into array for use with jsmin file.
296 //this will preserve the license in the file
297 $lic_arr = array($lic_str);
300 //$jMin = new JSMin($from_path,$to_path,$lic_arr);
301 $out = $lic_str . JSMin::minify(file_get_contents($from_path));
303 if(function_exists('sugar_fopen') && $fh = @sugar_fopen( $to_path, 'w' ) )
308 file_put_contents($to_path, $out);
313 echo"<B> COULD NOT COMPRESS $from_path, it is not a file \n";
318 echo"<B> COULD NOT COMPRESS $from_path, missing variables \n";
322 function reverseScripts($from_path,$to_path=''){
323 $from_path = str_replace('\\', '/', $from_path);
325 $to_path = $from_path;
327 $to_path = str_replace('\\', '/', $to_path);
329 //check to see if provided paths are legit
331 if (!file_exists("$from_path"))
334 echo "JS Source directory at $from_path Does Not Exist<p>\n";
338 //get correct path for backup
340 $bu_path .= substr($from_path, strlen($to_path.'/jssource/src_files'));
342 //if this is a directory, then read it and process files
343 if(is_dir("$from_path")){
344 //grab file / directory and read it.
345 $handle = opendir("$from_path");
346 //loop over the directory and go into each child directory
347 while (false !== ($dir = readdir($handle))) {
349 //make sure you go into directory tree and not out of tree
350 if($dir!= '.' && $dir!= '..'){
351 //make recursive call to process this directory
352 reverseScripts($from_path.'/'.$dir, $to_path );
357 //if this is not a directory, then
358 //check if this is a javascript file, then process
359 $path_parts = pathinfo($from_path);
360 if(is_file("$from_path") && isset($path_parts['extension']) && $path_parts['extension'] =='js'){
362 //create backup directory if needed
363 $bu_dir = dirname($bu_path);
365 if(!file_exists($bu_dir)){
366 //directory does not exist, log it and return
367 echo" directory $bu_dir does not exist, could not restore $bu_path";
371 //delete backup src file if it exists already
372 if(file_exists($bu_path)){
375 copy($from_path, $bu_path);
381 /**BackUpAndCompressScriptFiles
383 * This method takes in a string value of the root directory to begin processing
384 * it will process and iterate through all files and subdirectories
385 * under the passed in directory, ignoring directories and files from the predefined exclude array.
386 * Processing includes calling a method that will minify the javascript children files
387 * @from_path root directory where processing should take place
388 * @to_path root directory where processing should take place, this gets filled in dynamically
390 function BackUpAndCompressScriptFiles($from_path,$to_path = '', $backup = true){
392 //check to see if provided paths are legit
393 if (!file_exists("$from_path"))
396 echo "The from directory, $from_path Does Not Exist<p>\n";
399 $from_path = str_replace('\\', '/', $from_path);
403 $to_path = $from_path;
404 }elseif (!file_exists("$to_path"))
407 echo "The to directory, $to_path Does Not Exist<p>\n";
411 //now grab list of files to exclude from minifying
412 $exclude_files = get_exclude_files($to_path);
414 //process only if file/directory is not in exclude list
415 if(!isset($exclude_files[$from_path])){
417 //get correct path for backup
418 $bu_path = $to_path.'/jssource/src_files';
419 $bu_path .= substr($from_path, strlen($to_path));
421 //if this is a directory, then read it and process files
422 if(is_dir("$from_path")){
423 //grab file / directory and read it.
424 $handle = opendir("$from_path");
425 //loop over the directory and go into each child directory
426 while (false !== ($dir = readdir($handle))) {
428 //make sure you go into directory tree and not out of tree
429 if($dir!= '.' && $dir!= '..'){
430 //make recursive call to process this directory
431 BackUpAndCompressScriptFiles($from_path.'/'.$dir, $to_path,$backup);
437 //if this is not a directory, then
438 //check if this is a javascript file, then process
439 $path_parts = pathinfo($from_path);
440 if(is_file("$from_path") && isset($path_parts['extension']) && $path_parts['extension'] =='js'){
443 $bu_dir = dirname($bu_path);
444 if(!file_exists($bu_dir)){
445 create_backup_folder($bu_dir);
448 //delete backup src file if it exists already
449 if(file_exists($bu_path)){
452 //copy original file into a source file
453 rename($from_path, $bu_path);
455 //no need to backup, but remove file that is about to be copied
456 //if it exists in both backed up scripts and working directory
457 if(file_exists($from_path) && file_exists($bu_path)){unlink($from_path);}
460 //now make call to minify and overwrite the original file.
461 CompressFiles($bu_path, $from_path);