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.'));
114 * Quit execution with the message that the endpoint isn't implemented
116 * @param string $method
119 public static function unsupported(string $method = 'all')
121 $path = DI::args()->getQueryString();
122 Logger::info('Unimplemented API call', ['method' => $method, 'path' => $path, 'agent' => $_SERVER['HTTP_USER_AGENT'] ?? '', 'request' => $_REQUEST ?? []]);
123 $error = DI::l10n()->t('API endpoint %s %s is not implemented', strtoupper($method), $path);
124 $error_description = DI::l10n()->t('The API endpoint is currently not implemented but might be in the future.');
125 $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
126 System::jsonError(501, $errorobj->toArray());
130 * Log in user via OAuth1 or Simple HTTP Auth.
132 * Simple Auth allow username in form of <pre>user@server</pre>, ignoring server part
134 * @return bool Was a user authenticated?
135 * @throws HTTPException\ForbiddenException
136 * @throws HTTPException\UnauthorizedException
137 * @throws HTTPException\InternalServerErrorException
138 * @hook 'authenticate'
140 * 'username' => username from login form
141 * 'password' => password from login form
142 * 'authenticated' => return status,
143 * 'user_record' => return authenticated user record
145 protected static function login()
147 if (empty(self::$current_user_id)) {
148 self::$current_user_id = self::getUserByBearer();
151 if (empty(self::$current_user_id)) {
152 // The execution stops here if no one is logged in
153 api_login(DI::app());
156 self::$current_user_id = api_user();
158 return (bool)self::$current_user_id;
162 * Get current user id, returns 0 if not logged in
164 * @return int User ID
166 protected static function getCurrentUserID()
168 if (empty(self::$current_user_id)) {
169 self::$current_user_id = self::getUserByBearer();
172 if (empty(self::$current_user_id)) {
173 // Fetch the user id if logged in - but don't fail if not
174 api_login(DI::app(), false);
176 self::$current_user_id = api_user();
179 return (int)self::$current_user_id;
183 * Get the user id via the Bearer token
185 * @return int User-ID
187 private static function getUserByBearer()
189 $authorization = $_SERVER['HTTP_AUTHORIZATION'] ?? '';
191 if (substr($authorization, 0, 7) != 'Bearer ') {
195 $bearer = trim(substr($authorization, 7));
196 $condition = ['access_token' => $bearer];
197 $token = DBA::selectFirst('application-token', ['uid'], $condition);
198 if (!DBA::isResult($token)) {
199 Logger::warning('Token not found', $condition);
202 Logger::info('Token found', $token);
203 return $token['uid'];
207 * Get the application record via the proved request header fields
209 * @return array application record
211 public static function getApplication()
213 $redirect_uri = $_REQUEST['redirect_uri'] ?? '';
214 $client_id = $_REQUEST['client_id'] ?? '';
215 $client_secret = $_REQUEST['client_secret'] ?? '';
217 if ((empty($redirect_uri) && empty($client_secret)) || empty($client_id)) {
218 Logger::warning('Incomplete request', ['request' => $_REQUEST]);
222 $condition = ['client_id' => $client_id];
223 if (!empty($client_secret)) {
224 $condition['client_secret'] = $client_secret;
226 if (!empty($redirect_uri)) {
227 $condition['redirect_uri'] = $redirect_uri;
230 $application = DBA::selectFirst('application', [], $condition);
231 if (!DBA::isResult($application)) {
232 Logger::warning('Application not found', $condition);
239 * Check if an token for the application and user exists
241 * @param array $application
242 * @param integer $uid
245 public static function existsTokenForUser(array $application, int $uid)
247 return DBA::exists('application-token', ['application-id' => $application['id'], 'uid' => $uid]);
251 * Fetch the token for the given application and user
253 * @param array $application
254 * @param integer $uid
255 * @return array application record
257 public static function getTokenForUser(array $application, int $uid)
259 return DBA::selectFirst('application-token', [], ['application-id' => $application['id'], 'uid' => $uid]);
263 * Create and fetch an token for the application and user
265 * @param array $application
266 * @param integer $uid
267 * @return array application record
269 public static function createTokenForUser(array $application, int $uid)
271 $code = bin2hex(random_bytes(32));
272 $access_token = bin2hex(random_bytes(32));
274 $fields = ['application-id' => $application['id'], 'uid' => $uid, 'code' => $code, 'access_token' => $access_token, 'created_at' => DateTimeFormat::utcNow(DateTimeFormat::MYSQL)];
275 if (!DBA::insert('application-token', $fields, Database::INSERT_UPDATE)) {
279 return DBA::selectFirst('application-token', [], ['application-id' => $application['id'], 'uid' => $uid]);
283 * Get user info array.
285 * @param int|string $contact_id Contact ID or URL
287 * @throws HTTPException\BadRequestException
288 * @throws HTTPException\InternalServerErrorException
289 * @throws HTTPException\UnauthorizedException
290 * @throws \ImagickException
292 protected static function getUser($contact_id = null)
294 return api_get_user(DI::app(), $contact_id);
298 * Formats the data according to the data type
300 * @param string $root_element
301 * @param array $data An array with a single element containing the returned result
302 * @return false|string
304 protected static function format(string $root_element, array $data)
306 $return = api_format_data($root_element, self::$format, $data);
308 switch (self::$format) {
310 header("Content-Type: text/xml");
313 header("Content-Type: application/json");
314 if (!empty($return)) {
315 $json = json_encode(end($return));
316 if (!empty($_GET['callback'])) {
317 $json = $_GET['callback'] . "(" . $json . ")";
323 header("Content-Type: application/rss+xml");
324 $return = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $return;
327 header("Content-Type: application/atom+xml");
328 $return = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $return;
336 * Creates the XML from a JSON style array
339 * @param $root_element
342 protected static function createXml($data, $root_element)
344 return api_create_xml($data, $root_element);