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 (
59
from bzrlib.foreign import ForeignBranch
62
class GitPullResult(branch.PullResult):
64
def _lookup_revno(self, revid):
65
assert isinstance(revid, str), "was %r" % revid
66
# Try in source branch first, it'll be faster
67
return self.target_branch.revision_id_to_revno(revid)
71
return self._lookup_revno(self.old_revid)
75
return self._lookup_revno(self.new_revid)
78
class LocalGitTagDict(tag.BasicTags):
79
"""Dictionary with tags in a local repository."""
81
def __init__(self, branch):
83
self.repository = branch.repository
85
def get_tag_dict(self):
87
for k,v in extract_tags(self.repository._git.get_refs()).iteritems():
89
obj = self.repository._git[v]
91
mutter("Tag %s points at unknown object %s, ignoring", v, obj)
93
while isinstance(obj, Tag):
95
obj = self.repository._git[v]
96
if not isinstance(obj, Commit):
97
mutter("Tag %s points at object %r that is not a commit, "
100
ret[k] = self.branch.mapping.revision_id_foreign_to_bzr(v)
103
def _set_tag_dict(self, to_dict):
104
extra = set(self.repository._git.get_refs().keys())
105
for k, revid in to_dict.iteritems():
106
name = tag_name_to_ref(k)
109
self.set_tag(k, revid)
111
if name.startswith("refs/tags/"):
112
del self.repository._git[name]
114
def set_tag(self, name, revid):
115
self.repository._git.refs[tag_name_to_ref(name)], _ = \
116
self.branch.mapping.revision_id_bzr_to_foreign(revid)
119
class DictTagDict(LocalGitTagDict):
121
def __init__(self, branch, tags):
122
super(DictTagDict, self).__init__(branch)
125
def get_tag_dict(self):
129
class GitBranchFormat(branch.BranchFormat):
131
def get_format_description(self):
134
def network_name(self):
137
def supports_tags(self):
140
def get_foreign_tests_branch_factory(self):
141
from bzrlib.plugins.git.tests.test_branch import ForeignTestsBranchFactory
142
return ForeignTestsBranchFactory()
144
def make_tags(self, branch):
145
if getattr(branch.repository, "get_refs", None) is not None:
146
from bzrlib.plugins.git.remote import RemoteGitTagDict
147
return RemoteGitTagDict(branch)
149
return LocalGitTagDict(branch)
152
class GitReadLock(object):
154
def __init__(self, unlock):
158
class GitWriteLock(object):
160
def __init__(self, unlock):
164
class GitBranch(ForeignBranch):
165
"""An adapter to git repositories for bzr Branch objects."""
167
def __init__(self, bzrdir, repository, ref, lockfiles, tagsdict=None):
168
self.repository = repository
169
self._format = GitBranchFormat()
170
self.control_files = lockfiles
172
super(GitBranch, self).__init__(repository.get_mapping())
173
if tagsdict is not None:
174
self.tags = DictTagDict(self, tagsdict)
176
self.name = ref_to_branch_name(ref)
178
self.base = bzrdir.root_transport.base
180
def _get_checkout_format(self):
181
"""Return the most suitable metadir for a checkout of this branch.
182
Weaves are used if this branch's repository uses weaves.
184
return get_rich_root_format()
186
def get_child_submit_format(self):
187
"""Return the preferred format of submissions to this branch."""
188
ret = self.get_config().get_user_option("child_submit_format")
193
def _get_nick(self, local=False, possible_master_transports=None):
194
"""Find the nick name for this branch.
200
def _set_nick(self, nick):
201
raise NotImplementedError
203
nick = property(_get_nick, _set_nick)
206
return "<%s(%r, %r)>" % (self.__class__.__name__, self.repository.base,
209
def generate_revision_history(self, revid, old_revid=None):
210
# FIXME: Check that old_revid is in the ancestry of revid
211
newhead, self.mapping = self.mapping.revision_id_bzr_to_foreign(revid)
212
self._set_head(newhead)
214
def lock_write(self):
215
self.control_files.lock_write()
216
return GitWriteLock(self.unlock)
218
def get_stacked_on_url(self):
219
# Git doesn't do stacking (yet...)
220
raise errors.UnstackableBranchFormat(self._format, self.base)
222
def get_parent(self):
223
"""See Branch.get_parent()."""
224
# FIXME: Set "origin" url from .git/config ?
227
def set_parent(self, url):
228
# FIXME: Set "origin" url in .git/config ?
232
self.control_files.lock_read()
233
return GitReadLock(self.unlock)
236
return self.control_files.is_locked()
239
self.control_files.unlock()
241
def get_physical_lock_status(self):
245
def last_revision(self):
246
# perhaps should escape this ?
247
if self.head is None:
248
return revision.NULL_REVISION
249
return self.mapping.revision_id_foreign_to_bzr(self.head)
251
def _basic_push(self, target, overwrite=False, stop_revision=None):
252
return branch.InterBranch.get(self, target)._basic_push(
253
overwrite, stop_revision)
256
class LocalGitBranch(GitBranch):
257
"""A local Git branch."""
259
def __init__(self, bzrdir, repository, name, lockfiles, tagsdict=None):
260
super(LocalGitBranch, self).__init__(bzrdir, repository, name,
262
if not name in repository._git.get_refs().keys():
263
raise errors.NotBranchError(self.base)
265
def create_checkout(self, to_location, revision_id=None, lightweight=False,
266
accelerator_tree=None, hardlink=False):
268
t = transport.get_transport(to_location)
270
format = self._get_checkout_format()
271
checkout = format.initialize_on_transport(t)
272
from_branch = branch.BranchReferenceFormat().initialize(checkout,
274
tree = checkout.create_workingtree(revision_id,
275
from_branch=from_branch, hardlink=hardlink)
278
return self._create_heavyweight_checkout(to_location, revision_id,
281
def _create_heavyweight_checkout(self, to_location, revision_id=None,
283
"""Create a new heavyweight checkout of this branch.
285
:param to_location: URL of location to create the new checkout in.
286
:param revision_id: Revision that should be the tip of the checkout.
287
:param hardlink: Whether to hardlink
288
:return: WorkingTree object of checkout.
290
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
291
to_location, force_new_tree=False, format=get_rich_root_format())
292
checkout = checkout_branch.bzrdir
293
checkout_branch.bind(self)
294
# pull up to the specified revision_id to set the initial
295
# branch tip correctly, and seed it with history.
296
checkout_branch.pull(self, stop_revision=revision_id)
297
return checkout.create_workingtree(revision_id, hardlink=hardlink)
299
def _gen_revision_history(self):
300
if self.head is None:
302
ret = list(self.repository.iter_reverse_revision_history(
303
self.last_revision()))
309
return self.repository._git.ref(self.ref)
313
def set_last_revision_info(self, revno, revid):
314
self.set_last_revision(revid)
316
def set_last_revision(self, revid):
317
(newhead, self.mapping) = self.repository.lookup_bzr_revision_id(revid)
320
def _set_head(self, value):
322
self.repository._git.refs[self.ref] = self._head
323
self._clear_cached_state()
325
head = property(_get_head, _set_head)
327
def get_config(self):
328
return GitBranchConfig(self)
330
def get_push_location(self):
331
"""See Branch.get_push_location."""
332
push_loc = self.get_config().get_user_option('push_location')
335
def set_push_location(self, location):
336
"""See Branch.set_push_location."""
337
self.get_config().set_user_option('push_location', location,
338
store=config.STORE_LOCATION)
340
def supports_tags(self):
344
class GitBranchPullResult(branch.PullResult):
347
super(GitBranchPullResult, self).__init__()
348
self.new_git_head = None
349
self._old_revno = None
350
self._new_revno = None
352
def report(self, to_file):
354
if self.old_revid == self.new_revid:
355
to_file.write('No revisions to pull.\n')
356
elif self.new_git_head is not None:
357
to_file.write('Now on revision %d (git sha: %s).\n' %
358
(self.new_revno, self.new_git_head))
360
to_file.write('Now on revision %d.\n' % (self.new_revno,))
361
self._show_tag_conficts(to_file)
363
def _lookup_revno(self, revid):
364
assert isinstance(revid, str), "was %r" % revid
365
# Try in source branch first, it'll be faster
367
return self.source_branch.revision_id_to_revno(revid)
368
except errors.NoSuchRevision:
369
# FIXME: Check using graph.find_distance_to_null() ?
370
return self.target_branch.revision_id_to_revno(revid)
372
def _get_old_revno(self):
373
if self._old_revno is not None:
374
return self._old_revno
375
return self._lookup_revno(self.old_revid)
377
def _set_old_revno(self, revno):
378
self._old_revno = revno
380
old_revno = property(_get_old_revno, _set_old_revno)
382
def _get_new_revno(self):
383
if self._new_revno is not None:
384
return self._new_revno
385
return self._lookup_revno(self.new_revid)
387
def _set_new_revno(self, revno):
388
self._new_revno = revno
390
new_revno = property(_get_new_revno, _set_new_revno)
393
class GitBranchPushResult(branch.BranchPushResult):
395
def _lookup_revno(self, revid):
396
assert isinstance(revid, str), "was %r" % revid
397
# Try in source branch first, it'll be faster
399
return self.source_branch.revision_id_to_revno(revid)
400
except errors.NoSuchRevision:
401
# FIXME: Check using graph.find_distance_to_null() ?
402
return self.target_branch.revision_id_to_revno(revid)
406
return self._lookup_revno(self.old_revid)
410
return self._lookup_revno(self.new_revid)
413
class InterFromGitBranch(branch.GenericInterBranch):
414
"""InterBranch implementation that pulls from Git into bzr."""
417
def _get_interrepo(self, source, target):
418
return repository.InterRepository.get(source.repository,
422
def is_compatible(cls, source, target):
423
return (isinstance(source, GitBranch) and
424
not isinstance(target, GitBranch) and
425
(getattr(cls._get_interrepo(source, target), "fetch_objects", None) is not None))
427
def _update_revisions(self, stop_revision=None, overwrite=False,
428
graph=None, limit=None):
429
"""Like InterBranch.update_revisions(), but with additions.
431
Compared to the `update_revisions()` below, this function takes a
432
`limit` argument that limits how many git commits will be converted
433
and returns the new git head.
435
interrepo = self._get_interrepo(self.source, self.target)
436
def determine_wants(heads):
437
if not self.source.ref in heads:
438
raise NoSuchRef(self.source.ref, heads.keys())
439
if stop_revision is not None:
440
self._last_revid = stop_revision
441
head, mapping = self.source.repository.lookup_bzr_revision_id(
444
head = heads[self.source.ref]
445
self._last_revid = self.source.mapping.revision_id_foreign_to_bzr(
447
if self.target.repository.has_revision(self._last_revid):
450
pack_hint, head = interrepo.fetch_objects(
451
determine_wants, self.source.mapping, limit=limit)
452
if pack_hint is not None and self.target.repository._format.pack_compresses:
453
self.target.repository.pack(hint=pack_hint)
455
self._last_revid = self.source.mapping.revision_id_foreign_to_bzr(head)
457
prev_last_revid = None
459
prev_last_revid = self.target.last_revision()
460
self.target.generate_revision_history(self._last_revid,
464
def update_revisions(self, stop_revision=None, overwrite=False,
466
"""See InterBranch.update_revisions()."""
467
self._update_revisions(stop_revision, overwrite, graph)
469
def pull(self, overwrite=False, stop_revision=None,
470
possible_transports=None, _hook_master=None, run_hooks=True,
471
_override_hook_target=None, local=False, limit=None):
474
:param _hook_master: Private parameter - set the branch to
475
be supplied as the master to pull hooks.
476
:param run_hooks: Private parameter - if false, this branch
477
is being called because it's the master of the primary branch,
478
so it should not run its hooks.
479
:param _override_hook_target: Private parameter - set the branch to be
480
supplied as the target_branch to pull hooks.
481
:param limit: Only import this many revisons. `None`, the default,
482
means import all revisions.
484
# This type of branch can't be bound.
486
raise errors.LocalRequiresBoundBranch()
487
result = GitBranchPullResult()
488
result.source_branch = self.source
489
if _override_hook_target is None:
490
result.target_branch = self.target
492
result.target_branch = _override_hook_target
493
self.source.lock_read()
495
# We assume that during 'pull' the target repository is closer than
497
graph = self.target.repository.get_graph(self.source.repository)
498
(result.old_revno, result.old_revid) = \
499
self.target.last_revision_info()
500
result.new_git_head = self._update_revisions(
501
stop_revision, overwrite=overwrite, graph=graph, limit=limit)
502
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
504
(result.new_revno, result.new_revid) = \
505
self.target.last_revision_info()
507
result.master_branch = _hook_master
508
result.local_branch = result.target_branch
510
result.master_branch = result.target_branch
511
result.local_branch = None
513
for hook in branch.Branch.hooks['post_pull']:
519
def _basic_push(self, overwrite=False, stop_revision=None):
520
result = branch.BranchPushResult()
521
result.source_branch = self.source
522
result.target_branch = self.target
523
graph = self.target.repository.get_graph(self.source.repository)
524
result.old_revno, result.old_revid = self.target.last_revision_info()
525
result.new_git_head = self._update_revisions(
526
stop_revision, overwrite=overwrite, graph=graph)
527
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
529
result.new_revno, result.new_revid = self.target.last_revision_info()
533
class InterGitBranch(branch.GenericInterBranch):
534
"""InterBranch implementation that pulls between Git branches."""
537
class InterGitLocalRemoteBranch(InterGitBranch):
538
"""InterBranch that copies from a local to a remote git branch."""
541
def is_compatible(self, source, target):
542
from bzrlib.plugins.git.remote import RemoteGitBranch
543
return (isinstance(source, LocalGitBranch) and
544
isinstance(target, RemoteGitBranch))
546
def _basic_push(self, overwrite=False, stop_revision=None):
547
from dulwich.protocol import ZERO_SHA
548
result = GitBranchPushResult()
549
result.source_branch = self.source
550
result.target_branch = self.target
551
if stop_revision is None:
552
stop_revision = self.source.last_revision()
553
# FIXME: Check for diverged branches
554
def get_changed_refs(old_refs):
555
result.old_revid = self.target.mapping.revision_id_foreign_to_bzr(old_refs.get(self.target.ref, ZERO_SHA))
556
refs = { self.target.ref: self.source.repository.lookup_bzr_revision_id(stop_revision)[0] }
557
result.new_revid = stop_revision
558
for name, sha in self.source.repository._git.refs.as_dict("refs/tags").iteritems():
559
refs[tag_name_to_ref(name)] = sha
561
self.target.repository.send_pack(get_changed_refs,
562
self.source.repository._git.object_store.generate_pack_contents)
566
class InterGitRemoteLocalBranch(InterGitBranch):
567
"""InterBranch that copies from a remote to a local git branch."""
570
def is_compatible(self, source, target):
571
from bzrlib.plugins.git.remote import RemoteGitBranch
572
return (isinstance(source, RemoteGitBranch) and
573
isinstance(target, LocalGitBranch))
575
def _basic_push(self, overwrite=False, stop_revision=None):
576
result = branch.BranchPushResult()
577
result.source_branch = self.source
578
result.target_branch = self.target
579
result.old_revid = self.target.last_revision()
580
refs, stop_revision = self.update_refs(stop_revision)
581
self.target.generate_revision_history(stop_revision, result.old_revid)
582
self.update_tags(refs)
583
result.new_revid = self.target.last_revision()
586
def update_tags(self, refs):
587
for name, v in extract_tags(refs).iteritems():
588
revid = self.target.mapping.revision_id_foreign_to_bzr(v)
589
self.target.tags.set_tag(name, revid)
591
def update_refs(self, stop_revision=None):
592
interrepo = repository.InterRepository.get(self.source.repository,
593
self.target.repository)
594
if stop_revision is None:
595
refs = interrepo.fetch_refs(branches=["HEAD"])
596
stop_revision = self.target.mapping.revision_id_foreign_to_bzr(refs["HEAD"])
598
refs = interrepo.fetch_refs(revision_id=stop_revision)
599
return refs, stop_revision
601
def pull(self, stop_revision=None, overwrite=False,
602
possible_transports=None, run_hooks=True,local=False):
603
# This type of branch can't be bound.
605
raise errors.LocalRequiresBoundBranch()
606
result = GitPullResult()
607
result.source_branch = self.source
608
result.target_branch = self.target
609
result.old_revid = self.target.last_revision()
610
refs, stop_revision = self.update_refs(stop_revision)
611
self.target.generate_revision_history(stop_revision, result.old_revid)
612
self.update_tags(refs)
613
result.new_revid = self.target.last_revision()
617
class InterToGitBranch(branch.InterBranch):
618
"""InterBranch implementation that pulls from Git into bzr."""
621
def _get_branch_formats_to_test():
625
def is_compatible(self, source, target):
626
return (not isinstance(source, GitBranch) and
627
isinstance(target, GitBranch))
629
def update_revisions(self, *args, **kwargs):
630
raise NoPushSupport()
632
def _get_new_refs(self, stop_revision=None):
633
if stop_revision is None:
634
stop_revision = self.source.last_revision()
635
refs = { self.target.ref: stop_revision }
636
for name, revid in self.source.tags.get_tag_dict().iteritems():
637
if self.source.repository.has_revision(revid):
638
refs[tag_name_to_ref(name)] = revid
641
def pull(self, overwrite=False, stop_revision=None, local=False,
642
possible_transports=None):
643
from dulwich.protocol import ZERO_SHA
644
result = GitBranchPullResult()
645
result.source_branch = self.source
646
result.target_branch = self.target
647
# FIXME: Check for diverged branches
648
old_refs = self.target.repository._git.get_refs()
649
refs = dict(old_refs)
650
refs.update(self._get_new_refs(stop_revision))
651
self.target.repository.fetch_refs(self.source.repository, refs)
652
result.old_revid = self.target.mapping.revision_id_foreign_to_bzr(
653
old_refs.get(self.target.ref, ZERO_SHA))
654
result.new_revid = refs[self.target.ref]
657
def push(self, overwrite=False, stop_revision=None,
658
_override_hook_source_branch=None):
659
from dulwich.protocol import ZERO_SHA
660
result = GitBranchPushResult()
661
result.source_branch = self.source
662
result.target_branch = self.target
663
# FIXME: Check for diverged branches
664
old_refs = self.target.repository._git.get_refs()
665
refs = dict(old_refs)
666
refs.update(self._get_new_refs(stop_revision))
667
self.target.repository.fetch_refs(self.source.repository, refs)
668
result.old_revid = self.target.mapping.revision_id_foreign_to_bzr(
669
old_refs.get(self.target.ref, ZERO_SHA))
670
result.new_revid = refs[self.target.ref]
673
def lossy_push(self, stop_revision=None):
674
from dulwich.protocol import ZERO_SHA
675
result = GitBranchPushResult()
676
result.source_branch = self.source
677
result.target_branch = self.target
678
# FIXME: Check for diverged branches
679
refs = self._get_new_refs(stop_revision)
680
result.revidmap, old_refs, new_refs = self.target.repository.dfetch_refs(
681
self.source.repository, refs)
682
result.old_revid = self.target.mapping.revision_id_foreign_to_bzr(
683
old_refs.get(self.target.ref, ZERO_SHA))
684
result.new_revid = self.target.mapping.revision_id_foreign_to_bzr(
685
new_refs[self.target.ref])
689
branch.InterBranch.register_optimiser(InterGitRemoteLocalBranch)
690
branch.InterBranch.register_optimiser(InterFromGitBranch)
691
branch.InterBranch.register_optimiser(InterToGitBranch)
692
branch.InterBranch.register_optimiser(InterGitLocalRemoteBranch)