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['query']['person_sum'])) {
  73             //DB_DataObject::debugLevel(1);
  74             $this->_extra_cols = array('qty' );
  75             $this->selectAdd("count($tn.id) as qty");
  76             $this->whereAdd('LENGTH(person_id_name) > 0 ');
  77             $this->groupBy('person_id');
  78         }
  79          if (isset($q['query']['table_sum'])) {
  80             //DB_DataObject::debugLevel(1);
  81             $this->_extra_cols = array('qty' , 'uqty');
  82             $this->selectAdd("count($tn.id) as qty");
  83             $this->selectAdd("count( distinct $tn.on_id) as uqty");
  84
  85             $this->groupBy('on_table');
  86         }
  87
  88
  89         if (isset($q['_join'])) {
  90             //DB_DataObject::DebugLevel(1);
  91             $joins = explode(',',$q['_join']);
  92
  93             $this->selectAdd(); // ???
  94             $distinct = false;
  95
  96             foreach($joins as $t) {
  97                 $t = preg_replace('/[^a-z_]+/', '', $t); // protection.
  98                 $x = DB_DataObject::Factory($t);
  99                 if (!is_a($x,'DB_DataObject')) {
 100                     continue;
 101                 }
 102                 $jtn = $x->tableName();
 103                 $jk = array_shift($x->keys());
 104                 $this->_join .= "
 105
 106                     LEFT JOIN {$jtn} as join_on_id_{$jtn} ON {$tn}.on_id = join_on_id_{$jtn}.{$jk}
 107                         AND on_table = '{$jtn}'
 108                 ";
 109                 $keys = array_keys($x->table());
 110                 if (isset($q['_join_cols'])) {
 111                     $jcs = explode(',',$q['_join_cols'] );
 112                     //DB_DataObject::DebugLevel(1);
 113
 114                     foreach($jcs as $jc) {
 115                         if (! in_array($jc, $keys)) {
 116                             continue;
 117                         }
 118                         if ($distinct) {
 119
 120
 121                             $this->selectAdd( " join_on_id_{$jtn}.{$jc}   as on_id_{$jc} ");
 122                         } else {
 123                             $this->selectAdd( " distinct(join_on_id_{$jtn}.{$jc}  ) as on_id_{$jc} ");
 124                             $distinct = true;
 125                         }
 126                         $this->groupBy("on_id_{$jc} ");
 127                         $this->whereAdd("join_on_id_{$jtn}.{$jc} IS NOT NULL");
 128                     }
 129                     $this->selectAdd( "MAX(events.event_when) as event_when");
 130                     $this->orderBy('event_when DESC');
 131                    // $this->selectAs(array($q['_join_cols']) , 'on_id_%s', "join_on_id_{$jtn}");
 132                 } else {
 133                     $this->selectAs($x, 'on_id_%s', "join_on_id_{$jtn}");
 134                 }
 135             }
 136
 137
 138
 139
 140         }
 141
 142         if (isset($q['_related_on_id']) && isset($q['_related_on_table'])) {
 143             // example: sales order - has invoices,
 144             $ev  =$this->factory('Events');
 145             $ev->setFrom(array(
 146                 'on_id' => $q['_related_on_id'],
 147                 'on_table' => $q['_related_on_table'],
 148                                ));
 149             $obj = $ev->object();
 150
 151             if ($obj && method_exists($obj,'relatedWhere')) {
 152                 $ar = $obj->relatedWhere();
 153                 $tn = $this->tableName();
 154
 155                 $w = array();
 156                 $w[] = "( {$tn}.on_table = '" .
 157                         $this->escape($q['_related_on_table']) .
 158                         "' AND {$tn}.on_id = ". ((int)  $q['_related_on_id']) .
 159                     ")";
 160
 161
 162                 foreach($ar as $k=>$v) {
 163                     if (empty($v)) {
 164                         continue;
 165                     }
 166                      $w[] = "( {$tn}.on_table = '$k' AND {$tn}.on_id IN (". implode(',', $v). "))";
 167
 168                 }
 169                 $this->whereAdd(implode(' OR ' , $w));
 170             }
 171
 172
 173
 174
 175
 176         }
 177
 178
 179
 180
 181
 182
 183     }
 184     /**
 185      * check who is trying to access this. false == access denied..
 186      * @return {boolean} true if access is allowed.
 187      */
 188     function checkPerm($lvl, $au)
 189     {
 190         if ($lvl == 'S') {
 191             return true;
 192         }
 193         // listing is controleed by applyfilters..
 194         return $au->hasPerm("Admin.Admin_Tab", 'S');
 195     }
 196     /**
 197      * object :
 198      * return the object that this relates to.
 199      *
 200      * @return {DB_DataObject} related object
 201      */
 202     function object()
 203     {
 204         $o = DB_DataObject::factory($this->on_table);
 205         $o->get($this->on_id);
 206         return $o;
 207
 208     }
 209
 210
 211     /**
 212      * init:
 213      * Initialize an event - ready to insert..
 214      *
 215      * @param {String} action  - group/name of event
 216      * @param {DataObject|false} obj - dataobject action occured on.
 217      * @param {String} any remarks
 218      */
 219
 220     function init($act, $obj, $remarks)
 221     {
 222         $ff = HTML_FlexyFramework::get();
 223         $pg = $ff->page;
 224         $au = $pg->getAuthUser();
 225
 226         if ($ff->cli && empty($au) && isset($obj->person_id)) {
 227             $au = DB_DataObject::Factory('Person'); // not always a person..
 228             $au->get($obj->person_id);
 229         }
 230
 231
 232
 233         $this->person_name = $au && !empty($au->name) ? $au->name : '';
 234         $this->person_id = $au ? $au->id : '';
 235         $this->ipaddr = isset($_SERVER["REMOTE_ADDR"]) ? $_SERVER["REMOTE_ADDR"] : 'cli';
 236         $this->action = $act;
 237         $this->on_table = $obj ? $obj->tableName() : '';
 238         $pk = $obj ? $obj->keys()  : false;
 239         $this->on_id  = $obj && $pk ? $obj->{$pk[0]}: 0;
 240         $rem  = array();
 241         // should this really go in remarks? -
 242         if ($obj && method_exists($obj,'toEventString')) {
 243             $rem[] = $obj->toEventString() ;
 244         }
 245         $rem[] = $remarks;
 246         $this->remarks = implode(' : ', $rem);
 247     }
 248
 249     /**
 250      * Generate an audit for this field.
 251      *
 252      * @param {DB_DataObject} new data
 253      * @param {DB_DataObject} old data
 254      *
 255      * @return {int} number of entries logged.
 256      */
 257
 258     function audit($new, $old = false)
 259     {
 260         if ($old == $new) {
 261             return 0; // they are the same...
 262         }
 263
 264         $ret = 0;
 265         foreach(array_keys($new->table()) as $k) {
 266             // should we JSON serialize this?
 267             $n = empty($new->$k) ? '' : $new->$k;
 268             $o = empty($old->$k) || empty($old->$k) ? '' : $old->$k;
 269             if ($n == $o) {
 270                 continue;
 271             }
 272             $this->auditField($k, $o, $n, $old);
 273             $ret++;
 274         }
 275         return $ret;
 276     }
 277     /**
 278      * Record an audited change, in theory so we can audit data that is not just
 279      * database Fields...
 280      *
 281      * @param {string} $name    table field anme
 282      * @param {mixed} $ov  old value
 283      * @param {mixed} $onv  new value
 284      * @param {mixed} $old  old object (false if we are creating..)
 285      */
 286     function auditField($name, $ov, $nv, $old=false )
 287     {
 288         $x = DB_DataObject::factory('core_event_audit');
 289         $x->setFrom(array(
 290             'event_id' => $this->id,
 291             'name' => $name,
 292             'old_audit_id' => $old ? $x->findLast($this, $name) : 0,
 293             'newvalue' => $nv
 294
 295         ));
 296         $x->insert();
 297
 298     }
 299 }