modules/iCals/iCal.php

   1 <?php
   2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
   3 /*********************************************************************************
   4  * SugarCRM Community Edition is a customer relationship management program developed by
   5  * SugarCRM, Inc. Copyright (C) 2004-2012 SugarCRM Inc.
   6  *
   7  * This program is free software; you can redistribute it and/or modify it under
   8  * the terms of the GNU Affero General Public License version 3 as published by the
   9  * Free Software Foundation with the addition of the following permission added
  10  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  11  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  12  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License along with
  20  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  21  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  22  * 02110-1301 USA.
  23  *
  24  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  25  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  26  *
  27  * The interactive user interfaces in modified source and object code versions
  28  * of this program must display Appropriate Legal Notices, as required under
  29  * Section 5 of the GNU Affero General Public License version 3.
  30  *
  31  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  32  * these Appropriate Legal Notices must retain the display of the "Powered by
  33  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  34  * technical reasons, the Appropriate Legal Notices must display the words
  35  * "Powered by SugarCRM".
  36  ********************************************************************************/
  37
  38
  39
  40 require_once('include/utils.php');
  41 require_once('modules/Calendar/Calendar.php');
  42 require_once('modules/vCals/vCal.php');
  43
  44 /**
  45 * Class for constructing the iCal response string for the current user.
  46 *
  47 * @see vCal
  48 */
  49 class iCal extends vCal {
  50
  51     const UTC_FORMAT = 'Ymd\THi00\Z';
  52
  53     /**
  54     * Constructor for the iCal class.
  55     */
  56     public function __construct()
  57     {
  58         parent::vCal();
  59     }
  60
  61     /**
  62     * Escapes new lines in the given string,
  63     *
  64     * @param string $string the original string
  65     * @return string the string with new lines properly escaped
  66     */
  67     protected function escapeNls($string)
  68     {
  69         $str = str_replace("\r\n", "\\n", $string);
  70         return $str;
  71     }
  72
  73     /**
  74     * Gets a UTC formatted string from the given dateTime
  75     *
  76     * @param SugarDateTime $dateTime the dateTime to format
  77     * @return string the UTC formatted dateTime
  78     */
  79     protected function getUtcDateTime($dateTime)
  80     {
  81         return $dateTime->format(self::UTC_FORMAT);
  82     }
  83
  84     /**
  85     * Gets the UTC formatted dateTime from the given timestamp.
  86     *
  87     * Checks the version of Sugar to see if user timezone adjustments are needed.
  88     *
  89     * @param integer $ts the timestamp to format
  90     * @return string the UTC formatted dateTime
  91     */
  92     protected function getUtcTime($ts)
  93     {
  94         global $timedate, $sugar_version;
  95         $timestamp = ($ts+(date('Z')-$timedate->adjustmentForUserTimeZone()*60));
  96         return $this->getUtcDateTime(new SugarDateTime("@" . $ts));
  97     }
  98
  99     /**
 100     * Converts the given number of minutes to formatted number of hours and remaining minutes.
 101     *
 102     * @param integer $minutes the number of minutes to format
 103     * @return string the formatted hours and minutes
 104     */
 105     protected function convertMinsToHoursAndMins($minutes)
 106     {
 107         $hrs = floor(abs($minutes) / 60);
 108         $remainderMinutes = abs($minutes) - ($hrs * 60);
 109         $sign = (($minutes < 0) ? "-" : "+");
 110         return $sign . str_pad($hrs, 2, "0", STR_PAD_LEFT) . str_pad($remainderMinutes, 2, "0", STR_PAD_LEFT);
 111     }
 112
 113     /**
 114     * Create a todo entry for the given task.
 115     *
 116     * @param UserBean $user_bean the current UserBean
 117     * @param Task $task the task for the todo entry
 118     * @param string $moduleName the name of the task module
 119     * @param string $dtstamp the current timestamp
 120     * @return string the todo entry for the task
 121     */
 122     protected function createSugarIcalTodo($user_bean, $task, $moduleName, $dtstamp)
 123     {
 124         global $sugar_config;
 125         $str = "";
 126         $str .= "BEGIN:VTODO\n";
 127         $validDueDate = (isset($task->date_due) && $task->date_due != "" && $task->date_due != "0000-00-00");
 128         $validDueTime = (isset($task->time_due) && $task->time_due != "");
 129         $dueYear = 1970;
 130         $dueMonth = 1;
 131         $dueDay = 1;
 132         $dueHour = 0;
 133         $dueMin = 0;
 134         if ($validDueDate) {
 135             $dateDueArr = split("-", $task->date_due);
 136             $dueYear = (int)$dateDueArr[0];
 137             $dueMonth = (int)$dateDueArr[1];
 138             $dueDay = (int)$dateDueArr[2];
 139
 140             if ($validDueTime) {
 141                 $timeDueArr = split(":", $task->time_due);
 142                 $dueHour = (int)$timeDueArr[0];
 143                 $dueMin = (int)$timeDueArr[1];
 144             }
 145         }
 146         $date_arr = array(
 147              'day'=>$dueDay,
 148              'month'=>$dueMonth,
 149              'hour'=>$dueHour,
 150              'min'=>$dueMin,
 151              'year'=>$dueYear);
 152         $due_date_time = new SugarDateTime();
 153         $due_date_time->setDate($dueYear, $dueMonth, $dueDay);
 154         $due_date_time->setTime($dueHour, $dueMin);
 155         $str .= "DTSTART;TZID=" . $user_bean->getPreference('timezone') . ":" .
 156                     str_replace("Z", "", $this->getUtcDateTime($due_date_time)) . "\n";
 157         $str .= "DTSTAMP:" . $dtstamp . "\n";
 158         $str .= "SUMMARY:" . $task->name . "\n";
 159         $str .= "UID:" . $task->id . "\n";
 160         if ($validDueDate) {
 161             $iCalDueDate = str_replace("-", "", $task->date_due);
 162             if (strlen($iCalDueDate) > 8) {
 163                 $iCalDueDate = substr($iCalDueDate, 0, 8);
 164             }
 165             $str .= "DUE;VALUE=DATE:" . $iCalDueDate . "\n";
 166         }
 167         if ($moduleName == "ProjectTask") {
 168             $str .= "DESCRIPTION:Project: " . $task->project_name. "\\n\\n" .
 169                 $this->escapeNls($task->description). "\n";
 170         } else {
 171             $str .= "DESCRIPTION:" . $this->escapeNls($task->description). "\n";
 172         }
 173         $str .= "URL;VALUE=URI:" . $sugar_config['site_url'].
 174             "/index.php?module=".$moduleName."&action=DetailView&record=". $task->id. "\n";
 175         if ($task->status == 'Completed') {
 176             $str .= "STATUS:COMPLETED\n";
 177             $str .= "PERCENT-COMPLETE:100\n";
 178             $str .= "COMPLETED:" . $this->getUtcDateTime($due_date_time) . "\n";
 179         } else if (!empty($task->percent_complete)) {
 180             $str .= "PERCENT-COMPLETE:" . $task->percent_complete . "\n";
 181         }
 182         if ($task->priority == "Low") {
 183             $str .= "PRIORITY:9\n";
 184         } else if ($task->priority == "Medium") {
 185                 $str .= "PRIORITY:5\n";
 186         } else if ($task->priority == "High") {
 187                 $str .= "PRIORITY:1\n";
 188         }
 189         $str .= "END:VTODO\n";
 190         return $str;
 191     }
 192
 193     /**
 194     * Creates the string for the user's events and todos between the given start
 195     * and end times
 196     *
 197     * @param UserBean $user_bean the current UserBean
 198     * @param DateTime $start_date_time the start date to search from
 199     * @param DateTime $end_date_time the end date to search to
 200     * @param string $dtstamp the current timestamp
 201     * @return string the entries for events and todos
 202     */
 203     protected function createSugarIcal(&$user_bean,&$start_date_time,&$end_date_time, $dtstamp)
 204     {
 205         $str = '';
 206         global $DO_USER_TIME_OFFSET, $sugar_config, $current_user, $timedate;
 207
 208         $acts_arr = CalendarActivity::get_activities($user_bean->id,
 209             false,
 210             $start_date_time,
 211             $end_date_time,
 212             'month');
 213
 214         $hide_calls = false;
 215         if (!empty($_REQUEST['hide_calls']) && $_REQUEST['hide_calls'] == "true")
 216         {
 217             $hide_calls = true;
 218         }
 219
 220         // loop thru each activity, get start/end time in UTC, and return iCal strings
 221         foreach($acts_arr as $act)
 222         {
 223
 224             $event = $act->sugar_bean;
 225             if (!$hide_calls || ($hide_calls && $event->object_name != "Call"))
 226             {
 227                 $str .= "BEGIN:VEVENT\n";
 228                 $str .= "SUMMARY:" . $event->name . "\n";
 229                 $str .= "DTSTART;TZID=" . $user_bean->getPreference('timezone') . ":" .
 230                         str_replace("Z", "", $timedate->tzUser($act->start_time, $current_user)->format(self::UTC_FORMAT)) . "\n";
 231                 $str .= "DTEND;TZID=" . $user_bean->getPreference('timezone') . ":" .
 232                         str_replace("Z", "", $timedate->tzUser($act->end_time, $current_user)->format(self::UTC_FORMAT)) . "\n";
 233                 $str .= "DTSTAMP:" . $dtstamp . "\n";
 234                 $str .= "DESCRIPTION:" . $this->escapeNls($event->description) . "\n";
 235                 $str .= "URL;VALUE=URI:" . $sugar_config['site_url'].
 236                     "/index.php?module=".$event->module_dir."&action=DetailView&record=". $event->id. "\n";
 237                 $str .= "UID:" . $event->id . "\n";
 238                 if ($event->object_name == "Meeting")
 239                 {
 240                     $str .= "LOCATION:" . $event->location . "\n";
 241                     $eventUsers = $event->get_meeting_users();
 242                     $query = "SELECT contact_id as id from meetings_contacts where meeting_id='$event->id' AND deleted=0";
 243                     $eventContacts = $event->build_related_list($query, new Contact());
 244                     $eventAttendees = array_merge($eventUsers, $eventContacts);
 245                     if (is_array($eventAttendees))
 246                     {
 247                         foreach($eventAttendees as $attendee)
 248                         {
 249                             if ($attendee->id != $user_bean->id)
 250                             {
 251                                 $str .= 'ATTENDEE;CN="'.$attendee->get_summary_text().'":mailto:'. $attendee->email1 . "\n";
 252                             }
 253                         }
 254                     }
 255                 }
 256                 if ($event->object_name == "Call")
 257                 {
 258                     $eventUsers = $event->get_call_users();
 259                     $eventContacts = $event->get_contacts();
 260                     $eventAttendees = array_merge($eventUsers, $eventContacts);
 261                     if (is_array($eventAttendees))
 262                     {
 263                         foreach($eventAttendees as $attendee)
 264                         {
 265                             if ($attendee->id != $user_bean->id)
 266                             {
 267                                 $str .= 'ATTENDEE;CN="'.$attendee->get_summary_text().'":mailto:'. $attendee->email1 . "\n";
 268                             }
 269                         }
 270                     }
 271                 }
 272                 if ($event->reminder_time > 0 && $event->status != "Held")
 273                 {
 274                     $str .= "BEGIN:VALARM\n";
 275                     $str .= "TRIGGER:-PT" . $event->reminder_time/60 . "M\n";
 276                     $str .= "ACTION:DISPLAY\n";
 277                     $str .= "DESCRIPTION:" . $event->name . "\n";
 278                     $str .= "END:VALARM\n";
 279                 }
 280                 $str .= "END:VEVENT\n";
 281             }
 282
 283         }
 284
 285         require_once('include/TimeDate.php');
 286         $timedate = new TimeDate();
 287         $today = gmdate("Y-m-d");
 288         $today = $timedate->handle_offset($today, $timedate->dbDayFormat, false);
 289
 290         require_once('modules/ProjectTask/ProjectTask.php');
 291         $where = "project_task.assigned_user_id='{$user_bean->id}' ".
 292             "AND (project_task.status IS NULL OR (project_task.status!='Deferred')) ".
 293             "AND (project_task.date_start IS NULL OR project_task.date_start <= '$today')";
 294         $seedProjectTask = new ProjectTask();
 295         $projectTaskList = $seedProjectTask->get_full_list("", $where);
 296         if (is_array($projectTaskList))
 297         {
 298             foreach($projectTaskList as $projectTask)
 299             {
 300                 $str .= $this->createSugarIcalTodo($user_bean, $projectTask, "ProjectTask", $dtstamp);
 301             }
 302         }
 303
 304         require_once('modules/Tasks/Task.php');
 305         $where = "tasks.assigned_user_id='{$user_bean->id}' ".
 306             "AND (tasks.status IS NULL OR (tasks.status!='Deferred')) ".
 307             "AND (tasks.date_start IS NULL OR tasks.date_start <= '$today')";
 308         $seedTask = new Task();
 309         $taskList = $seedTask->get_full_list("", $where);
 310         if (is_array($taskList))
 311         {
 312             foreach($taskList as $task)
 313             {
 314                 $str .= $this->createSugarIcalTodo($user_bean, $task, "Tasks", $dtstamp);
 315             }
 316         }
 317
 318         return $str;
 319     }
 320
 321     /**
 322     * Gets the time zone for the given user.
 323     *
 324     * @param User $current_user the user
 325     * @return DateTimeZone the user's timezone
 326     */
 327     protected function getUserTimezone($current_user)
 328     {
 329         $gmtTZ = new DateTimeZone("UTC");
 330         $userTZName = TimeDate::userTimezone($current_user);
 331         if (!empty($userTZName))
 332         {
 333             $tz = new DateTimeZone($userTZName);
 334         } else
 335         {
 336             $tz = $gmtTZ;
 337         }
 338         return $tz;
 339     }
 340
 341     /**
 342     * Gets the daylight savings range for the given user.
 343     *
 344     * @param User $current_user the user
 345     * @param integer $year the year
 346     * @return array the start and end transitions of daylight savings
 347     */
 348     protected function getDSTRange($current_user, $year)
 349     {
 350         $tz = $this->getUserTimezone($current_user);
 351         $idx = 0;
 352         $result = array();
 353
 354         if (version_compare(PHP_VERSION, '5.3.0') >= 0)
 355         {
 356             $year_date = SugarDateTime::createFromFormat("Y", $year, new DateTimeZone("UTC"));
 357             $year_end = clone $year_date;
 358             $year_end->setDate((int) $year, 12, 31);
 359             $year_end->setTime(23, 59, 59);
 360             $year_date->setDate((int) $year, 1, 1);
 361             $year_date->setTime(0, 0, 0);
 362
 363             $transitions = $tz->getTransitions($year_date->getTimestamp(), $year_end->getTimestamp());
 364             foreach($transitions as $transition) {
 365                 if($transition['isdst']) {
 366                     break;
 367                 }
 368                 $idx++;
 369             }
 370         } else {
 371             $transitions = $tz->getTransitions();
 372
 373             $idx = 0;
 374             foreach($transitions as $transition) {
 375                 if($transition['isdst'] && intval(substr($transition["time"], 0, 4)) == intval(date("Y"))) {
 376                     break;
 377                 }
 378                 $idx++;
 379             }
 380         }
 381
 382         if (empty($transitions[$idx]["isdst"])) {
 383             // No DST transitions found
 384             return $result;
 385         }
 386         $result["start"] = $transitions[$idx]; // DST begins here
 387         // scan till DST ends
 388         while (isset($transitions[$idx]) && $transitions[$idx]["isdst"]) $idx++;
 389         if(isset($transitions[$idx])) {
 390             $result["end"] = $transitions[$idx];
 391         }
 392         return $result;
 393     }
 394
 395     /**
 396     * Gets the timezone string for the current user.
 397     *
 398     * @return string the full timezone definition including daylight savings for the iCal
 399     */
 400     protected function getTimezoneString()
 401     {
 402         global $current_user, $timedate;
 403         $timezoneName = $current_user->getPreference('timezone');
 404
 405         $gmtTZ = new DateTimeZone("UTC");
 406         $tz = $this->getUserTimezone($current_user);
 407         $dstRange = $this->getDSTRange($current_user, date('Y'));
 408
 409         $dstOffset = 0;
 410         $gmtOffset = 0;
 411
 412         $timezoneString = "BEGIN:VTIMEZONE\n";
 413         $timezoneString .= "TZID:" . $timezoneName . "\n";
 414         $timezoneString .= "X-LIC-LOCATION:" . $timezoneName . "\n";
 415
 416         if (array_key_exists('start', $dstRange))
 417         {
 418             $dstOffset = ($dstRange['start']['offset'] / 60);
 419             $startDate = new DateTime("@" . $dstRange["start"]["ts"], $gmtTZ);
 420             $startstamp = strtotime($timedate->asDb($startDate));
 421             $timezoneString .= "BEGIN:DAYLIGHT\n";
 422             $timezoneString .= "TZOFFSETFROM:" . $this->convertMinsToHoursAndMins($gmtOffset) . "\n";
 423             $timezoneString .= "TZOFFSETTO:" . $this->convertMinsToHoursAndMins($dstOffset) . "\n";
 424             $timezoneString .= "DTSTART:" . str_replace("Z", "", $this->getUtcTime($startstamp)) . "\n";
 425             $timezoneString .= "END:DAYLIGHT\n";
 426         }
 427
 428         if (array_key_exists('end', $dstRange))
 429         {
 430             $gmtOffset = ($dstRange['end']['offset'] / 60);
 431             $endDate = new DateTime("@" . $dstRange["end"]["ts"], $gmtTZ);
 432             $endstamp = strtotime($timedate->asDb($endDate));
 433             $timezoneString .= "BEGIN:STANDARD\n";
 434             $timezoneString .= "TZOFFSETFROM:" . $this->convertMinsToHoursAndMins($dstOffset) . "\n";
 435             $timezoneString .= "TZOFFSETTO:" . $this->convertMinsToHoursAndMins($gmtOffset) . "\n";
 436             $timezoneString .= "DTSTART:" . str_replace("Z", "", $this->getUtcTime($endstamp)) . "\n";
 437             $timezoneString .= "END:STANDARD\n";
 438         }
 439
 440         $timezoneString .= "END:VTIMEZONE\n";
 441
 442         return $timezoneString;
 443     }
 444
 445     /**
 446     * Generates the complete string for the calendar
 447     *
 448     * @param User $user_focus the user
 449     * @param integer $num_months the number of months to search before and after today
 450     * @return string the iCal calenar string
 451     */
 452     function getVcalIcal(&$user_focus, $num_months)
 453     {
 454         global $current_user, $timedate;
 455         $current_user = $user_focus;
 456
 457         $cal_name = $user_focus->first_name. " ". $user_focus->last_name;
 458
 459         $str = "BEGIN:VCALENDAR\n";
 460         $str .= "VERSION:2.0\n";
 461         $str .= "METHOD:PUBLISH\n";
 462         $str .= "X-WR-CALNAME:$cal_name (SugarCRM)\n";
 463         $str .= "PRODID:-//SugarCRM//SugarCRM Calendar//EN\n";
 464         $str .= $this->getTimezoneString();
 465         $str .= "CALSCALE:GREGORIAN\n";
 466
 467         $now_date_time = $timedate->getNow(true);
 468
 469         global $sugar_config;
 470         $timeOffset = 2;
 471         if (isset($sugar_config['vcal_time']) && $sugar_config['vcal_time'] != 0 && $sugar_config['vcal_time'] < 13)
 472         {
 473             $timeOffset = $sugar_config['vcal_time'];
 474         }
 475         if (!empty($num_months))
 476         {
 477             $timeOffset = $num_months;
 478         }
 479         $start_date_time = $now_date_time->get("-$timeOffset months");
 480         $end_date_time = $now_date_time->get("+$timeOffset months");
 481
 482         $utc_now_time = $this->getUtcDateTime($now_date_time);
 483
 484         $str .= $this->createSugarIcal($user_focus,$start_date_time,$end_date_time,$utc_now_time);
 485
 486         $str .= "DTSTAMP:" . $utc_now_time . "\n";
 487         $str .= "END:VCALENDAR\n";
 488
 489         return $str;
 490     }
 491
 492 }