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
# don't shelve add of tree root. Working tree should never
77
# lack roots, and bzr misbehaves when they do.
78
# FIXME ADHB (2009-08-09): should still shelve adds of tree roots
79
# when a tree root was deleted / renamed.
80
if kind[0] is None and names[1] == '':
82
if kind[0] is None or versioned[0] == False:
83
self.creation[file_id] = (kind[1], names[1], parents[1],
85
yield ('add file', file_id, kind[1], paths[1])
86
elif kind[1] is None or versioned[0] == False:
87
self.deletion[file_id] = (kind[0], names[0], parents[0],
89
yield ('delete file', file_id, kind[0], paths[0])
91
if names[0] != names[1] or parents[0] != parents[1]:
92
self.renames[file_id] = (names, parents)
93
yield ('rename', file_id) + paths
95
if kind[0] != kind [1]:
96
yield ('change kind', file_id, kind[0], kind[1], paths[0])
97
elif kind[0] == 'symlink':
98
t_target = self.target_tree.get_symlink_target(file_id)
99
w_target = self.work_tree.get_symlink_target(file_id)
100
yield ('modify target', file_id, paths[0], t_target,
103
yield ('modify text', file_id)
105
def shelve_change(self, change):
106
"""Shelve a change in the iter_shelvable format."""
107
if change[0] == 'rename':
108
self.shelve_rename(change[1])
109
elif change[0] == 'delete file':
110
self.shelve_deletion(change[1])
111
elif change[0] == 'add file':
112
self.shelve_creation(change[1])
113
elif change[0] in ('change kind', 'modify text'):
114
self.shelve_content_change(change[1])
115
elif change[0] == 'modify target':
116
self.shelve_modify_target(change[1])
118
raise ValueError('Unknown change kind: "%s"' % change[0])
120
def shelve_all(self):
121
"""Shelve all changes."""
122
for change in self.iter_shelvable():
123
self.shelve_change(change)
125
def shelve_rename(self, file_id):
126
"""Shelve a file rename.
128
:param file_id: The file id of the file to shelve the renaming of.
130
names, parents = self.renames[file_id]
131
w_trans_id = self.work_transform.trans_id_file_id(file_id)
132
work_parent = self.work_transform.trans_id_file_id(parents[0])
133
self.work_transform.adjust_path(names[0], work_parent, w_trans_id)
135
s_trans_id = self.shelf_transform.trans_id_file_id(file_id)
136
shelf_parent = self.shelf_transform.trans_id_file_id(parents[1])
137
self.shelf_transform.adjust_path(names[1], shelf_parent, s_trans_id)
139
def shelve_modify_target(self, file_id):
140
"""Shelve a change of symlink target.
142
:param file_id: The file id of the symlink which changed target.
143
:param new_target: The target that the symlink should have due
146
new_target = self.target_tree.get_symlink_target(file_id)
147
w_trans_id = self.work_transform.trans_id_file_id(file_id)
148
self.work_transform.delete_contents(w_trans_id)
149
self.work_transform.create_symlink(new_target, w_trans_id)
151
old_target = self.work_tree.get_symlink_target(file_id)
152
s_trans_id = self.shelf_transform.trans_id_file_id(file_id)
153
self.shelf_transform.delete_contents(s_trans_id)
154
self.shelf_transform.create_symlink(old_target, s_trans_id)
156
def shelve_lines(self, file_id, new_lines):
157
"""Shelve text changes to a file, using provided lines.
159
:param file_id: The file id of the file to shelve the text of.
160
:param new_lines: The lines that the file should have due to shelving.
162
w_trans_id = self.work_transform.trans_id_file_id(file_id)
163
self.work_transform.delete_contents(w_trans_id)
164
self.work_transform.create_file(new_lines, w_trans_id)
166
s_trans_id = self.shelf_transform.trans_id_file_id(file_id)
167
self.shelf_transform.delete_contents(s_trans_id)
168
inverse_lines = self._inverse_lines(new_lines, file_id)
169
self.shelf_transform.create_file(inverse_lines, s_trans_id)
172
def _content_from_tree(tt, tree, file_id):
173
trans_id = tt.trans_id_file_id(file_id)
174
tt.delete_contents(trans_id)
175
transform.create_from_tree(tt, trans_id, tree, file_id)
177
def shelve_content_change(self, file_id):
178
"""Shelve a kind change or binary file content change.
180
:param file_id: The file id of the file to shelve the content change
183
self._content_from_tree(self.work_transform, self.target_tree, file_id)
184
self._content_from_tree(self.shelf_transform, self.work_tree, file_id)
186
def shelve_creation(self, file_id):
187
"""Shelve creation of a file.
189
This handles content and inventory id.
190
:param file_id: The file_id of the file to shelve creation of.
192
kind, name, parent, versioned = self.creation[file_id]
193
version = not versioned[0]
194
self._shelve_creation(self.work_tree, file_id, self.work_transform,
195
self.shelf_transform, kind, name, parent,
198
def shelve_deletion(self, file_id):
199
"""Shelve deletion of a file.
201
This handles content and inventory id.
202
:param file_id: The file_id of the file to shelve deletion of.
204
kind, name, parent, versioned = self.deletion[file_id]
205
existing_path = self.target_tree.id2path(file_id)
206
if not self.work_tree.has_filename(existing_path):
208
version = not versioned[1]
209
self._shelve_creation(self.target_tree, file_id, self.shelf_transform,
210
self.work_transform, kind, name, parent,
211
version, existing_path=existing_path)
213
def _shelve_creation(self, tree, file_id, from_transform, to_transform,
214
kind, name, parent, version, existing_path=None):
215
w_trans_id = from_transform.trans_id_file_id(file_id)
216
if parent is not None and kind is not None:
217
from_transform.delete_contents(w_trans_id)
218
from_transform.unversion_file(w_trans_id)
220
if existing_path is not None:
221
s_trans_id = to_transform.trans_id_tree_path(existing_path)
223
s_trans_id = to_transform.trans_id_file_id(file_id)
224
if parent is not None:
225
s_parent_id = to_transform.trans_id_file_id(parent)
226
to_transform.adjust_path(name, s_parent_id, s_trans_id)
227
if existing_path is None:
229
to_transform.create_file('', s_trans_id)
231
transform.create_from_tree(to_transform, s_trans_id,
234
to_transform.version_file(file_id, s_trans_id)
236
def _inverse_lines(self, new_lines, file_id):
237
"""Produce a version with only those changes removed from new_lines."""
238
target_lines = self.target_tree.get_file_lines(file_id)
239
work_lines = self.work_tree.get_file_lines(file_id)
240
return merge3.Merge3(new_lines, target_lines, work_lines).merge_lines()
243
"""Release all resources used by this ShelfCreator."""
244
self.work_transform.finalize()
245
self.shelf_transform.finalize()
248
"""Shelve changes from working tree."""
249
self.work_transform.apply()
251
def write_shelf(self, shelf_file, message=None):
252
"""Serialize the shelved changes to a file.
254
:param shelf_file: A file-like object to write the shelf to.
255
:param message: An optional message describing the shelved changes.
256
:return: the filename of the written file.
258
transform.resolve_conflicts(self.shelf_transform)
259
serializer = pack.ContainerSerialiser()
260
shelf_file.write(serializer.begin())
262
'revision_id': self.target_tree.get_revision_id(),
264
if message is not None:
265
metadata['message'] = message.encode('utf-8')
266
shelf_file.write(serializer.bytes_record(
267
bencode.bencode(metadata), (('metadata',),)))
268
for bytes in self.shelf_transform.serialize(serializer):
269
shelf_file.write(bytes)
270
shelf_file.write(serializer.end())
273
class Unshelver(object):
274
"""Unshelve shelved changes."""
276
def __init__(self, tree, base_tree, transform, message):
279
:param tree: The tree to apply the changes to.
280
:param base_tree: The basis to apply the tranform to.
281
:param message: A message from the shelved transform.
284
self.base_tree = base_tree
285
self.transform = transform
286
self.message = message
289
def iter_records(shelf_file):
290
parser = pack.ContainerPushParser()
291
parser.accept_bytes(shelf_file.read())
292
return iter(parser.read_pending_records())
295
def parse_metadata(records):
296
names, metadata_bytes = records.next()
297
if names[0] != ('metadata',):
298
raise errors.ShelfCorrupt
299
metadata = bencode.bdecode(metadata_bytes)
300
message = metadata.get('message')
301
if message is not None:
302
metadata['message'] = message.decode('utf-8')
306
def from_tree_and_shelf(klass, tree, shelf_file):
307
"""Create an Unshelver from a tree and a shelf file.
309
:param tree: The tree to apply shelved changes to.
310
:param shelf_file: A file-like object containing shelved changes.
311
:return: The Unshelver.
313
records = klass.iter_records(shelf_file)
314
metadata = klass.parse_metadata(records)
315
base_revision_id = metadata['revision_id']
317
base_tree = tree.revision_tree(base_revision_id)
318
except errors.NoSuchRevisionInTree:
319
base_tree = tree.branch.repository.revision_tree(base_revision_id)
320
tt = transform.TransformPreview(base_tree)
321
tt.deserialize(records)
322
return klass(tree, base_tree, tt, metadata.get('message'))
324
def make_merger(self, task=None):
325
"""Return a merger that can unshelve the changes."""
326
target_tree = self.transform.get_preview_tree()
327
merger = merge.Merger.from_uncommitted(self.tree, target_tree,
328
task, self.base_tree)
329
merger.merge_type = merge.Merge3Merger
333
"""Release all resources held by this Unshelver."""
334
self.transform.finalize()
337
class ShelfManager(object):
338
"""Maintain a list of shelved changes."""
340
def __init__(self, tree, transport):
342
self.transport = transport.clone('shelf')
343
self.transport.ensure_base()
345
def get_shelf_filename(self, shelf_id):
346
return 'shelf-%d' % shelf_id
348
def get_shelf_ids(self, filenames):
349
matcher = re.compile('shelf-([1-9][0-9]*)')
351
for filename in filenames:
352
match = matcher.match(filename)
353
if match is not None:
354
shelf_ids.append(int(match.group(1)))
358
"""Return a file object and id for a new set of shelved changes."""
359
last_shelf = self.last_shelf()
360
if last_shelf is None:
363
next_shelf = last_shelf + 1
364
filename = self.get_shelf_filename(next_shelf)
365
shelf_file = open(self.transport.local_abspath(filename), 'wb')
366
return next_shelf, shelf_file
368
def shelve_changes(self, creator, message=None):
369
"""Store the changes in a ShelfCreator on a shelf."""
370
next_shelf, shelf_file = self.new_shelf()
372
creator.write_shelf(shelf_file, message)
378
def read_shelf(self, shelf_id):
379
"""Return the file associated with a shelf_id for reading.
381
:param shelf_id: The id of the shelf to retrive the file for.
383
filename = self.get_shelf_filename(shelf_id)
385
return open(self.transport.local_abspath(filename), 'rb')
387
if e.errno != errno.ENOENT:
389
from bzrlib import errors
390
raise errors.NoSuchShelfId(shelf_id)
392
def get_unshelver(self, shelf_id):
393
"""Return an unshelver for a given shelf_id.
395
:param shelf_id: The shelf id to return the unshelver for.
397
shelf_file = self.read_shelf(shelf_id)
399
return Unshelver.from_tree_and_shelf(self.tree, shelf_file)
403
def get_metadata(self, shelf_id):
404
"""Return the metadata associated with a given shelf_id."""
405
shelf_file = self.read_shelf(shelf_id)
407
records = Unshelver.iter_records(shelf_file)
410
return Unshelver.parse_metadata(records)
412
def delete_shelf(self, shelf_id):
413
"""Delete the shelved changes for a given id.
415
:param shelf_id: id of the shelved changes to delete.
417
filename = self.get_shelf_filename(shelf_id)
418
self.transport.delete(filename)
420
def active_shelves(self):
421
"""Return a list of shelved changes."""
422
active = self.get_shelf_ids(self.transport.list_dir('.'))
426
def last_shelf(self):
427
"""Return the id of the last-created shelved change."""
428
active = self.active_shelves()
added
removed
bzrlib/shelf.py
