mirror of
https://github.com/borgbackup/borg.git
synced 2024-12-29 03:06:12 +00:00
Correct some confusing error messages from borg init
(#3485)
init: more clear exception messages for borg create, fixes #3465
also: refactor
(cherry picked from commit 9f400633f2
)
This commit is contained in:
parent
5ab238df2b
commit
5138db20e2
1 changed files with 26 additions and 15 deletions
|
@ -116,6 +116,9 @@ class DoesNotExist(Error):
|
||||||
class AlreadyExists(Error):
|
class AlreadyExists(Error):
|
||||||
"""A repository already exists at {}."""
|
"""A repository already exists at {}."""
|
||||||
|
|
||||||
|
class PathAlreadyExists(Error):
|
||||||
|
"""There is already something at {}."""
|
||||||
|
|
||||||
class InvalidRepository(Error):
|
class InvalidRepository(Error):
|
||||||
"""{} is not a valid repository. Check repo config."""
|
"""{} is not a valid repository. Check repo config."""
|
||||||
|
|
||||||
|
@ -195,9 +198,24 @@ def __exit__(self, exc_type, exc_val, exc_tb):
|
||||||
def id_str(self):
|
def id_str(self):
|
||||||
return bin_to_hex(self.id)
|
return bin_to_hex(self.id)
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def is_repository(path):
|
||||||
|
"""Check whether there is already a Borg repository at *path*."""
|
||||||
|
try:
|
||||||
|
# Use binary mode to avoid troubles if a README contains some stuff not in our locale
|
||||||
|
with open(os.path.join(path, 'README'), 'rb') as fd:
|
||||||
|
# Read only the first ~100 bytes (if any), in case some README file we stumble upon is large.
|
||||||
|
readme_head = fd.read(100)
|
||||||
|
# The first comparison captures our current variant (REPOSITORY_README), the second comparison
|
||||||
|
# is an older variant of the README file (used by 1.0.x).
|
||||||
|
return b'Borg Backup repository' in readme_head or b'Borg repository' in readme_head
|
||||||
|
except OSError:
|
||||||
|
# Ignore FileNotFound, PermissionError, ...
|
||||||
|
return False
|
||||||
|
|
||||||
def check_can_create_repository(self, path):
|
def check_can_create_repository(self, path):
|
||||||
"""
|
"""
|
||||||
Raise self.AlreadyExists if a repository already exists at *path* or any parent directory.
|
Raise an exception if a repository already exists at *path* or any parent directory.
|
||||||
|
|
||||||
Checking parent directories is done for two reasons:
|
Checking parent directories is done for two reasons:
|
||||||
(1) It's just a weird thing to do, and usually not intended. A Borg using the "parent" repository
|
(1) It's just a weird thing to do, and usually not intended. A Borg using the "parent" repository
|
||||||
|
@ -207,8 +225,11 @@ def check_can_create_repository(self, path):
|
||||||
repository, user's can only use the quota'd repository, when their --restrict-to-path points
|
repository, user's can only use the quota'd repository, when their --restrict-to-path points
|
||||||
at the user's repository.
|
at the user's repository.
|
||||||
"""
|
"""
|
||||||
if os.path.exists(path) and (not os.path.isdir(path) or os.listdir(path)):
|
if os.path.exists(path):
|
||||||
raise self.AlreadyExists(path)
|
if self.is_repository(path):
|
||||||
|
raise self.AlreadyExists(path)
|
||||||
|
if not os.path.isdir(path) or os.listdir(path):
|
||||||
|
raise self.PathAlreadyExists(path)
|
||||||
|
|
||||||
while True:
|
while True:
|
||||||
# Check all parent directories for Borg's repository README
|
# Check all parent directories for Borg's repository README
|
||||||
|
@ -218,18 +239,8 @@ def check_can_create_repository(self, path):
|
||||||
if path == previous_path:
|
if path == previous_path:
|
||||||
# We reached the root of the directory hierarchy (/.. = / and C:\.. = C:\).
|
# We reached the root of the directory hierarchy (/.. = / and C:\.. = C:\).
|
||||||
break
|
break
|
||||||
try:
|
if self.is_repository(path):
|
||||||
# Use binary mode to avoid troubles if a README contains some stuff not in our locale
|
raise self.AlreadyExists(path)
|
||||||
with open(os.path.join(path, 'README'), 'rb') as fd:
|
|
||||||
# Read only the first ~100 bytes (if any), in case some README file we stumble upon is large.
|
|
||||||
readme_head = fd.read(100)
|
|
||||||
# The first comparison captures our current variant (REPOSITORY_README), the second comparison
|
|
||||||
# is an older variant of the README file (used by 1.0.x).
|
|
||||||
if b'Borg Backup repository' in readme_head or b'Borg repository' in readme_head:
|
|
||||||
raise self.AlreadyExists(path)
|
|
||||||
except OSError:
|
|
||||||
# Ignore FileNotFound, PermissionError, ...
|
|
||||||
pass
|
|
||||||
|
|
||||||
def create(self, path):
|
def create(self, path):
|
||||||
"""Create a new empty repository at `path`
|
"""Create a new empty repository at `path`
|
||||||
|
|
Loading…
Reference in a new issue