LocationController::getHierarchy() - Code Metrics - Inspection of "Map coordinate fixes" - fisharebest/webtrees - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#3652)

unknown

created 2021-01-15 14:07 UTC

LocationController::getHierarchy() A

↳ Parent: LocationController

Complexity

Conditions	2
Paths	2

Size

Total Lines	20
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	12
nc	2
nop	1
dl	0
loc	20
rs	9.8666
c	0
b	0
f	0

<?php

/**
 * webtrees: online genealogy
 * Copyright (C) 2020 webtrees development team
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

declare(strict_types=1);

namespace Fisharebest\Webtrees\Http\Controllers\Admin;

use Exception;
use Fisharebest\Webtrees\FlashMessages;
use Fisharebest\Webtrees\Gedcom;
use Fisharebest\Webtrees\Http\RequestHandlers\ControlPanel;
use Fisharebest\Webtrees\Http\RequestHandlers\MapDataList;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\PlaceLocation;
use Fisharebest\Webtrees\Registry;
use Fisharebest\Webtrees\Services\GedcomService;
use Illuminate\Database\Capsule\Manager as DB;
use Illuminate\Database\Eloquent\Collection;
use Illuminate\Database\Query\Expression;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Message\UploadedFileInterface;
use RuntimeException;
use stdClass;

use function addcslashes;
use function array_filter;
use function array_merge;
use function array_pad;
use function array_reverse;
use function array_slice;
use function assert;
use function count;
use function e;
use function fclose;
use function fgetcsv;
use function fopen;
use function fputcsv;
use function implode;
use function is_numeric;
use function json_decode;
use function preg_replace;
use function redirect;
use function response;
use function rewind;
use function route;
use function str_replace;
use function stream_get_contents;
use function stripos;
use function substr_count;

use const UPLOAD_ERR_OK;

/**
 * Controller for maintaining geographic data.
 */
class LocationController extends AbstractAdminController
{
    // Location of files to import
    private const PLACES_FOLDER = 'places/';

    /** @var GedcomService */
    private $gedcom_service;

    /**
     * Dependency injection.
     *
     * @param GedcomService $gedcom_service
     */
    public function __construct(GedcomService $gedcom_service)
    {
        $this->gedcom_service = $gedcom_service;
    }

    /**
     * @param int $id
     *
     * @return array<stdClass>
     */
    private function getHierarchy(int $id): array
    {
        $arr  = [];
        $fqpn = [];

        while ($id !== 0) {
            $row = DB::table('placelocation')
                ->where('pl_id', '=', $id)
                ->first();

            // For static analysis tools.
            assert($row instanceof stdClass);

            $fqpn[]    = $row->pl_place;
            $row->fqpn = implode(Gedcom::PLACE_SEPARATOR, $fqpn);
            $id        = (int) $row->pl_parent_id;
            $arr[]     = $row;
        }

        return array_reverse($arr);
    }

    /**
     * @param ServerRequestInterface $request
     *
     * @return ResponseInterface
     */
    public function mapDataEdit(ServerRequestInterface $request): ResponseInterface
    {
        $parent_id = (int) $request->getQueryParams()['parent_id'];
        $hierarchy = $this->getHierarchy($parent_id);
        $fqpn      = $hierarchy === [] ? '' : $hierarchy[0]->fqpn;
        $parent    = new PlaceLocation($fqpn);

        $place_id  = (int) $request->getQueryParams()['place_id'];
        $hierarchy = $this->getHierarchy($place_id);
        $fqpn      = $hierarchy === [] ? '' : $hierarchy[0]->fqpn;
        $location  = new PlaceLocation($fqpn);

        if ($location->id() !== 0) {
            $title = e($location->locationName());
        } else {
            // Add a place
            if ($parent_id === 0) {
                // We're at the global level so create a minimal
                // place for the page title and breadcrumbs
                $title     = I18N::translate('World');
                $hierarchy = [];
            } else {
                $hierarchy = $this->getHierarchy($parent_id);
                $tmp       = new PlaceLocation($hierarchy[0]->fqpn);

                if ($tmp->latitude() === 0.0 && $tmp->longitude() === 0.0) {

                    FlashMessages::addMessage(I18N::translate('%s (coordinates [0,0]) cannot have a subordinate place', $hierarchy[0]->fqpn), 'warning');

                    return redirect(route(MapDataList::class));
                }
                $title     = e($tmp->locationName());
            }
        }

        $breadcrumbs = [
            route(ControlPanel::class) => I18N::translate('Control panel'),
            route(MapDataList::class)  => I18N::translate('Geographic data'),
        ];

        foreach ($hierarchy as $row) {
            $breadcrumbs[route(MapDataList::class, ['parent_id' => $row->pl_id])] = e($row->pl_place);
        }

        if ($place_id === 0) {
            $title .= ' — ' . I18N::translate('Add');
            $breadcrumbs[] = I18N::translate('Add');
            $latitude      = null;
            $longitude     = null;
            $map_bounds    = $parent->boundingRectangle();
        } else {
            $title .= ' — ' . I18N::translate('Edit');
            $breadcrumbs[] = I18N::translate('Edit');
            $latitude      = $location->latitude();
            $longitude     = $location->longitude();
            $map_bounds    = $location->boundingRectangle();
        }

        // If the current co-ordinates are unknown, leave the input fields empty,
        // and show a marker in the middle of the map.
        if ($latitude === null || $longitude === null) {
            $latitude  = '';
            $longitude = '';

            $marker_position = [
                ($map_bounds[0][0] + $map_bounds[1][0]) / 2.0,
                ($map_bounds[0][1] + $map_bounds[1][1]) / 2.0,
            ];
        } else {
            $marker_position = [$latitude, $longitude];
        }

        return $this->viewResponse('admin/location-edit', [
            'breadcrumbs'     => $breadcrumbs,
            'title'           => $title,
            'location'        => $location,
            'latitude'        => $latitude,
            'longitude'       => $longitude,
            'map_bounds'      => $map_bounds,
            'marker_position' => $marker_position,
            'parent'          => $parent,
            'level'           => $parent_id,
            'provider'        => [
                'url'     => 'https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png',
                'options' => [
                    'attribution' => '<a href="https://www.openstreetmap.org/copyright">&copy; OpenStreetMap</a> contributors',
                    'max_zoom'    => 19
                ]
            ],
        ]);
    }

