LegacyDFSCluster::loadList() - Code Metrics - Inspection of "fixup! EZP-25946: Separated file listing from file..." - ezsystems/ezpublish-kernel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — ezp25946-migrate_files_to_othe... ( e1d3cb...7924de )

unknown

created 2016-11-25 11:47 UTC

LegacyDFSCluster::loadList() B

↳ Parent: Project

Complexity

Conditions	6
Paths	8

Size

Total Lines	25
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	6
eloc	16
nc	8
nop	2
dl	0
loc	25
rs	8.439
c	0
b	0
f	0

<?php

/**
 * This file is part of the eZ Publish Legacy package.
 *
 * @copyright Copyright (C) eZ Systems AS. All rights reserved.
 * @license For full copyright and license information view LICENSE file distributd with this source code.
 */
namespace eZ\Publish\Core\IO\IOMetadataHandler;

use DateTime;
use eZ\Publish\Core\IO\IOMetadataHandler;
use Doctrine\DBAL\Connection;
use Doctrine\DBAL\DBALException;
use eZ\Publish\Core\Base\Exceptions\NotFoundException;
use eZ\Publish\Core\IO\Exception\BinaryFileNotFoundException;
use eZ\Publish\Core\IO\Exception\InvalidBinaryFileIdException;
use eZ\Publish\Core\IO\UrlDecorator;
use eZ\Publish\SPI\IO\BinaryFileCreateStruct as SPIBinaryFileCreateStruct;
use eZ\Publish\SPI\IO\BinaryFile as SPIBinaryFile;
use RuntimeException;

/**
 * Manages IO metadata in a mysql table, ezdfsfile.
 *
 * It will prevent simultaneous writes to the same file.
 */
class LegacyDFSCluster implements IOMetadataHandler

{
    /** @var Connection */
    private $db;

    /** @var UrlDecorator */
    private $urlDecorator;

    /**
     * @param Connection $connection Doctrine DBAL connection
     * @param UrlDecorator $urlDecorator The URL decorator used to add a prefix to files path
     */
    public function __construct(Connection $connection, UrlDecorator $urlDecorator = null)
    {
        $this->db = $connection;
        $this->urlDecorator = $urlDecorator;
    }

    /**
     * Inserts a new reference to file $spiBinaryFileId.
     *
     * @param string  $spiBinaryFileId
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @throws RuntimeException if a DBAL error occurs
     *
     * @return \eZ\Publish\SPI\IO\BinaryFile
     */
    public function create(SPIBinaryFileCreateStruct $binaryFileCreateStruct)
    {
        $path = $this->addPrefix($binaryFileCreateStruct->id);

        try {
            /*
             * @todo what might go wrong here ? Can another process be trying to insert the same image ?
             *       what happens if somebody did ?
             **/
            $stmt = $this->db->prepare(<<<SQL
INSERT INTO ezdfsfile
  (name, name_hash, name_trunk, mtime, size, scope, datatype)
  VALUES (:name, :name_hash, :name_trunk, :mtime, :size, :scope, :datatype)
ON DUPLICATE KEY UPDATE
  datatype=VALUES(datatype), scope=VALUES(scope), size=VALUES(size),
  mtime=VALUES(mtime)
SQL
            );
            $stmt->bindValue('name', $path);
            $stmt->bindValue('name_hash', md5($path));
            $stmt->bindValue('name_trunk', $this->getNameTrunk($binaryFileCreateStruct));
            $stmt->bindValue(
                'mtime',
                $binaryFileCreateStruct->mtime instanceof DateTime
                    ? $binaryFileCreateStruct->mtime->getTimestamp()
                    : $binaryFileCreateStruct->mtime
            );
            $stmt->bindValue('size', $binaryFileCreateStruct->size);
            $stmt->bindValue('scope', $this->getScope($binaryFileCreateStruct));
            $stmt->bindValue('datatype', $binaryFileCreateStruct->mimeType);
            $stmt->execute();
        } catch (DBALException $e) {
            throw new RuntimeException("A DBAL error occured while writing $path", 0, $e);
        }

        return $this->mapSPIBinaryFileCreateStructToSPIBinaryFile($binaryFileCreateStruct);
    }

