%s
%s" % ( + _("Database backup failed."), + escaped_tb), + subtype=self.env.ref( + "auto_backup.mail_message_subtype_failure" + ), + ) + else: + _logger.info("Database backup succeeded: %s", self.name) + self.message_post(body=_("Database backup succeeded.")) + + @api.multi + def cleanup(self): + """Clean up old backups.""" + now = datetime.now() + for rec in self.filtered("days_to_keep"): + with rec.cleanup_log(): + oldest = self.filename(now - timedelta(days=rec.days_to_keep)) + + if rec.method == "local": + for name in iglob(os.path.join(rec.folder, + "*.dump.zip")): + if os.path.basename(name) < oldest: + os.unlink(name) + + elif rec.method == "sftp": + with rec.sftp_connection() as remote: + for name in remote.listdir(rec.folder): + if (name.endswith(".dump.zip") and + os.path.basename(name) < oldest): + remote.unlink('%s/%s' % (rec.folder, name)) + + @api.multi + @contextmanager + def cleanup_log(self): + """Log a possible cleanup failure.""" + self.ensure_one() + try: + _logger.info( + "Starting cleanup process after database backup: %s", + self.name) + yield + except Exception: + _logger.exception("Cleanup of old database backups failed: %s") + escaped_tb = tools.html_escape(traceback.format_exc()) + self.message_post( # pylint: disable=translation-required + body="
%s
%s" % ( + _("Cleanup of old database backups failed."), + escaped_tb), + subtype=self.env.ref("auto_backup.failure")) + else: + _logger.info( + "Cleanup of old database backups succeeded: %s", + self.name) + + @staticmethod + def filename(when, ext='zip'): + """Generate a file name for a backup. + + :param datetime.datetime when: + Use this datetime instead of :meth:`datetime.datetime.now`. + :param str ext: Extension of the file. Default: dump.zip + """ + return "{:%Y_%m_%d_%H_%M_%S}.{ext}".format( + when, ext='dump.zip' if ext == 'zip' else ext + ) + + @api.multi + def sftp_connection(self): + """Return a new SFTP connection with found parameters.""" + self.ensure_one() + params = { + "host": self.sftp_host, + "username": self.sftp_user, + "port": self.sftp_port, + } + _logger.debug( + "Trying to connect to sftp://%(username)s@%(host)s:%(port)d", + extra=params) + if self.sftp_private_key: + params["private_key"] = self.sftp_private_key + if self.sftp_password: + params["private_key_pass"] = self.sftp_password + else: + params["password"] = self.sftp_password + + return pysftp.Connection(**params) diff --git a/auto_backup/readme/CONFIGURE.rst b/auto_backup/readme/CONFIGURE.rst new file mode 100644 index 000000000..406e81487 --- /dev/null +++ b/auto_backup/readme/CONFIGURE.rst @@ -0,0 +1,3 @@ +Go to *Settings -> Database Structure -> Automated Backup* to +create your configurations for each database that you needed +to backups. diff --git a/auto_backup/readme/CONTRIBUTORS.rst b/auto_backup/readme/CONTRIBUTORS.rst new file mode 100644 index 000000000..7ee6bb99e --- /dev/null +++ b/auto_backup/readme/CONTRIBUTORS.rst @@ -0,0 +1,6 @@ +* Yenthe Van Ginneken
A tool for all your back-ups, internal and external!
+Table of contents
+Before installing this module, you need to execute:
++pip3 install pysftp==0.2.8 ++
Go to Settings -> Database Structure -> Automated Backup to +create your configurations for each database that you needed +to backups.
+Keep your Odoo data safe with this module. Take automated back-ups, +remove them automatically and even write them to an external server +through an encrypted tunnel. You can even specify how long local backups +and external backups should be kept, automatically!
+Want to go even further and write your backups to an external server? +You can with this module! Specify the credentials to the server, specify +a path and everything will be backed up automatically. This is done +through an SSH (encrypted) tunnel, thanks to pysftp, so your data is +safe!
+Want to make sure if the connection details are correct and if Odoo can +automatically write them to the remote server? Simply click on the ‘Test +SFTP Connection’ button and you will get message telling you if +everything is OK, or what is wrong!
+Do you want to know if the database backup succeeded or failed? Subscribe to +the corresponding backup setting notification type.
+From the backups configuration list, press More > Execute backup(s) to +manually execute the selected processes.
+
+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 smashing it by providing a detailed and welcomed +feedback.
+Do not contact contributors directly about support or help with technical issues.
+This module is maintained by the OCA.
+
+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.
+