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