Compare commits

...

15 Commits

Author SHA1 Message Date
c715188973
Fix code with autopep8 2025-03-30 15:02:50 +02:00
57613649c2
Add missing type hints 2025-03-30 15:02:04 +02:00
67dbb49a67
Update PKGBUILD 2025-03-30 14:53:53 +02:00
e62a668f3e
Update metadata 2025-03-30 14:39:59 +02:00
bd8934d57f
Update version tag 2025-03-30 14:38:56 +02:00
96fe3c7813
Update man page 2025-03-30 14:38:29 +02:00
9fdb959540
Improve handling of user detection failure 2025-03-30 14:37:30 +02:00
eb889beee7
Add Python 3.13 to setup.cfg 2025-03-30 12:16:04 +02:00
2a37eb4172
Add PKGBUILD 2024-11-13 19:38:12 +01:00
45a07205a1
Add type hints plus minor code fixes 2024-09-28 09:47:33 +02:00
9390cd2de8
Allow removing remote old backups with sudo if possible
If allowed by the remote server, try using sudo to remove
old backups (rm needs to be allowed in sudoers to run
without password)
2023-10-15 15:39:06 +02:00
77661c0964
Handle getpass exception 2023-07-16 08:22:51 +02:00
e3a970217f
Improve logging 2023-06-25 11:49:02 +02:00
8968fcd1a8
Fix parsing option bug 2023-06-25 10:12:07 +02:00
35b87c859e
Add --user arg 2023-06-20 19:22:22 +02:00
7 changed files with 336 additions and 143 deletions

40
PKGBUILD Normal file
View File

