diff --git a/requirements.txt b/requirements.txt index 8b5c09e7085..f595b88c2cc 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,5 @@ # generated from manifests external_dependencies cryptography +paramiko paramiko<4.0.0 pysftp diff --git a/server_ftp/README.rst b/server_ftp/README.rst new file mode 100644 index 00000000000..767157b24b2 --- /dev/null +++ b/server_ftp/README.rst @@ -0,0 +1,153 @@ +.. image:: https://odoo-community.org/readme-banner-image + :target: https://odoo-community.org/get-involved?utm_source=readme + :alt: Odoo Community Association + +========== +Server FTP +========== + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:9bac6cfb37203ffe6deb69b9d21feb8672d2267a252e8befca1b9f4ff61a55ab + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png + :target: https://odoo-community.org/page/development-status + :alt: Beta +.. |badge2| image:: https://img.shields.io/badge/license-AGPL--3-blue.png + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github + :target: https://github.com/OCA/server-tools/tree/20.0/server_ftp + :alt: OCA/server-tools +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/server-tools-20-0/server-tools-20-0-server_ftp + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png + :target: https://runboat.odoo-community.org/builds?repo=OCA/server-tools&target_branch=20.0 + :alt: Try me on Runboat + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module enables connections via FTP, SFTP and FTP_TLS. Operations +such as retrieving a file, checking if a file exists, are all +centralized in an Abstract python class, so the user can operate without +even noticing what protocol they are using. + +For more exquisite operations, the user may retrieve a pure connection +object in a straighforward way. + +TODOS: + +- Secure everything + +**Table of contents** + +.. contents:: + :local: + +Installation +============ + +To install this module, you need to: + +1. Have paramiko available ``pip3 install paramiko`` +2. Add it as dependency from your main module. + +Configuration +============= + +To configure this module, you need to: + +1. Go to ``Settings/Technical/FTP/Servers`` +2. Find your favourite protocol and configure connection settings +3. In the form view of the record, edit file structure. +4. If more folders are needed, just add data records with a proper + xml_id +5. If more servers are needed, just add data records with a proper + xml_id + +Usage +===== + +To use this module, you need to: + +1. Configure and test you ftp/sftp/lsftp connection +2. Fetch the relevant server.ftp.folder record via it's xmlid +3. Code + +:: + + >>> folder = session.env.ref("server_ftp.server_ftp_pull_folder_01_ftp") + >>> folder_server_object = folder.connect() + # folder_server_object is lib.ftp_server.FtpServer object + # You can perform simple operations like ls, put, get, close etc + # with folder_server_object. See lib/abstract_ftp_model.py for more + >>> folder_server_object.listdir() + -rw-rw-r-- 1 1001 1001 0 May 06 14:10 a_file.txt + -rw-rw-r-- 1 1001 1001 0 May 06 14:21 another_file.txt + >>> server = folder_server_object.get_server() + # server is ftplib.FTP object + # so we can do anything in ftplib + >>> server.dir() + -rw-rw-r-- 1 1001 1001 0 May 06 14:10 a_file.txt + -rw-rw-r-- 1 1001 1001 0 May 06 14:21 another_file.txt + >>> + >>> folder_server_object.remove("a_file.txt") + >>> folder_server_object.listdir() + -rw-rw-r-- 1 1001 1001 0 May 06 14:21 another_file.txt + >>> server.dir() + -rw-rw-r-- 1 1001 1001 0 May 06 14:21 another_file.txt + >>> server.delete("another_file.txt") + '250 Delete operation successful.' + >>> folder_server_object.listdir() + >>> server.dir() + >>> folder_server_object.close() == server.quit() + +Bug Tracker +=========== + +Bugs are tracked on `GitHub Issues `_. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us to smash it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +------- + +* Therp BV + +Contributors +------------ + +- Nikos Tsirintanis ntsirintanis@therp.nl + +Other credits +------------- + +Therp B.V. + +Maintainers +----------- + +This module is maintained by the OCA. + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use. + +This module is part of the `OCA/server-tools `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/server_ftp/__init__.py b/server_ftp/__init__.py new file mode 100644 index 00000000000..8082dedf98d --- /dev/null +++ b/server_ftp/__init__.py @@ -0,0 +1,3 @@ +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). +from . import lib +from . import models diff --git a/server_ftp/__manifest__.py b/server_ftp/__manifest__.py new file mode 100644 index 00000000000..c43b4d3d6ed --- /dev/null +++ b/server_ftp/__manifest__.py @@ -0,0 +1,16 @@ +# Copyright 2020 - 2023 Therp BV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). +{ + "name": "Server FTP", + "version": "20.0.1.0.0", + "author": "Therp BV, Odoo Community Association (OCA)", + "website": "https://github.com/OCA/server-tools", + "license": "AGPL-3", + "category": "Tools", + "summary": "Enable connection via various protocols", + "depends": ["base"], + "data": ["security/ir.access.csv", "views/server_ftp_views.xml"], + "demo": ["demo/server_ftp.xml", "demo/server_ftp_folder.xml"], + "external_dependencies": {"python": ["paramiko"]}, + "installable": True, +} diff --git a/server_ftp/demo/server_ftp.xml b/server_ftp/demo/server_ftp.xml new file mode 100644 index 00000000000..1f27d9444c3 --- /dev/null +++ b/server_ftp/demo/server_ftp.xml @@ -0,0 +1,10 @@ + + + + FTP Example Server + ftp + ftp.example.com + user + password + + diff --git a/server_ftp/demo/server_ftp_folder.xml b/server_ftp/demo/server_ftp_folder.xml new file mode 100644 index 00000000000..1a32af6070c --- /dev/null +++ b/server_ftp/demo/server_ftp_folder.xml @@ -0,0 +1,15 @@ + + + + + Push folder + /pull_folder + + + + + Pull folder + /push_folder + + + diff --git a/server_ftp/lib/__init__.py b/server_ftp/lib/__init__.py new file mode 100644 index 00000000000..8f968edc6d8 --- /dev/null +++ b/server_ftp/lib/__init__.py @@ -0,0 +1,6 @@ +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). +from . import abstract_ftp_server +from . import ftp_server +from . import ftp_tls_server +from . import sftp_server +from . import mock_server diff --git a/server_ftp/lib/abstract_ftp_server.py b/server_ftp/lib/abstract_ftp_server.py new file mode 100644 index 00000000000..ee2244657e0 --- /dev/null +++ b/server_ftp/lib/abstract_ftp_server.py @@ -0,0 +1,71 @@ +# Copyright 2020 - 2023 Therp BV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). +from abc import ABC, abstractmethod + + +class AbstractFTPServer(ABC): + def __init__(self): + self.server = None + super().__init__() + + def get_server(self): + return self.server + + @abstractmethod + def connect(self, host, port, user, password): + """Connect to object""" + raise NotImplementedError + + @abstractmethod + def close(self): + """Close connection""" + raise NotImplementedError + + @abstractmethod + def putfo(self, file_like, name): + """Transfer file-like object to server + + name: filename+extension for file at server + file_like: byte object, content of which + will appear in server as name + """ + raise NotImplementedError + + @abstractmethod + def put(self, filepath, name): + """Transfer file object to server + + name: filename+extension for file at server + filepath: path + the actual file you are putting + """ + raise NotImplementedError + + @abstractmethod + def getfo(self, file_like, name): + """Get file from server + + name: filename of file to retrieve + file_like: byte object to save containt + of filename + """ + raise NotImplementedError + + @abstractmethod + def remove(self, file): + """Remove file from server""" + raise NotImplementedError + + @abstractmethod + def listdir(self, path=""): + """List in current directory""" + raise NotImplementedError + + @abstractmethod + def cd(self, path): + """Change directory""" + raise NotImplementedError + + @abstractmethod + def exists(self, file, path=""): + """See if file exists in path""" + raise NotImplementedError diff --git a/server_ftp/lib/ftp_server.py b/server_ftp/lib/ftp_server.py new file mode 100644 index 00000000000..f23cc498280 --- /dev/null +++ b/server_ftp/lib/ftp_server.py @@ -0,0 +1,73 @@ +# Copyright 2020 - 2023 Therp BV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). +from ftplib import FTP, error_perm + +from .abstract_ftp_server import AbstractFTPServer + + +class FTPServer(AbstractFTPServer): + def connect(self, host, port, user, password): + """Connect to server""" + self.server = FTP() + # Init step by step + self.server.connect(host, port) + self.server.login(user, password) + return self + + def close(self): + """Close connection""" + self.server.quit() + self.server = None + + def putfo(self, file_like, name): + """Transfer file-like object to server + + name: filename+extension for file at server + file_like: byte object, content of which + will appear in server as name + + Example + + bytes_ = b'abc def' + name = "abc.txt" + self.putfo(io.BytesIO(bytes_), name) + """ + self.server.storbinary("STOR " + name, file_like) + + def put(self, filepath, name): + """Transfer file object to server + + name: filename+extension for file at server + filepath: path + the actual file you are putting + """ + with open(filepath, "rb") as file: + self.server.storbinary("STOR " + name, file) + + def getfo(self, filepath, name): + """Get file-like object from server + + name: containt of file in filepath in bytes + filepath: filename+extension for file at server + """ + self.server.retrbinary("RETR " + filepath, name.write) + + def remove(self, file): + """Remove file from server""" + self.server.delete(file) + + def listdir(self, path=""): + """List directory in path""" + files = [] + try: + files = self.server.nlst(path) + except error_perm: + files = [] + return files + + def cd(self, path): + """Change directory""" + self.server.cwd(path) + + def exists(self, file, path=""): + """See if file exists in path""" + return file in self.server.nlst(path) diff --git a/server_ftp/lib/ftp_tls_server.py b/server_ftp/lib/ftp_tls_server.py new file mode 100644 index 00000000000..2d6bd2bd490 --- /dev/null +++ b/server_ftp/lib/ftp_tls_server.py @@ -0,0 +1,15 @@ +# Copyright 2020 - 2023 Therp BV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). +from ftplib import FTP_TLS + +from .ftp_server import FTPServer + + +class FTPTLSServer(FTPServer): + def connect(self, host, port, user, password): + """Connect to server""" + self.server = FTP_TLS() + # Init step by step + self.server.connect(host, port) + self.server.login(user, password) + return self diff --git a/server_ftp/lib/mock_server.py b/server_ftp/lib/mock_server.py new file mode 100644 index 00000000000..4ea165c04b2 --- /dev/null +++ b/server_ftp/lib/mock_server.py @@ -0,0 +1,92 @@ +# Copyright 2020 - 2023 Therp BV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). +from odoo import _ +from odoo.exceptions import UserError + +from .abstract_ftp_server import AbstractFTPServer + + +class MockServer(AbstractFTPServer): + """Define a Mock FTP server that stores and retrieves files from memory. + + The purpose it not so much to unittest the server_ftp module, but rather the + modules that use this module, without need for an external connection. + + You will need to put files first, before using any get functions. + """ + + def __init__(self): + super().__init__() + self.filestore = None # To hold file-objects in memory + self.current_directory = None + + def connect(self, host, port, user, password): + """Connect to object""" + self.filestore = {"/": {}} # One "directory" with no files. + self.current_directory = "/" + return self + + def close(self): + """Close connection""" + self.filestore = None + self.current_directory = None + + def putfo(self, file_like, name): + """Transfer file-like object to server + + name: filename+extension for file at server + file_like: byte object, content of which + will appear in server as name + """ + directory = self._get_checked_directory() + file_like.seek(0) + directory[name] = file_like.read() + + def put(self, filepath, name): + """Transfer file object to server + + name: filename+extension for file at server + filepath: filepath_to_file, content of which + will appear in server as name + """ + localfile = open(filepath, "rb") + self.putfo(localfile, name) + localfile.close() + + def getfo(self, name, file_like): + """Get file from server + + name: filename of file to retrieve + file_like: byte object to save containt + of filename + """ + directory = self._get_checked_directory() + return file_like.write(directory[name]) + + def remove(self, file): + """Remove file from server""" + directory = self._get_checked_directory() + del directory[file] + + def listdir(self, path=""): + """List directory in path""" + directory = self._get_checked_directory(path) + return list(directory.keys()) # list: otherwise returns dict_keys object. + + def cd(self, path): + """Change directory, automatically create it if not existing.""" + if path not in self.filestore: + self.filestore[path] = {} + self.current_directory = path + + def exists(self, file, path="."): + """See if file exists in path""" + directory = self._get_checked_directory(path) + return file in directory + + def _get_checked_directory(self, path=None): + """Get path, but check for existence.""" + path = path != "." and path or self.current_directory + if path not in self.filestore: + raise UserError(_("Path does not exist.")) + return self.filestore[path] diff --git a/server_ftp/lib/sftp_server.py b/server_ftp/lib/sftp_server.py new file mode 100644 index 00000000000..16198de04c5 --- /dev/null +++ b/server_ftp/lib/sftp_server.py @@ -0,0 +1,78 @@ +# Copyright 2020 - 2023 Therp BV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). +import posixpath + +import paramiko + +from .abstract_ftp_server import AbstractFTPServer + + +class SFTPServer(AbstractFTPServer): + def __init__(self): + super().__init__() + self.transport = None + + def connect(self, host, port, user, password): + """Connect to object""" + # paramiko directly, pysftp is no longer compatible + # TODO: make this secure (host key verification) + self.transport = paramiko.Transport((host, port)) + self.transport.connect(username=user, password=password) + self.server = paramiko.SFTPClient.from_transport(self.transport) + return self + + def close(self): + """Close connection""" + if self.server: + self.server.close() + if self.transport: + self.transport.close() + self.server = None + self.transport = None + + def putfo(self, file_like, name): + """Transfer file-like object to server + + name: filename+extension for file at server + file_like: byte object, content of which + will appear in server as name + """ + self.server.putfo(file_like, name) + + def put(self, filepath, name): + """Transfer file object to server + + name: filename+extension for file at server + filepath: filepath_to_file, content of which + will appear in server as name + """ + self.server.put(filepath, name) + + def getfo(self, name, file_like): + """Get file from server + + name: filename of file to retrieve + file_like: byte object to save containt + of filename + """ + self.server.getfo(name, file_like) + + def remove(self, file): + """Remove file from server""" + self.server.remove(file) + + def listdir(self, path=""): + """List directory in path""" + return self.server.listdir(path or ".") + + def cd(self, path): + """Change directory""" + self.server.chdir(path) + + def exists(self, file, path=""): + """See if file exists in path""" + try: + self.server.stat(posixpath.join(path, file)) + except FileNotFoundError: + return False + return True diff --git a/server_ftp/models/__init__.py b/server_ftp/models/__init__.py new file mode 100644 index 00000000000..320d6316b4b --- /dev/null +++ b/server_ftp/models/__init__.py @@ -0,0 +1,3 @@ +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). +from . import server_ftp +from . import server_ftp_folder diff --git a/server_ftp/models/server_ftp.py b/server_ftp/models/server_ftp.py new file mode 100644 index 00000000000..23fe9e8c23c --- /dev/null +++ b/server_ftp/models/server_ftp.py @@ -0,0 +1,96 @@ +# Copyright 2020 - 2023 Therp BV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). +import ftplib + +import paramiko + +from odoo import fields, models +from odoo.exceptions import UserError + +from ..lib.ftp_server import FTPServer +from ..lib.ftp_tls_server import FTPTLSServer +from ..lib.mock_server import MockServer +from ..lib.sftp_server import SFTPServer + +# Errors cd() can raise for the supported protocols +FOLDER_ERRORS = (*ftplib.all_errors, paramiko.SFTPError) + + +class ServerFTP(models.Model): + _name = "server.ftp" + _description = "Server FTP" + + name = fields.Char(required=True) + host = fields.Char(required=True) + user = fields.Char(required=True, default="anonymous", string="Username") + password = fields.Char() + port = fields.Integer(required=True, default=21) + server_type = fields.Selection( + selection=[ + ("ftp", "FTP"), + ("ftpls", "FTP_TLS"), + ("sftp", "SFTP"), + ("mock", "Mock"), + ], + string="Connection protocol", + required=True, + ) + state = fields.Selection( + selection=[("draft", "Not Confirmed"), ("done", "Confirmed")], + default="draft", + readonly=True, + required=True, + ) + folder_ids = fields.One2many( + comodel_name="server.ftp.folder", inverse_name="server_id" + ) + + def write(self, vals): + connection_fields = ["name", "user", "password", "port", "host", "server_type"] + if any(f in vals for f in connection_fields): + # Reset state if someone edits a connection field + vals["state"] = "draft" + return super().write(vals) + + def action_test_connection(self): + """Test the outcome of connect()""" + self.ensure_one() + if not all([self.host, self.port, self.user, self.password]): + raise UserError(self.env._("Make sure that required info is set")) + try: + server = self.connect() + except Exception as e: + raise UserError(str(e)) from e + # Check if all folders are accessible + not_accessible_folders = [] + for folder in self.folder_ids: + try: + server.cd(folder.path) + except FOLDER_ERRORS: + not_accessible_folders.append( + self.env._("Folder %s is not accessible", folder.name) + ) + server.close() + if not_accessible_folders: + raise UserError("\n".join(not_accessible_folders)) + self.state = "done" + + def connect(self): + """Return appropriate object based on server_type""" + self.ensure_one() + server = self._make_server_instance() + server.connect(self.host, self.port, self.user, self.password) + return server + + def _make_server_instance(self): + """Return server class for selected type.""" + if self.server_type == "ftp": + return FTPServer() + # Key matches the selection value + elif self.server_type == "ftpls": + return FTPTLSServer() + elif self.server_type == "sftp": + return SFTPServer() + elif self.server_type == "mock": + return MockServer() + raise UserError(self.env._("Unsupported FTP server type %s", self.server_type)) diff --git a/server_ftp/models/server_ftp_folder.py b/server_ftp/models/server_ftp_folder.py new file mode 100644 index 00000000000..a5edb80088f --- /dev/null +++ b/server_ftp/models/server_ftp_folder.py @@ -0,0 +1,18 @@ +# Copyright 2020 - 2023 Therp BV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). +from odoo import fields, models + + +class ServerFTPFolder(models.Model): + _name = "server.ftp.folder" + _description = "Server ftp folder" + + name = fields.Char() + path = fields.Char(help="change path upon connection") + server_id = fields.Many2one(comodel_name="server.ftp") + + def connect(self): + """Return appropriate FTP class, cd into path""" + server = self.server_id.connect() + server.cd(self.path) + return server diff --git a/server_ftp/pyproject.toml b/server_ftp/pyproject.toml new file mode 100644 index 00000000000..4231d0cccb3 --- /dev/null +++ b/server_ftp/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/server_ftp/readme/CONFIGURE.md b/server_ftp/readme/CONFIGURE.md new file mode 100644 index 00000000000..82805386bdd --- /dev/null +++ b/server_ftp/readme/CONFIGURE.md @@ -0,0 +1,7 @@ +To configure this module, you need to: + +1. Go to `Settings/Technical/FTP/Servers` +2. Find your favourite protocol and configure connection settings +3. In the form view of the record, edit file structure. +4. If more folders are needed, just add data records with a proper xml_id +5. If more servers are needed, just add data records with a proper xml_id diff --git a/server_ftp/readme/CONTRIBUTORS.md b/server_ftp/readme/CONTRIBUTORS.md new file mode 100644 index 00000000000..bba671cc0cf --- /dev/null +++ b/server_ftp/readme/CONTRIBUTORS.md @@ -0,0 +1 @@ +- Nikos Tsirintanis diff --git a/server_ftp/readme/CREDITS.md b/server_ftp/readme/CREDITS.md new file mode 100644 index 00000000000..931af23065a --- /dev/null +++ b/server_ftp/readme/CREDITS.md @@ -0,0 +1 @@ +Therp B.V. diff --git a/server_ftp/readme/DESCRIPTION.md b/server_ftp/readme/DESCRIPTION.md new file mode 100644 index 00000000000..9f9866ce9d5 --- /dev/null +++ b/server_ftp/readme/DESCRIPTION.md @@ -0,0 +1,11 @@ +This module enables connections via FTP, SFTP and FTP_TLS. +Operations such as retrieving a file, checking if a file exists, are all centralized +in an Abstract python class, so the user can operate without even noticing what protocol +they are using. + +For more exquisite operations, the user may retrieve a pure connection object in a +straighforward way. + +TODOS: + +- Secure everything diff --git a/server_ftp/readme/INSTALL.md b/server_ftp/readme/INSTALL.md new file mode 100644 index 00000000000..8319aff8fdf --- /dev/null +++ b/server_ftp/readme/INSTALL.md @@ -0,0 +1,4 @@ +To install this module, you need to: + +1. Have paramiko available `pip3 install paramiko` +2. Add it as dependency from your main module. diff --git a/server_ftp/readme/USAGE.md b/server_ftp/readme/USAGE.md new file mode 100644 index 00000000000..9894960fae3 --- /dev/null +++ b/server_ftp/readme/USAGE.md @@ -0,0 +1,33 @@ +To use this module, you need to: + +1. Configure and test you ftp/sftp/lsftp connection +2. Fetch the relevant server.ftp.folder record via it's xmlid +3. Code + +``` +>>> folder = session.env.ref("server_ftp.server_ftp_pull_folder_01_ftp") +>>> folder_server_object = folder.connect() +# folder_server_object is lib.ftp_server.FtpServer object +# You can perform simple operations like ls, put, get, close etc +# with folder_server_object. See lib/abstract_ftp_model.py for more +>>> folder_server_object.listdir() +-rw-rw-r-- 1 1001 1001 0 May 06 14:10 a_file.txt +-rw-rw-r-- 1 1001 1001 0 May 06 14:21 another_file.txt +>>> server = folder_server_object.get_server() +# server is ftplib.FTP object +# so we can do anything in ftplib +>>> server.dir() +-rw-rw-r-- 1 1001 1001 0 May 06 14:10 a_file.txt +-rw-rw-r-- 1 1001 1001 0 May 06 14:21 another_file.txt +>>> +>>> folder_server_object.remove("a_file.txt") +>>> folder_server_object.listdir() +-rw-rw-r-- 1 1001 1001 0 May 06 14:21 another_file.txt +>>> server.dir() +-rw-rw-r-- 1 1001 1001 0 May 06 14:21 another_file.txt +>>> server.delete("another_file.txt") +'250 Delete operation successful.' +>>> folder_server_object.listdir() +>>> server.dir() +>>> folder_server_object.close() == server.quit() +``` diff --git a/server_ftp/security/ir.access.csv b/server_ftp/security/ir.access.csv new file mode 100644 index 00000000000..1b66bf6210a --- /dev/null +++ b/server_ftp/security/ir.access.csv @@ -0,0 +1,3 @@ +id,name,model_id,group_id/id,operation,domain +access_server_ftp,server.ftp,server.ftp,base.group_system,crud, +access_server_ftp_folder,server.ftp.folder,server.ftp.folder,base.group_system,crud, diff --git a/server_ftp/static/description/index.html b/server_ftp/static/description/index.html new file mode 100644 index 00000000000..483ae340d3b --- /dev/null +++ b/server_ftp/static/description/index.html @@ -0,0 +1,503 @@ + + + + + +Server FTP + + + +
+ + + +Odoo Community Association + +
+

