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