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