~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Martin Pool
  • Date: 2007-07-05 00:12:25 UTC
  • mfrom: (2586 +trunk)
  • mto: This revision was merged to the branch mainline in revision 2588.
  • Revision ID: mbp@sourcefrog.net-20070705001225-sgr71qfxpj9ghc83
merge trunk and fix run_bzr call in merge_directive tests

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