Check that conditions on valueMax are acceptable before adding the vote

Handles people voting when the answers valueMax has been reached by someone else in the background

Signed-off-by: Thomas Citharel <tcit@tcit.fr>

adminstuds.php

@@ -19,6 +19,7 @@
 use Framadate\Editable;
 use Framadate\Exception\AlreadyExistsException;
 use Framadate\Exception\ConcurrentEditionException;
+use Framadate\Exception\ConcurrentVoteException;
 use Framadate\Exception\MomentAlreadyExistsException;
 use Framadate\Message;
 use Framadate\Security\PasswordHasher;
@@ -224,6 +225,8 @@ if (!empty($_POST['save'])) { // Save edition of an old vote
             }
         } catch (ConcurrentEditionException $cee) {
             $message = new Message('danger', __('Error', 'Poll has been updated before you vote'));
+        } catch (ConcurrentVoteException $cve) {
+            $message = new Message('danger', __('Error', "Your vote wasn't counted, because someone voted in the meantime and it conflicted with your choices and the poll conditions. Please retry."));
         }
     }
 } elseif (isset($_POST['save'])) { // Add a new vote
@@ -251,6 +254,8 @@ if (!empty($_POST['save'])) { // Save edition of an old vote
             $message = new Message('danger', __('Error', 'You already voted'));
         } catch (ConcurrentEditionException $cee) {
             $message = new Message('danger', __('Error', 'Poll has been updated before you vote'));
+        } catch (ConcurrentVoteException $cve) {
+            $message = new Message('danger', __('Error', "Your vote wasn't counted, because someone voted in the meantime and it conflicted with your choices and the poll conditions. Please retry."));
         }
     }
 }

app/classes/Framadate/Exception/ConcurrentVoteException.php

@@ -0,0 +1,12 @@
+<?php
+namespace Framadate\Exception;
+
+/**
+ * Class ConcurrentVoteException
+ *
+ * Thrown when a poll has a maximum votes constraint for options, and a vote happened since the poll was rendered
+ */
+class ConcurrentVoteException extends \Exception {
+    function __construct() {
+    }
+}

app/classes/Framadate/Services/PollService.php

@@ -20,6 +20,7 @@ namespace Framadate\Services;
 
 use Framadate\Exception\AlreadyExistsException;
 use Framadate\Exception\ConcurrentEditionException;
+use Framadate\Exception\ConcurrentVoteException;
 use Framadate\Form;
 use Framadate\FramaDB;
 use Framadate\Repositories\RepositoryFactory;
@@ -82,9 +83,22 @@ class PollService {
         return $slots;
     }
 
+    /**
+     * @param $poll_id
+     * @param $vote_id
+     * @param $name
+     * @param $choices
+     * @param $slots_hash
+     * @return bool
+     * @throws ConcurrentEditionException
+     * @throws ConcurrentVoteException
+     */
     public function updateVote($poll_id, $vote_id, $name, $choices, $slots_hash) {
         $poll = $this->findById($poll_id);
 
+        // Check that no-one voted in the meantime and it conflicts the maximum votes constraint
+        $this->checkMaxVotes($choices, $poll, $poll_id);
+
         // Check if slots are still the same
         $this->checkThatSlotsDidntChanged($poll, $slots_hash);
 
@@ -93,9 +107,22 @@ class PollService {
         return $this->voteRepository->update($poll_id, $vote_id, $name, $choices);
     }
 
+    /**
+     * @param $poll_id
+     * @param $name
+     * @param $choices
+     * @param $slots_hash
+     * @return \stdClass
+     * @throws AlreadyExistsException
+     * @throws ConcurrentEditionException
+     * @throws ConcurrentVoteException
+     */
     function addVote($poll_id, $name, $choices, $slots_hash) {
         $poll = $this->findById($poll_id);
 
+        // Check that no-one voted in the meantime and it conflicts the maximum votes constraint
+        $this->checkMaxVotes($choices, $poll, $poll_id);
+
         // Check if slots are still the same
         $this->checkThatSlotsDidntChanged($poll, $slots_hash);
 
@@ -252,4 +279,22 @@ class PollService {
             throw new ConcurrentEditionException();
         }
     }
+
+    /**
+     * This method checks if the votes doesn't conflicts the maximum votes constraint
+     *
+     * @param $user_choice
+     * @param \stdClass $poll
+     * @param string $poll_id
+     * @throws ConcurrentVoteException
+     */
+    private function checkMaxVotes($user_choice, $poll, $poll_id) {
+        $best_choices = $this->computeBestChoices($this->allVotesByPollId($poll_id));
+        foreach ($best_choices['y'] as $i => $nb_choice) {
+            // if for this option we have reached maximum value and user wants to add itself too
+            if ($nb_choice >= $poll->ValueMax && $user_choice[$i] === "2") {
+                throw new ConcurrentVoteException();
+            }
+        }
+    }
 }

