Compare commits

...

12 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
7 changed files with 228 additions and 105 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. or by editing the sudoers file.
If SSH key authentication is not available, password authentication will be used instead. 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 .SH NAME
simple_backup \- Backup files and folders using rsync simple_backup \- Backup files and folders using rsync
.SH SYNOPSIS .SH SYNOPSIS
@ -93,19 +93,19 @@ Don't use systemd journal for logging.
.B \-\-rsync\-options OPTIONS [OPTION...] .B \-\-rsync\-options OPTIONS [OPTION...]
By default, the following rsync options are used: By default, the following rsync options are used:
.RS .RS
.PP .P
\-a \-r \-v \-h \-s \-H \-X \-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: 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 \-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: Options \-r and \-v are used in any case. Not that options must be specified without dash (\-), for example:
.PP .P
.EX .EX
simple_backup \-\-rsync\-options a l p simple_backup \-\-rsync\-options a l p
.EE .EE
.TP .P
Check Check
.BR rsync (1) .BR rsync (1)
for details about the options. for details about the options.
@ -114,8 +114,12 @@ for details about the options.
.B \-\-remote\-sudo .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: 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 .RS
.PP .P
<username> ALL=NOPASSWD:<path/to/rsync> <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 .RE
.TP .TP
.B \-\-numeric\-ids .B \-\-numeric\-ids
@ -139,7 +143,7 @@ When running
.B simple_backup .B simple_backup
with with
.B sudo, .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 .P
.EX .EX
sudo --preserve-env=SSH_AUTH_SOCK -s simple_backup [options] sudo --preserve-env=SSH_AUTH_SOCK -s simple_backup [options]
@ -148,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 It is also possible to make this permanent by editing the
.B sudoers .B sudoers
file (see file (see
.BR sudoers (5) .BR sudoers (5))
)
.P .P
If SSH key authentication is not available, password authentication will be used instead. If SSH key authentication is not available, password authentication will be used instead.
Note that in this case Note that in this case
@ -184,6 +187,6 @@ Bad configuration file.
.SH SEE ALSO .SH SEE ALSO
.BR rsync (1) .BR rsync (1)
.SH AUTHORS .SH AUTHORS
.MT https://github.com/Fuxino .MT https://git.shouldnt.work/fuxino
Daniele Fucini Daniele Fucini
.ME .ME

View File

@ -6,7 +6,7 @@ long_description = file: README.md
author = Daniele Fucini author = Daniele Fucini
author_email = dfucini@gmail.com author_email = dfucini@gmail.com
license = GPL3 license = GPL3
url = https://github.com/Fuxino/simple_backup url = https://git.shouldnt.work/fuxino
classifiers = classifiers =
Development Status :: 4 - Beta Development Status :: 4 - Beta
Environment :: Console Environment :: Console
@ -16,6 +16,7 @@ classifiers =
Programming Language :: Python :: 3.10 Programming Language :: Python :: 3.10
Programming Language :: Python :: 3.11 Programming Language :: Python :: 3.11
Programming Language :: Python :: 3.12 Programming Language :: Python :: 3.12
Programming Language :: Python :: 3.13
Topic :: System :: Archiving :: Backup Topic :: System :: Archiving :: Backup
[options] [options]

View File

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

View File

@ -2,7 +2,7 @@
[backup] [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). # 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. # Output directory.
backup_dir=/media/Backup backup_dir=/media/Backup

View File

