<?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
*
namespace Friendica\Module;
+use Friendica\App;
+use Friendica\App\Router;
use Friendica\BaseModule;
+use Friendica\Core\L10n;
use Friendica\Core\Logger;
use Friendica\Core\System;
-use Friendica\Database\Database;
-use Friendica\Database\DBA;
use Friendica\DI;
+use Friendica\Model\Contact;
+use Friendica\Model\Item;
+use Friendica\Model\Post;
+use Friendica\Model\User;
+use Friendica\Module\Api\ApiResponse;
use Friendica\Network\HTTPException;
+use Friendica\Security\BasicAuth;
+use Friendica\Security\OAuth;
use Friendica\Util\DateTimeFormat;
-
-require_once __DIR__ . '/../../include/api.php';
+use Friendica\Util\Profiler;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Log\LoggerInterface;
class BaseApi extends BaseModule
{
+ const LOG_PREFIX = 'API {action} - ';
+
+ const SCOPE_READ = 'read';
+ const SCOPE_WRITE = 'write';
+ const SCOPE_FOLLOW = 'follow';
+ const SCOPE_PUSH = 'push';
+
/**
- * @var string json|xml|rss|atom
+ * @var array
*/
- protected static $format = 'json';
+ protected static $boundaries = [];
+
/**
- * @var bool|int
+ * @var array
*/
- protected static $current_user_id;
+ protected static $request = [];
+
+ /** @var App */
+ protected $app;
- public static function init(array $parameters = [])
+ /** @var ApiResponse */
+ protected $response;
+
+ public function __construct(App $app, L10n $l10n, App\BaseURL $baseUrl, App\Arguments $args, LoggerInterface $logger, Profiler $profiler, ApiResponse $response, array $server, array $parameters = [])
{
- $arguments = DI::args();
+ parent::__construct($l10n, $baseUrl, $args, $logger, $profiler, $response, $server, $parameters);
- if (substr($arguments->getCommand(), -4) === '.xml') {
- self::$format = 'xml';
- }
- if (substr($arguments->getCommand(), -4) === '.rss') {
- self::$format = 'rss';
- }
- if (substr($arguments->getCommand(), -4) === '.atom') {
- self::$format = 'atom';
- }
+ $this->app = $app;
}
- public static function delete(array $parameters = [])
+ /**
+ * Additionally checks, if the caller is permitted to do this action
+ *
+ * {@inheritDoc}
+ *
+ * @throws HTTPException\ForbiddenException
+ */
+ public function run(array $request = [], bool $scopecheck = true): ResponseInterface
{
- if (!api_user()) {
- throw new HTTPException\UnauthorizedException(DI::l10n()->t('Permission denied.'));
+ if ($scopecheck) {
+ switch ($this->args->getMethod()) {
+ case Router::DELETE:
+ case Router::PATCH:
+ case Router::POST:
+ case Router::PUT:
+ self::checkAllowedScope(self::SCOPE_WRITE);
+
+ if (!self::getCurrentUserID()) {
+ throw new HTTPException\ForbiddenException($this->t('Permission denied.'));
+ }
+ break;
+ }
}
- $a = DI::app();
-
- if (!empty($a->user['uid']) && $a->user['uid'] != api_user()) {
- throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
- }
+ return parent::run($request);
}
- public static function patch(array $parameters = [])
+ /**
+ * Processes data from GET requests and sets defaults
+ *
+ * @param array $defaults Associative array of expected request keys and their default typed value. A null
+ * value will remove the request key from the resulting value array.
+ * @param array $request Custom REQUEST array, superglobal instead
+ * @return array request data
+ * @throws \Exception
+ */
+ public function getRequest(array $defaults, array $request): array
{
- if (!api_user()) {
- throw new HTTPException\UnauthorizedException(DI::l10n()->t('Permission denied.'));
- }
+ self::$request = $request;
+ self::$boundaries = [];
- $a = DI::app();
+ unset(self::$request['pagename']);
- if (!empty($a->user['uid']) && $a->user['uid'] != api_user()) {
- throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
- }
+ return $this->checkDefaults($defaults, $request);
}
- public static function post(array $parameters = [])
+ /**
+ * Set boundaries for the "link" header
+ * @param array $boundaries
+ * @param int $id
+ */
+ protected static function setBoundaries(int $id)
{
- if (!api_user()) {
- throw new HTTPException\UnauthorizedException(DI::l10n()->t('Permission denied.'));
+ if (!isset(self::$boundaries['min'])) {
+ self::$boundaries['min'] = $id;
}
- $a = DI::app();
-
- if (!empty($a->user['uid']) && $a->user['uid'] != api_user()) {
- throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
+ if (!isset(self::$boundaries['max'])) {
+ self::$boundaries['max'] = $id;
}
+
+ self::$boundaries['min'] = min(self::$boundaries['min'], $id);
+ self::$boundaries['max'] = max(self::$boundaries['max'], $id);
}
- public static function put(array $parameters = [])
+ /**
+ * Get the "link" header with "next" and "prev" links
+ * @return string
+ */
+ protected static function getLinkHeader(): string
{
- if (!api_user()) {
- throw new HTTPException\UnauthorizedException(DI::l10n()->t('Permission denied.'));
+ if (empty(self::$boundaries)) {
+ return '';
}
- $a = DI::app();
+ $request = self::$request;
- if (!empty($a->user['uid']) && $a->user['uid'] != api_user()) {
- throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
- }
+ unset($request['min_id']);
+ unset($request['max_id']);
+ unset($request['since_id']);
+
+ $prev_request = $next_request = $request;
+
+ $prev_request['min_id'] = self::$boundaries['max'];
+ $next_request['max_id'] = self::$boundaries['min'];
+
+ $command = DI::baseUrl() . '/' . DI::args()->getCommand();
+
+ $prev = $command . '?' . http_build_query($prev_request);
+ $next = $command . '?' . http_build_query($next_request);
+
+ return 'Link: <' . $next . '>; rel="next", <' . $prev . '>; rel="prev"';
}
- public static function unsupported(string $method = 'all')
+ /**
+ * Set the "link" header with "next" and "prev" links
+ * @return void
+ */
+ protected static function setLinkHeader()
{
- $path = DI::args()->getQueryString();
- Logger::info('Unimplemented API call', ['method' => $method, 'path' => $path, 'agent' => $_SERVER['HTTP_USER_AGENT'] ?? '', 'request' => $_REQUEST ?? []]);
- $error = DI::l10n()->t('API endpoint %s %s is not implemented', strtoupper($method), $path);
- $error_description = DI::l10n()->t('The API endpoint is currently not implemented but might be in the future.');;
- $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
- System::jsonError(501, $errorobj->toArray());
+ $header = self::getLinkHeader();
+ if (!empty($header)) {
+ header($header);
+ }
}
/**
- * Log in user via OAuth1 or Simple HTTP Auth.
+ * Get current application token
*
- * Simple Auth allow username in form of <pre>user@server</pre>, ignoring server part
- *
- * @return bool Was a user authenticated?
- * @throws HTTPException\ForbiddenException
- * @throws HTTPException\UnauthorizedException
- * @throws HTTPException\InternalServerErrorException
- * @hook 'authenticate'
- * array $addon_auth
- * 'username' => username from login form
- * 'password' => password from login form
- * 'authenticated' => return status,
- * 'user_record' => return authenticated user record
+ * @return array token
*/
- protected static function login()
+ public static function getCurrentApplication()
{
- $authorization = $_SERVER['HTTP_AUTHORIZATION'] ?? '';
- $authorization = $_SERVER['AUTHORIZATION'] ?? $authorization;
+ $token = OAuth::getCurrentApplicationToken();
- if (self::checkBearer($authorization)) {
- self::$current_user_id = self::getUserByBearer($authorization);
- return (bool)self::$current_user_id;
+ if (empty($token)) {
+ $token = BasicAuth::getCurrentApplicationToken();
}
- api_login(DI::app());
-
- self::$current_user_id = api_user();
-
- return (bool)self::$current_user_id;
+ return $token;
}
/**
*
* @return int User ID
*/
- protected static function getCurrentUserID()
+ public static function getCurrentUserID()
{
- $authorization = $_SERVER['HTTP_AUTHORIZATION'] ?? '';
- $authorization = $_SERVER['AUTHORIZATION'] ?? $authorization;
+ $uid = OAuth::getCurrentUserID();
- if (self::checkBearer($authorization)) {
- self::$current_user_id = self::getUserByBearer($authorization);
- return (int)self::$current_user_id;
+ if (empty($uid)) {
+ $uid = BasicAuth::getCurrentUserID(false);
}
- if (is_null(self::$current_user_id)) {
- api_login(DI::app(), false);
+ return (int)$uid;
+ }
+
+ /**
+ * Check if the provided scope does exist.
+ * halts execution on missing scope or when not logged in.
+ *
+ * @param string $scope the requested scope (read, write, follow, push)
+ */
+ public static function checkAllowedScope(string $scope)
+ {
+ $token = self::getCurrentApplication();
- self::$current_user_id = api_user();
+ if (empty($token)) {
+ Logger::notice('Empty application token');
+ DI::mstdnError()->Forbidden();
}
- return (int)self::$current_user_id;
- }
+ if (!isset($token[$scope])) {
+ Logger::warning('The requested scope does not exist', ['scope' => $scope, 'application' => $token]);
+ DI::mstdnError()->Forbidden();
+ }
- private static function checkBearer(string $authorization)
- {
- return (substr($authorization, 0, 7) == 'Bearer ');
+ if (empty($token[$scope])) {
+ Logger::warning('The requested scope is not allowed', ['scope' => $scope, 'application' => $token]);
+ DI::mstdnError()->Forbidden();
+ }
}
- private static function getUserByBearer(string $authorization)
+ public static function checkThrottleLimit()
{
- $bearer = trim(substr($authorization, 6));
- $condition = ['access_token' => $bearer];
- $token = DBA::selectFirst('application-token', ['uid'], $condition);
- if (!DBA::isResult($token)) {
- Logger::warning('Token not found', $condition);
- return 0;
+ $uid = self::getCurrentUserID();
+
+ // Check for throttling (maximum posts per day, week and month)
+ $throttle_day = DI::config()->get('system', 'throttle_limit_day');
+ if ($throttle_day > 0) {
+ $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60);
+
+ $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", Item::GRAVITY_PARENT, $uid, $datefrom];
+ $posts_day = Post::countThread($condition);
+
+ if ($posts_day > $throttle_day) {
+ Logger::notice('Daily posting limit reached', ['uid' => $uid, 'posts' => $posts_day, 'limit' => $throttle_day]);
+ $error = DI::l10n()->t('Too Many Requests');
+ $error_description = DI::l10n()->tt("Daily posting limit of %d post reached. The post was rejected.", "Daily posting limit of %d posts reached. The post was rejected.", $throttle_day);
+ $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
+ System::jsonError(429, $errorobj->toArray());
+ }
}
- Logger::info('Token found', $token);
- return $token['uid'];
- }
- public static function getApplication()
- {
- $redirect_uri = !isset($_REQUEST['redirect_uri']) ? '' : $_REQUEST['redirect_uri'];
- $client_id = !isset($_REQUEST['client_id']) ? '' : $_REQUEST['client_id'];
+ $throttle_week = DI::config()->get('system', 'throttle_limit_week');
+ if ($throttle_week > 0) {
+ $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*7);
+
+ $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", Item::GRAVITY_PARENT, $uid, $datefrom];
+ $posts_week = Post::countThread($condition);
- if (empty($redirect_uri) || empty($client_id)) {
- Logger::warning('Incomplete request');
- return [];
+ if ($posts_week > $throttle_week) {
+ Logger::notice('Weekly posting limit reached', ['uid' => $uid, 'posts' => $posts_week, 'limit' => $throttle_week]);
+ $error = DI::l10n()->t('Too Many Requests');
+ $error_description = DI::l10n()->tt("Weekly posting limit of %d post reached. The post was rejected.", "Weekly posting limit of %d posts reached. The post was rejected.", $throttle_week);
+ $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
+ System::jsonError(429, $errorobj->toArray());
+ }
}
- $condition = ['redirect_uri' => $redirect_uri, 'client_id' => $client_id];
- $application = DBA::selectFirst('application', [], $condition);
- if (!DBA::isResult($application)) {
- Logger::warning('Application not found', $condition);
- return [];
+ $throttle_month = DI::config()->get('system', 'throttle_limit_month');
+ if ($throttle_month > 0) {
+ $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*30);
+
+ $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", Item::GRAVITY_PARENT, $uid, $datefrom];
+ $posts_month = Post::countThread($condition);
+
+ if ($posts_month > $throttle_month) {
+ Logger::notice('Monthly posting limit reached', ['uid' => $uid, 'posts' => $posts_month, 'limit' => $throttle_month]);
+ $error = DI::l10n()->t('Too Many Requests');
+ $error_description = DI::l10n()->tt('Monthly posting limit of %d post reached. The post was rejected.', 'Monthly posting limit of %d posts reached. The post was rejected.', $throttle_month);
+ $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
+ System::jsonError(429, $errorobj->toArray());
+ }
}
- return $application;
}
- public static function getTokenForUser(array $application, int $uid)
+ public static function getContactIDForSearchterm(string $screen_name = null, string $profileurl = null, int $cid = null, int $uid)
{
- $code = bin2hex(random_bytes(32));
- $access_token = bin2hex(random_bytes(32));
+ if (!empty($cid)) {
+ return $cid;
+ }
- $fields = ['application-id' => $application['id'], 'uid' => $uid, 'code' => $code, 'access_token' => $access_token, 'created_at' => DateTimeFormat::utcNow(DateTimeFormat::MYSQL)];
- if (!DBA::insert('application-token', $fields, Database::INSERT_UPDATE)) {
- return [];
+ if (!empty($profileurl)) {
+ return Contact::getIdForURL($profileurl);
}
- return DBA::selectFirst('application-token', [], ['application-id' => $application['id'], 'uid' => $uid]);
- }
- /**
- * Get user info array.
- *
- * @param int|string $contact_id Contact ID or URL
- * @return array|bool
- * @throws HTTPException\BadRequestException
- * @throws HTTPException\InternalServerErrorException
- * @throws HTTPException\UnauthorizedException
- * @throws \ImagickException
- */
- protected static function getUser($contact_id = null)
- {
- return api_get_user(DI::app(), $contact_id);
- }
+ if (empty($cid) && !empty($screen_name)) {
+ if (strpos($screen_name, '@') !== false) {
+ return Contact::getIdForURL($screen_name, 0, false);
+ }
- /**
- * Formats the data according to the data type
- *
- * @param string $root_element
- * @param array $data An array with a single element containing the returned result
- * @return false|string
- */
- protected static function format(string $root_element, array $data)
- {
- $return = api_format_data($root_element, self::$format, $data);
-
- switch (self::$format) {
- case "xml":
- header("Content-Type: text/xml");
- break;
- case "json":
- header("Content-Type: application/json");
- if (!empty($return)) {
- $json = json_encode(end($return));
- if (!empty($_GET['callback'])) {
- $json = $_GET['callback'] . "(" . $json . ")";
- }
- $return = $json;
- }
- break;
- case "rss":
- header("Content-Type: application/rss+xml");
- $return = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $return;
- break;
- case "atom":
- header("Content-Type: application/atom+xml");
- $return = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $return;
- break;
+ $user = User::getByNickname($screen_name, ['uid']);
+ if (!empty($user['uid'])) {
+ return Contact::getPublicIdByUserId($user['uid']);
+ }
}
- return $return;
- }
+ if ($uid != 0) {
+ return Contact::getPublicIdByUserId($uid);
+ }
- /**
- * Creates the XML from a JSON style array
- *
- * @param $data
- * @param $root_element
- * @return string
- */
- protected static function createXml($data, $root_element)
- {
- return api_create_xml($data, $root_element);
+ return null;
}
}