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