RedisService::setupRedisInstance() - Code Metrics - Inspection of "68: Refactored the worker to docker and redis envi..." - janis91/ocr - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#93)

by Janis

created 2017-06-29 21:47 UTC

RedisService::setupRedisInstance() A

↳ Parent: RedisService

Complexity

Conditions	4
Paths	4

Size

Total Lines	19
Code Lines	13

Duplication

Lines	8
Ratio	42.11 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	8
loc	19
rs	9.2
cc	4
eloc	13
nc	4
nop	0

<?php

/**
 * Nextcloud - OCR
 *
 * This file is licensed under the Affero General Public License version 3 or
 * later. See the COPYING file.
 *
 * @author Janis Koehr <[email protected]>
 * @copyright Janis Koehr 2017
 */
namespace OCA\Ocr\Service;

use Exception;
use OCA\Ocr\Db\OcrJob;
use OCA\Ocr\Db\OcrJobMapper;
use OCP\IConfig;
use OCP\IL10N;
use OCP\ILogger;
use OCA\Ocr\Constants\OcrConstants;

/**
 * Class RedisService
 *
 * @package OCA\Ocr\Service
 */
class RedisService {
	
	/**
	 *
	 * @var IConfig
	 */
	private $config;
	
	/**
	 *
	 * @var OcrJobMapper
	 */
	private $mapper;
	
	/**
	 *
	 * @var FileService
	 */
	private $fileService;
	
	/**
	 *
	 * @var ILogger
	 */
	private $logger;
	
	/**
	 *
	 * @var IL10N
	 */
	private $l10n;
	
	/**
	 *
	 * @var string
	 */
	private $redisHost;
	
	/**
	 *
	 * @var integer
	 */
	private $redisPort;
	
	/**
	 *
	 * @var integer
	 */
	private $redisDb;
	
	/**
	 *
	 * @var string
	 */
	private $appName = 'ocr';
	
	/**
	 * QueueService constructor.
	 *
	 * @param OcrJobMapper $mapper        	
	 * @param FileService $fileService        	
	 * @param IConfig $config        	
	 * @param IL10N $l10n        	
	 * @param ILogger $logger        	
	 */
	public function __construct(OcrJobMapper $mapper, FileService $fileService, IConfig $config, IL10N $l10n, ILogger $logger) {
		$this->mapper = $mapper;
		$this->fileService = $fileService;
		$this->logger = $logger;
		$this->l10n = $l10n;
		$this->config = $config;
		$this->redisHost = $this->config->getAppValue ( $this->appName, 'redisHost' );
		$this->redisPort = intval ( $this->config->getAppValue ( $this->appName, 'redisPort' ) );
		$this->redisDb = intval ( $this->config->getAppValue ( $this->appName, 'redisDb' ) );
	}
	
	/**
	 * Inits the client and sends the task to the background worker (async)
	 *
	 * @param OcrJob $job        	
	 * @param string[] $languages        	
	 * @param string $occDir        	
	 */
	public function sendJob($job, $languages, $occDir) {

		try {
			// check for messaging and put everything together
			$redis = $this->setupRedisInstance ();
			
			$job = $this->mapper->insert ( $job );
			$msg = json_encode ( array (
					'id' => $job->getId (),
					'type' => $job->getType (),
					'source' => $job->getSource (),
					'tempFile' => $job->getTempFile (),
					'languages' => $languages 
			) );
			if (! $redis->lPush ( OcrConstants::REDIS_NEW_JOBS_QUEUE, $msg )) {
				throw new NotFoundException ( $this->l10n->t ( 'Could not add files to the redis OCR processing queue.' ) );
			}
		} catch ( Exception $e ) {
			$this->fileService->execRemove ( $job->getTempFile () );
			$job->setStatus ( 'FAILED' );
			$job->setErrorLog ( $this->l10n->t ( 'Could not add files to the redis OCR processing queue.' ) );
			$this->mapper->update ( $job );
			$this->handleException ( $e );
		}
	}
	