    /**
     * @param ServerRequestInterface $request
     *
     * @return ResponseInterface
     */
    public function mapDataSave(ServerRequestInterface $request): ResponseInterface
    {
        $params = (array) $request->getParsedBody();

        $parent_id = (int) $request->getQueryParams()['parent_id'];
        $place_id  = (int) $request->getQueryParams()['place_id'];
        $lat       = $this->gedcom_service->writeLatitude((float) $params['new_place_lati']);
        $lng       = $this->gedcom_service->writeLongitude((float) $params['new_place_long']);
        $hierarchy = $this->getHierarchy($parent_id);
        $level     = count($hierarchy);
        $icon      = $params['icon'];
        $zoom      = (int) $params['new_zoom_factor'];

        if ($parent_id > 0 && $lat === 'N0' && $lng === 'E0') {
            FlashMessages::addMessage(I18N::translate('Location [0,0] cannot be subordinate to another place'), 'warning');
        } else {
            if ($place_id === 0) {
                $place_id = 1 + (int) DB::table('placelocation')->max('pl_id');

                DB::table('placelocation')->insert([
                    'pl_id'        => $place_id,
                    'pl_parent_id' => $parent_id,
                    'pl_level'     => $level,
                    'pl_place'     => mb_substr($params['new_place_name'], 0, 120),
                    'pl_lati'      => $lat,
                    'pl_long'      => $lng,
                    'pl_zoom'      => $zoom,
                    'pl_icon'      => $icon,
                ]);
            } else {
                DB::table('placelocation')
                ->where('pl_id', '=', $place_id)
                    ->update([
                        'pl_place' => mb_substr($params['new_place_name'], 0, 120),
                        'pl_lati'  => $lat,
                        'pl_long'  => $lng,
                        'pl_zoom'  => $zoom,
                        'pl_icon'  => $icon,
                    ]);
            }

            FlashMessages::addMessage(
                I18N::translate(
                    'The details for “%s” have been updated.',
                    e($params['new_place_name'])
                ),
                'success'
            );
        }
        $url = route(MapDataList::class, ['parent_id' => $parent_id]);

        return redirect($url);
    }

    /**
     * @param ServerRequestInterface $request
     *
     * @return ResponseInterface
     */
    public function exportLocations(ServerRequestInterface $request): ResponseInterface
    {
        $parent_id = (int) $request->getQueryParams()['parent_id'];
        $format    = $request->getQueryParams()['format'];
        $hierarchy = $this->getHierarchy($parent_id);

        // Create the file name
        // $hierarchy[0] always holds the full placename
        $place_name = $hierarchy === [] ? 'Global' : $hierarchy[0]->fqpn;
        $place_name = str_replace(Gedcom::PLACE_SEPARATOR, '-', $place_name);
        $filename   = addcslashes('Places-' . preg_replace('/[^a-zA-Z0-9.-]/', '', $place_name), '"');

        // Fill in the place names for the starting conditions
        $startfqpn = [];
        foreach ($hierarchy as $record) {
            $startfqpn[] = $record->pl_place;
        }

        // Generate an array containing the data to output.
        $places = [];
        $this->buildExport($parent_id, $startfqpn, $places);

        // Pad all locations to the length of the longest.
        $max_level = 0;
        foreach ($places as $place) {
            $max_level = max($max_level, count($place->fqpn));
        }

        $places = array_map(static function (stdClass $place) use ($max_level): array {
            return array_merge(
                [count($place->fqpn) - 1],
                array_pad($place->fqpn, $max_level, ''),
                [$place->pl_long],
                [$place->pl_lati],
                [$place->pl_zoom],
                [$place->pl_icon]
            );
        }, $places);

        if ($format === 'csv') {
            // Create the header line for the output file (always English)
            $header = [
                I18N::translate('Level'),
            ];

            for ($i = 0; $i < $max_level; $i++) {
                $header[] = 'Place' . $i;
            }

            $header[] = 'Longitude';
            $header[] = 'Latitude';
            $header[] = 'Zoom';
            $header[] = 'Icon';

            return $this->exportCSV($filename . '.csv', $header, $places);
        }

        return $this->exportGeoJSON($filename . '.geojson', $places, $max_level);
    }

