229190229

Build # 229190229

Build Type

push

github

Committed by Unrud

Commit Message

Pass the lock fd to the hook process

Run Details

1193 of 1536 branches covered (77.67%)

Branch coverage included in aggregate %.

8 of 8 new or added lines in 2 files covered. (100.0%)

4 existing lines in 1 file now uncovered.

2877 of 3421 relevant lines covered (84.1%)

12.6 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

85.0

/radicale/storage/multifilesystem/lock.py

# This file is part of Radicale Server - Calendar Server
# Copyright © 2014 Jean-Marc Martins
# Copyright © 2012-2017 Guillaume Ayoub
# Copyright © 2017-2019 Unrud <unrud@outlook.com>
#
# This library is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Radicale.  If not, see <http://www.gnu.org/licenses/>.

import contextlib
import logging
import os
import shlex
import subprocess

from radicale import pathutils
from radicale.log import logger


class CollectionLockMixin:
    def _acquire_cache_lock(self, ns=""):
        if self._storage._lock.locked == "w":
            return contextlib.ExitStack()
        cache_folder = os.path.join(self._filesystem_path, ".Radicale.cache")
        self._storage._makedirs_synced(cache_folder)
        lock_path = os.path.join(cache_folder,
                                 ".Radicale.lock" + (".%s" % ns if ns else ""))
        lock = pathutils.RwLock(lock_path)
        return lock.acquire("w")


class StorageLockMixin:

    def __init__(self, configuration):
        super().__init__(configuration)
        folder = self.configuration.get("storage", "filesystem_folder")
        lock_path = os.path.join(folder, ".Radicale.lock")
        self._lock = pathutils.RwLock(lock_path)

    @contextlib.contextmanager
    def acquire_lock(self, mode, user=None):
        with self._lock.acquire(mode) as lock_file:
            yield
            # execute hook
            hook = self.configuration.get("storage", "hook")
            if mode == "w" and hook:
                folder = self.configuration.get("storage", "filesystem_folder")
                debug = logger.isEnabledFor(logging.DEBUG)
                popen_kwargs = dict(
                    stdin=subprocess.DEVNULL,
                    stdout=subprocess.PIPE if debug else subprocess.DEVNULL,
                    stderr=subprocess.PIPE if debug else subprocess.DEVNULL,
                    shell=True, universal_newlines=True, cwd=folder)
                if os.name == "posix":
                    # Pass the lock_file to the subprocess to ensure the lock
                    # doesn't get released if this process is killed but the
                    # child process lives on
                    popen_kwargs["pass_fds"] = [lock_file.fileno()]
                command = hook % {"user": shlex.quote(user or "Anonymous")}
                logger.debug("Running hook")
                p = subprocess.Popen(command, **popen_kwargs)
                try:
                    stdout_data, stderr_data = p.communicate()
                except BaseException:
                    # Try to terminate the hook process on KeyboardInterrupt or
                    # SystemExit
                    p.terminate()
                    p.wait()
                    raise
                if stdout_data:
                    logger.debug("Captured stdout hook:\n%s", stdout_data)
                if stderr_data:
                    logger.debug("Captured stderr hook:\n%s", stderr_data)
                if p.returncode != 0:
                    raise subprocess.CalledProcessError(p.returncode, p.args)

1	# This file is part of Radicale Server - Calendar Server
2	# Copyright © 2014 Jean-Marc Martins
3	# Copyright © 2012-2017 Guillaume Ayoub
4	# Copyright © 2017-2019 Unrud <unrud@outlook.com>
5	#
6	# This library is free software: you can redistribute it and/or modify
7	# it under the terms of the GNU General Public License as published by
8	# the Free Software Foundation, either version 3 of the License, or
9	# (at your option) any later version.
10	#
11	# This library is distributed in the hope that it will be useful,
12	# but WITHOUT ANY WARRANTY; without even the implied warranty of
13	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14	# GNU General Public License for more details.
15	#
16	# You should have received a copy of the GNU General Public License
17	# along with Radicale. If not, see <http://www.gnu.org/licenses/>.
18
19	import contextlib	15✔
20	import logging	15✔
21	import os	15✔
22	import shlex	15✔
23	import subprocess	15✔
24
25	from radicale import pathutils	15✔
26	from radicale.log import logger	15✔
27
28
29	class CollectionLockMixin:	15✔
30	def _acquire_cache_lock(self, ns=""):	15✔
31	if self._storage._lock.locked == "w":	15!
32	return contextlib.ExitStack()	×
33	cache_folder = os.path.join(self._filesystem_path, ".Radicale.cache")	15✔
34	self._storage._makedirs_synced(cache_folder)	15✔
35	lock_path = os.path.join(cache_folder,	15✔
36	".Radicale.lock" + (".%s" % ns if ns else ""))
37	lock = pathutils.RwLock(lock_path)	15✔
38	return lock.acquire("w")	15✔
39
40
41	class StorageLockMixin:	15✔
42
43	def __init__(self, configuration):	15✔
44	super().__init__(configuration)	15✔
45	folder = self.configuration.get("storage", "filesystem_folder")	15✔
46	lock_path = os.path.join(folder, ".Radicale.lock")	15✔
47	self._lock = pathutils.RwLock(lock_path)	15✔
48
49	@contextlib.contextmanager	15✔
50	def acquire_lock(self, mode, user=None):	15✔
51	with self._lock.acquire(mode) as lock_file:	15✔
52	yield	15✔
53	# execute hook
54	hook = self.configuration.get("storage", "hook")	15✔
55	if mode == "w" and hook:	15✔
56	folder = self.configuration.get("storage", "filesystem_folder")	15✔
57	debug = logger.isEnabledFor(logging.DEBUG)	15✔
58	popen_kwargs = dict(	15✔
59	stdin=subprocess.DEVNULL,
60	stdout=subprocess.PIPE if debug else subprocess.DEVNULL,
61	stderr=subprocess.PIPE if debug else subprocess.DEVNULL,
62	shell=True, universal_newlines=True, cwd=folder)
63	if os.name == "posix":	15!
64	# Pass the lock_file to the subprocess to ensure the lock
65	# doesn't get released if this process is killed but the
66	# child process lives on
67	popen_kwargs["pass_fds"] = [lock_file.fileno()]	15✔
68	command = hook % {"user": shlex.quote(user or "Anonymous")}	15✔
69	logger.debug("Running hook")	15✔
70	p = subprocess.Popen(command, **popen_kwargs)	15✔
71	try:	15✔
72	stdout_data, stderr_data = p.communicate()	15✔
73	except BaseException:	×
74	# Try to terminate the hook process on KeyboardInterrupt or
75	# SystemExit
UNCOV 76	p.terminate()	×
UNCOV 77	p.wait()	×
UNCOV 78	raise	×
79	if stdout_data:	15!
UNCOV 80	logger.debug("Captured stdout hook:\n%s", stdout_data)	×
81	if stderr_data:	15✔
82	logger.debug("Captured stderr hook:\n%s", stderr_data)	15✔
83	if p.returncode != 0:	15✔
84	raise subprocess.CalledProcessError(p.returncode, p.args)	15✔

Kozea / Radicale / 229190229

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous