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