git.roojs.org Git - Pman.Core/blob - DataObjects/Core_notify.php

   1 <?php
   2 /**
   3  *
   4  * Table is designed to be used with a mailer to notify or issue
   5  * emails (or maybe others later??)
   6  *
   7  *
   8 CREATE TABLE  core_notify  (
   9   `id` int(11)  NOT NULL AUTO_INCREMENT,
  10   `recur_id` INT(11) NOT NULL;
  11   `act_when` DATETIME NOT NULL,
  12   `onid` int(11)  NOT NULL DEFAULT 0,
  13   `ontable` varchar(128)  NOT NULL DEFAULT '',
  14   `person_id` int(11)  NOT NULL DEFAULT 0,
  15   `msgid` varchar(128)  NOT NULL  DEFAULT '',
  16   `sent` DATETIME  NOT NULL,
  17   `event_id` int(11)  NOT NULL DEFAULT 0,
  18   PRIMARY KEY (`id`),
  19   INDEX `lookup`(`act_when`, `msgid`)
  20 );
  21 **/
  22
  23 require_once 'DB/DataObject.php';
  24
  25 class Pman_Core_DataObjects_Core_notify extends DB_DataObject
  26 {
  27     ###START_AUTOCODE
  28     /* the code below is auto generated do not remove the above tag */
  29
  30     public $__table = 'core_notify';                     // table name
  31     public $id;                              // int(11)  not_null primary_key auto_increment
  32     public $recur_id;                        // int(11) not_null
  33     public $act_when;                        // datetime(19)  not_null multiple_key binary
  34     public $onid;                            // int(11)  not_null
  35     public $ontable;                         // string(128)  not_null
  36     public $person_id;                       // int(11)  not_null
  37     public $msgid;                           // string(128)  not_null
  38     public $sent;                            // datetime(19)  not_null binary
  39     public $event_id;                        // int(11)
  40     public $watch_id;                        // int(11)
  41     public $trigger_person_id;                 // int(11)
  42     public $trigger_event_id;              // int(11)
  43     public $evtype;                         // event type (or method to call)fall
  44     public $act_start;
  45     public $person_table;
  46
  47
  48     /* the code above is auto generated do not remove the tag below */
  49     ###END_AUTOCODE
  50
  51     function person($set = false)
  52     {
  53         if ($set !== false) {
  54             $this->person_table = is_object($set) ? $set->tableName() : '';
  55             $col = $this->person_table  == "Person" ? 'person_id' : $person_table . '_id';
  56             $this->person_id = is_object($set) ? $set->id : $set;
  57             return;
  58         }
  59         static $cache  =array();
  60         $person_table = empty($this->person_table) ? 'Person' : $this->person_table;
  61         $col = $person_table == "Person" ? 'person_id' : $person_table . '_id';
  62
  63         if (isset($cache[$person_table .':'. $this->{$col}])) {
  64             return $cache[$person_table .':'. $this->{$col}];
  65         }
  66
  67         $c = DB_DataObject::Factory($person_table);
  68         $c->get($this->{$col});
  69         $cache[$person_table .':'. $this->{$col}] = $c;
  70         return $c;
  71
  72     }
  73     function object($set = false)
  74     {
  75         if ($set !== false) {
  76             $this->ontable = $set->tableName();
  77             $this->onid = $set->id;
  78             return $set;
  79         }
  80         $c = DB_DataObject::factory($this->ontable);
  81
  82         if ($this->onid == 0) {
  83             return $c; // empty dataobject.
  84         }
  85
  86         $c->autoJoin();
  87
  88         if ($c->get($this->onid)) {
  89             return $c;
  90         }
  91         return false;
  92
  93     }
  94
  95     function lookup($obj, $person, $evtype='')
  96     {
  97         $x = DB_DataObject::Factory($this->tableName());
  98         $x->object($obj);
  99         $x->person($person);
 100         if (!empty($evtype)) {
 101             $x->evtype = $evtype;
 102         }
 103         if ($x->count() != 1) {
 104             return false;
 105         }
 106         $x->find(true);
 107         return $x;
 108
 109     }
 110
 111
 112     function beforeDelete($dependants_array, $roo) {
 113         if ($this->delivered()) {
 114             $roo->jerr("you can not delete a record of a successfull delivery");
 115         }
 116     }
 117     function  beforeInsert($request,$roo)
 118     {
 119         if (empty($request['act_when']) && !empty($request['act_start'])) {
 120             $this->act_start($request['act_start']);
 121         }
 122
 123     }
 124     function beforeUpdate($old, $request,$roo)
 125     {
 126         if (empty($request['act_when']) && !empty($request['act_start'])) {
 127             $this->act_start($request['act_start']);
 128         }
 129     }
 130
 131
 132     function act_start($set = false)
 133     {
 134         if ($set === false) {
 135             return $this->act_start;
 136         }
 137         $this->act_when = $set;
 138         $this->act_start = $set;
 139         return $set;
 140     }
 141
 142     function event()
 143     {
 144
 145         $c = DB_DataObject::factory('Events');
 146
 147         if ($c->get($this->event_id)) {
 148             return $c;
 149         }
 150         return false;
 151
 152     }
 153
 154     function triggerEvent()
 155     {
 156
 157         $c = DB_DataObject::factory('Events');
 158
 159         if ($c->get($this->trigger_event_id)) {
 160             return $c;
 161         }
 162         return false;
 163
 164     }
 165
 166     function delivered()
 167     {
 168         return !empty($this->msgid);
 169     }
 170
 171     function whereAddDeliveryStatus($delivered = false)
 172     {
 173         $tn = $this->tableName();
 174         if ($delivered) {
 175             $this->whereAdd("$tn.msgid IS NOT NULL AND $tn.msgid != ''");
 176         } else {
 177             $this->whereAdd("$tn.msgid IS NULL OR $tn.msgid = ''");
 178         }
 179     }
 180
 181     function status() // used by commandline reporting at present..
 182     {
 183         switch($this->event_id) {
 184             case -1:
 185                 return 'DELIVERED';   //not valid..
 186             case 0:
 187                 return 'PENDING';
 188             default:
 189                 $p ='';
 190                 if (strtotime($this->act_when) > time()) {
 191                     $p = "RETRY: {$this->act_when} ";
 192                 }
 193                 return  $p. $this->event()->remarks;
 194         }
 195
 196     }
 197     /**
 198      * current state of process
 199      *
 200      * 0 = pending
 201      * 1 = delivered
 202      * -1 = failed
 203      *
 204      *
 205      */
 206     function state()
 207     {
 208
 209         if ($this->msgid != '') {
 210             return 1;
 211         }
 212
 213         // msgid is empty now..
 214         // if act_when is greater than now, then it's still pending.
 215         if (strtotime($this->act_when) > time()) {
 216             return 0;
 217         }
 218
 219         // event id can be filled in with a failed attempt.
 220
 221         if ($this->event_id > 0) {
 222             return -1;
 223         }
 224
 225         // event id is empty, and act_when is in the past... not sent yet..
 226
 227         return 0; // pending
 228
 229
 230     }
 231
 232
 233     function applyFilters($q, $au, $roo)
 234     {
 235         if (isset($q['ontable']) && !in_array($q['ontable'], array('Person', 'Events',  'core_watch'))) {
 236             // this will only work on tables not joined to ours.
 237
 238             //DB_DAtaObject::DebugLevel(1);
 239             // then we can build a join..
 240             $d = DB_DataObject::Factory($q['ontable']);
 241             $ji = $d->autoJoin();
 242             //echo '<PRE>';print_R($ji);
 243             // get cols
 244             foreach($ji['join_names'] as $cname=>$fname) {
 245                  $this->selectAdd($fname . ' as ontable_id_' . $cname );
 246             }
 247
 248             //$this->selectAdd($d->_query['data_select']); -- this will cause the same dataIndex...
 249             $this->_join .= "
 250                 LEFT JOIN {$d->tableName()} ON {$this->tableName()}.onid = {$d->tableName()}.id
 251                 {$d->_join}
 252             ";
 253             $this->selectAs($d, 'core_notify_%s');
 254         }
 255         if (!empty($q['query']['person_id_name']) ) {
 256             $this->whereAdd( "join_person_id_id.name LIKE '{$this->escape($q['query']['person_id_name'])}%'");
 257
 258         }
 259          if (!empty($q['query']['status'])) {
 260             switch ($q['query']['status']) {
 261
 262                 case 'SUCCESS';
 263                     $this->whereAdd("msgid  != ''");
 264                     break;
 265                 case 'FAILED';
 266
 267                     $this->whereAdd("msgid  = '' AND event_id > 0 AND act_when < NOW()");
 268
 269                     break;
 270                 case 'PENDING';
 271                     $this->whereAdd('event_id = 0 OR (event_id  > 0 AND act_when > NOW() )');
 272                     break;
 273
 274                 case 'OPENED';
 275                     $this->whereAdd('is_open > 0');
 276                     break;
 277
 278                 case 'ALL':
 279                 default:
 280                     break;
 281             }
 282         }
 283
 284         if(!empty($q['_evtype_align'])){
 285             $this->selectAdd("
 286                 (SELECT
 287                         display_name
 288                 FROM
 289                         core_enum
 290                 WHERE
 291                         etype = 'Core.NotifyType'
 292                     AND
 293                         name = core_notify.evtype
 294                     AND
 295                         active = 1
 296                 ) AS evtype_align
 297             ");
 298         }
 299
 300         if(!empty($q['from'])){
 301             $this->whereAdd("
 302                 act_when >= '{$q['from']}'
 303             ");
 304         }
 305
 306         if(!empty($q['to'])){
 307             $this->whereAdd("
 308                 act_when <= '{$q['to']}'
 309             ");
 310         }
 311
 312     }
 313
 314 }