DataObjects/Core_watch.php
[Pman.Core] / DataObjects / Core_watch.php
1 <?php
2 /**
3  * Table Definition for core_watch
4  *
5  * works with 'core_notify'
6  *
7  * any object can call
8  *   $watch->notify($ontable, $onid)
9  *
10  *   in which case it should create a core_notify event.
11  *
12  *
13  * Should 'event' trigger this..
14  *   -> eg. somebody makes a 'EDIT' on 'person'
15  *   -> a watch exists for
16  *        ontable=person,
17  *        onid = -1 <<-- every entry..
18  *        person_id -> who is goes to.
19  *        event = CRUD (eg. shortcut for edit/create/delete)
20  *        medium = "REVIEW" << eg. review needed..
21  *        
22  *
23  * 
24  * 
25  */
26 require_once 'DB/DataObject.php';
27
28 class Pman_Core_DataObjects_Core_watch extends DB_DataObject 
29 {
30     ###START_AUTOCODE
31     /* the code below is auto generated do not remove the above tag */
32
33     public $__table = 'core_watch';                      // table name
34     public $id;                              // int(11)  not_null primary_key auto_increment
35     public $ontable;                         // string(128)  not_null
36     public $onid;                            // int(11)  not_null
37     public $person_id;                       // int(11)  not_null
38     public $event;                           // string(128)  not_null
39     public $medium;                          // string(128)  not_null
40     public $active;                          // int(11)  not_null
41
42     
43     /* the code above is auto generated do not remove the tag below */
44     ###END_AUTOCODE
45     /** make sure there is a watch for this user.. */
46     
47     /**
48      *
49      * Create a watch...
50      *
51      */
52     
53     function ensureNotify(  $ontable, $onid, $person_id, $whereAdd)
54     {
55         //DB_DAtaObject::debugLevel(1);
56         $w = DB_DataObject::factory('core_watch');
57         $w->person_id = $person_id;
58         if (empty($w->person_id)) {
59             return;
60         }
61         
62         $nw = clone($w);
63         $w->whereAdd($whereAdd);
64         
65         
66         if ($w->count()) {
67             return;
68         }
69         $nw->ontable = $ontable;
70         $nw->onid = $onid;
71         
72         $nw->medium = 'email';
73         $nw->active = 1;
74         $nw->insert();
75          
76     }
77     /**
78      * Generate a notify event based on watches (matching whereAdd)
79      *
80      * Usage: $core_watch->notify('mtrack_repos', 1, false, date()
81      *
82      * This can match any 'event' type - eg. it can be blank etc...
83      *   Generally used by non-event driven notifications, like our
84      *   Daily commit message.
85      *
86      *  @param string $ontable - the database table that has been updated/changed etc.
87      *  @param int    $onid    - the id of the row changed
88      *  @param string  $whereAdd (optiona) - a DB whereAdd() condition to filter the search for watches
89      *  @param datetime    $when   (default now)  - date/time to create the notification for (Eg. end of day..)
90      * 
91      */
92     function notify($ontable , $onid, $whereAdd = false, $when=false)
93     {
94         $w = DB_DataObject::factory('core_watch');   
95         if ($whereAdd !== false) { 
96             $w->whereAdd($whereAdd  );
97         }
98         $w->active =1;
99         
100         $w->whereAdd('onid = 0 OR onid='. ((int) $onid));
101        
102         
103         $w->ontable = $ontable;
104         //$w->selectAdd();
105         //$w->selectAdd('distinct(person_id) as person_id');
106         
107         foreach($w->fetchAll() as $w) { 
108             if (!$w->person_id) { // no people??? bugs in watch table
109                 continue;
110             }
111          
112          
113          
114             $nn = DB_DataObject::Factory('core_notify');
115             $nn->ontable = $ontable;
116             $nn->onid = $onid;
117             $nn->evtype = $w->medium;
118             $nn->person_id = $w->person_id;
119             
120             $nf = clone($nn);
121             $nf->whereAdd("sent < '2000-01-01'");
122             if ($nf->count()) {
123                 // we have a item in the queue for that waiting to be sent..
124                 continue;
125             }
126             $nn->act_start( date("Y-m-d H:i:s", $when !== false ? strtotime($when) : time()) );
127             $nn->insert();
128         }
129           
130     }
131     // static really...
132     /**
133      *
134      * This get's called by roo->jok()
135      *
136      *
137      * it's basic usage is to fill in core_notify after an event has happend.
138      *
139      * We can also use it to notify other modules if something has happend.
140      *  = eg. mtrack_ticket * watch will notify mtrack_jira::
141      *
142      *  in that example:
143      *     public $ontable;                         // string(128)  not_null
144             public $onid;                            // int(11)  not_null
145             public $person_id;                       // int(11)  not_null
146             public $event;                           // string(128)  not_null
147             public $medium;                          // string(128)  not_null
148             public $active;                          // int(11)  not_null
149
150      */
151     
152     function notifyEvent($event)
153     {
154         //DB_DataObject::DebugLevel(1);
155         // see if there are any watches on events..
156         // notify everyone flagged except the person doing it...
157         // this is very basic logic... -
158         //    if more intelligence is needed...
159         //    then it 'rules' will have to be added by the watched object....
160         //    anyway leave that for another day..
161         if (empty($event->action)) {
162             return;
163         }
164         $w = DB_DataObject::factory('core_watch');
165         $w->ontable = $event->on_table;
166         $w->whereAdd('onid = 0 OR onid='. ((int) $event->on_id));
167        
168         $w->event  = $event->action;
169         $w->active = 1;
170         
171         
172         $w->whereAdd('person_id != '. (int) $event->person_id);
173  
174         $watches = $w->fetchAll();
175         
176         //print_R($watches);exit;
177         
178         $nn = DB_DataObject::Factory('core_notify');
179         $nn->ontable    = $event->on_table;
180         $nn->onid       = $event->on_id;
181         
182         foreach($watches as $watch) {
183             if (!$watch->person_id) { // no people??? bugs in watch table
184                 $dom = explode(':',$watch->medium);
185                 if (count($dom) != 2) {
186                     continue;
187                 }
188                 $do = DB_DataObject::factory($dom[0]);
189                 if (!method_exists($do,$dom[1])) {
190                     continue;
191                 }
192                 $do->{$dom[1]}($event);
193                 
194                 continue;
195             }
196             
197             $n = clone($nn);
198             $n->trigger_person_id = $event->person_id;
199             $n->trigger_event_id = $event->id;
200             $n->person_id = $watch->person_id;
201             $n->watch_id =  $watch->id;
202             
203             // does this watch already have a flag...
204             $nf = clone($n);
205             $nf->whereAdd("sent ><'2000-01-01'");
206             //$nf->whereAdd('sent < act_when');
207             if ($nf->count()) {
208                 // we have a item in the queue for that waiting to be sent..
209                 continue;
210             }
211             
212             $n->act_start( date("Y-m-d H:i:s") );
213             $n->insert();
214             
215             
216         }
217         
218         
219         
220     }
221     
222      
223 }