xref: /webtrees/app/Schema/Migration44.php (revision 22c135fa2a9d8aaf68a70032269940d5314a9818)
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2021 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\Schema;
21
22use Illuminate\Database\Capsule\Manager as DB;
23use Illuminate\Database\Query\Expression;
24use Illuminate\Database\Schema\Blueprint;
25use PDOException;
26
27/**
28 * Upgrade the database schema from version 44 to version 45.
29 */
30class Migration44 implements MigrationInterface
31{
32    /**
33     * Upgrade to to the next version
34     *
35     * @return void
36     */
37    public function upgrade(): void
38    {
39        // It is simpler to create a new table than to update the existing one.
40
41        if (!DB::schema()->hasTable('place_location')) {
42            DB::schema()->create('place_location', static function (Blueprint $table): void {
43                $table->integer('id', true);
44                $table->integer('parent_id')->nullable();
45                $table->string('place', 120);
46                $table->double('latitude')->nullable();
47                $table->double('longitude')->nullable();
48
49                $table->unique(['parent_id', 'place']);
50                $table->unique(['place', 'parent_id']);
51
52                $table->index(['latitude']);
53                $table->index(['longitude']);
54            });
55
56            DB::schema()->table('place_location', static function (Blueprint $table): void {
57                $table->foreign(['parent_id'])
58                    ->references(['id'])
59                    ->on('place_location')
60                    ->onDelete('CASCADE')
61                    ->onUpdate('CASCADE');
62            });
63        }
64
65        if (DB::schema()->hasTable('placelocation')) {
66            DB::table('placelocation')
67                ->where('pl_lati', '=', '')
68                ->orWhere('pl_long', '=', '')
69                ->update([
70                    'pl_lati' => null,
71                    'pl_long' => null,
72                ]);
73
74            // Missing/invalid parents?  Move them to the top level
75            DB::table('placelocation AS pl1')
76                ->leftJoin('placelocation AS pl2', 'pl1.pl_parent_id', '=', 'pl2.pl_id')
77                ->whereNull('pl2.pl_id')
78                ->update([
79                    'pl1.pl_parent_id' => 0,
80                ]);
81
82            // Remove invalid values.
83            if (DB::connection()->getDriverName() === 'mysql') {
84                DB::table('placelocation')
85                    ->where('pl_lati', 'NOT REGEXP', '[^NS][0-9]+[.]?[0-9]*$')
86                    ->orWhere('pl_long', 'NOT REGEXP', '[^EW][0-9]+[.]?[0-9]*$')
87                    ->update([
88                        'pl_lati' => '',
89                        'pl_long' => '',
90                    ]);
91            }
92
93            DB::table('placelocation')
94                ->update([
95                    'pl_place' => new Expression('SUBSTR(pl_place, 1, 120)'),
96                ]);
97
98            // The lack of unique key constraints means that there may be duplicates...
99            while (true) {
100                // Two places with the same name and parent...
101                $row = DB::table('placelocation')
102                    ->select([
103                        new Expression('MIN(pl_id) AS min'),
104                        new Expression('MAX(pl_id) AS max'),
105                    ])
106                    ->groupBy(['pl_parent_id', 'pl_place'])
107                    ->having(new Expression('COUNT(*)'), '>', '1')
108                    ->first();
109
110                if ($row === null) {
111                    break;
112                }
113
114                // ...move children to the first
115                DB::table('placelocation')
116                    ->where('pl_parent_id', '=', $row->max)
117                    ->update(['pl_parent_id' => $row->min]);
118
119                // ...delete the second
120                DB::table('placelocation')
121                    ->where('pl_id', '=', $row->max)
122                    ->delete();
123            }
124
125            // This is the SQL standard.  It works with Postgres, Sqlite and MySQL 8
126            $select1 = DB::table('placelocation')
127                ->leftJoin('place_location', 'id', '=', 'pl_id')
128                ->whereNull('id')
129                ->orderBy('pl_level')
130                ->orderBy('pl_id')
131                ->select([
132                    'pl_id',
133                    new Expression('CASE pl_parent_id WHEN 0 THEN NULL ELSE pl_parent_id END'),
134                    'pl_place',
135                    new Expression("CAST(REPLACE(REPLACE(pl_lati, 'S', '-'), 'N', '') AS FLOAT)"),
136                    new Expression("CAST(REPLACE(REPLACE(pl_long, 'W', '-'), 'E', '') AS FLOAT)"),
137                ]);
138
139            // This works for MySQL 5.7 and lower, which cannot cast to FLOAT
140            $select2 = DB::table('placelocation')
141                ->leftJoin('place_location', 'id', '=', 'pl_id')
142                ->whereNull('id')
143                ->orderBy('pl_level')
144                ->orderBy('pl_id')
145                ->select([
146                    'pl_id',
147                    new Expression('CASE pl_parent_id WHEN 0 THEN NULL ELSE pl_parent_id END'),
148                    'pl_place',
149                    new Expression("REPLACE(REPLACE(pl_lati, 'S', '-'), 'N', '')"),
150                    new Expression("REPLACE(REPLACE(pl_long, 'W', '-'), 'E', '')"),
151                ]);
152
153            try {
154                DB::table('place_location')
155                    ->insertUsing(['id', 'parent_id', 'place', 'latitude', 'longitude'], $select1);
156            } catch (PDOException $ex) {
157                DB::table('place_location')
158                    ->insertUsing(['id', 'parent_id', 'place', 'latitude', 'longitude'], $select2);
159            }
160
161            DB::schema()->drop('placelocation');
162        }
163
164        // Earlier versions of webtrees used 0 and NULL interchangeably.
165        // Assume 0 at the country-level and NULL at lower levels.
166        DB::table('place_location')
167            ->whereNotNull('parent_id')
168            ->where('latitude', '=', 0)
169            ->where('longitude', '=', 0)
170            ->update([
171                'latitude'  => null,
172                'longitude' => null,
173            ]);
174    }
175}
176