1
# Copyright (C) 2008 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(), """
38
class VcsMapping(object):
39
"""Describes the mapping between the semantics of Bazaar and a foreign VCS.
42
# Whether this is an experimental mapping that is still open to changes.
45
# Whether this mapping supports exporting and importing all bzr semantics.
48
# Prefix used when importing revisions native to the foreign VCS (as
49
# opposed to roundtripping bzr-native revisions) using this mapping.
52
def __init__(self, vcs):
53
"""Create a new VcsMapping.
55
:param vcs: VCS that this mapping maps to Bazaar
59
def revision_id_bzr_to_foreign(self, bzr_revid):
60
"""Parse a bzr revision id and convert it to a foreign revid.
62
:param bzr_revid: The bzr revision id (a string).
63
:return: A foreign revision id, can be any sort of object.
65
raise NotImplementedError(self.revision_id_bzr_to_foreign)
67
def revision_id_foreign_to_bzr(self, foreign_revid):
68
"""Parse a foreign revision id and convert it to a bzr revid.
70
:param foreign_revid: Foreign revision id, can be any sort of object.
71
:return: A bzr revision id.
73
raise NotImplementedError(self.revision_id_foreign_to_bzr)
76
class VcsMappingRegistry(registry.Registry):
77
"""Registry for Bazaar<->foreign VCS mappings.
79
There should be one instance of this registry for every foreign VCS.
82
def register(self, key, factory, help):
83
"""Register a mapping between Bazaar and foreign VCS semantics.
85
The factory must be a callable that takes one parameter: the key.
86
It must produce an instance of VcsMapping when called.
89
raise ValueError("mapping name can not contain colon (:)")
90
registry.Registry.register(self, key, factory, help)
92
def set_default(self, key):
93
"""Set the 'default' key to be a clone of the supplied key.
95
This method must be called once and only once.
97
self._set_default_key(key)
99
def get_default(self):
100
"""Convenience function for obtaining the default mapping to use."""
101
return self.get(self._get_default_key())
103
def revision_id_bzr_to_foreign(self, revid):
104
"""Convert a bzr revision id to a foreign revid."""
105
raise NotImplementedError(self.revision_id_bzr_to_foreign)
108
class ForeignRevision(Revision):
109
"""A Revision from a Foreign repository. Remembers
110
information about foreign revision id and mapping.
114
def __init__(self, foreign_revid, mapping, *args, **kwargs):
115
if not "inventory_sha1" in kwargs:
116
kwargs["inventory_sha1"] = ""
117
super(ForeignRevision, self).__init__(*args, **kwargs)
118
self.foreign_revid = foreign_revid
119
self.mapping = mapping
122
class ForeignVcs(object):
123
"""A foreign version control system."""
127
def __init__(self, mapping_registry):
128
self.mapping_registry = mapping_registry
130
def show_foreign_revid(self, foreign_revid):
131
"""Prepare a foreign revision id for formatting using bzr log.
133
:param foreign_revid: Foreign revision id.
134
:return: Dictionary mapping string keys to string values.
139
class ForeignVcsRegistry(registry.Registry):
140
"""Registry for Foreign VCSes.
142
There should be one entry per foreign VCS. Example entries would be
143
"git", "svn", "hg", "darcs", etc.
147
def register(self, key, foreign_vcs, help):
148
"""Register a foreign VCS.
150
:param key: Prefix of the foreign VCS in revision ids
151
:param foreign_vcs: ForeignVCS instance
152
:param help: Description of the foreign VCS
154
if ":" in key or "-" in key:
155
raise ValueError("vcs name can not contain : or -")
156
registry.Registry.register(self, key, foreign_vcs, help)
158
def parse_revision_id(self, revid):
159
"""Parse a bzr revision and return the matching mapping and foreign
162
:param revid: The bzr revision id
163
:return: tuple with foreign revid and vcs mapping
165
if not ":" in revid or not "-" in revid:
166
raise errors.InvalidRevisionId(revid, None)
168
foreign_vcs = self.get(revid.split("-")[0])
170
raise errors.InvalidRevisionId(revid, None)
171
return foreign_vcs.mapping_registry.revision_id_bzr_to_foreign(revid)
174
foreign_vcs_registry = ForeignVcsRegistry()
177
class ForeignRepository(Repository):
178
"""A Repository that exists in a foreign version control system.
180
The data in this repository can not be represented natively using
181
Bazaars internal datastructures, but have to converted using a VcsMapping.
184
# This repository's native version control system
187
def has_foreign_revision(self, foreign_revid):
188
"""Check whether the specified foreign revision is present.
190
:param foreign_revid: A foreign revision id, in the format used
191
by this Repository's VCS.
193
raise NotImplementedError(self.has_foreign_revision)
195
def lookup_bzr_revision_id(self, revid):
196
"""Lookup a mapped or roundtripped revision by revision id.
198
:param revid: Bazaar revision id
199
:return: Tuple with foreign revision id and mapping.
201
raise NotImplementedError(self.lookup_revision_id)
203
def all_revision_ids(self, mapping=None):
204
"""See Repository.all_revision_ids()."""
205
raise NotImplementedError(self.all_revision_ids)
207
def get_default_mapping(self):
208
"""Get the default mapping for this repository."""
209
raise NotImplementedError(self.get_default_mapping)
211
def get_inventory_xml(self, revision_id):
212
"""See Repository.get_inventory_xml()."""
213
return self.serialise_inventory(self.get_inventory(revision_id))
215
def get_inventory_sha1(self, revision_id):
216
"""Get the sha1 for the XML representation of an inventory.
218
:param revision_id: Revision id of the inventory for which to return
223
return osutils.sha_string(self.get_inventory_xml(revision_id))
225
def get_revision_xml(self, revision_id):
226
"""Return the XML representation of a revision.
228
:param revision_id: Revision for which to return the XML.
231
return self._serializer.write_revision_to_string(
232
self.get_revision(revision_id))
235
class ForeignBranch(Branch):
236
"""Branch that exists in a foreign version control system."""
238
def __init__(self, mapping):
239
self.mapping = mapping
240
super(ForeignBranch, self).__init__()
243
def update_workingtree_fileids(wt, target_tree):
244
"""Update the file ids in a working tree based on another tree.
246
:param wt: Working tree in which to update file ids
247
:param target_tree: Tree to retrieve new file ids from, based on path
249
tt = transform.TreeTransform(wt)
251
for f, p, c, v, d, n, k, e in target_tree.iter_changes(wt):
252
if v == (True, False):
253
trans_id = tt.trans_id_tree_path(p[0])
254
tt.unversion_file(trans_id)
255
elif v == (False, True):
256
trans_id = tt.trans_id_tree_path(p[1])
257
tt.version_file(f, trans_id)
261
if len(wt.get_parent_ids()) == 1:
262
wt.set_parent_trees([(target_tree.get_revision_id(), target_tree)])
264
wt.set_last_revision(target_tree.get_revision_id())
267
class cmd_dpush(Command):
268
"""Push into a different VCS without any custom bzr metadata.
270
This will afterwards rebase the local branch on the remote
271
branch unless the --no-rebase option is used, in which case
272
the two branches will be out of sync after the push.
275
takes_args = ['location?']
279
help='Branch to push from, '
280
'rather than the one containing the working directory.',
284
Option('no-rebase', help="Do not rebase after push."),
286
help='Refuse to push if there are uncommitted changes in'
287
' the working tree, --no-strict disables the check.'),
290
def run(self, location=None, remember=False, directory=None,
291
no_rebase=False, strict=None):
292
from bzrlib import urlutils
293
from bzrlib.bzrdir import BzrDir
294
from bzrlib.errors import BzrCommandError, NoWorkingTree
295
from bzrlib.workingtree import WorkingTree
297
if directory is None:
300
source_wt = WorkingTree.open_containing(directory)[0]
301
source_branch = source_wt.branch
302
except NoWorkingTree:
303
source_branch = Branch.open(directory)
306
strict = source_branch.get_config(
307
).get_user_option_as_bool('dpush_strict')
308
if strict is None: strict = True # default value
309
if strict and source_wt is not None:
310
if (source_wt.has_changes()):
311
raise errors.UncommittedChanges(
312
source_wt, more='Use --no-strict to force the push.')
313
if source_wt.last_revision() != source_wt.branch.last_revision():
314
# The tree has lost sync with its branch, there is little
315
# chance that the user is aware of it but he can still force
316
# the push with --no-strict
317
raise errors.OutOfDateTree(
318
source_wt, more='Use --no-strict to force the push.')
319
stored_loc = source_branch.get_push_location()
321
if stored_loc is None:
322
raise BzrCommandError("No push location known or specified.")
324
display_url = urlutils.unescape_for_display(stored_loc,
326
self.outf.write("Using saved location: %s\n" % display_url)
327
location = stored_loc
329
bzrdir = BzrDir.open(location)
330
target_branch = bzrdir.open_branch()
331
target_branch.lock_write()
334
push_result = source_branch.lossy_push(target_branch)
335
except errors.LossyPushToSameVCS:
336
raise BzrCommandError("%r and %r are in the same VCS, lossy "
337
"push not necessary. Please use regular push." %
338
(source_branch, target_branch))
339
# We successfully created the target, remember it
340
if source_branch.get_push_location() is None or remember:
341
source_branch.set_push_location(target_branch.base)
343
old_last_revid = source_branch.last_revision()
344
source_branch.pull(target_branch, overwrite=True)
345
new_last_revid = source_branch.last_revision()
346
if source_wt is not None and old_last_revid != new_last_revid:
347
source_wt.lock_write()
349
target = source_wt.branch.repository.revision_tree(
351
update_workingtree_fileids(source_wt, target)
354
push_result.report(self.outf)
356
target_branch.unlock()
359
class InterToForeignBranch(InterBranch):
361
def lossy_push(self, stop_revision=None):
362
"""Push deltas into another branch.
364
:note: This does not, like push, retain the revision ids from
365
the source branch and will, rather than adding bzr-specific
366
metadata, push only those semantics of the revision that can be
367
natively represented by this branch' VCS.
369
:param target: Target branch
370
:param stop_revision: Revision to push, defaults to last revision.
371
:return: BranchPushResult with an extra member revidmap:
372
A dictionary mapping revision ids from the target branch
373
to new revision ids in the target branch, for each
374
revision that was pushed.
376
raise NotImplementedError(self.lossy_push)
added
removed
bzrlib/foreign.py
