3 * @copyright Copyright (C) 2010-2022, the Friendica project
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Module;
25 use Friendica\App\Router;
26 use Friendica\BaseModule;
27 use Friendica\Core\L10n;
28 use Friendica\Core\Logger;
29 use Friendica\Core\System;
31 use Friendica\Model\Contact;
32 use Friendica\Model\Item;
33 use Friendica\Model\Post;
34 use Friendica\Model\User;
35 use Friendica\Module\Api\ApiResponse;
36 use Friendica\Network\HTTPException;
37 use Friendica\Security\BasicAuth;
38 use Friendica\Security\OAuth;
39 use Friendica\Util\DateTimeFormat;
40 use Friendica\Util\Profiler;
41 use Psr\Http\Message\ResponseInterface;
42 use Psr\Log\LoggerInterface;
44 class BaseApi extends BaseModule
46 const LOG_PREFIX = 'API {action} - ';
48 const SCOPE_READ = 'read';
49 const SCOPE_WRITE = 'write';
50 const SCOPE_FOLLOW = 'follow';
51 const SCOPE_PUSH = 'push';
56 protected static $boundaries = [];
61 protected static $request = [];
66 /** @var ApiResponse */
69 public function __construct(App $app, L10n $l10n, App\BaseURL $baseUrl, App\Arguments $args, LoggerInterface $logger, Profiler $profiler, ApiResponse $response, array $server, array $parameters = [])
71 parent::__construct($l10n, $baseUrl, $args, $logger, $profiler, $response, $server, $parameters);
77 * Additionally checks, if the caller is permitted to do this action
81 * @throws HTTPException\ForbiddenException
83 public function run(array $request = [], bool $scopecheck = true): ResponseInterface
86 switch ($this->args->getMethod()) {
91 self::checkAllowedScope(self::SCOPE_WRITE);
93 if (!self::getCurrentUserID()) {
94 throw new HTTPException\ForbiddenException($this->t('Permission denied.'));
100 return parent::run($request);
104 * Processes data from GET requests and sets defaults
106 * @param array $defaults Associative array of expected request keys and their default typed value. A null
107 * value will remove the request key from the resulting value array.
108 * @param array $request Custom REQUEST array, superglobal instead
109 * @return array request data
112 public function getRequest(array $defaults, array $request): array
114 self::$request = $request;
115 self::$boundaries = [];
117 unset(self::$request['pagename']);
119 return $this->checkDefaults($defaults, $request);
123 * Set boundaries for the "link" header
124 * @param array $boundaries
127 protected static function setBoundaries(int $id)
129 if (!isset(self::$boundaries['min'])) {
130 self::$boundaries['min'] = $id;
133 if (!isset(self::$boundaries['max'])) {
134 self::$boundaries['max'] = $id;
137 self::$boundaries['min'] = min(self::$boundaries['min'], $id);
138 self::$boundaries['max'] = max(self::$boundaries['max'], $id);
142 * Get the "link" header with "next" and "prev" links
145 protected static function getLinkHeader(): string
147 if (empty(self::$boundaries)) {
151 $request = self::$request;
153 unset($request['min_id']);
154 unset($request['max_id']);
155 unset($request['since_id']);
157 $prev_request = $next_request = $request;
159 $prev_request['min_id'] = self::$boundaries['max'];
160 $next_request['max_id'] = self::$boundaries['min'];
162 $command = DI::baseUrl() . '/' . DI::args()->getCommand();
164 $prev = $command . '?' . http_build_query($prev_request);
165 $next = $command . '?' . http_build_query($next_request);
167 return 'Link: <' . $next . '>; rel="next", <' . $prev . '>; rel="prev"';
171 * Set the "link" header with "next" and "prev" links
174 protected static function setLinkHeader()
176 $header = self::getLinkHeader();
177 if (!empty($header)) {
183 * Get current application token
185 * @return array token
187 public static function getCurrentApplication()
189 $token = OAuth::getCurrentApplicationToken();
192 $token = BasicAuth::getCurrentApplicationToken();
199 * Get current user id, returns 0 if not logged in
201 * @return int User ID
203 public static function getCurrentUserID()
205 $uid = OAuth::getCurrentUserID();
208 $uid = BasicAuth::getCurrentUserID(false);
215 * Check if the provided scope does exist.
216 * halts execution on missing scope or when not logged in.
218 * @param string $scope the requested scope (read, write, follow, push)
220 public static function checkAllowedScope(string $scope)
222 $token = self::getCurrentApplication();
225 Logger::notice('Empty application token');
226 DI::mstdnError()->Forbidden();
229 if (!isset($token[$scope])) {
230 Logger::warning('The requested scope does not exist', ['scope' => $scope, 'application' => $token]);
231 DI::mstdnError()->Forbidden();
234 if (empty($token[$scope])) {
235 Logger::warning('The requested scope is not allowed', ['scope' => $scope, 'application' => $token]);
236 DI::mstdnError()->Forbidden();
240 public static function checkThrottleLimit()
242 $uid = self::getCurrentUserID();
244 // Check for throttling (maximum posts per day, week and month)
245 $throttle_day = DI::config()->get('system', 'throttle_limit_day');
246 if ($throttle_day > 0) {
247 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60);
249 $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", Item::GRAVITY_PARENT, $uid, $datefrom];
250 $posts_day = Post::countThread($condition);
252 if ($posts_day > $throttle_day) {
253 Logger::notice('Daily posting limit reached', ['uid' => $uid, 'posts' => $posts_day, 'limit' => $throttle_day]);
254 $error = DI::l10n()->t('Too Many Requests');
255 $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);
256 $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
257 System::jsonError(429, $errorobj->toArray());
261 $throttle_week = DI::config()->get('system', 'throttle_limit_week');
262 if ($throttle_week > 0) {
263 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*7);
265 $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", Item::GRAVITY_PARENT, $uid, $datefrom];
266 $posts_week = Post::countThread($condition);
268 if ($posts_week > $throttle_week) {
269 Logger::notice('Weekly posting limit reached', ['uid' => $uid, 'posts' => $posts_week, 'limit' => $throttle_week]);
270 $error = DI::l10n()->t('Too Many Requests');
271 $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);
272 $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
273 System::jsonError(429, $errorobj->toArray());
277 $throttle_month = DI::config()->get('system', 'throttle_limit_month');
278 if ($throttle_month > 0) {
279 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*30);
281 $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", Item::GRAVITY_PARENT, $uid, $datefrom];
282 $posts_month = Post::countThread($condition);
284 if ($posts_month > $throttle_month) {
285 Logger::notice('Monthly posting limit reached', ['uid' => $uid, 'posts' => $posts_month, 'limit' => $throttle_month]);
286 $error = DI::l10n()->t('Too Many Requests');
287 $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);
288 $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
289 System::jsonError(429, $errorobj->toArray());
294 public static function getContactIDForSearchterm(string $screen_name = null, string $profileurl = null, int $cid = null, int $uid)
300 if (!empty($profileurl)) {
301 return Contact::getIdForURL($profileurl);
304 if (empty($cid) && !empty($screen_name)) {
305 if (strpos($screen_name, '@') !== false) {
306 return Contact::getIdForURL($screen_name, 0, false);
309 $user = User::getByNickname($screen_name, ['uid']);
310 if (!empty($user['uid'])) {
311 return Contact::getPublicIdByUserId($user['uid']);
316 return Contact::getPublicIdByUserId($uid);