    /**
     * @param int             $parent_id
     * @param array<string>   $fqpn
     * @param array<stdClass> $places
     *
     * @return void
     * @throws Exception
     */
    private function buildExport(int $parent_id, array $fqpn, array &$places): void
    {
        // Current number of levels.
        $level = count($fqpn);

        // Data for the next level.
        $rows = DB::table('placelocation')
            ->where('pl_parent_id', '=', $parent_id)
            ->orderBy(new Expression('pl_place /*! COLLATE ' . I18N::collation() . ' */'))
            ->get()
            ->filter(function ($v) {
                return $v->pl_lati !== '' && $v->pl_long !== '';
            });

        foreach ($rows as $row) {
            $fqpn[$level] = $row->pl_place;

            $row->fqpn    = $fqpn;
            $row->pl_zoom = (int) $row->pl_zoom;
            $row->pl_icon = (string) $row->pl_icon;

            $places[] = $row;

            $this->buildExport((int) $row->pl_id, $fqpn, $places);
        }
    }

    /**
     * @param string     $filename
     * @param string[]   $columns
     * @param string[][] $places
     *
     * @return ResponseInterface
     */
    private function exportCSV(string $filename, array $columns, array $places): ResponseInterface
    {
        $resource = fopen('php://temp', 'wb+');

        if ($resource === false) {
            throw new RuntimeException('Failed to create temporary stream');
        }

        fputcsv($resource, $columns, ';');

        foreach ($places as $place) {
            fputcsv($resource, $place, ';');
        }

        rewind($resource);

        return response(stream_get_contents($resource))
            ->withHeader('Content-Type', 'text/csv; charset=utf-8')
            ->withHeader('Content-Disposition', 'attachment; filename="' . $filename . '"');
    }

    /**
     * @param string $filename
     * @param array  $rows
     * @param int    $maxlevel
     *
     * @return ResponseInterface
     */
    private function exportGeoJSON(string $filename, array $rows, int $maxlevel): ResponseInterface
    {
        $geojson = [
            'type'     => 'FeatureCollection',
            'features' => [],
        ];
        foreach ($rows as $place) {
            $fqpn = implode(
                Gedcom::PLACE_SEPARATOR,
                array_reverse(
                    array_filter(
                        array_slice($place, 1, $maxlevel)
                    )
                )
            );

            $geojson['features'][] = [
                'type'       => 'Feature',
                'geometry'   => [
                    'type'        => 'Point',
                    'coordinates' => [
                        $this->gedcom_service->readLongitude($place[$maxlevel + 1]),
                        $this->gedcom_service->readLatitude($place[$maxlevel + 2]),
                    ],
                ],
                'properties' => [
                    'name' => $fqpn,
                ],
            ];
        }

        return response($geojson)
            ->withHeader('Content-Type', 'application/vnd.geo+json')
            ->withHeader('Content-Disposition', 'attachment; filename="' . $filename . '"');
    }

    /**
     * @param ServerRequestInterface $request
     *
     * @return ResponseInterface
     */
    public function importLocations(ServerRequestInterface $request): ResponseInterface
    {
        $data_filesystem      = Registry::filesystem()->data();
        $data_filesystem_name = Registry::filesystem()->dataName();

        $parent_id = (int) $request->getQueryParams()['parent_id'];

        $files = Collection::make($data_filesystem->listContents('places'))
            ->filter(static function (array $metadata): bool {
                $extension = strtolower($metadata['extension'] ?? '');

                return $extension === 'csv' || $extension === 'geojson';
            })
            ->map(static function (array $metadata): string {
                return $metadata['basename'];
            })
            ->sort();

        return $this->viewResponse('admin/map-import-form', [
            'place_folder' => $data_filesystem_name . self::PLACES_FOLDER,
            'title'        => I18N::translate('Import geographic data'),
            'parent_id'    => $parent_id,
            'files'        => $files,
        ]);
    }

