src/Model/Event.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2022, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   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.
  11  *
  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.
  16  *
  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/>.
  19  *
  20  */
  21
  22 namespace Friendica\Model;
  23
  24 use Friendica\Content\Text\BBCode;
  25 use Friendica\Core\Hook;
  26 use Friendica\Core\Logger;
  27 use Friendica\Core\Renderer;
  28 use Friendica\Core\System;
  29 use Friendica\Database\DBA;
  30 use Friendica\DI;
  31 use Friendica\Network\HTTPException\NotFoundException;
  32 use Friendica\Network\HTTPException\UnauthorizedException;
  33 use Friendica\Protocol\Activity;
  34 use Friendica\Util\DateTimeFormat;
  35 use Friendica\Util\Map;
  36 use Friendica\Util\Strings;
  37 use Friendica\Util\Temporal;
  38 use Friendica\Util\XML;
  39
  40 /**
  41  * functions for interacting with the event database table
  42  */
  43 class Event
  44 {
  45
  46         public static function getHTML(array $event, bool $simple = false, int $uriid = 0): string
  47         {
  48                 if (empty($event)) {
  49                         return '';
  50                 }
  51
  52                 $uriid = $event['uri-id'] ?? $uriid;
  53
  54                 $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)
  55
  56                 $event_start = DI::l10n()->getDay(DateTimeFormat::local($event['start'], $bd_format));
  57
  58                 if (!empty($event['finish'])) {
  59                         $event_end = DI::l10n()->getDay(DateTimeFormat::local($event['finish'], $bd_format));
  60                 } else {
  61                         $event_end = '';
  62                 }
  63
  64                 if ($simple) {
  65                         $o = '';
  66
  67                         if (!empty($event['summary'])) {
  68                                 $o .= "<h3>" . BBCode::convertForUriId($uriid, Strings::escapeHtml($event['summary']), $simple) . "</h3>";
  69                         }
  70
  71                         if (!empty($event['desc'])) {
  72                                 $o .= "<div>" . BBCode::convertForUriId($uriid, Strings::escapeHtml($event['desc']), $simple) . "</div>";
  73                         }
  74
  75                         $o .= "<h4>" . DI::l10n()->t('Starts:') . "</h4><p>" . $event_start . "</p>";
  76
  77                         if (!$event['nofinish']) {
  78                                 $o .= "<h4>" . DI::l10n()->t('Finishes:') . "</h4><p>" . $event_end . "</p>";
  79                         }
  80
  81                         if (!empty($event['location'])) {
  82                                 $o .= "<h4>" . DI::l10n()->t('Location:') . "</h4><p>" . BBCode::convertForUriId($uriid, Strings::escapeHtml($event['location']), $simple) . "</p>";
  83                         }
  84
  85                         return $o;
  86                 }
  87
  88                 $o = '<div class="vevent">' . "\r\n";
  89
  90                 $o .= '<div class="summary event-summary">' . BBCode::convertForUriId($uriid, Strings::escapeHtml($event['summary']), $simple) . '</div>' . "\r\n";
  91
  92                 $o .= '<div class="event-start"><span class="event-label">' . DI::l10n()->t('Starts:') . '</span>&nbsp;<span class="dtstart" title="'
  93                         . DateTimeFormat::local($event['start'], DateTimeFormat::ATOM)
  94                         . '" >' . $event_start
  95                         . '</span></div>' . "\r\n";
  96
  97                 if (!$event['nofinish']) {
  98                         $o .= '<div class="event-end" ><span class="event-label">' . DI::l10n()->t('Finishes:') . '</span>&nbsp;<span class="dtend" title="'
  99                                 . DateTimeFormat::local($event['finish'], DateTimeFormat::ATOM)
 100                                 . '" >' . $event_end
 101                                 . '</span></div>' . "\r\n";
 102                 }
 103
 104                 if (!empty($event['desc'])) {
 105                         $o .= '<div class="description event-description">' . BBCode::convertForUriId($uriid, Strings::escapeHtml($event['desc']), $simple) . '</div>' . "\r\n";
 106                 }
 107
 108                 if (!empty($event['location'])) {
 109                         $o .= '<div class="event-location"><span class="event-label">' . DI::l10n()->t('Location:') . '</span>&nbsp;<span class="location">'
 110                                 . BBCode::convertForUriId($uriid, Strings::escapeHtml($event['location']), $simple)
 111                                 . '</span></div>' . "\r\n";
 112
 113                         // Include a map of the location if the [map] BBCode is used.
 114                         if (strpos($event['location'], "[map") !== false) {
 115                                 $map = Map::byLocation($event['location'], $simple);
 116                                 if ($map !== $event['location']) {
 117                                         $o .= $map;
 118                                 }
 119                         }
 120                 }
 121
 122                 $o .= '</div>' . "\r\n";
 123                 return $o;
 124         }
 125
 126         /**
 127          * Convert an array with event data to bbcode.
 128          *
 129          * @param array $event Array which contains the event data.
 130          * @return string The event as a bbcode formatted string.
 131          */
 132         private static function getBBCode(array $event): string
 133         {
 134                 $o = '';
 135
 136                 if ($event['summary']) {
 137                         $o .= '[event-summary]' . $event['summary'] . '[/event-summary]';
 138                 }
 139
 140                 if ($event['desc']) {
 141                         $o .= '[event-description]' . $event['desc'] . '[/event-description]';
 142                 }
 143
 144                 if ($event['start']) {
 145                         $o .= '[event-start]' . $event['start'] . '[/event-start]';
 146                 }
 147
 148                 if (($event['finish']) && (!$event['nofinish'])) {
 149                         $o .= '[event-finish]' . $event['finish'] . '[/event-finish]';
 150                 }
 151
 152                 if ($event['location']) {
 153                         $o .= '[event-location]' . $event['location'] . '[/event-location]';
 154                 }
 155
 156                 return $o;
 157         }
 158
 159         /**
 160          * Extract bbcode formatted event data from a string.
 161          *
 162          * @param string $text The string which should be parsed for event data.
 163          * @return array The array with the event information.
 164          */
 165         public static function fromBBCode(string $text): array
 166         {
 167                 $ev = [];
 168
 169                 $match = [];
 170                 if (preg_match("/\[event\-summary\](.*?)\[\/event\-summary\]/is", $text, $match)) {
 171                         $ev['summary'] = $match[1];
 172                 }
 173
 174                 $match = [];
 175                 if (preg_match("/\[event\-description\](.*?)\[\/event\-description\]/is", $text, $match)) {
 176                         $ev['desc'] = $match[1];
 177                 }
 178
 179                 $match = [];
 180                 if (preg_match("/\[event\-start\](.*?)\[\/event\-start\]/is", $text, $match)) {
 181                         $ev['start'] = $match[1];
 182                 }
 183
 184                 $match = [];
 185                 if (preg_match("/\[event\-finish\](.*?)\[\/event\-finish\]/is", $text, $match)) {
 186                         $ev['finish'] = $match[1];
 187                 }
 188
 189                 $match = [];
 190                 if (preg_match("/\[event\-location\](.*?)\[\/event\-location\]/is", $text, $match)) {
 191                         $ev['location'] = $match[1];
 192                 }
 193
 194                 $ev['nofinish'] = !empty($ev['start']) && empty($ev['finish']) ? 1 : 0;
 195
 196                 return $ev;
 197         }
 198
 199         public static function sortByDate(array $event_list): array
 200         {
 201                 usort($event_list, ['self', 'compareDatesCallback']);
 202                 return $event_list;
 203         }
 204
 205         private static function compareDatesCallback(array $event_a, array $event_b)
 206         {
 207                 $date_a = DateTimeFormat::local($event_a['start']);
 208                 $date_b = DateTimeFormat::local($event_b['start']);
 209
 210                 if ($date_a === $date_b) {
 211                         return strcasecmp($event_a['desc'], $event_b['desc']);
 212                 }
 213
 214                 return strcmp($date_a, $date_b);
 215         }
 216
 217         /**
 218          * Delete an event from the event table.
 219          *
 220          * Note: This function does only delete the event from the event table not its
 221          * related entry in the item table.
 222          *
 223          * @param int $event_id Event ID.
 224          * @return void
 225          * @throws \Exception
 226          */
 227         public static function delete(int $event_id)
 228         {
 229                 if ($event_id == 0) {
 230                         return;
 231                 }
 232
 233                 DBA::delete('event', ['id' => $event_id]);
 234                 Logger::info("Deleted event", ['id' => $event_id]);
 235         }
 236
 237         /**
 238          * Store the event.
 239          *
 240          * Store the event in the event table and create an event item in the item table.
 241          *
 242          * @param array $arr Array with event data.
 243          * @return int The new event id.
 244          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 245          */
 246         public static function store(array $arr): int
 247         {
 248                 $guid = $arr['guid'] ?? '' ?: System::createUUID();
 249                 $uri  = $arr['uri']  ?? '' ?: Item::newURI($guid);
 250                 $event = [
 251                         'id'        => intval($arr['id']        ?? 0),
 252                         'uid'       => intval($arr['uid']       ?? 0),
 253                         'cid'       => intval($arr['cid']       ?? 0),
 254                         'guid'      => $guid,
 255                         'uri'       => $uri,
 256                         'uri-id'    => ItemURI::insert(['uri' => $uri, 'guid' => $guid]),
 257                         'type'      => ($arr['type']      ?? '') ?: 'event',
 258                         'summary'   =>  $arr['summary']   ?? '',
 259                         'desc'      =>  $arr['desc']      ?? '',
 260                         'location'  =>  $arr['location']  ?? '',
 261                         'allow_cid' =>  $arr['allow_cid'] ?? '',
 262                         'allow_gid' =>  $arr['allow_gid'] ?? '',
 263                         'deny_cid'  =>  $arr['deny_cid']  ?? '',
 264                         'deny_gid'  =>  $arr['deny_gid']  ?? '',
 265                         'nofinish'  => intval($arr['nofinish'] ?? (!empty($arr['start']) && empty($arr['finish']))),
 266                         'created'   => DateTimeFormat::utc(($arr['created'] ?? '') ?: 'now'),
 267                         'edited'    => DateTimeFormat::utc(($arr['edited']  ?? '') ?: 'now'),
 268                         'start'     => DateTimeFormat::utc(($arr['start']   ?? '') ?: DBA::NULL_DATETIME),
 269                         'finish'    => DateTimeFormat::utc(($arr['finish']  ?? '') ?: DBA::NULL_DATETIME),
 270                 ];
 271
 272
 273                 if ($event['finish'] < DBA::NULL_DATETIME) {
 274                         $event['finish'] = DBA::NULL_DATETIME;
 275                 }
 276
 277                 // Existing event being modified.
 278                 if ($event['id']) {
 279                         // has the event actually changed?
 280                         $existing_event = DBA::selectFirst('event', ['edited'], ['id' => $event['id'], 'uid' => $event['uid']]);
 281                         if (!DBA::isResult($existing_event)) {
 282                                 return 0;
 283                         }
 284
 285                         if ($existing_event['edited'] === $event['edited']) {
 286                                 return $event['id'];
 287                         }
 288
 289                         $updated_fields = [
 290                                 'edited'   => $event['edited'],
 291                                 'start'    => $event['start'],
 292                                 'finish'   => $event['finish'],
 293                                 'summary'  => $event['summary'],
 294                                 'desc'     => $event['desc'],
 295                                 'location' => $event['location'],
 296                                 'type'     => $event['type'],
 297                                 'nofinish' => $event['nofinish'],
 298                         ];
 299
 300                         DBA::update('event', $updated_fields, ['id' => $event['id'], 'uid' => $event['uid']]);
 301
 302                         $item = Post::selectFirst(['id', 'uri-id'], ['event-id' => $event['id'], 'uid' => $event['uid']]);
 303                         if (DBA::isResult($item)) {
 304                                 $object = '<object><type>' . XML::escape(Activity\ObjectType::EVENT) . '</type><title></title><id>' . XML::escape($event['uri']) . '</id>';
 305                                 $object .= '<content>' . XML::escape(self::getBBCode($event)) . '</content>';
 306                                 $object .= '</object>' . "\n";
 307
 308                                 $fields = ['body' => self::getBBCode($event), 'object' => $object, 'edited' => $event['edited']];
 309                                 Item::update($fields, ['id' => $item['id']]);
 310                         }
 311
 312                         Hook::callAll('event_updated', $event['id']);
 313                 } else {
 314                         // New event. Store it.
 315                         DBA::insert('event', $event);
 316
 317                         $event['id'] = DBA::lastInsertId();
 318
 319                         Hook::callAll("event_created", $event['id']);
 320                 }
 321
 322                 return $event['id'];
 323         }
 324
 325         public static function getItemArrayForId(int $event_id, array $item = []): array
 326         {
 327                 if (empty($event_id)) {
 328                         return $item;
 329                 }
 330
 331                 $event = DBA::selectFirst('event', [], ['id' => $event_id]);
 332                 if ($event['type'] != 'event') {
 333                         return $item;
 334                 }
 335
 336                 if ($event['cid']) {
 337                         $conditions = ['id' => $event['cid']];
 338                 } else {
 339                         $conditions = ['uid' => $event['uid'], 'self' => true];
 340                 }
 341
 342                 $contact = DBA::selectFirst('contact', [], $conditions);
 343
 344                 $event['id'] = $event_id;
 345
 346                 $item['uid']           = $event['uid'];
 347                 $item['contact-id']    = $event['cid'];
 348                 $item['uri']           = $event['uri'];
 349                 $item['uri-id']        = ItemURI::getIdByURI($event['uri']);
 350                 $item['guid']          = $event['guid'];
 351                 $item['plink']         = $arr['plink'] ?? '';
 352                 $item['post-type']     = Item::PT_EVENT;
 353                 $item['wall']          = $event['cid'] ? 0 : 1;
 354                 $item['contact-id']    = $contact['id'];
 355                 $item['owner-name']    = $contact['name'];
 356                 $item['owner-link']    = $contact['url'];
 357                 $item['owner-avatar']  = $contact['thumb'];
 358                 $item['author-name']   = $contact['name'];
 359                 $item['author-link']   = $contact['url'];
 360                 $item['author-avatar'] = $contact['thumb'];
 361                 $item['title']         = '';
 362                 $item['allow_cid']     = $event['allow_cid'];
 363                 $item['allow_gid']     = $event['allow_gid'];
 364                 $item['deny_cid']      = $event['deny_cid'];
 365                 $item['deny_gid']      = $event['deny_gid'];
 366                 $item['private']       = intval($event['private'] ?? 0);
 367                 $item['visible']       = 1;
 368                 $item['verb']          = Activity::POST;
 369                 $item['object-type']   = Activity\ObjectType::EVENT;
 370                 $item['post-type']     = Item::PT_EVENT;
 371                 $item['origin']        = $event['cid'] === 0 ? 1 : 0;
 372                 $item['body']          = self::getBBCode($event);
 373                 $item['event-id']      = $event['id'];
 374
 375                 $item['object']  = '<object><type>' . XML::escape(Activity\ObjectType::EVENT) . '</type><title></title><id>' . XML::escape($event['uri']) . '</id>';
 376                 $item['object'] .= '<content>' . XML::escape(self::getBBCode($event)) . '</content>';
 377                 $item['object'] .= '</object>' . "\n";
 378
 379                 return $item;
 380         }
 381
 382         public static function getItemArrayForImportedId(int $event_id, array $item = []): array
 383         {
 384                 if (empty($event_id)) {
 385                         return $item;
 386                 }
 387
 388                 $event = DBA::selectFirst('event', [], ['id' => $event_id]);
 389                 if ($event['type'] != 'event') {
 390                         return $item;
 391                 }
 392
 393                 $item['post-type']     = Item::PT_EVENT;
 394                 $item['title']         = '';
 395                 $item['object-type']   = Activity\ObjectType::EVENT;
 396                 $item['body']          = self::getBBCode($event);
 397                 $item['event-id']      = $event_id;
 398
 399                 $item['object']  = '<object><type>' . XML::escape(Activity\ObjectType::EVENT) . '</type><title></title><id>' . XML::escape($event['uri']) . '</id>';
 400                 $item['object'] .= '<content>' . XML::escape(self::getBBCode($event)) . '</content>';
 401                 $item['object'] .= '</object>' . "\n";
 402
 403                 return $item;
 404         }
 405
 406         /**
 407          * Create an array with translation strings used for events.
 408          *
 409          * @return array Array with translations strings.
 410          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 411          */
 412         public static function getStrings(): array
 413         {
 414                 // First day of the week (0 = Sunday).
 415                 $firstDay = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'system', 'first_day_of_week', 0);
 416
 417                 $i18n = [
 418                         "firstDay" => $firstDay,
 419                         "allday"   => DI::l10n()->t("all-day"),
 420
 421                         "Sun" => DI::l10n()->t("Sun"),
 422                         "Mon" => DI::l10n()->t("Mon"),
 423                         "Tue" => DI::l10n()->t("Tue"),
 424                         "Wed" => DI::l10n()->t("Wed"),
 425                         "Thu" => DI::l10n()->t("Thu"),
 426                         "Fri" => DI::l10n()->t("Fri"),
 427                         "Sat" => DI::l10n()->t("Sat"),
 428
 429                         "Sunday"    => DI::l10n()->t("Sunday"),
 430                         "Monday"    => DI::l10n()->t("Monday"),
 431                         "Tuesday"   => DI::l10n()->t("Tuesday"),
 432                         "Wednesday" => DI::l10n()->t("Wednesday"),
 433                         "Thursday"  => DI::l10n()->t("Thursday"),
 434                         "Friday"    => DI::l10n()->t("Friday"),
 435                         "Saturday"  => DI::l10n()->t("Saturday"),
 436
 437                         "Jan" => DI::l10n()->t("Jan"),
 438                         "Feb" => DI::l10n()->t("Feb"),
 439                         "Mar" => DI::l10n()->t("Mar"),
 440                         "Apr" => DI::l10n()->t("Apr"),
 441                         "May" => DI::l10n()->t("May"),
 442                         "Jun" => DI::l10n()->t("Jun"),
 443                         "Jul" => DI::l10n()->t("Jul"),
 444                         "Aug" => DI::l10n()->t("Aug"),
 445                         "Sep" => DI::l10n()->t("Sept"),
 446                         "Oct" => DI::l10n()->t("Oct"),
 447                         "Nov" => DI::l10n()->t("Nov"),
 448                         "Dec" => DI::l10n()->t("Dec"),
 449
 450                         "January"   => DI::l10n()->t("January"),
 451                         "February"  => DI::l10n()->t("February"),
 452                         "March"     => DI::l10n()->t("March"),
 453                         "April"     => DI::l10n()->t("April"),
 454                         "June"      => DI::l10n()->t("June"),
 455                         "July"      => DI::l10n()->t("July"),
 456                         "August"    => DI::l10n()->t("August"),
 457                         "September" => DI::l10n()->t("September"),
 458                         "October"   => DI::l10n()->t("October"),
 459                         "November"  => DI::l10n()->t("November"),
 460                         "December"  => DI::l10n()->t("December"),
 461
 462                         "today" => DI::l10n()->t("today"),
 463                         "month" => DI::l10n()->t("month"),
 464                         "week"  => DI::l10n()->t("week"),
 465                         "day"   => DI::l10n()->t("day"),
 466
 467                         "noevent" => DI::l10n()->t("No events to display"),
 468
 469                         "dtstart_label"  => DI::l10n()->t("Starts:"),
 470                         "dtend_label"    => DI::l10n()->t("Finishes:"),
 471                         "location_label" => DI::l10n()->t("Location:")
 472                 ];
 473
 474                 return $i18n;
 475         }
 476
 477         /**
 478          * Removes duplicated birthday events.
 479          *
 480          * @param array $dates Array of possibly duplicated events.
 481          * @return array Cleaned events.
 482          *
 483          * @todo We should replace this with a separate update function if there is some time left.
 484          */
 485         private static function removeDuplicates(array $dates): array
 486         {
 487                 $dates2 = [];
 488
 489                 foreach ($dates as $date) {
 490                         if ($date['type'] == 'birthday') {
 491                                 $dates2[$date['uid'] . "-" . $date['cid'] . "-" . $date['start']] = $date;
 492                         } else {
 493                                 $dates2[] = $date;
 494                         }
 495                 }
 496                 return array_values($dates2);
 497         }
 498
 499         /**
 500          * Returns the owner array of a given nickname
 501          * Additionally, it can check if the owner array is selectable
 502          *
 503          * @param string $nickname
 504          * @param bool   $check
 505          *
 506          * @return array the owner array
 507          * @throws NotFoundException The given nickname does not exist
 508          * @throws UnauthorizedException The access for the given nickname is restricted
 509          */
 510         public static function getOwnerForNickname(string $nickname, bool $check = true): array
 511         {
 512                 $owner = User::getOwnerDataByNick($nickname);
 513                 if (empty($owner)) {
 514                         throw new NotFoundException(DI::l10n()->t('User not found.'));
 515                 }
 516
 517                 if ($check) {
 518                         $contact_id = DI::userSession()->getRemoteContactID($owner['uid']);
 519
 520                         $remote_contact = $contact_id && DBA::exists('contact', ['id' => $contact_id, 'uid' => $owner['uid']]);
 521
 522                         $is_owner = DI::userSession()->getLocalUserId() == $owner['uid'];
 523
 524                         if ($owner['hidewall'] && !$is_owner && !$remote_contact) {
 525                                 throw new UnauthorizedException(DI::l10n()->t('Access to this profile has been restricted.'));
 526                         }
 527                 }
 528
 529                 return $owner;
 530         }
 531
 532         /**
 533          * Get an event by its event ID.
 534          *
 535          * @param int         $owner_uid The User ID of the owner of the event
 536          * @param int         $event_id  The ID of the event in the event table
 537          * @param string|null $nickname  a possible nickname to search for instead of the owner uid
 538          * @return array Query result
 539          * @throws \Exception
 540          */
 541         public static function getByIdAndUid(int $owner_uid, int $event_id, string $nickname = null): array
 542         {
 543                 if (!empty($nickname)) {
 544                         $owner = static::getOwnerForNickname($nickname, true);
 545                         $owner_uid = $owner['uid'];
 546
 547                         // get the permissions
 548                         $sql_perms = Item::getPermissionsSQLByUserId($owner_uid);
 549                         // we only want to have the events of the profile owner
 550                         $sql_extra = " AND `event`.`cid` = 0 " . $sql_perms;
 551                 } else {
 552                         $sql_extra = "";
 553                 }
 554
 555                 // Only allow events if there is a valid owner_id.
 556                 if ($owner_uid == 0) {
 557                         return [];
 558                 }
 559
 560                 // Query for the event by event id
 561                 $events = DBA::toArray(DBA::p("SELECT `event`.*, `post-user`.`id` AS `itemid` FROM `event`
 562                         LEFT JOIN `post-user` ON `post-user`.`event-id` = `event`.`id` AND `post-user`.`uid` = `event`.`uid`
 563                         WHERE `event`.`uid` = ? AND `event`.`id` = ? $sql_extra",
 564                         $owner_uid, $event_id));
 565
 566                 if (empty($events)) {
 567                         throw new NotFoundException(DI::l10n()->t('Event not found.'));
 568                 } else {
 569                         $events = self::removeDuplicates($events);
 570                         return $events[0];
 571                 }
 572         }
 573
 574         /**
 575          * Get all events in a specific time frame.
 576          *
 577          * @param int         $owner_uid The User ID of the owner of the events.
 578          * @param string|null $start     Start time of the timeframe.
 579          * @param string|null $finish    Finish time of the timeframe.
 580          * @param bool        $ignore
 581          * @param string|null $nickname
 582          *
 583          * @return array Query results.
 584          * @throws NotFoundException
 585          * @throws UnauthorizedException
 586          */
 587         public static function getListByDate(int $owner_uid, string $start = null, string $finish = null, bool $ignore = false, string $nickname = null): array
 588         {
 589                 if (!empty($nickname)) {
 590                         $owner     = static::getOwnerForNickname($nickname);
 591                         $owner_uid = $owner['uid'];
 592
 593                         // get the permissions
 594                         $sql_perms = Item::getPermissionsSQLByUserId($owner_uid);
 595                         // we only want to have the events of the profile owner
 596                         $sql_extra = " AND `event`.`cid` = 0 " . $sql_perms;
 597                 } else {
 598                         $sql_extra = "";
 599                 }
 600
 601                 // Only allow events if there is a valid owner_id.
 602                 if ($owner_uid == 0) {
 603                         return [];
 604                 }
 605
 606                 if (empty($start) || empty($finish)) {
 607
 608                         $y = intval(DateTimeFormat::localNow('Y'));
 609                         $m = intval(DateTimeFormat::localNow('m'));
 610
 611                         if (empty($start)) {
 612                                 $start = sprintf('%d-%d-%d %d:%d:%d', $y, $m, 1, 0, 0, 0);
 613                         } else {
 614                                 $dim    = Temporal::getDaysInMonth($y, $m);
 615                                 $finish = sprintf('%d-%d-%d %d:%d:%d', $y, $m, $dim, 23, 59, 59);
 616                         }
 617                 }
 618
 619                 // Query for the event by date.
 620                 $events = DBA::toArray(DBA::p("SELECT `event`.*, `post-user`.`id` AS `itemid` FROM `event`
 621                                 LEFT JOIN `post-user` ON `post-user`.`event-id` = `event`.`id` AND `post-user`.`uid` = `event`.`uid`
 622                                 WHERE `event`.`uid` = ? AND `event`.`ignore` = ?
 623                                 AND (`finish` >= ? OR (`nofinish` AND `start` >= ?)) AND `start` <= ?
 624                                 " . $sql_extra,
 625                         $owner_uid, $ignore,
 626                         $start, $start, $finish
 627                 ));
 628
 629                 $events = self::removeDuplicates($events ?? []);
 630                 return self::sortByDate($events);
 631         }
 632
 633         /**
 634          * Convert an array query results in an array which could be used by the events template.
 635          *
 636          * @param array $event_result Event query array.
 637          * @return array Event array for the template.
 638          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 639          * @throws \ImagickException
 640          */
 641         public static function prepareListForTemplate(array $event_result): array
 642         {
 643                 $event_list = [];
 644
 645                 foreach ($event_result as $event) {
 646                         $event_list[] = static::prepareForItem($event);
 647                 }
 648
 649                 return $event_list;
 650         }
 651
 652         /**
 653          * Convert an one event in an array which could be used by the events template.
 654          *
 655          * @param array $event Event query array.
 656          * @return array Event array for the template.
 657          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 658          * @throws \ImagickException
 659          */
 660         public static function prepareForItem(array $event): array
 661         {
 662                 $fmt = DI::l10n()->t('l, F j');
 663
 664                 $item = Post::selectFirst(['plink', 'author-name', 'author-network', 'author-id', 'author-avatar', 'author-link', 'private', 'uri-id'], ['id' => $event['itemid']]);
 665                 if (empty($item)) {
 666                         // Using default values when no item had been found
 667                         $item = ['plink' => '', 'author-name' => '', 'author-avatar' => '', 'author-link' => '', 'private' => Item::PUBLIC, 'uri-id' => ($event['uri-id'] ?? 0)];
 668                 }
 669
 670                 $event = array_merge($event, $item);
 671
 672                 $start = DateTimeFormat::local($event['start'], 'c');
 673                 $j     = DateTimeFormat::local($event['start'], 'j');
 674                 $day   = DateTimeFormat::local($event['start'], $fmt);
 675                 $day   = DI::l10n()->getDay($day);
 676
 677                 if ($event['nofinish']) {
 678                         $end = null;
 679                 } else {
 680                         $end = DateTimeFormat::local($event['finish'], 'c');
 681                 }
 682
 683                 // Show edit and drop actions only if the user is the owner of the event and the event
 684                 // is a real event (no bithdays).
 685                 $edit = null;
 686                 $copy = null;
 687                 $drop = null;
 688                 if (DI::userSession()->getLocalUserId() && DI::userSession()->getLocalUserId() == $event['uid'] && $event['type'] == 'event') {
 689                         $edit = !$event['cid'] ? ['calendar/event/edit/' . $event['id'], DI::l10n()->t('Edit event')     , '', ''] : null;
 690                         $copy = !$event['cid'] ? ['calendar/event/copy/' . $event['id'] , DI::l10n()->t('Duplicate event'), '', ''] : null;
 691                         $drop =                  ['calendar/api/delete/' . $event['id'] , DI::l10n()->t('Delete event')   , '', ''];
 692                 }
 693
 694                 $title = BBCode::convertForUriId($event['uri-id'], Strings::escapeHtml($event['summary']));
 695                 if (!$title) {
 696                         [$title, $_trash] = explode("<br", BBCode::convertForUriId($event['uri-id'], Strings::escapeHtml($event['desc'])), BBCode::TWITTER_API);
 697                 }
 698
 699                 $author_link = $event['author-link'];
 700
 701                 $event['author-link'] = Contact::magicLink($author_link);
 702
 703                 $html = self::getHTML($event);
 704                 $event['summary']  = BBCode::convertForUriId($event['uri-id'], Strings::escapeHtml($event['summary']));
 705                 $event['desc']     = BBCode::convertForUriId($event['uri-id'], Strings::escapeHtml($event['desc']));
 706                 $event['location'] = BBCode::convertForUriId($event['uri-id'], Strings::escapeHtml($event['location']));
 707
 708                 return [
 709                         'id'       => $event['id'],
 710                         'start'    => $start,
 711                         'end'      => $end,
 712                         'allDay'   => false,
 713                         'title'    => $title,
 714                         'j'        => $j,
 715                         'd'        => $day,
 716                         'edit'     => $edit,
 717                         'drop'     => $drop,
 718                         'copy'     => $copy,
 719                         'item'     => $event,
 720                         'html'     => $html,
 721                         'plink'    => Item::getPlink($event),
 722                 ];
 723         }
 724
 725         /**
 726          * Format event to export format (ical/csv).
 727          *
 728          * @param array  $events Query result for events.
 729          * @param string $format The output format (ical/csv).
 730          *
 731          * @param string $timezone Timezone (missing parameter!)
 732          * @return string Content according to selected export format.
 733          *
 734          * @todo  Implement timezone support
 735          */
 736         private static function formatListForExport(array $events, string $format): string
 737         {
 738                 $o = '';
 739
 740                 if (!count($events)) {
 741                         return $o;
 742                 }
 743
 744                 switch ($format) {
 745                         // Format the exported data as a CSV file.
 746                         case "csv":
 747                                 $o .= '"Subject", "Start Date", "Start Time", "Description", "End Date", "End Time", "Location"' . PHP_EOL;
 748
 749                                 foreach ($events as $event) {
 750                                         /// @todo The time / date entries don't include any information about the
 751                                         /// timezone the event is scheduled in :-/
 752                                         $tmp1 = strtotime($event['start']);
 753                                         $tmp2 = strtotime($event['finish']);
 754                                         $time_format = "%H:%M:%S";
 755                                         $date_format = "%Y-%m-%d";
 756
 757                                         $o .= '"' . $event['summary'] . '", "' . strftime($date_format, $tmp1) .
 758                                                 '", "' . strftime($time_format, $tmp1) . '", "' . $event['desc'] .
 759                                                 '", "' . strftime($date_format, $tmp2) .
 760                                                 '", "' . strftime($time_format, $tmp2) .
 761                                                 '", "' . $event['location'] . '"' . PHP_EOL;
 762                                 }
 763                                 break;
 764
 765                         // Format the exported data as a ics file.
 766                         case "ical":
 767                                 $o = 'BEGIN:VCALENDAR' . PHP_EOL
 768                                         . 'VERSION:2.0' . PHP_EOL
 769                                         . 'PRODID:-//friendica calendar export//0.1//EN' . PHP_EOL;
 770                                 ///  @todo include timezone informations in cases were the time is not in UTC
 771                                 //  see http://tools.ietf.org/html/rfc2445#section-4.8.3
 772                                 //              . 'BEGIN:VTIMEZONE' . PHP_EOL
 773                                 //              . 'TZID:' . $timezone . PHP_EOL
 774                                 //              . 'END:VTIMEZONE' . PHP_EOL;
 775                                 //  TODO instead of PHP_EOL CRLF should be used for long entries
 776                                 //       but test your solution against http://icalvalid.cloudapp.net/
 777                                 //       also long lines SHOULD be split at 75 characters length
 778                                 foreach ($events as $event) {
 779                                         $o .= 'BEGIN:VEVENT' . PHP_EOL;
 780                                         $o .= 'UID:' . $event['id'] . PHP_EOL;
 781                                         $o .= 'DTSTAMP:' . DateTimeFormat::utc($event['created'], 'Ymd\THis\Z') . PHP_EOL;
 782
 783                                         if ($event['start']) {
 784                                                 $o .= 'DTSTART:' . DateTimeFormat::utc($event['start'], 'Ymd\THis\Z') . PHP_EOL;
 785                                         }
 786
 787                                         if (!$event['nofinish']) {
 788                                                 $o .= 'DTEND:' . DateTimeFormat::utc($event['finish'], 'Ymd\THis\Z') . PHP_EOL;
 789                                         }
 790
 791                                         if ($event['summary']) {
 792                                                 $tmp = $event['summary'];
 793                                                 $tmp = str_replace(PHP_EOL, PHP_EOL . ' ', $tmp);
 794                                                 $tmp = addcslashes($tmp, ',;');
 795                                                 $o .= 'SUMMARY:' . $tmp . PHP_EOL;
 796                                         }
 797
 798                                         if ($event['desc']) {
 799                                                 $tmp = $event['desc'];
 800                                                 $tmp = str_replace(PHP_EOL, PHP_EOL . ' ', $tmp);
 801                                                 $tmp = addcslashes($tmp, ',;');
 802                                                 $o .= 'DESCRIPTION:' . $tmp . PHP_EOL;
 803                                         }
 804
 805                                         if ($event['location']) {
 806                                                 $tmp = $event['location'];
 807                                                 $tmp = str_replace(PHP_EOL, PHP_EOL . ' ', $tmp);
 808                                                 $tmp = addcslashes($tmp, ',;');
 809                                                 $o .= 'LOCATION:' . $tmp . PHP_EOL;
 810                                         }
 811
 812                                         $o .= 'END:VEVENT' . PHP_EOL;
 813                                 }
 814
 815                                 $o .= 'END:VCALENDAR' . PHP_EOL;
 816                                 break;
 817                 }
 818
 819                 return $o;
 820         }
 821
 822         /**
 823          * Get all events for a user ID.
 824          *
 825          *    The query for events is done permission sensitive.
 826          *    If the user is the owner of the calendar they
 827          *    will get all of their available events.
 828          *    If the user is only a visitor only the public events will
 829          *    be available.
 830          *
 831          * @param int $uid The user ID.
 832          *
 833          * @return array Query results.
 834          * @throws \Exception
 835          */
 836         private static function getListByUserId(int $uid = 0): array
 837         {
 838                 $return = [];
 839
 840                 if ($uid == 0) {
 841                         return $return;
 842                 }
 843
 844                 $fields = ['id', 'created', 'start', 'finish', 'summary', 'desc', 'location', 'nofinish'];
 845
 846                 $conditions = ['uid' => $uid, 'cid' => 0];
 847
 848                 // Does the user who requests happen to be the owner of the events
 849                 // requested? then show all of your events, otherwise only those that
 850                 // don't have limitations set in allow_cid and allow_gid.
 851                 if (DI::userSession()->getLocalUserId() != $uid) {
 852                         $conditions += ['allow_cid' => '', 'allow_gid' => ''];
 853                 }
 854
 855                 $events = DBA::select('event', $fields, $conditions);
 856                 if (DBA::isResult($events)) {
 857                         $return = DBA::toArray($events);
 858                 }
 859
 860                 return $return;
 861         }
 862
 863         /**
 864          *
 865          * @param int    $uid    The user ID.
 866          * @param string $format Output format (ical/csv).
 867          * @return array With the results:
 868          *                       bool 'success' => True if the processing was successful,<br>
 869          *                       string 'format' => The output format,<br>
 870          *                       string 'extension' => The file extension of the output format,<br>
 871          *                       string 'content' => The formatted output content.<br>
 872          *
 873          * @throws \Exception
 874          * @todo Respect authenticated users with events_by_uid().
 875          */
 876         public static function exportListByUserId(int $uid, string $format = 'ical'): array
 877         {
 878                 $process = false;
 879
 880                 // Get all events which are owned by a uid (respects permissions).
 881                 $events = self::getListByUserId($uid);
 882
 883                 // We have the events that are available for the requestor.
 884                 // Now format the output according to the requested format.
 885                 $res = self::formatListForExport($events, $format);
 886
 887                 // If there are results the precess was successful.
 888                 if (!empty($res)) {
 889                         $process = true;
 890                 }
 891
 892                 // Get the file extension for the format.
 893                 switch ($format) {
 894                         case "ical":
 895                                 $file_ext = "ics";
 896                                 break;
 897
 898                         case "csv":
 899                                 $file_ext = "csv";
 900                                 break;
 901
 902                         default:
 903                                 $file_ext = "";
 904                 }
 905
 906                 $return = [
 907                         'success'   => $process,
 908                         'format'    => $format,
 909                         'extension' => $file_ext,
 910                         'content'   => $res,
 911                 ];
 912
 913                 return $return;
 914         }
 915
 916         /**
 917          * Format an item array with event data to HTML.
 918          *
 919          * @param array $item Array with item and event data.
 920          * @return string HTML output.
 921          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 922          * @throws \ImagickException
 923          */
 924         public static function getItemHTML(array $item): string
 925         {
 926                 $same_date = false;
 927                 $finish    = false;
 928
 929                 // Set the different time formats.
 930                 $dformat       = DI::l10n()->t('l F d, Y \@ g:i A'); // Friday January 18, 2011 @ 8:01 AM.
 931                 $dformat_short = DI::l10n()->t('D g:i A'); // Fri 8:01 AM.
 932                 $tformat       = DI::l10n()->t('g:i A'); // 8:01 AM.
 933
 934                 // Convert the time to different formats.
 935                 $dtstart_dt = DI::l10n()->getDay(DateTimeFormat::local($item['event-start'], $dformat));
 936                 $dtstart_title = DateTimeFormat::utc($item['event-start'], DateTimeFormat::ATOM);
 937                 // Format: Jan till Dec.
 938                 $month_short = DI::l10n()->getDayShort(DateTimeFormat::local($item['event-start'], 'M'));
 939                 // Format: 1 till 31.
 940                 $date_short = DateTimeFormat::local($item['event-start'], 'j');
 941                 $start_time = DateTimeFormat::local($item['event-start'], $tformat);
 942                 $start_short = DI::l10n()->getDayShort(DateTimeFormat::local($item['event-start'], $dformat_short));
 943
 944                 // If the option 'nofinisch' isn't set, we need to format the finish date/time.
 945                 if (!$item['event-nofinish']) {
 946                         $finish = true;
 947                         $dtend_dt  = DI::l10n()->getDay(DateTimeFormat::local($item['event-finish'], $dformat));
 948                         $dtend_title = DateTimeFormat::utc($item['event-finish'], DateTimeFormat::ATOM);
 949                         $end_short = DI::l10n()->getDayShort(DateTimeFormat::utc($item['event-finish'], $dformat_short));
 950                         $end_time = DateTimeFormat::local($item['event-finish'], $tformat);
 951                         // Check if start and finish time is at the same day.
 952                         if (substr($dtstart_title, 0, 10) === substr($dtend_title, 0, 10)) {
 953                                 $same_date = true;
 954                         }
 955                 } else {
 956                         $dtend_title = '';
 957                         $dtend_dt = '';
 958                         $end_time = '';
 959                         $end_short = '';
 960                 }
 961
 962                 // Format the event location.
 963                 $location = self::locationToArray($item['event-location']);
 964
 965                 // Construct the profile link (magic-auth).
 966                 $author = ['uid' => 0, 'id' => $item['author-id'],
 967                                 'network' => $item['author-network'], 'url' => $item['author-link']];
 968                 $profile_link = Contact::magicLinkByContact($author);
 969
 970                 $tpl = Renderer::getMarkupTemplate('event_stream_item.tpl');
 971                 $return = Renderer::replaceMacros($tpl, [
 972                         '$id'             => $item['event-id'],
 973                         '$title'          => BBCode::convertForUriId($item['uri-id'], $item['event-summary']),
 974                         '$dtstart_label'  => DI::l10n()->t('Starts:'),
 975                         '$dtstart_title'  => $dtstart_title,
 976                         '$dtstart_dt'     => $dtstart_dt,
 977                         '$finish'         => $finish,
 978                         '$dtend_label'    => DI::l10n()->t('Finishes:'),
 979                         '$dtend_title'    => $dtend_title,
 980                         '$dtend_dt'       => $dtend_dt,
 981                         '$month_short'    => $month_short,
 982                         '$date_short'     => $date_short,
 983                         '$same_date'      => $same_date,
 984                         '$start_time'     => $start_time,
 985                         '$start_short'    => $start_short,
 986                         '$end_time'       => $end_time,
 987                         '$end_short'      => $end_short,
 988                         '$author_name'    => $item['author-name'],
 989                         '$author_link'    => $profile_link,
 990                         '$author_avatar'  => $item['author-avatar'],
 991                         '$description'    => BBCode::convertForUriId($item['uri-id'], $item['event-desc']),
 992                         '$location_label' => DI::l10n()->t('Location:'),
 993                         '$show_map_label' => DI::l10n()->t('Show map'),
 994                         '$hide_map_label' => DI::l10n()->t('Hide map'),
 995                         '$map_btn_label'  => DI::l10n()->t('Show map'),
 996                         '$location'       => $location
 997                 ]);
 998
 999                 return $return;
1000         }
1001
1002         /**
1003          * Format a string with map bbcode to an array with location data.
1004          *
1005          * Note: The string must only contain location data. A string with no bbcode will be
1006          * handled as location name.
1007          *
1008          * @param string $s The string with the bbcode formatted location data.
1009          *
1010          * @return array The array with the location data.
1011          *  'name' => The name of the location,<br>
1012          * 'address' => The address of the location,<br>
1013          * 'coordinates' => Latitude and longitude (e.g. '48.864716,2.349014').<br>
1014          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1015          */
1016         private static function locationToArray(string $s = ''): array
1017         {
1018                 if ($s == '') {
1019                         return [];
1020                 }
1021
1022                 $location = ['name' => $s];
1023
1024                 // Map tag with location name - e.g. [map]Paris[/map].
1025                 if (strpos($s, '[/map]') !== false) {
1026                         $found = preg_match("/\[map\](.*?)\[\/map\]/ism", $s, $match);
1027                         if (intval($found) > 0 && array_key_exists(1, $match)) {
1028                                 $location['address'] =  $match[1];
1029                                 // Remove the map bbcode from the location name.
1030                                 $location['name'] = str_replace($match[0], "", $s);
1031                         }
1032                 // Map tag with coordinates - e.g. [map=48.864716,2.349014].
1033                 } elseif (strpos($s, '[map=') !== false) {
1034                         $found = preg_match("/\[map=(.*?)\]/ism", $s, $match);
1035                         if (intval($found) > 0 && array_key_exists(1, $match)) {
1036                                 $location['coordinates'] =  $match[1];
1037                                 // Remove the map bbcode from the location name.
1038                                 $location['name'] = str_replace($match[0], "", $s);
1039                         }
1040                 }
1041
1042                 $location['name'] = BBCode::convert($location['name']);
1043
1044                 // Construct the map HTML.
1045                 if (isset($location['address'])) {
1046                         $location['map'] = '<div class="map">' . Map::byLocation($location['address']) . '</div>';
1047                 } elseif (isset($location['coordinates'])) {
1048                         $location['map'] = '<div class="map">' . Map::byCoordinates(str_replace('/', ' ', $location['coordinates'])) . '</div>';
1049                 }
1050
1051                 return $location;
1052         }
1053
1054         /**
1055          * Add new birthday event for this person
1056          *
1057          * @param array  $contact  Contact array, expects: id, uid, url, name
1058          * @param string $birthday Birthday of the contact
1059          * @return bool
1060          * @throws \Exception
1061          */
1062         public static function createBirthday(array $contact, string $birthday): bool
1063         {
1064                 // Check for duplicates
1065                 $condition = [
1066                         'uid' => $contact['uid'],
1067                         'cid' => $contact['id'],
1068                         'start' => DateTimeFormat::utc($birthday),
1069                         'type' => 'birthday'
1070                 ];
1071                 if (DBA::exists('event', $condition)) {
1072                         return false;
1073                 }
1074
1075                 /*
1076                  * Add new birthday event for this person
1077                  *
1078                  * summary is just a readable placeholder in case the event is shared
1079                  * with others. We will replace it during presentation to our $importer
1080                  * to contain a sparkle link and perhaps a photo.
1081                  */
1082                 $values = [
1083                         'uid'     => $contact['uid'],
1084                         'cid'     => $contact['id'],
1085                         'start'   => DateTimeFormat::utc($birthday),
1086                         'finish'  => DateTimeFormat::utc($birthday . ' + 1 day '),
1087                         'summary' => DI::l10n()->t('%s\'s birthday', $contact['name']),
1088                         'desc'    => DI::l10n()->t('Happy Birthday %s', ' [url=' . $contact['url'] . ']' . $contact['name'] . '[/url]'),
1089                         'type'    => 'birthday',
1090                 ];
1091
1092                 // Check if self::store() was success
1093                 return (self::store($values) > 0);
1094         }
1095
1096         public static function setIgnore(int $uid, int $eventId, bool $ignore = true)
1097         {
1098                 DBA::update('event', ['ignore' => $ignore], ['id' => $eventId, 'uid' => $uid]);
1099         }
1100 }