Make File creation context configurable (base change) (#39)

* Make File creation context configurable (base change)

* Added unit tests for CreationManager

* Remove hardcoded time, timezone source

Author: pawski

emission/app/config/parameters_defaults.yml

@@ -1,3 +1,4 @@
 parameters:
     google_openid_client_id: client_id
     google_openid_client_secret: client_secret
+    app.time_zone: 'UTC'

emission/src/Enginewerk/ApplicationBundle/DateTime/DateTimeReadInterface.php

@@ -0,0 +1,19 @@
+<?php
+namespace Enginewerk\ApplicationBundle\DateTime;
+
+interface DateTimeReadInterface
+{
+    /**
+     * Returns DateTime object with current time
+     *
+     * @return \DateTime
+     */
+    public function getCurrentDateTime();
+
+    /**
+     * Returns DateTimeImmutable object with current time
+     *
+     * @return \DateTimeImmutable
+     */
+    public function getCurrentDateTimeImmutable();
+}

emission/src/Enginewerk/ApplicationBundle/Resources/config/services.yml

@@ -1,4 +1,16 @@
 services:
+    enginewerk_application.service.date_time_read_service:
+        class: Enginewerk\ApplicationBundle\Service\DateTimeReadService
+        public: true
+        arguments:
+            -  '@enginewerk_application.service.data_time_zone'
+
+    enginewerk_application.service.data_time_zone:
+        class: DateTimeZone
+        public: false
+        arguments:
+            - '%app.time_zone%'
+
     enginewerk_application.logger.request_uuid_processor:
         class: Enginewerk\ApplicationBundle\Logger\RequestUuidProcessor
         public: true

emission/src/Enginewerk/ApplicationBundle/Service/DateTimeReadService.php

@@ -0,0 +1,40 @@
+<?php
+namespace Enginewerk\ApplicationBundle\Service;
+
+use Enginewerk\ApplicationBundle\DateTime\DateTimeReadInterface;
+
+final class DateTimeReadService implements DateTimeReadInterface
+{
+    /**
+     * @var \DateTimeZone
+     */
+    private $dateTimeZone;
+
+    /**
+     * @param \DateTimeZone $dateTimeZone
+     */
+    public function __construct(\DateTimeZone $dateTimeZone)
+    {
+        $this->dateTimeZone = $dateTimeZone;
+    }
+
+    /**
+     * Returns DateTimeImmutable object with current time
+     *
+     * @return \DateTimeImmutable
+     */
+    public function getCurrentDateTimeImmutable()
+    {
+        return new \DateTimeImmutable('NOW', $this->dateTimeZone);
+    }
+
+    /**
+     * Returns DateTime object with current time
+     *
+     * @return \DateTime
+     */
+    public function getCurrentDateTime()
+    {
+        return new \DateTime('NOW', $this->dateTimeZone);
+    }
+}

emission/src/Enginewerk/EmissionBundle/Entity/File.php

@@ -2,7 +2,6 @@
 namespace Enginewerk\EmissionBundle\Entity;
 
 use Doctrine\Common\Collections\ArrayCollection;
-use Enginewerk\EmissionBundle\Generator\HashGenerator;
 use Enginewerk\UserBundle\Entity\User;
 
 class File
@@ -383,23 +382,4 @@ public function getUser()
     {
         return $this->user;
     }
-
-    public function preChange()
-    {
-        $currentTime = new \DateTime();
-        $currentTime->setTimestamp(time());
-
-        if (null === $this->getFileHash()) {
-            $fileHash = sha1(uniqid(mt_rand(), true));
-            $this->fileHash = $fileHash;
-            $this->setCreatedAt($currentTime);
-            $this->setPublicIdentifier(HashGenerator::generateRandomHash(8));
-
-            $expirationTime = new \DateTime();
-            $expirationTime->setTimestamp(time() + 86600);
-            $this->setExpirationDate($expirationTime);
-        }
-
-        $this->setUpdatedAt($currentTime);
-    }
 }

emission/src/Enginewerk/EmissionBundle/EventListener/FileBlockSubscriber.php

@@ -3,10 +3,22 @@
 
 use Doctrine\Common\EventSubscriber;
 use Doctrine\ORM\Event\LifecycleEventArgs;
+use Enginewerk\ApplicationBundle\DateTime\DateTimeReadInterface;
 use Enginewerk\EmissionBundle\Entity\FileBlock;
 
 class FileBlockSubscriber implements EventSubscriber
 {
+    /** @var DateTimeReadInterface */
+    private $dateTimeReader;
+
+    /**
+     * @param DateTimeReadInterface $dateTimeReader
+     */
+    public function __construct(DateTimeReadInterface $dateTimeReader)
+    {
+        $this->dateTimeReader = $dateTimeReader;
+    }
+
     /**
      * @return string[]
      */
@@ -25,9 +37,9 @@ public function prePersist(LifecycleEventArgs $args)
         $fileBlock = $args->getEntity();
 
         if ($fileBlock instanceof FileBlock) {
-            $createdAt = new \DateTime('now');
-            $fileBlock->setUpdatedAt($createdAt);
-            $fileBlock->setCreatedAt($createdAt);
+            $currentTime = $this->dateTimeReader->getCurrentDateTime();
+            $fileBlock->setUpdatedAt($currentTime);
+            $fileBlock->setCreatedAt($currentTime);
         }
     }
 }

