Remove DI dependency from PermissionTooltip module

- Update PHPDoc of APContact::getByURL

diff --git a/src/Model/APContact.php b/src/Model/APContact.php
index 0b8a78a999ea3a026733b2b0cbbbd45e1261cbae..49b802f8ac3d1db1d1746b92754a8555f6165b00 100644 (file)
--- a/src/Model/APContact.php
+++ b/src/Model/APContact.php
@@ -105,14 +105,12 @@ class APContact
        /**
         * Fetches a profile from a given url
         *
-        * @param string  $url    profile url
-        * @param boolean $update true = always update, false = never update, null = update when not found or outdated
+        * @param string   $url    profile url
+        * @param ?boolean $update true = always update, false = never update, null = update when not found or outdated
         * @return array profile array
         * @throws \Friendica\Network\HTTPException\InternalServerErrorException
-        * @throws \ImagickException
-        * @todo Rewrite parameter $update to avoid true|false|null (boolean is binary, null adds a third case)
         */
-       public static function getByURL(string $url, $update = null): array
+       public static function getByURL(string $url, bool $update = null): array
        {
                if (empty($url) || Network::isUrlBlocked($url)) {
                        Logger::info('Domain is blocked', ['url' => $url]);

diff --git a/src/Module/PermissionTooltip.php b/src/Module/PermissionTooltip.php
index f4fd5665022b2c42579f6fe5b6a5e3a0361caa79..5c6b68b4cf34049cf08b8344811188ba5ced27fc 100644 (file)
--- a/src/Module/PermissionTooltip.php
+++ b/src/Module/PermissionTooltip.php
@@ -21,24 +21,43 @@
 
 namespace Friendica\Module;
 
+use Friendica\App;
+use Friendica\Core\Config\Capability\IManageConfigValues;
 use Friendica\Core\Hook;
+use Friendica\Core\L10n;
 use Friendica\Core\Protocol;
-use Friendica\Core\System;
-use Friendica\Database\DBA;
-use Friendica\DI;
-use Friendica\Model\APContact;
-use Friendica\Model\Circle;
-use Friendica\Model\Item;
-use Friendica\Model\Post;
-use Friendica\Model\Tag;
-use Friendica\Model\User;
+use Friendica\Core\Session\Capability\IHandleUserSessions;
+use Friendica\Database\Database;
+use Friendica\Model;
 use Friendica\Network\HTTPException;
+use Friendica\Network\HTTPException\InternalServerErrorException;
+use Friendica\Security\PermissionSet\Repository\PermissionSet;
+use Friendica\Util\ACLFormatter;
+use Friendica\Util\Profiler;
+use Psr\Log\LoggerInterface;
 
 /**
  * Outputs the permission tooltip HTML content for the provided item, photo or event id.
  */
 class PermissionTooltip extends \Friendica\BaseModule
 {
+       private Database $dba;
+       private ACLFormatter $aclFormatter;
+       private IHandleUserSessions $session;
+       private IManageConfigValues $config;
+       private PermissionSet $permissionSet;
+
+       public function __construct(PermissionSet $permissionSet, IManageConfigValues $config, IHandleUserSessions $session, ACLFormatter $aclFormatter, Database $dba, L10n $l10n, App\BaseURL $baseUrl, App\Arguments $args, LoggerInterface $logger, Profiler $profiler, Response $response, array $server, array $parameters = [])
+       {
+               parent::__construct($l10n, $baseUrl, $args, $logger, $profiler, $response, $server, $parameters);
+
+               $this->dba = $dba;
+               $this->aclFormatter = $aclFormatter;
+               $this->session = $session;
+               $this->config = $config;
+               $this->permissionSet = $permissionSet;
+       }
+
        protected function rawContent(array $request = [])
        {
                $type = $this->parameters['type'];
@@ -46,16 +65,16 @@ class PermissionTooltip extends \Friendica\BaseModule
 
                $expectedTypes = ['item', 'photo', 'event'];
                if (!in_array($type, $expectedTypes)) {
-                       throw new HTTPException\BadRequestException(DI::l10n()->t('Wrong type "%s", expected one of: %s', $type, implode(', ', $expectedTypes)));
+                       throw new HTTPException\BadRequestException($this->t('Wrong type "%s", expected one of: %s', $type, implode(', ', $expectedTypes)));
                }
 
-               $condition = ['id' => $referenceId, 'uid' => [0, DI::userSession()->getLocalUserId()]];
+               $condition = ['id' => $referenceId, 'uid' => [0, $this->session->getLocalUserId()]];
                if ($type == 'item') {
                        $fields = ['uid', 'psid', 'private', 'uri-id', 'origin', 'network'];
-                       $model = Post::selectFirst($fields, $condition, ['order' => ['uid' => true]]);
+                       $model = Model\Post::selectFirst($fields, $condition, ['order' => ['uid' => true]]);
 
                        if ($model['origin'] || ($model['network'] != Protocol::ACTIVITYPUB)) {
-                               $permissionSet = DI::permissionSet()->selectOneById($model['psid'], $model['uid']);
+                               $permissionSet = $this->permissionSet->selectOneById($model['psid'], $model['uid']);
                                $model['allow_cid'] = $permissionSet->allow_cid;
                                $model['allow_gid'] = $permissionSet->allow_gid;
                                $model['deny_cid']  = $permissionSet->deny_cid;
@@ -68,15 +87,15 @@ class PermissionTooltip extends \Friendica\BaseModule
                        }
                } else {
                        $fields = ['uid', 'allow_cid', 'allow_gid', 'deny_cid', 'deny_gid'];
-                       $model = DBA::selectFirst($type, $fields, $condition);
-                       $model['allow_cid'] = DI::aclFormatter()->expand($model['allow_cid']);
-                       $model['allow_gid'] = DI::aclFormatter()->expand($model['allow_gid']);
-                       $model['deny_cid']  = DI::aclFormatter()->expand($model['deny_cid']);
-                       $model['deny_gid']  = DI::aclFormatter()->expand($model['deny_gid']);
+                       $model = $this->dba->selectFirst($type, $fields, $condition);
+                       $model['allow_cid'] = $this->aclFormatter->expand($model['allow_cid']);
+                       $model['allow_gid'] = $this->aclFormatter->expand($model['allow_gid']);
+                       $model['deny_cid']  = $this->aclFormatter->expand($model['deny_cid']);
+                       $model['deny_gid']  = $this->aclFormatter->expand($model['deny_gid']);
                }
 
-               if (!DBA::isResult($model)) {
-                       throw new HttpException\NotFoundException(DI::l10n()->t('Model not found'));
+               if (!$this->dba->isResult($model)) {
+                       throw new HttpException\NotFoundException($this->t('Model not found'));
                }
 
                // Kept for backwards compatibility
@@ -86,16 +105,16 @@ class PermissionTooltip extends \Friendica\BaseModule
                        $receivers = $this->fetchReceivers($model['uri-id']);
                        if (empty($receivers)) {
                                switch ($model['private']) {
-                                       case Item::PUBLIC:
-                                               $receivers = DI::l10n()->t('Public');
+                                       case Model\Item::PUBLIC:
+                                               $receivers = $this->t('Public');
                                                break;
 
-                                       case Item::UNLISTED:
-                                               $receivers = DI::l10n()->t('Unlisted');
+                                       case Model\Item::UNLISTED:
+                                               $receivers = $this->t('Unlisted');
                                                break;
 
-                                       case Item::PRIVATE:
-                                               $receivers = DI::l10n()->t('Limited/Private');
+                                       case Model\Item::PRIVATE:
+                                               $receivers = $this->t('Limited/Private');
                                                break;
                                }
                        }
@@ -109,7 +128,7 @@ class PermissionTooltip extends \Friendica\BaseModule
                        && empty($model['deny_gid'])
                        && empty($receivers))
                {
-                       echo DI::l10n()->t('Remote privacy information not available.');
+                       echo $this->t('Remote privacy information not available.');
                        exit;
                }
 
@@ -117,16 +136,14 @@ class PermissionTooltip extends \Friendica\BaseModule
                        $receivers = $this->fetchReceiversFromACL($model);
                }
 
-               $this->httpExit(DI::l10n()->t('Visible to:') . '<br />' . $receivers);
+               $this->httpExit($this->t('Visible to:') . '<br />' . $receivers);
        }
 
        /**
         * Fetch a list of receivers based on the ACL data
-        *
-        * @param array $model
-        * @return string
+        * @throws \Exception
         */
-       private function fetchReceiversFromACL(array $model)
+       private function fetchReceiversFromACL(array $model): string
        {
                $allowed_users   = $model['allow_cid'];
                $allowed_circles = $model['allow_gid'];
@@ -136,46 +153,46 @@ class PermissionTooltip extends \Friendica\BaseModule
                $l = [];
 
                if (count($allowed_circles)) {
-                       $key = array_search(Circle::FOLLOWERS, $allowed_circles);
+                       $key = array_search(Model\Circle::FOLLOWERS, $allowed_circles);
                        if ($key !== false) {
-                               $l[] = '<b>' . DI::l10n()->t('Followers') . '</b>';
+                               $l[] = '<b>' . $this->t('Followers') . '</b>';
                                unset($allowed_circles[$key]);
                        }
 
-                       $key = array_search(Circle::MUTUALS, $allowed_circles);
+                       $key = array_search(Model\Circle::MUTUALS, $allowed_circles);
                        if ($key !== false) {
-                               $l[] = '<b>' . DI::l10n()->t('Mutuals') . '</b>';
+                               $l[] = '<b>' . $this->t('Mutuals') . '</b>';
                                unset($allowed_circles[$key]);
                        }
 
-                       foreach (DI::dba()->selectToArray('group', ['name'], ['id' => $allowed_circles]) as $circle) {
+                       foreach ($this->dba->selectToArray('group', ['name'], ['id' => $allowed_circles]) as $circle) {
                                $l[] = '<b>' . $circle['name'] . '</b>';
                        }
                }
 
-               foreach (DI::dba()->selectToArray('contact', ['name'], ['id' => $allowed_users]) as $contact) {
+               foreach ($this->dba->selectToArray('contact', ['name'], ['id' => $allowed_users]) as $contact) {
                        $l[] = $contact['name'];
                }
 
                if (count($deny_circles)) {
-                       $key = array_search(Circle::FOLLOWERS, $deny_circles);
+                       $key = array_search(Model\Circle::FOLLOWERS, $deny_circles);
                        if ($key !== false) {
-                               $l[] = '<b><strike>' . DI::l10n()->t('Followers') . '</strike></b>';
+                               $l[] = '<b><strike>' . $this->t('Followers') . '</strike></b>';
                                unset($deny_circles[$key]);
                        }
 
-                       $key = array_search(Circle::MUTUALS, $deny_circles);
+                       $key = array_search(Model\Circle::MUTUALS, $deny_circles);
                        if ($key !== false) {
-                               $l[] = '<b><strike>' . DI::l10n()->t('Mutuals') . '</strike></b>';
+                               $l[] = '<b><strike>' . $this->t('Mutuals') . '</strike></b>';
                                unset($deny_circles[$key]);
                        }
 
-                       foreach (DI::dba()->selectToArray('group', ['name'], ['id' => $allowed_circles]) as $circle) {
+                       foreach ($this->dba->selectToArray('group', ['name'], ['id' => $allowed_circles]) as $circle) {
                                $l[] = '<b><strike>' . $circle['name'] . '</strike></b>';
                        }
                }
 
-               foreach (DI::dba()->selectToArray('contact', ['name'], ['id' => $deny_users]) as $contact) {
+               foreach ($this->dba->selectToArray('contact', ['name'], ['id' => $deny_users]) as $contact) {
                        $l[] = '<strike>' . $contact['name'] . '</strike>';
                }
 
@@ -184,41 +201,39 @@ class PermissionTooltip extends \Friendica\BaseModule
 
        /**
         * Fetch a list of receivers
-        *
-        * @param int $uriId
-        * @return string
+        * @throws InternalServerErrorException
         */
        private function fetchReceivers(int $uriId): string
        {
                $own_url = '';
-               $uid = DI::userSession()->getLocalUserId();
+               $uid = $this->session->getLocalUserId();
                if ($uid) {
-                       $owner = User::getOwnerDataById($uid);
+                       $owner = Model\User::getOwnerDataById($uid);
                        if (!empty($owner['url'])) {
                                $own_url = $owner['url'];
                        }
                }
 
                $receivers = [];
-               foreach (Tag::getByURIId($uriId, [Tag::TO, Tag::CC, Tag::BCC, Tag::AUDIENCE, Tag::ATTRIBUTED]) as $receiver) {
+               foreach (Model\Tag::getByURIId($uriId, [Model\Tag::TO, Model\Tag::CC, Model\Tag::BCC, Model\Tag::AUDIENCE, Model\Tag::ATTRIBUTED]) as $receiver) {
                        // We only display BCC when it contains the current user
-                       if (($receiver['type'] == Tag::BCC) && ($receiver['url'] != $own_url)) {
+                       if (($receiver['type'] == Model\Tag::BCC) && ($receiver['url'] != $own_url)) {
                                continue;
                        }
 
-                       switch (Tag::getTargetType($receiver['url'], false)) {
-                               case Tag::PUBLIC_COLLECTION:
-                                       $receivers[$receiver['type']][] = DI::l10n()->t('Public');
+                       switch (Model\Tag::getTargetType($receiver['url'], false)) {
+                               case Model\Tag::PUBLIC_COLLECTION:
+                                       $receivers[$receiver['type']][] = $this->t('Public');
                                        break;
-                               case Tag::GENERAL_COLLECTION:
-                                       $receivers[$receiver['type']][] = DI::l10n()->t('Collection (%s)', $receiver['name']);
+                               case Model\Tag::GENERAL_COLLECTION:
+                                       $receivers[$receiver['type']][] = $this->t('Collection (%s)', $receiver['name']);
                                        break;
-                               case Tag::FOLLOWER_COLLECTION:
-                                       $apcontact = DBA::selectFirst('apcontact', ['name'], ['followers' => $receiver['url']]);
-                                       $receivers[$receiver['type']][] = DI::l10n()->t('Followers (%s)', $apcontact['name'] ?? $receiver['name']);
+                               case Model\Tag::FOLLOWER_COLLECTION:
+                                       $apcontact = $this->dba->selectFirst('apcontact', ['name'], ['followers' => $receiver['url']]);
+                                       $receivers[$receiver['type']][] = $this->t('Followers (%s)', $apcontact['name'] ?? $receiver['name']);
                                        break;
-                               case Tag::ACCOUNT:
-                                       $apcontact = APContact::getByURL($receiver['url'], false);
+                               case Model\Tag::ACCOUNT:
+                                       $apcontact = Model\APContact::getByURL($receiver['url'], false);
                                        $receivers[$receiver['type']][] = $apcontact['name'] ?? $receiver['name'];
                                        break;
                                default:
@@ -230,27 +245,27 @@ class PermissionTooltip extends \Friendica\BaseModule
                $output = '';
 
                foreach ($receivers as $type => $receiver) {
-                       $max = DI::config()->get('system', 'max_receivers');
+                       $max = $this->config->get('system', 'max_receivers');
                        $total = count($receiver);
                        if ($total > $max) {
                                $receiver = array_slice($receiver, 0, $max);
-                               $receiver[] = DI::l10n()->t('%d more', $total - $max);
+                               $receiver[] = $this->t('%d more', $total - $max);
                        }
                        switch ($type) {
-                               case Tag::TO:
-                                       $output .= DI::l10n()->t('<b>To:</b> %s<br>', implode(', ', $receiver));
+                               case Model\Tag::TO:
+                                       $output .= $this->t('<b>To:</b> %s<br>', implode(', ', $receiver));
                                        break;
-                               case Tag::CC:
-                                       $output .= DI::l10n()->t('<b>CC:</b> %s<br>', implode(', ', $receiver));
+                               case Model\Tag::CC:
+                                       $output .= $this->t('<b>CC:</b> %s<br>', implode(', ', $receiver));
                                        break;
-                               case Tag::BCC:
-                                       $output .= DI::l10n()->t('<b>BCC:</b> %s<br>', implode(', ', $receiver));
+                               case Model\Tag::BCC:
+                                       $output .= $this->t('<b>BCC:</b> %s<br>', implode(', ', $receiver));
                                        break;
-                               case Tag::AUDIENCE:
-                                       $output .= DI::l10n()->t('<b>Audience:</b> %s<br>', implode(', ', $receiver));
+                               case Model\Tag::AUDIENCE:
+                                       $output .= $this->t('<b>Audience:</b> %s<br>', implode(', ', $receiver));
                                        break;
-                               case Tag::ATTRIBUTED:
-                                       $output .= DI::l10n()->t('<b>Attributed To:</b> %s<br>', implode(', ', $receiver));
+                               case Model\Tag::ATTRIBUTED:
+                                       $output .= $this->t('<b>Attributed To:</b> %s<br>', implode(', ', $receiver));
                                        break;
                        }
                }