    /**
     * Deletes file $spiBinaryFileId.
     *
     * @throws BinaryFileNotFoundException If $spiBinaryFileId is not found
     *
     * @param string $spiBinaryFileId
     */
    public function delete($spiBinaryFileId)
    {
        $path = $this->addPrefix($spiBinaryFileId);

        // Unlike the legacy cluster, the file is directly deleted. It was inherited from the DB cluster anyway
        $stmt = $this->db->prepare('DELETE FROM ezdfsfile WHERE name_hash LIKE :name_hash');
        $stmt->bindValue('name_hash', md5($path));
        $stmt->execute();

        if ($stmt->rowCount() != 1) {
            // Is this really necessary ?
            throw new BinaryFileNotFoundException($path);
        }
    }

    /**
     * Loads and returns metadata for $spiBinaryFileId.
     *
     * @param string $spiBinaryFileId
     *
     * @return SPIBinaryFile
     *
     * @throws BinaryFileNotFoundException if no row is found for $spiBinaryFileId
     * @throws DBALException Any unhandled DBAL exception
     */
    public function load($spiBinaryFileId)
    {
        $path = $this->addPrefix($spiBinaryFileId);

        $stmt = $this->db->prepare('SELECT * FROM ezdfsfile WHERE name_hash LIKE ? AND expired != 1 AND mtime > 0');
        $stmt->bindValue(1, md5($path));
        $stmt->execute();

        if ($stmt->rowCount() == 0) {
            throw new BinaryFileNotFoundException($path);
        }

        $row = $stmt->fetch(\PDO::FETCH_ASSOC) + array('id' => $spiBinaryFileId);

        return $this->mapArrayToSPIBinaryFile($row);
    }

    /**
     * Checks if a file $spiBinaryFileId exists.
     *
     * @param string $spiBinaryFileId
     *
     * @throws NotFoundException
     * @throws DBALException Any unhandled DBAL exception
     *
     * @return bool
     */
    public function exists($spiBinaryFileId)
    {
        $path = $this->addPrefix($spiBinaryFileId);

        $stmt = $this->db->prepare('SELECT name FROM ezdfsfile WHERE name_hash LIKE ? and mtime > 0 and expired != 1');
        $stmt->bindValue(1, md5($path));
        $stmt->execute();

        return ($stmt->rowCount() == 1);
    }

    /**
     * @param SPIBinaryFileCreateStruct $binaryFileCreateStruct
     *
     * @return mixed
     */
    protected function getNameTrunk(SPIBinaryFileCreateStruct $binaryFileCreateStruct)
    {
        return $this->addPrefix($binaryFileCreateStruct->id);
    }

    /**
     * Returns the value for the scope meta field, based on the created file's path.
     *
     * Note that this is slightly incorrect, as it will return binaryfile for media files as well. It is a bit
     * of an issue, but shouldn't be a blocker given that this meta field isn't used that much.
     *
     * @param SPIBinaryFileCreateStruct $binaryFileCreateStruct
     *
     * @return string
     */
    protected function getScope(SPIBinaryFileCreateStruct $binaryFileCreateStruct)
    {
        list($filePrefix) = explode('/', $binaryFileCreateStruct->id);

        switch ($filePrefix) {
            case 'images':
                return 'image';

            case 'original':
                return 'binaryfile';
        }

        return 'UNKNOWN_SCOPE';
    }

    /**
     * Adds the internal prefix string to $id.
     *
     * @param string $id
     *
     * @return string prefixed id
     */
    protected function addPrefix($id)
    {
        return isset($this->urlDecorator) ? $this->urlDecorator->decorate($id) : $id;
    }

    /**
     * Removes the internal prefix string from $prefixedId.
     *
     * @param string $prefixedId
     *
     * @return string the id without the prefix
     *
     * @throws InvalidBinaryFileIdException if the prefix isn't found in $prefixedId
     */
    protected function removePrefix($prefixedId)
    {
        return isset($this->urlDecorator) ? $this->urlDecorator->undecorate($prefixedId) : $prefixedId;
    }

    public function getMimeType($spiBinaryFileId)
    {
        $stmt = $this->db->prepare('SELECT * FROM ezdfsfile WHERE name_hash LIKE ? AND expired != 1 AND mtime > 0');
        $stmt->bindValue(1, md5($this->addPrefix($spiBinaryFileId)));
        $stmt->execute();

        if ($stmt->rowCount() == 0) {
            throw new BinaryFileNotFoundException($spiBinaryFileId);
        }

        $row = $stmt->fetch(\PDO::FETCH_ASSOC);

        return $row['datatype'];
    }

    public function deleteDirectory($spiPath)
    {
        $stmt = $this->db->prepare('DELETE FROM ezdfsfile WHERE name LIKE ?');
        $stmt->bindValue(1, rtrim($spiPath, '/') . '/%');
        $stmt->execute();
    }

