1
# Copyright (C) 2008, 2009, 2010 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
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
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. This is not
41
required to be locked - a tree_write lock will be taken out.
42
:param target_tree: The tree to make the working tree more similar to.
43
This is not required to be locked - a read_lock will be taken out.
44
:param file_list: The files to make more similar to the target.
46
self.work_tree = work_tree
47
self.work_transform = transform.TreeTransform(work_tree)
49
self.target_tree = target_tree
50
self.shelf_transform = transform.TransformPreview(self.target_tree)
55
self.iter_changes = work_tree.iter_changes(
56
self.target_tree, specific_files=file_list)
58
self.shelf_transform.finalize()
61
self.work_transform.finalize()
64
def iter_shelvable(self):
65
"""Iterable of tuples describing shelvable changes.
67
As well as generating the tuples, this updates several members.
70
('add file', file_id, work_kind, work_path)
71
('delete file', file_id, target_kind, target_path)
72
('rename', file_id, target_path, work_path)
73
('change kind', file_id, target_kind, work_kind, target_path)
74
('modify text', file_id)
75
('modify target', file_id, target_target, work_target)
77
for (file_id, paths, changed, versioned, parents, names, kind,
78
executable) in self.iter_changes:
79
# don't shelve add of tree root. Working tree should never
80
# lack roots, and bzr misbehaves when they do.
81
# FIXME ADHB (2009-08-09): should still shelve adds of tree roots
82
# when a tree root was deleted / renamed.
83
if kind[0] is None and names[1] == '':
85
if kind[0] is None or versioned[0] == False:
86
self.creation[file_id] = (kind[1], names[1], parents[1],
88
yield ('add file', file_id, kind[1], paths[1])
89
elif kind[1] is None or versioned[0] == False:
90
self.deletion[file_id] = (kind[0], names[0], parents[0],
92
yield ('delete file', file_id, kind[0], paths[0])
94
if names[0] != names[1] or parents[0] != parents[1]:
95
self.renames[file_id] = (names, parents)
96
yield ('rename', file_id) + paths
98
if kind[0] != kind [1]:
99
yield ('change kind', file_id, kind[0], kind[1], paths[0])
100
elif kind[0] == 'symlink':
101
t_target = self.target_tree.get_symlink_target(file_id)
102
w_target = self.work_tree.get_symlink_target(file_id)
103
yield ('modify target', file_id, paths[0], t_target,
106
yield ('modify text', file_id)
108
def shelve_change(self, change):
109
"""Shelve a change in the iter_shelvable format."""
110
if change[0] == 'rename':
111
self.shelve_rename(change[1])
112
elif change[0] == 'delete file':
113
self.shelve_deletion(change[1])
114
elif change[0] == 'add file':
115
self.shelve_creation(change[1])
116
elif change[0] in ('change kind', 'modify text'):
117
self.shelve_content_change(change[1])
118
elif change[0] == 'modify target':
119
self.shelve_modify_target(change[1])
121
raise ValueError('Unknown change kind: "%s"' % change[0])
123
def shelve_all(self):
124
"""Shelve all changes."""
125
for change in self.iter_shelvable():
126
self.shelve_change(change)
128
def shelve_rename(self, file_id):
129
"""Shelve a file rename.
131
:param file_id: The file id of the file to shelve the renaming of.
133
names, parents = self.renames[file_id]
134
w_trans_id = self.work_transform.trans_id_file_id(file_id)
135
work_parent = self.work_transform.trans_id_file_id(parents[0])
136
self.work_transform.adjust_path(names[0], work_parent, w_trans_id)
138
s_trans_id = self.shelf_transform.trans_id_file_id(file_id)
139
shelf_parent = self.shelf_transform.trans_id_file_id(parents[1])
140
self.shelf_transform.adjust_path(names[1], shelf_parent, s_trans_id)
142
def shelve_modify_target(self, file_id):
143
"""Shelve a change of symlink target.
145
:param file_id: The file id of the symlink which changed target.
146
:param new_target: The target that the symlink should have due
149
new_target = self.target_tree.get_symlink_target(file_id)
150
w_trans_id = self.work_transform.trans_id_file_id(file_id)
151
self.work_transform.delete_contents(w_trans_id)
152
self.work_transform.create_symlink(new_target, w_trans_id)
154
old_target = self.work_tree.get_symlink_target(file_id)
155
s_trans_id = self.shelf_transform.trans_id_file_id(file_id)
156
self.shelf_transform.delete_contents(s_trans_id)
157
self.shelf_transform.create_symlink(old_target, s_trans_id)
159
def shelve_lines(self, file_id, new_lines):
160
"""Shelve text changes to a file, using provided lines.
162
:param file_id: The file id of the file to shelve the text of.
163
:param new_lines: The lines that the file should have due to shelving.
165
w_trans_id = self.work_transform.trans_id_file_id(file_id)
166
self.work_transform.delete_contents(w_trans_id)
167
self.work_transform.create_file(new_lines, w_trans_id)
169
s_trans_id = self.shelf_transform.trans_id_file_id(file_id)
170
self.shelf_transform.delete_contents(s_trans_id)
171
inverse_lines = self._inverse_lines(new_lines, file_id)
172
self.shelf_transform.create_file(inverse_lines, s_trans_id)
175
def _content_from_tree(tt, tree, file_id):
176
trans_id = tt.trans_id_file_id(file_id)
177
tt.delete_contents(trans_id)
178
transform.create_from_tree(tt, trans_id, tree, file_id)
180
def shelve_content_change(self, file_id):
181
"""Shelve a kind change or binary file content change.
183
:param file_id: The file id of the file to shelve the content change
186
self._content_from_tree(self.work_transform, self.target_tree, file_id)
187
self._content_from_tree(self.shelf_transform, self.work_tree, file_id)
189
def shelve_creation(self, file_id):
190
"""Shelve creation of a file.
192
This handles content and inventory id.
193
:param file_id: The file_id of the file to shelve creation of.
195
kind, name, parent, versioned = self.creation[file_id]
196
version = not versioned[0]
197
self._shelve_creation(self.work_tree, file_id, self.work_transform,
198
self.shelf_transform, kind, name, parent,
201
def shelve_deletion(self, file_id):
202
"""Shelve deletion of a file.
204
This handles content and inventory id.
205
:param file_id: The file_id of the file to shelve deletion of.
207
kind, name, parent, versioned = self.deletion[file_id]
208
existing_path = self.target_tree.id2path(file_id)
209
if not self.work_tree.has_filename(existing_path):
211
version = not versioned[1]
212
self._shelve_creation(self.target_tree, file_id, self.shelf_transform,
213
self.work_transform, kind, name, parent,
214
version, existing_path=existing_path)
216
def _shelve_creation(self, tree, file_id, from_transform, to_transform,
217
kind, name, parent, version, existing_path=None):
218
w_trans_id = from_transform.trans_id_file_id(file_id)
219
if parent is not None and kind is not None:
220
from_transform.delete_contents(w_trans_id)
221
from_transform.unversion_file(w_trans_id)
223
if existing_path is not None:
224
s_trans_id = to_transform.trans_id_tree_path(existing_path)
226
s_trans_id = to_transform.trans_id_file_id(file_id)
227
if parent is not None:
228
s_parent_id = to_transform.trans_id_file_id(parent)
229
to_transform.adjust_path(name, s_parent_id, s_trans_id)
230
if existing_path is None:
232
to_transform.create_file('', s_trans_id)
234
transform.create_from_tree(to_transform, s_trans_id,
237
to_transform.version_file(file_id, s_trans_id)
239
def _inverse_lines(self, new_lines, file_id):
240
"""Produce a version with only those changes removed from new_lines."""
241
target_lines = self.target_tree.get_file_lines(file_id)
242
work_lines = self.work_tree.get_file_lines(file_id)
243
return merge3.Merge3(new_lines, target_lines, work_lines).merge_lines()
246
"""Release all resources used by this ShelfCreator."""
247
self.work_transform.finalize()
248
self.shelf_transform.finalize()
251
"""Shelve changes from working tree."""
252
self.work_transform.apply()
254
def write_shelf(self, shelf_file, message=None):
255
"""Serialize the shelved changes to a file.
257
:param shelf_file: A file-like object to write the shelf to.
258
:param message: An optional message describing the shelved changes.
259
:return: the filename of the written file.
261
transform.resolve_conflicts(self.shelf_transform)
262
serializer = pack.ContainerSerialiser()
263
shelf_file.write(serializer.begin())
265
'revision_id': self.target_tree.get_revision_id(),
267
if message is not None:
268
metadata['message'] = message.encode('utf-8')
269
shelf_file.write(serializer.bytes_record(
270
bencode.bencode(metadata), (('metadata',),)))
271
for bytes in self.shelf_transform.serialize(serializer):
272
shelf_file.write(bytes)
273
shelf_file.write(serializer.end())
276
class Unshelver(object):
277
"""Unshelve shelved changes."""
279
def __init__(self, tree, base_tree, transform, message):
282
:param tree: The tree to apply the changes to.
283
:param base_tree: The basis to apply the tranform to.
284
:param message: A message from the shelved transform.
287
self.base_tree = base_tree
288
self.transform = transform
289
self.message = message
292
def iter_records(shelf_file):
293
parser = pack.ContainerPushParser()
294
parser.accept_bytes(shelf_file.read())
295
return iter(parser.read_pending_records())
298
def parse_metadata(records):
299
names, metadata_bytes = records.next()
300
if names[0] != ('metadata',):
301
raise errors.ShelfCorrupt
302
metadata = bencode.bdecode(metadata_bytes)
303
message = metadata.get('message')
304
if message is not None:
305
metadata['message'] = message.decode('utf-8')
309
def from_tree_and_shelf(klass, tree, shelf_file):
310
"""Create an Unshelver from a tree and a shelf file.
312
:param tree: The tree to apply shelved changes to.
313
:param shelf_file: A file-like object containing shelved changes.
314
:return: The Unshelver.
316
records = klass.iter_records(shelf_file)
317
metadata = klass.parse_metadata(records)
318
base_revision_id = metadata['revision_id']
320
base_tree = tree.revision_tree(base_revision_id)
321
except errors.NoSuchRevisionInTree:
322
base_tree = tree.branch.repository.revision_tree(base_revision_id)
323
tt = transform.TransformPreview(base_tree)
324
tt.deserialize(records)
325
return klass(tree, base_tree, tt, metadata.get('message'))
327
def make_merger(self, task=None):
328
"""Return a merger that can unshelve the changes."""
329
target_tree = self.transform.get_preview_tree()
330
merger = merge.Merger.from_uncommitted(self.tree, target_tree,
331
task, self.base_tree)
332
merger.merge_type = merge.Merge3Merger
336
"""Release all resources held by this Unshelver."""
337
self.transform.finalize()
340
class ShelfManager(object):
341
"""Maintain a list of shelved changes."""
343
def __init__(self, tree, transport):
345
self.transport = transport.clone('shelf')
346
self.transport.ensure_base()
348
def get_shelf_filename(self, shelf_id):
349
return 'shelf-%d' % shelf_id
351
def get_shelf_ids(self, filenames):
352
matcher = re.compile('shelf-([1-9][0-9]*)')
354
for filename in filenames:
355
match = matcher.match(filename)
356
if match is not None:
357
shelf_ids.append(int(match.group(1)))
361
"""Return a file object and id for a new set of shelved changes."""
362
last_shelf = self.last_shelf()
363
if last_shelf is None:
366
next_shelf = last_shelf + 1
367
filename = self.get_shelf_filename(next_shelf)
368
shelf_file = open(self.transport.local_abspath(filename), 'wb')
369
return next_shelf, shelf_file
371
def shelve_changes(self, creator, message=None):
372
"""Store the changes in a ShelfCreator on a shelf."""
373
next_shelf, shelf_file = self.new_shelf()
375
creator.write_shelf(shelf_file, message)
381
def read_shelf(self, shelf_id):
382
"""Return the file associated with a shelf_id for reading.
384
:param shelf_id: The id of the shelf to retrive the file for.
386
filename = self.get_shelf_filename(shelf_id)
388
return open(self.transport.local_abspath(filename), 'rb')
390
if e.errno != errno.ENOENT:
392
from bzrlib import errors
393
raise errors.NoSuchShelfId(shelf_id)
395
def get_unshelver(self, shelf_id):
396
"""Return an unshelver for a given shelf_id.
398
:param shelf_id: The shelf id to return the unshelver for.
400
shelf_file = self.read_shelf(shelf_id)
402
return Unshelver.from_tree_and_shelf(self.tree, shelf_file)
406
def get_metadata(self, shelf_id):
407
"""Return the metadata associated with a given shelf_id."""
408
shelf_file = self.read_shelf(shelf_id)
410
records = Unshelver.iter_records(shelf_file)
413
return Unshelver.parse_metadata(records)
415
def delete_shelf(self, shelf_id):
416
"""Delete the shelved changes for a given id.
418
:param shelf_id: id of the shelved changes to delete.
420
filename = self.get_shelf_filename(shelf_id)
421
self.transport.delete(filename)
423
def active_shelves(self):
424
"""Return a list of shelved changes."""
425
active = self.get_shelf_ids(self.transport.list_dir('.'))
429
def last_shelf(self):
430
"""Return the id of the last-created shelved change."""
431
active = self.active_shelves()
added
removed
bzrlib/shelf.py
