friendica/src/Module/BaseApi.php

305 lines
8.5 KiB
PHP
Raw Normal View History

2019-12-05 08:12:59 -05:00
<?php
2020-02-09 09:45:36 -05:00
/**
2021-03-29 02:40:20 -04:00
* @copyright Copyright (C) 2010-2021, the Friendica project
2020-02-09 09:45:36 -05: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 08:12:59 -05:00
2020-01-27 21:18:42 -05:00
namespace Friendica\Module;
2019-12-05 08:12:59 -05:00
use Friendica\BaseModule;
2021-05-08 05:14:19 -04:00
use Friendica\Core\Logger;
use Friendica\Core\System;
use Friendica\DI;
2019-12-05 08:12:59 -05:00
use Friendica\Network\HTTPException;
use Friendica\Security\BasicAuth;
use Friendica\Security\OAuth;
use Friendica\Util\HTTPInputData;
2019-12-05 08:12:59 -05:00
2020-01-27 21:18:42 -05:00
require_once __DIR__ . '/../../include/api.php';
2019-12-05 08:12:59 -05:00
2020-01-27 21:18:42 -05:00
class BaseApi extends BaseModule
2019-12-05 08:12:59 -05:00
{
/** @deprecated Use OAuth class constant */
2021-05-16 03:37:11 -04:00
const SCOPE_READ = 'read';
/** @deprecated Use OAuth class constant */
2021-05-16 03:37:11 -04:00
const SCOPE_WRITE = 'write';
/** @deprecated Use OAuth class constant */
2021-05-16 03:37:11 -04:00
const SCOPE_FOLLOW = 'follow';
/** @deprecated Use OAuth class constant */
2021-05-16 03:37:11 -04:00
const SCOPE_PUSH = 'push';
2019-12-05 08:12:59 -05:00
/**
* @var string json|xml|rss|atom
*/
protected static $format = 'json';
public static function init(array $parameters = [])
{
$arguments = DI::args();
2019-12-05 08:12:59 -05:00
if (substr($arguments->getCommand(), -4) === '.xml') {
2019-12-05 08:12:59 -05:00
self::$format = 'xml';
}
if (substr($arguments->getCommand(), -4) === '.rss') {
2019-12-05 08:12:59 -05:00
self::$format = 'rss';
}
if (substr($arguments->getCommand(), -4) === '.atom') {
2019-12-05 08:12:59 -05:00
self::$format = 'atom';
}
}
2021-05-08 05:14:19 -04: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 08:12:59 -05:00
public static function post(array $parameters = [])
{
if (!api_user()) {
throw new HTTPException\UnauthorizedException(DI::l10n()->t('Permission denied.'));
2019-12-05 08:12:59 -05:00
}
$a = DI::app();
2019-12-05 08:12:59 -05:00
if (!empty($a->user['uid']) && $a->user['uid'] != api_user()) {
throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
2019-12-05 08:12:59 -05:00
}
}
2021-05-08 05:14:19 -04: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 08:08:30 -04:00
/**
* Quit execution with the message that the endpoint isn't implemented
*
* @param string $method
* @return void
*/
2021-05-08 05:14:19 -04:00
public static function unsupported(string $method = 'all')
{
$path = DI::args()->getQueryString();
Logger::info('Unimplemented API call', ['method' => $method, 'path' => $path, 'agent' => $_SERVER['HTTP_USER_AGENT'] ?? '', 'request' => HTTPInputData::process()]);
$error = DI::l10n()->t('API endpoint %s %s is not implemented', strtoupper($method), $path);
2021-05-12 08:08:30 -04:00
$error_description = DI::l10n()->t('The API endpoint is currently not implemented but might be in the future.');
2021-05-08 05:14:19 -04:00
$errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
System::jsonError(501, $errorobj->toArray());
}
/**
* Processes data from GET requests and sets defaults
*
* @return array request data
*/
2021-05-29 06:40:47 -04:00
public static function getRequest(array $defaults)
{
$httpinput = HTTPInputData::process();
$input = array_merge($httpinput['variables'], $httpinput['files'], $_REQUEST);
$request = [];
foreach ($defaults as $parameter => $defaultvalue) {
if (is_string($defaultvalue)) {
$request[$parameter] = $input[$parameter] ?? $defaultvalue;
} elseif (is_int($defaultvalue)) {
$request[$parameter] = (int)($input[$parameter] ?? $defaultvalue);
} elseif (is_float($defaultvalue)) {
$request[$parameter] = (float)($input[$parameter] ?? $defaultvalue);
} elseif (is_array($defaultvalue)) {
$request[$parameter] = $input[$parameter] ?? [];
} elseif (is_bool($defaultvalue)) {
$request[$parameter] = in_array(strtolower($input[$parameter] ?? ''), ['true', '1']);
} else {
Logger::notice('Unhandled default value type', ['parameter' => $parameter, 'type' => gettype($defaultvalue)]);
}
}
foreach ($input ?? [] as $parameter => $value) {
if ($parameter == 'pagename') {
continue;
}
if (!in_array($parameter, array_keys($defaults))) {
Logger::notice('Unhandled request field', ['parameter' => $parameter, 'value' => $value, 'command' => DI::args()->getCommand()]);
}
}
Logger::debug('Got request parameters', ['request' => $request, 'command' => DI::args()->getCommand()]);
return $request;
}
2019-12-05 08:12:59 -05:00
/**
* Log in user via OAuth1 or Simple HTTP Auth.
*
2020-01-19 01:05:23 -05:00
* Simple Auth allow username in form of <pre>user@server</pre>, ignoring server part
2019-12-05 08:12:59 -05:00
*
2021-05-16 03:37:11 -04:00
* @param string $scope the requested scope (read, write, follow)
*
2019-12-05 08:12:59 -05: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
*/
2021-05-16 03:37:11 -04:00
protected static function login(string $scope)
2019-12-05 08:12:59 -05:00
{
$token = OAuth::getCurrentApplicationToken();
if (!empty($token)) {
if (!OAuth::isAllowedScope($scope)) {
2021-05-16 03:37:11 -04:00
DI::mstdnError()->Forbidden();
}
$uid = OAuth::getCurrentUserID();
2021-05-16 03:37:11 -04:00
}
if (empty($uid)) {
2021-05-12 08:08:30 -04:00
// The execution stops here if no one is logged in
BasicAuth::getCurrentUserID(true);
}
2019-12-05 08:12:59 -05:00
}
2021-05-15 18:40:57 -04:00
/**
* Get current application token
2021-05-15 18:40:57 -04:00
*
* @return array token
*/
protected static function getCurrentApplication()
{
$token = OAuth::getCurrentApplicationToken();
2021-05-11 02:30:20 -04:00
if (empty($token)) {
$token = BasicAuth::getCurrentApplicationToken();
}
2021-05-15 18:40:57 -04:00
return $token;
2021-05-11 02:30:20 -04:00
}
2021-05-12 08:08:30 -04:00
/**
* Get current user id, returns 0 if not logged in
2021-05-12 08:08:30 -04:00
*
* @return int User ID
2021-05-12 08:08:30 -04:00
*/
public static function getCurrentUserID()
2021-05-11 02:30:20 -04:00
{
$uid = OAuth::getCurrentUserID();
if (empty($uid)) {
$uid = BasicAuth::getCurrentUserID(false);
2021-05-11 02:30:20 -04:00
}
return (int)$uid;
2021-05-11 02:30:20 -04:00
}
2019-12-05 08:12:59 -05:00
/**
2020-01-19 01:05:23 -05:00
* Get user info array.
2019-12-05 08:12:59 -05: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 08:12:59 -05: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 08:12:59 -05:00
{
$return = api_format_data($root_element, self::$format, $data);
2019-12-05 08:12:59 -05:00
switch (self::$format) {
case "xml":
header("Content-Type: text/xml");
2019-12-05 08:12:59 -05: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 08:12:59 -05:00
break;
}
2021-05-11 02:30:20 -04:00
return $return;
}
2019-12-05 08:12:59 -05: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 08:12:59 -05:00
}
}