X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FModule%2FBaseApi.php;h=b6824140db632ab8b73afbff30f0042baf6af2ea;hb=e7384288766f342da98b7d0ada082db516501ac6;hp=c097a5826937b4125d51d836052f279b8330f22b;hpb=0f09b4f636384dcca0961720adb44037a1136bc8;p=friendica.git

diff --git a/src/Module/BaseApi.php b/src/Module/BaseApi.php
index c097a58269..b6824140db 100644
--- a/src/Module/BaseApi.php
+++ b/src/Module/BaseApi.php
@@ -1,6 +1,6 @@
 <?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
  *
@@ -21,21 +21,29 @@
 
 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\DateTimeFormat;
-use Friendica\Util\HTTPInputData;
+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';
@@ -51,86 +59,63 @@ class BaseApi extends BaseModule
 	 */
 	protected static $request = [];
 
-	public function delete()
-	{
-		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 function patch()
+	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.'));
-		}
+		$this->app = $app;
 	}
 
-	public function post()
+	/**
+	 * Additionally checks, if the caller is permitted to do this action
+	 *
+	 * {@inheritDoc}
+	 *
+	 * @throws HTTPException\ForbiddenException
+	 */
+	public function run(array $request = [], bool $scopecheck = true): ResponseInterface
 	{
-		self::checkAllowedScope(self::SCOPE_WRITE);
-
-		if (!DI::app()->isLoggedIn()) {
-			throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
+		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;
+			}	
 		}
-	}
 
-	public function put()
-	{
-		self::checkAllowedScope(self::SCOPE_WRITE);
-
-		if (!DI::app()->isLoggedIn()) {
-			throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
-		}
+		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);
 	}
 
 	/**
@@ -186,7 +171,7 @@ class BaseApi extends BaseModule
 	 *
 	 * @return array token
 	 */
-	protected static function getCurrentApplication()
+	public static function getCurrentApplication()
 	{
 		$token = OAuth::getCurrentApplicationToken();
 
@@ -293,54 +278,31 @@ class BaseApi extends BaseModule
 		}
 	}
 
-	public static function getContactIDForSearchterm(string $screen_name, int $cid, int $uid)
+	public static function getContactIDForSearchterm(string $screen_name = null, string $profileurl = null, int $cid = null, int $uid)
 	{
 		if (!empty($cid)) {
 			return $cid;
 		}
 
-		if (strpos($screen_name, '@') !== false) {
-			$cid = Contact::getIdForURL($screen_name, 0, false);
-		} else {
+		if (!empty($profileurl)) {
+			return Contact::getIdForURL($profileurl);
+		}
+
+		if (empty($cid) && !empty($screen_name)) {
+			if (strpos($screen_name, '@') !== false) {
+				return Contact::getIdForURL($screen_name, 0, false);
+			}
+
 			$user = User::getByNickname($screen_name, ['uid']);
 			if (!empty($user['uid'])) {
-				$cid = Contact::getPublicIdByUserId($user['uid']);
+				return Contact::getPublicIdByUserId($user['uid']);
 			}
 		}
 
-		if (empty($cid) && ($uid != 0)) {
-			$cid = Contact::getPublicIdByUserId($uid);
-		}
-
-		return $cid;
-	}
-
-	/**
-	 * Set values for RSS template
-	 *
-	 * @param array $arr Array to be passed to template
-	 * @param int   $cid Contact ID of template
-	 * @return array
-	 */
-	public static function addRSSValues(array $arr, int $cid)
-	{
-		if (empty($cid)) {
-			return $arr;
+		if ($uid != 0) {
+			return Contact::getPublicIdByUserId($uid);
 		}
 
-		$user_info = DI::twitterUser()->createFromContactId($cid)->toArray();
-
-		$arr['$user'] = $user_info;
-		$arr['$rss'] = [
-			'alternate'    => $user_info['url'],
-			'self'         => DI::baseUrl() . '/' . DI::args()->getQueryString(),
-			'base'         => DI::baseUrl(),
-			'updated'      => DateTimeFormat::utc(null, DateTimeFormat::API),
-			'atom_updated' => DateTimeFormat::utcNow(DateTimeFormat::ATOM),
-			'language'     => $user_info['lang'],
-			'logo'         => DI::baseUrl() . '/images/friendica-32.png',
-		];
-
-		return $arr;
+		return null;
 	}
 }