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