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