/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to branch.py

Add NEWS entry about hg-git support.

Show diffs side-by-side

added added

removed removed

Lines of Context:
branch.py
 
1
# Copyright (C) 2007 Canonical Ltd
 
2
# Copyright (C) 2009 Jelmer Vernooij <jelmer@samba.org>
 
3
#
 
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.
 
8
#
 
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.
 
13
#
 
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
 
17
 
 
18
"""An adapter between a Git Branch and a Bazaar Branch"""
 
19
 
 
20
from dulwich.objects import (
 
21
    Commit,
 
22
    Tag,
 
23
    )
 
24
 
 
25
from bzrlib import (
 
26
    branch,
 
27
    bzrdir,
 
28
    config,
 
29
    errors,
 
30
    repository,
 
31
    revision,
 
32
    tag,
 
33
    transport,
 
34
    )
 
35
from bzrlib.decorators import (
 
36
    needs_read_lock,
 
37
    )
 
38
from bzrlib.trace import (
 
39
    is_quiet,
 
40
    mutter,
 
41
    )
 
42
 
 
43
from bzrlib.plugins.git import (
 
44
    get_rich_root_format,
 
45
    )
 
46
from bzrlib.plugins.git.config import (
 
47
    GitBranchConfig,
 
48
    )
 
49
from bzrlib.plugins.git.errors import (
 
50
    NoPushSupport,
 
51
    NoSuchRef,
 
52
    )
 
53
 
 
54
from bzrlib.foreign import ForeignBranch
 
55
 
 
56
 
 
57
def extract_tags(refs, mapping):
 
58
    ret = {}
 
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/"):]] = mapping.revision_id_foreign_to_bzr(v)
 
63
    return ret
 
64
 
 
65
 
 
66
class GitPullResult(branch.PullResult):
 
67
 
 
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)
 
72
 
 
73
    @property
 
74
    def old_revno(self):
 
75
        return self._lookup_revno(self.old_revid)
 
76
 
 
77
    @property
 
78
    def new_revno(self):
 
79
        return self._lookup_revno(self.new_revid)
 
80
 
 
81
 
 
82
class LocalGitTagDict(tag.BasicTags):
 
83
    """Dictionary with tags in a local repository."""
 
84
 
 
85
    def __init__(self, branch):
 
86
        self.branch = branch
 
87
        self.repository = branch.repository
 
88
 
 
89
    def get_tag_dict(self):
 
90
        ret = {}
 
91
        for k,v in self.repository._git.refs.as_dict("refs/tags").iteritems():
 
92
            try:
 
93
                obj = self.repository._git.get_object(v)
 
94
            except KeyError:
 
95
                mutter("Tag %s points at unknown object %s, ignoring", v, obj)
 
96
                continue
 
97
            while isinstance(obj, Tag):
 
98
                v = obj.object[1]
 
99
                obj = self.repository._git.get_object(v)
 
100
            if not isinstance(obj, Commit):
 
101
                mutter("Tag %s points at object %r that is not a commit, "
 
102
                       "ignoring", k, obj)
 
103
                continue
 
104
            ret[k] = self.branch.mapping.revision_id_foreign_to_bzr(v)
 
105
        return ret
 
106
 
 
107
    def set_tag(self, name, revid):
 
108
        self.repository._git.refs["refs/tags/%s" % name], _ = \
 
109
            self.branch.mapping.revision_id_bzr_to_foreign(revid)
 
110
 
 
111
 
 
112
class DictTagDict(LocalGitTagDict):
 
113
 
 
114
 
 
115
    def __init__(self, branch, tags):
 
116
        super(DictTagDict, self).__init__(branch)
 
117
        self._tags = tags
 
118
 
 
119
    def get_tag_dict(self):
 
120
        return self._tags
 
121
 
 
122
 
 
123
 
 
124
class GitBranchFormat(branch.BranchFormat):
 
125
 
 
126
    def get_format_description(self):
 
