##// END OF EJS Templates
path: error out if the `path://` reference point to an unknown path...
marmoute -
r47584:395cf404 default
parent child Browse files
Show More
@@ -1,2452 +1,2457 b''
1 # ui.py - user interface bits for mercurial
1 # ui.py - user interface bits for mercurial
2 #
2 #
3 # Copyright 2005-2007 Olivia Mackall <olivia@selenic.com>
3 # Copyright 2005-2007 Olivia Mackall <olivia@selenic.com>
4 #
4 #
5 # This software may be used and distributed according to the terms of the
5 # This software may be used and distributed according to the terms of the
6 # GNU General Public License version 2 or any later version.
6 # GNU General Public License version 2 or any later version.
7
7
8 from __future__ import absolute_import
8 from __future__ import absolute_import
9
9
10 import collections
10 import collections
11 import contextlib
11 import contextlib
12 import datetime
12 import datetime
13 import errno
13 import errno
14 import getpass
14 import getpass
15 import inspect
15 import inspect
16 import os
16 import os
17 import re
17 import re
18 import signal
18 import signal
19 import socket
19 import socket
20 import subprocess
20 import subprocess
21 import sys
21 import sys
22 import traceback
22 import traceback
23
23
24 from .i18n import _
24 from .i18n import _
25 from .node import hex
25 from .node import hex
26 from .pycompat import (
26 from .pycompat import (
27 getattr,
27 getattr,
28 open,
28 open,
29 setattr,
29 setattr,
30 )
30 )
31
31
32 from . import (
32 from . import (
33 color,
33 color,
34 config,
34 config,
35 configitems,
35 configitems,
36 encoding,
36 encoding,
37 error,
37 error,
38 formatter,
38 formatter,
39 loggingutil,
39 loggingutil,
40 progress,
40 progress,
41 pycompat,
41 pycompat,
42 rcutil,
42 rcutil,
43 scmutil,
43 scmutil,
44 util,
44 util,
45 )
45 )
46 from .utils import (
46 from .utils import (
47 dateutil,
47 dateutil,
48 procutil,
48 procutil,
49 resourceutil,
49 resourceutil,
50 stringutil,
50 stringutil,
51 )
51 )
52
52
53 urlreq = util.urlreq
53 urlreq = util.urlreq
54
54
55 # for use with str.translate(None, _keepalnum), to keep just alphanumerics
55 # for use with str.translate(None, _keepalnum), to keep just alphanumerics
56 _keepalnum = b''.join(
56 _keepalnum = b''.join(
57 c for c in map(pycompat.bytechr, range(256)) if not c.isalnum()
57 c for c in map(pycompat.bytechr, range(256)) if not c.isalnum()
58 )
58 )
59
59
60 # The config knobs that will be altered (if unset) by ui.tweakdefaults.
60 # The config knobs that will be altered (if unset) by ui.tweakdefaults.
61 tweakrc = b"""
61 tweakrc = b"""
62 [ui]
62 [ui]
63 # The rollback command is dangerous. As a rule, don't use it.
63 # The rollback command is dangerous. As a rule, don't use it.
64 rollback = False
64 rollback = False
65 # Make `hg status` report copy information
65 # Make `hg status` report copy information
66 statuscopies = yes
66 statuscopies = yes
67 # Prefer curses UIs when available. Revert to plain-text with `text`.
67 # Prefer curses UIs when available. Revert to plain-text with `text`.
68 interface = curses
68 interface = curses
69 # Make compatible commands emit cwd-relative paths by default.
69 # Make compatible commands emit cwd-relative paths by default.
70 relative-paths = yes
70 relative-paths = yes
71
71
72 [commands]
72 [commands]
73 # Grep working directory by default.
73 # Grep working directory by default.
74 grep.all-files = True
74 grep.all-files = True
75 # Refuse to perform an `hg update` that would cause a file content merge
75 # Refuse to perform an `hg update` that would cause a file content merge
76 update.check = noconflict
76 update.check = noconflict
77 # Show conflicts information in `hg status`
77 # Show conflicts information in `hg status`
78 status.verbose = True
78 status.verbose = True
79 # Make `hg resolve` with no action (like `-m`) fail instead of re-merging.
79 # Make `hg resolve` with no action (like `-m`) fail instead of re-merging.
80 resolve.explicit-re-merge = True
80 resolve.explicit-re-merge = True
81
81
82 [diff]
82 [diff]
83 git = 1
83 git = 1
84 showfunc = 1
84 showfunc = 1
85 word-diff = 1
85 word-diff = 1
86 """
86 """
87
87
88 samplehgrcs = {
88 samplehgrcs = {
89 b'user': b"""# example user config (see 'hg help config' for more info)
89 b'user': b"""# example user config (see 'hg help config' for more info)
90 [ui]
90 [ui]
91 # name and email, e.g.
91 # name and email, e.g.
92 # username = Jane Doe <jdoe@example.com>
92 # username = Jane Doe <jdoe@example.com>
93 username =
93 username =
94
94
95 # We recommend enabling tweakdefaults to get slight improvements to
95 # We recommend enabling tweakdefaults to get slight improvements to
96 # the UI over time. Make sure to set HGPLAIN in the environment when
96 # the UI over time. Make sure to set HGPLAIN in the environment when
97 # writing scripts!
97 # writing scripts!
98 # tweakdefaults = True
98 # tweakdefaults = True
99
99
100 # uncomment to disable color in command output
100 # uncomment to disable color in command output
101 # (see 'hg help color' for details)
101 # (see 'hg help color' for details)
102 # color = never
102 # color = never
103
103
104 # uncomment to disable command output pagination
104 # uncomment to disable command output pagination
105 # (see 'hg help pager' for details)
105 # (see 'hg help pager' for details)
106 # paginate = never
106 # paginate = never
107
107
108 [extensions]
108 [extensions]
109 # uncomment the lines below to enable some popular extensions
109 # uncomment the lines below to enable some popular extensions
110 # (see 'hg help extensions' for more info)
110 # (see 'hg help extensions' for more info)
111 #
111 #
112 # histedit =
112 # histedit =
113 # rebase =
113 # rebase =
114 # uncommit =
114 # uncommit =
115 """,
115 """,
116 b'cloned': b"""# example repository config (see 'hg help config' for more info)
116 b'cloned': b"""# example repository config (see 'hg help config' for more info)
117 [paths]
117 [paths]
118 default = %s
118 default = %s
119
119
120 # path aliases to other clones of this repo in URLs or filesystem paths
120 # path aliases to other clones of this repo in URLs or filesystem paths
121 # (see 'hg help config.paths' for more info)
121 # (see 'hg help config.paths' for more info)
122 #
122 #
123 # default:pushurl = ssh://jdoe@example.net/hg/jdoes-fork
123 # default:pushurl = ssh://jdoe@example.net/hg/jdoes-fork
124 # my-fork = ssh://jdoe@example.net/hg/jdoes-fork
124 # my-fork = ssh://jdoe@example.net/hg/jdoes-fork
125 # my-clone = /home/jdoe/jdoes-clone
125 # my-clone = /home/jdoe/jdoes-clone
126
126
127 [ui]
127 [ui]
128 # name and email (local to this repository, optional), e.g.
128 # name and email (local to this repository, optional), e.g.
129 # username = Jane Doe <jdoe@example.com>
129 # username = Jane Doe <jdoe@example.com>
130 """,
130 """,
131 b'local': b"""# example repository config (see 'hg help config' for more info)
131 b'local': b"""# example repository config (see 'hg help config' for more info)
132 [paths]
132 [paths]
133 # path aliases to other clones of this repo in URLs or filesystem paths
133 # path aliases to other clones of this repo in URLs or filesystem paths
134 # (see 'hg help config.paths' for more info)
134 # (see 'hg help config.paths' for more info)
135 #
135 #
136 # default = http://example.com/hg/example-repo
136 # default = http://example.com/hg/example-repo
137 # default:pushurl = ssh://jdoe@example.net/hg/jdoes-fork
137 # default:pushurl = ssh://jdoe@example.net/hg/jdoes-fork
138 # my-fork = ssh://jdoe@example.net/hg/jdoes-fork
138 # my-fork = ssh://jdoe@example.net/hg/jdoes-fork
139 # my-clone = /home/jdoe/jdoes-clone
139 # my-clone = /home/jdoe/jdoes-clone
140
140
141 [ui]
141 [ui]
142 # name and email (local to this repository, optional), e.g.
142 # name and email (local to this repository, optional), e.g.
143 # username = Jane Doe <jdoe@example.com>
143 # username = Jane Doe <jdoe@example.com>
144 """,
144 """,
145 b'global': b"""# example system-wide hg config (see 'hg help config' for more info)
145 b'global': b"""# example system-wide hg config (see 'hg help config' for more info)
146
146
147 [ui]
147 [ui]
148 # uncomment to disable color in command output
148 # uncomment to disable color in command output
149 # (see 'hg help color' for details)
149 # (see 'hg help color' for details)
150 # color = never
150 # color = never
151
151
152 # uncomment to disable command output pagination
152 # uncomment to disable command output pagination
153 # (see 'hg help pager' for details)
153 # (see 'hg help pager' for details)
154 # paginate = never
154 # paginate = never
155
155
156 [extensions]
156 [extensions]
157 # uncomment the lines below to enable some popular extensions
157 # uncomment the lines below to enable some popular extensions
158 # (see 'hg help extensions' for more info)
158 # (see 'hg help extensions' for more info)
159 #
159 #
160 # blackbox =
160 # blackbox =
161 # churn =
161 # churn =
162 """,
162 """,
163 }
163 }
164
164
165
165
166 def _maybestrurl(maybebytes):
166 def _maybestrurl(maybebytes):
167 return pycompat.rapply(pycompat.strurl, maybebytes)
167 return pycompat.rapply(pycompat.strurl, maybebytes)
168
168
169
169
170 def _maybebytesurl(maybestr):
170 def _maybebytesurl(maybestr):
171 return pycompat.rapply(pycompat.bytesurl, maybestr)
171 return pycompat.rapply(pycompat.bytesurl, maybestr)
172
172
173
173
174 class httppasswordmgrdbproxy(object):
174 class httppasswordmgrdbproxy(object):
175 """Delays loading urllib2 until it's needed."""
175 """Delays loading urllib2 until it's needed."""
176
176
177 def __init__(self):
177 def __init__(self):
178 self._mgr = None
178 self._mgr = None
179
179
180 def _get_mgr(self):
180 def _get_mgr(self):
181 if self._mgr is None:
181 if self._mgr is None:
182 self._mgr = urlreq.httppasswordmgrwithdefaultrealm()
182 self._mgr = urlreq.httppasswordmgrwithdefaultrealm()
183 return self._mgr
183 return self._mgr
184
184
185 def add_password(self, realm, uris, user, passwd):
185 def add_password(self, realm, uris, user, passwd):
186 return self._get_mgr().add_password(
186 return self._get_mgr().add_password(
187 _maybestrurl(realm),
187 _maybestrurl(realm),
188 _maybestrurl(uris),
188 _maybestrurl(uris),
189 _maybestrurl(user),
189 _maybestrurl(user),
190 _maybestrurl(passwd),
190 _maybestrurl(passwd),
191 )
191 )
192
192
193 def find_user_password(self, realm, uri):
193 def find_user_password(self, realm, uri):
194 mgr = self._get_mgr()
194 mgr = self._get_mgr()
195 return _maybebytesurl(
195 return _maybebytesurl(
196 mgr.find_user_password(_maybestrurl(realm), _maybestrurl(uri))
196 mgr.find_user_password(_maybestrurl(realm), _maybestrurl(uri))
197 )
197 )
198
198
199
199
200 def _catchterm(*args):
200 def _catchterm(*args):
201 raise error.SignalInterrupt
201 raise error.SignalInterrupt
202
202
203
203
204 # unique object used to detect no default value has been provided when
204 # unique object used to detect no default value has been provided when
205 # retrieving configuration value.
205 # retrieving configuration value.
206 _unset = object()
206 _unset = object()
207
207
208 # _reqexithandlers: callbacks run at the end of a request
208 # _reqexithandlers: callbacks run at the end of a request
209 _reqexithandlers = []
209 _reqexithandlers = []
210
210
211
211
212 class ui(object):
212 class ui(object):
213 def __init__(self, src=None):
213 def __init__(self, src=None):
214 """Create a fresh new ui object if no src given
214 """Create a fresh new ui object if no src given
215
215
216 Use uimod.ui.load() to create a ui which knows global and user configs.
216 Use uimod.ui.load() to create a ui which knows global and user configs.
217 In most cases, you should use ui.copy() to create a copy of an existing
217 In most cases, you should use ui.copy() to create a copy of an existing
218 ui object.
218 ui object.
219 """
219 """
220 # _buffers: used for temporary capture of output
220 # _buffers: used for temporary capture of output
221 self._buffers = []
221 self._buffers = []
222 # 3-tuple describing how each buffer in the stack behaves.
222 # 3-tuple describing how each buffer in the stack behaves.
223 # Values are (capture stderr, capture subprocesses, apply labels).
223 # Values are (capture stderr, capture subprocesses, apply labels).
224 self._bufferstates = []
224 self._bufferstates = []
225 # When a buffer is active, defines whether we are expanding labels.
225 # When a buffer is active, defines whether we are expanding labels.
226 # This exists to prevent an extra list lookup.
226 # This exists to prevent an extra list lookup.
227 self._bufferapplylabels = None
227 self._bufferapplylabels = None
228 self.quiet = self.verbose = self.debugflag = self.tracebackflag = False
228 self.quiet = self.verbose = self.debugflag = self.tracebackflag = False
229 self._reportuntrusted = True
229 self._reportuntrusted = True
230 self._knownconfig = configitems.coreitems
230 self._knownconfig = configitems.coreitems
231 self._ocfg = config.config() # overlay
231 self._ocfg = config.config() # overlay
232 self._tcfg = config.config() # trusted
232 self._tcfg = config.config() # trusted
233 self._ucfg = config.config() # untrusted
233 self._ucfg = config.config() # untrusted
234 self._trustusers = set()
234 self._trustusers = set()
235 self._trustgroups = set()
235 self._trustgroups = set()
236 self.callhooks = True
236 self.callhooks = True
237 # Insecure server connections requested.
237 # Insecure server connections requested.
238 self.insecureconnections = False
238 self.insecureconnections = False
239 # Blocked time
239 # Blocked time
240 self.logblockedtimes = False
240 self.logblockedtimes = False
241 # color mode: see mercurial/color.py for possible value
241 # color mode: see mercurial/color.py for possible value
242 self._colormode = None
242 self._colormode = None
243 self._terminfoparams = {}
243 self._terminfoparams = {}
244 self._styles = {}
244 self._styles = {}
245 self._uninterruptible = False
245 self._uninterruptible = False
246 self.showtimestamp = False
246 self.showtimestamp = False
247
247
248 if src:
248 if src:
249 self._fout = src._fout
249 self._fout = src._fout
250 self._ferr = src._ferr
250 self._ferr = src._ferr
251 self._fin = src._fin
251 self._fin = src._fin
252 self._fmsg = src._fmsg
252 self._fmsg = src._fmsg
253 self._fmsgout = src._fmsgout
253 self._fmsgout = src._fmsgout
254 self._fmsgerr = src._fmsgerr
254 self._fmsgerr = src._fmsgerr
255 self._finoutredirected = src._finoutredirected
255 self._finoutredirected = src._finoutredirected
256 self._loggers = src._loggers.copy()
256 self._loggers = src._loggers.copy()
257 self.pageractive = src.pageractive
257 self.pageractive = src.pageractive
258 self._disablepager = src._disablepager
258 self._disablepager = src._disablepager
259 self._tweaked = src._tweaked
259 self._tweaked = src._tweaked
260
260
261 self._tcfg = src._tcfg.copy()
261 self._tcfg = src._tcfg.copy()
262 self._ucfg = src._ucfg.copy()
262 self._ucfg = src._ucfg.copy()
263 self._ocfg = src._ocfg.copy()
263 self._ocfg = src._ocfg.copy()
264 self._trustusers = src._trustusers.copy()
264 self._trustusers = src._trustusers.copy()
265 self._trustgroups = src._trustgroups.copy()
265 self._trustgroups = src._trustgroups.copy()
266 self.environ = src.environ
266 self.environ = src.environ
267 self.callhooks = src.callhooks
267 self.callhooks = src.callhooks
268 self.insecureconnections = src.insecureconnections
268 self.insecureconnections = src.insecureconnections
269 self._colormode = src._colormode
269 self._colormode = src._colormode
270 self._terminfoparams = src._terminfoparams.copy()
270 self._terminfoparams = src._terminfoparams.copy()
271 self._styles = src._styles.copy()
271 self._styles = src._styles.copy()
272
272
273 self.fixconfig()
273 self.fixconfig()
274
274
275 self.httppasswordmgrdb = src.httppasswordmgrdb
275 self.httppasswordmgrdb = src.httppasswordmgrdb
276 self._blockedtimes = src._blockedtimes
276 self._blockedtimes = src._blockedtimes
277 else:
277 else:
278 self._fout = procutil.stdout
278 self._fout = procutil.stdout
279 self._ferr = procutil.stderr
279 self._ferr = procutil.stderr
280 self._fin = procutil.stdin
280 self._fin = procutil.stdin
281 self._fmsg = None
281 self._fmsg = None
282 self._fmsgout = self.fout # configurable
282 self._fmsgout = self.fout # configurable
283 self._fmsgerr = self.ferr # configurable
283 self._fmsgerr = self.ferr # configurable
284 self._finoutredirected = False
284 self._finoutredirected = False
285 self._loggers = {}
285 self._loggers = {}
286 self.pageractive = False
286 self.pageractive = False
287 self._disablepager = False
287 self._disablepager = False
288 self._tweaked = False
288 self._tweaked = False
289
289
290 # shared read-only environment
290 # shared read-only environment
291 self.environ = encoding.environ
291 self.environ = encoding.environ
292
292
293 self.httppasswordmgrdb = httppasswordmgrdbproxy()
293 self.httppasswordmgrdb = httppasswordmgrdbproxy()
294 self._blockedtimes = collections.defaultdict(int)
294 self._blockedtimes = collections.defaultdict(int)
295
295
296 allowed = self.configlist(b'experimental', b'exportableenviron')
296 allowed = self.configlist(b'experimental', b'exportableenviron')
297 if b'*' in allowed:
297 if b'*' in allowed:
298 self._exportableenviron = self.environ
298 self._exportableenviron = self.environ
299 else:
299 else:
300 self._exportableenviron = {}
300 self._exportableenviron = {}
301 for k in allowed:
301 for k in allowed:
302 if k in self.environ:
302 if k in self.environ:
303 self._exportableenviron[k] = self.environ[k]
303 self._exportableenviron[k] = self.environ[k]
304
304
305 def _new_source(self):
305 def _new_source(self):
306 self._ocfg.new_source()
306 self._ocfg.new_source()
307 self._tcfg.new_source()
307 self._tcfg.new_source()
308 self._ucfg.new_source()
308 self._ucfg.new_source()
309
309
310 @classmethod
310 @classmethod
311 def load(cls):
311 def load(cls):
312 """Create a ui and load global and user configs"""
312 """Create a ui and load global and user configs"""
313 u = cls()
313 u = cls()
314 # we always trust global config files and environment variables
314 # we always trust global config files and environment variables
315 for t, f in rcutil.rccomponents():
315 for t, f in rcutil.rccomponents():
316 if t == b'path':
316 if t == b'path':
317 u.readconfig(f, trust=True)
317 u.readconfig(f, trust=True)
318 elif t == b'resource':
318 elif t == b'resource':
319 u.read_resource_config(f, trust=True)
319 u.read_resource_config(f, trust=True)
320 elif t == b'items':
320 elif t == b'items':
321 u._new_source()
321 u._new_source()
322 sections = set()
322 sections = set()
323 for section, name, value, source in f:
323 for section, name, value, source in f:
324 # do not set u._ocfg
324 # do not set u._ocfg
325 # XXX clean this up once immutable config object is a thing
325 # XXX clean this up once immutable config object is a thing
326 u._tcfg.set(section, name, value, source)
326 u._tcfg.set(section, name, value, source)
327 u._ucfg.set(section, name, value, source)
327 u._ucfg.set(section, name, value, source)
328 sections.add(section)
328 sections.add(section)
329 for section in sections:
329 for section in sections:
330 u.fixconfig(section=section)
330 u.fixconfig(section=section)
331 else:
331 else:
332 raise error.ProgrammingError(b'unknown rctype: %s' % t)
332 raise error.ProgrammingError(b'unknown rctype: %s' % t)
333 u._maybetweakdefaults()
333 u._maybetweakdefaults()
334 u._new_source() # anything after that is a different level
334 u._new_source() # anything after that is a different level
335 return u
335 return u
336
336
337 def _maybetweakdefaults(self):
337 def _maybetweakdefaults(self):
338 if not self.configbool(b'ui', b'tweakdefaults'):
338 if not self.configbool(b'ui', b'tweakdefaults'):
339 return
339 return
340 if self._tweaked or self.plain(b'tweakdefaults'):
340 if self._tweaked or self.plain(b'tweakdefaults'):
341 return
341 return
342
342
343 # Note: it is SUPER IMPORTANT that you set self._tweaked to
343 # Note: it is SUPER IMPORTANT that you set self._tweaked to
344 # True *before* any calls to setconfig(), otherwise you'll get
344 # True *before* any calls to setconfig(), otherwise you'll get
345 # infinite recursion between setconfig and this method.
345 # infinite recursion between setconfig and this method.
346 #
346 #
347 # TODO: We should extract an inner method in setconfig() to
347 # TODO: We should extract an inner method in setconfig() to
348 # avoid this weirdness.
348 # avoid this weirdness.
349 self._tweaked = True
349 self._tweaked = True
350 tmpcfg = config.config()
350 tmpcfg = config.config()
351 tmpcfg.parse(b'<tweakdefaults>', tweakrc)
351 tmpcfg.parse(b'<tweakdefaults>', tweakrc)
352 for section in tmpcfg:
352 for section in tmpcfg:
353 for name, value in tmpcfg.items(section):
353 for name, value in tmpcfg.items(section):
354 if not self.hasconfig(section, name):
354 if not self.hasconfig(section, name):
355 self.setconfig(section, name, value, b"<tweakdefaults>")
355 self.setconfig(section, name, value, b"<tweakdefaults>")
356
356
357 def copy(self):
357 def copy(self):
358 return self.__class__(self)
358 return self.__class__(self)
359
359
360 def resetstate(self):
360 def resetstate(self):
361 """Clear internal state that shouldn't persist across commands"""
361 """Clear internal state that shouldn't persist across commands"""
362 if self._progbar:
362 if self._progbar:
363 self._progbar.resetstate() # reset last-print time of progress bar
363 self._progbar.resetstate() # reset last-print time of progress bar
364 self.httppasswordmgrdb = httppasswordmgrdbproxy()
364 self.httppasswordmgrdb = httppasswordmgrdbproxy()
365
365
366 @contextlib.contextmanager
366 @contextlib.contextmanager
367 def timeblockedsection(self, key):
367 def timeblockedsection(self, key):
368 # this is open-coded below - search for timeblockedsection to find them
368 # this is open-coded below - search for timeblockedsection to find them
369 starttime = util.timer()
369 starttime = util.timer()
370 try:
370 try:
371 yield
371 yield
372 finally:
372 finally:
373 self._blockedtimes[key + b'_blocked'] += (
373 self._blockedtimes[key + b'_blocked'] += (
374 util.timer() - starttime
374 util.timer() - starttime
375 ) * 1000
375 ) * 1000
376
376
377 @contextlib.contextmanager
377 @contextlib.contextmanager
378 def uninterruptible(self):
378 def uninterruptible(self):
379 """Mark an operation as unsafe.
379 """Mark an operation as unsafe.
380
380
381 Most operations on a repository are safe to interrupt, but a
381 Most operations on a repository are safe to interrupt, but a
382 few are risky (for example repair.strip). This context manager
382 few are risky (for example repair.strip). This context manager
383 lets you advise Mercurial that something risky is happening so
383 lets you advise Mercurial that something risky is happening so
384 that control-C etc can be blocked if desired.
384 that control-C etc can be blocked if desired.
385 """
385 """
386 enabled = self.configbool(b'experimental', b'nointerrupt')
386 enabled = self.configbool(b'experimental', b'nointerrupt')
387 if enabled and self.configbool(
387 if enabled and self.configbool(
388 b'experimental', b'nointerrupt-interactiveonly'
388 b'experimental', b'nointerrupt-interactiveonly'
389 ):
389 ):
390 enabled = self.interactive()
390 enabled = self.interactive()
391 if self._uninterruptible or not enabled:
391 if self._uninterruptible or not enabled:
392 # if nointerrupt support is turned off, the process isn't
392 # if nointerrupt support is turned off, the process isn't
393 # interactive, or we're already in an uninterruptible
393 # interactive, or we're already in an uninterruptible
394 # block, do nothing.
394 # block, do nothing.
395 yield
395 yield
396 return
396 return
397
397
398 def warn():
398 def warn():
399 self.warn(_(b"shutting down cleanly\n"))
399 self.warn(_(b"shutting down cleanly\n"))
400 self.warn(
400 self.warn(
401 _(b"press ^C again to terminate immediately (dangerous)\n")
401 _(b"press ^C again to terminate immediately (dangerous)\n")
402 )
402 )
403 return True
403 return True
404
404
405 with procutil.uninterruptible(warn):
405 with procutil.uninterruptible(warn):
406 try:
406 try:
407 self._uninterruptible = True
407 self._uninterruptible = True
408 yield
408 yield
409 finally:
409 finally:
410 self._uninterruptible = False
410 self._uninterruptible = False
411
411
412 def formatter(self, topic, opts):
412 def formatter(self, topic, opts):
413 return formatter.formatter(self, self, topic, opts)
413 return formatter.formatter(self, self, topic, opts)
414
414
415 def _trusted(self, fp, f):
415 def _trusted(self, fp, f):
416 st = util.fstat(fp)
416 st = util.fstat(fp)
417 if util.isowner(st):
417 if util.isowner(st):
418 return True
418 return True
419
419
420 tusers, tgroups = self._trustusers, self._trustgroups
420 tusers, tgroups = self._trustusers, self._trustgroups
421 if b'*' in tusers or b'*' in tgroups:
421 if b'*' in tusers or b'*' in tgroups:
422 return True
422 return True
423
423
424 user = util.username(st.st_uid)
424 user = util.username(st.st_uid)
425 group = util.groupname(st.st_gid)
425 group = util.groupname(st.st_gid)
426 if user in tusers or group in tgroups or user == util.username():
426 if user in tusers or group in tgroups or user == util.username():
427 return True
427 return True
428
428
429 if self._reportuntrusted:
429 if self._reportuntrusted:
430 self.warn(
430 self.warn(
431 _(
431 _(
432 b'not trusting file %s from untrusted '
432 b'not trusting file %s from untrusted '
433 b'user %s, group %s\n'
433 b'user %s, group %s\n'
434 )
434 )
435 % (f, user, group)
435 % (f, user, group)
436 )
436 )
437 return False
437 return False
438
438
439 def read_resource_config(
439 def read_resource_config(
440 self, name, root=None, trust=False, sections=None, remap=None
440 self, name, root=None, trust=False, sections=None, remap=None
441 ):
441 ):
442 try:
442 try:
443 fp = resourceutil.open_resource(name[0], name[1])
443 fp = resourceutil.open_resource(name[0], name[1])
444 except IOError:
444 except IOError:
445 if not sections: # ignore unless we were looking for something
445 if not sections: # ignore unless we were looking for something
446 return
446 return
447 raise
447 raise
448
448
449 self._readconfig(
449 self._readconfig(
450 b'resource:%s.%s' % name, fp, root, trust, sections, remap
450 b'resource:%s.%s' % name, fp, root, trust, sections, remap
451 )
451 )
452
452
453 def readconfig(
453 def readconfig(
454 self, filename, root=None, trust=False, sections=None, remap=None
454 self, filename, root=None, trust=False, sections=None, remap=None
455 ):
455 ):
456 try:
456 try:
457 fp = open(filename, 'rb')
457 fp = open(filename, 'rb')
458 except IOError:
458 except IOError:
459 if not sections: # ignore unless we were looking for something
459 if not sections: # ignore unless we were looking for something
460 return
460 return
461 raise
461 raise
462
462
463 self._readconfig(filename, fp, root, trust, sections, remap)
463 self._readconfig(filename, fp, root, trust, sections, remap)
464
464
465 def _readconfig(
465 def _readconfig(
466 self, filename, fp, root=None, trust=False, sections=None, remap=None
466 self, filename, fp, root=None, trust=False, sections=None, remap=None
467 ):
467 ):
468 with fp:
468 with fp:
469 cfg = config.config()
469 cfg = config.config()
470 trusted = sections or trust or self._trusted(fp, filename)
470 trusted = sections or trust or self._trusted(fp, filename)
471
471
472 try:
472 try:
473 cfg.read(filename, fp, sections=sections, remap=remap)
473 cfg.read(filename, fp, sections=sections, remap=remap)
474 except error.ConfigError as inst:
474 except error.ConfigError as inst:
475 if trusted:
475 if trusted:
476 raise
476 raise
477 self.warn(
477 self.warn(
478 _(b'ignored %s: %s\n') % (inst.location, inst.message)
478 _(b'ignored %s: %s\n') % (inst.location, inst.message)
479 )
479 )
480
480
481 self._applyconfig(cfg, trusted, root)
481 self._applyconfig(cfg, trusted, root)
482
482
483 def applyconfig(self, configitems, source=b"", root=None):
483 def applyconfig(self, configitems, source=b"", root=None):
484 """Add configitems from a non-file source. Unlike with ``setconfig()``,
484 """Add configitems from a non-file source. Unlike with ``setconfig()``,
485 they can be overridden by subsequent config file reads. The items are
485 they can be overridden by subsequent config file reads. The items are
486 in the same format as ``configoverride()``, namely a dict of the
486 in the same format as ``configoverride()``, namely a dict of the
487 following structures: {(section, name) : value}
487 following structures: {(section, name) : value}
488
488
489 Typically this is used by extensions that inject themselves into the
489 Typically this is used by extensions that inject themselves into the
490 config file load procedure by monkeypatching ``localrepo.loadhgrc()``.
490 config file load procedure by monkeypatching ``localrepo.loadhgrc()``.
491 """
491 """
492 cfg = config.config()
492 cfg = config.config()
493
493
494 for (section, name), value in configitems.items():
494 for (section, name), value in configitems.items():
495 cfg.set(section, name, value, source)
495 cfg.set(section, name, value, source)
496
496
497 self._applyconfig(cfg, True, root)
497 self._applyconfig(cfg, True, root)
498
498
499 def _applyconfig(self, cfg, trusted, root):
499 def _applyconfig(self, cfg, trusted, root):
500 if self.plain():
500 if self.plain():
501 for k in (
501 for k in (
502 b'debug',
502 b'debug',
503 b'fallbackencoding',
503 b'fallbackencoding',
504 b'quiet',
504 b'quiet',
505 b'slash',
505 b'slash',
506 b'logtemplate',
506 b'logtemplate',
507 b'message-output',
507 b'message-output',
508 b'statuscopies',
508 b'statuscopies',
509 b'style',
509 b'style',
510 b'traceback',
510 b'traceback',
511 b'verbose',
511 b'verbose',
512 ):
512 ):
513 if k in cfg[b'ui']:
513 if k in cfg[b'ui']:
514 del cfg[b'ui'][k]
514 del cfg[b'ui'][k]
515 for k, v in cfg.items(b'defaults'):
515 for k, v in cfg.items(b'defaults'):
516 del cfg[b'defaults'][k]
516 del cfg[b'defaults'][k]
517 for k, v in cfg.items(b'commands'):
517 for k, v in cfg.items(b'commands'):
518 del cfg[b'commands'][k]
518 del cfg[b'commands'][k]
519 for k, v in cfg.items(b'command-templates'):
519 for k, v in cfg.items(b'command-templates'):
520 del cfg[b'command-templates'][k]
520 del cfg[b'command-templates'][k]
521 # Don't remove aliases from the configuration if in the exceptionlist
521 # Don't remove aliases from the configuration if in the exceptionlist
522 if self.plain(b'alias'):
522 if self.plain(b'alias'):
523 for k, v in cfg.items(b'alias'):
523 for k, v in cfg.items(b'alias'):
524 del cfg[b'alias'][k]
524 del cfg[b'alias'][k]
525 if self.plain(b'revsetalias'):
525 if self.plain(b'revsetalias'):
526 for k, v in cfg.items(b'revsetalias'):
526 for k, v in cfg.items(b'revsetalias'):
527 del cfg[b'revsetalias'][k]
527 del cfg[b'revsetalias'][k]
528 if self.plain(b'templatealias'):
528 if self.plain(b'templatealias'):
529 for k, v in cfg.items(b'templatealias'):
529 for k, v in cfg.items(b'templatealias'):
530 del cfg[b'templatealias'][k]
530 del cfg[b'templatealias'][k]
531
531
532 if trusted:
532 if trusted:
533 self._tcfg.update(cfg)
533 self._tcfg.update(cfg)
534 self._tcfg.update(self._ocfg)
534 self._tcfg.update(self._ocfg)
535 self._ucfg.update(cfg)
535 self._ucfg.update(cfg)
536 self._ucfg.update(self._ocfg)
536 self._ucfg.update(self._ocfg)
537
537
538 if root is None:
538 if root is None:
539 root = os.path.expanduser(b'~')
539 root = os.path.expanduser(b'~')
540 self.fixconfig(root=root)
540 self.fixconfig(root=root)
541
541
542 def fixconfig(self, root=None, section=None):
542 def fixconfig(self, root=None, section=None):
543 if section in (None, b'paths'):
543 if section in (None, b'paths'):
544 # expand vars and ~
544 # expand vars and ~
545 # translate paths relative to root (or home) into absolute paths
545 # translate paths relative to root (or home) into absolute paths
546 root = root or encoding.getcwd()
546 root = root or encoding.getcwd()
547 for c in self._tcfg, self._ucfg, self._ocfg:
547 for c in self._tcfg, self._ucfg, self._ocfg:
548 for n, p in c.items(b'paths'):
548 for n, p in c.items(b'paths'):
549 # Ignore sub-options.
549 # Ignore sub-options.
550 if b':' in n:
550 if b':' in n:
551 continue
551 continue
552 if not p:
552 if not p:
553 continue
553 continue
554 if b'%%' in p:
554 if b'%%' in p:
555 s = self.configsource(b'paths', n) or b'none'
555 s = self.configsource(b'paths', n) or b'none'
556 self.warn(
556 self.warn(
557 _(b"(deprecated '%%' in path %s=%s from %s)\n")
557 _(b"(deprecated '%%' in path %s=%s from %s)\n")
558 % (n, p, s)
558 % (n, p, s)
559 )
559 )
560 p = p.replace(b'%%', b'%')
560 p = p.replace(b'%%', b'%')
561 p = util.expandpath(p)
561 p = util.expandpath(p)
562 if not util.hasscheme(p) and not os.path.isabs(p):
562 if not util.hasscheme(p) and not os.path.isabs(p):
563 p = os.path.normpath(os.path.join(root, p))
563 p = os.path.normpath(os.path.join(root, p))
564 c.alter(b"paths", n, p)
564 c.alter(b"paths", n, p)
565
565
566 if section in (None, b'ui'):
566 if section in (None, b'ui'):
567 # update ui options
567 # update ui options
568 self._fmsgout, self._fmsgerr = _selectmsgdests(self)
568 self._fmsgout, self._fmsgerr = _selectmsgdests(self)
569 self.debugflag = self.configbool(b'ui', b'debug')
569 self.debugflag = self.configbool(b'ui', b'debug')
570 self.verbose = self.debugflag or self.configbool(b'ui', b'verbose')
570 self.verbose = self.debugflag or self.configbool(b'ui', b'verbose')
571 self.quiet = not self.debugflag and self.configbool(b'ui', b'quiet')
571 self.quiet = not self.debugflag and self.configbool(b'ui', b'quiet')
572 if self.verbose and self.quiet:
572 if self.verbose and self.quiet:
573 self.quiet = self.verbose = False
573 self.quiet = self.verbose = False
574 self._reportuntrusted = self.debugflag or self.configbool(
574 self._reportuntrusted = self.debugflag or self.configbool(
575 b"ui", b"report_untrusted"
575 b"ui", b"report_untrusted"
576 )
576 )
577 self.showtimestamp = self.configbool(b'ui', b'timestamp-output')
577 self.showtimestamp = self.configbool(b'ui', b'timestamp-output')
578 self.tracebackflag = self.configbool(b'ui', b'traceback')
578 self.tracebackflag = self.configbool(b'ui', b'traceback')
579 self.logblockedtimes = self.configbool(b'ui', b'logblockedtimes')
579 self.logblockedtimes = self.configbool(b'ui', b'logblockedtimes')
580
580
581 if section in (None, b'trusted'):
581 if section in (None, b'trusted'):
582 # update trust information
582 # update trust information
583 self._trustusers.update(self.configlist(b'trusted', b'users'))
583 self._trustusers.update(self.configlist(b'trusted', b'users'))
584 self._trustgroups.update(self.configlist(b'trusted', b'groups'))
584 self._trustgroups.update(self.configlist(b'trusted', b'groups'))
585
585
586 if section in (None, b'devel', b'ui') and self.debugflag:
586 if section in (None, b'devel', b'ui') and self.debugflag:
587 tracked = set()
587 tracked = set()
588 if self.configbool(b'devel', b'debug.extensions'):
588 if self.configbool(b'devel', b'debug.extensions'):
589 tracked.add(b'extension')
589 tracked.add(b'extension')
590 if tracked:
590 if tracked:
591 logger = loggingutil.fileobjectlogger(self._ferr, tracked)
591 logger = loggingutil.fileobjectlogger(self._ferr, tracked)
592 self.setlogger(b'debug', logger)
592 self.setlogger(b'debug', logger)
593
593
594 def backupconfig(self, section, item):
594 def backupconfig(self, section, item):
595 return (
595 return (
596 self._ocfg.backup(section, item),
596 self._ocfg.backup(section, item),
597 self._tcfg.backup(section, item),
597 self._tcfg.backup(section, item),
598 self._ucfg.backup(section, item),
598 self._ucfg.backup(section, item),
599 )
599 )
600
600
601 def restoreconfig(self, data):
601 def restoreconfig(self, data):
602 self._ocfg.restore(data[0])
602 self._ocfg.restore(data[0])
603 self._tcfg.restore(data[1])
603 self._tcfg.restore(data[1])
604 self._ucfg.restore(data[2])
604 self._ucfg.restore(data[2])
605
605
606 def setconfig(self, section, name, value, source=b''):
606 def setconfig(self, section, name, value, source=b''):
607 for cfg in (self._ocfg, self._tcfg, self._ucfg):
607 for cfg in (self._ocfg, self._tcfg, self._ucfg):
608 cfg.set(section, name, value, source)
608 cfg.set(section, name, value, source)
609 self.fixconfig(section=section)
609 self.fixconfig(section=section)
610 self._maybetweakdefaults()
610 self._maybetweakdefaults()
611
611
612 def _data(self, untrusted):
612 def _data(self, untrusted):
613 return untrusted and self._ucfg or self._tcfg
613 return untrusted and self._ucfg or self._tcfg
614
614
615 def configsource(self, section, name, untrusted=False):
615 def configsource(self, section, name, untrusted=False):
616 return self._data(untrusted).source(section, name)
616 return self._data(untrusted).source(section, name)
617
617
618 def config(self, section, name, default=_unset, untrusted=False):
618 def config(self, section, name, default=_unset, untrusted=False):
619 """return the plain string version of a config"""
619 """return the plain string version of a config"""
620 value = self._config(
620 value = self._config(
621 section, name, default=default, untrusted=untrusted
621 section, name, default=default, untrusted=untrusted
622 )
622 )
623 if value is _unset:
623 if value is _unset:
624 return None
624 return None
625 return value
625 return value
626
626
627 def _config(self, section, name, default=_unset, untrusted=False):
627 def _config(self, section, name, default=_unset, untrusted=False):
628 value = itemdefault = default
628 value = itemdefault = default
629 item = self._knownconfig.get(section, {}).get(name)
629 item = self._knownconfig.get(section, {}).get(name)
630 alternates = [(section, name)]
630 alternates = [(section, name)]
631
631
632 if item is not None:
632 if item is not None:
633 alternates.extend(item.alias)
633 alternates.extend(item.alias)
634 if callable(item.default):
634 if callable(item.default):
635 itemdefault = item.default()
635 itemdefault = item.default()
636 else:
636 else:
637 itemdefault = item.default
637 itemdefault = item.default
638 else:
638 else:
639 msg = b"accessing unregistered config item: '%s.%s'"
639 msg = b"accessing unregistered config item: '%s.%s'"
640 msg %= (section, name)
640 msg %= (section, name)
641 self.develwarn(msg, 2, b'warn-config-unknown')
641 self.develwarn(msg, 2, b'warn-config-unknown')
642
642
643 if default is _unset:
643 if default is _unset:
644 if item is None:
644 if item is None:
645 value = default
645 value = default
646 elif item.default is configitems.dynamicdefault:
646 elif item.default is configitems.dynamicdefault:
647 value = None
647 value = None
648 msg = b"config item requires an explicit default value: '%s.%s'"
648 msg = b"config item requires an explicit default value: '%s.%s'"
649 msg %= (section, name)
649 msg %= (section, name)
650 self.develwarn(msg, 2, b'warn-config-default')
650 self.develwarn(msg, 2, b'warn-config-default')
651 else:
651 else:
652 value = itemdefault
652 value = itemdefault
653 elif (
653 elif (
654 item is not None
654 item is not None
655 and item.default is not configitems.dynamicdefault
655 and item.default is not configitems.dynamicdefault
656 and default != itemdefault
656 and default != itemdefault
657 ):
657 ):
658 msg = (
658 msg = (
659 b"specifying a mismatched default value for a registered "
659 b"specifying a mismatched default value for a registered "
660 b"config item: '%s.%s' '%s'"
660 b"config item: '%s.%s' '%s'"
661 )
661 )
662 msg %= (section, name, pycompat.bytestr(default))
662 msg %= (section, name, pycompat.bytestr(default))
663 self.develwarn(msg, 2, b'warn-config-default')
663 self.develwarn(msg, 2, b'warn-config-default')
664
664
665 candidates = []
665 candidates = []
666 config = self._data(untrusted)
666 config = self._data(untrusted)
667 for s, n in alternates:
667 for s, n in alternates:
668 candidate = config.get(s, n, None)
668 candidate = config.get(s, n, None)
669 if candidate is not None:
669 if candidate is not None:
670 candidates.append((s, n, candidate))
670 candidates.append((s, n, candidate))
671 if candidates:
671 if candidates:
672
672
673 def level(x):
673 def level(x):
674 return config.level(x[0], x[1])
674 return config.level(x[0], x[1])
675
675
676 value = max(candidates, key=level)[2]
676 value = max(candidates, key=level)[2]
677
677
678 if self.debugflag and not untrusted and self._reportuntrusted:
678 if self.debugflag and not untrusted and self._reportuntrusted:
679 for s, n in alternates:
679 for s, n in alternates:
680 uvalue = self._ucfg.get(s, n)
680 uvalue = self._ucfg.get(s, n)
681 if uvalue is not None and uvalue != value:
681 if uvalue is not None and uvalue != value:
682 self.debug(
682 self.debug(
683 b"ignoring untrusted configuration option "
683 b"ignoring untrusted configuration option "
684 b"%s.%s = %s\n" % (s, n, uvalue)
684 b"%s.%s = %s\n" % (s, n, uvalue)
685 )
685 )
686 return value
686 return value
687
687
688 def config_default(self, section, name):
688 def config_default(self, section, name):
689 """return the default value for a config option
689 """return the default value for a config option
690
690
691 The default is returned "raw", for example if it is a callable, the
691 The default is returned "raw", for example if it is a callable, the
692 callable was not called.
692 callable was not called.
693 """
693 """
694 item = self._knownconfig.get(section, {}).get(name)
694 item = self._knownconfig.get(section, {}).get(name)
695
695
696 if item is None:
696 if item is None:
697 raise KeyError((section, name))
697 raise KeyError((section, name))
698 return item.default
698 return item.default
699
699
700 def configsuboptions(self, section, name, default=_unset, untrusted=False):
700 def configsuboptions(self, section, name, default=_unset, untrusted=False):
701 """Get a config option and all sub-options.
701 """Get a config option and all sub-options.
702
702
703 Some config options have sub-options that are declared with the
703 Some config options have sub-options that are declared with the
704 format "key:opt = value". This method is used to return the main
704 format "key:opt = value". This method is used to return the main
705 option and all its declared sub-options.
705 option and all its declared sub-options.
706
706
707 Returns a 2-tuple of ``(option, sub-options)``, where `sub-options``
707 Returns a 2-tuple of ``(option, sub-options)``, where `sub-options``
708 is a dict of defined sub-options where keys and values are strings.
708 is a dict of defined sub-options where keys and values are strings.
709 """
709 """
710 main = self.config(section, name, default, untrusted=untrusted)
710 main = self.config(section, name, default, untrusted=untrusted)
711 data = self._data(untrusted)
711 data = self._data(untrusted)
712 sub = {}
712 sub = {}
713 prefix = b'%s:' % name
713 prefix = b'%s:' % name
714 for k, v in data.items(section):
714 for k, v in data.items(section):
715 if k.startswith(prefix):
715 if k.startswith(prefix):
716 sub[k[len(prefix) :]] = v
716 sub[k[len(prefix) :]] = v
717
717
718 if self.debugflag and not untrusted and self._reportuntrusted:
718 if self.debugflag and not untrusted and self._reportuntrusted:
719 for k, v in sub.items():
719 for k, v in sub.items():
720 uvalue = self._ucfg.get(section, b'%s:%s' % (name, k))
720 uvalue = self._ucfg.get(section, b'%s:%s' % (name, k))
721 if uvalue is not None and uvalue != v:
721 if uvalue is not None and uvalue != v:
722 self.debug(
722 self.debug(
723 b'ignoring untrusted configuration option '
723 b'ignoring untrusted configuration option '
724 b'%s:%s.%s = %s\n' % (section, name, k, uvalue)
724 b'%s:%s.%s = %s\n' % (section, name, k, uvalue)
725 )
725 )
726
726
727 return main, sub
727 return main, sub
728
728
729 def configpath(self, section, name, default=_unset, untrusted=False):
729 def configpath(self, section, name, default=_unset, untrusted=False):
730 """get a path config item, expanded relative to repo root or config
730 """get a path config item, expanded relative to repo root or config
731 file"""
731 file"""
732 v = self.config(section, name, default, untrusted)
732 v = self.config(section, name, default, untrusted)
733 if v is None:
733 if v is None:
734 return None
734 return None
735 if not os.path.isabs(v) or b"://" not in v:
735 if not os.path.isabs(v) or b"://" not in v:
736 src = self.configsource(section, name, untrusted)
736 src = self.configsource(section, name, untrusted)
737 if b':' in src:
737 if b':' in src:
738 base = os.path.dirname(src.rsplit(b':')[0])
738 base = os.path.dirname(src.rsplit(b':')[0])
739 v = os.path.join(base, os.path.expanduser(v))
739 v = os.path.join(base, os.path.expanduser(v))
740 return v
740 return v
741
741
742 def configbool(self, section, name, default=_unset, untrusted=False):
742 def configbool(self, section, name, default=_unset, untrusted=False):
743 """parse a configuration element as a boolean
743 """parse a configuration element as a boolean
744
744
745 >>> u = ui(); s = b'foo'
745 >>> u = ui(); s = b'foo'
746 >>> u.setconfig(s, b'true', b'yes')
746 >>> u.setconfig(s, b'true', b'yes')
747 >>> u.configbool(s, b'true')
747 >>> u.configbool(s, b'true')
748 True
748 True
749 >>> u.setconfig(s, b'false', b'no')
749 >>> u.setconfig(s, b'false', b'no')
750 >>> u.configbool(s, b'false')
750 >>> u.configbool(s, b'false')
751 False
751 False
752 >>> u.configbool(s, b'unknown')
752 >>> u.configbool(s, b'unknown')
753 False
753 False
754 >>> u.configbool(s, b'unknown', True)
754 >>> u.configbool(s, b'unknown', True)
755 True
755 True
756 >>> u.setconfig(s, b'invalid', b'somevalue')
756 >>> u.setconfig(s, b'invalid', b'somevalue')
757 >>> u.configbool(s, b'invalid')
757 >>> u.configbool(s, b'invalid')
758 Traceback (most recent call last):
758 Traceback (most recent call last):
759 ...
759 ...
760 ConfigError: foo.invalid is not a boolean ('somevalue')
760 ConfigError: foo.invalid is not a boolean ('somevalue')
761 """
761 """
762
762
763 v = self._config(section, name, default, untrusted=untrusted)
763 v = self._config(section, name, default, untrusted=untrusted)
764 if v is None:
764 if v is None:
765 return v
765 return v
766 if v is _unset:
766 if v is _unset:
767 if default is _unset:
767 if default is _unset:
768 return False
768 return False
769 return default
769 return default
770 if isinstance(v, bool):
770 if isinstance(v, bool):
771 return v
771 return v
772 b = stringutil.parsebool(v)
772 b = stringutil.parsebool(v)
773 if b is None:
773 if b is None:
774 raise error.ConfigError(
774 raise error.ConfigError(
775 _(b"%s.%s is not a boolean ('%s')") % (section, name, v)
775 _(b"%s.%s is not a boolean ('%s')") % (section, name, v)
776 )
776 )
777 return b
777 return b
778
778
779 def configwith(
779 def configwith(
780 self, convert, section, name, default=_unset, desc=None, untrusted=False
780 self, convert, section, name, default=_unset, desc=None, untrusted=False
781 ):
781 ):
782 """parse a configuration element with a conversion function
782 """parse a configuration element with a conversion function
783
783
784 >>> u = ui(); s = b'foo'
784 >>> u = ui(); s = b'foo'
785 >>> u.setconfig(s, b'float1', b'42')
785 >>> u.setconfig(s, b'float1', b'42')
786 >>> u.configwith(float, s, b'float1')
786 >>> u.configwith(float, s, b'float1')
787 42.0
787 42.0
788 >>> u.setconfig(s, b'float2', b'-4.25')
788 >>> u.setconfig(s, b'float2', b'-4.25')
789 >>> u.configwith(float, s, b'float2')
789 >>> u.configwith(float, s, b'float2')
790 -4.25
790 -4.25
791 >>> u.configwith(float, s, b'unknown', 7)
791 >>> u.configwith(float, s, b'unknown', 7)
792 7.0
792 7.0
793 >>> u.setconfig(s, b'invalid', b'somevalue')
793 >>> u.setconfig(s, b'invalid', b'somevalue')
794 >>> u.configwith(float, s, b'invalid')
794 >>> u.configwith(float, s, b'invalid')
795 Traceback (most recent call last):
795 Traceback (most recent call last):
796 ...
796 ...
797 ConfigError: foo.invalid is not a valid float ('somevalue')
797 ConfigError: foo.invalid is not a valid float ('somevalue')
798 >>> u.configwith(float, s, b'invalid', desc=b'womble')
798 >>> u.configwith(float, s, b'invalid', desc=b'womble')
799 Traceback (most recent call last):
799 Traceback (most recent call last):
800 ...
800 ...
801 ConfigError: foo.invalid is not a valid womble ('somevalue')
801 ConfigError: foo.invalid is not a valid womble ('somevalue')
802 """
802 """
803
803
804 v = self.config(section, name, default, untrusted)
804 v = self.config(section, name, default, untrusted)
805 if v is None:
805 if v is None:
806 return v # do not attempt to convert None
806 return v # do not attempt to convert None
807 try:
807 try:
808 return convert(v)
808 return convert(v)
809 except (ValueError, error.ParseError):
809 except (ValueError, error.ParseError):
810 if desc is None:
810 if desc is None:
811 desc = pycompat.sysbytes(convert.__name__)
811 desc = pycompat.sysbytes(convert.__name__)
812 raise error.ConfigError(
812 raise error.ConfigError(
813 _(b"%s.%s is not a valid %s ('%s')") % (section, name, desc, v)
813 _(b"%s.%s is not a valid %s ('%s')") % (section, name, desc, v)
814 )
814 )
815
815
816 def configint(self, section, name, default=_unset, untrusted=False):
816 def configint(self, section, name, default=_unset, untrusted=False):
817 """parse a configuration element as an integer
817 """parse a configuration element as an integer
818
818
819 >>> u = ui(); s = b'foo'
819 >>> u = ui(); s = b'foo'
820 >>> u.setconfig(s, b'int1', b'42')
820 >>> u.setconfig(s, b'int1', b'42')
821 >>> u.configint(s, b'int1')
821 >>> u.configint(s, b'int1')
822 42
822 42
823 >>> u.setconfig(s, b'int2', b'-42')
823 >>> u.setconfig(s, b'int2', b'-42')
824 >>> u.configint(s, b'int2')
824 >>> u.configint(s, b'int2')
825 -42
825 -42
826 >>> u.configint(s, b'unknown', 7)
826 >>> u.configint(s, b'unknown', 7)
827 7
827 7
828 >>> u.setconfig(s, b'invalid', b'somevalue')
828 >>> u.setconfig(s, b'invalid', b'somevalue')
829 >>> u.configint(s, b'invalid')
829 >>> u.configint(s, b'invalid')
830 Traceback (most recent call last):
830 Traceback (most recent call last):
831 ...
831 ...
832 ConfigError: foo.invalid is not a valid integer ('somevalue')
832 ConfigError: foo.invalid is not a valid integer ('somevalue')
833 """
833 """
834
834
835 return self.configwith(
835 return self.configwith(
836 int, section, name, default, b'integer', untrusted
836 int, section, name, default, b'integer', untrusted
837 )
837 )
838
838
839 def configbytes(self, section, name, default=_unset, untrusted=False):
839 def configbytes(self, section, name, default=_unset, untrusted=False):
840 """parse a configuration element as a quantity in bytes
840 """parse a configuration element as a quantity in bytes
841
841
842 Units can be specified as b (bytes), k or kb (kilobytes), m or
842 Units can be specified as b (bytes), k or kb (kilobytes), m or
843 mb (megabytes), g or gb (gigabytes).
843 mb (megabytes), g or gb (gigabytes).
844
844
845 >>> u = ui(); s = b'foo'
845 >>> u = ui(); s = b'foo'
846 >>> u.setconfig(s, b'val1', b'42')
846 >>> u.setconfig(s, b'val1', b'42')
847 >>> u.configbytes(s, b'val1')
847 >>> u.configbytes(s, b'val1')
848 42
848 42
849 >>> u.setconfig(s, b'val2', b'42.5 kb')
849 >>> u.setconfig(s, b'val2', b'42.5 kb')
850 >>> u.configbytes(s, b'val2')
850 >>> u.configbytes(s, b'val2')
851 43520
851 43520
852 >>> u.configbytes(s, b'unknown', b'7 MB')
852 >>> u.configbytes(s, b'unknown', b'7 MB')
853 7340032
853 7340032
854 >>> u.setconfig(s, b'invalid', b'somevalue')
854 >>> u.setconfig(s, b'invalid', b'somevalue')
855 >>> u.configbytes(s, b'invalid')
855 >>> u.configbytes(s, b'invalid')
856 Traceback (most recent call last):
856 Traceback (most recent call last):
857 ...
857 ...
858 ConfigError: foo.invalid is not a byte quantity ('somevalue')
858 ConfigError: foo.invalid is not a byte quantity ('somevalue')
859 """
859 """
860
860
861 value = self._config(section, name, default, untrusted)
861 value = self._config(section, name, default, untrusted)
862 if value is _unset:
862 if value is _unset:
863 if default is _unset:
863 if default is _unset:
864 default = 0
864 default = 0
865 value = default
865 value = default
866 if not isinstance(value, bytes):
866 if not isinstance(value, bytes):
867 return value
867 return value
868 try:
868 try:
869 return util.sizetoint(value)
869 return util.sizetoint(value)
870 except error.ParseError:
870 except error.ParseError:
871 raise error.ConfigError(
871 raise error.ConfigError(
872 _(b"%s.%s is not a byte quantity ('%s')")
872 _(b"%s.%s is not a byte quantity ('%s')")
873 % (section, name, value)
873 % (section, name, value)
874 )
874 )
875
875
876 def configlist(self, section, name, default=_unset, untrusted=False):
876 def configlist(self, section, name, default=_unset, untrusted=False):
877 """parse a configuration element as a list of comma/space separated
877 """parse a configuration element as a list of comma/space separated
878 strings
878 strings
879
879
880 >>> u = ui(); s = b'foo'
880 >>> u = ui(); s = b'foo'
881 >>> u.setconfig(s, b'list1', b'this,is "a small" ,test')
881 >>> u.setconfig(s, b'list1', b'this,is "a small" ,test')
882 >>> u.configlist(s, b'list1')
882 >>> u.configlist(s, b'list1')
883 ['this', 'is', 'a small', 'test']
883 ['this', 'is', 'a small', 'test']
884 >>> u.setconfig(s, b'list2', b'this, is "a small" , test ')
884 >>> u.setconfig(s, b'list2', b'this, is "a small" , test ')
885 >>> u.configlist(s, b'list2')
885 >>> u.configlist(s, b'list2')
886 ['this', 'is', 'a small', 'test']
886 ['this', 'is', 'a small', 'test']
887 """
887 """
888 # default is not always a list
888 # default is not always a list
889 v = self.configwith(
889 v = self.configwith(
890 config.parselist, section, name, default, b'list', untrusted
890 config.parselist, section, name, default, b'list', untrusted
891 )
891 )
892 if isinstance(v, bytes):
892 if isinstance(v, bytes):
893 return config.parselist(v)
893 return config.parselist(v)
894 elif v is None:
894 elif v is None:
895 return []
895 return []
896 return v
896 return v
897
897
898 def configdate(self, section, name, default=_unset, untrusted=False):
898 def configdate(self, section, name, default=_unset, untrusted=False):
899 """parse a configuration element as a tuple of ints
899 """parse a configuration element as a tuple of ints
900
900
901 >>> u = ui(); s = b'foo'
901 >>> u = ui(); s = b'foo'
902 >>> u.setconfig(s, b'date', b'0 0')
902 >>> u.setconfig(s, b'date', b'0 0')
903 >>> u.configdate(s, b'date')
903 >>> u.configdate(s, b'date')
904 (0, 0)
904 (0, 0)
905 """
905 """
906 if self.config(section, name, default, untrusted):
906 if self.config(section, name, default, untrusted):
907 return self.configwith(
907 return self.configwith(
908 dateutil.parsedate, section, name, default, b'date', untrusted
908 dateutil.parsedate, section, name, default, b'date', untrusted
909 )
909 )
910 if default is _unset:
910 if default is _unset:
911 return None
911 return None
912 return default
912 return default
913
913
914 def configdefault(self, section, name):
914 def configdefault(self, section, name):
915 """returns the default value of the config item"""
915 """returns the default value of the config item"""
916 item = self._knownconfig.get(section, {}).get(name)
916 item = self._knownconfig.get(section, {}).get(name)
917 itemdefault = None
917 itemdefault = None
918 if item is not None:
918 if item is not None:
919 if callable(item.default):
919 if callable(item.default):
920 itemdefault = item.default()
920 itemdefault = item.default()
921 else:
921 else:
922 itemdefault = item.default
922 itemdefault = item.default
923 return itemdefault
923 return itemdefault
924
924
925 def hasconfig(self, section, name, untrusted=False):
925 def hasconfig(self, section, name, untrusted=False):
926 return self._data(untrusted).hasitem(section, name)
926 return self._data(untrusted).hasitem(section, name)
927
927
928 def has_section(self, section, untrusted=False):
928 def has_section(self, section, untrusted=False):
929 '''tell whether section exists in config.'''
929 '''tell whether section exists in config.'''
930 return section in self._data(untrusted)
930 return section in self._data(untrusted)
931
931
932 def configitems(self, section, untrusted=False, ignoresub=False):
932 def configitems(self, section, untrusted=False, ignoresub=False):
933 items = self._data(untrusted).items(section)
933 items = self._data(untrusted).items(section)
934 if ignoresub:
934 if ignoresub:
935 items = [i for i in items if b':' not in i[0]]
935 items = [i for i in items if b':' not in i[0]]
936 if self.debugflag and not untrusted and self._reportuntrusted:
936 if self.debugflag and not untrusted and self._reportuntrusted:
937 for k, v in self._ucfg.items(section):
937 for k, v in self._ucfg.items(section):
938 if self._tcfg.get(section, k) != v:
938 if self._tcfg.get(section, k) != v:
939 self.debug(
939 self.debug(
940 b"ignoring untrusted configuration option "
940 b"ignoring untrusted configuration option "
941 b"%s.%s = %s\n" % (section, k, v)
941 b"%s.%s = %s\n" % (section, k, v)
942 )
942 )
943 return items
943 return items
944
944
945 def walkconfig(self, untrusted=False):
945 def walkconfig(self, untrusted=False):
946 cfg = self._data(untrusted)
946 cfg = self._data(untrusted)
947 for section in cfg.sections():
947 for section in cfg.sections():
948 for name, value in self.configitems(section, untrusted):
948 for name, value in self.configitems(section, untrusted):
949 yield section, name, value
949 yield section, name, value
950
950
951 def plain(self, feature=None):
951 def plain(self, feature=None):
952 """is plain mode active?
952 """is plain mode active?
953
953
954 Plain mode means that all configuration variables which affect
954 Plain mode means that all configuration variables which affect
955 the behavior and output of Mercurial should be
955 the behavior and output of Mercurial should be
956 ignored. Additionally, the output should be stable,
956 ignored. Additionally, the output should be stable,
957 reproducible and suitable for use in scripts or applications.
957 reproducible and suitable for use in scripts or applications.
958
958
959 The only way to trigger plain mode is by setting either the
959 The only way to trigger plain mode is by setting either the
960 `HGPLAIN' or `HGPLAINEXCEPT' environment variables.
960 `HGPLAIN' or `HGPLAINEXCEPT' environment variables.
961
961
962 The return value can either be
962 The return value can either be
963 - False if HGPLAIN is not set, or feature is in HGPLAINEXCEPT
963 - False if HGPLAIN is not set, or feature is in HGPLAINEXCEPT
964 - False if feature is disabled by default and not included in HGPLAIN
964 - False if feature is disabled by default and not included in HGPLAIN
965 - True otherwise
965 - True otherwise
966 """
966 """
967 if (
967 if (
968 b'HGPLAIN' not in encoding.environ
968 b'HGPLAIN' not in encoding.environ
969 and b'HGPLAINEXCEPT' not in encoding.environ
969 and b'HGPLAINEXCEPT' not in encoding.environ
970 ):
970 ):
971 return False
971 return False
972 exceptions = (
972 exceptions = (
973 encoding.environ.get(b'HGPLAINEXCEPT', b'').strip().split(b',')
973 encoding.environ.get(b'HGPLAINEXCEPT', b'').strip().split(b',')
974 )
974 )
975 # TODO: add support for HGPLAIN=+feature,-feature syntax
975 # TODO: add support for HGPLAIN=+feature,-feature syntax
976 if b'+strictflags' not in encoding.environ.get(b'HGPLAIN', b'').split(
976 if b'+strictflags' not in encoding.environ.get(b'HGPLAIN', b'').split(
977 b','
977 b','
978 ):
978 ):
979 exceptions.append(b'strictflags')
979 exceptions.append(b'strictflags')
980 if feature and exceptions:
980 if feature and exceptions:
981 return feature not in exceptions
981 return feature not in exceptions
982 return True
982 return True
983
983
984 def username(self, acceptempty=False):
984 def username(self, acceptempty=False):
985 """Return default username to be used in commits.
985 """Return default username to be used in commits.
986
986
987 Searched in this order: $HGUSER, [ui] section of hgrcs, $EMAIL
987 Searched in this order: $HGUSER, [ui] section of hgrcs, $EMAIL
988 and stop searching if one of these is set.
988 and stop searching if one of these is set.
989 If not found and acceptempty is True, returns None.
989 If not found and acceptempty is True, returns None.
990 If not found and ui.askusername is True, ask the user, else use
990 If not found and ui.askusername is True, ask the user, else use
991 ($LOGNAME or $USER or $LNAME or $USERNAME) + "@full.hostname".
991 ($LOGNAME or $USER or $LNAME or $USERNAME) + "@full.hostname".
992 If no username could be found, raise an Abort error.
992 If no username could be found, raise an Abort error.
993 """
993 """
994 user = encoding.environ.get(b"HGUSER")
994 user = encoding.environ.get(b"HGUSER")
995 if user is None:
995 if user is None:
996 user = self.config(b"ui", b"username")
996 user = self.config(b"ui", b"username")
997 if user is not None:
997 if user is not None:
998 user = os.path.expandvars(user)
998 user = os.path.expandvars(user)
999 if user is None:
999 if user is None:
1000 user = encoding.environ.get(b"EMAIL")
1000 user = encoding.environ.get(b"EMAIL")
1001 if user is None and acceptempty:
1001 if user is None and acceptempty:
1002 return user
1002 return user
1003 if user is None and self.configbool(b"ui", b"askusername"):
1003 if user is None and self.configbool(b"ui", b"askusername"):
1004 user = self.prompt(_(b"enter a commit username:"), default=None)
1004 user = self.prompt(_(b"enter a commit username:"), default=None)
1005 if user is None and not self.interactive():
1005 if user is None and not self.interactive():
1006 try:
1006 try:
1007 user = b'%s@%s' % (
1007 user = b'%s@%s' % (
1008 procutil.getuser(),
1008 procutil.getuser(),
1009 encoding.strtolocal(socket.getfqdn()),
1009 encoding.strtolocal(socket.getfqdn()),
1010 )
1010 )
1011 self.warn(_(b"no username found, using '%s' instead\n") % user)
1011 self.warn(_(b"no username found, using '%s' instead\n") % user)
1012 except KeyError:
1012 except KeyError:
1013 pass
1013 pass
1014 if not user:
1014 if not user:
1015 raise error.Abort(
1015 raise error.Abort(
1016 _(b'no username supplied'),
1016 _(b'no username supplied'),
1017 hint=_(b"use 'hg config --edit' " b'to set your username'),
1017 hint=_(b"use 'hg config --edit' " b'to set your username'),
1018 )
1018 )
1019 if b"\n" in user:
1019 if b"\n" in user:
1020 raise error.Abort(
1020 raise error.Abort(
1021 _(b"username %r contains a newline\n") % pycompat.bytestr(user)
1021 _(b"username %r contains a newline\n") % pycompat.bytestr(user)
1022 )
1022 )
1023 return user
1023 return user
1024
1024
1025 def shortuser(self, user):
1025 def shortuser(self, user):
1026 """Return a short representation of a user name or email address."""
1026 """Return a short representation of a user name or email address."""
1027 if not self.verbose:
1027 if not self.verbose:
1028 user = stringutil.shortuser(user)
1028 user = stringutil.shortuser(user)
1029 return user
1029 return user
1030
1030
1031 def expandpath(self, loc, default=None):
1031 def expandpath(self, loc, default=None):
1032 """Return repository location relative to cwd or from [paths]"""
1032 """Return repository location relative to cwd or from [paths]"""
1033 try:
1033 try:
1034 p = self.getpath(loc)
1034 p = self.getpath(loc)
1035 if p:
1035 if p:
1036 return p.rawloc
1036 return p.rawloc
1037 except error.RepoError:
1037 except error.RepoError:
1038 pass
1038 pass
1039
1039
1040 if default:
1040 if default:
1041 try:
1041 try:
1042 p = self.getpath(default)
1042 p = self.getpath(default)
1043 if p:
1043 if p:
1044 return p.rawloc
1044 return p.rawloc
1045 except error.RepoError:
1045 except error.RepoError:
1046 pass
1046 pass
1047
1047
1048 return loc
1048 return loc
1049
1049
1050 @util.propertycache
1050 @util.propertycache
1051 def paths(self):
1051 def paths(self):
1052 return paths(self)
1052 return paths(self)
1053
1053
1054 def getpath(self, *args, **kwargs):
1054 def getpath(self, *args, **kwargs):
1055 """see paths.getpath for details
1055 """see paths.getpath for details
1056
1056
1057 This method exist as `getpath` need a ui for potential warning message.
1057 This method exist as `getpath` need a ui for potential warning message.
1058 """
1058 """
1059 return self.paths.getpath(self, *args, **kwargs)
1059 return self.paths.getpath(self, *args, **kwargs)
1060
1060
1061 @property
1061 @property
1062 def fout(self):
1062 def fout(self):
1063 return self._fout
1063 return self._fout
1064
1064
1065 @fout.setter
1065 @fout.setter
1066 def fout(self, f):
1066 def fout(self, f):
1067 self._fout = f
1067 self._fout = f
1068 self._fmsgout, self._fmsgerr = _selectmsgdests(self)
1068 self._fmsgout, self._fmsgerr = _selectmsgdests(self)
1069
1069
1070 @property
1070 @property
1071 def ferr(self):
1071 def ferr(self):
1072 return self._ferr
1072 return self._ferr
1073
1073
1074 @ferr.setter
1074 @ferr.setter
1075 def ferr(self, f):
1075 def ferr(self, f):
1076 self._ferr = f
1076 self._ferr = f
1077 self._fmsgout, self._fmsgerr = _selectmsgdests(self)
1077 self._fmsgout, self._fmsgerr = _selectmsgdests(self)
1078
1078
1079 @property
1079 @property
1080 def fin(self):
1080 def fin(self):
1081 return self._fin
1081 return self._fin
1082
1082
1083 @fin.setter
1083 @fin.setter
1084 def fin(self, f):
1084 def fin(self, f):
1085 self._fin = f
1085 self._fin = f
1086
1086
1087 @property
1087 @property
1088 def fmsg(self):
1088 def fmsg(self):
1089 """Stream dedicated for status/error messages; may be None if
1089 """Stream dedicated for status/error messages; may be None if
1090 fout/ferr are used"""
1090 fout/ferr are used"""
1091 return self._fmsg
1091 return self._fmsg
1092
1092
1093 @fmsg.setter
1093 @fmsg.setter
1094 def fmsg(self, f):
1094 def fmsg(self, f):
1095 self._fmsg = f
1095 self._fmsg = f
1096 self._fmsgout, self._fmsgerr = _selectmsgdests(self)
1096 self._fmsgout, self._fmsgerr = _selectmsgdests(self)
1097
1097
1098 def pushbuffer(self, error=False, subproc=False, labeled=False):
1098 def pushbuffer(self, error=False, subproc=False, labeled=False):
1099 """install a buffer to capture standard output of the ui object
1099 """install a buffer to capture standard output of the ui object
1100
1100
1101 If error is True, the error output will be captured too.
1101 If error is True, the error output will be captured too.
1102
1102
1103 If subproc is True, output from subprocesses (typically hooks) will be
1103 If subproc is True, output from subprocesses (typically hooks) will be
1104 captured too.
1104 captured too.
1105
1105
1106 If labeled is True, any labels associated with buffered
1106 If labeled is True, any labels associated with buffered
1107 output will be handled. By default, this has no effect
1107 output will be handled. By default, this has no effect
1108 on the output returned, but extensions and GUI tools may
1108 on the output returned, but extensions and GUI tools may
1109 handle this argument and returned styled output. If output
1109 handle this argument and returned styled output. If output
1110 is being buffered so it can be captured and parsed or
1110 is being buffered so it can be captured and parsed or
1111 processed, labeled should not be set to True.
1111 processed, labeled should not be set to True.
1112 """
1112 """
1113 self._buffers.append([])
1113 self._buffers.append([])
1114 self._bufferstates.append((error, subproc, labeled))
1114 self._bufferstates.append((error, subproc, labeled))
1115 self._bufferapplylabels = labeled
1115 self._bufferapplylabels = labeled
1116
1116
1117 def popbuffer(self):
1117 def popbuffer(self):
1118 '''pop the last buffer and return the buffered output'''
1118 '''pop the last buffer and return the buffered output'''
1119 self._bufferstates.pop()
1119 self._bufferstates.pop()
1120 if self._bufferstates:
1120 if self._bufferstates:
1121 self._bufferapplylabels = self._bufferstates[-1][2]
1121 self._bufferapplylabels = self._bufferstates[-1][2]
1122 else:
1122 else:
1123 self._bufferapplylabels = None
1123 self._bufferapplylabels = None
1124
1124
1125 return b"".join(self._buffers.pop())
1125 return b"".join(self._buffers.pop())
1126
1126
1127 def _isbuffered(self, dest):
1127 def _isbuffered(self, dest):
1128 if dest is self._fout:
1128 if dest is self._fout:
1129 return bool(self._buffers)
1129 return bool(self._buffers)
1130 if dest is self._ferr:
1130 if dest is self._ferr:
1131 return bool(self._bufferstates and self._bufferstates[-1][0])
1131 return bool(self._bufferstates and self._bufferstates[-1][0])
1132 return False
1132 return False
1133
1133
1134 def canwritewithoutlabels(self):
1134 def canwritewithoutlabels(self):
1135 '''check if write skips the label'''
1135 '''check if write skips the label'''
1136 if self._buffers and not self._bufferapplylabels:
1136 if self._buffers and not self._bufferapplylabels:
1137 return True
1137 return True
1138 return self._colormode is None
1138 return self._colormode is None
1139
1139
1140 def canbatchlabeledwrites(self):
1140 def canbatchlabeledwrites(self):
1141 '''check if write calls with labels are batchable'''
1141 '''check if write calls with labels are batchable'''
1142 # Windows color printing is special, see ``write``.
1142 # Windows color printing is special, see ``write``.
1143 return self._colormode != b'win32'
1143 return self._colormode != b'win32'
1144
1144
1145 def write(self, *args, **opts):
1145 def write(self, *args, **opts):
1146 """write args to output
1146 """write args to output
1147
1147
1148 By default, this method simply writes to the buffer or stdout.
1148 By default, this method simply writes to the buffer or stdout.
1149 Color mode can be set on the UI class to have the output decorated
1149 Color mode can be set on the UI class to have the output decorated
1150 with color modifier before being written to stdout.
1150 with color modifier before being written to stdout.
1151
1151
1152 The color used is controlled by an optional keyword argument, "label".
1152 The color used is controlled by an optional keyword argument, "label".
1153 This should be a string containing label names separated by space.
1153 This should be a string containing label names separated by space.
1154 Label names take the form of "topic.type". For example, ui.debug()
1154 Label names take the form of "topic.type". For example, ui.debug()
1155 issues a label of "ui.debug".
1155 issues a label of "ui.debug".
1156
1156
1157 Progress reports via stderr are normally cleared before writing as
1157 Progress reports via stderr are normally cleared before writing as
1158 stdout and stderr go to the same terminal. This can be skipped with
1158 stdout and stderr go to the same terminal. This can be skipped with
1159 the optional keyword argument "keepprogressbar". The progress bar
1159 the optional keyword argument "keepprogressbar". The progress bar
1160 will continue to occupy a partial line on stderr in that case.
1160 will continue to occupy a partial line on stderr in that case.
1161 This functionality is intended when Mercurial acts as data source
1161 This functionality is intended when Mercurial acts as data source
1162 in a pipe.
1162 in a pipe.
1163
1163
1164 When labeling output for a specific command, a label of
1164 When labeling output for a specific command, a label of
1165 "cmdname.type" is recommended. For example, status issues
1165 "cmdname.type" is recommended. For example, status issues
1166 a label of "status.modified" for modified files.
1166 a label of "status.modified" for modified files.
1167 """
1167 """
1168 dest = self._fout
1168 dest = self._fout
1169
1169
1170 # inlined _write() for speed
1170 # inlined _write() for speed
1171 if self._buffers:
1171 if self._buffers:
1172 label = opts.get('label', b'')
1172 label = opts.get('label', b'')
1173 if label and self._bufferapplylabels:
1173 if label and self._bufferapplylabels:
1174 self._buffers[-1].extend(self.label(a, label) for a in args)
1174 self._buffers[-1].extend(self.label(a, label) for a in args)
1175 else:
1175 else:
1176 self._buffers[-1].extend(args)
1176 self._buffers[-1].extend(args)
1177 return
1177 return
1178
1178
1179 # inlined _writenobuf() for speed
1179 # inlined _writenobuf() for speed
1180 if not opts.get('keepprogressbar', False):
1180 if not opts.get('keepprogressbar', False):
1181 self._progclear()
1181 self._progclear()
1182 msg = b''.join(args)
1182 msg = b''.join(args)
1183
1183
1184 # opencode timeblockedsection because this is a critical path
1184 # opencode timeblockedsection because this is a critical path
1185 starttime = util.timer()
1185 starttime = util.timer()
1186 try:
1186 try:
1187 if self._colormode == b'win32':
1187 if self._colormode == b'win32':
1188 # windows color printing is its own can of crab, defer to
1188 # windows color printing is its own can of crab, defer to
1189 # the color module and that is it.
1189 # the color module and that is it.
1190 color.win32print(self, dest.write, msg, **opts)
1190 color.win32print(self, dest.write, msg, **opts)
1191 else:
1191 else:
1192 if self._colormode is not None:
1192 if self._colormode is not None:
1193 label = opts.get('label', b'')
1193 label = opts.get('label', b'')
1194 msg = self.label(msg, label)
1194 msg = self.label(msg, label)
1195 dest.write(msg)
1195 dest.write(msg)
1196 except IOError as err:
1196 except IOError as err:
1197 raise error.StdioError(err)
1197 raise error.StdioError(err)
1198 finally:
1198 finally:
1199 self._blockedtimes[b'stdio_blocked'] += (
1199 self._blockedtimes[b'stdio_blocked'] += (
1200 util.timer() - starttime
1200 util.timer() - starttime
1201 ) * 1000
1201 ) * 1000
1202
1202
1203 def write_err(self, *args, **opts):
1203 def write_err(self, *args, **opts):
1204 self._write(self._ferr, *args, **opts)
1204 self._write(self._ferr, *args, **opts)
1205
1205
1206 def _write(self, dest, *args, **opts):
1206 def _write(self, dest, *args, **opts):
1207 # update write() as well if you touch this code
1207 # update write() as well if you touch this code
1208 if self._isbuffered(dest):
1208 if self._isbuffered(dest):
1209 label = opts.get('label', b'')
1209 label = opts.get('label', b'')
1210 if label and self._bufferapplylabels:
1210 if label and self._bufferapplylabels:
1211 self._buffers[-1].extend(self.label(a, label) for a in args)
1211 self._buffers[-1].extend(self.label(a, label) for a in args)
1212 else:
1212 else:
1213 self._buffers[-1].extend(args)
1213 self._buffers[-1].extend(args)
1214 else:
1214 else:
1215 self._writenobuf(dest, *args, **opts)
1215 self._writenobuf(dest, *args, **opts)
1216
1216
1217 def _writenobuf(self, dest, *args, **opts):
1217 def _writenobuf(self, dest, *args, **opts):
1218 # update write() as well if you touch this code
1218 # update write() as well if you touch this code
1219 if not opts.get('keepprogressbar', False):
1219 if not opts.get('keepprogressbar', False):
1220 self._progclear()
1220 self._progclear()
1221 msg = b''.join(args)
1221 msg = b''.join(args)
1222
1222
1223 # opencode timeblockedsection because this is a critical path
1223 # opencode timeblockedsection because this is a critical path
1224 starttime = util.timer()
1224 starttime = util.timer()
1225 try:
1225 try:
1226 if dest is self._ferr and not getattr(self._fout, 'closed', False):
1226 if dest is self._ferr and not getattr(self._fout, 'closed', False):
1227 self._fout.flush()
1227 self._fout.flush()
1228 if getattr(dest, 'structured', False):
1228 if getattr(dest, 'structured', False):
1229 # channel for machine-readable output with metadata, where
1229 # channel for machine-readable output with metadata, where
1230 # no extra colorization is necessary.
1230 # no extra colorization is necessary.
1231 dest.write(msg, **opts)
1231 dest.write(msg, **opts)
1232 elif self._colormode == b'win32':
1232 elif self._colormode == b'win32':
1233 # windows color printing is its own can of crab, defer to
1233 # windows color printing is its own can of crab, defer to
1234 # the color module and that is it.
1234 # the color module and that is it.
1235 color.win32print(self, dest.write, msg, **opts)
1235 color.win32print(self, dest.write, msg, **opts)
1236 else:
1236 else:
1237 if self._colormode is not None:
1237 if self._colormode is not None:
1238 label = opts.get('label', b'')
1238 label = opts.get('label', b'')
1239 msg = self.label(msg, label)
1239 msg = self.label(msg, label)
1240 dest.write(msg)
1240 dest.write(msg)
1241 # stderr may be buffered under win32 when redirected to files,
1241 # stderr may be buffered under win32 when redirected to files,
1242 # including stdout.
1242 # including stdout.
1243 if dest is self._ferr and not getattr(dest, 'closed', False):
1243 if dest is self._ferr and not getattr(dest, 'closed', False):
1244 dest.flush()
1244 dest.flush()
1245 except IOError as err:
1245 except IOError as err:
1246 if dest is self._ferr and err.errno in (
1246 if dest is self._ferr and err.errno in (
1247 errno.EPIPE,
1247 errno.EPIPE,
1248 errno.EIO,
1248 errno.EIO,
1249 errno.EBADF,
1249 errno.EBADF,
1250 ):
1250 ):
1251 # no way to report the error, so ignore it
1251 # no way to report the error, so ignore it
1252 return
1252 return
1253 raise error.StdioError(err)
1253 raise error.StdioError(err)
1254 finally:
1254 finally:
1255 self._blockedtimes[b'stdio_blocked'] += (
1255 self._blockedtimes[b'stdio_blocked'] += (
1256 util.timer() - starttime
1256 util.timer() - starttime
1257 ) * 1000
1257 ) * 1000
1258
1258
1259 def _writemsg(self, dest, *args, **opts):
1259 def _writemsg(self, dest, *args, **opts):
1260 timestamp = self.showtimestamp and opts.get('type') in {
1260 timestamp = self.showtimestamp and opts.get('type') in {
1261 b'debug',
1261 b'debug',
1262 b'error',
1262 b'error',
1263 b'note',
1263 b'note',
1264 b'status',
1264 b'status',
1265 b'warning',
1265 b'warning',
1266 }
1266 }
1267 if timestamp:
1267 if timestamp:
1268 args = (
1268 args = (
1269 b'[%s] '
1269 b'[%s] '
1270 % pycompat.bytestr(datetime.datetime.now().isoformat()),
1270 % pycompat.bytestr(datetime.datetime.now().isoformat()),
1271 ) + args
1271 ) + args
1272 _writemsgwith(self._write, dest, *args, **opts)
1272 _writemsgwith(self._write, dest, *args, **opts)
1273 if timestamp:
1273 if timestamp:
1274 dest.flush()
1274 dest.flush()
1275
1275
1276 def _writemsgnobuf(self, dest, *args, **opts):
1276 def _writemsgnobuf(self, dest, *args, **opts):
1277 _writemsgwith(self._writenobuf, dest, *args, **opts)
1277 _writemsgwith(self._writenobuf, dest, *args, **opts)
1278
1278
1279 def flush(self):
1279 def flush(self):
1280 # opencode timeblockedsection because this is a critical path
1280 # opencode timeblockedsection because this is a critical path
1281 starttime = util.timer()
1281 starttime = util.timer()
1282 try:
1282 try:
1283 try:
1283 try:
1284 self._fout.flush()
1284 self._fout.flush()
1285 except IOError as err:
1285 except IOError as err:
1286 if err.errno not in (errno.EPIPE, errno.EIO, errno.EBADF):
1286 if err.errno not in (errno.EPIPE, errno.EIO, errno.EBADF):
1287 raise error.StdioError(err)
1287 raise error.StdioError(err)
1288 finally:
1288 finally:
1289 try:
1289 try:
1290 self._ferr.flush()
1290 self._ferr.flush()
1291 except IOError as err:
1291 except IOError as err:
1292 if err.errno not in (errno.EPIPE, errno.EIO, errno.EBADF):
1292 if err.errno not in (errno.EPIPE, errno.EIO, errno.EBADF):
1293 raise error.StdioError(err)
1293 raise error.StdioError(err)
1294 finally:
1294 finally:
1295 self._blockedtimes[b'stdio_blocked'] += (
1295 self._blockedtimes[b'stdio_blocked'] += (
1296 util.timer() - starttime
1296 util.timer() - starttime
1297 ) * 1000
1297 ) * 1000
1298
1298
1299 def _isatty(self, fh):
1299 def _isatty(self, fh):
1300 if self.configbool(b'ui', b'nontty'):
1300 if self.configbool(b'ui', b'nontty'):
1301 return False
1301 return False
1302 return procutil.isatty(fh)
1302 return procutil.isatty(fh)
1303
1303
1304 def protectfinout(self):
1304 def protectfinout(self):
1305 """Duplicate ui streams and redirect original if they are stdio
1305 """Duplicate ui streams and redirect original if they are stdio
1306
1306
1307 Returns (fin, fout) which point to the original ui fds, but may be
1307 Returns (fin, fout) which point to the original ui fds, but may be
1308 copy of them. The returned streams can be considered "owned" in that
1308 copy of them. The returned streams can be considered "owned" in that
1309 print(), exec(), etc. never reach to them.
1309 print(), exec(), etc. never reach to them.
1310 """
1310 """
1311 if self._finoutredirected:
1311 if self._finoutredirected:
1312 # if already redirected, protectstdio() would just create another
1312 # if already redirected, protectstdio() would just create another
1313 # nullfd pair, which is equivalent to returning self._fin/_fout.
1313 # nullfd pair, which is equivalent to returning self._fin/_fout.
1314 return self._fin, self._fout
1314 return self._fin, self._fout
1315 fin, fout = procutil.protectstdio(self._fin, self._fout)
1315 fin, fout = procutil.protectstdio(self._fin, self._fout)
1316 self._finoutredirected = (fin, fout) != (self._fin, self._fout)
1316 self._finoutredirected = (fin, fout) != (self._fin, self._fout)
1317 return fin, fout
1317 return fin, fout
1318
1318
1319 def restorefinout(self, fin, fout):
1319 def restorefinout(self, fin, fout):
1320 """Restore ui streams from possibly duplicated (fin, fout)"""
1320 """Restore ui streams from possibly duplicated (fin, fout)"""
1321 if (fin, fout) == (self._fin, self._fout):
1321 if (fin, fout) == (self._fin, self._fout):
1322 return
1322 return
1323 procutil.restorestdio(self._fin, self._fout, fin, fout)
1323 procutil.restorestdio(self._fin, self._fout, fin, fout)
1324 # protectfinout() won't create more than one duplicated streams,
1324 # protectfinout() won't create more than one duplicated streams,
1325 # so we can just turn the redirection flag off.
1325 # so we can just turn the redirection flag off.
1326 self._finoutredirected = False
1326 self._finoutredirected = False
1327
1327
1328 @contextlib.contextmanager
1328 @contextlib.contextmanager
1329 def protectedfinout(self):
1329 def protectedfinout(self):
1330 """Run code block with protected standard streams"""
1330 """Run code block with protected standard streams"""
1331 fin, fout = self.protectfinout()
1331 fin, fout = self.protectfinout()
1332 try:
1332 try:
1333 yield fin, fout
1333 yield fin, fout
1334 finally:
1334 finally:
1335 self.restorefinout(fin, fout)
1335 self.restorefinout(fin, fout)
1336
1336
1337 def disablepager(self):
1337 def disablepager(self):
1338 self._disablepager = True
1338 self._disablepager = True
1339
1339
1340 def pager(self, command):
1340 def pager(self, command):
1341 """Start a pager for subsequent command output.
1341 """Start a pager for subsequent command output.
1342
1342
1343 Commands which produce a long stream of output should call
1343 Commands which produce a long stream of output should call
1344 this function to activate the user's preferred pagination
1344 this function to activate the user's preferred pagination
1345 mechanism (which may be no pager). Calling this function
1345 mechanism (which may be no pager). Calling this function
1346 precludes any future use of interactive functionality, such as
1346 precludes any future use of interactive functionality, such as
1347 prompting the user or activating curses.
1347 prompting the user or activating curses.
1348
1348
1349 Args:
1349 Args:
1350 command: The full, non-aliased name of the command. That is, "log"
1350 command: The full, non-aliased name of the command. That is, "log"
1351 not "history, "summary" not "summ", etc.
1351 not "history, "summary" not "summ", etc.
1352 """
1352 """
1353 if self._disablepager or self.pageractive:
1353 if self._disablepager or self.pageractive:
1354 # how pager should do is already determined
1354 # how pager should do is already determined
1355 return
1355 return
1356
1356
1357 if not command.startswith(b'internal-always-') and (
1357 if not command.startswith(b'internal-always-') and (
1358 # explicit --pager=on (= 'internal-always-' prefix) should
1358 # explicit --pager=on (= 'internal-always-' prefix) should
1359 # take precedence over disabling factors below
1359 # take precedence over disabling factors below
1360 command in self.configlist(b'pager', b'ignore')
1360 command in self.configlist(b'pager', b'ignore')
1361 or not self.configbool(b'ui', b'paginate')
1361 or not self.configbool(b'ui', b'paginate')
1362 or not self.configbool(b'pager', b'attend-' + command, True)
1362 or not self.configbool(b'pager', b'attend-' + command, True)
1363 or encoding.environ.get(b'TERM') == b'dumb'
1363 or encoding.environ.get(b'TERM') == b'dumb'
1364 # TODO: if we want to allow HGPLAINEXCEPT=pager,
1364 # TODO: if we want to allow HGPLAINEXCEPT=pager,
1365 # formatted() will need some adjustment.
1365 # formatted() will need some adjustment.
1366 or not self.formatted()
1366 or not self.formatted()
1367 or self.plain()
1367 or self.plain()
1368 or self._buffers
1368 or self._buffers
1369 # TODO: expose debugger-enabled on the UI object
1369 # TODO: expose debugger-enabled on the UI object
1370 or b'--debugger' in pycompat.sysargv
1370 or b'--debugger' in pycompat.sysargv
1371 ):
1371 ):
1372 # We only want to paginate if the ui appears to be
1372 # We only want to paginate if the ui appears to be
1373 # interactive, the user didn't say HGPLAIN or
1373 # interactive, the user didn't say HGPLAIN or
1374 # HGPLAINEXCEPT=pager, and the user didn't specify --debug.
1374 # HGPLAINEXCEPT=pager, and the user didn't specify --debug.
1375 return
1375 return
1376
1376
1377 pagercmd = self.config(b'pager', b'pager', rcutil.fallbackpager)
1377 pagercmd = self.config(b'pager', b'pager', rcutil.fallbackpager)
1378 if not pagercmd:
1378 if not pagercmd:
1379 return
1379 return
1380
1380
1381 pagerenv = {}
1381 pagerenv = {}
1382 for name, value in rcutil.defaultpagerenv().items():
1382 for name, value in rcutil.defaultpagerenv().items():
1383 if name not in encoding.environ:
1383 if name not in encoding.environ:
1384 pagerenv[name] = value
1384 pagerenv[name] = value
1385
1385
1386 self.debug(
1386 self.debug(
1387 b'starting pager for command %s\n' % stringutil.pprint(command)
1387 b'starting pager for command %s\n' % stringutil.pprint(command)
1388 )
1388 )
1389 self.flush()
1389 self.flush()
1390
1390
1391 wasformatted = self.formatted()
1391 wasformatted = self.formatted()
1392 if util.safehasattr(signal, b"SIGPIPE"):
1392 if util.safehasattr(signal, b"SIGPIPE"):
1393 signal.signal(signal.SIGPIPE, _catchterm)
1393 signal.signal(signal.SIGPIPE, _catchterm)
1394 if self._runpager(pagercmd, pagerenv):
1394 if self._runpager(pagercmd, pagerenv):
1395 self.pageractive = True
1395 self.pageractive = True
1396 # Preserve the formatted-ness of the UI. This is important
1396 # Preserve the formatted-ness of the UI. This is important
1397 # because we mess with stdout, which might confuse
1397 # because we mess with stdout, which might confuse
1398 # auto-detection of things being formatted.
1398 # auto-detection of things being formatted.
1399 self.setconfig(b'ui', b'formatted', wasformatted, b'pager')
1399 self.setconfig(b'ui', b'formatted', wasformatted, b'pager')
1400 self.setconfig(b'ui', b'interactive', False, b'pager')
1400 self.setconfig(b'ui', b'interactive', False, b'pager')
1401
1401
1402 # If pagermode differs from color.mode, reconfigure color now that
1402 # If pagermode differs from color.mode, reconfigure color now that
1403 # pageractive is set.
1403 # pageractive is set.
1404 cm = self._colormode
1404 cm = self._colormode
1405 if cm != self.config(b'color', b'pagermode', cm):
1405 if cm != self.config(b'color', b'pagermode', cm):
1406 color.setup(self)
1406 color.setup(self)
1407 else:
1407 else:
1408 # If the pager can't be spawned in dispatch when --pager=on is
1408 # If the pager can't be spawned in dispatch when --pager=on is
1409 # given, don't try again when the command runs, to avoid a duplicate
1409 # given, don't try again when the command runs, to avoid a duplicate
1410 # warning about a missing pager command.
1410 # warning about a missing pager command.
1411 self.disablepager()
1411 self.disablepager()
1412
1412
1413 def _runpager(self, command, env=None):
1413 def _runpager(self, command, env=None):
1414 """Actually start the pager and set up file descriptors.
1414 """Actually start the pager and set up file descriptors.
1415
1415
1416 This is separate in part so that extensions (like chg) can
1416 This is separate in part so that extensions (like chg) can
1417 override how a pager is invoked.
1417 override how a pager is invoked.
1418 """
1418 """
1419 if command == b'cat':
1419 if command == b'cat':
1420 # Save ourselves some work.
1420 # Save ourselves some work.
1421 return False
1421 return False
1422 # If the command doesn't contain any of these characters, we
1422 # If the command doesn't contain any of these characters, we
1423 # assume it's a binary and exec it directly. This means for
1423 # assume it's a binary and exec it directly. This means for
1424 # simple pager command configurations, we can degrade
1424 # simple pager command configurations, we can degrade
1425 # gracefully and tell the user about their broken pager.
1425 # gracefully and tell the user about their broken pager.
1426 shell = any(c in command for c in b"|&;<>()$`\\\"' \t\n*?[#~=%")
1426 shell = any(c in command for c in b"|&;<>()$`\\\"' \t\n*?[#~=%")
1427
1427
1428 if pycompat.iswindows and not shell:
1428 if pycompat.iswindows and not shell:
1429 # Window's built-in `more` cannot be invoked with shell=False, but
1429 # Window's built-in `more` cannot be invoked with shell=False, but
1430 # its `more.com` can. Hide this implementation detail from the
1430 # its `more.com` can. Hide this implementation detail from the
1431 # user so we can also get sane bad PAGER behavior. MSYS has
1431 # user so we can also get sane bad PAGER behavior. MSYS has
1432 # `more.exe`, so do a cmd.exe style resolution of the executable to
1432 # `more.exe`, so do a cmd.exe style resolution of the executable to
1433 # determine which one to use.
1433 # determine which one to use.
1434 fullcmd = procutil.findexe(command)
1434 fullcmd = procutil.findexe(command)
1435 if not fullcmd:
1435 if not fullcmd:
1436 self.warn(
1436 self.warn(
1437 _(b"missing pager command '%s', skipping pager\n") % command
1437 _(b"missing pager command '%s', skipping pager\n") % command
1438 )
1438 )
1439 return False
1439 return False
1440
1440
1441 command = fullcmd
1441 command = fullcmd
1442
1442
1443 try:
1443 try:
1444 pager = subprocess.Popen(
1444 pager = subprocess.Popen(
1445 procutil.tonativestr(command),
1445 procutil.tonativestr(command),
1446 shell=shell,
1446 shell=shell,
1447 bufsize=-1,
1447 bufsize=-1,
1448 close_fds=procutil.closefds,
1448 close_fds=procutil.closefds,
1449 stdin=subprocess.PIPE,
1449 stdin=subprocess.PIPE,
1450 stdout=procutil.stdout,
1450 stdout=procutil.stdout,
1451 stderr=procutil.stderr,
1451 stderr=procutil.stderr,
1452 env=procutil.tonativeenv(procutil.shellenviron(env)),
1452 env=procutil.tonativeenv(procutil.shellenviron(env)),
1453 )
1453 )
1454 except OSError as e:
1454 except OSError as e:
1455 if e.errno == errno.ENOENT and not shell:
1455 if e.errno == errno.ENOENT and not shell:
1456 self.warn(
1456 self.warn(
1457 _(b"missing pager command '%s', skipping pager\n") % command
1457 _(b"missing pager command '%s', skipping pager\n") % command
1458 )
1458 )
1459 return False
1459 return False
1460 raise
1460 raise
1461
1461
1462 # back up original file descriptors
1462 # back up original file descriptors
1463 stdoutfd = os.dup(procutil.stdout.fileno())
1463 stdoutfd = os.dup(procutil.stdout.fileno())
1464 stderrfd = os.dup(procutil.stderr.fileno())
1464 stderrfd = os.dup(procutil.stderr.fileno())
1465
1465
1466 os.dup2(pager.stdin.fileno(), procutil.stdout.fileno())
1466 os.dup2(pager.stdin.fileno(), procutil.stdout.fileno())
1467 if self._isatty(procutil.stderr):
1467 if self._isatty(procutil.stderr):
1468 os.dup2(pager.stdin.fileno(), procutil.stderr.fileno())
1468 os.dup2(pager.stdin.fileno(), procutil.stderr.fileno())
1469
1469
1470 @self.atexit
1470 @self.atexit
1471 def killpager():
1471 def killpager():
1472 if util.safehasattr(signal, b"SIGINT"):
1472 if util.safehasattr(signal, b"SIGINT"):
1473 signal.signal(signal.SIGINT, signal.SIG_IGN)
1473 signal.signal(signal.SIGINT, signal.SIG_IGN)
1474 # restore original fds, closing pager.stdin copies in the process
1474 # restore original fds, closing pager.stdin copies in the process
1475 os.dup2(stdoutfd, procutil.stdout.fileno())
1475 os.dup2(stdoutfd, procutil.stdout.fileno())
1476 os.dup2(stderrfd, procutil.stderr.fileno())
1476 os.dup2(stderrfd, procutil.stderr.fileno())
1477 pager.stdin.close()
1477 pager.stdin.close()
1478 pager.wait()
1478 pager.wait()
1479
1479
1480 return True
1480 return True
1481
1481
1482 @property
1482 @property
1483 def _exithandlers(self):
1483 def _exithandlers(self):
1484 return _reqexithandlers
1484 return _reqexithandlers
1485
1485
1486 def atexit(self, func, *args, **kwargs):
1486 def atexit(self, func, *args, **kwargs):
1487 """register a function to run after dispatching a request
1487 """register a function to run after dispatching a request
1488
1488
1489 Handlers do not stay registered across request boundaries."""
1489 Handlers do not stay registered across request boundaries."""
1490 self._exithandlers.append((func, args, kwargs))
1490 self._exithandlers.append((func, args, kwargs))
1491 return func
1491 return func
1492
1492
1493 def interface(self, feature):
1493 def interface(self, feature):
1494 """what interface to use for interactive console features?
1494 """what interface to use for interactive console features?
1495
1495
1496 The interface is controlled by the value of `ui.interface` but also by
1496 The interface is controlled by the value of `ui.interface` but also by
1497 the value of feature-specific configuration. For example:
1497 the value of feature-specific configuration. For example:
1498
1498
1499 ui.interface.histedit = text
1499 ui.interface.histedit = text
1500 ui.interface.chunkselector = curses
1500 ui.interface.chunkselector = curses
1501
1501
1502 Here the features are "histedit" and "chunkselector".
1502 Here the features are "histedit" and "chunkselector".
1503
1503
1504 The configuration above means that the default interfaces for commands
1504 The configuration above means that the default interfaces for commands
1505 is curses, the interface for histedit is text and the interface for
1505 is curses, the interface for histedit is text and the interface for
1506 selecting chunk is crecord (the best curses interface available).
1506 selecting chunk is crecord (the best curses interface available).
1507
1507
1508 Consider the following example:
1508 Consider the following example:
1509 ui.interface = curses
1509 ui.interface = curses
1510 ui.interface.histedit = text
1510 ui.interface.histedit = text
1511
1511
1512 Then histedit will use the text interface and chunkselector will use
1512 Then histedit will use the text interface and chunkselector will use
1513 the default curses interface (crecord at the moment).
1513 the default curses interface (crecord at the moment).
1514 """
1514 """
1515 alldefaults = frozenset([b"text", b"curses"])
1515 alldefaults = frozenset([b"text", b"curses"])
1516
1516
1517 featureinterfaces = {
1517 featureinterfaces = {
1518 b"chunkselector": [
1518 b"chunkselector": [
1519 b"text",
1519 b"text",
1520 b"curses",
1520 b"curses",
1521 ],
1521 ],
1522 b"histedit": [
1522 b"histedit": [
1523 b"text",
1523 b"text",
1524 b"curses",
1524 b"curses",
1525 ],
1525 ],
1526 }
1526 }
1527
1527
1528 # Feature-specific interface
1528 # Feature-specific interface
1529 if feature not in featureinterfaces.keys():
1529 if feature not in featureinterfaces.keys():
1530 # Programming error, not user error
1530 # Programming error, not user error
1531 raise ValueError(b"Unknown feature requested %s" % feature)
1531 raise ValueError(b"Unknown feature requested %s" % feature)
1532
1532
1533 availableinterfaces = frozenset(featureinterfaces[feature])
1533 availableinterfaces = frozenset(featureinterfaces[feature])
1534 if alldefaults > availableinterfaces:
1534 if alldefaults > availableinterfaces:
1535 # Programming error, not user error. We need a use case to
1535 # Programming error, not user error. We need a use case to
1536 # define the right thing to do here.
1536 # define the right thing to do here.
1537 raise ValueError(
1537 raise ValueError(
1538 b"Feature %s does not handle all default interfaces" % feature
1538 b"Feature %s does not handle all default interfaces" % feature
1539 )
1539 )
1540
1540
1541 if self.plain() or encoding.environ.get(b'TERM') == b'dumb':
1541 if self.plain() or encoding.environ.get(b'TERM') == b'dumb':
1542 return b"text"
1542 return b"text"
1543
1543
1544 # Default interface for all the features
1544 # Default interface for all the features
1545 defaultinterface = b"text"
1545 defaultinterface = b"text"
1546 i = self.config(b"ui", b"interface")
1546 i = self.config(b"ui", b"interface")
1547 if i in alldefaults:
1547 if i in alldefaults:
1548 defaultinterface = i
1548 defaultinterface = i
1549
1549
1550 choseninterface = defaultinterface
1550 choseninterface = defaultinterface
1551 f = self.config(b"ui", b"interface.%s" % feature)
1551 f = self.config(b"ui", b"interface.%s" % feature)
1552 if f in availableinterfaces:
1552 if f in availableinterfaces:
1553 choseninterface = f
1553 choseninterface = f
1554
1554
1555 if i is not None and defaultinterface != i:
1555 if i is not None and defaultinterface != i:
1556 if f is not None:
1556 if f is not None:
1557 self.warn(_(b"invalid value for ui.interface: %s\n") % (i,))
1557 self.warn(_(b"invalid value for ui.interface: %s\n") % (i,))
1558 else:
1558 else:
1559 self.warn(
1559 self.warn(
1560 _(b"invalid value for ui.interface: %s (using %s)\n")
1560 _(b"invalid value for ui.interface: %s (using %s)\n")
1561 % (i, choseninterface)
1561 % (i, choseninterface)
1562 )
1562 )
1563 if f is not None and choseninterface != f:
1563 if f is not None and choseninterface != f:
1564 self.warn(
1564 self.warn(
1565 _(b"invalid value for ui.interface.%s: %s (using %s)\n")
1565 _(b"invalid value for ui.interface.%s: %s (using %s)\n")
1566 % (feature, f, choseninterface)
1566 % (feature, f, choseninterface)
1567 )
1567 )
1568
1568
1569 return choseninterface
1569 return choseninterface
1570
1570
1571 def interactive(self):
1571 def interactive(self):
1572 """is interactive input allowed?
1572 """is interactive input allowed?
1573
1573
1574 An interactive session is a session where input can be reasonably read
1574 An interactive session is a session where input can be reasonably read
1575 from `sys.stdin'. If this function returns false, any attempt to read
1575 from `sys.stdin'. If this function returns false, any attempt to read
1576 from stdin should fail with an error, unless a sensible default has been
1576 from stdin should fail with an error, unless a sensible default has been
1577 specified.
1577 specified.
1578
1578
1579 Interactiveness is triggered by the value of the `ui.interactive'
1579 Interactiveness is triggered by the value of the `ui.interactive'
1580 configuration variable or - if it is unset - when `sys.stdin' points
1580 configuration variable or - if it is unset - when `sys.stdin' points
1581 to a terminal device.
1581 to a terminal device.
1582
1582
1583 This function refers to input only; for output, see `ui.formatted()'.
1583 This function refers to input only; for output, see `ui.formatted()'.
1584 """
1584 """
1585 i = self.configbool(b"ui", b"interactive")
1585 i = self.configbool(b"ui", b"interactive")
1586 if i is None:
1586 if i is None:
1587 # some environments replace stdin without implementing isatty
1587 # some environments replace stdin without implementing isatty
1588 # usually those are non-interactive
1588 # usually those are non-interactive
1589 return self._isatty(self._fin)
1589 return self._isatty(self._fin)
1590
1590
1591 return i
1591 return i
1592
1592
1593 def termwidth(self):
1593 def termwidth(self):
1594 """how wide is the terminal in columns?"""
1594 """how wide is the terminal in columns?"""
1595 if b'COLUMNS' in encoding.environ:
1595 if b'COLUMNS' in encoding.environ:
1596 try:
1596 try:
1597 return int(encoding.environ[b'COLUMNS'])
1597 return int(encoding.environ[b'COLUMNS'])
1598 except ValueError:
1598 except ValueError:
1599 pass
1599 pass
1600 return scmutil.termsize(self)[0]
1600 return scmutil.termsize(self)[0]
1601
1601
1602 def formatted(self):
1602 def formatted(self):
1603 """should formatted output be used?
1603 """should formatted output be used?
1604
1604
1605 It is often desirable to format the output to suite the output medium.
1605 It is often desirable to format the output to suite the output medium.
1606 Examples of this are truncating long lines or colorizing messages.
1606 Examples of this are truncating long lines or colorizing messages.
1607 However, this is not often not desirable when piping output into other
1607 However, this is not often not desirable when piping output into other
1608 utilities, e.g. `grep'.
1608 utilities, e.g. `grep'.
1609
1609
1610 Formatted output is triggered by the value of the `ui.formatted'
1610 Formatted output is triggered by the value of the `ui.formatted'
1611 configuration variable or - if it is unset - when `sys.stdout' points
1611 configuration variable or - if it is unset - when `sys.stdout' points
1612 to a terminal device. Please note that `ui.formatted' should be
1612 to a terminal device. Please note that `ui.formatted' should be
1613 considered an implementation detail; it is not intended for use outside
1613 considered an implementation detail; it is not intended for use outside
1614 Mercurial or its extensions.
1614 Mercurial or its extensions.
1615
1615
1616 This function refers to output only; for input, see `ui.interactive()'.
1616 This function refers to output only; for input, see `ui.interactive()'.
1617 This function always returns false when in plain mode, see `ui.plain()'.
1617 This function always returns false when in plain mode, see `ui.plain()'.
1618 """
1618 """
1619 if self.plain():
1619 if self.plain():
1620 return False
1620 return False
1621
1621
1622 i = self.configbool(b"ui", b"formatted")
1622 i = self.configbool(b"ui", b"formatted")
1623 if i is None:
1623 if i is None:
1624 # some environments replace stdout without implementing isatty
1624 # some environments replace stdout without implementing isatty
1625 # usually those are non-interactive
1625 # usually those are non-interactive
1626 return self._isatty(self._fout)
1626 return self._isatty(self._fout)
1627
1627
1628 return i
1628 return i
1629
1629
1630 def _readline(self, prompt=b' ', promptopts=None):
1630 def _readline(self, prompt=b' ', promptopts=None):
1631 # Replacing stdin/stdout temporarily is a hard problem on Python 3
1631 # Replacing stdin/stdout temporarily is a hard problem on Python 3
1632 # because they have to be text streams with *no buffering*. Instead,
1632 # because they have to be text streams with *no buffering*. Instead,
1633 # we use rawinput() only if call_readline() will be invoked by
1633 # we use rawinput() only if call_readline() will be invoked by
1634 # PyOS_Readline(), so no I/O will be made at Python layer.
1634 # PyOS_Readline(), so no I/O will be made at Python layer.
1635 usereadline = (
1635 usereadline = (
1636 self._isatty(self._fin)
1636 self._isatty(self._fin)
1637 and self._isatty(self._fout)
1637 and self._isatty(self._fout)
1638 and procutil.isstdin(self._fin)
1638 and procutil.isstdin(self._fin)
1639 and procutil.isstdout(self._fout)
1639 and procutil.isstdout(self._fout)
1640 )
1640 )
1641 if usereadline:
1641 if usereadline:
1642 try:
1642 try:
1643 # magically add command line editing support, where
1643 # magically add command line editing support, where
1644 # available
1644 # available
1645 import readline
1645 import readline
1646
1646
1647 # force demandimport to really load the module
1647 # force demandimport to really load the module
1648 readline.read_history_file
1648 readline.read_history_file
1649 # windows sometimes raises something other than ImportError
1649 # windows sometimes raises something other than ImportError
1650 except Exception:
1650 except Exception:
1651 usereadline = False
1651 usereadline = False
1652
1652
1653 if self._colormode == b'win32' or not usereadline:
1653 if self._colormode == b'win32' or not usereadline:
1654 if not promptopts:
1654 if not promptopts:
1655 promptopts = {}
1655 promptopts = {}
1656 self._writemsgnobuf(
1656 self._writemsgnobuf(
1657 self._fmsgout, prompt, type=b'prompt', **promptopts
1657 self._fmsgout, prompt, type=b'prompt', **promptopts
1658 )
1658 )
1659 self.flush()
1659 self.flush()
1660 prompt = b' '
1660 prompt = b' '
1661 else:
1661 else:
1662 prompt = self.label(prompt, b'ui.prompt') + b' '
1662 prompt = self.label(prompt, b'ui.prompt') + b' '
1663
1663
1664 # prompt ' ' must exist; otherwise readline may delete entire line
1664 # prompt ' ' must exist; otherwise readline may delete entire line
1665 # - http://bugs.python.org/issue12833
1665 # - http://bugs.python.org/issue12833
1666 with self.timeblockedsection(b'stdio'):
1666 with self.timeblockedsection(b'stdio'):
1667 if usereadline:
1667 if usereadline:
1668 self.flush()
1668 self.flush()
1669 prompt = encoding.strfromlocal(prompt)
1669 prompt = encoding.strfromlocal(prompt)
1670 line = encoding.strtolocal(pycompat.rawinput(prompt))
1670 line = encoding.strtolocal(pycompat.rawinput(prompt))
1671 # When stdin is in binary mode on Windows, it can cause
1671 # When stdin is in binary mode on Windows, it can cause
1672 # raw_input() to emit an extra trailing carriage return
1672 # raw_input() to emit an extra trailing carriage return
1673 if pycompat.oslinesep == b'\r\n' and line.endswith(b'\r'):
1673 if pycompat.oslinesep == b'\r\n' and line.endswith(b'\r'):
1674 line = line[:-1]
1674 line = line[:-1]
1675 else:
1675 else:
1676 self._fout.write(pycompat.bytestr(prompt))
1676 self._fout.write(pycompat.bytestr(prompt))
1677 self._fout.flush()
1677 self._fout.flush()
1678 line = self._fin.readline()
1678 line = self._fin.readline()
1679 if not line:
1679 if not line:
1680 raise EOFError
1680 raise EOFError
1681 line = line.rstrip(pycompat.oslinesep)
1681 line = line.rstrip(pycompat.oslinesep)
1682
1682
1683 return line
1683 return line
1684
1684
1685 def prompt(self, msg, default=b"y"):
1685 def prompt(self, msg, default=b"y"):
1686 """Prompt user with msg, read response.
1686 """Prompt user with msg, read response.
1687 If ui is not interactive, the default is returned.
1687 If ui is not interactive, the default is returned.
1688 """
1688 """
1689 return self._prompt(msg, default=default)
1689 return self._prompt(msg, default=default)
1690
1690
1691 def _prompt(self, msg, **opts):
1691 def _prompt(self, msg, **opts):
1692 default = opts['default']
1692 default = opts['default']
1693 if not self.interactive():
1693 if not self.interactive():
1694 self._writemsg(self._fmsgout, msg, b' ', type=b'prompt', **opts)
1694 self._writemsg(self._fmsgout, msg, b' ', type=b'prompt', **opts)
1695 self._writemsg(
1695 self._writemsg(
1696 self._fmsgout, default or b'', b"\n", type=b'promptecho'
1696 self._fmsgout, default or b'', b"\n", type=b'promptecho'
1697 )
1697 )
1698 return default
1698 return default
1699 try:
1699 try:
1700 r = self._readline(prompt=msg, promptopts=opts)
1700 r = self._readline(prompt=msg, promptopts=opts)
1701 if not r:
1701 if not r:
1702 r = default
1702 r = default
1703 if self.configbool(b'ui', b'promptecho'):
1703 if self.configbool(b'ui', b'promptecho'):
1704 self._writemsg(
1704 self._writemsg(
1705 self._fmsgout, r or b'', b"\n", type=b'promptecho'
1705 self._fmsgout, r or b'', b"\n", type=b'promptecho'
1706 )
1706 )
1707 return r
1707 return r
1708 except EOFError:
1708 except EOFError:
1709 raise error.ResponseExpected()
1709 raise error.ResponseExpected()
1710
1710
1711 @staticmethod
1711 @staticmethod
1712 def extractchoices(prompt):
1712 def extractchoices(prompt):
1713 """Extract prompt message and list of choices from specified prompt.
1713 """Extract prompt message and list of choices from specified prompt.
1714
1714
1715 This returns tuple "(message, choices)", and "choices" is the
1715 This returns tuple "(message, choices)", and "choices" is the
1716 list of tuple "(response character, text without &)".
1716 list of tuple "(response character, text without &)".
1717
1717
1718 >>> ui.extractchoices(b"awake? $$ &Yes $$ &No")
1718 >>> ui.extractchoices(b"awake? $$ &Yes $$ &No")
1719 ('awake? ', [('y', 'Yes'), ('n', 'No')])
1719 ('awake? ', [('y', 'Yes'), ('n', 'No')])
1720 >>> ui.extractchoices(b"line\\nbreak? $$ &Yes $$ &No")
1720 >>> ui.extractchoices(b"line\\nbreak? $$ &Yes $$ &No")
1721 ('line\\nbreak? ', [('y', 'Yes'), ('n', 'No')])
1721 ('line\\nbreak? ', [('y', 'Yes'), ('n', 'No')])
1722 >>> ui.extractchoices(b"want lots of $$money$$?$$Ye&s$$N&o")
1722 >>> ui.extractchoices(b"want lots of $$money$$?$$Ye&s$$N&o")
1723 ('want lots of $$money$$?', [('s', 'Yes'), ('o', 'No')])
1723 ('want lots of $$money$$?', [('s', 'Yes'), ('o', 'No')])
1724 """
1724 """
1725
1725
1726 # Sadly, the prompt string may have been built with a filename
1726 # Sadly, the prompt string may have been built with a filename
1727 # containing "$$" so let's try to find the first valid-looking
1727 # containing "$$" so let's try to find the first valid-looking
1728 # prompt to start parsing. Sadly, we also can't rely on
1728 # prompt to start parsing. Sadly, we also can't rely on
1729 # choices containing spaces, ASCII, or basically anything
1729 # choices containing spaces, ASCII, or basically anything
1730 # except an ampersand followed by a character.
1730 # except an ampersand followed by a character.
1731 m = re.match(br'(?s)(.+?)\$\$([^$]*&[^ $].*)', prompt)
1731 m = re.match(br'(?s)(.+?)\$\$([^$]*&[^ $].*)', prompt)
1732 msg = m.group(1)
1732 msg = m.group(1)
1733 choices = [p.strip(b' ') for p in m.group(2).split(b'$$')]
1733 choices = [p.strip(b' ') for p in m.group(2).split(b'$$')]
1734
1734
1735 def choicetuple(s):
1735 def choicetuple(s):
1736 ampidx = s.index(b'&')
1736 ampidx = s.index(b'&')
1737 return s[ampidx + 1 : ampidx + 2].lower(), s.replace(b'&', b'', 1)
1737 return s[ampidx + 1 : ampidx + 2].lower(), s.replace(b'&', b'', 1)
1738
1738
1739 return (msg, [choicetuple(s) for s in choices])
1739 return (msg, [choicetuple(s) for s in choices])
1740
1740
1741 def promptchoice(self, prompt, default=0):
1741 def promptchoice(self, prompt, default=0):
1742 """Prompt user with a message, read response, and ensure it matches
1742 """Prompt user with a message, read response, and ensure it matches
1743 one of the provided choices. The prompt is formatted as follows:
1743 one of the provided choices. The prompt is formatted as follows:
1744
1744
1745 "would you like fries with that (Yn)? $$ &Yes $$ &No"
1745 "would you like fries with that (Yn)? $$ &Yes $$ &No"
1746
1746
1747 The index of the choice is returned. Responses are case
1747 The index of the choice is returned. Responses are case
1748 insensitive. If ui is not interactive, the default is
1748 insensitive. If ui is not interactive, the default is
1749 returned.
1749 returned.
1750 """
1750 """
1751
1751
1752 msg, choices = self.extractchoices(prompt)
1752 msg, choices = self.extractchoices(prompt)
1753 resps = [r for r, t in choices]
1753 resps = [r for r, t in choices]
1754 while True:
1754 while True:
1755 r = self._prompt(msg, default=resps[default], choices=choices)
1755 r = self._prompt(msg, default=resps[default], choices=choices)
1756 if r.lower() in resps:
1756 if r.lower() in resps:
1757 return resps.index(r.lower())
1757 return resps.index(r.lower())
1758 # TODO: shouldn't it be a warning?
1758 # TODO: shouldn't it be a warning?
1759 self._writemsg(self._fmsgout, _(b"unrecognized response\n"))
1759 self._writemsg(self._fmsgout, _(b"unrecognized response\n"))
1760
1760
1761 def getpass(self, prompt=None, default=None):
1761 def getpass(self, prompt=None, default=None):
1762 if not self.interactive():
1762 if not self.interactive():
1763 return default
1763 return default
1764 try:
1764 try:
1765 self._writemsg(
1765 self._writemsg(
1766 self._fmsgerr,
1766 self._fmsgerr,
1767 prompt or _(b'password: '),
1767 prompt or _(b'password: '),
1768 type=b'prompt',
1768 type=b'prompt',
1769 password=True,
1769 password=True,
1770 )
1770 )
1771 # disable getpass() only if explicitly specified. it's still valid
1771 # disable getpass() only if explicitly specified. it's still valid
1772 # to interact with tty even if fin is not a tty.
1772 # to interact with tty even if fin is not a tty.
1773 with self.timeblockedsection(b'stdio'):
1773 with self.timeblockedsection(b'stdio'):
1774 if self.configbool(b'ui', b'nontty'):
1774 if self.configbool(b'ui', b'nontty'):
1775 l = self._fin.readline()
1775 l = self._fin.readline()
1776 if not l:
1776 if not l:
1777 raise EOFError
1777 raise EOFError
1778 return l.rstrip(b'\n')
1778 return l.rstrip(b'\n')
1779 else:
1779 else:
1780 return encoding.strtolocal(getpass.getpass(''))
1780 return encoding.strtolocal(getpass.getpass(''))
1781 except EOFError:
1781 except EOFError:
1782 raise error.ResponseExpected()
1782 raise error.ResponseExpected()
1783
1783
1784 def status(self, *msg, **opts):
1784 def status(self, *msg, **opts):
1785 """write status message to output (if ui.quiet is False)
1785 """write status message to output (if ui.quiet is False)
1786
1786
1787 This adds an output label of "ui.status".
1787 This adds an output label of "ui.status".
1788 """
1788 """
1789 if not self.quiet:
1789 if not self.quiet:
1790 self._writemsg(self._fmsgout, type=b'status', *msg, **opts)
1790 self._writemsg(self._fmsgout, type=b'status', *msg, **opts)
1791
1791
1792 def warn(self, *msg, **opts):
1792 def warn(self, *msg, **opts):
1793 """write warning message to output (stderr)
1793 """write warning message to output (stderr)
1794
1794
1795 This adds an output label of "ui.warning".
1795 This adds an output label of "ui.warning".
1796 """
1796 """
1797 self._writemsg(self._fmsgerr, type=b'warning', *msg, **opts)
1797 self._writemsg(self._fmsgerr, type=b'warning', *msg, **opts)
1798
1798
1799 def error(self, *msg, **opts):
1799 def error(self, *msg, **opts):
1800 """write error message to output (stderr)
1800 """write error message to output (stderr)
1801
1801
1802 This adds an output label of "ui.error".
1802 This adds an output label of "ui.error".
1803 """
1803 """
1804 self._writemsg(self._fmsgerr, type=b'error', *msg, **opts)
1804 self._writemsg(self._fmsgerr, type=b'error', *msg, **opts)
1805
1805
1806 def note(self, *msg, **opts):
1806 def note(self, *msg, **opts):
1807 """write note to output (if ui.verbose is True)
1807 """write note to output (if ui.verbose is True)
1808
1808
1809 This adds an output label of "ui.note".
1809 This adds an output label of "ui.note".
1810 """
1810 """
1811 if self.verbose:
1811 if self.verbose:
1812 self._writemsg(self._fmsgout, type=b'note', *msg, **opts)
1812 self._writemsg(self._fmsgout, type=b'note', *msg, **opts)
1813
1813
1814 def debug(self, *msg, **opts):
1814 def debug(self, *msg, **opts):
1815 """write debug message to output (if ui.debugflag is True)
1815 """write debug message to output (if ui.debugflag is True)
1816
1816
1817 This adds an output label of "ui.debug".
1817 This adds an output label of "ui.debug".
1818 """
1818 """
1819 if self.debugflag:
1819 if self.debugflag:
1820 self._writemsg(self._fmsgout, type=b'debug', *msg, **opts)
1820 self._writemsg(self._fmsgout, type=b'debug', *msg, **opts)
1821 self.log(b'debug', b'%s', b''.join(msg))
1821 self.log(b'debug', b'%s', b''.join(msg))
1822
1822
1823 # Aliases to defeat check-code.
1823 # Aliases to defeat check-code.
1824 statusnoi18n = status
1824 statusnoi18n = status
1825 notenoi18n = note
1825 notenoi18n = note
1826 warnnoi18n = warn
1826 warnnoi18n = warn
1827 writenoi18n = write
1827 writenoi18n = write
1828
1828
1829 def edit(
1829 def edit(
1830 self,
1830 self,
1831 text,
1831 text,
1832 user,
1832 user,
1833 extra=None,
1833 extra=None,
1834 editform=None,
1834 editform=None,
1835 pending=None,
1835 pending=None,
1836 repopath=None,
1836 repopath=None,
1837 action=None,
1837 action=None,
1838 ):
1838 ):
1839 if action is None:
1839 if action is None:
1840 self.develwarn(
1840 self.develwarn(
1841 b'action is None but will soon be a required '
1841 b'action is None but will soon be a required '
1842 b'parameter to ui.edit()'
1842 b'parameter to ui.edit()'
1843 )
1843 )
1844 extra_defaults = {
1844 extra_defaults = {
1845 b'prefix': b'editor',
1845 b'prefix': b'editor',
1846 b'suffix': b'.txt',
1846 b'suffix': b'.txt',
1847 }
1847 }
1848 if extra is not None:
1848 if extra is not None:
1849 if extra.get(b'suffix') is not None:
1849 if extra.get(b'suffix') is not None:
1850 self.develwarn(
1850 self.develwarn(
1851 b'extra.suffix is not None but will soon be '
1851 b'extra.suffix is not None but will soon be '
1852 b'ignored by ui.edit()'
1852 b'ignored by ui.edit()'
1853 )
1853 )
1854 extra_defaults.update(extra)
1854 extra_defaults.update(extra)
1855 extra = extra_defaults
1855 extra = extra_defaults
1856
1856
1857 if action == b'diff':
1857 if action == b'diff':
1858 suffix = b'.diff'
1858 suffix = b'.diff'
1859 elif action:
1859 elif action:
1860 suffix = b'.%s.hg.txt' % action
1860 suffix = b'.%s.hg.txt' % action
1861 else:
1861 else:
1862 suffix = extra[b'suffix']
1862 suffix = extra[b'suffix']
1863
1863
1864 rdir = None
1864 rdir = None
1865 if self.configbool(b'experimental', b'editortmpinhg'):
1865 if self.configbool(b'experimental', b'editortmpinhg'):
1866 rdir = repopath
1866 rdir = repopath
1867 (fd, name) = pycompat.mkstemp(
1867 (fd, name) = pycompat.mkstemp(
1868 prefix=b'hg-' + extra[b'prefix'] + b'-', suffix=suffix, dir=rdir
1868 prefix=b'hg-' + extra[b'prefix'] + b'-', suffix=suffix, dir=rdir
1869 )
1869 )
1870 try:
1870 try:
1871 with os.fdopen(fd, 'wb') as f:
1871 with os.fdopen(fd, 'wb') as f:
1872 f.write(util.tonativeeol(text))
1872 f.write(util.tonativeeol(text))
1873
1873
1874 environ = {b'HGUSER': user}
1874 environ = {b'HGUSER': user}
1875 if b'transplant_source' in extra:
1875 if b'transplant_source' in extra:
1876 environ.update(
1876 environ.update(
1877 {b'HGREVISION': hex(extra[b'transplant_source'])}
1877 {b'HGREVISION': hex(extra[b'transplant_source'])}
1878 )
1878 )
1879 for label in (b'intermediate-source', b'source', b'rebase_source'):
1879 for label in (b'intermediate-source', b'source', b'rebase_source'):
1880 if label in extra:
1880 if label in extra:
1881 environ.update({b'HGREVISION': extra[label]})
1881 environ.update({b'HGREVISION': extra[label]})
1882 break
1882 break
1883 if editform:
1883 if editform:
1884 environ.update({b'HGEDITFORM': editform})
1884 environ.update({b'HGEDITFORM': editform})
1885 if pending:
1885 if pending:
1886 environ.update({b'HG_PENDING': pending})
1886 environ.update({b'HG_PENDING': pending})
1887
1887
1888 editor = self.geteditor()
1888 editor = self.geteditor()
1889
1889
1890 self.system(
1890 self.system(
1891 b"%s \"%s\"" % (editor, name),
1891 b"%s \"%s\"" % (editor, name),
1892 environ=environ,
1892 environ=environ,
1893 onerr=error.CanceledError,
1893 onerr=error.CanceledError,
1894 errprefix=_(b"edit failed"),
1894 errprefix=_(b"edit failed"),
1895 blockedtag=b'editor',
1895 blockedtag=b'editor',
1896 )
1896 )
1897
1897
1898 with open(name, 'rb') as f:
1898 with open(name, 'rb') as f:
1899 t = util.fromnativeeol(f.read())
1899 t = util.fromnativeeol(f.read())
1900 finally:
1900 finally:
1901 os.unlink(name)
1901 os.unlink(name)
1902
1902
1903 return t
1903 return t
1904
1904
1905 def system(
1905 def system(
1906 self,
1906 self,
1907 cmd,
1907 cmd,
1908 environ=None,
1908 environ=None,
1909 cwd=None,
1909 cwd=None,
1910 onerr=None,
1910 onerr=None,
1911 errprefix=None,
1911 errprefix=None,
1912 blockedtag=None,
1912 blockedtag=None,
1913 ):
1913 ):
1914 """execute shell command with appropriate output stream. command
1914 """execute shell command with appropriate output stream. command
1915 output will be redirected if fout is not stdout.
1915 output will be redirected if fout is not stdout.
1916
1916
1917 if command fails and onerr is None, return status, else raise onerr
1917 if command fails and onerr is None, return status, else raise onerr
1918 object as exception.
1918 object as exception.
1919 """
1919 """
1920 if blockedtag is None:
1920 if blockedtag is None:
1921 # Long cmds tend to be because of an absolute path on cmd. Keep
1921 # Long cmds tend to be because of an absolute path on cmd. Keep
1922 # the tail end instead
1922 # the tail end instead
1923 cmdsuffix = cmd.translate(None, _keepalnum)[-85:]
1923 cmdsuffix = cmd.translate(None, _keepalnum)[-85:]
1924 blockedtag = b'unknown_system_' + cmdsuffix
1924 blockedtag = b'unknown_system_' + cmdsuffix
1925 out = self._fout
1925 out = self._fout
1926 if any(s[1] for s in self._bufferstates):
1926 if any(s[1] for s in self._bufferstates):
1927 out = self
1927 out = self
1928 with self.timeblockedsection(blockedtag):
1928 with self.timeblockedsection(blockedtag):
1929 rc = self._runsystem(cmd, environ=environ, cwd=cwd, out=out)
1929 rc = self._runsystem(cmd, environ=environ, cwd=cwd, out=out)
1930 if rc and onerr:
1930 if rc and onerr:
1931 errmsg = b'%s %s' % (
1931 errmsg = b'%s %s' % (
1932 procutil.shellsplit(cmd)[0],
1932 procutil.shellsplit(cmd)[0],
1933 procutil.explainexit(rc),
1933 procutil.explainexit(rc),
1934 )
1934 )
1935 if errprefix:
1935 if errprefix:
1936 errmsg = b'%s: %s' % (errprefix, errmsg)
1936 errmsg = b'%s: %s' % (errprefix, errmsg)
1937 raise onerr(errmsg)
1937 raise onerr(errmsg)
1938 return rc
1938 return rc
1939
1939
1940 def _runsystem(self, cmd, environ, cwd, out):
1940 def _runsystem(self, cmd, environ, cwd, out):
1941 """actually execute the given shell command (can be overridden by
1941 """actually execute the given shell command (can be overridden by
1942 extensions like chg)"""
1942 extensions like chg)"""
1943 return procutil.system(cmd, environ=environ, cwd=cwd, out=out)
1943 return procutil.system(cmd, environ=environ, cwd=cwd, out=out)
1944
1944
1945 def traceback(self, exc=None, force=False):
1945 def traceback(self, exc=None, force=False):
1946 """print exception traceback if traceback printing enabled or forced.
1946 """print exception traceback if traceback printing enabled or forced.
1947 only to call in exception handler. returns true if traceback
1947 only to call in exception handler. returns true if traceback
1948 printed."""
1948 printed."""
1949 if self.tracebackflag or force:
1949 if self.tracebackflag or force:
1950 if exc is None:
1950 if exc is None:
1951 exc = sys.exc_info()
1951 exc = sys.exc_info()
1952 cause = getattr(exc[1], 'cause', None)
1952 cause = getattr(exc[1], 'cause', None)
1953
1953
1954 if cause is not None:
1954 if cause is not None:
1955 causetb = traceback.format_tb(cause[2])
1955 causetb = traceback.format_tb(cause[2])
1956 exctb = traceback.format_tb(exc[2])
1956 exctb = traceback.format_tb(exc[2])
1957 exconly = traceback.format_exception_only(cause[0], cause[1])
1957 exconly = traceback.format_exception_only(cause[0], cause[1])
1958
1958
1959 # exclude frame where 'exc' was chained and rethrown from exctb
1959 # exclude frame where 'exc' was chained and rethrown from exctb
1960 self.write_err(
1960 self.write_err(
1961 b'Traceback (most recent call last):\n',
1961 b'Traceback (most recent call last):\n',
1962 encoding.strtolocal(''.join(exctb[:-1])),
1962 encoding.strtolocal(''.join(exctb[:-1])),
1963 encoding.strtolocal(''.join(causetb)),
1963 encoding.strtolocal(''.join(causetb)),
1964 encoding.strtolocal(''.join(exconly)),
1964 encoding.strtolocal(''.join(exconly)),
1965 )
1965 )
1966 else:
1966 else:
1967 output = traceback.format_exception(exc[0], exc[1], exc[2])
1967 output = traceback.format_exception(exc[0], exc[1], exc[2])
1968 self.write_err(encoding.strtolocal(''.join(output)))
1968 self.write_err(encoding.strtolocal(''.join(output)))
1969 return self.tracebackflag or force
1969 return self.tracebackflag or force
1970
1970
1971 def geteditor(self):
1971 def geteditor(self):
1972 '''return editor to use'''
1972 '''return editor to use'''
1973 if pycompat.sysplatform == b'plan9':
1973 if pycompat.sysplatform == b'plan9':
1974 # vi is the MIPS instruction simulator on Plan 9. We
1974 # vi is the MIPS instruction simulator on Plan 9. We
1975 # instead default to E to plumb commit messages to
1975 # instead default to E to plumb commit messages to
1976 # avoid confusion.
1976 # avoid confusion.
1977 editor = b'E'
1977 editor = b'E'
1978 elif pycompat.isdarwin:
1978 elif pycompat.isdarwin:
1979 # vi on darwin is POSIX compatible to a fault, and that includes
1979 # vi on darwin is POSIX compatible to a fault, and that includes
1980 # exiting non-zero if you make any mistake when running an ex
1980 # exiting non-zero if you make any mistake when running an ex
1981 # command. Proof: `vi -c ':unknown' -c ':qa'; echo $?` produces 1,
1981 # command. Proof: `vi -c ':unknown' -c ':qa'; echo $?` produces 1,
1982 # while s/vi/vim/ doesn't.
1982 # while s/vi/vim/ doesn't.
1983 editor = b'vim'
1983 editor = b'vim'
1984 else:
1984 else:
1985 editor = b'vi'
1985 editor = b'vi'
1986 return encoding.environ.get(b"HGEDITOR") or self.config(
1986 return encoding.environ.get(b"HGEDITOR") or self.config(
1987 b"ui", b"editor", editor
1987 b"ui", b"editor", editor
1988 )
1988 )
1989
1989
1990 @util.propertycache
1990 @util.propertycache
1991 def _progbar(self):
1991 def _progbar(self):
1992 """setup the progbar singleton to the ui object"""
1992 """setup the progbar singleton to the ui object"""
1993 if (
1993 if (
1994 self.quiet
1994 self.quiet
1995 or self.debugflag
1995 or self.debugflag
1996 or self.configbool(b'progress', b'disable')
1996 or self.configbool(b'progress', b'disable')
1997 or not progress.shouldprint(self)
1997 or not progress.shouldprint(self)
1998 ):
1998 ):
1999 return None
1999 return None
2000 return getprogbar(self)
2000 return getprogbar(self)
2001
2001
2002 def _progclear(self):
2002 def _progclear(self):
2003 """clear progress bar output if any. use it before any output"""
2003 """clear progress bar output if any. use it before any output"""
2004 if not haveprogbar(): # nothing loaded yet
2004 if not haveprogbar(): # nothing loaded yet
2005 return
2005 return
2006 if self._progbar is not None and self._progbar.printed:
2006 if self._progbar is not None and self._progbar.printed:
2007 self._progbar.clear()
2007 self._progbar.clear()
2008
2008
2009 def makeprogress(self, topic, unit=b"", total=None):
2009 def makeprogress(self, topic, unit=b"", total=None):
2010 """Create a progress helper for the specified topic"""
2010 """Create a progress helper for the specified topic"""
2011 if getattr(self._fmsgerr, 'structured', False):
2011 if getattr(self._fmsgerr, 'structured', False):
2012 # channel for machine-readable output with metadata, just send
2012 # channel for machine-readable output with metadata, just send
2013 # raw information
2013 # raw information
2014 # TODO: consider porting some useful information (e.g. estimated
2014 # TODO: consider porting some useful information (e.g. estimated
2015 # time) from progbar. we might want to support update delay to
2015 # time) from progbar. we might want to support update delay to
2016 # reduce the cost of transferring progress messages.
2016 # reduce the cost of transferring progress messages.
2017 def updatebar(topic, pos, item, unit, total):
2017 def updatebar(topic, pos, item, unit, total):
2018 self._fmsgerr.write(
2018 self._fmsgerr.write(
2019 None,
2019 None,
2020 type=b'progress',
2020 type=b'progress',
2021 topic=topic,
2021 topic=topic,
2022 pos=pos,
2022 pos=pos,
2023 item=item,
2023 item=item,
2024 unit=unit,
2024 unit=unit,
2025 total=total,
2025 total=total,
2026 )
2026 )
2027
2027
2028 elif self._progbar is not None:
2028 elif self._progbar is not None:
2029 updatebar = self._progbar.progress
2029 updatebar = self._progbar.progress
2030 else:
2030 else:
2031
2031
2032 def updatebar(topic, pos, item, unit, total):
2032 def updatebar(topic, pos, item, unit, total):
2033 pass
2033 pass
2034
2034
2035 return scmutil.progress(self, updatebar, topic, unit, total)
2035 return scmutil.progress(self, updatebar, topic, unit, total)
2036
2036
2037 def getlogger(self, name):
2037 def getlogger(self, name):
2038 """Returns a logger of the given name; or None if not registered"""
2038 """Returns a logger of the given name; or None if not registered"""
2039 return self._loggers.get(name)
2039 return self._loggers.get(name)
2040
2040
2041 def setlogger(self, name, logger):
2041 def setlogger(self, name, logger):
2042 """Install logger which can be identified later by the given name
2042 """Install logger which can be identified later by the given name
2043
2043
2044 More than one loggers can be registered. Use extension or module
2044 More than one loggers can be registered. Use extension or module
2045 name to uniquely identify the logger instance.
2045 name to uniquely identify the logger instance.
2046 """
2046 """
2047 self._loggers[name] = logger
2047 self._loggers[name] = logger
2048
2048
2049 def log(self, event, msgfmt, *msgargs, **opts):
2049 def log(self, event, msgfmt, *msgargs, **opts):
2050 """hook for logging facility extensions
2050 """hook for logging facility extensions
2051
2051
2052 event should be a readily-identifiable subsystem, which will
2052 event should be a readily-identifiable subsystem, which will
2053 allow filtering.
2053 allow filtering.
2054
2054
2055 msgfmt should be a newline-terminated format string to log, and
2055 msgfmt should be a newline-terminated format string to log, and
2056 *msgargs are %-formatted into it.
2056 *msgargs are %-formatted into it.
2057
2057
2058 **opts currently has no defined meanings.
2058 **opts currently has no defined meanings.
2059 """
2059 """
2060 if not self._loggers:
2060 if not self._loggers:
2061 return
2061 return
2062 activeloggers = [
2062 activeloggers = [
2063 l for l in pycompat.itervalues(self._loggers) if l.tracked(event)
2063 l for l in pycompat.itervalues(self._loggers) if l.tracked(event)
2064 ]
2064 ]
2065 if not activeloggers:
2065 if not activeloggers:
2066 return
2066 return
2067 msg = msgfmt % msgargs
2067 msg = msgfmt % msgargs
2068 opts = pycompat.byteskwargs(opts)
2068 opts = pycompat.byteskwargs(opts)
2069 # guard against recursion from e.g. ui.debug()
2069 # guard against recursion from e.g. ui.debug()
2070 registeredloggers = self._loggers
2070 registeredloggers = self._loggers
2071 self._loggers = {}
2071 self._loggers = {}
2072 try:
2072 try:
2073 for logger in activeloggers:
2073 for logger in activeloggers:
2074 logger.log(self, event, msg, opts)
2074 logger.log(self, event, msg, opts)
2075 finally:
2075 finally:
2076 self._loggers = registeredloggers
2076 self._loggers = registeredloggers
2077
2077
2078 def label(self, msg, label):
2078 def label(self, msg, label):
2079 """style msg based on supplied label
2079 """style msg based on supplied label
2080
2080
2081 If some color mode is enabled, this will add the necessary control
2081 If some color mode is enabled, this will add the necessary control
2082 characters to apply such color. In addition, 'debug' color mode adds
2082 characters to apply such color. In addition, 'debug' color mode adds
2083 markup showing which label affects a piece of text.
2083 markup showing which label affects a piece of text.
2084
2084
2085 ui.write(s, 'label') is equivalent to
2085 ui.write(s, 'label') is equivalent to
2086 ui.write(ui.label(s, 'label')).
2086 ui.write(ui.label(s, 'label')).
2087 """
2087 """
2088 if self._colormode is not None:
2088 if self._colormode is not None:
2089 return color.colorlabel(self, msg, label)
2089 return color.colorlabel(self, msg, label)
2090 return msg
2090 return msg
2091
2091
2092 def develwarn(self, msg, stacklevel=1, config=None):
2092 def develwarn(self, msg, stacklevel=1, config=None):
2093 """issue a developer warning message
2093 """issue a developer warning message
2094
2094
2095 Use 'stacklevel' to report the offender some layers further up in the
2095 Use 'stacklevel' to report the offender some layers further up in the
2096 stack.
2096 stack.
2097 """
2097 """
2098 if not self.configbool(b'devel', b'all-warnings'):
2098 if not self.configbool(b'devel', b'all-warnings'):
2099 if config is None or not self.configbool(b'devel', config):
2099 if config is None or not self.configbool(b'devel', config):
2100 return
2100 return
2101 msg = b'devel-warn: ' + msg
2101 msg = b'devel-warn: ' + msg
2102 stacklevel += 1 # get in develwarn
2102 stacklevel += 1 # get in develwarn
2103 if self.tracebackflag:
2103 if self.tracebackflag:
2104 util.debugstacktrace(msg, stacklevel, self._ferr, self._fout)
2104 util.debugstacktrace(msg, stacklevel, self._ferr, self._fout)
2105 self.log(
2105 self.log(
2106 b'develwarn',
2106 b'develwarn',
2107 b'%s at:\n%s'
2107 b'%s at:\n%s'
2108 % (msg, b''.join(util.getstackframes(stacklevel))),
2108 % (msg, b''.join(util.getstackframes(stacklevel))),
2109 )
2109 )
2110 else:
2110 else:
2111 curframe = inspect.currentframe()
2111 curframe = inspect.currentframe()
2112 calframe = inspect.getouterframes(curframe, 2)
2112 calframe = inspect.getouterframes(curframe, 2)
2113 fname, lineno, fmsg = calframe[stacklevel][1:4]
2113 fname, lineno, fmsg = calframe[stacklevel][1:4]
2114 fname, fmsg = pycompat.sysbytes(fname), pycompat.sysbytes(fmsg)
2114 fname, fmsg = pycompat.sysbytes(fname), pycompat.sysbytes(fmsg)
2115 self.write_err(b'%s at: %s:%d (%s)\n' % (msg, fname, lineno, fmsg))
2115 self.write_err(b'%s at: %s:%d (%s)\n' % (msg, fname, lineno, fmsg))
2116 self.log(
2116 self.log(
2117 b'develwarn', b'%s at: %s:%d (%s)\n', msg, fname, lineno, fmsg
2117 b'develwarn', b'%s at: %s:%d (%s)\n', msg, fname, lineno, fmsg
2118 )
2118 )
2119
2119
2120 # avoid cycles
2120 # avoid cycles
2121 del curframe
2121 del curframe
2122 del calframe
2122 del calframe
2123
2123
2124 def deprecwarn(self, msg, version, stacklevel=2):
2124 def deprecwarn(self, msg, version, stacklevel=2):
2125 """issue a deprecation warning
2125 """issue a deprecation warning
2126
2126
2127 - msg: message explaining what is deprecated and how to upgrade,
2127 - msg: message explaining what is deprecated and how to upgrade,
2128 - version: last version where the API will be supported,
2128 - version: last version where the API will be supported,
2129 """
2129 """
2130 if not (
2130 if not (
2131 self.configbool(b'devel', b'all-warnings')
2131 self.configbool(b'devel', b'all-warnings')
2132 or self.configbool(b'devel', b'deprec-warn')
2132 or self.configbool(b'devel', b'deprec-warn')
2133 ):
2133 ):
2134 return
2134 return
2135 msg += (
2135 msg += (
2136 b"\n(compatibility will be dropped after Mercurial-%s,"
2136 b"\n(compatibility will be dropped after Mercurial-%s,"
2137 b" update your code.)"
2137 b" update your code.)"
2138 ) % version
2138 ) % version
2139 self.develwarn(msg, stacklevel=stacklevel, config=b'deprec-warn')
2139 self.develwarn(msg, stacklevel=stacklevel, config=b'deprec-warn')
2140
2140
2141 def exportableenviron(self):
2141 def exportableenviron(self):
2142 """The environment variables that are safe to export, e.g. through
2142 """The environment variables that are safe to export, e.g. through
2143 hgweb.
2143 hgweb.
2144 """
2144 """
2145 return self._exportableenviron
2145 return self._exportableenviron
2146
2146
2147 @contextlib.contextmanager
2147 @contextlib.contextmanager
2148 def configoverride(self, overrides, source=b""):
2148 def configoverride(self, overrides, source=b""):
2149 """Context manager for temporary config overrides
2149 """Context manager for temporary config overrides
2150 `overrides` must be a dict of the following structure:
2150 `overrides` must be a dict of the following structure:
2151 {(section, name) : value}"""
2151 {(section, name) : value}"""
2152 backups = {}
2152 backups = {}
2153 try:
2153 try:
2154 for (section, name), value in overrides.items():
2154 for (section, name), value in overrides.items():
2155 backups[(section, name)] = self.backupconfig(section, name)
2155 backups[(section, name)] = self.backupconfig(section, name)
2156 self.setconfig(section, name, value, source)
2156 self.setconfig(section, name, value, source)
2157 yield
2157 yield
2158 finally:
2158 finally:
2159 for __, backup in backups.items():
2159 for __, backup in backups.items():
2160 self.restoreconfig(backup)
2160 self.restoreconfig(backup)
2161 # just restoring ui.quiet config to the previous value is not enough
2161 # just restoring ui.quiet config to the previous value is not enough
2162 # as it does not update ui.quiet class member
2162 # as it does not update ui.quiet class member
2163 if (b'ui', b'quiet') in overrides:
2163 if (b'ui', b'quiet') in overrides:
2164 self.fixconfig(section=b'ui')
2164 self.fixconfig(section=b'ui')
2165
2165
2166 def estimatememory(self):
2166 def estimatememory(self):
2167 """Provide an estimate for the available system memory in Bytes.
2167 """Provide an estimate for the available system memory in Bytes.
2168
2168
2169 This can be overriden via ui.available-memory. It returns None, if
2169 This can be overriden via ui.available-memory. It returns None, if
2170 no estimate can be computed.
2170 no estimate can be computed.
2171 """
2171 """
2172 value = self.config(b'ui', b'available-memory')
2172 value = self.config(b'ui', b'available-memory')
2173 if value is not None:
2173 if value is not None:
2174 try:
2174 try:
2175 return util.sizetoint(value)
2175 return util.sizetoint(value)
2176 except error.ParseError:
2176 except error.ParseError:
2177 raise error.ConfigError(
2177 raise error.ConfigError(
2178 _(b"ui.available-memory value is invalid ('%s')") % value
2178 _(b"ui.available-memory value is invalid ('%s')") % value
2179 )
2179 )
2180 return util._estimatememory()
2180 return util._estimatememory()
2181
2181
2182
2182
2183 class paths(dict):
2183 class paths(dict):
2184 """Represents a collection of paths and their configs.
2184 """Represents a collection of paths and their configs.
2185
2185
2186 Data is initially derived from ui instances and the config files they have
2186 Data is initially derived from ui instances and the config files they have
2187 loaded.
2187 loaded.
2188 """
2188 """
2189
2189
2190 def __init__(self, ui):
2190 def __init__(self, ui):
2191 dict.__init__(self)
2191 dict.__init__(self)
2192
2192
2193 for name, loc in ui.configitems(b'paths', ignoresub=True):
2193 for name, loc in ui.configitems(b'paths', ignoresub=True):
2194 # No location is the same as not existing.
2194 # No location is the same as not existing.
2195 if not loc:
2195 if not loc:
2196 continue
2196 continue
2197 loc, sub_opts = ui.configsuboptions(b'paths', name)
2197 loc, sub_opts = ui.configsuboptions(b'paths', name)
2198 self[name] = path(ui, name, rawloc=loc, suboptions=sub_opts)
2198 self[name] = path(ui, name, rawloc=loc, suboptions=sub_opts)
2199
2199
2200 for name, p in sorted(self.items()):
2200 for name, p in sorted(self.items()):
2201 p.chain_path(ui, self)
2201 p.chain_path(ui, self)
2202
2202
2203 def getpath(self, ui, name, default=None):
2203 def getpath(self, ui, name, default=None):
2204 """Return a ``path`` from a string, falling back to default.
2204 """Return a ``path`` from a string, falling back to default.
2205
2205
2206 ``name`` can be a named path or locations. Locations are filesystem
2206 ``name`` can be a named path or locations. Locations are filesystem
2207 paths or URIs.
2207 paths or URIs.
2208
2208
2209 Returns None if ``name`` is not a registered path, a URI, or a local
2209 Returns None if ``name`` is not a registered path, a URI, or a local
2210 path to a repo.
2210 path to a repo.
2211 """
2211 """
2212 # Only fall back to default if no path was requested.
2212 # Only fall back to default if no path was requested.
2213 if name is None:
2213 if name is None:
2214 if not default:
2214 if not default:
2215 default = ()
2215 default = ()
2216 elif not isinstance(default, (tuple, list)):
2216 elif not isinstance(default, (tuple, list)):
2217 default = (default,)
2217 default = (default,)
2218 for k in default:
2218 for k in default:
2219 try:
2219 try:
2220 return self[k]
2220 return self[k]
2221 except KeyError:
2221 except KeyError:
2222 continue
2222 continue
2223 return None
2223 return None
2224
2224
2225 # Most likely empty string.
2225 # Most likely empty string.
2226 # This may need to raise in the future.
2226 # This may need to raise in the future.
2227 if not name:
2227 if not name:
2228 return None
2228 return None
2229
2229
2230 try:
2230 try:
2231 return self[name]
2231 return self[name]
2232 except KeyError:
2232 except KeyError:
2233 # Try to resolve as a local path or URI.
2233 # Try to resolve as a local path or URI.
2234 try:
2234 try:
2235 # we pass the ui instance are warning might need to be issued
2235 # we pass the ui instance are warning might need to be issued
2236 return path(ui, None, rawloc=name)
2236 return path(ui, None, rawloc=name)
2237 except ValueError:
2237 except ValueError:
2238 raise error.RepoError(_(b'repository %s does not exist') % name)
2238 raise error.RepoError(_(b'repository %s does not exist') % name)
2239
2239
2240
2240
2241 _pathsuboptions = {}
2241 _pathsuboptions = {}
2242
2242
2243
2243
2244 def pathsuboption(option, attr):
2244 def pathsuboption(option, attr):
2245 """Decorator used to declare a path sub-option.
2245 """Decorator used to declare a path sub-option.
2246
2246
2247 Arguments are the sub-option name and the attribute it should set on
2247 Arguments are the sub-option name and the attribute it should set on
2248 ``path`` instances.
2248 ``path`` instances.
2249
2249
2250 The decorated function will receive as arguments a ``ui`` instance,
2250 The decorated function will receive as arguments a ``ui`` instance,
2251 ``path`` instance, and the string value of this option from the config.
2251 ``path`` instance, and the string value of this option from the config.
2252 The function should return the value that will be set on the ``path``
2252 The function should return the value that will be set on the ``path``
2253 instance.
2253 instance.
2254
2254
2255 This decorator can be used to perform additional verification of
2255 This decorator can be used to perform additional verification of
2256 sub-options and to change the type of sub-options.
2256 sub-options and to change the type of sub-options.
2257 """
2257 """
2258
2258
2259 def register(func):
2259 def register(func):
2260 _pathsuboptions[option] = (attr, func)
2260 _pathsuboptions[option] = (attr, func)
2261 return func
2261 return func
2262
2262
2263 return register
2263 return register
2264
2264
2265
2265
2266 @pathsuboption(b'pushurl', b'pushloc')
2266 @pathsuboption(b'pushurl', b'pushloc')
2267 def pushurlpathoption(ui, path, value):
2267 def pushurlpathoption(ui, path, value):
2268 u = util.url(value)
2268 u = util.url(value)
2269 # Actually require a URL.
2269 # Actually require a URL.
2270 if not u.scheme:
2270 if not u.scheme:
2271 ui.warn(_(b'(paths.%s:pushurl not a URL; ignoring)\n') % path.name)
2271 ui.warn(_(b'(paths.%s:pushurl not a URL; ignoring)\n') % path.name)
2272 return None
2272 return None
2273
2273
2274 # Don't support the #foo syntax in the push URL to declare branch to
2274 # Don't support the #foo syntax in the push URL to declare branch to
2275 # push.
2275 # push.
2276 if u.fragment:
2276 if u.fragment:
2277 ui.warn(
2277 ui.warn(
2278 _(
2278 _(
2279 b'("#fragment" in paths.%s:pushurl not supported; '
2279 b'("#fragment" in paths.%s:pushurl not supported; '
2280 b'ignoring)\n'
2280 b'ignoring)\n'
2281 )
2281 )
2282 % path.name
2282 % path.name
2283 )
2283 )
2284 u.fragment = None
2284 u.fragment = None
2285
2285
2286 return bytes(u)
2286 return bytes(u)
2287
2287
2288
2288
2289 @pathsuboption(b'pushrev', b'pushrev')
2289 @pathsuboption(b'pushrev', b'pushrev')
2290 def pushrevpathoption(ui, path, value):
2290 def pushrevpathoption(ui, path, value):
2291 return value
2291 return value
2292
2292
2293
2293
2294 class path(object):
2294 class path(object):
2295 """Represents an individual path and its configuration."""
2295 """Represents an individual path and its configuration."""
2296
2296
2297 def __init__(self, ui, name, rawloc=None, suboptions=None):
2297 def __init__(self, ui, name, rawloc=None, suboptions=None):
2298 """Construct a path from its config options.
2298 """Construct a path from its config options.
2299
2299
2300 ``ui`` is the ``ui`` instance the path is coming from.
2300 ``ui`` is the ``ui`` instance the path is coming from.
2301 ``name`` is the symbolic name of the path.
2301 ``name`` is the symbolic name of the path.
2302 ``rawloc`` is the raw location, as defined in the config.
2302 ``rawloc`` is the raw location, as defined in the config.
2303 ``pushloc`` is the raw locations pushes should be made to.
2303 ``pushloc`` is the raw locations pushes should be made to.
2304
2304
2305 If ``name`` is not defined, we require that the location be a) a local
2305 If ``name`` is not defined, we require that the location be a) a local
2306 filesystem path with a .hg directory or b) a URL. If not,
2306 filesystem path with a .hg directory or b) a URL. If not,
2307 ``ValueError`` is raised.
2307 ``ValueError`` is raised.
2308 """
2308 """
2309 if not rawloc:
2309 if not rawloc:
2310 raise ValueError(b'rawloc must be defined')
2310 raise ValueError(b'rawloc must be defined')
2311
2311
2312 # Locations may define branches via syntax <base>#<branch>.
2312 # Locations may define branches via syntax <base>#<branch>.
2313 u = util.url(rawloc)
2313 u = util.url(rawloc)
2314 branch = None
2314 branch = None
2315 if u.fragment:
2315 if u.fragment:
2316 branch = u.fragment
2316 branch = u.fragment
2317 u.fragment = None
2317 u.fragment = None
2318
2318
2319 self.url = u
2319 self.url = u
2320 # the url from the config/command line before dealing with `path://`
2320 # the url from the config/command line before dealing with `path://`
2321 self.raw_url = u.copy()
2321 self.raw_url = u.copy()
2322 self.branch = branch
2322 self.branch = branch
2323
2323
2324 self.name = name
2324 self.name = name
2325 self.rawloc = rawloc
2325 self.rawloc = rawloc
2326 self.loc = b'%s' % u
2326 self.loc = b'%s' % u
2327
2327
2328 self._validate_path()
2328 self._validate_path()
2329
2329
2330 _path, sub_opts = ui.configsuboptions(b'paths', b'*')
2330 _path, sub_opts = ui.configsuboptions(b'paths', b'*')
2331 self._own_sub_opts = {}
2331 self._own_sub_opts = {}
2332 if suboptions is not None:
2332 if suboptions is not None:
2333 self._own_sub_opts = suboptions.copy()
2333 self._own_sub_opts = suboptions.copy()
2334 sub_opts.update(suboptions)
2334 sub_opts.update(suboptions)
2335 self._all_sub_opts = sub_opts.copy()
2335 self._all_sub_opts = sub_opts.copy()
2336
2336
2337 self._apply_suboptions(ui, sub_opts)
2337 self._apply_suboptions(ui, sub_opts)
2338
2338
2339 def chain_path(self, ui, paths):
2339 def chain_path(self, ui, paths):
2340 if self.url.scheme == b'path':
2340 if self.url.scheme == b'path':
2341 assert self.url.path is None
2341 assert self.url.path is None
2342 subpath = paths[self.url.host]
2342 try:
2343 subpath = paths[self.url.host]
2344 except KeyError:
2345 m = _('cannot use `%s`, "%s" is not a known path')
2346 m %= (self.rawloc, self.url.host)
2347 raise error.Abort(m)
2343 if subpath.raw_url.scheme == b'path':
2348 if subpath.raw_url.scheme == b'path':
2344 m = _('cannot use `%s`, "%s" is also define as a `path://`')
2349 m = _('cannot use `%s`, "%s" is also define as a `path://`')
2345 m %= (self.rawloc, self.url.host)
2350 m %= (self.rawloc, self.url.host)
2346 raise error.Abort(m)
2351 raise error.Abort(m)
2347 self.url = subpath.url
2352 self.url = subpath.url
2348 self.rawloc = subpath.rawloc
2353 self.rawloc = subpath.rawloc
2349 self.loc = subpath.loc
2354 self.loc = subpath.loc
2350 if self.branch is None:
2355 if self.branch is None:
2351 self.branch = subpath.branch
2356 self.branch = subpath.branch
2352 else:
2357 else:
2353 base = self.rawloc.rsplit(b'#', 1)[0]
2358 base = self.rawloc.rsplit(b'#', 1)[0]
2354 self.rawloc = b'%s#%s' % (base, self.branch)
2359 self.rawloc = b'%s#%s' % (base, self.branch)
2355 suboptions = subpath._all_sub_opts.copy()
2360 suboptions = subpath._all_sub_opts.copy()
2356 suboptions.update(self._own_sub_opts)
2361 suboptions.update(self._own_sub_opts)
2357 self._apply_suboptions(ui, suboptions)
2362 self._apply_suboptions(ui, suboptions)
2358
2363
2359 def _validate_path(self):
2364 def _validate_path(self):
2360 # When given a raw location but not a symbolic name, validate the
2365 # When given a raw location but not a symbolic name, validate the
2361 # location is valid.
2366 # location is valid.
2362 if (
2367 if (
2363 not self.name
2368 not self.name
2364 and not self.url.scheme
2369 and not self.url.scheme
2365 and not self._isvalidlocalpath(self.loc)
2370 and not self._isvalidlocalpath(self.loc)
2366 ):
2371 ):
2367 raise ValueError(
2372 raise ValueError(
2368 b'location is not a URL or path to a local '
2373 b'location is not a URL or path to a local '
2369 b'repo: %s' % self.rawloc
2374 b'repo: %s' % self.rawloc
2370 )
2375 )
2371
2376
2372 def _apply_suboptions(self, ui, sub_options):
2377 def _apply_suboptions(self, ui, sub_options):
2373 # Now process the sub-options. If a sub-option is registered, its
2378 # Now process the sub-options. If a sub-option is registered, its
2374 # attribute will always be present. The value will be None if there
2379 # attribute will always be present. The value will be None if there
2375 # was no valid sub-option.
2380 # was no valid sub-option.
2376 for suboption, (attr, func) in pycompat.iteritems(_pathsuboptions):
2381 for suboption, (attr, func) in pycompat.iteritems(_pathsuboptions):
2377 if suboption not in sub_options:
2382 if suboption not in sub_options:
2378 setattr(self, attr, None)
2383 setattr(self, attr, None)
2379 continue
2384 continue
2380
2385
2381 value = func(ui, self, sub_options[suboption])
2386 value = func(ui, self, sub_options[suboption])
2382 setattr(self, attr, value)
2387 setattr(self, attr, value)
2383
2388
2384 def _isvalidlocalpath(self, path):
2389 def _isvalidlocalpath(self, path):
2385 """Returns True if the given path is a potentially valid repository.
2390 """Returns True if the given path is a potentially valid repository.
2386 This is its own function so that extensions can change the definition of
2391 This is its own function so that extensions can change the definition of
2387 'valid' in this case (like when pulling from a git repo into a hg
2392 'valid' in this case (like when pulling from a git repo into a hg
2388 one)."""
2393 one)."""
2389 try:
2394 try:
2390 return os.path.isdir(os.path.join(path, b'.hg'))
2395 return os.path.isdir(os.path.join(path, b'.hg'))
2391 # Python 2 may return TypeError. Python 3, ValueError.
2396 # Python 2 may return TypeError. Python 3, ValueError.
2392 except (TypeError, ValueError):
2397 except (TypeError, ValueError):
2393 return False
2398 return False
2394
2399
2395 @property
2400 @property
2396 def suboptions(self):
2401 def suboptions(self):
2397 """Return sub-options and their values for this path.
2402 """Return sub-options and their values for this path.
2398
2403
2399 This is intended to be used for presentation purposes.
2404 This is intended to be used for presentation purposes.
2400 """
2405 """
2401 d = {}
2406 d = {}
2402 for subopt, (attr, _func) in pycompat.iteritems(_pathsuboptions):
2407 for subopt, (attr, _func) in pycompat.iteritems(_pathsuboptions):
2403 value = getattr(self, attr)
2408 value = getattr(self, attr)
2404 if value is not None:
2409 if value is not None:
2405 d[subopt] = value
2410 d[subopt] = value
2406 return d
2411 return d
2407
2412
2408
2413
2409 # we instantiate one globally shared progress bar to avoid
2414 # we instantiate one globally shared progress bar to avoid
2410 # competing progress bars when multiple UI objects get created
2415 # competing progress bars when multiple UI objects get created
2411 _progresssingleton = None
2416 _progresssingleton = None
2412
2417
2413
2418
2414 def getprogbar(ui):
2419 def getprogbar(ui):
2415 global _progresssingleton
2420 global _progresssingleton
2416 if _progresssingleton is None:
2421 if _progresssingleton is None:
2417 # passing 'ui' object to the singleton is fishy,
2422 # passing 'ui' object to the singleton is fishy,
2418 # this is how the extension used to work but feel free to rework it.
2423 # this is how the extension used to work but feel free to rework it.
2419 _progresssingleton = progress.progbar(ui)
2424 _progresssingleton = progress.progbar(ui)
2420 return _progresssingleton
2425 return _progresssingleton
2421
2426
2422
2427
2423 def haveprogbar():
2428 def haveprogbar():
2424 return _progresssingleton is not None
2429 return _progresssingleton is not None
2425
2430
2426
2431
2427 def _selectmsgdests(ui):
2432 def _selectmsgdests(ui):
2428 name = ui.config(b'ui', b'message-output')
2433 name = ui.config(b'ui', b'message-output')
2429 if name == b'channel':
2434 if name == b'channel':
2430 if ui.fmsg:
2435 if ui.fmsg:
2431 return ui.fmsg, ui.fmsg
2436 return ui.fmsg, ui.fmsg
2432 else:
2437 else:
2433 # fall back to ferr if channel isn't ready so that status/error
2438 # fall back to ferr if channel isn't ready so that status/error
2434 # messages can be printed
2439 # messages can be printed
2435 return ui.ferr, ui.ferr
2440 return ui.ferr, ui.ferr
2436 if name == b'stdio':
2441 if name == b'stdio':
2437 return ui.fout, ui.ferr
2442 return ui.fout, ui.ferr
2438 if name == b'stderr':
2443 if name == b'stderr':
2439 return ui.ferr, ui.ferr
2444 return ui.ferr, ui.ferr
2440 raise error.Abort(b'invalid ui.message-output destination: %s' % name)
2445 raise error.Abort(b'invalid ui.message-output destination: %s' % name)
2441
2446
2442
2447
2443 def _writemsgwith(write, dest, *args, **opts):
2448 def _writemsgwith(write, dest, *args, **opts):
2444 """Write ui message with the given ui._write*() function
2449 """Write ui message with the given ui._write*() function
2445
2450
2446 The specified message type is translated to 'ui.<type>' label if the dest
2451 The specified message type is translated to 'ui.<type>' label if the dest
2447 isn't a structured channel, so that the message will be colorized.
2452 isn't a structured channel, so that the message will be colorized.
2448 """
2453 """
2449 # TODO: maybe change 'type' to a mandatory option
2454 # TODO: maybe change 'type' to a mandatory option
2450 if 'type' in opts and not getattr(dest, 'structured', False):
2455 if 'type' in opts and not getattr(dest, 'structured', False):
2451 opts['label'] = opts.get('label', b'') + b' ui.%s' % opts.pop('type')
2456 opts['label'] = opts.get('label', b'') + b' ui.%s' % opts.pop('type')
2452 write(dest, *args, **opts)
2457 write(dest, *args, **opts)
@@ -1,372 +1,387 b''
1 $ hg init a
1 $ hg init a
2 $ hg clone a b
2 $ hg clone a b
3 updating to branch default
3 updating to branch default
4 0 files updated, 0 files merged, 0 files removed, 0 files unresolved
4 0 files updated, 0 files merged, 0 files removed, 0 files unresolved
5 $ cd a
5 $ cd a
6
6
7 with no paths:
7 with no paths:
8
8
9 $ hg paths
9 $ hg paths
10 $ hg paths unknown
10 $ hg paths unknown
11 not found!
11 not found!
12 [1]
12 [1]
13 $ hg paths -Tjson
13 $ hg paths -Tjson
14 [
14 [
15 ]
15 ]
16
16
17 with paths:
17 with paths:
18
18
19 $ echo '[paths]' >> .hg/hgrc
19 $ echo '[paths]' >> .hg/hgrc
20 $ echo 'dupe = ../b#tip' >> .hg/hgrc
20 $ echo 'dupe = ../b#tip' >> .hg/hgrc
21 $ echo 'expand = $SOMETHING/bar' >> .hg/hgrc
21 $ echo 'expand = $SOMETHING/bar' >> .hg/hgrc
22 $ hg in dupe
22 $ hg in dupe
23 comparing with $TESTTMP/b
23 comparing with $TESTTMP/b
24 no changes found
24 no changes found
25 [1]
25 [1]
26 $ cd ..
26 $ cd ..
27 $ hg -R a in dupe
27 $ hg -R a in dupe
28 comparing with $TESTTMP/b
28 comparing with $TESTTMP/b
29 no changes found
29 no changes found
30 [1]
30 [1]
31 $ cd a
31 $ cd a
32 $ hg paths
32 $ hg paths
33 dupe = $TESTTMP/b#tip
33 dupe = $TESTTMP/b#tip
34 expand = $TESTTMP/a/$SOMETHING/bar
34 expand = $TESTTMP/a/$SOMETHING/bar
35 $ SOMETHING=foo hg paths
35 $ SOMETHING=foo hg paths
36 dupe = $TESTTMP/b#tip
36 dupe = $TESTTMP/b#tip
37 expand = $TESTTMP/a/foo/bar
37 expand = $TESTTMP/a/foo/bar
38 #if msys
38 #if msys
39 $ SOMETHING=//foo hg paths
39 $ SOMETHING=//foo hg paths
40 dupe = $TESTTMP/b#tip
40 dupe = $TESTTMP/b#tip
41 expand = /foo/bar
41 expand = /foo/bar
42 #else
42 #else
43 $ SOMETHING=/foo hg paths
43 $ SOMETHING=/foo hg paths
44 dupe = $TESTTMP/b#tip
44 dupe = $TESTTMP/b#tip
45 expand = /foo/bar
45 expand = /foo/bar
46 #endif
46 #endif
47 $ hg paths -q
47 $ hg paths -q
48 dupe
48 dupe
49 expand
49 expand
50 $ hg paths dupe
50 $ hg paths dupe
51 $TESTTMP/b#tip
51 $TESTTMP/b#tip
52 $ hg paths -q dupe
52 $ hg paths -q dupe
53 $ hg paths unknown
53 $ hg paths unknown
54 not found!
54 not found!
55 [1]
55 [1]
56 $ hg paths -q unknown
56 $ hg paths -q unknown
57 [1]
57 [1]
58
58
59 formatter output with paths:
59 formatter output with paths:
60
60
61 $ echo 'dupe:pushurl = https://example.com/dupe' >> .hg/hgrc
61 $ echo 'dupe:pushurl = https://example.com/dupe' >> .hg/hgrc
62 $ hg paths -Tjson | sed 's|\\\\|\\|g'
62 $ hg paths -Tjson | sed 's|\\\\|\\|g'
63 [
63 [
64 {
64 {
65 "name": "dupe",
65 "name": "dupe",
66 "pushurl": "https://example.com/dupe",
66 "pushurl": "https://example.com/dupe",
67 "url": "$TESTTMP/b#tip"
67 "url": "$TESTTMP/b#tip"
68 },
68 },
69 {
69 {
70 "name": "expand",
70 "name": "expand",
71 "url": "$TESTTMP/a/$SOMETHING/bar"
71 "url": "$TESTTMP/a/$SOMETHING/bar"
72 }
72 }
73 ]
73 ]
74 $ hg paths -Tjson dupe | sed 's|\\\\|\\|g'
74 $ hg paths -Tjson dupe | sed 's|\\\\|\\|g'
75 [
75 [
76 {
76 {
77 "name": "dupe",
77 "name": "dupe",
78 "pushurl": "https://example.com/dupe",
78 "pushurl": "https://example.com/dupe",
79 "url": "$TESTTMP/b#tip"
79 "url": "$TESTTMP/b#tip"
80 }
80 }
81 ]
81 ]
82 $ hg paths -Tjson -q unknown
82 $ hg paths -Tjson -q unknown
83 [
83 [
84 ]
84 ]
85 [1]
85 [1]
86
86
87 log template:
87 log template:
88
88
89 (behaves as a {name: path-string} dict by default)
89 (behaves as a {name: path-string} dict by default)
90
90
91 $ hg log -rnull -T '{peerurls}\n'
91 $ hg log -rnull -T '{peerurls}\n'
92 dupe=$TESTTMP/b#tip expand=$TESTTMP/a/$SOMETHING/bar
92 dupe=$TESTTMP/b#tip expand=$TESTTMP/a/$SOMETHING/bar
93 $ hg log -rnull -T '{join(peerurls, "\n")}\n'
93 $ hg log -rnull -T '{join(peerurls, "\n")}\n'
94 dupe=$TESTTMP/b#tip
94 dupe=$TESTTMP/b#tip
95 expand=$TESTTMP/a/$SOMETHING/bar
95 expand=$TESTTMP/a/$SOMETHING/bar
96 $ hg log -rnull -T '{peerurls % "{name}: {url}\n"}'
96 $ hg log -rnull -T '{peerurls % "{name}: {url}\n"}'
97 dupe: $TESTTMP/b#tip
97 dupe: $TESTTMP/b#tip
98 expand: $TESTTMP/a/$SOMETHING/bar
98 expand: $TESTTMP/a/$SOMETHING/bar
99 $ hg log -rnull -T '{get(peerurls, "dupe")}\n'
99 $ hg log -rnull -T '{get(peerurls, "dupe")}\n'
100 $TESTTMP/b#tip
100 $TESTTMP/b#tip
101
101
102 (sub options can be populated by map/dot operation)
102 (sub options can be populated by map/dot operation)
103
103
104 $ hg log -rnull \
104 $ hg log -rnull \
105 > -T '{get(peerurls, "dupe") % "url: {url}\npushurl: {pushurl}\n"}'
105 > -T '{get(peerurls, "dupe") % "url: {url}\npushurl: {pushurl}\n"}'
106 url: $TESTTMP/b#tip
106 url: $TESTTMP/b#tip
107 pushurl: https://example.com/dupe
107 pushurl: https://example.com/dupe
108 $ hg log -rnull -T '{peerurls.dupe.pushurl}\n'
108 $ hg log -rnull -T '{peerurls.dupe.pushurl}\n'
109 https://example.com/dupe
109 https://example.com/dupe
110
110
111 (in JSON, it's a dict of urls)
111 (in JSON, it's a dict of urls)
112
112
113 $ hg log -rnull -T '{peerurls|json}\n' | sed 's|\\\\|/|g'
113 $ hg log -rnull -T '{peerurls|json}\n' | sed 's|\\\\|/|g'
114 {"dupe": "$TESTTMP/b#tip", "expand": "$TESTTMP/a/$SOMETHING/bar"}
114 {"dupe": "$TESTTMP/b#tip", "expand": "$TESTTMP/a/$SOMETHING/bar"}
115
115
116 password should be masked in plain output, but not in machine-readable/template
116 password should be masked in plain output, but not in machine-readable/template
117 output:
117 output:
118
118
119 $ echo 'insecure = http://foo:insecure@example.com/' >> .hg/hgrc
119 $ echo 'insecure = http://foo:insecure@example.com/' >> .hg/hgrc
120 $ hg paths insecure
120 $ hg paths insecure
121 http://foo:***@example.com/
121 http://foo:***@example.com/
122 $ hg paths -Tjson insecure
122 $ hg paths -Tjson insecure
123 [
123 [
124 {
124 {
125 "name": "insecure",
125 "name": "insecure",
126 "url": "http://foo:insecure@example.com/"
126 "url": "http://foo:insecure@example.com/"
127 }
127 }
128 ]
128 ]
129 $ hg log -rnull -T '{get(peerurls, "insecure")}\n'
129 $ hg log -rnull -T '{get(peerurls, "insecure")}\n'
130 http://foo:insecure@example.com/
130 http://foo:insecure@example.com/
131
131
132 zeroconf wraps ui.configitems(), which shouldn't crash at least:
132 zeroconf wraps ui.configitems(), which shouldn't crash at least:
133
133
134 $ hg paths --config extensions.zeroconf=
134 $ hg paths --config extensions.zeroconf=
135 dupe = $TESTTMP/b#tip
135 dupe = $TESTTMP/b#tip
136 dupe:pushurl = https://example.com/dupe
136 dupe:pushurl = https://example.com/dupe
137 expand = $TESTTMP/a/$SOMETHING/bar
137 expand = $TESTTMP/a/$SOMETHING/bar
138 insecure = http://foo:***@example.com/
138 insecure = http://foo:***@example.com/
139
139
140 $ cd ..
140 $ cd ..
141
141
142 sub-options for an undeclared path are ignored
142 sub-options for an undeclared path are ignored
143
143
144 $ hg init suboptions
144 $ hg init suboptions
145 $ cd suboptions
145 $ cd suboptions
146
146
147 $ cat > .hg/hgrc << EOF
147 $ cat > .hg/hgrc << EOF
148 > [paths]
148 > [paths]
149 > path0 = https://example.com/path0
149 > path0 = https://example.com/path0
150 > path1:pushurl = https://example.com/path1
150 > path1:pushurl = https://example.com/path1
151 > EOF
151 > EOF
152 $ hg paths
152 $ hg paths
153 path0 = https://example.com/path0
153 path0 = https://example.com/path0
154
154
155 unknown sub-options aren't displayed
155 unknown sub-options aren't displayed
156
156
157 $ cat > .hg/hgrc << EOF
157 $ cat > .hg/hgrc << EOF
158 > [paths]
158 > [paths]
159 > path0 = https://example.com/path0
159 > path0 = https://example.com/path0
160 > path0:foo = https://example.com/path1
160 > path0:foo = https://example.com/path1
161 > EOF
161 > EOF
162
162
163 $ hg paths
163 $ hg paths
164 path0 = https://example.com/path0
164 path0 = https://example.com/path0
165
165
166 :pushurl must be a URL
166 :pushurl must be a URL
167
167
168 $ cat > .hg/hgrc << EOF
168 $ cat > .hg/hgrc << EOF
169 > [paths]
169 > [paths]
170 > default = /path/to/nothing
170 > default = /path/to/nothing
171 > default:pushurl = /not/a/url
171 > default:pushurl = /not/a/url
172 > EOF
172 > EOF
173
173
174 $ hg paths
174 $ hg paths
175 (paths.default:pushurl not a URL; ignoring)
175 (paths.default:pushurl not a URL; ignoring)
176 default = /path/to/nothing
176 default = /path/to/nothing
177
177
178 #fragment is not allowed in :pushurl
178 #fragment is not allowed in :pushurl
179
179
180 $ cat > .hg/hgrc << EOF
180 $ cat > .hg/hgrc << EOF
181 > [paths]
181 > [paths]
182 > default = https://example.com/repo
182 > default = https://example.com/repo
183 > invalid = https://example.com/repo
183 > invalid = https://example.com/repo
184 > invalid:pushurl = https://example.com/repo#branch
184 > invalid:pushurl = https://example.com/repo#branch
185 > EOF
185 > EOF
186
186
187 $ hg paths
187 $ hg paths
188 ("#fragment" in paths.invalid:pushurl not supported; ignoring)
188 ("#fragment" in paths.invalid:pushurl not supported; ignoring)
189 default = https://example.com/repo
189 default = https://example.com/repo
190 invalid = https://example.com/repo
190 invalid = https://example.com/repo
191 invalid:pushurl = https://example.com/repo
191 invalid:pushurl = https://example.com/repo
192
192
193 $ cd ..
193 $ cd ..
194
194
195 'file:' disables [paths] entries for clone destination
195 'file:' disables [paths] entries for clone destination
196
196
197 $ cat >> $HGRCPATH <<EOF
197 $ cat >> $HGRCPATH <<EOF
198 > [paths]
198 > [paths]
199 > gpath1 = http://hg.example.com
199 > gpath1 = http://hg.example.com
200 > EOF
200 > EOF
201
201
202 $ hg clone a gpath1
202 $ hg clone a gpath1
203 abort: cannot create new http repository
203 abort: cannot create new http repository
204 [255]
204 [255]
205
205
206 $ hg clone a file:gpath1
206 $ hg clone a file:gpath1
207 updating to branch default
207 updating to branch default
208 0 files updated, 0 files merged, 0 files removed, 0 files unresolved
208 0 files updated, 0 files merged, 0 files removed, 0 files unresolved
209 $ cd gpath1
209 $ cd gpath1
210 $ hg -q id
210 $ hg -q id
211 000000000000
211 000000000000
212
212
213 $ cd ..
213 $ cd ..
214
214
215 Testing path referencing other paths
215 Testing path referencing other paths
216 ====================================
216 ====================================
217
217
218 basic setup
218 basic setup
219 -----------
219 -----------
220
220
221 $ ls -1
221 $ ls -1
222 a
222 a
223 b
223 b
224 gpath1
224 gpath1
225 suboptions
225 suboptions
226 $ hg init chained_path
226 $ hg init chained_path
227 $ cd chained_path
227 $ cd chained_path
228 $ cat << EOF > .hg/hgrc
228 $ cat << EOF > .hg/hgrc
229 > [paths]
229 > [paths]
230 > default=../a
230 > default=../a
231 > other_default=path://default
231 > other_default=path://default
232 > path_with_branch=../branchy#foo
232 > path_with_branch=../branchy#foo
233 > other_branch=path://path_with_branch
233 > other_branch=path://path_with_branch
234 > other_branched=path://path_with_branch#default
234 > other_branched=path://path_with_branch#default
235 > pushdest=../push-dest
235 > pushdest=../push-dest
236 > pushdest:pushrev=default
236 > pushdest:pushrev=default
237 > pushdest2=path://pushdest
237 > pushdest2=path://pushdest
238 > pushdest-overwrite=path://pushdest
238 > pushdest-overwrite=path://pushdest
239 > pushdest-overwrite:pushrev=foo
239 > pushdest-overwrite:pushrev=foo
240 > EOF
240 > EOF
241
241
242 $ hg init ../branchy
242 $ hg init ../branchy
243 $ hg init ../push-dest
243 $ hg init ../push-dest
244 $ hg debugbuilddag -R ../branchy '.:base+3<base@foo+5'
244 $ hg debugbuilddag -R ../branchy '.:base+3<base@foo+5'
245 $ hg log -G -T '{branch}\n' -R ../branchy
245 $ hg log -G -T '{branch}\n' -R ../branchy
246 o foo
246 o foo
247 |
247 |
248 o foo
248 o foo
249 |
249 |
250 o foo
250 o foo
251 |
251 |
252 o foo
252 o foo
253 |
253 |
254 o foo
254 o foo
255 |
255 |
256 | o default
256 | o default
257 | |
257 | |
258 | o default
258 | o default
259 | |
259 | |
260 | o default
260 | o default
261 |/
261 |/
262 o default
262 o default
263
263
264
264
265 $ hg paths
265 $ hg paths
266 default = $TESTTMP/a
266 default = $TESTTMP/a
267 gpath1 = http://hg.example.com/
267 gpath1 = http://hg.example.com/
268 other_branch = $TESTTMP/branchy#foo
268 other_branch = $TESTTMP/branchy#foo
269 other_branched = $TESTTMP/branchy#default
269 other_branched = $TESTTMP/branchy#default
270 other_default = $TESTTMP/a
270 other_default = $TESTTMP/a
271 path_with_branch = $TESTTMP/branchy#foo
271 path_with_branch = $TESTTMP/branchy#foo
272 pushdest = $TESTTMP/push-dest
272 pushdest = $TESTTMP/push-dest
273 pushdest:pushrev = default
273 pushdest:pushrev = default
274 pushdest-overwrite = $TESTTMP/push-dest
274 pushdest-overwrite = $TESTTMP/push-dest
275 pushdest-overwrite:pushrev = foo
275 pushdest-overwrite:pushrev = foo
276 pushdest2 = $TESTTMP/push-dest
276 pushdest2 = $TESTTMP/push-dest
277 pushdest2:pushrev = default
277 pushdest2:pushrev = default
278
278
279 test basic chaining
279 test basic chaining
280 -------------------
280 -------------------
281
281
282 $ hg path other_default
282 $ hg path other_default
283 $TESTTMP/a
283 $TESTTMP/a
284 $ hg pull default
284 $ hg pull default
285 pulling from $TESTTMP/a
285 pulling from $TESTTMP/a
286 no changes found
286 no changes found
287 $ hg pull other_default
287 $ hg pull other_default
288 pulling from $TESTTMP/a
288 pulling from $TESTTMP/a
289 no changes found
289 no changes found
290
290
291 test inheritance of the #fragment part
291 test inheritance of the #fragment part
292 --------------------------------------
292 --------------------------------------
293
293
294 $ hg pull path_with_branch
294 $ hg pull path_with_branch
295 pulling from $TESTTMP/branchy
295 pulling from $TESTTMP/branchy
296 adding changesets
296 adding changesets
297 adding manifests
297 adding manifests
298 adding file changes
298 adding file changes
299 added 6 changesets with 0 changes to 0 files
299 added 6 changesets with 0 changes to 0 files
300 new changesets 1ea73414a91b:bcebb50b77de
300 new changesets 1ea73414a91b:bcebb50b77de
301 (run 'hg update' to get a working copy)
301 (run 'hg update' to get a working copy)
302 $ hg pull other_branch
302 $ hg pull other_branch
303 pulling from $TESTTMP/branchy
303 pulling from $TESTTMP/branchy
304 no changes found
304 no changes found
305 $ hg pull other_branched
305 $ hg pull other_branched
306 pulling from $TESTTMP/branchy
306 pulling from $TESTTMP/branchy
307 searching for changes
307 searching for changes
308 adding changesets
308 adding changesets
309 adding manifests
309 adding manifests
310 adding file changes
310 adding file changes
311 added 3 changesets with 0 changes to 0 files (+1 heads)
311 added 3 changesets with 0 changes to 0 files (+1 heads)
312 new changesets 66f7d451a68b:2dc09a01254d
312 new changesets 66f7d451a68b:2dc09a01254d
313 (run 'hg heads' to see heads)
313 (run 'hg heads' to see heads)
314
314
315 test inheritance of the suboptions
315 test inheritance of the suboptions
316 ----------------------------------
316 ----------------------------------
317
317
318 $ hg push pushdest
318 $ hg push pushdest
319 pushing to $TESTTMP/push-dest
319 pushing to $TESTTMP/push-dest
320 searching for changes
320 searching for changes
321 adding changesets
321 adding changesets
322 adding manifests
322 adding manifests
323 adding file changes
323 adding file changes
324 added 4 changesets with 0 changes to 0 files
324 added 4 changesets with 0 changes to 0 files
325 $ hg push pushdest2
325 $ hg push pushdest2
326 pushing to $TESTTMP/push-dest
326 pushing to $TESTTMP/push-dest
327 searching for changes
327 searching for changes
328 no changes found
328 no changes found
329 [1]
329 [1]
330 $ hg push pushdest-overwrite --new-branch
330 $ hg push pushdest-overwrite --new-branch
331 pushing to $TESTTMP/push-dest
331 pushing to $TESTTMP/push-dest
332 searching for changes
332 searching for changes
333 adding changesets
333 adding changesets
334 adding manifests
334 adding manifests
335 adding file changes
335 adding file changes
336 added 5 changesets with 0 changes to 0 files (+1 heads)
336 added 5 changesets with 0 changes to 0 files (+1 heads)
337
337
338 Test chaining path:// definition
338 Test chaining path:// definition
339 --------------------------------
339 --------------------------------
340
340
341 This is currently unsupported, but feel free to implement the necessary
341 This is currently unsupported, but feel free to implement the necessary
342 dependency detection.
342 dependency detection.
343
343
344 $ cat << EOF >> .hg/hgrc
344 $ cat << EOF >> .hg/hgrc
345 > chain_path=path://other_default
345 > chain_path=path://other_default
346 > EOF
346 > EOF
347
347
348 $ hg id
348 $ hg id
349 000000000000
349 000000000000
350 $ hg path
350 $ hg path
351 abort: cannot use `path://other_default`, "other_default" is also define as a `path://`
351 abort: cannot use `path://other_default`, "other_default" is also define as a `path://`
352 [255]
352 [255]
353 $ hg pull chain_path
353 $ hg pull chain_path
354 abort: cannot use `path://other_default`, "other_default" is also define as a `path://`
354 abort: cannot use `path://other_default`, "other_default" is also define as a `path://`
355 [255]
355 [255]
356
356
357 Doing an actual circle should always be an issue
357 Doing an actual circle should always be an issue
358
358
359 $ cat << EOF >> .hg/hgrc
359 $ cat << EOF >> .hg/hgrc
360 > rock=path://cissors
360 > rock=path://cissors
361 > cissors=path://paper
361 > cissors=path://paper
362 > paper=://rock
362 > paper=://rock
363 > EOF
363 > EOF
364
364
365 $ hg id
365 $ hg id
366 000000000000
366 000000000000
367 $ hg path
367 $ hg path
368 abort: cannot use `path://other_default`, "other_default" is also define as a `path://`
368 abort: cannot use `path://other_default`, "other_default" is also define as a `path://`
369 [255]
369 [255]
370 $ hg pull chain_path
370 $ hg pull chain_path
371 abort: cannot use `path://other_default`, "other_default" is also define as a `path://`
371 abort: cannot use `path://other_default`, "other_default" is also define as a `path://`
372 [255]
372 [255]
373
374 Test basic error cases
375 ----------------------
376
377 $ cat << EOF > .hg/hgrc
378 > [paths]
379 > error-missing=path://unknown
380 > EOF
381 $ hg path
382 abort: cannot use `path://unknown`, "unknown" is not a known path
383 [255]
384 $ hg pull error-missing
385 abort: cannot use `path://unknown`, "unknown" is not a known path
386 [255]
387
General Comments 0
You need to be logged in to leave comments. Login now