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') && !method_exists($obj,'relatedEventsWhere')) {
222                 $roo->jerr( $q['_related_on_table'] . " Does not have method relatedWhere  or relatedEventsWhere:" .
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             
246             if ($obj && method_exists($obj,'relatedEventsWhere')) {
247                 $a = $obj->relatedEventsWhere($q,$roo);
248                 if($a){
249                     $this->whereAdd($a);
250                 }
251             }
252             
253             
254             
255             
256         }
257         if (!isset($q['_who'])) {
258             //$this->autoJoinExtra();
259         }
260         
261         // since roo does not support autojoin yet..
262         if (!isset($q['_distinct'])) {
263             //$this->autoJoinExtra();
264         }
265         
266         if(!empty($q['query']['action'])) {
267             $act = $this->escape($q['query']['action']);
268             $this->whereAdd("Events.action LIKE '%{$act}%'");
269         }
270         
271         if(!empty($q['query']['on_table'])) {
272             $tnb = $this->escape($q['query']['on_table']);
273             $this->whereAdd("Events.on_table LIKE '%{$tnb}%'");
274         } 
275         
276     }
277       
278     
279     
280     /**
281      * check who is trying to access this. false == access denied..
282      * @return {boolean} true if access is allowed.
283      */
284     function checkPerm($lvl, $au) 
285     {
286         if ($lvl == 'S') {
287             return true;
288         }
289         // listing is controleed by applyfilters..
290         return $au->hasPerm("Admin.Admin_Tab", 'S');
291     }
292     /**
293      * object :
294      * return the object that this relates to.
295      * 
296      * @return {DB_DataObject} related object
297      */
298     function object()
299     {
300         $o = DB_DataObject::factory($this->on_table);
301         $o->get($this->on_id);
302         return $o;
303         
304     }
305     
306     
307     /**
308      * init:
309      * Initialize an event - ready to insert..
310      * 
311      * @param {String} action  - group/name of event
312      * @param {DataObject|false} obj - dataobject action occured on.
313      * @param {String} any remarks 
314      */
315     
316     function init($act, $obj, $remarks)
317     {
318         $ff = HTML_FlexyFramework::get();
319         $pg = $ff->page;
320         $au = $pg->getAuthUser();
321         
322         if ($ff->cli) { // && empty($au) && isset($obj->person_id)) {
323             $au = false;
324            // $au = DB_DataObject::Factory('Person'); // not always a person..
325            // $au->get($obj->person_id);
326         } 
327           
328         $this->person_name = $au && !empty($au->name) ? $au->name : '';
329         //print_r($au);
330         //exit;
331         //$this->who = $au && !empty($au->name) ? $au->name : '';
332         if (empty($au) || (isset($au->id) && empty($au->id))) {
333             // not authenticated - and a standard id based object
334             $this->person_id = 0;
335         } else {
336             $col = $au->tableName() == "Person" ? 'person_id' : $au->tableName() . '_id';
337             // does $col exist?
338             $cols = $this->tableColumns();
339             $col = isset($cols[$col]) ? $col : 'person_id'; // for BC.... - revert to using person_id
340             $this->{$col} = $au->pid();
341             //$this->person_id = $au ? (!empty($au->id) ? $au->id : $au->pid()) : -1;            
342         }
343         $this->person_table = $au ? $au->tableName() : '';
344         $this->ipaddr = isset($_SERVER["REMOTE_ADDR"]) ? $_SERVER["REMOTE_ADDR"] : 'cli';
345         if (!empty($_SERVER['HTTP_X_FORWARDED_FOR'])) {
346             $this->ipaddr = $_SERVER['HTTP_X_FORWARDED_FOR'];
347         }
348         
349         $this->action = $act;
350         $this->on_table = $obj ? $obj->tableName() : '';
351         $pk = $obj ? $obj->keys()  : false;
352         $this->on_id  = $obj && $pk ? $obj->{$pk[0]}: 0;
353         $rem  = array();
354         // should this really go in remarks? - 
355         if ($obj && method_exists($obj,'toEventString')) {
356             if($obj->toEventString() !== false){
357                 $rem[] = $obj->toEventString();
358             }
359         }
360         $rem[] = $remarks;
361         $this->remarks = implode(' : ', $rem);
362     }
363     
364     /**
365      * Generate an audit for this field.
366      *
367      * @param {DB_DataObject} new data
368      * @param {DB_DataObject} old data
369      * 
370      * @return {int} number of entries logged.
371      */
372     
373     function audit($new, $old = false)
374     {
375         if ($old == $new) {
376             return 0; // they are the same...
377         }
378          
379         $ret = 0;
380         foreach(array_keys($new->tableColumns()) as $k) {
381             // should we JSON serialize this?
382             $n = empty($new->$k) ? '' : $new->$k;
383             $o = empty($old->$k) || empty($old->$k) ? '' : $old->$k;
384             if ($n == $o) {
385                 continue;
386             }
387             $this->auditField($k, $o, $n, $old);
388             $ret++;
389         }
390         return $ret;
391     }
392     /**
393      * Record an audited change, in theory so we can audit data that is not just
394      * database Fields...
395      *
396      * @param {string} $name    table field anme
397      * @param {mixed} $ov  old value
398      * @param {mixed} $onv  new value
399      * @param {mixed} $old  old object (false if we are creating..)
400      */
401     function auditField($name, $ov, $nv, $old=false )
402     {
403         // hack..
404         if (is_object($nv)) {
405             return;
406         
407         }
408         
409         $x = DB_DataObject::factory('core_event_audit');
410         $x->setFrom(array(
411             'event_id' => $this->id,
412             'name' => $name,
413             'old_audit_id' => $old ? $x->findLast($this, $name) : 0,
414             'newvalue' => $nv
415
416         ));
417         $x->insert();
418     
419     }
420     
421     function beforeInsert($request,$roo)
422     {
423         if(empty($this->event_when)){
424             $this->event_when = $this->sqlValue("NOW()");
425         }
426         
427         if(empty($this->person_id)){
428             $this->person_id = $roo->authUser->id;
429             $this->person_name = $roo->authUser->name;
430             $this->person_table = $roo->authUser->tableName();
431         }
432         
433         if(empty($this->ipaddr)){
434             $this->ipaddr = isset($_SERVER["REMOTE_ADDR"]) ? $_SERVER["REMOTE_ADDR"] : 'cli';
435             if (!empty($_SERVER['HTTP_X_FORWARDED_FOR'])) {
436                 $this->ipaddr = $_SERVER['HTTP_X_FORWARDED_FOR'];
437             }
438         }        
439     }
440     
441     function beforeUpdate($old, $request,$roo)
442     {
443         if(!empty($request['_restore'])){
444             $this->restore($roo);
445         }
446     }
447     
448     function onInsert($request,$roo)
449     {
450         $this->writeEventLog();
451     }
452     
453     static $deleted = array();
454     
455     
456     // log deleting of a record so that it can be written later..
457     function logDeletedRecord($obj = false)
458     {
459         if (is_array($obj)) {
460             $ret = false;
461             foreach($obj as $o) {
462                 $aret = $this->logDeletedRecord($o);
463                 $ret = $ret ? $ret : $aret;
464             }
465             return true;
466         }
467         
468         if(empty($obj) || !is_a($obj, 'DB_DataObject')){
469             return false;
470         }
471         
472         
473         $del = $obj->toArray();
474         $del['_table'] = $obj->tableName();
475         
476         self::$deleted[] = $del;
477         return true;
478     }
479     static $extra_data = false;
480     
481     static function writeEventLogExtra($data) {
482         self::$extra_data = $data;
483     }
484     
485     function logDir()
486     {
487         $ff  = HTML_FlexyFramework::get();
488         if (function_exists('posix_getpwuid')) {
489             $uinfo = posix_getpwuid( posix_getuid () ); 
490          
491             $user = $uinfo['name'];
492         } else {
493             $user = getenv('USERNAME'); // windows.
494         }
495         
496         // DEPRICATED...
497         if (!empty($ff->Pman['event_log_dir'])) {
498             return $ff->Pman['event_log_dir'] . '/'.$user;
499         }
500         if (!empty($ff->Pman['storedir'])) {
501             return $ff->Pman['storedir'] .'/Events/'.$user;
502         
503         }
504         return false;
505     }
506     
507     
508     
509     function writeEventLog($extra_data  = false)
510     {
511         $logdir = $this->logDir();
512         if (!$logdir) {
513             return false;
514         }
515         
516          
517         //print_r($this);
518         $file = $logdir.  date('/Y/m/d/'). $this->id . ".json";
519         if (!file_exists(dirname($file))) {
520             
521             @mkdir(dirname($file),0700,true); // this might fail if it does not have correct permissions..
522             if (!file_exists(dirname($file))) {
523                 die("could not create $file - permissons are not correct"); // fatal, otherwise we loop!?
524             }
525             
526         }
527         
528         // Remove all the password from logs...
529         $p =  empty($_POST) ? array() : $_POST;
530         foreach(array('passwd', 'password','passwd1',  'passwd2','password1', 'password2') as $rm) {
531             if (isset($p[$rm])) {
532                 $p[$rm] = '******';
533             }
534         }
535         
536         
537         $i=0;
538         $files = array();
539          
540         $i = 0;
541         foreach ($_FILES as $k=>$f){
542             // does not handle any other file[] arrary very well..
543             if (empty($f['tmp_name']) || !file_exists($f['tmp_name'])) {
544                 continue;
545             }
546             $i++;
547             $files[$k] = $f;
548             
549              
550             $files[$k]['tmp_name'] =  $this->id . '-'. $i;
551             $nf = $logdir .   date('/Y/m/d/').   $files[$k]['tmp_name']; 
552             if (!copy($f['tmp_name'], $nf)) {
553                 print_r("failed to copy {$f['tmp_name']}...\n");
554             }
555         }
556         $out = array(
557             'REQUEST_URI' => empty($_SERVER['REQUEST_URI']) ? 'cli' : $_SERVER['REQUEST_URI'],
558             'HTTP_USER_AGENT' => empty($_SERVER['HTTP_USER_AGENT']) ? '' : $_SERVER['HTTP_USER_AGENT'],
559             'GET' => empty($_GET) ? array() : $_GET,
560             'POST' =>$p,
561             'FILES' => $files,
562             
563         );
564         if (!empty(self::$deleted)) {
565             $out['DELETED_DATAOBJECTS'] = self::$deleted;
566         }
567         if ($extra_data !== false) {
568             $out['EXTRA'] = $extra_data;
569         }
570         if ( self::$extra_data !== false) {
571             $out['EXTRA_DATA'] =  self::$extra_data;
572         }
573         
574         file_put_contents($file, json_encode($out));
575         
576         
577     }
578     
579     function toRooArray( $q)
580     {
581         $ret = $this->toArray();
582         
583         // fill toEventString.
584         if (!empty($q['_with_obj_summary']) && !empty($this->on_id)) {
585             $obj = $this->object();
586               
587             if ($obj && $obj->pid() && method_exists($obj,'toEventString')) {
588                 $es = $obj->toEventString();
589                 
590                 if (empty($this->remarks) || strpos($this->remarks, $es) < 0) {
591                     $ret['remarks'] = $es . ' ' . $this->remarks;
592                 }
593             } else if (empty($this->remarks)){
594                 $ret['remarks'] = "DELETED";
595                 
596             }
597         }
598         //print_r($ret);
599         return $ret;
600         
601     }
602     
603     function toRooSingleArray($au, $q)
604     {
605         $ret = $this->toArray();
606         
607          
608         
609         if(empty($q['_retrieve_source'])){
610             return $ret;
611         }
612         
613         $file = $this->retrieveEventLog();
614         
615         if(!$file){
616             return "No records?!";
617         }
618         
619         $source = json_decode(file_get_contents($file));
620         
621         return $source;
622     }
623     
624     function retrieveEventLog()
625     {
626         
627         $logdir = $this->logDir();
628         if (!$logdir) {
629             return false;
630          
631         }
632         
633         $date = date('/Y/m/d/', strtotime($this->event_when));
634         
635         $file = $logdir. $date. $this->id . ".json";
636         if (!file_exists(dirname($file))) {
637             return false;
638         }
639         
640         return $file;
641     }
642     
643     function restore($roo)
644     {
645         $file = $this->retrieveEventLog();
646         
647         if(empty($file) || !file_exists($file)){
648             $roo->jerr('Could not retrieve the event log file');
649         }
650         
651         $log = json_decode(file_get_contents($file), true);
652         
653         if(empty($log['POST']) || empty($log['POST']['_delete']) || empty($log['DELETED_DATAOBJECTS'])){
654             $roo->jerr('Invalid url');
655         }
656         
657         $restored = array();
658         
659         foreach ($log['DELETED_DATAOBJECTS'] as $d){
660             if(
661                     empty($d['id']) || 
662                     empty($d['_table']) || 
663                     (
664                             !empty($restored[$d['_table']]) && 
665                             in_array($d['id'], $restored[$d['_table']])
666                     )
667             ){
668                 continue;
669             }
670             
671             if(!isset($restored[$d['_table']])){
672                 $restored[$d['_table']] = array();
673             }
674             
675             $restored[$d['_table']][] = $d['id'];
676             
677             $table = DB_DataObject::factory($d['_table']);
678             
679             if (!is_a($table,'DB_DataObject')) {
680                 continue;
681             }
682             
683             unset($d['_table']);
684             
685             $table->setFrom($d);
686             
687             /*
688              * need to use the old id
689              */
690             $table->id = $d['id'];
691             
692             $table->sequenceKey(false,false);
693             
694             $table->insert();
695             
696             if($table->tableName() == 'crm_mailing_list_member'){
697                 $ml = DB_DataObject::factory('crm_mailing_list');
698                 if(!$ml->get($table->mailing_list_id)){
699                     continue;
700                 }
701
702                 $mlm = DB_DataObject::factory('crm_mailing_list_member');
703                 $mlm->setFrom(array(
704                     'mailing_list_id' => $table->mailing_list_id,
705                     'is_active' => 1
706                 ));
707
708                 $o = clone($ml);
709                 $ml->no_members = $mlm->count();
710                 $ml->update($o);
711             }
712         }
713         
714         $roo->jok('RESTORE');
715     }
716     function selectAddPersonEmail()
717     {
718         $this->selectAdd('join_person_id_id.email as email');
719         
720     }
721     
722     function autoJoinExtData()
723     {
724        $this->_join .= "LEFT JOIN
725                             ext_data AS ext_data_id
726                         ON
727                             Events.modx_users_id = ext_data_id.userdata_id";                            
728     }
729     
730     function autoJoinCorePerson()
731     {
732        $this->_join .= "LEFT JOIN                             
733                              core_person AS core_person_id
734                         ON
735                              Events.person_id = core_person_id.id";                             
736     }
737 }