FTP_Reader

Complexity

Total Complexity

38

Size/Duplication

Total Lines	278
Duplicated Lines	0 %

Importance

Changes	11
Bugs	1	Features	0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	setSearchedFile()	0	3	1
A	setFTPCredential()	0	7	1
A	setLastUpdateTimingLimit()	0	3	1
A	setFolder()	0	3	1
A	isSearchedFileAvailable()	0	3	2
A	selectWantedFiles()	0	11	3
A	__construct()	0	6	1
A	getFtp()	0	31	4
A	writeExportDataFile()	0	17	2
A	getFilesFromFTP()	0	13	2
A	isLastUpdateInTimingLimit()	0	11	3
B	connectAndGoToFolder()	0	33	7
A	parseLysarcTxt()	0	30	4
A	getSftp()	0	36	4
A	sendFailedReadFTP()	0	10	2

<?php

/**
 Copyright (C) 2018-2020 KANOUN Salim
 This program is free software; you can redistribute it and/or modify
 it under the terms of the Affero GNU General Public v.3 License as published by
 the Free Software Foundation;
 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 Affero GNU General Public Public for more details.
 You should have received a copy of the Affero GNU General Public Public along
 with this program; if not, write to the Free Software Foundation, Inc.,
 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

/**
 * Access Data from FTP Source
 */

use phpseclib\Net\SFTP;

The type phpseclib\Net\SFTP was not found. Maybe you did not declare it correctly or list all dependencies?

class FTP_Reader
{

	public $ftpUsername;
	public $ftpPassword;
	public $ftpHost;
	public $ftpPort;
	public $ftpIsSftp;
	public $ftpFolder;
	public $ftpFileName;
	public $lastUpdateLimit;
	private $linkpdo;

	public function __construct($linkpdo)
	{
		$this->linkpdo=$linkpdo;
		$this->ftpFileName=null;
		$this->lastUpdateLimit=null;
		$this->ftpFolder='/';
	}

	/**
	 * 
	 */
	public function setFTPCredential(String $host, String $username, String $password, int $port=21, bool $ftpIsSftp=false)
	{
		$this->ftpHost=$host;
		$this->ftpUsername=$username;
		$this->ftpPassword=$password;
		$this->ftpPort=$port;
		$this->ftpIsSftp=$ftpIsSftp;
	}

	public function setFolder(String $folder)
	{
		$this->ftpFolder=$folder;
	}

	public function setSearchedFile(String $fileName)
	{
		$this->ftpFileName=$fileName;
	}

	/**
	 * Number of minutes the last update of files should be inferior
	 */
	public function setLastUpdateTimingLimit(int $lastUpdateLimit)
	{
		$this->lastUpdateLimit=$lastUpdateLimit;
	}

	private function selectWantedFiles(array $fileArray)
	{
		if ($this->ftpFileName != null) {
			$isAvailable=$this->isSearchedFileAvailable($fileArray);
			if ($isAvailable) {
				return array($this->ftpFileName);
			}else {
				throw new Exception('Target File Not Found');
			}
		}else {
			return $fileArray;
		}
	}

	private function isSearchedFileAvailable(array $fileArray)
	{
		return in_array($this->ftpFileName, $fileArray) ? true : false;
	}

	private function isLastUpdateInTimingLimit(int $mtimStamp)
	{
		//$lastUpdateTime=DateTime::createFromFormat('U', $mtim);
		$dateNow=new DateTime();

		if (($this->lastUpdateLimit != null) &&
			($dateNow->getTimestamp()-$mtimStamp) > ($this->lastUpdateLimit*60)
		) {
			throw new Exception('File last update too old');
		}
		return true;
	}

	/**
	 * Download the FTP folder taget and return an array of temporary dowloaded files
	 */
	public function getFilesFromFTP()
	{

		if ($this->ftpIsSftp) {

			$filesArray=$this->getSftp();
		}else {
			$filesArray=$this->getFtp();
			//$ftpConnect = ftp_ssl_connect ($this->ftpHost, $this->ftpPort) or die("Can't Connect to Server ".$this->ftpHost);

		}

		return $filesArray;
	}

	private function connectAndGoToFolder() {

		if ($this->ftpIsSftp) {

			$sftp=new SFTP($this->ftpHost);
			if (!$sftp->login($this->ftpUsername, $this->ftpPassword)) {
				throw new Exception('Login SFTP failed');
			}
    
			if (!$sftp->chdir($this->ftpFolder)) {
				throw new Exception("Can't reach SFTP Path Target");
			};

			return $sftp;

		}else {

			if (!$ftpConnect=ftp_connect($this->ftpHost, $this->ftpPort)) {
				throw new Exception('Cant Connect to Server'.$this->ftpHost);
			}
    
			if (!ftp_login($ftpConnect, $this->ftpUsername, $this->ftpPassword)) {
				ftp_close($ftpConnect);
				throw new Exception('Login failed');
			};
    
			//Move to the target folder
			if (!ftp_chdir($ftpConnect, $this->ftpFolder)) {
				ftp_close($ftpConnect);
				throw new Exception("Can't reach FTP Path Target");
			}

			return $ftpConnect;

		}

	}

