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