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