organised Leaflet map and Google Maps into wrappers

2021-05-02 12:14:20 +02:00
9 changed files with 72 additions and 190 deletions
--- a/README.md
+++ b/README.md
@ -14,7 +14,7 @@ git clone https://gitea.e5tv.hu/esoko/mapguesser.git

 All the commands listed here should be executed from the repository root.

-### Setup Docker stack (recommended)
+### (Optional) Setup Docker stack

 The easiest way to build up a fully working application with web server and database is to use Docker Compose with the included `docker-compose.yml`.

@ -24,17 +24,9 @@ All you have to do is executing the following command:
 docker-compose up -d
 ```

-Attach shell to the container of `mapguesser_app`:
+Attach shell to the container of `mapguesser_app`. All of the following commands should be executed there.

-```
-docker exec -it mapguesser_app_1 bash
-```
-
-All of the following commands should be executed there.
-
-### Manual setup (alternative)
-
-If you don't use the Docker stack you need to install your environment manually. Check `docker-compose.yml` and `docker/Dockerfile` to see the system requirements.
+**If you don't use the Docker stack you need to install your environment manually. Check `docker-compose.yml` and `docker/Dockerfile` to see the system requirements.**

 ### Initialize project

@ -48,28 +40,15 @@ composer create-project

 The `.env` file contains several environment variables that are needed by the application to work properly. These should be configured for your environment.

-One very important variable is `DEV`. This indicates that the application operates in development (staging) and not in production mode.
+**You should set here the API keys that enable playing the game. Without these API keys the application cannot work well. To get Google API keys visit this page: https://console.developers.google.com/**

-**Hint:** If you install the application in the Docker stack for development (staging) environment, only the variables for external dependencies (API keys, map attribution, etc.) should be adapted. All other variables (for DB connection, static root, mailing, multiplayer, etc.) are fine with the default value.
+One very important variable is `DEV`. This indicates that the application operates in development (staging) and not in produciton mode.

-#### API keys
-
-**You should set the API keys that enable playing the game. Without these API keys the application cannot work well. To get Google API keys visit this page: https://console.developers.google.com/**
-
-Required Google APIs:
-* **Maps JavaScript API**: for the interactive maps and street views
-* **Maps Static API**: for the static map images
-* **Street View Static API**: for the backend metadata requests
-
-Required API keys:
-* **GOOGLE_MAPS_SERVER_API_KEY**: this it used by the backend and should have access to **Street View Static API**
-* **GOOGLE_MAPS_JS_API_KEY**: this is used by the frontend and should have access to **Maps JavaScript API** and **Maps Static API**
-
-Additionally, a tile provider is also needed for map editor. This should be configured by `LEAFLET_TILESERVER_URL` and `LEAFLET_TILESERVER_ATTRIBUTION`. You can find some providers here: https://wiki.openstreetmap.org/wiki/Tile_servers. OpenStreetMap's tile server is fine for testing.
+If you install the application in the Docker stack for development (staging) environment, only the variables for external dependencies (API keys, map attribution, etc.) should be adapted. All other variables (for DB connection, static root, mailing, etc.) are fine with the default value.

 ### (Production only) Create cron job

-To maintain database (delete inactive users, old sessions etc.), the command `db:maintain` should be regularly executed. It is recommended to create a cron job that runs every hour:
+To maintain database (delete inactive users, old sessions etc.), the command `db:maintain` should be regularly executed. It is recommened to create a cron job that runs every hour:

 ```
 0 * * * * /path/to/your/installation/mapg db:maintain >>/var/log/cron-mapguesser.log 2>&1
