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