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