Completed
Push — master ( e1052c...4a8100 )
by Greg
07:45
created

MapDataImportAction::__construct()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 1
eloc 1
nc 1
nop 1
dl 0
loc 3
rs 10
c 1
b 0
f 0
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
18
declare(strict_types=1);
19
20
namespace Fisharebest\Webtrees\Http\RequestHandlers;
21
22
use Exception;
23
use Fisharebest\Webtrees\FlashMessages;
24
use Fisharebest\Webtrees\Gedcom;
25
use Fisharebest\Webtrees\I18N;
26
use Fisharebest\Webtrees\PlaceLocation;
27
use Fisharebest\Webtrees\Registry;
28
use Fisharebest\Webtrees\Services\MapDataService;
29
use Illuminate\Database\Capsule\Manager as DB;
30
use Psr\Http\Message\ResponseInterface;
31
use Psr\Http\Message\ServerRequestInterface;
32
use Psr\Http\Message\UploadedFileInterface;
33
use Psr\Http\Server\RequestHandlerInterface;
34
35
use function array_filter;
36
use function array_reverse;
37
use function array_slice;
38
use function count;
39
use function fclose;
40
use function fgetcsv;
41
use function implode;
42
use function is_numeric;
43
use function json_decode;
44
use function redirect;
45
use function rewind;
46
use function route;
47
use function str_contains;
48
use function stream_get_contents;
49
50
use const UPLOAD_ERR_OK;
51
52
/**
53
 * Import geographic data.
54
 */
55
class MapDataImportAction implements RequestHandlerInterface
56
{
57
    /**
58
     * This function assumes the input file layout is
59
     * level followed by a variable number of placename fields
60
     * followed by Longitude, Latitude, Zoom & Icon
61
     *
62
     * @param ServerRequestInterface $request
63
     *
64
     * @return ResponseInterface
65
     * @throws Exception
66
     */
67
    public function handle(ServerRequestInterface $request): ResponseInterface
68
    {
69
        $data_filesystem = Registry::filesystem()->data();
70
71
        $params = (array) $request->getParsedBody();
72
73
        $serverfile     = $params['serverfile'] ?? '';
74
        $options        = $params['import-options'] ?? '';
75
        $clear_database = (bool) ($params['cleardatabase'] ?? false);
76
        $local_file     = $request->getUploadedFiles()['localfile'] ?? null;
77
78
        $places = [];
79
80
        $url = route(MapDataList::class, ['parent_id' => 0]);
81
82
        $fp = false;
83
84
        if ($serverfile !== '' && $data_filesystem->has(MapDataService::PLACES_FOLDER . $serverfile)) {
85
            // first choice is file on server
86
            $fp = $data_filesystem->readStream(MapDataService::PLACES_FOLDER . $serverfile);
87
        } elseif ($local_file instanceof UploadedFileInterface && $local_file->getError() === UPLOAD_ERR_OK) {
88
            // 2nd choice is local file
89
            $fp = $local_file->getStream()->detach();
90
        }
91
92
        if ($fp === false || $fp === null) {
93
            return redirect($url);
94
        }
95
96
        $string = stream_get_contents($fp);
97
98
        // Check the file type
99
        if (str_contains($string, 'FeatureCollection')) {
100
            $input_array = json_decode($string, false);
101
102
            foreach ($input_array->features as $feature) {
103
                $places[] = [
104
                    'latitude'  => $feature->geometry->coordinates[1],
105
                    'longitude' => $feature->geometry->coordinates[0],
106
                    'name'      => $feature->properties->name,
107
                ];
108
            }
109
        } else {
110
            rewind($fp);
111
            while (($row = fgetcsv($fp, 0, MapDataService::CSV_SEPARATOR)) !== false) {
112
                // Skip the header
113
                if (!is_numeric($row[0])) {
114
                    continue;
115
                }
116
117
                $level = (int) $row[0];
118
                $count = count($row);
119
                $name  = implode(Gedcom::PLACE_SEPARATOR, array_reverse(array_slice($row, 1, 1 + $level)));
120
121
                $places[] = [
122
                    'latitude'  => (float) strtr($row[$count - 3], ['N' => '', 'S' => '-', ',' => '.']),
123
                    'longitude' => (float) strtr($row[$count - 4], ['E' => '', 'W' => '-', ',' => '.']),
124
                    'name'      => $name
125
                ];
126
            }
127
        }
128
129
        fclose($fp);
130
131
        if ($clear_database) {
132
            // Child places are deleted via on-delete-cascade...
133
            DB::table('place_location')
134
                ->whereNull('parent_id')
135
                ->delete();
136
        }
137
138
        $added   = 0;
139
        $updated = 0;
140
141
        // Remove places with 0,0 coordinates at lower levels.
142
        $places = array_filter($places, static function ($place) {
143
            return !str_contains($place['name'], ',') || $place['longitude'] !== 0.0 || $place['latitude'] !== 0.0;
144
        });
145
146
        foreach ($places as $place) {
147
            $location = new PlaceLocation($place['name']);
148
            $exists   = $location->exists();
149
150
            // Only update existing records
151
            if ($options === 'update' && !$exists) {
152
                continue;
153
            }
154
155
            // Only add new records
156
            if ($options === 'add' && $exists) {
157
                continue;
158
            }
159
160
            if (!$exists) {
161
                $added++;
162
            }
163
164
            $updated += DB::table('place_location')
165
                ->where('id', '=', $location->id())
166
                ->update([
167
                    'latitude'  => $place['latitude'],
168
                    'longitude' => $place['longitude'],
169
                ]);
170
        }
171
172
        FlashMessages::addMessage(
173
            I18N::translate('locations updated: %s, locations added: %s', I18N::number($updated), I18N::number($added)),
174
            'info'
175
        );
176
177
        return redirect($url);
178
    }
179
}
180