	public function writeExportDataFile(String $fileName, String $file) {

		if ($this->ftpIsSftp) {

			$sftp=$this->connectAndGoToFolder();

			$result=$sftp->put($fileName, $file, SFTP::SOURCE_LOCAL_FILE);

			return $result;

		}else {      

			$ftp=$this->connectAndGoToFolder();

			$result=ftp_fput($ftp, $fileName, fopen($file, 'r'));

It seems like $ftp can also be of type phpseclib\Net\SFTP; however, parameter $ftp of ftp_fput() does only seem to accept resource, maybe add an additional type check?

			return $result;
		}


	}

	private function getSftp()
	{
		$sftp=$this->connectAndGoToFolder();

		$fileArray=$sftp->nlist();

		//Remove . and ..
		$fileArray=array_filter($fileArray, function($file) {

It seems like $fileArray can also be of type false; however, parameter $array of array_filter() does only seem to accept array, maybe add an additional type check?

			if ($file == '.' || $file == '..') {
				return false;
			}else {
				return true;
			}
		});
        


		print_r($fileArray);

		$selectedFiles=$this->selectWantedFiles($fileArray);

		$resultFileArray=[];

		foreach ($selectedFiles as $fileInFtp) {
			$fileState=$sftp->stat($fileInFtp);
			$this->isLastUpdateInTimingLimit($fileState['mtime']);
			print_r($fileState);
			$temp=fopen(sys_get_temp_dir().DIRECTORY_SEPARATOR.$fileInFtp, 'w');
			//Retrieve File from SFTP
			$sftp->get($fileInFtp, $temp);

$temp of type resource is incompatible with the type string expected by parameter $local_file of phpseclib\Net\SFTP::get().

			fclose($temp);
			//Store resulting file in array
			$resultFileArray[]=sys_get_temp_dir().DIRECTORY_SEPARATOR.$fileInFtp;
		}

		return $resultFileArray;
	}

	private function getFtp()
	{
		$ftpConnect=$this->connectAndGoToFolder();

		// Get files in the ftp folder
		$fileArray=ftp_nlist($ftpConnect, ".");

It seems like $ftpConnect can also be of type phpseclib\Net\SFTP; however, parameter $ftp of ftp_nlist() does only seem to accept resource, maybe add an additional type check?

		//Remove . and ..
		$fileArray=array_filter($fileArray, function($file) {
			if ($file == '.' || $file == '..') {
				return false;
			}else {
				return true;
			}
		});

		$selectedFiles=$this->selectWantedFiles($fileArray);

		$resultFileArray=[];

		foreach ($selectedFiles as $fileInFtp) {
			$temp=fopen(sys_get_temp_dir().DIRECTORY_SEPARATOR.$fileInFtp, 'w');
			ftp_fget($ftpConnect, $temp, $fileInFtp);

It seems like $ftpConnect can also be of type phpseclib\Net\SFTP; however, parameter $ftp of ftp_fget() does only seem to accept resource, maybe add an additional type check?

			fclose($temp);
			//Store resulting file in array
			$resultFileArray[]=sys_get_temp_dir().DIRECTORY_SEPARATOR.$fileInFtp;
		}

		ftp_close($ftpConnect);

It seems like $ftpConnect can also be of type phpseclib\Net\SFTP; however, parameter $ftp of ftp_close() does only seem to accept resource, maybe add an additional type check?

		return $resultFileArray;
	}

	/**
	 * Transform Text file with # separator to an associative array
	 */
	public static function parseLysarcTxt(String $txt)
	{
		//Erase last empty new line
		$txt=rtrim($txt);
		//Divided text in row by splitting new line
		$lines=explode("\n", $txt);

		$titles=[];
		$results=[];

		for ($i=0; $i < sizeOf($lines); $i++) {

It seems like you are calling the size function sizeof() as part of the test condition. You might want to compute the size beforehand, and not on each iteration.

			//remove return new line and last #
			$lines[$i]=rtrim($lines[$i]);
			$lines[$i]=rtrim($lines[$i], '#');
			//split string in columns
			$columns=explode("#", $lines[$i]);
			if ($i == 0) {
				//First line is column definition
				$titles=$columns;
			}else {
				$patient=[];
				//For each column associate data into an associative array
				for ($j=0; $j < sizeof($columns); $j++) {

It seems like you are calling the size function sizeof() as part of the test condition. You might want to compute the size beforehand, and not on each iteration.

					$patient[$titles[$j]]=$columns[$j];
				}
				$results[]=$patient;
			}
		}

		return $results;
	}


	function sendFailedReadFTP($exceptionMessage) {

It is generally recommended to explicitly declare the visibility for methods.

		try {
			$email=new Send_Email($this->linkpdo);
			$email->setMessage("FTP Process Has failed <br> Reason : ".$exceptionMessage);
			$email->setSubject('FTP Process Failed');
			$email->addAminEmails();
			$email->sendEmail();
		}catch (Exception $e) {
			echo('sendEmailException');
			echo($e->getMessage());
		}

    
	}


	/**
	 * Return files from a local folder
	 * @param string $folder
	 * @return string[]
	 */
	/*
    public static function getFilesFromFolder(string $folder)
    {

        $scanned_directory = array_diff(scandir($folder), array('..', '.'));

        $resultFileArray = [];
        foreach ($scanned_directory as $file) {

            $resultFileArray[] = $folder . DIRECTORY_SEPARATOR . $file;
        }

        return $resultFileArray;
    }
    */
}