~bzr-pqm/bzr/bzr.dev

4454.3.60 by John Arbash Meinel
Update copyright
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
2
#
453 by Martin Pool
- Split WorkingTree into its own file
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.
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
7
#
453 by Martin Pool
- Split WorkingTree into its own file
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.
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
12
#
453 by Martin Pool
- Split WorkingTree into its own file
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
4183.7.1 by Sabin Iacob
update FSF mailing address
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
453 by Martin Pool
- Split WorkingTree into its own file
16
1185.16.72 by Martin Pool
[merge] from robert and fix up tests
17
"""WorkingTree object and friends.
18
19
A WorkingTree represents the editable working copy of a branch.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
20
Operations which represent the WorkingTree are also done here,
21
such as renaming or adding files.  The WorkingTree has an inventory
22
which is updated by these operations.  A commit produces a
1185.16.72 by Martin Pool
[merge] from robert and fix up tests
23
new revision based on the workingtree and its inventory.
24
25
At the moment every WorkingTree has its own branch.  Remote
26
WorkingTrees aren't supported.
27
1534.4.46 by Robert Collins
Nearly complete .bzr/checkout splitout.
28
To get a WorkingTree, call bzrdir.open_workingtree() or
29
WorkingTree.open(dir).
1185.16.72 by Martin Pool
[merge] from robert and fix up tests
30
"""
31
32
# TODO: Give the workingtree sole responsibility for the working inventory;
33
# remove the variable and references to it from the branch.  This may require
34
# updating the commit code so as to update the inventory within the working
35
# copy, and making sure there's only one WorkingTree for any directory on disk.
1553.5.74 by Martin Pool
Convert WorkingTree format3 to use LockDirs
36
# At the moment they may alias the inventory and have old copies of it in
37
# memory.  (Now done? -- mbp 20060309)
956 by Martin Pool
doc
38
1996.3.6 by John Arbash Meinel
Find a few places that weren't importing their dependencies.
39
from cStringIO import StringIO
40
import os
2423.2.1 by Alexander Belchenko
Fix for walkdirs in missing dir with Py2.4 @ win32
41
import sys
1996.3.6 by John Arbash Meinel
Find a few places that weren't importing their dependencies.
42
43
from bzrlib.lazy_import import lazy_import
44
lazy_import(globals(), """
1852.15.7 by Robert Collins
Start testing behaviour of unknowns in WorkingTree.walkdirs.
45
from bisect import bisect_left
1732.1.9 by John Arbash Meinel
Non-recursive implementation of WorkingTree.list_files
46
import collections
1534.4.26 by Robert Collins
Move working tree initialisation out from Branch.initialize, deprecated Branch.initialize to Branch.create.
47
import errno
1852.15.7 by Robert Collins
Start testing behaviour of unknowns in WorkingTree.walkdirs.
48
import itertools
49
import operator
1398 by Robert Collins
integrate in Gustavos x-bit patch
50
import stat
2120.7.5 by Aaron Bentley
Merge bzr.dev
51
import re
1534.4.26 by Robert Collins
Move working tree initialisation out from Branch.initialize, deprecated Branch.initialize to Branch.create.
52
1836.1.21 by John Arbash Meinel
Restore the ability to ignore items by modifying DEFAULT_IGNORE
53
import bzrlib
1731.2.17 by Aaron Bentley
Support extracting with checkouts
54
from bzrlib import (
55
    branch,
1996.3.6 by John Arbash Meinel
Find a few places that weren't importing their dependencies.
56
    bzrdir,
57
    conflicts as _mod_conflicts,
58
    errors,
2116.4.1 by John Arbash Meinel
Update file and revision id generators.
59
    generate_ids,
2135.2.7 by Kent Gibson
Implement JAM's review suggestions.
60
    globbing,
4454.3.67 by John Arbash Meinel
Implement RevisionTree.annotate_iter and WT.annotate_iter
61
    graph as _mod_graph,
2201.1.1 by John Arbash Meinel
Fix bug #76299 by ignoring write errors during readonly hashcache write.
62
    hashcache,
1996.3.6 by John Arbash Meinel
Find a few places that weren't importing their dependencies.
63
    ignores,
4496.3.4 by Andrew Bennetts
Tidy up unused and redundant imports in workingtree.py.
64
    inventory,
1996.3.6 by John Arbash Meinel
Find a few places that weren't importing their dependencies.
65
    merge,
2598.5.1 by Aaron Bentley
Start eliminating the use of None to indicate null revision
66
    revision as _mod_revision,
1908.11.5 by John Arbash Meinel
[merge] bzr.dev 2240
67
    revisiontree,
1996.3.6 by John Arbash Meinel
Find a few places that weren't importing their dependencies.
68
    textui,
2323.6.1 by Martin Pool
(broken) Give a message when opening old workingtree formats suggesting upgrade
69
    trace,
1996.3.6 by John Arbash Meinel
Find a few places that weren't importing their dependencies.
70
    transform,
2323.6.2 by Martin Pool
Move responsibility for suggesting upgrades to ui object
71
    ui,
3586.1.3 by Ian Clatworthy
add views attribute to working trees
72
    views,
1996.3.6 by John Arbash Meinel
Find a few places that weren't importing their dependencies.
73
    xml5,
2100.3.10 by Aaron Bentley
Ensure added references are serialized properly, beef up Workingtreee3
74
    xml7,
1731.2.17 by Aaron Bentley
Support extracting with checkouts
75
    )
1852.3.1 by Robert Collins
Trivial cleanups to workingtree.py
76
import bzrlib.branch
1996.3.6 by John Arbash Meinel
Find a few places that weren't importing their dependencies.
77
from bzrlib.transport import get_transport
4210.4.2 by Ian Clatworthy
split filtered views support out into WorkingTreeFormat6
78
from bzrlib.workingtree_4 import (
79
    WorkingTreeFormat4,
80
    WorkingTreeFormat5,
81
    WorkingTreeFormat6,
82
    )
1996.3.6 by John Arbash Meinel
Find a few places that weren't importing their dependencies.
83
""")
84
1986.5.6 by Robert Collins
Merge bzr.dev.
85
from bzrlib import symbol_versioning
1534.4.28 by Robert Collins
first cut at merge from integration.
86
from bzrlib.decorators import needs_read_lock, needs_write_lock
3834.2.1 by Martin Pool
Remove dead exports
87
from bzrlib.lockable_files import LockableFiles
1553.5.74 by Martin Pool
Convert WorkingTree format3 to use LockDirs
88
from bzrlib.lockdir import LockDir
1986.1.2 by Robert Collins
Various changes to allow non-workingtree specific tests to run entirely
89
import bzrlib.mutabletree
1986.1.8 by Robert Collins
Update to bzr.dev, which involves adding lock_tree_write to MutableTree and MemoryTree.
90
from bzrlib.mutabletree import needs_tree_write_lock
2949.6.2 by Alexander Belchenko
more changes osutils.lstat -> os.lstat
91
from bzrlib import osutils
1587.1.14 by Robert Collins
Make bound branch creation happen via 'checkout'
92
from bzrlib.osutils import (
1996.3.6 by John Arbash Meinel
Find a few places that weren't importing their dependencies.
93
    file_kind,
94
    isdir,
2206.1.8 by Marius Kruger
Converted move/rename error messages to show source => target.
95
    normpath,
2220.1.9 by Marius Kruger
Remove all trailing white space this bundle would have
96
    pathjoin,
2206.1.8 by Marius Kruger
Converted move/rename error messages to show source => target.
97
    realpath,
1996.3.6 by John Arbash Meinel
Find a few places that weren't importing their dependencies.
98
    safe_unicode,
99
    splitpath,
100
    supports_executable,
101
    )
3368.2.4 by Ian Clatworthy
make content filter lookup a tree responsibility
102
from bzrlib.filters import filtered_input_file
1996.3.6 by John Arbash Meinel
Find a few places that weren't importing their dependencies.
103
from bzrlib.trace import mutter, note
104
from bzrlib.transport.local import LocalTransport
1551.2.36 by Aaron Bentley
Make pull update the progress bar more nicely
105
from bzrlib.progress import DummyProgress, ProgressPhase
4496.3.4 by Andrew Bennetts
Tidy up unused and redundant imports in workingtree.py.
106
from bzrlib.revision import CURRENT_REVISION
1534.10.3 by Aaron Bentley
Simplify set_merge_modified with rio_file
107
from bzrlib.rio import RioReader, rio_file, Stanza
4496.3.4 by Andrew Bennetts
Tidy up unused and redundant imports in workingtree.py.
108
from bzrlib.symbol_versioning import (
109
    deprecated_passed,
110
    DEPRECATED_PARAMETER,
111
    )
1996.3.6 by John Arbash Meinel
Find a few places that weren't importing their dependencies.
112
113
114
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
115
CONFLICT_HEADER_1 = "BZR conflict list format 1"
1685.1.30 by John Arbash Meinel
PEP8 for workingtree.py
116
2423.2.1 by Alexander Belchenko
Fix for walkdirs in missing dir with Py2.4 @ win32
117
ERROR_PATH_NOT_FOUND = 3    # WindowsError errno code, equivalent to ENOENT
118
2116.4.1 by John Arbash Meinel
Update file and revision id generators.
119
1399.1.2 by Robert Collins
push kind character creation into InventoryEntry and TreeEntry
120
class TreeEntry(object):
1759.2.1 by Jelmer Vernooij
Fix some types (found using aspell).
121
    """An entry that implements the minimum interface used by commands.
1399.1.2 by Robert Collins
push kind character creation into InventoryEntry and TreeEntry
122
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
123
    This needs further inspection, it may be better to have
1399.1.2 by Robert Collins
push kind character creation into InventoryEntry and TreeEntry
124
    InventoryEntries without ids - though that seems wrong. For now,
125
    this is a parallel hierarchy to InventoryEntry, and needs to become
126
    one of several things: decorates to that hierarchy, children of, or
127
    parents of it.
1399.1.3 by Robert Collins
move change detection for text and metadata from delta to entry.detect_changes
128
    Another note is that these objects are currently only used when there is
129
    no InventoryEntry available - i.e. for unversioned objects.
130
    Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
1399.1.2 by Robert Collins
push kind character creation into InventoryEntry and TreeEntry
131
    """
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
132
1399.1.2 by Robert Collins
push kind character creation into InventoryEntry and TreeEntry
133
    def __eq__(self, other):
134
        # yes, this us ugly, TODO: best practice __eq__ style.
135
        return (isinstance(other, TreeEntry)
136
                and other.__class__ == self.__class__)
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
137
1399.1.2 by Robert Collins
push kind character creation into InventoryEntry and TreeEntry
138
    def kind_character(self):
139
        return "???"
140
141
142
class TreeDirectory(TreeEntry):
143
    """See TreeEntry. This is a directory in a working tree."""
144
145
    def __eq__(self, other):
146
        return (isinstance(other, TreeDirectory)
147
                and other.__class__ == self.__class__)
148
149
    def kind_character(self):
150
        return "/"
151
152
153
class TreeFile(TreeEntry):
154
    """See TreeEntry. This is a regular file in a working tree."""
155
156
    def __eq__(self, other):
157
        return (isinstance(other, TreeFile)
158
                and other.__class__ == self.__class__)
159
160
    def kind_character(self):
161
        return ''
162
163
164
class TreeLink(TreeEntry):
165
    """See TreeEntry. This is a symlink in a working tree."""
166
167
    def __eq__(self, other):
168
        return (isinstance(other, TreeLink)
169
                and other.__class__ == self.__class__)
170
171
    def kind_character(self):
172
        return ''
173
174
1986.1.2 by Robert Collins
Various changes to allow non-workingtree specific tests to run entirely
175
class WorkingTree(bzrlib.mutabletree.MutableTree):
453 by Martin Pool
- Split WorkingTree into its own file
176
    """Working copy tree.
177
178
    The inventory is held in the `Branch` working-inventory, and the
179
    files are in a directory on disk.
180
181
    It is possible for a `WorkingTree` to have a filename which is
182
    not listed in the Inventory and vice versa.
183
    """
1442.1.65 by Robert Collins
Branch.remove has been moved to WorkingTree.
184
3586.1.3 by Ian Clatworthy
add views attribute to working trees
185
    # override this to set the strategy for storing views
186
    def _make_views(self):
187
        return views.DisabledViews(self)
188
1534.4.51 by Robert Collins
Test the disk layout of format3 working trees.
189
    def __init__(self, basedir='.',
1508.1.19 by Robert Collins
Give format3 working trees their own last-revision marker.
190
                 branch=DEPRECATED_PARAMETER,
1534.4.51 by Robert Collins
Test the disk layout of format3 working trees.
191
                 _inventory=None,
192
                 _control_files=None,
193
                 _internal=False,
194
                 _format=None,
195
                 _bzrdir=None):
2367.2.1 by Robert Collins
Remove bzrlib 0.8 compatability where it was making the code unclear or messy. (Robert Collins)
196
        """Construct a WorkingTree instance. This is not a public API.
1457.1.1 by Robert Collins
rather than getting the branch inventory, WorkingTree can use the whole Branch, or make its own.
197
2367.2.1 by Robert Collins
Remove bzrlib 0.8 compatability where it was making the code unclear or messy. (Robert Collins)
198
        :param branch: A branch to override probing for the branch.
1457.1.1 by Robert Collins
rather than getting the branch inventory, WorkingTree can use the whole Branch, or make its own.
199
        """
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
200
        self._format = _format
1534.4.51 by Robert Collins
Test the disk layout of format3 working trees.
201
        self.bzrdir = _bzrdir
1534.4.46 by Robert Collins
Nearly complete .bzr/checkout splitout.
202
        if not _internal:
2367.2.1 by Robert Collins
Remove bzrlib 0.8 compatability where it was making the code unclear or messy. (Robert Collins)
203
            raise errors.BzrError("Please use bzrdir.open_workingtree or "
204
                "WorkingTree.open() to obtain a WorkingTree.")
1534.4.26 by Robert Collins
Move working tree initialisation out from Branch.initialize, deprecated Branch.initialize to Branch.create.
205
        basedir = safe_unicode(basedir)
1534.5.3 by Robert Collins
Make format 4/5/6 branches share a single LockableFiles instance across wt/branch/repository.
206
        mutter("opening working tree %r", basedir)
1508.1.19 by Robert Collins
Give format3 working trees their own last-revision marker.
207
        if deprecated_passed(branch):
1681.1.1 by Robert Collins
Make WorkingTree.branch a read only property. (Robert Collins)
208
            self._branch = branch
1508.1.19 by Robert Collins
Give format3 working trees their own last-revision marker.
209
        else:
1681.1.1 by Robert Collins
Make WorkingTree.branch a read only property. (Robert Collins)
210
            self._branch = self.bzrdir.open_branch()
1508.1.10 by Robert Collins
bzrlib.add.smart_add_branch is now smart_add_tree. (Robert Collins)
211
        self.basedir = realpath(basedir)
1534.4.28 by Robert Collins
first cut at merge from integration.
212
        # if branch is at our basedir and is a format 6 or less
1534.4.51 by Robert Collins
Test the disk layout of format3 working trees.
213
        if isinstance(self._format, WorkingTreeFormat2):
214
            # share control object
1534.4.28 by Robert Collins
first cut at merge from integration.
215
            self._control_files = self.branch.control_files
216
        else:
1852.3.1 by Robert Collins
Trivial cleanups to workingtree.py
217
            # assume all other formats have their own control files.
1553.5.74 by Martin Pool
Convert WorkingTree format3 to use LockDirs
218
            self._control_files = _control_files
3407.2.1 by Martin Pool
Deprecate LockableFiles.get
219
        self._transport = self._control_files._transport
866 by Martin Pool
- use new path-based hashcache for WorkingTree- squash mtime/ctime to whole seconds- update and if necessary write out hashcache when WorkingTree object is created.
220
        # update the whole cache up front and write to disk if anything changed;
221
        # in the future we might want to do this more selectively
1467 by Robert Collins
WorkingTree.__del__ has been removed.
222
        # two possible ways offer themselves : in self._unlock, write the cache
223
        # if needed, or, when the cache sees a change, append it to the hash
224
        # cache file, and have the parser take the most recent entry for a
225
        # given path only.
2220.1.6 by Marius Kruger
* change error message telling user about --after option sightly
226
        wt_trans = self.bzrdir.get_workingtree_transport(None)
227
        cache_filename = wt_trans.local_abspath('stat-cache')
2201.1.1 by John Arbash Meinel
Fix bug #76299 by ignoring write errors during readonly hashcache write.
228
        self._hashcache = hashcache.HashCache(basedir, cache_filename,
3368.2.27 by Ian Clatworthy
merge bzr.dev r3564
229
            self.bzrdir._get_file_mode(),
3368.2.45 by Ian Clatworthy
add and use supports_content_filtering API
230
            self._content_filter_stack_provider())
2201.1.1 by John Arbash Meinel
Fix bug #76299 by ignoring write errors during readonly hashcache write.
231
        hc = self._hashcache
866 by Martin Pool
- use new path-based hashcache for WorkingTree- squash mtime/ctime to whole seconds- update and if necessary write out hashcache when WorkingTree object is created.
232
        hc.read()
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
233
        # is this scan needed ? it makes things kinda slow.
1732.1.20 by John Arbash Meinel
hash cache pre-scan cost us ~500ms on a kernel sized tree
234
        #hc.scan()
866 by Martin Pool
- use new path-based hashcache for WorkingTree- squash mtime/ctime to whole seconds- update and if necessary write out hashcache when WorkingTree object is created.
235
236
        if hc.needs_write:
237
            mutter("write hc")
238
            hc.write()
453 by Martin Pool
- Split WorkingTree into its own file
239
1534.4.26 by Robert Collins
Move working tree initialisation out from Branch.initialize, deprecated Branch.initialize to Branch.create.
240
        if _inventory is None:
2334.1.1 by John Arbash Meinel
Lazily read working inventory in workingtree.py,
241
            # This will be acquired on lock_read() or lock_write()
1986.5.3 by Robert Collins
New method ``WorkingTree.flush()`` which will write the current memory
242
            self._inventory_is_modified = False
2334.1.1 by John Arbash Meinel
Lazily read working inventory in workingtree.py,
243
            self._inventory = None
1534.4.26 by Robert Collins
Move working tree initialisation out from Branch.initialize, deprecated Branch.initialize to Branch.create.
244
        else:
1986.5.3 by Robert Collins
New method ``WorkingTree.flush()`` which will write the current memory
245
            # the caller of __init__ has provided an inventory,
246
            # we assume they know what they are doing - as its only
247
            # the Format factory and creation methods that are
248
            # permitted to do this.
249
            self._set_inventory(_inventory, dirty=False)
3034.4.3 by Aaron Bentley
Add case-sensitivity handling to WorkingTree
250
        self._detect_case_handling()
3398.1.24 by Ian Clatworthy
make iter_search_rules a tree method
251
        self._rules_searcher = None
3586.1.3 by Ian Clatworthy
add views attribute to working trees
252
        self.views = self._make_views()
3034.4.3 by Aaron Bentley
Add case-sensitivity handling to WorkingTree
253
254
    def _detect_case_handling(self):
255
        wt_trans = self.bzrdir.get_workingtree_transport(None)
256
        try:
257
            wt_trans.stat("FoRMaT")
3034.4.4 by Aaron Bentley
Fix case-sensitivity detection
258
        except errors.NoSuchFile:
3034.4.3 by Aaron Bentley
Add case-sensitivity handling to WorkingTree
259
            self.case_sensitive = True
260
        else:
261
            self.case_sensitive = False
1185.60.6 by Aaron Bentley
Fixed hashcache
262
2974.2.2 by John Arbash Meinel
Only one test failed, because it was incorrectly succeeding.
263
        self._setup_directory_is_tree_reference()
264
1681.1.1 by Robert Collins
Make WorkingTree.branch a read only property. (Robert Collins)
265
    branch = property(
266
        fget=lambda self: self._branch,
267
        doc="""The branch this WorkingTree is connected to.
268
269
            This cannot be set - it is reflective of the actual disk structure
270
            the working tree has been constructed from.
271
            """)
272
1687.1.9 by Robert Collins
Teach WorkingTree about break-lock.
273
    def break_lock(self):
274
        """Break a lock if one is present from another instance.
275
276
        Uses the ui factory to ask for confirmation if the lock may be from
277
        an active process.
278
279
        This will probe the repository for its lock as well.
280
        """
281
        self._control_files.break_lock()
282
        self.branch.break_lock()
283
2100.3.14 by Aaron Bentley
Test workingtree4 format, prevent use with old repos
284
    def requires_rich_root(self):
285
        return self._format.requires_rich_root
286
2100.3.20 by Aaron Bentley
Implement tree comparison for tree references
287
    def supports_tree_reference(self):
2255.2.232 by Robert Collins
Make WorkingTree4 report support for references based on the repositories capabilities.
288
        return False
2100.3.20 by Aaron Bentley
Implement tree comparison for tree references
289
3907.2.1 by Ian Clatworthy
WorkingTreeFormat5 supporting content filtering and views
290
    def supports_content_filtering(self):
291
        return self._format.supports_content_filtering()
292
3586.1.3 by Ian Clatworthy
add views attribute to working trees
293
    def supports_views(self):
294
        return self.views.supports_views()
295
1986.5.3 by Robert Collins
New method ``WorkingTree.flush()`` which will write the current memory
296
    def _set_inventory(self, inv, dirty):
297
        """Set the internal cached inventory.
298
299
        :param inv: The inventory to set.
300
        :param dirty: A boolean indicating whether the inventory is the same
301
            logical inventory as whats on disk. If True the inventory is not
302
            the same and should be written to disk or data will be lost, if
303
            False then the inventory is the same as that on disk and any
304
            serialisation would be unneeded overhead.
305
        """
1508.1.10 by Robert Collins
bzrlib.add.smart_add_branch is now smart_add_tree. (Robert Collins)
306
        self._inventory = inv
1986.5.3 by Robert Collins
New method ``WorkingTree.flush()`` which will write the current memory
307
        self._inventory_is_modified = dirty
1534.5.5 by Robert Collins
Move is_control_file into WorkingTree.is_control_filename and test.
308
1508.1.1 by Robert Collins
Provide a open_containing for WorkingTree.
309
    @staticmethod
1534.4.46 by Robert Collins
Nearly complete .bzr/checkout splitout.
310
    def open(path=None, _unsupported=False):
311
        """Open an existing working tree at path.
312
313
        """
314
        if path is None:
3753.1.1 by John Arbash Meinel
Add some simple direct tests for WT.open and WT.open_containing.
315
            path = osutils.getcwd()
1534.4.46 by Robert Collins
Nearly complete .bzr/checkout splitout.
316
        control = bzrdir.BzrDir.open(path, _unsupported)
317
        return control.open_workingtree(_unsupported)
3753.1.1 by John Arbash Meinel
Add some simple direct tests for WT.open and WT.open_containing.
318
1534.4.46 by Robert Collins
Nearly complete .bzr/checkout splitout.
319
    @staticmethod
1508.1.1 by Robert Collins
Provide a open_containing for WorkingTree.
320
    def open_containing(path=None):
321
        """Open an existing working tree which has its root about path.
3753.1.1 by John Arbash Meinel
Add some simple direct tests for WT.open and WT.open_containing.
322
1508.1.1 by Robert Collins
Provide a open_containing for WorkingTree.
323
        This probes for a working tree at path and searches upwards from there.
324
325
        Basically we keep looking up until we find the control directory or
326
        run into /.  If there isn't one, raises NotBranchError.
327
        TODO: give this a new exception.
328
        If there is one, it is returned, along with the unused portion of path.
1685.1.27 by John Arbash Meinel
BzrDir works in URLs, but WorkingTree works in unicode paths
329
330
        :return: The WorkingTree that contains 'path', and the rest of path
1508.1.1 by Robert Collins
Provide a open_containing for WorkingTree.
331
        """
332
        if path is None:
1830.3.14 by John Arbash Meinel
WorkingTree.open_containing() was directly calling os.getcwdu(), which on mac returns the wrong normalization, and on win32 would have the wrong slashes
333
            path = osutils.getcwd()
1685.1.28 by John Arbash Meinel
Changing open_containing to always return a unicode path.
334
        control, relpath = bzrdir.BzrDir.open_containing(path)
1685.1.27 by John Arbash Meinel
BzrDir works in URLs, but WorkingTree works in unicode paths
335
1685.1.28 by John Arbash Meinel
Changing open_containing to always return a unicode path.
336
        return control.open_workingtree(), relpath
1534.4.46 by Robert Collins
Nearly complete .bzr/checkout splitout.
337
338
    @staticmethod
339
    def open_downlevel(path=None):
340
        """Open an unsupported working tree.
341
342
        Only intended for advanced situations like upgrading part of a bzrdir.
343
        """
344
        return WorkingTree.open(path, _unsupported=True)
1508.1.1 by Robert Collins
Provide a open_containing for WorkingTree.
345
3140.1.4 by Aaron Bentley
Add WorkingTree.find_trees
346
    @staticmethod
347
    def find_trees(location):
348
        def list_current(transport):
349
            return [d for d in transport.list_dir('') if d != '.bzr']
350
        def evaluate(bzrdir):
351
            try:
352
                tree = bzrdir.open_workingtree()
353
            except errors.NoWorkingTree:
354
                return True, None
355
            else:
356
                return True, tree
357
        transport = get_transport(location)
358
        iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
359
                                              list_current=list_current)
360
        return [t for t in iterator if t is not None]
361
2255.2.170 by Martin Pool
merge dirstate
362
    # should be deprecated - this is slow and in any case treating them as a
363
    # container is (we now know) bad style -- mbp 20070302
364
    ## @deprecated_method(zero_fifteen)
462 by Martin Pool
- New form 'file_id in tree' to check if the file is present
365
    def __iter__(self):
366
        """Iterate through file_ids for this tree.
367
368
        file_ids are in a WorkingTree if they are in the working inventory
369
        and the working file exists.
370
        """
371
        inv = self._inventory
866 by Martin Pool
- use new path-based hashcache for WorkingTree- squash mtime/ctime to whole seconds- update and if necessary write out hashcache when WorkingTree object is created.
372
        for path, ie in inv.iter_entries():
1836.1.22 by John Arbash Meinel
[merge] bzr.dev 1861
373
            if osutils.lexists(self.abspath(path)):
866 by Martin Pool
- use new path-based hashcache for WorkingTree- squash mtime/ctime to whole seconds- update and if necessary write out hashcache when WorkingTree object is created.
374
                yield ie.file_id
462 by Martin Pool
- New form 'file_id in tree' to check if the file is present
375
3146.8.16 by Aaron Bentley
Updates from review
376
    def all_file_ids(self):
3146.8.2 by Aaron Bentley
Introduce iter_all_file_ids, to avoid hitting Inventory for this case
377
        """See Tree.iter_all_file_ids"""
3146.8.16 by Aaron Bentley
Updates from review
378
        return set(self.inventory)
3146.8.2 by Aaron Bentley
Introduce iter_all_file_ids, to avoid hitting Inventory for this case
379
453 by Martin Pool
- Split WorkingTree into its own file
380
    def __repr__(self):
381
        return "<%s of %s>" % (self.__class__.__name__,
954 by Martin Pool
- separate out code that just scans the hash cache to find files that are possibly
382
                               getattr(self, 'basedir', None))
453 by Martin Pool
- Split WorkingTree into its own file
383
384
    def abspath(self, filename):
1185.31.32 by John Arbash Meinel
Updated the bzr sourcecode to use bzrlib.osutils.pathjoin rather than os.path.join to enforce internal use of / instead of \
385
        return pathjoin(self.basedir, filename)
2292.1.30 by Marius Kruger
* Minor text fixes.
386
1534.4.35 by Robert Collins
Give branch its own basis tree and last_revision methods; deprecated branch.working_tree()
387
    def basis_tree(self):
1927.2.3 by Robert Collins
review comment application - paired with Martin.
388
        """Return RevisionTree for the current last revision.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
389
1927.2.3 by Robert Collins
review comment application - paired with Martin.
390
        If the left most parent is a ghost then the returned tree will be an
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
391
        empty tree - one obtained by calling
3668.5.1 by Jelmer Vernooij
Use NULL_REVISION rather than None for Repository.revision_tree().
392
        repository.revision_tree(NULL_REVISION).
1927.2.3 by Robert Collins
review comment application - paired with Martin.
393
        """
