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