6 * - base application setup (variables etc to javascript)
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..)
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?!? ;)
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')
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
36 require_once 'Pman/Core/AssetTrait.php';
37 require_once 'Pman/Core/JsonOutputTrait.php';
40 class Pman extends HTML_FlexyFramework_Page
42 use Pman_Core_AssetTrait,
43 //outputJavascriptDir()
46 Pman_Core_JsonOutputTrait;
58 var $appShortName= "";
59 var $appVersion = "1.8";
66 var $appDisabled = array(); // array of disabled modules..
67 // (based on config option disable)
69 var $authUser; // always contains the authenticated user..
71 var $disable_jstemplate = false; /// disable inclusion of jstemplate code..
74 var $css_path = ''; // can inject a specific path into the base HTML page.
77 var $transObj = false; // used to rollback or commit in JOK/JERR
79 // these are used somewhere -
80 var $builderJs = false;//
81 var $serverName = false;
83 var $allowSignup = false;
90 * ------------- Standard getAuth/get/post methods of framework.
95 function getAuth() // everyone allowed in!!!!!
97 $this->loadOwnerCompany();
102 function init($base = false)
105 if (isset($this->_hasInit)) {
108 $this->_hasInit = true;
109 // move away from doing this ... you can access bootLoader.XXXXXX in the master template..
110 $boot = HTML_FlexyFramework::get();
111 // echo'<PRE>';print_R($boot);exit;
112 $this->appName = $boot->appName;
114 $this->appNameShort = $boot->appNameShort;
116 $this->appModules = $boot->enable;
118 // echo $this->arrayToJsInclude($files);
119 $this->isDev = empty($boot->Pman['isDev']) ? false : $boot->Pman['isDev'];
121 $this->css_path = empty($boot->Pman['css_path']) ? '' : $boot->Pman['css_path'];
123 $this->appDisable = $boot->disable;
124 $this->appDisabled = explode(',', $boot->disable);
125 $this->version = $boot->version;
126 $this->appVersion = $boot->version;
127 $this->uiConfig = empty($boot->Pman['uiConfig']) ? false : $boot->Pman['uiConfig'];
129 if (!empty($boot->Pman['local_autoauth']) &&
130 !empty($_SERVER['SERVER_ADDR']) &&
131 !empty($_SERVER['REMOTE_ADDR']) &&
132 ($_SERVER['SERVER_ADDR'] == '127.0.0.1') &&
133 ($_SERVER['REMOTE_ADDR'] == '127.0.0.1')
139 !empty($_REQUEST['isDev'])
143 !empty($_SERVER['SERVER_ADDR']) &&
145 (($_SERVER['SERVER_ADDR'] == '127.0.0.1') && ($_SERVER['REMOTE_ADDR'] == '127.0.0.1'))
147 (($_SERVER['SERVER_ADDR'] == '::1') && ($_SERVER['REMOTE_ADDR'] == '::1'))
149 (preg_match('/^192\.168/', $_SERVER['SERVER_ADDR']) && $_SERVER['SERVER_ADDR'] == $_SERVER['HTTP_HOST'])
153 !empty($boot->Pman['enable_isdev_url'])
157 $boot->Pman['isDev'] = true;
161 // if a file Pman_{module}_Pman exists.. and it has an init function... - call that..
163 //var_dump($this->appModules);
169 * call a method on {module}/Pman.php
170 * * initially used on the main page load to call init();
171 * * also used for ccsIncludes??
173 * // usage: $this->callModules('init', $base)
177 function callModules($fn)
179 $args = func_get_args();
181 foreach(explode(',',$this->appModules) as $m) {
182 $cls = 'Pman_'. $m . '_Pman';
183 if (!file_exists($this->rootDir . '/'.str_replace('_','/', $cls). '.php')) {
186 require_once str_replace('_','/', $cls). '.php';
188 if (method_exists($c, $fn)) {
189 call_user_func_array(array($c,$fn),$args);
195 function get($base, $opts=array())
199 $this->callModules('init', $this, $base);
202 //$this->allowSignup= empty($opts['allowSignup']) ? 0 : 1;
203 $bits = explode('/', $base);
206 // should really be moved to Login...
208 if ($bits[0] == 'PasswordReset') {
209 $this->linkFail = $this->resetPassword(@$bits[1],@$bits[2],@$bits[3]);
210 header('Content-type: text/html; charset=utf-8');
215 $au = $this->getAuthUser();
217 $ff= HTML_FlexyFramework::get();
219 if (!empty($ff->Pman['auth_comptype']) && $au->id > 0 &&
220 ( !$au->company_id || ($ff->Pman['auth_comptype'] != $au->company()->comptype))) {
224 $this->jerr("Login not permited to outside companies - please reload");
226 $this->addEvent("RELOAD");
230 if (strlen($base) && $bits[0] != 'PasswordReset') {
231 $this->jerror("NOTICE-BADURL","invalid url: $base");
234 if (isset($_GET['onloadTrack'])) {
235 $this->onloadTrack = (int)$_GET['onloadTrack'];
237 // getting this to work with xhtml is a nightmare
238 // = nbsp / <img> issues screw everyting up.
239 //var_dump($this->isDev);
240 // force regeneration on load for development enviroments..
242 HTML_FlexyFramework::get()->generateDataobjectsCache($this->isDev && !empty($_REQUEST['isDev']));
244 //header('Content-type: application/xhtml+xml; charset=utf-8');
248 if ($this->company && $this->company->logo_id) {
249 $im = DB_DataObject::Factory('Images');
250 $im->get($this->company->logo_id);
251 $this->appLogo = $this->baseURL . '/Images/Thumb/x100/'. $this->company->logo_id .'/' . $im->filename;
254 header('Content-type: text/html; charset=utf-8');
257 function post($base) {
258 return $this->get($base);
262 // --------------- AUTHENTICATION or system information
265 * finds the compay with comptype=='OWNER'
266 * ?? what about comptype_id-name ?????
268 * @return {Pman_Core_DataObjects_Companies} the owner company
270 function loadOwnerCompany()
272 // only applies if authtable is person..
273 $ff = HTML_FlexyFramework::get();
274 if (!empty($ff->Pman['authTable']) && !in_array($ff->Pman['authTable'] , [ 'core_person', 'Person' ])) {
278 $this->company = DB_DataObject::Factory('core_company');
279 if (!is_a($this->company, 'DB_DataObject')) { // non-core pman projects
282 $e = DB_DataObject::Factory('core_enum')->lookupObject('COMPTYPE', 'OWNER');
284 $this->company->get('comptype_id', $e->id);
285 return $this->company;
289 static function staticGetAuthUser($t) {
290 if (!empty($t->authUser)) {
293 $ff = HTML_FlexyFramework::get();
294 $tbl = empty($ff->Pman['authTable']) ? 'core_person' : $ff->Pman['authTable'];
296 $u = DB_DataObject::factory( $tbl );
298 if (is_a($u,'PEAR_Error') || !$u->isAuth()) {
301 $t->authUser =$u->getAuthUser();
302 return $t->authUser ;
307 * getAuthUser: - get the authenticated user..
309 * @return {DB_DataObject} of type Pman[authTable] if authenticated.
312 function getAuthUser()
314 return self::staticGetAuthUser($this);
318 * wrapper arround authuser->hasPerm
319 * @see Pman_Core_DataObject_Core_person::hasPerm
321 * @param {String} $name The permission name (eg. Projects.List)
322 * @param {String} $lvl eg. (C)reate (E)dit (D)elete ... etc.
325 function hasPerm($name, $lvl) // do we have a permission
327 static $pcache = array();
328 $au = $this->getAuthUser();
329 return $au && $au->hasPerm($name,$lvl);
333 * modulesList: List the modules in the application
335 * @return {Array} list of modules
337 function modulesList()
339 $boot = HTML_FlexyFramework::get();
340 // echo'<PRE>';print_R($boot);exit;
343 $mods = explode(',', $boot->enable);
344 if (in_array('Core',$mods)) { // core has to be the first modules loaded as it contains Pman.js
345 array_unshift($mods, 'Core');
348 if (in_array($boot->appNameShort,$mods)) { // Project has to be the last modules loaded as it contains Pman.js
349 unset($mods[array_search($boot->appNameShort, $mods)]);
350 $mods[] = $boot->appNameShort;
353 $mods = array_unique($mods);
355 $disabled = explode(',', $boot->disable ? $boot->disable : '');
357 foreach($mods as $mod) {
358 // add the css file..
359 if (in_array($mod, $disabled)) {
370 function hasModule($name)
373 if (!strpos( $name,'.') ) {
374 // use enable / disable..
375 return in_array($name, $this->modules());
378 $x = DB_DataObject::factory('core_group_right');
379 $ar = $x->defaultPermData();
380 if (empty($ar[$name]) || empty($ar[$name][0])) {
388 function jsencode($v, $header = false)
391 header("Content-type: text/javascript");
393 if (function_exists("json_encode")) {
394 $ret= json_encode($v);
395 if ($ret !== false) {
399 require_once 'Services/JSON.php';
400 $js = new Services_JSON();
401 return $js->encodeUnsafe($v);
410 * ---------------- Global Tools ---------------
412 function checkFileUploadError() // check for file upload errors.
415 empty($_FILES['File'])
416 || empty($_FILES['File']['name'])
417 || empty($_FILES['File']['tmp_name'])
418 || empty($_FILES['File']['type'])
419 || !empty($_FILES['File']['error'])
420 || empty($_FILES['File']['size'])
422 $this->jerr("File upload error: <PRE>" . print_r($_FILES,true) . print_r($_POST,true) . "</PRE>");
426 static $deleteOnExit = false;
428 * generate a tempory file with an extension (dont forget to delete it)
431 function deleteOnExitAdd($name)
433 if (self::$deleteOnExit === false) {
434 register_shutdown_function(array('Pman','deleteOnExit'));
435 self::$deleteOnExit = array();
437 self::$deleteOnExit[] = $name;
440 function tempName($ext, $deleteOnExit=false)
443 $x = tempnam(ini_get('session.save_path'), HTML_FlexyFramework::get()->appNameShort.'TMP');
445 $ret = $x .'.'. $ext;
447 $this->deleteOnExitAdd($ret);
453 static function deleteOnExit()
456 foreach(self::$deleteOnExit as $fn) {
457 if (file_exists($fn)) {
464 * ------------- Authentication password reset ------ ??? MOVEME?
477 * ---------------- OUTPUT
479 function hasBg($fn) // used on front page to check if logos exist..
481 return file_exists($this->rootDir.'/Pman/'.$this->appNameShort.'/templates/images/'. $fn);
484 * outputJavascriptIncludes:
486 * output <script....> for all the modules in the applcaiton
489 function outputJavascriptIncludes()
491 // BC support - currently 1 project still relies on this.. (MO portal)
492 $ff = HTML_FlexyFramework::get();
493 $o = isset($ff->Pman_Core) ? $ff->Pman_Core : array();
494 if (isset($o['packseed'])) {
495 return $this->outputJavascriptIncludesBC();
499 $mods = $this->modulesList();
502 $is_bootstrap = in_array('BAdmin', $mods);
504 foreach($mods as $mod) {
505 // add the css file..
508 if (!file_exists($this->rootDir."/Pman/$mod/is_bootstrap")) {
509 echo '<!-- missing '. $this->rootDir."/Pman/$mod/is_bootstrap - skipping -->";
515 $this->outputJavascriptDir("Pman/$mod/widgets", "*.js");
516 $this->outputJavascriptDir("Pman/$mod", "*.js");
520 if (empty($this->disable_jstemplate)) {
521 // and finally the JsTemplate...
522 echo '<script type="text/javascript" src="'. $this->baseURL. '/Core/JsTemplate"></script>'."\n";
525 $this->callModules('outputJavascriptIncludes', $this);
528 var $css_includes = array();
532 * output <link rel=stylesheet......> for all the modules in the applcaiton
535 * This could css minify as well.
537 function outputCSSIncludes() // includes on CSS links.
541 $mods = $this->modulesList();
542 $is_bootstrap = in_array('BAdmin', $mods);
544 $this->callModules('applyCSSIncludes', $this);
545 foreach($this->css_includes as $module => $ar) {
548 $this->assetArrayToHtml( $ar , 'css');
552 // old style... - probably remove this...
553 $this->callModules('outputCSSIncludes', $this);
555 foreach($mods as $mod) {
556 // add the css file..
557 if ($is_bootstrap && !file_exists($this->rootDir."/Pman/$mod/is_bootstrap")) {
558 echo '<!-- missing '. $this->rootDir."/Pman/$mod/is_bootstrap - skipping -->";
561 $this->outputCSSDir("Pman/$mod","*.css");
563 $this->outputSCSS($mod);
567 return ''; // needs to return something as we output it..
580 // --- OLD CODE - in for BC on MO project.... - needs removing...
582 // used on old versions.....
583 function outputJavascriptIncludesBC()
586 $mods = $this->modulesList();
588 foreach($mods as $mod) {
589 // add the css file..
592 $files = $this->moduleJavascriptList($mod.'/widgets');
593 foreach($files as $f) {
594 echo '<script type="text/javascript" src="'. $f. '"></script>'."\n";
597 $files = $this->moduleJavascriptList($mod);
598 foreach($files as $f) {
599 echo '<script type="text/javascript" src="'. $f. '"></script>'."\n";
603 if (empty($this->disable_jstemplate)) {
604 // and finally the JsTemplate...
605 echo '<script type="text/javascript" src="'. $this->baseURL. '/Core/JsTemplate"></script>'."\n";
610 * Gather infor for javascript files..
612 * @param {String} $mod the module to get info about.
613 * @return {StdClass} details about module.
615 function moduleJavascriptFilesInfo($mod)
618 static $cache = array();
620 if (isset($cache[$mod])) {
625 $ff = HTML_FlexyFramework::get();
627 $base = dirname($_SERVER['SCRIPT_FILENAME']);
628 $dir = $this->rootDir.'/Pman/'. $mod;
629 $path = $this->rootURL ."/Pman/$mod/";
631 $ar = glob($dir . '/*.js');
637 foreach($ar as $fn) {
639 // got the 'module file..'
640 $mtime = filemtime($dir . '/'. $f);
641 $maxtime = max($mtime, $maxtime);
642 $arfiles[$fn] = $mtime;
643 $files[] = $path . $f . '?ts='.$mtime;
646 ksort($arfiles); // just sort by name so it's consistant for serialize..
648 // The original idea of this was to serve the files direct from a publicly available 'cache' directory.
649 // but that doesnt really make sense - as we can just serve it from the session directory where we stick
650 // cached data anyway.
653 $compile = empty($ff->Pman['public_cache_dir']) ? 0 : 1;
654 $basedir = $compile ? $ff->Pman['public_cache_dir'] : false;
655 $baseurl = $compile ? $ff->Pman['public_cache_url'] : false;
659 $basedir = session_save_path(). '/translate-cache/';
660 if (!file_exists($basedir)) {
661 mkdir($basedir,0755);
663 $baseurl = $this->baseURL . '/Admin/Translations';
665 if (PHP_VERSION_ID < 70000 ) {
666 $lsort = create_function('$a,$b','return strlen($a) > strlen($b) ? 1 : -1;');
667 usort($files, $lsort);
669 usort($files, function($a,$b) { return strlen($a) > strlen($b) ? 1 : -1; });
672 $smod = str_replace('/','.',$mod);
674 $output = date('Y-m-d-H-i-s-', $maxtime). $smod .'-'.md5(serialize($arfiles)) .'.js';
677 // why are translations done like this - we just build them on the fly frmo the database..
678 $tmtime = file_exists($this->rootDir.'/_translations_/'. $smod.'.js')
679 ? filemtime($this->rootDir.'/_translations_/'. $smod.'.js') : 0;
681 $cache[$mod] = (object) array(
682 'smod' => $smod, // module name without '/'
683 'files' => $files, // list of all files.
684 'filesmtime' => $arfiles, // map of mtime=>file
685 'maxtime' => $maxtime, // max mtime
686 'compile' => $this->isDev ? false : $compile,
687 'translation_file' => $base .'/_translations_/' . $smod . '.js',
688 'translation_mtime' => $tmtime,
690 'translation_data' => preg_replace('/\.js$/', '.__translation__.js', $output),
691 'translation_base' => $dir .'/', //prefix of filename (without moudle name))
692 'basedir' => $basedir,
693 'baseurl' => $baseurl,
694 'module_dir' => $dir,
701 * moduleJavascriptList: list the javascript files in a module
703 * The original version of this.. still needs more thought...
705 * Compiled is in Pman/_compiled_/{$mod}/{LATEST...}.js
706 * Translations are in Pman/_translations_/{$mod}.js
708 * if that stuff does not exist just list files in Pman/{$mod}/*.js
710 * Compiled could be done on the fly..
714 * @param {String} $mod the module to look at - eg. Pman/{$mod}/*.js
715 * @return {Array} list of include paths (either compiled or raw)
721 function moduleJavascriptList($mod)
725 $dir = $this->rootDir.'/Pman/'. $mod;
728 if (!file_exists($dir)) {
729 echo '<!-- missing directory '. htmlspecialchars($dir) .' -->';
733 $info = $this->moduleJavascriptFilesInfo($mod);
737 if (empty($info->files)) {
740 // finally sort the files, so they are in the right order..
742 // only compile this stuff if public_cache is set..
746 // public_cache_dir = /var/www/myproject_cache
747 // public_cache_url = /myproject_cache (with Alias apache /myproject_cache/ /var/www/myproject_cache/)
750 if (!$info->compile) {
751 echo "<!-- Javascript compile turned off (isDev on, or public_cache_dir not set) -->\n";
755 // where are we going to write all of this..
756 // This has to be done via a
757 if (!file_exists($info->basedir.'/'.$info->output) || !filesize($info->basedir.'/'.$info->output)) {
758 require_once 'Pman/Core/JsCompile.php';
759 $x = new Pman_Core_JsCompile();
761 $x->pack($info->filesmtime,$info->basedir.'/'.$info->output, $info->translation_base);
763 echo "<!-- file exists not exist: {$info->basedir}/{$info->output} -->\n";
766 if (file_exists($info->basedir.'/'.$info->output) &&
767 filesize($info->basedir.'/'.$info->output)) {
770 $info->baseurl.'/'. $info->output,
773 // output all the ava
774 // fixme - this needs the max datetime for the translation file..
775 $ret[] = $this->baseURL."/Admin/InterfaceTranslations/".$mod.".js"; //?ts=".$info->translation_mtime;
777 //if ($info->translation_mtime) {
778 // $ret[] = $this->rootURL."/_translations_/". $info->smod.".js?ts=".$info->translation_mtime;
785 // give up and output original files...
795 * PEAR::setErrorHandling(PEAR_ERROR_CALLBACK, array($this, 'onPearError'));
797 function initErrorHandling()
799 if (!class_exists('HTML_FlexyFramework2')) {
800 // what about older code that still users PEAR?
801 PEAR::setErrorHandling(PEAR_ERROR_CALLBACK, array($this, 'onPearError'));
803 set_exception_handler(array($this,'onException'));
808 static $permitError = false; // static why?
810 var $showErrorToUser = true;
812 function onPearError($err)
814 return $this->onException($err);
819 function onException($ex)
821 static $reported = false;
826 if (Pman::$permitError) {
833 $out = (is_a($ex,'Exception') || is_a($ex, 'Error') ? $ex->getMessage() : $ex->toString()) .
834 ' ' . (empty($_SERVER['REQUEST_METHOD']) ? 'cli' : $_SERVER['REQUEST_METHOD'] ) . ' ' .
835 (empty($_SERVER['REQUEST_URI']) ? 'No URL' : $_SERVER['REQUEST_URI']) .
836 ' ' . (empty($POST) ? '' : file_get_contents('php://input')) ;
839 //print_R($bt); exit;
842 $bt = is_a($ex,'Exception')|| is_a($ex, 'Error') ? $ex->getTrace() : $ex->backtrace;
843 if (is_a($ex,'Exception')|| is_a($ex, 'Error') ) {
844 $ret[] = $ex->getFile() . '('. $ex->getLine() . ')';
846 foreach( $bt as $b) {
847 $ret[] = @$b['file'] . '(' . @$b['line'] . ')@' . @$b['class'] . '::' . @$b['function'];
853 //convert the huge backtrace into something that is readable..
854 $out .= "\n" . implode("\n", $ret);
857 $this->addEvent("EXCEPTION", false, $out);
859 if ($this->showErrorToUser) {
862 // not sure why this is here... - perhaps doing a jerr() was actually caught by the UI, and hidden from the user..?
863 $this->jerror(false,"An error Occured, please contact the website owner");
872 * ---------------- Logging ---------------
877 * Log an action (only if it has not been logged already.
879 * @param {String} action - group/name of event
880 * @param {DataObject|false} obj - dataobject action occured on.
881 * @param {String} any remarks
882 * @return {false|DB_DataObject} Event object.,
885 function addEventOnce($act, $obj = false, $remarks = '')
887 if (!empty(HTML_FlexyFramework::get()->Pman['disable_events'])) {
890 $e = DB_DataObject::factory('Events');
891 $e->init($act,$obj,$remarks);
892 if ($e->find(true)) {
895 return $this->addEvent($act, $obj, $remarks);
901 * @param {String} action - group/name of event
902 * @param {DataObject|false} obj - dataobject action occured on.
903 * @param {String} any remarks
904 * @return {DB_DataObject} Event object.,
907 function addEvent($act, $obj = false, $remarks = '')
910 $ff = HTML_FlexyFramework::get();
913 if (!empty($ff->Pman['disable_events'])
914 || !empty($ff->database_is_readonly)
915 || substr($act, 0, 7) === 'NOTICE-'
917 if (!preg_match('/^(ERROR|EXCEPTION)/', $act)) {
920 $str = $obj !== false ? "{$obj->tableName()}:{$obj->id} " : '';
921 $de = ini_set('display_errors', 0);
922 trigger_error("{$act} {$str} {$remarks}" , E_USER_NOTICE);
923 ini_set('display_errors', $de );
927 $au = $this->getAuthUser();
929 $e = DB_DataObject::factory('Events');
930 $e->init($act,$obj,$remarks);
932 $e->event_when = $e->sqlValue('NOW()');
936 // fixme - this should be in onInsert..
937 $wa = DB_DataObject::factory('core_watch');
938 if (method_exists($wa,'notifyEvent')) {
939 $wa->notifyEvent($e); // trigger any actions..
943 $e->onInsert(isset($_REQUEST) ? $_REQUEST : array() , $this);
944 if (!preg_match('/^(ERROR|EXCEPTION)/', $act)) {
947 $str = $obj !== false ? "{$obj->tableName()}:{$obj->id} " : '';
948 $de = ini_set('display_errors', 0);
949 trigger_error("{$act} [event_id={$e->id}] {$str} {$remarks}" , E_USER_NOTICE);
950 ini_set('display_errors', $de );
956 function addEventNotifyOnly($act, $obj = false, $remarks = '')
958 $au = $this->getAuthUser();
960 $e = DB_DataObject::factory('Events');
961 $e->init($act,$obj,$remarks);
963 $e->event_when = $e->sqlValue('NOW()');
964 $wa = DB_DataObject::factory('core_watch');
965 if (method_exists($wa,'notifyEvent')) {
966 $wa->notifyEvent($e); // trigger any actions..
971 // ------------------ DEPERCIATED ----------------------------
973 // DEPRECITAED - use moduleslist
974 function modules() { return $this->modulesList(); }
977 // DEPRICATED USE Pman_Core_Mailer
979 function emailTemplate($templateFile, $args)
982 require_once 'Pman/Core/Mailer.php';
983 $r = new Pman_Core_Mailer(array(
984 'template'=>$templateFile,
991 // DEPRICATED - USE Pman_Core_Mailer
992 // WHAT Part about DEPRICATED Does no one understand??
993 function sendTemplate($templateFile, $args)
995 require_once 'Pman/Core/Mailer.php';
996 $r = new Pman_Core_Mailer(array(
997 'template'=>$templateFile,
998 'contents' => array(),