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)
51
self.iter_changes = work_tree.iter_changes(self.target_tree,
52
specific_files=file_list)
54
def iter_shelvable(self):
55
"""Iterable of tuples describing shelvable changes.
57
As well as generating the tuples, this updates several members.
59
('add file', file_id, work_kind, work_path)
60
('delete file', file_id, target_kind, target_path)
61
('rename', file_id, target_path, work_path)
62
('change kind', file_id, target_kind, work_kind, target_path)
63
('modify text', file_id)
65
for (file_id, paths, changed, versioned, parents, names, kind,
66
executable) in self.iter_changes:
67
if kind[0] is None or versioned[0] == False:
68
self.creation[file_id] = (kind[1], names[1], parents[1],
70
yield ('add file', file_id, kind[1], paths[1])
71
elif kind[1] is None or versioned[0] == False:
72
self.deletion[file_id] = (kind[0], names[0], parents[0],
74
yield ('delete file', file_id, kind[0], paths[0])
76
if names[0] != names[1] or parents[0] != parents[1]:
77
self.renames[file_id] = (names, parents)
78
yield ('rename', file_id) + paths
80
if kind[0] != kind [1]:
81
yield ('change kind', file_id, kind[0], kind[1], paths[0])
83
yield ('modify text', file_id)
85
def shelve_rename(self, file_id):
86
"""Shelve a file rename.
88
:param file_id: The file id of the file to shelve the renaming of.
90
names, parents = self.renames[file_id]
91
w_trans_id = self.work_transform.trans_id_file_id(file_id)
92
work_parent = self.work_transform.trans_id_file_id(parents[0])
93
self.work_transform.adjust_path(names[0], work_parent, w_trans_id)
95
s_trans_id = self.shelf_transform.trans_id_file_id(file_id)
96
shelf_parent = self.shelf_transform.trans_id_file_id(parents[1])
97
self.shelf_transform.adjust_path(names[1], shelf_parent, s_trans_id)
99
def shelve_lines(self, file_id, new_lines):
100
"""Shelve text changes to a file, using provided lines.
102
:param file_id: The file id of the file to shelve the text of.
103
:param new_lines: The lines that the file should have due to shelving.
105
w_trans_id = self.work_transform.trans_id_file_id(file_id)
106
self.work_transform.delete_contents(w_trans_id)
107
self.work_transform.create_file(new_lines, w_trans_id)
109
s_trans_id = self.shelf_transform.trans_id_file_id(file_id)
110
self.shelf_transform.delete_contents(s_trans_id)
111
inverse_lines = self._inverse_lines(new_lines, file_id)
112
self.shelf_transform.create_file(inverse_lines, s_trans_id)
115
def _content_from_tree(tt, tree, file_id):
116
trans_id = tt.trans_id_file_id(file_id)
117
tt.delete_contents(trans_id)
118
transform.create_from_tree(tt, trans_id, tree, file_id)
120
def shelve_content_change(self, file_id):
121
"""Shelve a kind change or binary file content change.
123
:param file_id: The file id of the file to shelve the content change
126
self._content_from_tree(self.work_transform, self.target_tree, file_id)
127
self._content_from_tree(self.shelf_transform, self.work_tree, file_id)
129
def shelve_creation(self, file_id):
130
"""Shelve creation of a file.
132
This handles content and inventory id.
133
:param file_id: The file_id of the file to shelve creation of.
135
kind, name, parent, versioned = self.creation[file_id]
136
version = not versioned[0]
137
self._shelve_creation(self.work_tree, file_id, self.work_transform,
138
self.shelf_transform, kind, name, parent,
141
def shelve_deletion(self, file_id):
142
"""Shelve deletion of a file.
144
This handles content and inventory id.
145
:param file_id: The file_id of the file to shelve deletion of.
147
kind, name, parent, versioned = self.deletion[file_id]
148
existing_path = self.target_tree.id2path(file_id)
149
if not self.work_tree.has_filename(existing_path):
151
version = not versioned[1]
152
self._shelve_creation(self.target_tree, file_id, self.shelf_transform,
153
self.work_transform, kind, name, parent,
154
version, existing_path=existing_path)
156
def _shelve_creation(self, tree, file_id, from_transform, to_transform,
157
kind, name, parent, version, existing_path=None):
158
w_trans_id = from_transform.trans_id_file_id(file_id)
159
if parent is not None and kind is not None:
160
from_transform.delete_contents(w_trans_id)
161
from_transform.unversion_file(w_trans_id)
163
if existing_path is not None:
164
s_trans_id = to_transform.trans_id_tree_path(existing_path)
166
s_trans_id = to_transform.trans_id_file_id(file_id)
167
if parent is not None:
168
s_parent_id = to_transform.trans_id_file_id(parent)
169
to_transform.adjust_path(name, s_parent_id, s_trans_id)
170
if existing_path is None:
172
to_transform.create_file('', s_trans_id)
174
transform.create_from_tree(to_transform, s_trans_id,
177
to_transform.version_file(file_id, s_trans_id)
179
def _inverse_lines(self, new_lines, file_id):
180
"""Produce a version with only those changes removed from new_lines."""
181
target_lines = self.target_tree.get_file_lines(file_id)
182
work_lines = self.work_tree.get_file_lines(file_id)
183
return merge3.Merge3(new_lines, target_lines, work_lines).merge_lines()
186
"""Release all resources used by this ShelfCreator."""
187
self.work_transform.finalize()
188
self.shelf_transform.finalize()
191
"""Shelve changes from working tree."""
192
self.work_transform.apply()
194
def write_shelf(self, shelf_file, message=None):
195
"""Serialize the shelved changes to a file.
197
:param shelf_file: A file-like object to write the shelf to.
198
:param message: An optional message describing the shelved changes.
199
:return: the filename of the written file.
201
transform.resolve_conflicts(self.shelf_transform)
202
serializer = pack.ContainerSerialiser()
203
shelf_file.write(serializer.begin())
205
'revision_id': self.target_tree.get_revision_id(),
207
if message is not None:
208
metadata['message'] = message.encode('utf-8')
209
shelf_file.write(serializer.bytes_record(
210
bencode.bencode(metadata), (('metadata',),)))
211
for bytes in self.shelf_transform.serialize(serializer):
212
shelf_file.write(bytes)
213
shelf_file.write(serializer.end())
216
class Unshelver(object):
217
"""Unshelve shelved changes."""
219
def __init__(self, tree, base_tree, transform, message):
222
:param tree: The tree to apply the changes to.
223
:param base_tree: The basis to apply the tranform to.
224
:param message: A message from the shelved transform.
227
self.base_tree = base_tree
228
self.transform = transform
229
self.message = message
232
def iter_records(shelf_file):
233
parser = pack.ContainerPushParser()
234
parser.accept_bytes(shelf_file.read())
235
return iter(parser.read_pending_records())
238
def parse_metadata(records):
239
names, metadata_bytes = records.next()
240
if names[0] != ('metadata',):
241
raise errors.ShelfCorrupt
242
metadata = bencode.bdecode(metadata_bytes)
243
message = metadata.get('message')
244
if message is not None:
245
metadata['message'] = message.decode('utf-8')
249
def from_tree_and_shelf(klass, tree, shelf_file):
250
"""Create an Unshelver from a tree and a shelf file.
252
:param tree: The tree to apply shelved changes to.
253
:param shelf_file: A file-like object containing shelved changes.
254
:return: The Unshelver.
256
records = klass.iter_records(shelf_file)
257
metadata = klass.parse_metadata(records)
258
base_revision_id = metadata['revision_id']
260
base_tree = tree.revision_tree(base_revision_id)
261
except errors.NoSuchRevisionInTree:
262
base_tree = tree.branch.repository.revision_tree(base_revision_id)
263
tt = transform.TransformPreview(base_tree)
264
tt.deserialize(records)
265
return klass(tree, base_tree, tt, metadata.get('message'))
267
def make_merger(self):
268
"""Return a merger that can unshelve the changes."""
269
pb = ui.ui_factory.nested_progress_bar()
271
target_tree = self.transform.get_preview_tree()
272
merger = merge.Merger.from_uncommitted(self.tree, target_tree, pb,
274
merger.merge_type = merge.Merge3Merger
280
"""Release all resources held by this Unshelver."""
281
self.transform.finalize()
284
class ShelfManager(object):
285
"""Maintain a list of shelved changes."""
287
def __init__(self, tree, transport):
289
self.transport = transport.clone('shelf')
290
self.transport.ensure_base()
292
def get_shelf_filename(self, shelf_id):
293
return 'shelf-%d' % shelf_id
295
def get_shelf_ids(self, filenames):
296
matcher = re.compile('shelf-([1-9][0-9]*)')
298
for filename in filenames:
299
match = matcher.match(filename)
300
if match is not None:
301
shelf_ids.append(int(match.group(1)))
305
"""Return a file object and id for a new set of shelved changes."""
306
last_shelf = self.last_shelf()
307
if last_shelf is None:
310
next_shelf = last_shelf + 1
311
filename = self.get_shelf_filename(next_shelf)
312
shelf_file = open(self.transport.local_abspath(filename), 'wb')
313
return next_shelf, shelf_file
315
def shelve_changes(self, creator, message=None):
316
"""Store the changes in a ShelfCreator on a shelf."""
317
next_shelf, shelf_file = self.new_shelf()
319
creator.write_shelf(shelf_file, message)
325
def read_shelf(self, shelf_id):
326
"""Return the file associated with a shelf_id for reading.
328
:param shelf_id: The id of the shelf to retrive the file for.
330
filename = self.get_shelf_filename(shelf_id)
332
return open(self.transport.local_abspath(filename), 'rb')
334
if e.errno != errno.ENOENT:
336
from bzrlib import errors
337
raise errors.NoSuchShelfId(shelf_id)
339
def get_unshelver(self, shelf_id):
340
"""Return an unshelver for a given shelf_id.
342
:param shelf_id: The shelf id to return the unshelver for.
344
shelf_file = self.read_shelf(shelf_id)
346
return Unshelver.from_tree_and_shelf(self.tree, shelf_file)
350
def get_metadata(self, shelf_id):
351
"""Return the metadata associated with a given shelf_id."""
352
shelf_file = self.read_shelf(shelf_id)
354
records = Unshelver.iter_records(shelf_file)
357
return Unshelver.parse_metadata(records)
359
def delete_shelf(self, shelf_id):
360
"""Delete the shelved changes for a given id.
362
:param shelf_id: id of the shelved changes to delete.
364
filename = self.get_shelf_filename(shelf_id)
365
self.transport.delete(filename)
367
def active_shelves(self):
368
"""Return a list of shelved changes."""
369
active = self.get_shelf_ids(self.transport.list_dir('.'))
373
def last_shelf(self):
374
"""Return the id of the last-created shelved change."""
375
active = self.active_shelves()
added
removed
bzrlib/shelf.py
