Merge pull request 'feature/MAPG-203-initial-multiplayer-implementation' (#5) from feature/MAPG-203-initial-multiplayer-implementation into develop

Reviewed-on: https://gitea.e5tv.hu/esoko/mapguesser/pulls/5

.gitignore

@@ -1,4 +1,3 @@
 .env
 installed
-unit_test_results.xml
 vendor

README.md

@@ -9,7 +9,7 @@ This is the MapGuesser Application project. This is a game about guessing where
 The first step is obviously cloning the repository to your machine:
 
 ```
-git clone https://bitbucket.org/esoko/mapguesser.git
+git clone https://gitea.e5tv.hu/esoko/mapguesser.git
 ```
 
 All the commands listed here should be executed from the repository root.

bitbucket-pipelines.yml

@@ -17,8 +17,10 @@ pipelines:
               name: Static Code Analysis
               caches:
                   - composer
+              artifacts:
+                  - static_code_analysis_results.json
               script:
                   - apt-get update && apt-get install -y unzip
                   - curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
                   - composer install
-                  - vendor/bin/phpstan analyse -c phpstan.neon
+                  - php -d memory_limit=1G vendor/bin/phpstan analyse -c phpstan.neon --error-format=prettyJson > static_code_analysis_results.json

public/static/css/mapguesser.css

@@ -404,9 +404,17 @@ div.buttonContainer>button {
 }
 
 #cookiesNotice {
+    position: fixed;
+    left: 0;
+    bottom: 0;
+    right: 0;
+    margin: 20px;
     background-color: #eeeeee;
+    border: solid #888888 1px;
+    border-radius: 3px;
     padding: 10px;
     text-align: center;
+    z-index: 10;
 }
 
 #loading {

public/static/js/game.js

@@ -26,7 +26,7 @@
             });
             Game.map.fitBounds(mapBounds);
 
-            MapGuesser.httpRequest('GET', '/game/' + mapId + '/newPlace.json', function () {
+            MapGuesser.httpRequest('GET', '/game/' + mapId + '/initialData.json', function () {
                 document.getElementById('loading').style.visibility = 'hidden';
                 document.getElementById('panoCover').style.visibility = 'hidden';
 
@@ -35,8 +35,8 @@
                     return;
                 }
 
-                Game.panoId = this.response.panoId;
-                Game.pov = this.response.pov;
+                Game.panoId = this.response.place.panoId;
+                Game.pov = this.response.place.pov;
 
                 if (this.response.history) {
                     for (var i = 0; i < this.response.history.length; ++i) {
@@ -200,8 +200,13 @@
                     document.getElementById('showSummaryButton').style.display = 'block';
                 }
 
-                Game.panoId = this.response.panoId;
-                Game.pov = this.response.pov;
+                if (this.response.newPlace) {
+                    Game.panoId = this.response.newPlace.panoId;
+                    Game.pov = this.response.newPlace.pov;
+                } else {
+                    Game.panoId = null;
+                    Game.pov = null;
+                }
             }, data);
         },
 

src/Controller/GameFlowController.php

@@ -4,7 +4,6 @@ use MapGuesser\Interfaces\Request\IRequest;
 use MapGuesser\Util\Geo\Position;
 use MapGuesser\Response\JsonContent;
 use MapGuesser\Interfaces\Response\IContent;
-use MapGuesser\PersistentData\Model\Place;
 use MapGuesser\Repository\PlaceRepository;
 
 class GameFlowController
@@ -22,10 +21,9 @@ class GameFlowController
         $this->placeRepository = new PlaceRepository();
     }
 
