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.trace import (
43
from bzrlib.plugins.git import (
46
from bzrlib.plugins.git.config import (
49
from bzrlib.plugins.git.errors import (
53
from bzrlib.plugins.git.refs import (
60
from bzrlib.foreign import ForeignBranch
63
class GitPullResult(branch.PullResult):
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.mapping.revision_id_bzr_to_foreign(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 get_rich_root_format()
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.
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,
261
class LocalGitBranch(GitBranch):
262
"""A local Git branch."""
264
def __init__(self, bzrdir, repository, name, lockfiles, tagsdict=None):
265
super(LocalGitBranch, self).__init__(bzrdir, repository, name,
267
if not name in repository._git.get_refs().keys():
268
raise errors.NotBranchError(self.base)
270
def create_checkout(self, to_location, revision_id=None, lightweight=False,
271
accelerator_tree=None, hardlink=False):
273
t = transport.get_transport(to_location)
275
format = self._get_checkout_format()
276
checkout = format.initialize_on_transport(t)
277
from_branch = branch.BranchReferenceFormat().initialize(checkout,
279
tree = checkout.create_workingtree(revision_id,
280
from_branch=from_branch, hardlink=hardlink)
283
return self._create_heavyweight_checkout(to_location, revision_id,
286
def _create_heavyweight_checkout(self, to_location, revision_id=None,
288
"""Create a new heavyweight checkout of this branch.
290
:param to_location: URL of location to create the new checkout in.
291
:param revision_id: Revision that should be the tip of the checkout.
292
:param hardlink: Whether to hardlink
293
:return: WorkingTree object of checkout.
295
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
296
to_location, force_new_tree=False, format=get_rich_root_format())
297
checkout = checkout_branch.bzrdir
298
checkout_branch.bind(self)
299
# pull up to the specified revision_id to set the initial
300
# branch tip correctly, and seed it with history.
301
checkout_branch.pull(self, stop_revision=revision_id)
302
return checkout.create_workingtree(revision_id, hardlink=hardlink)
304
def _gen_revision_history(self):
305
if self.head is None:
307
ret = list(self.repository.iter_reverse_revision_history(
308
self.last_revision()))
314
return self.repository._git.ref(self.ref)
318
def set_last_revision_info(self, revno, revid):
319
self.set_last_revision(revid)
321
def set_last_revision(self, revid):
322
(newhead, self.mapping) = self.repository.lookup_bzr_revision_id(revid)
325
def _set_head(self, value):
327
self.repository._git.refs[self.ref] = self._head
328
self._clear_cached_state()
330
head = property(_get_head, _set_head)
332
def get_config(self):
333
return GitBranchConfig(self)
335
def get_push_location(self):
336
"""See Branch.get_push_location."""
337
push_loc = self.get_config().get_user_option('push_location')
340
def set_push_location(self, location):
341
"""See Branch.set_push_location."""
342
self.get_config().set_user_option('push_location', location,
343
store=config.STORE_LOCATION)
345
def supports_tags(self):
349
class GitBranchPullResult(branch.PullResult):
352
super(GitBranchPullResult, self).__init__()
353
self.new_git_head = None
354
self._old_revno = None
355
self._new_revno = None
357
def report(self, to_file):
359
if self.old_revid == self.new_revid:
360
to_file.write('No revisions to pull.\n')
361
elif self.new_git_head is not None:
362
to_file.write('Now on revision %d (git sha: %s).\n' %
363
(self.new_revno, self.new_git_head))
365
to_file.write('Now on revision %d.\n' % (self.new_revno,))
366
self._show_tag_conficts(to_file)
368
def _lookup_revno(self, revid):
369
assert isinstance(revid, str), "was %r" % revid
370
# Try in source branch first, it'll be faster
372
return self.source_branch.revision_id_to_revno(revid)
373
except errors.NoSuchRevision:
374
# FIXME: Check using graph.find_distance_to_null() ?
375
return self.target_branch.revision_id_to_revno(revid)
377
def _get_old_revno(self):
378
if self._old_revno is not None:
379
return self._old_revno
380
return self._lookup_revno(self.old_revid)
382
def _set_old_revno(self, revno):
383
self._old_revno = revno
385
old_revno = property(_get_old_revno, _set_old_revno)
387
def _get_new_revno(self):
388
if self._new_revno is not None:
389
return self._new_revno
390
return self._lookup_revno(self.new_revid)
392
def _set_new_revno(self, revno):
393
self._new_revno = revno
395
new_revno = property(_get_new_revno, _set_new_revno)
398
class GitBranchPushResult(branch.BranchPushResult):
400
def _lookup_revno(self, revid):
401
assert isinstance(revid, str), "was %r" % revid
402
# Try in source branch first, it'll be faster
404
return self.source_branch.revision_id_to_revno(revid)
405
except errors.NoSuchRevision:
406
# FIXME: Check using graph.find_distance_to_null() ?
407
return self.target_branch.revision_id_to_revno(revid)
411
return self._lookup_revno(self.old_revid)
415
return self._lookup_revno(self.new_revid)
418
class InterFromGitBranch(branch.GenericInterBranch):
419
"""InterBranch implementation that pulls from Git into bzr."""
422
def _get_interrepo(self, source, target):
423
return repository.InterRepository.get(source.repository,
427
def is_compatible(cls, source, target):
428
return (isinstance(source, GitBranch) and
429
not isinstance(target, GitBranch) and
430
(getattr(cls._get_interrepo(source, target), "fetch_objects", None) is not None))
432
def _update_revisions(self, stop_revision=None, overwrite=False,
433
graph=None, limit=None):
434
"""Like InterBranch.update_revisions(), but with additions.
436
Compared to the `update_revisions()` below, this function takes a
437
`limit` argument that limits how many git commits will be converted
438
and returns the new git head.
440
interrepo = self._get_interrepo(self.source, self.target)
441
def determine_wants(heads):
442
if not self.source.ref in heads:
443
raise NoSuchRef(self.source.ref, heads.keys())
444
if stop_revision is not None:
445
self._last_revid = stop_revision
446
head, mapping = self.source.repository.lookup_bzr_revision_id(
449
head = heads[self.source.ref]
450
self._last_revid = self.source.lookup_foreign_revision_id(head)
451
if self.target.repository.has_revision(self._last_revid):
454
pack_hint, head = interrepo.fetch_objects(
455
determine_wants, self.source.mapping, limit=limit)
456
if (pack_hint is not None and
457
self.target.repository._format.pack_compresses):
458
self.target.repository.pack(hint=pack_hint)
460
self._last_revid = self.source.lookup_foreign_revision_id(head)
462
prev_last_revid = None
464
prev_last_revid = self.target.last_revision()
465
self.target.generate_revision_history(self._last_revid,
469
def update_revisions(self, stop_revision=None, overwrite=False,
471
"""See InterBranch.update_revisions()."""
472
self._update_revisions(stop_revision, overwrite, graph)
474
def pull(self, overwrite=False, stop_revision=None,
475
possible_transports=None, _hook_master=None, run_hooks=True,
476
_override_hook_target=None, local=False, limit=None):
479
:param _hook_master: Private parameter - set the branch to
480
be supplied as the master to pull hooks.
481
:param run_hooks: Private parameter - if false, this branch
482
is being called because it's the master of the primary branch,
483
so it should not run its hooks.
484
:param _override_hook_target: Private parameter - set the branch to be
485
supplied as the target_branch to pull hooks.
486
:param limit: Only import this many revisons. `None`, the default,
487
means import all revisions.
489
# This type of branch can't be bound.
491
raise errors.LocalRequiresBoundBranch()
492
result = GitBranchPullResult()
493
result.source_branch = self.source
494
if _override_hook_target is None:
495
result.target_branch = self.target
497
result.target_branch = _override_hook_target
498
self.source.lock_read()
500
# We assume that during 'pull' the target repository is closer than
502
graph = self.target.repository.get_graph(self.source.repository)
503
(result.old_revno, result.old_revid) = \
504
self.target.last_revision_info()
505
result.new_git_head = self._update_revisions(
506
stop_revision, overwrite=overwrite, graph=graph, limit=limit)
507
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
509
(result.new_revno, result.new_revid) = \
510
self.target.last_revision_info()
512
result.master_branch = _hook_master
513
result.local_branch = result.target_branch
515
result.master_branch = result.target_branch
516
result.local_branch = None
518
for hook in branch.Branch.hooks['post_pull']:
524
def _basic_push(self, overwrite=False, stop_revision=None):
525
result = branch.BranchPushResult()
526
result.source_branch = self.source
527
result.target_branch = self.target
528
graph = self.target.repository.get_graph(self.source.repository)
529
result.old_revno, result.old_revid = self.target.last_revision_info()
530
result.new_git_head = self._update_revisions(
531
stop_revision, overwrite=overwrite, graph=graph)
532
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
534
result.new_revno, result.new_revid = self.target.last_revision_info()
538
class InterGitBranch(branch.GenericInterBranch):
539
"""InterBranch implementation that pulls between Git branches."""
542
class InterGitLocalRemoteBranch(InterGitBranch):
543
"""InterBranch that copies from a local to a remote git branch."""
546
def is_compatible(self, source, target):
547
from bzrlib.plugins.git.remote import RemoteGitBranch
548
return (isinstance(source, LocalGitBranch) and
549
isinstance(target, RemoteGitBranch))
551
def _basic_push(self, overwrite=False, stop_revision=None):
552
from dulwich.protocol import ZERO_SHA
553
result = GitBranchPushResult()
554
result.source_branch = self.source
555
result.target_branch = self.target
556
if stop_revision is None:
557
stop_revision = self.source.last_revision()
558
# FIXME: Check for diverged branches
559
def get_changed_refs(old_refs):
560
result.old_revid = self.target.lookup_foreign_revision_id(old_refs.get(self.target.ref, ZERO_SHA))
561
refs = { self.target.ref: self.source.repository.lookup_bzr_revision_id(stop_revision)[0] }
562
result.new_revid = stop_revision
563
for name, sha in self.source.repository._git.refs.as_dict("refs/tags").iteritems():
564
refs[tag_name_to_ref(name)] = sha
566
self.target.repository.send_pack(get_changed_refs,
567
self.source.repository._git.object_store.generate_pack_contents)
571
class InterGitRemoteLocalBranch(InterGitBranch):
572
"""InterBranch that copies from a remote to a local git branch."""
575
def is_compatible(self, source, target):
576
from bzrlib.plugins.git.remote import RemoteGitBranch
577
return (isinstance(source, RemoteGitBranch) and
578
isinstance(target, LocalGitBranch))
580
def _basic_push(self, overwrite=False, stop_revision=None):
581
result = branch.BranchPushResult()
582
result.source_branch = self.source
583
result.target_branch = self.target
584
result.old_revid = self.target.last_revision()
585
refs, stop_revision = self.update_refs(stop_revision)
586
self.target.generate_revision_history(stop_revision, result.old_revid)
587
self.update_tags(refs)
588
result.new_revid = self.target.last_revision()
591
def update_tags(self, refs):
592
for name, v in extract_tags(refs).iteritems():
593
revid = self.target.lookup_foreign_revision_id(v)
594
self.target.tags.set_tag(name, revid)
596
def update_refs(self, stop_revision=None):
597
interrepo = repository.InterRepository.get(self.source.repository,
598
self.target.repository)
599
if stop_revision is None:
600
refs = interrepo.fetch_refs(branches=["HEAD"])
601
stop_revision = self.target.lookup_foreign_revision_id(refs["HEAD"])
603
refs = interrepo.fetch_refs(revision_id=stop_revision)
604
return refs, stop_revision
606
def pull(self, stop_revision=None, overwrite=False,
607
possible_transports=None, run_hooks=True,local=False):
608
# This type of branch can't be bound.
610
raise errors.LocalRequiresBoundBranch()
611
result = GitPullResult()
612
result.source_branch = self.source
613
result.target_branch = self.target
614
result.old_revid = self.target.last_revision()
615
refs, stop_revision = self.update_refs(stop_revision)
616
self.target.generate_revision_history(stop_revision, result.old_revid)
617
self.update_tags(refs)
618
result.new_revid = self.target.last_revision()
622
class InterToGitBranch(branch.InterBranch):
623
"""InterBranch implementation that pulls from Git into bzr."""
626
def _get_branch_formats_to_test():
630
def is_compatible(self, source, target):
631
return (not isinstance(source, GitBranch) and
632
isinstance(target, GitBranch))
634
def update_revisions(self, *args, **kwargs):
635
raise NoPushSupport()
637
def _get_new_refs(self, stop_revision=None):
638
if stop_revision is None:
639
stop_revision = self.source.last_revision()
640
main_ref = self.target.ref or "refs/heads/master"
641
refs = { main_ref: stop_revision }
642
for name, revid in self.source.tags.get_tag_dict().iteritems():
643
if self.source.repository.has_revision(revid):
644
refs[tag_name_to_ref(name)] = revid
645
return refs, main_ref
647
def pull(self, overwrite=False, stop_revision=None, local=False,
648
possible_transports=None):
649
from dulwich.protocol import ZERO_SHA
650
result = GitBranchPullResult()
651
result.source_branch = self.source
652
result.target_branch = self.target
653
# FIXME: Check for diverged branches
654
old_refs = self.target.repository._git.get_refs()
655
refs = dict(old_refs)
656
new_refs, main_ref = self._get_new_refs(stop_revision)
657
refs.update(new_refs)
658
self.target.repository.fetch_refs(self.source.repository, refs)
659
result.old_revid = self.target.lookup_foreign_revision_id(
660
old_refs.get(main_ref, ZERO_SHA))
661
result.new_revid = refs[main_ref]
664
def push(self, overwrite=False, stop_revision=None,
665
_override_hook_source_branch=None):
666
from dulwich.protocol import ZERO_SHA
667
result = GitBranchPushResult()
668
result.source_branch = self.source
669
result.target_branch = self.target
670
# FIXME: Check for diverged branches
671
old_refs = self.target.repository._git.get_refs()
672
refs = dict(old_refs)
673
new_refs, main_ref = self._get_new_refs(stop_revision)
674
refs.update(new_refs)
675
self.target.repository.fetch_refs(self.source.repository, refs)
676
result.old_revid = self.target.lookup_foreign_revision_id(
677
old_refs.get(main_ref, ZERO_SHA))
678
result.new_revid = refs[main_ref]
681
def lossy_push(self, stop_revision=None):
682
from dulwich.protocol import ZERO_SHA
683
result = GitBranchPushResult()
684
result.source_branch = self.source
685
result.target_branch = self.target
686
# FIXME: Check for diverged branches
687
refs, main_ref = self._get_new_refs(stop_revision)
688
result.revidmap, old_refs, new_refs = self.target.repository.dfetch_refs(
689
self.source.repository, refs)
690
result.old_revid = self.target.lookup_foreign_revision_id(
691
old_refs.get(self.target.ref, ZERO_SHA))
692
result.new_revid = self.target.lookup_foreign_revision_id(
697
branch.InterBranch.register_optimiser(InterGitRemoteLocalBranch)
698
branch.InterBranch.register_optimiser(InterFromGitBranch)
699
branch.InterBranch.register_optimiser(InterToGitBranch)
700
branch.InterBranch.register_optimiser(InterGitLocalRemoteBranch)