/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

Update docs.

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
    config,
 
28
    errors,
 
29
    foreign,
 
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.config import (
 
44
    GitBranchConfig,
 
45
    )
 
46
from bzrlib.plugins.git.errors import (
 
47
    NoSuchRef,
 
48
    )
 
49
 
 
50
try:
 
51
    from bzrlib.foreign import ForeignBranch
 
52
except ImportError:
 
53
    class ForeignBranch(branch.Branch):
 
54
        def __init__(self, mapping):
 
55
            self.mapping = mapping
 
56
            super(ForeignBranch, self).__init__()
 
57
 
 
58
 
 
59
def extract_tags(refs, mapping):
 
60
    ret = {}
 
61
    for k,v in refs.iteritems():
 
62
        if k.startswith("refs/tags/") and not k.endswith("^{}"):
 
63
            v = refs.get(k+"^{}", v)
 
64
            ret[k[len("refs/tags/"):]] = mapping.revision_id_foreign_to_bzr(v)
 
65
    return ret
 
66
 
 
67
 
 
68
class GitPullResult(branch.PullResult):
 
69
 
 
70
    def _lookup_revno(self, revid):
 
71
        assert isinstance(revid, str), "was %r" % revid
 
72
        # Try in source branch first, it'll be faster
 
73
        return self.target_branch.revision_id_to_revno(revid)
 
74
 
 
75
    @property
 
76
    def old_revno(self):
 
77
        return self._lookup_revno(self.old_revid)
 
78
 
 
79
    @property
 
80
    def new_revno(self):
 
81
        return self._lookup_revno(self.new_revid)
 
82
 
 
83
 
 
84
class LocalGitTagDict(tag.BasicTags):
 
85
    """Dictionary with tags in a local repository."""
 
86
 
 
87
    def __init__(self, branch):
 
88
        self.branch = branch
 
89
        self.repository = branch.repository
 
90
 
 
91
    def get_tag_dict(self):
 
92
        ret = {}
 
93
        for k,v in self.repository._git.tags.iteritems():
 
94
            obj = self.repository._git.get_object(v)
 
95
            while isinstance(obj, Tag):
 
96
                v = obj.object[1]
 
97
                obj = self.repository._git.get_object(v)
 
98
            if not isinstance(obj, Commit):
 
99
                mutter("Tag %s points at object %r that is not a commit, "
 
100
                       "ignoring", k, obj)
 
101
                continue
 
102
            ret[k] = self.branch.mapping.revision_id_foreign_to_bzr(v)
 
103
        return ret
 
104
 
 
105
    def set_tag(self, name, revid):
 
106
        self.repository._git.tags[name], _ = \
 
107
            self.branch.mapping.revision_id_bzr_to_foreign(revid)
 
108
 
 
109
 
 
110
class GitBranchFormat(branch.BranchFormat):
 
111
 
 
112
    def get_format_description(self):
 
113
        return 'Git Branch'
 
114
 
 
115
    def supports_tags(self):
 
116
        return True
 
117
 
 
118
    def make_tags(self, branch):
 
119
        if getattr(branch.repository, "get_refs", None) is not None:
 
120
            from bzrlib.plugins.git.remote import RemoteGitTagDict
 
121
            return RemoteGitTagDict(branch)
 
122
        else:
 
123
            return LocalGitTagDict(branch)
 
124
 
 
125
 
 
126
class GitBranch(ForeignBranch):
 
127
    """An adapter to git repositories for bzr Branch objects."""
 
128
 
 
129
    def __init__(self, bzrdir, repository, name, lockfiles):
 
130
        self.repository = repository
 
131
        self._format = GitBranchFormat()
 
132
        self.control_files = lockfiles
 
133
        self.bzrdir = bzrdir
 
134
        super(GitBranch, self).__init__(repository.get_mapping())
 
135
        self.name = name
 
136
        self._head = None
 
137
        self.base = bzrdir.transport.base
 
138
 
 
139
    def _get_nick(self, local=False, possible_master_transports=None):
 
