/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Martin Pool
  • Date: 2011-02-09 08:03:35 UTC
  • mto: This revision was merged to the branch mainline in revision 5663.
  • Revision ID: mbp@sourcefrog.net-20110209080335-0gczvdsr6bzpwho8
Rename _fallback_vfs to _immediate_fallbacks

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
2
 
 
 
1
# Copyright (C) 2005-2011 Canonical Ltd
 
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
 
 
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""WorkingTree object and friends.
18
18
 
19
19
A WorkingTree represents the editable working copy of a branch.
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 
 
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
23
23
new revision based on the workingtree and its inventory.
24
24
 
25
25
At the moment every WorkingTree has its own branch.  Remote
29
29
WorkingTree.open(dir).
30
30
"""
31
31
 
32
 
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
33
 
CONFLICT_HEADER_1 = "BZR conflict list format 1"
34
 
 
35
 
# TODO: Give the workingtree sole responsibility for the working inventory;
36
 
# remove the variable and references to it from the branch.  This may require
37
 
# updating the commit code so as to update the inventory within the working
38
 
# copy, and making sure there's only one WorkingTree for any directory on disk.
39
 
# At the moment they may alias the inventory and have old copies of it in
40
 
# memory.  (Now done? -- mbp 20060309)
41
 
 
42
 
from copy import deepcopy
 
32
 
43
33
from cStringIO import StringIO
 
34
import os
 
35
import sys
 
36
 
 
37
from bzrlib.lazy_import import lazy_import
 
38
lazy_import(globals(), """
 
39
from bisect import bisect_left
 
40
import collections
44
41
import errno
45
 
import fnmatch
46
 
import os
 
42
import itertools
 
43
import operator
47
44
import stat
48
 
 
49
 
 
50
 
from bzrlib.atomicfile import AtomicFile
51
 
from bzrlib.branch import (Branch,
52
 
                           quotefn)
53
 
from bzrlib.conflicts import Conflict, ConflictList, CONFLICT_SUFFIXES
54
 
import bzrlib.bzrdir as bzrdir
 
45
import re
 
46
 
 
47
import bzrlib
 
48
from bzrlib import (
 
49
    branch,
 
50
    bzrdir,
 
51
    conflicts as _mod_conflicts,
 
52
    controldir,
 
53
    errors,
 
54
    generate_ids,
 
55
    globbing,
 
56
    graph as _mod_graph,
 
57
    hashcache,
 
58
    ignores,
 
59
    inventory,
 
60
    merge,
 
61
    revision as _mod_revision,
 
62
    revisiontree,
 
63
    trace,
 
64
    transform,
 
65
    transport,
 
66
    ui,
 
67
    views,
 
68
    xml5,
 
69
    xml7,
 
70
    )
 
71
from bzrlib.workingtree_4 import (
 
72
    WorkingTreeFormat4,
 
73
    WorkingTreeFormat5,
 
74
    WorkingTreeFormat6,
 
75
    )
 
76
""")
 
77
 
 
78
from bzrlib import symbol_versioning
55
79
from bzrlib.decorators import needs_read_lock, needs_write_lock
56
 
import bzrlib.errors as errors
57
 
from bzrlib.errors import (BzrCheckError,
58
 
                           BzrError,
59
 
                           ConflictFormatError,
60
 
                           DivergedBranches,
61
 
                           WeaveRevisionNotPresent,
62
 
                           NotBranchError,
63
 
                           NoSuchFile,
64
 
                           NotVersionedError,
65
 
                           MergeModifiedFormatError,
66
 
                           UnsupportedOperation,
67
 
                           )
68
 
from bzrlib.inventory import InventoryEntry, Inventory
69
 
from bzrlib.lockable_files import LockableFiles, TransportLock
 
80
from bzrlib.lock import LogicalLockResult
 
81
from bzrlib.lockable_files import LockableFiles
70
82
from bzrlib.lockdir import LockDir
71
 
from bzrlib.merge import merge_inner, transform_tree
 
83
import bzrlib.mutabletree
 
84
from bzrlib.mutabletree import needs_tree_write_lock
 
85
from bzrlib import osutils
72
86
from bzrlib.osutils import (
73
 
                            abspath,
74
 
                            appendpath,
75
 
                            compact_date,
76
 
                            file_kind,
77
 
                            isdir,
78
 
                            getcwd,
79
 
                            pathjoin,
80
 
                            pumpfile,
81
 
                            safe_unicode,
82
 
                            splitpath,
83
 
                            rand_bytes,
84
 
                            normpath,
85
 
                            realpath,
86
 
                            relpath,
87
 
                            rename,
88
 
                            supports_executable,
89
 
                            )
90
 
from bzrlib.progress import DummyProgress, ProgressPhase
91
 
from bzrlib.revision import NULL_REVISION
92
 
from bzrlib.rio import RioReader, rio_file, Stanza
93
 
from bzrlib.symbol_versioning import *
94
 
from bzrlib.textui import show_status
95
 
import bzrlib.tree
96
 
from bzrlib.transform import build_tree
 
87
    file_kind,
 
88
    isdir,
 
89
    normpath,
 
90
    pathjoin,
 
91
    realpath,
 
92
    safe_unicode,
 
93
    splitpath,
 
94
    supports_executable,
 
95
    )
 
96
from bzrlib.filters import filtered_input_file
97
97
from bzrlib.trace import mutter, note
98
 
from bzrlib.transport import get_transport
99
98
from bzrlib.transport.local import LocalTransport
100
 
import bzrlib.ui
101
 
import bzrlib.xml5
102
 
 
103
 
 
104
 
def gen_file_id(name):
105
 
    """Return new file id.
106
 
 
107
 
    This should probably generate proper UUIDs, but for the moment we
108
 
    cope with just randomness because running uuidgen every time is
109
 
    slow."""
110
 
    import re
111
 
    from binascii import hexlify
112
 
    from time import time
113
 
 
114
 
    # get last component
115
 
    idx = name.rfind('/')
116
 
    if idx != -1:
117
 
        name = name[idx+1 : ]
118
 
    idx = name.rfind('\\')
119
 
    if idx != -1:
120
 
        name = name[idx+1 : ]
121
 
 
122
 
    # make it not a hidden file
123
 
    name = name.lstrip('.')
124
 
 
125
 
    # remove any wierd characters; we don't escape them but rather
126
 
    # just pull them out
127
 
    name = re.sub(r'[^\w.]', '', name)
128
 
 
129
 
    s = hexlify(rand_bytes(8))
130
 
    return '-'.join((name, compact_date(time()), s))
131
 
 
132
 
 
133
 
def gen_root_id():
134
 
    """Return a new tree-root file id."""
135
 
    return gen_file_id('TREE_ROOT')
 
99
from bzrlib.revision import CURRENT_REVISION
 
100
from bzrlib.rio import RioReader, rio_file, Stanza
 
101
from bzrlib.symbol_versioning import (
 
102
    deprecated_passed,
 
103
    DEPRECATED_PARAMETER,
 
104
    )
 
105
 
 
106
 
 
107
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
 
108
# TODO: Modifying the conflict objects or their type is currently nearly
 
109
# impossible as there is no clear relationship between the working tree format
 
110
# and the conflict list file format.
 
111
CONFLICT_HEADER_1 = "BZR conflict list format 1"
 
112
 
 
113
ERROR_PATH_NOT_FOUND = 3    # WindowsError errno code, equivalent to ENOENT
136
114
 
137
115
 
138
116
class TreeEntry(object):
139
 
    """An entry that implements the minium interface used by commands.
 
117
    """An entry that implements the minimum interface used by commands.
140
118
 
141
 
    This needs further inspection, it may be better to have 
 
119
    This needs further inspection, it may be better to have
142
120
    InventoryEntries without ids - though that seems wrong. For now,
143
121
    this is a parallel hierarchy to InventoryEntry, and needs to become
144
122
    one of several things: decorates to that hierarchy, children of, or
147
125
    no InventoryEntry available - i.e. for unversioned objects.
148
126
    Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
149
127
    """
150
 
 
 
128
 
151
129
    def __eq__(self, other):
152
130
        # yes, this us ugly, TODO: best practice __eq__ style.
153
131
        return (isinstance(other, TreeEntry)
154
132
                and other.__class__ == self.__class__)
155
 
 
 
133
 
156
134
    def kind_character(self):
157
135
        return "???"
158
136
 
190
168
        return ''
191
169
 
192
170
 
193
 
class WorkingTree(bzrlib.tree.Tree):
 
171
class WorkingTree(bzrlib.mutabletree.MutableTree,
 
172
    controldir.ControlComponent):
194
173
    """Working copy tree.
195
174
 
196
175
    The inventory is held in the `Branch` working-inventory, and the
198
177
 
199
178
    It is possible for a `WorkingTree` to have a filename which is
200
179
    not listed in the Inventory and vice versa.
 
180
 
 
181
    :ivar basedir: The root of the tree on disk. This is a unicode path object
 
182
        (as opposed to a URL).
201
183
    """
202
184
 
 
185
    # override this to set the strategy for storing views
 
186
    def _make_views(self):
 
187
        return views.DisabledViews(self)
 
188
 
203
189
    def __init__(self, basedir='.',
204
190
                 branch=DEPRECATED_PARAMETER,
205
191
                 _inventory=None,
207
193
                 _internal=False,
208
194
                 _format=None,
209
195
                 _bzrdir=None):
210
 
        """Construct a WorkingTree for basedir.
 
196
        """Construct a WorkingTree instance. This is not a public API.
211
197
 
212
 
        If the branch is not supplied, it is opened automatically.
213
 
        If the branch is supplied, it must be the branch for this basedir.
214
 
        (branch.base is not cross checked, because for remote branches that
215
 
        would be meaningless).
 
198
        :param branch: A branch to override probing for the branch.
216
199
        """
217
200
        self._format = _format
218
201
        self.bzrdir = _bzrdir
219
202
        if not _internal:
220
 
            # not created via open etc.
221
 
            warn("WorkingTree() is deprecated as of bzr version 0.8. "
222
 
                 "Please use bzrdir.open_workingtree or WorkingTree.open().",
223
 
                 DeprecationWarning,
224
 
                 stacklevel=2)
225
 
            wt = WorkingTree.open(basedir)
226
 
            self.branch = wt.branch
227
 
            self.basedir = wt.basedir
228
 
            self._control_files = wt._control_files
229
 
            self._hashcache = wt._hashcache
230
 
            self._set_inventory(wt._inventory)
231
 
            self._format = wt._format
232
 
            self.bzrdir = wt.bzrdir
233
 
        from bzrlib.hashcache import HashCache
234
 
        from bzrlib.trace import note, mutter
235
 
        assert isinstance(basedir, basestring), \
236
 
            "base directory %r is not a string" % basedir
 
203
            raise errors.BzrError("Please use bzrdir.open_workingtree or "
 
204
                "WorkingTree.open() to obtain a WorkingTree.")
237
205
        basedir = safe_unicode(basedir)
238
206
        mutter("opening working tree %r", basedir)
239
207
        if deprecated_passed(branch):
240
 
            if not _internal:
241
 
                warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
242
 
                     " Please use bzrdir.open_workingtree() or"
243
 
                     " WorkingTree.open().",
244
 
                     DeprecationWarning,
245
 
                     stacklevel=2
246
 
                     )
247
 
            self.branch = branch
 
208
            self._branch = branch
248
209
        else:
249
 
            self.branch = self.bzrdir.open_branch()
250
 
        assert isinstance(self.branch, Branch), \
251
 
            "branch %r is not a Branch" % self.branch
 
210
            self._branch = self.bzrdir.open_branch()
252
211
        self.basedir = realpath(basedir)
253
 
        # if branch is at our basedir and is a format 6 or less
254
 
        if isinstance(self._format, WorkingTreeFormat2):
255
 
            # share control object
256
 
            self._control_files = self.branch.control_files
257
 
        else:
258
 
            # only ready for format 3
259
 
            assert isinstance(self._format, WorkingTreeFormat3)
260
 
            assert isinstance(_control_files, LockableFiles), \
261
 
                    "_control_files must be a LockableFiles, not %r" \
262
 
                    % _control_files
263
 
            self._control_files = _control_files
 
212
        self._control_files = _control_files
 
213
        self._transport = self._control_files._transport
264
214
        # update the whole cache up front and write to disk if anything changed;
265
215
        # in the future we might want to do this more selectively
266
216
        # two possible ways offer themselves : in self._unlock, write the cache
267
217
        # if needed, or, when the cache sees a change, append it to the hash
268
218
        # cache file, and have the parser take the most recent entry for a
269
219
        # given path only.
270
 
        cache_filename = self.bzrdir.get_workingtree_transport(None).abspath('stat-cache')
271
 
        hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
 
220
        wt_trans = self.bzrdir.get_workingtree_transport(None)
 
221
        cache_filename = wt_trans.local_abspath('stat-cache')
 
222
        self._hashcache = hashcache.HashCache(basedir, cache_filename,
 
223
            self.bzrdir._get_file_mode(),
 
224
            self._content_filter_stack_provider())
 
225
        hc = self._hashcache
272
226
        hc.read()
273
227
        # is this scan needed ? it makes things kinda slow.
274
 
        hc.scan()
 
228
        #hc.scan()
275
229
 
276
230
        if hc.needs_write:
277
231
            mutter("write hc")
278
232
            hc.write()
279
233
 
280
234
        if _inventory is None:
281
 
            self._set_inventory(self.read_working_inventory())
282
 
        else:
283
 
            self._set_inventory(_inventory)
284
 
 
285
 
    def _set_inventory(self, inv):
 
235
            # This will be acquired on lock_read() or lock_write()
 
236
            self._inventory_is_modified = False
 
237
            self._inventory = None
 
238
        else:
 
239
            # the caller of __init__ has provided an inventory,
 
240
            # we assume they know what they are doing - as its only
 
241
            # the Format factory and creation methods that are
 
242
            # permitted to do this.
 
243
            self._set_inventory(_inventory, dirty=False)
 
244
        self._detect_case_handling()
 
245
        self._rules_searcher = None
 
246
        self.views = self._make_views()
 
247
 
 
248
    @property
 
249
    def user_transport(self):
 
250
        return self.bzrdir.user_transport
 
251
 
 
252
    @property
 
253
    def control_transport(self):
 
254
        return self._transport
 
255
 
 
256
    def _detect_case_handling(self):
 
257
        wt_trans = self.bzrdir.get_workingtree_transport(None)
 
258
        try:
 
259
            wt_trans.stat(self._format.case_sensitive_filename)
 
260
        except errors.NoSuchFile:
 
261
            self.case_sensitive = True
 
262
        else:
 
263
            self.case_sensitive = False
 
264
 
 
265
        self._setup_directory_is_tree_reference()
 
266
 
 
267
    branch = property(
 
268
        fget=lambda self: self._branch,
 
269
        doc="""The branch this WorkingTree is connected to.
 
270
 
 
271
            This cannot be set - it is reflective of the actual disk structure
 
272
            the working tree has been constructed from.
 
273
            """)
 
274
 
 
275
    def break_lock(self):
 
276
        """Break a lock if one is present from another instance.
 
277
 
 
278
        Uses the ui factory to ask for confirmation if the lock may be from
 
279
        an active process.
 
280
 
 
281
        This will probe the repository for its lock as well.
 
282
        """
 
283
        self._control_files.break_lock()
 
284
        self.branch.break_lock()
 
285
 
 
286
    def _get_check_refs(self):
 
287
        """Return the references needed to perform a check of this tree.
 
288
        
 
289
        The default implementation returns no refs, and is only suitable for
 
290
        trees that have no local caching and can commit on ghosts at any time.
 
291
 
 
292
        :seealso: bzrlib.check for details about check_refs.
 
293
        """
 
294
        return []
 
295
 
 
296
    def requires_rich_root(self):
 
297
        return self._format.requires_rich_root
 
298
 
 
299
    def supports_tree_reference(self):
 
300
        return False
 
301
 
 
302
    def supports_content_filtering(self):
 
303
        return self._format.supports_content_filtering()
 
304
 
 
305
    def supports_views(self):
 
306
        return self.views.supports_views()
 
307
 
 
308
    def _set_inventory(self, inv, dirty):
 
309
        """Set the internal cached inventory.
 
310
 
 
311
        :param inv: The inventory to set.
 
312
        :param dirty: A boolean indicating whether the inventory is the same
 
313
            logical inventory as whats on disk. If True the inventory is not
 
314
            the same and should be written to disk or data will be lost, if
 
315
            False then the inventory is the same as that on disk and any
 
316
            serialisation would be unneeded overhead.
 
317
        """
286
318
        self._inventory = inv
287
 
        self.path2id = self._inventory.path2id
288
 
 
289
 
    def is_control_filename(self, filename):
290
 
        """True if filename is the name of a control file in this tree.
291
 
        
292
 
        This is true IF and ONLY IF the filename is part of the meta data
293
 
        that bzr controls in this tree. I.E. a random .bzr directory placed
294
 
        on disk will not be a control file for this tree.
295
 
        """
296
 
        try:
297
 
            self.bzrdir.transport.relpath(self.abspath(filename))
298
 
            return True
299
 
        except errors.PathNotChild:
300
 
            return False
 
319
        self._inventory_is_modified = dirty
301
320
 
302
321
    @staticmethod
303
322
    def open(path=None, _unsupported=False):
305
324
 
306
325
        """
307
326
        if path is None:
308
 
            path = os.path.getcwdu()
 
327
            path = osutils.getcwd()
309
328
        control = bzrdir.BzrDir.open(path, _unsupported)
310
329
        return control.open_workingtree(_unsupported)
311
 
        
 
330
 
312
331
    @staticmethod
313
332
    def open_containing(path=None):
314
333
        """Open an existing working tree which has its root about path.
315
 
        
 
334
 
316
335
        This probes for a working tree at path and searches upwards from there.
317
336
 
318
337
        Basically we keep looking up until we find the control directory or
319
338
        run into /.  If there isn't one, raises NotBranchError.
320
339
        TODO: give this a new exception.
321
340
        If there is one, it is returned, along with the unused portion of path.
 
341
 
 
342
        :return: The WorkingTree that contains 'path', and the rest of path
322
343
        """
323
344
        if path is None:
324
 
            path = os.getcwdu()
 
345
            path = osutils.getcwd()
325
346
        control, relpath = bzrdir.BzrDir.open_containing(path)
326
347
        return control.open_workingtree(), relpath
327
348
 
328
349
    @staticmethod
 
350
    def open_containing_paths(file_list, default_directory=None,
 
351
                              canonicalize=True, apply_view=True):
 
352
        """Open the WorkingTree that contains a set of paths.
 
353
 
 
354
        Fail if the paths given are not all in a single tree.
 
355
 
 
356
        This is used for the many command-line interfaces that take a list of
 
357
        any number of files and that require they all be in the same tree.
 
358
        """
 
359
        if default_directory is None:
 
360
            default_directory = u'.'
 
361
        # recommended replacement for builtins.internal_tree_files
 
362
        if file_list is None or len(file_list) == 0:
 
363
            tree = WorkingTree.open_containing(default_directory)[0]
 
364
            # XXX: doesn't really belong here, and seems to have the strange
 
365
            # side effect of making it return a bunch of files, not the whole
 
366
            # tree -- mbp 20100716
 
367
            if tree.supports_views() and apply_view:
 
368
                view_files = tree.views.lookup_view()
 
369
                if view_files:
 
370
                    file_list = view_files
 
371
                    view_str = views.view_display_str(view_files)
 
372
                    note("Ignoring files outside view. View is %s" % view_str)
 
373
            return tree, file_list
 
374
        if default_directory == u'.':
 
375
            seed = file_list[0]
 
376
        else:
 
377
            seed = default_directory
 
378
            file_list = [osutils.pathjoin(default_directory, f)
 
379
                         for f in file_list]
 
380
        tree = WorkingTree.open_containing(seed)[0]
 
381
        return tree, tree.safe_relpath_files(file_list, canonicalize,
 
382
                                             apply_view=apply_view)
 
383
 
 
384
    def safe_relpath_files(self, file_list, canonicalize=True, apply_view=True):
 
385
        """Convert file_list into a list of relpaths in tree.
 
386
 
 
387
        :param self: A tree to operate on.
 
388
        :param file_list: A list of user provided paths or None.
 
389
        :param apply_view: if True and a view is set, apply it or check that
 
390
            specified files are within it
 
391
        :return: A list of relative paths.
 
392
        :raises errors.PathNotChild: When a provided path is in a different self
 
393
            than self.
 
394
        """
 
395
        if file_list is None:
 
396
            return None
 
397
        if self.supports_views() and apply_view:
 
398
            view_files = self.views.lookup_view()
 
399
        else:
 
400
            view_files = []
 
401
        new_list = []
 
402
        # self.relpath exists as a "thunk" to osutils, but canonical_relpath
 
403
        # doesn't - fix that up here before we enter the loop.
 
404
        if canonicalize:
 
405
            fixer = lambda p: osutils.canonical_relpath(self.basedir, p)
 
406
        else:
 
407
            fixer = self.relpath
 
408
        for filename in file_list:
 
409
            relpath = fixer(osutils.dereference_path(filename))
 
410
            if view_files and not osutils.is_inside_any(view_files, relpath):
 
411
                raise errors.FileOutsideView(filename, view_files)
 
412
            new_list.append(relpath)
 
413
        return new_list
 
414
 
 
415
    @staticmethod
329
416
    def open_downlevel(path=None):
330
417
        """Open an unsupported working tree.
331
418
 
333
420
        """
334
421
        return WorkingTree.open(path, _unsupported=True)
335
422
 
 
423
    @staticmethod
 
424
    def find_trees(location):
 
425
        def list_current(transport):
 
426
            return [d for d in transport.list_dir('') if d != '.bzr']
 
427
        def evaluate(bzrdir):
 
