selfprivacy-rest-api/selfprivacy_api/restic_controller/__init__.py

234 lines
7.4 KiB
Python
Raw Normal View History

2021-12-06 06:48:29 +00:00
"""Restic singleton controller."""
from datetime import datetime
import json
import subprocess
import os
from enum import Enum
from selfprivacy_api.utils import ReadUserData
from selfprivacy_api.utils.singleton_metaclass import SingletonMetaclass
2021-12-06 06:48:29 +00:00
class ResticStates(Enum):
"""Restic states enum."""
NO_KEY = 0
NOT_INITIALIZED = 1
INITIALIZED = 2
BACKING_UP = 3
RESTORING = 4
ERROR = 5
INITIALIZING = 6
class ResticController(metaclass=SingletonMetaclass):
2021-12-06 06:48:29 +00:00
"""
States in wich the restic_controller may be
- no backblaze key
- backblaze key is provided, but repository is not initialized
- backblaze key is provided, repository is initialized
- fetching list of snapshots
- creating snapshot, current progress can be retrieved
- recovering from snapshot
Any ongoing operation acquires the lock
Current state can be fetched with get_state()
"""
_initialized = False
def __init__(self):
if self._initialized:
return
self.state = ResticStates.NO_KEY
self.lock = False
self.progress = 0
self._backblaze_account = None
self._backblaze_key = None
self._repository_name = None
self.snapshot_list = []
self.error_message = None
2021-12-06 09:07:03 +00:00
self._initialized = True
2021-12-06 06:48:29 +00:00
self.load_configuration()
self.load_snapshots()
def load_configuration(self):
"""Load current configuration from user data to singleton."""
with ReadUserData() as user_data:
self._backblaze_account = user_data["backblaze"]["accountId"]
self._backblaze_key = user_data["backblaze"]["accountKey"]
self._repository_name = user_data["backblaze"]["bucket"]
if self._backblaze_account and self._backblaze_key and self._repository_name:
self.state = ResticStates.INITIALIZING
else:
self.state = ResticStates.NO_KEY
def load_snapshots(self):
"""
Load list of snapshots from repository
"""
backup_listing_command = [
"restic",
"-o",
2023-01-18 09:40:04 +00:00
self.rclone_args(),
2021-12-06 06:48:29 +00:00
"-r",
2023-01-18 09:49:02 +00:00
self.restic_repo(),
2021-12-06 06:48:29 +00:00
"snapshots",
"--json",
]
2022-02-16 13:03:38 +00:00
if self.state in (ResticStates.BACKING_UP, ResticStates.RESTORING):
2021-12-06 06:48:29 +00:00
return
2021-12-06 09:00:53 +00:00
with subprocess.Popen(
backup_listing_command,
shell=False,
stdout=subprocess.PIPE,
stderr=subprocess.STDOUT,
) as backup_listing_process_descriptor:
2021-12-06 18:35:41 +00:00
snapshots_list = backup_listing_process_descriptor.communicate()[0].decode(
"utf-8"
)
2021-12-06 09:00:53 +00:00
try:
starting_index = snapshots_list.find("[")
json.loads(snapshots_list[starting_index:])
self.snapshot_list = json.loads(snapshots_list[starting_index:])
self.state = ResticStates.INITIALIZED
2021-12-06 09:07:03 +00:00
print(snapshots_list)
2021-12-06 09:00:53 +00:00
except ValueError:
if "Is there a repository at the following location?" in snapshots_list:
self.state = ResticStates.NOT_INITIALIZED
return
2022-02-16 13:03:38 +00:00
self.state = ResticStates.ERROR
self.error_message = snapshots_list
return
2021-12-06 06:48:29 +00:00
2023-01-18 09:49:02 +00:00
def restic_repo(self):
# https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#other-services-via-rclone
# https://forum.rclone.org/t/can-rclone-be-run-solely-with-command-line-options-no-config-no-env-vars/6314/5
return f"rclone::b2:{self._repository_name}/sfbackup"
2023-01-18 09:49:02 +00:00
2023-01-18 09:40:04 +00:00
def rclone_args(self):
return "rclone.args=serve restic --stdio" + self.backend_rclone_args()
def backend_rclone_args(self):
return f"--b2-account {self._backblaze_account} --b2-key {self._backblaze_key}"
2023-01-18 09:40:04 +00:00
2021-12-06 06:48:29 +00:00
def initialize_repository(self):
"""
Initialize repository with restic
"""
initialize_repository_command = [
"restic",
"-o",
2023-01-18 09:40:04 +00:00
self.rclone_args(),
2021-12-06 06:48:29 +00:00
"-r",
2023-01-18 09:49:02 +00:00
self.restic_repo(),
2021-12-06 06:48:29 +00:00
"init",
]
2021-12-06 09:00:53 +00:00
with subprocess.Popen(
initialize_repository_command,
shell=False,
stdout=subprocess.PIPE,
stderr=subprocess.STDOUT,
) as initialize_repository_process_descriptor:
msg = initialize_repository_process_descriptor.communicate()[0].decode(
"utf-8"
)
if initialize_repository_process_descriptor.returncode == 0:
self.state = ResticStates.INITIALIZED
else:
self.state = ResticStates.ERROR
self.error_message = msg
2021-12-06 06:48:29 +00:00
2021-12-06 09:00:53 +00:00
self.state = ResticStates.INITIALIZED
2021-12-06 06:48:29 +00:00
def start_backup(self):
"""
Start backup with restic
"""
backup_command = [
"restic",
"-o",
2023-01-18 09:40:04 +00:00
self.rclone_args(),
2021-12-06 06:48:29 +00:00
"-r",
2023-01-18 09:49:02 +00:00
self.restic_repo(),
2021-12-06 06:48:29 +00:00
"--verbose",
"--json",
"backup",
"/var",
]
with open("/var/backup.log", "w", encoding="utf-8") as log_file:
2021-12-06 09:00:53 +00:00
subprocess.Popen(
backup_command,
shell=False,
stdout=log_file,
stderr=subprocess.STDOUT,
)
2021-12-06 06:48:29 +00:00
2021-12-06 09:00:53 +00:00
self.state = ResticStates.BACKING_UP
self.progress = 0
2021-12-06 06:48:29 +00:00
def check_progress(self):
"""
Check progress of ongoing backup operation
"""
backup_status_check_command = ["tail", "-1", "/var/backup.log"]
2021-12-06 06:48:29 +00:00
2022-02-16 13:03:38 +00:00
if self.state in (ResticStates.NO_KEY, ResticStates.NOT_INITIALIZED):
2021-12-06 06:48:29 +00:00
return
# If the log file does not exists
if os.path.exists("/var/backup.log") is False:
2021-12-06 06:48:29 +00:00
self.state = ResticStates.INITIALIZED
with subprocess.Popen(
backup_status_check_command,
shell=False,
stdout=subprocess.PIPE,
stderr=subprocess.STDOUT,
) as backup_status_check_process_descriptor:
backup_process_status = (
backup_status_check_process_descriptor.communicate()[0].decode("utf-8")
)
try:
status = json.loads(backup_process_status)
except ValueError:
print(backup_process_status)
self.error_message = backup_process_status
return
if status["message_type"] == "status":
self.progress = status["percent_done"]
self.state = ResticStates.BACKING_UP
elif status["message_type"] == "summary":
self.state = ResticStates.INITIALIZED
self.progress = 0
self.snapshot_list.append(
{
"short_id": status["snapshot_id"],
# Current time in format 2021-12-02T00:02:51.086452543+03:00
"time": datetime.now().strftime("%Y-%m-%dT%H:%M:%S.%f%z"),
}
)
def restore_from_backup(self, snapshot_id):
"""
Restore from backup with restic
"""
backup_restoration_command = [
"restic",
"-o",
2023-01-18 09:40:04 +00:00
self.rclone_args(),
2021-12-06 06:48:29 +00:00
"-r",
2023-01-18 09:49:02 +00:00
self.restic_repo(),
2021-12-06 06:48:29 +00:00
"restore",
snapshot_id,
"--target",
"/",
]
self.state = ResticStates.RESTORING
2021-12-06 09:00:53 +00:00
subprocess.run(backup_restoration_command, shell=False)
2021-12-06 06:48:29 +00:00
self.state = ResticStates.INITIALIZED