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