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