1908.7.6 by Robert Collins
Deprecate WorkingTree.last_revision.
394
        try:
395
            revision_id = self.get_parent_ids()[0]
396
        except IndexError:
397
            # no parents, return an empty revision tree.
398
            # in the future this should return the tree for
399
            # 'empty:' - the implicit root empty tree.
3668.5.1 by Jelmer Vernooij
Use NULL_REVISION rather than None for Repository.revision_tree().
400
            return self.branch.repository.revision_tree(
401
                       _mod_revision.NULL_REVISION)
1908.11.2 by Robert Collins
Implement WorkingTree interface conformance tests for
402
        try:
403
            return self.revision_tree(revision_id)
404
        except errors.NoSuchRevision:
405
            pass
1908.7.6 by Robert Collins
Deprecate WorkingTree.last_revision.
406
        # No cached copy available, retrieve from the repository.
407
        # FIXME? RBC 20060403 should we cache the inventory locally
408
        # at this point ?
1927.2.1 by Robert Collins
Alter set_pending_merges to shove the left most merge into the trees last-revision if that is not set. Related bugfixes include basis_tree handling ghosts, de-duping the merges with the last-revision and update changing where and how it adds its pending merge.
409
        try:
410
            return self.branch.repository.revision_tree(revision_id)
3350.6.4 by Robert Collins
First cut at pluralised VersionedFiles. Some rather massive API incompatabilities, primarily because of the difficulty of coherence among competing stores.
411
        except (errors.RevisionNotPresent, errors.NoSuchRevision):
1927.2.1 by Robert Collins
Alter set_pending_merges to shove the left most merge into the trees last-revision if that is not set. Related bugfixes include basis_tree handling ghosts, de-duping the merges with the last-revision and update changing where and how it adds its pending merge.
412
            # the basis tree *may* be a ghost or a low level error may have
4031.3.1 by Frank Aspell
Fixing various typos
413
            # occurred. If the revision is present, its a problem, if its not
1927.2.1 by Robert Collins
Alter set_pending_merges to shove the left most merge into the trees last-revision if that is not set. Related bugfixes include basis_tree handling ghosts, de-duping the merges with the last-revision and update changing where and how it adds its pending merge.
414
            # its a ghost.
415
            if self.branch.repository.has_revision(revision_id):
416
                raise
1927.2.3 by Robert Collins
review comment application - paired with Martin.
417
            # the basis tree is a ghost so return an empty tree.
3668.5.1 by Jelmer Vernooij
Use NULL_REVISION rather than None for Repository.revision_tree().
418
            return self.branch.repository.revision_tree(
419
                       _mod_revision.NULL_REVISION)
453 by Martin Pool
- Split WorkingTree into its own file
420
2665.3.2 by Daniel Watkins
Created _cleanup() method in WorkingTree.
421
    def _cleanup(self):
422
        self._flush_ignore_list_cache()
423
1713.1.9 by Robert Collins
Paired performance tuning of bzr add. (Robert Collins, Martin Pool).
424
    def relpath(self, path):
425
        """Return the local path portion from a given path.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
426
427
        The path may be absolute or relative. If its a relative path it is
1713.1.9 by Robert Collins
Paired performance tuning of bzr add. (Robert Collins, Martin Pool).
428
        interpreted relative to the python current working directory.
429
        """
1996.3.6 by John Arbash Meinel
Find a few places that weren't importing their dependencies.
430
        return osutils.relpath(self.basedir, path)
1457.1.3 by Robert Collins
make Branch.relpath delegate to the working tree.
431
453 by Martin Pool
- Split WorkingTree into its own file
432
    def has_filename(self, filename):
1836.1.22 by John Arbash Meinel
[merge] bzr.dev 1861
433
        return osutils.lexists(self.abspath(filename))
453 by Martin Pool
- Split WorkingTree into its own file
434
3368.2.11 by Ian Clatworthy
add filtered option to get_file and get_file_byname in workingtree.py
435
    def get_file(self, file_id, path=None, filtered=True):
3368.2.45 by Ian Clatworthy
add and use supports_content_filtering API
436
        return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
3709.3.2 by Robert Collins
Race-free stat-fingerprint updating during commit via a new method get_file_with_stat.
437
3368.2.45 by Ian Clatworthy
add and use supports_content_filtering API
438
    def get_file_with_stat(self, file_id, path=None, filtered=True,
439
        _fstat=os.fstat):
4354.4.7 by Aaron Bentley
Move MutableTree.get_file_with_stat to Tree.get_file_with_stat.
440
        """See Tree.get_file_with_stat."""
2743.3.3 by Ian Clatworthy
Skip path lookup for tree.get_file() when we already know the path
441
        if path is None:
442
            path = self.id2path(file_id)
3368.2.41 by Ian Clatworthy
1st cut merge of bzr.dev r3907
443
        file_obj = self.get_file_byname(path, filtered=False)
3368.2.45 by Ian Clatworthy
add and use supports_content_filtering API
444
        stat_value = _fstat(file_obj.fileno())
4413.4.3 by John Arbash Meinel
Move the boolean check to the first part of the if statement
445
        if filtered and self.supports_content_filtering():
3368.2.46 by Ian Clatworthy
minor fix
446
            filters = self._content_filter_stack(path)
3368.2.45 by Ian Clatworthy
add and use supports_content_filtering API
447
            file_obj = filtered_input_file(file_obj, filters)
448
        return (file_obj, stat_value)
453 by Martin Pool
- Split WorkingTree into its own file
449
3368.2.41 by Ian Clatworthy
1st cut merge of bzr.dev r3907
450
    def get_file_text(self, file_id, path=None, filtered=True):
451
        return self.get_file(file_id, path=path, filtered=filtered).read()
1852.6.9 by Robert Collins
Add more test trees to the tree-implementations tests.
452
3368.2.11 by Ian Clatworthy
add filtered option to get_file and get_file_byname in workingtree.py
453
    def get_file_byname(self, filename, filtered=True):
3368.2.1 by Ian Clatworthy
first cut at working tree content filtering
454
        path = self.abspath(filename)
3368.2.11 by Ian Clatworthy
add filtered option to get_file and get_file_byname in workingtree.py
455
        f = file(path, 'rb')
4413.4.3 by John Arbash Meinel
Move the boolean check to the first part of the if statement
456
        if filtered and self.supports_content_filtering():
3368.2.11 by Ian Clatworthy
add filtered option to get_file and get_file_byname in workingtree.py
457
            filters = self._content_filter_stack(filename)
458
            return filtered_input_file(f, filters)
459
        else:
460
            return f
453 by Martin Pool
- Split WorkingTree into its own file
461
3368.2.45 by Ian Clatworthy
add and use supports_content_filtering API
462
    def get_file_lines(self, file_id, path=None, filtered=True):
3774.1.4 by Aaron Bentley
Use file.readlines on working trees.
463
        """See Tree.get_file_lines()"""
3368.2.45 by Ian Clatworthy
add and use supports_content_filtering API
464
        file = self.get_file(file_id, path, filtered=filtered)
3774.1.4 by Aaron Bentley
Use file.readlines on working trees.
465
        try:
466
            return file.readlines()
467
        finally:
468
            file.close()
469
2255.2.18 by Robert Collins
Dirstate: all tree_implementation tests passing.
470
    @needs_read_lock
1551.15.46 by Aaron Bentley
Move plan merge to tree
471
    def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
1551.9.16 by Aaron Bentley
Implement Tree.annotate_iter for RevisionTree and WorkingTree
472
        """See Tree.annotate_iter
473
474
        This implementation will use the basis tree implementation if possible.
475
        Lines not in the basis are attributed to CURRENT_REVISION
476
477
        If there are pending merges, lines added by those merges will be
478
        incorrectly attributed to CURRENT_REVISION (but after committing, the
479
        attribution will be correct).
480
        """
4454.3.67 by John Arbash Meinel
Implement RevisionTree.annotate_iter and WT.annotate_iter
481
        maybe_file_parent_keys = []
482
        for parent_id in self.get_parent_ids():
483
            try:
484
                parent_tree = self.revision_tree(parent_id)
485
            except errors.NoSuchRevisionInTree:
486
                parent_tree = self.branch.repository.revision_tree(parent_id)
487
            parent_tree.lock_read()
488
            try:
489
                if file_id not in parent_tree:
2255.2.238 by Robert Collins
Fix annotate_iter to lock the basis tree appropriately.
490
                    continue
4454.3.67 by John Arbash Meinel
Implement RevisionTree.annotate_iter and WT.annotate_iter
491
                ie = parent_tree.inventory[file_id]
4454.3.68 by John Arbash Meinel
Add some tests that we can handle doing annotations even when
492
                if ie.kind != 'file':
493
                    # Note: this is slightly unnecessary, because symlinks and
494
                    # directories have a "text" which is the empty text, and we
495
                    # know that won't mess up annotations. But it seems cleaner
496
                    continue
4454.3.67 by John Arbash Meinel
Implement RevisionTree.annotate_iter and WT.annotate_iter
497
                parent_text_key = (file_id, ie.revision)
498
                if parent_text_key not in maybe_file_parent_keys:
499
                    maybe_file_parent_keys.append(parent_text_key)
500
            finally:
501
                parent_tree.unlock()
502
        graph = _mod_graph.Graph(self.branch.repository.texts)
503
        heads = graph.heads(maybe_file_parent_keys)
504
        file_parent_keys = []
505
        for key in maybe_file_parent_keys:
506
            if key in heads:
507
                file_parent_keys.append(key)
508
509
        # Now we have the parents of this content
510
        annotator = self.branch.repository.texts.get_annotator()
511
        text = self.get_file(file_id).read()
512
        this_key =(file_id, default_revision)
513
        annotator.add_special_text(this_key, file_parent_keys, text)
514
        annotations = [(key[-1], line)
515
                       for key, line in annotator.annotate_flat(this_key)]
516
        return annotations
1551.9.18 by Aaron Bentley
Updates from review comments
517
1551.15.46 by Aaron Bentley
Move plan merge to tree
518
    def _get_ancestors(self, default_revision):
519
        ancestors = set([default_revision])
520
        for parent_id in self.get_parent_ids():
521
            ancestors.update(self.branch.repository.get_ancestry(
522
                             parent_id, topo_sorted=False))
523
        return ancestors
524
1773.2.1 by Robert Collins
Teach all trees about unknowns, conflicts and get_parent_ids.
525
    def get_parent_ids(self):
526
        """See Tree.get_parent_ids.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
527
1773.2.1 by Robert Collins
Teach all trees about unknowns, conflicts and get_parent_ids.
528
        This implementation reads the pending merges list and last_revision
529
        value and uses that to decide what the parents list should be.
530
        """
2598.5.3 by Aaron Bentley
Push NULL_REVISION deeper
531
        last_rev = _mod_revision.ensure_null(self._last_revision())
2598.5.7 by Aaron Bentley
Updates from review
532
        if _mod_revision.NULL_REVISION == last_rev:
1773.2.1 by Robert Collins
Teach all trees about unknowns, conflicts and get_parent_ids.
533
            parents = []
534
        else:
535
            parents = [last_rev]
1908.6.10 by Robert Collins
forward to get_parent_ids in pending_merges.
536
        try:
3407.2.14 by Martin Pool
Remove more cases of getting transport via control_files
537
            merges_file = self._transport.get('pending-merges')
2206.1.7 by Marius Kruger
* errors
538
        except errors.NoSuchFile:
1908.6.10 by Robert Collins
forward to get_parent_ids in pending_merges.
539
            pass
540
        else:
541
            for l in merges_file.readlines():
2858.2.1 by Martin Pool
Remove most calls to safe_file_id and safe_revision_id.
542
                revision_id = l.rstrip('\n')
2249.5.9 by John Arbash Meinel
Update WorkingTree to use safe_revision_id when appropriate
543
                parents.append(revision_id)
1908.6.10 by Robert Collins
forward to get_parent_ids in pending_merges.
544
        return parents
1773.2.1 by Robert Collins
Teach all trees about unknowns, conflicts and get_parent_ids.
545
1986.5.1 by Robert Collins
(Robert Collins, John Meinel) Change WorkingTree.get_root_id to not trigger read_working_inventory and instead use the one inside the current transaction.
546
    @needs_read_lock
1497 by Robert Collins
Move Branch.read_working_inventory to WorkingTree.
547
    def get_root_id(self):
548
        """Return the id of this trees root"""
1986.5.1 by Robert Collins
(Robert Collins, John Meinel) Change WorkingTree.get_root_id to not trigger read_working_inventory and instead use the one inside the current transaction.
549
        return self._inventory.root.file_id
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
550
453 by Martin Pool
- Split WorkingTree into its own file
551
    def _get_store_filename(self, file_id):
1508.1.1 by Robert Collins
Provide a open_containing for WorkingTree.
552
        ## XXX: badly named; this is not in the store at all
453 by Martin Pool
- Split WorkingTree into its own file
553
        return self.abspath(self.id2path(file_id))
554
1534.4.35 by Robert Collins
Give branch its own basis tree and last_revision methods; deprecated branch.working_tree()
555
    @needs_read_lock
2387.1.1 by Robert Collins
Remove the --basis parameter to clone etc. (Robert Collins)
556
    def clone(self, to_bzrdir, revision_id=None):
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
557
        """Duplicate this working tree into to_bzr, including all state.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
558
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
559
        Specifically modified files are kept as modified, but
560
        ignored and unknown files are discarded.
1534.4.35 by Robert Collins
Give branch its own basis tree and last_revision methods; deprecated branch.working_tree()
561
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
562
        If you want to make a new line of development, see bzrdir.sprout()
1534.4.35 by Robert Collins
Give branch its own basis tree and last_revision methods; deprecated branch.working_tree()
563
564
        revision
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
565
            If not None, the cloned tree will have its last revision set to
4031.3.1 by Frank Aspell
Fixing various typos
566
            revision, and difference between the source trees last revision
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
567
            and this one merged in.
1534.4.35 by Robert Collins
Give branch its own basis tree and last_revision methods; deprecated branch.working_tree()
568
        """
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
569
        # assumes the target bzr dir format is compatible.
3650.5.5 by Aaron Bentley
Make WorkingTree.clone use bzrdir's format
570
        result = to_bzrdir.create_workingtree()
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
571
        self.copy_content_into(result, revision_id)
572
        return result
573
574
    @needs_read_lock
575
    def copy_content_into(self, tree, revision_id=None):
576
        """Copy the current content and user files of this tree into tree."""
1731.1.33 by Aaron Bentley
Revert no-special-root changes
577
        tree.set_root_id(self.get_root_id())
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
578
        if revision_id is None:
1996.3.6 by John Arbash Meinel
Find a few places that weren't importing their dependencies.
579
            merge.transform_tree(tree, self)
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
580
        else:
1908.6.1 by Robert Collins
Change all callers of set_last_revision to use set_parent_trees.
581
            # TODO now merge from tree.last_revision to revision (to preserve
582
            # user local changes)
1996.3.6 by John Arbash Meinel
Find a few places that weren't importing their dependencies.
583
            merge.transform_tree(tree, self)
1908.6.3 by Robert Collins
Tidy up the last_revision_id and add_pending_merge conversion to use cleaner apis.
584
            tree.set_parent_ids([revision_id])
1534.4.35 by Robert Collins
Give branch its own basis tree and last_revision methods; deprecated branch.working_tree()
585
1248 by Martin Pool
- new weave based cleanup [broken]
586
    def id2abspath(self, file_id):
587
        return self.abspath(self.id2path(file_id))
588
1185.12.39 by abentley
Propogated has_or_had_id to Tree
589
    def has_id(self, file_id):
453 by Martin Pool
- Split WorkingTree into its own file
590
        # files that have been deleted are excluded
2255.2.82 by Robert Collins
various notes about find_ids_across_trees
591
        inv = self.inventory
866 by Martin Pool
- use new path-based hashcache for WorkingTree- squash mtime/ctime to whole seconds- update and if necessary write out hashcache when WorkingTree object is created.
592
        if not inv.has_id(file_id):
453 by Martin Pool
- Split WorkingTree into its own file
593
            return False
866 by Martin Pool
- use new path-based hashcache for WorkingTree- squash mtime/ctime to whole seconds- update and if necessary write out hashcache when WorkingTree object is created.
594
        path = inv.id2path(file_id)
1836.1.22 by John Arbash Meinel
[merge] bzr.dev 1861
595
        return osutils.lexists(self.abspath(path))
462 by Martin Pool
- New form 'file_id in tree' to check if the file is present
596
1185.12.39 by abentley
Propogated has_or_had_id to Tree
597
    def has_or_had_id(self, file_id):
598
        if file_id == self.inventory.root.file_id:
599
            return True
600
        return self.inventory.has_id(file_id)
462 by Martin Pool
- New form 'file_id in tree' to check if the file is present
601
602
    __contains__ = has_id
603
453 by Martin Pool
- Split WorkingTree into its own file
604
    def get_file_size(self, file_id):
3363.3.4 by Aaron Bentley
Add get_file_size to Tree interface
605
        """See Tree.get_file_size"""
3363.2.7 by Aaron Bentley
Implement alterntative-to-inventory tests
606
        try:
607
            return os.path.getsize(self.id2abspath(file_id))
608
        except OSError, e:
609
            if e.errno != errno.ENOENT:
610
                raise
611
            else:
612
                return None
453 by Martin Pool
- Split WorkingTree into its own file
613
1185.60.6 by Aaron Bentley
Fixed hashcache
614
    @needs_read_lock
2012.1.7 by Aaron Bentley
Get tree._iter_changed down to ~ 1 stat per file
615
    def get_file_sha1(self, file_id, path=None, stat_value=None):
1732.1.19 by John Arbash Meinel
If you have the path, use it rather than looking it up again
616
        if not path:
617
            path = self._inventory.id2path(file_id)
2012.1.7 by Aaron Bentley
Get tree._iter_changed down to ~ 1 stat per file
618
        return self._hashcache.get_sha1(path, stat_value)
453 by Martin Pool
- Split WorkingTree into its own file
619
1740.2.5 by Aaron Bentley
Merge from bzr.dev
620
    def get_file_mtime(self, file_id, path=None):
621
        if not path:
2255.7.36 by John Arbash Meinel
All trees should implement get_file_mtime()
622
            path = self.inventory.id2path(file_id)
1740.2.5 by Aaron Bentley
Merge from bzr.dev
623
        return os.lstat(self.abspath(path)).st_mtime
624
2911.5.2 by John Arbash Meinel
Ensure that WT3 properly extracts the executable bit from the basis inventory.
625
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
626
        file_id = self.path2id(path)
627
        return self._inventory[file_id].executable
628
629
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
630
        mode = stat_result.st_mode
631
        return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
632
1732.1.19 by John Arbash Meinel
If you have the path, use it rather than looking it up again
633
    if not supports_executable():
634
        def is_executable(self, file_id, path=None):
1398 by Robert Collins
integrate in Gustavos x-bit patch
635
            return self._inventory[file_id].executable
2911.5.2 by John Arbash Meinel
Ensure that WT3 properly extracts the executable bit from the basis inventory.
636
637
        _is_executable_from_path_and_stat = \
2911.5.4 by John Arbash Meinel
Switch around to properly look up the executable bit in the basis.
638
            _is_executable_from_path_and_stat_from_basis
1732.1.19 by John Arbash Meinel
If you have the path, use it rather than looking it up again
639
    else:
640
        def is_executable(self, file_id, path=None):
641
            if not path:
2255.2.15 by Robert Collins
Dirstate - truncate state file fixing bug in saving a smaller file, get more tree_implementation tests passing.
642
                path = self.id2path(file_id)
1398 by Robert Collins
integrate in Gustavos x-bit patch
643
            mode = os.lstat(self.abspath(path)).st_mode
1733.1.4 by Robert Collins
Cosmetic niceties for debugging, extra comments etc.
644
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1398 by Robert Collins
integrate in Gustavos x-bit patch
645
2911.5.2 by John Arbash Meinel
Ensure that WT3 properly extracts the executable bit from the basis inventory.
646
        _is_executable_from_path_and_stat = \
2911.5.4 by John Arbash Meinel
Switch around to properly look up the executable bit in the basis.
647
            _is_executable_from_path_and_stat_from_stat
2911.5.2 by John Arbash Meinel
Ensure that WT3 properly extracts the executable bit from the basis inventory.
648
2255.2.168 by Martin Pool
merge robert, debugging
649
    @needs_tree_write_lock
1986.1.2 by Robert Collins
Various changes to allow non-workingtree specific tests to run entirely
650
    def _add(self, files, ids, kinds):
651
        """See MutableTree._add."""
1508.1.5 by Robert Collins
Move add from Branch to WorkingTree.
652
        # TODO: Re-adding a file that is removed in the working copy
653
        # should probably put it back with the previous ID.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
654
        # the read and write working inventory should not occur in this
1986.1.2 by Robert Collins
Various changes to allow non-workingtree specific tests to run entirely
655
        # function - they should be part of lock_write and unlock.
2568.2.3 by Robert Collins
Fix WorkingTree(3).add to not reset the entire inventory but modify the existing one.
656
        inv = self.inventory
1986.1.2 by Robert Collins
Various changes to allow non-workingtree specific tests to run entirely
657
        for f, file_id, kind in zip(files, ids, kinds):
1508.1.5 by Robert Collins
Move add from Branch to WorkingTree.
658
            if file_id is None:
1713.1.6 by Robert Collins
Move file id random data selection out of the inner loop for 'bzr add'.
659
                inv.add_path(f, kind=kind)
660
            else:
661
                inv.add_path(f, kind=kind, file_id=file_id)
2568.2.3 by Robert Collins
Fix WorkingTree(3).add to not reset the entire inventory but modify the existing one.
662
            self._inventory_is_modified = True
1508.1.5 by Robert Collins
Move add from Branch to WorkingTree.
663
1997.1.3 by Robert Collins
All WorkingTree methods which write to the tree, but not to the branch
664
    @needs_tree_write_lock
1986.1.2 by Robert Collins
Various changes to allow non-workingtree specific tests to run entirely
665
    def _gather_kinds(self, files, kinds):
666
        """See MutableTree._gather_kinds."""
667
        for pos, f in enumerate(files):
668
            if kinds[pos] is None:
669
                fullpath = normpath(self.abspath(f))
670
                try:
671
                    kinds[pos] = file_kind(fullpath)
672
                except OSError, e:
673
                    if e.errno == errno.ENOENT:
2206.1.7 by Marius Kruger
* errors
674
                        raise errors.NoSuchFile(fullpath)
1986.1.2 by Robert Collins
Various changes to allow non-workingtree specific tests to run entirely
675
1508.1.5 by Robert Collins
Move add from Branch to WorkingTree.
676
    @needs_write_lock
1908.5.9 by Robert Collins
Add a guard against setting the tree last-revision value to a ghost in the new tree parent management api.
677
    def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
1908.5.4 by Robert Collins
Add add_parent_tree_id WorkingTree helper api.
678
        """Add revision_id as a parent.
679
680
        This is equivalent to retrieving the current list of parent ids
681
        and setting the list to its value plus revision_id.
682
683
        :param revision_id: The revision id to add to the parent list. It may
1908.5.12 by Robert Collins
Apply review feedback - paired with Martin.
684
        be a ghost revision as long as its not the first parent to be added,
685
        or the allow_leftmost_as_ghost parameter is set True.
686
        :param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
1908.5.4 by Robert Collins
Add add_parent_tree_id WorkingTree helper api.
687
        """
1908.5.13 by Robert Collins
Adding a parent when the first is a ghost already should not require forcing it.
688
        parents = self.get_parent_ids() + [revision_id]
2220.1.9 by Marius Kruger
Remove all trailing white space this bundle would have
689
        self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
2206.1.7 by Marius Kruger
* errors
690
            or allow_leftmost_as_ghost)
1908.5.4 by Robert Collins
Add add_parent_tree_id WorkingTree helper api.
691
1997.1.3 by Robert Collins
All WorkingTree methods which write to the tree, but not to the branch
692
    @needs_tree_write_lock
1908.5.9 by Robert Collins
Add a guard against setting the tree last-revision value to a ghost in the new tree parent management api.
693
    def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
1908.5.6 by Robert Collins
Add add_parent_tree to WorkingTree.
694
        """Add revision_id, tree tuple as a parent.
695
696
        This is equivalent to retrieving the current list of parent trees
697
        and setting the list to its value plus parent_tuple. See also
698
        add_parent_tree_id - if you only have a parent id available it will be
699
        simpler to use that api. If you have the parent already available, using
700
        this api is preferred.
701
1908.5.12 by Robert Collins
Apply review feedback - paired with Martin.
702
        :param parent_tuple: The (revision id, tree) to add to the parent list.
703
            If the revision_id is a ghost, pass None for the tree.
704
        :param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
1908.5.6 by Robert Collins
Add add_parent_tree to WorkingTree.
705
        """
1979.2.1 by Robert Collins
(robertc) adds a convenience method "merge_from_branch" to WorkingTree.
706
        parent_ids = self.get_parent_ids() + [parent_tuple[0]]
707
        if len(parent_ids) > 1:
708
            # the leftmost may have already been a ghost, preserve that if it
709
            # was.
710
            allow_leftmost_as_ghost = True
