clones/friendica
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #11763 from tobiasd/marcor-newapi 

new event APIs
This commit is contained in:
Michael Vogel 2022-09-24 21:18:20 +02:00 committed by GitHub
parent 5a236e0af2 946db2ab45
commit 08ead52433
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 226 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/API-Entities.md
View File

@ -410,13 +410,13 @@ Ex: Wed May 23 06:01:13 +0000 2007
</tr>
<tr>
<td><code>startTime</code></td>
<td><code>start_time</code></td>
<td>String (UTC <code>YYYY-MM-DD HH:II:SS)</code>)</td>
<td></td>
</tr>
<tr>
<td><code>endTime</code></td>
<td><code>end_time</code></td>
<td>String (UTC <code>YYYY-MM-DD HH:II:SS)</code>)</td>
<td>Optional (null date is <code>0001-01-01 00:00:00</code></td>
</tr>

26
doc/API-Friendica.md
View File

@ -24,6 +24,32 @@ Returns a list of [Event](help/API-Entities#Event) entities for the current logg
- `since_id`: (optional) minimum event id for pagination
- `count`: maximum number of items returned, default 20
### POST api/friendica/event_create
Create a new event for the current logged in user.
#### Parameters
- `id` : (optional) id of event, event will be amended if supplied
- `name` : name of the event (required)
- `start_time` : start of the event (ISO), required
- `end_time` : (optional) end of the event, event is open end, if not supplied
- `desc` : (optional) description of the event
- `place` : (optional) location of the event
- `publish` : (optional) create message for event
- `allow_cid` : (optional) ACL-formatted list of allowed contact ids if private event
- `allow_gid` : (optional) ACL-formatted list of disallowed contact ids if private event
- `deny_cid` : (optional) ACL-formatted list of allowed group ids if private event
- `deny_gid` : (optional) ACL-formatted list of disallowed group ids if private event
### POST api/friendica/event_delete
Delete event from calendar (not the message)
#### Parameters
- `id` : id of event to be deleted
### GET api/externalprofile/show
Returns a [Contact](help/API-Entities#Contact) entity for the provided profile URL.

115
src/Module/Api/Friendica/Events/Create.php Normal file
View File

@ -0,0 +1,115 @@
<?php
/**
* @copyright Copyright (C) 2010-2022, the Friendica project
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
*/
namespace Friendica\Module\Api\Friendica\Events;
use Friendica\Core\Protocol;
use Friendica\Core\Worker;
use Friendica\Database\DBA;
use Friendica\DI;
use Friendica\Model\Event;
use Friendica\Model\Conversation;
use Friendica\Model\Item;
use Friendica\Module\BaseApi;
use Friendica\Network\HTTPException;
use Friendica\Util\DateTimeFormat;
use Friendica\Worker\Delivery;
/**
* API endpoint: /api/friendica/event_create
*/
class Create extends BaseApi
{
protected function post(array $request = [])
{
BaseApi::checkAllowedScope(BaseApi::SCOPE_WRITE);
$uid = BaseApi::getCurrentUserID();
// params
$request = $this->getRequest([
'id' => 0, //if provided, event will be amended
'name' => '', //summary of the event
'desc' => '', //description in BBCode
'start_time' => '', //start_time, required
'end_time' => '', //endtime, required if nofinish false
'place' => '', //location of the event
'publish' => 0, //publish message
'allow_cid' => '', //array of allowed person, if access restricted
'allow_gid' => '', //array of allowed groups, if access restricted
'deny_cid' => '', //array of denied person, if access restricted
'deny_gid' => '', //array of denied groups, if access restricted
], $request);
// error if no name specified
if (empty($request['name'])) {
throw new HTTPException\BadRequestException('event name not specified');
}
// error startDate is not specified
if (empty($request['start_time'])) {
throw new HTTPException\BadRequestException('startDate not specified');
}
// nofinish if end_time is not specified
if (empty($request['end_time'])) {
$finish = DBA::NULL_DATETIME;
$nofinish = true;
} else {
$finish = DateTimeFormat::convert($request['end_time'], 'UTC', DI::app()->getTimeZone());
$nofinish = false;
}
$start = DateTimeFormat::convert($request['start_time'], 'UTC', DI::app()->getTimeZone());
// create event
$event = [];
$event['id'] = $request['id'];
$event['uid'] = $uid;
$event['type'] = 'event';
$event['summary'] = $request['name'];
$event['desc'] = $request['desc'];
$event['location'] = $request['place'];
$event['start_time'] = $start;
$event['end_time'] = $finish;
$event['nofinish'] = $nofinish;
$event['allow_cid'] = $request['allow_cid'];
$event['allow_gid'] = $request['allow_gid'];
$event['deny_cid'] = $request['deny_cid'];
$event['deny_gid'] = $request['deny_gid'];
$event['publish'] = $request['publish'];
$event_id = Event::store($event);
if (!empty($request['publish'])) {
$item = ['network' => Protocol::DFRN, 'protocol' => Conversation::PARCEL_DIRECT, 'direction' => Conversation::PUSH];
$item = Event::getItemArrayForId($event_id, $item);
if (Item::insert($item)) {
Worker::add(PRIORITY_HIGH, "Notifier", Delivery::POST, (int)$item['uri-id'], $uid);
}
}
$result = ['success' => true, 'event_id' => $event_id, 'event' => $event];
$this->response->exit('event_create', ['$result' => $result], $this->parameters['extension'] ?? null);
}
}

64
src/Module/Api/Friendica/Events/Delete.php Normal file
View File

@ -0,0 +1,64 @@
<?php
/**
* @copyright Copyright (C) 2010-2022, the Friendica project
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
*/
namespace Friendica\Module\Api\Friendica\Events;
use Friendica\Database\DBA;
use Friendica\Model\Event;
use Friendica\Module\BaseApi;
use Friendica\Network\HTTPException;
/**
* API endpoint: /api/friendica/event_delete
*/
class Delete extends BaseApi
{
protected function post(array $request = [])
{
self::checkAllowedScope(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
$request = $this->getRequest([
'id' => 0
], $request);
// params
// error if no id specified
if ($request['id'] == 0) {
throw new HTTPException\BadRequestException('id not specified');
}
// error message if specified id is not in database
if (!DBA::exists('event', ['uid' => $uid, 'id' => $request['id']])) {
throw new HTTPException\BadRequestException('id not available');
}
// delete event
$eventid = $request['id'];
Event::delete($eventid);
$success = ['id' => $eventid, 'status' => 'deleted'];
$this->response->exit('event_delete', ['$result' => $success], $this->parameters['extension'] ?? null);
}
}

34
src/Module/Api/Friendica/Events/Index.php
View File

@ -49,23 +49,23 @@ class Index extends BaseApi
$items = [];
foreach ($events as $event) {
$items[] = [
'id' => intval($event['id']),
'uid' => intval($event['uid']),
'cid' => $event['cid'],
'uri' => $event['uri'],
'name' => $event['summary'],
'desc' => BBCode::convertForUriId($event['uri-id'], $event['desc']),
'startTime' => $event['start'],
'endTime' => $event['finish'],
'type' => $event['type'],
'nofinish' => $event['nofinish'],
'place' => $event['location'],
'adjust' => 1,
'ignore' => $event['ignore'],
'allow_cid' => $event['allow_cid'],
'allow_gid' => $event['allow_gid'],
'deny_cid' => $event['deny_cid'],
'deny_gid' => $event['deny_gid']
'id' => intval($event['id']),
'uid' => intval($event['uid']),
'cid' => $event['cid'],
'uri' => $event['uri'],
'name' => $event['summary'],
'desc' => BBCode::convertForUriId($event['uri-id'], $event['desc']),
'start_time' => $event['start'],
'end_time' => $event['finish'],
'type' => $event['type'],
'nofinish' => $event['nofinish'],
'place' => $event['location'],
'adjust' => 1,
'ignore' => $event['ignore'],
'allow_cid' => $event['allow_cid'],
'allow_gid' => $event['allow_gid'],
'deny_cid' => $event['deny_cid'],
'deny_gid' => $event['deny_gid']
];
}

2
static/routes.config.php
View File

@ -82,6 +82,8 @@ $apiRoutes = [
'/direct_messages_setseen[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\DirectMessages\Setseen::class, [ R::POST]],
'/direct_messages_search[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\DirectMessages\Search ::class, [R::GET ]],
'/events[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Events\Index::class, [R::GET ]],
'/event_create[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Events\Create::class, [ R::POST]],
'/event_delete[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Events\Delete::class, [ R::POST]],
'/group_show[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Group\Show::class, [R::GET ]],
'/group_create[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Group\Create::class, [ R::POST]],
'/group_delete[.{extension:json|xml|rss|atom}]' => [Module\Api\Friendica\Group\Delete::class, [ R::POST]],