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