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