~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree_4.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-07-07 21:30:06 UTC
  • mfrom: (5333.1.2 better_pyqt_include)
  • Revision ID: pqm@pqm.ubuntu.com-20100707213006-lriphkkbzwwrl7ne
(jameinel) Use a better list of PyQt includes and excludes. (Gary van der
 Merwe)

Show diffs side-by-side

added added

removed removed

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