10 Commits
3.2.1 ... 3.2.4

Author SHA1 Message Date
a07fce1b6c Version bump 2023-05-25 19:01:50 +02:00
11c1ab0952 Add options to remove old backups before copying files 2023-05-25 19:01:19 +02:00
a42ade4f2b Version bump 2023-05-25 17:27:04 +02:00
c6432c1350 Check rsync return code 2023-05-25 17:20:32 +02:00
fa1d8f410e Remove old last_backup link after copying files 2023-05-25 17:10:38 +02:00
8b9087cdf6 Version bump 2023-05-11 20:21:00 +02:00
3c155e62a2 Version bump 2023-05-11 20:19:56 +02:00
5a4a26f9a7 Fix minor bugs and improve exception handling 2023-05-11 20:18:42 +02:00
ca0e3d133f Fix entry_point in setup.cfg 2023-05-05 19:41:32 +02:00
cc788735dd Fix README.md 2023-05-05 19:30:53 +02:00
5 changed files with 51 additions and 43 deletions

View File

@ -3,7 +3,7 @@
# Maintainer: Daniele Fucini <dfucini@gmail.com>
pkgname=simple_backup
pkgver=3.1.2.r1.ga4c4b88
pkgver=3.2.3.r1.ga42ade4
pkgrel=1
pkgdesc='Simple backup script that uses rsync to copy files'
arch=('any')

View File

