~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/plugins/weave_fmt/workingtree.py

  • Committer: Jelmer Vernooij
  • Date: 2011-01-11 04:33:12 UTC
  • mto: (5582.12.2 weave-plugin)
  • mto: This revision was merged to the branch mainline in revision 5718.
  • Revision ID: jelmer@samba.org-20110111043312-g4wx6iuf9662f36d
Move weave formats into bzrlib.plugins.weave_fmt.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005-2010 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
"""Weave-era working tree objects."""
 
18
 
 
19
from cStringIO import StringIO
 
20
 
 
21
from bzrlib import (
 
22
    inventory,
 
23
    revision as _mod_revision,
 
24
    transform,
 
25
    )
 
26
from bzrlib.transport.local import LocalTransport
 
27
from bzrlib.workingtree import (
 
28
    WorkingTreeFormat,
 
29
    WorkingTree,
 
30
    )
 
31
 
 
32
 
 
33
class WorkingTreeFormat2(WorkingTreeFormat):
 
34
    """The second working tree format.
 
35
 
 
36
    This format modified the hash cache from the format 1 hash cache.
 
37
    """
 
38
 
 
39
    upgrade_recommended = True
 
40
 
 
41
    def get_format_description(self):
 
42
        """See WorkingTreeFormat.get_format_description()."""
 
43
        return "Working tree format 2"
 
44
 
 
45
    def _stub_initialize_on_transport(self, transport, file_mode):
 
46
        """Workaround: create control files for a remote working tree.
 
47
 
 
48
        This ensures that it can later be updated and dealt with locally,
 
49
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
 
50
        no working tree.  (See bug #43064).
 
51
        """
 
52
        sio = StringIO()
 
53
        inv = inventory.Inventory()
 
54
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
 
55
        sio.seek(0)
 
56
        transport.put_file('inventory', sio, file_mode)
 
57
        transport.put_bytes('pending-merges', '', file_mode)
 
58
 
 
59
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
 
60
                   accelerator_tree=None, hardlink=False):
 
61
        """See WorkingTreeFormat.initialize()."""
 
62
        if not isinstance(a_bzrdir.transport, LocalTransport):
 
63
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
 
64
        if from_branch is not None:
 
65
            branch = from_branch
 
66
        else:
 
67
            branch = a_bzrdir.open_branch()
 
68
        if revision_id is None:
 
69
            revision_id = _mod_revision.ensure_null(branch.last_revision())
 
70
        branch.lock_write()
 
71
        try:
 
72
            branch.generate_revision_history(revision_id)
 
73
        finally:
 
74
            branch.unlock()
 
75
        inv = inventory.Inventory()
 
76
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
 
77
                         branch,
 
78
                         inv,
 
79
                         _internal=True,
 
80
                         _format=self,
 
81
                         _bzrdir=a_bzrdir)
 
82
        basis_tree = branch.repository.revision_tree(revision_id)
 
83
        if basis_tree.inventory.root is not None:
 
84
            wt.set_root_id(basis_tree.get_root_id())
 
85
        # set the parent list and cache the basis tree.
 
86
        if _mod_revision.is_null(revision_id):
 
87
            parent_trees = []
 
88
        else:
 
89
            parent_trees = [(revision_id, basis_tree)]
 
90
        wt.set_parent_trees(parent_trees)
 
91
        transform.build_tree(basis_tree, wt)
 
92
        return wt
 
93
 
 
94
    def __init__(self):
 
95
        super(WorkingTreeFormat2, self).__init__()
 
96
        from bzrlib.plugins.weave_fmt.bzrdir import BzrDirFormat6
 
97
        self._matchingbzrdir = BzrDirFormat6()
 
98
 
 
99
    def open(self, a_bzrdir, _found=False):
 
100
        """Return the WorkingTree object for a_bzrdir
 
101
 
 
102
        _found is a private parameter, do not use it. It is used to indicate
 
103
               if format probing has already been done.
 
104
        """
 
105
        if not _found:
 
106
            # we are being called directly and must probe.
 
107
            raise NotImplementedError
 
108
        if not isinstance(a_bzrdir.transport, LocalTransport):
 
109
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
 
110
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
 
111
                           _internal=True,
 
112
                           _format=self,
 
113
                           _bzrdir=a_bzrdir)
 
114
        return wt
 
115
 
 
116
 
 
117
class WorkingTree2(WorkingTree):
 
118
    """This is the Format 2 working tree.
 
119
 
 
120
    This was the first weave based working tree.
 
121
     - uses os locks for locking.
 
122
     - uses the branch last-revision.
 
123
    """
 
124
 
 
125
    def __init__(self, *args, **kwargs):
 
126
        super(WorkingTree2, self).__init__(*args, **kwargs)
 
127
        # WorkingTree2 has more of a constraint that self._inventory must
 
128
        # exist. Because this is an older format, we don't mind the overhead
 
129
        # caused by the extra computation here.
 
130
 
 
131
        # Newer WorkingTree's should only have self._inventory set when they
 
132
        # have a read lock.
 
133
        if self._inventory is None:
 
134
            self.read_working_inventory()
 
135
 
 
136
    def _get_check_refs(self):
 
137
        """Return the references needed to perform a check of this tree."""
 
138
        return [('trees', self.last_revision())]
 
139
 
 
140
    def lock_tree_write(self):
 
141
        """See WorkingTree.lock_tree_write().
 
142
 
 
143
        In Format2 WorkingTrees we have a single lock for the branch and tree
 
144
        so lock_tree_write() degrades to lock_write().
 
145
 
 
146
        :return: An object with an unlock method which will release the lock
 
147
            obtained.
 
148
        """
 
149
        self.branch.lock_write()
 
150
        try:
 
151
            self._control_files.lock_write()
 
152
            return self
 
153
        except:
 
154
            self.branch.unlock()
 
155
            raise
 
156
 
 
157
    def unlock(self):
 
158
        # do non-implementation specific cleanup
 
159
        self._cleanup()
 
160
 
 
161
        # we share control files:
 
162
        if self._control_files._lock_count == 3:
 
163
            # _inventory_is_modified is always False during a read lock.
 
164
            if self._inventory_is_modified:
 
165
                self.flush()
 
166
            self._write_hashcache_if_dirty()
 
167
 
 
168
        # reverse order of locking.
 
169
        try:
 
170
            return self._control_files.unlock()
 
171
        finally:
 
172
            self.branch.unlock()
 
173
 
 
174
 
 
175
 
 
176
 
 
177
# formats which have no format string are not discoverable
 
178
# and not independently creatable, so are not registered.
 
179
_legacy_formats = [WorkingTreeFormat2(),
 
180
                   ]