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