return prepare_photo_data($type, false, $resource_id, $uid);
} else {
throw new InternalServerErrorException("image upload failed");
+ DI::page()->exit(DI::apiResponse());
}
}
// Let the module run it's internal process (init, get, post, ...)
$response = $module->run($_POST, $_REQUEST);
- $page->run($this, $this->baseURL, $this->args, $this->mode, $response, $this->l10n, $this->profiler, $this->config, $pconfig);
+ if ($response->getType() === $response::TYPE_HTML) {
+ $page->run($this, $this->baseURL, $this->args, $this->mode, $response, $this->l10n, $this->profiler, $this->config, $pconfig);
+ } else {
+ $page->exit($response);
+ }
} catch (HTTPException $e) {
(new ModuleHTTPException())->rawContent($e);
}
$this->footerScripts[] = trim($url, '/');
}
+ /**
+ * Directly exit with the current response (include setting all headers)
+ *
+ * @param IRespondToRequests $response
+ */
+ public function exit(IRespondToRequests $response)
+ {
+ foreach ($response->getHeaders() as $key => $header) {
+ if (empty($key)) {
+ header($header);
+ } else {
+ header("$key: $header");
+ }
+ }
+
+ echo $response->getContent();
+ }
+
/**
* Executes the creation of the current page and prints it to the screen
*
$this->page['nav'] = Nav::build($app);
}
- foreach ($response->getHeaders() as $key => $values) {
- if (is_array($values)) {
- foreach ($values as $value) {
- header($key, $value);
- }
+ foreach ($response->getHeaders() as $key => $header) {
+ if (empty($key)) {
+ header($header);
} else {
- header($key, $values);
+ header("$key: $header");
}
}
use Friendica\App\Router;
use Friendica\Capabilities\ICanHandleRequests;
-use Friendica\Capabilities\ICanReadAndWriteToResponds;
+use Friendica\Capabilities\ICanCreateResponses;
use Friendica\Capabilities\IRespondToRequests;
use Friendica\Core\Hook;
use Friendica\Core\L10n;
protected $profiler;
/** @var array */
protected $server;
- /** @var ICanReadAndWriteToResponds */
+ /** @var ICanCreateResponses */
protected $response;
public function __construct(L10n $l10n, App\BaseURL $baseUrl, App\Arguments $args, LoggerInterface $logger, Profiler $profiler, Response $response, array $server, array $parameters = [])
{
}
- /** Gets the name of the current class */
- public function getClassName(): string
- {
- return static::class;
- }
-
/**
* {@inheritDoc}
*/
Core\Hook::callAll($this->args->getModuleName() . '_mod_init', $placeholder);
$this->profiler->set(microtime(true) - $timestamp, 'init');
- $this->response->setType(IRespondToRequests::TYPE_CONTENT);
- switch ($this->server['REQUEST_METHOD']) {
+ switch ($this->server['REQUEST_METHOD'] ?? Router::GET) {
case Router::DELETE:
- $this->response->setType(IRespondToRequests::TYPE_DELETE);
$this->delete();
break;
case Router::PATCH:
- $this->response->setType(IRespondToRequests::TYPE_PATCH);
$this->patch();
break;
case Router::POST:
Core\Hook::callAll($this->args->getModuleName() . '_mod_post', $post);
- $this->response->setType(IRespondToRequests::TYPE_POST);
$this->post($request, $post);
break;
case Router::PUT:
- $this->response->setType(IRespondToRequests::TYPE_PUT);
$this->put();
break;
default:
+ $timestamp = microtime(true);
// "rawContent" is especially meant for technical endpoints.
// This endpoint doesn't need any theme initialization or other comparable stuff.
$this->rawContent($request);
$this->response->addContent($this->content($_REQUEST));
} catch (HTTPException $e) {
$this->response->addContent((new ModuleHTTPException())->content($e));
+ } finally {
+ $this->profiler->set(microtime(true) - $timestamp, 'content');
}
break;
}
--- /dev/null
+<?php
+
+namespace Friendica\Capabilities;
+
+use Friendica\Network\HTTPException\InternalServerErrorException;
+
+interface ICanCreateResponses extends IRespondToRequests
+{
+ /**
+ * Adds a header entry to the module response
+ *
+ * @param string $header
+ * @param string|null $key
+ */
+ public function setHeader(string $header, ?string $key = null): void;
+
+ /**
+ * Adds output content to the module response
+ *
+ * @param mixed $content
+ */
+ public function addContent($content): void;
+
+ /**
+ * Sets the response type of the current request
+ *
+ * @param string $type
+ * @param string|null $content_type (optional) overrides the direct content_type, otherwise set the default one
+ *
+ * @throws InternalServerErrorException
+ */
+ public function setType(string $type, ?string $content_type = null): void;
+}
+++ /dev/null
-<?php
-
-namespace Friendica\Capabilities;
-
-use Friendica\Network\HTTPException\InternalServerErrorException;
-
-interface ICanReadAndWriteToResponds extends IRespondToRequests
-{
- /**
- * Adds a header entry to the module response
- *
- * @param string $key
- * @param string $value
- */
- public function addHeader(string $key, string $value);
-
- /**
- * Adds output content to the module response
- *
- * @param string $content
- */
- public function addContent(string $content);
-
- /**
- * Sets the response type of the current request
- *
- * @param string $type
- *
- * @throws InternalServerErrorException
- */
- public function setType(string $type);
-}
interface IRespondToRequests
{
- const TYPE_CONTENT = 'content';
- const TYPE_RAW_CONTENT = 'rawContent';
- const TYPE_POST = 'post';
- const TYPE_PUT = 'put';
- const TYPE_DELETE = 'delete';
- const TYPE_PATCH = 'patch';
+ const TYPE_HTML = 'html';
+ const TYPE_XML = 'xml';
+ const TYPE_JSON = 'json';
+ const TYPE_ATOM = 'atom';
+ const TYPE_RSS = 'rss';
const ALLOWED_TYPES = [
- self::TYPE_CONTENT,
- self::TYPE_RAW_CONTENT,
- self::TYPE_POST,
- self::TYPE_PUT,
- self::TYPE_DELETE,
- self::TYPE_PATCH,
+ self::TYPE_HTML,
+ self::TYPE_XML,
+ self::TYPE_JSON,
+ self::TYPE_ATOM,
+ self::TYPE_RSS
];
/**
* Returns all set headers during the module execution
*
- * @return string[][]
+ * @return string[]
*/
public function getHeaders(): array;
/**
- * Returns the output of the module
+ * Returns the output of the module (mixed content possible)
*
- * @return string
+ * @return mixed
*/
- public function getContent(): string;
+ public function getContent();
/**
- * Returns the response type of the current request
+ * Returns the response type
*
* @return string
*/
- public function getTyp(): string;
+ public function getType(): string;
}
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;
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;
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;
}
/**
$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;
break;
}
- $this->printOutput($return);
+ $this->addContent($return);
}
/**
} 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);
}
}
}
// 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
$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);
}
}
];
}
- DI::apiResponse()->exit('events', ['events' => $items], $this->parameters['extension'] ?? null);
+ $this->response->exit('events', ['events' => $items], $this->parameters['extension'] ?? null);
}
}
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');
}
$result = false;
}
- DI::apiResponse()->exit('notes', ['note' => $result], $this->parameters['extension'] ?? null);
+ $this->response->exit('notes', ['note' => $result], $this->parameters['extension'] ?? null);
}
}
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");
}
// 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");
}
// 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");
}
'profiles' => $profiles
];
- DI::apiResponse()->exit('friendica_profiles', ['$result' => $result], $this->parameters['extension'] ?? null);
+ $this->response->exit('friendica_profiles', ['$result' => $result], $this->parameters['extension'] ?? null);
}
/**
],
];
- DI::apiResponse()->exit('config', ['config' => $config], $this->parameters['extension'] ?? null);
+ $this->response->exit('config', ['config' => $config], $this->parameters['extension'] ?? null);
}
}
{
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);
}
}
$ok = 'ok';
}
- DI::apiResponse()->exit('ok', ['ok' => $ok], $this->parameters['extension'] ?? null);
+ $this->response->exit('ok', ['ok' => $ok], $this->parameters['extension'] ?? null);
}
}
use Friendica\App\Router;
use Friendica\Core\Logger;
-use Friendica\DI;
use Friendica\Module\BaseApi;
use Friendica\Util\HTTPInputData;
Logger::info('Patch data', ['data' => $data]);
- DI::apiResponse()->unsupported(Router::PATCH);
+ $this->response->unsupported(Router::PATCH);
}
}
{
self::checkAllowedScope(self::SCOPE_WRITE);
- DI::apiResponse()->unsupported(Router::POST);
+ $this->response->unsupported(Router::POST);
}
/**
use Friendica\Core\System;
use Friendica\Database\DBA;
use Friendica\DI;
-use Friendica\Module\Api\ApiResponse;
use Friendica\Module\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);
}
/**
{
self::checkAllowedScope(self::SCOPE_WRITE);
- DI::apiResponse()->unsupported(Router::POST);
+ $this->response->unsupported(Router::POST);
}
/**
use Friendica\Database\DBA;
use Friendica\DI;
use Friendica\Model\Post;
-use Friendica\Module\Api\ApiResponse;
use Friendica\Module\BaseApi;
/**
self::checkAllowedScope(self::SCOPE_WRITE);
$uid = self::getCurrentUserID();
- DI::apiResponse()->unsupported(Router::PUT);
+ $this->response->unsupported(Router::PUT);
}
protected function delete()
namespace Friendica\Module\Api\Mastodon;
use Friendica\App\Router;
-use Friendica\DI;
use Friendica\Module\BaseApi;
/**
*/
protected function delete()
{
- DI::apiResponse()->unsupported(Router::DELETE);
+ $this->response->unsupported(Router::DELETE);
}
/**
*/
protected function patch()
{
- DI::apiResponse()->unsupported(Router::PATCH);
+ $this->response->unsupported(Router::PATCH);
}
/**
*/
protected function post(array $request = [], array $post = [])
{
- DI::apiResponse()->unsupported(Router::POST);
+ $this->response->unsupported(Router::POST);
}
/**
*/
public function put()
{
- DI::apiResponse()->unsupported(Router::PUT);
+ $this->response->unsupported(Router::PUT);
}
/**
*/
protected function rawContent(array $request = [])
{
- DI::apiResponse()->unsupported(Router::GET);
+ $this->response->unsupported(Router::GET);
}
}
namespace Friendica\Module\Api\Twitter\Account;
use Friendica\Module\BaseApi;
-use Friendica\DI;
use Friendica\Util\DateTimeFormat;
/**
];
}
- DI::apiResponse()->exit('hash', ['hash' => $hash], $this->parameters['extension'] ?? null);
+ $this->response->exit('hash', ['hash' => $hash], $this->parameters['extension'] ?? null);
}
}
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;
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);
}
namespace Friendica\Module\Api\Twitter;
use Friendica\Database\DBA;
-use Friendica\DI;
use Friendica\Module\BaseApi;
/**
DBA::close($terms);
- DI::apiResponse()->exit('terms', ['terms' => $result], $this->parameters['extension'] ?? null);
+ $this->response->exit('terms', ['terms' => $result], $this->parameters['extension'] ?? null);
}
}
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
{
*/
protected static $request = [];
+ /** @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);
+ }
+
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.'));
}
}
{
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.'));
}
}
{
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.'));
}
}
namespace Friendica\Module\HTTPException;
use Friendica\BaseModule;
+use Friendica\Capabilities\IRespondToRequests;
use Friendica\DI;
use Friendica\Network\HTTPException;
throw new HTTPException\NotFoundException(DI::l10n()->t('Page not found.'));
}
- public function run(array $post = [], array $request = []): string
+ public function run(array $post = [], array $request = []): IRespondToRequests
{
/* The URL provided does not resolve to a valid module.
*
namespace Friendica\Module;
+use Friendica\App;
use Friendica\BaseModule;
+use Friendica\Capabilities\IRespondToRequests;
use Friendica\Core\Addon;
-use Friendica\Core\System;
-use Friendica\DI;
+use Friendica\Core\Config\Capability\IManageConfigValues;
+use Friendica\Core\L10n;
use Friendica\Model\Nodeinfo;
+use Friendica\Util\Profiler;
+use Psr\Log\LoggerInterface;
/**
* Version 1.0 of Nodeinfo, a standardized way of exposing metadata about a server running one of the distributed social networks.
*/
class NodeInfo110 extends BaseModule
{
- protected function rawContent(array $request = [])
+ /** @var IManageConfigValues */
+ protected $config;
+
+ public function __construct(L10n $l10n, App\BaseURL $baseUrl, App\Arguments $args, LoggerInterface $logger, Profiler $profiler, Response $response, IManageConfigValues $config, array $server, array $parameters = [])
{
- $config = DI::config();
+ parent::__construct($l10n, $baseUrl, $args, $logger, $profiler, $response, $server, $parameters);
+
+ $this->config = $config;
+ }
+ protected function rawContent(array $request = [])
+ {
$nodeinfo = [
'version' => '1.0',
'software' => [
],
'services' => [],
'usage' => [],
- 'openRegistrations' => intval($config->get('config', 'register_policy')) !== Register::CLOSED,
+ 'openRegistrations' => intval($this->config->get('config', 'register_policy')) !== Register::CLOSED,
'metadata' => [
- 'nodeName' => $config->get('config', 'sitename'),
+ 'nodeName' => $this->config->get('config', 'sitename'),
],
];
- if (!empty($config->get('system', 'diaspora_enabled'))) {
- $nodeinfo['protocols']['inbound'][] = 'diaspora';
+ if (!empty($this->config->get('system', 'diaspora_enabled'))) {
+ $nodeinfo['protocols']['inbound'][] = 'diaspora';
$nodeinfo['protocols']['outbound'][] = 'diaspora';
}
- if (empty($config->get('system', 'ostatus_disabled'))) {
- $nodeinfo['protocols']['inbound'][] = 'gnusocial';
+ if (empty($this->config->get('system', 'ostatus_disabled'))) {
+ $nodeinfo['protocols']['inbound'][] = 'gnusocial';
$nodeinfo['protocols']['outbound'][] = 'gnusocial';
}
$nodeinfo['services'] = Nodeinfo::getServices();
- $nodeinfo['metadata']['protocols'] = $nodeinfo['protocols'];
+ $nodeinfo['metadata']['protocols'] = $nodeinfo['protocols'];
$nodeinfo['metadata']['protocols']['outbound'][] = 'atom1.0';
- $nodeinfo['metadata']['protocols']['inbound'][] = 'atom1.0';
- $nodeinfo['metadata']['protocols']['inbound'][] = 'rss2.0';
+ $nodeinfo['metadata']['protocols']['inbound'][] = 'atom1.0';
+ $nodeinfo['metadata']['protocols']['inbound'][] = 'rss2.0';
$nodeinfo['metadata']['services'] = $nodeinfo['services'];
$nodeinfo['metadata']['services']['inbound'][] = 'twitter';
}
- $nodeinfo['metadata']['explicitContent'] = $config->get('system', 'explicit_content', false) == true;
+ $nodeinfo['metadata']['explicitContent'] = $this->config->get('system', 'explicit_content', false) == true;
- System::jsonExit($nodeinfo, 'application/json; charset=utf-8', JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES);
+ $this->response->setType(IRespondToRequests::TYPE_JSON);
+ $this->response->addContent(json_encode($nodeinfo, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES));
}
}
namespace Friendica\Module;
+use Friendica\App;
use Friendica\BaseModule;
+use Friendica\Capabilities\IRespondToRequests;
use Friendica\Core\Addon;
-use Friendica\Core\System;
-use Friendica\DI;
+use Friendica\Core\Config\Capability\IManageConfigValues;
+use Friendica\Core\L10n;
use Friendica\Model\Nodeinfo;
+use Friendica\Util\Profiler;
+use Psr\Log\LoggerInterface;
/**
* Version 2.0 of Nodeinfo, a standardized way of exposing metadata about a server running one of the distributed social networks.
*/
class NodeInfo120 extends BaseModule
{
- protected function rawContent(array $request = [])
+ /** @var IManageConfigValues */
+ protected $config;
+
+ public function __construct(L10n $l10n, App\BaseURL $baseUrl, App\Arguments $args, LoggerInterface $logger, Profiler $profiler, Response $response, IManageConfigValues $config, array $server, array $parameters = [])
{
- $config = DI::config();
+ parent::__construct($l10n, $baseUrl, $args, $logger, $profiler, $response, $server, $parameters);
+
+ $this->config = $config;
+ }
+ protected function rawContent(array $request = [])
+ {
$nodeinfo = [
- 'version' => '2.0',
- 'software' => [
+ 'version' => '2.0',
+ 'software' => [
'name' => 'friendica',
'version' => FRIENDICA_VERSION . '-' . DB_UPDATE_VERSION,
],
'protocols' => ['dfrn', 'activitypub'],
'services' => [],
'usage' => [],
- 'openRegistrations' => intval($config->get('config', 'register_policy')) !== Register::CLOSED,
+ 'openRegistrations' => intval($this->config->get('config', 'register_policy')) !== Register::CLOSED,
'metadata' => [
- 'nodeName' => $config->get('config', 'sitename'),
+ 'nodeName' => $this->config->get('config', 'sitename'),
],
];
- if (!empty($config->get('system', 'diaspora_enabled'))) {
+ if (!empty($this->config->get('system', 'diaspora_enabled'))) {
$nodeinfo['protocols'][] = 'diaspora';
}
- if (empty($config->get('system', 'ostatus_disabled'))) {
+ if (empty($this->config->get('system', 'ostatus_disabled'))) {
$nodeinfo['protocols'][] = 'ostatus';
}
$nodeinfo['services']['inbound'][] = 'rss2.0';
$nodeinfo['services']['outbound'][] = 'atom1.0';
- if (function_exists('imap_open') && !$config->get('system', 'imap_disabled')) {
+ if (function_exists('imap_open') && !$this->config->get('system', 'imap_disabled')) {
$nodeinfo['services']['inbound'][] = 'imap';
}
- $nodeinfo['metadata']['explicitContent'] = $config->get('system', 'explicit_content', false) == true;
+ $nodeinfo['metadata']['explicitContent'] = $this->config->get('system', 'explicit_content', false) == true;
- System::jsonExit($nodeinfo, 'application/json; charset=utf-8', JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES);
+ $this->response->setType(IRespondToRequests::TYPE_JSON, 'application/json; charset=utf-8');
+ $this->response->addContent(json_encode($nodeinfo, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES));
}
}
namespace Friendica\Module;
+use Friendica\App;
use Friendica\BaseModule;
use Friendica\Core\Addon;
+use Friendica\Core\Config\Capability\IManageConfigValues;
+use Friendica\Core\L10n;
use Friendica\Core\System;
-use Friendica\DI;
use Friendica\Model\Nodeinfo;
+use Friendica\Util\Profiler;
+use Psr\Log\LoggerInterface;
/**
* Version 1.0 of Nodeinfo 2, a sStandardized way of exposing metadata about a server running one of the distributed social networks.
*/
class NodeInfo210 extends BaseModule
{
- protected function rawContent(array $request = [])
+ /** @var IManageConfigValues */
+ protected $config;
+
+ public function __construct(L10n $l10n, App\BaseURL $baseUrl, App\Arguments $args, LoggerInterface $logger, Profiler $profiler, Response $response, IManageConfigValues $config, array $server, array $parameters = [])
{
- $config = DI::config();
+ parent::__construct($l10n, $baseUrl, $args, $logger, $profiler, $response, $server, $parameters);
+
+ $this->config = $config;
+ }
+ protected function rawContent(array $request = [])
+ {
$nodeinfo = [
- 'version' => '1.0',
- 'server' => [
- 'baseUrl' => DI::baseUrl()->get(),
- 'name' => $config->get('config', 'sitename'),
+ 'version' => '1.0',
+ 'server' => [
+ 'baseUrl' => $this->baseUrl->get(),
+ 'name' => $this->config->get('config', 'sitename'),
'software' => 'friendica',
'version' => FRIENDICA_VERSION . '-' . DB_UPDATE_VERSION,
],
- 'organization' => Nodeinfo::getOrganization($config),
+ 'organization' => Nodeinfo::getOrganization($this->config),
'protocols' => ['dfrn', 'activitypub'],
'services' => [],
- 'openRegistrations' => intval($config->get('config', 'register_policy')) !== Register::CLOSED,
+ 'openRegistrations' => intval($this->config->get('config', 'register_policy')) !== Register::CLOSED,
'usage' => [],
];
- if (!empty($config->get('system', 'diaspora_enabled'))) {
+ if (!empty($this->config->get('system', 'diaspora_enabled'))) {
$nodeinfo['protocols'][] = 'diaspora';
}
- if (empty($config->get('system', 'ostatus_disabled'))) {
+ if (empty($this->config->get('system', 'ostatus_disabled'))) {
$nodeinfo['protocols'][] = 'ostatus';
}
$nodeinfo['services']['inbound'][] = 'rss2.0';
$nodeinfo['services']['outbound'][] = 'atom1.0';
- if (function_exists('imap_open') && !$config->get('system', 'imap_disabled')) {
+ if (function_exists('imap_open') && !$this->config->get('system', 'imap_disabled')) {
$nodeinfo['services']['inbound'][] = 'imap';
}
namespace Friendica\Module;
-use Friendica\Capabilities\ICanReadAndWriteToResponds;
+use Friendica\Capabilities\ICanCreateResponses;
use Friendica\Capabilities\IRespondToRequests;
use Friendica\Network\HTTPException\InternalServerErrorException;
-class Response implements ICanReadAndWriteToResponds
+class Response implements ICanCreateResponses
{
/**
- * @var string[][]
+ * @var string[]
*/
protected $headers = [];
/**
/**
* @var string
*/
- protected $type = IRespondToRequests::TYPE_CONTENT;
+ protected $type = IRespondToRequests::TYPE_HTML;
/**
* {@inheritDoc}
*/
- public function addHeader(string $key, string $value)
+ public function setHeader(?string $header = null, ?string $key = null): void
{
- $this->headers[$key][] = $value;
+ if (!isset($header) && !empty($key)) {
+ unset($this->headers[$key]);
+ }
+
+ if (isset($header)) {
+ if (empty($key)) {
+ $this->headers[] = $header;
+ } else {
+ $this->headers[$key] = $header;
+ }
+ }
}
/**
* {@inheritDoc}
*/
- public function addContent(string $content)
+ public function addContent($content): void
{
$this->content .= $content;
}
/**
* {@inheritDoc}
*/
- public function getContent(): string
+ public function getContent()
{
return $this->content;
}
/**
* {@inheritDoc}
*/
- public function setType(string $type)
+ public function setType(string $type, ?string $content_type = null): void
{
if (!in_array($type, IRespondToRequests::ALLOWED_TYPES)) {
throw new InternalServerErrorException('wrong type');
}
+ switch ($type) {
+ case static::TYPE_JSON:
+ $content_type = $content_type ?? 'application/json';
+ break;
+ case static::TYPE_XML:
+ $content_type = $content_type ?? 'text/xml';
+ break;
+ }
+
+
+ $this->setHeader($content_type, 'Content-type');
+
$this->type = $type;
}
/**
* {@inheritDoc}
*/
- public function getTyp(): string
+ public function getType(): string
{
return $this->type;
}
/**
* The header list
*
- * @var string[]
+ * @var string[][]
*/
protected static $header = [];
self::$header = [];
}
- protected function setHeader(string $header)
+ /**
+ * {@inheritDoc}
+ */
+ public function setHeader(?string $header = null, ?string $key = null): void
{
- static::$header[] = $header;
+ if (!isset($header) && !empty($key)) {
+ unset(static::$header[$key]);
+ }
+
+ if (isset($header)) {
+ if (empty($key)) {
+ static::$header[] = $header;
+ } else {
+ static::$header[$key] = $header;
+ }
+ }
}
protected function printOutput(string $output)
use Friendica\App\BaseURL;
use Friendica\Core\L10n;
use Friendica\Factory\Api\Twitter\User;
+use Friendica\Module\Api\ApiResponse;
use Friendica\Test\MockedTest;
-use Friendica\Test\Util\ApiResponseDouble;
use Psr\Log\NullLogger;
class ApiResponseTest extends MockedTest
{
- protected function tearDown(): void
- {
- ApiResponseDouble::reset();
-
- parent::tearDown();
- }
-
public function testErrorWithJson()
{
$l10n = \Mockery::mock(L10n::class);
$baseUrl = \Mockery::mock(BaseURL::class);
$twitterUser = \Mockery::mock(User::class);
- $response = new ApiResponseDouble($l10n, $args, new NullLogger(), $baseUrl, $twitterUser);
+ $response = new ApiResponse($l10n, $args, new NullLogger(), $baseUrl, $twitterUser);
$response->error(200, 'OK', 'error_message', 'json');
- self::assertEquals('{"error":"error_message","code":"200 OK","request":""}', ApiResponseDouble::getOutput());
+ self::assertEquals('{"error":"error_message","code":"200 OK","request":""}', $response->getContent());
}
public function testErrorWithXml()
$baseUrl = \Mockery::mock(BaseURL::class);
$twitterUser = \Mockery::mock(User::class);
- $response = new ApiResponseDouble($l10n, $args, new NullLogger(), $baseUrl, $twitterUser);
+ $response = new ApiResponse($l10n, $args, new NullLogger(), $baseUrl, $twitterUser);
$response->error(200, 'OK', 'error_message', 'xml');
self::assertEquals('<?xml version="1.0"?>' . "\n" .
' <code>200 OK</code>' . "\n" .
' <request/>' . "\n" .
'</status>' . "\n",
- ApiResponseDouble::getOutput());
+ $response->getContent());
}
public function testErrorWithRss()
$baseUrl = \Mockery::mock(BaseURL::class);
$twitterUser = \Mockery::mock(User::class);
- $response = new ApiResponseDouble($l10n, $args, new NullLogger(), $baseUrl, $twitterUser);
+ $response = new ApiResponse($l10n, $args, new NullLogger(), $baseUrl, $twitterUser);
$response->error(200, 'OK', 'error_message', 'rss');
self::assertEquals(
' <code>200 OK</code>' . "\n" .
' <request/>' . "\n" .
'</status>' . "\n",
- ApiResponseDouble::getOutput());
+ $response->getContent());
}
public function testErrorWithAtom()
$baseUrl = \Mockery::mock(BaseURL::class);
$twitterUser = \Mockery::mock(User::class);
- $response = new ApiResponseDouble($l10n, $args, new NullLogger(), $baseUrl, $twitterUser);
+ $response = new ApiResponse($l10n, $args, new NullLogger(), $baseUrl, $twitterUser);
$response->error(200, 'OK', 'error_message', 'atom');
self::assertEquals(
' <code>200 OK</code>' . "\n" .
' <request/>' . "\n" .
'</status>' . "\n",
- ApiResponseDouble::getOutput());
+ $response->getContent());
}
public function testUnsupported()
$baseUrl = \Mockery::mock(BaseURL::class);
$twitterUser = \Mockery::mock(User::class);
- $response = new ApiResponseDouble($l10n, $args, new NullLogger(), $baseUrl, $twitterUser);
+ $response = new ApiResponse($l10n, $args, new NullLogger(), $baseUrl, $twitterUser);
$response->unsupported();
- self::assertEquals('{"error":"API endpoint %s %s is not implemented","error_description":"The API endpoint is currently not implemented but might be in the future."}', ApiResponseDouble::getOutput());
+ self::assertEquals('{"error":"API endpoint %s %s is not implemented","error_description":"The API endpoint is currently not implemented but might be in the future."}', $response->getContent());
}
}
use Friendica\Core\Hook;
use Friendica\Database\Database;
use Friendica\DI;
-use Friendica\Module\Api\ApiResponse;
use Friendica\Security\Authentication;
use Friendica\Test\FixtureTest;
-use Friendica\Test\Util\ApiResponseDouble;
use Friendica\Test\Util\AuthenticationDouble;
abstract class ApiTest extends FixtureTest
parent::setUp(); // TODO: Change the autogenerated stub
$this->dice = $this->dice
- ->addRule(Authentication::class, ['instanceOf' => AuthenticationDouble::class, 'shared' => true])
- ->addRule(ApiResponse::class, ['instanceOf' => ApiResponseDouble::class, 'shared' => true]);
+ ->addRule(Authentication::class, ['instanceOf' => AuthenticationDouble::class, 'shared' => true]);
DI::init($this->dice);
$this->installAuthTest();
}
- protected function tearDown(): void
- {
- ApiResponseDouble::reset();
-
- parent::tearDown();
- }
-
/**
* installs auththest.
*
use Friendica\DI;
use Friendica\Module\Api\Friendica\Notification;
-use Friendica\Network\HTTPException\BadRequestException;
use Friendica\Test\src\Module\Api\ApiTest;
-use Friendica\Test\Util\ApiResponseDouble;
use Friendica\Util\DateTimeFormat;
use Friendica\Util\Temporal;
</notes>
XML;
- $notification = new Notification(DI::l10n(), ['extension' => 'xml']);
- $notification->rawContent();
+ $notification = new Notification(DI::app(), DI::l10n(), DI::baseUrl(), DI::args(), DI::logger(), DI::profiler(), DI::apiResponse(), [], ['extension' => 'xml']);
+ $response = $notification->run();
- self::assertXmlStringEqualsXmlString($assertXml, ApiResponseDouble::getOutput());
+ self::assertXmlStringEqualsXmlString($assertXml, $response->getContent());
}
public function testWithJsonResult()
{
- $notification = new Notification(DI::l10n(),['parameter' => 'json']);
- $notification->rawContent();
+ $notification = new Notification(DI::app(), DI::l10n(), DI::baseUrl(), DI::args(), DI::logger(), DI::profiler(), DI::apiResponse(), [], ['extension' => 'json']);
+ $response = $notification->run();
- $result = json_encode(ApiResponseDouble::getOutput());
-
- self::assertJson($result);
+ self::assertJson($response->getContent());
}
}
public function testEmpty()
{
$this->expectException(BadRequestException::class);
- (new Delete(DI::l10n()))->rawContent();
+ (new Delete(DI::app(), DI::l10n(), DI::baseUrl(), DI::args(), DI::logger(), DI::profiler(), DI::apiResponse(), []))->run();
}
public function testWithoutAuthenticatedUser()
public function testWrong()
{
$this->expectException(BadRequestException::class);
- (new Delete(DI::l10n(), ['photo_id' => 1]))->rawContent();
+ (new Delete(DI::app(), DI::l10n(), DI::baseUrl(), DI::args(), DI::logger(), DI::profiler(), DI::apiResponse(), []))->run(['photo_id' => 1]);
}
public function testWithCorrectPhotoId()
public function testEmpty()
{
$this->expectException(BadRequestException::class);
- (new Delete(DI::l10n()))->rawContent();
+ (new Delete(DI::app(), DI::l10n(), DI::baseUrl(), DI::args(), DI::logger(), DI::profiler(), DI::apiResponse(), []))->run();
+
}
public function testWrong()
{
$this->expectException(BadRequestException::class);
- (new Delete(DI::l10n(), ['album' => 'album_name']))->rawContent();
+ (new Delete(DI::app(), DI::l10n(), DI::baseUrl(), DI::args(), DI::logger(), DI::profiler(), DI::apiResponse(), []))->run(['album' => 'album_name']);
}
public function testValid()
public function testEmpty()
{
$this->expectException(BadRequestException::class);
- (new Update(DI::l10n()))->rawContent();
+ (new Update(DI::app(), DI::l10n(), DI::baseUrl(), DI::args(), DI::logger(), DI::profiler(), DI::apiResponse(), []))->run();
}
public function testTooFewArgs()
{
$this->expectException(BadRequestException::class);
- (new Update(DI::l10n(), ['album' => 'album_name']))->rawContent();
+ (new Update(DI::app(), DI::l10n(), DI::baseUrl(), DI::args(), DI::logger(), DI::profiler(), DI::apiResponse(), []))->run(['album' => 'album_name']);
}
public function testWrongUpdate()
{
$this->expectException(BadRequestException::class);
- (new Update(DI::l10n(), ['album' => 'album_name', 'album_new' => 'album_name']))->rawContent();
+ (new Update(DI::app(), DI::l10n(), DI::baseUrl(), DI::args(), DI::logger(), DI::profiler(), DI::apiResponse(), []))->run(['album' => 'album_name', 'album_new' => 'album_name']);
}
public function testWithoutAuthenticatedUser()
use Friendica\DI;
use Friendica\Module\Api\GNUSocial\GNUSocial\Version;
use Friendica\Test\src\Module\Api\ApiTest;
-use Friendica\Test\Util\ApiResponseDouble;
class VersionTest extends ApiTest
{
public function test()
{
- $version = new Version(DI::l10n(), ['extension' => 'json']);
- $version->rawContent();
+ $version = new Version(DI::app(), DI::l10n(), DI::baseUrl(), DI::args(), DI::logger(), DI::profiler(), DI::apiResponse(), [], ['extension' => 'json']);
+ $response = $version->run();
- $result = json_decode(ApiResponseDouble::getOutput());
-
- self::assertEquals('0.9.7', $result);
+ self::assertEquals('"0.9.7"', $response->getContent());
}
}
use Friendica\DI;
use Friendica\Module\Api\GNUSocial\Help\Test;
use Friendica\Test\src\Module\Api\ApiTest;
-use Friendica\Test\Util\ApiResponseDouble;
class TestTest extends ApiTest
{
public function testJson()
{
- $test = new Test(DI::l10n(), ['extension' => 'json']);
- $test->rawContent();
+ $test = new Test(DI::app(), DI::l10n(), DI::baseUrl(), DI::args(), DI::logger(), DI::profiler(), DI::apiResponse(), [], ['extension' => 'json']);
+ $response = $test->run();
- self::assertEquals('"ok"', ApiResponseDouble::getOutput());
+ self::assertEquals('"ok"', $response->getContent());
}
public function testXml()
{
- $test = new Test(DI::l10n(), ['extension' => 'xml']);
- $test->rawContent();
+ $test = new Test(DI::app(), DI::l10n(), DI::baseUrl(), DI::args(), DI::logger(), DI::profiler(), DI::apiResponse(), [], ['extension' => 'xml']);
+ $response = $test->run();
- self::assertxml(ApiResponseDouble::getOutput(), 'ok');
+ self::assertxml($response->getContent(), 'ok');
}
}
use Friendica\DI;
use Friendica\Module\Api\Twitter\Account\RateLimitStatus;
use Friendica\Test\src\Module\Api\ApiTest;
-use Friendica\Test\Util\ApiResponseDouble;
class RateLimitStatusTest extends ApiTest
{
public function testWithJson()
{
- $rateLimitStatus = new RateLimitStatus(DI::l10n(), ['extension' => 'json']);
- $rateLimitStatus->rawContent();
+ $rateLimitStatus = new RateLimitStatus(DI::app(), DI::l10n(), DI::baseUrl(), DI::args(), DI::logger(), DI::profiler(), DI::apiResponse(), [], ['extension' => 'json']);
+ $response = $rateLimitStatus->run();
- $result = json_decode(ApiResponseDouble::getOutput());
+ $result = json_decode($response->getContent());
self::assertEquals(150, $result->remaining_hits);
self::assertEquals(150, $result->hourly_limit);
public function testWithXml()
{
- $rateLimitStatus = new RateLimitStatus(DI::l10n(),['extension' => 'xml']);
- $rateLimitStatus->rawContent();
+ $rateLimitStatus = new RateLimitStatus(DI::app(), DI::l10n(), DI::baseUrl(), DI::args(), DI::logger(), DI::profiler(), DI::apiResponse(), [], ['extension' => 'xml']);
+ $response = $rateLimitStatus->run();
- self::assertXml(ApiResponseDouble::getOutput(), 'hash');
+ self::assertXml($response->getContent(), 'hash');
}
}
use Friendica\DI;
use Friendica\Module\Api\Twitter\SavedSearches;
use Friendica\Test\src\Module\Api\ApiTest;
-use Friendica\Test\Util\ApiResponseDouble;
class SavedSearchesTest extends ApiTest
{
public function test()
{
- $savedSearch = new SavedSearches(DI::l10n(), ['extension' => 'json']);
- $savedSearch->rawContent();
+ $savedSearch = new SavedSearches(DI::app(), DI::l10n(), DI::baseUrl(), DI::args(), DI::logger(), DI::profiler(), DI::apiResponse(), [], ['extension' => 'json']);
+ $response = $savedSearch->run();
- $result = json_decode(ApiResponseDouble::getOutput());
+ $result = json_decode($response->getContent());
self::assertEquals(1, $result[0]->id);
self::assertEquals(1, $result[0]->id_str);
projects / friendica.git / commitdiff