711
        self.set_parent_ids(parent_ids,
1908.5.9 by Robert Collins
Add a guard against setting the tree last-revision value to a ghost in the new tree parent management api.
712
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1908.5.6 by Robert Collins
Add add_parent_tree to WorkingTree.
713
1997.1.3 by Robert Collins
All WorkingTree methods which write to the tree, but not to the branch
714
    @needs_tree_write_lock
1457.1.15 by Robert Collins
Move add_pending_merge to WorkingTree.
715
    def add_pending_merge(self, *revision_ids):
716
        # TODO: Perhaps should check at this point that the
717
        # history of the revision is actually present?
1908.6.7 by Robert Collins
Remove all users of set_pending_merges and add_pending_merge except tests that they work correctly.
718
        parents = self.get_parent_ids()
1457.1.15 by Robert Collins
Move add_pending_merge to WorkingTree.
719
        updated = False
720
        for rev_id in revision_ids:
1908.6.7 by Robert Collins
Remove all users of set_pending_merges and add_pending_merge except tests that they work correctly.
721
            if rev_id in parents:
722
                continue
723
            parents.append(rev_id)
1457.1.15 by Robert Collins
Move add_pending_merge to WorkingTree.
724
            updated = True
725
        if updated:
1908.6.7 by Robert Collins
Remove all users of set_pending_merges and add_pending_merge except tests that they work correctly.
726
            self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
1457.1.15 by Robert Collins
Move add_pending_merge to WorkingTree.
727
2949.6.2 by Alexander Belchenko
more changes osutils.lstat -> os.lstat
728
    def path_content_summary(self, path, _lstat=os.lstat,
2776.1.7 by Robert Collins
* New method on ``bzrlib.tree.Tree`` ``path_content_summary`` provides a
729
        _mapper=osutils.file_kind_from_stat_mode):
730
        """See Tree.path_content_summary."""
731
        abspath = self.abspath(path)
732
        try:
733
            stat_result = _lstat(abspath)
734
        except OSError, e:
735
            if getattr(e, 'errno', None) == errno.ENOENT:
736
                # no file.
737
                return ('missing', None, None, None)
2776.1.9 by Robert Collins
Review feedback.
738
            # propagate other errors
2776.1.7 by Robert Collins
* New method on ``bzrlib.tree.Tree`` ``path_content_summary`` provides a
739
            raise
740
        kind = _mapper(stat_result.st_mode)
741
        if kind == 'file':
742
            size = stat_result.st_size
743
            # try for a stat cache lookup
2911.5.2 by John Arbash Meinel
Ensure that WT3 properly extracts the executable bit from the basis inventory.
744
            executable = self._is_executable_from_path_and_stat(path, stat_result)
2776.1.8 by Robert Collins
Retrieve the sha from the dirstate for path_content_summary on hash cache hits; slight performance hit but a big win for incremental commits.
745
            return (kind, size, executable, self._sha_from_stat(
746
                path, stat_result))
2776.1.7 by Robert Collins
* New method on ``bzrlib.tree.Tree`` ``path_content_summary`` provides a
747
        elif kind == 'directory':
748
            # perhaps it looks like a plain directory, but it's really a
749
            # reference.
750
            if self._directory_is_tree_reference(path):
751
                kind = 'tree-reference'
752
            return kind, None, None, None
753
        elif kind == 'symlink':
4241.14.18 by Vincent Ladeuil
Use better fixes for unicode symlinks handling in WTs.
754
            target = osutils.readlink(abspath)
4241.14.12 by Vincent Ladeuil
Far too many modifications for a single commit, need to restart.
755
            return ('symlink', None, None, target)
2776.1.7 by Robert Collins
* New method on ``bzrlib.tree.Tree`` ``path_content_summary`` provides a
756
        else:
757
            return (kind, None, None, None)
758
2041.1.2 by John Arbash Meinel
Update WorkingTree.set_parent_trees() to directly cache inv.
759
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
760
        """Common ghost checking functionality from set_parent_*.
761
762
        This checks that the left hand-parent exists if there are any
763
        revisions present.
764
        """
765
        if len(revision_ids) > 0:
766
            leftmost_id = revision_ids[0]
767
            if (not allow_leftmost_as_ghost and not
768
                self.branch.repository.has_revision(leftmost_id)):
769
                raise errors.GhostRevisionUnusableHere(leftmost_id)
770
771
    def _set_merges_from_parent_ids(self, parent_ids):
772
        merges = parent_ids[1:]
3407.2.7 by Martin Pool
Deprecate LockableFiles.put_utf8 and put_bytes.
773
        self._transport.put_bytes('pending-merges', '\n'.join(merges),
3407.2.18 by Martin Pool
BzrDir takes responsibility for default file/dir modes
774
            mode=self.bzrdir._get_file_mode())
2041.1.2 by John Arbash Meinel
Update WorkingTree.set_parent_trees() to directly cache inv.
775
3462.1.2 by John Arbash Meinel
Change WT.set_parent_(ids/trees) to filter out ancestors.
776
    def _filter_parent_ids_by_ancestry(self, revision_ids):
777
        """Check that all merged revisions are proper 'heads'.
778
779
        This will always return the first revision_id, and any merged revisions
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
780
        which are
3462.1.2 by John Arbash Meinel
Change WT.set_parent_(ids/trees) to filter out ancestors.
781
        """
782
        if len(revision_ids) == 0:
783
            return revision_ids
784
        graph = self.branch.repository.get_graph()
785
        heads = graph.heads(revision_ids)
786
        new_revision_ids = revision_ids[:1]
787
        for revision_id in revision_ids[1:]:
788
            if revision_id in heads and revision_id not in new_revision_ids:
789
                new_revision_ids.append(revision_id)
790
        if new_revision_ids != revision_ids:
791
            trace.mutter('requested to set revision_ids = %s,'
792
                         ' but filtered to %s', revision_ids, new_revision_ids)
793
        return new_revision_ids
794
1997.1.3 by Robert Collins
All WorkingTree methods which write to the tree, but not to the branch
795
    @needs_tree_write_lock
1908.5.9 by Robert Collins
Add a guard against setting the tree last-revision value to a ghost in the new tree parent management api.
796
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
1908.5.5 by Robert Collins
Add WorkingTree.set_parent_ids.
797
        """Set the parent ids to revision_ids.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
798
1908.5.5 by Robert Collins
Add WorkingTree.set_parent_ids.
799
        See also set_parent_trees. This api will try to retrieve the tree data
800
        for each element of revision_ids from the trees repository. If you have
801
        tree data already available, it is more efficient to use
802
        set_parent_trees rather than set_parent_ids. set_parent_ids is however
803
        an easier API to use.
804
805
        :param revision_ids: The revision_ids to set as the parent ids of this
806
            working tree. Any of these may be ghosts.
807
        """
2041.1.2 by John Arbash Meinel
Update WorkingTree.set_parent_trees() to directly cache inv.
808
        self._check_parents_for_ghosts(revision_ids,
809
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
2598.5.2 by Aaron Bentley
Got all tests passing with Branch returning 'null:' for null revision
810
        for revision_id in revision_ids:
811
            _mod_revision.check_not_reserved_id(revision_id)
2041.1.2 by John Arbash Meinel
Update WorkingTree.set_parent_trees() to directly cache inv.
812
3462.1.2 by John Arbash Meinel
Change WT.set_parent_(ids/trees) to filter out ancestors.
813
        revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
814
1908.6.7 by Robert Collins
Remove all users of set_pending_merges and add_pending_merge except tests that they work correctly.
815
        if len(revision_ids) > 0:
2041.1.2 by John Arbash Meinel
Update WorkingTree.set_parent_trees() to directly cache inv.
816
            self.set_last_revision(revision_ids[0])
1908.6.7 by Robert Collins
Remove all users of set_pending_merges and add_pending_merge except tests that they work correctly.
817
        else:
2598.5.3 by Aaron Bentley
Push NULL_REVISION deeper
818
            self.set_last_revision(_mod_revision.NULL_REVISION)
2041.1.2 by John Arbash Meinel
Update WorkingTree.set_parent_trees() to directly cache inv.
819
820
        self._set_merges_from_parent_ids(revision_ids)
1908.5.5 by Robert Collins
Add WorkingTree.set_parent_ids.
821
1997.1.3 by Robert Collins
All WorkingTree methods which write to the tree, but not to the branch
822
    @needs_tree_write_lock
1908.5.9 by Robert Collins
Add a guard against setting the tree last-revision value to a ghost in the new tree parent management api.
823
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1986.1.2 by Robert Collins
Various changes to allow non-workingtree specific tests to run entirely
824
        """See MutableTree.set_parent_trees."""
2858.2.1 by Martin Pool
Remove most calls to safe_file_id and safe_revision_id.
825
        parent_ids = [rev for (rev, tree) in parents_list]
2598.5.2 by Aaron Bentley
Got all tests passing with Branch returning 'null:' for null revision
826
        for revision_id in parent_ids:
827
            _mod_revision.check_not_reserved_id(revision_id)
2041.1.2 by John Arbash Meinel
Update WorkingTree.set_parent_trees() to directly cache inv.
828
829
        self._check_parents_for_ghosts(parent_ids,
1908.6.7 by Robert Collins
Remove all users of set_pending_merges and add_pending_merge except tests that they work correctly.
830
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
1908.5.2 by Robert Collins
Create and test set_parent_trees.
831
3462.1.2 by John Arbash Meinel
Change WT.set_parent_(ids/trees) to filter out ancestors.
832
        parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
833
2041.1.2 by John Arbash Meinel
Update WorkingTree.set_parent_trees() to directly cache inv.
834
        if len(parent_ids) == 0:
2598.5.3 by Aaron Bentley
Push NULL_REVISION deeper
835
            leftmost_parent_id = _mod_revision.NULL_REVISION
2041.1.3 by John Arbash Meinel
Call _cache_basis_inventory directly rather than set_last_revision
836
            leftmost_parent_tree = None
2041.1.2 by John Arbash Meinel
Update WorkingTree.set_parent_trees() to directly cache inv.
837
        else:
838
            leftmost_parent_id, leftmost_parent_tree = parents_list[0]
839
2041.1.3 by John Arbash Meinel
Call _cache_basis_inventory directly rather than set_last_revision
840
        if self._change_last_revision(leftmost_parent_id):
841
            if leftmost_parent_tree is None:
2041.1.4 by John Arbash Meinel
NEWS and documentation
842
                # If we don't have a tree, fall back to reading the
843
                # parent tree from the repository.
2041.1.3 by John Arbash Meinel
Call _cache_basis_inventory directly rather than set_last_revision
844
                self._cache_basis_inventory(leftmost_parent_id)
845
            else:
2041.1.2 by John Arbash Meinel
Update WorkingTree.set_parent_trees() to directly cache inv.
846
                inv = leftmost_parent_tree.inventory
847
                xml = self._create_basis_xml_from_inventory(
848
                                        leftmost_parent_id, inv)
849
                self._write_basis_inventory(xml)
850
        self._set_merges_from_parent_ids(parent_ids)
851
1997.1.3 by Robert Collins
All WorkingTree methods which write to the tree, but not to the branch
852
    @needs_tree_write_lock
1457.1.16 by Robert Collins
Move set_pending_merges to WorkingTree.
853
    def set_pending_merges(self, rev_list):
1908.6.7 by Robert Collins
Remove all users of set_pending_merges and add_pending_merge except tests that they work correctly.
854
        parents = self.get_parent_ids()
855
        leftmost = parents[:1]
856
        new_parents = leftmost + rev_list
857
        self.set_parent_ids(new_parents)
1457.1.16 by Robert Collins
Move set_pending_merges to WorkingTree.
858
1997.1.3 by Robert Collins
All WorkingTree methods which write to the tree, but not to the branch
859
    @needs_tree_write_lock
1534.7.192 by Aaron Bentley
Record hashes produced by merges
860
    def set_merge_modified(self, modified_hashes):
1534.10.3 by Aaron Bentley
Simplify set_merge_modified with rio_file
861
        def iter_stanzas():
862
            for file_id, hash in modified_hashes.iteritems():
2294.1.10 by John Arbash Meinel
Switch all apis over to utf8 file ids. All tests pass
863
                yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
1534.10.3 by Aaron Bentley
Simplify set_merge_modified with rio_file
864
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
865
2776.1.8 by Robert Collins
Retrieve the sha from the dirstate for path_content_summary on hash cache hits; slight performance hit but a big win for incremental commits.
866
    def _sha_from_stat(self, path, stat_result):
867
        """Get a sha digest from the tree's stat cache.
868
869
        The default implementation assumes no stat cache is present.
870
871
        :param path: The path.
872
        :param stat_result: The stat result being looked up.
873
        """
874
        return None
875
1534.10.3 by Aaron Bentley
Simplify set_merge_modified with rio_file
876
    def _put_rio(self, filename, stanzas, header):
2298.1.1 by Martin Pool
Add test for merge_modified
877
        self._must_be_locked()
1534.10.3 by Aaron Bentley
Simplify set_merge_modified with rio_file
878
        my_file = rio_file(stanzas, header)
3407.2.7 by Martin Pool
Deprecate LockableFiles.put_utf8 and put_bytes.
879
        self._transport.put_file(filename, my_file,
3407.2.18 by Martin Pool
BzrDir takes responsibility for default file/dir modes
880
            mode=self.bzrdir._get_file_mode())
1534.7.192 by Aaron Bentley
Record hashes produced by merges
881
1997.1.3 by Robert Collins
All WorkingTree methods which write to the tree, but not to the branch
882
    @needs_write_lock # because merge pulls data into the branch.
1551.15.69 by Aaron Bentley
Add merge_type to merge_from_branch
883
    def merge_from_branch(self, branch, to_revision=None, from_revision=None,
884
        merge_type=None):
1979.2.1 by Robert Collins
(robertc) adds a convenience method "merge_from_branch" to WorkingTree.
885
        """Merge from a branch into this working tree.
886
887
        :param branch: The branch to merge from.
2220.1.9 by Marius Kruger
Remove all trailing white space this bundle would have
888
        :param to_revision: If non-None, the merge will merge to to_revision,
889
            but not beyond it. to_revision does not need to be in the history
2206.1.7 by Marius Kruger
* errors
890
            of the branch when it is supplied. If None, to_revision defaults to
1979.2.1 by Robert Collins
(robertc) adds a convenience method "merge_from_branch" to WorkingTree.
891
            branch.last_revision().
892
        """
893
        from bzrlib.merge import Merger, Merge3Merger
4496.3.4 by Andrew Bennetts
Tidy up unused and redundant imports in workingtree.py.
894
        pb = ui.ui_factory.nested_progress_bar()
1979.2.1 by Robert Collins
(robertc) adds a convenience method "merge_from_branch" to WorkingTree.
895
        try:
896
            merger = Merger(self.branch, this_tree=self, pb=pb)
897
            merger.pp = ProgressPhase("Merge phase", 5, pb)
898
            merger.pp.next_phase()
899
            # check that there are no
900
            # local alterations
901
            merger.check_basis(check_clean=True, require_commits=False)
902
            if to_revision is None:
2598.5.4 by Aaron Bentley
Restore original Branch.last_revision behavior, fix bits that care
903
                to_revision = _mod_revision.ensure_null(branch.last_revision())
1979.2.1 by Robert Collins
(robertc) adds a convenience method "merge_from_branch" to WorkingTree.
904
            merger.other_rev_id = to_revision
2598.5.2 by Aaron Bentley
Got all tests passing with Branch returning 'null:' for null revision
905
            if _mod_revision.is_null(merger.other_rev_id):
2490.2.28 by Aaron Bentley
Fix handling of null revision
906
                raise errors.NoCommits(branch)
1979.2.1 by Robert Collins
(robertc) adds a convenience method "merge_from_branch" to WorkingTree.
907
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
908
            merger.other_basis = merger.other_rev_id
909
            merger.other_tree = self.branch.repository.revision_tree(
910
                merger.other_rev_id)
2100.3.29 by Aaron Bentley
Get merge working initially
911
            merger.other_branch = branch
1979.2.1 by Robert Collins
(robertc) adds a convenience method "merge_from_branch" to WorkingTree.
912
            merger.pp.next_phase()
1551.15.68 by Aaron Bentley
Add support for base to merge_from_branch
913
            if from_revision is None:
914
                merger.find_base()
915
            else:
916
                merger.set_base_revision(from_revision, branch)
1979.2.1 by Robert Collins
(robertc) adds a convenience method "merge_from_branch" to WorkingTree.
917
            if merger.base_rev_id == merger.other_rev_id:
918
                raise errors.PointlessMerge
919
            merger.backup_files = False
1551.15.69 by Aaron Bentley
Add merge_type to merge_from_branch
920
            if merge_type is None:
921
                merger.merge_type = Merge3Merger
922
            else:
923
                merger.merge_type = merge_type
1979.2.1 by Robert Collins
(robertc) adds a convenience method "merge_from_branch" to WorkingTree.
924
            merger.set_interesting_files(None)
925
            merger.show_base = False
926
            merger.reprocess = False
927
            conflicts = merger.do_merge()
928
            merger.set_pending()
929
        finally:
930
            pb.finished()
931
        return conflicts
932
2255.2.156 by Martin Pool
Merge WorkingTree implementation back from trunk
933
    @needs_read_lock
934
    def merge_modified(self):
2298.1.1 by Martin Pool
Add test for merge_modified
935
        """Return a dictionary of files modified by a merge.
936
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
937
        The list is initialized by WorkingTree.set_merge_modified, which is
2298.1.1 by Martin Pool
Add test for merge_modified
938
        typically called after we make some automatic updates to the tree
939
        because of a merge.
940
941
        This returns a map of file_id->sha1, containing only files which are
942
        still in the working inventory and have that text hash.
943
        """
2255.2.156 by Martin Pool
Merge WorkingTree implementation back from trunk
944
        try:
3407.2.14 by Martin Pool
Remove more cases of getting transport via control_files
945
            hashfile = self._transport.get('merge-hashes')
2255.2.156 by Martin Pool
Merge WorkingTree implementation back from trunk
946
        except errors.NoSuchFile:
947
            return {}
948
        try:
3619.6.5 by Mark Hammond
ensure merge_modified() closes the hash file.
949
            merge_hashes = {}
950
            try:
951
                if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
952
                    raise errors.MergeModifiedFormatError()
953
            except StopIteration:
2255.2.156 by Martin Pool
Merge WorkingTree implementation back from trunk
954
                raise errors.MergeModifiedFormatError()
3619.6.5 by Mark Hammond
ensure merge_modified() closes the hash file.
955
            for s in RioReader(hashfile):
956
                # RioReader reads in Unicode, so convert file_ids back to utf8
957
                file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
958
                if file_id not in self.inventory:
959
                    continue
960
                text_hash = s.get("hash")
961
                if text_hash == self.get_file_sha1(file_id):
962
                    merge_hashes[file_id] = text_hash
963
            return merge_hashes
964
        finally:
965
            hashfile.close()
2255.2.156 by Martin Pool
Merge WorkingTree implementation back from trunk
966
967
    @needs_write_lock
968
    def mkdir(self, path, file_id=None):
969
        """See MutableTree.mkdir()."""
970
        if file_id is None:
971
            file_id = generate_ids.gen_file_id(os.path.basename(path))
972
        os.mkdir(self.abspath(path))
973
        self.add(path, file_id, 'directory')
974
        return file_id
975
976
    def get_symlink_target(self, file_id):
4241.14.12 by Vincent Ladeuil
Far too many modifications for a single commit, need to restart.
977
        abspath = self.id2abspath(file_id)
4241.14.18 by Vincent Ladeuil
Use better fixes for unicode symlinks handling in WTs.
978
        target = osutils.readlink(abspath)
4241.14.12 by Vincent Ladeuil
Far too many modifications for a single commit, need to restart.
979
        return target
2255.2.156 by Martin Pool
Merge WorkingTree implementation back from trunk
980
1731.2.1 by Aaron Bentley
Initial subsume implementation
981
    @needs_write_lock
982
    def subsume(self, other_tree):
1731.2.4 by Aaron Bentley
Ensure subsume works with Knit2 repos
983
        def add_children(inventory, entry):
984
            for child_entry in entry.children.values():
985
                inventory._byid[child_entry.file_id] = child_entry
986
                if child_entry.kind == 'directory':
987
                    add_children(inventory, child_entry)
1731.2.2 by Aaron Bentley
Test subsume failure modes
988
        if other_tree.get_root_id() == self.get_root_id():
2255.2.194 by Robert Collins
[BROKEN] Many updates to stop using experimental formats in tests.
989
            raise errors.BadSubsumeSource(self, other_tree,
1731.2.2 by Aaron Bentley
Test subsume failure modes
990
                                          'Trees have the same root')
991
        try:
992
            other_tree_path = self.relpath(other_tree.basedir)
993
        except errors.PathNotChild:
2255.2.194 by Robert Collins
[BROKEN] Many updates to stop using experimental formats in tests.
994
            raise errors.BadSubsumeSource(self, other_tree,
1731.2.2 by Aaron Bentley
Test subsume failure modes
995
                'Tree is not contained by the other')
1731.2.4 by Aaron Bentley
Ensure subsume works with Knit2 repos
996
        new_root_parent = self.path2id(osutils.dirname(other_tree_path))
997
        if new_root_parent is None:
2255.2.194 by Robert Collins
[BROKEN] Many updates to stop using experimental formats in tests.
998
            raise errors.BadSubsumeSource(self, other_tree,
1731.2.3 by Aaron Bentley
Handle unversioned parents during subsume
999
                'Parent directory is not versioned.')
1731.2.5 by Aaron Bentley
Ensure versionedfile will be produced for subsumed tree root
1000
        # We need to ensure that the result of a fetch will have a
1001
        # versionedfile for the other_tree root, and only fetching into
1002
        # RepositoryKnit2 guarantees that.
1731.2.10 by Aaron Bentley
Change test for rich root data
1003
        if not self.branch.repository.supports_rich_root():
1731.2.5 by Aaron Bentley
Ensure versionedfile will be produced for subsumed tree root
1004
            raise errors.SubsumeTargetNeedsUpgrade(other_tree)
1731.2.4 by Aaron Bentley
Ensure subsume works with Knit2 repos
1005
        other_tree.lock_tree_write()
1006
        try:
2255.2.194 by Robert Collins
[BROKEN] Many updates to stop using experimental formats in tests.
1007
            new_parents = other_tree.get_parent_ids()
1731.2.4 by Aaron Bentley
Ensure subsume works with Knit2 repos
1008
            other_root = other_tree.inventory.root
1009
            other_root.parent_id = new_root_parent
1010
            other_root.name = osutils.basename(other_tree_path)
1011
            self.inventory.add(other_root)
1012
            add_children(self.inventory, other_root)
1013
            self._write_inventory(self.inventory)
2255.14.1 by Martin Pool
Add BzrDir.retire_bzrdir and partly fix subsume
1014
            # normally we don't want to fetch whole repositories, but i think
1015
            # here we really do want to consolidate the whole thing.
2255.2.194 by Robert Collins
[BROKEN] Many updates to stop using experimental formats in tests.
1016
            for parent_id in other_tree.get_parent_ids():
1017
                self.branch.fetch(other_tree.branch, parent_id)
1018
                self.add_parent_tree_id(parent_id)
1731.2.4 by Aaron Bentley
Ensure subsume works with Knit2 repos
1019
        finally:
1020
            other_tree.unlock()
2255.2.214 by Robert Collins
Get _iter_changes on dirstate passing the subtree tests.
1021
        other_tree.bzrdir.retire_bzrdir()
1731.2.1 by Aaron Bentley
Initial subsume implementation
1022
2974.2.2 by John Arbash Meinel
Only one test failed, because it was incorrectly succeeding.
1023
    def _setup_directory_is_tree_reference(self):
1024
        if self._branch.repository._format.supports_tree_reference:
1025
            self._directory_is_tree_reference = \
1026
                self._directory_may_be_tree_reference
1027
        else:
1028
            self._directory_is_tree_reference = \
1029
                self._directory_is_never_tree_reference
1030
1031
    def _directory_is_never_tree_reference(self, relpath):
1032
        return False
1033
1034
    def _directory_may_be_tree_reference(self, relpath):
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1035
        # as a special case, if a directory contains control files then
2776.1.7 by Robert Collins
* New method on ``bzrlib.tree.Tree`` ``path_content_summary`` provides a
1036
        # it's a tree reference, except that the root of the tree is not
1037
        return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1038
        # TODO: We could ask all the control formats whether they
1039
        # recognize this directory, but at the moment there's no cheap api
1040
        # to do that.  Since we probably can only nest bzr checkouts and
1041
        # they always use this name it's ok for now.  -- mbp 20060306
1042
        #
1043
        # FIXME: There is an unhandled case here of a subdirectory
1044
        # containing .bzr but not a branch; that will probably blow up
1045
        # when you try to commit it.  It might happen if there is a
1046
        # checkout in a subdirectory.  This can be avoided by not adding
1047
        # it.  mbp 20070306
1048
1731.2.16 by Aaron Bentley
Get extract working for standalone trees
1049
    @needs_tree_write_lock
1731.2.17 by Aaron Bentley
Support extracting with checkouts
1050
    def extract(self, file_id, format=None):
1731.2.16 by Aaron Bentley
Get extract working for standalone trees
1051
        """Extract a subtree from this tree.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1052
1731.2.16 by Aaron Bentley
Get extract working for standalone trees
1053
        A new branch will be created, relative to the path for this tree.
1054
        """
1551.10.26 by Aaron Bentley
Allow extract when tree is locked
1055
        self.flush()
1731.2.17 by Aaron Bentley
Support extracting with checkouts
1056
        def mkdirs(path):
1057
            segments = osutils.splitpath(path)
1058
            transport = self.branch.bzrdir.root_transport
1059
            for name in segments:
1060
                transport = transport.clone(name)
2475.3.3 by John Arbash Meinel
Change calls to try/mkdir('.')/except FileExists to ensure_base()
1061
                transport.ensure_base()
1731.2.17 by Aaron Bentley
Support extracting with checkouts
1062
            return transport
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1063
1731.2.16 by Aaron Bentley
Get extract working for standalone trees
1064
        sub_path = self.id2path(file_id)
1731.2.17 by Aaron Bentley
Support extracting with checkouts
1065
        branch_transport = mkdirs(sub_path)
1066
        if format is None:
3113.6.1 by Aaron Bentley
Use source format where available for splitting
1067
            format = self.bzrdir.cloning_metadir()
2475.3.3 by John Arbash Meinel
Change calls to try/mkdir('.')/except FileExists to ensure_base()
1068
        branch_transport.ensure_base()
1731.2.16 by Aaron Bentley
Get extract working for standalone trees
1069
        branch_bzrdir = format.initialize_on_transport(branch_transport)
1070
        try:
1071
            repo = branch_bzrdir.find_repository()
1072
        except errors.NoRepositoryPresent:
1073
            repo = branch_bzrdir.create_repository()
3113.6.4 by Aaron Bentley
Require the user to upgrade if they run split in a non-rich-root tree.
1074
        if not repo.supports_rich_root():
1075
            raise errors.RootNotRich()
1731.2.16 by Aaron Bentley
Get extract working for standalone trees
1076
        new_branch = branch_bzrdir.create_branch()
1731.2.21 by Aaron Bentley
Ensure extracting a subtree dupes the branch
1077
        new_branch.pull(self.branch)
1731.2.16 by Aaron Bentley
Get extract working for standalone trees
1078
        for parent_id in self.get_parent_ids():
1079
            new_branch.fetch(self.branch, parent_id)
1080
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
1081
        if tree_transport.base != branch_transport.base:
1082
            tree_bzrdir = format.initialize_on_transport(tree_transport)
1731.2.17 by Aaron Bentley
Support extracting with checkouts
1083
            branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1731.2.16 by Aaron Bentley
Get extract working for standalone trees
1084
        else:
1085
            tree_bzrdir = branch_bzrdir
4496.3.4 by Andrew Bennetts
Tidy up unused and redundant imports in workingtree.py.
1086
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1731.2.16 by Aaron Bentley
Get extract working for standalone trees
1087
        wt.set_parent_ids(self.get_parent_ids())
1088
        my_inv = self.inventory
4496.3.4 by Andrew Bennetts
Tidy up unused and redundant imports in workingtree.py.
1089
        child_inv = inventory.Inventory(root_id=None)
1731.2.16 by Aaron Bentley
Get extract working for standalone trees
1090
        new_root = my_inv[file_id]
1091
        my_inv.remove_recursive_id(file_id)
1092
        new_root.parent_id = None
1093
        child_inv.add(new_root)
1094
        self._write_inventory(my_inv)
1095
        wt._write_inventory(child_inv)
1096
        return wt
1097
2255.2.152 by Martin Pool
(broken) merge aaron's workingtree format changes
1098
    def _serialize(self, inventory, out_file):
2817.2.1 by Robert Collins
* Inventory serialisation no longer double-sha's the content.
1099
        xml5.serializer_v5.write_inventory(self._inventory, out_file,
1100
            working=True)
2255.2.152 by Martin Pool
(broken) merge aaron's workingtree format changes
1101
1102
    def _deserialize(selt, in_file):
1103
        return xml5.serializer_v5.read_inventory(in_file)
453 by Martin Pool
- Split WorkingTree into its own file
1104
1986.5.3 by Robert Collins
New method ``WorkingTree.flush()`` which will write the current memory
1105
    def flush(self):
1106
        """Write the in memory inventory to disk."""
1107
        # TODO: Maybe this should only write on dirty ?
1108
        if self._control_files._lock_mode != 'w':
1109
            raise errors.NotWriteLocked(self)
1110
        sio = StringIO()
2100.3.10 by Aaron Bentley
Ensure added references are serialized properly, beef up Workingtreee3
1111
        self._serialize(self._inventory, sio)
1986.5.3 by Robert Collins
New method ``WorkingTree.flush()`` which will write the current memory
1112
        sio.seek(0)
3407.2.7 by Martin Pool
Deprecate LockableFiles.put_utf8 and put_bytes.
1113
        self._transport.put_file('inventory', sio,
3407.2.18 by Martin Pool
BzrDir takes responsibility for default file/dir modes
1114
            mode=self.bzrdir._get_file_mode())
1986.5.3 by Robert Collins
New method ``WorkingTree.flush()`` which will write the current memory
1115
        self._inventory_is_modified = False
1116
1551.10.29 by Aaron Bentley
Fix tree.list_files when file kind changes
1117
    def _kind(self, relpath):
1118
        return osutils.file_kind(self.abspath(relpath))
1119
4370.5.2 by Ian Clatworthy
extend list_files() with from_dir and recursive parameters
1120
    def list_files(self, include_root=False, from_dir=None, recursive=True):
1121
        """List all files as (path, class, kind, id, entry).
453 by Martin Pool
- Split WorkingTree into its own file
1122
1123
        Lists, but does not descend into unversioned directories.
1124
        This does not include files that have been deleted in this
4370.5.2 by Ian Clatworthy
extend list_files() with from_dir and recursive parameters
1125
        tree. Skips the control directory.
453 by Martin Pool
- Split WorkingTree into its own file
1126
4370.5.2 by Ian Clatworthy
extend list_files() with from_dir and recursive parameters
1127
        :param include_root: if True, do not return an entry for the root
1128
        :param from_dir: start from this directory or None for the root
1129
        :param recursive: whether to recurse into subdirectories or not
453 by Martin Pool
- Split WorkingTree into its own file
1130
        """
2255.2.60 by John Arbash Meinel
Add an explicit exception since tree.list_files() requires a lock (at least for dirstate
1131
        # list_files is an iterator, so @needs_read_lock doesn't work properly
1132
        # with it. So callers should be careful to always read_lock the tree.
1133
        if not self.is_locked():
1134
            raise errors.ObjectNotLocked(self)
1135
2255.2.52 by Robert Collins
Dirstate - fix workingtree.list_files to use the public interface to access the trees inventory.
1136
        inv = self.inventory
4370.5.2 by Ian Clatworthy
extend list_files() with from_dir and recursive parameters
1137
        if from_dir is None and include_root is True:
1910.2.56 by Aaron Bentley
More work on bundles
1138
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1732.1.9 by John Arbash Meinel
Non-recursive implementation of WorkingTree.list_files
1139
        # Convert these into local objects to save lookup times
1836.1.22 by John Arbash Meinel
[merge] bzr.dev 1861
1140
        pathjoin = osutils.pathjoin
1551.10.29 by Aaron Bentley
Fix tree.list_files when file kind changes
1141
        file_kind = self._kind
1732.1.9 by John Arbash Meinel
Non-recursive implementation of WorkingTree.list_files
1142
1143
        # transport.base ends in a slash, we want the piece
1144
        # between the last two slashes
1145
        transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1146
1732.1.11 by John Arbash Meinel
Trying multiple things to get WorkingTree.list_files time down
1147
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1148
1732.1.9 by John Arbash Meinel
Non-recursive implementation of WorkingTree.list_files
1149
        # directory file_id, relative path, absolute path, reverse sorted children
4370.5.2 by Ian Clatworthy
extend list_files() with from_dir and recursive parameters
1150
        if from_dir is not None:
1151
            from_dir_id = inv.path2id(from_dir)
4370.5.3 by Ian Clatworthy
handle unversioned directories
1152
            if from_dir_id is None:
1153
                # Directory not versioned
1154
                return
4370.5.2 by Ian Clatworthy
extend list_files() with from_dir and recursive parameters
1155
            from_dir_abspath = pathjoin(self.basedir, from_dir)
1156
        else:
1157
            from_dir_id = inv.root.file_id
1158
            from_dir_abspath = self.basedir
1159
        children = os.listdir(from_dir_abspath)
1732.1.9 by John Arbash Meinel
Non-recursive implementation of WorkingTree.list_files
1160
        children.sort()
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1161
        # jam 20060527 The kernel sized tree seems equivalent whether we
1732.1.14 by John Arbash Meinel
Some speedups by not calling pathjoin()
1162
        # use a deque and popleft to keep them sorted, or if we use a plain
1163
        # list and just reverse() them.
1732.1.13 by John Arbash Meinel
A large improvement from not popping the parent off until we have done all children.
1164
        children = collections.deque(children)
4370.5.2 by Ian Clatworthy
extend list_files() with from_dir and recursive parameters
1165
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
1732.1.9 by John Arbash Meinel
Non-recursive implementation of WorkingTree.list_files
1166
        while stack:
1732.1.13 by John Arbash Meinel
A large improvement from not popping the parent off until we have done all children.
1167
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1732.1.9 by John Arbash Meinel
Non-recursive implementation of WorkingTree.list_files
1168
1169
            while children:
1732.1.13 by John Arbash Meinel
A large improvement from not popping the parent off until we have done all children.
1170
                f = children.popleft()
453 by Martin Pool
- Split WorkingTree into its own file
1171
                ## TODO: If we find a subdirectory with its own .bzr
1172
                ## directory, then that is a separate tree and we
1173
                ## should exclude it.
1534.5.5 by Robert Collins
Move is_control_file into WorkingTree.is_control_filename and test.
1174
1175
                # the bzrdir for this tree
1732.1.9 by John Arbash Meinel
Non-recursive implementation of WorkingTree.list_files
1176
                if transport_base_dir == f:
453 by Martin Pool
- Split WorkingTree into its own file
1177
                    continue
1178
1732.1.14 by John Arbash Meinel
Some speedups by not calling pathjoin()
1179
                # we know that from_dir_relpath and from_dir_abspath never end in a slash
1180
                # and 'f' doesn't begin with one, we can do a string op, rather
1732.1.21 by John Arbash Meinel
We don't need to strip off 2 characters, just do one, minor memory improvement
1181
                # than the checks of pathjoin(), all relative paths will have an extra slash
1182
                # at the beginning
1732.1.14 by John Arbash Meinel
Some speedups by not calling pathjoin()
1183
                fp = from_dir_relpath + '/' + f
453 by Martin Pool
- Split WorkingTree into its own file
1184
1185
                # absolute path
1732.1.14 by John Arbash Meinel
Some speedups by not calling pathjoin()
1186
                fap = from_dir_abspath + '/' + f
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1187
453 by Martin Pool
- Split WorkingTree into its own file
1188
                f_ie = inv.get_child(from_dir_id, f)
1189
                if f_ie:
1190
                    c = 'V'
1551.6.36 by Aaron Bentley
Revert --debris/--detritus changes
1191
                elif self.is_ignored(fp[1:]):
1192
                    c = 'I'
453 by Martin Pool
- Split WorkingTree into its own file
1193
                else:
1830.3.3 by John Arbash Meinel
inside workingtree check for normalized filename access
1194
                    # we may not have found this file, because of a unicode issue
1195
                    f_norm, can_access = osutils.normalized_filename(f)
1196
                    if f == f_norm or not can_access:
1197
                        # No change, so treat this file normally
1198
                        c = '?'
1199
                    else:
1200
                        # this file can be accessed by a normalized path
1201
                        # check again if it is versioned
1202
                        # these lines are repeated here for performance
1203
                        f = f_norm
1204
                        fp = from_dir_relpath + '/' + f
1205
                        fap = from_dir_abspath + '/' + f
1206
                        f_ie = inv.get_child(from_dir_id, f)
1207
                        if f_ie:
1208
                            c = 'V'
1209
                        elif self.is_ignored(fp[1:]):
1210
                            c = 'I'
1211
                        else:
1212
                            c = '?'
453 by Martin Pool
- Split WorkingTree into its own file
1213
1214
                fk = file_kind(fap)
1215
1399.1.2 by Robert Collins
push kind character creation into InventoryEntry and TreeEntry
1216
                # make a last minute entry
1217
                if f_ie:
1732.1.21 by John Arbash Meinel
We don't need to strip off 2 characters, just do one, minor memory improvement
1218
                    yield fp[1:], c, fk, f_ie.file_id, f_ie
1399.1.2 by Robert Collins
push kind character creation into InventoryEntry and TreeEntry
1219
                else:
1732.1.11 by John Arbash Meinel
Trying multiple things to get WorkingTree.list_files time down
1220
                    try:
1732.1.21 by John Arbash Meinel
We don't need to strip off 2 characters, just do one, minor memory improvement
1221
                        yield fp[1:], c, fk, None, fk_entries[fk]()
1732.1.11 by John Arbash Meinel
Trying multiple things to get WorkingTree.list_files time down
1222
                    except KeyError:
1732.1.21 by John Arbash Meinel
We don't need to strip off 2 characters, just do one, minor memory improvement
1223
                        yield fp[1:], c, fk, None, TreeEntry()
1732.1.13 by John Arbash Meinel
A large improvement from not popping the parent off until we have done all children.
1224
                    continue
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1225
453 by Martin Pool
- Split WorkingTree into its own file
1226
                if fk != 'directory':
1227
                    continue
1228
4370.5.2 by Ian Clatworthy
extend list_files() with from_dir and recursive parameters
1229
                # But do this child first if recursing down
1230
                if recursive:
1231
                    new_children = os.listdir(fap)
1232
                    new_children.sort()
1233
                    new_children = collections.deque(new_children)
1234
                    stack.append((f_ie.file_id, fp, fap, new_children))
1235
                    # Break out of inner loop,
1236
                    # so that we start outer loop with child
1237
                    break
1732.1.22 by John Arbash Meinel
Bug in list_files if the last entry in a directory is another directory
1238
            else:
1239
                # if we finished all children, pop it off the stack
1732.1.25 by John Arbash Meinel
Fix list_files test, we don't need to check if children are empty if we fall off the loop.
1240
                stack.pop()
1732.1.13 by John Arbash Meinel
A large improvement from not popping the parent off until we have done all children.
1241
1997.1.3 by Robert Collins
All WorkingTree methods which write to the tree, but not to the branch
1242
    @needs_tree_write_lock
2123.3.8 by Steffen Eichenberg
new parameter to_dir must be a named parameter
1243
    def move(self, from_paths, to_dir=None, after=False, **kwargs):
1508.1.8 by Robert Collins
move move() from Branch to WorkingTree.
1244
        """Rename files.
1245
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
1246
        to_dir must exist in the inventory.
1508.1.8 by Robert Collins
move move() from Branch to WorkingTree.
1247
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
1248
        If to_dir exists and is a directory, the files are moved into
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1249
        it, keeping their old names.
1508.1.8 by Robert Collins
move move() from Branch to WorkingTree.
1250
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
1251
        Note that to_dir is only the last component of the new name;
1508.1.8 by Robert Collins
move move() from Branch to WorkingTree.
1252
        this doesn't change the directory.
1253
2220.1.9 by Marius Kruger
Remove all trailing white space this bundle would have
1254
        For each entry in from_paths the move mode will be determined
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
1255
        independently.
1256
2220.1.9 by Marius Kruger
Remove all trailing white space this bundle would have
1257
        The first mode moves the file in the filesystem and updates the
1258
        inventory. The second mode only updates the inventory without
1259
        touching the file on the filesystem. This is the new mode introduced
2220.1.6 by Marius Kruger
* change error message telling user about --after option sightly
1260
        in version 0.15.
2220.1.9 by Marius Kruger
Remove all trailing white space this bundle would have
1261
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
1262
        move uses the second mode if 'after == True' and the target is not
1263
        versioned but present in the working tree.
1264
2220.1.9 by Marius Kruger
Remove all trailing white space this bundle would have
1265
        move uses the second mode if 'after == False' and the source is
1266
        versioned but no longer in the working tree, and the target is not
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
1267
        versioned but present in the working tree.
1268
2220.1.9 by Marius Kruger
Remove all trailing white space this bundle would have
1269
        move uses the first mode if 'after == False' and the source is
1270
        versioned and present in the working tree, and the target is not
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
1271
        versioned and not present in the working tree.
1272
1273
        Everything else results in an error.
1274
1508.1.8 by Robert Collins
move move() from Branch to WorkingTree.
1275
        This returns a list of (from_path, to_path) pairs for each
2220.1.6 by Marius Kruger
* change error message telling user about --after option sightly
1276
        entry that is moved.
1508.1.8 by Robert Collins
move move() from Branch to WorkingTree.
1277
        """
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
1278
        rename_entries = []
1279
        rename_tuples = []
1280
1281
        # check for deprecated use of signature
1282
        if to_dir is None:
1283
            to_dir = kwargs.get('to_name', None)
1284
            if to_dir is None:
1285
                raise TypeError('You must supply a target directory')
1286
            else:
1287
                symbol_versioning.warn('The parameter to_name was deprecated'
1288
                                       ' in version 0.13. Use to_dir instead',
1289
                                       DeprecationWarning)
1290
1291
        # check destination directory
3376.2.4 by Martin Pool
Remove every assert statement from bzrlib!
1292
        if isinstance(from_paths, basestring):
1293
            raise ValueError()
1508.1.8 by Robert Collins
move move() from Branch to WorkingTree.
1294
        inv = self.inventory
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
1295
        to_abs = self.abspath(to_dir)
1508.1.8 by Robert Collins
move move() from Branch to WorkingTree.
1296
        if not isdir(to_abs):
2220.1.9 by Marius Kruger
Remove all trailing white space this bundle would have
1297
            raise errors.BzrMoveFailedError('',to_dir,
2206.1.9 by Marius Kruger
* Change move/rename errors yet again
1298
                errors.NotADirectory(to_abs))
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
1299
        if not self.has_filename(to_dir):
2206.1.9 by Marius Kruger
* Change move/rename errors yet again
1300
            raise errors.BzrMoveFailedError('',to_dir,
1301
                errors.NotInWorkingDirectory(to_dir))
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
1302
        to_dir_id = inv.path2id(to_dir)
2123.3.6 by Steffen Eichenberg
unified error messages
1303
        if to_dir_id is None:
2206.1.9 by Marius Kruger
* Change move/rename errors yet again
1304
            raise errors.BzrMoveFailedError('',to_dir,
1305
                errors.NotVersionedError(path=str(to_dir)))
2220.1.9 by Marius Kruger
Remove all trailing white space this bundle would have
1306
1508.1.8 by Robert Collins
move move() from Branch to WorkingTree.
1307
        to_dir_ie = inv[to_dir_id]
1731.1.2 by Aaron Bentley
Removed all remaining uses of root_directory
1308
        if to_dir_ie.kind != 'directory':
2206.1.9 by Marius Kruger
* Change move/rename errors yet again
1309
            raise errors.BzrMoveFailedError('',to_dir,
1310
                errors.NotADirectory(to_abs))
1508.1.8 by Robert Collins
move move() from Branch to WorkingTree.
1311
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
1312
        # create rename entries and tuples
1313
        for from_rel in from_paths:
1314
            from_tail = splitpath(from_rel)[-1]
1315
            from_id = inv.path2id(from_rel)
1316
            if from_id is None:
2206.1.9 by Marius Kruger
* Change move/rename errors yet again
1317
                raise errors.BzrMoveFailedError(from_rel,to_dir,
1318
                    errors.NotVersionedError(path=str(from_rel)))
2206.1.4 by Marius Kruger
Improved WorkingTree.move excptions. (as requested)
1319
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
1320
            from_entry = inv[from_id]
1321
            from_parent_id = from_entry.parent_id
1322
            to_rel = pathjoin(to_dir, from_tail)
2220.1.9 by Marius Kruger
Remove all trailing white space this bundle would have
1323
            rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
2123.3.2 by Steffen Eichenberg
fixed the most obvious bugs
1324
                                         from_id=from_id,
1325
                                         from_tail=from_tail,
1326
                                         from_parent_id=from_parent_id,
1327
                                         to_rel=to_rel, to_tail=from_tail,
1328
                                         to_parent_id=to_dir_id)
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
1329
            rename_entries.append(rename_entry)
1330
            rename_tuples.append((from_rel, to_rel))
1331
1332
        # determine which move mode to use. checks also for movability
1333
        rename_entries = self._determine_mv_mode(rename_entries, after)
1334
1986.5.3 by Robert Collins
New method ``WorkingTree.flush()`` which will write the current memory
1335
        original_modified = self._inventory_is_modified
1508.1.8 by Robert Collins
move move() from Branch to WorkingTree.
1336
        try:
2220.1.6 by Marius Kruger
* change error message telling user about --after option sightly
1337
            if len(from_paths):
1986.5.3 by Robert Collins
New method ``WorkingTree.flush()`` which will write the current memory
1338
                self._inventory_is_modified = True
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
1339
            self._move(rename_entries)
1508.1.8 by Robert Collins
move move() from Branch to WorkingTree.
1340
        except:
1341
            # restore the inventory on error
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
1342
            self._inventory_is_modified = original_modified
1508.1.8 by Robert Collins
move move() from Branch to WorkingTree.
1343
            raise
1344
        self._write_inventory(inv)
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
1345
        return rename_tuples
1346
1347
    def _determine_mv_mode(self, rename_entries, after=False):
1348
        """Determines for each from-to pair if both inventory and working tree
1349
        or only the inventory has to be changed.
1350
1351
        Also does basic plausability tests.
1352
        """
1353
        inv = self.inventory
1354
1355
        for rename_entry in rename_entries:
1356
            # store to local variables for easier reference
1357
            from_rel = rename_entry.from_rel
1358
            from_id = rename_entry.from_id
1359
            to_rel = rename_entry.to_rel
1360
            to_id = inv.path2id(to_rel)
1361
            only_change_inv = False
1362
1363
            # check the inventory for source and destination
1364
            if from_id is None:
2206.1.9 by Marius Kruger
* Change move/rename errors yet again
1365
                raise errors.BzrMoveFailedError(from_rel,to_rel,
1366
                    errors.NotVersionedError(path=str(from_rel)))
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
1367
            if to_id is not None:
2206.1.9 by Marius Kruger
* Change move/rename errors yet again
1368
                raise errors.BzrMoveFailedError(from_rel,to_rel,
1369
                    errors.AlreadyVersionedError(path=str(to_rel)))
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
1370
2220.1.9 by Marius Kruger
Remove all trailing white space this bundle would have
1371
            # try to determine the mode for rename (only change inv or change
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
1372
            # inv and file system)
1373
            if after:
1374
                if not self.has_filename(to_rel):
2206.1.9 by Marius Kruger
* Change move/rename errors yet again
1375
                    raise errors.BzrMoveFailedError(from_id,to_rel,
1376
                        errors.NoSuchFile(path=str(to_rel),
1377
                        extra="New file has not been created yet"))
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
1378
                only_change_inv = True
1379
            elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1380
                only_change_inv = True
1381
            elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1382
                only_change_inv = False
3638.3.3 by Vincent Ladeuil
OSX too needs to accept 'bzr mv foo Foo' when foo and Foo are the same file.
1383
            elif (not self.case_sensitive
1384
                  and from_rel.lower() == to_rel.lower()
1385
                  and self.has_filename(from_rel)):
2978.8.1 by Alexander Belchenko
Rename on Windows is able to change filename case. (#77740)
1386
                only_change_inv = False
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
1387
            else:
1388
                # something is wrong, so lets determine what exactly
1389
                if not self.has_filename(from_rel) and \
1390
                   not self.has_filename(to_rel):
2206.1.9 by Marius Kruger
* Change move/rename errors yet again
1391
                    raise errors.BzrRenameFailedError(from_rel,to_rel,
2220.1.9 by Marius Kruger
Remove all trailing white space this bundle would have
1392
                        errors.PathsDoNotExist(paths=(str(from_rel),
2206.1.9 by Marius Kruger
* Change move/rename errors yet again
1393
                        str(to_rel))))
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
1394
                else:
2967.3.6 by Daniel Watkins
Extracted the string from every use of RenameFailedFilesExist to RenameFailedFilesExist itself.
1395
                    raise errors.RenameFailedFilesExist(from_rel, to_rel)
2220.1.9 by Marius Kruger
Remove all trailing white space this bundle would have
1396
            rename_entry.only_change_inv = only_change_inv
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
1397
        return rename_entries
1398
1399
    def _move(self, rename_entries):
1400
        """Moves a list of files.
1401
1402
        Depending on the value of the flag 'only_change_inv', the
1403
        file will be moved on the file system or not.
1404
        """
1405
        inv = self.inventory
1406
        moved = []
1407
1408
        for entry in rename_entries:
1409
            try:
1410
                self._move_entry(entry)
2220.1.12 by Marius Kruger
* Fix errors.py import order
1411
            except:
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
1412
                self._rollback_move(moved)
1413
                raise
1414
            moved.append(entry)
1415
1416
    def _rollback_move(self, moved):
2220.1.12 by Marius Kruger
* Fix errors.py import order
1417
        """Try to rollback a previous move in case of an filesystem error."""
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
1418
        inv = self.inventory
1419
        for entry in moved:
1420
            try:
4496.3.4 by Andrew Bennetts
Tidy up unused and redundant imports in workingtree.py.
1421
                self._move_entry(WorkingTree._RenameEntry(
1422
                    entry.to_rel, entry.from_id,
2220.1.12 by Marius Kruger
* Fix errors.py import order
1423
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
1424
                    entry.from_tail, entry.from_parent_id,
1425
                    entry.only_change_inv))
2220.1.14 by Aaron Bentley
Cleanup formatting and error handling
1426
            except errors.BzrMoveFailedError, e:
2220.1.12 by Marius Kruger
* Fix errors.py import order
1427
                raise errors.BzrMoveFailedError( '', '', "Rollback failed."
2206.1.9 by Marius Kruger
* Change move/rename errors yet again
1428
                        " The working tree is in an inconsistent state."
1429
                        " Please consider doing a 'bzr revert'."
2220.1.14 by Aaron Bentley
Cleanup formatting and error handling
1430
                        " Error message is: %s" % e)
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
1431
2220.1.12 by Marius Kruger
* Fix errors.py import order
1432
    def _move_entry(self, entry):
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
1433
        inv = self.inventory
1434
        from_rel_abs = self.abspath(entry.from_rel)
1435
        to_rel_abs = self.abspath(entry.to_rel)
1436
        if from_rel_abs == to_rel_abs:
2220.1.12 by Marius Kruger
* Fix errors.py import order
1437
            raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
2206.1.9 by Marius Kruger
* Change move/rename errors yet again
1438
                "Source and target are identical.")
2220.1.9 by Marius Kruger
Remove all trailing white space this bundle would have
1439
2220.1.12 by Marius Kruger
* Fix errors.py import order
1440
        if not entry.only_change_inv:
1441
            try:
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
1442
                osutils.rename(from_rel_abs, to_rel_abs)
2220.1.12 by Marius Kruger
* Fix errors.py import order
1443
            except OSError, e:
1444
                raise errors.BzrMoveFailedError(entry.from_rel,
1445
                    entry.to_rel, e[1])
1446
        inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1508.1.8 by Robert Collins
move move() from Branch to WorkingTree.
1447
1997.1.3 by Robert Collins
All WorkingTree methods which write to the tree, but not to the branch
1448
    @needs_tree_write_lock
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
1449
    def rename_one(self, from_rel, to_rel, after=False):
1508.1.7 by Robert Collins
Move rename_one from Branch to WorkingTree. (Robert Collins).
1450
        """Rename one file.
1451
1452
        This can change the directory or the filename or both.
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
1453
2220.1.9 by Marius Kruger
Remove all trailing white space this bundle would have
1454
        rename_one has several 'modes' to work. First, it can rename a physical
1455
        file and change the file_id. That is the normal mode. Second, it can
1456
        only change the file_id without touching any physical file. This is
1457
        the new mode introduced in version 0.15.
1458
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
1459
        rename_one uses the second mode if 'after == True' and 'to_rel' is not
1460
        versioned but present in the working tree.
1461
2220.1.9 by Marius Kruger
Remove all trailing white space this bundle would have
1462
        rename_one uses the second mode if 'after == False' and 'from_rel' is
1463
        versioned but no longer in the working tree, and 'to_rel' is not
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
1464
        versioned but present in the working tree.
1465
2220.1.9 by Marius Kruger
Remove all trailing white space this bundle would have
1466
        rename_one uses the first mode if 'after == False' and 'from_rel' is
1467
        versioned and present in the working tree, and 'to_rel' is not
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
1468
        versioned and not present in the working tree.
1469
1470
        Everything else results in an error.
1508.1.7 by Robert Collins
Move rename_one from Branch to WorkingTree. (Robert Collins).
1471
        """
1472
        inv = self.inventory
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
1473
        rename_entries = []
1474
1475
        # create rename entries and tuples
1476
        from_tail = splitpath(from_rel)[-1]
1477
        from_id = inv.path2id(from_rel)
1478
        if from_id is None:
4371.6.1 by Marius Kruger
Allow renaming of files already removed from the inventory
1479
            # if file is missing in the inventory maybe it's in the basis_tree
1480
            basis_tree = self.branch.basis_tree()
1481
            from_id = basis_tree.path2id(from_rel)
1482
            if from_id is None:
1483
                raise errors.BzrRenameFailedError(from_rel,to_rel,
1484
                    errors.NotVersionedError(path=str(from_rel)))
1485
            # put entry back in the inventory so we can rename it
4371.6.5 by Marius Kruger
clone the the inventory entry when putting it back
1486
            from_entry = basis_tree.inventory[from_id].copy()
4371.6.1 by Marius Kruger
Allow renaming of files already removed from the inventory
1487
            inv.add(from_entry)
1488
        else:
1489
            from_entry = inv[from_id]
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
1490
        from_parent_id = from_entry.parent_id
1508.1.7 by Robert Collins
Move rename_one from Branch to WorkingTree. (Robert Collins).
1491
        to_dir, to_tail = os.path.split(to_rel)
1492
        to_dir_id = inv.path2id(to_dir)
2220.1.9 by Marius Kruger
Remove all trailing white space this bundle would have
1493
        rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
2123.3.2 by Steffen Eichenberg
fixed the most obvious bugs
1494
                                     from_id=from_id,
1495
                                     from_tail=from_tail,
1496
                                     from_parent_id=from_parent_id,
1497
                                     to_rel=to_rel, to_tail=to_tail,
1498
                                     to_parent_id=to_dir_id)
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
1499
        rename_entries.append(rename_entry)
1500
1501
        # determine which move mode to use. checks also for movability
1502
        rename_entries = self._determine_mv_mode(rename_entries, after)
1503
1504
        # check if the target changed directory and if the target directory is
1505
        # versioned
2123.3.6 by Steffen Eichenberg
unified error messages
1506
        if to_dir_id is None:
2206.1.9 by Marius Kruger
* Change move/rename errors yet again
1507
            raise errors.BzrMoveFailedError(from_rel,to_rel,
1508
                errors.NotVersionedError(path=str(to_dir)))
2220.1.9 by Marius Kruger
Remove all trailing white space this bundle would have
1509
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
1510
        # all checks done. now we can continue with our actual work
1511
        mutter('rename_one:\n'
1512
               '  from_id   {%s}\n'
1513
               '  from_rel: %r\n'
1514
               '  to_rel:   %r\n'
1515
               '  to_dir    %r\n'
1516
               '  to_dir_id {%s}\n',
1517
               from_id, from_rel, to_rel, to_dir, to_dir_id)
1518
1519
        self._move(rename_entries)
1508.1.7 by Robert Collins
Move rename_one from Branch to WorkingTree. (Robert Collins).
1520
        self._write_inventory(inv)
1521
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
1522
    class _RenameEntry(object):
2123.3.2 by Steffen Eichenberg
fixed the most obvious bugs
1523
        def __init__(self, from_rel, from_id, from_tail, from_parent_id,
2220.1.12 by Marius Kruger
* Fix errors.py import order
1524
                     to_rel, to_tail, to_parent_id, only_change_inv=False):
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
1525
            self.from_rel = from_rel
1526
            self.from_id = from_id
1527
            self.from_tail = from_tail
1528
            self.from_parent_id = from_parent_id
1529
            self.to_rel = to_rel
1530
            self.to_tail = to_tail
1531
            self.to_parent_id = to_parent_id
2220.1.12 by Marius Kruger
* Fix errors.py import order
1532
            self.only_change_inv = only_change_inv
2123.3.1 by Steffen Eichenberg
the mv command is now able to move files that have already been moved on the file system
1533
1508.1.7 by Robert Collins
Move rename_one from Branch to WorkingTree. (Robert Collins).
1534
    @needs_read_lock
453 by Martin Pool
- Split WorkingTree into its own file
1535
    def unknowns(self):
1508.1.6 by Robert Collins
Move Branch.unknowns() to WorkingTree.
1536
        """Return all unknown files.
1537
1538
        These are files in the working directory that are not versioned or
1539
        control files or ignored.
1540
        """
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1541
        # force the extras method to be fully executed before returning, to
2255.2.15 by Robert Collins
Dirstate - truncate state file fixing bug in saving a smaller file, get more tree_implementation tests passing.
1542
        # prevent race conditions with the lock
1543
        return iter(
1544
            [subp for subp in self.extras() if not self.is_ignored(subp)])
2323.6.1 by Martin Pool
(broken) Give a message when opening old workingtree formats suggesting upgrade
1545
1997.1.3 by Robert Collins
All WorkingTree methods which write to the tree, but not to the branch
1546
    @needs_tree_write_lock
1988.2.1 by Robert Collins
WorkingTree has a new api ``unversion`` which allow the unversioning of
1547
    def unversion(self, file_ids):
1548
        """Remove the file ids in file_ids from the current versioned set.
1549
1550
        When a file_id is unversioned, all of its children are automatically
1551
        unversioned.
1552
1553
        :param file_ids: The file ids to stop versioning.
1554
        :raises: NoSuchId if any fileid is not currently versioned.
1555
        """
1556
        for file_id in file_ids:
4183.5.5 by Robert Collins
Enable record_iter_changes for cases where it can work.
1557
            if file_id not in self._inventory:
1558
                raise errors.NoSuchId(self, file_id)
1559
        for file_id in file_ids:
1988.2.1 by Robert Collins
WorkingTree has a new api ``unversion`` which allow the unversioning of
1560
            if self._inventory.has_id(file_id):
1988.2.6 by Robert Collins
Review feedback.
1561
                self._inventory.remove_recursive_id(file_id)
1988.2.1 by Robert Collins
WorkingTree has a new api ``unversion`` which allow the unversioning of
1562
        if len(file_ids):
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1563
            # in the future this should just set a dirty bit to wait for the
1988.2.1 by Robert Collins
WorkingTree has a new api ``unversion`` which allow the unversioning of
1564
            # final unlock. However, until all methods of workingtree start
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1565
            # with the current in -memory inventory rather than triggering
1988.2.1 by Robert Collins
WorkingTree has a new api ``unversion`` which allow the unversioning of
1566
            # a read, it is more complex - we need to teach read_inventory
1567
            # to know when to read, and when to not read first... and possibly
1568
            # to save first when the in memory one may be corrupted.
1569
            # so for now, we just only write it if it is indeed dirty.
1570
            # - RBC 20060907
1571
            self._write_inventory(self._inventory)
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1572
1534.10.9 by Aaron Bentley
Switched display functions to conflict_lines
1573
    def _iter_conflicts(self):
1185.14.6 by Aaron Bentley
Made iter_conflicts a WorkingTree method
1574
        conflicted = set()
1732.1.11 by John Arbash Meinel
Trying multiple things to get WorkingTree.list_files time down
1575
        for info in self.list_files():
1576
            path = info[0]
1185.14.6 by Aaron Bentley
Made iter_conflicts a WorkingTree method
1577
            stem = get_conflicted_stem(path)
1578
            if stem is None:
1579
                continue
1580
            if stem not in conflicted:
1581
                conflicted.add(stem)
1582
                yield stem
453 by Martin Pool
- Split WorkingTree into its own file
1583
1442.1.67 by Robert Collins
Factor out the guts of 'pull' from the command into WorkingTree.pull().
1584
    @needs_write_lock
1551.11.10 by Aaron Bentley
Add change reporting to pull
1585
    def pull(self, source, overwrite=False, stop_revision=None,
4056.6.3 by Gary van der Merwe
Add local args to pull methods, and add more tests
1586
             change_reporter=None, possible_transports=None, local=False):
4496.3.4 by Andrew Bennetts
Tidy up unused and redundant imports in workingtree.py.
1587
        top_pb = ui.ui_factory.nested_progress_bar()
1442.1.67 by Robert Collins
Factor out the guts of 'pull' from the command into WorkingTree.pull().
1588
        source.lock_read()
1589
        try:
1551.2.36 by Aaron Bentley
Make pull update the progress bar more nicely
1590
            pp = ProgressPhase("Pull phase", 2, top_pb)
1591
            pp.next_phase()
2249.4.2 by Wouter van Heyst
Convert callers of Branch.revision_history() to Branch.last_revision_info() where sensible.
1592
            old_revision_info = self.branch.last_revision_info()
1563.1.4 by Robert Collins
Fix 'bzr pull' on metadir trees.
1593
            basis_tree = self.basis_tree()
2817.4.3 by Vincent Ladeuil
Add tests for commit, reuse master branch transport.
1594
            count = self.branch.pull(source, overwrite, stop_revision,
4056.6.4 by Gary van der Merwe
Implement pull --local.
1595
                                     possible_transports=possible_transports,
1596
                                     local=local)
2249.4.2 by Wouter van Heyst
Convert callers of Branch.revision_history() to Branch.last_revision_info() where sensible.
1597
            new_revision_info = self.branch.last_revision_info()
1598
            if new_revision_info != old_revision_info:
1551.2.36 by Aaron Bentley
Make pull update the progress bar more nicely
1599
                pp.next_phase()
1185.67.2 by Aaron Bentley
Renamed Branch.storage to Branch.repository
1600
                repository = self.branch.repository
4496.3.4 by Andrew Bennetts
Tidy up unused and redundant imports in workingtree.py.
1601
                pb = ui.ui_factory.nested_progress_bar()
2255.2.38 by Robert Collins
Fix WorkingTree4.pull to work.
1602
                basis_tree.lock_read()
1594.1.3 by Robert Collins
Fixup pb usage to use nested_progress_bar.
1603
                try:
1908.6.1 by Robert Collins
Change all callers of set_last_revision to use set_parent_trees.
1604
                    new_basis_tree = self.branch.basis_tree()
1996.3.6 by John Arbash Meinel
Find a few places that weren't importing their dependencies.
1605
                    merge.merge_inner(
1606
                                self.branch,
1908.6.1 by Robert Collins
Change all callers of set_last_revision to use set_parent_trees.
1607
                                new_basis_tree,
1608
                                basis_tree,
1609
                                this_tree=self,
1551.11.10 by Aaron Bentley
Add change reporting to pull
1610
                                pb=pb,
1611
                                change_reporter=change_reporter)
1731.1.33 by Aaron Bentley
Revert no-special-root changes
1612
                    if (basis_tree.inventory.root is None and
1731.1.47 by Aaron Bentley
Merge bzr.dev
1613
                        new_basis_tree.inventory.root is not None):
2946.3.3 by John Arbash Meinel
Prefer tree.get_root_id() as more explicit than tree.path2id('')
1614
                        self.set_root_id(new_basis_tree.get_root_id())
1594.1.3 by Robert Collins
Fixup pb usage to use nested_progress_bar.
1615
                finally:
1616
                    pb.finished()
2255.2.38 by Robert Collins
Fix WorkingTree4.pull to work.
1617
                    basis_tree.unlock()
1908.6.1 by Robert Collins
Change all callers of set_last_revision to use set_parent_trees.
1618
                # TODO - dedup parents list with things merged by pull ?
1908.6.3 by Robert Collins
Tidy up the last_revision_id and add_pending_merge conversion to use cleaner apis.
1619
                # reuse the revisiontree we merged against to set the new
1620
                # tree data.
1908.6.1 by Robert Collins
Change all callers of set_last_revision to use set_parent_trees.
1621
                parent_trees = [(self.branch.last_revision(), new_basis_tree)]
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1622
                # we have to pull the merge trees out again, because
1623
                # merge_inner has set the ids. - this corner is not yet
1908.6.3 by Robert Collins
Tidy up the last_revision_id and add_pending_merge conversion to use cleaner apis.
1624
                # layered well enough to prevent double handling.
2255.2.38 by Robert Collins
Fix WorkingTree4.pull to work.
1625
                # XXX TODO: Fix the double handling: telling the tree about
1626
                # the already known parent data is wasteful.
1908.6.1 by Robert Collins
Change all callers of set_last_revision to use set_parent_trees.
1627
                merges = self.get_parent_ids()[1:]
1628
                parent_trees.extend([
1629
                    (parent, repository.revision_tree(parent)) for
1630
                     parent in merges])
1631
                self.set_parent_trees(parent_trees)
1185.33.44 by Martin Pool
[patch] show number of revisions pushed/pulled/merged (Robey Pointer)
1632
            return count
1442.1.67 by Robert Collins
Factor out the guts of 'pull' from the command into WorkingTree.pull().
1633
        finally:
1634
            source.unlock()
1551.2.36 by Aaron Bentley
Make pull update the progress bar more nicely
1635
            top_pb.finished()
1442.1.67 by Robert Collins
Factor out the guts of 'pull' from the command into WorkingTree.pull().
1636
1986.1.2 by Robert Collins
Various changes to allow non-workingtree specific tests to run entirely
1637
    @needs_write_lock
1638
    def put_file_bytes_non_atomic(self, file_id, bytes):
1639
        """See MutableTree.put_file_bytes_non_atomic."""
1640
        stream = file(self.id2abspath(file_id), 'wb')
1641
        try:
1642
            stream.write(bytes)
1643
        finally:
1644
            stream.close()
1645
        # TODO: update the hashcache here ?
1646
453 by Martin Pool
- Split WorkingTree into its own file
1647
    def extras(self):
2255.7.85 by Robert Collins
Teach _iter_changes to gather unversioned path details upon request.
1648
        """Yield all unversioned files in this WorkingTree.
453 by Martin Pool
- Split WorkingTree into its own file
1649
2255.7.85 by Robert Collins
Teach _iter_changes to gather unversioned path details upon request.
1650
        If there are any unversioned directories then only the directory is
1651
        returned, not all its children.  But if there are unversioned files
453 by Martin Pool
- Split WorkingTree into its own file
1652
        under a versioned subdirectory, they are returned.
1653
1654
        Currently returned depth-first, sorted by name within directories.
2255.7.85 by Robert Collins
Teach _iter_changes to gather unversioned path details upon request.
1655
        This is the same order used by 'osutils.walkdirs'.
453 by Martin Pool
- Split WorkingTree into its own file
1656
        """
1657
        ## TODO: Work from given directory downwards
1658
        for path, dir_entry in self.inventory.directories():
1711.2.101 by John Arbash Meinel
Clean up some unnecessary mutter() calls
1659
            # mutter("search for unknowns in %r", path)
453 by Martin Pool
- Split WorkingTree into its own file
1660
            dirabs = self.abspath(path)
1661
            if not isdir(dirabs):
1662
                # e.g. directory deleted
1663
                continue
1664
1665
            fl = []
1666
            for subf in os.listdir(dirabs):
4324.5.1 by Jelmer Vernooij
Use utility function to check for control filename rather than assuming it is '.bzr.'
1667
                if self.bzrdir.is_control_filename(subf):
1830.3.3 by John Arbash Meinel
inside workingtree check for normalized filename access
1668
                    continue
1669
                if subf not in dir_entry.children:
3287.20.3 by John Arbash Meinel
Aaron recommended to make this a WT_impl test.
1670
                    try:
1671
                        (subf_norm,
3287.20.4 by John Arbash Meinel
fix trivial typo
1672
                         can_access) = osutils.normalized_filename(subf)
3287.20.3 by John Arbash Meinel
Aaron recommended to make this a WT_impl test.
1673
                    except UnicodeDecodeError:
1674
                        path_os_enc = path.encode(osutils._fs_enc)
1675
                        relpath = path_os_enc + '/' + subf
1676
                        raise errors.BadFilenameEncoding(relpath,
1677
                                                         osutils._fs_enc)
1830.3.3 by John Arbash Meinel
inside workingtree check for normalized filename access
1678
                    if subf_norm != subf and can_access:
1679
                        if subf_norm not in dir_entry.children:
1680
                            fl.append(subf_norm)
1681
                    else:
1682
                        fl.append(subf)
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1683
453 by Martin Pool
- Split WorkingTree into its own file
1684
            fl.sort()
1685
            for subf in fl:
1732.1.1 by John Arbash Meinel
deprecating appendpath, it does exactly what pathjoin does
1686
                subp = pathjoin(path, subf)
453 by Martin Pool
- Split WorkingTree into its own file
1687
                yield subp
1688
1689
    def ignored_files(self):
1690
        """Yield list of PATH, IGNORE_PATTERN"""
1691
        for subp in self.extras():
1692
            pat = self.is_ignored(subp)
1963.2.6 by Robey Pointer
pychecker is on crack; go back to using 'is None'.
1693
            if pat is not None:
453 by Martin Pool
- Split WorkingTree into its own file
1694
                yield subp, pat
1695
1696
    def get_ignore_list(self):
1697
        """Return list of ignore patterns.
1698
1699
        Cached in the Tree object after the first call.
1700
        """
1836.1.30 by John Arbash Meinel
Change ignore functions to use sets instead of lists.
1701
        ignoreset = getattr(self, '_ignoreset', None)
1702
        if ignoreset is not None:
1703
            return ignoreset
1704
2696.1.1 by Martin Pool
Remove things deprecated in 0.11 and earlier
1705
        ignore_globs = set()
1836.1.30 by John Arbash Meinel
Change ignore functions to use sets instead of lists.
1706
        ignore_globs.update(ignores.get_runtime_ignores())
1707
        ignore_globs.update(ignores.get_user_ignores())
453 by Martin Pool
- Split WorkingTree into its own file
1708
        if self.has_filename(bzrlib.IGNORE_FILENAME):
1709
            f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1836.1.4 by John Arbash Meinel
Cleanup is_ignored to handle comment lines, and a global ignore pattern
1710
            try:
1836.1.30 by John Arbash Meinel
Change ignore functions to use sets instead of lists.
1711
                ignore_globs.update(ignores.parse_ignore_file(f))
1836.1.4 by John Arbash Meinel
Cleanup is_ignored to handle comment lines, and a global ignore pattern
1712
            finally:
1713
                f.close()
1836.1.30 by John Arbash Meinel
Change ignore functions to use sets instead of lists.
1714
        self._ignoreset = ignore_globs
1836.1.4 by John Arbash Meinel
Cleanup is_ignored to handle comment lines, and a global ignore pattern
1715
        return ignore_globs
453 by Martin Pool
- Split WorkingTree into its own file
1716
2135.2.7 by Kent Gibson
Implement JAM's review suggestions.
1717
    def _flush_ignore_list_cache(self):
2135.2.1 by Kent Gibson
Added glob module to replace broken fnmatch based ignore pattern matching (#57637)
1718
        """Resets the cached ignore list to force a cache rebuild."""
1719
        self._ignoreset = None
1720
        self._ignoreglobster = None
1713.2.3 by Robert Collins
Combine ignore rules into a single regex preventing pathological behaviour during add.
1721
453 by Martin Pool
- Split WorkingTree into its own file
1722
    def is_ignored(self, filename):
1723
        r"""Check whether the filename matches an ignore pattern.
1724
1725
        Patterns containing '/' or '\' need to match the whole path;
1726
        others match against only the last component.
1727
1728
        If the file is ignored, returns the pattern which caused it to
1729
        be ignored, otherwise None.  So this can simply be used as a
1730
        boolean if desired."""
2135.2.1 by Kent Gibson
Added glob module to replace broken fnmatch based ignore pattern matching (#57637)
1731
        if getattr(self, '_ignoreglobster', None) is None:
2135.2.7 by Kent Gibson
Implement JAM's review suggestions.
1732
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
2135.2.1 by Kent Gibson
Added glob module to replace broken fnmatch based ignore pattern matching (#57637)
1733
        return self._ignoreglobster.match(filename)
1185.14.6 by Aaron Bentley
Made iter_conflicts a WorkingTree method
1734
1185.12.28 by Aaron Bentley
Removed use of readonly path for executability test
1735
    def kind(self, file_id):
1736
        return file_kind(self.id2abspath(file_id))
1737
3146.8.4 by Aaron Bentley
Eliminate direct use of inventory from transform application
1738
    def stored_kind(self, file_id):
1739
        """See Tree.stored_kind"""
1740
        return self.inventory[file_id].kind
1741
2012.1.7 by Aaron Bentley
Get tree._iter_changed down to ~ 1 stat per file
1742
    def _comparison_data(self, entry, path):
1743
        abspath = self.abspath(path)
1744
        try:
1745
            stat_value = os.lstat(abspath)
1746
        except OSError, e:
1747
            if getattr(e, 'errno', None) == errno.ENOENT:
1748
                stat_value = None
1749
                kind = None
1750
                executable = False
1751
            else:
1752
                raise
1753
        else:
1754
            mode = stat_value.st_mode
1755
            kind = osutils.file_kind_from_stat_mode(mode)
1756
            if not supports_executable():
2409.1.2 by Dmitry Vasiliev
Used one-line conditional expression instead of the multi-line one
1757
                executable = entry is not None and entry.executable
2012.1.7 by Aaron Bentley
Get tree._iter_changed down to ~ 1 stat per file
1758
            else:
1759
                executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1760
        return kind, executable, stat_value
1761
1762
    def _file_size(self, entry, stat_value):
1763
        return stat_value.st_size
1764
1534.4.35 by Robert Collins
Give branch its own basis tree and last_revision methods; deprecated branch.working_tree()
1765
    def last_revision(self):
1986.1.6 by Robert Collins
Add MemoryTree.last_revision.
1766
        """Return the last revision of the branch for this tree.
1767
1768
        This format tree does not support a separate marker for last-revision
1769
        compared to the branch.
1770
1771
        See MutableTree.last_revision
1534.4.35 by Robert Collins
Give branch its own basis tree and last_revision methods; deprecated branch.working_tree()
1772
        """
1908.7.6 by Robert Collins
Deprecate WorkingTree.last_revision.
1773
        return self._last_revision()
1774
1775
    @needs_read_lock
1776
    def _last_revision(self):
1777
        """helper for get_parent_ids."""
2598.5.10 by Aaron Bentley
Return NULL_REVISION instead of None for the null revision
1778
        return _mod_revision.ensure_null(self.branch.last_revision())
1534.4.35 by Robert Collins
Give branch its own basis tree and last_revision methods; deprecated branch.working_tree()
1779
1694.2.6 by Martin Pool
[merge] bzr.dev
1780
    def is_locked(self):
1781
        return self._control_files.is_locked()
1782
2298.1.1 by Martin Pool
Add test for merge_modified
1783
    def _must_be_locked(self):
1784
        if not self.is_locked():
1785
            raise errors.ObjectNotLocked(self)
1786
1442.1.65 by Robert Collins
Branch.remove has been moved to WorkingTree.
1787
    def lock_read(self):
1788
        """See Branch.lock_read, and WorkingTree.unlock."""
2255.2.204 by Robert Collins
Fix info and status again.
1789
        if not self.is_locked():
1790
            self._reset_data()
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
1791
        self.branch.lock_read()
1792
        try:
1793
            return self._control_files.lock_read()
1794
        except:
1795
            self.branch.unlock()
1796
            raise
1442.1.65 by Robert Collins
Branch.remove has been moved to WorkingTree.
1797
1997.1.1 by Robert Collins
Add WorkingTree.lock_tree_write.
1798
    def lock_tree_write(self):
1986.1.8 by Robert Collins
Update to bzr.dev, which involves adding lock_tree_write to MutableTree and MemoryTree.
1799
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
2255.2.204 by Robert Collins
Fix info and status again.
1800
        if not self.is_locked():
1801
            self._reset_data()
1997.1.1 by Robert Collins
Add WorkingTree.lock_tree_write.
1802
        self.branch.lock_read()
1803
        try:
1804
            return self._control_files.lock_write()
1805
        except:
1806
            self.branch.unlock()
1807
            raise
1808
1442.1.65 by Robert Collins
Branch.remove has been moved to WorkingTree.
1809
    def lock_write(self):
1986.1.2 by Robert Collins
Various changes to allow non-workingtree specific tests to run entirely
1810
        """See MutableTree.lock_write, and WorkingTree.unlock."""
2255.2.204 by Robert Collins
Fix info and status again.
1811
        if not self.is_locked():
1812
            self._reset_data()
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
1813
        self.branch.lock_write()
1814
        try:
1815
            return self._control_files.lock_write()
1816
        except:
1817
            self.branch.unlock()
1818
            raise
1442.1.65 by Robert Collins
Branch.remove has been moved to WorkingTree.
1819
1694.2.6 by Martin Pool
[merge] bzr.dev
1820
    def get_physical_lock_status(self):
1821
        return self._control_files.get_physical_lock_status()
1822
1638.1.2 by Robert Collins
Change the basis-inventory file to not have the revision-id in the file name.
1823
    def _basis_inventory_name(self):
1910.2.31 by Aaron Bentley
Fix bugs in basis inventory handling, change filename
1824
        return 'basis-inventory-cache'
1185.33.59 by Martin Pool
[patch] keep a cached basis inventory (Johan Rydberg)
1825
2255.2.204 by Robert Collins
Fix info and status again.
1826
    def _reset_data(self):
1827
        """Reset transient data that cannot be revalidated."""
1828
        self._inventory_is_modified = False
3407.2.1 by Martin Pool
Deprecate LockableFiles.get
1829
        result = self._deserialize(self._transport.get('inventory'))
2255.2.204 by Robert Collins
Fix info and status again.
1830
        self._set_inventory(result, dirty=False)
1831
1997.1.3 by Robert Collins
All WorkingTree methods which write to the tree, but not to the branch
1832
    @needs_tree_write_lock
1638.1.2 by Robert Collins
Change the basis-inventory file to not have the revision-id in the file name.
1833
    def set_last_revision(self, new_revision):
1508.1.19 by Robert Collins
Give format3 working trees their own last-revision marker.
1834
        """Change the last revision in the working tree."""
1835
        if self._change_last_revision(new_revision):
1836
            self._cache_basis_inventory(new_revision)
1837
1838
    def _change_last_revision(self, new_revision):
1638.1.2 by Robert Collins
Change the basis-inventory file to not have the revision-id in the file name.
1839
        """Template method part of set_last_revision to perform the change.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1840
1638.1.2 by Robert Collins
Change the basis-inventory file to not have the revision-id in the file name.
1841
        This is used to allow WorkingTree3 instances to not affect branch
1842
        when their last revision is set.
1843
        """
2598.5.1 by Aaron Bentley
Start eliminating the use of None to indicate null revision
1844
        if _mod_revision.is_null(new_revision):
1534.4.35 by Robert Collins
Give branch its own basis tree and last_revision methods; deprecated branch.working_tree()
1845
            self.branch.set_revision_history([])
1508.1.19 by Robert Collins
Give format3 working trees their own last-revision marker.
1846
            return False
1534.4.35 by Robert Collins
Give branch its own basis tree and last_revision methods; deprecated branch.working_tree()
1847
        try:
1908.1.1 by Robert Collins
Relax WorkingTree.set_last-revision to allow any revision to be set.
1848
            self.branch.generate_revision_history(new_revision)
1849
        except errors.NoSuchRevision:
1850
            # not present in the repo - dont try to set it deeper than the tip
1851
            self.branch.set_revision_history([new_revision])
1508.1.19 by Robert Collins
Give format3 working trees their own last-revision marker.
1852
        return True
1853
2041.1.2 by John Arbash Meinel
Update WorkingTree.set_parent_trees() to directly cache inv.
1854
    def _write_basis_inventory(self, xml):
1855
        """Write the basis inventory XML to the basis-inventory file"""
1856
        path = self._basis_inventory_name()
1857
        sio = StringIO(xml)
3407.2.7 by Martin Pool
Deprecate LockableFiles.put_utf8 and put_bytes.
1858
        self._transport.put_file(path, sio,
3407.2.18 by Martin Pool
BzrDir takes responsibility for default file/dir modes
1859
            mode=self.bzrdir._get_file_mode())
2041.1.2 by John Arbash Meinel
Update WorkingTree.set_parent_trees() to directly cache inv.
1860
1861
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
1862
        """Create the text that will be saved in basis-inventory"""
2858.2.3 by Martin Pool
Fix incorrect deletion from _create_basis_xml_from_inventory (thanks igc)
1863
        inventory.revision_id = revision_id
2100.3.14 by Aaron Bentley
Test workingtree4 format, prevent use with old repos
1864
        return xml7.serializer_v7.write_inventory_to_string(inventory)
2041.1.2 by John Arbash Meinel
Update WorkingTree.set_parent_trees() to directly cache inv.
1865
1508.1.19 by Robert Collins
Give format3 working trees their own last-revision marker.
1866
    def _cache_basis_inventory(self, new_revision):
1867
        """Cache new_revision as the basis inventory."""
1740.2.3 by Aaron Bentley
Only reserialize the working tree basis inventory when needed.
1868
        # TODO: this should allow the ready-to-use inventory to be passed in,
1869
        # as commit already has that ready-to-use [while the format is the
1870
        # same, that is].
1185.33.59 by Martin Pool
[patch] keep a cached basis inventory (Johan Rydberg)
1871
        try:
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1872
            # this double handles the inventory - unpack and repack -
1638.1.2 by Robert Collins
Change the basis-inventory file to not have the revision-id in the file name.
1873
            # but is easier to understand. We can/should put a conditional
1874
            # in here based on whether the inventory is in the latest format
1875
            # - perhaps we should repack all inventories on a repository
1876
            # upgrade ?
1740.2.3 by Aaron Bentley
Only reserialize the working tree basis inventory when needed.
1877
            # the fast path is to copy the raw xml from the repository. If the
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1878
            # xml contains 'revision_id="', then we assume the right
1740.2.3 by Aaron Bentley
Only reserialize the working tree basis inventory when needed.
1879
            # revision_id is set. We must check for this full string, because a
1880
            # root node id can legitimately look like 'revision_id' but cannot
1881
            # contain a '"'.
1882
            xml = self.branch.repository.get_inventory_xml(new_revision)
1910.2.22 by Aaron Bentley
Make commits preserve root entry data
1883
            firstline = xml.split('\n', 1)[0]
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1884
            if (not 'revision_id="' in firstline or
2100.3.14 by Aaron Bentley
Test workingtree4 format, prevent use with old repos
1885
                'format="7"' not in firstline):
1740.2.3 by Aaron Bentley
Only reserialize the working tree basis inventory when needed.
1886
                inv = self.branch.repository.deserialise_inventory(
1887
                    new_revision, xml)
2041.1.2 by John Arbash Meinel
Update WorkingTree.set_parent_trees() to directly cache inv.
1888
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
1889
            self._write_basis_inventory(xml)
1908.1.1 by Robert Collins
Relax WorkingTree.set_last-revision to allow any revision to be set.
1890
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1185.33.59 by Martin Pool
[patch] keep a cached basis inventory (Johan Rydberg)
1891
            pass
1892
1638.1.2 by Robert Collins
Change the basis-inventory file to not have the revision-id in the file name.
1893
    def read_basis_inventory(self):
1185.33.59 by Martin Pool
[patch] keep a cached basis inventory (Johan Rydberg)
1894
        """Read the cached basis inventory."""
1638.1.2 by Robert Collins
Change the basis-inventory file to not have the revision-id in the file name.
1895
        path = self._basis_inventory_name()
3407.2.14 by Martin Pool
Remove more cases of getting transport via control_files
1896
        return self._transport.get_bytes(path)
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1897
1497 by Robert Collins
Move Branch.read_working_inventory to WorkingTree.
1898
    @needs_read_lock
1899
    def read_working_inventory(self):
1986.5.3 by Robert Collins
New method ``WorkingTree.flush()`` which will write the current memory
1900
        """Read the working inventory.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1901
1986.5.7 by Robert Collins
Merge reviews.
1902
        :raises errors.InventoryModified: read_working_inventory will fail
1903
            when the current in memory inventory has been modified.
1986.5.3 by Robert Collins
New method ``WorkingTree.flush()`` which will write the current memory
1904
        """
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1905
        # conceptually this should be an implementation detail of the tree.
1986.5.3 by Robert Collins
New method ``WorkingTree.flush()`` which will write the current memory
1906
        # XXX: Deprecate this.
1497 by Robert Collins
Move Branch.read_working_inventory to WorkingTree.
1907
        # ElementTree does its own conversion from UTF-8, so open in
1908
        # binary.
1986.5.3 by Robert Collins
New method ``WorkingTree.flush()`` which will write the current memory
1909
        if self._inventory_is_modified:
1910
            raise errors.InventoryModified(self)
3407.2.14 by Martin Pool
Remove more cases of getting transport via control_files
1911
        result = self._deserialize(self._transport.get('inventory'))
1986.5.3 by Robert Collins
New method ``WorkingTree.flush()`` which will write the current memory
1912
        self._set_inventory(result, dirty=False)
1534.4.35 by Robert Collins
Give branch its own basis tree and last_revision methods; deprecated branch.working_tree()
1913
        return result
1497 by Robert Collins
Move Branch.read_working_inventory to WorkingTree.
1914
1997.1.3 by Robert Collins
All WorkingTree methods which write to the tree, but not to the branch
1915
    @needs_tree_write_lock
2292.1.22 by Marius Kruger
Implement TODO: Normalize names.
1916
    def remove(self, files, verbose=False, to_file=None, keep_files=True,
2292.1.10 by Marius Kruger
* workingtree.remove
1917
        force=False):
2475.5.2 by Marius Kruger
* blackbox/test_remove
1918
        """Remove nominated files from the working inventory.
1442.1.65 by Robert Collins
Branch.remove has been moved to WorkingTree.
1919
2292.1.22 by Marius Kruger
Implement TODO: Normalize names.
1920
        :files: File paths relative to the basedir.
2292.1.7 by Marius Kruger
First pass at only deleting files on 'bzr remove' when
1921
        :keep_files: If true, the files will also be kept.
2292.1.10 by Marius Kruger
* workingtree.remove
1922
        :force: Delete files and directories, even if they are changed and
1923
            even if the directories are not empty.
1442.1.65 by Robert Collins
Branch.remove has been moved to WorkingTree.
1924
        """
1925
        if isinstance(files, basestring):
1926
            files = [files]
1927
1551.15.12 by Aaron Bentley
Stop using inventory directly in WorkingTree.remove
1928
        inv_delta = []
2292.1.25 by Marius Kruger
* Add utility method delta.get_changes_as_text to get the output of .show()
1929
1930
        new_files=set()
2655.2.16 by Marius Kruger
* Rename `unknown_files_in_directory` to `unknown_nested_files`, which
1931
        unknown_nested_files=set()
2292.1.25 by Marius Kruger
* Add utility method delta.get_changes_as_text to get the output of .show()
1932
1933
        def recurse_directory_to_add_files(directory):
2655.2.16 by Marius Kruger
* Rename `unknown_files_in_directory` to `unknown_nested_files`, which
1934
            # Recurse directory and add all files
2292.1.25 by Marius Kruger
* Add utility method delta.get_changes_as_text to get the output of .show()
1935
            # so we can check if they have changed.
1551.15.11 by Aaron Bentley
Bugfix WorkingTree.remove to handle subtrees, and non-cwd trees
1936
            for parent_info, file_infos in\
3585.2.4 by Robert Collins
* Deleting directories by hand before running ``bzr rm`` will not
1937
                self.walkdirs(directory):
1938
                for relpath, basename, kind, lstat, fileid, kind in file_infos:
2655.2.16 by Marius Kruger
* Rename `unknown_files_in_directory` to `unknown_nested_files`, which
1939
                    # Is it versioned or ignored?
1940
                    if self.path2id(relpath) or self.is_ignored(relpath):
1941
                        # Add nested content for deletion.
2655.2.6 by Marius Kruger
* workingtree.remove
1942
                        new_files.add(relpath)
2655.2.16 by Marius Kruger
* Rename `unknown_files_in_directory` to `unknown_nested_files`, which
1943
                    else:
1944
                        # Files which are not versioned and not ignored
1945
                        # should be treated as unknown.
1946
                        unknown_nested_files.add((relpath, None, kind))
2292.1.25 by Marius Kruger
* Add utility method delta.get_changes_as_text to get the output of .show()
1947
1948
        for filename in files:
1949
            # Get file name into canonical form.
1551.15.11 by Aaron Bentley
Bugfix WorkingTree.remove to handle subtrees, and non-cwd trees
1950
            abspath = self.abspath(filename)
1951
            filename = self.relpath(abspath)
2292.1.25 by Marius Kruger
* Add utility method delta.get_changes_as_text to get the output of .show()
1952
            if len(filename) > 0:
1953
                new_files.add(filename)
3585.2.4 by Robert Collins
* Deleting directories by hand before running ``bzr rm`` will not
1954
                recurse_directory_to_add_files(filename)
2655.2.4 by Marius Kruger
* workingtree.remove
1955
2655.2.15 by Marius Kruger
Apply Alexander's comments:
1956
        files = list(new_files)
2292.1.22 by Marius Kruger
Implement TODO: Normalize names.
1957
2475.5.2 by Marius Kruger
* blackbox/test_remove
1958
        if len(files) == 0:
1959
            return # nothing to do
1960
2292.1.22 by Marius Kruger
Implement TODO: Normalize names.
1961
        # Sort needed to first handle directory content before the directory
1962
        files.sort(reverse=True)
2655.2.6 by Marius Kruger
* workingtree.remove
1963
2655.2.4 by Marius Kruger
* workingtree.remove
1964
        # Bail out if we are going to delete files we shouldn't
2292.1.11 by Marius Kruger
* workingtree.remove
1965
        if not keep_files and not force:
2655.2.16 by Marius Kruger
* Rename `unknown_files_in_directory` to `unknown_nested_files`, which
1966
            has_changed_files = len(unknown_nested_files) > 0
2475.5.2 by Marius Kruger
* blackbox/test_remove
1967
            if not has_changed_files:
1968
                for (file_id, path, content_change, versioned, parent_id, name,
3254.1.1 by Aaron Bentley
Make Tree.iter_changes a public method
1969
                     kind, executable) in self.iter_changes(self.basis_tree(),
2475.5.2 by Marius Kruger
* blackbox/test_remove
1970
                         include_unchanged=True, require_versioned=False,
1971
                         want_unversioned=True, specific_files=files):
3042.2.1 by Lukáš Lalinský
Fix ``bzr rm`` to not delete modified and ignored files.
1972
                    if versioned == (False, False):
3042.2.2 by John Arbash Meinel
Minor comment cleanup.
1973
                        # The record is unknown ...
3042.2.1 by Lukáš Lalinský
Fix ``bzr rm`` to not delete modified and ignored files.
1974
                        if not self.is_ignored(path[1]):
3042.2.2 by John Arbash Meinel
Minor comment cleanup.
1975
                            # ... but not ignored
3042.2.1 by Lukáš Lalinský
Fix ``bzr rm`` to not delete modified and ignored files.
1976
                            has_changed_files = True
1977
                            break
3376.2.11 by Martin Pool
Compare to None using is/is not not ==
1978
                    elif content_change and (kind[1] is not None):
3042.2.2 by John Arbash Meinel
Minor comment cleanup.
1979
                        # Versioned and changed, but not deleted
2475.5.2 by Marius Kruger
* blackbox/test_remove
1980
                        has_changed_files = True
1981
                        break
1982
1983
            if has_changed_files:
2655.2.17 by Marius Kruger
Minor doc and spacing updates.
1984
                # Make delta show ALL applicable changes in error message.
2475.5.2 by Marius Kruger
* blackbox/test_remove
1985
                tree_delta = self.changes_from(self.basis_tree(),
2655.2.4 by Marius Kruger
* workingtree.remove
1986
                    require_versioned=False, want_unversioned=True,
2475.5.2 by Marius Kruger
* blackbox/test_remove
1987
                    specific_files=files)
2655.2.16 by Marius Kruger
* Rename `unknown_files_in_directory` to `unknown_nested_files`, which
1988
                for unknown_file in unknown_nested_files:
2655.2.6 by Marius Kruger
* workingtree.remove
1989
                    if unknown_file not in tree_delta.unversioned:
1990
                        tree_delta.unversioned.extend((unknown_file,))
2292.1.25 by Marius Kruger
* Add utility method delta.get_changes_as_text to get the output of .show()
1991
                raise errors.BzrRemoveChangedFilesError(tree_delta)
2292.1.7 by Marius Kruger
First pass at only deleting files on 'bzr remove' when
1992
4031.3.1 by Frank Aspell
Fixing various typos
1993
        # Build inv_delta and delete files where applicable,
2655.2.17 by Marius Kruger
Minor doc and spacing updates.
1994
        # do this before any modifications to inventory.
1442.1.65 by Robert Collins
Branch.remove has been moved to WorkingTree.
1995
        for f in files:
1551.15.12 by Aaron Bentley
Stop using inventory directly in WorkingTree.remove
1996
            fid = self.path2id(f)
2655.2.4 by Marius Kruger
* workingtree.remove
1997
            message = None
1442.1.65 by Robert Collins
Branch.remove has been moved to WorkingTree.
1998
            if not fid:
2655.2.4 by Marius Kruger
* workingtree.remove
1999
                message = "%s is not versioned." % (f,)
2245.5.1 by Marius Kruger
Let bzr rm rather give a warning than an error when trying to remove a non-versioned file.
2000
            else:
2001
                if verbose:
2292.1.10 by Marius Kruger
* workingtree.remove
2002
                    # having removed it, it must be either ignored or unknown
2245.5.1 by Marius Kruger
Let bzr rm rather give a warning than an error when trying to remove a non-versioned file.
2003
                    if self.is_ignored(f):
2004
                        new_status = 'I'
2005
                    else:
2006
                        new_status = '?'
1551.15.12 by Aaron Bentley
Stop using inventory directly in WorkingTree.remove
2007
                    textui.show_status(new_status, self.kind(fid), f,
2245.5.1 by Marius Kruger
Let bzr rm rather give a warning than an error when trying to remove a non-versioned file.
2008
                                       to_file=to_file)
2655.2.17 by Marius Kruger
Minor doc and spacing updates.
2009
                # Unversion file
1551.15.12 by Aaron Bentley
Stop using inventory directly in WorkingTree.remove
2010
                inv_delta.append((f, None, fid, None))
2655.2.4 by Marius Kruger
* workingtree.remove
2011
                message = "removed %s" % (f,)
2292.1.7 by Marius Kruger
First pass at only deleting files on 'bzr remove' when
2012
2292.1.13 by Marius Kruger
* merge the unversion command back into the remove command,
2013
            if not keep_files:
2292.1.30 by Marius Kruger
* Minor text fixes.
2014
                abs_path = self.abspath(f)
2015
                if osutils.lexists(abs_path):
2016
                    if (osutils.isdir(abs_path) and
2017
                        len(os.listdir(abs_path)) > 0):
2655.2.4 by Marius Kruger
* workingtree.remove
2018
                        if force:
2019
                            osutils.rmtree(abs_path)
2020
                        else:
2655.2.6 by Marius Kruger
* workingtree.remove
2021
                            message = "%s is not an empty directory "\
2655.2.4 by Marius Kruger
* workingtree.remove
2022
                                "and won't be deleted." % (f,)
2292.1.25 by Marius Kruger
* Add utility method delta.get_changes_as_text to get the output of .show()
2023
                    else:
2292.1.30 by Marius Kruger
* Minor text fixes.
2024
                        osutils.delete_any(abs_path)
2655.2.4 by Marius Kruger
* workingtree.remove
2025
                        message = "deleted %s" % (f,)
2292.1.13 by Marius Kruger
* merge the unversion command back into the remove command,
2026
                elif message is not None:
2655.2.17 by Marius Kruger
Minor doc and spacing updates.
2027
                    # Only care if we haven't done anything yet.
2028
                    message = "%s does not exist." % (f,)
2292.1.25 by Marius Kruger
* Add utility method delta.get_changes_as_text to get the output of .show()
2029
2655.2.17 by Marius Kruger
Minor doc and spacing updates.
2030
            # Print only one message (if any) per file.
2292.1.1 by Marius Kruger
"bzr remove" and "bzr rm" will now remove the working file.
2031
            if message is not None:
2032
                note(message)
1551.15.12 by Aaron Bentley
Stop using inventory directly in WorkingTree.remove
2033
        self.apply_inventory_delta(inv_delta)
1442.1.65 by Robert Collins
Branch.remove has been moved to WorkingTree.
2034
1997.1.3 by Robert Collins
All WorkingTree methods which write to the tree, but not to the branch
2035
    @needs_tree_write_lock
2748.3.2 by Aaron Bentley
Fix revert, remove-tree, and various tests to use None for 'no files specified'
2036
    def revert(self, filenames=None, old_tree=None, backups=True,
2225.1.1 by Aaron Bentley
Added revert change display, with tests
2037
               pb=DummyProgress(), report_changes=False):
1996.3.6 by John Arbash Meinel
Find a few places that weren't importing their dependencies.
2038
        from bzrlib.conflicts import resolve
2748.3.3 by Aaron Bentley
Add a deprecation warning for revert([]), and handle as revert(None) for now
2039
        if filenames == []:
2040
            filenames = None
2041
            symbol_versioning.warn('Using [] to revert all files is deprecated'
2042
                ' as of bzr 0.91.  Please use None (the default) instead.',
2043
                DeprecationWarning, stacklevel=2)
1501 by Robert Collins
Move revert from Branch to WorkingTree.
2044
        if old_tree is None:
2949.2.1 by Robert Collins
* Revert takes out an appropriate lock when reverting to a basis tree, and
2045
            basis_tree = self.basis_tree()
2046
            basis_tree.lock_read()
2047
            old_tree = basis_tree
1534.10.14 by Aaron Bentley
Made revert clear conflicts
2048
        else:
2949.2.1 by Robert Collins
* Revert takes out an appropriate lock when reverting to a basis tree, and
2049
            basis_tree = None
2050
        try:
2051
            conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2052
                                         report_changes)
2949.2.2 by Robert Collins
Avoid dirstate parent resetting when it is not needed during revert.
2053
            if filenames is None and len(self.get_parent_ids()) > 1:
2949.2.1 by Robert Collins
* Revert takes out an appropriate lock when reverting to a basis tree, and
2054
                parent_trees = []
2055
                last_revision = self.last_revision()
4496.3.4 by Andrew Bennetts
Tidy up unused and redundant imports in workingtree.py.
2056
                if last_revision != _mod_revision.NULL_REVISION:
2949.2.1 by Robert Collins
* Revert takes out an appropriate lock when reverting to a basis tree, and
2057
                    if basis_tree is None:
2058
                        basis_tree = self.basis_tree()
2059
                        basis_tree.lock_read()
2060
                    parent_trees.append((last_revision, basis_tree))
2061
                self.set_parent_trees(parent_trees)
2062
                resolve(self)
2063
            else:
3017.2.1 by Aaron Bentley
Revert now resolves conflicts recursively (#102739)
2064
                resolve(self, filenames, ignore_misses=True, recursive=True)
2949.2.1 by Robert Collins
* Revert takes out an appropriate lock when reverting to a basis tree, and
2065
        finally:
2066
            if basis_tree is not None:
2067
                basis_tree.unlock()
1558.7.13 by Aaron Bentley
WorkingTree.revert returns conflicts
2068
        return conflicts
1501 by Robert Collins
Move revert from Branch to WorkingTree.
2069
1908.11.2 by Robert Collins
Implement WorkingTree interface conformance tests for
2070
    def revision_tree(self, revision_id):
2071
        """See Tree.revision_tree.
2072
2073
        WorkingTree can supply revision_trees for the basis revision only
2074
        because there is only one cached inventory in the bzr directory.
2075
        """
2076
        if revision_id == self.last_revision():
2077
            try:
2078
                xml = self.read_basis_inventory()
1852.16.5 by John Arbash Meinel
[merge] bzr.dev 2255, resolve conflicts, update copyrights
2079
            except errors.NoSuchFile:
1908.11.2 by Robert Collins
Implement WorkingTree interface conformance tests for
2080
                pass
2081
            else:
1908.11.3 by Robert Collins
Merge bzr.dev
2082
                try:
2255.6.5 by Aaron Bentley
fix revision_tree tests
2083
                    inv = xml7.serializer_v7.read_inventory_from_string(xml)
1908.11.3 by Robert Collins
Merge bzr.dev
2084
                    # dont use the repository revision_tree api because we want
2085
                    # to supply the inventory.
2086
                    if inv.revision_id == revision_id:
1908.11.5 by John Arbash Meinel
[merge] bzr.dev 2240
2087
                        return revisiontree.RevisionTree(self.branch.repository,
1908.11.3 by Robert Collins
Merge bzr.dev
2088
                            inv, revision_id)
2089
                except errors.BadInventoryFormat:
2090
                    pass
1908.11.2 by Robert Collins
Implement WorkingTree interface conformance tests for
2091
        # raise if there was no inventory, or if we read the wrong inventory.
2092
        raise errors.NoSuchRevisionInTree(self, revision_id)
2093
1658.1.3 by Martin Pool
Doc
2094
    # XXX: This method should be deprecated in favour of taking in a proper
2095
    # new Inventory object.
1997.1.3 by Robert Collins
All WorkingTree methods which write to the tree, but not to the branch
2096
    @needs_tree_write_lock
1497 by Robert Collins
Move Branch.read_working_inventory to WorkingTree.
2097
    def set_inventory(self, new_inventory_list):
2098
        from bzrlib.inventory import (Inventory,
2099
                                      InventoryDirectory,
2100
                                      InventoryFile,
2101
                                      InventoryLink)
2102
        inv = Inventory(self.get_root_id())
1658.1.2 by Martin Pool
Revert changes to WorkingTree.set_inventory to unbreak bzrtools
2103
        for path, file_id, parent, kind in new_inventory_list:
1497 by Robert Collins
Move Branch.read_working_inventory to WorkingTree.
2104
            name = os.path.basename(path)
2105
            if name == "":
2106
                continue
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2107
            # fixme, there should be a factory function inv,add_??
1497 by Robert Collins
Move Branch.read_working_inventory to WorkingTree.
2108
            if kind == 'directory':
2109
                inv.add(InventoryDirectory(file_id, name, parent))
2110
            elif kind == 'file':
1658.1.2 by Martin Pool
Revert changes to WorkingTree.set_inventory to unbreak bzrtools
2111
                inv.add(InventoryFile(file_id, name, parent))
1497 by Robert Collins
Move Branch.read_working_inventory to WorkingTree.
2112
            elif kind == 'symlink':
2113
                inv.add(InventoryLink(file_id, name, parent))
2114
            else:
2206.1.7 by Marius Kruger
* errors
2115
                raise errors.BzrError("unknown kind %r" % kind)
1457.1.11 by Robert Collins
Move _write_inventory to WorkingTree.
2116
        self._write_inventory(inv)
1497 by Robert Collins
Move Branch.read_working_inventory to WorkingTree.
2117
1997.1.3 by Robert Collins
All WorkingTree methods which write to the tree, but not to the branch
2118
    @needs_tree_write_lock
1457.1.10 by Robert Collins
Move set_root_id to WorkingTree.
2119
    def set_root_id(self, file_id):
2120
        """Set the root id for this tree."""
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2121
        # for compatability
2858.2.4 by Martin Pool
Restore deprecated behaviour of accepting None for WorkingTree.set_root_id (thanks igc)
2122
        if file_id is None:
3400.3.6 by Martin Pool
Remove code deprecated prior to 1.1 and its tests
2123
            raise ValueError(
2124
                'WorkingTree.set_root_id with fileid=None')
2125
        file_id = osutils.safe_file_id(file_id)
2255.2.15 by Robert Collins
Dirstate - truncate state file fixing bug in saving a smaller file, get more tree_implementation tests passing.
2126
        self._set_root_id(file_id)
2127
2128
    def _set_root_id(self, file_id):
2129
        """Set the root id for this tree, in a format specific manner.
2130
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2131
        :param file_id: The file id to assign to the root. It must not be
2255.2.15 by Robert Collins
Dirstate - truncate state file fixing bug in saving a smaller file, get more tree_implementation tests passing.
2132
            present in the current inventory or an error will occur. It must
2133
            not be None, but rather a valid file id.
2134
        """
1986.5.2 by Robert Collins
``WorkingTree.set_root_id(None)`` is now deprecated. Please
2135
        inv = self._inventory
1457.1.10 by Robert Collins
Move set_root_id to WorkingTree.
2136
        orig_root_id = inv.root.file_id
1986.5.3 by Robert Collins
New method ``WorkingTree.flush()`` which will write the current memory
2137
        # TODO: it might be nice to exit early if there was nothing
2138
        # to do, saving us from trigger a sync on unlock.
2139
        self._inventory_is_modified = True
2140
        # we preserve the root inventory entry object, but
2141
        # unlinkit from the byid index
1457.1.10 by Robert Collins
Move set_root_id to WorkingTree.
2142
        del inv._byid[inv.root.file_id]
2143
        inv.root.file_id = file_id
1986.5.3 by Robert Collins
New method ``WorkingTree.flush()`` which will write the current memory
2144
        # and link it into the index with the new changed id.
1457.1.10 by Robert Collins
Move set_root_id to WorkingTree.
2145
        inv._byid[inv.root.file_id] = inv.root
1986.5.3 by Robert Collins
New method ``WorkingTree.flush()`` which will write the current memory
2146
        # and finally update all children to reference the new id.
2147
        # XXX: this should be safe to just look at the root.children
2148
        # list, not the WHOLE INVENTORY.
1457.1.10 by Robert Collins
Move set_root_id to WorkingTree.
2149
        for fid in inv:
2150
            entry = inv[fid]
1534.4.35 by Robert Collins
Give branch its own basis tree and last_revision methods; deprecated branch.working_tree()
2151
            if entry.parent_id == orig_root_id:
1457.1.10 by Robert Collins
Move set_root_id to WorkingTree.
2152
                entry.parent_id = inv.root.file_id
2153
1442.1.65 by Robert Collins
Branch.remove has been moved to WorkingTree.
2154
    def unlock(self):
2155
        """See Branch.unlock.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2156
1442.1.65 by Robert Collins
Branch.remove has been moved to WorkingTree.
2157
        WorkingTree locking just uses the Branch locking facilities.
2158
        This is current because all working trees have an embedded branch
2159
        within them. IF in the future, we were to make branch data shareable
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2160
        between multiple working trees, i.e. via shared storage, then we
1442.1.65 by Robert Collins
Branch.remove has been moved to WorkingTree.
2161
        would probably want to lock both the local tree, and the branch.
2162
        """
1852.4.2 by Robert Collins
Refactor workingtree.unlock to be cleaner, adding a trivial test for unlock. Introduces an explicit Format2 tree type, making the base WorkingTree cleaner to derive from.
2163
        raise NotImplementedError(self.unlock)
1442.1.65 by Robert Collins
Branch.remove has been moved to WorkingTree.
2164
2806.2.2 by Vincent Ladeuil
Fix #128076 and #131396 by reusing bound branch transport.
2165
    def update(self, change_reporter=None, possible_transports=None):
1587.1.11 by Robert Collins
Local commits appear to be working properly.
2166
        """Update a working tree along its branch.
2167
1731.1.33 by Aaron Bentley
Revert no-special-root changes
2168
        This will update the branch if its bound too, which means we have
2169
        multiple trees involved:
2170
2171
        - The new basis tree of the master.
2172
        - The old basis tree of the branch.
2173
        - The old basis tree of the working tree.
2174
        - The current working tree state.
2175
2176
        Pathologically, all three may be different, and non-ancestors of each
2177
        other.  Conceptually we want to:
2178
2179
        - Preserve the wt.basis->wt.state changes
2180
        - Transform the wt.basis to the new master basis.
2181
        - Apply a merge of the old branch basis to get any 'local' changes from
2182
          it into the tree.
2183
        - Restore the wt.basis->wt.state changes.
1587.1.11 by Robert Collins
Local commits appear to be working properly.
2184
2185
        There isn't a single operation at the moment to do that, so we:
1731.1.33 by Aaron Bentley
Revert no-special-root changes
2186
        - Merge current state -> basis tree of the master w.r.t. the old tree
2187
          basis.
2188
        - Do a 'normal' merge of the old branch basis if it is relevant.
1587.1.11 by Robert Collins
Local commits appear to be working properly.
2189
        """
3280.5.1 by John Arbash Meinel
Avoid opening the master branch when we won't use it.
2190
        if self.branch.get_bound_location() is not None:
2084.2.1 by Aaron Bentley
Support updating lightweight checkouts of readonly branches
2191
            self.lock_write()
2192
            update_branch = True
2193
        else:
2194
            self.lock_tree_write()
2195
            update_branch = False
2196
        try:
2197
            if update_branch:
2806.2.2 by Vincent Ladeuil
Fix #128076 and #131396 by reusing bound branch transport.
2198
                old_tip = self.branch.update(possible_transports)
2084.2.1 by Aaron Bentley
Support updating lightweight checkouts of readonly branches
2199
            else:
2200
                old_tip = None
2504.2.1 by Daniel Watkins
builtins.py now passes a delta._ChangeReporter down the line when update is called, causing the changes the update makes to be displayed.
2201
            return self._update_tree(old_tip, change_reporter)
2084.2.1 by Aaron Bentley
Support updating lightweight checkouts of readonly branches
2202
        finally:
2203
            self.unlock()
2204
2205
    @needs_tree_write_lock
2504.2.1 by Daniel Watkins
builtins.py now passes a delta._ChangeReporter down the line when update is called, causing the changes the update makes to be displayed.
2206
    def _update_tree(self, old_tip=None, change_reporter=None):
2084.2.1 by Aaron Bentley
Support updating lightweight checkouts of readonly branches
2207
        """Update a tree to the master branch.
2208
2209
        :param old_tip: if supplied, the previous tip revision the branch,
2210
            before it was changed to the master branch's tip.
2211
        """
1927.2.3 by Robert Collins
review comment application - paired with Martin.
2212
        # here if old_tip is not None, it is the old tip of the branch before
2213
        # it was updated from the master branch. This should become a pending
2214
        # merge in the working tree to preserve the user existing work.  we
2215
        # cant set that until we update the working trees last revision to be
2216
        # one from the new branch, because it will just get absorbed by the
2217
        # parent de-duplication logic.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2218
        #
1927.2.3 by Robert Collins
review comment application - paired with Martin.
2219
        # We MUST save it even if an error occurs, because otherwise the users
2220
        # local work is unreferenced and will appear to have been lost.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2221
        #
1927.2.3 by Robert Collins
review comment application - paired with Martin.
2222
        result = 0
1908.7.6 by Robert Collins
Deprecate WorkingTree.last_revision.
2223
        try:
2224
            last_rev = self.get_parent_ids()[0]
2225
        except IndexError:
2598.5.1 by Aaron Bentley
Start eliminating the use of None to indicate null revision
2226
            last_rev = _mod_revision.NULL_REVISION
2598.5.4 by Aaron Bentley
Restore original Branch.last_revision behavior, fix bits that care
2227
        if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
1927.2.3 by Robert Collins
review comment application - paired with Martin.
2228
            # merge tree state up to new branch tip.
2229
            basis = self.basis_tree()
2255.2.44 by Robert Collins
Fix tree unlock on readonly Format4 trees with dirty hashcache.
2230
            basis.lock_read()
2231
            try:
2232
                to_tree = self.branch.basis_tree()
2255.6.6 by Aaron Bentley
Fix update to set unique roots, and work with dirstate
2233
                if basis.inventory.root is None:
2946.3.3 by John Arbash Meinel
Prefer tree.get_root_id() as more explicit than tree.path2id('')
2234
                    self.set_root_id(to_tree.get_root_id())
2255.6.6 by Aaron Bentley
Fix update to set unique roots, and work with dirstate
2235
                    self.flush()
2255.2.44 by Robert Collins
Fix tree unlock on readonly Format4 trees with dirty hashcache.
2236
                result += merge.merge_inner(
2237
                                      self.branch,
2238
                                      to_tree,
2239
                                      basis,
2504.2.1 by Daniel Watkins
builtins.py now passes a delta._ChangeReporter down the line when update is called, causing the changes the update makes to be displayed.
2240
                                      this_tree=self,
2241
                                      change_reporter=change_reporter)
2255.2.44 by Robert Collins
Fix tree unlock on readonly Format4 trees with dirty hashcache.
2242
            finally:
2243
                basis.unlock()
1908.6.6 by Robert Collins
Merge updated set_parents api.
2244
            # TODO - dedup parents list with things merged by pull ?
2245
            # reuse the tree we've updated to to set the basis:
2246
            parent_trees = [(self.branch.last_revision(), to_tree)]
2247
            merges = self.get_parent_ids()[1:]
2248
            # Ideally we ask the tree for the trees here, that way the working
4031.3.1 by Frank Aspell
Fixing various typos
2249
            # tree can decide whether to give us the entire tree or give us a
1908.6.6 by Robert Collins
Merge updated set_parents api.
2250
            # lazy initialised tree. dirstate for instance will have the trees
2251
            # in ram already, whereas a last-revision + basis-inventory tree
2252
            # will not, but also does not need them when setting parents.
2253
            for parent in merges:
2254
                parent_trees.append(
2255
                    (parent, self.branch.repository.revision_tree(parent)))
2598.5.3 by Aaron Bentley
Push NULL_REVISION deeper
2256
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
1908.6.6 by Robert Collins
Merge updated set_parents api.
2257
                parent_trees.append(
2258
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
2259
            self.set_parent_trees(parent_trees)
1908.7.6 by Robert Collins
Deprecate WorkingTree.last_revision.
2260
            last_rev = parent_trees[0][0]
1927.2.3 by Robert Collins
review comment application - paired with Martin.
2261
        else:
2262
            # the working tree had the same last-revision as the master
2263
            # branch did. We may still have pivot local work from the local
2264
            # branch into old_tip:
2598.5.3 by Aaron Bentley
Push NULL_REVISION deeper
2265
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
1908.6.7 by Robert Collins
Remove all users of set_pending_merges and add_pending_merge except tests that they work correctly.
2266
                self.add_parent_tree_id(old_tip)
2598.5.3 by Aaron Bentley
Push NULL_REVISION deeper
2267
        if (old_tip is not None and not _mod_revision.is_null(old_tip)
2268
            and old_tip != last_rev):
1927.2.3 by Robert Collins
review comment application - paired with Martin.
2269
            # our last revision was not the prior branch last revision
2270
            # and we have converted that last revision to a pending merge.
2271
            # base is somewhere between the branch tip now
2272
            # and the now pending merge
2255.2.55 by John Arbash Meinel
add extra flush() call to make _update_tree work for dirstate.
2273
2274
            # Since we just modified the working tree and inventory, flush out
2275
            # the current state, before we modify it again.
2276
            # TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2277
            #       requires it only because TreeTransform directly munges the
2278
            #       inventory and calls tree._write_inventory(). Ultimately we
2279
            #       should be able to remove this extra flush.
2280
            self.flush()
2490.2.21 by Aaron Bentley
Rename graph to deprecated_graph
2281
            graph = self.branch.repository.get_graph()
2282
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2283
                                                old_tip)
1927.2.3 by Robert Collins
review comment application - paired with Martin.
2284
            base_tree = self.branch.repository.revision_tree(base_rev_id)
2285
            other_tree = self.branch.repository.revision_tree(old_tip)
1996.3.6 by John Arbash Meinel
Find a few places that weren't importing their dependencies.
2286
            result += merge.merge_inner(
2287
                                  self.branch,
1927.2.3 by Robert Collins
review comment application - paired with Martin.
2288
                                  other_tree,
2289
                                  base_tree,
2504.2.1 by Daniel Watkins
builtins.py now passes a delta._ChangeReporter down the line when update is called, causing the changes the update makes to be displayed.
2290
                                  this_tree=self,
2291
                                  change_reporter=change_reporter)
1927.2.3 by Robert Collins
review comment application - paired with Martin.
2292
        return result
1508.1.24 by Robert Collins
Add update command for use with checkouts.
2293
2201.1.1 by John Arbash Meinel
Fix bug #76299 by ignoring write errors during readonly hashcache write.
2294
    def _write_hashcache_if_dirty(self):
2295
        """Write out the hashcache if it is dirty."""
2296
        if self._hashcache.needs_write:
2297
            try:
2298
                self._hashcache.write()
2299
            except OSError, e:
2300
                if e.errno not in (errno.EPERM, errno.EACCES):
2301
                    raise
2302
                # TODO: jam 20061219 Should this be a warning? A single line
2303
                #       warning might be sufficient to let the user know what
2304
                #       is going on.
2305
                mutter('Could not write hashcache for %s\nError: %s',
2306
                       self._hashcache.cache_file_name(), e)
2307
1997.1.3 by Robert Collins
All WorkingTree methods which write to the tree, but not to the branch
2308
    @needs_tree_write_lock
1457.1.11 by Robert Collins
Move _write_inventory to WorkingTree.
2309
    def _write_inventory(self, inv):
2310
        """Write inventory as the current inventory."""
1986.5.3 by Robert Collins
New method ``WorkingTree.flush()`` which will write the current memory
2311
        self._set_inventory(inv, dirty=True)
2312
        self.flush()
1508.1.19 by Robert Collins
Give format3 working trees their own last-revision marker.
2313
1534.10.22 by Aaron Bentley
Got ConflictList implemented
2314
    def set_conflicts(self, arg):
2206.1.7 by Marius Kruger
* errors
2315
        raise errors.UnsupportedOperation(self.set_conflicts, self)
1534.10.8 by Aaron Bentley
Implemented conflict_lines in terms of old system on WorkingTree
2316
1551.7.11 by Aaron Bentley
Add WorkingTree.add_conflicts
2317
    def add_conflicts(self, arg):
2206.1.7 by Marius Kruger
* errors
2318
        raise errors.UnsupportedOperation(self.add_conflicts, self)
1551.7.11 by Aaron Bentley
Add WorkingTree.add_conflicts
2319
1534.10.8 by Aaron Bentley
Implemented conflict_lines in terms of old system on WorkingTree
2320
    @needs_read_lock
1534.10.22 by Aaron Bentley
Got ConflictList implemented
2321
    def conflicts(self):
1996.3.6 by John Arbash Meinel
Find a few places that weren't importing their dependencies.
2322
        conflicts = _mod_conflicts.ConflictList()
1534.10.9 by Aaron Bentley
Switched display functions to conflict_lines
2323
        for conflicted in self._iter_conflicts():
1534.10.8 by Aaron Bentley
Implemented conflict_lines in terms of old system on WorkingTree
2324
            text = True
2325
            try:
2326
                if file_kind(self.abspath(conflicted)) != "file":
2327
                    text = False
1757.2.4 by Robert Collins
Teach file_kind about NoSuchFile, reducing duplicate code, and add user files before entering the main loop in smart_add.
2328
            except errors.NoSuchFile:
2329
                text = False
1534.10.8 by Aaron Bentley
Implemented conflict_lines in terms of old system on WorkingTree
2330
            if text is True:
2331
                for suffix in ('.THIS', '.OTHER'):
2332
                    try:
2333
                        kind = file_kind(self.abspath(conflicted+suffix))
1757.2.4 by Robert Collins
Teach file_kind about NoSuchFile, reducing duplicate code, and add user files before entering the main loop in smart_add.
2334
                        if kind != "file":
1534.10.8 by Aaron Bentley
Implemented conflict_lines in terms of old system on WorkingTree
2335
                            text = False
1757.2.4 by Robert Collins
Teach file_kind about NoSuchFile, reducing duplicate code, and add user files before entering the main loop in smart_add.
2336
                    except errors.NoSuchFile:
1534.10.8 by Aaron Bentley
Implemented conflict_lines in terms of old system on WorkingTree
2337
                        text = False
1757.2.4 by Robert Collins
Teach file_kind about NoSuchFile, reducing duplicate code, and add user files before entering the main loop in smart_add.
2338
                    if text == False:
1534.10.8 by Aaron Bentley
Implemented conflict_lines in terms of old system on WorkingTree
2339
                        break
2340
            ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1996.3.6 by John Arbash Meinel
Find a few places that weren't importing their dependencies.
2341
            conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2342
                             path=conflicted,
1534.10.22 by Aaron Bentley
Got ConflictList implemented
2343
                             file_id=self.path2id(conflicted)))
2344
        return conflicts
2345
1852.15.3 by Robert Collins
Add a first-cut Tree.walkdirs method.
2346
    def walkdirs(self, prefix=""):
2255.2.18 by Robert Collins
Dirstate: all tree_implementation tests passing.
2347
        """Walk the directories of this tree.
2348
2292.1.25 by Marius Kruger
* Add utility method delta.get_changes_as_text to get the output of .show()
2349
        returns a generator which yields items in the form:
2292.1.30 by Marius Kruger
* Minor text fixes.
2350
                ((curren_directory_path, fileid),
2292.1.25 by Marius Kruger
* Add utility method delta.get_changes_as_text to get the output of .show()
2351
                 [(file1_path, file1_name, file1_kind, (lstat), file1_id,
2352
                   file1_kind), ... ])
2353
2255.2.18 by Robert Collins
Dirstate: all tree_implementation tests passing.
2354
        This API returns a generator, which is only valid during the current
2355
        tree transaction - within a single lock_read or lock_write duration.
2356
2292.1.25 by Marius Kruger
* Add utility method delta.get_changes_as_text to get the output of .show()
2357
        If the tree is not locked, it may cause an error to be raised,
2358
        depending on the tree implementation.
2255.2.18 by Robert Collins
Dirstate: all tree_implementation tests passing.
2359
        """
1852.15.7 by Robert Collins
Start testing behaviour of unknowns in WorkingTree.walkdirs.
2360
        disk_top = self.abspath(prefix)
2361
        if disk_top.endswith('/'):
2362
            disk_top = disk_top[:-1]
2363
        top_strip_len = len(disk_top) + 1
1852.15.11 by Robert Collins
Tree.walkdirs handles missing contents in workingtrees.
2364
        inventory_iterator = self._walkdirs(prefix)
1852.15.7 by Robert Collins
Start testing behaviour of unknowns in WorkingTree.walkdirs.
2365
        disk_iterator = osutils.walkdirs(disk_top, prefix)
1852.15.10 by Robert Collins
Tweak the Tree.walkdirs interface more to be more useful.
2366
        try:
1852.15.11 by Robert Collins
Tree.walkdirs handles missing contents in workingtrees.
2367
            current_disk = disk_iterator.next()
2368
            disk_finished = False
2369
        except OSError, e:
2423.2.1 by Alexander Belchenko
Fix for walkdirs in missing dir with Py2.4 @ win32
2370
            if not (e.errno == errno.ENOENT or
2371
                (sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
1852.15.11 by Robert Collins
Tree.walkdirs handles missing contents in workingtrees.
2372
                raise
2373
            current_disk = None
2374
            disk_finished = True
2375
        try:
1852.15.10 by Robert Collins
Tweak the Tree.walkdirs interface more to be more useful.
2376
            current_inv = inventory_iterator.next()
2377
            inv_finished = False
2378
        except StopIteration:
2379
            current_inv = None
2380
            inv_finished = True
1852.15.7 by Robert Collins
Start testing behaviour of unknowns in WorkingTree.walkdirs.
2381
        while not inv_finished or not disk_finished:
2457.2.3 by Marius Kruger
factor out tuples into better readable variables
2382
            if current_disk:
2383
                ((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2384
                    cur_disk_dir_content) = current_disk
2385
            else:
2386
                ((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2387
                    cur_disk_dir_content) = ((None, None), None)
1852.15.7 by Robert Collins
Start testing behaviour of unknowns in WorkingTree.walkdirs.
2388
            if not disk_finished:
2389
                # strip out .bzr dirs
2457.2.3 by Marius Kruger
factor out tuples into better readable variables
2390
                if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2391
                    len(cur_disk_dir_content) > 0):
2392
                    # osutils.walkdirs can be made nicer -
1852.15.7 by Robert Collins
Start testing behaviour of unknowns in WorkingTree.walkdirs.
2393
                    # yield the path-from-prefix rather than the pathjoined
2394
                    # value.
2457.2.3 by Marius Kruger
factor out tuples into better readable variables
2395
                    bzrdir_loc = bisect_left(cur_disk_dir_content,
2396
                        ('.bzr', '.bzr'))
3719.1.1 by Vincent Ladeuil
Fix bug #272648
2397
                    if (bzrdir_loc < len(cur_disk_dir_content)
4324.5.1 by Jelmer Vernooij
Use utility function to check for control filename rather than assuming it is '.bzr.'
2398
                        and self.bzrdir.is_control_filename(
2399
                            cur_disk_dir_content[bzrdir_loc][0])):
1852.15.7 by Robert Collins
Start testing behaviour of unknowns in WorkingTree.walkdirs.
2400
                        # we dont yield the contents of, or, .bzr itself.
2457.2.3 by Marius Kruger
factor out tuples into better readable variables
2401
                        del cur_disk_dir_content[bzrdir_loc]
1852.15.10 by Robert Collins
Tweak the Tree.walkdirs interface more to be more useful.
2402
            if inv_finished:
2403
                # everything is unknown
1852.15.12 by Robert Collins
WorkingTree.walkdirs handling of changing file kinds, and multi-directory with missing and unknown ordering bugfix.
2404
                direction = 1
1852.15.11 by Robert Collins
Tree.walkdirs handles missing contents in workingtrees.
2405
            elif disk_finished:
2406
                # everything is missing
1852.15.12 by Robert Collins
WorkingTree.walkdirs handling of changing file kinds, and multi-directory with missing and unknown ordering bugfix.
2407
                direction = -1
1852.15.10 by Robert Collins
Tweak the Tree.walkdirs interface more to be more useful.
2408
            else:
2457.2.3 by Marius Kruger
factor out tuples into better readable variables
2409
                direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
1852.15.12 by Robert Collins
WorkingTree.walkdirs handling of changing file kinds, and multi-directory with missing and unknown ordering bugfix.
2410
            if direction > 0:
1852.15.10 by Robert Collins
Tweak the Tree.walkdirs interface more to be more useful.
2411
                # disk is before inventory - unknown
1852.15.11 by Robert Collins
Tree.walkdirs handles missing contents in workingtrees.
2412
                dirblock = [(relpath, basename, kind, stat, None, None) for
2457.2.7 by Marius Kruger
extract method as per review request
2413
                    relpath, basename, kind, stat, top_path in
2457.2.3 by Marius Kruger
factor out tuples into better readable variables
2414
                    cur_disk_dir_content]
2415
                yield (cur_disk_dir_relpath, None), dirblock
1852.15.7 by Robert Collins
Start testing behaviour of unknowns in WorkingTree.walkdirs.
2416
                try:
2417
                    current_disk = disk_iterator.next()
2418
                except StopIteration:
2419
                    disk_finished = True
1852.15.12 by Robert Collins
WorkingTree.walkdirs handling of changing file kinds, and multi-directory with missing and unknown ordering bugfix.
2420
            elif direction < 0:
1852.15.10 by Robert Collins
Tweak the Tree.walkdirs interface more to be more useful.
2421
                # inventory is before disk - missing.
1852.15.11 by Robert Collins
Tree.walkdirs handles missing contents in workingtrees.
2422
                dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2457.2.7 by Marius Kruger
extract method as per review request
2423
                    for relpath, basename, dkind, stat, fileid, kind in
1852.15.11 by Robert Collins
Tree.walkdirs handles missing contents in workingtrees.
2424
                    current_inv[1]]
2425
                yield (current_inv[0][0], current_inv[0][1]), dirblock
1852.15.7 by Robert Collins
Start testing behaviour of unknowns in WorkingTree.walkdirs.
2426
                try:
2427
                    current_inv = inventory_iterator.next()
2428
                except StopIteration:
2429
                    inv_finished = True
2430
            else:
2431
                # versioned present directory
2432
                # merge the inventory and disk data together
2433
                dirblock = []
1852.15.11 by Robert Collins
Tree.walkdirs handles missing contents in workingtrees.
2434
                for relpath, subiterator in itertools.groupby(sorted(
2457.2.7 by Marius Kruger
extract method as per review request
2435
                    current_inv[1] + cur_disk_dir_content,
2457.2.3 by Marius Kruger
factor out tuples into better readable variables
2436
                    key=operator.itemgetter(0)), operator.itemgetter(1)):
1852.15.7 by Robert Collins
Start testing behaviour of unknowns in WorkingTree.walkdirs.
2437
                    path_elements = list(subiterator)
2438
                    if len(path_elements) == 2:
1852.15.12 by Robert Collins
WorkingTree.walkdirs handling of changing file kinds, and multi-directory with missing and unknown ordering bugfix.
2439
                        inv_row, disk_row = path_elements
1852.15.7 by Robert Collins
Start testing behaviour of unknowns in WorkingTree.walkdirs.
2440
                        # versioned, present file
1852.15.12 by Robert Collins
WorkingTree.walkdirs handling of changing file kinds, and multi-directory with missing and unknown ordering bugfix.
2441
                        dirblock.append((inv_row[0],
2442
                            inv_row[1], disk_row[2],
2443
                            disk_row[3], inv_row[4],
2444
                            inv_row[5]))
1852.15.7 by Robert Collins
Start testing behaviour of unknowns in WorkingTree.walkdirs.
2445
                    elif len(path_elements[0]) == 5:
2446
                        # unknown disk file
1852.15.11 by Robert Collins
Tree.walkdirs handles missing contents in workingtrees.
2447
                        dirblock.append((path_elements[0][0],
2448
                            path_elements[0][1], path_elements[0][2],
2449
                            path_elements[0][3], None, None))
2450
                    elif len(path_elements[0]) == 6:
2451
                        # versioned, absent file.
2452
                        dirblock.append((path_elements[0][0],
2453
                            path_elements[0][1], 'unknown', None,
2454
                            path_elements[0][4], path_elements[0][5]))
2455
                    else:
2456
                        raise NotImplementedError('unreachable code')
1852.15.7 by Robert Collins
Start testing behaviour of unknowns in WorkingTree.walkdirs.
2457
                yield current_inv[0], dirblock
2458
                try:
2459
                    current_inv = inventory_iterator.next()
2460
                except StopIteration:
2461
                    inv_finished = True
2462
                try:
2463
                    current_disk = disk_iterator.next()
2464
                except StopIteration:
2465
                    disk_finished = True
2466
2467
    def _walkdirs(self, prefix=""):
2292.1.25 by Marius Kruger
* Add utility method delta.get_changes_as_text to get the output of .show()
2468
        """Walk the directories of this tree.
2469
2470
           :prefix: is used as the directrory to start with.
2471
           returns a generator which yields items in the form:
2292.1.30 by Marius Kruger
* Minor text fixes.
2472
                ((curren_directory_path, fileid),
2292.1.25 by Marius Kruger
* Add utility method delta.get_changes_as_text to get the output of .show()
2473
                 [(file1_path, file1_name, file1_kind, None, file1_id,
2474
                   file1_kind), ... ])
2475
        """
1852.15.3 by Robert Collins
Add a first-cut Tree.walkdirs method.
2476
        _directory = 'directory'
1852.15.10 by Robert Collins
Tweak the Tree.walkdirs interface more to be more useful.
2477
        # get the root in the inventory
1852.15.3 by Robert Collins
Add a first-cut Tree.walkdirs method.
2478
        inv = self.inventory
1852.15.10 by Robert Collins
Tweak the Tree.walkdirs interface more to be more useful.
2479
        top_id = inv.path2id(prefix)
2480
        if top_id is None:
2481
            pending = []
2482
        else:
2483
            pending = [(prefix, '', _directory, None, top_id, None)]
1852.15.3 by Robert Collins
Add a first-cut Tree.walkdirs method.
2484
        while pending:
2485
            dirblock = []
2486
            currentdir = pending.pop()
1852.15.10 by Robert Collins
Tweak the Tree.walkdirs interface more to be more useful.
2487
            # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2488
            top_id = currentdir[4]
1852.15.3 by Robert Collins
Add a first-cut Tree.walkdirs method.
2489
            if currentdir[0]:
2490
                relroot = currentdir[0] + '/'
2491
            else:
2492
                relroot = ""
2493
            # FIXME: stash the node in pending
1852.15.10 by Robert Collins
Tweak the Tree.walkdirs interface more to be more useful.
2494
            entry = inv[top_id]
3585.2.4 by Robert Collins
* Deleting directories by hand before running ``bzr rm`` will not
2495
            if entry.kind == 'directory':
2496
                for name, child in entry.sorted_children():
2497
                    dirblock.append((relroot + name, name, child.kind, None,
2498
                        child.file_id, child.kind
2499
                        ))
1852.15.10 by Robert Collins
Tweak the Tree.walkdirs interface more to be more useful.
2500
            yield (currentdir[0], entry.file_id), dirblock
1852.15.3 by Robert Collins
Add a first-cut Tree.walkdirs method.
2501
            # push the user specified dirs from dirblock
2502
            for dir in reversed(dirblock):
2503
                if dir[2] == _directory:
2504
                    pending.append(dir)
2505
2120.7.2 by Aaron Bentley
Move autoresolve functionality to workingtree
2506
    @needs_tree_write_lock
2507
    def auto_resolve(self):
2508
        """Automatically resolve text conflicts according to contents.
2509
2510
        Only text conflicts are auto_resolvable. Files with no conflict markers
2511
        are considered 'resolved', because bzr always puts conflict markers
2512
        into files that have text conflicts.  The corresponding .THIS .BASE and
2513
        .OTHER files are deleted, as per 'resolve'.
2514
        :return: a tuple of ConflictLists: (un_resolved, resolved).
2515
        """
2516
        un_resolved = _mod_conflicts.ConflictList()
2517
        resolved = _mod_conflicts.ConflictList()
2518
        conflict_re = re.compile('^(<{7}|={7}|>{7})')
2519
        for conflict in self.conflicts():
2120.7.3 by Aaron Bentley
Update resolve command to automatically mark conflicts as resolved
2520
            if (conflict.typestring != 'text conflict' or
2521
                self.kind(conflict.file_id) != 'file'):
2120.7.2 by Aaron Bentley
Move autoresolve functionality to workingtree
2522
                un_resolved.append(conflict)
2523
                continue
2524
            my_file = open(self.id2abspath(conflict.file_id), 'rb')
2525
            try:
2526
                for line in my_file:
2527
                    if conflict_re.search(line):
2528
                        un_resolved.append(conflict)
2529
                        break
2530
                else:
2531
                    resolved.append(conflict)
2532
            finally:
2533
                my_file.close()
2534
        resolved.remove_files(self)
2535
        self.set_conflicts(un_resolved)
2536
        return un_resolved, resolved
2537
3015.3.30 by Daniel Watkins
Moved check to WorkingTree.
2538
    @needs_read_lock
3015.3.58 by Daniel Watkins
Various other cleanup as requested by reviews.
2539
    def _check(self):
3015.3.30 by Daniel Watkins
Moved check to WorkingTree.
2540
        tree_basis = self.basis_tree()
2541
        tree_basis.lock_read()
2542
        try:
2543
            repo_basis = self.branch.repository.revision_tree(
2544
                self.last_revision())
3015.3.58 by Daniel Watkins
Various other cleanup as requested by reviews.
2545
            if len(list(repo_basis.iter_changes(tree_basis))) > 0:
3015.3.30 by Daniel Watkins
Moved check to WorkingTree.
2546
                raise errors.BzrCheckError(
2547
                    "Mismatched basis inventory content.")
2548
            self._validate()
2549
        finally:
2550
            tree_basis.unlock()
2551
2371.2.1 by John Arbash Meinel
Update DirState._validate() to detect rename errors.
2552
    def _validate(self):
2553
        """Validate internal structures.
2554
2555
        This is meant mostly for the test suite. To give it a chance to detect
2556
        corruption after actions have occurred. The default implementation is a
2557
        just a no-op.
2558
2559
        :return: None. An exception should be raised if there is an error.
2560
        """
2561
        return
2562
3398.1.24 by Ian Clatworthy
make iter_search_rules a tree method
2563
    @needs_read_lock
2564
    def _get_rules_searcher(self, default_searcher):
2565
        """See Tree._get_rules_searcher."""
2566
        if self._rules_searcher is None:
2567
            self._rules_searcher = super(WorkingTree,
2568
                self)._get_rules_searcher(default_searcher)
2569
        return self._rules_searcher
2570
0.12.68 by Aaron Bentley
Update docs, move items to proper files.
2571
    def get_shelf_manager(self):
2572
        """Return the ShelfManager for this WorkingTree."""
2573
        from bzrlib.shelf import ShelfManager
2574
        return ShelfManager(self, self._transport)
2575
1508.1.19 by Robert Collins
Give format3 working trees their own last-revision marker.
2576
1852.4.2 by Robert Collins
Refactor workingtree.unlock to be cleaner, adding a trivial test for unlock. Introduces an explicit Format2 tree type, making the base WorkingTree cleaner to derive from.
2577
class WorkingTree2(WorkingTree):
2578
    """This is the Format 2 working tree.
2579
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2580
    This was the first weave based working tree.
1852.4.2 by Robert Collins
Refactor workingtree.unlock to be cleaner, adding a trivial test for unlock. Introduces an explicit Format2 tree type, making the base WorkingTree cleaner to derive from.
2581
     - uses os locks for locking.
2582
     - uses the branch last-revision.
2583
    """
2584
2334.1.4 by John Arbash Meinel
WT2 needs to have an _inventory without a lock.
2585
    def __init__(self, *args, **kwargs):
2586
        super(WorkingTree2, self).__init__(*args, **kwargs)
2587
        # WorkingTree2 has more of a constraint that self._inventory must
2588
        # exist. Because this is an older format, we don't mind the overhead
2589
        # caused by the extra computation here.
2590
2591
        # Newer WorkingTree's should only have self._inventory set when they
2592
        # have a read lock.
2593
        if self._inventory is None:
2594
            self.read_working_inventory()
2595
1997.1.1 by Robert Collins
Add WorkingTree.lock_tree_write.
2596
    def lock_tree_write(self):
2597
        """See WorkingTree.lock_tree_write().
2598
2599
        In Format2 WorkingTrees we have a single lock for the branch and tree
2600
        so lock_tree_write() degrades to lock_write().
2601
        """
2602
        self.branch.lock_write()
2603
        try:
2604
            return self._control_files.lock_write()
2605
        except:
2606
            self.branch.unlock()
2607
            raise
2608
1852.4.2 by Robert Collins
Refactor workingtree.unlock to be cleaner, adding a trivial test for unlock. Introduces an explicit Format2 tree type, making the base WorkingTree cleaner to derive from.
2609
    def unlock(self):
2665.3.3 by Daniel Watkins
Added _cleanup() to the unlock() method of all implementations of WorkingTree so that the cached ignore definitions are wiped when a lock is lost.
2610
        # do non-implementation specific cleanup
2611
        self._cleanup()
2612
1852.4.2 by Robert Collins
Refactor workingtree.unlock to be cleaner, adding a trivial test for unlock. Introduces an explicit Format2 tree type, making the base WorkingTree cleaner to derive from.
2613
        # we share control files:
1986.5.3 by Robert Collins
New method ``WorkingTree.flush()`` which will write the current memory
2614
        if self._control_files._lock_count == 3:
2615
            # _inventory_is_modified is always False during a read lock.
2616
            if self._inventory_is_modified:
2617
                self.flush()
2201.1.1 by John Arbash Meinel
Fix bug #76299 by ignoring write errors during readonly hashcache write.
2618
            self._write_hashcache_if_dirty()
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2619
1852.4.2 by Robert Collins
Refactor workingtree.unlock to be cleaner, adding a trivial test for unlock. Introduces an explicit Format2 tree type, making the base WorkingTree cleaner to derive from.
2620
        # reverse order of locking.
2621
        try:
2622
            return self._control_files.unlock()
2623
        finally:
2624
            self.branch.unlock()
2625
2626
1508.1.19 by Robert Collins
Give format3 working trees their own last-revision marker.
2627
class WorkingTree3(WorkingTree):
2628
    """This is the Format 3 working tree.
2629
2630
    This differs from the base WorkingTree by:
2631
     - having its own file lock
2632
     - having its own last-revision property.
1553.5.74 by Martin Pool
Convert WorkingTree format3 to use LockDirs
2633
2634
    This is new in bzr 0.8
1508.1.19 by Robert Collins
Give format3 working trees their own last-revision marker.
2635
    """
2636
2637
    @needs_read_lock
1908.7.6 by Robert Collins
Deprecate WorkingTree.last_revision.
2638
    def _last_revision(self):
1986.1.6 by Robert Collins
Add MemoryTree.last_revision.
2639
        """See Mutable.last_revision."""
1508.1.19 by Robert Collins
Give format3 working trees their own last-revision marker.
2640
        try:
3407.2.1 by Martin Pool
Deprecate LockableFiles.get
2641
            return self._transport.get_bytes('last-revision')
2206.1.7 by Marius Kruger
* errors
2642
        except errors.NoSuchFile:
2598.5.10 by Aaron Bentley
Return NULL_REVISION instead of None for the null revision
2643
            return _mod_revision.NULL_REVISION
1508.1.19 by Robert Collins
Give format3 working trees their own last-revision marker.
2644
2645
    def _change_last_revision(self, revision_id):
2646
        """See WorkingTree._change_last_revision."""
4496.3.4 by Andrew Bennetts
Tidy up unused and redundant imports in workingtree.py.
2647
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
1508.1.19 by Robert Collins
Give format3 working trees their own last-revision marker.
2648
            try:
3407.2.14 by Martin Pool
Remove more cases of getting transport via control_files
2649
                self._transport.delete('last-revision')
1508.1.19 by Robert Collins
Give format3 working trees their own last-revision marker.
2650
            except errors.NoSuchFile:
2651
                pass
2652
            return False
2653
        else:
3407.2.7 by Martin Pool
Deprecate LockableFiles.put_utf8 and put_bytes.
2654
            self._transport.put_bytes('last-revision', revision_id,
3407.2.18 by Martin Pool
BzrDir takes responsibility for default file/dir modes
2655
                mode=self.bzrdir._get_file_mode())
1508.1.19 by Robert Collins
Give format3 working trees their own last-revision marker.
2656
            return True
2657
1997.1.3 by Robert Collins
All WorkingTree methods which write to the tree, but not to the branch
2658
    @needs_tree_write_lock
1534.10.22 by Aaron Bentley
Got ConflictList implemented
2659
    def set_conflicts(self, conflicts):
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2660
        self._put_rio('conflicts', conflicts.to_stanzas(),
1534.10.21 by Aaron Bentley
Moved and renamed conflict functions
2661
                      CONFLICT_HEADER_1)
1534.10.6 by Aaron Bentley
Conflict serialization working for WorkingTree3
2662
1997.1.3 by Robert Collins
All WorkingTree methods which write to the tree, but not to the branch
2663
    @needs_tree_write_lock
1551.7.11 by Aaron Bentley
Add WorkingTree.add_conflicts
2664
    def add_conflicts(self, new_conflicts):
2665
        conflict_set = set(self.conflicts())
2666
        conflict_set.update(set(list(new_conflicts)))
1996.3.6 by John Arbash Meinel
Find a few places that weren't importing their dependencies.
2667
        self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2668
                                       key=_mod_conflicts.Conflict.sort_key)))
1551.7.11 by Aaron Bentley
Add WorkingTree.add_conflicts
2669
1534.10.6 by Aaron Bentley
Conflict serialization working for WorkingTree3
2670
    @needs_read_lock
1534.10.22 by Aaron Bentley
Got ConflictList implemented
2671
    def conflicts(self):
1534.10.6 by Aaron Bentley
Conflict serialization working for WorkingTree3
2672
        try:
3407.2.1 by Martin Pool
Deprecate LockableFiles.get
2673
            confile = self._transport.get('conflicts')
2206.1.7 by Marius Kruger
* errors
2674
        except errors.NoSuchFile:
1996.3.6 by John Arbash Meinel
Find a few places that weren't importing their dependencies.
2675
            return _mod_conflicts.ConflictList()
1534.10.6 by Aaron Bentley
Conflict serialization working for WorkingTree3
2676
        try:
3619.6.2 by Mark Hammond
ensure the conflict list file is closed before returning.
2677
            try:
2678
                if confile.next() != CONFLICT_HEADER_1 + '\n':
2679
                    raise errors.ConflictFormatError()
2680
            except StopIteration:
2206.1.7 by Marius Kruger
* errors
2681
                raise errors.ConflictFormatError()
3619.6.2 by Mark Hammond
ensure the conflict list file is closed before returning.
2682
            return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2683
        finally:
2684
            confile.close()
1534.10.6 by Aaron Bentley
Conflict serialization working for WorkingTree3
2685
1852.4.2 by Robert Collins
Refactor workingtree.unlock to be cleaner, adding a trivial test for unlock. Introduces an explicit Format2 tree type, making the base WorkingTree cleaner to derive from.
2686
    def unlock(self):
2665.3.3 by Daniel Watkins
Added _cleanup() to the unlock() method of all implementations of WorkingTree so that the cached ignore definitions are wiped when a lock is lost.
2687
        # do non-implementation specific cleanup
2688
        self._cleanup()
1986.5.3 by Robert Collins
New method ``WorkingTree.flush()`` which will write the current memory
2689
        if self._control_files._lock_count == 1:
2690
            # _inventory_is_modified is always False during a read lock.
2691
            if self._inventory_is_modified:
2692
                self.flush()
2201.1.1 by John Arbash Meinel
Fix bug #76299 by ignoring write errors during readonly hashcache write.
2693
            self._write_hashcache_if_dirty()
1852.4.2 by Robert Collins
Refactor workingtree.unlock to be cleaner, adding a trivial test for unlock. Introduces an explicit Format2 tree type, making the base WorkingTree cleaner to derive from.
2694
        # reverse order of locking.
2695
        try:
2696
            return self._control_files.unlock()
2697
        finally:
2698
            self.branch.unlock()
2699
1534.10.6 by Aaron Bentley
Conflict serialization working for WorkingTree3
2700
1185.14.6 by Aaron Bentley
Made iter_conflicts a WorkingTree method
2701
def get_conflicted_stem(path):
1996.3.6 by John Arbash Meinel
Find a few places that weren't importing their dependencies.
2702
    for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
1185.14.6 by Aaron Bentley
Made iter_conflicts a WorkingTree method
2703
        if path.endswith(suffix):
2704
            return path[:-len(suffix)]
1534.4.41 by Robert Collins
Branch now uses BzrDir reasonably sanely.
2705
2255.2.3 by Robert Collins
Split out working tree format 4 to its own file, create stub dirstate revision object, start working on dirstate.set_parent_trees - a key failure point.
2706
1534.4.45 by Robert Collins
Start WorkingTree -> .bzr/checkout transition
2707
class WorkingTreeFormat(object):
2708
    """An encapsulation of the initialization and open routines for a format.
2709
2710
    Formats provide three things:
2711
     * An initialization routine,
2712
     * a format string,
2713
     * an open routine.
2714
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2715
    Formats are placed in an dict by their format string for reference
1534.4.45 by Robert Collins
Start WorkingTree -> .bzr/checkout transition
2716
    during workingtree opening. Its not required that these be instances, they
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2717
    can be classes themselves with class methods - it simply depends on
1534.4.45 by Robert Collins
Start WorkingTree -> .bzr/checkout transition
2718
    whether state is needed for a given format or not.
2719
2720
    Once a format is deprecated, just deprecate the initialize and open
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2721
    methods on the format class. Do not deprecate the object, as the
1534.4.45 by Robert Collins
Start WorkingTree -> .bzr/checkout transition
2722
    object will be created every time regardless.
2723
    """
2724
1534.4.46 by Robert Collins
Nearly complete .bzr/checkout splitout.
2725
    _default_format = None
2726
    """The default format used for new trees."""
2727
2728
    _formats = {}
2729
    """The known formats."""
2730
2100.3.14 by Aaron Bentley
Test workingtree4 format, prevent use with old repos
2731
    requires_rich_root = False
2732
2323.6.4 by Martin Pool
BzrDir._check_supported now also takes care of recommending upgrades, which
2733
    upgrade_recommended = False
2734
1534.4.46 by Robert Collins
Nearly complete .bzr/checkout splitout.
2735
    @classmethod
2736
    def find_format(klass, a_bzrdir):
2737
        """Return the format for the working tree object in a_bzrdir."""
2738
        try:
2739
            transport = a_bzrdir.get_workingtree_transport(None)
2740
            format_string = transport.get("format").read()
2741
            return klass._formats[format_string]
2206.1.7 by Marius Kruger
* errors
2742
        except errors.NoSuchFile:
1508.1.19 by Robert Collins
Give format3 working trees their own last-revision marker.
2743
            raise errors.NoWorkingTree(base=transport.base)
1534.4.46 by Robert Collins
Nearly complete .bzr/checkout splitout.
2744
        except KeyError:
3246.3.2 by Daniel Watkins
Modified uses of errors.UnknownFormatError.
2745
            raise errors.UnknownFormatError(format=format_string,
2746
                                            kind="working tree")
1534.4.46 by Robert Collins
Nearly complete .bzr/checkout splitout.
2747
2100.3.35 by Aaron Bentley
equality operations on bzrdir
2748
    def __eq__(self, other):
2749
        return self.__class__ is other.__class__
2750
2751
    def __ne__(self, other):
2752
        return not (self == other)
2753
1534.4.46 by Robert Collins
Nearly complete .bzr/checkout splitout.
2754
    @classmethod
2755
    def get_default_format(klass):
2756
        """Return the current default format."""
2757
        return klass._default_format
2758
1534.4.45 by Robert Collins
Start WorkingTree -> .bzr/checkout transition
2759
    def get_format_string(self):
2760
        """Return the ASCII format string that identifies this format."""
2761
        raise NotImplementedError(self.get_format_string)
2762
1624.3.19 by Olaf Conradi
New call get_format_description to give a user-friendly description of a
2763
    def get_format_description(self):
2764
        """Return the short description for this format."""
2765
        raise NotImplementedError(self.get_format_description)
2766
1534.4.46 by Robert Collins
Nearly complete .bzr/checkout splitout.
2767
    def is_supported(self):
2768
        """Is this format supported?
2769
2770
        Supported formats can be initialized and opened.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2771
        Unsupported formats may not support initialization or committing or
1534.4.46 by Robert Collins
Nearly complete .bzr/checkout splitout.
2772
        some other features depending on the reason for not being supported.
2773
        """
2774
        return True
2775
3907.2.1 by Ian Clatworthy
WorkingTreeFormat5 supporting content filtering and views
2776
    def supports_content_filtering(self):
2777
        """True if this format supports content filtering."""
2778
        return False
2779
3586.1.4 by Ian Clatworthy
first cut at tree-level view tests
2780
    def supports_views(self):
2781
        """True if this format supports stored views."""
2782
        return False
2783
1534.4.46 by Robert Collins
Nearly complete .bzr/checkout splitout.
2784
    @classmethod
2785
    def register_format(klass, format):
2786
        klass._formats[format.get_format_string()] = format
2787
2788
    @classmethod
2789
    def set_default_format(klass, format):
2790
        klass._default_format = format
2791
2792
    @classmethod
2793
    def unregister_format(klass, format):
2794
        del klass._formats[format.get_format_string()]
2795
1534.4.45 by Robert Collins
Start WorkingTree -> .bzr/checkout transition
2796
2797
class WorkingTreeFormat2(WorkingTreeFormat):
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2798
    """The second working tree format.
1534.4.42 by Robert Collins
add working tree to the BzrDir facilities.
2799
2800
    This format modified the hash cache from the format 1 hash cache.
2801
    """
2802
2323.6.4 by Martin Pool
BzrDir._check_supported now also takes care of recommending upgrades, which
2803
    upgrade_recommended = True
2804
1624.3.19 by Olaf Conradi
New call get_format_description to give a user-friendly description of a
2805
    def get_format_description(self):
2806
        """See WorkingTreeFormat.get_format_description()."""
2807
        return "Working tree format 2"
2808
3650.5.7 by Aaron Bentley
Fix working tree initialization
2809
    def _stub_initialize_on_transport(self, transport, file_mode):
3650.5.6 by Aaron Bentley
Fix cloning problems by creating missing working tree files
2810
        """Workaround: create control files for a remote working tree.
2811
1692.7.9 by Martin Pool
Don't create broken standalone branches over sftp (Malone #43064)
2812
        This ensures that it can later be updated and dealt with locally,
3650.5.6 by Aaron Bentley
Fix cloning problems by creating missing working tree files
2813
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
1692.7.9 by Martin Pool
Don't create broken standalone branches over sftp (Malone #43064)
2814
        no working tree.  (See bug #43064).
2815
        """
2816
        sio = StringIO()
4496.3.4 by Andrew Bennetts
Tidy up unused and redundant imports in workingtree.py.
2817
        inv = inventory.Inventory()
2817.2.1 by Robert Collins
* Inventory serialisation no longer double-sha's the content.
2818
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
1692.7.9 by Martin Pool
Don't create broken standalone branches over sftp (Malone #43064)
2819
        sio.seek(0)
3650.5.7 by Aaron Bentley
Fix working tree initialization
2820
        transport.put_file('inventory', sio, file_mode)
2821
        transport.put_bytes('pending-merges', '', file_mode)
1692.7.9 by Martin Pool
Don't create broken standalone branches over sftp (Malone #43064)
2822
3123.5.3 by Aaron Bentley
Get tests passing with accelerator_tree
2823
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
3136.1.3 by Aaron Bentley
Implement hard-link support for branch and checkout
2824
                   accelerator_tree=None, hardlink=False):
1534.4.42 by Robert Collins
add working tree to the BzrDir facilities.
2825
        """See WorkingTreeFormat.initialize()."""
2826
        if not isinstance(a_bzrdir.transport, LocalTransport):
2827
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2955.5.3 by Vincent Ladeuil
Fix second unwanted connection by providing the right branch to create_checkout.
2828
        if from_branch is not None:
2829
            branch = from_branch
2830
        else:
2831
            branch = a_bzrdir.open_branch()
2598.5.4 by Aaron Bentley
Restore original Branch.last_revision behavior, fix bits that care
2832
        if revision_id is None:
2833
            revision_id = _mod_revision.ensure_null(branch.last_revision())
2834
        branch.lock_write()
2835
        try:
2836
            branch.generate_revision_history(revision_id)
2837
        finally:
2838
            branch.unlock()
4496.3.4 by Andrew Bennetts
Tidy up unused and redundant imports in workingtree.py.
2839
        inv = inventory.Inventory()
1852.4.2 by Robert Collins
Refactor workingtree.unlock to be cleaner, adding a trivial test for unlock. Introduces an explicit Format2 tree type, making the base WorkingTree cleaner to derive from.
2840
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
2841
                         branch,
2842
                         inv,
2843
                         _internal=True,
1534.4.51 by Robert Collins
Test the disk layout of format3 working trees.
2844
                         _format=self,
2845
                         _bzrdir=a_bzrdir)
