1
# Copyright (C) 2007-2011 Canonical Ltd
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.
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.
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
17
"""WorkingTree3 format and implementation.
21
from __future__ import absolute_import
30
revision as _mod_revision,
34
from bzrlib.decorators import (
37
from bzrlib.lockable_files import LockableFiles
38
from bzrlib.lockdir import LockDir
39
from bzrlib.transport.local import LocalTransport
40
from bzrlib.workingtree import (
42
WorkingTreeFormatMetaDir,
46
class PreDirStateWorkingTree(InventoryWorkingTree):
48
def __init__(self, basedir='.', *args, **kwargs):
49
super(PreDirStateWorkingTree, self).__init__(basedir, *args, **kwargs)
50
# update the whole cache up front and write to disk if anything changed;
51
# in the future we might want to do this more selectively
52
# two possible ways offer themselves : in self._unlock, write the cache
53
# if needed, or, when the cache sees a change, append it to the hash
54
# cache file, and have the parser take the most recent entry for a
56
wt_trans = self.bzrdir.get_workingtree_transport(None)
57
cache_filename = wt_trans.local_abspath('stat-cache')
58
self._hashcache = hashcache.HashCache(basedir, cache_filename,
59
self.bzrdir._get_file_mode(),
60
self._content_filter_stack_provider())
63
# is this scan needed ? it makes things kinda slow.
67
trace.mutter("write hc")
70
def _write_hashcache_if_dirty(self):
71
"""Write out the hashcache if it is dirty."""
72
if self._hashcache.needs_write:
74
self._hashcache.write()
76
if e.errno not in (errno.EPERM, errno.EACCES):
78
# TODO: jam 20061219 Should this be a warning? A single line
79
# warning might be sufficient to let the user know what
81
trace.mutter('Could not write hashcache for %s\nError: %s',
82
self._hashcache.cache_file_name(), e)
85
def get_file_sha1(self, file_id, path=None, stat_value=None):
87
path = self._inventory.id2path(file_id)
88
return self._hashcache.get_sha1(path, stat_value)
91
class WorkingTree3(PreDirStateWorkingTree):
92
"""This is the Format 3 working tree.
94
This differs from the base WorkingTree by:
95
- having its own file lock
96
- having its own last-revision property.
98
This is new in bzr 0.8
102
def _last_revision(self):
103
"""See Mutable.last_revision."""
105
return self._transport.get_bytes('last-revision')
106
except errors.NoSuchFile:
107
return _mod_revision.NULL_REVISION
109
def _change_last_revision(self, revision_id):
110
"""See WorkingTree._change_last_revision."""
111
if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
113
self._transport.delete('last-revision')
114
except errors.NoSuchFile:
118
self._transport.put_bytes('last-revision', revision_id,
119
mode=self.bzrdir._get_file_mode())
122
def _get_check_refs(self):
123
"""Return the references needed to perform a check of this tree."""
124
return [('trees', self.last_revision())]
127
if self._control_files._lock_count == 1:
128
# do non-implementation specific cleanup
130
# _inventory_is_modified is always False during a read lock.
131
if self._inventory_is_modified:
133
self._write_hashcache_if_dirty()
134
# reverse order of locking.
136
return self._control_files.unlock()
141
class WorkingTreeFormat3(WorkingTreeFormatMetaDir):
142
"""The second working tree format updated to record a format marker.
145
- exists within a metadir controlling .bzr
146
- includes an explicit version marker for the workingtree control
147
files, separate from the ControlDir format
148
- modifies the hash cache format
150
- uses a LockDir to guard access for writes.
153
upgrade_recommended = True
155
missing_parent_conflicts = True
157
supports_versioned_directories = True
160
def get_format_string(cls):
161
"""See WorkingTreeFormat.get_format_string()."""
162
return "Bazaar-NG Working Tree format 3"
164
def get_format_description(self):
165
"""See WorkingTreeFormat.get_format_description()."""
166
return "Working tree format 3"
168
_tree_class = WorkingTree3
170
def __get_matchingbzrdir(self):
171
return bzrdir.BzrDirMetaFormat1()
173
_matchingbzrdir = property(__get_matchingbzrdir)
175
def _open_control_files(self, a_bzrdir):
176
transport = a_bzrdir.get_workingtree_transport(None)
177
return LockableFiles(transport, 'lock', LockDir)
179
def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
180
accelerator_tree=None, hardlink=False):
181
"""See WorkingTreeFormat.initialize().
183
:param revision_id: if supplied, create a working tree at a different
184
revision than the branch is at.
185
:param accelerator_tree: A tree which can be used for retrieving file
186
contents more quickly than the revision tree, i.e. a workingtree.
187
The revision tree will be used for cases where accelerator_tree's
188
content is different.
189
:param hardlink: If true, hard-link files from accelerator_tree,
192
if not isinstance(a_bzrdir.transport, LocalTransport):
193
raise errors.NotLocalUrl(a_bzrdir.transport.base)
194
transport = a_bzrdir.get_workingtree_transport(self)
195
control_files = self._open_control_files(a_bzrdir)
196
control_files.create_lock()
197
control_files.lock_write()
198
transport.put_bytes('format', self.get_format_string(),
199
mode=a_bzrdir._get_file_mode())
200
if from_branch is not None:
203
branch = a_bzrdir.open_branch()
204
if revision_id is None:
205
revision_id = _mod_revision.ensure_null(branch.last_revision())
206
# WorkingTree3 can handle an inventory which has a unique root id.
207
# as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
208
# those trees. And because there isn't a format bump inbetween, we
209
# are maintaining compatibility with older clients.
210
# inv = Inventory(root_id=gen_root_id())
211
inv = self._initial_inventory()
212
wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
218
_control_files=control_files)
221
basis_tree = branch.repository.revision_tree(revision_id)
222
# only set an explicit root id if there is one to set.
223
if basis_tree.inventory.root is not None:
224
wt.set_root_id(basis_tree.get_root_id())
225
if revision_id == _mod_revision.NULL_REVISION:
226
wt.set_parent_trees([])
228
wt.set_parent_trees([(revision_id, basis_tree)])
229
transform.build_tree(basis_tree, wt)
231
# Unlock in this order so that the unlock-triggers-flush in
232
# WorkingTree is given a chance to fire.
233
control_files.unlock()
237
def _initial_inventory(self):
238
return inventory.Inventory()
240
def open(self, a_bzrdir, _found=False):
241
"""Return the WorkingTree object for a_bzrdir
243
_found is a private parameter, do not use it. It is used to indicate
244
if format probing has already been done.
247
# we are being called directly and must probe.
248
raise NotImplementedError
249
if not isinstance(a_bzrdir.transport, LocalTransport):
250
raise errors.NotLocalUrl(a_bzrdir.transport.base)
251
wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
254
def _open(self, a_bzrdir, control_files):
255
"""Open the tree itself.
257
:param a_bzrdir: the dir for the tree.
258
:param control_files: the control files for the tree.
260
return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
264
_control_files=control_files)
added
removed
bzrlib/workingtree_3.py
