add "duration + fixed start time" tracking mode (#859)

src/Timesheet/TrackingMode/AbstractTrackingMode.php

@@ -0,0 +1,101 @@
+<?php
+
+/*
+ * This file is part of the Kimai time-tracking app.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Timesheet\TrackingMode;
+
+use App\Configuration\TimesheetConfiguration;
+use App\Entity\Timesheet;
+use App\Timesheet\UserDateTimeFactory;
+use Symfony\Component\HttpFoundation\Request;
+
+abstract class AbstractTrackingMode implements TrackingModeInterface
+{
+    /**
+     * @var UserDateTimeFactory
+     */
+    protected $dateTime;
+    /**
+     * @var TimesheetConfiguration
+     */
+    protected $configuration;
+
+    public function __construct(UserDateTimeFactory $dateTime, TimesheetConfiguration $configuration)
+    {
+        $this->dateTime = $dateTime;
+        $this->configuration = $configuration;
+    }
+
+    public function create(Timesheet $timesheet, Request $request): void
+    {
+        $this->setBeginEndFromRequest($timesheet, $request);
+        $this->setFromToFromRequest($timesheet, $request);
+    }
+
+    protected function setBeginEndFromRequest(Timesheet $entry, Request $request)
+    {
+        $start = $request->get('begin');
+        if (null === $start) {
+            return;
+        }
+
+        $start = $this->dateTime->createDateTimeFromFormat('Y-m-d', $start);
+        if (false === $start) {
+            return;
+        }
+
+        $entry->setBegin($start);
+
+        // only check for an end date if a begin date was given
+        $end = $request->get('end');
+        if (null === $end) {
+            return;
+        }
+
+        $end = $this->dateTime->createDateTimeFromFormat('Y-m-d', $end);
+        if (false === $end) {
+            return;
+        }
+
+        $start->setTime(10, 0, 0);
+        $end->setTime(18, 0, 0);
+
+        $entry->setEnd($end);
+        $entry->setDuration($end->getTimestamp() - $start->getTimestamp());
+    }
+
+    protected function setFromToFromRequest(Timesheet $entry, Request $request)
+    {
+        $from = $request->get('from');
+        if (null === $from) {
+            return;
+        }
+
+        try {
+            $from = $this->dateTime->createDateTime($from);
+        } catch (\Exception $ex) {
+            return;
+        }
+
+        $entry->setBegin($from);
+
+        $to = $request->get('to');
+        if (null === $to) {
+            return;
+        }
+
+        try {
+            $to = $this->dateTime->createDateTime($to);
+        } catch (\Exception $ex) {
+            return;
+        }
+
+        $entry->setEnd($to);
+        $entry->setDuration($to->getTimestamp() - $from->getTimestamp());
+    }
+}

src/Timesheet/TrackingMode/DefaultMode.php

@@ -0,0 +1,43 @@
+<?php
+
+/*
+ * This file is part of the Kimai time-tracking app.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Timesheet\TrackingMode;
+
+class DefaultMode extends AbstractTrackingMode
+{
+    public function canEditBegin(): bool
+    {
+        return true;
+    }
+
+    public function canEditEnd(): bool
+    {
+        return true;
+    }
+
+    public function canEditDuration(): bool
+    {
+        return false;
+    }
+
+    public function canUpdateTimesWithAPI(): bool
+    {
+        return true;
+    }
+
+    public function getId(): string
+    {
+        return 'default';
+    }
+
+    public function canSeeBeginAndEndTimes(): bool
+    {
+        return true;
+    }
+}

src/Timesheet/TrackingMode/DurationFixedStartMode.php

@@ -0,0 +1,72 @@
+<?php
+
+/*
+ * This file is part of the Kimai time-tracking app.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Timesheet\TrackingMode;
+
+use App\Configuration\TimesheetConfiguration;
+use App\Entity\Timesheet;
+use App\Timesheet\UserDateTimeFactory;
+use Symfony\Component\HttpFoundation\Request;
+
+class DurationFixedStartMode implements TrackingModeInterface
+{
+    /**
+     * @var UserDateTimeFactory
+     */
+    protected $dateTime;
+    /**
+     * @var TimesheetConfiguration
+     */
+    protected $configuration;
+
+    public function __construct(UserDateTimeFactory $dateTime, TimesheetConfiguration $configuration)
+    {
+        $this->dateTime = $dateTime;
+        $this->configuration = $configuration;
+    }
+
+    public function canEditBegin(): bool
+    {
+        return false;
+    }
+
+    public function canEditEnd(): bool
+    {
+        return false;
+    }
+
+    public function canEditDuration(): bool
+    {
+        return true;
+    }
+
+    public function canUpdateTimesWithAPI(): bool
+    {
+        return false;
+    }
+
+    public function create(Timesheet $timesheet, Request $request): void
+    {
+        if (null === $timesheet->getBegin()) {
+            $timesheet->setBegin($this->dateTime->createDateTime());
+        }
+
+        $timesheet->getBegin()->modify($this->configuration->getDefaultBeginTime());
+    }
+
+    public function getId(): string
+    {
+        return 'duration_fixed_start';
+    }
+
+    public function canSeeBeginAndEndTimes(): bool
+    {
+        return false;
+    }
+}

