1
# Copyright (C) 2007 Canonical Ltd
2
# Copyright (C) 2009 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 (
54
from bzrlib.foreign import ForeignBranch
57
def extract_tags(refs):
59
for k,v in refs.iteritems():
60
if k.startswith("refs/tags/") and not k.endswith("^{}"):
61
v = refs.get(k+"^{}", v)
62
ret[k[len("refs/tags/"):]] = v
66
class GitPullResult(branch.PullResult):
68
def _lookup_revno(self, revid):
69
assert isinstance(revid, str), "was %r" % revid
70
# Try in source branch first, it'll be faster
71
return self.target_branch.revision_id_to_revno(revid)
75
return self._lookup_revno(self.old_revid)
79
return self._lookup_revno(self.new_revid)
82
class LocalGitTagDict(tag.BasicTags):
83
"""Dictionary with tags in a local repository."""
85
def __init__(self, branch):
87
self.repository = branch.repository
89
def get_tag_dict(self):
91
for k,v in extract_tags(self.repository._git.get_refs()).iteritems():
93
obj = self.repository._git[v]
95
mutter("Tag %s points at unknown object %s, ignoring", v, obj)
97
while isinstance(obj, Tag):
99
obj = self.repository._git[v]
100
if not isinstance(obj, Commit):
101
mutter("Tag %s points at object %r that is not a commit, "
104
ret[k] = self.branch.mapping.revision_id_foreign_to_bzr(v)
107
def _set_tag_dict(self, to_dict):
108
extra = set(self.repository._git.get_refs().keys())
109
for k, revid in to_dict.iteritems():
110
name = "refs/tags/%s" % k
113
self.set_tag(k, revid)
115
if name.startswith("refs/tags/"):
116
del self.repository._git[name]
118
def set_tag(self, name, revid):
119
self.repository._git.refs["refs/tags/%s" % name], _ = \
120
self.branch.mapping.revision_id_bzr_to_foreign(revid)
123
class DictTagDict(LocalGitTagDict):
126
def __init__(self, branch, tags):
127
super(DictTagDict, self).__init__(branch)
130
def get_tag_dict(self):
135
class GitBranchFormat(branch.BranchFormat):
137
def get_format_description(self):
140
def network_name(self):
143
def supports_tags(self):
146
def get_foreign_tests_branch_factory(self):
147
from bzrlib.plugins.git.tests.test_branch import ForeignTestsBranchFactory
148
return ForeignTestsBranchFactory()
150
def make_tags(self, branch):
151
if getattr(branch.repository, "get_refs", None) is not None:
152
from bzrlib.plugins.git.remote import RemoteGitTagDict
153
return RemoteGitTagDict(branch)
155
return LocalGitTagDict(branch)
158
class GitBranch(ForeignBranch):
159
"""An adapter to git repositories for bzr Branch objects."""
161
def __init__(self, bzrdir, repository, name, lockfiles, tagsdict=None):
162
self.repository = repository
163
self._format = GitBranchFormat()
164
self.control_files = lockfiles
166
super(GitBranch, self).__init__(repository.get_mapping())
167
if tagsdict is not None:
168
self.tags = DictTagDict(self, tagsdict)
171
self.base = bzrdir.root_transport.base
173
def _get_checkout_format(self):
174
"""Return the most suitable metadir for a checkout of this branch.
175
Weaves are used if this branch's repository uses weaves.
177
return get_rich_root_format()
179
def get_child_submit_format(self):
180
"""Return the preferred format of submissions to this branch."""
181
ret = self.get_config().get_user_option("child_submit_format")
186
def _get_nick(self, local=False, possible_master_transports=None):
187
"""Find the nick name for this branch.
193
def _set_nick(self, nick):
194
raise NotImplementedError
196
nick = property(_get_nick, _set_nick)
199
return "%s(%r, %r)" % (self.__class__.__name__, self.repository.base, self.name)
201
def generate_revision_history(self, revid, old_revid=None):
202
# FIXME: Check that old_revid is in the ancestry of revid
203
newhead, self.mapping = self.mapping.revision_id_bzr_to_foreign(revid)
204
self._set_head(newhead)
206
def lock_write(self):
207
self.control_files.lock_write()
209
def get_stacked_on_url(self):
210
# Git doesn't do stacking (yet...)
211
raise errors.UnstackableBranchFormat(self._format, self.base)
213
def get_parent(self):
214
"""See Branch.get_parent()."""
215
# FIXME: Set "origin" url from .git/config ?
218
def set_parent(self, url):
219
# FIXME: Set "origin" url in .git/config ?
223
self.control_files.lock_read()
226
return self.control_files.is_locked()
229
self.control_files.unlock()
231
def get_physical_lock_status(self):
235
def last_revision(self):
236
# perhaps should escape this ?
237
if self.head is None:
238
return revision.NULL_REVISION
239
return self.mapping.revision_id_foreign_to_bzr(self.head)
241
def _basic_push(self, target, overwrite=False, stop_revision=None):
242
return branch.InterBranch.get(self, target)._basic_push(
243
overwrite, stop_revision)
246
class LocalGitBranch(GitBranch):
247
"""A local Git branch."""
249
def create_checkout(self, to_location, revision_id=None, lightweight=False,
250
accelerator_tree=None, hardlink=False):
252
t = transport.get_transport(to_location)
254
format = self._get_checkout_format()
255
checkout = format.initialize_on_transport(t)
256
from_branch = branch.BranchReferenceFormat().initialize(checkout,
258
tree = checkout.create_workingtree(revision_id,
259
from_branch=from_branch, hardlink=hardlink)
262
return self._create_heavyweight_checkout(to_location, revision_id,
265
def _create_heavyweight_checkout(self, to_location, revision_id=None,
267
"""Create a new heavyweight checkout of this branch.
269
:param to_location: URL of location to create the new checkout in.
270
:param revision_id: Revision that should be the tip of the checkout.
271
:param hardlink: Whether to hardlink
272
:return: WorkingTree object of checkout.
274
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
275
to_location, force_new_tree=False, format=get_rich_root_format())
276
checkout = checkout_branch.bzrdir
277
checkout_branch.bind(self)
278
# pull up to the specified revision_id to set the initial
279
# branch tip correctly, and seed it with history.
280
checkout_branch.pull(self, stop_revision=revision_id)
281
return checkout.create_workingtree(revision_id, hardlink=hardlink)
283
def _gen_revision_history(self):
284
if self.head is None:
286
ret = list(self.repository.iter_reverse_revision_history(
287
self.last_revision()))
293
return self.repository._git.ref(self.name)
297
def set_last_revision_info(self, revno, revid):
298
self.set_last_revision(revid)
300
def set_last_revision(self, revid):
301
(newhead, self.mapping) = self.mapping.revision_id_bzr_to_foreign(
305
def _set_head(self, value):
307
self.repository._git.refs[self.name] = self._head
308
self._clear_cached_state()
310
head = property(_get_head, _set_head)
312
def get_config(self):
313
return GitBranchConfig(self)
315
def get_push_location(self):
316
"""See Branch.get_push_location."""
317
push_loc = self.get_config().get_user_option('push_location')
320
def set_push_location(self, location):
321
"""See Branch.set_push_location."""
322
self.get_config().set_user_option('push_location', location,
323
store=config.STORE_LOCATION)
325
def supports_tags(self):
329
class GitBranchPullResult(branch.PullResult):
331
def report(self, to_file):
333
if self.old_revid == self.new_revid:
334
to_file.write('No revisions to pull.\n')
336
to_file.write('Now on revision %d (git sha: %s).\n' %
337
(self.new_revno, self.new_git_head))
338
self._show_tag_conficts(to_file)
341
class GitBranchPushResult(branch.BranchPushResult):
343
def _lookup_revno(self, revid):
344
assert isinstance(revid, str), "was %r" % revid
345
# Try in source branch first, it'll be faster
347
return self.source_branch.revision_id_to_revno(revid)
348
except errors.NoSuchRevision:
349
# FIXME: Check using graph.find_distance_to_null() ?
350
return self.target_branch.revision_id_to_revno(revid)
354
return self._lookup_revno(self.old_revid)
358
return self._lookup_revno(self.new_revid)
361
class InterFromGitBranch(branch.GenericInterBranch):
362
"""InterBranch implementation that pulls from Git into bzr."""
365
def _get_interrepo(self, source, target):
366
return repository.InterRepository.get(source.repository,
370
def is_compatible(cls, source, target):
371
return (isinstance(source, GitBranch) and
372
not isinstance(target, GitBranch) and
373
(getattr(cls._get_interrepo(source, target), "fetch_objects", None) is not None))
375
def update_revisions(self, stop_revision=None, overwrite=False,
377
"""See InterBranch.update_revisions()."""
378
interrepo = self._get_interrepo(self.source, self.target)
380
self._last_revid = None
381
def determine_wants(heads):
382
if not self.source.name in heads:
383
raise NoSuchRef(self.source.name, heads.keys())
384
if stop_revision is not None:
385
self._last_revid = stop_revision
386
self._head, mapping = self.source.repository.lookup_bzr_revision_id(
389
self._head = heads[self.source.name]
391
self.source.mapping.revision_id_foreign_to_bzr(self._head)
392
if self.target.repository.has_revision(self._last_revid):
395
interrepo.fetch_objects(determine_wants, self.source.mapping)
397
prev_last_revid = None
399
prev_last_revid = self.target.last_revision()
400
self.target.generate_revision_history(self._last_revid, prev_last_revid)
402
def pull(self, overwrite=False, stop_revision=None,
403
possible_transports=None, _hook_master=None, run_hooks=True,
404
_override_hook_target=None, local=False):
407
:param _hook_master: Private parameter - set the branch to
408
be supplied as the master to pull hooks.
409
:param run_hooks: Private parameter - if false, this branch
410
is being called because it's the master of the primary branch,
411
so it should not run its hooks.
412
:param _override_hook_target: Private parameter - set the branch to be
413
supplied as the target_branch to pull hooks.
415
# This type of branch can't be bound.
417
raise errors.LocalRequiresBoundBranch()
418
result = GitBranchPullResult()
419
result.source_branch = self.source
420
if _override_hook_target is None:
421
result.target_branch = self.target
423
result.target_branch = _override_hook_target
424
self.source.lock_read()
426
# We assume that during 'pull' the target repository is closer than
428
graph = self.target.repository.get_graph(self.source.repository)
429
result.old_revno, result.old_revid = \
430
self.target.last_revision_info()
431
self.update_revisions(stop_revision, overwrite=overwrite,
433
result.new_git_head = self._head
434
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
436
result.new_revno, result.new_revid = self.target.last_revision_info()
438
result.master_branch = _hook_master
439
result.local_branch = result.target_branch
441
result.master_branch = result.target_branch
442
result.local_branch = None
444
for hook in branch.Branch.hooks['post_pull']:
450
def _basic_push(self, overwrite=False, stop_revision=None):
451
result = branch.BranchPushResult()
452
result.source_branch = self.source
453
result.target_branch = self.target
454
graph = self.target.repository.get_graph(self.source.repository)
455
result.old_revno, result.old_revid = self.target.last_revision_info()
456
self.update_revisions(stop_revision, overwrite=overwrite, graph=graph)
457
result.new_git_head = self._head
458
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
460
result.new_revno, result.new_revid = self.target.last_revision_info()
464
class InterGitBranch(branch.GenericInterBranch):
465
"""InterBranch implementation that pulls between Git branches."""
468
class InterGitLocalRemoteBranch(InterGitBranch):
469
"""InterBranch that copies from a local to a remote git branch."""
472
def is_compatible(self, source, target):
473
from bzrlib.plugins.git.remote import RemoteGitBranch
474
return (isinstance(source, LocalGitBranch) and
475
isinstance(target, RemoteGitBranch))
477
def _basic_push(self, overwrite=False, stop_revision=None):
478
result = GitBranchPushResult()
479
result.source_branch = self.source
480
result.target_branch = self.target
481
if stop_revision is None:
482
stop_revision = self.source.last_revision()
483
# FIXME: Check for diverged branches
484
def get_changed_refs(old_refs):
485
result.old_revid = self.target.mapping.revision_id_foreign_to_bzr(old_refs.get("refs/heads/master", "0" * 40))
486
refs = { "refs/heads/master": self.source.repository.lookup_bzr_revision_id(stop_revision)[0] }
487
result.new_revid = stop_revision
488
for name, sha in self.source.repository._git.refs.as_dict("refs/tags").iteritems():
489
refs["refs/tags/%s" % name] = sha
491
self.target.repository.send_pack(get_changed_refs,
492
self.source.repository._git.object_store.generate_pack_contents)
496
class InterGitRemoteLocalBranch(InterGitBranch):
497
"""InterBranch that copies from a remote to a local git branch."""
500
def is_compatible(self, source, target):
501
from bzrlib.plugins.git.remote import RemoteGitBranch
502
return (isinstance(source, RemoteGitBranch) and
503
isinstance(target, LocalGitBranch))
505
def _basic_push(self, overwrite=False, stop_revision=None):
506
result = branch.BranchPushResult()
507
result.source_branch = self.source
508
result.target_branch = self.target
509
result.old_revid = self.target.last_revision()
510
refs, stop_revision = self.update_refs(stop_revision)
511
self.target.generate_revision_history(stop_revision, result.old_revid)
512
self.update_tags(refs)
513
result.new_revid = self.target.last_revision()
516
def update_tags(self, refs):
517
for name, v in extract_tags(refs).iteritems():
518
revid = self.target.mapping.revision_id_foreign_to_bzr(v)
519
self.target.tags.set_tag(name, revid)
521
def update_refs(self, stop_revision=None):
522
interrepo = repository.InterRepository.get(self.source.repository,
523
self.target.repository)
524
if stop_revision is None:
525
refs = interrepo.fetch_refs(branches=["HEAD"])
526
stop_revision = self.target.mapping.revision_id_foreign_to_bzr(refs["HEAD"])
528
refs = interrepo.fetch_refs(revision_id=stop_revision)
529
return refs, stop_revision
531
def pull(self, stop_revision=None, overwrite=False,
532
possible_transports=None, local=False):
533
# This type of branch can't be bound.
535
raise errors.LocalRequiresBoundBranch()
536
result = GitPullResult()
537
result.source_branch = self.source
538
result.target_branch = self.target
539
result.old_revid = self.target.last_revision()
540
refs, stop_revision = self.update_refs(stop_revision)
541
self.target.generate_revision_history(stop_revision, result.old_revid)
542
self.update_tags(refs)
543
result.new_revid = self.target.last_revision()
547
class InterToGitBranch(branch.InterBranch):
548
"""InterBranch implementation that pulls from Git into bzr."""
551
def _get_branch_formats_to_test():
555
def is_compatible(self, source, target):
556
return (not isinstance(source, GitBranch) and
557
isinstance(target, GitBranch))
559
def update_revisions(self, *args, **kwargs):
560
raise NoPushSupport()
562
def push(self, overwrite=True, stop_revision=None,
563
_override_hook_source_branch=None):
564
raise NoPushSupport()
566
def lossy_push(self, stop_revision=None):
567
result = GitBranchPushResult()
568
result.source_branch = self.source
569
result.target_branch = self.target
571
result.old_revid = self.target.last_revision()
573
result.old_revid = revision.NULL_REVISION
574
if stop_revision is None:
575
stop_revision = self.source.last_revision()
576
# FIXME: Check for diverged branches
577
refs = { "refs/heads/master": stop_revision }
578
for name, revid in self.source.tags.get_tag_dict().iteritems():
579
if self.source.repository.has_revision(revid):
580
refs["refs/tags/%s" % name] = revid
581
revidmap, new_refs = self.target.repository.dfetch_refs(
582
self.source.repository, refs)
584
self.target.generate_revision_history(revidmap[stop_revision])
585
result.new_revid = revidmap[stop_revision]
587
result.new_revid = result.old_revid
588
result.revidmap = revidmap
592
branch.InterBranch.register_optimiser(InterGitRemoteLocalBranch)
593
branch.InterBranch.register_optimiser(InterFromGitBranch)
594
branch.InterBranch.register_optimiser(InterToGitBranch)
595
branch.InterBranch.register_optimiser(InterGitLocalRemoteBranch)