2598.5.4 by Aaron Bentley
Restore original Branch.last_revision behavior, fix bits that care
2846
        basis_tree = branch.repository.revision_tree(revision_id)
1731.1.33 by Aaron Bentley
Revert no-special-root changes
2847
        if basis_tree.inventory.root is not None:
2946.3.3 by John Arbash Meinel
Prefer tree.get_root_id() as more explicit than tree.path2id('')
2848
            wt.set_root_id(basis_tree.get_root_id())
1986.5.8 by Robert Collins
Merge bzr.dev.
2849
        # set the parent list and cache the basis tree.
2598.5.4 by Aaron Bentley
Restore original Branch.last_revision behavior, fix bits that care
2850
        if _mod_revision.is_null(revision_id):
2598.5.2 by Aaron Bentley
Got all tests passing with Branch returning 'null:' for null revision
2851
            parent_trees = []
2852
        else:
2598.5.4 by Aaron Bentley
Restore original Branch.last_revision behavior, fix bits that care
2853
            parent_trees = [(revision_id, basis_tree)]
2598.5.2 by Aaron Bentley
Got all tests passing with Branch returning 'null:' for null revision
2854
        wt.set_parent_trees(parent_trees)
1996.3.6 by John Arbash Meinel
Find a few places that weren't importing their dependencies.
2855
        transform.build_tree(basis_tree, wt)
