FlatFileDriver::popMessage() - Code Metrics - Inspection of "Updated FlatFileDriver.php" - bernardphp/bernard - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#308)

unknown

created 2017-06-15 14:11 UTC

FlatFileDriver::popMessage() A

↳ Parent: FlatFileDriver

Complexity

Conditions	3
Paths	3

Size

Total Lines	22
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	22
rs	9.2
cc	3
eloc	13
nc	3
nop	2

<?php

namespace Bernard\Driver;

/**
 * Flat file driver to provide a simple job queue without any
 * database.
 *
 * @author Markus Bachmann <[email protected]>
 */
class FlatFileDriver implements \Bernard\Driver
{
    /**
     * @var string
     */
    private $baseDirectory;

    /**
     * @var integer
     */
    private $permissions;

    /**
     * @param string $baseDirectory The base directory
     * @param int    $permissions   Permissions to create the file with.
     */
    public function __construct($baseDirectory, $permissions = 0740)
    {
        $this->baseDirectory = $baseDirectory;
        $this->permissions = $permissions;
    }

    /**
     * {@inheritdoc}
     */
    public function listQueues()
    {
        $it = new \FilesystemIterator($this->baseDirectory, \FilesystemIterator::SKIP_DOTS);

        $queues = [];

        foreach ($it as $file) {
            if (!$file->isDir()) {
                continue;
            }

            array_push($queues, $file->getBasename());
        }

        return $queues;
    }

    /**
     * {@inheritdoc}
     */
    public function createQueue($queueName)
    {
        $queueDir = $this->getQueueDirectory($queueName);

        if (is_dir($queueDir)) {
            return;
        }

        mkdir($queueDir, 0755, true);
    }

    /**
     * {@inheritdoc}
     */
    public function countMessages($queueName)
    {
        return iterator_count($this->getJobIterator($queueName));
    }

    /**
     * {@inheritdoc}
     */
    public function pushMessage($queueName, $message)
    {
        $queueDir = $this->getQueueDirectory($queueName);

        $filename = $this->getJobFilename($queueName);

        file_put_contents($queueDir.DIRECTORY_SEPARATOR.$filename, $message);
        chmod($queueDir.DIRECTORY_SEPARATOR.$filename, $this->permissions);
    }

    /**
     * {@inheritdoc}
     */
    public function popMessage($queueName, $duration = 5)
    {
        $runtime = microtime(true) + $duration;
        $queueDir = $this->getQueueDirectory($queueName);
        $files = $this->getJobFiles($queueName);

        natsort($files);

        while (microtime(true) < $runtime) {
            if ($files) {

                $id = array_shift($files);
                $data = array(file_get_contents($queueDir.DIRECTORY_SEPARATOR.$id), $id);
                // Set file hidden (emulating message invisibility)
                rename($queueDir.DIRECTORY_SEPARATOR.$id, $queueDir.DIRECTORY_SEPARATOR.'.'.$id);
                return $data;
            }

            usleep(1000);
        }

        return array(null, null);
    }

    /**
     * {@inheritdoc}
     */
    public function acknowledgeMessage($queueName, $receipt)
    {
        $queueDir = $this->getQueueDirectory($queueName);
        // Set path to hidden filename
        $path = $queueDir.DIRECTORY_SEPARATOR.'.'.$receipt;

        if (!is_file($path)) {
            return;
        }

        unlink($path);
    }

    /**
     * {@inheritdoc}
     */
    public function peekQueue($queueName, $index = 0, $limit = 20)
    {
        $queueDir = $this->getQueueDirectory($queueName);

        $files = $this->getJobFiles($queueName);

        natsort($files);

        $files = array_slice($files, $index, $limit);

        $messages = [];

        foreach ($files as $file) {
            array_push($messages, file_get_contents($queueDir.DIRECTORY_SEPARATOR.$file));
        }

        return $messages;
    }

    /**
     * {@inheritdoc}
     */
    public function removeQueue($queueName)
    {
        $this->removeDirectoryRecursive($this->getQueueDirectory($queueName));
    }

    /**
     * {@inheritdoc}
     */
    public function info()
    {
        return [];
    }

    /**
     * @param string $queueName
     *
     * @return string
     */
    private function getQueueDirectory($queueName)
    {
        return $this->baseDirectory.DIRECTORY_SEPARATOR.str_replace(array('\\', '.'), '-', $queueName);
    }

