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