1534.4.46 by Robert Collins
Nearly complete .bzr/checkout splitout.
2856
        return wt
2857
2858
    def __init__(self):
2859
        super(WorkingTreeFormat2, self).__init__()
2860
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
1534.4.42 by Robert Collins
add working tree to the BzrDir facilities.
2861
2862
    def open(self, a_bzrdir, _found=False):
2863
        """Return the WorkingTree object for a_bzrdir
2864
2865
        _found is a private parameter, do not use it. It is used to indicate
2866
               if format probing has already been done.
2867
        """
2868
        if not _found:
2869
            # we are being called directly and must probe.
2870
            raise NotImplementedError
1534.4.46 by Robert Collins
Nearly complete .bzr/checkout splitout.
2871
        if not isinstance(a_bzrdir.transport, LocalTransport):
2872
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2323.6.4 by Martin Pool
BzrDir._check_supported now also takes care of recommending upgrades, which
2873
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1534.4.51 by Robert Collins
Test the disk layout of format3 working trees.
2874
                           _internal=True,
2875
                           _format=self,
2876
                           _bzrdir=a_bzrdir)
2323.6.4 by Martin Pool
BzrDir._check_supported now also takes care of recommending upgrades, which
2877
        return wt
1534.4.45 by Robert Collins
Start WorkingTree -> .bzr/checkout transition
2878
2879
class WorkingTreeFormat3(WorkingTreeFormat):
2880
    """The second working tree format updated to record a format marker.
2881
1553.5.74 by Martin Pool
Convert WorkingTree format3 to use LockDirs
2882
    This format:
2883
        - exists within a metadir controlling .bzr
2884
        - includes an explicit version marker for the workingtree control
2885
          files, separate from the BzrDir format
2886
        - modifies the hash cache format
2887
        - is new in bzr 0.8
1852.3.1 by Robert Collins
Trivial cleanups to workingtree.py
2888
        - uses a LockDir to guard access for writes.
1534.4.45 by Robert Collins
Start WorkingTree -> .bzr/checkout transition
2889
    """
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2890
2323.6.4 by Martin Pool
BzrDir._check_supported now also takes care of recommending upgrades, which
2891
    upgrade_recommended = True
