namespace Friendica\Module;
+use Friendica\App;
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\DateTimeFormat;
use Friendica\Util\HTTPInputData;
-use Friendica\Util\XML;
-
-require_once __DIR__ . '/../../include/api.php';
+use Friendica\Util\Profiler;
+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';
const SCOPE_PUSH = 'push';
- /**
- * @var string json|xml|rss|atom
- */
- protected static $format = 'json';
-
/**
* @var array
*/
*/
protected static $request = [];
- public static function init(array $parameters = [])
+ /** @var App */
+ protected $app;
+
+ /** @var ApiResponse */
+ protected $response;
+
+ public function __construct(App $app, L10n $l10n, App\BaseURL $baseUrl, App\Arguments $args, LoggerInterface $logger, Profiler $profiler, ApiResponse $response, array $server, array $parameters = [])
{
- $arguments = DI::args();
+ parent::__construct($l10n, $baseUrl, $args, $logger, $profiler, $response, $server, $parameters);
- if (substr($arguments->getCommand(), -4) === '.xml') {
- self::$format = 'xml';
- }
- if (substr($arguments->getCommand(), -4) === '.rss') {
- self::$format = 'rss';
- }
- if (substr($arguments->getCommand(), -4) === '.atom') {
- self::$format = 'atom';
- }
+ $this->app = $app;
}
- public static function delete(array $parameters = [])
+ protected function delete()
{
self::checkAllowedScope(self::SCOPE_WRITE);
- if (!DI::app()->isLoggedIn()) {
- throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
+ if (!$this->app->isLoggedIn()) {
+ throw new HTTPException\ForbiddenException($this->t('Permission denied.'));
}
}
- public static function patch(array $parameters = [])
+ protected function patch()
{
self::checkAllowedScope(self::SCOPE_WRITE);
- if (!DI::app()->isLoggedIn()) {
- throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
+ if (!$this->app->isLoggedIn()) {
+ throw new HTTPException\ForbiddenException($this->t('Permission denied.'));
}
}
- public static function post(array $parameters = [])
+ protected function post(array $request = [], array $post = [])
{
self::checkAllowedScope(self::SCOPE_WRITE);
- if (!DI::app()->isLoggedIn()) {
- throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
+ if (!$this->app->isLoggedIn()) {
+ throw new HTTPException\ForbiddenException($this->t('Permission denied.'));
}
}
- public static function put(array $parameters = [])
+ public function put()
{
self::checkAllowedScope(self::SCOPE_WRITE);
- if (!DI::app()->isLoggedIn()) {
- throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
+ if (!$this->app->isLoggedIn()) {
+ throw new HTTPException\ForbiddenException($this->t('Permission denied.'));
}
}
- /**
- * Quit execution with the message that the endpoint isn't implemented
- *
- * @param string $method
- * @return void
- */
- 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);
- $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());
- }
-
/**
* 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|null $request Custom REQUEST array, superglobal instead
* @return array request data
+ * @throws \Exception
*/
- public static function getRequest(array $defaults)
+ public static function getRequest(array $defaults, array $request = null): array
{
$httpinput = HTTPInputData::process();
- $input = array_merge($httpinput['variables'], $httpinput['files'], $_REQUEST);
+ $input = array_merge($httpinput['variables'], $httpinput['files'], $request ?? $_REQUEST);
self::$request = $input;
self::$boundaries = [];
* 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();
*
* @return int User ID
*/
- protected static function getCurrentUserID()
+ public static function getCurrentUserID()
{
$uid = OAuth::getCurrentUserID();
}
}
- /**
- * 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);
- }
-
- /**
- * 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)
- {
- $return = self::formatData($root_element, self::$format, $data);
-
- switch (self::$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;
- }
-
- return $return;
- }
-
- /**
- * walks recursively through an array with the possibility to change value and key
- *
- * @param array $array The array to walk through
- * @param callable $callback The callback function
- *
- * @return array the transformed array
- */
- static public function walkRecursive(array &$array, callable $callback)
- {
- $new_array = [];
-
- foreach ($array as $k => $v) {
- if (is_array($v)) {
- if ($callback($v, $k)) {
- $new_array[$k] = self::walkRecursive($v, $callback);
- }
- } else {
- if ($callback($v, $k)) {
- $new_array[$k] = $v;
- }
- }
- }
- $array = $new_array;
-
- return $array;
- }
-
- /**
- * 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);
- }
- 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 (!empty($profileurl)) {
+ return Contact::getIdForURL($profileurl);
}
- if (is_array($data2)) {
- $key = key($data2);
- self::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