127
        return 'Git Branch'
 
128
 
 
129
    def supports_tags(self):
 
130
        return True
 
131
 
 
132
    def make_tags(self, branch):
 
133
        if getattr(branch.repository, "get_refs", None) is not None:
 
134
            from bzrlib.plugins.git.remote import RemoteGitTagDict
 
135
            return RemoteGitTagDict(branch)
 
136
        else:
 
137
            return LocalGitTagDict(branch)
 
138
 
 
139
 
 
140
class GitBranch(ForeignBranch):
 
141
    """An adapter to git repositories for bzr Branch objects."""
 
142
 
 
143
    def __init__(self, bzrdir, repository, name, lockfiles, tagsdict=None):
 
144
        self.repository = repository
 
145
        self._format = GitBranchFormat()
 
146
        self.control_files = lockfiles
 
147
        self.bzrdir = bzrdir
 
148
        super(GitBranch, self).__init__(repository.get_mapping())
 
149
        if tagsdict is not None:
 
150
            self.tags = DictTagDict(self, tagsdict)
 
151
        self.name = name
 
152
        self._head = None
 
153
        self.base = bzrdir.root_transport.base
 
154
 
 
155
    def _get_checkout_format(self):
 
156
        """Return the most suitable metadir for a checkout of this branch.
 
157
        Weaves are used if this branch's repository uses weaves.
 
158
        """
 
159
        return get_rich_root_format()
 
160
 
 
161
    def get_child_submit_format(self):
 
162
        """Return the preferred format of submissions to this branch."""
 
163
        ret = self.get_config().get_user_option("child_submit_format")
 
164
        if ret is not None:
 
165
            return ret
 
166
        return "git"
 
167
 
 
168
    def _get_nick(self, local=False, possible_master_transports=None):
 
169
        """Find the nick name for this branch.
 
170
 
 
171
        :return: Branch nick
 
172
        """
 
173
        return self.name
 
174
 
 
175
    def _set_nick(self, nick):
 
176
        raise NotImplementedError
 
177
 
 
178
    nick = property(_get_nick, _set_nick)
 
179
 
 
180
    def __repr__(self):
 
181
        return "%s(%r, %r)" % (self.__class__.__name__, self.repository.base, self.name)
 
182
 
 
183
    def generate_revision_history(self, revid, old_revid=None):
 
184
        # FIXME: Check that old_revid is in the ancestry of revid
 
185
        newhead, self.mapping = self.mapping.revision_id_bzr_to_foreign(revid)
 
186
        self._set_head(newhead)
 
187
 
 
188
    def lock_write(self):
 
189
        self.control_files.lock_write()
 
190
 
 
191
    def get_stacked_on_url(self):
 
192
        # Git doesn't do stacking (yet...)
 
193
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
194
 
 
195
    def get_parent(self):
 
196
        """See Branch.get_parent()."""
 
197
        # FIXME: Set "origin" url from .git/config ?
 
198
        return None
 
199
 
 
200
    def set_parent(self, url):
 
201
        # FIXME: Set "origin" url in .git/config ?
 
202
        pass
 
203
 
 
204
    def lock_read(self):
 
205
        self.control_files.lock_read()
 
206
 
 
207
    def is_locked(self):
 
208
        return self.control_files.is_locked()
 
209
 
 
210
    def unlock(self):
 
211
        self.control_files.unlock()
 
212
 
 
213
    def get_physical_lock_status(self):
 
214
        return False
 
215
 
 
216
    @needs_read_lock
 
217
    def last_revision(self):
 
218
        # perhaps should escape this ?
 
219
        if self.head is None:
 
220
            return revision.NULL_REVISION
 
221
        return self.mapping.revision_id_foreign_to_bzr(self.head)
 
222
 
 
223
    def _basic_push(self, target, overwrite=False, stop_revision=None):
 
224
        return branch.InterBranch.get(self, target)._basic_push(
 
225
            overwrite, stop_revision)
 