1534.4.45 by Robert Collins
Start WorkingTree -> .bzr/checkout transition
2892
2893
    def get_format_string(self):
2894
        """See WorkingTreeFormat.get_format_string()."""
1553.5.81 by Martin Pool
Revert change to WorkingTreeFormat3 format string; too many things want it the old way
2895
        return "Bazaar-NG Working Tree format 3"
1534.4.45 by Robert Collins
Start WorkingTree -> .bzr/checkout transition
2896
1624.3.19 by Olaf Conradi
New call get_format_description to give a user-friendly description of a
2897
    def get_format_description(self):
2898
        """See WorkingTreeFormat.get_format_description()."""
2899
        return "Working tree format 3"
2900
1553.5.74 by Martin Pool
Convert WorkingTree format3 to use LockDirs
2901
    _lock_file_name = 'lock'
2902
    _lock_class = LockDir
2903
2100.3.3 by Aaron Bentley
Start of work on format 4 trees
2904
    _tree_class = WorkingTree3
1553.5.74 by Martin Pool
Convert WorkingTree format3 to use LockDirs
2905
2100.3.15 by Aaron Bentley
get test suite passing
2906
    def __get_matchingbzrdir(self):
2907
        return bzrdir.BzrDirMetaFormat1()
2908
2909
    _matchingbzrdir = property(__get_matchingbzrdir)