140
        """Find the nick name for this branch.
 
141
 
 
142
        :return: Branch nick
 
143
        """
 
144
        return self.name
 
145
 
 
146
    def _set_nick(self, nick):
 
147
        raise NotImplementedError
 
148
 
 
149
    nick = property(_get_nick, _set_nick)
 
150
 
 
151
    def __repr__(self):
 
152
        return "%s(%r, %r)" % (self.__class__.__name__, self.repository.base, self.name)
 
153
 
 
154
    def dpull(self, source, stop_revision=None):
 
155
        if stop_revision is None:
 
156
            stop_revision = source.last_revision()
 
157
        # FIXME: Check for diverged branches
 
158
        refs = { "refs/heads/master": stop_revision }
 
159
        for name, revid in source.tags.get_tag_dict().iteritems():
 
160
            if source.repository.has_revision(revid):
 
161
                refs["refs/tags/%s" % name] = revid
 
162
        revidmap, new_refs = self.repository.dfetch_refs(source.repository, 
 
163
                refs)
 
164
        if revidmap != {}:
 
165
            self.generate_revision_history(revidmap[stop_revision])
 
166
        return revidmap
 
167
 
 
168
    def generate_revision_history(self, revid, old_revid=None):
 
169
        # FIXME: Check that old_revid is in the ancestry of revid
 
170
        newhead, self.mapping = self.mapping.revision_id_bzr_to_foreign(revid)
 
171
        self._set_head(newhead)
 
172
 
 
173
    def lock_write(self):
 
174
        self.control_files.lock_write()
 
175
 
 
176
    def get_stacked_on_url(self):
 
177
        # Git doesn't do stacking (yet...)
 
178
        return None
 
179
 
 
180
    def get_parent(self):
 
181
        """See Branch.get_parent()."""
 
182
        # FIXME: Set "origin" url from .git/config ?
 
183
        return None
 
184
 
 
185
    def set_parent(self, url):
 
186
        # FIXME: Set "origin" url in .git/config ?
 
187
        pass
 
188
 
 
189
    def lock_read(self):
 
190
        self.control_files.lock_read()
 
191
 
 
192
    def is_locked(self):
 
193
        return self.control_files.is_locked()
 
194
 
 
195
    def unlock(self):
 
196
        self.control_files.unlock()
 
197
 
 
198
    def get_physical_lock_status(self):
 
199
        return False
 
200
 
 
201
 
 
202
class LocalGitBranch(GitBranch):
 
203
    """A local Git branch."""
 
204
 
 
205
    @needs_read_lock
 
206
    def last_revision(self):
 
207
        # perhaps should escape this ?
 
208
        if self.head is None:
 
209
            return revision.NULL_REVISION
 
210
        return self.mapping.revision_id_foreign_to_bzr(self.head)
 
211
 
 
212
    def _get_checkout_format(self):
 
213
        """Return the most suitable metadir for a checkout of this branch.
 
214
        Weaves are used if this branch's repository uses weaves.
 
215
        """
 
216
        format = self.repository.bzrdir.checkout_metadir()
 
217
        format.set_branch_format(self._format)
 
218
        return format
 
219
 
 
220
    def create_checkout(self, to_location, revision_id=None, lightweight=False,
 
221
        accelerator_tree=None, hardlink=False):
 
222
        if lightweight:
 
223
            t = transport.get_transport(to_location)
 
224
            t.ensure_base()
 
225
            format = self._get_checkout_format()
 
226
            checkout = format.initialize_on_transport(t)
 
227
            from_branch = branch.BranchReferenceFormat().initialize(checkout, 
 
228
                self)
 
229
            tree = checkout.create_workingtree(revision_id,
 
230
                from_branch=from_branch, hardlink=hardlink)
 
231
            return tree
 
232
        else:
 
233
            return self._create_heavyweight_checkout(to_location, revision_id,
 
234
            hardlink)
 
235
 
 
236
    def _create_heavyweight_checkout(self, to_location, revision_id=None, 
 
237
                                     hardlink=False):
 
