[#173] Report several kinds of errors on task creation.

We start reporting errors on the task create operation, in the
following situations:
* Overlapping tasks detected.
* Trying to write to a date that has been locked.
* Trying to assign a task to a project that's closed.

These errors are detected prior to launching the SQL query. We haven't
addressed SQL errors yet.

Author: jaragunde

model/dao/TaskDAO/PostgreSQLTaskDAO.php

@@ -841,8 +841,7 @@ private function checkOverlappingTasks($tasks) {
      * The internal id of <var>$taskVO</var> will be set after its creation.
      *
      * @param TaskVO $taskVO the {@link TaskVO} with the data we want to insert on database.
-     * @return int the number of rows that have been affected (it should be 1).
-     * @throws {@link SQLQueryErrorException}, {@link SQLUniqueViolationException}
+     * @return OperationResult the result {@link OperationResult} with information about operation status
      */
     public function create(TaskVO $taskVO) {
         $tasks = array($taskVO);
@@ -911,13 +910,16 @@ private function createInternal(TaskVO $taskVO) {
      * Equivalent to {@see create} for arrays of tasks.
      *
      * @param array $tasks array of {@link TaskVO} objects to be created.
-     * @return int the number of rows that have been affected (it should be
-     *         equal to the size of $tasks).
-     * @throws {@link SQLQueryErrorException}
+     * @return OperationResult the result {@link OperationResult} with information about operation status
      */
     public function batchCreate($tasks) {
+        $result = new OperationResult(false);
         if (!$this->checkOverlappingWithDBTasks($tasks)) {
-            return 0;
+            $result->setErrorNumber(10);
+            $result->setMessage("Task creation failed:\nDetected overlapping times.");
+            $result->setIsSuccessful(false);
+            $result->setResponseCode(500);
+            return $result;
         }
 
         $affectedRows = 0;
@@ -926,7 +928,11 @@ public function batchCreate($tasks) {
             $affectedRows += $this->createInternal($task);
         }
 
-        return $affectedRows;
+        if ($affectedRows == count($tasks)) {
+            $result->setIsSuccessful(true);
+            $result->setResponseCode(201);
+        }
+        return $result;
     }
 
     /** Task deleter for PostgreSQL.

model/dao/TaskDAO/TaskDAO.php

@@ -245,8 +245,7 @@ public abstract function batchPartialUpdate($tasks);
      * The internal id of <var>$taskVO</var> will be set after its creation.
      *
      * @param TaskVO $taskVO the {@link TaskVO} with the data we want to insert on database.
-     * @return int the number of rows that have been affected (it should be 1).
-     * @throws {@link OperationErrorException}, {@link SQLUniqueViolationException}
+     * @return OperationResult the result {@link OperationResult} with information about operation status
      */
     public abstract function create(TaskVO $taskVO);
 
@@ -255,9 +254,7 @@ public abstract function create(TaskVO $taskVO);
      * Equivalent to {@see create} for arrays of tasks.
      *
      * @param array $tasks array of {@link TaskVO} objects to be created.
-     * @return int the number of rows that have been affected (it should be
-     *         equal to the size of $tasks).
-     * @throws {@link SQLQueryErrorException}
+     * @return OperationResult the result {@link OperationResult} with information about operation status
      */
     public abstract function batchCreate($tasks);
 

model/facade/TasksFacade.php

@@ -71,8 +71,7 @@ abstract class TasksFacade {
      *
      * @param TaskVO $task the Task value object we want to create. It will be
      * updated with the autogenerated task ID field in case of success.
-     * @return int it just indicates if there was any error (<i>-1</i>) or not (<i>0</i>).
-     * @throws {@link SQLQueryErrorException}, {@link SQLUniqueViolationException}
+     * @return OperationResult the result {@link OperationResult} with information about operation status
      */
     static function CreateReport(TaskVO $task) {
         return TasksFacade::CreateReports(array($task));
@@ -86,8 +85,7 @@ static function CreateReport(TaskVO $task) {
      * @param array $tasks the Task value objects we want to create. The objects
      * contained in the array will be updated with the autogenerated task ID
      * field in case of success.
-     * @return int it just indicates if there was any error (<i>-1</i>) or not (<i>0</i>).
-     * @throws {@link SQLQueryErrorException}, {@link SQLUniqueViolationException}
+     * @return OperationResult the result {@link OperationResult} with information about operation status
      */
     static function CreateReports($tasks) {
         $action = new CreateTasksAction($tasks);

model/facade/action/CreateTasksAction.php

@@ -68,40 +68,39 @@ public function __construct($tasks) {
      *
      * Runs the action itself.
      *
-     * @return int it just indicates if there was any error (<i>-1</i>)
-     *         or not (<i>0</i>).
+     * @return OperationResult the result {@link OperationResult} with information about operation status
      */
     protected function doExecute() {
         $configDao = DAOFactory::getConfigDAO();
         $taskDao = DAOFactory::getTaskDAO();
         $projectDAO = DAOFactory::getProjectDAO();
         $discardedTasks = array();
+        $discardedReason = "";
 
         //first check permission on task write
         foreach ($this->tasks as $i => $task) {
             if (!$configDao->isWriteAllowedForDate($task->getDate())) {
                 $discardedTasks[] = $task;
+                $discardedReason .= "Not allowed to write to date.\n";
                 unset($this->tasks[$i]);
                 continue;
             }
             $projectVO = $projectDAO->getById($task->getProjectId());
             if (!$projectVO || !$projectVO->getActivation()) {
                 $discardedTasks[] = $task;
+                $discardedReason .= "Not allowed to write to project.\n";
                 unset($this->tasks[$i]);
             }
         }
 
-        if ($taskDao->batchCreate($this->tasks) < count($this->tasks)) {
-            return -1;
-        }
+        $result = $taskDao->batchCreate($this->tasks);
 
         //TODO: do something meaningful with the list of discarded tasks
-        if (empty($discardedTasks)) {
-            return 0;
-        }
-        else {
-            return -1;
+        if (!empty($discardedTasks)) {
+            $result = new OperationResult(false);
+            $result->setMessage("Some tasks were discarded:\n" . $discardedReason);
         }
+        return $result;
     }
 
 }

web/js/tasks.js

@@ -932,9 +932,12 @@ var tasksStore = new Ext.ux.TasksStore({
             }
             tasksStore.error = false;
         },
-        'exception': function () {
+        'exception': function(proxy, type, action, eOpts, res) {
             Ext.onReady(function () { // this may run in case of error in the initial load
-                App.setAlert(false, "Some Error Occurred While Saving The Changes (please check you haven't clipped working hours)");
+                let parser = new DOMParser();
+                let errorDoc = parser.parseFromString(res.responseText, "text/xml");
+                let errorMessage = errorDoc.getElementsByTagName("error")[0].childNodes[0].nodeValue;
+                App.setAlert(false, errorMessage);
                 tasksStore.error = true;
             });
         },

web/services/createTasksService.php

@@ -226,11 +226,14 @@
 
         } while ($parser->read());
 
-
-        if (count($createTasks) >= 1)
-            if (TasksFacade::CreateReports($createTasks) == -1)
-                $string = "<return service='createTasks'><success>false</success><error id='1'>There was some error while creating the tasks</error></return>";
-
+        $result = TasksFacade::CreateReports($createTasks);
+        if (!$result->getIsSuccessful()) {
+            //if multiple failures, let's just return a 500
+            http_response_code(500);
+            $string = "<return service='deleteProjects'><errors>";
+            $string .= "<error id='" . $result->getErrorNumber() . "'>" . $result->getMessage() . "</error>";
+            $string .= "</errors></return>";
+        }
 
         if (!isset($string))
         {