<?php
/**
- * @copyright Copyright (C) 2010-2021, the Friendica project
+ * @copyright Copyright (C) 2010-2022, the Friendica project
*
* @license GNU AGPL version 3 or any later version
*
namespace Friendica\Module;
+use Friendica\App;
+use Friendica\App\Router;
use Friendica\BaseModule;
+use Friendica\Core\L10n;
use Friendica\Core\Logger;
use Friendica\Core\System;
use Friendica\DI;
+use Friendica\Model\Contact;
use Friendica\Model\Post;
+use Friendica\Model\User;
+use Friendica\Module\Api\ApiResponse;
use Friendica\Network\HTTPException;
use Friendica\Security\BasicAuth;
use Friendica\Security\OAuth;
-use Friendica\Util\Arrays;
use Friendica\Util\DateTimeFormat;
-use Friendica\Util\HTTPInputData;
-use Friendica\Util\XML;
-
-require_once __DIR__ . '/../../include/api.php';
+use Friendica\Util\Profiler;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Log\LoggerInterface;
class BaseApi extends BaseModule
{
+ const LOG_PREFIX = 'API {action} - ';
+
const SCOPE_READ = 'read';
const SCOPE_WRITE = 'write';
const SCOPE_FOLLOW = 'follow';
*/
protected static $request = [];
- public static function delete(array $parameters = [])
- {
- self::checkAllowedScope(self::SCOPE_WRITE);
+ /** @var App */
+ protected $app;
- if (!DI::app()->isLoggedIn()) {
- throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
- }
- }
+ /** @var ApiResponse */
+ protected $response;
- public static function patch(array $parameters = [])
+ public function __construct(App $app, L10n $l10n, App\BaseURL $baseUrl, App\Arguments $args, LoggerInterface $logger, Profiler $profiler, ApiResponse $response, array $server, array $parameters = [])
{
- self::checkAllowedScope(self::SCOPE_WRITE);
+ parent::__construct($l10n, $baseUrl, $args, $logger, $profiler, $response, $server, $parameters);
- if (!DI::app()->isLoggedIn()) {
- throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
- }
- }
-
- public static function post(array $parameters = [])
- {
- self::checkAllowedScope(self::SCOPE_WRITE);
-
- if (!DI::app()->isLoggedIn()) {
- throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
- }
- }
-
- public static function put(array $parameters = [])
- {
- self::checkAllowedScope(self::SCOPE_WRITE);
-
- if (!DI::app()->isLoggedIn()) {
- throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
- }
+ $this->app = $app;
}
/**
- * Quit execution with the message that the endpoint isn't implemented
+ * Additionally checks, if the caller is permitted to do this action
*
- * @param string $method
- * @return void
+ * {@inheritDoc}
+ *
+ * @throws HTTPException\ForbiddenException
*/
- public static function unsupported(string $method = 'all')
+ public function run(array $request = [], bool $scopecheck = true): ResponseInterface
{
- $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);
- $error_description = DI::l10n()->t('The API endpoint is currently not implemented but might be in the future.');
- $errorobj = new \Friendica\Object\Api\Mastodon\Error($error, $error_description);
- System::jsonError(501, $errorobj->toArray());
+ if ($scopecheck) {
+ switch ($this->args->getMethod()) {
+ case Router::DELETE:
+ case Router::PATCH:
+ case Router::POST:
+ case Router::PUT:
+ self::checkAllowedScope(self::SCOPE_WRITE);
+
+ if (!self::getCurrentUserID()) {
+ throw new HTTPException\ForbiddenException($this->t('Permission denied.'));
+ }
+ break;
+ }
+ }
+
+ return parent::run($request);
}
/**
* Processes data from GET requests and sets defaults
*
+ * @param array $defaults Associative array of expected request keys and their default typed value. A null
+ * value will remove the request key from the resulting value array.
+ * @param array $request Custom REQUEST array, superglobal instead
* @return array request data
+ * @throws \Exception
*/
- public static function getRequest(array $defaults)
+ public function getRequest(array $defaults, array $request): array
{
- $httpinput = HTTPInputData::process();
- $input = array_merge($httpinput['variables'], $httpinput['files'], $_REQUEST);
-
- self::$request = $input;
+ self::$request = $request;
self::$boundaries = [];
unset(self::$request['pagename']);
- $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;
+ return $this->checkDefaults($defaults, $request);
}
/**
* Set boundaries for the "link" header
* @param array $boundaries
* @param int $id
- * @return array
*/
protected static function setBoundaries(int $id)
{
*
* @return array token
*/
- protected static function getCurrentApplication()
+ public static function getCurrentApplication()
{
$token = OAuth::getCurrentApplicationToken();
}
}
- /**
- * Get user info array.
- *
- * @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($contact_id);
- }
-
- /**
- * Exit with error code
- *
- * @param int $code
- * @param string $description
- * @param string $message
- * @param string|null $format
- * @return void
- */
- public static function error(int $code, string $description, string $message, string $format = null)
- {
- $error = [
- 'error' => $message ?: $description,
- 'code' => $code . ' ' . $description,
- 'request' => DI::args()->getQueryString()
- ];
-
- header($_SERVER["SERVER_PROTOCOL"] . ' ' . $code . ' ' . $description);
-
- self::exit('status', ['status' => $error], $format);
- }
-
- /**
- * Outputs formatted data according to the data type and then exits the execution.
- *
- * @param string $root_element
- * @param array $data An array with a single element containing the returned result
- * @param string $format Output format (xml, json, rss, atom)
- * @return false|string
- */
- protected static function exit(string $root_element, array $data, string $format = null)
- {
- $format = $format ?? 'json';
-
- $return = self::formatData($root_element, $format, $data);
-
- switch ($format) {
- case 'xml':
- header('Content-Type: text/xml');
- 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;
- break;
- }
-
- echo $return;
- exit;
- }
-
- /**
- * Formats the data according to the data type
- *
- * @param string $root_element Name of the root element
- * @param string $type Return type (atom, rss, xml, json)
- * @param array $data JSON style array
- *
- * @return array|string (string|array) XML data or JSON data
- */
- public static function formatData($root_element, string $type, array $data)
- {
- switch ($type) {
- case 'atom':
- case 'rss':
- case 'xml':
- $ret = self::createXML($data, $root_element);
- break;
- case 'json':
- default:
- $ret = $data;
- break;
- }
- return $ret;
- }
-
- /**
- * Callback function to transform the array in an array that can be transformed in a XML file
- *
- * @param mixed $item Array item value
- * @param string $key Array key
- *
- * @return boolean
- */
- public static function reformatXML(&$item, &$key)
+ public static function getContactIDForSearchterm(string $screen_name = null, string $profileurl = null, int $cid = null, int $uid)
{
- if (is_bool($item)) {
- $item = ($item ? 'true' : 'false');
+ if (!empty($cid)) {
+ return $cid;
}
- if (substr($key, 0, 10) == 'statusnet_') {
- $key = 'statusnet:'.substr($key, 10);
- } elseif (substr($key, 0, 10) == 'friendica_') {
- $key = 'friendica:'.substr($key, 10);
+ if (!empty($profileurl)) {
+ return Contact::getIdForURL($profileurl);
}
- return true;
- }
- /**
- * Creates the XML from a JSON style array
- *
- * @param array $data JSON style array
- * @param string $root_element Name of the root element
- *
- * @return string The XML data
- */
- public static function createXML(array $data, $root_element)
- {
- $childname = key($data);
- $data2 = array_pop($data);
-
- $namespaces = ['' => 'http://api.twitter.com',
- 'statusnet' => 'http://status.net/schema/api/1/',
- 'friendica' => 'http://friendi.ca/schema/api/1/',
- 'georss' => 'http://www.georss.org/georss'];
-
- /// @todo Auto detection of needed namespaces
- if (in_array($root_element, ['ok', 'hash', 'config', 'version', 'ids', 'notes', 'photos'])) {
- $namespaces = [];
- }
-
- if (is_array($data2)) {
- $key = key($data2);
- Arrays::walkRecursive($data2, ['Friendica\Module\BaseApi', 'reformatXML']);
-
- if ($key == '0') {
- $data4 = [];
- $i = 1;
-
- foreach ($data2 as $item) {
- $data4[$i++ . ':' . $childname] = $item;
- }
+ if (empty($cid) && !empty($screen_name)) {
+ if (strpos($screen_name, '@') !== false) {
+ return Contact::getIdForURL($screen_name, 0, false);
+ }
- $data2 = $data4;
+ $user = User::getByNickname($screen_name, ['uid']);
+ if (!empty($user['uid'])) {
+ return Contact::getPublicIdByUserId($user['uid']);
}
}
- $data3 = [$root_element => $data2];
+ if ($uid != 0) {
+ return Contact::getPublicIdByUserId($uid);
+ }
- $ret = XML::fromArray($data3, $xml, false, $namespaces);
- return $ret;
+ return null;
}
}
projects / friendica.git / blobdiff