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