Server FTP

+ +

Beta License: AGPL-3 OCA/server-tools Translate me on Weblate Try me on Runboat

+

This module enables connections via FTP, SFTP and FTP_TLS. Operations +such as retrieving a file, checking if a file exists, are all +centralized in an Abstract python class, so the user can operate without +even noticing what protocol they are using.

+

For more exquisite operations, the user may retrieve a pure connection +object in a straighforward way.

+

TODOS:

+
    +
  • Secure everything
  • +
+

Table of contents

+ +
+

Installation

+

To install this module, you need to:

+
    +
  1. Have paramiko available pip3 install paramiko
  2. +
  3. Add it as dependency from your main module.
  4. +
+
+
+

Configuration

+

To configure this module, you need to:

+
    +
  1. Go to Settings/Technical/FTP/Servers
  2. +
  3. Find your favourite protocol and configure connection settings
  4. +
  5. In the form view of the record, edit file structure.
  6. +
  7. If more folders are needed, just add data records with a proper +xml_id
  8. +
  9. If more servers are needed, just add data records with a proper +xml_id
  10. +
+
+
+

Usage

+

To use this module, you need to:

+
    +
  1. Configure and test you ftp/sftp/lsftp connection
  2. +
  3. Fetch the relevant server.ftp.folder record via it’s xmlid
  4. +
  5. Code
  6. +
