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 = [])
65 throw new HTTPException\UnauthorizedException(DI::l10n()->t('Permission denied.'));
70 if (!empty($a->user['uid']) && $a->user['uid'] != api_user()) {
71 throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
75 public static function patch(array $parameters = [])
78 throw new HTTPException\UnauthorizedException(DI::l10n()->t('Permission denied.'));
83 if (!empty($a->user['uid']) && $a->user['uid'] != api_user()) {
84 throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
88 public static function post(array $parameters = [])
91 throw new HTTPException\UnauthorizedException(DI::l10n()->t('Permission denied.'));
96 if (!empty($a->user['uid']) && $a->user['uid'] != api_user()) {
97 throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
101 public static function put(array $parameters = [])
104 throw new HTTPException\UnauthorizedException(DI::l10n()->t('Permission denied.'));
109 if (!empty($a->user['uid']) && $a->user['uid'] != api_user()) {
110 throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
115 * Quit execution with the message that the endpoint isn't implemented
117 * @param string $method
120 public static function unsupported(string $method = 'all')
122 $path = DI::args()->getQueryString();
123 Logger::info('Unimplemented API call', ['method' => $method, 'path' => $path, 'agent' => $_SERVER['HTTP_USER_AGENT'] ?? '', 'request' => HTTPInputData::process()]);
124 $error = DI::l10n()->t('API endpoint %s %s is not implemented', strtoupper($method), $path);
125 $error_description = DI::l10n()->t('The API endpoint is currently not implemented but might be in the future.');
126 $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
127 System::jsonError(501, $errorobj->toArray());
131 * Processes data from GET requests and sets defaults
133 * @return array request data
135 public static function getRequest(array $defaults)
137 $httpinput = HTTPInputData::process();
138 $input = array_merge($httpinput['variables'], $httpinput['files'], $_REQUEST);
142 foreach ($defaults as $parameter => $defaultvalue) {
143 if (is_string($defaultvalue)) {
144 $request[$parameter] = $input[$parameter] ?? $defaultvalue;
145 } elseif (is_int($defaultvalue)) {
146 $request[$parameter] = (int)($input[$parameter] ?? $defaultvalue);
147 } elseif (is_float($defaultvalue)) {
148 $request[$parameter] = (float)($input[$parameter] ?? $defaultvalue);
149 } elseif (is_array($defaultvalue)) {
150 $request[$parameter] = $input[$parameter] ?? [];
151 } elseif (is_bool($defaultvalue)) {
152 $request[$parameter] = in_array(strtolower($input[$parameter] ?? ''), ['true', '1']);
154 Logger::notice('Unhandled default value type', ['parameter' => $parameter, 'type' => gettype($defaultvalue)]);
158 foreach ($input ?? [] as $parameter => $value) {
159 if ($parameter == 'pagename') {
162 if (!in_array($parameter, array_keys($defaults))) {
163 Logger::notice('Unhandled request field', ['parameter' => $parameter, 'value' => $value, 'command' => DI::args()->getCommand()]);
167 Logger::debug('Got request parameters', ['request' => $request, 'command' => DI::args()->getCommand()]);
172 * @deprecated Use checkAllowedScope instead
173 * Log in user via OAuth or Basic HTTP Auth.
175 * @param string $scope the requested scope (read, write, follow)
177 protected static function login(string $scope)
179 self::checkAllowedScope($scope);
183 * Get current application token
185 * @return array token
187 protected 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();
241 * Get user info array.
243 * @param int|string $contact_id Contact ID or URL
245 * @throws HTTPException\BadRequestException
246 * @throws HTTPException\InternalServerErrorException
247 * @throws HTTPException\UnauthorizedException
248 * @throws \ImagickException
250 protected static function getUser($contact_id = null)
252 return api_get_user(DI::app(), $contact_id);
256 * Formats the data according to the data type
258 * @param string $root_element
259 * @param array $data An array with a single element containing the returned result
260 * @return false|string
262 protected static function format(string $root_element, array $data)
264 $return = api_format_data($root_element, self::$format, $data);
266 switch (self::$format) {
268 header("Content-Type: text/xml");
271 header("Content-Type: application/json");
272 if (!empty($return)) {
273 $json = json_encode(end($return));
274 if (!empty($_GET['callback'])) {
275 $json = $_GET['callback'] . "(" . $json . ")";
281 header("Content-Type: application/rss+xml");
282 $return = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $return;
285 header("Content-Type: application/atom+xml");
286 $return = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $return;
294 * Creates the XML from a JSON style array
297 * @param $root_element
300 protected static function createXml($data, $root_element)
302 return api_create_xml($data, $root_element);