DataObjects/Core_watch.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 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
28     
29     /* the code above is auto generated do not remove the tag below */
30     ###END_AUTOCODE
31     
32     
33     
34     
35     //  ------------ROO HOOKS------------------------------------
36     function applyFilters($q, $au ,$roo)
37     {
38         $tn = $this->tableName();
39         if (!empty($q['query']['from'])) {
40             $dt = date('Y-m-d' , strtotime($q['query']['from']));
41             $this->whereAdd(" {$tn}.event_when >=  '$dt' ");
42         }
43         if (!empty($q['query']['to'])) {
44             $dt = date('Y-m-d' , strtotime($q['query']['to']));
45             $this->whereAdd(" {$tn}.event_when <=  '$dt' ");
46         }
47         /*
48         if (!empty($q['query']['grouped']) && $q['query']['grouped'] == 'gr') {
49             // grouped..
50             DB_DataObject::Debuglevel(1);
51             $this->groupBy('on_id');
52             $this->selectAdd('
53                 (SELECT count(id) FROM core_event_audit WHERE event_id = Events.id) as changed
54                 ');
55         }
56         */
57         
58         if (!$au->hasPerm("Admin.Admin_Tab", 'S')) {
59             //DB_DataObject::DebugLevel(1);
60             // they can only view their changes..
61             $this->person_id = $au->id;
62             
63         }
64         // _join = tablename,tablename...
65         
66         /// on_table=cohead
67         //   &_join=cohead
68         //   &_join_cols=cohead_number
69         //    &_columns=on_id_cohead_number,event_when << this is ignored at present.
70         // max(event_when) is not supported... by any query yet..
71         
72         if (isset($q['on_table']) && !strlen($q['on_table'])) {
73             // empty ontable queries.. these are valid..
74             $this->whereAdd("$tn.on_table = ''");
75         }
76         
77         
78         if (isset($q['query']['person_sum'])) {
79             //DB_DataObject::debugLevel(1);
80             $this->_extra_cols = array('qty' );
81             $this->selectAdd("count($tn.id) as qty");
82             $this->selectAdd("count( distinct $tn.on_id) as uqty");
83             $this->whereAdd('LENGTH(join_person_id_id.name) > 0 ');
84             $this->groupBy('person_id,join_person_id_id.name,join_person_id_id.email');
85         }
86          if (isset($q['query']['table_sum'])) {
87             //DB_DataObject::debugLevel(1);
88             $this->_extra_cols = array('qty' , 'uqty');
89             $this->selectAdd("count($tn.id) as qty");
90             $this->selectAdd("count( distinct $tn.on_table, $tn.on_id) as uqty");
91             
92             $this->groupBy('on_table');
93         }
94          if (isset($q['query']['day_sum'])) {
95             //DB_DataObject::debugLevel(1);
96             $this->_extra_cols = array('qty' , 'uqty');
97             $this->selectAdd("DATE_FORMAT(event_when, '%Y-%m-%d') as on_day");
98             $this->selectAdd("count($tn.id) as qty");
99             $this->selectAdd("count( distinct $tn.on_id) as uqty");
100             
101             $this->groupBy('on_day');
102         }
103         
104         if (isset($q['_join'])) {
105             //DB_DataObject::DebugLevel(1);
106             $joins = explode(',',$q['_join']);
107             
108             $this->selectAdd(); // ???
109             $distinct = false;
110             
111             foreach($joins as $t) {
112                 $t = preg_replace('/[^a-z_]+/', '', $t); // protection.
113                 $x = DB_DataObject::Factory($t);
114                 if (!is_a($x,'DB_DataObject')) {
115                     continue;
116                 }
117                 $jtn = $x->tableName();
118                 $jk = array_shift($x->keys());
119                 $this->_join .= "
120                 
121                     LEFT JOIN {$jtn} as join_on_id_{$jtn} ON {$tn}.on_id = join_on_id_{$jtn}.{$jk}
122                         AND on_table = '{$jtn}'
123                 ";
124                 $keys = array_keys($x->table());
125                 if (isset($q['_join_cols'])) {
126                     $jcs = explode(',',$q['_join_cols'] );
127                     //DB_DataObject::DebugLevel(1);
128                     
129                     foreach($jcs as $jc) { 
130                         if (! in_array($jc, $keys)) {
131                             continue;
132                         }
133                         if ($distinct) { 
134                         
135                        
136                             $this->selectAdd( " join_on_id_{$jtn}.{$jc}   as on_id_{$jc} ");
137                         } else {
138                             $this->selectAdd( " distinct(join_on_id_{$jtn}.{$jc}  ) as on_id_{$jc} ");
139                             $distinct = true;
140                         }
141                         $this->groupBy("on_id_{$jc} ");
142                         $this->whereAdd("join_on_id_{$jtn}.{$jc} IS NOT NULL");
143                     }
144                     $this->selectAdd( "MAX(events.event_when) as event_when");
145                     $this->orderBy('event_when DESC');
146                    // $this->selectAs(array($q['_join_cols']) , 'on_id_%s', "join_on_id_{$jtn}");
147                 } else { 
148                     $this->selectAs($x, 'on_id_%s', "join_on_id_{$jtn}");
149                 }
150             }
151                 
152                 
153             
154             
155         }
156         
157         if (isset($q['_related_on_id']) && isset($q['_related_on_table'])) {
158             // example: sales order - has invoices,
159             ///DB_DataObject::DebugLevel(1);
160             $ev  =$this->factory('Events');
161             $ev->setFrom(array(
162                 'on_id' => $q['_related_on_id'],
163                 'on_table' => $q['_related_on_table'],
164                                ));
165             $obj = $ev->object();
166             
167             if (!$obj) {
168                 $roo->jerr("ontable is invalid");
169             }
170             if (!method_exists($obj,'relatedWhere')) {
171                 $roo->jerr( $q['_related_on_table'] . " Does not have method relatedWhere :" .
172                            implode(',', get_class_methods($obj)));
173             }
174             if ($obj && method_exists($obj,'relatedWhere')) {
175                 $ar = $obj->relatedWhere();
176                 $tn = $this->tableName();
177                 
178                 $w = array();
179                 $w[] = "( {$tn}.on_table = '" .
180                         $this->escape($q['_related_on_table']) .
181                         "' AND {$tn}.on_id = ". ((int)  $q['_related_on_id']) .
182                     ")";
183                 
184                 
185                 foreach($ar as $k=>$v) {
186                     if (empty($v)) {
187                         continue;
188                     }                
189                      $w[] = "( {$tn}.on_table = '$k' AND {$tn}.on_id IN (". implode(',', $v). "))";
190                     
191                 }
192                 $this->whereAdd(implode(' OR ' , $w));
193             }
194             
195             
196             
197             
198             
199         }
200         // since roo does not support autojoin yet..
201         if (!isset($q['_distinct'])) {
202             $this->autoJoinExtra();
203         }
204         
205         
206         
207             
208     }
209      
210     function autoJoinExtra()
211     {
212         //$ret = parent::autoJoin();
213         // DB_DataObject::debugLevel(1);
214         
215         // now try and magically join person_table to the right table..
216         return;
217         // this does not work on postgres.. 
218         $tn = $this->tableName();
219         $pt = DB_DataObject::Factory($this->tableName());
220         $pt->selectAdD();
221         $pt->selectAdD('distinct(person_table) as person_table');
222         $pt->whereAdd('person_table IS NOT NULL AND LENGTH(person_table) > 0');
223         $tbls = $pt->fetchAll('person_table');
224         $pers = DB_DataObject::Factory('Person');
225         $ptbl = $pers->tableName();
226         if (!in_array($ptbl,$tbls)) {
227             $tbls[] = $ptbl;
228             
229         }
230         foreach($tbls as $tbl) {
231             
232             // find all the columns from the joined table..
233             $st = DB_DataObject::Factory($tbl);
234             $tcols = array_keys($st->table());
235             
236             $cond = "{$tn}.person_table = '{$tbl}'";
237             if ($tbl == $ptbl) {
238                 $cond = "( $cond OR {$tn}.person_table  = '')";
239             }
240             
241             foreach($tcols as $col) {
242                 if ($col == 'passwd') {
243                     continue;
244                 }
245                 $cols[$col]  = isset($cols[$col] ) ? $cols[$col]  : array();
246                 $cols[$col][] = "WHEN $cond  THEN join_person_table_{$tbl}.{$col}";
247             }
248             // id's are hard coded...
249             
250             $this->_join .= "
251                 LEFT JOIN {$tbl} AS  join_person_table_{$tbl}
252                     ON {$tn}.person_id = join_person_table_{$tbl}.id
253                         AND $cond
254             ";
255         }
256         foreach($cols as $col=>$whens) {
257             
258             $this->selectAdd("
259                     CASE
260                         ". implode("\n", $whens) ." 
261                         ELSE ''
262                     END
263                     as person_table_{$col}"
264             );
265         }
266         //return $ret;
267          
268     }
269     
270     
271     /**
272      * check who is trying to access this. false == access denied..
273      * @return {boolean} true if access is allowed.
274      */
275     function checkPerm($lvl, $au) 
276     {
277         if ($lvl == 'S') {
278             return true;
279         }
280         // listing is controleed by applyfilters..
281         return $au->hasPerm("Admin.Admin_Tab", 'S');
282     }
283     /**
284      * object :
285      * return the object that this relates to.
286      * 
287      * @return {DB_DataObject} related object
288      */
289     function object()
290     {
291         $o = DB_DataObject::factory($this->on_table);
292         $o->get($this->on_id);
293         return $o;
294         
295     }
296     
297     
298     /**
299      * init:
300      * Initialize an event - ready to insert..
301      * 
302      * @param {String} action  - group/name of event
303      * @param {DataObject|false} obj - dataobject action occured on.
304      * @param {String} any remarks 
305      */
306     
307     function init($act, $obj, $remarks)
308     {
309         $ff = HTML_FlexyFramework::get();
310         $pg = $ff->page;
311         $au = $pg->getAuthUser();
312         
313         if ($ff->cli) { // && empty($au) && isset($obj->person_id)) {
314             $au = false;
315            // $au = DB_DataObject::Factory('Person'); // not always a person..
316            // $au->get($obj->person_id);
317         } 
318           
319         $this->person_name = $au && !empty($au->name) ? $au->name : '';
320         $this->person_id = $au ? $au->id : -1;
321         $this->person_table = $au ? $au->tableName() : '';
322         $this->ipaddr = isset($_SERVER["REMOTE_ADDR"]) ? $_SERVER["REMOTE_ADDR"] : 'cli';
323         $this->action = $act;
324         $this->on_table = $obj ? $obj->tableName() : '';
325         $pk = $obj ? $obj->keys()  : false;
326         $this->on_id  = $obj && $pk ? $obj->{$pk[0]}: 0;
327         $rem  = array();
328         // should this really go in remarks? - 
329         if ($obj && method_exists($obj,'toEventString')) {
330             $rem[] = $obj->toEventString() ;
331         }
332         $rem[] = $remarks;
333         $this->remarks = implode(' : ', $rem);
334     }
335     
336     /**
337      * Generate an audit for this field.
338      *
339      * @param {DB_DataObject} new data
340      * @param {DB_DataObject} old data
341      * 
342      * @return {int} number of entries logged.
343      */
344     
345     function audit($new, $old = false)
346     {
347         if ($old == $new) {
348             return 0; // they are the same...
349         }
350          
351         $ret = 0;
352         foreach(array_keys($new->table()) as $k) {
353             // should we JSON serialize this?
354             $n = empty($new->$k) ? '' : $new->$k;
355             $o = empty($old->$k) || empty($old->$k) ? '' : $old->$k;
356             if ($n == $o) {
357                 continue;
358             }
359             $this->auditField($k, $o, $n, $old);
360             $ret++;
361         }
362         return $ret;
363     }
364     /**
365      * Record an audited change, in theory so we can audit data that is not just
366      * database Fields...
367      *
368      * @param {string} $name    table field anme
369      * @param {mixed} $ov  old value
370      * @param {mixed} $onv  new value
371      * @param {mixed} $old  old object (false if we are creating..)
372      */
373     function auditField($name, $ov, $nv, $old=false )
374     {
375         // hack..
376         if (is_object($nv)) {
377             return;
378         
379         }
380         
381         $x = DB_DataObject::factory('core_event_audit');
382         $x->setFrom(array(
383             'event_id' => $this->id,
384             'name' => $name,
385             'old_audit_id' => $old ? $x->findLast($this, $name) : 0,
386             'newvalue' => $nv
387
388         ));
389         $x->insert();
390     
391     }
392     
393     
394     
395     function onInsert($request,$roo)
396     {
397         $this->writeEventLog();
398     }
399     
400     function writeEventLog()
401     {
402         $ff  = HTML_FlexyFramework::get();
403         if (empty($ff->Pman['event_log_dir'])) {
404             return false;
405         }
406         
407         // add user (eg. www-data or local user if not..)
408         if (function_exists('posix_getpwuid')) {
409             $uinfo = posix_getpwuid( posix_getuid () ); 
410          
411             $user = $uinfo['name'];
412         } else {
413             $user = getenv('USERNAME'); // windows.
414         }
415         //print_r($this);
416         $file = $ff->Pman['event_log_dir']. '/'. $user. date('/Y/m/d/'). $this->id . ".json";
417         if (!file_exists(dirname($file))) {
418             mkdir(dirname($file),0700,true);
419         }
420         
421         // Remove all the password from logs...
422         $p =  empty($_POST) ? array() : $_POST;
423         foreach(array('passwd', 'password', 'passwd2', 'password2') as $rm) {
424             if (isset($p[$rm])) {
425                 $p['passwd'] = '******';
426             }
427         }
428         $i=0;
429         $files = array();
430         foreach ($_FILES as $k=>$f){
431             if (empty($f['tmp_name']) || !file_exists($f['tmp_name'])) {
432                 continue;
433             }
434             $i++;
435             $files[$k] = $f;
436             $files[$k]['tmp_name'] = $this->id . '.file_'. $i.'.jpg';
437             $nf = $ff->Pman['event_log_dir']. '/'. $this->id . ".file_$i.jpg";
438             if (!copy($f['tmp_name'], $nf)) {
439                 print_r("failed to copy {$f['tmp_name']}...\n");
440             }
441         }
442         
443         file_put_contents($file, json_encode(array(
444             'REQUEST_URI' => empty($_SERVER['REQUEST_URI']) ? 'cli' : $_SERVER['REQUEST_URI'],
445             'GET' => empty($_GET) ? array() : $_GET,
446             'POST' =>$p,
447             'FILES' => $files,
448         )));
449         
450     }
451     
452     
453 }