FileManager::buildFileDocument() - Code Metrics - Inspection of "Keep file info if only metadata update" - libgraviton/graviton - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature/keep-file-info ( acc8ce )

unknown

created 2016-11-16 14:23 UTC

FileManager::buildFileDocument() C

↳ Parent: FileManager

Complexity

Conditions	13
Paths	48

Size

Total Lines	41
Code Lines	25

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	182

Importance

Changes

Metric	Value
dl	0
loc	41
ccs	0
cts	32
cp	0
rs	5.1234
c	0
b	0
f	0
cc	13
eloc	25
nc	48
nop	3
crap	182

How to fix Complexity

<?php
/**
 * Handles file specific actions
 */

namespace Graviton\FileBundle\Manager;

use Doctrine\ODM\MongoDB\Id\UuidGenerator;
use Gaufrette\File as GaufretteFile;
use Gaufrette\Filesystem;
use GravitonDyn\FileBundle\Document\File as FileDocument;
use GravitonDyn\FileBundle\Document\FileMetadataBase;
use GravitonDyn\FileBundle\Document\FileMetadataEmbedded;
use Symfony\Component\Form\Exception\InvalidArgumentException;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\ResponseHeaderBag;
use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
use Symfony\Component\HttpFoundation\FileBag;
use Symfony\Component\HttpFoundation\File\UploadedFile;
use GravitonDyn\FileBundle\Document\File as DocumentFile;
use Doctrine\Bundle\MongoDBBundle\ManagerRegistry;
use Doctrine\ODM\MongoDB\DocumentManager;
use Symfony\Component\Filesystem\Filesystem as SfFileSystem;
use GravitonDyn\FileBundle\Model\File as DocumentModel;

/**
 * @author   List of contributors <https://github.com/libgraviton/graviton/graphs/contributors>
 * @license  http://opensource.org/licenses/gpl-license.php GNU Public License
 * @link     http://swisscom.ch
 */
class FileManager
{
    /**
     * @var Filesystem
     */
    private $fileSystem;

    /**
     * @var DocumentManager
     */
    private $documentManager;

    /** @var array allowedMimeTypes Control files to be saved and returned */
    private $allowedMimeTypes = [];

    /**
     * FileManager constructor.
     *
     * @param Filesystem      $fileSystem      file system abstraction layer for s3 and more
     * @param ManagerRegistry $managerRegistry MongoDB registry manager
     */
    public function __construct(
        Filesystem $fileSystem,
        ManagerRegistry $managerRegistry
    ) {
        $this->fileSystem = $fileSystem;
        $this->documentManager = $managerRegistry->getManager();
    }

    /**
     * Configure allowed content types, empty is equal to all
     *
     * @param array $mimeTypes of Allowed types, application/pdf, image/jpeg...
     *
     * @return void
     */
    public function setAllowedMimeTypes(array $mimeTypes)
    {
        $this->allowedMimeTypes = $mimeTypes;
    }

    /**
     * Will update the response object with provided file data
     *
     * @param Response     $response To building the response on
     * @param DocumentFile $file     File document object from DB
     *
     * @return Response
     * @throws InvalidArgumentException if invalid info fetched from fileSystem
     */
    public function buildGetContentResponse(Response $response, FileDocument $file)
    {
        /** @var FileMetadataBase $metadata */
        $metadata = $file->getMetadata();
        if (!$metadata) {
            throw new InvalidArgumentException('Loaded file have no valid metadata');
        }

        // We use file's mimeType, just in case none we use DB's.
        $mimeType = $this->fileSystem->mimeType($file->getId());
        if (!$mimeType) {
            $mimeType = $metadata->getMime();
        }
        if ($this->allowedMimeTypes && !in_array($mimeType, $this->allowedMimeTypes)) {
            throw new InvalidArgumentException('File mime type: '.$mimeType.' is not allowed as response.');
        }

        // Read Data
        $file = $this->fileSystem->read($file->getId());

        // Create Response
        $disposition = $response->headers->makeDisposition(
            ResponseHeaderBag::DISPOSITION_INLINE,
            $metadata->getFilename()
        );
        $response
            ->setStatusCode(Response::HTTP_OK)
            ->setContent($file);
        $response
            ->headers->set('Content-Type', $mimeType);
        $response
            ->headers->set('Content-Disposition', $disposition);
        return $response;
    }


