##// END OF EJS Templates
stdio: raise StdioError if something goes wrong in ui.flush...
Bryan O'Sullivan -
r31963:1bfb9a63 default
parent child Browse files
Show More
@@ -1,1670 +1,1675
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 tempfile
21 import tempfile
22 import traceback
22 import traceback
23
23
24 from .i18n import _
24 from .i18n import _
25 from .node import hex
25 from .node import hex
26
26
27 from . import (
27 from . import (
28 color,
28 color,
29 config,
29 config,
30 encoding,
30 encoding,
31 error,
31 error,
32 formatter,
32 formatter,
33 progress,
33 progress,
34 pycompat,
34 pycompat,
35 rcutil,
35 rcutil,
36 scmutil,
36 scmutil,
37 util,
37 util,
38 )
38 )
39
39
40 urlreq = util.urlreq
40 urlreq = util.urlreq
41
41
42 # for use with str.translate(None, _keepalnum), to keep just alphanumerics
42 # for use with str.translate(None, _keepalnum), to keep just alphanumerics
43 _keepalnum = ''.join(c for c in map(pycompat.bytechr, range(256))
43 _keepalnum = ''.join(c for c in map(pycompat.bytechr, range(256))
44 if not c.isalnum())
44 if not c.isalnum())
45
45
46 samplehgrcs = {
46 samplehgrcs = {
47 'user':
47 'user':
48 """# example user config (see 'hg help config' for more info)
48 """# example user config (see 'hg help config' for more info)
49 [ui]
49 [ui]
50 # name and email, e.g.
50 # name and email, e.g.
51 # username = Jane Doe <jdoe@example.com>
51 # username = Jane Doe <jdoe@example.com>
52 username =
52 username =
53
53
54 # uncomment to colorize command output
54 # uncomment to colorize command output
55 # color = auto
55 # color = auto
56
56
57 [extensions]
57 [extensions]
58 # uncomment these lines to enable some popular extensions
58 # uncomment these lines to enable some popular extensions
59 # (see 'hg help extensions' for more info)
59 # (see 'hg help extensions' for more info)
60 #
60 #
61 # pager =""",
61 # pager =""",
62
62
63 'cloned':
63 'cloned':
64 """# example repository config (see 'hg help config' for more info)
64 """# example repository config (see 'hg help config' for more info)
65 [paths]
65 [paths]
66 default = %s
66 default = %s
67
67
68 # path aliases to other clones of this repo in URLs or filesystem paths
68 # path aliases to other clones of this repo in URLs or filesystem paths
69 # (see 'hg help config.paths' for more info)
69 # (see 'hg help config.paths' for more info)
70 #
70 #
71 # default:pushurl = ssh://jdoe@example.net/hg/jdoes-fork
71 # default:pushurl = ssh://jdoe@example.net/hg/jdoes-fork
72 # my-fork = ssh://jdoe@example.net/hg/jdoes-fork
72 # my-fork = ssh://jdoe@example.net/hg/jdoes-fork
73 # my-clone = /home/jdoe/jdoes-clone
73 # my-clone = /home/jdoe/jdoes-clone
74
74
75 [ui]
75 [ui]
76 # name and email (local to this repository, optional), e.g.
76 # name and email (local to this repository, optional), e.g.
77 # username = Jane Doe <jdoe@example.com>
77 # username = Jane Doe <jdoe@example.com>
78 """,
78 """,
79
79
80 'local':
80 'local':
81 """# example repository config (see 'hg help config' for more info)
81 """# example repository config (see 'hg help config' for more info)
82 [paths]
82 [paths]
83 # path aliases to other clones of this repo in URLs or filesystem paths
83 # path aliases to other clones of this repo in URLs or filesystem paths
84 # (see 'hg help config.paths' for more info)
84 # (see 'hg help config.paths' for more info)
85 #
85 #
86 # default = http://example.com/hg/example-repo
86 # default = http://example.com/hg/example-repo
87 # default:pushurl = ssh://jdoe@example.net/hg/jdoes-fork
87 # default:pushurl = ssh://jdoe@example.net/hg/jdoes-fork
88 # my-fork = ssh://jdoe@example.net/hg/jdoes-fork
88 # my-fork = ssh://jdoe@example.net/hg/jdoes-fork
89 # my-clone = /home/jdoe/jdoes-clone
89 # my-clone = /home/jdoe/jdoes-clone
90
90
91 [ui]
91 [ui]
92 # name and email (local to this repository, optional), e.g.
92 # name and email (local to this repository, optional), e.g.
93 # username = Jane Doe <jdoe@example.com>
93 # username = Jane Doe <jdoe@example.com>
94 """,
94 """,
95
95
96 'global':
96 'global':
97 """# example system-wide hg config (see 'hg help config' for more info)
97 """# example system-wide hg config (see 'hg help config' for more info)
98
98
99 [ui]
99 [ui]
100 # uncomment to colorize command output
100 # uncomment to colorize command output
101 # color = auto
101 # color = auto
102
102
103 [extensions]
103 [extensions]
104 # uncomment these lines to enable some popular extensions
104 # uncomment these lines to enable some popular extensions
105 # (see 'hg help extensions' for more info)
105 # (see 'hg help extensions' for more info)
106 #
106 #
107 # blackbox =
107 # blackbox =
108 # pager =""",
108 # pager =""",
109 }
109 }
110
110
111
111
112 class httppasswordmgrdbproxy(object):
112 class httppasswordmgrdbproxy(object):
113 """Delays loading urllib2 until it's needed."""
113 """Delays loading urllib2 until it's needed."""
114 def __init__(self):
114 def __init__(self):
115 self._mgr = None
115 self._mgr = None
116
116
117 def _get_mgr(self):
117 def _get_mgr(self):
118 if self._mgr is None:
118 if self._mgr is None:
119 self._mgr = urlreq.httppasswordmgrwithdefaultrealm()
119 self._mgr = urlreq.httppasswordmgrwithdefaultrealm()
120 return self._mgr
120 return self._mgr
121
121
122 def add_password(self, *args, **kwargs):
122 def add_password(self, *args, **kwargs):
123 return self._get_mgr().add_password(*args, **kwargs)
123 return self._get_mgr().add_password(*args, **kwargs)
124
124
125 def find_user_password(self, *args, **kwargs):
125 def find_user_password(self, *args, **kwargs):
126 return self._get_mgr().find_user_password(*args, **kwargs)
126 return self._get_mgr().find_user_password(*args, **kwargs)
127
127
128 def _catchterm(*args):
128 def _catchterm(*args):
129 raise error.SignalInterrupt
129 raise error.SignalInterrupt
130
130
131 class ui(object):
131 class ui(object):
132 def __init__(self, src=None):
132 def __init__(self, src=None):
133 """Create a fresh new ui object if no src given
133 """Create a fresh new ui object if no src given
134
134
135 Use uimod.ui.load() to create a ui which knows global and user configs.
135 Use uimod.ui.load() to create a ui which knows global and user configs.
136 In most cases, you should use ui.copy() to create a copy of an existing
136 In most cases, you should use ui.copy() to create a copy of an existing
137 ui object.
137 ui object.
138 """
138 """
139 # _buffers: used for temporary capture of output
139 # _buffers: used for temporary capture of output
140 self._buffers = []
140 self._buffers = []
141 # _exithandlers: callbacks run at the end of a request
141 # _exithandlers: callbacks run at the end of a request
142 self._exithandlers = []
142 self._exithandlers = []
143 # 3-tuple describing how each buffer in the stack behaves.
143 # 3-tuple describing how each buffer in the stack behaves.
144 # Values are (capture stderr, capture subprocesses, apply labels).
144 # Values are (capture stderr, capture subprocesses, apply labels).
145 self._bufferstates = []
145 self._bufferstates = []
146 # When a buffer is active, defines whether we are expanding labels.
146 # When a buffer is active, defines whether we are expanding labels.
147 # This exists to prevent an extra list lookup.
147 # This exists to prevent an extra list lookup.
148 self._bufferapplylabels = None
148 self._bufferapplylabels = None
149 self.quiet = self.verbose = self.debugflag = self.tracebackflag = False
149 self.quiet = self.verbose = self.debugflag = self.tracebackflag = False
150 self._reportuntrusted = True
150 self._reportuntrusted = True
151 self._ocfg = config.config() # overlay
151 self._ocfg = config.config() # overlay
152 self._tcfg = config.config() # trusted
152 self._tcfg = config.config() # trusted
153 self._ucfg = config.config() # untrusted
153 self._ucfg = config.config() # untrusted
154 self._trustusers = set()
154 self._trustusers = set()
155 self._trustgroups = set()
155 self._trustgroups = set()
156 self.callhooks = True
156 self.callhooks = True
157 # Insecure server connections requested.
157 # Insecure server connections requested.
158 self.insecureconnections = False
158 self.insecureconnections = False
159 # Blocked time
159 # Blocked time
160 self.logblockedtimes = False
160 self.logblockedtimes = False
161 # color mode: see mercurial/color.py for possible value
161 # color mode: see mercurial/color.py for possible value
162 self._colormode = None
162 self._colormode = None
163 self._terminfoparams = {}
163 self._terminfoparams = {}
164 self._styles = {}
164 self._styles = {}
165
165
166 if src:
166 if src:
167 self._exithandlers = src._exithandlers
167 self._exithandlers = src._exithandlers
168 self.fout = src.fout
168 self.fout = src.fout
169 self.ferr = src.ferr
169 self.ferr = src.ferr
170 self.fin = src.fin
170 self.fin = src.fin
171 self.pageractive = src.pageractive
171 self.pageractive = src.pageractive
172 self._disablepager = src._disablepager
172 self._disablepager = src._disablepager
173
173
174 self._tcfg = src._tcfg.copy()
174 self._tcfg = src._tcfg.copy()
175 self._ucfg = src._ucfg.copy()
175 self._ucfg = src._ucfg.copy()
176 self._ocfg = src._ocfg.copy()
176 self._ocfg = src._ocfg.copy()
177 self._trustusers = src._trustusers.copy()
177 self._trustusers = src._trustusers.copy()
178 self._trustgroups = src._trustgroups.copy()
178 self._trustgroups = src._trustgroups.copy()
179 self.environ = src.environ
179 self.environ = src.environ
180 self.callhooks = src.callhooks
180 self.callhooks = src.callhooks
181 self.insecureconnections = src.insecureconnections
181 self.insecureconnections = src.insecureconnections
182 self._colormode = src._colormode
182 self._colormode = src._colormode
183 self._terminfoparams = src._terminfoparams.copy()
183 self._terminfoparams = src._terminfoparams.copy()
184 self._styles = src._styles.copy()
184 self._styles = src._styles.copy()
185
185
186 self.fixconfig()
186 self.fixconfig()
187
187
188 self.httppasswordmgrdb = src.httppasswordmgrdb
188 self.httppasswordmgrdb = src.httppasswordmgrdb
189 self._blockedtimes = src._blockedtimes
189 self._blockedtimes = src._blockedtimes
190 else:
190 else:
191 self.fout = util.stdout
191 self.fout = util.stdout
192 self.ferr = util.stderr
192 self.ferr = util.stderr
193 self.fin = util.stdin
193 self.fin = util.stdin
194 self.pageractive = False
194 self.pageractive = False
195 self._disablepager = False
195 self._disablepager = False
196
196
197 # shared read-only environment
197 # shared read-only environment
198 self.environ = encoding.environ
198 self.environ = encoding.environ
199
199
200 self.httppasswordmgrdb = httppasswordmgrdbproxy()
200 self.httppasswordmgrdb = httppasswordmgrdbproxy()
201 self._blockedtimes = collections.defaultdict(int)
201 self._blockedtimes = collections.defaultdict(int)
202
202
203 allowed = self.configlist('experimental', 'exportableenviron')
203 allowed = self.configlist('experimental', 'exportableenviron')
204 if '*' in allowed:
204 if '*' in allowed:
205 self._exportableenviron = self.environ
205 self._exportableenviron = self.environ
206 else:
206 else:
207 self._exportableenviron = {}
207 self._exportableenviron = {}
208 for k in allowed:
208 for k in allowed:
209 if k in self.environ:
209 if k in self.environ:
210 self._exportableenviron[k] = self.environ[k]
210 self._exportableenviron[k] = self.environ[k]
211
211
212 @classmethod
212 @classmethod
213 def load(cls):
213 def load(cls):
214 """Create a ui and load global and user configs"""
214 """Create a ui and load global and user configs"""
215 u = cls()
215 u = cls()
216 # we always trust global config files and environment variables
216 # we always trust global config files and environment variables
217 for t, f in rcutil.rccomponents():
217 for t, f in rcutil.rccomponents():
218 if t == 'path':
218 if t == 'path':
219 u.readconfig(f, trust=True)
219 u.readconfig(f, trust=True)
220 elif t == 'items':
220 elif t == 'items':
221 sections = set()
221 sections = set()
222 for section, name, value, source in f:
222 for section, name, value, source in f:
223 # do not set u._ocfg
223 # do not set u._ocfg
224 # XXX clean this up once immutable config object is a thing
224 # XXX clean this up once immutable config object is a thing
225 u._tcfg.set(section, name, value, source)
225 u._tcfg.set(section, name, value, source)
226 u._ucfg.set(section, name, value, source)
226 u._ucfg.set(section, name, value, source)
227 sections.add(section)
227 sections.add(section)
228 for section in sections:
228 for section in sections:
229 u.fixconfig(section=section)
229 u.fixconfig(section=section)
230 else:
230 else:
231 raise error.ProgrammingError('unknown rctype: %s' % t)
231 raise error.ProgrammingError('unknown rctype: %s' % t)
232 return u
232 return u
233
233
234 def copy(self):
234 def copy(self):
235 return self.__class__(self)
235 return self.__class__(self)
236
236
237 def resetstate(self):
237 def resetstate(self):
238 """Clear internal state that shouldn't persist across commands"""
238 """Clear internal state that shouldn't persist across commands"""
239 if self._progbar:
239 if self._progbar:
240 self._progbar.resetstate() # reset last-print time of progress bar
240 self._progbar.resetstate() # reset last-print time of progress bar
241 self.httppasswordmgrdb = httppasswordmgrdbproxy()
241 self.httppasswordmgrdb = httppasswordmgrdbproxy()
242
242
243 @contextlib.contextmanager
243 @contextlib.contextmanager
244 def timeblockedsection(self, key):
244 def timeblockedsection(self, key):
245 # this is open-coded below - search for timeblockedsection to find them
245 # this is open-coded below - search for timeblockedsection to find them
246 starttime = util.timer()
246 starttime = util.timer()
247 try:
247 try:
248 yield
248 yield
249 finally:
249 finally:
250 self._blockedtimes[key + '_blocked'] += \
250 self._blockedtimes[key + '_blocked'] += \
251 (util.timer() - starttime) * 1000
251 (util.timer() - starttime) * 1000
252
252
253 def formatter(self, topic, opts):
253 def formatter(self, topic, opts):
254 return formatter.formatter(self, topic, opts)
254 return formatter.formatter(self, topic, opts)
255
255
256 def _trusted(self, fp, f):
256 def _trusted(self, fp, f):
257 st = util.fstat(fp)
257 st = util.fstat(fp)
258 if util.isowner(st):
258 if util.isowner(st):
259 return True
259 return True
260
260
261 tusers, tgroups = self._trustusers, self._trustgroups
261 tusers, tgroups = self._trustusers, self._trustgroups
262 if '*' in tusers or '*' in tgroups:
262 if '*' in tusers or '*' in tgroups:
263 return True
263 return True
264
264
265 user = util.username(st.st_uid)
265 user = util.username(st.st_uid)
266 group = util.groupname(st.st_gid)
266 group = util.groupname(st.st_gid)
267 if user in tusers or group in tgroups or user == util.username():
267 if user in tusers or group in tgroups or user == util.username():
268 return True
268 return True
269
269
270 if self._reportuntrusted:
270 if self._reportuntrusted:
271 self.warn(_('not trusting file %s from untrusted '
271 self.warn(_('not trusting file %s from untrusted '
272 'user %s, group %s\n') % (f, user, group))
272 'user %s, group %s\n') % (f, user, group))
273 return False
273 return False
274
274
275 def readconfig(self, filename, root=None, trust=False,
275 def readconfig(self, filename, root=None, trust=False,
276 sections=None, remap=None):
276 sections=None, remap=None):
277 try:
277 try:
278 fp = open(filename, u'rb')
278 fp = open(filename, u'rb')
279 except IOError:
279 except IOError:
280 if not sections: # ignore unless we were looking for something
280 if not sections: # ignore unless we were looking for something
281 return
281 return
282 raise
282 raise
283
283
284 cfg = config.config()
284 cfg = config.config()
285 trusted = sections or trust or self._trusted(fp, filename)
285 trusted = sections or trust or self._trusted(fp, filename)
286
286
287 try:
287 try:
288 cfg.read(filename, fp, sections=sections, remap=remap)
288 cfg.read(filename, fp, sections=sections, remap=remap)
289 fp.close()
289 fp.close()
290 except error.ConfigError as inst:
290 except error.ConfigError as inst:
291 if trusted:
291 if trusted:
292 raise
292 raise
293 self.warn(_("ignored: %s\n") % str(inst))
293 self.warn(_("ignored: %s\n") % str(inst))
294
294
295 if self.plain():
295 if self.plain():
296 for k in ('debug', 'fallbackencoding', 'quiet', 'slash',
296 for k in ('debug', 'fallbackencoding', 'quiet', 'slash',
297 'logtemplate', 'statuscopies', 'style',
297 'logtemplate', 'statuscopies', 'style',
298 'traceback', 'verbose'):
298 'traceback', 'verbose'):
299 if k in cfg['ui']:
299 if k in cfg['ui']:
300 del cfg['ui'][k]
300 del cfg['ui'][k]
301 for k, v in cfg.items('defaults'):
301 for k, v in cfg.items('defaults'):
302 del cfg['defaults'][k]
302 del cfg['defaults'][k]
303 for k, v in cfg.items('commands'):
303 for k, v in cfg.items('commands'):
304 del cfg['commands'][k]
304 del cfg['commands'][k]
305 # Don't remove aliases from the configuration if in the exceptionlist
305 # Don't remove aliases from the configuration if in the exceptionlist
306 if self.plain('alias'):
306 if self.plain('alias'):
307 for k, v in cfg.items('alias'):
307 for k, v in cfg.items('alias'):
308 del cfg['alias'][k]
308 del cfg['alias'][k]
309 if self.plain('revsetalias'):
309 if self.plain('revsetalias'):
310 for k, v in cfg.items('revsetalias'):
310 for k, v in cfg.items('revsetalias'):
311 del cfg['revsetalias'][k]
311 del cfg['revsetalias'][k]
312 if self.plain('templatealias'):
312 if self.plain('templatealias'):
313 for k, v in cfg.items('templatealias'):
313 for k, v in cfg.items('templatealias'):
314 del cfg['templatealias'][k]
314 del cfg['templatealias'][k]
315
315
316 if trusted:
316 if trusted:
317 self._tcfg.update(cfg)
317 self._tcfg.update(cfg)
318 self._tcfg.update(self._ocfg)
318 self._tcfg.update(self._ocfg)
319 self._ucfg.update(cfg)
319 self._ucfg.update(cfg)
320 self._ucfg.update(self._ocfg)
320 self._ucfg.update(self._ocfg)
321
321
322 if root is None:
322 if root is None:
323 root = os.path.expanduser('~')
323 root = os.path.expanduser('~')
324 self.fixconfig(root=root)
324 self.fixconfig(root=root)
325
325
326 def fixconfig(self, root=None, section=None):
326 def fixconfig(self, root=None, section=None):
327 if section in (None, 'paths'):
327 if section in (None, 'paths'):
328 # expand vars and ~
328 # expand vars and ~
329 # translate paths relative to root (or home) into absolute paths
329 # translate paths relative to root (or home) into absolute paths
330 root = root or pycompat.getcwd()
330 root = root or pycompat.getcwd()
331 for c in self._tcfg, self._ucfg, self._ocfg:
331 for c in self._tcfg, self._ucfg, self._ocfg:
332 for n, p in c.items('paths'):
332 for n, p in c.items('paths'):
333 # Ignore sub-options.
333 # Ignore sub-options.
334 if ':' in n:
334 if ':' in n:
335 continue
335 continue
336 if not p:
336 if not p:
337 continue
337 continue
338 if '%%' in p:
338 if '%%' in p:
339 s = self.configsource('paths', n) or 'none'
339 s = self.configsource('paths', n) or 'none'
340 self.warn(_("(deprecated '%%' in path %s=%s from %s)\n")
340 self.warn(_("(deprecated '%%' in path %s=%s from %s)\n")
341 % (n, p, s))
341 % (n, p, s))
342 p = p.replace('%%', '%')
342 p = p.replace('%%', '%')
343 p = util.expandpath(p)
343 p = util.expandpath(p)
344 if not util.hasscheme(p) and not os.path.isabs(p):
344 if not util.hasscheme(p) and not os.path.isabs(p):
345 p = os.path.normpath(os.path.join(root, p))
345 p = os.path.normpath(os.path.join(root, p))
346 c.set("paths", n, p)
346 c.set("paths", n, p)
347
347
348 if section in (None, 'ui'):
348 if section in (None, 'ui'):
349 # update ui options
349 # update ui options
350 self.debugflag = self.configbool('ui', 'debug')
350 self.debugflag = self.configbool('ui', 'debug')
351 self.verbose = self.debugflag or self.configbool('ui', 'verbose')
351 self.verbose = self.debugflag or self.configbool('ui', 'verbose')
352 self.quiet = not self.debugflag and self.configbool('ui', 'quiet')
352 self.quiet = not self.debugflag and self.configbool('ui', 'quiet')
353 if self.verbose and self.quiet:
353 if self.verbose and self.quiet:
354 self.quiet = self.verbose = False
354 self.quiet = self.verbose = False
355 self._reportuntrusted = self.debugflag or self.configbool("ui",
355 self._reportuntrusted = self.debugflag or self.configbool("ui",
356 "report_untrusted", True)
356 "report_untrusted", True)
357 self.tracebackflag = self.configbool('ui', 'traceback', False)
357 self.tracebackflag = self.configbool('ui', 'traceback', False)
358 self.logblockedtimes = self.configbool('ui', 'logblockedtimes')
358 self.logblockedtimes = self.configbool('ui', 'logblockedtimes')
359
359
360 if section in (None, 'trusted'):
360 if section in (None, 'trusted'):
361 # update trust information
361 # update trust information
362 self._trustusers.update(self.configlist('trusted', 'users'))
362 self._trustusers.update(self.configlist('trusted', 'users'))
363 self._trustgroups.update(self.configlist('trusted', 'groups'))
363 self._trustgroups.update(self.configlist('trusted', 'groups'))
364
364
365 def backupconfig(self, section, item):
365 def backupconfig(self, section, item):
366 return (self._ocfg.backup(section, item),
366 return (self._ocfg.backup(section, item),
367 self._tcfg.backup(section, item),
367 self._tcfg.backup(section, item),
368 self._ucfg.backup(section, item),)
368 self._ucfg.backup(section, item),)
369 def restoreconfig(self, data):
369 def restoreconfig(self, data):
370 self._ocfg.restore(data[0])
370 self._ocfg.restore(data[0])
371 self._tcfg.restore(data[1])
371 self._tcfg.restore(data[1])
372 self._ucfg.restore(data[2])
372 self._ucfg.restore(data[2])
373
373
374 def setconfig(self, section, name, value, source=''):
374 def setconfig(self, section, name, value, source=''):
375 for cfg in (self._ocfg, self._tcfg, self._ucfg):
375 for cfg in (self._ocfg, self._tcfg, self._ucfg):
376 cfg.set(section, name, value, source)
376 cfg.set(section, name, value, source)
377 self.fixconfig(section=section)
377 self.fixconfig(section=section)
378
378
379 def _data(self, untrusted):
379 def _data(self, untrusted):
380 return untrusted and self._ucfg or self._tcfg
380 return untrusted and self._ucfg or self._tcfg
381
381
382 def configsource(self, section, name, untrusted=False):
382 def configsource(self, section, name, untrusted=False):
383 return self._data(untrusted).source(section, name)
383 return self._data(untrusted).source(section, name)
384
384
385 def config(self, section, name, default=None, untrusted=False):
385 def config(self, section, name, default=None, untrusted=False):
386 if isinstance(name, list):
386 if isinstance(name, list):
387 alternates = name
387 alternates = name
388 else:
388 else:
389 alternates = [name]
389 alternates = [name]
390
390
391 for n in alternates:
391 for n in alternates:
392 value = self._data(untrusted).get(section, n, None)
392 value = self._data(untrusted).get(section, n, None)
393 if value is not None:
393 if value is not None:
394 name = n
394 name = n
395 break
395 break
396 else:
396 else:
397 value = default
397 value = default
398
398
399 if self.debugflag and not untrusted and self._reportuntrusted:
399 if self.debugflag and not untrusted and self._reportuntrusted:
400 for n in alternates:
400 for n in alternates:
401 uvalue = self._ucfg.get(section, n)
401 uvalue = self._ucfg.get(section, n)
402 if uvalue is not None and uvalue != value:
402 if uvalue is not None and uvalue != value:
403 self.debug("ignoring untrusted configuration option "
403 self.debug("ignoring untrusted configuration option "
404 "%s.%s = %s\n" % (section, n, uvalue))
404 "%s.%s = %s\n" % (section, n, uvalue))
405 return value
405 return value
406
406
407 def configsuboptions(self, section, name, default=None, untrusted=False):
407 def configsuboptions(self, section, name, default=None, untrusted=False):
408 """Get a config option and all sub-options.
408 """Get a config option and all sub-options.
409
409
410 Some config options have sub-options that are declared with the
410 Some config options have sub-options that are declared with the
411 format "key:opt = value". This method is used to return the main
411 format "key:opt = value". This method is used to return the main
412 option and all its declared sub-options.
412 option and all its declared sub-options.
413
413
414 Returns a 2-tuple of ``(option, sub-options)``, where `sub-options``
414 Returns a 2-tuple of ``(option, sub-options)``, where `sub-options``
415 is a dict of defined sub-options where keys and values are strings.
415 is a dict of defined sub-options where keys and values are strings.
416 """
416 """
417 data = self._data(untrusted)
417 data = self._data(untrusted)
418 main = data.get(section, name, default)
418 main = data.get(section, name, default)
419 if self.debugflag and not untrusted and self._reportuntrusted:
419 if self.debugflag and not untrusted and self._reportuntrusted:
420 uvalue = self._ucfg.get(section, name)
420 uvalue = self._ucfg.get(section, name)
421 if uvalue is not None and uvalue != main:
421 if uvalue is not None and uvalue != main:
422 self.debug('ignoring untrusted configuration option '
422 self.debug('ignoring untrusted configuration option '
423 '%s.%s = %s\n' % (section, name, uvalue))
423 '%s.%s = %s\n' % (section, name, uvalue))
424
424
425 sub = {}
425 sub = {}
426 prefix = '%s:' % name
426 prefix = '%s:' % name
427 for k, v in data.items(section):
427 for k, v in data.items(section):
428 if k.startswith(prefix):
428 if k.startswith(prefix):
429 sub[k[len(prefix):]] = v
429 sub[k[len(prefix):]] = v
430
430
431 if self.debugflag and not untrusted and self._reportuntrusted:
431 if self.debugflag and not untrusted and self._reportuntrusted:
432 for k, v in sub.items():
432 for k, v in sub.items():
433 uvalue = self._ucfg.get(section, '%s:%s' % (name, k))
433 uvalue = self._ucfg.get(section, '%s:%s' % (name, k))
434 if uvalue is not None and uvalue != v:
434 if uvalue is not None and uvalue != v:
435 self.debug('ignoring untrusted configuration option '
435 self.debug('ignoring untrusted configuration option '
436 '%s:%s.%s = %s\n' % (section, name, k, uvalue))
436 '%s:%s.%s = %s\n' % (section, name, k, uvalue))
437
437
438 return main, sub
438 return main, sub
439
439
440 def configpath(self, section, name, default=None, untrusted=False):
440 def configpath(self, section, name, default=None, untrusted=False):
441 'get a path config item, expanded relative to repo root or config file'
441 'get a path config item, expanded relative to repo root or config file'
442 v = self.config(section, name, default, untrusted)
442 v = self.config(section, name, default, untrusted)
443 if v is None:
443 if v is None:
444 return None
444 return None
445 if not os.path.isabs(v) or "://" not in v:
445 if not os.path.isabs(v) or "://" not in v:
446 src = self.configsource(section, name, untrusted)
446 src = self.configsource(section, name, untrusted)
447 if ':' in src:
447 if ':' in src:
448 base = os.path.dirname(src.rsplit(':')[0])
448 base = os.path.dirname(src.rsplit(':')[0])
449 v = os.path.join(base, os.path.expanduser(v))
449 v = os.path.join(base, os.path.expanduser(v))
450 return v
450 return v
451
451
452 def configbool(self, section, name, default=False, untrusted=False):
452 def configbool(self, section, name, default=False, untrusted=False):
453 """parse a configuration element as a boolean
453 """parse a configuration element as a boolean
454
454
455 >>> u = ui(); s = 'foo'
455 >>> u = ui(); s = 'foo'
456 >>> u.setconfig(s, 'true', 'yes')
456 >>> u.setconfig(s, 'true', 'yes')
457 >>> u.configbool(s, 'true')
457 >>> u.configbool(s, 'true')
458 True
458 True
459 >>> u.setconfig(s, 'false', 'no')
459 >>> u.setconfig(s, 'false', 'no')
460 >>> u.configbool(s, 'false')
460 >>> u.configbool(s, 'false')
461 False
461 False
462 >>> u.configbool(s, 'unknown')
462 >>> u.configbool(s, 'unknown')
463 False
463 False
464 >>> u.configbool(s, 'unknown', True)
464 >>> u.configbool(s, 'unknown', True)
465 True
465 True
466 >>> u.setconfig(s, 'invalid', 'somevalue')
466 >>> u.setconfig(s, 'invalid', 'somevalue')
467 >>> u.configbool(s, 'invalid')
467 >>> u.configbool(s, 'invalid')
468 Traceback (most recent call last):
468 Traceback (most recent call last):
469 ...
469 ...
470 ConfigError: foo.invalid is not a boolean ('somevalue')
470 ConfigError: foo.invalid is not a boolean ('somevalue')
471 """
471 """
472
472
473 v = self.config(section, name, None, untrusted)
473 v = self.config(section, name, None, untrusted)
474 if v is None:
474 if v is None:
475 return default
475 return default
476 if isinstance(v, bool):
476 if isinstance(v, bool):
477 return v
477 return v
478 b = util.parsebool(v)
478 b = util.parsebool(v)
479 if b is None:
479 if b is None:
480 raise error.ConfigError(_("%s.%s is not a boolean ('%s')")
480 raise error.ConfigError(_("%s.%s is not a boolean ('%s')")
481 % (section, name, v))
481 % (section, name, v))
482 return b
482 return b
483
483
484 def configwith(self, convert, section, name, default=None,
484 def configwith(self, convert, section, name, default=None,
485 desc=None, untrusted=False):
485 desc=None, untrusted=False):
486 """parse a configuration element with a conversion function
486 """parse a configuration element with a conversion function
487
487
488 >>> u = ui(); s = 'foo'
488 >>> u = ui(); s = 'foo'
489 >>> u.setconfig(s, 'float1', '42')
489 >>> u.setconfig(s, 'float1', '42')
490 >>> u.configwith(float, s, 'float1')
490 >>> u.configwith(float, s, 'float1')
491 42.0
491 42.0
492 >>> u.setconfig(s, 'float2', '-4.25')
492 >>> u.setconfig(s, 'float2', '-4.25')
493 >>> u.configwith(float, s, 'float2')
493 >>> u.configwith(float, s, 'float2')
494 -4.25
494 -4.25
495 >>> u.configwith(float, s, 'unknown', 7)
495 >>> u.configwith(float, s, 'unknown', 7)
496 7
496 7
497 >>> u.setconfig(s, 'invalid', 'somevalue')
497 >>> u.setconfig(s, 'invalid', 'somevalue')
498 >>> u.configwith(float, s, 'invalid')
498 >>> u.configwith(float, s, 'invalid')
499 Traceback (most recent call last):
499 Traceback (most recent call last):
500 ...
500 ...
501 ConfigError: foo.invalid is not a valid float ('somevalue')
501 ConfigError: foo.invalid is not a valid float ('somevalue')
502 >>> u.configwith(float, s, 'invalid', desc='womble')
502 >>> u.configwith(float, s, 'invalid', desc='womble')
503 Traceback (most recent call last):
503 Traceback (most recent call last):
504 ...
504 ...
505 ConfigError: foo.invalid is not a valid womble ('somevalue')
505 ConfigError: foo.invalid is not a valid womble ('somevalue')
506 """
506 """
507
507
508 v = self.config(section, name, None, untrusted)
508 v = self.config(section, name, None, untrusted)
509 if v is None:
509 if v is None:
510 return default
510 return default
511 try:
511 try:
512 return convert(v)
512 return convert(v)
513 except ValueError:
513 except ValueError:
514 if desc is None:
514 if desc is None:
515 desc = convert.__name__
515 desc = convert.__name__
516 raise error.ConfigError(_("%s.%s is not a valid %s ('%s')")
516 raise error.ConfigError(_("%s.%s is not a valid %s ('%s')")
517 % (section, name, desc, v))
517 % (section, name, desc, v))
518
518
519 def configint(self, section, name, default=None, untrusted=False):
519 def configint(self, section, name, default=None, untrusted=False):
520 """parse a configuration element as an integer
520 """parse a configuration element as an integer
521
521
522 >>> u = ui(); s = 'foo'
522 >>> u = ui(); s = 'foo'
523 >>> u.setconfig(s, 'int1', '42')
523 >>> u.setconfig(s, 'int1', '42')
524 >>> u.configint(s, 'int1')
524 >>> u.configint(s, 'int1')
525 42
525 42
526 >>> u.setconfig(s, 'int2', '-42')
526 >>> u.setconfig(s, 'int2', '-42')
527 >>> u.configint(s, 'int2')
527 >>> u.configint(s, 'int2')
528 -42
528 -42
529 >>> u.configint(s, 'unknown', 7)
529 >>> u.configint(s, 'unknown', 7)
530 7
530 7
531 >>> u.setconfig(s, 'invalid', 'somevalue')
531 >>> u.setconfig(s, 'invalid', 'somevalue')
532 >>> u.configint(s, 'invalid')
532 >>> u.configint(s, 'invalid')
533 Traceback (most recent call last):
533 Traceback (most recent call last):
534 ...
534 ...
535 ConfigError: foo.invalid is not a valid integer ('somevalue')
535 ConfigError: foo.invalid is not a valid integer ('somevalue')
536 """
536 """
537
537
538 return self.configwith(int, section, name, default, 'integer',
538 return self.configwith(int, section, name, default, 'integer',
539 untrusted)
539 untrusted)
540
540
541 def configbytes(self, section, name, default=0, untrusted=False):
541 def configbytes(self, section, name, default=0, untrusted=False):
542 """parse a configuration element as a quantity in bytes
542 """parse a configuration element as a quantity in bytes
543
543
544 Units can be specified as b (bytes), k or kb (kilobytes), m or
544 Units can be specified as b (bytes), k or kb (kilobytes), m or
545 mb (megabytes), g or gb (gigabytes).
545 mb (megabytes), g or gb (gigabytes).
546
546
547 >>> u = ui(); s = 'foo'
547 >>> u = ui(); s = 'foo'
548 >>> u.setconfig(s, 'val1', '42')
548 >>> u.setconfig(s, 'val1', '42')
549 >>> u.configbytes(s, 'val1')
549 >>> u.configbytes(s, 'val1')
550 42
550 42
551 >>> u.setconfig(s, 'val2', '42.5 kb')
551 >>> u.setconfig(s, 'val2', '42.5 kb')
552 >>> u.configbytes(s, 'val2')
552 >>> u.configbytes(s, 'val2')
553 43520
553 43520
554 >>> u.configbytes(s, 'unknown', '7 MB')
554 >>> u.configbytes(s, 'unknown', '7 MB')
555 7340032
555 7340032
556 >>> u.setconfig(s, 'invalid', 'somevalue')
556 >>> u.setconfig(s, 'invalid', 'somevalue')
557 >>> u.configbytes(s, 'invalid')
557 >>> u.configbytes(s, 'invalid')
558 Traceback (most recent call last):
558 Traceback (most recent call last):
559 ...
559 ...
560 ConfigError: foo.invalid is not a byte quantity ('somevalue')
560 ConfigError: foo.invalid is not a byte quantity ('somevalue')
561 """
561 """
562
562
563 value = self.config(section, name, None, untrusted)
563 value = self.config(section, name, None, untrusted)
564 if value is None:
564 if value is None:
565 if not isinstance(default, str):
565 if not isinstance(default, str):
566 return default
566 return default
567 value = default
567 value = default
568 try:
568 try:
569 return util.sizetoint(value)
569 return util.sizetoint(value)
570 except error.ParseError:
570 except error.ParseError:
571 raise error.ConfigError(_("%s.%s is not a byte quantity ('%s')")
571 raise error.ConfigError(_("%s.%s is not a byte quantity ('%s')")
572 % (section, name, value))
572 % (section, name, value))
573
573
574 def configlist(self, section, name, default=None, untrusted=False):
574 def configlist(self, section, name, default=None, untrusted=False):
575 """parse a configuration element as a list of comma/space separated
575 """parse a configuration element as a list of comma/space separated
576 strings
576 strings
577
577
578 >>> u = ui(); s = 'foo'
578 >>> u = ui(); s = 'foo'
579 >>> u.setconfig(s, 'list1', 'this,is "a small" ,test')
579 >>> u.setconfig(s, 'list1', 'this,is "a small" ,test')
580 >>> u.configlist(s, 'list1')
580 >>> u.configlist(s, 'list1')
581 ['this', 'is', 'a small', 'test']
581 ['this', 'is', 'a small', 'test']
582 """
582 """
583 # default is not always a list
583 # default is not always a list
584 if isinstance(default, bytes):
584 if isinstance(default, bytes):
585 default = config.parselist(default)
585 default = config.parselist(default)
586 return self.configwith(config.parselist, section, name, default or [],
586 return self.configwith(config.parselist, section, name, default or [],
587 'list', untrusted)
587 'list', untrusted)
588
588
589 def hasconfig(self, section, name, untrusted=False):
589 def hasconfig(self, section, name, untrusted=False):
590 return self._data(untrusted).hasitem(section, name)
590 return self._data(untrusted).hasitem(section, name)
591
591
592 def has_section(self, section, untrusted=False):
592 def has_section(self, section, untrusted=False):
593 '''tell whether section exists in config.'''
593 '''tell whether section exists in config.'''
594 return section in self._data(untrusted)
594 return section in self._data(untrusted)
595
595
596 def configitems(self, section, untrusted=False, ignoresub=False):
596 def configitems(self, section, untrusted=False, ignoresub=False):
597 items = self._data(untrusted).items(section)
597 items = self._data(untrusted).items(section)
598 if ignoresub:
598 if ignoresub:
599 newitems = {}
599 newitems = {}
600 for k, v in items:
600 for k, v in items:
601 if ':' not in k:
601 if ':' not in k:
602 newitems[k] = v
602 newitems[k] = v
603 items = newitems.items()
603 items = newitems.items()
604 if self.debugflag and not untrusted and self._reportuntrusted:
604 if self.debugflag and not untrusted and self._reportuntrusted:
605 for k, v in self._ucfg.items(section):
605 for k, v in self._ucfg.items(section):
606 if self._tcfg.get(section, k) != v:
606 if self._tcfg.get(section, k) != v:
607 self.debug("ignoring untrusted configuration option "
607 self.debug("ignoring untrusted configuration option "
608 "%s.%s = %s\n" % (section, k, v))
608 "%s.%s = %s\n" % (section, k, v))
609 return items
609 return items
610
610
611 def walkconfig(self, untrusted=False):
611 def walkconfig(self, untrusted=False):
612 cfg = self._data(untrusted)
612 cfg = self._data(untrusted)
613 for section in cfg.sections():
613 for section in cfg.sections():
614 for name, value in self.configitems(section, untrusted):
614 for name, value in self.configitems(section, untrusted):
615 yield section, name, value
615 yield section, name, value
616
616
617 def plain(self, feature=None):
617 def plain(self, feature=None):
618 '''is plain mode active?
618 '''is plain mode active?
619
619
620 Plain mode means that all configuration variables which affect
620 Plain mode means that all configuration variables which affect
621 the behavior and output of Mercurial should be
621 the behavior and output of Mercurial should be
622 ignored. Additionally, the output should be stable,
622 ignored. Additionally, the output should be stable,
623 reproducible and suitable for use in scripts or applications.
623 reproducible and suitable for use in scripts or applications.
624
624
625 The only way to trigger plain mode is by setting either the
625 The only way to trigger plain mode is by setting either the
626 `HGPLAIN' or `HGPLAINEXCEPT' environment variables.
626 `HGPLAIN' or `HGPLAINEXCEPT' environment variables.
627
627
628 The return value can either be
628 The return value can either be
629 - False if HGPLAIN is not set, or feature is in HGPLAINEXCEPT
629 - False if HGPLAIN is not set, or feature is in HGPLAINEXCEPT
630 - True otherwise
630 - True otherwise
631 '''
631 '''
632 if ('HGPLAIN' not in encoding.environ and
632 if ('HGPLAIN' not in encoding.environ and
633 'HGPLAINEXCEPT' not in encoding.environ):
633 'HGPLAINEXCEPT' not in encoding.environ):
634 return False
634 return False
635 exceptions = encoding.environ.get('HGPLAINEXCEPT',
635 exceptions = encoding.environ.get('HGPLAINEXCEPT',
636 '').strip().split(',')
636 '').strip().split(',')
637 if feature and exceptions:
637 if feature and exceptions:
638 return feature not in exceptions
638 return feature not in exceptions
639 return True
639 return True
640
640
641 def username(self):
641 def username(self):
642 """Return default username to be used in commits.
642 """Return default username to be used in commits.
643
643
644 Searched in this order: $HGUSER, [ui] section of hgrcs, $EMAIL
644 Searched in this order: $HGUSER, [ui] section of hgrcs, $EMAIL
645 and stop searching if one of these is set.
645 and stop searching if one of these is set.
646 If not found and ui.askusername is True, ask the user, else use
646 If not found and ui.askusername is True, ask the user, else use
647 ($LOGNAME or $USER or $LNAME or $USERNAME) + "@full.hostname".
647 ($LOGNAME or $USER or $LNAME or $USERNAME) + "@full.hostname".
648 """
648 """
649 user = encoding.environ.get("HGUSER")
649 user = encoding.environ.get("HGUSER")
650 if user is None:
650 if user is None:
651 user = self.config("ui", ["username", "user"])
651 user = self.config("ui", ["username", "user"])
652 if user is not None:
652 if user is not None:
653 user = os.path.expandvars(user)
653 user = os.path.expandvars(user)
654 if user is None:
654 if user is None:
655 user = encoding.environ.get("EMAIL")
655 user = encoding.environ.get("EMAIL")
656 if user is None and self.configbool("ui", "askusername"):
656 if user is None and self.configbool("ui", "askusername"):
657 user = self.prompt(_("enter a commit username:"), default=None)
657 user = self.prompt(_("enter a commit username:"), default=None)
658 if user is None and not self.interactive():
658 if user is None and not self.interactive():
659 try:
659 try:
660 user = '%s@%s' % (util.getuser(), socket.getfqdn())
660 user = '%s@%s' % (util.getuser(), socket.getfqdn())
661 self.warn(_("no username found, using '%s' instead\n") % user)
661 self.warn(_("no username found, using '%s' instead\n") % user)
662 except KeyError:
662 except KeyError:
663 pass
663 pass
664 if not user:
664 if not user:
665 raise error.Abort(_('no username supplied'),
665 raise error.Abort(_('no username supplied'),
666 hint=_("use 'hg config --edit' "
666 hint=_("use 'hg config --edit' "
667 'to set your username'))
667 'to set your username'))
668 if "\n" in user:
668 if "\n" in user:
669 raise error.Abort(_("username %s contains a newline\n")
669 raise error.Abort(_("username %s contains a newline\n")
670 % repr(user))
670 % repr(user))
671 return user
671 return user
672
672
673 def shortuser(self, user):
673 def shortuser(self, user):
674 """Return a short representation of a user name or email address."""
674 """Return a short representation of a user name or email address."""
675 if not self.verbose:
675 if not self.verbose:
676 user = util.shortuser(user)
676 user = util.shortuser(user)
677 return user
677 return user
678
678
679 def expandpath(self, loc, default=None):
679 def expandpath(self, loc, default=None):
680 """Return repository location relative to cwd or from [paths]"""
680 """Return repository location relative to cwd or from [paths]"""
681 try:
681 try:
682 p = self.paths.getpath(loc)
682 p = self.paths.getpath(loc)
683 if p:
683 if p:
684 return p.rawloc
684 return p.rawloc
685 except error.RepoError:
685 except error.RepoError:
686 pass
686 pass
687
687
688 if default:
688 if default:
689 try:
689 try:
690 p = self.paths.getpath(default)
690 p = self.paths.getpath(default)
691 if p:
691 if p:
692 return p.rawloc
692 return p.rawloc
693 except error.RepoError:
693 except error.RepoError:
694 pass
694 pass
695
695
696 return loc
696 return loc
697
697
698 @util.propertycache
698 @util.propertycache
699 def paths(self):
699 def paths(self):
700 return paths(self)
700 return paths(self)
701
701
702 def pushbuffer(self, error=False, subproc=False, labeled=False):
702 def pushbuffer(self, error=False, subproc=False, labeled=False):
703 """install a buffer to capture standard output of the ui object
703 """install a buffer to capture standard output of the ui object
704
704
705 If error is True, the error output will be captured too.
705 If error is True, the error output will be captured too.
706
706
707 If subproc is True, output from subprocesses (typically hooks) will be
707 If subproc is True, output from subprocesses (typically hooks) will be
708 captured too.
708 captured too.
709
709
710 If labeled is True, any labels associated with buffered
710 If labeled is True, any labels associated with buffered
711 output will be handled. By default, this has no effect
711 output will be handled. By default, this has no effect
712 on the output returned, but extensions and GUI tools may
712 on the output returned, but extensions and GUI tools may
713 handle this argument and returned styled output. If output
713 handle this argument and returned styled output. If output
714 is being buffered so it can be captured and parsed or
714 is being buffered so it can be captured and parsed or
715 processed, labeled should not be set to True.
715 processed, labeled should not be set to True.
716 """
716 """
717 self._buffers.append([])
717 self._buffers.append([])
718 self._bufferstates.append((error, subproc, labeled))
718 self._bufferstates.append((error, subproc, labeled))
719 self._bufferapplylabels = labeled
719 self._bufferapplylabels = labeled
720
720
721 def popbuffer(self):
721 def popbuffer(self):
722 '''pop the last buffer and return the buffered output'''
722 '''pop the last buffer and return the buffered output'''
723 self._bufferstates.pop()
723 self._bufferstates.pop()
724 if self._bufferstates:
724 if self._bufferstates:
725 self._bufferapplylabels = self._bufferstates[-1][2]
725 self._bufferapplylabels = self._bufferstates[-1][2]
726 else:
726 else:
727 self._bufferapplylabels = None
727 self._bufferapplylabels = None
728
728
729 return "".join(self._buffers.pop())
729 return "".join(self._buffers.pop())
730
730
731 def write(self, *args, **opts):
731 def write(self, *args, **opts):
732 '''write args to output
732 '''write args to output
733
733
734 By default, this method simply writes to the buffer or stdout.
734 By default, this method simply writes to the buffer or stdout.
735 Color mode can be set on the UI class to have the output decorated
735 Color mode can be set on the UI class to have the output decorated
736 with color modifier before being written to stdout.
736 with color modifier before being written to stdout.
737
737
738 The color used is controlled by an optional keyword argument, "label".
738 The color used is controlled by an optional keyword argument, "label".
739 This should be a string containing label names separated by space.
739 This should be a string containing label names separated by space.
740 Label names take the form of "topic.type". For example, ui.debug()
740 Label names take the form of "topic.type". For example, ui.debug()
741 issues a label of "ui.debug".
741 issues a label of "ui.debug".
742
742
743 When labeling output for a specific command, a label of
743 When labeling output for a specific command, a label of
744 "cmdname.type" is recommended. For example, status issues
744 "cmdname.type" is recommended. For example, status issues
745 a label of "status.modified" for modified files.
745 a label of "status.modified" for modified files.
746 '''
746 '''
747 if self._buffers and not opts.get('prompt', False):
747 if self._buffers and not opts.get('prompt', False):
748 if self._bufferapplylabels:
748 if self._bufferapplylabels:
749 label = opts.get('label', '')
749 label = opts.get('label', '')
750 self._buffers[-1].extend(self.label(a, label) for a in args)
750 self._buffers[-1].extend(self.label(a, label) for a in args)
751 else:
751 else:
752 self._buffers[-1].extend(args)
752 self._buffers[-1].extend(args)
753 elif self._colormode == 'win32':
753 elif self._colormode == 'win32':
754 # windows color printing is its own can of crab, defer to
754 # windows color printing is its own can of crab, defer to
755 # the color module and that is it.
755 # the color module and that is it.
756 color.win32print(self, self._write, *args, **opts)
756 color.win32print(self, self._write, *args, **opts)
757 else:
757 else:
758 msgs = args
758 msgs = args
759 if self._colormode is not None:
759 if self._colormode is not None:
760 label = opts.get('label', '')
760 label = opts.get('label', '')
761 msgs = [self.label(a, label) for a in args]
761 msgs = [self.label(a, label) for a in args]
762 self._write(*msgs, **opts)
762 self._write(*msgs, **opts)
763
763
764 def _write(self, *msgs, **opts):
764 def _write(self, *msgs, **opts):
765 self._progclear()
765 self._progclear()
766 # opencode timeblockedsection because this is a critical path
766 # opencode timeblockedsection because this is a critical path
767 starttime = util.timer()
767 starttime = util.timer()
768 try:
768 try:
769 for a in msgs:
769 for a in msgs:
770 self.fout.write(a)
770 self.fout.write(a)
771 except IOError as err:
771 except IOError as err:
772 raise error.StdioError(err)
772 raise error.StdioError(err)
773 finally:
773 finally:
774 self._blockedtimes['stdio_blocked'] += \
774 self._blockedtimes['stdio_blocked'] += \
775 (util.timer() - starttime) * 1000
775 (util.timer() - starttime) * 1000
776
776
777 def write_err(self, *args, **opts):
777 def write_err(self, *args, **opts):
778 self._progclear()
778 self._progclear()
779 if self._bufferstates and self._bufferstates[-1][0]:
779 if self._bufferstates and self._bufferstates[-1][0]:
780 self.write(*args, **opts)
780 self.write(*args, **opts)
781 elif self._colormode == 'win32':
781 elif self._colormode == 'win32':
782 # windows color printing is its own can of crab, defer to
782 # windows color printing is its own can of crab, defer to
783 # the color module and that is it.
783 # the color module and that is it.
784 color.win32print(self, self._write_err, *args, **opts)
784 color.win32print(self, self._write_err, *args, **opts)
785 else:
785 else:
786 msgs = args
786 msgs = args
787 if self._colormode is not None:
787 if self._colormode is not None:
788 label = opts.get('label', '')
788 label = opts.get('label', '')
789 msgs = [self.label(a, label) for a in args]
789 msgs = [self.label(a, label) for a in args]
790 self._write_err(*msgs, **opts)
790 self._write_err(*msgs, **opts)
791
791
792 def _write_err(self, *msgs, **opts):
792 def _write_err(self, *msgs, **opts):
793 try:
793 try:
794 with self.timeblockedsection('stdio'):
794 with self.timeblockedsection('stdio'):
795 if not getattr(self.fout, 'closed', False):
795 if not getattr(self.fout, 'closed', False):
796 self.fout.flush()
796 self.fout.flush()
797 for a in msgs:
797 for a in msgs:
798 self.ferr.write(a)
798 self.ferr.write(a)
799 # stderr may be buffered under win32 when redirected to files,
799 # stderr may be buffered under win32 when redirected to files,
800 # including stdout.
800 # including stdout.
801 if not getattr(self.ferr, 'closed', False):
801 if not getattr(self.ferr, 'closed', False):
802 self.ferr.flush()
802 self.ferr.flush()
803 except IOError as inst:
803 except IOError as inst:
804 raise error.StdioError(inst)
804 raise error.StdioError(inst)
805
805
806 def flush(self):
806 def flush(self):
807 # opencode timeblockedsection because this is a critical path
807 # opencode timeblockedsection because this is a critical path
808 starttime = util.timer()
808 starttime = util.timer()
809 try:
809 try:
810 try: self.fout.flush()
810 try:
811 except (IOError, ValueError): pass
811 self.fout.flush()
812 try: self.ferr.flush()
812 except IOError as err:
813 except (IOError, ValueError): pass
813 raise error.StdioError(err)
814 finally:
815 try:
816 self.ferr.flush()
817 except IOError as err:
818 raise error.StdioError(err)
814 finally:
819 finally:
815 self._blockedtimes['stdio_blocked'] += \
820 self._blockedtimes['stdio_blocked'] += \
816 (util.timer() - starttime) * 1000
821 (util.timer() - starttime) * 1000
817
822
818 def _isatty(self, fh):
823 def _isatty(self, fh):
819 if self.configbool('ui', 'nontty', False):
824 if self.configbool('ui', 'nontty', False):
820 return False
825 return False
821 return util.isatty(fh)
826 return util.isatty(fh)
822
827
823 def disablepager(self):
828 def disablepager(self):
824 self._disablepager = True
829 self._disablepager = True
825
830
826 def pager(self, command):
831 def pager(self, command):
827 """Start a pager for subsequent command output.
832 """Start a pager for subsequent command output.
828
833
829 Commands which produce a long stream of output should call
834 Commands which produce a long stream of output should call
830 this function to activate the user's preferred pagination
835 this function to activate the user's preferred pagination
831 mechanism (which may be no pager). Calling this function
836 mechanism (which may be no pager). Calling this function
832 precludes any future use of interactive functionality, such as
837 precludes any future use of interactive functionality, such as
833 prompting the user or activating curses.
838 prompting the user or activating curses.
834
839
835 Args:
840 Args:
836 command: The full, non-aliased name of the command. That is, "log"
841 command: The full, non-aliased name of the command. That is, "log"
837 not "history, "summary" not "summ", etc.
842 not "history, "summary" not "summ", etc.
838 """
843 """
839 if (self._disablepager
844 if (self._disablepager
840 or self.pageractive
845 or self.pageractive
841 or command in self.configlist('pager', 'ignore')
846 or command in self.configlist('pager', 'ignore')
842 or not self.configbool('pager', 'enable', True)
847 or not self.configbool('pager', 'enable', True)
843 or not self.configbool('pager', 'attend-' + command, True)
848 or not self.configbool('pager', 'attend-' + command, True)
844 # TODO: if we want to allow HGPLAINEXCEPT=pager,
849 # TODO: if we want to allow HGPLAINEXCEPT=pager,
845 # formatted() will need some adjustment.
850 # formatted() will need some adjustment.
846 or not self.formatted()
851 or not self.formatted()
847 or self.plain()
852 or self.plain()
848 # TODO: expose debugger-enabled on the UI object
853 # TODO: expose debugger-enabled on the UI object
849 or '--debugger' in pycompat.sysargv):
854 or '--debugger' in pycompat.sysargv):
850 # We only want to paginate if the ui appears to be
855 # We only want to paginate if the ui appears to be
851 # interactive, the user didn't say HGPLAIN or
856 # interactive, the user didn't say HGPLAIN or
852 # HGPLAINEXCEPT=pager, and the user didn't specify --debug.
857 # HGPLAINEXCEPT=pager, and the user didn't specify --debug.
853 return
858 return
854
859
855 fallbackpager = 'more'
860 fallbackpager = 'more'
856 pagercmd = self.config('pager', 'pager', fallbackpager)
861 pagercmd = self.config('pager', 'pager', fallbackpager)
857 if not pagercmd:
862 if not pagercmd:
858 return
863 return
859
864
860 pagerenv = {}
865 pagerenv = {}
861 for name, value in rcutil.defaultpagerenv().items():
866 for name, value in rcutil.defaultpagerenv().items():
862 if name not in encoding.environ:
867 if name not in encoding.environ:
863 pagerenv[name] = value
868 pagerenv[name] = value
864
869
865 self.debug('starting pager for command %r\n' % command)
870 self.debug('starting pager for command %r\n' % command)
866 self.flush()
871 self.flush()
867
872
868 wasformatted = self.formatted()
873 wasformatted = self.formatted()
869 if util.safehasattr(signal, "SIGPIPE"):
874 if util.safehasattr(signal, "SIGPIPE"):
870 signal.signal(signal.SIGPIPE, _catchterm)
875 signal.signal(signal.SIGPIPE, _catchterm)
871 if self._runpager(pagercmd, pagerenv):
876 if self._runpager(pagercmd, pagerenv):
872 self.pageractive = True
877 self.pageractive = True
873 # Preserve the formatted-ness of the UI. This is important
878 # Preserve the formatted-ness of the UI. This is important
874 # because we mess with stdout, which might confuse
879 # because we mess with stdout, which might confuse
875 # auto-detection of things being formatted.
880 # auto-detection of things being formatted.
876 self.setconfig('ui', 'formatted', wasformatted, 'pager')
881 self.setconfig('ui', 'formatted', wasformatted, 'pager')
877 self.setconfig('ui', 'interactive', False, 'pager')
882 self.setconfig('ui', 'interactive', False, 'pager')
878
883
879 # If pagermode differs from color.mode, reconfigure color now that
884 # If pagermode differs from color.mode, reconfigure color now that
880 # pageractive is set.
885 # pageractive is set.
881 cm = self._colormode
886 cm = self._colormode
882 if cm != self.config('color', 'pagermode', cm):
887 if cm != self.config('color', 'pagermode', cm):
883 color.setup(self)
888 color.setup(self)
884 else:
889 else:
885 # If the pager can't be spawned in dispatch when --pager=on is
890 # If the pager can't be spawned in dispatch when --pager=on is
886 # given, don't try again when the command runs, to avoid a duplicate
891 # given, don't try again when the command runs, to avoid a duplicate
887 # warning about a missing pager command.
892 # warning about a missing pager command.
888 self.disablepager()
893 self.disablepager()
889
894
890 def _runpager(self, command, env=None):
895 def _runpager(self, command, env=None):
891 """Actually start the pager and set up file descriptors.
896 """Actually start the pager and set up file descriptors.
892
897
893 This is separate in part so that extensions (like chg) can
898 This is separate in part so that extensions (like chg) can
894 override how a pager is invoked.
899 override how a pager is invoked.
895 """
900 """
896 if command == 'cat':
901 if command == 'cat':
897 # Save ourselves some work.
902 # Save ourselves some work.
898 return False
903 return False
899 # If the command doesn't contain any of these characters, we
904 # If the command doesn't contain any of these characters, we
900 # assume it's a binary and exec it directly. This means for
905 # assume it's a binary and exec it directly. This means for
901 # simple pager command configurations, we can degrade
906 # simple pager command configurations, we can degrade
902 # gracefully and tell the user about their broken pager.
907 # gracefully and tell the user about their broken pager.
903 shell = any(c in command for c in "|&;<>()$`\\\"' \t\n*?[#~=%")
908 shell = any(c in command for c in "|&;<>()$`\\\"' \t\n*?[#~=%")
904
909
905 if pycompat.osname == 'nt' and not shell:
910 if pycompat.osname == 'nt' and not shell:
906 # Window's built-in `more` cannot be invoked with shell=False, but
911 # Window's built-in `more` cannot be invoked with shell=False, but
907 # its `more.com` can. Hide this implementation detail from the
912 # its `more.com` can. Hide this implementation detail from the
908 # user so we can also get sane bad PAGER behavior. MSYS has
913 # user so we can also get sane bad PAGER behavior. MSYS has
909 # `more.exe`, so do a cmd.exe style resolution of the executable to
914 # `more.exe`, so do a cmd.exe style resolution of the executable to
910 # determine which one to use.
915 # determine which one to use.
911 fullcmd = util.findexe(command)
916 fullcmd = util.findexe(command)
912 if not fullcmd:
917 if not fullcmd:
913 self.warn(_("missing pager command '%s', skipping pager\n")
918 self.warn(_("missing pager command '%s', skipping pager\n")
914 % command)
919 % command)
915 return False
920 return False
916
921
917 command = fullcmd
922 command = fullcmd
918
923
919 try:
924 try:
920 pager = subprocess.Popen(
925 pager = subprocess.Popen(
921 command, shell=shell, bufsize=-1,
926 command, shell=shell, bufsize=-1,
922 close_fds=util.closefds, stdin=subprocess.PIPE,
927 close_fds=util.closefds, stdin=subprocess.PIPE,
923 stdout=util.stdout, stderr=util.stderr,
928 stdout=util.stdout, stderr=util.stderr,
924 env=util.shellenviron(env))
929 env=util.shellenviron(env))
925 except OSError as e:
930 except OSError as e:
926 if e.errno == errno.ENOENT and not shell:
931 if e.errno == errno.ENOENT and not shell:
927 self.warn(_("missing pager command '%s', skipping pager\n")
932 self.warn(_("missing pager command '%s', skipping pager\n")
928 % command)
933 % command)
929 return False
934 return False
930 raise
935 raise
931
936
932 # back up original file descriptors
937 # back up original file descriptors
933 stdoutfd = os.dup(util.stdout.fileno())
938 stdoutfd = os.dup(util.stdout.fileno())
934 stderrfd = os.dup(util.stderr.fileno())
939 stderrfd = os.dup(util.stderr.fileno())
935
940
936 os.dup2(pager.stdin.fileno(), util.stdout.fileno())
941 os.dup2(pager.stdin.fileno(), util.stdout.fileno())
937 if self._isatty(util.stderr):
942 if self._isatty(util.stderr):
938 os.dup2(pager.stdin.fileno(), util.stderr.fileno())
943 os.dup2(pager.stdin.fileno(), util.stderr.fileno())
939
944
940 @self.atexit
945 @self.atexit
941 def killpager():
946 def killpager():
942 if util.safehasattr(signal, "SIGINT"):
947 if util.safehasattr(signal, "SIGINT"):
943 signal.signal(signal.SIGINT, signal.SIG_IGN)
948 signal.signal(signal.SIGINT, signal.SIG_IGN)
944 # restore original fds, closing pager.stdin copies in the process
949 # restore original fds, closing pager.stdin copies in the process
945 os.dup2(stdoutfd, util.stdout.fileno())
950 os.dup2(stdoutfd, util.stdout.fileno())
946 os.dup2(stderrfd, util.stderr.fileno())
951 os.dup2(stderrfd, util.stderr.fileno())
947 pager.stdin.close()
952 pager.stdin.close()
948 pager.wait()
953 pager.wait()
949
954
950 return True
955 return True
951
956
952 def atexit(self, func, *args, **kwargs):
957 def atexit(self, func, *args, **kwargs):
953 '''register a function to run after dispatching a request
958 '''register a function to run after dispatching a request
954
959
955 Handlers do not stay registered across request boundaries.'''
960 Handlers do not stay registered across request boundaries.'''
956 self._exithandlers.append((func, args, kwargs))
961 self._exithandlers.append((func, args, kwargs))
957 return func
962 return func
958
963
959 def interface(self, feature):
964 def interface(self, feature):
960 """what interface to use for interactive console features?
965 """what interface to use for interactive console features?
961
966
962 The interface is controlled by the value of `ui.interface` but also by
967 The interface is controlled by the value of `ui.interface` but also by
963 the value of feature-specific configuration. For example:
968 the value of feature-specific configuration. For example:
964
969
965 ui.interface.histedit = text
970 ui.interface.histedit = text
966 ui.interface.chunkselector = curses
971 ui.interface.chunkselector = curses
967
972
968 Here the features are "histedit" and "chunkselector".
973 Here the features are "histedit" and "chunkselector".
969
974
970 The configuration above means that the default interfaces for commands
975 The configuration above means that the default interfaces for commands
971 is curses, the interface for histedit is text and the interface for
976 is curses, the interface for histedit is text and the interface for
972 selecting chunk is crecord (the best curses interface available).
977 selecting chunk is crecord (the best curses interface available).
973
978
974 Consider the following example:
979 Consider the following example:
975 ui.interface = curses
980 ui.interface = curses
976 ui.interface.histedit = text
981 ui.interface.histedit = text
977
982
978 Then histedit will use the text interface and chunkselector will use
983 Then histedit will use the text interface and chunkselector will use
979 the default curses interface (crecord at the moment).
984 the default curses interface (crecord at the moment).
980 """
985 """
981 alldefaults = frozenset(["text", "curses"])
986 alldefaults = frozenset(["text", "curses"])
982
987
983 featureinterfaces = {
988 featureinterfaces = {
984 "chunkselector": [
989 "chunkselector": [
985 "text",
990 "text",
986 "curses",
991 "curses",
987 ]
992 ]
988 }
993 }
989
994
990 # Feature-specific interface
995 # Feature-specific interface
991 if feature not in featureinterfaces.keys():
996 if feature not in featureinterfaces.keys():
992 # Programming error, not user error
997 # Programming error, not user error
993 raise ValueError("Unknown feature requested %s" % feature)
998 raise ValueError("Unknown feature requested %s" % feature)
994
999
995 availableinterfaces = frozenset(featureinterfaces[feature])
1000 availableinterfaces = frozenset(featureinterfaces[feature])
996 if alldefaults > availableinterfaces:
1001 if alldefaults > availableinterfaces:
997 # Programming error, not user error. We need a use case to
1002 # Programming error, not user error. We need a use case to
998 # define the right thing to do here.
1003 # define the right thing to do here.
999 raise ValueError(
1004 raise ValueError(
1000 "Feature %s does not handle all default interfaces" %
1005 "Feature %s does not handle all default interfaces" %
1001 feature)
1006 feature)
1002
1007
1003 if self.plain():
1008 if self.plain():
1004 return "text"
1009 return "text"
1005
1010
1006 # Default interface for all the features
1011 # Default interface for all the features
1007 defaultinterface = "text"
1012 defaultinterface = "text"
1008 i = self.config("ui", "interface", None)
1013 i = self.config("ui", "interface", None)
1009 if i in alldefaults:
1014 if i in alldefaults:
1010 defaultinterface = i
1015 defaultinterface = i
1011
1016
1012 choseninterface = defaultinterface
1017 choseninterface = defaultinterface
1013 f = self.config("ui", "interface.%s" % feature, None)
1018 f = self.config("ui", "interface.%s" % feature, None)
1014 if f in availableinterfaces:
1019 if f in availableinterfaces:
1015 choseninterface = f
1020 choseninterface = f
1016
1021
1017 if i is not None and defaultinterface != i:
1022 if i is not None and defaultinterface != i:
1018 if f is not None:
1023 if f is not None:
1019 self.warn(_("invalid value for ui.interface: %s\n") %
1024 self.warn(_("invalid value for ui.interface: %s\n") %
1020 (i,))
1025 (i,))
1021 else:
1026 else:
1022 self.warn(_("invalid value for ui.interface: %s (using %s)\n") %
1027 self.warn(_("invalid value for ui.interface: %s (using %s)\n") %
1023 (i, choseninterface))
1028 (i, choseninterface))
1024 if f is not None and choseninterface != f:
1029 if f is not None and choseninterface != f:
1025 self.warn(_("invalid value for ui.interface.%s: %s (using %s)\n") %
1030 self.warn(_("invalid value for ui.interface.%s: %s (using %s)\n") %
1026 (feature, f, choseninterface))
1031 (feature, f, choseninterface))
1027
1032
1028 return choseninterface
1033 return choseninterface
1029
1034
1030 def interactive(self):
1035 def interactive(self):
1031 '''is interactive input allowed?
1036 '''is interactive input allowed?
1032
1037
1033 An interactive session is a session where input can be reasonably read
1038 An interactive session is a session where input can be reasonably read
1034 from `sys.stdin'. If this function returns false, any attempt to read
1039 from `sys.stdin'. If this function returns false, any attempt to read
1035 from stdin should fail with an error, unless a sensible default has been
1040 from stdin should fail with an error, unless a sensible default has been
1036 specified.
1041 specified.
1037
1042
1038 Interactiveness is triggered by the value of the `ui.interactive'
1043 Interactiveness is triggered by the value of the `ui.interactive'
1039 configuration variable or - if it is unset - when `sys.stdin' points
1044 configuration variable or - if it is unset - when `sys.stdin' points
1040 to a terminal device.
1045 to a terminal device.
1041
1046
1042 This function refers to input only; for output, see `ui.formatted()'.
1047 This function refers to input only; for output, see `ui.formatted()'.
1043 '''
1048 '''
1044 i = self.configbool("ui", "interactive", None)
1049 i = self.configbool("ui", "interactive", None)
1045 if i is None:
1050 if i is None:
1046 # some environments replace stdin without implementing isatty
1051 # some environments replace stdin without implementing isatty
1047 # usually those are non-interactive
1052 # usually those are non-interactive
1048 return self._isatty(self.fin)
1053 return self._isatty(self.fin)
1049
1054
1050 return i
1055 return i
1051
1056
1052 def termwidth(self):
1057 def termwidth(self):
1053 '''how wide is the terminal in columns?
1058 '''how wide is the terminal in columns?
1054 '''
1059 '''
1055 if 'COLUMNS' in encoding.environ:
1060 if 'COLUMNS' in encoding.environ:
1056 try:
1061 try:
1057 return int(encoding.environ['COLUMNS'])
1062 return int(encoding.environ['COLUMNS'])
1058 except ValueError:
1063 except ValueError:
1059 pass
1064 pass
1060 return scmutil.termsize(self)[0]
1065 return scmutil.termsize(self)[0]
1061
1066
1062 def formatted(self):
1067 def formatted(self):
1063 '''should formatted output be used?
1068 '''should formatted output be used?
1064
1069
1065 It is often desirable to format the output to suite the output medium.
1070 It is often desirable to format the output to suite the output medium.
1066 Examples of this are truncating long lines or colorizing messages.
1071 Examples of this are truncating long lines or colorizing messages.
1067 However, this is not often not desirable when piping output into other
1072 However, this is not often not desirable when piping output into other
1068 utilities, e.g. `grep'.
1073 utilities, e.g. `grep'.
1069
1074
1070 Formatted output is triggered by the value of the `ui.formatted'
1075 Formatted output is triggered by the value of the `ui.formatted'
1071 configuration variable or - if it is unset - when `sys.stdout' points
1076 configuration variable or - if it is unset - when `sys.stdout' points
1072 to a terminal device. Please note that `ui.formatted' should be
1077 to a terminal device. Please note that `ui.formatted' should be
1073 considered an implementation detail; it is not intended for use outside
1078 considered an implementation detail; it is not intended for use outside
1074 Mercurial or its extensions.
1079 Mercurial or its extensions.
1075
1080
1076 This function refers to output only; for input, see `ui.interactive()'.
1081 This function refers to output only; for input, see `ui.interactive()'.
1077 This function always returns false when in plain mode, see `ui.plain()'.
1082 This function always returns false when in plain mode, see `ui.plain()'.
1078 '''
1083 '''
1079 if self.plain():
1084 if self.plain():
1080 return False
1085 return False
1081
1086
1082 i = self.configbool("ui", "formatted", None)
1087 i = self.configbool("ui", "formatted", None)
1083 if i is None:
1088 if i is None:
1084 # some environments replace stdout without implementing isatty
1089 # some environments replace stdout without implementing isatty
1085 # usually those are non-interactive
1090 # usually those are non-interactive
1086 return self._isatty(self.fout)
1091 return self._isatty(self.fout)
1087
1092
1088 return i
1093 return i
1089
1094
1090 def _readline(self, prompt=''):
1095 def _readline(self, prompt=''):
1091 if self._isatty(self.fin):
1096 if self._isatty(self.fin):
1092 try:
1097 try:
1093 # magically add command line editing support, where
1098 # magically add command line editing support, where
1094 # available
1099 # available
1095 import readline
1100 import readline
1096 # force demandimport to really load the module
1101 # force demandimport to really load the module
1097 readline.read_history_file
1102 readline.read_history_file
1098 # windows sometimes raises something other than ImportError
1103 # windows sometimes raises something other than ImportError
1099 except Exception:
1104 except Exception:
1100 pass
1105 pass
1101
1106
1102 # call write() so output goes through subclassed implementation
1107 # call write() so output goes through subclassed implementation
1103 # e.g. color extension on Windows
1108 # e.g. color extension on Windows
1104 self.write(prompt, prompt=True)
1109 self.write(prompt, prompt=True)
1105
1110
1106 # instead of trying to emulate raw_input, swap (self.fin,
1111 # instead of trying to emulate raw_input, swap (self.fin,
1107 # self.fout) with (sys.stdin, sys.stdout)
1112 # self.fout) with (sys.stdin, sys.stdout)
1108 oldin = sys.stdin
1113 oldin = sys.stdin
1109 oldout = sys.stdout
1114 oldout = sys.stdout
1110 sys.stdin = self.fin
1115 sys.stdin = self.fin
1111 sys.stdout = self.fout
1116 sys.stdout = self.fout
1112 # prompt ' ' must exist; otherwise readline may delete entire line
1117 # prompt ' ' must exist; otherwise readline may delete entire line
1113 # - http://bugs.python.org/issue12833
1118 # - http://bugs.python.org/issue12833
1114 with self.timeblockedsection('stdio'):
1119 with self.timeblockedsection('stdio'):
1115 line = raw_input(' ')
1120 line = raw_input(' ')
1116 sys.stdin = oldin
1121 sys.stdin = oldin
1117 sys.stdout = oldout
1122 sys.stdout = oldout
1118
1123
1119 # When stdin is in binary mode on Windows, it can cause
1124 # When stdin is in binary mode on Windows, it can cause
1120 # raw_input() to emit an extra trailing carriage return
1125 # raw_input() to emit an extra trailing carriage return
1121 if pycompat.oslinesep == '\r\n' and line and line[-1] == '\r':
1126 if pycompat.oslinesep == '\r\n' and line and line[-1] == '\r':
1122 line = line[:-1]
1127 line = line[:-1]
1123 return line
1128 return line
1124
1129
1125 def prompt(self, msg, default="y"):
1130 def prompt(self, msg, default="y"):
1126 """Prompt user with msg, read response.
1131 """Prompt user with msg, read response.
1127 If ui is not interactive, the default is returned.
1132 If ui is not interactive, the default is returned.
1128 """
1133 """
1129 if not self.interactive():
1134 if not self.interactive():
1130 self.write(msg, ' ', default or '', "\n")
1135 self.write(msg, ' ', default or '', "\n")
1131 return default
1136 return default
1132 try:
1137 try:
1133 r = self._readline(self.label(msg, 'ui.prompt'))
1138 r = self._readline(self.label(msg, 'ui.prompt'))
1134 if not r:
1139 if not r:
1135 r = default
1140 r = default
1136 if self.configbool('ui', 'promptecho'):
1141 if self.configbool('ui', 'promptecho'):
1137 self.write(r, "\n")
1142 self.write(r, "\n")
1138 return r
1143 return r
1139 except EOFError:
1144 except EOFError:
1140 raise error.ResponseExpected()
1145 raise error.ResponseExpected()
1141
1146
1142 @staticmethod
1147 @staticmethod
1143 def extractchoices(prompt):
1148 def extractchoices(prompt):
1144 """Extract prompt message and list of choices from specified prompt.
1149 """Extract prompt message and list of choices from specified prompt.
1145
1150
1146 This returns tuple "(message, choices)", and "choices" is the
1151 This returns tuple "(message, choices)", and "choices" is the
1147 list of tuple "(response character, text without &)".
1152 list of tuple "(response character, text without &)".
1148
1153
1149 >>> ui.extractchoices("awake? $$ &Yes $$ &No")
1154 >>> ui.extractchoices("awake? $$ &Yes $$ &No")
1150 ('awake? ', [('y', 'Yes'), ('n', 'No')])
1155 ('awake? ', [('y', 'Yes'), ('n', 'No')])
1151 >>> ui.extractchoices("line\\nbreak? $$ &Yes $$ &No")
1156 >>> ui.extractchoices("line\\nbreak? $$ &Yes $$ &No")
1152 ('line\\nbreak? ', [('y', 'Yes'), ('n', 'No')])
1157 ('line\\nbreak? ', [('y', 'Yes'), ('n', 'No')])
1153 >>> ui.extractchoices("want lots of $$money$$?$$Ye&s$$N&o")
1158 >>> ui.extractchoices("want lots of $$money$$?$$Ye&s$$N&o")
1154 ('want lots of $$money$$?', [('s', 'Yes'), ('o', 'No')])
1159 ('want lots of $$money$$?', [('s', 'Yes'), ('o', 'No')])
1155 """
1160 """
1156
1161
1157 # Sadly, the prompt string may have been built with a filename
1162 # Sadly, the prompt string may have been built with a filename
1158 # containing "$$" so let's try to find the first valid-looking
1163 # containing "$$" so let's try to find the first valid-looking
1159 # prompt to start parsing. Sadly, we also can't rely on
1164 # prompt to start parsing. Sadly, we also can't rely on
1160 # choices containing spaces, ASCII, or basically anything
1165 # choices containing spaces, ASCII, or basically anything
1161 # except an ampersand followed by a character.
1166 # except an ampersand followed by a character.
1162 m = re.match(r'(?s)(.+?)\$\$([^\$]*&[^ \$].*)', prompt)
1167 m = re.match(r'(?s)(.+?)\$\$([^\$]*&[^ \$].*)', prompt)
1163 msg = m.group(1)
1168 msg = m.group(1)
1164 choices = [p.strip(' ') for p in m.group(2).split('$$')]
1169 choices = [p.strip(' ') for p in m.group(2).split('$$')]
1165 return (msg,
1170 return (msg,
1166 [(s[s.index('&') + 1].lower(), s.replace('&', '', 1))
1171 [(s[s.index('&') + 1].lower(), s.replace('&', '', 1))
1167 for s in choices])
1172 for s in choices])
1168
1173
1169 def promptchoice(self, prompt, default=0):
1174 def promptchoice(self, prompt, default=0):
1170 """Prompt user with a message, read response, and ensure it matches
1175 """Prompt user with a message, read response, and ensure it matches
1171 one of the provided choices. The prompt is formatted as follows:
1176 one of the provided choices. The prompt is formatted as follows:
1172
1177
1173 "would you like fries with that (Yn)? $$ &Yes $$ &No"
1178 "would you like fries with that (Yn)? $$ &Yes $$ &No"
1174
1179
1175 The index of the choice is returned. Responses are case
1180 The index of the choice is returned. Responses are case
1176 insensitive. If ui is not interactive, the default is
1181 insensitive. If ui is not interactive, the default is
1177 returned.
1182 returned.
1178 """
1183 """
1179
1184
1180 msg, choices = self.extractchoices(prompt)
1185 msg, choices = self.extractchoices(prompt)
1181 resps = [r for r, t in choices]
1186 resps = [r for r, t in choices]
1182 while True:
1187 while True:
1183 r = self.prompt(msg, resps[default])
1188 r = self.prompt(msg, resps[default])
1184 if r.lower() in resps:
1189 if r.lower() in resps:
1185 return resps.index(r.lower())
1190 return resps.index(r.lower())
1186 self.write(_("unrecognized response\n"))
1191 self.write(_("unrecognized response\n"))
1187
1192
1188 def getpass(self, prompt=None, default=None):
1193 def getpass(self, prompt=None, default=None):
1189 if not self.interactive():
1194 if not self.interactive():
1190 return default
1195 return default
1191 try:
1196 try:
1192 self.write_err(self.label(prompt or _('password: '), 'ui.prompt'))
1197 self.write_err(self.label(prompt or _('password: '), 'ui.prompt'))
1193 # disable getpass() only if explicitly specified. it's still valid
1198 # disable getpass() only if explicitly specified. it's still valid
1194 # to interact with tty even if fin is not a tty.
1199 # to interact with tty even if fin is not a tty.
1195 with self.timeblockedsection('stdio'):
1200 with self.timeblockedsection('stdio'):
1196 if self.configbool('ui', 'nontty'):
1201 if self.configbool('ui', 'nontty'):
1197 l = self.fin.readline()
1202 l = self.fin.readline()
1198 if not l:
1203 if not l:
1199 raise EOFError
1204 raise EOFError
1200 return l.rstrip('\n')
1205 return l.rstrip('\n')
1201 else:
1206 else:
1202 return getpass.getpass('')
1207 return getpass.getpass('')
1203 except EOFError:
1208 except EOFError:
1204 raise error.ResponseExpected()
1209 raise error.ResponseExpected()
1205 def status(self, *msg, **opts):
1210 def status(self, *msg, **opts):
1206 '''write status message to output (if ui.quiet is False)
1211 '''write status message to output (if ui.quiet is False)
1207
1212
1208 This adds an output label of "ui.status".
1213 This adds an output label of "ui.status".
1209 '''
1214 '''
1210 if not self.quiet:
1215 if not self.quiet:
1211 opts[r'label'] = opts.get(r'label', '') + ' ui.status'
1216 opts[r'label'] = opts.get(r'label', '') + ' ui.status'
1212 self.write(*msg, **opts)
1217 self.write(*msg, **opts)
1213 def warn(self, *msg, **opts):
1218 def warn(self, *msg, **opts):
1214 '''write warning message to output (stderr)
1219 '''write warning message to output (stderr)
1215
1220
1216 This adds an output label of "ui.warning".
1221 This adds an output label of "ui.warning".
1217 '''
1222 '''
1218 opts[r'label'] = opts.get(r'label', '') + ' ui.warning'
1223 opts[r'label'] = opts.get(r'label', '') + ' ui.warning'
1219 self.write_err(*msg, **opts)
1224 self.write_err(*msg, **opts)
1220 def note(self, *msg, **opts):
1225 def note(self, *msg, **opts):
1221 '''write note to output (if ui.verbose is True)
1226 '''write note to output (if ui.verbose is True)
1222
1227
1223 This adds an output label of "ui.note".
1228 This adds an output label of "ui.note".
1224 '''
1229 '''
1225 if self.verbose:
1230 if self.verbose:
1226 opts[r'label'] = opts.get(r'label', '') + ' ui.note'
1231 opts[r'label'] = opts.get(r'label', '') + ' ui.note'
1227 self.write(*msg, **opts)
1232 self.write(*msg, **opts)
1228 def debug(self, *msg, **opts):
1233 def debug(self, *msg, **opts):
1229 '''write debug message to output (if ui.debugflag is True)
1234 '''write debug message to output (if ui.debugflag is True)
1230
1235
1231 This adds an output label of "ui.debug".
1236 This adds an output label of "ui.debug".
1232 '''
1237 '''
1233 if self.debugflag:
1238 if self.debugflag:
1234 opts[r'label'] = opts.get(r'label', '') + ' ui.debug'
1239 opts[r'label'] = opts.get(r'label', '') + ' ui.debug'
1235 self.write(*msg, **opts)
1240 self.write(*msg, **opts)
1236
1241
1237 def edit(self, text, user, extra=None, editform=None, pending=None,
1242 def edit(self, text, user, extra=None, editform=None, pending=None,
1238 repopath=None):
1243 repopath=None):
1239 extra_defaults = {
1244 extra_defaults = {
1240 'prefix': 'editor',
1245 'prefix': 'editor',
1241 'suffix': '.txt',
1246 'suffix': '.txt',
1242 }
1247 }
1243 if extra is not None:
1248 if extra is not None:
1244 extra_defaults.update(extra)
1249 extra_defaults.update(extra)
1245 extra = extra_defaults
1250 extra = extra_defaults
1246
1251
1247 rdir = None
1252 rdir = None
1248 if self.configbool('experimental', 'editortmpinhg'):
1253 if self.configbool('experimental', 'editortmpinhg'):
1249 rdir = repopath
1254 rdir = repopath
1250 (fd, name) = tempfile.mkstemp(prefix='hg-' + extra['prefix'] + '-',
1255 (fd, name) = tempfile.mkstemp(prefix='hg-' + extra['prefix'] + '-',
1251 suffix=extra['suffix'],
1256 suffix=extra['suffix'],
1252 dir=rdir)
1257 dir=rdir)
1253 try:
1258 try:
1254 f = os.fdopen(fd, r'wb')
1259 f = os.fdopen(fd, r'wb')
1255 f.write(util.tonativeeol(text))
1260 f.write(util.tonativeeol(text))
1256 f.close()
1261 f.close()
1257
1262
1258 environ = {'HGUSER': user}
1263 environ = {'HGUSER': user}
1259 if 'transplant_source' in extra:
1264 if 'transplant_source' in extra:
1260 environ.update({'HGREVISION': hex(extra['transplant_source'])})
1265 environ.update({'HGREVISION': hex(extra['transplant_source'])})
1261 for label in ('intermediate-source', 'source', 'rebase_source'):
1266 for label in ('intermediate-source', 'source', 'rebase_source'):
1262 if label in extra:
1267 if label in extra:
1263 environ.update({'HGREVISION': extra[label]})
1268 environ.update({'HGREVISION': extra[label]})
1264 break
1269 break
1265 if editform:
1270 if editform:
1266 environ.update({'HGEDITFORM': editform})
1271 environ.update({'HGEDITFORM': editform})
1267 if pending:
1272 if pending:
1268 environ.update({'HG_PENDING': pending})
1273 environ.update({'HG_PENDING': pending})
1269
1274
1270 editor = self.geteditor()
1275 editor = self.geteditor()
1271
1276
1272 self.system("%s \"%s\"" % (editor, name),
1277 self.system("%s \"%s\"" % (editor, name),
1273 environ=environ,
1278 environ=environ,
1274 onerr=error.Abort, errprefix=_("edit failed"),
1279 onerr=error.Abort, errprefix=_("edit failed"),
1275 blockedtag='editor')
1280 blockedtag='editor')
1276
1281
1277 f = open(name, r'rb')
1282 f = open(name, r'rb')
1278 t = util.fromnativeeol(f.read())
1283 t = util.fromnativeeol(f.read())
1279 f.close()
1284 f.close()
1280 finally:
1285 finally:
1281 os.unlink(name)
1286 os.unlink(name)
1282
1287
1283 return t
1288 return t
1284
1289
1285 def system(self, cmd, environ=None, cwd=None, onerr=None, errprefix=None,
1290 def system(self, cmd, environ=None, cwd=None, onerr=None, errprefix=None,
1286 blockedtag=None):
1291 blockedtag=None):
1287 '''execute shell command with appropriate output stream. command
1292 '''execute shell command with appropriate output stream. command
1288 output will be redirected if fout is not stdout.
1293 output will be redirected if fout is not stdout.
1289
1294
1290 if command fails and onerr is None, return status, else raise onerr
1295 if command fails and onerr is None, return status, else raise onerr
1291 object as exception.
1296 object as exception.
1292 '''
1297 '''
1293 if blockedtag is None:
1298 if blockedtag is None:
1294 # Long cmds tend to be because of an absolute path on cmd. Keep
1299 # Long cmds tend to be because of an absolute path on cmd. Keep
1295 # the tail end instead
1300 # the tail end instead
1296 cmdsuffix = cmd.translate(None, _keepalnum)[-85:]
1301 cmdsuffix = cmd.translate(None, _keepalnum)[-85:]
1297 blockedtag = 'unknown_system_' + cmdsuffix
1302 blockedtag = 'unknown_system_' + cmdsuffix
1298 out = self.fout
1303 out = self.fout
1299 if any(s[1] for s in self._bufferstates):
1304 if any(s[1] for s in self._bufferstates):
1300 out = self
1305 out = self
1301 with self.timeblockedsection(blockedtag):
1306 with self.timeblockedsection(blockedtag):
1302 rc = self._runsystem(cmd, environ=environ, cwd=cwd, out=out)
1307 rc = self._runsystem(cmd, environ=environ, cwd=cwd, out=out)
1303 if rc and onerr:
1308 if rc and onerr:
1304 errmsg = '%s %s' % (os.path.basename(cmd.split(None, 1)[0]),
1309 errmsg = '%s %s' % (os.path.basename(cmd.split(None, 1)[0]),
1305 util.explainexit(rc)[0])
1310 util.explainexit(rc)[0])
1306 if errprefix:
1311 if errprefix:
1307 errmsg = '%s: %s' % (errprefix, errmsg)
1312 errmsg = '%s: %s' % (errprefix, errmsg)
1308 raise onerr(errmsg)
1313 raise onerr(errmsg)
1309 return rc
1314 return rc
1310
1315
1311 def _runsystem(self, cmd, environ, cwd, out):
1316 def _runsystem(self, cmd, environ, cwd, out):
1312 """actually execute the given shell command (can be overridden by
1317 """actually execute the given shell command (can be overridden by
1313 extensions like chg)"""
1318 extensions like chg)"""
1314 return util.system(cmd, environ=environ, cwd=cwd, out=out)
1319 return util.system(cmd, environ=environ, cwd=cwd, out=out)
1315
1320
1316 def traceback(self, exc=None, force=False):
1321 def traceback(self, exc=None, force=False):
1317 '''print exception traceback if traceback printing enabled or forced.
1322 '''print exception traceback if traceback printing enabled or forced.
1318 only to call in exception handler. returns true if traceback
1323 only to call in exception handler. returns true if traceback
1319 printed.'''
1324 printed.'''
1320 if self.tracebackflag or force:
1325 if self.tracebackflag or force:
1321 if exc is None:
1326 if exc is None:
1322 exc = sys.exc_info()
1327 exc = sys.exc_info()
1323 cause = getattr(exc[1], 'cause', None)
1328 cause = getattr(exc[1], 'cause', None)
1324
1329
1325 if cause is not None:
1330 if cause is not None:
1326 causetb = traceback.format_tb(cause[2])
1331 causetb = traceback.format_tb(cause[2])
1327 exctb = traceback.format_tb(exc[2])
1332 exctb = traceback.format_tb(exc[2])
1328 exconly = traceback.format_exception_only(cause[0], cause[1])
1333 exconly = traceback.format_exception_only(cause[0], cause[1])
1329
1334
1330 # exclude frame where 'exc' was chained and rethrown from exctb
1335 # exclude frame where 'exc' was chained and rethrown from exctb
1331 self.write_err('Traceback (most recent call last):\n',
1336 self.write_err('Traceback (most recent call last):\n',
1332 ''.join(exctb[:-1]),
1337 ''.join(exctb[:-1]),
1333 ''.join(causetb),
1338 ''.join(causetb),
1334 ''.join(exconly))
1339 ''.join(exconly))
1335 else:
1340 else:
1336 output = traceback.format_exception(exc[0], exc[1], exc[2])
1341 output = traceback.format_exception(exc[0], exc[1], exc[2])
1337 data = r''.join(output)
1342 data = r''.join(output)
1338 if pycompat.ispy3:
1343 if pycompat.ispy3:
1339 enc = pycompat.sysstr(encoding.encoding)
1344 enc = pycompat.sysstr(encoding.encoding)
1340 data = data.encode(enc, errors=r'replace')
1345 data = data.encode(enc, errors=r'replace')
1341 self.write_err(data)
1346 self.write_err(data)
1342 return self.tracebackflag or force
1347 return self.tracebackflag or force
1343
1348
1344 def geteditor(self):
1349 def geteditor(self):
1345 '''return editor to use'''
1350 '''return editor to use'''
1346 if pycompat.sysplatform == 'plan9':
1351 if pycompat.sysplatform == 'plan9':
1347 # vi is the MIPS instruction simulator on Plan 9. We
1352 # vi is the MIPS instruction simulator on Plan 9. We
1348 # instead default to E to plumb commit messages to
1353 # instead default to E to plumb commit messages to
1349 # avoid confusion.
1354 # avoid confusion.
1350 editor = 'E'
1355 editor = 'E'
1351 else:
1356 else:
1352 editor = 'vi'
1357 editor = 'vi'
1353 return (encoding.environ.get("HGEDITOR") or
1358 return (encoding.environ.get("HGEDITOR") or
1354 self.config("ui", "editor", editor))
1359 self.config("ui", "editor", editor))
1355
1360
1356 @util.propertycache
1361 @util.propertycache
1357 def _progbar(self):
1362 def _progbar(self):
1358 """setup the progbar singleton to the ui object"""
1363 """setup the progbar singleton to the ui object"""
1359 if (self.quiet or self.debugflag
1364 if (self.quiet or self.debugflag
1360 or self.configbool('progress', 'disable', False)
1365 or self.configbool('progress', 'disable', False)
1361 or not progress.shouldprint(self)):
1366 or not progress.shouldprint(self)):
1362 return None
1367 return None
1363 return getprogbar(self)
1368 return getprogbar(self)
1364
1369
1365 def _progclear(self):
1370 def _progclear(self):
1366 """clear progress bar output if any. use it before any output"""
1371 """clear progress bar output if any. use it before any output"""
1367 if '_progbar' not in vars(self): # nothing loaded yet
1372 if '_progbar' not in vars(self): # nothing loaded yet
1368 return
1373 return
1369 if self._progbar is not None and self._progbar.printed:
1374 if self._progbar is not None and self._progbar.printed:
1370 self._progbar.clear()
1375 self._progbar.clear()
1371
1376
1372 def progress(self, topic, pos, item="", unit="", total=None):
1377 def progress(self, topic, pos, item="", unit="", total=None):
1373 '''show a progress message
1378 '''show a progress message
1374
1379
1375 By default a textual progress bar will be displayed if an operation
1380 By default a textual progress bar will be displayed if an operation
1376 takes too long. 'topic' is the current operation, 'item' is a
1381 takes too long. 'topic' is the current operation, 'item' is a
1377 non-numeric marker of the current position (i.e. the currently
1382 non-numeric marker of the current position (i.e. the currently
1378 in-process file), 'pos' is the current numeric position (i.e.
1383 in-process file), 'pos' is the current numeric position (i.e.
1379 revision, bytes, etc.), unit is a corresponding unit label,
1384 revision, bytes, etc.), unit is a corresponding unit label,
1380 and total is the highest expected pos.
1385 and total is the highest expected pos.
1381
1386
1382 Multiple nested topics may be active at a time.
1387 Multiple nested topics may be active at a time.
1383
1388
1384 All topics should be marked closed by setting pos to None at
1389 All topics should be marked closed by setting pos to None at
1385 termination.
1390 termination.
1386 '''
1391 '''
1387 if self._progbar is not None:
1392 if self._progbar is not None:
1388 self._progbar.progress(topic, pos, item=item, unit=unit,
1393 self._progbar.progress(topic, pos, item=item, unit=unit,
1389 total=total)
1394 total=total)
1390 if pos is None or not self.configbool('progress', 'debug'):
1395 if pos is None or not self.configbool('progress', 'debug'):
1391 return
1396 return
1392
1397
1393 if unit:
1398 if unit:
1394 unit = ' ' + unit
1399 unit = ' ' + unit
1395 if item:
1400 if item:
1396 item = ' ' + item
1401 item = ' ' + item
1397
1402
1398 if total:
1403 if total:
1399 pct = 100.0 * pos / total
1404 pct = 100.0 * pos / total
1400 self.debug('%s:%s %s/%s%s (%4.2f%%)\n'
1405 self.debug('%s:%s %s/%s%s (%4.2f%%)\n'
1401 % (topic, item, pos, total, unit, pct))
1406 % (topic, item, pos, total, unit, pct))
1402 else:
1407 else:
1403 self.debug('%s:%s %s%s\n' % (topic, item, pos, unit))
1408 self.debug('%s:%s %s%s\n' % (topic, item, pos, unit))
1404
1409
1405 def log(self, service, *msg, **opts):
1410 def log(self, service, *msg, **opts):
1406 '''hook for logging facility extensions
1411 '''hook for logging facility extensions
1407
1412
1408 service should be a readily-identifiable subsystem, which will
1413 service should be a readily-identifiable subsystem, which will
1409 allow filtering.
1414 allow filtering.
1410
1415
1411 *msg should be a newline-terminated format string to log, and
1416 *msg should be a newline-terminated format string to log, and
1412 then any values to %-format into that format string.
1417 then any values to %-format into that format string.
1413
1418
1414 **opts currently has no defined meanings.
1419 **opts currently has no defined meanings.
1415 '''
1420 '''
1416
1421
1417 def label(self, msg, label):
1422 def label(self, msg, label):
1418 '''style msg based on supplied label
1423 '''style msg based on supplied label
1419
1424
1420 If some color mode is enabled, this will add the necessary control
1425 If some color mode is enabled, this will add the necessary control
1421 characters to apply such color. In addition, 'debug' color mode adds
1426 characters to apply such color. In addition, 'debug' color mode adds
1422 markup showing which label affects a piece of text.
1427 markup showing which label affects a piece of text.
1423
1428
1424 ui.write(s, 'label') is equivalent to
1429 ui.write(s, 'label') is equivalent to
1425 ui.write(ui.label(s, 'label')).
1430 ui.write(ui.label(s, 'label')).
1426 '''
1431 '''
1427 if self._colormode is not None:
1432 if self._colormode is not None:
1428 return color.colorlabel(self, msg, label)
1433 return color.colorlabel(self, msg, label)
1429 return msg
1434 return msg
1430
1435
1431 def develwarn(self, msg, stacklevel=1, config=None):
1436 def develwarn(self, msg, stacklevel=1, config=None):
1432 """issue a developer warning message
1437 """issue a developer warning message
1433
1438
1434 Use 'stacklevel' to report the offender some layers further up in the
1439 Use 'stacklevel' to report the offender some layers further up in the
1435 stack.
1440 stack.
1436 """
1441 """
1437 if not self.configbool('devel', 'all-warnings'):
1442 if not self.configbool('devel', 'all-warnings'):
1438 if config is not None and not self.configbool('devel', config):
1443 if config is not None and not self.configbool('devel', config):
1439 return
1444 return
1440 msg = 'devel-warn: ' + msg
1445 msg = 'devel-warn: ' + msg
1441 stacklevel += 1 # get in develwarn
1446 stacklevel += 1 # get in develwarn
1442 if self.tracebackflag:
1447 if self.tracebackflag:
1443 util.debugstacktrace(msg, stacklevel, self.ferr, self.fout)
1448 util.debugstacktrace(msg, stacklevel, self.ferr, self.fout)
1444 self.log('develwarn', '%s at:\n%s' %
1449 self.log('develwarn', '%s at:\n%s' %
1445 (msg, ''.join(util.getstackframes(stacklevel))))
1450 (msg, ''.join(util.getstackframes(stacklevel))))
1446 else:
1451 else:
1447 curframe = inspect.currentframe()
1452 curframe = inspect.currentframe()
1448 calframe = inspect.getouterframes(curframe, 2)
1453 calframe = inspect.getouterframes(curframe, 2)
1449 self.write_err('%s at: %s:%s (%s)\n'
1454 self.write_err('%s at: %s:%s (%s)\n'
1450 % ((msg,) + calframe[stacklevel][1:4]))
1455 % ((msg,) + calframe[stacklevel][1:4]))
1451 self.log('develwarn', '%s at: %s:%s (%s)\n',
1456 self.log('develwarn', '%s at: %s:%s (%s)\n',
1452 msg, *calframe[stacklevel][1:4])
1457 msg, *calframe[stacklevel][1:4])
1453 curframe = calframe = None # avoid cycles
1458 curframe = calframe = None # avoid cycles
1454
1459
1455 def deprecwarn(self, msg, version):
1460 def deprecwarn(self, msg, version):
1456 """issue a deprecation warning
1461 """issue a deprecation warning
1457
1462
1458 - msg: message explaining what is deprecated and how to upgrade,
1463 - msg: message explaining what is deprecated and how to upgrade,
1459 - version: last version where the API will be supported,
1464 - version: last version where the API will be supported,
1460 """
1465 """
1461 if not (self.configbool('devel', 'all-warnings')
1466 if not (self.configbool('devel', 'all-warnings')
1462 or self.configbool('devel', 'deprec-warn')):
1467 or self.configbool('devel', 'deprec-warn')):
1463 return
1468 return
1464 msg += ("\n(compatibility will be dropped after Mercurial-%s,"
1469 msg += ("\n(compatibility will be dropped after Mercurial-%s,"
1465 " update your code.)") % version
1470 " update your code.)") % version
1466 self.develwarn(msg, stacklevel=2, config='deprec-warn')
1471 self.develwarn(msg, stacklevel=2, config='deprec-warn')
1467
1472
1468 def exportableenviron(self):
1473 def exportableenviron(self):
1469 """The environment variables that are safe to export, e.g. through
1474 """The environment variables that are safe to export, e.g. through
1470 hgweb.
1475 hgweb.
1471 """
1476 """
1472 return self._exportableenviron
1477 return self._exportableenviron
1473
1478
1474 @contextlib.contextmanager
1479 @contextlib.contextmanager
1475 def configoverride(self, overrides, source=""):
1480 def configoverride(self, overrides, source=""):
1476 """Context manager for temporary config overrides
1481 """Context manager for temporary config overrides
1477 `overrides` must be a dict of the following structure:
1482 `overrides` must be a dict of the following structure:
1478 {(section, name) : value}"""
1483 {(section, name) : value}"""
1479 backups = {}
1484 backups = {}
1480 try:
1485 try:
1481 for (section, name), value in overrides.items():
1486 for (section, name), value in overrides.items():
1482 backups[(section, name)] = self.backupconfig(section, name)
1487 backups[(section, name)] = self.backupconfig(section, name)
1483 self.setconfig(section, name, value, source)
1488 self.setconfig(section, name, value, source)
1484 yield
1489 yield
1485 finally:
1490 finally:
1486 for __, backup in backups.items():
1491 for __, backup in backups.items():
1487 self.restoreconfig(backup)
1492 self.restoreconfig(backup)
1488 # just restoring ui.quiet config to the previous value is not enough
1493 # just restoring ui.quiet config to the previous value is not enough
1489 # as it does not update ui.quiet class member
1494 # as it does not update ui.quiet class member
1490 if ('ui', 'quiet') in overrides:
1495 if ('ui', 'quiet') in overrides:
1491 self.fixconfig(section='ui')
1496 self.fixconfig(section='ui')
1492
1497
1493 class paths(dict):
1498 class paths(dict):
1494 """Represents a collection of paths and their configs.
1499 """Represents a collection of paths and their configs.
1495
1500
1496 Data is initially derived from ui instances and the config files they have
1501 Data is initially derived from ui instances and the config files they have
1497 loaded.
1502 loaded.
1498 """
1503 """
1499 def __init__(self, ui):
1504 def __init__(self, ui):
1500 dict.__init__(self)
1505 dict.__init__(self)
1501
1506
1502 for name, loc in ui.configitems('paths', ignoresub=True):
1507 for name, loc in ui.configitems('paths', ignoresub=True):
1503 # No location is the same as not existing.
1508 # No location is the same as not existing.
1504 if not loc:
1509 if not loc:
1505 continue
1510 continue
1506 loc, sub = ui.configsuboptions('paths', name)
1511 loc, sub = ui.configsuboptions('paths', name)
1507 self[name] = path(ui, name, rawloc=loc, suboptions=sub)
1512 self[name] = path(ui, name, rawloc=loc, suboptions=sub)
1508
1513
1509 def getpath(self, name, default=None):
1514 def getpath(self, name, default=None):
1510 """Return a ``path`` from a string, falling back to default.
1515 """Return a ``path`` from a string, falling back to default.
1511
1516
1512 ``name`` can be a named path or locations. Locations are filesystem
1517 ``name`` can be a named path or locations. Locations are filesystem
1513 paths or URIs.
1518 paths or URIs.
1514
1519
1515 Returns None if ``name`` is not a registered path, a URI, or a local
1520 Returns None if ``name`` is not a registered path, a URI, or a local
1516 path to a repo.
1521 path to a repo.
1517 """
1522 """
1518 # Only fall back to default if no path was requested.
1523 # Only fall back to default if no path was requested.
1519 if name is None:
1524 if name is None:
1520 if not default:
1525 if not default:
1521 default = ()
1526 default = ()
1522 elif not isinstance(default, (tuple, list)):
1527 elif not isinstance(default, (tuple, list)):
1523 default = (default,)
1528 default = (default,)
1524 for k in default:
1529 for k in default:
1525 try:
1530 try:
1526 return self[k]
1531 return self[k]
1527 except KeyError:
1532 except KeyError:
1528 continue
1533 continue
1529 return None
1534 return None
1530
1535
1531 # Most likely empty string.
1536 # Most likely empty string.
1532 # This may need to raise in the future.
1537 # This may need to raise in the future.
1533 if not name:
1538 if not name:
1534 return None
1539 return None
1535
1540
1536 try:
1541 try:
1537 return self[name]
1542 return self[name]
1538 except KeyError:
1543 except KeyError:
1539 # Try to resolve as a local path or URI.
1544 # Try to resolve as a local path or URI.
1540 try:
1545 try:
1541 # We don't pass sub-options in, so no need to pass ui instance.
1546 # We don't pass sub-options in, so no need to pass ui instance.
1542 return path(None, None, rawloc=name)
1547 return path(None, None, rawloc=name)
1543 except ValueError:
1548 except ValueError:
1544 raise error.RepoError(_('repository %s does not exist') %
1549 raise error.RepoError(_('repository %s does not exist') %
1545 name)
1550 name)
1546
1551
1547 _pathsuboptions = {}
1552 _pathsuboptions = {}
1548
1553
1549 def pathsuboption(option, attr):
1554 def pathsuboption(option, attr):
1550 """Decorator used to declare a path sub-option.
1555 """Decorator used to declare a path sub-option.
1551
1556
1552 Arguments are the sub-option name and the attribute it should set on
1557 Arguments are the sub-option name and the attribute it should set on
1553 ``path`` instances.
1558 ``path`` instances.
1554
1559
1555 The decorated function will receive as arguments a ``ui`` instance,
1560 The decorated function will receive as arguments a ``ui`` instance,
1556 ``path`` instance, and the string value of this option from the config.
1561 ``path`` instance, and the string value of this option from the config.
1557 The function should return the value that will be set on the ``path``
1562 The function should return the value that will be set on the ``path``
1558 instance.
1563 instance.
1559
1564
1560 This decorator can be used to perform additional verification of
1565 This decorator can be used to perform additional verification of
1561 sub-options and to change the type of sub-options.
1566 sub-options and to change the type of sub-options.
1562 """
1567 """
1563 def register(func):
1568 def register(func):
1564 _pathsuboptions[option] = (attr, func)
1569 _pathsuboptions[option] = (attr, func)
1565 return func
1570 return func
1566 return register
1571 return register
1567
1572
1568 @pathsuboption('pushurl', 'pushloc')
1573 @pathsuboption('pushurl', 'pushloc')
1569 def pushurlpathoption(ui, path, value):
1574 def pushurlpathoption(ui, path, value):
1570 u = util.url(value)
1575 u = util.url(value)
1571 # Actually require a URL.
1576 # Actually require a URL.
1572 if not u.scheme:
1577 if not u.scheme:
1573 ui.warn(_('(paths.%s:pushurl not a URL; ignoring)\n') % path.name)
1578 ui.warn(_('(paths.%s:pushurl not a URL; ignoring)\n') % path.name)
1574 return None
1579 return None
1575
1580
1576 # Don't support the #foo syntax in the push URL to declare branch to
1581 # Don't support the #foo syntax in the push URL to declare branch to
1577 # push.
1582 # push.
1578 if u.fragment:
1583 if u.fragment:
1579 ui.warn(_('("#fragment" in paths.%s:pushurl not supported; '
1584 ui.warn(_('("#fragment" in paths.%s:pushurl not supported; '
1580 'ignoring)\n') % path.name)
1585 'ignoring)\n') % path.name)
1581 u.fragment = None
1586 u.fragment = None
1582
1587
1583 return str(u)
1588 return str(u)
1584
1589
1585 @pathsuboption('pushrev', 'pushrev')
1590 @pathsuboption('pushrev', 'pushrev')
1586 def pushrevpathoption(ui, path, value):
1591 def pushrevpathoption(ui, path, value):
1587 return value
1592 return value
1588
1593
1589 class path(object):
1594 class path(object):
1590 """Represents an individual path and its configuration."""
1595 """Represents an individual path and its configuration."""
1591
1596
1592 def __init__(self, ui, name, rawloc=None, suboptions=None):
1597 def __init__(self, ui, name, rawloc=None, suboptions=None):
1593 """Construct a path from its config options.
1598 """Construct a path from its config options.
1594
1599
1595 ``ui`` is the ``ui`` instance the path is coming from.
1600 ``ui`` is the ``ui`` instance the path is coming from.
1596 ``name`` is the symbolic name of the path.
1601 ``name`` is the symbolic name of the path.
1597 ``rawloc`` is the raw location, as defined in the config.
1602 ``rawloc`` is the raw location, as defined in the config.
1598 ``pushloc`` is the raw locations pushes should be made to.
1603 ``pushloc`` is the raw locations pushes should be made to.
1599
1604
1600 If ``name`` is not defined, we require that the location be a) a local
1605 If ``name`` is not defined, we require that the location be a) a local
1601 filesystem path with a .hg directory or b) a URL. If not,
1606 filesystem path with a .hg directory or b) a URL. If not,
1602 ``ValueError`` is raised.
1607 ``ValueError`` is raised.
1603 """
1608 """
1604 if not rawloc:
1609 if not rawloc:
1605 raise ValueError('rawloc must be defined')
1610 raise ValueError('rawloc must be defined')
1606
1611
1607 # Locations may define branches via syntax <base>#<branch>.
1612 # Locations may define branches via syntax <base>#<branch>.
1608 u = util.url(rawloc)
1613 u = util.url(rawloc)
1609 branch = None
1614 branch = None
1610 if u.fragment:
1615 if u.fragment:
1611 branch = u.fragment
1616 branch = u.fragment
1612 u.fragment = None
1617 u.fragment = None
1613
1618
1614 self.url = u
1619 self.url = u
1615 self.branch = branch
1620 self.branch = branch
1616
1621
1617 self.name = name
1622 self.name = name
1618 self.rawloc = rawloc
1623 self.rawloc = rawloc
1619 self.loc = '%s' % u
1624 self.loc = '%s' % u
1620
1625
1621 # When given a raw location but not a symbolic name, validate the
1626 # When given a raw location but not a symbolic name, validate the
1622 # location is valid.
1627 # location is valid.
1623 if not name and not u.scheme and not self._isvalidlocalpath(self.loc):
1628 if not name and not u.scheme and not self._isvalidlocalpath(self.loc):
1624 raise ValueError('location is not a URL or path to a local '
1629 raise ValueError('location is not a URL or path to a local '
1625 'repo: %s' % rawloc)
1630 'repo: %s' % rawloc)
1626
1631
1627 suboptions = suboptions or {}
1632 suboptions = suboptions or {}
1628
1633
1629 # Now process the sub-options. If a sub-option is registered, its
1634 # Now process the sub-options. If a sub-option is registered, its
1630 # attribute will always be present. The value will be None if there
1635 # attribute will always be present. The value will be None if there
1631 # was no valid sub-option.
1636 # was no valid sub-option.
1632 for suboption, (attr, func) in _pathsuboptions.iteritems():
1637 for suboption, (attr, func) in _pathsuboptions.iteritems():
1633 if suboption not in suboptions:
1638 if suboption not in suboptions:
1634 setattr(self, attr, None)
1639 setattr(self, attr, None)
1635 continue
1640 continue
1636
1641
1637 value = func(ui, self, suboptions[suboption])
1642 value = func(ui, self, suboptions[suboption])
1638 setattr(self, attr, value)
1643 setattr(self, attr, value)
1639
1644
1640 def _isvalidlocalpath(self, path):
1645 def _isvalidlocalpath(self, path):
1641 """Returns True if the given path is a potentially valid repository.
1646 """Returns True if the given path is a potentially valid repository.
1642 This is its own function so that extensions can change the definition of
1647 This is its own function so that extensions can change the definition of
1643 'valid' in this case (like when pulling from a git repo into a hg
1648 'valid' in this case (like when pulling from a git repo into a hg
1644 one)."""
1649 one)."""
1645 return os.path.isdir(os.path.join(path, '.hg'))
1650 return os.path.isdir(os.path.join(path, '.hg'))
1646
1651
1647 @property
1652 @property
1648 def suboptions(self):
1653 def suboptions(self):
1649 """Return sub-options and their values for this path.
1654 """Return sub-options and their values for this path.
1650
1655
1651 This is intended to be used for presentation purposes.
1656 This is intended to be used for presentation purposes.
1652 """
1657 """
1653 d = {}
1658 d = {}
1654 for subopt, (attr, _func) in _pathsuboptions.iteritems():
1659 for subopt, (attr, _func) in _pathsuboptions.iteritems():
1655 value = getattr(self, attr)
1660 value = getattr(self, attr)
1656 if value is not None:
1661 if value is not None:
1657 d[subopt] = value
1662 d[subopt] = value
1658 return d
1663 return d
1659
1664
1660 # we instantiate one globally shared progress bar to avoid
1665 # we instantiate one globally shared progress bar to avoid
1661 # competing progress bars when multiple UI objects get created
1666 # competing progress bars when multiple UI objects get created
1662 _progresssingleton = None
1667 _progresssingleton = None
1663
1668
1664 def getprogbar(ui):
1669 def getprogbar(ui):
1665 global _progresssingleton
1670 global _progresssingleton
1666 if _progresssingleton is None:
1671 if _progresssingleton is None:
1667 # passing 'ui' object to the singleton is fishy,
1672 # passing 'ui' object to the singleton is fishy,
1668 # this is how the extension used to work but feel free to rework it.
1673 # this is how the extension used to work but feel free to rework it.
1669 _progresssingleton = progress.progbar(ui)
1674 _progresssingleton = progress.progbar(ui)
1670 return _progresssingleton
1675 return _progresssingleton
General Comments 0
You need to be logged in to leave comments. Login now