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\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';
*/
protected static $request = [];
- public function delete()
+ /** @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 = [])
+ {
+ parent::__construct($l10n, $baseUrl, $args, $logger, $profiler, $response, $server, $parameters);
+
+ $this->app = $app;
+ }
+
+ 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 function patch()
+ 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 function post()
+ 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.'));
}
}
{
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.'));
}
}
/**
* 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 = [];
*
* @return array token
*/
- protected static function getCurrentApplication()
+ public static function getCurrentApplication()
{
$token = OAuth::getCurrentApplicationToken();
}
}
- 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);
+ if ($uid != 0) {
+ return 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;
- }
-
- $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;
}
}