ED/EDMarketConnector
1
0
Fork 0
mirror of https://github.com/EDCD/EDMarketConnector.git synced 2025-04-17 17:42:20 +03:00
Code Issues Projects Releases Wiki Activity

JournalLock: Catch when journal_dir is None

Browse Source 
* If it's None then set journal_dir_path to None as well.  Setting '' or
  nothing results in '.' (CWD), which could cause other issues.
* As we do this in three places, it's in a helper function.
* New JournalLockResult.JOURNALDIR_IS_NONE to signal this.
* Fix checking of return from obtain_lock() to specifically reference
  JournalLockResult.ALREADY_LOCKED.
This commit is contained in:
Athanasius 2021-03-15 11:20:46 +00:00
parent 1cd0392527
commit fa49159de5
1 changed files with 23 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
journal_lock.py
View File

@ -25,6 +25,7 @@ class JournalLockResult(Enum):
JOURNALDIR_NOTEXIST = 2 JOURNALDIR_NOTEXIST = 2
JOURNALDIR_READONLY = 3 JOURNALDIR_READONLY = 3
ALREADY_LOCKED = 4 ALREADY_LOCKED = 4
JOURNALDIR_IS_NONE = 5
class JournalLock: class JournalLock:
@ -33,18 +34,33 @@ class JournalLock:
def __init__(self) -> None: def __init__(self) -> None:
"""Initialise where the journal directory and lock file are.""" """Initialise where the journal directory and lock file are."""
self.journal_dir: str = config.get('journaldir') or config.default_journal_dir self.journal_dir: str = config.get('journaldir') or config.default_journal_dir
self.journal_dir_path = pathlib.Path(self.journal_dir) self.journal_dir_path: Optional[pathlib.Path] = None
self.set_path_from_journaldir()
self.journal_dir_lockfile_name: Optional[pathlib.Path] = None self.journal_dir_lockfile_name: Optional[pathlib.Path] = None
# We never test truthiness of this, so let it be defined when first assigned. Avoids type hint issues. # We never test truthiness of this, so let it be defined when first assigned. Avoids type hint issues.
# self.journal_dir_lockfile: Optional[IO] = None # self.journal_dir_lockfile: Optional[IO] = None
self.locked = False self.locked = False
def set_path_from_journaldir(self):
if self.journal_dir is None:
self.journal_dir_path = None
else:
try:
self.journal_dir_path = pathlib.Path(self.journal_dir)
except Exception:
logger.exception("Couldn't make pathlib.Path from journal_dir", exc_info=True)
def obtain_lock(self) -> JournalLockResult: def obtain_lock(self) -> JournalLockResult:
""" """
Attempt to obtain a lock on the journal directory. Attempt to obtain a lock on the journal directory.
:return: LockResult - See the class Enum definition :return: LockResult - See the class Enum definition
""" """
if self.journal_dir_path is None:
return JournalLockResult.JOURNALDIR_IS_NONE
self.journal_dir_lockfile_name = self.journal_dir_path / 'edmc-journal-lock.txt' self.journal_dir_lockfile_name = self.journal_dir_path / 'edmc-journal-lock.txt'
logger.trace(f'journal_dir_lockfile_name = {self.journal_dir_lockfile_name!r}') logger.trace(f'journal_dir_lockfile_name = {self.journal_dir_lockfile_name!r}')
try: try:
@ -100,7 +116,7 @@ class JournalLock:
""" """
Release lock on journal directory. Release lock on journal directory.
:return: bool - Success of unlocking operation. :return: bool - Whether we're now unlocked.
""" """
if not self.locked: if not self.locked:
return True # We weren't locked, and still aren't return True # We weren't locked, and still aren't
@ -222,8 +238,9 @@ class JournalLock:
self.release_lock() self.release_lock()
self.journal_dir = current_journaldir self.journal_dir = current_journaldir
self.journal_dir_path = pathlib.Path(self.journal_dir) self.set_path_from_journaldir()
if not self.obtain_lock():
if self.obtain_lock() == JournalLockResult.ALREADY_LOCKED:
# Pop-up message asking for Retry or Ignore # Pop-up message asking for Retry or Ignore
self.retry_popup = self.JournalAlreadyLocked(parent, self.retry_lock) self.retry_popup = self.JournalAlreadyLocked(parent, self.retry_lock)
@ -241,7 +258,7 @@ class JournalLock:
current_journaldir = config.get('journaldir') or config.default_journal_dir current_journaldir = config.get('journaldir') or config.default_journal_dir
self.journal_dir = current_journaldir self.journal_dir = current_journaldir
self.journal_dir_path = pathlib.Path(self.journal_dir) self.set_path_from_journaldir()
if not self.obtain_lock(): if self.obtain_lock() == JournalLockResult.ALREADY_LOCKED:
# Pop-up message asking for Retry or Ignore # Pop-up message asking for Retry or Ignore
self.retry_popup = self.JournalAlreadyLocked(parent, self.retry_lock) self.retry_popup = self.JournalAlreadyLocked(parent, self.retry_lock)