/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/workingtree_4.py

  • Committer: Matt Nordhoff
  • Date: 2007-08-15 19:16:00 UTC
  • mto: This revision was merged to the branch mainline in revision 2719.
  • Revision ID: mnordhoff@mattnordhoff.com-20070815191600-bs6zklckprt6mc1f
wsgi.RelpathSetter sent an empty dict of headers instead of an empty list in 404 error responses.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2007-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""WorkingTree4 format and implementation.
18
18
 
28
28
 
29
29
from bzrlib.lazy_import import lazy_import
30
30
lazy_import(globals(), """
 
31
from bisect import bisect_left
 
32
import collections
 
33
from copy import deepcopy
31
34
import errno
 
35
import itertools
 
36
import operator
32
37
import stat
 
38
from time import time
 
39
import warnings
33
40
 
34
41
import bzrlib
35
42
from bzrlib import (
36
43
    bzrdir,
37
44
    cache_utf8,
38
 
    debug,
 
45
    conflicts as _mod_conflicts,
 
46
    delta,
39
47
    dirstate,
40
48
    errors,
41
49
    generate_ids,
 
50
    globbing,
 
51
    hashcache,
 
52
    ignores,
 
53
    merge,
42
54
    osutils,
43
55
    revision as _mod_revision,
44
56
    revisiontree,
45
 
    trace,
 
57
    textui,
46
58
    transform,
47
 
    views,
 
59
    urlutils,
 
60
    xml5,
 
61
    xml6,
48
62
    )
49
63
import bzrlib.branch
 
64
from bzrlib.transport import get_transport
50
65
import bzrlib.ui
51
66
""")
52
67
 
 
68
from bzrlib import symbol_versioning
53
69
from bzrlib.decorators import needs_read_lock, needs_write_lock
54
 
from bzrlib.filters import filtered_input_file, internal_size_sha_file_byname
55
 
from bzrlib.inventory import Inventory, ROOT_ID, entry_factory
 
70
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, entry_factory
 
71
from bzrlib.lockable_files import LockableFiles, TransportLock
 
72
from bzrlib.lockdir import LockDir
 
73
import bzrlib.mutabletree
56
74
from bzrlib.mutabletree import needs_tree_write_lock
57
75
from bzrlib.osutils import (
58
76
    file_kind,
59
77
    isdir,
 
78
    normpath,
60
79
    pathjoin,
 
80
    rand_chars,
61
81
    realpath,
62
82
    safe_unicode,
 
83
    splitpath,
63
84
    )
64
 
from bzrlib.trace import mutter
 
85
from bzrlib.trace import mutter, note
65
86
from bzrlib.transport.local import LocalTransport
66
87
from bzrlib.tree import InterTree
 
88
from bzrlib.progress import DummyProgress, ProgressPhase
 
89
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
 
90
from bzrlib.rio import RioReader, rio_file, Stanza
 
91
from bzrlib.symbol_versioning import (deprecated_passed,
 
92
        deprecated_method,
 
93
        deprecated_function,
 
94
        DEPRECATED_PARAMETER,
 
95
        )
67
96
from bzrlib.tree import Tree
68
97
from bzrlib.workingtree import WorkingTree, WorkingTree3, WorkingTreeFormat3
69
98
 
70
99
 
71
 
class DirStateWorkingTree(WorkingTree3):
 
100
# This is the Windows equivalent of ENOTDIR
 
101
# It is defined in pywin32.winerror, but we don't want a strong dependency for
 
102
# just an error code.
 
103
ERROR_PATH_NOT_FOUND = 3
 
104
ERROR_DIRECTORY = 267
 
105
 
 
106
 
 
107
class WorkingTree4(WorkingTree3):
 
108
    """This is the Format 4 working tree.
 
109
 
 
110
    This differs from WorkingTree3 by:
 
111
     - Having a consolidated internal dirstate, stored in a
 
112
       randomly-accessible sorted file on disk.
 
113
     - Not having a regular inventory attribute.  One can be synthesized 
 
114
       on demand but this is expensive and should be avoided.
 
115
 
 
116
    This is new in bzr 0.15.
 
117
    """
 
118
 
