Friendica/friendica-github
1
0
Fork 0
mirror of https://github.com/friendica/friendica synced 2025-04-19 09:50:11 +00:00
Code Issues Projects Releases Packages Wiki Activity

Inherit ApiResponse from Response

Browse source
This commit is contained in:
Philipp 2021-11-21 21:52:36 +01:00
parent 561aba18e3
commit 537b74f307
No known key found for this signature in database
GPG key ID: 24A7501396EB5432
46 changed files with 326 additions and 277 deletions
Download patch file Download diff file Expand all files Collapse all files

51
src/Module/Api/ApiResponse.php
View file

@ -5,6 +5,7 @@ namespace Friendica\Module\Api;
use Friendica\App\Arguments;
use Friendica\App\BaseURL;
use Friendica\Core\L10n;
use Friendica\Module\Response;
use Friendica\Util\Arrays;
use Friendica\Util\DateTimeFormat;
use Friendica\Util\HTTPInputData;
@ -13,9 +14,9 @@ use Psr\Log\LoggerInterface;
use Friendica\Factory\Api\Twitter\User as TwitterUser;
/**
* This class is used to format and return API responses
* This class is used to format and create API responses
*/
class ApiResponse
class ApiResponse extends Response
{
/** @var L10n */
protected $l10n;
@ -23,42 +24,18 @@ class ApiResponse
protected $args;
/** @var LoggerInterface */
protected $logger;
/** @var BaseURL */
protected $baseUrl;
/** @var TwitterUser */
protected $twitterUser;
/**
* @param L10n $l10n
* @param Arguments $args
* @param LoggerInterface $logger
*/
public function __construct(L10n $l10n, Arguments $args, LoggerInterface $logger, BaseURL $baseurl, TwitterUser $twitteruser)
public function __construct(L10n $l10n, Arguments $args, LoggerInterface $logger, BaseURL $baseUrl, TwitterUser $twitterUser)
{
$this->l10n = $l10n;
$this->args = $args;
$this->logger = $logger;
$this->baseurl = $baseurl;
$this->twitterUser = $twitteruser;
}
/**
* Sets header directly
* mainly used to override it for tests
*
* @param string $header
*/
protected function setHeader(string $header)
{
header($header);
}
/**
* Prints output directly to the caller
* mainly used to override it for tests
*
* @param string $output
*/
protected function printOutput(string $output)
{
echo $output;
exit;
$this->baseUrl = $baseUrl;
$this->twitterUser = $twitterUser;
}
/**
@ -125,12 +102,12 @@ class ApiResponse
$arr['$user'] = $user_info;
$arr['$rss'] = [
'alternate' => $user_info['url'],
'self' => $this->baseurl . '/' . $this->args->getQueryString(),
'base' => $this->baseurl,
'self' => $this->baseUrl . '/' . $this->args->getQueryString(),
'base' => $this->baseUrl,
'updated' => DateTimeFormat::utc(null, DateTimeFormat::API),
'atom_updated' => DateTimeFormat::utcNow(DateTimeFormat::ATOM),
'language' => $user_info['lang'],
'logo' => $this->baseurl . '/images/friendica-32.png',
'logo' => $this->baseUrl . '/images/friendica-32.png',
];
return $arr;
@ -242,7 +219,7 @@ class ApiResponse
break;
}
$this->printOutput($return);
$this->addContent($return);
}
/**

4
src/Module/Api/Friendica/Activity.php
View file

@ -57,9 +57,9 @@ class Activity extends BaseApi
} else {
$ok = 'ok';
}
DI::apiResponse()->exit('ok', ['ok' => $ok], $this->parameters['extension'] ?? null);
$this->response->exit('ok', ['ok' => $ok], $this->parameters['extension'] ?? null);
} else {
DI::apiResponse()->error(500, 'Error adding activity', '', $this->parameters['extension'] ?? null);
$this->response->error(500, 'Error adding activity', '', $this->parameters['extension'] ?? null);
}
}
}

8
src/Module/Api/Friendica/DirectMessages/Setseen.php
View file

@ -42,13 +42,15 @@ class Setseen extends BaseApi
// return error if id is zero
if (empty($request['id'])) {
$answer = ['result' => 'error', 'message' => 'message id not specified'];
DI::apiResponse()->exit('direct_messages_setseen', ['$result' => $answer], $this->parameters['extension'] ?? null);
$this->response->exit('direct_messages_setseen', ['$result' => $answer], $this->parameters['extension'] ?? null);
return;
}
// error message if specified id is not in database
if (!DBA::exists('mail', ['id' => $request['id'], 'uid' => $uid])) {
$answer = ['result' => 'error', 'message' => 'message id not in database'];
DI::apiResponse()->exit('direct_messages_setseen', ['$result' => $answer], $this->parameters['extension'] ?? null);
$this->response->exit('direct_messages_setseen', ['$result' => $answer], $this->parameters['extension'] ?? null);
return;
}
// update seen indicator
@ -58,6 +60,6 @@ class Setseen extends BaseApi
$answer = ['result' => 'error', 'message' => 'unknown error'];
}
DI::apiResponse()->exit('direct_messages_setseen', ['$result' => $answer], $this->parameters['extension'] ?? null);
$this->response->exit('direct_messages_setseen', ['$result' => $answer], $this->parameters['extension'] ?? null);
}
}

2
src/Module/Api/Friendica/Events/Index.php
View file

@ -70,6 +70,6 @@ class Index extends BaseApi
];
}
DI::apiResponse()->exit('events', ['events' => $items], $this->parameters['extension'] ?? null);
$this->response->exit('events', ['events' => $items], $this->parameters['extension'] ?? null);
}
}

2
src/Module/Api/Friendica/Group/Delete.php
View file

@ -70,7 +70,7 @@ class Delete extends BaseApi
if ($ret) {
// return success
$success = ['success' => $ret, 'gid' => $request['gid'], 'name' => $request['name'], 'status' => 'deleted', 'wrong users' => []];
DI::apiResponse()->exit('group_delete', ['$result' => $success], $parameters['extension'] ?? null);
$this->response->exit('group_delete', ['$result' => $success], $parameters['extension'] ?? null);
} else {
throw new BadRequestException('other API error');
}

2
src/Module/Api/Friendica/Notification.php
View file

@ -56,6 +56,6 @@ class Notification extends BaseApi
$result = false;
}
DI::apiResponse()->exit('notes', ['note' => $result], $this->parameters['extension'] ?? null);
$this->response->exit('notes', ['note' => $result], $this->parameters['extension'] ?? null);
}
}

2
src/Module/Api/Friendica/Photo/Delete.php
View file

@ -64,7 +64,7 @@ class Delete extends BaseApi
Item::deleteForUser($condition, $uid);
$result = ['result' => 'deleted', 'message' => 'photo with id `' . $request['photo_id'] . '` has been deleted from server.'];
DI::apiResponse()->exit('photo_delete', ['$result' => $result], $this->parameters['extension'] ?? null);
$this->response->exit('photo_delete', ['$result' => $result], $this->parameters['extension'] ?? null);
} else {
throw new InternalServerErrorException("unknown error on deleting photo from database table");
}

2
src/Module/Api/Friendica/Photoalbum/Delete.php
View file

@ -67,7 +67,7 @@ class Delete extends BaseApi
// return success of deletion or error message
if ($result) {
$answer = ['result' => 'deleted', 'message' => 'album `' . $request['album'] . '` with all containing photos has been deleted.'];
DI::apiResponse()->exit('photoalbum_delete', ['$result' => $answer], $this->parameters['extension'] ?? null);
$this->response->exit('photoalbum_delete', ['$result' => $answer], $this->parameters['extension'] ?? null);
} else {
throw new InternalServerErrorException("unknown error - deleting from database failed");
}

2
src/Module/Api/Friendica/Photoalbum/Update.php
View file

@ -59,7 +59,7 @@ class Update extends BaseApi
// return success of updating or error message
if ($result) {
$answer = ['result' => 'updated', 'message' => 'album `' . $request['album'] . '` with all containing photos has been renamed to `' . $request['album_new'] . '`.'];
DI::apiResponse()->exit('photoalbum_update', ['$result' => $answer], $this->parameters['extension'] ?? null);
$this->response->exit('photoalbum_update', ['$result' => $answer], $this->parameters['extension'] ?? null);
} else {
throw new InternalServerErrorException("unknown error - updating in database failed");
}

2
src/Module/Api/Friendica/Profile/Show.php
View file

@ -61,7 +61,7 @@ class Show extends BaseApi
'profiles' => $profiles
];
DI::apiResponse()->exit('friendica_profiles', ['$result' => $result], $this->parameters['extension'] ?? null);
$this->response->exit('friendica_profiles', ['$result' => $result], $this->parameters['extension'] ?? null);
}
/**

2
src/Module/Api/GNUSocial/GNUSocial/Config.php
View file

@ -61,6 +61,6 @@ class Config extends BaseApi
],
];
DI::apiResponse()->exit('config', ['config' => $config], $this->parameters['extension'] ?? null);
$this->response->exit('config', ['config' => $config], $this->parameters['extension'] ?? null);
}
}

2
src/Module/Api/GNUSocial/GNUSocial/Version.php
View file

@ -31,6 +31,6 @@ class Version extends BaseApi
{
protected function rawContent(array $request = [])
{
DI::apiResponse()->exit('version', ['version' => '0.9.7'], $this->parameters['extension'] ?? null);
$this->response->exit('version', ['version' => '0.9.7'], $this->parameters['extension'] ?? null);
}
}

2
src/Module/Api/GNUSocial/Help/Test.php
View file

@ -37,6 +37,6 @@ class Test extends BaseApi
$ok = 'ok';
}
DI::apiResponse()->exit('ok', ['ok' => $ok], $this->parameters['extension'] ?? null);
$this->response->exit('ok', ['ok' => $ok], $this->parameters['extension'] ?? null);
}
}

3
src/Module/Api/Mastodon/Accounts/UpdateCredentials.php
View file

@ -23,7 +23,6 @@ namespace Friendica\Module\Api\Mastodon\Accounts;
use Friendica\App\Router;
use Friendica\Core\Logger;
use Friendica\DI;
use Friendica\Module\BaseApi;
use Friendica\Util\HTTPInputData;
@ -41,6 +40,6 @@ class UpdateCredentials extends BaseApi
Logger::info('Patch data', ['data' => $data]);
DI::apiResponse()->unsupported(Router::PATCH);
$this->response->unsupported(Router::PATCH);
}
}

2
src/Module/Api/Mastodon/Filters.php
View file

@ -35,7 +35,7 @@ class Filters extends BaseApi
{
self::checkAllowedScope(self::SCOPE_WRITE);
DI::apiResponse()->unsupported(Router::POST);
$this->response->unsupported(Router::POST);
}
/**

5
src/Module/Api/Mastodon/Lists/Accounts.php
View file

@ -25,7 +25,6 @@ use Friendica\App\Router;
use Friendica\Core\System;
use Friendica\Database\DBA;
use Friendica\DI;
use Friendica\Module\Api\ApiResponse;
use Friendica\Module\BaseApi;
/**
@ -37,12 +36,12 @@ class Accounts extends BaseApi
{
protected function delete()
{
DI::apiResponse()->unsupported(Router::DELETE);
$this->response->unsupported(Router::DELETE);
}
protected function post(array $request = [], array $post = [])
{
DI::apiResponse()->unsupported(Router::POST);
$this->response->unsupported(Router::POST);
}
/**

2
src/Module/Api/Mastodon/Markers.php
View file

@ -35,7 +35,7 @@ class Markers extends BaseApi
{
self::checkAllowedScope(self::SCOPE_WRITE);
DI::apiResponse()->unsupported(Router::POST);
$this->response->unsupported(Router::POST);
}
/**

3
src/Module/Api/Mastodon/ScheduledStatuses.php
View file

@ -26,7 +26,6 @@ use Friendica\Core\System;
use Friendica\Database\DBA;
use Friendica\DI;
use Friendica\Model\Post;
use Friendica\Module\Api\ApiResponse;
use Friendica\Module\BaseApi;
/**
@ -39,7 +38,7 @@ class ScheduledStatuses extends BaseApi
self::checkAllowedScope(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
DI::apiResponse()->unsupported(Router::PUT);
$this->response->unsupported(Router::PUT);
}
protected function delete()

11
src/Module/Api/Mastodon/Unimplemented.php
View file

@ -22,7 +22,6 @@
namespace Friendica\Module\Api\Mastodon;
use Friendica\App\Router;
use Friendica\DI;
use Friendica\Module\BaseApi;
/**
@ -35,7 +34,7 @@ class Unimplemented extends BaseApi
*/
protected function delete()
{
DI::apiResponse()->unsupported(Router::DELETE);
$this->response->unsupported(Router::DELETE);
}
/**
@ -43,7 +42,7 @@ class Unimplemented extends BaseApi
*/
protected function patch()
{
DI::apiResponse()->unsupported(Router::PATCH);
$this->response->unsupported(Router::PATCH);
}
/**
@ -51,7 +50,7 @@ class Unimplemented extends BaseApi
*/
protected function post(array $request = [], array $post = [])
{
DI::apiResponse()->unsupported(Router::POST);
$this->response->unsupported(Router::POST);
}
/**
@ -59,7 +58,7 @@ class Unimplemented extends BaseApi
*/
public function put()
{
DI::apiResponse()->unsupported(Router::PUT);
$this->response->unsupported(Router::PUT);
}
/**
@ -67,6 +66,6 @@ class Unimplemented extends BaseApi
*/
protected function rawContent(array $request = [])
{
DI::apiResponse()->unsupported(Router::GET);
$this->response->unsupported(Router::GET);
}
}

