forked from osTicket/osTicket-1.7
/
class.template.php
392 lines (309 loc) · 14.7 KB
/
class.template.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
<?php
/*********************************************************************
class.template.php
Email Template
Peter Rotich <peter@osticket.com>
Copyright (c) 2006-2012 osTicket
http://www.osticket.com
Released under the GNU General Public License WITHOUT ANY WARRANTY.
See LICENSE.TXT for details.
vim: expandtab sw=4 ts=4 sts=4:
**********************************************************************/
class Template {
var $id;
var $ht;
function Template($id){
$this->id=0;
$this->load($id);
}
function load($id) {
if(!$id && !($id=$this->getId()))
return false;
$sql='SELECT tpl.*,count(dept.tpl_id) as depts '
.' FROM '.EMAIL_TEMPLATE_TABLE.' tpl '
.' LEFT JOIN '.DEPT_TABLE.' dept USING(tpl_id) '
.' WHERE tpl_id='.db_input($id);
if(!($res=db_query($sql))|| !db_num_rows($res))
return false;
$this->ht=db_fetch_array($res);
$this->id=$this->ht['tpl_id'];
return true;
}
function reload() {
return $this->load($this->getId());
}
function getId(){
return $this->id;
}
function getName(){
return $this->ht['name'];
}
function getNotes(){
return $this->ht['notes'];
}
function isEnabled() {
return ($this->ht['isactive']);
}
function isActive(){
return $this->isEnabled();
}
function isInUse(){
global $cfg;
return ($this->ht['depts'] || ($cfg && $this->getId()==$cfg->getDefaultTemplateId()));
}
function getHashtable() {
return $this->ht;
}
function getInfo() {
return $this->getHashtable();
}
function setStatus($status){
$sql='UPDATE '.EMAIL_TEMPLATE_TABLE.' SET updated=NOW(), isactive='.db_input($status?1:0)
.' WHERE tpl_id='.db_input($this->getId());
return (db_query($sql) && db_affected_rows());
}
function getMsgTemplate($name){
//TODO: Don't preload - do ondemand fetch!
$tpl=array();
switch(strtolower($name)){
case 'ticket_autoresp':
$tpl=array('subj'=>$this->ht['ticket_autoresp_subj'],'body'=>$this->ht['ticket_autoresp_body']);
break;
case 'msg_autoresp':
$tpl=array('subj'=>$this->ht['message_autoresp_subj'],'body'=>$this->ht['message_autoresp_body']);
break;
case 'ticket_notice':
$tpl=array('subj'=>$this->ht['ticket_notice_subj'],'body'=>$this->ht['ticket_notice_body']);
break;
case 'overlimit_notice':
$tpl=array('subj'=>$this->ht['ticket_overlimit_subj'],'body'=>$this->ht['ticket_overlimit_body']);
break;
case 'ticket_reply':
$tpl=array('subj'=>$this->ht['ticket_reply_subj'],'body'=>$this->ht['ticket_reply_body']);
break;
case 'ticket_alert':
$tpl=array('subj'=>$this->ht['ticket_alert_subj'],'body'=>$this->ht['ticket_alert_body']);
break;
case 'msg_alert':
$tpl=array('subj'=>$this->ht['message_alert_subj'],'body'=>$this->ht['message_alert_body']);
break;
case 'note_alert':
$tpl=array('subj'=>$this->ht['note_alert_subj'],'body'=>$this->ht['note_alert_body']);
break;
case 'assigned_alert':
$tpl=array('subj'=>$this->ht['assigned_alert_subj'],'body'=>$this->ht['assigned_alert_body']);
break;
case 'transfer_alert':
$tpl=array('subj'=>$this->ht['transfer_alert_subj'],'body'=>$this->ht['transfer_alert_body']);
break;
case 'overdue_alert':
$tpl=array('subj'=>$this->ht['ticket_overdue_subj'],'body'=>$this->ht['ticket_overdue_body']);
break;
default:
Sys::log(LOG_WARNING,'Template Fetch Error',"Unable to fetch '$name' template - id #".$this->getId());
$tpl=array();
}
return $tpl;
}
function getNewTicketAlertMsgTemplate() {
return $this->getMsgTemplate('ticket_alert');
}
function getNewMessageAlertMsgTemplate() {
return $this->getMsgTemplate('msg_alert');
}
function getNewTicketNoticeMsgTemplate() {
return $this->getMsgTemplate('ticket_notice');
}
function getNewMessageAutorepMsgTemplate() {
return $this->getMsgTemplate('msg_autoresp');
}
function getAutoRespMsgTemplate() {
return $this->getMsgTemplate('ticket_autoresp');
}
function getReplyMsgTemplate() {
return $this->getMsgTemplate('ticket_reply');
}
function getOverlimitMsgTemplate() {
return $this->getMsgTemplate('overlimit_notice');
}
function getNoteAlertMsgTemplate() {
return $this->getMsgTemplate('note_alert');
}
function getTransferAlertMsgTemplate() {
return $this->getMsgTemplate('transfer_alert');
}
function getAssignedAlertMsgTemplate() {
return $this->getMsgTemplate('assigned_alert');
}
function getOverdueAlertMsgTemplate() {
return $this->getMsgTemplate('overdue_alert');
}
function updateMsgTemplate($vars, &$errors) {
if(!($tpls=Template::message_templates()) || !$tpls[$vars['tpl']])
$errors['tpl']='Unknown or invalid template';
if(!$vars['subj'])
$errors['subj']='Message subject required';
if(!$vars['body'])
$errors['body']='Message body required';
if($errors) return false;
$sql='UPDATE '.EMAIL_TEMPLATE_TABLE.' SET updated=NOW() ';
switch(strtolower($vars['tpl'])){
case 'ticket_autoresp':
$sql.=',ticket_autoresp_subj='.db_input($vars['subj']).',ticket_autoresp_body='.db_input($vars['body']);
break;
case 'msg_autoresp':
$sql.=',message_autoresp_subj='.db_input($vars['subj']).',message_autoresp_body='.db_input($vars['body']);
break;
case 'ticket_notice':
$sql.=',ticket_notice_subj='.db_input($vars['subj']).',ticket_notice_body='.db_input($vars['body']);
break;
case 'overlimit_notice':
$sql.=',ticket_overlimit_subj='.db_input($vars['subj']).',ticket_overlimit_body='.db_input($vars['body']);
break;
case 'ticket_reply':
$sql.=',ticket_reply_subj='.db_input($vars['subj']).',ticket_reply_body='.db_input($vars['body']);
break;
case 'ticket_alert':
$sql.=',ticket_alert_subj='.db_input($vars['subj']).',ticket_alert_body='.db_input($vars['body']);
break;
case 'msg_alert':
$sql.=',message_alert_subj='.db_input($vars['subj']).',message_alert_body='.db_input($vars['body']);
break;
case 'note_alert':
$sql.=',note_alert_subj='.db_input($vars['subj']).',note_alert_body='.db_input($vars['body']);
break;
case 'assigned_alert':
$sql.=',assigned_alert_subj='.db_input($vars['subj']).',assigned_alert_body='.db_input($vars['body']);
break;
case 'transfer_alert':
$sql.=',transfer_alert_subj='.db_input($vars['subj']).',transfer_alert_body='.db_input($vars['body']);
break;
case 'overdue_alert':
$sql.=',ticket_overdue_subj='.db_input($vars['subj']).',ticket_overdue_body='.db_input($vars['body']);
break;
default:
$errors['tpl']='Unknown or invalid template';
return false;
}
$sql.=' WHERE tpl_id='.db_input($this->getId());
return (db_query($sql));
}
function update($vars,&$errors) {
if(!$vars['isactive'] && $this->isInUse())
$errors['isactive']='Template in-use can not be disabled!';
if(!$this->save($this->getId(),$vars,$errors))
return false;
$this->reload();
return true;
}
function enable(){
return ($this->setStatus(1));
}
function disable(){
return (!$this->isInUse() && $this->setStatus(0));
}
function delete(){
global $cfg;
if($this->isInUse() || $cfg->getDefaultTemplateId()==$this->getId())
return 0;
$sql='DELETE FROM '.EMAIL_TEMPLATE_TABLE.' WHERE tpl_id='.db_input($this->getId()).' LIMIT 1';
if(db_query($sql) && ($num=db_affected_rows())) {
//isInuse check is enough - but it doesn't hurt make sure deleted tpl is not in-use.
db_query('UPDATE '.DEPT_TABLE.' SET tpl_id=0 WHERE tpl_id='.db_input($this->getId()));
}
return $num;
}
/*** Static functions ***/
function message_templates(){
//TODO: Make it database driven and dynamic
$messages=array('ticket_autoresp'=>array('name'=>'New Ticket Autoresponse',
'desc'=>'Autoresponse sent to user, if enabled, on new ticket.'),
'msg_autoresp'=>array('name'=>'New Message Auto-response',
'desc'=>'Confirmation sent to user when a new message is appended to an existing ticket.'),
'ticket_notice'=>array('name'=>'New Ticket Notice',
'desc'=>'Notice sent to user, if enabled, on new ticket created by staff on their behalf (e.g phone calls).'),
'overlimit_notice'=>array('name'=>'Over Limit Notice',
'desc'=>'A one time notice sent, if enabled, when user has reached the maximum allowed open tickets.'),
'ticket_reply'=>array('name'=>'Response/Reply Template',
'desc'=>'Template used on ticket response/reply'),
'ticket_alert'=>array('name'=>'New Ticket Alert',
'desc'=>'Alert sent to staff, if enabled, on new ticket.'),
'msg_alert'=>array('name'=>'New Message Alert',
'desc'=>'Alert sent to staff, if enabled, when user replies to an existing ticket.'),
'note_alert'=>array('name'=>'Internal Note Alert',
'desc'=>'Alert sent to selected staff, if enabled, on new internal note.'),
'assigned_alert'=>array('name'=>'Ticket Assignment Alert',
'desc'=>'Alert sent to staff on ticket assignment.'),
'transfer_alert'=>array('name'=>'Ticket Transfer Alert',
'desc'=>'Alert sent to staff on ticket transfer.'),
'overdue_alert'=>array('name'=>'Overdue Ticket Alert',
'desc'=>'Alert sent to staff on stale or overdue tickets.')
);
return $messages;
}
function create($vars,&$errors) {
return Template::save(0,$vars,$errors);
}
function getIdByName($name){
$sql='SELECT tpl_id FROM '.EMAIL_TEMPLATE_TABLE.' WHERE name='.db_input($name);
if(($res=db_query($sql)) && db_num_rows($res))
list($id)=db_fetch_row($res);
return $id;
}
function lookup($id){
return ($id && is_numeric($id) && ($t= new Template($id)) && $t->getId()==$id)?$t:null;
}
function save($id,$vars,&$errors) {
global $cfg;
$tpl=null;
$vars['name']=Format::striptags(trim($vars['name']));
if($id && $id!=$vars['id'])
$errors['err']='Internal error. Try again';
if(!$vars['name'])
$errors['name']='Name required';
elseif(($tid=Template::getIdByName($vars['name'])) && $tid!=$id)
$errors['name']='Template name already exists';
if(!$id && (!$vars['tpl_id'] || !($tpl=Template::lookup($vars['tpl_id']))))
$errors['tpl_id']='Selection required';
if($errors) return false;
$sql=' updated=NOW() '
.' ,name='.db_input($vars['name'])
.' ,isactive='.db_input($vars['isactive'])
.' ,notes='.db_input($vars['notes']);
if($id) {
$sql='UPDATE '.EMAIL_TEMPLATE_TABLE.' SET '.$sql.' WHERE tpl_id='.db_input($id);
if(db_query($sql))
return true;
$errors['err']='Unable to update the template. Internal error occurred';
}elseif($tpl && ($info=$tpl->getInfo())){
$sql='INSERT INTO '.EMAIL_TEMPLATE_TABLE.' SET '.$sql
.' ,created=NOW() '
.' ,cfg_id='.db_input($cfg->getId())
.' ,ticket_autoresp_subj='.db_input($info['ticket_autoresp_subj'])
.' ,ticket_autoresp_body='.db_input($info['ticket_autoresp_body'])
.' ,ticket_notice_subj='.db_input($info['ticket_notice_subj'])
.' ,ticket_notice_body='.db_input($info['ticket_notice_body'])
.' ,ticket_alert_subj='.db_input($info['ticket_alert_subj'])
.' ,ticket_alert_body='.db_input($info['ticket_alert_body'])
.' ,message_autoresp_subj='.db_input($info['message_autoresp_subj'])
.' ,message_autoresp_body='.db_input($info['message_autoresp_body'])
.' ,message_alert_subj='.db_input($info['message_alert_subj'])
.' ,message_alert_body='.db_input($info['message_alert_body'])
.' ,note_alert_subj='.db_input($info['note_alert_subj'])
.' ,note_alert_body='.db_input($info['note_alert_body'])
.' ,assigned_alert_subj='.db_input($info['assigned_alert_subj'])
.' ,assigned_alert_body='.db_input($info['assigned_alert_body'])
.' ,ticket_overdue_subj='.db_input($info['ticket_overdue_subj'])
.' ,ticket_overdue_body='.db_input($info['ticket_overdue_body'])
.' ,ticket_overlimit_subj='.db_input($info['ticket_overlimit_subj'])
.' ,ticket_overlimit_body='.db_input($info['ticket_overlimit_body'])
.' ,ticket_reply_subj='.db_input($info['ticket_reply_subj'])
.' ,ticket_reply_body='.db_input($info['ticket_reply_body']);
if(db_query($sql) && ($id=db_insert_id()))
return $id;
$errors['err']='Unable to create template. Internal error';
}
return false;
}
}
?>