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