xref: /webtrees/app/Statistics/Repository/LatestUserRepository.php (revision b11cdcd45131b1585d66693fab363cfeb18c51a4) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * 'Copyright (C) 2023 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 <https://www.gnu.org/licenses/>.
16 */
17
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees\Statistics\Repository;
21
22use Fisharebest\Webtrees\Auth;
23use Fisharebest\Webtrees\Contracts\UserInterface;
24use Fisharebest\Webtrees\I18N;
25use Fisharebest\Webtrees\Registry;
26use Fisharebest\Webtrees\Services\UserService;
27use Fisharebest\Webtrees\Statistics\Repository\Interfaces\LatestUserRepositoryInterface;
28use Illuminate\Database\Capsule\Manager as DB;
29use Illuminate\Database\Query\Builder;
30use Illuminate\Database\Query\JoinClause;
31
32use function date;
33use function e;
34use function str_replace;
35
36/**
37 * A repository providing methods for latest user related statistics.
38 */
39class LatestUserRepository implements LatestUserRepositoryInterface
40{
41    private UserService $user_service;
42
43    /**
44     * LatestUserRepository constructor.
45     *
46     * @param UserService $user_service
47     */
48    public function __construct(UserService $user_service)
49    {
50        $this->user_service = $user_service;
51    }
52
53    /**
54     * @return string
55     */
56    public function latestUserId(): string
57    {
58        return (string) $this->latestUserQuery()->id();
59    }
60
61    /**
62     * Find the newest user on the site.
63     * If no user has registered (i.e. all created by the admin), then
64     * return the current user.
65     *
66     * @return UserInterface
67     */
68    private function latestUserQuery(): UserInterface
69    {
70        static $user;
71
72        if ($user instanceof UserInterface) {
73            return $user;
74        }
75
76        $user_id = DB::table('user as u')
77            ->select(['u.user_id'])
78            ->leftJoin('user_setting as us', static function (JoinClause $join): void {
79                $join->on(static function (Builder $query): void {
80                    $query->whereColumn('u.user_id', '=', 'us.user_id')
81                        ->where('us.setting_name', '=', UserInterface::PREF_TIMESTAMP_REGISTERED);
82                });
83            })
84            ->orderByDesc('us.setting_value')
85            ->value('user_id');
86
87        if ($user_id !== null) {
88            $user_id = (int) $user_id;
89        }
90
91        return $this->user_service->find($user_id) ?? Auth::user();
92    }
93
94    /**
95     * @return string
96     */
97    public function latestUserName(): string
98    {
99        return e($this->latestUserQuery()->userName());
100    }
101
102    /**
103     * @return string
104     */
105    public function latestUserFullName(): string
106    {
107        return e($this->latestUserQuery()->realName());
108    }
109
110    /**
111     * @param string|null $format
112     *
113     * @return string
114     */
115    public function latestUserRegDate(string $format = null): string
116    {
117        $format ??= I18N::dateFormat();
118        $user      = $this->latestUserQuery();
119        $timestamp = (int) $user->getPreference(UserInterface::PREF_TIMESTAMP_REGISTERED);
120
121        return Registry::timestampFactory()->make($timestamp)->format(strtr($format, ['%' => '']));
122    }
123
124    /**
125     * @param string|null $format
126     *
127     * @return string
128     */
129    public function latestUserRegTime(string $format = null): string
130    {
131        $format ??= str_replace('%', '', I18N::timeFormat());
132        $user = $this->latestUserQuery();
133
134        return date($format, (int) $user->getPreference(UserInterface::PREF_TIMESTAMP_REGISTERED));
135    }
136
137    /**
138     * @param string|null $yes
139     * @param string|null $no
140     *
141     * @return string
142     */
143    public function latestUserLoggedin(string $yes = null, string $no = null): string
144    {
145        $yes ??= I18N::translate('yes');
146        $no ??= I18N::translate('no');
147        $user = $this->latestUserQuery();
148
149        $is_logged_in = DB::table('session')
150            ->selectRaw('1')
151            ->where('user_id', '=', $user->id())
152            ->first();
153
154        return $is_logged_in !== null ? $yes : $no;
155    }
156}
157