src/Timesheet/TrackingMode/DurationOnlyMode.php

@@ -0,0 +1,43 @@
+<?php
+
+/*
+ * This file is part of the Kimai time-tracking app.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Timesheet\TrackingMode;
+
+class DurationOnlyMode extends AbstractTrackingMode
+{
+    public function canEditBegin(): bool
+    {
+        return true;
+    }
+
+    public function canEditEnd(): bool
+    {
+        return false;
+    }
+
+    public function canEditDuration(): bool
+    {
+        return true;
+    }
+
+    public function canUpdateTimesWithAPI(): bool
+    {
+        return true;
+    }
+
+    public function getId(): string
+    {
+        return 'duration_only';
+    }
+
+    public function canSeeBeginAndEndTimes(): bool
+    {
+        return false;
+    }
+}

src/Timesheet/TrackingMode/PunchInOutMode.php

@@ -0,0 +1,50 @@
+<?php
+
+/*
+ * This file is part of the Kimai time-tracking app.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Timesheet\TrackingMode;
+
+use App\Entity\Timesheet;
+use Symfony\Component\HttpFoundation\Request;
+
+class PunchInOutMode implements TrackingModeInterface
+{
+    public function canEditBegin(): bool
+    {
+        return false;
+    }
+
+    public function canEditEnd(): bool
+    {
+        return false;
+    }
+
+    public function canEditDuration(): bool
+    {
+        return false;
+    }
+
+    public function canUpdateTimesWithAPI(): bool
+    {
+        return false;
+    }
+
+    public function create(Timesheet $timesheet, Request $request): void
+    {
+    }
+
+    public function getId(): string
+    {
+        return 'punch';
+    }
+
+    public function canSeeBeginAndEndTimes(): bool
+    {
+        return true;
+    }
+}

src/Timesheet/TrackingMode/TrackingModeInterface.php

@@ -0,0 +1,72 @@
+<?php
+
+/*
+ * This file is part of the Kimai time-tracking app.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Timesheet\TrackingMode;
+
+use App\Entity\Timesheet;
+use Symfony\Component\HttpFoundation\Request;
+
+/**
+ * A tracking-mode defines the behaviour of the user timesheet.
+ * It is NOT used for the timesheet administration.
+ */
+interface TrackingModeInterface
+{
+    /**
+     * Set default values on this new timesheet entity,
+     * before form data is rendered/processed.
+     *
+     * @param Timesheet $timesheet
+     * @param Request $request
+     */
+    public function create(Timesheet $timesheet, Request $request): void;
+
+    /**
+     * Whether the user can edit the begin datetime.
+     *
+     * @return bool
+     */
+    public function canEditBegin(): bool;
+
+    /**
+     * Whether the user can edit the end datetime.
+     *
+     * @return bool
+     */
+    public function canEditEnd(): bool;
+
+    /**
+     * Whether the user can edit the duration.
+     * If this is true, the result of canEditEnd() will be ignored.
+     *
+     * @return bool
+     */
+    public function canEditDuration(): bool;
+
+    /**
+     * Whether the API can be used to manipulate the start and end times.
+     *
+     * @return bool
+     */
+    public function canUpdateTimesWithAPI(): bool;
+
+    /**
+     * Whether the real begin and end times are shown in the user timesheet.
+     *
+     * @return bool
+     */
+    public function canSeeBeginAndEndTimes(): bool;
+
+    /**
+     * Returns a unique identifier for this tracking mode.
+     *
+     * @return string
+     */
+    public function getId(): string;
+}

