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