MessageService::__construct() - Code Metrics - Inspection of "Fix: #2719 cannot send messages using ugly urls; r..." - fisharebest/webtrees - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 149810...e381f9 )

by Greg

created 2019-11-01 19:45 UTC

MessageService::__construct() A

↳ Parent: MessageService

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	2
c	1
b	0
f	0
nc	1
nop	2
dl	0
loc	4
rs	10

<?php

/**
 * webtrees: online genealogy
 * Copyright (C) 2019 webtrees development team
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU 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 General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

declare(strict_types=1);

namespace Fisharebest\Webtrees\Services;

use Fisharebest\Webtrees\Auth;
use Fisharebest\Webtrees\Carbon;
use Fisharebest\Webtrees\Contracts\UserInterface;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\SiteUser;
use Fisharebest\Webtrees\Tree;
use Illuminate\Database\Capsule\Manager as DB;
use Illuminate\Support\Collection;

use function array_filter;
use function in_array;
use function view;

/**
 * Send messages between users and from visitors to the site.
 */
class MessageService
{
    /** @var UserService */
    private $user_service;

    /** @var EmailService */
    private $email_service;

    /**
     * MessageService constructor.
     *
     * @param EmailService $email_service
     * @param UserService  $user_service
     */
    public function __construct(EmailService $email_service, UserService $user_service)
    {
        $this->email_service = $email_service;
        $this->user_service  = $user_service;
    }

    /**
     * Contact messages can only be sent to the designated contacts
     *
     * @param Tree $tree
     *
     * @return UserInterface[]
     */
    public function validContacts(Tree $tree): array
    {
        $contacts = [
            $this->user_service->find((int) $tree->getPreference('CONTACT_USER_ID')),
            $this->user_service->find((int) $tree->getPreference('WEBMASTER_USER_ID')),
        ];

        return array_filter($contacts);
    }

    /**
     * Add a message to a user's inbox, send it to them via email, or both.
     *
     * @param UserInterface $sender
     * @param UserInterface $recipient
     * @param string        $subject
     * @param string        $body
     * @param string        $url
     * @param string        $ip
     *
     * @return bool
     */
    public function deliverMessage(UserInterface $sender, UserInterface $recipient, string $subject, string $body, string $url, string $ip): bool
    {
        $success = true;

        // Temporarily switch to the recipient's language
        $old_language = I18N::languageTag();
        I18N::init($recipient->getPreference('language'));

        $body_text = view('emails/message-user-text', [
            'sender'    => $sender,
            'recipient' => $recipient,
            'message'   => $body,
            'url'       => $url,
        ]);

        $body_html = view('emails/message-user-html', [
            'sender'    => $sender,
            'recipient' => $recipient,
            'message'   => $body,
            'url'       => $url,
        ]);

        // Send via the internal messaging system.
        if ($this->sendInternalMessage($recipient)) {
            DB::table('message')->insert([
                'sender'     => Auth::check() ? Auth::user()->email() : $sender->email(),
                'ip_address' => $ip,
                'user_id'    => $recipient->id(),
                'subject'    => $subject,
                'body'       => $body_text,
            ]);
        }

        // Send via email
        if ($this->sendEmail($recipient)) {
            $success = $this->email_service->send(
                new SiteUser(),
                $recipient,
                $sender,
                I18N::translate('webtrees message') . ' - ' . $subject,
                $body_text,
                $body_html
            );
        }

        I18N::init($old_language);

        return $success;
    }

    /**
     * Should we send messages to this user via internal messaging?
     *
     * @param UserInterface $user
     *
     * @return bool
     */
    public function sendInternalMessage(UserInterface $user): bool
    {
        return in_array($user->getPreference('contactmethod'), [
            'messaging',
            'messaging2',
            'mailto',
            'none',
        ], true);
    }

