1
# (C) 2005 Canonical Development 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_property(self, name, value):
58
"""Add a property to the action"""
59
self.properties.append((name, value))
61
def add_bool_property(self, name, value):
62
"""Add a boolean property to the action"""
63
self.add_property(name, bool_text[value])
65
def write(self, to_file):
66
"""Write action as to a file"""
67
p_texts = [' '.join([self.name]+self.parameters)]
68
for prop in self.properties:
70
p_texts.append(prop[0])
73
p_texts.append('%s:%s' % prop)
77
text.append(' // '.join(p_texts))
78
text_line = ''.join(text).encode('utf-8')
80
while len(text_line) > available:
81
to_file.write(text_line[:available])
82
text_line = text_line[available:]
83
to_file.write('\n... ')
84
available = 79 - len('... ')
85
to_file.write(text_line+'\n')
88
class BundleSerializerV08(BundleSerializer):
90
"""Read the rest of the bundles from the supplied file.
92
:param f: The file to read from
93
:return: A list of bundles
95
return BundleReader(f).info
97
def write(self, source, revision_ids, forced_bases, f):
98
"""Write the bundless to the supplied files.
100
:param source: A source for revision information
101
:param revision_ids: The list of revision ids to serialize
102
:param forced_bases: A dict of revision -> base that overrides default
103
:param f: The file to output to
106
self.revision_ids = revision_ids
107
self.forced_bases = forced_bases
111
self._write_main_header()
114
self._write_revisions(pb)
121
def _write_main_header(self):
122
"""Write the header for the changes"""
124
f.write(BUNDLE_HEADER)
128
def _write(self, key, value, indent=1):
129
"""Write out meta information, with proper indenting, etc"""
130
assert indent > 0, 'indentation must be greater than 0'
132
f.write('#' + (' ' * indent))
133
f.write(key.encode('utf-8'))
136
elif isinstance(value, basestring):
138
f.write(value.encode('utf-8'))
143
f.write('#' + (' ' * (indent+2)))
144
f.write(entry.encode('utf-8'))
147
def _write_revisions(self, pb):
148
"""Write the information for all of the revisions."""
150
# Optimize for the case of revisions in order
154
i_max = len(self.revision_ids)
155
for i, rev_id in enumerate(self.revision_ids):
156
pb.update("Generating revsion data", i, i_max)
157
rev = self.source.get_revision(rev_id)
158
if rev_id == last_rev_id:
159
rev_tree = last_rev_tree
161
base_tree = self.source.revision_tree(rev_id)
162
rev_tree = self.source.revision_tree(rev_id)
163
if rev_id in self.forced_bases:
165
base_id = self.forced_bases[rev_id]
167
base_id = NULL_REVISION
169
explicit_base = False
171
base_id = rev.parent_ids[-1]
173
base_id = NULL_REVISION
175
if base_id == last_rev_id:
176
base_tree = last_rev_tree
178
base_tree = self.source.revision_tree(base_id)
179
force_binary = (i != 0)
180
self._write_revision(rev, rev_tree, base_id, base_tree,
181
explicit_base, force_binary)
183
last_rev_id = base_id
184
last_rev_tree = base_tree
186
def _write_revision(self, rev, rev_tree, base_rev, base_tree,
187
explicit_base, force_binary):
188
"""Write out the information for a revision."""
190
self._write(key, value, indent=1)
192
w('message', rev.message.split('\n'))
193
w('committer', rev.committer)
194
w('date', format_highres_date(rev.timestamp, rev.timezone))
195
self.to_file.write('\n')
197
self._write_delta(rev_tree, base_tree, rev.revision_id, force_binary)
199
w('revision id', rev.revision_id)
200
w('sha1', StrictTestament.from_revision(self.source,
201
rev.revision_id).as_sha1())
202
w('inventory sha1', rev.inventory_sha1)
204
w('parent ids', rev.parent_ids)
206
w('base id', base_rev)
208
self._write('properties', None, indent=1)
209
for name, value in rev.properties.items():
210
self._write(name, value, indent=3)
212
# Add an extra blank space at the end
213
self.to_file.write('\n')
215
def _write_action(self, name, parameters, properties=None):
216
if properties is None:
218
p_texts = ['%s:%s' % v for v in properties]
219
self.to_file.write('=== ')
220
self.to_file.write(' '.join([name]+parameters).encode('utf-8'))
221
self.to_file.write(' // '.join(p_texts).encode('utf-8'))
222
self.to_file.write('\n')
224
def _write_delta(self, new_tree, old_tree, default_revision_id,
226
"""Write out the changes between the trees."""
227
DEVNULL = '/dev/null'
231
def do_diff(file_id, old_path, new_path, action, force_binary):
232
def tree_lines(tree, require_text=False):
234
tree_file = tree.get_file(file_id)
235
if require_text is True:
236
tree_file = text_file(tree_file)
237
return tree_file.readlines()
243
raise errors.BinaryFile()
244
old_lines = tree_lines(old_tree, require_text=True)
245
new_lines = tree_lines(new_tree, require_text=True)
246
action.write(self.to_file)
247
internal_diff(old_path, old_lines, new_path, new_lines,
249
except errors.BinaryFile:
250
old_lines = tree_lines(old_tree, require_text=False)
251
new_lines = tree_lines(new_tree, require_text=False)
252
action.add_property('encoding', 'base64')
253
action.write(self.to_file)
254
binary_diff(old_path, old_lines, new_path, new_lines,
257
def finish_action(action, file_id, kind, meta_modified, text_modified,
259
entry = new_tree.inventory[file_id]
260
if entry.revision != default_revision_id:
261
action.add_property('last-changed', entry.revision)
263
action.add_bool_property('executable', entry.executable)
264
if text_modified and kind == "symlink":
265
action.add_property('target', entry.symlink_target)
266
if text_modified and kind == "file":
267
do_diff(file_id, old_path, new_path, action, force_binary)
269
action.write(self.to_file)
271
delta = new_tree.changes_from(old_tree, want_unchanged=True)
272
for path, file_id, kind in delta.removed:
273
action = Action('removed', [kind, path]).write(self.to_file)
275
for path, file_id, kind in delta.added:
276
action = Action('added', [kind, path], [('file-id', file_id)])
277
meta_modified = (kind=='file' and
278
new_tree.is_executable(file_id))
279
finish_action(action, file_id, kind, meta_modified, True,
282
for (old_path, new_path, file_id, kind,
283
text_modified, meta_modified) in delta.renamed:
284
action = Action('renamed', [kind, old_path], [(new_path,)])
285
finish_action(action, file_id, kind, meta_modified, text_modified,
288
for (path, file_id, kind,
289
text_modified, meta_modified) in delta.modified:
290
action = Action('modified', [kind, path])
291
finish_action(action, file_id, kind, meta_modified, text_modified,
294
for path, file_id, kind in delta.unchanged:
295
ie = new_tree.inventory[file_id]
296
new_rev = getattr(ie, 'revision', None)
299
old_rev = getattr(old_tree.inventory[ie.file_id], 'revision', None)
300
if new_rev != old_rev:
301
action = Action('modified', [ie.kind,
302
new_tree.id2path(ie.file_id)])
303
action.add_property('last-changed', ie.revision)
304
action.write(self.to_file)
307
class BundleReader(object):
308
"""This class reads in a bundle from a file, and returns
309
a Bundle object, which can then be applied against a tree.
311
def __init__(self, from_file):
312
"""Read in the bundle from the file.
314
:param from_file: A file-like object (must have iterator support).
316
object.__init__(self)
317
self.from_file = iter(from_file)
318
self._next_line = None
320
self.info = BundleInfo08()
321
# We put the actual inventory ids in the footer, so that the patch
322
# is easier to read for humans.
323
# Unfortunately, that means we need to read everything before we
324
# can create a proper bundle.
330
while self._next_line is not None:
331
if not self._read_revision_header():
333
if self._next_line is None:
339
"""Make sure that the information read in makes sense
340
and passes appropriate checksums.
342
# Fill in all the missing blanks for the revisions
343
# and generate the real_revisions list.
344
self.info.complete_info()
347
"""yield the next line, but secretly
348
keep 1 extra line for peeking.
350
for line in self.from_file:
351
last = self._next_line
352
self._next_line = line
354
#mutter('yielding line: %r' % last)
356
last = self._next_line
357
self._next_line = None
358
#mutter('yielding line: %r' % last)
361
def _read_revision_header(self):
362
found_something = False
363
self.info.revisions.append(RevisionInfo(None))
364
for line in self._next():
365
# The bzr header is terminated with a blank line
366
# which does not start with '#'
367
if line is None or line == '\n':
369
if not line.startswith('#'):
371
found_something = True
372
self._handle_next(line)
373
if not found_something:
374
# Nothing was there, so remove the added revision
375
self.info.revisions.pop()
376
return found_something
378
def _read_next_entry(self, line, indent=1):
379
"""Read in a key-value pair
381
if not line.startswith('#'):
382
raise errors.MalformedHeader('Bzr header did not start with #')
383
line = line[1:-1].decode('utf-8') # Remove the '#' and '\n'
384
if line[:indent] == ' '*indent:
387
return None, None# Ignore blank lines
389
loc = line.find(': ')
394
value = self._read_many(indent=indent+2)
395
elif line[-1:] == ':':
397
value = self._read_many(indent=indent+2)
399
raise errors.MalformedHeader('While looking for key: value pairs,'
400
' did not find the colon %r' % (line))
402
key = key.replace(' ', '_')
403
#mutter('found %s: %s' % (key, value))
406
def _handle_next(self, line):
409
key, value = self._read_next_entry(line, indent=1)
410
mutter('_handle_next %r => %r' % (key, value))
414
revision_info = self.info.revisions[-1]
415
if hasattr(revision_info, key):
416
if getattr(revision_info, key) is None:
417
setattr(revision_info, key, value)
419
raise errors.MalformedHeader('Duplicated Key: %s' % key)
421
# What do we do with a key we don't recognize
422
raise errors.MalformedHeader('Unknown Key: "%s"' % key)
424
def _read_many(self, indent):
425
"""If a line ends with no entry, that means that it should be
426
followed with multiple lines of values.
428
This detects the end of the list, because it will be a line that
429
does not start properly indented.
432
start = '#' + (' '*indent)
434
if self._next_line is None or self._next_line[:len(start)] != start:
437
for line in self._next():
438
values.append(line[len(start):-1].decode('utf-8'))
439
if self._next_line is None or self._next_line[:len(start)] != start:
443
def _read_one_patch(self):
444
"""Read in one patch, return the complete patch, along with
447
:return: action, lines, do_continue
449
#mutter('_read_one_patch: %r' % self._next_line)
450
# Peek and see if there are no patches
451
if self._next_line is None or self._next_line.startswith('#'):
452
return None, [], False
456
for line in self._next():
458
if not line.startswith('==='):
459
raise errors.MalformedPatches('The first line of all patches'
460
' should be a bzr meta line "==="'
462
action = line[4:-1].decode('utf-8')
463
elif line.startswith('... '):
464
action += line[len('... '):-1].decode('utf-8')
466
if (self._next_line is not None and
467
self._next_line.startswith('===')):
468
return action, lines, True
469
elif self._next_line is None or self._next_line.startswith('#'):
470
return action, lines, False
474
elif not line.startswith('... '):
477
return action, lines, False
479
def _read_patches(self):
481
revision_actions = []
483
action, lines, do_continue = self._read_one_patch()
484
if action is not None:
485
revision_actions.append((action, lines))
486
assert self.info.revisions[-1].tree_actions is None
487
self.info.revisions[-1].tree_actions = revision_actions
489
def _read_footer(self):
490
"""Read the rest of the meta information.
492
:param first_line: The previous step iterates past what it
493
can handle. That extra line is given here.
495
for line in self._next():
496
self._handle_next(line)
497
if self._next_line is None:
499
if not self._next_line.startswith('#'):
500
# Consume the trailing \n and stop processing
505
class BundleInfo08(BundleInfo):
506
def _update_tree(self, bundle_tree, revision_id):
507
bundle_tree.note_last_changed('', revision_id)
508
BundleInfo._update_tree(self, bundle_tree, revision_id)
added
removed
bzrlib/bundle/serializer/v08.py
