Show More
@@ -1,718 +1,731 b'' | |||
|
1 | 1 | # chgserver.py - command server extension for cHg |
|
2 | 2 | # |
|
3 | 3 | # Copyright 2011 Yuya Nishihara <yuya@tcha.org> |
|
4 | 4 | # |
|
5 | 5 | # This software may be used and distributed according to the terms of the |
|
6 | 6 | # GNU General Public License version 2 or any later version. |
|
7 | 7 | |
|
8 | 8 | """command server extension for cHg |
|
9 | 9 | |
|
10 | 10 | 'S' channel (read/write) |
|
11 | 11 | propagate ui.system() request to client |
|
12 | 12 | |
|
13 | 13 | 'attachio' command |
|
14 | 14 | attach client's stdio passed by sendmsg() |
|
15 | 15 | |
|
16 | 16 | 'chdir' command |
|
17 | 17 | change current directory |
|
18 | 18 | |
|
19 | 19 | 'setenv' command |
|
20 | 20 | replace os.environ completely |
|
21 | 21 | |
|
22 | 22 | 'setumask' command (DEPRECATED) |
|
23 | 23 | 'setumask2' command |
|
24 | 24 | set umask |
|
25 | 25 | |
|
26 | 26 | 'validate' command |
|
27 | 27 | reload the config and check if the server is up to date |
|
28 | 28 | |
|
29 | 29 | Config |
|
30 | 30 | ------ |
|
31 | 31 | |
|
32 | 32 | :: |
|
33 | 33 | |
|
34 | 34 | [chgserver] |
|
35 | 35 | # how long (in seconds) should an idle chg server exit |
|
36 | 36 | idletimeout = 3600 |
|
37 | 37 | |
|
38 | 38 | # whether to skip config or env change checks |
|
39 | 39 | skiphash = False |
|
40 | 40 | """ |
|
41 | 41 | |
|
42 | 42 | from __future__ import absolute_import |
|
43 | 43 | |
|
44 | 44 | import inspect |
|
45 | 45 | import os |
|
46 | 46 | import re |
|
47 | 47 | import socket |
|
48 | 48 | import stat |
|
49 | 49 | import struct |
|
50 | 50 | import time |
|
51 | 51 | |
|
52 | 52 | from .i18n import _ |
|
53 | 53 | from .pycompat import ( |
|
54 | 54 | getattr, |
|
55 | 55 | setattr, |
|
56 | 56 | ) |
|
57 | 57 | |
|
58 | 58 | from . import ( |
|
59 | 59 | commandserver, |
|
60 | 60 | encoding, |
|
61 | 61 | error, |
|
62 | 62 | extensions, |
|
63 | 63 | node, |
|
64 | 64 | pycompat, |
|
65 | 65 | util, |
|
66 | 66 | ) |
|
67 | 67 | |
|
68 | 68 | from .utils import ( |
|
69 | 69 | hashutil, |
|
70 | 70 | procutil, |
|
71 | 71 | stringutil, |
|
72 | 72 | ) |
|
73 | 73 | |
|
74 | 74 | |
|
75 | 75 | def _hashlist(items): |
|
76 | 76 | """return sha1 hexdigest for a list""" |
|
77 | 77 | return node.hex(hashutil.sha1(stringutil.pprint(items)).digest()) |
|
78 | 78 | |
|
79 | 79 | |
|
80 | 80 | # sensitive config sections affecting confighash |
|
81 | 81 | _configsections = [ |
|
82 | 82 | b'alias', # affects global state commands.table |
|
83 | 83 | b'diff-tools', # affects whether gui or not in extdiff's uisetup |
|
84 | 84 | b'eol', # uses setconfig('eol', ...) |
|
85 | 85 | b'extdiff', # uisetup will register new commands |
|
86 | 86 | b'extensions', |
|
87 | 87 | b'fastannotate', # affects annotate command and adds fastannonate cmd |
|
88 | 88 | b'merge-tools', # affects whether gui or not in extdiff's uisetup |
|
89 | 89 | b'schemes', # extsetup will update global hg.schemes |
|
90 | 90 | ] |
|
91 | 91 | |
|
92 | 92 | _configsectionitems = [ |
|
93 | 93 | (b'commands', b'show.aliasprefix'), # show.py reads it in extsetup |
|
94 | 94 | ] |
|
95 | 95 | |
|
96 | 96 | # sensitive environment variables affecting confighash |
|
97 | 97 | _envre = re.compile( |
|
98 | 98 | br'''\A(?: |
|
99 | 99 | CHGHG |
|
100 | 100 | |HG(?:DEMANDIMPORT|EMITWARNINGS|MODULEPOLICY|PROF|RCPATH)? |
|
101 | 101 | |HG(?:ENCODING|PLAIN).* |
|
102 | 102 | |LANG(?:UAGE)? |
|
103 | 103 | |LC_.* |
|
104 | 104 | |LD_.* |
|
105 | 105 | |PATH |
|
106 | 106 | |PYTHON.* |
|
107 | 107 | |TERM(?:INFO)? |
|
108 | 108 | |TZ |
|
109 | 109 | )\Z''', |
|
110 | 110 | re.X, |
|
111 | 111 | ) |
|
112 | 112 | |
|
113 | 113 | |
|
114 | 114 | def _confighash(ui): |
|
115 | 115 | """return a quick hash for detecting config/env changes |
|
116 | 116 | |
|
117 | 117 | confighash is the hash of sensitive config items and environment variables. |
|
118 | 118 | |
|
119 | 119 | for chgserver, it is designed that once confighash changes, the server is |
|
120 | 120 | not qualified to serve its client and should redirect the client to a new |
|
121 | 121 | server. different from mtimehash, confighash change will not mark the |
|
122 | 122 | server outdated and exit since the user can have different configs at the |
|
123 | 123 | same time. |
|
124 | 124 | """ |
|
125 | 125 | sectionitems = [] |
|
126 | 126 | for section in _configsections: |
|
127 | 127 | sectionitems.append(ui.configitems(section)) |
|
128 | 128 | for section, item in _configsectionitems: |
|
129 | 129 | sectionitems.append(ui.config(section, item)) |
|
130 | 130 | sectionhash = _hashlist(sectionitems) |
|
131 | 131 | # If $CHGHG is set, the change to $HG should not trigger a new chg server |
|
132 | 132 | if b'CHGHG' in encoding.environ: |
|
133 | 133 | ignored = {b'HG'} |
|
134 | 134 | else: |
|
135 | 135 | ignored = set() |
|
136 | 136 | envitems = [ |
|
137 | 137 | (k, v) |
|
138 | 138 | for k, v in pycompat.iteritems(encoding.environ) |
|
139 | 139 | if _envre.match(k) and k not in ignored |
|
140 | 140 | ] |
|
141 | 141 | envhash = _hashlist(sorted(envitems)) |
|
142 | 142 | return sectionhash[:6] + envhash[:6] |
|
143 | 143 | |
|
144 | 144 | |
|
145 | 145 | def _getmtimepaths(ui): |
|
146 | 146 | """get a list of paths that should be checked to detect change |
|
147 | 147 | |
|
148 | 148 | The list will include: |
|
149 | 149 | - extensions (will not cover all files for complex extensions) |
|
150 | 150 | - mercurial/__version__.py |
|
151 | 151 | - python binary |
|
152 | 152 | """ |
|
153 | 153 | modules = [m for n, m in extensions.extensions(ui)] |
|
154 | 154 | try: |
|
155 | 155 | from . import __version__ |
|
156 | 156 | |
|
157 | 157 | modules.append(__version__) |
|
158 | 158 | except ImportError: |
|
159 | 159 | pass |
|
160 | 160 | files = [] |
|
161 | 161 | if pycompat.sysexecutable: |
|
162 | 162 | files.append(pycompat.sysexecutable) |
|
163 | 163 | for m in modules: |
|
164 | 164 | try: |
|
165 | 165 | files.append(pycompat.fsencode(inspect.getabsfile(m))) |
|
166 | 166 | except TypeError: |
|
167 | 167 | pass |
|
168 | 168 | return sorted(set(files)) |
|
169 | 169 | |
|
170 | 170 | |
|
171 | 171 | def _mtimehash(paths): |
|
172 | 172 | """return a quick hash for detecting file changes |
|
173 | 173 | |
|
174 | 174 | mtimehash calls stat on given paths and calculate a hash based on size and |
|
175 | 175 | mtime of each file. mtimehash does not read file content because reading is |
|
176 | 176 | expensive. therefore it's not 100% reliable for detecting content changes. |
|
177 | 177 | it's possible to return different hashes for same file contents. |
|
178 | 178 | it's also possible to return a same hash for different file contents for |
|
179 | 179 | some carefully crafted situation. |
|
180 | 180 | |
|
181 | 181 | for chgserver, it is designed that once mtimehash changes, the server is |
|
182 | 182 | considered outdated immediately and should no longer provide service. |
|
183 | 183 | |
|
184 | 184 | mtimehash is not included in confighash because we only know the paths of |
|
185 | 185 | extensions after importing them (there is imp.find_module but that faces |
|
186 | 186 | race conditions). We need to calculate confighash without importing. |
|
187 | 187 | """ |
|
188 | 188 | |
|
189 | 189 | def trystat(path): |
|
190 | 190 | try: |
|
191 | 191 | st = os.stat(path) |
|
192 | 192 | return (st[stat.ST_MTIME], st.st_size) |
|
193 | 193 | except OSError: |
|
194 | 194 | # could be ENOENT, EPERM etc. not fatal in any case |
|
195 | 195 | pass |
|
196 | 196 | |
|
197 | 197 | return _hashlist(pycompat.maplist(trystat, paths))[:12] |
|
198 | 198 | |
|
199 | 199 | |
|
200 | 200 | class hashstate(object): |
|
201 | 201 | """a structure storing confighash, mtimehash, paths used for mtimehash""" |
|
202 | 202 | |
|
203 | 203 | def __init__(self, confighash, mtimehash, mtimepaths): |
|
204 | 204 | self.confighash = confighash |
|
205 | 205 | self.mtimehash = mtimehash |
|
206 | 206 | self.mtimepaths = mtimepaths |
|
207 | 207 | |
|
208 | 208 | @staticmethod |
|
209 | 209 | def fromui(ui, mtimepaths=None): |
|
210 | 210 | if mtimepaths is None: |
|
211 | 211 | mtimepaths = _getmtimepaths(ui) |
|
212 | 212 | confighash = _confighash(ui) |
|
213 | 213 | mtimehash = _mtimehash(mtimepaths) |
|
214 | 214 | ui.log( |
|
215 | 215 | b'cmdserver', |
|
216 | 216 | b'confighash = %s mtimehash = %s\n', |
|
217 | 217 | confighash, |
|
218 | 218 | mtimehash, |
|
219 | 219 | ) |
|
220 | 220 | return hashstate(confighash, mtimehash, mtimepaths) |
|
221 | 221 | |
|
222 | 222 | |
|
223 | 223 | def _newchgui(srcui, csystem, attachio): |
|
224 | 224 | class chgui(srcui.__class__): |
|
225 | 225 | def __init__(self, src=None): |
|
226 | 226 | super(chgui, self).__init__(src) |
|
227 | 227 | if src: |
|
228 | 228 | self._csystem = getattr(src, '_csystem', csystem) |
|
229 | 229 | else: |
|
230 | 230 | self._csystem = csystem |
|
231 | 231 | |
|
232 | 232 | def _runsystem(self, cmd, environ, cwd, out): |
|
233 | 233 | # fallback to the original system method if |
|
234 | 234 | # a. the output stream is not stdout (e.g. stderr, cStringIO), |
|
235 | 235 | # b. or stdout is redirected by protectfinout(), |
|
236 | 236 | # because the chg client is not aware of these situations and |
|
237 | 237 | # will behave differently (i.e. write to stdout). |
|
238 | 238 | if ( |
|
239 | 239 | out is not self.fout |
|
240 | 240 | or not util.safehasattr(self.fout, b'fileno') |
|
241 | 241 | or self.fout.fileno() != procutil.stdout.fileno() |
|
242 | 242 | or self._finoutredirected |
|
243 | 243 | ): |
|
244 | 244 | return procutil.system(cmd, environ=environ, cwd=cwd, out=out) |
|
245 | 245 | self.flush() |
|
246 | 246 | return self._csystem(cmd, procutil.shellenviron(environ), cwd) |
|
247 | 247 | |
|
248 | 248 | def _runpager(self, cmd, env=None): |
|
249 | 249 | self._csystem( |
|
250 | 250 | cmd, |
|
251 | 251 | procutil.shellenviron(env), |
|
252 | 252 | type=b'pager', |
|
253 | 253 | cmdtable={b'attachio': attachio}, |
|
254 | 254 | ) |
|
255 | 255 | return True |
|
256 | 256 | |
|
257 | 257 | return chgui(srcui) |
|
258 | 258 | |
|
259 | 259 | |
|
260 | 260 | def _loadnewui(srcui, args, cdebug): |
|
261 | 261 | from . import dispatch # avoid cycle |
|
262 | 262 | |
|
263 | 263 | newui = srcui.__class__.load() |
|
264 | 264 | for a in [b'fin', b'fout', b'ferr', b'environ']: |
|
265 | 265 | setattr(newui, a, getattr(srcui, a)) |
|
266 | 266 | if util.safehasattr(srcui, b'_csystem'): |
|
267 | 267 | newui._csystem = srcui._csystem |
|
268 | 268 | |
|
269 | 269 | # command line args |
|
270 | 270 | options = dispatch._earlyparseopts(newui, args) |
|
271 | 271 | dispatch._parseconfig(newui, options[b'config']) |
|
272 | 272 | |
|
273 | 273 | # stolen from tortoisehg.util.copydynamicconfig() |
|
274 | 274 | for section, name, value in srcui.walkconfig(): |
|
275 | 275 | source = srcui.configsource(section, name) |
|
276 | 276 | if b':' in source or source == b'--config' or source.startswith(b'$'): |
|
277 | 277 | # path:line or command line, or environ |
|
278 | 278 | continue |
|
279 | 279 | newui.setconfig(section, name, value, source) |
|
280 | 280 | |
|
281 | 281 | # load wd and repo config, copied from dispatch.py |
|
282 | 282 | cwd = options[b'cwd'] |
|
283 | 283 | cwd = cwd and os.path.realpath(cwd) or None |
|
284 | 284 | rpath = options[b'repository'] |
|
285 | 285 | path, newlui = dispatch._getlocal(newui, rpath, wd=cwd) |
|
286 | 286 | |
|
287 | 287 | extensions.populateui(newui) |
|
288 | 288 | commandserver.setuplogging(newui, fp=cdebug) |
|
289 | 289 | if newui is not newlui: |
|
290 | 290 | extensions.populateui(newlui) |
|
291 | 291 | commandserver.setuplogging(newlui, fp=cdebug) |
|
292 | 292 | |
|
293 | 293 | return (newui, newlui) |
|
294 | 294 | |
|
295 | 295 | |
|
296 | 296 | class channeledsystem(object): |
|
297 | 297 | """Propagate ui.system() request in the following format: |
|
298 | 298 | |
|
299 | 299 | payload length (unsigned int), |
|
300 | 300 | type, '\0', |
|
301 | 301 | cmd, '\0', |
|
302 | 302 | cwd, '\0', |
|
303 | 303 | envkey, '=', val, '\0', |
|
304 | 304 | ... |
|
305 | 305 | envkey, '=', val |
|
306 | 306 | |
|
307 | 307 | if type == 'system', waits for: |
|
308 | 308 | |
|
309 | 309 | exitcode length (unsigned int), |
|
310 | 310 | exitcode (int) |
|
311 | 311 | |
|
312 | 312 | if type == 'pager', repetitively waits for a command name ending with '\n' |
|
313 | 313 | and executes it defined by cmdtable, or exits the loop if the command name |
|
314 | 314 | is empty. |
|
315 | 315 | """ |
|
316 | 316 | |
|
317 | 317 | def __init__(self, in_, out, channel): |
|
318 | 318 | self.in_ = in_ |
|
319 | 319 | self.out = out |
|
320 | 320 | self.channel = channel |
|
321 | 321 | |
|
322 | 322 | def __call__(self, cmd, environ, cwd=None, type=b'system', cmdtable=None): |
|
323 | 323 | args = [type, cmd, os.path.abspath(cwd or b'.')] |
|
324 | 324 | args.extend(b'%s=%s' % (k, v) for k, v in pycompat.iteritems(environ)) |
|
325 | 325 | data = b'\0'.join(args) |
|
326 | 326 | self.out.write(struct.pack(b'>cI', self.channel, len(data))) |
|
327 | 327 | self.out.write(data) |
|
328 | 328 | self.out.flush() |
|
329 | 329 | |
|
330 | 330 | if type == b'system': |
|
331 | 331 | length = self.in_.read(4) |
|
332 | 332 | (length,) = struct.unpack(b'>I', length) |
|
333 | 333 | if length != 4: |
|
334 | 334 | raise error.Abort(_(b'invalid response')) |
|
335 | 335 | (rc,) = struct.unpack(b'>i', self.in_.read(4)) |
|
336 | 336 | return rc |
|
337 | 337 | elif type == b'pager': |
|
338 | 338 | while True: |
|
339 | 339 | cmd = self.in_.readline()[:-1] |
|
340 | 340 | if not cmd: |
|
341 | 341 | break |
|
342 | 342 | if cmdtable and cmd in cmdtable: |
|
343 | 343 | cmdtable[cmd]() |
|
344 | 344 | else: |
|
345 | 345 | raise error.Abort(_(b'unexpected command: %s') % cmd) |
|
346 | 346 | else: |
|
347 | 347 | raise error.ProgrammingError(b'invalid S channel type: %s' % type) |
|
348 | 348 | |
|
349 | 349 | |
|
350 | 350 | _iochannels = [ |
|
351 | 351 | # server.ch, ui.fp, mode |
|
352 | 352 | (b'cin', b'fin', 'rb'), |
|
353 | 353 | (b'cout', b'fout', 'wb'), |
|
354 | 354 | (b'cerr', b'ferr', 'wb'), |
|
355 | 355 | ] |
|
356 | 356 | |
|
357 | 357 | |
|
358 | 358 | class chgcmdserver(commandserver.server): |
|
359 | 359 | def __init__( |
|
360 | 360 | self, ui, repo, fin, fout, sock, prereposetups, hashstate, baseaddress |
|
361 | 361 | ): |
|
362 | 362 | super(chgcmdserver, self).__init__( |
|
363 | 363 | _newchgui(ui, channeledsystem(fin, fout, b'S'), self.attachio), |
|
364 | 364 | repo, |
|
365 | 365 | fin, |
|
366 | 366 | fout, |
|
367 | 367 | prereposetups, |
|
368 | 368 | ) |
|
369 | 369 | self.clientsock = sock |
|
370 | 370 | self._ioattached = False |
|
371 | 371 | self._oldios = [] # original (self.ch, ui.fp, fd) before "attachio" |
|
372 | 372 | self.hashstate = hashstate |
|
373 | 373 | self.baseaddress = baseaddress |
|
374 | 374 | if hashstate is not None: |
|
375 | 375 | self.capabilities = self.capabilities.copy() |
|
376 | 376 | self.capabilities[b'validate'] = chgcmdserver.validate |
|
377 | 377 | |
|
378 | 378 | def cleanup(self): |
|
379 | 379 | super(chgcmdserver, self).cleanup() |
|
380 | 380 | # dispatch._runcatch() does not flush outputs if exception is not |
|
381 | 381 | # handled by dispatch._dispatch() |
|
382 | 382 | self.ui.flush() |
|
383 | 383 | self._restoreio() |
|
384 | 384 | self._ioattached = False |
|
385 | 385 | |
|
386 | 386 | def attachio(self): |
|
387 | 387 | """Attach to client's stdio passed via unix domain socket; all |
|
388 | 388 | channels except cresult will no longer be used |
|
389 | 389 | """ |
|
390 | 390 | # tell client to sendmsg() with 1-byte payload, which makes it |
|
391 | 391 | # distinctive from "attachio\n" command consumed by client.read() |
|
392 | 392 | self.clientsock.sendall(struct.pack(b'>cI', b'I', 1)) |
|
393 | 393 | clientfds = util.recvfds(self.clientsock.fileno()) |
|
394 | 394 | self.ui.log(b'chgserver', b'received fds: %r\n', clientfds) |
|
395 | 395 | |
|
396 | 396 | ui = self.ui |
|
397 | 397 | ui.flush() |
|
398 | 398 | self._saveio() |
|
399 | 399 | for fd, (cn, fn, mode) in zip(clientfds, _iochannels): |
|
400 | 400 | assert fd > 0 |
|
401 | 401 | fp = getattr(ui, fn) |
|
402 | 402 | os.dup2(fd, fp.fileno()) |
|
403 | 403 | os.close(fd) |
|
404 | 404 | if self._ioattached: |
|
405 | 405 | continue |
|
406 | 406 | # reset buffering mode when client is first attached. as we want |
|
407 | 407 | # to see output immediately on pager, the mode stays unchanged |
|
408 | 408 | # when client re-attached. ferr is unchanged because it should |
|
409 | 409 | # be unbuffered no matter if it is a tty or not. |
|
410 | 410 | if fn == b'ferr': |
|
411 | 411 | newfp = fp |
|
412 | 412 | else: |
|
413 | 413 | # make it line buffered explicitly because the default is |
|
414 | 414 | # decided on first write(), where fout could be a pager. |
|
415 | 415 | if fp.isatty(): |
|
416 | 416 | bufsize = 1 # line buffered |
|
417 | 417 | else: |
|
418 | 418 | bufsize = -1 # system default |
|
419 | 419 | newfp = os.fdopen(fp.fileno(), mode, bufsize) |
|
420 | 420 | setattr(ui, fn, newfp) |
|
421 | 421 | setattr(self, cn, newfp) |
|
422 | 422 | |
|
423 | 423 | self._ioattached = True |
|
424 | 424 | self.cresult.write(struct.pack(b'>i', len(clientfds))) |
|
425 | 425 | |
|
426 | 426 | def _saveio(self): |
|
427 | 427 | if self._oldios: |
|
428 | 428 | return |
|
429 | 429 | ui = self.ui |
|
430 | 430 | for cn, fn, _mode in _iochannels: |
|
431 | 431 | ch = getattr(self, cn) |
|
432 | 432 | fp = getattr(ui, fn) |
|
433 | 433 | fd = os.dup(fp.fileno()) |
|
434 | 434 | self._oldios.append((ch, fp, fd)) |
|
435 | 435 | |
|
436 | 436 | def _restoreio(self): |
|
437 | 437 | ui = self.ui |
|
438 | 438 | for (ch, fp, fd), (cn, fn, _mode) in zip(self._oldios, _iochannels): |
|
439 | 439 | newfp = getattr(ui, fn) |
|
440 | 440 | # close newfp while it's associated with client; otherwise it |
|
441 | 441 | # would be closed when newfp is deleted |
|
442 | 442 | if newfp is not fp: |
|
443 | 443 | newfp.close() |
|
444 | 444 | # restore original fd: fp is open again |
|
445 | os.dup2(fd, fp.fileno()) | |
|
445 | try: | |
|
446 | os.dup2(fd, fp.fileno()) | |
|
447 | except OSError as err: | |
|
448 | # According to issue6330, running chg on heavy loaded systems | |
|
449 | # can lead to EBUSY. [man dup2] indicates that, on Linux, | |
|
450 | # EBUSY comes from a race condition between open() and dup2(). | |
|
451 | # However it's not clear why open() race occurred for | |
|
452 | # newfd=stdin/out/err. | |
|
453 | self.ui.log( | |
|
454 | b'chgserver', | |
|
455 | b'got %s while duplicating %s\n', | |
|
456 | stringutil.forcebytestr(err), | |
|
457 | fn, | |
|
458 | ) | |
|
446 | 459 | os.close(fd) |
|
447 | 460 | setattr(self, cn, ch) |
|
448 | 461 | setattr(ui, fn, fp) |
|
449 | 462 | del self._oldios[:] |
|
450 | 463 | |
|
451 | 464 | def validate(self): |
|
452 | 465 | """Reload the config and check if the server is up to date |
|
453 | 466 | |
|
454 | 467 | Read a list of '\0' separated arguments. |
|
455 | 468 | Write a non-empty list of '\0' separated instruction strings or '\0' |
|
456 | 469 | if the list is empty. |
|
457 | 470 | An instruction string could be either: |
|
458 | 471 | - "unlink $path", the client should unlink the path to stop the |
|
459 | 472 | outdated server. |
|
460 | 473 | - "redirect $path", the client should attempt to connect to $path |
|
461 | 474 | first. If it does not work, start a new server. It implies |
|
462 | 475 | "reconnect". |
|
463 | 476 | - "exit $n", the client should exit directly with code n. |
|
464 | 477 | This may happen if we cannot parse the config. |
|
465 | 478 | - "reconnect", the client should close the connection and |
|
466 | 479 | reconnect. |
|
467 | 480 | If neither "reconnect" nor "redirect" is included in the instruction |
|
468 | 481 | list, the client can continue with this server after completing all |
|
469 | 482 | the instructions. |
|
470 | 483 | """ |
|
471 | 484 | from . import dispatch # avoid cycle |
|
472 | 485 | |
|
473 | 486 | args = self._readlist() |
|
474 | 487 | try: |
|
475 | 488 | self.ui, lui = _loadnewui(self.ui, args, self.cdebug) |
|
476 | 489 | except error.ParseError as inst: |
|
477 | 490 | dispatch._formatparse(self.ui.warn, inst) |
|
478 | 491 | self.ui.flush() |
|
479 | 492 | self.cresult.write(b'exit 255') |
|
480 | 493 | return |
|
481 | 494 | except error.Abort as inst: |
|
482 | 495 | self.ui.error(_(b"abort: %s\n") % inst) |
|
483 | 496 | if inst.hint: |
|
484 | 497 | self.ui.error(_(b"(%s)\n") % inst.hint) |
|
485 | 498 | self.ui.flush() |
|
486 | 499 | self.cresult.write(b'exit 255') |
|
487 | 500 | return |
|
488 | 501 | newhash = hashstate.fromui(lui, self.hashstate.mtimepaths) |
|
489 | 502 | insts = [] |
|
490 | 503 | if newhash.mtimehash != self.hashstate.mtimehash: |
|
491 | 504 | addr = _hashaddress(self.baseaddress, self.hashstate.confighash) |
|
492 | 505 | insts.append(b'unlink %s' % addr) |
|
493 | 506 | # mtimehash is empty if one or more extensions fail to load. |
|
494 | 507 | # to be compatible with hg, still serve the client this time. |
|
495 | 508 | if self.hashstate.mtimehash: |
|
496 | 509 | insts.append(b'reconnect') |
|
497 | 510 | if newhash.confighash != self.hashstate.confighash: |
|
498 | 511 | addr = _hashaddress(self.baseaddress, newhash.confighash) |
|
499 | 512 | insts.append(b'redirect %s' % addr) |
|
500 | 513 | self.ui.log(b'chgserver', b'validate: %s\n', stringutil.pprint(insts)) |
|
501 | 514 | self.cresult.write(b'\0'.join(insts) or b'\0') |
|
502 | 515 | |
|
503 | 516 | def chdir(self): |
|
504 | 517 | """Change current directory |
|
505 | 518 | |
|
506 | 519 | Note that the behavior of --cwd option is bit different from this. |
|
507 | 520 | It does not affect --config parameter. |
|
508 | 521 | """ |
|
509 | 522 | path = self._readstr() |
|
510 | 523 | if not path: |
|
511 | 524 | return |
|
512 | 525 | self.ui.log(b'chgserver', b"chdir to '%s'\n", path) |
|
513 | 526 | os.chdir(path) |
|
514 | 527 | |
|
515 | 528 | def setumask(self): |
|
516 | 529 | """Change umask (DEPRECATED)""" |
|
517 | 530 | # BUG: this does not follow the message frame structure, but kept for |
|
518 | 531 | # backward compatibility with old chg clients for some time |
|
519 | 532 | self._setumask(self._read(4)) |
|
520 | 533 | |
|
521 | 534 | def setumask2(self): |
|
522 | 535 | """Change umask""" |
|
523 | 536 | data = self._readstr() |
|
524 | 537 | if len(data) != 4: |
|
525 | 538 | raise ValueError(b'invalid mask length in setumask2 request') |
|
526 | 539 | self._setumask(data) |
|
527 | 540 | |
|
528 | 541 | def _setumask(self, data): |
|
529 | 542 | mask = struct.unpack(b'>I', data)[0] |
|
530 | 543 | self.ui.log(b'chgserver', b'setumask %r\n', mask) |
|
531 | 544 | util.setumask(mask) |
|
532 | 545 | |
|
533 | 546 | def runcommand(self): |
|
534 | 547 | # pager may be attached within the runcommand session, which should |
|
535 | 548 | # be detached at the end of the session. otherwise the pager wouldn't |
|
536 | 549 | # receive EOF. |
|
537 | 550 | globaloldios = self._oldios |
|
538 | 551 | self._oldios = [] |
|
539 | 552 | try: |
|
540 | 553 | return super(chgcmdserver, self).runcommand() |
|
541 | 554 | finally: |
|
542 | 555 | self._restoreio() |
|
543 | 556 | self._oldios = globaloldios |
|
544 | 557 | |
|
545 | 558 | def setenv(self): |
|
546 | 559 | """Clear and update os.environ |
|
547 | 560 | |
|
548 | 561 | Note that not all variables can make an effect on the running process. |
|
549 | 562 | """ |
|
550 | 563 | l = self._readlist() |
|
551 | 564 | try: |
|
552 | 565 | newenv = dict(s.split(b'=', 1) for s in l) |
|
553 | 566 | except ValueError: |
|
554 | 567 | raise ValueError(b'unexpected value in setenv request') |
|
555 | 568 | self.ui.log(b'chgserver', b'setenv: %r\n', sorted(newenv.keys())) |
|
556 | 569 | |
|
557 | 570 | encoding.environ.clear() |
|
558 | 571 | encoding.environ.update(newenv) |
|
559 | 572 | |
|
560 | 573 | capabilities = commandserver.server.capabilities.copy() |
|
561 | 574 | capabilities.update( |
|
562 | 575 | { |
|
563 | 576 | b'attachio': attachio, |
|
564 | 577 | b'chdir': chdir, |
|
565 | 578 | b'runcommand': runcommand, |
|
566 | 579 | b'setenv': setenv, |
|
567 | 580 | b'setumask': setumask, |
|
568 | 581 | b'setumask2': setumask2, |
|
569 | 582 | } |
|
570 | 583 | ) |
|
571 | 584 | |
|
572 | 585 | if util.safehasattr(procutil, b'setprocname'): |
|
573 | 586 | |
|
574 | 587 | def setprocname(self): |
|
575 | 588 | """Change process title""" |
|
576 | 589 | name = self._readstr() |
|
577 | 590 | self.ui.log(b'chgserver', b'setprocname: %r\n', name) |
|
578 | 591 | procutil.setprocname(name) |
|
579 | 592 | |
|
580 | 593 | capabilities[b'setprocname'] = setprocname |
|
581 | 594 | |
|
582 | 595 | |
|
583 | 596 | def _tempaddress(address): |
|
584 | 597 | return b'%s.%d.tmp' % (address, os.getpid()) |
|
585 | 598 | |
|
586 | 599 | |
|
587 | 600 | def _hashaddress(address, hashstr): |
|
588 | 601 | # if the basename of address contains '.', use only the left part. this |
|
589 | 602 | # makes it possible for the client to pass 'server.tmp$PID' and follow by |
|
590 | 603 | # an atomic rename to avoid locking when spawning new servers. |
|
591 | 604 | dirname, basename = os.path.split(address) |
|
592 | 605 | basename = basename.split(b'.', 1)[0] |
|
593 | 606 | return b'%s-%s' % (os.path.join(dirname, basename), hashstr) |
|
594 | 607 | |
|
595 | 608 | |
|
596 | 609 | class chgunixservicehandler(object): |
|
597 | 610 | """Set of operations for chg services""" |
|
598 | 611 | |
|
599 | 612 | pollinterval = 1 # [sec] |
|
600 | 613 | |
|
601 | 614 | def __init__(self, ui): |
|
602 | 615 | self.ui = ui |
|
603 | 616 | self._idletimeout = ui.configint(b'chgserver', b'idletimeout') |
|
604 | 617 | self._lastactive = time.time() |
|
605 | 618 | |
|
606 | 619 | def bindsocket(self, sock, address): |
|
607 | 620 | self._inithashstate(address) |
|
608 | 621 | self._checkextensions() |
|
609 | 622 | self._bind(sock) |
|
610 | 623 | self._createsymlink() |
|
611 | 624 | # no "listening at" message should be printed to simulate hg behavior |
|
612 | 625 | |
|
613 | 626 | def _inithashstate(self, address): |
|
614 | 627 | self._baseaddress = address |
|
615 | 628 | if self.ui.configbool(b'chgserver', b'skiphash'): |
|
616 | 629 | self._hashstate = None |
|
617 | 630 | self._realaddress = address |
|
618 | 631 | return |
|
619 | 632 | self._hashstate = hashstate.fromui(self.ui) |
|
620 | 633 | self._realaddress = _hashaddress(address, self._hashstate.confighash) |
|
621 | 634 | |
|
622 | 635 | def _checkextensions(self): |
|
623 | 636 | if not self._hashstate: |
|
624 | 637 | return |
|
625 | 638 | if extensions.notloaded(): |
|
626 | 639 | # one or more extensions failed to load. mtimehash becomes |
|
627 | 640 | # meaningless because we do not know the paths of those extensions. |
|
628 | 641 | # set mtimehash to an illegal hash value to invalidate the server. |
|
629 | 642 | self._hashstate.mtimehash = b'' |
|
630 | 643 | |
|
631 | 644 | def _bind(self, sock): |
|
632 | 645 | # use a unique temp address so we can stat the file and do ownership |
|
633 | 646 | # check later |
|
634 | 647 | tempaddress = _tempaddress(self._realaddress) |
|
635 | 648 | util.bindunixsocket(sock, tempaddress) |
|
636 | 649 | self._socketstat = os.stat(tempaddress) |
|
637 | 650 | sock.listen(socket.SOMAXCONN) |
|
638 | 651 | # rename will replace the old socket file if exists atomically. the |
|
639 | 652 | # old server will detect ownership change and exit. |
|
640 | 653 | util.rename(tempaddress, self._realaddress) |
|
641 | 654 | |
|
642 | 655 | def _createsymlink(self): |
|
643 | 656 | if self._baseaddress == self._realaddress: |
|
644 | 657 | return |
|
645 | 658 | tempaddress = _tempaddress(self._baseaddress) |
|
646 | 659 | os.symlink(os.path.basename(self._realaddress), tempaddress) |
|
647 | 660 | util.rename(tempaddress, self._baseaddress) |
|
648 | 661 | |
|
649 | 662 | def _issocketowner(self): |
|
650 | 663 | try: |
|
651 | 664 | st = os.stat(self._realaddress) |
|
652 | 665 | return ( |
|
653 | 666 | st.st_ino == self._socketstat.st_ino |
|
654 | 667 | and st[stat.ST_MTIME] == self._socketstat[stat.ST_MTIME] |
|
655 | 668 | ) |
|
656 | 669 | except OSError: |
|
657 | 670 | return False |
|
658 | 671 | |
|
659 | 672 | def unlinksocket(self, address): |
|
660 | 673 | if not self._issocketowner(): |
|
661 | 674 | return |
|
662 | 675 | # it is possible to have a race condition here that we may |
|
663 | 676 | # remove another server's socket file. but that's okay |
|
664 | 677 | # since that server will detect and exit automatically and |
|
665 | 678 | # the client will start a new server on demand. |
|
666 | 679 | util.tryunlink(self._realaddress) |
|
667 | 680 | |
|
668 | 681 | def shouldexit(self): |
|
669 | 682 | if not self._issocketowner(): |
|
670 | 683 | self.ui.log( |
|
671 | 684 | b'chgserver', b'%s is not owned, exiting.\n', self._realaddress |
|
672 | 685 | ) |
|
673 | 686 | return True |
|
674 | 687 | if time.time() - self._lastactive > self._idletimeout: |
|
675 | 688 | self.ui.log(b'chgserver', b'being idle too long. exiting.\n') |
|
676 | 689 | return True |
|
677 | 690 | return False |
|
678 | 691 | |
|
679 | 692 | def newconnection(self): |
|
680 | 693 | self._lastactive = time.time() |
|
681 | 694 | |
|
682 | 695 | def createcmdserver(self, repo, conn, fin, fout, prereposetups): |
|
683 | 696 | return chgcmdserver( |
|
684 | 697 | self.ui, |
|
685 | 698 | repo, |
|
686 | 699 | fin, |
|
687 | 700 | fout, |
|
688 | 701 | conn, |
|
689 | 702 | prereposetups, |
|
690 | 703 | self._hashstate, |
|
691 | 704 | self._baseaddress, |
|
692 | 705 | ) |
|
693 | 706 | |
|
694 | 707 | |
|
695 | 708 | def chgunixservice(ui, repo, opts): |
|
696 | 709 | # CHGINTERNALMARK is set by chg client. It is an indication of things are |
|
697 | 710 | # started by chg so other code can do things accordingly, like disabling |
|
698 | 711 | # demandimport or detecting chg client started by chg client. When executed |
|
699 | 712 | # here, CHGINTERNALMARK is no longer useful and hence dropped to make |
|
700 | 713 | # environ cleaner. |
|
701 | 714 | if b'CHGINTERNALMARK' in encoding.environ: |
|
702 | 715 | del encoding.environ[b'CHGINTERNALMARK'] |
|
703 | 716 | # Python3.7+ "coerces" the LC_CTYPE environment variable to a UTF-8 one if |
|
704 | 717 | # it thinks the current value is "C". This breaks the hash computation and |
|
705 | 718 | # causes chg to restart loop. |
|
706 | 719 | if b'CHGORIG_LC_CTYPE' in encoding.environ: |
|
707 | 720 | encoding.environ[b'LC_CTYPE'] = encoding.environ[b'CHGORIG_LC_CTYPE'] |
|
708 | 721 | del encoding.environ[b'CHGORIG_LC_CTYPE'] |
|
709 | 722 | elif b'CHG_CLEAR_LC_CTYPE' in encoding.environ: |
|
710 | 723 | if b'LC_CTYPE' in encoding.environ: |
|
711 | 724 | del encoding.environ[b'LC_CTYPE'] |
|
712 | 725 | del encoding.environ[b'CHG_CLEAR_LC_CTYPE'] |
|
713 | 726 | |
|
714 | 727 | if repo: |
|
715 | 728 | # one chgserver can serve multiple repos. drop repo information |
|
716 | 729 | ui.setconfig(b'bundle', b'mainreporoot', b'', b'repo') |
|
717 | 730 | h = chgunixservicehandler(ui) |
|
718 | 731 | return commandserver.unixforkingservice(ui, repo=None, opts=opts, handler=h) |
General Comments 0
You need to be logged in to leave comments.
Login now