428
            try:
 
429
                tree = bzrdir.open_workingtree()
 
430
            except errors.NoWorkingTree:
 
431
                return True, None
 
432
            else:
 
433
                return True, tree
 
434
        t = transport.get_transport(location)
 
435
        iterator = bzrdir.BzrDir.find_bzrdirs(t, evaluate=evaluate,
 
436
                                              list_current=list_current)
 
437
        return [tr for tr in iterator if tr is not None]
 
438
 
 
439
    # should be deprecated - this is slow and in any case treating them as a
 
440
    # container is (we now know) bad style -- mbp 20070302
 
441
    ## @deprecated_method(zero_fifteen)
336
442
    def __iter__(self):
337
443
        """Iterate through file_ids for this tree.
338
444
 
341
447
        """
342
448
        inv = self._inventory
343
449
        for path, ie in inv.iter_entries():
344
 
            if bzrlib.osutils.lexists(self.abspath(path)):
 
450
            if osutils.lexists(self.abspath(path)):
345
451
                yield ie.file_id
346
452
 
 
453
    def all_file_ids(self):
 
454
        """See Tree.iter_all_file_ids"""
 
455
        return set(self.inventory)
 
456
 
347
457
    def __repr__(self):
348
458
        return "<%s of %s>" % (self.__class__.__name__,
349
459
                               getattr(self, 'basedir', None))
350
460
 
351
461
    def abspath(self, filename):
352
462
        return pathjoin(self.basedir, filename)
353
 
    
 
463
 
354
464
    def basis_tree(self):
355
 
        """Return RevisionTree for the current last revision."""
356
 
        revision_id = self.last_revision()
357
 
        if revision_id is not None:
358
 
            try:
359
 
                xml = self.read_basis_inventory()
360
 
                inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
361
 
            except NoSuchFile:
362
 
                inv = None
363
 
            if inv is not None and inv.revision_id == revision_id:
364
 
                return bzrlib.tree.RevisionTree(self.branch.repository, inv,
365
 
                                                revision_id)
366
 
        # FIXME? RBC 20060403 should we cache the inventory here ?
367
 
        return self.branch.repository.revision_tree(revision_id)
368
 
 
369
 
    @staticmethod
370
 
    @deprecated_method(zero_eight)
371
 
    def create(branch, directory):
372
 
        """Create a workingtree for branch at directory.
373
 
 
374
 
        If existing_directory already exists it must have a .bzr directory.
375
 
        If it does not exist, it will be created.
376
 
 
377
 
        This returns a new WorkingTree object for the new checkout.
378
 
 
379
 
        TODO FIXME RBC 20060124 when we have checkout formats in place this
380
 
        should accept an optional revisionid to checkout [and reject this if
381
 
        checking out into the same dir as a pre-checkout-aware branch format.]
382
 
 
383
 
        XXX: When BzrDir is present, these should be created through that 
384
 
        interface instead.
385
 
        """
386
 
        warn('delete WorkingTree.create', stacklevel=3)
387
 
        transport = get_transport(directory)
388
 
        if branch.bzrdir.root_transport.base == transport.base:
389
 
            # same dir 
390
 
            return branch.bzrdir.create_workingtree()
391
 
        # different directory, 
392
 
        # create a branch reference
393
 
        # and now a working tree.
394
 
        raise NotImplementedError
395
 
 
396
 
    @staticmethod
397
 
    @deprecated_method(zero_eight)
398
 
    def create_standalone(directory):
399
 
        """Create a checkout and a branch and a repo at directory.
400
 
 
401
 
        Directory must exist and be empty.
402
 
 
403
 
        please use BzrDir.create_standalone_workingtree
404
 
        """
405
 
        return bzrdir.BzrDir.create_standalone_workingtree(directory)
406
 
 
407
 
    def relpath(self, abs):
408
 
        """Return the local path portion from a given absolute path."""
409
 
        return relpath(self.basedir, abs)
 
465
        """Return RevisionTree for the current last revision.
 
466
 
 
467
        If the left most parent is a ghost then the returned tree will be an
 
468
        empty tree - one obtained by calling
 
469
        repository.revision_tree(NULL_REVISION).
 
470
        """
 
471
        try:
 
472
            revision_id = self.get_parent_ids()[0]
 
473
        except IndexError:
 
474
            # no parents, return an empty revision tree.
 
475
            # in the future this should return the tree for
 
476
            # 'empty:' - the implicit root empty tree.
 
477
            return self.branch.repository.revision_tree(
 
478
                       _mod_revision.NULL_REVISION)
 
479
        try:
 
480
            return self.revision_tree(revision_id)
 
481
        except errors.NoSuchRevision:
 
482
            pass
 
483
        # No cached copy available, retrieve from the repository.
 
484
        # FIXME? RBC 20060403 should we cache the inventory locally
 
485
        # at this point ?
 
486
        try:
 
487
            return self.branch.repository.revision_tree(revision_id)
 
488
        except (errors.RevisionNotPresent, errors.NoSuchRevision):
 
489
            # the basis tree *may* be a ghost or a low level error may have
 
490
            # occurred. If the revision is present, its a problem, if its not
 
491
            # its a ghost.
 
492
            if self.branch.repository.has_revision(revision_id):
 
493
                raise
 
494
            # the basis tree is a ghost so return an empty tree.
 
495
            return self.branch.repository.revision_tree(
 
496
                       _mod_revision.NULL_REVISION)
 
497
 
 
498
    def _cleanup(self):
 
499
        self._flush_ignore_list_cache()
 
500
 
 
501
    def relpath(self, path):
 
502
        """Return the local path portion from a given path.
 
503
 
 
504
        The path may be absolute or relative. If its a relative path it is
 
505
        interpreted relative to the python current working directory.
 
506
        """
 
507
        return osutils.relpath(self.basedir, path)
410
508
 
411
509
    def has_filename(self, filename):
412
 
        return bzrlib.osutils.lexists(self.abspath(filename))
413
 
 
414
 
    def get_file(self, file_id):
415
 
        return self.get_file_byname(self.id2path(file_id))
416
 
 
417
 
    def get_file_byname(self, filename):
418
 
        return file(self.abspath(filename), 'rb')
419
 
 
 
510
        return osutils.lexists(self.abspath(filename))
 
511
 
 
512
    def get_file(self, file_id, path=None, filtered=True):
 
513
        return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
 
514
 
 
515
    def get_file_with_stat(self, file_id, path=None, filtered=True,
 
516
        _fstat=os.fstat):
 
517
        """See Tree.get_file_with_stat."""
 
518
        if path is None:
 
519
            path = self.id2path(file_id)
 
520
        file_obj = self.get_file_byname(path, filtered=False)
 
521
        stat_value = _fstat(file_obj.fileno())
 
522
        if filtered and self.supports_content_filtering():
 
523
            filters = self._content_filter_stack(path)
 
524
            file_obj = filtered_input_file(file_obj, filters)
 
525
        return (file_obj, stat_value)
 
526
 
 
527
    def get_file_text(self, file_id, path=None, filtered=True):
 
528
        my_file = self.get_file(file_id, path=path, filtered=filtered)
 
529
        try:
 
530
            return my_file.read()
 
531
        finally:
 
532
            my_file.close()
 
533
 
 
534
    def get_file_byname(self, filename, filtered=True):
 
535
        path = self.abspath(filename)
 
536
        f = file(path, 'rb')
 
537
        if filtered and self.supports_content_filtering():
 
538
            filters = self._content_filter_stack(filename)
 
539
            return filtered_input_file(f, filters)
 
540
        else:
 
541
            return f
 
542
 
 
543
    def get_file_lines(self, file_id, path=None, filtered=True):
 
544
        """See Tree.get_file_lines()"""
 
545
        file = self.get_file(file_id, path, filtered=filtered)
 
546
        try:
 
547
            return file.readlines()
 
548
        finally:
 
549
            file.close()
 
550
 
 
551
    @needs_read_lock
 
552
    def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
 
553
        """See Tree.annotate_iter
 
554
 
 
555
        This implementation will use the basis tree implementation if possible.
 
556
        Lines not in the basis are attributed to CURRENT_REVISION
 
557
 
 
558
        If there are pending merges, lines added by those merges will be
 
559
        incorrectly attributed to CURRENT_REVISION (but after committing, the
 
560
        attribution will be correct).
 
561
        """
 
562
        maybe_file_parent_keys = []
 
563
        for parent_id in self.get_parent_ids():
 
564
            try:
 
565
                parent_tree = self.revision_tree(parent_id)
 
566
            except errors.NoSuchRevisionInTree:
 
567
                parent_tree = self.branch.repository.revision_tree(parent_id)
 
568
            parent_tree.lock_read()
 
569
            try:
 
570
                if file_id not in parent_tree:
 
571
                    continue
 
572
                ie = parent_tree.inventory[file_id]
 
573
                if ie.kind != 'file':
 
574
                    # Note: this is slightly unnecessary, because symlinks and
 
575
                    # directories have a "text" which is the empty text, and we
 
576
                    # know that won't mess up annotations. But it seems cleaner
 
577
                    continue
 
578
                parent_text_key = (file_id, ie.revision)
 
579
                if parent_text_key not in maybe_file_parent_keys:
 
580
                    maybe_file_parent_keys.append(parent_text_key)
 
581
            finally:
 
582
                parent_tree.unlock()
 
583
        graph = _mod_graph.Graph(self.branch.repository.texts)
 
584
        heads = graph.heads(maybe_file_parent_keys)
 
585
        file_parent_keys = []
 
586
        for key in maybe_file_parent_keys:
 
587
            if key in heads:
 
588
                file_parent_keys.append(key)
 
589
 
 
590
        # Now we have the parents of this content
 
591
        annotator = self.branch.repository.texts.get_annotator()
 
592
        text = self.get_file_text(file_id)
 
593
        this_key =(file_id, default_revision)
 
594
        annotator.add_special_text(this_key, file_parent_keys, text)
 
595
        annotations = [(key[-1], line)
 
596
                       for key, line in annotator.annotate_flat(this_key)]
 
597
        return annotations
 
598
 
 
599
    def _get_ancestors(self, default_revision):
 
600
        ancestors = set([default_revision])
 
601
        for parent_id in self.get_parent_ids():
 
602
            ancestors.update(self.branch.repository.get_ancestry(
 
603
                             parent_id, topo_sorted=False))
 
604
        return ancestors
 
605
 
 
606
    def get_parent_ids(self):
 
607
        """See Tree.get_parent_ids.
 
608
 
 
609
        This implementation reads the pending merges list and last_revision
 
610
        value and uses that to decide what the parents list should be.
 
611
        """
 
612
        last_rev = _mod_revision.ensure_null(self._last_revision())
 
613
        if _mod_revision.NULL_REVISION == last_rev:
 
614
            parents = []
 
615
        else:
 
616
            parents = [last_rev]
 
617
        try:
 
618
            merges_bytes = self._transport.get_bytes('pending-merges')
 
619
        except errors.NoSuchFile:
 
620
            pass
 
621
        else:
 
622
            for l in osutils.split_lines(merges_bytes):
 
623
                revision_id = l.rstrip('\n')
 
624
                parents.append(revision_id)
 
625
        return parents
 
626
 
 
627
    @needs_read_lock
420
628
    def get_root_id(self):
421
629
        """Return the id of this trees root"""
422
 
        inv = self.read_working_inventory()
423
 
        return inv.root.file_id
424
 
        
 
630
        return self._inventory.root.file_id
 
631
 
425
632
    def _get_store_filename(self, file_id):
426
633
        ## XXX: badly named; this is not in the store at all
427
634
        return self.abspath(self.id2path(file_id))
428
635
 
429
636
    @needs_read_lock
430
 
    def clone(self, to_bzrdir, revision_id=None, basis=None):
 
637
    def clone(self, to_bzrdir, revision_id=None):
431
638
        """Duplicate this working tree into to_bzr, including all state.
432
 
        
 
639
 
433
640
        Specifically modified files are kept as modified, but
434
641
        ignored and unknown files are discarded.
435
642
 
436
643
        If you want to make a new line of development, see bzrdir.sprout()
437
644
 
438
645
        revision
439
 
            If not None, the cloned tree will have its last revision set to 
440
 
            revision, and and difference between the source trees last revision
 
646
            If not None, the cloned tree will have its last revision set to
 
647
            revision, and difference between the source trees last revision
441
648
            and this one merged in.
442
 
 
443
 
        basis
444
 
            If not None, a closer copy of a tree which may have some files in
445
 
            common, and which file content should be preferentially copied from.
446
649
        """
447
650
        # assumes the target bzr dir format is compatible.
448
 
        result = self._format.initialize(to_bzrdir)
 
651
        result = to_bzrdir.create_workingtree()
449
652
        self.copy_content_into(result, revision_id)
450
653
        return result
451
654
 
452
655
    @needs_read_lock
453
656
    def copy_content_into(self, tree, revision_id=None):
454
657
        """Copy the current content and user files of this tree into tree."""
 
658
        tree.set_root_id(self.get_root_id())
455
659
        if revision_id is None:
456
 
            transform_tree(tree, self)
 
660
            merge.transform_tree(tree, self)
457
661
        else:
458
 
            # TODO now merge from tree.last_revision to revision
459
 
            transform_tree(tree, self)
460
 
            tree.set_last_revision(revision_id)
461
 
 
462
 
    @needs_write_lock
463
 
    def commit(self, message=None, revprops=None, *args, **kwargs):
464
 
        # avoid circular imports
465
 
        from bzrlib.commit import Commit
466
 
        if revprops is None:
467
 
            revprops = {}
468
 
        if not 'branch-nick' in revprops:
469
 
            revprops['branch-nick'] = self.branch.nick
470
 
        # args for wt.commit start at message from the Commit.commit method,
471
 
        # but with branch a kwarg now, passing in args as is results in the
472
 
        #message being used for the branch
473
 
        args = (DEPRECATED_PARAMETER, message, ) + args
474
 
        Commit().commit(working_tree=self, revprops=revprops, *args, **kwargs)
475
 
        self._set_inventory(self.read_working_inventory())
 
662
            # TODO now merge from tree.last_revision to revision (to preserve
 
663
            # user local changes)
 
664
            merge.transform_tree(tree, self)
 
665
            tree.set_parent_ids([revision_id])
476
666
 
477
667
    def id2abspath(self, file_id):
478
668
        return self.abspath(self.id2path(file_id))
479
669
 
480
670
    def has_id(self, file_id):
481
671
        # files that have been deleted are excluded
482
 
        inv = self._inventory
 
672
        inv = self.inventory
483
673
        if not inv.has_id(file_id):
484
674
            return False
485
675
        path = inv.id2path(file_id)
486
 
        return bzrlib.osutils.lexists(self.abspath(path))
 
676
        return osutils.lexists(self.abspath(path))
487
677
 
488
678
    def has_or_had_id(self, file_id):
489
679
        if file_id == self.inventory.root.file_id:
493
683
    __contains__ = has_id
494
684
 
495
685
    def get_file_size(self, file_id):
496
 
        return os.path.getsize(self.id2abspath(file_id))
 
686
        """See Tree.get_file_size"""
 
687
        # XXX: this returns the on-disk size; it should probably return the
 
688
        # canonical size
 
689
        try:
 
690
            return os.path.getsize(self.id2abspath(file_id))
 
691
        except OSError, e:
 
692
            if e.errno != errno.ENOENT:
 
693
                raise
 
694
            else:
 
695
                return None
497
696
 
498
697
    @needs_read_lock
499
 
    def get_file_sha1(self, file_id):
500
 
        path = self._inventory.id2path(file_id)
501
 
        return self._hashcache.get_sha1(path)
502
 
 
503
 
    def is_executable(self, file_id):
504
 
        if not supports_executable():
 
698
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
699
        if not path:
 
700
            path = self._inventory.id2path(file_id)
 
701
        return self._hashcache.get_sha1(path, stat_value)
 
702
 
 
703
    def get_file_mtime(self, file_id, path=None):
 
704
        if not path:
 
705
            path = self.inventory.id2path(file_id)
 
706
        return os.lstat(self.abspath(path)).st_mtime
 
707
 
 
708
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
 
709
        file_id = self.path2id(path)
 
710
        if file_id is None:
 
711
            # For unversioned files on win32, we just assume they are not
 
712
            # executable
 
713
            return False
 
714
        return self._inventory[file_id].executable
 
715
 
 
716
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
 
717
        mode = stat_result.st_mode
 
718
        return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
 
719
 
 
720
    if not supports_executable():
 
721
        def is_executable(self, file_id, path=None):
505
722
            return self._inventory[file_id].executable
506
 
        else:
507
 
            path = self._inventory.id2path(file_id)
 
723
 
 
724
        _is_executable_from_path_and_stat = \
 
725
            _is_executable_from_path_and_stat_from_basis
 
726
    else:
 
727
        def is_executable(self, file_id, path=None):
 
728
            if not path:
 
729
                path = self.id2path(file_id)
508
730
            mode = os.lstat(self.abspath(path)).st_mode
509
 
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
510
 
 
511
 
    @needs_write_lock
512
 
    def add(self, files, ids=None):
513
 
        """Make files versioned.
514
 
 
515
 
        Note that the command line normally calls smart_add instead,
516
 
        which can automatically recurse.
517
 
 
518
 
        This adds the files to the inventory, so that they will be
519
 
        recorded by the next commit.
520
 
 
521
 
        files
522
 
            List of paths to add, relative to the base of the tree.
523
 
 
524
 
        ids
525
 
            If set, use these instead of automatically generated ids.
526
 
            Must be the same length as the list of files, but may
527
 
            contain None for ids that are to be autogenerated.
528
 
 
529
 
        TODO: Perhaps have an option to add the ids even if the files do
530
 
              not (yet) exist.
531
 
 
532
 
        TODO: Perhaps callback with the ids and paths as they're added.
533
 
        """
 
731
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
 
732
 
 
733
        _is_executable_from_path_and_stat = \
 
734
            _is_executable_from_path_and_stat_from_stat
 
735
 
 
736
    @needs_tree_write_lock
 
737
    def _add(self, files, ids, kinds):
 
738
        """See MutableTree._add."""
534
739
        # TODO: Re-adding a file that is removed in the working copy
535
740
        # should probably put it back with the previous ID.
536
 
        if isinstance(files, basestring):
537
 
            assert(ids is None or isinstance(ids, basestring))
538
 
            files = [files]
539
 
            if ids is not None:
540
 
                ids = [ids]
541
 
 
542
 
        if ids is None:
543
 
            ids = [None] * len(files)
544
 
        else:
545
 
            assert(len(ids) == len(files))
546
 
 
547
 
        inv = self.read_working_inventory()
548
 
        for f,file_id in zip(files, ids):
549
 
            if self.is_control_filename(f):
550
 
                raise BzrError("cannot add control file %s" % quotefn(f))
551
 
 
552
 
            fp = splitpath(f)
553
 
 
554
 
            if len(fp) == 0:
555
 
                raise BzrError("cannot add top-level %r" % f)
556
 
 
557
 
            fullpath = normpath(self.abspath(f))
558
 
 
559
 
            try:
560
 
                kind = file_kind(fullpath)
561
 
            except OSError, e:
562
 
                if e.errno == errno.ENOENT:
563
 
                    raise NoSuchFile(fullpath)
564
 
                # maybe something better?
565
 
                raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
566
 
 
567
 
            if not InventoryEntry.versionable_kind(kind):
568
 
                raise BzrError('cannot add: not a versionable file ('
569
 
                               'i.e. regular file, symlink or directory): %s' % quotefn(f))
570
 
 
 
741
        # the read and write working inventory should not occur in this
 
742
        # function - they should be part of lock_write and unlock.
 
743
        inv = self.inventory
 
744
        for f, file_id, kind in zip(files, ids, kinds):
571
745
            if file_id is None:
572
 
                file_id = gen_file_id(f)
573
 
            inv.add_path(f, kind=kind, file_id=file_id)
 
746
                inv.add_path(f, kind=kind)
 
747
            else:
 
748
                inv.add_path(f, kind=kind, file_id=file_id)
 
749
            self._inventory_is_modified = True
574
750
 
575
 
            mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
576
 
        self._write_inventory(inv)
 
751
    @needs_tree_write_lock
 
752
    def _gather_kinds(self, files, kinds):
 
753
        """See MutableTree._gather_kinds."""
 
754
        for pos, f in enumerate(files):
 
755
            if kinds[pos] is None:
 
756
                fullpath = normpath(self.abspath(f))
 
757
                try:
 
758
                    kinds[pos] = file_kind(fullpath)
 
759
                except OSError, e:
 
760
                    if e.errno == errno.ENOENT:
 
761
                        raise errors.NoSuchFile(fullpath)
577
762
 
578
763
    @needs_write_lock
 
764
    def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
 
765
        """Add revision_id as a parent.
 
766
 
 
767
        This is equivalent to retrieving the current list of parent ids
 
768
        and setting the list to its value plus revision_id.
 
769
 
 
770
        :param revision_id: The revision id to add to the parent list. It may
 
771
        be a ghost revision as long as its not the first parent to be added,
 
772
        or the allow_leftmost_as_ghost parameter is set True.
 
773
        :param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
 
774
        """
 
775
        parents = self.get_parent_ids() + [revision_id]
 
776
        self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
 
777
            or allow_leftmost_as_ghost)
 
778
 
 
779
    @needs_tree_write_lock
 
780
    def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
 
781
        """Add revision_id, tree tuple as a parent.
 
782
 
 
783
        This is equivalent to retrieving the current list of parent trees
 
784
        and setting the list to its value plus parent_tuple. See also
 
785
        add_parent_tree_id - if you only have a parent id available it will be
 
786
        simpler to use that api. If you have the parent already available, using
 
787
        this api is preferred.
 
788
 
 
789
        :param parent_tuple: The (revision id, tree) to add to the parent list.
 
790
            If the revision_id is a ghost, pass None for the tree.
 
791
        :param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
 
792
        """
 
