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