@ -14,6 +14,7 @@ Classes:
# Import libraries # Import libraries
import sys import sys
import os import os
from typing import Callable, List, Optional, ParamSpec, TypeVar, Union
import warnings import warnings
from functools import wraps from functools import wraps
from shutil import rmtree, which from shutil import rmtree, which
@ -26,7 +27,7 @@ from timeit import default_timer
from subprocess import Popen, PIPE, STDOUT from subprocess import Popen, PIPE, STDOUT
from datetime import datetime from datetime import datetime
from tempfile import mkstemp from tempfile import mkstemp
from getpass import getpass from getpass import GetPassWarning, getpass
from glob import glob from glob import glob
from dotenv import load_dotenv from dotenv import load_dotenv
@ -67,29 +68,29 @@ if journal:
j_handler.setFormatter(j_format) j_handler.setFormatter(j_format)
logger.addHandler(j_handler) 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 """Decorator to measure execution time of a function
Parameters: Parameters:
_logger: Logger object func: Function to decorate
""" """
def decorator_timing(func): @wraps(func)
@wraps(func) def wrapper(*args: P.args, **kwargs: P.kwargs) -> R:
def wrapper_timing(*args, **kwargs): start = default_timer()
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 wrapper
return decorator_timing
class MyFormatter(argparse.RawTextHelpFormatter, argparse.ArgumentDefaultsHelpFormatter): class MyFormatter(argparse.RawTextHelpFormatter, argparse.ArgumentDefaultsHelpFormatter):
@ -134,8 +135,9 @@ class Backup:
Perform the backup Perform the backup
""" """
def __init__(self, inputs, output, exclude, keep, options, ssh_host=None, ssh_user=None, def __init__(self, inputs: List[str], output: str, exclude: List[str], keep: int, options: str,
ssh_keyfile=None, remote_sudo=False, remove_before=False, verbose=False): 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.inputs = inputs
self.output = output self.output = output
self.exclude = exclude self.exclude = exclude
@ -152,21 +154,23 @@ class Backup:
self._output_dir = '' self._output_dir = ''
self._inputs_path = '' self._inputs_path = ''
self._exclude_path = '' self._exclude_path = ''
self._remote = None self._remote = False
self._ssh = None self._ssh = None
self._password_auth = False self._password_auth = False
self._password = None self._password = None
def check_params(self, homedir=''): def check_params(self, homedir: str = '') -> int:
"""Check if parameters for the backup are valid""" """Check if parameters for the backup are valid"""
if self.inputs is None or len(self.inputs) == 0: 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 return 1
if self.output is None: 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 return 2
@ -179,7 +183,8 @@ class Backup:
if self._ssh is None: if self._ssh is None:
return 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() output = stdout.read().decode('utf-8').strip()
@ -201,7 +206,7 @@ class Backup:
return 0 return 0
# Function to create the actual backup directory # Function to create the actual backup directory
def define_backup_dir(self): def define_backup_dir(self) -> None:
"""Define the actual backup dir""" """Define the actual backup dir"""
now = datetime.now().strftime('%Y-%m-%d %H:%M:%S') now = datetime.now().strftime('%Y-%m-%d %H:%M:%S')
self._output_dir = f'{self.output}/simple_backup/{now}' self._output_dir = f'{self.output}/simple_backup/{now}'
@ -209,11 +214,14 @@ class Backup:
if self._remote: if self._remote:
self._server = f'{self.ssh_user}@{self.ssh_host}:' 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'""" """Remove old backups if there are more than indicated by 'keep'"""
if self._remote: 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') dirs = stdout.read().decode('utf-8').strip().split('\n')
@ -229,12 +237,18 @@ class Backup:
dirs.sort() dirs.sort()
for i in range(n_backup - self.keep): 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] err = stderr.read().decode('utf-8').strip().split('\n')[0]
if err != '': if err != '':
logger.error('Error while removing backup %s.', {dirs[i]}) logger.error(
'Error while removing backup %s.', {dirs[i]})
logger.error(err) logger.error(err)
else: else:
count += 1 count += 1
@ -260,16 +274,18 @@ class Backup:
rmtree(f'{self.output}/simple_backup/{dirs[i]}') rmtree(f'{self.output}/simple_backup/{dirs[i]}')
count += 1 count += 1
except FileNotFoundError: 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: 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: if count == 1:
logger.info('Removed %d backup', count) logger.info('Removed %d backup', count)
elif count > 1: elif count > 1:
logger.info('Removed %d backups', count) 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""" """Get path of last backup (from last_backup symlink) for rsync --link-dest"""
if self._remote: if self._remote:
@ -277,7 +293,8 @@ class Backup:
logger.critical('SSH connection to server failed') logger.critical('SSH connection to server failed')
sys.exit(5) 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') output = stdout.read().decode('utf-8').strip().split('\n')
if output[-1] != '': if output[-1] != '':
@ -286,16 +303,18 @@ class Backup:
logger.info('No previous backups available') logger.info('No previous backups available')
else: else:
try: 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: except FileNotFoundError:
logger.info('No previous backups available') logger.info('No previous backups available')
return return
except PermissionError: except PermissionError:
logger.critical('Cannot access the backup directory. Permission denied') logger.critical(
'Cannot access the backup directory. Permission denied')
try: try:
notify('Backup failed (check log for details)') _notify('Backup failed (check log for details)')
except NameError: except NameError:
pass pass
@ -306,17 +325,18 @@ class Backup:
except IndexError: except IndexError:
logger.info('No previous backups available') logger.info('No previous backups available')
def _ssh_connect(self, homedir=''): def _ssh_connect(self, homedir: str = '') -> paramiko.client.SSHClient:
try: try:
ssh = paramiko.SSHClient() ssh = paramiko.SSHClient()
except NameError: except NameError:
logger.error('Install paramiko for ssh support') logger.error('Install paramiko for ssh support')
return None return None
try: try:
ssh.load_host_keys(filename=f'{homedir}/.ssh/known_hosts') ssh.load_host_keys(filename=f'{homedir}/.ssh/known_hosts')
except FileNotFoundError: 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()) ssh.set_missing_host_key_policy(paramiko.WarningPolicy())
@ -325,7 +345,8 @@ class Backup:
return ssh return ssh
except UserWarning: 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': if k[0].upper() == 'Y':
ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy()) ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())
@ -348,13 +369,20 @@ class Backup:
if self.ssh_keyfile is None: if self.ssh_keyfile is None:
try: try:
password = getpass(f'{self.ssh_user}@{self.ssh_host}\'s password: ') password = getpass(
ssh.connect(self.ssh_host, username=self.ssh_user, password=password) f'{self.ssh_user}@{self.ssh_host}\'s password: ')
ssh.connect(self.ssh_host, username=self.ssh_user,
password=password)
self._password_auth = True self._password_auth = True
os.environ['SSHPASS'] = password os.environ['SSHPASS'] = password
return ssh return ssh
except GetPassWarning as e:
logger.critical('Unable to get password')
logger.critical(e)
return None
except paramiko.SSHException as e: except paramiko.SSHException as e:
logger.critical('Can\'t connect to the server.') logger.critical('Can\'t connect to the server.')
logger.critical(e) logger.critical(e)
@ -366,7 +394,8 @@ class Backup:
try: try:
pkey = RSAKey.from_private_key_file(self.ssh_keyfile) pkey = RSAKey.from_private_key_file(self.ssh_keyfile)
except paramiko.PasswordRequiredException: except paramiko.PasswordRequiredException:
password = getpass(f'Enter passwphrase for key \'{self.ssh_keyfile}\': ') password = getpass(
f'Enter passwphrase for key \'{self.ssh_keyfile}\': ')
try: try:
pkey = RSAKey.from_private_key_file(self.ssh_keyfile, password) pkey = RSAKey.from_private_key_file(self.ssh_keyfile, password)
@ -378,7 +407,8 @@ class Backup:
pkey = Ed25519Key.from_private_key_file(self.ssh_keyfile) pkey = Ed25519Key.from_private_key_file(self.ssh_keyfile)
except paramiko.PasswordRequiredException: except paramiko.PasswordRequiredException:
try: try:
pkey = Ed25519Key.from_private_key_file(self.ssh_keyfile, password) pkey = Ed25519Key.from_private_key_file(
self.ssh_keyfile, password)
except paramiko.SSHException: except paramiko.SSHException:
pass pass
@ -387,7 +417,8 @@ class Backup:
pkey = ECDSAKey.from_private_key_file(self.ssh_keyfile) pkey = ECDSAKey.from_private_key_file(self.ssh_keyfile)
except paramiko.PasswordRequiredException: except paramiko.PasswordRequiredException:
try: try:
pkey = ECDSAKey.from_private_key_file(self.ssh_keyfile, password) pkey = ECDSAKey.from_private_key_file(
self.ssh_keyfile, password)
except paramiko.SSHException: except paramiko.SSHException:
pass pass
@ -396,7 +427,8 @@ class Backup:
pkey = DSSKey.from_private_key_file(self.ssh_keyfile) pkey = DSSKey.from_private_key_file(self.ssh_keyfile)
except paramiko.PasswordRequiredException: except paramiko.PasswordRequiredException:
try: try:
pkey = DSSKey.from_private_key_file(self.ssh_keyfile, password) pkey = DSSKey.from_private_key_file(
self.ssh_keyfile, password)
except paramiko.SSHException: except paramiko.SSHException:
pass pass
@ -409,38 +441,51 @@ class Backup:
return ssh return ssh
def _returncode_log(self, returncode): def _returncode_log(self, returncode: int) -> None:
match returncode: match returncode:
case 2: case 2:
logger.error('Rsync error (return code 2) - Protocol incompatibility') logger.error(
'Rsync error (return code 2) - Protocol incompatibility')
case 3: case 3:
logger.error('Rsync error (return code 3) - Errors selecting input/output files, dirs') logger.error(
'Rsync error (return code 3) - Errors selecting input/output files, dirs')
case 4: case 4:
logger.error('Rsync error (return code 4) - Requested action not supported') logger.error(
'Rsync error (return code 4) - Requested action not supported')
case 5: case 5:
logger.error('Rsync error (return code 5) - Error starting client-server protocol') logger.error(
'Rsync error (return code 5) - Error starting client-server protocol')
case 10: case 10:
logger.error('Rsync error (return code 10) - Error in socket I/O') logger.error(
'Rsync error (return code 10) - Error in socket I/O')
case 11: case 11:
logger.error('Rsync error (return code 11) - Error in file I/O') logger.error(
'Rsync error (return code 11) - Error in file I/O')
case 12: case 12:
logger.error('Rsync error (return code 12) - Error in rsync protocol data stream') logger.error(
'Rsync error (return code 12) - Error in rsync protocol data stream')
case 22: case 22:
logger.error('Rsync error (return code 22) - Error allocating core memory buffers') logger.error(
'Rsync error (return code 22) - Error allocating core memory buffers')
case 23: case 23:
logger.warning('Rsync error (return code 23) - Partial transfer due to error') logger.warning(
'Rsync error (return code 23) - Partial transfer due to error')
case 24: case 24:
logger.warning('Rsync error (return code 24) - Partial transfer due to vanished source files') logger.warning(
'Rsync error (return code 24) - Partial transfer due to vanished source files')
case 30: case 30:
logger.error('Rsync error (return code 30) - Timeout in data send/receive') logger.error(
'Rsync error (return code 30) - Timeout in data send/receive')
case 35: case 35:
logger.error('Rsync error (return code 35) - Timeout waiting for daemon connection') logger.error(
'Rsync error (return code 35) - Timeout waiting for daemon connection')
case _: case _:
logger.error('Rsync error (return code %d) - Check rsync(1) for details', returncode) logger.error(
'Rsync error (return code %d) - Check rsync(1) for details', returncode)
# Function to read configuration file # Function to read configuration file
@timing(logger) @timing
def run(self): def run(self) -> int:
"""Perform the backup""" """Perform the backup"""
logger.info('Starting backup...') logger.info('Starting backup...')
@ -466,10 +511,11 @@ class Backup:
count += 1 count += 1
if count == 0: 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: try:
notify('Backup finished. No files copied') _notify('Backup finished. No files copied')
except NameError: except NameError:
pass pass
@ -490,10 +536,10 @@ class Backup:
if self._last_backup == '': if self._last_backup == '':
rsync = f'/usr/bin/rsync {self.options} --exclude-from={self._exclude_path} ' +\ 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: else:
rsync = f'/usr/bin/rsync {self.options} --link-dest="{self._last_backup}" --exclude-from=' +\ 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() euid = os.geteuid()
@ -510,6 +556,7 @@ class Backup:
args = shlex.split(rsync) args = shlex.split(rsync)
with Popen(args, stdin=PIPE, stdout=PIPE, stderr=STDOUT, shell=False) as p: with Popen(args, stdin=PIPE, stdout=PIPE, stderr=STDOUT, shell=False) as p:
output: Union[bytes, List[str]]
output, _ = p.communicate() output, _ = p.communicate()
try: try:
@ -543,7 +590,10 @@ class Backup:
os.remove(self._exclude_path) os.remove(self._exclude_path)
if self._remote: 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() output = stdout.read().decode('utf-8').strip()
@ -566,10 +616,12 @@ class Backup:
self._ssh.close() self._ssh.close()
else: else:
if returncode != 0: if returncode != 0:
logger.error('Some errors occurred while performing the backup') logger.error(
'Some errors occurred while performing the backup')
try: 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: except NameError:
pass pass
@ -585,14 +637,14 @@ class Backup:
return 0 return 0
def _parse_arguments(): def _parse_arguments() -> argparse.Namespace:
euid = os.geteuid() euid = os.geteuid()
if euid == 0: if euid == 0:
user = os.getenv('SUDO_USER') user = os.getenv('SUDO_USER')
else: else:
user = os.getenv('USER') user = os.getenv('USER')
homedir = os.path.expanduser(f'~{user}') homedir = os.path.expanduser(f'~{user}')
parser = argparse.ArgumentParser(prog='simple_backup', parser = argparse.ArgumentParser(prog='simple_backup',
@ -600,26 +652,39 @@ def _parse_arguments():
epilog='See simple_backup(1) manpage for full documentation', epilog='See simple_backup(1) manpage for full documentation',
formatter_class=MyFormatter) formatter_class=MyFormatter)
parser.add_argument('-v', '--verbose', action='store_true', help='More verbose output') 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', parser.add_argument('-c', '--config', default=f'{homedir}/.config/simple_backup/simple_backup.conf',
help='Specify location of configuration file') help='Specify location of configuration file')
parser.add_argument('-i', '--inputs', nargs='+', help='Paths/files to backup') parser.add_argument('-i', '--inputs', nargs='+',
parser.add_argument('-o', '--output', help='Output directory for the backup') help='Paths/files to backup')
parser.add_argument('-e', '--exclude', nargs='+', help='Files/directories/patterns to exclude from the backup') parser.add_argument(
parser.add_argument('-k', '--keep', type=int, help='Number of old backups to keep') '-o', '--output', help='Output directory for the backup')
parser.add_argument('-u', '--user', help='Explicitly specify the user running the backup') parser.add_argument('-e', '--exclude', nargs='+',
parser.add_argument('-s', '--checksum', action='store_true', help='Use checksum rsync option to compare files') help='Files/directories/patterns to exclude from the backup')
parser.add_argument('--ssh-host', help='Server hostname (for remote backup)') parser.add_argument('-k', '--keep', type=int,
parser.add_argument('--ssh-user', help='Username to connect to server (for remote backup)') 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(
'--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('--keyfile', help='SSH key location')
parser.add_argument('-z', '--compress', action='store_true', help='Compress data during the transfer') parser.add_argument('-z', '--compress', action='store_true',
help='Compress data during the transfer')
parser.add_argument('--remove-before-backup', action='store_true', parser.add_argument('--remove-before-backup', action='store_true',
help='Remove old backups before executing the backup, instead of after') 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='+', 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') 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', parser.add_argument('--numeric-ids', action='store_true',
help='Use rsync \'--numeric-ids\' option (don\'t map uid/gid values by name)') help='Use rsync \'--numeric-ids\' option (don\'t map uid/gid values by name)')
@ -628,7 +693,7 @@ def _parse_arguments():
return args return args
def _expand_inputs(inputs, user=None): def _expand_inputs(inputs, user: Optional[str] = None):
expanded_inputs = [] expanded_inputs = []
for i in inputs: for i in inputs:
@ -644,14 +709,15 @@ def _expand_inputs(inputs, user=None):
logger.warning('Cannot expand \'~\'. No user specified') logger.warning('Cannot expand \'~\'. No user specified')
if len(i_ex) == 0: 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: else:
expanded_inputs.extend(i_ex) expanded_inputs.extend(i_ex)
return expanded_inputs return expanded_inputs
def _read_config(config_file, user=None): def _read_config(config_file, user: Optional[str] = None):
config_args = {'inputs': None, config_args = {'inputs': None,
'output': None, 'output': None,
'exclude': None, 'exclude': None,
@ -663,7 +729,11 @@ def _read_config(config_file, user=None):
'numeric_ids': False} 'numeric_ids': False}
if not os.path.isfile(config_file): 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 return config_args
@ -743,7 +813,7 @@ def _read_config(config_file, user=None):
return config_args return config_args
def _notify(text): def _notify(text: str) -> None:
euid = os.geteuid() euid = os.geteuid()
if euid == 0: if euid == 0:
@ -757,14 +827,15 @@ def _notify(text):
os.seteuid(int(uid)) os.seteuid(int(uid))
os.environ['DBUS_SESSION_BUS_ADDRESS'] = f'unix:path=/run/user/{uid}/bus' 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 = dbus.Interface(obj, 'org.freedesktop.Notifications')
obj.Notify('', 0, '', 'simple_backup', text, [], {'urgency': 1}, 10000) 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""" """Main"""
args = _parse_arguments() args = _parse_arguments()
@ -777,7 +848,13 @@ def simple_backup():
if euid == 0: if euid == 0:
user = os.getenv('SUDO_USER') user = os.getenv('SUDO_USER')
homedir = os.path.expanduser(f'~{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: else:
user = os.getenv('USER') user = os.getenv('USER')
homedir = os.getenv('HOME') homedir = os.getenv('HOME')
@ -795,6 +872,7 @@ def simple_backup():
config_args = _read_config(args.config, user) config_args = _read_config(args.config, user)
except (configparser.NoSectionError, configparser.NoOptionError): except (configparser.NoSectionError, configparser.NoOptionError):
logger.critical('Bad configuration file') logger.critical('Bad configuration file')
return 6 return 6
inputs = args.inputs if args.inputs is not None else config_args['inputs'] inputs = args.inputs if args.inputs is not None else config_args['inputs']
@ -807,7 +885,8 @@ def simple_backup():
remote_sudo = args.remote_sudo or config_args['remote_sudo'] remote_sudo = args.remote_sudo or config_args['remote_sudo']
if args.rsync_options is None: 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: else:
rsync_options = ['-r', '-v'] rsync_options = ['-r', '-v']