2910
1553.5.74 by Martin Pool
Convert WorkingTree format3 to use LockDirs
2911
    def _open_control_files(self, a_bzrdir):
2912
        transport = a_bzrdir.get_workingtree_transport(None)
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2913
        return LockableFiles(transport, self._lock_file_name,
1553.5.74 by Martin Pool
Convert WorkingTree format3 to use LockDirs
2914
                             self._lock_class)
2915
3123.5.3 by Aaron Bentley
Get tests passing with accelerator_tree
2916
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
3136.1.3 by Aaron Bentley
Implement hard-link support for branch and checkout
2917
                   accelerator_tree=None, hardlink=False):
1508.1.21 by Robert Collins
Implement -r limit for checkout command.
2918
        """See WorkingTreeFormat.initialize().
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2919
3123.5.17 by Aaron Bentley
Update docs
2920
        :param revision_id: if supplied, create a working tree at a different
2921
            revision than the branch is at.
2922
        :param accelerator_tree: A tree which can be used for retrieving file
2923
            contents more quickly than the revision tree, i.e. a workingtree.
2924
            The revision tree will be used for cases where accelerator_tree's
2925
            content is different.
3136.1.3 by Aaron Bentley
Implement hard-link support for branch and checkout
2926
        :param hardlink: If true, hard-link files from accelerator_tree,
2927
            where possible.
1508.1.21 by Robert Collins
Implement -r limit for checkout command.
2928
        """
