← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/shelf.py

  • Committer: Aaron Bentley
  • Date: 2008-11-03 21:52:46 UTC
  • mto: This revision was merged to the branch mainline in revision 3823.
  • Revision ID: aaron@aaronbentley.com-20081103215246-xcpvqnno9d1lhmz4
raise UserAbort instead of doing sys.exit

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/shelf.py
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
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
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
18
18
import errno
19
19
import re
20
20
 
21
21
from bzrlib import (
22
 
    bencode,
23
22
    errors,
24
23
    merge,
25
24
    merge3,
 
25
    osutils,
26
26
    pack,
27
27
    transform,
 
28
    ui,
 
29
    workingtree,
28
30
)
 
31
from bzrlib.util import bencode
29
32
 
30
33
 
31
34
class ShelfCreator(object):
34
37
    def __init__(self, work_tree, target_tree, file_list=None):
35
38
        """Constructor.
36
39
 
37
 
        :param work_tree: The working tree to apply changes to. This is not
38
 
            required to be locked - a tree_write lock will be taken out.
 
40
        :param work_tree: The working tree to apply changes to
39
41
        :param target_tree: The tree to make the working tree more similar to.
40
 
            This is not required to be locked - a read_lock will be taken out.
41
42
        :param file_list: The files to make more similar to the target.
42
43
        """
43
44
        self.work_tree = work_tree
44
45
        self.work_transform = transform.TreeTransform(work_tree)
45
 
        try:
46
 
            self.target_tree = target_tree
47
 
            self.shelf_transform = transform.TransformPreview(self.target_tree)
48
 
            try:
49
 
                self.renames = {}
50
 
                self.creation = {}
51
 
                self.deletion = {}
52
 
                self.iter_changes = work_tree.iter_changes(
53
 
                    self.target_tree, specific_files=file_list)
54
 
            except:
55
 
                self.shelf_transform.finalize()
56
 
                raise
57
 
        except:
58
 
            self.work_transform.finalize()
59
 
            raise
 
46
        self.target_tree = target_tree
 
47
        self.shelf_transform = transform.TransformPreview(self.target_tree)
 
48
        self.renames = {}
 
49
        self.creation = {}
 
50
        self.deletion = {}
 
51
        self.iter_changes = work_tree.iter_changes(self.target_tree,
 
52
                                                   specific_files=file_list)
60
53
 
61
54
    def iter_shelvable(self):
62
55
        """Iterable of tuples describing shelvable changes.
68
61
           ('rename', file_id, target_path, work_path)
69
62
           ('change kind', file_id, target_kind, work_kind, target_path)
70
63
           ('modify text', file_id)
71
 
           ('modify target', file_id, target_target, work_target)
72
64
        """
73
65
        for (file_id, paths, changed, versioned, parents, names, kind,
74
66
             executable) in self.iter_changes:
75
 
            # don't shelve add of tree root.  Working tree should never
76
 
            # lack roots, and bzr misbehaves when they do.
77
 
            # FIXME ADHB (2009-08-09): should still shelve adds of tree roots
78
 
            # when a tree root was deleted / renamed.
79
 
            if kind[0] is None and names[1] == '':
80
 
                continue
81
67
            if kind[0] is None or versioned[0] == False:
82
68
                self.creation[file_id] = (kind[1], names[1], parents[1],
83
69
                                          versioned)
93
79
 
94
80
                if kind[0] != kind [1]:
95
81
                    yield ('change kind', file_id, kind[0], kind[1], paths[0])
96
 
                elif kind[0] == 'symlink':
97
 
                    t_target = self.target_tree.get_symlink_target(file_id)
98
 
                    w_target = self.work_tree.get_symlink_target(file_id)
99
 
                    yield ('modify target', file_id, paths[0], t_target,
100
 
                            w_target)
101
82
                elif changed:
102
83
                    yield ('modify text', file_id)
103
84
 
104
 
    def shelve_change(self, change):
105
 
        """Shelve a change in the iter_shelvable format."""
106
 
        if change[0] == 'rename':
107
 
            self.shelve_rename(change[1])
108
 
        elif change[0] == 'delete file':
109
 
            self.shelve_deletion(change[1])
110
 
        elif change[0] == 'add file':
111
 
            self.shelve_creation(change[1])
112
 
        elif change[0] in ('change kind', 'modify text'):
113
 
            self.shelve_content_change(change[1])
114
 
        elif change[0] == 'modify target':
115
 
            self.shelve_modify_target(change[1])
116
 
        else:
117
 
            raise ValueError('Unknown change kind: "%s"' % change[0])
118
 
 
119
 
    def shelve_all(self):
120
 
        """Shelve all changes."""
121
 
        for change in self.iter_shelvable():
122
 
            self.shelve_change(change)
123
 
 
124
85
    def shelve_rename(self, file_id):
