friendica/src/Module/BaseApi.php

309 lines
9 KiB
PHP
Raw Normal View History

2019-12-05 14:12:59 +01:00
<?php
2020-02-09 15:45:36 +01:00
/**
2022-01-02 08:27:47 +01:00
* @copyright Copyright (C) 2010-2022, the Friendica project
2020-02-09 15:45:36 +01:00
*
* @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/>.
*
*/
2019-12-05 14:12:59 +01:00
2020-01-28 03:18:42 +01:00
namespace Friendica\Module;
2019-12-05 14:12:59 +01:00
2021-11-21 21:52:36 +01:00
use Friendica\App;
use Friendica\App\Router;
2019-12-05 14:12:59 +01:00
use Friendica\BaseModule;
2021-11-21 21:52:36 +01:00
use Friendica\Core\L10n;
2021-05-08 11:14:19 +02:00
use Friendica\Core\Logger;
use Friendica\Core\System;
use Friendica\DI;
2021-11-18 23:20:19 +01:00
use Friendica\Model\Contact;
use Friendica\Model\Post;
use Friendica\Model\User;
2021-11-21 21:52:36 +01:00
use Friendica\Module\Api\ApiResponse;
2019-12-05 14:12:59 +01:00
use Friendica\Network\HTTPException;
use Friendica\Security\BasicAuth;
use Friendica\Security\OAuth;
use Friendica\Util\DateTimeFormat;
2021-11-21 21:52:36 +01:00
use Friendica\Util\Profiler;
use Psr\Http\Message\ResponseInterface;
2021-11-21 21:52:36 +01:00
use Psr\Log\LoggerInterface;
2019-12-05 14:12:59 +01:00
2020-01-28 03:18:42 +01:00
class BaseApi extends BaseModule
2019-12-05 14:12:59 +01:00
{
const LOG_PREFIX = 'API {action} - ';
2021-05-16 09:37:11 +02:00
const SCOPE_READ = 'read';
const SCOPE_WRITE = 'write';
const SCOPE_FOLLOW = 'follow';
const SCOPE_PUSH = 'push';
2021-06-16 17:02:33 +02:00
/**
* @var array
*/
protected static $boundaries = [];
/**
* @var array
*/
protected static $request = [];
2021-11-21 21:52:36 +01:00
/** @var App */
protected $app;
/** @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 = [])
{
parent::__construct($l10n, $baseUrl, $args, $logger, $profiler, $response, $server, $parameters);
2021-11-28 13:11:12 +01:00
$this->app = $app;
2021-11-21 21:52:36 +01:00
}
/**
* Additionally checks, if the caller is permitted to do this action
*
* {@inheritDoc}
*
* @throws HTTPException\ForbiddenException
*/
2021-12-17 08:04:52 +01:00
public function run(array $request = [], bool $scopecheck = true): ResponseInterface
2019-12-05 14:12:59 +01:00
{
2021-12-17 08:04:52 +01:00
if ($scopecheck) {
switch ($this->args->getMethod()) {
2021-12-17 08:04:52 +01:00
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;
}
2019-12-05 14:12:59 +01:00
}
2021-05-08 11:14:19 +02:00
return parent::run($request);
2021-05-08 11:14:19 +02:00
}
/**
* 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
2021-05-29 12:40:47 +02:00
{
self::$request = $request;
2021-06-16 17:02:33 +02:00
self::$boundaries = [];
unset(self::$request['pagename']);
return $this->checkDefaults($defaults, $request);
}
2021-06-16 17:02:33 +02:00
/**
* Set boundaries for the "link" header
* @param array $boundaries
* @param int $id
*/
protected static function setBoundaries(int $id)
{
if (!isset(self::$boundaries['min'])) {
self::$boundaries['min'] = $id;
}
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);
}
/**
* Set the "link" header with "next" and "prev" links
* @return void
*/
protected static function setLinkHeader()
{
if (empty(self::$boundaries)) {
return;
}
$request = self::$request;
unset($request['min_id']);
unset($request['max_id']);
unset($request['since_id']);
$prev_request = $next_request = $request;
2021-06-16 19:57:01 +02:00
$prev_request['min_id'] = self::$boundaries['max'];
$next_request['max_id'] = self::$boundaries['min'];
2021-06-16 17:02:33 +02:00
$command = DI::baseUrl() . '/' . DI::args()->getCommand();
$prev = $command . '?' . http_build_query($prev_request);
$next = $command . '?' . http_build_query($next_request);
header('Link: <' . $next . '>; rel="next", <' . $prev . '>; rel="prev"');
}
2021-05-16 00:40:57 +02:00
/**
* Get current application token
2021-05-16 00:40:57 +02:00
*
* @return array token
*/
public static function getCurrentApplication()
2021-05-16 00:40:57 +02:00
{
$token = OAuth::getCurrentApplicationToken();
2021-05-11 08:30:20 +02:00
if (empty($token)) {
$token = BasicAuth::getCurrentApplicationToken();
}
2021-05-16 00:40:57 +02:00
return $token;
2021-05-11 08:30:20 +02:00
}
2021-05-12 14:08:30 +02:00
/**
* Get current user id, returns 0 if not logged in
2021-05-12 14:08:30 +02:00
*
* @return int User ID
2021-05-12 14:08:30 +02:00
*/
2021-11-09 22:41:37 +01:00
public static function getCurrentUserID()
2021-05-11 08:30:20 +02:00
{
$uid = OAuth::getCurrentUserID();
if (empty($uid)) {
$uid = BasicAuth::getCurrentUserID(false);
2021-05-11 08:30:20 +02:00
}
return (int)$uid;
2021-05-11 08:30:20 +02:00
}
2021-06-08 11:11:56 +02:00
/**
* 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();
if (empty($token)) {
Logger::notice('Empty application token');
DI::mstdnError()->Forbidden();
}
if (!isset($token[$scope])) {
Logger::warning('The requested scope does not exist', ['scope' => $scope, 'application' => $token]);
DI::mstdnError()->Forbidden();
}
if (empty($token[$scope])) {
Logger::warning('The requested scope is not allowed', ['scope' => $scope, 'application' => $token]);
DI::mstdnError()->Forbidden();
}
}
public static function checkThrottleLimit()
{
$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` > ?", GRAVITY_PARENT, $uid, $datefrom];
2021-07-08 19:32:41 +02:00
$posts_day = Post::countThread($condition);
if ($posts_day > $throttle_day) {
Logger::info('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());
}
}
$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` > ?", GRAVITY_PARENT, $uid, $datefrom];
2021-07-08 19:32:41 +02:00
$posts_week = Post::countThread($condition);
if ($posts_week > $throttle_week) {
Logger::info('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());
}
}
$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` > ?", GRAVITY_PARENT, $uid, $datefrom];
2021-07-08 19:32:41 +02:00
$posts_month = Post::countThread($condition);
if ($posts_month > $throttle_month) {
Logger::info('Monthly posting limit reached', ['uid' => $uid, 'posts' => $posts_month, 'limit' => $throttle_month]);
$error = DI::l10n()->t('Too Many Requests');
$error_description = DI::l10n()->t("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());
}
}
}
2021-11-18 23:20:19 +01:00
2021-11-26 09:16:06 +01:00
public static function getContactIDForSearchterm(string $screen_name = null, string $profileurl = null, int $cid = null, int $uid)
2021-11-18 23:20:19 +01:00
{
if (!empty($cid)) {
return $cid;
}
if (!empty($profileurl)) {
return Contact::getIdForURL($profileurl);
}
if (empty($cid) && !empty($screen_name)) {
if (strpos($screen_name, '@') !== false) {
return Contact::getIdForURL($screen_name, 0, false);
}
$user = User::getByNickname($screen_name, ['uid']);
if (!empty($user['uid'])) {
return Contact::getPublicIdByUserId($user['uid']);
}
}
if ($uid != 0) {
return Contact::getPublicIdByUserId($uid);
2021-11-18 23:20:19 +01:00
}
return null;
2021-11-18 23:20:19 +01:00
}
2019-12-05 14:12:59 +01:00
}