3 * Table Definition for Events
5 * objects can implement relatedWhere(), which should return
6 * 'tablename' => array of ids
10 class_exists('DB_DataObject') ? '' : require_once 'DB/DataObject.php';
12 class Pman_Core_DataObjects_Events extends DB_DataObject
15 /* the code below is auto generated do not remove the above tag */
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)
30 /* the code above is auto generated do not remove the tag below */
36 // ------------ROO HOOKS------------------------------------
37 function applyFilters($q, $au ,$roo)
39 $tn = $this->tableName();
40 // if not empty on_table
42 if(!empty($q['person_table'])){
43 $jt = DB_DataObject::factory($q['person_table']);
47 if(!array_key_exists("{$jt->tableName()}_id", $this->tableColumns())){ // coz we have triiger on mysql...
51 $this->_join = "LEFT JOIN {$jt->tableName()} AS join_person_id_id ON (join_person_id_id.{$keys[0]}=Events.person_id)";
56 $this->selectAs($jt, 'person_id_%s', 'join_person_id_id');
58 if (method_exists($jt,'nameColumn')) {
59 $this->selectAdd("join_person_id_id.{$jt->nameColumn()} as person_id_name");
62 if (method_exists($jt,'emailColumn')) {
63 $this->selectAdd("join_person_id_id.{$jt->emailColumn()} as person_id_email");
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'];
76 $jt = DB_DataObject::factory($person);
78 // person_table = '{$jt->tableName()}'
81 // OR person_table IS NULL"
82 //); // default to our standard.. - unless otherwise requested..
86 if (!empty($q['query']['from'])) {
87 $dt = date('Y-m-d' , strtotime($q['query']['from']));
88 $this->whereAdd(" {$tn}.event_when >= '$dt' ");
90 if (!empty($q['query']['to'])) {
91 $dt = date('Y-m-d' , strtotime($q['query']['to']));
92 $this->whereAdd(" {$tn}.event_when <= '$dt' ");
95 if(!empty($q['_with_dupe_count'])){
97 $this->selectAdd("(select count(*)+1 from Events ev_cnt where ev_cnt.dupe_id = {$tn}.id) as dupe_count");
100 if (!empty($q['query']['grouped']) && $q['query']['grouped'] == 'gr') {
102 DB_DataObject::Debuglevel(1);
103 $this->groupBy('on_id');
105 (SELECT count(id) FROM core_event_audit WHERE event_id = Events.id) as changed
110 // _join = tablename,tablename...
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..
118 if (isset($q['on_table']) && !strlen($q['on_table'])) {
119 // empty ontable queries.. these are valid..
120 $this->whereAdd("$tn.on_table = ''");
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');
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");
137 $this->groupBy('on_table');
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");
146 $this->groupBy('on_day');
149 if (isset($q['_join'])) {
150 //DB_DataObject::DebugLevel(1);
151 $joins = explode(',',$q['_join']);
153 $this->selectAdd(); // ???
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')) {
162 $jtn = $x->tableName();
163 $jk = array_shift($x->keys());
166 LEFT JOIN {$jtn} as join_on_id_{$jtn} ON {$tn}.on_id = join_on_id_{$jtn}.{$jk}
167 AND on_table = '{$jtn}'
169 $keys = array_keys($x->tableColumns());
170 if (isset($q['_join_cols'])) {
171 $jcs = explode(',',$q['_join_cols'] );
172 //DB_DataObject::DebugLevel(1);
174 foreach($jcs as $jc) {
175 if (! in_array($jc, $keys)) {
181 $this->selectAdd( " join_on_id_{$jtn}.{$jc} as on_id_{$jc} ");
183 $this->selectAdd( " distinct(join_on_id_{$jtn}.{$jc} ) as on_id_{$jc} ");
186 $this->groupBy("on_id_{$jc} ");
187 $this->whereAdd("join_on_id_{$jtn}.{$jc} IS NOT NULL");
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}");
193 $this->selectAs($x, 'on_id_%s', "join_on_id_{$jtn}");
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');
205 'on_id' => $q['_related_on_id'],
206 'on_table' => $q['_related_on_table'],
208 $obj = $ev->object();
211 $roo->jerr("ontable is invalid");
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)));
218 if ($obj && method_exists($obj,'relatedWhere')) {
219 $ar = $obj->relatedWhere();
220 $tn = $this->tableName();
223 $w[] = "( {$tn}.on_table = '" .
224 $this->escape($q['_related_on_table']) .
225 "' AND {$tn}.on_id = ". ((int) $q['_related_on_id']) .
229 foreach($ar as $k=>$v) {
233 $w[] = "( {$tn}.on_table = '$k' AND {$tn}.on_id IN (". implode(',', $v). "))";
236 $this->whereAdd(implode(' OR ' , $w));
243 // since roo does not support autojoin yet..
244 if (!isset($q['_distinct'])) {
245 //$this->autoJoinExtra();
248 if(!empty($q['query']['action'])) {
249 $act = $this->escape($q['query']['action']);
250 $this->whereAdd("Events.action LIKE '%{$act}%'");
253 if(!empty($q['query']['on_table'])) {
254 $tnb = $this->escape($q['query']['on_table']);
255 $this->whereAdd("Events.on_table LIKE '%{$tnb}%'");
260 function applyPermissionFilters($q, $au ,$roo)
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;
271 * check who is trying to access this. false == access denied..
272 * @return {boolean} true if access is allowed.
274 function checkPerm($lvl, $au)
279 // listing is controleed by applyfilters..
280 return $au->hasPerm("Admin.Admin_Tab", 'S');
284 * return the object that this relates to.
286 * @return {DB_DataObject} related object
290 $o = DB_DataObject::factory($this->on_table);
291 $o->get($this->on_id);
299 * Initialize an event - ready to insert..
301 * @param {String} action - group/name of event
302 * @param {DataObject|false} obj - dataobject action occured on.
303 * @param {String} any remarks
306 function init($act, $obj, $remarks)
308 $ff = HTML_FlexyFramework::get();
310 $au = $pg->getAuthUser();
312 if ($ff->cli) { // && empty($au) && isset($obj->person_id)) {
314 // $au = DB_DataObject::Factory('Person'); // not always a person..
315 // $au->get($obj->person_id);
318 $this->person_name = $au && !empty($au->name) ? $au->name : '';
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;
326 $col = $au->tableName() == "Person" ? 'person_id' : $au->tableName() . '_id';
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;
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'];
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;
344 // should this really go in remarks? -
345 if ($obj && method_exists($obj,'toEventString')) {
346 if($obj->toEventString() !== false){
347 $rem[] = $obj->toEventString();
351 if(!empty($remarks)){
355 $this->remarks = implode(' : ', $rem);
359 * Generate an audit for this field.
361 * @param {DB_DataObject} new data
362 * @param {DB_DataObject} old data
364 * @return {int} number of entries logged.
367 function audit($new, $old = false)
370 return 0; // they are the same...
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;
381 $this->auditField($k, $o, $n, $old);
387 * Record an audited change, in theory so we can audit data that is not just
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..)
395 function auditField($name, $ov, $nv, $old=false )
398 if (is_object($nv)) {
403 $x = DB_DataObject::factory('core_event_audit');
405 'event_id' => $this->id,
407 'old_audit_id' => $old ? $x->findLast($this, $name) : 0,
415 function beforeInsert($request,$roo)
417 if(empty($this->event_when)){
418 $this->event_when = $this->sqlValue("NOW()");
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();
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'];
435 function beforeUpdate($old, $request,$roo)
437 if(!empty($request['_restore'])){
438 $this->restore($roo);
442 function onInsert($request,$roo)
444 $this->writeEventLog();
447 static $deleted = array();
450 // log deleting of a record so that it can be written later..
451 function logDeletedRecord($obj = false)
453 if (is_array($obj)) {
455 foreach($obj as $o) {
456 $aret = $this->logDeletedRecord($o);
457 $ret = $ret ? $ret : $aret;
462 if(empty($obj) || !is_a($obj, 'DB_DataObject')){
467 $del = $obj->toArray();
468 $del['_table'] = $obj->tableName();
470 self::$deleted[] = $del;
473 static $extra_data = false;
475 static function writeEventLogExtra($data) {
476 self::$extra_data = $data;
481 $ff = HTML_FlexyFramework::get();
482 if (function_exists('posix_getpwuid')) {
483 $uinfo = posix_getpwuid( posix_getuid () );
485 $user = $uinfo['name'];
487 $user = getenv('USERNAME'); // windows.
492 if (!empty($ff->Pman['storedir'])) {
493 return $ff->Pman['storedir'] .'/Events/'.$user;
496 if (!empty($ff->Pman['event_log_dir'])) {
497 return $ff->Pman['event_log_dir'] . '/'.$user;
505 function writeEventLog($extra_data = false)
507 $logdir = $this->logDir();
515 $file = $logdir. date('/Y/m/d/'). $this->id . ".json";
516 if (!file_exists(dirname($file))) {
518 @mkdir(dirname($file),0700,true); // this might fail if it does not have correct permissions..
519 if (!file_exists(dirname($file))) {
521 die("Events:: writeEventLog: could not create $file - permissons are not correct\n"); // fatal, otherwise we loop!?
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])) {
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'])) {
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");
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,
565 if (!empty(self::$deleted)) {
566 $out['DELETED_DATAOBJECTS'] = self::$deleted;
568 if ($extra_data !== false) {
569 $out['EXTRA'] = $extra_data;
571 if ( self::$extra_data !== false) {
572 $out['EXTRA_DATA'] = self::$extra_data;
575 foreach($out as $k=>$v) {
576 if (!empty($v) && $k != 'REQUEST_URI') {
581 return; // do not write an empty file with no usefull info.
585 file_put_contents($file, json_encode($out));
590 function toRooArray( $q)
592 $ret = $this->toArray();
594 // fill toEventString.
595 if (!empty($q['_with_obj_summary']) && !empty($this->on_id)) {
596 $obj = $this->object();
598 if ($obj && $obj->pid() && method_exists($obj,'toEventString')) {
599 $es = $obj->toEventString();
601 if (empty($this->remarks) || strpos($this->remarks, $es) < 0) {
602 $ret['remarks'] = $es . ' ' . $this->remarks;
604 } else if (empty($this->remarks)){
605 $ret['remarks'] = "DELETED";
614 function toRooSingleArray($au, $q)
616 $ret = $this->toArray();
620 if(empty($q['_retrieve_source'])){
624 $file = $this->retrieveEventLog();
627 return "No records?!";
630 $source = json_decode(file_get_contents($file));
635 function retrieveEventLog()
638 $logdir = $this->logDir();
644 $date = date('/Y/m/d/', strtotime($this->event_when));
646 $file = $logdir. $date. $this->id . ".json";
647 if (!file_exists(dirname($file))) {
654 function restore($roo)
656 $file = $this->retrieveEventLog();
658 if(empty($file) || !file_exists($file)){
659 $roo->jerr('Could not retrieve the event log file');
662 $log = json_decode(file_get_contents($file), true);
664 if(empty($log['POST']) || empty($log['POST']['_delete']) || empty($log['DELETED_DATAOBJECTS'])){
665 $roo->jerr('Invalid url');
670 foreach ($log['DELETED_DATAOBJECTS'] as $d){
673 empty($d['_table']) ||
675 !empty($restored[$d['_table']]) &&
676 in_array($d['id'], $restored[$d['_table']])
682 if(!isset($restored[$d['_table']])){
683 $restored[$d['_table']] = array();
686 $restored[$d['_table']][] = $d['id'];
688 $table = DB_DataObject::factory($d['_table']);
690 if (!is_a($table,'DB_DataObject')) {
699 * need to use the old id
701 $table->id = $d['id'];
703 $table->sequenceKey(false,false);
707 if($table->tableName() == 'crm_mailing_list_member'){
708 $ml = DB_DataObject::factory('crm_mailing_list');
709 if(!$ml->get($table->mailing_list_id)){
713 $mlm = DB_DataObject::factory('crm_mailing_list_member');
715 'mailing_list_id' => $table->mailing_list_id,
720 $ml->no_members = $mlm->count();
725 $roo->jok('RESTORE');
727 function selectAddPersonEmail()
729 $this->selectAdd('join_person_id_id.email as email');