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 .lazy_import import lazy_import
22
lazy_import(globals(), """
29
from breezy.bzr import (
35
class ShelfCorrupt(errors.BzrError):
37
_fmt = "Shelf corrupt."
40
class NoSuchShelfId(errors.BzrError):
42
_fmt = 'No changes are shelved with id "%(shelf_id)d".'
44
def __init__(self, shelf_id):
45
errors.BzrError.__init__(self, shelf_id=shelf_id)
48
class InvalidShelfId(errors.BzrError):
50
_fmt = '"%(invalid_id)s" is not a valid shelf id, try a number instead.'
52
def __init__(self, invalid_id):
53
errors.BzrError.__init__(self, invalid_id=invalid_id)
56
class ShelfCreator(object):
57
"""Create a transform to shelve objects and its inverse."""
59
def __init__(self, work_tree, target_tree, file_list=None):
62
:param work_tree: The working tree to apply changes to. This is not
63
required to be locked - a tree_write lock will be taken out.
64
:param target_tree: The tree to make the working tree more similar to.
65
This is not required to be locked - a read_lock will be taken out.
66
:param file_list: The files to make more similar to the target.
68
self.work_tree = work_tree
69
self.work_transform = work_tree.transform()
71
self.target_tree = target_tree
72
self.shelf_transform = self.target_tree.preview_transform()
77
self.iter_changes = work_tree.iter_changes(
78
self.target_tree, specific_files=file_list)
80
self.shelf_transform.finalize()
83
self.work_transform.finalize()
86
def iter_shelvable(self):
87
"""Iterable of tuples describing shelvable changes.
89
As well as generating the tuples, this updates several members.
92
('add file', file_id, work_kind, work_path)
93
('delete file', file_id, target_kind, target_path)
94
('rename', file_id, target_path, work_path)
95
('change kind', file_id, target_kind, work_kind, target_path)
96
('modify text', file_id)
97
('modify target', file_id, target_target, work_target)
99
for change in self.iter_changes:
100
# don't shelve add of tree root. Working tree should never
101
# lack roots, and bzr misbehaves when they do.
102
# FIXME ADHB (2009-08-09): should still shelve adds of tree roots
103
# when a tree root was deleted / renamed.
104
if change.kind[0] is None and change.name[1] == '':
106
# Also don't shelve deletion of tree root.
107
if change.kind[1] is None and change.name[0] == '':
109
if change.kind[0] is None or change.versioned[0] is False:
110
self.creation[change.file_id] = (
111
change.kind[1], change.name[1], change.parent_id[1], change.versioned)
112
yield ('add file', change.file_id, change.kind[1], change.path[1])
113
elif change.kind[1] is None or change.versioned[0] is False:
114
self.deletion[change.file_id] = (
115
change.kind[0], change.name[0], change.parent_id[0], change.versioned)
116
yield ('delete file', change.file_id, change.kind[0], change.path[0])
118
if change.name[0] != change.name[1] or change.parent_id[0] != change.parent_id[1]:
119
self.renames[change.file_id] = (change.name, change.parent_id)
120
yield ('rename', change.file_id) + change.path
122
if change.kind[0] != change.kind[1]:
123
yield ('change kind', change.file_id, change.kind[0], change.kind[1], change.path[0])
124
elif change.kind[0] == 'symlink':
125
t_target = self.target_tree.get_symlink_target(change.path[0])
126
w_target = self.work_tree.get_symlink_target(change.path[1])
127
yield ('modify target', change.file_id, change.path[0], t_target,
129
elif change.changed_content:
130
yield ('modify text', change.file_id)
132
def shelve_change(self, change):
133
"""Shelve a change in the iter_shelvable format."""
134
if change[0] == 'rename':
135
self.shelve_rename(change[1])
136
elif change[0] == 'delete file':
137
self.shelve_deletion(change[1])
138
elif change[0] == 'add file':
139
self.shelve_creation(change[1])
140
elif change[0] in ('change kind', 'modify text'):
141
self.shelve_content_change(change[1])
142
elif change[0] == 'modify target':
143
self.shelve_modify_target(change[1])
145
raise ValueError('Unknown change kind: "%s"' % change[0])
147
def shelve_all(self):
148
"""Shelve all changes.
150
:return: ``True`` if changes were shelved, otherwise ``False``.
153
for change in self.iter_shelvable():
154
self.shelve_change(change)
155
return change is not None
157
def shelve_rename(self, file_id):
158
"""Shelve a file rename.
160
:param file_id: The file id of the file to shelve the renaming of.
162
names, parents = self.renames[file_id]
163
w_trans_id = self.work_transform.trans_id_file_id(file_id)
164
work_parent = self.work_transform.trans_id_file_id(parents[0])
165
self.work_transform.adjust_path(names[0], work_parent, w_trans_id)
167
s_trans_id = self.shelf_transform.trans_id_file_id(file_id)
168
shelf_parent = self.shelf_transform.trans_id_file_id(parents[1])
169
self.shelf_transform.adjust_path(names[1], shelf_parent, s_trans_id)
171
def shelve_modify_target(self, file_id):
172
"""Shelve a change of symlink target.
174
:param file_id: The file id of the symlink which changed target.
175
:param new_target: The target that the symlink should have due
178
new_path = self.target_tree.id2path(file_id)
179
new_target = self.target_tree.get_symlink_target(new_path)
180
w_trans_id = self.work_transform.trans_id_file_id(file_id)
181
self.work_transform.delete_contents(w_trans_id)
182
self.work_transform.create_symlink(new_target, w_trans_id)
184
old_path = self.work_tree.id2path(file_id)
185
old_target = self.work_tree.get_symlink_target(old_path)
186
s_trans_id = self.shelf_transform.trans_id_file_id(file_id)
187
self.shelf_transform.delete_contents(s_trans_id)
188
self.shelf_transform.create_symlink(old_target, s_trans_id)
190
def shelve_lines(self, file_id, new_lines):
191
"""Shelve text changes to a file, using provided lines.
193
:param file_id: The file id of the file to shelve the text of.
194
:param new_lines: The lines that the file should have due to shelving.
196
w_trans_id = self.work_transform.trans_id_file_id(file_id)
197
self.work_transform.delete_contents(w_trans_id)
198
self.work_transform.create_file(new_lines, w_trans_id)
200
s_trans_id = self.shelf_transform.trans_id_file_id(file_id)
201
self.shelf_transform.delete_contents(s_trans_id)
202
inverse_lines = self._inverse_lines(new_lines, file_id)
203
self.shelf_transform.create_file(inverse_lines, s_trans_id)
206
def _content_from_tree(tt, tree, file_id):
207
trans_id = tt.trans_id_file_id(file_id)
208
tt.delete_contents(trans_id)
209
transform.create_from_tree(tt, trans_id, tree, tree.id2path(file_id))
211
def shelve_content_change(self, file_id):
212
"""Shelve a kind change or binary file content change.
214
:param file_id: The file id of the file to shelve the content change
217
self._content_from_tree(self.work_transform, self.target_tree, file_id)
218
self._content_from_tree(self.shelf_transform, self.work_tree, file_id)
220
def shelve_creation(self, file_id):
221
"""Shelve creation of a file.
223
This handles content and inventory id.
224
:param file_id: The file_id of the file to shelve creation of.
226
kind, name, parent, versioned = self.creation[file_id]
227
version = not versioned[0]
228
self._shelve_creation(self.work_tree, file_id, self.work_transform,
229
self.shelf_transform, kind, name, parent,
232
def shelve_deletion(self, file_id):
233
"""Shelve deletion of a file.
235
This handles content and inventory id.
236
:param file_id: The file_id of the file to shelve deletion of.
238
kind, name, parent, versioned = self.deletion[file_id]
239
existing_path = self.target_tree.id2path(file_id)
240
if not self.work_tree.has_filename(existing_path):
242
version = not versioned[1]
243
self._shelve_creation(self.target_tree, file_id, self.shelf_transform,
244
self.work_transform, kind, name, parent,
245
version, existing_path=existing_path)
247
def _shelve_creation(self, tree, file_id, from_transform, to_transform,
248
kind, name, parent, version, existing_path=None):
249
w_trans_id = from_transform.trans_id_file_id(file_id)
250
if parent is not None and kind is not None:
251
from_transform.delete_contents(w_trans_id)
252
from_transform.unversion_file(w_trans_id)
254
if existing_path is not None:
255
s_trans_id = to_transform.trans_id_tree_path(existing_path)
257
s_trans_id = to_transform.trans_id_file_id(file_id)
258
if parent is not None:
259
s_parent_id = to_transform.trans_id_file_id(parent)
260
to_transform.adjust_path(name, s_parent_id, s_trans_id)
261
if existing_path is None:
263
to_transform.create_file([b''], s_trans_id)
265
transform.create_from_tree(
266
to_transform, s_trans_id, tree,
267
tree.id2path(file_id))
269
to_transform.version_file(s_trans_id, file_id=file_id)
271
def _inverse_lines(self, new_lines, file_id):
272
"""Produce a version with only those changes removed from new_lines."""
273
target_path = self.target_tree.id2path(file_id)
274
target_lines = self.target_tree.get_file_lines(target_path)
275
work_path = self.work_tree.id2path(file_id)
276
work_lines = self.work_tree.get_file_lines(work_path)
277
return merge3.Merge3(new_lines, target_lines, work_lines).merge_lines()
280
"""Release all resources used by this ShelfCreator."""
281
self.work_transform.finalize()
282
self.shelf_transform.finalize()
285
"""Shelve changes from working tree."""
286
self.work_transform.apply()
289
def metadata_record(serializer, revision_id, message=None):
290
metadata = {b'revision_id': revision_id}
291
if message is not None:
292
metadata[b'message'] = message.encode('utf-8')
293
return serializer.bytes_record(
294
bencode.bencode(metadata), ((b'metadata',),))
296
def write_shelf(self, shelf_file, message=None):
297
"""Serialize the shelved changes to a file.
299
:param shelf_file: A file-like object to write the shelf to.
300
:param message: An optional message describing the shelved changes.
301
:return: the filename of the written file.
303
transform.resolve_conflicts(self.shelf_transform)
304
revision_id = self.target_tree.get_revision_id()
305
return self._write_shelf(shelf_file, self.shelf_transform, revision_id,
309
def _write_shelf(cls, shelf_file, transform, revision_id, message=None):
310
serializer = pack.ContainerSerialiser()
311
shelf_file.write(serializer.begin())
312
metadata = cls.metadata_record(serializer, revision_id, message)
313
shelf_file.write(metadata)
314
for bytes in transform.serialize(serializer):
315
shelf_file.write(bytes)
316
shelf_file.write(serializer.end())
319
class Unshelver(object):
320
"""Unshelve shelved changes."""
322
def __init__(self, tree, base_tree, transform, message):
325
:param tree: The tree to apply the changes to.
326
:param base_tree: The basis to apply the tranform to.
327
:param message: A message from the shelved transform.
330
self.base_tree = base_tree
331
self.transform = transform
332
self.message = message
335
def iter_records(shelf_file):
336
parser = pack.ContainerPushParser()
337
parser.accept_bytes(shelf_file.read())
338
return iter(parser.read_pending_records())
341
def parse_metadata(records):
342
names, metadata_bytes = next(records)
343
if names[0] != (b'metadata',):
345
metadata = bencode.bdecode(metadata_bytes)
346
message = metadata.get(b'message')
347
if message is not None:
348
metadata[b'message'] = message.decode('utf-8')
352
def from_tree_and_shelf(klass, tree, shelf_file):
353
"""Create an Unshelver from a tree and a shelf file.
355
:param tree: The tree to apply shelved changes to.
356
:param shelf_file: A file-like object containing shelved changes.
357
:return: The Unshelver.
359
records = klass.iter_records(shelf_file)
360
metadata = klass.parse_metadata(records)
361
base_revision_id = metadata[b'revision_id']
363
base_tree = tree.revision_tree(base_revision_id)
364
except errors.NoSuchRevisionInTree:
365
base_tree = tree.branch.repository.revision_tree(base_revision_id)
366
tt = base_tree.preview_transform()
367
tt.deserialize(records)
368
return klass(tree, base_tree, tt, metadata.get(b'message'))
370
def make_merger(self):
371
"""Return a merger that can unshelve the changes."""
372
target_tree = self.transform.get_preview_tree()
373
merger = merge.Merger.from_uncommitted(self.tree, target_tree,
375
merger.merge_type = merge.Merge3Merger
379
"""Release all resources held by this Unshelver."""
380
self.transform.finalize()
383
class ShelfManager(object):
384
"""Maintain a list of shelved changes."""
386
def __init__(self, tree, transport):
388
self.transport = transport.clone('shelf')
389
self.transport.ensure_base()
391
def get_shelf_filename(self, shelf_id):
392
return 'shelf-%d' % shelf_id
394
def get_shelf_ids(self, filenames):
395
matcher = re.compile('shelf-([1-9][0-9]*)')
397
for filename in filenames:
398
match = matcher.match(filename)
399
if match is not None:
400
shelf_ids.append(int(match.group(1)))
404
"""Return a file object and id for a new set of shelved changes."""
405
last_shelf = self.last_shelf()
406
if last_shelf is None:
409
next_shelf = last_shelf + 1
410
filename = self.get_shelf_filename(next_shelf)
411
shelf_file = open(self.transport.local_abspath(filename), 'wb')
412
return next_shelf, shelf_file
414
def shelve_changes(self, creator, message=None):
415
"""Store the changes in a ShelfCreator on a shelf."""
416
next_shelf, shelf_file = self.new_shelf()
418
creator.write_shelf(shelf_file, message)
424
def read_shelf(self, shelf_id):
425
"""Return the file associated with a shelf_id for reading.
427
:param shelf_id: The id of the shelf to retrive the file for.
429
filename = self.get_shelf_filename(shelf_id)
431
return open(self.transport.local_abspath(filename), 'rb')
433
if e.errno != errno.ENOENT:
435
raise NoSuchShelfId(shelf_id)
437
def get_unshelver(self, shelf_id):
438
"""Return an unshelver for a given shelf_id.
440
:param shelf_id: The shelf id to return the unshelver for.
442
shelf_file = self.read_shelf(shelf_id)
444
return Unshelver.from_tree_and_shelf(self.tree, shelf_file)
448
def get_metadata(self, shelf_id):
449
"""Return the metadata associated with a given shelf_id."""
450
shelf_file = self.read_shelf(shelf_id)
452
records = Unshelver.iter_records(shelf_file)
455
return Unshelver.parse_metadata(records)
457
def delete_shelf(self, shelf_id):
458
"""Delete the shelved changes for a given id.
460
:param shelf_id: id of the shelved changes to delete.
462
filename = self.get_shelf_filename(shelf_id)
463
self.transport.delete(filename)
465
def active_shelves(self):
466
"""Return a list of shelved changes."""
467
active = sorted(self.get_shelf_ids(self.transport.list_dir('.')))
470
def last_shelf(self):
471
"""Return the id of the last-created shelved change."""
472
active = self.active_shelves()
added
removed
breezy/shelf.py