226
 
 
227
 
 
228
class LocalGitBranch(GitBranch):
 
229
    """A local Git branch."""
 
230
 
 
231
    def create_checkout(self, to_location, revision_id=None, lightweight=False,
 
232
        accelerator_tree=None, hardlink=False):
 
233
        if lightweight:
 
234
            t = transport.get_transport(to_location)
 
235
            t.ensure_base()
 
236
            format = self._get_checkout_format()
 
237
            checkout = format.initialize_on_transport(t)
 
238
            from_branch = branch.BranchReferenceFormat().initialize(checkout, 
 
239
                self)
 
240
            tree = checkout.create_workingtree(revision_id,
 
241
                from_branch=from_branch, hardlink=hardlink)
 
242
            return tree
 
243
        else:
 
244
            return self._create_heavyweight_checkout(to_location, revision_id,
 
245
            hardlink)
 
246
 
 
247
    def _create_heavyweight_checkout(self, to_location, revision_id=None, 
 
248
                                     hardlink=False):
 
249
        """Create a new heavyweight checkout of this branch.
 
250
 
 
251
        :param to_location: URL of location to create the new checkout in.
 
252
        :param revision_id: Revision that should be the tip of the checkout.
 
253
        :param hardlink: Whether to hardlink
 
254
        :return: WorkingTree object of checkout.
 
255
        """
 
256
        checkout_branch = bzrdir.BzrDir.create_branch_convenience(
 
257
            to_location, force_new_tree=False, format=get_rich_root_format())
 
258
        checkout = checkout_branch.bzrdir
 
259
        checkout_branch.bind(self)
 
260
        # pull up to the specified revision_id to set the initial 
 
261
        # branch tip correctly, and seed it with history.
 
262
        checkout_branch.pull(self, stop_revision=revision_id)
 
263
        return checkout.create_workingtree(revision_id, hardlink=hardlink)
 
264
 
 
265
    def _gen_revision_history(self):
 
266
        if self.head is None:
 
267
            return []
 
268
        ret = list(self.repository.iter_reverse_revision_history(
 
269
            self.last_revision()))
 
270
        ret.reverse()
 
271
        return ret
 
272
 
 
273
    def _get_head(self):
 
274
        try:
 
275
            return self.repository._git.ref(self.name)
 
276
        except KeyError:
 
277
            return None
 
278
 
 
279
    def set_last_revision_info(self, revno, revid):
 
280
        self.set_last_revision(revid)
 
281
 
 
282
    def set_last_revision(self, revid):
 
283
        (newhead, self.mapping) = self.mapping.revision_id_bzr_to_foreign(
 
284
                revid)
 
285
        self.head = newhead
 
286
 
 
287
    def _set_head(self, value):
 
288
        self._head = value
 
289
        self.repository._git.refs[self.name] = self._head
 
290
        self._clear_cached_state()
 
291
 
 
292
    head = property(_get_head, _set_head)
 
293
 
 
294
    def get_config(self):
 
295
        return GitBranchConfig(self)
 
296
 
 
297
    def get_push_location(self):
 
298
        """See Branch.get_push_location."""
 
299
        push_loc = self.get_config().get_user_option('push_location')
 
300
        return push_loc
 
301
 
 
302
    def set_push_location(self, location):
 
303
        """See Branch.set_push_location."""
 
304
        self.get_config().set_user_option('push_location', location,
 
305
                                          store=config.STORE_LOCATION)
 
306
 
 
307
    def supports_tags(self):
 
308
        return True
 
309
 
 
310
 
 
311
class GitBranchPullResult(branch.PullResult):
 
312
 
 
313
    def report(self, to_file):
 
314
        if not is_quiet():
 
315
            if self.old_revid == self.new_revid:
 
316
                to_file.write('No revisions to pull.\n')
 
317
            else:
 
318
                to_file.write('Now on revision %d (git sha: %s).\n' % 
 
319
                        (self.new_revno, self.new_git_head))
 
