1
# Copyright (C) 2008-2011 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
"""Foreign branch utilities."""
21
from bzrlib.branch import (
25
from bzrlib.commands import Command, Option
26
from bzrlib.repository import Repository
27
from bzrlib.revision import Revision
28
from bzrlib.lazy_import import lazy_import
29
lazy_import(globals(), """
37
class VcsMapping(object):
38
"""Describes the mapping between the semantics of Bazaar and a foreign VCS.
41
# Whether this is an experimental mapping that is still open to changes.
44
# Whether this mapping supports exporting and importing all bzr semantics.
47
# Prefix used when importing revisions native to the foreign VCS (as
48
# opposed to roundtripping bzr-native revisions) using this mapping.
51
def __init__(self, vcs):
52
"""Create a new VcsMapping.
54
:param vcs: VCS that this mapping maps to Bazaar
58
def revision_id_bzr_to_foreign(self, bzr_revid):
59
"""Parse a bzr revision id and convert it to a foreign revid.
61
:param bzr_revid: The bzr revision id (a string).
62
:return: A foreign revision id, can be any sort of object.
64
raise NotImplementedError(self.revision_id_bzr_to_foreign)
66
def revision_id_foreign_to_bzr(self, foreign_revid):
67
"""Parse a foreign revision id and convert it to a bzr revid.
69
:param foreign_revid: Foreign revision id, can be any sort of object.
70
:return: A bzr revision id.
72
raise NotImplementedError(self.revision_id_foreign_to_bzr)
75
class VcsMappingRegistry(registry.Registry):
76
"""Registry for Bazaar<->foreign VCS mappings.
78
There should be one instance of this registry for every foreign VCS.
81
def register(self, key, factory, help):
82
"""Register a mapping between Bazaar and foreign VCS semantics.
84
The factory must be a callable that takes one parameter: the key.
85
It must produce an instance of VcsMapping when called.
88
raise ValueError("mapping name can not contain colon (:)")
89
registry.Registry.register(self, key, factory, help)
91
def set_default(self, key):
92
"""Set the 'default' key to be a clone of the supplied key.
94
This method must be called once and only once.
96
self._set_default_key(key)
98
def get_default(self):
99
"""Convenience function for obtaining the default mapping to use."""
100
return self.get(self._get_default_key())
102
def revision_id_bzr_to_foreign(self, revid):
103
"""Convert a bzr revision id to a foreign revid."""
104
raise NotImplementedError(self.revision_id_bzr_to_foreign)
107
class ForeignRevision(Revision):
108
"""A Revision from a Foreign repository. Remembers
109
information about foreign revision id and mapping.
113
def __init__(self, foreign_revid, mapping, *args, **kwargs):
114
if not "inventory_sha1" in kwargs:
115
kwargs["inventory_sha1"] = ""
116
super(ForeignRevision, self).__init__(*args, **kwargs)
117
self.foreign_revid = foreign_revid
118
self.mapping = mapping
121
class ForeignVcs(object):
122
"""A foreign version control system."""
126
repository_format = None
128
def __init__(self, mapping_registry, abbreviation=None):
129
"""Create a new foreign vcs instance.
131
:param mapping_registry: Registry with mappings for this VCS.
132
:param abbreviation: Optional abbreviation ('bzr', 'svn', 'git', etc)
134
self.abbreviation = abbreviation
135
self.mapping_registry = mapping_registry
137
def show_foreign_revid(self, foreign_revid):
138
"""Prepare a foreign revision id for formatting using bzr log.
140
:param foreign_revid: Foreign revision id.
141
:return: Dictionary mapping string keys to string values.
145
def serialize_foreign_revid(self, foreign_revid):
146
"""Serialize a foreign revision id for this VCS.
148
:param foreign_revid: Foreign revision id
149
:return: Bytestring with serialized revid, will not contain any
152
raise NotImplementedError(self.serialize_foreign_revid)
155
class ForeignVcsRegistry(registry.Registry):
156
"""Registry for Foreign VCSes.
158
There should be one entry per foreign VCS. Example entries would be
159
"git", "svn", "hg", "darcs", etc.
163
def register(self, key, foreign_vcs, help):
164
"""Register a foreign VCS.
166
:param key: Prefix of the foreign VCS in revision ids
167
:param foreign_vcs: ForeignVCS instance
168
:param help: Description of the foreign VCS
170
if ":" in key or "-" in key:
171
raise ValueError("vcs name can not contain : or -")
172
registry.Registry.register(self, key, foreign_vcs, help)
174
def parse_revision_id(self, revid):
175
"""Parse a bzr revision and return the matching mapping and foreign
178
:param revid: The bzr revision id
179
:return: tuple with foreign revid and vcs mapping
181
if not ":" in revid or not "-" in revid:
182
raise errors.InvalidRevisionId(revid, None)
184
foreign_vcs = self.get(revid.split("-")[0])
186
raise errors.InvalidRevisionId(revid, None)
187
return foreign_vcs.mapping_registry.revision_id_bzr_to_foreign(revid)
190
foreign_vcs_registry = ForeignVcsRegistry()
193
class ForeignRepository(Repository):
194
"""A Repository that exists in a foreign version control system.
196
The data in this repository can not be represented natively using
197
Bazaars internal datastructures, but have to converted using a VcsMapping.
200
# This repository's native version control system
203
def has_foreign_revision(self, foreign_revid):
204
"""Check whether the specified foreign revision is present.
206
:param foreign_revid: A foreign revision id, in the format used
207
by this Repository's VCS.
209
raise NotImplementedError(self.has_foreign_revision)
211
def lookup_bzr_revision_id(self, revid):
212
"""Lookup a mapped or roundtripped revision by revision id.
214
:param revid: Bazaar revision id
215
:return: Tuple with foreign revision id and mapping.
217
raise NotImplementedError(self.lookup_revision_id)
219
def all_revision_ids(self, mapping=None):
220
"""See Repository.all_revision_ids()."""
221
raise NotImplementedError(self.all_revision_ids)
223
def get_default_mapping(self):
224
"""Get the default mapping for this repository."""
225
raise NotImplementedError(self.get_default_mapping)
228
class ForeignBranch(Branch):
229
"""Branch that exists in a foreign version control system."""
231
def __init__(self, mapping):
232
self.mapping = mapping
233
super(ForeignBranch, self).__init__()
236
def update_workingtree_fileids(wt, target_tree):
237
"""Update the file ids in a working tree based on another tree.
239
:param wt: Working tree in which to update file ids
240
:param target_tree: Tree to retrieve new file ids from, based on path
242
tt = transform.TreeTransform(wt)
244
for f, p, c, v, d, n, k, e in target_tree.iter_changes(wt):
245
if v == (True, False):
246
trans_id = tt.trans_id_tree_path(p[0])
247
tt.unversion_file(trans_id)
248
elif v == (False, True):
249
trans_id = tt.trans_id_tree_path(p[1])
250
tt.version_file(f, trans_id)
254
if len(wt.get_parent_ids()) == 1:
255
wt.set_parent_trees([(target_tree.get_revision_id(), target_tree)])
257
wt.set_last_revision(target_tree.get_revision_id())
260
class cmd_dpush(Command):
261
__doc__ = """Push into a different VCS without any custom bzr metadata.
263
This will afterwards rebase the local branch on the remote
264
branch unless the --no-rebase option is used, in which case
265
the two branches will be out of sync after the push.
268
takes_args = ['location?']
272
help='Branch to push from, '
273
'rather than the one containing the working directory.',
277
Option('no-rebase', help="Do not rebase after push."),
279
help='Refuse to push if there are uncommitted changes in'
280
' the working tree, --no-strict disables the check.'),
283
def run(self, location=None, remember=False, directory=None,
284
no_rebase=False, strict=None):
285
from bzrlib import urlutils
286
from bzrlib.bzrdir import BzrDir
287
from bzrlib.errors import BzrCommandError, NoWorkingTree
288
from bzrlib.workingtree import WorkingTree
290
if directory is None:
293
source_wt = WorkingTree.open_containing(directory)[0]
294
source_branch = source_wt.branch
295
except NoWorkingTree:
296
source_branch = Branch.open(directory)
298
if source_wt is not None:
299
source_wt.check_changed_or_out_of_date(
300
strict, 'dpush_strict',
301
more_error='Use --no-strict to force the push.',
302
more_warning='Uncommitted changes will not be pushed.')
303
stored_loc = source_branch.get_push_location()
305
if stored_loc is None:
306
raise BzrCommandError("No push location known or specified.")
308
display_url = urlutils.unescape_for_display(stored_loc,
310
self.outf.write("Using saved location: %s\n" % display_url)
311
location = stored_loc
313
bzrdir = BzrDir.open(location)
314
target_branch = bzrdir.open_branch()
315
target_branch.lock_write()
318
push_result = source_branch.lossy_push(target_branch)
319
except errors.LossyPushToSameVCS:
320
raise BzrCommandError("%r and %r are in the same VCS, lossy "
321
"push not necessary. Please use regular push." %
322
(source_branch, target_branch))
323
# We successfully created the target, remember it
324
if source_branch.get_push_location() is None or remember:
325
source_branch.set_push_location(target_branch.base)
327
old_last_revid = source_branch.last_revision()
328
source_branch.pull(target_branch, overwrite=True)
329
new_last_revid = source_branch.last_revision()
330
if source_wt is not None and old_last_revid != new_last_revid:
331
source_wt.lock_write()
333
target = source_wt.branch.repository.revision_tree(
335
update_workingtree_fileids(source_wt, target)
338
push_result.report(self.outf)
340
target_branch.unlock()
343
class InterToForeignBranch(InterBranch):
345
def lossy_push(self, stop_revision=None):
346
"""Push deltas into another branch.
348
:note: This does not, like push, retain the revision ids from
349
the source branch and will, rather than adding bzr-specific
350
metadata, push only those semantics of the revision that can be
351
natively represented by this branch' VCS.
353
:param target: Target branch
354
:param stop_revision: Revision to push, defaults to last revision.
355
:return: BranchPushResult with an extra member revidmap:
356
A dictionary mapping revision ids from the target branch
357
to new revision ids in the target branch, for each
358
revision that was pushed.
360
raise NotImplementedError(self.lossy_push)
added
removed
bzrlib/foreign.py
