3 * @copyright Copyright (C) 2010-2022, the Friendica project
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Model;
24 use Friendica\Content\Text\BBCode;
25 use Friendica\Core\Hook;
26 use Friendica\Core\Logger;
27 use Friendica\Core\Protocol;
28 use Friendica\Core\Renderer;
29 use Friendica\Core\System;
30 use Friendica\Database\DBA;
32 use Friendica\Protocol\Activity;
33 use Friendica\Util\DateTimeFormat;
34 use Friendica\Util\Map;
35 use Friendica\Util\Strings;
36 use Friendica\Util\XML;
39 * functions for interacting with the event database table
44 public static function getHTML(array $event, bool $simple = false, int $uriid = 0): string
50 $uriid = $event['uri-id'] ?? $uriid;
52 $bd_format = DI::l10n()->t('l F d, Y \@ g:i A \G\M\TP (e)'); // Friday October 29, 2021 @ 9:15 AM GMT-04:00 (America/New_York)
54 $event_start = DI::l10n()->getDay(DateTimeFormat::local($event['start'], $bd_format));
56 if (!empty($event['finish'])) {
57 $event_end = DI::l10n()->getDay(DateTimeFormat::local($event['finish'], $bd_format));
65 if (!empty($event['summary'])) {
66 $o .= "<h3>" . BBCode::convertForUriId($uriid, Strings::escapeHtml($event['summary']), $simple) . "</h3>";
69 if (!empty($event['desc'])) {
70 $o .= "<div>" . BBCode::convertForUriId($uriid, Strings::escapeHtml($event['desc']), $simple) . "</div>";
73 $o .= "<h4>" . DI::l10n()->t('Starts:') . "</h4><p>" . $event_start . "</p>";
75 if (!$event['nofinish']) {
76 $o .= "<h4>" . DI::l10n()->t('Finishes:') . "</h4><p>" . $event_end . "</p>";
79 if (!empty($event['location'])) {
80 $o .= "<h4>" . DI::l10n()->t('Location:') . "</h4><p>" . BBCode::convertForUriId($uriid, Strings::escapeHtml($event['location']), $simple) . "</p>";
86 $o = '<div class="vevent">' . "\r\n";
88 $o .= '<div class="summary event-summary">' . BBCode::convertForUriId($uriid, Strings::escapeHtml($event['summary']), $simple) . '</div>' . "\r\n";
90 $o .= '<div class="event-start"><span class="event-label">' . DI::l10n()->t('Starts:') . '</span> <span class="dtstart" title="'
91 . DateTimeFormat::local($event['start'], DateTimeFormat::ATOM)
92 . '" >' . $event_start
93 . '</span></div>' . "\r\n";
95 if (!$event['nofinish']) {
96 $o .= '<div class="event-end" ><span class="event-label">' . DI::l10n()->t('Finishes:') . '</span> <span class="dtend" title="'
97 . DateTimeFormat::local($event['finish'], DateTimeFormat::ATOM)
99 . '</span></div>' . "\r\n";
102 if (!empty($event['desc'])) {
103 $o .= '<div class="description event-description">' . BBCode::convertForUriId($uriid, Strings::escapeHtml($event['desc']), $simple) . '</div>' . "\r\n";
106 if (!empty($event['location'])) {
107 $o .= '<div class="event-location"><span class="event-label">' . DI::l10n()->t('Location:') . '</span> <span class="location">'
108 . BBCode::convertForUriId($uriid, Strings::escapeHtml($event['location']), $simple)
109 . '</span></div>' . "\r\n";
111 // Include a map of the location if the [map] BBCode is used.
112 if (strpos($event['location'], "[map") !== false) {
113 $map = Map::byLocation($event['location'], $simple);
114 if ($map !== $event['location']) {
120 $o .= '</div>' . "\r\n";
125 * Convert an array with event data to bbcode.
127 * @param array $event Array which contains the event data.
128 * @return string The event as a bbcode formatted string.
130 private static function getBBCode(array $event): string
134 if ($event['summary']) {
135 $o .= '[event-summary]' . $event['summary'] . '[/event-summary]';
138 if ($event['desc']) {
139 $o .= '[event-description]' . $event['desc'] . '[/event-description]';
142 if ($event['start']) {
143 $o .= '[event-start]' . $event['start'] . '[/event-start]';
146 if (($event['finish']) && (!$event['nofinish'])) {
147 $o .= '[event-finish]' . $event['finish'] . '[/event-finish]';
150 if ($event['location']) {
151 $o .= '[event-location]' . $event['location'] . '[/event-location]';
158 * Extract bbcode formatted event data from a string.
160 * @param string $text The string which should be parsed for event data.
161 * @return array The array with the event information.
163 public static function fromBBCode(string $text): array
168 if (preg_match("/\[event\-summary\](.*?)\[\/event\-summary\]/is", $text, $match)) {
169 $ev['summary'] = $match[1];
173 if (preg_match("/\[event\-description\](.*?)\[\/event\-description\]/is", $text, $match)) {
174 $ev['desc'] = $match[1];
178 if (preg_match("/\[event\-start\](.*?)\[\/event\-start\]/is", $text, $match)) {
179 $ev['start'] = $match[1];
183 if (preg_match("/\[event\-finish\](.*?)\[\/event\-finish\]/is", $text, $match)) {
184 $ev['finish'] = $match[1];
188 if (preg_match("/\[event\-location\](.*?)\[\/event\-location\]/is", $text, $match)) {
189 $ev['location'] = $match[1];
192 $ev['nofinish'] = !empty($ev['start']) && empty($ev['finish']) ? 1 : 0;
197 public static function sortByDate(array $event_list): array
199 usort($event_list, ['self', 'compareDatesCallback']);
203 private static function compareDatesCallback(array $event_a, array $event_b)
205 $date_a = DateTimeFormat::local($event_a['start']);
206 $date_b = DateTimeFormat::local($event_b['start']);
208 if ($date_a === $date_b) {
209 return strcasecmp($event_a['desc'], $event_b['desc']);
212 return strcmp($date_a, $date_b);
216 * Delete an event from the event table.
218 * Note: This function does only delete the event from the event table not its
219 * related entry in the item table.
221 * @param int $event_id Event ID.
225 public static function delete(int $event_id)
227 if ($event_id == 0) {
231 DBA::delete('event', ['id' => $event_id]);
232 Logger::info("Deleted event", ['id' => $event_id]);
238 * Store the event in the event table and create an event item in the item table.
240 * @param array $arr Array with event data.
241 * @return int The new event id.
242 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
244 public static function store(array $arr): int
246 $guid = $arr['guid'] ?? '' ?: System::createUUID();
247 $uri = $arr['uri'] ?? '' ?: Item::newURI($guid);
249 'id' => intval($arr['id'] ?? 0),
250 'uid' => intval($arr['uid'] ?? 0),
251 'cid' => intval($arr['cid'] ?? 0),
254 'uri-id' => ItemURI::insert(['uri' => $uri, 'guid' => $guid]),
255 'type' => ($arr['type'] ?? '') ?: 'event',
256 'summary' => $arr['summary'] ?? '',
257 'desc' => $arr['desc'] ?? '',
258 'location' => $arr['location'] ?? '',
259 'allow_cid' => $arr['allow_cid'] ?? '',
260 'allow_gid' => $arr['allow_gid'] ?? '',
261 'deny_cid' => $arr['deny_cid'] ?? '',
262 'deny_gid' => $arr['deny_gid'] ?? '',
263 'nofinish' => intval($arr['nofinish'] ?? (!empty($arr['start']) && empty($arr['finish']))),
264 'created' => DateTimeFormat::utc(($arr['created'] ?? '') ?: 'now'),
265 'edited' => DateTimeFormat::utc(($arr['edited'] ?? '') ?: 'now'),
266 'start' => DateTimeFormat::utc(($arr['start'] ?? '') ?: DBA::NULL_DATETIME),
267 'finish' => DateTimeFormat::utc(($arr['finish'] ?? '') ?: DBA::NULL_DATETIME),
271 if ($event['finish'] < DBA::NULL_DATETIME) {
272 $event['finish'] = DBA::NULL_DATETIME;
275 // Existing event being modified.
277 // has the event actually changed?
278 $existing_event = DBA::selectFirst('event', ['edited'], ['id' => $event['id'], 'uid' => $event['uid']]);
279 if (!DBA::isResult($existing_event)) {
283 if ($existing_event['edited'] === $event['edited']) {
288 'edited' => $event['edited'],
289 'start' => $event['start'],
290 'finish' => $event['finish'],
291 'summary' => $event['summary'],
292 'desc' => $event['desc'],
293 'location' => $event['location'],
294 'type' => $event['type'],
295 'nofinish' => $event['nofinish'],
298 DBA::update('event', $updated_fields, ['id' => $event['id'], 'uid' => $event['uid']]);
300 $item = Post::selectFirst(['id', 'uri-id'], ['event-id' => $event['id'], 'uid' => $event['uid']]);
301 if (DBA::isResult($item)) {
302 $object = '<object><type>' . XML::escape(Activity\ObjectType::EVENT) . '</type><title></title><id>' . XML::escape($event['uri']) . '</id>';
303 $object .= '<content>' . XML::escape(self::getBBCode($event)) . '</content>';
304 $object .= '</object>' . "\n";
306 $fields = ['body' => self::getBBCode($event), 'object' => $object, 'edited' => $event['edited']];
307 Item::update($fields, ['id' => $item['id']]);
310 Hook::callAll('event_updated', $event['id']);
312 // New event. Store it.
313 DBA::insert('event', $event);
315 $event['id'] = DBA::lastInsertId();
317 Hook::callAll("event_created", $event['id']);
323 public static function getItemArrayForId(int $event_id, array $item = []): array
325 if (empty($event_id)) {
329 $event = DBA::selectFirst('event', [], ['id' => $event_id]);
330 if ($event['type'] != 'event') {
335 $conditions = ['id' => $event['cid']];
337 $conditions = ['uid' => $event['uid'], 'self' => true];
340 $contact = DBA::selectFirst('contact', [], $conditions);
342 $event['id'] = $event_id;
344 $item['uid'] = $event['uid'];
345 $item['contact-id'] = $event['cid'];
346 $item['uri'] = $event['uri'];
347 $item['uri-id'] = ItemURI::getIdByURI($event['uri']);
348 $item['guid'] = $event['guid'];
349 $item['plink'] = $arr['plink'] ?? '';
350 $item['post-type'] = Item::PT_EVENT;
351 $item['wall'] = $event['cid'] ? 0 : 1;
352 $item['contact-id'] = $contact['id'];
353 $item['owner-name'] = $contact['name'];
354 $item['owner-link'] = $contact['url'];
355 $item['owner-avatar'] = $contact['thumb'];
356 $item['author-name'] = $contact['name'];
357 $item['author-link'] = $contact['url'];
358 $item['author-avatar'] = $contact['thumb'];
360 $item['allow_cid'] = $event['allow_cid'];
361 $item['allow_gid'] = $event['allow_gid'];
362 $item['deny_cid'] = $event['deny_cid'];
363 $item['deny_gid'] = $event['deny_gid'];
364 $item['private'] = intval($event['private'] ?? 0);
365 $item['visible'] = 1;
366 $item['verb'] = Activity::POST;
367 $item['object-type'] = Activity\ObjectType::EVENT;
368 $item['post-type'] = Item::PT_EVENT;
369 $item['origin'] = $event['cid'] === 0 ? 1 : 0;
370 $item['body'] = self::getBBCode($event);
371 $item['event-id'] = $event['id'];
373 $item['object'] = '<object><type>' . XML::escape(Activity\ObjectType::EVENT) . '</type><title></title><id>' . XML::escape($event['uri']) . '</id>';
374 $item['object'] .= '<content>' . XML::escape(self::getBBCode($event)) . '</content>';
375 $item['object'] .= '</object>' . "\n";
380 public static function getItemArrayForImportedId(int $event_id, array $item = []): array
382 if (empty($event_id)) {
386 $event = DBA::selectFirst('event', [], ['id' => $event_id]);
387 if ($event['type'] != 'event') {
391 $item['post-type'] = Item::PT_EVENT;
393 $item['object-type'] = Activity\ObjectType::EVENT;
394 $item['body'] = self::getBBCode($event);
395 $item['event-id'] = $event_id;
397 $item['object'] = '<object><type>' . XML::escape(Activity\ObjectType::EVENT) . '</type><title></title><id>' . XML::escape($event['uri']) . '</id>';
398 $item['object'] .= '<content>' . XML::escape(self::getBBCode($event)) . '</content>';
399 $item['object'] .= '</object>' . "\n";
405 * Create an array with translation strings used for events.
407 * @return array Array with translations strings.
408 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
410 public static function getStrings(): array
412 // First day of the week (0 = Sunday).
413 $firstDay = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'system', 'first_day_of_week', 0);
416 "firstDay" => $firstDay,
417 "allday" => DI::l10n()->t("all-day"),
419 "Sun" => DI::l10n()->t("Sun"),
420 "Mon" => DI::l10n()->t("Mon"),
421 "Tue" => DI::l10n()->t("Tue"),
422 "Wed" => DI::l10n()->t("Wed"),
423 "Thu" => DI::l10n()->t("Thu"),
424 "Fri" => DI::l10n()->t("Fri"),
425 "Sat" => DI::l10n()->t("Sat"),
427 "Sunday" => DI::l10n()->t("Sunday"),
428 "Monday" => DI::l10n()->t("Monday"),
429 "Tuesday" => DI::l10n()->t("Tuesday"),
430 "Wednesday" => DI::l10n()->t("Wednesday"),
431 "Thursday" => DI::l10n()->t("Thursday"),
432 "Friday" => DI::l10n()->t("Friday"),
433 "Saturday" => DI::l10n()->t("Saturday"),
435 "Jan" => DI::l10n()->t("Jan"),
436 "Feb" => DI::l10n()->t("Feb"),
437 "Mar" => DI::l10n()->t("Mar"),
438 "Apr" => DI::l10n()->t("Apr"),
439 "May" => DI::l10n()->t("May"),
440 "Jun" => DI::l10n()->t("Jun"),
441 "Jul" => DI::l10n()->t("Jul"),
442 "Aug" => DI::l10n()->t("Aug"),
443 "Sep" => DI::l10n()->t("Sept"),
444 "Oct" => DI::l10n()->t("Oct"),
445 "Nov" => DI::l10n()->t("Nov"),
446 "Dec" => DI::l10n()->t("Dec"),
448 "January" => DI::l10n()->t("January"),
449 "February" => DI::l10n()->t("February"),
450 "March" => DI::l10n()->t("March"),
451 "April" => DI::l10n()->t("April"),
452 "June" => DI::l10n()->t("June"),
453 "July" => DI::l10n()->t("July"),
454 "August" => DI::l10n()->t("August"),
455 "September" => DI::l10n()->t("September"),
456 "October" => DI::l10n()->t("October"),
457 "November" => DI::l10n()->t("November"),
458 "December" => DI::l10n()->t("December"),
460 "today" => DI::l10n()->t("today"),
461 "month" => DI::l10n()->t("month"),
462 "week" => DI::l10n()->t("week"),
463 "day" => DI::l10n()->t("day"),
465 "noevent" => DI::l10n()->t("No events to display"),
467 "dtstart_label" => DI::l10n()->t("Starts:"),
468 "dtend_label" => DI::l10n()->t("Finishes:"),
469 "location_label" => DI::l10n()->t("Location:")
476 * Removes duplicated birthday events.
478 * @param array $dates Array of possibly duplicated events.
479 * @return array Cleaned events.
481 * @todo We should replace this with a separate update function if there is some time left.
483 private static function removeDuplicates(array $dates): array
487 foreach ($dates as $date) {
488 if ($date['type'] == 'birthday') {
489 $dates2[$date['uid'] . "-" . $date['cid'] . "-" . $date['start']] = $date;
494 return array_values($dates2);
498 * Get an event by its event ID.
500 * @param int $owner_uid The User ID of the owner of the event
501 * @param int $event_id The ID of the event in the event table
502 * @param string $sql_extra
503 * @return array Query result
506 public static function getListById(int $owner_uid, int $event_id, string $sql_extra = ''): array
510 // Ownly allow events if there is a valid owner_id.
511 if ($owner_uid == 0) {
515 // Query for the event by event id
516 $events = DBA::toArray(DBA::p("SELECT `event`.*, `post-user`.`id` AS `itemid` FROM `event`
517 LEFT JOIN `post-user` ON `post-user`.`event-id` = `event`.`id` AND `post-user`.`uid` = `event`.`uid`
518 WHERE `event`.`uid` = ? AND `event`.`id` = ? $sql_extra",
519 $owner_uid, $event_id));
521 if (DBA::isResult($events)) {
522 $return = self::removeDuplicates($events);
529 * Get all events in a specific time frame.
531 * @param int $owner_uid The User ID of the owner of the events.
532 * @param array $event_params An associative array with
534 * string 'start' => Start time of the timeframe.
535 * string 'finish' => Finish time of the timeframe.
537 * @param string $sql_extra Additional sql conditions (e.g. permission request).
539 * @return array Query results.
542 public static function getListByDate(int $owner_uid, array $event_params, string $sql_extra = ''): array
546 // Only allow events if there is a valid owner_id.
547 if ($owner_uid == 0) {
551 // Query for the event by date.
552 $events = DBA::toArray(DBA::p("SELECT `event`.*, `post-user`.`id` AS `itemid` FROM `event`
553 LEFT JOIN `post-user` ON `post-user`.`event-id` = `event`.`id` AND `post-user`.`uid` = `event`.`uid`
554 WHERE `event`.`uid` = ? AND `event`.`ignore` = ?
555 AND (`finish` >= ? OR (`nofinish` AND `start` >= ?)) AND `start` <= ?
557 $owner_uid, $event_params['ignore'],
558 $event_params['start'], $event_params['start'], $event_params['finish']
561 if (DBA::isResult($events)) {
562 $return = self::removeDuplicates($events);
569 * Convert an array query results in an array which could be used by the events template.
571 * @param array $event_result Event query array.
572 * @return array Event array for the template.
573 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
574 * @throws \ImagickException
576 public static function prepareListForTemplate(array $event_result): array
581 $fmt = DI::l10n()->t('l, F j');
582 foreach ($event_result as $event) {
583 $item = Post::selectFirst(['plink', 'author-name', 'author-network', 'author-id', 'author-avatar', 'author-link', 'private', 'uri-id'], ['id' => $event['itemid']]);
584 if (!DBA::isResult($item)) {
585 // Using default values when no item had been found
586 $item = ['plink' => '', 'author-name' => '', 'author-avatar' => '', 'author-link' => '', 'private' => Item::PUBLIC, 'uri-id' => ($event['uri-id'] ?? 0)];
589 $event = array_merge($event, $item);
591 $start = DateTimeFormat::local($event['start'], 'c');
592 $j = DateTimeFormat::local($event['start'], 'j');
593 $day = DateTimeFormat::local($event['start'], $fmt);
594 $day = DI::l10n()->getDay($day);
596 if ($event['nofinish']) {
599 $end = DateTimeFormat::local($event['finish'], 'c');
602 $is_first = ($day !== $last_date);
606 // Show edit and drop actions only if the user is the owner of the event and the event
607 // is a real event (no bithdays).
611 if (DI::userSession()->getLocalUserId() && DI::userSession()->getLocalUserId() == $event['uid'] && $event['type'] == 'event') {
612 $edit = !$event['cid'] ? [DI::baseUrl() . '/events/event/' . $event['id'], DI::l10n()->t('Edit event') , '', ''] : null;
613 $copy = !$event['cid'] ? [DI::baseUrl() . '/events/copy/' . $event['id'] , DI::l10n()->t('Duplicate event'), '', ''] : null;
614 $drop = [DI::baseUrl() . '/events/drop/' . $event['id'] , DI::l10n()->t('Delete event') , '', ''];
617 $title = BBCode::convertForUriId($event['uri-id'], Strings::escapeHtml($event['summary']));
619 list($title, $_trash) = explode("<br", BBCode::convertForUriId($event['uri-id'], Strings::escapeHtml($event['desc'])), BBCode::API);
622 $author_link = $event['author-link'];
624 $event['author-link'] = Contact::magicLink($author_link);
626 $html = self::getHTML($event);
627 $event['summary'] = BBCode::convertForUriId($event['uri-id'], Strings::escapeHtml($event['summary']));
628 $event['desc'] = BBCode::convertForUriId($event['uri-id'], Strings::escapeHtml($event['desc']));
629 $event['location'] = BBCode::convertForUriId($event['uri-id'], Strings::escapeHtml($event['location']));
631 'id' => $event['id'],
641 'is_first' => $is_first,
644 'plink' => Item::getPlink($event),
652 * Format event to export format (ical/csv).
654 * @param array $events Query result for events.
655 * @param string $format The output format (ical/csv).
657 * @param string $timezone Timezone (missing parameter!)
658 * @return string Content according to selected export format.
660 * @todo Implement timezone support
662 private static function formatListForExport(array $events, string $format): string
666 if (!count($events)) {
671 // Format the exported data as a CSV file.
673 header("Content-type: text/csv");
674 $o .= '"Subject", "Start Date", "Start Time", "Description", "End Date", "End Time", "Location"' . PHP_EOL;
676 foreach ($events as $event) {
677 /// @todo The time / date entries don't include any information about the
678 /// timezone the event is scheduled in :-/
679 $tmp1 = strtotime($event['start']);
680 $tmp2 = strtotime($event['finish']);
681 $time_format = "%H:%M:%S";
682 $date_format = "%Y-%m-%d";
684 $o .= '"' . $event['summary'] . '", "' . strftime($date_format, $tmp1) .
685 '", "' . strftime($time_format, $tmp1) . '", "' . $event['desc'] .
686 '", "' . strftime($date_format, $tmp2) .
687 '", "' . strftime($time_format, $tmp2) .
688 '", "' . $event['location'] . '"' . PHP_EOL;
692 // Format the exported data as a ics file.
694 header("Content-type: text/ics");
695 $o = 'BEGIN:VCALENDAR' . PHP_EOL
696 . 'VERSION:2.0' . PHP_EOL
697 . 'PRODID:-//friendica calendar export//0.1//EN' . PHP_EOL;
698 /// @todo include timezone informations in cases were the time is not in UTC
699 // see http://tools.ietf.org/html/rfc2445#section-4.8.3
700 // . 'BEGIN:VTIMEZONE' . PHP_EOL
701 // . 'TZID:' . $timezone . PHP_EOL
702 // . 'END:VTIMEZONE' . PHP_EOL;
703 // TODO instead of PHP_EOL CRLF should be used for long entries
704 // but test your solution against http://icalvalid.cloudapp.net/
705 // also long lines SHOULD be split at 75 characters length
706 foreach ($events as $event) {
707 $o .= 'BEGIN:VEVENT' . PHP_EOL;
709 if ($event['start']) {
710 $o .= 'DTSTART:' . DateTimeFormat::utc($event['start'], 'Ymd\THis\Z') . PHP_EOL;
713 if (!$event['nofinish']) {
714 $o .= 'DTEND:' . DateTimeFormat::utc($event['finish'], 'Ymd\THis\Z') . PHP_EOL;
717 if ($event['summary']) {
718 $tmp = $event['summary'];
719 $tmp = str_replace(PHP_EOL, PHP_EOL . ' ', $tmp);
720 $tmp = addcslashes($tmp, ',;');
721 $o .= 'SUMMARY:' . $tmp . PHP_EOL;
724 if ($event['desc']) {
725 $tmp = $event['desc'];
726 $tmp = str_replace(PHP_EOL, PHP_EOL . ' ', $tmp);
727 $tmp = addcslashes($tmp, ',;');
728 $o .= 'DESCRIPTION:' . $tmp . PHP_EOL;
731 if ($event['location']) {
732 $tmp = $event['location'];
733 $tmp = str_replace(PHP_EOL, PHP_EOL . ' ', $tmp);
734 $tmp = addcslashes($tmp, ',;');
735 $o .= 'LOCATION:' . $tmp . PHP_EOL;
738 $o .= 'END:VEVENT' . PHP_EOL;
742 $o .= 'END:VCALENDAR' . PHP_EOL;
750 * Get all events for a user ID.
752 * The query for events is done permission sensitive.
753 * If the user is the owner of the calendar they
754 * will get all of their available events.
755 * If the user is only a visitor only the public events will
758 * @param int $uid The user ID.
760 * @return array Query results.
763 private static function getListByUserId(int $uid = 0): array
771 $fields = ['start', 'finish', 'summary', 'desc', 'location', 'nofinish'];
773 $conditions = ['uid' => $uid, 'cid' => 0];
775 // Does the user who requests happen to be the owner of the events
776 // requested? then show all of your events, otherwise only those that
777 // don't have limitations set in allow_cid and allow_gid.
778 if (DI::userSession()->getLocalUserId() != $uid) {
779 $conditions += ['allow_cid' => '', 'allow_gid' => ''];
782 $events = DBA::select('event', $fields, $conditions);
783 if (DBA::isResult($events)) {
784 $return = DBA::toArray($events);
792 * @param int $uid The user ID.
793 * @param string $format Output format (ical/csv).
794 * @return array With the results:
795 * bool 'success' => True if the processing was successful,<br>
796 * string 'format' => The output format,<br>
797 * string 'extension' => The file extension of the output format,<br>
798 * string 'content' => The formatted output content.<br>
801 * @todo Respect authenticated users with events_by_uid().
803 public static function exportListByUserId(int $uid, string $format = 'ical'): array
807 // Get all events which are owned by a uid (respects permissions).
808 $events = self::getListByUserId($uid);
810 // We have the events that are available for the requestor.
811 // Now format the output according to the requested format.
812 $res = self::formatListForExport($events, $format);
814 // If there are results the precess was successful.
819 // Get the file extension for the format.
834 'success' => $process,
836 'extension' => $file_ext,
844 * Format an item array with event data to HTML.
846 * @param array $item Array with item and event data.
847 * @return string HTML output.
848 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
849 * @throws \ImagickException
851 public static function getItemHTML(array $item): string
856 // Set the different time formats.
857 $dformat = DI::l10n()->t('l F d, Y \@ g:i A'); // Friday January 18, 2011 @ 8:01 AM.
858 $dformat_short = DI::l10n()->t('D g:i A'); // Fri 8:01 AM.
859 $tformat = DI::l10n()->t('g:i A'); // 8:01 AM.
861 // Convert the time to different formats.
862 $dtstart_dt = DI::l10n()->getDay(DateTimeFormat::local($item['event-start'], $dformat));
863 $dtstart_title = DateTimeFormat::utc($item['event-start'], DateTimeFormat::ATOM);
864 // Format: Jan till Dec.
865 $month_short = DI::l10n()->getDayShort(DateTimeFormat::local($item['event-start'], 'M'));
866 // Format: 1 till 31.
867 $date_short = DateTimeFormat::local($item['event-start'], 'j');
868 $start_time = DateTimeFormat::local($item['event-start'], $tformat);
869 $start_short = DI::l10n()->getDayShort(DateTimeFormat::local($item['event-start'], $dformat_short));
871 // If the option 'nofinisch' isn't set, we need to format the finish date/time.
872 if (!$item['event-nofinish']) {
874 $dtend_dt = DI::l10n()->getDay(DateTimeFormat::local($item['event-finish'], $dformat));
875 $dtend_title = DateTimeFormat::utc($item['event-finish'], DateTimeFormat::ATOM);
876 $end_short = DI::l10n()->getDayShort(DateTimeFormat::utc($item['event-finish'], $dformat_short));
877 $end_time = DateTimeFormat::local($item['event-finish'], $tformat);
878 // Check if start and finish time is at the same day.
879 if (substr($dtstart_title, 0, 10) === substr($dtend_title, 0, 10)) {
889 // Format the event location.
890 $location = self::locationToArray($item['event-location']);
892 // Construct the profile link (magic-auth).
893 $author = ['uid' => 0, 'id' => $item['author-id'],
894 'network' => $item['author-network'], 'url' => $item['author-link']];
895 $profile_link = Contact::magicLinkByContact($author);
897 $tpl = Renderer::getMarkupTemplate('event_stream_item.tpl');
898 $return = Renderer::replaceMacros($tpl, [
899 '$id' => $item['event-id'],
900 '$title' => BBCode::convertForUriId($item['uri-id'], $item['event-summary']),
901 '$dtstart_label' => DI::l10n()->t('Starts:'),
902 '$dtstart_title' => $dtstart_title,
903 '$dtstart_dt' => $dtstart_dt,
904 '$finish' => $finish,
905 '$dtend_label' => DI::l10n()->t('Finishes:'),
906 '$dtend_title' => $dtend_title,
907 '$dtend_dt' => $dtend_dt,
908 '$month_short' => $month_short,
909 '$date_short' => $date_short,
910 '$same_date' => $same_date,
911 '$start_time' => $start_time,
912 '$start_short' => $start_short,
913 '$end_time' => $end_time,
914 '$end_short' => $end_short,
915 '$author_name' => $item['author-name'],
916 '$author_link' => $profile_link,
917 '$author_avatar' => $item['author-avatar'],
918 '$description' => BBCode::convertForUriId($item['uri-id'], $item['event-desc']),
919 '$location_label' => DI::l10n()->t('Location:'),
920 '$show_map_label' => DI::l10n()->t('Show map'),
921 '$hide_map_label' => DI::l10n()->t('Hide map'),
922 '$map_btn_label' => DI::l10n()->t('Show map'),
923 '$location' => $location
930 * Format a string with map bbcode to an array with location data.
932 * Note: The string must only contain location data. A string with no bbcode will be
933 * handled as location name.
935 * @param string $s The string with the bbcode formatted location data.
937 * @return array The array with the location data.
938 * 'name' => The name of the location,<br>
939 * 'address' => The address of the location,<br>
940 * 'coordinates' => Latitude and longitude (e.g. '48.864716,2.349014').<br>
941 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
943 private static function locationToArray(string $s = ''): array
949 $location = ['name' => $s];
951 // Map tag with location name - e.g. [map]Paris[/map].
952 if (strpos($s, '[/map]') !== false) {
953 $found = preg_match("/\[map\](.*?)\[\/map\]/ism", $s, $match);
954 if (intval($found) > 0 && array_key_exists(1, $match)) {
955 $location['address'] = $match[1];
956 // Remove the map bbcode from the location name.
957 $location['name'] = str_replace($match[0], "", $s);
959 // Map tag with coordinates - e.g. [map=48.864716,2.349014].
960 } elseif (strpos($s, '[map=') !== false) {
961 $found = preg_match("/\[map=(.*?)\]/ism", $s, $match);
962 if (intval($found) > 0 && array_key_exists(1, $match)) {
963 $location['coordinates'] = $match[1];
964 // Remove the map bbcode from the location name.
965 $location['name'] = str_replace($match[0], "", $s);
969 $location['name'] = BBCode::convert($location['name']);
971 // Construct the map HTML.
972 if (isset($location['address'])) {
973 $location['map'] = '<div class="map">' . Map::byLocation($location['address']) . '</div>';
974 } elseif (isset($location['coordinates'])) {
975 $location['map'] = '<div class="map">' . Map::byCoordinates(str_replace('/', ' ', $location['coordinates'])) . '</div>';
982 * Add new birthday event for this person
984 * @param array $contact Contact array, expects: id, uid, url, name
985 * @param string $birthday Birthday of the contact
989 public static function createBirthday(array $contact, string $birthday): bool
991 // Check for duplicates
993 'uid' => $contact['uid'],
994 'cid' => $contact['id'],
995 'start' => DateTimeFormat::utc($birthday),
998 if (DBA::exists('event', $condition)) {
1003 * Add new birthday event for this person
1005 * summary is just a readable placeholder in case the event is shared
1006 * with others. We will replace it during presentation to our $importer
1007 * to contain a sparkle link and perhaps a photo.
1010 'uid' => $contact['uid'],
1011 'cid' => $contact['id'],
1012 'start' => DateTimeFormat::utc($birthday),
1013 'finish' => DateTimeFormat::utc($birthday . ' + 1 day '),
1014 'summary' => DI::l10n()->t('%s\'s birthday', $contact['name']),
1015 'desc' => DI::l10n()->t('Happy Birthday %s', ' [url=' . $contact['url'] . ']' . $contact['name'] . '[/url]'),
1016 'type' => 'birthday',
1019 // Check if self::store() was success
1020 return (self::store($values) > 0);