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