X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FBaseModule.php;h=be4788045c2d283d73c5c30080c1ebf661ee7710;hb=f00792d370cfbf1d52b37e3eed7e80e682df9d8a;hp=b812370fdf0d5b35f335d0e47005f148b23620fb;hpb=15b93b4459f051c1cf6d394a597399f17f9748f3;p=friendica.git diff --git a/src/BaseModule.php b/src/BaseModule.php index b812370fdf..be4788045c 100644 --- a/src/BaseModule.php +++ b/src/BaseModule.php @@ -21,6 +21,8 @@ namespace Friendica; +use Friendica\Capabilities\ICanHandleRequests; +use Friendica\Core\L10n; use Friendica\Core\Logger; use Friendica\Model\User; @@ -33,94 +35,90 @@ use Friendica\Model\User; * * @author Hypolite Petovan */ -abstract class BaseModule +abstract class BaseModule implements ICanHandleRequests { + /** @var array */ + protected $parameters = []; + + /** @var L10n */ + protected $l10n; + + public function __construct(L10n $l10n, array $parameters = []) + { + $this->parameters = $parameters; + $this->l10n = $l10n; + } + /** - * Initialization method common to both content() and post() + * Wraps the L10n::t() function for Modules * - * Extend this method if you need to do any shared processing before both - * content() or post() + * @see L10n::t() */ - public static function init(array $parameters = []) + protected function t(string $s, ...$args): string { + return $this->l10n->t($s, $args); } /** - * Module GET method to display raw content from technical endpoints + * Wraps the L10n::tt() function for Modules * - * Extend this method if the module is supposed to return communication data, - * e.g. from protocol implementations. + * @see L10n::tt() + */ + protected function tt(string $singular, string $plurarl, int $count): string + { + return $this->l10n->tt($singular, $plurarl, $count); + } + + /** + * {@inheritDoc} */ - public static function rawContent(array $parameters = []) + public function rawContent() { // echo ''; // exit; } /** - * Module GET method to display any content - * - * Extend this method if the module is supposed to return any display - * through a GET request. It can be an HTML page through templating or a - * XML feed or a JSON output. - * - * @return string + * {@inheritDoc} */ - public static function content(array $parameters = []) + public function content(): string { - $o = ''; - - return $o; + return ''; } /** - * Module DELETE method to process submitted data - * - * Extend this method if the module is supposed to process DELETE requests. - * Doesn't display any content + * {@inheritDoc} */ - public static function delete(array $parameters = []) + public function delete() { } /** - * Module PATCH method to process submitted data - * - * Extend this method if the module is supposed to process PATCH requests. - * Doesn't display any content + * {@inheritDoc} */ - public static function patch(array $parameters = []) + public function patch() { } /** - * Module POST method to process submitted data - * - * Extend this method if the module is supposed to process POST requests. - * Doesn't display any content + * {@inheritDoc} */ - public static function post(array $parameters = []) + public function post() { // DI::baseurl()->redirect('module'); } /** - * Called after post() - * - * Unknown purpose + * {@inheritDoc} */ - public static function afterpost(array $parameters = []) + public function put() { } - /** - * Module PUT method to process submitted data - * - * Extend this method if the module is supposed to process PUT requests. - * Doesn't display any content - */ - public static function put(array $parameters = []) + /** Gets the name of the current class */ + public function getClassName(): string { + return static::class; } /* @@ -136,7 +134,7 @@ abstract class BaseModule */ public static function getFormSecurityToken($typename = '') { - $user = User::getById(DI::app()->getUserId(), ['guid', 'prvkey']); + $user = User::getById(DI::app()->getLoggedInUserId(), ['guid', 'prvkey']); $timestamp = time(); $sec_hash = hash('whirlpool', ($user['guid'] ?? '') . ($user['prvkey'] ?? '') . session_id() . $timestamp . $typename); @@ -163,7 +161,7 @@ abstract class BaseModule $max_livetime = 10800; // 3 hours - $user = User::getById(DI::app()->getUserId(), ['guid', 'prvkey']); + $user = User::getById(DI::app()->getLoggedInUserId(), ['guid', 'prvkey']); $x = explode('.', $hash); if (time() > (intval($x[0]) + $max_livetime)) { @@ -183,8 +181,8 @@ abstract class BaseModule public static function checkFormSecurityTokenRedirectOnError($err_redirect, $typename = '', $formname = 'form_security_token') { if (!self::checkFormSecurityToken($typename, $formname)) { - Logger::log('checkFormSecurityToken failed: user ' . DI::app()->getLoggedInUserNickname() . ' - form element ' . $typename); - Logger::log('checkFormSecurityToken failed: _REQUEST data: ' . print_r($_REQUEST, true), Logger::DATA); + Logger::notice('checkFormSecurityToken failed: user ' . DI::app()->getLoggedInUserNickname() . ' - form element ' . $typename); + Logger::debug('checkFormSecurityToken failed', ['request' => $_REQUEST]); notice(self::getFormSecurityStandardErrorMessage()); DI::baseUrl()->redirect($err_redirect); } @@ -193,8 +191,8 @@ abstract class BaseModule public static function checkFormSecurityTokenForbiddenOnError($typename = '', $formname = 'form_security_token') { if (!self::checkFormSecurityToken($typename, $formname)) { - Logger::log('checkFormSecurityToken failed: user ' . DI::app()->getLoggedInUserNickname() . ' - form element ' . $typename); - Logger::log('checkFormSecurityToken failed: _REQUEST data: ' . print_r($_REQUEST, true), Logger::DATA); + Logger::notice('checkFormSecurityToken failed: user ' . DI::app()->getLoggedInUserNickname() . ' - form element ' . $typename); + Logger::debug('checkFormSecurityToken failed', ['request' => $_REQUEST]); throw new \Friendica\Network\HTTPException\ForbiddenException(); }