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
23
from .lazy_import import lazy_import
24
lazy_import(globals(), """
31
from breezy.bzr import (
37
class ShelfCorrupt(errors.BzrError):
39
_fmt = "Shelf corrupt."
42
class NoSuchShelfId(errors.BzrError):
44
_fmt = 'No changes are shelved with id "%(shelf_id)d".'
46
def __init__(self, shelf_id):
47
errors.BzrError.__init__(self, shelf_id=shelf_id)
50
class InvalidShelfId(errors.BzrError):
52
_fmt = '"%(invalid_id)s" is not a valid shelf id, try a number instead.'
54
def __init__(self, invalid_id):
55
errors.BzrError.__init__(self, invalid_id=invalid_id)
58
class ShelfCreator(object):
59
"""Create a transform to shelve objects and its inverse."""
61
def __init__(self, work_tree, target_tree, file_list=None):
64
:param work_tree: The working tree to apply changes to. This is not
65
required to be locked - a tree_write lock will be taken out.
66
:param target_tree: The tree to make the working tree more similar to.
67
This is not required to be locked - a read_lock will be taken out.
68
:param file_list: The files to make more similar to the target.
70
self.work_tree = work_tree
71
self.work_transform = work_tree.get_transform()
73
self.target_tree = target_tree
74
self.shelf_transform = transform.TransformPreview(self.target_tree)
79
self.iter_changes = work_tree.iter_changes(
80
self.target_tree, specific_files=file_list)
82
self.shelf_transform.finalize()
85
self.work_transform.finalize()
88
def iter_shelvable(self):
89
"""Iterable of tuples describing shelvable changes.
91
As well as generating the tuples, this updates several members.
94
('add file', file_id, work_kind, work_path)
95
('delete file', file_id, target_kind, target_path)
96
('rename', file_id, target_path, work_path)
97
('change kind', file_id, target_kind, work_kind, target_path)
98
('modify text', file_id)
99
('modify target', file_id, target_target, work_target)
101
for change in self.iter_changes:
102
# don't shelve add of tree root. Working tree should never
103
# lack roots, and bzr misbehaves when they do.
104
# FIXME ADHB (2009-08-09): should still shelve adds of tree roots
105
# when a tree root was deleted / renamed.
106
if change.kind[0] is None and change.name[1] == '':
108
# Also don't shelve deletion of tree root.
109
if change.kind[1] is None and change.name[0] == '':
111
if change.kind[0] is None or change.versioned[0] is False:
112
self.creation[change.file_id] = (
113
change.kind[1], change.name[1], change.parent_id[1], change.versioned)
114
yield ('add file', change.file_id, change.kind[1], change.path[1])
115
elif change.kind[1] is None or change.versioned[0] is False:
116
self.deletion[change.file_id] = (
117
change.kind[0], change.name[0], change.parent_id[0], change.versioned)
118
yield ('delete file', change.file_id, change.kind[0], change.path[0])
120
if change.name[0] != change.name[1] or change.parent_id[0] != change.parent_id[1]:
121
self.renames[change.file_id] = (change.name, change.parent_id)
122
yield ('rename', change.file_id) + change.path
124
if change.kind[0] != change.kind[1]:
125
yield ('change kind', change.file_id, change.kind[0], change.kind[1], change.path[0])
126
elif change.kind[0] == 'symlink':
127
t_target = self.target_tree.get_symlink_target(change.path[0])
128
w_target = self.work_tree.get_symlink_target(change.path[1])
129
yield ('modify target', change.file_id, change.path[0], t_target,
131
elif change.changed_content:
132
yield ('modify text', change.file_id)
134
def shelve_change(self, change):
135
"""Shelve a change in the iter_shelvable format."""
136
if change[0] == 'rename':
137
self.shelve_rename(change[1])
138
elif change[0] == 'delete file':
139
self.shelve_deletion(change[1])
140
elif change[0] == 'add file':
141
self.shelve_creation(change[1])
142
elif change[0] in ('change kind', 'modify text'):
143
self.shelve_content_change(change[1])
144
elif change[0] == 'modify target':
145
self.shelve_modify_target(change[1])
147
raise ValueError('Unknown change kind: "%s"' % change[0])
149
def shelve_all(self):
150
"""Shelve all changes.
152
:return: ``True`` if changes were shelved, otherwise ``False``.
155
for change in self.iter_shelvable():
156
self.shelve_change(change)
157
return change is not None
159
def shelve_rename(self, file_id):
160
"""Shelve a file rename.
162
:param file_id: The file id of the file to shelve the renaming of.
164
names, parents = self.renames[file_id]
165
w_trans_id = self.work_transform.trans_id_file_id(file_id)
166
work_parent = self.work_transform.trans_id_file_id(parents[0])
167
self.work_transform.adjust_path(names[0], work_parent, w_trans_id)
169
s_trans_id = self.shelf_transform.trans_id_file_id(file_id)
170
shelf_parent = self.shelf_transform.trans_id_file_id(parents[1])
171
self.shelf_transform.adjust_path(names[1], shelf_parent, s_trans_id)
173
def shelve_modify_target(self, file_id):
174
"""Shelve a change of symlink target.
176
:param file_id: The file id of the symlink which changed target.
177
:param new_target: The target that the symlink should have due
180
new_path = self.target_tree.id2path(file_id)
181
new_target = self.target_tree.get_symlink_target(new_path)
182
w_trans_id = self.work_transform.trans_id_file_id(file_id)
183
self.work_transform.delete_contents(w_trans_id)
184
self.work_transform.create_symlink(new_target, w_trans_id)
186
old_path = self.work_tree.id2path(file_id)
187
old_target = self.work_tree.get_symlink_target(old_path)
188
s_trans_id = self.shelf_transform.trans_id_file_id(file_id)
189
self.shelf_transform.delete_contents(s_trans_id)
190
self.shelf_transform.create_symlink(old_target, s_trans_id)
192
def shelve_lines(self, file_id, new_lines):
193
"""Shelve text changes to a file, using provided lines.
195
:param file_id: The file id of the file to shelve the text of.
196
:param new_lines: The lines that the file should have due to shelving.
198
w_trans_id = self.work_transform.trans_id_file_id(file_id)
199
self.work_transform.delete_contents(w_trans_id)
200
self.work_transform.create_file(new_lines, w_trans_id)
202
s_trans_id = self.shelf_transform.trans_id_file_id(file_id)
203
self.shelf_transform.delete_contents(s_trans_id)
204
inverse_lines = self._inverse_lines(new_lines, file_id)
205
self.shelf_transform.create_file(inverse_lines, s_trans_id)
208
def _content_from_tree(tt, tree, file_id):
209
trans_id = tt.trans_id_file_id(file_id)
210
tt.delete_contents(trans_id)
211
transform.create_from_tree(tt, trans_id, tree, tree.id2path(file_id))
213
def shelve_content_change(self, file_id):
214
"""Shelve a kind change or binary file content change.
216
:param file_id: The file id of the file to shelve the content change
219
self._content_from_tree(self.work_transform, self.target_tree, file_id)
220
self._content_from_tree(self.shelf_transform, self.work_tree, file_id)
222
def shelve_creation(self, file_id):
223
"""Shelve creation of a file.
225
This handles content and inventory id.
226
:param file_id: The file_id of the file to shelve creation of.
228
kind, name, parent, versioned = self.creation[file_id]
229
version = not versioned[0]
230
self._shelve_creation(self.work_tree, file_id, self.work_transform,
231
self.shelf_transform, kind, name, parent,
234
def shelve_deletion(self, file_id):
235
"""Shelve deletion of a file.
237
This handles content and inventory id.
238
:param file_id: The file_id of the file to shelve deletion of.
240
kind, name, parent, versioned = self.deletion[file_id]
241
existing_path = self.target_tree.id2path(file_id)
242
if not self.work_tree.has_filename(existing_path):
244
version = not versioned[1]
245
self._shelve_creation(self.target_tree, file_id, self.shelf_transform,
246
self.work_transform, kind, name, parent,
247
version, existing_path=existing_path)
249
def _shelve_creation(self, tree, file_id, from_transform, to_transform,
250
kind, name, parent, version, existing_path=None):
251
w_trans_id = from_transform.trans_id_file_id(file_id)
252
if parent is not None and kind is not None:
253
from_transform.delete_contents(w_trans_id)
254
from_transform.unversion_file(w_trans_id)
256
if existing_path is not None:
257
s_trans_id = to_transform.trans_id_tree_path(existing_path)
259
s_trans_id = to_transform.trans_id_file_id(file_id)
260
if parent is not None:
261
s_parent_id = to_transform.trans_id_file_id(parent)
262
to_transform.adjust_path(name, s_parent_id, s_trans_id)
263
if existing_path is None:
265
to_transform.create_file([b''], s_trans_id)
267
transform.create_from_tree(
268
to_transform, s_trans_id, tree,
269
tree.id2path(file_id))
271
to_transform.version_file(file_id, s_trans_id)
273
def _inverse_lines(self, new_lines, file_id):
274
"""Produce a version with only those changes removed from new_lines."""
275
target_path = self.target_tree.id2path(file_id)
276
target_lines = self.target_tree.get_file_lines(target_path)
277
work_path = self.work_tree.id2path(file_id)
278
work_lines = self.work_tree.get_file_lines(work_path)
279
return merge3.Merge3(new_lines, target_lines, work_lines).merge_lines()
282
"""Release all resources used by this ShelfCreator."""
283
self.work_transform.finalize()
284
self.shelf_transform.finalize()
287
"""Shelve changes from working tree."""
288
self.work_transform.apply()
291
def metadata_record(serializer, revision_id, message=None):
292
metadata = {b'revision_id': revision_id}
293
if message is not None:
294
metadata[b'message'] = message.encode('utf-8')
295
return serializer.bytes_record(
296
bencode.bencode(metadata), ((b'metadata',),))
298
def write_shelf(self, shelf_file, message=None):
299
"""Serialize the shelved changes to a file.
301
:param shelf_file: A file-like object to write the shelf to.
302
:param message: An optional message describing the shelved changes.
303
:return: the filename of the written file.
305
transform.resolve_conflicts(self.shelf_transform)
306
revision_id = self.target_tree.get_revision_id()
307
return self._write_shelf(shelf_file, self.shelf_transform, revision_id,
311
def _write_shelf(cls, shelf_file, transform, revision_id, message=None):
312
serializer = pack.ContainerSerialiser()
313
shelf_file.write(serializer.begin())
314
metadata = cls.metadata_record(serializer, revision_id, message)
315
shelf_file.write(metadata)
316
for bytes in transform.serialize(serializer):
317
shelf_file.write(bytes)
318
shelf_file.write(serializer.end())
321
class Unshelver(object):
322
"""Unshelve shelved changes."""
324
def __init__(self, tree, base_tree, transform, message):
327
:param tree: The tree to apply the changes to.
328
:param base_tree: The basis to apply the tranform to.
329
:param message: A message from the shelved transform.
332
self.base_tree = base_tree
333
self.transform = transform
334
self.message = message
337
def iter_records(shelf_file):
338
parser = pack.ContainerPushParser()
339
parser.accept_bytes(shelf_file.read())
340
return iter(parser.read_pending_records())
343
def parse_metadata(records):
344
names, metadata_bytes = next(records)
345
if names[0] != (b'metadata',):
347
metadata = bencode.bdecode(metadata_bytes)
348
message = metadata.get(b'message')
349
if message is not None:
350
metadata[b'message'] = message.decode('utf-8')
354
def from_tree_and_shelf(klass, tree, shelf_file):
355
"""Create an Unshelver from a tree and a shelf file.
357
:param tree: The tree to apply shelved changes to.
358
:param shelf_file: A file-like object containing shelved changes.
359
:return: The Unshelver.
361
records = klass.iter_records(shelf_file)
362
metadata = klass.parse_metadata(records)
363
base_revision_id = metadata[b'revision_id']
365
base_tree = tree.revision_tree(base_revision_id)
366
except errors.NoSuchRevisionInTree:
367
base_tree = tree.branch.repository.revision_tree(base_revision_id)
368
tt = transform.TransformPreview(base_tree)
369
tt.deserialize(records)
370
return klass(tree, base_tree, tt, metadata.get(b'message'))
372
def make_merger(self):
373
"""Return a merger that can unshelve the changes."""
374
target_tree = self.transform.get_preview_tree()
375
merger = merge.Merger.from_uncommitted(self.tree, target_tree,
377
merger.merge_type = merge.Merge3Merger
381
"""Release all resources held by this Unshelver."""
382
self.transform.finalize()
385
class ShelfManager(object):
386
"""Maintain a list of shelved changes."""
388
def __init__(self, tree, transport):
390
self.transport = transport.clone('shelf')
391
self.transport.ensure_base()
393
def get_shelf_filename(self, shelf_id):
394
return 'shelf-%d' % shelf_id
396
def get_shelf_ids(self, filenames):
397
matcher = re.compile('shelf-([1-9][0-9]*)')
399
for filename in filenames:
400
match = matcher.match(filename)
401
if match is not None:
402
shelf_ids.append(int(match.group(1)))
406
"""Return a file object and id for a new set of shelved changes."""
407
last_shelf = self.last_shelf()
408
if last_shelf is None:
411
next_shelf = last_shelf + 1
412
filename = self.get_shelf_filename(next_shelf)
413
shelf_file = open(self.transport.local_abspath(filename), 'wb')
414
return next_shelf, shelf_file
416
def shelve_changes(self, creator, message=None):
417
"""Store the changes in a ShelfCreator on a shelf."""
418
next_shelf, shelf_file = self.new_shelf()
420
creator.write_shelf(shelf_file, message)
426
def read_shelf(self, shelf_id):
427
"""Return the file associated with a shelf_id for reading.
429
:param shelf_id: The id of the shelf to retrive the file for.
431
filename = self.get_shelf_filename(shelf_id)
433
return open(self.transport.local_abspath(filename), 'rb')
435
if e.errno != errno.ENOENT:
437
raise NoSuchShelfId(shelf_id)
439
def get_unshelver(self, shelf_id):
440
"""Return an unshelver for a given shelf_id.
442
:param shelf_id: The shelf id to return the unshelver for.
444
shelf_file = self.read_shelf(shelf_id)
446
return Unshelver.from_tree_and_shelf(self.tree, shelf_file)
450
def get_metadata(self, shelf_id):
451
"""Return the metadata associated with a given shelf_id."""
452
shelf_file = self.read_shelf(shelf_id)
454
records = Unshelver.iter_records(shelf_file)
457
return Unshelver.parse_metadata(records)
459
def delete_shelf(self, shelf_id):
460
"""Delete the shelved changes for a given id.
462
:param shelf_id: id of the shelved changes to delete.
464
filename = self.get_shelf_filename(shelf_id)
465
self.transport.delete(filename)
467
def active_shelves(self):
468
"""Return a list of shelved changes."""
469
active = sorted(self.get_shelf_ids(self.transport.list_dir('.')))
472
def last_shelf(self):
473
"""Return the id of the last-created shelved change."""
474
active = self.active_shelves()
added
removed
breezy/shelf.py
