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