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             ;
216         //echo "<PRE>$cmd\n"; echo `$cmd`; exit;
217         `$cmd`;
218         
219         
220         // we should do more checking.. return val etc..
221         if (file_exists($output) && ($max < filemtime($output) ) ) {
222             return true;
223         }
224         return false;
225         
226     }
227     /**
228      * wrapper arround packer...
229      * uses the translation module & puts index in __tra
230      * 
231      * @param {Array} map of $files => filemtime the files to pack
232      * @param {String} $output name fo file to output
233      *
234      */
235     function pack($files, $output, $translation_base=false)
236     {
237         
238          
239         $o = HTML_FlexyFramework::get()->Pman_Core;
240         
241         if (empty($o['jspacker']) || !file_exists($o['jspacker'].'/pack.js')) {
242             echo '<!-- JS COMPILE ERROR: option: Pman_Core[jspacker] not set to directory -->';
243             return false;
244             
245         }
246         require_once 'System.php';
247         $seed= System::which('seed');
248         if (!$seed) {
249             echo '<!-- JS COMPILE ERROR: seed not installed -->';
250             return false;
251             
252         }
253         $targetm = file_exists($output) && filesize($output) ? filemtime($output) : 0;
254         $max = 0;
255         $ofiles = array();
256         foreach($files as $f => $mt) {
257             $max = max($max,$mt);
258             $ofiles[] = escapeshellarg($f);
259         }
260         if ($max < $targetm) {
261             echo '<!--  use cached compile. -->';
262             return true;
263         }
264         //var_dump($output);
265         if (!file_exists(dirname($output))) {
266             mkdir(dirname($output), 0755, true);
267         }
268         $lsort = create_function('$a,$b','return strlen($a) > strlen($b) ? 1 : -1;');
269         usort($ofiles, $lsort);
270         
271         $eoutput = " -o " . escapeshellarg($output) ;
272             
273                    
274         if (  $translation_base) {
275             $toutput = "-t ". escapeshellarg(preg_replace('/\.js$/', '.__translation__.js', $output)) .
276                     " -p " . escapeshellarg($translation_base) ;//." -k "; // this kills the compression.
277                     
278         }
279         
280         
281         $cmd = "$seed {$o['jspacker']}/pack.js   $eoutput  $toutput " . implode($ofiles, ' ') . ' 2>&1';
282         //echo "<PRE>$cmd\n";
283         //echo `$cmd`;
284         
285          echo "<!-- Compile javascript
286           
287             " . htmlspecialchars($cmd) . "
288             
289             -->";
290             
291        // return false;
292         
293         $res = `$cmd`;
294         //exit;
295         file_put_contents($output.'.log', $cmd."\n\n". $res);
296         // since this only appears when we change.. it's ok to dump it out..
297         echo "<!-- Compiled javascript
298             " . htmlspecialchars($res) . "
299             -->";
300             
301         // we should do more checking.. return val etc..
302         if (file_exists($output) && ($max < filemtime($output) ) ) {
303             
304             return true;
305         }
306         echo "<!-- JS COMPILE ERROR: packed file did not exist  -->";
307         return false;
308         
309     }
310     
311     
312     /***
313      * build:
314      *
315      * @param {String} $proj name of Pman component to build
316      * runs pack.js -m {proj} -a $src/*.js
317      * 
318      *
319      */
320       
321     function build($proj) 
322     {
323         echo "Building $proj\n";
324        // var_dump($proj);
325         if (empty($proj)) {
326             $this->err = "no project";
327             if ($this->cli) echo $this->err;
328             return;
329         }
330         // first item in path is always the app start directory..
331         $src= array_shift(explode(PATH_SEPARATOR, ini_get('include_path'))) .'/Pman/'. $proj;
332         
333         
334         
335        //$tmp = ini_get('session.save_path')."/{$proj}_". posix_getuid(). '_'.md5($src);
336         
337         
338         require_once 'System.php';
339         $seed= System::which('seed');
340         if (!$seed) {
341             $this->err ="no seed installed";
342             if ($this->cli) echo $this->err;
343             return false;
344         }
345         
346         $o = HTML_FlexyFramework::get()->Pman_Core;
347         
348         if (empty($o['jspacker']) || !file_exists($o['jspacker'].'/pack.js')) {
349             $this->err ="no jstoolkit path set [Pman_Core][jspacker] to the
350                     introspection documentation directory where pack.js is located.";
351             if ($this->cli) echo $this->err;
352             return false;
353         }  
354         
355         // should we be more specirfic!??!?!?
356          
357         $cmd = "$seed {$o['jspacker']}/pack.js -m $proj  -a  $src/*.js";
358         echo "$cmd\n";
359         passthru($cmd);
360         // technically we should trash old compiled files.. 
361         // or we move towards a 'cache in session directory model..'
362         
363         
364         /*
365         
366         $ret = $tmp . '/'. $proj . '.js';
367         if ($this->cli) {
368             echo "BUILT:  $ret \n";
369             exit;
370         }
371         return $ret;
372         */
373         
374     }
375     // link {PROJECT}/compiled/{PROJECT}.js to _compiled_ folder to make it live.
376         
377     function install($proj) 
378     {
379        
380         $base = dirname(realpath($_SERVER["SCRIPT_FILENAME"]));
381         if (empty($base )) {
382             $base = getcwd();
383         }
384         var_dump($base .'/Pman/'. $proj.'/compiled/'.$proj .'.js');
385         $src =  realpath($base .'/Pman/'. $proj.'/compiled/'.$proj .'.js');
386         if (!$src) {
387             echo "SKIP : no js file $proj\n";
388             return;
389         }
390         if (!file_exists("$base/_compiled_")) {
391             mkdir ("$base/_compiled_", 0755, true);
392         }
393         $target = "$base/_compiled_/".$proj .'.js';
394         print_R(array($src,$target));
395         if (file_exists($target)) {
396             return; // already installed.
397         }
398         
399         symlink($src, $target);
400         
401         
402     }
403     
404     function gatherProjects() {
405         $src= array_shift(explode(PATH_SEPARATOR, ini_get('include_path'))) .'/Pman';
406         
407         $ret = array();
408         foreach(scandir($src) as $f) {
409             if (!strlen($f) || $f[0] == '.') {
410                 continue;
411             }
412             
413             $fp = "$src/$f";
414             if (!is_dir($fp)) {
415                 continue;
416             }
417             if ($f == 'templates') {
418                 continue;
419             }
420             $ret[] = $f;
421             
422             
423         }
424         return $ret;
425     }
426 }
427