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