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?!? ;)
20 * DB_DataObject*:*toEventString (for logging - this is generically prefixed to all database operations.)
21 * - any data object where this method exists, the result will get prefixed to the log remarks
24 class Pman extends HTML_FlexyFramework_Page
28 var $appShortName= "";
29 var $appVersion = "1.8";
36 var $appDisabled = array(); // array of disabled modules..
37 // (based on config option disable)
39 var $authUser; // always contains the authenticated user..
41 var $disable_jstemplate = false; /// disable inclusion of jstemplate code..
45 * ------------- Standard getAuth/get/post methods of framework.
50 function getAuth() // everyone allowed in!!!!!
52 $this->loadOwnerCompany();
60 if (isset($this->_hasInit)) {
63 $this->_hasInit = true;
64 // move away from doing this ... you can access bootLoader.XXXXXX in the master template..
65 $boot = HTML_FlexyFramework::get();
66 // echo'<PRE>';print_R($boot);exit;
67 $this->appName= $boot->appName;
68 $this->appNameShort= $boot->appNameShort;
71 $this->appModules= $boot->enable;
73 // echo $this->arrayToJsInclude($files);
74 $this->isDev = empty($boot->Pman['isDev']) ? false : $boot->Pman['isDev'];
76 $this->appDisable = $boot->disable;
77 $this->appDisabled = explode(',', $boot->disable);
78 $this->version = $boot->version;
79 $this->uiConfig = empty($boot->Pman['uiConfig']) ? false : $boot->Pman['uiConfig'];
81 if (!empty($ff->Pman['local_autoauth']) &&
82 ($_SERVER['SERVER_ADDR'] == '127.0.0.1') &&
83 ($_SERVER['REMOTE_ADDR'] == '127.0.0.1')
88 // if a file Pman_{module}_Pman exists.. and it has an init function... - call that..
90 //var_dump($this->appModules);
96 * module init is only loaded on main page call, and includes checks for configuration settings.
98 function initModules()
100 foreach(explode(',',$this->appModules) as $m) {
101 $cls = 'Pman_'. $m . '_Pman';
103 //echo $this->rootDir . '/'.str_replace('_','/', $cls). '.php';
105 if (!file_exists($this->rootDir . '/'.str_replace('_','/', $cls). '.php')) {
108 require_once str_replace('_','/', $cls). '.php';
110 if (method_exists($c,'init')) {
122 $this->initModules();
125 //$this->allowSignup= empty($opts['allowSignup']) ? 0 : 1;
126 $bits = explode('/', $base);
128 if ($bits[0] == 'Link') {
129 $this->linkFail = $this->linkAuth(@$bits[1],@$bits[2]);
130 header('Content-type: text/html; charset=utf-8');
134 // should really be moved to Login...
136 if ($bits[0] == 'PasswordReset') {
137 $this->linkFail = $this->resetPassword(@$bits[1],@$bits[2],@$bits[3]);
138 header('Content-type: text/html; charset=utf-8');
142 $au = $this->getAuthUser();
144 $ff= HTML_FlexyFramework::get();
146 if (!empty($ff->Pman['auth_comptype']) && $au->id > 0 &&
147 ( !$au->company_id || ($ff->Pman['auth_comptype'] != $au->company()->comptype))) {
151 $this->jerr("Login not permited to outside companies - please reload");
153 $this->addEvent("RELOAD");
158 $this->addEvent("BADURL", false, $base);
159 $this->jerr("invalid url");
162 if (isset($_GET['onloadTrack'])) {
163 $this->onloadTrack = (int)$_GET['onloadTrack'];
165 // getting this to work with xhtml is a nightmare
166 // = nbsp / <img> issues screw everyting up.
167 //var_dump($this->isDev);
168 // force regeneration on load for development enviroments..
170 HTML_FlexyFramework::get()->generateDataobjectsCache($this->isDev);
172 //header('Content-type: application/xhtml+xml; charset=utf-8');
176 if ($this->company && $this->company->logo_id) {
177 $im = DB_DataObject::Factory('Images');
178 $im->get($this->company->logo_id);
179 $this->appLogo = $this->baseURL . '/Images/Thumb/300x100/'. $this->company->logo_id .'/' . $im->filename;
182 header('Content-type: text/html; charset=utf-8');
185 function post($base) {
186 return $this->get($base);
190 // --------------- AUTHENTICATION or system information
193 * finds the compay with comptype=='OWNER'
195 * @return {Pman_Core_DataObjects_Companies} the owner company
197 function loadOwnerCompany()
199 // only applies if authtable is person..
200 $ff = HTML_FlexyFramework::get();
201 if (!empty($ff->Pman['authTable']) && $ff->Pman['authTable'] != 'Person') {
205 $this->company = DB_DataObject::Factory('Companies');
206 if (!is_a($this->company, 'DB_DataObject')) { // non-core pman projects
209 $this->company->get('comptype', 'OWNER');
210 return $this->company;
216 * getAuthUser: - get the authenticated user..
218 * @return {DB_DataObject} of type Pman[authTable] if authenticated.
221 function getAuthUser()
223 if (!empty($this->authUser)) {
224 return $this->authUser;
226 $ff = HTML_FlexyFramework::get();
227 $tbl = empty($ff->Pman['authTable']) ? 'Person' : $ff->Pman['authTable'];
229 $u = DB_DataObject::factory( $tbl );
233 $this->authUser =$u->getAuthUser();
234 return $this->authUser ;
238 * wrapper arround authuser->hasPerm
239 * @see Pman_Core_DataObjects_User::hasPerm
241 * @param {String} $name The permission name (eg. Projects.List)
242 * @param {String} $lvl eg. (C)reate (E)dit (D)elete ... etc.
245 function hasPerm($name, $lvl) // do we have a permission
247 static $pcache = array();
248 $au = $this->getAuthUser();
249 return $au && $au->hasPerm($name,$lvl);
254 * modulesList: List the modules in the application
256 * @return {Array} list of modules
258 function modulesList()
260 $boot = HTML_FlexyFramework::get();
261 // echo'<PRE>';print_R($boot);exit;
264 $mods = explode(',', $boot->enable);
265 if (in_array('Core',$mods)) { // core has to be the first modules loaded as it contains Pman.js
266 array_unshift($mods, 'Core');
269 if (in_array($boot->appNameShort,$mods)) { // Project has to be the last modules loaded as it contains Pman.js
270 unset($mods[array_search($boot->appNameShort, $mods)]);
271 $mods[] = $boot->appNameShort;
274 $mods = array_unique($mods);
276 $disabled = explode(',', $boot->disable ? $boot->disable : '');
278 foreach($mods as $mod) {
279 // add the css file..
280 if (in_array($mod, $disabled)) {
291 function hasModule($name)
294 if (!strpos( $name,'.') ) {
295 // use enable / disable..
296 return in_array($name, $this->modules());
299 $x = DB_DataObject::factory('Group_Rights');
300 $ar = $x->defaultPermData();
301 if (empty($ar[$name]) || empty($ar[$name][0])) {
316 * ---------------- Global Tools ---------------
318 function checkFileUploadError() // check for file upload errors.
321 empty($_FILES['File'])
322 || empty($_FILES['File']['name'])
323 || empty($_FILES['File']['tmp_name'])
324 || empty($_FILES['File']['type'])
325 || !empty($_FILES['File']['error'])
326 || empty($_FILES['File']['size'])
328 $this->jerr("File upload error: <PRE>" . print_r($_FILES,true) . print_r($_POST,true) . "</PRE>");
334 * generate a tempory file with an extension (dont forget to delete it)
337 function tempName($ext)
339 $x = tempnam(ini_get('session.save_path'), HTML_FlexyFramework::get()->appNameShort.'TMP');
341 return $x .'.'. $ext;
344 * ------------- Authentication testing ------ ??? MOVEME?
348 function linkAuth($trid, $trkey)
350 $tr = DB_DataObject::factory('Documents_Tracking');
351 if (!$tr->get($trid)) {
352 return "Invalid URL";
354 if (strtolower($tr->authkey) != strtolower($trkey)) {
355 $this->AddEvent("ERROR-L", false, "Invalid Key");
356 return "Invalid KEY";
359 $this->onloadTrack = (int) $tr->doc_id;
360 if (strtotime($tr->date_sent) < strtotime("NOW - 14 DAYS")) {
361 $this->AddEvent("ERROR-L", false, "Key Expired");
362 return "Key Expired";
364 // user logged in and not
365 $au = $this->getAuthUser();
366 if ($au && $au->id && $au->id != $tr->person_id) {
369 return "Logged Out existing Session\n - reload to log in with correct key";
371 if ($au) { // logged in anyway..
372 $this->AddEvent("LOGIN", false, "With Key (ALREADY)");
373 header('Location: ' . $this->baseURL.'?onloadTrack='.$this->onloadTrack);
378 // authenticate the user...
380 $u = DB_DataObject::factory('Person');
382 $u->get($tr->person_id);
384 $this->AddEvent("LOGIN", false, "With Key");
386 // we need to redirect out - otherwise refererer url will include key!
387 header('Location: ' . $this->baseURL.'?onloadTrack='.$this->onloadTrack);
399 * ------------- Authentication password reset ------ ??? MOVEME?
405 function resetPassword($id,$t, $key)
408 $au = $this->getAuthUser();
410 return "Already Logged in - no need to use Password Reset";
413 $u = DB_DataObject::factory('Person');
414 //$u->company_id = $this->company->id;
416 if (!$u->get($id) || !strlen($u->passwd)) {
421 if ($key != $u->genPassKey($t)) {
422 return "invalid key";
425 $u->no_reset_sent = 0;
428 if ($t < strtotime("NOW - 1 DAY")) {
431 $this->showNewPass = implode("/", array($id,$t,$key));
436 * jerrAuth: standard auth failure - with data that let's the UI know..
440 $au = $this->authUser();
442 // is it an authfailure?
443 $this->jerr("Permission denied to view this resource", array('authFailure' => true));
445 $this->jerr("Not authenticated", array('authFailure' => true));
451 * ---------------- Standard JSON outputers. - used everywhere
452 * JSON error - simple error with logging.
456 function jerr($str, $errors=array(), $content_type = false) // standard error reporting..
458 return $this->jerror('ERROR', $str,$errors,$content_type);
461 * Recomended JSON error indicator
464 * @param string $type - normally 'ERROR' - you can use this to track error types.
465 * @param string $message - error message displayed to user.
466 * @param array $errors - optioanl data to pass to front end.
467 * @param string $content_type - use text/plain to return plan text - ?? not sure why...
471 function jerror($type, $str, $errors=array(), $content_type = false) // standard error reporting..
473 if ($type !== false) {
474 $this->addEvent($type, false, $str);
477 $cli = HTML_FlexyFramework::get()->cli;
479 echo "ERROR: " .$str . "\n";
484 if ($content_type == 'text/plain') {
485 header('Content-Disposition: attachment; filename="error.txt"');
486 header('Content-type: '. $content_type);
487 echo "ERROR: " .$str . "\n";
493 require_once 'Services/JSON.php';
494 $json = new Services_JSON();
499 if (!empty($_REQUEST['returnHTML']) ||
500 (isset($_SERVER['CONTENT_TYPE']) && preg_match('#multipart/form-data#i', $_SERVER['CONTENT_TYPE']))
502 header('Content-type: text/html');
503 echo "<HTML><HEAD></HEAD><BODY>";
504 echo $json->encodeUnsafe(array(
507 'message' => $str, // compate with exeption / loadexception.
509 'errors' => $errors ? $errors : true, // used by forms to flag errors.
510 'authFailure' => !empty($errors['authFailure']),
512 echo "</BODY></HTML>";
516 if (isset($_REQUEST['_debug'])) {
517 echo '<PRE>'.htmlspecialchars(print_r(array(
521 'message' => $str, // compate with exeption / loadexception.
522 'errors' => $errors ? $errors : true, // used by forms to flag errors.
523 'authFailure' => !empty($errors['authFailure']),
529 echo $json->encode(array(
533 'message' => $str, // compate with exeption / loadexception.
534 'errors' => $errors ? $errors : true, // used by forms to flag errors.
535 'authFailure' => !empty($errors['authFailure']),
544 $cli = HTML_FlexyFramework::get()->cli;
546 echo "OK: " .$str . "\n";
549 require_once 'Services/JSON.php';
550 $json = new Services_JSON();
552 if (!empty($_REQUEST['returnHTML']) ||
553 (isset($_SERVER['CONTENT_TYPE']) && preg_match('#multipart/form-data#i', $_SERVER['CONTENT_TYPE']))
556 header('Content-type: text/html');
557 echo "<HTML><HEAD></HEAD><BODY>";
558 // encode html characters so they can be read..
559 echo str_replace(array('<','>'), array('\u003c','\u003e'),
560 $json->encodeUnsafe(array('success'=> true, 'data' => $str)));
561 echo "</BODY></HTML>";
566 echo $json->encode(array('success'=> true, 'data' => $str));
572 * output data for grids or tree
573 * @ar {Array} ar Array of data
574 * @total {Number|false} total number of records (or false to return count(ar)
575 * @extra {Array} extra key value list of data to pass as extra data.
578 function jdata($ar,$total=false, $extra=array(), $cachekey = false)
580 // should do mobile checking???
581 if ($total == false) {
584 $extra= $extra ? $extra : array();
585 require_once 'Services/JSON.php';
586 $json = new Services_JSON();
587 if (isset($_SERVER['CONTENT_TYPE']) && preg_match('#multipart/form-data#i', $_SERVER['CONTENT_TYPE'])) {
589 header('Content-type: text/html');
590 echo "<HTML><HEAD></HEAD><BODY>";
591 // encode html characters so they can be read..
592 echo str_replace(array('<','>'), array('\u003c','\u003e'),
593 $json->encodeUnsafe(array('success' => true, 'total'=> $total, 'data' => $ar) + $extra));
594 echo "</BODY></HTML>";
599 // see if trimming will help...
600 if (!empty($_REQUEST['_pman_short'])) {
603 foreach($ar as $as) {
605 foreach($as as $k=>$v) {
606 if (is_string($v) && !strlen(trim($v))) {
618 $ret = $json->encode(array('success' => true, 'total'=> $total, 'data' => $ar) + $extra);
620 if (!empty($cachekey)) {
622 $fn = ini_get('session.save_path') . '/json-cache'.date('/Y/m/d').'.'. $cachekey . '.cache.json';
623 if (!file_exists(dirname($fn))) {
624 mkdir(dirname($fn), 0777,true);
626 file_put_contents($fn, $ret);
634 /** a daily cache **/
635 function jdataCache($cachekey)
637 $fn = ini_get('session.save_path') . '/json-cache'.date('/Y/m/d').'.'. $cachekey . '.cache.json';
638 if (file_exists($fn)) {
639 header('Content-type: application/json');
640 echo file_get_contents($fn);
650 * ---------------- OUTPUT
652 function hasBg($fn) // used on front page to check if logos exist..
654 return file_exists($this->rootDir.'/Pman/'.$this->appNameShort.'/templates/images/'. $fn);
657 * outputJavascriptIncludes:
659 * output <script....> for all the modules in the applcaiton
662 function outputJavascriptIncludes()
665 $mods = $this->modulesList();
667 foreach($mods as $mod) {
668 // add the css file..
671 $files = $this->moduleJavascriptList($mod.'/widgets');
672 foreach($files as $f) {
673 echo '<script type="text/javascript" src="'. $f. '"></script>'."\n";
676 $files = $this->moduleJavascriptList($mod);
677 foreach($files as $f) {
678 echo '<script type="text/javascript" src="'. $f. '"></script>'."\n";
682 if (empty($this->disable_jstemplate)) {
683 // and finally the JsTemplate...
684 echo '<script type="text/javascript" src="'. $this->baseURL. '/Core/JsTemplate"></script>'."\n";
691 * output <link rel=stylesheet......> for all the modules in the applcaiton
694 * This could css minify as well.
696 function outputCSSIncludes() // includes on CSS links.
699 $mods = $this->modulesList();
702 foreach($mods as $mod) {
703 // add the css file..
704 $dir = $this->rootDir.'/Pman/'.$mod;
705 $ar = glob($dir . '/*.css');
706 foreach($ar as $fn) {
707 $css = $this->rootURL .'/Pman/'.$mod.'/'.basename($fn) . '?ts=' . filemtime($fn);
708 echo '<link rel="stylesheet" type="text/css" href="'.$css.'" />'."\n";
717 * Gather infor for javascript files..
719 * @param {String} $mod the module to get info about.
720 * @return {StdClass} details about module.
722 function moduleJavascriptFilesInfo($mod)
725 static $cache = array();
727 if (isset($cache[$mod])) {
732 $ff = HTML_FlexyFramework::get();
734 $base = dirname($_SERVER['SCRIPT_FILENAME']);
735 $dir = $this->rootDir.'/Pman/'. $mod;
736 $path = $this->rootURL ."/Pman/$mod/";
738 $ar = glob($dir . '/*.js');
744 foreach($ar as $fn) {
746 // got the 'module file..'
747 $mtime = filemtime($dir . '/'. $f);
748 $maxtime = max($mtime, $maxtime);
749 $arfiles[$fn] = $mtime;
750 $files[] = $path . $f . '?ts='.$mtime;
753 ksort($arfiles); // just sort by name so it's consistant for serialize..
755 $compile = empty($ff->Pman['public_cache_dir']) ? 0 : 1;
756 $basedir = $compile ? $ff->Pman['public_cache_dir'] : false;
757 $baseurl = $compile ? $ff->Pman['public_cache_url'] : false;
759 $lsort = create_function('$a,$b','return strlen($a) > strlen($b) ? 1 : -1;');
760 usort($files, $lsort);
762 $smod = str_replace('/','.',$mod);
764 $output = date('Y-m-d-H-i-s-', $maxtime). $smod .'-'.md5(serialize($arfiles)) .'.js';
767 // why are translations done like this - we just build them on the fly frmo the database..
768 $tmtime = file_exists($this->rootDir.'/_translations_/'. $smod.'.js')
769 ? filemtime($this->rootDir.'/_translations_/'. $smod.'.js') : 0;
771 $cache[$mod] = (object) array(
772 'smod' => $smod, // module name without '/'
773 'files' => $files, // list of all files.
774 'filesmtime' => $arfiles, // map of mtime=>file
775 'maxtime' => $maxtime, // max mtime
776 'compile' => $this->isDev ? false : $compile,
777 'translation_file' => $base .'/_translations_/' . $smod . '.js',
778 'translation_mtime' => $tmtime,
780 'translation_data' => preg_replace('/\.js$/', '.__translation__.js', $output),
781 'translation_base' => $dir .'/', //prefix of filename (without moudle name))
782 'basedir' => $basedir,
783 'baseurl' => $baseurl,
784 'module_dir' => $dir,
791 * moduleJavascriptList: list the javascript files in a module
793 * The original version of this.. still needs more thought...
795 * Compiled is in Pman/_compiled_/{$mod}/{LATEST...}.js
796 * Translations are in Pman/_translations_/{$mod}.js
798 * if that stuff does not exist just list files in Pman/{$mod}/*.js
800 * Compiled could be done on the fly..
804 * @param {String} $mod the module to look at - eg. Pman/{$mod}/*.js
805 * @return {Array} list of include paths (either compiled or raw)
811 function moduleJavascriptList($mod)
815 $dir = $this->rootDir.'/Pman/'. $mod;
818 if (!file_exists($dir)) {
819 echo '<!-- missing directory '. htmlspecialchars($dir) .' -->';
823 $info = $this->moduleJavascriptFilesInfo($mod);
827 if (empty($info->files)) {
830 // finally sort the files, so they are in the right order..
832 // only compile this stuff if public_cache is set..
836 // public_cache_dir = /var/www/myproject_cache
837 // public_cache_url = /myproject_cache (with Alias apache /myproject_cache/ /var/www/myproject_cache/)
840 if (!$info->compile) {
841 echo "<!-- Javascript compile turned off (isDev on, or public_cache_dir not set) -->\n";
845 // where are we going to write all of this..
846 // This has to be done via a
847 if (!file_exists($info->basedir.'/'.$info->output) || !filesize($info->basedir.'/'.$info->output)) {
848 require_once 'Pman/Core/JsCompile.php';
849 $x = new Pman_Core_JsCompile();
851 $x->pack($info->filesmtime,$info->basedir.'/'.$info->output, $info->translation_base);
853 echo "<!-- file exists not exist: {$info->basedir}/{$info->output} -->\n";
856 if (file_exists($info->basedir.'/'.$info->output) &&
857 filesize($info->basedir.'/'.$info->output)) {
860 $info->baseurl.'/'. $info->output,
863 // output all the ava
864 // fixme - this needs the max datetime for the translation file..
865 $ret[] = $this->baseURL."/Admin/InterfaceTranslations/".$mod.".js"; //?ts=".$info->translation_mtime;
867 //if ($info->translation_mtime) {
868 // $ret[] = $this->rootURL."/_translations_/". $info->smod.".js?ts=".$info->translation_mtime;
875 // give up and output original files...
885 * PEAR::setErrorHandling(PEAR_ERROR_CALLBACK, array($this, 'onPearError'));
888 static $permitError = false;
890 function onPearError($err)
892 static $reported = false;
897 if (Pman::$permitError) {
905 $out = $err->toString();
908 //print_R($bt); exit;
911 foreach($err->backtrace as $b) {
912 $ret[] = @$b['file'] . '(' . @$b['line'] . ')@' . @$b['class'] . '::' . @$b['function'];
918 //convert the huge backtrace into something that is readable..
919 $out .= "\n" . implode("\n", $ret);
930 * ---------------- Logging ---------------
935 * Log an action (only if it has not been logged already.
937 * @param {String} action - group/name of event
938 * @param {DataObject|false} obj - dataobject action occured on.
939 * @param {String} any remarks
940 * @return {false|DB_DataObject} Event object.,
943 function addEventOnce($act, $obj = false, $remarks = '')
945 if (!empty(HTML_FlexyFramework::get()->Pman['disable_events'])) {
948 $e = DB_DataObject::factory('Events');
949 $e->init($act,$obj,$remarks);
950 if ($e->find(true)) {
953 return $this->addEvent($act, $obj, $remarks);
959 * @param {String} action - group/name of event
960 * @param {DataObject|false} obj - dataobject action occured on.
961 * @param {String} any remarks
962 * @return {DB_DataObject} Event object.,
965 function addEvent($act, $obj = false, $remarks = '')
968 if (!empty(HTML_FlexyFramework::get()->Pman['disable_events'])) {
971 $au = $this->getAuthUser();
973 $e = DB_DataObject::factory('Events');
974 $e->init($act,$obj,$remarks);
976 $e->event_when = date('Y-m-d H:i:s');
980 // fixme - this should be in onInsert..
981 $wa = DB_DataObject::factory('core_watch');
982 if (method_exists($wa,'notifyEvent')) {
983 $wa->notifyEvent($e); // trigger any actions..
987 $e->onInsert(isset($_REQUEST) ? $_REQUEST : array() , $this);
993 // ------------------ DEPERCIATED ----------------------------
995 // DEPRECITAED - use moduleslist
996 function modules() { return $this->modulesList(); }
998 // DEPRECIATED.. - use getAuthUser...
999 function staticGetAuthUser() { $x = new Pman(); return $x->getAuthUser(); }
1002 // DEPRICATED USE Pman_Core_Mailer
1004 function emailTemplate($templateFile, $args)
1007 require_once 'Pman/Core/Mailer.php';
1008 $r = new Pman_Core_Mailer(array(
1009 'template'=>$templateFile,
1010 'contents' => $args,
1013 return $r->toData();
1016 // DEPRICATED - USE Pman_Core_Mailer
1017 // WHAT Part about DEPRICATED Does no one understand??
1018 function sendTemplate($templateFile, $args)
1020 require_once 'Pman/Core/Mailer.php';
1021 $r = new Pman_Core_Mailer(array(
1022 'template'=>$templateFile,
1023 'contents' => array(),