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 = transform.TreeTransform(work_tree)
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 (file_id, paths, changed, versioned, parents, names, kind,
102
executable) in self.iter_changes:
103
# don't shelve add of tree root. Working tree should never
104
# lack roots, and bzr misbehaves when they do.
105
# FIXME ADHB (2009-08-09): should still shelve adds of tree roots
106
# when a tree root was deleted / renamed.
107
if kind[0] is None and names[1] == '':
109
# Also don't shelve deletion of tree root.
110
if kind[1] is None and names[0] == '':
112
if kind[0] is None or versioned[0] is False:
113
self.creation[file_id] = (kind[1], names[1], parents[1],
115
yield ('add file', file_id, kind[1], paths[1])
116
elif kind[1] is None or versioned[0] is False:
117
self.deletion[file_id] = (kind[0], names[0], parents[0],
119
yield ('delete file', file_id, kind[0], paths[0])
121
if names[0] != names[1] or parents[0] != parents[1]:
122
self.renames[file_id] = (names, parents)
123
yield ('rename', file_id) + paths
125
if kind[0] != kind[1]:
126
yield ('change kind', file_id, kind[0], kind[1], paths[0])
127
elif kind[0] == 'symlink':
128
t_target = self.target_tree.get_symlink_target(paths[0])
129
w_target = self.work_tree.get_symlink_target(paths[1])
130
yield ('modify target', file_id, paths[0], t_target,
133
yield ('modify text', file_id)
135
def shelve_change(self, change):
136
"""Shelve a change in the iter_shelvable format."""
137
if change[0] == 'rename':
138
self.shelve_rename(change[1])
139
elif change[0] == 'delete file':
140
self.shelve_deletion(change[1])
141
elif change[0] == 'add file':
142
self.shelve_creation(change[1])
143
elif change[0] in ('change kind', 'modify text'):
144
self.shelve_content_change(change[1])
145
elif change[0] == 'modify target':
146
self.shelve_modify_target(change[1])
148
raise ValueError('Unknown change kind: "%s"' % change[0])
150
def shelve_all(self):
151
"""Shelve all changes.
153
:return: ``True`` if changes were shelved, otherwise ``False``.
156
for change in self.iter_shelvable():
157
self.shelve_change(change)
158
return change is not None
160
def shelve_rename(self, file_id):
161
"""Shelve a file rename.
163
:param file_id: The file id of the file to shelve the renaming of.
165
names, parents = self.renames[file_id]
166
w_trans_id = self.work_transform.trans_id_file_id(file_id)
167
work_parent = self.work_transform.trans_id_file_id(parents[0])
168
self.work_transform.adjust_path(names[0], work_parent, w_trans_id)
170
s_trans_id = self.shelf_transform.trans_id_file_id(file_id)
171
shelf_parent = self.shelf_transform.trans_id_file_id(parents[1])
172
self.shelf_transform.adjust_path(names[1], shelf_parent, s_trans_id)
174
def shelve_modify_target(self, file_id):
175
"""Shelve a change of symlink target.
177
:param file_id: The file id of the symlink which changed target.
178
:param new_target: The target that the symlink should have due
181
new_path = self.target_tree.id2path(file_id)
182
new_target = self.target_tree.get_symlink_target(new_path)
183
w_trans_id = self.work_transform.trans_id_file_id(file_id)
184
self.work_transform.delete_contents(w_trans_id)
185
self.work_transform.create_symlink(new_target, w_trans_id)
187
old_path = self.work_tree.id2path(file_id)
188
old_target = self.work_tree.get_symlink_target(old_path)
189
s_trans_id = self.shelf_transform.trans_id_file_id(file_id)
190
self.shelf_transform.delete_contents(s_trans_id)
191
self.shelf_transform.create_symlink(old_target, s_trans_id)
193
def shelve_lines(self, file_id, new_lines):
194
"""Shelve text changes to a file, using provided lines.
196
:param file_id: The file id of the file to shelve the text of.
197
:param new_lines: The lines that the file should have due to shelving.
199
w_trans_id = self.work_transform.trans_id_file_id(file_id)
200
self.work_transform.delete_contents(w_trans_id)
201
self.work_transform.create_file(new_lines, w_trans_id)
203
s_trans_id = self.shelf_transform.trans_id_file_id(file_id)
204
self.shelf_transform.delete_contents(s_trans_id)
205
inverse_lines = self._inverse_lines(new_lines, file_id)
206
self.shelf_transform.create_file(inverse_lines, s_trans_id)
209
def _content_from_tree(tt, tree, file_id):
210
trans_id = tt.trans_id_file_id(file_id)
211
tt.delete_contents(trans_id)
212
transform.create_from_tree(tt, trans_id, tree, tree.id2path(file_id),
215
def shelve_content_change(self, file_id):
216
"""Shelve a kind change or binary file content change.
218
:param file_id: The file id of the file to shelve the content change
221
self._content_from_tree(self.work_transform, self.target_tree, file_id)
222
self._content_from_tree(self.shelf_transform, self.work_tree, file_id)
224
def shelve_creation(self, file_id):
225
"""Shelve creation of a file.
227
This handles content and inventory id.
228
:param file_id: The file_id of the file to shelve creation of.
230
kind, name, parent, versioned = self.creation[file_id]
231
version = not versioned[0]
232
self._shelve_creation(self.work_tree, file_id, self.work_transform,
233
self.shelf_transform, kind, name, parent,
236
def shelve_deletion(self, file_id):
237
"""Shelve deletion of a file.
239
This handles content and inventory id.
240
:param file_id: The file_id of the file to shelve deletion of.
242
kind, name, parent, versioned = self.deletion[file_id]
243
existing_path = self.target_tree.id2path(file_id)
244
if not self.work_tree.has_filename(existing_path):
246
version = not versioned[1]
247
self._shelve_creation(self.target_tree, file_id, self.shelf_transform,
248
self.work_transform, kind, name, parent,
249
version, existing_path=existing_path)
251
def _shelve_creation(self, tree, file_id, from_transform, to_transform,
252
kind, name, parent, version, existing_path=None):
253
w_trans_id = from_transform.trans_id_file_id(file_id)
254
if parent is not None and kind is not None:
255
from_transform.delete_contents(w_trans_id)
256
from_transform.unversion_file(w_trans_id)
258
if existing_path is not None:
259
s_trans_id = to_transform.trans_id_tree_path(existing_path)
261
s_trans_id = to_transform.trans_id_file_id(file_id)
262
if parent is not None:
263
s_parent_id = to_transform.trans_id_file_id(parent)
264
to_transform.adjust_path(name, s_parent_id, s_trans_id)
265
if existing_path is None:
267
to_transform.create_file([b''], s_trans_id)
269
transform.create_from_tree(
270
to_transform, s_trans_id, tree,
271
tree.id2path(file_id), file_id)
273
to_transform.version_file(file_id, s_trans_id)
275
def _inverse_lines(self, new_lines, file_id):
276
"""Produce a version with only those changes removed from new_lines."""
277
target_path = self.target_tree.id2path(file_id)
278
target_lines = self.target_tree.get_file_lines(target_path)
279
work_path = self.work_tree.id2path(file_id)
280
work_lines = self.work_tree.get_file_lines(work_path)
281
return merge3.Merge3(new_lines, target_lines, work_lines).merge_lines()
284
"""Release all resources used by this ShelfCreator."""
285
self.work_transform.finalize()
286
self.shelf_transform.finalize()
289
"""Shelve changes from working tree."""
290
self.work_transform.apply()
293
def metadata_record(serializer, revision_id, message=None):
294
metadata = {b'revision_id': revision_id}
295
if message is not None:
296
metadata[b'message'] = message.encode('utf-8')
297
return serializer.bytes_record(
298
bencode.bencode(metadata), ((b'metadata',),))
300
def write_shelf(self, shelf_file, message=None):
301
"""Serialize the shelved changes to a file.
303
:param shelf_file: A file-like object to write the shelf to.
304
:param message: An optional message describing the shelved changes.
305
:return: the filename of the written file.
307
transform.resolve_conflicts(self.shelf_transform)
308
revision_id = self.target_tree.get_revision_id()
309
return self._write_shelf(shelf_file, self.shelf_transform, revision_id,
313
def _write_shelf(cls, shelf_file, transform, revision_id, message=None):
314
serializer = pack.ContainerSerialiser()
315
shelf_file.write(serializer.begin())
316
metadata = cls.metadata_record(serializer, revision_id, message)
317
shelf_file.write(metadata)
318
for bytes in transform.serialize(serializer):
319
shelf_file.write(bytes)
320
shelf_file.write(serializer.end())
323
class Unshelver(object):
324
"""Unshelve shelved changes."""
326
def __init__(self, tree, base_tree, transform, message):
329
:param tree: The tree to apply the changes to.
330
:param base_tree: The basis to apply the tranform to.
331
:param message: A message from the shelved transform.
334
self.base_tree = base_tree
335
self.transform = transform
336
self.message = message
339
def iter_records(shelf_file):
340
parser = pack.ContainerPushParser()
341
parser.accept_bytes(shelf_file.read())
342
return iter(parser.read_pending_records())
345
def parse_metadata(records):
346
names, metadata_bytes = next(records)
347
if names[0] != (b'metadata',):
349
metadata = bencode.bdecode(metadata_bytes)
350
message = metadata.get(b'message')
351
if message is not None:
352
metadata[b'message'] = message.decode('utf-8')
356
def from_tree_and_shelf(klass, tree, shelf_file):
357
"""Create an Unshelver from a tree and a shelf file.
359
:param tree: The tree to apply shelved changes to.
360
:param shelf_file: A file-like object containing shelved changes.
361
:return: The Unshelver.
363
records = klass.iter_records(shelf_file)
364
metadata = klass.parse_metadata(records)
365
base_revision_id = metadata[b'revision_id']
367
base_tree = tree.revision_tree(base_revision_id)
368
except errors.NoSuchRevisionInTree:
369
base_tree = tree.branch.repository.revision_tree(base_revision_id)
370
tt = transform.TransformPreview(base_tree)
371
tt.deserialize(records)
372
return klass(tree, base_tree, tt, metadata.get(b'message'))
374
def make_merger(self):
375
"""Return a merger that can unshelve the changes."""
376
target_tree = self.transform.get_preview_tree()
377
merger = merge.Merger.from_uncommitted(self.tree, target_tree,
379
merger.merge_type = merge.Merge3Merger
383
"""Release all resources held by this Unshelver."""
384
self.transform.finalize()
387
class ShelfManager(object):
388
"""Maintain a list of shelved changes."""
390
def __init__(self, tree, transport):
392
self.transport = transport.clone('shelf')
393
self.transport.ensure_base()
395
def get_shelf_filename(self, shelf_id):
396
return 'shelf-%d' % shelf_id
398
def get_shelf_ids(self, filenames):
399
matcher = re.compile('shelf-([1-9][0-9]*)')
401
for filename in filenames:
402
match = matcher.match(filename)
403
if match is not None:
404
shelf_ids.append(int(match.group(1)))
408
"""Return a file object and id for a new set of shelved changes."""
409
last_shelf = self.last_shelf()
410
if last_shelf is None:
413
next_shelf = last_shelf + 1
414
filename = self.get_shelf_filename(next_shelf)
415
shelf_file = open(self.transport.local_abspath(filename), 'wb')
416
return next_shelf, shelf_file
418
def shelve_changes(self, creator, message=None):
419
"""Store the changes in a ShelfCreator on a shelf."""
420
next_shelf, shelf_file = self.new_shelf()
422
creator.write_shelf(shelf_file, message)
428
def read_shelf(self, shelf_id):
429
"""Return the file associated with a shelf_id for reading.
431
:param shelf_id: The id of the shelf to retrive the file for.
433
filename = self.get_shelf_filename(shelf_id)
435
return open(self.transport.local_abspath(filename), 'rb')
437
if e.errno != errno.ENOENT:
439
raise NoSuchShelfId(shelf_id)
441
def get_unshelver(self, shelf_id):
442
"""Return an unshelver for a given shelf_id.
444
:param shelf_id: The shelf id to return the unshelver for.
446
shelf_file = self.read_shelf(shelf_id)
448
return Unshelver.from_tree_and_shelf(self.tree, shelf_file)
452
def get_metadata(self, shelf_id):
453
"""Return the metadata associated with a given shelf_id."""
454
shelf_file = self.read_shelf(shelf_id)
456
records = Unshelver.iter_records(shelf_file)
459
return Unshelver.parse_metadata(records)
461
def delete_shelf(self, shelf_id):
462
"""Delete the shelved changes for a given id.
464
:param shelf_id: id of the shelved changes to delete.
466
filename = self.get_shelf_filename(shelf_id)
467
self.transport.delete(filename)
469
def active_shelves(self):
470
"""Return a list of shelved changes."""
471
active = sorted(self.get_shelf_ids(self.transport.list_dir('.')))
474
def last_shelf(self):
475
"""Return the id of the last-created shelved change."""
476
active = self.active_shelves()
added
removed
breezy/shelf.py