src/Timesheet/TrackingModeService.php

@@ -0,0 +1,62 @@
+<?php
+
+/*
+ * This file is part of the Kimai time-tracking app.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Timesheet;
+
+use App\Configuration\TimesheetConfiguration;
+use App\Timesheet\TrackingMode\DefaultMode;
+use App\Timesheet\TrackingMode\DurationFixedStartMode;
+use App\Timesheet\TrackingMode\DurationOnlyMode;
+use App\Timesheet\TrackingMode\PunchInOutMode;
+use App\Timesheet\TrackingMode\TrackingModeInterface;
+use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
+
+class TrackingModeService
+{
+    /**
+     * @var UserDateTimeFactory
+     */
+    protected $dateTime;
+    /**
+     * @var TimesheetConfiguration
+     */
+    protected $configuration;
+
+    public function __construct(UserDateTimeFactory $dateTime, TimesheetConfiguration $configuration)
+    {
+        $this->dateTime = $dateTime;
+        $this->configuration = $configuration;
+    }
+
+    /**
+     * @return TrackingModeInterface[]
+     */
+    public function getModes(): iterable
+    {
+        return [
+            new DefaultMode($this->dateTime, $this->configuration),
+            new PunchInOutMode(),
+            new DurationOnlyMode($this->dateTime, $this->configuration),
+            new DurationFixedStartMode($this->dateTime, $this->configuration),
+        ];
+    }
+
+    public function getActiveMode(): TrackingModeInterface
+    {
+        $trackingMode = $this->configuration->getTrackingMode();
+
+        foreach ($this->getModes() as $mode) {
+            if ($mode->getId() === $trackingMode) {
+                return $mode;
+            }
+        }
+
+        throw new ServiceNotFoundException($trackingMode);
+    }
+}

src/Timesheet/UserDateTimeFactory.php

@@ -19,9 +19,6 @@ class UserDateTimeFactory
      */
     protected $timezone;
 
-    /**
-     * @param CurrentUser $user
-     */
     public function __construct(CurrentUser $user)
     {
         $timezone = date_default_timezone_get();
@@ -34,18 +31,12 @@ class UserDateTimeFactory
         $this->timezone = new \DateTimeZone($timezone);
     }
 
-    /**
-     * @return \DateTimeZone
-     */
-    public function getTimezone()
+    public function getTimezone(): \DateTimeZone
     {
         return $this->timezone;
     }
 
-    /**
-     * @return \DateTime
-     */
-    public function getStartOfMonth()
+    public function getStartOfMonth(): \DateTime
     {
         $date = $this->createDateTime('first day of this month');
         $date->setTime(0, 0, 0);
@@ -53,10 +44,7 @@ class UserDateTimeFactory
         return $date;
     }
 
-    /**
-     * @return \DateTime
-     */
-    public function getEndOfMonth()
+    public function getEndOfMonth(): \DateTime
     {
         $date = $this->createDateTime('last day of this month');
         $date->setTime(23, 59, 59);
@@ -64,11 +52,7 @@ class UserDateTimeFactory
         return $date;
     }
 
-    /**
-     * @param string $datetime
-     * @return \DateTime
-     */
-    public function createDateTime(string $datetime = 'now')
+    public function createDateTime(string $datetime = 'now'): \DateTime
     {
         $date = new \DateTime($datetime, $this->timezone);