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