72
119
    def __init__(self, basedir,
73
120
                 branch,
74
121
                 _control_files=None,
83
130
        """
84
131
        self._format = _format
85
132
        self.bzrdir = _bzrdir
 
133
        from bzrlib.trace import note, mutter
 
134
        assert isinstance(basedir, basestring), \
 
135
            "base directory %r is not a string" % basedir
86
136
        basedir = safe_unicode(basedir)
87
137
        mutter("opening working tree %r", basedir)
88
138
        self._branch = branch
 
139
        assert isinstance(self.branch, bzrlib.branch.Branch), \
 
140
            "branch %r is not a Branch" % self.branch
89
141
        self.basedir = realpath(basedir)
90
142
        # if branch is at our basedir and is a format 6 or less
91
143
        # assume all other formats have their own control files.
 
144
        assert isinstance(_control_files, LockableFiles), \
 
145
            "_control_files must be a LockableFiles, not %r" % _control_files
92
146
        self._control_files = _control_files
93
 
        self._transport = self._control_files._transport
94
147
        self._dirty = None
95
148
        #-------------
96
149
        # during a read or write lock these objects are set, and are
98
151
        self._dirstate = None
99
152
        self._inventory = None
100
153
        #-------------
101
 
        self._setup_directory_is_tree_reference()
102
 
        self._detect_case_handling()
103
 
        self._rules_searcher = None
104
 
        self.views = self._make_views()
105
 
        #--- allow tests to select the dirstate iter_changes implementation
106
 
        self._iter_changes = dirstate._process_entry
107
154
 
108
155
    @needs_tree_write_lock
109
156
    def _add(self, files, ids, kinds):
111
158
        state = self.current_dirstate()
112
159
        for f, file_id, kind in zip(files, ids, kinds):
113
160
            f = f.strip('/')
 
161
            assert '//' not in f
 
162
            assert '..' not in f
114
163
            if self.path2id(f):
115
164
                # special case tree root handling.
116
165
                if f == '' and self.path2id(f) == ROOT_ID:
137
186
    @needs_tree_write_lock
138
187
    def add_reference(self, sub_tree):
139
188
        # use standard implementation, which calls back to self._add
140
 
        #
 
189
        # 
141
190
        # So we don't store the reference_revision in the working dirstate,
142
 
        # it's just recorded at the moment of commit.
 
191
        # it's just recorded at the moment of commit. 
143
192
        self._add_reference(sub_tree)
144
193
 
145
194
    def break_lock(self):
184
233
            WorkingTree3._comparison_data(self, entry, path)
185
234
        # it looks like a plain directory, but it's really a reference -- see
186
235
        # also kind()
187
 
        if (self._repo_supports_tree_reference and kind == 'directory'
188
 
            and entry is not None and entry.kind == 'tree-reference'):
 
236
        if (self._repo_supports_tree_reference and
 
237
            kind == 'directory' and
 
238
            self._directory_is_tree_reference(path)):
189
239
            kind = 'tree-reference'
190
240
        return kind, executable, stat_value
191
241
 
217
267
            return self._dirstate
218
268
        local_path = self.bzrdir.get_workingtree_transport(None
219
269
            ).local_abspath('dirstate')
220
 
        self._dirstate = dirstate.DirState.on_file(local_path,
221
 
            self._sha1_provider())
 
270
        self._dirstate = dirstate.DirState.on_file(local_path)
222
271
        return self._dirstate
223
272
 
224
 
    def _sha1_provider(self):
225
 
        """A function that returns a SHA1Provider suitable for this tree.
226
 
 
227
 
        :return: None if content filtering is not supported by this tree.
228
 
          Otherwise, a SHA1Provider is returned that sha's the canonical
229
 
          form of files, i.e. after read filters are applied.
230
 
        """
231
 
        if self.supports_content_filtering():
232
 
            return ContentFilterAwareSHA1Provider(self)
233
 
        else:
234
 
            return None
 
273
    def _directory_is_tree_reference(self, relpath):
 
274
        # as a special case, if a directory contains control files then 
 
275
        # it's a tree reference, except that the root of the tree is not
 
276
        return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
 
277
        # TODO: We could ask all the control formats whether they
 
278
        # recognize this directory, but at the moment there's no cheap api
 
279
        # to do that.  Since we probably can only nest bzr checkouts and
 
280
        # they always use this name it's ok for now.  -- mbp 20060306
 
281
        #
 
282
        # FIXME: There is an unhandled case here of a subdirectory
 
283
        # containing .bzr but not a branch; that will probably blow up
 
284
        # when you try to commit it.  It might happen if there is a
 
285
        # checkout in a subdirectory.  This can be avoided by not adding
 
286
        # it.  mbp 20070306
235
287
 
236
288
    def filter_unversioned_files(self, paths):
237
289
        """Filter out paths that are versioned.
270
322
 
271
323
    def _generate_inventory(self):
272
324
        """Create and set self.inventory from the dirstate object.
273
 
 
 
325
        
274
326
        This is relatively expensive: we have to walk the entire dirstate.
275
327
        Ideally we would not, and can deprecate this function.
276
328
        """
280
332
        state._read_dirblocks_if_needed()
281
333
        root_key, current_entry = self._get_entry(path='')
282
334
        current_id = root_key[2]
283
 
        if not (current_entry[0][0] == 'd'): # directory
284
 
            raise AssertionError(current_entry)
 
335
        assert current_entry[0][0] == 'd' # directory
285
336
        inv = Inventory(root_id=current_id)
286
337
        # Turn some things into local variables
287
338
        minikind_to_kind = dirstate.DirState._minikind_to_kind
320
371
                    # add this entry to the parent map.
321
372
                    parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
322
373
                elif kind == 'tree-reference':
323
 
                    if not self._repo_supports_tree_reference:
324
 
                        raise errors.UnsupportedOperation(
325
 
                            self._generate_inventory,
326
 
                            self.branch.repository)
 
374
                    assert self._repo_supports_tree_reference, \
 
375
                        "repository of %r " \
 
376
                        "doesn't support tree references " \
 
377
                        "required by entry %r" \
 
378
                        % (self, name)
327
379
                    inv_entry.reference_revision = link_or_sha1 or None
328
380
                elif kind != 'symlink':
329
381
                    raise AssertionError("unknown kind %r" % kind)
330
382
                # These checks cost us around 40ms on a 55k entry tree
331
 
                if file_id in inv_byid:
332
 
                    raise AssertionError('file_id %s already in'
333
 
                        ' inventory as %s' % (file_id, inv_byid[file_id]))
334
 
                if name_unicode in parent_ie.children:
335
 
                    raise AssertionError('name %r already in parent'
336
 
                        % (name_unicode,))
 
383
                assert file_id not in inv_byid, ('file_id %s already in'
 
384
                    ' inventory as %s' % (file_id, inv_byid[file_id]))
 
385
                assert name_unicode not in parent_ie.children
337
386
                inv_byid[file_id] = inv_entry
338
387
                parent_ie.children[name_unicode] = inv_entry
339
388
        self._inventory = inv
344
393
        If either file_id or path is supplied, it is used as the key to lookup.
345
394
        If both are supplied, the fastest lookup is used, and an error is
346
395
        raised if they do not both point at the same row.
347
 
 
 
396
        
348
397
        :param file_id: An optional unicode file_id to be looked up.
349
398
        :param path: An optional unicode path to be looked up.
350
399
        :return: The dirstate row tuple for path/file_id, or (None, None)
374
423
                    return None
375
424
                else:
376
425
                    raise
377
 
        link_or_sha1 = dirstate.update_entry(state, entry, file_abspath,
378
 
            stat_value=stat_value)
 
426
        link_or_sha1 = state.update_entry(entry, file_abspath,
 
427
                                          stat_value=stat_value)
379
428
        if entry[1][0][0] == 'f':
380
 
            if link_or_sha1 is None:
381
 
                file_obj, statvalue = self.get_file_with_stat(file_id, path)
382
 
                try:
383
 
                    sha1 = osutils.sha_file(file_obj)
384
 
                finally:
385
 
                    file_obj.close()
386
 
                self._observed_sha1(file_id, path, (sha1, statvalue))
387
 
                return sha1
388
 
            else:
389
 
                return link_or_sha1
 
429
            return link_or_sha1
390
430
        return None
391
431
 
392
432
    def _get_inventory(self):
393
433
        """Get the inventory for the tree. This is only valid within a lock."""
394
 
        if 'evil' in debug.debug_flags:
395
 
            trace.mutter_callsite(2,
396
 
                "accessing .inventory forces a size of tree translation.")
397
434
        if self._inventory is not None:
398
435
            return self._inventory
399
436
        self._must_be_locked()
406
443
    @needs_read_lock
407
444
    def get_parent_ids(self):
408
445
        """See Tree.get_parent_ids.
409
 
 
 
446
        
410
447
        This implementation requests the ids list from the dirstate file.
411
448
        """
412
449
        return self.current_dirstate().get_parent_ids()
428
465
 
429
466
    def has_id(self, file_id):
430
467
        state = self.current_dirstate()
 
468
        file_id = osutils.safe_file_id(file_id)
431
469
        row, parents = self._get_entry(file_id=file_id)
432
470
        if row is None:
433
471
            return False
434
472
        return osutils.lexists(pathjoin(
435
473
                    self.basedir, row[0].decode('utf8'), row[1].decode('utf8')))
436
474
 
437
 
    def has_or_had_id(self, file_id):
438
 
        state = self.current_dirstate()
439
 
        row, parents = self._get_entry(file_id=file_id)
440
 
        return row is not None
441
 
 
442
475
    @needs_read_lock
443
476
    def id2path(self, file_id):
444
477
        "Convert a file-id to a path."
 
478
        file_id = osutils.safe_file_id(file_id)
445
479
        state = self.current_dirstate()
446
480
        entry = self._get_entry(file_id=file_id)
447
481
        if entry == (None, None):
449
483
        path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
450
484
        return path_utf8.decode('utf8')
451
485
 
452
 
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
453
 
        entry = self._get_entry(path=path)
454
 
        if entry == (None, None):
455
 
            return False # Missing entries are not executable
456
 
        return entry[1][0][3] # Executable?
457
 
 
458
486
    if not osutils.supports_executable():
459
487
        def is_executable(self, file_id, path=None):
460
488
            """Test if a file is executable or not.
461
489
 
462
490
            Note: The caller is expected to take a read-lock before calling this.
463
491
            """
 
492
            file_id = osutils.safe_file_id(file_id)
464
493
            entry = self._get_entry(file_id=file_id, path=path)
465
494
            if entry == (None, None):
466
495
                return False
467
496
            return entry[1][0][3]
468
 
 
469
 
        _is_executable_from_path_and_stat = \
470
 
            _is_executable_from_path_and_stat_from_basis
471
497
    else:
472
498
        def is_executable(self, file_id, path=None):
473
499
            """Test if a file is executable or not.
474
500
 
475
501
            Note: The caller is expected to take a read-lock before calling this.
476
502
            """
477
 
            self._must_be_locked()
478
503
            if not path:
 
504
                file_id = osutils.safe_file_id(file_id)
479
505
                path = self.id2path(file_id)
480
506
            mode = os.lstat(self.abspath(path)).st_mode
481
507
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
482
508
 
483
 
    def all_file_ids(self):
484
 
        """See Tree.iter_all_file_ids"""
485
 
        self._must_be_locked()
486
 
        result = set()
487
 
        for key, tree_details in self.current_dirstate()._iter_entries():
488
 
            if tree_details[0][0] in ('a', 'r'): # relocated
489
 
                continue
490
 
            result.add(key[2])
491
 
        return result
492
 
 
493
509
    @needs_read_lock
494
510
    def __iter__(self):
495
511
        """Iterate through file_ids for this tree.
508
524
        return iter(result)
509
525
 
510
526
    def iter_references(self):
511
 
        if not self._repo_supports_tree_reference:
512
 
            # When the repo doesn't support references, we will have nothing to
513
 
            # return
514
 
            return
515
527
        for key, tree_details in self.current_dirstate()._iter_entries():
516
528
            if tree_details[0][0] in ('a', 'r'): # absent, relocated
517
529
                # not relevant to the working tree
519
531
            if not key[1]:
520
532
                # the root is not a reference.
521
533
                continue
522
 
            relpath = pathjoin(key[0].decode('utf8'), key[1].decode('utf8'))
 
534
            path = pathjoin(self.basedir, key[0].decode('utf8'), key[1].decode('utf8'))
523
535
            try:
524
 
                if self._kind(relpath) == 'tree-reference':
525
 
                    yield relpath, key[2]
 
536
                if self._kind(path) == 'tree-reference':
 
537
                    yield path, key[2]
526
538
            except errors.NoSuchFile:
527
539
                # path is missing on disk.
528
540
                continue
529
541
 
530
 
    def _observed_sha1(self, file_id, path, (sha1, statvalue)):
531
 
        """See MutableTree._observed_sha1."""
532
 
        state = self.current_dirstate()
533
 
        entry = self._get_entry(file_id=file_id, path=path)
534
 
        state._observed_sha1(entry, sha1, statvalue)
535
 
 
536
542
    def kind(self, file_id):
537
543
        """Return the kind of a file.
538
544
 
542
548
        Note: The caller is expected to take a read-lock before calling this.
543
549
        """
544
550
        relpath = self.id2path(file_id)
545
 
        if relpath is None:
546
 
            raise AssertionError(
547
 
                "path for id {%s} is None!" % file_id)
 
551
        assert relpath != None, \
 
552
            "path for id {%s} is None!" % file_id
548
553
        return self._kind(relpath)
549
554
 
550
555
    def _kind(self, relpath):
551
556
        abspath = self.abspath(relpath)
552
557
        kind = file_kind(abspath)
553
 
        if (self._repo_supports_tree_reference and kind == 'directory'):
554
 
            entry = self._get_entry(path=relpath)
555
 
            if entry[1] is not None:
556
 
                if entry[1][0][0] == 't':
557
 
                    kind = 'tree-reference'
 
558
        if (self._repo_supports_tree_reference and
 
559
            kind == 'directory' and
 
560
            self._directory_is_tree_reference(relpath)):
 
561
            kind = 'tree-reference'
558
562
        return kind
559
563
 
560
564
    @needs_read_lock
564
568
        if parent_ids:
565
569
            return parent_ids[0]
566
570
        else:
567
 
            return _mod_revision.NULL_REVISION
 
571
            return None
568
572
 
569
573
    def lock_read(self):
570
 
        """See Branch.lock_read, and WorkingTree.unlock.
571
 
 
572
 
        :return: An object with an unlock method which will release the lock
573
 
            obtained.
574
 
        """
 
574
        """See Branch.lock_read, and WorkingTree.unlock."""
575
575
        self.branch.lock_read()
576
576
        try:
577
577
            self._control_files.lock_read()
590
590
        except:
591
591
            self.branch.unlock()
592
592
            raise
593
 
        return self
594
593
 
595
594
    def _lock_self_write(self):
596
595
        """This should be called after the branch is locked."""
611
610
        except:
612
611
            self.branch.unlock()
613
612
            raise
614
 
        return self
615
613
 
616
614
    def lock_tree_write(self):
617
 
        """See MutableTree.lock_tree_write, and WorkingTree.unlock.
618
 
 
619
 
        :return: An object with an unlock method which will release the lock
620
 
            obtained.
621
 
        """
 
615
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
622
616
        self.branch.lock_read()
623
 
        return self._lock_self_write()
 
617
        self._lock_self_write()
624
618
 
625
619
    def lock_write(self):
626
 
        """See MutableTree.lock_write, and WorkingTree.unlock.
627
 
 
628
 
        :return: An object with an unlock method which will release the lock
629
 
            obtained.
630
 
        """
 
620
        """See MutableTree.lock_write, and WorkingTree.unlock."""
631
621
        self.branch.lock_write()
632
 
        return self._lock_self_write()
 
622
        self._lock_self_write()
633
623
 
634
624
    @needs_tree_write_lock
635
625
    def move(self, from_paths, to_dir, after=False):
637
627
        result = []
638
628
        if not from_paths:
639
629
            return result
 
630
 
640
631
        state = self.current_dirstate()
641
 
        if isinstance(from_paths, basestring):
642
 
            raise ValueError()
 
632
 
 
633
        assert not isinstance(from_paths, basestring)
643
634
        to_dir_utf8 = to_dir.encode('utf8')
644
635
        to_entry_dirname, to_basename = os.path.split(to_dir_utf8)
645
636
        id_index = state._get_id_index()
667
658
        if self._inventory is not None:
668
659
            update_inventory = True
669
660
            inv = self.inventory
 
661
            to_dir_ie = inv[to_dir_id]
670
662
            to_dir_id = to_entry[0][2]
671
 
            to_dir_ie = inv[to_dir_id]
672
663
        else:
673
664
            update_inventory = False
674
665
 
705
696
            from_entry = self._get_entry(path=from_rel)
706
697
            if from_entry == (None, None):
707
698
                raise errors.BzrMoveFailedError(from_rel,to_dir,
708
 
                    errors.NotVersionedError(path=from_rel))
 
699
                    errors.NotVersionedError(path=str(from_rel)))
709
700
 
710
701
            from_id = from_entry[0][2]
711
702
            to_rel = pathjoin(to_dir, from_tail)
738
729
                if from_missing: # implicitly just update our path mapping
739
730
                    move_file = False
740
731
                elif not after:
741
 
                    raise errors.RenameFailedFilesExist(from_rel, to_rel)
 
732
                    raise errors.RenameFailedFilesExist(from_rel, to_rel,
 
733
                        extra="(Use --after to update the Bazaar id)")
742
734
 
743
735
            rollbacks = []
744
736
            def rollback_rename():
800
792
                if minikind == 'd':
801
793
                    def update_dirblock(from_dir, to_key, to_dir_utf8):
802
794
                        """Recursively update all entries in this dirblock."""
803
 
                        if from_dir == '':
804
 
                            raise AssertionError("renaming root not supported")
 
795
                        assert from_dir != '', "renaming root not supported"
805
796
                        from_key = (from_dir, '')
806
797
                        from_block_idx, present = \
807
798
                            state._find_block_index_from_key(from_key)
820
811
 
821
812
                        # Grab a copy since move_one may update the list.
822
813
                        for entry in from_block[1][:]:
823
 
                            if not (entry[0][0] == from_dir):
824
 
                                raise AssertionError()
 
814
                            assert entry[0][0] == from_dir
825
815
                            cur_details = entry[1][0]
826
816
                            to_key = (to_dir_utf8, entry[0][1], entry[0][2])
827
817
                            from_path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
886
876
        for tree in trees:
887
877
            if not (isinstance(tree, DirStateRevisionTree) and tree._revision_id in
888
878
                parents):
889
 
                return super(DirStateWorkingTree, self).paths2ids(paths,
890
 
                    trees, require_versioned)
 
879
                return super(WorkingTree4, self).paths2ids(paths, trees, require_versioned)
891
880
        search_indexes = [0] + [1 + parents.index(tree._revision_id) for tree in trees]
892
881
        # -- make all paths utf8 --
893
882
        paths_utf8 = set()
953
942
            if not all_versioned:
954
943
                raise errors.PathsNotVersionedError(paths)
955
944
        # -- remove redundancy in supplied paths to prevent over-scanning --
956
 
        search_paths = osutils.minimum_path_selection(paths)
957
 
        # sketch:
 
945
        search_paths = set()
 
946
        for path in paths:
 
947
            other_paths = paths.difference(set([path]))
 
948
            if not osutils.is_inside_any(other_paths, path):
 
949
                # this is a top level path, we must check it.
 
950
                search_paths.add(path)
 
951
        # sketch: 
958
952
        # for all search_indexs in each path at or under each element of
959
953
        # search_paths, if the detail is relocated: add the id, and add the
960
954
        # relocated path as one to search if its not searched already. If the
1016
1010
 
1017
1011
    def read_working_inventory(self):
1018
1012
        """Read the working inventory.
1019
 
 
 
1013
        
1020
1014
        This is a meaningless operation for dirstate, but we obey it anyhow.
1021
1015
        """
1022
1016
        return self.inventory
1027
1021
 
1028
1022
        WorkingTree4 supplies revision_trees for any basis tree.
1029
1023
        """
 
1024
        revision_id = osutils.safe_revision_id(revision_id)
1030
1025
        dirstate = self.current_dirstate()
1031
1026
        parent_ids = dirstate.get_parent_ids()
1032
1027
        if revision_id not in parent_ids:
1039
1034
    @needs_tree_write_lock
1040
1035
    def set_last_revision(self, new_revision):
1041
1036
        """Change the last revision in the working tree."""
 
1037
        new_revision = osutils.safe_revision_id(new_revision)
1042
1038
        parents = self.get_parent_ids()
1043
 
        if new_revision in (_mod_revision.NULL_REVISION, None):
1044
 
            if len(parents) >= 2:
1045
 
                raise AssertionError(
1046
 
                    "setting the last parent to none with a pending merge is "
1047
 
                    "unsupported.")
 
1039
        if new_revision in (NULL_REVISION, None):
 
1040
            assert len(parents) < 2, (
 
1041
                "setting the last parent to none with a pending merge is "
 
1042
                "unsupported.")
1048
1043
            self.set_parent_ids([])
1049
1044
        else:
1050
1045
            self.set_parent_ids([new_revision] + parents[1:],
1053
1048
    @needs_tree_write_lock
1054
1049
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
1055
1050
        """Set the parent ids to revision_ids.
1056
 
 
 
1051
        
1057
1052
        See also set_parent_trees. This api will try to retrieve the tree data
1058
1053
        for each element of revision_ids from the trees repository. If you have
1059
1054
        tree data already available, it is more efficient to use
1063
1058
        :param revision_ids: The revision_ids to set as the parent ids of this
1064
1059
            working tree. Any of these may be ghosts.
1065
1060
        """
 
1061
        revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1066
1062
        trees = []
1067
1063
        for revision_id in revision_ids:
1068
1064
            try:
1091
1087
                raise errors.GhostRevisionUnusableHere(parents_list[0][0])
1092
1088
        real_trees = []
1093
1089
        ghosts = []
1094
 
 
1095
 
        parent_ids = [rev_id for rev_id, tree in parents_list]
1096
 
        graph = self.branch.repository.get_graph()
1097
 
        heads = graph.heads(parent_ids)
1098
 
        accepted_revisions = set()
1099
 
 
1100
1090
        # convert absent trees to the null tree, which we convert back to
1101
1091
        # missing on access.
1102
1092
        for rev_id, tree in parents_list:
1103
 
            if len(accepted_revisions) > 0:
1104
 
                # we always accept the first tree
1105
 
                if rev_id in accepted_revisions or rev_id not in heads:
1106
 
                    # We have already included either this tree, or its
1107
 
                    # descendent, so we skip it.
1108
 
                    continue
 
1093
            rev_id = osutils.safe_revision_id(rev_id)
1109
1094
            _mod_revision.check_not_reserved_id(rev_id)
1110
1095
            if tree is not None:
1111
1096
                real_trees.append((rev_id, tree))
1112
1097
            else:
1113
1098
                real_trees.append((rev_id,
1114
 
                    self.branch.repository.revision_tree(
1115
 
                        _mod_revision.NULL_REVISION)))
 
1099
                    self.branch.repository.revision_tree(None)))
