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

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