3
src/Module/Api/Twitter/Account/RateLimitStatus.php
View file

@ -22,7 +22,6 @@
namespace Friendica\Module\Api\Twitter\Account;
use Friendica\Module\BaseApi;
use Friendica\DI;
use Friendica\Util\DateTimeFormat;
/**
@ -52,6 +51,6 @@ class RateLimitStatus extends BaseApi
];
}
DI::apiResponse()->exit('hash', ['hash' => $hash], $this->parameters['extension'] ?? null);
$this->response->exit('hash', ['hash' => $hash], $this->parameters['extension'] ?? null);
}
}

6
src/Module/Api/Twitter/ContactEndpoint.php
View file

@ -27,9 +27,9 @@ use Friendica\Database\DBA;
use Friendica\DI;
use Friendica\Model\Profile;
use Friendica\Model\User;
use Friendica\Module\Api\ApiResponse;
use Friendica\Module\BaseApi;
use Friendica\Model\Contact;
use Friendica\Module\Response;
use Friendica\Network\HTTPException;
use Friendica\Util\Profiler;
use Friendica\Util\Strings;
@ -40,9 +40,9 @@ abstract class ContactEndpoint extends BaseApi
const DEFAULT_COUNT = 20;
const MAX_COUNT = 200;
public function __construct(L10n $l10n, App\BaseURL $baseUrl, App\Arguments $args, LoggerInterface $logger, Profiler $profiler, Response $response, array $server, 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 = [])
{
parent::__construct($l10n, $baseUrl, $args, $logger, $profiler, $response, $server, $parameters);
parent::__construct($app, $l10n, $baseUrl, $args, $logger, $profiler, $response, $server, $parameters);
self::checkAllowedScope(self::SCOPE_READ);
}

3
src/Module/Api/Twitter/SavedSearches.php
View file

@ -22,7 +22,6 @@
namespace Friendica\Module\Api\Twitter;
use Friendica\Database\DBA;
use Friendica\DI;
use Friendica\Module\BaseApi;
/**
@ -45,6 +44,6 @@ class SavedSearches extends BaseApi
DBA::close($terms);
DI::apiResponse()->exit('terms', ['terms' => $result], $this->parameters['extension'] ?? null);
$this->response->exit('terms', ['terms' => $result], $this->parameters['extension'] ?? null);
}
}