	/**
	 * Retrieves all finished jobs from redis and returns them.
	 *
	 * @return string[]
	 */
	public function readingFinishedJobs() {
		try {
			$redis = $this->setupRedisInstance ();
			
			$result = $redis->multi ()->lRange ( OcrConstants::REDIS_FINISHED_JOBS_QUEUE, 0, - 1 )->delete ( OcrConstants::REDIS_FINISHED_JOBS_QUEUE )->exec ();
			$this->logger->debug ( 'Retrieved the following array from redis: {result}', [ 
					'result' => $result [0] 
			] );
			return $result [0];
		} catch ( Exception $e ) {
			$this->handleException ( $e );
		}
	}
	
	/**
	 * Setup the Redis instance and return to whom ever it needs.
	 *
	 * @throws NotFoundException
	 * @return \Redis
	 */
	private function setupRedisInstance() {
		if (! extension_loaded ( 'redis' )) {

			$this->logger->debug ( 'It seems that the message queueing capabilities are not available in your local php installation. Please install php-redis.' );
			throw new NotFoundException ( $this->l10n->t ( 'Message queueing capabilities are missing on the server.' ) );
		}
		
		$redis = new \Redis ();
		if (! $redis->connect ( $this->redisHost, $this->redisPort, 2.5, NULL, 100 )) {
			$this->logger->debug ( 'Cannot connect to Redis.' );
			throw new NotFoundException ( $this->l10n->t ( 'Cannot connect to Redis.' ) );
		}
		if (! $redis->select ( $this->redisDb )) {

			$this->logger->debug ( 'Cannot connect to the right Redis database.' );
			throw new NotFoundException ( $this->l10n->t ( 'Cannot connect to the right Redis database.' ) );
		}
		$redis->setOption ( \Redis::OPT_PREFIX, OcrConstants::REDIS_KEY_PREFIX );
		
		return $redis;
	}
	
	/**
	 * Handle the possible thrown Exceptions from all methods of this class.
	 *
	 * @param Exception $e        	
	 * @throws Exception
	 * @throws NotFoundException
	 */
	private function handleException($e) {
		$this->logger->logException ( $e, [ 
				'message' => 'Exception during message queue processing' 
		] );
		throw $e;
	}
}

