1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
|
# Copyright (C) 2008 Canonical Ltd
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
"""Foreign branch utilities."""
from bzrlib.branch import Branch
from bzrlib.commands import Command, Option
from bzrlib.repository import Repository
from bzrlib.revision import Revision
from bzrlib.lazy_import import lazy_import
lazy_import(globals(), """
from bzrlib import (
errors,
osutils,
registry,
)
""")
class VcsMapping(object):
"""Describes the mapping between the semantics of Bazaar and a foreign vcs.
"""
# Whether this is an experimental mapping that is still open to changes.
experimental = False
# Whether this mapping supports exporting and importing all bzr semantics.
roundtripping = False
# Prefix used when importing native foreign revisions (not roundtripped)
# using this mapping.
revid_prefix = None
def __init__(self, vcs):
"""Create a new VcsMapping.
:param vcs: VCS that this mapping maps to Bazaar
"""
self.vcs = vcs
def revision_id_bzr_to_foreign(self, bzr_revid):
"""Parse a bzr revision id and convert it to a foreign revid.
:param bzr_revid: The bzr revision id (a string).
:return: A foreign revision id, can be any sort of object.
"""
raise NotImplementedError(self.revision_id_bzr_to_foreign)
def revision_id_foreign_to_bzr(self, foreign_revid):
"""Parse a foreign revision id and convert it to a bzr revid.
:param foreign_revid: Foreign revision id, can be any sort of object.
:return: A bzr revision id.
"""
raise NotImplementedError(self.revision_id_foreign_to_bzr)
class VcsMappingRegistry(registry.Registry):
"""Registry for Bazaar<->foreign VCS mappings.
There should be one instance of this registry for every foreign VCS.
"""
def register(self, key, factory, help):
"""Register a mapping between Bazaar and foreign VCS semantics.
The factory must be a callable that takes one parameter: the key.
It must produce an instance of VcsMapping when called.
"""
if ":" in key:
raise ValueError("mapping name can not contain colon (:)")
registry.Registry.register(self, key, factory, help)
def set_default(self, key):
"""Set the 'default' key to be a clone of the supplied key.
This method must be called once and only once.
"""
self._set_default_key(key)
def get_default(self):
"""Convenience function for obtaining the default mapping to use."""
return self.get(self._get_default_key())
def revision_id_bzr_to_foreign(self, revid):
"""Convert a bzr revision id to a foreign revid."""
raise NotImplementedError(self.revision_id_bzr_to_foreign)
class ForeignRevision(Revision):
"""A Revision from a Foreign repository. Remembers
information about foreign revision id and mapping.
"""
def __init__(self, foreign_revid, mapping, *args, **kwargs):
if not "inventory_sha1" in kwargs:
kwargs["inventory_sha1"] = ""
super(ForeignRevision, self).__init__(*args, **kwargs)
self.foreign_revid = foreign_revid
self.mapping = mapping
def show_foreign_properties(rev):
"""Custom log displayer for foreign revision identifiers.
:param rev: Revision object.
"""
# Revision comes directly from a foreign repository
if isinstance(rev, ForeignRevision):
return rev.mapping.vcs.show_foreign_revid(rev.foreign_revid)
# Revision was once imported from a foreign repository
try:
foreign_revid, mapping = \
foreign_vcs_registry.parse_revision_id(rev.revision_id)
except errors.InvalidRevisionId:
return {}
return mapping.vcs.show_foreign_revid(foreign_revid)
class ForeignVcs(object):
"""A foreign version control system."""
def __init__(self, mapping_registry):
self.mapping_registry = mapping_registry
def show_foreign_revid(self, foreign_revid):
"""Prepare a foreign revision id for formatting using bzr log.
:param foreign_revid: Foreign revision id.
:return: Dictionary mapping string keys to string values.
"""
return { }
class ForeignVcsRegistry(registry.Registry):
"""Registry for Foreign VCSes.
There should be one entry per foreign VCS. Example entries would be
"git", "svn", "hg", "darcs", etc.
"""
def register(self, key, foreign_vcs, help):
"""Register a foreign VCS.
:param key: Prefix of the foreign VCS in revision ids
:param foreign_vcs: ForeignVCS instance
:param help: Description of the foreign VCS
"""
if ":" in key or "-" in key:
raise ValueError("vcs name can not contain : or -")
registry.Registry.register(self, key, foreign_vcs, help)
def parse_revision_id(self, revid):
"""Parse a bzr revision and return the matching mapping and foreign
revid.
:param revid: The bzr revision id
:return: tuple with foreign revid and vcs mapping
"""
if not "-" in revid:
raise errors.InvalidRevisionId(revid, None)
try:
foreign_vcs = self.get(revid.split("-")[0])
except KeyError:
raise errors.InvalidRevisionId(revid, None)
return foreign_vcs.mapping_registry.revision_id_bzr_to_foreign(revid)
foreign_vcs_registry = ForeignVcsRegistry()
class ForeignRepository(Repository):
"""A Repository that exists in a foreign version control system.
The data in this repository can not be represented natively using
Bazaars internal datastructures, but have to converted using a VcsMapping.
"""
# This repository's native version control system
vcs = None
def has_foreign_revision(self, foreign_revid):
"""Check whether the specified foreign revision is present.
:param foreign_revid: A foreign revision id, in the format used
by this Repository's VCS.
"""
raise NotImplementedError(self.has_foreign_revision)
def lookup_bzr_revision_id(self, revid):
"""Lookup a mapped or roundtripped revision by revision id.
:param revid: Bazaar revision id
:return: Tuple with foreign revision id and mapping.
"""
raise NotImplementedError(self.lookup_revision_id)
def all_revision_ids(self, mapping=None):
"""See Repository.all_revision_ids()."""
raise NotImplementedError(self.all_revision_ids)
def get_default_mapping(self):
"""Get the default mapping for this repository."""
raise NotImplementedError(self.get_default_mapping)
def get_inventory_xml(self, revision_id):
"""See Repository.get_inventory_xml()."""
return self.serialise_inventory(self.get_inventory(revision_id))
def get_inventory_sha1(self, revision_id):
"""Get the sha1 for the XML representation of an inventory.
:param revision_id: Revision id of the inventory for which to return
the SHA1.
:return: XML string
"""
return osutils.sha_string(self.get_inventory_xml(revision_id))
def get_revision_xml(self, revision_id):
"""Return the XML representation of a revision.
:param revision_id: Revision for which to return the XML.
:return: XML string
"""
return self._serializer.write_revision_to_string(
self.get_revision(revision_id))
|