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