1534.4.45 by Robert Collins
Start WorkingTree -> .bzr/checkout transition
2929
        if not isinstance(a_bzrdir.transport, LocalTransport):
2930
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
1534.4.46 by Robert Collins
Nearly complete .bzr/checkout splitout.
2931
        transport = a_bzrdir.get_workingtree_transport(self)
1553.5.74 by Martin Pool
Convert WorkingTree format3 to use LockDirs
2932
        control_files = self._open_control_files(a_bzrdir)
2933
        control_files.create_lock()
1607.1.14 by Robert Collins
Reduce lock thrashing somewhat - drops bound branch tests lock count from 6554 to 4456 locks.
2934
        control_files.lock_write()
3407.2.5 by Martin Pool
Deprecate LockableFiles.put_utf8
2935
        transport.put_bytes('format', self.get_format_string(),
3407.2.18 by Martin Pool
BzrDir takes responsibility for default file/dir modes
2936
            mode=a_bzrdir._get_file_mode())
2955.5.3 by Vincent Ladeuil
Fix second unwanted connection by providing the right branch to create_checkout.
2937
        if from_branch is not None:
2938
            branch = from_branch
2939
        else:
2940
            branch = a_bzrdir.open_branch()
1508.1.21 by Robert Collins
Implement -r limit for checkout command.
2941
        if revision_id is None:
2598.5.7 by Aaron Bentley
Updates from review
2942
            revision_id = _mod_revision.ensure_null(branch.last_revision())
2084.1.1 by John Arbash Meinel
Don't create new working trees with unique roots, because it breaks older versions of bzr
2943
        # WorkingTree3 can handle an inventory which has a unique root id.
2944
        # as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2945
        # those trees. And because there isn't a format bump inbetween, we
2946
        # are maintaining compatibility with older clients.
2947
        # inv = Inventory(root_id=gen_root_id())
2100.3.12 by Aaron Bentley
Stop generating unique roots for WorkingTree3
2948
        inv = self._initial_inventory()
2100.3.8 by Aaron Bentley
Add add_reference
2949
        wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
1534.4.50 by Robert Collins
Got the bzrdir api straightened out, plenty of refactoring to use it pending, but the api is up and running.
2950
                         branch,
2951
                         inv,
2952
                         _internal=True,
1534.4.51 by Robert Collins
Test the disk layout of format3 working trees.
2953
                         _format=self,
1553.5.74 by Martin Pool
Convert WorkingTree format3 to use LockDirs
2954
                         _bzrdir=a_bzrdir,
2955
                         _control_files=control_files)
1997.1.4 by Robert Collins
``bzr checkout --lightweight`` now operates on readonly branches as well
2956
        wt.lock_tree_write()
1607.1.14 by Robert Collins
Reduce lock thrashing somewhat - drops bound branch tests lock count from 6554 to 4456 locks.
2957
        try:
1908.6.1 by Robert Collins
Change all callers of set_last_revision to use set_parent_trees.
2958
            basis_tree = branch.repository.revision_tree(revision_id)
1986.5.8 by Robert Collins
Merge bzr.dev.
2959
            # only set an explicit root id if there is one to set.
2960
            if basis_tree.inventory.root is not None:
2946.3.3 by John Arbash Meinel
Prefer tree.get_root_id() as more explicit than tree.path2id('')
2961
                wt.set_root_id(basis_tree.get_root_id())
4496.3.4 by Andrew Bennetts
Tidy up unused and redundant imports in workingtree.py.
2962
            if revision_id == _mod_revision.NULL_REVISION:
1551.8.20 by Aaron Bentley
Fix BzrDir.create_workingtree for NULL_REVISION
2963
                wt.set_parent_trees([])
2964
            else:
2965
                wt.set_parent_trees([(revision_id, basis_tree)])
1996.3.6 by John Arbash Meinel
Find a few places that weren't importing their dependencies.
2966
            transform.build_tree(basis_tree, wt)
1607.1.14 by Robert Collins
Reduce lock thrashing somewhat - drops bound branch tests lock count from 6554 to 4456 locks.
2967
        finally:
1986.5.7 by Robert Collins
Merge reviews.
2968
            # Unlock in this order so that the unlock-triggers-flush in
1986.5.4 by Robert Collins
Update comments and unlock in a better order in tree initialization (Robert Collins, John Meinel)
2969
            # WorkingTree is given a chance to fire.
2970
            control_files.unlock()
1607.1.14 by Robert Collins
Reduce lock thrashing somewhat - drops bound branch tests lock count from 6554 to 4456 locks.
2971
            wt.unlock()
1534.4.46 by Robert Collins
Nearly complete .bzr/checkout splitout.
2972
        return wt
2973
2100.3.12 by Aaron Bentley
Stop generating unique roots for WorkingTree3
2974
    def _initial_inventory(self):
4496.3.4 by Andrew Bennetts
Tidy up unused and redundant imports in workingtree.py.
2975
        return inventory.Inventory()
2100.3.12 by Aaron Bentley
Stop generating unique roots for WorkingTree3
2976
1534.4.46 by Robert Collins
Nearly complete .bzr/checkout splitout.
2977
    def __init__(self):
2978
        super(WorkingTreeFormat3, self).__init__()
1534.4.45 by Robert Collins
Start WorkingTree -> .bzr/checkout transition
2979
2980
    def open(self, a_bzrdir, _found=False):
2981
        """Return the WorkingTree object for a_bzrdir
2982
2983
        _found is a private parameter, do not use it. It is used to indicate
2984
               if format probing has already been done.
2985
        """
2986
        if not _found:
2987
            # we are being called directly and must probe.
2988
            raise NotImplementedError
1534.4.46 by Robert Collins
Nearly complete .bzr/checkout splitout.
2989
        if not isinstance(a_bzrdir.transport, LocalTransport):
2990
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2323.6.4 by Martin Pool
BzrDir._check_supported now also takes care of recommending upgrades, which
2991
        wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2992
        return wt
1852.3.1 by Robert Collins
Trivial cleanups to workingtree.py
2993
2994
    def _open(self, a_bzrdir, control_files):
2995
        """Open the tree itself.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
2996
1852.3.1 by Robert Collins
Trivial cleanups to workingtree.py
2997
        :param a_bzrdir: the dir for the tree.
2998
        :param control_files: the control files for the tree.
2999
        """
2100.3.3 by Aaron Bentley
Start of work on format 4 trees
3000
        return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3001
                                _internal=True,
3002
                                _format=self,
3003
                                _bzrdir=a_bzrdir,
3004
                                _control_files=control_files)
1534.4.46 by Robert Collins
Nearly complete .bzr/checkout splitout.
3005
1534.5.1 by Robert Collins
Give info some reasonable output and tests.
3006
    def __str__(self):
3007
        return self.get_format_string()
3008
1534.4.46 by Robert Collins
Nearly complete .bzr/checkout splitout.
3009
2255.2.173 by Martin Pool
Set default wt to 4, as in dirstate branch
3010
__default_format = WorkingTreeFormat4()
1534.4.46 by Robert Collins
Nearly complete .bzr/checkout splitout.
3011
WorkingTreeFormat.register_format(__default_format)
4210.4.2 by Ian Clatworthy
split filtered views support out into WorkingTreeFormat6
3012
WorkingTreeFormat.register_format(WorkingTreeFormat6())
3907.2.3 by Ian Clatworthy
DirStateWorkingTree and DirStateWorkingTreeFormat base classes introduced
3013
WorkingTreeFormat.register_format(WorkingTreeFormat5())
2255.2.173 by Martin Pool
Set default wt to 4, as in dirstate branch
3014
WorkingTreeFormat.register_format(WorkingTreeFormat3())
1534.4.46 by Robert Collins
Nearly complete .bzr/checkout splitout.
3015
WorkingTreeFormat.set_default_format(__default_format)
1852.13.2 by Robert Collins
Introduce a WorkingTree Format 4, which is the new dirstate format.
3016
# formats which have no format string are not discoverable
3017
# and not independently creatable, so are not registered.
1534.4.46 by Robert Collins
Nearly complete .bzr/checkout splitout.
3018
_legacy_formats = [WorkingTreeFormat2(),
3019
                   ]