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          
260         $o = HTML_FlexyFramework::get()->Pman_Core;
261         
262         
263         require_once 'System.php';
264         $packer = System::which('roojspacker');
265         
266         
267         if (!$packer) {
268             echo '<!-- roojspacker is not installed -->';
269             return false;
270             
271         }
272         $targetm = file_exists($output) && filesize($output) ? filemtime($output) : 0;
273         $max = 0;
274         $ofiles = array();
275         foreach($files as $f => $mt) {
276             $max = max($max,$mt);
277             $ofiles[] = escapeshellarg($f);
278         }
279         if ($max < $targetm) {
280             echo '<!--  use cached compile. -->';
281             return true;
282         }
283         //var_dump($output);
284         if (!file_exists(dirname($output))) {
285             mkdir(dirname($output), 0755, true);
286         }
287         $lsort = create_function('$a,$b','return strlen($a) > strlen($b) ? 1 : -1;');
288         usort($ofiles, $lsort);
289         
290         //$eoutput = " -k  -o " . escapeshellarg($output) ; // with whitespace..
291         $eoutput = "  -t " . escapeshellarg($output) ;
292           
293         // no support for translation any more?         
294         //if (  $translation_base) {
295         //    $toutput = " -t ". escapeshellarg(preg_replace('/\.js$/', '.__translation__.js', $output)) .
296         //            " -p " . escapeshellarg($translation_base) ;//." -k "; // this kills the compression.
297         //            
298         //}
299         
300         
301         $cmd = "$packer  $eoutput  -f " . implode($ofiles, ' -f ') . ' 2>&1';
302         //echo "<PRE>$cmd\n";
303         //echo `$cmd`;
304         
305          echo "<!-- Compile javascript
306           
307             " . htmlspecialchars($cmd) . "
308             
309             -->";
310             
311        // return false;
312         
313         $res = `$cmd`;
314         //exit;
315         file_put_contents($output.'.log', $cmd."\n\n". $res);
316         // since this only appears when we change.. it's ok to dump it out..
317         echo "<!-- Compiled javascript
318             " . htmlspecialchars($res) . "
319             -->";
320             
321         // we should do more checking.. return val etc..
322         if (file_exists($output) && ($max < filemtime($output) ) ) {
323             
324             return true;
325         }
326         echo "<!-- JS COMPILE ERROR: packed file did not exist  -->";
327         return false;
328         
329     }
330     
331     // depricated verison using seed.
332     function packSeed($files, $output, $translation_base=false)
333     {
334         
335          
336         $o = HTML_FlexyFramework::get()->Pman_Core;
337         
338         if (empty($o['jspacker']) || !file_exists($o['jspacker'].'/pack.js')) {
339             echo '<!-- JS COMPILE ERROR: option: Pman_Core[jspacker] not set to directory -->';
340             return false;
341             
342         }
343         require_once 'System.php';
344         $seed= System::which('seed');
345         $gjs = System::which('gjs');
346         
347         if (!$seed && !$gjs) {
348             echo '<!-- seed or gjs are  not installed -->';
349             return false;
350             
351         }
352         $targetm = file_exists($output) && filesize($output) ? filemtime($output) : 0;
353         $max = 0;
354         $ofiles = array();
355         foreach($files as $f => $mt) {
356             $max = max($max,$mt);
357             $ofiles[] = escapeshellarg($f);
358         }
359         if ($max < $targetm) {
360             echo '<!--  use cached compile. -->';
361             return true;
362         }
363         //var_dump($output);
364         if (!file_exists(dirname($output))) {
365             mkdir(dirname($output), 0755, true);
366         }
367         $lsort = create_function('$a,$b','return strlen($a) > strlen($b) ? 1 : -1;');
368         usort($ofiles, $lsort);
369         
370         //$eoutput = " -k  -o " . escapeshellarg($output) ; // with whitespace..
371         $eoutput = "  -o " . escapeshellarg($output) ;
372                    
373         if (  $translation_base) {
374             $toutput = " -t ". escapeshellarg(preg_replace('/\.js$/', '.__translation__.js', $output)) .
375                     " -p " . escapeshellarg($translation_base) ;//." -k "; // this kills the compression.
376                     
377         }
378         
379         
380         $cmd = ($seed ?
381              "$seed {$o['jspacker']}/pack.js " :
382              "$gjs -I {$o['jspacker']} -I {$o['jspacker']}/JSDOC  {$o['jspacker']}/pack.js -- -- " 
383               
384              ) . " $eoutput  $toutput " . implode($ofiles, ' ') . ' 2>&1';
385         //echo "<PRE>$cmd\n";
386         //echo `$cmd`;
387         
388          echo "<!-- Compile javascript
389           
390             " . htmlspecialchars($cmd) . "
391             
392             -->";
393             
394        // return false;
395         
396         $res = `$cmd`;
397         //exit;
398         file_put_contents($output.'.log', $cmd."\n\n". $res);
399         // since this only appears when we change.. it's ok to dump it out..
400         echo "<!-- Compiled javascript
401             " . htmlspecialchars($res) . "
402             -->";
403             
404         // we should do more checking.. return val etc..
405         if (file_exists($output) && ($max < filemtime($output) ) ) {
406             
407             return true;
408         }
409         echo "<!-- JS COMPILE ERROR: packed file did not exist  -->";
410         return false;
411         
412     }
413     
414     
415     /***
416      * build:
417      *
418      * @param {String} $proj name of Pman component to build
419      * runs pack.js -m {proj} -a $src/*.js
420      * 
421      *
422      */
423       
424     function build($proj) 
425     {
426         echo "Building $proj\n";
427        // var_dump($proj);
428         if (empty($proj)) {
429             $this->err = "no project";
430             if ($this->cli) echo $this->err;
431             return;
432         }
433         // first item in path is always the app start directory..
434         $src= array_shift(explode(PATH_SEPARATOR, ini_get('include_path'))) .'/Pman/'. $proj;
435         
436         
437         
438        //$tmp = ini_get('session.save_path')."/{$proj}_". posix_getuid(). '_'.md5($src);
439         
440         
441         require_once 'System.php';
442         $seed= System::which('seed');
443         if (!$seed) {
444             $this->err ="no seed installed";
445             if ($this->cli) echo $this->err;
446             return false;
447         }
448         
449         $o = HTML_FlexyFramework::get()->Pman_Core;
450         
451         if (empty($o['jspacker']) || !file_exists($o['jspacker'].'/pack.js')) {
452             $this->err ="no jstoolkit path set [Pman_Core][jspacker] to the
453                     introspection documentation directory where pack.js is located.";
454             if ($this->cli) echo $this->err;
455             return false;
456         }  
457         
458         // should we be more specirfic!??!?!?
459          
460         $cmd = "$seed {$o['jspacker']}/pack.js -m $proj  -a  $src/*.js";
461         echo "$cmd\n";
462         passthru($cmd);
463         // technically we should trash old compiled files.. 
464         // or we move towards a 'cache in session directory model..'
465         
466         
467         /*
468         
469         $ret = $tmp . '/'. $proj . '.js';
470         if ($this->cli) {
471             echo "BUILT:  $ret \n";
472             exit;
473         }
474         return $ret;
475         */
476         
477     }
478     // link {PROJECT}/compiled/{PROJECT}.js to _compiled_ folder to make it live.
479         
480     function install($proj) 
481     {
482        
483         $base = dirname(realpath($_SERVER["SCRIPT_FILENAME"]));
484         if (empty($base )) {
485             $base = getcwd();
486         }
487         var_dump($base .'/Pman/'. $proj.'/compiled/'.$proj .'.js');
488         $src =  realpath($base .'/Pman/'. $proj.'/compiled/'.$proj .'.js');
489         if (!$src) {
490             echo "SKIP : no js file $proj\n";
491             return;
492         }
493         if (!file_exists("$base/_compiled_")) {
494             mkdir ("$base/_compiled_", 0755, true);
495         }
496         $target = "$base/_compiled_/".$proj .'.js';
497         print_R(array($src,$target));
498         if (file_exists($target)) {
499             return; // already installed.
500         }
501         
502         symlink($src, $target);
503         
504         
505     }
506     
507     function gatherProjects() {
508         $src= array_shift(explode(PATH_SEPARATOR, ini_get('include_path'))) .'/Pman';
509         
510         $ret = array();
511         foreach(scandir($src) as $f) {
512             if (!strlen($f) || $f[0] == '.') {
513                 continue;
514             }
515             
516             $fp = "$src/$f";
517             if (!is_dir($fp)) {
518                 continue;
519             }
520             if ($f == 'templates') {
521                 continue;
522             }
523             $ret[] = $f;
524             
525             
526         }
527         return $ret;
528     }
529 }
530