emission/src/Enginewerk/EmissionBundle/EventListener/FileSubscriber.php

@@ -3,10 +3,22 @@
 
 use Doctrine\Common\EventSubscriber;
 use Doctrine\ORM\Event\LifecycleEventArgs;
+use Enginewerk\ApplicationBundle\DateTime\DateTimeReadInterface;
 use Enginewerk\EmissionBundle\Entity\File as FileEntity;
 
 class FileSubscriber implements EventSubscriber
 {
+    /** @var DateTimeReadInterface */
+    private $dateTimeReader;
+
+    /**
+     * @param DateTimeReadInterface $dateTimeReader
+     */
+    public function __construct(DateTimeReadInterface $dateTimeReader)
+    {
+        $this->dateTimeReader = $dateTimeReader;
+    }
+
     /**
      * @return string[]
      */
@@ -26,7 +38,9 @@ public function prePersist(LifecycleEventArgs $args)
         $file = $args->getEntity();
 
         if ($file instanceof FileEntity) {
-            $file->preChange();
+            $currentTime = $this->dateTimeReader->getCurrentDateTime();
+            $file->setCreatedAt($currentTime);
+            $file->setUpdatedAt($currentTime);
         }
     }
 
@@ -38,7 +52,7 @@ public function preUpdate(LifecycleEventArgs $args)
         $file = $args->getEntity();
 
         if ($file instanceof FileEntity) {
-            $file->preChange();
+            $file->setUpdatedAt($this->dateTimeReader->getCurrentDateTime());
         }
     }
 }

emission/src/Enginewerk/EmissionBundle/Generator/Adapter/NativeGeneratorAdapter.php

@@ -0,0 +1,16 @@
+<?php
+namespace Enginewerk\EmissionBundle\Generator\Adapter;
+
+use Enginewerk\EmissionBundle\Generator\HashGenerator;
+use Enginewerk\EmissionBundle\Generator\PublicIdentifierGeneratorInterface;
+
+final class NativeGeneratorAdapter implements PublicIdentifierGeneratorInterface
+{
+    /**
+     * @inheritdoc
+     */
+    public function generate($length = 8)
+    {
+        return HashGenerator::generateRandomHash($length);
+    }
+}

emission/src/Enginewerk/EmissionBundle/Generator/PublicIdentifierGeneratorInterface.php

@@ -0,0 +1,12 @@
+<?php
+namespace Enginewerk\EmissionBundle\Generator;
+
+interface PublicIdentifierGeneratorInterface
+{
+    /**
+     * @param int $length
+     *
+     * @return string
+     */
+    public function generate($length = 8);
+}

emission/src/Enginewerk/EmissionBundle/Resources/config/services.yml

@@ -12,9 +12,28 @@ services:
         arguments:
             - '@enginewerk_emission.repository.file_repository'
             - '@enginewerk_emission.repository.file_block_repository'
-            - '@enginewerk_user.repository_doctrine.user_repository'
+            - '@enginewerk_emission.storage.manager.file_creation_manager'
             - '@enginewerk_fs.service.binary_storage_service'
 
+    enginewerk_emission.storage.manager.file_creation_manager:
+        class: Enginewerk\EmissionBundle\Storage\Manager\FileCreationManager
+        public: true
+        arguments:
+            - '@enginewerk_emission.repository.file_repository'
+            - '@enginewerk_resumable.common.uuid.uuid_version4generator'
+            - '@enginewerk_emission.generator_adapter.native_generator_adapter'
+            - '@enginewerk_user.repository_doctrine.user_repository'
+            - '@enginewerk_emission.storage_configuration.configuration'
+            - '@enginewerk_application.service.date_time_read_service'
+
+    enginewerk_emission.storage_configuration.configuration:
+        class: Enginewerk\EmissionBundle\Storage\Configuration\Configuration
+        public: false
+
+    enginewerk_emission.generator_adapter.native_generator_adapter:
+        class: Enginewerk\EmissionBundle\Generator\Adapter\NativeGeneratorAdapter
+        public: false
+
     enginewerk_emission.byte_formatter.script_fusion_adapter:
         public: false
         class: Enginewerk\Common\Formatter\ByteFormatter\Adapter\ScriptFusionAdapter
