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