.
*/
declare(strict_types=1);
namespace Fisharebest\Webtrees\Module;
use Fisharebest\Webtrees\Auth;
use Fisharebest\Webtrees\Carbon;
use Fisharebest\Webtrees\Contracts\UserInterface;
use Fisharebest\Webtrees\Filter;
use Fisharebest\Webtrees\Http\RequestHandlers\MessagePage;
use Fisharebest\Webtrees\Http\RequestHandlers\MessageSelect;
use Fisharebest\Webtrees\Http\RequestHandlers\TreePage;
use Fisharebest\Webtrees\Http\RequestHandlers\UserPage;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Services\UserService;
use Fisharebest\Webtrees\Tree;
use Fisharebest\Webtrees\User;
use Illuminate\Database\Capsule\Manager as DB;
use Illuminate\Support\Str;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use stdClass;
use function assert;
use function e;
use function route;
use function str_starts_with;
use function view;
/**
* Class UserMessagesModule
*/
class UserMessagesModule extends AbstractModule implements ModuleBlockInterface
{
use ModuleBlockTrait;
/**
* @var UserService
*/
private $user_service;
/**
* UserMessagesModule constructor.
*
* @param UserService $user_service
*/
public function __construct(UserService $user_service)
{
$this->user_service = $user_service;
}
/**
* How should this module be identified in the control panel, etc.?
*
* @return string
*/
public function title(): string
{
/* I18N: Name of a module */
return I18N::translate('Messages');
}
/**
* A sentence describing what this module does.
*
* @return string
*/
public function description(): string
{
/* I18N: Description of the “Messages” module */
return I18N::translate('Communicate directly with other users, using private messages.');
}
/**
* Delete one or messages belonging to a user.
*
* @param ServerRequestInterface $request
*
* @return ResponseInterface
*/
public function postDeleteMessageAction(ServerRequestInterface $request): ResponseInterface
{
$tree = $request->getAttribute('tree');
assert($tree instanceof Tree);
$params = (array) $request->getParsedBody();
$message_ids = $params['message_id'] ?? [];
DB::table('message')
->where('user_id', '=', Auth::id())
->whereIn('message_id', $message_ids)
->delete();
if ($request->getQueryParams()['context'] === ModuleBlockInterface::CONTEXT_USER_PAGE) {
$url = route(UserPage::class, ['tree' => $tree->name()]);
} else {
$url = route(TreePage::class, ['tree' => $tree->name()]);
}
return redirect($url);
}
/**
* Generate the HTML content of this block.
*
* @param Tree $tree
* @param int $block_id
* @param string $context
* @param string[] $config
*
* @return string
*/
public function getBlock(Tree $tree, int $block_id, string $context, array $config = []): string
{
$messages = DB::table('message')
->where('user_id', '=', Auth::id())
->orderByDesc('message_id')
->get()
->map(static function (stdClass $row): stdClass {
$row->created = Carbon::make($row->created);
return $row;
});
$users = $this->user_service->all()->filter(static function (UserInterface $user) use ($tree): bool {
$public_tree = $tree->getPreference('REQUIRE_AUTHENTICATION') !== '1';
$can_see_tree = $public_tree || Auth::accessLevel($tree, $user) <= Auth::PRIV_USER;
return
$user->id() !== Auth::id() &&
$user->getPreference(User::PREF_IS_ACCOUNT_APPROVED) &&
$can_see_tree &&
$user->getPreference(User::PREF_CONTACT_METHOD) !== 'none';
});
$content = '';
if ($users->isNotEmpty()) {
$url = route(UserPage::class, ['tree' => $tree->name()]);
$content .= '';
}
$content .= '';
if ($context !== self::CONTEXT_EMBED) {
$count = $messages->count();
return view('modules/block-template', [
'block' => Str::kebab($this->name()),
'id' => $block_id,
'config_url' => '',
'title' => I18N::plural('%s message', '%s messages', $count, I18N::number($count)),
'content' => $content,
]);
}
return $content;
}
/**
* Should this block load asynchronously using AJAX?
*
* Simple blocks are faster in-line, more complex ones can be loaded later.
*
* @return bool
*/
public function loadAjax(): bool
{
return false;
}
/**
* Can this block be shown on the user’s home page?
*
* @return bool
*/
public function isUserBlock(): bool
{
return true;
}
/**
* Can this block be shown on the tree’s home page?
*
* @return bool
*/
public function isTreeBlock(): bool
{
return false;
}
}