@@ -45,11 +64,13 @@ services:
         class: Enginewerk\EmissionBundle\EventListener\FileBlockSubscriber
         tags:
             - { name: doctrine.event_subscriber, connection: default }
+        arguments: ['@enginewerk_application.service.date_time_read_service']
 
     enginewerk_emission.event_listener.file_subscriber:
         class: Enginewerk\EmissionBundle\EventListener\FileSubscriber
         tags:
             - { name: doctrine.event_subscriber, connection: default }
+        arguments: ['@enginewerk_application.service.date_time_read_service']
 
     enginewerk_emission.service.file_write_service:
         public: false

emission/src/Enginewerk/EmissionBundle/Storage/Configuration/Configuration.php

@@ -0,0 +1,21 @@
+<?php
+namespace Enginewerk\EmissionBundle\Storage\Configuration;
+
+final class Configuration implements FileCreateConfigurationInterface
+{
+    /**
+     * @inheritdoc
+     */
+    public function getTimeToLive()
+    {
+        return 86600;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getPublicIdentifierLength()
+    {
+        return 8;
+    }
+}

emission/src/Enginewerk/EmissionBundle/Storage/Configuration/FileCreateConfigurationInterface.php

@@ -0,0 +1,15 @@
+<?php
+namespace Enginewerk\EmissionBundle\Storage\Configuration;
+
+interface FileCreateConfigurationInterface
+{
+    /**
+     * @return int seconds
+     */
+    public function getTimeToLive();
+
+    /**
+     * @return int Identifier length
+     */
+    public function getPublicIdentifierLength();
+}

emission/src/Enginewerk/EmissionBundle/Storage/FileManager.php

@@ -6,8 +6,8 @@
 use Enginewerk\EmissionBundle\Entity\FileBlock;
 use Enginewerk\EmissionBundle\Repository\FileBlockRepositoryInterface;
 use Enginewerk\EmissionBundle\Repository\FileRepositoryInterface;
+use Enginewerk\EmissionBundle\Storage\Manager\CreateFileInterface;
 use Enginewerk\FSBundle\Service\BinaryStorageInterface;
-use Enginewerk\UserBundle\Repository\UserFinderInterface;
 
 final class FileManager implements FileCreationInterface
 {
@@ -17,27 +17,27 @@ final class FileManager implements FileCreationInterface
     /** @var FileBlockRepositoryInterface */
     private $fileBlockRepository;
 
-    /** @var UserFinderInterface */
-    private $userRepository;
-
     /** @var BinaryStorageInterface */
     private $binaryBlockStorage;
 
+    /** @var CreateFileInterface */
+    private $fileCreationManager;
+
     /**
      * @param FileRepositoryInterface $fileRepository
      * @param FileBlockRepositoryInterface $fileBlockRepository
-     * @param UserFinderInterface $userRepository
+     * @param CreateFileInterface $fileCreationManager
      * @param BinaryStorageInterface $binaryBlockStorage
      */
     public function __construct(
         FileRepositoryInterface $fileRepository,
         FileBlockRepositoryInterface $fileBlockRepository,
-        UserFinderInterface $userRepository,
+        CreateFileInterface $fileCreationManager,
         BinaryStorageInterface $binaryBlockStorage
     ) {
         $this->fileRepository = $fileRepository;
         $this->fileBlockRepository = $fileBlockRepository;
-        $this->userRepository = $userRepository;
+        $this->fileCreationManager = $fileCreationManager;
         $this->binaryBlockStorage = $binaryBlockStorage;
     }
 
@@ -110,19 +110,7 @@ public function alterExpirationDate($publicIdentifier, \DateTimeInterface $expir
      */
     public function createFile($fileName, $fileChecksum, $fileSize, $userIdentifier, $mimeType)
     {
-        $user = $this->userRepository->getByEmail($userIdentifier);
-        $file = new FileEntity();
-
-        $file->setName($fileName);
-        $file->setChecksum($fileChecksum);
-        $file->setSize($fileSize);
-        $file->setType($mimeType);
-        $file->setUser($user);
-        $file->setComplete(false);
-
-        $this->fileRepository->persist($file);
-
-        return $file->getPublicIdentifier();
+        return $this->fileCreationManager->createFile($fileName, $fileChecksum, $fileSize, $userIdentifier, $mimeType);
     }
 
     /**

emission/src/Enginewerk/EmissionBundle/Storage/Manager/CreateFileInterface.php

@@ -0,0 +1,16 @@
+<?php
+namespace Enginewerk\EmissionBundle\Storage\Manager;
+
+interface CreateFileInterface
+{
+    /**
+     * @param string $fileName
+     * @param string $fileChecksum
+     * @param int $fileSize
+     * @param string $userIdentifier
+     * @param string $mimeType
+     *
+     * @return string Public Identifier
+     */
+    public function createFile($fileName, $fileChecksum, $fileSize, $userIdentifier, $mimeType);
+}