+
+>>> folder = session.env.ref("server_ftp.server_ftp_pull_folder_01_ftp")
+>>> folder_server_object = folder.connect()
+# folder_server_object is lib.ftp_server.FtpServer object
+# You can perform simple operations like ls, put, get, close etc
+# with folder_server_object. See lib/abstract_ftp_model.py for more
+>>> folder_server_object.listdir()
+-rw-rw-r--    1 1001     1001            0 May 06 14:10 a_file.txt
+-rw-rw-r--    1 1001     1001            0 May 06 14:21 another_file.txt
+>>> server = folder_server_object.get_server()
+# server is ftplib.FTP object
+# so we can do anything in ftplib
+>>> server.dir()
+-rw-rw-r--    1 1001     1001            0 May 06 14:10 a_file.txt
+-rw-rw-r--    1 1001     1001            0 May 06 14:21 another_file.txt
+>>>
+>>> folder_server_object.remove("a_file.txt")
+>>> folder_server_object.listdir()
+-rw-rw-r--    1 1001     1001            0 May 06 14:21 another_file.txt
+>>> server.dir()
+-rw-rw-r--    1 1001     1001            0 May 06 14:21 another_file.txt
+>>> server.delete("another_file.txt")
+'250 Delete operation successful.'
+>>> folder_server_object.listdir()
+>>> server.dir()
+>>> folder_server_object.close() == server.quit()
+
+
+
+

