~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/memorytree.py

Various changes to allow non-workingtree specific tests to run entirely
from MemoryTransports:
 * Create MemoryTree and pull up common code for it from WorkingTree to
   a new common base class MutableTree.
 * Add MutableTree.mkdir().
 * Add MutableTree.put_file_bytes_nonatomic().
 * New test helper make_branch_and_memory_tree().
(Robert Collins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
"""MemoryTree object.
 
18
 
 
19
See MemoryTree for more details.
 
20
"""
 
21
 
 
22
 
 
23
from copy import deepcopy
 
24
from cStringIO import StringIO
 
25
 
 
26
from bzrlib import errors, mutabletree
 
27
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
28
from bzrlib.osutils import sha_file
 
29
from bzrlib.transport.memory import MemoryTransport
 
30
 
 
31
 
 
32
class MemoryTree(mutabletree.MutableTree):
 
33
    """A MemoryTree is a specialisation of MutableTree.
 
34
    
 
35
    It maintains nearly no state outside of read_lock and write_lock
 
36
    transactions. (it keeps a reference to the branch, and its last-revision
 
37
    only).
 
38
    """
 
39
 
 
40
    def __init__(self, branch, revision_id):
 
41
        """Construct a MemoryTree for branch using revision_id."""
 
42
        self.branch = branch
 
43
        self.bzrdir = branch.bzrdir
 
44
        self._branch_revision_id = revision_id
 
45
        self._locks = 0
 
46
        self._lock_mode = None
 
47
 
 
48
    @needs_write_lock
 
49
    def _add(self, files, ids, kinds):
 
50
        """See MutableTree._add."""
 
51
        for f, file_id, kind in zip(files, ids, kinds):
 
52
            if kind is None:
 
53
                kind = 'file'
 
54
            if file_id is None:
 
55
                self._inventory.add_path(f, kind=kind)
 
56
            else:
 
57
                self._inventory.add_path(f, kind=kind, file_id=file_id)
 
58
 
 
59
    def basis_tree(self):
 
60
        """See Tree.basis_tree()."""
 
61
        return self._basis_tree
 
62
 
 
63
    @staticmethod
 
64
    def create_on_branch(branch):
 
65
        """Create a MemoryTree for branch, using the last-revision of branch."""
 
66
        return MemoryTree(branch, branch.last_revision())
 
67
 
 
68
    def _gather_kinds(self, files, kinds):
 
69
        """See MutableTree._gather_kinds.
 
70
        
 
71
        This implementation does not care about the file kind of
 
72
        missing files, so is a no-op.
 
73
        """
 
74
 
 
75
    def get_file(self, file_id):
 
76
        """See Tree.get_file."""
 
77
        return self._file_transport.get(self.id2path(file_id))
 
78
 
 
79
    def get_file_sha1(self, file_id, path=None):
 
80
        """See Tree.get_file_sha1()."""
 
81
        if path is None:
 
82
            path = self.id2path(file_id)
 
83
        stream = self._file_transport.get(path)
 
84
        return sha_file(stream)
 
85
 
 
86
    @needs_read_lock
 
87
    def get_parent_ids(self):
 
88
        """See Tree.get_parent_ids.
 
89
 
 
90
        This implementation returns the current cached value from
 
91
            self._parent_ids.
 
92
        """
 
93
        return list(self._parent_ids)
 
94
 
 
95
    def has_filename(self, filename):
 
96
        """See Tree.has_filename()."""
 
97
        return self._file_transport.has(filename)
 
98
 
 
99
    def is_executable(self, file_id, path=None):
 
100
        return self._inventory[file_id].executable
 
101
 
 
102
    def mkdir(self, path, file_id=None):
 
103
        """See MutableTree.mkdir()."""
 
104
        self.add(path, file_id, 'directory')
 
105
        if file_id is None:
 
106
            file_id = self.path2id(path)
 
107
        self._file_transport.mkdir(path)
 
108
        return file_id
 
109
 
 
110
    def lock_read(self):
 
111
        """Lock the memory tree for reading.
 
112
 
 
113
        This triggers population of data from the branch for its revision.
 
114
        """
 
115
        self._locks += 1
 
116
        try:
 
117
            if self._locks == 1:
 
118
                self.branch.lock_read()
 
119
                self._lock_mode = "r"
 
120
                self._populate_from_branch()
 
121
        except:
 
122
            self._locks -= 1
 
123
            raise
 
124
 
 
125
    def lock_write(self):
 
126
        """See MutableTree.lock_write()."""
 
127
        self._locks += 1
 
128
        try:
 
129
            if self._locks == 1:
 
130
                self.branch.lock_write()
 
131
                self._lock_mode = "w"
 
132
                self._populate_from_branch()
 
133
            elif self._lock_mode == "r":
 
134
                raise errors.ReadOnlyError(self)
 
135
        except:
 
136
            self._locks -= 1
 
137
            raise
 
138
 
 
139
    def _populate_from_branch(self):
 
140
        """Populate the in-tree state from the branch."""
 
141
        self._basis_tree = self.branch.repository.revision_tree(
 
142
            self._branch_revision_id)
 
143
        if self._branch_revision_id is None:
 
144
            self._parent_ids = []
 
145
        else:
 
146
            self._parent_ids = [self._branch_revision_id]
 
147
        self._inventory = deepcopy(self._basis_tree._inventory)
 
148
        self._file_transport = MemoryTransport()
 
149
        # TODO copy the revision trees content, or do it lazy, or something.
 
150
        inventory_entries = self._inventory.iter_entries()
 
151
        inventory_entries.next()
 
152
        for path, entry in inventory_entries:
 
153
            if entry.kind == 'directory':
 
154
                self._file_transport.mkdir(path)
 
155
            elif entry.kind == 'file':
 
156
                self._file_transport.put(path,
 
157
                    self._basis_tree.get_file(entry.file_id))
 
158
            else:
 
159
                raise NotImplementedError(self._populate_from_branch)
 
160
 
 
161
    def put_file_bytes_non_atomic(self, file_id, bytes):
 
162
        """See MutableTree.put_file_bytes_non_atomic."""
 
163
        self._file_transport.put(self.id2path(file_id), StringIO(bytes))
 
164
 
 
165
    def unlock(self):
 
166
        """Release a lock.
 
167
 
 
168
        This frees all cached state when the last lock context for the tree is
 
169
        left.
 
170
        """
 
171
        if self._locks == 1:
 
172
            self._basis_tree = None
 
173
            self._parent_ids = []
 
174
            self._inventory = None
 
175
            try:
 
176
                self.branch.unlock()
 
177
            finally:
 
178
                self._locks = 0
 
179
                self._lock_mode = None
 
180
        else:
 
181
            self._locks -= 1
 
182
 
 
183
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
 
184
        """See MutableTree.set_parent_trees()."""
 
185
        if len(parents_list) == 0:
 
186
            self._parent_ids = []
 
187
            self._basis_tree = self.branch.repository.revisiontree(None)
 
188
        else:
 
189
            if parents_list[0][1] is None and not allow_leftmost_as_ghost:
 
190
                # a ghost in the left most parent
 
191
                raise errors.GhostRevisionUnusableHere(parents_list[0][0])
 
192
            self._parent_ids = [parent_id for parent_id, tree in parents_list]
 
193
            if parents_list[0][1] is None:
 
194
                self._basis_tree = self.branch.repository.revisiontree(None)
 
195
            else:
 
196
                self._basis_tree = parents_list[0][1]