    /**
     * This function assumes the input file layout is
     * level followed by a variable number of placename fields
     * followed by Longitude, Latitude, Zoom & Icon
     *
     * @param ServerRequestInterface $request
     *
     * @return ResponseInterface
     * @throws Exception
     */
    public function importLocationsAction(ServerRequestInterface $request): ResponseInterface
    {
        $data_filesystem = Registry::filesystem()->data();

        $params = (array) $request->getParsedBody();
        $url    = route(MapDataList::class, ['parent_id' => 0]);

        $serverfile     = $params['serverfile'] ?? '';
        $options        = $params['import-options'] ?? '';
        $clear_database = (bool) ($params['cleardatabase'] ?? false);
        $local_file     = $request->getUploadedFiles()['localfile'] ?? null;

        $fp = false;

        if ($serverfile !== '' && $data_filesystem->has(self::PLACES_FOLDER . $serverfile)) {
            // first choice is file on server
            $fp = $data_filesystem->readStream(self::PLACES_FOLDER . $serverfile);
        } elseif ($local_file instanceof UploadedFileInterface && $local_file->getError() === UPLOAD_ERR_OK) {
            // 2nd choice is local file
            $fp = $local_file->getStream()->detach();
        }

        if ($fp === false) {
            return redirect($url);
        }

        $string = stream_get_contents($fp);

        $places = [];

        // Check the file type
        if (stripos($string, 'FeatureCollection') !== false) {
            $input_array = json_decode($string, false);

            foreach ($input_array->features as $feature) {
                $places[] = [
                    'pl_level' => $feature->properties->level ?? substr_count($feature->properties->name, ','),
                    'pl_long'  => $feature->geometry->coordinates[0],
                    'pl_lati'  => $feature->geometry->coordinates[1],
                    'pl_zoom'  => $feature->properties->zoom ?? null,
                    'pl_icon'  => $feature->properties->icon ?? null,
                    'fqpn'     => $feature->properties->name,
                ];
            }
        } else {
            rewind($fp);
            while (($row = fgetcsv($fp, 0, ';')) !== false) {
                // Skip the header
                if (!is_numeric($row[0])) {
                    continue;
                }

                $level = (int) $row[0];
                $count = count($row);

                // convert separate place fields into a comma separated placename
                $fqdn = implode(Gedcom::PLACE_SEPARATOR, array_reverse(array_slice($row, 1, 1 + $level)));

                $places[] = [
                    'pl_level' => $level,
                    'pl_long'  => (float) strtr($row[$count - 4], ['E' => '', 'W' => '-', ',' => '.']),
                    'pl_lati'  => (float) strtr($row[$count - 3], ['N' => '', 'S' => '-', ',' => '.']),
                    'pl_zoom'  => $row[$count - 2],
                    'pl_icon'  => $row[$count - 1],
                    'fqpn'     => $fqdn,
                ];
            }
        }

        fclose($fp);

        if ($clear_database) {
            DB::table('placelocation')->delete();
        }

        $added   = 0;
        $updated = 0;

        // Remove places with invalid coordinates
        $places = array_filter($places, function ($item) {
            return $item['pl_level'] === 0 || $item['pl_long'] !== 0.0 || $item['pl_lati'] !== 0.0;
        });

        foreach ($places as $place) {
            $location = new PlaceLocation($place['fqpn']);
            $exists   = $location->exists();

            // Only update existing records
            if ($options === 'update' && !$exists) {
                continue;
            }

            // Only add new records
            if ($options === 'add' && $exists) {
                continue;
            }

            if (!$exists) {
                $added++;
            }

            $updated += DB::table('placelocation')
                ->where('pl_id', '=', $location->id())
                ->update([
                    'pl_lati' => $this->gedcom_service->writeLatitude($place['pl_lati']),
                    'pl_long' => $this->gedcom_service->writeLongitude($place['pl_long']),
                    'pl_zoom' => $place['pl_zoom'] ?: null,
                    'pl_icon' => $place['pl_icon'] ?: null,
                ]);
        }
        FlashMessages::addMessage(
            I18N::translate('locations updated: %s, locations added: %s', I18N::number($updated), I18N::number($added)),
            'info'
        );

        return redirect($url);
    }
}


