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
 355
 356
 357
 358
 359
 360     /**
 361      * ---------------- Global Tools ---------------
 362      */
 363     function checkFileUploadError()  // check for file upload errors.
 364     {
 365         if (
 366             empty($_FILES['File'])
 367             || empty($_FILES['File']['name'])
 368             || empty($_FILES['File']['tmp_name'])
 369             || empty($_FILES['File']['type'])
 370             || !empty($_FILES['File']['error'])
 371             || empty($_FILES['File']['size'])
 372         ) {
 373             $this->jerr("File upload error: <PRE>" . print_r($_FILES,true) . print_r($_POST,true) . "</PRE>");
 374         }
 375     }
 376
 377
 378     /**
 379      * generate a tempory file with an extension (dont forget to delete it)
 380      */
 381
 382     function tempName($ext)
 383     {
 384         $x = tempnam(ini_get('session.save_path'), HTML_FlexyFramework::get()->appNameShort.'TMP');
 385         unlink($x);
 386         return $x .'.'. $ext;
 387     }
 388
 389
 390     /**
 391      * ------------- Authentication password reset ------ ??? MOVEME?
 392      *
 393      *
 394      */
 395
 396
 397
 398     /**
 399      * jerrAuth: standard auth failure - with data that let's the UI know..
 400      */
 401     function jerrAuth()
 402     {
 403         $au = $this->authUser();
 404         if ($au) {
 405             // is it an authfailure?
 406             $this->jerr("Permission denied to view this resource", array('authFailure' => true));
 407         }
 408         $this->jerr("Not authenticated", array('authFailure' => true));
 409     }
 410
 411
 412
 413     /**
 414      * ---------------- Standard JSON outputers. - used everywhere
 415      */
 416       /**
 417      * ---------------- Standard JSON outputers. - used everywhere
 418      * JSON error - simple error with logging.
 419      * @see Pman::jerror
 420      */
 421
 422     function jerr($str, $errors=array(), $content_type = false) // standard error reporting..
 423     {
 424         return $this->jerror('ERROR', $str,$errors,$content_type);
 425     }
 426     /**
 427      * Recomended JSON error indicator
 428      *
 429      *
 430      * @param string $type  - normally 'ERROR' - you can use this to track error types.
 431      * @param string $message - error message displayed to user.
 432      * @param array $errors - optioanl data to pass to front end.
 433      * @param string $content_type - use text/plain to return plan text - ?? not sure why...
 434      *
 435      */
 436
 437     function jerror($type, $str, $errors=array(), $content_type = false) // standard error reporting..
 438     {
 439         if ($this->transObj) {
 440             $this->transObj->query('ROLLBACK');
 441         }
 442
 443         $cli = HTML_FlexyFramework::get()->cli;
 444         if ($cli) {
 445             echo "ERROR: " .$str . "\n"; // print the error first, as DB might fail..
 446         }
 447
 448         if ($type !== false) {
 449
 450             if(!empty($errors)){
 451                 DB_DataObject::factory('Events')->writeEventLogExtra($errors);
 452             }
 453
 454             $this->addEvent($type, false, $str);
 455
 456         }
 457
 458         $cli = HTML_FlexyFramework::get()->cli;
 459         if ($cli) {
 460             exit(1); // cli --- exit code to stop shell execution if necessary.
 461         }
 462
 463
 464         if ($content_type == 'text/plain') {
 465             header('Content-Disposition: attachment; filename="error.txt"');
 466             header('Content-type: '. $content_type);
 467             echo "ERROR: " .$str . "\n";
 468             exit;
 469         }
 470
 471
 472
 473         require_once 'Services/JSON.php';
 474         $json = new Services_JSON();
 475
 476         // log all errors!!!
 477
 478         $retHTML = isset($_SERVER['CONTENT_TYPE']) &&
 479                 preg_match('#multipart/form-data#i', $_SERVER['CONTENT_TYPE']);
 480
 481         if ($retHTML){
 482             if (isset($_REQUEST['returnHTML']) && $_REQUEST['returnHTML'] == 'NO') {
 483                 $retHTML = false;
 484             }
 485         } else {
 486             $retHTML = isset($_REQUEST['returnHTML']) && $_REQUEST['returnHTML'] !='NO';
 487         }
 488
 489
 490         if ($retHTML) {
 491             header('Content-type: text/html');
 492             echo "<HTML><HEAD></HEAD><BODY>";
 493             echo  $json->encodeUnsafe(array(
 494                     'success'=> false,
 495                     'errorMsg' => $str,
 496                     'message' => $str, // compate with exeption / loadexception.
 497
 498                     'errors' => $errors ? $errors : true, // used by forms to flag errors.
 499                     'authFailure' => !empty($errors['authFailure']),
 500                 ));
 501             echo "</BODY></HTML>";
 502             exit;
 503         }
 504
 505         if (isset($_REQUEST['_debug'])) {
 506             echo '<PRE>'.htmlspecialchars(print_r(array(
 507                 'success'=> false,
 508                 'data'=> array(),
 509                 'errorMsg' => $str,
 510                 'message' => $str, // compate with exeption / loadexception.
 511                 'errors' => $errors ? $errors : true, // used by forms to flag errors.
 512                 'authFailure' => !empty($errors['authFailure']),
 513             ),true));
 514             exit;
 515
 516         }
 517
 518         echo $json->encode(array(
 519             'success'=> false,
 520             'data'=> array(),
 521             'errorMsg' => $str,
 522             'message' => $str, // compate with exeption / loadexception.
 523             'errors' => $errors ? $errors : true, // used by forms to flag errors.
 524             'authFailure' => !empty($errors['authFailure']),
 525         ));
 526
 527
 528         exit;
 529
 530     }
 531     function jok($str)
 532     {
 533         if ($this->transObj ) {
 534             $this->transObj->query( connection_aborted() ? 'ROLLBACK' :  'COMMIT');
 535         }
 536
 537         $cli = HTML_FlexyFramework::get()->cli;
 538         if ($cli) {
 539             echo "OK: " .$str . "\n";
 540             exit;
 541         }
 542         require_once 'Services/JSON.php';
 543         $json = new Services_JSON();
 544
 545         $retHTML = isset($_SERVER['CONTENT_TYPE']) &&
 546                 preg_match('#multipart/form-data#i', $_SERVER['CONTENT_TYPE']);
 547
 548         if ($retHTML){
 549             if (isset($_REQUEST['returnHTML']) && $_REQUEST['returnHTML'] == 'NO') {
 550                 $retHTML = false;
 551             }
 552         } else {
 553             $retHTML = isset($_REQUEST['returnHTML']) && $_REQUEST['returnHTML'] !='NO';
 554         }
 555
 556         if ($retHTML) {
 557             header('Content-type: text/html');
 558             echo "<HTML><HEAD></HEAD><BODY>";
 559             // encode html characters so they can be read..
 560             echo  str_replace(array('<','>'), array('\u003c','\u003e'),
 561                         $json->encodeUnsafe(array('success'=> true, 'data' => $str)));
 562             echo "</BODY></HTML>";
 563             exit;
 564         }
 565
 566
 567         echo  $json->encode(array('success'=> true, 'data' => $str));
 568
 569         exit;
 570
 571     }
 572     /**
 573      * output data for grids or tree
 574      * @ar {Array} ar Array of data
 575      * @total {Number|false} total number of records (or false to return count(ar)
 576      * @extra {Array} extra key value list of data to pass as extra data.
 577      *
 578      */
 579     function jdata($ar,$total=false, $extra=array(), $cachekey = false)
 580     {
 581         // should do mobile checking???
 582         if ($total == false) {
 583             $total = count($ar);
 584         }
 585         $extra=  $extra ? $extra : array();
 586         require_once 'Services/JSON.php';
 587         $json = new Services_JSON();
 588
 589         $retHTML = isset($_SERVER['CONTENT_TYPE']) &&
 590                 preg_match('#multipart/form-data#i', $_SERVER['CONTENT_TYPE']);
 591
 592         if ($retHTML){
 593             if (isset($_REQUEST['returnHTML']) && $_REQUEST['returnHTML'] == 'NO') {
 594                 $retHTML = false;
 595             }
 596         } else {
 597             $retHTML = isset($_REQUEST['returnHTML']) && $_REQUEST['returnHTML'] !='NO';
 598         }
 599
 600         if ($retHTML) {
 601
 602             header('Content-type: text/html');
 603             echo "<HTML><HEAD></HEAD><BODY>";
 604             // encode html characters so they can be read..
 605             echo  str_replace(array('<','>'), array('\u003c','\u003e'),
 606                         $json->encodeUnsafe(array('success' =>  true, 'total'=> $total, 'data' => $ar) + $extra));
 607             echo "</BODY></HTML>";
 608             exit;
 609         }
 610
 611
 612         // see if trimming will help...
 613         if (!empty($_REQUEST['_pman_short'])) {
 614             $nar = array();
 615
 616             foreach($ar as $as) {
 617                 $add = array();
 618                 foreach($as as $k=>$v) {
 619                     if (is_string($v) && !strlen(trim($v))) {
 620                         continue;
 621                     }
 622                     $add[$k] = $v;
 623                 }
 624                 $nar[] = $add;
 625             }
 626             $ar = $nar;
 627
 628         }
 629
 630
 631         $ret =  $json->encode(array('success' =>  true, 'total'=> $total, 'data' => $ar) + $extra);
 632
 633         if (!empty($cachekey)) {
 634
 635             $fn = ini_get('session.save_path') . '/json-cache'.date('/Y/m/d').'.'. $cachekey . '.cache.json';
 636             if (!file_exists(dirname($fn))) {
 637                 mkdir(dirname($fn), 0777,true);
 638             }
 639             file_put_contents($fn, $ret);
 640         }
 641         echo $ret;
 642         exit;
 643     }
 644
 645
 646
 647     /** a daily cache **/
 648     function jdataCache($cachekey)
 649     {
 650         $fn = ini_get('session.save_path') . '/json-cache'.date('/Y/m/d').'.'. $cachekey . '.cache.json';
 651         if (file_exists($fn)) {
 652             header('Content-type: application/json');
 653             echo file_get_contents($fn);
 654             exit;
 655         }
 656         return false;
 657
 658     }
 659
 660
 661
 662     /**
 663      * ---------------- OUTPUT
 664      */
 665     function hasBg($fn) // used on front page to check if logos exist..
 666     {
 667         return file_exists($this->rootDir.'/Pman/'.$this->appNameShort.'/templates/images/'.  $fn);
 668     }
 669      /**
 670      * outputJavascriptIncludes:
 671      *
 672      * output <script....> for all the modules in the applcaiton
 673      *
 674      */
 675     function outputJavascriptIncludes()
 676     {
 677         // BC support - currently 1 project still relies on this.. (MO portal)
 678         $o = HTML_FlexyFramework::get()->Pman_Core;
 679         if (isset($o['packseed'])) {
 680             return $this->outputJavascriptIncludesBC();
 681         }
 682
 683
 684         $mods = $this->modulesList();
 685
 686         $is_bootstrap = in_array('BAdmin', $mods);
 687
 688         foreach($mods as $mod) {
 689             // add the css file..
 690
 691             if ($is_bootstrap) {
 692                 if (!file_exists($this->rootDir."/Pman/$mod/is_bootstrap")) {
 693                     echo '<!-- missing '. $this->rootDir."/Pman/$mod/is_bootstrap  - skipping -->";
 694                     continue;
 695                 }
 696
 697             }
 698
 699             $this->outputJavascriptDir("Pman/$mod/widgets", "*.js");
 700             $this->outputJavascriptDir("Pman/$mod", "*.js");
 701
 702         }
 703
 704         if (empty($this->disable_jstemplate)) {
 705         // and finally the JsTemplate...
 706             echo '<script type="text/javascript" src="'. $this->baseURL. '/Core/JsTemplate"></script>'."\n";
 707         }
 708
 709         $this->callModules('outputJavascriptIncludes', $this);
 710
 711     }
 712     var $css_includes = array();
 713      /**
 714      * outputCSSIncludes:
 715      *
 716      * output <link rel=stylesheet......> for all the modules in the applcaiton
 717      *
 718      *
 719      * This could css minify as well.
 720      */
 721     function outputCSSIncludes() // includes on CSS links.
 722     {
 723
 724
 725         $mods = $this->modulesList();
 726
 727         $this->callModules('applyCSSIncludes', $this);
 728         foreach($this->css_includes as $module => $ar) {
 729             if ($ar) {
 730                 $this->assetArrayToHtml( $ar , 'css');
 731             }
 732         }
 733
 734         // old style... - probably remove this...
 735         $this->callModules('outputCSSIncludes', $this);
 736
 737         foreach($mods as $mod) {
 738             // add the css file..
 739             $this->outputCSSDir("Pman/$mod","*.css");
 740         }
 741
 742
 743     }
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756
 757
 758
 759
 760
 761     // --- OLD CODE - in for BC on MO project.... - needs removing...
 762
 763     // used on old versions.....
 764     function outputJavascriptIncludesBC()
 765     {
 766
 767         $mods = $this->modulesList();
 768
 769         foreach($mods as $mod) {
 770             // add the css file..
 771
 772
 773             $files = $this->moduleJavascriptList($mod.'/widgets');
 774             foreach($files as $f) {
 775                 echo '<script type="text/javascript" src="'. $f. '"></script>'."\n";
 776             }
 777
 778             $files = $this->moduleJavascriptList($mod);
 779             foreach($files as $f) {
 780                 echo '<script type="text/javascript" src="'. $f. '"></script>'."\n";
 781             }
 782
 783         }
 784         if (empty($this->disable_jstemplate)) {
 785         // and finally the JsTemplate...
 786             echo '<script type="text/javascript" src="'. $this->baseURL. '/Core/JsTemplate"></script>'."\n";
 787         }
 788
 789     }
 790     /**
 791      * Gather infor for javascript files..
 792      *
 793      * @param {String} $mod the module to get info about.
 794      * @return {StdClass}  details about module.
 795      */
 796     function moduleJavascriptFilesInfo($mod)
 797     {
 798
 799         static $cache = array();
 800
 801         if (isset($cache[$mod])) {
 802             return $cache[$mod];
 803         }
 804
 805
 806         $ff = HTML_FlexyFramework::get();
 807
 808         $base = dirname($_SERVER['SCRIPT_FILENAME']);
 809         $dir =   $this->rootDir.'/Pman/'. $mod;
 810         $path = $this->rootURL ."/Pman/$mod/";
 811
 812         $ar = glob($dir . '/*.js');
 813
 814         $files = array();
 815         $arfiles = array();
 816         $maxtime = 0;
 817         $mtime = 0;
 818         foreach($ar as $fn) {
 819             $f = basename($fn);
 820             // got the 'module file..'
 821             $mtime = filemtime($dir . '/'. $f);
 822             $maxtime = max($mtime, $maxtime);
 823             $arfiles[$fn] = $mtime;
 824             $files[] = $path . $f . '?ts='.$mtime;
 825         }
 826
 827         ksort($arfiles); // just sort by name so it's consistant for serialize..
 828
 829         $compile  = empty($ff->Pman['public_cache_dir']) ? 0 : 1;
 830         $basedir = $compile ? $ff->Pman['public_cache_dir'] : false;
 831         $baseurl = $compile ? $ff->Pman['public_cache_url'] : false;
 832
 833
 834
 835
 836         $lsort = create_function('$a,$b','return strlen($a) > strlen($b) ? 1 : -1;');
 837         usort($files, $lsort);
 838
 839         $smod = str_replace('/','.',$mod);
 840
 841         $output = date('Y-m-d-H-i-s-', $maxtime). $smod .'-'.md5(serialize($arfiles)) .'.js';
 842
 843
 844         // why are translations done like this - we just build them on the fly frmo the database..
 845         $tmtime = file_exists($this->rootDir.'/_translations_/'. $smod.'.js')
 846             ? filemtime($this->rootDir.'/_translations_/'. $smod.'.js') : 0;
 847
 848         $cache[$mod]  = (object) array(
 849             'smod' =>               $smod, // module name without '/'
 850             'files' =>              $files, // list of all files.
 851             'filesmtime' =>         $arfiles,  // map of mtime=>file
 852             'maxtime' =>            $maxtime, // max mtime
 853             'compile' =>            $this->isDev ? false : $compile,
 854             'translation_file' =>   $base .'/_translations_/' . $smod .  '.js',
 855             'translation_mtime' =>  $tmtime,
 856             'output' =>             $output,
 857             'translation_data' =>   preg_replace('/\.js$/', '.__translation__.js', $output),
 858             'translation_base' =>   $dir .'/', //prefix of filename (without moudle name))
 859             'basedir' =>            $basedir,
 860             'baseurl' =>            $baseurl,
 861             'module_dir' =>         $dir,
 862         );
 863         return $cache[$mod];
 864     }
 865
 866
 867     /**
 868      *  moduleJavascriptList: list the javascript files in a module
 869      *
 870      *  The original version of this.. still needs more thought...
 871      *
 872      *  Compiled is in Pman/_compiled_/{$mod}/{LATEST...}.js
 873      *  Translations are in Pman/_translations_/{$mod}.js
 874      *
 875      *  if that stuff does not exist just list files in  Pman/{$mod}/*.js
 876      *
 877      *  Compiled could be done on the fly..
 878      *
 879      *
 880      *
 881      *  @param {String} $mod  the module to look at - eg. Pman/{$mod}/*.js
 882      *  @return {Array} list of include paths (either compiled or raw)
 883      *
 884      */
 885
 886
 887
 888     function moduleJavascriptList($mod)
 889     {
 890
 891
 892         $dir =   $this->rootDir.'/Pman/'. $mod;
 893
 894
 895         if (!file_exists($dir)) {
 896             echo '<!-- missing directory '. htmlspecialchars($dir) .' -->';
 897             return array();
 898         }
 899
 900         $info = $this->moduleJavascriptFilesInfo($mod);
 901
 902
 903
 904         if (empty($info->files)) {
 905             return array();
 906         }
 907         // finally sort the files, so they are in the right order..
 908
 909         // only compile this stuff if public_cache is set..
 910
 911
 912         // suggestions...
 913         //  public_cache_dir =   /var/www/myproject_cache
 914         //  public_cache_url =   /myproject_cache    (with Alias apache /myproject_cache/ /var/www/myproject_cache/)
 915
 916         // bit of debugging
 917         if (!$info->compile) {
 918             echo "<!-- Javascript compile turned off (isDev on, or public_cache_dir not set) -->\n";
 919             return $info->files;
 920         }
 921
 922         // where are we going to write all of this..
 923         // This has to be done via a
 924         if (!file_exists($info->basedir.'/'.$info->output) || !filesize($info->basedir.'/'.$info->output)) {
 925             require_once 'Pman/Core/JsCompile.php';
 926             $x = new Pman_Core_JsCompile();
 927
 928             $x->pack($info->filesmtime,$info->basedir.'/'.$info->output, $info->translation_base);
 929         } else {
 930             echo "<!-- file exists not exist: {$info->basedir}/{$info->output} -->\n";
 931         }
 932
 933         if (file_exists($info->basedir.'/'.$info->output) &&
 934                 filesize($info->basedir.'/'.$info->output)) {
 935
 936             $ret =array(
 937                 $info->baseurl.'/'. $info->output,
 938
 939             );
 940             // output all the ava
 941             // fixme  - this needs the max datetime for the translation file..
 942             $ret[] = $this->baseURL."/Admin/InterfaceTranslations/".$mod.".js"; //?ts=".$info->translation_mtime;
 943
 944             //if ($info->translation_mtime) {
 945             //    $ret[] = $this->rootURL."/_translations_/". $info->smod.".js?ts=".$info->translation_mtime;
 946             //}
 947             return $ret;
 948         }
 949
 950
 951
 952         // give up and output original files...
 953
 954
 955         return $info->files;
 956
 957
 958     }
 959
 960     /**
 961      * Error handling...
 962      *  PEAR::setErrorHandling(PEAR_ERROR_CALLBACK, array($this, 'onPearError'));
 963      */
 964     function initErrorHandling()
 965     {
 966         if (!class_exists('HTML_FlexyFramework2')) {
 967             // what about older code that still users PEAR?
 968             PEAR::setErrorHandling(PEAR_ERROR_CALLBACK, array($this, 'onPearError'));
 969         }
 970         set_exception_handler(array($this,'onException'));
 971
 972     }
 973
 974
 975     static $permitError = false; // static why?
 976
 977     var $showErrorToUser = true;
 978
 979     function onPearError($err)
 980     {
 981         return $this->onException($err);
 982
 983     }
 984
 985
 986     function onException($ex)
 987     {
 988          static $reported = false;
 989         if ($reported) {
 990             return;
 991         }
 992
 993         if (Pman::$permitError) {
 994             return;
 995         }
 996
 997
 998         $reported = true;
 999
1000         $out = is_a($ex,'Exception') || is_a($ex, 'Error') ? $ex->getMessage() : $ex->toString();
1001
1002
1003         //print_R($bt); exit;
1004         $ret = array();
1005         $n = 0;
1006         $bt = is_a($ex,'Exception')|| is_a($ex, 'Error')  ? $ex->getTrace() : $ex->backtrace;
1007         if (is_a($ex,'Exception')|| is_a($ex, 'Error') ) {
1008             $ret[] = $ex->getFile() . '('. $ex->getLine() . ')';
1009         }
1010         foreach( $bt as $b) {
1011             $ret[] = @$b['file'] . '(' . @$b['line'] . ')@' .   @$b['class'] . '::' . @$b['function'];
1012             if ($n > 20) {
1013                 break;
1014             }
1015             $n++;
1016         }
1017         //convert the huge backtrace into something that is readable..
1018         $out .= "\n" . implode("\n",  $ret);
1019
1020         $this->addEvent("EXCEPTION", false, $out);
1021
1022         if ($this->showErrorToUser) {
1023             print_R($out);exit;
1024         }
1025         // not sure why this is here... - perhaps doing a jerr() was actually caught by the UI, and hidden from the user..?
1026         $this->jerror(false,"An error Occured, please contact the website owner");
1027
1028         //$this->jerr($out);
1029
1030
1031     }
1032
1033
1034     /**
1035      * ---------------- Logging ---------------
1036      */
1037
1038     /**
1039      * addEventOnce:
1040      * Log an action (only if it has not been logged already.
1041      *
1042      * @param {String} action  - group/name of event
1043      * @param {DataObject|false} obj - dataobject action occured on.
1044      * @param {String} any remarks
1045      * @return {false|DB_DataObject} Event object.,
1046      */
1047
1048     function addEventOnce($act, $obj = false, $remarks = '')
1049     {
1050         if (!empty(HTML_FlexyFramework::get()->Pman['disable_events'])) {
1051             return;
1052         }
1053         $e = DB_DataObject::factory('Events');
1054         $e->init($act,$obj,$remarks);
1055         if ($e->find(true)) {
1056             return false;
1057         }
1058         return $this->addEvent($act, $obj, $remarks);
1059     }
1060     /**
1061      * addEvent:
1062      * Log an action.
1063      *
1064      * @param {String} action  - group/name of event
1065      * @param {DataObject|false} obj - dataobject action occured on.
1066      * @param {String} any remarks
1067      * @return {DB_DataObject} Event object.,
1068      */
1069
1070     function addEvent($act, $obj = false, $remarks = '')
1071     {
1072
1073         if (!empty(HTML_FlexyFramework::get()->Pman['disable_events'])) {
1074             return;
1075         }
1076         $au = $this->getAuthUser();
1077
1078         $e = DB_DataObject::factory('Events');
1079         $e->init($act,$obj,$remarks);
1080
1081         $e->event_when = $e->sqlValue('NOW()');
1082
1083         $eid = $e->insert();
1084
1085         // fixme - this should be in onInsert..
1086         $wa = DB_DataObject::factory('core_watch');
1087         if (method_exists($wa,'notifyEvent')) {
1088             $wa->notifyEvent($e); // trigger any actions..
1089         }
1090
1091
1092         $e->onInsert(isset($_REQUEST) ? $_REQUEST : array() , $this);
1093
1094
1095         return $e;
1096
1097     }
1098
1099     function addEventNotifyOnly($act, $obj = false, $remarks = '')
1100     {
1101          $au = $this->getAuthUser();
1102
1103         $e = DB_DataObject::factory('Events');
1104         $e->init($act,$obj,$remarks);
1105
1106         $e->event_when = $e->sqlValue('NOW()');
1107         $wa = DB_DataObject::factory('core_watch');
1108         if (method_exists($wa,'notifyEvent')) {
1109             $wa->notifyEvent($e); // trigger any actions..
1110         }
1111     }
1112
1113
1114     // ------------------ DEPERCIATED ----------------------------
1115
1116     // DEPRECITAED - use moduleslist
1117     function modules()  { return $this->modulesList();  }
1118
1119     // DEPRECIATED.. - use getAuthUser...
1120     function staticGetAuthUser()  { $x = new Pman(); return $x->getAuthUser();  }
1121
1122
1123     // DEPRICATED  USE Pman_Core_Mailer
1124
1125     function emailTemplate($templateFile, $args)
1126     {
1127
1128         require_once 'Pman/Core/Mailer.php';
1129         $r = new Pman_Core_Mailer(array(
1130             'template'=>$templateFile,
1131             'contents' => $args,
1132             'page' => $this
1133         ));
1134         return $r->toData();
1135
1136     }
1137     // DEPRICATED - USE Pman_Core_Mailer
1138     // WHAT Part about DEPRICATED Does no one understand??
1139     function sendTemplate($templateFile, $args)
1140     {
1141         require_once 'Pman/Core/Mailer.php';
1142         $r = new Pman_Core_Mailer(array(
1143             'template'=>$templateFile,
1144             'contents' => array(),
1145             'page' => $this
1146         ));
1147         return $r->send();
1148
1149
1150     }
1151 }