Merge pull request #30 from microsoft/feat/ftp-server-support

feat: add FTP server support

Author: urucoder

docker-compose.yml

@@ -9,6 +9,7 @@ services:
       - ./sparrow.env
     ports:
       - "25:25" # SMTP server port
+      - "21:21" # FTP server port
     volumes:
       - ./sparrow/config:/app/config
       - ./sparrow/images:/app/images

sparrow.env

@@ -7,4 +7,6 @@ VEDIRECT_PORT=/dev/ttyUSB0
 VEDIRECT_BAUD=19200
 SERVER_BASE_URL=https://server.sparrow-earth.com
 TZ=Etc/UTC
-ONLY_SAVE_ANIMALS=true
+ONLY_SAVE_ANIMALS=true
+FTP_USER=camera
+FTP_PASS=

sparrow/Dockerfile

@@ -34,5 +34,6 @@ RUN pip install --default-timeout=100 --no-cache-dir -r requirements.txt
 COPY . /app
 
 EXPOSE 25
+EXPOSE 21
 COPY supervisord.conf /etc/supervisor/supervisord.conf
 CMD ["supervisord", "-c", "/etc/supervisor/supervisord.conf"]

sparrow/ftp_server.py

@@ -0,0 +1,76 @@
+"""
+FTP server for camera feed: accepts FTP connections,
+authenticates a single user, and stores uploaded files in /app/images.
+"""
+
+import os
+import logging
+from pyftpdlib.authorizers import DummyAuthorizer
+from pyftpdlib.handlers import FTPHandler
+from pyftpdlib.servers import FTPServer
+
+# Configuration Paths
+SAVE_DIR = "/app/images"
+LOG_DIR = "/app/logs"
+os.makedirs(LOG_DIR, exist_ok=True)
+os.makedirs(SAVE_DIR, exist_ok=True)
+LOG_FILE = os.path.join(LOG_DIR, "ftp_server.log")
+
+# Setup Logging & Folders
+logging.basicConfig(
+    level=logging.INFO,
+    format="%(asctime)s %(levelname)s %(message)s",
+    handlers=[
+        logging.FileHandler(LOG_FILE),
+        logging.StreamHandler()
+    ]
+)
+logger = logging.getLogger(__name__)
+
+FTP_USER = os.getenv("FTP_USER", "camera")
+FTP_PASS = os.getenv("FTP_PASS")
+FTP_PORT = 21
+
+class CustomFTPHandler(FTPHandler):
+    permit_foreign_addresses = True
+
+    def on_connect(self):
+        logger.info(f"New connection from {self.remote_ip}:{self.remote_port}")
+
+    def on_disconnect(self):
+        logger.info(f"Disconnected: {self.remote_ip}")
+
+    def on_login(self, username):
+        logger.info(f"User logged in: {username} from {self.remote_ip}")
+
+    def on_login_failed(self, username, password):
+        logger.warning(f"Failed login attempt: username={username} ip={self.remote_ip}")
+
+    def on_file_received(self, file_path):
+        logger.info(f"File received and saved: {file_path}")
+
+    def on_incomplete_file_received(self, file_path):
+        logger.warning(f"Incomplete file received (removed): {file_path}")
+
+
+def main():
+    authorizer = DummyAuthorizer()
+    authorizer.add_user(FTP_USER, FTP_PASS, SAVE_DIR, perm="elradfmw")
+
+    handler = CustomFTPHandler
+    handler.authorizer = authorizer
+    handler.banner = "Reolink FTP server ready."
+
+    address = ("0.0.0.0", FTP_PORT)
+    server = FTPServer(address, handler)
+
+    # Connection limits
+    server.max_cons = 256
+    server.max_cons_per_ip = 10
+
+    logger.info(f"FTP server listening on 0.0.0.0:{FTP_PORT}, saving to {SAVE_DIR}")
+    server.serve_forever()
+
+
+if __name__ == "__main__":
+    main()

sparrow/requirements.txt

@@ -23,4 +23,5 @@ audioread==3.0.1
 pooch==1.8.2
 librosa==0.10.2.post1
 numba==0.59.1
-llvmlite==0.42.0
+llvmlite==0.42.0
+pyftpdlib==2.1.0

sparrow/supervisord.conf

@@ -1,6 +1,14 @@
 [supervisord]
 nodaemon=true
 
+[program:ftp_server]
+command=python /app/ftp_server.py
+autostart=true
+autorestart=true
+priority=20
+stdout_logfile=/dev/null
+stderr_logfile=/dev/null
+
 [program:rtc_sync_once]
 directory=/app/tools
 command=python /app/tools/rtc_sync.py