DataObjects/Person.php
[Pman.Core] / DataObjects / Person.php
1 <?php
2 /**
3  * Table Definition for Person
4  */
5 require_once 'DB/DataObject.php';
6
7 class Pman_Core_DataObjects_Person extends DB_DataObject 
8 {
9     ###START_AUTOCODE
10     /* the code below is auto generated do not remove the above tag */
11
12     public $__table = 'Person';                          // table name
13     public $id;                              // int(11)  not_null primary_key auto_increment
14     public $office_id;                       // int(11)  
15     public $name;                            // string(128)  not_null
16     public $phone;                           // string(32)  not_null
17     public $fax;                             // string(32)  not_null
18     public $email;                           // string(128)  not_null
19     public $company_id;                      // int(11)  
20     public $role;                            // string(32)  not_null
21     public $active;                          // int(11)  not_null
22     public $remarks;                         // blob(65535)  not_null blob
23     public $passwd;                          // string(64)  not_null
24     public $owner_id;                        // int(11)  not_null
25     public $lang;                            // string(8)  
26     public $no_reset_sent;                   // int(11)  
27     public $action_type;                     // string(32)  
28     public $project_id;                      // int(11)  
29     public $deleted_by;                      // int(11)  not_null
30     public $deleted_dt;                      // datetime(19)  binary
31
32     
33     /* the code above is auto generated do not remove the tag below */
34     ###END_AUTOCODE
35     /**
36      *
37      * @param {String} $templateFile  (mail/XXXXXXX.txt) exclude the mail and .txt bit.
38      * @param {Array|Object} $args   data to send out..
39      * @return {Array|PEAR_Error} array of $recipents, $header, $body 
40      */
41     function buildMail($templateFile, $args)
42     {
43           
44         $args = (array) $args;
45         $content  = clone($this);
46         
47         foreach((array)$args as $k=>$v) {
48             $content->$k = $v;
49         }
50         
51         $ff = HTML_FlexyFramework::get();
52         
53         
54         //?? is this really the place for this???
55         if (
56                 !$ff->cli && 
57                 empty($args['no_auth']) &&
58                 !in_array($templateFile, array(
59                     // templates that can be sent without authentication.
60                      'password_reset' ,
61                      'password_welcome'
62                  ))
63             ) {
64             
65             $content->authUser = $this->getAuthUser();
66             if (!$content->authUser) {
67                 return PEAR::raiseError("Not authenticated");
68             }
69         }
70         
71         // should handle x-forwarded...
72         
73         $content->HTTP_HOST = isset($_SERVER["HTTP_HOST"]) ?
74             $_SERVER["HTTP_HOST"] :
75             (isset($ff->HTTP_HOST) ? $ff->HTTP_HOST : 'localhost');
76             
77         /* use the regex compiler, as it doesnt parse <tags */
78         require_once 'HTML/Template/Flexy.php';
79         $template = new HTML_Template_Flexy( array(
80             'compiler'    => 'Flexy',
81             'nonHTML' => true,
82             'filters' => array('SimpleTags','Mail'),
83             //     'debug'=>1,
84         ));
85         
86      
87          
88         
89         $template->compile("mail/$templateFile.txt");
90         
91         /* use variables from this object to ouput data. */
92         $mailtext = $template->bufferedOutputObject($content);
93         //echo "<PRE>";print_R($mailtext);
94         //print_R($mailtext);exit;
95         /* With the output try and send an email, using a few tricks in Mail_MimeDecode. */
96         require_once 'Mail/mimeDecode.php';
97         require_once 'Mail.php';
98         
99         $decoder = new Mail_mimeDecode($mailtext);
100         $parts = $decoder->getSendArray();
101         if (PEAR::isError($parts)) {
102             return $parts;
103             //echo "PROBLEM: {$parts->message}";
104             //exit;
105         } 
106         list($recipents,$headers,$body) = $parts;
107         $recipents = array($this->email);
108         if (!empty($content->bcc) && is_array($content->bcc)) {
109             $recipents =array_merge($recipents, $content->bcc);
110         }
111         $headers['Date'] = date('r');
112         
113         return array(
114             'recipents' => $recipents,
115             'headers'    => $headers,
116             'body'      => $body
117         );
118         
119         
120     }
121     
122     
123     /**
124      * send a template
125      * - user must be authenticate or args[no_auth] = true
126      *   or template = password_[reset|welcome]
127      * 
128      */
129     function sendTemplate($templateFile, $args)
130     {
131         
132         $ar = $this->buildMail($templateFile, $args);
133          
134         //print_r($recipents);exit;
135         $mailOptions = PEAR::getStaticProperty('Mail','options');
136         $mail = Mail::factory("SMTP",$mailOptions);
137         
138         if (PEAR::isError($mail)) {
139             return $mail;
140         } 
141         $oe = error_reporting(E_ALL ^ E_NOTICE);
142         $ret = $mail->send($ar['recipents'],$ar['headers'],$ar['body']);
143         error_reporting($oe);
144        
145         return $ret;
146     
147     }
148     function getEmailFrom()
149     {
150         return '"' . addslashes($this->name) . '" <' . $this->email . '>';
151     }
152     function toEventString() 
153     {
154         return empty($this->name) ? $this->email : $this->name;
155     } 
156     function verifyAuth()
157     { 
158         $ff= HTML_FlexyFramework::get();
159         if (!empty($ff->Pman['auth_comptype']) && $ff->Pman['auth_comptype'] != $this->company()->comptype) {
160             $ff->page->jerr("Login not permited to outside companies");
161         }
162         return true;
163         
164     }    
165    
166    
167     //   ---------------- authentication / passwords and keys stuff  ----------------
168     function isAuth()
169     {
170         $db = $this->getDatabaseConnection();
171         $sesPrefix = $db->dsn['database'];
172         @session_start();
173         if (!empty($_SESSION[__CLASS__][$sesPrefix .'-auth'])) {
174             // in session...
175             $a = unserialize($_SESSION[__CLASS__][$sesPrefix .'-auth']);
176             $u = DB_DataObject::factory('Person');
177             if ($u->get($a->id)) { //&& strlen($u->passwd)) {
178                 $u->verifyAuth();
179                 
180                 return true;
181             }
182             
183             $_SESSION[__CLASS__][$sesPrefix .'-auth'] = '';
184             
185         }
186         // local auth - 
187         $u = DB_DataObject::factory('Person');
188         $ff = HTML_FlexyFramework::get();
189         if (!empty($ff->Pman['local_autoauth']) && 
190             (!empty($_SERVER['SERVER_ADDR'])) &&
191             ($_SERVER['SERVER_ADDR'] == '127.0.0.1') &&
192             ($_SERVER['REMOTE_ADDR'] == '127.0.0.1') &&
193             $u->get('email', $ff->Pman['local_autoauth'])
194         ) {
195             $db = $this->getDatabaseConnection();
196             $sesPrefix = $db->dsn['database'];
197             $_SESSION[__CLASS__][$sesPrefix .'-auth'] = serialize($u);
198             return true;
199         }
200            
201         
202         // not in session or not matched...
203         $u = DB_DataObject::factory('Person');
204         $u->whereAdd(' LENGTH(passwd) > 0');
205         $n = $u->count();
206         $error =  PEAR::getStaticProperty('DB_DataObject','lastError');
207         if ($error) {
208             die($error->toString()); // not really a good thing to do...
209         }
210         if (!$n){ // authenticated as there are no users in the system...
211             return true;
212         }
213         
214         return false;
215         
216     }
217     function getAuthUser()
218     {
219         if (!$this->isAuth()) {
220             return false;
221         }
222         $db = $this->getDatabaseConnection();
223         $sesPrefix = $db->dsn['database'];
224         if (!empty($_SESSION[__CLASS__][$sesPrefix .'-auth'])) {
225             $a = unserialize($_SESSION[__CLASS__][$sesPrefix .'-auth']);
226             
227             $u = DB_DataObject::factory('Person');
228             if ($u->get($a->id)) { /// && strlen($u->passwd)) {
229                 return clone($u);
230             }
231              
232         }
233         
234         $u = DB_DataObject::factory('Person');
235         $u->whereAdd(' LENGTH(passwd) > 0');
236         if (!$u->count()){
237             $u = DB_DataObject::factory('Person');
238             $u->id = -1;
239             return $u;
240             
241         }
242         return false;
243     }     
244     function login()
245     {
246         $this->isAuth(); // force session start..
247         $this->verifyAuth();
248         $db = $this->getDatabaseConnection();
249         
250         
251         $g = DB_DataObject::factory('Groups');
252         $g->type = 0;
253         $g->get('name', 'Administrators');
254         $gm = DB_DataObject::Factory('Group_Members');
255         if (in_array($g->id,$gm->listGroupMembership($this))) {
256             // refresh admin groups.
257             $gr = DB_DataObject::Factory('Group_Rights');
258             $gr->applyDefs($g, 0);
259             
260         }
261             
262             
263         
264         $sesPrefix = $db->dsn['database'];
265         $_SESSION[__CLASS__][$sesPrefix .'-auth'] = serialize($this);
266         
267     }
268     function logout()
269     {
270         $this->isAuth(); // force session start..
271          $db = $this->getDatabaseConnection();
272         $sesPrefix = $db->dsn['database'];
273         $_SESSION[__CLASS__][$sesPrefix .'-auth'] = "";
274         
275     }    
276     function genPassKey ($t) 
277     {
278         return md5($this->email . $t. $this->passwd);
279     }
280     function simpleAuthKey($m = 0)
281     {
282         $month = $m > -1 ? date('Y-m') : date('Y-m', strtotime('LAST MONTH'));
283         
284         return md5(implode(',' ,  array($month, $this->email , $this->passwd, $this->id)));
285     } 
286     function checkPassword($val)
287     {
288         
289         if (substr($this->passwd,0,1) == '$') {
290             return crypt($val,$this->passwd) == $this->passwd ;
291         }
292         // old style md5 passwords...- cant be used with courier....
293         return md5($val) == $this->passwd;
294     }
295     function setPassword($value) 
296     {
297         $salt='';
298         while(strlen($salt)<9) {
299             $salt.=chr(rand(64,126));
300             //php -r var_dump(crypt('testpassword', '$1$'. (rand(64,126)). '$'));
301         }
302         $this->passwd = crypt($value, '$1$'. $salt. '$');
303        
304        
305     }      
306     
307     function company()
308     {
309         $x = DB_DataObject::factory('Companies');
310         $x->get($this->company_id);
311         return $x;
312     }
313     
314     
315     function active()
316     {
317         return $this->active;
318     }
319     function authUserName($n) // set username prior to acheck user exists query.
320     {
321         
322         $this->whereAdd('LENGTH(passwd) > 1'); 
323         $this->email = $n;
324     }
325     function lang($val)
326     {
327         if ($val == $this->lang) {
328             return;
329         }
330         $uu = clone($this);
331         $this->lang = $val;
332         $this->update($uu);
333
334     }
335             
336     
337     function authUserArray()
338     {
339         
340         $aur = $this->toArray();
341         
342         if ($this->id < 1) {
343             return $aur;
344         }
345         
346         
347         //DB_DataObject::debugLevel(1);
348         $c = DB_Dataobject::factory('Companies');
349         $im = DB_Dataobject::factory('Images');
350         $c->joinAdd($im, 'LEFT');
351         $c->selectAdd();
352         $c->selectAs($c, 'company_id_%s');
353         $c->selectAs($im, 'company_id_logo_id_%s');
354         $c->id = $this->company_id;
355         $c->limit(1);
356         $c->find(true);
357         
358         $aur = array_merge( $c->toArray(),$aur);
359         
360         if (empty($c->company_id_logo_id_id))  {
361                  
362             $im = DB_Dataobject::factory('Images');
363             $im->ontable = 'Companies';
364             $im->onid = $c->id;
365             $im->imgtype = 'LOGO';
366             $im->limit(1);
367             $im->selectAdd();
368             $im->selectAs($im,  'company_id_logo_id_%s');
369             if ($im->find(true)) {
370                     
371                 foreach($im->toArray() as $k=>$v) {
372                     $aur[$k] = $v;
373                 }
374             }
375         }
376       
377         // perms + groups.
378         $aur['perms']  = $this->getPerms();
379         $g = DB_DataObject::Factory('Group_Members');
380         $aur['groups']  = $g->listGroupMembership($this, 'name');
381         
382         $aur['passwd'] = '';
383         $aur['dailykey'] = '';
384         
385         
386         
387         return $aur;
388     }
389     
390     //   ----------PERMS------  ----------------
391     function getPerms() 
392     {
393          //DB_DataObject::debugLevel(1);
394         // find out all the groups they are a member of.. + Default..
395         
396         // ------ INIITIALIZE IF NO GROUPS ARE SET UP.
397         
398         $g = DB_DataObject::Factory('Group_Rights');
399         if (!$g->count()) {
400             $g->genDefault();
401         }
402         
403         if ($this->id < 0) {
404             return $g->adminRights(); // system is not set up - so they get full rights.
405         }
406         DB_DataObject::debugLevel(1);
407         $g = DB_DataObject::Factory('Group_Members');
408         $g->whereAdd('group_id is NOT NULL AND user_id IS NOT NULL');
409         if (!$g->count()) {
410             // add the current user to the admin group..
411             $g = DB_DataObject::Factory('Groups');
412             if ($g->get('name', 'Administrators')) {
413                 $gm = DB_DataObject::Factory('Group_Members');
414                 $gm->group_id = $g->id;
415                 $gm->user_id = $this->id;
416                 $gm->insert();
417             }
418             
419         }
420         
421         // ------ STANDARD PERMISSION HANDLING.
422         
423         $g = DB_DataObject::Factory('Group_Members');
424         $grps = $g->listGroupMembership($this);
425        //var_dump($grps);
426         $isAdmin = $g->inAdmin;
427         //echo '<PRE>'; print_r($grps);var_dump($isAdmin);
428         // the load all the perms for those groups, and add them all together..
429         // then load all those 
430         $g = DB_DataObject::Factory('Group_Rights');
431         $ret =  $g->listPermsFromGroupIds($grps, $isAdmin);
432         //echo '<PRE>';print_r($ret);
433         return $ret;
434          
435         
436     }
437     /**
438      *Basic group fetching - probably needs to filter by type eventually.
439      *
440      */
441     
442     function groups()
443     {
444         $g = DB_DataObject::Factory('Group_Members');
445         $grps = $g->listGroupMembership($this);
446         $g = DB_DataObject::Factory('Groups');
447         $g->whereAddIn('id', $grps, 'int');
448         return $g->fetchAll();
449         
450     }
451     
452     function hasPerm($name, $lvl) 
453     {
454         static $pcache = array();
455         
456         if (!isset($pcache[$this->id])) {
457             $pcache[$this->id] = $this->getPerms();
458         }
459        // echo "<PRE>";print_r($pcache[$au->id]);
460        // var_dump($pcache[$au->id]);
461         if (empty($pcache[$this->id][$name])) {
462             return false;
463         }
464         
465         return strpos($pcache[$this->id][$name], $lvl) > -1;
466         
467     }    
468     
469     //  ------------ROO HOOKS------------------------------------
470     function applyFilters($q, $au)
471     {
472         if (!empty($q['query']['person_not_internal'])) {
473             $this->whereAdd(" join_company_id_id.isOwner = 0 ");
474         }
475         if (!empty($q['query']['person_internal_only_all'])) {
476             
477             
478             // must be internal and not current user (need for distribution list)
479             // user has a projectdirectory entry and role is not blank.
480             //DB_DataObject::DebugLevel(1);
481             $pd = DB_DataObject::factory('ProjectDirectory');
482             $pd->whereAdd("role != ''");
483             $pd->selectAdd();
484             $pd->selectAdd('distinct(person_id) as person_id');
485             $roled = $pd->fetchAll('person_id');
486             $rs = $roled  ? "  OR
487                     {$this->tableName()}.id IN (".implode(',', $roled) . ") 
488                     " : '';
489             $this->whereAdd(" join_company_id_id.comptype = 'OWNER' $rs ");
490             
491         }
492         // -- for distribution
493         if (!empty($q['query']['person_internal_only'])) {
494             // must be internal and not current user (need for distribution list)
495             $this->whereAdd(" join_company_id_id.comptype = 'OWNER'");
496             
497             //$this->whereAdd(($this->tableName() == 'Person' ? 'Person' : "join_person_id_id") .
498             //    ".id  != ".$au->id);
499             $this->whereAdd("Person.id != {$au->id}");
500         } 
501         
502         if (!empty($q['query']['comptype_or_company_id'])) {
503            // DB_DataObject::debugLevel(1);
504             $bits = explode(',', $q['query']['comptype_or_company_id']);
505             $id = (int) array_pop($bits);
506             $ct = $this->escape($bits[0]);
507             
508             $this->whereAdd(" join_company_id_id.comptype = '$ct' OR Person.company_id = $id");
509             
510         }
511         
512         
513         // staff list..
514         if (!empty($q['query']['person_inactive'])) {
515            // DB_Dataobject::debugLevel(1);
516             $this->active = 1;
517         }
518         
519         ///---------------- Group views --------
520         if (!empty($q['query']['in_group'])) {
521             // DB_DataObject::debugLevel(1);
522             $ing = (int) $q['query']['in_group'];
523             if ($q['query']['in_group'] == -1) {
524                 // list all staff who are not in a group.
525                 $this->whereAdd("Person.id NOT IN (
526                     SELECT distinct(user_id) FROM Group_Members LEFT JOIN
527                         Groups ON Groups.id = Group_Members.group_id
528                         WHERE Groups.type = ".$q['query']['type']."
529                     )");
530                 
531                 
532             } else {
533                 
534                 $this->whereAdd("Person.id IN (
535                     SELECT distinct(user_id) FROM Group_Members 
536                         WHERE group_id = $ing
537                     )");
538                }
539             
540         }
541         
542         if (!empty($q['query']['not_in_directory'])) { 
543             // it's a Person list..
544             // DB_DATaobjecT::debugLevel(1);
545             
546             // specific to project directory which is single comp. login
547             //
548             $owncomp = DB_DataObject::Factory('Companies');
549             $owncomp->get('comptype', 'OWNER');
550             if ($q['company_id'] == $owncomp->id) {
551                 $this->active =1;
552             }
553             
554             
555             if ( $q['query']['not_in_directory'] > -1) {
556                 // can list current - so that it does not break!!!
557                 $x->whereAdd('Person.id NOT IN 
558                     ( SELECT distinct person_id FROM ProjectDirectory WHERE
559                         project_id = ' . $q['query']['not_in_directory'] . ' AND 
560                         company_id = ' . $this->company_id . ')');
561             }
562         }
563         
564         
565         if (!empty($q['query']['project_member_of'])) {
566                // this is also a flag to return if they are a member..
567             //DB_DataObject::debugLevel(1);
568             $do = DB_DataObject::factory('ProjectDirectory');
569             $do->project_id = $q['query']['project_member_of'];
570             
571             $this->joinAdd($do,array('joinType' => 'LEFT', 'useWhereAsOn' => true));
572             $this->selectAdd('IF(ProjectDirectory.id IS NULL, 0,  ProjectDirectory.id )  as is_member');
573                 
574                 
575             if (!empty($q['query']['project_member_filter'])) {
576                 $this->having('is_member !=0');
577             
578             }
579             
580         }
581         
582         
583         if (!empty($q['query']['search'])) {
584             $s = $this->escape($q['query']['search']);
585                     $this->whereAdd("
586                         Person.name LIKE '%$s%'  OR
587                         Person.email LIKE '%$s%'  OR
588                         Person.role LIKE '%$s%'  OR
589                         Person.remarks LIKE '%$s%' 
590                         
591                     ");
592         }
593         
594         //
595     }
596     function setFromRoo($ar, $roo)
597     {
598         $this->setFrom($ar);
599         if (!empty($ar['passwd1'])) {
600             $this->setPassword($ar['passwd1']);
601         }
602         
603         
604         if (    $this->id &&
605                 ($this->email == $roo->old->email)&&
606                 ($this->company_id == $roo->old->company_id)
607             ) {
608             return true;
609         }
610         if (empty($this->email)) {
611             return true;
612         }
613         $xx = DB_Dataobject::factory('Person');
614         $xx->setFrom(array(
615             'email' => $this->email,
616            // 'company_id' => $x->company_id
617         ));
618         
619         if ($xx->count()) {
620             return "Duplicate Email found";
621         }
622         return true;
623     }
624     /**
625      *
626      * before Delete - delete significant dependancies..
627      * this is called after checkPerm..
628      */
629     
630     function beforeDelete()
631     {
632         
633         $e = DB_DataObject::Factory('Events');
634         $e->whereAdd('person_id = ' . $this->id);
635         $e->delete(true);
636         
637         // anything else?  
638         
639     }
640     
641     
642     /***
643      * Check if the a user has access to modify this item.
644      * @param String $lvl Level (eg. Core.Projects)
645      * @param Pman_Core_DataObjects_Person $au The authenticated user.
646      * @param boolean $changes alllow changes???
647      *
648      * @return false if no access..
649      */
650     function checkPerm($lvl, $au, $changes=false) //heck who is trying to access this. false == access denied..
651     {
652          
653        // do we have an empty system..
654         if ($au && $au->id == -1) {
655             return true;
656         }
657         
658         // determine if it's staff!!!
659          
660         if ($au->company()->comptype != 'OWNER') {
661             
662             // - can not change company!!!
663             if ($changes && 
664                 isset($changes['company_id']) && 
665                 $changes['company_id'] != $au->company_id) {
666                 return false;
667             }
668             // can only set new emails..
669             if ($changes && 
670                     !empty($this->email) && 
671                     isset($changes['email']) && 
672                     $changes['email'] != $this->email) {
673                 return false;
674             }
675             
676             // edit self... - what about other staff members...
677             
678             return $this->company_id == $au->company_id;
679         }
680          
681          
682         // yes, only owner company can mess with this...
683         $owncomp = DB_DataObject::Factory('Companies');
684         $owncomp->get('comptype', 'OWNER');
685         
686         $isStaff = ($this->company_id ==  $owncomp->id);
687         
688     
689         switch ($lvl) {
690             // extra case change passwod?
691             case 'P': //??? password
692                 // standard perms -- for editing + if the user is dowing them selves..
693                 $ret = $isStaff ? $au->hasPerm("Core.Person", "E") : $au->hasPerm("Core.Staff", "E");
694                 return $ret || $au->id == $this->id;
695             
696             case 'S': // list..
697                 return $au->hasPerm("Core.Person", "S");
698             
699             case 'E': // edit
700                 return $isStaff ? $au->hasPerm("Core.Person", "E") : $au->hasPerm("Core.Staff", "E");
701             
702             case 'A': // add
703                 return $isStaff ? $au->hasPerm("Core.Person", "A") : $au->hasPerm("Core.Staff", "A");
704             
705             case 'D': // add
706                 return $isStaff ? $au->hasPerm("Core.Person", "D") : $au->hasPerm("Core.Staff", "D");
707         
708         }
709         return false;
710     }
711     function onInsert($req, $roo)  
712     {
713         
714         if ($roo->authUser->id < 0) {
715             $g = DB_DataObject::factory('Groups');
716             $g->type = 0;
717             $g->get('name', 'Administrators');
718             
719             $p = DB_DataObject::factory('Group_Members');
720             $p->group_id = $g->id;
721             $p->user_id = $this->id;     
722             if (!$p->count()) {
723                 $p->insert();
724                 $roo->addEvent("ADD", $p, $g->toEventString(). " Added " . $this->toEventString());
725             }
726             $this->login();
727         }
728         if (!empty($req['project_id_addto'])) {
729             $pd = DB_DataObject::factory('ProjectDirectory');
730             $pd->project_id = $req['project_id_addto'];
731             $pd->person_id = $this->id; 
732             $pd->ispm =0;
733             $pd->office_id = $this->office_id;
734             $pd->company_id = $this->company_id;
735             $pd->insert();
736         }
737         
738     }
739  }