    /**
     * Should we send messages to this user via email?
     *
     * @param UserInterface $user
     *
     * @return bool
     */
    public function sendEmail(UserInterface $user): bool
    {
        return in_array($user->getPreference('contactmethod'), [
            'messaging2',
            'messaging3',
            'mailto',
            'none',
        ], true);
    }

    /**
     * Convert a username (or mailing list name) into an array of recipients.
     *
     * @param string $to
     *
     * @return Collection
     */
    public function recipientUsers(string $to): Collection
    {
        switch ($to) {
            default:
            case 'all':
                return $this->user_service->all();
            case 'never_logged':
                return $this->user_service->all()->filter(static function (UserInterface $user): bool {
                    return $user->getPreference('verified_by_admin') && $user->getPreference('reg_timestamp') > $user->getPreference('sessiontime');
                });
            case 'last_6mo':
                $six_months_ago = Carbon::now()->subMonths(6)->unix();

                return $this->user_service->all()->filter(static function (UserInterface $user) use ($six_months_ago): bool {
                    $session_time = (int) $user->getPreference('sessiontime');

                    return $session_time > 0 && $session_time < $six_months_ago;
                });
        }
    }

    /**
     * @param string $to
     *
     * @return string
     */
    public function recipientDescription(string $to): string
    {
        switch ($to) {
            default:
            case 'all':
                return I18N::translate('Send a message to all users');
            case 'never_logged':
                return I18N::translate('Send a message to users who have never signed in');
            case 'last_6mo':
                return I18N::translate('Send a message to users who have not signed in for 6 months');
        }
    }
}


