xref: /webtrees/app/Log.php (revision d35568b467207589ea9059739da0bf1f7e785a0d) 
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;
21
22use Illuminate\Database\Capsule\Manager as DB;
23use Psr\Http\Message\ServerRequestInterface;
24
25/**
26 * Record webtrees events in the database
27 */
28class Log
29{
30    // We can log the following types of message in the wt_log table.
31    private const TYPE_AUTHENTICATION = 'auth';
32    private const TYPE_CONFIGURATION  = 'config';
33    private const TYPE_EDIT           = 'edit';
34    private const TYPE_ERROR          = 'error';
35    private const TYPE_MEDIA          = 'media';
36    private const TYPE_SEARCH         = 'search';
37
38    /**
39     * Store an authentication message in the message log.
40     *
41     * @param string $message
42     *
43     * @return void
44     */
45    public static function addAuthenticationLog(string $message): void
46    {
47        self::addLog($message, self::TYPE_AUTHENTICATION);
48    }
49
50    /**
51     * Store a new message (of the appropriate type) in the message log.
52     *
53     * @param string    $message
54     * @param string    $log_type
55     * @param Tree|null $tree
56     *
57     * @return void
58     */
59    private static function addLog(string $message, string $log_type, Tree $tree = null): void
60    {
61        if (Registry::container()->has(ServerRequestInterface::class)) {
62            $request    = Registry::container()->get(ServerRequestInterface::class);
63            $ip_address = Validator::attributes($request)->string('client-ip');
64        } else {
65            $ip_address = '127.0.0.1';
66        }
67
68        DB::table('log')->insert([
69            'log_type'    => $log_type,
70            'log_message' => $message,
71            'ip_address'  => $ip_address,
72            'user_id'     => Auth::id(),
73            'gedcom_id'   => $tree?->id(),
74        ]);
75    }
76
77    /**
78     * Store a configuration message in the message log.
79     *
80     * @param string    $message
81     * @param Tree|null $tree
82     *
83     * @return void
84     */
85    public static function addConfigurationLog(string $message, Tree $tree = null): void
86    {
87        self::addLog($message, self::TYPE_CONFIGURATION, $tree);
88    }
89
90    /**
91     * Store an edit message in the message log.
92     *
93     * @param string $message
94     * @param Tree   $tree
95     *
96     * @return void
97     */
98    public static function addEditLog(string $message, Tree $tree): void
99    {
100        self::addLog($message, self::TYPE_EDIT, $tree);
101    }
102
103    /**
104     * Store an error message in the message log.
105     *
106     * @param string $message
107     *
108     * @return void
109     */
110    public static function addErrorLog(string $message): void
111    {
112        self::addLog($message, self::TYPE_ERROR);
113    }
114
115    /**
116     * Store an media management message in the message log.
117     *
118     * @param string $message
119     *
120     * @return void
121     */
122    public static function addMediaLog(string $message): void
123    {
124        self::addLog($message, self::TYPE_MEDIA);
125    }
126
127    /**
128     * Store a search event in the message log.
129     * Unlike most webtrees activity, search is not restricted to a single tree,
130     * so we need to record which trees were searched.
131     *
132     * @param string      $message
133     * @param array<Tree> $trees Which trees were searched
134     *
135     * @return void
136     */
137    public static function addSearchLog(string $message, array $trees): void
138    {
139        foreach ($trees as $tree) {
140            self::addLog($message, self::TYPE_SEARCH, $tree);
141        }
142    }
143}
144