grommunio /
mapi-header-php
| Total Complexity | 187 |
| Total Lines | 1438 |
| Duplicated Lines | 0 % |
| Changes | 6 | ||
| Bugs | 1 | Features | 0 |
Complex classes like Recurrence often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Recurrence, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 12 | class Recurrence extends BaseRecurrence { |
||
| 13 | /* |
||
| 14 | * ABOUT TIMEZONES |
||
| 15 | * |
||
| 16 | * Timezones are rather complicated here so here are some rules to think about: |
||
| 17 | * |
||
| 18 | * - Timestamps in mapi-like properties (so in PT_SYSTIME properties) are always in GMT (including |
||
| 19 | * the 'basedate' property in exceptions !!) |
||
| 20 | * - Timestamps for recurrence (so start/end of recurrence, and basedates for exceptions (everything |
||
| 21 | * outside the 'basedate' property in the exception !!), and start/endtimes for exceptions) are |
||
| 22 | * always in LOCAL time. |
||
| 23 | */ |
||
| 24 | |||
| 25 | // All properties for a recipient that are interesting |
||
| 26 | public $recipprops = [ |
||
| 27 | PR_ENTRYID, |
||
| 28 | PR_SEARCH_KEY, |
||
| 29 | PR_DISPLAY_NAME, |
||
| 30 | PR_EMAIL_ADDRESS, |
||
| 31 | PR_RECIPIENT_ENTRYID, |
||
| 32 | PR_RECIPIENT_TYPE, |
||
| 33 | PR_SEND_INTERNET_ENCODING, |
||
| 34 | PR_SEND_RICH_INFO, |
||
| 35 | PR_RECIPIENT_DISPLAY_NAME, |
||
| 36 | PR_ADDRTYPE, |
||
| 37 | PR_DISPLAY_TYPE, |
||
| 38 | PR_DISPLAY_TYPE_EX, |
||
| 39 | PR_RECIPIENT_TRACKSTATUS, |
||
| 40 | PR_RECIPIENT_TRACKSTATUS_TIME, |
||
| 41 | PR_RECIPIENT_FLAGS, |
||
| 42 | PR_ROWID, |
||
| 43 | ]; |
||
| 44 | |||
| 45 | /** |
||
| 46 | * Constructor. |
||
| 47 | * |
||
| 48 | * @param resource $store MAPI Message Store Object |
||
| 49 | * @param mixed $message the MAPI (appointment) message |
||
| 50 | * @param array $proptags an associative array of protags and their values |
||
| 51 | */ |
||
| 52 | public function __construct($store, $message, $proptags = []) { |
||
| 53 | if (!empty($proptags)) { |
||
| 54 | $this->proptags = $proptags; |
||
| 55 | } |
||
| 56 | else { |
||
| 57 | $properties = []; |
||
| 58 | $properties["entryid"] = PR_ENTRYID; |
||
| 59 | $properties["parent_entryid"] = PR_PARENT_ENTRYID; |
||
| 60 | $properties["message_class"] = PR_MESSAGE_CLASS; |
||
| 61 | $properties["icon_index"] = PR_ICON_INDEX; |
||
| 62 | $properties["subject"] = PR_SUBJECT; |
||
| 63 | $properties["display_to"] = PR_DISPLAY_TO; |
||
| 64 | $properties["importance"] = PR_IMPORTANCE; |
||
| 65 | $properties["sensitivity"] = PR_SENSITIVITY; |
||
| 66 | $properties["startdate"] = "PT_SYSTIME:PSETID_Appointment:" . PidLidAppointmentStartWhole; |
||
| 67 | $properties["duedate"] = "PT_SYSTIME:PSETID_Appointment:" . PidLidAppointmentEndWhole; |
||
| 68 | $properties["recurring"] = "PT_BOOLEAN:PSETID_Appointment:" . PidLidRecurring; |
||
| 69 | $properties["recurring_data"] = "PT_BINARY:PSETID_Appointment:" . PidLidAppointmentRecur; |
||
| 70 | $properties["busystatus"] = "PT_LONG:PSETID_Appointment:" . PidLidBusyStatus; |
||
| 71 | $properties["label"] = "PT_LONG:PSETID_Appointment:0x8214"; |
||
| 72 | $properties["alldayevent"] = "PT_BOOLEAN:PSETID_Appointment:" . PidLidAppointmentSubType; |
||
| 73 | $properties["private"] = "PT_BOOLEAN:PSETID_Common:" . PidLidPrivate; |
||
| 74 | $properties["meeting"] = "PT_LONG:PSETID_Appointment:" . PidLidAppointmentStateFlags; |
||
| 75 | $properties["startdate_recurring"] = "PT_SYSTIME:PSETID_Appointment:" . PidLidClipStart; |
||
| 76 | $properties["enddate_recurring"] = "PT_SYSTIME:PSETID_Appointment:" . PidLidClipEnd; |
||
| 77 | $properties["recurring_pattern"] = "PT_STRING8:PSETID_Appointment:" . PidLidRecurrencePattern; |
||
| 78 | $properties["location"] = "PT_STRING8:PSETID_Appointment:" . PidLidLocation; |
||
| 79 | $properties["duration"] = "PT_LONG:PSETID_Appointment:" . PidLidAppointmentDuration; |
||
| 80 | $properties["responsestatus"] = "PT_LONG:PSETID_Appointment:0x8218"; |
||
| 81 | $properties["reminder"] = "PT_BOOLEAN:PSETID_Common:" . PidLidReminderSet; |
||
| 82 | $properties["reminder_minutes"] = "PT_LONG:PSETID_Common:" . PidLidReminderDelta; |
||
| 83 | $properties["recurrencetype"] = "PT_LONG:PSETID_Appointment:0x8231"; |
||
| 84 | $properties["contacts"] = "PT_MV_STRING8:PSETID_Common:0x853a"; |
||
| 85 | $properties["contacts_string"] = "PT_STRING8:PSETID_Common:0x8586"; |
||
| 86 | $properties["categories"] = "PT_MV_STRING8:PS_PUBLIC_STRINGS:Keywords"; |
||
| 87 | $properties["reminder_time"] = "PT_SYSTIME:PSETID_Common:" . PidLidReminderTime; |
||
| 88 | $properties["commonstart"] = "PT_SYSTIME:PSETID_Common:0x8516"; |
||
| 89 | $properties["commonend"] = "PT_SYSTIME:PSETID_Common:0x8517"; |
||
| 90 | $properties["basedate"] = "PT_SYSTIME:PSETID_Appointment:" . PidLidExceptionReplaceTime; |
||
| 91 | $properties["timezone_data"] = "PT_BINARY:PSETID_Appointment:" . PidLidTimeZoneStruct; |
||
| 92 | $properties["timezone"] = "PT_STRING8:PSETID_Appointment:" . PidLidTimeZoneDescription; |
||
| 93 | $properties["flagdueby"] = "PT_SYSTIME:PSETID_Common:" . PidLidReminderSignalTime; |
||
| 94 | $properties["side_effects"] = "PT_LONG:PSETID_Common:0x8510"; |
||
| 95 | $properties["hideattachments"] = "PT_BOOLEAN:PSETID_Common:" . PidLidSmartNoAttach; |
||
| 96 | $properties['meetingrecurring'] = "PT_BOOLEAN:PSETID_Meeting:" . PidLidIsRecurring; |
||
| 97 | |||
| 98 | $this->proptags = getPropIdsFromStrings($store, $properties); |
||
| 99 | } |
||
| 100 | |||
| 101 | parent::__construct($store, $message); |
||
| 102 | } |
||
| 103 | |||
| 104 | /** |
||
| 105 | * Create an exception. |
||
| 106 | * |
||
| 107 | * @param array $exception_props the exception properties (same properties as normal recurring items) |
||
| 108 | * @param mixed $base_date the base date of the exception (LOCAL time of non-exception occurrence) |
||
| 109 | * @param bool $delete true - delete occurrence, false - create new exception or modify existing |
||
| 110 | * @param array $exception_recips list of recipients |
||
| 111 | * @param mixed $copy_attach_from mapi message from which attachments should be copied |
||
| 112 | */ |
||
| 113 | public function createException($exception_props, $base_date, $delete = false, $exception_recips = [], $copy_attach_from = false): bool { |
||
| 114 | $baseday = $this->dayStartOf($base_date); |
||
| 115 | $basetime = $baseday + $this->recur["startocc"] * 60; |
||
| 116 | |||
| 117 | // Remove any pre-existing exception on this base date |
||
| 118 | if ($this->isException($baseday)) { |
||
| 119 | $this->deleteException($baseday); // note that deleting an exception is different from creating a deleted exception (deleting an occurrence). |
||
| 120 | } |
||
| 121 | |||
| 122 | if (!$delete) { |
||
| 123 | if (isset($exception_props[$this->proptags["startdate"]]) && !$this->isValidExceptionDate($base_date, $this->fromGMT($this->tz, $exception_props[$this->proptags["startdate"]]))) { |
||
| 124 | return false; |
||
| 125 | } |
||
| 126 | $changed_item = []; |
||
| 127 | // Properties in the attachment are the properties of the base object, plus $exception_props plus the base date |
||
| 128 | foreach (["subject", "location", "label", "reminder", "reminder_minutes", "alldayevent", "busystatus"] as $propname) { |
||
| 129 | if (isset($this->messageprops[$this->proptags[$propname]])) { |
||
| 130 | $props[$this->proptags[$propname]] = $this->messageprops[$this->proptags[$propname]]; |
||
| 131 | if (isset($exception_props[$this->proptags[$propname]]) && |
||
| 132 | $this->messageprops[$this->proptags[$propname]] != $exception_props[$this->proptags[$propname]]) { |
||
| 133 | $changed_item[$propname] = $exception_props[$this->proptags[$propname]]; |
||
| 134 | } |
||
| 135 | } |
||
| 136 | elseif (isset($exception_props[$this->proptags[$propname]])) { |
||
| 137 | $changed_item[$propname] = $exception_props[$this->proptags[$propname]]; |
||
| 138 | } |
||
| 139 | } |
||
| 140 | |||
| 141 | $props[PR_MESSAGE_CLASS] = "IPM.OLE.CLASS.{00061055-0000-0000-C000-000000000046}"; |
||
| 142 | unset($exception_props[PR_MESSAGE_CLASS], $exception_props[PR_ICON_INDEX]); |
||
| 143 | |||
| 144 | $props = $exception_props + $props; |
||
|
Comprehensibility
Best Practice
introduced
by
|
|||
| 145 | |||
| 146 | // Basedate in the exception attachment is the GMT time at which the original occurrence would have been |
||
| 147 | $props[$this->proptags["basedate"]] = $this->toGMT($this->tz, $basetime); |
||
| 148 | |||
| 149 | if (!isset($exception_props[$this->proptags["startdate"]])) { |
||
| 150 | $props[$this->proptags["startdate"]] = $this->getOccurrenceStart($base_date); |
||
| 151 | } |
||
| 152 | |||
| 153 | if (!isset($exception_props[$this->proptags["duedate"]])) { |
||
| 154 | $props[$this->proptags["duedate"]] = $this->getOccurrenceEnd($base_date); |
||
| 155 | } |
||
| 156 | |||
| 157 | // synchronize commonstart/commonend with startdate/duedate |
||
| 158 | if (isset($props[$this->proptags["startdate"]])) { |
||
| 159 | $props[$this->proptags["commonstart"]] = $props[$this->proptags["startdate"]]; |
||
| 160 | } |
||
| 161 | |||
| 162 | if (isset($props[$this->proptags["duedate"]])) { |
||
| 163 | $props[$this->proptags["commonend"]] = $props[$this->proptags["duedate"]]; |
||
| 164 | } |
||
| 165 | |||
| 166 | // Save the data into an attachment |
||
| 167 | $this->createExceptionAttachment($props, $exception_recips, $copy_attach_from); |
||
| 168 | |||
| 169 | $changed_item["basedate"] = $baseday; |
||
| 170 | $changed_item["start"] = $this->fromGMT($this->tz, $props[$this->proptags["startdate"]]); |
||
| 171 | $changed_item["end"] = $this->fromGMT($this->tz, $props[$this->proptags["duedate"]]); |
||
| 172 | |||
| 173 | // Add the changed occurrence to the list |
||
| 174 | array_push($this->recur["changed_occurrences"], $changed_item); |
||
| 175 | } |
||
| 176 | else { |
||
| 177 | // Delete the occurrence by placing it in the deleted occurrences list |
||
| 178 | array_push($this->recur["deleted_occurrences"], $baseday); |
||
| 179 | } |
||
| 180 | |||
| 181 | // Turn on hideattachments, because the attachments in this item are the exceptions |
||
| 182 | mapi_setprops($this->message, [$this->proptags["hideattachments"] => true]); |
||
| 183 | |||
| 184 | // Save recurrence data to message |
||
| 185 | $this->saveRecurrence(); |
||
| 186 | |||
| 187 | return true; |
||
| 188 | } |
||
| 189 | |||
| 190 | /** |
||
| 191 | * Modifies an existing exception, but only updates the given properties |
||
| 192 | * NOTE: You can't remove properties from an exception, only add new ones. |
||
| 193 | * |
||
| 194 | * @param mixed $exception_props |
||
| 195 | * @param mixed $base_date |
||
| 196 | * @param mixed $exception_recips |
||
| 197 | * @param mixed $copy_attach_from |
||
| 198 | */ |
||
| 199 | public function modifyException($exception_props, $base_date, $exception_recips = [], $copy_attach_from = false): bool { |
||
| 200 | if (isset($exception_props[$this->proptags["startdate"]]) && !$this->isValidExceptionDate($base_date, $this->fromGMT($this->tz, $exception_props[$this->proptags["startdate"]]))) { |
||
| 201 | return false; |
||
| 202 | } |
||
| 203 | |||
| 204 | $baseday = $this->dayStartOf($base_date); |
||
| 205 | $extomodify = false; |
||
| 206 | |||
| 207 | for ($i = 0, $len = count($this->recur["changed_occurrences"]); $i < $len; ++$i) { |
||
| 208 | if ($this->isSameDay($this->recur["changed_occurrences"][$i]["basedate"], $baseday)) { |
||
| 209 | $extomodify = &$this->recur["changed_occurrences"][$i]; |
||
| 210 | break; |
||
| 211 | } |
||
| 212 | } |
||
| 213 | |||
| 214 | if (!$extomodify) { |
||
| 215 | return false; |
||
| 216 | } |
||
| 217 | |||
| 218 | // remove basedate property as we want to preserve the old value |
||
| 219 | // client will send basedate with time part as zero, so discard that value |
||
| 220 | unset($exception_props[$this->proptags["basedate"]]); |
||
| 221 | |||
| 222 | if (array_key_exists($this->proptags["startdate"], $exception_props)) { |
||
| 223 | $extomodify["start"] = $this->fromGMT($this->tz, $exception_props[$this->proptags["startdate"]]); |
||
| 224 | } |
||
| 225 | |||
| 226 | if (array_key_exists($this->proptags["duedate"], $exception_props)) { |
||
| 227 | $extomodify["end"] = $this->fromGMT($this->tz, $exception_props[$this->proptags["duedate"]]); |
||
| 228 | } |
||
| 229 | |||
| 230 | if (array_key_exists($this->proptags["subject"], $exception_props)) { |
||
| 231 | $extomodify["subject"] = $exception_props[$this->proptags["subject"]]; |
||
| 232 | } |
||
| 233 | |||
| 234 | if (array_key_exists($this->proptags["location"], $exception_props)) { |
||
| 235 | $extomodify["location"] = $exception_props[$this->proptags["location"]]; |
||
| 236 | } |
||
| 237 | |||
| 238 | if (array_key_exists($this->proptags["label"], $exception_props)) { |
||
| 239 | $extomodify["label"] = $exception_props[$this->proptags["label"]]; |
||
| 240 | } |
||
| 241 | |||
| 242 | if (array_key_exists($this->proptags["reminder"], $exception_props)) { |
||
| 243 | $extomodify["reminder_set"] = $exception_props[$this->proptags["reminder"]]; |
||
| 244 | } |
||
| 245 | |||
| 246 | if (array_key_exists($this->proptags["reminder_minutes"], $exception_props)) { |
||
| 247 | $extomodify["remind_before"] = $exception_props[$this->proptags["reminder_minutes"]]; |
||
| 248 | } |
||
| 249 | |||
| 250 | if (array_key_exists($this->proptags["alldayevent"], $exception_props)) { |
||
| 251 | $extomodify["alldayevent"] = $exception_props[$this->proptags["alldayevent"]]; |
||
| 252 | } |
||
| 253 | |||
| 254 | if (array_key_exists($this->proptags["busystatus"], $exception_props)) { |
||
| 255 | $extomodify["busystatus"] = $exception_props[$this->proptags["busystatus"]]; |
||
| 256 | } |
||
| 257 | |||
| 258 | $exception_props[PR_MESSAGE_CLASS] = "IPM.OLE.CLASS.{00061055-0000-0000-C000-000000000046}"; |
||
| 259 | |||
| 260 | // synchronize commonstart/commonend with startdate/duedate |
||
| 261 | if (isset($exception_props[$this->proptags["startdate"]])) { |
||
| 262 | $exception_props[$this->proptags["commonstart"]] = $exception_props[$this->proptags["startdate"]]; |
||
| 263 | } |
||
| 264 | |||
| 265 | if (isset($exception_props[$this->proptags["duedate"]])) { |
||
| 266 | $exception_props[$this->proptags["commonend"]] = $exception_props[$this->proptags["duedate"]]; |
||
| 267 | } |
||
| 268 | |||
| 269 | $attach = $this->getExceptionAttachment($baseday); |
||
| 270 | if (!$attach) { |
||
| 271 | if ($copy_attach_from) { |
||
| 272 | $this->deleteExceptionAttachment($base_date); |
||
| 273 | $this->createException($exception_props, $base_date, false, $exception_recips, $copy_attach_from); |
||
| 274 | } |
||
| 275 | else { |
||
| 276 | $this->createExceptionAttachment($exception_props, $exception_recips, $copy_attach_from); |
||
| 277 | } |
||
| 278 | } |
||
| 279 | else { |
||
| 280 | $message = mapi_attach_openobj($attach, MAPI_MODIFY); |
||
| 281 | |||
| 282 | // Set exception properties on embedded message and save |
||
| 283 | mapi_setprops($message, $exception_props); |
||
| 284 | $this->setExceptionRecipients($message, $exception_recips, false); |
||
| 285 | mapi_savechanges($message); |
||
| 286 | |||
| 287 | // If a new start or duedate is provided, we update the properties 'PR_EXCEPTION_STARTTIME' and 'PR_EXCEPTION_ENDTIME' |
||
| 288 | // on the attachment which holds the embedded msg and save everything. |
||
| 289 | $props = []; |
||
| 290 | if (isset($exception_props[$this->proptags["startdate"]])) { |
||
| 291 | $props[PR_EXCEPTION_STARTTIME] = $this->fromGMT($this->tz, $exception_props[$this->proptags["startdate"]]); |
||
| 292 | } |
||
| 293 | if (isset($exception_props[$this->proptags["duedate"]])) { |
||
| 294 | $props[PR_EXCEPTION_ENDTIME] = $this->fromGMT($this->tz, $exception_props[$this->proptags["duedate"]]); |
||
| 295 | } |
||
| 296 | if (!empty($props)) { |
||
| 297 | mapi_setprops($attach, $props); |
||
| 298 | } |
||
| 299 | |||
| 300 | mapi_savechanges($attach); |
||
| 301 | } |
||
| 302 | |||
| 303 | // Save recurrence data to message |
||
| 304 | $this->saveRecurrence(); |
||
| 305 | |||
| 306 | return true; |
||
| 307 | } |
||
| 308 | |||
| 309 | // Checks to see if the following is true: |
||
| 310 | // 1) The exception to be created doesn't create two exceptions starting on one day (however, they can END on the same day by modifying duration) |
||
| 311 | // 2) The exception to be created doesn't 'jump' over another occurrence (which may be an exception itself!) |
||
| 312 | // |
||
| 313 | // Both $basedate and $start are in LOCAL time |
||
| 314 | public function isValidExceptionDate($basedate, $start): bool { |
||
| 315 | // The way we do this is to look at the days that we're 'moving' the item in the exception. Each |
||
| 316 | // of these days may only contain the item that we're modifying. Any other item violates the rules. |
||
| 317 | |||
| 318 | if ($this->isException($basedate)) { |
||
| 319 | // If we're modifying an exception, we want to look at the days that we're 'moving' compared to where |
||
| 320 | // the exception used to be. |
||
| 321 | $oldexception = $this->getChangeException($basedate); |
||
| 322 | $prevday = $this->dayStartOf($oldexception["start"]); |
||
| 323 | } |
||
| 324 | else { |
||
| 325 | // If its a new exception, we want to look at the original placement of this item. |
||
| 326 | $prevday = $basedate; |
||
| 327 | } |
||
| 328 | |||
| 329 | $startday = $this->dayStartOf($start); |
||
| 330 | |||
| 331 | // Get all the occurrences on the days between the basedate (may be reversed) |
||
| 332 | if ($prevday < $startday) { |
||
| 333 | $items = $this->getItems($this->toGMT($this->tz, $prevday), $this->toGMT($this->tz, $startday + 24 * 60 * 60)); |
||
| 334 | } |
||
| 335 | else { |
||
| 336 | $items = $this->getItems($this->toGMT($this->tz, $startday), $this->toGMT($this->tz, $prevday + 24 * 60 * 60)); |
||
| 337 | } |
||
| 338 | |||
| 339 | // There should now be exactly one item, namely the item that we are modifying. If there are any other items in the range, |
||
| 340 | // then we abort the change, since one of the rules has been violated. |
||
| 341 | return count($items) == 1; |
||
| 342 | } |
||
| 343 | |||
| 344 | /** |
||
| 345 | * Check to see if the exception proposed at a certain basedate is allowed concerning reminder times:. |
||
| 346 | * |
||
| 347 | * Both must be true: |
||
| 348 | * - reminder time of this item is not before the starttime of the previous recurring item |
||
| 349 | * - reminder time of the next item is not before the starttime of this item |
||
| 350 | * |
||
| 351 | * @param date $basedate the base date of the exception (LOCAL time of non-exception occurrence) |
||
| 352 | * @param string $reminderminutes reminder minutes which is set of the item |
||
| 353 | * @param date $startdate the startdate of the selected item |
||
| 354 | * |
||
| 355 | * @returns boolean if the reminder minutes value valid (FALSE if either of the rules above are FALSE) |
||
| 356 | */ |
||
| 357 | public function isValidReminderTime($basedate, $reminderminutes, $startdate): bool { |
||
| 358 | // get all occurrence items before the selected items occurrence starttime |
||
| 359 | $occitems = $this->getItems($this->messageprops[$this->proptags["startdate"]], $this->toGMT($this->tz, $basedate)); |
||
| 360 | |||
| 361 | if (!empty($occitems)) { |
||
| 362 | // as occitems array is sorted in ascending order of startdate, to get the previous occurrence we take the last items in occitems . |
||
| 363 | $previousitem_startdate = $occitems[count($occitems) - 1][$this->proptags["startdate"]]; |
||
| 364 | |||
| 365 | // if our reminder is set before or equal to the beginning of the previous occurrence, then that's not allowed |
||
| 366 | if ($startdate - ($reminderminutes * 60) <= $previousitem_startdate) { |
||
| 367 | return false; |
||
| 368 | } |
||
| 369 | } |
||
| 370 | |||
| 371 | // Get the endtime of the current occurrence and find the next two occurrences (including the current occurrence) |
||
| 372 | $currentOcc = $this->getItems($this->toGMT($this->tz, $basedate), 0x7FF00000, 2, true); |
||
| 373 | |||
| 374 | // If there are another two occurrences, then the first is the current occurrence, and the one after that |
||
| 375 | // is the next occurrence. |
||
| 376 | if (count($currentOcc) > 1) { |
||
| 377 | $next = $currentOcc[1]; |
||
| 378 | // Get reminder time of the next occurrence. |
||
| 379 | $nextOccReminderTime = $next[$this->proptags["startdate"]] - ($next[$this->proptags["reminder_minutes"]] * 60); |
||
| 380 | // If the reminder time of the next item is before the start of this item, then that's not allowed |
||
| 381 | if ($nextOccReminderTime <= $startdate) { |
||
| 382 | return false; |
||
| 383 | } |
||
| 384 | } |
||
| 385 | |||
| 386 | // All was ok |
||
| 387 | return true; |
||
| 388 | } |
||
| 389 | |||
| 390 | public function setRecurrence($tz, $recur): void { |
||
| 391 | // only reset timezone if specified |
||
| 392 | if ($tz) { |
||
| 393 | $this->tz = $tz; |
||
| 394 | } |
||
| 395 | |||
| 396 | $this->recur = $recur; |
||
| 397 | |||
| 398 | if (!isset($this->recur["changed_occurrences"])) { |
||
| 399 | $this->recur["changed_occurrences"] = []; |
||
| 400 | } |
||
| 401 | |||
| 402 | if (!isset($this->recur["deleted_occurrences"])) { |
||
| 403 | $this->recur["deleted_occurrences"] = []; |
||
| 404 | } |
||
| 405 | |||
| 406 | $this->deleteAttachments(); |
||
| 407 | $this->saveRecurrence(); |
||
| 408 | |||
| 409 | // if client has not set the recurring_pattern then we should generate it and save it |
||
| 410 | $messageProps = mapi_getprops($this->message, [$this->proptags["recurring_pattern"]]); |
||
| 411 | if (empty($messageProps[$this->proptags["recurring_pattern"]])) { |
||
| 412 | $this->saveRecurrencePattern(); |
||
| 413 | } |
||
| 414 | } |
||
| 415 | |||
| 416 | // Returns the start or end time of the occurrence on the given base date. |
||
| 417 | // This assumes that the basedate you supply is in LOCAL time |
||
| 418 | public function getOccurrenceStart($basedate) { |
||
| 419 | $daystart = $this->dayStartOf($basedate); |
||
| 420 | |||
| 421 | return $this->toGMT($this->tz, $daystart + $this->recur["startocc"] * 60); |
||
| 422 | } |
||
| 423 | |||
| 424 | public function getOccurrenceEnd($basedate) { |
||
| 425 | $daystart = $this->dayStartOf($basedate); |
||
| 426 | |||
| 427 | return $this->toGMT($this->tz, $daystart + $this->recur["endocc"] * 60); |
||
| 428 | } |
||
| 429 | |||
| 430 | /** |
||
| 431 | * This function returns the next remindertime starting from $timestamp |
||
| 432 | * When no next reminder exists, false is returned. |
||
| 433 | * |
||
| 434 | * Note: Before saving this new reminder time (when snoozing), you must check for |
||
| 435 | * yourself if this reminder time is earlier than your snooze time, else |
||
| 436 | * use your snooze time and not this reminder time. |
||
| 437 | * |
||
| 438 | * @param mixed $timestamp |
||
| 439 | */ |
||
| 440 | public function getNextReminderTime($timestamp) { |
||
| 441 | /** |
||
| 442 | * Get next item from now until forever, but max 1 item with reminder set |
||
| 443 | * Note 0x7ff00000 instead of 0x7fffffff because of possible overflow failures when converting to GMT.... |
||
| 444 | * Here for getting next 10 occurrences assuming that next here we will be able to find |
||
| 445 | * nextreminder occurrence in 10 occurrences. |
||
| 446 | */ |
||
| 447 | $items = $this->getItems($timestamp, 0x7FF00000, 10, true); |
||
| 448 | |||
| 449 | // Initially setting nextreminder to false so when no next reminder exists, false is returned. |
||
| 450 | $nextreminder = false; |
||
| 451 | /* |
||
| 452 | * Loop through all reminder which we get in items variable |
||
| 453 | * and check whether the remindertime is greater than timestamp. |
||
| 454 | * On the first occurrence of greater nextreminder break the loop |
||
| 455 | * and return the value to calling function. |
||
| 456 | */ |
||
| 457 | for ($i = 0, $len = count($items); $i < $len; ++$i) { |
||
| 458 | $item = $items[$i]; |
||
| 459 | $tempnextreminder = $item[$this->proptags["startdate"]] - ($item[$this->proptags["reminder_minutes"]] * 60); |
||
| 460 | |||
| 461 | // If tempnextreminder is greater than timestamp then save it in nextreminder and break from the loop. |
||
| 462 | if ($tempnextreminder > $timestamp) { |
||
| 463 | $nextreminder = $tempnextreminder; |
||
| 464 | break; |
||
| 465 | } |
||
| 466 | } |
||
| 467 | |||
| 468 | return $nextreminder; |
||
| 469 | } |
||
| 470 | |||
| 471 | /** |
||
| 472 | * Note: Static function, more like a utility function. |
||
| 473 | * |
||
| 474 | * Gets all the items (including recurring items) in the specified calendar in the given timeframe. Items are |
||
| 475 | * included as a whole if they overlap the interval <$start, $end> (non-inclusive). This means that if the interval |
||
| 476 | * is <08:00 - 14:00>, the item [6:00 - 8:00> is NOT included, nor is the item [14:00 - 16:00>. However, the item |
||
| 477 | * [7:00 - 9:00> is included as a whole, and is NOT capped to [8:00 - 9:00>. |
||
| 478 | * |
||
| 479 | * @param $store resource The store in which the calendar resides |
||
| 480 | * @param $calendar resource The calendar to get the items from |
||
| 481 | * @param $viewstart int Timestamp of beginning of view window |
||
| 482 | * @param $viewend int Timestamp of end of view window |
||
| 483 | * @param $propsrequested array Array of properties to return |
||
| 484 | * |
||
| 485 | * @psalm-param list{0: mixed, 1: mixed, 2?: mixed} $propsrequested |
||
| 486 | */ |
||
| 487 | public static function getCalendarItems($store, $calendar, $viewstart, $viewend, $propsrequested) { |
||
| 488 | return getCalendarItems($store, $calendar, $viewstart, $viewend, $propsrequested); |
||
| 489 | } |
||
| 490 | |||
| 491 | /* |
||
| 492 | * CODE BELOW THIS LINE IS FOR INTERNAL USE ONLY |
||
| 493 | ***************************************************************************************************************** |
||
| 494 | */ |
||
| 495 | |||
| 496 | /** |
||
| 497 | * Returns langified daily recurrence type string, whether it's singular or plural, |
||
| 498 | * recurrence interval. |
||
| 499 | */ |
||
| 500 | public function getI18RecTypeDaily(mixed $type, mixed $interval, bool $occSingleDayRank): array { |
||
| 501 | switch ($interval) { |
||
| 502 | case 1: // workdays |
||
| 503 | $type = dgettext('zarafa', 'workday'); |
||
| 504 | $occSingleDayRank = true; |
||
| 505 | break; |
||
| 506 | |||
| 507 | case 1440: // daily |
||
| 508 | $type = dgettext('zarafa', 'day'); |
||
| 509 | $occSingleDayRank = true; |
||
| 510 | break; |
||
| 511 | |||
| 512 | default: // every $interval days |
||
| 513 | $interval /= 1440; |
||
| 514 | $type = dgettext('zarafa', 'days'); |
||
| 515 | $occSingleDayRank = false; |
||
| 516 | break; |
||
| 517 | } |
||
| 518 | |||
| 519 | return [ |
||
| 520 | 'type' => $type, |
||
| 521 | 'interval' => $interval, |
||
| 522 | 'occSingleDayRank' => boolval($occSingleDayRank), |
||
| 523 | ]; |
||
| 524 | } |
||
| 525 | |||
| 526 | /** |
||
| 527 | * Returns langified weekly recurrence type string, whether it's singular or plural, |
||
| 528 | * recurrence interval. |
||
| 529 | */ |
||
| 530 | public function getI18RecTypeWeekly(mixed $type, mixed $interval, bool $occSingleDayRank): array { |
||
| 531 | if ($interval == 1) { |
||
| 532 | $type = dgettext('zarafa', 'week'); |
||
| 533 | $occSingleDayRank = true; |
||
| 534 | } |
||
| 535 | else { |
||
| 536 | $type = dgettext('zarafa', 'weeks'); |
||
| 537 | $occSingleDayRank = false; |
||
| 538 | } |
||
| 539 | $daysOfWeek = ["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"]; |
||
| 540 | $type .= sprintf(" %s ", dgettext('zarafa', 'on')); |
||
| 541 | |||
| 542 | for ($j = 0, $weekdays = (int) $this->recur["weekdays"]; $j < 7; ++$j) { |
||
| 543 | if ($weekdays & (1 << $j)) { |
||
| 544 | $type .= sprintf("%s, ", dgettext('zarafa', $daysOfWeek[$j])); |
||
| 545 | } |
||
| 546 | } |
||
| 547 | $type = trim($type, ", "); |
||
| 548 | if (($pos = strrpos($type, ",")) !== false) { |
||
| 549 | $type = substr_replace($type, " " . dgettext('zarafa', 'and'), $pos, 1); |
||
| 550 | } |
||
| 551 | |||
| 552 | return [ |
||
| 553 | 'type' => $type, |
||
| 554 | 'interval' => $interval, |
||
| 555 | 'occSingleDayRank' => boolval($occSingleDayRank), |
||
| 556 | ]; |
||
| 557 | } |
||
| 558 | |||
| 559 | /** |
||
| 560 | * Returns langified monthly recurrence type string, whether it's singular or plural, |
||
| 561 | * recurrence interval. |
||
| 562 | */ |
||
| 563 | public function getI18RecTypeMonthly(mixed $type, mixed $interval, bool $occSingleDayRank): array { |
||
| 564 | if ($interval == 1) { |
||
| 565 | $type = dgettext('zarafa', 'month'); |
||
| 566 | $occSingleDayRank = true; |
||
| 567 | } |
||
| 568 | else { |
||
| 569 | $type = dgettext('zarafa', 'months'); |
||
| 570 | $occSingleDayRank = false; |
||
| 571 | } |
||
| 572 | |||
| 573 | return [ |
||
| 574 | 'type' => $type, |
||
| 575 | 'interval' => $interval, |
||
| 576 | 'occSingleDayRank' => boolval($occSingleDayRank), |
||
| 577 | ]; |
||
| 578 | } |
||
| 579 | |||
| 580 | /** |
||
| 581 | * Returns langified yearly recurrence type string, whether it's singular or plural, |
||
| 582 | * recurrence interval. |
||
| 583 | */ |
||
| 584 | public function getI18RecTypeYearly(mixed $type, mixed $interval, bool $occSingleDayRank): array { |
||
| 585 | if ($interval <= 12) { |
||
| 586 | $interval = 1; |
||
| 587 | $type = dgettext('zarafa', 'year'); |
||
| 588 | $occSingleDayRank = true; |
||
| 589 | } |
||
| 590 | else { |
||
| 591 | $interval = $interval / 12; |
||
| 592 | $type = dgettext('zarafa', 'years'); |
||
| 593 | $occSingleDayRank = false; |
||
| 594 | } |
||
| 595 | |||
| 596 | return [ |
||
| 597 | 'type' => $type, |
||
| 598 | 'interval' => $interval, |
||
| 599 | 'occSingleDayRank' => boolval($occSingleDayRank), |
||
| 600 | ]; |
||
| 601 | } |
||
| 602 | |||
| 603 | /** |
||
| 604 | * Returns langified recurrence type string, whether it's singular or plural, |
||
| 605 | * recurrence interval. |
||
| 606 | */ |
||
| 607 | public function getI18nRecurrenceType(): array { |
||
| 608 | $type = $this->recur['type']; |
||
| 609 | $interval = $this->recur['everyn']; |
||
| 610 | $occSingleDayRank = false; |
||
| 611 | |||
| 612 | return match ($type) { |
||
| 613 | // Daily |
||
| 614 | 0x0A => $this->getI18RecTypeDaily($type, $interval, $occSingleDayRank), |
||
| 615 | // Weekly |
||
| 616 | 0x0B => $this->getI18RecTypeWeekly($type, $interval, $occSingleDayRank), |
||
| 617 | // Monthly |
||
| 618 | 0x0C => $this->getI18RecTypeMonthly($type, $interval, $occSingleDayRank), |
||
| 619 | // Yearly |
||
| 620 | 0x0D => $this->getI18RecTypeYearly($type, $interval, $occSingleDayRank), |
||
| 621 | default => [ |
||
| 622 | 'type' => $type, |
||
| 623 | 'interval' => $interval, |
||
| 624 | 'occSingleDayRank' => boolval($occSingleDayRank), |
||
| 625 | ], |
||
| 626 | }; |
||
| 627 | } |
||
| 628 | |||
| 629 | /** |
||
| 630 | * Returns the start or end time of the first occurrence. |
||
| 631 | */ |
||
| 632 | public function getOccDate(bool $getStart = true): mixed { |
||
| 633 | return $getStart ? |
||
| 634 | (isset($this->recur['startocc']) ? |
||
| 635 | $this->recur['start'] + (((int) $this->recur['startocc']) * 60) : |
||
| 636 | $this->recur['start']) : |
||
| 637 | (isset($this->recur['endocc']) ? |
||
| 638 | $this->recur['start'] + (((int) $this->recur['endocc']) * 60) : |
||
| 639 | $this->recur['end']); |
||
| 640 | } |
||
| 641 | |||
| 642 | /** |
||
| 643 | * Returns langified occurrence time. |
||
| 644 | */ |
||
| 645 | public function getI18nTime(string $format, mixed $occTime): string { |
||
| 646 | return gmdate(dgettext('zarafa', $format), $occTime); |
||
| 647 | } |
||
| 648 | |||
| 649 | /** |
||
| 650 | * Returns langified recurrence pattern termination after the given date. |
||
| 651 | */ |
||
| 652 | public function getI18nRecTermDate( |
||
| 653 | bool $occTimeRange, |
||
| 654 | bool $occSingleDayRank, |
||
| 655 | mixed $type, |
||
| 656 | mixed $interval, |
||
| 657 | string $start, |
||
| 658 | string $end, |
||
| 659 | string $startocc, |
||
| 660 | string $endocc |
||
| 661 | ): string { |
||
| 662 | return $occTimeRange ? |
||
| 663 | ( |
||
| 664 | $occSingleDayRank ? |
||
| 665 | sprintf( |
||
| 666 | dgettext('zarafa', 'Occurs every %s effective %s until %s from %s to %s.'), |
||
| 667 | $type, |
||
| 668 | $start, |
||
| 669 | $end, |
||
| 670 | $startocc, |
||
| 671 | $endocc |
||
| 672 | ) : |
||
| 673 | sprintf( |
||
| 674 | dgettext('zarafa', 'Occurs every %s %s effective %s until %s from %s to %s.'), |
||
| 675 | $interval, |
||
| 676 | $type, |
||
| 677 | $start, |
||
| 678 | $end, |
||
| 679 | $startocc, |
||
| 680 | $endocc |
||
| 681 | ) |
||
| 682 | ) : |
||
| 683 | ( |
||
| 684 | $occSingleDayRank ? |
||
| 685 | sprintf( |
||
| 686 | dgettext('zarafa', 'Occurs every %s effective %s until %s.'), |
||
| 687 | $type, |
||
| 688 | $start, |
||
| 689 | $end |
||
| 690 | ) : |
||
| 691 | sprintf( |
||
| 692 | dgettext('zarafa', 'Occurs every %s %s effective %s until %s.'), |
||
| 693 | $interval, |
||
| 694 | $type, |
||
| 695 | $start, |
||
| 696 | $end |
||
| 697 | ) |
||
| 698 | ); |
||
| 699 | } |
||
| 700 | |||
| 701 | /** |
||
| 702 | * Returns langified recurrence pattern termination after a number of |
||
| 703 | * occurrences. |
||
| 704 | */ |
||
| 705 | public function getI18nRecTermNrOcc( |
||
| 770 | ) |
||
| 771 | ); |
||
| 772 | } |
||
| 773 | |||
| 774 | /** |
||
| 775 | * Returns langified recurrence pattern termination with no end date. |
||
| 776 | */ |
||
| 777 | public function getI18nRecTermNoEnd( |
||
| 778 | bool $occTimeRange, |
||
| 779 | bool $occSingleDayRank, |
||
| 780 | mixed $type, |
||
| 781 | mixed $interval, |
||
| 782 | string $start, |
||
| 783 | string $startocc, |
||
| 784 | string $endocc |
||
| 785 | ): string { |
||
| 786 | return $occTimeRange ? |
||
| 787 | ( |
||
| 788 | $occSingleDayRank ? |
||
| 789 | sprintf( |
||
| 790 | dgettext('zarafa', 'Occurs every %s effective %s from %s to %s.'), |
||
| 791 | $type, |
||
| 792 | $start, |
||
| 793 | $startocc, |
||
| 794 | $endocc |
||
| 795 | ) : |
||
| 796 | sprintf( |
||
| 797 | dgettext('zarafa', 'Occurs every %s %s effective %s from %s to %s.'), |
||
| 798 | $interval, |
||
| 799 | $type, |
||
| 800 | $start, |
||
| 801 | $startocc, |
||
| 802 | $endocc |
||
| 803 | ) |
||
| 804 | ) : |
||
| 805 | ( |
||
| 806 | $occSingleDayRank ? |
||
| 807 | sprintf( |
||
| 808 | dgettext('zarafa', 'Occurs every %s effective %s.'), |
||
| 809 | $type, |
||
| 810 | $start |
||
| 811 | ) : |
||
| 812 | sprintf( |
||
| 813 | dgettext('zarafa', 'Occurs every %s %s effective %s.'), |
||
| 814 | $interval, |
||
| 815 | $type, |
||
| 816 | $start |
||
| 817 | ) |
||
| 818 | ); |
||
| 819 | } |
||
| 820 | |||
| 821 | /** |
||
| 822 | * Generates and stores recurrence pattern string to recurring_pattern property. |
||
| 823 | */ |
||
| 824 | public function saveRecurrencePattern(): string { |
||
| 825 | // Start formatting the properties in such a way we can apply |
||
| 826 | // them directly into the recurrence pattern. |
||
| 827 | $pattern = ''; |
||
| 828 | $occTimeRange = $this->recur['startocc'] != 0 && $this->recur['endocc'] != 0; |
||
| 829 | |||
| 830 | [ |
||
| 831 | 'type' => $type, |
||
| 832 | 'interval' => $interval, |
||
| 833 | 'occSingleDayRank' => $occSingleDayRank, |
||
| 834 | ] = $this->getI18nRecurrenceType(); |
||
| 835 | |||
| 836 | // get timings of the first occurrence |
||
| 837 | $firstoccstartdate = $this->getOccDate(); |
||
| 838 | $firstoccenddate = $this->getOccDate(false); |
||
| 839 | |||
| 840 | $start = $this->getI18nTime('d-m-Y', $firstoccstartdate); |
||
| 841 | $end = $this->getI18nTime('d-m-Y', $firstoccenddate); |
||
| 842 | $startocc = $this->getI18nTime('G:i', $firstoccstartdate); |
||
| 843 | $endocc = $this->getI18nTime('G:i', $firstoccenddate); |
||
| 844 | |||
| 845 | // Based on the properties, we need to generate the recurrence pattern string. |
||
| 846 | // This is obviously very easy since we can simply concatenate a bunch of strings, |
||
| 847 | // however this messes up translations for languages which order their words |
||
| 848 | // differently. |
||
| 849 | // To improve translation quality we create a series of default strings, in which |
||
| 850 | // we only have to fill in the correct variables. The base string is thus selected |
||
| 851 | // based on the available properties. |
||
| 852 | switch ($this->recur['term']) { |
||
| 853 | case 0x21: // After the given enddate |
||
| 854 | $pattern = $this->getI18nRecTermDate( |
||
| 855 | $occTimeRange, |
||
| 856 | boolval($occSingleDayRank), |
||
| 857 | $type, |
||
| 858 | $interval, |
||
| 859 | $start, |
||
| 860 | $end, |
||
| 861 | $startocc, |
||
| 862 | $endocc |
||
| 863 | ); |
||
| 864 | break; |
||
| 865 | |||
| 866 | case 0x22: // After a number of times |
||
| 867 | $pattern = $this->getI18nRecTermNrOcc( |
||
| 868 | $occTimeRange, |
||
| 869 | boolval($occSingleDayRank), |
||
| 870 | $type, |
||
| 871 | $interval, |
||
| 872 | $start, |
||
| 873 | $this->recur['numoccur'] ?? 0, |
||
| 874 | $startocc, |
||
| 875 | $endocc |
||
| 876 | ); |
||
| 877 | break; |
||
| 878 | |||
| 879 | case 0x23: // Never ends |
||
| 880 | $pattern = $this->getI18nRecTermNoEnd( |
||
| 881 | $occTimeRange, |
||
| 882 | boolval($occSingleDayRank), |
||
| 883 | $type, |
||
| 884 | $interval, |
||
| 885 | $start, |
||
| 886 | $startocc, |
||
| 887 | $endocc |
||
| 888 | ); |
||
| 889 | break; |
||
| 890 | |||
| 891 | default: |
||
| 892 | error_log(sprintf("Invalid recurrence pattern termination %d", $this->recur['term'])); |
||
| 893 | break; |
||
| 894 | } |
||
| 895 | |||
| 896 | if (!empty($pattern)) { |
||
| 897 | mapi_setprops($this->message, [$this->proptags["recurring_pattern"] => $pattern]); |
||
| 898 | } |
||
| 899 | |||
| 900 | return $pattern; |
||
| 901 | } |
||
| 902 | |||
| 903 | /* |
||
| 904 | * Remove an exception by base_date. This is the base date in local daystart time |
||
| 905 | */ |
||
| 906 | /** |
||
| 907 | * @param false|int $base_date |
||
| 908 | */ |
||
| 909 | public function deleteException($base_date): void { |
||
| 910 | // Remove all exceptions on $base_date from the deleted and changed occurrences lists |
||
| 911 | |||
| 912 | // Remove all items in $todelete from deleted_occurrences |
||
| 913 | $new = []; |
||
| 914 | |||
| 915 | foreach ($this->recur["deleted_occurrences"] as $entry) { |
||
| 916 | if ($entry != $base_date) { |
||
| 917 | $new[] = $entry; |
||
| 918 | } |
||
| 919 | } |
||
| 920 | $this->recur["deleted_occurrences"] = $new; |
||
| 921 | |||
| 922 | $new = []; |
||
| 923 | |||
| 924 | foreach ($this->recur["changed_occurrences"] as $entry) { |
||
| 925 | if (!$this->isSameDay($entry["basedate"], $base_date)) { |
||
| 926 | $new[] = $entry; |
||
| 927 | } |
||
| 928 | else { |
||
| 929 | $this->deleteExceptionAttachment($this->toGMT($this->tz, $base_date + $this->recur["startocc"] * 60)); |
||
| 930 | } |
||
| 931 | } |
||
| 932 | |||
| 933 | $this->recur["changed_occurrences"] = $new; |
||
| 934 | } |
||
| 935 | |||
| 936 | /** |
||
| 937 | * Function which saves the exception data in an attachment. |
||
| 938 | * |
||
| 939 | * @param array $exception_props the exception data (like any other MAPI appointment) |
||
| 940 | * @param array $exception_recips list of recipients |
||
| 941 | * @param mapi_message $copy_attach_from mapi message from which attachments should be copied |
||
| 942 | */ |
||
| 943 | public function createExceptionAttachment($exception_props, $exception_recips = [], $copy_attach_from = false): void { |
||
| 944 | // Create new attachment. |
||
| 945 | $attachment = mapi_message_createattach($this->message); |
||
| 946 | $props = []; |
||
| 947 | $props[PR_ATTACHMENT_FLAGS] = 2; |
||
| 948 | $props[PR_ATTACHMENT_HIDDEN] = true; |
||
| 949 | $props[PR_ATTACHMENT_LINKID] = 0; |
||
| 950 | $props[PR_ATTACH_FLAGS] = 0; |
||
| 951 | $props[PR_ATTACH_METHOD] = ATTACH_EMBEDDED_MSG; |
||
| 952 | $props[PR_DISPLAY_NAME] = "Exception"; |
||
| 953 | $props[PR_EXCEPTION_STARTTIME] = $this->fromGMT($this->tz, $exception_props[$this->proptags["startdate"]]); |
||
| 954 | $props[PR_EXCEPTION_ENDTIME] = $this->fromGMT($this->tz, $exception_props[$this->proptags["duedate"]]); |
||
| 955 | mapi_setprops($attachment, $props); |
||
| 956 | |||
| 957 | $imessage = mapi_attach_openobj($attachment, MAPI_CREATE | MAPI_MODIFY); |
||
| 958 | |||
| 959 | if ($copy_attach_from) { |
||
| 960 | $attachmentTable = mapi_message_getattachmenttable($copy_attach_from); |
||
| 961 | if ($attachmentTable) { |
||
| 962 | $attachments = mapi_table_queryallrows($attachmentTable, [PR_ATTACH_NUM, PR_ATTACH_SIZE, PR_ATTACH_LONG_FILENAME, PR_ATTACHMENT_HIDDEN, PR_DISPLAY_NAME, PR_ATTACH_METHOD]); |
||
| 963 | |||
| 964 | foreach ($attachments as $attach_props) { |
||
| 965 | $attach_old = mapi_message_openattach($copy_attach_from, (int) $attach_props[PR_ATTACH_NUM]); |
||
| 966 | $attach_newResourceMsg = mapi_message_createattach($imessage); |
||
| 967 | mapi_copyto($attach_old, [], [], $attach_newResourceMsg, 0); |
||
| 968 | mapi_savechanges($attach_newResourceMsg); |
||
| 969 | } |
||
| 970 | } |
||
| 971 | } |
||
| 972 | |||
| 973 | $props = $props + $exception_props; |
||
| 974 | |||
| 975 | // FIXME: the following piece of code is written to fix the creation |
||
| 976 | // of an exception. This is only a quickfix as it is not yet possible |
||
| 977 | // to change an existing exception. |
||
| 978 | // remove mv properties when needed |
||
| 979 | foreach ($props as $propTag => $propVal) { |
||
| 980 | if ((mapi_prop_type($propTag) & MV_FLAG) == MV_FLAG && is_null($propVal)) { |
||
| 981 | unset($props[$propTag]); |
||
| 982 | } |
||
| 983 | } |
||
| 984 | |||
| 985 | mapi_setprops($imessage, $props); |
||
| 986 | |||
| 987 | $this->setExceptionRecipients($imessage, $exception_recips, true); |
||
| 988 | |||
| 989 | mapi_savechanges($imessage); |
||
| 990 | mapi_savechanges($attachment); |
||
| 991 | } |
||
| 992 | |||
| 993 | /** |
||
| 994 | * Function which deletes the attachment of an exception. |
||
| 995 | * |
||
| 996 | * @param mixed $base_date base date of the attachment. Should be in GMT. The attachment |
||
| 997 | * actually saves the real time of the original date, so we have |
||
| 998 | * to check whether it's on the same day. |
||
| 999 | */ |
||
| 1000 | public function deleteExceptionAttachment($base_date): void { |
||
| 1001 | $attachments = mapi_message_getattachmenttable($this->message); |
||
| 1002 | // Retrieve only exceptions which are stored as embedded messages |
||
| 1003 | $attach_res = [ |
||
| 1004 | RES_PROPERTY, |
||
| 1005 | [ |
||
| 1006 | RELOP => RELOP_EQ, |
||
| 1007 | ULPROPTAG => PR_ATTACH_METHOD, |
||
| 1008 | VALUE => [PR_ATTACH_METHOD => ATTACH_EMBEDDED_MSG], |
||
| 1009 | ], |
||
| 1010 | ]; |
||
| 1011 | $attachRows = mapi_table_queryallrows($attachments, [PR_ATTACH_NUM], $attach_res); |
||
| 1012 | |||
| 1013 | foreach ($attachRows as $attachRow) { |
||
| 1014 | $tempattach = mapi_message_openattach($this->message, $attachRow[PR_ATTACH_NUM]); |
||
| 1015 | $exception = mapi_attach_openobj($tempattach); |
||
| 1016 | |||
| 1017 | $data = mapi_message_getprops($exception, [$this->proptags["basedate"]]); |
||
| 1018 | |||
| 1019 | if ($this->dayStartOf($this->fromGMT($this->tz, $data[$this->proptags["basedate"]])) == $this->dayStartOf($base_date)) { |
||
| 1020 | mapi_message_deleteattach($this->message, $attachRow[PR_ATTACH_NUM]); |
||
| 1021 | } |
||
| 1022 | } |
||
| 1023 | } |
||
| 1024 | |||
| 1025 | /** |
||
| 1026 | * Function which deletes all attachments of a message. |
||
| 1027 | */ |
||
| 1028 | public function deleteAttachments(): void { |
||
| 1029 | $attachments = mapi_message_getattachmenttable($this->message); |
||
| 1030 | $attachTable = mapi_table_queryallrows($attachments, [PR_ATTACH_NUM, PR_ATTACHMENT_HIDDEN]); |
||
| 1031 | |||
| 1032 | foreach ($attachTable as $attachRow) { |
||
| 1033 | if (isset($attachRow[PR_ATTACHMENT_HIDDEN]) && $attachRow[PR_ATTACHMENT_HIDDEN]) { |
||
| 1034 | mapi_message_deleteattach($this->message, $attachRow[PR_ATTACH_NUM]); |
||
| 1035 | } |
||
| 1036 | } |
||
| 1037 | } |
||
| 1038 | |||
| 1039 | /** |
||
| 1040 | * Get an exception attachment based on its basedate. |
||
| 1041 | * |
||
| 1042 | * @param mixed $base_date |
||
| 1043 | */ |
||
| 1044 | public function getExceptionAttachment($base_date) { |
||
| 1077 | } |
||
| 1078 | |||
| 1079 | /** |
||
| 1080 | * processOccurrenceItem, adds an item to a list of occurrences, but only if the following criteria are met: |
||
| 1081 | * - The resulting occurrence (or exception) starts or ends in the interval <$start, $end> |
||
| 1082 | * - The occurrence isn't specified as a deleted occurrence. |
||
| 1083 | * |
||
| 1084 | * @param array $items reference to the array to be added to |
||
| 1085 | * @param int $start start of timeframe in GMT TIME |
||
| 1086 | * @param int $end end of timeframe in GMT TIME |
||
| 1087 | * @param int $basedate (hour/sec/min assumed to be 00:00:00) in LOCAL TIME OF THE OCCURRENCE |
||
| 1088 | * @param int $startocc start of occurrence since beginning of day in minutes |
||
| 1089 | * @param int $endocc end of occurrence since beginning of day in minutes |
||
| 1090 | * @param mixed $tz the timezone info for this occurrence ( applied to $basedate / $startocc / $endocc ) |
||
| 1091 | * @param bool $reminderonly If TRUE, only add the item if the reminder is set |
||
| 1092 | * |
||
| 1093 | * @return null|false |
||
| 1094 | */ |
||
| 1095 | public function processOccurrenceItem(&$items, $start, $end, $basedate, $startocc, $endocc, $tz, $reminderonly) { |
||
| 1096 | $exception = $this->isException($basedate); |
||
| 1097 | if ($exception) { |
||
| 1098 | return false; |
||
| 1099 | } |
||
| 1100 | $occstart = $basedate + $startocc * 60; |
||
| 1101 | $occend = $basedate + $endocc * 60; |
||
| 1102 | |||
| 1103 | // Convert to GMT |
||
| 1104 | $occstart = $this->toGMT($tz, $occstart); |
||
| 1105 | $occend = $this->toGMT($tz, $occend); |
||
| 1106 | |||
| 1107 | /** |
||
| 1108 | * FIRST PART: Check range criterium. Exact matches (eg when $occstart == $end), do NOT match since you cannot |
||
| 1109 | * see any part of the appointment. Partial overlaps DO match. |
||
| 1110 | * |
||
| 1111 | * SECOND PART: check if occurrence is not a zero duration occurrence which |
||
| 1112 | * starts at 00:00 and ends on 00:00. if it is so, then process |
||
| 1113 | * the occurrence and send it in response. |
||
| 1114 | */ |
||
| 1115 | if (($occstart >= $end || $occend <= $start) && !($occstart == $occend && $occstart == $start)) { |
||
| 1116 | return; |
||
| 1117 | } |
||
| 1118 | |||
| 1119 | // Properties for this occurrence are the same as the main object, |
||
| 1120 | // With these properties overridden |
||
| 1121 | $newitem = $this->messageprops; |
||
| 1122 | $newitem[$this->proptags["startdate"]] = $occstart; |
||
| 1123 | $newitem[$this->proptags["duedate"]] = $occend; |
||
| 1124 | $newitem[$this->proptags["commonstart"]] = $occstart; |
||
| 1125 | $newitem[$this->proptags["commonend"]] = $occend; |
||
| 1126 | $newitem["basedate"] = $basedate; |
||
| 1127 | |||
| 1128 | // If reminderonly is set, only add reminders |
||
| 1129 | if ($reminderonly && (!isset($newitem[$this->proptags["reminder"]]) || $newitem[$this->proptags["reminder"]] == false)) { |
||
| 1130 | return; |
||
| 1131 | } |
||
| 1132 | |||
| 1133 | $items[] = $newitem; |
||
| 1134 | } |
||
| 1135 | |||
| 1136 | /** |
||
| 1137 | * processExceptionItem, adds an all exception item to a list of occurrences, without any constraint on timeframe. |
||
| 1138 | * |
||
| 1139 | * @param array $items reference to the array to be added to |
||
| 1140 | * @param date $start start of timeframe in GMT TIME |
||
| 1141 | * @param date $end end of timeframe in GMT TIME |
||
| 1142 | */ |
||
| 1143 | public function processExceptionItems(&$items, $start, $end): void { |
||
| 1144 | $limit = 0; |
||
| 1145 | foreach ($this->recur["changed_occurrences"] as $exception) { |
||
| 1146 | // Convert to GMT |
||
| 1147 | $occstart = $this->toGMT($this->tz, $exception["start"]); |
||
| 1148 | $occend = $this->toGMT($this->tz, $exception["end"]); |
||
| 1149 | |||
| 1150 | // Check range criterium. Exact matches (eg when $occstart == $end), do NOT match since you cannot |
||
| 1151 | // see any part of the appointment. Partial overlaps DO match. |
||
| 1152 | if ($occstart >= $end || $occend <= $start) { |
||
| 1153 | continue; |
||
| 1154 | } |
||
| 1155 | |||
| 1156 | array_push($items, $this->getExceptionProperties($exception)); |
||
| 1157 | if (count($items) == $limit) { |
||
| 1158 | break; |
||
| 1159 | } |
||
| 1160 | } |
||
| 1161 | } |
||
| 1162 | |||
| 1163 | /** |
||
| 1164 | * Function which verifies if on the given date an exception, delete or change, occurs. |
||
| 1165 | * |
||
| 1166 | * @param mixed $basedate |
||
| 1167 | * |
||
| 1168 | * @return bool true - if an exception occurs on the given date, false - no exception occurs on the given date |
||
| 1169 | */ |
||
| 1170 | public function isException($basedate) { |
||
| 1180 | } |
||
| 1181 | |||
| 1182 | /** |
||
| 1183 | * Returns TRUE if there is a DELETE exception on the given base date. |
||
| 1184 | * |
||
| 1185 | * @param mixed $basedate |
||
| 1186 | */ |
||
| 1187 | public function isDeleteException($basedate): bool { |
||
| 1188 | // Check if the occurrence is deleted on the specified date |
||
| 1189 | foreach ($this->recur["deleted_occurrences"] as $deleted) { |
||
| 1190 | if ($this->isSameDay($deleted, $basedate)) { |
||
| 1191 | return true; |
||
| 1192 | } |
||
| 1193 | } |
||
| 1194 | |||
| 1195 | return false; |
||
| 1196 | } |
||
| 1197 | |||
| 1198 | /** |
||
| 1199 | * Returns the exception if there is a CHANGE exception on the given base date, or FALSE otherwise. |
||
| 1200 | * |
||
| 1201 | * @param mixed $basedate |
||
| 1202 | */ |
||
| 1203 | public function getChangeException($basedate) { |
||
| 1204 | // Check if the occurrence is modified on the specified date |
||
| 1205 | foreach ($this->recur["changed_occurrences"] as $changed) { |
||
| 1206 | if ($this->isSameDay($changed["basedate"], $basedate)) { |
||
| 1207 | return $changed; |
||
| 1208 | } |
||
| 1209 | } |
||
| 1210 | |||
| 1211 | return false; |
||
| 1212 | } |
||
| 1213 | |||
| 1214 | /** |
||
| 1215 | * Function to see if two dates are on the same day. |
||
| 1216 | * |
||
| 1217 | * @param mixed $date1 |
||
| 1218 | * @param mixed $date2 |
||
| 1219 | * |
||
| 1220 | * @return bool Returns TRUE when both dates are on the same day |
||
| 1221 | */ |
||
| 1222 | public function isSameDay($date1, $date2) { |
||
| 1227 | } |
||
| 1228 | |||
| 1229 | /** |
||
| 1230 | * Function which sets recipients for an exception. |
||
| 1231 | * |
||
| 1232 | * The $exception_recips can be provided in 2 ways: |
||
| 1233 | * - A delta which indicates which recipients must be added, removed or deleted. |
||
| 1234 | * - A complete array of the recipients which should be applied to the message. |
||
| 1235 | * |
||
| 1236 | * The first option is preferred as it will require less work to be executed. |
||
| 1237 | * |
||
| 1238 | * @param resource $message exception attachment of recurring item |
||
| 1239 | * @param array $exception_recips list of recipients |
||
| 1240 | * @param bool $copy_orig_recips True to copy all recipients which are on the original |
||
| 1241 | * message to the attachment by default. False if only the $exception_recips changes should |
||
| 1242 | * be applied. |
||
| 1243 | */ |
||
| 1244 | public function setExceptionRecipients($message, $exception_recips, $copy_orig_recips = true): void { |
||
| 1245 | if (isset($exception_recips['add']) || isset($exception_recips['remove']) || isset($exception_recips['modify'])) { |
||
| 1246 | $this->setDeltaExceptionRecipients($message, $exception_recips, $copy_orig_recips); |
||
| 1247 | } |
||
| 1248 | else { |
||
| 1249 | $this->setAllExceptionRecipients($message, $exception_recips); |
||
| 1250 | } |
||
| 1251 | } |
||
| 1252 | |||
| 1253 | /** |
||
| 1254 | * Function which applies the provided delta for recipients changes to the exception. |
||
| 1255 | * |
||
| 1256 | * The $exception_recips should be an array containing the following keys: |
||
| 1257 | * - "add": this contains an array of recipients which must be added |
||
| 1258 | * - "remove": This contains an array of recipients which must be removed |
||
| 1259 | * - "modify": This contains an array of recipients which must be modified |
||
| 1260 | * |
||
| 1261 | * @param mixed $exception |
||
| 1262 | * @param array $exception_recips list of recipients |
||
| 1263 | * @param bool $copy_orig_recips True to copy all recipients which are on the original |
||
| 1264 | * message to the attachment by default. False if only the $exception_recips changes should |
||
| 1265 | * be applied. |
||
| 1266 | */ |
||
| 1267 | public function setDeltaExceptionRecipients($exception, $exception_recips, $copy_orig_recips): void { |
||
| 1306 | } |
||
| 1307 | } |
||
| 1308 | |||
| 1309 | /** |
||
| 1310 | * Function which applies the provided recipients to the exception, also checks for deleted recipients. |
||
| 1311 | * |
||
| 1312 | * The $exception_recips should be an array containing all recipients which must be applied |
||
| 1313 | * to the exception. This will copy all recipients from the original message and then start filter |
||
| 1314 | * out all recipients which are not provided by the $exception_recips list. |
||
| 1315 | * |
||
| 1316 | * @param resource $message exception attachment of recurring item |
||
| 1317 | * @param array $exception_recips list of recipients |
||
| 1318 | */ |
||
| 1319 | public function setAllExceptionRecipients($message, $exception_recips): void { |
||
| 1320 | $deletedRecipients = []; |
||
| 1321 | $useMessageRecipients = false; |
||
| 1322 | |||
| 1323 | $recipientTable = mapi_message_getrecipienttable($message); |
||
| 1324 | $recipientRows = mapi_table_queryallrows($recipientTable, $this->recipprops); |
||
| 1325 | |||
| 1326 | if (empty($recipientRows)) { |
||
| 1327 | $useMessageRecipients = true; |
||
| 1328 | $recipientTable = mapi_message_getrecipienttable($this->message); |
||
| 1329 | $recipientRows = mapi_table_queryallrows($recipientTable, $this->recipprops); |
||
| 1330 | } |
||
| 1331 | |||
| 1332 | // Add organizer to meeting only if it is not organized. |
||
| 1333 | $msgprops = mapi_getprops($message, [PR_SENT_REPRESENTING_ENTRYID, PR_SENT_REPRESENTING_EMAIL_ADDRESS, PR_SENT_REPRESENTING_NAME, PR_SENT_REPRESENTING_ADDRTYPE, PR_SENT_REPRESENTING_SEARCH_KEY, $this->proptags['responsestatus']]); |
||
| 1334 | if (isset($msgprops[$this->proptags['responsestatus']]) && $msgprops[$this->proptags['responsestatus']] != olResponseOrganized) { |
||
| 1335 | $this->addOrganizer($msgprops, $exception_recips); |
||
| 1336 | } |
||
| 1337 | |||
| 1338 | if (!empty($exception_recips)) { |
||
| 1339 | foreach ($recipientRows as $recipient) { |
||
| 1340 | $found = false; |
||
| 1341 | foreach ($exception_recips as $excep_recip) { |
||
| 1342 | if (isset($recipient[PR_SEARCH_KEY], $excep_recip[PR_SEARCH_KEY]) && $recipient[PR_SEARCH_KEY] == $excep_recip[PR_SEARCH_KEY]) { |
||
| 1343 | $found = true; |
||
| 1344 | } |
||
| 1345 | } |
||
| 1346 | |||
| 1347 | if (!$found) { |
||
| 1348 | $foundInDeletedRecipients = false; |
||
| 1349 | // Look if the $recipient is in the list of deleted recipients |
||
| 1350 | if (!empty($deletedRecipients)) { |
||
| 1351 | foreach ($deletedRecipients as $recip) { |
||
| 1352 | if (isset($recipient[PR_SEARCH_KEY], $excep_recip[PR_SEARCH_KEY]) && $recip[PR_SEARCH_KEY] == $recipient[PR_SEARCH_KEY]) { |
||
| 1353 | $foundInDeletedRecipients = true; |
||
| 1354 | break; |
||
| 1355 | } |
||
| 1356 | } |
||
| 1357 | } |
||
| 1358 | |||
| 1359 | // If recipient is not in list of deleted recipient, add him |
||
| 1360 | if (!$foundInDeletedRecipients) { |
||
| 1361 | if (!isset($recipient[PR_RECIPIENT_FLAGS]) || $recipient[PR_RECIPIENT_FLAGS] != (recipReserved | recipExceptionalDeleted | recipSendable)) { |
||
| 1362 | $recipient[PR_RECIPIENT_FLAGS] = recipSendable | recipExceptionalDeleted; |
||
| 1363 | } |
||
| 1364 | else { |
||
| 1365 | $recipient[PR_RECIPIENT_FLAGS] = recipReserved | recipExceptionalDeleted | recipSendable; |
||
| 1366 | } |
||
| 1367 | $recipient[PR_RECIPIENT_TRACKSTATUS] = olRecipientTrackStatusNone; // No Response required |
||
| 1368 | $deletedRecipients[] = $recipient; |
||
| 1369 | } |
||
| 1370 | } |
||
| 1371 | |||
| 1372 | // When $message contains a non-empty recipienttable, we must delete the recipients |
||
| 1373 | // before re-adding them. However, when $message is doesn't contain any recipients, |
||
| 1374 | // we are using the recipient table of the original message ($this->message) |
||
| 1375 | // rather then $message. In that case, we don't need to remove the recipients |
||
| 1376 | // from the $message, as the recipient table is already empty, and |
||
| 1377 | // mapi_message_modifyrecipients() will throw an error. |
||
| 1378 | if ($useMessageRecipients === false) { |
||
| 1379 | mapi_message_modifyrecipients($message, MODRECIP_REMOVE, [$recipient]); |
||
| 1380 | } |
||
| 1381 | } |
||
| 1382 | $exception_recips = array_merge($exception_recips, $deletedRecipients); |
||
| 1383 | } |
||
| 1384 | else { |
||
| 1385 | $exception_recips = $recipientRows; |
||
| 1386 | } |
||
| 1387 | |||
| 1388 | if (!empty($exception_recips)) { |
||
| 1389 | // Set the new list of recipients on the exception message, this also removes the existing recipients |
||
| 1390 | mapi_message_modifyrecipients($message, MODRECIP_MODIFY, $exception_recips); |
||
| 1391 | } |
||
| 1392 | } |
||
| 1393 | |||
| 1394 | /** |
||
| 1395 | * Function returns basedates of all changed occurrences. |
||
| 1396 | * |
||
| 1397 | * @return array|false array( 0 => 123459321 ) |
||
| 1398 | * |
||
| 1399 | * @psalm-return false|list<mixed> |
||
| 1400 | */ |
||
| 1401 | public function getAllExceptions() { |
||
| 1412 | } |
||
| 1413 | |||
| 1414 | /** |
||
| 1415 | * Function which adds organizer to recipient list which is passed. |
||
| 1416 | * This function also checks if it has organizer. |
||
| 1417 | * |
||
| 1418 | * @param array $messageProps message properties |
||
| 1419 | * @param array $recipients recipients list of message |
||
| 1420 | * @param bool $isException true if we are processing recipient of exception |
||
| 1421 | */ |
||
| 1422 | public function addOrganizer($messageProps, &$recipients, $isException = false): void { |
||
| 1423 | $hasOrganizer = false; |
||
| 1424 | // Check if meeting already has an organizer. |
||
| 1425 | foreach ($recipients as $key => $recipient) { |
||
| 1426 | if (isset($recipient[PR_RECIPIENT_FLAGS]) && $recipient[PR_RECIPIENT_FLAGS] == (recipSendable | recipOrganizer)) { |
||
| 1427 | $hasOrganizer = true; |
||
| 1428 | } |
||
| 1450 | } |
||
| 1451 | } |
||
| 1452 | } |
||
| 1453 | |||
| 1763 |
Loading history...