    /**
     * Save or update a file
     *
     * @param string $id   ID of file
     * @param String $data content to save
     *
     * @return GaufretteFile
     *
     * @throws BadRequestHttpException
     */
    public function saveFile($id, $data)
    {
        if (is_resource($data)) {
            throw new BadRequestHttpException('/file does not support storing resources');
        }
        $file = new GaufretteFile($id, $this->fileSystem);
        $file->setContent($data);

        return $file;
    }

    /**
     * @param DocumentFile  $document File Document
     * @param Request       $request  Request bag
     * @param DocumentModel $model    File Document Model
     * @return DocumentFile
     */
    public function handleSaveRequest(
        FileDocument $document,
        Request $request,
        DocumentModel $model
    ) {
        $file = $this->getUploadedFileFromRequest($request);
        $requestId = $request->get('id', '');
        if ($requestId && !$document->getId()) {
            $document->setId($requestId);
        }

        $original = $model->find($requestId);
        $isNew = $requestId ? !$original : true;

        // If posted  file document not equal the one to be created or updated, then error
        if (!$this->validIdRequest($document, $requestId)) {
            throw new InvalidArgumentException('File id and Request id must match.');
        }

        $document = $this->buildFileDocument($document, $file, $original);
        if (!$document->getId()) {
            $n = new UuidGenerator();
            $uuid = (string) $n->generateV4();
            $document->setId($uuid);
        }

        // All ok, let's save the file
        if ($isNew) {
            if (!$file || $file->getSize() == 0) {
                throw new InvalidArgumentException('You can not create a new empty file resource. No file received.');
            }
        }

        if ($file) {
            $this->saveFile($document->getId(), file_get_contents($file->getRealPath()));
            $sfFileSys = new SfFileSystem();
            $sfFileSys->remove($file->getRealPath());
        }

        if ($isNew) {
            $model->insertRecord($document);
        } else {
            $model->updateRecord($document->getId(), $document);
        }

        // store id of new record so we don't need to re-parse body later when needed
        $request->attributes->set('id', $document->getId());

        return $document;
    }

    /**
     * Create the basic needs for a file
     *
     * @param DocumentFile $document Post or Put file document
     * @param UploadedFile $file     To be used in set metadata
     * @param DocumentFile $original If there is a original document
     *
     * @return DocumentFile
     * @throws InvalidArgumentException
     */
    private function buildFileDocument(FileDocument $document, $file, $original)
    {
        $now = new \DateTime();

        // If only a file is posted, check if there is a original object and clone it
        if ($file && $original && !$document->getMetadata()) {
            $document = clone $original;
        }

        // Basic Metadata update
        $metadata = $document->getMetadata() ?: new FileMetadataEmbedded();

        // File related, if no file uploaded we keep original file info.
        if ($file) {
            $hash = hash('sha256', file_get_contents($file->getRealPath()));
            $metadata->setHash($hash);
            $metadata->setMime($file->getMimeType());
            $metadata->setSize($file->getSize());
            if (!$metadata->getFilename()) {
                $fileName = $file->getClientOriginalName() ? $file->getClientOriginalName() : $file->getFilename();
                $fileName = preg_replace("/[^a-zA-Z0-9.]/", "-", $fileName);
                $metadata->setFilename($fileName);
            }
        } elseif ($original && ($originalMetadata = $original->getMetadata())) {
            if (!$metadata->getFilename()) {
                $metadata->setFilename($originalMetadata->getFilename());
            }
            $metadata->setHash($originalMetadata->getHash());
            $metadata->setMime($originalMetadata->getMime());
            $metadata->setSize($originalMetadata->getSize());
        }

        if (!$original || !$metadata->getCreatedate()) {
            $metadata->setCreatedate($now);
        }
        $metadata->setModificationdate($now);

        $document->setMetadata($metadata);

        return $document;
    }

