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