friendica
/
friendica
mirror of https://git.friendi.ca/friendica/friendica.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Merge pull request #10252 from annando/api-status 

API: We now can post statuses via API
pull/10253/head
Hypolite Petovan 2021-05-16 04:35:36 -04:00 committed by GitHub
parent d9bfd78bd4 3dcd91cddd
commit 69824b73c9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
57 changed files with 369 additions and 79 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
database.sql
View File

@ -1,6 +1,6 @@
-- ------------------------------------------
-- Friendica 2021.06-dev (Siberian Iris)
-- DB_UPDATE_VERSION 1417
-- DB_UPDATE_VERSION 1418
-- ------------------------------------------
@ -378,6 +378,7 @@ CREATE TABLE IF NOT EXISTS `application` (
`read` boolean COMMENT 'Read scope',
`write` boolean COMMENT 'Write scope',
`follow` boolean COMMENT 'Follow scope',
`push` boolean COMMENT 'Push scope',
PRIMARY KEY(`id`),
UNIQUE INDEX `client_id` (`client_id`)
) DEFAULT COLLATE utf8mb4_general_ci COMMENT='OAuth application';
@ -395,6 +396,7 @@ CREATE TABLE IF NOT EXISTS `application-token` (
`read` boolean COMMENT 'Read scope',
`write` boolean COMMENT 'Write scope',
`follow` boolean COMMENT 'Follow scope',
`push` boolean COMMENT 'Push scope',
PRIMARY KEY(`application-id`,`uid`),
INDEX `uid_id` (`uid`,`application-id`),
FOREIGN KEY (`application-id`) REFERENCES `application` (`id`) ON UPDATE RESTRICT ON DELETE CASCADE,
@ -1525,7 +1527,8 @@ CREATE VIEW `application-view` AS SELECT
`application-token`.`scopes` AS `scopes`,
`application-token`.`read` AS `read`,
`application-token`.`write` AS `write`,
`application-token`.`follow` AS `follow`
`application-token`.`follow` AS `follow`,
`application-token`.`push` AS `push`
FROM `application-token`
INNER JOIN `application` ON `application-token`.`application-id` = `application`.`id`;

2
doc/API-Mastodon.md
View File

@ -85,6 +85,7 @@ These endpoints use the [Mastodon API entities](https://docs.joinmastodon.org/en
- [`POST /api/v1/notifications/clear`](https://docs.joinmastodon.org/methods/notifications/)
- [`POST /api/v1/notifications/:id/dismiss`](https://docs.joinmastodon.org/methods/notifications/)
- [`GET /api/v1/preferences`](https://docs.joinmastodon.org/methods/accounts/preferences/)
- [`POST /api/v1/statuses`](https://docs.joinmastodon.org/methods/statuses/)
- [`GET /api/v1/statuses/:id`](https://docs.joinmastodon.org/methods/statuses/)
- [`DELETE /api/v1/statuses/:id`](https://docs.joinmastodon.org/methods/statuses/)
- [`GET /api/v1/statuses/:id/context`](https://docs.joinmastodon.org/methods/statuses/)
@ -120,7 +121,6 @@ These emdpoints are planned to be implemented
- [`GET /api/v1/instance/activity`](https://docs.joinmastodon.org/methods/instance#weekly-activity)
- [`POST /api/v1/media`](https://docs.joinmastodon.org/methods/statuses/media/)
- [`PUT /api/v1/media/:id`](https://docs.joinmastodon.org/methods/statuses/media/)
- [`POST /api/v1/statuses`](https://docs.joinmastodon.org/methods/statuses/)
- [`GET /api/v1/timelines/direct`](https://docs.joinmastodon.org/methods/timelines/)
## Non supportable endpoints

26
src/Content/Text/BBCode.php
View File

@ -2115,6 +2115,32 @@ class BBCode
return array_unique($ret);
}
/**
* Expand tags to URLs
*
* @param string $body
* @return string body with expanded tags
*/
public static function expandTags(string $body)
{
return preg_replace_callback("/([!#@])([^\^ \x0D\x0A,;:?\']*[^\^ \x0D\x0A,;:?!\'.])/",
function ($match) {
switch ($match[1]) {
case '!':
case '@':
$contact = Contact::getByURL($match[2]);
if (!empty($contact)) {
return $match[1] . '[url=' . $contact['url'] . ']' . $contact['name'] . '[/url]';
} else {
return $match[1] . $match[2];
}
break;
case '#':
return $match[1] . '[url=' . 'https://' . DI::baseUrl() . '/search?tag=' . $match[2] . ']' . $match[2] . '[/url]';
}
}, $body);
}
/**
* Perform a custom function on a text after having escaped blocks enclosed in the provided tag list.
*

9
src/Factory/Api/Mastodon/Error.php
View File

@ -54,6 +54,15 @@ class Error extends BaseFactory
System::jsonError(401, $errorobj->toArray());
}
public function Forbidden(string $error = '')
{
$error = $error ?: DI::l10n()->t('Token is not authorized with a valid user or is missing a required scope');
$error_description = '';
$errorobj = New \Friendica\Object\Api\Mastodon\Error($error, $error_description);
System::jsonError(403, $errorobj->toArray());
}
public function InternalError(string $error = '')
{
$error = $error ?: DI::l10n()->t('Internal Server Error');

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

@ -35,7 +35,7 @@ class Index extends BaseApi
{
public static function rawContent(array $parameters = [])
{
if (self::login() === false) {
if (self::login(self::SCOPE_READ) === false) {
throw new HTTPException\ForbiddenException();
}

2
src/Module/Api/Friendica/Profile/Show.php
View File

@ -37,7 +37,7 @@ class Show extends BaseApi
{
public static function rawContent(array $parameters = [])
{
if (self::login() === false) {
if (self::login(self::SCOPE_READ) === false) {
throw new HTTPException\ForbiddenException();
}

2
src/Module/Api/Mastodon/Accounts/Block.php
View File

@ -33,7 +33,7 @@ class Block extends BaseApi
{
public static function post(array $parameters = [])
{
self::login();
self::login(self::SCOPE_FOLLOW);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {

4
src/Module/Api/Mastodon/Accounts/Follow.php
View File

@ -33,7 +33,7 @@ class Follow extends BaseApi
{
public static function post(array $parameters = [])
{
self::login();
self::login(self::SCOPE_FOLLOW);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {
@ -42,6 +42,6 @@ class Follow extends BaseApi
$cid = Contact::follow($parameters['id'], self::getCurrentUserID());
System::jsonExit(DI::mstdnRelationship()->createFromContactId($cid)->toArray());
System::jsonExit(DI::mstdnRelationship()->createFromContactId($cid, $uid)->toArray());
}
}

2
src/Module/Api/Mastodon/Accounts/Followers.php
View File

@ -37,7 +37,7 @@ class Followers extends BaseApi
*/
public static function rawContent(array $parameters = [])
{
self::login();
self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {

2
src/Module/Api/Mastodon/Accounts/Following.php
View File

@ -37,7 +37,7 @@ class Following extends BaseApi
*/
public static function rawContent(array $parameters = [])
{
self::login();
self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {

2
src/Module/Api/Mastodon/Accounts/IdentityProofs.php
View File

@ -35,7 +35,7 @@ class IdentityProofs extends BaseApi
*/
public static function rawContent(array $parameters = [])
{
self::login();
self::login(self::SCOPE_READ);
System::jsonExit([]);
}

2
src/Module/Api/Mastodon/Accounts/Lists.php
View File

@ -38,7 +38,7 @@ class Lists extends BaseApi
*/
public static function rawContent(array $parameters = [])
{
self::login();
self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {

2
src/Module/Api/Mastodon/Accounts/Mute.php
View File

@ -33,7 +33,7 @@ class Mute extends BaseApi
{
public static function post(array $parameters = [])
{
self::login();
self::login(self::SCOPE_FOLLOW);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {

2
src/Module/Api/Mastodon/Accounts/Note.php
View File

@ -34,7 +34,7 @@ class Note extends BaseApi
{
public static function post(array $parameters = [])
{
self::login();
self::login(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {

2
src/Module/Api/Mastodon/Accounts/Relationships.php
View File

@ -37,7 +37,7 @@ class Relationships extends BaseApi
*/
public static function rawContent(array $parameters = [])
{
self::login();
self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
if (empty($_REQUEST['id']) || !is_array($_REQUEST['id'])) {

2
src/Module/Api/Mastodon/Accounts/Search.php
View File

@ -40,7 +40,7 @@ class Search extends BaseApi
*/
public static function rawContent(array $parameters = [])
{
self::login();
self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
// What to search for

2
src/Module/Api/Mastodon/Accounts/Unblock.php
View File

@ -33,7 +33,7 @@ class Unblock extends BaseApi
{
public static function post(array $parameters = [])
{
self::login();
self::login(self::SCOPE_FOLLOW);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {

2
src/Module/Api/Mastodon/Accounts/Unfollow.php
View File

@ -33,7 +33,7 @@ class Unfollow extends BaseApi
{
public static function post(array $parameters = [])
{
self::login();
self::login(self::SCOPE_FOLLOW);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {

2
src/Module/Api/Mastodon/Accounts/Unmute.php
View File

@ -33,7 +33,7 @@ class Unmute extends BaseApi
{
public static function post(array $parameters = [])
{
self::login();
self::login(self::SCOPE_FOLLOW);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {

2
src/Module/Api/Mastodon/Accounts/UpdateCredentials.php
View File

@ -31,7 +31,7 @@ class UpdateCredentials extends BaseApi
{
public static function patch(array $parameters = [])
{
self::login();
self::login(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
$data = Network::postdata();

2
src/Module/Api/Mastodon/Accounts/VerifyCredentials.php
View File

@ -38,7 +38,7 @@ class VerifyCredentials extends BaseApi
*/
public static function rawContent(array $parameters = [])
{
self::login();
self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
$self = User::getOwnerDataById($uid);

2
src/Module/Api/Mastodon/Announcements.php
View File

@ -35,7 +35,7 @@ class Announcements extends BaseApi
*/
public static function rawContent(array $parameters = [])
{
self::login();
self::login(self::SCOPE_READ);
// @todo Possibly use the message from the pageheader addon for this
System::jsonExit([]);

7
src/Module/Api/Mastodon/Apps.php
View File

@ -67,9 +67,10 @@ class Apps extends BaseApi
$fields['scopes'] = $scopes;
}
$fields['read'] = (stripos($scopes, 'read') !== false);
$fields['write'] = (stripos($scopes, 'write') !== false);
$fields['follow'] = (stripos($scopes, 'follow') !== false);
$fields['read'] = (stripos($scopes, self::SCOPE_READ) !== false);
$fields['write'] = (stripos($scopes, self::SCOPE_WRITE) !== false);
$fields['follow'] = (stripos($scopes, self::SCOPE_FOLLOW) !== false);
$fields['push'] = (stripos($scopes, self::SCOPE_PUSH) !== false);
if (!empty($website)) {
$fields['website'] = $website;

2
src/Module/Api/Mastodon/Blocks.php
View File

@ -37,7 +37,7 @@ class Blocks extends BaseApi
*/
public static function rawContent(array $parameters = [])
{
self::login();
self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {

2
src/Module/Api/Mastodon/Bookmarks.php
View File

@ -39,7 +39,7 @@ class Bookmarks extends BaseApi
*/
public static function rawContent(array $parameters = [])
{
self::login();
self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
// Maximum number of results to return. Defaults to 20.

2
src/Module/Api/Mastodon/Favourited.php
View File

@ -40,7 +40,7 @@ class Favourited extends BaseApi
*/
public static function rawContent(array $parameters = [])
{
self::login();
self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
// Maximum number of results to return. Defaults to 20.

40
src/Module/Api/Mastodon/Filters.php Normal file
View File

@ -0,0 +1,40 @@
<?php
/**
* @copyright Copyright (C) 2010-2021, 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\Mastodon;
use Friendica\Core\System;
use Friendica\Module\BaseApi;
/**
* @see https://docs.joinmastodon.org/methods/accounts/filters/
*/
class Filters extends BaseApi
{
/**
* @param array $parameters
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
public static function rawContent(array $parameters = [])
{
System::jsonError(404, ['error' => 'Record not found']);
}
}

4
src/Module/Api/Mastodon/FollowRequests.php
View File

@ -45,7 +45,7 @@ class FollowRequests extends BaseApi
*/
public static function post(array $parameters = [])
{
self::login();
self::login(self::SCOPE_FOLLOW);
$uid = self::getCurrentUserID();
$introduction = DI::intro()->selectFirst(['id' => $parameters['id'], 'uid' => $uid]);
@ -83,7 +83,7 @@ class FollowRequests extends BaseApi
*/
public static function rawContent(array $parameters = [])
{
self::login();
self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
$min_id = $_GET['min_id'] ?? null;

6
src/Module/Api/Mastodon/Lists.php
View File

@ -33,7 +33,7 @@ class Lists extends BaseApi
{
public static function delete(array $parameters = [])
{
self::login();
self::login(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
@ -54,7 +54,7 @@ class Lists extends BaseApi
public static function post(array $parameters = [])
{
self::login();
self::login(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
$title = $_REQUEST['title'] ?? '';
@ -90,7 +90,7 @@ class Lists extends BaseApi
*/
public static function rawContent(array $parameters = [])
{
self::login();
self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {

2
src/Module/Api/Mastodon/Lists/Accounts.php
View File

@ -49,7 +49,7 @@ class Accounts extends BaseApi
*/
public static function rawContent(array $parameters = [])
{
self::login();
self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {

4
src/Module/Api/Mastodon/Markers.php
View File

@ -31,6 +31,8 @@ class Markers extends BaseApi
{
public static function post(array $parameters = [])
{
self::login(self::SCOPE_WRITE);
self::unsupported('post');
}
@ -40,7 +42,7 @@ class Markers extends BaseApi
*/
public static function rawContent(array $parameters = [])
{
self::login();
self::login(self::SCOPE_READ);
System::jsonExit([]);
}

5
src/Module/Api/Mastodon/Media.php
View File

@ -33,6 +33,9 @@ class Media extends BaseApi
{
public static function put(array $parameters = [])
{
self::login(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
$data = self::getPutData();
self::unsupported('put');
}
@ -43,7 +46,7 @@ class Media extends BaseApi
*/
public static function rawContent(array $parameters = [])
{
self::login();
self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {

2
src/Module/Api/Mastodon/Mutes.php
View File

@ -37,7 +37,7 @@ class Mutes extends BaseApi
*/
public static function rawContent(array $parameters = [])
{
self::login();
self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {

2
src/Module/Api/Mastodon/Notifications.php
View File

@ -39,7 +39,7 @@ class Notifications extends BaseApi
*/
public static function rawContent(array $parameters = [])
{
self::login();
self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
if (!empty($parameters['id'])) {

2
src/Module/Api/Mastodon/Notifications/Clear.php
View File

@ -32,7 +32,7 @@ class Clear extends BaseApi
{
public static function post(array $parameters = [])
{
self::login();
self::login(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
DBA::update('notify', ['seen' => true], ['uid' => $uid]);

2
src/Module/Api/Mastodon/Notifications/Dismiss.php
View File

@ -33,7 +33,7 @@ class Dismiss extends BaseApi
{
public static function post(array $parameters = [])
{
self::login();
self::login(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {

2
src/Module/Api/Mastodon/Preferences.php
View File

@ -37,7 +37,7 @@ class Preferences extends BaseApi
*/
public static function rawContent(array $parameters = [])
{
self::login();
self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
$user = User::getById($uid, ['language', 'allow_cid', 'allow_gid', 'deny_cid', 'deny_gid']);

155
src/Module/Api/Mastodon/Statuses.php
View File

@ -21,12 +21,19 @@
namespace Friendica\Module\Api\Mastodon;
use Friendica\Core\Logger;
use Friendica\Content\Text\BBCode;
use Friendica\Content\Text\Markdown;
use Friendica\Core\System;
use Friendica\Database\DBA;
use Friendica\DI;
use Friendica\Model\Contact;
use Friendica\Model\Group;
use Friendica\Model\Item;
use Friendica\Model\Post;
use Friendica\Model\User;
use Friendica\Module\BaseApi;
use Friendica\Protocol\Activity;
use Friendica\Util\Images;
/**
* @see https://docs.joinmastodon.org/methods/statuses/
@ -35,13 +42,155 @@ class Statuses extends BaseApi
{
public static function post(array $parameters = [])
{
self::login(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
$data = self::getJsonPostData();
self::unsupported('post');
$status = $data['status'] ?? '';
$media_ids = $data['media_ids'] ?? [];
$in_reply_to_id = $data['in_reply_to_id'] ?? 0;
$sensitive = $data['sensitive'] ?? false; // @todo Possibly trigger "nsfw" flag?
$spoiler_text = $data['spoiler_text'] ?? '';
$visibility = $data['visibility'] ?? '';
$scheduled_at = $data['scheduled_at'] ?? ''; // Currently unsupported, but maybe in the future
$language = $data['language'] ?? '';
$owner = User::getOwnerDataById($uid);
// The imput is defined as text. So we can use Markdown for some enhancements
$body = Markdown::toBBCode($status);
$body = BBCode::expandTags($body);
$item = [];
$item['uid'] = $uid;
$item['verb'] = Activity::POST;
$item['contact-id'] = $owner['id'];
$item['author-id'] = $item['owner-id'] = Contact::getPublicIdByUserId($uid);
$item['title'] = $spoiler_text;
$item['body'] = $body;
if (!empty(self::getCurrentApplication()['name'])) {
$item['app'] = self::getCurrentApplication()['name'];
}
if (empty($item['app'])) {
$item['app'] = 'API';
}
switch ($visibility) {
case 'public':
$item['allow_cid'] = '';
$item['allow_gid'] = '';
$item['deny_cid'] = '';
$item['deny_gid'] = '';
$item['private'] = Item::PUBLIC;
break;
case 'unlisted':
$item['allow_cid'] = '';
$item['allow_gid'] = '';
$item['deny_cid'] = '';
$item['deny_gid'] = '';
$item['private'] = Item::UNLISTED;
break;
case 'private':
if (!empty($owner['allow_cid'] . $owner['allow_gid'] . $owner['deny_cid'] . $owner['deny_gid'])) {
$item['allow_cid'] = $owner['allow_cid'];
$item['allow_gid'] = $owner['allow_gid'];
$item['deny_cid'] = $owner['deny_cid'];
$item['deny_gid'] = $owner['deny_gid'];
} else {
$item['allow_cid'] = '';
$item['allow_gid'] = [Group::FOLLOWERS];
$item['deny_cid'] = '';
$item['deny_gid'] = '';
}
$item['private'] = Item::PRIVATE;
break;
case 'direct':
// Direct messages are currently unsupported
DI::mstdnError()->InternalError('Direct messages are currently unsupported');
break;
default:
$item['allow_cid'] = $owner['allow_cid'];
$item['allow_gid'] = $owner['allow_gid'];
$item['deny_cid'] = $owner['deny_cid'];
$item['deny_gid'] = $owner['deny_gid'];
if (!empty($item['allow_cid'] . $item['allow_gid'] . $item['deny_cid'] . $item['deny_gid'])) {
$item['private'] = Item::PRIVATE;
} elseif (DI::pConfig()->get($uid, 'system', 'unlisted')) {
$item['private'] = Item::UNLISTED;
} else {
$item['private'] = Item::PUBLIC;
}
break;
}
if (!empty($language)) {
$item['language'] = json_encode([$language => 1]);
}
if ($in_reply_to_id) {
$parent = Post::selectFirst(['uri'], ['uri-id' => $in_reply_to_id, 'uid' => [0, $uid]]);
$item['thr-parent'] = $parent['uri'];
$item['gravity'] = GRAVITY_COMMENT;
$item['object-type'] = Activity\ObjectType::COMMENT;
} else {
$item['gravity'] = GRAVITY_PARENT;
$item['object-type'] = Activity\ObjectType::NOTE;
}
if (!empty($media_ids)) {
$item['object-type'] = Activity\ObjectType::IMAGE;
$item['post-type'] = Item::PT_IMAGE;
$item['attachments'] = [];
foreach ($media_ids as $id) {
$media = DBA::toArray(DBA::p("SELECT `resource-id`, `scale`, `type`, `desc`, `filename`, `datasize`, `width`, `height` FROM `photo`
WHERE `resource-id` IN (SELECT `resource-id` FROM `photo` WHERE `id` = ?) AND `photo`.`uid` = ?
ORDER BY `photo`.`width` DESC LIMIT 2", $id, $uid));
if (empty($media)) {
continue;
}
$ressources[] = $media[0]['resource-id'];
$phototypes = Images::supportedTypes();
$ext = $phototypes[$media[0]['type']];
$attachment = ['type' => Post\Media::IMAGE, 'mimetype' => $media[0]['type'],
'url' => DI::baseUrl() . '/photo/' . $media[0]['resource-id'] . '-' . $media[0]['scale'] . '.' . $ext,
'size' => $media[0]['datasize'],
'name' => $media[0]['filename'] ?: $media[0]['resource-id'],
'description' => $media[0]['desc'] ?? '',
'width' => $media[0]['width'],
'height' => $media[0]['height']];
if (count($media) > 1) {
$attachment['preview'] = DI::baseUrl() . '/photo/' . $media[1]['resource-id'] . '-' . $media[1]['scale'] . '.' . $ext;
$attachment['preview-width'] = $media[1]['width'];
$attachment['preview-height'] = $media[1]['height'];
}
$item['attachments'][] = $attachment;
}
}
$id = Item::insert($item, true);
if (!empty($id)) {
$item = Post::selectFirst(['uri-id'], ['id' => $id]);
if (!empty($item['uri-id'])) {
System::jsonExit(DI::mstdnStatus()->createFromUriId($item['uri-id'], $uid));
}
}
DI::mstdnError()->InternalError();
}
public static function delete(array $parameters = [])
{
self::login();
self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {

2
src/Module/Api/Mastodon/Statuses/Bookmark.php
View File

@ -35,7 +35,7 @@ class Bookmark extends BaseApi
{
public static function post(array $parameters = [])
{
self::login();
self::login(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {

2
src/Module/Api/Mastodon/Statuses/Favourite.php
View File

@ -35,7 +35,7 @@ class Favourite extends BaseApi
{
public static function post(array $parameters = [])
{
self::login();
self::login(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {

2
src/Module/Api/Mastodon/Statuses/Mute.php
View File

@ -34,7 +34,7 @@ class Mute extends BaseApi
{
public static function post(array $parameters = [])
{
self::login();
self::login(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {

2
src/Module/Api/Mastodon/Statuses/Pin.php
View File

@ -34,7 +34,7 @@ class Pin extends BaseApi
{
public static function post(array $parameters = [])
{
self::login();
self::login(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {

2
src/Module/Api/Mastodon/Statuses/Reblog.php
View File

@ -37,7 +37,7 @@ class Reblog extends BaseApi
{
public static function post(array $parameters = [])
{
self::login();
self::login(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {

2
src/Module/Api/Mastodon/Statuses/Unbookmark.php
View File

@ -35,7 +35,7 @@ class Unbookmark extends BaseApi
{
public static function post(array $parameters = [])
{
self::login();
self::login(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {

2
src/Module/Api/Mastodon/Statuses/Unfavourite.php
View File

@ -35,7 +35,7 @@ class Unfavourite extends BaseApi
{
public static function post(array $parameters = [])
{
self::login();
self::login(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {

2
src/Module/Api/Mastodon/Statuses/Unmute.php
View File

@ -34,7 +34,7 @@ class Unmute extends BaseApi
{
public static function post(array $parameters = [])
{
self::login();
self::login(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {

2
src/Module/Api/Mastodon/Statuses/Unpin.php
View File

@ -34,7 +34,7 @@ class Unpin extends BaseApi
{
public static function post(array $parameters = [])
{
self::login();
self::login(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {

2
src/Module/Api/Mastodon/Statuses/Unreblog.php
View File

@ -37,7 +37,7 @@ class Unreblog extends BaseApi
{
public static function post(array $parameters = [])
{
self::login();
self::login(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {

2
src/Module/Api/Mastodon/Suggestions.php
View File

@ -37,7 +37,7 @@ class Suggestions extends BaseApi
*/
public static function rawContent(array $parameters = [])
{
self::login();
self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
// Maximum number of results to return. Defaults to 40.

2
src/Module/Api/Mastodon/Timelines/Home.php
View File

@ -39,7 +39,7 @@ class Home extends BaseApi
*/
public static function rawContent(array $parameters = [])
{
self::login();
self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
// Return results older than id

2
src/Module/Api/Mastodon/Timelines/ListTimeline.php
View File

@ -39,7 +39,7 @@ class ListTimeline extends BaseApi
*/
public static function rawContent(array $parameters = [])
{
self::login();
self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
if (empty($parameters['id'])) {

2
src/Module/Api/Mastodon/Timelines/Tag.php
View File

@ -40,7 +40,7 @@ class Tag extends BaseApi
*/
public static function rawContent(array $parameters = [])
{
self::login();
self::login(self::SCOPE_READ);
$uid = self::getCurrentUserID();
if (empty($parameters['hashtag'])) {

2
src/Module/Api/Twitter/ContactEndpoint.php
View File

@ -39,7 +39,7 @@ abstract class ContactEndpoint extends BaseApi
{
parent::init($parameters);
if (!self::login()) {
if (!self::login(self::SCOPE_READ)) {
throw new HTTPException\UnauthorizedException();
}
}

73
src/Module/BaseApi.php
View File

@ -35,6 +35,11 @@ require_once __DIR__ . '/../../include/api.php';
class BaseApi extends BaseModule
{
const SCOPE_READ = 'read';
const SCOPE_WRITE = 'write';
const SCOPE_FOLLOW = 'follow';
const SCOPE_PUSH = 'push';
/**
* @var string json|xml|rss|atom
*/
@ -43,6 +48,10 @@ class BaseApi extends BaseModule
* @var bool|int
*/
protected static $current_user_id;
/**
* @var array
*/
protected static $current_token = [];
public static function init(array $parameters = [])
{
@ -171,6 +180,8 @@ class BaseApi extends BaseModule
*
* Simple Auth allow username in form of <pre>user@server</pre>, ignoring server part
*
* @param string $scope the requested scope (read, write, follow)
*
* @return bool Was a user authenticated?
* @throws HTTPException\ForbiddenException
* @throws HTTPException\UnauthorizedException
@ -182,10 +193,22 @@ class BaseApi extends BaseModule
* 'authenticated' => return status,
* 'user_record' => return authenticated user record
*/
protected static function login()
protected static function login(string $scope)
{
if (empty(self::$current_user_id)) {
self::$current_user_id = self::getUserByBearer();
self::$current_token = self::getTokenByBearer();
if (!empty(self::$current_token['uid'])) {
self::$current_user_id = self::$current_token['uid'];
} else {
self::$current_user_id = 0;
}
}
if (!empty($scope) && !empty(self::$current_token)) {
if (empty(self::$current_token[$scope])) {
Logger::warning('The requested scope is not allowed', ['scope' => $scope, 'application' => self::$current_token]);
DI::mstdnError()->Forbidden();
}
}
if (empty(self::$current_user_id)) {
@ -198,6 +221,16 @@ class BaseApi extends BaseModule
return (bool)self::$current_user_id;
}
/**
* Get current application
*
* @return array token
*/
protected static function getCurrentApplication()
{
return self::$current_token;
}
/**
* Get current user id, returns 0 if not logged in
*
@ -206,7 +239,13 @@ class BaseApi extends BaseModule
protected static function getCurrentUserID()
{
if (empty(self::$current_user_id)) {
self::$current_user_id = self::getUserByBearer();
self::$current_token = self::getTokenByBearer();
if (!empty(self::$current_token['uid'])) {
self::$current_user_id = self::$current_token['uid'];
} else {
self::$current_user_id = 0;
}
}
if (empty(self::$current_user_id)) {
@ -220,27 +259,27 @@ class BaseApi extends BaseModule
}
/**
* Get the user id via the Bearer token
* Get the user token via the Bearer token
*
* @return int User-ID
* @return array User Token
*/
private static function getUserByBearer()
private static function getTokenByBearer()
{
$authorization = $_SERVER['HTTP_AUTHORIZATION'] ?? '';
if (substr($authorization, 0, 7) != 'Bearer ') {
return 0;
return [];
}
$bearer = trim(substr($authorization, 7));
$condition = ['access_token' => $bearer];
$token = DBA::selectFirst('application-token', ['uid'], $condition);
$token = DBA::selectFirst('application-view', ['uid', 'id', 'name', 'website', 'created_at', 'read', 'write', 'follow', 'push'], $condition);
if (!DBA::isResult($token)) {
Logger::warning('Token not found', $condition);
return 0;
return [];
}
Logger::info('Token found', $token);
return $token['uid'];
return $token;
}
/**
@ -307,8 +346,18 @@ class BaseApi extends BaseModule
$access_token = bin2hex(random_bytes(32));
$fields = ['application-id' => $application['id'], 'uid' => $uid, 'code' => $code, 'access_token' => $access_token, 'scopes' => $scope,
'read' => (stripos($scope, 'read') !== false), 'write' => (stripos($scope, 'write') !== false),
'follow' => (stripos($scope, 'follow') !== false), 'created_at' => DateTimeFormat::utcNow(DateTimeFormat::MYSQL)];
'read' => (stripos($scope, self::SCOPE_READ) !== false),
'write' => (stripos($scope, self::SCOPE_WRITE) !== false),
'follow' => (stripos($scope, self::SCOPE_FOLLOW) !== false),
'push' => (stripos($scope, self::SCOPE_PUSH) !== false),
'created_at' => DateTimeFormat::utcNow(DateTimeFormat::MYSQL)];
foreach ([self::SCOPE_READ, self::SCOPE_WRITE, self::SCOPE_WRITE, self::SCOPE_PUSH] as $scope) {
if ($fields[$scope] && !$application[$scope]) {
Logger::warning('Requested token scope is not allowed for the application', ['token' => $fields, 'application' => $application]);
}
}
if (!DBA::insert('application-token', $fields, Database::INSERT_UPDATE)) {
return [];
}

4
static/dbstructure.config.php
View File

@ -55,7 +55,7 @@
use Friendica\Database\DBA;
if (!defined('DB_UPDATE_VERSION')) {
define('DB_UPDATE_VERSION', 1417);
define('DB_UPDATE_VERSION', 1418);
}
return [
@ -439,6 +439,7 @@ return [
"read" => ["type" => "boolean", "comment" => "Read scope"],
"write" => ["type" => "boolean", "comment" => "Write scope"],
"follow" => ["type" => "boolean", "comment" => "Follow scope"],
"push" => ["type" => "boolean", "comment" => "Push scope"],
],
"indexes" => [
"PRIMARY" => ["id"],
@ -457,6 +458,7 @@ return [
"read" => ["type" => "boolean", "comment" => "Read scope"],
"write" => ["type" => "boolean", "comment" => "Write scope"],
"follow" => ["type" => "boolean", "comment" => "Follow scope"],
"push" => ["type" => "boolean", "comment" => "Push scope"],
],
"indexes" => [
"PRIMARY" => ["application-id", "uid"],

1
static/dbview.config.php
View File

@ -53,6 +53,7 @@
"read" => ["application-token", "read"],
"write" => ["application-token", "write"],
"follow" => ["application-token", "follow"],
"push" => ["application-token", "push"],
],
"query" => "FROM `application-token`
INNER JOIN `application` ON `application-token`.`application-id` = `application`.`id`"

19
view/lang/C/messages.po
View File

@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: 2021.06-dev\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2021-05-15 10:54+0000\n"
"POT-Creation-Date: 2021-05-16 07:41+0000\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
@ -833,10 +833,10 @@ msgstr ""
#: mod/unfollow.php:82 mod/wall_attach.php:78 mod/wall_attach.php:81
#: mod/wall_upload.php:99 mod/wall_upload.php:102 mod/wallmessage.php:35
#: mod/wallmessage.php:59 mod/wallmessage.php:96 mod/wallmessage.php:120
#: src/Module/Attach.php:56 src/Module/BaseApi.php:65 src/Module/BaseApi.php:71
#: src/Module/BaseApi.php:78 src/Module/BaseApi.php:84
#: src/Module/BaseApi.php:91 src/Module/BaseApi.php:97
#: src/Module/BaseApi.php:104 src/Module/BaseApi.php:110
#: src/Module/Attach.php:56 src/Module/BaseApi.php:74 src/Module/BaseApi.php:80
#: src/Module/BaseApi.php:87 src/Module/BaseApi.php:93
#: src/Module/BaseApi.php:100 src/Module/BaseApi.php:106
#: src/Module/BaseApi.php:113 src/Module/BaseApi.php:119
#: src/Module/BaseNotifications.php:88 src/Module/Contact.php:385
#: src/Module/Contact/Advanced.php:43 src/Module/Delegation.php:118
#: src/Module/FollowConfirm.php:16 src/Module/FriendSuggest.php:44
@ -4556,6 +4556,11 @@ msgid "Unauthorized"
msgstr ""
#: src/Factory/Api/Mastodon/Error.php:59
msgid ""
"Token is not authorized with a valid user or is missing a required scope"
msgstr ""
#: src/Factory/Api/Mastodon/Error.php:68
#: src/Module/Special/HTTPException.php:53
msgid "Internal Server Error"
msgstr ""
@ -7333,12 +7338,12 @@ msgstr ""
msgid "User registrations waiting for confirmation"
msgstr ""
#: src/Module/BaseApi.php:124
#: src/Module/BaseApi.php:133
#, php-format
msgid "API endpoint %s %s is not implemented"
msgstr ""
#: src/Module/BaseApi.php:125
#: src/Module/BaseApi.php:134
msgid ""
"The API endpoint is currently not implemented but might be in the future."
msgstr ""