1
# Copyright (C) 2008-2012 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
17
"""Foreign branch utilities."""
19
from __future__ import absolute_import
25
from .commands import Command, Option
26
from .repository import Repository
27
from .revision import Revision
31
from .lazy_import import lazy_import
32
lazy_import(globals(), """
38
from breezy.i18n import gettext
41
class VcsMapping(object):
42
"""Describes the mapping between the semantics of Bazaar and a foreign VCS.
45
# Whether this is an experimental mapping that is still open to changes.
48
# Whether this mapping supports exporting and importing all bzr semantics.
51
# Prefix used when importing revisions native to the foreign VCS (as
52
# opposed to roundtripping bzr-native revisions) using this mapping.
55
def __init__(self, vcs):
56
"""Create a new VcsMapping.
58
:param vcs: VCS that this mapping maps to Bazaar
62
def revision_id_bzr_to_foreign(self, bzr_revid):
63
"""Parse a bzr revision id and convert it to a foreign revid.
65
:param bzr_revid: The bzr revision id (a string).
66
:return: A foreign revision id, can be any sort of object.
68
raise NotImplementedError(self.revision_id_bzr_to_foreign)
70
def revision_id_foreign_to_bzr(self, foreign_revid):
71
"""Parse a foreign revision id and convert it to a bzr revid.
73
:param foreign_revid: Foreign revision id, can be any sort of object.
74
:return: A bzr revision id.
76
raise NotImplementedError(self.revision_id_foreign_to_bzr)
79
class VcsMappingRegistry(registry.Registry):
80
"""Registry for Bazaar<->foreign VCS mappings.
82
There should be one instance of this registry for every foreign VCS.
85
def register(self, key, factory, help):
86
"""Register a mapping between Bazaar and foreign VCS semantics.
88
The factory must be a callable that takes one parameter: the key.
89
It must produce an instance of VcsMapping when called.
92
raise ValueError("mapping name can not contain colon (:)")
93
registry.Registry.register(self, key, factory, help)
95
def set_default(self, key):
96
"""Set the 'default' key to be a clone of the supplied key.
98
This method must be called once and only once.
100
self._set_default_key(key)
102
def get_default(self):
103
"""Convenience function for obtaining the default mapping to use."""
104
return self.get(self._get_default_key())
106
def revision_id_bzr_to_foreign(self, revid):
107
"""Convert a bzr revision id to a foreign revid."""
108
raise NotImplementedError(self.revision_id_bzr_to_foreign)
111
class ForeignRevision(Revision):
112
"""A Revision from a Foreign repository. Remembers
113
information about foreign revision id and mapping.
117
def __init__(self, foreign_revid, mapping, *args, **kwargs):
118
if not "inventory_sha1" in kwargs:
119
kwargs["inventory_sha1"] = ""
120
super(ForeignRevision, self).__init__(*args, **kwargs)
121
self.foreign_revid = foreign_revid
122
self.mapping = mapping
125
class ForeignVcs(object):
126
"""A foreign version control system."""
130
repository_format = None
132
def __init__(self, mapping_registry, abbreviation=None):
133
"""Create a new foreign vcs instance.
135
:param mapping_registry: Registry with mappings for this VCS.
136
:param abbreviation: Optional abbreviation ('bzr', 'svn', 'git', etc)
138
self.abbreviation = abbreviation
139
self.mapping_registry = mapping_registry
141
def show_foreign_revid(self, foreign_revid):
142
"""Prepare a foreign revision id for formatting using bzr log.
144
:param foreign_revid: Foreign revision id.
145
:return: Dictionary mapping string keys to string values.
149
def serialize_foreign_revid(self, foreign_revid):
150
"""Serialize a foreign revision id for this VCS.
152
:param foreign_revid: Foreign revision id
153
:return: Bytestring with serialized revid, will not contain any
156
raise NotImplementedError(self.serialize_foreign_revid)
159
class ForeignVcsRegistry(registry.Registry):
160
"""Registry for Foreign VCSes.
162
There should be one entry per foreign VCS. Example entries would be
163
"git", "svn", "hg", "darcs", etc.
167
def register(self, key, foreign_vcs, help):
168
"""Register a foreign VCS.
170
:param key: Prefix of the foreign VCS in revision ids
171
:param foreign_vcs: ForeignVCS instance
172
:param help: Description of the foreign VCS
174
if ":" in key or "-" in key:
175
raise ValueError("vcs name can not contain : or -")
176
registry.Registry.register(self, key, foreign_vcs, help)
178
def parse_revision_id(self, revid):
179
"""Parse a bzr revision and return the matching mapping and foreign
182
:param revid: The bzr revision id
183
:return: tuple with foreign revid and vcs mapping
185
if not ":" in revid or not "-" in revid:
186
raise errors.InvalidRevisionId(revid, None)
188
foreign_vcs = self.get(revid.split("-")[0])
190
raise errors.InvalidRevisionId(revid, None)
191
return foreign_vcs.mapping_registry.revision_id_bzr_to_foreign(revid)
194
foreign_vcs_registry = ForeignVcsRegistry()
197
class ForeignRepository(Repository):
198
"""A Repository that exists in a foreign version control system.
200
The data in this repository can not be represented natively using
201
Bazaars internal datastructures, but have to converted using a VcsMapping.
204
# This repository's native version control system
207
def has_foreign_revision(self, foreign_revid):
208
"""Check whether the specified foreign revision is present.
210
:param foreign_revid: A foreign revision id, in the format used
211
by this Repository's VCS.
213
raise NotImplementedError(self.has_foreign_revision)
215
def lookup_bzr_revision_id(self, revid):
216
"""Lookup a mapped or roundtripped revision by revision id.
218
:param revid: Bazaar revision id
219
:return: Tuple with foreign revision id and mapping.
221
raise NotImplementedError(self.lookup_revision_id)
223
def all_revision_ids(self, mapping=None):
224
"""See Repository.all_revision_ids()."""
225
raise NotImplementedError(self.all_revision_ids)
227
def get_default_mapping(self):
228
"""Get the default mapping for this repository."""
229
raise NotImplementedError(self.get_default_mapping)
232
class ForeignBranch(Branch):
233
"""Branch that exists in a foreign version control system."""
235
def __init__(self, mapping):
236
self.mapping = mapping
237
super(ForeignBranch, self).__init__()
added
removed
breezy/foreign.py
