1
# Copyright (C) 2007 Canonical Ltd
2
# Copyright (C) 2009-2010 Jelmer Vernooij <jelmer@samba.org>
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
"""An adapter between a Git Branch and a Bazaar Branch"""
20
from dulwich.objects import (
35
from bzrlib.decorators import (
38
from bzrlib.revision import (
41
from bzrlib.trace import (
46
from bzrlib.plugins.git.config import (
49
from bzrlib.plugins.git.errors import (
53
from bzrlib.plugins.git.refs import (
59
from bzrlib.foreign import ForeignBranch
62
class GitPullResult(branch.PullResult):
63
"""Result of a pull from a Git branch."""
65
def _lookup_revno(self, revid):
66
assert isinstance(revid, str), "was %r" % revid
67
# Try in source branch first, it'll be faster
68
return self.target_branch.revision_id_to_revno(revid)
72
return self._lookup_revno(self.old_revid)
76
return self._lookup_revno(self.new_revid)
79
class LocalGitTagDict(tag.BasicTags):
80
"""Dictionary with tags in a local repository."""
82
def __init__(self, branch):
84
self.repository = branch.repository
86
def get_tag_dict(self):
88
for k,v in extract_tags(self.repository._git.get_refs()).iteritems():
90
obj = self.repository._git[v]
92
mutter("Tag %s points at unknown object %s, ignoring", v, obj)
94
while isinstance(obj, Tag):
96
obj = self.repository._git[v]
97
if not isinstance(obj, Commit):
98
mutter("Tag %s points at object %r that is not a commit, "
101
ret[k] = self.branch.lookup_foreign_revision_id(v)
104
def _set_tag_dict(self, to_dict):
105
extra = set(self.repository._git.get_refs().keys())
106
for k, revid in to_dict.iteritems():
107
name = tag_name_to_ref(k)
110
self.set_tag(k, revid)
112
if name.startswith("refs/tags/"):
113
del self.repository._git[name]
115
def set_tag(self, name, revid):
116
self.repository._git.refs[tag_name_to_ref(name)], _ = \
117
self.branch.lookup_bzr_revision_id(revid)
120
class DictTagDict(LocalGitTagDict):
122
def __init__(self, branch, tags):
123
super(DictTagDict, self).__init__(branch)
126
def get_tag_dict(self):
130
class GitBranchFormat(branch.BranchFormat):
132
def get_format_description(self):
135
def network_name(self):
138
def supports_tags(self):
141
def get_foreign_tests_branch_factory(self):
142
from bzrlib.plugins.git.tests.test_branch import ForeignTestsBranchFactory
143
return ForeignTestsBranchFactory()
145
def make_tags(self, branch):
146
if getattr(branch.repository, "get_refs", None) is not None:
147
from bzrlib.plugins.git.remote import RemoteGitTagDict
148
return RemoteGitTagDict(branch)
150
return LocalGitTagDict(branch)
153
class GitReadLock(object):
155
def __init__(self, unlock):
159
class GitWriteLock(object):
161
def __init__(self, unlock):
165
class GitBranch(ForeignBranch):
166
"""An adapter to git repositories for bzr Branch objects."""
168
def __init__(self, bzrdir, repository, ref, lockfiles, tagsdict=None):
169
self.repository = repository
170
self._format = GitBranchFormat()
171
self.control_files = lockfiles
173
super(GitBranch, self).__init__(repository.get_mapping())
174
if tagsdict is not None:
175
self.tags = DictTagDict(self, tagsdict)
177
self.name = ref_to_branch_name(ref)
179
self.base = bzrdir.root_transport.base
181
def _get_checkout_format(self):
182
"""Return the most suitable metadir for a checkout of this branch.
183
Weaves are used if this branch's repository uses weaves.
185
return bzrdir.format_registry.make_bzrdir("default")
187
def get_child_submit_format(self):
188
"""Return the preferred format of submissions to this branch."""
189
ret = self.get_config().get_user_option("child_submit_format")
194
def _get_nick(self, local=False, possible_master_transports=None):
195
"""Find the nick name for this branch.
199
return self.name or "HEAD"
201
def _set_nick(self, nick):
202
raise NotImplementedError
204
nick = property(_get_nick, _set_nick)
207
return "<%s(%r, %r)>" % (self.__class__.__name__, self.repository.base,
210
def generate_revision_history(self, revid, old_revid=None):
211
# FIXME: Check that old_revid is in the ancestry of revid
212
newhead, self.mapping = self.mapping.revision_id_bzr_to_foreign(revid)
213
self._set_head(newhead)
215
def lock_write(self):
216
self.control_files.lock_write()
217
return GitWriteLock(self.unlock)
219
def get_stacked_on_url(self):
220
# Git doesn't do stacking (yet...)
221
raise errors.UnstackableBranchFormat(self._format, self.base)
223
def get_parent(self):
224
"""See Branch.get_parent()."""
225
# FIXME: Set "origin" url from .git/config ?
228
def set_parent(self, url):
229
# FIXME: Set "origin" url in .git/config ?
233
self.control_files.lock_read()
234
return GitReadLock(self.unlock)
237
return self.control_files.is_locked()
240
self.control_files.unlock()
242
def get_physical_lock_status(self):
246
def last_revision(self):
247
# perhaps should escape this ?
248
if self.head is None:
249
return revision.NULL_REVISION
250
return self.lookup_foreign_revision_id(self.head)
252
def _basic_push(self, target, overwrite=False, stop_revision=None):
253
return branch.InterBranch.get(self, target)._basic_push(
254
overwrite, stop_revision)
256
def lookup_foreign_revision_id(self, foreign_revid):
257
return self.repository.lookup_foreign_revision_id(foreign_revid,
260
def lookup_bzr_revision_id(self, revid):
261
return self.repository.lookup_bzr_revision_id(
262
revid, mapping=self.mapping)
265
class LocalGitBranch(GitBranch):
266
"""A local Git branch."""
268
def __init__(self, bzrdir, repository, name, lockfiles, tagsdict=None):
269
super(LocalGitBranch, self).__init__(bzrdir, repository, name,
271
refs = repository._git.get_refs()
272
if not (name in refs.keys() or "HEAD" in refs.keys()):
273
raise errors.NotBranchError(self.base)
275
def create_checkout(self, to_location, revision_id=None, lightweight=False,
276
accelerator_tree=None, hardlink=False):
278
t = transport.get_transport(to_location)
280
format = self._get_checkout_format()
281
checkout = format.initialize_on_transport(t)
282
from_branch = branch.BranchReferenceFormat().initialize(checkout,
284
tree = checkout.create_workingtree(revision_id,
285
from_branch=from_branch, hardlink=hardlink)
288
return self._create_heavyweight_checkout(to_location, revision_id,
291
def _create_heavyweight_checkout(self, to_location, revision_id=None,
293
"""Create a new heavyweight checkout of this branch.
295
:param to_location: URL of location to create the new checkout in.
296
:param revision_id: Revision that should be the tip of the checkout.
297
:param hardlink: Whether to hardlink
298
:return: WorkingTree object of checkout.
300
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
301
to_location, force_new_tree=False)
302
checkout = checkout_branch.bzrdir
303
checkout_branch.bind(self)
304
# pull up to the specified revision_id to set the initial
305
# branch tip correctly, and seed it with history.
306
checkout_branch.pull(self, stop_revision=revision_id)
307
return checkout.create_workingtree(revision_id, hardlink=hardlink)
309
def _gen_revision_history(self):
310
if self.head is None:
312
ret = list(self.repository.iter_reverse_revision_history(
313
self.last_revision()))
319
return self.repository._git.ref(self.ref or "HEAD")
323
def set_last_revision_info(self, revno, revid):
324
self.set_last_revision(revid)
326
def set_last_revision(self, revid):
327
(newhead, self.mapping) = self.repository.lookup_bzr_revision_id(revid)
330
def _set_head(self, value):
332
self.repository._git.refs[self.ref or "HEAD"] = self._head
333
self._clear_cached_state()
335
head = property(_get_head, _set_head)
337
def get_config(self):
338
return GitBranchConfig(self)
340
def get_push_location(self):
341
"""See Branch.get_push_location."""
342
push_loc = self.get_config().get_user_option('push_location')
345
def set_push_location(self, location):
346
"""See Branch.set_push_location."""
347
self.get_config().set_user_option('push_location', location,
348
store=config.STORE_LOCATION)
350
def supports_tags(self):
354
class GitBranchPullResult(branch.PullResult):
357
super(GitBranchPullResult, self).__init__()
358
self.new_git_head = None
359
self._old_revno = None
360
self._new_revno = None
362
def report(self, to_file):
364
if self.old_revid == self.new_revid:
365
to_file.write('No revisions to pull.\n')
366
elif self.new_git_head is not None:
367
to_file.write('Now on revision %d (git sha: %s).\n' %
368
(self.new_revno, self.new_git_head))
370
to_file.write('Now on revision %d.\n' % (self.new_revno,))
371
self._show_tag_conficts(to_file)
373
def _lookup_revno(self, revid):
374
assert isinstance(revid, str), "was %r" % revid
375
# Try in source branch first, it'll be faster
377
return self.source_branch.revision_id_to_revno(revid)
378
except errors.NoSuchRevision:
379
# FIXME: Check using graph.find_distance_to_null() ?
380
return self.target_branch.revision_id_to_revno(revid)
382
def _get_old_revno(self):
383
if self._old_revno is not None:
384
return self._old_revno
385
return self._lookup_revno(self.old_revid)
387
def _set_old_revno(self, revno):
388
self._old_revno = revno
390
old_revno = property(_get_old_revno, _set_old_revno)
392
def _get_new_revno(self):
393
if self._new_revno is not None:
394
return self._new_revno
395
return self._lookup_revno(self.new_revid)
397
def _set_new_revno(self, revno):
398
self._new_revno = revno
400
new_revno = property(_get_new_revno, _set_new_revno)
403
class GitBranchPushResult(branch.BranchPushResult):
405
def _lookup_revno(self, revid):
406
assert isinstance(revid, str), "was %r" % revid
407
# Try in source branch first, it'll be faster
409
return self.source_branch.revision_id_to_revno(revid)
410
except errors.NoSuchRevision:
411
# FIXME: Check using graph.find_distance_to_null() ?
412
return self.target_branch.revision_id_to_revno(revid)
416
return self._lookup_revno(self.old_revid)
420
return self._lookup_revno(self.new_revid)
423
class InterFromGitBranch(branch.GenericInterBranch):
424
"""InterBranch implementation that pulls from Git into bzr."""
427
def _get_branch_formats_to_test():
431
def _get_interrepo(self, source, target):
432
return repository.InterRepository.get(source.repository,
436
def is_compatible(cls, source, target):
437
return (isinstance(source, GitBranch) and
438
not isinstance(target, GitBranch) and
439
(getattr(cls._get_interrepo(source, target), "fetch_objects", None) is not None))
441
def _update_revisions(self, stop_revision=None, overwrite=False,
442
graph=None, limit=None):
443
"""Like InterBranch.update_revisions(), but with additions.
445
Compared to the `update_revisions()` below, this function takes a
446
`limit` argument that limits how many git commits will be converted
447
and returns the new git head.
449
interrepo = self._get_interrepo(self.source, self.target)
450
def determine_wants(heads):
451
if self.source.ref is not None and not self.source.ref in heads:
452
raise NoSuchRef(self.source.ref, heads.keys())
453
if stop_revision is not None:
454
self._last_revid = stop_revision
455
head, mapping = self.source.repository.lookup_bzr_revision_id(
458
if self.source.ref is not None:
459
head = heads[self.source.ref]
462
self._last_revid = self.source.lookup_foreign_revision_id(head)
463
if self.target.repository.has_revision(self._last_revid):
466
pack_hint, head, refs = interrepo.fetch_objects(
467
determine_wants, self.source.mapping, limit=limit)
468
if (pack_hint is not None and
469
self.target.repository._format.pack_compresses):
470
self.target.repository.pack(hint=pack_hint)
472
self._last_revid = self.source.lookup_foreign_revision_id(head)
474
prev_last_revid = None
476
prev_last_revid = self.target.last_revision()
477
self.target.generate_revision_history(self._last_revid,
481
def update_revisions(self, stop_revision=None, overwrite=False,
483
"""See InterBranch.update_revisions()."""
484
self._update_revisions(stop_revision, overwrite, graph)
486
def pull(self, overwrite=False, stop_revision=None,
487
possible_transports=None, _hook_master=None, run_hooks=True,
488
_override_hook_target=None, local=False, limit=None):
491
:param _hook_master: Private parameter - set the branch to
492
be supplied as the master to pull hooks.
493
:param run_hooks: Private parameter - if false, this branch
494
is being called because it's the master of the primary branch,
495
so it should not run its hooks.
496
:param _override_hook_target: Private parameter - set the branch to be
497
supplied as the target_branch to pull hooks.
498
:param limit: Only import this many revisons. `None`, the default,
499
means import all revisions.
501
# This type of branch can't be bound.
503
raise errors.LocalRequiresBoundBranch()
504
result = GitBranchPullResult()
505
result.source_branch = self.source
506
if _override_hook_target is None:
507
result.target_branch = self.target
509
result.target_branch = _override_hook_target
510
self.source.lock_read()
512
# We assume that during 'pull' the target repository is closer than
514
graph = self.target.repository.get_graph(self.source.repository)
515
(result.old_revno, result.old_revid) = \
516
self.target.last_revision_info()
517
result.new_git_head = self._update_revisions(
518
stop_revision, overwrite=overwrite, graph=graph, limit=limit)
519
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
521
(result.new_revno, result.new_revid) = \
522
self.target.last_revision_info()
524
result.master_branch = _hook_master
525
result.local_branch = result.target_branch
527
result.master_branch = result.target_branch
528
result.local_branch = None
530
for hook in branch.Branch.hooks['post_pull']:
536
def _basic_push(self, overwrite=False, stop_revision=None):
537
result = branch.BranchPushResult()
538
result.source_branch = self.source
539
result.target_branch = self.target
540
graph = self.target.repository.get_graph(self.source.repository)
541
result.old_revno, result.old_revid = self.target.last_revision_info()
542
result.new_git_head = self._update_revisions(
543
stop_revision, overwrite=overwrite, graph=graph)
544
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
546
result.new_revno, result.new_revid = self.target.last_revision_info()
550
class InterGitBranch(branch.GenericInterBranch):
551
"""InterBranch implementation that pulls between Git branches."""
554
class InterGitLocalRemoteBranch(InterGitBranch):
555
"""InterBranch that copies from a local to a remote git branch."""
558
def _get_branch_formats_to_test():
562
def is_compatible(self, source, target):
563
from bzrlib.plugins.git.remote import RemoteGitBranch
564
return (isinstance(source, LocalGitBranch) and
565
isinstance(target, RemoteGitBranch))
567
def _basic_push(self, overwrite=False, stop_revision=None):
568
from dulwich.protocol import ZERO_SHA
569
result = GitBranchPushResult()
570
result.source_branch = self.source
571
result.target_branch = self.target
572
if stop_revision is None:
573
stop_revision = self.source.last_revision()
574
# FIXME: Check for diverged branches
575
def get_changed_refs(old_refs):
576
result.old_revid = self.target.lookup_foreign_revision_id(old_refs.get(self.target.ref, ZERO_SHA))
577
refs = { self.target.ref: self.source.repository.lookup_bzr_revision_id(stop_revision)[0] }
578
result.new_revid = stop_revision
579
for name, sha in self.source.repository._git.refs.as_dict("refs/tags").iteritems():
580
refs[tag_name_to_ref(name)] = sha
582
self.target.repository.send_pack(get_changed_refs,
583
self.source.repository._git.object_store.generate_pack_contents)
587
class InterGitRemoteLocalBranch(InterGitBranch):
588
"""InterBranch that copies from a remote to a local git branch."""
591
def _get_branch_formats_to_test():
595
def is_compatible(self, source, target):
596
from bzrlib.plugins.git.remote import RemoteGitBranch
597
return (isinstance(source, RemoteGitBranch) and
598
isinstance(target, LocalGitBranch))
600
def _basic_push(self, overwrite=False, stop_revision=None):
601
result = branch.BranchPushResult()
602
result.source_branch = self.source
603
result.target_branch = self.target
604
result.old_revid = self.target.last_revision()
605
refs, stop_revision = self.update_refs(stop_revision)
606
self.target.generate_revision_history(stop_revision, result.old_revid)
607
self.update_tags(refs)
608
result.new_revid = self.target.last_revision()
611
def update_tags(self, refs):
612
for name, v in extract_tags(refs).iteritems():
613
revid = self.target.lookup_foreign_revision_id(v)
614
self.target.tags.set_tag(name, revid)
616
def update_refs(self, stop_revision=None):
617
interrepo = repository.InterRepository.get(self.source.repository,
618
self.target.repository)
619
if stop_revision is None:
620
refs = interrepo.fetch(branches=["HEAD"])
621
stop_revision = self.target.lookup_foreign_revision_id(refs["HEAD"])
623
refs = interrepo.fetch(revision_id=stop_revision)
624
return refs, stop_revision
626
def pull(self, stop_revision=None, overwrite=False,
627
possible_transports=None, run_hooks=True,local=False):
628
# This type of branch can't be bound.
630
raise errors.LocalRequiresBoundBranch()
631
result = GitPullResult()
632
result.source_branch = self.source
633
result.target_branch = self.target
634
result.old_revid = self.target.last_revision()
635
refs, stop_revision = self.update_refs(stop_revision)
636
self.target.generate_revision_history(stop_revision, result.old_revid)
637
self.update_tags(refs)
638
result.new_revid = self.target.last_revision()
642
class InterToGitBranch(branch.GenericInterBranch):
643
"""InterBranch implementation that pulls from Git into bzr."""
645
def __init__(self, source, target):
646
super(InterToGitBranch, self).__init__(source, target)
647
self.interrepo = repository.InterRepository.get(source.repository,
651
def _get_branch_formats_to_test():
655
def is_compatible(self, source, target):
656
return (not isinstance(source, GitBranch) and
657
isinstance(target, GitBranch))
659
def update_revisions(self, *args, **kwargs):
660
raise NoPushSupport()
662
def _get_new_refs(self, stop_revision=None):
663
if stop_revision is None:
664
stop_revision = self.source.last_revision()
665
assert type(stop_revision) is str
666
main_ref = self.target.ref or "refs/heads/master"
667
refs = { main_ref: (None, stop_revision) }
668
for name, revid in self.source.tags.get_tag_dict().iteritems():
669
if self.source.repository.has_revision(revid):
670
refs[tag_name_to_ref(name)] = (None, revid)
671
return refs, main_ref
673
def pull(self, overwrite=False, stop_revision=None, local=False,
674
possible_transports=None):
675
from dulwich.protocol import ZERO_SHA
676
result = GitBranchPullResult()
677
result.source_branch = self.source
678
result.target_branch = self.target
679
new_refs, main_ref = self._get_new_refs(stop_revision)
680
def update_refs(old_refs):
681
refs = dict(old_refs)
682
# FIXME: Check for diverged branches
683
refs.update(new_refs)
685
old_refs, new_refs = self.interrepo.fetch_refs(update_refs)
686
result.old_revid = self.target.lookup_foreign_revision_id(
687
old_refs.get(main_ref, ZERO_SHA))
688
result.new_revid = new_refs[main_ref]
691
def push(self, overwrite=False, stop_revision=None,
692
_override_hook_source_branch=None):
693
from dulwich.protocol import ZERO_SHA
694
result = GitBranchPushResult()
695
result.source_branch = self.source
696
result.target_branch = self.target
697
new_refs, main_ref = self._get_new_refs(stop_revision)
698
def update_refs(old_refs):
699
refs = dict(old_refs)
700
# FIXME: Check for diverged branches
701
refs.update(new_refs)
703
old_refs, new_refs = self.interrepo.fetch_refs(update_refs)
704
(result.old_revid, old_sha1) = old_refs.get(main_ref, (ZERO_SHA, NULL_REVISION))
705
if result.old_revid is None:
706
result.old_revid = self.target.lookup_foreign_revision_id(old_sha1)
707
result.new_revid = new_refs[main_ref]
710
def lossy_push(self, stop_revision=None):
711
result = GitBranchPushResult()
712
result.source_branch = self.source
713
result.target_branch = self.target
714
new_refs, main_ref = self._get_new_refs(stop_revision)
715
def update_refs(old_refs):
716
refs = dict(old_refs)
717
# FIXME: Check for diverged branches
718
refs.update(new_refs)
720
result.revidmap, old_refs, new_refs = self.interrepo.dfetch_refs(
722
result.old_revid = old_refs.get(self.target.ref, (None, NULL_REVISION))[1]
723
result.new_revid = new_refs[main_ref][1]
727
branch.InterBranch.register_optimiser(InterGitRemoteLocalBranch)
728
branch.InterBranch.register_optimiser(InterFromGitBranch)
729
branch.InterBranch.register_optimiser(InterToGitBranch)
730
branch.InterBranch.register_optimiser(InterGitLocalRemoteBranch)
added
removed
branch.py
