Source code for duplicity.backends.rsyncbackend

# -*- Mode:Python; indent-tabs-mode:nil; tab-width:4; encoding:utf-8 -*-
#
# Copyright 2002 Ben Escoto <ben@emerose.org>
# Copyright 2007 Kenneth Loafman <kenneth@loafman.com>
#
# This file is part of duplicity.
#
# Duplicity 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 2 of the License, or (at your
# option) any later version.
#
# Duplicity 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 duplicity; if not, write to the Free Software Foundation,
# Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA


import os
import re
import tempfile

import duplicity.backend
from duplicity import (
    config,
    tempdir,
    util,
)
from duplicity.errors import InvalidBackendURL


[docs]class RsyncBackend(duplicity.backend.Backend): """Connect to remote store using rsync rsync backend contributed by Sebastian Wilhelmi <seppi@seppi.de> rsyncd auth, alternate port support Copyright 2010 by Edgar Soldin <edgar.soldin@web.de> """
[docs] def __init__(self, parsed_url): """rsyncBackend initializer""" duplicity.backend.Backend.__init__(self, parsed_url) """ rsyncd module url: rsync://[user:password@]host[:port]::[/]modname/path Note: 3.0.7 is picky about syntax use either 'rsync://' or '::' cmd: rsync [--port=port] host::modname/path -or- rsync via ssh/rsh url: rsync://user@host[:port]://some_absolute_path -or- rsync://user@host[:port]:/some_relative_path cmd: rsync -e 'ssh [-p=port]' [user@]host:[/]path """ host = parsed_url.hostname port = "" # RSYNC_RSH from calling shell might conflict with our settings if "RSYNC_RSH" in os.environ: del os.environ["RSYNC_RSH"] if self.over_rsyncd(): # its a module path (path, port) = self.get_rsync_path() self.url_string = f"{host}::{path.lstrip('/:')}" if port: port = f" --port={port}" else: host_string = f"{host}:" if host else "" if parsed_url.path.startswith("//"): # its an absolute path self.url_string = f"{host_string}/{parsed_url.path.lstrip('/')}" else: # its a relative path self.url_string = f"{host_string}{parsed_url.path.lstrip('/')}" if parsed_url.port: port = f"-p {parsed_url.port}" # add trailing slash if missing if self.url_string[-1] != "/": self.url_string += "/" # user? if parsed_url.username: if self.over_rsyncd(): os.environ["USER"] = parsed_url.username else: self.url_string = f"{parsed_url.username}@{self.url_string}" # password?, don't ask if none was given self.use_getpass = False password = self.get_password() if password: os.environ["RSYNC_PASSWORD"] = password if self.over_rsyncd(): portOption = port else: portOption = f"-e 'ssh {port} -oBatchMode=yes {config.ssh_options}'" rsyncOptions = config.rsync_options # build cmd self.cmd = f"rsync {portOption} {rsyncOptions}"
[docs] def over_rsyncd(self): url = self.parsed_url.url_string if re.search("::[^:]*$", url): return True else: return False
[docs] def get_rsync_path(self): url = self.parsed_url.url_string m = re.search(r"(:\d+|)?::([^:]*)$", url) if m: return m.group(2), m.group(1).lstrip(":") raise InvalidBackendURL(f"Could not determine rsync path: {self.munge_password(url)}")
[docs] def _put(self, source_path, remote_filename): remote_filename = os.fsdecode(remote_filename) remote_path = os.path.join(self.url_string, remote_filename) commandline = f"{self.cmd} {source_path.uc_name} {remote_path}" self.subprocess_popen(commandline)
[docs] def _get(self, remote_filename, local_path): remote_filename = os.fsdecode(remote_filename) remote_path = os.path.join(self.url_string, remote_filename) commandline = f"{self.cmd} {remote_path} {local_path.uc_name}" self.subprocess_popen(commandline)
[docs] def _list(self): def split(str): # pylint: disable=redefined-builtin line = str.split() if len(line) > 4 and line[4] != ".": return line[4] else: return None commandline = f"{self.cmd} {self.url_string}" result, stdout, stderr = self.subprocess_popen(commandline) return [os.fsencode(x) for x in map(split, stdout.split("\n")) if x]
[docs] def _delete_list(self, filename_list): delete_list = filename_list dont_delete_list = [] for file in self._list(): if file in delete_list: delete_list.remove(file) else: dont_delete_list.append(file) dir = tempfile.mkdtemp() # pylint: disable=redefined-builtin exclude, exclude_name = tempdir.default().mkstemp_file() to_delete = [exclude_name] for file in dont_delete_list: file = os.fsdecode(file) path = os.path.join(dir, file) to_delete.append(path) try: f = open(path, "w") except IsADirectoryError: print(file, file=exclude) continue print(file, file=exclude) f.close() exclude.close() commandline = f"{self.cmd} --recursive --delete --exclude-from={exclude_name} {dir}/ {self.url_string}" self.subprocess_popen(commandline) for file in to_delete: try: util.ignore_missing(os.unlink, file) except IsADirectoryError: pass os.rmdir(dir)
duplicity.backend.register_backend("rsync", RsyncBackend) duplicity.backend.uses_netloc.extend(["rsync"])