friendica-github/src/Module/BaseApi.php

345 lines
9.4 KiB
PHP
Raw Normal View History

2019-12-05 13:12:59 +00:00
<?php
2020-02-09 14:45:36 +00:00
/**
2021-03-29 06:40:20 +00:00
* @copyright Copyright (C) 2010-2021, the Friendica project
2020-02-09 14:45:36 +00:00
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
*/
2019-12-05 13:12:59 +00:00
2020-01-28 02:18:42 +00:00
namespace Friendica\Module;
2019-12-05 13:12:59 +00:00
2021-05-13 11:26:56 +00:00
use Exception;
2019-12-05 13:12:59 +00:00
use Friendica\BaseModule;
2021-05-08 09:14:19 +00:00
use Friendica\Core\Logger;
use Friendica\Core\System;
2021-05-11 06:30:20 +00:00
use Friendica\Database\Database;
use Friendica\Database\DBA;
use Friendica\DI;
2019-12-05 13:12:59 +00:00
use Friendica\Network\HTTPException;
2021-05-11 08:16:40 +00:00
use Friendica\Util\DateTimeFormat;
2019-12-05 13:12:59 +00:00
2020-01-28 02:18:42 +00:00
require_once __DIR__ . '/../../include/api.php';
2019-12-05 13:12:59 +00:00
2020-01-28 02:18:42 +00:00
class BaseApi extends BaseModule
2019-12-05 13:12:59 +00:00
{
/**
* @var string json|xml|rss|atom
*/
protected static $format = 'json';
/**
* @var bool|int
*/
protected static $current_user_id;
public static function init(array $parameters = [])
{
$arguments = DI::args();
2019-12-05 13:12:59 +00:00
if (substr($arguments->getCommand(), -4) === '.xml') {
2019-12-05 13:12:59 +00:00
self::$format = 'xml';
}
if (substr($arguments->getCommand(), -4) === '.rss') {
2019-12-05 13:12:59 +00:00
self::$format = 'rss';
}
if (substr($arguments->getCommand(), -4) === '.atom') {
2019-12-05 13:12:59 +00:00
self::$format = 'atom';
}
}
2021-05-08 09:14:19 +00:00
public static function delete(array $parameters = [])
{
if (!api_user()) {
throw new HTTPException\UnauthorizedException(DI::l10n()->t('Permission denied.'));
}
$a = DI::app();
if (!empty($a->user['uid']) && $a->user['uid'] != api_user()) {
throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
}
}
public static function patch(array $parameters = [])
{
if (!api_user()) {
throw new HTTPException\UnauthorizedException(DI::l10n()->t('Permission denied.'));
}
$a = DI::app();
if (!empty($a->user['uid']) && $a->user['uid'] != api_user()) {
throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
}
}
2019-12-05 13:12:59 +00:00
public static function post(array $parameters = [])
{
if (!api_user()) {
throw new HTTPException\UnauthorizedException(DI::l10n()->t('Permission denied.'));
2019-12-05 13:12:59 +00:00
}
$a = DI::app();
2019-12-05 13:12:59 +00:00
if (!empty($a->user['uid']) && $a->user['uid'] != api_user()) {
throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
2019-12-05 13:12:59 +00:00
}
}
2021-05-08 09:14:19 +00:00
public static function put(array $parameters = [])
{
if (!api_user()) {
throw new HTTPException\UnauthorizedException(DI::l10n()->t('Permission denied.'));
}
$a = DI::app();
if (!empty($a->user['uid']) && $a->user['uid'] != api_user()) {
throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
}
}
2021-05-12 12:08:30 +00:00
/**
* Quit execution with the message that the endpoint isn't implemented
*
* @param string $method
* @return void
*/
2021-05-08 09:14:19 +00:00
public static function unsupported(string $method = 'all')
{
$path = DI::args()->getQueryString();
2021-05-11 06:30:20 +00:00
Logger::info('Unimplemented API call', ['method' => $method, 'path' => $path, 'agent' => $_SERVER['HTTP_USER_AGENT'] ?? '', 'request' => $_REQUEST ?? []]);
$error = DI::l10n()->t('API endpoint %s %s is not implemented', strtoupper($method), $path);
2021-05-12 12:08:30 +00:00
$error_description = DI::l10n()->t('The API endpoint is currently not implemented but might be in the future.');
2021-05-08 09:14:19 +00:00
$errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
System::jsonError(501, $errorobj->toArray());
}
2019-12-05 13:12:59 +00:00
/**
* Log in user via OAuth1 or Simple HTTP Auth.
*
2020-01-19 06:05:23 +00:00
* Simple Auth allow username in form of <pre>user@server</pre>, ignoring server part
2019-12-05 13:12:59 +00:00
*
* @return bool Was a user authenticated?
2019-12-05 13:12:59 +00:00
* @throws HTTPException\ForbiddenException
* @throws HTTPException\UnauthorizedException
* @throws HTTPException\InternalServerErrorException
* @hook 'authenticate'
* array $addon_auth
* 'username' => username from login form
* 'password' => password from login form
* 'authenticated' => return status,
* 'user_record' => return authenticated user record
*/
protected static function login()
{
if (empty(self::$current_user_id)) {
self::$current_user_id = self::getUserByBearer();
2021-05-11 06:30:20 +00:00
}
if (empty(self::$current_user_id)) {
2021-05-12 12:08:30 +00:00
// The execution stops here if no one is logged in
api_login(DI::app());
}
2019-12-05 13:12:59 +00:00
self::$current_user_id = api_user();
return (bool)self::$current_user_id;
2019-12-05 13:12:59 +00:00
}
/**
* Get current user id, returns 0 if not logged in
*
* @return int User ID
*/
protected static function getCurrentUserID()
{
if (empty(self::$current_user_id)) {
self::$current_user_id = self::getUserByBearer();
2021-05-11 06:30:20 +00:00
}
if (empty(self::$current_user_id)) {
2021-05-12 12:08:30 +00:00
// Fetch the user id if logged in - but don't fail if not
api_login(DI::app(), false);
self::$current_user_id = api_user();
}
return (int)self::$current_user_id;
}
2021-05-12 12:08:30 +00:00
/**
* Get the user id via the Bearer token
*
* @return int User-ID
*/
private static function getUserByBearer()
2021-05-11 06:30:20 +00:00
{
$authorization = $_SERVER['HTTP_AUTHORIZATION'] ?? '';
2021-05-11 06:30:20 +00:00
if (substr($authorization, 0, 7) != 'Bearer ') {
return 0;
}
$bearer = trim(substr($authorization, 7));
2021-05-11 06:30:20 +00:00
$condition = ['access_token' => $bearer];
$token = DBA::selectFirst('application-token', ['uid'], $condition);
if (!DBA::isResult($token)) {
Logger::warning('Token not found', $condition);
return 0;
}
Logger::info('Token found', $token);
return $token['uid'];
}
2021-05-12 12:08:30 +00:00
/**
* Get the application record via the proved request header fields
*
2021-05-13 11:33:07 +00:00
* @param string $client_id
* @param string $client_secret
* @param string $redirect_uri
2021-05-12 12:08:30 +00:00
* @return array application record
*/
2021-05-13 11:26:56 +00:00
public static function getApplication(string $client_id, string $client_secret, string $redirect_uri)
2021-05-11 06:30:20 +00:00
{
2021-05-12 05:30:21 +00:00
$condition = ['client_id' => $client_id];
if (!empty($client_secret)) {
$condition['client_secret'] = $client_secret;
}
if (!empty($redirect_uri)) {
$condition['redirect_uri'] = $redirect_uri;
}
2021-05-11 06:30:20 +00:00
$application = DBA::selectFirst('application', [], $condition);
if (!DBA::isResult($application)) {
Logger::warning('Application not found', $condition);
return [];
}
return $application;
}
2021-05-12 12:08:30 +00:00
/**
* Check if an token for the application and user exists
*
* @param array $application
* @param integer $uid
* @return boolean
*/
public static function existsTokenForUser(array $application, int $uid)
{
return DBA::exists('application-token', ['application-id' => $application['id'], 'uid' => $uid]);
}
2021-05-12 12:08:30 +00:00
/**
* Fetch the token for the given application and user
*
* @param array $application
* @param integer $uid
* @return array application record
*/
2021-05-11 06:30:20 +00:00
public static function getTokenForUser(array $application, int $uid)
{
return DBA::selectFirst('application-token', [], ['application-id' => $application['id'], 'uid' => $uid]);
}
2021-05-12 12:08:30 +00:00
/**
* Create and fetch an token for the application and user
*
2021-05-13 11:26:56 +00:00
* @param array $application
2021-05-12 12:08:30 +00:00
* @param integer $uid
2021-05-13 11:26:56 +00:00
* @param string $scope
2021-05-12 12:08:30 +00:00
* @return array application record
*/
2021-05-13 11:26:56 +00:00
public static function createTokenForUser(array $application, int $uid, string $scope)
2021-05-11 06:30:20 +00:00
{
$code = bin2hex(random_bytes(32));
$access_token = bin2hex(random_bytes(32));
2021-05-11 06:30:20 +00:00
2021-05-13 11:26:56 +00:00
// @todo store the scope
2021-05-11 08:16:40 +00:00
$fields = ['application-id' => $application['id'], 'uid' => $uid, 'code' => $code, 'access_token' => $access_token, 'created_at' => DateTimeFormat::utcNow(DateTimeFormat::MYSQL)];
2021-05-11 06:30:20 +00:00
if (!DBA::insert('application-token', $fields, Database::INSERT_UPDATE)) {
return [];
}
return DBA::selectFirst('application-token', [], ['application-id' => $application['id'], 'uid' => $uid]);
}
2019-12-05 13:12:59 +00:00
/**
2020-01-19 06:05:23 +00:00
* Get user info array.
2019-12-05 13:12:59 +00:00
*
* @param int|string $contact_id Contact ID or URL
* @return array|bool
* @throws HTTPException\BadRequestException
* @throws HTTPException\InternalServerErrorException
* @throws HTTPException\UnauthorizedException
* @throws \ImagickException
*/
protected static function getUser($contact_id = null)
{
return api_get_user(DI::app(), $contact_id);
2019-12-05 13:12:59 +00:00
}
/**
* Formats the data according to the data type
*
* @param string $root_element
* @param array $data An array with a single element containing the returned result
* @return false|string
*/
protected static function format(string $root_element, array $data)
2019-12-05 13:12:59 +00:00
{
$return = api_format_data($root_element, self::$format, $data);
2019-12-05 13:12:59 +00:00
switch (self::$format) {
case "xml":
header("Content-Type: text/xml");
2019-12-05 13:12:59 +00:00
break;
case "json":
header("Content-Type: application/json");
if (!empty($return)) {
$json = json_encode(end($return));
if (!empty($_GET['callback'])) {
$json = $_GET['callback'] . "(" . $json . ")";
}
$return = $json;
}
break;
case "rss":
header("Content-Type: application/rss+xml");
$return = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $return;
break;
case "atom":
header("Content-Type: application/atom+xml");
$return = '<?xml version="1.0" encoding="UTF-8"?>' . "\n" . $return;
2019-12-05 13:12:59 +00:00
break;
}
2021-05-11 06:30:20 +00:00
return $return;
}
2019-12-05 13:12:59 +00:00
/**
* Creates the XML from a JSON style array
*
* @param $data
* @param $root_element
* @return string
*/
protected static function createXml($data, $root_element)
{
return api_create_xml($data, $root_element);
2019-12-05 13:12:59 +00:00
}
}