Merge pull request #2712 from tafaRU/16.0-mig-auto_backup

[16.0][MIG] auto_backup

auto_backup/README.rst

@@ -0,0 +1,162 @@
+====================
+Database Auto-Backup
+====================
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:163fe86803c25bd1647c8a149b89b15db756b9f3551c73e29bc93c5d1d31a2ee
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |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/licence-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/16.0/auto_backup
+    :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-16-0/server-tools-16-0-auto_backup
+    :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=16.0
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+A tool for all your back-ups, internal and external!
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Installation
+============
+
+Before installing this module, you need to execute::
+
+    pip3 install pysftp==0.2.9
+
+Configuration
+=============
+
+Go to *Settings -> Database Structure -> Automated Backup* to
+create your configurations for each database that you needed
+to backups.
+
+Usage
+=====
+
+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!
+
+Connect with an FTP Server
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Keep your data safe, through an SSH tunnel!
+-------------------------------------------
+
+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!
+
+Test connection
+~~~~~~~~~~~~~~~
+
+Checks your credentials in one click
+------------------------------------
+
+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!
+
+E-mail on backup failure
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Stay informed of problems, automatically!
+-----------------------------------------
+
+Do you want to know if the database backup succeeded or failed? Subscribe to
+the corresponding backup setting notification type.
+
+Run backups when you want
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+From the backups configuration list, press *More > Execute backup(s)* to
+manually execute the selected processes.
+
+.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
+   :alt: Try me on Runbot
+   :target: https://runbot.odoo-community.org/runbot/149/11.0
+
+Known issues / Roadmap
+======================
+
+* On larger databases, it is possible that backups will die due to Odoo server
+  settings. In order to circumvent this without frivolously changing settings,
+  you need to run the backup from outside of the main Odoo instance. How to do
+  this is outlined in `this blog post
+  <https://blog.laslabs.com/2016/10/running-python-scripts-within-odoos-environment/>`_.
+* Backups won't work if list_db=False is configured in the instance.
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/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 <https://github.com/OCA/server-tools/issues/new?body=module:%20auto_backup%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+
+Do not contact contributors directly about support or help with technical issues.
+
+Credits
+=======
+
+Authors
+~~~~~~~
+
+* Yenthe Van Ginneken
+* Agile Business Group
+* Grupo ESOC Ingenieria de Servicios
+* LasLabs
+* AdaptiveCity
+
+Contributors
+~~~~~~~~~~~~
+
+* Yenthe Van Ginneken <yenthe.vanginneken@vanroey.be>
+* Alessio Gerace <alessio.gerace@agilebg.com>
+* Jairo Llopis <yajo.sk8@gmail.com>
+* Dave Lasley <dave@laslabs.com>
+* Andrea Stirpe <a.stirpe@onestein.nl>
+* Aitor Bouzas <aitor.bouzas@adaptivecity.com>
+* Simone Vanin <simone.vanin@agilebg.com>
+* Vu Nguyen Anh <vuna2004@gmail.com>
+* Alex Comba <alex.comba@agilebg.com>
+
+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 <https://github.com/OCA/server-tools/tree/16.0/auto_backup>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

auto_backup/__init__.py

@@ -0,0 +1,3 @@
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+
+from . import models

auto_backup/__manifest__.py

@@ -0,0 +1,28 @@
+# Copyright 2004-2009 Tiny SPRL (<http://tiny.be>).
+# Copyright 2015 Agile Business Group <http://www.agilebg.com>
+# Copyright 2016 Grupo ESOC Ingenieria de Servicios, S.L.U. - Jairo Llopis
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+
+{
+    "name": "Database Auto-Backup",
+    "summary": "Backups database",
+    "version": "16.0.1.0.0",
+    "author": "Yenthe Van Ginneken, "
+    "Agile Business Group, "
+    "Grupo ESOC Ingenieria de Servicios, "
+    "LasLabs, "
+    "AdaptiveCity, "
+    "Odoo Community Association (OCA)",
+    "license": "AGPL-3",
+    "website": "https://github.com/OCA/server-tools",
+    "category": "Tools",
+    "depends": ["mail"],
+    "data": [
+        "data/ir_cron.xml",
+        "data/mail_message_subtype.xml",
+        "security/ir.model.access.csv",
+        "view/db_backup_view.xml",
+    ],
+    "installable": True,
+    "external_dependencies": {"python": ["pysftp", "cryptography"]},
+}

auto_backup/data/ir_cron.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<odoo noupdate="1">
+    <record id="ir_cron_backup_scheduler_0" model="ir.cron">
+        <field name="name">Backup Scheduler</field>
+        <field name="user_id" ref="base.user_root" />
+        <field name="interval_number">1</field>
+        <field name="interval_type">days</field>
+        <field name="numbercall">-1</field>
+        <field
+            name="nextcall"
+            eval="(datetime.now() + timedelta(days=1)).strftime('%Y-%m-%d 03:00:00')"
+        />
+        <field name="model_id" ref="model_db_backup" />
+        <field name="state">code</field>
+        <field name="code">model.action_backup_all()</field>
+    </record>
+</odoo>

auto_backup/data/mail_message_subtype.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<odoo noupdate="1">
+    <record id="mail_message_subtype_success" model="mail.message.subtype">
+        <field name="name">Backup Successful</field>
+        <field name="description">Database backup succeeded.</field>
+        <field name="res_model">db.backup</field>
+        <field name="default" eval="False" />
+    </record>
+    <record id="mail_message_subtype_failure" model="mail.message.subtype">
+        <field name="name">Backup Failed</field>
+        <field name="description">Database backup failed.</field>
+        <field name="res_model">db.backup</field>
+        <field name="default" eval="True" />
+    </record>
+</odoo>