Bug Tracker

+

Bugs are tracked on GitHub Issues. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us to smash it by providing a detailed and welcomed +feedback.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • Therp BV
  • +
+
+
+

Contributors

+ +
+
+

Other credits

+

Therp B.V.

+
+
+

Maintainers

+

This module is maintained by the OCA.

+ +Odoo Community Association + +

OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use.

+

This module is part of the OCA/server-tools project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+
+ + diff --git a/server_ftp/tests/__init__.py b/server_ftp/tests/__init__.py new file mode 100644 index 00000000000..6a97669fa4f --- /dev/null +++ b/server_ftp/tests/__init__.py @@ -0,0 +1,3 @@ +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). +from . import common +from . import test_mock_server diff --git a/server_ftp/tests/common.py b/server_ftp/tests/common.py new file mode 100644 index 00000000000..c93986b08c1 --- /dev/null +++ b/server_ftp/tests/common.py @@ -0,0 +1,30 @@ +# Copyright 2020 - 2023 Therp BV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). +"""Define a class that can be used in Custom Modules to test FTP interactions.""" + +from odoo.tests.common import TransactionCase + + +class MockServerCase(TransactionCase): + """Test MockServer.""" + + @classmethod + def setUpClass(cls): + super().setUpClass() + cls.server = cls.env["server.ftp"].create( + { + "name": "Mock FTP Server for testing", + "server_type": "mock", + "host": "example.acme.com", + "user": "anonymous", + "password": "secret", + "state": "draft", + } + ) + cls.folder = cls.env["server.ftp.folder"].create( + { + "name": "Mock FTP Folder", + "server_id": cls.server.id, + "path": "example_directory", + } + ) diff --git a/server_ftp/tests/test_mock_server.py b/server_ftp/tests/test_mock_server.py new file mode 100644 index 00000000000..93c401638b1 --- /dev/null +++ b/server_ftp/tests/test_mock_server.py @@ -0,0 +1,46 @@ +# Copyright 2020 - 2023 Therp BV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). +from io import BytesIO + +from .common import MockServerCase + + +class TestMockServer(MockServerCase): + """Test MockServer.""" + + def test_mock_server(self): + """Test Mock FTP Server.""" + folder = self.folder + server = folder.server_id + server.action_test_connection() + self.assertEqual(server.state, "done") + directory = folder.connect() + self.assertEqual(directory.listdir(), []) + datas = BytesIO() + datas.write(b"Hello World!") + directory.putfo(datas, "hello.txt") + self.assertEqual(directory.listdir(), ["hello.txt"]) + self.assertTrue(directory.exists("hello.txt")) + self.assertFalse(directory.exists("bye.txt")) + get_datas = BytesIO() + directory.getfo("hello.txt", get_datas) + get_datas.seek(0) + hello_bytes = get_datas.read() + self.assertEqual(hello_bytes, b"Hello World!") + directory.remove("hello.txt") + self.assertFalse(directory.exists("hello.txt")) + self.assertEqual(directory.listdir(), []) + directory.close() + + def test_server_type_instances(self): + """Every selection value maps to a server class.""" + for value, _label in self.server._fields["server_type"].selection: + self.server.server_type = value + self.assertTrue(self.server._make_server_instance()) + + def test_multi_write_resets_state(self): + """Connection edits on several records reset state.""" + servers = self.server | self.server.copy() + servers.write({"state": "done"}) + servers.write({"host": "other.acme.com"}) + self.assertEqual(set(servers.mapped("state")), {"draft"}) diff --git a/server_ftp/views/server_ftp_views.xml b/server_ftp/views/server_ftp_views.xml new file mode 100644 index 00000000000..51a0556f7eb --- /dev/null +++ b/server_ftp/views/server_ftp_views.xml @@ -0,0 +1,129 @@ + + + + server.ftp.list + server.ftp + + + + + + + + + +