    /**
     * Simple validation for post/put request
     *
     * @param DocumentFile $document  File document
     * @param string       $requestId Request ID
     * @return bool
     */
    private function validIdRequest(FileDocument $document, $requestId)

    {
        if (!$requestId && !$document->getId()) {
            return true;
        }
        if ($requestId === $document->getId()) {
            return true;
        }
        return false;
    }

    /**
     * Simple delete item from file system
     *
     * @param string $id ID of file to be deleted
     *
     * @return void
     */
    public function remove($id)
    {
        if ($this->fileSystem->has($id)) {
            $this->fileSystem->delete($id);
        }
    }

    /**
     * Set global uploaded file.
     * Only ONE file allowed per upload.
     *
     * @param Request $request service request
     * @return UploadedFile if file was uploaded
     * @throws InvalidArgumentException
     */
    private function getUploadedFileFromRequest(Request $request)
    {
        $file = false;

        if ($request->files instanceof FileBag && $request->files->count() > 0) {
            if ($request->files->count() > 1) {
                throw new InvalidArgumentException('Only 1 file upload per requests allowed.');
            }
            $files = $request->files->all();
            $file = reset($files);
            if ($this->allowedMimeTypes && !in_array($file->getMimeType(), $this->allowedMimeTypes)) {
                throw new InvalidArgumentException('File mime type: '.$file->getMimeType().' is not allowed.');
            }
        }

        return $file;
    }
}


