Add sftp

Author: insoIite

config.yml

@@ -14,9 +14,20 @@ qbitorrent:
   password: "" # qbittorrent password
   port: 8080   # qbitorrent port
 
-ftp:
+# Either use ftp or sftp depending on your remote.
+# Only one of those 2 dict should be filles
+# If not, ftp will prevail
+ftp: {}
+  #domain: ""      # FTP hostname
+  #port: 21        # FTP port
+  #user: ""        # FTP user
+  #password: ""    # FTP password
+  # Remote path on the FTP server
+  #remote_path: "" # Example: "/torrents/qbittorrent/"
+
+sftp:
   domain: ""      # FTP hostname
-  port: 21        # FTP port
+  port: 22        # FTP port
   user: ""        # FTP user
   password: ""    # FTP password
   # Remote path on the FTP server

qbit_watcher/sftp.py

@@ -0,0 +1,49 @@
+import logging
+import shutil
+
+from pysftp import Connection, CnOpts
+from pathlib import Path
+
+LOGGER = logging.getLogger(__name__)
+
+class TorrentSftp:
+    def __init__(self, conf, dest_folder, toaster):
+        self.conf = conf
+        self.dest = dest_folder
+        self.sftp = self.get_client()
+        self.toaster = toaster
+
+    def get_client(self):
+        cnopts = CnOpts()
+        cnopts.hostkeys = None
+        sftp = Connection(
+            self.conf['domain'],
+            username=self.conf['user'],
+            password=self.conf['password'],
+            cnopts=cnopts,
+            default_path=self.conf['remote_path']
+        )
+        LOGGER.info("Successfully connected to '%s' SFTP server", self.conf['domain'])
+        return sftp
+
+    def download(self, fname):
+        """
+        Download torrent to local workstation
+        """
+        LOGGER.info("Retrieving '%s'" % fname)
+        if self.sftp.isfile(fname):
+            self.sftp.get(fname, localpath="%s/%s" %(self.dest, fname))
+        elif self.sftp.isdir(fname):
+            # Cannot get folder if its already exists on local.
+            # Therefore remove it before downloading again
+            path = Path("%s/%s" % (self.dest, fname))
+            if path.exists():
+                shutil.rmtree(path)
+            self.sftp.get_r(fname, self.dest)
+        else:
+            LOGGER.info("No file to download found")
+            return
+        self.toaster.notif("%s is downloaded" % (fname))
+
+    def close(self):
+        self.sftp.close()

qbit_watcher/watcher.py

@@ -7,6 +7,7 @@
 
 from qbit_watcher.qbittorrent import QBittorrent
 from qbit_watcher.ftp import TorrentFTP
+from qbit_watcher.sftp import TorrentSftp
 from qbit_watcher.toaster import TorrentToaster
 
 from watchdog.events import FileSystemEventHandler
@@ -41,8 +42,15 @@ def manage(self, torrent_filename, torrent_name):
             if client.torrent_complete(torrent_name):
                 break
 
-        ftpCli = TorrentFTP(self.conf['ftp'], self.dest_folder, self.toaster)
-        ftpCli.download(torrent_name)
+        if self.conf['ftp']:
+            LOGGER.info("Using FTP")
+            ftpCli = TorrentFTP(self.conf['ftp'], self.dest_folder, self.toaster)
+            ftpCli.download(torrent_name)
+        elif self.conf['sftp']:
+            LOGGER.info("Using SFTP")
+            sftpCli = TorrentSftp(self.conf['sftp'], self.dest_folder, self.toaster)
+            sftpCli.download(torrent_name)
+            sftpCli.close()
 
     def on_modified(self, event):
         """