793
        parent_ids = self.get_parent_ids() + [parent_tuple[0]]
 
794
        if len(parent_ids) > 1:
 
795
            # the leftmost may have already been a ghost, preserve that if it
 
796
            # was.
 
797
            allow_leftmost_as_ghost = True
 
798
        self.set_parent_ids(parent_ids,
 
799
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
800
 
 
801
    @needs_tree_write_lock
579
802
    def add_pending_merge(self, *revision_ids):
580
803
        # TODO: Perhaps should check at this point that the
581
804
        # history of the revision is actually present?
582
 
        p = self.pending_merges()
 
805
        parents = self.get_parent_ids()
583
806
        updated = False
584
807
        for rev_id in revision_ids:
585
 
            if rev_id in p:
 
808
            if rev_id in parents:
586
809
                continue
587
 
            p.append(rev_id)
 
810
            parents.append(rev_id)
588
811
            updated = True
589
812
        if updated:
590
 
            self.set_pending_merges(p)
591
 
 
592
 
    @needs_read_lock
593
 
    def pending_merges(self):
594
 
        """Return a list of pending merges.
595
 
 
596
 
        These are revisions that have been merged into the working
597
 
        directory but not yet committed.
598
 
        """
 
813
            self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
 
814
 
 
815
    def path_content_summary(self, path, _lstat=os.lstat,
 
816
        _mapper=osutils.file_kind_from_stat_mode):
 
817
        """See Tree.path_content_summary."""
 
818
        abspath = self.abspath(path)
599
819
        try:
600
 
            merges_file = self._control_files.get_utf8('pending-merges')
 
820
            stat_result = _lstat(abspath)
601
821
        except OSError, e:
602
 
            if e.errno != errno.ENOENT:
603
 
                raise
604
 
            return []
605
 
        p = []
606
 
        for l in merges_file.readlines():
607
 
            p.append(l.rstrip('\n'))
608
 
        return p
609
 
 
610
 
    @needs_write_lock
 
822
            if getattr(e, 'errno', None) == errno.ENOENT:
 
823
                # no file.
 
824
                return ('missing', None, None, None)
 
825
            # propagate other errors
 
826
            raise
 
827
        kind = _mapper(stat_result.st_mode)
 
828
        if kind == 'file':
 
829
            return self._file_content_summary(path, stat_result)
 
830
        elif kind == 'directory':
 
831
            # perhaps it looks like a plain directory, but it's really a
 
832
            # reference.
 
833
            if self._directory_is_tree_reference(path):
 
834
                kind = 'tree-reference'
 
835
            return kind, None, None, None
 
836
        elif kind == 'symlink':
 
837
            target = osutils.readlink(abspath)
 
838
            return ('symlink', None, None, target)
 
839
        else:
 
840
            return (kind, None, None, None)
 
841
 
 
842
    def _file_content_summary(self, path, stat_result):
 
843
        size = stat_result.st_size
 
844
        executable = self._is_executable_from_path_and_stat(path, stat_result)
 
845
        # try for a stat cache lookup
 
846
        return ('file', size, executable, self._sha_from_stat(
 
847
            path, stat_result))
 
848
 
 
849
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
 
850
        """Common ghost checking functionality from set_parent_*.
 
851
 
 
852
        This checks that the left hand-parent exists if there are any
 
853
        revisions present.
 
854
        """
 
855
        if len(revision_ids) > 0:
 
856
            leftmost_id = revision_ids[0]
 
857
            if (not allow_leftmost_as_ghost and not
 
858
                self.branch.repository.has_revision(leftmost_id)):
 
859
                raise errors.GhostRevisionUnusableHere(leftmost_id)
 
860
 
 
861
    def _set_merges_from_parent_ids(self, parent_ids):
 
862
        merges = parent_ids[1:]
 
863
        self._transport.put_bytes('pending-merges', '\n'.join(merges),
 
864
            mode=self.bzrdir._get_file_mode())
 
865
 
 
866
    def _filter_parent_ids_by_ancestry(self, revision_ids):
 
867
        """Check that all merged revisions are proper 'heads'.
 
868
 
 
869
        This will always return the first revision_id, and any merged revisions
 
870
        which are
 
871
        """
 
872
        if len(revision_ids) == 0:
 
873
            return revision_ids
 
874
        graph = self.branch.repository.get_graph()
 
875
        heads = graph.heads(revision_ids)
 
876
        new_revision_ids = revision_ids[:1]
 
877
        for revision_id in revision_ids[1:]:
 
878
            if revision_id in heads and revision_id not in new_revision_ids:
 
879
                new_revision_ids.append(revision_id)
 
880
        if new_revision_ids != revision_ids:
 
881
            trace.mutter('requested to set revision_ids = %s,'
 
882
                         ' but filtered to %s', revision_ids, new_revision_ids)
 
883
        return new_revision_ids
 
884
 
 
885
    @needs_tree_write_lock
 
886
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
 
887
        """Set the parent ids to revision_ids.
 
888
 
 
889
        See also set_parent_trees. This api will try to retrieve the tree data
 
890
        for each element of revision_ids from the trees repository. If you have
 
891
        tree data already available, it is more efficient to use
 
892
        set_parent_trees rather than set_parent_ids. set_parent_ids is however
 
893
        an easier API to use.
 
894
 
 
895
        :param revision_ids: The revision_ids to set as the parent ids of this
 
896
            working tree. Any of these may be ghosts.
 
897
        """
 
898
        self._check_parents_for_ghosts(revision_ids,
 
899
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
900
        for revision_id in revision_ids:
 
901
            _mod_revision.check_not_reserved_id(revision_id)
 
902
 
 
903
        revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
 
904
 
 
905
        if len(revision_ids) > 0:
 
906
            self.set_last_revision(revision_ids[0])
 
907
        else:
 
908
            self.set_last_revision(_mod_revision.NULL_REVISION)
 
909
 
 
910
        self._set_merges_from_parent_ids(revision_ids)
 
911
 
 
912
    @needs_tree_write_lock
 
913
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
 
914
        """See MutableTree.set_parent_trees."""
 
915
        parent_ids = [rev for (rev, tree) in parents_list]
 
916
        for revision_id in parent_ids:
 
917
            _mod_revision.check_not_reserved_id(revision_id)
 
918
 
 
919
        self._check_parents_for_ghosts(parent_ids,
 
920
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
921
 
 
922
        parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
 
923
 
 
924
        if len(parent_ids) == 0:
 
925
            leftmost_parent_id = _mod_revision.NULL_REVISION
 
926
            leftmost_parent_tree = None
 
927
        else:
 
928
            leftmost_parent_id, leftmost_parent_tree = parents_list[0]
 
929
 
 
930
        if self._change_last_revision(leftmost_parent_id):
 
931
            if leftmost_parent_tree is None:
 
932
                # If we don't have a tree, fall back to reading the
 
933
                # parent tree from the repository.
 
934
                self._cache_basis_inventory(leftmost_parent_id)
 
935
            else:
 
936
                inv = leftmost_parent_tree.inventory
 
937
                xml = self._create_basis_xml_from_inventory(
 
938
                                        leftmost_parent_id, inv)
 
939
                self._write_basis_inventory(xml)
 
940
        self._set_merges_from_parent_ids(parent_ids)
 
941
 
 
942
    @needs_tree_write_lock
611
943
    def set_pending_merges(self, rev_list):
612
 
        self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
 
944
        parents = self.get_parent_ids()
 
945
        leftmost = parents[:1]
 
946
        new_parents = leftmost + rev_list
 
947
        self.set_parent_ids(new_parents)
613
948
 
614
 
    @needs_write_lock
 
949
    @needs_tree_write_lock
615
950
    def set_merge_modified(self, modified_hashes):
616
951
        def iter_stanzas():
617
952
            for file_id, hash in modified_hashes.iteritems():
618
 
                yield Stanza(file_id=file_id, hash=hash)
 
953
                yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
619
954
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
620
955
 
621
 
    @needs_write_lock
 
956
    def _sha_from_stat(self, path, stat_result):
 
957
        """Get a sha digest from the tree's stat cache.
 
958
 
 
959
        The default implementation assumes no stat cache is present.
 
960
 
 
961
        :param path: The path.
 
962
        :param stat_result: The stat result being looked up.
 
963
        """
 
964
        return None
 
965
 
622
966
    def _put_rio(self, filename, stanzas, header):
 
967
        self._must_be_locked()
623
968
        my_file = rio_file(stanzas, header)
624
 
        self._control_files.put(filename, my_file)
 
969
        self._transport.put_file(filename, my_file,
 
970
            mode=self.bzrdir._get_file_mode())
 
971
 
 
972
    @needs_write_lock # because merge pulls data into the branch.
 
973
    def merge_from_branch(self, branch, to_revision=None, from_revision=None,
 
974
                          merge_type=None, force=False):
 
975
        """Merge from a branch into this working tree.
 
976
 
 
977
        :param branch: The branch to merge from.
 
978
        :param to_revision: If non-None, the merge will merge to to_revision,
 
979
            but not beyond it. to_revision does not need to be in the history
 
980
            of the branch when it is supplied. If None, to_revision defaults to
 
981
            branch.last_revision().
 
982
        """
 
983
        from bzrlib.merge import Merger, Merge3Merger
 
984
        merger = Merger(self.branch, this_tree=self)
 
985
        # check that there are no local alterations
 
986
        if not force and self.has_changes():
 
987
            raise errors.UncommittedChanges(self)
 
988
        if to_revision is None:
 
989
            to_revision = _mod_revision.ensure_null(branch.last_revision())
 
990
        merger.other_rev_id = to_revision
 
991
        if _mod_revision.is_null(merger.other_rev_id):
 
992
            raise errors.NoCommits(branch)
 
993
        self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
994
        merger.other_basis = merger.other_rev_id
 
995
        merger.other_tree = self.branch.repository.revision_tree(
 
996
            merger.other_rev_id)
 
997
        merger.other_branch = branch
 
998
        if from_revision is None:
 
999
            merger.find_base()
 
1000
        else:
 
1001
            merger.set_base_revision(from_revision, branch)
 
1002
        if merger.base_rev_id == merger.other_rev_id:
 
1003
            raise errors.PointlessMerge
 
1004
        merger.backup_files = False
 
1005
        if merge_type is None:
 
1006
            merger.merge_type = Merge3Merger
 
1007
        else:
 
1008
            merger.merge_type = merge_type
 
1009
        merger.set_interesting_files(None)
 
1010
        merger.show_base = False
 
1011
        merger.reprocess = False
 
1012
        conflicts = merger.do_merge()
 
1013
        merger.set_pending()
 
1014
        return conflicts
625
1015
 
626
1016
    @needs_read_lock
627
1017
    def merge_modified(self):
 
1018
        """Return a dictionary of files modified by a merge.
 
1019
 
 
1020
        The list is initialized by WorkingTree.set_merge_modified, which is
 
1021
        typically called after we make some automatic updates to the tree
 
1022
        because of a merge.
 
1023
 
 
1024
        This returns a map of file_id->sha1, containing only files which are
 
1025
        still in the working inventory and have that text hash.
 
1026
        """
628
1027
        try:
629
 
            hashfile = self._control_files.get('merge-hashes')
630
 
        except NoSuchFile:
 
1028
            hashfile = self._transport.get('merge-hashes')
 
1029
        except errors.NoSuchFile:
631
1030
            return {}
632
 
        merge_hashes = {}
633
1031
        try:
634
 
            if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
635
 
                raise MergeModifiedFormatError()
636
 
        except StopIteration:
637
 
            raise MergeModifiedFormatError()
638
 
        for s in RioReader(hashfile):
639
 
            file_id = s.get("file_id")
640
 
            if file_id not in self.inventory:
641
 
                continue
642
 
            hash = s.get("hash")
643
 
            if hash == self.get_file_sha1(file_id):
644
 
                merge_hashes[file_id] = hash
645
 
        return merge_hashes
 
1032
            merge_hashes = {}
 
1033
            try:
 
1034
                if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
 
1035
                    raise errors.MergeModifiedFormatError()
 
1036
            except StopIteration:
 
1037
                raise errors.MergeModifiedFormatError()
 
1038
            for s in RioReader(hashfile):
 
1039
                # RioReader reads in Unicode, so convert file_ids back to utf8
 
1040
                file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
 
1041
                if file_id not in self.inventory:
 
1042
                    continue
 
1043
                text_hash = s.get("hash")
 
1044
                if text_hash == self.get_file_sha1(file_id):
 
1045
                    merge_hashes[file_id] = text_hash
 
1046
            return merge_hashes
 
1047
        finally:
 
1048
            hashfile.close()
 
1049
 
 
1050
    @needs_write_lock
 
1051
    def mkdir(self, path, file_id=None):
 
1052
        """See MutableTree.mkdir()."""
 
1053
        if file_id is None:
 
1054
            file_id = generate_ids.gen_file_id(os.path.basename(path))
 
1055
        os.mkdir(self.abspath(path))
 
1056
        self.add(path, file_id, 'directory')
 
1057
        return file_id
646
1058
 
647
1059
    def get_symlink_target(self, file_id):
648
 
        return os.readlink(self.id2abspath(file_id))
649
 
 
650
 
    def file_class(self, filename):
651
 
        if self.path2id(filename):
652
 
            return 'V'
653
 
        elif self.is_ignored(filename):
654
 
            return 'I'
655
 
        else:
656
 
            return '?'
657
 
 
658
 
    def list_files(self):
659
 
        """Recursively list all files as (path, class, kind, id).
 
1060
        abspath = self.id2abspath(file_id)
 
1061
        target = osutils.readlink(abspath)
 
1062
        return target
 
1063
 
 
1064
    @needs_write_lock
 
1065
    def subsume(self, other_tree):
 
1066
        def add_children(inventory, entry):
 
1067
            for child_entry in entry.children.values():
 
1068
                inventory._byid[child_entry.file_id] = child_entry
 
1069
                if child_entry.kind == 'directory':
 
1070
                    add_children(inventory, child_entry)
 
1071
        if other_tree.get_root_id() == self.get_root_id():
 
1072
            raise errors.BadSubsumeSource(self, other_tree,
 
1073
                                          'Trees have the same root')
 
1074
        try:
 
1075
            other_tree_path = self.relpath(other_tree.basedir)
 
1076
        except errors.PathNotChild:
 
1077
            raise errors.BadSubsumeSource(self, other_tree,
 
1078
                'Tree is not contained by the other')
 
1079
        new_root_parent = self.path2id(osutils.dirname(other_tree_path))
 
1080
        if new_root_parent is None:
 
1081
            raise errors.BadSubsumeSource(self, other_tree,
 
1082
                'Parent directory is not versioned.')
 
1083
        # We need to ensure that the result of a fetch will have a
 
1084
        # versionedfile for the other_tree root, and only fetching into
 
1085
        # RepositoryKnit2 guarantees that.
 
1086
        if not self.branch.repository.supports_rich_root():
 
1087
            raise errors.SubsumeTargetNeedsUpgrade(other_tree)
 
1088
        other_tree.lock_tree_write()
 
1089
        try:
 
1090
            new_parents = other_tree.get_parent_ids()
 
1091
            other_root = other_tree.inventory.root
 
1092
            other_root.parent_id = new_root_parent
 
1093
            other_root.name = osutils.basename(other_tree_path)
 
1094
            self.inventory.add(other_root)
 
1095
            add_children(self.inventory, other_root)
 
1096
            self._write_inventory(self.inventory)
 
1097
            # normally we don't want to fetch whole repositories, but i think
 
1098
            # here we really do want to consolidate the whole thing.
 
1099
            for parent_id in other_tree.get_parent_ids():
 
1100
                self.branch.fetch(other_tree.branch, parent_id)
 
1101
                self.add_parent_tree_id(parent_id)
 
1102
        finally:
 
1103
            other_tree.unlock()
 
1104
        other_tree.bzrdir.retire_bzrdir()
 
1105
 
 
1106
    def _setup_directory_is_tree_reference(self):
 
1107
        if self._branch.repository._format.supports_tree_reference:
 
1108
            self._directory_is_tree_reference = \
 
1109
                self._directory_may_be_tree_reference
 
1110
        else:
 
1111
            self._directory_is_tree_reference = \
 
1112
                self._directory_is_never_tree_reference
 
1113
 
 
1114
    def _directory_is_never_tree_reference(self, relpath):
 
1115
        return False
 
1116
 
 
1117
    def _directory_may_be_tree_reference(self, relpath):
 
1118
        # as a special case, if a directory contains control files then
 
1119
        # it's a tree reference, except that the root of the tree is not
 
1120
        return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
 
1121
        # TODO: We could ask all the control formats whether they
 
1122
        # recognize this directory, but at the moment there's no cheap api
 
1123
        # to do that.  Since we probably can only nest bzr checkouts and
 
1124
        # they always use this name it's ok for now.  -- mbp 20060306
 
1125
        #
 
1126
        # FIXME: There is an unhandled case here of a subdirectory
 
1127
        # containing .bzr but not a branch; that will probably blow up
 
1128
        # when you try to commit it.  It might happen if there is a
 
1129
        # checkout in a subdirectory.  This can be avoided by not adding
 
1130
        # it.  mbp 20070306
 
1131
 
 
1132
    @needs_tree_write_lock
 
1133
    def extract(self, file_id, format=None):
 
1134
        """Extract a subtree from this tree.
 
1135
 
 
1136
        A new branch will be created, relative to the path for this tree.
 
1137
        """
 
1138
        self.flush()
 
1139
        def mkdirs(path):
 
1140
            segments = osutils.splitpath(path)
 
1141
            transport = self.branch.bzrdir.root_transport
 
1142
            for name in segments:
 
1143
                transport = transport.clone(name)
 
1144
                transport.ensure_base()
 
1145
            return transport
 
1146
 
 
1147
        sub_path = self.id2path(file_id)
 
1148
        branch_transport = mkdirs(sub_path)
 
1149
        if format is None:
 
1150
            format = self.bzrdir.cloning_metadir()
 
1151
        branch_transport.ensure_base()
 
1152
        branch_bzrdir = format.initialize_on_transport(branch_transport)
 
1153
        try:
 
1154
            repo = branch_bzrdir.find_repository()
 
1155
        except errors.NoRepositoryPresent:
 
1156
            repo = branch_bzrdir.create_repository()
 
1157
        if not repo.supports_rich_root():
 
1158
            raise errors.RootNotRich()
 
1159
        new_branch = branch_bzrdir.create_branch()
 
1160
        new_branch.pull(self.branch)
 
1161
        for parent_id in self.get_parent_ids():
 
1162
            new_branch.fetch(self.branch, parent_id)
 
1163
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
 
1164
        if tree_transport.base != branch_transport.base:
 
1165
            tree_bzrdir = format.initialize_on_transport(tree_transport)
 
1166
            branch.BranchReferenceFormat().initialize(tree_bzrdir,
 
1167
                target_branch=new_branch)
 
1168
        else:
 
1169
            tree_bzrdir = branch_bzrdir
 
1170
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
 
1171
        wt.set_parent_ids(self.get_parent_ids())
 
1172
        my_inv = self.inventory
 
1173
        child_inv = inventory.Inventory(root_id=None)
 
1174
        new_root = my_inv[file_id]
 
1175
        my_inv.remove_recursive_id(file_id)
 
1176
        new_root.parent_id = None
 
1177
        child_inv.add(new_root)
 
1178
        self._write_inventory(my_inv)
 
1179
        wt._write_inventory(child_inv)
 
1180
        return wt
 
1181
 
 
1182
    def _serialize(self, inventory, out_file):
 
1183
        xml5.serializer_v5.write_inventory(self._inventory, out_file,
 
1184
            working=True)
 
1185
 
 
1186
    def _deserialize(selt, in_file):
 
1187
        return xml5.serializer_v5.read_inventory(in_file)
 
1188
 
 
1189
    def flush(self):
 
1190
        """Write the in memory inventory to disk."""
 
1191
        # TODO: Maybe this should only write on dirty ?
 
1192
        if self._control_files._lock_mode != 'w':
 
1193
            raise errors.NotWriteLocked(self)
 
1194
        sio = StringIO()
 
1195
        self._serialize(self._inventory, sio)
 
1196
        sio.seek(0)
 
1197
        self._transport.put_file('inventory', sio,
 
1198
            mode=self.bzrdir._get_file_mode())
 
1199
        self._inventory_is_modified = False
 
1200
 
 
1201
    def _kind(self, relpath):
 
1202
        return osutils.file_kind(self.abspath(relpath))
 
1203
 
 
1204
    def list_files(self, include_root=False, from_dir=None, recursive=True):
 
1205
        """List all files as (path, class, kind, id, entry).
660
1206
 
661
1207
        Lists, but does not descend into unversioned directories.
662
 
 
663
1208
        This does not include files that have been deleted in this
664
 
        tree.
 
1209
        tree. Skips the control directory.
665
1210
 
666
 
        Skips the control directory.
 
1211
        :param include_root: if True, return an entry for the root
 
1212
        :param from_dir: start from this directory or None for the root
 
1213
        :param recursive: whether to recurse into subdirectories or not
667
1214
        """
668
 
        inv = self._inventory
669
 
 
670
 
        def descend(from_dir_relpath, from_dir_id, dp):
671
 
            ls = os.listdir(dp)
672
 
            ls.sort()
673
 
            for f in ls:
 
1215
        # list_files is an iterator, so @needs_read_lock doesn't work properly
 
1216
        # with it. So callers should be careful to always read_lock the tree.
 
1217
        if not self.is_locked():
 
1218
            raise errors.ObjectNotLocked(self)
 
1219
 
 
1220
        inv = self.inventory
 
1221
        if from_dir is None and include_root is True:
 
1222
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
 
1223
        # Convert these into local objects to save lookup times
 
1224
        pathjoin = osutils.pathjoin
 
1225
        file_kind = self._kind
 
1226
 
 
1227
        # transport.base ends in a slash, we want the piece
 
1228
        # between the last two slashes
 
1229
        transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
 
1230
 
 
1231
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
 
1232
 
 
1233
        # directory file_id, relative path, absolute path, reverse sorted children
 
1234
        if from_dir is not None:
 
1235
            from_dir_id = inv.path2id(from_dir)
 
1236
            if from_dir_id is None:
 
1237
                # Directory not versioned
 
1238
                return
 
1239
            from_dir_abspath = pathjoin(self.basedir, from_dir)
 
1240
        else:
 
1241
            from_dir_id = inv.root.file_id
 
1242
            from_dir_abspath = self.basedir
 
1243
        children = os.listdir(from_dir_abspath)
 
1244
        children.sort()
 
1245
        # jam 20060527 The kernel sized tree seems equivalent whether we
 
1246
        # use a deque and popleft to keep them sorted, or if we use a plain
 
1247
        # list and just reverse() them.
 
1248
        children = collections.deque(children)
 
1249
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
 
1250
        while stack:
 
1251
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
 
1252
 
 
1253
            while children:
 
1254
                f = children.popleft()
674
1255
                ## TODO: If we find a subdirectory with its own .bzr
675
1256
                ## directory, then that is a separate tree and we
676
1257
                ## should exclude it.
677
1258
 
678
1259
                # the bzrdir for this tree
679
 
                if self.bzrdir.transport.base.endswith(f + '/'):
 
1260
                if transport_base_dir == f:
680
1261
                    continue
681
1262
 
682
 
                # path within tree
683
 
                fp = appendpath(from_dir_relpath, f)
 
1263
                # we know that from_dir_relpath and from_dir_abspath never end in a slash
 
1264
                # and 'f' doesn't begin with one, we can do a string op, rather
 
1265
                # than the checks of pathjoin(), all relative paths will have an extra slash
 
1266
                # at the beginning
 
1267
                fp = from_dir_relpath + '/' + f
684
1268
 
685
1269
                # absolute path
686
 
                fap = appendpath(dp, f)
687
 
                
688
 
                f_ie = inv.get_child(from_dir_id, f)
 
1270
                fap = from_dir_abspath + '/' + f
 
1271
 
 
1272
                dir_ie = inv[from_dir_id]
 
1273
                if dir_ie.kind == 'directory':
 
1274
                    f_ie = dir_ie.children.get(f)
 
1275
                else:
 
1276
                    f_ie = None
689
1277
                if f_ie:
690
1278
                    c = 'V'
691
 
                elif self.is_ignored(fp):
 
1279
                elif self.is_ignored(fp[1:]):
692
1280
                    c = 'I'
693
1281
                else:
694
 
                    c = '?'
 
1282
                    # we may not have found this file, because of a unicode
 
1283
                    # issue, or because the directory was actually a symlink.
 
1284
                    f_norm, can_access = osutils.normalized_filename(f)
 
1285
                    if f == f_norm or not can_access:
 
1286
                        # No change, so treat this file normally
 
1287
                        c = '?'
 
1288
                    else:
 
1289
                        # this file can be accessed by a normalized path
 
1290
                        # check again if it is versioned
 
1291
                        # these lines are repeated here for performance
 
1292
                        f = f_norm
 
1293
                        fp = from_dir_relpath + '/' + f
 
1294
                        fap = from_dir_abspath + '/' + f
 
1295
                        f_ie = inv.get_child(from_dir_id, f)
 
1296
                        if f_ie:
 
1297
                            c = 'V'
 
1298
                        elif self.is_ignored(fp[1:]):
 
1299
                            c = 'I'
 
1300
                        else:
 
1301
                            c = '?'
695
1302
 
696
1303
                fk = file_kind(fap)
697
1304
 
698
 
                if f_ie:
699
 
                    if f_ie.kind != fk:
700
 
                        raise BzrCheckError("file %r entered as kind %r id %r, "
701
 
                                            "now of kind %r"
702
 
                                            % (fap, f_ie.kind, f_ie.file_id, fk))
703
 
 
704
1305
                # make a last minute entry
705
1306
                if f_ie:
706
 
                    entry = f_ie
 
1307
                    yield fp[1:], c, fk, f_ie.file_id, f_ie
707
1308
                else:
708
 
                    if fk == 'directory':
709
 
                        entry = TreeDirectory()
710
 
                    elif fk == 'file':
711
 
                        entry = TreeFile()
712
 
                    elif fk == 'symlink':
713
 
                        entry = TreeLink()
714
 
                    else:
715
 
                        entry = TreeEntry()
716
 
                
717
 
                yield fp, c, fk, (f_ie and f_ie.file_id), entry
 
1309
                    try:
 
1310
                        yield fp[1:], c, fk, None, fk_entries[fk]()
 
1311
                    except KeyError:
 
1312
                        yield fp[1:], c, fk, None, TreeEntry()
 
1313
                    continue
718
1314
 
719
1315
                if fk != 'directory':
720
1316
                    continue
721
1317
 
722
 
                if c != 'V':
723
 
                    # don't descend unversioned directories
724
 
                    continue
725
 
                
726
 
                for ff in descend(fp, f_ie.file_id, fap):
727
 
                    yield ff
728
 
 
729
 
        for f in descend(u'', inv.root.file_id, self.basedir):
730
 
            yield f
731
 
 
732
 
    @needs_write_lock
733
 
    def move(self, from_paths, to_name):
 
1318
                # But do this child first if recursing down
 
1319
                if recursive:
 
1320
                    new_children = os.listdir(fap)
 
1321
                    new_children.sort()
 
1322
                    new_children = collections.deque(new_children)
 
1323
                    stack.append((f_ie.file_id, fp, fap, new_children))
 
1324
                    # Break out of inner loop,
 
1325
                    # so that we start outer loop with child
 
1326
                    break
 
1327
            else:
 
1328
                # if we finished all children, pop it off the stack
 
1329
                stack.pop()
 
1330
 
 
1331
    @needs_tree_write_lock
 
1332
    def move(self, from_paths, to_dir=None, after=False):
734
1333
        """Rename files.
735
1334
 
736
 
        to_name must exist in the inventory.
737
 
 
738
 
        If to_name exists and is a directory, the files are moved into
739
 
        it, keeping their old names.  
740
 
 
741
 
        Note that to_name is only the last component of the new name;
 
1335
        to_dir must exist in the inventory.
 
1336
 
 
1337
        If to_dir exists and is a directory, the files are moved into
 
1338
        it, keeping their old names.
 
1339
 
 
1340
        Note that to_dir is only the last component of the new name;
742
1341
        this doesn't change the directory.
743
1342
 
 
1343
        For each entry in from_paths the move mode will be determined
 
1344
        independently.
 
1345
 
 
1346
        The first mode moves the file in the filesystem and updates the
 
1347
        inventory. The second mode only updates the inventory without
 
1348
        touching the file on the filesystem. This is the new mode introduced
 
1349
        in version 0.15.
 
1350
 
 
1351
        move uses the second mode if 'after == True' and the target is not
 
1352
        versioned but present in the working tree.
 
1353
 
 
1354
        move uses the second mode if 'after == False' and the source is
 
1355
        versioned but no longer in the working tree, and the target is not
 
1356
        versioned but present in the working tree.
 
1357
 
 
1358
        move uses the first mode if 'after == False' and the source is
 
1359
        versioned and present in the working tree, and the target is not
 
1360
        versioned and not present in the working tree.
 
1361
 
 
1362
        Everything else results in an error.
 
1363
 
744
1364
        This returns a list of (from_path, to_path) pairs for each
745
1365
        entry that is moved.
746
1366
        """
747
 
        result = []
748
 
        ## TODO: Option to move IDs only
749
 
        assert not isinstance(from_paths, basestring)
 
1367
        rename_entries = []
 
1368
        rename_tuples = []
 
1369
 
 
1370
        # check for deprecated use of signature
 
1371
        if to_dir is None:
 
1372
            raise TypeError('You must supply a target directory')
 
1373
        # check destination directory
 
1374
        if isinstance(from_paths, basestring):
 
1375
            raise ValueError()
750
1376
        inv = self.inventory
751
 
        to_abs = self.abspath(to_name)
 
1377
        to_abs = self.abspath(to_dir)
752
1378
        if not isdir(to_abs):
753
 
            raise BzrError("destination %r is not a directory" % to_abs)
754
 
        if not self.has_filename(to_name):
755
 
            raise BzrError("destination %r not in working directory" % to_abs)
756
 
        to_dir_id = inv.path2id(to_name)
757
 
        if to_dir_id == None and to_name != '':
758
 
            raise BzrError("destination %r is not a versioned directory" % to_name)
 
1379
            raise errors.BzrMoveFailedError('',to_dir,
 
1380
                errors.NotADirectory(to_abs))
 
1381
        if not self.has_filename(to_dir):
 
1382
            raise errors.BzrMoveFailedError('',to_dir,
 
1383
                errors.NotInWorkingDirectory(to_dir))
 
1384
        to_dir_id = inv.path2id(to_dir)
 
1385
        if to_dir_id is None:
 
1386
            raise errors.BzrMoveFailedError('',to_dir,
 
1387
                errors.NotVersionedError(path=to_dir))
 
1388
 
759
1389
        to_dir_ie = inv[to_dir_id]
760
 
        if to_dir_ie.kind not in ('directory', 'root_directory'):
761
 
            raise BzrError("destination %r is not a directory" % to_abs)
762
 
 
763
 
        to_idpath = inv.get_idpath(to_dir_id)
764
 
 
765
 
        for f in from_paths:
766
 
            if not self.has_filename(f):
767
 
                raise BzrError("%r does not exist in working tree" % f)
768
 
            f_id = inv.path2id(f)
769
 
            if f_id == None:
770
 
                raise BzrError("%r is not versioned" % f)
771
 
            name_tail = splitpath(f)[-1]
772
 
            dest_path = appendpath(to_name, name_tail)
773
 
            if self.has_filename(dest_path):
774
 
                raise BzrError("destination %r already exists" % dest_path)
775
 
            if f_id in to_idpath:
776
 
                raise BzrError("can't move %r to a subdirectory of itself" % f)
777
 
 
778
 
        # OK, so there's a race here, it's possible that someone will
779
 
        # create a file in this interval and then the rename might be
780
 
        # left half-done.  But we should have caught most problems.
781
 
        orig_inv = deepcopy(self.inventory)
 
1390
        if to_dir_ie.kind != 'directory':
 
1391
            raise errors.BzrMoveFailedError('',to_dir,
 
1392
                errors.NotADirectory(to_abs))
 
1393
 
 
1394
        # create rename entries and tuples
 
1395
        for from_rel in from_paths:
 
1396
            from_tail = splitpath(from_rel)[-1]
 
1397
            from_id = inv.path2id(from_rel)
 
1398
            if from_id is None:
 
1399
                raise errors.BzrMoveFailedError(from_rel,to_dir,
 
1400
                    errors.NotVersionedError(path=from_rel))
 
1401
 
 
1402
            from_entry = inv[from_id]
 
1403
            from_parent_id = from_entry.parent_id
 
1404
            to_rel = pathjoin(to_dir, from_tail)
 
1405
            rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
 
1406
                                         from_id=from_id,
 
1407
                                         from_tail=from_tail,
 
1408
                                         from_parent_id=from_parent_id,
 
1409
                                         to_rel=to_rel, to_tail=from_tail,
 
1410
                                         to_parent_id=to_dir_id)
 
1411
            rename_entries.append(rename_entry)
 
1412
            rename_tuples.append((from_rel, to_rel))
 
1413
 
 
1414
        # determine which move mode to use. checks also for movability
 
1415
        rename_entries = self._determine_mv_mode(rename_entries, after)
 
1416
 
 
1417
        original_modified = self._inventory_is_modified
782
1418
        try:
783
 
            for f in from_paths:
784
 
                name_tail = splitpath(f)[-1]
785
 
                dest_path = appendpath(to_name, name_tail)
786
 
                result.append((f, dest_path))
787
 
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
788
 
                try:
789
 
                    rename(self.abspath(f), self.abspath(dest_path))
790
 
                except OSError, e:
791
 
                    raise BzrError("failed to rename %r to %r: %s" %
792
 
                                   (f, dest_path, e[1]),
793
 
                            ["rename rolled back"])
 
1419
            if len(from_paths):
 
1420
                self._inventory_is_modified = True
 
1421
            self._move(rename_entries)
794
1422
        except:
795
1423
            # restore the inventory on error
796
 
            self._set_inventory(orig_inv)
 
1424
            self._inventory_is_modified = original_modified
797
1425
            raise
798
1426
        self._write_inventory(inv)
799
 
        return result
800
 
 
801
 
    @needs_write_lock
802
 
    def rename_one(self, from_rel, to_rel):
 
1427
        return rename_tuples
 
1428
 
 
1429
    def _determine_mv_mode(self, rename_entries, after=False):
 
1430
        """Determines for each from-to pair if both inventory and working tree
 
1431
        or only the inventory has to be changed.
 
1432
 
 
1433
        Also does basic plausability tests.
 
1434
        """
 
1435
        inv = self.inventory
 
1436
 
 
1437
        for rename_entry in rename_entries:
 
1438
            # store to local variables for easier reference
 
1439
            from_rel = rename_entry.from_rel
 
1440
            from_id = rename_entry.from_id
 
1441
            to_rel = rename_entry.to_rel
 
1442
            to_id = inv.path2id(to_rel)
 
1443
            only_change_inv = False
 
1444
 
 
1445
            # check the inventory for source and destination
 
1446
            if from_id is None:
 
1447
                raise errors.BzrMoveFailedError(from_rel,to_rel,
 
1448
                    errors.NotVersionedError(path=from_rel))
 
1449
            if to_id is not None:
 
1450
                raise errors.BzrMoveFailedError(from_rel,to_rel,
 
1451
                    errors.AlreadyVersionedError(path=to_rel))
 
1452
 
 
1453
            # try to determine the mode for rename (only change inv or change
 
1454
            # inv and file system)
 
1455
            if after:
 
1456
                if not self.has_filename(to_rel):
 
1457
                    raise errors.BzrMoveFailedError(from_id,to_rel,
 
1458
                        errors.NoSuchFile(path=to_rel,
 
1459
                        extra="New file has not been created yet"))
 
1460
                only_change_inv = True
 
1461
            elif not self.has_filename(from_rel) and self.has_filename(to_rel):
 
1462
                only_change_inv = True
 
1463
            elif self.has_filename(from_rel) and not self.has_filename(to_rel):
 
1464
                only_change_inv = False
 
1465
            elif (not self.case_sensitive
 
1466
                  and from_rel.lower() == to_rel.lower()
 
1467
                  and self.has_filename(from_rel)):
 
1468
                only_change_inv = False
 
1469
            else:
 
1470
                # something is wrong, so lets determine what exactly
 
1471
                if not self.has_filename(from_rel) and \
 
1472
                   not self.has_filename(to_rel):
 
1473
                    raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1474
                        errors.PathsDoNotExist(paths=(str(from_rel),
 
1475
                        str(to_rel))))
 
1476
                else:
 
1477
                    raise errors.RenameFailedFilesExist(from_rel, to_rel)
 
1478
            rename_entry.only_change_inv = only_change_inv
 
1479
        return rename_entries
 
1480
 
 
1481
    def _move(self, rename_entries):
 
1482
        """Moves a list of files.
 
1483
 
 
1484
        Depending on the value of the flag 'only_change_inv', the
 
1485
        file will be moved on the file system or not.
 
1486
        """
 
1487
        inv = self.inventory
 
1488
        moved = []
 
1489
 
 
1490
        for entry in rename_entries:
 
1491
            try:
 
1492
                self._move_entry(entry)
 
1493
            except:
 
1494
                self._rollback_move(moved)
 
1495
                raise
 
1496
            moved.append(entry)
 
1497
 
 
1498
    def _rollback_move(self, moved):
 
1499
        """Try to rollback a previous move in case of an filesystem error."""
 
1500
        inv = self.inventory
 
1501
        for entry in moved:
 
1502
            try:
 
1503
                self._move_entry(WorkingTree._RenameEntry(
 
1504
                    entry.to_rel, entry.from_id,
 
1505
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
 
1506
                    entry.from_tail, entry.from_parent_id,
 
1507
                    entry.only_change_inv))
 
1508
            except errors.BzrMoveFailedError, e:
 
1509
                raise errors.BzrMoveFailedError( '', '', "Rollback failed."
 
1510
                        " The working tree is in an inconsistent state."
 
1511
                        " Please consider doing a 'bzr revert'."
 
1512
                        " Error message is: %s" % e)
 
1513
 
 
1514
    def _move_entry(self, entry):
 
1515
        inv = self.inventory
 
1516
        from_rel_abs = self.abspath(entry.from_rel)
 
1517
        to_rel_abs = self.abspath(entry.to_rel)
 
1518
        if from_rel_abs == to_rel_abs:
 
1519
            raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
 
1520
                "Source and target are identical.")
 
1521
 
 
1522
        if not entry.only_change_inv:
 
1523
            try:
 
1524
                osutils.rename(from_rel_abs, to_rel_abs)
 
1525
            except OSError, e:
 
1526
                raise errors.BzrMoveFailedError(entry.from_rel,
 
1527
                    entry.to_rel, e[1])
 
1528
        inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
 
1529
 
 
1530
    @needs_tree_write_lock
 
1531
    def rename_one(self, from_rel, to_rel, after=False):
803
1532
        """Rename one file.
804
1533
 
805
1534
        This can change the directory or the filename or both.
 
1535
 
 
1536
        rename_one has several 'modes' to work. First, it can rename a physical
 
1537
        file and change the file_id. That is the normal mode. Second, it can
 
1538
        only change the file_id without touching any physical file. This is
 
1539
        the new mode introduced in version 0.15.
 
1540
 
 
1541
        rename_one uses the second mode if 'after == True' and 'to_rel' is not
 
1542
        versioned but present in the working tree.
 
1543
 
 
1544
        rename_one uses the second mode if 'after == False' and 'from_rel' is
 
1545
        versioned but no longer in the working tree, and 'to_rel' is not
 
1546
        versioned but present in the working tree.
 
1547
 
 
1548
        rename_one uses the first mode if 'after == False' and 'from_rel' is
 
1549
        versioned and present in the working tree, and 'to_rel' is not
 
1550
        versioned and not present in the working tree.
 
1551
 
 
1552
        Everything else results in an error.
806
1553
        """
807
1554
        inv = self.inventory
808
 
        if not self.has_filename(from_rel):
809
 
            raise BzrError("can't rename: old working file %r does not exist" % from_rel)
810
 
        if self.has_filename(to_rel):
811
 
            raise BzrError("can't rename: new working file %r already exists" % to_rel)
812
 
 
813
 
        file_id = inv.path2id(from_rel)
814
 
        if file_id == None:
815
 
            raise BzrError("can't rename: old name %r is not versioned" % from_rel)
816
 
 
817
 
        entry = inv[file_id]
818
 
        from_parent = entry.parent_id
819
 
        from_name = entry.name
820
 
        
821
 
        if inv.path2id(to_rel):
822
 
            raise BzrError("can't rename: new name %r is already versioned" % to_rel)
823
 
 
 
1555
        rename_entries = []
 
1556
 
 
1557
        # create rename entries and tuples
 
1558
        from_tail = splitpath(from_rel)[-1]
 
1559
        from_id = inv.path2id(from_rel)
 
1560
        if from_id is None:
 
1561
            # if file is missing in the inventory maybe it's in the basis_tree
 
1562
            basis_tree = self.branch.basis_tree()
 
1563
            from_id = basis_tree.path2id(from_rel)
 
1564
            if from_id is None:
 
1565
                raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1566
                    errors.NotVersionedError(path=from_rel))
 
1567
            # put entry back in the inventory so we can rename it
 
1568
            from_entry = basis_tree.inventory[from_id].copy()
 
1569
            inv.add(from_entry)
 
1570
        else:
 
1571
            from_entry = inv[from_id]
 
1572
        from_parent_id = from_entry.parent_id
824
1573
        to_dir, to_tail = os.path.split(to_rel)
825
1574
        to_dir_id = inv.path2id(to_dir)
826
 
        if to_dir_id == None and to_dir != '':
827
 
            raise BzrError("can't determine destination directory id for %r" % to_dir)
828
 
 
829
 
        mutter("rename_one:")
830
 
        mutter("  file_id    {%s}" % file_id)
831
 
        mutter("  from_rel   %r" % from_rel)
832
 
        mutter("  to_rel     %r" % to_rel)
833
 
        mutter("  to_dir     %r" % to_dir)
834
 
        mutter("  to_dir_id  {%s}" % to_dir_id)
835
 
 
836
 
        inv.rename(file_id, to_dir_id, to_tail)
837
 
 
838
 
        from_abs = self.abspath(from_rel)
839
 
        to_abs = self.abspath(to_rel)
840
 
        try:
841
 
            rename(from_abs, to_abs)
842
 
        except OSError, e:
843
 
            inv.rename(file_id, from_parent, from_name)
844
 
            raise BzrError("failed to rename %r to %r: %s"
845
 
                    % (from_abs, to_abs, e[1]),
846
 
                    ["rename rolled back"])
 
1575
        rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
 
1576
                                     from_id=from_id,
 
1577
                                     from_tail=from_tail,
 
1578
                                     from_parent_id=from_parent_id,
 
1579
                                     to_rel=to_rel, to_tail=to_tail,
 
1580
                                     to_parent_id=to_dir_id)
 
1581
        rename_entries.append(rename_entry)
 
1582
 
 
1583
        # determine which move mode to use. checks also for movability
 
1584
        rename_entries = self._determine_mv_mode(rename_entries, after)
 
1585
 
 
1586
        # check if the target changed directory and if the target directory is
 
1587
        # versioned
 
1588
        if to_dir_id is None:
 
1589
            raise errors.BzrMoveFailedError(from_rel,to_rel,
 
1590
                errors.NotVersionedError(path=to_dir))
 
1591
 
 
1592
        # all checks done. now we can continue with our actual work
 
1593
        mutter('rename_one:\n'
 
1594
               '  from_id   {%s}\n'
 
1595
               '  from_rel: %r\n'
 
1596
               '  to_rel:   %r\n'
 
1597
               '  to_dir    %r\n'
 
1598
               '  to_dir_id {%s}\n',
 
1599
               from_id, from_rel, to_rel, to_dir, to_dir_id)
 
1600
 
 
1601
        self._move(rename_entries)
847
1602
        self._write_inventory(inv)
848
1603
 
 
1604
    class _RenameEntry(object):
 
1605
        def __init__(self, from_rel, from_id, from_tail, from_parent_id,
 
1606
                     to_rel, to_tail, to_parent_id, only_change_inv=False):
 
1607
            self.from_rel = from_rel
 
1608
            self.from_id = from_id
 
1609
            self.from_tail = from_tail
 
1610
            self.from_parent_id = from_parent_id
 
1611
            self.to_rel = to_rel
 
1612
            self.to_tail = to_tail
 
1613
            self.to_parent_id = to_parent_id
 
1614
            self.only_change_inv = only_change_inv
 
1615
 
849
1616
    @needs_read_lock
850
1617
    def unknowns(self):
851
1618
        """Return all unknown files.
852
1619
 
853
1620
        These are files in the working directory that are not versioned or
854
1621
        control files or ignored.
855
 
        
856
 
        >>> from bzrlib.bzrdir import ScratchDir
857
 
        >>> d = ScratchDir(files=['foo', 'foo~'])
858
 
        >>> b = d.open_branch()
859
 
        >>> tree = d.open_workingtree()
860
 
        >>> map(str, tree.unknowns())
861
 
        ['foo']
862
 
        >>> tree.add('foo')
863
 
        >>> list(b.unknowns())
864
 
        []
865
 
        >>> tree.remove('foo')
866
 
        >>> list(b.unknowns())
867
 
        [u'foo']
868
 
        """
869
 
        for subp in self.extras():
870
 
            if not self.is_ignored(subp):
871
 
                yield subp
872
 
 
873
 
    @deprecated_method(zero_eight)
874
 
    def iter_conflicts(self):
875
 
        """List all files in the tree that have text or content conflicts.
876
 
        DEPRECATED.  Use conflicts instead."""
877
 
        return self._iter_conflicts()
 
1622
        """
 
1623
        # force the extras method to be fully executed before returning, to
 
1624
        # prevent race conditions with the lock
 
1625
        return iter(
 
1626
            [subp for subp in self.extras() if not self.is_ignored(subp)])
 
1627
 
 
1628
    @needs_tree_write_lock
 
1629
    def unversion(self, file_ids):
 
1630
        """Remove the file ids in file_ids from the current versioned set.
 
1631
 
 
1632
        When a file_id is unversioned, all of its children are automatically
 
1633
        unversioned.
 
1634
 
 
1635
        :param file_ids: The file ids to stop versioning.
 
1636
        :raises: NoSuchId if any fileid is not currently versioned.
 
1637
        """
 
1638
        for file_id in file_ids:
 
1639
            if file_id not in self._inventory:
 
1640
                raise errors.NoSuchId(self, file_id)
 
1641
        for file_id in file_ids:
 
1642
            if self._inventory.has_id(file_id):
 
1643
                self._inventory.remove_recursive_id(file_id)
 
1644
        if len(file_ids):
 
1645
            # in the future this should just set a dirty bit to wait for the
 
1646
            # final unlock. However, until all methods of workingtree start
 
1647
            # with the current in -memory inventory rather than triggering
 
1648
            # a read, it is more complex - we need to teach read_inventory
 
1649
            # to know when to read, and when to not read first... and possibly
 
1650
            # to save first when the in memory one may be corrupted.
 
1651
            # so for now, we just only write it if it is indeed dirty.
 
1652
            # - RBC 20060907
 
1653
            self._write_inventory(self._inventory)
878
1654
 
879
1655
    def _iter_conflicts(self):
880
1656
        conflicted = set()
881
 
        for path in (s[0] for s in self.list_files()):
 
1657
        for info in self.list_files():
 
1658
            path = info[0]
882
1659
            stem = get_conflicted_stem(path)
883
1660
            if stem is None:
884
1661
                continue
887
1664
                yield stem
888
1665
 
889
1666
    @needs_write_lock
890
 
    def pull(self, source, overwrite=False, stop_revision=None):
891
 
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1667
    def pull(self, source, overwrite=False, stop_revision=None,
 
1668
             change_reporter=None, possible_transports=None, local=False,
 
1669
             show_base=False):
892
1670
        source.lock_read()
893
1671
        try:
894
 
            pp = ProgressPhase("Pull phase", 2, top_pb)
895
 
            pp.next_phase()
896
 
            old_revision_history = self.branch.revision_history()
 
1672
            old_revision_info = self.branch.last_revision_info()
897
1673
            basis_tree = self.basis_tree()
898
 
            count = self.branch.pull(source, overwrite, stop_revision)
899
 
            new_revision_history = self.branch.revision_history()
900
 
            if new_revision_history != old_revision_history:
901
 
                pp.next_phase()
902
 
                if len(old_revision_history):
903
 
                    other_revision = old_revision_history[-1]
904
 
                else:
905
 
                    other_revision = None
 
1674
            count = self.branch.pull(source, overwrite, stop_revision,
 
1675
                                     possible_transports=possible_transports,
 
1676
                                     local=local)
 
1677
            new_revision_info = self.branch.last_revision_info()
 
1678
            if new_revision_info != old_revision_info:
906
1679
                repository = self.branch.repository
907
 
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1680
                basis_tree.lock_read()
908
1681
                try:
909
 
                    merge_inner(self.branch,
910
 
                                self.branch.basis_tree(),
911
 
                                basis_tree, 
912
 
                                this_tree=self, 
913
 
                                pb=pb)
 
1682
                    new_basis_tree = self.branch.basis_tree()
 
1683
                    merge.merge_inner(
 
1684
                                self.branch,
 
1685
                                new_basis_tree,
 
1686
                                basis_tree,
 
1687
                                this_tree=self,
 
1688
                                pb=None,
 
1689
                                change_reporter=change_reporter,
 
1690
                                show_base=show_base)
 
1691
                    basis_root_id = basis_tree.get_root_id()
 
1692
                    new_root_id = new_basis_tree.get_root_id()
 
1693
                    if basis_root_id != new_root_id:
 
1694
                        self.set_root_id(new_root_id)
914
1695
                finally:
915
 
                    pb.finished()
916
 
                self.set_last_revision(self.branch.last_revision())
 
1696
                    basis_tree.unlock()
 
1697
                # TODO - dedup parents list with things merged by pull ?
 
1698
                # reuse the revisiontree we merged against to set the new
 
1699
                # tree data.
 
1700
                parent_trees = [(self.branch.last_revision(), new_basis_tree)]
 
1701
                # we have to pull the merge trees out again, because
 
1702
                # merge_inner has set the ids. - this corner is not yet
 
1703
                # layered well enough to prevent double handling.
 
1704
                # XXX TODO: Fix the double handling: telling the tree about
 
1705
                # the already known parent data is wasteful.
 
1706
                merges = self.get_parent_ids()[1:]
 
1707
                parent_trees.extend([
 
1708
                    (parent, repository.revision_tree(parent)) for
 
1709
                     parent in merges])
 
1710
                self.set_parent_trees(parent_trees)
917
1711
            return count
918
1712
        finally:
919
1713
            source.unlock()
920
 
            top_pb.finished()
 
1714
 
 
1715
    @needs_write_lock
 
1716
    def put_file_bytes_non_atomic(self, file_id, bytes):
 
1717
        """See MutableTree.put_file_bytes_non_atomic."""
 
1718
        stream = file(self.id2abspath(file_id), 'wb')
 
1719
        try:
 
1720
            stream.write(bytes)
 
1721
        finally:
 
1722
            stream.close()
 
1723
        # TODO: update the hashcache here ?
921
1724
 
922
1725
    def extras(self):
923
 
        """Yield all unknown files in this WorkingTree.
 
1726
        """Yield all unversioned files in this WorkingTree.
924
1727
 
925
 
        If there are any unknown directories then only the directory is
926
 
        returned, not all its children.  But if there are unknown files
 
1728
        If there are any unversioned directories then only the directory is
 
1729
        returned, not all its children.  But if there are unversioned files
927
1730
        under a versioned subdirectory, they are returned.
928
1731
 
929
1732
        Currently returned depth-first, sorted by name within directories.
 
1733
        This is the same order used by 'osutils.walkdirs'.
930
1734
        """
931
1735
        ## TODO: Work from given directory downwards
932
1736
        for path, dir_entry in self.inventory.directories():
933
 
            mutter("search for unknowns in %r", path)
 
1737
            # mutter("search for unknowns in %r", path)
934
1738
            dirabs = self.abspath(path)
935
1739
            if not isdir(dirabs):
936
1740
                # e.g. directory deleted
938
1742
 
939
1743
            fl = []
940
1744
            for subf in os.listdir(dirabs):
941
 
                if (subf != '.bzr'
942
 
                    and (subf not in dir_entry.children)):
943
 
                    fl.append(subf)
944
 
            
 
1745
                if self.bzrdir.is_control_filename(subf):
 
1746
                    continue
 
1747
                if subf not in dir_entry.children:
 
1748
                    try:
 
1749
                        (subf_norm,
 
1750
                         can_access) = osutils.normalized_filename(subf)
 
1751
                    except UnicodeDecodeError:
 
1752
                        path_os_enc = path.encode(osutils._fs_enc)
 
1753
                        relpath = path_os_enc + '/' + subf
 
1754
                        raise errors.BadFilenameEncoding(relpath,
 
1755
                                                         osutils._fs_enc)
 
1756
                    if subf_norm != subf and can_access:
 
1757
                        if subf_norm not in dir_entry.children:
 
1758
                            fl.append(subf_norm)
 
1759
                    else:
 
1760
                        fl.append(subf)
 
1761
 
945
1762
            fl.sort()
946
1763
            for subf in fl:
947
 
                subp = appendpath(path, subf)
 
1764
                subp = pathjoin(path, subf)
948
1765
                yield subp
949
1766
 
950
 
 
951
1767
    def ignored_files(self):
952
1768
        """Yield list of PATH, IGNORE_PATTERN"""
953
1769
        for subp in self.extras():
954
1770
            pat = self.is_ignored(subp)
955
 
            if pat != None:
 
1771
            if pat is not None:
956
1772
                yield subp, pat
957
1773
 
958
 
 
959
1774
    def get_ignore_list(self):
960
1775
        """Return list of ignore patterns.
961
1776
 
962
1777
        Cached in the Tree object after the first call.
963
1778
        """
964
 
        if hasattr(self, '_ignorelist'):
965
 
            return self._ignorelist
 
1779
        ignoreset = getattr(self, '_ignoreset', None)
 
1780
        if ignoreset is not None:
 
1781
            return ignoreset
966
1782
 
967
 
        l = bzrlib.DEFAULT_IGNORE[:]
 
1783
        ignore_globs = set()
 
1784
        ignore_globs.update(ignores.get_runtime_ignores())
 
1785
        ignore_globs.update(ignores.get_user_ignores())
968
1786
        if self.has_filename(bzrlib.IGNORE_FILENAME):
969
1787
            f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
970
 
            l.extend([line.rstrip("\n\r") for line in f.readlines()])
971
 
        self._ignorelist = l
972
 
        return l
 
1788
            try:
 
1789
                ignore_globs.update(ignores.parse_ignore_file(f))
 
1790
            finally:
 
1791
                f.close()
 
1792
        self._ignoreset = ignore_globs
 
1793
        return ignore_globs
973
1794
 
 
1795
    def _flush_ignore_list_cache(self):
 
1796
        """Resets the cached ignore list to force a cache rebuild."""
 
1797
        self._ignoreset = None
 
1798
        self._ignoreglobster = None
974
1799
 
975
1800
    def is_ignored(self, filename):
976
1801
        r"""Check whether the filename matches an ignore pattern.
977
1802
 
978
1803
        Patterns containing '/' or '\' need to match the whole path;
979
 
        others match against only the last component.
 
1804
        others match against only the last component.  Patterns starting
 
1805
        with '!' are ignore exceptions.  Exceptions take precedence
 
1806
        over regular patterns and cause the filename to not be ignored.
980
1807
 
981
1808
        If the file is ignored, returns the pattern which caused it to
982
1809
        be ignored, otherwise None.  So this can simply be used as a
983
1810
        boolean if desired."""
984
 
 
985
 
        # TODO: Use '**' to match directories, and other extended
986
 
        # globbing stuff from cvs/rsync.
987
 
 
988
 
        # XXX: fnmatch is actually not quite what we want: it's only
989
 
        # approximately the same as real Unix fnmatch, and doesn't
990
 
        # treat dotfiles correctly and allows * to match /.
991
 
        # Eventually it should be replaced with something more
992
 
        # accurate.
993
 
        
994
 
        for pat in self.get_ignore_list():
995
 
            if '/' in pat or '\\' in pat:
996
 
                
997
 
                # as a special case, you can put ./ at the start of a
998
 
                # pattern; this is good to match in the top-level
999
 
                # only;
1000
 
                
1001
 
                if (pat[:2] == './') or (pat[:2] == '.\\'):
1002
 
                    newpat = pat[2:]
1003
 
                else:
1004
 
                    newpat = pat
1005
 
                if fnmatch.fnmatchcase(filename, newpat):
1006
 
                    return pat
1007
 
            else:
1008
 
                if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
1009
 
                    return pat
1010
 
        else:
1011
 
            return None
 
1811
        if getattr(self, '_ignoreglobster', None) is None:
 
1812
            self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
 
1813
        return self._ignoreglobster.match(filename)
1012
1814
 
1013
1815
    def kind(self, file_id):
1014
1816
        return file_kind(self.id2abspath(file_id))
1015
1817
 
1016
 
    @needs_read_lock
 
1818
    def stored_kind(self, file_id):
 
1819
        """See Tree.stored_kind"""
 
1820
        return self.inventory[file_id].kind
 
1821
 
 
1822
    def _comparison_data(self, entry, path):
 
1823
        abspath = self.abspath(path)
 
1824
        try:
 
1825
            stat_value = os.lstat(abspath)
 
1826
        except OSError, e:
 
1827
            if getattr(e, 'errno', None) == errno.ENOENT:
 
1828
                stat_value = None
 
1829
                kind = None
 
1830
                executable = False
 
1831
            else:
 
1832
                raise
 
1833
        else:
 
1834
            mode = stat_value.st_mode
 
1835
            kind = osutils.file_kind_from_stat_mode(mode)
 
1836
            if not supports_executable():
 
1837
                executable = entry is not None and entry.executable
 
1838
            else:
 
1839
                executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
 
1840
        return kind, executable, stat_value
 
1841
 
 
1842
    def _file_size(self, entry, stat_value):
 
1843
        return stat_value.st_size
 
1844
 
1017
1845
    def last_revision(self):
1018
 
        """Return the last revision id of this working tree.
1019
 
 
1020
 
        In early branch formats this was == the branch last_revision,
1021
 
        but that cannot be relied upon - for working tree operations,
1022
 
        always use tree.last_revision().
 
1846
        """Return the last revision of the branch for this tree.
 
1847
 
 
1848
        This format tree does not support a separate marker for last-revision
 
1849
        compared to the branch.
 
1850
 
 
1851
        See MutableTree.last_revision
1023
1852
        """
1024
 
        return self.branch.last_revision()
 
1853
        return self._last_revision()
 
1854
 
 
1855
    @needs_read_lock
 
1856
    def _last_revision(self):
 
1857
        """helper for get_parent_ids."""
 
1858
        return _mod_revision.ensure_null(self.branch.last_revision())
 
1859
 
 
1860
    def is_locked(self):
 
1861
        return self._control_files.is_locked()
 
1862
 
 
1863
    def _must_be_locked(self):
 
1864
        if not self.is_locked():
 
1865
            raise errors.ObjectNotLocked(self)
1025
1866
 
1026
1867
    def lock_read(self):
1027
 
        """See Branch.lock_read, and WorkingTree.unlock."""
1028
 
        self.branch.lock_read()
1029
 
        try:
1030
 
            return self._control_files.lock_read()
 
1868
        """Lock the tree for reading.
 
1869
 
 
1870
        This also locks the branch, and can be unlocked via self.unlock().
 
1871
 
 
1872
        :return: A bzrlib.lock.LogicalLockResult.
 
1873
        """
 
1874
        if not self.is_locked():
 
1875
            self._reset_data()
 
1876
        self.branch.lock_read()
 
1877
        try:
 
1878
            self._control_files.lock_read()
 
1879
            return LogicalLockResult(self.unlock)
 
1880
        except:
 
1881
            self.branch.unlock()
 
1882
            raise
 
1883
 
 
1884
    def lock_tree_write(self):
 
1885
        """See MutableTree.lock_tree_write, and WorkingTree.unlock.
 
1886
 
 
1887
        :return: A bzrlib.lock.LogicalLockResult.
 
1888
        """
 
1889
        if not self.is_locked():
 
1890
            self._reset_data()
 
1891
        self.branch.lock_read()
 
1892
        try:
 
1893
            self._control_files.lock_write()
 
1894
            return LogicalLockResult(self.unlock)
1031
1895
        except:
1032
1896
            self.branch.unlock()
1033
1897
            raise
1034
1898
 
1035
1899
    def lock_write(self):
1036
 
        """See Branch.lock_write, and WorkingTree.unlock."""
 
1900
        """See MutableTree.lock_write, and WorkingTree.unlock.
 
1901
 
 
1902
        :return: A bzrlib.lock.LogicalLockResult.
 
1903
        """
 
1904
        if not self.is_locked():
 
1905
            self._reset_data()
1037
1906
        self.branch.lock_write()
1038
1907
        try:
1039
 
            return self._control_files.lock_write()
 
1908
            self._control_files.lock_write()
 
1909
            return LogicalLockResult(self.unlock)
1040
1910
        except:
1041
1911
            self.branch.unlock()
1042
1912
            raise
1043
1913
 
 
1914
    def get_physical_lock_status(self):
 
1915
        return self._control_files.get_physical_lock_status()
 
1916
 
1044
1917
    def _basis_inventory_name(self):
1045
 
        return 'basis-inventory'
1046
 
 
1047
 
    @needs_write_lock
 
1918
        return 'basis-inventory-cache'
 
1919
 
 
1920
    def _reset_data(self):
 
1921
        """Reset transient data that cannot be revalidated."""
 
1922
        self._inventory_is_modified = False
 
1923
        f = self._transport.get('inventory')
 
1924
        try:
 
1925
            result = self._deserialize(f)
 
1926
        finally:
 
1927
            f.close()
 
1928
        self._set_inventory(result, dirty=False)
 
1929
 
 
1930
    @needs_tree_write_lock
1048
1931
    def set_last_revision(self, new_revision):
1049
1932
        """Change the last revision in the working tree."""
1050
1933
        if self._change_last_revision(new_revision):
1052
1935
 
1053
1936
    def _change_last_revision(self, new_revision):
1054
1937
        """Template method part of set_last_revision to perform the change.
1055
 
        
 
1938
 
1056
1939
        This is used to allow WorkingTree3 instances to not affect branch
1057
1940
        when their last revision is set.
1058
1941
        """
1059
 
        if new_revision is None:
 
1942
        if _mod_revision.is_null(new_revision):
1060
1943
            self.branch.set_revision_history([])
1061
1944
            return False
1062
 
        # current format is locked in with the branch
1063
 
        revision_history = self.branch.revision_history()
1064
1945
        try:
1065
 
            position = revision_history.index(new_revision)
1066
 
        except ValueError:
1067
 
            raise errors.NoSuchRevision(self.branch, new_revision)
1068
 
        self.branch.set_revision_history(revision_history[:position + 1])
 
1946
            self.branch.generate_revision_history(new_revision)
 
1947
        except errors.NoSuchRevision:
 
1948
            # not present in the repo - dont try to set it deeper than the tip
 
1949
            self.branch.set_revision_history([new_revision])
1069
1950
        return True
1070
1951
 
 
1952
    def _write_basis_inventory(self, xml):
 
1953
        """Write the basis inventory XML to the basis-inventory file"""
 
1954
        path = self._basis_inventory_name()
 
1955
        sio = StringIO(xml)
 
1956
        self._transport.put_file(path, sio,
 
1957
            mode=self.bzrdir._get_file_mode())
 
1958
 
 
1959
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
 
1960
        """Create the text that will be saved in basis-inventory"""
 
1961
        inventory.revision_id = revision_id
 
1962
        return xml7.serializer_v7.write_inventory_to_string(inventory)
 
1963
 
1071
1964
    def _cache_basis_inventory(self, new_revision):
1072
1965
        """Cache new_revision as the basis inventory."""
 
1966
        # TODO: this should allow the ready-to-use inventory to be passed in,
 
1967
        # as commit already has that ready-to-use [while the format is the
 
1968
        # same, that is].
1073
1969
        try:
1074
 
            # this double handles the inventory - unpack and repack - 
 
1970
            # this double handles the inventory - unpack and repack -
1075
1971
            # but is easier to understand. We can/should put a conditional
1076
1972
            # in here based on whether the inventory is in the latest format
1077
1973
            # - perhaps we should repack all inventories on a repository
1078
1974
            # upgrade ?
1079
 
            inv = self.branch.repository.get_inventory(new_revision)
1080
 
            inv.revision_id = new_revision
1081
 
            xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1082
 
 
1083
 
            path = self._basis_inventory_name()
1084
 
            self._control_files.put_utf8(path, xml)
1085
 
        except WeaveRevisionNotPresent:
 
1975
            # the fast path is to copy the raw xml from the repository. If the
 
1976
            # xml contains 'revision_id="', then we assume the right
 
1977
            # revision_id is set. We must check for this full string, because a
 
1978
            # root node id can legitimately look like 'revision_id' but cannot
 
1979
            # contain a '"'.
 
1980
            xml = self.branch.repository._get_inventory_xml(new_revision)
 
1981
            firstline = xml.split('\n', 1)[0]
 
1982
            if (not 'revision_id="' in firstline or
 
1983
                'format="7"' not in firstline):
 
1984
                inv = self.branch.repository._serializer.read_inventory_from_string(
 
1985
                    xml, new_revision)
 
1986
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
 
1987
            self._write_basis_inventory(xml)
 
1988
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1086
1989
            pass
1087
1990
 
1088
1991
    def read_basis_inventory(self):
1089
1992
        """Read the cached basis inventory."""
1090
1993
        path = self._basis_inventory_name()
1091
 
        return self._control_files.get_utf8(path).read()
1092
 
        
 
1994
        return self._transport.get_bytes(path)
 
1995
 
1093
1996
    @needs_read_lock
1094
1997
    def read_working_inventory(self):
1095
 
        """Read the working inventory."""
 
1998
        """Read the working inventory.
 
1999
 
 
2000
        :raises errors.InventoryModified: read_working_inventory will fail
 
2001
            when the current in memory inventory has been modified.
 
2002
        """
 
2003
        # conceptually this should be an implementation detail of the tree.
 
2004
        # XXX: Deprecate this.
1096
2005
        # ElementTree does its own conversion from UTF-8, so open in
1097
2006
        # binary.
1098
 
        result = bzrlib.xml5.serializer_v5.read_inventory(
1099
 
            self._control_files.get('inventory'))
1100
 
        self._set_inventory(result)
 
2007
        if self._inventory_is_modified:
 
2008
            raise errors.InventoryModified(self)
 
2009
        f = self._transport.get('inventory')
 
2010
        try:
 
2011
            result = self._deserialize(f)
 
2012
        finally:
 
2013
            f.close()
 
2014
        self._set_inventory(result, dirty=False)
1101
2015
        return result
1102
2016
 
1103
 
    @needs_write_lock
1104
 
    def remove(self, files, verbose=False):
1105
 
        """Remove nominated files from the working inventory..
1106
 
 
1107
 
        This does not remove their text.  This does not run on XXX on what? RBC
1108
 
 
1109
 
        TODO: Refuse to remove modified files unless --force is given?
1110
 
 
1111
 
        TODO: Do something useful with directories.
1112
 
 
1113
 
        TODO: Should this remove the text or not?  Tough call; not
1114
 
        removing may be useful and the user can just use use rm, and
1115
 
        is the opposite of add.  Removing it is consistent with most
1116
 
        other tools.  Maybe an option.
 
2017
    @needs_tree_write_lock
 
2018
    def remove(self, files, verbose=False, to_file=None, keep_files=True,
 
2019
        force=False):
 
2020
        """Remove nominated files from the working inventory.
 
2021
 
 
2022
        :files: File paths relative to the basedir.
 
2023
        :keep_files: If true, the files will also be kept.
 
2024
        :force: Delete files and directories, even if they are changed and
 
2025
            even if the directories are not empty.
1117
2026
        """
1118
 
        ## TODO: Normalize names
1119
 
        ## TODO: Remove nested loops; better scalability
1120
2027
        if isinstance(files, basestring):
1121
2028
            files = [files]
1122
2029
 
1123
 
        inv = self.inventory
1124
 
 
1125
 
        # do this before any modifications
 
2030
        inv_delta = []
 
2031
 
 
2032
        all_files = set() # specified and nested files 
 
2033
        unknown_nested_files=set()
 
2034
        if to_file is None:
 
2035
            to_file = sys.stdout
 
2036
 
 
2037
        files_to_backup = []
 
2038
 
 
2039
        def recurse_directory_to_add_files(directory):
 
2040
            # Recurse directory and add all files
 
2041
            # so we can check if they have changed.
 
2042
            for parent_info, file_infos in self.walkdirs(directory):
 
2043
                for relpath, basename, kind, lstat, fileid, kind in file_infos:
 
2044
                    # Is it versioned or ignored?
 
2045
                    if self.path2id(relpath):
 
2046
                        # Add nested content for deletion.
 
2047
                        all_files.add(relpath)
 
2048
                    else:
 
2049
                        # Files which are not versioned
 
2050
                        # should be treated as unknown.
 
2051
                        files_to_backup.append(relpath)
 
2052
 
 
2053
        for filename in files:
 
2054
            # Get file name into canonical form.
 
2055
            abspath = self.abspath(filename)
 
2056
            filename = self.relpath(abspath)
 
2057
            if len(filename) > 0:
 
2058
                all_files.add(filename)
 
2059
                recurse_directory_to_add_files(filename)
 
2060
 
 
2061
        files = list(all_files)
 
2062
 
 
2063
        if len(files) == 0:
 
2064
            return # nothing to do
 
2065
 
 
2066
        # Sort needed to first handle directory content before the directory
 
2067
        files.sort(reverse=True)
 
2068
 
 
2069
        # Bail out if we are going to delete files we shouldn't
 
2070
        if not keep_files and not force:
 
2071
            for (file_id, path, content_change, versioned, parent_id, name,
 
2072
                 kind, executable) in self.iter_changes(self.basis_tree(),
 
2073
                     include_unchanged=True, require_versioned=False,
 
2074
                     want_unversioned=True, specific_files=files):
 
2075
                if versioned[0] == False:
 
2076
                    # The record is unknown or newly added
 
2077
                    files_to_backup.append(path[1])
 
2078
                elif (content_change and (kind[1] is not None) and
 
2079
                        osutils.is_inside_any(files, path[1])):
 
2080
                    # Versioned and changed, but not deleted, and still
 
2081
                    # in one of the dirs to be deleted.
 
2082
                    files_to_backup.append(path[1])
 
2083
 
 
2084
        def backup(file_to_backup):
 
2085
            backup_name = self.bzrdir._available_backup_name(file_to_backup)
 
2086
            osutils.rename(abs_path, self.abspath(backup_name))
 
2087
            return "removed %s (but kept a copy: %s)" % (file_to_backup,
 
2088
                                                         backup_name)
 
2089
 
 
2090
        # Build inv_delta and delete files where applicable,
 
2091
        # do this before any modifications to inventory.
1126
2092
        for f in files:
1127
 
            fid = inv.path2id(f)
 
2093
            fid = self.path2id(f)
 
2094
            message = None
1128
2095
            if not fid:
1129
 
                # TODO: Perhaps make this just a warning, and continue?
1130
 
                # This tends to happen when 
1131
 
                raise NotVersionedError(path=f)
1132
 
            mutter("remove inventory entry %s {%s}", quotefn(f), fid)
1133
 
            if verbose:
1134
 
                # having remove it, it must be either ignored or unknown
1135
 
                if self.is_ignored(f):
1136
 
                    new_status = 'I'
1137
 
                else:
1138
 
                    new_status = '?'
1139
 
                show_status(new_status, inv[fid].kind, quotefn(f))
1140
 
            del inv[fid]
1141
 
 
1142
 
        self._write_inventory(inv)
1143
 
 
1144
 
    @needs_write_lock
1145
 
    def revert(self, filenames, old_tree=None, backups=True, 
1146
 
               pb=DummyProgress()):
1147
 
        from transform import revert
1148
 
        from conflicts import resolve
 
2096
                message = "%s is not versioned." % (f,)
 
2097
            else:
 
2098
                if verbose:
 
2099
                    # having removed it, it must be either ignored or unknown
 
2100
                    if self.is_ignored(f):
 
2101
                        new_status = 'I'
 
2102
                    else:
 
2103
                        new_status = '?'
 
2104
                    # XXX: Really should be a more abstract reporter interface
 
2105
                    kind_ch = osutils.kind_marker(self.kind(fid))
 
2106
                    to_file.write(new_status + '       ' + f + kind_ch + '\n')
 
2107
                # Unversion file
 
2108
                inv_delta.append((f, None, fid, None))
 
2109
                message = "removed %s" % (f,)
 
2110
 
 
2111
            if not keep_files:
 
2112
                abs_path = self.abspath(f)
 
2113
                if osutils.lexists(abs_path):
 
2114
                    if (osutils.isdir(abs_path) and
 
2115
                        len(os.listdir(abs_path)) > 0):
 
2116
                        if force:
 
2117
                            osutils.rmtree(abs_path)
 
2118
                            message = "deleted %s" % (f,)
 
2119
                        else:
 
2120
                            message = backup(f)
 
2121
                    else:
 
2122
                        if f in files_to_backup:
 
2123
                            message = backup(f)
 
2124
                        else:
 
2125
                            osutils.delete_any(abs_path)
 
2126
                            message = "deleted %s" % (f,)
 
2127
                elif message is not None:
 
2128
                    # Only care if we haven't done anything yet.
 
2129
                    message = "%s does not exist." % (f,)
 
2130
 
 
2131
            # Print only one message (if any) per file.
 
2132
            if message is not None:
 
2133
                note(message)
 
2134
        self.apply_inventory_delta(inv_delta)
 
2135
 
 
2136
    @needs_tree_write_lock
 
2137
    def revert(self, filenames=None, old_tree=None, backups=True,
 
2138
               pb=None, report_changes=False):
 
2139
        from bzrlib.conflicts import resolve
 
2140
        if filenames == []:
 
2141
            filenames = None
 
2142
            symbol_versioning.warn('Using [] to revert all files is deprecated'
 
2143
                ' as of bzr 0.91.  Please use None (the default) instead.',
 
2144
                DeprecationWarning, stacklevel=2)
1149
2145
        if old_tree is None:
1150
 
            old_tree = self.basis_tree()
1151
 
        conflicts = revert(self, old_tree, filenames, backups, pb)
1152
 
        if not len(filenames):
1153
 
            self.set_pending_merges([])
1154
 
            resolve(self)
 
2146
            basis_tree = self.basis_tree()
 
2147
            basis_tree.lock_read()
 
2148
            old_tree = basis_tree
1155
2149
        else:
1156
 
            resolve(self, filenames, ignore_misses=True)
 
2150
            basis_tree = None
 
2151
        try:
 
2152
            conflicts = transform.revert(self, old_tree, filenames, backups, pb,
 
2153
                                         report_changes)
 
2154
            if filenames is None and len(self.get_parent_ids()) > 1:
 
2155
                parent_trees = []
 
2156
                last_revision = self.last_revision()
 
2157
                if last_revision != _mod_revision.NULL_REVISION:
 
2158
                    if basis_tree is None:
 
2159
                        basis_tree = self.basis_tree()
 
2160
                        basis_tree.lock_read()
 
2161
                    parent_trees.append((last_revision, basis_tree))
 
2162
                self.set_parent_trees(parent_trees)
 
2163
                resolve(self)
 
2164
            else:
 
2165
                resolve(self, filenames, ignore_misses=True, recursive=True)
 
2166
        finally:
 
2167
            if basis_tree is not None:
 
2168
                basis_tree.unlock()
1157
2169
        return conflicts
1158
2170
 
 
2171
    def revision_tree(self, revision_id):
 
2172
        """See Tree.revision_tree.
 
2173
 
 
2174
        WorkingTree can supply revision_trees for the basis revision only
 
2175
        because there is only one cached inventory in the bzr directory.
 
2176
        """
 
2177
        if revision_id == self.last_revision():
 
2178
            try:
 
2179
                xml = self.read_basis_inventory()
 
2180
            except errors.NoSuchFile:
 
2181
                pass
 
2182
            else:
 
2183
                try:
 
2184
                    inv = xml7.serializer_v7.read_inventory_from_string(xml)
 
2185
                    # dont use the repository revision_tree api because we want
 
2186
                    # to supply the inventory.
 
2187
                    if inv.revision_id == revision_id:
 
2188
                        return revisiontree.RevisionTree(self.branch.repository,
 
2189
                            inv, revision_id)
 
2190
                except errors.BadInventoryFormat:
 
2191
                    pass
 
2192
        # raise if there was no inventory, or if we read the wrong inventory.
 
2193
        raise errors.NoSuchRevisionInTree(self, revision_id)
 
2194
 
1159
2195
    # XXX: This method should be deprecated in favour of taking in a proper
1160
2196
    # new Inventory object.
1161
 
    @needs_write_lock
 
2197
    @needs_tree_write_lock
1162
2198
    def set_inventory(self, new_inventory_list):
1163
2199
        from bzrlib.inventory import (Inventory,
1164
2200
                                      InventoryDirectory,
1165
 
                                      InventoryEntry,
1166
2201
                                      InventoryFile,
1167
2202
                                      InventoryLink)
1168
2203
        inv = Inventory(self.get_root_id())
1170
2205
            name = os.path.basename(path)
1171
2206
            if name == "":
1172
2207
                continue
1173
 
            # fixme, there should be a factory function inv,add_?? 
 
2208
            # fixme, there should be a factory function inv,add_??
1174
2209
            if kind == 'directory':
1175
2210
                inv.add(InventoryDirectory(file_id, name, parent))
1176
2211
            elif kind == 'file':
1178
2213
            elif kind == 'symlink':
1179
2214
                inv.add(InventoryLink(file_id, name, parent))
1180
2215
            else:
1181
 
                raise BzrError("unknown kind %r" % kind)
 
2216
                raise errors.BzrError("unknown kind %r" % kind)
1182
2217
        self._write_inventory(inv)
1183
2218
 
1184
 
    @needs_write_lock
 
2219
    @needs_tree_write_lock
1185
2220
    def set_root_id(self, file_id):
1186
2221
        """Set the root id for this tree."""
1187
 
        inv = self.read_working_inventory()
 
2222
        # for compatability
 
2223
        if file_id is None:
 
2224
            raise ValueError(
 
2225
                'WorkingTree.set_root_id with fileid=None')
 
2226
        file_id = osutils.safe_file_id(file_id)
 
2227
        self._set_root_id(file_id)
 
2228
 
 
2229
    def _set_root_id(self, file_id):
 
2230
        """Set the root id for this tree, in a format specific manner.
 
2231
 
 
2232
        :param file_id: The file id to assign to the root. It must not be
 
2233
            present in the current inventory or an error will occur. It must
 
2234
            not be None, but rather a valid file id.
 
2235
        """
 
2236
        inv = self._inventory
1188
2237
        orig_root_id = inv.root.file_id
 
2238
        # TODO: it might be nice to exit early if there was nothing
 
2239
        # to do, saving us from trigger a sync on unlock.
 
2240
        self._inventory_is_modified = True
 
2241
        # we preserve the root inventory entry object, but
 
2242
        # unlinkit from the byid index
1189
2243
        del inv._byid[inv.root.file_id]
1190
2244
        inv.root.file_id = file_id
 
2245
        # and link it into the index with the new changed id.
1191
2246
        inv._byid[inv.root.file_id] = inv.root
 
2247
        # and finally update all children to reference the new id.
 
2248
        # XXX: this should be safe to just look at the root.children
 
2249
        # list, not the WHOLE INVENTORY.
1192
2250
        for fid in inv:
1193
2251
            entry = inv[fid]
1194
2252
            if entry.parent_id == orig_root_id:
1195
2253
                entry.parent_id = inv.root.file_id
1196
 
        self._write_inventory(inv)
1197
2254
 
1198
2255
    def unlock(self):
1199
2256
        """See Branch.unlock.
1200
 
        
 
2257
 
1201
2258
        WorkingTree locking just uses the Branch locking facilities.
1202
2259
        This is current because all working trees have an embedded branch
1203
2260
        within them. IF in the future, we were to make branch data shareable
1204
 
        between multiple working trees, i.e. via shared storage, then we 
 
2261
        between multiple working trees, i.e. via shared storage, then we
1205
2262
        would probably want to lock both the local tree, and the branch.
1206
2263
        """
1207
 
        # FIXME: We want to write out the hashcache only when the last lock on
1208
 
        # this working copy is released.  Peeking at the lock count is a bit
1209
 
        # of a nasty hack; probably it's better to have a transaction object,
1210
 
        # which can do some finalization when it's either successfully or
1211
 
        # unsuccessfully completed.  (Denys's original patch did that.)
1212
 
        # RBC 20060206 hookinhg into transaction will couple lock and transaction
1213
 
        # wrongly. Hookinh into unllock on the control files object is fine though.
1214
 
        
1215
 
        # TODO: split this per format so there is no ugly if block
1216
 
        if self._hashcache.needs_write and (
1217
 
            # dedicated lock files
1218
 
            self._control_files._lock_count==1 or 
1219
 
            # shared lock files
1220
 
            (self._control_files is self.branch.control_files and 
1221
 
             self._control_files._lock_count==3)):
1222
 
            self._hashcache.write()
1223
 
        # reverse order of locking.
1224
 
        result = self._control_files.unlock()
1225
 
        try:
1226
 
            self.branch.unlock()
1227
 
        finally:
1228
 
            return result
1229
 
 
1230
 
    @needs_write_lock
1231
 
    def update(self):
 
2264
        raise NotImplementedError(self.unlock)
 
2265
 
 
2266
    _marker = object()
 
2267
 
 
2268
    def update(self, change_reporter=None, possible_transports=None,
 
2269
               revision=None, old_tip=_marker, show_base=False):
1232
2270
        """Update a working tree along its branch.
1233
2271
 
1234
 
        This will update the branch if its bound too, which means we have multiple trees involved:
1235
 
        The new basis tree of the master.
1236
 
        The old basis tree of the branch.
1237
 
        The old basis tree of the working tree.
1238
 
        The current working tree state.
1239
 
        pathologically all three may be different, and non ancestors of each other.
1240
 
        Conceptually we want to:
1241
 
        Preserve the wt.basis->wt.state changes
1242
 
        Transform the wt.basis to the new master basis.
1243
 
        Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1244
 
        Restore the wt.basis->wt.state changes.
 
2272
        This will update the branch if its bound too, which means we have
 
2273
        multiple trees involved:
 
2274
 
 
2275
        - The new basis tree of the master.
 
2276
        - The old basis tree of the branch.
 
2277
        - The old basis tree of the working tree.
 
2278
        - The current working tree state.
 
2279
 
 
2280
        Pathologically, all three may be different, and non-ancestors of each
 
2281
        other.  Conceptually we want to:
 
2282
 
 
2283
        - Preserve the wt.basis->wt.state changes
 
2284
        - Transform the wt.basis to the new master basis.
 
2285
        - Apply a merge of the old branch basis to get any 'local' changes from
 
2286
          it into the tree.
 
2287
        - Restore the wt.basis->wt.state changes.
1245
2288
 
1246
2289
        There isn't a single operation at the moment to do that, so we:
1247
 
        Merge current state -> basis tree of the master w.r.t. the old tree basis.
1248
 
        Do a 'normal' merge of the old branch basis if it is relevant.
 
2290
        - Merge current state -> basis tree of the master w.r.t. the old tree
 
2291
          basis.
 
2292
        - Do a 'normal' merge of the old branch basis if it is relevant.
 
2293
 
 
2294
        :param revision: The target revision to update to. Must be in the
 
2295
            revision history.
 
2296
        :param old_tip: If branch.update() has already been run, the value it
 
2297
            returned (old tip of the branch or None). _marker is used
 
2298
            otherwise.
1249
2299
        """
1250
 
        old_tip = self.branch.update()
1251
 
        if old_tip is not None:
1252
 
            self.add_pending_merge(old_tip)
1253
 
        self.branch.lock_read()
 
2300
        if self.branch.get_bound_location() is not None:
 
2301
            self.lock_write()
 
2302
            update_branch = (old_tip is self._marker)
 
2303
        else:
 
2304
            self.lock_tree_write()
 
2305
            update_branch = False
1254
2306
        try:
1255
 
            result = 0
1256
 
            if self.last_revision() != self.branch.last_revision():
1257
 
                # merge tree state up to new branch tip.
1258
 
                basis = self.basis_tree()
1259
 
                to_tree = self.branch.basis_tree()
1260
 
                result += merge_inner(self.branch,
1261
 
                                      to_tree,
1262
 
                                      basis,
1263
 
                                      this_tree=self)
1264
 
                self.set_last_revision(self.branch.last_revision())
1265
 
            if old_tip and old_tip != self.last_revision():
1266
 
                # our last revision was not the prior branch last reivison
1267
 
                # and we have converted that last revision to a pending merge.
1268
 
                # base is somewhere between the branch tip now
1269
 
                # and the now pending merge
1270
 
                from bzrlib.revision import common_ancestor
1271
 
                try:
1272
 
                    base_rev_id = common_ancestor(self.branch.last_revision(),
1273
 
                                                  old_tip,
1274
 
                                                  self.branch.repository)
1275
 
                except errors.NoCommonAncestor:
1276
 
                    base_rev_id = None
1277
 
                base_tree = self.branch.repository.revision_tree(base_rev_id)
1278
 
                other_tree = self.branch.repository.revision_tree(old_tip)
1279
 
                result += merge_inner(self.branch,
1280
 
                                      other_tree,
1281
 
                                      base_tree,
1282
 
                                      this_tree=self)
1283
 
            return result
 
2307
            if update_branch:
 
2308
                old_tip = self.branch.update(possible_transports)
 
2309
            else:
 
2310
                if old_tip is self._marker:
 
2311
                    old_tip = None
 
2312
            return self._update_tree(old_tip, change_reporter, revision, show_base)
1284
2313
        finally:
1285
 
            self.branch.unlock()
1286
 
 
1287
 
    @needs_write_lock
 
2314
            self.unlock()
 
2315
 
 
2316
    @needs_tree_write_lock
 
2317
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None,
 
2318
                     show_base=False):
 
2319
        """Update a tree to the master branch.
 
2320
 
 
2321
        :param old_tip: if supplied, the previous tip revision the branch,
 
2322
            before it was changed to the master branch's tip.
 
2323
        """
 
2324
        # here if old_tip is not None, it is the old tip of the branch before
 
2325
        # it was updated from the master branch. This should become a pending
 
2326
        # merge in the working tree to preserve the user existing work.  we
 
2327
        # cant set that until we update the working trees last revision to be
 
2328
        # one from the new branch, because it will just get absorbed by the
 
2329
        # parent de-duplication logic.
 
2330
        #
 
2331
        # We MUST save it even if an error occurs, because otherwise the users
 
2332
        # local work is unreferenced and will appear to have been lost.
 
2333
        #
 
2334
        nb_conflicts = 0
 
2335
        try:
 
2336
            last_rev = self.get_parent_ids()[0]
 
2337
        except IndexError:
 
2338
            last_rev = _mod_revision.NULL_REVISION
 
2339
        if revision is None:
 
2340
            revision = self.branch.last_revision()
 
2341
 
 
2342
        old_tip = old_tip or _mod_revision.NULL_REVISION
 
2343
 
 
2344
        if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
 
2345
            # the branch we are bound to was updated
 
2346
            # merge those changes in first
 
2347
            base_tree  = self.basis_tree()
 
2348
            other_tree = self.branch.repository.revision_tree(old_tip)
 
2349
            nb_conflicts = merge.merge_inner(self.branch, other_tree,
 
2350
                                             base_tree, this_tree=self,
 
2351
                                             change_reporter=change_reporter,
 
2352
                                             show_base=show_base)
 
2353
            if nb_conflicts:
 
2354
                self.add_parent_tree((old_tip, other_tree))
 
2355
                trace.note('Rerun update after fixing the conflicts.')
 
2356
                return nb_conflicts
 
2357
 
 
2358
        if last_rev != _mod_revision.ensure_null(revision):
 
2359
            # the working tree is up to date with the branch
 
2360
            # we can merge the specified revision from master
 
2361
            to_tree = self.branch.repository.revision_tree(revision)
 
2362
            to_root_id = to_tree.get_root_id()
 
2363
 
 
2364
            basis = self.basis_tree()
 
2365
            basis.lock_read()
 
2366
            try:
 
2367
                if (basis.inventory.root is None
 
2368
                    or basis.inventory.root.file_id != to_root_id):
 
2369
                    self.set_root_id(to_root_id)
 
2370
                    self.flush()
 
2371
            finally:
 
2372
                basis.unlock()
 
2373
 
 
2374
            # determine the branch point
 
2375
            graph = self.branch.repository.get_graph()
 
2376
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
 
2377
                                                last_rev)
 
2378
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
2379
 
 
2380
            nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
 
2381
                                             this_tree=self,
 
2382
                                             change_reporter=change_reporter,
 
2383
                                             show_base=show_base)
 
2384
            self.set_last_revision(revision)
 
2385
            # TODO - dedup parents list with things merged by pull ?
 
2386
            # reuse the tree we've updated to to set the basis:
 
2387
            parent_trees = [(revision, to_tree)]
 
2388
            merges = self.get_parent_ids()[1:]
 
2389
            # Ideally we ask the tree for the trees here, that way the working
 
2390
            # tree can decide whether to give us the entire tree or give us a
 
2391
            # lazy initialised tree. dirstate for instance will have the trees
 
2392
            # in ram already, whereas a last-revision + basis-inventory tree
 
2393
            # will not, but also does not need them when setting parents.
 
2394
            for parent in merges:
 
2395
                parent_trees.append(
 
2396
                    (parent, self.branch.repository.revision_tree(parent)))
 
2397
            if not _mod_revision.is_null(old_tip):
 
2398
                parent_trees.append(
 
2399
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
 
2400
            self.set_parent_trees(parent_trees)
 
2401
            last_rev = parent_trees[0][0]
 
2402
        return nb_conflicts
 
2403
 
 
2404
    def _write_hashcache_if_dirty(self):
 
2405
        """Write out the hashcache if it is dirty."""
 
2406
        if self._hashcache.needs_write:
 
2407
            try:
 
2408
                self._hashcache.write()
 
2409
            except OSError, e:
 
2410
                if e.errno not in (errno.EPERM, errno.EACCES):
 
2411
                    raise
 
2412
                # TODO: jam 20061219 Should this be a warning? A single line
 
2413
                #       warning might be sufficient to let the user know what
 
2414
                #       is going on.
 
2415
                mutter('Could not write hashcache for %s\nError: %s',
 
2416
                       self._hashcache.cache_file_name(), e)
 
2417
 
 
2418
    @needs_tree_write_lock
1288
2419
    def _write_inventory(self, inv):
1289
2420
        """Write inventory as the current inventory."""
1290
 
        sio = StringIO()
1291
 
        bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1292
 
        sio.seek(0)
1293
 
        self._control_files.put('inventory', sio)
1294
 
        self._set_inventory(inv)
1295
 
        mutter('wrote working inventory')
 
2421
        self._set_inventory(inv, dirty=True)
 
2422
        self.flush()
1296
2423
 
1297
2424
    def set_conflicts(self, arg):
1298
 
        raise UnsupportedOperation(self.set_conflicts, self)
 
2425
        raise errors.UnsupportedOperation(self.set_conflicts, self)
 
2426
 
 
2427
    def add_conflicts(self, arg):
 
2428
        raise errors.UnsupportedOperation(self.add_conflicts, self)
1299
2429
 
1300
2430
    @needs_read_lock
1301
2431
    def conflicts(self):
1302
 
        conflicts = ConflictList()
 
2432
        conflicts = _mod_conflicts.ConflictList()
1303
2433
        for conflicted in self._iter_conflicts():
1304
2434
            text = True
1305
2435
            try:
1306
2436
                if file_kind(self.abspath(conflicted)) != "file":
1307
2437
                    text = False
1308
 
            except OSError, e:
1309
 
                if e.errno == errno.ENOENT:
1310
 
                    text = False
1311
 
                else:
1312
 
                    raise
 
2438
            except errors.NoSuchFile:
 
2439
                text = False
1313
2440
            if text is True:
1314
2441
                for suffix in ('.THIS', '.OTHER'):
1315
2442
                    try:
1316
2443
                        kind = file_kind(self.abspath(conflicted+suffix))
1317
 
                    except OSError, e:
1318
 
                        if e.errno == errno.ENOENT:
 
2444
                        if kind != "file":
1319
2445
                            text = False
1320
 
                            break
1321
 
                        else:
1322
 
                            raise
1323
 
                    if kind != "file":
 
2446
                    except errors.NoSuchFile:
1324
2447
                        text = False
 
2448
                    if text == False:
1325
2449
                        break
1326
2450
            ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1327
 
            conflicts.append(Conflict.factory(ctype, path=conflicted,
 
2451
            conflicts.append(_mod_conflicts.Conflict.factory(ctype,
 
2452
                             path=conflicted,
1328
2453
                             file_id=self.path2id(conflicted)))
1329
2454
        return conflicts
1330
2455
 
 
2456
    def walkdirs(self, prefix=""):
 
2457
        """Walk the directories of this tree.
 
2458
 
 
2459
        returns a generator which yields items in the form:
 
2460
                ((curren_directory_path, fileid),
 
2461
                 [(file1_path, file1_name, file1_kind, (lstat), file1_id,
 
2462
                   file1_kind), ... ])
 
2463
 
 
2464
        This API returns a generator, which is only valid during the current
 
2465
        tree transaction - within a single lock_read or lock_write duration.
 
2466
 
 
2467
        If the tree is not locked, it may cause an error to be raised,
 
2468
        depending on the tree implementation.
 
2469
        """
 
2470
        disk_top = self.abspath(prefix)
 
2471
        if disk_top.endswith('/'):
 
2472
            disk_top = disk_top[:-1]
 
2473
        top_strip_len = len(disk_top) + 1
 
2474
        inventory_iterator = self._walkdirs(prefix)
 
2475
        disk_iterator = osutils.walkdirs(disk_top, prefix)
 
2476
        try:
 
2477
            current_disk = disk_iterator.next()
 
2478
            disk_finished = False
 
2479
        except OSError, e:
 
2480
            if not (e.errno == errno.ENOENT or
 
2481
                (sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
 
2482
                raise
 
2483
            current_disk = None
 
2484
            disk_finished = True
 
2485
        try:
 
2486
            current_inv = inventory_iterator.next()
 
2487
            inv_finished = False
 
2488
        except StopIteration:
 
2489
            current_inv = None
 
2490
            inv_finished = True
 
2491
        while not inv_finished or not disk_finished:
 
2492
            if current_disk:
 
2493
                ((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
 
2494
                    cur_disk_dir_content) = current_disk
 
2495
            else:
 
2496
                ((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
 
2497
                    cur_disk_dir_content) = ((None, None), None)
 
2498
            if not disk_finished:
 
2499
                # strip out .bzr dirs
 
2500
                if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
 
2501
                    len(cur_disk_dir_content) > 0):
 
2502
                    # osutils.walkdirs can be made nicer -
 
2503
                    # yield the path-from-prefix rather than the pathjoined
 
2504
                    # value.
 
2505
                    bzrdir_loc = bisect_left(cur_disk_dir_content,
 
2506
                        ('.bzr', '.bzr'))
 
2507
                    if (bzrdir_loc < len(cur_disk_dir_content)
 
2508
                        and self.bzrdir.is_control_filename(
 
2509
                            cur_disk_dir_content[bzrdir_loc][0])):
 
2510
                        # we dont yield the contents of, or, .bzr itself.
 
2511
                        del cur_disk_dir_content[bzrdir_loc]
 
2512
            if inv_finished:
 
2513
                # everything is unknown
 
2514
                direction = 1
 
2515
            elif disk_finished:
 
2516
                # everything is missing
 
2517
                direction = -1
 
2518
            else:
 
2519
                direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
 
2520
            if direction > 0:
 
2521
                # disk is before inventory - unknown
 
2522
                dirblock = [(relpath, basename, kind, stat, None, None) for
 
2523
                    relpath, basename, kind, stat, top_path in
 
2524
                    cur_disk_dir_content]
 
2525
                yield (cur_disk_dir_relpath, None), dirblock
 
2526
                try:
 
2527
                    current_disk = disk_iterator.next()
 
2528
                except StopIteration:
 
2529
                    disk_finished = True
 
2530
            elif direction < 0:
 
2531
                # inventory is before disk - missing.
 
2532
                dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
 
2533
                    for relpath, basename, dkind, stat, fileid, kind in
 
2534
                    current_inv[1]]
 
2535
                yield (current_inv[0][0], current_inv[0][1]), dirblock
 
2536
                try:
 
2537
                    current_inv = inventory_iterator.next()
 
2538
                except StopIteration:
 
2539
                    inv_finished = True
 
2540
            else:
 
2541
                # versioned present directory
 
2542
                # merge the inventory and disk data together
 
2543
                dirblock = []
 
2544
                for relpath, subiterator in itertools.groupby(sorted(
 
2545
                    current_inv[1] + cur_disk_dir_content,
 
2546
                    key=operator.itemgetter(0)), operator.itemgetter(1)):
 
2547
                    path_elements = list(subiterator)
 
2548
                    if len(path_elements) == 2:
 
2549
                        inv_row, disk_row = path_elements
 
2550
                        # versioned, present file
 
2551
                        dirblock.append((inv_row[0],
 
2552
                            inv_row[1], disk_row[2],
 
2553
                            disk_row[3], inv_row[4],
 
2554
                            inv_row[5]))
 
2555
                    elif len(path_elements[0]) == 5:
 
2556
                        # unknown disk file
 
2557
                        dirblock.append((path_elements[0][0],
 
2558
                            path_elements[0][1], path_elements[0][2],
 
2559
                            path_elements[0][3], None, None))
 
2560
                    elif len(path_elements[0]) == 6:
 
2561
                        # versioned, absent file.
 
2562
                        dirblock.append((path_elements[0][0],
 
2563
                            path_elements[0][1], 'unknown', None,
 
2564
                            path_elements[0][4], path_elements[0][5]))
 
2565
                    else:
 
2566
                        raise NotImplementedError('unreachable code')
 
2567
                yield current_inv[0], dirblock
 
2568
                try:
 
2569
                    current_inv = inventory_iterator.next()
 
2570
                except StopIteration:
 
2571
                    inv_finished = True
 
2572
                try:
 
2573
                    current_disk = disk_iterator.next()
 
2574
                except StopIteration:
 
2575
                    disk_finished = True
 
2576
 
 
2577
    def _walkdirs(self, prefix=""):
 
2578
        """Walk the directories of this tree.
 
2579
 
 
2580
           :prefix: is used as the directrory to start with.
 
2581
           returns a generator which yields items in the form:
 
2582
                ((curren_directory_path, fileid),
 
2583
                 [(file1_path, file1_name, file1_kind, None, file1_id,
 
2584
                   file1_kind), ... ])
 
2585
        """
 
2586
        _directory = 'directory'
 
2587
        # get the root in the inventory
 
2588
        inv = self.inventory
 
2589
        top_id = inv.path2id(prefix)
 
2590
        if top_id is None:
 
2591
            pending = []
 
2592
        else:
 
2593
            pending = [(prefix, '', _directory, None, top_id, None)]
 
2594
        while pending:
 
2595
            dirblock = []
 
2596
            currentdir = pending.pop()
 
2597
            # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
 
2598
            top_id = currentdir[4]
 
2599
            if currentdir[0]:
 
2600
                relroot = currentdir[0] + '/'
 
2601
            else:
 
2602
                relroot = ""
 
2603
            # FIXME: stash the node in pending
 
2604
            entry = inv[top_id]
 
2605
            if entry.kind == 'directory':
 
2606
                for name, child in entry.sorted_children():
 
2607
                    dirblock.append((relroot + name, name, child.kind, None,
 
2608
                        child.file_id, child.kind
 
2609
                        ))
 
2610
            yield (currentdir[0], entry.file_id), dirblock
 
2611
            # push the user specified dirs from dirblock
 
2612
            for dir in reversed(dirblock):
 
2613
                if dir[2] == _directory:
 
2614
                    pending.append(dir)
 
2615
 
 
2616
    @needs_tree_write_lock
 
2617
    def auto_resolve(self):
 
2618
        """Automatically resolve text conflicts according to contents.
 
2619
 
 
2620
        Only text conflicts are auto_resolvable. Files with no conflict markers
 
2621
        are considered 'resolved', because bzr always puts conflict markers
 
2622
        into files that have text conflicts.  The corresponding .THIS .BASE and
 
2623
        .OTHER files are deleted, as per 'resolve'.
 
2624
        :return: a tuple of ConflictLists: (un_resolved, resolved).
 
2625
        """
 
2626
        un_resolved = _mod_conflicts.ConflictList()
 
2627
        resolved = _mod_conflicts.ConflictList()
 
2628
        conflict_re = re.compile('^(<{7}|={7}|>{7})')
 
2629
        for conflict in self.conflicts():
 
2630
            if (conflict.typestring != 'text conflict' or
 
2631
                self.kind(conflict.file_id) != 'file'):
 
2632
                un_resolved.append(conflict)
 
2633
                continue
 
2634
            my_file = open(self.id2abspath(conflict.file_id), 'rb')
 
2635
            try:
 
2636
                for line in my_file:
 
2637
                    if conflict_re.search(line):
 
2638
                        un_resolved.append(conflict)
 
2639
                        break
 
2640
                else:
 
2641
                    resolved.append(conflict)
 
2642
            finally:
 
2643
                my_file.close()
 
2644
        resolved.remove_files(self)
 
2645
        self.set_conflicts(un_resolved)
 
2646
        return un_resolved, resolved
 
2647
 
 
2648
    @needs_read_lock
 
2649
    def _check(self, references):
 
2650
        """Check the tree for consistency.
 
2651
 
 
2652
        :param references: A dict with keys matching the items returned by
 
2653
            self._get_check_refs(), and values from looking those keys up in
 
2654
            the repository.
 
2655
        """
 
2656
        tree_basis = self.basis_tree()
 
2657
        tree_basis.lock_read()
 
2658
        try:
 
2659
            repo_basis = references[('trees', self.last_revision())]
 
2660
            if len(list(repo_basis.iter_changes(tree_basis))) > 0:
 
2661
                raise errors.BzrCheckError(
 
2662
                    "Mismatched basis inventory content.")
 
2663
            self._validate()
 
2664
        finally:
 
2665
            tree_basis.unlock()
 
2666
 
 
2667
    def _validate(self):
 
2668
        """Validate internal structures.
 
2669
 
 
2670
        This is meant mostly for the test suite. To give it a chance to detect
 
2671
        corruption after actions have occurred. The default implementation is a
 
2672
        just a no-op.
 
2673
 
 
2674
        :return: None. An exception should be raised if there is an error.
 
2675
        """
 
2676
        return
 
2677
 
 
2678
    @needs_read_lock
 
2679
    def check_state(self):
 
2680
        """Check that the working state is/isn't valid."""
 
2681
        check_refs = self._get_check_refs()
 
2682
        refs = {}
 
2683
        for ref in check_refs:
 
2684
            kind, value = ref
 
2685
            if kind == 'trees':
 
2686
                refs[ref] = self.branch.repository.revision_tree(value)
 
2687
        self._check(refs)
 
2688
 
 
2689
    @needs_tree_write_lock
 
2690
    def reset_state(self, revision_ids=None):
 
2691
        """Reset the state of the working tree.
 
2692
 
 
2693
        This does a hard-reset to a last-known-good state. This is a way to
 
2694
        fix if something got corrupted (like the .bzr/checkout/dirstate file)
 
2695
        """
 
2696
        if revision_ids is None:
 
2697
            revision_ids = self.get_parent_ids()
 
2698
        if not revision_ids:
 
2699
            rt = self.branch.repository.revision_tree(
 
2700
                _mod_revision.NULL_REVISION)
 
2701
        else:
 
2702
            rt = self.branch.repository.revision_tree(revision_ids[0])
 
2703
        self._write_inventory(rt.inventory)
 
2704
        self.set_parent_ids(revision_ids)
 
2705
 
 
2706
    def _get_rules_searcher(self, default_searcher):
 
2707
        """See Tree._get_rules_searcher."""
 
2708
        if self._rules_searcher is None:
 
2709
            self._rules_searcher = super(WorkingTree,
 
2710
                self)._get_rules_searcher(default_searcher)
 
2711
        return self._rules_searcher
 
2712
 
 
2713
    def get_shelf_manager(self):
 
2714
        """Return the ShelfManager for this WorkingTree."""
 
2715
        from bzrlib.shelf import ShelfManager
 
2716
        return ShelfManager(self, self._transport)
 
2717
 
 
2718
 
 
2719
class WorkingTree2(WorkingTree):
 
2720
    """This is the Format 2 working tree.
 
2721
 
 
2722
    This was the first weave based working tree.
 
2723
     - uses os locks for locking.
 
2724
     - uses the branch last-revision.
 
2725
    """
 
2726
 
 
2727
    def __init__(self, *args, **kwargs):
 
2728
        super(WorkingTree2, self).__init__(*args, **kwargs)
 
2729
        # WorkingTree2 has more of a constraint that self._inventory must
 
2730
        # exist. Because this is an older format, we don't mind the overhead
 
2731
        # caused by the extra computation here.
 
2732
 
 
2733
        # Newer WorkingTree's should only have self._inventory set when they
 
2734
        # have a read lock.
 
2735
        if self._inventory is None:
 
2736
            self.read_working_inventory()
 
2737
 
 
2738
    def _get_check_refs(self):
 
2739
        """Return the references needed to perform a check of this tree."""
 
2740
        return [('trees', self.last_revision())]
 
2741
 
 
2742
    def lock_tree_write(self):
 
2743
        """See WorkingTree.lock_tree_write().
 
2744
 
 
2745
        In Format2 WorkingTrees we have a single lock for the branch and tree
 
2746
        so lock_tree_write() degrades to lock_write().
 
2747
 
 
2748
        :return: An object with an unlock method which will release the lock
 
2749
            obtained.
 
2750
        """
 
2751
        self.branch.lock_write()
 
2752
        try:
 
2753
            self._control_files.lock_write()
 
2754
            return self
 
2755
        except:
 
2756
            self.branch.unlock()
 
2757
            raise
 
2758
 
 
2759
    def unlock(self):
 
2760
        # do non-implementation specific cleanup
 
2761
        self._cleanup()
 
2762
 
 
2763
        # we share control files:
 
2764
        if self._control_files._lock_count == 3:
 
2765
            # _inventory_is_modified is always False during a read lock.
 
2766
            if self._inventory_is_modified:
 
2767
                self.flush()
 
2768
            self._write_hashcache_if_dirty()
 
2769
 
 
2770
        # reverse order of locking.
 
2771
        try:
 
2772
            return self._control_files.unlock()
 
2773
        finally:
 
2774
            self.branch.unlock()
 
2775
 
1331
2776
 
1332
2777
class WorkingTree3(WorkingTree):
1333
2778
    """This is the Format 3 working tree.
1340
2785
    """
1341
2786
 
1342
2787
    @needs_read_lock
1343
 
    def last_revision(self):
1344
 
        """See WorkingTree.last_revision."""
 
2788
    def _last_revision(self):
 
2789
        """See Mutable.last_revision."""
1345
2790
        try:
1346
 
            return self._control_files.get_utf8('last-revision').read()
1347
 
        except NoSuchFile:
1348
 
            return None
 
2791
            return self._transport.get_bytes('last-revision')
 
2792
        except errors.NoSuchFile:
 
2793
            return _mod_revision.NULL_REVISION
1349
2794
 
1350
2795
    def _change_last_revision(self, revision_id):
1351
2796
        """See WorkingTree._change_last_revision."""
1352
 
        if revision_id is None or revision_id == NULL_REVISION:
 
2797
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
1353
2798
            try:
1354
 
                self._control_files._transport.delete('last-revision')
 
2799
                self._transport.delete('last-revision')
1355
2800
            except errors.NoSuchFile:
1356
2801
                pass
1357
2802
            return False
1358
2803
        else:
1359
 
            try:
1360
 
                self.branch.revision_history().index(revision_id)
1361
 
            except ValueError:
1362
 
                raise errors.NoSuchRevision(self.branch, revision_id)
1363
 
            self._control_files.put_utf8('last-revision', revision_id)
 
2804
            self._transport.put_bytes('last-revision', revision_id,
 
2805
                mode=self.bzrdir._get_file_mode())
1364
2806
            return True
1365
2807
 
1366
 
    @needs_write_lock
 
2808
    def _get_check_refs(self):
 
2809
        """Return the references needed to perform a check of this tree."""
 
2810
        return [('trees', self.last_revision())]
 
2811
 
 
2812
    @needs_tree_write_lock
1367
2813
    def set_conflicts(self, conflicts):
1368
 
        self._put_rio('conflicts', conflicts.to_stanzas(), 
 
2814
        self._put_rio('conflicts', conflicts.to_stanzas(),
1369
2815
                      CONFLICT_HEADER_1)
1370
2816
 
 
2817
    @needs_tree_write_lock
 
2818
    def add_conflicts(self, new_conflicts):
 
2819
        conflict_set = set(self.conflicts())
 
2820
        conflict_set.update(set(list(new_conflicts)))
 
2821
        self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
 
2822
                                       key=_mod_conflicts.Conflict.sort_key)))
 
2823
 
1371
2824
    @needs_read_lock
1372
2825
    def conflicts(self):
1373
2826
        try:
1374
 
            confile = self._control_files.get('conflicts')
1375
 
        except NoSuchFile:
1376
 
            return ConflictList()
1377
 
        try:
1378
 
            if confile.next() != CONFLICT_HEADER_1 + '\n':
1379
 
                raise ConflictFormatError()
1380
 
        except StopIteration:
1381
 
            raise ConflictFormatError()
1382
 
        return ConflictList.from_stanzas(RioReader(confile))
 
2827
            confile = self._transport.get('conflicts')
 
2828
        except errors.NoSuchFile:
 
2829
            return _mod_conflicts.ConflictList()
 
2830
        try:
 
2831
            try:
 
2832
                if confile.next() != CONFLICT_HEADER_1 + '\n':
 
2833
                    raise errors.ConflictFormatError()
 
2834
            except StopIteration:
 
2835
                raise errors.ConflictFormatError()
 
2836
            return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
 
2837
        finally:
 
2838
            confile.close()
 
2839
 
 
2840
    def unlock(self):
 
2841
        # do non-implementation specific cleanup
 
2842
        self._cleanup()
 
2843
        if self._control_files._lock_count == 1:
 
2844
            # _inventory_is_modified is always False during a read lock.
 
2845
            if self._inventory_is_modified:
 
2846
                self.flush()
 
2847
            self._write_hashcache_if_dirty()
 
2848
        # reverse order of locking.
 
2849
        try:
 
2850
            return self._control_files.unlock()
 
2851
        finally:
 
2852
            self.branch.unlock()
1383
2853
 
1384
2854
 
1385
2855
def get_conflicted_stem(path):
1386
 
    for suffix in CONFLICT_SUFFIXES:
 
2856
    for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
1387
2857
        if path.endswith(suffix):
1388
2858
            return path[:-len(suffix)]
1389
2859
 
1390
 
@deprecated_function(zero_eight)
1391
 
def is_control_file(filename):
1392
 
    """See WorkingTree.is_control_filename(filename)."""
1393
 
    ## FIXME: better check
1394
 
    filename = normpath(filename)
1395
 
    while filename != '':
1396
 
        head, tail = os.path.split(filename)
1397
 
        ## mutter('check %r for control file' % ((head, tail),))
1398
 
        if tail == '.bzr':
1399
 
            return True
1400
 
        if filename == head:
1401
 
            break
1402
 
        filename = head
1403
 
    return False
1404
 
 
1405
2860
 
1406
2861
class WorkingTreeFormat(object):
1407
2862
    """An encapsulation of the initialization and open routines for a format.
1411
2866
     * a format string,
1412
2867
     * an open routine.
1413
2868
 
1414
 
    Formats are placed in an dict by their format string for reference 
 
2869
    Formats are placed in an dict by their format string for reference
1415
2870
    during workingtree opening. Its not required that these be instances, they
1416
 
    can be classes themselves with class methods - it simply depends on 
 
2871
    can be classes themselves with class methods - it simply depends on
1417
2872
    whether state is needed for a given format or not.
1418
2873
 
1419
2874
    Once a format is deprecated, just deprecate the initialize and open
1420
 
    methods on the format class. Do not deprecate the object, as the 
 
2875
    methods on the format class. Do not deprecate the object, as the
1421
2876
    object will be created every time regardless.
1422
2877
    """
1423
2878
 
1427
2882
    _formats = {}
1428
2883
    """The known formats."""
1429
2884
 
 
2885
    _extra_formats = []
 
2886
    """Extra formats that can not be used in a metadir."""
 
2887
 
 
2888
    requires_rich_root = False
 
2889
 
 
2890
    upgrade_recommended = False
 
2891
 
 
2892
    requires_normalized_unicode_filenames = False
 
2893
 
 
2894
    case_sensitive_filename = "FoRMaT"
 
2895
 
1430
2896
    @classmethod
1431
2897
    def find_format(klass, a_bzrdir):
1432
2898
        """Return the format for the working tree object in a_bzrdir."""
1433
2899
        try:
1434
2900
            transport = a_bzrdir.get_workingtree_transport(None)
1435
 
            format_string = transport.get("format").read()
 
2901
            format_string = transport.get_bytes("format")
1436
2902
            return klass._formats[format_string]
1437
 
        except NoSuchFile:
 
2903
        except errors.NoSuchFile:
1438
2904
            raise errors.NoWorkingTree(base=transport.base)
1439
2905
        except KeyError:
1440
 
            raise errors.UnknownFormatError(format_string)
 
2906
            raise errors.UnknownFormatError(format=format_string,
 
2907
                                            kind="working tree")
 
2908
 
 
2909
    def __eq__(self, other):
 
2910
        return self.__class__ is other.__class__
 
2911
 
 
2912
    def __ne__(self, other):
 
2913
        return not (self == other)
1441
2914
 
1442
2915
    @classmethod
1443
2916
    def get_default_format(klass):
1456
2929
        """Is this format supported?
1457
2930
 
1458
2931
        Supported formats can be initialized and opened.
1459
 
        Unsupported formats may not support initialization or committing or 
 
2932
        Unsupported formats may not support initialization or committing or
1460
2933
        some other features depending on the reason for not being supported.
1461
2934
        """
1462
2935
        return True
1463
2936
 
 
2937
    def supports_content_filtering(self):
 
2938
        """True if this format supports content filtering."""
 
2939
        return False
 
2940
 
 
2941
    def supports_views(self):
 
2942
        """True if this format supports stored views."""
 
2943
        return False
 
2944
 
1464
2945
    @classmethod
1465
2946
    def register_format(klass, format):
1466
2947
        klass._formats[format.get_format_string()] = format
1467
2948
 
1468
2949
    @classmethod
 
2950
    def register_extra_format(klass, format):
 
2951
        klass._extra_formats.append(format)
 
2952
 
 
2953
    @classmethod
 
2954
    def unregister_extra_format(klass, format):
 
2955
        klass._extra_formats.remove(format)
 
2956
 
 
2957
    @classmethod
 
2958
    def get_formats(klass):
 
2959
        return klass._formats.values() + klass._extra_formats
 
2960
 
 
2961
    @classmethod
1469
2962
    def set_default_format(klass, format):
1470
2963
        klass._default_format = format
1471
2964
 
1472
2965
    @classmethod
1473
2966
    def unregister_format(klass, format):
1474
 
        assert klass._formats[format.get_format_string()] is format
1475
2967
        del klass._formats[format.get_format_string()]
1476
2968
 
1477
2969
 
1478
 
 
1479
2970
class WorkingTreeFormat2(WorkingTreeFormat):
1480
 
    """The second working tree format. 
 
2971
    """The second working tree format.
1481
2972
 
1482
2973
    This format modified the hash cache from the format 1 hash cache.
1483
2974
    """
1484
2975
 
 
2976
    upgrade_recommended = True
 
2977
 
 
2978
    requires_normalized_unicode_filenames = True
 
2979
 
 
2980
    case_sensitive_filename = "Branch-FoRMaT"
 
2981
 
1485
2982
    def get_format_description(self):
1486
2983
        """See WorkingTreeFormat.get_format_description()."""
1487
2984
        return "Working tree format 2"
1488
2985
 
1489
 
    def initialize(self, a_bzrdir, revision_id=None):
 
2986
    def _stub_initialize_on_transport(self, transport, file_mode):
 
2987
        """Workaround: create control files for a remote working tree.
 
2988
 
 
2989
        This ensures that it can later be updated and dealt with locally,
 
2990
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
 
2991
        no working tree.  (See bug #43064).
 
2992
        """
 
2993
        sio = StringIO()
 
2994
        inv = inventory.Inventory()
 
2995
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
 
2996
        sio.seek(0)
 
2997
        transport.put_file('inventory', sio, file_mode)
 
2998
        transport.put_bytes('pending-merges', '', file_mode)
 
2999
 
 
3000
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
 
3001
                   accelerator_tree=None, hardlink=False):
1490
3002
        """See WorkingTreeFormat.initialize()."""
1491
3003
        if not isinstance(a_bzrdir.transport, LocalTransport):
1492
3004
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
1493
 
        branch = a_bzrdir.open_branch()
1494
 
        if revision_id is not None:
1495
 
            branch.lock_write()
1496
 
            try:
1497
 
                revision_history = branch.revision_history()
1498
 
                try:
1499
 
                    position = revision_history.index(revision_id)
1500
 
                except ValueError:
1501
 
                    raise errors.NoSuchRevision(branch, revision_id)
1502
 
                branch.set_revision_history(revision_history[:position + 1])
1503
 
            finally:
1504
 
                branch.unlock()
1505
 
        revision = branch.last_revision()
1506
 
        inv = Inventory() 
1507
 
        wt = WorkingTree(a_bzrdir.root_transport.base,
 
3005
        if from_branch is not None:
 
3006
            branch = from_branch
 
3007
        else:
 
3008
            branch = a_bzrdir.open_branch()
 
3009
        if revision_id is None:
 
3010
            revision_id = _mod_revision.ensure_null(branch.last_revision())
 
3011
        branch.lock_write()
 
3012
        try:
 
3013
            branch.generate_revision_history(revision_id)
 
3014
        finally:
 
3015
            branch.unlock()
 
3016
        inv = inventory.Inventory()
 
3017
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1508
3018
                         branch,
1509
3019
                         inv,
1510
3020
                         _internal=True,
1511
3021
                         _format=self,
1512
 
                         _bzrdir=a_bzrdir)
1513
 
        wt._write_inventory(inv)
1514
 
        wt.set_root_id(inv.root.file_id)
1515
 
        wt.set_last_revision(revision)
1516
 
        wt.set_pending_merges([])
1517
 
        build_tree(wt.basis_tree(), wt)
 
3022
                         _bzrdir=a_bzrdir,
 
3023
                         _control_files=branch.control_files)
 
3024
        basis_tree = branch.repository.revision_tree(revision_id)
 
3025
        if basis_tree.inventory.root is not None:
 
3026
            wt.set_root_id(basis_tree.get_root_id())
 
3027
        # set the parent list and cache the basis tree.
 
3028
        if _mod_revision.is_null(revision_id):
 
3029
            parent_trees = []
 
3030
        else:
 
3031
            parent_trees = [(revision_id, basis_tree)]
 
3032
        wt.set_parent_trees(parent_trees)
 
3033
        transform.build_tree(basis_tree, wt)
1518
3034
        return wt
1519
3035
 
1520
3036
    def __init__(self):
1532
3048
            raise NotImplementedError
1533
3049
        if not isinstance(a_bzrdir.transport, LocalTransport):
1534
3050
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
1535
 
        return WorkingTree(a_bzrdir.root_transport.base,
 
3051
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1536
3052
                           _internal=True,
1537
3053
                           _format=self,
1538
 
                           _bzrdir=a_bzrdir)
1539
 
 
 
3054
                           _bzrdir=a_bzrdir,
 
3055
                           _control_files=a_bzrdir.open_branch().control_files)
 
3056
        return wt
1540
3057
 
1541
3058
class WorkingTreeFormat3(WorkingTreeFormat):
1542
3059
    """The second working tree format updated to record a format marker.
1547
3064
          files, separate from the BzrDir format
1548
3065
        - modifies the hash cache format
1549
3066
        - is new in bzr 0.8
1550
 
        - uses a LockDir to guard access to the repository
 
3067
        - uses a LockDir to guard access for writes.
1551
3068
    """
1552
3069
 
 
3070
    upgrade_recommended = True
 
3071
 
1553
3072
    def get_format_string(self):
1554
3073
        """See WorkingTreeFormat.get_format_string()."""
1555
3074
        return "Bazaar-NG Working Tree format 3"
1561
3080
    _lock_file_name = 'lock'
1562
3081
    _lock_class = LockDir
1563
3082
 
 
3083
    _tree_class = WorkingTree3
 
3084
 
 
3085
    def __get_matchingbzrdir(self):
 
3086
        return bzrdir.BzrDirMetaFormat1()
 
3087
 
 
3088
    _matchingbzrdir = property(__get_matchingbzrdir)
 
3089
 
1564
3090
    def _open_control_files(self, a_bzrdir):
1565
3091
        transport = a_bzrdir.get_workingtree_transport(None)
1566
 
        return LockableFiles(transport, self._lock_file_name, 
 
3092
        return LockableFiles(transport, self._lock_file_name,
1567
3093
                             self._lock_class)
1568
3094
 
1569
 
    def initialize(self, a_bzrdir, revision_id=None):
 
3095
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
 
3096
                   accelerator_tree=None, hardlink=False):
1570
3097
        """See WorkingTreeFormat.initialize().
1571
 
        
1572
 
        revision_id allows creating a working tree at a differnet
1573
 
        revision than the branch is at.
 
3098
 
 
3099
        :param revision_id: if supplied, create a working tree at a different
 
3100
            revision than the branch is at.
 
3101
        :param accelerator_tree: A tree which can be used for retrieving file
 
3102
            contents more quickly than the revision tree, i.e. a workingtree.
 
3103
            The revision tree will be used for cases where accelerator_tree's
 
3104
            content is different.
 
3105
        :param hardlink: If true, hard-link files from accelerator_tree,
 
3106
            where possible.
1574
3107
        """
1575
3108
        if not isinstance(a_bzrdir.transport, LocalTransport):
1576
3109
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
1577
3110
        transport = a_bzrdir.get_workingtree_transport(self)
1578
3111
        control_files = self._open_control_files(a_bzrdir)
1579
3112
        control_files.create_lock()
1580
 
        control_files.put_utf8('format', self.get_format_string())
1581
 
        branch = a_bzrdir.open_branch()
 
3113
        control_files.lock_write()
 
3114
        transport.put_bytes('format', self.get_format_string(),
 
3115
            mode=a_bzrdir._get_file_mode())
 
3116
        if from_branch is not None:
 
3117
            branch = from_branch
 
3118
        else:
 
3119
            branch = a_bzrdir.open_branch()
1582
3120
        if revision_id is None:
1583
 
            revision_id = branch.last_revision()
1584
 
        inv = Inventory() 
1585
 
        wt = WorkingTree3(a_bzrdir.root_transport.base,
 
3121
            revision_id = _mod_revision.ensure_null(branch.last_revision())
 
3122
        # WorkingTree3 can handle an inventory which has a unique root id.
 
3123
        # as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
 
3124
        # those trees. And because there isn't a format bump inbetween, we
 
3125
        # are maintaining compatibility with older clients.
 
3126
        # inv = Inventory(root_id=gen_root_id())
 
3127
        inv = self._initial_inventory()
 
3128
        wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
1586
3129
                         branch,
1587
3130
                         inv,
1588
3131
                         _internal=True,
1589
3132
                         _format=self,
1590
3133
                         _bzrdir=a_bzrdir,
1591
3134
                         _control_files=control_files)
1592
 
        wt._write_inventory(inv)
1593
 
        wt.set_root_id(inv.root.file_id)
1594
 
        wt.set_last_revision(revision_id)
1595
 
        wt.set_pending_merges([])
1596
 
        build_tree(wt.basis_tree(), wt)
 
3135
        wt.lock_tree_write()
 
3136
        try:
 
3137
            basis_tree = branch.repository.revision_tree(revision_id)
 
3138
            # only set an explicit root id if there is one to set.
 
3139
            if basis_tree.inventory.root is not None:
 
3140
                wt.set_root_id(basis_tree.get_root_id())
 
3141
            if revision_id == _mod_revision.NULL_REVISION:
 
3142
                wt.set_parent_trees([])
 
3143
            else:
 
3144
                wt.set_parent_trees([(revision_id, basis_tree)])
 
3145
            transform.build_tree(basis_tree, wt)
 
3146
        finally:
 
3147
            # Unlock in this order so that the unlock-triggers-flush in
 
3148
            # WorkingTree is given a chance to fire.
 
3149
            control_files.unlock()
 
3150
            wt.unlock()
1597
3151
        return wt
1598
3152
 
 
3153
    def _initial_inventory(self):
 
3154
        return inventory.Inventory()
 
3155
 
1599
3156
    def __init__(self):
1600
3157
        super(WorkingTreeFormat3, self).__init__()
1601
 
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1602
3158
 
1603
3159
    def open(self, a_bzrdir, _found=False):
1604
3160
        """Return the WorkingTree object for a_bzrdir
1611
3167
            raise NotImplementedError
1612
3168
        if not isinstance(a_bzrdir.transport, LocalTransport):
1613
3169
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
1614
 
        control_files = self._open_control_files(a_bzrdir)
1615
 
        return WorkingTree3(a_bzrdir.root_transport.base,
1616
 
                           _internal=True,
1617
 
                           _format=self,
1618
 
                           _bzrdir=a_bzrdir,
1619
 
                           _control_files=control_files)
 
3170
        wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
 
3171
        return wt
 
3172
 
 
3173
    def _open(self, a_bzrdir, control_files):
 
3174
        """Open the tree itself.
 
3175
 
 
3176
        :param a_bzrdir: the dir for the tree.
 
3177
        :param control_files: the control files for the tree.
 
3178
        """
 
3179
        return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
 
3180
                                _internal=True,
 
3181
                                _format=self,
 
3182
                                _bzrdir=a_bzrdir,
 
3183
                                _control_files=control_files)
1620
3184
 
1621
3185
    def __str__(self):
1622
3186
        return self.get_format_string()
1623
3187
 
1624
3188
 
1625
 
# formats which have no format string are not discoverable
1626
 
# and not independently creatable, so are not registered.
1627
 
__default_format = WorkingTreeFormat3()
 
3189
__default_format = WorkingTreeFormat6()
1628
3190
WorkingTreeFormat.register_format(__default_format)
 
3191
WorkingTreeFormat.register_format(WorkingTreeFormat5())
 
3192
WorkingTreeFormat.register_format(WorkingTreeFormat4())
 
3193
WorkingTreeFormat.register_format(WorkingTreeFormat3())
1629
3194
WorkingTreeFormat.set_default_format(__default_format)
1630
 
_legacy_formats = [WorkingTreeFormat2(),
1631
 
                   ]
1632
 
 
1633
 
 
1634
 
class WorkingTreeTestProviderAdapter(object):
1635
 
    """A tool to generate a suite testing multiple workingtree formats at once.
1636
 
 
1637
 
    This is done by copying the test once for each transport and injecting
1638
 
    the transport_server, transport_readonly_server, and workingtree_format
1639
 
    classes into each copy. Each copy is also given a new id() to make it
1640
 
    easy to identify.
1641
 
    """
1642
 
 
1643
 
    def __init__(self, transport_server, transport_readonly_server, formats):
1644
 
        self._transport_server = transport_server
1645
 
        self._transport_readonly_server = transport_readonly_server
1646
 
        self._formats = formats
1647
 
    
1648
 
    def adapt(self, test):
1649
 
        from bzrlib.tests import TestSuite
1650
 
        result = TestSuite()
1651
 
        for workingtree_format, bzrdir_format in self._formats:
1652
 
            new_test = deepcopy(test)
1653
 
            new_test.transport_server = self._transport_server
1654
 
            new_test.transport_readonly_server = self._transport_readonly_server
1655
 
            new_test.bzrdir_format = bzrdir_format
1656
 
            new_test.workingtree_format = workingtree_format
1657
 
            def make_new_test_id():
1658
 
                new_id = "%s(%s)" % (new_test.id(), workingtree_format.__class__.__name__)
1659
 
                return lambda: new_id
1660
 
            new_test.id = make_new_test_id()
1661
 
            result.addTest(new_test)
1662
 
        return result
 
3195
# Register extra formats which have no format string are not discoverable
 
3196
# and not independently creatable. They are implicitly created as part of
 
3197
# e.g. older Bazaar formats or foreign formats.
 
3198
WorkingTreeFormat.register_extra_format(WorkingTreeFormat2())