/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/memorytree.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/memorytree.py
 
1
# Copyright (C) 2006 Canonical Ltd
 
2
#
 
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.
 
7
#
 
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.
 
12
#
 
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
 
16
 
 
17
"""MemoryTree object.
 
18
 
 
19
See MemoryTree for more details.
 
20
"""
 
21
 
 
22
import os
 
23
import stat
 
24
 
 
25
from . import (
 
26
    errors,
 
27
    lock,
 
28
    revision as _mod_revision,
 
29
    )
 
30
from .bzr.inventory import Inventory
 
31
from .bzr.inventorytree import MutableInventoryTree
 
32
from .osutils import sha_file
 
33
from .transport.memory import MemoryTransport
 
34
 
 
35
 
 
36
class MemoryTree(MutableInventoryTree):
 
37
    """A MemoryTree is a specialisation of MutableTree.
 
38
 
 
39
    It maintains nearly no state outside of read_lock and write_lock
 
40
    transactions. (it keeps a reference to the branch, and its last-revision
 
41
    only).
 
42
    """
 
43
 
 
44
    def __init__(self, branch, revision_id):
 
45
        """Construct a MemoryTree for branch using revision_id."""
 
46
        self.branch = branch
 
47
        self.controldir = branch.controldir
 
48
        self._branch_revision_id = revision_id
 
49
        self._locks = 0
 
50
        self._lock_mode = None
 
51
 
 
52
    def supports_symlinks(self):
 
53
        return True
 
54
 
 
55
    def supports_tree_reference(self):
 
56
        return False
 
57
 
 
58
    def get_config_stack(self):
 
59
        return self.branch.get_config_stack()
 
60
 
 
61
    def is_control_filename(self, filename):
 
62
        # Memory tree doesn't have any control filenames
 
63
        return False
 
64
 
 
65
    def _add(self, files, ids, kinds):
 
66
        """See MutableTree._add."""
 
67
        with self.lock_tree_write():
 
68
            for f, file_id, kind in zip(files, ids, kinds):
 
69
                if kind is None:
 
70
                    st_mode = self._file_transport.stat(f).st_mode
 
71
                    if stat.S_ISREG(st_mode):
 
72
                        kind = 'file'
 
73
                    elif stat.S_ISLNK(st_mode):
 
74
                        kind = 'symlink'
 
75
                    elif stat.S_ISDIR(st_mode):
 
76
                        kind = 'directory'
 
77
                    else:
 
78
                        raise AssertionError('Unknown file kind')
 
79
                if file_id is None:
 
80
                    self._inventory.add_path(f, kind=kind)
 
81
                else:
 
82
                    self._inventory.add_path(f, kind=kind, file_id=file_id)
 
83
 
 
84
    def basis_tree(self):
 
85
        """See Tree.basis_tree()."""
 
86
        return self._basis_tree
 
87
 
 
88
    @staticmethod
 
89
    def create_on_branch(branch):
 
90
        """Create a MemoryTree for branch, using the last-revision of branch."""
 
91
        revision_id = _mod_revision.ensure_null(branch.last_revision())
 
92
        return MemoryTree(branch, revision_id)
 
93
 
 
94
    def _gather_kinds(self, files, kinds):
 
95
        """See MutableTree._gather_kinds.
 
96
 
 
97
        This implementation does not care about the file kind of
 
98
        missing files, so is a no-op.
 
99
        """
 
100
 
 
101
    def get_file(self, path):
 
102
        """See Tree.get_file."""
 
103
        return self._file_transport.get(path)
 
104
 
 
105
    def get_file_sha1(self, path, stat_value=None):
 
106
        """See Tree.get_file_sha1()."""
 
107
        stream = self._file_transport.get(path)
 
108
        return sha_file(stream)
 
109
 
 
110
    def _comparison_data(self, entry, path):
 
111
        """See Tree._comparison_data."""
 
112
        if entry is None:
 
113
            return None, False, None
 
114
        return entry.kind, entry.executable, None
 
115
 
 
116
    def rename_one(self, from_rel, to_rel):
 
117
        with self.lock_tree_write():
 
118
            file_id = self.path2id(from_rel)
 
119
            to_dir, to_tail = os.path.split(to_rel)
 
120
            to_parent_id = self.path2id(to_dir)
 
121
            self._file_transport.move(from_rel, to_rel)
 
122
            self._inventory.rename(file_id, to_parent_id, to_tail)
 
123
 
 
124
    def path_content_summary(self, path):
 