320
        self._show_tag_conficts(to_file)
 
321
 
 
322
 
 
323
class GitBranchPushResult(branch.BranchPushResult):
 
324
 
 
325
    def _lookup_revno(self, revid):
 
326
        assert isinstance(revid, str), "was %r" % revid
 
327
        # Try in source branch first, it'll be faster
 
328
        try:
 
329
            return self.source_branch.revision_id_to_revno(revid)
 
330
        except errors.NoSuchRevision:
 
331
            # FIXME: Check using graph.find_distance_to_null() ?
 
332
            return self.target_branch.revision_id_to_revno(revid)
 
333
 
 
334
    @property
 
335
    def old_revno(self):
 
336
        return self._lookup_revno(self.old_revid)
 
337
 
 
338
    @property
 
339
    def new_revno(self):
 
340
        return self._lookup_revno(self.new_revid)
 
341
 
 
342
 
 
343
class InterFromGitBranch(branch.GenericInterBranch):
 
344
    """InterBranch implementation that pulls from Git into bzr."""
 
345
 
 
346
    @classmethod
 
347
    def is_compatible(self, source, target):
 
348
        return (isinstance(source, GitBranch) and 
 
349
                not isinstance(target, GitBranch))
 
350
 
 
351
    def update_revisions(self, stop_revision=None, overwrite=False,
 
352
        graph=None):
 
353
        """See InterBranch.update_revisions()."""
 
354
        interrepo = repository.InterRepository.get(self.source.repository, 
 
355
            self.target.repository)
 
356
        self._head = None
 
357
        self._last_revid = None
 
358
        def determine_wants(heads):
 
359
            if not self.source.name in heads:
 
360
                raise NoSuchRef(self.source.name, heads.keys())
 
361
            if stop_revision is not None:
 
362
                self._last_revid = stop_revision
 
363
                self._head, mapping = self.source.repository.lookup_git_revid(
 
364
                    stop_revision)
 
365
            else:
 
366
                self._head = heads[self.source.name]
 
367
                self._last_revid = \
 
368
                    self.source.mapping.revision_id_foreign_to_bzr(self._head)
 
369
            if self.target.repository.has_revision(self._last_revid):
 
370
                return []
 
371
            return [self._head]
 
372
        interrepo.fetch_objects(determine_wants, self.source.mapping)
 
373
        if overwrite:
 
374
            prev_last_revid = None
 
375
        else:
 
376
            prev_last_revid = self.target.last_revision()
 
377
        self.target.generate_revision_history(self._last_revid, prev_last_revid)
 
378
 
 
379
    def pull(self, overwrite=False, stop_revision=None,
 
380
             possible_transports=None, _hook_master=None, run_hooks=True,
 
381
             _override_hook_target=None, local=False):
 
382
        """See Branch.pull.
 
383
 
 
384
        :param _hook_master: Private parameter - set the branch to
 
385
            be supplied as the master to pull hooks.
 
386
        :param run_hooks: Private parameter - if false, this branch
 
387
            is being called because it's the master of the primary branch,
 
388
            so it should not run its hooks.
 
389
        :param _override_hook_target: Private parameter - set the branch to be
 
390
            supplied as the target_branch to pull hooks.
 
391
        """
 
392
        # This type of branch can't be bound.
 
393
        if local:
 
394
            raise errors.LocalRequiresBoundBranch()
 
395
        result = GitBranchPullResult()
 
396
        result.source_branch = self.source
 
397
        if _override_hook_target is None:
 
398
            result.target_branch = self.target
 
399
        else:
 
400
            result.target_branch = _override_hook_target
 
401
        self.source.lock_read()
 
402
        try:
 
403
            # We assume that during 'pull' the target repository is closer than
 
404
            # the source one.
 
405
            graph = self.target.repository.get_graph(self.source.repository)
 
406
            result.old_revno, result.old_revid = \
 
