3 * @copyright Copyright (C) 2010-2021, 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, $simple = false)
50 $bd_format = DI::l10n()->t('l F d, Y \@ g:i A'); // Friday January 18, 2011 @ 8 AM.
52 $event_start = DI::l10n()->getDay(
53 !empty($event['adjust']) ?
54 DateTimeFormat::local($event['start'], $bd_format) : DateTimeFormat::utc($event['start'], $bd_format)
57 if (!empty($event['finish'])) {
58 $event_end = DI::l10n()->getDay(
59 !empty($event['adjust']) ?
60 DateTimeFormat::local($event['finish'], $bd_format) : DateTimeFormat::utc($event['finish'], $bd_format)
69 if (!empty($event['summary'])) {
70 $o .= "<h3>" . BBCode::convert(Strings::escapeHtml($event['summary']), false, $simple) . "</h3>";
73 if (!empty($event['desc'])) {
74 $o .= "<div>" . BBCode::convert(Strings::escapeHtml($event['desc']), false, $simple) . "</div>";
77 $o .= "<h4>" . DI::l10n()->t('Starts:') . "</h4><p>" . $event_start . "</p>";
79 if (!$event['nofinish']) {
80 $o .= "<h4>" . DI::l10n()->t('Finishes:') . "</h4><p>" . $event_end . "</p>";
83 if (!empty($event['location'])) {
84 $o .= "<h4>" . DI::l10n()->t('Location:') . "</h4><p>" . BBCode::convert(Strings::escapeHtml($event['location']), false, $simple) . "</p>";
90 $o = '<div class="vevent">' . "\r\n";
92 $o .= '<div class="summary event-summary">' . BBCode::convert(Strings::escapeHtml($event['summary']), false, $simple) . '</div>' . "\r\n";
94 $o .= '<div class="event-start"><span class="event-label">' . DI::l10n()->t('Starts:') . '</span> <span class="dtstart" title="'
95 . DateTimeFormat::utc($event['start'], (!empty($event['adjust']) ? DateTimeFormat::ATOM : 'Y-m-d\TH:i:s'))
96 . '" >' . $event_start
97 . '</span></div>' . "\r\n";
99 if (!$event['nofinish']) {
100 $o .= '<div class="event-end" ><span class="event-label">' . DI::l10n()->t('Finishes:') . '</span> <span class="dtend" title="'
101 . DateTimeFormat::utc($event['finish'], (!empty($event['adjust']) ? DateTimeFormat::ATOM : 'Y-m-d\TH:i:s'))
103 . '</span></div>' . "\r\n";
106 if (!empty($event['desc'])) {
107 $o .= '<div class="description event-description">' . BBCode::convert(Strings::escapeHtml($event['desc']), false, $simple) . '</div>' . "\r\n";
110 if (!empty($event['location'])) {
111 $o .= '<div class="event-location"><span class="event-label">' . DI::l10n()->t('Location:') . '</span> <span class="location">'
112 . BBCode::convert(Strings::escapeHtml($event['location']), false, $simple)
113 . '</span></div>' . "\r\n";
115 // Include a map of the location if the [map] BBCode is used.
116 if (strpos($event['location'], "[map") !== false) {
117 $map = Map::byLocation($event['location'], $simple);
118 if ($map !== $event['location']) {
124 $o .= '</div>' . "\r\n";
129 * Convert an array with event data to bbcode.
131 * @param array $event Array which contains the event data.
132 * @return string The event as a bbcode formatted string.
134 private static function getBBCode(array $event)
138 if ($event['summary']) {
139 $o .= '[event-summary]' . $event['summary'] . '[/event-summary]';
142 if ($event['desc']) {
143 $o .= '[event-description]' . $event['desc'] . '[/event-description]';
146 if ($event['start']) {
147 $o .= '[event-start]' . $event['start'] . '[/event-start]';
150 if (($event['finish']) && (!$event['nofinish'])) {
151 $o .= '[event-finish]' . $event['finish'] . '[/event-finish]';
154 if ($event['location']) {
155 $o .= '[event-location]' . $event['location'] . '[/event-location]';
158 if ($event['adjust']) {
159 $o .= '[event-adjust]' . $event['adjust'] . '[/event-adjust]';
166 * Extract bbcode formatted event data from a string.
168 * @params: string $s The string which should be parsed for event data.
170 * @return array The array with the event information.
172 public static function fromBBCode($text)
177 if (preg_match("/\[event\-summary\](.*?)\[\/event\-summary\]/is", $text, $match)) {
178 $ev['summary'] = $match[1];
182 if (preg_match("/\[event\-description\](.*?)\[\/event\-description\]/is", $text, $match)) {
183 $ev['desc'] = $match[1];
187 if (preg_match("/\[event\-start\](.*?)\[\/event\-start\]/is", $text, $match)) {
188 $ev['start'] = $match[1];
192 if (preg_match("/\[event\-finish\](.*?)\[\/event\-finish\]/is", $text, $match)) {
193 $ev['finish'] = $match[1];
197 if (preg_match("/\[event\-location\](.*?)\[\/event\-location\]/is", $text, $match)) {
198 $ev['location'] = $match[1];
202 if (preg_match("/\[event\-adjust\](.*?)\[\/event\-adjust\]/is", $text, $match)) {
203 $ev['adjust'] = $match[1];
206 $ev['nofinish'] = !empty($ev['start']) && empty($ev['finish']) ? 1 : 0;
211 public static function sortByDate($event_list)
213 usort($event_list, ['self', 'compareDatesCallback']);
217 private static function compareDatesCallback($event_a, $event_b)
219 $date_a = (($event_a['adjust']) ? DateTimeFormat::local($event_a['start']) : $event_a['start']);
220 $date_b = (($event_b['adjust']) ? DateTimeFormat::local($event_b['start']) : $event_b['start']);
222 if ($date_a === $date_b) {
223 return strcasecmp($event_a['desc'], $event_b['desc']);
226 return strcmp($date_a, $date_b);
230 * Delete an event from the event table.
232 * Note: This function does only delete the event from the event table not its
233 * related entry in the item table.
235 * @param int $event_id Event ID.
239 public static function delete($event_id)
241 if ($event_id == 0) {
245 DBA::delete('event', ['id' => $event_id]);
246 Logger::log("Deleted event ".$event_id, Logger::DEBUG);
252 * Store the event in the event table and create an event item in the item table.
254 * @param array $arr Array with event data.
255 * @return int The new event id.
256 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
258 public static function store($arr)
260 $network = $arr['network'] ?? Protocol::DFRN;
261 $protocol = $arr['protocol'] ?? Conversation::PARCEL_UNKNOWN;
262 $direction = $arr['direction'] ?? Conversation::UNKNOWN;
263 $source = $arr['source'] ?? '';
265 unset($arr['network']);
266 unset($arr['protocol']);
267 unset($arr['direction']);
268 unset($arr['source']);
271 $event['id'] = intval($arr['id'] ?? 0);
272 $event['uid'] = intval($arr['uid'] ?? 0);
273 $event['cid'] = intval($arr['cid'] ?? 0);
274 $event['guid'] = ($arr['guid'] ?? '') ?: System::createUUID();
275 $event['uri'] = ($arr['uri'] ?? '') ?: Item::newURI($event['uid'], $event['guid']);
276 $event['type'] = ($arr['type'] ?? '') ?: 'event';
277 $event['summary'] = $arr['summary'] ?? '';
278 $event['desc'] = $arr['desc'] ?? '';
279 $event['location'] = $arr['location'] ?? '';
280 $event['allow_cid'] = $arr['allow_cid'] ?? '';
281 $event['allow_gid'] = $arr['allow_gid'] ?? '';
282 $event['deny_cid'] = $arr['deny_cid'] ?? '';
283 $event['deny_gid'] = $arr['deny_gid'] ?? '';
284 $event['adjust'] = intval($arr['adjust'] ?? 0);
285 $event['nofinish'] = intval($arr['nofinish'] ?? (!empty($event['start']) && empty($event['finish'])));
287 $event['created'] = DateTimeFormat::utc(($arr['created'] ?? '') ?: 'now');
288 $event['edited'] = DateTimeFormat::utc(($arr['edited'] ?? '') ?: 'now');
289 $event['start'] = DateTimeFormat::utc(($arr['start'] ?? '') ?: DBA::NULL_DATETIME);
290 $event['finish'] = DateTimeFormat::utc(($arr['finish'] ?? '') ?: DBA::NULL_DATETIME);
291 if ($event['finish'] < DBA::NULL_DATETIME) {
292 $event['finish'] = DBA::NULL_DATETIME;
294 $private = intval($arr['private'] ?? 0);
296 $conditions = ['uid' => $event['uid']];
298 $conditions['id'] = $event['cid'];
300 $conditions['self'] = true;
303 $contact = DBA::selectFirst('contact', [], $conditions);
304 if (!DBA::isResult($contact)) {
305 Logger::warning('Contact not found', ['condition' => $conditions, 'callstack' => System::callstack(20)]);
308 // Existing event being modified.
310 // has the event actually changed?
311 $existing_event = DBA::selectFirst('event', ['edited'], ['id' => $event['id'], 'uid' => $event['uid']]);
312 if (!DBA::isResult($existing_event) || ($existing_event['edited'] === $event['edited'])) {
314 $item = Post::selectFirst(['id'], ['event-id' => $event['id'], 'uid' => $event['uid']]);
316 return DBA::isResult($item) ? $item['id'] : 0;
320 'edited' => $event['edited'],
321 'start' => $event['start'],
322 'finish' => $event['finish'],
323 'summary' => $event['summary'],
324 'desc' => $event['desc'],
325 'location' => $event['location'],
326 'type' => $event['type'],
327 'adjust' => $event['adjust'],
328 'nofinish' => $event['nofinish'],
331 DBA::update('event', $updated_fields, ['id' => $event['id'], 'uid' => $event['uid']]);
333 $item = Post::selectFirst(['id', 'uri-id'], ['event-id' => $event['id'], 'uid' => $event['uid']]);
334 if (DBA::isResult($item)) {
335 $object = '<object><type>' . XML::escape(Activity\ObjectType::EVENT) . '</type><title></title><id>' . XML::escape($event['uri']) . '</id>';
336 $object .= '<content>' . XML::escape(self::getBBCode($event)) . '</content>';
337 $object .= '</object>' . "\n";
339 $fields = ['body' => self::getBBCode($event), 'object' => $object, 'edited' => $event['edited']];
340 Item::update($fields, ['id' => $item['id']]);
342 $uriid = $item['uri-id'];
347 Hook::callAll('event_updated', $event['id']);
349 // New event. Store it.
350 DBA::insert('event', $event);
354 // Don't create an item for birthday events
355 if ($event['type'] == 'event') {
356 $event['id'] = DBA::lastInsertId();
360 $item_arr['uid'] = $event['uid'];
361 $item_arr['contact-id'] = $event['cid'];
362 $item_arr['uri'] = $event['uri'];
363 $item_arr['uri-id'] = ItemURI::getIdByURI($event['uri']);
364 $item_arr['guid'] = $event['guid'];
365 $item_arr['plink'] = $arr['plink'] ?? '';
366 $item_arr['post-type'] = Item::PT_EVENT;
367 $item_arr['wall'] = $event['cid'] ? 0 : 1;
368 $item_arr['contact-id'] = $contact['id'];
369 $item_arr['owner-name'] = $contact['name'];
370 $item_arr['owner-link'] = $contact['url'];
371 $item_arr['owner-avatar'] = $contact['thumb'];
372 $item_arr['author-name'] = $contact['name'];
373 $item_arr['author-link'] = $contact['url'];
374 $item_arr['author-avatar'] = $contact['thumb'];
375 $item_arr['title'] = '';
376 $item_arr['allow_cid'] = $event['allow_cid'];
377 $item_arr['allow_gid'] = $event['allow_gid'];
378 $item_arr['deny_cid'] = $event['deny_cid'];
379 $item_arr['deny_gid'] = $event['deny_gid'];
380 $item_arr['private'] = $private;
381 $item_arr['visible'] = 1;
382 $item_arr['verb'] = Activity::POST;
383 $item_arr['object-type'] = Activity\ObjectType::EVENT;
384 $item_arr['post-type'] = Item::PT_EVENT;
385 $item_arr['origin'] = $event['cid'] === 0 ? 1 : 0;
386 $item_arr['body'] = self::getBBCode($event);
387 $item_arr['event-id'] = $event['id'];
388 $item_arr['network'] = $network;
389 $item_arr['protocol'] = $protocol;
390 $item_arr['direction'] = $direction;
391 $item_arr['source'] = $source;
393 $item_arr['object'] = '<object><type>' . XML::escape(Activity\ObjectType::EVENT) . '</type><title></title><id>' . XML::escape($event['uri']) . '</id>';
394 $item_arr['object'] .= '<content>' . XML::escape(self::getBBCode($event)) . '</content>';
395 $item_arr['object'] .= '</object>' . "\n";
397 if (Item::insert($item_arr)) {
398 $uriid = $item_arr['uri-id'];
402 Hook::callAll("event_created", $event['id']);
409 * Create an array with translation strings used for events.
411 * @return array Array with translations strings.
412 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
414 public static function getStrings()
416 // First day of the week (0 = Sunday).
417 $firstDay = DI::pConfig()->get(local_user(), 'system', 'first_day_of_week', 0);
420 "firstDay" => $firstDay,
421 "allday" => DI::l10n()->t("all-day"),
423 "Sun" => DI::l10n()->t("Sun"),
424 "Mon" => DI::l10n()->t("Mon"),
425 "Tue" => DI::l10n()->t("Tue"),
426 "Wed" => DI::l10n()->t("Wed"),
427 "Thu" => DI::l10n()->t("Thu"),
428 "Fri" => DI::l10n()->t("Fri"),
429 "Sat" => DI::l10n()->t("Sat"),
431 "Sunday" => DI::l10n()->t("Sunday"),
432 "Monday" => DI::l10n()->t("Monday"),
433 "Tuesday" => DI::l10n()->t("Tuesday"),
434 "Wednesday" => DI::l10n()->t("Wednesday"),
435 "Thursday" => DI::l10n()->t("Thursday"),
436 "Friday" => DI::l10n()->t("Friday"),
437 "Saturday" => DI::l10n()->t("Saturday"),
439 "Jan" => DI::l10n()->t("Jan"),
440 "Feb" => DI::l10n()->t("Feb"),
441 "Mar" => DI::l10n()->t("Mar"),
442 "Apr" => DI::l10n()->t("Apr"),
443 "May" => DI::l10n()->t("May"),
444 "Jun" => DI::l10n()->t("Jun"),
445 "Jul" => DI::l10n()->t("Jul"),
446 "Aug" => DI::l10n()->t("Aug"),
447 "Sep" => DI::l10n()->t("Sept"),
448 "Oct" => DI::l10n()->t("Oct"),
449 "Nov" => DI::l10n()->t("Nov"),
450 "Dec" => DI::l10n()->t("Dec"),
452 "January" => DI::l10n()->t("January"),
453 "February" => DI::l10n()->t("February"),
454 "March" => DI::l10n()->t("March"),
455 "April" => DI::l10n()->t("April"),
456 "June" => DI::l10n()->t("June"),
457 "July" => DI::l10n()->t("July"),
458 "August" => DI::l10n()->t("August"),
459 "September" => DI::l10n()->t("September"),
460 "October" => DI::l10n()->t("October"),
461 "November" => DI::l10n()->t("November"),
462 "December" => DI::l10n()->t("December"),
464 "today" => DI::l10n()->t("today"),
465 "month" => DI::l10n()->t("month"),
466 "week" => DI::l10n()->t("week"),
467 "day" => DI::l10n()->t("day"),
469 "noevent" => DI::l10n()->t("No events to display"),
471 "dtstart_label" => DI::l10n()->t("Starts:"),
472 "dtend_label" => DI::l10n()->t("Finishes:"),
473 "location_label" => DI::l10n()->t("Location:")
480 * Removes duplicated birthday events.
482 * @param array $dates Array of possibly duplicated events.
483 * @return array Cleaned events.
485 * @todo We should replace this with a separate update function if there is some time left.
487 private static function removeDuplicates(array $dates)
491 foreach ($dates as $date) {
492 if ($date['type'] == 'birthday') {
493 $dates2[$date['uid'] . "-" . $date['cid'] . "-" . $date['start']] = $date;
498 return array_values($dates2);
502 * Get an event by its event ID.
504 * @param int $owner_uid The User ID of the owner of the event
505 * @param int $event_id The ID of the event in the event table
506 * @param string $sql_extra
507 * @return array Query result
510 public static function getListById($owner_uid, $event_id, $sql_extra = '')
514 // Ownly allow events if there is a valid owner_id.
515 if ($owner_uid == 0) {
519 // Query for the event by event id
520 $events = DBA::toArray(DBA::p("SELECT `event`.*, `post-user-view`.`id` AS `itemid` FROM `event`
521 LEFT JOIN `post-user-view` ON `post-user-view`.`event-id` = `event`.`id` AND `post-user-view`.`uid` = `event`.`uid`
522 WHERE `event`.`uid` = ? AND `event`.`id` = ? $sql_extra",
523 $owner_uid, $event_id));
525 if (DBA::isResult($events)) {
526 $return = self::removeDuplicates($events);
533 * Get all events in a specific time frame.
535 * @param int $owner_uid The User ID of the owner of the events.
536 * @param array $event_params An associative array with
538 * string 'start' => Start time of the timeframe.
539 * string 'finish' => Finish time of the timeframe.
540 * string 'adjust_start' =>
541 * string 'adjust_finish' =>
543 * @param string $sql_extra Additional sql conditions (e.g. permission request).
545 * @return array Query results.
548 public static function getListByDate($owner_uid, $event_params, $sql_extra = '')
552 // Only allow events if there is a valid owner_id.
553 if ($owner_uid == 0) {
557 // Query for the event by date.
558 // @todo Slow query (518 seconds to run), to be optimzed
559 $events = DBA::toArray(DBA::p("SELECT `event`.*, `post-user-view`.`id` AS `itemid` FROM `event`
560 LEFT JOIN `post-user-view` ON `post-user-view`.`event-id` = `event`.`id` AND `post-user-view`.`uid` = `event`.`uid`
561 WHERE `event`.`uid` = ? AND `event`.`ignore` = ?
562 AND ((NOT `adjust` AND (`finish` >= ? OR (`nofinish` AND `start` >= ?)) AND `start` <= ?)
563 OR (`adjust` AND (`finish` >= ? OR (`nofinish` AND `start` >= ?)) AND `start` <= ?))" . $sql_extra,
564 $owner_uid, $event_params["ignore"],
565 $event_params["start"], $event_params["start"], $event_params["finish"],
566 $event_params["adjust_start"], $event_params["adjust_start"], $event_params["adjust_finish"]));
568 if (DBA::isResult($events)) {
569 $return = self::removeDuplicates($events);
576 * Convert an array query results in an array which could be used by the events template.
578 * @param array $event_result Event query array.
579 * @return array Event array for the template.
580 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
581 * @throws \ImagickException
583 public static function prepareListForTemplate(array $event_result)
588 $fmt = DI::l10n()->t('l, F j');
589 foreach ($event_result as $event) {
590 $item = Post::selectFirst(['plink', 'author-name', 'author-avatar', 'author-link'], ['id' => $event['itemid']]);
591 if (!DBA::isResult($item)) {
592 // Using default values when no item had been found
593 $item = ['plink' => '', 'author-name' => '', 'author-avatar' => '', 'author-link' => ''];
596 $event = array_merge($event, $item);
598 $start = $event['adjust'] ? DateTimeFormat::local($event['start'], 'c') : DateTimeFormat::utc($event['start'], 'c');
599 $j = $event['adjust'] ? DateTimeFormat::local($event['start'], 'j') : DateTimeFormat::utc($event['start'], 'j');
600 $day = $event['adjust'] ? DateTimeFormat::local($event['start'], $fmt) : DateTimeFormat::utc($event['start'], $fmt);
601 $day = DI::l10n()->getDay($day);
603 if ($event['nofinish']) {
606 $end = $event['adjust'] ? DateTimeFormat::local($event['finish'], 'c') : DateTimeFormat::utc($event['finish'], 'c');
609 $is_first = ($day !== $last_date);
613 // Show edit and drop actions only if the user is the owner of the event and the event
614 // is a real event (no bithdays).
618 if (local_user() && local_user() == $event['uid'] && $event['type'] == 'event') {
619 $edit = !$event['cid'] ? [DI::baseUrl() . '/events/event/' . $event['id'], DI::l10n()->t('Edit event') , '', ''] : null;
620 $copy = !$event['cid'] ? [DI::baseUrl() . '/events/copy/' . $event['id'] , DI::l10n()->t('Duplicate event'), '', ''] : null;
621 $drop = [DI::baseUrl() . '/events/drop/' . $event['id'] , DI::l10n()->t('Delete event') , '', ''];
624 $title = BBCode::convert(Strings::escapeHtml($event['summary']));
626 list($title, $_trash) = explode("<br", BBCode::convert(Strings::escapeHtml($event['desc'])), BBCode::API);
629 $author_link = $event['author-link'];
631 $event['author-link'] = Contact::magicLink($author_link);
633 $html = self::getHTML($event);
634 $event['summary'] = BBCode::convert(Strings::escapeHtml($event['summary']));
635 $event['desc'] = BBCode::convert(Strings::escapeHtml($event['desc']));
636 $event['location'] = BBCode::convert(Strings::escapeHtml($event['location']));
638 'id' => $event['id'],
648 'is_first' => $is_first,
651 'plink' => Item::getPlink($event),
659 * Format event to export format (ical/csv).
661 * @param array $events Query result for events.
662 * @param string $format The output format (ical/csv).
665 * @return string Content according to selected export format.
667 * @todo Implement timezone support
669 private static function formatListForExport(array $events, $format)
673 if (!count($events)) {
678 // Format the exported data as a CSV file.
680 header("Content-type: text/csv");
681 $o .= '"Subject", "Start Date", "Start Time", "Description", "End Date", "End Time", "Location"' . PHP_EOL;
683 foreach ($events as $event) {
684 /// @todo The time / date entries don't include any information about the
685 /// timezone the event is scheduled in :-/
686 $tmp1 = strtotime($event['start']);
687 $tmp2 = strtotime($event['finish']);
688 $time_format = "%H:%M:%S";
689 $date_format = "%Y-%m-%d";
691 $o .= '"' . $event['summary'] . '", "' . strftime($date_format, $tmp1) .
692 '", "' . strftime($time_format, $tmp1) . '", "' . $event['desc'] .
693 '", "' . strftime($date_format, $tmp2) .
694 '", "' . strftime($time_format, $tmp2) .
695 '", "' . $event['location'] . '"' . PHP_EOL;
699 // Format the exported data as a ics file.
701 header("Content-type: text/ics");
702 $o = 'BEGIN:VCALENDAR' . PHP_EOL
703 . 'VERSION:2.0' . PHP_EOL
704 . 'PRODID:-//friendica calendar export//0.1//EN' . PHP_EOL;
705 /// @todo include timezone informations in cases were the time is not in UTC
706 // see http://tools.ietf.org/html/rfc2445#section-4.8.3
707 // . 'BEGIN:VTIMEZONE' . PHP_EOL
708 // . 'TZID:' . $timezone . PHP_EOL
709 // . 'END:VTIMEZONE' . PHP_EOL;
710 // TODO instead of PHP_EOL CRLF should be used for long entries
711 // but test your solution against http://icalvalid.cloudapp.net/
712 // also long lines SHOULD be split at 75 characters length
713 foreach ($events as $event) {
714 if ($event['adjust'] == 1) {
719 $o .= 'BEGIN:VEVENT' . PHP_EOL;
721 if ($event['start']) {
722 $tmp = strtotime($event['start']);
723 $dtformat = "%Y%m%dT%H%M%S" . $UTC;
724 $o .= 'DTSTART:' . strftime($dtformat, $tmp) . PHP_EOL;
727 if (!$event['nofinish']) {
728 $tmp = strtotime($event['finish']);
729 $dtformat = "%Y%m%dT%H%M%S" . $UTC;
730 $o .= 'DTEND:' . strftime($dtformat, $tmp) . PHP_EOL;
733 if ($event['summary']) {
734 $tmp = $event['summary'];
735 $tmp = str_replace(PHP_EOL, PHP_EOL . ' ', $tmp);
736 $tmp = addcslashes($tmp, ',;');
737 $o .= 'SUMMARY:' . $tmp . PHP_EOL;
740 if ($event['desc']) {
741 $tmp = $event['desc'];
742 $tmp = str_replace(PHP_EOL, PHP_EOL . ' ', $tmp);
743 $tmp = addcslashes($tmp, ',;');
744 $o .= 'DESCRIPTION:' . $tmp . PHP_EOL;
747 if ($event['location']) {
748 $tmp = $event['location'];
749 $tmp = str_replace(PHP_EOL, PHP_EOL . ' ', $tmp);
750 $tmp = addcslashes($tmp, ',;');
751 $o .= 'LOCATION:' . $tmp . PHP_EOL;
754 $o .= 'END:VEVENT' . PHP_EOL;
758 $o .= 'END:VCALENDAR' . PHP_EOL;
766 * Get all events for a user ID.
768 * The query for events is done permission sensitive.
769 * If the user is the owner of the calendar they
770 * will get all of their available events.
771 * If the user is only a visitor only the public events will
774 * @param int $uid The user ID.
776 * @return array Query results.
779 private static function getListByUserId($uid = 0)
787 $fields = ['start', 'finish', 'adjust', 'summary', 'desc', 'location', 'nofinish'];
789 $conditions = ['uid' => $uid, 'cid' => 0];
791 // Does the user who requests happen to be the owner of the events
792 // requested? then show all of your events, otherwise only those that
793 // don't have limitations set in allow_cid and allow_gid.
794 if (local_user() != $uid) {
795 $conditions += ['allow_cid' => '', 'allow_gid' => ''];
798 $events = DBA::select('event', $fields, $conditions);
799 if (DBA::isResult($events)) {
800 $return = DBA::toArray($events);
808 * @param int $uid The user ID.
809 * @param string $format Output format (ical/csv).
810 * @return array With the results:
811 * bool 'success' => True if the processing was successful,<br>
812 * string 'format' => The output format,<br>
813 * string 'extension' => The file extension of the output format,<br>
814 * string 'content' => The formatted output content.<br>
817 * @todo Respect authenticated users with events_by_uid().
819 public static function exportListByUserId($uid, $format = 'ical')
823 // Get all events which are owned by a uid (respects permissions).
824 $events = self::getListByUserId($uid);
826 // We have the events that are available for the requestor.
827 // Now format the output according to the requested format.
828 $res = self::formatListForExport($events, $format);
830 // If there are results the precess was successful.
835 // Get the file extension for the format.
850 'success' => $process,
852 'extension' => $file_ext,
860 * Format an item array with event data to HTML.
862 * @param array $item Array with item and event data.
863 * @return string HTML output.
864 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
865 * @throws \ImagickException
867 public static function getItemHTML(array $item) {
871 // Set the different time formats.
872 $dformat = DI::l10n()->t('l F d, Y \@ g:i A'); // Friday January 18, 2011 @ 8:01 AM.
873 $dformat_short = DI::l10n()->t('D g:i A'); // Fri 8:01 AM.
874 $tformat = DI::l10n()->t('g:i A'); // 8:01 AM.
876 // Convert the time to different formats.
877 $dtstart_dt = DI::l10n()->getDay(
878 $item['event-adjust'] ?
879 DateTimeFormat::local($item['event-start'], $dformat)
880 : DateTimeFormat::utc($item['event-start'], $dformat)
882 $dtstart_title = DateTimeFormat::utc($item['event-start'], $item['event-adjust'] ? DateTimeFormat::ATOM : 'Y-m-d\TH:i:s');
883 // Format: Jan till Dec.
884 $month_short = DI::l10n()->getDayShort(
885 $item['event-adjust'] ?
886 DateTimeFormat::local($item['event-start'], 'M')
887 : DateTimeFormat::utc($item['event-start'], 'M')
889 // Format: 1 till 31.
890 $date_short = $item['event-adjust'] ?
891 DateTimeFormat::local($item['event-start'], 'j')
892 : DateTimeFormat::utc($item['event-start'], 'j');
893 $start_time = $item['event-adjust'] ?
894 DateTimeFormat::local($item['event-start'], $tformat)
895 : DateTimeFormat::utc($item['event-start'], $tformat);
896 $start_short = DI::l10n()->getDayShort(
897 $item['event-adjust'] ?
898 DateTimeFormat::local($item['event-start'], $dformat_short)
899 : DateTimeFormat::utc($item['event-start'], $dformat_short)
902 // If the option 'nofinisch' isn't set, we need to format the finish date/time.
903 if (!$item['event-nofinish']) {
905 $dtend_dt = DI::l10n()->getDay(
906 $item['event-adjust'] ?
907 DateTimeFormat::local($item['event-finish'], $dformat)
908 : DateTimeFormat::utc($item['event-finish'], $dformat)
910 $dtend_title = DateTimeFormat::utc($item['event-finish'], $item['event-adjust'] ? DateTimeFormat::ATOM : 'Y-m-d\TH:i:s');
911 $end_short = DI::l10n()->getDayShort(
912 $item['event-adjust'] ?
913 DateTimeFormat::local($item['event-finish'], $dformat_short)
914 : DateTimeFormat::utc($item['event-finish'], $dformat_short)
916 $end_time = $item['event-adjust'] ?
917 DateTimeFormat::local($item['event-finish'], $tformat)
918 : DateTimeFormat::utc($item['event-finish'], $tformat);
919 // Check if start and finish time is at the same day.
920 if (substr($dtstart_title, 0, 10) === substr($dtend_title, 0, 10)) {
930 // Format the event location.
931 $location = self::locationToArray($item['event-location']);
933 // Construct the profile link (magic-auth).
934 $author = ['uid' => 0, 'id' => $item['author-id'],
935 'network' => $item['author-network'], 'url' => $item['author-link']];
936 $profile_link = Contact::magicLinkByContact($author);
938 $tpl = Renderer::getMarkupTemplate('event_stream_item.tpl');
939 $return = Renderer::replaceMacros($tpl, [
940 '$id' => $item['event-id'],
941 '$title' => BBCode::convert($item['event-summary']),
942 '$dtstart_label' => DI::l10n()->t('Starts:'),
943 '$dtstart_title' => $dtstart_title,
944 '$dtstart_dt' => $dtstart_dt,
945 '$finish' => $finish,
946 '$dtend_label' => DI::l10n()->t('Finishes:'),
947 '$dtend_title' => $dtend_title,
948 '$dtend_dt' => $dtend_dt,
949 '$month_short' => $month_short,
950 '$date_short' => $date_short,
951 '$same_date' => $same_date,
952 '$start_time' => $start_time,
953 '$start_short' => $start_short,
954 '$end_time' => $end_time,
955 '$end_short' => $end_short,
956 '$author_name' => $item['author-name'],
957 '$author_link' => $profile_link,
958 '$author_avatar' => $item['author-avatar'],
959 '$description' => BBCode::convert($item['event-desc']),
960 '$location_label' => DI::l10n()->t('Location:'),
961 '$show_map_label' => DI::l10n()->t('Show map'),
962 '$hide_map_label' => DI::l10n()->t('Hide map'),
963 '$map_btn_label' => DI::l10n()->t('Show map'),
964 '$location' => $location
971 * Format a string with map bbcode to an array with location data.
973 * Note: The string must only contain location data. A string with no bbcode will be
974 * handled as location name.
976 * @param string $s The string with the bbcode formatted location data.
978 * @return array The array with the location data.
979 * 'name' => The name of the location,<br>
980 * 'address' => The address of the location,<br>
981 * 'coordinates' => Latitude and longitude (e.g. '48.864716,2.349014').<br>
982 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
984 private static function locationToArray($s = '') {
989 $location = ['name' => $s];
991 // Map tag with location name - e.g. [map]Paris[/map].
992 if (strpos($s, '[/map]') !== false) {
993 $found = preg_match("/\[map\](.*?)\[\/map\]/ism", $s, $match);
994 if (intval($found) > 0 && array_key_exists(1, $match)) {
995 $location['address'] = $match[1];
996 // Remove the map bbcode from the location name.
997 $location['name'] = str_replace($match[0], "", $s);
999 // Map tag with coordinates - e.g. [map=48.864716,2.349014].
1000 } elseif (strpos($s, '[map=') !== false) {
1001 $found = preg_match("/\[map=(.*?)\]/ism", $s, $match);
1002 if (intval($found) > 0 && array_key_exists(1, $match)) {
1003 $location['coordinates'] = $match[1];
1004 // Remove the map bbcode from the location name.
1005 $location['name'] = str_replace($match[0], "", $s);
1009 $location['name'] = BBCode::convert($location['name']);
1011 // Construct the map HTML.
1012 if (isset($location['address'])) {
1013 $location['map'] = '<div class="map">' . Map::byLocation($location['address']) . '</div>';
1014 } elseif (isset($location['coordinates'])) {
1015 $location['map'] = '<div class="map">' . Map::byCoordinates(str_replace('/', ' ', $location['coordinates'])) . '</div>';
1022 * Add new birthday event for this person
1024 * @param array $contact Contact array, expects: id, uid, url, name
1025 * @param string $birthday Birthday of the contact
1027 * @throws \Exception
1029 public static function createBirthday($contact, $birthday)
1031 // Check for duplicates
1033 'uid' => $contact['uid'],
1034 'cid' => $contact['id'],
1035 'start' => DateTimeFormat::utc($birthday),
1036 'type' => 'birthday'
1038 if (DBA::exists('event', $condition)) {
1043 * Add new birthday event for this person
1045 * summary is just a readable placeholder in case the event is shared
1046 * with others. We will replace it during presentation to our $importer
1047 * to contain a sparkle link and perhaps a photo.
1050 'uid' => $contact['uid'],
1051 'cid' => $contact['id'],
1052 'start' => DateTimeFormat::utc($birthday),
1053 'finish' => DateTimeFormat::utc($birthday . ' + 1 day '),
1054 'summary' => DI::l10n()->t('%s\'s birthday', $contact['name']),
1055 'desc' => DI::l10n()->t('Happy Birthday %s', ' [url=' . $contact['url'] . ']' . $contact['name'] . '[/url]'),
1056 'type' => 'birthday',
1060 self::store($values);