git.roojs.org Git - Pman.Base/blob - Pman.php

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