3 * @file include/event.php
4 * @brief functions specific to event handling
8 use Friendica\Content\Feature;
9 use Friendica\Core\PConfig;
10 use Friendica\Core\System;
11 use Friendica\Database\DBM;
13 require_once 'include/bbcode.php';
14 require_once 'include/map.php';
15 require_once 'include/datetime.php';
16 require_once "include/conversation.php";
18 function format_event_html($ev, $simple = false) {
19 if (! ((is_array($ev)) && count($ev))) {
23 $bd_format = t('l F d, Y \@ g:i A') ; // Friday January 18, 2011 @ 8 AM.
25 $event_start = (($ev['adjust']) ? day_translate(datetime_convert('UTC', date_default_timezone_get(),
26 $ev['start'] , $bd_format ))
27 : day_translate(datetime_convert('UTC', 'UTC',
28 $ev['start'] , $bd_format)));
30 $event_end = (($ev['adjust']) ? day_translate(datetime_convert('UTC', date_default_timezone_get(),
31 $ev['finish'] , $bd_format ))
32 : day_translate(datetime_convert('UTC', 'UTC',
33 $ev['finish'] , $bd_format )));
36 $o = "<h3>" . bbcode($ev['summary']) . "</h3>";
38 $o .= "<div>" . bbcode($ev['desc']) . "</div>";
40 $o .= "<h4>" . t('Starts:') . "</h4><p>" . $event_start . "</p>";
42 if (! $ev['nofinish']) {
43 $o .= "<h4>" . t('Finishes:') . "</h4><p>" . $event_end ."</p>";
46 if (strlen($ev['location'])) {
47 $o .= "<h4>" . t('Location:') . "</h4><p>" . $ev['location'] . "</p>";
53 $o = '<div class="vevent">' . "\r\n";
55 $o .= '<div class="summary event-summary">' . bbcode($ev['summary']) . '</div>' . "\r\n";
57 $o .= '<div class="event-start"><span class="event-label">' . t('Starts:') . '</span> <span class="dtstart" title="'
58 . datetime_convert('UTC', 'UTC', $ev['start'], (($ev['adjust']) ? ATOM_TIME : 'Y-m-d\TH:i:s' ))
60 . '</span></div>' . "\r\n";
62 if (! $ev['nofinish']) {
63 $o .= '<div class="event-end" ><span class="event-label">' . t('Finishes:') . '</span> <span class="dtend" title="'
64 . datetime_convert('UTC', 'UTC', $ev['finish'], (($ev['adjust']) ? ATOM_TIME : 'Y-m-d\TH:i:s' ))
66 . '</span></div>' . "\r\n";
69 $o .= '<div class="description event-description">' . bbcode($ev['desc']) . '</div>' . "\r\n";
71 if (strlen($ev['location'])) {
72 $o .= '<div class="event-location"><span class="event-label">' . t('Location:') . '</span> <span class="location">'
73 . bbcode($ev['location'])
74 . '</span></div>' . "\r\n";
76 // Include a map of the location if the [map] BBCode is used.
77 if (strpos($ev['location'], "[map") !== false) {
78 $map = generate_named_map($ev['location']);
79 if ($map !== $ev['location']) {
85 $o .= '</div>' . "\r\n";
90 * @brief Convert an array with event data to bbcode.
92 * @param array $ev Array which conains the event data.
93 * @return string The event as a bbcode formatted string.
95 function format_event_bbcode($ev) {
100 $o .= '[event-summary]' . $ev['summary'] . '[/event-summary]';
104 $o .= '[event-description]' . $ev['desc'] . '[/event-description]';
108 $o .= '[event-start]' . $ev['start'] . '[/event-start]';
111 if (($ev['finish']) && (! $ev['nofinish'])) {
112 $o .= '[event-finish]' . $ev['finish'] . '[/event-finish]';
115 if ($ev['location']) {
116 $o .= '[event-location]' . $ev['location'] . '[/event-location]';
120 $o .= '[event-adjust]' . $ev['adjust'] . '[/event-adjust]';
127 * @brief Extract bbcode formatted event data from a string
128 * and convert it to html.
130 * @params: string $s The string which should be parsed for event data.
131 * @return string The html output.
133 function bbtovcal($s) {
138 $o = format_event_html($ev);
145 * @brief Extract bbcode formatted event data from a string.
147 * @params: string $s The string which should be parsed for event data.
148 * @return array The array with the event information.
150 function bbtoevent($s) {
155 if (preg_match("/\[event\-summary\](.*?)\[\/event\-summary\]/is", $s, $match)) {
156 $ev['summary'] = $match[1];
160 if (preg_match("/\[event\-description\](.*?)\[\/event\-description\]/is", $s, $match)) {
161 $ev['desc'] = $match[1];
165 if (preg_match("/\[event\-start\](.*?)\[\/event\-start\]/is", $s, $match)) {
166 $ev['start'] = $match[1];
170 if (preg_match("/\[event\-finish\](.*?)\[\/event\-finish\]/is", $s, $match)) {
171 $ev['finish'] = $match[1];
175 if (preg_match("/\[event\-location\](.*?)\[\/event\-location\]/is", $s, $match)) {
176 $ev['location'] = $match[1];
180 if (preg_match("/\[event\-adjust\](.*?)\[\/event\-adjust\]/is", $s, $match)) {
181 $ev['adjust'] = $match[1];
184 $ev['nofinish'] = (((x($ev, 'start') && $ev['start']) && (!x($ev, 'finish') || !$ev['finish'])) ? 1 : 0);
189 function sort_by_date($a) {
191 usort($a,'ev_compare');
195 function ev_compare($a,$b) {
197 $date_a = (($a['adjust']) ? datetime_convert('UTC', date_default_timezone_get(), $a['start']) : $a['start']);
198 $date_b = (($b['adjust']) ? datetime_convert('UTC', date_default_timezone_get(), $b['start']) : $b['start']);
200 if ($date_a === $date_b) {
201 return strcasecmp($a['desc'], $b['desc']);
204 return strcmp($date_a, $date_b);
208 * @brief Delete an event from the event table.
210 * Note: This function does only delete the event from the event table not its
211 * related entry in the item table.
213 * @param int $event_id Event ID.
216 function event_delete($event_id) {
217 if ($event_id == 0) {
221 dba::delete('event', array('id' => $event_id));
222 logger("Deleted event ".$event_id, LOGGER_DEBUG);
226 * @brief Store the event.
228 * Store the event in the event table and create an event item in the item table.
230 * @param array $arr Array with event data.
231 * @return int The event id.
233 function event_store($arr) {
235 require_once 'include/datetime.php';
236 require_once 'include/items.php';
237 require_once 'include/bbcode.php';
241 $arr['created'] = (($arr['created']) ? $arr['created'] : datetime_convert());
242 $arr['edited'] = (($arr['edited']) ? $arr['edited'] : datetime_convert());
243 $arr['type'] = (($arr['type']) ? $arr['type'] : 'event' );
244 $arr['cid'] = ((intval($arr['cid'])) ? intval($arr['cid']) : 0);
245 $arr['uri'] = (x($arr, 'uri') ? $arr['uri'] : item_new_uri($a->get_hostname(), $arr['uid']));
246 $arr['private'] = ((x($arr, 'private')) ? intval($arr['private']) : 0);
247 $arr['guid'] = get_guid(32);
250 $c = q("SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d LIMIT 1",
255 $c = q("SELECT * FROM `contact` WHERE `self` = 1 AND `uid` = %d LIMIT 1",
260 if (DBM::is_result($c)) {
265 // Existing event being modified.
269 // has the event actually changed?
271 $r = q("SELECT * FROM `event` WHERE `id` = %d AND `uid` = %d LIMIT 1",
275 if ((! DBM::is_result($r)) || ($r[0]['edited'] === $arr['edited'])) {
277 // Nothing has changed. Grab the item id to return.
279 $r = q("SELECT * FROM `item` WHERE `event-id` = %d AND `uid` = %d LIMIT 1",
283 return ((DBM::is_result($r)) ? $r[0]['id'] : 0);
286 // The event changed. Update it.
288 $r = q("UPDATE `event` SET
298 WHERE `id` = %d AND `uid` = %d",
300 dbesc($arr['edited']),
301 dbesc($arr['start']),
302 dbesc($arr['finish']),
303 dbesc($arr['summary']),
305 dbesc($arr['location']),
307 intval($arr['adjust']),
308 intval($arr['nofinish']),
312 $r = q("SELECT * FROM `item` WHERE `event-id` = %d AND `uid` = %d LIMIT 1",
316 if (DBM::is_result($r)) {
317 $object = '<object><type>' . xmlify(ACTIVITY_OBJ_EVENT) . '</type><title></title><id>' . xmlify($arr['uri']) . '</id>';
318 $object .= '<content>' . xmlify(format_event_bbcode($arr)) . '</content>';
319 $object .= '</object>' . "\n";
321 q("UPDATE `item` SET `body` = '%s', `object` = '%s', `edited` = '%s' WHERE `id` = %d AND `uid` = %d",
322 dbesc(format_event_bbcode($arr)),
324 dbesc($arr['edited']),
329 $item_id = $r[0]['id'];
334 call_hooks("event_updated", $arr['id']);
338 // New event. Store it.
340 $r = q("INSERT INTO `event` (`uid`,`cid`,`guid`,`uri`,`created`,`edited`,`start`,`finish`,`summary`, `desc`,`location`,`type`,
341 `adjust`,`nofinish`,`allow_cid`,`allow_gid`,`deny_cid`,`deny_gid`)
342 VALUES ( %d, %d, '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', %d, %d, '%s', '%s', '%s', '%s' ) ",
347 dbesc($arr['created']),
348 dbesc($arr['edited']),
349 dbesc($arr['start']),
350 dbesc($arr['finish']),
351 dbesc($arr['summary']),
353 dbesc($arr['location']),
355 intval($arr['adjust']),
356 intval($arr['nofinish']),
357 dbesc($arr['allow_cid']),
358 dbesc($arr['allow_gid']),
359 dbesc($arr['deny_cid']),
360 dbesc($arr['deny_gid'])
363 $r = q("SELECT * FROM `event` WHERE `uri` = '%s' AND `uid` = %d LIMIT 1",
367 if (DBM::is_result($r)) {
373 $item_arr['uid'] = $arr['uid'];
374 $item_arr['contact-id'] = $arr['cid'];
375 $item_arr['uri'] = $arr['uri'];
376 $item_arr['parent-uri'] = $arr['uri'];
377 $item_arr['guid'] = $arr['guid'];
378 $item_arr['type'] = 'activity';
379 $item_arr['wall'] = (($arr['cid']) ? 0 : 1);
380 $item_arr['contact-id'] = $contact['id'];
381 $item_arr['owner-name'] = $contact['name'];
382 $item_arr['owner-link'] = $contact['url'];
383 $item_arr['owner-avatar'] = $contact['thumb'];
384 $item_arr['author-name'] = $contact['name'];
385 $item_arr['author-link'] = $contact['url'];
386 $item_arr['author-avatar'] = $contact['thumb'];
387 $item_arr['title'] = '';
388 $item_arr['allow_cid'] = $arr['allow_cid'];
389 $item_arr['allow_gid'] = $arr['allow_gid'];
390 $item_arr['deny_cid'] = $arr['deny_cid'];
391 $item_arr['deny_gid'] = $arr['deny_gid'];
392 $item_arr['private'] = $arr['private'];
393 $item_arr['last-child'] = 1;
394 $item_arr['visible'] = 1;
395 $item_arr['verb'] = ACTIVITY_POST;
396 $item_arr['object-type'] = ACTIVITY_OBJ_EVENT;
397 $item_arr['origin'] = ((intval($arr['cid']) == 0) ? 1 : 0);
398 $item_arr['body'] = format_event_bbcode($event);
401 $item_arr['object'] = '<object><type>' . xmlify(ACTIVITY_OBJ_EVENT) . '</type><title></title><id>' . xmlify($arr['uri']) . '</id>';
402 $item_arr['object'] .= '<content>' . xmlify(format_event_bbcode($event)) . '</content>';
403 $item_arr['object'] .= '</object>' . "\n";
405 $item_id = item_store($item_arr);
407 $r = q("SELECT * FROM `user` WHERE `uid` = %d LIMIT 1",
410 //if (DBM::is_result($r))
411 // $plink = System::baseUrl() . '/display/' . $r[0]['nickname'] . '/' . $item_id;
415 //q("UPDATE `item` SET `plink` = '%s', `event-id` = %d WHERE `uid` = %d AND `id` = %d",
417 // intval($event['id']),
418 // intval($arr['uid']),
421 q("UPDATE `item` SET `event-id` = %d WHERE `uid` = %d AND `id` = %d",
422 intval($event['id']),
428 call_hooks("event_created", $event['id']);
435 * @brief Create an array with translation strings used for events.
437 * @return array Array with translations strings.
439 function get_event_strings() {
441 // First day of the week (0 = Sunday).
442 $firstDay = PConfig::get(local_user(), 'system', 'first_day_of_week', 0);
445 "firstDay" => $firstDay,
446 "allday" => t("all-day"),
456 "Sunday" => t("Sunday"),
457 "Monday" => t("Monday"),
458 "Tuesday" => t("Tuesday"),
459 "Wednesday" => t("Wednesday"),
460 "Thursday" => t("Thursday"),
461 "Friday" => t("Friday"),
462 "Saturday" => t("Saturday"),
477 "January" => t("January"),
478 "February" => t("February"),
479 "March" => t("March"),
480 "April" => t("April"),
484 "August" => t("August"),
485 "September" => t("September"),
486 "October" => t("October"),
487 "November" => t("November"),
488 "December" => t("December"),
490 "today" => t("today"),
491 "month" => t("month"),
495 "noevent" => t("No events to display"),
497 "dtstart_label" => t("Starts:"),
498 "dtend_label" => t("Finishes:"),
499 "location_label" => t("Location:")
506 * @brief Removes duplicated birthday events.
508 * @param array $dates Array of possibly duplicated events.
509 * @return array Cleaned events.
511 * @todo We should replace this with a separate update function if there is some time left.
513 function event_remove_duplicates($dates) {
516 foreach ($dates as $date) {
517 if ($date['type'] == 'birthday') {
518 $dates2[$date['uid'] . "-" . $date['cid'] . "-" . $date['start']] = $date;
527 * @brief Get an event by its event ID.
529 * @param type $owner_uid The User ID of the owner of the event
530 * @param type $event_params An assoziative array with
531 * int 'event_id' => The ID of the event in the event table
532 * @param type $sql_extra
533 * @return array Query result
535 function event_by_id($owner_uid = 0, $event_params, $sql_extra = '') {
536 // Ownly allow events if there is a valid owner_id.
537 if ($owner_uid == 0) {
541 // Query for the event by event id
542 $r = q("SELECT `event`.*, `item`.`id` AS `itemid`,`item`.`plink`,
543 `item`.`author-name`, `item`.`author-avatar`, `item`.`author-link` FROM `event`
544 LEFT JOIN `item` ON `item`.`event-id` = `event`.`id` AND `item`.`uid` = `event`.`uid`
545 WHERE `event`.`uid` = %d AND `event`.`id` = %d $sql_extra",
547 intval($event_params["event_id"])
550 if (DBM::is_result($r)) {
551 return event_remove_duplicates($r);
556 * @brief Get all events in a specific timeframe.
558 * @param int $owner_uid The User ID of the owner of the events.
559 * @param array $event_params An assoziative array with
560 * int 'ignored' =><br>
561 * string 'start' => Start time of the timeframe.<br>
562 * string 'finish' => Finish time of the timeframe.<br>
563 * string 'adjust_start' =><br>
564 * string 'adjust_start' =>
566 * @param string $sql_extra Additional sql conditions (e.g. permission request).
568 * @return array Query results.
570 function events_by_date($owner_uid = 0, $event_params, $sql_extra = '') {
571 // Only allow events if there is a valid owner_id.
572 if ($owner_uid == 0) {
576 // Query for the event by date.
577 $r = q("SELECT `event`.*, `item`.`id` AS `itemid`,`item`.`plink`,
578 `item`.`author-name`, `item`.`author-avatar`, `item`.`author-link` FROM `event`
579 LEFT JOIN `item` ON `item`.`event-id` = `event`.`id` AND `item`.`uid` = `event`.`uid`
580 WHERE `event`.`uid` = %d AND event.ignore = %d
581 AND ((`adjust` = 0 AND (`finish` >= '%s' OR (nofinish AND start >= '%s')) AND `start` <= '%s')
582 OR (`adjust` = 1 AND (`finish` >= '%s' OR (nofinish AND start >= '%s')) AND `start` <= '%s'))
585 intval($event_params["ignored"]),
586 dbesc($event_params["start"]),
587 dbesc($event_params["start"]),
588 dbesc($event_params["finish"]),
589 dbesc($event_params["adjust_start"]),
590 dbesc($event_params["adjust_start"]),
591 dbesc($event_params["adjust_finish"])
594 if (DBM::is_result($r)) {
595 return event_remove_duplicates($r);
600 * @brief Convert an array query results in an arry which could be used by the events template.
602 * @param array $arr Event query array.
603 * @return array Event array for the template.
605 function process_events($arr) {
611 foreach ($arr as $rr) {
612 $j = (($rr['adjust']) ? datetime_convert('UTC', date_default_timezone_get(), $rr['start'], 'j') : datetime_convert('UTC', 'UTC', $rr['start'], 'j'));
613 $d = (($rr['adjust']) ? datetime_convert('UTC', date_default_timezone_get(), $rr['start'], $fmt) : datetime_convert('UTC', 'UTC', $rr['start'], $fmt));
614 $d = day_translate($d);
616 $start = (($rr['adjust']) ? datetime_convert('UTC', date_default_timezone_get(), $rr['start'], 'c') : datetime_convert('UTC', 'UTC', $rr['start'], 'c'));
617 if ($rr['nofinish']) {
620 $end = (($rr['adjust']) ? datetime_convert('UTC', date_default_timezone_get(), $rr['finish'], 'c') : datetime_convert('UTC', 'UTC', $rr['finish'], 'c'));
623 $is_first = ($d !== $last_date);
627 // Show edit and drop actions only if the user is the owner of the event and the event
628 // is a real event (no bithdays).
629 if (local_user() && local_user() == $rr['uid'] && $rr['type'] == 'event') {
630 $edit = ((! $rr['cid']) ? array(System::baseUrl() . '/events/event/' . $rr['id'], t('Edit event'), '', '') : null);
631 $copy = ((! $rr['cid']) ? array(System::baseUrl() . '/events/copy/' . $rr['id'], t('Duplicate event'), '', '') : null);
632 $drop = array(System::baseUrl() . '/events/drop/' . $rr['id'], t('Delete event'), '', '');
635 $title = strip_tags(html_entity_decode(bbcode($rr['summary']), ENT_QUOTES, 'UTF-8'));
637 list($title, $_trash) = explode("<br", bbcode($rr['desc']), 2);
638 $title = strip_tags(html_entity_decode($title, ENT_QUOTES, 'UTF-8'));
641 $html = format_event_html($rr);
642 $rr['desc'] = bbcode($rr['desc']);
643 $rr['location'] = bbcode($rr['location']);
656 'is_first' => $is_first,
659 'plink' => array($rr['plink'], t('link to source'), '', ''),
668 * @brief Format event to export format (ical/csv).
670 * @param array $events Query result for events.
671 * @param string $format The output format (ical/csv).
672 * @param string $timezone The timezone of the user (not implemented yet).
674 * @return string Content according to selected export format.
676 function event_format_export ($events, $format = 'ical', $timezone) {
677 if (! ((is_array($events)) && count($events))) {
682 // Format the exported data as a CSV file.
684 header("Content-type: text/csv");
685 $o = '"Subject", "Start Date", "Start Time", "Description", "End Date", "End Time", "Location"' . PHP_EOL;
687 foreach ($events as $event) {
688 /// @todo The time / date entries don't include any information about the
689 /// timezone the event is scheduled in :-/
690 $tmp1 = strtotime($event['start']);
691 $tmp2 = strtotime($event['finish']);
692 $time_format = "%H:%M:%S";
693 $date_format = "%Y-%m-%d";
695 $o .= '"' . $event['summary'] . '", "' . strftime($date_format, $tmp1) .
696 '", "' . strftime($time_format, $tmp1) . '", "' . $event['desc'] .
697 '", "' . strftime($date_format, $tmp2) .
698 '", "' . strftime($time_format, $tmp2) .
699 '", "' . $event['location'] . '"' . PHP_EOL;
703 // Format the exported data as a ics file.
705 header("Content-type: text/ics");
706 $o = 'BEGIN:VCALENDAR' . PHP_EOL
707 . 'VERSION:2.0' . PHP_EOL
708 . 'PRODID:-//friendica calendar export//0.1//EN' . PHP_EOL;
709 /// @todo include timezone informations in cases were the time is not in UTC
710 // see http://tools.ietf.org/html/rfc2445#section-4.8.3
711 // . 'BEGIN:VTIMEZONE' . PHP_EOL
712 // . 'TZID:' . $timezone . PHP_EOL
713 // . 'END:VTIMEZONE' . PHP_EOL;
714 // TODO instead of PHP_EOL CRLF should be used for long entries
715 // but test your solution against http://icalvalid.cloudapp.net/
716 // also long lines SHOULD be split at 75 characters length
717 foreach ($events as $event) {
718 if ($event['adjust'] == 1) {
723 $o .= 'BEGIN:VEVENT' . PHP_EOL;
725 if ($event['start']) {
726 $tmp = strtotime($event['start']);
727 $dtformat = "%Y%m%dT%H%M%S" . $UTC;
728 $o .= 'DTSTART:' . strftime($dtformat, $tmp) . PHP_EOL;
731 if (!$event['nofinish']) {
732 $tmp = strtotime($event['finish']);
733 $dtformat = "%Y%m%dT%H%M%S" . $UTC;
734 $o .= 'DTEND:' . strftime($dtformat, $tmp) . PHP_EOL;
737 if ($event['summary']) {
738 $tmp = $event['summary'];
739 $tmp = str_replace(PHP_EOL, PHP_EOL . ' ', $tmp);
740 $tmp = addcslashes($tmp, ',;');
741 $o .= 'SUMMARY:' . $tmp . PHP_EOL;
744 if ($event['desc']) {
745 $tmp = $event['desc'];
746 $tmp = str_replace(PHP_EOL, PHP_EOL . ' ', $tmp);
747 $tmp = addcslashes($tmp, ',;');
748 $o .= 'DESCRIPTION:' . $tmp . PHP_EOL;
751 if ($event['location']) {
752 $tmp = $event['location'];
753 $tmp = str_replace(PHP_EOL, PHP_EOL . ' ', $tmp);
754 $tmp = addcslashes($tmp, ',;');
755 $o .= 'LOCATION:' . $tmp . PHP_EOL;
758 $o .= 'END:VEVENT' . PHP_EOL;
762 $o .= 'END:VCALENDAR' . PHP_EOL;
770 * @brief Get all events for a user ID.
772 * The query for events is done permission sensitive.
773 * If the user is the owner of the calendar he/she
774 * will get all of his/her available events.
775 * If the user is only a visitor only the public events will
778 * @param int $uid The user ID.
779 * @param int $sql_extra Additional sql conditions for permission.
781 * @return array Query results.
783 function events_by_uid($uid = 0, $sql_extra = '') {
788 // The permission condition if no condition was transmitted.
789 if ($sql_extra == '') {
790 $sql_extra = " AND `allow_cid` = '' AND `allow_gid` = '' ";
793 // Does the user who requests happen to be the owner of the events
794 // requested? then show all of your events, otherwise only those that
795 // don't have limitations set in allow_cid and allow_gid.
796 if (local_user() == $uid) {
797 $r = q("SELECT `start`, `finish`, `adjust`, `summary`, `desc`, `location`, `nofinish`
798 FROM `event` WHERE `uid`= %d AND `cid` = 0 ",
802 $r = q("SELECT `start`, `finish`, `adjust`, `summary`, `desc`, `location`, `nofinish`
803 FROM `event` WHERE `uid`= %d AND `cid` = 0 $sql_extra ",
808 if (DBM::is_result($r)) {
815 * @param int $uid The user ID.
816 * @param string $format Output format (ical/csv).
817 * @return array With the results:
818 * bool 'success' => True if the processing was successful,<br>
819 * string 'format' => The output format,<br>
820 * string 'extension' => The file extension of the output format,<br>
821 * string 'content' => The formatted output content.<br>
823 * @todo Respect authenticated users with events_by_uid().
825 function event_export($uid, $format = 'ical') {
829 // We are allowed to show events.
830 // Get the timezone the user is in.
831 $r = q("SELECT `timezone` FROM `user` WHERE `uid` = %d LIMIT 1", intval($uid));
832 if (DBM::is_result($r)) {
833 $timezone = $r[0]['timezone'];
836 // Get all events which are owned by a uid (respects permissions).
837 $events = events_by_uid($uid);
839 // We have the events that are available for the requestor.
840 // Now format the output according to the requested format.
841 if (count($events)) {
842 $res = event_format_export($events, $format, $timezone);
845 // If there are results the precess was successfull.
850 // Get the file extension for the format.
865 'success' => $process,
867 'extension' => $file_ext,
875 * @brief Get the events widget.
877 * @return string Formated html of the evens widget.
879 function widget_events() {
882 $owner_uid = $a->data['user']['uid'];
883 // $a->data is only available if the profile page is visited. If the visited page is not part
884 // of the profile page it should be the personal /events page. So we can use $a->user.
885 $user = ($a->data['user']['nickname'] ? $a->data['user']['nickname'] : $a->user['nickname']);
888 // The permission testing is a little bit tricky because we have to respect many cases.
890 // It's not the private events page (we don't get the $owner_uid for /events).
891 if (! local_user() && ! $owner_uid) {
896 * Cal logged in user (test permission at foreign profile page).
897 * If the $owner uid is available we know it is part of one of the profile pages (like /cal).
898 * So we have to test if if it's the own profile page of the logged in user
899 * or a foreign one. For foreign profile pages we need to check if the feature
900 * for exporting the cal is enabled (otherwise the widget would appear for logged in users
901 * on foreigen profile pages even if the widget is disabled).
903 if (intval($owner_uid) && local_user() !== $owner_uid && ! Feature::isEnabled($owner_uid, "export_calendar")) {
908 * If it's a kind of profile page (intval($owner_uid)) return if the user not logged in and
909 * export feature isn't enabled.
911 if (intval($owner_uid) && ! local_user() && ! Feature::isEnabled($owner_uid, "export_calendar")) {
915 return replace_macros(get_markup_template("events_aside.tpl"), array(
916 '$etitle' => t("Export"),
917 '$export_ical' => t("Export calendar as ical"),
918 '$export_csv' => t("Export calendar as csv"),
924 * @brief Format an item array with event data to HTML.
926 * @param arr $item Array with item and event data.
927 * @return string HTML output.
929 function format_event_item($item) {
933 // Set the different time formats.
934 $dformat = t('l F d, Y \@ g:i A'); // Friday January 18, 2011 @ 8:01 AM.
935 $dformat_short = t('D g:i A'); // Fri 8:01 AM.
936 $tformat = t('g:i A'); // 8:01 AM.
938 // Convert the time to different formats.
939 $dtstart_dt = (($item['event-adjust']) ? day_translate(datetime_convert('UTC', date_default_timezone_get(), $item['event-start'], $dformat)) : day_translate(datetime_convert('UTC', 'UTC', $item['event-start'], $dformat)));
940 $dtstart_title = datetime_convert('UTC', 'UTC', $item['event-start'], (($item['event-adjust']) ? ATOM_TIME : 'Y-m-d\TH:i:s'));
941 // Format: Jan till Dec.
942 $month_short = (($item['event-adjust']) ? day_short_translate(datetime_convert('UTC', date_default_timezone_get(), $item['event-start'], 'M')) : day_short_translate(datetime_convert('UTC', 'UTC', $item['event-start'], 'M')));
943 // Format: 1 till 31.
944 $date_short = (($item['event-adjust']) ? datetime_convert('UTC', date_default_timezone_get(), $item['event-start'], 'j') : datetime_convert('UTC', 'UTC', $item['event-start'], 'j'));
945 $start_time = (($item['event-adjust']) ? datetime_convert('UTC', date_default_timezone_get(), $item['event-start'], $tformat) : datetime_convert('UTC', 'UTC', $item['event-start'], $tformat));
946 $start_short = (($item['event-adjust']) ? day_short_translate(datetime_convert('UTC', date_default_timezone_get(), $item['event-start'], $dformat_short)) : day_short_translate(datetime_convert('UTC', 'UTC', $item['event-start'], $dformat_short)));
948 // If the option 'nofinisch' isn't set, we need to format the finish date/time.
949 if (!$item['event-nofinish']) {
951 $dtend_dt = (($item['event-adjust']) ? day_translate(datetime_convert('UTC', date_default_timezone_get(), $item['event-finish'], $dformat)) : day_translate(datetime_convert('UTC', 'UTC', $item['event-finish'], $dformat)));
952 $dtend_title = datetime_convert('UTC', 'UTC', $item['event-finish'], (($item['event-adjust']) ? ATOM_TIME : 'Y-m-d\TH:i:s'));
953 $end_short = (($item['event-adjust']) ? day_short_translate(datetime_convert('UTC', date_default_timezone_get(), $item['event-finish'], $dformat_short)) : day_short_translate(datetime_convert('UTC', 'UTC', $item['event-finish'], $dformat_short)));
954 $end_time = (($item['event-adjust']) ? datetime_convert('UTC', date_default_timezone_get(), $item['event-finish'], $tformat) : datetime_convert('UTC', 'UTC', $item['event-finish'], $tformat));
955 // Check if start and finish time is at the same day.
956 if (substr($dtstart_title, 0, 10) === substr($dtend_title, 0, 10)) {
961 // Format the event location.
962 $evloc = event_location2array($item['event-location']);
965 if (isset($evloc['name'])) {
966 $location['name'] = prepare_text($evloc['name']);
968 // Construct the map HTML.
969 if (isset($evloc['address'])) {
970 $location['map'] = '<div class="map">' . generate_named_map($evloc['address']) . '</div>';
971 } elseif (isset($evloc['coordinates'])) {
972 $location['map'] = '<div class="map">' . generate_map(str_replace('/', ' ', $evloc['coordinates'])) . '</div>';
975 // Construct the profile link (magic-auth).
977 $profile_link = best_link_url($item, $sp);
980 $profile_link = zrl($profile_link);
983 $event = replace_macros(get_markup_template('event_stream_item.tpl'), array(
984 '$id' => $item['event-id'],
985 '$title' => prepare_text($item['event-summary']),
986 '$dtstart_label' => t('Starts:'),
987 '$dtstart_title' => $dtstart_title,
988 '$dtstart_dt' => $dtstart_dt,
989 '$finish' => $finish,
990 '$dtend_label' => t('Finishes:'),
991 '$dtend_title' => $dtend_title,
992 '$dtend_dt' => $dtend_dt,
993 '$month_short' => $month_short,
994 '$date_short' => $date_short,
995 '$same_date' => $same_date,
996 '$start_time' => $start_time,
997 '$start_short' => $start_short,
998 '$end_time' => $end_time,
999 '$end_short' => $end_short,
1000 '$author_name' => $item['author-name'],
1001 '$author_link' => $profile_link,
1002 '$author_avatar' => $item['author-avatar'],
1003 '$description' => prepare_text($item['event-desc']),
1004 '$location_label' => t('Location:'),
1005 '$show_map_label' => t('Show map'),
1006 '$hide_map_label' => t('Hide map'),
1007 '$map_btn_label' => t('Show map'),
1008 '$location' => $location
1015 * @brief Format a string with map bbcode to an array with location data.
1017 * Note: The string must only contain location data. A string with no bbcode will be
1018 * handled as location name.
1020 * @param string $s The string with the bbcode formatted location data.
1022 * @return array The array with the location data.
1023 * 'name' => The name of the location,<br>
1024 * 'address' => The address of the location,<br>
1025 * 'coordinates' => Latitude and longitude (e.g. '48.864716,2.349014').<br>
1027 function event_location2array($s = '') {
1032 $location = array('name' => $s);
1034 // Map tag with location name - e.g. [map]Paris[/map].
1035 if (strpos($s, '[/map]') !== false) {
1036 $found = preg_match("/\[map\](.*?)\[\/map\]/ism", $s, $match);
1037 if (intval($found) > 0 && array_key_exists(1, $match)) {
1038 $location['address'] = $match[1];
1039 // Remove the map bbcode from the location name.
1040 $location['name'] = str_replace($match[0], "", $s);
1042 // Map tag with coordinates - e.g. [map=48.864716,2.349014].
1043 } elseif (strpos($s, '[map=') !== false) {
1044 $found = preg_match("/\[map=(.*?)\]/ism", $s, $match);
1045 if (intval($found) > 0 && array_key_exists(1, $match)) {
1046 $location['coordinates'] = $match[1];
1047 // Remove the map bbcode from the location name.
1048 $location['name'] = str_replace($match[0], "", $s);