125
        """See Tree.path_content_summary."""
 
126
        id = self.path2id(path)
 
127
        if id is None:
 
128
            return 'missing', None, None, None
 
129
        kind = self.kind(path, id)
 
130
        if kind == 'file':
 
131
            bytes = self._file_transport.get_bytes(path)
 
132
            size = len(bytes)
 
133
            executable = self._inventory[id].executable
 
134
            sha1 = None  # no stat cache
 
135
            return (kind, size, executable, sha1)
 
136
        elif kind == 'directory':
 
137
            # memory tree does not support nested trees yet.
 
138
            return kind, None, None, None
 
139
        elif kind == 'symlink':
 
140
            return kind, None, None, self._inventory[id].symlink_target
 
141
        else:
 
142
            raise NotImplementedError('unknown kind')
 
143
 
 
144
    def get_parent_ids(self):
 
145
        """See Tree.get_parent_ids.
 
146
 
 
147
        This implementation returns the current cached value from
 
148
            self._parent_ids.
 
149
        """
 
150
        with self.lock_read():
 
151
            return list(self._parent_ids)
 
152
 
 
153
    def has_filename(self, filename):
 
154
        """See Tree.has_filename()."""
 
155
        return self._file_transport.has(filename)
 
156
 
 
157
    def is_executable(self, path):
 
158
        return self._inventory.get_entry_by_path(path).executable
 
159
 
 
160
    def kind(self, path):
 
161
        return self._inventory.get_entry_by_path(path).kind
 
162
 
 
163
    def mkdir(self, path, file_id=None):
 
164
        """See MutableTree.mkdir()."""
 
165
        self.add(path, file_id, 'directory')
 
166
        if file_id is None:
 
167
            file_id = self.path2id(path)
 
168
        self._file_transport.mkdir(path)
 
169
        return file_id
 
170
 
 
171
    def last_revision(self):
 
172
        """See MutableTree.last_revision."""
 
173
        with self.lock_read():
 
174
            return self._branch_revision_id
 
175
 
 
176
    def lock_read(self):
 
177
        """Lock the memory tree for reading.
 
178
 
 
179
        This triggers population of data from the branch for its revision.
 
180
        """
 
181
        self._locks += 1
 
182
        try:
 
183
            if self._locks == 1:
 
184
                self.branch.lock_read()
 
185
                self._lock_mode = "r"
 
186
                self._populate_from_branch()
 
187
            return lock.LogicalLockResult(self.unlock)
 
188
        except BaseException:
 
189
            self._locks -= 1
 
190
            raise
 
191
 
 
192
    def lock_tree_write(self):
 
193
        """See MutableTree.lock_tree_write()."""
 
194
        self._locks += 1
 
195
        try:
 
196
            if self._locks == 1:
 
197
                self.branch.lock_read()
 
198
                self._lock_mode = "w"
 
199
                self._populate_from_branch()
 
200
            elif self._lock_mode == "r":
 
201
                raise errors.ReadOnlyError(self)
 
202
        except BaseException:
 
203
            self._locks -= 1
 
204
            raise
 
205
        return lock.LogicalLockResult(self.unlock)
 
206
 
 
207
    def lock_write(self):
 
208
        """See MutableTree.lock_write()."""
 
209
        self._locks += 1
 
210
        try:
 
211
            if self._locks == 1:
 
212
                self.branch.lock_write()
 
213
                self._lock_mode = "w"
 
214
                self._populate_from_branch()
 
215
            elif self._lock_mode == "r":
 
216
                raise errors.ReadOnlyError(self)
 
217
            return lock.LogicalLockResult(self.unlock)
 
218
        except BaseException:
 
219
            self._locks -= 1
 
220
            raise
 
221
 
 
222
    def _populate_from_branch(self):
 
223
        """Populate the in-tree state from the branch."""
 
224
        self._set_basis()
 
225
        if self._branch_revision_id == _mod_revision.NULL_REVISION:
 
226
            self._parent_ids = []
 
227
        else:
 
228
            self._parent_ids = [self._branch_revision_id]
 
229
        self._inventory = Inventory(None, self._basis_tree.get_revision_id())
 
230
        self._file_transport = MemoryTransport()
 
231
        # TODO copy the revision trees content, or do it lazy, or something.
 
232
        inventory_entries = self._basis_tree.iter_entries_by_dir()
 
233
        for path, entry in inventory_entries:
 
234
            self._inventory.add(entry.copy())
 
