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
rev_tree = self.source.revision_tree(rev_id)
162
if rev_id in self.forced_bases:
164
base_id = self.forced_bases[rev_id]
166
base_id = NULL_REVISION
168
explicit_base = False
170
base_id = rev.parent_ids[-1]
172
base_id = NULL_REVISION
174
if base_id == last_rev_id:
175
base_tree = last_rev_tree
177
base_tree = self.source.revision_tree(base_id)
178
force_binary = (i != 0)
179
self._write_revision(rev, rev_tree, base_id, base_tree,
180
explicit_base, force_binary)
182
last_rev_id = base_id
183
last_rev_tree = base_tree
185
def _write_revision(self, rev, rev_tree, base_rev, base_tree,
186
explicit_base, force_binary):
187
"""Write out the information for a revision."""
189
self._write(key, value, indent=1)
191
w('message', rev.message.split('\n'))
192
w('committer', rev.committer)
193
w('date', format_highres_date(rev.timestamp, rev.timezone))
194
self.to_file.write('\n')
196
self._write_delta(rev_tree, base_tree, rev.revision_id, force_binary)
198
w('revision id', rev.revision_id)
199
w('sha1', StrictTestament.from_revision(self.source,
200
rev.revision_id).as_sha1())
201
w('inventory sha1', rev.inventory_sha1)
203
w('parent ids', rev.parent_ids)
205
w('base id', base_rev)
207
self._write('properties', None, indent=1)
208
for name, value in rev.properties.items():
209
self._write(name, value, indent=3)
211
# Add an extra blank space at the end
212
self.to_file.write('\n')
214
def _write_action(self, name, parameters, properties=None):
215
if properties is None:
217
p_texts = ['%s:%s' % v for v in properties]
218
self.to_file.write('=== ')
219
self.to_file.write(' '.join([name]+parameters).encode('utf-8'))
220
self.to_file.write(' // '.join(p_texts).encode('utf-8'))
221
self.to_file.write('\n')
223
def _write_delta(self, new_tree, old_tree, default_revision_id,
225
"""Write out the changes between the trees."""
226
DEVNULL = '/dev/null'
230
def bundle_path(path):
236
def do_diff(file_id, old_path, new_path, action, force_binary):
237
def tree_lines(tree, require_text=False):
239
tree_file = tree.get_file(file_id)
240
if require_text is True:
241
tree_file = text_file(tree_file)
242
return tree_file.readlines()
248
raise errors.BinaryFile()
249
old_lines = tree_lines(old_tree, require_text=True)
250
new_lines = tree_lines(new_tree, require_text=True)
251
action.write(self.to_file)
252
internal_diff(old_path, old_lines, new_path, new_lines,
254
except errors.BinaryFile:
255
old_lines = tree_lines(old_tree, require_text=False)
256
new_lines = tree_lines(new_tree, require_text=False)
257
action.add_property('encoding', 'base64')
258
action.write(self.to_file)
259
binary_diff(old_path, old_lines, new_path, new_lines,
262
def finish_action(action, file_id, kind, meta_modified, text_modified,
264
entry = new_tree.inventory[file_id]
265
if (entry.revision != default_revision_id and
266
entry.revision is not None):
267
action.add_property('last-changed', entry.revision)
269
action.add_bool_property('executable', entry.executable)
270
if text_modified and kind == "symlink":
271
action.add_property('target', entry.symlink_target)
272
if text_modified and kind == "file":
273
do_diff(file_id, old_path, new_path, action, force_binary)
275
action.write(self.to_file)
277
delta = new_tree.changes_from(old_tree, want_unchanged=True,
279
for path, file_id, kind in delta.removed:
280
action = Action('removed', [kind, path]).write(self.to_file)
282
for path, file_id, kind in delta.added:
283
action = Action('added', [kind, bundle_path(path)],
284
[('file-id', file_id)])
285
meta_modified = (kind=='file' and
286
new_tree.is_executable(file_id))
287
finish_action(action, file_id, kind, meta_modified, True,
290
for (old_path, new_path, file_id, kind,
291
text_modified, meta_modified) in delta.renamed:
292
action = Action('renamed', [kind, bundle_path(old_path)],
293
[(bundle_path(new_path),)])
294
finish_action(action, file_id, kind, meta_modified, text_modified,
297
for (path, file_id, kind,
298
text_modified, meta_modified) in delta.modified:
299
action = Action('modified', [kind, bundle_path(path)])
300
finish_action(action, file_id, kind, meta_modified, text_modified,
303
for path, file_id, kind in delta.unchanged:
304
ie = new_tree.inventory[file_id]
305
new_rev = getattr(ie, 'revision', None)
308
old_rev = getattr(old_tree.inventory[ie.file_id], 'revision', None)
309
if new_rev != old_rev:
310
action = Action('modified',
311
[ie.kind, bundle_path(new_tree.id2path(ie.file_id))])
312
if ie.revision is not None:
313
action.add_property('last-changed', ie.revision)
314
action.write(self.to_file)
317
class BundleReader(object):
318
"""This class reads in a bundle from a file, and returns
319
a Bundle object, which can then be applied against a tree.
321
def __init__(self, from_file):
322
"""Read in the bundle from the file.
324
:param from_file: A file-like object (must have iterator support).
326
object.__init__(self)
327
self.from_file = iter(from_file)
328
self._next_line = None
330
self.info = BundleInfo08()
331
# We put the actual inventory ids in the footer, so that the patch
332
# is easier to read for humans.
333
# Unfortunately, that means we need to read everything before we
334
# can create a proper bundle.
340
while self._next_line is not None:
341
if not self._read_revision_header():
343
if self._next_line is None:
349
"""Make sure that the information read in makes sense
350
and passes appropriate checksums.
352
# Fill in all the missing blanks for the revisions
353
# and generate the real_revisions list.
354
self.info.complete_info()
357
"""yield the next line, but secretly
358
keep 1 extra line for peeking.
360
for line in self.from_file:
361
last = self._next_line
362
self._next_line = line
364
#mutter('yielding line: %r' % last)
366
last = self._next_line
367
self._next_line = None
368
#mutter('yielding line: %r' % last)
371
def _read_revision_header(self):
372
found_something = False
373
self.info.revisions.append(RevisionInfo(None))
374
for line in self._next():
375
# The bzr header is terminated with a blank line
376
# which does not start with '#'
377
if line is None or line == '\n':
379
if not line.startswith('#'):
381
found_something = True
382
self._handle_next(line)
383
if not found_something:
384
# Nothing was there, so remove the added revision
385
self.info.revisions.pop()
386
return found_something
388
def _read_next_entry(self, line, indent=1):
389
"""Read in a key-value pair
391
if not line.startswith('#'):
392
raise errors.MalformedHeader('Bzr header did not start with #')
393
line = line[1:-1].decode('utf-8') # Remove the '#' and '\n'
394
if line[:indent] == ' '*indent:
397
return None, None# Ignore blank lines
399
loc = line.find(': ')
404
value = self._read_many(indent=indent+2)
405
elif line[-1:] == ':':
407
value = self._read_many(indent=indent+2)
409
raise errors.MalformedHeader('While looking for key: value pairs,'
410
' did not find the colon %r' % (line))
412
key = key.replace(' ', '_')
413
#mutter('found %s: %s' % (key, value))
416
def _handle_next(self, line):
419
key, value = self._read_next_entry(line, indent=1)
420
mutter('_handle_next %r => %r' % (key, value))
424
revision_info = self.info.revisions[-1]
425
if key in revision_info.__dict__:
426
if getattr(revision_info, key) is None:
427
setattr(revision_info, key, value)
429
raise errors.MalformedHeader('Duplicated Key: %s' % key)
431
# What do we do with a key we don't recognize
432
raise errors.MalformedHeader('Unknown Key: "%s"' % key)
434
def _read_many(self, indent):
435
"""If a line ends with no entry, that means that it should be
436
followed with multiple lines of values.
438
This detects the end of the list, because it will be a line that
439
does not start properly indented.
442
start = '#' + (' '*indent)
444
if self._next_line is None or self._next_line[:len(start)] != start:
447
for line in self._next():
448
values.append(line[len(start):-1].decode('utf-8'))
449
if self._next_line is None or self._next_line[:len(start)] != start:
453
def _read_one_patch(self):
454
"""Read in one patch, return the complete patch, along with
457
:return: action, lines, do_continue
459
#mutter('_read_one_patch: %r' % self._next_line)
460
# Peek and see if there are no patches
461
if self._next_line is None or self._next_line.startswith('#'):
462
return None, [], False
466
for line in self._next():
468
if not line.startswith('==='):
469
raise errors.MalformedPatches('The first line of all patches'
470
' should be a bzr meta line "==="'
472
action = line[4:-1].decode('utf-8')
473
elif line.startswith('... '):
474
action += line[len('... '):-1].decode('utf-8')
476
if (self._next_line is not None and
477
self._next_line.startswith('===')):
478
return action, lines, True
479
elif self._next_line is None or self._next_line.startswith('#'):
480
return action, lines, False
484
elif not line.startswith('... '):
487
return action, lines, False
489
def _read_patches(self):
491
revision_actions = []
493
action, lines, do_continue = self._read_one_patch()
494
if action is not None:
495
revision_actions.append((action, lines))
496
assert self.info.revisions[-1].tree_actions is None
497
self.info.revisions[-1].tree_actions = revision_actions
499
def _read_footer(self):
500
"""Read the rest of the meta information.
502
:param first_line: The previous step iterates past what it
503
can handle. That extra line is given here.
505
for line in self._next():
506
self._handle_next(line)
507
if self._next_line is None:
509
if not self._next_line.startswith('#'):
510
# Consume the trailing \n and stop processing
515
class BundleInfo08(BundleInfo):
516
def _update_tree(self, bundle_tree, revision_id):
517
bundle_tree.note_last_changed('', revision_id)
518
BundleInfo._update_tree(self, bundle_tree, revision_id)
added
removed
bzrlib/bundle/serializer/v08.py
