1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
# R overlay -- run roverlay hooks (shell scripts)
# -*- coding: utf-8 -*-
# Copyright (C) 2013 André Erdmann <dywi@mailerd.de>
# Distributed under the terms of the GNU General Public License;
# either version 2 of the License, or (at your option) any later version.
import os
import logging
import roverlay.config
import roverlay.tools.shenv
__all__ = [ 'run_hook', 'phase_allowed', ]
LOGGER = logging.getLogger ( 'event_hook' )
_EVENT_SCRIPT = None
# None|iterable _EVENT_RESTRICT
_EVENT_RESTRICT = None
# int _EVENT_POLICY
# -1: no policy (allow all)
# 0: not configured
# 1: allow unless in _EVENT_RESTRICT (blacklist)
# 2: deny unless in _EVENT_RESTRICT (whitelist)
# 4: deny all
_EVENT_POLICY = 0
PHASE_INITIAL_DIRS = {
'user': True,
}
class HookException ( Exception ):
pass
def setup ( force=False ):
global _EVENT_SCRIPT
global _EVENT_POLICY
global _EVENT_RESTRICT
if roverlay.config.get ( 'write_disabled', False ) and not force:
_EVENT_SCRIPT = False
return
_EVENT_SCRIPT = roverlay.config.get ( 'EVENT_HOOK.exe', False )
if _EVENT_SCRIPT is False:
if roverlay.config.get_or_fail ( 'installed' ):
s = os.path.join (
roverlay.config.get_or_fail ( 'INSTALLINFO.libexec' ),
*roverlay.config.get_or_fail ( 'EVENT_HOOK.default_exe_relpath' )
)
if os.path.isfile ( s ):
_EVENT_SCRIPT = s
else:
LOGGER.error (
'missing {!r} - '
'has roverlay been installed properly?'.format ( s )
)
else:
a_dir = roverlay.config.get ( 'OVERLAY.additions_dir', None )
if a_dir:
s = os.path.join (
a_dir, *roverlay.config.get_or_fail (
'EVENT_HOOK.default_exe_relpath'
)
)
if os.path.isfile ( s ):
_EVENT_SCRIPT = s
# -- end if installed
# -- end if _EVENT_SCRIPT
conf_restrict = roverlay.config.get ( 'EVENT_HOOK.restrict', False )
if conf_restrict:
# tristate None,False,True
is_whitelist = None
allow = set()
deny = set()
for p in conf_restrict:
if p in { '*', '+*', '-*' }:
# "allow all" / "deny all"
# to avoid confusion, only one "[+-]*" statement is allowed
if is_whitelist is None:
is_whitelist = bool ( p[0] == '-' )
else:
raise Exception (
'EVENT_HOOK_RESTRICT must not contain more than one '
'"*"/"+*"/"-*" statement'
)
elif p == '-' or p == '+':
# empty
pass
elif p[0] == '-':
# deny <k>
k = p[1:].lower()
deny.add ( k )
try:
allow.remove ( k )
except KeyError:
pass
else:
# allow <k>
k = ( p[1:] if p[0] == '+' else p ).lower()
allow.add ( k )
try:
deny.remove ( k )
except KeyError:
pass
# -- end for;
if is_whitelist is None:
# allow is set => is whitelist
# neither allow nor deny are set => deny allow
is_whitelist = bool ( allow or not deny )
# -- end if is_whitelist #1
if is_whitelist:
if allow:
_EVENT_RESTRICT = frozenset ( allow )
_EVENT_POLICY = 2
else:
_EVENT_POLICY = 4
elif deny:
_EVENT_RESTRICT = frozenset ( deny )
_EVENT_POLICY = 1
else:
_EVENT_POLICY = -1
# -- end if is_whitelist #2
else:
_EVENT_POLICY = -1
# -- end if conf_restrict
# --- end of setup (...) ---
def phase_allowed ( phase ):
if _EVENT_POLICY == -1:
return True
elif _EVENT_POLICY == 1:
# allow unless in restrict
if phase not in _EVENT_RESTRICT:
return True
else:
LOGGER.debug (
"phase {!r} denied by blacklist policy.".format ( phase )
)
elif _EVENT_POLICY == 2:
# deny unless in restrict
if phase in _EVENT_RESTRICT:
return True
else:
LOGGER.debug (
"phase {!r} denied by whitelist policy.".format ( phase )
)
elif _EVENT_POLICY == 4:
LOGGER.debug (
"phase {!r} denied by 'deny all' policy".format ( phase )
)
else:
LOGGER.warning (
"phase {!r} denied by undefined policy {} (fix this)".format (
phase, _EVENT_POLICY
)
)
# -- end if _EVENT_POLICY
# default return
return False
# --- end of phase_allowed (...) ---
def phase_allowed_nolog ( phase ):
return (
_EVENT_POLICY == -1
) or (
_EVENT_POLICY == 1 and phase not in _EVENT_RESTRICT
) or (
_EVENT_POLICY == 2 and phase in _EVENT_RESTRICT
)
# --- end of phase_allowed_nolog (...) ---
def run ( phase, catch_failure=True ):
if _EVENT_SCRIPT is None:
LOGGER.warning (
"hook module not initialized - doing that now (FIXME!)"
)
setup()
# -- end if
if _EVENT_SCRIPT and phase_allowed ( phase.lower() ):
initial_dir = PHASE_INITIAL_DIRS.get ( phase.lower() )
if initial_dir is True:
initial_dir = os.getcwd()
if roverlay.tools.shenv.run_script (
_EVENT_SCRIPT, phase, return_success=True, initial_dir=initial_dir,
):
return True
elif catch_failure:
raise HookException (
"hook {h!r} returned non-zero for phase {p!r}".format (
h=_EVENT_SCRIPT, p=phase
)
)
#return False
else:
return False
else:
# nop
return True
# --- end of run (...) ---
run_hook = run
|
GitWeb