##// END OF EJS Templates
typing: rewrite a conditional assignment to unconfuse pytype...
Matt Harbison -
r47551:86b47ec1 stable
parent child Browse files
Show More
@@ -1,3698 +1,3698 b''
1 1 # localrepo.py - read/write repository class for mercurial
2 2 #
3 3 # Copyright 2005-2007 Matt Mackall <mpm@selenic.com>
4 4 #
5 5 # This software may be used and distributed according to the terms of the
6 6 # GNU General Public License version 2 or any later version.
7 7
8 8 from __future__ import absolute_import
9 9
10 10 import errno
11 11 import functools
12 12 import os
13 13 import random
14 14 import sys
15 15 import time
16 16 import weakref
17 17
18 18 from .i18n import _
19 19 from .node import (
20 20 bin,
21 21 hex,
22 22 nullid,
23 23 nullrev,
24 24 short,
25 25 )
26 26 from .pycompat import (
27 27 delattr,
28 28 getattr,
29 29 )
30 30 from . import (
31 31 bookmarks,
32 32 branchmap,
33 33 bundle2,
34 34 bundlecaches,
35 35 changegroup,
36 36 color,
37 37 commit,
38 38 context,
39 39 dirstate,
40 40 dirstateguard,
41 41 discovery,
42 42 encoding,
43 43 error,
44 44 exchange,
45 45 extensions,
46 46 filelog,
47 47 hook,
48 48 lock as lockmod,
49 49 match as matchmod,
50 50 mergestate as mergestatemod,
51 51 mergeutil,
52 52 namespaces,
53 53 narrowspec,
54 54 obsolete,
55 55 pathutil,
56 56 phases,
57 57 pushkey,
58 58 pycompat,
59 59 rcutil,
60 60 repoview,
61 61 requirements as requirementsmod,
62 62 revlog,
63 63 revset,
64 64 revsetlang,
65 65 scmutil,
66 66 sparse,
67 67 store as storemod,
68 68 subrepoutil,
69 69 tags as tagsmod,
70 70 transaction,
71 71 txnutil,
72 72 util,
73 73 vfs as vfsmod,
74 74 )
75 75
76 76 from .interfaces import (
77 77 repository,
78 78 util as interfaceutil,
79 79 )
80 80
81 81 from .utils import (
82 82 hashutil,
83 83 procutil,
84 84 stringutil,
85 85 )
86 86
87 87 from .revlogutils import constants as revlogconst
88 88
89 89 release = lockmod.release
90 90 urlerr = util.urlerr
91 91 urlreq = util.urlreq
92 92
93 93 # set of (path, vfs-location) tuples. vfs-location is:
94 94 # - 'plain for vfs relative paths
95 95 # - '' for svfs relative paths
96 96 _cachedfiles = set()
97 97
98 98
99 99 class _basefilecache(scmutil.filecache):
100 100 """All filecache usage on repo are done for logic that should be unfiltered"""
101 101
102 102 def __get__(self, repo, type=None):
103 103 if repo is None:
104 104 return self
105 105 # proxy to unfiltered __dict__ since filtered repo has no entry
106 106 unfi = repo.unfiltered()
107 107 try:
108 108 return unfi.__dict__[self.sname]
109 109 except KeyError:
110 110 pass
111 111 return super(_basefilecache, self).__get__(unfi, type)
112 112
113 113 def set(self, repo, value):
114 114 return super(_basefilecache, self).set(repo.unfiltered(), value)
115 115
116 116
117 117 class repofilecache(_basefilecache):
118 118 """filecache for files in .hg but outside of .hg/store"""
119 119
120 120 def __init__(self, *paths):
121 121 super(repofilecache, self).__init__(*paths)
122 122 for path in paths:
123 123 _cachedfiles.add((path, b'plain'))
124 124
125 125 def join(self, obj, fname):
126 126 return obj.vfs.join(fname)
127 127
128 128
129 129 class storecache(_basefilecache):
130 130 """filecache for files in the store"""
131 131
132 132 def __init__(self, *paths):
133 133 super(storecache, self).__init__(*paths)
134 134 for path in paths:
135 135 _cachedfiles.add((path, b''))
136 136
137 137 def join(self, obj, fname):
138 138 return obj.sjoin(fname)
139 139
140 140
141 141 class mixedrepostorecache(_basefilecache):
142 142 """filecache for a mix files in .hg/store and outside"""
143 143
144 144 def __init__(self, *pathsandlocations):
145 145 # scmutil.filecache only uses the path for passing back into our
146 146 # join(), so we can safely pass a list of paths and locations
147 147 super(mixedrepostorecache, self).__init__(*pathsandlocations)
148 148 _cachedfiles.update(pathsandlocations)
149 149
150 150 def join(self, obj, fnameandlocation):
151 151 fname, location = fnameandlocation
152 152 if location == b'plain':
153 153 return obj.vfs.join(fname)
154 154 else:
155 155 if location != b'':
156 156 raise error.ProgrammingError(
157 157 b'unexpected location: %s' % location
158 158 )
159 159 return obj.sjoin(fname)
160 160
161 161
162 162 def isfilecached(repo, name):
163 163 """check if a repo has already cached "name" filecache-ed property
164 164
165 165 This returns (cachedobj-or-None, iscached) tuple.
166 166 """
167 167 cacheentry = repo.unfiltered()._filecache.get(name, None)
168 168 if not cacheentry:
169 169 return None, False
170 170 return cacheentry.obj, True
171 171
172 172
173 173 class unfilteredpropertycache(util.propertycache):
174 174 """propertycache that apply to unfiltered repo only"""
175 175
176 176 def __get__(self, repo, type=None):
177 177 unfi = repo.unfiltered()
178 178 if unfi is repo:
179 179 return super(unfilteredpropertycache, self).__get__(unfi)
180 180 return getattr(unfi, self.name)
181 181
182 182
183 183 class filteredpropertycache(util.propertycache):
184 184 """propertycache that must take filtering in account"""
185 185
186 186 def cachevalue(self, obj, value):
187 187 object.__setattr__(obj, self.name, value)
188 188
189 189
190 190 def hasunfilteredcache(repo, name):
191 191 """check if a repo has an unfilteredpropertycache value for <name>"""
192 192 return name in vars(repo.unfiltered())
193 193
194 194
195 195 def unfilteredmethod(orig):
196 196 """decorate method that always need to be run on unfiltered version"""
197 197
198 198 @functools.wraps(orig)
199 199 def wrapper(repo, *args, **kwargs):
200 200 return orig(repo.unfiltered(), *args, **kwargs)
201 201
202 202 return wrapper
203 203
204 204
205 205 moderncaps = {
206 206 b'lookup',
207 207 b'branchmap',
208 208 b'pushkey',
209 209 b'known',
210 210 b'getbundle',
211 211 b'unbundle',
212 212 }
213 213 legacycaps = moderncaps.union({b'changegroupsubset'})
214 214
215 215
216 216 @interfaceutil.implementer(repository.ipeercommandexecutor)
217 217 class localcommandexecutor(object):
218 218 def __init__(self, peer):
219 219 self._peer = peer
220 220 self._sent = False
221 221 self._closed = False
222 222
223 223 def __enter__(self):
224 224 return self
225 225
226 226 def __exit__(self, exctype, excvalue, exctb):
227 227 self.close()
228 228
229 229 def callcommand(self, command, args):
230 230 if self._sent:
231 231 raise error.ProgrammingError(
232 232 b'callcommand() cannot be used after sendcommands()'
233 233 )
234 234
235 235 if self._closed:
236 236 raise error.ProgrammingError(
237 237 b'callcommand() cannot be used after close()'
238 238 )
239 239
240 240 # We don't need to support anything fancy. Just call the named
241 241 # method on the peer and return a resolved future.
242 242 fn = getattr(self._peer, pycompat.sysstr(command))
243 243
244 244 f = pycompat.futures.Future()
245 245
246 246 try:
247 247 result = fn(**pycompat.strkwargs(args))
248 248 except Exception:
249 249 pycompat.future_set_exception_info(f, sys.exc_info()[1:])
250 250 else:
251 251 f.set_result(result)
252 252
253 253 return f
254 254
255 255 def sendcommands(self):
256 256 self._sent = True
257 257
258 258 def close(self):
259 259 self._closed = True
260 260
261 261
262 262 @interfaceutil.implementer(repository.ipeercommands)
263 263 class localpeer(repository.peer):
264 264 '''peer for a local repo; reflects only the most recent API'''
265 265
266 266 def __init__(self, repo, caps=None):
267 267 super(localpeer, self).__init__()
268 268
269 269 if caps is None:
270 270 caps = moderncaps.copy()
271 271 self._repo = repo.filtered(b'served')
272 272 self.ui = repo.ui
273 273 self._caps = repo._restrictcapabilities(caps)
274 274
275 275 # Begin of _basepeer interface.
276 276
277 277 def url(self):
278 278 return self._repo.url()
279 279
280 280 def local(self):
281 281 return self._repo
282 282
283 283 def peer(self):
284 284 return self
285 285
286 286 def canpush(self):
287 287 return True
288 288
289 289 def close(self):
290 290 self._repo.close()
291 291
292 292 # End of _basepeer interface.
293 293
294 294 # Begin of _basewirecommands interface.
295 295
296 296 def branchmap(self):
297 297 return self._repo.branchmap()
298 298
299 299 def capabilities(self):
300 300 return self._caps
301 301
302 302 def clonebundles(self):
303 303 return self._repo.tryread(bundlecaches.CB_MANIFEST_FILE)
304 304
305 305 def debugwireargs(self, one, two, three=None, four=None, five=None):
306 306 """Used to test argument passing over the wire"""
307 307 return b"%s %s %s %s %s" % (
308 308 one,
309 309 two,
310 310 pycompat.bytestr(three),
311 311 pycompat.bytestr(four),
312 312 pycompat.bytestr(five),
313 313 )
314 314
315 315 def getbundle(
316 316 self, source, heads=None, common=None, bundlecaps=None, **kwargs
317 317 ):
318 318 chunks = exchange.getbundlechunks(
319 319 self._repo,
320 320 source,
321 321 heads=heads,
322 322 common=common,
323 323 bundlecaps=bundlecaps,
324 324 **kwargs
325 325 )[1]
326 326 cb = util.chunkbuffer(chunks)
327 327
328 328 if exchange.bundle2requested(bundlecaps):
329 329 # When requesting a bundle2, getbundle returns a stream to make the
330 330 # wire level function happier. We need to build a proper object
331 331 # from it in local peer.
332 332 return bundle2.getunbundler(self.ui, cb)
333 333 else:
334 334 return changegroup.getunbundler(b'01', cb, None)
335 335
336 336 def heads(self):
337 337 return self._repo.heads()
338 338
339 339 def known(self, nodes):
340 340 return self._repo.known(nodes)
341 341
342 342 def listkeys(self, namespace):
343 343 return self._repo.listkeys(namespace)
344 344
345 345 def lookup(self, key):
346 346 return self._repo.lookup(key)
347 347
348 348 def pushkey(self, namespace, key, old, new):
349 349 return self._repo.pushkey(namespace, key, old, new)
350 350
351 351 def stream_out(self):
352 352 raise error.Abort(_(b'cannot perform stream clone against local peer'))
353 353
354 354 def unbundle(self, bundle, heads, url):
355 355 """apply a bundle on a repo
356 356
357 357 This function handles the repo locking itself."""
358 358 try:
359 359 try:
360 360 bundle = exchange.readbundle(self.ui, bundle, None)
361 361 ret = exchange.unbundle(self._repo, bundle, heads, b'push', url)
362 362 if util.safehasattr(ret, b'getchunks'):
363 363 # This is a bundle20 object, turn it into an unbundler.
364 364 # This little dance should be dropped eventually when the
365 365 # API is finally improved.
366 366 stream = util.chunkbuffer(ret.getchunks())
367 367 ret = bundle2.getunbundler(self.ui, stream)
368 368 return ret
369 369 except Exception as exc:
370 370 # If the exception contains output salvaged from a bundle2
371 371 # reply, we need to make sure it is printed before continuing
372 372 # to fail. So we build a bundle2 with such output and consume
373 373 # it directly.
374 374 #
375 375 # This is not very elegant but allows a "simple" solution for
376 376 # issue4594
377 377 output = getattr(exc, '_bundle2salvagedoutput', ())
378 378 if output:
379 379 bundler = bundle2.bundle20(self._repo.ui)
380 380 for out in output:
381 381 bundler.addpart(out)
382 382 stream = util.chunkbuffer(bundler.getchunks())
383 383 b = bundle2.getunbundler(self.ui, stream)
384 384 bundle2.processbundle(self._repo, b)
385 385 raise
386 386 except error.PushRaced as exc:
387 387 raise error.ResponseError(
388 388 _(b'push failed:'), stringutil.forcebytestr(exc)
389 389 )
390 390
391 391 # End of _basewirecommands interface.
392 392
393 393 # Begin of peer interface.
394 394
395 395 def commandexecutor(self):
396 396 return localcommandexecutor(self)
397 397
398 398 # End of peer interface.
399 399
400 400
401 401 @interfaceutil.implementer(repository.ipeerlegacycommands)
402 402 class locallegacypeer(localpeer):
403 403 """peer extension which implements legacy methods too; used for tests with
404 404 restricted capabilities"""
405 405
406 406 def __init__(self, repo):
407 407 super(locallegacypeer, self).__init__(repo, caps=legacycaps)
408 408
409 409 # Begin of baselegacywirecommands interface.
410 410
411 411 def between(self, pairs):
412 412 return self._repo.between(pairs)
413 413
414 414 def branches(self, nodes):
415 415 return self._repo.branches(nodes)
416 416
417 417 def changegroup(self, nodes, source):
418 418 outgoing = discovery.outgoing(
419 419 self._repo, missingroots=nodes, ancestorsof=self._repo.heads()
420 420 )
421 421 return changegroup.makechangegroup(self._repo, outgoing, b'01', source)
422 422
423 423 def changegroupsubset(self, bases, heads, source):
424 424 outgoing = discovery.outgoing(
425 425 self._repo, missingroots=bases, ancestorsof=heads
426 426 )
427 427 return changegroup.makechangegroup(self._repo, outgoing, b'01', source)
428 428
429 429 # End of baselegacywirecommands interface.
430 430
431 431
432 432 # Functions receiving (ui, features) that extensions can register to impact
433 433 # the ability to load repositories with custom requirements. Only
434 434 # functions defined in loaded extensions are called.
435 435 #
436 436 # The function receives a set of requirement strings that the repository
437 437 # is capable of opening. Functions will typically add elements to the
438 438 # set to reflect that the extension knows how to handle that requirements.
439 439 featuresetupfuncs = set()
440 440
441 441
442 442 def _getsharedvfs(hgvfs, requirements):
443 443 """returns the vfs object pointing to root of shared source
444 444 repo for a shared repository
445 445
446 446 hgvfs is vfs pointing at .hg/ of current repo (shared one)
447 447 requirements is a set of requirements of current repo (shared one)
448 448 """
449 449 # The ``shared`` or ``relshared`` requirements indicate the
450 450 # store lives in the path contained in the ``.hg/sharedpath`` file.
451 451 # This is an absolute path for ``shared`` and relative to
452 452 # ``.hg/`` for ``relshared``.
453 453 sharedpath = hgvfs.read(b'sharedpath').rstrip(b'\n')
454 454 if requirementsmod.RELATIVE_SHARED_REQUIREMENT in requirements:
455 455 sharedpath = hgvfs.join(sharedpath)
456 456
457 457 sharedvfs = vfsmod.vfs(sharedpath, realpath=True)
458 458
459 459 if not sharedvfs.exists():
460 460 raise error.RepoError(
461 461 _(b'.hg/sharedpath points to nonexistent directory %s')
462 462 % sharedvfs.base
463 463 )
464 464 return sharedvfs
465 465
466 466
467 467 def _readrequires(vfs, allowmissing):
468 468 """reads the require file present at root of this vfs
469 469 and return a set of requirements
470 470
471 471 If allowmissing is True, we suppress ENOENT if raised"""
472 472 # requires file contains a newline-delimited list of
473 473 # features/capabilities the opener (us) must have in order to use
474 474 # the repository. This file was introduced in Mercurial 0.9.2,
475 475 # which means very old repositories may not have one. We assume
476 476 # a missing file translates to no requirements.
477 477 try:
478 478 requirements = set(vfs.read(b'requires').splitlines())
479 479 except IOError as e:
480 480 if not (allowmissing and e.errno == errno.ENOENT):
481 481 raise
482 482 requirements = set()
483 483 return requirements
484 484
485 485
486 486 def makelocalrepository(baseui, path, intents=None):
487 487 """Create a local repository object.
488 488
489 489 Given arguments needed to construct a local repository, this function
490 490 performs various early repository loading functionality (such as
491 491 reading the ``.hg/requires`` and ``.hg/hgrc`` files), validates that
492 492 the repository can be opened, derives a type suitable for representing
493 493 that repository, and returns an instance of it.
494 494
495 495 The returned object conforms to the ``repository.completelocalrepository``
496 496 interface.
497 497
498 498 The repository type is derived by calling a series of factory functions
499 499 for each aspect/interface of the final repository. These are defined by
500 500 ``REPO_INTERFACES``.
501 501
502 502 Each factory function is called to produce a type implementing a specific
503 503 interface. The cumulative list of returned types will be combined into a
504 504 new type and that type will be instantiated to represent the local
505 505 repository.
506 506
507 507 The factory functions each receive various state that may be consulted
508 508 as part of deriving a type.
509 509
510 510 Extensions should wrap these factory functions to customize repository type
511 511 creation. Note that an extension's wrapped function may be called even if
512 512 that extension is not loaded for the repo being constructed. Extensions
513 513 should check if their ``__name__`` appears in the
514 514 ``extensionmodulenames`` set passed to the factory function and no-op if
515 515 not.
516 516 """
517 517 ui = baseui.copy()
518 518 # Prevent copying repo configuration.
519 519 ui.copy = baseui.copy
520 520
521 521 # Working directory VFS rooted at repository root.
522 522 wdirvfs = vfsmod.vfs(path, expandpath=True, realpath=True)
523 523
524 524 # Main VFS for .hg/ directory.
525 525 hgpath = wdirvfs.join(b'.hg')
526 526 hgvfs = vfsmod.vfs(hgpath, cacheaudited=True)
527 527 # Whether this repository is shared one or not
528 528 shared = False
529 529 # If this repository is shared, vfs pointing to shared repo
530 530 sharedvfs = None
531 531
532 532 # The .hg/ path should exist and should be a directory. All other
533 533 # cases are errors.
534 534 if not hgvfs.isdir():
535 535 try:
536 536 hgvfs.stat()
537 537 except OSError as e:
538 538 if e.errno != errno.ENOENT:
539 539 raise
540 540 except ValueError as e:
541 541 # Can be raised on Python 3.8 when path is invalid.
542 542 raise error.Abort(
543 543 _(b'invalid path %s: %s') % (path, stringutil.forcebytestr(e))
544 544 )
545 545
546 546 raise error.RepoError(_(b'repository %s not found') % path)
547 547
548 548 requirements = _readrequires(hgvfs, True)
549 549 shared = (
550 550 requirementsmod.SHARED_REQUIREMENT in requirements
551 551 or requirementsmod.RELATIVE_SHARED_REQUIREMENT in requirements
552 552 )
553 553 storevfs = None
554 554 if shared:
555 555 # This is a shared repo
556 556 sharedvfs = _getsharedvfs(hgvfs, requirements)
557 557 storevfs = vfsmod.vfs(sharedvfs.join(b'store'))
558 558 else:
559 559 storevfs = vfsmod.vfs(hgvfs.join(b'store'))
560 560
561 561 # if .hg/requires contains the sharesafe requirement, it means
562 562 # there exists a `.hg/store/requires` too and we should read it
563 563 # NOTE: presence of SHARESAFE_REQUIREMENT imply that store requirement
564 564 # is present. We never write SHARESAFE_REQUIREMENT for a repo if store
565 565 # is not present, refer checkrequirementscompat() for that
566 566 #
567 567 # However, if SHARESAFE_REQUIREMENT is not present, it means that the
568 568 # repository was shared the old way. We check the share source .hg/requires
569 569 # for SHARESAFE_REQUIREMENT to detect whether the current repository needs
570 570 # to be reshared
571 571 hint = _(b"see `hg help config.format.use-share-safe` for more information")
572 572 if requirementsmod.SHARESAFE_REQUIREMENT in requirements:
573 573
574 574 if (
575 575 shared
576 576 and requirementsmod.SHARESAFE_REQUIREMENT
577 577 not in _readrequires(sharedvfs, True)
578 578 ):
579 579 mismatch_warn = ui.configbool(
580 580 b'share', b'safe-mismatch.source-not-safe.warn'
581 581 )
582 582 mismatch_config = ui.config(
583 583 b'share', b'safe-mismatch.source-not-safe'
584 584 )
585 585 if mismatch_config in (
586 586 b'downgrade-allow',
587 587 b'allow',
588 588 b'downgrade-abort',
589 589 ):
590 590 # prevent cyclic import localrepo -> upgrade -> localrepo
591 591 from . import upgrade
592 592
593 593 upgrade.downgrade_share_to_non_safe(
594 594 ui,
595 595 hgvfs,
596 596 sharedvfs,
597 597 requirements,
598 598 mismatch_config,
599 599 mismatch_warn,
600 600 )
601 601 elif mismatch_config == b'abort':
602 602 raise error.Abort(
603 603 _(b"share source does not support share-safe requirement"),
604 604 hint=hint,
605 605 )
606 606 else:
607 607 raise error.Abort(
608 608 _(
609 609 b"share-safe mismatch with source.\nUnrecognized"
610 610 b" value '%s' of `share.safe-mismatch.source-not-safe`"
611 611 b" set."
612 612 )
613 613 % mismatch_config,
614 614 hint=hint,
615 615 )
616 616 else:
617 617 requirements |= _readrequires(storevfs, False)
618 618 elif shared:
619 619 sourcerequires = _readrequires(sharedvfs, False)
620 620 if requirementsmod.SHARESAFE_REQUIREMENT in sourcerequires:
621 621 mismatch_config = ui.config(b'share', b'safe-mismatch.source-safe')
622 622 mismatch_warn = ui.configbool(
623 623 b'share', b'safe-mismatch.source-safe.warn'
624 624 )
625 625 if mismatch_config in (
626 626 b'upgrade-allow',
627 627 b'allow',
628 628 b'upgrade-abort',
629 629 ):
630 630 # prevent cyclic import localrepo -> upgrade -> localrepo
631 631 from . import upgrade
632 632
633 633 upgrade.upgrade_share_to_safe(
634 634 ui,
635 635 hgvfs,
636 636 storevfs,
637 637 requirements,
638 638 mismatch_config,
639 639 mismatch_warn,
640 640 )
641 641 elif mismatch_config == b'abort':
642 642 raise error.Abort(
643 643 _(
644 644 b'version mismatch: source uses share-safe'
645 645 b' functionality while the current share does not'
646 646 ),
647 647 hint=hint,
648 648 )
649 649 else:
650 650 raise error.Abort(
651 651 _(
652 652 b"share-safe mismatch with source.\nUnrecognized"
653 653 b" value '%s' of `share.safe-mismatch.source-safe` set."
654 654 )
655 655 % mismatch_config,
656 656 hint=hint,
657 657 )
658 658
659 659 # The .hg/hgrc file may load extensions or contain config options
660 660 # that influence repository construction. Attempt to load it and
661 661 # process any new extensions that it may have pulled in.
662 662 if loadhgrc(ui, wdirvfs, hgvfs, requirements, sharedvfs):
663 663 afterhgrcload(ui, wdirvfs, hgvfs, requirements)
664 664 extensions.loadall(ui)
665 665 extensions.populateui(ui)
666 666
667 667 # Set of module names of extensions loaded for this repository.
668 668 extensionmodulenames = {m.__name__ for n, m in extensions.extensions(ui)}
669 669
670 670 supportedrequirements = gathersupportedrequirements(ui)
671 671
672 672 # We first validate the requirements are known.
673 673 ensurerequirementsrecognized(requirements, supportedrequirements)
674 674
675 675 # Then we validate that the known set is reasonable to use together.
676 676 ensurerequirementscompatible(ui, requirements)
677 677
678 678 # TODO there are unhandled edge cases related to opening repositories with
679 679 # shared storage. If storage is shared, we should also test for requirements
680 680 # compatibility in the pointed-to repo. This entails loading the .hg/hgrc in
681 681 # that repo, as that repo may load extensions needed to open it. This is a
682 682 # bit complicated because we don't want the other hgrc to overwrite settings
683 683 # in this hgrc.
684 684 #
685 685 # This bug is somewhat mitigated by the fact that we copy the .hg/requires
686 686 # file when sharing repos. But if a requirement is added after the share is
687 687 # performed, thereby introducing a new requirement for the opener, we may
688 688 # will not see that and could encounter a run-time error interacting with
689 689 # that shared store since it has an unknown-to-us requirement.
690 690
691 691 # At this point, we know we should be capable of opening the repository.
692 692 # Now get on with doing that.
693 693
694 694 features = set()
695 695
696 696 # The "store" part of the repository holds versioned data. How it is
697 697 # accessed is determined by various requirements. If `shared` or
698 698 # `relshared` requirements are present, this indicates current repository
699 699 # is a share and store exists in path mentioned in `.hg/sharedpath`
700 700 if shared:
701 701 storebasepath = sharedvfs.base
702 702 cachepath = sharedvfs.join(b'cache')
703 703 features.add(repository.REPO_FEATURE_SHARED_STORAGE)
704 704 else:
705 705 storebasepath = hgvfs.base
706 706 cachepath = hgvfs.join(b'cache')
707 707 wcachepath = hgvfs.join(b'wcache')
708 708
709 709 # The store has changed over time and the exact layout is dictated by
710 710 # requirements. The store interface abstracts differences across all
711 711 # of them.
712 712 store = makestore(
713 713 requirements,
714 714 storebasepath,
715 715 lambda base: vfsmod.vfs(base, cacheaudited=True),
716 716 )
717 717 hgvfs.createmode = store.createmode
718 718
719 719 storevfs = store.vfs
720 720 storevfs.options = resolvestorevfsoptions(ui, requirements, features)
721 721
722 722 # The cache vfs is used to manage cache files.
723 723 cachevfs = vfsmod.vfs(cachepath, cacheaudited=True)
724 724 cachevfs.createmode = store.createmode
725 725 # The cache vfs is used to manage cache files related to the working copy
726 726 wcachevfs = vfsmod.vfs(wcachepath, cacheaudited=True)
727 727 wcachevfs.createmode = store.createmode
728 728
729 729 # Now resolve the type for the repository object. We do this by repeatedly
730 730 # calling a factory function to produces types for specific aspects of the
731 731 # repo's operation. The aggregate returned types are used as base classes
732 732 # for a dynamically-derived type, which will represent our new repository.
733 733
734 734 bases = []
735 735 extrastate = {}
736 736
737 737 for iface, fn in REPO_INTERFACES:
738 738 # We pass all potentially useful state to give extensions tons of
739 739 # flexibility.
740 740 typ = fn()(
741 741 ui=ui,
742 742 intents=intents,
743 743 requirements=requirements,
744 744 features=features,
745 745 wdirvfs=wdirvfs,
746 746 hgvfs=hgvfs,
747 747 store=store,
748 748 storevfs=storevfs,
749 749 storeoptions=storevfs.options,
750 750 cachevfs=cachevfs,
751 751 wcachevfs=wcachevfs,
752 752 extensionmodulenames=extensionmodulenames,
753 753 extrastate=extrastate,
754 754 baseclasses=bases,
755 755 )
756 756
757 757 if not isinstance(typ, type):
758 758 raise error.ProgrammingError(
759 759 b'unable to construct type for %s' % iface
760 760 )
761 761
762 762 bases.append(typ)
763 763
764 764 # type() allows you to use characters in type names that wouldn't be
765 765 # recognized as Python symbols in source code. We abuse that to add
766 766 # rich information about our constructed repo.
767 767 name = pycompat.sysstr(
768 768 b'derivedrepo:%s<%s>' % (wdirvfs.base, b','.join(sorted(requirements)))
769 769 )
770 770
771 771 cls = type(name, tuple(bases), {})
772 772
773 773 return cls(
774 774 baseui=baseui,
775 775 ui=ui,
776 776 origroot=path,
777 777 wdirvfs=wdirvfs,
778 778 hgvfs=hgvfs,
779 779 requirements=requirements,
780 780 supportedrequirements=supportedrequirements,
781 781 sharedpath=storebasepath,
782 782 store=store,
783 783 cachevfs=cachevfs,
784 784 wcachevfs=wcachevfs,
785 785 features=features,
786 786 intents=intents,
787 787 )
788 788
789 789
790 790 def loadhgrc(ui, wdirvfs, hgvfs, requirements, sharedvfs=None):
791 791 """Load hgrc files/content into a ui instance.
792 792
793 793 This is called during repository opening to load any additional
794 794 config files or settings relevant to the current repository.
795 795
796 796 Returns a bool indicating whether any additional configs were loaded.
797 797
798 798 Extensions should monkeypatch this function to modify how per-repo
799 799 configs are loaded. For example, an extension may wish to pull in
800 800 configs from alternate files or sources.
801 801
802 802 sharedvfs is vfs object pointing to source repo if the current one is a
803 803 shared one
804 804 """
805 805 if not rcutil.use_repo_hgrc():
806 806 return False
807 807
808 808 ret = False
809 809 # first load config from shared source if we has to
810 810 if requirementsmod.SHARESAFE_REQUIREMENT in requirements and sharedvfs:
811 811 try:
812 812 ui.readconfig(sharedvfs.join(b'hgrc'), root=sharedvfs.base)
813 813 ret = True
814 814 except IOError:
815 815 pass
816 816
817 817 try:
818 818 ui.readconfig(hgvfs.join(b'hgrc'), root=wdirvfs.base)
819 819 ret = True
820 820 except IOError:
821 821 pass
822 822
823 823 try:
824 824 ui.readconfig(hgvfs.join(b'hgrc-not-shared'), root=wdirvfs.base)
825 825 ret = True
826 826 except IOError:
827 827 pass
828 828
829 829 return ret
830 830
831 831
832 832 def afterhgrcload(ui, wdirvfs, hgvfs, requirements):
833 833 """Perform additional actions after .hg/hgrc is loaded.
834 834
835 835 This function is called during repository loading immediately after
836 836 the .hg/hgrc file is loaded and before per-repo extensions are loaded.
837 837
838 838 The function can be used to validate configs, automatically add
839 839 options (including extensions) based on requirements, etc.
840 840 """
841 841
842 842 # Map of requirements to list of extensions to load automatically when
843 843 # requirement is present.
844 844 autoextensions = {
845 845 b'git': [b'git'],
846 846 b'largefiles': [b'largefiles'],
847 847 b'lfs': [b'lfs'],
848 848 }
849 849
850 850 for requirement, names in sorted(autoextensions.items()):
851 851 if requirement not in requirements:
852 852 continue
853 853
854 854 for name in names:
855 855 if not ui.hasconfig(b'extensions', name):
856 856 ui.setconfig(b'extensions', name, b'', source=b'autoload')
857 857
858 858
859 859 def gathersupportedrequirements(ui):
860 860 """Determine the complete set of recognized requirements."""
861 861 # Start with all requirements supported by this file.
862 862 supported = set(localrepository._basesupported)
863 863
864 864 # Execute ``featuresetupfuncs`` entries if they belong to an extension
865 865 # relevant to this ui instance.
866 866 modules = {m.__name__ for n, m in extensions.extensions(ui)}
867 867
868 868 for fn in featuresetupfuncs:
869 869 if fn.__module__ in modules:
870 870 fn(ui, supported)
871 871
872 872 # Add derived requirements from registered compression engines.
873 873 for name in util.compengines:
874 874 engine = util.compengines[name]
875 875 if engine.available() and engine.revlogheader():
876 876 supported.add(b'exp-compression-%s' % name)
877 877 if engine.name() == b'zstd':
878 878 supported.add(b'revlog-compression-zstd')
879 879
880 880 return supported
881 881
882 882
883 883 def ensurerequirementsrecognized(requirements, supported):
884 884 """Validate that a set of local requirements is recognized.
885 885
886 886 Receives a set of requirements. Raises an ``error.RepoError`` if there
887 887 exists any requirement in that set that currently loaded code doesn't
888 888 recognize.
889 889
890 890 Returns a set of supported requirements.
891 891 """
892 892 missing = set()
893 893
894 894 for requirement in requirements:
895 895 if requirement in supported:
896 896 continue
897 897
898 898 if not requirement or not requirement[0:1].isalnum():
899 899 raise error.RequirementError(_(b'.hg/requires file is corrupt'))
900 900
901 901 missing.add(requirement)
902 902
903 903 if missing:
904 904 raise error.RequirementError(
905 905 _(b'repository requires features unknown to this Mercurial: %s')
906 906 % b' '.join(sorted(missing)),
907 907 hint=_(
908 908 b'see https://mercurial-scm.org/wiki/MissingRequirement '
909 909 b'for more information'
910 910 ),
911 911 )
912 912
913 913
914 914 def ensurerequirementscompatible(ui, requirements):
915 915 """Validates that a set of recognized requirements is mutually compatible.
916 916
917 917 Some requirements may not be compatible with others or require
918 918 config options that aren't enabled. This function is called during
919 919 repository opening to ensure that the set of requirements needed
920 920 to open a repository is sane and compatible with config options.
921 921
922 922 Extensions can monkeypatch this function to perform additional
923 923 checking.
924 924
925 925 ``error.RepoError`` should be raised on failure.
926 926 """
927 927 if (
928 928 requirementsmod.SPARSE_REQUIREMENT in requirements
929 929 and not sparse.enabled
930 930 ):
931 931 raise error.RepoError(
932 932 _(
933 933 b'repository is using sparse feature but '
934 934 b'sparse is not enabled; enable the '
935 935 b'"sparse" extensions to access'
936 936 )
937 937 )
938 938
939 939
940 940 def makestore(requirements, path, vfstype):
941 941 """Construct a storage object for a repository."""
942 942 if b'store' in requirements:
943 943 if b'fncache' in requirements:
944 944 return storemod.fncachestore(
945 945 path, vfstype, b'dotencode' in requirements
946 946 )
947 947
948 948 return storemod.encodedstore(path, vfstype)
949 949
950 950 return storemod.basicstore(path, vfstype)
951 951
952 952
953 953 def resolvestorevfsoptions(ui, requirements, features):
954 954 """Resolve the options to pass to the store vfs opener.
955 955
956 956 The returned dict is used to influence behavior of the storage layer.
957 957 """
958 958 options = {}
959 959
960 960 if requirementsmod.TREEMANIFEST_REQUIREMENT in requirements:
961 961 options[b'treemanifest'] = True
962 962
963 963 # experimental config: format.manifestcachesize
964 964 manifestcachesize = ui.configint(b'format', b'manifestcachesize')
965 965 if manifestcachesize is not None:
966 966 options[b'manifestcachesize'] = manifestcachesize
967 967
968 968 # In the absence of another requirement superseding a revlog-related
969 969 # requirement, we have to assume the repo is using revlog version 0.
970 970 # This revlog format is super old and we don't bother trying to parse
971 971 # opener options for it because those options wouldn't do anything
972 972 # meaningful on such old repos.
973 973 if (
974 974 b'revlogv1' in requirements
975 975 or requirementsmod.REVLOGV2_REQUIREMENT in requirements
976 976 ):
977 977 options.update(resolverevlogstorevfsoptions(ui, requirements, features))
978 978 else: # explicitly mark repo as using revlogv0
979 979 options[b'revlogv0'] = True
980 980
981 981 if requirementsmod.COPIESSDC_REQUIREMENT in requirements:
982 982 options[b'copies-storage'] = b'changeset-sidedata'
983 983 else:
984 984 writecopiesto = ui.config(b'experimental', b'copies.write-to')
985 985 copiesextramode = (b'changeset-only', b'compatibility')
986 986 if writecopiesto in copiesextramode:
987 987 options[b'copies-storage'] = b'extra'
988 988
989 989 return options
990 990
991 991
992 992 def resolverevlogstorevfsoptions(ui, requirements, features):
993 993 """Resolve opener options specific to revlogs."""
994 994
995 995 options = {}
996 996 options[b'flagprocessors'] = {}
997 997
998 998 if b'revlogv1' in requirements:
999 999 options[b'revlogv1'] = True
1000 1000 if requirementsmod.REVLOGV2_REQUIREMENT in requirements:
1001 1001 options[b'revlogv2'] = True
1002 1002
1003 1003 if b'generaldelta' in requirements:
1004 1004 options[b'generaldelta'] = True
1005 1005
1006 1006 # experimental config: format.chunkcachesize
1007 1007 chunkcachesize = ui.configint(b'format', b'chunkcachesize')
1008 1008 if chunkcachesize is not None:
1009 1009 options[b'chunkcachesize'] = chunkcachesize
1010 1010
1011 1011 deltabothparents = ui.configbool(
1012 1012 b'storage', b'revlog.optimize-delta-parent-choice'
1013 1013 )
1014 1014 options[b'deltabothparents'] = deltabothparents
1015 1015
1016 1016 lazydelta = ui.configbool(b'storage', b'revlog.reuse-external-delta')
1017 1017 lazydeltabase = False
1018 1018 if lazydelta:
1019 1019 lazydeltabase = ui.configbool(
1020 1020 b'storage', b'revlog.reuse-external-delta-parent'
1021 1021 )
1022 1022 if lazydeltabase is None:
1023 1023 lazydeltabase = not scmutil.gddeltaconfig(ui)
1024 1024 options[b'lazydelta'] = lazydelta
1025 1025 options[b'lazydeltabase'] = lazydeltabase
1026 1026
1027 1027 chainspan = ui.configbytes(b'experimental', b'maxdeltachainspan')
1028 1028 if 0 <= chainspan:
1029 1029 options[b'maxdeltachainspan'] = chainspan
1030 1030
1031 1031 mmapindexthreshold = ui.configbytes(b'experimental', b'mmapindexthreshold')
1032 1032 if mmapindexthreshold is not None:
1033 1033 options[b'mmapindexthreshold'] = mmapindexthreshold
1034 1034
1035 1035 withsparseread = ui.configbool(b'experimental', b'sparse-read')
1036 1036 srdensitythres = float(
1037 1037 ui.config(b'experimental', b'sparse-read.density-threshold')
1038 1038 )
1039 1039 srmingapsize = ui.configbytes(b'experimental', b'sparse-read.min-gap-size')
1040 1040 options[b'with-sparse-read'] = withsparseread
1041 1041 options[b'sparse-read-density-threshold'] = srdensitythres
1042 1042 options[b'sparse-read-min-gap-size'] = srmingapsize
1043 1043
1044 1044 sparserevlog = requirementsmod.SPARSEREVLOG_REQUIREMENT in requirements
1045 1045 options[b'sparse-revlog'] = sparserevlog
1046 1046 if sparserevlog:
1047 1047 options[b'generaldelta'] = True
1048 1048
1049 1049 sidedata = requirementsmod.SIDEDATA_REQUIREMENT in requirements
1050 1050 options[b'side-data'] = sidedata
1051 1051
1052 1052 maxchainlen = None
1053 1053 if sparserevlog:
1054 1054 maxchainlen = revlogconst.SPARSE_REVLOG_MAX_CHAIN_LENGTH
1055 1055 # experimental config: format.maxchainlen
1056 1056 maxchainlen = ui.configint(b'format', b'maxchainlen', maxchainlen)
1057 1057 if maxchainlen is not None:
1058 1058 options[b'maxchainlen'] = maxchainlen
1059 1059
1060 1060 for r in requirements:
1061 1061 # we allow multiple compression engine requirement to co-exist because
1062 1062 # strickly speaking, revlog seems to support mixed compression style.
1063 1063 #
1064 1064 # The compression used for new entries will be "the last one"
1065 1065 prefix = r.startswith
1066 1066 if prefix(b'revlog-compression-') or prefix(b'exp-compression-'):
1067 1067 options[b'compengine'] = r.split(b'-', 2)[2]
1068 1068
1069 1069 options[b'zlib.level'] = ui.configint(b'storage', b'revlog.zlib.level')
1070 1070 if options[b'zlib.level'] is not None:
1071 1071 if not (0 <= options[b'zlib.level'] <= 9):
1072 1072 msg = _(b'invalid value for `storage.revlog.zlib.level` config: %d')
1073 1073 raise error.Abort(msg % options[b'zlib.level'])
1074 1074 options[b'zstd.level'] = ui.configint(b'storage', b'revlog.zstd.level')
1075 1075 if options[b'zstd.level'] is not None:
1076 1076 if not (0 <= options[b'zstd.level'] <= 22):
1077 1077 msg = _(b'invalid value for `storage.revlog.zstd.level` config: %d')
1078 1078 raise error.Abort(msg % options[b'zstd.level'])
1079 1079
1080 1080 if requirementsmod.NARROW_REQUIREMENT in requirements:
1081 1081 options[b'enableellipsis'] = True
1082 1082
1083 1083 if ui.configbool(b'experimental', b'rust.index'):
1084 1084 options[b'rust.index'] = True
1085 1085 if requirementsmod.NODEMAP_REQUIREMENT in requirements:
1086 1086 slow_path = ui.config(
1087 1087 b'storage', b'revlog.persistent-nodemap.slow-path'
1088 1088 )
1089 1089 if slow_path not in (b'allow', b'warn', b'abort'):
1090 1090 default = ui.config_default(
1091 1091 b'storage', b'revlog.persistent-nodemap.slow-path'
1092 1092 )
1093 1093 msg = _(
1094 1094 b'unknown value for config '
1095 1095 b'"storage.revlog.persistent-nodemap.slow-path": "%s"\n'
1096 1096 )
1097 1097 ui.warn(msg % slow_path)
1098 1098 if not ui.quiet:
1099 1099 ui.warn(_(b'falling back to default value: %s\n') % default)
1100 1100 slow_path = default
1101 1101
1102 1102 msg = _(
1103 1103 b"accessing `persistent-nodemap` repository without associated "
1104 1104 b"fast implementation."
1105 1105 )
1106 1106 hint = _(
1107 1107 b"check `hg help config.format.use-persistent-nodemap` "
1108 1108 b"for details"
1109 1109 )
1110 1110 if not revlog.HAS_FAST_PERSISTENT_NODEMAP:
1111 1111 if slow_path == b'warn':
1112 1112 msg = b"warning: " + msg + b'\n'
1113 1113 ui.warn(msg)
1114 1114 if not ui.quiet:
1115 1115 hint = b'(' + hint + b')\n'
1116 1116 ui.warn(hint)
1117 1117 if slow_path == b'abort':
1118 1118 raise error.Abort(msg, hint=hint)
1119 1119 options[b'persistent-nodemap'] = True
1120 1120 if ui.configbool(b'storage', b'revlog.persistent-nodemap.mmap'):
1121 1121 options[b'persistent-nodemap.mmap'] = True
1122 1122 if ui.configbool(b'devel', b'persistent-nodemap'):
1123 1123 options[b'devel-force-nodemap'] = True
1124 1124
1125 1125 return options
1126 1126
1127 1127
1128 1128 def makemain(**kwargs):
1129 1129 """Produce a type conforming to ``ilocalrepositorymain``."""
1130 1130 return localrepository
1131 1131
1132 1132
1133 1133 @interfaceutil.implementer(repository.ilocalrepositoryfilestorage)
1134 1134 class revlogfilestorage(object):
1135 1135 """File storage when using revlogs."""
1136 1136
1137 1137 def file(self, path):
1138 1138 if path.startswith(b'/'):
1139 1139 path = path[1:]
1140 1140
1141 1141 return filelog.filelog(self.svfs, path)
1142 1142
1143 1143
1144 1144 @interfaceutil.implementer(repository.ilocalrepositoryfilestorage)
1145 1145 class revlognarrowfilestorage(object):
1146 1146 """File storage when using revlogs and narrow files."""
1147 1147
1148 1148 def file(self, path):
1149 1149 if path.startswith(b'/'):
1150 1150 path = path[1:]
1151 1151
1152 1152 return filelog.narrowfilelog(self.svfs, path, self._storenarrowmatch)
1153 1153
1154 1154
1155 1155 def makefilestorage(requirements, features, **kwargs):
1156 1156 """Produce a type conforming to ``ilocalrepositoryfilestorage``."""
1157 1157 features.add(repository.REPO_FEATURE_REVLOG_FILE_STORAGE)
1158 1158 features.add(repository.REPO_FEATURE_STREAM_CLONE)
1159 1159
1160 1160 if requirementsmod.NARROW_REQUIREMENT in requirements:
1161 1161 return revlognarrowfilestorage
1162 1162 else:
1163 1163 return revlogfilestorage
1164 1164
1165 1165
1166 1166 # List of repository interfaces and factory functions for them. Each
1167 1167 # will be called in order during ``makelocalrepository()`` to iteratively
1168 1168 # derive the final type for a local repository instance. We capture the
1169 1169 # function as a lambda so we don't hold a reference and the module-level
1170 1170 # functions can be wrapped.
1171 1171 REPO_INTERFACES = [
1172 1172 (repository.ilocalrepositorymain, lambda: makemain),
1173 1173 (repository.ilocalrepositoryfilestorage, lambda: makefilestorage),
1174 1174 ]
1175 1175
1176 1176
1177 1177 @interfaceutil.implementer(repository.ilocalrepositorymain)
1178 1178 class localrepository(object):
1179 1179 """Main class for representing local repositories.
1180 1180
1181 1181 All local repositories are instances of this class.
1182 1182
1183 1183 Constructed on its own, instances of this class are not usable as
1184 1184 repository objects. To obtain a usable repository object, call
1185 1185 ``hg.repository()``, ``localrepo.instance()``, or
1186 1186 ``localrepo.makelocalrepository()``. The latter is the lowest-level.
1187 1187 ``instance()`` adds support for creating new repositories.
1188 1188 ``hg.repository()`` adds more extension integration, including calling
1189 1189 ``reposetup()``. Generally speaking, ``hg.repository()`` should be
1190 1190 used.
1191 1191 """
1192 1192
1193 1193 # obsolete experimental requirements:
1194 1194 # - manifestv2: An experimental new manifest format that allowed
1195 1195 # for stem compression of long paths. Experiment ended up not
1196 1196 # being successful (repository sizes went up due to worse delta
1197 1197 # chains), and the code was deleted in 4.6.
1198 1198 supportedformats = {
1199 1199 b'revlogv1',
1200 1200 b'generaldelta',
1201 1201 requirementsmod.TREEMANIFEST_REQUIREMENT,
1202 1202 requirementsmod.COPIESSDC_REQUIREMENT,
1203 1203 requirementsmod.REVLOGV2_REQUIREMENT,
1204 1204 requirementsmod.SIDEDATA_REQUIREMENT,
1205 1205 requirementsmod.SPARSEREVLOG_REQUIREMENT,
1206 1206 requirementsmod.NODEMAP_REQUIREMENT,
1207 1207 bookmarks.BOOKMARKS_IN_STORE_REQUIREMENT,
1208 1208 requirementsmod.SHARESAFE_REQUIREMENT,
1209 1209 }
1210 1210 _basesupported = supportedformats | {
1211 1211 b'store',
1212 1212 b'fncache',
1213 1213 requirementsmod.SHARED_REQUIREMENT,
1214 1214 requirementsmod.RELATIVE_SHARED_REQUIREMENT,
1215 1215 b'dotencode',
1216 1216 requirementsmod.SPARSE_REQUIREMENT,
1217 1217 requirementsmod.INTERNAL_PHASE_REQUIREMENT,
1218 1218 }
1219 1219
1220 1220 # list of prefix for file which can be written without 'wlock'
1221 1221 # Extensions should extend this list when needed
1222 1222 _wlockfreeprefix = {
1223 1223 # We migh consider requiring 'wlock' for the next
1224 1224 # two, but pretty much all the existing code assume
1225 1225 # wlock is not needed so we keep them excluded for
1226 1226 # now.
1227 1227 b'hgrc',
1228 1228 b'requires',
1229 1229 # XXX cache is a complicatged business someone
1230 1230 # should investigate this in depth at some point
1231 1231 b'cache/',
1232 1232 # XXX shouldn't be dirstate covered by the wlock?
1233 1233 b'dirstate',
1234 1234 # XXX bisect was still a bit too messy at the time
1235 1235 # this changeset was introduced. Someone should fix
1236 1236 # the remainig bit and drop this line
1237 1237 b'bisect.state',
1238 1238 }
1239 1239
1240 1240 def __init__(
1241 1241 self,
1242 1242 baseui,
1243 1243 ui,
1244 1244 origroot,
1245 1245 wdirvfs,
1246 1246 hgvfs,
1247 1247 requirements,
1248 1248 supportedrequirements,
1249 1249 sharedpath,
1250 1250 store,
1251 1251 cachevfs,
1252 1252 wcachevfs,
1253 1253 features,
1254 1254 intents=None,
1255 1255 ):
1256 1256 """Create a new local repository instance.
1257 1257
1258 1258 Most callers should use ``hg.repository()``, ``localrepo.instance()``,
1259 1259 or ``localrepo.makelocalrepository()`` for obtaining a new repository
1260 1260 object.
1261 1261
1262 1262 Arguments:
1263 1263
1264 1264 baseui
1265 1265 ``ui.ui`` instance that ``ui`` argument was based off of.
1266 1266
1267 1267 ui
1268 1268 ``ui.ui`` instance for use by the repository.
1269 1269
1270 1270 origroot
1271 1271 ``bytes`` path to working directory root of this repository.
1272 1272
1273 1273 wdirvfs
1274 1274 ``vfs.vfs`` rooted at the working directory.
1275 1275
1276 1276 hgvfs
1277 1277 ``vfs.vfs`` rooted at .hg/
1278 1278
1279 1279 requirements
1280 1280 ``set`` of bytestrings representing repository opening requirements.
1281 1281
1282 1282 supportedrequirements
1283 1283 ``set`` of bytestrings representing repository requirements that we
1284 1284 know how to open. May be a supetset of ``requirements``.
1285 1285
1286 1286 sharedpath
1287 1287 ``bytes`` Defining path to storage base directory. Points to a
1288 1288 ``.hg/`` directory somewhere.
1289 1289
1290 1290 store
1291 1291 ``store.basicstore`` (or derived) instance providing access to
1292 1292 versioned storage.
1293 1293
1294 1294 cachevfs
1295 1295 ``vfs.vfs`` used for cache files.
1296 1296
1297 1297 wcachevfs
1298 1298 ``vfs.vfs`` used for cache files related to the working copy.
1299 1299
1300 1300 features
1301 1301 ``set`` of bytestrings defining features/capabilities of this
1302 1302 instance.
1303 1303
1304 1304 intents
1305 1305 ``set`` of system strings indicating what this repo will be used
1306 1306 for.
1307 1307 """
1308 1308 self.baseui = baseui
1309 1309 self.ui = ui
1310 1310 self.origroot = origroot
1311 1311 # vfs rooted at working directory.
1312 1312 self.wvfs = wdirvfs
1313 1313 self.root = wdirvfs.base
1314 1314 # vfs rooted at .hg/. Used to access most non-store paths.
1315 1315 self.vfs = hgvfs
1316 1316 self.path = hgvfs.base
1317 1317 self.requirements = requirements
1318 1318 self.supported = supportedrequirements
1319 1319 self.sharedpath = sharedpath
1320 1320 self.store = store
1321 1321 self.cachevfs = cachevfs
1322 1322 self.wcachevfs = wcachevfs
1323 1323 self.features = features
1324 1324
1325 1325 self.filtername = None
1326 1326
1327 1327 if self.ui.configbool(b'devel', b'all-warnings') or self.ui.configbool(
1328 1328 b'devel', b'check-locks'
1329 1329 ):
1330 1330 self.vfs.audit = self._getvfsward(self.vfs.audit)
1331 1331 # A list of callback to shape the phase if no data were found.
1332 1332 # Callback are in the form: func(repo, roots) --> processed root.
1333 1333 # This list it to be filled by extension during repo setup
1334 1334 self._phasedefaults = []
1335 1335
1336 1336 color.setup(self.ui)
1337 1337
1338 1338 self.spath = self.store.path
1339 1339 self.svfs = self.store.vfs
1340 1340 self.sjoin = self.store.join
1341 1341 if self.ui.configbool(b'devel', b'all-warnings') or self.ui.configbool(
1342 1342 b'devel', b'check-locks'
1343 1343 ):
1344 1344 if util.safehasattr(self.svfs, b'vfs'): # this is filtervfs
1345 1345 self.svfs.vfs.audit = self._getsvfsward(self.svfs.vfs.audit)
1346 1346 else: # standard vfs
1347 1347 self.svfs.audit = self._getsvfsward(self.svfs.audit)
1348 1348
1349 1349 self._dirstatevalidatewarned = False
1350 1350
1351 1351 self._branchcaches = branchmap.BranchMapCache()
1352 1352 self._revbranchcache = None
1353 1353 self._filterpats = {}
1354 1354 self._datafilters = {}
1355 1355 self._transref = self._lockref = self._wlockref = None
1356 1356
1357 1357 # A cache for various files under .hg/ that tracks file changes,
1358 1358 # (used by the filecache decorator)
1359 1359 #
1360 1360 # Maps a property name to its util.filecacheentry
1361 1361 self._filecache = {}
1362 1362
1363 1363 # hold sets of revision to be filtered
1364 1364 # should be cleared when something might have changed the filter value:
1365 1365 # - new changesets,
1366 1366 # - phase change,
1367 1367 # - new obsolescence marker,
1368 1368 # - working directory parent change,
1369 1369 # - bookmark changes
1370 1370 self.filteredrevcache = {}
1371 1371
1372 1372 # post-dirstate-status hooks
1373 1373 self._postdsstatus = []
1374 1374
1375 1375 # generic mapping between names and nodes
1376 1376 self.names = namespaces.namespaces()
1377 1377
1378 1378 # Key to signature value.
1379 1379 self._sparsesignaturecache = {}
1380 1380 # Signature to cached matcher instance.
1381 1381 self._sparsematchercache = {}
1382 1382
1383 1383 self._extrafilterid = repoview.extrafilter(ui)
1384 1384
1385 1385 self.filecopiesmode = None
1386 1386 if requirementsmod.COPIESSDC_REQUIREMENT in self.requirements:
1387 1387 self.filecopiesmode = b'changeset-sidedata'
1388 1388
1389 1389 def _getvfsward(self, origfunc):
1390 1390 """build a ward for self.vfs"""
1391 1391 rref = weakref.ref(self)
1392 1392
1393 1393 def checkvfs(path, mode=None):
1394 1394 ret = origfunc(path, mode=mode)
1395 1395 repo = rref()
1396 1396 if (
1397 1397 repo is None
1398 1398 or not util.safehasattr(repo, b'_wlockref')
1399 1399 or not util.safehasattr(repo, b'_lockref')
1400 1400 ):
1401 1401 return
1402 1402 if mode in (None, b'r', b'rb'):
1403 1403 return
1404 1404 if path.startswith(repo.path):
1405 1405 # truncate name relative to the repository (.hg)
1406 1406 path = path[len(repo.path) + 1 :]
1407 1407 if path.startswith(b'cache/'):
1408 1408 msg = b'accessing cache with vfs instead of cachevfs: "%s"'
1409 1409 repo.ui.develwarn(msg % path, stacklevel=3, config=b"cache-vfs")
1410 1410 # path prefixes covered by 'lock'
1411 1411 vfs_path_prefixes = (
1412 1412 b'journal.',
1413 1413 b'undo.',
1414 1414 b'strip-backup/',
1415 1415 b'cache/',
1416 1416 )
1417 1417 if any(path.startswith(prefix) for prefix in vfs_path_prefixes):
1418 1418 if repo._currentlock(repo._lockref) is None:
1419 1419 repo.ui.develwarn(
1420 1420 b'write with no lock: "%s"' % path,
1421 1421 stacklevel=3,
1422 1422 config=b'check-locks',
1423 1423 )
1424 1424 elif repo._currentlock(repo._wlockref) is None:
1425 1425 # rest of vfs files are covered by 'wlock'
1426 1426 #
1427 1427 # exclude special files
1428 1428 for prefix in self._wlockfreeprefix:
1429 1429 if path.startswith(prefix):
1430 1430 return
1431 1431 repo.ui.develwarn(
1432 1432 b'write with no wlock: "%s"' % path,
1433 1433 stacklevel=3,
1434 1434 config=b'check-locks',
1435 1435 )
1436 1436 return ret
1437 1437
1438 1438 return checkvfs
1439 1439
1440 1440 def _getsvfsward(self, origfunc):
1441 1441 """build a ward for self.svfs"""
1442 1442 rref = weakref.ref(self)
1443 1443
1444 1444 def checksvfs(path, mode=None):
1445 1445 ret = origfunc(path, mode=mode)
1446 1446 repo = rref()
1447 1447 if repo is None or not util.safehasattr(repo, b'_lockref'):
1448 1448 return
1449 1449 if mode in (None, b'r', b'rb'):
1450 1450 return
1451 1451 if path.startswith(repo.sharedpath):
1452 1452 # truncate name relative to the repository (.hg)
1453 1453 path = path[len(repo.sharedpath) + 1 :]
1454 1454 if repo._currentlock(repo._lockref) is None:
1455 1455 repo.ui.develwarn(
1456 1456 b'write with no lock: "%s"' % path, stacklevel=4
1457 1457 )
1458 1458 return ret
1459 1459
1460 1460 return checksvfs
1461 1461
1462 1462 def close(self):
1463 1463 self._writecaches()
1464 1464
1465 1465 def _writecaches(self):
1466 1466 if self._revbranchcache:
1467 1467 self._revbranchcache.write()
1468 1468
1469 1469 def _restrictcapabilities(self, caps):
1470 1470 if self.ui.configbool(b'experimental', b'bundle2-advertise'):
1471 1471 caps = set(caps)
1472 1472 capsblob = bundle2.encodecaps(
1473 1473 bundle2.getrepocaps(self, role=b'client')
1474 1474 )
1475 1475 caps.add(b'bundle2=' + urlreq.quote(capsblob))
1476 1476 return caps
1477 1477
1478 1478 # Don't cache auditor/nofsauditor, or you'll end up with reference cycle:
1479 1479 # self -> auditor -> self._checknested -> self
1480 1480
1481 1481 @property
1482 1482 def auditor(self):
1483 1483 # This is only used by context.workingctx.match in order to
1484 1484 # detect files in subrepos.
1485 1485 return pathutil.pathauditor(self.root, callback=self._checknested)
1486 1486
1487 1487 @property
1488 1488 def nofsauditor(self):
1489 1489 # This is only used by context.basectx.match in order to detect
1490 1490 # files in subrepos.
1491 1491 return pathutil.pathauditor(
1492 1492 self.root, callback=self._checknested, realfs=False, cached=True
1493 1493 )
1494 1494
1495 1495 def _checknested(self, path):
1496 1496 """Determine if path is a legal nested repository."""
1497 1497 if not path.startswith(self.root):
1498 1498 return False
1499 1499 subpath = path[len(self.root) + 1 :]
1500 1500 normsubpath = util.pconvert(subpath)
1501 1501
1502 1502 # XXX: Checking against the current working copy is wrong in
1503 1503 # the sense that it can reject things like
1504 1504 #
1505 1505 # $ hg cat -r 10 sub/x.txt
1506 1506 #
1507 1507 # if sub/ is no longer a subrepository in the working copy
1508 1508 # parent revision.
1509 1509 #
1510 1510 # However, it can of course also allow things that would have
1511 1511 # been rejected before, such as the above cat command if sub/
1512 1512 # is a subrepository now, but was a normal directory before.
1513 1513 # The old path auditor would have rejected by mistake since it
1514 1514 # panics when it sees sub/.hg/.
1515 1515 #
1516 1516 # All in all, checking against the working copy seems sensible
1517 1517 # since we want to prevent access to nested repositories on
1518 1518 # the filesystem *now*.
1519 1519 ctx = self[None]
1520 1520 parts = util.splitpath(subpath)
1521 1521 while parts:
1522 1522 prefix = b'/'.join(parts)
1523 1523 if prefix in ctx.substate:
1524 1524 if prefix == normsubpath:
1525 1525 return True
1526 1526 else:
1527 1527 sub = ctx.sub(prefix)
1528 1528 return sub.checknested(subpath[len(prefix) + 1 :])
1529 1529 else:
1530 1530 parts.pop()
1531 1531 return False
1532 1532
1533 1533 def peer(self):
1534 1534 return localpeer(self) # not cached to avoid reference cycle
1535 1535
1536 1536 def unfiltered(self):
1537 1537 """Return unfiltered version of the repository
1538 1538
1539 1539 Intended to be overwritten by filtered repo."""
1540 1540 return self
1541 1541
1542 1542 def filtered(self, name, visibilityexceptions=None):
1543 1543 """Return a filtered version of a repository
1544 1544
1545 1545 The `name` parameter is the identifier of the requested view. This
1546 1546 will return a repoview object set "exactly" to the specified view.
1547 1547
1548 1548 This function does not apply recursive filtering to a repository. For
1549 1549 example calling `repo.filtered("served")` will return a repoview using
1550 1550 the "served" view, regardless of the initial view used by `repo`.
1551 1551
1552 1552 In other word, there is always only one level of `repoview` "filtering".
1553 1553 """
1554 1554 if self._extrafilterid is not None and b'%' not in name:
1555 1555 name = name + b'%' + self._extrafilterid
1556 1556
1557 1557 cls = repoview.newtype(self.unfiltered().__class__)
1558 1558 return cls(self, name, visibilityexceptions)
1559 1559
1560 1560 @mixedrepostorecache(
1561 1561 (b'bookmarks', b'plain'),
1562 1562 (b'bookmarks.current', b'plain'),
1563 1563 (b'bookmarks', b''),
1564 1564 (b'00changelog.i', b''),
1565 1565 )
1566 1566 def _bookmarks(self):
1567 1567 # Since the multiple files involved in the transaction cannot be
1568 1568 # written atomically (with current repository format), there is a race
1569 1569 # condition here.
1570 1570 #
1571 1571 # 1) changelog content A is read
1572 1572 # 2) outside transaction update changelog to content B
1573 1573 # 3) outside transaction update bookmark file referring to content B
1574 1574 # 4) bookmarks file content is read and filtered against changelog-A
1575 1575 #
1576 1576 # When this happens, bookmarks against nodes missing from A are dropped.
1577 1577 #
1578 1578 # Having this happening during read is not great, but it become worse
1579 1579 # when this happen during write because the bookmarks to the "unknown"
1580 1580 # nodes will be dropped for good. However, writes happen within locks.
1581 1581 # This locking makes it possible to have a race free consistent read.
1582 1582 # For this purpose data read from disc before locking are
1583 1583 # "invalidated" right after the locks are taken. This invalidations are
1584 1584 # "light", the `filecache` mechanism keep the data in memory and will
1585 1585 # reuse them if the underlying files did not changed. Not parsing the
1586 1586 # same data multiple times helps performances.
1587 1587 #
1588 1588 # Unfortunately in the case describe above, the files tracked by the
1589 1589 # bookmarks file cache might not have changed, but the in-memory
1590 1590 # content is still "wrong" because we used an older changelog content
1591 1591 # to process the on-disk data. So after locking, the changelog would be
1592 1592 # refreshed but `_bookmarks` would be preserved.
1593 1593 # Adding `00changelog.i` to the list of tracked file is not
1594 1594 # enough, because at the time we build the content for `_bookmarks` in
1595 1595 # (4), the changelog file has already diverged from the content used
1596 1596 # for loading `changelog` in (1)
1597 1597 #
1598 1598 # To prevent the issue, we force the changelog to be explicitly
1599 1599 # reloaded while computing `_bookmarks`. The data race can still happen
1600 1600 # without the lock (with a narrower window), but it would no longer go
1601 1601 # undetected during the lock time refresh.
1602 1602 #
1603 1603 # The new schedule is as follow
1604 1604 #
1605 1605 # 1) filecache logic detect that `_bookmarks` needs to be computed
1606 1606 # 2) cachestat for `bookmarks` and `changelog` are captured (for book)
1607 1607 # 3) We force `changelog` filecache to be tested
1608 1608 # 4) cachestat for `changelog` are captured (for changelog)
1609 1609 # 5) `_bookmarks` is computed and cached
1610 1610 #
1611 1611 # The step in (3) ensure we have a changelog at least as recent as the
1612 1612 # cache stat computed in (1). As a result at locking time:
1613 1613 # * if the changelog did not changed since (1) -> we can reuse the data
1614 1614 # * otherwise -> the bookmarks get refreshed.
1615 1615 self._refreshchangelog()
1616 1616 return bookmarks.bmstore(self)
1617 1617
1618 1618 def _refreshchangelog(self):
1619 1619 """make sure the in memory changelog match the on-disk one"""
1620 1620 if 'changelog' in vars(self) and self.currenttransaction() is None:
1621 1621 del self.changelog
1622 1622
1623 1623 @property
1624 1624 def _activebookmark(self):
1625 1625 return self._bookmarks.active
1626 1626
1627 1627 # _phasesets depend on changelog. what we need is to call
1628 1628 # _phasecache.invalidate() if '00changelog.i' was changed, but it
1629 1629 # can't be easily expressed in filecache mechanism.
1630 1630 @storecache(b'phaseroots', b'00changelog.i')
1631 1631 def _phasecache(self):
1632 1632 return phases.phasecache(self, self._phasedefaults)
1633 1633
1634 1634 @storecache(b'obsstore')
1635 1635 def obsstore(self):
1636 1636 return obsolete.makestore(self.ui, self)
1637 1637
1638 1638 @storecache(b'00changelog.i')
1639 1639 def changelog(self):
1640 1640 # load dirstate before changelog to avoid race see issue6303
1641 1641 self.dirstate.prefetch_parents()
1642 1642 return self.store.changelog(txnutil.mayhavepending(self.root))
1643 1643
1644 1644 @storecache(b'00manifest.i')
1645 1645 def manifestlog(self):
1646 1646 return self.store.manifestlog(self, self._storenarrowmatch)
1647 1647
1648 1648 @repofilecache(b'dirstate')
1649 1649 def dirstate(self):
1650 1650 return self._makedirstate()
1651 1651
1652 1652 def _makedirstate(self):
1653 1653 """Extension point for wrapping the dirstate per-repo."""
1654 1654 sparsematchfn = lambda: sparse.matcher(self)
1655 1655
1656 1656 return dirstate.dirstate(
1657 1657 self.vfs, self.ui, self.root, self._dirstatevalidate, sparsematchfn
1658 1658 )
1659 1659
1660 1660 def _dirstatevalidate(self, node):
1661 1661 try:
1662 1662 self.changelog.rev(node)
1663 1663 return node
1664 1664 except error.LookupError:
1665 1665 if not self._dirstatevalidatewarned:
1666 1666 self._dirstatevalidatewarned = True
1667 1667 self.ui.warn(
1668 1668 _(b"warning: ignoring unknown working parent %s!\n")
1669 1669 % short(node)
1670 1670 )
1671 1671 return nullid
1672 1672
1673 1673 @storecache(narrowspec.FILENAME)
1674 1674 def narrowpats(self):
1675 1675 """matcher patterns for this repository's narrowspec
1676 1676
1677 1677 A tuple of (includes, excludes).
1678 1678 """
1679 1679 return narrowspec.load(self)
1680 1680
1681 1681 @storecache(narrowspec.FILENAME)
1682 1682 def _storenarrowmatch(self):
1683 1683 if requirementsmod.NARROW_REQUIREMENT not in self.requirements:
1684 1684 return matchmod.always()
1685 1685 include, exclude = self.narrowpats
1686 1686 return narrowspec.match(self.root, include=include, exclude=exclude)
1687 1687
1688 1688 @storecache(narrowspec.FILENAME)
1689 1689 def _narrowmatch(self):
1690 1690 if requirementsmod.NARROW_REQUIREMENT not in self.requirements:
1691 1691 return matchmod.always()
1692 1692 narrowspec.checkworkingcopynarrowspec(self)
1693 1693 include, exclude = self.narrowpats
1694 1694 return narrowspec.match(self.root, include=include, exclude=exclude)
1695 1695
1696 1696 def narrowmatch(self, match=None, includeexact=False):
1697 1697 """matcher corresponding the the repo's narrowspec
1698 1698
1699 1699 If `match` is given, then that will be intersected with the narrow
1700 1700 matcher.
1701 1701
1702 1702 If `includeexact` is True, then any exact matches from `match` will
1703 1703 be included even if they're outside the narrowspec.
1704 1704 """
1705 1705 if match:
1706 1706 if includeexact and not self._narrowmatch.always():
1707 1707 # do not exclude explicitly-specified paths so that they can
1708 1708 # be warned later on
1709 1709 em = matchmod.exact(match.files())
1710 1710 nm = matchmod.unionmatcher([self._narrowmatch, em])
1711 1711 return matchmod.intersectmatchers(match, nm)
1712 1712 return matchmod.intersectmatchers(match, self._narrowmatch)
1713 1713 return self._narrowmatch
1714 1714
1715 1715 def setnarrowpats(self, newincludes, newexcludes):
1716 1716 narrowspec.save(self, newincludes, newexcludes)
1717 1717 self.invalidate(clearfilecache=True)
1718 1718
1719 1719 @unfilteredpropertycache
1720 1720 def _quick_access_changeid_null(self):
1721 1721 return {
1722 1722 b'null': (nullrev, nullid),
1723 1723 nullrev: (nullrev, nullid),
1724 1724 nullid: (nullrev, nullid),
1725 1725 }
1726 1726
1727 1727 @unfilteredpropertycache
1728 1728 def _quick_access_changeid_wc(self):
1729 1729 # also fast path access to the working copy parents
1730 1730 # however, only do it for filter that ensure wc is visible.
1731 1731 quick = self._quick_access_changeid_null.copy()
1732 1732 cl = self.unfiltered().changelog
1733 1733 for node in self.dirstate.parents():
1734 1734 if node == nullid:
1735 1735 continue
1736 1736 rev = cl.index.get_rev(node)
1737 1737 if rev is None:
1738 1738 # unknown working copy parent case:
1739 1739 #
1740 1740 # skip the fast path and let higher code deal with it
1741 1741 continue
1742 1742 pair = (rev, node)
1743 1743 quick[rev] = pair
1744 1744 quick[node] = pair
1745 1745 # also add the parents of the parents
1746 1746 for r in cl.parentrevs(rev):
1747 1747 if r == nullrev:
1748 1748 continue
1749 1749 n = cl.node(r)
1750 1750 pair = (r, n)
1751 1751 quick[r] = pair
1752 1752 quick[n] = pair
1753 1753 p1node = self.dirstate.p1()
1754 1754 if p1node != nullid:
1755 1755 quick[b'.'] = quick[p1node]
1756 1756 return quick
1757 1757
1758 1758 @unfilteredmethod
1759 1759 def _quick_access_changeid_invalidate(self):
1760 1760 if '_quick_access_changeid_wc' in vars(self):
1761 1761 del self.__dict__['_quick_access_changeid_wc']
1762 1762
1763 1763 @property
1764 1764 def _quick_access_changeid(self):
1765 1765 """an helper dictionnary for __getitem__ calls
1766 1766
1767 1767 This contains a list of symbol we can recognise right away without
1768 1768 further processing.
1769 1769 """
1770 1770 if self.filtername in repoview.filter_has_wc:
1771 1771 return self._quick_access_changeid_wc
1772 1772 return self._quick_access_changeid_null
1773 1773
1774 1774 def __getitem__(self, changeid):
1775 1775 # dealing with special cases
1776 1776 if changeid is None:
1777 1777 return context.workingctx(self)
1778 1778 if isinstance(changeid, context.basectx):
1779 1779 return changeid
1780 1780
1781 1781 # dealing with multiple revisions
1782 1782 if isinstance(changeid, slice):
1783 1783 # wdirrev isn't contiguous so the slice shouldn't include it
1784 1784 return [
1785 1785 self[i]
1786 1786 for i in pycompat.xrange(*changeid.indices(len(self)))
1787 1787 if i not in self.changelog.filteredrevs
1788 1788 ]
1789 1789
1790 1790 # dealing with some special values
1791 1791 quick_access = self._quick_access_changeid.get(changeid)
1792 1792 if quick_access is not None:
1793 1793 rev, node = quick_access
1794 1794 return context.changectx(self, rev, node, maybe_filtered=False)
1795 1795 if changeid == b'tip':
1796 1796 node = self.changelog.tip()
1797 1797 rev = self.changelog.rev(node)
1798 1798 return context.changectx(self, rev, node)
1799 1799
1800 1800 # dealing with arbitrary values
1801 1801 try:
1802 1802 if isinstance(changeid, int):
1803 1803 node = self.changelog.node(changeid)
1804 1804 rev = changeid
1805 1805 elif changeid == b'.':
1806 1806 # this is a hack to delay/avoid loading obsmarkers
1807 1807 # when we know that '.' won't be hidden
1808 1808 node = self.dirstate.p1()
1809 1809 rev = self.unfiltered().changelog.rev(node)
1810 1810 elif len(changeid) == 20:
1811 1811 try:
1812 1812 node = changeid
1813 1813 rev = self.changelog.rev(changeid)
1814 1814 except error.FilteredLookupError:
1815 1815 changeid = hex(changeid) # for the error message
1816 1816 raise
1817 1817 except LookupError:
1818 1818 # check if it might have come from damaged dirstate
1819 1819 #
1820 1820 # XXX we could avoid the unfiltered if we had a recognizable
1821 1821 # exception for filtered changeset access
1822 1822 if (
1823 1823 self.local()
1824 1824 and changeid in self.unfiltered().dirstate.parents()
1825 1825 ):
1826 1826 msg = _(b"working directory has unknown parent '%s'!")
1827 1827 raise error.Abort(msg % short(changeid))
1828 1828 changeid = hex(changeid) # for the error message
1829 1829 raise
1830 1830
1831 1831 elif len(changeid) == 40:
1832 1832 node = bin(changeid)
1833 1833 rev = self.changelog.rev(node)
1834 1834 else:
1835 1835 raise error.ProgrammingError(
1836 1836 b"unsupported changeid '%s' of type %s"
1837 1837 % (changeid, pycompat.bytestr(type(changeid)))
1838 1838 )
1839 1839
1840 1840 return context.changectx(self, rev, node)
1841 1841
1842 1842 except (error.FilteredIndexError, error.FilteredLookupError):
1843 1843 raise error.FilteredRepoLookupError(
1844 1844 _(b"filtered revision '%s'") % pycompat.bytestr(changeid)
1845 1845 )
1846 1846 except (IndexError, LookupError):
1847 1847 raise error.RepoLookupError(
1848 1848 _(b"unknown revision '%s'") % pycompat.bytestr(changeid)
1849 1849 )
1850 1850 except error.WdirUnsupported:
1851 1851 return context.workingctx(self)
1852 1852
1853 1853 def __contains__(self, changeid):
1854 1854 """True if the given changeid exists"""
1855 1855 try:
1856 1856 self[changeid]
1857 1857 return True
1858 1858 except error.RepoLookupError:
1859 1859 return False
1860 1860
1861 1861 def __nonzero__(self):
1862 1862 return True
1863 1863
1864 1864 __bool__ = __nonzero__
1865 1865
1866 1866 def __len__(self):
1867 1867 # no need to pay the cost of repoview.changelog
1868 1868 unfi = self.unfiltered()
1869 1869 return len(unfi.changelog)
1870 1870
1871 1871 def __iter__(self):
1872 1872 return iter(self.changelog)
1873 1873
1874 1874 def revs(self, expr, *args):
1875 1875 """Find revisions matching a revset.
1876 1876
1877 1877 The revset is specified as a string ``expr`` that may contain
1878 1878 %-formatting to escape certain types. See ``revsetlang.formatspec``.
1879 1879
1880 1880 Revset aliases from the configuration are not expanded. To expand
1881 1881 user aliases, consider calling ``scmutil.revrange()`` or
1882 1882 ``repo.anyrevs([expr], user=True)``.
1883 1883
1884 1884 Returns a smartset.abstractsmartset, which is a list-like interface
1885 1885 that contains integer revisions.
1886 1886 """
1887 1887 tree = revsetlang.spectree(expr, *args)
1888 1888 return revset.makematcher(tree)(self)
1889 1889
1890 1890 def set(self, expr, *args):
1891 1891 """Find revisions matching a revset and emit changectx instances.
1892 1892
1893 1893 This is a convenience wrapper around ``revs()`` that iterates the
1894 1894 result and is a generator of changectx instances.
1895 1895
1896 1896 Revset aliases from the configuration are not expanded. To expand
1897 1897 user aliases, consider calling ``scmutil.revrange()``.
1898 1898 """
1899 1899 for r in self.revs(expr, *args):
1900 1900 yield self[r]
1901 1901
1902 1902 def anyrevs(self, specs, user=False, localalias=None):
1903 1903 """Find revisions matching one of the given revsets.
1904 1904
1905 1905 Revset aliases from the configuration are not expanded by default. To
1906 1906 expand user aliases, specify ``user=True``. To provide some local
1907 1907 definitions overriding user aliases, set ``localalias`` to
1908 1908 ``{name: definitionstring}``.
1909 1909 """
1910 1910 if specs == [b'null']:
1911 1911 return revset.baseset([nullrev])
1912 1912 if specs == [b'.']:
1913 1913 quick_data = self._quick_access_changeid.get(b'.')
1914 1914 if quick_data is not None:
1915 1915 return revset.baseset([quick_data[0]])
1916 1916 if user:
1917 1917 m = revset.matchany(
1918 1918 self.ui,
1919 1919 specs,
1920 1920 lookup=revset.lookupfn(self),
1921 1921 localalias=localalias,
1922 1922 )
1923 1923 else:
1924 1924 m = revset.matchany(None, specs, localalias=localalias)
1925 1925 return m(self)
1926 1926
1927 1927 def url(self):
1928 1928 return b'file:' + self.root
1929 1929
1930 1930 def hook(self, name, throw=False, **args):
1931 1931 """Call a hook, passing this repo instance.
1932 1932
1933 1933 This a convenience method to aid invoking hooks. Extensions likely
1934 1934 won't call this unless they have registered a custom hook or are
1935 1935 replacing code that is expected to call a hook.
1936 1936 """
1937 1937 return hook.hook(self.ui, self, name, throw, **args)
1938 1938
1939 1939 @filteredpropertycache
1940 1940 def _tagscache(self):
1941 1941 """Returns a tagscache object that contains various tags related
1942 1942 caches."""
1943 1943
1944 1944 # This simplifies its cache management by having one decorated
1945 1945 # function (this one) and the rest simply fetch things from it.
1946 1946 class tagscache(object):
1947 1947 def __init__(self):
1948 1948 # These two define the set of tags for this repository. tags
1949 1949 # maps tag name to node; tagtypes maps tag name to 'global' or
1950 1950 # 'local'. (Global tags are defined by .hgtags across all
1951 1951 # heads, and local tags are defined in .hg/localtags.)
1952 1952 # They constitute the in-memory cache of tags.
1953 1953 self.tags = self.tagtypes = None
1954 1954
1955 1955 self.nodetagscache = self.tagslist = None
1956 1956
1957 1957 cache = tagscache()
1958 1958 cache.tags, cache.tagtypes = self._findtags()
1959 1959
1960 1960 return cache
1961 1961
1962 1962 def tags(self):
1963 1963 '''return a mapping of tag to node'''
1964 1964 t = {}
1965 1965 if self.changelog.filteredrevs:
1966 1966 tags, tt = self._findtags()
1967 1967 else:
1968 1968 tags = self._tagscache.tags
1969 1969 rev = self.changelog.rev
1970 1970 for k, v in pycompat.iteritems(tags):
1971 1971 try:
1972 1972 # ignore tags to unknown nodes
1973 1973 rev(v)
1974 1974 t[k] = v
1975 1975 except (error.LookupError, ValueError):
1976 1976 pass
1977 1977 return t
1978 1978
1979 1979 def _findtags(self):
1980 1980 """Do the hard work of finding tags. Return a pair of dicts
1981 1981 (tags, tagtypes) where tags maps tag name to node, and tagtypes
1982 1982 maps tag name to a string like \'global\' or \'local\'.
1983 1983 Subclasses or extensions are free to add their own tags, but
1984 1984 should be aware that the returned dicts will be retained for the
1985 1985 duration of the localrepo object."""
1986 1986
1987 1987 # XXX what tagtype should subclasses/extensions use? Currently
1988 1988 # mq and bookmarks add tags, but do not set the tagtype at all.
1989 1989 # Should each extension invent its own tag type? Should there
1990 1990 # be one tagtype for all such "virtual" tags? Or is the status
1991 1991 # quo fine?
1992 1992
1993 1993 # map tag name to (node, hist)
1994 1994 alltags = tagsmod.findglobaltags(self.ui, self)
1995 1995 # map tag name to tag type
1996 1996 tagtypes = {tag: b'global' for tag in alltags}
1997 1997
1998 1998 tagsmod.readlocaltags(self.ui, self, alltags, tagtypes)
1999 1999
2000 2000 # Build the return dicts. Have to re-encode tag names because
2001 2001 # the tags module always uses UTF-8 (in order not to lose info
2002 2002 # writing to the cache), but the rest of Mercurial wants them in
2003 2003 # local encoding.
2004 2004 tags = {}
2005 2005 for (name, (node, hist)) in pycompat.iteritems(alltags):
2006 2006 if node != nullid:
2007 2007 tags[encoding.tolocal(name)] = node
2008 2008 tags[b'tip'] = self.changelog.tip()
2009 2009 tagtypes = {
2010 2010 encoding.tolocal(name): value
2011 2011 for (name, value) in pycompat.iteritems(tagtypes)
2012 2012 }
2013 2013 return (tags, tagtypes)
2014 2014
2015 2015 def tagtype(self, tagname):
2016 2016 """
2017 2017 return the type of the given tag. result can be:
2018 2018
2019 2019 'local' : a local tag
2020 2020 'global' : a global tag
2021 2021 None : tag does not exist
2022 2022 """
2023 2023
2024 2024 return self._tagscache.tagtypes.get(tagname)
2025 2025
2026 2026 def tagslist(self):
2027 2027 '''return a list of tags ordered by revision'''
2028 2028 if not self._tagscache.tagslist:
2029 2029 l = []
2030 2030 for t, n in pycompat.iteritems(self.tags()):
2031 2031 l.append((self.changelog.rev(n), t, n))
2032 2032 self._tagscache.tagslist = [(t, n) for r, t, n in sorted(l)]
2033 2033
2034 2034 return self._tagscache.tagslist
2035 2035
2036 2036 def nodetags(self, node):
2037 2037 '''return the tags associated with a node'''
2038 2038 if not self._tagscache.nodetagscache:
2039 2039 nodetagscache = {}
2040 2040 for t, n in pycompat.iteritems(self._tagscache.tags):
2041 2041 nodetagscache.setdefault(n, []).append(t)
2042 2042 for tags in pycompat.itervalues(nodetagscache):
2043 2043 tags.sort()
2044 2044 self._tagscache.nodetagscache = nodetagscache
2045 2045 return self._tagscache.nodetagscache.get(node, [])
2046 2046
2047 2047 def nodebookmarks(self, node):
2048 2048 """return the list of bookmarks pointing to the specified node"""
2049 2049 return self._bookmarks.names(node)
2050 2050
2051 2051 def branchmap(self):
2052 2052 """returns a dictionary {branch: [branchheads]} with branchheads
2053 2053 ordered by increasing revision number"""
2054 2054 return self._branchcaches[self]
2055 2055
2056 2056 @unfilteredmethod
2057 2057 def revbranchcache(self):
2058 2058 if not self._revbranchcache:
2059 2059 self._revbranchcache = branchmap.revbranchcache(self.unfiltered())
2060 2060 return self._revbranchcache
2061 2061
2062 2062 def branchtip(self, branch, ignoremissing=False):
2063 2063 """return the tip node for a given branch
2064 2064
2065 2065 If ignoremissing is True, then this method will not raise an error.
2066 2066 This is helpful for callers that only expect None for a missing branch
2067 2067 (e.g. namespace).
2068 2068
2069 2069 """
2070 2070 try:
2071 2071 return self.branchmap().branchtip(branch)
2072 2072 except KeyError:
2073 2073 if not ignoremissing:
2074 2074 raise error.RepoLookupError(_(b"unknown branch '%s'") % branch)
2075 2075 else:
2076 2076 pass
2077 2077
2078 2078 def lookup(self, key):
2079 2079 node = scmutil.revsymbol(self, key).node()
2080 2080 if node is None:
2081 2081 raise error.RepoLookupError(_(b"unknown revision '%s'") % key)
2082 2082 return node
2083 2083
2084 2084 def lookupbranch(self, key):
2085 2085 if self.branchmap().hasbranch(key):
2086 2086 return key
2087 2087
2088 2088 return scmutil.revsymbol(self, key).branch()
2089 2089
2090 2090 def known(self, nodes):
2091 2091 cl = self.changelog
2092 2092 get_rev = cl.index.get_rev
2093 2093 filtered = cl.filteredrevs
2094 2094 result = []
2095 2095 for n in nodes:
2096 2096 r = get_rev(n)
2097 2097 resp = not (r is None or r in filtered)
2098 2098 result.append(resp)
2099 2099 return result
2100 2100
2101 2101 def local(self):
2102 2102 return self
2103 2103
2104 2104 def publishing(self):
2105 2105 # it's safe (and desirable) to trust the publish flag unconditionally
2106 2106 # so that we don't finalize changes shared between users via ssh or nfs
2107 2107 return self.ui.configbool(b'phases', b'publish', untrusted=True)
2108 2108
2109 2109 def cancopy(self):
2110 2110 # so statichttprepo's override of local() works
2111 2111 if not self.local():
2112 2112 return False
2113 2113 if not self.publishing():
2114 2114 return True
2115 2115 # if publishing we can't copy if there is filtered content
2116 2116 return not self.filtered(b'visible').changelog.filteredrevs
2117 2117
2118 2118 def shared(self):
2119 2119 '''the type of shared repository (None if not shared)'''
2120 2120 if self.sharedpath != self.path:
2121 2121 return b'store'
2122 2122 return None
2123 2123
2124 2124 def wjoin(self, f, *insidef):
2125 2125 return self.vfs.reljoin(self.root, f, *insidef)
2126 2126
2127 2127 def setparents(self, p1, p2=nullid):
2128 2128 self[None].setparents(p1, p2)
2129 2129 self._quick_access_changeid_invalidate()
2130 2130
2131 2131 def filectx(self, path, changeid=None, fileid=None, changectx=None):
2132 2132 """changeid must be a changeset revision, if specified.
2133 2133 fileid can be a file revision or node."""
2134 2134 return context.filectx(
2135 2135 self, path, changeid, fileid, changectx=changectx
2136 2136 )
2137 2137
2138 2138 def getcwd(self):
2139 2139 return self.dirstate.getcwd()
2140 2140
2141 2141 def pathto(self, f, cwd=None):
2142 2142 return self.dirstate.pathto(f, cwd)
2143 2143
2144 2144 def _loadfilter(self, filter):
2145 2145 if filter not in self._filterpats:
2146 2146 l = []
2147 2147 for pat, cmd in self.ui.configitems(filter):
2148 2148 if cmd == b'!':
2149 2149 continue
2150 2150 mf = matchmod.match(self.root, b'', [pat])
2151 2151 fn = None
2152 2152 params = cmd
2153 2153 for name, filterfn in pycompat.iteritems(self._datafilters):
2154 2154 if cmd.startswith(name):
2155 2155 fn = filterfn
2156 2156 params = cmd[len(name) :].lstrip()
2157 2157 break
2158 2158 if not fn:
2159 2159 fn = lambda s, c, **kwargs: procutil.filter(s, c)
2160 2160 fn.__name__ = 'commandfilter'
2161 2161 # Wrap old filters not supporting keyword arguments
2162 2162 if not pycompat.getargspec(fn)[2]:
2163 2163 oldfn = fn
2164 2164 fn = lambda s, c, oldfn=oldfn, **kwargs: oldfn(s, c)
2165 2165 fn.__name__ = 'compat-' + oldfn.__name__
2166 2166 l.append((mf, fn, params))
2167 2167 self._filterpats[filter] = l
2168 2168 return self._filterpats[filter]
2169 2169
2170 2170 def _filter(self, filterpats, filename, data):
2171 2171 for mf, fn, cmd in filterpats:
2172 2172 if mf(filename):
2173 2173 self.ui.debug(
2174 2174 b"filtering %s through %s\n"
2175 2175 % (filename, cmd or pycompat.sysbytes(fn.__name__))
2176 2176 )
2177 2177 data = fn(data, cmd, ui=self.ui, repo=self, filename=filename)
2178 2178 break
2179 2179
2180 2180 return data
2181 2181
2182 2182 @unfilteredpropertycache
2183 2183 def _encodefilterpats(self):
2184 2184 return self._loadfilter(b'encode')
2185 2185
2186 2186 @unfilteredpropertycache
2187 2187 def _decodefilterpats(self):
2188 2188 return self._loadfilter(b'decode')
2189 2189
2190 2190 def adddatafilter(self, name, filter):
2191 2191 self._datafilters[name] = filter
2192 2192
2193 2193 def wread(self, filename):
2194 2194 if self.wvfs.islink(filename):
2195 2195 data = self.wvfs.readlink(filename)
2196 2196 else:
2197 2197 data = self.wvfs.read(filename)
2198 2198 return self._filter(self._encodefilterpats, filename, data)
2199 2199
2200 2200 def wwrite(self, filename, data, flags, backgroundclose=False, **kwargs):
2201 2201 """write ``data`` into ``filename`` in the working directory
2202 2202
2203 2203 This returns length of written (maybe decoded) data.
2204 2204 """
2205 2205 data = self._filter(self._decodefilterpats, filename, data)
2206 2206 if b'l' in flags:
2207 2207 self.wvfs.symlink(data, filename)
2208 2208 else:
2209 2209 self.wvfs.write(
2210 2210 filename, data, backgroundclose=backgroundclose, **kwargs
2211 2211 )
2212 2212 if b'x' in flags:
2213 2213 self.wvfs.setflags(filename, False, True)
2214 2214 else:
2215 2215 self.wvfs.setflags(filename, False, False)
2216 2216 return len(data)
2217 2217
2218 2218 def wwritedata(self, filename, data):
2219 2219 return self._filter(self._decodefilterpats, filename, data)
2220 2220
2221 2221 def currenttransaction(self):
2222 2222 """return the current transaction or None if non exists"""
2223 2223 if self._transref:
2224 2224 tr = self._transref()
2225 2225 else:
2226 2226 tr = None
2227 2227
2228 2228 if tr and tr.running():
2229 2229 return tr
2230 2230 return None
2231 2231
2232 2232 def transaction(self, desc, report=None):
2233 2233 if self.ui.configbool(b'devel', b'all-warnings') or self.ui.configbool(
2234 2234 b'devel', b'check-locks'
2235 2235 ):
2236 2236 if self._currentlock(self._lockref) is None:
2237 2237 raise error.ProgrammingError(b'transaction requires locking')
2238 2238 tr = self.currenttransaction()
2239 2239 if tr is not None:
2240 2240 return tr.nest(name=desc)
2241 2241
2242 2242 # abort here if the journal already exists
2243 2243 if self.svfs.exists(b"journal"):
2244 2244 raise error.RepoError(
2245 2245 _(b"abandoned transaction found"),
2246 2246 hint=_(b"run 'hg recover' to clean up transaction"),
2247 2247 )
2248 2248
2249 2249 idbase = b"%.40f#%f" % (random.random(), time.time())
2250 2250 ha = hex(hashutil.sha1(idbase).digest())
2251 2251 txnid = b'TXN:' + ha
2252 2252 self.hook(b'pretxnopen', throw=True, txnname=desc, txnid=txnid)
2253 2253
2254 2254 self._writejournal(desc)
2255 2255 renames = [(vfs, x, undoname(x)) for vfs, x in self._journalfiles()]
2256 2256 if report:
2257 2257 rp = report
2258 2258 else:
2259 2259 rp = self.ui.warn
2260 2260 vfsmap = {b'plain': self.vfs, b'store': self.svfs} # root of .hg/
2261 2261 # we must avoid cyclic reference between repo and transaction.
2262 2262 reporef = weakref.ref(self)
2263 2263 # Code to track tag movement
2264 2264 #
2265 2265 # Since tags are all handled as file content, it is actually quite hard
2266 2266 # to track these movement from a code perspective. So we fallback to a
2267 2267 # tracking at the repository level. One could envision to track changes
2268 2268 # to the '.hgtags' file through changegroup apply but that fails to
2269 2269 # cope with case where transaction expose new heads without changegroup
2270 2270 # being involved (eg: phase movement).
2271 2271 #
2272 2272 # For now, We gate the feature behind a flag since this likely comes
2273 2273 # with performance impacts. The current code run more often than needed
2274 2274 # and do not use caches as much as it could. The current focus is on
2275 2275 # the behavior of the feature so we disable it by default. The flag
2276 2276 # will be removed when we are happy with the performance impact.
2277 2277 #
2278 2278 # Once this feature is no longer experimental move the following
2279 2279 # documentation to the appropriate help section:
2280 2280 #
2281 2281 # The ``HG_TAG_MOVED`` variable will be set if the transaction touched
2282 2282 # tags (new or changed or deleted tags). In addition the details of
2283 2283 # these changes are made available in a file at:
2284 2284 # ``REPOROOT/.hg/changes/tags.changes``.
2285 2285 # Make sure you check for HG_TAG_MOVED before reading that file as it
2286 2286 # might exist from a previous transaction even if no tag were touched
2287 2287 # in this one. Changes are recorded in a line base format::
2288 2288 #
2289 2289 # <action> <hex-node> <tag-name>\n
2290 2290 #
2291 2291 # Actions are defined as follow:
2292 2292 # "-R": tag is removed,
2293 2293 # "+A": tag is added,
2294 2294 # "-M": tag is moved (old value),
2295 2295 # "+M": tag is moved (new value),
2296 2296 tracktags = lambda x: None
2297 2297 # experimental config: experimental.hook-track-tags
2298 2298 shouldtracktags = self.ui.configbool(
2299 2299 b'experimental', b'hook-track-tags'
2300 2300 )
2301 2301 if desc != b'strip' and shouldtracktags:
2302 2302 oldheads = self.changelog.headrevs()
2303 2303
2304 2304 def tracktags(tr2):
2305 2305 repo = reporef()
2306 2306 assert repo is not None # help pytype
2307 2307 oldfnodes = tagsmod.fnoderevs(repo.ui, repo, oldheads)
2308 2308 newheads = repo.changelog.headrevs()
2309 2309 newfnodes = tagsmod.fnoderevs(repo.ui, repo, newheads)
2310 2310 # notes: we compare lists here.
2311 2311 # As we do it only once buiding set would not be cheaper
2312 2312 changes = tagsmod.difftags(repo.ui, repo, oldfnodes, newfnodes)
2313 2313 if changes:
2314 2314 tr2.hookargs[b'tag_moved'] = b'1'
2315 2315 with repo.vfs(
2316 2316 b'changes/tags.changes', b'w', atomictemp=True
2317 2317 ) as changesfile:
2318 2318 # note: we do not register the file to the transaction
2319 2319 # because we needs it to still exist on the transaction
2320 2320 # is close (for txnclose hooks)
2321 2321 tagsmod.writediff(changesfile, changes)
2322 2322
2323 2323 def validate(tr2):
2324 2324 """will run pre-closing hooks"""
2325 2325 # XXX the transaction API is a bit lacking here so we take a hacky
2326 2326 # path for now
2327 2327 #
2328 2328 # We cannot add this as a "pending" hooks since the 'tr.hookargs'
2329 2329 # dict is copied before these run. In addition we needs the data
2330 2330 # available to in memory hooks too.
2331 2331 #
2332 2332 # Moreover, we also need to make sure this runs before txnclose
2333 2333 # hooks and there is no "pending" mechanism that would execute
2334 2334 # logic only if hooks are about to run.
2335 2335 #
2336 2336 # Fixing this limitation of the transaction is also needed to track
2337 2337 # other families of changes (bookmarks, phases, obsolescence).
2338 2338 #
2339 2339 # This will have to be fixed before we remove the experimental
2340 2340 # gating.
2341 2341 tracktags(tr2)
2342 2342 repo = reporef()
2343 2343 assert repo is not None # help pytype
2344 2344
2345 2345 singleheadopt = (b'experimental', b'single-head-per-branch')
2346 2346 singlehead = repo.ui.configbool(*singleheadopt)
2347 2347 if singlehead:
2348 2348 singleheadsub = repo.ui.configsuboptions(*singleheadopt)[1]
2349 2349 accountclosed = singleheadsub.get(
2350 2350 b"account-closed-heads", False
2351 2351 )
2352 2352 if singleheadsub.get(b"public-changes-only", False):
2353 2353 filtername = b"immutable"
2354 2354 else:
2355 2355 filtername = b"visible"
2356 2356 scmutil.enforcesinglehead(
2357 2357 repo, tr2, desc, accountclosed, filtername
2358 2358 )
2359 2359 if hook.hashook(repo.ui, b'pretxnclose-bookmark'):
2360 2360 for name, (old, new) in sorted(
2361 2361 tr.changes[b'bookmarks'].items()
2362 2362 ):
2363 2363 args = tr.hookargs.copy()
2364 2364 args.update(bookmarks.preparehookargs(name, old, new))
2365 2365 repo.hook(
2366 2366 b'pretxnclose-bookmark',
2367 2367 throw=True,
2368 2368 **pycompat.strkwargs(args)
2369 2369 )
2370 2370 if hook.hashook(repo.ui, b'pretxnclose-phase'):
2371 2371 cl = repo.unfiltered().changelog
2372 2372 for revs, (old, new) in tr.changes[b'phases']:
2373 2373 for rev in revs:
2374 2374 args = tr.hookargs.copy()
2375 2375 node = hex(cl.node(rev))
2376 2376 args.update(phases.preparehookargs(node, old, new))
2377 2377 repo.hook(
2378 2378 b'pretxnclose-phase',
2379 2379 throw=True,
2380 2380 **pycompat.strkwargs(args)
2381 2381 )
2382 2382
2383 2383 repo.hook(
2384 2384 b'pretxnclose', throw=True, **pycompat.strkwargs(tr.hookargs)
2385 2385 )
2386 2386
2387 2387 def releasefn(tr, success):
2388 2388 repo = reporef()
2389 2389 if repo is None:
2390 2390 # If the repo has been GC'd (and this release function is being
2391 2391 # called from transaction.__del__), there's not much we can do,
2392 2392 # so just leave the unfinished transaction there and let the
2393 2393 # user run `hg recover`.
2394 2394 return
2395 2395 if success:
2396 2396 # this should be explicitly invoked here, because
2397 2397 # in-memory changes aren't written out at closing
2398 2398 # transaction, if tr.addfilegenerator (via
2399 2399 # dirstate.write or so) isn't invoked while
2400 2400 # transaction running
2401 2401 repo.dirstate.write(None)
2402 2402 else:
2403 2403 # discard all changes (including ones already written
2404 2404 # out) in this transaction
2405 2405 narrowspec.restorebackup(self, b'journal.narrowspec')
2406 2406 narrowspec.restorewcbackup(self, b'journal.narrowspec.dirstate')
2407 2407 repo.dirstate.restorebackup(None, b'journal.dirstate')
2408 2408
2409 2409 repo.invalidate(clearfilecache=True)
2410 2410
2411 2411 tr = transaction.transaction(
2412 2412 rp,
2413 2413 self.svfs,
2414 2414 vfsmap,
2415 2415 b"journal",
2416 2416 b"undo",
2417 2417 aftertrans(renames),
2418 2418 self.store.createmode,
2419 2419 validator=validate,
2420 2420 releasefn=releasefn,
2421 2421 checkambigfiles=_cachedfiles,
2422 2422 name=desc,
2423 2423 )
2424 2424 tr.changes[b'origrepolen'] = len(self)
2425 2425 tr.changes[b'obsmarkers'] = set()
2426 2426 tr.changes[b'phases'] = []
2427 2427 tr.changes[b'bookmarks'] = {}
2428 2428
2429 2429 tr.hookargs[b'txnid'] = txnid
2430 2430 tr.hookargs[b'txnname'] = desc
2431 2431 tr.hookargs[b'changes'] = tr.changes
2432 2432 # note: writing the fncache only during finalize mean that the file is
2433 2433 # outdated when running hooks. As fncache is used for streaming clone,
2434 2434 # this is not expected to break anything that happen during the hooks.
2435 2435 tr.addfinalize(b'flush-fncache', self.store.write)
2436 2436
2437 2437 def txnclosehook(tr2):
2438 2438 """To be run if transaction is successful, will schedule a hook run"""
2439 2439 # Don't reference tr2 in hook() so we don't hold a reference.
2440 2440 # This reduces memory consumption when there are multiple
2441 2441 # transactions per lock. This can likely go away if issue5045
2442 2442 # fixes the function accumulation.
2443 2443 hookargs = tr2.hookargs
2444 2444
2445 2445 def hookfunc(unused_success):
2446 2446 repo = reporef()
2447 2447 assert repo is not None # help pytype
2448 2448
2449 2449 if hook.hashook(repo.ui, b'txnclose-bookmark'):
2450 2450 bmchanges = sorted(tr.changes[b'bookmarks'].items())
2451 2451 for name, (old, new) in bmchanges:
2452 2452 args = tr.hookargs.copy()
2453 2453 args.update(bookmarks.preparehookargs(name, old, new))
2454 2454 repo.hook(
2455 2455 b'txnclose-bookmark',
2456 2456 throw=False,
2457 2457 **pycompat.strkwargs(args)
2458 2458 )
2459 2459
2460 2460 if hook.hashook(repo.ui, b'txnclose-phase'):
2461 2461 cl = repo.unfiltered().changelog
2462 2462 phasemv = sorted(
2463 2463 tr.changes[b'phases'], key=lambda r: r[0][0]
2464 2464 )
2465 2465 for revs, (old, new) in phasemv:
2466 2466 for rev in revs:
2467 2467 args = tr.hookargs.copy()
2468 2468 node = hex(cl.node(rev))
2469 2469 args.update(phases.preparehookargs(node, old, new))
2470 2470 repo.hook(
2471 2471 b'txnclose-phase',
2472 2472 throw=False,
2473 2473 **pycompat.strkwargs(args)
2474 2474 )
2475 2475
2476 2476 repo.hook(
2477 2477 b'txnclose', throw=False, **pycompat.strkwargs(hookargs)
2478 2478 )
2479 2479
2480 2480 repo = reporef()
2481 2481 assert repo is not None # help pytype
2482 2482 repo._afterlock(hookfunc)
2483 2483
2484 2484 tr.addfinalize(b'txnclose-hook', txnclosehook)
2485 2485 # Include a leading "-" to make it happen before the transaction summary
2486 2486 # reports registered via scmutil.registersummarycallback() whose names
2487 2487 # are 00-txnreport etc. That way, the caches will be warm when the
2488 2488 # callbacks run.
2489 2489 tr.addpostclose(b'-warm-cache', self._buildcacheupdater(tr))
2490 2490
2491 2491 def txnaborthook(tr2):
2492 2492 """To be run if transaction is aborted"""
2493 2493 repo = reporef()
2494 2494 assert repo is not None # help pytype
2495 2495 repo.hook(
2496 2496 b'txnabort', throw=False, **pycompat.strkwargs(tr2.hookargs)
2497 2497 )
2498 2498
2499 2499 tr.addabort(b'txnabort-hook', txnaborthook)
2500 2500 # avoid eager cache invalidation. in-memory data should be identical
2501 2501 # to stored data if transaction has no error.
2502 2502 tr.addpostclose(b'refresh-filecachestats', self._refreshfilecachestats)
2503 2503 self._transref = weakref.ref(tr)
2504 2504 scmutil.registersummarycallback(self, tr, desc)
2505 2505 return tr
2506 2506
2507 2507 def _journalfiles(self):
2508 2508 return (
2509 2509 (self.svfs, b'journal'),
2510 2510 (self.svfs, b'journal.narrowspec'),
2511 2511 (self.vfs, b'journal.narrowspec.dirstate'),
2512 2512 (self.vfs, b'journal.dirstate'),
2513 2513 (self.vfs, b'journal.branch'),
2514 2514 (self.vfs, b'journal.desc'),
2515 2515 (bookmarks.bookmarksvfs(self), b'journal.bookmarks'),
2516 2516 (self.svfs, b'journal.phaseroots'),
2517 2517 )
2518 2518
2519 2519 def undofiles(self):
2520 2520 return [(vfs, undoname(x)) for vfs, x in self._journalfiles()]
2521 2521
2522 2522 @unfilteredmethod
2523 2523 def _writejournal(self, desc):
2524 2524 self.dirstate.savebackup(None, b'journal.dirstate')
2525 2525 narrowspec.savewcbackup(self, b'journal.narrowspec.dirstate')
2526 2526 narrowspec.savebackup(self, b'journal.narrowspec')
2527 2527 self.vfs.write(
2528 2528 b"journal.branch", encoding.fromlocal(self.dirstate.branch())
2529 2529 )
2530 2530 self.vfs.write(b"journal.desc", b"%d\n%s\n" % (len(self), desc))
2531 2531 bookmarksvfs = bookmarks.bookmarksvfs(self)
2532 2532 bookmarksvfs.write(
2533 2533 b"journal.bookmarks", bookmarksvfs.tryread(b"bookmarks")
2534 2534 )
2535 2535 self.svfs.write(b"journal.phaseroots", self.svfs.tryread(b"phaseroots"))
2536 2536
2537 2537 def recover(self):
2538 2538 with self.lock():
2539 2539 if self.svfs.exists(b"journal"):
2540 2540 self.ui.status(_(b"rolling back interrupted transaction\n"))
2541 2541 vfsmap = {
2542 2542 b'': self.svfs,
2543 2543 b'plain': self.vfs,
2544 2544 }
2545 2545 transaction.rollback(
2546 2546 self.svfs,
2547 2547 vfsmap,
2548 2548 b"journal",
2549 2549 self.ui.warn,
2550 2550 checkambigfiles=_cachedfiles,
2551 2551 )
2552 2552 self.invalidate()
2553 2553 return True
2554 2554 else:
2555 2555 self.ui.warn(_(b"no interrupted transaction available\n"))
2556 2556 return False
2557 2557
2558 2558 def rollback(self, dryrun=False, force=False):
2559 2559 wlock = lock = dsguard = None
2560 2560 try:
2561 2561 wlock = self.wlock()
2562 2562 lock = self.lock()
2563 2563 if self.svfs.exists(b"undo"):
2564 2564 dsguard = dirstateguard.dirstateguard(self, b'rollback')
2565 2565
2566 2566 return self._rollback(dryrun, force, dsguard)
2567 2567 else:
2568 2568 self.ui.warn(_(b"no rollback information available\n"))
2569 2569 return 1
2570 2570 finally:
2571 2571 release(dsguard, lock, wlock)
2572 2572
2573 2573 @unfilteredmethod # Until we get smarter cache management
2574 2574 def _rollback(self, dryrun, force, dsguard):
2575 2575 ui = self.ui
2576 2576 try:
2577 2577 args = self.vfs.read(b'undo.desc').splitlines()
2578 2578 (oldlen, desc, detail) = (int(args[0]), args[1], None)
2579 2579 if len(args) >= 3:
2580 2580 detail = args[2]
2581 2581 oldtip = oldlen - 1
2582 2582
2583 2583 if detail and ui.verbose:
2584 2584 msg = _(
2585 2585 b'repository tip rolled back to revision %d'
2586 2586 b' (undo %s: %s)\n'
2587 2587 ) % (oldtip, desc, detail)
2588 2588 else:
2589 2589 msg = _(
2590 2590 b'repository tip rolled back to revision %d (undo %s)\n'
2591 2591 ) % (oldtip, desc)
2592 2592 except IOError:
2593 2593 msg = _(b'rolling back unknown transaction\n')
2594 2594 desc = None
2595 2595
2596 2596 if not force and self[b'.'] != self[b'tip'] and desc == b'commit':
2597 2597 raise error.Abort(
2598 2598 _(
2599 2599 b'rollback of last commit while not checked out '
2600 2600 b'may lose data'
2601 2601 ),
2602 2602 hint=_(b'use -f to force'),
2603 2603 )
2604 2604
2605 2605 ui.status(msg)
2606 2606 if dryrun:
2607 2607 return 0
2608 2608
2609 2609 parents = self.dirstate.parents()
2610 2610 self.destroying()
2611 2611 vfsmap = {b'plain': self.vfs, b'': self.svfs}
2612 2612 transaction.rollback(
2613 2613 self.svfs, vfsmap, b'undo', ui.warn, checkambigfiles=_cachedfiles
2614 2614 )
2615 2615 bookmarksvfs = bookmarks.bookmarksvfs(self)
2616 2616 if bookmarksvfs.exists(b'undo.bookmarks'):
2617 2617 bookmarksvfs.rename(
2618 2618 b'undo.bookmarks', b'bookmarks', checkambig=True
2619 2619 )
2620 2620 if self.svfs.exists(b'undo.phaseroots'):
2621 2621 self.svfs.rename(b'undo.phaseroots', b'phaseroots', checkambig=True)
2622 2622 self.invalidate()
2623 2623
2624 2624 has_node = self.changelog.index.has_node
2625 2625 parentgone = any(not has_node(p) for p in parents)
2626 2626 if parentgone:
2627 2627 # prevent dirstateguard from overwriting already restored one
2628 2628 dsguard.close()
2629 2629
2630 2630 narrowspec.restorebackup(self, b'undo.narrowspec')
2631 2631 narrowspec.restorewcbackup(self, b'undo.narrowspec.dirstate')
2632 2632 self.dirstate.restorebackup(None, b'undo.dirstate')
2633 2633 try:
2634 2634 branch = self.vfs.read(b'undo.branch')
2635 2635 self.dirstate.setbranch(encoding.tolocal(branch))
2636 2636 except IOError:
2637 2637 ui.warn(
2638 2638 _(
2639 2639 b'named branch could not be reset: '
2640 2640 b'current branch is still \'%s\'\n'
2641 2641 )
2642 2642 % self.dirstate.branch()
2643 2643 )
2644 2644
2645 2645 parents = tuple([p.rev() for p in self[None].parents()])
2646 2646 if len(parents) > 1:
2647 2647 ui.status(
2648 2648 _(
2649 2649 b'working directory now based on '
2650 2650 b'revisions %d and %d\n'
2651 2651 )
2652 2652 % parents
2653 2653 )
2654 2654 else:
2655 2655 ui.status(
2656 2656 _(b'working directory now based on revision %d\n') % parents
2657 2657 )
2658 2658 mergestatemod.mergestate.clean(self)
2659 2659
2660 2660 # TODO: if we know which new heads may result from this rollback, pass
2661 2661 # them to destroy(), which will prevent the branchhead cache from being
2662 2662 # invalidated.
2663 2663 self.destroyed()
2664 2664 return 0
2665 2665
2666 2666 def _buildcacheupdater(self, newtransaction):
2667 2667 """called during transaction to build the callback updating cache
2668 2668
2669 2669 Lives on the repository to help extension who might want to augment
2670 2670 this logic. For this purpose, the created transaction is passed to the
2671 2671 method.
2672 2672 """
2673 2673 # we must avoid cyclic reference between repo and transaction.
2674 2674 reporef = weakref.ref(self)
2675 2675
2676 2676 def updater(tr):
2677 2677 repo = reporef()
2678 2678 assert repo is not None # help pytype
2679 2679 repo.updatecaches(tr)
2680 2680
2681 2681 return updater
2682 2682
2683 2683 @unfilteredmethod
2684 2684 def updatecaches(self, tr=None, full=False):
2685 2685 """warm appropriate caches
2686 2686
2687 2687 If this function is called after a transaction closed. The transaction
2688 2688 will be available in the 'tr' argument. This can be used to selectively
2689 2689 update caches relevant to the changes in that transaction.
2690 2690
2691 2691 If 'full' is set, make sure all caches the function knows about have
2692 2692 up-to-date data. Even the ones usually loaded more lazily.
2693 2693 """
2694 2694 if tr is not None and tr.hookargs.get(b'source') == b'strip':
2695 2695 # During strip, many caches are invalid but
2696 2696 # later call to `destroyed` will refresh them.
2697 2697 return
2698 2698
2699 2699 if tr is None or tr.changes[b'origrepolen'] < len(self):
2700 2700 # accessing the 'served' branchmap should refresh all the others,
2701 2701 self.ui.debug(b'updating the branch cache\n')
2702 2702 self.filtered(b'served').branchmap()
2703 2703 self.filtered(b'served.hidden').branchmap()
2704 2704
2705 2705 if full:
2706 2706 unfi = self.unfiltered()
2707 2707
2708 2708 self.changelog.update_caches(transaction=tr)
2709 2709 self.manifestlog.update_caches(transaction=tr)
2710 2710
2711 2711 rbc = unfi.revbranchcache()
2712 2712 for r in unfi.changelog:
2713 2713 rbc.branchinfo(r)
2714 2714 rbc.write()
2715 2715
2716 2716 # ensure the working copy parents are in the manifestfulltextcache
2717 2717 for ctx in self[b'.'].parents():
2718 2718 ctx.manifest() # accessing the manifest is enough
2719 2719
2720 2720 # accessing fnode cache warms the cache
2721 2721 tagsmod.fnoderevs(self.ui, unfi, unfi.changelog.revs())
2722 2722 # accessing tags warm the cache
2723 2723 self.tags()
2724 2724 self.filtered(b'served').tags()
2725 2725
2726 2726 # The `full` arg is documented as updating even the lazily-loaded
2727 2727 # caches immediately, so we're forcing a write to cause these caches
2728 2728 # to be warmed up even if they haven't explicitly been requested
2729 2729 # yet (if they've never been used by hg, they won't ever have been
2730 2730 # written, even if they're a subset of another kind of cache that
2731 2731 # *has* been used).
2732 2732 for filt in repoview.filtertable.keys():
2733 2733 filtered = self.filtered(filt)
2734 2734 filtered.branchmap().write(filtered)
2735 2735
2736 2736 def invalidatecaches(self):
2737 2737
2738 2738 if '_tagscache' in vars(self):
2739 2739 # can't use delattr on proxy
2740 2740 del self.__dict__['_tagscache']
2741 2741
2742 2742 self._branchcaches.clear()
2743 2743 self.invalidatevolatilesets()
2744 2744 self._sparsesignaturecache.clear()
2745 2745
2746 2746 def invalidatevolatilesets(self):
2747 2747 self.filteredrevcache.clear()
2748 2748 obsolete.clearobscaches(self)
2749 2749 self._quick_access_changeid_invalidate()
2750 2750
2751 2751 def invalidatedirstate(self):
2752 2752 """Invalidates the dirstate, causing the next call to dirstate
2753 2753 to check if it was modified since the last time it was read,
2754 2754 rereading it if it has.
2755 2755
2756 2756 This is different to dirstate.invalidate() that it doesn't always
2757 2757 rereads the dirstate. Use dirstate.invalidate() if you want to
2758 2758 explicitly read the dirstate again (i.e. restoring it to a previous
2759 2759 known good state)."""
2760 2760 if hasunfilteredcache(self, 'dirstate'):
2761 2761 for k in self.dirstate._filecache:
2762 2762 try:
2763 2763 delattr(self.dirstate, k)
2764 2764 except AttributeError:
2765 2765 pass
2766 2766 delattr(self.unfiltered(), 'dirstate')
2767 2767
2768 2768 def invalidate(self, clearfilecache=False):
2769 2769 """Invalidates both store and non-store parts other than dirstate
2770 2770
2771 2771 If a transaction is running, invalidation of store is omitted,
2772 2772 because discarding in-memory changes might cause inconsistency
2773 2773 (e.g. incomplete fncache causes unintentional failure, but
2774 2774 redundant one doesn't).
2775 2775 """
2776 2776 unfiltered = self.unfiltered() # all file caches are stored unfiltered
2777 2777 for k in list(self._filecache.keys()):
2778 2778 # dirstate is invalidated separately in invalidatedirstate()
2779 2779 if k == b'dirstate':
2780 2780 continue
2781 2781 if (
2782 2782 k == b'changelog'
2783 2783 and self.currenttransaction()
2784 2784 and self.changelog._delayed
2785 2785 ):
2786 2786 # The changelog object may store unwritten revisions. We don't
2787 2787 # want to lose them.
2788 2788 # TODO: Solve the problem instead of working around it.
2789 2789 continue
2790 2790
2791 2791 if clearfilecache:
2792 2792 del self._filecache[k]
2793 2793 try:
2794 2794 delattr(unfiltered, k)
2795 2795 except AttributeError:
2796 2796 pass
2797 2797 self.invalidatecaches()
2798 2798 if not self.currenttransaction():
2799 2799 # TODO: Changing contents of store outside transaction
2800 2800 # causes inconsistency. We should make in-memory store
2801 2801 # changes detectable, and abort if changed.
2802 2802 self.store.invalidatecaches()
2803 2803
2804 2804 def invalidateall(self):
2805 2805 """Fully invalidates both store and non-store parts, causing the
2806 2806 subsequent operation to reread any outside changes."""
2807 2807 # extension should hook this to invalidate its caches
2808 2808 self.invalidate()
2809 2809 self.invalidatedirstate()
2810 2810
2811 2811 @unfilteredmethod
2812 2812 def _refreshfilecachestats(self, tr):
2813 2813 """Reload stats of cached files so that they are flagged as valid"""
2814 2814 for k, ce in self._filecache.items():
2815 2815 k = pycompat.sysstr(k)
2816 2816 if k == 'dirstate' or k not in self.__dict__:
2817 2817 continue
2818 2818 ce.refresh()
2819 2819
2820 2820 def _lock(
2821 2821 self,
2822 2822 vfs,
2823 2823 lockname,
2824 2824 wait,
2825 2825 releasefn,
2826 2826 acquirefn,
2827 2827 desc,
2828 2828 ):
2829 2829 timeout = 0
2830 2830 warntimeout = 0
2831 2831 if wait:
2832 2832 timeout = self.ui.configint(b"ui", b"timeout")
2833 2833 warntimeout = self.ui.configint(b"ui", b"timeout.warn")
2834 2834 # internal config: ui.signal-safe-lock
2835 2835 signalsafe = self.ui.configbool(b'ui', b'signal-safe-lock')
2836 2836
2837 2837 l = lockmod.trylock(
2838 2838 self.ui,
2839 2839 vfs,
2840 2840 lockname,
2841 2841 timeout,
2842 2842 warntimeout,
2843 2843 releasefn=releasefn,
2844 2844 acquirefn=acquirefn,
2845 2845 desc=desc,
2846 2846 signalsafe=signalsafe,
2847 2847 )
2848 2848 return l
2849 2849
2850 2850 def _afterlock(self, callback):
2851 2851 """add a callback to be run when the repository is fully unlocked
2852 2852
2853 2853 The callback will be executed when the outermost lock is released
2854 2854 (with wlock being higher level than 'lock')."""
2855 2855 for ref in (self._wlockref, self._lockref):
2856 2856 l = ref and ref()
2857 2857 if l and l.held:
2858 2858 l.postrelease.append(callback)
2859 2859 break
2860 2860 else: # no lock have been found.
2861 2861 callback(True)
2862 2862
2863 2863 def lock(self, wait=True):
2864 2864 """Lock the repository store (.hg/store) and return a weak reference
2865 2865 to the lock. Use this before modifying the store (e.g. committing or
2866 2866 stripping). If you are opening a transaction, get a lock as well.)
2867 2867
2868 2868 If both 'lock' and 'wlock' must be acquired, ensure you always acquires
2869 2869 'wlock' first to avoid a dead-lock hazard."""
2870 2870 l = self._currentlock(self._lockref)
2871 2871 if l is not None:
2872 2872 l.lock()
2873 2873 return l
2874 2874
2875 2875 l = self._lock(
2876 2876 vfs=self.svfs,
2877 2877 lockname=b"lock",
2878 2878 wait=wait,
2879 2879 releasefn=None,
2880 2880 acquirefn=self.invalidate,
2881 2881 desc=_(b'repository %s') % self.origroot,
2882 2882 )
2883 2883 self._lockref = weakref.ref(l)
2884 2884 return l
2885 2885
2886 2886 def wlock(self, wait=True):
2887 2887 """Lock the non-store parts of the repository (everything under
2888 2888 .hg except .hg/store) and return a weak reference to the lock.
2889 2889
2890 2890 Use this before modifying files in .hg.
2891 2891
2892 2892 If both 'lock' and 'wlock' must be acquired, ensure you always acquires
2893 2893 'wlock' first to avoid a dead-lock hazard."""
2894 l = self._wlockref and self._wlockref()
2894 l = self._wlockref() if self._wlockref else None
2895 2895 if l is not None and l.held:
2896 2896 l.lock()
2897 2897 return l
2898 2898
2899 2899 # We do not need to check for non-waiting lock acquisition. Such
2900 2900 # acquisition would not cause dead-lock as they would just fail.
2901 2901 if wait and (
2902 2902 self.ui.configbool(b'devel', b'all-warnings')
2903 2903 or self.ui.configbool(b'devel', b'check-locks')
2904 2904 ):
2905 2905 if self._currentlock(self._lockref) is not None:
2906 2906 self.ui.develwarn(b'"wlock" acquired after "lock"')
2907 2907
2908 2908 def unlock():
2909 2909 if self.dirstate.pendingparentchange():
2910 2910 self.dirstate.invalidate()
2911 2911 else:
2912 2912 self.dirstate.write(None)
2913 2913
2914 2914 self._filecache[b'dirstate'].refresh()
2915 2915
2916 2916 l = self._lock(
2917 2917 self.vfs,
2918 2918 b"wlock",
2919 2919 wait,
2920 2920 unlock,
2921 2921 self.invalidatedirstate,
2922 2922 _(b'working directory of %s') % self.origroot,
2923 2923 )
2924 2924 self._wlockref = weakref.ref(l)
2925 2925 return l
2926 2926
2927 2927 def _currentlock(self, lockref):
2928 2928 """Returns the lock if it's held, or None if it's not."""
2929 2929 if lockref is None:
2930 2930 return None
2931 2931 l = lockref()
2932 2932 if l is None or not l.held:
2933 2933 return None
2934 2934 return l
2935 2935
2936 2936 def currentwlock(self):
2937 2937 """Returns the wlock if it's held, or None if it's not."""
2938 2938 return self._currentlock(self._wlockref)
2939 2939
2940 2940 def checkcommitpatterns(self, wctx, match, status, fail):
2941 2941 """check for commit arguments that aren't committable"""
2942 2942 if match.isexact() or match.prefix():
2943 2943 matched = set(status.modified + status.added + status.removed)
2944 2944
2945 2945 for f in match.files():
2946 2946 f = self.dirstate.normalize(f)
2947 2947 if f == b'.' or f in matched or f in wctx.substate:
2948 2948 continue
2949 2949 if f in status.deleted:
2950 2950 fail(f, _(b'file not found!'))
2951 2951 # Is it a directory that exists or used to exist?
2952 2952 if self.wvfs.isdir(f) or wctx.p1().hasdir(f):
2953 2953 d = f + b'/'
2954 2954 for mf in matched:
2955 2955 if mf.startswith(d):
2956 2956 break
2957 2957 else:
2958 2958 fail(f, _(b"no match under directory!"))
2959 2959 elif f not in self.dirstate:
2960 2960 fail(f, _(b"file not tracked!"))
2961 2961
2962 2962 @unfilteredmethod
2963 2963 def commit(
2964 2964 self,
2965 2965 text=b"",
2966 2966 user=None,
2967 2967 date=None,
2968 2968 match=None,
2969 2969 force=False,
2970 2970 editor=None,
2971 2971 extra=None,
2972 2972 ):
2973 2973 """Add a new revision to current repository.
2974 2974
2975 2975 Revision information is gathered from the working directory,
2976 2976 match can be used to filter the committed files. If editor is
2977 2977 supplied, it is called to get a commit message.
2978 2978 """
2979 2979 if extra is None:
2980 2980 extra = {}
2981 2981
2982 2982 def fail(f, msg):
2983 2983 raise error.InputError(b'%s: %s' % (f, msg))
2984 2984
2985 2985 if not match:
2986 2986 match = matchmod.always()
2987 2987
2988 2988 if not force:
2989 2989 match.bad = fail
2990 2990
2991 2991 # lock() for recent changelog (see issue4368)
2992 2992 with self.wlock(), self.lock():
2993 2993 wctx = self[None]
2994 2994 merge = len(wctx.parents()) > 1
2995 2995
2996 2996 if not force and merge and not match.always():
2997 2997 raise error.Abort(
2998 2998 _(
2999 2999 b'cannot partially commit a merge '
3000 3000 b'(do not specify files or patterns)'
3001 3001 )
3002 3002 )
3003 3003
3004 3004 status = self.status(match=match, clean=force)
3005 3005 if force:
3006 3006 status.modified.extend(
3007 3007 status.clean
3008 3008 ) # mq may commit clean files
3009 3009
3010 3010 # check subrepos
3011 3011 subs, commitsubs, newstate = subrepoutil.precommit(
3012 3012 self.ui, wctx, status, match, force=force
3013 3013 )
3014 3014
3015 3015 # make sure all explicit patterns are matched
3016 3016 if not force:
3017 3017 self.checkcommitpatterns(wctx, match, status, fail)
3018 3018
3019 3019 cctx = context.workingcommitctx(
3020 3020 self, status, text, user, date, extra
3021 3021 )
3022 3022
3023 3023 ms = mergestatemod.mergestate.read(self)
3024 3024 mergeutil.checkunresolved(ms)
3025 3025
3026 3026 # internal config: ui.allowemptycommit
3027 3027 if cctx.isempty() and not self.ui.configbool(
3028 3028 b'ui', b'allowemptycommit'
3029 3029 ):
3030 3030 self.ui.debug(b'nothing to commit, clearing merge state\n')
3031 3031 ms.reset()
3032 3032 return None
3033 3033
3034 3034 if merge and cctx.deleted():
3035 3035 raise error.Abort(_(b"cannot commit merge with missing files"))
3036 3036
3037 3037 if editor:
3038 3038 cctx._text = editor(self, cctx, subs)
3039 3039 edited = text != cctx._text
3040 3040
3041 3041 # Save commit message in case this transaction gets rolled back
3042 3042 # (e.g. by a pretxncommit hook). Leave the content alone on
3043 3043 # the assumption that the user will use the same editor again.
3044 3044 msgfn = self.savecommitmessage(cctx._text)
3045 3045
3046 3046 # commit subs and write new state
3047 3047 if subs:
3048 3048 uipathfn = scmutil.getuipathfn(self)
3049 3049 for s in sorted(commitsubs):
3050 3050 sub = wctx.sub(s)
3051 3051 self.ui.status(
3052 3052 _(b'committing subrepository %s\n')
3053 3053 % uipathfn(subrepoutil.subrelpath(sub))
3054 3054 )
3055 3055 sr = sub.commit(cctx._text, user, date)
3056 3056 newstate[s] = (newstate[s][0], sr)
3057 3057 subrepoutil.writestate(self, newstate)
3058 3058
3059 3059 p1, p2 = self.dirstate.parents()
3060 3060 hookp1, hookp2 = hex(p1), (p2 != nullid and hex(p2) or b'')
3061 3061 try:
3062 3062 self.hook(
3063 3063 b"precommit", throw=True, parent1=hookp1, parent2=hookp2
3064 3064 )
3065 3065 with self.transaction(b'commit'):
3066 3066 ret = self.commitctx(cctx, True)
3067 3067 # update bookmarks, dirstate and mergestate
3068 3068 bookmarks.update(self, [p1, p2], ret)
3069 3069 cctx.markcommitted(ret)
3070 3070 ms.reset()
3071 3071 except: # re-raises
3072 3072 if edited:
3073 3073 self.ui.write(
3074 3074 _(b'note: commit message saved in %s\n') % msgfn
3075 3075 )
3076 3076 self.ui.write(
3077 3077 _(
3078 3078 b"note: use 'hg commit --logfile "
3079 3079 b".hg/last-message.txt --edit' to reuse it\n"
3080 3080 )
3081 3081 )
3082 3082 raise
3083 3083
3084 3084 def commithook(unused_success):
3085 3085 # hack for command that use a temporary commit (eg: histedit)
3086 3086 # temporary commit got stripped before hook release
3087 3087 if self.changelog.hasnode(ret):
3088 3088 self.hook(
3089 3089 b"commit", node=hex(ret), parent1=hookp1, parent2=hookp2
3090 3090 )
3091 3091
3092 3092 self._afterlock(commithook)
3093 3093 return ret
3094 3094
3095 3095 @unfilteredmethod
3096 3096 def commitctx(self, ctx, error=False, origctx=None):
3097 3097 return commit.commitctx(self, ctx, error=error, origctx=origctx)
3098 3098
3099 3099 @unfilteredmethod
3100 3100 def destroying(self):
3101 3101 """Inform the repository that nodes are about to be destroyed.
3102 3102 Intended for use by strip and rollback, so there's a common
3103 3103 place for anything that has to be done before destroying history.
3104 3104
3105 3105 This is mostly useful for saving state that is in memory and waiting
3106 3106 to be flushed when the current lock is released. Because a call to
3107 3107 destroyed is imminent, the repo will be invalidated causing those
3108 3108 changes to stay in memory (waiting for the next unlock), or vanish
3109 3109 completely.
3110 3110 """
3111 3111 # When using the same lock to commit and strip, the phasecache is left
3112 3112 # dirty after committing. Then when we strip, the repo is invalidated,
3113 3113 # causing those changes to disappear.
3114 3114 if '_phasecache' in vars(self):
3115 3115 self._phasecache.write()
3116 3116
3117 3117 @unfilteredmethod
3118 3118 def destroyed(self):
3119 3119 """Inform the repository that nodes have been destroyed.
3120 3120 Intended for use by strip and rollback, so there's a common
3121 3121 place for anything that has to be done after destroying history.
3122 3122 """
3123 3123 # When one tries to:
3124 3124 # 1) destroy nodes thus calling this method (e.g. strip)
3125 3125 # 2) use phasecache somewhere (e.g. commit)
3126 3126 #
3127 3127 # then 2) will fail because the phasecache contains nodes that were
3128 3128 # removed. We can either remove phasecache from the filecache,
3129 3129 # causing it to reload next time it is accessed, or simply filter
3130 3130 # the removed nodes now and write the updated cache.
3131 3131 self._phasecache.filterunknown(self)
3132 3132 self._phasecache.write()
3133 3133
3134 3134 # refresh all repository caches
3135 3135 self.updatecaches()
3136 3136
3137 3137 # Ensure the persistent tag cache is updated. Doing it now
3138 3138 # means that the tag cache only has to worry about destroyed
3139 3139 # heads immediately after a strip/rollback. That in turn
3140 3140 # guarantees that "cachetip == currenttip" (comparing both rev
3141 3141 # and node) always means no nodes have been added or destroyed.
3142 3142
3143 3143 # XXX this is suboptimal when qrefresh'ing: we strip the current
3144 3144 # head, refresh the tag cache, then immediately add a new head.
3145 3145 # But I think doing it this way is necessary for the "instant
3146 3146 # tag cache retrieval" case to work.
3147 3147 self.invalidate()
3148 3148
3149 3149 def status(
3150 3150 self,
3151 3151 node1=b'.',
3152 3152 node2=None,
3153 3153 match=None,
3154 3154 ignored=False,
3155 3155 clean=False,
3156 3156 unknown=False,
3157 3157 listsubrepos=False,
3158 3158 ):
3159 3159 '''a convenience method that calls node1.status(node2)'''
3160 3160 return self[node1].status(
3161 3161 node2, match, ignored, clean, unknown, listsubrepos
3162 3162 )
3163 3163
3164 3164 def addpostdsstatus(self, ps):
3165 3165 """Add a callback to run within the wlock, at the point at which status
3166 3166 fixups happen.
3167 3167
3168 3168 On status completion, callback(wctx, status) will be called with the
3169 3169 wlock held, unless the dirstate has changed from underneath or the wlock
3170 3170 couldn't be grabbed.
3171 3171
3172 3172 Callbacks should not capture and use a cached copy of the dirstate --
3173 3173 it might change in the meanwhile. Instead, they should access the
3174 3174 dirstate via wctx.repo().dirstate.
3175 3175
3176 3176 This list is emptied out after each status run -- extensions should
3177 3177 make sure it adds to this list each time dirstate.status is called.
3178 3178 Extensions should also make sure they don't call this for statuses
3179 3179 that don't involve the dirstate.
3180 3180 """
3181 3181
3182 3182 # The list is located here for uniqueness reasons -- it is actually
3183 3183 # managed by the workingctx, but that isn't unique per-repo.
3184 3184 self._postdsstatus.append(ps)
3185 3185
3186 3186 def postdsstatus(self):
3187 3187 """Used by workingctx to get the list of post-dirstate-status hooks."""
3188 3188 return self._postdsstatus
3189 3189
3190 3190 def clearpostdsstatus(self):
3191 3191 """Used by workingctx to clear post-dirstate-status hooks."""
3192 3192 del self._postdsstatus[:]
3193 3193
3194 3194 def heads(self, start=None):
3195 3195 if start is None:
3196 3196 cl = self.changelog
3197 3197 headrevs = reversed(cl.headrevs())
3198 3198 return [cl.node(rev) for rev in headrevs]
3199 3199
3200 3200 heads = self.changelog.heads(start)
3201 3201 # sort the output in rev descending order
3202 3202 return sorted(heads, key=self.changelog.rev, reverse=True)
3203 3203
3204 3204 def branchheads(self, branch=None, start=None, closed=False):
3205 3205 """return a (possibly filtered) list of heads for the given branch
3206 3206
3207 3207 Heads are returned in topological order, from newest to oldest.
3208 3208 If branch is None, use the dirstate branch.
3209 3209 If start is not None, return only heads reachable from start.
3210 3210 If closed is True, return heads that are marked as closed as well.
3211 3211 """
3212 3212 if branch is None:
3213 3213 branch = self[None].branch()
3214 3214 branches = self.branchmap()
3215 3215 if not branches.hasbranch(branch):
3216 3216 return []
3217 3217 # the cache returns heads ordered lowest to highest
3218 3218 bheads = list(reversed(branches.branchheads(branch, closed=closed)))
3219 3219 if start is not None:
3220 3220 # filter out the heads that cannot be reached from startrev
3221 3221 fbheads = set(self.changelog.nodesbetween([start], bheads)[2])
3222 3222 bheads = [h for h in bheads if h in fbheads]
3223 3223 return bheads
3224 3224
3225 3225 def branches(self, nodes):
3226 3226 if not nodes:
3227 3227 nodes = [self.changelog.tip()]
3228 3228 b = []
3229 3229 for n in nodes:
3230 3230 t = n
3231 3231 while True:
3232 3232 p = self.changelog.parents(n)
3233 3233 if p[1] != nullid or p[0] == nullid:
3234 3234 b.append((t, n, p[0], p[1]))
3235 3235 break
3236 3236 n = p[0]
3237 3237 return b
3238 3238
3239 3239 def between(self, pairs):
3240 3240 r = []
3241 3241
3242 3242 for top, bottom in pairs:
3243 3243 n, l, i = top, [], 0
3244 3244 f = 1
3245 3245
3246 3246 while n != bottom and n != nullid:
3247 3247 p = self.changelog.parents(n)[0]
3248 3248 if i == f:
3249 3249 l.append(n)
3250 3250 f = f * 2
3251 3251 n = p
3252 3252 i += 1
3253 3253
3254 3254 r.append(l)
3255 3255
3256 3256 return r
3257 3257
3258 3258 def checkpush(self, pushop):
3259 3259 """Extensions can override this function if additional checks have
3260 3260 to be performed before pushing, or call it if they override push
3261 3261 command.
3262 3262 """
3263 3263
3264 3264 @unfilteredpropertycache
3265 3265 def prepushoutgoinghooks(self):
3266 3266 """Return util.hooks consists of a pushop with repo, remote, outgoing
3267 3267 methods, which are called before pushing changesets.
3268 3268 """
3269 3269 return util.hooks()
3270 3270
3271 3271 def pushkey(self, namespace, key, old, new):
3272 3272 try:
3273 3273 tr = self.currenttransaction()
3274 3274 hookargs = {}
3275 3275 if tr is not None:
3276 3276 hookargs.update(tr.hookargs)
3277 3277 hookargs = pycompat.strkwargs(hookargs)
3278 3278 hookargs['namespace'] = namespace
3279 3279 hookargs['key'] = key
3280 3280 hookargs['old'] = old
3281 3281 hookargs['new'] = new
3282 3282 self.hook(b'prepushkey', throw=True, **hookargs)
3283 3283 except error.HookAbort as exc:
3284 3284 self.ui.write_err(_(b"pushkey-abort: %s\n") % exc)
3285 3285 if exc.hint:
3286 3286 self.ui.write_err(_(b"(%s)\n") % exc.hint)
3287 3287 return False
3288 3288 self.ui.debug(b'pushing key for "%s:%s"\n' % (namespace, key))
3289 3289 ret = pushkey.push(self, namespace, key, old, new)
3290 3290
3291 3291 def runhook(unused_success):
3292 3292 self.hook(
3293 3293 b'pushkey',
3294 3294 namespace=namespace,
3295 3295 key=key,
3296 3296 old=old,
3297 3297 new=new,
3298 3298 ret=ret,
3299 3299 )
3300 3300
3301 3301 self._afterlock(runhook)
3302 3302 return ret
3303 3303
3304 3304 def listkeys(self, namespace):
3305 3305 self.hook(b'prelistkeys', throw=True, namespace=namespace)
3306 3306 self.ui.debug(b'listing keys for "%s"\n' % namespace)
3307 3307 values = pushkey.list(self, namespace)
3308 3308 self.hook(b'listkeys', namespace=namespace, values=values)
3309 3309 return values
3310 3310
3311 3311 def debugwireargs(self, one, two, three=None, four=None, five=None):
3312 3312 '''used to test argument passing over the wire'''
3313 3313 return b"%s %s %s %s %s" % (
3314 3314 one,
3315 3315 two,
3316 3316 pycompat.bytestr(three),
3317 3317 pycompat.bytestr(four),
3318 3318 pycompat.bytestr(five),
3319 3319 )
3320 3320
3321 3321 def savecommitmessage(self, text):
3322 3322 fp = self.vfs(b'last-message.txt', b'wb')
3323 3323 try:
3324 3324 fp.write(text)
3325 3325 finally:
3326 3326 fp.close()
3327 3327 return self.pathto(fp.name[len(self.root) + 1 :])
3328 3328
3329 3329
3330 3330 # used to avoid circular references so destructors work
3331 3331 def aftertrans(files):
3332 3332 renamefiles = [tuple(t) for t in files]
3333 3333
3334 3334 def a():
3335 3335 for vfs, src, dest in renamefiles:
3336 3336 # if src and dest refer to a same file, vfs.rename is a no-op,
3337 3337 # leaving both src and dest on disk. delete dest to make sure
3338 3338 # the rename couldn't be such a no-op.
3339 3339 vfs.tryunlink(dest)
3340 3340 try:
3341 3341 vfs.rename(src, dest)
3342 3342 except OSError: # journal file does not yet exist
3343 3343 pass
3344 3344
3345 3345 return a
3346 3346
3347 3347
3348 3348 def undoname(fn):
3349 3349 base, name = os.path.split(fn)
3350 3350 assert name.startswith(b'journal')
3351 3351 return os.path.join(base, name.replace(b'journal', b'undo', 1))
3352 3352
3353 3353
3354 3354 def instance(ui, path, create, intents=None, createopts=None):
3355 3355 localpath = util.urllocalpath(path)
3356 3356 if create:
3357 3357 createrepository(ui, localpath, createopts=createopts)
3358 3358
3359 3359 return makelocalrepository(ui, localpath, intents=intents)
3360 3360
3361 3361
3362 3362 def islocal(path):
3363 3363 return True
3364 3364
3365 3365
3366 3366 def defaultcreateopts(ui, createopts=None):
3367 3367 """Populate the default creation options for a repository.
3368 3368
3369 3369 A dictionary of explicitly requested creation options can be passed
3370 3370 in. Missing keys will be populated.
3371 3371 """
3372 3372 createopts = dict(createopts or {})
3373 3373
3374 3374 if b'backend' not in createopts:
3375 3375 # experimental config: storage.new-repo-backend
3376 3376 createopts[b'backend'] = ui.config(b'storage', b'new-repo-backend')
3377 3377
3378 3378 return createopts
3379 3379
3380 3380
3381 3381 def newreporequirements(ui, createopts):
3382 3382 """Determine the set of requirements for a new local repository.
3383 3383
3384 3384 Extensions can wrap this function to specify custom requirements for
3385 3385 new repositories.
3386 3386 """
3387 3387 # If the repo is being created from a shared repository, we copy
3388 3388 # its requirements.
3389 3389 if b'sharedrepo' in createopts:
3390 3390 requirements = set(createopts[b'sharedrepo'].requirements)
3391 3391 if createopts.get(b'sharedrelative'):
3392 3392 requirements.add(requirementsmod.RELATIVE_SHARED_REQUIREMENT)
3393 3393 else:
3394 3394 requirements.add(requirementsmod.SHARED_REQUIREMENT)
3395 3395
3396 3396 return requirements
3397 3397
3398 3398 if b'backend' not in createopts:
3399 3399 raise error.ProgrammingError(
3400 3400 b'backend key not present in createopts; '
3401 3401 b'was defaultcreateopts() called?'
3402 3402 )
3403 3403
3404 3404 if createopts[b'backend'] != b'revlogv1':
3405 3405 raise error.Abort(
3406 3406 _(
3407 3407 b'unable to determine repository requirements for '
3408 3408 b'storage backend: %s'
3409 3409 )
3410 3410 % createopts[b'backend']
3411 3411 )
3412 3412
3413 3413 requirements = {b'revlogv1'}
3414 3414 if ui.configbool(b'format', b'usestore'):
3415 3415 requirements.add(b'store')
3416 3416 if ui.configbool(b'format', b'usefncache'):
3417 3417 requirements.add(b'fncache')
3418 3418 if ui.configbool(b'format', b'dotencode'):
3419 3419 requirements.add(b'dotencode')
3420 3420
3421 3421 compengines = ui.configlist(b'format', b'revlog-compression')
3422 3422 for compengine in compengines:
3423 3423 if compengine in util.compengines:
3424 3424 break
3425 3425 else:
3426 3426 raise error.Abort(
3427 3427 _(
3428 3428 b'compression engines %s defined by '
3429 3429 b'format.revlog-compression not available'
3430 3430 )
3431 3431 % b', '.join(b'"%s"' % e for e in compengines),
3432 3432 hint=_(
3433 3433 b'run "hg debuginstall" to list available '
3434 3434 b'compression engines'
3435 3435 ),
3436 3436 )
3437 3437
3438 3438 # zlib is the historical default and doesn't need an explicit requirement.
3439 3439 if compengine == b'zstd':
3440 3440 requirements.add(b'revlog-compression-zstd')
3441 3441 elif compengine != b'zlib':
3442 3442 requirements.add(b'exp-compression-%s' % compengine)
3443 3443
3444 3444 if scmutil.gdinitconfig(ui):
3445 3445 requirements.add(b'generaldelta')
3446 3446 if ui.configbool(b'format', b'sparse-revlog'):
3447 3447 requirements.add(requirementsmod.SPARSEREVLOG_REQUIREMENT)
3448 3448
3449 3449 # experimental config: format.exp-use-side-data
3450 3450 if ui.configbool(b'format', b'exp-use-side-data'):
3451 3451 requirements.add(requirementsmod.SIDEDATA_REQUIREMENT)
3452 3452 # experimental config: format.exp-use-copies-side-data-changeset
3453 3453 if ui.configbool(b'format', b'exp-use-copies-side-data-changeset'):
3454 3454 requirements.add(requirementsmod.SIDEDATA_REQUIREMENT)
3455 3455 requirements.add(requirementsmod.COPIESSDC_REQUIREMENT)
3456 3456 if ui.configbool(b'experimental', b'treemanifest'):
3457 3457 requirements.add(requirementsmod.TREEMANIFEST_REQUIREMENT)
3458 3458
3459 3459 revlogv2 = ui.config(b'experimental', b'revlogv2')
3460 3460 if revlogv2 == b'enable-unstable-format-and-corrupt-my-data':
3461 3461 requirements.remove(b'revlogv1')
3462 3462 # generaldelta is implied by revlogv2.
3463 3463 requirements.discard(b'generaldelta')
3464 3464 requirements.add(requirementsmod.REVLOGV2_REQUIREMENT)
3465 3465 # experimental config: format.internal-phase
3466 3466 if ui.configbool(b'format', b'internal-phase'):
3467 3467 requirements.add(requirementsmod.INTERNAL_PHASE_REQUIREMENT)
3468 3468
3469 3469 if createopts.get(b'narrowfiles'):
3470 3470 requirements.add(requirementsmod.NARROW_REQUIREMENT)
3471 3471
3472 3472 if createopts.get(b'lfs'):
3473 3473 requirements.add(b'lfs')
3474 3474
3475 3475 if ui.configbool(b'format', b'bookmarks-in-store'):
3476 3476 requirements.add(bookmarks.BOOKMARKS_IN_STORE_REQUIREMENT)
3477 3477
3478 3478 if ui.configbool(b'format', b'use-persistent-nodemap'):
3479 3479 requirements.add(requirementsmod.NODEMAP_REQUIREMENT)
3480 3480
3481 3481 # if share-safe is enabled, let's create the new repository with the new
3482 3482 # requirement
3483 3483 if ui.configbool(b'format', b'use-share-safe'):
3484 3484 requirements.add(requirementsmod.SHARESAFE_REQUIREMENT)
3485 3485
3486 3486 return requirements
3487 3487
3488 3488
3489 3489 def checkrequirementscompat(ui, requirements):
3490 3490 """Checks compatibility of repository requirements enabled and disabled.
3491 3491
3492 3492 Returns a set of requirements which needs to be dropped because dependend
3493 3493 requirements are not enabled. Also warns users about it"""
3494 3494
3495 3495 dropped = set()
3496 3496
3497 3497 if b'store' not in requirements:
3498 3498 if bookmarks.BOOKMARKS_IN_STORE_REQUIREMENT in requirements:
3499 3499 ui.warn(
3500 3500 _(
3501 3501 b'ignoring enabled \'format.bookmarks-in-store\' config '
3502 3502 b'beacuse it is incompatible with disabled '
3503 3503 b'\'format.usestore\' config\n'
3504 3504 )
3505 3505 )
3506 3506 dropped.add(bookmarks.BOOKMARKS_IN_STORE_REQUIREMENT)
3507 3507
3508 3508 if (
3509 3509 requirementsmod.SHARED_REQUIREMENT in requirements
3510 3510 or requirementsmod.RELATIVE_SHARED_REQUIREMENT in requirements
3511 3511 ):
3512 3512 raise error.Abort(
3513 3513 _(
3514 3514 b"cannot create shared repository as source was created"
3515 3515 b" with 'format.usestore' config disabled"
3516 3516 )
3517 3517 )
3518 3518
3519 3519 if requirementsmod.SHARESAFE_REQUIREMENT in requirements:
3520 3520 ui.warn(
3521 3521 _(
3522 3522 b"ignoring enabled 'format.use-share-safe' config because "
3523 3523 b"it is incompatible with disabled 'format.usestore'"
3524 3524 b" config\n"
3525 3525 )
3526 3526 )
3527 3527 dropped.add(requirementsmod.SHARESAFE_REQUIREMENT)
3528 3528
3529 3529 return dropped
3530 3530
3531 3531
3532 3532 def filterknowncreateopts(ui, createopts):
3533 3533 """Filters a dict of repo creation options against options that are known.
3534 3534
3535 3535 Receives a dict of repo creation options and returns a dict of those
3536 3536 options that we don't know how to handle.
3537 3537
3538 3538 This function is called as part of repository creation. If the
3539 3539 returned dict contains any items, repository creation will not
3540 3540 be allowed, as it means there was a request to create a repository
3541 3541 with options not recognized by loaded code.
3542 3542
3543 3543 Extensions can wrap this function to filter out creation options
3544 3544 they know how to handle.
3545 3545 """
3546 3546 known = {
3547 3547 b'backend',
3548 3548 b'lfs',
3549 3549 b'narrowfiles',
3550 3550 b'sharedrepo',
3551 3551 b'sharedrelative',
3552 3552 b'shareditems',
3553 3553 b'shallowfilestore',
3554 3554 }
3555 3555
3556 3556 return {k: v for k, v in createopts.items() if k not in known}
3557 3557
3558 3558
3559 3559 def createrepository(ui, path, createopts=None):
3560 3560 """Create a new repository in a vfs.
3561 3561
3562 3562 ``path`` path to the new repo's working directory.
3563 3563 ``createopts`` options for the new repository.
3564 3564
3565 3565 The following keys for ``createopts`` are recognized:
3566 3566
3567 3567 backend
3568 3568 The storage backend to use.
3569 3569 lfs
3570 3570 Repository will be created with ``lfs`` requirement. The lfs extension
3571 3571 will automatically be loaded when the repository is accessed.
3572 3572 narrowfiles
3573 3573 Set up repository to support narrow file storage.
3574 3574 sharedrepo
3575 3575 Repository object from which storage should be shared.
3576 3576 sharedrelative
3577 3577 Boolean indicating if the path to the shared repo should be
3578 3578 stored as relative. By default, the pointer to the "parent" repo
3579 3579 is stored as an absolute path.
3580 3580 shareditems
3581 3581 Set of items to share to the new repository (in addition to storage).
3582 3582 shallowfilestore
3583 3583 Indicates that storage for files should be shallow (not all ancestor
3584 3584 revisions are known).
3585 3585 """
3586 3586 createopts = defaultcreateopts(ui, createopts=createopts)
3587 3587
3588 3588 unknownopts = filterknowncreateopts(ui, createopts)
3589 3589
3590 3590 if not isinstance(unknownopts, dict):
3591 3591 raise error.ProgrammingError(
3592 3592 b'filterknowncreateopts() did not return a dict'
3593 3593 )
3594 3594
3595 3595 if unknownopts:
3596 3596 raise error.Abort(
3597 3597 _(
3598 3598 b'unable to create repository because of unknown '
3599 3599 b'creation option: %s'
3600 3600 )
3601 3601 % b', '.join(sorted(unknownopts)),
3602 3602 hint=_(b'is a required extension not loaded?'),
3603 3603 )
3604 3604
3605 3605 requirements = newreporequirements(ui, createopts=createopts)
3606 3606 requirements -= checkrequirementscompat(ui, requirements)
3607 3607
3608 3608 wdirvfs = vfsmod.vfs(path, expandpath=True, realpath=True)
3609 3609
3610 3610 hgvfs = vfsmod.vfs(wdirvfs.join(b'.hg'))
3611 3611 if hgvfs.exists():
3612 3612 raise error.RepoError(_(b'repository %s already exists') % path)
3613 3613
3614 3614 if b'sharedrepo' in createopts:
3615 3615 sharedpath = createopts[b'sharedrepo'].sharedpath
3616 3616
3617 3617 if createopts.get(b'sharedrelative'):
3618 3618 try:
3619 3619 sharedpath = os.path.relpath(sharedpath, hgvfs.base)
3620 3620 except (IOError, ValueError) as e:
3621 3621 # ValueError is raised on Windows if the drive letters differ
3622 3622 # on each path.
3623 3623 raise error.Abort(
3624 3624 _(b'cannot calculate relative path'),
3625 3625 hint=stringutil.forcebytestr(e),
3626 3626 )
3627 3627
3628 3628 if not wdirvfs.exists():
3629 3629 wdirvfs.makedirs()
3630 3630
3631 3631 hgvfs.makedir(notindexed=True)
3632 3632 if b'sharedrepo' not in createopts:
3633 3633 hgvfs.mkdir(b'cache')
3634 3634 hgvfs.mkdir(b'wcache')
3635 3635
3636 3636 if b'store' in requirements and b'sharedrepo' not in createopts:
3637 3637 hgvfs.mkdir(b'store')
3638 3638
3639 3639 # We create an invalid changelog outside the store so very old
3640 3640 # Mercurial versions (which didn't know about the requirements
3641 3641 # file) encounter an error on reading the changelog. This
3642 3642 # effectively locks out old clients and prevents them from
3643 3643 # mucking with a repo in an unknown format.
3644 3644 #
3645 3645 # The revlog header has version 2, which won't be recognized by
3646 3646 # such old clients.
3647 3647 hgvfs.append(
3648 3648 b'00changelog.i',
3649 3649 b'\0\0\0\2 dummy changelog to prevent using the old repo '
3650 3650 b'layout',
3651 3651 )
3652 3652
3653 3653 # Filter the requirements into working copy and store ones
3654 3654 wcreq, storereq = scmutil.filterrequirements(requirements)
3655 3655 # write working copy ones
3656 3656 scmutil.writerequires(hgvfs, wcreq)
3657 3657 # If there are store requirements and the current repository
3658 3658 # is not a shared one, write stored requirements
3659 3659 # For new shared repository, we don't need to write the store
3660 3660 # requirements as they are already present in store requires
3661 3661 if storereq and b'sharedrepo' not in createopts:
3662 3662 storevfs = vfsmod.vfs(hgvfs.join(b'store'), cacheaudited=True)
3663 3663 scmutil.writerequires(storevfs, storereq)
3664 3664
3665 3665 # Write out file telling readers where to find the shared store.
3666 3666 if b'sharedrepo' in createopts:
3667 3667 hgvfs.write(b'sharedpath', sharedpath)
3668 3668
3669 3669 if createopts.get(b'shareditems'):
3670 3670 shared = b'\n'.join(sorted(createopts[b'shareditems'])) + b'\n'
3671 3671 hgvfs.write(b'shared', shared)
3672 3672
3673 3673
3674 3674 def poisonrepository(repo):
3675 3675 """Poison a repository instance so it can no longer be used."""
3676 3676 # Perform any cleanup on the instance.
3677 3677 repo.close()
3678 3678
3679 3679 # Our strategy is to replace the type of the object with one that
3680 3680 # has all attribute lookups result in error.
3681 3681 #
3682 3682 # But we have to allow the close() method because some constructors
3683 3683 # of repos call close() on repo references.
3684 3684 class poisonedrepository(object):
3685 3685 def __getattribute__(self, item):
3686 3686 if item == 'close':
3687 3687 return object.__getattribute__(self, item)
3688 3688
3689 3689 raise error.ProgrammingError(
3690 3690 b'repo instances should not be used after unshare'
3691 3691 )
3692 3692
3693 3693 def close(self):
3694 3694 pass
3695 3695
3696 3696 # We may have a repoview, which intercepts __setattr__. So be sure
3697 3697 # we operate at the lowest level possible.
3698 3698 object.__setattr__(repo, '__class__', poisonedrepository)
General Comments 0
You need to be logged in to leave comments. Login now