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