@ -27,12 +27,19 @@ To install the program, first clone the repository:
git clone https://github.com/Fuxino/simple_backup.git
```
Install tools required to build and install the package:
```bash
pip install --upgrade build installer wheel
```
Then run:
```bash
cd simple_backup
python -m build --wheel
python -m installer dist/*.whl
```
For Arch Linux, a PKGBUILD that automates this process is provided.

View File

@ -29,5 +29,5 @@ install_requires =
[options.entry_points]
console_scripts =
simple_backup = simple_backup:simple_backup
simple_backup = simple_backup.simple_backup:simple_backup

View File

@ -1,3 +1,3 @@
"""Init."""
__version__ = '3.1.2'
__version__ = '3.2.4'

View File

@ -17,7 +17,7 @@ from dotenv import load_dotenv
try:
from systemd import journal
except ImportError:
pass
journal = None
load_dotenv()
@ -38,14 +38,12 @@ c_format = logging.Formatter('%(name)s - %(levelname)s - %(message)s')
c_handler.setFormatter(c_format)
logger.addHandler(c_handler)
try:
if journal:
j_handler = journal.JournalHandler()
j_handler.setLevel(logging.INFO)
j_format = logging.Formatter('%(levelname)s - %(message)s')
j_handler.setFormatter(j_format)
logger.addHandler(j_handler)
except NameError:
pass
def timing(_logger):
@ -73,12 +71,13 @@ class MyFormatter(argparse.RawTextHelpFormatter, argparse.ArgumentDefaultsHelpFo
class Backup:
def __init__(self, inputs, output, exclude, keep, options):
def __init__(self, inputs, output, exclude, keep, options, remove_before=False):
self.inputs = inputs
self.output = output
self.exclude = exclude
self.options = options
self.keep = keep
self.remove_before = remove_before
self._last_backup = ''
self._output_dir = ''
self._inputs_path = ''
@ -91,17 +90,6 @@ class Backup:
return False
for i in self.inputs:
if os.path.islink(i):
try:
i_new = os.readlink(i)
logger.info(f'Input {i} is a symbolic link referencing {i_new}. Copying {i_new} instead')
self.inputs.remove(i)
self.inputs.append(i_new)
except Exception:
logger.warning(f'Input {i} is a link and cannot be read. Skipping')
self.inputs.remove(i)
if self.output is None:
logger.critical('No output path specified. Use -o argument or specify output path in configuration file')
@ -129,9 +117,7 @@ class Backup:
def remove_old_backups(self):
try:
dirs = os.listdir(f'{self.output}/simple_backup')
except Exception:
logger.info('No older backups to remove')
except FileNotFoundError:
return
if dirs.count('last_backup') > 0:
@ -148,8 +134,10 @@ class Backup:
try:
rmtree(f'{self.output}/simple_backup/{dirs[i]}')
count += 1
except Exception:
logger.error(f'Error while removing backup {dirs[i]}')
except FileNotFoundError:
logger.error(f'Error while removing backup {dirs[i]}. Directory not found')
except PermissionError:
logger.error(f'Error while removing backup {dirs[i]}. Permission denied')
if count == 1:
logger.info(f'Removed {count} backup')
@ -158,15 +146,14 @@ class Backup:
def find_last_backup(self):
if os.path.islink(f'{self.output}/simple_backup/last_backup'):
try:
self._last_backup = os.readlink(f'{self.output}/simple_backup/last_backup')
except Exception:
logger.warning('Previous backup could not be read')
link = os.readlink(f'{self.output}/simple_backup/last_backup')
if os.path.isdir(link):
self._last_backup = link
else:
logger.info('No previous backups available')
else:
logger.info('No previous backups available')
if not os.path.isdir(self._last_backup):
logger.warning('Previous backup could not be read')
# Function to read configuration file
@timing(logger)
@ -176,13 +163,6 @@ class Backup:
self.create_backup_dir()
self.find_last_backup()
if os.path.islink(f'{self.output}/simple_backup/last_backup'):
try:
os.remove(f'{self.output}/simple_backup/last_backup')
except Exception:
logger.error('Failed to remove last_backup link')
self._err_flag = True
_, self._inputs_path = mkstemp(prefix='tmp_inputs', text=True)
_, self._exclude_path = mkstemp(prefix='tmp_exclude', text=True)
@ -199,6 +179,9 @@ class Backup:
fp.write(e)
fp.write('\n')
if self.keep != -1 and self.remove_before:
self.remove_old_backups()
logger.info('Copying files. This may take a long time...')
if self._last_backup == '':
@ -213,18 +196,34 @@ class Backup:
p = Popen(rsync, stdout=PIPE, stderr=STDOUT, shell=True)
output, _ = p.communicate()
if p.returncode != 0:
self._err_flag = True
output = output.decode("utf-8").split('\n')
logger.info(f'rsync: {output[-3]}')
logger.info(f'rsync: {output[-2]}')
if os.path.islink(f'{self.output}/simple_backup/last_backup'):
try:
os.symlink(self._output_dir, f'{self.output}/simple_backup/last_backup')
except Exception:
logger.error('Failed to create last_backup link')
os.remove(f'{self.output}/simple_backup/last_backup')
except FileNotFoundError:
logger.error('Failed to remove last_backup link. File not found')
self._err_flag = True
except PermissionError:
logger.error('Failed to remove last_backup link. Permission denied')
self._err_flag = True
if self.keep != -1:
try:
os.symlink(self._output_dir, f'{self.output}/simple_backup/last_backup', target_is_directory=True)
except FileExistsError:
logger.error('Failed to create last_backup link. Link already exists')
self._err_flag = True
except PermissionError:
logger.error('Failed to create last_backup link. Permission denied')
self._err_flag = True
if self.keep != -1 and not self.remove_before:
self.remove_old_backups()
os.remove(self._inputs_path)
@ -250,6 +249,8 @@ def _parse_arguments():
parser.add_argument('-k', '--keep', type=int, help='Number of old backups to keep')
parser.add_argument('-s', '--checksum', action='store_true',
help='Use checksum rsync option to compare files (MUCH SLOWER)')
parser.add_argument('--remove-before-backup', action='store_true',
help='Remove old backups before executing the backup, instead of after')
args = parser.parse_args()
@ -296,7 +297,7 @@ def simple_backup():
else:
backup_options = '-arvh -H -X'
backup = Backup(inputs, output, exclude, keep, backup_options)
backup = Backup(inputs, output, exclude, keep, backup_options, remove_before=args.remove_before_backup)
if backup.check_params():
backup.run()