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

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