407
                self.target.last_revision_info()
 
408
            self.update_revisions(stop_revision, overwrite=overwrite, 
 
409
                graph=graph)
 
410
            result.new_git_head = self._head
 
411
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
412
                overwrite)
 
413
            result.new_revno, result.new_revid = self.target.last_revision_info()
 
414
            if _hook_master:
 
415
                result.master_branch = _hook_master
 
416
                result.local_branch = result.target_branch
 
417
            else:
 
418
                result.master_branch = result.target_branch
 
419
                result.local_branch = None
 
420
            if run_hooks:
 
421
                for hook in branch.Branch.hooks['post_pull']:
 
422
                    hook(result)
 
423
        finally:
 
424
            self.source.unlock()
 
425
        return result
 
426
 
 
427
    def _basic_push(self, overwrite=False, stop_revision=None):
 
428
        result = branch.BranchPushResult()
 
429
        result.source_branch = self.source
 
430
        result.target_branch = self.target
 
431
        graph = self.target.repository.get_graph(self.source.repository)
 
432
        result.old_revno, result.old_revid = self.target.last_revision_info()
 
433
        self.update_revisions(stop_revision, overwrite=overwrite, 
 
434
            graph=graph)
 
435
        result.new_git_head = self._head
 
436
        result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
437
            overwrite)
 
438
        result.new_revno, result.new_revid = self.target.last_revision_info()
 
439
        return result
 
440
 
 
441
 
 
442
class InterGitBranch(branch.GenericInterBranch):
 
443
    """InterBranch implementation that pulls between Git branches."""
 
444
 
 
445
 
 
446
class InterGitLocalRemoteBranch(InterGitBranch):
 
447
    """InterBranch that copies from a local to a remote git branch."""
 
448
 
 
449
    @classmethod
 
450
    def is_compatible(self, source, target):
 
451
        from bzrlib.plugins.git.remote import RemoteGitBranch
 
452
        return (isinstance(source, LocalGitBranch) and 
 
453
                isinstance(target, RemoteGitBranch))
 
454
 
 
455
    def _basic_push(self, overwrite=False, stop_revision=None):
 
456
        result = GitBranchPushResult()
 
457
        result.source_branch = self.source
 
458
        result.target_branch = self.target
 
459
        if stop_revision is None:
 
460
            stop_revision = self.source.last_revision()
 
461
        # FIXME: Check for diverged branches
 
462
        def get_changed_refs(old_refs):
 
463
            result.old_revid = self.target.mapping.revision_id_foreign_to_bzr(old_refs.get("refs/heads/master", "0" * 40))
 
464
            refs = { "refs/heads/master": self.source.repository.lookup_git_revid(stop_revision)[0] }
 
465
            result.new_revid = stop_revision
 
466
            for name, sha in self.source.repository._git.refs.as_dict("refs/tags").iteritems():
 
467
                refs["refs/tags/%s" % name] = sha
 
468
            return refs
 
469
        self.target.repository.send_pack(get_changed_refs, 
 
470
                self.source.repository._git.object_store.generate_pack_contents)
 
471
        return result
 
472
 
 
473
 
 
474
class InterGitRemoteLocalBranch(InterGitBranch):
 
475
    """InterBranch that copies from a remote to a local git branch."""
 
476
 
 
477
    @classmethod
 
478
    def is_compatible(self, source, target):
 
479
        from bzrlib.plugins.git.remote import RemoteGitBranch
 
480
        return (isinstance(source, RemoteGitBranch) and 
 
481
                isinstance(target, LocalGitBranch))
 
482
 
 
483
    def _basic_push(self, overwrite=False, stop_revision=None):
 
484
        result = branch.BranchPushResult()
 
485
        result.source_branch = self.source
 
486
        result.target_branch = self.target
 
487
        result.old_revid = self.target.last_revision()
 
488
        refs, stop_revision = self.update_refs(stop_revision)
 
