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\Network\HTTPException;
29 use Friendica\Security\BasicAuth;
30 use Friendica\Security\OAuth;
31 use Friendica\Util\HTTPInputData;
33 require_once __DIR__ . '/../../include/api.php';
35 class BaseApi extends BaseModule
37 const SCOPE_READ = 'read';
38 const SCOPE_WRITE = 'write';
39 const SCOPE_FOLLOW = 'follow';
40 const SCOPE_PUSH = 'push';
43 * @var string json|xml|rss|atom
45 protected static $format = 'json';
47 public static function init(array $parameters = [])
49 $arguments = DI::args();
51 if (substr($arguments->getCommand(), -4) === '.xml') {
52 self::$format = 'xml';
54 if (substr($arguments->getCommand(), -4) === '.rss') {
55 self::$format = 'rss';
57 if (substr($arguments->getCommand(), -4) === '.atom') {
58 self::$format = 'atom';
62 public static function delete(array $parameters = [])
64 self::checkAllowedScope(self::SCOPE_WRITE);
68 if (!empty($a->user['uid']) && $a->user['uid'] != self::getCurrentUserID()) {
69 throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
73 public static function patch(array $parameters = [])
75 self::checkAllowedScope(self::SCOPE_WRITE);
79 if (!empty($a->user['uid']) && $a->user['uid'] != self::getCurrentUserID()) {
80 throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
84 public static function post(array $parameters = [])
86 self::checkAllowedScope(self::SCOPE_WRITE);
90 if (!empty($a->user['uid']) && $a->user['uid'] != self::getCurrentUserID()) {
91 throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
95 public static function put(array $parameters = [])
97 self::checkAllowedScope(self::SCOPE_WRITE);
101 if (!empty($a->user['uid']) && $a->user['uid'] != self::getCurrentUserID()) {
102 throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
107 * Quit execution with the message that the endpoint isn't implemented
109 * @param string $method
112 public static function unsupported(string $method = 'all')
114 $path = DI::args()->getQueryString();
115 Logger::info('Unimplemented API call', ['method' => $method, 'path' => $path, 'agent' => $_SERVER['HTTP_USER_AGENT'] ?? '', 'request' => HTTPInputData::process()]);
116 $error = DI::l10n()->t('API endpoint %s %s is not implemented', strtoupper($method), $path);
117 $error_description = DI::l10n()->t('The API endpoint is currently not implemented but might be in the future.');
118 $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
119 System::jsonError(501, $errorobj->toArray());
123 * Processes data from GET requests and sets defaults
125 * @return array request data
127 public static function getRequest(array $defaults)
129 $httpinput = HTTPInputData::process();
130 $input = array_merge($httpinput['variables'], $httpinput['files'], $_REQUEST);
134 foreach ($defaults as $parameter => $defaultvalue) {
135 if (is_string($defaultvalue)) {
136 $request[$parameter] = $input[$parameter] ?? $defaultvalue;
137 } elseif (is_int($defaultvalue)) {
138 $request[$parameter] = (int)($input[$parameter] ?? $defaultvalue);
139 } elseif (is_float($defaultvalue)) {
140 $request[$parameter] = (float)($input[$parameter] ?? $defaultvalue);
141 } elseif (is_array($defaultvalue)) {
142 $request[$parameter] = $input[$parameter] ?? [];
143 } elseif (is_bool($defaultvalue)) {
144 $request[$parameter] = in_array(strtolower($input[$parameter] ?? ''), ['true', '1']);
146 Logger::notice('Unhandled default value type', ['parameter' => $parameter, 'type' => gettype($defaultvalue)]);
150 foreach ($input ?? [] as $parameter => $value) {
151 if ($parameter == 'pagename') {
154 if (!in_array($parameter, array_keys($defaults))) {
155 Logger::notice('Unhandled request field', ['parameter' => $parameter, 'value' => $value, 'command' => DI::args()->getCommand()]);
159 Logger::debug('Got request parameters', ['request' => $request, 'command' => DI::args()->getCommand()]);
164 * Get current application token
166 * @return array token
168 protected static function getCurrentApplication()
170 $token = OAuth::getCurrentApplicationToken();
173 $token = BasicAuth::getCurrentApplicationToken();
180 * Get current user id, returns 0 if not logged in
182 * @return int User ID
184 protected static function getCurrentUserID()
186 $uid = OAuth::getCurrentUserID();
189 $uid = BasicAuth::getCurrentUserID(false);
196 * Check if the provided scope does exist.
197 * halts execution on missing scope or when not logged in.
199 * @param string $scope the requested scope (read, write, follow, push)
201 public static function checkAllowedScope(string $scope)
203 $token = self::getCurrentApplication();
206 Logger::notice('Empty application token');
207 DI::mstdnError()->Forbidden();
210 if (!isset($token[$scope])) {
211 Logger::warning('The requested scope does not exist', ['scope' => $scope, 'application' => $token]);
212 DI::mstdnError()->Forbidden();
215 if (empty($token[$scope])) {
216 Logger::warning('The requested scope is not allowed', ['scope' => $scope, 'application' => $token]);
217 DI::mstdnError()->Forbidden();
222 * Get user info array.
224 * @param int|string $contact_id Contact ID or URL
226 * @throws HTTPException\BadRequestException
227 * @throws HTTPException\InternalServerErrorException
228 * @throws HTTPException\UnauthorizedException
229 * @throws \ImagickException
231 protected static function getUser($contact_id = null)
233 return api_get_user(DI::app(), $contact_id);
237 * Formats the data according to the data type
239 * @param string $root_element
240 * @param array $data An array with a single element containing the returned result
241 * @return false|string
243 protected static function format(string $root_element, array $data)
245 $return = api_format_data($root_element, self::$format, $data);
247 switch (self::$format) {
249 header("Content-Type: text/xml");
252 header("Content-Type: application/json");
253 if (!empty($return)) {
254 $json = json_encode(end($return));
255 if (!empty($_GET['callback'])) {
256 $json = $_GET['callback'] . "(" . $json . ")";
262 header("Content-Type: application/rss+xml");
263 $return = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $return;
266 header("Content-Type: application/atom+xml");
267 $return = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $return;
275 * Creates the XML from a JSON style array
278 * @param $root_element
281 protected static function createXml($data, $root_element)
283 return api_create_xml($data, $root_element);