xref: /webtrees/app/Module/UserMessagesModule.php (revision b46c87bda4b592cf9252f1db48552a820b1e3d97)
18c2e8227SGreg Roach<?php
23976b470SGreg Roach
38c2e8227SGreg Roach/**
48c2e8227SGreg Roach * webtrees: online genealogy
58fcd0d32SGreg Roach * Copyright (C) 2019 webtrees development team
68c2e8227SGreg Roach * This program is free software: you can redistribute it and/or modify
78c2e8227SGreg Roach * it under the terms of the GNU General Public License as published by
88c2e8227SGreg Roach * the Free Software Foundation, either version 3 of the License, or
98c2e8227SGreg Roach * (at your option) any later version.
108c2e8227SGreg Roach * This program is distributed in the hope that it will be useful,
118c2e8227SGreg Roach * but WITHOUT ANY WARRANTY; without even the implied warranty of
128c2e8227SGreg Roach * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
138c2e8227SGreg Roach * GNU General Public License for more details.
148c2e8227SGreg Roach * You should have received a copy of the GNU General Public License
158c2e8227SGreg Roach * along with this program. If not, see <http://www.gnu.org/licenses/>.
168c2e8227SGreg Roach */
17fcfa147eSGreg Roach
18e7f56f2aSGreg Roachdeclare(strict_types=1);
19e7f56f2aSGreg Roach
2076692c8bSGreg Roachnamespace Fisharebest\Webtrees\Module;
2176692c8bSGreg Roach
220e62c4b8SGreg Roachuse Fisharebest\Webtrees\Auth;
234459dc9aSGreg Roachuse Fisharebest\Webtrees\Carbon;
24e5a6b4d4SGreg Roachuse Fisharebest\Webtrees\Contracts\UserInterface;
250e62c4b8SGreg Roachuse Fisharebest\Webtrees\Filter;
260bf22806SGreg Roachuse Fisharebest\Webtrees\Http\Controllers\HomePageController;
27e381f98dSGreg Roachuse Fisharebest\Webtrees\Http\RequestHandlers\MessagePage;
28e381f98dSGreg Roachuse Fisharebest\Webtrees\Http\RequestHandlers\MessageSelect;
290e62c4b8SGreg Roachuse Fisharebest\Webtrees\I18N;
30e5a6b4d4SGreg Roachuse Fisharebest\Webtrees\Services\UserService;
31cf700360SGreg Roachuse Fisharebest\Webtrees\Tree;
320e62c4b8SGreg Roachuse Fisharebest\Webtrees\User;
33d39b150cSGreg Roachuse Illuminate\Database\Capsule\Manager as DB;
341e7a7a28SGreg Roachuse Illuminate\Support\Str;
356ccdf4f0SGreg Roachuse Psr\Http\Message\ResponseInterface;
366ccdf4f0SGreg Roachuse Psr\Http\Message\ServerRequestInterface;
37ca52a408SGreg Roachuse stdClass;
3871378461SGreg Roach
394ea62551SGreg Roachuse function assert;
4083615acfSGreg Roachuse function e;
4183615acfSGreg Roachuse function route;
428c2e8227SGreg Roach
438c2e8227SGreg Roach/**
448c2e8227SGreg Roach * Class UserMessagesModule
458c2e8227SGreg Roach */
4637eb8894SGreg Roachclass UserMessagesModule extends AbstractModule implements ModuleBlockInterface
47c1010edaSGreg Roach{
4849a243cbSGreg Roach    use ModuleBlockTrait;
4949a243cbSGreg Roach
50961ec755SGreg Roach    /**
51e5a6b4d4SGreg Roach     * @var UserService
52e5a6b4d4SGreg Roach     */
53e5a6b4d4SGreg Roach    private $user_service;
54e5a6b4d4SGreg Roach
55e5a6b4d4SGreg Roach    /**
56e5a6b4d4SGreg Roach     * UserMessagesModule constructor.
57e5a6b4d4SGreg Roach     *
58e5a6b4d4SGreg Roach     * @param UserService $user_service
59e5a6b4d4SGreg Roach     */
60e2cbf57aSGreg Roach    public function __construct(UserService $user_service)
61e2cbf57aSGreg Roach    {
62e5a6b4d4SGreg Roach        $this->user_service = $user_service;
63e5a6b4d4SGreg Roach    }
64e5a6b4d4SGreg Roach
65e5a6b4d4SGreg Roach    /**
660cfd6963SGreg Roach     * How should this module be identified in the control panel, etc.?
67961ec755SGreg Roach     *
68961ec755SGreg Roach     * @return string
69961ec755SGreg Roach     */
7049a243cbSGreg Roach    public function title(): string
71c1010edaSGreg Roach    {
72bbb76c12SGreg Roach        /* I18N: Name of a module */
73bbb76c12SGreg Roach        return I18N::translate('Messages');
748c2e8227SGreg Roach    }
758c2e8227SGreg Roach
76961ec755SGreg Roach    /**
77961ec755SGreg Roach     * A sentence describing what this module does.
78961ec755SGreg Roach     *
79961ec755SGreg Roach     * @return string
80961ec755SGreg Roach     */
8149a243cbSGreg Roach    public function description(): string
82c1010edaSGreg Roach    {
83bbb76c12SGreg Roach        /* I18N: Description of the “Messages” module */
84bbb76c12SGreg Roach        return I18N::translate('Communicate directly with other users, using private messages.');
858c2e8227SGreg Roach    }
868c2e8227SGreg Roach
8776692c8bSGreg Roach    /**
88cf700360SGreg Roach     * Delete one or messages belonging to a user.
892da2404eSGreg Roach     *
906ccdf4f0SGreg Roach     * @param ServerRequestInterface $request
91cf700360SGreg Roach     *
926ccdf4f0SGreg Roach     * @return ResponseInterface
932da2404eSGreg Roach     */
9457ab2231SGreg Roach    public function postDeleteMessageAction(ServerRequestInterface $request): ResponseInterface
95c1010edaSGreg Roach    {
9657ab2231SGreg Roach        $tree = $request->getAttribute('tree');
974ea62551SGreg Roach        assert($tree instanceof Tree);
984ea62551SGreg Roach
99*b46c87bdSGreg Roach        $params = (array) $request->getParsedBody();
100*b46c87bdSGreg Roach
101*b46c87bdSGreg Roach        $message_ids = $params['message_id'] ?? [];
102cf700360SGreg Roach
103d39b150cSGreg Roach        DB::table('message')
104d39b150cSGreg Roach            ->where('user_id', '=', Auth::id())
105d39b150cSGreg Roach            ->whereIn('message_id', $message_ids)
106d39b150cSGreg Roach            ->delete();
107cf700360SGreg Roach
1083caaa4d2SGreg Roach        if ($request->getQueryParams()['context'] === ModuleBlockInterface::CONTEXT_USER_PAGE) {
109d72b284aSGreg Roach            $url = route('user-page', ['tree' => $tree->name()]);
110cf700360SGreg Roach        } else {
111d72b284aSGreg Roach            $url = route('tree-page', ['tree' => $tree->name()]);
1122da2404eSGreg Roach        }
1132da2404eSGreg Roach
1146ccdf4f0SGreg Roach        return redirect($url);
1152da2404eSGreg Roach    }
1162da2404eSGreg Roach
1172da2404eSGreg Roach    /**
11876692c8bSGreg Roach     * Generate the HTML content of this block.
11976692c8bSGreg Roach     *
120e490cd80SGreg Roach     * @param Tree     $tree
12176692c8bSGreg Roach     * @param int      $block_id
1223caaa4d2SGreg Roach     * @param string   $context
1233caaa4d2SGreg Roach     * @param string[] $config
12476692c8bSGreg Roach     *
12576692c8bSGreg Roach     * @return string
12676692c8bSGreg Roach     */
1273caaa4d2SGreg Roach    public function getBlock(Tree $tree, int $block_id, string $context, array $config = []): string
128c1010edaSGreg Roach    {
129d39b150cSGreg Roach        $messages = DB::table('message')
130d39b150cSGreg Roach            ->where('user_id', '=', Auth::id())
131d39b150cSGreg Roach            ->orderByDesc('message_id')
132ca52a408SGreg Roach            ->get()
1330b5fd0a6SGreg Roach            ->map(static function (stdClass $row): stdClass {
1344459dc9aSGreg Roach                $row->created = Carbon::make($row->created);
135ca52a408SGreg Roach
136ca52a408SGreg Roach                return $row;
137ca52a408SGreg Roach            });
1388c2e8227SGreg Roach
1390b5fd0a6SGreg Roach        $users = $this->user_service->all()->filter(static function (UserInterface $user) use ($tree): bool {
14076a8e0f3SGreg Roach            $public_tree  = $tree->getPreference('REQUIRE_AUTHENTICATION') !== '1';
14176a8e0f3SGreg Roach            $can_see_tree = $public_tree || Auth::accessLevel($tree, $user) <= Auth::PRIV_USER;
14276a8e0f3SGreg Roach
14376a8e0f3SGreg Roach            return
144895230eeSGreg Roach                $user->id() !== Auth::id() &&
1457c4add84SGreg Roach                $user->getPreference(User::PREF_IS_ACCOUNT_APPROVED) &&
14676a8e0f3SGreg Roach                $can_see_tree &&
1477c4add84SGreg Roach                $user->getPreference(User::PREF_CONTACT_METHOD) !== 'none';
1488c2e8227SGreg Roach        });
1498c2e8227SGreg Roach
1507bab8982SGreg Roach        $content = '';
1518b67c11aSGreg Roach        if ($users->isNotEmpty()) {
152d72b284aSGreg Roach            $url = route('user-page', ['tree' => $tree->name()]);
153d39b150cSGreg Roach
154e381f98dSGreg Roach            $content .= '<form method="post" action="' . e(route(MessageSelect::class, ['tree' => $tree->name()])) . '">';
155e381f98dSGreg Roach            $content .= csrf_field();
156d53324c9SGreg Roach            $content .= '<input type="hidden" name="url" value="' . e($url) . '">';
1577bab8982SGreg Roach            $content .= '<label for="to">' . I18N::translate('Send a message') . '</label>';
158e381f98dSGreg Roach            $content .= '<select id="to" name="to" required>';
1598c2e8227SGreg Roach            $content .= '<option value="">' . I18N::translate('&lt;select&gt;') . '</option>';
1608c2e8227SGreg Roach            foreach ($users as $user) {
161e5a6b4d4SGreg Roach                $content .= sprintf('<option value="%1$s">%2$s - %1$s</option>', e($user->userName()), e($user->realName()));
1628c2e8227SGreg Roach            }
1638c2e8227SGreg Roach            $content .= '</select>';
1647bab8982SGreg Roach            $content .= '<button type="submit">' . I18N::translate('Send') . '</button><br><br>';
1657bab8982SGreg Roach            $content .= '</form>';
1668c2e8227SGreg Roach        }
16783615acfSGreg Roach        $content .= '<form method="post" action="' . e(route('module', [
168c1010edaSGreg Roach                'action'  => 'DeleteMessage',
16926684e68SGreg Roach                'module'  => $this->name(),
1703caaa4d2SGreg Roach                'context' => $context,
171d72b284aSGreg Roach                'tree'     => $tree->name(),
17283615acfSGreg Roach            ])) . '" data-confirm="' . I18N::translate('Are you sure you want to delete this message? It cannot be retrieved later.') . '" onsubmit="return confirm(this.dataset.confirm);" id="messageform" name="messageform">';
173cf700360SGreg Roach        $content .= csrf_field();
174cf700360SGreg Roach
175d39b150cSGreg Roach        if ($messages->isNotEmpty()) {
176b38a7b85SGreg Roach            $content .= '<div class="table-responsive">';
177b38a7b85SGreg Roach            $content .= '<table class="table table-sm w-100"><tr>';
178bc6628fbSRico Sonntag            $content .= '<th class="list_label">' . I18N::translate('Delete') . '<br><a href="#" onclick="$(\'#block-' . $block_id . ' :checkbox\').prop(\'checked\', true); return false;">' . I18N::translate('All') . '</a></th>';
179e284b8e1SGreg Roach            $content .= '<th class="list_label">' . I18N::translate('Subject') . '</th>';
180e284b8e1SGreg Roach            $content .= '<th class="list_label">' . I18N::translate('Date sent') . '</th>';
181e284b8e1SGreg Roach            $content .= '<th class="list_label">' . I18N::translate('Email address') . '</th>';
1828c2e8227SGreg Roach            $content .= '</tr>';
1838c2e8227SGreg Roach            foreach ($messages as $message) {
1848c2e8227SGreg Roach                $content .= '<tr>';
185a33af35aSmakitso                $content .= '<td class="list_value_wrap center"><input type="checkbox" name="message_id[]" value="' . $message->message_id . '" id="cb_message' . $message->message_id . '"></td>';
186d53324c9SGreg Roach                $content .= '<td class="list_value_wrap"><a href="#" onclick="return expand_layer(\'message' . $message->message_id . '\');"><i id="message' . $message->message_id . '_img" class="icon-plus"></i> <b dir="auto">' . e($message->subject) . '</b></a></td>';
1874459dc9aSGreg Roach                $content .= '<td class="list_value_wrap">' . view('components/datetime', ['timestamp' => $message->created]) . '</td>';
1888c2e8227SGreg Roach                $content .= '<td class="list_value_wrap">';
189d39b150cSGreg Roach
190e5a6b4d4SGreg Roach                $user = $this->user_service->findByIdentifier($message->sender);
191d39b150cSGreg Roach
19226eae716SGreg Roach                if ($user instanceof User) {
193e5a6b4d4SGreg Roach                    $content .= '<span dir="auto">' . e($user->realName()) . '</span> - <span dir="auto">' . $user->email() . '</span>';
1948c2e8227SGreg Roach                } else {
195d53324c9SGreg Roach                    $content .= '<a href="mailto:' . e($message->sender) . '">' . e($message->sender) . '</a>';
1968c2e8227SGreg Roach                }
197d39b150cSGreg Roach
1988c2e8227SGreg Roach                $content .= '</td>';
1998c2e8227SGreg Roach                $content .= '</tr>';
2008c2e8227SGreg Roach                $content .= '<tr><td class="list_value_wrap" colspan="4"><div id="message' . $message->message_id . '" style="display:none;">';
201e490cd80SGreg Roach                $content .= '<div dir="auto" style="white-space: pre-wrap;">' . Filter::expandUrls($message->body, $tree) . '</div><br>';
202d39b150cSGreg Roach
203bbb76c12SGreg Roach                /* I18N: When replying to an email, the subject becomes “RE: <subject>” */
204bbb76c12SGreg Roach                if (strpos($message->subject, I18N::translate('RE: ')) !== 0) {
2058c2e8227SGreg Roach                    $message->subject = I18N::translate('RE: ') . $message->subject;
2068c2e8227SGreg Roach                }
20746bb661fSGreg Roach
20846bb661fSGreg Roach                // If this user still exists, show a reply link.
209e381f98dSGreg Roach                if ($user instanceof User) {
210e381f98dSGreg Roach                    $reply_url = route(MessagePage::class, [
211c1010edaSGreg Roach                        'subject' => $message->subject,
212d72b284aSGreg Roach                        'to'      => $user->userName(),
213d72b284aSGreg Roach                        'tree'    => $tree->name(),
2140bf22806SGreg Roach                        'url'     => route('user-page', ['tree' => $tree->name()]),
215c1010edaSGreg Roach                    ]);
216d39b150cSGreg Roach
21746bb661fSGreg Roach                    $content .= '<a class="btn btn-primary" href="' . e($reply_url) . '" title="' . I18N::translate('Reply') . '">' . I18N::translate('Reply') . '</a> ';
2188c2e8227SGreg Roach                }
21946bb661fSGreg Roach                $content .= '<button type="button" class="btn btn-danger" data-confirm="' . I18N::translate('Are you sure you want to delete this message? It cannot be retrieved later.') . '" onclick="if (confirm(this.dataset.confirm)) {$(\'#messageform :checkbox\').prop(\'checked\', false); $(\'#cb_message' . $message->message_id . '\').prop(\'checked\', true); document.messageform.submit();}">' . I18N::translate('Delete') . '</button></div></td></tr>';
2208c2e8227SGreg Roach            }
2218c2e8227SGreg Roach            $content .= '</table>';
222b38a7b85SGreg Roach            $content .= '</div>';
2232da2404eSGreg Roach            $content .= '<p><button type="submit">' . I18N::translate('Delete selected messages') . '</button></p>';
2248c2e8227SGreg Roach        }
2258c2e8227SGreg Roach        $content .= '</form>';
2268c2e8227SGreg Roach
2273caaa4d2SGreg Roach        if ($context !== self::CONTEXT_EMBED) {
228d39b150cSGreg Roach            $count = $messages->count();
229d39b150cSGreg Roach
230147e99aaSGreg Roach            return view('modules/block-template', [
2311e7a7a28SGreg Roach                'block'      => Str::kebab($this->name()),
2329c6524dcSGreg Roach                'id'         => $block_id,
2339c6524dcSGreg Roach                'config_url' => '',
234f7f4b984SGreg Roach                'title'      => I18N::plural('%s message', '%s messages', $count, I18N::number($count)),
2359c6524dcSGreg Roach                'content'    => $content,
2369c6524dcSGreg Roach            ]);
2378c2e8227SGreg Roach        }
238b2ce94c6SRico Sonntag
239b2ce94c6SRico Sonntag        return $content;
2408c2e8227SGreg Roach    }
2418c2e8227SGreg Roach
2423caaa4d2SGreg Roach    /**
2433caaa4d2SGreg Roach     * Should this block load asynchronously using AJAX?
2443caaa4d2SGreg Roach     *
2453caaa4d2SGreg Roach     * Simple blocks are faster in-line, more complex ones can be loaded later.
2463caaa4d2SGreg Roach     *
2473caaa4d2SGreg Roach     * @return bool
2483caaa4d2SGreg Roach     */
249c1010edaSGreg Roach    public function loadAjax(): bool
250c1010edaSGreg Roach    {
2518c2e8227SGreg Roach        return false;
2528c2e8227SGreg Roach    }
2538c2e8227SGreg Roach
2543caaa4d2SGreg Roach    /**
2553caaa4d2SGreg Roach     * Can this block be shown on the user’s home page?
2563caaa4d2SGreg Roach     *
2573caaa4d2SGreg Roach     * @return bool
2583caaa4d2SGreg Roach     */
259c1010edaSGreg Roach    public function isUserBlock(): bool
260c1010edaSGreg Roach    {
2618c2e8227SGreg Roach        return true;
2628c2e8227SGreg Roach    }
2638c2e8227SGreg Roach
2643caaa4d2SGreg Roach    /**
2653caaa4d2SGreg Roach     * Can this block be shown on the tree’s home page?
2663caaa4d2SGreg Roach     *
2673caaa4d2SGreg Roach     * @return bool
2683caaa4d2SGreg Roach     */
26963276d8fSGreg Roach    public function isTreeBlock(): bool
270c1010edaSGreg Roach    {
2718c2e8227SGreg Roach        return false;
2728c2e8227SGreg Roach    }
2738c2e8227SGreg Roach}
274