.
*/
declare(strict_types=1);
namespace Fisharebest\Webtrees\Statistics\Repository;
use Fisharebest\Webtrees\Auth;
use Fisharebest\Webtrees\Contracts\UserInterface;
use Fisharebest\Webtrees\Http\RequestHandlers\MessagePage;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Individual;
use Fisharebest\Webtrees\Registry;
use Fisharebest\Webtrees\Services\MessageService;
use Fisharebest\Webtrees\Services\UserService;
use Fisharebest\Webtrees\Statistics\Repository\Interfaces\UserRepositoryInterface;
use Fisharebest\Webtrees\Tree;
use function count;
use function e;
use function route;
use function view;
/**
* A repository providing methods for user related statistics.
*/
class UserRepository implements UserRepositoryInterface
{
private Tree $tree;
private UserService $user_service;
/**
* @param Tree $tree
* @param UserService $user_service
*/
public function __construct(Tree $tree, UserService $user_service)
{
$this->tree = $tree;
$this->user_service = $user_service;
}
/**
* Who is currently logged in?
*
* @param string $type "list" or "nolist"
*
* @return string
*/
private function usersLoggedInQuery(string $type): string
{
$content = '';
$anonymous = 0;
$logged_in = [];
foreach ($this->user_service->allLoggedIn() as $user) {
if (Auth::isAdmin() || $user->getPreference(UserInterface::PREF_IS_VISIBLE_ONLINE) === '1') {
$logged_in[] = $user;
} else {
$anonymous++;
}
}
$count_logged_in = count($logged_in);
if ($count_logged_in === 0 && $anonymous === 0) {
$content .= I18N::translate('No signed-in and no anonymous users');
}
if ($anonymous > 0) {
$content .= '' . I18N::plural('%s anonymous signed-in user', '%s anonymous signed-in users', $anonymous, I18N::number($anonymous)) . '';
}
if ($count_logged_in > 0) {
if ($anonymous !== 0) {
if ($type === 'list') {
$content .= '
';
} else {
$content .= ' ' . I18N::translate('and') . ' ';
}
}
$content .= '' . I18N::plural('%s signed-in user', '%s signed-in users', $count_logged_in, I18N::number($count_logged_in)) . '';
if ($type === 'list') {
$content .= '';
} else {
$content .= ': ';
}
}
if (Auth::check()) {
foreach ($logged_in as $user) {
if ($type === 'list') {
$content .= '- ';
}
$individual = Registry::individualFactory()->make($this->tree->getUserPreference($user, UserInterface::PREF_TREE_ACCOUNT_XREF), $this->tree);
if ($individual instanceof Individual && $individual->canShow()) {
$content .= '' . e($user->realName()) . '';
} else {
$content .= e($user->realName());
}
$content .= ' - ' . e($user->userName());
if ($user->getPreference(UserInterface::PREF_CONTACT_METHOD) !== MessageService::CONTACT_METHOD_NONE && Auth::id() !== $user->id()) {
$content .= '' . view('icons/email') . '';
}
if ($type === 'list') {
$content .= '
';
}
}
}
if ($type === 'list') {
$content .= '
';
}
return $content;
}
/**
* @return string
*/
public function usersLoggedIn(): string
{
return $this->usersLoggedInQuery('nolist');
}
/**
* @return string
*/
public function usersLoggedInList(): string
{
return $this->usersLoggedInQuery('list');
}
/**
* Returns true if the given user is visible to others.
*
* @param UserInterface $user
*
* @return bool
*/
private function isUserVisible(UserInterface $user): bool
{
return Auth::isAdmin() || $user->getPreference(UserInterface::PREF_IS_VISIBLE_ONLINE) === '1';
}
/**
* @return int
*/
public function usersLoggedInTotal(): int
{
return count($this->user_service->allLoggedIn());
}
/**
* @return int
*/
public function usersLoggedInTotalAnon(): int
{
$anonymous = 0;
foreach ($this->user_service->allLoggedIn() as $user) {
if (!$this->isUserVisible($user)) {
++$anonymous;
}
}
return $anonymous;
}
/**
* @return int
*/
public function usersLoggedInTotalVisible(): int
{
$visible = 0;
foreach ($this->user_service->allLoggedIn() as $user) {
if ($this->isUserVisible($user)) {
++$visible;
}
}
return $visible;
}
/**
* @return string
*/
public function userId(): string
{
return (string) Auth::id();
}
/**
* @param string $visitor_text
*
* @return string
*/
public function userName(string $visitor_text = ''): string
{
if (Auth::check()) {
return e(Auth::user()->userName());
}
// if #username:visitor# was specified, then "visitor" will be returned when the user is not logged in
return e($visitor_text);
}
/**
* @return string
*/
public function userFullName(): string
{
return Auth::check() ? '' . e(Auth::user()->realName()) . '' : '';
}
/**
* Returns the user count.
*
* @return int
*/
private function getUserCount(): int
{
return count($this->user_service->all());
}
/**
* Returns the administrator count.
*
* @return int
*/
private function getAdminCount(): int
{
return count($this->user_service->administrators());
}
/**
* @return string
*/
public function totalUsers(): string
{
return I18N::number($this->getUserCount());
}
/**
* @return string
*/
public function totalAdmins(): string
{
return I18N::number($this->getAdminCount());
}
/**
* @return string
*/
public function totalNonAdmins(): string
{
return I18N::number($this->getUserCount() - $this->getAdminCount());
}
}