1			<?php
2			/**
3			* Handles file specific actions
4			*/
5
6			namespace Graviton\FileBundle\Manager;
7
8			use Doctrine\ODM\MongoDB\Id\UuidGenerator;
9			use Gaufrette\File as GaufretteFile;
10			use Gaufrette\Filesystem;
11			use GravitonDyn\FileBundle\Document\File as FileDocument;
12			use GravitonDyn\FileBundle\Document\FileMetadataBase;
13			use GravitonDyn\FileBundle\Document\FileMetadataEmbedded;
14			use Symfony\Component\Form\Exception\InvalidArgumentException;
15			use Symfony\Component\HttpFoundation\Request;
16			use Symfony\Component\HttpFoundation\Response;
17			use Symfony\Component\HttpFoundation\ResponseHeaderBag;
18			use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
19			use Symfony\Component\HttpFoundation\FileBag;
20			use Symfony\Component\HttpFoundation\File\UploadedFile;
21			use GravitonDyn\FileBundle\Document\File as DocumentFile;
22			use Doctrine\Bundle\MongoDBBundle\ManagerRegistry;
23			use Doctrine\ODM\MongoDB\DocumentManager;
24			use Symfony\Component\Filesystem\Filesystem as SfFileSystem;
25			use GravitonDyn\FileBundle\Model\File as DocumentModel;
26
27			/**
28			* @author List of contributors <https://github.com/libgraviton/graviton/graphs/contributors>
29			* @license http://opensource.org/licenses/gpl-license.php GNU Public License
30			* @link http://swisscom.ch
31			*/
32			class FileManager
33			{
34			/**
35			* @var Filesystem
36			*/
37			private $fileSystem;
38
39			/**
40			* @var DocumentManager
41			*/
42			private $documentManager;
43
44			/** @var array allowedMimeTypes Control files to be saved and returned */
45			private $allowedMimeTypes = [];
46
47			/**
48			* FileManager constructor.
49			*
50			* @param Filesystem $fileSystem file system abstraction layer for s3 and more
51			* @param ManagerRegistry $managerRegistry MongoDB registry manager
52			*/
53			public function __construct(
54			Filesystem $fileSystem,
55			ManagerRegistry $managerRegistry
56			) {
57			$this->fileSystem = $fileSystem;
58			$this->documentManager = $managerRegistry->getManager();
59			}
60
61			/**
62			* Configure allowed content types, empty is equal to all
63			*
64			* @param array $mimeTypes of Allowed types, application/pdf, image/jpeg...
65			*
66			* @return void
67			*/
68			public function setAllowedMimeTypes(array $mimeTypes)
69			{
70			$this->allowedMimeTypes = $mimeTypes;
71			}
72
73			/**
74			* Will update the response object with provided file data
75			*
76			* @param Response $response To building the response on
77			* @param DocumentFile $file File document object from DB
78			*
79			* @return Response
80			* @throws InvalidArgumentException if invalid info fetched from fileSystem
81			*/
82			public function buildGetContentResponse(Response $response, FileDocument $file)
83			{
84			/** @var FileMetadataBase $metadata */
85			$metadata = $file->getMetadata();
86			if (!$metadata) {
87			throw new InvalidArgumentException('Loaded file have no valid metadata');
88			}
89
90			// We use file's mimeType, just in case none we use DB's.
91			$mimeType = $this->fileSystem->mimeType($file->getId());
92			if (!$mimeType) {
93			$mimeType = $metadata->getMime();
94			}
95			if ($this->allowedMimeTypes && !in_array($mimeType, $this->allowedMimeTypes)) {
96			throw new InvalidArgumentException('File mime type: '.$mimeType.' is not allowed as response.');
97			}
98
99			// Read Data
100			$file = $this->fileSystem->read($file->getId());
101
102			// Create Response
103			$disposition = $response->headers->makeDisposition(
104			ResponseHeaderBag::DISPOSITION_INLINE,
105			$metadata->getFilename()
106			);
107			$response
108			->setStatusCode(Response::HTTP_OK)
109			->setContent($file);
110			$response
111			->headers->set('Content-Type', $mimeType);
112			$response
113			->headers->set('Content-Disposition', $disposition);
114			return $response;
115			}
116
117
118			/**
119			* Save or update a file
120			*
121			* @param string $id ID of file
122			* @param String $data content to save
123			*
124			* @return GaufretteFile
125			*
126			* @throws BadRequestHttpException
127			*/
128			public function saveFile($id, $data)
129			{
130			if (is_resource($data)) {
131			throw new BadRequestHttpException('/file does not support storing resources');
132			}
133			$file = new GaufretteFile($id, $this->fileSystem);
134			$file->setContent($data);
135
136			return $file;
137			}
138
139			/**
140			* @param DocumentFile $document File Document
141			* @param Request $request Request bag
142			* @param DocumentModel $model File Document Model
143			* @return DocumentFile
144			*/
145			public function handleSaveRequest(
146			FileDocument $document,
147			Request $request,
148			DocumentModel $model
149			) {
150			$file = $this->getUploadedFileFromRequest($request);
151			$requestId = $request->get('id', '');
152			if ($requestId && !$document->getId()) {
153			$document->setId($requestId);
154			}
155
156			$original = $model->find($requestId);
157			$isNew = $requestId ? !$original : true;
158
159			// If posted file document not equal the one to be created or updated, then error
160			if (!$this->validIdRequest($document, $requestId)) {
161			throw new InvalidArgumentException('File id and Request id must match.');
162			}
163
164			$document = $this->buildFileDocument($document, $file, $original);
165			if (!$document->getId()) {
166			$n = new UuidGenerator();
167			$uuid = (string) $n->generateV4();
168			$document->setId($uuid);
169			}
170
171			// All ok, let's save the file
172			if ($isNew) {
173			if (!$file \|\| $file->getSize() == 0) {
174			throw new InvalidArgumentException('You can not create a new empty file resource. No file received.');
175			}
176			}
177
178			if ($file) {
179			$this->saveFile($document->getId(), file_get_contents($file->getRealPath()));
180			$sfFileSys = new SfFileSystem();
181			$sfFileSys->remove($file->getRealPath());
182			}
183
184			if ($isNew) {
185			$model->insertRecord($document);
186			} else {
187			$model->updateRecord($document->getId(), $document);
188			}
189
190			// store id of new record so we don't need to re-parse body later when needed
191			$request->attributes->set('id', $document->getId());
192
193			return $document;
194			}
195
196			/**
197			* Create the basic needs for a file
198			*
199			* @param DocumentFile $document Post or Put file document
200			* @param UploadedFile $file To be used in set metadata
201			* @param DocumentFile $original If there is a original document
202			*
203			* @return DocumentFile
204			* @throws InvalidArgumentException
205			*/
206			private function buildFileDocument(FileDocument $document, $file, $original)
207			{
208			$now = new \DateTime();
209
210			// If only a file is posted, check if there is a original object and clone it
211			if ($file && $original && !$document->getMetadata()) {
212			$document = clone $original;
213			}
214
215			// Basic Metadata update
216			$metadata = $document->getMetadata() ?: new FileMetadataEmbedded();
217
218			// File related, if no file uploaded we keep original file info.
219			if ($file) {
220			$hash = hash('sha256', file_get_contents($file->getRealPath()));
221			$metadata->setHash($hash);
222			$metadata->setMime($file->getMimeType());
223			$metadata->setSize($file->getSize());
224			if (!$metadata->getFilename()) {
225			$fileName = $file->getClientOriginalName() ? $file->getClientOriginalName() : $file->getFilename();
226			$fileName = preg_replace("/[^a-zA-Z0-9.]/", "-", $fileName);
227			$metadata->setFilename($fileName);
228			}
229			} elseif ($original && ($originalMetadata = $original->getMetadata())) {
230			if (!$metadata->getFilename()) {
231			$metadata->setFilename($originalMetadata->getFilename());
232			}
233			$metadata->setHash($originalMetadata->getHash());
234			$metadata->setMime($originalMetadata->getMime());
235			$metadata->setSize($originalMetadata->getSize());
236			}
237
238			if (!$original \|\| !$metadata->getCreatedate()) {
239			$metadata->setCreatedate($now);
240			}
241			$metadata->setModificationdate($now);
242
243			$document->setMetadata($metadata);
244
245			return $document;
246			}
247
248			/**
249			* Simple validation for post/put request
250			*
251			* @param DocumentFile $document File document
252			* @param string $requestId Request ID
253			* @return bool
254			*/
255			private function validIdRequest(FileDocument $document, $requestId)
			0 ignored issues – show Coding Style introduced 2016-11-09 09:12 UTC by Report Bug Copy Issue Report `function validIdRequest()` does not seem to conform to the naming convention (`^(?:is\|has\|should\|may\|supports)`). This check examines a number of code elements and verifies that they conform to the given naming conventions. You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods. Loading history...
256			{
257			if (!$requestId && !$document->getId()) {
258			return true;
259			}
260			if ($requestId === $document->getId()) {
261			return true;
262			}
263			return false;
264			}
265
266			/**
267			* Simple delete item from file system
268			*
269			* @param string $id ID of file to be deleted
270			*
271			* @return void
272			*/
273			public function remove($id)
274			{
275			if ($this->fileSystem->has($id)) {
276			$this->fileSystem->delete($id);
277			}
278			}
279
280			/**
281			* Set global uploaded file.
282			* Only ONE file allowed per upload.
283			*
284			* @param Request $request service request
285			* @return UploadedFile if file was uploaded
286			* @throws InvalidArgumentException
287			*/
288			private function getUploadedFileFromRequest(Request $request)
289			{
290			$file = false;
291
292			if ($request->files instanceof FileBag && $request->files->count() > 0) {
293			if ($request->files->count() > 1) {
294			throw new InvalidArgumentException('Only 1 file upload per requests allowed.');
295			}
296			$files = $request->files->all();
297			$file = reset($files);
298			if ($this->allowedMimeTypes && !in_array($file->getMimeType(), $this->allowedMimeTypes)) {
299			throw new InvalidArgumentException('File mime type: '.$file->getMimeType().' is not allowed.');
300			}
301			}
302
303			return $file;
304			}
305			}
306

libgraviton / graviton

Push — feature/keep-file-info ( acc8ce )

FileManager::buildFileDocument() C

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like