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