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