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
17
from __future__ import absolute_import
22
from bzrlib.lazy_import import lazy_import
23
lazy_import(globals(), """
35
class ShelfCreator(object):
36
"""Create a transform to shelve objects and its inverse."""
38
def __init__(self, work_tree, target_tree, file_list=None):
41
:param work_tree: The working tree to apply changes to. This is not
42
required to be locked - a tree_write lock will be taken out.
43
:param target_tree: The tree to make the working tree more similar to.
44
This is not required to be locked - a read_lock will be taken out.
45
:param file_list: The files to make more similar to the target.
47
self.work_tree = work_tree
48
self.work_transform = transform.TreeTransform(work_tree)
50
self.target_tree = target_tree
51
self.shelf_transform = transform.TransformPreview(self.target_tree)
56
self.iter_changes = work_tree.iter_changes(
57
self.target_tree, specific_files=file_list)
59
self.shelf_transform.finalize()
62
self.work_transform.finalize()
65
def iter_shelvable(self):
66
"""Iterable of tuples describing shelvable changes.
68
As well as generating the tuples, this updates several members.
71
('add file', file_id, work_kind, work_path)
72
('delete file', file_id, target_kind, target_path)
73
('rename', file_id, target_path, work_path)
74
('change kind', file_id, target_kind, work_kind, target_path)
75
('modify text', file_id)
76
('modify target', file_id, target_target, work_target)
78
for (file_id, paths, changed, versioned, parents, names, kind,
79
executable) in self.iter_changes:
80
# don't shelve add of tree root. Working tree should never
81
# lack roots, and bzr misbehaves when they do.
82
# FIXME ADHB (2009-08-09): should still shelve adds of tree roots
83
# when a tree root was deleted / renamed.
84
if kind[0] is None and names[1] == '':
86
# Also don't shelve deletion of tree root.
87
if kind[1] is None and names[0] == '':
89
if kind[0] is None or versioned[0] == False:
90
self.creation[file_id] = (kind[1], names[1], parents[1],
92
yield ('add file', file_id, kind[1], paths[1])
93
elif kind[1] is None or versioned[0] == False:
94
self.deletion[file_id] = (kind[0], names[0], parents[0],
96
yield ('delete file', file_id, kind[0], paths[0])
98
if names[0] != names[1] or parents[0] != parents[1]:
99
self.renames[file_id] = (names, parents)
100
yield ('rename', file_id) + paths
102
if kind[0] != kind [1]:
103
yield ('change kind', file_id, kind[0], kind[1], paths[0])
104
elif kind[0] == 'symlink':
105
t_target = self.target_tree.get_symlink_target(file_id)
106
w_target = self.work_tree.get_symlink_target(file_id)
107
yield ('modify target', file_id, paths[0], t_target,
110
yield ('modify text', file_id)
112
def shelve_change(self, change):
113
"""Shelve a change in the iter_shelvable format."""
114
if change[0] == 'rename':
115
self.shelve_rename(change[1])
116
elif change[0] == 'delete file':
117
self.shelve_deletion(change[1])
118
elif change[0] == 'add file':
119
self.shelve_creation(change[1])
120
elif change[0] in ('change kind', 'modify text'):
121
self.shelve_content_change(change[1])
122
elif change[0] == 'modify target':
123
self.shelve_modify_target(change[1])
125
raise ValueError('Unknown change kind: "%s"' % change[0])
127
def shelve_all(self):
128
"""Shelve all changes.
130
:return: True if changes were shelved, False if there were no changes.
133
for change in self.iter_shelvable():
134
self.shelve_change(change)
135
return change is not None
137
def shelve_rename(self, file_id):
138
"""Shelve a file rename.
140
:param file_id: The file id of the file to shelve the renaming of.
142
names, parents = self.renames[file_id]
143
w_trans_id = self.work_transform.trans_id_file_id(file_id)
144
work_parent = self.work_transform.trans_id_file_id(parents[0])
145
self.work_transform.adjust_path(names[0], work_parent, w_trans_id)
147
s_trans_id = self.shelf_transform.trans_id_file_id(file_id)
148
shelf_parent = self.shelf_transform.trans_id_file_id(parents[1])
149
self.shelf_transform.adjust_path(names[1], shelf_parent, s_trans_id)
151
def shelve_modify_target(self, file_id):
152
"""Shelve a change of symlink target.
154
:param file_id: The file id of the symlink which changed target.
155
:param new_target: The target that the symlink should have due
158
new_target = self.target_tree.get_symlink_target(file_id)
159
w_trans_id = self.work_transform.trans_id_file_id(file_id)
160
self.work_transform.delete_contents(w_trans_id)
161
self.work_transform.create_symlink(new_target, w_trans_id)
163
old_target = self.work_tree.get_symlink_target(file_id)
164
s_trans_id = self.shelf_transform.trans_id_file_id(file_id)
165
self.shelf_transform.delete_contents(s_trans_id)
166
self.shelf_transform.create_symlink(old_target, s_trans_id)
168
def shelve_lines(self, file_id, new_lines):
169
"""Shelve text changes to a file, using provided lines.
171
:param file_id: The file id of the file to shelve the text of.
172
:param new_lines: The lines that the file should have due to shelving.
174
w_trans_id = self.work_transform.trans_id_file_id(file_id)
175
self.work_transform.delete_contents(w_trans_id)
176
self.work_transform.create_file(new_lines, w_trans_id)
178
s_trans_id = self.shelf_transform.trans_id_file_id(file_id)
179
self.shelf_transform.delete_contents(s_trans_id)
180
inverse_lines = self._inverse_lines(new_lines, file_id)
181
self.shelf_transform.create_file(inverse_lines, s_trans_id)
184
def _content_from_tree(tt, tree, file_id):
185
trans_id = tt.trans_id_file_id(file_id)
186
tt.delete_contents(trans_id)
187
transform.create_from_tree(tt, trans_id, tree, file_id)
189
def shelve_content_change(self, file_id):
190
"""Shelve a kind change or binary file content change.
192
:param file_id: The file id of the file to shelve the content change
195
self._content_from_tree(self.work_transform, self.target_tree, file_id)
196
self._content_from_tree(self.shelf_transform, self.work_tree, file_id)
198
def shelve_creation(self, file_id):
199
"""Shelve creation of a file.
201
This handles content and inventory id.
202
:param file_id: The file_id of the file to shelve creation of.
204
kind, name, parent, versioned = self.creation[file_id]
205
version = not versioned[0]
206
self._shelve_creation(self.work_tree, file_id, self.work_transform,
207
self.shelf_transform, kind, name, parent,
210
def shelve_deletion(self, file_id):
211
"""Shelve deletion of a file.
213
This handles content and inventory id.
214
:param file_id: The file_id of the file to shelve deletion of.
216
kind, name, parent, versioned = self.deletion[file_id]
217
existing_path = self.target_tree.id2path(file_id)
218
if not self.work_tree.has_filename(existing_path):
220
version = not versioned[1]
221
self._shelve_creation(self.target_tree, file_id, self.shelf_transform,
222
self.work_transform, kind, name, parent,
223
version, existing_path=existing_path)
225
def _shelve_creation(self, tree, file_id, from_transform, to_transform,
226
kind, name, parent, version, existing_path=None):
227
w_trans_id = from_transform.trans_id_file_id(file_id)
228
if parent is not None and kind is not None:
229
from_transform.delete_contents(w_trans_id)
230
from_transform.unversion_file(w_trans_id)
232
if existing_path is not None:
233
s_trans_id = to_transform.trans_id_tree_path(existing_path)
235
s_trans_id = to_transform.trans_id_file_id(file_id)
236
if parent is not None:
237
s_parent_id = to_transform.trans_id_file_id(parent)
238
to_transform.adjust_path(name, s_parent_id, s_trans_id)
239
if existing_path is None:
241
to_transform.create_file('', s_trans_id)
243
transform.create_from_tree(to_transform, s_trans_id,
246
to_transform.version_file(file_id, s_trans_id)
248
def _inverse_lines(self, new_lines, file_id):
249
"""Produce a version with only those changes removed from new_lines."""
250
target_lines = self.target_tree.get_file_lines(file_id)
251
work_lines = self.work_tree.get_file_lines(file_id)
252
return merge3.Merge3(new_lines, target_lines, work_lines).merge_lines()
255
"""Release all resources used by this ShelfCreator."""
256
self.work_transform.finalize()
257
self.shelf_transform.finalize()
260
"""Shelve changes from working tree."""
261
self.work_transform.apply()
264
def metadata_record(serializer, revision_id, message=None):
265
metadata = {'revision_id': revision_id}
266
if message is not None:
267
metadata['message'] = message.encode('utf-8')
268
return serializer.bytes_record(
269
bencode.bencode(metadata), (('metadata',),))
271
def write_shelf(self, shelf_file, message=None):
272
"""Serialize the shelved changes to a file.
274
:param shelf_file: A file-like object to write the shelf to.
275
:param message: An optional message describing the shelved changes.
276
:return: the filename of the written file.
278
transform.resolve_conflicts(self.shelf_transform)
279
revision_id = self.target_tree.get_revision_id()
280
return self._write_shelf(shelf_file, self.shelf_transform, revision_id,
284
def _write_shelf(cls, shelf_file, transform, revision_id, message=None):
285
serializer = pack.ContainerSerialiser()
286
shelf_file.write(serializer.begin())
287
metadata = cls.metadata_record(serializer, revision_id, message)
288
shelf_file.write(metadata)
289
for bytes in transform.serialize(serializer):
290
shelf_file.write(bytes)
291
shelf_file.write(serializer.end())
294
class Unshelver(object):
295
"""Unshelve shelved changes."""
297
def __init__(self, tree, base_tree, transform, message):
300
:param tree: The tree to apply the changes to.
301
:param base_tree: The basis to apply the tranform to.
302
:param message: A message from the shelved transform.
305
self.base_tree = base_tree
306
self.transform = transform
307
self.message = message
310
def iter_records(shelf_file):
311
parser = pack.ContainerPushParser()
312
parser.accept_bytes(shelf_file.read())
313
return iter(parser.read_pending_records())
316
def parse_metadata(records):
317
names, metadata_bytes = records.next()
318
if names[0] != ('metadata',):
319
raise errors.ShelfCorrupt
320
metadata = bencode.bdecode(metadata_bytes)
321
message = metadata.get('message')
322
if message is not None:
323
metadata['message'] = message.decode('utf-8')
327
def from_tree_and_shelf(klass, tree, shelf_file):
328
"""Create an Unshelver from a tree and a shelf file.
330
:param tree: The tree to apply shelved changes to.
331
:param shelf_file: A file-like object containing shelved changes.
332
:return: The Unshelver.
334
records = klass.iter_records(shelf_file)
335
metadata = klass.parse_metadata(records)
336
base_revision_id = metadata['revision_id']
338
base_tree = tree.revision_tree(base_revision_id)
339
except errors.NoSuchRevisionInTree:
340
base_tree = tree.branch.repository.revision_tree(base_revision_id)
341
tt = transform.TransformPreview(base_tree)
342
tt.deserialize(records)
343
return klass(tree, base_tree, tt, metadata.get('message'))
345
def make_merger(self, task=None):
346
"""Return a merger that can unshelve the changes."""
347
target_tree = self.transform.get_preview_tree()
348
merger = merge.Merger.from_uncommitted(self.tree, target_tree,
349
task, self.base_tree)
350
merger.merge_type = merge.Merge3Merger
354
"""Release all resources held by this Unshelver."""
355
self.transform.finalize()
358
class ShelfManager(object):
359
"""Maintain a list of shelved changes."""
361
def __init__(self, tree, transport):
363
self.transport = transport.clone('shelf')
364
self.transport.ensure_base()
366
def get_shelf_filename(self, shelf_id):
367
return 'shelf-%d' % shelf_id
369
def get_shelf_ids(self, filenames):
370
matcher = re.compile('shelf-([1-9][0-9]*)')
372
for filename in filenames:
373
match = matcher.match(filename)
374
if match is not None:
375
shelf_ids.append(int(match.group(1)))
379
"""Return a file object and id for a new set of shelved changes."""
380
last_shelf = self.last_shelf()
381
if last_shelf is None:
384
next_shelf = last_shelf + 1
385
filename = self.get_shelf_filename(next_shelf)
386
shelf_file = open(self.transport.local_abspath(filename), 'wb')
387
return next_shelf, shelf_file
389
def shelve_changes(self, creator, message=None):
390
"""Store the changes in a ShelfCreator on a shelf."""
391
next_shelf, shelf_file = self.new_shelf()
393
creator.write_shelf(shelf_file, message)
399
def read_shelf(self, shelf_id):
400
"""Return the file associated with a shelf_id for reading.
402
:param shelf_id: The id of the shelf to retrive the file for.
404
filename = self.get_shelf_filename(shelf_id)
406
return open(self.transport.local_abspath(filename), 'rb')
408
if e.errno != errno.ENOENT:
410
from bzrlib import errors
411
raise errors.NoSuchShelfId(shelf_id)
413
def get_unshelver(self, shelf_id):
414
"""Return an unshelver for a given shelf_id.
416
:param shelf_id: The shelf id to return the unshelver for.
418
shelf_file = self.read_shelf(shelf_id)
420
return Unshelver.from_tree_and_shelf(self.tree, shelf_file)
424
def get_metadata(self, shelf_id):
425
"""Return the metadata associated with a given shelf_id."""
426
shelf_file = self.read_shelf(shelf_id)
428
records = Unshelver.iter_records(shelf_file)
431
return Unshelver.parse_metadata(records)
433
def delete_shelf(self, shelf_id):
434
"""Delete the shelved changes for a given id.
436
:param shelf_id: id of the shelved changes to delete.
438
filename = self.get_shelf_filename(shelf_id)
439
self.transport.delete(filename)
441
def active_shelves(self):
442
"""Return a list of shelved changes."""
443
active = self.get_shelf_ids(self.transport.list_dir('.'))
447
def last_shelf(self):
448
"""Return the id of the last-created shelved change."""
449
active = self.active_shelves()
added
removed
bzrlib/shelf.py