1			<?php
2
3			/**
4			* webtrees: online genealogy
5			* Copyright (C) 2019 webtrees development team
6			* This program is free software: you can redistribute it and/or modify
7			* it under the terms of the GNU General Public License as published by
8			* the Free Software Foundation, either version 3 of the License, or
9			* (at your option) any later version.
10			* This program is distributed in the hope that it will be useful,
11			* but WITHOUT ANY WARRANTY; without even the implied warranty of
12			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13			* GNU General Public License for more details.
14			* You should have received a copy of the GNU General Public License
15			* along with this program. If not, see <http://www.gnu.org/licenses/>.
16			*/
17
18			declare(strict_types=1);
19
20			namespace Fisharebest\Webtrees\Services;
21
22			use Fisharebest\Webtrees\Auth;
23			use Fisharebest\Webtrees\Carbon;
24			use Fisharebest\Webtrees\Contracts\UserInterface;
25			use Fisharebest\Webtrees\I18N;
26			use Fisharebest\Webtrees\SiteUser;
27			use Fisharebest\Webtrees\Tree;
28			use Illuminate\Database\Capsule\Manager as DB;
29			use Illuminate\Support\Collection;
30
31			use function array_filter;
32			use function in_array;
33			use function view;
34
35			/**
36			* Send messages between users and from visitors to the site.
37			*/
38			class MessageService
39			{
40			/** @var UserService */
41			private $user_service;
42
43			/** @var EmailService */
44			private $email_service;
45
46			/**
47			* MessageService constructor.
48			*
49			* @param EmailService $email_service
50			* @param UserService $user_service
51			*/
52			public function __construct(EmailService $email_service, UserService $user_service)
53			{
54			$this->email_service = $email_service;
55			$this->user_service = $user_service;
56			}
57
58			/**
59			* Contact messages can only be sent to the designated contacts
60			*
61			* @param Tree $tree
62			*
63			* @return UserInterface[]
64			*/
65			public function validContacts(Tree $tree): array
66			{
67			$contacts = [
68			$this->user_service->find((int) $tree->getPreference('CONTACT_USER_ID')),
69			$this->user_service->find((int) $tree->getPreference('WEBMASTER_USER_ID')),
70			];
71
72			return array_filter($contacts);
73			}
74
75			/**
76			* Add a message to a user's inbox, send it to them via email, or both.
77			*
78			* @param UserInterface $sender
79			* @param UserInterface $recipient
80			* @param string $subject
81			* @param string $body
82			* @param string $url
83			* @param string $ip
84			*
85			* @return bool
86			*/
87			public function deliverMessage(UserInterface $sender, UserInterface $recipient, string $subject, string $body, string $url, string $ip): bool
88			{
89			$success = true;
90
91			// Temporarily switch to the recipient's language
92			$old_language = I18N::languageTag();
93			I18N::init($recipient->getPreference('language'));
94
95			$body_text = view('emails/message-user-text', [
96			'sender' => $sender,
97			'recipient' => $recipient,
98			'message' => $body,
99			'url' => $url,
100			]);
101
102			$body_html = view('emails/message-user-html', [
103			'sender' => $sender,
104			'recipient' => $recipient,
105			'message' => $body,
106			'url' => $url,
107			]);
108
109			// Send via the internal messaging system.
110			if ($this->sendInternalMessage($recipient)) {
111			DB::table('message')->insert([
112			'sender' => Auth::check() ? Auth::user()->email() : $sender->email(),
113			'ip_address' => $ip,
114			'user_id' => $recipient->id(),
115			'subject' => $subject,
116			'body' => $body_text,
117			]);
118			}
119
120			// Send via email
121			if ($this->sendEmail($recipient)) {
122			$success = $this->email_service->send(
123			new SiteUser(),
124			$recipient,
125			$sender,
126			I18N::translate('webtrees message') . ' - ' . $subject,
127			$body_text,
128			$body_html
129			);
130			}
131
132			I18N::init($old_language);
133
134			return $success;
135			}
136
137			/**
138			* Should we send messages to this user via internal messaging?
139			*
140			* @param UserInterface $user
141			*
142			* @return bool
143			*/
144			public function sendInternalMessage(UserInterface $user): bool
145			{
146			return in_array($user->getPreference('contactmethod'), [
147			'messaging',
148			'messaging2',
149			'mailto',
150			'none',
151			], true);
152			}
153
154			/**
155			* Should we send messages to this user via email?
156			*
157			* @param UserInterface $user
158			*
159			* @return bool
160			*/
161			public function sendEmail(UserInterface $user): bool
162			{
163			return in_array($user->getPreference('contactmethod'), [
164			'messaging2',
165			'messaging3',
166			'mailto',
167			'none',
168			], true);
169			}
170
171			/**
172			* Convert a username (or mailing list name) into an array of recipients.
173			*
174			* @param string $to
175			*
176			* @return Collection
177			*/
178			public function recipientUsers(string $to): Collection
179			{
180			switch ($to) {
181			default:
182			case 'all':
183			return $this->user_service->all();
184			case 'never_logged':
185			return $this->user_service->all()->filter(static function (UserInterface $user): bool {
186			return $user->getPreference('verified_by_admin') && $user->getPreference('reg_timestamp') > $user->getPreference('sessiontime');
187			});
188			case 'last_6mo':
189			$six_months_ago = Carbon::now()->subMonths(6)->unix();
190
191			return $this->user_service->all()->filter(static function (UserInterface $user) use ($six_months_ago): bool {
192			$session_time = (int) $user->getPreference('sessiontime');
193
194			return $session_time > 0 && $session_time < $six_months_ago;
195			});
196			}
197			}
198
199			/**
200			* @param string $to
201			*
202			* @return string
203			*/
204			public function recipientDescription(string $to): string
205			{
206			switch ($to) {
207			default:
208			case 'all':
209			return I18N::translate('Send a message to all users');
210			case 'never_logged':
211			return I18N::translate('Send a message to users who have never signed in');
212			case 'last_6mo':
213			return I18N::translate('Send a message to users who have not signed in for 6 months');
214			}
215			}
216			}
217

fisharebest / webtrees

Push — master ( 149810...e381f9 )

MessageService::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like