/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 breezy/shelf.py

  • Committer: Gustav Hartvigsson
  • Date: 2021-01-09 21:36:27 UTC
  • Revision ID: gustav.hartvigsson@gmail.com-20210109213627-h1xwcutzy9m7a99b
Added 'Case Preserving Working Tree Use Cases' from Canonical Wiki

* Addod a page from the Canonical Bazaar wiki
  with information on the scmeatics of case
  perserving filesystems an a case insensitive
  filesystem works.
  
  * Needs re-work, but this will do as it is the
    same inforamoton as what was on the linked
    page in the currint documentation.

Show diffs side-by-side

added added

removed removed

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