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