DataObjects/Events.php
[Pman.Core] / DataObjects / Events.php
1 <?php
2 /**
3  * Table Definition for Events
4  *
5  * objects can implement relatedWhere(), which should return
6  *    'tablename' => array of ids
7  *
8  * 
9  */
10 class_exists('DB_DataObject') ? '' : require_once 'DB/DataObject.php';
11
12 class Pman_Core_DataObjects_Events extends DB_DataObject 
13 {
14     ###START_AUTOCODE
15     /* the code below is auto generated do not remove the above tag */
16
17     public $__table = 'Events';                          // table name
18     public $id;                              // int(11)  not_null primary_key auto_increment
19     public $person_name;                     // string(128)  
20     public $event_when;                      // datetime(19)  binary
21     public $action;                          // string(32)  
22     public $ipaddr;                          // string(16)  
23     public $on_id;                           // int(11)  
24     public $on_table;                        // string(64)  
25     public $person_id;                       // int(11)  
26     public $remarks;                         // blob(65535)  blob
27     public $person_table;                    // string(64)
28     public $dupe_id;                    // int(11)
29
30     /* the code above is auto generated do not remove the tag below */
31     ###END_AUTOCODE
32     
33     
34     
35     
36     //  ------------ROO HOOKS------------------------------------
37     function applyFilters($q, $au ,$roo)
38     {
39         $tn = $this->tableName();
40         // if not empty on_table
41         
42         if(!empty($q['person_table'])){
43             $jt = DB_DataObject::factory($q['person_table']);
44
45             
46             
47             if(!array_key_exists("{$jt->tableName()}_id", $this->tableColumns())){ // coz we have triiger on mysql...
48                 
49                 $keys = $jt->keys();
50             
51                 $this->_join = "LEFT JOIN {$jt->tableName()} AS join_person_id_id ON (join_person_id_id.{$keys[0]}=Events.person_id)";
52                 
53                 $this->selectAdd();
54                 $this->selectAs();
55
56                 $this->selectAs($jt, 'person_id_%s', 'join_person_id_id');
57
58                 if (method_exists($jt,'nameColumn')) {
59                     $this->selectAdd("join_person_id_id.{$jt->nameColumn()} as person_id_name");
60                 }
61
62                 if (method_exists($jt,'emailColumn')) {
63                     $this->selectAdd("join_person_id_id.{$jt->emailColumn()} as person_id_email");
64                 }
65                 
66             }
67         
68         } else {
69             
70             $person = $au->tableName(); //'Person';  -- projects may not use person as the auth table...
71             $cfg = HTML_FlexyFramework::get()->Pman;
72             if (!empty($cfg['authTable'])) {
73                 $person =$cfg['authTable'];
74             }
75             
76             $jt = DB_DataObject::factory($person);
77             //$this->whereAdd("
78             //        person_table  = '{$jt->tableName()}'
79             //        OR
80             //        person_table = ''
81             //        OR person_table IS NULL"
82             //); // default to  our standard.. - unless otherwise requested..
83         }
84         
85         
86         if (!empty($q['query']['from'])) {
87             $dt = date('Y-m-d' , strtotime($q['query']['from']));
88             $this->whereAdd(" {$tn}.event_when >=  '$dt' ");
89         }
90         if (!empty($q['query']['to'])) {
91             $dt = date('Y-m-d' , strtotime($q['query']['to']));
92             $this->whereAdd(" {$tn}.event_when <=  '$dt' ");
93         }
94         
95         if(!empty($q['_with_dupe_count'])){
96             $this->dupe_id = 0;                            
97             $this->selectAdd("(select count(*)+1 from Events ev_cnt where ev_cnt.dupe_id = {$tn}.id) as dupe_count");
98         }
99         /*
100         if (!empty($q['query']['grouped']) && $q['query']['grouped'] == 'gr') {
101             // grouped..
102             DB_DataObject::Debuglevel(1);
103             $this->groupBy('on_id');
104             $this->selectAdd('
105                 (SELECT count(id) FROM core_event_audit WHERE event_id = Events.id) as changed
106                 ');
107         }
108         */
109         
110         if (!$au->hasPerm("Admin.Admin_Tab", 'S')) {
111             //DB_DataObject::DebugLevel(1);
112             // they can only view their changes..
113             $this->whereAdd("($tn.person_id = {$au->id} OR $tn.person_id = 0)");
114 //            $this->person_id = $au->id;
115             
116         }
117         // _join = tablename,tablename...
118         
119         /// on_table=cohead
120         //   &_join=cohead
121         //   &_join_cols=cohead_number
122         //    &_columns=on_id_cohead_number,event_when << this is ignored at present.
123         // max(event_when) is not supported... by any query yet..
124         
125         if (isset($q['on_table']) && !strlen($q['on_table'])) {
126             // empty ontable queries.. these are valid..
127             $this->whereAdd("$tn.on_table = ''");
128         }
129       
130         if (isset($q['query']['person_sum'])) {
131             //DB_DataObject::debugLevel(1);
132             $this->_extra_cols = array('qty' );
133             $this->selectAdd("count($tn.id) as qty");
134             $this->selectAdd("count( distinct $tn.on_id) as uqty");
135             $this->whereAdd('LENGTH(join_person_id_id.name) > 0 ');
136             $this->groupBy('person_id,join_person_id_id.name,join_person_id_id.email');
137         }
138          if (isset($q['query']['table_sum'])) {
139             //DB_DataObject::debugLevel(1);
140             $this->_extra_cols = array('qty' , 'uqty');
141             $this->selectAdd("count($tn.id) as qty");
142             $this->selectAdd("count( distinct $tn.on_table, $tn.on_id) as uqty");
143             
144             $this->groupBy('on_table');
145         }
146          if (isset($q['query']['day_sum'])) {
147             //DB_DataObject::debugLevel(1);
148             $this->_extra_cols = array('qty' , 'uqty');
149             $this->selectAdd("DATE_FORMAT(event_when, '%Y-%m-%d') as on_day");
150             $this->selectAdd("count($tn.id) as qty");
151             $this->selectAdd("count( distinct $tn.on_id) as uqty");
152             
153             $this->groupBy('on_day');
154         }
155         
156         if (isset($q['_join'])) {
157             //DB_DataObject::DebugLevel(1);
158             $joins = explode(',',$q['_join']);
159             
160             $this->selectAdd(); // ???
161             $distinct = false;
162             
163             foreach($joins as $t) {
164                 $t = preg_replace('/[^a-z_]+/', '', $t); // protection.
165                 $x = DB_DataObject::Factory($t);
166                 if (!is_a($x,'DB_DataObject')) {
167                     continue;
168                 }
169                 $jtn = $x->tableName();
170                 $jk = array_shift($x->keys());
171                 $this->_join .= "
172                 
173                     LEFT JOIN {$jtn} as join_on_id_{$jtn} ON {$tn}.on_id = join_on_id_{$jtn}.{$jk}
174                         AND on_table = '{$jtn}'
175                 ";
176                 $keys = array_keys($x->tableColumns());
177                 if (isset($q['_join_cols'])) {
178                     $jcs = explode(',',$q['_join_cols'] );
179                     //DB_DataObject::DebugLevel(1);
180                     
181                     foreach($jcs as $jc) { 
182                         if (! in_array($jc, $keys)) {
183                             continue;
184                         }
185                         if ($distinct) { 
186                         
187                        
188                             $this->selectAdd( " join_on_id_{$jtn}.{$jc}   as on_id_{$jc} ");
189                         } else {
190                             $this->selectAdd( " distinct(join_on_id_{$jtn}.{$jc}  ) as on_id_{$jc} ");
191                             $distinct = true;
192                         }
193                         $this->groupBy("on_id_{$jc} ");
194                         $this->whereAdd("join_on_id_{$jtn}.{$jc} IS NOT NULL");
195                     }
196                     $this->selectAdd( "MAX(events.event_when) as event_when");
197                     $this->orderBy('event_when DESC');
198                    // $this->selectAs(array($q['_join_cols']) , 'on_id_%s', "join_on_id_{$jtn}");
199                 } else { 
200                     $this->selectAs($x, 'on_id_%s', "join_on_id_{$jtn}");
201                 }
202             }
203                  
204             
205         }
206         
207         if (isset($q['_related_on_id']) && isset($q['_related_on_table'])) {
208             // example: sales order - has invoices,
209             ///DB_DataObject::DebugLevel(1);
210             $ev  =$this->factory('Events');
211             $ev->setFrom(array(
212                 'on_id' => $q['_related_on_id'],
213                 'on_table' => $q['_related_on_table'],
214                                ));
215             $obj = $ev->object();
216             
217             if (!$obj) {
218                 $roo->jerr("ontable is invalid");
219             }
220             /*
221             if (!method_exists($obj,'relatedWhere')) {
222                 $roo->jerr( $q['_related_on_table'] . " Does not have method relatedWhere :" .
223                            implode(',', get_class_methods($obj)));
224             }
225             if ($obj && method_exists($obj,'relatedWhere')) {
226                 $ar = $obj->relatedWhere();
227                 $tn = $this->tableName();
228                 
229                 $w = array();
230                 $w[] = "( {$tn}.on_table = '" .
231                         $this->escape($q['_related_on_table']) .
232                         "' AND {$tn}.on_id = ". ((int)  $q['_related_on_id']) .
233                     ")";
234                 
235                 
236                 foreach($ar as $k=>$v) {
237                     if (empty($v)) {
238                         continue;
239                     }                
240                      $w[] = "( {$tn}.on_table = '$k' AND {$tn}.on_id IN (". implode(',', $v). "))";
241                     
242                 }
243                 $this->whereAdd(implode(' OR ' , $w));
244             }*/
245             if ($obj && method_exists($obj,'relatedEventsWhere')) {
246                 $a = $obj->relatedEventsWhere($q,$roo);
247                 if($a){
248                     $this->whereAdd($a);
249                 }
250             }
251             
252             
253             
254             
255         }
256         // since roo does not support autojoin yet..
257         if (!isset($q['_distinct'])) {
258             //$this->autoJoinExtra();
259         }
260         
261         if(!empty($q['query']['action'])) {
262             $act = $this->escape($q['query']['action']);
263             $this->whereAdd("Events.action LIKE '%{$act}%'");
264         }
265         
266         if(!empty($q['query']['on_table'])) {
267             $tnb = $this->escape($q['query']['on_table']);
268             $this->whereAdd("Events.on_table LIKE '%{$tnb}%'");
269         } 
270         
271     }
272       
273     
274     
275     /**
276      * check who is trying to access this. false == access denied..
277      * @return {boolean} true if access is allowed.
278      */
279     function checkPerm($lvl, $au) 
280     {
281         if ($lvl == 'S') {
282             return true;
283         }
284         // listing is controleed by applyfilters..
285         return $au->hasPerm("Admin.Admin_Tab", 'S');
286     }
287     /**
288      * object :
289      * return the object that this relates to.
290      * 
291      * @return {DB_DataObject} related object
292      */
293     function object()
294     {
295         $o = DB_DataObject::factory($this->on_table);
296         $o->get($this->on_id);
297         return $o;
298         
299     }
300     
301     
302     /**
303      * init:
304      * Initialize an event - ready to insert..
305      * 
306      * @param {String} action  - group/name of event
307      * @param {DataObject|false} obj - dataobject action occured on.
308      * @param {String} any remarks 
309      */
310     
311     function init($act, $obj, $remarks)
312     {
313         $ff = HTML_FlexyFramework::get();
314         $pg = $ff->page;
315         $au = $pg->getAuthUser();
316         
317         if ($ff->cli) { // && empty($au) && isset($obj->person_id)) {
318             $au = false;
319            // $au = DB_DataObject::Factory('Person'); // not always a person..
320            // $au->get($obj->person_id);
321         } 
322           
323         $this->person_name = $au && !empty($au->name) ? $au->name : '';
324         //print_r($au);
325         //exit;
326         //$this->who = $au && !empty($au->name) ? $au->name : '';
327         if (empty($au) || (isset($au->id) && empty($au->id))) {
328             // not authenticated - and a standard id based object
329             $this->person_id = 0;
330         } else {
331             $col = $au->tableName() == "Person" ? 'person_id' : $au->tableName() . '_id';
332             // does $col exist?
333             $cols = $this->tableColumns();
334             $col = isset($cols[$col]) ? $col : 'person_id'; // for BC.... - revert to using person_id
335             $this->{$col} = $au->pid();
336             //$this->person_id = $au ? (!empty($au->id) ? $au->id : $au->pid()) : -1;
337             
338             $this->who = $au->name;
339             
340             if($au->tableName() == "modx_users"){
341                 $e = PDO_DataObject::factory('ext_data');
342                $e->setFrom(array(            
343                   'userdata_id' => $au->pid(),            
344                ));
345                print_r($e);
346                exit;   
347                if($e->find(true)){
348                    $this->who = $e->getUserName();
349                }               
350             }
351         }
352         $this->person_table = $au ? $au->tableName() : '';
353         $this->ipaddr = isset($_SERVER["REMOTE_ADDR"]) ? $_SERVER["REMOTE_ADDR"] : 'cli';
354         if (!empty($_SERVER['HTTP_X_FORWARDED_FOR'])) {
355             $this->ipaddr = $_SERVER['HTTP_X_FORWARDED_FOR'];
356         }
357         
358         $this->action = $act;
359         $this->on_table = $obj ? $obj->tableName() : '';
360         $pk = $obj ? $obj->keys()  : false;
361         $this->on_id  = $obj && $pk ? $obj->{$pk[0]}: 0;
362         $rem  = array();
363         // should this really go in remarks? - 
364         if ($obj && method_exists($obj,'toEventString')) {
365             if($obj->toEventString() !== false){
366                 $rem[] = $obj->toEventString();
367             }
368         }
369         $rem[] = $remarks;
370         $this->remarks = implode(' : ', $rem);
371     }
372     
373     /**
374      * Generate an audit for this field.
375      *
376      * @param {DB_DataObject} new data
377      * @param {DB_DataObject} old data
378      * 
379      * @return {int} number of entries logged.
380      */
381     
382     function audit($new, $old = false)
383     {
384         if ($old == $new) {
385             return 0; // they are the same...
386         }
387          
388         $ret = 0;
389         foreach(array_keys($new->tableColumns()) as $k) {
390             // should we JSON serialize this?
391             $n = empty($new->$k) ? '' : $new->$k;
392             $o = empty($old->$k) || empty($old->$k) ? '' : $old->$k;
393             if ($n == $o) {
394                 continue;
395             }
396             $this->auditField($k, $o, $n, $old);
397             $ret++;
398         }
399         return $ret;
400     }
401     /**
402      * Record an audited change, in theory so we can audit data that is not just
403      * database Fields...
404      *
405      * @param {string} $name    table field anme
406      * @param {mixed} $ov  old value
407      * @param {mixed} $onv  new value
408      * @param {mixed} $old  old object (false if we are creating..)
409      */
410     function auditField($name, $ov, $nv, $old=false )
411     {
412         // hack..
413         if (is_object($nv)) {
414             return;
415         
416         }
417         
418         $x = DB_DataObject::factory('core_event_audit');
419         $x->setFrom(array(
420             'event_id' => $this->id,
421             'name' => $name,
422             'old_audit_id' => $old ? $x->findLast($this, $name) : 0,
423             'newvalue' => $nv
424
425         ));
426         $x->insert();
427     
428     }
429     
430     function beforeInsert($request,$roo)
431     {
432         if(empty($this->event_when)){
433             $this->event_when = $this->sqlValue("NOW()");
434         }
435         
436         if(empty($this->person_id)){
437             $this->person_id = $roo->authUser->id;
438             $this->person_name = $roo->authUser->name;
439             $this->person_table = $roo->authUser->tableName();
440         }
441         
442         if(empty($this->ipaddr)){
443             $this->ipaddr = isset($_SERVER["REMOTE_ADDR"]) ? $_SERVER["REMOTE_ADDR"] : 'cli';
444             if (!empty($_SERVER['HTTP_X_FORWARDED_FOR'])) {
445                 $this->ipaddr = $_SERVER['HTTP_X_FORWARDED_FOR'];
446             }
447         }
448     }
449     
450     function beforeUpdate($old, $request,$roo)
451     {
452         if(!empty($request['_restore'])){
453             $this->restore($roo);
454         }
455     }
456     
457     function onInsert($request,$roo)
458     {
459         $this->writeEventLog();
460     }
461     
462     static $deleted = array();
463     
464     
465     // log deleting of a record so that it can be written later..
466     function logDeletedRecord($obj = false)
467     {
468         if (is_array($obj)) {
469             $ret = false;
470             foreach($obj as $o) {
471                 $aret = $this->logDeletedRecord($o);
472                 $ret = $ret ? $ret : $aret;
473             }
474             return true;
475         }
476         
477         if(empty($obj) || !is_a($obj, 'DB_DataObject')){
478             return false;
479         }
480         
481         
482         $del = $obj->toArray();
483         $del['_table'] = $obj->tableName();
484         
485         self::$deleted[] = $del;
486         return true;
487     }
488     static $extra_data = false;
489     
490     static function writeEventLogExtra($data) {
491         self::$extra_data = $data;
492     }
493     
494     function logDir()
495     {
496         $ff  = HTML_FlexyFramework::get();
497         if (function_exists('posix_getpwuid')) {
498             $uinfo = posix_getpwuid( posix_getuid () ); 
499          
500             $user = $uinfo['name'];
501         } else {
502             $user = getenv('USERNAME'); // windows.
503         }
504         
505         // DEPRICATED...
506         if (!empty($ff->Pman['event_log_dir'])) {
507             return $ff->Pman['event_log_dir'] . '/'.$user;
508         }
509         if (!empty($ff->Pman['storedir'])) {
510             return $ff->Pman['storedir'] .'/Events/'.$user;
511         
512         }
513         return false;
514     }
515     
516     
517     
518     function writeEventLog($extra_data  = false)
519     {
520         $logdir = $this->logDir();
521         if (!$logdir) {
522             return false;
523         }
524         
525          
526         //print_r($this);
527         $file = $logdir.  date('/Y/m/d/'). $this->id . ".json";
528         if (!file_exists(dirname($file))) {
529             
530             @mkdir(dirname($file),0700,true); // this might fail if it does not have correct permissions..
531             if (!file_exists(dirname($file))) {
532                 die("could not create $file - permissons are not correct"); // fatal, otherwise we loop!?
533             }
534             
535         }
536         
537         // Remove all the password from logs...
538         $p =  empty($_POST) ? array() : $_POST;
539         foreach(array('passwd', 'password','passwd1',  'passwd2','password1', 'password2') as $rm) {
540             if (isset($p[$rm])) {
541                 $p[$rm] = '******';
542             }
543         }
544         
545         
546         $i=0;
547         $files = array();
548          
549         $i = 0;
550         foreach ($_FILES as $k=>$f){
551             // does not handle any other file[] arrary very well..
552             if (empty($f['tmp_name']) || !file_exists($f['tmp_name'])) {
553                 continue;
554             }
555             $i++;
556             $files[$k] = $f;
557             
558              
559             $files[$k]['tmp_name'] =  $this->id . '-'. $i;
560             $nf = $logdir .   date('/Y/m/d/').   $files[$k]['tmp_name']; 
561             if (!copy($f['tmp_name'], $nf)) {
562                 print_r("failed to copy {$f['tmp_name']}...\n");
563             }
564         }
565         $out = array(
566             'REQUEST_URI' => empty($_SERVER['REQUEST_URI']) ? 'cli' : $_SERVER['REQUEST_URI'],
567             'HTTP_USER_AGENT' => empty($_SERVER['HTTP_USER_AGENT']) ? '' : $_SERVER['HTTP_USER_AGENT'],
568             'GET' => empty($_GET) ? array() : $_GET,
569             'POST' =>$p,
570             'FILES' => $files,
571             
572         );
573         if (!empty(self::$deleted)) {
574             $out['DELETED_DATAOBJECTS'] = self::$deleted;
575         }
576         if ($extra_data !== false) {
577             $out['EXTRA'] = $extra_data;
578         }
579         if ( self::$extra_data !== false) {
580             $out['EXTRA_DATA'] =  self::$extra_data;
581         }
582         
583         file_put_contents($file, json_encode($out));
584         
585         
586     }
587     
588     function toRooArray( $q)
589     {
590         $ret = $this->toArray();
591         
592         // fill toEventString.
593         if (!empty($q['_with_obj_summary']) && !empty($this->on_id)) {
594             $obj = $this->object();
595               
596             if ($obj && $obj->pid() && method_exists($obj,'toEventString')) {
597                 $es = $obj->toEventString();
598                 
599                 if (empty($this->remarks) || strpos($this->remarks, $es) < 0) {
600                     $ret['remarks'] = $es . ' ' . $this->remarks;
601                 }
602             } else if (empty($this->remarks)){
603                 $ret['remarks'] = "DELETED";
604                 
605             }
606         }
607         //print_r($ret);
608         return $ret;
609         
610     }
611     
612     function toRooSingleArray($au, $q)
613     {
614         $ret = $this->toArray();
615         
616          
617         
618         if(empty($q['_retrieve_source'])){
619             return $ret;
620         }
621         
622         $file = $this->retrieveEventLog();
623         
624         if(!$file){
625             return "No records?!";
626         }
627         
628         $source = json_decode(file_get_contents($file));
629         
630         return $source;
631     }
632     
633     function retrieveEventLog()
634     {
635         
636         $logdir = $this->logDir();
637         if (!$logdir) {
638             return false;
639          
640         }
641         
642         $date = date('/Y/m/d/', strtotime($this->event_when));
643         
644         $file = $logdir. $date. $this->id . ".json";
645         if (!file_exists(dirname($file))) {
646             return false;
647         }
648         
649         return $file;
650     }
651     
652     function restore($roo)
653     {
654         $file = $this->retrieveEventLog();
655         
656         if(empty($file) || !file_exists($file)){
657             $roo->jerr('Could not retrieve the event log file');
658         }
659         
660         $log = json_decode(file_get_contents($file), true);
661         
662         if(empty($log['POST']) || empty($log['POST']['_delete']) || empty($log['DELETED_DATAOBJECTS'])){
663             $roo->jerr('Invalid url');
664         }
665         
666         $restored = array();
667         
668         foreach ($log['DELETED_DATAOBJECTS'] as $d){
669             if(
670                     empty($d['id']) || 
671                     empty($d['_table']) || 
672                     (
673                             !empty($restored[$d['_table']]) && 
674                             in_array($d['id'], $restored[$d['_table']])
675                     )
676             ){
677                 continue;
678             }
679             
680             if(!isset($restored[$d['_table']])){
681                 $restored[$d['_table']] = array();
682             }
683             
684             $restored[$d['_table']][] = $d['id'];
685             
686             $table = DB_DataObject::factory($d['_table']);
687             
688             if (!is_a($table,'DB_DataObject')) {
689                 continue;
690             }
691             
692             unset($d['_table']);
693             
694             $table->setFrom($d);
695             
696             /*
697              * need to use the old id
698              */
699             $table->id = $d['id'];
700             
701             $table->sequenceKey(false,false);
702             
703             $table->insert();
704             
705             if($table->tableName() == 'crm_mailing_list_member'){
706                 $ml = DB_DataObject::factory('crm_mailing_list');
707                 if(!$ml->get($table->mailing_list_id)){
708                     continue;
709                 }
710
711                 $mlm = DB_DataObject::factory('crm_mailing_list_member');
712                 $mlm->setFrom(array(
713                     'mailing_list_id' => $table->mailing_list_id,
714                     'is_active' => 1
715                 ));
716
717                 $o = clone($ml);
718                 $ml->no_members = $mlm->count();
719                 $ml->update($o);
720             }
721         }
722         
723         $roo->jok('RESTORE');
724     }
725     function selectAddPersonEmail()
726     {
727         $this->selectAdd('join_person_id_id.email as email');
728         
729     }
730 }