/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/shelf.py

  • Committer: Robert Collins
  • Date: 2010-05-06 23:41:35 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506234135-yivbzczw1sejxnxc
Lock methods on ``Tree``, ``Branch`` and ``Repository`` are now
expected to return an object which can be used to unlock them. This reduces
duplicate code when using cleanups. The previous 'tokens's returned by
``Branch.lock_write`` and ``Repository.lock_write`` are now attributes
on the result of the lock_write. ``repository.RepositoryWriteLockResult``
and ``branch.BranchWriteLockResult`` document this. (Robert Collins)

``log._get_info_for_log_files`` now takes an add_cleanup callable.
(Robert Collins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/shelf.py
1
 
# Copyright (C) 2008, 2009, 2010 Canonical Ltd
 
1
# Copyright (C) 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
from __future__ import absolute_import
18
17
 
19
18
import errno
20
19
import re
21
20
 
22
 
from . import errors
23
 
from .lazy_import import lazy_import
24
 
lazy_import(globals(), """
25
 
from breezy import (
 
21
from bzrlib import (
26
22
    bencode,
 
23
    errors,
27
24
    merge,
28
25
    merge3,
 
26
    pack,
29
27
    transform,
30
28
)
31
 
from breezy.bzr import (
32
 
    pack,
33
 
    )
34
 
""")
35
 
 
36
 
 
37
 
class ShelfCorrupt(errors.BzrError):
38
 
 
39
 
    _fmt = "Shelf corrupt."
40
 
 
41
 
 
42
 
class NoSuchShelfId(errors.BzrError):
43
 
 
44
 
    _fmt = 'No changes are shelved with id "%(shelf_id)d".'
45
 
 
46
 
    def __init__(self, shelf_id):
47
 
        errors.BzrError.__init__(self, shelf_id=shelf_id)
48
 
 
49
 
 
50
 
class InvalidShelfId(errors.BzrError):
51
 
 
52
 
    _fmt = '"%(invalid_id)s" is not a valid shelf id, try a number instead.'
53
 
 
54
 
    def __init__(self, invalid_id):
55
 
        errors.BzrError.__init__(self, invalid_id=invalid_id)
56
29
 
57
30
 
58
31
class ShelfCreator(object):
68
41
        :param file_list: The files to make more similar to the target.
69
42
        """
70
43
        self.work_tree = work_tree
71
 
        self.work_transform = work_tree.get_transform()
 
44
        self.work_transform = transform.TreeTransform(work_tree)
72
45
        try:
73
46
            self.target_tree = target_tree
74
47
            self.shelf_transform = transform.TransformPreview(self.target_tree)
89
62
        """Iterable of tuples describing shelvable changes.
90
63
 
91
64
        As well as generating the tuples, this updates several members.
92
 
        Tuples may be::
93
 
 
 
65
        Tuples may be:
94
66
           ('add file', file_id, work_kind, work_path)
95
67
           ('delete file', file_id, target_kind, target_path)
96
68
           ('rename', file_id, target_path, work_path)
98
70
           ('modify text', file_id)
99
71
           ('modify target', file_id, target_target, work_target)
100
72
        """
101
 
        for change in self.iter_changes:
 
73
        for (file_id, paths, changed, versioned, parents, names, kind,
 
74
             executable) in self.iter_changes:
102
75
            # don't shelve add of tree root.  Working tree should never
103
76
            # lack roots, and bzr misbehaves when they do.
104
77
            # FIXME ADHB (2009-08-09): should still shelve adds of tree roots
105
78
            # when a tree root was deleted / renamed.
106
 
            if change.kind[0] is None and change.name[1] == '':
107
 
                continue
108
 
            # Also don't shelve deletion of tree root.
109
 
            if change.kind[1] is None and change.name[0] == '':
110
 
                continue
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])
 
79
            if kind[0] is None and names[1] == '':
 
80
                continue
 
81
            if kind[0] is None or versioned[0] == False:
 
82
                self.creation[file_id] = (kind[1], names[1], parents[1],
 
83
                                          versioned)
 
84
                yield ('add file', file_id, kind[1], paths[1])
 
85
            elif kind[1] is None or versioned[0] == False:
 
86
                self.deletion[file_id] = (kind[0], names[0], parents[0],
 
87
                                          versioned)
 
88
                yield ('delete file', file_id, kind[0], paths[0])
119
89
            else:
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
 
90
                if names[0] != names[1] or parents[0] != parents[1]:
 
91
                    self.renames[file_id] = (names, parents)
 
92
                    yield ('rename', file_id) + paths
123
93
 
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,
130
 
                           w_target)
131
 
                elif change.changed_content:
132
 
                    yield ('modify text', change.file_id)
 
94
                if kind[0] != kind [1]:
 
95
                    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
                elif changed:
 
102
                    yield ('modify text', file_id)
133
103
 
134
104
    def shelve_change(self, change):
135
105
        """Shelve a change in the iter_shelvable format."""
147
117
            raise ValueError('Unknown change kind: "%s"' % change[0])
148
118
 
149
119
    def shelve_all(self):
150
 
        """Shelve all changes.
151
 
 
152
 
        :return: ``True`` if changes were shelved, otherwise ``False``.
153
 
        """
154
 
        change = None
 
120
        """Shelve all changes."""
155
121
        for change in self.iter_shelvable():
156
122
            self.shelve_change(change)
157
 
        return change is not None
158
123
 
159
124
    def shelve_rename(self, file_id):
160
125
        """Shelve a file rename.
177
142
        :param new_target: The target that the symlink should have due
178
143
            to shelving.
179
144
        """
180
 
        new_path = self.target_tree.id2path(file_id)
181
 
        new_target = self.target_tree.get_symlink_target(new_path)
 
145
        new_target = self.target_tree.get_symlink_target(file_id)
182
146
        w_trans_id = self.work_transform.trans_id_file_id(file_id)
183
147
        self.work_transform.delete_contents(w_trans_id)
184
148
        self.work_transform.create_symlink(new_target, w_trans_id)
185
149
 
186
 
        old_path = self.work_tree.id2path(file_id)
187
 
        old_target = self.work_tree.get_symlink_target(old_path)
 
150
        old_target = self.work_tree.get_symlink_target(file_id)
188
151
        s_trans_id = self.shelf_transform.trans_id_file_id(file_id)
189
152
        self.shelf_transform.delete_contents(s_trans_id)
190
153
        self.shelf_transform.create_symlink(old_target, s_trans_id)
208
171
    def _content_from_tree(tt, tree, file_id):
209
172
        trans_id = tt.trans_id_file_id(file_id)
210
173
        tt.delete_contents(trans_id)
211
 
        transform.create_from_tree(tt, trans_id, tree, tree.id2path(file_id))
 
174
        transform.create_from_tree(tt, trans_id, tree, file_id)
212
175
 
213
176
    def shelve_content_change(self, file_id):
214
177
        """Shelve a kind change or binary file content change.
262
225
            to_transform.adjust_path(name, s_parent_id, s_trans_id)
263
226
            if existing_path is None:
264
227
                if kind is None:
265
 
                    to_transform.create_file([b''], s_trans_id)
 
228
                    to_transform.create_file('', s_trans_id)
266
229
                else:
267
 
                    transform.create_from_tree(
268
 
                        to_transform, s_trans_id, tree,
269
 
                        tree.id2path(file_id))
 
230
                    transform.create_from_tree(to_transform, s_trans_id,
 
231
                                               tree, file_id)
270
232
        if version:
271
233
            to_transform.version_file(file_id, s_trans_id)
272
234
 
273
235
    def _inverse_lines(self, new_lines, file_id):
274
236
        """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)
 
237
        target_lines = self.target_tree.get_file_lines(file_id)
 
238
        work_lines = self.work_tree.get_file_lines(file_id)
279
239
        return merge3.Merge3(new_lines, target_lines, work_lines).merge_lines()
280
240
 
281
241
    def finalize(self):
287
247
        """Shelve changes from working tree."""
288
248
        self.work_transform.apply()
289
249
 
290
 
    @staticmethod
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',),))
297
 
 
298
250
    def write_shelf(self, shelf_file, message=None):
299
251
        """Serialize the shelved changes to a file.
300
252
 
303
255
        :return: the filename of the written file.
304
256
        """
305
257
        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,
308
 
                                 message)
309
 
 
310
 
    @classmethod
311
 
    def _write_shelf(cls, shelf_file, transform, revision_id, message=None):
312
258
        serializer = pack.ContainerSerialiser()
313
259
        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):
 
260
        metadata = {
 
261
            'revision_id': self.target_tree.get_revision_id(),
 
262
        }
 
263
        if message is not None:
 
264
            metadata['message'] = message.encode('utf-8')
 
265
        shelf_file.write(serializer.bytes_record(
 
266
            bencode.bencode(metadata), (('metadata',),)))
 
267
        for bytes in self.shelf_transform.serialize(serializer):
317
268
            shelf_file.write(bytes)
318
269
        shelf_file.write(serializer.end())
319
270
 
341
292
 
342
293
    @staticmethod
343
294
    def parse_metadata(records):
344
 
        names, metadata_bytes = next(records)
345
 
        if names[0] != (b'metadata',):
346
 
            raise ShelfCorrupt
 
295
        names, metadata_bytes = records.next()
 
296
        if names[0] != ('metadata',):
 
297
            raise errors.ShelfCorrupt
347
298
        metadata = bencode.bdecode(metadata_bytes)
348
 
        message = metadata.get(b'message')
 
299
        message = metadata.get('message')
349
300
        if message is not None:
350
 
            metadata[b'message'] = message.decode('utf-8')
 
301
            metadata['message'] = message.decode('utf-8')
351
302
        return metadata
352
303
 
353
304
    @classmethod
360
311
        """
361
312
        records = klass.iter_records(shelf_file)
362
313
        metadata = klass.parse_metadata(records)
363
 
        base_revision_id = metadata[b'revision_id']
 
314
        base_revision_id = metadata['revision_id']
364
315
        try:
365
316
            base_tree = tree.revision_tree(base_revision_id)
366
317
        except errors.NoSuchRevisionInTree:
367
318
            base_tree = tree.branch.repository.revision_tree(base_revision_id)
368
319
        tt = transform.TransformPreview(base_tree)
369
320
        tt.deserialize(records)
370
 
        return klass(tree, base_tree, tt, metadata.get(b'message'))
 
321
        return klass(tree, base_tree, tt, metadata.get('message'))
371
322
 
372
 
    def make_merger(self):
 
323
    def make_merger(self, task=None):
373
324
        """Return a merger that can unshelve the changes."""
374
325
        target_tree = self.transform.get_preview_tree()
375
326
        merger = merge.Merger.from_uncommitted(self.tree, target_tree,
376
 
                                               self.base_tree)
 
327
            task, self.base_tree)
377
328
        merger.merge_type = merge.Merge3Merger
378
329
        return merger
379
330
 
431
382
        filename = self.get_shelf_filename(shelf_id)
432
383
        try:
433
384
            return open(self.transport.local_abspath(filename), 'rb')
434
 
        except IOError as e:
 
385
        except IOError, e:
435
386
            if e.errno != errno.ENOENT:
436
387
                raise
437
 
            raise NoSuchShelfId(shelf_id)
 
388
            from bzrlib import errors
 
389
            raise errors.NoSuchShelfId(shelf_id)
438
390
 
439
391
    def get_unshelver(self, shelf_id):
440
392
        """Return an unshelver for a given shelf_id.
466
418
 
467
419
    def active_shelves(self):
468
420
        """Return a list of shelved changes."""
469
 
        active = sorted(self.get_shelf_ids(self.transport.list_dir('.')))
 
421
        active = self.get_shelf_ids(self.transport.list_dir('.'))
 
422
        active.sort()
470
423
        return active
471
424
 
472
425
    def last_shelf(self):