1			<?php
2
3			/**
4			* webtrees: online genealogy
5			* Copyright (C) 2020 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 <http://www.gnu.org/licenses/>.
16			*/
17
18			declare(strict_types=1);
19
20			namespace Fisharebest\Webtrees\Http\Controllers\Admin;
21
22			use Exception;
23			use Fisharebest\Webtrees\FlashMessages;
24			use Fisharebest\Webtrees\Gedcom;
25			use Fisharebest\Webtrees\Http\RequestHandlers\ControlPanel;
26			use Fisharebest\Webtrees\Http\RequestHandlers\MapDataList;
27			use Fisharebest\Webtrees\I18N;
28			use Fisharebest\Webtrees\PlaceLocation;
29			use Fisharebest\Webtrees\Registry;
30			use Fisharebest\Webtrees\Services\GedcomService;
31			use Illuminate\Database\Capsule\Manager as DB;
32			use Illuminate\Database\Eloquent\Collection;
33			use Illuminate\Database\Query\Expression;
34			use Psr\Http\Message\ResponseInterface;
35			use Psr\Http\Message\ServerRequestInterface;
36			use Psr\Http\Message\UploadedFileInterface;
37			use RuntimeException;
38			use stdClass;
39
40			use function addcslashes;
41			use function array_filter;
42			use function array_merge;
43			use function array_pad;
44			use function array_reverse;
45			use function array_slice;
46			use function assert;
47			use function count;
48			use function e;
49			use function fclose;
50			use function fgetcsv;
51			use function fopen;
52			use function fputcsv;
53			use function implode;
54			use function is_numeric;
55			use function json_decode;
56			use function preg_replace;
57			use function redirect;
58			use function response;
59			use function rewind;
60			use function route;
61			use function str_replace;
62			use function stream_get_contents;
63			use function stripos;
64			use function substr_count;
65
66			use const UPLOAD_ERR_OK;
67
68			/**
69			* Controller for maintaining geographic data.
70			*/
71			class LocationController extends AbstractAdminController
72			{
73			// Location of files to import
74			private const PLACES_FOLDER = 'places/';
75
76			/** @var GedcomService */
77			private $gedcom_service;
78
79			/**
80			* Dependency injection.
81			*
82			* @param GedcomService $gedcom_service
83			*/
84			public function __construct(GedcomService $gedcom_service)
85			{
86			$this->gedcom_service = $gedcom_service;
87			}
88
89			/**
90			* @param int $id
91			*
92			* @return array<stdClass>
93			*/
94			private function getHierarchy(int $id): array
95			{
96			$arr = [];
97			$fqpn = [];
98
99			while ($id !== 0) {
100			$row = DB::table('placelocation')
101			->where('pl_id', '=', $id)
102			->first();
103
104			// For static analysis tools.
105			assert($row instanceof stdClass);
106
107			$fqpn[] = $row->pl_place;
108			$row->fqpn = implode(Gedcom::PLACE_SEPARATOR, $fqpn);
109			$id = (int) $row->pl_parent_id;
110			$arr[] = $row;
111			}
112
113			return array_reverse($arr);
114			}
115
116			/**
117			* @param ServerRequestInterface $request
118			*
119			* @return ResponseInterface
120			*/
121			public function mapDataEdit(ServerRequestInterface $request): ResponseInterface
122			{
123			$parent_id = (int) $request->getQueryParams()['parent_id'];
124			$hierarchy = $this->getHierarchy($parent_id);
125			$fqpn = $hierarchy === [] ? '' : $hierarchy[0]->fqpn;
126			$parent = new PlaceLocation($fqpn);
127
128			$place_id = (int) $request->getQueryParams()['place_id'];
129			$hierarchy = $this->getHierarchy($place_id);
130			$fqpn = $hierarchy === [] ? '' : $hierarchy[0]->fqpn;
131			$location = new PlaceLocation($fqpn);
132
133			if ($location->id() !== 0) {
134			$title = e($location->locationName());
135			} else {
136			// Add a place
137			if ($parent_id === 0) {
138			// We're at the global level so create a minimal
139			// place for the page title and breadcrumbs
140			$title = I18N::translate('World');
141			$hierarchy = [];
142			} else {
143			$hierarchy = $this->getHierarchy($parent_id);
144			$tmp = new PlaceLocation($hierarchy[0]->fqpn);
145
146			if ($tmp->latitude() === 0.0 && $tmp->longitude() === 0.0) {
			0 ignored issues – show introduced 2021-01-15 14:13 UTC by Report Bug Copy Issue Report The condition `$tmp->latitude() === 0.0` is always `false`. Loading history...
147			FlashMessages::addMessage(I18N::translate('%s (coordinates [0,0]) cannot have a subordinate place', $hierarchy[0]->fqpn), 'warning');
148
149			return redirect(route(MapDataList::class));
150			}
151			$title = e($tmp->locationName());
152			}
153			}
154
155			$breadcrumbs = [
156			route(ControlPanel::class) => I18N::translate('Control panel'),
157			route(MapDataList::class) => I18N::translate('Geographic data'),
158			];
159
160			foreach ($hierarchy as $row) {
161			$breadcrumbs[route(MapDataList::class, ['parent_id' => $row->pl_id])] = e($row->pl_place);
162			}
163
164			if ($place_id === 0) {
165			$title .= ' — ' . I18N::translate('Add');
166			$breadcrumbs[] = I18N::translate('Add');
167			$latitude = null;
168			$longitude = null;
169			$map_bounds = $parent->boundingRectangle();
170			} else {
171			$title .= ' — ' . I18N::translate('Edit');
172			$breadcrumbs[] = I18N::translate('Edit');
173			$latitude = $location->latitude();
174			$longitude = $location->longitude();
175			$map_bounds = $location->boundingRectangle();
176			}
177
178			// If the current co-ordinates are unknown, leave the input fields empty,
179			// and show a marker in the middle of the map.
180			if ($latitude === null \|\| $longitude === null) {
181			$latitude = '';
182			$longitude = '';
183
184			$marker_position = [
185			($map_bounds[0][0] + $map_bounds[1][0]) / 2.0,
186			($map_bounds[0][1] + $map_bounds[1][1]) / 2.0,
187			];
188			} else {
189			$marker_position = [$latitude, $longitude];
190			}
191
192			return $this->viewResponse('admin/location-edit', [
193			'breadcrumbs' => $breadcrumbs,
194			'title' => $title,
195			'location' => $location,
196			'latitude' => $latitude,
197			'longitude' => $longitude,
198			'map_bounds' => $map_bounds,
199			'marker_position' => $marker_position,
200			'parent' => $parent,
201			'level' => $parent_id,
202			'provider' => [
203			'url' => 'https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png',
204			'options' => [
205			'attribution' => '<a href="https://www.openstreetmap.org/copyright">© OpenStreetMap</a> contributors',
206			'max_zoom' => 19
207			]
208			],
209			]);
210			}
211
212			/**
213			* @param ServerRequestInterface $request
214			*
215			* @return ResponseInterface
216			*/
217			public function mapDataSave(ServerRequestInterface $request): ResponseInterface
218			{
219			$params = (array) $request->getParsedBody();
220
221			$parent_id = (int) $request->getQueryParams()['parent_id'];
222			$place_id = (int) $request->getQueryParams()['place_id'];
223			$lat = $this->gedcom_service->writeLatitude((float) $params['new_place_lati']);
224			$lng = $this->gedcom_service->writeLongitude((float) $params['new_place_long']);
225			$hierarchy = $this->getHierarchy($parent_id);
226			$level = count($hierarchy);
227			$icon = $params['icon'];
228			$zoom = (int) $params['new_zoom_factor'];
229
230			if ($parent_id > 0 && $lat === 'N0' && $lng === 'E0') {
231			FlashMessages::addMessage(I18N::translate('Location [0,0] cannot be subordinate to another place'), 'warning');
232			} else {
233			if ($place_id === 0) {
234			$place_id = 1 + (int) DB::table('placelocation')->max('pl_id');
235
236			DB::table('placelocation')->insert([
237			'pl_id' => $place_id,
238			'pl_parent_id' => $parent_id,
239			'pl_level' => $level,
240			'pl_place' => mb_substr($params['new_place_name'], 0, 120),
241			'pl_lati' => $lat,
242			'pl_long' => $lng,
243			'pl_zoom' => $zoom,
244			'pl_icon' => $icon,
245			]);
246			} else {
247			DB::table('placelocation')
248			->where('pl_id', '=', $place_id)
249			->update([
250			'pl_place' => mb_substr($params['new_place_name'], 0, 120),
251			'pl_lati' => $lat,
252			'pl_long' => $lng,
253			'pl_zoom' => $zoom,
254			'pl_icon' => $icon,
255			]);
256			}
257
258			FlashMessages::addMessage(
259			I18N::translate(
260			'The details for “%s” have been updated.',
261			e($params['new_place_name'])
262			),
263			'success'
264			);
265			}
266			$url = route(MapDataList::class, ['parent_id' => $parent_id]);
267
268			return redirect($url);
269			}
270
271			/**
272			* @param ServerRequestInterface $request
273			*
274			* @return ResponseInterface
275			*/
276			public function exportLocations(ServerRequestInterface $request): ResponseInterface
277			{
278			$parent_id = (int) $request->getQueryParams()['parent_id'];
279			$format = $request->getQueryParams()['format'];
280			$hierarchy = $this->getHierarchy($parent_id);
281
282			// Create the file name
283			// $hierarchy[0] always holds the full placename
284			$place_name = $hierarchy === [] ? 'Global' : $hierarchy[0]->fqpn;
285			$place_name = str_replace(Gedcom::PLACE_SEPARATOR, '-', $place_name);
286			$filename = addcslashes('Places-' . preg_replace('/[^a-zA-Z0-9.-]/', '', $place_name), '"');
287
288			// Fill in the place names for the starting conditions
289			$startfqpn = [];
290			foreach ($hierarchy as $record) {
291			$startfqpn[] = $record->pl_place;
292			}
293
294			// Generate an array containing the data to output.
295			$places = [];
296			$this->buildExport($parent_id, $startfqpn, $places);
297
298			// Pad all locations to the length of the longest.
299			$max_level = 0;
300			foreach ($places as $place) {
301			$max_level = max($max_level, count($place->fqpn));
302			}
303
304			$places = array_map(static function (stdClass $place) use ($max_level): array {
305			return array_merge(
306			[count($place->fqpn) - 1],
307			array_pad($place->fqpn, $max_level, ''),
308			[$place->pl_long],
309			[$place->pl_lati],
310			[$place->pl_zoom],
311			[$place->pl_icon]
312			);
313			}, $places);
314
315			if ($format === 'csv') {
316			// Create the header line for the output file (always English)
317			$header = [
318			I18N::translate('Level'),
319			];
320
321			for ($i = 0; $i < $max_level; $i++) {
322			$header[] = 'Place' . $i;
323			}
324
325			$header[] = 'Longitude';
326			$header[] = 'Latitude';
327			$header[] = 'Zoom';
328			$header[] = 'Icon';
329
330			return $this->exportCSV($filename . '.csv', $header, $places);
331			}
332
333			return $this->exportGeoJSON($filename . '.geojson', $places, $max_level);
334			}
335
336			/**
337			* @param int $parent_id
338			* @param array<string> $fqpn
339			* @param array<stdClass> $places
340			*
341			* @return void
342			* @throws Exception
343			*/
344			private function buildExport(int $parent_id, array $fqpn, array &$places): void
345			{
346			// Current number of levels.
347			$level = count($fqpn);
348
349			// Data for the next level.
350			$rows = DB::table('placelocation')
351			->where('pl_parent_id', '=', $parent_id)
352			->orderBy(new Expression('pl_place /! COLLATE ' . I18N::collation() . ' /'))
353			->get()
354			->filter(function ($v) {
355			return $v->pl_lati !== '' && $v->pl_long !== '';
356			});
357
358			foreach ($rows as $row) {
359			$fqpn[$level] = $row->pl_place;
360
361			$row->fqpn = $fqpn;
362			$row->pl_zoom = (int) $row->pl_zoom;
363			$row->pl_icon = (string) $row->pl_icon;
364
365			$places[] = $row;
366
367			$this->buildExport((int) $row->pl_id, $fqpn, $places);
368			}
369			}
370
371			/**
372			* @param string $filename
373			* @param string[] $columns
374			* @param string[][] $places
375			*
376			* @return ResponseInterface
377			*/
378			private function exportCSV(string $filename, array $columns, array $places): ResponseInterface
379			{
380			$resource = fopen('php://temp', 'wb+');
381
382			if ($resource === false) {
383			throw new RuntimeException('Failed to create temporary stream');
384			}
385
386			fputcsv($resource, $columns, ';');
387
388			foreach ($places as $place) {
389			fputcsv($resource, $place, ';');
390			}
391
392			rewind($resource);
393
394			return response(stream_get_contents($resource))
395			->withHeader('Content-Type', 'text/csv; charset=utf-8')
396			->withHeader('Content-Disposition', 'attachment; filename="' . $filename . '"');
397			}
398
399			/**
400			* @param string $filename
401			* @param array $rows
402			* @param int $maxlevel
403			*
404			* @return ResponseInterface
405			*/
406			private function exportGeoJSON(string $filename, array $rows, int $maxlevel): ResponseInterface
407			{
408			$geojson = [
409			'type' => 'FeatureCollection',
410			'features' => [],
411			];
412			foreach ($rows as $place) {
413			$fqpn = implode(
414			Gedcom::PLACE_SEPARATOR,
415			array_reverse(
416			array_filter(
417			array_slice($place, 1, $maxlevel)
418			)
419			)
420			);
421
422			$geojson['features'][] = [
423			'type' => 'Feature',
424			'geometry' => [
425			'type' => 'Point',
426			'coordinates' => [
427			$this->gedcom_service->readLongitude($place[$maxlevel + 1]),
428			$this->gedcom_service->readLatitude($place[$maxlevel + 2]),
429			],
430			],
431			'properties' => [
432			'name' => $fqpn,
433			],
434			];
435			}
436
437			return response($geojson)
438			->withHeader('Content-Type', 'application/vnd.geo+json')
439			->withHeader('Content-Disposition', 'attachment; filename="' . $filename . '"');
440			}
441
442			/**
443			* @param ServerRequestInterface $request
444			*
445			* @return ResponseInterface
446			*/
447			public function importLocations(ServerRequestInterface $request): ResponseInterface
448			{
449			$data_filesystem = Registry::filesystem()->data();
450			$data_filesystem_name = Registry::filesystem()->dataName();
451
452			$parent_id = (int) $request->getQueryParams()['parent_id'];
453
454			$files = Collection::make($data_filesystem->listContents('places'))
455			->filter(static function (array $metadata): bool {
456			$extension = strtolower($metadata['extension'] ?? '');
457
458			return $extension === 'csv' \|\| $extension === 'geojson';
459			})
460			->map(static function (array $metadata): string {
461			return $metadata['basename'];
462			})
463			->sort();
464
465			return $this->viewResponse('admin/map-import-form', [
466			'place_folder' => $data_filesystem_name . self::PLACES_FOLDER,
467			'title' => I18N::translate('Import geographic data'),
468			'parent_id' => $parent_id,
469			'files' => $files,
470			]);
471			}
472
473			/**
474			* This function assumes the input file layout is
475			* level followed by a variable number of placename fields
476			* followed by Longitude, Latitude, Zoom & Icon
477			*
478			* @param ServerRequestInterface $request
479			*
480			* @return ResponseInterface
481			* @throws Exception
482			*/
483			public function importLocationsAction(ServerRequestInterface $request): ResponseInterface
484			{
485			$data_filesystem = Registry::filesystem()->data();
486
487			$params = (array) $request->getParsedBody();
488			$url = route(MapDataList::class, ['parent_id' => 0]);
489
490			$serverfile = $params['serverfile'] ?? '';
491			$options = $params['import-options'] ?? '';
492			$clear_database = (bool) ($params['cleardatabase'] ?? false);
493			$local_file = $request->getUploadedFiles()['localfile'] ?? null;
494
495			$fp = false;
496
497			if ($serverfile !== '' && $data_filesystem->has(self::PLACES_FOLDER . $serverfile)) {
498			// first choice is file on server
499			$fp = $data_filesystem->readStream(self::PLACES_FOLDER . $serverfile);
500			} elseif ($local_file instanceof UploadedFileInterface && $local_file->getError() === UPLOAD_ERR_OK) {
501			// 2nd choice is local file
502			$fp = $local_file->getStream()->detach();
503			}
504
505			if ($fp === false) {
506			return redirect($url);
507			}
508
509			$string = stream_get_contents($fp);
510
511			$places = [];
512
513			// Check the file type
514			if (stripos($string, 'FeatureCollection') !== false) {
515			$input_array = json_decode($string, false);
516
517			foreach ($input_array->features as $feature) {
518			$places[] = [
519			'pl_level' => $feature->properties->level ?? substr_count($feature->properties->name, ','),
520			'pl_long' => $feature->geometry->coordinates[0],
521			'pl_lati' => $feature->geometry->coordinates[1],
522			'pl_zoom' => $feature->properties->zoom ?? null,
523			'pl_icon' => $feature->properties->icon ?? null,
524			'fqpn' => $feature->properties->name,
525			];
526			}
527			} else {
528			rewind($fp);
529			while (($row = fgetcsv($fp, 0, ';')) !== false) {
530			// Skip the header
531			if (!is_numeric($row[0])) {
532			continue;
533			}
534
535			$level = (int) $row[0];
536			$count = count($row);
537
538			// convert separate place fields into a comma separated placename
539			$fqdn = implode(Gedcom::PLACE_SEPARATOR, array_reverse(array_slice($row, 1, 1 + $level)));
540
541			$places[] = [
542			'pl_level' => $level,
543			'pl_long' => (float) strtr($row[$count - 4], ['E' => '', 'W' => '-', ',' => '.']),
544			'pl_lati' => (float) strtr($row[$count - 3], ['N' => '', 'S' => '-', ',' => '.']),
545			'pl_zoom' => $row[$count - 2],
546			'pl_icon' => $row[$count - 1],
547			'fqpn' => $fqdn,
548			];
549			}
550			}
551
552			fclose($fp);
553
554			if ($clear_database) {
555			DB::table('placelocation')->delete();
556			}
557
558			$added = 0;
559			$updated = 0;
560
561			// Remove places with invalid coordinates
562			$places = array_filter($places, function ($item) {
563			return $item['pl_level'] === 0 \|\| $item['pl_long'] !== 0.0 \|\| $item['pl_lati'] !== 0.0;
564			});
565
566			foreach ($places as $place) {
567			$location = new PlaceLocation($place['fqpn']);
568			$exists = $location->exists();
569
570			// Only update existing records
571			if ($options === 'update' && !$exists) {
572			continue;
573			}
574
575			// Only add new records
576			if ($options === 'add' && $exists) {
577			continue;
578			}
579
580			if (!$exists) {
581			$added++;
582			}
583
584			$updated += DB::table('placelocation')
585			->where('pl_id', '=', $location->id())
586			->update([
587			'pl_lati' => $this->gedcom_service->writeLatitude($place['pl_lati']),
588			'pl_long' => $this->gedcom_service->writeLongitude($place['pl_long']),
589			'pl_zoom' => $place['pl_zoom'] ?: null,
590			'pl_icon' => $place['pl_icon'] ?: null,
591			]);
592			}
593			FlashMessages::addMessage(
594			I18N::translate('locations updated: %s, locations added: %s', I18N::number($updated), I18N::number($added)),
595			'info'
596			);
597
598			return redirect($url);
599			}
600			}
601

fisharebest / webtrees

Pull Request — master (#3652)

LocationController::getHierarchy() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like