OCA\Ocr\Service\FileService

Complexity

Total Complexity

25

Size/Duplication

Total Lines	263
Duplicated Lines	5.32 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

17.07%

Importance

Changes	1
Bugs	0	Features	0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	checkSharedWithInitiator()	0	10	2
A	buildTarget()	0	8	2
A	buildSource()	0	9	2
A	buildFileInfo()	0	16	3
A	getCorrectType()	0	7	2
A	execRemove()	0	3	1
A	getFileContents()	0	3	1
A	fileExists()	0	3	1
A	buildNotExistingFilename()	0	3	1
B	buildTargetForShared()	7	26	3
B	buildTargetNotForShared()	7	27	3
A	checkMimeType()	0	6	3

<?php

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

use OCA\Ocr\Db\FileMapper;
use OCA\Ocr\Db\File;
use OCP\ILogger;
use OCA\Ocr\Db\ShareMapper;
use OCP\IL10N;
use OCA\Ocr\Constants\OcrConstants;

/**
 * Class FileService
 *
 * @package OCA\Ocr\Service
 */
class FileService {
	
	/**
	 *
	 * @var ILogger
	 */
	private $logger;
	
	/**
	 *
	 * @var FileMapper
	 */
	private $fileMapper;
	
	/**
	 *
	 * @var ShareMapper
	 */
	private $shareMapper;
	
	/**
	 *
	 * @var string
	 */
	private $userId;
	
	/**
	 *
	 * @var IL10N
	 */
	private $l10n;
	public function __construct(IL10N $l10n, ILogger $logger, $userId, FileMapper $fileMapper, ShareMapper $shareMapper) {
		$this->l10n = $l10n;
		$this->logger = $logger;
		$this->userId = $userId;
		$this->fileMapper = $fileMapper;
		$this->shareMapper = $shareMapper;
	}
	
	/**
	 * Checks if shared with the process initiator
	 *
	 * @param File $fileInfo        	
	 * @return boolean|null
	 */
	public function checkSharedWithInitiator($fileInfo) {
		$owner = str_replace ( 'home::', '', $fileInfo->getStoragename () );
		if ($this->userId === $owner) {
			// user is owner (no shared file)
			return false;
		} else {
			// user is not owner (shared file)
			return true;
		}
	}
	
	/**
	 * Builds the target name.
	 *
	 * @param File $fileInfo        	
	 * @param boolean $shared        	
	 * @return string
	 */
	public function buildTarget($fileInfo, $shared) {
		if ($shared) {
			$target = $this->buildTargetForShared ( $fileInfo );
		} else {
			$target = $this->buildTargetNotForShared ( $fileInfo );
		}
		return $target;
	}
	
	/**
	 * Builds the source name.
	 *
	 * @param File $fileInfo        	
	 * @param boolean $shared        	
	 * @return string
	 */
	public function buildSource($fileInfo, $shared) {
		$source = $fileInfo->getPath ();
		if ($shared) {
			$source = str_replace ( 'home::', '', $fileInfo->getStoragename () ) . '/' . $source;
		} else {
			$source = $this->userId . '/' . $source;
		}
		return $source;
	}
	
	/**
	 * Returns the fileInfo for each file in files and checks
	 * if it has a allowed MIME type and some other conditions.
	 *
	 * @param array $files        	
	 * @return File[]
	 * @throws NotFoundException
	 */
	public function buildFileInfo($files) {
		$fileArray = array ();
		foreach ( $files as $file ) {
			// Check if anything is missing and file type is correct
			if (! empty ( $file ['id'] )) {
				
				$fileInfo = $this->fileMapper->find ( $file ['id'] );
				$this->checkMimeType ( $fileInfo );
				
				array_push ( $fileArray, $fileInfo );
			} else {
				throw new NotFoundException ( $this->l10n->t ( 'Wrong parameter.' ) );
			}
		}
		return $fileArray;
	}
	
	/**
	 * Determines the correct type for the ocr process worker.
	 *
	 * @param File $fileInfo        	
	 * @return integer
	 */
	public function getCorrectType($fileInfo) {
		if ($fileInfo->getMimetype () === OcrConstants::MIME_TYPE_PDF) {
			return OcrConstants::OCRmyPDF;
		} else {
			return OcrConstants::TESSERACT;
		}
	}
	
	/**
	 * Executes the exec function with a remove statement for a given file path.
	 *
	 * @codeCoverageIgnore
	 *
	 * @param string $pathToFile        	
	 */
	public function execRemove($pathToFile) {
		exec ( 'rm ' . $pathToFile );
	}
	
	/**
	 * Wraps the static file_get_contents method of php.
	 *
	 * @codeCoverageIgnore
	 *
	 * @param string $pathToFile        	
	 * @return string
	 */
	public function getFileContents($pathToFile) {
		return file_get_contents ( $pathToFile );
	}
	
	/**
	 * Wraps the static file_exists method of php.
	 *
	 * @codeCoverageIgnore
	 *
	 * @param string $pathToFile        	
	 * @return boolean
	 */
	public function fileExists($pathToFile) {
		return file_exists ( $pathToFile );
	}
	
