Queue::delete_messages() - Code Metrics - Inspection of "* ooops, логическая ошибка копирования объекта" - nokitakaze/php-queue - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — developer ( dc3c7c...6e5def )

by Никита

created 2017-10-06 17:29 UTC

Queue::delete_messages() A

↳ Parent: Queue

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	8
ccs	6
cts	6
cp	1
rs	9.4285
cc	2
eloc	5
nc	2
nop	1
crap	2

<?php

    namespace NokitaKaze\Queue;

    class Queue extends AbstractQueueTransport {
        const ProducerThreadCount = 5;
        const DefaultDBFileCount = 10;
        const DefaultMessageFolderSubfolderCount = 10;

        const StorageTemporary = 0;
        const StoragePersistent = 1;

        /**
         * @var QueueTransport
         */
        protected $_general_queue = null;

        /**
         * @var QueueTransport[]
         */
        protected $_additional_queue = [];

        /**
         * @var GeneralQueueConstructionSettings|object $_settings
         */
        protected $_settings = null;

        /**
         * SmartQueue constructor.
         *
         * @param GeneralQueueConstructionSettings|object $settings
         *
         * @throws QueueException
         */
        function __construct($settings) {

            $this->_settings = $settings;
            foreach ($settings->queues as $queue_settings) {
                /**
                 * @var string|QueueTransport $queue_class_name
                 * @var QueueTransport        $queue
                 */
                if (substr($queue_settings->class_name, 0, 1) == '\\') {
                    $queue_class_name = $queue_settings->class_name.'QueueTransport';
                } else {
                    $queue_class_name = __NAMESPACE__.'\\'.$queue_settings->class_name.'QueueTransport';
                }
                $queue = new $queue_class_name($queue_settings);

                if (isset($queue_settings->is_general) and $queue_settings->is_general) {
                    if (isset($this->_general_queue)) {
                        throw new QueueException('Two or more general queues');
                    }
                    $this->_general_queue = $queue;
                    $this->_additional_queue[] = clone $queue;
                } else {
                    $this->_additional_queue[] = $queue;
                }
            }
            if (is_null($this->_general_queue)) {
                throw new QueueException('Can not get general queue');
            }
            // @todo дописать
        }

        /**
         * @return string
         */
        static function generate_rnd_postfix() {

            // mt_rand. **ДЁШЕВО** и сердито
            return mt_rand(1000000, 9999999).mt_rand(1000000, 9999999);

            // return RandomString::generate(6, RandomString::INCLUDE_NUMERIC | RandomString::INCLUDE_LOWER_LETTERS);
        }

        /**
         * Формируем сообщение для очереди
         *
         * @param mixed       $data
         * @param string|null $name Название сообщения. Если null, то можно дублировать
         * @param integer     $sort
         *
         * @return iMessage|object
         */
        static function build_message($data, $name = null, $sort = 5) {

            return (object) [
                'name' => is_null($name) ? null : (string) $name,
                'data' => $data,
                'time_created' => microtime(true),
                'time_rnd_postfix' => is_null($name) ? static::generate_rnd_postfix() : null,
                'time_last_update' => microtime(true),
                'sort' => min(max($sort, 0), self::DefaultDBFileCount - 1),
                'is_read' => false,
            ];
        }

        /**
         * @param iMessage|object $object
         *
         * @return iMessage|object
         * @throws QueueException
         */
        static function sanify_event_object($object) {

            $ret = clone $object;
            /** @noinspection PhpParamsInspection */
            if (!array_key_exists('name', $ret)) {
                $ret->name = null;
            }
            /** @noinspection PhpParamsInspection */
            if (!array_key_exists('data', $ret)) {
                throw new QueueException('Datum does not have field data', 12);
            }
            if (!isset($ret->sort)) {
                $ret->sort = 5;
            } else {
                $ret->sort = min(max($ret->sort, 0), Queue::DefaultDBFileCount - 1);
            }

            return $ret;
        }

        /**
         * Cloning sub queues
         */
        function __clone() {

            parent::__clone();
            $this->_general_queue = clone $this->_general_queue;
            foreach ($this->_additional_queue as &$sub_queue) {
                $sub_queue = clone $sub_queue;
            }
        }

        /**
         * implements Transport
         */

        /**
         * @param iMessage|object $message
         *
         * @return string
         */
        static function get_real_key_for_message($message) {

            return !is_null($message->name)
                ? $message->name
                : sprintf('_%s%s',
                    number_format($message->time_created, 7, '.', ''),
                    isset($message->time_rnd_postfix) ? '_'.$message->time_rnd_postfix : ''
                );
        }

        function get_queue_name() {

            return $this->_settings->name;
        }

        static function is_support_sorted_events() {

            return false;
        }

        function produce_message($data, $name = null, $sort = 5) {

            $this->set_same_time_flag(1);
            $this->_general_queue->produce_message($data, $name, $sort);
        }

        function save() {

            $this->set_same_time_flag(1);
            $this->_general_queue->push($this->_pushed_for_save);
            $this->_pushed_for_save = [];
            $this->_general_queue->save();
        }

        function set_exclusive_mode($mode) {

            $this->_general_queue->set_exclusive_mode($mode);
            foreach ($this->_additional_queue as $queue) {
                $queue->set_exclusive_mode($mode);
            }
        }

        /**
         * @var iMessage[]|object[]
         */
        protected $_next_messages = [];

        function consume_next_message($wait_time = -1) {

            $this->set_same_time_flag(2);
            if (!empty($this->_next_messages)) {
                return array_shift($this->_next_messages);
            }
            $ts_start = microtime(true);
            $till_time = $ts_start + $wait_time;

            $first_run = false;
            do {
                if ($first_run) {
                    usleep($this->_settings->sleep_time_while_consuming * 1000000);
                } else {
                    $first_run = true;
                }
                $messages = [];
                foreach ($this->_additional_queue as $queue) {
                    while ($message = $queue->consume_next_message(0)) {
                        $key = self::get_real_key_for_message($message);
                        if (isset($this->_consumed_keys[$key])) {
                            continue;
                        }
                        $message->is_read = true;
                        $messages[] = $message;
                        $this->_consumed_keys[$key] = 1;
                    }

                    if (!empty($messages)) {
                        $this->_next_messages = $messages;
                        if (!$queue->is_equal_to($this->_general_queue)) {
                            $this->_general_queue->push($messages);
                            $this->_general_queue->save();
                            $queue->delete_messages($messages);
                        }

                        return array_shift($this->_next_messages);
                    }
                }
                unset($message, $key, $queue);
            } while (($wait_time == -1) or (microtime(true) <= $till_time));

            return null;
        }

        /**
         * Обновляем сообщение и сразу же сохраняем всё
         *
         * Эта функция не рейзит ошибку, если сообщение не найдено
         *
         * @param iMessage|object $message
         * @param string|null     $key форсированно задаём ключ сообщения
         *
         * @return boolean
         * @throws QueueException
         */
        function update_message($message, $key = null) {

            $this_key = !is_null($key) ? $key : self::get_real_key_for_message($message);
            foreach ($this->_next_messages as $exists_message) {
                if (self::get_real_key_for_message($exists_message) == $this_key) {
                    $exists_message->data = $message->data;
                    $exists_message->time_last_update = microtime(true);
                    break;
                }
            }

            return $this->_general_queue->update_message($message, $key);
        }

        function clear_consumed_keys() {

            $this->_consumed_keys = [];
            foreach ($this->_additional_queue as $queue) {
                $queue->clear_consumed_keys();
            }
        }

        /**
         * Удалить сообщения и сразу же записать это в БД
         *
         * @param iMessage[]|object[] $messages
         *
         * @return string[]|integer[]
         */
        function delete_messages(array $messages) {

            $deleted_keys = [];
            foreach ($this->_additional_queue as $queue) {
                $deleted_keys = array_merge($deleted_keys, $queue->delete_messages($messages));
            }

            return array_unique($deleted_keys);
        }

        /**
         * @param Queue $queue
         *
         * @return boolean
         */
        function is_equal_to($queue) {

            if (spl_object_hash($this) == spl_object_hash($queue)) {
                return true;
            }
            if (!parent::is_equal_to($queue)) {
                return false;
            }
            if (!$this->_general_queue->is_equal_to($queue->_general_queue)) {
                return false;
            }
            foreach ($this->_additional_queue as $i => $sub_queue) {
                if (!$sub_queue->is_equal_to($queue->_additional_queue[$i])) {
                    return false;
                }
            }

            return true;
        }
    }

