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