3 * @copyright Copyright (C) 2010-2021, 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;
24 use Friendica\BaseModule;
25 use Friendica\Core\Logger;
26 use Friendica\Core\System;
28 use Friendica\Model\Post;
29 use Friendica\Network\HTTPException;
30 use Friendica\Security\BasicAuth;
31 use Friendica\Security\OAuth;
32 use Friendica\Util\Arrays;
33 use Friendica\Util\DateTimeFormat;
34 use Friendica\Util\HTTPInputData;
35 use Friendica\Util\XML;
37 require_once __DIR__ . '/../../include/api.php';
39 class BaseApi extends BaseModule
41 const SCOPE_READ = 'read';
42 const SCOPE_WRITE = 'write';
43 const SCOPE_FOLLOW = 'follow';
44 const SCOPE_PUSH = 'push';
49 protected static $boundaries = [];
54 protected static $request = [];
56 public static function delete(array $parameters = [])
58 self::checkAllowedScope(self::SCOPE_WRITE);
60 if (!DI::app()->isLoggedIn()) {
61 throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
65 public static function patch(array $parameters = [])
67 self::checkAllowedScope(self::SCOPE_WRITE);
69 if (!DI::app()->isLoggedIn()) {
70 throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
74 public static function post(array $parameters = [])
76 self::checkAllowedScope(self::SCOPE_WRITE);
78 if (!DI::app()->isLoggedIn()) {
79 throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
83 public static function put(array $parameters = [])
85 self::checkAllowedScope(self::SCOPE_WRITE);
87 if (!DI::app()->isLoggedIn()) {
88 throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
93 * Quit execution with the message that the endpoint isn't implemented
95 * @param string $method
98 public static function unsupported(string $method = 'all')
100 $path = DI::args()->getQueryString();
101 Logger::info('Unimplemented API call', ['method' => $method, 'path' => $path, 'agent' => $_SERVER['HTTP_USER_AGENT'] ?? '', 'request' => HTTPInputData::process()]);
102 $error = DI::l10n()->t('API endpoint %s %s is not implemented', strtoupper($method), $path);
103 $error_description = DI::l10n()->t('The API endpoint is currently not implemented but might be in the future.');
104 $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
105 System::jsonError(501, $errorobj->toArray());
109 * Processes data from GET requests and sets defaults
111 * @return array request data
113 public static function getRequest(array $defaults)
115 $httpinput = HTTPInputData::process();
116 $input = array_merge($httpinput['variables'], $httpinput['files'], $_REQUEST);
118 self::$request = $input;
119 self::$boundaries = [];
121 unset(self::$request['pagename']);
125 foreach ($defaults as $parameter => $defaultvalue) {
126 if (is_string($defaultvalue)) {
127 $request[$parameter] = $input[$parameter] ?? $defaultvalue;
128 } elseif (is_int($defaultvalue)) {
129 $request[$parameter] = (int)($input[$parameter] ?? $defaultvalue);
130 } elseif (is_float($defaultvalue)) {
131 $request[$parameter] = (float)($input[$parameter] ?? $defaultvalue);
132 } elseif (is_array($defaultvalue)) {
133 $request[$parameter] = $input[$parameter] ?? [];
134 } elseif (is_bool($defaultvalue)) {
135 $request[$parameter] = in_array(strtolower($input[$parameter] ?? ''), ['true', '1']);
137 Logger::notice('Unhandled default value type', ['parameter' => $parameter, 'type' => gettype($defaultvalue)]);
141 foreach ($input ?? [] as $parameter => $value) {
142 if ($parameter == 'pagename') {
145 if (!in_array($parameter, array_keys($defaults))) {
146 Logger::notice('Unhandled request field', ['parameter' => $parameter, 'value' => $value, 'command' => DI::args()->getCommand()]);
150 Logger::debug('Got request parameters', ['request' => $request, 'command' => DI::args()->getCommand()]);
155 * Set boundaries for the "link" header
156 * @param array $boundaries
160 protected static function setBoundaries(int $id)
162 if (!isset(self::$boundaries['min'])) {
163 self::$boundaries['min'] = $id;
166 if (!isset(self::$boundaries['max'])) {
167 self::$boundaries['max'] = $id;
170 self::$boundaries['min'] = min(self::$boundaries['min'], $id);
171 self::$boundaries['max'] = max(self::$boundaries['max'], $id);
175 * Set the "link" header with "next" and "prev" links
178 protected static function setLinkHeader()
180 if (empty(self::$boundaries)) {
184 $request = self::$request;
186 unset($request['min_id']);
187 unset($request['max_id']);
188 unset($request['since_id']);
190 $prev_request = $next_request = $request;
192 $prev_request['min_id'] = self::$boundaries['max'];
193 $next_request['max_id'] = self::$boundaries['min'];
195 $command = DI::baseUrl() . '/' . DI::args()->getCommand();
197 $prev = $command . '?' . http_build_query($prev_request);
198 $next = $command . '?' . http_build_query($next_request);
200 header('Link: <' . $next . '>; rel="next", <' . $prev . '>; rel="prev"');
204 * Get current application token
206 * @return array token
208 protected static function getCurrentApplication()
210 $token = OAuth::getCurrentApplicationToken();
213 $token = BasicAuth::getCurrentApplicationToken();
220 * Get current user id, returns 0 if not logged in
222 * @return int User ID
224 public static function getCurrentUserID()
226 $uid = OAuth::getCurrentUserID();
229 $uid = BasicAuth::getCurrentUserID(false);
236 * Check if the provided scope does exist.
237 * halts execution on missing scope or when not logged in.
239 * @param string $scope the requested scope (read, write, follow, push)
241 public static function checkAllowedScope(string $scope)
243 $token = self::getCurrentApplication();
246 Logger::notice('Empty application token');
247 DI::mstdnError()->Forbidden();
250 if (!isset($token[$scope])) {
251 Logger::warning('The requested scope does not exist', ['scope' => $scope, 'application' => $token]);
252 DI::mstdnError()->Forbidden();
255 if (empty($token[$scope])) {
256 Logger::warning('The requested scope is not allowed', ['scope' => $scope, 'application' => $token]);
257 DI::mstdnError()->Forbidden();
261 public static function checkThrottleLimit()
263 $uid = self::getCurrentUserID();
265 // Check for throttling (maximum posts per day, week and month)
266 $throttle_day = DI::config()->get('system', 'throttle_limit_day');
267 if ($throttle_day > 0) {
268 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60);
270 $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", GRAVITY_PARENT, $uid, $datefrom];
271 $posts_day = Post::countThread($condition);
273 if ($posts_day > $throttle_day) {
274 Logger::info('Daily posting limit reached', ['uid' => $uid, 'posts' => $posts_day, 'limit' => $throttle_day]);
275 $error = DI::l10n()->t('Too Many Requests');
276 $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);
277 $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
278 System::jsonError(429, $errorobj->toArray());
282 $throttle_week = DI::config()->get('system', 'throttle_limit_week');
283 if ($throttle_week > 0) {
284 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*7);
286 $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", GRAVITY_PARENT, $uid, $datefrom];
287 $posts_week = Post::countThread($condition);
289 if ($posts_week > $throttle_week) {
290 Logger::info('Weekly posting limit reached', ['uid' => $uid, 'posts' => $posts_week, 'limit' => $throttle_week]);
291 $error = DI::l10n()->t('Too Many Requests');
292 $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);
293 $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
294 System::jsonError(429, $errorobj->toArray());
298 $throttle_month = DI::config()->get('system', 'throttle_limit_month');
299 if ($throttle_month > 0) {
300 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*30);
302 $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", GRAVITY_PARENT, $uid, $datefrom];
303 $posts_month = Post::countThread($condition);
305 if ($posts_month > $throttle_month) {
306 Logger::info('Monthly posting limit reached', ['uid' => $uid, 'posts' => $posts_month, 'limit' => $throttle_month]);
307 $error = DI::l10n()->t('Too Many Requests');
308 $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);
309 $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
310 System::jsonError(429, $errorobj->toArray());
316 * Get user info array.
318 * @param int|string $contact_id Contact ID or URL
320 * @throws HTTPException\BadRequestException
321 * @throws HTTPException\InternalServerErrorException
322 * @throws HTTPException\UnauthorizedException
323 * @throws \ImagickException
325 protected static function getUser($contact_id = null)
327 return api_get_user($contact_id);
331 * Exit with error code
334 * @param string $description
335 * @param string $message
336 * @param string|null $format
339 public static function error(int $code, string $description, string $message, string $format = null)
342 'error' => $message ?: $description,
343 'code' => $code . ' ' . $description,
344 'request' => DI::args()->getQueryString()
347 header(($_SERVER['SERVER_PROTOCOL'] ?? 'HTTP/1.1') . ' ' . $code . ' ' . $description);
349 self::exit('status', ['status' => $error], $format);
353 * Outputs formatted data according to the data type and then exits the execution.
355 * @param string $root_element
356 * @param array $data An array with a single element containing the returned result
357 * @param string $format Output format (xml, json, rss, atom)
358 * @return false|string
360 protected static function exit(string $root_element, array $data, string $format = null)
362 $format = $format ?? 'json';
364 $return = self::formatData($root_element, $format, $data);
368 header('Content-Type: text/xml');
371 header('Content-Type: application/json');
372 if (!empty($return)) {
373 $json = json_encode(end($return));
374 if (!empty($_GET['callback'])) {
375 $json = $_GET['callback'] . '(' . $json . ')';
381 header('Content-Type: application/rss+xml');
382 $return = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $return;
385 header('Content-Type: application/atom+xml');
386 $return = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $return;
395 * Formats the data according to the data type
397 * @param string $root_element Name of the root element
398 * @param string $type Return type (atom, rss, xml, json)
399 * @param array $data JSON style array
401 * @return array|string (string|array) XML data or JSON data
403 public static function formatData($root_element, string $type, array $data)
409 $ret = self::createXML($data, $root_element);
420 * Callback function to transform the array in an array that can be transformed in a XML file
422 * @param mixed $item Array item value
423 * @param string $key Array key
427 public static function reformatXML(&$item, &$key)
429 if (is_bool($item)) {
430 $item = ($item ? 'true' : 'false');
433 if (substr($key, 0, 10) == 'statusnet_') {
434 $key = 'statusnet:'.substr($key, 10);
435 } elseif (substr($key, 0, 10) == 'friendica_') {
436 $key = 'friendica:'.substr($key, 10);
442 * Creates the XML from a JSON style array
444 * @param array $data JSON style array
445 * @param string $root_element Name of the root element
447 * @return string The XML data
449 public static function createXML(array $data, $root_element)
451 $childname = key($data);
452 $data2 = array_pop($data);
454 $namespaces = ['' => 'http://api.twitter.com',
455 'statusnet' => 'http://status.net/schema/api/1/',
456 'friendica' => 'http://friendi.ca/schema/api/1/',
457 'georss' => 'http://www.georss.org/georss'];
459 /// @todo Auto detection of needed namespaces
460 if (in_array($root_element, ['ok', 'hash', 'config', 'version', 'ids', 'notes', 'photos'])) {
464 if (is_array($data2)) {
466 Arrays::walkRecursive($data2, ['Friendica\Module\BaseApi', 'reformatXML']);
472 foreach ($data2 as $item) {
473 $data4[$i++ . ':' . $childname] = $item;
480 $data3 = [$root_element => $data2];
482 $ret = XML::fromArray($data3, $xml, false, $namespaces);