238
        """Create a new heavyweight checkout of this branch.
 
239
 
 
240
        :param to_location: URL of location to create the new checkout in.
 
241
        :param revision_id: Revision that should be the tip of the checkout.
 
242
        :param hardlink: Whether to hardlink
 
243
        :return: WorkingTree object of checkout.
 
244
        """
 
245
        checkout_branch = BzrDir.create_branch_convenience(
 
246
            to_location, force_new_tree=False, format=get_rich_root_format())
 
247
        checkout = checkout_branch.bzrdir
 
248
        checkout_branch.bind(self)
 
249
        # pull up to the specified revision_id to set the initial 
 
250
        # branch tip correctly, and seed it with history.
 
251
        checkout_branch.pull(self, stop_revision=revision_id)
 
252
        return checkout.create_workingtree(revision_id, hardlink=hardlink)
 
253
 
 
254
    def _gen_revision_history(self):
 
255
        if self.head is None:
 
256
            return []
 
257
        ret = list(self.repository.iter_reverse_revision_history(
 
258
            self.last_revision()))
 
259
        ret.reverse()
 
260
        return ret
 
261
 
 
262
    def _get_head(self):
 
263
        return self.repository._git.ref(self.name)
 
264
 
 
265
    def _set_head(self, value):
 
266
        self._head = value
 
267
        self.repository._git.set_ref(self.name, self._head)
 
268
        self._clear_cached_state()
 
269
 
 
270
    head = property(_get_head, _set_head)
 
271
 
 
272
    def get_config(self):
 
273
        return GitBranchConfig(self)
 
274
 
 
275
    def get_push_location(self):
 
276
        """See Branch.get_push_location."""
 
277
        push_loc = self.get_config().get_user_option('push_location')
 
278
        return push_loc
 
279
 
 
280
    def set_push_location(self, location):
 
281
        """See Branch.set_push_location."""
 
282
        self.get_config().set_user_option('push_location', location,
 
283
                                          store=config.STORE_LOCATION)
 
284
 
 
285
    def supports_tags(self):
 
286
        return True
 
287
 
 
288
 
 
289
class GitBranchPullResult(branch.PullResult):
 
290
 
 
291
    def report(self, to_file):
 
292
        if not is_quiet():
 
293
            if self.old_revid == self.new_revid:
 
294
                to_file.write('No revisions to pull.\n')
 
295
            else:
 
296
                to_file.write('Now on revision %d (git sha: %s).\n' % 
 
297
                        (self.new_revno, self.new_git_head))
 
298
        self._show_tag_conficts(to_file)
 
299
 
 
300
 
 
301
class InterGitGenericBranch(branch.InterBranch):
 
302
    """InterBranch implementation that pulls from Git into bzr."""
 
303
 
 
304
    @classmethod
 
305
    def is_compatible(self, source, target):
 
306
        return (isinstance(source, GitBranch) and 
 
307
                not isinstance(target, GitBranch))
 
308
 
 
309
    def update_revisions(self, stop_revision=None, overwrite=False,
 
310
        graph=None):
 
311
        """See InterBranch.update_revisions()."""
 
312
        interrepo = repository.InterRepository.get(self.source.repository, 
 
313
            self.target.repository)
 
314
        self._head = None
 
315
        self._last_revid = None
 
316
        def determine_wants(heads):
 
317
            if not self.source.name in heads:
 
318
                raise NoSuchRef(self.source.name, heads.keys())
 
319
            if stop_revision is not None:
 
320
                self._last_revid = stop_revision
 
321
                self._head, mapping = self.source.repository.lookup_git_revid(
 
322
                    stop_revision)
 
323
            else:
 
324
                self._head = heads[self.source.name]
 
325
                self._last_revid = \
 
326
                    self.source.mapping.revision_id_foreign_to_bzr(self._head)
 
327
            if self.target.repository.has_revision(self._last_revid):
 
328
                return []
 
329
            return [self._head]
 
330
        interrepo.fetch_objects(determine_wants, self.source.mapping)
 
331
        if overwrite:
 
332
            prev_last_revid = None
 
333
        else:
 
334
            prev_last_revid = self.target.last_revision()
 