    /**
     * Generates a uuid.
     *
     * @param string $queueName
     *
     * @return string
     */
    private function getJobFilename($queueName)
    {
        $path = $this->baseDirectory.'/bernard.meta';

        if (!is_file($path)) {
            touch($path);
            chmod($path, $this->permissions);
        }

        $file = new \SplFileObject($path, 'r+');
        $file->flock(LOCK_EX);

        $meta = unserialize($file->fgets());

        $id = isset($meta[$queueName]) ? $meta[$queueName] : 0;
        $id++;

        $filename = sprintf('%d.job', $id);
        $meta[$queueName] = $id;

        $content = serialize($meta);

        $file->fseek(0);
        $file->fwrite($content, strlen($content));
        $file->flock(LOCK_UN);

        return $filename;
    }

    /**
     * Creates an iterator of all message files in the queue
     * @param string $queueName
     * @return \GlobIterator
     */
    private function getJobIterator($queueName) {
        $queueDir = $this->getQueueDirectory($queueName);
        $iterator = new \GlobIterator($queueDir.DIRECTORY_SEPARATOR.'*.job', \FilesystemIterator::KEY_AS_FILENAME);
        return $iterator;
    }

    /**
     * Retrieves an array of all message files in the queue
     * @param string $queueName
     * @return array
     */
    private function getJobFiles($queueName) {
        $iterator = $this->getJobIterator($queueName);
        $files = array_keys(iterator_to_array($iterator));
        return $files;
    }

    /**
     * Removes a directory recursively
     * @param string $directory
     */
    private function removeDirectoryRecursive($directory)
    {
        foreach (glob("{$directory}/{,.}[!.,!..]*", GLOB_MARK|GLOB_BRACE) as $file)
        {
            if (is_dir($file)) {
                $this->removeDirectoryRecursive($file);
            } else {
                unlink($file);
            }
        }
        rmdir($directory);
    }
}


