Thank you for creating this. SFTP Client is forcing Host key and "hostname" isnt working when referenced in the connection.

[ComputermanIT]

I corrected with below. Not using ssh key's so is not as secure but you noted not supported in the .env files.

-- coding: UTF-8 --

import pysftp
import os
from time import sleep
from myhelpers.logging import logger
from myhelpers.traitement_fichier import csv_files_read
import pysftp.exceptions

from pathlib import Path
path = Path(file).resolve()
dir_path = path.parent
working_path = path.cwd()
class sftpclient():
"""
The sftpclient class provides a convenient way to interact with an SFTP server. It allows you to:

- Connect to an SFTP server with the provided host, user, password, and optional port, private key, and private key password.
- Monitor an SFTP folder, download any new files to a local folder, and optionally archive or delete the files on the SFTP server.
- Read any CSV files that were downloaded to the local folder and move them to an archive folder.

The `monitor` method is the main entry point for interacting with the SFTP server. It will connect to the SFTP server, change to the specified `ftpfolder`, download any new files to the `localfolder`, and then either archive or delete the files on the SFTP server based on the value of the `FTP_3CX_ARCHIVE_OR_DELETE` environment variable. Finally, it will read any CSV files that were downloaded and move them to the `archivefolder`.
"""
    
def __init__(self, host, user, password, server_dir, interval,port=22, private_key=None, private_key_pass=None):
    self.host=host
    self.user=user
    self.password=password
    self.port=port
    self.server_dir = server_dir
    self.interval = interval
    self.private_key = private_key
    self.private_key_pass = private_key_pass

def monitor(self, ftpfolder='', localfolder='',archivefolder='', interval=50):
    """
    Monitors an SFTP folder, downloads any new files to a local folder, and optionally archives or deletes the files on the SFTP server. It then reads any CSV files that were downloaded and moves them to an archive folder.
    
    Args:
        ftpfolder (str): The SFTP folder to monitor.
        localfolder (str): The local folder to download files to.
        archivefolder (str): The folder to move CSV files to.
        interval (int): The number of seconds to wait between checks.
    
    Returns:
        None
    """
    cnopts = pysftp.CnOpts()
    cnopts.hostkeys = None
            
    with pysftp.Connection(host=self.host, port=self.port,
                            username=self.user, password=self.password, 
                            private_key=None, private_key_pass=None,
                            cnopts=cnopts) as sftp :
        sftp.chdir(ftpfolder)
        fNames = sftp.listdir(sftp.getcwd())
        for f in fNames:
            logger.info(f)
            if not f.endswith('old'):
                sftp.get(f, os.path.join(localfolder, f))
                logger.info("file downloaded:" + f)
                if os.environ.get('3CX_FILES_ARCHIVE_OR_DELETE') == 'ARCHIVE':
                    sftp.rename(f, f + ".old")
                elif os.environ.get('3CX_FILES_ARCHIVE_OR_DELETE') == 'DELETE':
                    sftp.remove(f)
        csv_files_read(localfolder, archivefolder)            
        sleep(interval)

[dorel14]

Hello , for the moment sftp is not completly supported as i have don't have an sftp server for testing
I you want you can submit a pull request to make it completly ok and safe to use

[ComputermanIT]

Thank you. So the SFTP connection is only deleting the files to archive them but not entering them into the database? What connection method do you recommend? Socket?

[dorel14]

It is not a normal thing if files are only downloaded and archived, the right process is downloaded, inserted in db and archived.

The 2 more tested are scp and tcp