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