    /**
     * Maps an array of data base properties (id, size, mtime, datatype, md5_path, path...) to an SPIBinaryFile object.
     *
     * @param array $properties database properties array
     *
     * @return SPIBinaryFile
     */
    protected function mapArrayToSPIBinaryFile(array $properties)
    {
        $spiBinaryFile = new SPIBinaryFile();
        $spiBinaryFile->id = $properties['id'];
        $spiBinaryFile->size = $properties['size'];
        $spiBinaryFile->mtime = new DateTime('@' . $properties['mtime']);
        $spiBinaryFile->mimeType = $properties['datatype'];


        return $spiBinaryFile;
    }

    /**
     * @param SPIBinaryFileCreateStruct $binaryFileCreateStruct
     *
     * @return SPIBinaryFile
     */
    protected function mapSPIBinaryFileCreateStructToSPIBinaryFile(SPIBinaryFileCreateStruct $binaryFileCreateStruct)
    {
        $spiBinaryFile = new SPIBinaryFile();
        $spiBinaryFile->id = $binaryFileCreateStruct->id;
        $spiBinaryFile->mtime = $binaryFileCreateStruct->mtime;
        $spiBinaryFile->size = $binaryFileCreateStruct->size;
        $spiBinaryFile->mimeType = $binaryFileCreateStruct->mimeType;


        return $spiBinaryFile;
    }
}


1		<?php
2
3		/**
4		* This file is part of the eZ Publish Legacy package.
5		*
6		* @copyright Copyright (C) eZ Systems AS. All rights reserved.
7		* @license For full copyright and license information view LICENSE file distributd with this source code.
8		*/
9		namespace eZ\Publish\Core\IO\IOMetadataHandler;
10
11		use DateTime;
12		use eZ\Publish\Core\IO\IOMetadataHandler;
13		use Doctrine\DBAL\Connection;
14		use Doctrine\DBAL\DBALException;
15		use eZ\Publish\Core\Base\Exceptions\NotFoundException;
16		use eZ\Publish\Core\IO\Exception\BinaryFileNotFoundException;
17		use eZ\Publish\Core\IO\Exception\InvalidBinaryFileIdException;
18		use eZ\Publish\Core\IO\UrlDecorator;
19		use eZ\Publish\SPI\IO\BinaryFileCreateStruct as SPIBinaryFileCreateStruct;
20		use eZ\Publish\SPI\IO\BinaryFile as SPIBinaryFile;
21		use RuntimeException;
22
23		/**
24		* Manages IO metadata in a mysql table, ezdfsfile.
25		*
26		* It will prevent simultaneous writes to the same file.
27		*/
28		class LegacyDFSCluster implements IOMetadataHandler
		0 ignored issues – show Bug introduced 2016-11-25 11:58 UTC by Report Bug Copy Issue Report There is at least one abstract method in this class. Maybe declare it as abstract, or implement the remaining methods: count, loadList Loading history...
