<?php
/**
- * @copyright Copyright (C) 2010-2021, the Friendica project
+ * @copyright Copyright (C) 2010-2022, the Friendica project
*
* @license GNU AGPL version 3 or any later version
*
use Friendica\Content\Text\BBCode;
use Friendica\Core\Hook;
use Friendica\Core\Logger;
-use Friendica\Core\Protocol;
use Friendica\Core\Renderer;
use Friendica\Core\System;
use Friendica\Database\DBA;
use Friendica\DI;
+use Friendica\Network\HTTPException\NotFoundException;
+use Friendica\Network\HTTPException\UnauthorizedException;
use Friendica\Protocol\Activity;
use Friendica\Util\DateTimeFormat;
use Friendica\Util\Map;
use Friendica\Util\Strings;
+use Friendica\Util\Temporal;
use Friendica\Util\XML;
/**
class Event
{
- public static function getHTML(array $event, $simple = false, $uriid = 0)
+ public static function getHTML(array $event, bool $simple = false, int $uriid = 0): string
{
if (empty($event)) {
return '';
* @param array $event Array which contains the event data.
* @return string The event as a bbcode formatted string.
*/
- private static function getBBCode(array $event)
+ private static function getBBCode(array $event): string
{
$o = '';
/**
* Extract bbcode formatted event data from a string.
*
- * @params: string $s The string which should be parsed for event data.
- * @param $text
+ * @param string $text The string which should be parsed for event data.
* @return array The array with the event information.
*/
- public static function fromBBCode($text)
+ public static function fromBBCode(string $text): array
{
$ev = [];
return $ev;
}
- public static function sortByDate($event_list)
+ public static function sortByDate(array $event_list): array
{
usort($event_list, ['self', 'compareDatesCallback']);
return $event_list;
}
- private static function compareDatesCallback($event_a, $event_b)
+ private static function compareDatesCallback(array $event_a, array $event_b)
{
$date_a = DateTimeFormat::local($event_a['start']);
$date_b = DateTimeFormat::local($event_b['start']);
* @return void
* @throws \Exception
*/
- public static function delete($event_id)
+ public static function delete(int $event_id)
{
if ($event_id == 0) {
return;
}
DBA::delete('event', ['id' => $event_id]);
- Logger::log("Deleted event ".$event_id, Logger::DEBUG);
+ Logger::info("Deleted event", ['id' => $event_id]);
}
/**
* @return int The new event id.
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
- public static function store($arr)
+ public static function store(array $arr): int
{
- $event = [];
- $event['id'] = intval($arr['id'] ?? 0);
- $event['uid'] = intval($arr['uid'] ?? 0);
- $event['cid'] = intval($arr['cid'] ?? 0);
- $event['guid'] = ($arr['guid'] ?? '') ?: System::createUUID();
- $event['uri'] = ($arr['uri'] ?? '') ?: Item::newURI($event['uid'], $event['guid']);
- $event['uri-id'] = ItemURI::insert(['uri' => $event['uri'], 'guid' => $event['guid']]);
- $event['type'] = ($arr['type'] ?? '') ?: 'event';
- $event['summary'] = $arr['summary'] ?? '';
- $event['desc'] = $arr['desc'] ?? '';
- $event['location'] = $arr['location'] ?? '';
- $event['allow_cid'] = $arr['allow_cid'] ?? '';
- $event['allow_gid'] = $arr['allow_gid'] ?? '';
- $event['deny_cid'] = $arr['deny_cid'] ?? '';
- $event['deny_gid'] = $arr['deny_gid'] ?? '';
- $event['nofinish'] = intval($arr['nofinish'] ?? (!empty($event['start']) && empty($event['finish'])));
-
- $event['created'] = DateTimeFormat::utc(($arr['created'] ?? '') ?: 'now');
- $event['edited'] = DateTimeFormat::utc(($arr['edited'] ?? '') ?: 'now');
- $event['start'] = DateTimeFormat::utc(($arr['start'] ?? '') ?: DBA::NULL_DATETIME);
- $event['finish'] = DateTimeFormat::utc(($arr['finish'] ?? '') ?: DBA::NULL_DATETIME);
+ $guid = $arr['guid'] ?? '' ?: System::createUUID();
+ $uri = $arr['uri'] ?? '' ?: Item::newURI($guid);
+ $event = [
+ 'id' => intval($arr['id'] ?? 0),
+ 'uid' => intval($arr['uid'] ?? 0),
+ 'cid' => intval($arr['cid'] ?? 0),
+ 'guid' => $guid,
+ 'uri' => $uri,
+ 'uri-id' => ItemURI::insert(['uri' => $uri, 'guid' => $guid]),
+ 'type' => ($arr['type'] ?? '') ?: 'event',
+ 'summary' => $arr['summary'] ?? '',
+ 'desc' => $arr['desc'] ?? '',
+ 'location' => $arr['location'] ?? '',
+ 'allow_cid' => $arr['allow_cid'] ?? '',
+ 'allow_gid' => $arr['allow_gid'] ?? '',
+ 'deny_cid' => $arr['deny_cid'] ?? '',
+ 'deny_gid' => $arr['deny_gid'] ?? '',
+ 'nofinish' => intval($arr['nofinish'] ?? (!empty($arr['start']) && empty($arr['finish']))),
+ 'created' => DateTimeFormat::utc(($arr['created'] ?? '') ?: 'now'),
+ 'edited' => DateTimeFormat::utc(($arr['edited'] ?? '') ?: 'now'),
+ 'start' => DateTimeFormat::utc(($arr['start'] ?? '') ?: DBA::NULL_DATETIME),
+ 'finish' => DateTimeFormat::utc(($arr['finish'] ?? '') ?: DBA::NULL_DATETIME),
+ ];
+
+
if ($event['finish'] < DBA::NULL_DATETIME) {
$event['finish'] = DBA::NULL_DATETIME;
}
return $event['id'];
}
- public static function getItemArrayForId(int $event_id, array $item = []):array
+ public static function getItemArrayForId(int $event_id, array $item = []): array
{
if (empty($event_id)) {
return $item;
return $item;
}
- public static function getItemArrayForImportedId(int $event_id, array $item = []):array
+ public static function getItemArrayForImportedId(int $event_id, array $item = []): array
{
if (empty($event_id)) {
return $item;
* @return array Array with translations strings.
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
- public static function getStrings()
+ public static function getStrings(): array
{
// First day of the week (0 = Sunday).
- $firstDay = DI::pConfig()->get(local_user(), 'system', 'first_day_of_week', 0);
+ $firstDay = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'system', 'first_day_of_week', 0);
$i18n = [
"firstDay" => $firstDay,
*
* @todo We should replace this with a separate update function if there is some time left.
*/
- private static function removeDuplicates(array $dates)
+ private static function removeDuplicates(array $dates): array
{
$dates2 = [];
return array_values($dates2);
}
+ /**
+ * Returns the owner array of a given nickname
+ * Additionally, it can check if the owner array is selectable
+ *
+ * @param string $nickname
+ * @param bool $check
+ *
+ * @return array the owner array
+ * @throws NotFoundException The given nickname does not exist
+ * @throws UnauthorizedException The access for the given nickname is restricted
+ */
+ public static function getOwnerForNickname(string $nickname, bool $check = true): array
+ {
+ $owner = User::getOwnerDataByNick($nickname);
+ if (empty($owner)) {
+ throw new NotFoundException(DI::l10n()->t('User not found.'));
+ }
+
+ if ($check) {
+ $contact_id = DI::userSession()->getRemoteContactID($owner['uid']);
+
+ $remote_contact = $contact_id && DBA::exists('contact', ['id' => $contact_id, 'uid' => $owner['uid']]);
+
+ $is_owner = DI::userSession()->getLocalUserId() == $owner['uid'];
+
+ if ($owner['hidewall'] && !$is_owner && !$remote_contact) {
+ throw new UnauthorizedException(DI::l10n()->t('Access to this profile has been restricted.'));
+ }
+ }
+
+ return $owner;
+ }
+
/**
* Get an event by its event ID.
*
- * @param int $owner_uid The User ID of the owner of the event
- * @param int $event_id The ID of the event in the event table
- * @param string $sql_extra
+ * @param int $owner_uid The User ID of the owner of the event
+ * @param int $event_id The ID of the event in the event table
+ * @param string|null $nickname a possible nickname to search for instead of the owner uid
* @return array Query result
* @throws \Exception
*/
- public static function getListById($owner_uid, $event_id, $sql_extra = '')
+ public static function getByIdAndUid(int $owner_uid, int $event_id, string $nickname = null): array
{
- $return = [];
+ if (!empty($nickname)) {
+ $owner = static::getOwnerForNickname($nickname, true);
+ $owner_uid = $owner['uid'];
+
+ // get the permissions
+ $sql_perms = Item::getPermissionsSQLByUserId($owner_uid);
+ // we only want to have the events of the profile owner
+ $sql_extra = " AND `event`.`cid` = 0 " . $sql_perms;
+ } else {
+ $sql_extra = "";
+ }
- // Ownly allow events if there is a valid owner_id.
+ // Only allow events if there is a valid owner_id.
if ($owner_uid == 0) {
- return $return;
+ return [];
}
// Query for the event by event id
WHERE `event`.`uid` = ? AND `event`.`id` = ? $sql_extra",
$owner_uid, $event_id));
- if (DBA::isResult($events)) {
- $return = self::removeDuplicates($events);
+ if (empty($events)) {
+ throw new NotFoundException(DI::l10n()->t('Event not found.'));
+ } else {
+ $events = self::removeDuplicates($events);
+ return $events[0];
}
-
- return $return;
}
/**
* Get all events in a specific time frame.
*
- * @param int $owner_uid The User ID of the owner of the events.
- * @param array $event_params An associative array with
- * int 'ignore' =>
- * string 'start' => Start time of the timeframe.
- * string 'finish' => Finish time of the timeframe.
- *
- * @param string $sql_extra Additional sql conditions (e.g. permission request).
+ * @param int $owner_uid The User ID of the owner of the events.
+ * @param string|null $start Start time of the timeframe.
+ * @param string|null $finish Finish time of the timeframe.
+ * @param bool $ignore
+ * @param string|null $nickname
*
* @return array Query results.
- * @throws \Exception
+ * @throws NotFoundException
+ * @throws UnauthorizedException
*/
- public static function getListByDate($owner_uid, $event_params, $sql_extra = '')
+ public static function getListByDate(int $owner_uid, string $start = null, string $finish = null, bool $ignore = false, string $nickname = null): array
{
- $return = [];
+ if (!empty($nickname)) {
+ $owner = static::getOwnerForNickname($nickname);
+ $owner_uid = $owner['uid'];
+
+ // get the permissions
+ $sql_perms = Item::getPermissionsSQLByUserId($owner_uid);
+ // we only want to have the events of the profile owner
+ $sql_extra = " AND `event`.`cid` = 0 " . $sql_perms;
+ } else {
+ $sql_extra = "";
+ }
// Only allow events if there is a valid owner_id.
if ($owner_uid == 0) {
- return $return;
+ return [];
+ }
+
+ if (empty($start) || empty($finish)) {
+
+ $y = intval(DateTimeFormat::localNow('Y'));
+ $m = intval(DateTimeFormat::localNow('m'));
+
+ if (empty($start)) {
+ $start = sprintf('%d-%d-%d %d:%d:%d', $y, $m, 1, 0, 0, 0);
+ } else {
+ $dim = Temporal::getDaysInMonth($y, $m);
+ $finish = sprintf('%d-%d-%d %d:%d:%d', $y, $m, $dim, 23, 59, 59);
+ }
}
// Query for the event by date.
WHERE `event`.`uid` = ? AND `event`.`ignore` = ?
AND (`finish` >= ? OR (`nofinish` AND `start` >= ?)) AND `start` <= ?
" . $sql_extra,
- $owner_uid, $event_params['ignore'],
- $event_params['start'], $event_params['start'], $event_params['finish']
+ $owner_uid, $ignore,
+ $start, $start, $finish
));
- if (DBA::isResult($events)) {
- $return = self::removeDuplicates($events);
- }
-
- return $return;
+ $events = self::removeDuplicates($events ?? []);
+ return self::sortByDate($events);
}
/**
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
* @throws \ImagickException
*/
- public static function prepareListForTemplate(array $event_result)
+ public static function prepareListForTemplate(array $event_result): array
{
$event_list = [];
- $last_date = '';
- $fmt = DI::l10n()->t('l, F j');
foreach ($event_result as $event) {
- $item = Post::selectFirst(['plink', 'author-name', 'author-avatar', 'author-link', 'private', 'uri-id'], ['id' => $event['itemid']]);
- if (!DBA::isResult($item)) {
- // Using default values when no item had been found
- $item = ['plink' => '', 'author-name' => '', 'author-avatar' => '', 'author-link' => '', 'private' => Item::PUBLIC, 'uri-id' => ($event['uri-id'] ?? 0)];
- }
+ $event_list[] = static::prepareForItem($event);
+ }
- $event = array_merge($event, $item);
+ return $event_list;
+ }
- $start = DateTimeFormat::local($event['start'], 'c');
- $j = DateTimeFormat::local($event['start'], 'j');
- $day = DateTimeFormat::local($event['start'], $fmt);
- $day = DI::l10n()->getDay($day);
+ /**
+ * Convert an one event in an array which could be used by the events template.
+ *
+ * @param array $event Event query array.
+ * @return array Event array for the template.
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+ * @throws \ImagickException
+ */
+ public static function prepareForItem(array $event): array
+ {
+ $fmt = DI::l10n()->t('l, F j');
- if ($event['nofinish']) {
- $end = null;
- } else {
- $end = DateTimeFormat::local($event['finish'], 'c');
- }
+ $item = Post::selectFirst(['plink', 'author-name', 'author-network', 'author-id', 'author-avatar', 'author-link', 'private', 'uri-id'], ['id' => $event['itemid']]);
+ if (empty($item)) {
+ // Using default values when no item had been found
+ $item = ['plink' => '', 'author-name' => '', 'author-avatar' => '', 'author-link' => '', 'private' => Item::PUBLIC, 'uri-id' => ($event['uri-id'] ?? 0)];
+ }
- $is_first = ($day !== $last_date);
+ $event = array_merge($event, $item);
- $last_date = $day;
+ $start = DateTimeFormat::local($event['start'], 'c');
+ $j = DateTimeFormat::local($event['start'], 'j');
+ $day = DateTimeFormat::local($event['start'], $fmt);
+ $day = DI::l10n()->getDay($day);
- // Show edit and drop actions only if the user is the owner of the event and the event
- // is a real event (no bithdays).
- $edit = null;
- $copy = null;
- $drop = null;
- if (local_user() && local_user() == $event['uid'] && $event['type'] == 'event') {
- $edit = !$event['cid'] ? [DI::baseUrl() . '/events/event/' . $event['id'], DI::l10n()->t('Edit event') , '', ''] : null;
- $copy = !$event['cid'] ? [DI::baseUrl() . '/events/copy/' . $event['id'] , DI::l10n()->t('Duplicate event'), '', ''] : null;
- $drop = [DI::baseUrl() . '/events/drop/' . $event['id'] , DI::l10n()->t('Delete event') , '', ''];
- }
+ if ($event['nofinish']) {
+ $end = null;
+ } else {
+ $end = DateTimeFormat::local($event['finish'], 'c');
+ }
- $title = BBCode::convertForUriId($event['uri-id'], Strings::escapeHtml($event['summary']));
- if (!$title) {
- list($title, $_trash) = explode("<br", BBCode::convertForUriId($event['uri-id'], Strings::escapeHtml($event['desc'])), BBCode::API);
- }
+ // Show edit and drop actions only if the user is the owner of the event and the event
+ // is a real event (no bithdays).
+ $edit = null;
+ $copy = null;
+ $drop = null;
+ if (DI::userSession()->getLocalUserId() && DI::userSession()->getLocalUserId() == $event['uid'] && $event['type'] == 'event') {
+ $edit = !$event['cid'] ? ['calendar/event/edit/' . $event['id'], DI::l10n()->t('Edit event') , '', ''] : null;
+ $copy = !$event['cid'] ? ['calendar/event/copy/' . $event['id'] , DI::l10n()->t('Duplicate event'), '', ''] : null;
+ $drop = ['calendar/api/delete/' . $event['id'] , DI::l10n()->t('Delete event') , '', ''];
+ }
- $author_link = $event['author-link'];
-
- $event['author-link'] = Contact::magicLink($author_link);
-
- $html = self::getHTML($event);
- $event['summary'] = BBCode::convertForUriId($event['uri-id'], Strings::escapeHtml($event['summary']));
- $event['desc'] = BBCode::convertForUriId($event['uri-id'], Strings::escapeHtml($event['desc']));
- $event['location'] = BBCode::convertForUriId($event['uri-id'], Strings::escapeHtml($event['location']));
- $event_list[] = [
- 'id' => $event['id'],
- 'start' => $start,
- 'end' => $end,
- 'allDay' => false,
- 'title' => $title,
- 'j' => $j,
- 'd' => $day,
- 'edit' => $edit,
- 'drop' => $drop,
- 'copy' => $copy,
- 'is_first' => $is_first,
- 'item' => $event,
- 'html' => $html,
- 'plink' => Item::getPlink($event),
- ];
+ $title = BBCode::convertForUriId($event['uri-id'], Strings::escapeHtml($event['summary']));
+ if (!$title) {
+ [$title, $_trash] = explode("<br", BBCode::convertForUriId($event['uri-id'], Strings::escapeHtml($event['desc'])), BBCode::TWITTER_API);
}
- return $event_list;
+ $author_link = $event['author-link'];
+
+ $event['author-link'] = Contact::magicLink($author_link);
+
+ $html = self::getHTML($event);
+ $event['summary'] = BBCode::convertForUriId($event['uri-id'], Strings::escapeHtml($event['summary']));
+ $event['desc'] = BBCode::convertForUriId($event['uri-id'], Strings::escapeHtml($event['desc']));
+ $event['location'] = BBCode::convertForUriId($event['uri-id'], Strings::escapeHtml($event['location']));
+
+ return [
+ 'id' => $event['id'],
+ 'start' => $start,
+ 'end' => $end,
+ 'allDay' => false,
+ 'title' => $title,
+ 'j' => $j,
+ 'd' => $day,
+ 'edit' => $edit,
+ 'drop' => $drop,
+ 'copy' => $copy,
+ 'item' => $event,
+ 'html' => $html,
+ 'plink' => Item::getPlink($event),
+ ];
}
/**
* @param array $events Query result for events.
* @param string $format The output format (ical/csv).
*
- * @param $timezone
+ * @param string $timezone Timezone (missing parameter!)
* @return string Content according to selected export format.
*
* @todo Implement timezone support
*/
- private static function formatListForExport(array $events, $format)
+ private static function formatListForExport(array $events, string $format): string
{
$o = '';
switch ($format) {
// Format the exported data as a CSV file.
case "csv":
- header("Content-type: text/csv");
$o .= '"Subject", "Start Date", "Start Time", "Description", "End Date", "End Time", "Location"' . PHP_EOL;
foreach ($events as $event) {
// Format the exported data as a ics file.
case "ical":
- header("Content-type: text/ics");
$o = 'BEGIN:VCALENDAR' . PHP_EOL
. 'VERSION:2.0' . PHP_EOL
. 'PRODID:-//friendica calendar export//0.1//EN' . PHP_EOL;
// also long lines SHOULD be split at 75 characters length
foreach ($events as $event) {
$o .= 'BEGIN:VEVENT' . PHP_EOL;
+ $o .= 'UID:' . $event['id'] . PHP_EOL;
+ $o .= 'DTSTAMP:' . DateTimeFormat::utc($event['created'], 'Ymd\THis\Z') . PHP_EOL;
if ($event['start']) {
$o .= 'DTSTART:' . DateTimeFormat::utc($event['start'], 'Ymd\THis\Z') . PHP_EOL;
}
$o .= 'END:VEVENT' . PHP_EOL;
- $o .= PHP_EOL;
}
$o .= 'END:VCALENDAR' . PHP_EOL;
* @return array Query results.
* @throws \Exception
*/
- private static function getListByUserId($uid = 0)
+ private static function getListByUserId(int $uid = 0): array
{
$return = [];
return $return;
}
- $fields = ['start', 'finish', 'summary', 'desc', 'location', 'nofinish'];
+ $fields = ['id', 'created', 'start', 'finish', 'summary', 'desc', 'location', 'nofinish'];
$conditions = ['uid' => $uid, 'cid' => 0];
// Does the user who requests happen to be the owner of the events
// requested? then show all of your events, otherwise only those that
// don't have limitations set in allow_cid and allow_gid.
- if (local_user() != $uid) {
+ if (DI::userSession()->getLocalUserId() != $uid) {
$conditions += ['allow_cid' => '', 'allow_gid' => ''];
}
* @throws \Exception
* @todo Respect authenticated users with events_by_uid().
*/
- public static function exportListByUserId($uid, $format = 'ical')
+ public static function exportListByUserId(int $uid, string $format = 'ical'): array
{
$process = false;
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
* @throws \ImagickException
*/
- public static function getItemHTML(array $item) {
+ public static function getItemHTML(array $item): string
+ {
$same_date = false;
$finish = false;
* @return array The array with the location data.
* 'name' => The name of the location,<br>
* 'address' => The address of the location,<br>
- * 'coordinates' => Latitude and longitude (e.g. '48.864716,2.349014').<br>
+ * 'coordinates' => Latitude and longitude (e.g. '48.864716,2.349014').<br>
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
- private static function locationToArray($s = '') {
+ private static function locationToArray(string $s = ''): array
+ {
if ($s == '') {
return [];
}
* @return bool
* @throws \Exception
*/
- public static function createBirthday($contact, $birthday)
+ public static function createBirthday(array $contact, string $birthday): bool
{
// Check for duplicates
$condition = [
'type' => 'birthday',
];
- self::store($values);
+ // Check if self::store() was success
+ return (self::store($values) > 0);
+ }
- return true;
+ public static function setIgnore(int $uid, int $eventId, bool $ignore = true)
+ {
+ DBA::update('event', ['ignore' => $ignore], ['id' => $eventId, 'uid' => $uid]);
}
}
projects / friendica.git / blobdiff