-    public function getNewPlace(): IContent
+    public function getInitialData(): IContent
     {
         $mapId = (int) $this->request->query('mapId');
-
         $session = $this->request->session();
 
         if (!($state = $session->get('state')) || $state['mapId'] !== $mapId) {
@@ -33,16 +31,15 @@ class GameFlowController
         }
 
         if (count($state['rounds']) === 0) {
-            $placesWithoutPano = [];
-            $place = $this->placeRepository->getRandomForMapWithValidPano($mapId, [], $placesWithoutPano);
-
-            $this->addNewRoundToState($state, $place, $placesWithoutPano);
+            $place = $this->selectNewPlace($state, $mapId);
 
             $session->set('state', $state);
 
             $data = [
-                'panoId' => $place->getPanoIdCached(),
-                'pov' => $place->getPov()->toArray()
+                'place' => [
+                    'panoId' => $place->getPanoIdCached(),
+                    'pov' => $place->getPov()->toArray()
+                ]
             ];
         } else {
             $rounds = count($state['rounds']);
@@ -61,10 +58,12 @@ class GameFlowController
 
             $data = [
                 'history' => $history,
-                'panoId' => $last['panoId'],
-                'pov' => isset($last['pov']) ? // should be checked not to break with old sessions
-                    $last['pov']->toArray() :
-                    ['heading' => 0.0, 'pitch' => 0.0, 'zoom' => 0.0],
+                'place' => [
+                    'panoId' => $last['panoId'],
+                    'pov' => isset($last['pov']) ? // should be checked not to break with old sessions
+                        $last['pov']->toArray() :
+                        ['heading' => 0.0, 'pitch' => 0.0, 'zoom' => 0.0]
+                ]
             ];
         }
 
@@ -74,7 +73,6 @@ class GameFlowController
     public function evaluateGuess(): IContent
     {
         $mapId = (int) $this->request->query('mapId');
-
         $session = $this->request->session();
 
         if (!($state = $session->get('state')) || $state['mapId'] !== $mapId) {
@@ -94,49 +92,43 @@ class GameFlowController
         $last['score'] = $score;
         $state['rounds'][count($state['rounds']) - 1] = $last;
 
-        if (count($state['rounds']) < static::NUMBER_OF_ROUNDS) {
-            $exclude = [];
-
-            foreach ($state['rounds'] as $round) {
-                $exclude = array_merge($exclude, $round['placesWithoutPano'], [$round['placeId']]);
-            }
-
-            $placesWithoutPano = [];
-            $place = $this->placeRepository->getRandomForMapWithValidPano($mapId, $exclude, $placesWithoutPano);
-
-            $this->addNewRoundToState($state, $place, $placesWithoutPano);
-
-            $panoId = $place->getPanoIdCached();
-            $pov = $place->getPov()->toArray();
-        } else {
-            $state['rounds'] = [];
-
-            $panoId = null;
-            $pov = null;
-        }
-
-        $session->set('state', $state);
-
-        return new JsonContent([
+        $response = [
             'result' => [
                 'position' => $position->toArray(),
                 'distance' => $distance,
                 'score' => $score
-            ],
-            'panoId' => $panoId,
-            'pov' => $pov
-        ]);
+            ]
+        ];
+
+        if (count($state['rounds']) < static::NUMBER_OF_ROUNDS) {
+            $place = $this->selectNewPlace($state, $mapId);
+
+            $response['newPlace'] = [
+                'panoId' => $place->getPanoIdCached(),
+                'pov' => $place->getPov()->toArray()
+            ];
+        } else {
+            $state['rounds'] = [];
+        }
+
+        $session->set('state', $state);
+
+        return new JsonContent($response);
     }
 
-    private function addNewRoundToState(array &$state, Place $place, array $placesWithoutPano): void
+    private function selectNewPlace(array &$state, int $mapId)
     {
+        $exclude = array_column($state['rounds'], 'placeId');
+        $place = $this->placeRepository->getRandomForMapWithValidPano($mapId, $exclude);
+
         $state['rounds'][] = [
-            'placesWithoutPano' => $placesWithoutPano,
             'placeId' => $place->getId(),
             'position' => $place->getPosition(),
             'panoId' => $place->getPanoIdCached(),
             'pov' => $place->getPov()
         ];
+
+        return $place;
     }
 
     private function calculateDistance(Position $realPosition, Position $guessPosition): float

src/Repository/PlaceRepository.php

@@ -29,17 +29,14 @@ class PlaceRepository
     }
 
     //TODO: use Map instead of id
