[#510] Add Holiday Management view

At the moment this view is read-only and will only display the booked
holidays. 

Merge pull request #512 from anarute/holiday-management

Author: jaragunde

.gitignore

@@ -21,3 +21,6 @@ config/config.defaults
 
 # Composer dependencies
 vendor
+
+# do not ignore vue.js and v-calendar files
+!web/vuejs/*.min.js

Makefile

@@ -39,8 +39,8 @@ help:
 	rm footer
 
 minify:
-	for i in `find -name *.min.js`; do rm $$i; done
-	for i in `find -name *.js` ; do \
+	for i in `find -name "*.min.js" -not -path "*web/vuejs/*"`; do rm $$i; done
+	for i in `find -name "*.js" -not -path "*web/vuejs/*"` ; do \
 	  #extract file name to be used in the uglify output \
 	  FILE=`basename -s .js $$i`; \
 	  DIR=`dirname $$i`; \
@@ -49,7 +49,7 @@ minify:
 	      --source-map "filename=$${FILE}.min.js.map" -c -m; \
 	  cd -; \
 	  done
-	for i in `find web -name *.php`; do \
+	for i in `find web -name "*.php" -not -path "*web/holidayManagement.php"`; do \
 	  #revert any previous minification changes \
 	  sed 's/<script src="\(.*\).min.js">/<script src="\1.js">/' $$i > tmp; \
 	  #modify script tags to link the minified file \

config/permissions.php

@@ -43,6 +43,9 @@
         '/services/createTasksService.php', '/services/deleteTasksService.php',
         '/services/updateTasksService.php',
         '/services/getTasksFiltered.php', '/userTasksReport.php',
+        //holidays management
+        '/services/getHolidays.php',
+        '/holidayManagement.php',
         //templates
         '/services/createTemplatesService.php', '/services/getUserTemplatesService.php',
         '/services/deleteTemplatesService.php',
@@ -59,7 +62,7 @@
         '/services/createTaskSectionsService.php', '/services/deleteTaskSectionsService.php',
         //reports
         '/projectDetailsReport.php', '/viewUserDetails.php', '/projectDetails.php', '/viewWorkingHoursResultsReport.php',
-        '/services/getExtraHoursReportService.php','/services/getPendingHolidayHoursService.php',
+        '/services/getExtraHoursReportService.php', '/services/getPendingHolidayHoursService.php',
         '/services/getProjectTtypeReportService.php', '/services/getProjectUserCustomerReportJsonService.php',
         '/services/getProjectUserCustomerReportService.php', '/services/getProjectUserStoryReportService.php',
         '/services/getUserProjectCustomerReportJsonService.php', '/services/getUsersProjectsReportService.php',
@@ -70,8 +73,8 @@
         '/services/getAllCitiesService.php', '/services/getProjectService.php', '/services/getProjectsService.php',
         '/services/getAllSectorsService.php', '/services/getAllAreasService.php',
         '/services/getAllExtraHourVOsService.php', '/services/getAllCitiesService.php',
-	    '/services/getUserGoalsService.php', '/services/createUserGoalsService.php', '/services/updateUserGoalsService.php',
-	    '/services/deleteUserGoalsService.php',
+        '/services/getUserGoalsService.php', '/services/createUserGoalsService.php', '/services/updateUserGoalsService.php',
+        '/services/deleteUserGoalsService.php',
         //user management screen (read only)
         '/viewUsers.php',
         '/services/getUserHourCostHistoriesService.php', '/services/getUserAreaHistoriesService.php',
@@ -122,7 +125,8 @@
         //system settings
         '/settings.php',
         //API test
-        '/APITest.php')
+        '/APITest.php'
+    )
 );
 
 /** Extra permissions array

model/dao/ProjectDAO/PostgreSQLProjectDAO.php

@@ -568,6 +568,18 @@ public function getAllCustom($active = False, $orderField = 'id') {
         return $this->customExecute($sql);
     }
 
+    public function getByDescription(string $desc): ?int
+    {
+        $sql = "SELECT * FROM project WHERE description='" . $desc . "'";
+
+        $res = pg_query($this->connect, $sql);
+        if ($res == NULL) throw new SQLQueryErrorException(pg_last_error());
+
+        $resultAux = @pg_fetch_array($res);
+
+        return $resultAux['id'] ?? NULL;
+    }
+
     /** Project partial updater for PostgreSQL.
      *
      * This function updates only some fields of the data of a Project by its {@link ProjectVO}, reading

model/dao/ProjectDAO/ProjectDAO.php

@@ -258,6 +258,8 @@ public abstract function getByCustomerUserLogin($customerId = NULL, $userLogin =
      */
     public abstract function getAllCustom($active = False, $orderField = 'id');
 
+    public abstract function getByDescription(string $description): ?int;
+
     /** Project partial updater.
      *
      * This function updates only some fields of the data of a Project by its {@link ProjectVO}, reading

model/dao/TaskDAO/PostgreSQLTaskDAO.php

@@ -655,6 +655,35 @@ public function getVacations(UserVO $userVO, DateTime $initDate = NULL, DateTime
 
     }
 
+    public function getVacationsDates(UserVO $userVO, int $projectId = NULL, DateTime $initDate = NULL, DateTime $endDate = NULL): array
+    {
+        if (is_null($projectId)) {
+            return [];
+        }
+
+        $sql = "SELECT _date FROM task WHERE projectid=" . $projectId . " AND usrid=" . $userVO->getId();
+
+        if (!is_null($initDate)) {
+            $sql .= " AND _date >=" . DBPostgres::formatDate($initDate);
+            if (!is_null($endDate))
+                $sql .= " AND _date <=" . DBPostgres::formatDate($endDate);
+        }
+
+        $sql .= " ORDER BY _date";
+
+        $res = pg_query($this->connect, $sql);
+        if ($res == NULL) throw new SQLQueryErrorException(pg_last_error());
+
+        $result = array();
+        for ($i = 0; $i < pg_num_rows($res); $i++) {
+            $result[] = @pg_fetch_array($res)['_date'];
+        }
+
+        if (empty($result))
+            return [];
+        return $result;
+    }
+
     /** Task partial updater for PostgreSQL.
      *
      * This function updates only some fields of the data of a Task using a

model/dao/TaskDAO/TaskDAO.php

@@ -283,6 +283,8 @@ public abstract function getProjectUserWeeklyWorkingHours(ProjectVO $project, Da
      */
     public abstract function getVacations(UserVO $userVO, DateTime $initDate = NULL, DateTime $endDate = NULL);
 
+    public abstract function getVacationsDates(UserVO $userVO, int $projectId = NULL, DateTime $initDate = NULL, DateTime $endDate = NULL): array;
+
     /** Task partial updater for PostgreSQL.
      *
      * This function updates only some fields of the data of a Task using a

model/facade/ProjectsFacade.php

@@ -264,6 +264,14 @@ static function GetProjectUsers($projectId) {
 
     }
 
+    static function GetProjectByDescription(string $description) {
+
+        $action = new GetProjectByDescriptionAction($description);
+
+        return $action->execute();
+
+    }
+
     /** Update Project Function
      *
      *  This function is used for updating a Project.

model/facade/UsersFacade.php

@@ -1,6 +1,6 @@
 <?php
 /*
- * Copyright (C) 2009 Igalia, S.L. <[email protected]>
+ * Copyright (C) 2009-2021 Igalia, S.L. <[email protected]>
  *
  * This file is part of PhpReport.
  *
@@ -38,6 +38,7 @@
 include_once(PHPREPORT_ROOT . '/model/facade/action/UpdateUserAction.php');
 include_once(PHPREPORT_ROOT . '/model/facade/action/ExtraHoursReportAction.php');
 include_once(PHPREPORT_ROOT . '/model/facade/action/GetPendingHolidayHoursAction.php');
+include_once(PHPREPORT_ROOT . '/model/facade/action/GetScheduledHolidaysAction.php');
 include_once(PHPREPORT_ROOT . '/model/facade/action/CreateCustomEventAction.php');
 include_once(PHPREPORT_ROOT . '/model/facade/action/DeleteCustomEventAction.php');
 include_once(PHPREPORT_ROOT . '/model/facade/action/UpdateCustomEventAction.php');
@@ -260,6 +261,15 @@ static function GetPendingHolidayHours(DateTime $init, DateTime $end, UserVO $us
 
     }
 
+
+    static function GetScheduledHolidays(DateTime $init, DateTime $end, UserVO $user = NULL) {
+
+        $action = new GetScheduledHolidaysAction($init, $end, $user);
+
+        return $action->execute();
+
+    }
+
     /** User retriever by Project Iteration Function
      *
      * This function retrieves the Users assigned to the same Area as a Project Iteration with id <var>$iterationid</var> today.

model/facade/action/GetProjectByDescriptionAction.php

@@ -0,0 +1,40 @@
+<?php
+/*
+ * Copyright (C) 2021 Igalia, S.L. <[email protected]>
+ *
+ * This file is part of PhpReport.
+ *
+ * PhpReport 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.
+ *
+ * PhpReport 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 PhpReport.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+
+include_once(PHPREPORT_ROOT . '/model/facade/action/Action.php');
+include_once(PHPREPORT_ROOT . '/model/dao/DAOFactory.php');
+
+class GetProjectByDescriptionAction extends Action
+{
+
+    public function __construct(string $description)
+    {
+        $this->description = $description;
+        $this->preActionParameter = "GET_PROJECT_BY_DESCRIPTION_PREACTION";
+        $this->postActionParameter = "GET_PROJECTS_BY_DESCRIPTION_POSTACTION";
+    }
+
+    protected function doExecute()
+    {
+        $dao = DAOFactory::getProjectDAO();
+        return $dao->getByDescription($this->description);
+    }
+}

model/facade/action/GetScheduledHolidaysAction.php

@@ -0,0 +1,70 @@
+<?php
+/*
+ * Copyright (C) 2021 Igalia, S.L. <[email protected]>
+ *
+ * This file is part of PhpReport.
+ *
+ * PhpReport 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.
+ *
+ * PhpReport 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 PhpReport.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+include_once(PHPREPORT_ROOT . '/model/facade/action/Action.php');
+include_once(PHPREPORT_ROOT . '/model/dao/DAOFactory.php');
+include_once(PHPREPORT_ROOT . '/model/vo/UserVO.php');
+include_once(PHPREPORT_ROOT . '/util/ConfigurationParametersManager.php');
+
+
+class GetScheduledHolidaysAction extends Action
+{
+
+    private UserVO $user;
+    private DateTime $init;
+    private DateTime $end;
+
+    public function __construct(DateTime $init, DateTime $end, UserVO $user = NULL)
+    {
+        $this->init = $init;
+        $this->end = $end;
+        $this->user = $user;
+        $this->preActionParameter = "GET_SCHEDULED_HOLIDAYS_PREACTION";
+        $this->postActionParameter = "GET_SCHEDULED_HOLIDAYS_POSTACTION";
+    }
+
+    protected function doExecute(): array
+    {
+
+        $taskDao = DAOFactory::getTaskDAO();
+        $userDao = DAOFactory::getUserDAO();
+        $projectDao = DAOFactory::getProjectDAO();
+
+        if (is_null($this->user)) {
+            return [];
+        }
+
+        // The User can be identified by either the id or the login
+        if (is_null($this->user->getLogin())) {
+            if (!is_null($this->user->getId()))
+                $this->user = $userDao->getById($this->user->getId());
+        } else
+            if (is_null($this->user->getId()))
+            $this->user = $userDao->getByUserLogin($this->user->getLogin());
+
+        $projectId = $projectDao->getByDescription(ConfigurationParametersManager::getParameter('VACATIONS_PROJECT'));
+        $reportInit = $this->init;
+        $reportEnd = $this->end;
+
+        $vacations = $taskDao->getVacationsDates($this->user, $projectId, $reportInit, $reportEnd);
+
+        return $vacations;
+    }
+}