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;
27 use Friendica\Database\Database;
28 use Friendica\Database\DBA;
30 use Friendica\Network\HTTPException;
31 use Friendica\Util\DateTimeFormat;
33 require_once __DIR__ . '/../../include/api.php';
35 class BaseApi extends BaseModule
38 * @var string json|xml|rss|atom
40 protected static $format = 'json';
44 protected static $current_user_id;
46 public static function init(array $parameters = [])
48 $arguments = DI::args();
50 if (substr($arguments->getCommand(), -4) === '.xml') {
51 self::$format = 'xml';
53 if (substr($arguments->getCommand(), -4) === '.rss') {
54 self::$format = 'rss';
56 if (substr($arguments->getCommand(), -4) === '.atom') {
57 self::$format = 'atom';
61 public static function delete(array $parameters = [])
64 throw new HTTPException\UnauthorizedException(DI::l10n()->t('Permission denied.'));
69 if (!empty($a->user['uid']) && $a->user['uid'] != api_user()) {
70 throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
74 public static function patch(array $parameters = [])
77 throw new HTTPException\UnauthorizedException(DI::l10n()->t('Permission denied.'));
82 if (!empty($a->user['uid']) && $a->user['uid'] != api_user()) {
83 throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
87 public static function post(array $parameters = [])
90 throw new HTTPException\UnauthorizedException(DI::l10n()->t('Permission denied.'));
95 if (!empty($a->user['uid']) && $a->user['uid'] != api_user()) {
96 throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
100 public static function put(array $parameters = [])
103 throw new HTTPException\UnauthorizedException(DI::l10n()->t('Permission denied.'));
108 if (!empty($a->user['uid']) && $a->user['uid'] != api_user()) {
109 throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
113 public static function unsupported(string $method = 'all')
115 $path = DI::args()->getQueryString();
116 Logger::info('Unimplemented API call', ['method' => $method, 'path' => $path, 'agent' => $_SERVER['HTTP_USER_AGENT'] ?? '', 'request' => $_REQUEST ?? []]);
117 $error = DI::l10n()->t('API endpoint %s %s is not implemented', strtoupper($method), $path);
118 $error_description = DI::l10n()->t('The API endpoint is currently not implemented but might be in the future.');;
119 $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
120 System::jsonError(501, $errorobj->toArray());
124 * Log in user via OAuth1 or Simple HTTP Auth.
126 * Simple Auth allow username in form of <pre>user@server</pre>, ignoring server part
128 * @return bool Was a user authenticated?
129 * @throws HTTPException\ForbiddenException
130 * @throws HTTPException\UnauthorizedException
131 * @throws HTTPException\InternalServerErrorException
132 * @hook 'authenticate'
134 * 'username' => username from login form
135 * 'password' => password from login form
136 * 'authenticated' => return status,
137 * 'user_record' => return authenticated user record
139 protected static function login()
141 $authorization = $_SERVER['HTTP_AUTHORIZATION'] ?? '';
142 $authorization = $_SERVER['AUTHORIZATION'] ?? $authorization;
144 if (self::checkBearer($authorization)) {
145 self::$current_user_id = self::getUserByBearer($authorization);
146 return (bool)self::$current_user_id;
149 api_login(DI::app());
151 self::$current_user_id = api_user();
153 return (bool)self::$current_user_id;
157 * Get current user id, returns 0 if not logged in
159 * @return int User ID
161 protected static function getCurrentUserID()
163 $authorization = $_SERVER['HTTP_AUTHORIZATION'] ?? '';
164 $authorization = $_SERVER['AUTHORIZATION'] ?? $authorization;
166 if (self::checkBearer($authorization)) {
167 self::$current_user_id = self::getUserByBearer($authorization);
168 return (int)self::$current_user_id;
171 if (is_null(self::$current_user_id)) {
172 api_login(DI::app(), false);
174 self::$current_user_id = api_user();
177 return (int)self::$current_user_id;
180 private static function checkBearer(string $authorization)
182 return(strpos($authorization, 'Bearer ') !== false);
185 private static function getUserByBearer(string $authorization)
187 $bearer = trim(substr($authorization, 6));
188 $condition = ['access_token' => $bearer];
189 $token = DBA::selectFirst('application-token', ['uid'], $condition);
190 if (!DBA::isResult($token)) {
191 Logger::warning('Token not found', $condition);
194 Logger::info('Token found', $token);
195 return $token['uid'];
198 public static function getApplication()
200 $redirect_uri = !isset($_REQUEST['redirect_uri']) ? '' : $_REQUEST['redirect_uri'];
201 $client_id = !isset($_REQUEST['client_id']) ? '' : $_REQUEST['client_id'];
203 if (empty($redirect_uri) || empty($client_id)) {
204 Logger::warning('Incomplete request');
208 $condition = ['redirect_uri' => $redirect_uri, 'client_id' => $client_id];
209 $application = DBA::selectFirst('application', [], $condition);
210 if (!DBA::isResult($application)) {
211 Logger::warning('Application not found', $condition);
217 public static function getTokenForUser(array $application, int $uid)
219 $code = bin2hex(openssl_random_pseudo_bytes(32));
220 $access_token = bin2hex(openssl_random_pseudo_bytes(32));
222 $fields = ['application-id' => $application['id'], 'uid' => $uid, 'code' => $code, 'access_token' => $access_token, 'created_at' => DateTimeFormat::utcNow(DateTimeFormat::MYSQL)];
223 if (!DBA::insert('application-token', $fields, Database::INSERT_UPDATE)) {
227 return DBA::selectFirst('application-token', [], ['application-id' => $application['id'], 'uid' => $uid]);
230 * Get user info array.
232 * @param int|string $contact_id Contact ID or URL
234 * @throws HTTPException\BadRequestException
235 * @throws HTTPException\InternalServerErrorException
236 * @throws HTTPException\UnauthorizedException
237 * @throws \ImagickException
239 protected static function getUser($contact_id = null)
241 return api_get_user(DI::app(), $contact_id);
245 * Formats the data according to the data type
247 * @param string $root_element
248 * @param array $data An array with a single element containing the returned result
249 * @return false|string
251 protected static function format(string $root_element, array $data)
253 $return = api_format_data($root_element, self::$format, $data);
255 switch (self::$format) {
257 header("Content-Type: text/xml");
260 header("Content-Type: application/json");
261 if (!empty($return)) {
262 $json = json_encode(end($return));
263 if (!empty($_GET['callback'])) {
264 $json = $_GET['callback'] . "(" . $json . ")";
270 header("Content-Type: application/rss+xml");
271 $return = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $return;
274 header("Content-Type: application/atom+xml");
275 $return = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $return;
283 * Creates the XML from a JSON style array
286 * @param $root_element
289 protected static function createXml($data, $root_element)
291 return api_create_xml($data, $root_element);