git.roojs.org Git - Pman.Base/blob - Pman.php

   1 <?php
   2 /**
   3  * Pman Base class
   4  *
   5  * Provides:
   6  *  - base application setup (variables etc to javascript)
   7  *
   8  *  - authentication and permission info about user / application
   9  *  - json output methods.
  10  *  - file upload error checking - checkFileUploadError
  11  *  - logging to event table
  12  *  - sendTemplate code (normally use the Person version for sending to specific people..)
  13  *
  14  *  - doc managment code?? - remarks and tracking??? - MOVEME
  15  *  - authentication link checking?? MOVEME?
  16  *  - authentication reset password ?? MOVEME?
  17  *  ?? arrayClean.. what's it doing here?!? ;)
  18  *
  19  *
  20  *  OPTIONS
  21  *  Pman['local_autoauth']   // who to login as when using localhost
  22  *  Pman['isDev']  // can the site show develpment info.?
  23  *  Pman['uiConfig']  // extra variable to export to front end..
  24  *  Pman['auth_comptype'] // -- if set to 'OWNER' then only users with company=OWNER can log in
  25  *  Pman['authTable'] // the authentication table (default 'person')
  26  *
  27  *
  28  * Usefull implemetors
  29  * DB_DataObject*:*toEventString (for logging - this is generically prefixed to all database operations.)
  30  *   - any data object where this method exists, the result will get prefixed to the log remarks
  31  */
  32
  33
  34
  35
  36
  37 require_once 'Pman/Core/AssetTrait.php';
  38
  39 class Pman extends HTML_FlexyFramework_Page
  40 {
  41     use Pman_Core_AssetTrait;
  42     //outputJavascriptDir()
  43     //outputCssDir();
  44
  45     var $appName= "";
  46     var $appLogo= "";
  47     var $appShortName= "";
  48     var $appVersion = "1.8";
  49     var $version = 'dev';
  50     var $onloadTrack = 0;
  51     var $linkFail = "";
  52     var $showNewPass = 0;
  53     var $logoPrefix = '';
  54     var $appModules = '';
  55     var $appDisabled = array(); // array of disabled modules..
  56                     // (based on config option disable)
  57
  58     var $authUser; // always contains the authenticated user..
  59
  60     var $disable_jstemplate = false; /// disable inclusion of jstemplate code..
  61     var $company = false;
  62
  63     var $css_path = ''; // can inject a specific path into the base HTML page.
  64
  65
  66     var $transObj = false; // used to rollback or commit in JOK/JERR
  67     /**
  68      * ------------- Standard getAuth/get/post methods of framework.
  69      *
  70      *
  71      */
  72
  73     function getAuth() // everyone allowed in!!!!!
  74     {
  75         $this->loadOwnerCompany();
  76
  77         return true;
  78     }
  79
  80     function init($base = false)
  81     {
  82
  83         if (isset($this->_hasInit)) {
  84             return;
  85         }
  86         $this->_hasInit = true;
  87          // move away from doing this ... you can access bootLoader.XXXXXX in the master template..
  88         $boot = HTML_FlexyFramework::get();
  89         // echo'<PRE>';print_R($boot);exit;
  90         $this->appName      = $boot->appName;
  91
  92         $this->appNameShort = $boot->appNameShort;
  93
  94         $this->appModules   = $boot->enable;
  95
  96 //        echo $this->arrayToJsInclude($files);
  97         $this->isDev = empty($boot->Pman['isDev']) ? false : $boot->Pman['isDev'];
  98
  99         $this->css_path = empty($boot->Pman['css_path']) ? '' : $boot->Pman['css_path'];
 100
 101         $this->appDisable = $boot->disable;
 102         $this->appDisabled = explode(',', $boot->disable);
 103         $this->version = $boot->version;
 104         $this->uiConfig = empty($boot->Pman['uiConfig']) ? false : $boot->Pman['uiConfig'];
 105
 106         if (!empty($boot->Pman['local_autoauth']) &&
 107             !empty($_SERVER['SERVER_ADDR']) &&
 108             !empty($_SERVER['REMOTE_ADDR']) &&
 109             ($_SERVER['SERVER_ADDR'] == '127.0.0.1') &&
 110             ($_SERVER['REMOTE_ADDR'] == '127.0.0.1')
 111         ) {
 112             $this->isDev = true;
 113         }
 114
 115         if (
 116             !empty($_REQUEST['isDev'])
 117             &&
 118             !empty($_SERVER['SERVER_ADDR']) &&
 119             (
 120                 (($_SERVER['SERVER_ADDR'] == '127.0.0.1') && ($_SERVER['REMOTE_ADDR'] == '127.0.0.1'))
 121                 ||
 122                 (($_SERVER['SERVER_ADDR'] == '::1') && ($_SERVER['REMOTE_ADDR'] == '::1'))
 123             )
 124
 125         ) {
 126             $boot->Pman['isDev'] = true;
 127             $this->isDev = true;
 128         }
 129
 130         // if a file Pman_{module}_Pman exists.. and it has an init function... - call that..
 131
 132         //var_dump($this->appModules);
 133
 134
 135
 136     }
 137     /*
 138      * call a method on {module}/Pman.php
 139      * * initially used on the main page load to call init();
 140      * * also used for ccsIncludes??
 141      *
 142      * // usage: $this->callModules('init', $base)
 143      *
 144      */
 145
 146     function callModules($fn)
 147     {
 148         $args = func_get_args();
 149         array_shift($args);
 150         foreach(explode(',',$this->appModules) as $m) {
 151             $cls = 'Pman_'. $m . '_Pman';
 152             if (!file_exists($this->rootDir . '/'.str_replace('_','/', $cls). '.php')) {
 153                 continue;
 154             }
 155             require_once str_replace('_','/', $cls). '.php';
 156             $c = new $cls();
 157             if (method_exists($c, $fn)) {
 158                 call_user_func_array(array($c,$fn),$args);
 159             }
 160         }
 161
 162      }
 163
 164     function get($base, $opts=array())
 165     {
 166         $this->init();
 167         if (empty($base)) {
 168             $this->callModules('init', $this, $base);
 169         }
 170
 171             //$this->allowSignup= empty($opts['allowSignup']) ? 0 : 1;
 172         $bits = explode('/', $base);
 173
 174
 175         // should really be moved to Login...
 176         /*
 177         if ($bits[0] == 'PasswordReset') {
 178             $this->linkFail = $this->resetPassword(@$bits[1],@$bits[2],@$bits[3]);
 179             header('Content-type: text/html; charset=utf-8');
 180             return;
 181         }
 182         */
 183
 184         $au = $this->getAuthUser();
 185         if ($au) {
 186             $ff= HTML_FlexyFramework::get();
 187
 188             if (!empty($ff->Pman['auth_comptype']) && $au->id > 0 &&
 189                 ( !$au->company_id || ($ff->Pman['auth_comptype'] != $au->company()->comptype))) {
 190
 191                 $au->logout();
 192
 193                 $this->jerr("Login not permited to outside companies - please reload");
 194             }
 195             $this->addEvent("RELOAD");
 196         }
 197
 198
 199         if (strlen($base) && $bits[0] != 'PasswordReset') {
 200             $this->jerror("BADURL","invalid url: $base");
 201         }
 202         // deliver template
 203         if (isset($_GET['onloadTrack'])) {
 204             $this->onloadTrack = (int)$_GET['onloadTrack'];
 205         }
 206         // getting this to work with xhtml is a nightmare
 207         // = nbsp / <img> issues screw everyting up.
 208          //var_dump($this->isDev);
 209         // force regeneration on load for development enviroments..
 210
 211         HTML_FlexyFramework::get()->generateDataobjectsCache($this->isDev && !empty($_REQUEST['isDev']));
 212
 213         //header('Content-type: application/xhtml+xml; charset=utf-8');
 214
 215
 216
 217         if ($this->company && $this->company->logo_id) {
 218             $im = DB_DataObject::Factory('Images');
 219             $im->get($this->company->logo_id);
 220             $this->appLogo = $this->baseURL . '/Images/Thumb/x100/'. $this->company->logo_id .'/' . $im->filename;
 221         }
 222
 223         header('Content-type: text/html; charset=utf-8');
 224
 225     }
 226     function post($base) {
 227         return $this->get($base);
 228     }
 229
 230
 231     // --------------- AUTHENTICATION or  system information
 232     /**
 233      * loadOwnerCompany:
 234      * finds the compay with comptype=='OWNER'
 235      * ?? what about comptype_id-name ?????
 236      *
 237      * @return {Pman_Core_DataObjects_Companies} the owner company
 238      */
 239     function loadOwnerCompany()
 240     {
 241         // only applies if authtable is person..
 242         $ff = HTML_FlexyFramework::get();
 243         if (!empty($ff->Pman['authTable']) && !in_array($ff->Pman['authTable'] , [ 'core_person', 'Person' ])) {
 244             return false;
 245         }
 246
 247         $this->company = DB_DataObject::Factory('core_company');
 248         if (!is_a($this->company, 'DB_DataObject')) { // non-core pman projects
 249             return false;
 250         }
 251         $e = DB_DataObject::Factory('core_enum')->lookupObject('COMPTYPE', 'OWNER');
 252
 253         $this->company->get('comptype_id', $e->id);
 254         return $this->company;
 255     }
 256
 257
 258
 259     /**
 260      * getAuthUser: - get the authenticated user..
 261      *
 262      * @return {DB_DataObject} of type Pman[authTable] if authenticated.
 263      */
 264
 265     function getAuthUser()
 266     {
 267         if (!empty($this->authUser)) {
 268             return $this->authUser;
 269         }
 270         $ff = HTML_FlexyFramework::get();
 271         $tbl = empty($ff->Pman['authTable']) ? 'core_person' : $ff->Pman['authTable'];
 272
 273         $u = DB_DataObject::factory( $tbl );
 274
 275         if (is_a($u,'PEAR_Error') || !$u->isAuth()) {
 276             return false;
 277         }
 278         $this->authUser =$u->getAuthUser();
 279         return $this->authUser ;
 280     }
 281     /**
 282      * hasPerm:
 283      * wrapper arround authuser->hasPerm
 284      * @see Pman_Core_DataObject_Core_person::hasPerm
 285      *
 286      * @param {String} $name  The permission name (eg. Projects.List)
 287      * @param {String} $lvl   eg. (C)reate (E)dit (D)elete ... etc.
 288      *
 289      */
 290     function hasPerm($name, $lvl)  // do we have a permission
 291     {
 292         static $pcache = array();
 293         $au = $this->getAuthUser();
 294         return $au && $au->hasPerm($name,$lvl);
 295
 296     }
 297
 298     /**
 299      * modulesList:  List the modules in the application
 300      *
 301      * @return {Array} list of modules
 302      */
 303     function modulesList()
 304     {
 305         $boot = HTML_FlexyFramework::get();
 306         // echo'<PRE>';print_R($boot);exit;
 307
 308
 309         $mods = explode(',', $boot->enable);
 310         if (in_array('Core',$mods)) { // core has to be the first  modules loaded as it contains Pman.js
 311             array_unshift($mods,   'Core');
 312         }
 313
 314         if (in_array($boot->appNameShort,$mods)) { // Project has to be the last  modules loaded as it contains Pman.js
 315             unset($mods[array_search($boot->appNameShort, $mods)]);
 316             $mods[] = $boot->appNameShort;
 317         }
 318
 319         $mods = array_unique($mods);
 320
 321         $disabled =  explode(',', $boot->disable ? $boot->disable : '');
 322         $ret = array();
 323         foreach($mods as $mod) {
 324             // add the css file..
 325             if (in_array($mod, $disabled)) {
 326                 continue;
 327             }
 328             $ret[] = $mod;
 329         }
 330         return $ret;
 331     }
 332
 333
 334
 335
 336     function hasModule($name)
 337     {
 338         $this->init();
 339         if (!strpos( $name,'.') ) {
 340             // use enable / disable..
 341             return in_array($name, $this->modules());
 342         }
 343
 344         $x = DB_DataObject::factory('core_group_right');
 345         $ar = $x->defaultPermData();
 346         if (empty($ar[$name]) || empty($ar[$name][0])) {
 347             return false;
 348         }
 349         return true;
 350     }
 351
 352
 353
 354     function jsencode($v, $header = false)
 355     {
 356         if ($header) {
 357             header("Content-type: text/javascript");
 358         }
 359         if (function_exists("json_encode")) {
 360             $ret=  json_encode($v);
 361             if ($ret !== false) {
 362                 return $ret;
 363             }
 364         }
 365         require_once 'Services/JSON.php';
 366         $js = new Services_JSON();
 367         return $js->encodeUnsafe($v);
 368
 369
 370
 371     }
 372
 373
 374
 375     /**
 376      * ---------------- Global Tools ---------------
 377      */
 378     function checkFileUploadError()  // check for file upload errors.
 379     {
 380         if (
 381             empty($_FILES['File'])
 382             || empty($_FILES['File']['name'])
 383             || empty($_FILES['File']['tmp_name'])
 384             || empty($_FILES['File']['type'])
 385             || !empty($_FILES['File']['error'])
 386             || empty($_FILES['File']['size'])
 387         ) {
 388             $this->jerr("File upload error: <PRE>" . print_r($_FILES,true) . print_r($_POST,true) . "</PRE>");
 389         }
 390     }
 391
 392     static $deleteOnExit = false;
 393     /**
 394      * generate a tempory file with an extension (dont forget to delete it)
 395      */
 396
 397     function tempName($ext, $deleteOnExit=false)
 398     {
 399         if ($deleteOnExit && self::$deleteOnExit === false) {
 400             register_shutdown_function(array('Pman','deleteOnExit'));
 401             self::$deleteOnExit  = array();
 402         }
 403         $x = tempnam(ini_get('session.save_path'), HTML_FlexyFramework::get()->appNameShort.'TMP');
 404         unlink($x);
 405         $ret = $x .'.'. $ext;
 406         if ($deleteOnExit) {
 407             self::$deleteOnExit[] = $ret;
 408         }
 409         return $ret;
 410
 411     }
 412
 413      static function deleteOnExit()
 414     {
 415
 416         foreach(self::$deleteOnExit as $fn) {
 417             if (file_exists($fn)) {
 418                 unlink($fn);
 419             }
 420         }
 421     }
 422
 423     /**
 424      * ------------- Authentication password reset ------ ??? MOVEME?
 425      *
 426      *
 427      */
 428
 429
 430
 431     /**
 432      * jerrAuth: standard auth failure - with data that let's the UI know..
 433      */
 434     function jerrAuth()
 435     {
 436         $au = $this->authUser();
 437         if ($au) {
 438             // is it an authfailure?
 439             $this->jerr("Permission denied to view this resource", array('authFailure' => true));
 440         }
 441         $this->jerr("Not authenticated", array('authFailure' => true));
 442     }
 443
 444
 445
 446     /**
 447      * ---------------- Standard JSON outputers. - used everywhere
 448      */
 449       /**
 450      * ---------------- Standard JSON outputers. - used everywhere
 451      * JSON error - simple error with logging.
 452      * @see Pman::jerror
 453      */
 454
 455     function jerr($str, $errors=array(), $content_type = false) // standard error reporting..
 456     {
 457         return $this->jerror('ERROR', $str,$errors,$content_type);
 458     }
 459     /**
 460      * Recomended JSON error indicator
 461      *
 462      *
 463      * @param string $type  - normally 'ERROR' - you can use this to track error types.
 464      * @param string $message - error message displayed to user.
 465      * @param array $errors - optioanl data to pass to front end.
 466      * @param string $content_type - use text/plain to return plan text - ?? not sure why...
 467      *
 468      */
 469
 470     function jerror($type, $str, $errors=array(), $content_type = false) // standard error reporting..
 471     {
 472         if ($this->transObj) {
 473             $this->transObj->query('ROLLBACK');
 474         }
 475
 476         $cli = HTML_FlexyFramework::get()->cli;
 477         if ($cli) {
 478             echo "ERROR: " .$str . "\n"; // print the error first, as DB might fail..
 479         }
 480
 481         if ($type !== false) {
 482
 483             if(!empty($errors)){
 484                 DB_DataObject::factory('Events')->writeEventLogExtra($errors);
 485             }
 486
 487             $this->addEvent($type, false, $str);
 488
 489         }
 490
 491         $cli = HTML_FlexyFramework::get()->cli;
 492         if ($cli) {
 493             exit(1); // cli --- exit code to stop shell execution if necessary.
 494         }
 495
 496
 497         if ($content_type == 'text/plain') {
 498             header('Content-Disposition: attachment; filename="error.txt"');
 499             header('Content-type: '. $content_type);
 500             echo "ERROR: " .$str . "\n";
 501             exit;
 502         }
 503
 504      // log all errors!!!
 505
 506         $retHTML = isset($_SERVER['CONTENT_TYPE']) &&
 507                 preg_match('#multipart/form-data#i', $_SERVER['CONTENT_TYPE']);
 508
 509         if ($retHTML){
 510             if (isset($_REQUEST['returnHTML']) && $_REQUEST['returnHTML'] == 'NO') {
 511                 $retHTML = false;
 512             }
 513         } else {
 514             $retHTML = isset($_REQUEST['returnHTML']) && $_REQUEST['returnHTML'] !='NO';
 515         }
 516
 517
 518         if ($retHTML) {
 519             header('Content-type: text/html');
 520             echo "<HTML><HEAD></HEAD><BODY>";
 521             echo  $this->jsencode(array(
 522                     'success'=> false,
 523                     'errorMsg' => $str,
 524                     'message' => $str, // compate with exeption / loadexception.
 525
 526                     'errors' => $errors ? $errors : true, // used by forms to flag errors.
 527                     'authFailure' => !empty($errors['authFailure']),
 528                 ), false);
 529             echo "</BODY></HTML>";
 530             exit;
 531         }
 532
 533         if (isset($_REQUEST['_debug'])) {
 534             echo '<PRE>'.htmlspecialchars(print_r(array(
 535                 'success'=> false,
 536                 'data'=> array(),
 537                 'errorMsg' => $str,
 538                 'message' => $str, // compate with exeption / loadexception.
 539                 'errors' => $errors ? $errors : true, // used by forms to flag errors.
 540                 'authFailure' => !empty($errors['authFailure']),
 541             ),true));
 542             exit;
 543
 544         }
 545
 546         echo $this->jsencode(array(
 547             'success'=> false,
 548             'data'=> array(),
 549             'errorMsg' => $str,
 550             'message' => $str, // compate with exeption / loadexception.
 551             'errors' => $errors ? $errors : true, // used by forms to flag errors.
 552             'authFailure' => !empty($errors['authFailure']),
 553         ),true);
 554
 555
 556         exit;
 557
 558     }
 559     function jok($str)
 560     {
 561         if ($this->transObj ) {
 562             $this->transObj->query( connection_aborted() ? 'ROLLBACK' :  'COMMIT');
 563         }
 564
 565         $cli = HTML_FlexyFramework::get()->cli;
 566         if ($cli) {
 567             echo "OK: " .$str . "\n";
 568             exit;
 569         }
 570
 571         $retHTML = isset($_SERVER['CONTENT_TYPE']) &&
 572                 preg_match('#multipart/form-data#i', $_SERVER['CONTENT_TYPE']);
 573
 574         if ($retHTML){
 575             if (isset($_REQUEST['returnHTML']) && $_REQUEST['returnHTML'] == 'NO') {
 576                 $retHTML = false;
 577             }
 578         } else {
 579             $retHTML = isset($_REQUEST['returnHTML']) && $_REQUEST['returnHTML'] !='NO';
 580         }
 581
 582         if ($retHTML) {
 583             header('Content-type: text/html');
 584             echo "<HTML><HEAD></HEAD><BODY>";
 585             // encode html characters so they can be read..
 586             echo  str_replace(array('<','>'), array('\u003c','\u003e'),
 587                         $this->jsencode(array('success'=> true, 'data' => $str), false));
 588             echo "</BODY></HTML>";
 589             exit;
 590         }
 591
 592
 593         echo  $this->jsencode(array('success'=> true, 'data' => $str),true);
 594
 595         exit;
 596
 597     }
 598     /**
 599      * output data for grids or tree
 600      * @ar {Array} ar Array of data
 601      * @total {Number|false} total number of records (or false to return count(ar)
 602      * @extra {Array} extra key value list of data to pass as extra data.
 603      *
 604      */
 605     function jdata($ar,$total=false, $extra=array(), $cachekey = false)
 606     {
 607         // should do mobile checking???
 608         if ($total == false) {
 609             $total = count($ar);
 610         }
 611         $extra=  $extra ? $extra : array();
 612
 613
 614         $retHTML = isset($_SERVER['CONTENT_TYPE']) &&
 615                 preg_match('#multipart/form-data#i', $_SERVER['CONTENT_TYPE']);
 616
 617         if ($retHTML){
 618             if (isset($_REQUEST['returnHTML']) && $_REQUEST['returnHTML'] == 'NO') {
 619                 $retHTML = false;
 620             }
 621         } else {
 622             $retHTML = isset($_REQUEST['returnHTML']) && $_REQUEST['returnHTML'] !='NO';
 623         }
 624
 625         if ($retHTML) {
 626
 627             header('Content-type: text/html');
 628             echo "<HTML><HEAD></HEAD><BODY>";
 629             // encode html characters so they can be read..
 630             echo  str_replace(array('<','>'), array('\u003c','\u003e'),
 631                         $this->jsencode(array('success' =>  true, 'total'=> $total, 'data' => $ar) + $extra, false));
 632             echo "</BODY></HTML>";
 633             exit;
 634         }
 635
 636
 637         // see if trimming will help...
 638         if (!empty($_REQUEST['_pman_short'])) {
 639             $nar = array();
 640
 641             foreach($ar as $as) {
 642                 $add = array();
 643                 foreach($as as $k=>$v) {
 644                     if (is_string($v) && !strlen(trim($v))) {
 645                         continue;
 646                     }
 647                     $add[$k] = $v;
 648                 }
 649                 $nar[] = $add;
 650             }
 651             $ar = $nar;
 652
 653         }
 654
 655
 656         $ret =  $this->jsencode(array('success' =>  true, 'total'=> $total, 'data' => $ar) + $extra,true);
 657
 658         if (!empty($cachekey)) {
 659
 660             $fn = ini_get('session.save_path') . '/json-cache'.date('/Y/m/d').'.'. $cachekey . '.cache.json';
 661             if (!file_exists(dirname($fn))) {
 662                 mkdir(dirname($fn), 0777,true);
 663             }
 664             file_put_contents($fn, $ret);
 665         }
 666
 667         echo $ret;
 668         exit;
 669     }
 670
 671
 672
 673     /** a daily cache **/
 674     function jdataCache($cachekey)
 675     {
 676         $fn = ini_get('session.save_path') . '/json-cache'.date('/Y/m/d').'.'. $cachekey . '.cache.json';
 677         if (file_exists($fn)) {
 678             header('Content-type: application/json');
 679             echo file_get_contents($fn);
 680             exit;
 681         }
 682         return false;
 683
 684     }
 685
 686
 687
 688     /**
 689      * ---------------- OUTPUT
 690      */
 691     function hasBg($fn) // used on front page to check if logos exist..
 692     {
 693         return file_exists($this->rootDir.'/Pman/'.$this->appNameShort.'/templates/images/'.  $fn);
 694     }
 695      /**
 696      * outputJavascriptIncludes:
 697      *
 698      * output <script....> for all the modules in the applcaiton
 699      *
 700      */
 701     function outputJavascriptIncludes()
 702     {
 703         // BC support - currently 1 project still relies on this.. (MO portal)
 704         $o = HTML_FlexyFramework::get()->Pman_Core;
 705         if (isset($o['packseed'])) {
 706             return $this->outputJavascriptIncludesBC();
 707         }
 708
 709
 710         $mods = $this->modulesList();
 711
 712         $is_bootstrap = in_array('BAdmin', $mods);
 713
 714         foreach($mods as $mod) {
 715             // add the css file..
 716
 717             if ($is_bootstrap) {
 718                 if (!file_exists($this->rootDir."/Pman/$mod/is_bootstrap")) {
 719                     echo '<!-- missing '. $this->rootDir."/Pman/$mod/is_bootstrap  - skipping -->";
 720                     continue;
 721                 }
 722
 723             }
 724
 725             $this->outputJavascriptDir("Pman/$mod/widgets", "*.js");
 726             $this->outputJavascriptDir("Pman/$mod", "*.js");
 727
 728         }
 729
 730         if (empty($this->disable_jstemplate)) {
 731         // and finally the JsTemplate...
 732             echo '<script type="text/javascript" src="'. $this->baseURL. '/Core/JsTemplate"></script>'."\n";
 733         }
 734
 735         $this->callModules('outputJavascriptIncludes', $this);
 736
 737     }
 738     var $css_includes = array();
 739      /**
 740      * outputCSSIncludes:
 741      *
 742      * output <link rel=stylesheet......> for all the modules in the applcaiton
 743      *
 744      *
 745      * This could css minify as well.
 746      */
 747     function outputCSSIncludes() // includes on CSS links.
 748     {
 749
 750
 751         $mods = $this->modulesList();
 752
 753         $this->callModules('applyCSSIncludes', $this);
 754         foreach($this->css_includes as $module => $ar) {
 755             if ($ar) {
 756                 $this->assetArrayToHtml( $ar , 'css');
 757             }
 758         }
 759
 760         // old style... - probably remove this...
 761         $this->callModules('outputCSSIncludes', $this);
 762
 763         foreach($mods as $mod) {
 764             // add the css file..
 765             $this->outputCSSDir("Pman/$mod","*.css");
 766         }
 767
 768
 769     }
 770
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783
 784
 785
 786
 787     // --- OLD CODE - in for BC on MO project.... - needs removing...
 788
 789     // used on old versions.....
 790     function outputJavascriptIncludesBC()
 791     {
 792
 793         $mods = $this->modulesList();
 794
 795         foreach($mods as $mod) {
 796             // add the css file..
 797
 798
 799             $files = $this->moduleJavascriptList($mod.'/widgets');
 800             foreach($files as $f) {
 801                 echo '<script type="text/javascript" src="'. $f. '"></script>'."\n";
 802             }
 803
 804             $files = $this->moduleJavascriptList($mod);
 805             foreach($files as $f) {
 806                 echo '<script type="text/javascript" src="'. $f. '"></script>'."\n";
 807             }
 808
 809         }
 810         if (empty($this->disable_jstemplate)) {
 811         // and finally the JsTemplate...
 812             echo '<script type="text/javascript" src="'. $this->baseURL. '/Core/JsTemplate"></script>'."\n";
 813         }
 814
 815     }
 816     /**
 817      * Gather infor for javascript files..
 818      *
 819      * @param {String} $mod the module to get info about.
 820      * @return {StdClass}  details about module.
 821      */
 822     function moduleJavascriptFilesInfo($mod)
 823     {
 824
 825         static $cache = array();
 826
 827         if (isset($cache[$mod])) {
 828             return $cache[$mod];
 829         }
 830
 831
 832         $ff = HTML_FlexyFramework::get();
 833
 834         $base = dirname($_SERVER['SCRIPT_FILENAME']);
 835         $dir =   $this->rootDir.'/Pman/'. $mod;
 836         $path = $this->rootURL ."/Pman/$mod/";
 837
 838         $ar = glob($dir . '/*.js');
 839
 840         $files = array();
 841         $arfiles = array();
 842         $maxtime = 0;
 843         $mtime = 0;
 844         foreach($ar as $fn) {
 845             $f = basename($fn);
 846             // got the 'module file..'
 847             $mtime = filemtime($dir . '/'. $f);
 848             $maxtime = max($mtime, $maxtime);
 849             $arfiles[$fn] = $mtime;
 850             $files[] = $path . $f . '?ts='.$mtime;
 851         }
 852
 853         ksort($arfiles); // just sort by name so it's consistant for serialize..
 854
 855         $compile  = empty($ff->Pman['public_cache_dir']) ? 0 : 1;
 856         $basedir = $compile ? $ff->Pman['public_cache_dir'] : false;
 857         $baseurl = $compile ? $ff->Pman['public_cache_url'] : false;
 858
 859
 860
 861
 862         $lsort = create_function('$a,$b','return strlen($a) > strlen($b) ? 1 : -1;');
 863         usort($files, $lsort);
 864
 865         $smod = str_replace('/','.',$mod);
 866
 867         $output = date('Y-m-d-H-i-s-', $maxtime). $smod .'-'.md5(serialize($arfiles)) .'.js';
 868
 869
 870         // why are translations done like this - we just build them on the fly frmo the database..
 871         $tmtime = file_exists($this->rootDir.'/_translations_/'. $smod.'.js')
 872             ? filemtime($this->rootDir.'/_translations_/'. $smod.'.js') : 0;
 873
 874         $cache[$mod]  = (object) array(
 875             'smod' =>               $smod, // module name without '/'
 876             'files' =>              $files, // list of all files.
 877             'filesmtime' =>         $arfiles,  // map of mtime=>file
 878             'maxtime' =>            $maxtime, // max mtime
 879             'compile' =>            $this->isDev ? false : $compile,
 880             'translation_file' =>   $base .'/_translations_/' . $smod .  '.js',
 881             'translation_mtime' =>  $tmtime,
 882             'output' =>             $output,
 883             'translation_data' =>   preg_replace('/\.js$/', '.__translation__.js', $output),
 884             'translation_base' =>   $dir .'/', //prefix of filename (without moudle name))
 885             'basedir' =>            $basedir,
 886             'baseurl' =>            $baseurl,
 887             'module_dir' =>         $dir,
 888         );
 889         return $cache[$mod];
 890     }
 891
 892
 893     /**
 894      *  moduleJavascriptList: list the javascript files in a module
 895      *
 896      *  The original version of this.. still needs more thought...
 897      *
 898      *  Compiled is in Pman/_compiled_/{$mod}/{LATEST...}.js
 899      *  Translations are in Pman/_translations_/{$mod}.js
 900      *
 901      *  if that stuff does not exist just list files in  Pman/{$mod}/*.js
 902      *
 903      *  Compiled could be done on the fly..
 904      *
 905      *
 906      *
 907      *  @param {String} $mod  the module to look at - eg. Pman/{$mod}/*.js
 908      *  @return {Array} list of include paths (either compiled or raw)
 909      *
 910      */
 911
 912
 913
 914     function moduleJavascriptList($mod)
 915     {
 916
 917
 918         $dir =   $this->rootDir.'/Pman/'. $mod;
 919
 920
 921         if (!file_exists($dir)) {
 922             echo '<!-- missing directory '. htmlspecialchars($dir) .' -->';
 923             return array();
 924         }
 925
 926         $info = $this->moduleJavascriptFilesInfo($mod);
 927
 928
 929
 930         if (empty($info->files)) {
 931             return array();
 932         }
 933         // finally sort the files, so they are in the right order..
 934
 935         // only compile this stuff if public_cache is set..
 936
 937
 938         // suggestions...
 939         //  public_cache_dir =   /var/www/myproject_cache
 940         //  public_cache_url =   /myproject_cache    (with Alias apache /myproject_cache/ /var/www/myproject_cache/)
 941
 942         // bit of debugging
 943         if (!$info->compile) {
 944             echo "<!-- Javascript compile turned off (isDev on, or public_cache_dir not set) -->\n";
 945             return $info->files;
 946         }
 947
 948         // where are we going to write all of this..
 949         // This has to be done via a
 950         if (!file_exists($info->basedir.'/'.$info->output) || !filesize($info->basedir.'/'.$info->output)) {
 951             require_once 'Pman/Core/JsCompile.php';
 952             $x = new Pman_Core_JsCompile();
 953
 954             $x->pack($info->filesmtime,$info->basedir.'/'.$info->output, $info->translation_base);
 955         } else {
 956             echo "<!-- file exists not exist: {$info->basedir}/{$info->output} -->\n";
 957         }
 958
 959         if (file_exists($info->basedir.'/'.$info->output) &&
 960                 filesize($info->basedir.'/'.$info->output)) {
 961
 962             $ret =array(
 963                 $info->baseurl.'/'. $info->output,
 964
 965             );
 966             // output all the ava
 967             // fixme  - this needs the max datetime for the translation file..
 968             $ret[] = $this->baseURL."/Admin/InterfaceTranslations/".$mod.".js"; //?ts=".$info->translation_mtime;
 969
 970             //if ($info->translation_mtime) {
 971             //    $ret[] = $this->rootURL."/_translations_/". $info->smod.".js?ts=".$info->translation_mtime;
 972             //}
 973             return $ret;
 974         }
 975
 976
 977
 978         // give up and output original files...
 979
 980
 981         return $info->files;
 982
 983
 984     }
 985
 986     /**
 987      * Error handling...
 988      *  PEAR::setErrorHandling(PEAR_ERROR_CALLBACK, array($this, 'onPearError'));
 989      */
 990     function initErrorHandling()
 991     {
 992         if (!class_exists('HTML_FlexyFramework2')) {
 993             // what about older code that still users PEAR?
 994             PEAR::setErrorHandling(PEAR_ERROR_CALLBACK, array($this, 'onPearError'));
 995         }
 996         set_exception_handler(array($this,'onException'));
 997
 998     }
 999
1000
1001     static $permitError = false; // static why?
1002
1003     var $showErrorToUser = true;
1004
1005     function onPearError($err)
1006     {
1007         return $this->onException($err);
1008
1009     }
1010
1011
1012     function onException($ex)
1013     {
1014          static $reported = false;
1015         if ($reported) {
1016             return;
1017         }
1018
1019         if (Pman::$permitError) {
1020             return;
1021         }
1022
1023
1024         $reported = true;
1025
1026         $out = is_a($ex,'Exception') || is_a($ex, 'Error') ? $ex->getMessage() : $ex->toString();
1027
1028
1029         //print_R($bt); exit;
1030         $ret = array();
1031         $n = 0;
1032         $bt = is_a($ex,'Exception')|| is_a($ex, 'Error')  ? $ex->getTrace() : $ex->backtrace;
1033         if (is_a($ex,'Exception')|| is_a($ex, 'Error') ) {
1034             $ret[] = $ex->getFile() . '('. $ex->getLine() . ')';
1035         }
1036         foreach( $bt as $b) {
1037             $ret[] = @$b['file'] . '(' . @$b['line'] . ')@' .   @$b['class'] . '::' . @$b['function'];
1038             if ($n > 20) {
1039                 break;
1040             }
1041             $n++;
1042         }
1043         //convert the huge backtrace into something that is readable..
1044         $out .= "\n" . implode("\n",  $ret);
1045
1046         $this->addEvent("EXCEPTION", false, $out);
1047
1048         if ($this->showErrorToUser) {
1049             print_R($out);exit;
1050         }
1051         // not sure why this is here... - perhaps doing a jerr() was actually caught by the UI, and hidden from the user..?
1052         $this->jerror(false,"An error Occured, please contact the website owner");
1053
1054         //$this->jerr($out);
1055
1056
1057     }
1058
1059
1060     /**
1061      * ---------------- Logging ---------------
1062      */
1063
1064     /**
1065      * addEventOnce:
1066      * Log an action (only if it has not been logged already.
1067      *
1068      * @param {String} action  - group/name of event
1069      * @param {DataObject|false} obj - dataobject action occured on.
1070      * @param {String} any remarks
1071      * @return {false|DB_DataObject} Event object.,
1072      */
1073
1074     function addEventOnce($act, $obj = false, $remarks = '')
1075     {
1076         if (!empty(HTML_FlexyFramework::get()->Pman['disable_events'])) {
1077             return;
1078         }
1079         $e = DB_DataObject::factory('Events');
1080         $e->init($act,$obj,$remarks);
1081         if ($e->find(true)) {
1082             return false;
1083         }
1084         return $this->addEvent($act, $obj, $remarks);
1085     }
1086     /**
1087      * addEvent:
1088      * Log an action.
1089      *
1090      * @param {String} action  - group/name of event
1091      * @param {DataObject|false} obj - dataobject action occured on.
1092      * @param {String} any remarks
1093      * @return {DB_DataObject} Event object.,
1094      */
1095
1096     function addEvent($act, $obj = false, $remarks = '')
1097     {
1098
1099         if (!empty(HTML_FlexyFramework::get()->Pman['disable_events'])) {
1100             return;
1101         }
1102         $au = $this->getAuthUser();
1103
1104         $e = DB_DataObject::factory('Events');
1105         $e->init($act,$obj,$remarks);
1106
1107         $e->event_when = $e->sqlValue('NOW()');
1108
1109         $eid = $e->insert();
1110
1111         // fixme - this should be in onInsert..
1112         $wa = DB_DataObject::factory('core_watch');
1113         if (method_exists($wa,'notifyEvent')) {
1114             $wa->notifyEvent($e); // trigger any actions..
1115         }
1116
1117
1118         $e->onInsert(isset($_REQUEST) ? $_REQUEST : array() , $this);
1119
1120
1121         return $e;
1122
1123     }
1124
1125     function addEventNotifyOnly($act, $obj = false, $remarks = '')
1126     {
1127          $au = $this->getAuthUser();
1128
1129         $e = DB_DataObject::factory('Events');
1130         $e->init($act,$obj,$remarks);
1131
1132         $e->event_when = $e->sqlValue('NOW()');
1133         $wa = DB_DataObject::factory('core_watch');
1134         if (method_exists($wa,'notifyEvent')) {
1135             $wa->notifyEvent($e); // trigger any actions..
1136         }
1137     }
1138
1139
1140     // ------------------ DEPERCIATED ----------------------------
1141
1142     // DEPRECITAED - use moduleslist
1143     function modules()  { return $this->modulesList();  }
1144
1145     // DEPRECIATED.. - use getAuthUser...
1146     function staticGetAuthUser()  { $x = new Pman(); return $x->getAuthUser();  }
1147
1148
1149     // DEPRICATED  USE Pman_Core_Mailer
1150
1151     function emailTemplate($templateFile, $args)
1152     {
1153
1154         require_once 'Pman/Core/Mailer.php';
1155         $r = new Pman_Core_Mailer(array(
1156             'template'=>$templateFile,
1157             'contents' => $args,
1158             'page' => $this
1159         ));
1160         return $r->toData();
1161
1162     }
1163     // DEPRICATED - USE Pman_Core_Mailer
1164     // WHAT Part about DEPRICATED Does no one understand??
1165     function sendTemplate($templateFile, $args)
1166     {
1167         require_once 'Pman/Core/Mailer.php';
1168         $r = new Pman_Core_Mailer(array(
1169             'template'=>$templateFile,
1170             'contents' => array(),
1171             'page' => $this
1172         ));
1173         return $r->send();
1174
1175
1176     }
1177 }