~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Martin Pool
  • Date: 2005-09-12 01:29:49 UTC
  • mto: (1092.2.12) (974.1.76) (1185.8.2)
  • mto: This revision was merged to the branch mainline in revision 1390.
  • Revision ID: mbp@sourcefrog.net-20050912012949-73a539d3f2542173
- patch from mpe to automatically add parent directories

Show diffs side-by-side

added added

removed removed

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