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] == 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] == 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(
130
w_target = self.work_tree.get_symlink_target(
132
yield ('modify target', file_id, paths[0], t_target,
135
yield ('modify text', file_id)
137
def shelve_change(self, change):
138
"""Shelve a change in the iter_shelvable format."""
139
if change[0] == 'rename':
140
self.shelve_rename(change[1])
141
elif change[0] == 'delete file':
142
self.shelve_deletion(change[1])
143
elif change[0] == 'add file':
144
self.shelve_creation(change[1])
145
elif change[0] in ('change kind', 'modify text'):
146
self.shelve_content_change(change[1])
147
elif change[0] == 'modify target':
148
self.shelve_modify_target(change[1])
150
raise ValueError('Unknown change kind: "%s"' % change[0])
152
def shelve_all(self):
153
"""Shelve all changes.
155
:return: True if changes were shelved, False if there were no changes.
158
for change in self.iter_shelvable():
159
self.shelve_change(change)
160
return change is not None
162
def shelve_rename(self, file_id):
163
"""Shelve a file rename.
165
:param file_id: The file id of the file to shelve the renaming of.
167
names, parents = self.renames[file_id]
168
w_trans_id = self.work_transform.trans_id_file_id(file_id)
169
work_parent = self.work_transform.trans_id_file_id(parents[0])
170
self.work_transform.adjust_path(names[0], work_parent, w_trans_id)
172
s_trans_id = self.shelf_transform.trans_id_file_id(file_id)
173
shelf_parent = self.shelf_transform.trans_id_file_id(parents[1])
174
self.shelf_transform.adjust_path(names[1], shelf_parent, s_trans_id)
176
def shelve_modify_target(self, file_id):
177
"""Shelve a change of symlink target.
179
:param file_id: The file id of the symlink which changed target.
180
:param new_target: The target that the symlink should have due
183
new_path = self.target_tree.id2path(file_id)
184
new_target = self.target_tree.get_symlink_target(new_path, file_id)
185
w_trans_id = self.work_transform.trans_id_file_id(file_id)
186
self.work_transform.delete_contents(w_trans_id)
187
self.work_transform.create_symlink(new_target, w_trans_id)
189
old_path = self.work_tree.id2path(file_id)
190
old_target = self.work_tree.get_symlink_target(old_path, file_id)
191
s_trans_id = self.shelf_transform.trans_id_file_id(file_id)
192
self.shelf_transform.delete_contents(s_trans_id)
193
self.shelf_transform.create_symlink(old_target, s_trans_id)
195
def shelve_lines(self, file_id, new_lines):
196
"""Shelve text changes to a file, using provided lines.
198
:param file_id: The file id of the file to shelve the text of.
199
:param new_lines: The lines that the file should have due to shelving.
201
w_trans_id = self.work_transform.trans_id_file_id(file_id)
202
self.work_transform.delete_contents(w_trans_id)
203
self.work_transform.create_file(new_lines, w_trans_id)
205
s_trans_id = self.shelf_transform.trans_id_file_id(file_id)
206
self.shelf_transform.delete_contents(s_trans_id)
207
inverse_lines = self._inverse_lines(new_lines, file_id)
208
self.shelf_transform.create_file(inverse_lines, s_trans_id)
211
def _content_from_tree(tt, tree, file_id):
212
trans_id = tt.trans_id_file_id(file_id)
213
tt.delete_contents(trans_id)
214
transform.create_from_tree(tt, trans_id, tree, tree.id2path(file_id),
217
def shelve_content_change(self, file_id):
218
"""Shelve a kind change or binary file content change.
220
:param file_id: The file id of the file to shelve the content change
223
self._content_from_tree(self.work_transform, self.target_tree, file_id)
224
self._content_from_tree(self.shelf_transform, self.work_tree, file_id)
226
def shelve_creation(self, file_id):
227
"""Shelve creation of a file.
229
This handles content and inventory id.
230
:param file_id: The file_id of the file to shelve creation of.
232
kind, name, parent, versioned = self.creation[file_id]
233
version = not versioned[0]
234
self._shelve_creation(self.work_tree, file_id, self.work_transform,
235
self.shelf_transform, kind, name, parent,
238
def shelve_deletion(self, file_id):
239
"""Shelve deletion of a file.
241
This handles content and inventory id.
242
:param file_id: The file_id of the file to shelve deletion of.
244
kind, name, parent, versioned = self.deletion[file_id]
245
existing_path = self.target_tree.id2path(file_id)
246
if not self.work_tree.has_filename(existing_path):
248
version = not versioned[1]
249
self._shelve_creation(self.target_tree, file_id, self.shelf_transform,
250
self.work_transform, kind, name, parent,
251
version, existing_path=existing_path)
253
def _shelve_creation(self, tree, file_id, from_transform, to_transform,
254
kind, name, parent, version, existing_path=None):
255
w_trans_id = from_transform.trans_id_file_id(file_id)
256
if parent is not None and kind is not None:
257
from_transform.delete_contents(w_trans_id)
258
from_transform.unversion_file(w_trans_id)
260
if existing_path is not None:
261
s_trans_id = to_transform.trans_id_tree_path(existing_path)
263
s_trans_id = to_transform.trans_id_file_id(file_id)
264
if parent is not None:
265
s_parent_id = to_transform.trans_id_file_id(parent)
266
to_transform.adjust_path(name, s_parent_id, s_trans_id)
267
if existing_path is None:
269
to_transform.create_file('', s_trans_id)
271
transform.create_from_tree(
272
to_transform, s_trans_id, tree,
273
tree.id2path(file_id), file_id)
275
to_transform.version_file(file_id, s_trans_id)
277
def _inverse_lines(self, new_lines, file_id):
278
"""Produce a version with only those changes removed from new_lines."""
279
target_path = self.target_tree.id2path(file_id)
280
target_lines = self.target_tree.get_file_lines(target_path, file_id)
281
work_path = self.work_tree.id2path(file_id)
282
work_lines = self.work_tree.get_file_lines(work_path, file_id)
283
return merge3.Merge3(new_lines, target_lines, work_lines).merge_lines()
286
"""Release all resources used by this ShelfCreator."""
287
self.work_transform.finalize()
288
self.shelf_transform.finalize()
291
"""Shelve changes from working tree."""
292
self.work_transform.apply()
295
def metadata_record(serializer, revision_id, message=None):
296
metadata = {b'revision_id': revision_id}
297
if message is not None:
298
metadata[b'message'] = message.encode('utf-8')
299
return serializer.bytes_record(
300
bencode.bencode(metadata), (('metadata',),))
302
def write_shelf(self, shelf_file, message=None):
303
"""Serialize the shelved changes to a file.
305
:param shelf_file: A file-like object to write the shelf to.
306
:param message: An optional message describing the shelved changes.
307
:return: the filename of the written file.
309
transform.resolve_conflicts(self.shelf_transform)
310
revision_id = self.target_tree.get_revision_id()
311
return self._write_shelf(shelf_file, self.shelf_transform, revision_id,
315
def _write_shelf(cls, shelf_file, transform, revision_id, message=None):
316
serializer = pack.ContainerSerialiser()
317
shelf_file.write(serializer.begin())
318
metadata = cls.metadata_record(serializer, revision_id, message)
319
shelf_file.write(metadata)
320
for bytes in transform.serialize(serializer):
321
shelf_file.write(bytes)
322
shelf_file.write(serializer.end())
325
class Unshelver(object):
326
"""Unshelve shelved changes."""
328
def __init__(self, tree, base_tree, transform, message):
331
:param tree: The tree to apply the changes to.
332
:param base_tree: The basis to apply the tranform to.
333
:param message: A message from the shelved transform.
336
self.base_tree = base_tree
337
self.transform = transform
338
self.message = message
341
def iter_records(shelf_file):
342
parser = pack.ContainerPushParser()
343
parser.accept_bytes(shelf_file.read())
344
return iter(parser.read_pending_records())
347
def parse_metadata(records):
348
names, metadata_bytes = next(records)
349
if names[0] != ('metadata',):
351
metadata = bencode.bdecode(metadata_bytes)
352
message = metadata.get('message')
353
if message is not None:
354
metadata['message'] = message.decode('utf-8')
358
def from_tree_and_shelf(klass, tree, shelf_file):
359
"""Create an Unshelver from a tree and a shelf file.
361
:param tree: The tree to apply shelved changes to.
362
:param shelf_file: A file-like object containing shelved changes.
363
:return: The Unshelver.
365
records = klass.iter_records(shelf_file)
366
metadata = klass.parse_metadata(records)
367
base_revision_id = metadata['revision_id']
369
base_tree = tree.revision_tree(base_revision_id)
370
except errors.NoSuchRevisionInTree:
371
base_tree = tree.branch.repository.revision_tree(base_revision_id)
372
tt = transform.TransformPreview(base_tree)
373
tt.deserialize(records)
374
return klass(tree, base_tree, tt, metadata.get('message'))
376
def make_merger(self):
377
"""Return a merger that can unshelve the changes."""
378
target_tree = self.transform.get_preview_tree()
379
merger = merge.Merger.from_uncommitted(self.tree, target_tree,
381
merger.merge_type = merge.Merge3Merger
385
"""Release all resources held by this Unshelver."""
386
self.transform.finalize()
389
class ShelfManager(object):
390
"""Maintain a list of shelved changes."""
392
def __init__(self, tree, transport):
394
self.transport = transport.clone('shelf')
395
self.transport.ensure_base()
397
def get_shelf_filename(self, shelf_id):
398
return 'shelf-%d' % shelf_id
400
def get_shelf_ids(self, filenames):
401
matcher = re.compile('shelf-([1-9][0-9]*)')
403
for filename in filenames:
404
match = matcher.match(filename)
405
if match is not None:
406
shelf_ids.append(int(match.group(1)))
410
"""Return a file object and id for a new set of shelved changes."""
411
last_shelf = self.last_shelf()
412
if last_shelf is None:
415
next_shelf = last_shelf + 1
416
filename = self.get_shelf_filename(next_shelf)
417
shelf_file = open(self.transport.local_abspath(filename), 'wb')
418
return next_shelf, shelf_file
420
def shelve_changes(self, creator, message=None):
421
"""Store the changes in a ShelfCreator on a shelf."""
422
next_shelf, shelf_file = self.new_shelf()
424
creator.write_shelf(shelf_file, message)
430
def read_shelf(self, shelf_id):
431
"""Return the file associated with a shelf_id for reading.
433
:param shelf_id: The id of the shelf to retrive the file for.
435
filename = self.get_shelf_filename(shelf_id)
437
return open(self.transport.local_abspath(filename), 'rb')
439
if e.errno != errno.ENOENT:
441
raise NoSuchShelfId(shelf_id)
443
def get_unshelver(self, shelf_id):
444
"""Return an unshelver for a given shelf_id.
446
:param shelf_id: The shelf id to return the unshelver for.
448
shelf_file = self.read_shelf(shelf_id)
450
return Unshelver.from_tree_and_shelf(self.tree, shelf_file)
454
def get_metadata(self, shelf_id):
455
"""Return the metadata associated with a given shelf_id."""
456
shelf_file = self.read_shelf(shelf_id)
458
records = Unshelver.iter_records(shelf_file)
461
return Unshelver.parse_metadata(records)
463
def delete_shelf(self, shelf_id):
464
"""Delete the shelved changes for a given id.
466
:param shelf_id: id of the shelved changes to delete.
468
filename = self.get_shelf_filename(shelf_id)
469
self.transport.delete(filename)
471
def active_shelves(self):
472
"""Return a list of shelved changes."""
473
active = sorted(self.get_shelf_ids(self.transport.list_dir('.')))
476
def last_shelf(self):
477
"""Return the id of the last-created shelved change."""
478
active = self.active_shelves()
added
removed
breezy/shelf.py