locale/br.json

@@ -395,6 +395,7 @@
         "Adding vote failed": "C'hwitadenn war ouzhpennadenn ar vouezh",
         "You already voted": "Mouezhzt ho peus endeo",
         "Poll has been updated before you vote": "Hizivaet eo bet ar sontadeg a-raok ho mouezh",
+        "Your vote wasn't counted, because someone voted in the meantime and it conflicted with your choices and the poll conditions. Please retry.": "Your vote wasn't counted, because someone voted in the meantime and it conflicted with your choices and the poll conditions. Please retry.",
         "Comment failed": "C'hiwtadenn war an evezhiadenn",
         "You can't create a poll with hidden results with the following edition option:": "N'hallit ket krouiñ ur sontadeg gant respontoù kuzhet gant an dibarzhioù embann da heul:",
         "Failed to delete column": "C'hwitadenn war zilemel ar bann",

locale/de.json

@@ -396,6 +396,7 @@
         "Adding vote failed": "Stimmabgabe fehlgeschlagen",
         "You already voted": "Sie haben bereits abgestimmt",
         "Poll has been updated before you vote": "Die Abstimmung wurde vor Ihrer Stimmabgabe aktualisiert",
+        "Your vote wasn't counted, because someone voted in the meantime and it conflicted with your choices and the poll conditions. Please retry.": "Your vote wasn't counted, because someone voted in the meantime and it conflicted with your choices and the poll conditions. Please retry.",
         "Comment failed": "Abgabe des Kommentars gescheitert",
         "You can't create a poll with hidden results with the following edition option:": "Sie können mit der folgenden Editier-Option keine Umfrage mit versteckten Ergebnissen erzeugen:",
         "Failed to delete column": "Löschen der Spalte fehlgeschlagen",

locale/en.json

@@ -399,6 +399,7 @@
         "Adding vote failed": "Adding vote failed",
         "You already voted": "You already voted",
         "Poll has been updated before you vote": "Poll has been updated before you vote",
+        "Your vote wasn't counted, because someone voted in the meantime and it conflicted with your choices and the poll conditions. Please retry.": "Your vote wasn't counted, because someone voted in the meantime and it conflicted with your choices and the poll conditions. Please retry.",
         "Comment failed": "Comment failed",
         "You can't create a poll with hidden results with the following edition option:": "You can't create a poll with hidden results with the following option: ",
         "Failed to delete column": "Failed to delete column",

locale/es.json

@@ -396,6 +396,7 @@
         "Adding vote failed": "Error al crear el voto",
         "You already voted": "Usted ya votó",
         "Poll has been updated before you vote": "La encuesta fue actualizada antes de su voto",
+        "Your vote wasn't counted, because someone voted in the meantime and it conflicted with your choices and the poll conditions. Please retry.": "Your vote wasn't counted, because someone voted in the meantime and it conflicted with your choices and the poll conditions. Please retry.",
         "Comment failed": "Error al crear el comentario",
         "You can't create a poll with hidden results with the following edition option:": "No puede crear una encuesta con resultados no visibles con los siguientes opciones de edición",
         "Failed to delete column": "Error al eliminar la columna",

locale/fr.json

@@ -399,6 +399,7 @@
         "Adding vote failed": "Échec de l'ajout d'un vote",
         "You already voted": "Vous avez déjà voté",
         "Poll has been updated before you vote": "Le sondage a été mis à jour avant votre vote",
