-
Notifications
You must be signed in to change notification settings - Fork 1
/
class.taskrecurrence.php
415 lines (348 loc) · 16.4 KB
/
class.taskrecurrence.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
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
<?php
/*
* SPDX-License-Identifier: AGPL-3.0-only
* SPDX-FileCopyrightText: Copyright 2005-2016 Zarafa Deutschland GmbH
* SPDX-FileCopyrightText: Copyright 2020-2022 grommunio GmbH
*/
class TaskRecurrence extends BaseRecurrence {
/**
* Timezone info which is always false for task.
*
* @var false
*/
public $tz = false;
private $action;
public function __construct($store, $message) {
$this->store = $store;
$this->message = $message;
$properties = [];
$properties["entryid"] = PR_ENTRYID;
$properties["parent_entryid"] = PR_PARENT_ENTRYID;
$properties["icon_index"] = PR_ICON_INDEX;
$properties["message_class"] = PR_MESSAGE_CLASS;
$properties["message_flags"] = PR_MESSAGE_FLAGS;
$properties["subject"] = PR_SUBJECT;
$properties["importance"] = PR_IMPORTANCE;
$properties["sensitivity"] = PR_SENSITIVITY;
$properties["last_modification_time"] = PR_LAST_MODIFICATION_TIME;
$properties["status"] = "PT_LONG:PSETID_Task:" . PidLidTaskStatus;
$properties["percent_complete"] = "PT_DOUBLE:PSETID_Task:" . PidLidPercentComplete;
$properties["startdate"] = "PT_SYSTIME:PSETID_Task:" . PidLidTaskStartDate;
$properties["duedate"] = "PT_SYSTIME:PSETID_Task:" . PidLidTaskDueDate;
$properties["reset_reminder"] = "PT_BOOLEAN:PSETID_Task:0x8107";
$properties["dead_occurrence"] = "PT_BOOLEAN:PSETID_Task:0x8109";
$properties["datecompleted"] = "PT_SYSTIME:PSETID_Task:" . PidLidTaskDateCompleted;
$properties["recurring_data"] = "PT_BINARY:PSETID_Task:0x8116";
$properties["actualwork"] = "PT_LONG:PSETID_Task:0x8110";
$properties["totalwork"] = "PT_LONG:PSETID_Task:0x8111";
$properties["complete"] = "PT_BOOLEAN:PSETID_Task:" . PidLidTaskComplete;
$properties["task_f_creator"] = "PT_BOOLEAN:PSETID_Task:0x811e";
$properties["owner"] = "PT_STRING8:PSETID_Task:0x811f";
$properties["recurring"] = "PT_BOOLEAN:PSETID_Task:0x8126";
$properties["reminder_minutes"] = "PT_LONG:PSETID_Common:" . PidLidReminderDelta;
$properties["reminder_time"] = "PT_SYSTIME:PSETID_Common:" . PidLidReminderTime;
$properties["reminder"] = "PT_BOOLEAN:PSETID_Common:" . PidLidReminderSet;
$properties["private"] = "PT_BOOLEAN:PSETID_Common:" . PidLidPrivate;
$properties["contacts"] = "PT_MV_STRING8:PSETID_Common:0x853a";
$properties["contacts_string"] = "PT_STRING8:PSETID_Common:0x8586";
$properties["categories"] = "PT_MV_STRING8:PS_PUBLIC_STRINGS:Keywords";
$properties["commonstart"] = "PT_SYSTIME:PSETID_Common:0x8516";
$properties["commonend"] = "PT_SYSTIME:PSETID_Common:0x8517";
$properties["commonassign"] = "PT_LONG:PSETID_Common:0x8518";
$properties["flagdueby"] = "PT_SYSTIME:PSETID_Common:" . PidLidReminderSignalTime;
$properties["side_effects"] = "PT_LONG:PSETID_Common:0x8510";
$this->proptags = getPropIdsFromStrings($store, $properties);
parent::__construct($store, $message);
}
/**
* Function which saves recurrence and also regenerates task if necessary.
*
* @param mixed $recur new recurrence properties
*
* @return array|bool of properties of regenerated task else false
*/
public function setRecurrence(&$recur) {
$this->recur = $recur;
$this->action = &$recur;
if (!isset($this->recur["changed_occurrences"])) {
$this->recur["changed_occurrences"] = [];
}
if (!isset($this->recur["deleted_occurrences"])) {
$this->recur["deleted_occurrences"] = [];
}
if (!isset($this->recur['startocc'])) {
$this->recur['startocc'] = 0;
}
if (!isset($this->recur['endocc'])) {
$this->recur['endocc'] = 0;
}
// Save recurrence because we need proper startrecurrdate and endrecurrdate
$this->saveRecurrence();
// Update $this->recur with proper startrecurrdate and endrecurrdate updated after saving recurrence
$msgProps = mapi_getprops($this->message, [$this->proptags['recurring_data']]);
$recurring_data = $this->parseRecurrence($msgProps[$this->proptags['recurring_data']]);
foreach ($recurring_data as $key => $value) {
$this->recur[$key] = $value;
}
$this->setFirstOccurrence();
// Let's see if next occurrence has to be generated
return $this->moveToNextOccurrence();
}
/**
* Sets task object to first occurrence if startdate/duedate of task object is different from first occurrence.
*/
public function setFirstOccurrence() {
// Check if it is already the first occurrence
if ($this->action['start'] == $this->recur["start"]) {
return;
}
$items = $this->getNextOccurrence();
$props = [];
$props[$this->proptags['startdate']] = $items[$this->proptags['startdate']];
$props[$this->proptags['commonstart']] = $items[$this->proptags['startdate']];
$props[$this->proptags['duedate']] = $items[$this->proptags['duedate']];
$props[$this->proptags['commonend']] = $items[$this->proptags['duedate']];
mapi_setprops($this->message, $props);
}
/**
* Function which creates new task as current occurrence and moves the
* existing task to next occurrence.
*
* @return array|bool properties of newly created task if moving to next occurrence succeeds
* false if that was last occurrence
*/
public function moveToNextOccurrence() {
$result = false;
/*
* Every recurring task should have a 'duedate'. If a recurring task is created with no start/end date
* then we create first two occurrence separately and for first occurrence recurrence has ended.
*/
if ((empty($this->action['startdate']) && empty($this->action['duedate'])) ||
($this->action['complete'] == 1) || (isset($this->action['deleteOccurrence']) && $this->action['deleteOccurrence'])) {
$nextOccurrence = $this->getNextOccurrence();
$result = mapi_getprops($this->message, [PR_ENTRYID, PR_PARENT_ENTRYID, PR_STORE_ENTRYID]);
$props = [];
if (!empty($nextOccurrence)) {
if (!isset($this->action['deleteOccurrence'])) {
// Create current occurrence as separate task
$result = $this->regenerateTask($this->action['complete']);
}
// Set reminder for next occurrence
$this->setReminder($nextOccurrence);
// Update properties for next occurrence
$this->action['duedate'] = $props[$this->proptags['duedate']] = $nextOccurrence[$this->proptags['duedate']];
$this->action['commonend'] = $props[$this->proptags['commonend']] = $nextOccurrence[$this->proptags['duedate']];
$this->action['startdate'] = $props[$this->proptags['startdate']] = $nextOccurrence[$this->proptags['startdate']];
$this->action['commonstart'] = $props[$this->proptags['commonstart']] = $nextOccurrence[$this->proptags['startdate']];
// If current task as been mark as 'Complete' then next occurrence should be incomplete.
if (isset($this->action['complete']) && $this->action['complete'] == 1) {
$this->action['status'] = $props[$this->proptags["status"]] = olTaskNotStarted;
$this->action['complete'] = $props[$this->proptags["complete"]] = false;
$this->action['percent_complete'] = $props[$this->proptags["percent_complete"]] = 0;
}
$props[$this->proptags["dead_occurrence"]] = false;
}
else {
if (isset($this->action['deleteOccurrence']) && $this->action['deleteOccurrence']) {
return false;
}
// Didn't get next occurrence, probably this is the last one, so recurrence ends here
$props[$this->proptags["dead_occurrence"]] = true;
$props[$this->proptags["datecompleted"]] = $this->action['datecompleted'];
$props[$this->proptags["task_f_creator"]] = true;
// OL props
$props[$this->proptags["side_effects"]] = 1296;
$props[$this->proptags["icon_index"]] = 1280;
}
mapi_setprops($this->message, $props);
}
return $result;
}
/**
* Function which return properties of next occurrence.
*
* @return null|array|false|T startdate/enddate of next occurrence
*/
public function getNextOccurrence() {
if ($this->recur) {
// @TODO: fix start of range
$start = isset($this->messageprops[$this->proptags["duedate"]]) ? $this->messageprops[$this->proptags["duedate"]] : $this->action['start'];
$dayend = ($this->recur['term'] == 0x23) ? 0x7FFFFFFF : $this->dayStartOf($this->recur["end"]);
// Fix recur object
$this->recur['startocc'] = 0;
$this->recur['endocc'] = 0;
// Retrieve next occurrence
$items = $this->getItems($start, $dayend, 1);
return !empty($items) ? $items[0] : false;
}
}
/**
* Function which clones current occurrence and sets appropriate properties.
* The original recurring item is moved to next occurrence.
*
* @param bool $markComplete true if existing occurrence has to be marked complete
*/
public function regenerateTask($markComplete) {
// Get all properties
$taskItemProps = mapi_getprops($this->message);
if (isset($this->action["subject"])) {
$taskItemProps[$this->proptags["subject"]] = $this->action["subject"];
}
if (isset($this->action["importance"])) {
$taskItemProps[$this->proptags["importance"]] = $this->action["importance"];
}
if (isset($this->action["startdate"])) {
$taskItemProps[$this->proptags["startdate"]] = $this->action["startdate"];
$taskItemProps[$this->proptags["commonstart"]] = $this->action["startdate"];
}
if (isset($this->action["duedate"])) {
$taskItemProps[$this->proptags["duedate"]] = $this->action["duedate"];
$taskItemProps[$this->proptags["commonend"]] = $this->action["duedate"];
}
$folder = mapi_msgstore_openentry($this->store, $taskItemProps[PR_PARENT_ENTRYID]);
$newMessage = mapi_folder_createmessage($folder);
$taskItemProps[$this->proptags["status"]] = $markComplete ? olTaskComplete : olTaskNotStarted;
$taskItemProps[$this->proptags["complete"]] = $markComplete;
$taskItemProps[$this->proptags["percent_complete"]] = $markComplete ? 1 : 0;
// This occurrence has been marked as 'Complete' so disable reminder
if ($markComplete) {
$taskItemProps[$this->proptags["reset_reminder"]] = false;
$taskItemProps[$this->proptags["reminder"]] = false;
$taskItemProps[$this->proptags["datecompleted"]] = $this->action["datecompleted"];
unset($this->action[$this->proptags['datecompleted']]);
}
// Recurrence ends for this item
$taskItemProps[$this->proptags["dead_occurrence"]] = true;
$taskItemProps[$this->proptags["task_f_creator"]] = true;
// OL props
$taskItemProps[$this->proptags["side_effects"]] = 1296;
$taskItemProps[$this->proptags["icon_index"]] = 1280;
// Copy recipients
$recipienttable = mapi_message_getrecipienttable($this->message);
$recipients = mapi_table_queryallrows($recipienttable, [PR_ENTRYID, PR_DISPLAY_NAME, PR_EMAIL_ADDRESS, PR_RECIPIENT_ENTRYID, PR_RECIPIENT_TYPE, PR_SEND_INTERNET_ENCODING, PR_SEND_RICH_INFO, PR_RECIPIENT_DISPLAY_NAME, PR_ADDRTYPE, PR_DISPLAY_TYPE, PR_RECIPIENT_TRACKSTATUS, PR_RECIPIENT_TRACKSTATUS_TIME, PR_RECIPIENT_FLAGS, PR_ROWID]);
$copy_to_recipientTable = mapi_message_getrecipienttable($newMessage);
$copy_to_recipientRows = mapi_table_queryallrows($copy_to_recipientTable, [PR_ROWID]);
foreach ($copy_to_recipientRows as $recipient) {
mapi_message_modifyrecipients($newMessage, MODRECIP_REMOVE, [$recipient]);
}
mapi_message_modifyrecipients($newMessage, MODRECIP_ADD, $recipients);
// Copy attachments
$attachmentTable = mapi_message_getattachmenttable($this->message);
if ($attachmentTable) {
$attachments = mapi_table_queryallrows($attachmentTable, [PR_ATTACH_NUM, PR_ATTACH_SIZE, PR_ATTACH_LONG_FILENAME, PR_ATTACHMENT_HIDDEN, PR_DISPLAY_NAME, PR_ATTACH_METHOD]);
foreach ($attachments as $attach_props) {
$attach_old = mapi_message_openattach($this->message, (int) $attach_props[PR_ATTACH_NUM]);
$attach_newResourceMsg = mapi_message_createattach($newMessage);
mapi_copyto($attach_old, [], [], $attach_newResourceMsg, 0);
mapi_savechanges($attach_newResourceMsg);
}
}
mapi_setprops($newMessage, $taskItemProps);
mapi_savechanges($newMessage);
// Update body of original message
$msgbody = mapi_openproperty($this->message, PR_BODY);
$msgbody = trim($msgbody, "\0");
$separator = "------------\r\n";
if (!empty($msgbody) && strrpos($msgbody, $separator) === false) {
$msgbody = $separator . $msgbody;
$stream = mapi_openproperty($this->message, PR_BODY, IID_IStream, STGM_TRANSACTED, 0);
mapi_stream_setsize($stream, strlen($msgbody));
mapi_stream_write($stream, $msgbody);
mapi_stream_commit($stream);
}
// We need these properties to notify client
return mapi_getprops($newMessage, [PR_ENTRYID, PR_PARENT_ENTRYID, PR_STORE_ENTRYID]);
}
/**
* processOccurrenceItem, adds an item to a list of occurrences, but only if the
* resulting occurrence starts or ends in the interval <$start, $end>.
*
* @param array $items reference to the array to be added to
* @param int $start start of timeframe in GMT TIME
* @param int $end end of timeframe in GMT TIME
* @param int $basedate (hour/sec/min assumed to be 00:00:00) in LOCAL TIME OF THE OCCURRENCE
* @param int $startocc start of occurrence since beginning of day in minutes
* @param int $endocc end of occurrence since beginning of day in minutes
* @param int $tz the timezone info for this occurrence ( applied to $basedate / $startocc / $endocc )
* @param bool $reminderonly If TRUE, only add the item if the reminder is set
*/
public function processOccurrenceItem(&$items, $start, $end, $basedate, $startocc, $endocc, $tz, $reminderonly) {
if ($basedate > $start) {
$newItem = [];
$newItem[$this->proptags['startdate']] = $basedate;
// If startdate and enddate are set on task, then slide enddate according to duration
if (isset($this->messageprops[$this->proptags["startdate"]], $this->messageprops[$this->proptags["duedate"]])) {
$newItem[$this->proptags['duedate']] = $newItem[$this->proptags['startdate']] + ($this->messageprops[$this->proptags["duedate"]] - $this->messageprops[$this->proptags["startdate"]]);
}
else {
$newItem[$this->proptags['duedate']] = $newItem[$this->proptags['startdate']];
}
$items[] = $newItem;
}
}
/**
* Function which marks existing occurrence to 'Complete'.
*
* @param array $recur array action from client
*
* @return array|bool of properties of regenerated task else false
*/
public function markOccurrenceComplete(&$recur) {
// Fix timezone object
$this->tz = false;
$this->action = &$recur;
$dead_occurrence = isset($this->messageprops[$this->proptags['dead_occurrence']]) ? $this->messageprops[$this->proptags['dead_occurrence']] : false;
if (!$dead_occurrence) {
return $this->moveToNextOccurrence();
}
return false;
}
/**
* Function which sets reminder on recurring task after existing occurrence has been deleted or marked complete.
*
* @param mixed $nextOccurrence properties of next occurrence
*/
public function setReminder($nextOccurrence): void {
$props = [];
if (!empty($nextOccurrence)) {
// Check if reminder is reset. Default is 'false'
$reset_reminder = isset($this->messageprops[$this->proptags['reset_reminder']]) ? $this->messageprops[$this->proptags['reset_reminder']] : false;
$reminder = $this->messageprops[$this->proptags['reminder']];
// Either reminder was already set OR reminder was set but was dismissed bty user
if ($reminder || $reset_reminder) {
// Reminder can be set at any time either before or after the duedate, so get duration between the reminder time and duedate
$reminder_time = isset($this->messageprops[$this->proptags['reminder_time']]) ? $this->messageprops[$this->proptags['reminder_time']] : 0;
$reminder_difference = isset($this->messageprops[$this->proptags['duedate']]) ? $this->messageprops[$this->proptags['duedate']] : 0;
$reminder_difference = $reminder_difference - $reminder_time;
// Apply duration to next calculated duedate
$next_reminder_time = $nextOccurrence[$this->proptags['duedate']] - $reminder_difference;
$props[$this->proptags['reminder_time']] = $next_reminder_time;
$props[$this->proptags['flagdueby']] = $next_reminder_time;
$this->action['reminder'] = $props[$this->proptags['reminder']] = true;
}
}
else {
// Didn't get next occurrence, probably this is the last occurrence
$props[$this->proptags['reminder']] = false;
$props[$this->proptags['reset_reminder']] = false;
}
if (!empty($props)) {
mapi_setprops($this->message, $props);
}
}
/**
* Function which recurring task to next occurrence.
* It simply doesn't regenerate task.
*
* @param array $action
*
* @return array|bool
*/
public function deleteOccurrence($action) {
$this->tz = false;
$this->action = $action;
$result = $this->moveToNextOccurrence();
mapi_savechanges($this->message);
return $result;
}
}