1		<?php
2
3		/**
4		* Nextcloud - OCR
5		*
6		* This file is licensed under the Affero General Public License version 3 or
7		* later. See the COPYING file.
8		*
9		* @author Janis Koehr <[email protected]>
10		* @copyright Janis Koehr 2017
11		*/
12		namespace OCA\Ocr\Service;
13
14		use Exception;
15		use OCA\Ocr\Db\OcrJob;
16		use OCA\Ocr\Db\OcrJobMapper;
17		use OCP\IConfig;
18		use OCP\IL10N;
19		use OCP\ILogger;
20		use OCA\Ocr\Constants\OcrConstants;
21
22		/**
23		* Class RedisService
24		*
25		* @package OCA\Ocr\Service
26		*/
27		class RedisService {
28
29		/**
30		*
31		* @var IConfig
32		*/
33		private $config;
34
35		/**
36		*
37		* @var OcrJobMapper
38		*/
39		private $mapper;
40
41		/**
42		*
43		* @var FileService
44		*/
45		private $fileService;
46
47		/**
48		*
49		* @var ILogger
50		*/
51		private $logger;
52
53		/**
54		*
55		* @var IL10N
56		*/
57		private $l10n;
58
59		/**
60		*
61		* @var string
62		*/
63		private $redisHost;
64
65		/**
66		*
67		* @var integer
68		*/
69		private $redisPort;
70
71		/**
72		*
73		* @var integer
74		*/
75		private $redisDb;
76
77		/**
78		*
79		* @var string
80		*/
81		private $appName = 'ocr';
82
83		/**
84		* QueueService constructor.
85		*
86		* @param OcrJobMapper $mapper
87		* @param FileService $fileService
88		* @param IConfig $config
89		* @param IL10N $l10n
90		* @param ILogger $logger
91		*/
92		public function __construct(OcrJobMapper $mapper, FileService $fileService, IConfig $config, IL10N $l10n, ILogger $logger) {
93		$this->mapper = $mapper;
94		$this->fileService = $fileService;
95		$this->logger = $logger;
96		$this->l10n = $l10n;
97		$this->config = $config;
98		$this->redisHost = $this->config->getAppValue ( $this->appName, 'redisHost' );
99		$this->redisPort = intval ( $this->config->getAppValue ( $this->appName, 'redisPort' ) );
100		$this->redisDb = intval ( $this->config->getAppValue ( $this->appName, 'redisDb' ) );
101		}
102
103		/**
104		* Inits the client and sends the task to the background worker (async)
105		*
106		* @param OcrJob $job
107		* @param string[] $languages
108		* @param string $occDir
109		*/
110		public function sendJob($job, $languages, $occDir) {
		0 ignored issues – show Unused Code introduced 2017-06-18 21:07 UTC by Report Bug Copy Issue Report The parameter `$occDir` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
111		try {
112		// check for messaging and put everything together
113		$redis = $this->setupRedisInstance ();
114
115		$job = $this->mapper->insert ( $job );
116		$msg = json_encode ( array (
117		'id' => $job->getId (),
118		'type' => $job->getType (),
119		'source' => $job->getSource (),
120		'tempFile' => $job->getTempFile (),
121		'languages' => $languages
122		) );
123		if (! $redis->lPush ( OcrConstants::REDIS_NEW_JOBS_QUEUE, $msg )) {
124		throw new NotFoundException ( $this->l10n->t ( 'Could not add files to the redis OCR processing queue.' ) );
125		}
126		} catch ( Exception $e ) {
127		$this->fileService->execRemove ( $job->getTempFile () );
128		$job->setStatus ( 'FAILED' );
129		$job->setErrorLog ( $this->l10n->t ( 'Could not add files to the redis OCR processing queue.' ) );
130		$this->mapper->update ( $job );
131		$this->handleException ( $e );
132		}
133		}
134
135		/**
136		* Retrieves all finished jobs from redis and returns them.
137		*
138		* @return string[]
139		*/
140		public function readingFinishedJobs() {
141		try {
142		$redis = $this->setupRedisInstance ();
143
144		$result = $redis->multi ()->lRange ( OcrConstants::REDIS_FINISHED_JOBS_QUEUE, 0, - 1 )->delete ( OcrConstants::REDIS_FINISHED_JOBS_QUEUE )->exec ();
145		$this->logger->debug ( 'Retrieved the following array from redis: {result}', [
146		'result' => $result [0]
147		] );
148		return $result [0];
149		} catch ( Exception $e ) {
150		$this->handleException ( $e );
151		}
152		}
153
154		/**
155		* Setup the Redis instance and return to whom ever it needs.
156		*
157		* @throws NotFoundException
158		* @return \Redis
159		*/
160		private function setupRedisInstance() {
161	View Code Duplication	if (! extension_loaded ( 'redis' )) {
		0 ignored issues – show Duplication introduced 2017-06-18 21:07 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
162		$this->logger->debug ( 'It seems that the message queueing capabilities are not available in your local php installation. Please install php-redis.' );
163		throw new NotFoundException ( $this->l10n->t ( 'Message queueing capabilities are missing on the server.' ) );
164		}
165
166		$redis = new \Redis ();
167		if (! $redis->connect ( $this->redisHost, $this->redisPort, 2.5, NULL, 100 )) {
168		$this->logger->debug ( 'Cannot connect to Redis.' );
169		throw new NotFoundException ( $this->l10n->t ( 'Cannot connect to Redis.' ) );
170		}
171	View Code Duplication	if (! $redis->select ( $this->redisDb )) {
		0 ignored issues – show Duplication introduced 2017-06-25 14:17 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
172		$this->logger->debug ( 'Cannot connect to the right Redis database.' );
173		throw new NotFoundException ( $this->l10n->t ( 'Cannot connect to the right Redis database.' ) );
174		}
175		$redis->setOption ( \Redis::OPT_PREFIX, OcrConstants::REDIS_KEY_PREFIX );
176
177		return $redis;
178		}
179
180		/**
181		* Handle the possible thrown Exceptions from all methods of this class.
182		*
183		* @param Exception $e
184		* @throws Exception
185		* @throws NotFoundException
186		*/
187		private function handleException($e) {
188		$this->logger->logException ( $e, [
189		'message' => 'Exception during message queue processing'
190		] );
191		throw $e;
192		}
193		}

janis91 / ocr

Pull Request — master (#93)

RedisService::setupRedisInstance() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like