From 7ca4c9ff9e998b153a203815a2b8368d99cc5fcc Mon Sep 17 00:00:00 2001 From: Alessio Gerace Date: Mon, 11 May 2015 14:50:32 +0200 Subject: [PATCH] Open FTP session on the last moment possible Used to open fp = open(file_path,'wb') a few lines before it was needed. This shouldn't be too much of a problem but opening and closing it right after eachother keeps the session open for less time and there are less chances on failure. --- auto_backup/README.rst | 100 +++++ auto_backup/__init__.py | 24 ++ auto_backup/__openerp__.py | 43 +++ auto_backup/backup_scheduler.py | 267 ------------- auto_backup/data/backup_data.xml | 18 + auto_backup/i18n/it.po | 335 +++++++++++++++++ auto_backup/model/__init__.py | 23 ++ auto_backup/model/backup_scheduler.py | 376 +++++++++++++++++++ auto_backup/security/ir.model.access.csv | 2 + auto_backup/static/description/no_index.html | 100 +++++ auto_backup/tests/__init__.py | 22 ++ auto_backup/tests/test_auto_backup.py | 56 +++ auto_backup/view/bkp_conf_view.xml | 100 +++++ 13 files changed, 1199 insertions(+), 267 deletions(-) create mode 100644 auto_backup/README.rst create mode 100644 auto_backup/__init__.py create mode 100644 auto_backup/__openerp__.py delete mode 100644 auto_backup/backup_scheduler.py create mode 100644 auto_backup/data/backup_data.xml create mode 100644 auto_backup/i18n/it.po create mode 100644 auto_backup/model/__init__.py create mode 100644 auto_backup/model/backup_scheduler.py create mode 100644 auto_backup/security/ir.model.access.csv create mode 100644 auto_backup/static/description/no_index.html create mode 100644 auto_backup/tests/__init__.py create mode 100644 auto_backup/tests/test_auto_backup.py create mode 100644 auto_backup/view/bkp_conf_view.xml diff --git a/auto_backup/README.rst b/auto_backup/README.rst new file mode 100644 index 000000000..769f80059 --- /dev/null +++ b/auto_backup/README.rst @@ -0,0 +1,100 @@ +.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg + :alt: License: AGPL-3 + +================= +Automated backups +================= + +A tool for all your back-ups, internal and external! + +Installation +============ + +Before to install this module, you need to: + +instal pysftp via pip. + +Configuration +============= + +Go to Settings -> Configuration -> Configure Backup +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 failed? Check the checkbox 'Auto. E-mail on backup fail' and fill in your e-mail. +Every time a backup fails you will get an e-mail in your mailbox with technical details. + + +Known issues / Roadmap +====================== + +* ... + +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 smashing it by providing a detailed and welcomed feedback +`here `_. + + +Credits +======= + +Contributors +------------ + +* Yenthe Van Ginneken +* Alessio Gerace + +Maintainer +---------- + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +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. + +To contribute to this module, please visit http://odoo-community.org. \ No newline at end of file diff --git a/auto_backup/__init__.py b/auto_backup/__init__.py new file mode 100644 index 000000000..a8f54341e --- /dev/null +++ b/auto_backup/__init__.py @@ -0,0 +1,24 @@ +# -*- encoding: utf-8 -*- +############################################################################## +# +# OpenERP, Open Source Management Solution +# Copyright (C) 2004-2009 Tiny SPRL (). All Rights Reserved +# $Id$ +# Copyright (C) 2015 Agile Business Group +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +# +############################################################################## + +from . import model +from . import tests diff --git a/auto_backup/__openerp__.py b/auto_backup/__openerp__.py new file mode 100644 index 000000000..72f4389b7 --- /dev/null +++ b/auto_backup/__openerp__.py @@ -0,0 +1,43 @@ +# -*- coding: utf-8 -*- +############################################################################## +# +# OpenERP, Open Source Management Solution +# Copyright (C) 2004-2009 Tiny SPRL (). All Rights Reserved +# $Id$ +# Copyright (C) 2015 Agile Business Group +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +# +############################################################################## + +{ + "name": "Database Auto-Backup", + "version": "8.0.1.0.0", + "author": ( + "VanRoey.be - Yenthe Van Ginneken, Agile Business Group," + " Odoo Community Association (OCA)" + ), + 'license': "AGPL-3", + "website": "http://www.vanroey.be/applications/bedrijfsbeheer/odoo", + "category": "Tools", + "summary": "Backups data base", + "depends": ['email_template'], + "demo": [], + "data": [ + "view/bkp_conf_view.xml", + "data/backup_data.xml", + "security/ir.model.access.csv" + ], + "application": True, + "installable": True +} diff --git a/auto_backup/backup_scheduler.py b/auto_backup/backup_scheduler.py deleted file mode 100644 index 6ec77a903..000000000 --- a/auto_backup/backup_scheduler.py +++ /dev/null @@ -1,267 +0,0 @@ -# -*- encoding: utf-8 -*- -############################################################################## -# -# OpenERP, Open Source Management Solution -# Copyright (C) 2004-2009 Tiny SPRL (). All Rights Reserved -# $Id$ -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . -# -############################################################################## - -import xmlrpclib -import socket -import os -import time -import datetime -import base64 -import re -try: - import pysftp -except ImportError: - raise ImportError('This module needs pysftp to automaticly write backups to the FTP through SFTP.Please install pysftp on your system.(sudo pip install pysftp)') -from openerp.osv import fields,osv,orm -from openerp import tools -from openerp import netsvc -from openerp import tools, _ -import logging -_logger = logging.getLogger(__name__) - -def execute(connector, method, *args): - res = False - try: - res = getattr(connector,method)(*args) - except socket.error,e: - raise e - return res - -addons_path = tools.config['addons_path'] + '/auto_backup/DBbackups' - -class db_backup(osv.Model): - _name = 'db.backup' - - def get_db_list(self, cr, user, ids, host, port, context={}): - print("Host: " + host) - print("Port: " + port) - uri = 'http://' + host + ':' + port - conn = xmlrpclib.ServerProxy(uri + '/xmlrpc/db') - db_list = execute(conn, 'list') - return db_list - - def _get_db_name(self,cr,uid, vals,context=None): - attach_pool = self.pool.get("ir.logging") - dbName = cr.dbname - return dbName - - _columns = { - #Columns local server - 'host' : fields.char('Host', size=100, required='True'), - 'port' : fields.char('Port', size=10, required='True'), - 'name' : fields.char('Database', size=100, required='True',help='Database you want to schedule backups for'), - 'bkp_dir' : fields.char('Backup Directory', size=100, help='Absolute path for storing the backups', required='True'), - 'autoremove': fields.boolean('Auto. Remove Backups', help="If you check this option you can choose to automaticly remove the backup after xx days"), - 'daystokeep': fields.integer('Remove after x days', - help="Choose after how many days the backup should be deleted. For example:\nIf you fill in 5 the backups will be removed after 5 days.",required=True), - #Columns for external server (SFTP) - 'sftpwrite': fields.boolean('Write to external server with sftp', help="If you check this option you can specify the details needed to write to a remote server with SFTP."), - 'sftppath': fields.char('Path external server', help="The location to the folder where the dumps should be written to. For example /odoo/backups/.\nFiles will then be written to /odoo/backups/ on your remote server."), - 'sftpip': fields.char('IP Address SFTP Server', help="The IP address from your remote server. For example 192.168.0.1"), - 'sftpport': fields.integer("SFTP Port", help="The port on the FTP server that accepts SSH/SFTP calls."), - 'sftpusername': fields.char('Username SFTP Server', help="The username where the SFTP connection should be made with. This is the user on the external server."), - 'sftppassword': fields.char('Password User SFTP Server', help="The password from the user where the SFTP connection should be made with. This is the password from the user on the external server."), - 'daystokeepsftp': fields.integer('Remove SFTP after x days', help="Choose after how many days the backup should be deleted from the FTP server. For example:\nIf you fill in 5 the backups will be removed after 5 days from the FTP server."), - 'sendmailsftpfail': fields.boolean('Auto. E-mail on backup fail', help="If you check this option you can choose to automaticly get e-mailed when the backup to the external server failed."), - 'emailtonotify': fields.char('E-mail to notify', help="Fill in the e-mail where you want to be notified that the backup failed on the FTP."), - } - - _defaults = { - #'bkp_dir' : lambda *a : addons_path, - 'bkp_dir' : '/odoo/backups', - 'host' : lambda *a : 'localhost', - 'port' : lambda *a : '8069', - 'name': _get_db_name, - 'daystokeepsftp': 30, - 'sftpport': 22, - } - - def _check_db_exist(self, cr, user, ids): - for rec in self.browse(cr,user,ids): - db_list = self.get_db_list(cr, user, ids, rec.host, rec.port) - if rec.name in db_list: - return True - return False - - _constraints = [ - (_check_db_exist, _('Error ! No such database exists!'), []) - ] - - - def test_sftp_connection(self, cr, uid, ids, context=None): - conf_ids= self.search(cr, uid, []) - confs = self.browse(cr,uid,conf_ids) - #Check if there is a success or fail and write messages - messageTitle = "" - messageContent = "" - for rec in confs: - db_list = self.get_db_list(cr, uid, [], rec.host, rec.port) - try: - pathToWriteTo = rec.sftppath - ipHost = rec.sftpip - portHost = rec.sftpport - usernameLogin = rec.sftpusername - passwordLogin = rec.sftppassword - #Connect with external server over SFTP, so we know sure that everything works. - srv = pysftp.Connection(host=ipHost, username=usernameLogin, -password=passwordLogin,port=portHost) - srv.close() - #We have a success. - messageTitle = "Connection Test Succeeded!" - messageContent = "Everything seems properly set up for FTP back-ups!" - except Exception, e: - messageTitle = "Connection Test Failed!" - if len(rec.sftpip) < 8: - messageContent += "\nYour IP address seems to be too short.\n" - messageContent += "Here is what we got instead:\n" - if "Failed" in messageTitle: - raise osv.except_osv(_(messageTitle), _(messageContent + "%s") % tools.ustr(e)) - else: - raise osv.except_osv(_(messageTitle), _(messageContent)) - - def schedule_backup(self, cr, user, context={}): - conf_ids= self.search(cr, user, []) - confs = self.browse(cr,user,conf_ids) - for rec in confs: - db_list = self.get_db_list(cr, user, [], rec.host, rec.port) - if rec.name in db_list: - try: - if not os.path.isdir(rec.bkp_dir): - os.makedirs(rec.bkp_dir) - except: - raise - #Create name for dumpfile. - bkp_file='%s_%s.dump' % (time.strftime('%d_%m_%Y_%H_%M_%S'),rec.name) - file_path = os.path.join(rec.bkp_dir,bkp_file) - fp = open(file_path,'wb') - uri = 'http://' + rec.host + ':' + rec.port - conn = xmlrpclib.ServerProxy(uri + '/xmlrpc/db') - bkp='' - try: - bkp = execute(conn, 'dump', tools.config['admin_passwd'], rec.name) - except: - logger.notifyChannel('backup', netsvc.LOG_INFO, "Could'nt backup database %s. Bad database administrator password for server running at http://%s:%s" %(rec.name, rec.host, rec.port)) - continue - bkp = base64.decodestring(bkp) - fp.write(bkp) - fp.close() - else: - logger.notifyChannel('backup', netsvc.LOG_INFO, "database %s doesn't exist on http://%s:%s" %(rec.name, rec.host, rec.port)) - - #Check if user wants to write to SFTP or not. - if rec.sftpwrite is True: - try: - #Store all values in variables - dir = rec.bkp_dir - pathToWriteTo = rec.sftppath - ipHost = rec.sftpip - portHost = rec.sftpport - usernameLogin = rec.sftpusername - passwordLogin = rec.sftppassword - #Connect with external server over SFTP - srv = pysftp.Connection(host=ipHost, username=usernameLogin, -password=passwordLogin, port=portHost) - #Move to the correct directory on external server. If the user made a typo in his path with multiple slashes (/odoo//backups/) it will be fixed by this regex. - pathToWriteTo = re.sub('([/]{2,5})+','/',pathToWriteTo) - print(pathToWriteTo) - try: - srv.chdir(pathToWriteTo) - except IOError: - #Create directory and subdirs if they do not exist. - currentDir = '' - for dirElement in pathToWriteTo.split('/'): - currentDir += dirElement + '/' - try: - srv.chdir(currentDir) - except: - print('(Part of the) path didn\'t exist. Creating it now at ' + currentDir) - #Make directory and then navigate into it - srv.mkdir(currentDir, mode=777) - srv.chdir(currentDir) - pass - srv.chdir(pathToWriteTo) - #Loop over all files in the directory. - for f in os.listdir(dir): - fullpath = os.path.join(dir, f) - if os.path.isfile(fullpath): - print(fullpath) - srv.put(fullpath) - - #Navigate in to the correct folder. - srv.chdir(pathToWriteTo) - - #Loop over all files in the directory from the back-ups. - #We will check the creation date of every back-up. - for file in srv.listdir(pathToWriteTo): - #Get the full path - fullpath = os.path.join(pathToWriteTo,file) - #Get the timestamp from the file on the external server - timestamp = srv.stat(fullpath).st_atime - createtime = datetime.datetime.fromtimestamp(timestamp) - now = datetime.datetime.now() - delta = now - createtime - #If the file is older than the daystokeepsftp (the days to keep that the user filled in on the Odoo form it will be removed. - if delta.days >= rec.daystokeepsftp: - #Only delete files, no directories! - if srv.isfile(fullpath) and ".dump" in file: - print("Delete: " + file) - srv.unlink(file) - #Close the SFTP session. - srv.close() - except Exception, e: - _logger.debug('Exception! We couldn\'t back up to the FTP server..') - #At this point the SFTP backup failed. We will now check if the user wants - #an e-mail notification about this. - if rec.sendmailsftpfail: - try: - ir_mail_server = self.pool.get('ir.mail_server') - message = "Dear,\n\nThe backup for the server " + rec.host + " (IP: " + rec.sftpip + ") failed.Please check the following details:\n\nIP address SFTP server: " + rec.sftpip + "\nUsername: " + rec.sftpusername + "\nPassword: " + rec.sftppassword + "\n\nError details: " + tools.ustr(e) + "\n\nWith kind regards" - msg = ir_mail_server.build_email("auto_backup@" + rec.name + ".com", [rec.emailtonotify], "Backup from " + rec.host + "(" + rec.sftpip + ") failed", message) - ir_mail_server.send_email(cr, user, msg) - except Exception: - pass - - """Remove all old files (on local server) in case this is configured.. - This is done after the SFTP writing to prevent unusual behaviour: - If the user would set local back-ups to be kept 0 days and the SFTP - to keep backups xx days there wouldn't be any new back-ups added to the - SFTP. - If we'd remove the dump files before they're writen to the SFTP there willbe nothing to write. Meaning that if an user doesn't want to keep back-ups locally and only wants them on the SFTP (NAS for example) there wouldn't be any writing to the remote server if this if statement was before the SFTP write method right above this comment. - """ - if rec.autoremove is True: - dir = rec.bkp_dir - #Loop over all files in the directory. - for f in os.listdir(dir): - fullpath = os.path.join(dir, f) - timestamp = os.stat(fullpath).st_ctime - createtime = datetime.datetime.fromtimestamp(timestamp) - now = datetime.datetime.now() - delta = now - createtime - if delta.days >= rec.daystokeep: - #Only delete files (which are .dump), no directories. - if os.path.isfile(fullpath) and ".dump" in f: - print("Delete: " + fullpath) - os.remove(fullpath) - -db_backup() - -# vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: \ No newline at end of file diff --git a/auto_backup/data/backup_data.xml b/auto_backup/data/backup_data.xml new file mode 100644 index 000000000..8911a3bd6 --- /dev/null +++ b/auto_backup/data/backup_data.xml @@ -0,0 +1,18 @@ + + + + + + + + + + + + + + + + + + diff --git a/auto_backup/i18n/it.po b/auto_backup/i18n/it.po new file mode 100644 index 000000000..a12a5cacb --- /dev/null +++ b/auto_backup/i18n/it.po @@ -0,0 +1,335 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * auto_backup +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 8.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2015-07-21 13:00+0000\n" +"PO-Revision-Date: 2015-07-21 13:00+0000\n" +"Last-Translator: <>\n" +"Language-Team: \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: \n" + + +#. module: auto_backup +#: code:addons/auto_backup/model/backup_scheduler.py:204 +#, python-format +msgid "\n" +"Your IP address seems to be too short.\n" +"" +msgstr "\n" +"L' indirizzo IP sembra essere troppo corto.\n" +"" + +#. module: auto_backup +#: code:addons/auto_backup/model/backup_scheduler.py:209 +#, python-format +msgid "%s" +msgstr "%s" + +#. module: auto_backup +#: code:addons/auto_backup/model/backup_scheduler.py:288 +#, python-format +msgid "(Part of the) path didn't exist. Creating it now at %s" +msgstr "(Una parte del) path non esiste. Verra' creato in %s" + +#. module: auto_backup +#: help:db.backup,bkp_dir:0 +msgid "Absolute path for storing the backups" +msgstr "Percorso assoluto per il salvataggio del DB" + +#. module: auto_backup +#: field:db.backup,sendmailsftpfail:0 +msgid "Auto. E-mail on backup fail" +msgstr "Auto. E-mail nel caso di errori durante il backup " + +#. module: auto_backup +#: field:db.backup,autoremove:0 +msgid "Auto. Remove Backups" +msgstr "Rimuovi Backups" + +#. module: auto_backup +#: view:db.backup:auto_backup.view_backup_conf_form +msgid "Automatic backups of the database can be scheduled as follows:" +msgstr "Il backup automatico del DB e' pianificato come segue:" + +#. module: auto_backup +#: field:db.backup,bkp_dir:0 +msgid "Backup Directory" +msgstr "Backup Directory" + +#. module: auto_backup +#: model:email.template,subject:auto_backup.email_template_autobackup_error_noificaiton +msgid "Backup from ${object.host} - (${object.sftpip}) failed" +msgstr "Backup da ${object.host} - (${object.sftpip}) fallito" + +#. module: auto_backup +#: view:db.backup:auto_backup.view_backup_conf_tree +msgid "Backups" +msgstr "Backups" + +#. module: auto_backup +#: help:db.backup,daystokeepsftp:0 +msgid "Choose after how many days the backup should be deleted from the FTP server. For example:\n" +"If you fill in 5 the backups will be removed after 5 days from the FTP server." +msgstr "Scegliere dopo quanti giorni si possa condsiderare da eliminare, un Backup nel server FTP. Per esempio:\n" +"se si imposta 5 i files di backups piu' vecchi di 5 giorni saranno eliminati dal server FTP" + +#. module: auto_backup +#: help:db.backup,daystokeep:0 +msgid "Scegliere dopo quanti giorni si possa condsiderare da eliminare un Backup. For example:\n" +"If you fill in 5 the backups will be removed after 5 days." +msgstr "Choose after how many days the backup should be deleted. For example:\n" +"se si imposta 5 i files di backups piu' vecchi di 5 giorni saranno eliminati." + +#. module: auto_backup +#: model:ir.actions.act_window,name:auto_backup.action_backup_conf_form +#: model:ir.ui.menu,name:auto_backup.backup_conf_menu +msgid "Configure Backup" +msgstr "Configura Backup" + +#. module: auto_backup +#: code:addons/auto_backup/model/backup_scheduler.py:202 +#, python-format +msgid "Connection Test Failed!" +msgstr "Test connessione Fallito!" + +#. module: auto_backup +#: code:addons/auto_backup/model/backup_scheduler.py:198 +#, python-format +msgid "Connection Test Succeeded!" +msgstr "Test connessione avvenuto con successo!" + +#. module: auto_backup +#: code:addons/auto_backup/model/backup_scheduler.py:241 +#, python-format +msgid "Couldn't backup database %s. Bad database administratorpassword for server running at http://%s:%s" +msgstr "Impossibile eseguire il backup di %s. DB password erraata per il server http://%s:%s" + +#. module: auto_backup +#: field:db.backup,create_uid:0 +msgid "Created by" +msgstr "Created by" + +#. module: auto_backup +#: field:db.backup,create_date:0 +msgid "Created on" +msgstr "Created on" + +#. module: auto_backup +#: field:db.backup,name:0 +msgid "Database" +msgstr "Database" + +#. module: auto_backup +#: help:db.backup,name:0 +msgid "Database you want to schedule backups for" +msgstr "Database you want to schedule backups for" + +#. module: auto_backup +#: field:db.backup,emailtonotify:0 +#: field:db.backup,lasterrorlog:0 +msgid "E-mail to notify" +msgstr "E-mail di notifica" + +#. module: auto_backup +#: code:addons/auto_backup/model/backup_scheduler.py:176 +#, python-format +msgid "Error" +msgstr "Errore" + +#. module: auto_backup +#: code:addons/auto_backup/model/backup_scheduler.py:176 +#, python-format +msgid "Error ! No such database exists!" +msgstr "Errore ! Il DB non esiste!" + +#. module: auto_backup +#: code:addons/auto_backup/model/backup_scheduler.py:199 +#, python-format +msgid "Everything seems properly set up for FTP back-ups!" +msgstr "Tutto sembra impostato correttamente per il back-up FTP!" + +#. module: auto_backup +#: help:db.backup,emailtonotify:0 +#: help:db.backup,lasterrorlog:0 +msgid "Fill in the e-mail where you want to be notified that the backup failed on the FTP." +msgstr "Compilare l'e -mail in cui si desidera essere avvisati,se il backup FTP fallisce." + +#. module: auto_backup +#: view:db.backup:auto_backup.view_backup_conf_form +msgid "For example: /odoo/backups/" +msgstr "Es.: /odoo/backups/" + +#. module: auto_backup +#: view:db.backup:auto_backup.view_backup_conf_form +msgid "Go to Settings / Technical / Automation / Scheduled Actions." +msgstr "Anadare in Settings / Technical / Automation / Scheduled Actions." + +#. module: auto_backup +#: view:db.backup:auto_backup.view_backup_conf_form +msgid "Help" +msgstr "Aiuto" + +#. module: auto_backup +#: field:db.backup,host:0 +msgid "Host" +msgstr "Host" + +#. module: auto_backup +#: field:db.backup,id:0 +msgid "ID" +msgstr "ID" + +#. module: auto_backup +#: field:db.backup,sftpip:0 +msgid "IP Address SFTP Server" +msgstr "IP Address SFTP Server" + +#. module: auto_backup +#: help:db.backup,sendmailsftpfail:0 +msgid "If you check this option you can choose to automaticly get e-mailed when the backup to the external server failed." +msgstr "Se si seleziona questa opzione è possibile scegliere di essere notificati automaticamente via e-mail quando il backup al server esterno fallisce ." + +#. module: auto_backup +#: help:db.backup,autoremove:0 +msgid "If you check this option you can choose to automaticly remove the backup after xx days" +msgstr "Se si seleziona questa opzione è possibile scegliere di rimuovere automaticamente il backup dopo xx giorni" + +#. module: auto_backup +#: help:db.backup,sftpwrite:0 +msgid "If you check this option you can specify the details needed to write to a remote server with SFTP." +msgstr "Se si seleziona questa opzione è possibile specificare i dettagli necessari per scrivere a un server remoto con SFTP ." + +#. module: auto_backup +#: field:db.backup,write_uid:0 +msgid "Last Updated by" +msgstr "Last Updated by" + +#. module: auto_backup +#: field:db.backup,write_date:0 +msgid "Last Updated on" +msgstr "Last Updated on" + +#. module: auto_backup +#: view:db.backup:auto_backup.view_backup_conf_form +msgid "Local backup configuration" +msgstr "Configurazione backup locale" + +#. module: auto_backup +#: field:db.backup,sftppassword:0 +msgid "Password User SFTP Server" +msgstr "Password utene SFTP Server" + +#. module: auto_backup +#: field:db.backup,sftppath:0 +msgid "Path external server" +msgstr "Path server esterno" + +#. module: auto_backup +#: field:db.backup,port:0 +msgid "Port" +msgstr "Porta" + +#. module: auto_backup +#: field:db.backup,daystokeepsftp:0 +msgid "Remove SFTP after x days" +msgstr "Rimuovi backup da SFTP dopo x giorni" + +#. module: auto_backup +#: field:db.backup,daystokeep:0 +msgid "Remove after x days" +msgstr "Rimuovi dopo x giorni" + +#. module: auto_backup +#: view:db.backup:auto_backup.view_backup_conf_form +msgid "SFTP" +msgstr "SFTP" + +#. module: auto_backup +#: field:db.backup,sftpport:0 +msgid "SFTP Port" +msgstr "Porta SFTP" + +#. module: auto_backup +#: view:db.backup:auto_backup.view_backup_conf_search +msgid "Search options" +msgstr "Search options" + +#. module: auto_backup +#: view:db.backup:auto_backup.view_backup_conf_form +msgid "Search the action named 'Backup scheduler'." +msgstr "Cerca l'azione denominata ' di pianificazione del backup ' ." + +#. module: auto_backup +#: view:db.backup:auto_backup.view_backup_conf_form +msgid "Set the scheduler to active and fill in how often you want backups generated." +msgstr "Impostare lo scheduler per attivare e compilare la frequenza con cui si desidera generare il backup." + +#. module: auto_backup +#: view:db.backup:auto_backup.view_backup_conf_form +msgid "Test" +msgstr "Test" + +#. module: auto_backup +#: view:db.backup:auto_backup.view_backup_conf_form +msgid "Test SFTP Connection" +msgstr "Test SFTP Connection" + +#. module: auto_backup +#: help:db.backup,sftpip:0 +msgid "The IP address from your remote server. For example 192.168.0.1" +msgstr "Indirizzo IP server remoto. Es. 192.168.0.1" + +#. module: auto_backup +#: help:db.backup,sftppath:0 +msgid "The location to the folder where the dumps should be written to. For example /odoo/backups/.\n" +"Files will then be written to /odoo/backups/ on your remote server." +msgstr "La posizione della cartella in cui i dumps devono essere scritti. Es. /odoo/backups/.\n" +"i files verranno scritti su /odoo/backups/ nel server remoto." + +#. module: auto_backup +#: help:db.backup,sftppassword:0 +msgid "The password from the user where the SFTP connection should be made with. This is the password from the user on the external server." +msgstr "La password dell'utente con cui la connessione SFTP deve essere fatta. Questa è la password dall'utente sul server esterno ." + +#. module: auto_backup +#: help:db.backup,sftpport:0 +msgid "The port on the FTP server that accepts SSH/SFTP calls." +msgstr "La porta sul server FTP che accetta chiamate SSH / SFTP." + +#. module: auto_backup +#: help:db.backup,sftpusername:0 +msgid "The username where the SFTP connection should be made with. This is the user on the external server." +msgstr "Il nome utente in cui la connessione SFTP dovrebbe essere fatto con . Questo è l'utente sul server esterno." + +#. module: auto_backup +#: view:db.backup:auto_backup.view_backup_conf_form +msgid "This configures the scheduler for automatic backup of the given database running on given host at given port on regular intervals." +msgstr "pianificazione per il backup automatico del database in esecuzione su dato host /porta ad intervalli regolari." + +#. module: auto_backup +#: view:db.backup:auto_backup.view_backup_conf_form +msgid "Use SFTP with caution! This writes files to external servers under the path you specify." +msgstr "Usare SFTP con cautela ! Questo scrive file su server esterni nel percorso specificato " + +#. module: auto_backup +#: field:db.backup,sftpusername:0 +msgid "Username SFTP Server" +msgstr "Username SFTP Server" + +#. module: auto_backup +#: view:db.backup:auto_backup.view_backup_conf_form +msgid "Warning:" +msgstr "Warning:" + +#. module: auto_backup +#: field:db.backup,sftpwrite:0 +msgid "Write to external server with sftp" +msgstr "Salva il backup anche su server FTP esterno" + diff --git a/auto_backup/model/__init__.py b/auto_backup/model/__init__.py new file mode 100644 index 000000000..995d7f02b --- /dev/null +++ b/auto_backup/model/__init__.py @@ -0,0 +1,23 @@ +# -*- coding: utf-8 -*- +############################################################################## +# +# OpenERP, Open Source Management Solution +# Copyright (C) 2004-2009 Tiny SPRL (). All Rights Reserved +# $Id$ +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +# +############################################################################## + +from . import backup_scheduler diff --git a/auto_backup/model/backup_scheduler.py b/auto_backup/model/backup_scheduler.py new file mode 100644 index 000000000..479023ff5 --- /dev/null +++ b/auto_backup/model/backup_scheduler.py @@ -0,0 +1,376 @@ +# -*- coding: utf-8 -*- +############################################################################## +# OpenERP, Open Source Management Solution +# Copyright (C) 2004-2009 Tiny SPRL (). All Rights Reserved +# Copyright 2015 Agile Business Group +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +# +############################################################################## +import socket +import os +import time +import datetime +import re +from openerp import models, fields, api, _ +from openerp.exceptions import except_orm, Warning as UserError +from openerp import tools +from openerp.service import db +import logging +_logger = logging.getLogger(__name__) +try: + import pysftp +except ImportError: + _logger.debug('Can not import pysftp') + + +def execute(connector, method, *args): + res = False + try: + res = getattr(connector, method)(*args) + except socket.error as e: + raise e + return res + + +class DbBackup(models.Model): + _name = 'db.backup' + + @api.model + def _get_db_name(self): + return self.env.cr.dbname + + name = fields.Char( + string='Database', size=100, required=True, + default=_get_db_name, + help='Database you want to schedule backups for' + ) + + bkp_dir = fields.Char( + string='Backup Directory', size=100, + default='/odoo/backups', + help='Absolute path for storing the backups', + required=True + ) + autoremove = fields.Boolean( + string='Auto. Remove Backups', + help=( + "If you check this option you can choose to " + "automaticly remove the backup after xx days" + ) + ) + daystokeep = fields.Integer( + string='Remove after x days', + default=30, + help=( + "Choose after how many days the backup should be " + "deleted. For example:\nIf you fill in 5 the backups " + "will be removed after 5 days." + ), required=True + ) + sftpwrite = fields.Boolean( + string='Write to external server with sftp', + help=( + "If you check this option you can specify the details " + "needed to write to a remote server with SFTP." + ) + ) + sftppath = fields.Char( + string='Path external server', + help=( + "The location to the folder where the dumps should be " + "written to. For example /odoo/backups/.\nFiles will then" + " be written to /odoo/backups/ on your remote server." + ) + ) + sftpip = fields.Char( + string='IP Address SFTP Server', + help=( + "The IP address from your remote" + " server. For example 192.168.0.1" + ) + ) + sftpport = fields.Integer( + string="SFTP Port", + default=22, + help="The port on the FTP server that accepts SSH/SFTP calls." + ) + sftpusername = fields.Char( + string='Username SFTP Server', + help=( + "The username where the SFTP connection " + "should be made with. This is the user on the external server." + ) + ) + sftppassword = fields.Char( + string='Password User SFTP Server', + help=( + "The password from the user where the SFTP connection " + "should be made with. This is the password from the user" + " on the external server." + ) + ) + daystokeepsftp = fields.Integer( + string='Remove SFTP after x days', + default=30, + help=( + "Choose after how many days the backup should be deleted " + "from the FTP server. For example:\nIf you fill in 5 the " + "backups will be removed after 5 days from the FTP server." + ) + ) + sendmailsftpfail = fields.Boolean( + string='Auto. E-mail on backup fail', + help=( + "If you check this option you can choose to automaticly" + " get e-mailed when the backup to the external server failed." + ) + ) + emailtonotify = fields.Char( + string='E-mail to notify', + help=( + "Fill in the e-mail where you want to be" + " notified that the backup failed on the FTP." + ) + ) + lasterrorlog = fields.Text( + string='E-mail to notify', + help=( + "Fill in the e-mail where you want to be" + " notified that the backup failed on the FTP." + ) + ) + + @api.multi + def _check_db_exist(self): + for rec in self: + db_list = db.exp_list(True) + if rec.name in db_list: + return True + return False + + _constraints = [ + ( + _check_db_exist, + _('Error ,No such database exists'), ['name'] + ) + ] + + @api.multi + def test_sftp_connection(self): + confs = self.search([]) + # Check if there is a success or fail and write messages + messageTitle = "" + messageContent = "" + conn_success = False + for rec in confs: + try: + conn_success = True + ipHost = rec.sftpip + portHost = rec.sftpport + usernameLogin = rec.sftpusername + passwordLogin = rec.sftppassword + # Connect with external server over SFTP, so we know sure that + # everything works. + srv = pysftp.Connection(host=ipHost, username=usernameLogin, + password=passwordLogin, port=portHost) + srv.close() + # We have a success. + messageTitle = _("Connection Test Succeeded!") + messageContent = _( + "Everything seems properly set up for FTP back-ups!") + except Exception as e: + conn_success = False + messageTitle = _("Connection Test Failed!") + if len(rec.sftpip) < 8: + messageContent += _( + "\nYour IP address seems to be too short.\n") + messageContent += _("Here is what we got instead:\n") + if not conn_success: + raise except_orm( + _(messageTitle), _( + messageContent + "%s") % + tools.ustr(e)) + else: + raise UserError(_(messageTitle), _(messageContent)) + + @api.model + def schedule_backup(self): + + for rec in self.search([]): + if not os.path.isdir(rec.bkp_dir): + os.makedirs(rec.bkp_dir) + # Create name for dumpfile. + bkp_file = '%s_%s.dump.zip' % ( + time.strftime('%d_%m_%Y_%H_%M_%S'), + rec.name) + file_path = os.path.join(rec.bkp_dir, bkp_file) + fbk = open(file_path, 'wb') + db.dump_db(rec.name, fbk) + fbk.close() + # Check if user wants to write to SFTP or not. + if rec.sftpwrite is True: + try: + # Store all values in variables + dir = rec.bkp_dir + pathToWriteTo = rec.sftppath + ipHost = rec.sftpip + portHost = rec.sftpport + usernameLogin = rec.sftpusername + passwordLogin = rec.sftppassword + # Connect with external server over SFTP + srv = pysftp.Connection( + host=ipHost, + username=usernameLogin, + password=passwordLogin, + port=portHost) + # Move to the correct directory on external server. If the + # user made a typo in his path with multiple slashes + # (/odoo//backups/) it will be fixed by this regex. + pathToWriteTo = re.sub('/+', '/', pathToWriteTo) + _logger.debug( + 'Start to copy files..' + ) + try: + srv.chdir(pathToWriteTo) + except IOError: + # Create directory and subdirs if they do not exist. + currentDir = '' + for dirElement in pathToWriteTo.split('/'): + currentDir += dirElement + '/' + try: + srv.chdir(currentDir) + except: + _logger.info( + _( + '(Part of the) path didn\'t exist. ' + 'Creating it now at %s' + ) % currentDir + ) + # Make directory and then navigate into it + srv.mkdir(currentDir, mode=777) + srv.chdir(currentDir) + pass + srv.chdir(pathToWriteTo) + # Loop over all files in the directory. + for f in os.listdir(dir): + fullpath = os.path.join(dir, f) + if os.path.isfile(fullpath): + srv.put(fullpath) + + # Navigate in to the correct folder. + srv.chdir(pathToWriteTo) + # Loop over all files in the directory from the back-ups. + # We will check the creation date of every back-up. + for file in srv.listdir(pathToWriteTo): + # Get the full path + fullpath = os.path.join(pathToWriteTo, file) + if srv.isfile(fullpath) and ".dump.zip" in file: + # Get the timestamp from the file on the external + # server + timestamp = srv.stat(fullpath).st_atime + createtime = ( + datetime.datetime.fromtimestamp(timestamp) + ) + now = datetime.datetime.now() + delta = now - createtime + # If the file is older than the daystokeepsftp (the + # days to keep that the user filled in on the Odoo + # form it will be removed. + if ( + rec.daystokeepsftp > 0 and + delta.days >= rec.daystokeepsftp + ): + # Only delete files, no directories! + srv.unlink(file) + # Close the SFTP session. + srv.close() + except Exception as e: + _logger.debug( + 'Exception We couldn\'t back ' + 'up to the FTP server..' + ) + # At this point the SFTP backup failed. + # We will now check if the user wants + # an e-mail notification about this. + if rec.sendmailsftpfail: + self.send_notification(rec, e) + + # Remove all old files (on local server) + # in case this is configured.. + if rec.autoremove is True: + try: + self.remove_folder(rec) + except Exception as e: + _logger.debug( + 'Exception when try to remove file' + ) + + return True + + def send_notification(self, rec, e): + try: + ir_mail_server = self.env['ir.mail_server'] + message = ( + "Dear,\n\nThe backup for the server %s" + " (IP: %s) failed.Please check" + " the following details:\n\n" + "IP address SFTP server: %s \nUsername: %s" + "\nPassword: %s" + "\n\nError details: %s \n\nWith kind regards" + ) % ( + rec.host, rec.sftpip, rec.sftpip, + rec.sftpusername, rec.sftppassword, + tools.ustr(e) + ) + msg = ir_mail_server.build_email( + "auto_backup@%s.com" % rec.name, + [rec.emailtonotify], + "Backup from %s ( %s ) failed" % ( + rec.host, rec.sftpip), + message) + ir_mail_server.send_email(msg) + + except Exception as e: + _logger.debug( + 'Exception %s' % tools.ustr(e) + ) + + # This is done after the SFTP writing to prevent unusual behaviour: + # If the user would set local back-ups to be kept 0 days and the SFTP + # to keep backups xx days there wouldn't be any new back-ups added + # to the SFTP. + # If we'd remove the dump files before they're writen to the SFTP + # there willbe nothing to write. Meaning that if an user doesn't want + # to keep back-ups locally and only wants them on the SFTP + # (NAS for example) there wouldn't be any writing to the + # remote server if this if statement was before the SFTP write method + # right above this comment. + def remove_folder(self, rec): + dir = rec.bkp_dir + # Loop over all files in the directory. + for f in os.listdir(dir): + fullpath = os.path.join(dir, f) + if os.path.isfile(fullpath) and ".dump.zip" in f: + timestamp = os.stat(fullpath).st_ctime + createtime = ( + datetime.datetime.fromtimestamp(timestamp) + ) + now = datetime.datetime.now() + delta = now - createtime + if delta.days >= rec.daystokeep: + _logger.debug( + 'Remove local file...' + ) + os.remove(fullpath) diff --git a/auto_backup/security/ir.model.access.csv b/auto_backup/security/ir.model.access.csv new file mode 100644 index 000000000..e38dbf11b --- /dev/null +++ b/auto_backup/security/ir.model.access.csv @@ -0,0 +1,2 @@ +id,name,model_id:id,group_id:id,perm_read,perm_write,perm_create,perm_unlink +access_db_backup,access_db_backup,model_db_backup,,1,0,0,0 diff --git a/auto_backup/static/description/no_index.html b/auto_backup/static/description/no_index.html new file mode 100644 index 000000000..6b3ba3e2b --- /dev/null +++ b/auto_backup/static/description/no_index.html @@ -0,0 +1,100 @@ +
+
+
+

