. */ declare(strict_types=1); namespace Fisharebest\Webtrees\Services; use Fisharebest\Webtrees\Auth; use Fisharebest\Webtrees\Contracts\UserInterface; use Fisharebest\Webtrees\I18N; use Fisharebest\Webtrees\Registry; use Fisharebest\Webtrees\SiteUser; use Fisharebest\Webtrees\Tree; use Fisharebest\Webtrees\User; 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 { // Users can be contacted by various methods public const CONTACT_METHOD_INTERNAL = 'messaging'; public const CONTACT_METHOD_INTERNAL_AND_EMAIL = 'messaging2'; public const CONTACT_METHOD_EMAIL = 'messaging3'; public const CONTACT_METHOD_MAILTO = 'mailto'; public const CONTACT_METHOD_NONE = 'none'; private const BROADCAST_ALL = 'all'; private const BROADCAST_NEVER = 'never'; private const BROADCAST_GONE = 'gone'; private EmailService $email_service; private UserService $user_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 array */ 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(UserInterface::PREF_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(UserInterface::PREF_CONTACT_METHOD), [ self::CONTACT_METHOD_INTERNAL, self::CONTACT_METHOD_INTERNAL_AND_EMAIL, self::CONTACT_METHOD_MAILTO, self::CONTACT_METHOD_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(UserInterface::PREF_CONTACT_METHOD), [ MessageService::CONTACT_METHOD_INTERNAL_AND_EMAIL, MessageService::CONTACT_METHOD_EMAIL, self::CONTACT_METHOD_MAILTO, self::CONTACT_METHOD_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 self::BROADCAST_ALL: return $this->user_service->all(); case self::BROADCAST_NEVER: return $this->user_service->all()->filter(static function (UserInterface $user): bool { return $user->getPreference(UserInterface::PREF_IS_ACCOUNT_APPROVED) === '1' && $user->getPreference(UserInterface::PREF_TIMESTAMP_REGISTERED) > $user->getPreference(UserInterface::PREF_TIMESTAMP_ACTIVE); }); case self::BROADCAST_GONE: $six_months_ago = Registry::timestampFactory()->now()->subtractMonths(6)->timestamp(); return $this->user_service->all()->filter(static function (UserInterface $user) use ($six_months_ago): bool { $session_time = (int) $user->getPreference(UserInterface::PREF_TIMESTAMP_ACTIVE); return $session_time > 0 && $session_time < $six_months_ago; }); } } /** * Recipients for broadcast messages * * @return array */ public function recipientTypes(): array { return [ self::BROADCAST_ALL => I18N::translate('Send a message to all users'), self::BROADCAST_NEVER => I18N::translate('Send a message to users who have never signed in'), self::BROADCAST_GONE => I18N::translate('Send a message to users who have not signed in for 6 months'), ]; } /** * A list of contact methods (e.g. for an edit control). * * @return array */ public function contactMethods(): array { return [ self::CONTACT_METHOD_INTERNAL => I18N::translate('Internal messaging'), self::CONTACT_METHOD_INTERNAL_AND_EMAIL => I18N::translate('Internal messaging with emails'), self::CONTACT_METHOD_EMAIL => I18N::translate('webtrees sends emails with no storage'), self::CONTACT_METHOD_MAILTO => I18N::translate('Mailto link'), self::CONTACT_METHOD_NONE => I18N::translate('No contact'), ]; } }