335
        self.target.generate_revision_history(self._last_revid, prev_last_revid)
 
336
 
 
337
    def pull(self, overwrite=False, stop_revision=None,
 
338
             possible_transports=None, _hook_master=None, run_hooks=True,
 
339
             _override_hook_target=None, local=False):
 
340
        """See Branch.pull.
 
341
 
 
342
        :param _hook_master: Private parameter - set the branch to
 
343
            be supplied as the master to pull hooks.
 
344
        :param run_hooks: Private parameter - if false, this branch
 
345
            is being called because it's the master of the primary branch,
 
346
            so it should not run its hooks.
 
347
        :param _override_hook_target: Private parameter - set the branch to be
 
348
            supplied as the target_branch to pull hooks.
 
349
        """
 
350
        # This type of branch can't be bound.
 
351
        if local:
 
352
            raise errors.LocalRequiresBoundBranch()
 
353
        result = GitBranchPullResult()
 
354
        result.source_branch = self.source
 
355
        if _override_hook_target is None:
 
356
            result.target_branch = self.target
 
357
        else:
 
358
            result.target_branch = _override_hook_target
 
359
        self.source.lock_read()
 
360
        try:
 
361
            # We assume that during 'pull' the target repository is closer than
 
362
            # the source one.
 
363
            graph = self.target.repository.get_graph(self.source.repository)
 
364
            result.old_revno, result.old_revid = \
 
365
                self.target.last_revision_info()
 
366
            self.update_revisions(stop_revision, overwrite=overwrite, 
 
367
                graph=graph)
 
368
            result.new_git_head = self._head
 
369
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
370
                overwrite)
 
371
            result.new_revno, result.new_revid = self.target.last_revision_info()
 
372
            if _hook_master:
 
373
                result.master_branch = _hook_master
 
374
                result.local_branch = result.target_branch
 
375
            else:
 
376
                result.master_branch = result.target_branch
 
377
                result.local_branch = None
 
378
            if run_hooks:
 
379
                for hook in branch.Branch.hooks['post_pull']:
 
380
                    hook(result)
 
381
        finally:
 
382
            self.source.unlock()
 
383
        return result
 
384
 
 
385
 
 
386
 
 
387
 
 
388
branch.InterBranch.register_optimiser(InterGitGenericBranch)
 
389
 
 
390
 
 
391
class InterGitRemoteLocalBranch(branch.InterBranch):
 
392
    """InterBranch implementation that pulls between Git branches."""
 
393
 
 
394
    @classmethod
 
395
    def is_compatible(self, source, target):
 
396
        from bzrlib.plugins.git.remote import RemoteGitBranch
 
397
        return (isinstance(source, RemoteGitBranch) and 
 
398
                isinstance(target, LocalGitBranch))
 
399
 
 
400
    def pull(self, stop_revision=None, overwrite=False, 
 
401
        possible_transports=None, local=False):
 
402
        # This type of branch can't be bound.
 
403
        if local:
 
404
            raise errors.LocalRequiresBoundBranch()
 
405
        result = GitPullResult()
 
406
        result.source_branch = self.source
 
407
        result.target_branch = self.target
 
408
        interrepo = repository.InterRepository.get(self.source.repository, 
 
409
            self.target.repository)
 
410
        result.old_revid = self.target.last_revision()
 
411
        if stop_revision is None:
 
412
            refs = interrepo.fetch_refs(branches=["HEAD"])
 
413
            stop_revision = self.target.mapping.revision_id_foreign_to_bzr(refs["HEAD"])
 
414
        else:
 
415
            refs = interrepo.fetch_refs(revision_id=stop_revision)
 
416
        self.target.generate_revision_history(stop_revision, result.old_revid)
 
417
        for name, revid in extract_tags(refs, self.target.mapping).iteritems():
 
418
            self.target.tags.set_tag(name, revid)
 
419
        result.new_revid = self.target.last_revision()
 
420
        return result
 
421
 
 
422
 
 
423
branch.InterBranch.register_optimiser(InterGitRemoteLocalBranch)