1
# Copyright (C) 2008 Canonical Ltd
1
# Copyright (C) 2008, 2009, 2010 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
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
23
from .lazy_import import lazy_import
24
lazy_import(globals(), """
31
from breezy.bzr import (
37
class ShelfCorrupt(errors.BzrError):
39
_fmt = "Shelf corrupt."
42
class NoSuchShelfId(errors.BzrError):
44
_fmt = 'No changes are shelved with id "%(shelf_id)d".'
46
def __init__(self, shelf_id):
47
errors.BzrError.__init__(self, shelf_id=shelf_id)
50
class InvalidShelfId(errors.BzrError):
52
_fmt = '"%(invalid_id)s" is not a valid shelf id, try a number instead.'
54
def __init__(self, invalid_id):
55
errors.BzrError.__init__(self, invalid_id=invalid_id)
31
58
class ShelfCreator(object):
62
89
"""Iterable of tuples describing shelvable changes.
64
91
As well as generating the tuples, this updates several members.
66
94
('add file', file_id, work_kind, work_path)
67
95
('delete file', file_id, target_kind, target_path)
68
96
('rename', file_id, target_path, work_path)
78
106
# when a tree root was deleted / renamed.
79
107
if kind[0] is None and names[1] == '':
109
# Also don't shelve deletion of tree root.
110
if kind[1] is None and names[0] == '':
81
112
if kind[0] is None or versioned[0] == False:
82
113
self.creation[file_id] = (kind[1], names[1], parents[1],
94
125
if kind[0] != kind [1]:
95
126
yield ('change kind', file_id, kind[0], kind[1], paths[0])
96
127
elif kind[0] == 'symlink':
97
t_target = self.target_tree.get_symlink_target(file_id)
98
w_target = self.work_tree.get_symlink_target(file_id)
99
yield ('modify target', file_id, paths[0], t_target,
128
t_target = self.target_tree.get_symlink_target(paths[0], file_id)
129
w_target = self.work_tree.get_symlink_target(paths[1], file_id)
130
yield ('modify target', file_id, paths[0], t_target, w_target)
102
132
yield ('modify text', file_id)
112
142
elif change[0] in ('change kind', 'modify text'):
113
143
self.shelve_content_change(change[1])
114
144
elif change[0] == 'modify target':
115
self.shelve_modify_target(change[1])
145
self.shelve_modify_target(change[1], change[2], change[3])
117
147
raise ValueError('Unknown change kind: "%s"' % change[0])
119
149
def shelve_all(self):
120
"""Shelve all changes."""
150
"""Shelve all changes.
152
:return: True if changes were shelved, False if there were no changes.
121
155
for change in self.iter_shelvable():
122
156
self.shelve_change(change)
157
return change is not None
124
159
def shelve_rename(self, file_id):
125
160
"""Shelve a file rename.
135
170
shelf_parent = self.shelf_transform.trans_id_file_id(parents[1])
136
171
self.shelf_transform.adjust_path(names[1], shelf_parent, s_trans_id)
138
def shelve_modify_target(self, file_id):
173
def shelve_modify_target(self, file_id, target_target, work_target):
139
174
"""Shelve a change of symlink target.
141
176
:param file_id: The file id of the symlink which changed target.
142
:param new_target: The target that the symlink should have due
177
:param target_target: The target tree target
178
:param work_target: The work tree target
145
new_target = self.target_tree.get_symlink_target(file_id)
146
180
w_trans_id = self.work_transform.trans_id_file_id(file_id)
147
181
self.work_transform.delete_contents(w_trans_id)
148
self.work_transform.create_symlink(new_target, w_trans_id)
182
self.work_transform.create_symlink(work_target, w_trans_id)
150
old_target = self.work_tree.get_symlink_target(file_id)
151
184
s_trans_id = self.shelf_transform.trans_id_file_id(file_id)
152
185
self.shelf_transform.delete_contents(s_trans_id)
153
self.shelf_transform.create_symlink(old_target, s_trans_id)
186
self.shelf_transform.create_symlink(target_target, s_trans_id)
155
188
def shelve_lines(self, file_id, new_lines):
156
189
"""Shelve text changes to a file, using provided lines.
171
204
def _content_from_tree(tt, tree, file_id):
172
205
trans_id = tt.trans_id_file_id(file_id)
173
206
tt.delete_contents(trans_id)
174
transform.create_from_tree(tt, trans_id, tree, file_id)
207
transform.create_from_tree(
208
tt, trans_id, tree, tree.id2path(file_id),
176
211
def shelve_content_change(self, file_id):
177
212
"""Shelve a kind change or binary file content change.
228
263
to_transform.create_file('', s_trans_id)
230
265
transform.create_from_tree(to_transform, s_trans_id,
266
tree, tree.id2path(file_id),
233
269
to_transform.version_file(file_id, s_trans_id)
235
271
def _inverse_lines(self, new_lines, file_id):
236
272
"""Produce a version with only those changes removed from new_lines."""
237
target_lines = self.target_tree.get_file_lines(file_id)
238
work_lines = self.work_tree.get_file_lines(file_id)
273
target_path = self.target_tree.id2path(file_id)
274
target_lines = self.target_tree.get_file_lines(target_path, file_id)
275
wt_path = self.work_tree.id2path(file_id)
276
work_lines = self.work_tree.get_file_lines(wt_path, file_id)
239
277
return merge3.Merge3(new_lines, target_lines, work_lines).merge_lines()
241
279
def finalize(self):
247
285
"""Shelve changes from working tree."""
248
286
self.work_transform.apply()
289
def metadata_record(serializer, revision_id, message=None):
290
metadata = {'revision_id': revision_id}
291
if message is not None:
292
metadata['message'] = message.encode('utf-8')
293
return serializer.bytes_record(
294
bencode.bencode(metadata), (('metadata',),))
250
296
def write_shelf(self, shelf_file, message=None):
251
297
"""Serialize the shelved changes to a file.
255
301
:return: the filename of the written file.
257
303
transform.resolve_conflicts(self.shelf_transform)
304
revision_id = self.target_tree.get_revision_id()
305
return self._write_shelf(shelf_file, self.shelf_transform, revision_id,
309
def _write_shelf(cls, shelf_file, transform, revision_id, message=None):
258
310
serializer = pack.ContainerSerialiser()
259
311
shelf_file.write(serializer.begin())
261
'revision_id': self.target_tree.get_revision_id(),
263
if message is not None:
264
metadata['message'] = message.encode('utf-8')
265
shelf_file.write(serializer.bytes_record(
266
bencode.bencode(metadata), (('metadata',),)))
267
for bytes in self.shelf_transform.serialize(serializer):
312
metadata = cls.metadata_record(serializer, revision_id, message)
313
shelf_file.write(metadata)
314
for bytes in transform.serialize(serializer):
268
315
shelf_file.write(bytes)
269
316
shelf_file.write(serializer.end())
294
341
def parse_metadata(records):
295
names, metadata_bytes = records.next()
342
names, metadata_bytes = next(records)
296
343
if names[0] != ('metadata',):
297
raise errors.ShelfCorrupt
298
345
metadata = bencode.bdecode(metadata_bytes)
299
346
message = metadata.get('message')
300
347
if message is not None:
320
367
tt.deserialize(records)
321
368
return klass(tree, base_tree, tt, metadata.get('message'))
323
def make_merger(self, task=None):
370
def make_merger(self):
324
371
"""Return a merger that can unshelve the changes."""
325
372
target_tree = self.transform.get_preview_tree()
326
373
merger = merge.Merger.from_uncommitted(self.tree, target_tree,
327
task, self.base_tree)
328
375
merger.merge_type = merge.Merge3Merger
382
429
filename = self.get_shelf_filename(shelf_id)
384
431
return open(self.transport.local_abspath(filename), 'rb')
386
433
if e.errno != errno.ENOENT:
388
from bzrlib import errors
389
raise errors.NoSuchShelfId(shelf_id)
435
raise NoSuchShelfId(shelf_id)
391
437
def get_unshelver(self, shelf_id):
392
438
"""Return an unshelver for a given shelf_id.