wrapper.py
449 lines
| 15.4 KiB
| text/x-python
|
PythonLexer
|
r35097 | # wrapper.py - methods wrapping core mercurial logic | ||
# | ||||
# Copyright 2017 Facebook, Inc. | ||||
# | ||||
# This software may be used and distributed according to the terms of the | ||||
# GNU General Public License version 2 or any later version. | ||||
from __future__ import absolute_import | ||||
import hashlib | ||||
|
r35098 | from mercurial.i18n import _ | ||
|
r36622 | from mercurial.node import bin, hex, nullid, short | ||
|
r35098 | |||
|
r35097 | from mercurial import ( | ||
|
r41078 | bundle2, | ||
changegroup, | ||||
cmdutil, | ||||
context, | ||||
|
r35097 | error, | ||
|
r41078 | exchange, | ||
exthelper, | ||||
localrepo, | ||||
|
r35097 | revlog, | ||
|
r41078 | scmutil, | ||
upgrade, | ||||
|
r35097 | util, | ||
|
r41078 | vfs as vfsmod, | ||
wireprotov1server, | ||||
|
r35097 | ) | ||
|
r43078 | from mercurial.interfaces import ( | ||
repository, | ||||
) | ||||
|
r37102 | from mercurial.utils import ( | ||
|
r39914 | storageutil, | ||
|
r37102 | stringutil, | ||
) | ||||
|
r35364 | from ..largefiles import lfutil | ||
|
r35097 | from . import ( | ||
blobstore, | ||||
pointer, | ||||
) | ||||
|
r41078 | eh = exthelper.exthelper() | ||
@eh.wrapfunction(localrepo, 'makefilestorage') | ||||
|
r39887 | def localrepomakefilestorage(orig, requirements, features, **kwargs): | ||
if b'lfs' in requirements: | ||||
features.add(repository.REPO_FEATURE_LFS) | ||||
return orig(requirements=requirements, features=features, **kwargs) | ||||
|
r41078 | @eh.wrapfunction(changegroup, 'allsupportedversions') | ||
|
r35097 | def allsupportedversions(orig, ui): | ||
versions = orig(ui) | ||||
versions.add('03') | ||||
return versions | ||||
|
r41078 | @eh.wrapfunction(wireprotov1server, '_capabilities') | ||
|
r35522 | def _capabilities(orig, repo, proto): | ||
'''Wrap server command to announce lfs server capability''' | ||||
caps = orig(repo, proto) | ||||
|
r38199 | if util.safehasattr(repo.svfs, 'lfslocalblobstore'): | ||
|
r40360 | # Advertise a slightly different capability when lfs is *required*, so | ||
# that the client knows it MUST load the extension. If lfs is not | ||||
# required on the server, there's no reason to autoload the extension | ||||
# on the client. | ||||
if b'lfs' in repo.requirements: | ||||
caps.append('lfs-serve') | ||||
|
r38199 | caps.append('lfs') | ||
|
r35522 | return caps | ||
|
r35097 | def bypasscheckhash(self, text): | ||
return False | ||||
def readfromstore(self, text): | ||||
"""Read filelog content from local blobstore transform for flagprocessor. | ||||
Default tranform for flagprocessor, returning contents from blobstore. | ||||
Returns a 2-typle (text, validatehash) where validatehash is True as the | ||||
contents of the blobstore should be checked using checkhash. | ||||
""" | ||||
p = pointer.deserialize(text) | ||||
oid = p.oid() | ||||
store = self.opener.lfslocalblobstore | ||||
if not store.has(oid): | ||||
|
r35584 | p.filename = self.filename | ||
|
r35097 | self.opener.lfsremoteblobstore.readbatch([p], store) | ||
|
r35492 | |||
# The caller will validate the content | ||||
text = store.read(oid, verify=False) | ||||
|
r35097 | |||
# pack hg filelog metadata | ||||
hgmeta = {} | ||||
for k in p.keys(): | ||||
if k.startswith('x-hg-'): | ||||
name = k[len('x-hg-'):] | ||||
hgmeta[name] = p[k] | ||||
if hgmeta or text.startswith('\1\n'): | ||||
|
r39914 | text = storageutil.packmeta(hgmeta, text) | ||
|
r35097 | |||
return (text, True) | ||||
def writetostore(self, text): | ||||
# hg filelog metadata (includes rename, etc) | ||||
|
r39914 | hgmeta, offset = storageutil.parsemeta(text) | ||
|
r35097 | if offset and offset > 0: | ||
# lfs blob does not contain hg filelog metadata | ||||
text = text[offset:] | ||||
# git-lfs only supports sha256 | ||||
|
r36622 | oid = hex(hashlib.sha256(text).digest()) | ||
|
r35567 | self.opener.lfslocalblobstore.write(oid, text) | ||
|
r35097 | |||
# replace contents with metadata | ||||
longoid = 'sha256:%s' % oid | ||||
|
r36621 | metadata = pointer.gitlfspointer(oid=longoid, size='%d' % len(text)) | ||
|
r35097 | |||
# by default, we expect the content to be binary. however, LFS could also | ||||
# be used for non-binary content. add a special entry for non-binary data. | ||||
# this will be used by filectx.isbinary(). | ||||
|
r37102 | if not stringutil.binary(text): | ||
|
r35097 | # not hg filelog metadata (affecting commit hash), no "x-hg-" prefix | ||
metadata['x-is-binary'] = '0' | ||||
# translate hg filelog metadata to lfs metadata with "x-hg-" prefix | ||||
if hgmeta is not None: | ||||
for k, v in hgmeta.iteritems(): | ||||
metadata['x-hg-%s' % k] = v | ||||
rawtext = metadata.serialize() | ||||
return (rawtext, False) | ||||
def _islfs(rlog, node=None, rev=None): | ||||
if rev is None: | ||||
if node is None: | ||||
# both None - likely working copy content where node is not ready | ||||
return False | ||||
|
r39891 | rev = rlog._revlog.rev(node) | ||
|
r35097 | else: | ||
|
r39891 | node = rlog._revlog.node(rev) | ||
|
r35097 | if node == nullid: | ||
return False | ||||
|
r39891 | flags = rlog._revlog.flags(rev) | ||
|
r35097 | return bool(flags & revlog.REVIDX_EXTSTORED) | ||
|
r41078 | # Wrapping may also be applied by remotefilelog | ||
|
r35097 | def filelogaddrevision(orig, self, text, transaction, link, p1, p2, | ||
cachedelta=None, node=None, | ||||
flags=revlog.REVIDX_DEFAULT_FLAGS, **kwds): | ||||
|
r38199 | # The matcher isn't available if reposetup() wasn't called. | ||
|
r39891 | lfstrack = self._revlog.opener.options.get('lfstrack') | ||
|
r35097 | |||
|
r38199 | if lfstrack: | ||
textlen = len(text) | ||||
# exclude hg rename meta from file size | ||||
|
r39914 | meta, offset = storageutil.parsemeta(text) | ||
|
r38199 | if offset: | ||
textlen -= offset | ||||
|
r35666 | |||
|
r39892 | if lfstrack(self._revlog.filename, textlen): | ||
|
r38199 | flags |= revlog.REVIDX_EXTSTORED | ||
|
r35097 | |||
return orig(self, text, transaction, link, p1, p2, cachedelta=cachedelta, | ||||
node=node, flags=flags, **kwds) | ||||
|
r41078 | # Wrapping may also be applied by remotefilelog | ||
|
r35097 | def filelogrenamed(orig, self, node): | ||
if _islfs(self, node): | ||||
r43043 | rawtext = self._revlog.rawdata(node) | |||
|
r35097 | if not rawtext: | ||
return False | ||||
metadata = pointer.deserialize(rawtext) | ||||
if 'x-hg-copy' in metadata and 'x-hg-copyrev' in metadata: | ||||
return metadata['x-hg-copy'], bin(metadata['x-hg-copyrev']) | ||||
else: | ||||
return False | ||||
return orig(self, node) | ||||
|
r41078 | # Wrapping may also be applied by remotefilelog | ||
|
r35097 | def filelogsize(orig, self, rev): | ||
if _islfs(self, rev=rev): | ||||
# fast path: use lfs metadata to answer size | ||||
r43043 | rawtext = self._revlog.rawdata(rev) | |||
|
r35097 | metadata = pointer.deserialize(rawtext) | ||
return int(metadata['size']) | ||||
return orig(self, rev) | ||||
|
r41078 | @eh.wrapfunction(context.basefilectx, 'cmp') | ||
|
r35097 | def filectxcmp(orig, self, fctx): | ||
"""returns True if text is different than fctx""" | ||||
# some fctx (ex. hg-git) is not based on basefilectx and do not have islfs | ||||
if self.islfs() and getattr(fctx, 'islfs', lambda: False)(): | ||||
# fast path: check LFS oid | ||||
p1 = pointer.deserialize(self.rawdata()) | ||||
p2 = pointer.deserialize(fctx.rawdata()) | ||||
return p1.oid() != p2.oid() | ||||
return orig(self, fctx) | ||||
|
r41078 | @eh.wrapfunction(context.basefilectx, 'isbinary') | ||
|
r35097 | def filectxisbinary(orig, self): | ||
if self.islfs(): | ||||
# fast path: use lfs metadata to answer isbinary | ||||
metadata = pointer.deserialize(self.rawdata()) | ||||
# if lfs metadata says nothing, assume it's binary by default | ||||
return bool(int(metadata.get('x-is-binary', 1))) | ||||
return orig(self) | ||||
def filectxislfs(self): | ||||
return _islfs(self.filelog(), self.filenode()) | ||||
|
r41078 | @eh.wrapfunction(cmdutil, '_updatecatformatter') | ||
|
r35681 | def _updatecatformatter(orig, fm, ctx, matcher, path, decode): | ||
orig(fm, ctx, matcher, path, decode) | ||||
fm.data(rawdata=ctx[path].rawdata()) | ||||
|
r41078 | @eh.wrapfunction(scmutil, 'wrapconvertsink') | ||
|
r35170 | def convertsink(orig, sink): | ||
sink = orig(sink) | ||||
if sink.repotype == 'hg': | ||||
class lfssink(sink.__class__): | ||||
def putcommit(self, files, copies, parents, commit, source, revmap, | ||||
full, cleanp2): | ||||
pc = super(lfssink, self).putcommit | ||||
node = pc(files, copies, parents, commit, source, revmap, full, | ||||
cleanp2) | ||||
if 'lfs' not in self.repo.requirements: | ||||
ctx = self.repo[node] | ||||
# The file list may contain removed files, so check for | ||||
# membership before assuming it is in the context. | ||||
if any(f in ctx and ctx[f].islfs() for f, n in files): | ||||
self.repo.requirements.add('lfs') | ||||
self.repo._writerequirements() | ||||
return node | ||||
sink.__class__ = lfssink | ||||
return sink | ||||
|
r41078 | # bundlerepo uses "vfsmod.readonlyvfs(othervfs)", we need to make sure lfs | ||
# options and blob stores are passed from othervfs to the new readonlyvfs. | ||||
@eh.wrapfunction(vfsmod.readonlyvfs, '__init__') | ||||
|
r35097 | def vfsinit(orig, self, othervfs): | ||
orig(self, othervfs) | ||||
# copy lfs related options | ||||
for k, v in othervfs.options.items(): | ||||
if k.startswith('lfs'): | ||||
self.options[k] = v | ||||
# also copy lfs blobstores. note: this can run before reposetup, so lfs | ||||
# blobstore attributes are not always ready at this time. | ||||
for name in ['lfslocalblobstore', 'lfsremoteblobstore']: | ||||
if util.safehasattr(othervfs, name): | ||||
setattr(self, name, getattr(othervfs, name)) | ||||
|
r37780 | def _prefetchfiles(repo, revs, match): | ||
|
r35940 | """Ensure that required LFS blobs are present, fetching them as a group if | ||
|
r36159 | needed.""" | ||
|
r38199 | if not util.safehasattr(repo.svfs, 'lfslocalblobstore'): | ||
return | ||||
|
r35940 | pointers = [] | ||
|
r37780 | oids = set() | ||
|
r35940 | localstore = repo.svfs.lfslocalblobstore | ||
|
r37780 | for rev in revs: | ||
ctx = repo[rev] | ||||
for f in ctx.walk(match): | ||||
p = pointerfromctx(ctx, f) | ||||
if p and p.oid() not in oids and not localstore.has(p.oid()): | ||||
p.filename = f | ||||
pointers.append(p) | ||||
oids.add(p.oid()) | ||||
|
r35940 | |||
if pointers: | ||||
|
r37536 | # Recalculating the repo store here allows 'paths.default' that is set | ||
# on the repo by a clone command to be used for the update. | ||||
blobstore.remote(repo).readbatch(pointers, localstore) | ||||
|
r35940 | |||
|
r35097 | def _canskipupload(repo): | ||
|
r38199 | # Skip if this hasn't been passed to reposetup() | ||
if not util.safehasattr(repo.svfs, 'lfsremoteblobstore'): | ||||
return True | ||||
|
r35097 | # if remotestore is a null store, upload is a no-op and can be skipped | ||
return isinstance(repo.svfs.lfsremoteblobstore, blobstore._nullremote) | ||||
def candownload(repo): | ||||
|
r38199 | # Skip if this hasn't been passed to reposetup() | ||
if not util.safehasattr(repo.svfs, 'lfsremoteblobstore'): | ||||
return False | ||||
|
r35097 | # if remotestore is a null store, downloads will lead to nothing | ||
return not isinstance(repo.svfs.lfsremoteblobstore, blobstore._nullremote) | ||||
def uploadblobsfromrevs(repo, revs): | ||||
'''upload lfs blobs introduced by revs | ||||
Note: also used by other extensions e. g. infinitepush. avoid renaming. | ||||
''' | ||||
if _canskipupload(repo): | ||||
return | ||||
pointers = extractpointers(repo, revs) | ||||
uploadblobs(repo, pointers) | ||||
def prepush(pushop): | ||||
"""Prepush hook. | ||||
Read through the revisions to push, looking for filelog entries that can be | ||||
deserialized into metadata so that we can block the push on their upload to | ||||
the remote blobstore. | ||||
""" | ||||
return uploadblobsfromrevs(pushop.repo, pushop.outgoing.missing) | ||||
|
r41078 | @eh.wrapfunction(exchange, 'push') | ||
|
r35522 | def push(orig, repo, remote, *args, **kwargs): | ||
|
r37582 | """bail on push if the extension isn't enabled on remote when needed, and | ||
update the remote store based on the destination path.""" | ||||
|
r35522 | if 'lfs' in repo.requirements: | ||
# If the remote peer is for a local repo, the requirement tests in the | ||||
# base class method enforce lfs support. Otherwise, some revisions in | ||||
# this repo use lfs, and the remote repo needs the extension loaded. | ||||
if not remote.local() and not remote.capable('lfs'): | ||||
# This is a copy of the message in exchange.push() when requirements | ||||
# are missing between local repos. | ||||
m = _("required features are not supported in the destination: %s") | ||||
raise error.Abort(m % 'lfs', | ||||
hint=_('enable the lfs extension on the server')) | ||||
|
r37582 | |||
# Repositories where this extension is disabled won't have the field. | ||||
# But if there's a requirement, then the extension must be loaded AND | ||||
# there may be blobs to push. | ||||
remotestore = repo.svfs.lfsremoteblobstore | ||||
try: | ||||
repo.svfs.lfsremoteblobstore = blobstore.remote(repo, remote.url()) | ||||
return orig(repo, remote, *args, **kwargs) | ||||
finally: | ||||
repo.svfs.lfsremoteblobstore = remotestore | ||||
else: | ||||
return orig(repo, remote, *args, **kwargs) | ||||
|
r35522 | |||
|
r41078 | # when writing a bundle via "hg bundle" command, upload related LFS blobs | ||
@eh.wrapfunction(bundle2, 'writenewbundle') | ||||
|
r35097 | def writenewbundle(orig, ui, repo, source, filename, bundletype, outgoing, | ||
*args, **kwargs): | ||||
"""upload LFS blobs added by outgoing revisions on 'hg bundle'""" | ||||
uploadblobsfromrevs(repo, outgoing.missing) | ||||
return orig(ui, repo, source, filename, bundletype, outgoing, *args, | ||||
**kwargs) | ||||
def extractpointers(repo, revs): | ||||
"""return a list of lfs pointers added by given revs""" | ||||
|
r35494 | repo.ui.debug('lfs: computing set of blobs to upload\n') | ||
|
r35097 | pointers = {} | ||
|
r39306 | |||
|
r39426 | makeprogress = repo.ui.makeprogress | ||
with makeprogress(_('lfs search'), _('changesets'), len(revs)) as progress: | ||||
|
r39306 | for r in revs: | ||
ctx = repo[r] | ||||
for p in pointersfromctx(ctx).values(): | ||||
pointers[p.oid()] = p | ||||
progress.increment() | ||||
|
r39985 | return sorted(pointers.values(), key=lambda p: p.oid()) | ||
|
r35097 | |||
|
r36016 | def pointerfromctx(ctx, f, removed=False): | ||
|
r35939 | """return a pointer for the named file from the given changectx, or None if | ||
|
r36016 | the file isn't LFS. | ||
Optionally, the pointer for a file deleted from the context can be returned. | ||||
Since no such pointer is actually stored, and to distinguish from a non LFS | ||||
file, this pointer is represented by an empty dict. | ||||
""" | ||||
_ctx = ctx | ||||
|
r35939 | if f not in ctx: | ||
|
r36016 | if not removed: | ||
return None | ||||
if f in ctx.p1(): | ||||
_ctx = ctx.p1() | ||||
elif f in ctx.p2(): | ||||
_ctx = ctx.p2() | ||||
else: | ||||
return None | ||||
fctx = _ctx[f] | ||||
|
r35939 | if not _islfs(fctx.filelog(), fctx.filenode()): | ||
return None | ||||
try: | ||||
|
r36016 | p = pointer.deserialize(fctx.rawdata()) | ||
if ctx == _ctx: | ||||
return p | ||||
return {} | ||||
|
r35939 | except pointer.InvalidPointer as ex: | ||
raise error.Abort(_('lfs: corrupted pointer (%s@%s): %s\n') | ||||
|
r36016 | % (f, short(_ctx.node()), ex)) | ||
|
r35939 | |||
|
r36016 | def pointersfromctx(ctx, removed=False): | ||
"""return a dict {path: pointer} for given single changectx. | ||||
If ``removed`` == True and the LFS file was removed from ``ctx``, the value | ||||
stored for the path is an empty dict. | ||||
""" | ||||
|
r35097 | result = {} | ||
|
r40422 | m = ctx.repo().narrowmatch() | ||
# TODO: consider manifest.fastread() instead | ||||
|
r35097 | for f in ctx.files(): | ||
|
r40422 | if not m(f): | ||
continue | ||||
|
r36016 | p = pointerfromctx(ctx, f, removed=removed) | ||
if p is not None: | ||||
|
r35939 | result[f] = p | ||
|
r35097 | return result | ||
def uploadblobs(repo, pointers): | ||||
"""upload given pointers from local blobstore""" | ||||
if not pointers: | ||||
return | ||||
remoteblob = repo.svfs.lfsremoteblobstore | ||||
remoteblob.writebatch(pointers, repo.svfs.lfslocalblobstore) | ||||
|
r35347 | |||
|
r41078 | @eh.wrapfunction(upgrade, '_finishdatamigration') | ||
|
r35364 | def upgradefinishdatamigration(orig, ui, srcrepo, dstrepo, requirements): | ||
orig(ui, srcrepo, dstrepo, requirements) | ||||
|
r38199 | # Skip if this hasn't been passed to reposetup() | ||
if (util.safehasattr(srcrepo.svfs, 'lfslocalblobstore') and | ||||
util.safehasattr(dstrepo.svfs, 'lfslocalblobstore')): | ||||
srclfsvfs = srcrepo.svfs.lfslocalblobstore.vfs | ||||
dstlfsvfs = dstrepo.svfs.lfslocalblobstore.vfs | ||||
|
r35364 | |||
|
r38199 | for dirpath, dirs, files in srclfsvfs.walk(): | ||
for oid in files: | ||||
ui.write(_('copying lfs blob %s\n') % oid) | ||||
lfutil.link(srclfsvfs.join(oid), dstlfsvfs.join(oid)) | ||||
|
r35364 | |||
|
r41078 | @eh.wrapfunction(upgrade, 'preservedrequirements') | ||
@eh.wrapfunction(upgrade, 'supporteddestrequirements') | ||||
|
r35347 | def upgraderequirements(orig, repo): | ||
reqs = orig(repo) | ||||
if 'lfs' in repo.requirements: | ||||
reqs.add('lfs') | ||||
return reqs | ||||