janis91 / ocr

lib/Service/GearmanWorkerService.php

Doc Comments +1 added lines, -1 removed lines

@@ -38,7 +38,7 @@
 	/**
 	 * Checks if a worker is active and registered at the Gearman Job Server.
 	 * returns false if not.
-	 * @return bool
+	 * @return boolean|null
 	 */
 	public function workerExists(){
 		try {

Spacing +4 added lines, -4 removed lines

@@ -40,7 +40,7 @@ 
 	 * returns false if not.
 	 * @return bool
 	 */
-	public function workerExists(){
+	public function workerExists() {
 		try {
 			$checkCommand = 'gearadmin -h 127.0.0.1 -p 4730 --workers 2>&1';
 			exec($checkCommand, $result, $success);
@@ -48,15 +48,15 @@ 
 				throw new NotFoundException('Gearman worker detection failed.');
 			}
 			// look into the resulting array. 3 because first row is the ps checking command, second row is the grep command separated from the ps and 3rd or more has to be the GearmanOCRWorker.php.
-			foreach ($result as $res){
-				if(strpos($res, 'ocr') !== false){
+			foreach ($result as $res) {
+				if (strpos($res, 'ocr') !== false) {
 					$this->logger->debug('Worker found.', ['app' => 'ocr']);
 					return true;
 				}
 			}
 			$this->logger->debug('No worker found.', ['app' => 'ocr']);
 			return false;
-		} catch (Exception $e){
+		} catch (Exception $e) {
 			$this->handleException($e);
 		}
 	}

lib/Service/OcrService.php

Doc Comments +4 added lines, -3 removed lines

@@ -130,7 +130,7 @@ 
 	 * Processes and prepares the files for ocr.
 	 * Sends the stuff to the gearman client in order to ocr async.
 	 *
-	 * @param $language
+	 * @param string $language
 	 * @param array $files
 	 * @return string
 	 */
@@ -199,7 +199,7 @@ 
 	 * the gearman worker should call it automatically after each processing step.
 	 *
 	 * @param $statusId
-	 * @param $failed
+	 * @param boolean $failed
 	 */
 	public function complete($statusId, $failed){
 		try{
@@ -334,12 +334,13 @@ 
 
 	/**
 	 * Inits the Gearman client and sends the task to the background worker (async)
-	 * @param $type
+	 * @param string $type
 	 * @param $datadirectory
 	 * @param $path
 	 * @param $tempFile
 	 * @param $language
 	 * @param $statusId
+	 * @param OcrStatus $status
 	 */
 	private function sendGearmanJob($type, $datadirectory, $path, $tempFile, $language, $status, $occDir){
 		try {

Spacing +43 added lines, -43 removed lines

@@ -98,7 +98,7 @@ 
 	 *
 	 * @return array Languages
 	 */
-	public function listLanguages(){
+	public function listLanguages() {
 		try {
 			$success = -1;
 			$this->logger->debug('Fetching languages. ', ['app' => 'ocr']);
@@ -116,12 +116,12 @@ 
 						array_push($languages, $tdname);
 					}
 				}
-				$this->logger->debug('Fetched languages: '.json_encode($languages), ['app' => 'ocr']);
+				$this->logger->debug('Fetched languages: ' . json_encode($languages), ['app' => 'ocr']);
 				return $languages;
 			} else {
 				throw new NotFoundException('No languages found.');
 			}
-		}catch(Exception $e){
+		} catch (Exception $e) {
 			$this->handleException($e);
 		}
 	}
@@ -136,12 +136,12 @@ 
 	 */
 	public function process($language, $files) {
 		try {
-			$this->logger->debug('Will now process files: '.json_encode($files) . ' with language: ' . json_encode($language), ['app' => 'ocr']);
+			$this->logger->debug('Will now process files: ' . json_encode($files) . ' with language: ' . json_encode($language), ['app' => 'ocr']);
 			// Check if $files and $language not empty
-			if(!empty($files) && !empty($language) && in_array($language, $this->listLanguages())){
+			if (!empty($files) && !empty($language) && in_array($language, $this->listLanguages())) {
 				// get the array with full fileinfo
 				$fileInfo = $this->buildFileInfo($files);
-				foreach ($fileInfo as $fInfo){
+				foreach ($fileInfo as $fInfo) {
 					// Check if filelock existing
 					// TODO: FileLock maybe \OC\Files\View::lockFile()
 					// get new name for saving purpose
@@ -151,9 +151,9 @@ 
 					$tempFile = $this->tempM->getTemporaryFile();
 
 					// set the gearman running type
-					if($fInfo->getMimetype() === $this::MIMETYPE_PDF){
+					if ($fInfo->getMimetype() === $this::MIMETYPE_PDF) {
 						$ftype = 'mypdf';
-					}else{
+					} else {
 						$ftype = 'tess';
 					}
 
@@ -165,10 +165,10 @@ 
 					$this->sendGearmanJob($ftype, $this->config->getSystemValue('datadirectory'), $fInfo->getPath(), $tempFile, $language, $status, \OC::$SERVERROOT);
 				}
 				return 'PROCESSING';
-			}else{
+			} else {
 				throw new NotFoundException('Empty parameters.');
 			}
-		}catch(Exception $e){
+		} catch (Exception $e) {
 			$this->handleException($e);
 		}
 	}
@@ -179,7 +179,7 @@ 
 	 *
 	 * @return string
 	 */
-	public function status(){
+	public function status() {
 		try {
 			// TODO: release lock
 			$processed = $this->handleProcessed();
@@ -189,7 +189,7 @@ 
 			$pending = count($this->statusMapper->findAllPending($this->userId));
 
 			return ['processed' => $processed, 'failed' => $failed, 'pending' => $pending];
-		}catch (Exception $e){
+		} catch (Exception $e) {
 			$this->handleException($e);
 		}
 	}
@@ -201,18 +201,18 @@ 
 	 * @param $statusId
 	 * @param $failed
 	 */
-	public function complete($statusId, $failed){
-		try{
+	public function complete($statusId, $failed) {
+		try {
 			$status = $this->statusMapper->find($statusId);
-			if(!$failed) {
+			if (!$failed) {
 				$status->setStatus('PROCESSED');
 				$this->statusMapper->update($status);
-			}else{
+			} else {
 				$status->setStatus('FAILED');
 				$this->statusMapper->update($status);
 			}
-		} catch (Exception $e){
-			if ($e instanceof NotFoundException){
+		} catch (Exception $e) {
+			if ($e instanceof NotFoundException) {
 				$status->setStatus('FAILED');
 				$this->statusMapper->update($status);
 				$this->handleException($e);
@@ -227,28 +227,28 @@ 
 	 *
 	 * @return int
 	 */
-	private function handleProcessed(){
+	private function handleProcessed() {
 		try {
 			$this->logger->debug('Find processed ocr files and put them to the right dirs.', ['app' => 'ocr']);
 			$processed = $this->statusMapper->findAllProcessed($this->userId);
 			foreach ($processed as $status) {
-				if ($status->getType() === 'tess' && file_exists($status->getTempFile().'.txt')) {
+				if ($status->getType() === 'tess' && file_exists($status->getTempFile() . '.txt')) {
 					//Save the tmp file with newname
-					$this->view->file_put_contents($status->getNewName(), file_get_contents($status->getTempFile() . '.txt'));// need .txt because tesseract saves it like this
+					$this->view->file_put_contents($status->getNewName(), file_get_contents($status->getTempFile() . '.txt')); // need .txt because tesseract saves it like this
 					// Cleaning temp files
 					$this->statusMapper->delete($status);
 					exec('rm ' . $status->getTempFile() . '.txt');
 				} elseif ($status->getType() === 'mypdf' && file_exists($status->getTempFile())) {
 					//Save the tmp file with newname
-					$this->view->file_put_contents($status->getNewName(), file_get_contents($status->getTempFile()));// don't need to extend with .pdf / it uses the tmp file to save
+					$this->view->file_put_contents($status->getNewName(), file_get_contents($status->getTempFile())); // don't need to extend with .pdf / it uses the tmp file to save
 					$this->statusMapper->delete($status);
 					exec('rm ' . $status->getTempFile());
-				}else{
+				} else {
 					throw new NotFoundException('Temp file does not exist.');
 				}
 			}
 			return count($processed);
-		}catch (Exception $e){
+		} catch (Exception $e) {
 			$this->handleException($e);
 		}
 	}
@@ -258,7 +258,7 @@ 
 	 *
 	 * @return array
 	 */
-	private function handleFailed(){
+	private function handleFailed() {
 		try {
 			$failed = $this->statusMapper->findAllFailed($this->userId);
 			foreach ($failed as $status) {
@@ -267,9 +267,9 @@ 
 				// clean from db
 				$this->statusMapper->delete($status);
 			}
-			$this->logger->debug('Following status objects failed: '.json_encode($failed), ['app' => 'ocr']);
+			$this->logger->debug('Following status objects failed: ' . json_encode($failed), ['app' => 'ocr']);
 			return $failed;
-		}catch (Exception $e){
+		} catch (Exception $e) {
 			$this->handleException($e);
 		}
 	}
@@ -281,19 +281,19 @@ 
 	 * @param Files\FileInfo $fileInfo
 	 * @return string
 	 */
-	private function buildNewName(Files\FileInfo $fileInfo){
+	private function buildNewName(Files\FileInfo $fileInfo) {
 		// get rid of the .png or .pdf and so on
-		$fileName = substr($fileInfo->getName(),0,-4);
+		$fileName = substr($fileInfo->getName(), 0, -4);
 		// eliminate the file name from the path
-		$filePath = str_replace($fileInfo->getName(),'',$fileInfo->getPath());
+		$filePath = str_replace($fileInfo->getName(), '', $fileInfo->getPath());
 		// and get the path on top of the user/files/ dir
-		$filePath = str_replace('/'.$this->userId.'/files','',$filePath);
-		if($fileInfo->getMimetype() === $this::MIMETYPE_PDF){
+		$filePath = str_replace('/' . $this->userId . '/files', '', $filePath);
+		if ($fileInfo->getMimetype() === $this::MIMETYPE_PDF) {
 			// PDFs:
-			return Files::buildNotExistingFileName($filePath, $fileName.'_OCR.pdf');
+			return Files::buildNotExistingFileName($filePath, $fileName . '_OCR.pdf');
 		} else {
 			// IMAGES:
-			return Files::buildNotExistingFileName($filePath, $fileName.'_OCR.txt');
+			return Files::buildNotExistingFileName($filePath, $fileName . '_OCR.txt');
 		}
 	}
 
@@ -305,16 +305,16 @@ 
 	 * @return array of Files\FileInfo
 	 * @throws NotFoundException
 	 */
-	private function buildFileInfo(array $files){
+	private function buildFileInfo(array $files) {
 		try {
 			$fileArray = array();
 			foreach ($files as $file) {
 				if ((!empty($file['path']) || !empty($file['directory'])) && $file['type'] === 'file') {
-					if(empty($file['path'])){ $file['path'] = $file['directory']; } //Because new updated files have the property directory instead of path
-					if($file['path'] === '/'){
-						$path = ''. '/' . $file['name'];
-					}else{
-						$path = $file['path']. '/' . $file['name'];
+					if (empty($file['path'])) { $file['path'] = $file['directory']; } //Because new updated files have the property directory instead of path
+					if ($file['path'] === '/') {
+						$path = '' . '/' . $file['name'];
+					} else {
+						$path = $file['path'] . '/' . $file['name'];
 					}
 					$fileInfo = $this->view->getFileInfo($path);
 					if (!$fileInfo || !in_array($fileInfo->getMimetype(), $this::ALLOWED_MIMETYPES)) {
@@ -341,15 +341,15 @@ 
 	 * @param $language
 	 * @param $statusId
 	 */
-	private function sendGearmanJob($type, $datadirectory, $path, $tempFile, $language, $status, $occDir){
+	private function sendGearmanJob($type, $datadirectory, $path, $tempFile, $language, $status, $occDir) {
 		try {
-			if(!$this->workerService->workerExists()){
+			if (!$this->workerService->workerExists()) {
 				throw new NotFoundException('No gearman worker exists.');
 			}
 			$this->statusMapper->insert($status);
 			// Gearman thing
 			$client = new \GearmanClient();
-			$client->addServer('127.0.0.1',4730);
+			$client->addServer('127.0.0.1', 4730);
 			$result = $client->doBackground("ocr", json_encode(array(
 				'type' => $type,
 				'datadirectory' => $datadirectory,

lib/Db/OcrStatusMapper.php

Spacing +1 added lines, -1 removed lines

@@ -36,7 +36,7 @@
 	 * @param $id
 	 * @return \OCP\AppFramework\Db\Entity
 	 */
-	public function find($id){
+	public function find($id) {
 		$sql = 'SELECT * FROM *PREFIX*ocr_status WHERE id = ?';
 		return $this->findEntity($sql, [$id]);
 	}

lib/AppInfo/Application.php

Spacing +2 added lines, -2 removed lines

@@ -64,7 +64,7 @@ 
 		/**
 		 * Register the Gearman Worker Service
 		 */
-		$container->registerService('GearmanWorkerService', function (IAppContainer $c){
+		$container->registerService('GearmanWorkerService', function(IAppContainer $c) {
 			/** @var \OC\Server $server */
 			$server = $c->query('ServerContainer');
 			return new GearmanWorkerService(
@@ -94,7 +94,7 @@ 
 				$server->getConfig(),
 				$c->query('GearmanWorkerService'),
 				$c->query('OcrStatusMapper'),
-				new View('/'.$c->query('CurrentUID').'/files'),
+				new View('/' . $c->query('CurrentUID') . '/files'),
 				$c->query('CurrentUID'),
 				$server->getLogger()
 			);

lib/Controller/Errors.php

Spacing +2 added lines, -2 removed lines

@@ -30,10 +30,10 @@
 	 * @param Closure $callback
 	 * @return DataResponse
 	 */
-	protected function handleNotFound (Closure $callback) {
+	protected function handleNotFound(Closure $callback) {
 		try {
 			return new DataResponse($callback());
-		} catch(NotFoundException $e) {
+		} catch (NotFoundException $e) {
 			return new DataResponse($e->getMessage(), Http::STATUS_NOT_FOUND);
 		}
 	}

lib/Controller/OcrController.php

Spacing +6 added lines, -6 removed lines

@@ -45,7 +45,7 @@ 
 	 * @param OcrService $service
 	 * @param $UserId
 	 */
-	public function __construct($AppName, IRequest $request, OcrService $service, $UserId){
+	public function __construct($AppName, IRequest $request, OcrService $service, $UserId) {
 		parent::__construct($AppName, $request);
 		$this->userId = $UserId;
 		$this->service = $service;
@@ -56,8 +56,8 @@ 
 	 * @NoAdminRequired
 	 * @return DataResponse
 	 */
-	public function languages(){
-		return $this->handleNotFound(function(){
+	public function languages() {
+		return $this->handleNotFound(function() {
 			return $this->service->listLanguages();
 		});
 	}
@@ -70,7 +70,7 @@ 
 	 * @return DataResponse
 	 */
 	public function process($language, $files) {
-		return $this->handleNotFound(function () use ($language, $files){
+		return $this->handleNotFound(function() use ($language, $files){
 			return $this->service->process($language, $files);
 		});
 	}
@@ -80,8 +80,8 @@ 
 	 * @NoAdminRequired
 	 * @return DataResponse
 	 */
-	public function status(){
-		return $this->handleNotFound(function () {
+	public function status() {
+		return $this->handleNotFound(function() {
 			return $this->service->status();
 		});
 	}

lib/Command/CompleteOCR.php

Spacing +8 added lines, -8 removed lines

@@ -27,7 +27,7 @@ 
  *
  * @package OCA\Ocr\Command
  */
-class CompleteOCR extends Command  {
+class CompleteOCR extends Command {
 
 	/**
 	 * @var OcrService
@@ -68,21 +68,21 @@ 
 	protected function execute(InputInterface $input, OutputInterface $output) {
 		$statusId = $input->getArgument('status-id');
 		$failed = $input->getArgument('failed');
-		try{
-			if($failed === 'false'){
+		try {
+			if ($failed === 'false') {
 				$failed = false;
-			}elseif ($failed === 'true'){
+			}elseif ($failed === 'true') {
 				$failed = true;
-			}else{
+			} else {
 				throw new ServiceException('Wrong Arguments.');
 			}
 			$this->ocrService->complete($statusId, $failed);
-		} catch(Exception $e){
-			if($e instanceof MultipleObjectsReturnedException || $e instanceof DoesNotExistException) {
+		} catch (Exception $e) {
+			if ($e instanceof MultipleObjectsReturnedException || $e instanceof DoesNotExistException) {
 				$output->writeln('<error>Could not complete ocr for status id ' . $statusId .
 					': ' . $e->getMessage() .
 					'</error> ');
-			}else{
+			} else {
 				$output->writeln('<error>Unexpected error for status id ' . $statusId .
 					': ' . $e->getMessage() .
 					'</error> ');

worker/GearmanOCRWorker.php

Spacing +9 added lines, -9 removed lines

@@ -1,26 +1,26 @@ 
 <?php
 
 $worker = new GearmanWorker();
-$worker->addServer('127.0.0.1',4730);
+$worker->addServer('127.0.0.1', 4730);
 
 $worker->addFunction(/**
 					 * @param GearmanJob $job
 					 */
 	"ocr", function(GearmanJob $job) {
 	$workload = json_decode($job->workload());
-	if($workload->type === 'tess'){
+	if ($workload->type === 'tess') {
 		//tesseract
 		$command = 'tesseract "' . $workload->datadirectory . $workload->path . '" "' . $workload->tempfile . '" -l ' . $workload->language;
 		$success = -1;
 		exec($command, $_out, $success);
 		if ($success === 0 && !isset($_out[1])) {
 			//occ command which puts the file and cleans the tempfile
-			exec('php '.$workload->occdir.'/occ ocr:complete '.$workload->statusid.' false');
-		}else{
+			exec('php ' . $workload->occdir . '/occ ocr:complete ' . $workload->statusid . ' false');
+		} else {
 			//update status failed.
-			exec('php '.$workload->occdir.'/occ ocr:complete '.$workload->statusid.' true');
+			exec('php ' . $workload->occdir . '/occ ocr:complete ' . $workload->statusid . ' true');
 		}
-	}else{
+	} else {
 		//ocrmypdf
 		$command = 'ocrmypdf "' . $workload->datadirectory . $workload->path . '" "' . $workload->tempfile . '" -l ' . $workload->language . ' --skip-text';
 		$success = -1;
@@ -28,10 +28,10 @@ 
 		// Command successful and no error by tesseract (line[0] is 'Tesseract Open Source OCR Engine v3.03 with Leptonica' line[1] should not exist)
 		if ($success === 0 && !isset($_out[0])) {
 			//occ command which puts the file and cleans the tempfile
-			exec('php '.$workload->occdir.'/occ ocr:complete '.$workload->statusid.' false');
-		}else{
+			exec('php ' . $workload->occdir . '/occ ocr:complete ' . $workload->statusid . ' false');
+		} else {
 			//update status failed.
-			exec('php '.$workload->occdir.'/occ ocr:complete '.$workload->statusid.' true');
+			exec('php ' . $workload->occdir . '/occ ocr:complete ' . $workload->statusid . ' true');
 		}
 	}
 });