80
_file_ids_altered_regex = lazy_regex.lazy_compile(
81
r'file_id="(?P<file_id>[^"]+)"'
82
r'.*revision="(?P<revision_id>[^"]+)"'
86
def add_inventory(self, revision_id, inv, parents):
87
"""Add the inventory inv to the repository as revision_id.
89
:param parents: The revision ids of the parents that revision_id
90
is known to have and are in the repository already.
92
returns the sha1 of the serialized inventory.
94
revision_id = osutils.safe_revision_id(revision_id)
95
_mod_revision.check_not_reserved_id(revision_id)
96
assert inv.revision_id is None or inv.revision_id == revision_id, \
97
"Mismatch between inventory revision" \
98
" id and insertion revid (%r, %r)" % (inv.revision_id, revision_id)
99
assert inv.root is not None
100
inv_text = self.serialise_inventory(inv)
101
inv_sha1 = osutils.sha_string(inv_text)
102
inv_vf = self.control_weaves.get_weave('inventory',
103
self.get_transaction())
104
self._inventory_add_lines(inv_vf, revision_id, parents,
105
osutils.split_lines(inv_text))
108
def _inventory_add_lines(self, inv_vf, revision_id, parents, lines):
110
for parent in parents:
112
final_parents.append(parent)
114
inv_vf.add_lines(revision_id, final_parents, lines)
117
def add_revision(self, revision_id, rev, inv=None, config=None):
118
"""Add rev to the revision store as revision_id.
120
:param revision_id: the revision id to use.
121
:param rev: The revision object.
122
:param inv: The inventory for the revision. if None, it will be looked
123
up in the inventory storer
124
:param config: If None no digital signature will be created.
125
If supplied its signature_needed method will be used
126
to determine if a signature should be made.
128
revision_id = osutils.safe_revision_id(revision_id)
129
# TODO: jam 20070210 Shouldn't we check rev.revision_id and
131
_mod_revision.check_not_reserved_id(revision_id)
132
if config is not None and config.signature_needed():
134
inv = self.get_inventory(revision_id)
135
plaintext = Testament(rev, inv).as_short_text()
136
self.store_revision_signature(
137
gpg.GPGStrategy(config), plaintext, revision_id)
138
if not revision_id in self.get_inventory_weave():
140
raise errors.WeaveRevisionNotPresent(revision_id,
141
self.get_inventory_weave())
143
# yes, this is not suitable for adding with ghosts.
144
self.add_inventory(revision_id, inv, rev.parent_ids)
145
self._revision_store.add_revision(rev, self.get_transaction())
147
def _add_revision_text(self, revision_id, text):
148
revision = self._revision_store._serializer.read_revision_from_string(
150
self._revision_store._add_revision(revision, StringIO(text),
151
self.get_transaction())
54
154
def _all_possible_ids(self):
55
155
"""Return all the possible revisions that we could find."""
56
return self.get_inventory_weave().names()
156
return self.get_inventory_weave().versions()
59
158
def all_revision_ids(self):
60
159
"""Returns a list of all the revision ids in the repository.
161
This is deprecated because code should generally work on the graph
162
reachable from a particular revision, and ignore any other revisions
163
that might be present. There is no direct replacement method.
165
return self._all_revision_ids()
168
def _all_revision_ids(self):
169
"""Returns a list of all the revision ids in the repository.
62
171
These are in as much topological order as the underlying store can
63
172
present: for weaves ghosts may lead to a lack of correctness until
64
173
the reweave updates the parents list.
175
if self._revision_store.text_store.listable():
176
return self._revision_store.all_revision_ids(self.get_transaction())
66
177
result = self._all_possible_ids()
178
# TODO: jam 20070210 Ensure that _all_possible_ids returns non-unicode
179
# ids. (It should, since _revision_store's API should change to
180
# return utf8 revision_ids)
67
181
return self._eliminate_revisions_not_present(result)
183
def break_lock(self):
184
"""Break a lock if one is present from another instance.
186
Uses the ui factory to ask for confirmation if the lock may be from
189
self.control_files.break_lock()
70
192
def _eliminate_revisions_not_present(self, revision_ids):
71
193
"""Check every revision id in revision_ids to see if we have it.
93
215
getting file texts, inventories and revisions, then
94
216
this construct will accept instances of those things.
218
super(Repository, self).__init__()
97
219
self._format = _format
98
220
# the following are part of the public API for Repository:
99
221
self.bzrdir = a_bzrdir
100
222
self.control_files = control_files
101
self.revision_store = revision_store
103
def lock_write(self):
104
self.control_files.lock_write()
223
self._revision_store = _revision_store
224
self.text_store = text_store
225
# backwards compatibility
226
self.weave_store = text_store
227
# not right yet - should be more semantically clear ?
229
self.control_store = control_store
230
self.control_weaves = control_store
231
# TODO: make sure to construct the right store classes, etc, depending
232
# on whether escaping is required.
233
self._warn_if_deprecated()
236
return '%s(%r)' % (self.__class__.__name__,
237
self.bzrdir.transport.base)
240
return self.control_files.is_locked()
242
def lock_write(self, token=None):
243
"""Lock this repository for writing.
245
:param token: if this is already locked, then lock_write will fail
246
unless the token matches the existing lock.
247
:returns: a token if this instance supports tokens, otherwise None.
248
:raises TokenLockingNotSupported: when a token is given but this
249
instance doesn't support using token locks.
250
:raises MismatchedToken: if the specified token doesn't match the token
251
of the existing lock.
253
A token should be passed in if you know that you have locked the object
254
some other way, and need to synchronise this object's state with that
257
XXX: this docstring is duplicated in many places, e.g. lockable_files.py
259
return self.control_files.lock_write(token=token)
106
261
def lock_read(self):
107
262
self.control_files.lock_read()
264
def get_physical_lock_status(self):
265
return self.control_files.get_physical_lock_status()
267
def leave_lock_in_place(self):
268
"""Tell this repository not to release the physical lock when this
271
If lock_write doesn't return a token, then this method is not supported.
273
self.control_files.leave_in_place()
275
def dont_leave_lock_in_place(self):
276
"""Tell this repository to release the physical lock when this
277
object is unlocked, even if it didn't originally acquire it.
279
If lock_write doesn't return a token, then this method is not supported.
281
self.control_files.dont_leave_in_place()
284
def gather_stats(self, revid=None, committers=None):
285
"""Gather statistics from a revision id.
287
:param revid: The revision id to gather statistics from, if None, then
288
no revision specific statistics are gathered.
289
:param committers: Optional parameter controlling whether to grab
290
a count of committers from the revision specific statistics.
291
:return: A dictionary of statistics. Currently this contains:
292
committers: The number of committers if requested.
293
firstrev: A tuple with timestamp, timezone for the penultimate left
294
most ancestor of revid, if revid is not the NULL_REVISION.
295
latestrev: A tuple with timestamp, timezone for revid, if revid is
296
not the NULL_REVISION.
297
revisions: The total revision count in the repository.
298
size: An estimate disk size of the repository in bytes.
301
if revid and committers:
302
result['committers'] = 0
303
if revid and revid != _mod_revision.NULL_REVISION:
305
all_committers = set()
306
revisions = self.get_ancestry(revid)
307
# pop the leading None
309
first_revision = None
311
# ignore the revisions in the middle - just grab first and last
312
revisions = revisions[0], revisions[-1]
313
for revision in self.get_revisions(revisions):
314
if not first_revision:
315
first_revision = revision
317
all_committers.add(revision.committer)
318
last_revision = revision
320
result['committers'] = len(all_committers)
321
result['firstrev'] = (first_revision.timestamp,
322
first_revision.timezone)
323
result['latestrev'] = (last_revision.timestamp,
324
last_revision.timezone)
326
# now gather global repository information
327
if self.bzrdir.root_transport.listable():
328
c, t = self._revision_store.total_size(self.get_transaction())
329
result['revisions'] = c
110
334
def missing_revision_ids(self, other, revision_id=None):
111
335
"""Return the revision ids that other has that this does not.
123
348
For instance, if the repository is at URL/.bzr/repository,
124
349
Repository.open(URL) -> a Repository instance.
126
control = bzrlib.bzrdir.BzrDir.open(base)
351
control = bzrdir.BzrDir.open(base)
127
352
return control.open_repository()
129
def copy_content_into(self, destination, revision_id=None, basis=None):
354
def copy_content_into(self, destination, revision_id=None):
130
355
"""Make a complete copy of the content in self into destination.
132
357
This is a destructive operation! Do not use it on existing
135
return InterRepository.get(self, destination).copy_content(revision_id, basis)
360
revision_id = osutils.safe_revision_id(revision_id)
361
return InterRepository.get(self, destination).copy_content(revision_id)
137
363
def fetch(self, source, revision_id=None, pb=None):
138
364
"""Fetch the content required to construct revision_id from source.
140
366
If revision_id is None all content is copied.
142
return InterRepository.get(source, self).fetch(revision_id=revision_id,
368
revision_id = osutils.safe_revision_id(revision_id)
369
inter = InterRepository.get(source, self)
371
return inter.fetch(revision_id=revision_id, pb=pb)
372
except NotImplementedError:
373
raise errors.IncompatibleRepositories(source, self)
375
def create_bundle(self, target, base, fileobj, format=None):
376
return serializer.write_bundle(self, target, base, fileobj, format)
378
def get_commit_builder(self, branch, parents, config, timestamp=None,
379
timezone=None, committer=None, revprops=None,
381
"""Obtain a CommitBuilder for this repository.
383
:param branch: Branch to commit to.
384
:param parents: Revision ids of the parents of the new revision.
385
:param config: Configuration to use.
386
:param timestamp: Optional timestamp recorded for commit.
387
:param timezone: Optional timezone for timestamp.
388
:param committer: Optional committer to set for commit.
389
:param revprops: Optional dictionary of revision properties.
390
:param revision_id: Optional revision id.
392
revision_id = osutils.safe_revision_id(revision_id)
393
return _CommitBuilder(self, parents, config, timestamp, timezone,
394
committer, revprops, revision_id)
145
396
def unlock(self):
146
397
self.control_files.unlock()
149
def clone(self, a_bzrdir, revision_id=None, basis=None):
400
def clone(self, a_bzrdir, revision_id=None):
150
401
"""Clone this repository into a_bzrdir using the current format.
152
403
Currently no check is made that the format of this repository and
153
404
the bzrdir format are compatible. FIXME RBC 20060201.
406
:return: The newly created destination repository.
408
# TODO: deprecate after 0.16; cloning this with all its settings is
409
# probably not very useful -- mbp 20070423
410
dest_repo = self._create_sprouting_repo(a_bzrdir, shared=self.is_shared())
411
self.copy_content_into(dest_repo, revision_id)
415
def sprout(self, to_bzrdir, revision_id=None):
416
"""Create a descendent repository for new development.
418
Unlike clone, this does not copy the settings of the repository.
420
dest_repo = self._create_sprouting_repo(to_bzrdir, shared=False)
421
dest_repo.fetch(self, revision_id=revision_id)
424
def _create_sprouting_repo(self, a_bzrdir, shared):
155
425
if not isinstance(a_bzrdir._format, self.bzrdir._format.__class__):
156
426
# use target default format.
157
result = a_bzrdir.create_repository()
158
# FIXME RBC 20060209 split out the repository type to avoid this check ?
159
elif isinstance(a_bzrdir._format,
160
(bzrlib.bzrdir.BzrDirFormat4,
161
bzrlib.bzrdir.BzrDirFormat5,
162
bzrlib.bzrdir.BzrDirFormat6)):
163
result = a_bzrdir.open_repository()
427
dest_repo = a_bzrdir.create_repository()
165
result = self._format.initialize(a_bzrdir, shared=self.is_shared())
166
self.copy_content_into(result, revision_id, basis)
429
# Most control formats need the repository to be specifically
430
# created, but on some old all-in-one formats it's not needed
432
dest_repo = self._format.initialize(a_bzrdir, shared=shared)
433
except errors.UninitializableFormat:
434
dest_repo = a_bzrdir.open_repository()
169
438
def has_revision(self, revision_id):
170
"""True if this branch has a copy of the revision.
172
This does not necessarily imply the revision is merge
173
or on the mainline."""
174
return (revision_id is None
175
or self.revision_store.has_id(revision_id))
439
"""True if this repository has a copy of the revision."""
440
revision_id = osutils.safe_revision_id(revision_id)
441
return self._revision_store.has_revision_id(revision_id,
442
self.get_transaction())
178
def get_revision_xml_file(self, revision_id):
179
"""Return XML file object for revision object."""
445
def get_revision_reconcile(self, revision_id):
446
"""'reconcile' helper routine that allows access to a revision always.
448
This variant of get_revision does not cross check the weave graph
449
against the revision one as get_revision does: but it should only
450
be used by reconcile, or reconcile-alike commands that are correcting
451
or testing the revision graph.
180
453
if not revision_id or not isinstance(revision_id, basestring):
181
raise InvalidRevisionId(revision_id=revision_id, branch=self)
183
return self.revision_store.get(revision_id)
184
except (IndexError, KeyError):
185
raise bzrlib.errors.NoSuchRevision(self, revision_id)
454
raise errors.InvalidRevisionId(revision_id=revision_id,
456
return self.get_revisions([revision_id])[0]
459
def get_revisions(self, revision_ids):
460
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
461
revs = self._revision_store.get_revisions(revision_ids,
462
self.get_transaction())
464
assert not isinstance(rev.revision_id, unicode)
465
for parent_id in rev.parent_ids:
466
assert not isinstance(parent_id, unicode)
188
470
def get_revision_xml(self, revision_id):
189
return self.get_revision_xml_file(revision_id).read()
471
# TODO: jam 20070210 This shouldn't be necessary since get_revision
472
# would have already do it.
473
# TODO: jam 20070210 Just use _serializer.write_revision_to_string()
474
revision_id = osutils.safe_revision_id(revision_id)
475
rev = self.get_revision(revision_id)
477
# the current serializer..
478
self._revision_store._serializer.write_revision(rev, rev_tmp)
480
return rev_tmp.getvalue()
192
483
def get_revision(self, revision_id):
193
484
"""Return the Revision object for a named revision"""
194
xml_file = self.get_revision_xml_file(revision_id)
197
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
198
except SyntaxError, e:
199
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
203
assert r.revision_id == revision_id
485
# TODO: jam 20070210 get_revision_reconcile should do this for us
486
revision_id = osutils.safe_revision_id(revision_id)
487
r = self.get_revision_reconcile(revision_id)
488
# weave corruption can lead to absent revision markers that should be
490
# the following test is reasonably cheap (it needs a single weave read)
491
# and the weave is cached in read transactions. In write transactions
492
# it is not cached but typically we only read a small number of
493
# revisions. For knits when they are introduced we will probably want
494
# to ensure that caching write transactions are in use.
495
inv = self.get_inventory_weave()
496
self._check_revision_parents(r, inv)
207
def get_revision_sha1(self, revision_id):
208
"""Hash the stored value of a revision, and return it."""
209
# In the future, revision entries will be signed. At that
210
# point, it is probably best *not* to include the signature
211
# in the revision hash. Because that lets you re-sign
212
# the revision, (add signatures/remove signatures) and still
213
# have all hash pointers stay consistent.
214
# But for now, just hash the contents.
215
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
500
def get_deltas_for_revisions(self, revisions):
501
"""Produce a generator of revision deltas.
503
Note that the input is a sequence of REVISIONS, not revision_ids.
504
Trees will be held in memory until the generator exits.
505
Each delta is relative to the revision's lefthand predecessor.
507
required_trees = set()
508
for revision in revisions:
509
required_trees.add(revision.revision_id)
510
required_trees.update(revision.parent_ids[:1])
511
trees = dict((t.get_revision_id(), t) for
512
t in self.revision_trees(required_trees))
513
for revision in revisions:
514
if not revision.parent_ids:
515
old_tree = self.revision_tree(None)
517
old_tree = trees[revision.parent_ids[0]]
518
yield trees[revision.revision_id].changes_from(old_tree)
521
def get_revision_delta(self, revision_id):
522
"""Return the delta for one revision.
524
The delta is relative to the left-hand predecessor of the
527
r = self.get_revision(revision_id)
528
return list(self.get_deltas_for_revisions([r]))[0]
530
def _check_revision_parents(self, revision, inventory):
531
"""Private to Repository and Fetch.
533
This checks the parentage of revision in an inventory weave for
534
consistency and is only applicable to inventory-weave-for-ancestry
535
using repository formats & fetchers.
537
weave_parents = inventory.get_parents(revision.revision_id)
538
weave_names = inventory.versions()
539
for parent_id in revision.parent_ids:
540
if parent_id in weave_names:
541
# this parent must not be a ghost.
542
if not parent_id in weave_parents:
544
raise errors.CorruptRepository(self)
217
546
@needs_write_lock
218
547
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
219
self.revision_store.add(StringIO(gpg_strategy.sign(plaintext)),
222
def fileid_involved_between_revs(self, from_revid, to_revid):
223
"""Find file_id(s) which are involved in the changes between revisions.
225
This determines the set of revisions which are involved, and then
226
finds all file ids affected by those revisions.
228
# TODO: jam 20060119 This code assumes that w.inclusions will
229
# always be correct. But because of the presence of ghosts
230
# it is possible to be wrong.
231
# One specific example from Robert Collins:
232
# Two branches, with revisions ABC, and AD
233
# C is a ghost merge of D.
234
# Inclusions doesn't recognize D as an ancestor.
235
# If D is ever merged in the future, the weave
236
# won't be fixed, because AD never saw revision C
237
# to cause a conflict which would force a reweave.
238
w = self.get_inventory_weave()
239
from_set = set(w.inclusions([w.lookup(from_revid)]))
240
to_set = set(w.inclusions([w.lookup(to_revid)]))
241
included = to_set.difference(from_set)
242
changed = map(w.idx_to_name, included)
243
return self._fileid_involved_by_set(changed)
245
def fileid_involved(self, last_revid=None):
246
"""Find all file_ids modified in the ancestry of last_revid.
248
:param last_revid: If None, last_revision() will be used.
250
w = self.get_inventory_weave()
252
changed = set(w._names)
254
included = w.inclusions([w.lookup(last_revid)])
255
changed = map(w.idx_to_name, included)
256
return self._fileid_involved_by_set(changed)
258
def fileid_involved_by_set(self, changes):
259
"""Find all file_ids modified by the set of revisions passed in.
261
:param changes: A set() of revision ids
263
# TODO: jam 20060119 This line does *nothing*, remove it.
264
# or better yet, change _fileid_involved_by_set so
265
# that it takes the inventory weave, rather than
266
# pulling it out by itself.
267
return self._fileid_involved_by_set(changes)
269
def _fileid_involved_by_set(self, changes):
270
"""Find the set of file-ids affected by the set of revisions.
272
:param changes: A set() of revision ids.
273
:return: A set() of file ids.
275
This peaks at the Weave, interpreting each line, looking to
276
see if it mentions one of the revisions. And if so, includes
277
the file id mentioned.
278
This expects both the Weave format, and the serialization
279
to have a single line per file/directory, and to have
280
fileid="" and revision="" on that line.
282
assert isinstance(self._format, (RepositoryFormat5,
285
RepositoryFormatKnit1)), \
286
"fileid_involved only supported for branches which store inventory as unnested xml"
288
w = self.get_inventory_weave()
290
for line in w._weave:
292
# it is ugly, but it is due to the weave structure
293
if not isinstance(line, basestring): continue
295
start = line.find('file_id="')+9
296
if start < 9: continue
297
end = line.find('"', start)
299
file_id = xml.sax.saxutils.unescape(line[start:end])
301
# check if file_id is already present
302
if file_id in file_ids: continue
304
start = line.find('revision="')+10
305
if start < 10: continue
306
end = line.find('"', start)
308
revision_id = xml.sax.saxutils.unescape(line[start:end])
310
if revision_id in changes:
311
file_ids.add(file_id)
548
revision_id = osutils.safe_revision_id(revision_id)
549
signature = gpg_strategy.sign(plaintext)
550
self._revision_store.add_revision_signature_text(revision_id,
552
self.get_transaction())
554
def fileids_altered_by_revision_ids(self, revision_ids):
555
"""Find the file ids and versions affected by revisions.
557
:param revisions: an iterable containing revision ids.
558
:return: a dictionary mapping altered file-ids to an iterable of
559
revision_ids. Each altered file-ids has the exact revision_ids that
560
altered it listed explicitly.
562
assert self._serializer.support_altered_by_hack, \
563
("fileids_altered_by_revision_ids only supported for branches "
564
"which store inventory as unnested xml, not on %r" % self)
565
selected_revision_ids = set(osutils.safe_revision_id(r)
566
for r in revision_ids)
567
w = self.get_inventory_weave()
570
# this code needs to read every new line in every inventory for the
571
# inventories [revision_ids]. Seeing a line twice is ok. Seeing a line
572
# not present in one of those inventories is unnecessary but not
573
# harmful because we are filtering by the revision id marker in the
574
# inventory lines : we only select file ids altered in one of those
575
# revisions. We don't need to see all lines in the inventory because
576
# only those added in an inventory in rev X can contain a revision=X
578
unescape_revid_cache = {}
579
unescape_fileid_cache = {}
581
# jam 20061218 In a big fetch, this handles hundreds of thousands
582
# of lines, so it has had a lot of inlining and optimizing done.
583
# Sorry that it is a little bit messy.
584
# Move several functions to be local variables, since this is a long
586
search = self._file_ids_altered_regex.search
587
unescape = _unescape_xml
588
setdefault = result.setdefault
589
pb = ui.ui_factory.nested_progress_bar()
591
for line in w.iter_lines_added_or_present_in_versions(
592
selected_revision_ids, pb=pb):
596
# One call to match.group() returning multiple items is quite a
597
# bit faster than 2 calls to match.group() each returning 1
598
file_id, revision_id = match.group('file_id', 'revision_id')
600
# Inlining the cache lookups helps a lot when you make 170,000
601
# lines and 350k ids, versus 8.4 unique ids.
602
# Using a cache helps in 2 ways:
603
# 1) Avoids unnecessary decoding calls
604
# 2) Re-uses cached strings, which helps in future set and
606
# (2) is enough that removing encoding entirely along with
607
# the cache (so we are using plain strings) results in no
608
# performance improvement.
610
revision_id = unescape_revid_cache[revision_id]
612
unescaped = unescape(revision_id)
613
unescape_revid_cache[revision_id] = unescaped
614
revision_id = unescaped
616
if revision_id in selected_revision_ids:
618
file_id = unescape_fileid_cache[file_id]
620
unescaped = unescape(file_id)
621
unescape_fileid_cache[file_id] = unescaped
623
setdefault(file_id, set()).add(revision_id)
315
629
def get_inventory_weave(self):
320
634
def get_inventory(self, revision_id):
321
635
"""Get Inventory object by hash."""
322
xml = self.get_inventory_xml(revision_id)
323
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
636
# TODO: jam 20070210 Technically we don't need to sanitize, since all
637
# called functions must sanitize.
638
revision_id = osutils.safe_revision_id(revision_id)
639
return self.deserialise_inventory(
640
revision_id, self.get_inventory_xml(revision_id))
642
def deserialise_inventory(self, revision_id, xml):
643
"""Transform the xml into an inventory object.
645
:param revision_id: The expected revision id of the inventory.
646
:param xml: A serialised inventory.
648
revision_id = osutils.safe_revision_id(revision_id)
649
result = self._serializer.read_inventory_from_string(xml)
650
result.root.revision = revision_id
653
def serialise_inventory(self, inv):
654
return self._serializer.write_inventory_to_string(inv)
656
def get_serializer_format(self):
657
return self._serializer.format_num
326
660
def get_inventory_xml(self, revision_id):
327
661
"""Get inventory XML as a file object."""
662
revision_id = osutils.safe_revision_id(revision_id)
329
assert isinstance(revision_id, basestring), type(revision_id)
664
assert isinstance(revision_id, str), type(revision_id)
330
665
iw = self.get_inventory_weave()
331
return iw.get_text(iw.lookup(revision_id))
666
return iw.get_text(revision_id)
332
667
except IndexError:
333
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
668
raise errors.HistoryMissing(self, 'inventory', revision_id)
336
671
def get_inventory_sha1(self, revision_id):
337
672
"""Return the sha1 hash of the inventory entry
674
# TODO: jam 20070210 Shouldn't this be deprecated / removed?
675
revision_id = osutils.safe_revision_id(revision_id)
339
676
return self.get_revision(revision_id).inventory_sha1
679
def get_revision_graph(self, revision_id=None):
680
"""Return a dictionary containing the revision graph.
682
:param revision_id: The revision_id to get a graph from. If None, then
683
the entire revision graph is returned. This is a deprecated mode of
684
operation and will be removed in the future.
685
:return: a dictionary of revision_id->revision_parents_list.
687
# special case NULL_REVISION
688
if revision_id == _mod_revision.NULL_REVISION:
690
revision_id = osutils.safe_revision_id(revision_id)
691
a_weave = self.get_inventory_weave()
692
all_revisions = self._eliminate_revisions_not_present(
694
entire_graph = dict([(node, tuple(a_weave.get_parents(node))) for
695
node in all_revisions])
696
if revision_id is None:
698
elif revision_id not in entire_graph:
699
raise errors.NoSuchRevision(self, revision_id)
701
# add what can be reached from revision_id
703
pending = set([revision_id])
704
while len(pending) > 0:
706
result[node] = entire_graph[node]
707
for revision_id in result[node]:
708
if revision_id not in result:
709
pending.add(revision_id)
713
def get_revision_graph_with_ghosts(self, revision_ids=None):
714
"""Return a graph of the revisions with ghosts marked as applicable.
716
:param revision_ids: an iterable of revisions to graph or None for all.
717
:return: a Graph object with the graph reachable from revision_ids.
719
result = deprecated_graph.Graph()
721
pending = set(self.all_revision_ids())
724
pending = set(osutils.safe_revision_id(r) for r in revision_ids)
725
# special case NULL_REVISION
726
if _mod_revision.NULL_REVISION in pending:
727
pending.remove(_mod_revision.NULL_REVISION)
728
required = set(pending)
731
revision_id = pending.pop()
733
rev = self.get_revision(revision_id)
734
except errors.NoSuchRevision:
735
if revision_id in required:
738
result.add_ghost(revision_id)
740
for parent_id in rev.parent_ids:
741
# is this queued or done ?
742
if (parent_id not in pending and
743
parent_id not in done):
745
pending.add(parent_id)
746
result.add_node(revision_id, rev.parent_ids)
747
done.add(revision_id)
750
def _get_history_vf(self):
751
"""Get a versionedfile whose history graph reflects all revisions.
753
For weave repositories, this is the inventory weave.
755
return self.get_inventory_weave()
757
def iter_reverse_revision_history(self, revision_id):
758
"""Iterate backwards through revision ids in the lefthand history
760
:param revision_id: The revision id to start with. All its lefthand
761
ancestors will be traversed.
763
revision_id = osutils.safe_revision_id(revision_id)
764
if revision_id in (None, _mod_revision.NULL_REVISION):
766
next_id = revision_id
767
versionedfile = self._get_history_vf()
770
parents = versionedfile.get_parents(next_id)
771
if len(parents) == 0:
342
777
def get_revision_inventory(self, revision_id):
343
778
"""Return inventory of a past revision."""
344
779
# TODO: Unify this with get_inventory()
358
793
def is_shared(self):
359
794
"""Return True if this repository is flagged as a shared repository."""
360
# FIXME format 4-6 cannot be shared, this is technically faulty.
361
return self.control_files._transport.has('shared-storage')
795
raise NotImplementedError(self.is_shared)
798
def reconcile(self, other=None, thorough=False):
799
"""Reconcile this repository."""
800
from bzrlib.reconcile import RepoReconciler
801
reconciler = RepoReconciler(self, thorough=thorough)
802
reconciler.reconcile()
364
806
def revision_tree(self, revision_id):
365
807
"""Return Tree for a revision on this branch.
367
`revision_id` may be None for the null revision, in which case
368
an `EmptyTree` is returned."""
809
`revision_id` may be None for the empty tree revision.
369
811
# TODO: refactor this to use an existing revision object
370
812
# so we don't need to read it in twice.
371
if revision_id is None or revision_id == NULL_REVISION:
813
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
814
return RevisionTree(self, Inventory(root_id=None),
815
_mod_revision.NULL_REVISION)
817
revision_id = osutils.safe_revision_id(revision_id)
374
818
inv = self.get_revision_inventory(revision_id)
375
819
return RevisionTree(self, inv, revision_id)
378
def get_ancestry(self, revision_id):
822
def revision_trees(self, revision_ids):
823
"""Return Tree for a revision on this branch.
825
`revision_id` may not be None or 'null:'"""
826
assert None not in revision_ids
827
assert _mod_revision.NULL_REVISION not in revision_ids
828
texts = self.get_inventory_weave().get_texts(revision_ids)
829
for text, revision_id in zip(texts, revision_ids):
830
inv = self.deserialise_inventory(revision_id, text)
831
yield RevisionTree(self, inv, revision_id)
834
def get_ancestry(self, revision_id, topo_sorted=True):
379
835
"""Return a list of revision-ids integrated by a revision.
837
The first element of the list is always None, indicating the origin
838
revision. This might change when we have history horizons, or
839
perhaps we should have a new API.
381
841
This is topologically sorted.
383
if revision_id is None:
843
if _mod_revision.is_null(revision_id):
845
revision_id = osutils.safe_revision_id(revision_id)
385
846
if not self.has_revision(revision_id):
386
847
raise errors.NoSuchRevision(self, revision_id)
387
848
w = self.get_inventory_weave()
388
return [None] + map(w.idx_to_name,
389
w.inclusions([w.lookup(revision_id)]))
849
candidates = w.get_ancestry(revision_id, topo_sorted)
850
return [None] + candidates # self._eliminate_revisions_not_present(candidates)
853
"""Compress the data within the repository.
855
This operation only makes sense for some repository types. For other
856
types it should be a no-op that just returns.
858
This stub method does not require a lock, but subclasses should use
859
@needs_write_lock as this is a long running call its reasonable to
860
implicitly lock for the user.
392
864
def print_file(self, file, revision_id):
426
926
:param new_value: True to restore the default, False to disable making
429
# FIXME: split out into a new class/strategy ?
430
if isinstance(self._format, (RepositoryFormat4,
433
raise NotImplementedError(self.set_make_working_trees)
436
self.control_files._transport.delete('no-working-trees')
437
except errors.NoSuchFile:
440
self.control_files.put_utf8('no-working-trees', '')
929
raise NotImplementedError(self.set_make_working_trees)
442
931
def make_working_trees(self):
443
932
"""Returns the policy for making working trees on new branches."""
444
# FIXME: split out into a new class/strategy ?
445
if isinstance(self._format, (RepositoryFormat4,
449
return not self.control_files._transport.has('no-working-trees')
933
raise NotImplementedError(self.make_working_trees)
451
935
@needs_write_lock
452
936
def sign_revision(self, revision_id, gpg_strategy):
937
revision_id = osutils.safe_revision_id(revision_id)
453
938
plaintext = Testament.from_revision(self, revision_id).as_short_text()
454
939
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
457
class AllInOneRepository(Repository):
458
"""Legacy support - the repository behaviour for all-in-one branches."""
460
def __init__(self, _format, a_bzrdir, revision_store):
461
# we reuse one control files instance.
462
dir_mode = a_bzrdir._control_files._dir_mode
463
file_mode = a_bzrdir._control_files._file_mode
465
def get_weave(name, prefixed=False):
467
name = safe_unicode(name)
942
def has_signature_for_revision_id(self, revision_id):
943
"""Query for a revision signature for revision_id in the repository."""
944
revision_id = osutils.safe_revision_id(revision_id)
945
return self._revision_store.has_signature(revision_id,
946
self.get_transaction())
949
def get_signature_text(self, revision_id):
950
"""Return the text for a signature."""
951
revision_id = osutils.safe_revision_id(revision_id)
952
return self._revision_store.get_signature_text(revision_id,
953
self.get_transaction())
956
def check(self, revision_ids):
957
"""Check consistency of all history of given revision_ids.
959
Different repository implementations should override _check().
961
:param revision_ids: A non-empty list of revision_ids whose ancestry
962
will be checked. Typically the last revision_id of a branch.
965
raise ValueError("revision_ids must be non-empty in %s.check"
967
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
968
return self._check(revision_ids)
970
def _check(self, revision_ids):
971
result = check.Check(self)
975
def _warn_if_deprecated(self):
976
global _deprecation_warning_done
977
if _deprecation_warning_done:
979
_deprecation_warning_done = True
980
warning("Format %s for %s is deprecated - please use 'bzr upgrade' to get better performance"
981
% (self._format, self.bzrdir.transport.base))
983
def supports_rich_root(self):
984
return self._format.rich_root_data
986
def _check_ascii_revisionid(self, revision_id, method):
987
"""Private helper for ascii-only repositories."""
988
# weave repositories refuse to store revisionids that are non-ascii.
989
if revision_id is not None:
990
# weaves require ascii revision ids.
991
if isinstance(revision_id, unicode):
993
revision_id.encode('ascii')
994
except UnicodeEncodeError:
995
raise errors.NonAsciiRevisionId(method, self)
470
relpath = a_bzrdir._control_files._escape(name)
471
weave_transport = a_bzrdir._control_files._transport.clone(relpath)
472
ws = WeaveStore(weave_transport, prefixed=prefixed,
475
if a_bzrdir._control_files._transport.should_cache():
476
ws.enable_cache = True
479
def get_store(name, compressed=True, prefixed=False):
480
# FIXME: This approach of assuming stores are all entirely compressed
481
# or entirely uncompressed is tidy, but breaks upgrade from
482
# some existing branches where there's a mixture; we probably
483
# still want the option to look for both.
484
relpath = a_bzrdir._control_files._escape(name)
485
store = TextStore(a_bzrdir._control_files._transport.clone(relpath),
486
prefixed=prefixed, compressed=compressed,
489
#if self._transport.should_cache():
490
# cache_path = os.path.join(self.cache_root, name)
491
# os.mkdir(cache_path)
492
# store = bzrlib.store.CachedStore(store, cache_path)
495
# not broken out yet because the controlweaves|inventory_store
496
# and text_store | weave_store bits are still different.
497
if isinstance(_format, RepositoryFormat4):
498
self.inventory_store = get_store('inventory-store')
499
self.text_store = get_store('text-store')
500
elif isinstance(_format, RepositoryFormat5):
501
self.control_weaves = get_weave('')
502
self.weave_store = get_weave('weaves')
503
elif isinstance(_format, RepositoryFormat6):
504
self.control_weaves = get_weave('')
505
self.weave_store = get_weave('weaves', prefixed=True)
998
revision_id.decode('ascii')
999
except UnicodeDecodeError:
1000
raise errors.NonAsciiRevisionId(method, self)
1004
# remove these delegates a while after bzr 0.15
1005
def __make_delegated(name, from_module):
1006
def _deprecated_repository_forwarder():
1007
symbol_versioning.warn('%s moved to %s in bzr 0.15'
1008
% (name, from_module),
1011
m = __import__(from_module, globals(), locals(), [name])
1013
return getattr(m, name)
1014
except AttributeError:
1015
raise AttributeError('module %s has no name %s'
1017
globals()[name] = _deprecated_repository_forwarder
1020
'AllInOneRepository',
1021
'WeaveMetaDirRepository',
1022
'PreSplitOutRepositoryFormat',
1023
'RepositoryFormat4',
1024
'RepositoryFormat5',
1025
'RepositoryFormat6',
1026
'RepositoryFormat7',
1028
__make_delegated(_name, 'bzrlib.repofmt.weaverepo')
1032
'RepositoryFormatKnit',
1033
'RepositoryFormatKnit1',
1035
__make_delegated(_name, 'bzrlib.repofmt.knitrepo')
1038
def install_revision(repository, rev, revision_tree):
1039
"""Install all revision data into a repository."""
1040
present_parents = []
1042
for p_id in rev.parent_ids:
1043
if repository.has_revision(p_id):
1044
present_parents.append(p_id)
1045
parent_trees[p_id] = repository.revision_tree(p_id)
507
raise errors.BzrError('unreachable code: unexpected repository'
509
revision_store.register_suffix('sig')
510
super(AllInOneRepository, self).__init__(_format, a_bzrdir, a_bzrdir._control_files, revision_store)
1047
parent_trees[p_id] = repository.revision_tree(None)
1049
inv = revision_tree.inventory
1050
entries = inv.iter_entries()
1051
# backwards compatability hack: skip the root id.
1052
if not repository.supports_rich_root():
1053
path, root = entries.next()
1054
if root.revision != rev.revision_id:
1055
raise errors.IncompatibleRevision(repr(repository))
1056
# Add the texts that are not already present
1057
for path, ie in entries:
1058
w = repository.weave_store.get_weave_or_empty(ie.file_id,
1059
repository.get_transaction())
1060
if ie.revision not in w:
1062
# FIXME: TODO: The following loop *may* be overlapping/duplicate
1063
# with InventoryEntry.find_previous_heads(). if it is, then there
1064
# is a latent bug here where the parents may have ancestors of each
1066
for revision, tree in parent_trees.iteritems():
1067
if ie.file_id not in tree:
1069
parent_id = tree.inventory[ie.file_id].revision
1070
if parent_id in text_parents:
1072
text_parents.append(parent_id)
1074
vfile = repository.weave_store.get_weave_or_empty(ie.file_id,
1075
repository.get_transaction())
1076
lines = revision_tree.get_file(ie.file_id).readlines()
1077
vfile.add_lines(rev.revision_id, text_parents, lines)
1079
# install the inventory
1080
repository.add_inventory(rev.revision_id, inv, present_parents)
1081
except errors.RevisionAlreadyPresent:
1083
repository.add_revision(rev.revision_id, rev, inv)
513
1086
class MetaDirRepository(Repository):
514
1087
"""Repositories in the new meta-dir layout."""
516
def __init__(self, _format, a_bzrdir, control_files, revision_store):
1089
def __init__(self, _format, a_bzrdir, control_files, _revision_store, control_store, text_store):
517
1090
super(MetaDirRepository, self).__init__(_format,
522
1096
dir_mode = self.control_files._dir_mode
523
1097
file_mode = self.control_files._file_mode
525
def get_weave(name, prefixed=False):
527
name = safe_unicode(name)
530
relpath = self.control_files._escape(name)
531
weave_transport = self.control_files._transport.clone(relpath)
532
ws = WeaveStore(weave_transport, prefixed=prefixed,
535
if self.control_files._transport.should_cache():
536
ws.enable_cache = True
539
if isinstance(self._format, RepositoryFormat7):
540
self.control_weaves = get_weave('')
541
self.weave_store = get_weave('weaves', prefixed=True)
542
elif isinstance(self._format, RepositoryFormatKnit1):
543
self.control_weaves = get_weave('')
544
self.weave_store = get_weave('knits', prefixed=True)
1100
def is_shared(self):
1101
"""Return True if this repository is flagged as a shared repository."""
1102
return self.control_files._transport.has('shared-storage')
1105
def set_make_working_trees(self, new_value):
1106
"""Set the policy flag for making working trees when creating branches.
1108
This only applies to branches that use this repository.
1110
The default is 'True'.
1111
:param new_value: True to restore the default, False to disable making
1116
self.control_files._transport.delete('no-working-trees')
1117
except errors.NoSuchFile:
546
raise errors.BzrError('unreachable code: unexpected repository'
1120
self.control_files.put_utf8('no-working-trees', '')
1122
def make_working_trees(self):
1123
"""Returns the policy for making working trees on new branches."""
1124
return not self.control_files._transport.has('no-working-trees')
1127
class RepositoryFormatRegistry(registry.Registry):
1128
"""Registry of RepositoryFormats.
1131
def get(self, format_string):
1132
r = registry.Registry.get(self, format_string)
1138
format_registry = RepositoryFormatRegistry()
1139
"""Registry of formats, indexed by their identifying format string.
1141
This can contain either format instances themselves, or classes/factories that
1142
can be called to obtain one.
1146
#####################################################################
1147
# Repository Formats
550
1149
class RepositoryFormat(object):
551
1150
"""A repository format.
658
1308
raise NotImplementedError(self.open)
661
def register_format(klass, format):
662
klass._formats[format.get_format_string()] = format
665
def set_default_format(klass, format):
666
klass._default_format = format
669
def unregister_format(klass, format):
670
assert klass._formats[format.get_format_string()] is format
671
del klass._formats[format.get_format_string()]
674
class PreSplitOutRepositoryFormat(RepositoryFormat):
675
"""Base class for the pre split out repository formats."""
677
def initialize(self, a_bzrdir, shared=False, _internal=False):
678
"""Create a weave repository.
680
TODO: when creating split out bzr branch formats, move this to a common
681
base for Format5, Format6. or something like that.
683
from bzrlib.weavefile import write_weave_v5
684
from bzrlib.weave import Weave
687
raise errors.IncompatibleFormat(self, a_bzrdir._format)
690
# always initialized when the bzrdir is.
691
return self.open(a_bzrdir, _found=True)
693
# Create an empty weave
695
bzrlib.weavefile.write_weave_v5(Weave(), sio)
696
empty_weave = sio.getvalue()
698
mutter('creating repository in %s.', a_bzrdir.transport.base)
699
dirs = ['revision-store', 'weaves']
700
lock_file = 'branch-lock'
701
files = [('inventory.weave', StringIO(empty_weave)),
704
# FIXME: RBC 20060125 dont peek under the covers
705
# NB: no need to escape relative paths that are url safe.
706
control_files = LockableFiles(a_bzrdir.transport, 'branch-lock')
707
control_files.lock_write()
708
control_files._transport.mkdir_multi(dirs,
709
mode=control_files._dir_mode)
711
for file, content in files:
712
control_files.put(file, content)
714
control_files.unlock()
715
return self.open(a_bzrdir, _found=True)
717
def open(self, a_bzrdir, _found=False):
718
"""See RepositoryFormat.open()."""
720
# we are being called directly and must probe.
721
raise NotImplementedError
723
repo_transport = a_bzrdir.get_repository_transport(None)
724
control_files = a_bzrdir._control_files
725
revision_store = self._get_revision_store(repo_transport, control_files)
726
return AllInOneRepository(_format=self,
728
revision_store=revision_store)
731
class RepositoryFormat4(PreSplitOutRepositoryFormat):
732
"""Bzr repository format 4.
734
This repository format has:
736
- TextStores for texts, inventories,revisions.
738
This format is deprecated: it indexes texts using a text id which is
739
removed in format 5; initializationa and write support for this format
744
super(RepositoryFormat4, self).__init__()
745
self._matchingbzrdir = bzrlib.bzrdir.BzrDirFormat4()
747
def initialize(self, url, shared=False, _internal=False):
748
"""Format 4 branches cannot be created."""
749
raise errors.UninitializableFormat(self)
751
def is_supported(self):
752
"""Format 4 is not supported.
754
It is not supported because the model changed from 4 to 5 and the
755
conversion logic is expensive - so doing it on the fly was not
760
def _get_revision_store(self, repo_transport, control_files):
761
"""See RepositoryFormat._get_revision_store()."""
762
return self._get_rev_store(repo_transport,
767
class RepositoryFormat5(PreSplitOutRepositoryFormat):
768
"""Bzr control format 5.
770
This repository format has:
771
- weaves for file texts and inventory
773
- TextStores for revisions and signatures.
777
super(RepositoryFormat5, self).__init__()
778
self._matchingbzrdir = bzrlib.bzrdir.BzrDirFormat5()
780
def _get_revision_store(self, repo_transport, control_files):
781
"""See RepositoryFormat._get_revision_store()."""
782
"""Return the revision store object for this a_bzrdir."""
783
return self._get_rev_store(repo_transport,
789
class RepositoryFormat6(PreSplitOutRepositoryFormat):
790
"""Bzr control format 6.
792
This repository format has:
793
- weaves for file texts and inventory
794
- hash subdirectory based stores.
795
- TextStores for revisions and signatures.
799
super(RepositoryFormat6, self).__init__()
800
self._matchingbzrdir = bzrlib.bzrdir.BzrDirFormat6()
802
def _get_revision_store(self, repo_transport, control_files):
803
"""See RepositoryFormat._get_revision_store()."""
804
return self._get_rev_store(repo_transport,
811
1311
class MetaDirRepositoryFormat(RepositoryFormat):
812
"""Common base class for the new repositories using the metadir layour."""
1312
"""Common base class for the new repositories using the metadir layout."""
1314
rich_root_data = False
1315
supports_tree_reference = False
1316
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
814
1318
def __init__(self):
815
1319
super(MetaDirRepositoryFormat, self).__init__()
816
self._matchingbzrdir = bzrlib.bzrdir.BzrDirMetaFormat1()
818
1321
def _create_control_files(self, a_bzrdir):
819
1322
"""Create the required files and the initial control_files object."""
820
# FIXME: RBC 20060125 dont peek under the covers
1323
# FIXME: RBC 20060125 don't peek under the covers
821
1324
# NB: no need to escape relative paths that are url safe.
823
1325
repository_transport = a_bzrdir.get_repository_transport(self)
824
repository_transport.put(lock_file, StringIO()) # TODO get the file mode from the bzrdir lock files., mode=file_mode)
825
control_files = LockableFiles(repository_transport, 'lock')
1326
control_files = lockable_files.LockableFiles(repository_transport,
1327
'lock', lockdir.LockDir)
1328
control_files.create_lock()
826
1329
return control_files
828
def _get_revision_store(self, repo_transport, control_files):
829
"""See RepositoryFormat._get_revision_store()."""
830
return self._get_rev_store(repo_transport,
837
def open(self, a_bzrdir, _found=False, _override_transport=None):
838
"""See RepositoryFormat.open().
840
:param _override_transport: INTERNAL USE ONLY. Allows opening the
841
repository at a slightly different url
842
than normal. I.e. during 'upgrade'.
845
format = RepositoryFormat.find_format(a_bzrdir)
846
assert format.__class__ == self.__class__
847
if _override_transport is not None:
848
repo_transport = _override_transport
850
repo_transport = a_bzrdir.get_repository_transport(None)
851
control_files = LockableFiles(repo_transport, 'lock')
852
revision_store = self._get_revision_store(repo_transport, control_files)
853
return MetaDirRepository(_format=self,
855
control_files=control_files,
856
revision_store=revision_store)
858
1331
def _upload_blank_content(self, a_bzrdir, dirs, files, utf8_files, shared):
859
1332
"""Upload the initial blank content."""
860
1333
control_files = self._create_control_files(a_bzrdir)
861
1334
control_files.lock_write()
862
control_files._transport.mkdir_multi(dirs,
863
mode=control_files._dir_mode)
1336
control_files._transport.mkdir_multi(dirs,
1337
mode=control_files._dir_mode)
865
1338
for file, content in files:
866
1339
control_files.put(file, content)
867
1340
for file, content in utf8_files:
872
1345
control_files.unlock()
875
class RepositoryFormat7(MetaDirRepositoryFormat):
878
This repository format has:
879
- weaves for file texts and inventory
880
- hash subdirectory based stores.
881
- TextStores for revisions and signatures.
882
- a format marker of its own
883
- an optional 'shared-storage' flag
884
- an optional 'no-working-trees' flag
887
def get_format_string(self):
888
"""See RepositoryFormat.get_format_string()."""
889
return "Bazaar-NG Repository format 7"
891
def initialize(self, a_bzrdir, shared=False):
892
"""Create a weave repository.
894
:param shared: If true the repository will be initialized as a shared
897
from bzrlib.weavefile import write_weave_v5
898
from bzrlib.weave import Weave
900
# Create an empty weave
902
bzrlib.weavefile.write_weave_v5(Weave(), sio)
903
empty_weave = sio.getvalue()
905
mutter('creating repository in %s.', a_bzrdir.transport.base)
906
dirs = ['revision-store', 'weaves']
907
files = [('inventory.weave', StringIO(empty_weave)),
909
utf8_files = [('format', self.get_format_string())]
911
self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
912
return self.open(a_bzrdir=a_bzrdir, _found=True)
915
class RepositoryFormatKnit1(MetaDirRepositoryFormat):
916
"""Bzr repository knit format 1.
918
This repository format has:
919
- knits for file texts and inventory
920
- hash subdirectory based stores.
921
- knits for revisions and signatures
922
- TextStores for revisions and signatures.
923
- a format marker of its own
924
- an optional 'shared-storage' flag
925
- an optional 'no-working-trees' flag
928
def get_format_string(self):
929
"""See RepositoryFormat.get_format_string()."""
930
return "Bazaar-NG Knit Repository Format 1"
932
def initialize(self, a_bzrdir, shared=False):
933
"""Create a knit format 1 repository.
935
:param shared: If true the repository will be initialized as a shared
937
XXX NOTE that this current uses a Weave for testing and will become
938
A Knit in due course.
940
from bzrlib.weavefile import write_weave_v5
941
from bzrlib.weave import Weave
943
# Create an empty weave
945
bzrlib.weavefile.write_weave_v5(Weave(), sio)
946
empty_weave = sio.getvalue()
948
mutter('creating repository in %s.', a_bzrdir.transport.base)
949
dirs = ['revision-store', 'knits']
950
files = [('inventory.weave', StringIO(empty_weave)),
952
utf8_files = [('format', self.get_format_string())]
954
self._upload_blank_content(a_bzrdir, dirs, files, utf8_files, shared)
955
return self.open(a_bzrdir=a_bzrdir, _found=True)
958
1348
# formats which have no format string are not discoverable
959
# and not independently creatable, so are not registered.
960
_default_format = RepositoryFormat7()
961
RepositoryFormat.register_format(_default_format)
962
RepositoryFormat.register_format(RepositoryFormatKnit1())
963
RepositoryFormat.set_default_format(_default_format)
964
_legacy_formats = [RepositoryFormat4(),
969
class InterRepository(object):
1349
# and not independently creatable, so are not registered. They're
1350
# all in bzrlib.repofmt.weaverepo now. When an instance of one of these is
1351
# needed, it's constructed directly by the BzrDir. Non-native formats where
1352
# the repository is not separately opened are similar.
1354
format_registry.register_lazy(
1355
'Bazaar-NG Repository format 7',
1356
'bzrlib.repofmt.weaverepo',
1359
# KEEP in sync with bzrdir.format_registry default, which controls the overall
1360
# default control directory format
1362
format_registry.register_lazy(
1363
'Bazaar-NG Knit Repository Format 1',
1364
'bzrlib.repofmt.knitrepo',
1365
'RepositoryFormatKnit1',
1367
format_registry.default_key = 'Bazaar-NG Knit Repository Format 1'
1369
format_registry.register_lazy(
1370
'Bazaar Knit Repository Format 3 (bzr 0.15)\n',
1371
'bzrlib.repofmt.knitrepo',
1372
'RepositoryFormatKnit3',
1376
class InterRepository(InterObject):
970
1377
"""This class represents operations taking place between two repositories.
972
1379
Its instances have methods like copy_content and fetch, and contain
1107
1432
# that we've decided we need.
1108
1433
return [rev_id for rev_id in source_ids if rev_id in result_set]
1436
class InterSameDataRepository(InterRepository):
1437
"""Code for converting between repositories that represent the same data.
1439
Data format and model must match for this to work.
1111
def register_optimiser(klass, optimiser):
1112
"""Register an InterRepository optimiser."""
1113
klass._optimisers.add(optimiser)
1116
"""Release the locks on source and target."""
1443
def _get_repo_format_to_test(self):
1444
"""Repository format for testing with."""
1445
return RepositoryFormat.get_default_format()
1448
def is_compatible(source, target):
1449
if source.supports_rich_root() != target.supports_rich_root():
1451
if source._serializer != target._serializer:
1456
def copy_content(self, revision_id=None):
1457
"""Make a complete copy of the content in self into destination.
1459
This copies both the repository's revision data, and configuration information
1460
such as the make_working_trees setting.
1462
This is a destructive operation! Do not use it on existing
1465
:param revision_id: Only copy the content needed to construct
1466
revision_id and its parents.
1118
self.target.unlock()
1120
self.source.unlock()
1123
def unregister_optimiser(klass, optimiser):
1124
"""Unregister an InterRepository optimiser."""
1125
klass._optimisers.remove(optimiser)
1128
class InterWeaveRepo(InterRepository):
1469
self.target.set_make_working_trees(self.source.make_working_trees())
1470
except NotImplementedError:
1472
# TODO: jam 20070210 This is fairly internal, so we should probably
1473
# just assert that revision_id is not unicode.
1474
revision_id = osutils.safe_revision_id(revision_id)
1475
# but don't bother fetching if we have the needed data now.
1476
if (revision_id not in (None, _mod_revision.NULL_REVISION) and
1477
self.target.has_revision(revision_id)):
1479
self.target.fetch(self.source, revision_id=revision_id)
1482
def fetch(self, revision_id=None, pb=None):
1483
"""See InterRepository.fetch()."""
1484
from bzrlib.fetch import GenericRepoFetcher
1485
mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
1486
self.source, self.source._format, self.target,
1487
self.target._format)
1488
# TODO: jam 20070210 This should be an assert, not a translate
1489
revision_id = osutils.safe_revision_id(revision_id)
1490
f = GenericRepoFetcher(to_repository=self.target,
1491
from_repository=self.source,
1492
last_revision=revision_id,
1494
return f.count_copied, f.failed_revisions
1497
class InterWeaveRepo(InterSameDataRepository):
1129
1498
"""Optimised code paths between Weave based repositories."""
1131
_matching_repo_format = _default_format
1132
"""Repository format for testing with."""
1501
def _get_repo_format_to_test(self):
1502
from bzrlib.repofmt import weaverepo
1503
return weaverepo.RepositoryFormat7()
1135
1506
def is_compatible(source, target):
1136
1507
"""Be compatible with known Weave formats.
1138
We dont test for the stores being of specific types becase that
1509
We don't test for the stores being of specific types because that
1139
1510
could lead to confusing results, and there is no need to be
1140
1511
overly general.
1513
from bzrlib.repofmt.weaverepo import (
1143
1519
return (isinstance(source._format, (RepositoryFormat5,
1144
1520
RepositoryFormat6,
1152
1528
@needs_write_lock
1153
def copy_content(self, revision_id=None, basis=None):
1529
def copy_content(self, revision_id=None):
1154
1530
"""See InterRepository.copy_content()."""
1155
1531
# weave specific optimised path:
1156
if basis is not None:
1157
# copy the basis in, then fetch remaining data.
1158
basis.copy_content_into(self.target, revision_id)
1159
# the basis copy_content_into could misset this.
1161
self.target.set_make_working_trees(self.source.make_working_trees())
1162
except NotImplementedError:
1164
self.target.fetch(self.source, revision_id=revision_id)
1167
self.target.set_make_working_trees(self.source.make_working_trees())
1168
except NotImplementedError:
1170
# FIXME do not peek!
1171
if self.source.control_files._transport.listable():
1172
pb = bzrlib.ui.ui_factory.progress_bar()
1173
copy_all(self.source.weave_store,
1174
self.target.weave_store, pb=pb)
1532
# TODO: jam 20070210 Internal, should be an assert, not translate
1533
revision_id = osutils.safe_revision_id(revision_id)
1535
self.target.set_make_working_trees(self.source.make_working_trees())
1536
except NotImplementedError:
1538
# FIXME do not peek!
1539
if self.source.control_files._transport.listable():
1540
pb = ui.ui_factory.nested_progress_bar()
1542
self.target.weave_store.copy_all_ids(
1543
self.source.weave_store,
1545
from_transaction=self.source.get_transaction(),
1546
to_transaction=self.target.get_transaction())
1175
1547
pb.update('copying inventory', 0, 1)
1176
1548
self.target.control_weaves.copy_multi(
1177
self.source.control_weaves, ['inventory'])
1178
copy_all(self.source.revision_store,
1179
self.target.revision_store, pb=pb)
1181
self.target.fetch(self.source, revision_id=revision_id)
1549
self.source.control_weaves, ['inventory'],
1550
from_transaction=self.source.get_transaction(),
1551
to_transaction=self.target.get_transaction())
1552
self.target._revision_store.text_store.copy_all_ids(
1553
self.source._revision_store.text_store,
1558
self.target.fetch(self.source, revision_id=revision_id)
1183
1560
@needs_write_lock
1184
1561
def fetch(self, revision_id=None, pb=None):
1185
1562
"""See InterRepository.fetch()."""
1186
from bzrlib.fetch import RepoFetcher
1563
from bzrlib.fetch import GenericRepoFetcher
1187
1564
mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
1188
1565
self.source, self.source._format, self.target, self.target._format)
1189
f = RepoFetcher(to_repository=self.target,
1190
from_repository=self.source,
1191
last_revision=revision_id,
1566
# TODO: jam 20070210 This should be an assert, not a translate
1567
revision_id = osutils.safe_revision_id(revision_id)
1568
f = GenericRepoFetcher(to_repository=self.target,
1569
from_repository=self.source,
1570
last_revision=revision_id,
1193
1572
return f.count_copied, f.failed_revisions
1195
1574
@needs_read_lock
1196
1575
def missing_revision_ids(self, revision_id=None):
1197
1576
"""See InterRepository.missing_revision_ids()."""
1198
1577
# we want all revisions to satisfy revision_id in source.
1199
# but we dont want to stat every file here and there.
1578
# but we don't want to stat every file here and there.
1200
1579
# we want then, all revisions other needs to satisfy revision_id
1201
1580
# checked, but not those that we have locally.
1202
1581
# so the first thing is to get a subset of the revisions to
1208
1587
# - RBC 20060209
1209
1588
if revision_id is not None:
1210
1589
source_ids = self.source.get_ancestry(revision_id)
1211
assert source_ids.pop(0) == None
1213
source_ids = self.source._all_possible_ids()
1214
source_ids_set = set(source_ids)
1215
# source_ids is the worst possible case we may need to pull.
1216
# now we want to filter source_ids against what we actually
1217
# have in target, but dont try to check for existence where we know
1218
# we do not have a revision as that would be pointless.
1219
target_ids = set(self.target._all_possible_ids())
1220
possibly_present_revisions = target_ids.intersection(source_ids_set)
1221
actually_present_revisions = set(self.target._eliminate_revisions_not_present(possibly_present_revisions))
1222
required_revisions = source_ids_set.difference(actually_present_revisions)
1223
required_topo_revisions = [rev_id for rev_id in source_ids if rev_id in required_revisions]
1224
if revision_id is not None:
1225
# we used get_ancestry to determine source_ids then we are assured all
1226
# revisions referenced are present as they are installed in topological order.
1227
# and the tip revision was validated by get_ancestry.
1228
return required_topo_revisions
1230
# if we just grabbed the possibly available ids, then
1231
# we only have an estimate of whats available and need to validate
1232
# that against the revision records.
1233
return self.source._eliminate_revisions_not_present(required_topo_revisions)
1590
assert source_ids[0] is None
1593
source_ids = self.source._all_possible_ids()
1594
source_ids_set = set(source_ids)
1595
# source_ids is the worst possible case we may need to pull.
1596
# now we want to filter source_ids against what we actually
1597
# have in target, but don't try to check for existence where we know
1598
# we do not have a revision as that would be pointless.
1599
target_ids = set(self.target._all_possible_ids())
1600
possibly_present_revisions = target_ids.intersection(source_ids_set)
1601
actually_present_revisions = set(self.target._eliminate_revisions_not_present(possibly_present_revisions))
1602
required_revisions = source_ids_set.difference(actually_present_revisions)
1603
required_topo_revisions = [rev_id for rev_id in source_ids if rev_id in required_revisions]
1604
if revision_id is not None:
1605
# we used get_ancestry to determine source_ids then we are assured all
1606
# revisions referenced are present as they are installed in topological order.
1607
# and the tip revision was validated by get_ancestry.
1608
return required_topo_revisions
1610
# if we just grabbed the possibly available ids, then
1611
# we only have an estimate of whats available and need to validate
1612
# that against the revision records.
1613
return self.source._eliminate_revisions_not_present(required_topo_revisions)
1616
class InterKnitRepo(InterSameDataRepository):
1617
"""Optimised code paths between Knit based repositories."""
1620
def _get_repo_format_to_test(self):
1621
from bzrlib.repofmt import knitrepo
1622
return knitrepo.RepositoryFormatKnit1()
1625
def is_compatible(source, target):
1626
"""Be compatible with known Knit formats.
1628
We don't test for the stores being of specific types because that
1629
could lead to confusing results, and there is no need to be
1632
from bzrlib.repofmt.knitrepo import RepositoryFormatKnit1
1634
return (isinstance(source._format, (RepositoryFormatKnit1)) and
1635
isinstance(target._format, (RepositoryFormatKnit1)))
1636
except AttributeError:
1640
def fetch(self, revision_id=None, pb=None):
1641
"""See InterRepository.fetch()."""
1642
from bzrlib.fetch import KnitRepoFetcher
1643
mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
1644
self.source, self.source._format, self.target, self.target._format)
1645
# TODO: jam 20070210 This should be an assert, not a translate
1646
revision_id = osutils.safe_revision_id(revision_id)
1647
f = KnitRepoFetcher(to_repository=self.target,
1648
from_repository=self.source,
1649
last_revision=revision_id,
1651
return f.count_copied, f.failed_revisions
1654
def missing_revision_ids(self, revision_id=None):
1655
"""See InterRepository.missing_revision_ids()."""
1656
if revision_id is not None:
1657
source_ids = self.source.get_ancestry(revision_id)
1658
assert source_ids[0] is None
1661
source_ids = self.source._all_possible_ids()
1662
source_ids_set = set(source_ids)
1663
# source_ids is the worst possible case we may need to pull.
1664
# now we want to filter source_ids against what we actually
1665
# have in target, but don't try to check for existence where we know
1666
# we do not have a revision as that would be pointless.
1667
target_ids = set(self.target._all_possible_ids())
1668
possibly_present_revisions = target_ids.intersection(source_ids_set)
1669
actually_present_revisions = set(self.target._eliminate_revisions_not_present(possibly_present_revisions))
1670
required_revisions = source_ids_set.difference(actually_present_revisions)
1671
required_topo_revisions = [rev_id for rev_id in source_ids if rev_id in required_revisions]
1672
if revision_id is not None:
1673
# we used get_ancestry to determine source_ids then we are assured all
1674
# revisions referenced are present as they are installed in topological order.
1675
# and the tip revision was validated by get_ancestry.
1676
return required_topo_revisions
1678
# if we just grabbed the possibly available ids, then
1679
# we only have an estimate of whats available and need to validate
1680
# that against the revision records.
1681
return self.source._eliminate_revisions_not_present(required_topo_revisions)
1684
class InterModel1and2(InterRepository):
1687
def _get_repo_format_to_test(self):
1691
def is_compatible(source, target):
1692
if not source.supports_rich_root() and target.supports_rich_root():
1698
def fetch(self, revision_id=None, pb=None):
1699
"""See InterRepository.fetch()."""
1700
from bzrlib.fetch import Model1toKnit2Fetcher
1701
# TODO: jam 20070210 This should be an assert, not a translate
1702
revision_id = osutils.safe_revision_id(revision_id)
1703
f = Model1toKnit2Fetcher(to_repository=self.target,
1704
from_repository=self.source,
1705
last_revision=revision_id,
1707
return f.count_copied, f.failed_revisions
1710
def copy_content(self, revision_id=None):
1711
"""Make a complete copy of the content in self into destination.
1713
This is a destructive operation! Do not use it on existing
1716
:param revision_id: Only copy the content needed to construct
1717
revision_id and its parents.
1720
self.target.set_make_working_trees(self.source.make_working_trees())
1721
except NotImplementedError:
1723
# TODO: jam 20070210 Internal, assert, don't translate
1724
revision_id = osutils.safe_revision_id(revision_id)
1725
# but don't bother fetching if we have the needed data now.
1726
if (revision_id not in (None, _mod_revision.NULL_REVISION) and
1727
self.target.has_revision(revision_id)):
1729
self.target.fetch(self.source, revision_id=revision_id)
1732
class InterKnit1and2(InterKnitRepo):
1735
def _get_repo_format_to_test(self):
1739
def is_compatible(source, target):
1740
"""Be compatible with Knit1 source and Knit3 target"""
1741
from bzrlib.repofmt.knitrepo import RepositoryFormatKnit3
1743
from bzrlib.repofmt.knitrepo import RepositoryFormatKnit1, \
1744
RepositoryFormatKnit3
1745
return (isinstance(source._format, (RepositoryFormatKnit1)) and
1746
isinstance(target._format, (RepositoryFormatKnit3)))
1747
except AttributeError:
1751
def fetch(self, revision_id=None, pb=None):
1752
"""See InterRepository.fetch()."""
1753
from bzrlib.fetch import Knit1to2Fetcher
1754
mutter("Using fetch logic to copy between %s(%s) and %s(%s)",
1755
self.source, self.source._format, self.target,
1756
self.target._format)
1757
# TODO: jam 20070210 This should be an assert, not a translate
1758
revision_id = osutils.safe_revision_id(revision_id)
1759
f = Knit1to2Fetcher(to_repository=self.target,
1760
from_repository=self.source,
1761
last_revision=revision_id,
1763
return f.count_copied, f.failed_revisions
1766
class InterRemoteRepository(InterRepository):
1767
"""Code for converting between RemoteRepository objects.
1769
This just gets an non-remote repository from the RemoteRepository, and calls
1770
InterRepository.get again.
1773
def __init__(self, source, target):
1774
if isinstance(source, remote.RemoteRepository):
1775
source._ensure_real()
1776
real_source = source._real_repository
1778
real_source = source
1779
if isinstance(target, remote.RemoteRepository):
1780
target._ensure_real()
1781
real_target = target._real_repository
1783
real_target = target
1784
self.real_inter = InterRepository.get(real_source, real_target)
1787
def is_compatible(source, target):
1788
if isinstance(source, remote.RemoteRepository):
1790
if isinstance(target, remote.RemoteRepository):
1794
def copy_content(self, revision_id=None):
1795
self.real_inter.copy_content(revision_id=revision_id)
1797
def fetch(self, revision_id=None, pb=None):
1798
self.real_inter.fetch(revision_id=revision_id, pb=pb)
1801
def _get_repo_format_to_test(self):
1805
InterRepository.register_optimiser(InterSameDataRepository)
1236
1806
InterRepository.register_optimiser(InterWeaveRepo)
1239
class RepositoryTestProviderAdapter(object):
1240
"""A tool to generate a suite testing multiple repository formats at once.
1242
This is done by copying the test once for each transport and injecting
1243
the transport_server, transport_readonly_server, and bzrdir_format and
1244
repository_format classes into each copy. Each copy is also given a new id()
1245
to make it easy to identify.
1248
def __init__(self, transport_server, transport_readonly_server, formats):
1249
self._transport_server = transport_server
1250
self._transport_readonly_server = transport_readonly_server
1251
self._formats = formats
1253
def adapt(self, test):
1254
result = TestSuite()
1255
for repository_format, bzrdir_format in self._formats:
1256
new_test = deepcopy(test)
1257
new_test.transport_server = self._transport_server
1258
new_test.transport_readonly_server = self._transport_readonly_server
1259
new_test.bzrdir_format = bzrdir_format
1260
new_test.repository_format = repository_format
1261
def make_new_test_id():
1262
new_id = "%s(%s)" % (new_test.id(), repository_format.__class__.__name__)
1263
return lambda: new_id
1264
new_test.id = make_new_test_id()
1265
result.addTest(new_test)
1269
class InterRepositoryTestProviderAdapter(object):
1270
"""A tool to generate a suite testing multiple inter repository formats.
1272
This is done by copying the test once for each interrepo provider and injecting
1273
the transport_server, transport_readonly_server, repository_format and
1274
repository_to_format classes into each copy.
1275
Each copy is also given a new id() to make it easy to identify.
1278
def __init__(self, transport_server, transport_readonly_server, formats):
1279
self._transport_server = transport_server
1280
self._transport_readonly_server = transport_readonly_server
1281
self._formats = formats
1283
def adapt(self, test):
1284
result = TestSuite()
1285
for interrepo_class, repository_format, repository_format_to in self._formats:
1286
new_test = deepcopy(test)
1287
new_test.transport_server = self._transport_server
1288
new_test.transport_readonly_server = self._transport_readonly_server
1289
new_test.interrepo_class = interrepo_class
1290
new_test.repository_format = repository_format
1291
new_test.repository_format_to = repository_format_to
1292
def make_new_test_id():
1293
new_id = "%s(%s)" % (new_test.id(), interrepo_class.__name__)
1294
return lambda: new_id
1295
new_test.id = make_new_test_id()
1296
result.addTest(new_test)
1300
def default_test_list():
1301
"""Generate the default list of interrepo permutations to test."""
1303
# test the default InterRepository between format 6 and the current
1305
# XXX: robertc 20060220 reinstate this when there are two supported
1306
# formats which do not have an optimal code path between them.
1307
result.append((InterRepository,
1308
RepositoryFormat6(),
1309
RepositoryFormatKnit1()))
1310
for optimiser in InterRepository._optimisers:
1311
result.append((optimiser,
1312
optimiser._matching_repo_format,
1313
optimiser._matching_repo_format
1315
# if there are specific combinations we want to use, we can add them
1807
InterRepository.register_optimiser(InterKnitRepo)
1808
InterRepository.register_optimiser(InterModel1and2)
1809
InterRepository.register_optimiser(InterKnit1and2)
1810
InterRepository.register_optimiser(InterRemoteRepository)
1320
1813
class CopyConverter(object):
1366
1860
"""Update the pb by a step."""
1368
1862
self.pb.update(message, self.count, self.total)
1865
class CommitBuilder(object):
1866
"""Provides an interface to build up a commit.
1868
This allows describing a tree to be committed without needing to
1869
know the internals of the format of the repository.
1872
record_root_entry = False
1873
def __init__(self, repository, parents, config, timestamp=None,
1874
timezone=None, committer=None, revprops=None,
1876
"""Initiate a CommitBuilder.
1878
:param repository: Repository to commit to.
1879
:param parents: Revision ids of the parents of the new revision.
1880
:param config: Configuration to use.
1881
:param timestamp: Optional timestamp recorded for commit.
1882
:param timezone: Optional timezone for timestamp.
1883
:param committer: Optional committer to set for commit.
1884
:param revprops: Optional dictionary of revision properties.
1885
:param revision_id: Optional revision id.
1887
self._config = config
1889
if committer is None:
1890
self._committer = self._config.username()
1892
assert isinstance(committer, basestring), type(committer)
1893
self._committer = committer
1895
self.new_inventory = Inventory(None)
1896
self._new_revision_id = osutils.safe_revision_id(revision_id)
1897
self.parents = parents
1898
self.repository = repository
1901
if revprops is not None:
1902
self._revprops.update(revprops)
1904
if timestamp is None:
1905
timestamp = time.time()
1906
# Restrict resolution to 1ms
1907
self._timestamp = round(timestamp, 3)
1909
if timezone is None:
1910
self._timezone = osutils.local_time_offset()
1912
self._timezone = int(timezone)
1914
self._generate_revision_if_needed()
1916
def commit(self, message):
1917
"""Make the actual commit.
1919
:return: The revision id of the recorded revision.
1921
rev = _mod_revision.Revision(
1922
timestamp=self._timestamp,
1923
timezone=self._timezone,
1924
committer=self._committer,
1926
inventory_sha1=self.inv_sha1,
1927
revision_id=self._new_revision_id,
1928
properties=self._revprops)
1929
rev.parent_ids = self.parents
1930
self.repository.add_revision(self._new_revision_id, rev,
1931
self.new_inventory, self._config)
1932
return self._new_revision_id
1934
def revision_tree(self):
1935
"""Return the tree that was just committed.
1937
After calling commit() this can be called to get a RevisionTree
1938
representing the newly committed tree. This is preferred to
1939
calling Repository.revision_tree() because that may require
1940
deserializing the inventory, while we already have a copy in
1943
return RevisionTree(self.repository, self.new_inventory,
1944
self._new_revision_id)
1946
def finish_inventory(self):
1947
"""Tell the builder that the inventory is finished."""
1948
if self.new_inventory.root is None:
1949
symbol_versioning.warn('Root entry should be supplied to'
1950
' record_entry_contents, as of bzr 0.10.',
1951
DeprecationWarning, stacklevel=2)
1952
self.new_inventory.add(InventoryDirectory(ROOT_ID, '', None))
1953
self.new_inventory.revision_id = self._new_revision_id
1954
self.inv_sha1 = self.repository.add_inventory(
1955
self._new_revision_id,
1960
def _gen_revision_id(self):
1961
"""Return new revision-id."""
1962
return generate_ids.gen_revision_id(self._config.username(),
1965
def _generate_revision_if_needed(self):
1966
"""Create a revision id if None was supplied.
1968
If the repository can not support user-specified revision ids
1969
they should override this function and raise CannotSetRevisionId
1970
if _new_revision_id is not None.
1972
:raises: CannotSetRevisionId
1974
if self._new_revision_id is None:
1975
self._new_revision_id = self._gen_revision_id()
1977
def record_entry_contents(self, ie, parent_invs, path, tree):
1978
"""Record the content of ie from tree into the commit if needed.
1980
Side effect: sets ie.revision when unchanged
1982
:param ie: An inventory entry present in the commit.
1983
:param parent_invs: The inventories of the parent revisions of the
1985
:param path: The path the entry is at in the tree.
1986
:param tree: The tree which contains this entry and should be used to
1989
if self.new_inventory.root is None and ie.parent_id is not None:
1990
symbol_versioning.warn('Root entry should be supplied to'
1991
' record_entry_contents, as of bzr 0.10.',
1992
DeprecationWarning, stacklevel=2)
1993
self.record_entry_contents(tree.inventory.root.copy(), parent_invs,
1995
self.new_inventory.add(ie)
1997
# ie.revision is always None if the InventoryEntry is considered
1998
# for committing. ie.snapshot will record the correct revision
1999
# which may be the sole parent if it is untouched.
2000
if ie.revision is not None:
2003
# In this revision format, root entries have no knit or weave
2004
if ie is self.new_inventory.root:
2005
# When serializing out to disk and back in
2006
# root.revision is always _new_revision_id
2007
ie.revision = self._new_revision_id
2009
previous_entries = ie.find_previous_heads(
2011
self.repository.weave_store,
2012
self.repository.get_transaction())
2013
# we are creating a new revision for ie in the history store
2015
ie.snapshot(self._new_revision_id, path, previous_entries, tree, self)
2017
def modified_directory(self, file_id, file_parents):
2018
"""Record the presence of a symbolic link.
2020
:param file_id: The file_id of the link to record.
2021
:param file_parents: The per-file parent revision ids.
2023
self._add_text_to_weave(file_id, [], file_parents.keys())
2025
def modified_reference(self, file_id, file_parents):
2026
"""Record the modification of a reference.
2028
:param file_id: The file_id of the link to record.
2029
:param file_parents: The per-file parent revision ids.
2031
self._add_text_to_weave(file_id, [], file_parents.keys())
2033
def modified_file_text(self, file_id, file_parents,
2034
get_content_byte_lines, text_sha1=None,
2036
"""Record the text of file file_id
2038
:param file_id: The file_id of the file to record the text of.
2039
:param file_parents: The per-file parent revision ids.
2040
:param get_content_byte_lines: A callable which will return the byte
2042
:param text_sha1: Optional SHA1 of the file contents.
2043
:param text_size: Optional size of the file contents.
2045
# mutter('storing text of file {%s} in revision {%s} into %r',
2046
# file_id, self._new_revision_id, self.repository.weave_store)
2047
# special case to avoid diffing on renames or
2049
if (len(file_parents) == 1
2050
and text_sha1 == file_parents.values()[0].text_sha1
2051
and text_size == file_parents.values()[0].text_size):
2052
previous_ie = file_parents.values()[0]
2053
versionedfile = self.repository.weave_store.get_weave(file_id,
2054
self.repository.get_transaction())
2055
versionedfile.clone_text(self._new_revision_id,
2056
previous_ie.revision, file_parents.keys())
2057
return text_sha1, text_size
2059
new_lines = get_content_byte_lines()
2060
# TODO: Rather than invoking sha_strings here, _add_text_to_weave
2061
# should return the SHA1 and size
2062
self._add_text_to_weave(file_id, new_lines, file_parents.keys())
2063
return osutils.sha_strings(new_lines), \
2064
sum(map(len, new_lines))
2066
def modified_link(self, file_id, file_parents, link_target):
2067
"""Record the presence of a symbolic link.
2069
:param file_id: The file_id of the link to record.
2070
:param file_parents: The per-file parent revision ids.
2071
:param link_target: Target location of this link.
2073
self._add_text_to_weave(file_id, [], file_parents.keys())
2075
def _add_text_to_weave(self, file_id, new_lines, parents):
2076
versionedfile = self.repository.weave_store.get_weave_or_empty(
2077
file_id, self.repository.get_transaction())
2078
versionedfile.add_lines(self._new_revision_id, parents, new_lines)
2079
versionedfile.clear_cache()
2082
class _CommitBuilder(CommitBuilder):
2083
"""Temporary class so old CommitBuilders are detected properly
2085
Note: CommitBuilder works whether or not root entry is recorded.
2088
record_root_entry = True
2091
class RootCommitBuilder(CommitBuilder):
2092
"""This commitbuilder actually records the root id"""
2094
record_root_entry = True
2096
def record_entry_contents(self, ie, parent_invs, path, tree):
2097
"""Record the content of ie from tree into the commit if needed.
2099
Side effect: sets ie.revision when unchanged
2101
:param ie: An inventory entry present in the commit.
2102
:param parent_invs: The inventories of the parent revisions of the
2104
:param path: The path the entry is at in the tree.
2105
:param tree: The tree which contains this entry and should be used to
2108
assert self.new_inventory.root is not None or ie.parent_id is None
2109
self.new_inventory.add(ie)
2111
# ie.revision is always None if the InventoryEntry is considered
2112
# for committing. ie.snapshot will record the correct revision
2113
# which may be the sole parent if it is untouched.
2114
if ie.revision is not None:
2117
previous_entries = ie.find_previous_heads(
2119
self.repository.weave_store,
2120
self.repository.get_transaction())
2121
# we are creating a new revision for ie in the history store
2123
ie.snapshot(self._new_revision_id, path, previous_entries, tree, self)
2135
def _unescaper(match, _map=_unescape_map):
2136
code = match.group(1)
2140
if not code.startswith('#'):
2142
return unichr(int(code[1:])).encode('utf8')
2148
def _unescape_xml(data):
2149
"""Unescape predefined XML entities in a string of data."""
2151
if _unescape_re is None:
2152
_unescape_re = re.compile('\&([^;]*);')
2153
return _unescape_re.sub(_unescaper, data)