JsCompile.php
[Pman.Core] / JsCompile.php
1 <?php
2
3 /**
4 * wrapper code around js builder...
5
6 *  -- we will use this later to compile on the fly...
7 *
8 *  -- updated to use roojspacker https://github.com/roojs/roojspacker
9 *
10 *
11 * For general usage:
12 *  $x = new Pman_Core_JsCompile();
13 *  $x->pack('/path/to/files/', 'destination')
14 *  
15 */
16 require_once 'Pman.php';
17
18
19 class Pman_Core_JsCompile  extends Pman
20 {
21     
22     static $cli_desc = "Wrapper around Javascript compression tools
23                         Runs the javascript compiler - merging all the JS files so the load faster.
24                         Note: cfg option Pman_Builder['jspacker'] must be set to location of jstoolkit code 
25 ";
26     
27     var $cli = false;
28     function getAuth()
29     {
30         // command line only ATM
31         $this->cli = HTML_FlexyFramework::get()->cli;
32       //  var_dump($this->cli);
33         if ($this->cli) {
34             return true;
35         }
36         return  false;
37     }
38     
39     
40     function get($proj, $args)
41     {
42         if (empty($args)) {
43             die("missing action : eg. build or install");
44         }
45         // list of projects.
46         if (empty($args[1])) {
47             
48             $ar = $this->gatherProjects();
49              echo "SELECT Component to build\n";
50             print_r($ar);
51             exit;
52         } else {
53             $ar = array($args[1]); 
54             //$ar = $args;
55             //array_shift($ar);
56         }
57         
58         switch ($args[0]) {
59             case 'build':
60              
61                 foreach($ar as $p) {
62                     $this->build($p);
63                     //$this->install($p);
64                 }
65                 break;
66             case 'install' :     // needed for install on remote sites..
67                 die('not yet..');
68                 foreach($ar as $p) {
69                     $this->install($p);
70                 }
71                 break;
72         }
73         exit;
74     }
75     /**
76      * packScript:
77      *
78      * @param {String} basedir absolute path to files
79      * @param {Array}  list of files (ontop of basedir) 
80      * @param {String} output url (path to basedir basically), or false
81      *                  to not compile
82      * 
83      *
84      */
85     
86     static function jsSort($a,$b)
87     {
88         $a = substr($a, 0, -3);
89         $b=  substr($b, 0, -3);
90         if ($a == $b) {
91             return 0;
92         }
93         return ($a > $b) ? +1 : -1;
94     }
95     
96     
97     function packScript($basedir, $files,  $output_url, $compile=true)
98     {
99         // this outputs <script tags..>
100         // either for just the original files,
101         // or the compressed version.
102         // first expand files..
103         
104         echo "<!-- compiling   $basedir  -->\n";
105         
106         $arfiles = array();
107         $ofiles = array();
108         foreach($files as $f) {
109              if (!file_exists($basedir .'/' .$f)) {
110                 continue;
111             }
112             if (!is_dir($basedir .'/' .$f)) {
113                 
114                 $arfiles[$basedir .'/' .$f] = filemtime($basedir .'/' .$f);
115                 $ofiles[] = $f;
116                 continue;
117             }
118             
119             foreach(glob($basedir .'/' .$f.'/*.js') as $fx) {
120                 
121                 $arfiles[$fx] = filemtime($fx);
122                 $ofiles [] = $f . '/'. basename($fx);
123             }
124         }
125         $tf = 
126         // sort exc. the .js
127         usort($ofiles,create_function('$a,$b', 'return Pman_Core_JsCompile::jsSort($a,$b);'));
128         
129         //print_R($ofiles);
130         
131         $output = md5(serialize($arfiles)) .'.js';
132         
133         if ( $compile && !file_exists($basedir.'/_cache_/'.$output)) {
134             $this->pack($arfiles,$basedir.'/_cache_/'.$output);
135         }
136         
137         if ($compile && file_exists($basedir.'/_cache_/'.$output)) {
138             
139             echo '<script type="text/javascript" src="'.$output_url.'/_cache_/'. $output.'"></script>';
140             return;
141         }
142         foreach($ofiles as $f) {
143             echo '<script type="text/javascript" src="'.$output_url.'/'.$f.'"></script>'."\n";
144             
145         }
146           
147     }
148     
149     // this is depricated... - we can use the pear CSS library for this..
150     
151     function packCss($basedir, $files,   $output_url)
152     {
153         // this outputs <script tags..>
154         // either for just the original files,
155         // or the compressed version.
156         // first expand files..
157         
158         $arfiles = array();
159         $ofiles = array();
160         //print_R($files);
161         foreach($files as $f) {
162             if (!file_exists($basedir .'/' .$f)) {
163                 continue;
164             }
165             if (!is_dir($basedir .'/' .$f)) {
166                 $arfiles[$basedir .'/' .$f] = filemtime($basedir .'/' .$f);
167                 $ofiles[] = $f;
168                 continue;
169             }
170             foreach(glob($basedir .'/' .$f.'/*.css') as $fx) {
171                 $arfiles[$fx] = filemtime($fx);
172                 $ofiles [] = $f . '/'. basename($fx);
173             }
174         }
175         
176         $output = md5(serialize($arfiles)) .'.css';
177         
178         if (!file_exists($basedir.'/_cache_/'.$output)) {
179             $this->packCssCore($arfiles,$basedir.'/_cache_/'.$output);
180         }
181         //var_dump()$basedir. '/_cache_/'.$output);
182         if (file_exists($basedir. '/_cache_/'.$output)) {
183             echo '<link type="text/css" rel="stylesheet" media="screen" href="'.$output_url. '/_cache_/'. $output.'" />';
184             return;
185         }
186         foreach($ofiles as $f ) {
187             echo '<link type="text/css" rel="stylesheet" media="screen" href="'.$output_url.'/'.$f.'" />'."\n";
188              
189         }
190          
191         
192     }
193      /**
194      * wrapper arroudn packer...
195      * @param {Array} map of $files => filemtime the files to pack
196      * @param {String} $output name fo file to output
197      *
198      */
199     function packCssCore($files, $output)
200     {
201         
202          
203         $o = HTML_FlexyFramework::get()->Pman_Core;
204         
205         if (empty($o['cssminify']) || !file_exists($o['cssminify'])) {
206             echo '<!-- cssminify not set -->';
207             return false;
208         }
209         require_once 'System.php';
210         
211         $seed= System::which('seed');
212         $gjs = System::which('gjs');
213         
214         if (!$seed && !$gjs) {
215             echo '<!-- seed or gjs are  not installed -->';
216             return false;
217             
218         }
219         $targetm = file_exists($output) ? filemtime($output) : 0;
220         $max = 0;
221         $ofiles = array();
222         foreach($files as $f => $mt) {
223             $max = max($max,$mt);
224             $ofiles[] = escapeshellarg($f);
225         }
226         if ($max < $targetm)  {
227             return true;
228         }
229         if (!file_exists(dirname($output))) {
230             mkdir(dirname($output), 0755, true);
231         }
232         $eoutput = escapeshellarg($output);
233         $cmd = $seed ?
234             ("$seed {$o['cssminify']}  $eoutput " . implode($ofiles, ' ')) :
235             ("$gjs {$o['cssminify']} -- -- $eoutput " . implode($ofiles, ' ')); 
236         //echo "<PRE>$cmd\n"; echo `$cmd`; exit;
237         `$cmd`;
238         
239         
240         // we should do more checking.. return val etc..
241         if (file_exists($output) && ($max < filemtime($output) ) ) {
242             return true;
243         }
244         return false;
245         
246     }
247     /**
248      * wrapper arround packer...
249      * uses the translation module & puts index in __tra
250      * 
251      * @param {Array} map of $files => filemtime the files to pack
252      * @param {String} $output name fo file to output
253      *
254      */
255     
256     function pack($files, $output, $translation_base=false)
257     {
258         
259         if (empty($files)) {
260             return false;
261         }
262         
263         $o = HTML_FlexyFramework::get()->Pman_Core;
264         if (isset($o['packseed'])) {
265             return $this->packSeed($files,$output,$translation_base);
266         }
267         if (!empty($o['disable_packer'])) {
268             echo "<!-- packer disabled    disable_packer  != false -->";
269             return;
270         }
271         
272         require_once 'System.php';
273         $packer = System::which('roojspacker');
274         
275         
276         if (!$packer) {
277             echo '<!-- roojspacker is not installed -->';
278             return false;
279             
280         }
281         $targetm = file_exists($output) && filesize($output) ? filemtime($output) : 0;
282         $max = 0;
283         $ofiles = array();
284         foreach($files as $f => $mt) {
285             $max = max($max,$mt);
286             $ofiles[] = escapeshellarg($f);
287         }
288         if ($max < $targetm) {
289             echo '<!--  use cached compile. -->';
290             return true;
291         }
292         
293         if (file_exists($output)) {
294             unlink($output);
295         }
296         
297          
298         if (!file_exists(dirname($output))) {
299             mkdir(dirname($output), 0755, true);
300         }
301         $lsort = create_function('$a,$b','return strlen($a) > strlen($b) ? 1 : -1;');
302         usort($ofiles, $lsort);
303         
304         //$eoutput = " -k  -o " . escapeshellarg($output) ; // with whitespace..
305         $eoutput = "  -t " . escapeshellarg($output) ;
306           
307         // no support for translation any more?         
308         //if (  $translation_base) {
309         //    $toutput = " -t ". escapeshellarg(preg_replace('/\.js$/', '.__translation__.js', $output)) .
310         //            " -p " . escapeshellarg($translation_base) ;//." -k "; // this kills the compression.
311         //            
312         //}
313         
314         
315         $cmd = "$packer  $eoutput  -f " . implode($ofiles, ' -f ') . ' 2>&1';
316         //echo "<PRE>$cmd\n";
317         //echo `$cmd`;
318         
319          echo "<!-- Compile javascript
320           
321             " . htmlspecialchars($cmd) . "
322             
323             -->";
324             
325        // return false;
326         
327         $res = `$cmd`;
328         //exit;
329         file_put_contents($output.'.log', $cmd."\n\n". $res);
330         // since this only appears when we change.. it's ok to dump it out..
331         echo "<!-- Compiled javascript
332             " . htmlspecialchars($res) . "
333             -->";
334         clearstatcache();
335         // we should do more checking.. return val etc..
336         if (file_exists($output) && filesize($output) && ($max < filemtime($output) ) ) {
337             echo "<!-- file looks like its been generated -->\n";
338             return true;
339         }
340         echo '<script type="text/javascript"> alert('. json_encode("Error: Javascript Compile failed\n" . $res) .');</script>';
341      
342         
343         echo "<!-- JS COMPILE ERROR: packed file did not exist  -->";
344         return false;
345         
346     }
347     
348     // depricated verison using seed.
349     function packSeed($files, $output, $translation_base=false)
350     {
351         
352          
353         $o = HTML_FlexyFramework::get()->Pman_Core;
354         
355         if (empty($o['packseed']) || !file_exists($o['jspacker'].'/pack.js')) {
356             echo '<!-- JS COMPILE ERROR: option: Pman_Core[jspacker] not set to directory -->';
357             return false;
358             
359         }
360         require_once 'System.php';
361         $seed= System::which('seed');
362         $gjs = System::which('gjs');
363         
364         if (!$seed && !$gjs) {
365             echo '<!-- seed or gjs are  not installed -->';
366             return false;
367             
368         }
369         $targetm = file_exists($output) && filesize($output) ? filemtime($output) : 0;
370         $max = 0;
371         $ofiles = array();
372         foreach($files as $f => $mt) {
373             $max = max($max,$mt);
374             $ofiles[] = escapeshellarg($f);
375         }
376         if ($max < $targetm) {
377             echo '<!--  use cached compile. -->';
378             return true;
379         }
380         //var_dump($output);
381         if (!file_exists(dirname($output))) {
382             mkdir(dirname($output), 0755, true);
383         }
384         $lsort = create_function('$a,$b','return strlen($a) > strlen($b) ? 1 : -1;');
385         usort($ofiles, $lsort);
386         
387         //$eoutput = " -k  -o " . escapeshellarg($output) ; // with whitespace..
388         $eoutput = "  -o " . escapeshellarg($output) ;
389                    
390         if (  $translation_base) {
391             $toutput = " -t ". escapeshellarg(preg_replace('/\.js$/', '.__translation__.js', $output)) .
392                     " -p " . escapeshellarg($translation_base) ;//." -k "; // this kills the compression.
393                     
394         }
395         
396         
397         $cmd = ($seed ?
398              "$seed {$o['packseed']}/pack.js " :
399              "$gjs -I {$o['packseed']} -I {$o['packseed']}/JSDOC  {$o['packseed']}/pack.js -- -- " 
400               
401              ) . " $eoutput  $toutput " . implode($ofiles, ' ') . ' 2>&1';
402         //echo "<PRE>$cmd\n";
403         //echo `$cmd`;
404         
405          echo "<!-- Compile javascript
406           
407             " . htmlspecialchars($cmd) . "
408             
409             -->";
410             
411        // return false;
412         
413         $res = `$cmd`;
414         //exit;
415         file_put_contents($output.'.log', $cmd."\n\n". $res);
416         // since this only appears when we change.. it's ok to dump it out..
417         echo "<!-- Compiled javascript
418             " . htmlspecialchars($res) . "
419             -->";
420             
421         // we should do more checking.. return val etc..
422         if (file_exists($output) && ($max < filemtime($output) ) ) {
423             
424             return true;
425         }
426         
427          
428         echo "\n<!-- JS COMPILE ERROR: packed file did not exist  -->\n";
429         return false;
430         
431     }
432     
433     
434     /***
435      * build:
436      *
437      * @param {String} $proj name of Pman component to build
438      * runs pack.js -m {proj} -a $src/*.js
439      * 
440      *
441      */
442       
443     function build($proj) 
444     {
445         echo "Building $proj\n";
446        // var_dump($proj);
447         if (empty($proj)) {
448             $this->err = "no project";
449             if ($this->cli) echo $this->err;
450             return;
451         }
452         // first item in path is always the app start directory..
453         $src= array_shift(explode(PATH_SEPARATOR, ini_get('include_path'))) .'/Pman/'. $proj;
454         
455         
456         
457        //$tmp = ini_get('session.save_path')."/{$proj}_". posix_getuid(). '_'.md5($src);
458         
459         
460         require_once 'System.php';
461         $seed= System::which('seed');
462         if (!$seed) {
463             $this->err ="no seed installed";
464             if ($this->cli) echo $this->err;
465             return false;
466         }
467         
468         $o = HTML_FlexyFramework::get()->Pman_Core;
469         
470         if (empty($o['packseed']) || !file_exists($o['packseed'].'/pack.js')) {
471             $this->err ="no jstoolkit path set [Pman_Core][packseed] to the
472                     introspection documentation directory where pack.js is located.";
473             if ($this->cli) echo $this->err;
474             return false;
475         }  
476         
477         // should we be more specirfic!??!?!?
478          
479         $cmd = "$seed {$o['packseed']}/pack.js -m $proj  -a  $src/*.js";
480         echo "$cmd\n";
481         passthru($cmd);
482         // technically we should trash old compiled files.. 
483         // or we move towards a 'cache in session directory model..'
484         
485         
486         /*
487         
488         $ret = $tmp . '/'. $proj . '.js';
489         if ($this->cli) {
490             echo "BUILT:  $ret \n";
491             exit;
492         }
493         return $ret;
494         */
495         
496     }
497     // link {PROJECT}/compiled/{PROJECT}.js to _compiled_ folder to make it live.
498         
499     function install($proj) 
500     {
501        
502         $base = dirname(realpath($_SERVER["SCRIPT_FILENAME"]));
503         if (empty($base )) {
504             $base = getcwd();
505         }
506         var_dump($base .'/Pman/'. $proj.'/compiled/'.$proj .'.js');
507         $src =  realpath($base .'/Pman/'. $proj.'/compiled/'.$proj .'.js');
508         if (!$src) {
509             echo "SKIP : no js file $proj\n";
510             return;
511         }
512         if (!file_exists("$base/_compiled_")) {
513             mkdir ("$base/_compiled_", 0755, true);
514         }
515         $target = "$base/_compiled_/".$proj .'.js';
516         print_R(array($src,$target));
517         if (file_exists($target)) {
518             return; // already installed.
519         }
520         
521         symlink($src, $target);
522         
523         
524     }
525     
526     function gatherProjects() {
527         $src= array_shift(explode(PATH_SEPARATOR, ini_get('include_path'))) .'/Pman';
528         
529         $ret = array();
530         foreach(scandir($src) as $f) {
531             if (!strlen($f) || $f[0] == '.') {
532                 continue;
533             }
534             
535             $fp = "$src/$f";
536             if (!is_dir($fp)) {
537                 continue;
538             }
539             if ($f == 'templates') {
540                 continue;
541             }
542             $ret[] = $f;
543             
544             
545         }
546         return $ret;
547     }
548 }
549