1116
1100
                ghosts.append(rev_id)
1117
 
            accepted_revisions.add(rev_id)
1118
1101
        dirstate.set_parent_trees(real_trees, ghosts=ghosts)
1119
1102
        self._make_dirty(reset_inventory=False)
1120
1103
 
1125
1108
        if state._dirblock_state == dirstate.DirState.IN_MEMORY_MODIFIED:
1126
1109
            self._make_dirty(reset_inventory=True)
1127
1110
 
1128
 
    def _sha_from_stat(self, path, stat_result):
1129
 
        """Get a sha digest from the tree's stat cache.
1130
 
 
1131
 
        The default implementation assumes no stat cache is present.
1132
 
 
1133
 
        :param path: The path.
1134
 
        :param stat_result: The stat result being looked up.
1135
 
        """
1136
 
        return self.current_dirstate().sha1_from_stat(path, stat_result)
1137
 
 
1138
1111
    @needs_read_lock
1139
1112
    def supports_tree_reference(self):
1140
1113
        return self._repo_supports_tree_reference
1180
1153
            return
1181
1154
        state = self.current_dirstate()
1182
1155
        state._read_dirblocks_if_needed()
1183
 
        ids_to_unversion = set(file_ids)
 
1156
        ids_to_unversion = set()
 
1157
        for file_id in file_ids:
 
1158
            ids_to_unversion.add(osutils.safe_file_id(file_id))
1184
1159
        paths_to_unversion = set()
1185
1160
        # sketch:
1186
1161
        # check if the root is to be unversioned, if so, assert for now.
1213
1188
                # just forget the whole block.
1214
1189
                entry_index = 0
1215
1190
                while entry_index < len(block[1]):
 
1191
                    # Mark this file id as having been removed
1216
1192
                    entry = block[1][entry_index]
1217
 
                    if entry[1][0][0] in 'ar':
1218
 
                        # don't remove absent or renamed entries
 
1193
                    ids_to_unversion.discard(entry[0][2])
 
1194
                    if (entry[1][0][0] == 'a'
 
1195
                        or not state._make_absent(entry)):
1219
1196
                        entry_index += 1
1220
 
                    else:
1221
 
                        # Mark this file id as having been removed
1222
 
                        ids_to_unversion.discard(entry[0][2])
1223
 
                        if not state._make_absent(entry):
1224
 
                            # The block has not shrunk.
1225
 
                            entry_index += 1
1226
1197
                # go to the next block. (At the moment we dont delete empty
1227
1198
                # dirblocks)
1228
1199
                block_index += 1
1251
1222
            for file_id in file_ids:
1252
1223
                self._inventory.remove_recursive_id(file_id)
1253
1224
 
1254
 
    @needs_tree_write_lock
1255
 
    def rename_one(self, from_rel, to_rel, after=False):
1256
 
        """See WorkingTree.rename_one"""
1257
 
        self.flush()
1258
 
        WorkingTree.rename_one(self, from_rel, to_rel, after)
1259
 
 
1260
 
    @needs_tree_write_lock
1261
 
    def apply_inventory_delta(self, changes):
1262
 
        """See MutableTree.apply_inventory_delta"""
1263
 
        state = self.current_dirstate()
1264
 
        state.update_by_delta(changes)
1265
 
        self._make_dirty(reset_inventory=True)
1266
 
 
1267
 
    def update_basis_by_delta(self, new_revid, delta):
1268
 
        """See MutableTree.update_basis_by_delta."""
1269
 
        if self.last_revision() == new_revid:
1270
 
            raise AssertionError()
1271
 
        self.current_dirstate().update_basis_by_delta(delta, new_revid)
1272
 
 
1273
1225
    @needs_read_lock
1274
1226
    def _validate(self):
1275
1227
        self._dirstate._validate()
1277
1229
    @needs_tree_write_lock
1278
1230
    def _write_inventory(self, inv):
1279
1231
        """Write inventory as the current inventory."""
1280
 
        if self._dirty:
1281
 
            raise AssertionError("attempting to write an inventory when the "
1282
 
                "dirstate is dirty will lose pending changes")
1283
 
        had_inventory = self._inventory is not None
1284
 
        # Setting self._inventory = None forces the dirstate to regenerate the
1285
 
        # working inventory. We do this because self.inventory may be inv, or
1286
 
        # may have been modified, and either case would prevent a clean delta
1287
 
        # being created.
1288
 
        self._inventory = None
1289
 
        # generate a delta,
1290
 
        delta = inv._make_delta(self.inventory)
1291
 
        # and apply it.
1292
 
        self.apply_inventory_delta(delta)
1293
 
        if had_inventory:
 
1232
        assert not self._dirty, "attempting to write an inventory when the dirstate is dirty will cause data loss"
 
1233
        self.current_dirstate().set_state_from_inventory(inv)
 
1234
        self._make_dirty(reset_inventory=False)
 
1235
        if self._inventory is not None:
1294
1236
            self._inventory = inv
1295
1237
        self.flush()
1296
1238
 
1297
1239
 
1298
 
class ContentFilterAwareSHA1Provider(dirstate.SHA1Provider):
1299
 
 
1300
 
    def __init__(self, tree):
1301
 
        self.tree = tree
1302
 
 
1303
 
    def sha1(self, abspath):
1304
 
        """See dirstate.SHA1Provider.sha1()."""
1305
 
        filters = self.tree._content_filter_stack(
1306
 
            self.tree.relpath(osutils.safe_unicode(abspath)))
1307
 
        return internal_size_sha_file_byname(abspath, filters)[1]
1308
 
 
1309
 
    def stat_and_sha1(self, abspath):
1310
 
        """See dirstate.SHA1Provider.stat_and_sha1()."""
1311
 
        filters = self.tree._content_filter_stack(
1312
 
            self.tree.relpath(osutils.safe_unicode(abspath)))
1313
 
        file_obj = file(abspath, 'rb', 65000)
1314
 
        try:
1315
 
            statvalue = os.fstat(file_obj.fileno())
1316
 
            if filters:
1317
 
                file_obj = filtered_input_file(file_obj, filters)
1318
 
            sha1 = osutils.size_sha_file(file_obj)[1]
1319
 
        finally:
1320
 
            file_obj.close()
1321
 
        return statvalue, sha1
1322
 
 
1323
 
 
1324
 
class ContentFilteringDirStateWorkingTree(DirStateWorkingTree):
1325
 
    """Dirstate working tree that supports content filtering.
1326
 
 
1327
 
    The dirstate holds the hash and size of the canonical form of the file, 
1328
 
    and most methods must return that.
1329
 
    """
1330
 
 
1331
 
    def _file_content_summary(self, path, stat_result):
1332
 
        # This is to support the somewhat obsolete path_content_summary method
1333
 
        # with content filtering: see
1334
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/415508>.
1335
 
        #
1336
 
        # If the dirstate cache is up to date and knows the hash and size,
1337
 
        # return that.
1338
 
        # Otherwise if there are no content filters, return the on-disk size
1339
 
        # and leave the hash blank.
1340
 
        # Otherwise, read and filter the on-disk file and use its size and
1341
 
        # hash.
1342
 
        #
1343
 
        # The dirstate doesn't store the size of the canonical form so we
1344
 
        # can't trust it for content-filtered trees.  We just return None.
1345
 
        dirstate_sha1 = self._dirstate.sha1_from_stat(path, stat_result)
1346
 
        executable = self._is_executable_from_path_and_stat(path, stat_result)
1347
 
        return ('file', None, executable, dirstate_sha1)
1348
 
 
1349
 
 
1350
 
class WorkingTree4(DirStateWorkingTree):
1351
 
    """This is the Format 4 working tree.
1352
 
 
1353
 
    This differs from WorkingTree3 by:
1354
 
     - Having a consolidated internal dirstate, stored in a
1355
 
       randomly-accessible sorted file on disk.
1356
 
     - Not having a regular inventory attribute.  One can be synthesized
1357
 
       on demand but this is expensive and should be avoided.
1358
 
 
1359
 
    This is new in bzr 0.15.
1360
 
    """
1361
 
 
1362
 
 
1363
 
class WorkingTree5(ContentFilteringDirStateWorkingTree):
1364
 
    """This is the Format 5 working tree.
1365
 
 
1366
 
    This differs from WorkingTree4 by:
1367
 
     - Supporting content filtering.
1368
 
 
1369
 
    This is new in bzr 1.11.
1370
 
    """
1371
 
 
1372
 
 
1373
 
class WorkingTree6(ContentFilteringDirStateWorkingTree):
1374
 
    """This is the Format 6 working tree.
1375
 
 
1376
 
    This differs from WorkingTree5 by:
1377
 
     - Supporting a current view that may mask the set of files in a tree
1378
 
       impacted by most user operations.
1379
 
 
1380
 
    This is new in bzr 1.14.
1381
 
    """
1382
 
 
1383
 
    def _make_views(self):
1384
 
        return views.PathBasedViews(self)
1385
 
 
1386
 
 
1387
 
class DirStateWorkingTreeFormat(WorkingTreeFormat3):
1388
 
 
1389
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
1390
 
                   accelerator_tree=None, hardlink=False):
 
1240
class WorkingTreeFormat4(WorkingTreeFormat3):
 
1241
    """The first consolidated dirstate working tree format.
 
1242
 
 
1243
    This format:
 
1244
        - exists within a metadir controlling .bzr
 
1245
        - includes an explicit version marker for the workingtree control
 
1246
          files, separate from the BzrDir format
 
1247
        - modifies the hash cache format
 
1248
        - is new in bzr 0.15
 
1249
        - uses a LockDir to guard access to it.
 
1250
    """
 
1251
 
 
1252
    upgrade_recommended = False
 
1253
 
 
1254
    def get_format_string(self):
 
1255
        """See WorkingTreeFormat.get_format_string()."""
 
1256
        return "Bazaar Working Tree Format 4 (bzr 0.15)\n"
 
1257
 
 
1258
    def get_format_description(self):
 
1259
        """See WorkingTreeFormat.get_format_description()."""
 
1260
        return "Working tree format 4"
 
1261
 
 
1262
    def initialize(self, a_bzrdir, revision_id=None):
1391
1263
        """See WorkingTreeFormat.initialize().
1392
1264
 
1393
1265
        :param revision_id: allows creating a working tree at a different
1394
1266
        revision than the branch is at.
1395
 
        :param accelerator_tree: A tree which can be used for retrieving file
1396
 
            contents more quickly than the revision tree, i.e. a workingtree.
1397
 
            The revision tree will be used for cases where accelerator_tree's
1398
 
            content is different.
1399
 
        :param hardlink: If true, hard-link files from accelerator_tree,
1400
 
            where possible.
1401
1267
 
1402
1268
        These trees get an initial random root id, if their repository supports
1403
1269
        rich root data, TREE_ROOT otherwise.
1404
1270
        """
 
1271
        revision_id = osutils.safe_revision_id(revision_id)
1405
1272
        if not isinstance(a_bzrdir.transport, LocalTransport):
1406
1273
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
1407
1274
        transport = a_bzrdir.get_workingtree_transport(self)