1			<?php
2
3			namespace Bernard\Driver;
4
5			/**
6			* Flat file driver to provide a simple job queue without any
7			* database.
8			*
9			* @author Markus Bachmann <[email protected]>
10			*/
11			class FlatFileDriver implements \Bernard\Driver
12			{
13			/**
14			* @var string
15			*/
16			private $baseDirectory;
17
18			/**
19			* @var integer
20			*/
21			private $permissions;
22
23			/**
24			* @param string $baseDirectory The base directory
25			* @param int $permissions Permissions to create the file with.
26			*/
27			public function __construct($baseDirectory, $permissions = 0740)
28			{
29			$this->baseDirectory = $baseDirectory;
30			$this->permissions = $permissions;
31			}
32
33			/**
34			* {@inheritdoc}
35			*/
36			public function listQueues()
37			{
38			$it = new \FilesystemIterator($this->baseDirectory, \FilesystemIterator::SKIP_DOTS);
39
40			$queues = [];
41
42			foreach ($it as $file) {
43			if (!$file->isDir()) {
44			continue;
45			}
46
47			array_push($queues, $file->getBasename());
48			}
49
50			return $queues;
51			}
52
53			/**
54			* {@inheritdoc}
55			*/
56			public function createQueue($queueName)
57			{
58			$queueDir = $this->getQueueDirectory($queueName);
59
60			if (is_dir($queueDir)) {
61			return;
62			}
63
64			mkdir($queueDir, 0755, true);
65			}
66
67			/**
68			* {@inheritdoc}
69			*/
70			public function countMessages($queueName)
71			{
72			return iterator_count($this->getJobIterator($queueName));
73			}
74
75			/**
76			* {@inheritdoc}
77			*/
78			public function pushMessage($queueName, $message)
79			{
80			$queueDir = $this->getQueueDirectory($queueName);
81
82			$filename = $this->getJobFilename($queueName);
83
84			file_put_contents($queueDir.DIRECTORY_SEPARATOR.$filename, $message);
85			chmod($queueDir.DIRECTORY_SEPARATOR.$filename, $this->permissions);
86			}
87
88			/**
89			* {@inheritdoc}
90			*/
91			public function popMessage($queueName, $duration = 5)
92			{
93			$runtime = microtime(true) + $duration;
94			$queueDir = $this->getQueueDirectory($queueName);
95			$files = $this->getJobFiles($queueName);
96
97			natsort($files);
98
99			while (microtime(true) < $runtime) {
100			if ($files) {
			1 ignored issue – show Bug Best Practice introduced 2015-11-30 20:04 UTC by Report Bug Copy Issue Report The expression `$files` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
101			$id = array_shift($files);
102			$data = array(file_get_contents($queueDir.DIRECTORY_SEPARATOR.$id), $id);
103			// Set file hidden (emulating message invisibility)
104			rename($queueDir.DIRECTORY_SEPARATOR.$id, $queueDir.DIRECTORY_SEPARATOR.'.'.$id);
105			return $data;
106			}
107
108			usleep(1000);
109			}
110
111			return array(null, null);
112			}
113
114			/**
115			* {@inheritdoc}
116			*/
117			public function acknowledgeMessage($queueName, $receipt)
118			{
119			$queueDir = $this->getQueueDirectory($queueName);
120			// Set path to hidden filename
121			$path = $queueDir.DIRECTORY_SEPARATOR.'.'.$receipt;
122
123			if (!is_file($path)) {
124			return;
125			}
126
127			unlink($path);
128			}
129
130			/**
131			* {@inheritdoc}
132			*/
133			public function peekQueue($queueName, $index = 0, $limit = 20)
134			{
135			$queueDir = $this->getQueueDirectory($queueName);
136
137			$files = $this->getJobFiles($queueName);
138
139			natsort($files);
140
141			$files = array_slice($files, $index, $limit);
142
143			$messages = [];
144
145			foreach ($files as $file) {
146			array_push($messages, file_get_contents($queueDir.DIRECTORY_SEPARATOR.$file));
147			}
148
149			return $messages;
150			}
151
152			/**
153			* {@inheritdoc}
154			*/
155			public function removeQueue($queueName)
156			{
157			$this->removeDirectoryRecursive($this->getQueueDirectory($queueName));
158			}
159
160			/**
161			* {@inheritdoc}
162			*/
163			public function info()
164			{
165			return [];
166			}
167
168			/**
169			* @param string $queueName
170			*
171			* @return string
172			*/
173			private function getQueueDirectory($queueName)
174			{
175			return $this->baseDirectory.DIRECTORY_SEPARATOR.str_replace(array('\\', '.'), '-', $queueName);
176			}
177
178			/**
179			* Generates a uuid.
180			*
181			* @param string $queueName
182			*
183			* @return string
184			*/
185			private function getJobFilename($queueName)
186			{
187			$path = $this->baseDirectory.'/bernard.meta';
188
189			if (!is_file($path)) {
190			touch($path);
191			chmod($path, $this->permissions);
192			}
193
194			$file = new \SplFileObject($path, 'r+');
195			$file->flock(LOCK_EX);
196
197			$meta = unserialize($file->fgets());
198
199			$id = isset($meta[$queueName]) ? $meta[$queueName] : 0;
200			$id++;
201
202			$filename = sprintf('%d.job', $id);
203			$meta[$queueName] = $id;
204
205			$content = serialize($meta);
206
207			$file->fseek(0);
208			$file->fwrite($content, strlen($content));
209			$file->flock(LOCK_UN);
210
211			return $filename;
212			}
213
214			/**
215			* Creates an iterator of all message files in the queue
216			* @param string $queueName
217			* @return \GlobIterator
218			*/
219			private function getJobIterator($queueName) {
220			$queueDir = $this->getQueueDirectory($queueName);
221			$iterator = new \GlobIterator($queueDir.DIRECTORY_SEPARATOR.'*.job', \FilesystemIterator::KEY_AS_FILENAME);
222			return $iterator;
223			}
224
225			/**
226			* Retrieves an array of all message files in the queue
227			* @param string $queueName
228			* @return array
229			*/
230			private function getJobFiles($queueName) {
231			$iterator = $this->getJobIterator($queueName);
232			$files = array_keys(iterator_to_array($iterator));
233			return $files;
234			}
235
236			/**
237			* Removes a directory recursively
238			* @param string $directory
239			*/
240			private function removeDirectoryRecursive($directory)
241			{
242			foreach (glob("{$directory}/{,.}[!.,!..]*", GLOB_MARK\|GLOB_BRACE) as $file)
243			{
244			if (is_dir($file)) {
245			$this->removeDirectoryRecursive($file);
246			} else {
247			unlink($file);
248			}
249			}
250			rmdir($directory);
251			}
252			}
253

bernardphp / bernard

GitHub Access Token became invalid

Pull Request — master (#308)

FlatFileDriver::popMessage() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like