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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
31
from bzrlib.util import bencode
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)
73
for (file_id, paths, changed, versioned, parents, names, kind,
74
executable) in self.iter_changes:
75
if kind[0] is None or versioned[0] == False:
76
self.creation[file_id] = (kind[1], names[1], parents[1],
78
yield ('add file', file_id, kind[1], paths[1])
79
elif kind[1] is None or versioned[0] == False:
80
self.deletion[file_id] = (kind[0], names[0], parents[0],
82
yield ('delete file', file_id, kind[0], paths[0])
84
if names[0] != names[1] or parents[0] != parents[1]:
85
self.renames[file_id] = (names, parents)
86
yield ('rename', file_id) + paths
88
if kind[0] != kind [1]:
89
yield ('change kind', file_id, kind[0], kind[1], paths[0])
91
yield ('modify text', file_id)
93
def shelve_rename(self, file_id):
94
"""Shelve a file rename.
96
:param file_id: The file id of the file to shelve the renaming of.
98
names, parents = self.renames[file_id]
99
w_trans_id = self.work_transform.trans_id_file_id(file_id)
100
work_parent = self.work_transform.trans_id_file_id(parents[0])
101
self.work_transform.adjust_path(names[0], work_parent, w_trans_id)
103
s_trans_id = self.shelf_transform.trans_id_file_id(file_id)
104
shelf_parent = self.shelf_transform.trans_id_file_id(parents[1])
105
self.shelf_transform.adjust_path(names[1], shelf_parent, s_trans_id)
107
def shelve_lines(self, file_id, new_lines):
108
"""Shelve text changes to a file, using provided lines.
110
:param file_id: The file id of the file to shelve the text of.
111
:param new_lines: The lines that the file should have due to shelving.
113
w_trans_id = self.work_transform.trans_id_file_id(file_id)
114
self.work_transform.delete_contents(w_trans_id)
115
self.work_transform.create_file(new_lines, w_trans_id)
117
s_trans_id = self.shelf_transform.trans_id_file_id(file_id)
118
self.shelf_transform.delete_contents(s_trans_id)
119
inverse_lines = self._inverse_lines(new_lines, file_id)
120
self.shelf_transform.create_file(inverse_lines, s_trans_id)
123
def _content_from_tree(tt, tree, file_id):
124
trans_id = tt.trans_id_file_id(file_id)
125
tt.delete_contents(trans_id)
126
transform.create_from_tree(tt, trans_id, tree, file_id)
128
def shelve_content_change(self, file_id):
129
"""Shelve a kind change or binary file content change.
131
:param file_id: The file id of the file to shelve the content change
134
self._content_from_tree(self.work_transform, self.target_tree, file_id)
135
self._content_from_tree(self.shelf_transform, self.work_tree, file_id)
137
def shelve_creation(self, file_id):
138
"""Shelve creation of a file.
140
This handles content and inventory id.
141
:param file_id: The file_id of the file to shelve creation of.
143
kind, name, parent, versioned = self.creation[file_id]
144
version = not versioned[0]
145
self._shelve_creation(self.work_tree, file_id, self.work_transform,
146
self.shelf_transform, kind, name, parent,
149
def shelve_deletion(self, file_id):
150
"""Shelve deletion of a file.
152
This handles content and inventory id.
153
:param file_id: The file_id of the file to shelve deletion of.
155
kind, name, parent, versioned = self.deletion[file_id]
156
existing_path = self.target_tree.id2path(file_id)
157
if not self.work_tree.has_filename(existing_path):
159
version = not versioned[1]
160
self._shelve_creation(self.target_tree, file_id, self.shelf_transform,
161
self.work_transform, kind, name, parent,
162
version, existing_path=existing_path)
164
def _shelve_creation(self, tree, file_id, from_transform, to_transform,
165
kind, name, parent, version, existing_path=None):
166
w_trans_id = from_transform.trans_id_file_id(file_id)
167
if parent is not None and kind is not None:
168
from_transform.delete_contents(w_trans_id)
169
from_transform.unversion_file(w_trans_id)
171
if existing_path is not None:
172
s_trans_id = to_transform.trans_id_tree_path(existing_path)
174
s_trans_id = to_transform.trans_id_file_id(file_id)
175
if parent is not None:
176
s_parent_id = to_transform.trans_id_file_id(parent)
177
to_transform.adjust_path(name, s_parent_id, s_trans_id)
178
if existing_path is None:
180
to_transform.create_file('', s_trans_id)
182
transform.create_from_tree(to_transform, s_trans_id,
185
to_transform.version_file(file_id, s_trans_id)
187
def _inverse_lines(self, new_lines, file_id):
188
"""Produce a version with only those changes removed from new_lines."""
189
target_lines = self.target_tree.get_file_lines(file_id)
190
work_lines = self.work_tree.get_file_lines(file_id)
191
return merge3.Merge3(new_lines, target_lines, work_lines).merge_lines()
194
"""Release all resources used by this ShelfCreator."""
195
self.work_transform.finalize()
196
self.shelf_transform.finalize()
199
"""Shelve changes from working tree."""
200
self.work_transform.apply()
202
def write_shelf(self, shelf_file, message=None):
203
"""Serialize the shelved changes to a file.
205
:param shelf_file: A file-like object to write the shelf to.
206
:param message: An optional message describing the shelved changes.
207
:return: the filename of the written file.
209
transform.resolve_conflicts(self.shelf_transform)
210
serializer = pack.ContainerSerialiser()
211
shelf_file.write(serializer.begin())
213
'revision_id': self.target_tree.get_revision_id(),
215
if message is not None:
216
metadata['message'] = message.encode('utf-8')
217
shelf_file.write(serializer.bytes_record(
218
bencode.bencode(metadata), (('metadata',),)))
219
for bytes in self.shelf_transform.serialize(serializer):
220
shelf_file.write(bytes)
221
shelf_file.write(serializer.end())
224
class Unshelver(object):
225
"""Unshelve shelved changes."""
227
def __init__(self, tree, base_tree, transform, message):
230
:param tree: The tree to apply the changes to.
231
:param base_tree: The basis to apply the tranform to.
232
:param message: A message from the shelved transform.
235
self.base_tree = base_tree
236
self.transform = transform
237
self.message = message
240
def iter_records(shelf_file):
241
parser = pack.ContainerPushParser()
242
parser.accept_bytes(shelf_file.read())
243
return iter(parser.read_pending_records())
246
def parse_metadata(records):
247
names, metadata_bytes = records.next()
248
if names[0] != ('metadata',):
249
raise errors.ShelfCorrupt
250
metadata = bencode.bdecode(metadata_bytes)
251
message = metadata.get('message')
252
if message is not None:
253
metadata['message'] = message.decode('utf-8')
257
def from_tree_and_shelf(klass, tree, shelf_file):
258
"""Create an Unshelver from a tree and a shelf file.
260
:param tree: The tree to apply shelved changes to.
261
:param shelf_file: A file-like object containing shelved changes.
262
:return: The Unshelver.
264
records = klass.iter_records(shelf_file)
265
metadata = klass.parse_metadata(records)
266
base_revision_id = metadata['revision_id']
268
base_tree = tree.revision_tree(base_revision_id)
269
except errors.NoSuchRevisionInTree:
270
base_tree = tree.branch.repository.revision_tree(base_revision_id)
271
tt = transform.TransformPreview(base_tree)
272
tt.deserialize(records)
273
return klass(tree, base_tree, tt, metadata.get('message'))
275
def make_merger(self, task=None):
276
"""Return a merger that can unshelve the changes."""
277
target_tree = self.transform.get_preview_tree()
278
merger = merge.Merger.from_uncommitted(self.tree, target_tree,
279
task, self.base_tree)
280
merger.merge_type = merge.Merge3Merger
284
"""Release all resources held by this Unshelver."""
285
self.transform.finalize()
288
class ShelfManager(object):
289
"""Maintain a list of shelved changes."""
291
def __init__(self, tree, transport):
293
self.transport = transport.clone('shelf')
294
self.transport.ensure_base()
296
def get_shelf_filename(self, shelf_id):
297
return 'shelf-%d' % shelf_id
299
def get_shelf_ids(self, filenames):
300
matcher = re.compile('shelf-([1-9][0-9]*)')
302
for filename in filenames:
303
match = matcher.match(filename)
304
if match is not None:
305
shelf_ids.append(int(match.group(1)))
309
"""Return a file object and id for a new set of shelved changes."""
310
last_shelf = self.last_shelf()
311
if last_shelf is None:
314
next_shelf = last_shelf + 1
315
filename = self.get_shelf_filename(next_shelf)
316
shelf_file = open(self.transport.local_abspath(filename), 'wb')
317
return next_shelf, shelf_file
319
def shelve_changes(self, creator, message=None):
320
"""Store the changes in a ShelfCreator on a shelf."""
321
next_shelf, shelf_file = self.new_shelf()
323
creator.write_shelf(shelf_file, message)
329
def read_shelf(self, shelf_id):
330
"""Return the file associated with a shelf_id for reading.
332
:param shelf_id: The id of the shelf to retrive the file for.
334
filename = self.get_shelf_filename(shelf_id)
336
return open(self.transport.local_abspath(filename), 'rb')
338
if e.errno != errno.ENOENT:
340
from bzrlib import errors
341
raise errors.NoSuchShelfId(shelf_id)
343
def get_unshelver(self, shelf_id):
344
"""Return an unshelver for a given shelf_id.
346
:param shelf_id: The shelf id to return the unshelver for.
348
shelf_file = self.read_shelf(shelf_id)
350
return Unshelver.from_tree_and_shelf(self.tree, shelf_file)
354
def get_metadata(self, shelf_id):
355
"""Return the metadata associated with a given shelf_id."""
356
shelf_file = self.read_shelf(shelf_id)
358
records = Unshelver.iter_records(shelf_file)
361
return Unshelver.parse_metadata(records)
363
def delete_shelf(self, shelf_id):
364
"""Delete the shelved changes for a given id.
366
:param shelf_id: id of the shelved changes to delete.
368
filename = self.get_shelf_filename(shelf_id)
369
self.transport.delete(filename)
371
def active_shelves(self):
372
"""Return a list of shelved changes."""
373
active = self.get_shelf_ids(self.transport.list_dir('.'))
377
def last_shelf(self):
378
"""Return the id of the last-created shelved change."""
379
active = self.active_shelves()
added
removed
bzrlib/shelf.py
