. */ declare(strict_types=1); namespace Fisharebest\Webtrees; use Illuminate\Database\Capsule\Manager as DB; use Psr\Http\Message\ServerRequestInterface; /** * Record webtrees events in the database */ class Log { // We can log the following types of message in the wt_log table. private const TYPE_AUTHENTICATION = 'auth'; private const TYPE_CONFIGURATION = 'config'; private const TYPE_EDIT = 'edit'; private const TYPE_ERROR = 'error'; private const TYPE_MEDIA = 'media'; private const TYPE_SEARCH = 'search'; /** * Store an authentication message in the message log. * * @param string $message * * @return void */ public static function addAuthenticationLog(string $message): void { self::addLog($message, self::TYPE_AUTHENTICATION); } /** * Store a new message (of the appropriate type) in the message log. * * @param string $message * @param string $log_type * @param Tree|null $tree * * @return void */ private static function addLog(string $message, string $log_type, Tree $tree = null): void { if (app()->has(ServerRequestInterface::class)) { $request = app(ServerRequestInterface::class); assert($request instanceof ServerRequestInterface); $ip_address = Validator::attributes($request)->string('client-ip'); } else { $ip_address = '127.0.0.1'; } $tree_id = $tree ? $tree->id() : null; DB::table('log')->insert([ 'log_type' => $log_type, 'log_message' => $message, 'ip_address' => $ip_address, 'user_id' => Auth::id(), 'gedcom_id' => $tree_id, ]); } /** * Store a configuration message in the message log. * * @param string $message * @param Tree|null $tree * * @return void */ public static function addConfigurationLog(string $message, Tree $tree = null): void { self::addLog($message, self::TYPE_CONFIGURATION, $tree); } /** * Store an edit message in the message log. * * @param string $message * @param Tree $tree * * @return void */ public static function addEditLog(string $message, Tree $tree): void { self::addLog($message, self::TYPE_EDIT, $tree); } /** * Store an error message in the message log. * * @param string $message * * @return void */ public static function addErrorLog(string $message): void { self::addLog($message, self::TYPE_ERROR); } /** * Store an media management message in the message log. * * @param string $message * * @return void */ public static function addMediaLog(string $message): void { self::addLog($message, self::TYPE_MEDIA); } /** * Store a search event in the message log. * Unlike most webtrees activity, search is not restricted to a single tree, * so we need to record which trees were searched. * * @param string $message * @param array $trees Which trees were searched * * @return void */ public static function addSearchLog(string $message, array $trees): void { foreach ($trees as $tree) { self::addLog($message, self::TYPE_SEARCH, $tree); } } }