xref: /webtrees/app/Http/Middleware/UseDatabase.php (revision 6e9f3eb95e5ab831212bea51daa6afbd5784024d)
16ccdf4f0SGreg Roach<?php
23976b470SGreg Roach
36ccdf4f0SGreg Roach/**
46ccdf4f0SGreg Roach * webtrees: online genealogy
5*6e9f3eb9SGreg Roach * Copyright (C) 2020 webtrees development team
66ccdf4f0SGreg Roach * This program is free software: you can redistribute it and/or modify
76ccdf4f0SGreg Roach * it under the terms of the GNU General Public License as published by
86ccdf4f0SGreg Roach * the Free Software Foundation, either version 3 of the License, or
96ccdf4f0SGreg Roach * (at your option) any later version.
106ccdf4f0SGreg Roach * This program is distributed in the hope that it will be useful,
116ccdf4f0SGreg Roach * but WITHOUT ANY WARRANTY; without even the implied warranty of
126ccdf4f0SGreg Roach * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
136ccdf4f0SGreg Roach * GNU General Public License for more details.
146ccdf4f0SGreg Roach * You should have received a copy of the GNU General Public License
156ccdf4f0SGreg Roach * along with this program. If not, see <http://www.gnu.org/licenses/>.
166ccdf4f0SGreg Roach */
17fcfa147eSGreg Roach
186ccdf4f0SGreg Roachdeclare(strict_types=1);
196ccdf4f0SGreg Roach
206ccdf4f0SGreg Roachnamespace Fisharebest\Webtrees\Http\Middleware;
216ccdf4f0SGreg Roach
226ccdf4f0SGreg Roachuse Fisharebest\Webtrees\Webtrees;
23e16a1bfdSGreg Roachuse Illuminate\Database\Capsule\Manager as DB;
24e16a1bfdSGreg Roachuse Illuminate\Database\Query\Builder;
255c98992aSGreg Roachuse LogicException;
2660a0fc35SGreg Roachuse PDO;
27b8d46257SGreg Roachuse PDOException;
286ccdf4f0SGreg Roachuse Psr\Http\Message\ResponseInterface;
296ccdf4f0SGreg Roachuse Psr\Http\Message\ServerRequestInterface;
306ccdf4f0SGreg Roachuse Psr\Http\Server\MiddlewareInterface;
316ccdf4f0SGreg Roachuse Psr\Http\Server\RequestHandlerInterface;
32*6e9f3eb9SGreg Roachuse RuntimeException;
336ccdf4f0SGreg Roach
346ccdf4f0SGreg Roach/**
356ccdf4f0SGreg Roach * Middleware to connect to the database.
366ccdf4f0SGreg Roach */
376ccdf4f0SGreg Roachclass UseDatabase implements MiddlewareInterface
386ccdf4f0SGreg Roach{
396ccdf4f0SGreg Roach    /**
406ccdf4f0SGreg Roach     * @param ServerRequestInterface  $request
416ccdf4f0SGreg Roach     * @param RequestHandlerInterface $handler
426ccdf4f0SGreg Roach     *
436ccdf4f0SGreg Roach     * @return ResponseInterface
446ccdf4f0SGreg Roach     */
456ccdf4f0SGreg Roach    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
466ccdf4f0SGreg Roach    {
47e16a1bfdSGreg Roach        // Earlier versions of webtrees did not have a dbtype config option.  They always used mysql.
48e16a1bfdSGreg Roach        $driver = $request->getAttribute('dbtype', 'mysql');
496ccdf4f0SGreg Roach
50e16a1bfdSGreg Roach        $dbname = $request->getAttribute('dbname');
516ccdf4f0SGreg Roach
52e16a1bfdSGreg Roach        if ($driver === 'sqlite') {
53e16a1bfdSGreg Roach            $dbname = Webtrees::ROOT_DIR . 'data/' . $dbname . '.sqlite';
546ccdf4f0SGreg Roach        }
556ccdf4f0SGreg Roach
56e16a1bfdSGreg Roach        $capsule = new DB();
57e16a1bfdSGreg Roach
58e16a1bfdSGreg Roach        $capsule->addConnection([
59e16a1bfdSGreg Roach            'driver'                  => $driver,
60e16a1bfdSGreg Roach            'host'                    => $request->getAttribute('dbhost'),
61e16a1bfdSGreg Roach            'port'                    => $request->getAttribute('dbport'),
62e16a1bfdSGreg Roach            'database'                => $dbname,
63e16a1bfdSGreg Roach            'username'                => $request->getAttribute('dbuser'),
64e16a1bfdSGreg Roach            'password'                => $request->getAttribute('dbpass'),
65e16a1bfdSGreg Roach            'prefix'                  => $request->getAttribute('tblpfx'),
66e16a1bfdSGreg Roach            'prefix_indexes'          => true,
6760a0fc35SGreg Roach            'options'                 => [
6860a0fc35SGreg Roach                // Some drivers do this and some don't.  Make them consistent.
6960a0fc35SGreg Roach                PDO::ATTR_STRINGIFY_FETCHES => true,
7060a0fc35SGreg Roach            ],
71e16a1bfdSGreg Roach            // For MySQL
72e16a1bfdSGreg Roach            'charset'                 => 'utf8',
73e16a1bfdSGreg Roach            'collation'               => 'utf8_unicode_ci',
74e16a1bfdSGreg Roach            'timezone'                => '+00:00',
75e16a1bfdSGreg Roach            'engine'                  => 'InnoDB',
76e16a1bfdSGreg Roach            'modes'                   => [
77e16a1bfdSGreg Roach                'ANSI',
789d1d823fSGreg Roach                'STRICT_ALL_TABLES',
792fef74aaSGreg Roach                // Use SQL injection(!) to override MAX_JOIN_SIZE setting.
802fef74aaSGreg Roach                "', SQL_BIG_SELECTS=1, @dummy='"
81e16a1bfdSGreg Roach            ],
82e16a1bfdSGreg Roach            // For SQLite
83e16a1bfdSGreg Roach            'foreign_key_constraints' => true,
84e16a1bfdSGreg Roach        ]);
85e16a1bfdSGreg Roach
86e16a1bfdSGreg Roach        $capsule->setAsGlobal();
87e16a1bfdSGreg Roach
88e16a1bfdSGreg Roach        Builder::macro('whereContains', function ($column, string $search, string $boolean = 'and'): Builder {
895c98992aSGreg Roach            // Assertion helps static analysis tools understand where we will be using this closure.
905c98992aSGreg Roach            assert($this instanceof Builder, new LogicException());
915c98992aSGreg Roach
92e16a1bfdSGreg Roach            $search = strtr($search, ['\\' => '\\\\', '%' => '\\%', '_' => '\\_', ' ' => '%']);
93e16a1bfdSGreg Roach
94e16a1bfdSGreg Roach            return $this->where($column, 'LIKE', '%' . $search . '%', $boolean);
95e16a1bfdSGreg Roach        });
96e16a1bfdSGreg Roach
97b8d46257SGreg Roach        try {
98ff020ee8SGreg Roach            // Eager-load the connection, to prevent database credentials appearing in error logs.
99ff020ee8SGreg Roach            DB::connection()->getPdo();
100b8d46257SGreg Roach        } catch (PDOException $exception) {
101*6e9f3eb9SGreg Roach            throw new RuntimeException($exception->getMessage());
102b8d46257SGreg Roach        }
103b8d46257SGreg Roach
104ff020ee8SGreg Roach        return $handler->handle($request);
1056ccdf4f0SGreg Roach    }
1066ccdf4f0SGreg Roach}
107