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
  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)
  37     {
  38         $tn = $this->tableName();
  39         if (!empty($q['query']['from'])) {
  40             $dt = date('Y-m-d' , strtotime($q['query']['from']));
  41             $this->whereAdd(" {$tn}.event_when >=  '$dt' ");
  42         }
  43         if (!empty($q['query']['to'])) {
  44             $dt = date('Y-m-d' , strtotime($q['query']['to']));
  45             $this->whereAdd(" {$tn}.event_when <=  '$dt' ");
  46         }
  47         /*
  48         if (!empty($q['query']['grouped']) && $q['query']['grouped'] == 'gr') {
  49             // grouped..
  50             DB_DataObject::Debuglevel(1);
  51             $this->groupBy('on_id');
  52             $this->selectAdd('
  53                 (SELECT count(id) FROM core_event_audit WHERE event_id = Events.id) as changed
  54                 ');
  55         }
  56         */
  57
  58         if (!$au->hasPerm("Admin.Admin_Tab", 'S')) {
  59             //DB_DataObject::DebugLevel(1);
  60             // they can only view their changes..
  61             $this->person_id = $au->id;
  62
  63         }
  64         // _join = tablename,tablename...
  65
  66         /// on_table=cohead
  67         //   &_join=cohead
  68         //   &_join_cols=cohead_number
  69         //    &_columns=on_id_cohead_number,event_when << this is ignored at present.
  70         // max(event_when) is not supported... by any query yet..
  71
  72         if (isset($q['on_table']) && !strlen($q['on_table'])) {
  73             // empty ontable queries.. these are valid..
  74             $this->whereAdd("$tn.on_table = ''");
  75         }
  76
  77
  78         if (isset($q['query']['person_sum'])) {
  79             //DB_DataObject::debugLevel(1);
  80             $this->_extra_cols = array('qty' );
  81             $this->selectAdd("count($tn.id) as qty");
  82             $this->selectAdd("count( distinct $tn.on_id) as uqty");
  83             $this->whereAdd('LENGTH(join_person_id_id.name) > 0 ');
  84             $this->groupBy('person_id');
  85         }
  86          if (isset($q['query']['table_sum'])) {
  87             //DB_DataObject::debugLevel(1);
  88             $this->_extra_cols = array('qty' , 'uqty');
  89             $this->selectAdd("count($tn.id) as qty");
  90             $this->selectAdd("count( distinct $tn.on_table, $tn.on_id) as uqty");
  91
  92             $this->groupBy('on_table');
  93         }
  94          if (isset($q['query']['day_sum'])) {
  95             //DB_DataObject::debugLevel(1);
  96             $this->_extra_cols = array('qty' , 'uqty');
  97             $this->selectAdd("DATE_FORMAT(event_when, '%Y-%m-%d') as on_day");
  98             $this->selectAdd("count($tn.id) as qty");
  99             $this->selectAdd("count( distinct $tn.on_id) as uqty");
 100
 101             $this->groupBy('on_day');
 102         }
 103
 104         if (isset($q['_join'])) {
 105             //DB_DataObject::DebugLevel(1);
 106             $joins = explode(',',$q['_join']);
 107
 108             $this->selectAdd(); // ???
 109             $distinct = false;
 110
 111             foreach($joins as $t) {
 112                 $t = preg_replace('/[^a-z_]+/', '', $t); // protection.
 113                 $x = DB_DataObject::Factory($t);
 114                 if (!is_a($x,'DB_DataObject')) {
 115                     continue;
 116                 }
 117                 $jtn = $x->tableName();
 118                 $jk = array_shift($x->keys());
 119                 $this->_join .= "
 120
 121                     LEFT JOIN {$jtn} as join_on_id_{$jtn} ON {$tn}.on_id = join_on_id_{$jtn}.{$jk}
 122                         AND on_table = '{$jtn}'
 123                 ";
 124                 $keys = array_keys($x->table());
 125                 if (isset($q['_join_cols'])) {
 126                     $jcs = explode(',',$q['_join_cols'] );
 127                     //DB_DataObject::DebugLevel(1);
 128
 129                     foreach($jcs as $jc) {
 130                         if (! in_array($jc, $keys)) {
 131                             continue;
 132                         }
 133                         if ($distinct) {
 134
 135
 136                             $this->selectAdd( " join_on_id_{$jtn}.{$jc}   as on_id_{$jc} ");
 137                         } else {
 138                             $this->selectAdd( " distinct(join_on_id_{$jtn}.{$jc}  ) as on_id_{$jc} ");
 139                             $distinct = true;
 140                         }
 141                         $this->groupBy("on_id_{$jc} ");
 142                         $this->whereAdd("join_on_id_{$jtn}.{$jc} IS NOT NULL");
 143                     }
 144                     $this->selectAdd( "MAX(events.event_when) as event_when");
 145                     $this->orderBy('event_when DESC');
 146                    // $this->selectAs(array($q['_join_cols']) , 'on_id_%s', "join_on_id_{$jtn}");
 147                 } else {
 148                     $this->selectAs($x, 'on_id_%s', "join_on_id_{$jtn}");
 149                 }
 150             }
 151
 152
 153
 154
 155         }
 156
 157         if (isset($q['_related_on_id']) && isset($q['_related_on_table'])) {
 158             // example: sales order - has invoices,
 159             $ev  =$this->factory('Events');
 160             $ev->setFrom(array(
 161                 'on_id' => $q['_related_on_id'],
 162                 'on_table' => $q['_related_on_table'],
 163                                ));
 164             $obj = $ev->object();
 165
 166             if ($obj && method_exists($obj,'relatedWhere')) {
 167                 $ar = $obj->relatedWhere();
 168                 $tn = $this->tableName();
 169
 170                 $w = array();
 171                 $w[] = "( {$tn}.on_table = '" .
 172                         $this->escape($q['_related_on_table']) .
 173                         "' AND {$tn}.on_id = ". ((int)  $q['_related_on_id']) .
 174                     ")";
 175
 176
 177                 foreach($ar as $k=>$v) {
 178                     if (empty($v)) {
 179                         continue;
 180                     }
 181                      $w[] = "( {$tn}.on_table = '$k' AND {$tn}.on_id IN (". implode(',', $v). "))";
 182
 183                 }
 184                 $this->whereAdd(implode(' OR ' , $w));
 185             }
 186
 187
 188
 189
 190
 191         }
 192         // since roo does not support autojoin yet..
 193         $this->autoJoinExtra();
 194
 195
 196
 197
 198
 199     }
 200
 201     function autoJoinExtra()
 202     {
 203         //$ret = parent::autoJoin();
 204         DB_DataObject::debugLevel(1);
 205
 206         // now try and magically join person_table to the right table..
 207         $tn = $this->tableName();
 208         $pt = DB_DataObject::Factory($this->tableName());
 209         $pt->selectAdD();
 210         $pt->selectAdD('distinct(person_table) as person_table');
 211         $pt->whereAdd('person_table IS NOT NULL AND LENGTH(person_table) > 0');
 212         $tbls = $pt->fetchAll('person_table');
 213         foreach($tbls as $tbl) {
 214
 215             // find all the columns from the joined table..
 216             $st = DB_DataObject::Factory($tbl);
 217             $tcols = array_keys($st->table());
 218             foreach($tcols as $col) {
 219                 if ($col == 'passwd') {
 220                     continue;
 221                 }
 222                 $cols[$col]  = isset($cols[$col] ) ? $cols[$col]  : array();
 223                 $cols[$col][] = "WHEN {$tn}.person_table = '$tbl'  THEN join_person_table_{$tbl}.{$col}";
 224             }
 225             // id's are hard coded...
 226             $this->_join .= "
 227                 LEFT JOIN {$tbl} AS  join_person_table_{$tbl}
 228                     ON {$tn}.person_id = join_person_table_{$tbl}.id
 229                         AND {$tn}.person_table = '{$tbl}'
 230
 231             ";
 232         }
 233         foreach($cols as $col=>$whens) {
 234
 235             $this->selectAdd("
 236                     CASE
 237                         ". implode("\n", $whens) ."
 238                         ELSE ''
 239                     END
 240                     as person_table_{$col}"
 241             );
 242         }
 243         //return $ret;
 244
 245     }
 246
 247
 248     /**
 249      * check who is trying to access this. false == access denied..
 250      * @return {boolean} true if access is allowed.
 251      */
 252     function checkPerm($lvl, $au)
 253     {
 254         if ($lvl == 'S') {
 255             return true;
 256         }
 257         // listing is controleed by applyfilters..
 258         return $au->hasPerm("Admin.Admin_Tab", 'S');
 259     }
 260     /**
 261      * object :
 262      * return the object that this relates to.
 263      *
 264      * @return {DB_DataObject} related object
 265      */
 266     function object()
 267     {
 268         $o = DB_DataObject::factory($this->on_table);
 269         $o->get($this->on_id);
 270         return $o;
 271
 272     }
 273
 274
 275     /**
 276      * init:
 277      * Initialize an event - ready to insert..
 278      *
 279      * @param {String} action  - group/name of event
 280      * @param {DataObject|false} obj - dataobject action occured on.
 281      * @param {String} any remarks
 282      */
 283
 284     function init($act, $obj, $remarks)
 285     {
 286         $ff = HTML_FlexyFramework::get();
 287         $pg = $ff->page;
 288         $au = $pg->getAuthUser();
 289
 290         if ($ff->cli) { // && empty($au) && isset($obj->person_id)) {
 291             $au = false;
 292            // $au = DB_DataObject::Factory('Person'); // not always a person..
 293            // $au->get($obj->person_id);
 294         }
 295
 296         $this->person_name = $au && !empty($au->name) ? $au->name : '';
 297         $this->person_id = $au ? $au->id : -1;
 298         $this->person_table = $au ? $au->tableName() : '';
 299         $this->ipaddr = isset($_SERVER["REMOTE_ADDR"]) ? $_SERVER["REMOTE_ADDR"] : 'cli';
 300         $this->action = $act;
 301         $this->on_table = $obj ? $obj->tableName() : '';
 302         $pk = $obj ? $obj->keys()  : false;
 303         $this->on_id  = $obj && $pk ? $obj->{$pk[0]}: 0;
 304         $rem  = array();
 305         // should this really go in remarks? -
 306         if ($obj && method_exists($obj,'toEventString')) {
 307             $rem[] = $obj->toEventString() ;
 308         }
 309         $rem[] = $remarks;
 310         $this->remarks = implode(' : ', $rem);
 311     }
 312
 313     /**
 314      * Generate an audit for this field.
 315      *
 316      * @param {DB_DataObject} new data
 317      * @param {DB_DataObject} old data
 318      *
 319      * @return {int} number of entries logged.
 320      */
 321
 322     function audit($new, $old = false)
 323     {
 324         if ($old == $new) {
 325             return 0; // they are the same...
 326         }
 327
 328         $ret = 0;
 329         foreach(array_keys($new->table()) as $k) {
 330             // should we JSON serialize this?
 331             $n = empty($new->$k) ? '' : $new->$k;
 332             $o = empty($old->$k) || empty($old->$k) ? '' : $old->$k;
 333             if ($n == $o) {
 334                 continue;
 335             }
 336             $this->auditField($k, $o, $n, $old);
 337             $ret++;
 338         }
 339         return $ret;
 340     }
 341     /**
 342      * Record an audited change, in theory so we can audit data that is not just
 343      * database Fields...
 344      *
 345      * @param {string} $name    table field anme
 346      * @param {mixed} $ov  old value
 347      * @param {mixed} $onv  new value
 348      * @param {mixed} $old  old object (false if we are creating..)
 349      */
 350     function auditField($name, $ov, $nv, $old=false )
 351     {
 352         $x = DB_DataObject::factory('core_event_audit');
 353         $x->setFrom(array(
 354             'event_id' => $this->id,
 355             'name' => $name,
 356             'old_audit_id' => $old ? $x->findLast($this, $name) : 0,
 357             'newvalue' => $nv
 358
 359         ));
 360         $x->insert();
 361
 362     }
 363 }