-    public function getRandomForMapWithValidPano(int $mapId, array $exclude = [], array &$placesWithoutPano): Place
+    public function getRandomForMapWithValidPano(int $mapId, array $exclude = []): Place
     {
-        $placesWithoutPano = [];
-
         do {
             $place = $this->selectRandomFromDbForMap($mapId, $exclude);
 
             $panoId = $place->getFreshPanoId();
-
             if ($panoId === null) {
-                $placesWithoutPano[] = $exclude[] = $place->getId();
+                $exclude[] = $place->getId();
             }
         } while ($panoId === null);
 

views/templates/layout_full.php

@@ -4,7 +4,7 @@
 <header class="small">
     <h1>
         <a href="/" title="<?= $_ENV['APP_NAME'] ?>">
-            <img class="inline" width="1em" height="1em" src="<?= $_ENV['STATIC_ROOT'] ?>/img/icon.svg?rev=<?= REVISION ?>"><!--
+            <img class="inline" width="1em" height="1em" src="<?= $_ENV['STATIC_ROOT'] ?>/img/icon.svg?rev=<?= REVISION ?>" alt="<?= $_ENV['APP_NAME'] ?>"><!--
          --><span><?= $_ENV['APP_NAME'] ?></span>
         </a>
     </h1>

views/templates/layout_minimal.php

@@ -3,7 +3,7 @@
 @section(content)
 <header>
     <h1>
-        <img class="inline" width="1em" height="1em" src="<?= $_ENV['STATIC_ROOT'] ?>/img/icon.svg?rev=<?= REVISION ?>"><!--
+        <img class="inline" width="1em" height="1em" src="<?= $_ENV['STATIC_ROOT'] ?>/img/icon.svg?rev=<?= REVISION ?>" alt="<?= $_ENV['APP_NAME'] ?>"><!--
      --><?= $_ENV['APP_NAME'] ?>
     </h1>
 </header>

views/templates/layout_normal.php

@@ -4,7 +4,7 @@
 <header>
     <h1>
         <a href="/" title="<?= $_ENV['APP_NAME'] ?>">
-            <img class="inline" width="1em" height="1em" src="<?= $_ENV['STATIC_ROOT'] ?>/img/icon.svg?rev=<?= REVISION ?>"><!--
+            <img class="inline" width="1em" height="1em" src="<?= $_ENV['STATIC_ROOT'] ?>/img/icon.svg?rev=<?= REVISION ?>" alt="<?= $_ENV['APP_NAME'] ?>"><!--
          --><span><?= $_ENV['APP_NAME'] ?></span>
         </a>
     </h1>

views/templates/mapguesser.php

@@ -1,13 +1,23 @@
 <!DOCTYPE html>
-<html>
+<html lang="en">
 <head>
     <meta charset="utf-8">
+    <meta name="description" content="<?= $_ENV['APP_NAME'] ?> – A game about guessing where you are based on a street view panorama.">
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <meta name="theme-color" content="#198231">
     <title><?= $_ENV['APP_NAME'] ?></title>
+    <?php if (preg_match('/^(http(s)?:)?\/\//', $_ENV['STATIC_ROOT']) === 1): ?>
+        <link href="<?= $_ENV['STATIC_ROOT'] ?>" rel="preconnect">
+    <?php endif; ?>
+    <link href="https://fonts.gstatic.com" rel="preconnect">
+    <link href="https://maps.googleapis.com" rel="preconnect">
+    <?php if (!empty($_ENV['GOOGLE_ANALITICS_ID'])): ?>
+        <link href="https://www.googletagmanager.com" rel="preconnect">
+        <link href="https://www.google-analytics.com" rel="preconnect">
+    <?php endif; ?>
+    <link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;500&amp;display=swap" rel="stylesheet">
     <link href="<?= $_ENV['STATIC_ROOT'] ?>/css/mapguesser.css?rev=<?= REVISION ?>" rel="stylesheet">
     @yields('externalCss')
-    <link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;500&display=swap" rel="stylesheet">
     @yields('inlineCss')
     <link rel="icon" type="image/png" sizes="192x192" href="<?= $_ENV['STATIC_ROOT'] ?>/img/favicon/192x192.png?rev=<?= REVISION ?>">
     <link rel="icon" type="image/png" sizes="96x96" href="<?= $_ENV['STATIC_ROOT'] ?>/img/favicon/96x96.png?rev=<?= REVISION ?>">
@@ -15,16 +25,8 @@
     <link rel="icon" type="image/png" sizes="16x16" href="<?= $_ENV['STATIC_ROOT'] ?>/img/favicon/16x16.png?rev=<?= REVISION ?>">
 </head>
 <body>
-    <?php if (!isset($_COOKIE['COOKIES_CONSENT'])): ?>
-        <div id="cookiesNotice">
-            <p class="small">
-                <?= $_ENV['APP_NAME'] ?> uses cookies to improve user experience. By using the app or clicking 'Agree', you consent to our use of cookies.
-            </p>
-            <button id="agreeCookiesButton" class="small marginTop">Agree</button>
-        </div>
-    <?php endif; ?>
     <div id="loading">
-        <img src="<?= $_ENV['STATIC_ROOT'] ?>/img/loading.svg?rev=<?= REVISION ?>" width="64" height="64">
+        <img src="<?= $_ENV['STATIC_ROOT'] ?>/img/loading.svg?rev=<?= REVISION ?>" width="64" height="64" alt="Loading">
     </div>
     <div id="cover"></div>
     <div id="modal" class="modal">
@@ -34,6 +36,14 @@
     </div>
     @yields('pagemodal')
     @yields('content')
+    <?php if (!isset($_COOKIE['COOKIES_CONSENT'])): ?>
+        <div id="cookiesNotice">
+            <p class="small">
+                <?= $_ENV['APP_NAME'] ?> uses cookies to improve user experience. By using the app or clicking 'Agree', you consent to our use of cookies.
+            </p>
+            <button id="agreeCookiesButton" class="small marginTop">Agree</button>
+        </div>
+    <?php endif; ?>
     <script>
         const STATIC_ROOT = '<?= $_ENV['STATIC_ROOT'] ?>';
         const REVISION = '<?= REVISION ?>';

web.php

@@ -51,7 +51,7 @@ Container::$routeCollection->group('account', function (MapGuesser\Routing\Route
 Container::$routeCollection->group('game', function (MapGuesser\Routing\RouteCollection $routeCollection) {
     $routeCollection->get('game', '{mapId}', [MapGuesser\Controller\GameController::class, 'getGame']);
     $routeCollection->get('game-json', '{mapId}/json', [MapGuesser\Controller\GameController::class, 'getGameJson']);
-    $routeCollection->get('newPlace-json', '{mapId}/newPlace.json', [MapGuesser\Controller\GameFlowController::class, 'getNewPlace']);
+    $routeCollection->get('initialData-json', '{mapId}/initialData.json', [MapGuesser\Controller\GameFlowController::class, 'getInitialData']);
     $routeCollection->post('guess-json', '{mapId}/guess.json', [MapGuesser\Controller\GameFlowController::class, 'evaluateGuess']);
 });
 Container::$routeCollection->group('admin', function (MapGuesser\Routing\RouteCollection $routeCollection) {