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)
46
self.target_tree = target_tree
47
self.shelf_transform = transform.TransformPreview(self.target_tree)
52
self.iter_changes = work_tree.iter_changes(self.target_tree,
53
specific_files=file_list)
54
except errors.PathsNotVersionedError:
59
def iter_shelvable(self):
60
"""Iterable of tuples describing shelvable changes.
62
As well as generating the tuples, this updates several members.
64
('add file', file_id, work_kind, work_path)
65
('delete file', file_id, target_kind, target_path)
66
('rename', file_id, target_path, work_path)
67
('change kind', file_id, target_kind, work_kind, target_path)
68
('modify text', file_id)
70
for (file_id, paths, changed, versioned, parents, names, kind,
71
executable) in self.iter_changes:
72
if kind[0] is None or versioned[0] == False:
73
self.creation[file_id] = (kind[1], names[1], parents[1],
75
yield ('add file', file_id, kind[1], paths[1])
76
elif kind[1] is None or versioned[0] == False:
77
self.deletion[file_id] = (kind[0], names[0], parents[0],
79
yield ('delete file', file_id, kind[0], paths[0])
81
if names[0] != names[1] or parents[0] != parents[1]:
82
self.renames[file_id] = (names, parents)
83
yield ('rename', file_id) + paths
85
if kind[0] != kind [1]:
86
yield ('change kind', file_id, kind[0], kind[1], paths[0])
88
yield ('modify text', file_id)
90
def shelve_rename(self, file_id):
91
"""Shelve a file rename.
93
:param file_id: The file id of the file to shelve the renaming of.
95
names, parents = self.renames[file_id]
96
w_trans_id = self.work_transform.trans_id_file_id(file_id)
97
work_parent = self.work_transform.trans_id_file_id(parents[0])
98
self.work_transform.adjust_path(names[0], work_parent, w_trans_id)
100
s_trans_id = self.shelf_transform.trans_id_file_id(file_id)
101
shelf_parent = self.shelf_transform.trans_id_file_id(parents[1])
102
self.shelf_transform.adjust_path(names[1], shelf_parent, s_trans_id)
104
def shelve_lines(self, file_id, new_lines):
105
"""Shelve text changes to a file, using provided lines.
107
:param file_id: The file id of the file to shelve the text of.
108
:param new_lines: The lines that the file should have due to shelving.
110
w_trans_id = self.work_transform.trans_id_file_id(file_id)
111
self.work_transform.delete_contents(w_trans_id)
112
self.work_transform.create_file(new_lines, w_trans_id)
114
s_trans_id = self.shelf_transform.trans_id_file_id(file_id)
115
self.shelf_transform.delete_contents(s_trans_id)
116
inverse_lines = self._inverse_lines(new_lines, file_id)
117
self.shelf_transform.create_file(inverse_lines, s_trans_id)
120
def _content_from_tree(tt, tree, file_id):
121
trans_id = tt.trans_id_file_id(file_id)
122
tt.delete_contents(trans_id)
123
transform.create_from_tree(tt, trans_id, tree, file_id)
125
def shelve_content_change(self, file_id):
126
"""Shelve a kind change or binary file content change.
128
:param file_id: The file id of the file to shelve the content change
131
self._content_from_tree(self.work_transform, self.target_tree, file_id)
132
self._content_from_tree(self.shelf_transform, self.work_tree, file_id)
134
def shelve_creation(self, file_id):
135
"""Shelve creation of a file.
137
This handles content and inventory id.
138
:param file_id: The file_id of the file to shelve creation of.
140
kind, name, parent, versioned = self.creation[file_id]
141
version = not versioned[0]
142
self._shelve_creation(self.work_tree, file_id, self.work_transform,
143
self.shelf_transform, kind, name, parent,
146
def shelve_deletion(self, file_id):
147
"""Shelve deletion of a file.
149
This handles content and inventory id.
150
:param file_id: The file_id of the file to shelve deletion of.
152
kind, name, parent, versioned = self.deletion[file_id]
153
existing_path = self.target_tree.id2path(file_id)
154
if not self.work_tree.has_filename(existing_path):
156
version = not versioned[1]
157
self._shelve_creation(self.target_tree, file_id, self.shelf_transform,
158
self.work_transform, kind, name, parent,
159
version, existing_path=existing_path)
161
def _shelve_creation(self, tree, file_id, from_transform, to_transform,
162
kind, name, parent, version, existing_path=None):
163
w_trans_id = from_transform.trans_id_file_id(file_id)
164
if parent is not None and kind is not None:
165
from_transform.delete_contents(w_trans_id)
166
from_transform.unversion_file(w_trans_id)
168
if existing_path is not None:
169
s_trans_id = to_transform.trans_id_tree_path(existing_path)
171
s_trans_id = to_transform.trans_id_file_id(file_id)
172
if parent is not None:
173
s_parent_id = to_transform.trans_id_file_id(parent)
174
to_transform.adjust_path(name, s_parent_id, s_trans_id)
175
if existing_path is None:
177
to_transform.create_file('', s_trans_id)
179
transform.create_from_tree(to_transform, s_trans_id,
182
to_transform.version_file(file_id, s_trans_id)
184
def _inverse_lines(self, new_lines, file_id):
185
"""Produce a version with only those changes removed from new_lines."""
186
target_lines = self.target_tree.get_file_lines(file_id)
187
work_lines = self.work_tree.get_file_lines(file_id)
188
return merge3.Merge3(new_lines, target_lines, work_lines).merge_lines()
191
"""Release all resources used by this ShelfCreator."""
192
self.work_transform.finalize()
193
self.shelf_transform.finalize()
196
"""Shelve changes from working tree."""
197
self.work_transform.apply()
199
def write_shelf(self, shelf_file, message=None):
200
"""Serialize the shelved changes to a file.
202
:param shelf_file: A file-like object to write the shelf to.
203
:param message: An optional message describing the shelved changes.
204
:return: the filename of the written file.
206
transform.resolve_conflicts(self.shelf_transform)
207
serializer = pack.ContainerSerialiser()
208
shelf_file.write(serializer.begin())
210
'revision_id': self.target_tree.get_revision_id(),
212
if message is not None:
213
metadata['message'] = message.encode('utf-8')
214
shelf_file.write(serializer.bytes_record(
215
bencode.bencode(metadata), (('metadata',),)))
216
for bytes in self.shelf_transform.serialize(serializer):
217
shelf_file.write(bytes)
218
shelf_file.write(serializer.end())
221
class Unshelver(object):
222
"""Unshelve shelved changes."""
224
def __init__(self, tree, base_tree, transform, message):
227
:param tree: The tree to apply the changes to.
228
:param base_tree: The basis to apply the tranform to.
229
:param message: A message from the shelved transform.
232
self.base_tree = base_tree
233
self.transform = transform
234
self.message = message
237
def iter_records(shelf_file):
238
parser = pack.ContainerPushParser()
239
parser.accept_bytes(shelf_file.read())
240
return iter(parser.read_pending_records())
243
def parse_metadata(records):
244
names, metadata_bytes = records.next()
245
if names[0] != ('metadata',):
246
raise errors.ShelfCorrupt
247
metadata = bencode.bdecode(metadata_bytes)
248
message = metadata.get('message')
249
if message is not None:
250
metadata['message'] = message.decode('utf-8')
254
def from_tree_and_shelf(klass, tree, shelf_file):
255
"""Create an Unshelver from a tree and a shelf file.
257
:param tree: The tree to apply shelved changes to.
258
:param shelf_file: A file-like object containing shelved changes.
259
:return: The Unshelver.
261
records = klass.iter_records(shelf_file)
262
metadata = klass.parse_metadata(records)
263
base_revision_id = metadata['revision_id']
265
base_tree = tree.revision_tree(base_revision_id)
266
except errors.NoSuchRevisionInTree:
267
base_tree = tree.branch.repository.revision_tree(base_revision_id)
268
tt = transform.TransformPreview(base_tree)
269
tt.deserialize(records)
270
return klass(tree, base_tree, tt, metadata.get('message'))
272
def make_merger(self):
273
"""Return a merger that can unshelve the changes."""
274
pb = ui.ui_factory.nested_progress_bar()
276
target_tree = self.transform.get_preview_tree()
277
merger = merge.Merger.from_uncommitted(self.tree, target_tree, pb,
279
merger.merge_type = merge.Merge3Merger
285
"""Release all resources held by this Unshelver."""
286
self.transform.finalize()
289
class ShelfManager(object):
290
"""Maintain a list of shelved changes."""
292
def __init__(self, tree, transport):
294
self.transport = transport.clone('shelf')
295
self.transport.ensure_base()
297
def get_shelf_filename(self, shelf_id):
298
return 'shelf-%d' % shelf_id
300
def get_shelf_ids(self, filenames):
301
matcher = re.compile('shelf-([1-9][0-9]*)')
303
for filename in filenames:
304
match = matcher.match(filename)
305
if match is not None:
306
shelf_ids.append(int(match.group(1)))
310
"""Return a file object and id for a new set of shelved changes."""
311
last_shelf = self.last_shelf()
312
if last_shelf is None:
315
next_shelf = last_shelf + 1
316
filename = self.get_shelf_filename(next_shelf)
317
shelf_file = open(self.transport.local_abspath(filename), 'wb')
318
return next_shelf, shelf_file
320
def shelve_changes(self, creator, message=None):
321
"""Store the changes in a ShelfCreator on a shelf."""
322
next_shelf, shelf_file = self.new_shelf()
324
creator.write_shelf(shelf_file, message)
330
def read_shelf(self, shelf_id):
331
"""Return the file associated with a shelf_id for reading.
333
:param shelf_id: The id of the shelf to retrive the file for.
335
filename = self.get_shelf_filename(shelf_id)
337
return open(self.transport.local_abspath(filename), 'rb')
339
if e.errno != errno.ENOENT:
341
from bzrlib import errors
342
raise errors.NoSuchShelfId(shelf_id)
344
def get_unshelver(self, shelf_id):
345
"""Return an unshelver for a given shelf_id.
347
:param shelf_id: The shelf id to return the unshelver for.
349
shelf_file = self.read_shelf(shelf_id)
351
return Unshelver.from_tree_and_shelf(self.tree, shelf_file)
355
def get_metadata(self, shelf_id):
356
"""Return the metadata associated with a given shelf_id."""
357
shelf_file = self.read_shelf(shelf_id)
359
records = Unshelver.iter_records(shelf_file)
362
return Unshelver.parse_metadata(records)
364
def delete_shelf(self, shelf_id):
365
"""Delete the shelved changes for a given id.
367
:param shelf_id: id of the shelved changes to delete.
369
filename = self.get_shelf_filename(shelf_id)
370
self.transport.delete(filename)
372
def active_shelves(self):
373
"""Return a list of shelved changes."""
374
active = self.get_shelf_ids(self.transport.list_dir('.'))
378
def last_shelf(self):
379
"""Return the id of the last-created shelved change."""
380
active = self.active_shelves()
added
removed
bzrlib/shelf.py
