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 (
24
from bzrlib.commands import Command, Option
25
from bzrlib.repository import Repository
26
from bzrlib.revision import Revision
27
from bzrlib.lazy_import import lazy_import
28
lazy_import(globals(), """
36
class VcsMapping(object):
37
"""Describes the mapping between the semantics of Bazaar and a foreign VCS.
40
# Whether this is an experimental mapping that is still open to changes.
43
# Whether this mapping supports exporting and importing all bzr semantics.
46
# Prefix used when importing revisions native to the foreign VCS (as
47
# opposed to roundtripping bzr-native revisions) using this mapping.
50
def __init__(self, vcs):
51
"""Create a new VcsMapping.
53
:param vcs: VCS that this mapping maps to Bazaar
57
def revision_id_bzr_to_foreign(self, bzr_revid):
58
"""Parse a bzr revision id and convert it to a foreign revid.
60
:param bzr_revid: The bzr revision id (a string).
61
:return: A foreign revision id, can be any sort of object.
63
raise NotImplementedError(self.revision_id_bzr_to_foreign)
65
def revision_id_foreign_to_bzr(self, foreign_revid):
66
"""Parse a foreign revision id and convert it to a bzr revid.
68
:param foreign_revid: Foreign revision id, can be any sort of object.
69
:return: A bzr revision id.
71
raise NotImplementedError(self.revision_id_foreign_to_bzr)
74
class VcsMappingRegistry(registry.Registry):
75
"""Registry for Bazaar<->foreign VCS mappings.
77
There should be one instance of this registry for every foreign VCS.
80
def register(self, key, factory, help):
81
"""Register a mapping between Bazaar and foreign VCS semantics.
83
The factory must be a callable that takes one parameter: the key.
84
It must produce an instance of VcsMapping when called.
87
raise ValueError("mapping name can not contain colon (:)")
88
registry.Registry.register(self, key, factory, help)
90
def set_default(self, key):
91
"""Set the 'default' key to be a clone of the supplied key.
93
This method must be called once and only once.
95
self._set_default_key(key)
97
def get_default(self):
98
"""Convenience function for obtaining the default mapping to use."""
99
return self.get(self._get_default_key())
101
def revision_id_bzr_to_foreign(self, revid):
102
"""Convert a bzr revision id to a foreign revid."""
103
raise NotImplementedError(self.revision_id_bzr_to_foreign)
106
class ForeignRevision(Revision):
107
"""A Revision from a Foreign repository. Remembers
108
information about foreign revision id and mapping.
112
def __init__(self, foreign_revid, mapping, *args, **kwargs):
113
if not "inventory_sha1" in kwargs:
114
kwargs["inventory_sha1"] = ""
115
super(ForeignRevision, self).__init__(*args, **kwargs)
116
self.foreign_revid = foreign_revid
117
self.mapping = mapping
120
class ForeignVcs(object):
121
"""A foreign version control system."""
125
repository_format = None
127
def __init__(self, mapping_registry, abbreviation=None):
128
"""Create a new foreign vcs instance.
130
:param mapping_registry: Registry with mappings for this VCS.
131
:param abbreviation: Optional abbreviation ('bzr', 'svn', 'git', etc)
133
self.abbreviation = abbreviation
134
self.mapping_registry = mapping_registry
136
def show_foreign_revid(self, foreign_revid):
137
"""Prepare a foreign revision id for formatting using bzr log.
139
:param foreign_revid: Foreign revision id.
140
:return: Dictionary mapping string keys to string values.
144
def serialize_foreign_revid(self, foreign_revid):
145
"""Serialize a foreign revision id for this VCS.
147
:param foreign_revid: Foreign revision id
148
:return: Bytestring with serialized revid, will not contain any
151
raise NotImplementedError(self.serialize_foreign_revid)
154
class ForeignVcsRegistry(registry.Registry):
155
"""Registry for Foreign VCSes.
157
There should be one entry per foreign VCS. Example entries would be
158
"git", "svn", "hg", "darcs", etc.
162
def register(self, key, foreign_vcs, help):
163
"""Register a foreign VCS.
165
:param key: Prefix of the foreign VCS in revision ids
166
:param foreign_vcs: ForeignVCS instance
167
:param help: Description of the foreign VCS
169
if ":" in key or "-" in key:
170
raise ValueError("vcs name can not contain : or -")
171
registry.Registry.register(self, key, foreign_vcs, help)
173
def parse_revision_id(self, revid):
174
"""Parse a bzr revision and return the matching mapping and foreign
177
:param revid: The bzr revision id
178
:return: tuple with foreign revid and vcs mapping
180
if not ":" in revid or not "-" in revid:
181
raise errors.InvalidRevisionId(revid, None)
183
foreign_vcs = self.get(revid.split("-")[0])
185
raise errors.InvalidRevisionId(revid, None)
186
return foreign_vcs.mapping_registry.revision_id_bzr_to_foreign(revid)
189
foreign_vcs_registry = ForeignVcsRegistry()
192
class ForeignRepository(Repository):
193
"""A Repository that exists in a foreign version control system.
195
The data in this repository can not be represented natively using
196
Bazaars internal datastructures, but have to converted using a VcsMapping.
199
# This repository's native version control system
202
def has_foreign_revision(self, foreign_revid):
203
"""Check whether the specified foreign revision is present.
205
:param foreign_revid: A foreign revision id, in the format used
206
by this Repository's VCS.
208
raise NotImplementedError(self.has_foreign_revision)
210
def lookup_bzr_revision_id(self, revid):
211
"""Lookup a mapped or roundtripped revision by revision id.
213
:param revid: Bazaar revision id
214
:return: Tuple with foreign revision id and mapping.
216
raise NotImplementedError(self.lookup_revision_id)
218
def all_revision_ids(self, mapping=None):
219
"""See Repository.all_revision_ids()."""
220
raise NotImplementedError(self.all_revision_ids)
222
def get_default_mapping(self):
223
"""Get the default mapping for this repository."""
224
raise NotImplementedError(self.get_default_mapping)
227
class ForeignBranch(Branch):
228
"""Branch that exists in a foreign version control system."""
230
def __init__(self, mapping):
231
self.mapping = mapping
232
super(ForeignBranch, self).__init__()
235
def update_workingtree_fileids(wt, target_tree):
236
"""Update the file ids in a working tree based on another tree.
238
:param wt: Working tree in which to update file ids
239
:param target_tree: Tree to retrieve new file ids from, based on path
241
tt = transform.TreeTransform(wt)
243
for f, p, c, v, d, n, k, e in target_tree.iter_changes(wt):
244
if v == (True, False):
245
trans_id = tt.trans_id_tree_path(p[0])
246
tt.unversion_file(trans_id)
247
elif v == (False, True):
248
trans_id = tt.trans_id_tree_path(p[1])
249
tt.version_file(f, trans_id)
253
if len(wt.get_parent_ids()) == 1:
254
wt.set_parent_trees([(target_tree.get_revision_id(), target_tree)])
256
wt.set_last_revision(target_tree.get_revision_id())
259
class cmd_dpush(Command):
260
__doc__ = """Push into a different VCS without any custom bzr metadata.
262
This will afterwards rebase the local branch on the remote
263
branch unless the --no-rebase option is used, in which case
264
the two branches will be out of sync after the push.
267
takes_args = ['location?']
271
help='Branch to push from, '
272
'rather than the one containing the working directory.',
276
Option('no-rebase', help="Do not rebase after push."),
278
help='Refuse to push if there are uncommitted changes in'
279
' the working tree, --no-strict disables the check.'),
282
def run(self, location=None, remember=False, directory=None,
283
no_rebase=False, strict=None):
284
from bzrlib import urlutils
285
from bzrlib.bzrdir import BzrDir
286
from bzrlib.errors import BzrCommandError, NoWorkingTree
287
from bzrlib.workingtree import WorkingTree
289
if directory is None:
292
source_wt = WorkingTree.open_containing(directory)[0]
293
source_branch = source_wt.branch
294
except NoWorkingTree:
295
source_branch = Branch.open(directory)
297
if source_wt is not None:
298
source_wt.check_changed_or_out_of_date(
299
strict, 'dpush_strict',
300
more_error='Use --no-strict to force the push.',
301
more_warning='Uncommitted changes will not be pushed.')
302
stored_loc = source_branch.get_push_location()
304
if stored_loc is None:
305
raise BzrCommandError("No push location known or specified.")
307
display_url = urlutils.unescape_for_display(stored_loc,
309
self.outf.write("Using saved location: %s\n" % display_url)
310
location = stored_loc
312
bzrdir = BzrDir.open(location)
313
target_branch = bzrdir.open_branch()
314
target_branch.lock_write()
317
push_result = source_branch.push(target_branch, lossy=True)
318
except errors.LossyPushToSameVCS:
319
raise BzrCommandError("%r and %r are in the same VCS, lossy "
320
"push not necessary. Please use regular push." %
321
(source_branch, target_branch))
322
# We successfully created the target, remember it
323
if source_branch.get_push_location() is None or remember:
324
source_branch.set_push_location(target_branch.base)
326
old_last_revid = source_branch.last_revision()
327
source_branch.pull(target_branch, overwrite=True)
328
new_last_revid = source_branch.last_revision()
329
if source_wt is not None and old_last_revid != new_last_revid:
330
source_wt.lock_write()
332
target = source_wt.branch.repository.revision_tree(
334
update_workingtree_fileids(source_wt, target)
337
push_result.report(self.outf)
339
target_branch.unlock()
added
removed
bzrlib/foreign.py