	/**
	 * Wraps the static function \OCP\Files::buildNotExistingFileName() in order to be able to test everything else.
	 *
	 * @codeCoverageIgnore
	 *
	 * @param string $filePath        	
	 * @param string $fileName        	
	 * @return string
	 */
	public function buildNotExistingFilename($filePath, $fileName) {
		return \OCP\Files::buildNotExistingFileName ( $filePath, $fileName . '_OCR.pdf' );
	}
	
	/**
	 * Returns a not existing file name for pdf or image processing
	 * protected as of testing issues with static methods.
	 * (Actually
	 * it will be mocked partially) FIXME: Change this behaviour as soon as the buidlNotExistingFileName function is not static anymore
	 * @codeCoverageIgnore
	 *
	 * @param File $fileInfo        	
	 * @return string
	 */
	private function buildTargetForShared(File $fileInfo) {
		$share = $this->shareMapper->find ( $fileInfo->getFileid (), $this->userId, str_replace ( 'home::', '', $fileInfo->getStoragename () ) );
		
		// get rid of the .png or .pdf and so on
		$fileName = substr ( $share->getFileTarget (), 0, (strrpos ( $share->getFileTarget (), '.' )) ); // '/thedom.png' => '/thedom' || '/Test/thedom.png' => '/Test/thedom'

50% of this comment could be valid code. Did you maybe forget this after debugging?

		                                                                                                 
		// remove everything in front of and including of the first appearance of a slash from behind
		$fileName = substr ( strrchr ( $fileName, "/" ), 1 ); // '/thedom' => 'thedom' || '/Test/thedom' => 'thedom'

50% of this comment could be valid code. Did you maybe forget this after debugging?

		                                                      
		// eliminate the file name from the path
		$filePath = dirname ( $share->getFileTarget () ); // '/thedom.png' => '/' || '/Test/thedom.png' => '/Test'

50% of this comment could be valid code. Did you maybe forget this after debugging?

		                                                  
		// replace the first slash
		$pos = strpos ( $filePath, '/' );
		if ($pos !== false) {
			$filePath = substr_replace ( $filePath, '', $pos, strlen ( '/' ) ); // '/' => '' || '/Test/' => 'Test'

50% of this comment could be valid code. Did you maybe forget this after debugging?

		}
		
		if ($fileInfo->getMimetype () === OcrConstants::MIME_TYPE_PDF) {

This code seems to be duplicated across your project.

			// PDFs:
			return $this->buildNotExistingFilename ( $filePath, $fileName . '_OCR.pdf' );
		} else {
			// IMAGES:
			return $this->buildNotExistingFilename ( $filePath, $fileName . '_OCR.txt' );
		}
	}
	
	/**
	 * Returns a not existing file name for PDF or image processing
	 * protected as of testing issues with static methods.
	 * (Actually
	 * it will be mocked partially) FIXME: Change this behaviour as soon as the buidlNotExistingFileName function is not static anymore
	 * @codeCoverageIgnore
	 *
	 * @param File $fileInfo        	
	 * @return string
	 */
	private function buildTargetNotForShared(File $fileInfo) {
		// get rid of the .png or .pdf and so on
		$fileName = substr ( $fileInfo->getName (), 0, (strrpos ( $fileInfo->getName (), '.' )) ); // 'thedom.png' => 'thedom'

50% of this comment could be valid code. Did you maybe forget this after debugging?

		                                                                                           
		// eliminate the file name from the path
		$filePath = str_replace ( $fileInfo->getName (), '', $fileInfo->getPath () ); // 'files/Test/thedom.png' => 'files/Test/' || 'files/thedom.png' => 'files/'

50% of this comment could be valid code. Did you maybe forget this after debugging?

		                                                                              
		// and get the path on top of the files/ dir
		$filePath = str_replace ( 'files', '', $filePath ); // 'files/Test/' => '/Test/' || 'files/' => '/'

50% of this comment could be valid code. Did you maybe forget this after debugging?

		                                                    
		// remove the last slash
		$filePath = substr_replace ( $filePath, '', strrpos ( $filePath, '/' ), strlen ( '/' ) ); // '/Test/' => '/Test' || '/' => ''

50% of this comment could be valid code. Did you maybe forget this after debugging?

		                                                                                          
		// replace the first slash
		$pos = strpos ( $filePath, '/' );
		if ($pos !== false) {
			$filePath = substr_replace ( $filePath, '', $pos, strlen ( '/' ) ); // '/Test' => '// 'Test' || '/' => ''
		}
		
		if ($fileInfo->getMimetype () === OcrConstants::MIME_TYPE_PDF) {

This code seems to be duplicated across your project.

			// PDFs:
			return $this->buildNotExistingFilename ( $filePath, $fileName . '_OCR.pdf' );
		} else {
			// IMAGES:
			return $this->buildNotExistingFilename ( $filePath, $fileName . '_OCR.txt' );
		}
	}
	
	/**
	 * Checks a MIME type for a specifically given FileInfo.
	 *
	 * @param File $fileInfo        	
	 */
	private function checkMimeType(File $fileInfo) {
		if (! $fileInfo || ! in_array ( $fileInfo->getMimetype (), OcrConstants::ALLOWED_MIME_TYPES )) {
			$this->logger->debug ( 'Getting FileInfo did not work or not included in the ALLOWED_MIMETYPES array.' );
			throw new NotFoundException ( $this->l10n->t ( 'Wrong MIME type.' ) );
		}
	}
}