1
# Copyright (C) 2008 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
34
class ShelfCreator(object):
35
"""Create a transform to shelve objects and its inverse."""
37
def __init__(self, work_tree, target_tree, file_list=None):
40
:param work_tree: The working tree to apply changes to
41
:param target_tree: The tree to make the working tree more similar to.
42
:param file_list: The files to make more similar to the target.
44
self.work_tree = work_tree
45
self.work_transform = transform.TreeTransform(work_tree)
47
self.target_tree = target_tree
48
self.shelf_transform = transform.TransformPreview(self.target_tree)
53
self.iter_changes = work_tree.iter_changes(
54
self.target_tree, specific_files=file_list)
56
self.shelf_transform.finalize()
59
self.work_transform.finalize()
62
def iter_shelvable(self):
63
"""Iterable of tuples describing shelvable changes.
65
As well as generating the tuples, this updates several members.
67
('add file', file_id, work_kind, work_path)
68
('delete file', file_id, target_kind, target_path)
69
('rename', file_id, target_path, work_path)
70
('change kind', file_id, target_kind, work_kind, target_path)
71
('modify text', file_id)
72
('modify target', file_id, target_target, work_target)
74
for (file_id, paths, changed, versioned, parents, names, kind,
75
executable) in self.iter_changes:
76
if kind[0] is None or versioned[0] == False:
77
self.creation[file_id] = (kind[1], names[1], parents[1],
79
yield ('add file', file_id, kind[1], paths[1])
80
elif kind[1] is None or versioned[0] == False:
81
self.deletion[file_id] = (kind[0], names[0], parents[0],
83
yield ('delete file', file_id, kind[0], paths[0])
85
if names[0] != names[1] or parents[0] != parents[1]:
86
self.renames[file_id] = (names, parents)
87
yield ('rename', file_id) + paths
89
if kind[0] != kind [1]:
90
yield ('change kind', file_id, kind[0], kind[1], paths[0])
91
elif kind[0] == 'symlink':
92
t_target = self.target_tree.get_symlink_target(file_id)
93
w_target = self.work_tree.get_symlink_target(file_id)
94
yield ('modify target', file_id, paths[0], t_target,
97
yield ('modify text', file_id)
99
def shelve_change(self, change):
100
"""Shelve a change in the iter_shelvable format."""
101
if change[0] == 'rename':
102
self.shelve_rename(change[1])
103
elif change[0] == 'delete file':
104
self.shelve_deletion(change[1])
105
elif change[0] == 'add file':
106
self.shelve_creation(change[1])
107
elif change[0] in ('change kind', 'modify text'):
108
self.shelve_content_change(change[1])
109
elif change[0] == 'modify target':
110
self.shelve_modify_target(change[1])
112
raise ValueError('Unknown change kind: "%s"' % change[0])
114
def shelve_all(self):
115
"""Shelve all changes."""
116
for change in self.iter_shelvable():
117
self.shelve_change(change)
119
def shelve_rename(self, file_id):
120
"""Shelve a file rename.
122
:param file_id: The file id of the file to shelve the renaming of.
124
names, parents = self.renames[file_id]
125
w_trans_id = self.work_transform.trans_id_file_id(file_id)
126
work_parent = self.work_transform.trans_id_file_id(parents[0])
127
self.work_transform.adjust_path(names[0], work_parent, w_trans_id)
129
s_trans_id = self.shelf_transform.trans_id_file_id(file_id)
130
shelf_parent = self.shelf_transform.trans_id_file_id(parents[1])
131
self.shelf_transform.adjust_path(names[1], shelf_parent, s_trans_id)
133
def shelve_modify_target(self, file_id):
134
"""Shelve a change of symlink target.
136
:param file_id: The file id of the symlink which changed target.
137
:param new_target: The target that the symlink should have due
140
new_target = self.target_tree.get_symlink_target(file_id)
141
w_trans_id = self.work_transform.trans_id_file_id(file_id)
142
self.work_transform.delete_contents(w_trans_id)
143
self.work_transform.create_symlink(new_target, w_trans_id)
145
old_target = self.work_tree.get_symlink_target(file_id)
146
s_trans_id = self.shelf_transform.trans_id_file_id(file_id)
147
self.shelf_transform.delete_contents(s_trans_id)
148
self.shelf_transform.create_symlink(old_target, s_trans_id)
150
def shelve_lines(self, file_id, new_lines):
151
"""Shelve text changes to a file, using provided lines.
153
:param file_id: The file id of the file to shelve the text of.
154
:param new_lines: The lines that the file should have due to shelving.
156
w_trans_id = self.work_transform.trans_id_file_id(file_id)
157
self.work_transform.delete_contents(w_trans_id)
158
self.work_transform.create_file(new_lines, w_trans_id)
160
s_trans_id = self.shelf_transform.trans_id_file_id(file_id)
161
self.shelf_transform.delete_contents(s_trans_id)
162
inverse_lines = self._inverse_lines(new_lines, file_id)
163
self.shelf_transform.create_file(inverse_lines, s_trans_id)
166
def _content_from_tree(tt, tree, file_id):
167
trans_id = tt.trans_id_file_id(file_id)
168
tt.delete_contents(trans_id)
169
transform.create_from_tree(tt, trans_id, tree, file_id)
171
def shelve_content_change(self, file_id):
172
"""Shelve a kind change or binary file content change.
174
:param file_id: The file id of the file to shelve the content change
177
self._content_from_tree(self.work_transform, self.target_tree, file_id)
178
self._content_from_tree(self.shelf_transform, self.work_tree, file_id)
180
def shelve_creation(self, file_id):
181
"""Shelve creation of a file.
183
This handles content and inventory id.
184
:param file_id: The file_id of the file to shelve creation of.
186
kind, name, parent, versioned = self.creation[file_id]
187
version = not versioned[0]
188
self._shelve_creation(self.work_tree, file_id, self.work_transform,
189
self.shelf_transform, kind, name, parent,
192
def shelve_deletion(self, file_id):
193
"""Shelve deletion of a file.
195
This handles content and inventory id.
196
:param file_id: The file_id of the file to shelve deletion of.
198
kind, name, parent, versioned = self.deletion[file_id]
199
existing_path = self.target_tree.id2path(file_id)
200
if not self.work_tree.has_filename(existing_path):
202
version = not versioned[1]
203
self._shelve_creation(self.target_tree, file_id, self.shelf_transform,
204
self.work_transform, kind, name, parent,
205
version, existing_path=existing_path)
207
def _shelve_creation(self, tree, file_id, from_transform, to_transform,
208
kind, name, parent, version, existing_path=None):
209
w_trans_id = from_transform.trans_id_file_id(file_id)
210
if parent is not None and kind is not None:
211
from_transform.delete_contents(w_trans_id)
212
from_transform.unversion_file(w_trans_id)
214
if existing_path is not None:
215
s_trans_id = to_transform.trans_id_tree_path(existing_path)
217
s_trans_id = to_transform.trans_id_file_id(file_id)
218
if parent is not None:
219
s_parent_id = to_transform.trans_id_file_id(parent)
220
to_transform.adjust_path(name, s_parent_id, s_trans_id)
221
if existing_path is None:
223
to_transform.create_file('', s_trans_id)
225
transform.create_from_tree(to_transform, s_trans_id,
228
to_transform.version_file(file_id, s_trans_id)
230
def _inverse_lines(self, new_lines, file_id):
231
"""Produce a version with only those changes removed from new_lines."""
232
target_lines = self.target_tree.get_file_lines(file_id)
233
work_lines = self.work_tree.get_file_lines(file_id)
234
return merge3.Merge3(new_lines, target_lines, work_lines).merge_lines()
237
"""Release all resources used by this ShelfCreator."""
238
self.work_transform.finalize()
239
self.shelf_transform.finalize()
242
"""Shelve changes from working tree."""
243
self.work_transform.apply()
245
def write_shelf(self, shelf_file, message=None):
246
"""Serialize the shelved changes to a file.
248
:param shelf_file: A file-like object to write the shelf to.
249
:param message: An optional message describing the shelved changes.
250
:return: the filename of the written file.
252
transform.resolve_conflicts(self.shelf_transform)
253
serializer = pack.ContainerSerialiser()
254
shelf_file.write(serializer.begin())
256
'revision_id': self.target_tree.get_revision_id(),
258
if message is not None:
259
metadata['message'] = message.encode('utf-8')
260
shelf_file.write(serializer.bytes_record(
261
bencode.bencode(metadata), (('metadata',),)))
262
for bytes in self.shelf_transform.serialize(serializer):
263
shelf_file.write(bytes)
264
shelf_file.write(serializer.end())
267
class Unshelver(object):
268
"""Unshelve shelved changes."""
270
def __init__(self, tree, base_tree, transform, message):
273
:param tree: The tree to apply the changes to.
274
:param base_tree: The basis to apply the tranform to.
275
:param message: A message from the shelved transform.
278
self.base_tree = base_tree
279
self.transform = transform
280
self.message = message
283
def iter_records(shelf_file):
284
parser = pack.ContainerPushParser()
285
parser.accept_bytes(shelf_file.read())
286
return iter(parser.read_pending_records())
289
def parse_metadata(records):
290
names, metadata_bytes = records.next()
291
if names[0] != ('metadata',):
292
raise errors.ShelfCorrupt
293
metadata = bencode.bdecode(metadata_bytes)
294
message = metadata.get('message')
295
if message is not None:
296
metadata['message'] = message.decode('utf-8')
300
def from_tree_and_shelf(klass, tree, shelf_file):
301
"""Create an Unshelver from a tree and a shelf file.
303
:param tree: The tree to apply shelved changes to.
304
:param shelf_file: A file-like object containing shelved changes.
305
:return: The Unshelver.
307
records = klass.iter_records(shelf_file)
308
metadata = klass.parse_metadata(records)
309
base_revision_id = metadata['revision_id']
311
base_tree = tree.revision_tree(base_revision_id)
312
except errors.NoSuchRevisionInTree:
313
base_tree = tree.branch.repository.revision_tree(base_revision_id)
314
tt = transform.TransformPreview(base_tree)
315
tt.deserialize(records)
316
return klass(tree, base_tree, tt, metadata.get('message'))
318
def make_merger(self, task=None):
319
"""Return a merger that can unshelve the changes."""
320
target_tree = self.transform.get_preview_tree()
321
merger = merge.Merger.from_uncommitted(self.tree, target_tree,
322
task, self.base_tree)
323
merger.merge_type = merge.Merge3Merger
327
"""Release all resources held by this Unshelver."""
328
self.transform.finalize()
331
class ShelfManager(object):
332
"""Maintain a list of shelved changes."""
334
def __init__(self, tree, transport):
336
self.transport = transport.clone('shelf')
337
self.transport.ensure_base()
339
def get_shelf_filename(self, shelf_id):
340
return 'shelf-%d' % shelf_id
342
def get_shelf_ids(self, filenames):
343
matcher = re.compile('shelf-([1-9][0-9]*)')
345
for filename in filenames:
346
match = matcher.match(filename)
347
if match is not None:
348
shelf_ids.append(int(match.group(1)))
352
"""Return a file object and id for a new set of shelved changes."""
353
last_shelf = self.last_shelf()
354
if last_shelf is None:
357
next_shelf = last_shelf + 1
358
filename = self.get_shelf_filename(next_shelf)
359
shelf_file = open(self.transport.local_abspath(filename), 'wb')
360
return next_shelf, shelf_file
362
def shelve_changes(self, creator, message=None):
363
"""Store the changes in a ShelfCreator on a shelf."""
364
next_shelf, shelf_file = self.new_shelf()
366
creator.write_shelf(shelf_file, message)
372
def read_shelf(self, shelf_id):
373
"""Return the file associated with a shelf_id for reading.
375
:param shelf_id: The id of the shelf to retrive the file for.
377
filename = self.get_shelf_filename(shelf_id)
379
return open(self.transport.local_abspath(filename), 'rb')
381
if e.errno != errno.ENOENT:
383
from bzrlib import errors
384
raise errors.NoSuchShelfId(shelf_id)
386
def get_unshelver(self, shelf_id):
387
"""Return an unshelver for a given shelf_id.
389
:param shelf_id: The shelf id to return the unshelver for.
391
shelf_file = self.read_shelf(shelf_id)
393
return Unshelver.from_tree_and_shelf(self.tree, shelf_file)
397
def get_metadata(self, shelf_id):
398
"""Return the metadata associated with a given shelf_id."""
399
shelf_file = self.read_shelf(shelf_id)
401
records = Unshelver.iter_records(shelf_file)
404
return Unshelver.parse_metadata(records)
406
def delete_shelf(self, shelf_id):
407
"""Delete the shelved changes for a given id.
409
:param shelf_id: id of the shelved changes to delete.
411
filename = self.get_shelf_filename(shelf_id)
412
self.transport.delete(filename)
414
def active_shelves(self):
415
"""Return a list of shelved changes."""
416
active = self.get_shelf_ids(self.transport.list_dir('.'))
420
def last_shelf(self):
421
"""Return the id of the last-created shelved change."""
422
active = self.active_shelves()
added
removed
bzrlib/shelf.py
