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