235
            if path == '':
 
236
                continue
 
237
            if entry.kind == 'directory':
 
238
                self._file_transport.mkdir(path)
 
239
            elif entry.kind == 'symlink':
 
240
                self._file_transport.symlink(entry.symlink_target, path)
 
241
            elif entry.kind == 'file':
 
242
                self._file_transport.put_file(
 
243
                    path, self._basis_tree.get_file(path))
 
244
            else:
 
245
                raise NotImplementedError(self._populate_from_branch)
 
246
 
 
247
    def put_file_bytes_non_atomic(self, path, bytes):
 
248
        """See MutableTree.put_file_bytes_non_atomic."""
 
249
        self._file_transport.put_bytes(path, bytes)
 
250
 
 
251
    def unlock(self):
 
252
        """Release a lock.
 
253
 
 
254
        This frees all cached state when the last lock context for the tree is
 
255
        left.
 
256
        """
 
257
        if self._locks == 1:
 
258
            self._basis_tree = None
 
259
            self._parent_ids = []
 
260
            self._inventory = None
 
261
            try:
 
262
                self.branch.unlock()
 
263
            finally:
 
264
                self._locks = 0
 
265
                self._lock_mode = None
 
266
        else:
 
267
            self._locks -= 1
 
268
 
 
269
    def unversion(self, paths):
 
270
        """Remove the paths from the current versioned set.
 
271
 
 
272
        When a file_id is unversioned, all of its children are automatically
 
273
        unversioned.
 
274
 
 
275
        :param paths: The paths to stop versioning.
 
276
        :raises: NoSuchId if any fileid is not currently versioned.
 
277
        """
 
278
        with self.lock_tree_write():
 
279
            # XXX: This should be in mutabletree, but the inventory-save action
 
280
            # is not relevant to memory tree. Until that is done in unlock by
 
281
            # working tree, we cannot share the implementation.
 
282
            file_ids = set()
 
283
            for path in paths:
 
284
                file_id = self.path2id(path)
 
285
                if file_id is None:
 
286
                    raise errors.NoSuchFile(path)
 
287
                file_ids.add(file_id)
 
288
            for file_id in file_ids:
 
289
                if self._inventory.has_id(file_id):
 
290
                    self._inventory.remove_recursive_id(file_id)
 
291
 
 
292
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
 
293
        """See MutableTree.set_parent_trees()."""
 
294
        for revision_id in revision_ids:
 
295
            _mod_revision.check_not_reserved_id(revision_id)
 
296
        if len(revision_ids) == 0:
 
297
            self._parent_ids = []
 
298
            self._branch_revision_id = _mod_revision.NULL_REVISION
 
299
        else:
 
300
            self._parent_ids = revision_ids
 
301
            self._branch_revision_id = revision_ids[0]
 
302
        self._allow_leftmost_as_ghost = allow_leftmost_as_ghost
 
303
        self._set_basis()
 
304
 
 
305
    def _set_basis(self):
 
306
        try:
 
307
            self._basis_tree = self.branch.repository.revision_tree(
 
308
                self._branch_revision_id)
 
309
        except errors.NoSuchRevision:
 
310
            if self._allow_leftmost_as_ghost:
 
311
                self._basis_tree = self.branch.repository.revision_tree(
 
312
                    _mod_revision.NULL_REVISION)
 
313
            else:
 
314
                raise
 
315
 
 
316
    def get_symlink_target(self, path):
 
317
        with self.lock_read():
 
318
            return self._file_transport.readlink(path)
 
319
 
 
320
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
 
321
        """See MutableTree.set_parent_trees()."""
 
322
        if len(parents_list) == 0:
 
323
            self._parent_ids = []
 
324
            self._basis_tree = self.branch.repository.revision_tree(
 
325
                _mod_revision.NULL_REVISION)
 
326
        else:
 
327
            if parents_list[0][1] is None and not allow_leftmost_as_ghost:
 
328
                # a ghost in the left most parent
 
329
                raise errors.GhostRevisionUnusableHere(parents_list[0][0])
 
330
            self._parent_ids = [parent_id for parent_id, tree in parents_list]
 
331
            if parents_list[0][1] is None or parents_list[0][1] == b'null:':
 
332
                self._basis_tree = self.branch.repository.revision_tree(
 
333
                    _mod_revision.NULL_REVISION)
 
334
            else:
 
335
                self._basis_tree = parents_list[0][1]
 
336
            self._branch_revision_id = parents_list[0][0]