+        "Your vote wasn't counted, because someone voted in the meantime and it conflicted with your choices and the poll conditions. Please retry.": "Votre vote n'a pas été pris en compte, car quelqu'un a voté entre temps et cela entre en conflit avec vos choix et les conditions du sondage. Merci de réessayer.",
         "Comment failed": "Échec du commentaire",
         "You can't create a poll with hidden results with the following edition option:": "Vous ne pouvez pas créer de sondage avec résulats cachés avec les options d'édition suivantes : ",
         "Failed to delete column": "Échec de la suppression de colonne",

locale/it.json

@@ -396,6 +396,7 @@
         "Adding vote failed": "Aggiunta del voto fallito",
         "You already voted": "IT_Vous avez déjà voté",
         "Poll has been updated before you vote": "IT_Le sondage a été mis à jour avant votre vote",
+        "Your vote wasn't counted, because someone voted in the meantime and it conflicted with your choices and the poll conditions. Please retry.": "Your vote wasn't counted, because someone voted in the meantime and it conflicted with your choices and the poll conditions. Please retry.",
         "Comment failed": "Commento fallito",
         "You can't create a poll with hidden results with the following edition option:": "Non potete creare un sondaggio con i risultati nascosti con queste opzioni: ",
         "Failed to delete column": "Impossibile eliminare la colonna",

locale/nl.json

@@ -396,6 +396,7 @@
         "Adding vote failed": "Toevoegen stem gefaald",
         "You already voted": "Je hebt al gestemd",
         "Poll has been updated before you vote": "De poll is gewijzigd voordat je stemde",
+        "Your vote wasn't counted, because someone voted in the meantime and it conflicted with your choices and the poll conditions. Please retry.": "Your vote wasn't counted, because someone voted in the meantime and it conflicted with your choices and the poll conditions. Please retry.",
         "Comment failed": "Opmerking mislukt",
         "You can't create a poll with hidden results with the following edition option:": "Je kan geen poll met verborgen resultaten maken met de volgende optie: ",
         "Failed to delete column": "Kolom verwijderen mislukt",

locale/oc.json

@@ -396,6 +396,7 @@
         "Adding vote failed": "Fracàs de l’apondon d’un vòte",
         "You already voted": "Avètz ja votat",
         "Poll has been updated before you vote": "Lo sondatge es estat mes a jorn abans vòstre vòte",
+        "Your vote wasn't counted, because someone voted in the meantime and it conflicted with your choices and the poll conditions. Please retry.": "Your vote wasn't counted, because someone voted in the meantime and it conflicted with your choices and the poll conditions. Please retry.",
         "Comment failed": "Fracàs del comentari",
         "You can't create a poll with hidden results with the following edition option:": "Podètz pas crear de sondatges amb de resultats amagats amb las opcions d’edicion seguentas : ",
         "Failed to delete column": "Fracàs de la supression de colomna",
@@ -428,4 +429,4 @@
         "Check again": "Tornar verificar",
         "Continue the installation": "Contunhar l’installacion"
     }
-}
+}

studs.php

@@ -19,6 +19,7 @@
 use Framadate\Editable;
 use Framadate\Exception\AlreadyExistsException;
 use Framadate\Exception\ConcurrentEditionException;
+use Framadate\Exception\ConcurrentVoteException;
 use Framadate\Message;
 use Framadate\Security\Token;
 use Framadate\Services\InputService;
@@ -146,6 +147,8 @@ if ($accessGranted) {
                 }
             } catch (ConcurrentEditionException $cee) {
                 $message = new Message('danger', __('Error', 'Poll has been updated before you vote'));
+            } catch (ConcurrentVoteException $cve) {
+                $message = new Message('danger', __('Error', "Your vote wasn't counted, because someone voted in the meantime and it conflicted with your choices and the poll conditions. Please retry."));
             }
         }
     } elseif (isset($_POST['save'])) { // Add a new vote
@@ -179,6 +182,8 @@ if ($accessGranted) {
                 $message = new Message('danger', __('Error', 'You already voted'));
             } catch (ConcurrentEditionException $cee) {
                 $message = new Message('danger', __('Error', 'Poll has been updated before you vote'));
+            } catch (ConcurrentVoteException $cve) {
+                $message = new Message('danger', __('Error', "Your vote wasn't counted, because someone voted in the meantime and it conflicted with your choices and the poll conditions. Please retry."));
             }
         }
     }