~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Vincent Ladeuil
  • Date: 2007-05-25 17:12:52 UTC
  • mto: (2485.8.44 bzr.connection.sharing)
  • mto: This revision was merged to the branch mainline in revision 2646.
  • Revision ID: v.ladeuil+lp@free.fr-20070525171252-hsooebpkqtb3j6ef
Add test for cat and missing.

* bzrlib/tests/commands/__init__.py:
(test_suite): Add test_cat and test_missing.

* bzrlib/tests/commands/test_cat.py: 
New file.

* bzrlib/tests/commands/test_missing.py: 
New file.

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