<?php
+/**
+ * @copyright Copyright (C) 2010-2021, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
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
*
* @author Hypolite Petovan <hypolite@mrpetovan.com>
*/
-abstract class BaseModule extends BaseObject
+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 = \get_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;
}
$max_livetime = 10800; // 3 hours
- $a = \get_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 = \get_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());
- $a->internalRedirect($err_redirect);
+ DI::baseUrl()->redirect($err_redirect);
}
}
public static function checkFormSecurityTokenForbiddenOnError($typename = '', $formname = 'form_security_token')
{
if (!self::checkFormSecurityToken($typename, $formname)) {
- $a = \get_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;
+ }
}
projects / friendica.git / blobdiff