1
# Copyright (C) 2005, 2006, 2009 Canonical Ltd
1
# Copyright (C) 2005, 2006 by Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
"""Serializer factory for reading and writing bundles.
22
from bzrlib import errors
26
23
from bzrlib.bundle.serializer import (BundleSerializer,
29
28
from bzrlib.bundle.serializer import binary_diff
30
29
from bzrlib.bundle.bundle_data import (RevisionInfo, BundleInfo, BundleTree)
31
30
from bzrlib.diff import internal_diff
32
31
from bzrlib.osutils import pathjoin
32
from bzrlib.progress import DummyProgress
33
33
from bzrlib.revision import NULL_REVISION
34
from bzrlib.rio import RioWriter, read_stanzas
34
36
from bzrlib.testament import StrictTestament
35
from bzrlib.timestamp import (
39
37
from bzrlib.textfile import text_file
40
38
from bzrlib.trace import mutter
57
55
self.properties = properties
59
def add_utf8_property(self, name, value):
60
"""Add a property whose value is currently utf8 to the action."""
61
self.properties.append((name, value.decode('utf8')))
63
57
def add_property(self, name, value):
64
58
"""Add a property to the action"""
65
59
self.properties.append((name, value))
103
97
def check_compatible(self):
104
98
if self.source.supports_rich_root():
105
raise errors.IncompatibleBundleFormat('0.8', repr(self.source))
99
raise errors.IncompatibleFormat('0.8', repr(self.source))
107
101
def write(self, source, revision_ids, forced_bases, f):
108
102
"""Write the bundless to the supplied files.
120
114
source.lock_read()
122
116
self._write_main_header()
123
pb = ui.ui_factory.nested_progress_bar()
125
119
self._write_revisions(pb)
131
def write_bundle(self, repository, target, base, fileobj):
132
return self._write_bundle(repository, target, base, fileobj)
134
126
def _write_main_header(self):
135
127
"""Write the header for the changes"""
137
f.write(_get_bundle_header('0.8'))
129
f.write(BUNDLE_HEADER)
140
def _write(self, key, value, indent=1, trailing_space_when_empty=False):
141
"""Write out meta information, with proper indenting, etc.
143
:param trailing_space_when_empty: To work around a bug in earlier
144
bundle readers, when writing an empty property, we use "prop: \n"
145
rather than writing "prop:\n".
146
If this parameter is True, and value is the empty string, we will
147
write an extra space.
150
raise ValueError('indentation must be greater than 0')
133
def _write(self, key, value, indent=1):
134
"""Write out meta information, with proper indenting, etc"""
135
assert indent > 0, 'indentation must be greater than 0'
152
137
f.write('#' + (' ' * indent))
153
138
f.write(key.encode('utf-8'))
155
if trailing_space_when_empty and value == '':
159
elif isinstance(value, str):
163
elif isinstance(value, unicode):
141
elif isinstance(value, basestring):
165
143
f.write(value.encode('utf-8'))
169
147
for entry in value:
170
148
f.write('#' + (' ' * (indent+2)))
171
if isinstance(entry, str):
174
f.write(entry.encode('utf-8'))
149
f.write(entry.encode('utf-8'))
177
152
def _write_revisions(self, pb):
181
156
last_rev_id = None
182
157
last_rev_tree = None
184
i_max = len(self.revision_ids)
159
i_max = len(self.revision_ids)
185
160
for i, rev_id in enumerate(self.revision_ids):
186
pb.update("Generating revision data", i, i_max)
161
pb.update("Generating revsion data", i, i_max)
187
162
rev = self.source.get_revision(rev_id)
188
163
if rev_id == last_rev_id:
189
164
rev_tree = last_rev_tree
207
182
base_tree = self.source.revision_tree(base_id)
208
183
force_binary = (i != 0)
209
self._write_revision(rev, rev_tree, base_id, base_tree,
184
self._write_revision(rev, rev_tree, base_id, base_tree,
210
185
explicit_base, force_binary)
212
187
last_rev_id = base_id
213
188
last_rev_tree = base_tree
215
190
def _testament_sha1(self, revision_id):
216
return StrictTestament.from_revision(self.source,
191
return StrictTestament.from_revision(self.source,
217
192
revision_id).as_sha1()
219
def _write_revision(self, rev, rev_tree, base_rev, base_tree,
194
def _write_revision(self, rev, rev_tree, base_rev, base_tree,
220
195
explicit_base, force_binary):
221
196
"""Write out the information for a revision."""
222
197
def w(key, value):
238
213
w('base id', base_rev)
239
214
if rev.properties:
240
215
self._write('properties', None, indent=1)
241
for name, value in sorted(rev.properties.items()):
242
self._write(name, value, indent=3,
243
trailing_space_when_empty=True)
216
for name, value in rev.properties.items():
217
self._write(name, value, indent=3)
245
219
# Add an extra blank space at the end
246
220
self.to_file.write('\n')
254
228
self.to_file.write(' // '.join(p_texts).encode('utf-8'))
255
229
self.to_file.write('\n')
257
def _write_delta(self, new_tree, old_tree, default_revision_id,
231
def _write_delta(self, new_tree, old_tree, default_revision_id,
259
233
"""Write out the changes between the trees."""
260
234
DEVNULL = '/dev/null'
277
251
old_lines = tree_lines(old_tree, require_text=True)
278
252
new_lines = tree_lines(new_tree, require_text=True)
279
253
action.write(self.to_file)
280
internal_diff(old_path, old_lines, new_path, new_lines,
254
internal_diff(old_path, old_lines, new_path, new_lines,
282
256
except errors.BinaryFile:
283
257
old_lines = tree_lines(old_tree, require_text=False)
284
258
new_lines = tree_lines(new_tree, require_text=False)
285
259
action.add_property('encoding', 'base64')
286
260
action.write(self.to_file)
287
binary_diff(old_path, old_lines, new_path, new_lines,
261
binary_diff(old_path, old_lines, new_path, new_lines,
290
264
def finish_action(action, file_id, kind, meta_modified, text_modified,
291
265
old_path, new_path):
292
266
entry = new_tree.inventory[file_id]
293
267
if entry.revision != default_revision_id:
294
action.add_utf8_property('last-changed', entry.revision)
268
action.add_property('last-changed', entry.revision)
295
269
if meta_modified:
296
270
action.add_bool_property('executable', entry.executable)
297
271
if text_modified and kind == "symlink":
309
283
for path, file_id, kind in delta.added:
310
284
action = Action('added', [kind, path], [('file-id', file_id)])
311
meta_modified = (kind=='file' and
285
meta_modified = (kind=='file' and
312
286
new_tree.is_executable(file_id))
313
287
finish_action(action, file_id, kind, meta_modified, True,
333
307
old_rev = getattr(old_tree.inventory[ie.file_id], 'revision', None)
334
308
if new_rev != old_rev:
335
action = Action('modified', [ie.kind,
309
action = Action('modified', [ie.kind,
336
310
new_tree.id2path(ie.file_id)])
337
action.add_utf8_property('last-changed', ie.revision)
311
action.add_property('last-changed', ie.revision)
338
312
action.write(self.to_file)
350
324
object.__init__(self)
351
325
self.from_file = iter(from_file)
352
326
self._next_line = None
354
328
self.info = self._get_info()
355
329
# We put the actual inventory ids in the footer, so that the patch
356
330
# is easier to read for humans.
451
425
revision_info = self.info.revisions[-1]
452
426
if key in revision_info.__dict__:
453
427
if getattr(revision_info, key) is None:
454
if key in ('file_id', 'revision_id', 'base_id'):
455
value = value.encode('utf8')
456
elif key in ('parent_ids'):
457
value = [v.encode('utf8') for v in value]
458
428
setattr(revision_info, key, value)
460
430
raise errors.MalformedHeader('Duplicated Key: %s' % key)
462
432
# What do we do with a key we don't recognize
463
433
raise errors.MalformedHeader('Unknown Key: "%s"' % key)
465
435
def _read_many(self, indent):
466
436
"""If a line ends with no entry, that means that it should be
467
437
followed with multiple lines of values.
504
474
elif line.startswith('... '):
505
475
action += line[len('... '):-1].decode('utf-8')
507
if (self._next_line is not None and
477
if (self._next_line is not None and
508
478
self._next_line.startswith('===')):
509
479
return action, lines, True
510
480
elif self._next_line is None or self._next_line.startswith('#'):
524
494
action, lines, do_continue = self._read_one_patch()
525
495
if action is not None:
526
496
revision_actions.append((action, lines))
527
if self.info.revisions[-1].tree_actions is not None:
528
raise AssertionError()
497
assert self.info.revisions[-1].tree_actions is None
529
498
self.info.revisions[-1].tree_actions = revision_actions
531
500
def _read_footer(self):