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';
47 * @var string json|xml|rss|atom
49 protected static $format = 'json';
54 protected static $boundaries = [];
59 protected static $request = [];
61 public static function init(array $parameters = [])
63 $arguments = DI::args();
65 if (substr($arguments->getCommand(), -4) === '.xml') {
66 self::$format = 'xml';
68 if (substr($arguments->getCommand(), -4) === '.rss') {
69 self::$format = 'rss';
71 if (substr($arguments->getCommand(), -4) === '.atom') {
72 self::$format = 'atom';
76 public static function delete(array $parameters = [])
78 self::checkAllowedScope(self::SCOPE_WRITE);
80 if (!DI::app()->isLoggedIn()) {
81 throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
85 public static function patch(array $parameters = [])
87 self::checkAllowedScope(self::SCOPE_WRITE);
89 if (!DI::app()->isLoggedIn()) {
90 throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
94 public static function post(array $parameters = [])
96 self::checkAllowedScope(self::SCOPE_WRITE);
98 if (!DI::app()->isLoggedIn()) {
99 throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
103 public static function put(array $parameters = [])
105 self::checkAllowedScope(self::SCOPE_WRITE);
107 if (!DI::app()->isLoggedIn()) {
108 throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
113 * Quit execution with the message that the endpoint isn't implemented
115 * @param string $method
118 public static function unsupported(string $method = 'all')
120 $path = DI::args()->getQueryString();
121 Logger::info('Unimplemented API call', ['method' => $method, 'path' => $path, 'agent' => $_SERVER['HTTP_USER_AGENT'] ?? '', 'request' => HTTPInputData::process()]);
122 $error = DI::l10n()->t('API endpoint %s %s is not implemented', strtoupper($method), $path);
123 $error_description = DI::l10n()->t('The API endpoint is currently not implemented but might be in the future.');
124 $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
125 System::jsonError(501, $errorobj->toArray());
129 * Processes data from GET requests and sets defaults
131 * @return array request data
133 public static function getRequest(array $defaults)
135 $httpinput = HTTPInputData::process();
136 $input = array_merge($httpinput['variables'], $httpinput['files'], $_REQUEST);
138 self::$request = $input;
139 self::$boundaries = [];
141 unset(self::$request['pagename']);
145 foreach ($defaults as $parameter => $defaultvalue) {
146 if (is_string($defaultvalue)) {
147 $request[$parameter] = $input[$parameter] ?? $defaultvalue;
148 } elseif (is_int($defaultvalue)) {
149 $request[$parameter] = (int)($input[$parameter] ?? $defaultvalue);
150 } elseif (is_float($defaultvalue)) {
151 $request[$parameter] = (float)($input[$parameter] ?? $defaultvalue);
152 } elseif (is_array($defaultvalue)) {
153 $request[$parameter] = $input[$parameter] ?? [];
154 } elseif (is_bool($defaultvalue)) {
155 $request[$parameter] = in_array(strtolower($input[$parameter] ?? ''), ['true', '1']);
157 Logger::notice('Unhandled default value type', ['parameter' => $parameter, 'type' => gettype($defaultvalue)]);
161 foreach ($input ?? [] as $parameter => $value) {
162 if ($parameter == 'pagename') {
165 if (!in_array($parameter, array_keys($defaults))) {
166 Logger::notice('Unhandled request field', ['parameter' => $parameter, 'value' => $value, 'command' => DI::args()->getCommand()]);
170 Logger::debug('Got request parameters', ['request' => $request, 'command' => DI::args()->getCommand()]);
175 * Set boundaries for the "link" header
176 * @param array $boundaries
180 protected static function setBoundaries(int $id)
182 if (!isset(self::$boundaries['min'])) {
183 self::$boundaries['min'] = $id;
186 if (!isset(self::$boundaries['max'])) {
187 self::$boundaries['max'] = $id;
190 self::$boundaries['min'] = min(self::$boundaries['min'], $id);
191 self::$boundaries['max'] = max(self::$boundaries['max'], $id);
195 * Set the "link" header with "next" and "prev" links
198 protected static function setLinkHeader()
200 if (empty(self::$boundaries)) {
204 $request = self::$request;
206 unset($request['min_id']);
207 unset($request['max_id']);
208 unset($request['since_id']);
210 $prev_request = $next_request = $request;
212 $prev_request['min_id'] = self::$boundaries['max'];
213 $next_request['max_id'] = self::$boundaries['min'];
215 $command = DI::baseUrl() . '/' . DI::args()->getCommand();
217 $prev = $command . '?' . http_build_query($prev_request);
218 $next = $command . '?' . http_build_query($next_request);
220 header('Link: <' . $next . '>; rel="next", <' . $prev . '>; rel="prev"');
224 * Get current application token
226 * @return array token
228 protected static function getCurrentApplication()
230 $token = OAuth::getCurrentApplicationToken();
233 $token = BasicAuth::getCurrentApplicationToken();
240 * Get current user id, returns 0 if not logged in
242 * @return int User ID
244 protected static function getCurrentUserID()
246 $uid = OAuth::getCurrentUserID();
249 $uid = BasicAuth::getCurrentUserID(false);
256 * Check if the provided scope does exist.
257 * halts execution on missing scope or when not logged in.
259 * @param string $scope the requested scope (read, write, follow, push)
261 public static function checkAllowedScope(string $scope)
263 $token = self::getCurrentApplication();
266 Logger::notice('Empty application token');
267 DI::mstdnError()->Forbidden();
270 if (!isset($token[$scope])) {
271 Logger::warning('The requested scope does not exist', ['scope' => $scope, 'application' => $token]);
272 DI::mstdnError()->Forbidden();
275 if (empty($token[$scope])) {
276 Logger::warning('The requested scope is not allowed', ['scope' => $scope, 'application' => $token]);
277 DI::mstdnError()->Forbidden();
281 public static function checkThrottleLimit()
283 $uid = self::getCurrentUserID();
285 // Check for throttling (maximum posts per day, week and month)
286 $throttle_day = DI::config()->get('system', 'throttle_limit_day');
287 if ($throttle_day > 0) {
288 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60);
290 $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", GRAVITY_PARENT, $uid, $datefrom];
291 $posts_day = Post::countThread($condition);
293 if ($posts_day > $throttle_day) {
294 Logger::info('Daily posting limit reached', ['uid' => $uid, 'posts' => $posts_day, 'limit' => $throttle_day]);
295 $error = DI::l10n()->t('Too Many Requests');
296 $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);
297 $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
298 System::jsonError(429, $errorobj->toArray());
302 $throttle_week = DI::config()->get('system', 'throttle_limit_week');
303 if ($throttle_week > 0) {
304 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*7);
306 $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", GRAVITY_PARENT, $uid, $datefrom];
307 $posts_week = Post::countThread($condition);
309 if ($posts_week > $throttle_week) {
310 Logger::info('Weekly posting limit reached', ['uid' => $uid, 'posts' => $posts_week, 'limit' => $throttle_week]);
311 $error = DI::l10n()->t('Too Many Requests');
312 $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);
313 $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
314 System::jsonError(429, $errorobj->toArray());
318 $throttle_month = DI::config()->get('system', 'throttle_limit_month');
319 if ($throttle_month > 0) {
320 $datefrom = date(DateTimeFormat::MYSQL, time() - 24*60*60*30);
322 $condition = ["`gravity` = ? AND `uid` = ? AND `wall` AND `received` > ?", GRAVITY_PARENT, $uid, $datefrom];
323 $posts_month = Post::countThread($condition);
325 if ($posts_month > $throttle_month) {
326 Logger::info('Monthly posting limit reached', ['uid' => $uid, 'posts' => $posts_month, 'limit' => $throttle_month]);
327 $error = DI::l10n()->t('Too Many Requests');
328 $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);
329 $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
330 System::jsonError(429, $errorobj->toArray());
336 * Get user info array.
338 * @param int|string $contact_id Contact ID or URL
340 * @throws HTTPException\BadRequestException
341 * @throws HTTPException\InternalServerErrorException
342 * @throws HTTPException\UnauthorizedException
343 * @throws \ImagickException
345 protected static function getUser($contact_id = null)
347 return api_get_user($contact_id);
351 * Outputs formatted data according to the data type and then exits the execution.
353 * @param string $root_element
354 * @param array $data An array with a single element containing the returned result
355 * @return false|string
357 protected static function exit(string $root_element, array $data)
359 $return = self::formatData($root_element, self::$format, $data);
361 switch (self::$format) {
363 header('Content-Type: text/xml');
366 header('Content-Type: application/json');
367 if (!empty($return)) {
368 $json = json_encode(end($return));
369 if (!empty($_GET['callback'])) {
370 $json = $_GET['callback'] . '(' . $json . ')';
376 header('Content-Type: application/rss+xml');
377 $return = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $return;
380 header('Content-Type: application/atom+xml');
381 $return = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $return;
390 * Formats the data according to the data type
392 * @param string $root_element Name of the root element
393 * @param string $type Return type (atom, rss, xml, json)
394 * @param array $data JSON style array
396 * @return array|string (string|array) XML data or JSON data
398 public static function formatData($root_element, string $type, array $data)
404 $ret = self::createXML($data, $root_element);
415 * Callback function to transform the array in an array that can be transformed in a XML file
417 * @param mixed $item Array item value
418 * @param string $key Array key
422 public static function reformatXML(&$item, &$key)
424 if (is_bool($item)) {
425 $item = ($item ? 'true' : 'false');
428 if (substr($key, 0, 10) == 'statusnet_') {
429 $key = 'statusnet:'.substr($key, 10);
430 } elseif (substr($key, 0, 10) == 'friendica_') {
431 $key = 'friendica:'.substr($key, 10);
437 * Creates the XML from a JSON style array
439 * @param array $data JSON style array
440 * @param string $root_element Name of the root element
442 * @return string The XML data
444 public static function createXML(array $data, $root_element)
446 $childname = key($data);
447 $data2 = array_pop($data);
449 $namespaces = ['' => 'http://api.twitter.com',
450 'statusnet' => 'http://status.net/schema/api/1/',
451 'friendica' => 'http://friendi.ca/schema/api/1/',
452 'georss' => 'http://www.georss.org/georss'];
454 /// @todo Auto detection of needed namespaces
455 if (in_array($root_element, ['ok', 'hash', 'config', 'version', 'ids', 'notes', 'photos'])) {
459 if (is_array($data2)) {
461 Arrays::walkRecursive($data2, ['Friendica\Module\BaseApi', 'reformatXML']);
467 foreach ($data2 as $item) {
468 $data4[$i++ . ':' . $childname] = $item;
475 $data3 = [$root_element => $data2];
477 $ret = XML::fromArray($data3, $xml, false, $namespaces);