125
86
        """Shelve a file rename.
126
87
 
135
96
        shelf_parent = self.shelf_transform.trans_id_file_id(parents[1])
136
97
        self.shelf_transform.adjust_path(names[1], shelf_parent, s_trans_id)
137
98
 
138
 
    def shelve_modify_target(self, file_id):
139
 
        """Shelve a change of symlink target.
140
 
 
141
 
        :param file_id: The file id of the symlink which changed target.
142
 
        :param new_target: The target that the symlink should have due
143
 
            to shelving.
144
 
        """
145
 
        new_target = self.target_tree.get_symlink_target(file_id)
146
 
        w_trans_id = self.work_transform.trans_id_file_id(file_id)
147
 
        self.work_transform.delete_contents(w_trans_id)
148
 
        self.work_transform.create_symlink(new_target, w_trans_id)
149
 
 
150
 
        old_target = self.work_tree.get_symlink_target(file_id)
151
 
        s_trans_id = self.shelf_transform.trans_id_file_id(file_id)
152
 
        self.shelf_transform.delete_contents(s_trans_id)
153
 
        self.shelf_transform.create_symlink(old_target, s_trans_id)
154
 
 
155
99
    def shelve_lines(self, file_id, new_lines):
156
100
        """Shelve text changes to a file, using provided lines.
157
101
 
284
228
        self.transform = transform
285
229
        self.message = message
286
230
 
287
 
    @staticmethod
288
 
    def iter_records(shelf_file):
 
231
    @classmethod
 
232
    def from_tree_and_shelf(klass, tree, shelf_file):
 
233
        """Create an Unshelver from a tree and a shelf file.
 
234
 
 
235
        :param tree: The tree to apply shelved changes to.
 
236
        :param shelf_file: A file-like object containing shelved changes.
 
237
        :return: The Unshelver.
 
238
        """
289
239
        parser = pack.ContainerPushParser()
290
240
        parser.accept_bytes(shelf_file.read())
291
 
        return iter(parser.read_pending_records())
292
 
 
293
 
    @staticmethod
294
 
    def parse_metadata(records):
 
241
        records = iter(parser.read_pending_records())
295
242
        names, metadata_bytes = records.next()
296
243
        if names[0] != ('metadata',):
297
244
            raise errors.ShelfCorrupt
298
245
        metadata = bencode.bdecode(metadata_bytes)
 
246
        base_revision_id = metadata['revision_id']
299
247
        message = metadata.get('message')
300
248
        if message is not None:
301
 
            metadata['message'] = message.decode('utf-8')
302
 
        return metadata
303
 
 
304
 
    @classmethod
305
 
    def from_tree_and_shelf(klass, tree, shelf_file):
306
 
        """Create an Unshelver from a tree and a shelf file.
307
 
 
308
 
        :param tree: The tree to apply shelved changes to.
309
 
        :param shelf_file: A file-like object containing shelved changes.
310
 
        :return: The Unshelver.
311
 
        """
312
 
        records = klass.iter_records(shelf_file)
313
 
        metadata = klass.parse_metadata(records)
314
 
        base_revision_id = metadata['revision_id']
 
249
            message = message.decode('utf-8')
315
250
        try:
316
251
            base_tree = tree.revision_tree(base_revision_id)
317
252
        except errors.NoSuchRevisionInTree:
318
253
            base_tree = tree.branch.repository.revision_tree(base_revision_id)
319
254
        tt = transform.TransformPreview(base_tree)
320
255
        tt.deserialize(records)
321
 
        return klass(tree, base_tree, tt, metadata.get('message'))
 
256
        return klass(tree, base_tree, tt, message)
322
257
 
323
 
    def make_merger(self, task=None):
 
258
    def make_merger(self):
324
259
        """Return a merger that can unshelve the changes."""
325
 
        target_tree = self.transform.get_preview_tree()
326
 
        merger = merge.Merger.from_uncommitted(self.tree, target_tree,
327
 
            task, self.base_tree)
328
 
        merger.merge_type = merge.Merge3Merger
329
 
        return merger
 
260
        pb = ui.ui_factory.nested_progress_bar()
 
261
        try:
 
262
            target_tree = self.transform.get_preview_tree()
 
263
            merger = merge.Merger.from_uncommitted(self.tree, target_tree, pb,
 
264
                                                   self.base_tree)
 
265
            merger.merge_type = merge.Merge3Merger
 
266
            return merger
 
267
        finally:
 
268
            pb.finished()
330
269
 
331
270
    def finalize(self):
332
271
        """Release all resources held by this Unshelver."""
399
338
        finally:
400
339
            shelf_file.close()
401
340
 
402
 
    def get_metadata(self, shelf_id):
403
 
        """Return the metadata associated with a given shelf_id."""
404
 
        shelf_file = self.read_shelf(shelf_id)
405
 
        try:
406
 
            records = Unshelver.iter_records(shelf_file)
407
 
        finally:
408
 
            shelf_file.close()
409
 
        return Unshelver.parse_metadata(records)
410
 
 
411
341
    def delete_shelf(self, shelf_id):
412
342
        """Delete the shelved changes for a given id.
413
343