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