?>

1		<?php
2
3		namespace NokitaKaze\Queue;
4
5		class Queue extends AbstractQueueTransport {
6		const ProducerThreadCount = 5;
7		const DefaultDBFileCount = 10;
8		const DefaultMessageFolderSubfolderCount = 10;
9
10		const StorageTemporary = 0;
11		const StoragePersistent = 1;
12
13		/**
14		* @var QueueTransport
15		*/
16		protected $_general_queue = null;
17
18		/**
19		* @var QueueTransport[]
20		*/
21		protected $_additional_queue = [];
22
23		/**
24		* @var GeneralQueueConstructionSettings\|object $_settings
25		*/
26		protected $_settings = null;
27
28		/**
29		* SmartQueue constructor.
30		*
31		* @param GeneralQueueConstructionSettings\|object $settings
32		*
33		* @throws QueueException
34		*/
35	27	function __construct($settings) {
		1 ignored issue – show Best Practice introduced 2017-10-05 11:47 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
36	27	$this->_settings = $settings;
37	27	foreach ($settings->queues as $queue_settings) {
38		/**
39		* @var string\|QueueTransport $queue_class_name
40		* @var QueueTransport $queue
41		*/
42	27	if (substr($queue_settings->class_name, 0, 1) == '\\') {
43		$queue_class_name = $queue_settings->class_name.'QueueTransport';
44		} else {
45	27	$queue_class_name = __NAMESPACE__.'\\'.$queue_settings->class_name.'QueueTransport';
46		}
47	27	$queue = new $queue_class_name($queue_settings);
48
49	27	if (isset($queue_settings->is_general) and $queue_settings->is_general) {
50	27	if (isset($this->_general_queue)) {
51		throw new QueueException('Two or more general queues');
52		}
53	27	$this->_general_queue = $queue;
54	27	$this->_additional_queue[] = clone $queue;
55	9	} else {
56	24	$this->_additional_queue[] = $queue;
57		}
58	9	}
59	27	if (is_null($this->_general_queue)) {
60		throw new QueueException('Can not get general queue');
61		}
62		// @todo дописать
63	27	}
64
65		/**
66		* @return string
67		*/
68	3701	static function generate_rnd_postfix() {
		1 ignored issue – show Best Practice introduced 2017-10-06 16:14 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
69		// mt_rand. ДЁШЕВО и сердито
70	3701	return mt_rand(1000000, 9999999).mt_rand(1000000, 9999999);
71
72		// return RandomString::generate(6, RandomString::INCLUDE_NUMERIC \| RandomString::INCLUDE_LOWER_LETTERS);
73		}
74
75		/**
76		* Формируем сообщение для очереди
77		*
78		* @param mixed $data
79		* @param string\|null $name Название сообщения. Если null, то можно дублировать
80		* @param integer $sort
81		*
82		* @return iMessage\|object
83		*/
84	3702	static function build_message($data, $name = null, $sort = 5) {
		1 ignored issue – show Best Practice introduced 2017-10-05 11:47 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
85		return (object) [
86	3702	'name' => is_null($name) ? null : (string) $name,
87	3702	'data' => $data,
88	3702	'time_created' => microtime(true),
89	3702	'time_rnd_postfix' => is_null($name) ? static::generate_rnd_postfix() : null,
90	3702	'time_last_update' => microtime(true),
91	3702	'sort' => min(max($sort, 0), self::DefaultDBFileCount - 1),
92	1205	'is_read' => false,
93	1205	];
94		}
95
96		/**
97		* @param iMessage\|object $object
98		*
99		* @return iMessage\|object
100		* @throws QueueException
101		*/
102	3699	static function sanify_event_object($object) {
		1 ignored issue – show Best Practice introduced 2017-10-05 11:47 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
103	3699	$ret = clone $object;
104		/** @noinspection PhpParamsInspection */
105	3699	if (!array_key_exists('name', $ret)) {
106	3	$ret->name = null;
107	1	}
108		/** @noinspection PhpParamsInspection */
109	3699	if (!array_key_exists('data', $ret)) {
110	3	throw new QueueException('Datum does not have field data', 12);
111		}
112	3699	if (!isset($ret->sort)) {
113	3	$ret->sort = 5;
114	1	} else {
115	3696	$ret->sort = min(max($ret->sort, 0), Queue::DefaultDBFileCount - 1);
116		}
117
118	3699	return $ret;
119		}
120
121		/**
122		* Cloning sub queues
123		*/
124	1266	function __clone() {
		1 ignored issue – show Best Practice introduced 2017-10-05 11:47 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
125	1266	parent::__clone();
126	1266	$this->_general_queue = clone $this->_general_queue;
127	1266	foreach ($this->_additional_queue as &$sub_queue) {
128	1266	$sub_queue = clone $sub_queue;
129	422	}
130	1266	}
131
132		/**
133		* implements Transport
134		*/
135
136		/**
137		* @param iMessage\|object $message
138		*
139		* @return string
140		*/
141	3822	static function get_real_key_for_message($message) {
		1 ignored issue – show Best Practice introduced 2017-10-05 11:47 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
142	3822	return !is_null($message->name)
143	3737	? $message->name
144	3799	: sprintf('_%s%s',
145	3788	number_format($message->time_created, 7, '.', ''),
146	3811	isset($message->time_rnd_postfix) ? '_'.$message->time_rnd_postfix : ''
147	1245	);
148		}
149
150	6	function get_queue_name() {
		1 ignored issue – show Best Practice introduced 2017-10-06 15:44 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
151	6	return $this->_settings->name;
152		}
153
154	3	static function is_support_sorted_events() {
		1 ignored issue – show Best Practice introduced 2017-10-05 11:47 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
155	3	return false;
156		}
157
158	15	function produce_message($data, $name = null, $sort = 5) {
		1 ignored issue – show Best Practice introduced 2017-10-05 11:47 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
159	15	$this->set_same_time_flag(1);
160	15	$this->_general_queue->produce_message($data, $name, $sort);
161	15	}
162
163	1245	function save() {
		1 ignored issue – show Best Practice introduced 2017-10-05 11:47 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
164	1245	$this->set_same_time_flag(1);
165	1245	$this->_general_queue->push($this->_pushed_for_save);
166	1245	$this->_pushed_for_save = [];
167	1245	$this->_general_queue->save();
168	1245	}
169
170		function set_exclusive_mode($mode) {
		1 ignored issue – show Best Practice introduced 2017-10-05 11:47 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
171		$this->_general_queue->set_exclusive_mode($mode);
172		foreach ($this->_additional_queue as $queue) {
173		$queue->set_exclusive_mode($mode);
174		}
175		}
176
177		/**
178		* @var iMessage[]\|object[]
179		*/
180		protected $_next_messages = [];
181
182	1254	function consume_next_message($wait_time = -1) {
		1 ignored issue – show Best Practice introduced 2017-10-05 11:47 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
183	1254	$this->set_same_time_flag(2);
184	1254	if (!empty($this->_next_messages)) {
185	1143	return array_shift($this->_next_messages);
186		}
187	1254	$ts_start = microtime(true);
188	1254	$till_time = $ts_start + $wait_time;
189
190	1254	$first_run = false;
191		do {
192	1254	if ($first_run) {
193	24	usleep($this->_settings->sleep_time_while_consuming * 1000000);
194	8	} else {
195	1254	$first_run = true;
196		}
197	1254	$messages = [];
198	1254	foreach ($this->_additional_queue as $queue) {
199	1254	while ($message = $queue->consume_next_message(0)) {
200	1254	$key = self::get_real_key_for_message($message);
201	1254	if (isset($this->_consumed_keys[$key])) {
202	1230	continue;
203		}
204	1254	$message->is_read = true;
205	1254	$messages[] = $message;
206	1254	$this->_consumed_keys[$key] = 1;
207	418	}
208
209	1254	if (!empty($messages)) {
210	1254	$this->_next_messages = $messages;
211	1254	if (!$queue->is_equal_to($this->_general_queue)) {
212	1242	$this->_general_queue->push($messages);
213	1242	$this->_general_queue->save();
214	1242	$queue->delete_messages($messages);
215	414	}
216
217	1254	return array_shift($this->_next_messages);
218		}
219	417	}
220	1239	unset($message, $key, $queue);
221	1239	} while (($wait_time == -1) or (microtime(true) <= $till_time));
222
223	1239	return null;
224		}
225
226		/**
227		* Обновляем сообщение и сразу же сохраняем всё
228		*
229		* Эта функция не рейзит ошибку, если сообщение не найдено
230		*
231		* @param iMessage\|object $message
232		* @param string\|null $key форсированно задаём ключ сообщения
233		*
234		* @return boolean
235		* @throws QueueException
236		*/
237	120	function update_message($message, $key = null) {
		1 ignored issue – show Best Practice introduced 2017-10-05 11:47 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
238	120	$this_key = !is_null($key) ? $key : self::get_real_key_for_message($message);
239	120	foreach ($this->_next_messages as $exists_message) {
240		if (self::get_real_key_for_message($exists_message) == $this_key) {
241		$exists_message->data = $message->data;
242		$exists_message->time_last_update = microtime(true);
243		break;
244		}
245	40	}
246
247	120	return $this->_general_queue->update_message($message, $key);
248		}
249
250	3	function clear_consumed_keys() {
		1 ignored issue – show Best Practice introduced 2017-10-05 11:47 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
251	3	$this->_consumed_keys = [];
252	3	foreach ($this->_additional_queue as $queue) {
253	3	$queue->clear_consumed_keys();
254	1	}
255	3	}
256
257		/**
258		* Удалить сообщения и сразу же записать это в БД
259		*
260		* @param iMessage[]\|object[] $messages
261		*
262		* @return string[]\|integer[]
263		*/
264	1092	function delete_messages(array $messages) {
		1 ignored issue – show Best Practice introduced 2017-10-05 11:47 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
265	1092	$deleted_keys = [];
266	1092	foreach ($this->_additional_queue as $queue) {
267	1092	$deleted_keys = array_merge($deleted_keys, $queue->delete_messages($messages));
268	364	}
269
270	1092	return array_unique($deleted_keys);
271		}
272
273		/**
274		* @param Queue $queue
275		*
276		* @return boolean
277		*/
278	3	function is_equal_to($queue) {
		1 ignored issue – show Best Practice introduced 2017-10-05 11:47 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
279	3	if (spl_object_hash($this) == spl_object_hash($queue)) {
280	3	return true;
281		}
282	3	if (!parent::is_equal_to($queue)) {
283		return false;
284		}
285	3	if (!$this->_general_queue->is_equal_to($queue->_general_queue)) {
286		return false;
287		}
288	3	foreach ($this->_additional_queue as $i => $sub_queue) {
289	3	if (!$sub_queue->is_equal_to($queue->_additional_queue[$i])) {
290	2	return false;
291		}
292	1	}
293
294	3	return true;
295		}
296		}
297
298		?>

nokitakaze / php-queue

Push — developer ( dc3c7c...6e5def )

Queue::delete_messages() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like