X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FBaseModule.php;h=be4788045c2d283d73c5c30080c1ebf661ee7710;hb=f00792d370cfbf1d52b37e3eed7e80e682df9d8a;hp=61bfe8e8d3d7fbcaf802f39e640f7d59d16b6782;hpb=f0eea6f87590f10081f5bc61395bb7eca9e76ec5;p=friendica.git diff --git a/src/BaseModule.php b/src/BaseModule.php index 61bfe8e8d3..be4788045c 100644 --- a/src/BaseModule.php +++ b/src/BaseModule.php @@ -1,9 +1,30 @@ . + * + */ namespace Friendica; +use Friendica\Capabilities\ICanHandleRequests; use Friendica\Core\L10n; use Friendica\Core\Logger; +use Friendica\Model\User; /** * All modules in Friendica should extend BaseModule, although not all modules @@ -14,84 +35,108 @@ use Friendica\Core\Logger; * * @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; + } + /** - * @brief 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); } /** - * @brief 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; } /** - * @brief 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 ''; + } - return $o; + /** + * {@inheritDoc} + */ + public function delete() + { } /** - * @brief 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 patch() { - // $a = self::getApp(); - // $a->internalRedirect('module'); } /** - * @brief Called after post() - * - * Unknown purpose + * {@inheritDoc} + */ + public function post() + { + // DI::baseurl()->redirect('module'); + } + + /** + * {@inheritDoc} */ - public static function afterpost(array $parameters = []) + public function put() { } + /** Gets the name of the current class */ + public function getClassName(): string + { + return static::class; + } + /* * Functions used to protect against Cross-Site Request Forgery * The security token has to base on at least one value that an attacker can't know - here it's the session ID and the private key. * In this implementation, a security token is reusable (if the user submits a form, goes back and resubmits the form, maybe with small changes; - * or if the security token is used for ajax-calls that happen several times), but only valid for a certain amout of time (3hours). - * The "typename" seperates the security tokens of different types of forms. This could be relevant in the following case: - * A security token is used to protekt a link from CSRF (e.g. the "delete this profile"-link). + * or if the security token is used for ajax-calls that happen several times), but only valid for a certain amount of time (3hours). + * The "typename" separates the security tokens of different types of forms. This could be relevant in the following case: + * A security token is used to protect a link from CSRF (e.g. the "delete this profile"-link). * If the new page contains by any chance external elements, then the used security token is exposed by the referrer. - * Actually, important actions should not be triggered by Links / GET-Requests at all, but somethimes they still are, + * Actually, important actions should not be triggered by Links / GET-Requests at all, but sometimes they still are, * so this mechanism brings in some damage control (the attacker would be able to forge a request to a form of this type, but not to forms of other types). */ public static function getFormSecurityToken($typename = '') { - $a = DI::app(); - + $user = User::getById(DI::app()->getLoggedInUserId(), ['guid', 'prvkey']); $timestamp = time(); - $sec_hash = hash('whirlpool', $a->user['guid'] . $a->user['prvkey'] . session_id() . $timestamp . $typename); + $sec_hash = hash('whirlpool', ($user['guid'] ?? '') . ($user['prvkey'] ?? '') . session_id() . $timestamp . $typename); return $timestamp . '.' . $sec_hash; } @@ -116,29 +161,28 @@ abstract class BaseModule $max_livetime = 10800; // 3 hours - $a = DI::app(); + $user = User::getById(DI::app()->getLoggedInUserId(), ['guid', 'prvkey']); $x = explode('.', $hash); if (time() > (intval($x[0]) + $max_livetime)) { return false; } - $sec_hash = hash('whirlpool', $a->user['guid'] . $a->user['prvkey'] . session_id() . $x[0] . $typename); + $sec_hash = hash('whirlpool', ($user['guid'] ?? '') . ($user['prvkey'] ?? '') . session_id() . $x[0] . $typename); return ($sec_hash == $x[1]); } public static function getFormSecurityStandardErrorMessage() { - return L10n::t("The form security token was not correct. This probably happened because the form has been opened for too long \x28>3 hours\x29 before submitting it.") . EOL; + return DI::l10n()->t("The form security token was not correct. This probably happened because the form has been opened for too long \x28>3 hours\x29 before submitting it.") . EOL; } public static function checkFormSecurityTokenRedirectOnError($err_redirect, $typename = '', $formname = 'form_security_token') { if (!self::checkFormSecurityToken($typename, $formname)) { - $a = DI::app(); - Logger::log('checkFormSecurityToken failed: user ' . $a->user['guid'] . ' - 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); } @@ -147,11 +191,46 @@ abstract class BaseModule public static function checkFormSecurityTokenForbiddenOnError($typename = '', $formname = 'form_security_token') { if (!self::checkFormSecurityToken($typename, $formname)) { - $a = DI::app(); - Logger::log('checkFormSecurityToken failed: user ' . $a->user['guid'] . ' - 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(); } } + + protected static function getContactFilterTabs(string $baseUrl, string $current, bool $displayCommonTab) + { + $tabs = [ + [ + 'label' => DI::l10n()->t('All contacts'), + 'url' => $baseUrl . '/contacts', + 'sel' => !$current || $current == 'all' ? 'active' : '', + ], + [ + 'label' => DI::l10n()->t('Followers'), + 'url' => $baseUrl . '/contacts/followers', + 'sel' => $current == 'followers' ? 'active' : '', + ], + [ + 'label' => DI::l10n()->t('Following'), + 'url' => $baseUrl . '/contacts/following', + 'sel' => $current == 'following' ? 'active' : '', + ], + [ + 'label' => DI::l10n()->t('Mutual friends'), + 'url' => $baseUrl . '/contacts/mutuals', + 'sel' => $current == 'mutuals' ? 'active' : '', + ], + ]; + + if ($displayCommonTab) { + $tabs[] = [ + 'label' => DI::l10n()->t('Common'), + 'url' => $baseUrl . '/contacts/common', + 'sel' => $current == 'common' ? 'active' : '', + ]; + } + + return $tabs; + } }