29		{
30		/** @var Connection */
31		private $db;
32
33		/** @var UrlDecorator */
34		private $urlDecorator;
35
36		/**
37		* @param Connection $connection Doctrine DBAL connection
38		* @param UrlDecorator $urlDecorator The URL decorator used to add a prefix to files path
39		*/
40		public function __construct(Connection $connection, UrlDecorator $urlDecorator = null)
41		{
42		$this->db = $connection;
43		$this->urlDecorator = $urlDecorator;
44		}
45
46		/**
47		* Inserts a new reference to file $spiBinaryFileId.
48		*
49		* @param string $spiBinaryFileId
		0 ignored issues – show Bug introduced 2015-11-21 14:37 UTC by Report Bug Copy Issue Report There is no parameter named `$spiBinaryFileId`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
50		*
51		* @throws RuntimeException if a DBAL error occurs
52		*
53		* @return \eZ\Publish\SPI\IO\BinaryFile
54		*/
55		public function create(SPIBinaryFileCreateStruct $binaryFileCreateStruct)
56		{
57		$path = $this->addPrefix($binaryFileCreateStruct->id);
58
59		try {
60		/*
61		* @todo what might go wrong here ? Can another process be trying to insert the same image ?
62		* what happens if somebody did ?
63		**/
64		$stmt = $this->db->prepare(<<<SQL
65		INSERT INTO ezdfsfile
66		(name, name_hash, name_trunk, mtime, size, scope, datatype)
67		VALUES (:name, :name_hash, :name_trunk, :mtime, :size, :scope, :datatype)
68		ON DUPLICATE KEY UPDATE
69		datatype=VALUES(datatype), scope=VALUES(scope), size=VALUES(size),
70		mtime=VALUES(mtime)
71		SQL
72		);
73		$stmt->bindValue('name', $path);
74		$stmt->bindValue('name_hash', md5($path));
75		$stmt->bindValue('name_trunk', $this->getNameTrunk($binaryFileCreateStruct));
76		$stmt->bindValue(
77		'mtime',
78		$binaryFileCreateStruct->mtime instanceof DateTime
79		? $binaryFileCreateStruct->mtime->getTimestamp()
80		: $binaryFileCreateStruct->mtime
81		);
82		$stmt->bindValue('size', $binaryFileCreateStruct->size);
83		$stmt->bindValue('scope', $this->getScope($binaryFileCreateStruct));
84		$stmt->bindValue('datatype', $binaryFileCreateStruct->mimeType);
85		$stmt->execute();
86		} catch (DBALException $e) {
87		throw new RuntimeException("A DBAL error occured while writing $path", 0, $e);
88		}
89
90		return $this->mapSPIBinaryFileCreateStructToSPIBinaryFile($binaryFileCreateStruct);
91		}
92
93		/**
94		* Deletes file $spiBinaryFileId.
95		*
96		* @throws BinaryFileNotFoundException If $spiBinaryFileId is not found
97		*
98		* @param string $spiBinaryFileId
99		*/
100	View Code Duplication	public function delete($spiBinaryFileId)
101		{
102		$path = $this->addPrefix($spiBinaryFileId);
103
104		// Unlike the legacy cluster, the file is directly deleted. It was inherited from the DB cluster anyway
105		$stmt = $this->db->prepare('DELETE FROM ezdfsfile WHERE name_hash LIKE :name_hash');
106		$stmt->bindValue('name_hash', md5($path));
107		$stmt->execute();
108
109		if ($stmt->rowCount() != 1) {
110		// Is this really necessary ?
111		throw new BinaryFileNotFoundException($path);
112		}
113		}
114
115		/**
116		* Loads and returns metadata for $spiBinaryFileId.
117		*
118		* @param string $spiBinaryFileId
119		*
120		* @return SPIBinaryFile
121		*
122		* @throws BinaryFileNotFoundException if no row is found for $spiBinaryFileId
123		* @throws DBALException Any unhandled DBAL exception
124		*/
125		public function load($spiBinaryFileId)
126		{
127		$path = $this->addPrefix($spiBinaryFileId);
128
129		$stmt = $this->db->prepare('SELECT * FROM ezdfsfile WHERE name_hash LIKE ? AND expired != 1 AND mtime > 0');
130		$stmt->bindValue(1, md5($path));
131		$stmt->execute();
132
133		if ($stmt->rowCount() == 0) {
134		throw new BinaryFileNotFoundException($path);
135		}
136
137		$row = $stmt->fetch(\PDO::FETCH_ASSOC) + array('id' => $spiBinaryFileId);
138
139		return $this->mapArrayToSPIBinaryFile($row);
140		}
141
142		/**
143		* Checks if a file $spiBinaryFileId exists.
144		*
145		* @param string $spiBinaryFileId
146		*
147		* @throws NotFoundException
148		* @throws DBALException Any unhandled DBAL exception
149		*
150		* @return bool
151		*/
152	View Code Duplication	public function exists($spiBinaryFileId)
153		{
154		$path = $this->addPrefix($spiBinaryFileId);
155
156		$stmt = $this->db->prepare('SELECT name FROM ezdfsfile WHERE name_hash LIKE ? and mtime > 0 and expired != 1');
157		$stmt->bindValue(1, md5($path));
158		$stmt->execute();
159
160		return ($stmt->rowCount() == 1);
161		}
162
163		/**
164		* @param SPIBinaryFileCreateStruct $binaryFileCreateStruct
165		*
166		* @return mixed
167		*/
168		protected function getNameTrunk(SPIBinaryFileCreateStruct $binaryFileCreateStruct)
169		{
170		return $this->addPrefix($binaryFileCreateStruct->id);
171		}
172
173		/**
174		* Returns the value for the scope meta field, based on the created file's path.
175		*
176		* Note that this is slightly incorrect, as it will return binaryfile for media files as well. It is a bit
177		* of an issue, but shouldn't be a blocker given that this meta field isn't used that much.
178		*
179		* @param SPIBinaryFileCreateStruct $binaryFileCreateStruct
180		*
181		* @return string
182		*/
183		protected function getScope(SPIBinaryFileCreateStruct $binaryFileCreateStruct)
184		{
185		list($filePrefix) = explode('/', $binaryFileCreateStruct->id);
186
187		switch ($filePrefix) {
188		case 'images':
189		return 'image';
190
191		case 'original':
192		return 'binaryfile';
193		}
194
195		return 'UNKNOWN_SCOPE';
196		}
197
198		/**
199		* Adds the internal prefix string to $id.
200		*
201		* @param string $id
202		*
203		* @return string prefixed id
204		*/
205		protected function addPrefix($id)
206		{
207		return isset($this->urlDecorator) ? $this->urlDecorator->decorate($id) : $id;
208		}
209
210		/**
211		* Removes the internal prefix string from $prefixedId.
212		*
213		* @param string $prefixedId
214		*
215		* @return string the id without the prefix
216		*
217		* @throws InvalidBinaryFileIdException if the prefix isn't found in $prefixedId
218		*/
219		protected function removePrefix($prefixedId)
220		{
221		return isset($this->urlDecorator) ? $this->urlDecorator->undecorate($prefixedId) : $prefixedId;
222		}
223
224	View Code Duplication	public function getMimeType($spiBinaryFileId)
225		{
226		$stmt = $this->db->prepare('SELECT * FROM ezdfsfile WHERE name_hash LIKE ? AND expired != 1 AND mtime > 0');
227		$stmt->bindValue(1, md5($this->addPrefix($spiBinaryFileId)));
228		$stmt->execute();
229
230		if ($stmt->rowCount() == 0) {
231		throw new BinaryFileNotFoundException($spiBinaryFileId);
232		}
233
234		$row = $stmt->fetch(\PDO::FETCH_ASSOC);
235
236		return $row['datatype'];
237		}
238
239		public function deleteDirectory($spiPath)
240		{
241		$stmt = $this->db->prepare('DELETE FROM ezdfsfile WHERE name LIKE ?');
242		$stmt->bindValue(1, rtrim($spiPath, '/') . '/%');
243		$stmt->execute();
244		}
245
246		/**
247		* Maps an array of data base properties (id, size, mtime, datatype, md5_path, path...) to an SPIBinaryFile object.
248		*
249		* @param array $properties database properties array
250		*
251		* @return SPIBinaryFile
252		*/
253		protected function mapArrayToSPIBinaryFile(array $properties)
254		{
255		$spiBinaryFile = new SPIBinaryFile();
256		$spiBinaryFile->id = $properties['id'];
257		$spiBinaryFile->size = $properties['size'];
258		$spiBinaryFile->mtime = new DateTime('@' . $properties['mtime']);
259		$spiBinaryFile->mimeType = $properties['datatype'];
		0 ignored issues – show Deprecated Code introduced 2015-11-21 14:37 UTC by Report Bug Copy Issue Report The property `eZ\Publish\SPI\IO\BinaryFile::$mimeType` has been deprecated with message: Since 5.3.3, use IO\Handler::getMimeType() This property has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the property will be removed from the class and what other property to use instead. Loading history...
260
261		return $spiBinaryFile;
262		}
263
264		/**
265		* @param SPIBinaryFileCreateStruct $binaryFileCreateStruct
266		*
267		* @return SPIBinaryFile
268		*/
269		protected function mapSPIBinaryFileCreateStructToSPIBinaryFile(SPIBinaryFileCreateStruct $binaryFileCreateStruct)
270		{
271		$spiBinaryFile = new SPIBinaryFile();
272		$spiBinaryFile->id = $binaryFileCreateStruct->id;
273		$spiBinaryFile->mtime = $binaryFileCreateStruct->mtime;
274		$spiBinaryFile->size = $binaryFileCreateStruct->size;
275		$spiBinaryFile->mimeType = $binaryFileCreateStruct->mimeType;
		0 ignored issues – show Deprecated Code introduced 2015-11-21 14:37 UTC by Report Bug Copy Issue Report The property `eZ\Publish\SPI\IO\BinaryFile::$mimeType` has been deprecated with message: Since 5.3.3, use IO\Handler::getMimeType() This property has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the property will be removed from the class and what other property to use instead. Loading history...
276
277		return $spiBinaryFile;
278		}
279		}
280

ezsystems / ezpublish-kernel

Push — ezp25946-migrate_files_to_othe... ( e1d3cb...7924de )

LegacyDFSCluster::loadList() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like