1408
1275
        control_files = self._open_control_files(a_bzrdir)
1409
1276
        control_files.create_lock()
1410
1277
        control_files.lock_write()
1411
 
        transport.put_bytes('format', self.get_format_string(),
1412
 
            mode=a_bzrdir._get_file_mode())
1413
 
        if from_branch is not None:
1414
 
            branch = from_branch
1415
 
        else:
1416
 
            branch = a_bzrdir.open_branch()
 
1278
        control_files.put_utf8('format', self.get_format_string())
 
1279
        branch = a_bzrdir.open_branch()
1417
1280
        if revision_id is None:
1418
1281
            revision_id = branch.last_revision()
1419
1282
        local_path = transport.local_abspath('dirstate')
1421
1284
        state = dirstate.DirState.initialize(local_path)
1422
1285
        state.unlock()
1423
1286
        del state
1424
 
        wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
 
1287
        wt = WorkingTree4(a_bzrdir.root_transport.local_abspath('.'),
1425
1288
                         branch,
1426
1289
                         _format=self,
1427
1290
                         _bzrdir=a_bzrdir,
1429
1292
        wt._new_tree()
1430
1293
        wt.lock_tree_write()
1431
1294
        try:
1432
 
            self._init_custom_control_files(wt)
1433
 
            if revision_id in (None, _mod_revision.NULL_REVISION):
 
1295
            if revision_id in (None, NULL_REVISION):
1434
1296
                if branch.repository.supports_rich_root():
1435
1297
                    wt._set_root_id(generate_ids.gen_root_id())
1436
1298
                else:
1437
1299
                    wt._set_root_id(ROOT_ID)
1438
1300
                wt.flush()
1439
 
            basis = None
1440
 
            # frequently, we will get here due to branching.  The accelerator
1441
 
            # tree will be the tree from the branch, so the desired basis
1442
 
            # tree will often be a parent of the accelerator tree.
1443
 
            if accelerator_tree is not None:
1444
 
                try:
1445
 
                    basis = accelerator_tree.revision_tree(revision_id)
1446
 
                except errors.NoSuchRevision:
1447
 
                    pass
1448
 
            if basis is None:
1449
 
                basis = branch.repository.revision_tree(revision_id)
1450
 
            if revision_id == _mod_revision.NULL_REVISION:
1451
 
                parents_list = []
1452
 
            else:
1453
 
                parents_list = [(revision_id, basis)]
 
1301
            wt.set_last_revision(revision_id)
 
1302
            wt.flush()
 
1303
            basis = wt.basis_tree()
1454
1304
            basis.lock_read()
1455
 
            try:
1456
 
                wt.set_parent_trees(parents_list, allow_leftmost_as_ghost=True)
 
1305
            # if the basis has a root id we have to use that; otherwise we use
 
1306
            # a new random one
 
1307
            basis_root_id = basis.get_root_id()
 
1308
            if basis_root_id is not None:
 
1309
                wt._set_root_id(basis_root_id)
1457
1310
                wt.flush()
1458
 
                # if the basis has a root id we have to use that; otherwise we
1459
 
                # use a new random one
1460
 
                basis_root_id = basis.get_root_id()
1461
 
                if basis_root_id is not None:
1462
 
                    wt._set_root_id(basis_root_id)
1463
 
                    wt.flush()
1464
 
                if wt.supports_content_filtering():
1465
 
                    # The original tree may not have the same content filters
1466
 
                    # applied so we can't safely build the inventory delta from
1467
 
                    # the source tree.
1468
 
                    delta_from_tree = False
1469
 
                else:
1470
 
                    delta_from_tree = True
1471
 
                # delta_from_tree is safe even for DirStateRevisionTrees,
1472
 
                # because wt4.apply_inventory_delta does not mutate the input
1473
 
                # inventory entries.
1474
 
                transform.build_tree(basis, wt, accelerator_tree,
1475
 
                                     hardlink=hardlink,
1476
 
                                     delta_from_tree=delta_from_tree)
1477
 
            finally:
1478
 
                basis.unlock()
 
1311
            transform.build_tree(basis, wt)
 
1312
            basis.unlock()
1479
1313
        finally:
1480
1314
            control_files.unlock()
1481
1315
            wt.unlock()
1482
1316
        return wt
1483
1317
 
1484
 
    def _init_custom_control_files(self, wt):
1485
 
        """Subclasses with custom control files should override this method.
1486
 
 
1487
 
        The working tree and control files are locked for writing when this
1488
 
        method is called.
1489
 
 
1490
 
        :param wt: the WorkingTree object
1491
 
        """
1492
 
 
1493
1318
    def _open(self, a_bzrdir, control_files):
1494
1319
        """Open the tree itself.
1495
1320
 
1496
1321
        :param a_bzrdir: the dir for the tree.
1497
1322
        :param control_files: the control files for the tree.
1498
1323
        """
1499
 
        return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
 
1324
        return WorkingTree4(a_bzrdir.root_transport.local_abspath('.'),
1500
1325
                           branch=a_bzrdir.open_branch(),
1501
1326
                           _format=self,
1502
1327
                           _bzrdir=a_bzrdir,
1503
1328
                           _control_files=control_files)
1504
1329
 
1505
1330
    def __get_matchingbzrdir(self):
1506
 
        return self._get_matchingbzrdir()
1507
 
 
1508
 
    def _get_matchingbzrdir(self):
1509
 
        """Overrideable method to get a bzrdir for testing."""
1510
1331
        # please test against something that will let us do tree references
1511
1332
        return bzrdir.format_registry.make_bzrdir(
1512
1333
            'dirstate-with-subtree')
1514
1335
    _matchingbzrdir = property(__get_matchingbzrdir)
1515
1336
 
1516
1337
 
1517
 
class WorkingTreeFormat4(DirStateWorkingTreeFormat):
1518
 
    """The first consolidated dirstate working tree format.
1519
 
 
1520
 
    This format:
1521
 
        - exists within a metadir controlling .bzr
1522
 
        - includes an explicit version marker for the workingtree control
1523
 
          files, separate from the BzrDir format
1524
 
        - modifies the hash cache format
1525
 
        - is new in bzr 0.15
1526
 
        - uses a LockDir to guard access to it.
1527
 
    """
1528
 
 
1529
 
    upgrade_recommended = False
1530
 
 
1531
 
    _tree_class = WorkingTree4
1532
 
 
1533
 
    def get_format_string(self):
1534
 
        """See WorkingTreeFormat.get_format_string()."""
1535
 
        return "Bazaar Working Tree Format 4 (bzr 0.15)\n"
1536
 
 
1537
 
    def get_format_description(self):
1538
 
        """See WorkingTreeFormat.get_format_description()."""
1539
 
        return "Working tree format 4"
1540
 
 
1541
 
 
1542
 
class WorkingTreeFormat5(DirStateWorkingTreeFormat):
1543
 
    """WorkingTree format supporting content filtering.
1544
 
    """
1545
 
 
1546
 
    upgrade_recommended = False
1547
 
 
1548
 
    _tree_class = WorkingTree5
1549
 
 
1550
 
    def get_format_string(self):
1551
 
        """See WorkingTreeFormat.get_format_string()."""
1552
 
        return "Bazaar Working Tree Format 5 (bzr 1.11)\n"
1553
 
 
1554
 
    def get_format_description(self):
1555
 
        """See WorkingTreeFormat.get_format_description()."""
1556
 
        return "Working tree format 5"
1557
 
 
1558
 
    def supports_content_filtering(self):
1559
 
        return True
1560
 
 
1561
 
 
1562
 
class WorkingTreeFormat6(DirStateWorkingTreeFormat):
1563
 
    """WorkingTree format supporting views.
1564
 
    """
1565
 
 
1566
 
    upgrade_recommended = False
1567
 
 
1568
 
    _tree_class = WorkingTree6
1569
 
 
1570
 
    def get_format_string(self):
1571
 
        """See WorkingTreeFormat.get_format_string()."""
1572
 
        return "Bazaar Working Tree Format 6 (bzr 1.14)\n"
1573
 
 
1574
 
    def get_format_description(self):
1575
 
        """See WorkingTreeFormat.get_format_description()."""
1576
 
        return "Working tree format 6"
1577
 
 
1578
 
    def _init_custom_control_files(self, wt):
1579
 
        """Subclasses with custom control files should override this method."""
1580
 
        wt._transport.put_bytes('views', '', mode=wt.bzrdir._get_file_mode())
1581
 
 
1582
 
    def supports_content_filtering(self):
1583
 
        return True
1584
 
 
1585
 
    def supports_views(self):
1586
 
        return True
1587
 
 
1588
 
 
1589
1338
class DirStateRevisionTree(Tree):
1590
 
    """A revision tree pulling the inventory from a dirstate.
1591
 
    
1592
 
    Note that this is one of the historical (ie revision) trees cached in the
1593
 
    dirstate for easy access, not the workingtree.
1594
 
    """
 
1339
    """A revision tree pulling the inventory from a dirstate."""
1595
1340
 
1596
1341
    def __init__(self, dirstate, revision_id, repository):
1597
1342
        self._dirstate = dirstate
1598
 
        self._revision_id = revision_id
 
1343
        self._revision_id = osutils.safe_revision_id(revision_id)
1599
1344
        self._repository = repository
1600
1345
        self._inventory = None
1601
1346
        self._locked = 0
1602
1347
        self._dirstate_locked = False
1603
 
        self._repo_supports_tree_reference = getattr(
1604
 
            repository._format, "supports_tree_reference",
1605
 
            False)
1606
1348
 
1607
1349
    def __repr__(self):
1608
1350
        return "<%s of %s in %s>" % \
1611
1353
    def annotate_iter(self, file_id,
1612
1354
                      default_revision=_mod_revision.CURRENT_REVISION):
1613
1355
        """See Tree.annotate_iter"""
1614
 
        text_key = (file_id, self.inventory[file_id].revision)
1615
 
        annotations = self._repository.texts.annotate(text_key)
1616
 
        return [(key[-1], line) for (key, line) in annotations]
 
1356
        w = self._get_weave(file_id)
 
1357
        return w.annotate_iter(self.inventory[file_id].revision)
1617
1358
 
1618
1359
    def _get_ancestors(self, default_revision):
1619
1360
        return set(self._repository.get_ancestry(self._revision_id,
1640
1381
    def get_root_id(self):
1641
1382
        return self.path2id('')
1642
1383
 
1643
 
    def id2path(self, file_id):
1644
 
        "Convert a file-id to a path."
1645
 
        entry = self._get_entry(file_id=file_id)
1646
 
        if entry == (None, None):
1647
 
            raise errors.NoSuchId(tree=self, file_id=file_id)
1648
 
        path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
1649
 
        return path_utf8.decode('utf8')
1650
 
 
1651
 
    def iter_references(self):
1652
 
        if not self._repo_supports_tree_reference:
1653
 
            # When the repo doesn't support references, we will have nothing to
1654
 
            # return
1655
 
            return iter([])
1656
 
        # Otherwise, fall back to the default implementation
1657
 
        return super(DirStateRevisionTree, self).iter_references()
1658
 
 
1659
1384
    def _get_parent_index(self):
1660
1385
        """Return the index in the dirstate referenced by this tree."""
1661
1386
        return self._dirstate.get_parent_ids().index(self._revision_id) + 1
1666
1391
        If either file_id or path is supplied, it is used as the key to lookup.
1667
1392
        If both are supplied, the fastest lookup is used, and an error is
1668
1393
        raised if they do not both point at the same row.
1669
 
 
 
1394
        
1670
1395
        :param file_id: An optional unicode file_id to be looked up.
1671
1396
        :param path: An optional unicode path to be looked up.
1672
1397
        :return: The dirstate row tuple for path/file_id, or (None, None)
1673
1398
        """
1674
1399
        if file_id is None and path is None:
1675
1400
            raise errors.BzrError('must supply file_id or path')
 
1401
        file_id = osutils.safe_file_id(file_id)
1676
1402
        if path is not None:
1677
1403
            path = path.encode('utf8')
1678
1404
        parent_index = self._get_parent_index()
1686
1412
 
1687
1413
        This is relatively expensive: we have to walk the entire dirstate.
1688
1414
        """
1689
 
        if not self._locked:
1690
 
            raise AssertionError(
1691
 
                'cannot generate inventory of an unlocked '
1692
 
                'dirstate revision tree')
 
1415
        assert self._locked, 'cannot generate inventory of an unlocked '\
 
1416
            'dirstate revision tree'
1693
1417
        # separate call for profiling - makes it clear where the costs are.
1694
1418
        self._dirstate._read_dirblocks_if_needed()
1695
 
        if self._revision_id not in self._dirstate.get_parent_ids():
1696
 
            raise AssertionError(
1697
 
                'parent %s has disappeared from %s' % (
1698
 
                self._revision_id, self._dirstate.get_parent_ids()))
 
1419
        assert self._revision_id in self._dirstate.get_parent_ids(), \
 
1420
            'parent %s has disappeared from %s' % (
 
1421
            self._revision_id, self._dirstate.get_parent_ids())
1699
1422
        parent_index = self._dirstate.get_parent_ids().index(self._revision_id) + 1
1700
1423
        # This is identical now to the WorkingTree _generate_inventory except
1701
1424
        # for the tree index use.
1702
1425
        root_key, current_entry = self._dirstate._get_entry(parent_index, path_utf8='')
1703
1426
        current_id = root_key[2]
1704
 
        if current_entry[parent_index][0] != 'd':
1705
 
            raise AssertionError()
 
1427
        assert current_entry[parent_index][0] == 'd'
1706
1428
        inv = Inventory(root_id=current_id, revision_id=self._revision_id)
1707
1429
        inv.root.revision = current_entry[parent_index][4]
1708
1430
        # Turn some things into local variables
1748
1470
                    raise AssertionError("cannot convert entry %r into an InventoryEntry"
1749
1471
                            % entry)
1750
1472
                # These checks cost us around 40ms on a 55k entry tree
1751
 
                if file_id in inv_byid:
1752
 
                    raise AssertionError('file_id %s already in'
1753
 
                        ' inventory as %s' % (file_id, inv_byid[file_id]))
1754
 
                if name_unicode in parent_ie.children:
1755
 
                    raise AssertionError('name %r already in parent'
1756
 
                        % (name_unicode,))
 
1473
                assert file_id not in inv_byid
 
1474
                assert name_unicode not in parent_ie.children
1757
1475
                inv_byid[file_id] = inv_entry
1758
1476
                parent_ie.children[name_unicode] = inv_entry
1759
1477
        self._inventory = inv
1769
1487
            return None
1770
1488
        parent_index = self._get_parent_index()
1771
1489
        last_changed_revision = entry[1][parent_index][4]
1772
 
        try:
1773
 
            rev = self._repository.get_revision(last_changed_revision)
1774
 
        except errors.NoSuchRevision:
1775
 
            raise errors.FileTimestampUnavailable(self.id2path(file_id))
1776
 
        return rev.timestamp
 
1490
        return self._repository.get_revision(last_changed_revision).timestamp
1777
1491
 
1778
1492
    def get_file_sha1(self, file_id, path=None, stat_value=None):
1779
1493
        entry = self._get_entry(file_id=file_id, path=path)
1783
1497
            return parent_details[1]
1784
1498
        return None
1785
1499
 
1786
 
    def get_file(self, file_id, path=None):
 
1500
    @symbol_versioning.deprecated_method(symbol_versioning.zero_ninety)
 
1501
    def get_weave(self, file_id):
 
1502
        return self._get_weave(file_id)
 
1503
 
 
1504
    def _get_weave(self, file_id):
 
1505
        return self._repository.weave_store.get_weave(file_id,
 
1506
                self._repository.get_transaction())
 
1507
 
 
1508
    def get_file(self, file_id):
1787
1509
        return StringIO(self.get_file_text(file_id))
1788
1510
 
 
1511
    def get_file_lines(self, file_id):
 
1512
        ie = self.inventory[file_id]
 
1513
        return self._get_weave(file_id).get_lines(ie.revision)
 
1514
 
1789
1515
    def get_file_size(self, file_id):
1790
 
        """See Tree.get_file_size"""
1791
1516
        return self.inventory[file_id].text_size
1792
1517
 
1793
 
    def get_file_text(self, file_id, path=None):
1794
 
        _, content = list(self.iter_files_bytes([(file_id, None)]))[0]
1795
 
        return ''.join(content)
 
1518
    def get_file_text(self, file_id):
 
1519
        return ''.join(self.get_file_lines(file_id))
1796
1520
 
1797
1521
    def get_reference_revision(self, file_id, path=None):
1798
1522
        return self.inventory[file_id].reference_revision
1799
1523
 
1800
 
    def iter_files_bytes(self, desired_files):
1801
 
        """See Tree.iter_files_bytes.
1802
 
 
1803
 
        This version is implemented on top of Repository.iter_files_bytes"""
1804
 
        parent_index = self._get_parent_index()
1805
 
        repo_desired_files = []
1806
 
        for file_id, identifier in desired_files:
1807
 
            entry = self._get_entry(file_id)
1808
 
            if entry == (None, None):
1809
 
                raise errors.NoSuchId(self, file_id)
1810
 
            repo_desired_files.append((file_id, entry[1][parent_index][4],
1811
 
                                       identifier))
1812
 
        return self._repository.iter_files_bytes(repo_desired_files)
1813
 
 
1814
1524
    def get_symlink_target(self, file_id):
1815
1525
        entry = self._get_entry(file_id=file_id)
1816
1526
        parent_index = self._get_parent_index()
1817
1527
        if entry[1][parent_index][0] != 'l':
1818
1528
            return None
1819
1529
        else:
1820
 
            target = entry[1][parent_index][1]
1821
 
            target = target.decode('utf8')
1822
 
            return target
 
1530
            # At present, none of the tree implementations supports non-ascii
 
1531
            # symlink targets. So we will just assume that the dirstate path is
 
1532
            # correct.
 
1533
            return entry[1][parent_index][1]
1823
1534
 
1824
1535
    def get_revision_id(self):
1825
1536
        """Return the revision id for this tree."""
1843
1554
        return bool(self.path2id(filename))
1844
1555
 
1845
1556
    def kind(self, file_id):
1846
 
        entry = self._get_entry(file_id=file_id)[1]
1847
 
        if entry is None:
1848
 
            raise errors.NoSuchId(tree=self, file_id=file_id)
1849
 
        parent_index = self._get_parent_index()
1850
 
        return dirstate.DirState._minikind_to_kind[entry[parent_index][0]]
1851
 
 
1852
 
    def stored_kind(self, file_id):
1853
 
        """See Tree.stored_kind"""
1854
 
        return self.kind(file_id)
1855
 
 
1856
 
    def path_content_summary(self, path):
1857
 
        """See Tree.path_content_summary."""
1858
 
        id = self.inventory.path2id(path)
1859
 
        if id is None:
1860
 
            return ('missing', None, None, None)
1861
 
        entry = self._inventory[id]
1862
 
        kind = entry.kind
1863
 
        if kind == 'file':
1864
 
            return (kind, entry.text_size, entry.executable, entry.text_sha1)
1865
 
        elif kind == 'symlink':
1866
 
            return (kind, None, None, entry.symlink_target)
1867
 
        else:
1868
 
            return (kind, None, None, None)
 
1557
        return self.inventory[file_id].kind
1869
1558
 
1870
1559
    def is_executable(self, file_id, path=None):
1871
1560
        ie = self.inventory[file_id]
1873
1562
            return None
1874
1563
        return ie.executable
1875
1564
 
1876
 
    def is_locked(self):
1877
 
        return self._locked
1878
 
 
1879
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
 
1565
    def list_files(self, include_root=False):
1880
1566
        # We use a standard implementation, because DirStateRevisionTree is
1881
1567
        # dealing with one of the parents of the current state
1882
1568
        inv = self._get_inventory()
1883
 
        if from_dir is None:
1884
 
            from_dir_id = None
1885
 
        else:
1886
 
            from_dir_id = inv.path2id(from_dir)
1887
 
            if from_dir_id is None:
1888
 
                # Directory not versioned
1889
 
                return
1890
 
        entries = inv.iter_entries(from_dir=from_dir_id, recursive=recursive)
1891
 
        if inv.root is not None and not include_root and from_dir is None:
 
1569
        entries = inv.iter_entries()
 
1570
        if self.inventory.root is not None and not include_root:
1892
1571
            entries.next()
1893
1572
        for path, entry in entries:
1894
1573
            yield path, 'V', entry.kind, entry.file_id, entry
1895
1574
 
1896
1575
    def lock_read(self):
1897
 
        """Lock the tree for a set of operations.
1898
 
 
1899
 
        :return: An object with an unlock method which will release the lock
1900
 
            obtained.
1901
 
        """
 
1576
        """Lock the tree for a set of operations."""
1902
1577
        if not self._locked:
1903
1578
            self._repository.lock_read()
1904
1579
            if self._dirstate._lock_token is None:
1905
1580
                self._dirstate.lock_read()
1906
1581
                self._dirstate_locked = True
1907
1582
        self._locked += 1
1908
 
        return self
1909
1583
 
1910
1584
    def _must_be_locked(self):
1911
1585
        if not self._locked:
1932
1606
                self._dirstate_locked = False
1933
1607
            self._repository.unlock()
1934
1608
 
1935
 
    @needs_read_lock
1936
 
    def supports_tree_reference(self):
1937
 
        return self._repo_supports_tree_reference
1938
 
 
1939
1609
    def walkdirs(self, prefix=""):
1940
1610
        # TODO: jam 20070215 This is the lazy way by using the RevisionTree
1941
 
        # implementation based on an inventory.
 
1611
        # implementation based on an inventory.  
1942
1612
        # This should be cleaned up to use the much faster Dirstate code
1943
1613
        # So for now, we just build up the parent inventory, and extract
1944
1614
        # it the same way RevisionTree does.
1973
1643
 
1974
1644
class InterDirStateTree(InterTree):
1975
1645
    """Fast path optimiser for changes_from with dirstate trees.
1976
 
 
1977
 
    This is used only when both trees are in the dirstate working file, and
1978
 
    the source is any parent within the dirstate, and the destination is
 
1646
    
 
1647
    This is used only when both trees are in the dirstate working file, and 
 
1648
    the source is any parent within the dirstate, and the destination is 
1979
1649
    the current working tree of the same dirstate.
1980
1650
    """
1981
1651
    # this could be generalized to allow comparisons between any trees in the
1994
1664
        target.set_parent_ids([revid])
1995
1665
        return target.basis_tree(), target
1996
1666
 
1997
 
    @classmethod
1998
 
    def make_source_parent_tree_python_dirstate(klass, test_case, source, target):
1999
 
        result = klass.make_source_parent_tree(source, target)
2000
 
        result[1]._iter_changes = dirstate.ProcessEntryPython
2001
 
        return result
2002
 
 
2003
 
    @classmethod
2004
 
    def make_source_parent_tree_compiled_dirstate(klass, test_case, source,
2005
 
                                                  target):
2006
 
        from bzrlib.tests.test__dirstate_helpers import \
2007
 
            compiled_dirstate_helpers_feature
2008
 
        test_case.requireFeature(compiled_dirstate_helpers_feature)
2009
 
        from bzrlib._dirstate_helpers_pyx import ProcessEntryC
2010
 
        result = klass.make_source_parent_tree(source, target)
2011
 
        result[1]._iter_changes = ProcessEntryC
2012
 
        return result
2013
 
 
2014
1667
    _matching_from_tree_format = WorkingTreeFormat4()
2015
1668
    _matching_to_tree_format = WorkingTreeFormat4()
2016
 
 
2017
 
    @classmethod
2018
 
    def _test_mutable_trees_to_test_trees(klass, test_case, source, target):
2019
 
        # This method shouldn't be called, because we have python and C
2020
 
        # specific flavours.
2021
 
        raise NotImplementedError
2022
 
 
2023
 
    def iter_changes(self, include_unchanged=False,
 
1669
    _test_mutable_trees_to_test_trees = make_source_parent_tree
 
1670
 
 
1671
    def _iter_changes(self, include_unchanged=False,
2024
1672
                      specific_files=None, pb=None, extra_trees=[],
2025
1673
                      require_versioned=True, want_unversioned=False):
2026
1674
        """Return the changes from source to target.
2027
1675
 
2028
 
        :return: An iterator that yields tuples. See InterTree.iter_changes
 
1676
        :return: An iterator that yields tuples. See InterTree._iter_changes
2029
1677
            for details.
2030
1678
        :param specific_files: An optional list of file paths to restrict the
2031
1679
            comparison to. When mapping filenames to ids, all matches in all
2042
1690
            output. An unversioned file is defined as one with (False, False)
2043
1691
            for the versioned pair.
2044
1692
        """
 
1693
        utf8_decode = cache_utf8._utf8_decode
 
1694
        _minikind_to_kind = dirstate.DirState._minikind_to_kind
 
1695
        cmp_by_dirs = dirstate.cmp_by_dirs
 
1696
        # NB: show_status depends on being able to pass in non-versioned files
 
1697
        # and report them as unknown
2045
1698
        # TODO: handle extra trees in the dirstate.
2046
 
        if (extra_trees or specific_files == []):
 
1699
        # TODO: handle comparisons as an empty tree as a different special
 
1700
        # case? mbp 20070226
 
1701
        if extra_trees or (self.source._revision_id == NULL_REVISION):
2047
1702
            # we can't fast-path these cases (yet)
2048
 
            return super(InterDirStateTree, self).iter_changes(
 
1703
            for f in super(InterDirStateTree, self)._iter_changes(
2049
1704
                include_unchanged, specific_files, pb, extra_trees,
2050
 
                require_versioned, want_unversioned=want_unversioned)
 
1705
                require_versioned, want_unversioned=want_unversioned):
 
1706
                yield f
 
1707
            return
2051
1708
        parent_ids = self.target.get_parent_ids()
2052
 
        if not (self.source._revision_id in parent_ids
2053
 
                or self.source._revision_id == _mod_revision.NULL_REVISION):
2054
 
            raise AssertionError(
2055
 
                "revision {%s} is not stored in {%s}, but %s "
2056
 
                "can only be used for trees stored in the dirstate"
2057
 
                % (self.source._revision_id, self.target, self.iter_changes))
 
1709
        assert (self.source._revision_id in parent_ids), \
 
1710
                "revision {%s} is not stored in {%s}, but %s " \
 
1711
                "can only be used for trees stored in the dirstate" \
 
1712
                % (self.source._revision_id, self.target, self._iter_changes)
2058
1713
        target_index = 0
2059
 
        if self.source._revision_id == _mod_revision.NULL_REVISION:
 
1714
        if self.source._revision_id == NULL_REVISION:
2060
1715
            source_index = None
2061
1716
            indices = (target_index,)
2062
1717
        else:
2063
 
            if not (self.source._revision_id in parent_ids):
2064
 
                raise AssertionError(
2065
 
                    "Failure: source._revision_id: %s not in target.parent_ids(%s)" % (
2066
 
                    self.source._revision_id, parent_ids))
 
1718
            assert (self.source._revision_id in parent_ids), \
 
1719
                "Failure: source._revision_id: %s not in target.parent_ids(%s)" % (
 
1720
                self.source._revision_id, parent_ids)
2067
1721
            source_index = 1 + parent_ids.index(self.source._revision_id)
2068
 
            indices = (source_index, target_index)
 
1722
            indices = (source_index,target_index)
2069
1723
        # -- make all specific_files utf8 --
2070
1724
        if specific_files:
2071
1725
            specific_files_utf8 = set()
2072
1726
            for path in specific_files:
2073
 
                # Note, if there are many specific files, using cache_utf8
2074
 
                # would be good here.
2075
1727
                specific_files_utf8.add(path.encode('utf8'))
2076
1728
            specific_files = specific_files_utf8
2077
1729
        else:
2078
1730
            specific_files = set([''])
2079
1731
        # -- specific_files is now a utf8 path set --
2080
 
 
2081
1732
        # -- get the state object and prepare it.
2082
1733
        state = self.target.current_dirstate()
2083
1734
        state._read_dirblocks_if_needed()
 
1735
        def _entries_for_path(path):
 
1736
            """Return a list with all the entries that match path for all ids.
 
1737
            """
 
1738
            dirname, basename = os.path.split(path)
 
1739
            key = (dirname, basename, '')
 
1740
            block_index, present = state._find_block_index_from_key(key)
 
1741
            if not present:
 
1742
                # the block which should contain path is absent.
 
1743
                return []
 
1744
            result = []
 
1745
            block = state._dirblocks[block_index][1]
 
1746
            entry_index, _ = state._find_entry_index(key, block)
 
1747
            # we may need to look at multiple entries at this path: walk while the specific_files match.
 
1748
            while (entry_index < len(block) and
 
1749
                block[entry_index][0][0:2] == key[0:2]):
 
1750
                result.append(block[entry_index])
 
1751
                entry_index += 1
 
1752
            return result
2084
1753
        if require_versioned:
2085
1754
            # -- check all supplied paths are versioned in a search tree. --
2086
 
            not_versioned = []
 
1755
            all_versioned = True
2087
1756
            for path in specific_files:
2088
 
                path_entries = state._entries_for_path(path)
 
1757
                path_entries = _entries_for_path(path)
2089
1758
                if not path_entries:
2090
1759
                    # this specified path is not present at all: error
2091
 
                    not_versioned.append(path)
2092
 
                    continue
 
1760
                    all_versioned = False
 
1761
                    break
2093
1762
                found_versioned = False
2094
1763
                # for each id at this path
2095
1764
                for entry in path_entries:
2102
1771
                if not found_versioned:
2103
1772
                    # none of the indexes was not 'absent' at all ids for this
2104
1773
                    # path.
2105
 
                    not_versioned.append(path)
2106
 
            if len(not_versioned) > 0:
2107
 
                raise errors.PathsNotVersionedError(not_versioned)
 
1774
                    all_versioned = False
 
1775
                    break
 
1776
            if not all_versioned:
 
1777
                raise errors.PathsNotVersionedError(specific_files)
2108
1778
        # -- remove redundancy in supplied specific_files to prevent over-scanning --
2109
 
        search_specific_files = osutils.minimum_path_selection(specific_files)
 
1779
        search_specific_files = set()
 
1780
        for path in specific_files:
 
1781
            other_specific_files = specific_files.difference(set([path]))
 
1782
            if not osutils.is_inside_any(other_specific_files, path):
 
1783
                # this is a top level path, we must check it.
 
1784
                search_specific_files.add(path)
 
1785
        # sketch: 
 
1786
        # compare source_index and target_index at or under each element of search_specific_files.
 
1787
        # follow the following comparison table. Note that we only want to do diff operations when
 
1788
        # the target is fdl because thats when the walkdirs logic will have exposed the pathinfo 
 
1789
        # for the target.
 
1790
        # cases:
 
1791
        # 
 
1792
        # Source | Target | disk | action
 
1793
        #   r    | fdlt   |      | add source to search, add id path move and perform
 
1794
        #        |        |      | diff check on source-target
 
1795
        #   r    | fdlt   |  a   | dangling file that was present in the basis. 
 
1796
        #        |        |      | ???
 
1797
        #   r    |  a     |      | add source to search
 
1798
        #   r    |  a     |  a   | 
 
1799
        #   r    |  r     |      | this path is present in a non-examined tree, skip.
 
1800
        #   r    |  r     |  a   | this path is present in a non-examined tree, skip.
 
1801
        #   a    | fdlt   |      | add new id
 
1802
        #   a    | fdlt   |  a   | dangling locally added file, skip
 
1803
        #   a    |  a     |      | not present in either tree, skip
 
1804
        #   a    |  a     |  a   | not present in any tree, skip
 
1805
        #   a    |  r     |      | not present in either tree at this path, skip as it
 
1806
        #        |        |      | may not be selected by the users list of paths.
 
1807
        #   a    |  r     |  a   | not present in either tree at this path, skip as it
 
1808
        #        |        |      | may not be selected by the users list of paths.
 
1809
        #  fdlt  | fdlt   |      | content in both: diff them
 
1810
        #  fdlt  | fdlt   |  a   | deleted locally, but not unversioned - show as deleted ?
 
1811
        #  fdlt  |  a     |      | unversioned: output deleted id for now
 
1812
        #  fdlt  |  a     |  a   | unversioned and deleted: output deleted id
 
1813
        #  fdlt  |  r     |      | relocated in this tree, so add target to search.
 
1814
        #        |        |      | Dont diff, we will see an r,fd; pair when we reach
 
1815
        #        |        |      | this id at the other path.
 
1816
        #  fdlt  |  r     |  a   | relocated in this tree, so add target to search.
 
1817
        #        |        |      | Dont diff, we will see an r,fd; pair when we reach
 
1818
        #        |        |      | this id at the other path.
 
1819
 
 
1820
        # for all search_indexs in each path at or under each element of
 
1821
        # search_specific_files, if the detail is relocated: add the id, and add the
 
1822
        # relocated path as one to search if its not searched already. If the
 
1823
        # detail is not relocated, add the id.
 
1824
        searched_specific_files = set()
 
1825
        NULL_PARENT_DETAILS = dirstate.DirState.NULL_PARENT_DETAILS
 
1826
        # Using a list so that we can access the values and change them in
 
1827
        # nested scope. Each one is [path, file_id, entry]
 
1828
        last_source_parent = [None, None]
 
1829
        last_target_parent = [None, None]
2110
1830
 
2111
1831
        use_filesystem_for_exec = (sys.platform != 'win32')
2112
 
        iter_changes = self.target._iter_changes(include_unchanged,
2113
 
            use_filesystem_for_exec, search_specific_files, state,
2114
 
            source_index, target_index, want_unversioned, self.target)
2115
 
        return iter_changes.iter_changes()
 
1832
 
 
1833
        # Just a sentry, so that _process_entry can say that this
 
1834
        # record is handled, but isn't interesting to process (unchanged)
 
1835
        uninteresting = object()
 
1836
 
 
1837
 
 
1838
        old_dirname_to_file_id = {}
 
1839
        new_dirname_to_file_id = {}
 
1840
        # TODO: jam 20070516 - Avoid the _get_entry lookup overhead by
 
1841
        #       keeping a cache of directories that we have seen.
 
1842
 
 
1843
        def _process_entry(entry, path_info):
 
1844
            """Compare an entry and real disk to generate delta information.
 
1845
 
 
1846
            :param path_info: top_relpath, basename, kind, lstat, abspath for
 
1847
                the path of entry. If None, then the path is considered absent.
 
1848
                (Perhaps we should pass in a concrete entry for this ?)
 
1849
                Basename is returned as a utf8 string because we expect this
 
1850
                tuple will be ignored, and don't want to take the time to
 
1851
                decode.
 
1852
            :return: None if these don't match
 
1853
                     A tuple of information about the change, or
 
1854
                     the object 'uninteresting' if these match, but are
 
1855
                     basically identical.
 
1856
            """
 
1857
            if source_index is None:
 
1858
                source_details = NULL_PARENT_DETAILS
 
1859
            else:
 
1860
                source_details = entry[1][source_index]
 
1861
            target_details = entry[1][target_index]
 
1862
            target_minikind = target_details[0]
 
1863
            if path_info is not None and target_minikind in 'fdlt':
 
1864
                assert target_index == 0
 
1865
                link_or_sha1 = state.update_entry(entry, abspath=path_info[4],
 
1866
                                                  stat_value=path_info[3])
 
1867
                # The entry may have been modified by update_entry
 
1868
                target_details = entry[1][target_index]
 
1869
                target_minikind = target_details[0]
 
1870
            else:
 
1871
                link_or_sha1 = None
 
1872
            file_id = entry[0][2]
 
1873
            source_minikind = source_details[0]
 
1874
            if source_minikind in 'fdltr' and target_minikind in 'fdlt':
 
1875
                # claimed content in both: diff
 
1876
                #   r    | fdlt   |      | add source to search, add id path move and perform
 
1877
                #        |        |      | diff check on source-target
 
1878
                #   r    | fdlt   |  a   | dangling file that was present in the basis.
 
1879
                #        |        |      | ???
 
1880
                if source_minikind in 'r':
 
1881
                    # add the source to the search path to find any children it
 
1882
                    # has.  TODO ? : only add if it is a container ?
 
1883
                    if not osutils.is_inside_any(searched_specific_files,
 
1884
                                                 source_details[1]):
 
1885
                        search_specific_files.add(source_details[1])
 
1886
                    # generate the old path; this is needed for stating later
 
1887
                    # as well.
 
1888
                    old_path = source_details[1]
 
1889
                    old_dirname, old_basename = os.path.split(old_path)
 
1890
                    path = pathjoin(entry[0][0], entry[0][1])
 
1891
                    old_entry = state._get_entry(source_index,
 
1892
                                                 path_utf8=old_path)
 
1893
                    # update the source details variable to be the real
 
1894
                    # location.
 
1895
                    source_details = old_entry[1][source_index]
 
1896
                    source_minikind = source_details[0]
 
1897
                else:
 
1898
                    old_dirname = entry[0][0]
 
1899
                    old_basename = entry[0][1]
 
1900
                    old_path = path = None
 
1901
                if path_info is None:
 
1902
                    # the file is missing on disk, show as removed.
 
1903
                    content_change = True
 
1904
                    target_kind = None
 
1905
                    target_exec = False
 
1906
                else:
 
1907
                    # source and target are both versioned and disk file is present.
 
1908
                    target_kind = path_info[2]
 
1909
                    if target_kind == 'directory':
 
1910
                        if path is None:
 
1911
                            old_path = path = pathjoin(old_dirname, old_basename)
 
1912
                        new_dirname_to_file_id[path] = file_id
 
1913
                        if source_minikind != 'd':
 
1914
                            content_change = True
 
1915
                        else:
 
1916
                            # directories have no fingerprint
 
1917
                            content_change = False
 
1918
                        target_exec = False
 
1919
                    elif target_kind == 'file':
 
1920
                        if source_minikind != 'f':
 
1921
                            content_change = True
 
1922
                        else:
 
1923
                            # We could check the size, but we already have the
 
1924
                            # sha1 hash.
 
1925
                            content_change = (link_or_sha1 != source_details[1])
 
1926
                        # Target details is updated at update_entry time
 
1927
                        if use_filesystem_for_exec:
 
1928
                            # We don't need S_ISREG here, because we are sure
 
1929
                            # we are dealing with a file.
 
1930
                            target_exec = bool(stat.S_IEXEC & path_info[3].st_mode)
 
1931
                        else:
 
1932
                            target_exec = target_details[3]
 
1933
                    elif target_kind == 'symlink':
 
1934
                        if source_minikind != 'l':
 
1935
                            content_change = True
 
1936
                        else:
 
1937
                            content_change = (link_or_sha1 != source_details[1])
 
1938
                        target_exec = False
 
1939
                    elif target_kind == 'tree-reference':
 
1940
                        if source_minikind != 't':
 
1941
                            content_change = True
 
1942
                        else:
 
1943
                            content_change = False
 
1944
                        target_exec = False
 
1945
                    else:
 
1946
                        raise Exception, "unknown kind %s" % path_info[2]
 
1947
                if source_minikind == 'd':
 
1948
                    if path is None:
 
1949
                        old_path = path = pathjoin(old_dirname, old_basename)
 
1950
                    old_dirname_to_file_id[old_path] = file_id
 
1951
                # parent id is the entry for the path in the target tree
 
1952
                if old_dirname == last_source_parent[0]:
 
1953
                    source_parent_id = last_source_parent[1]
 
1954
                else:
 
1955
                    try:
 
1956
                        source_parent_id = old_dirname_to_file_id[old_dirname]
 
1957
                    except KeyError:
 
1958
                        source_parent_entry = state._get_entry(source_index,
 
1959
                                                               path_utf8=old_dirname)
 
1960
                        source_parent_id = source_parent_entry[0][2]
 
1961
                    if source_parent_id == entry[0][2]:
 
1962
                        # This is the root, so the parent is None
 
1963
                        source_parent_id = None
 
1964
                    else:
 
1965
                        last_source_parent[0] = old_dirname
 
1966
                        last_source_parent[1] = source_parent_id
 
1967
                new_dirname = entry[0][0]
 
1968
                if new_dirname == last_target_parent[0]:
 
1969
                    target_parent_id = last_target_parent[1]
 
1970
                else:
 
1971
                    try:
 
1972
                        target_parent_id = new_dirname_to_file_id[new_dirname]
 
1973
                    except KeyError:
 
1974
                        # TODO: We don't always need to do the lookup, because the
 
1975
                        #       parent entry will be the same as the source entry.
 
1976
                        target_parent_entry = state._get_entry(target_index,
 
1977
                                                               path_utf8=new_dirname)
 
1978
                        assert target_parent_entry != (None, None), (
 
1979
                            "Could not find target parent in wt: %s\nparent of: %s"
 
1980
                            % (new_dirname, entry))
 
1981
                        target_parent_id = target_parent_entry[0][2]
 
1982
                    if target_parent_id == entry[0][2]:
 
1983
                        # This is the root, so the parent is None
 
1984
                        target_parent_id = None
 
1985
                    else:
 
1986
                        last_target_parent[0] = new_dirname
 
1987
                        last_target_parent[1] = target_parent_id
 
1988
 
 
1989
                source_exec = source_details[3]
 
1990
                if (include_unchanged
 
1991
                    or content_change
 
1992
                    or source_parent_id != target_parent_id
 
1993
                    or old_basename != entry[0][1]
 
1994
                    or source_exec != target_exec
 
1995
                    ):
 
1996
                    if old_path is None:
 
1997
                        old_path = path = pathjoin(old_dirname, old_basename)
 
1998
                        old_path_u = utf8_decode(old_path)[0]
 
1999
                        path_u = old_path_u
 
2000
                    else:
 
2001
                        old_path_u = utf8_decode(old_path)[0]
 
2002
                        if old_path == path:
 
2003
                            path_u = old_path_u
 
2004
                        else:
 
2005
                            path_u = utf8_decode(path)[0]
 
2006
                    source_kind = _minikind_to_kind[source_minikind]
 
2007
                    return (entry[0][2],
 
2008
                           (old_path_u, path_u),
 
2009
                           content_change,
 
2010
                           (True, True),
 
2011
                           (source_parent_id, target_parent_id),
 
2012
                           (utf8_decode(old_basename)[0], utf8_decode(entry[0][1])[0]),
 
2013
                           (source_kind, target_kind),
 
2014
                           (source_exec, target_exec))
 
2015
                else:
 
2016
                    return uninteresting
 
2017
            elif source_minikind in 'a' and target_minikind in 'fdlt':
 
2018
                # looks like a new file
 
2019
                if path_info is not None:
 
2020
                    path = pathjoin(entry[0][0], entry[0][1])
 
2021
                    # parent id is the entry for the path in the target tree
 
2022
                    # TODO: these are the same for an entire directory: cache em.
 
2023
                    parent_id = state._get_entry(target_index,
 
2024
                                                 path_utf8=entry[0][0])[0][2]
 
2025
                    if parent_id == entry[0][2]:
 
2026
                        parent_id = None
 
2027
                    if use_filesystem_for_exec:
 
2028
                        # We need S_ISREG here, because we aren't sure if this
 
2029
                        # is a file or not.
 
2030
                        target_exec = bool(
 
2031
                            stat.S_ISREG(path_info[3].st_mode)
 
2032
                            and stat.S_IEXEC & path_info[3].st_mode)
 
2033
                    else:
 
2034
                        target_exec = target_details[3]
 
2035
                    return (entry[0][2],
 
2036
                           (None, utf8_decode(path)[0]),
 
2037
                           True,
 
2038
                           (False, True),
 
2039
                           (None, parent_id),
 
2040
                           (None, utf8_decode(entry[0][1])[0]),
 
2041
                           (None, path_info[2]),
 
2042
                           (None, target_exec))
 
2043
                else:
 
2044
                    # but its not on disk: we deliberately treat this as just
 
2045
                    # never-present. (Why ?! - RBC 20070224)
 
2046
                    pass
 
2047
            elif source_minikind in 'fdlt' and target_minikind in 'a':
 
2048
                # unversioned, possibly, or possibly not deleted: we dont care.
 
2049
                # if its still on disk, *and* theres no other entry at this
 
2050
                # path [we dont know this in this routine at the moment -
 
2051
                # perhaps we should change this - then it would be an unknown.
 
2052
                old_path = pathjoin(entry[0][0], entry[0][1])
 
2053
                # parent id is the entry for the path in the target tree
 
2054
                parent_id = state._get_entry(source_index, path_utf8=entry[0][0])[0][2]
 
2055
                if parent_id == entry[0][2]:
 
2056
                    parent_id = None
 
2057
                return (entry[0][2],
 
2058
                       (utf8_decode(old_path)[0], None),
 
2059
                       True,
 
2060
                       (True, False),
 
2061
                       (parent_id, None),
 
2062
                       (utf8_decode(entry[0][1])[0], None),
 
2063
                       (_minikind_to_kind[source_minikind], None),
 
2064
                       (source_details[3], None))
 
2065
            elif source_minikind in 'fdlt' and target_minikind in 'r':
 
2066
                # a rename; could be a true rename, or a rename inherited from
 
2067
                # a renamed parent. TODO: handle this efficiently. Its not
 
2068
                # common case to rename dirs though, so a correct but slow
 
2069
                # implementation will do.
 
2070
                if not osutils.is_inside_any(searched_specific_files, target_details[1]):
 
2071
                    search_specific_files.add(target_details[1])
 
2072
            elif source_minikind in 'ra' and target_minikind in 'ra':
 
2073
                # neither of the selected trees contain this file,
 
2074
                # so skip over it. This is not currently directly tested, but
 
2075
                # is indirectly via test_too_much.TestCommands.test_conflicts.
 
2076
                pass
 
2077
            else:
 
2078
                raise AssertionError("don't know how to compare "
 
2079
                    "source_minikind=%r, target_minikind=%r"
 
2080
                    % (source_minikind, target_minikind))
 
2081
                ## import pdb;pdb.set_trace()
 
2082
            return None
 
2083
 
 
2084
        while search_specific_files:
 
2085
            # TODO: the pending list should be lexically sorted?  the
 
2086
            # interface doesn't require it.
 
2087
            current_root = search_specific_files.pop()
 
2088
            current_root_unicode = current_root.decode('utf8')
 
2089
            searched_specific_files.add(current_root)
 
2090
            # process the entries for this containing directory: the rest will be
 
2091
            # found by their parents recursively.
 
2092
            root_entries = _entries_for_path(current_root)
 
2093
            root_abspath = self.target.abspath(current_root_unicode)
 
2094
            try:
 
2095
                root_stat = os.lstat(root_abspath)
 
2096
            except OSError, e:
 
2097
                if e.errno == errno.ENOENT:
 
2098
                    # the path does not exist: let _process_entry know that.
 
2099
                    root_dir_info = None
 
2100
                else:
 
2101
                    # some other random error: hand it up.
 
2102
                    raise
 
2103
            else:
 
2104
                root_dir_info = ('', current_root,
 
2105
                    osutils.file_kind_from_stat_mode(root_stat.st_mode), root_stat,
 
2106
                    root_abspath)
 
2107
                if root_dir_info[2] == 'directory':
 
2108
                    if self.target._directory_is_tree_reference(
 
2109
                        current_root.decode('utf8')):
 
2110
                        root_dir_info = root_dir_info[:2] + \
 
2111
                            ('tree-reference',) + root_dir_info[3:]
 
2112
 
 
2113
            if not root_entries and not root_dir_info:
 
2114
                # this specified path is not present at all, skip it.
 
2115
                continue
 
2116
            path_handled = False
 
2117
            for entry in root_entries:
 
2118
                result = _process_entry(entry, root_dir_info)
 
2119
                if result is not None:
 
2120
                    path_handled = True
 
2121
                    if result is not uninteresting:
 
2122
                        yield result
 
2123
            if want_unversioned and not path_handled and root_dir_info:
 
2124
                new_executable = bool(
 
2125
                    stat.S_ISREG(root_dir_info[3].st_mode)
 
2126
                    and stat.S_IEXEC & root_dir_info[3].st_mode)
 
2127
                yield (None,
 
2128
                       (None, current_root_unicode),
 
2129
                       True,
 
2130
                       (False, False),
 
2131
                       (None, None),
 
2132
                       (None, splitpath(current_root_unicode)[-1]),
 
2133
                       (None, root_dir_info[2]),
 
2134
                       (None, new_executable)
 
2135
                      )
 
2136
            initial_key = (current_root, '', '')
 
2137
            block_index, _ = state._find_block_index_from_key(initial_key)
 
2138
            if block_index == 0:
 
2139
                # we have processed the total root already, but because the
 
2140
                # initial key matched it we should skip it here.
 
2141
                block_index +=1
 
2142
            if root_dir_info and root_dir_info[2] == 'tree-reference':
 
2143
                current_dir_info = None
 
2144
            else:
 
2145
                dir_iterator = osutils._walkdirs_utf8(root_abspath, prefix=current_root)
 
2146
                try:
 
2147
                    current_dir_info = dir_iterator.next()
 
2148
                except OSError, e:
 
2149
                    # on win32, python2.4 has e.errno == ERROR_DIRECTORY, but
 
2150
                    # python 2.5 has e.errno == EINVAL,
 
2151
                    #            and e.winerror == ERROR_DIRECTORY
 
2152
                    e_winerror = getattr(e, 'winerror', None)
 
2153
                    win_errors = (ERROR_DIRECTORY, ERROR_PATH_NOT_FOUND)
 
2154
                    # there may be directories in the inventory even though
 
2155
                    # this path is not a file on disk: so mark it as end of
 
2156
                    # iterator
 
2157
                    if e.errno in (errno.ENOENT, errno.ENOTDIR, errno.EINVAL):
 
2158
                        current_dir_info = None
 
2159
                    elif (sys.platform == 'win32'
 
2160
                          and (e.errno in win_errors
 
2161
                               or e_winerror in win_errors)):
 
2162
                        current_dir_info = None
 
2163
                    else:
 
2164
                        raise
 
2165
                else:
 
2166
                    if current_dir_info[0][0] == '':
 
2167
                        # remove .bzr from iteration
 
2168
                        bzr_index = bisect_left(current_dir_info[1], ('.bzr',))
 
2169
                        assert current_dir_info[1][bzr_index][0] == '.bzr'
 
2170
                        del current_dir_info[1][bzr_index]
 
2171
            # walk until both the directory listing and the versioned metadata
 
2172
            # are exhausted. 
 
2173
            if (block_index < len(state._dirblocks) and
 
2174
                osutils.is_inside(current_root, state._dirblocks[block_index][0])):
 
2175
                current_block = state._dirblocks[block_index]
 
2176
            else:
 
2177
                current_block = None
 
2178
            while (current_dir_info is not None or
 
2179
                   current_block is not None):
 
2180
                if (current_dir_info and current_block
 
2181
                    and current_dir_info[0][0] != current_block[0]):
 
2182
                    if cmp_by_dirs(current_dir_info[0][0], current_block[0]) < 0:
 
2183
                        # filesystem data refers to paths not covered by the dirblock.
 
2184
                        # this has two possibilities:
 
2185
                        # A) it is versioned but empty, so there is no block for it
 
2186
                        # B) it is not versioned.
 
2187
 
 
2188
                        # if (A) then we need to recurse into it to check for
 
2189
                        # new unknown files or directories.
 
2190
                        # if (B) then we should ignore it, because we don't
 
2191
                        # recurse into unknown directories.
 
2192
                        path_index = 0
 
2193
                        while path_index < len(current_dir_info[1]):
 
2194
                                current_path_info = current_dir_info[1][path_index]
 
2195
                                if want_unversioned:
 
2196
                                    if current_path_info[2] == 'directory':
 
2197
                                        if self.target._directory_is_tree_reference(
 
2198
                                            current_path_info[0].decode('utf8')):
 
2199
                                            current_path_info = current_path_info[:2] + \
 
2200
                                                ('tree-reference',) + current_path_info[3:]
 
2201
                                    new_executable = bool(
 
2202
                                        stat.S_ISREG(current_path_info[3].st_mode)
 
2203
                                        and stat.S_IEXEC & current_path_info[3].st_mode)
 
2204
                                    yield (None,
 
2205
                                        (None, utf8_decode(current_path_info[0])[0]),
 
2206
                                        True,
 
2207
                                        (False, False),
 
2208
                                        (None, None),
 
2209
                                        (None, utf8_decode(current_path_info[1])[0]),
 
2210
                                        (None, current_path_info[2]),
 
2211
                                        (None, new_executable))
 
2212
                                # dont descend into this unversioned path if it is
 
2213
                                # a dir
 
2214
                                if current_path_info[2] in ('directory',
 
2215
                                                            'tree-reference'):
 
2216
                                    del current_dir_info[1][path_index]
 
2217
                                    path_index -= 1
 
2218
                                path_index += 1
 
2219
 
 
2220
                        # This dir info has been handled, go to the next
 
2221
                        try:
 
2222
                            current_dir_info = dir_iterator.next()
 
2223
                        except StopIteration:
 
2224
                            current_dir_info = None
 
2225
                    else:
 
2226
                        # We have a dirblock entry for this location, but there
 
2227
                        # is no filesystem path for this. This is most likely
 
2228
                        # because a directory was removed from the disk.
 
2229
                        # We don't have to report the missing directory,
 
2230
                        # because that should have already been handled, but we
 
2231
                        # need to handle all of the files that are contained
 
2232
                        # within.
 
2233
                        for current_entry in current_block[1]:
 
2234
                            # entry referring to file not present on disk.
 
2235
                            # advance the entry only, after processing.
 
2236
                            result = _process_entry(current_entry, None)
 
2237
                            if result is not None:
 
2238
                                if result is not uninteresting:
 
2239
                                    yield result
 
2240
                        block_index +=1
 
2241
                        if (block_index < len(state._dirblocks) and
 
2242
                            osutils.is_inside(current_root,
 
2243
                                              state._dirblocks[block_index][0])):
 
2244
                            current_block = state._dirblocks[block_index]
 
2245
                        else:
 
2246
                            current_block = None
 
2247
                    continue
 
2248
                entry_index = 0
 
2249
                if current_block and entry_index < len(current_block[1]):
 
2250
                    current_entry = current_block[1][entry_index]
 
2251
                else:
 
2252
                    current_entry = None
 
2253
                advance_entry = True
 
2254
                path_index = 0
 
2255
                if current_dir_info and path_index < len(current_dir_info[1]):
 
2256
                    current_path_info = current_dir_info[1][path_index]
 
2257
                    if current_path_info[2] == 'directory':
 
2258
                        if self.target._directory_is_tree_reference(
 
2259
                            current_path_info[0].decode('utf8')):
 
2260
                            current_path_info = current_path_info[:2] + \
 
2261
                                ('tree-reference',) + current_path_info[3:]
 
2262
                else:
 
2263
                    current_path_info = None
 
2264
                advance_path = True
 
2265
                path_handled = False
 
2266
                while (current_entry is not None or
 
2267
                    current_path_info is not None):
 
2268
                    if current_entry is None:
 
2269
                        # the check for path_handled when the path is adnvaced
 
2270
                        # will yield this path if needed.
 
2271
                        pass
 
2272
                    elif current_path_info is None:
 
2273
                        # no path is fine: the per entry code will handle it.
 
2274
                        result = _process_entry(current_entry, current_path_info)
 
2275
                        if result is not None:
 
2276
                            if result is not uninteresting:
 
2277
                                yield result
 
2278
                    elif (current_entry[0][1] != current_path_info[1]
 
2279
                          or current_entry[1][target_index][0] in 'ar'):
 
2280
                        # The current path on disk doesn't match the dirblock
 
2281
                        # record. Either the dirblock is marked as absent, or
 
2282
                        # the file on disk is not present at all in the
 
2283
                        # dirblock. Either way, report about the dirblock
 
2284
                        # entry, and let other code handle the filesystem one.
 
2285
 
 
2286
                        # Compare the basename for these files to determine
 
2287
                        # which comes first
 
2288
                        if current_path_info[1] < current_entry[0][1]:
 
2289
                            # extra file on disk: pass for now, but only
 
2290
                            # increment the path, not the entry
 
2291
                            advance_entry = False
 
2292
                        else:
 
2293
                            # entry referring to file not present on disk.
 
2294
                            # advance the entry only, after processing.
 
2295
                            result = _process_entry(current_entry, None)
 
2296
                            if result is not None:
 
2297
                                if result is not uninteresting:
 
2298
                                    yield result
 
2299
                            advance_path = False
 
2300
                    else:
 
2301
                        result = _process_entry(current_entry, current_path_info)
 
2302
                        if result is not None:
 
2303
                            path_handled = True
 
2304
                            if result is not uninteresting:
 
2305
                                yield result
 
2306
                    if advance_entry and current_entry is not None:
 
2307
                        entry_index += 1
 
2308
                        if entry_index < len(current_block[1]):
 
2309
                            current_entry = current_block[1][entry_index]
 
2310
                        else:
 
2311
                            current_entry = None
 
2312
                    else:
 
2313
                        advance_entry = True # reset the advance flaga
 
2314
                    if advance_path and current_path_info is not None:
 
2315
                        if not path_handled:
 
2316
                            # unversioned in all regards
 
2317
                            if want_unversioned:
 
2318
                                new_executable = bool(
 
2319
                                    stat.S_ISREG(current_path_info[3].st_mode)
 
2320
                                    and stat.S_IEXEC & current_path_info[3].st_mode)
 
2321
                                yield (None,
 
2322
                                    (None, utf8_decode(current_path_info[0])[0]),
 
2323
                                    True,
 
2324
                                    (False, False),
 
2325
                                    (None, None),
 
2326
                                    (None, utf8_decode(current_path_info[1])[0]),
 
2327
                                    (None, current_path_info[2]),
 
2328
                                    (None, new_executable))
 
2329
                            # dont descend into this unversioned path if it is
 
2330
                            # a dir
 
2331
                            if current_path_info[2] in ('directory'):
 
2332
                                del current_dir_info[1][path_index]
 
2333
                                path_index -= 1
 
2334
                        # dont descend the disk iterator into any tree 
 
2335
                        # paths.
 
2336
                        if current_path_info[2] == 'tree-reference':
 
2337
                            del current_dir_info[1][path_index]
 
2338
                            path_index -= 1
 
2339
                        path_index += 1
 
2340
                        if path_index < len(current_dir_info[1]):
 
2341
                            current_path_info = current_dir_info[1][path_index]
 
2342
                            if current_path_info[2] == 'directory':
 
2343
                                if self.target._directory_is_tree_reference(
 
2344
                                    current_path_info[0].decode('utf8')):
 
2345
                                    current_path_info = current_path_info[:2] + \
 
2346
                                        ('tree-reference',) + current_path_info[3:]
 
2347
                        else:
 
2348
                            current_path_info = None
 
2349
                        path_handled = False
 
2350
                    else:
 
2351
                        advance_path = True # reset the advance flagg.
 
2352
                if current_block is not None:
 
2353
                    block_index += 1
 
2354
                    if (block_index < len(state._dirblocks) and
 
2355
                        osutils.is_inside(current_root, state._dirblocks[block_index][0])):
 
2356
                        current_block = state._dirblocks[block_index]
 
2357
                    else:
 
2358
                        current_block = None
 
2359
                if current_dir_info is not None:
 
2360
                    try:
 
2361
                        current_dir_info = dir_iterator.next()
 
2362
                    except StopIteration:
 
2363
                        current_dir_info = None
 
2364
 
2116
2365
 
2117
2366
    @staticmethod
2118
2367
    def is_compatible(source, target):
2119
2368
        # the target must be a dirstate working tree
2120
 
        if not isinstance(target, DirStateWorkingTree):
 
2369
        if not isinstance(target, WorkingTree4):
2121
2370
            return False
2122
 
        # the source must be a revtree or dirstate rev tree.
 
2371
        # the source must be a revtreee or dirstate rev tree.
2123
2372
        if not isinstance(source,
2124
2373
            (revisiontree.RevisionTree, DirStateRevisionTree)):
2125
2374
            return False
2126
2375
        # the source revid must be in the target dirstate
2127
 
        if not (source._revision_id == _mod_revision.NULL_REVISION or
 
2376
        if not (source._revision_id == NULL_REVISION or
2128
2377
            source._revision_id in target.get_parent_ids()):
2129
 
            # TODO: what about ghosts? it may well need to
 
2378
            # TODO: what about ghosts? it may well need to 
2130
2379
            # check for them explicitly.
2131
2380
            return False
2132
2381
        return True
2142
2391
 
2143
2392
    def convert(self, tree):
2144
2393
        # lock the control files not the tree, so that we dont get tree
2145
 
        # on-unlock behaviours, and so that noone else diddles with the
 
2394
        # on-unlock behaviours, and so that noone else diddles with the 
2146
2395
        # tree during upgrade.
2147
2396
        tree._control_files.lock_write()
2148
2397
        try:
2174
2423
 
2175
2424
    def update_format(self, tree):
2176
2425
        """Change the format marker."""
2177
 
        tree._transport.put_bytes('format',
2178
 
            self.target_format.get_format_string(),
2179
 
            mode=tree.bzrdir._get_file_mode())
2180
 
 
2181
 
 
2182
 
class Converter4to5(object):
2183
 
    """Perform an in-place upgrade of format 4 to format 5 trees."""
2184
 
 
2185
 
    def __init__(self):
2186
 
        self.target_format = WorkingTreeFormat5()
2187
 
 
2188
 
    def convert(self, tree):
2189
 
        # lock the control files not the tree, so that we don't get tree
2190
 
        # on-unlock behaviours, and so that no-one else diddles with the
2191
 
        # tree during upgrade.
2192
 
        tree._control_files.lock_write()
2193
 
        try:
2194
 
            self.update_format(tree)
2195
 
        finally:
2196
 
            tree._control_files.unlock()
2197
 
 
2198
 
    def update_format(self, tree):
2199
 
        """Change the format marker."""
2200
 
        tree._transport.put_bytes('format',
2201
 
            self.target_format.get_format_string(),
2202
 
            mode=tree.bzrdir._get_file_mode())
2203
 
 
2204
 
 
2205
 
class Converter4or5to6(object):
2206
 
    """Perform an in-place upgrade of format 4 or 5 to format 6 trees."""
2207
 
 
2208
 
    def __init__(self):
2209
 
        self.target_format = WorkingTreeFormat6()
2210
 
 
2211
 
    def convert(self, tree):
2212
 
        # lock the control files not the tree, so that we don't get tree
2213
 
        # on-unlock behaviours, and so that no-one else diddles with the
2214
 
        # tree during upgrade.
2215
 
        tree._control_files.lock_write()
2216
 
        try:
2217
 
            self.init_custom_control_files(tree)
2218
 
            self.update_format(tree)
2219
 
        finally:
2220
 
            tree._control_files.unlock()
2221
 
 
2222
 
    def init_custom_control_files(self, tree):
2223
 
        """Initialize custom control files."""
2224
 
        tree._transport.put_bytes('views', '',
2225
 
            mode=tree.bzrdir._get_file_mode())
2226
 
 
2227
 
    def update_format(self, tree):
2228
 
        """Change the format marker."""
2229
 
        tree._transport.put_bytes('format',
2230
 
            self.target_format.get_format_string(),
2231
 
            mode=tree.bzrdir._get_file_mode())
 
2426
        tree._control_files.put_utf8('format',
 
2427
            self.target_format.get_format_string())