Automated backups

+

A tool for all your back-ups, internal and external!

+
+
+
+ +
+
+
+

+ 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! +

+
+ Start your free trial +
+
+
+
+ +
+
+

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 failed? Check the checkbox 'Auto. E-mail on backup fail' and fill in your e-mail. + Every time a backup fails you will get an e-mail in your mailbox with technical details. +

+
+
+
+ +
+
+
+
+ +
+
+
+

Contact / Support

+

Need help or want extra features?

+
+
+
+ +
+
+
+

+ Need help with the configuration or want this module to have more functionalities? + Contact us through e-mail at yenthe.vanginneken@vanroey.be or tony.crols@vanroey.be +

+
+
+
diff --git a/auto_backup/tests/__init__.py b/auto_backup/tests/__init__.py new file mode 100644 index 000000000..01e81ba8a --- /dev/null +++ b/auto_backup/tests/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +############################################################################## +# +# Copyright 2015 Agile Business Group +# Copyright (C) 2015 Alessio Gerace +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published +# by the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +# +############################################################################## + +from . import test_auto_backup diff --git a/auto_backup/tests/test_auto_backup.py b/auto_backup/tests/test_auto_backup.py new file mode 100644 index 000000000..e2e6fee45 --- /dev/null +++ b/auto_backup/tests/test_auto_backup.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- +############################################################################## +# +# Copyright 2015 Agile Business Group +# Copyright (C) 2015 Alessio Gerace +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +# +############################################################################## + +from openerp.tests import common +from openerp.exceptions import except_orm +import os +import time + + +class TestsAutoBackup(common.TransactionCase): + + def setUp(self): + super(TestsAutoBackup, self).setUp() + self.abk_model = self.env["db.backup"] + self.cron_model = self.env["ir.cron"] + + def test_0(self): + with self.assertRaises(except_orm): + self.abk_model.create( + { + 'name': 'abcd', + 'adminpassword': 'admin' + } + ) + + def test_1(self): + this = self.abk_model.create( + { + 'bkp_dir': '/tmp' + } + ) + self.assertEqual(this.bkp_dir, '/tmp') + bkp_file = '%s_%s.dump.zip' % ( + time.strftime('%d_%m_%Y_%H_%M_%S'), + this.name) + file_path = os.path.join(this.bkp_dir, bkp_file) + this.schedule_backup() + self.assertTrue(os.path.isfile(file_path)) diff --git a/auto_backup/view/bkp_conf_view.xml b/auto_backup/view/bkp_conf_view.xml new file mode 100644 index 000000000..cb2281b08 --- /dev/null +++ b/auto_backup/view/bkp_conf_view.xml @@ -0,0 +1,100 @@ + + + + + + Configure Backup + db.backup + form + +
+ + + + + + + + + + + + +
+ Warning: + Use SFTP with caution! This writes files to external servers under the path you specify. +
+ + + + + + + + + + +