1
# Copyright (C) 2005, 2006 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""Serializer factory for reading and writing bundles.
22
from bzrlib import errors
23
from bzrlib.bundle.serializer import (BundleSerializer,
28
from bzrlib.bundle.serializer import binary_diff
29
from bzrlib.bundle.bundle_data import (RevisionInfo, BundleInfo, BundleTree)
30
from bzrlib.diff import internal_diff
31
from bzrlib.osutils import pathjoin
32
from bzrlib.progress import DummyProgress
33
from bzrlib.revision import NULL_REVISION
34
from bzrlib.rio import RioWriter, read_stanzas
36
from bzrlib.testament import StrictTestament
37
from bzrlib.textfile import text_file
38
from bzrlib.trace import mutter
40
bool_text = {True: 'yes', False: 'no'}
44
"""Represent an action"""
46
def __init__(self, name, parameters=None, properties=None):
48
if parameters is None:
51
self.parameters = parameters
52
if properties is None:
55
self.properties = properties
57
def add_utf8_property(self, name, value):
58
"""Add a property whose value is currently utf8 to the action."""
59
self.properties.append((name, value.decode('utf8')))
61
def add_property(self, name, value):
62
"""Add a property to the action"""
63
self.properties.append((name, value))
65
def add_bool_property(self, name, value):
66
"""Add a boolean property to the action"""
67
self.add_property(name, bool_text[value])
69
def write(self, to_file):
70
"""Write action as to a file"""
71
p_texts = [' '.join([self.name]+self.parameters)]
72
for prop in self.properties:
74
p_texts.append(prop[0])
77
p_texts.append('%s:%s' % prop)
81
text.append(' // '.join(p_texts))
82
text_line = ''.join(text).encode('utf-8')
84
while len(text_line) > available:
85
to_file.write(text_line[:available])
86
text_line = text_line[available:]
87
to_file.write('\n... ')
88
available = 79 - len('... ')
89
to_file.write(text_line+'\n')
92
class BundleSerializerV08(BundleSerializer):
94
"""Read the rest of the bundles from the supplied file.
96
:param f: The file to read from
97
:return: A list of bundles
99
return BundleReader(f).info
101
def check_compatible(self):
102
if self.source.supports_rich_root():
103
raise errors.IncompatibleBundleFormat('0.8', repr(self.source))
105
def write(self, source, revision_ids, forced_bases, f):
106
"""Write the bundless to the supplied files.
108
:param source: A source for revision information
109
:param revision_ids: The list of revision ids to serialize
110
:param forced_bases: A dict of revision -> base that overrides default
111
:param f: The file to output to
114
self.revision_ids = revision_ids
115
self.forced_bases = forced_bases
117
self.check_compatible()
120
self._write_main_header()
123
self._write_revisions(pb)
130
def _write_main_header(self):
131
"""Write the header for the changes"""
133
f.write(BUNDLE_HEADER)
137
def _write(self, key, value, indent=1):
138
"""Write out meta information, with proper indenting, etc"""
139
assert indent > 0, 'indentation must be greater than 0'
141
f.write('#' + (' ' * indent))
142
f.write(key.encode('utf-8'))
145
elif isinstance(value, str):
149
elif isinstance(value, unicode):
151
f.write(value.encode('utf-8'))
156
f.write('#' + (' ' * (indent+2)))
157
if isinstance(entry, str):
160
f.write(entry.encode('utf-8'))
163
def _write_revisions(self, pb):
164
"""Write the information for all of the revisions."""
166
# Optimize for the case of revisions in order
170
i_max = len(self.revision_ids)
171
for i, rev_id in enumerate(self.revision_ids):
172
pb.update("Generating revsion data", i, i_max)
173
rev = self.source.get_revision(rev_id)
174
if rev_id == last_rev_id:
175
rev_tree = last_rev_tree
177
rev_tree = self.source.revision_tree(rev_id)
178
if rev_id in self.forced_bases:
180
base_id = self.forced_bases[rev_id]
182
base_id = NULL_REVISION
184
explicit_base = False
186
base_id = rev.parent_ids[-1]
188
base_id = NULL_REVISION
190
if base_id == last_rev_id:
191
base_tree = last_rev_tree
193
base_tree = self.source.revision_tree(base_id)
194
force_binary = (i != 0)
195
self._write_revision(rev, rev_tree, base_id, base_tree,
196
explicit_base, force_binary)
198
last_rev_id = base_id
199
last_rev_tree = base_tree
201
def _testament_sha1(self, revision_id):
202
return StrictTestament.from_revision(self.source,
203
revision_id).as_sha1()
205
def _write_revision(self, rev, rev_tree, base_rev, base_tree,
206
explicit_base, force_binary):
207
"""Write out the information for a revision."""
209
self._write(key, value, indent=1)
211
w('message', rev.message.split('\n'))
212
w('committer', rev.committer)
213
w('date', format_highres_date(rev.timestamp, rev.timezone))
214
self.to_file.write('\n')
216
self._write_delta(rev_tree, base_tree, rev.revision_id, force_binary)
218
w('revision id', rev.revision_id)
219
w('sha1', self._testament_sha1(rev.revision_id))
220
w('inventory sha1', rev.inventory_sha1)
222
w('parent ids', rev.parent_ids)
224
w('base id', base_rev)
226
self._write('properties', None, indent=1)
227
for name, value in rev.properties.items():
228
self._write(name, value, indent=3)
230
# Add an extra blank space at the end
231
self.to_file.write('\n')
233
def _write_action(self, name, parameters, properties=None):
234
if properties is None:
236
p_texts = ['%s:%s' % v for v in properties]
237
self.to_file.write('=== ')
238
self.to_file.write(' '.join([name]+parameters).encode('utf-8'))
239
self.to_file.write(' // '.join(p_texts).encode('utf-8'))
240
self.to_file.write('\n')
242
def _write_delta(self, new_tree, old_tree, default_revision_id,
244
"""Write out the changes between the trees."""
245
DEVNULL = '/dev/null'
249
def do_diff(file_id, old_path, new_path, action, force_binary):
250
def tree_lines(tree, require_text=False):
252
tree_file = tree.get_file(file_id)
253
if require_text is True:
254
tree_file = text_file(tree_file)
255
return tree_file.readlines()
261
raise errors.BinaryFile()
262
old_lines = tree_lines(old_tree, require_text=True)
263
new_lines = tree_lines(new_tree, require_text=True)
264
action.write(self.to_file)
265
internal_diff(old_path, old_lines, new_path, new_lines,
267
except errors.BinaryFile:
268
old_lines = tree_lines(old_tree, require_text=False)
269
new_lines = tree_lines(new_tree, require_text=False)
270
action.add_property('encoding', 'base64')
271
action.write(self.to_file)
272
binary_diff(old_path, old_lines, new_path, new_lines,
275
def finish_action(action, file_id, kind, meta_modified, text_modified,
277
entry = new_tree.inventory[file_id]
278
if entry.revision != default_revision_id:
279
action.add_utf8_property('last-changed', entry.revision)
281
action.add_bool_property('executable', entry.executable)
282
if text_modified and kind == "symlink":
283
action.add_property('target', entry.symlink_target)
284
if text_modified and kind == "file":
285
do_diff(file_id, old_path, new_path, action, force_binary)
287
action.write(self.to_file)
289
delta = new_tree.changes_from(old_tree, want_unchanged=True,
291
for path, file_id, kind in delta.removed:
292
action = Action('removed', [kind, path]).write(self.to_file)
294
for path, file_id, kind in delta.added:
295
action = Action('added', [kind, path], [('file-id', file_id)])
296
meta_modified = (kind=='file' and
297
new_tree.is_executable(file_id))
298
finish_action(action, file_id, kind, meta_modified, True,
301
for (old_path, new_path, file_id, kind,
302
text_modified, meta_modified) in delta.renamed:
303
action = Action('renamed', [kind, old_path], [(new_path,)])
304
finish_action(action, file_id, kind, meta_modified, text_modified,
307
for (path, file_id, kind,
308
text_modified, meta_modified) in delta.modified:
309
action = Action('modified', [kind, path])
310
finish_action(action, file_id, kind, meta_modified, text_modified,
313
for path, file_id, kind in delta.unchanged:
314
ie = new_tree.inventory[file_id]
315
new_rev = getattr(ie, 'revision', None)
318
old_rev = getattr(old_tree.inventory[ie.file_id], 'revision', None)
319
if new_rev != old_rev:
320
action = Action('modified', [ie.kind,
321
new_tree.id2path(ie.file_id)])
322
action.add_utf8_property('last-changed', ie.revision)
323
action.write(self.to_file)
326
class BundleReader(object):
327
"""This class reads in a bundle from a file, and returns
328
a Bundle object, which can then be applied against a tree.
330
def __init__(self, from_file):
331
"""Read in the bundle from the file.
333
:param from_file: A file-like object (must have iterator support).
335
object.__init__(self)
336
self.from_file = iter(from_file)
337
self._next_line = None
339
self.info = self._get_info()
340
# We put the actual inventory ids in the footer, so that the patch
341
# is easier to read for humans.
342
# Unfortunately, that means we need to read everything before we
343
# can create a proper bundle.
348
return BundleInfo08()
352
while self._next_line is not None:
353
if not self._read_revision_header():
355
if self._next_line is None:
361
"""Make sure that the information read in makes sense
362
and passes appropriate checksums.
364
# Fill in all the missing blanks for the revisions
365
# and generate the real_revisions list.
366
self.info.complete_info()
369
"""yield the next line, but secretly
370
keep 1 extra line for peeking.
372
for line in self.from_file:
373
last = self._next_line
374
self._next_line = line
376
#mutter('yielding line: %r' % last)
378
last = self._next_line
379
self._next_line = None
380
#mutter('yielding line: %r' % last)
383
def _read_revision_header(self):
384
found_something = False
385
self.info.revisions.append(RevisionInfo(None))
386
for line in self._next():
387
# The bzr header is terminated with a blank line
388
# which does not start with '#'
389
if line is None or line == '\n':
391
if not line.startswith('#'):
393
found_something = True
394
self._handle_next(line)
395
if not found_something:
396
# Nothing was there, so remove the added revision
397
self.info.revisions.pop()
398
return found_something
400
def _read_next_entry(self, line, indent=1):
401
"""Read in a key-value pair
403
if not line.startswith('#'):
404
raise errors.MalformedHeader('Bzr header did not start with #')
405
line = line[1:-1].decode('utf-8') # Remove the '#' and '\n'
406
if line[:indent] == ' '*indent:
409
return None, None# Ignore blank lines
411
loc = line.find(': ')
416
value = self._read_many(indent=indent+2)
417
elif line[-1:] == ':':
419
value = self._read_many(indent=indent+2)
421
raise errors.MalformedHeader('While looking for key: value pairs,'
422
' did not find the colon %r' % (line))
424
key = key.replace(' ', '_')
425
#mutter('found %s: %s' % (key, value))
428
def _handle_next(self, line):
431
key, value = self._read_next_entry(line, indent=1)
432
mutter('_handle_next %r => %r' % (key, value))
436
revision_info = self.info.revisions[-1]
437
if key in revision_info.__dict__:
438
if getattr(revision_info, key) is None:
439
if key in ('file_id', 'revision_id', 'base_id'):
440
value = value.encode('utf8')
441
elif key in ('parent_ids'):
442
value = [v.encode('utf8') for v in value]
443
setattr(revision_info, key, value)
445
raise errors.MalformedHeader('Duplicated Key: %s' % key)
447
# What do we do with a key we don't recognize
448
raise errors.MalformedHeader('Unknown Key: "%s"' % key)
450
def _read_many(self, indent):
451
"""If a line ends with no entry, that means that it should be
452
followed with multiple lines of values.
454
This detects the end of the list, because it will be a line that
455
does not start properly indented.
458
start = '#' + (' '*indent)
460
if self._next_line is None or self._next_line[:len(start)] != start:
463
for line in self._next():
464
values.append(line[len(start):-1].decode('utf-8'))
465
if self._next_line is None or self._next_line[:len(start)] != start:
469
def _read_one_patch(self):
470
"""Read in one patch, return the complete patch, along with
473
:return: action, lines, do_continue
475
#mutter('_read_one_patch: %r' % self._next_line)
476
# Peek and see if there are no patches
477
if self._next_line is None or self._next_line.startswith('#'):
478
return None, [], False
482
for line in self._next():
484
if not line.startswith('==='):
485
raise errors.MalformedPatches('The first line of all patches'
486
' should be a bzr meta line "==="'
488
action = line[4:-1].decode('utf-8')
489
elif line.startswith('... '):
490
action += line[len('... '):-1].decode('utf-8')
492
if (self._next_line is not None and
493
self._next_line.startswith('===')):
494
return action, lines, True
495
elif self._next_line is None or self._next_line.startswith('#'):
496
return action, lines, False
500
elif not line.startswith('... '):
503
return action, lines, False
505
def _read_patches(self):
507
revision_actions = []
509
action, lines, do_continue = self._read_one_patch()
510
if action is not None:
511
revision_actions.append((action, lines))
512
assert self.info.revisions[-1].tree_actions is None
513
self.info.revisions[-1].tree_actions = revision_actions
515
def _read_footer(self):
516
"""Read the rest of the meta information.
518
:param first_line: The previous step iterates past what it
519
can handle. That extra line is given here.
521
for line in self._next():
522
self._handle_next(line)
523
if self._next_line is None:
525
if not self._next_line.startswith('#'):
526
# Consume the trailing \n and stop processing
531
class BundleInfo08(BundleInfo):
533
def _update_tree(self, bundle_tree, revision_id):
534
bundle_tree.note_last_changed('', revision_id)
535
BundleInfo._update_tree(self, bundle_tree, revision_id)
537
def _testament_sha1_from_revision(self, repository, revision_id):
538
testament = StrictTestament.from_revision(repository, revision_id)
539
return testament.as_sha1()
541
def _testament_sha1(self, revision, inventory):
542
return StrictTestament(revision, inventory).as_sha1()
added
removed
bzrlib/bundle/serializer/v08.py