@ -77,19 +56,13 @@ To maintain database (delete inactive users, old sessions etc.), the command `db

 ### Finalize installation

-After you followed the above steps, execute the following command:
+After you set the environment variables in the `.env` file, execute the following command:

 ```
 scripts/install.sh
 ```

-**Warning: Because of a known issue the image `mapguesser_multi` fails to run without the installation steps. You have to relauch `docker-compose up -d` after you finished the installation process.**
-
-**And you are done!** The application is ready to use and develop. In development mode an administrative user is also created by the installation script, email is **mapg@mapg.dev**, password is **123456**. In production mode you should create the first administrative user with the following command:
-
-```
-./mapg user:add EMAIL PASSWORD admin
-```
+**And you are done!** The application is ready to use and develop.

 If you installed it in the Docker stack, you can reach it on http://localhost. The mails that are sent by the application can be found on http://localhost:8080/. If needed, the database server can be directly reached on localhost:3306.

--- a/public/static/css/map_editor.css
+++ b/public/static/css/map_editor.css
@ -1,4 +1,4 @@
-.map {
+#map {
    position: absolute;
    top: 0;
    left: 0;
@ -7,13 +7,6 @@
    z-index: 1;
 }

-#mapSelection img {
-    display: inline;
-    width: 1em;
-    height: 1em;
-    vertical-align: -0.15em;
-}
-
 /* modify the cursor for the Leaflet map */
 .leaflet-container {
    cursor: crosshair;
@ -72,9 +65,6 @@
    #placeControl {
        top: calc(50% + 10px);
    }
-    .hideOnMobile {
-        display: none;
-    }
 }

@media screen and (min-width: 1000px), (max-height: 599px) {
--- a/public/static/img/compass.svg
+++ b/public/static/img/compass.svg
@ -1,5 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100">
-  <polygon id="needleNorth" points="50,0 33,50 66,50" style="fill:red;stroke:black;stroke-width:1" />
-  <polygon id="needleSouth" points="50,100 33,50 66,50" style="fill:white;stroke:black;stroke-width:1" />
-  Sorry, your browser does not support inline SVG.
-</svg>
--- a/public/static/img/map.svg
+++ b/public/static/img/map.svg
@ -1,4 +0,0 @@
-<!-- Copyright (c) 2019 The Bootstrap Authors. License can be found in 'USED_SOFTWARE' in section 'Bootstrap Icons'. -->
-<svg xmlns="http://www.w3.org/2000/svg" fill="#ffffff" viewBox="0 0 16 16">
-  <path fill-rule="evenodd" d="M15.817.113A.5.5 0 0 1 16 .5v14a.5.5 0 0 1-.402.49l-5 1a.502.502 0 0 1-.196 0L5.5 15.01l-4.902.98A.5.5 0 0 1 0 15.5v-14a.5.5 0 0 1 .402-.49l5-1a.5.5 0 0 1 .196 0L10.5.99l4.902-.98a.5.5 0 0 1 .415.103zM10 1.91l-4-.8v12.98l4 .8V1.91zm1 12.98 4-.8V1.11l-4 .8v12.98zm-6-.8V1.11l-4 .8v12.98l4-.8z"/>
-</svg>
--- a/public/static/js/game.js
+++ b/public/static/js/game.js
@ -387,10 +387,6 @@
            document.getElementById('currentRound').innerHTML = String(Game.rounds.length) + '/' + String(Game.NUMBER_OF_ROUNDS);

            Game.loadPano(Game.panoId, Game.pov);
-
-            // update the compass
-            const heading = Game.panorama.getPov().heading;
-            document.getElementById("compass").style.transform = "translateY(-50%) rotate(" + heading + "deg)";
        },

        handleErrorResponse: function (error) {
@ -867,9 +863,6 @@

    Game.panorama.addListener('pov_changed', function () {
        Game.rewriteGoogleLink();
-
-        const heading = Game.panorama.getPov().heading;
-        document.getElementById("compass").style.transform = "translateY(-50%) rotate(" + heading + "deg)";
    });

    if (COOKIES_CONSENT) {
@ -957,8 +950,4 @@
    document.getElementById('returnToStart').onclick = function () {
        Game.loadPano(Game.panoId, Game.pov);
    }
-
-    document.getElementById('compassContainer').onclick = function () {
-        Game.panorama.setPov({ heading: 0, pitch: Game.panorama.getPov().pitch });
-    }
 })();
--- a/public/static/js/map_editor.js
+++ b/public/static/js/map_editor.js
@ -117,7 +117,7 @@
            MapEditor.resetSelected();
            MapEditor.selectedMarker = marker;

-            MapEditor.map.resize();
+            MapEditor.map.invalidateSize(true);
            MapEditor.map.panTo(marker.getLatLng());

            MapEditor.panorama.setVisible(false);
@ -219,7 +219,7 @@
            MapEditor.resetSelected(del);
            MapEditor.selectedMarker = null;

-            MapEditor.map.resize();
+            MapEditor.map.invalidateSize(true);
        },

        deletePlace: function () {
@ -235,7 +235,6 @@

            delete MapEditor.added[placeId];
            delete MapEditor.edited[placeId];
-            delete places[placeId];

            document.getElementById('added').innerHTML = String(Object.keys(MapEditor.added).length);
            document.getElementById('edited').innerHTML = String(Object.keys(MapEditor.edited).length);
@ -351,7 +350,6 @@
    var LMapWrapper = {
        map: null,
        markers: null,
-        divId: null,
        iconCollection: {
            iconGreen: L.icon({
                iconUrl: STATIC_ROOT + '/img/markers/marker-green.svg?rev' + REVISION,
@ -371,48 +369,36 @@
        },

        init: function (divId, places) {
-            document.getElementById(divId).style.display = "block";
+            LMapWrapper.map = L.map('map', {
+                zoomControl: false
+            });

-            if (!LMapWrapper.map) {
-                LMapWrapper.divId = divId;
-                LMapWrapper.map = L.map(LMapWrapper.divId, {
-                    zoomControl: false
-                });
+            LMapWrapper.map.on('click', function (e) {
+                LMapWrapper.placeMarker(e.latlng);
+            });

-                LMapWrapper.map.on('click', function (e) {
-                    LMapWrapper.placeMarker(e.latlng);
-                });
+            var highResData = Util.getHighResData();

-                var highResData = Util.getHighResData();
+            L.tileLayer(tileUrl, {
+                attribution: tileAttribution,
+                subdomains: '1234',
+                ppi: highResData.ppi,
+                tileSize: highResData.tileSize,
+                zoomOffset: highResData.zoomOffset,
+                minZoom: highResData.minZoom,
+                maxZoom: highResData.maxZoom
+            }).addTo(LMapWrapper.map);

-                L.tileLayer(tileUrl, {
-                    attribution: tileAttribution,
-                    subdomains: '1234',
-                    ppi: highResData.ppi,
-                    tileSize: highResData.tileSize,
-                    zoomOffset: highResData.zoomOffset,
-                    minZoom: highResData.minZoom,
-                    maxZoom: highResData.maxZoom
-                }).addTo(LMapWrapper.map);
-
-                LMapWrapper.map.fitBounds(L.latLngBounds({ lat: mapBounds.south, lng: mapBounds.west }, { lat: mapBounds.north, lng: mapBounds.east }));
-            }
+            LMapWrapper.map.fitBounds(L.latLngBounds({ lat: mapBounds.south, lng: mapBounds.west }, { lat: mapBounds.north, lng: mapBounds.east }));

            LMapWrapper.loadMarkers(places);
        },

-        hide: function () {
-            document.getElementById(LMapWrapper.divId).style.display = 'none';
-        },
-
        loadMarkers: function (places) {
-            if (!LMapWrapper.markers) {
-                LMapWrapper.markers = L.markerClusterGroup({
-                    maxClusterRadius: 50
-                });
-            } else {
-                LMapWrapper.markers.clearLayers();
-            }
+
+            LMapWrapper.markers = L.markerClusterGroup({
+                maxClusterRadius: 50
+            });

            for (var placeId in places) {
                if (!places.hasOwnProperty(placeId)) {
@ -430,7 +416,7 @@
                        MapEditor.select(this);
                    });

-                marker.placeId = placeId;
+                marker.placeId = place.id;
            }

            LMapWrapper.map.addLayer(LMapWrapper.markers);
@ -443,7 +429,7 @@
                icon: LMapWrapper.iconCollection.iconBlue,
                zIndexOffset: 2000
            })
-                .addTo(LMapWrapper.markers)
+                .addTo(LMapWrapper.map)
                .on('click', function () {
                    MapEditor.select(this);
                });
@ -455,24 +441,25 @@
            LMapWrapper.map.panTo(latLng);
        },

-        resize: function () {
-            LMapWrapper.map.invalidateSize(true);
+        invalidateSize: function (invalid) {
+            LMapWrapper.map.invalidateSize(invalid);
        },

        changeMarkerIcon: function (marker, icon) {
+            LMapWrapper.markers.removeLayer(marker);
+            LMapWrapper.map.addLayer(marker);
            marker.setIcon(icon);
            marker.setZIndexOffset(2000);
        },

        removeMarker: function (marker) {
-            LMapWrapper.markers.removeLayer(marker);
+            LMapWrapper.map.removeLayer(marker);
        }
    };

    var GMapWrapper = {
        map: null,
        markers: null,
-        divId: null,
        iconCollection: {
            iconGreen: {
                url: STATIC_ROOT + '/img/markers/marker-green.svg?rev' + REVISION,
@ -495,52 +482,36 @@
        },

        init: function (divId, places) {
-            document.getElementById(divId).style.display = "block";
+            GMapWrapper.map = new google.maps.Map(document.getElementById(divId), {
+                center: { lat: 48.2207779, lng: 16.3098489 },
+                zoom: 2,
+                fullscreenControl: false,
+                zoomControl: true,
+                zoomControlOptions: {
+                    position: google.maps.ControlPosition.LEFT_BOTTOM
+                },
+                streetViewControl: true,
+                streetViewControlOptions: {
+                    position: google.maps.ControlPosition.LEFT_BOTTOM
+                },
+                draggableCursor: 'crosshair'
+            });

-            if (!GMapWrapper.map) {
-                GMapWrapper.divId = divId;
-                GMapWrapper.map = new google.maps.Map(document.getElementById(GMapWrapper.divId), {
-                    center: { lat: 0., lng: 0. },
-                    zoom: 2,
-                    fullscreenControl: false,
-                    zoomControl: true,
-                    zoomControlOptions: {
-                        position: google.maps.ControlPosition.LEFT_BOTTOM
-                    },
-                    streetViewControl: true,
-                    streetViewControlOptions: {
-                        position: google.maps.ControlPosition.LEFT_BOTTOM
-                    },
-                    draggableCursor: 'crosshair'
+            GMapWrapper.map.addListener('click', function (mapsMouseEvent) {
+                GMapWrapper.placeMarker({
+                    lat: mapsMouseEvent.latLng.lat(),
+                    lng: mapsMouseEvent.latLng.lng()
                });
-
-                GMapWrapper.map.addListener('click', function (mapsMouseEvent) {
-                    GMapWrapper.placeMarker({
-                        lat: mapsMouseEvent.latLng.lat(),
-                        lng: mapsMouseEvent.latLng.lng()
-                    });
-                });
-
-            }
+            });

            GMapWrapper.loadMarkers(places);
-
-            GMapWrapper.loaded = true;
-        },
-
-        hide: function () {
-            document.getElementById(GMapWrapper.divId).style.display = 'none';
        },

        loadMarkers: function (places) {
-            if (!GMapWrapper.markers) {
-                GMapWrapper.markers = new MarkerClusterer(GMapWrapper.map, [], {
-                    imagePath: STATIC_ROOT + '/img/markers/m',
-                    imageExtension: 'png?rev' + REVISION
-                });
-            } else {
-                GMapWrapper.markers.clearMarkers();
-            }
+            GMapWrapper.markers = new MarkerClusterer(GMapWrapper.map, [], { 
+                imagePath: STATIC_ROOT + '/img/markers/m',
+                imageExtension: 'png?rev' + REVISION
+            });

            for (var placeId in places) {
                if (!places.hasOwnProperty(placeId)) {
@ -564,7 +535,7 @@
                    MapEditor.select(this);
                });

-                marker.placeId = placeId;
+                marker.placeId = place.id;

                GMapWrapper.markers.addMarker(marker);
            }
@ -595,8 +566,10 @@
            GMapWrapper.map.panTo(latLng);
        },

-        resize: function () {
-            google.maps.event.trigger(GMapWrapper.map, 'resize');
+        invalidateSize: function (invalid) {
+            if (invalid) {
+                google.maps.event.trigger(GMapWrapper.map, 'resize');
+            }
        },

        changeMarkerIcon: function (marker, icon) {
@ -608,9 +581,9 @@
        }
    };

-    // initialize content of #map with google maps
+    // MapEditor.map = LMapWrapper;
    MapEditor.map = GMapWrapper;
-    MapEditor.map.init('gmap', places);
+    MapEditor.map.init('map', places);

    MapEditor.panorama = new google.maps.StreetViewPanorama(document.getElementById('panorama'), {
        // switch off fullscreenControl because positioning doesn't work
@ -680,19 +653,4 @@
        }
    };

-    document.getElementById('mapSelector').onclick = function () {
-        MapEditor.closePlace();
-        MapEditor.map.hide();
-
-        if (MapEditor.map === GMapWrapper) {
-            MapEditor.map = LMapWrapper;
-            MapEditor.map.init('lmap', places);
-        } else {
-            MapEditor.map = GMapWrapper;
-            MapEditor.map.init('gmap', places);
-        }
-
-
-    }
-
 })();
--- a/scripts/install.sh
+++ b/scripts/install.sh
@ -27,9 +27,6 @@ if [ -z "${DEV}" ] || [ "${DEV}" -eq "0" ]; then

    echo "Linking view files..."
    (cd ${ROOT_DIR} && ./mapg view:link)
-else
-    echo "Creating the first user..."
-    (cd ${ROOT_DIR} && ./mapg user:add mapg@mapg.dev 123456 admin)
 fi

 touch ${ROOT_DIR}/installed
--- a/views/admin/map_editor.php
+++ b/views/admin/map_editor.php
@ -13,12 +13,7 @@

@section(subheader) 
           <span><a href="javascript:;" id="mapName" title="Edit map data"><?= $mapName ?></a></span><!--
-        --><span class="inline hideOnMobile" id="mapSelection">
-                <button id="mapSelector">
-                    <img src="<?= $_ENV['STATIC_ROOT'] ?>/img/map.svg?rev=<?= REVISION ?>" alt="Map Selector" />
-                </button>
-           </span><!--
-        --><span class="inline hideOnMobile">
+        --><span>
               <input type="text" id="jumpCoordinates" placeholder="Insert coordinates here" />
               <button id="jumpButton" disabled >Jump</button>
           </span><!--
@ -63,10 +58,7 @@
@endsection

@section(main)
-    <div id="map" class="map">
-        <div id="lmap" class="map"></div>
-        <div id="gmap" class="map"></div>
-    </div>
+    <div id="map"></div>
    <div id="panorama"></div>
    <div id="noPano">
        <p class="bold">No panorama is available for this location.</p>
--- a/views/game.php
+++ b/views/game.php
@ -60,14 +60,6 @@
        </div>
    </div>
    <div id="navigation">
-        <div id="compassContainer" class="navigationItem">
-            <div>
-                <img src="<?= $_ENV['STATIC_ROOT'] ?>/img/circle_background.svg?rev=<?= REVISION ?>" alt="Circle Background" class="circleBackground" />
-            </div>
-            <div>
-                <img id="compass" src="<?= $_ENV['STATIC_ROOT'] ?>/img/compass.svg?rev=<?= REVISION ?>" alt="compass icon" class="navigationIcon" />
-            </div>
-        </div>
        <div id="returnToStart" class="navigationItem">
            <div>
                <img src="<?= $_ENV['STATIC_ROOT'] ?>/img/circle_background.svg?rev=<?= REVISION ?>" alt="Circle Background" class="circleBackground" />