@ -0,0 +1,40 @@
# PKGBUILD
# Maintainer: Daniele Fucini <dfucini [at] gmail [dot] com>
pkgname=simple_backup
pkgdesc='Simple backup script that uses rsync to copy files'
pkgver=4.1.6
pkgrel=1
url="https://git.shouldnt.work/fuxino/${pkgname}"
arch=('any')
license=('GPL-3.0-or-later')
makedepends=('git'
'python-setuptools'
'python-build'
'python-installer'
'python-wheel')
depends=('python>=3.10'
'rsync'
'python-dotenv')
optdepends=('python-systemd: use systemd log'
'python-dbus: for desktop notifications'
'python-paramiko: for remote backup through ssh')
conflicts=('simple_backup-git')
source=(git+${url}?signed#tag=${pkgver})
validpgpkeys=('7E12BC1FF3B6EDB2CD8053EB981A2B2A3BBF5514')
sha256sums=('b3b29d9e2e1b7b949e95674d9a401e8eeb0d5f898e8450473dce94f799ee9df3')
build()
{
cd ${srcdir}/${pkgname}
python -m build --wheel --no-isolation
}
package()
{
cd ${srcdir}/${pkgname}
python -m installer --destdir=${pkgdir} dist/*.whl
install -Dm644 ${pkgname}/${pkgname}.conf ${pkgdir}/usr/share/doc/${pkgname}/${pkgname}.conf
install -Dm644 man/${pkgname}.1 ${pkgdir}/usr/share/man/man1/${pkgname}.1
}

View File

@ -68,4 +68,4 @@ sudo --preserve-env=SSH_AUTH_SOCK -s simple_backup [options]
or by editing the sudoers file.
If SSH key authentication is not available, password authentication will be used instead.
Check the man page for more details.

View File

@ -1,4 +1,4 @@
.TH SIMPLE_BACKUP 1 2023-06-15 SIMPLE_BACKUP 3.2.6
.TH SIMPLE_BACKUP 1 2025-03-30 SIMPLE_BACKUP 4.1.6
.SH NAME
simple_backup \- Backup files and folders using rsync
.SH SYNOPSIS
@ -39,7 +39,7 @@ Parameters specified on the command line will override those in the configuratio
.SH OPTIONS
.TP
.B \-h, \-\-help
Print a short help message and exit
Print a short help message and exit.
.TP
.B \-c, \-\-config FILE
Specify the configuration file, useful to specify a different one from the default.
@ -52,21 +52,24 @@ or to use single or double quotes around them.
.B \-o, \-\-output DIR
Specify the directory where the files will be copied. The program will automatically
create a subdirectory called \(aqsimple_backup\(aq (if it does not already exist) and
inside this directory the actual backup directory (using the current date and time)
inside this directory the actual backup directory (using the current date and time).
.TP
.B \-e, \-\-exclude FILE|DIR|PATTERN [FILE|...]]
Specify files, directories or patterns to exclude from the backup. Matching files and directories
will not be copied. Multiple elements can be specified, in the same way as for the \-\-input option
will not be copied. Multiple elements can be specified, in the same way as for the \-\-input option.
.TP
.B \-k, \-\-keep N
Specify how many old backups (so excluding the current one) will be kept. The default behavior
is to keep them all (same as N=\-1)
is to keep them all (same as N=\-1).
.TP
.B \-u, \-\-user USERNAME
Explicitly specify the user running the backup (in case it is needed for home directory expansion).
.TP
.B \-\-ssh\-host HOSTNAME
Hostname of the server where to copy the files in case of remote backup through SSH
Hostname of the server where to copy the files in case of remote backup through SSH.
.TP
.B \-\-ssh\-user USERNAME
Username for connecting to the server in case of remote backup
Username for connecting to the server in case of remote backup.
.TP
.B \-\-keyfile FILE
Location of the SSH key for server authentication.
@ -85,24 +88,24 @@ before performing the backup.
Default behavior is to remove old backups after successfully completing the backup.
.TP
.B \-\-no\-syslog
Don't use systemd journal for logging
Don't use systemd journal for logging.
.TP
.B \-\-rsync\-options OPTIONS [OPTION...]
By default, the following rsync options are used:
.RS
.PP
.P
\-a \-r \-v \-h \-s \-H \-X
.PP
.P
Using \-\-rsync\-options it is possible to manually select which options to use. Supported values are the following:
.PP
.P
\-a, \-l, \-p, \-t, \-g, \-o, \-c, \-h, \-D, \-H, \-X, \-s
.PP
.P
Options \-r and \-v are used in any case. Not that options must be specified without dash (\-), for example:
.PP
.P
.EX
simple_backup \-\-rsync\-options a l p
.EE
.TP
.P
Check
.BR rsync (1)
for details about the options.
@ -111,12 +114,16 @@ for details about the options.
.B \-\-remote\-sudo
Run rsync on the remote server with sudo. This is needed if you want to preserve the owner of the files/folders to be copied (rsync \-\-owner option). For this to work the user used to login to the server obviously need to be allowed to use sudo. In addition, the user need to be able to run rsync with sudo without a password. To do this, /etc/sudoers on the server need to be edited adding a line like this one:
.RS
.PP
.P
<username> ALL=NOPASSWD:<path/to/rsync>
.P
To be able to remove old backups generated with \-\-remote\-sudo (see \-\-keep option), also
.BR rm (1)
needs to be allowed to run without password in the same way.
.RE
.TP
.B \-\-numeric\-ids
Use rsync \-\-numeric\-ids option. This causes rsync to use numeric uid/gid instead of trying to map uid/gid names from the local machine to the server
Use rsync \-\-numeric\-ids option. This causes rsync to use numeric uid/gid instead of trying to map uid/gid names from the local machine to the server.
.SH CONFIGURATION
An example configuration file is provided at \(aq/usr/share/doc/simple_backup/simple_backup.conf\(aq.
Copy it to the default location ($HOME/.config/simple_backup) and edit it as needed.
@ -136,7 +143,7 @@ When running
.B simple_backup
with
.B sudo,
in order to connect to the user\(aq s SSH agent it is necessary to preserve the \(aq SSH_AUTH_SOCK\(aq environment variable, for example:
in order to connect to the user\(aqs SSH agent it is necessary to preserve the \(aqSSH_AUTH_SOCK\(aq environment variable, for example:
.P
.EX
sudo --preserve-env=SSH_AUTH_SOCK -s simple_backup [options]
@ -145,8 +152,7 @@ in order to connect to the user\(aq s SSH agent it is necessary to preserve the
It is also possible to make this permanent by editing the
.B sudoers
file (see
.BR sudoers (5)
)
.BR sudoers (5))
.P
If SSH key authentication is not available, password authentication will be used instead.
Note that in this case
@ -159,28 +165,28 @@ for details. For this reason, use SSH key authentication if possible.
.SH EXIT STATUS
.TP
.B 0
The backup was completed without errors
The backup was completed without errors.
.TP
.B 1
No valid inputs selected for backup
No valid inputs selected for backup.
.TP
.B 2
Backup failed because output directory for storing the backup does not exist
Backup failed because output directory for storing the backup does not exist.
.TP
.B 3
Permission denied to access the output directory
Permission denied to access the output directory.
.TP
.B 4
rsync error (rsync returned a non-zero value)
rsync error (rsync returned a non-zero value).
.TP
.B 5
SSH connection failed
SSH connection failed.
.TP
.B 6
Bad configuration file
Bad configuration file.
.SH SEE ALSO
.BR rsync (1)
.SH AUTHORS
.MT https://github.com/Fuxino
.MT https://git.shouldnt.work/fuxino
Daniele Fucini
.ME

View File

@ -6,23 +6,22 @@ long_description = file: README.md
author = Daniele Fucini
author_email = dfucini@gmail.com
license = GPL3
url = https://github.com/Fuxino/simple_backup
url = https://git.shouldnt.work/fuxino
classifiers =
Development Status :: 4 - Beta
Environment :: Console
License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Natural Language :: English
Operating System :: POSIX :: Linux
Programming Language :: Python :: 3.7
Programming Language :: Python :: 3.8
Programming Language :: Python :: 3.9
Programming Language :: Python :: 3.10
Programming Language :: Python :: 3.11
Programming Language :: Python :: 3.12
Programming Language :: Python :: 3.13
Topic :: System :: Archiving :: Backup
[options]
packages = simple_backup
python_requires = >=3.7
python_requires = >=3.10
install_requires =
python-dotenv

View File

@ -1,3 +1,3 @@
"""Init."""
__version__ = '4.0.0'
__version__ = '4.1.6'

View File

@ -2,7 +2,7 @@
[backup]
# Files and directories to backup. Multiple items can be separated using a comma (','). It is possible to use wildcards (i.e. '*' to match multiple characters and '~' for the user's home directory).
inputs=/home/my_home,/etc
inputs=/home/user
# Output directory.
backup_dir=/media/Backup

View File

@ -14,6 +14,7 @@ Classes:
# Import libraries
import sys
import os
from typing import Callable, List, Optional, ParamSpec, TypeVar, Union
import warnings
from functools import wraps
from shutil import rmtree, which
@ -26,7 +27,7 @@ from timeit import default_timer
from subprocess import Popen, PIPE, STDOUT
from datetime import datetime
from tempfile import mkstemp
from getpass import getpass
from getpass import GetPassWarning, getpass
from glob import glob
from dotenv import load_dotenv
@ -51,15 +52,6 @@ except ImportError:
load_dotenv()
euid = os.geteuid()
if euid == 0:
user = os.getenv('SUDO_USER')
homedir = os.path.expanduser(f'~{user}')
else:
user = os.getenv('USER')
homedir = os.getenv('HOME')
logging.getLogger().setLevel(logging.DEBUG)
logger = logging.getLogger(os.path.basename(__file__))
c_handler = StreamHandler()
@ -76,29 +68,29 @@ if journal:
j_handler.setFormatter(j_format)
logger.addHandler(j_handler)
P = ParamSpec('P')
R = TypeVar('R')
def timing(_logger):
def timing(func: Callable[P, R]) -> Callable[P, R]:
"""Decorator to measure execution time of a function
Parameters:
_logger: Logger object
func: Function to decorate
"""
def decorator_timing(func):
@wraps(func)
def wrapper_timing(*args, **kwargs):
start = default_timer()
@wraps(func)
def wrapper(*args: P.args, **kwargs: P.kwargs) -> R:
start = default_timer()
value = func(*args, **kwargs)
value = func(*args, **kwargs)
end = default_timer()
end = default_timer()
_logger.info(f'Elapsed time: {end - start:.3f} seconds')
logger.info('Elapsed time: %.3f seconds', end - start)
return value
return value
return wrapper_timing
return decorator_timing
return wrapper
class MyFormatter(argparse.RawTextHelpFormatter, argparse.ArgumentDefaultsHelpFormatter):
@ -143,8 +135,9 @@ class Backup:
Perform the backup
"""
def __init__(self, inputs, output, exclude, keep, options, ssh_host=None, ssh_user=None,
ssh_keyfile=None, remote_sudo=False, remove_before=False):
def __init__(self, inputs: List[str], output: str, exclude: List[str], keep: int, options: str,
ssh_host: Optional[str] = None, ssh_user: Optional[str] = None, ssh_keyfile: Optional[str] = None,
remote_sudo: bool = False, remove_before: bool = False, verbose: bool = False) -> None:
self.inputs = inputs
self.output = output
self.exclude = exclude
@ -155,27 +148,29 @@ class Backup:
self.ssh_keyfile = ssh_keyfile
self.remote_sudo = remote_sudo
self._remove_before = remove_before
self._verbose = verbose
self._last_backup = ''
self._server = ''
self._output_dir = ''
self._inputs_path = ''
self._exclude_path = ''
self._remote = None
self._err_flag = False
self._remote = False
self._ssh = None
self._password_auth = False
self._password = None
def check_params(self):
def check_params(self, homedir: str = '') -> int:
"""Check if parameters for the backup are valid"""
if self.inputs is None or len(self.inputs) == 0:
logger.info('No existing files or directories specified for backup. Nothing to do')
logger.info(
'No existing files or directories specified for backup. Nothing to do')
return 1
if self.output is None:
logger.critical('No output path specified. Use -o argument or specify output path in configuration file')
logger.critical(
'No output path specified. Use -o argument or specify output path in configuration file')
return 2
@ -183,12 +178,13 @@ class Backup:
self._remote = True
if self._remote:
self._ssh = self._ssh_connect()
self._ssh = self._ssh_connect(homedir)
if self._ssh is None:
sys.exit(5)
return 5
_, stdout, _ = self._ssh.exec_command(f'if [ -d "{self.output}" ]; then echo "ok"; fi')
_, stdout, _ = self._ssh.exec_command(
f'if [ -d "{self.output}" ]; then echo "ok"; fi')
output = stdout.read().decode('utf-8').strip()
@ -210,7 +206,7 @@ class Backup:
return 0
# Function to create the actual backup directory
def define_backup_dir(self):
def define_backup_dir(self) -> None:
"""Define the actual backup dir"""
now = datetime.now().strftime('%Y-%m-%d %H:%M:%S')
self._output_dir = f'{self.output}/simple_backup/{now}'
@ -218,11 +214,14 @@ class Backup:
if self._remote:
self._server = f'{self.ssh_user}@{self.ssh_host}:'
def remove_old_backups(self):
def remove_old_backups(self) -> None:
"""Remove old backups if there are more than indicated by 'keep'"""
if self._remote:
_, stdout, _ = self._ssh.exec_command(f'ls {self.output}/simple_backup')
assert self._ssh is not None
_, stdout, _ = self._ssh.exec_command(
f'ls {self.output}/simple_backup')
dirs = stdout.read().decode('utf-8').strip().split('\n')
@ -238,12 +237,18 @@ class Backup:
dirs.sort()
for i in range(n_backup - self.keep):
_, _, stderr = self._ssh.exec_command(f'rm -r "{self.output}/simple_backup/{dirs[i]}"')
if self.remote_sudo:
_, _, stderr = self._ssh.exec_command(
f'sudo rm -r "{self.output}/simple_backup/{dirs[i]}"')
else:
_, _, stderr = self._ssh.exec_command(
f'rm -r "{self.output}/simple_backup/{dirs[i]}"')
err = stderr.read().decode('utf-8').strip().split('\n')[0]
if err != '':
logger.error('Error while removing backup %s.', {dirs[i]})
logger.error(
'Error while removing backup %s.', {dirs[i]})
logger.error(err)
else:
count += 1
@ -269,16 +274,18 @@ class Backup:
rmtree(f'{self.output}/simple_backup/{dirs[i]}')
count += 1
except FileNotFoundError:
logger.error('Error while removing backup %s. Directory not found', dirs[i])
logger.error(
'Error while removing backup %s. Directory not found', dirs[i])
except PermissionError:
logger.error('Error while removing backup %s. Permission denied', dirs[i])
logger.error(
'Error while removing backup %s. Permission denied', dirs[i])
if count == 1:
logger.info('Removed %d backup', count)
elif count > 1:
logger.info('Removed %d backups', count)
def find_last_backup(self):
def find_last_backup(self) -> None:
"""Get path of last backup (from last_backup symlink) for rsync --link-dest"""
if self._remote:
@ -286,7 +293,8 @@ class Backup:
logger.critical('SSH connection to server failed')
sys.exit(5)
_, stdout, _ = self._ssh.exec_command(f'find {self.output}/simple_backup/ -mindepth 1 -maxdepth 1 -type d | sort')
_, stdout, _ = self._ssh.exec_command(
f'find {self.output}/simple_backup/ -mindepth 1 -maxdepth 1 -type d | sort')
output = stdout.read().decode('utf-8').strip().split('\n')
if output[-1] != '':
@ -295,16 +303,18 @@ class Backup:
logger.info('No previous backups available')
else:
try:
dirs = sorted([f.path for f in os.scandir(f'{self.output}/simple_backup') if f.is_dir(follow_symlinks=False)])
dirs = sorted([f.path for f in os.scandir(
f'{self.output}/simple_backup') if f.is_dir(follow_symlinks=False)])
except FileNotFoundError:
logger.info('No previous backups available')
return
except PermissionError:
logger.critical('Cannot access the backup directory. Permission denied')
logger.critical(
'Cannot access the backup directory. Permission denied')
try:
notify('Backup failed (check log for details)')
_notify('Backup failed (check log for details)')
except NameError:
pass
@ -315,17 +325,18 @@ class Backup:
except IndexError:
logger.info('No previous backups available')
def _ssh_connect(self):
def _ssh_connect(self, homedir: str = '') -> paramiko.client.SSHClient:
try:
ssh = paramiko.SSHClient()
except NameError:
logger.error('Install paramiko for ssh support')
return None
try:
ssh.load_host_keys(filename=f'{homedir}/.ssh/known_hosts')
except FileNotFoundError:
logger.warning(f'Cannot find file {homedir}/.ssh/known_hosts')
logger.warning('Cannot find file %s/.ssh/known_hosts', homedir)
ssh.set_missing_host_key_policy(paramiko.WarningPolicy())
@ -334,7 +345,8 @@ class Backup:
return ssh
except UserWarning:
k = input(f'Unknown key for host {self.ssh_host}. Continue anyway? (Y/N) ')
k = input(
f'Unknown key for host {self.ssh_host}. Continue anyway? (Y/N) ')
if k[0].upper() == 'Y':
ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())
@ -357,13 +369,20 @@ class Backup:
if self.ssh_keyfile is None:
try:
password = getpass(f'{self.ssh_user}@{self.ssh_host}\'s password: ')
ssh.connect(self.ssh_host, username=self.ssh_user, password=password)
password = getpass(
f'{self.ssh_user}@{self.ssh_host}\'s password: ')
ssh.connect(self.ssh_host, username=self.ssh_user,
password=password)
self._password_auth = True
os.environ['SSHPASS'] = password
return ssh
except GetPassWarning as e:
logger.critical('Unable to get password')
logger.critical(e)
return None
except paramiko.SSHException as e:
logger.critical('Can\'t connect to the server.')
logger.critical(e)
@ -375,7 +394,8 @@ class Backup:
try:
pkey = RSAKey.from_private_key_file(self.ssh_keyfile)
except paramiko.PasswordRequiredException:
password = getpass(f'Enter passwphrase for key \'{self.ssh_keyfile}\': ')
password = getpass(
f'Enter passwphrase for key \'{self.ssh_keyfile}\': ')
try:
pkey = RSAKey.from_private_key_file(self.ssh_keyfile, password)
@ -387,7 +407,8 @@ class Backup:
pkey = Ed25519Key.from_private_key_file(self.ssh_keyfile)
except paramiko.PasswordRequiredException:
try:
pkey = Ed25519Key.from_private_key_file(self.ssh_keyfile, password)
pkey = Ed25519Key.from_private_key_file(
self.ssh_keyfile, password)
except paramiko.SSHException:
pass
@ -396,7 +417,8 @@ class Backup:
pkey = ECDSAKey.from_private_key_file(self.ssh_keyfile)
except paramiko.PasswordRequiredException:
try:
pkey = ECDSAKey.from_private_key_file(self.ssh_keyfile, password)
pkey = ECDSAKey.from_private_key_file(
self.ssh_keyfile, password)
except paramiko.SSHException:
pass
@ -405,7 +427,8 @@ class Backup:
pkey = DSSKey.from_private_key_file(self.ssh_keyfile)
except paramiko.PasswordRequiredException:
try:
pkey = DSSKey.from_private_key_file(self.ssh_keyfile, password)
pkey = DSSKey.from_private_key_file(
self.ssh_keyfile, password)
except paramiko.SSHException:
pass
@ -418,9 +441,51 @@ class Backup:
return ssh
def _returncode_log(self, returncode: int) -> None:
match returncode:
case 2:
logger.error(
'Rsync error (return code 2) - Protocol incompatibility')
case 3:
logger.error(
'Rsync error (return code 3) - Errors selecting input/output files, dirs')
case 4:
logger.error(
'Rsync error (return code 4) - Requested action not supported')
case 5:
logger.error(
'Rsync error (return code 5) - Error starting client-server protocol')
case 10:
logger.error(
'Rsync error (return code 10) - Error in socket I/O')
case 11:
logger.error(
'Rsync error (return code 11) - Error in file I/O')
case 12:
logger.error(
'Rsync error (return code 12) - Error in rsync protocol data stream')
case 22:
logger.error(
'Rsync error (return code 22) - Error allocating core memory buffers')
case 23:
logger.warning(
'Rsync error (return code 23) - Partial transfer due to error')
case 24:
logger.warning(
'Rsync error (return code 24) - Partial transfer due to vanished source files')
case 30:
logger.error(
'Rsync error (return code 30) - Timeout in data send/receive')
case 35:
logger.error(
'Rsync error (return code 35) - Timeout waiting for daemon connection')
case _:
logger.error(
'Rsync error (return code %d) - Check rsync(1) for details', returncode)
# Function to read configuration file
@timing(logger)
def run(self):
@timing
def run(self) -> int:
"""Perform the backup"""
logger.info('Starting backup...')
@ -446,10 +511,11 @@ class Backup:
count += 1
if count == 0:
logger.info('No existing files or directories specified for backup. Nothing to do')
logger.info(
'No existing files or directories specified for backup. Nothing to do')
try:
notify('Backup finished. No files copied')
_notify('Backup finished. No files copied')
except NameError:
pass
@ -470,10 +536,12 @@ class Backup:
if self._last_backup == '':
rsync = f'/usr/bin/rsync {self.options} --exclude-from={self._exclude_path} ' +\
f'--files-from={self._inputs_path} / "{self._server}{self._output_dir}"'
f'--files-from={self._inputs_path} / "{self._server}{self._output_dir}"'
else:
rsync = f'/usr/bin/rsync {self.options} --link-dest="{self._last_backup}" --exclude-from=' +\
f'{self._exclude_path} --files-from={self._inputs_path} / "{self._server}{self._output_dir}"'
f'{self._exclude_path} --files-from={self._inputs_path} / "{self._server}{self._output_dir}"'
euid = os.geteuid()
if euid == 0 and self.ssh_keyfile is not None:
rsync = f'{rsync} -e \'ssh -i {self.ssh_keyfile} -o StrictHostKeyChecking=no\''
@ -488,6 +556,7 @@ class Backup:
args = shlex.split(rsync)
with Popen(args, stdin=PIPE, stdout=PIPE, stderr=STDOUT, shell=False) as p:
output: Union[bytes, List[str]]
output, _ = p.communicate()
try:
@ -495,16 +564,24 @@ class Backup:
except KeyError:
pass
if p.returncode != 0:
self._err_flag = True
returncode = p.returncode
output = output.decode("utf-8").split('\n')
if self._err_flag:
logger.error('rsync: %s', output)
if returncode == 0:
if self._verbose:
logger.info('rsync: %s', output)
else:
logger.info('rsync: %s', output[-3])
logger.info('rsync: %s', output[-2])
else:
logger.info('rsync: %s', output[-3])
logger.info('rsync: %s', output[-2])
self._returncode_log(returncode)
if self._verbose:
if returncode in [23, 24]:
logger.warning(output)
else:
logger.error(output)
if self.keep != -1 and not self._remove_before:
self.remove_old_backups()
@ -513,7 +590,10 @@ class Backup:
os.remove(self._exclude_path)
if self._remote:
_, stdout, _ = self._ssh.exec_command(f'if [ -d "{self._output_dir}" ]; then echo "ok"; fi')
assert self._ssh is not None
_, stdout, _ = self._ssh.exec_command(
f'if [ -d "{self._output_dir}" ]; then echo "ok"; fi')
output = stdout.read().decode('utf-8').strip()
@ -535,51 +615,76 @@ class Backup:
if self._ssh:
self._ssh.close()
else:
if self._err_flag:
logger.error('Some errors occurred while performing the backup')
if returncode != 0:
logger.error(
'Some errors occurred while performing the backup')
try:
_notify('Some errors occurred while performing the backup. Check log for details')
_notify(
'Some errors occurred while performing the backup. Check log for details')
except NameError:
pass
return 4
else:
logger.info('Backup completed')
try:
_notify('Backup completed')
except NameError:
pass
logger.info('Backup completed')
try:
_notify('Backup completed')
except NameError:
pass
return 0
def _parse_arguments():
def _parse_arguments() -> argparse.Namespace:
euid = os.geteuid()
if euid == 0:
user = os.getenv('SUDO_USER')
else:
user = os.getenv('USER')
homedir = os.path.expanduser(f'~{user}')
parser = argparse.ArgumentParser(prog='simple_backup',
description='Simple backup script written in Python that uses rsync to copy files',
epilog='See simple_backup(1) manpage for full documentation',
formatter_class=MyFormatter)
parser.add_argument('-v', '--verbose', action='store_true',
help='More verbose output')
parser.add_argument('-c', '--config', default=f'{homedir}/.config/simple_backup/simple_backup.conf',
help='Specify location of configuration file')
parser.add_argument('-i', '--inputs', nargs='+', help='Paths/files to backup')
parser.add_argument('-o', '--output', help='Output directory for the backup')
parser.add_argument('-e', '--exclude', nargs='+', help='Files/directories/patterns to exclude from the backup')
parser.add_argument('-k', '--keep', type=int, help='Number of old backups to keep')
parser.add_argument('--ssh-host', help='Server hostname (for remote backup)')
parser.add_argument('--ssh-user', help='Username to connect to server (for remote backup)')
parser.add_argument('--keyfile', help='SSH key location')
parser.add_argument('-i', '--inputs', nargs='+',
help='Paths/files to backup')
parser.add_argument(
'-o', '--output', help='Output directory for the backup')
parser.add_argument('-e', '--exclude', nargs='+',
help='Files/directories/patterns to exclude from the backup')
parser.add_argument('-k', '--keep', type=int,
help='Number of old backups to keep')
parser.add_argument(
'-u', '--user', help='Explicitly specify the user running the backup')
parser.add_argument('-s', '--checksum', action='store_true',
help='Use checksum rsync option to compare files')
parser.add_argument('-z', '--compress', action='store_true', help='Compress data during the transfer')
parser.add_argument(
'--ssh-host', help='Server hostname (for remote backup)')
parser.add_argument(
'--ssh-user', help='Username to connect to server (for remote backup)')
parser.add_argument('--keyfile', help='SSH key location')
parser.add_argument('-z', '--compress', action='store_true',
help='Compress data during the transfer')
parser.add_argument('--remove-before-backup', action='store_true',
help='Remove old backups before executing the backup, instead of after')
parser.add_argument('--no-syslog', action='store_true', help='Disable systemd journal logging')
parser.add_argument('--no-syslog', action='store_true',
help='Disable systemd journal logging')
parser.add_argument('--rsync-options', nargs='+',
choices=['a', 'l', 'p', 't', 'g', 'o', 'c', 'h', 's', 'D', 'H', 'X'],
choices=['a', 'l', 'p', 't', 'g', 'o',
'c', 'h', 's', 'D', 'H', 'X'],
help='Specify options for rsync')
parser.add_argument('--remote-sudo', action='store_true', help='Run rsync on remote server with sudo if allowed')
parser.add_argument('--remote-sudo', action='store_true',
help='Run rsync on remote server with sudo if allowed')
parser.add_argument('--numeric-ids', action='store_true',
help='Use rsync \'--numeric-ids\' option (don\'t map uid/gid values by name)')
@ -588,24 +693,31 @@ def _parse_arguments():
return args
def _expand_inputs(inputs):
def _expand_inputs(inputs, user: Optional[str] = None):
expanded_inputs = []
for i in inputs:
if i == '':
continue
i_ex = glob(os.path.expanduser(i.replace('~', f'~{user}')))
if user is not None:
i_ex = glob(os.path.expanduser(i.replace('~', f'~{user}')))
else:
i_ex = glob(i)
if '~' in i:
logger.warning('Cannot expand \'~\'. No user specified')
if len(i_ex) == 0:
logger.warning('No file or directory matching input %s. Skipping...', i)
logger.warning(
'No file or directory matching input %s. Skipping...', i)
else:
expanded_inputs.extend(i_ex)
return expanded_inputs
def _read_config(config_file):
def _read_config(config_file, user: Optional[str] = None):
config_args = {'inputs': None,
'output': None,
'exclude': None,
@ -617,7 +729,11 @@ def _read_config(config_file):
'numeric_ids': False}
if not os.path.isfile(config_file):
logger.warning('Config file %s does not exist', config_file)
if user is not None:
logger.warning('Config file %s does not exist', config_file)
else:
logger.warning(
'User not specified. Can\'t read configuration file')
return config_args
@ -634,13 +750,17 @@ def _read_config(config_file):
inputs = config.get(section, 'inputs')
inputs = inputs.split(',')
inputs = _expand_inputs(inputs)
inputs = _expand_inputs(inputs, user)
inputs = list(set(inputs))
config_args['inputs'] = inputs
output = config.get(section, 'backup_dir')
output = os.path.expanduser(output.replace('~', f'~{user}'))
if user is not None:
output = os.path.expanduser(output.replace('~', f'~{user}'))
elif user is None and '~' in output:
logger.warning('Cannot expand \'~\', no user specified')
config_args['output'] = output
@ -693,29 +813,55 @@ def _read_config(config_file):
return config_args
def _notify(text):
_euid = os.geteuid()
def _notify(text: str) -> None:
euid = os.geteuid()
if _euid == 0:
if euid == 0:
uid = os.getenv('SUDO_UID')
else:
uid = os.geteuid()
uid = euid
if uid is None:
return
os.seteuid(int(uid))
os.environ['DBUS_SESSION_BUS_ADDRESS'] = f'unix:path=/run/user/{uid}/bus'
obj = dbus.SessionBus().get_object('org.freedesktop.Notifications', '/org/freedesktop/Notifications')
obj = dbus.SessionBus().get_object('org.freedesktop.Notifications',
'/org/freedesktop/Notifications')
obj = dbus.Interface(obj, 'org.freedesktop.Notifications')
obj.Notify('', 0, '', 'simple_backup', text, [], {'urgency': 1}, 10000)
os.seteuid(int(_euid))
os.seteuid(int(euid))
def simple_backup():
def simple_backup() -> int:
"""Main"""
args = _parse_arguments()
if args.user:
user = args.user
homedir = os.path.expanduser(f'~{user}')
else:
euid = os.geteuid()
if euid == 0:
user = os.getenv('SUDO_USER')
if user is not None:
homedir = os.path.expanduser(f'~{user}')
else:
logger.warning(
'Failed to detect user. You can use -u/--user parameter to manually specify it')
homedir = None
else:
user = os.getenv('USER')
homedir = os.getenv('HOME')
if homedir is None:
homedir = ''
if args.no_syslog:
try:
logger.removeHandler(j_handler)
@ -723,10 +869,11 @@ def simple_backup():
pass
try:
config_args = _read_config(args.config)
config_args = _read_config(args.config, user)
except (configparser.NoSectionError, configparser.NoOptionError):
logger.critical('Bad configuration file')
sys.exit(6)
return 6
inputs = args.inputs if args.inputs is not None else config_args['inputs']
output = args.output if args.output is not None else config_args['output']
@ -735,10 +882,11 @@ def simple_backup():
ssh_host = args.ssh_host if args.ssh_host is not None else config_args['ssh_host']
ssh_user = args.ssh_user if args.ssh_user is not None else config_args['ssh_user']
ssh_keyfile = args.keyfile if args.keyfile is not None else config_args['ssh_keyfile']
remote_sudo = args.remote_sudo if args.remote_sudo is not None else config_args['remote_sudo']
remote_sudo = args.remote_sudo or config_args['remote_sudo']
if args.rsync_options is None:
rsync_options = ['-a', '-r', '-v', '-h', '-H', '-X', '-s', '--ignore-missing-args', '--mkpath']
rsync_options = ['-a', '-r', '-v', '-h', '-H',
'-X', '-s', '--ignore-missing-args', '--mkpath']
else:
rsync_options = ['-r', '-v']
@ -757,9 +905,9 @@ def simple_backup():
rsync_options = ' '.join(rsync_options)
backup = Backup(inputs, output, exclude, keep, rsync_options, ssh_host, ssh_user, ssh_keyfile,
remote_sudo, remove_before=args.remove_before_backup)
remote_sudo, remove_before=args.remove_before_backup, verbose=args.verbose)
return_code = backup.check_params()
return_code = backup.check_params(homedir)
if return_code == 0:
return backup.run()