489
        self.target.generate_revision_history(stop_revision, result.old_revid)
 
490
        self.update_tags(refs)
 
491
        result.new_revid = self.target.last_revision()
 
492
        return result
 
493
 
 
494
    def update_tags(self, refs):
 
495
        for name, revid in extract_tags(refs, self.target.mapping).iteritems():
 
496
            self.target.tags.set_tag(name, revid)
 
497
 
 
498
    def update_refs(self, stop_revision=None):
 
499
        interrepo = repository.InterRepository.get(self.source.repository, 
 
500
            self.target.repository)
 
501
        if stop_revision is None:
 
502
            refs = interrepo.fetch_refs(branches=["HEAD"])
 
503
            stop_revision = self.target.mapping.revision_id_foreign_to_bzr(refs["HEAD"])
 
504
        else:
 
505
            refs = interrepo.fetch_refs(revision_id=stop_revision)
 
506
        return refs, stop_revision
 
507
 
 
508
    def pull(self, stop_revision=None, overwrite=False, 
 
509
        possible_transports=None, local=False):
 
510
        # This type of branch can't be bound.
 
511
        if local:
 
512
            raise errors.LocalRequiresBoundBranch()
 
513
        result = GitPullResult()
 
514
        result.source_branch = self.source
 
515
        result.target_branch = self.target
 
516
        result.old_revid = self.target.last_revision()
 
517
        refs, stop_revision = self.update_refs(stop_revision)
 
518
        self.target.generate_revision_history(stop_revision, result.old_revid)
 
519
        self.update_tags(refs)
 
520
        result.new_revid = self.target.last_revision()
 
521
        return result
 
522
 
 
523
    
 
524
class InterToGitBranch(branch.InterBranch):
 
525
    """InterBranch implementation that pulls from Git into bzr."""
 
526
 
 
527
    @staticmethod
 
528
    def _get_branch_formats_to_test():
 
529
        return None, None
 
530
 
 
531
    @classmethod
 
532
    def is_compatible(self, source, target):
 
533
        return (not isinstance(source, GitBranch) and 
 
534
                isinstance(target, GitBranch))
 
535
 
 
536
    def update_revisions(self, *args, **kwargs):
 
537
        raise NoPushSupport()
 
538
 
 
539
    def push(self, overwrite=True, stop_revision=None, 
 
540
             _override_hook_source_branch=None):
 
541
        raise NoPushSupport()
 
542
 
 
543
    def lossy_push(self, stop_revision=None):
 
544
        result = GitBranchPushResult()
 
545
        result.source_branch = self.source
 
546
        result.target_branch = self.target
 
547
        try:
 
548
            result.old_revid = self.target.last_revision()
 
549
        except NoSuchRef:
 
550
            result.old_revid = revision.NULL_REVISION
 
551
        if stop_revision is None:
 
552
            stop_revision = self.source.last_revision()
 
553
        # FIXME: Check for diverged branches
 
554
        refs = { "refs/heads/master": stop_revision }
 
555
        for name, revid in self.source.tags.get_tag_dict().iteritems():
 
556
            if self.source.repository.has_revision(revid):
 
557
                refs["refs/tags/%s" % name] = revid
 
558
        revidmap, new_refs = self.target.repository.dfetch_refs(
 
559
            self.source.repository, refs)
 
560
        if revidmap != {}:
 
561
            self.target.generate_revision_history(revidmap[stop_revision])
 
562
            result.new_revid = revidmap[stop_revision]
 
563
        else:
 
564
            result.new_revid = result.old_revid
 
565
        result.revidmap = revidmap
 
566
        return result
 
567
 
 
568
 
 
569
branch.InterBranch.register_optimiser(InterGitRemoteLocalBranch)
 
570
branch.InterBranch.register_optimiser(InterFromGitBranch)
 
571
branch.InterBranch.register_optimiser(InterToGitBranch)
 
572
branch.InterBranch.register_optimiser(InterGitLocalRemoteBranch)