~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Martin Pool
  • Date: 2007-04-04 06:17:31 UTC
  • mto: This revision was merged to the branch mainline in revision 2397.
  • Revision ID: mbp@sourcefrog.net-20070404061731-tt2xrzllqhbodn83
Contents of TODO file moved into bug tracker

Show diffs side-by-side

added added

removed removed

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