~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree_4.py

  • Committer: Patch Queue Manager
  • Date: 2016-04-21 04:10:52 UTC
  • mfrom: (6616.1.1 fix-en-user-guide)
  • Revision ID: pqm@pqm.ubuntu.com-20160421041052-clcye7ns1qcl2n7w
(richard-wilbur) Ensure build of English use guide always uses English text
 even when user's locale specifies a different language. (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
 
1
# Copyright (C) 2007-2012 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
 
22
22
WorkingTree.open(dir).
23
23
"""
24
24
 
 
25
from __future__ import absolute_import
 
26
 
25
27
from cStringIO import StringIO
26
28
import os
27
29
import sys
28
30
 
29
31
from bzrlib.lazy_import import lazy_import
30
32
lazy_import(globals(), """
31
 
from bisect import bisect_left
32
 
import collections
33
 
from copy import deepcopy
34
33
import errno
35
 
import itertools
36
 
import operator
37
34
import stat
38
 
from time import time
39
 
import warnings
40
35
 
41
 
import bzrlib
42
36
from bzrlib import (
43
37
    bzrdir,
44
38
    cache_utf8,
 
39
    config,
45
40
    conflicts as _mod_conflicts,
 
41
    controldir,
46
42
    debug,
47
 
    delta,
48
43
    dirstate,
49
44
    errors,
 
45
    filters as _mod_filters,
50
46
    generate_ids,
51
 
    globbing,
52
 
    ignores,
53
 
    merge,
54
47
    osutils,
55
48
    revision as _mod_revision,
56
49
    revisiontree,
57
 
    textui,
58
50
    trace,
59
51
    transform,
60
 
    urlutils,
61
 
    xml5,
62
 
    xml6,
 
52
    views,
63
53
    )
64
 
import bzrlib.branch
65
 
from bzrlib.transport import get_transport
66
 
import bzrlib.ui
67
54
""")
68
55
 
69
 
from bzrlib import symbol_versioning
70
56
from bzrlib.decorators import needs_read_lock, needs_write_lock
71
 
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, entry_factory
72
 
from bzrlib.lockable_files import LockableFiles, TransportLock
 
57
from bzrlib.inventory import Inventory, ROOT_ID, entry_factory
 
58
from bzrlib.lock import LogicalLockResult
 
59
from bzrlib.lockable_files import LockableFiles
73
60
from bzrlib.lockdir import LockDir
74
 
import bzrlib.mutabletree
75
 
from bzrlib.mutabletree import needs_tree_write_lock
 
61
from bzrlib.mutabletree import (
 
62
    MutableTree,
 
63
    needs_tree_write_lock,
 
64
    )
76
65
from bzrlib.osutils import (
77
66
    file_kind,
78
67
    isdir,
79
 
    normpath,
80
68
    pathjoin,
81
 
    rand_chars,
82
69
    realpath,
83
70
    safe_unicode,
84
 
    splitpath,
85
 
    )
86
 
from bzrlib.trace import mutter, note
 
71
    )
 
72
from bzrlib.symbol_versioning import (
 
73
    deprecated_in,
 
74
    deprecated_method,
 
75
    )
87
76
from bzrlib.transport.local import LocalTransport
88
 
from bzrlib.tree import InterTree
89
 
from bzrlib.progress import DummyProgress, ProgressPhase
90
 
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
91
 
from bzrlib.rio import RioReader, rio_file, Stanza
92
 
from bzrlib.symbol_versioning import (deprecated_passed,
93
 
        deprecated_method,
94
 
        deprecated_function,
95
 
        DEPRECATED_PARAMETER,
96
 
        )
97
 
from bzrlib.tree import Tree
98
 
from bzrlib.workingtree import WorkingTree, WorkingTree3, WorkingTreeFormat3
99
 
 
100
 
 
101
 
# This is the Windows equivalent of ENOTDIR
102
 
# It is defined in pywin32.winerror, but we don't want a strong dependency for
103
 
# just an error code.
104
 
ERROR_PATH_NOT_FOUND = 3
105
 
ERROR_DIRECTORY = 267
106
 
 
107
 
 
108
 
class WorkingTree4(WorkingTree3):
109
 
    """This is the Format 4 working tree.
110
 
 
111
 
    This differs from WorkingTree3 by:
112
 
     - Having a consolidated internal dirstate, stored in a
113
 
       randomly-accessible sorted file on disk.
114
 
     - Not having a regular inventory attribute.  One can be synthesized 
115
 
       on demand but this is expensive and should be avoided.
116
 
 
117
 
    This is new in bzr 0.15.
118
 
    """
 
77
from bzrlib.tree import (
 
78
    InterTree,
 
79
    InventoryTree,
 
80
    )
 
81
from bzrlib.workingtree import (
 
82
    InventoryWorkingTree,
 
83
    WorkingTree,
 
84
    WorkingTreeFormatMetaDir,
 
85
    )
 
86
 
 
87
 
 
88
class DirStateWorkingTree(InventoryWorkingTree):
119
89
 
120
90
    def __init__(self, basedir,
121
91
                 branch,
132
102
        self._format = _format
133
103
        self.bzrdir = _bzrdir
134
104
        basedir = safe_unicode(basedir)
135
 
        mutter("opening working tree %r", basedir)
 
105
        trace.mutter("opening working tree %r", basedir)
136
106
        self._branch = branch
137
107
        self.basedir = realpath(basedir)
138
108
        # if branch is at our basedir and is a format 6 or less
149
119
        self._setup_directory_is_tree_reference()
150
120
        self._detect_case_handling()
151
121
        self._rules_searcher = None
 
122
        self.views = self._make_views()
 
123
        #--- allow tests to select the dirstate iter_changes implementation
 
124
        self._iter_changes = dirstate._process_entry
152
125
 
153
126
    @needs_tree_write_lock
154
127
    def _add(self, files, ids, kinds):
169
142
            state.add(f, file_id, kind, None, '')
170
143
        self._make_dirty(reset_inventory=True)
171
144
 
 
145
    def _get_check_refs(self):
 
146
        """Return the references needed to perform a check of this tree."""
 
147
        return [('trees', self.last_revision())]
 
148
 
172
149
    def _make_dirty(self, reset_inventory):
173
150
        """Make the tree state dirty.
174
151
 
182
159
    @needs_tree_write_lock
183
160
    def add_reference(self, sub_tree):
184
161
        # use standard implementation, which calls back to self._add
185
 
        # 
 
162
        #
186
163
        # So we don't store the reference_revision in the working dirstate,
187
 
        # it's just recorded at the moment of commit. 
 
164
        # it's just recorded at the moment of commit.
188
165
        self._add_reference(sub_tree)
189
166
 
190
167
    def break_lock(self):
226
203
 
227
204
    def _comparison_data(self, entry, path):
228
205
        kind, executable, stat_value = \
229
 
            WorkingTree3._comparison_data(self, entry, path)
 
206
            WorkingTree._comparison_data(self, entry, path)
230
207
        # it looks like a plain directory, but it's really a reference -- see
231
208
        # also kind()
232
 
        if (self._repo_supports_tree_reference and
233
 
            kind == 'directory' and
234
 
            self._directory_is_tree_reference(path)):
 
209
        if (self._repo_supports_tree_reference and kind == 'directory'
 
210
            and entry is not None and entry.kind == 'tree-reference'):
235
211
            kind = 'tree-reference'
236
212
        return kind, executable, stat_value
237
213
 
239
215
    def commit(self, message=None, revprops=None, *args, **kwargs):
240
216
        # mark the tree as dirty post commit - commit
241
217
        # can change the current versioned list by doing deletes.
242
 
        result = WorkingTree3.commit(self, message, revprops, *args, **kwargs)
 
218
        result = WorkingTree.commit(self, message, revprops, *args, **kwargs)
243
219
        self._make_dirty(reset_inventory=True)
244
220
        return result
245
221
 
263
239
            return self._dirstate
264
240
        local_path = self.bzrdir.get_workingtree_transport(None
265
241
            ).local_abspath('dirstate')
266
 
        self._dirstate = dirstate.DirState.on_file(local_path)
 
242
        self._dirstate = dirstate.DirState.on_file(local_path,
 
243
            self._sha1_provider(), self._worth_saving_limit())
267
244
        return self._dirstate
268
245
 
 
246
    def _sha1_provider(self):
 
247
        """A function that returns a SHA1Provider suitable for this tree.
 
248
 
 
249
        :return: None if content filtering is not supported by this tree.
 
250
          Otherwise, a SHA1Provider is returned that sha's the canonical
 
251
          form of files, i.e. after read filters are applied.
 
252
        """
 
253
        if self.supports_content_filtering():
 
254
            return ContentFilterAwareSHA1Provider(self)
 
255
        else:
 
256
            return None
 
257
 
 
258
    def _worth_saving_limit(self):
 
259
        """How many hash changes are ok before we must save the dirstate.
 
260
 
 
261
        :return: an integer. -1 means never save.
 
262
        """
 
263
        conf = self.get_config_stack()
 
264
        return conf.get('bzr.workingtree.worth_saving_limit')
 
265
 
269
266
    def filter_unversioned_files(self, paths):
270
267
        """Filter out paths that are versioned.
271
268
 
303
300
 
304
301
    def _generate_inventory(self):
305
302
        """Create and set self.inventory from the dirstate object.
306
 
        
 
303
 
307
304
        This is relatively expensive: we have to walk the entire dirstate.
308
305
        Ideally we would not, and can deprecate this function.
309
306
        """
354
351
                    parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
355
352
                elif kind == 'tree-reference':
356
353
                    if not self._repo_supports_tree_reference:
357
 
                        raise AssertionError(
358
 
                            "repository of %r "
359
 
                            "doesn't support tree references "
360
 
                            "required by entry %r"
361
 
                            % (self, name))
 
354
                        raise errors.UnsupportedOperation(
 
355
                            self._generate_inventory,
 
356
                            self.branch.repository)
362
357
                    inv_entry.reference_revision = link_or_sha1 or None
363
358
                elif kind != 'symlink':
364
359
                    raise AssertionError("unknown kind %r" % kind)
379
374
        If either file_id or path is supplied, it is used as the key to lookup.
380
375
        If both are supplied, the fastest lookup is used, and an error is
381
376
        raised if they do not both point at the same row.
382
 
        
 
377
 
383
378
        :param file_id: An optional unicode file_id to be looked up.
384
379
        :param path: An optional unicode path to be looked up.
385
380
        :return: The dirstate row tuple for path/file_id, or (None, None)
403
398
        state = self.current_dirstate()
404
399
        if stat_value is None:
405
400
            try:
406
 
                stat_value = os.lstat(file_abspath)
 
401
                stat_value = osutils.lstat(file_abspath)
407
402
            except OSError, e:
408
403
                if e.errno == errno.ENOENT:
409
404
                    return None
410
405
                else:
411
406
                    raise
412
 
        link_or_sha1 = state.update_entry(entry, file_abspath,
413
 
                                          stat_value=stat_value)
 
407
        link_or_sha1 = dirstate.update_entry(state, entry, file_abspath,
 
408
            stat_value=stat_value)
414
409
        if entry[1][0][0] == 'f':
415
 
            return link_or_sha1
 
410
            if link_or_sha1 is None:
 
411
                file_obj, statvalue = self.get_file_with_stat(file_id, path)
 
412
                try:
 
413
                    sha1 = osutils.sha_file(file_obj)
 
414
                finally:
 
415
                    file_obj.close()
 
416
                self._observed_sha1(file_id, path, (sha1, statvalue))
 
417
                return sha1
 
418
            else:
 
419
                return link_or_sha1
416
420
        return None
417
421
 
418
 
    def _get_inventory(self):
 
422
    def _get_root_inventory(self):
419
423
        """Get the inventory for the tree. This is only valid within a lock."""
420
424
        if 'evil' in debug.debug_flags:
421
425
            trace.mutter_callsite(2,
426
430
        self._generate_inventory()
427
431
        return self._inventory
428
432
 
 
433
    @deprecated_method(deprecated_in((2, 5, 0)))
 
434
    def _get_inventory(self):
 
435
        return self.root_inventory
 
436
 
429
437
    inventory = property(_get_inventory,
430
438
                         doc="Inventory of this Tree")
431
439
 
 
440
    root_inventory = property(_get_root_inventory,
 
441
        "Root inventory of this tree")
 
442
 
432
443
    @needs_read_lock
433
444
    def get_parent_ids(self):
434
445
        """See Tree.get_parent_ids.
435
 
        
 
446
 
436
447
        This implementation requests the ids list from the dirstate file.
437
448
        """
438
449
        return self.current_dirstate().get_parent_ids()
460
471
        return osutils.lexists(pathjoin(
461
472
                    self.basedir, row[0].decode('utf8'), row[1].decode('utf8')))
462
473
 
 
474
    def has_or_had_id(self, file_id):
 
475
        state = self.current_dirstate()
 
476
        row, parents = self._get_entry(file_id=file_id)
 
477
        return row is not None
 
478
 
463
479
    @needs_read_lock
464
480
    def id2path(self, file_id):
465
481
        "Convert a file-id to a path."
476
492
            return False # Missing entries are not executable
477
493
        return entry[1][0][3] # Executable?
478
494
 
479
 
    if not osutils.supports_executable():
480
 
        def is_executable(self, file_id, path=None):
481
 
            """Test if a file is executable or not.
 
495
    def is_executable(self, file_id, path=None):
 
496
        """Test if a file is executable or not.
482
497
 
483
 
            Note: The caller is expected to take a read-lock before calling this.
484
 
            """
 
498
        Note: The caller is expected to take a read-lock before calling this.
 
499
        """
 
500
        if not self._supports_executable():
485
501
            entry = self._get_entry(file_id=file_id, path=path)
486
502
            if entry == (None, None):
487
503
                return False
488
504
            return entry[1][0][3]
489
 
 
490
 
        _is_executable_from_path_and_stat = \
491
 
            _is_executable_from_path_and_stat_from_basis
492
 
    else:
493
 
        def is_executable(self, file_id, path=None):
494
 
            """Test if a file is executable or not.
495
 
 
496
 
            Note: The caller is expected to take a read-lock before calling this.
497
 
            """
 
505
        else:
498
506
            self._must_be_locked()
499
507
            if not path:
500
508
                path = self.id2path(file_id)
501
 
            mode = os.lstat(self.abspath(path)).st_mode
 
509
            mode = osutils.lstat(self.abspath(path)).st_mode
502
510
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
503
511
 
504
512
    def all_file_ids(self):
548
556
                # path is missing on disk.
549
557
                continue
550
558
 
 
559
    def _observed_sha1(self, file_id, path, (sha1, statvalue)):
 
560
        """See MutableTree._observed_sha1."""
 
561
        state = self.current_dirstate()
 
562
        entry = self._get_entry(file_id=file_id, path=path)
 
563
        state._observed_sha1(entry, sha1, statvalue)
 
564
 
551
565
    def kind(self, file_id):
552
566
        """Return the kind of a file.
553
567
 
565
579
    def _kind(self, relpath):
566
580
        abspath = self.abspath(relpath)
567
581
        kind = file_kind(abspath)
568
 
        if (self._repo_supports_tree_reference and
569
 
            kind == 'directory' and
570
 
            self._directory_is_tree_reference(relpath)):
571
 
            kind = 'tree-reference'
 
582
        if (self._repo_supports_tree_reference and kind == 'directory'):
 
583
            entry = self._get_entry(path=relpath)
 
584
            if entry[1] is not None:
 
585
                if entry[1][0][0] == 't':
 
586
                    kind = 'tree-reference'
572
587
        return kind
573
588
 
574
589
    @needs_read_lock
581
596
            return _mod_revision.NULL_REVISION
582
597
 
583
598
    def lock_read(self):
584
 
        """See Branch.lock_read, and WorkingTree.unlock."""
 
599
        """See Branch.lock_read, and WorkingTree.unlock.
 
600
 
 
601
        :return: A bzrlib.lock.LogicalLockResult.
 
602
        """
585
603
        self.branch.lock_read()
586
604
        try:
587
605
            self._control_files.lock_read()
600
618
        except:
601
619
            self.branch.unlock()
602
620
            raise
 
621
        return LogicalLockResult(self.unlock)
603
622
 
604
623
    def _lock_self_write(self):
605
624
        """This should be called after the branch is locked."""
620
639
        except:
621
640
            self.branch.unlock()
622
641
            raise
 
642
        return LogicalLockResult(self.unlock)
623
643
 
624
644
    def lock_tree_write(self):
625
 
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
 
645
        """See MutableTree.lock_tree_write, and WorkingTree.unlock.
 
646
 
 
647
        :return: A bzrlib.lock.LogicalLockResult.
 
648
        """
626
649
        self.branch.lock_read()
627
 
        self._lock_self_write()
 
650
        return self._lock_self_write()
628
651
 
629
652
    def lock_write(self):
630
 
        """See MutableTree.lock_write, and WorkingTree.unlock."""
 
653
        """See MutableTree.lock_write, and WorkingTree.unlock.
 
654
 
 
655
        :return: A bzrlib.lock.LogicalLockResult.
 
656
        """
631
657
        self.branch.lock_write()
632
 
        self._lock_self_write()
 
658
        return self._lock_self_write()
633
659
 
634
660
    @needs_tree_write_lock
635
661
    def move(self, from_paths, to_dir, after=False):
666
692
 
667
693
        if self._inventory is not None:
668
694
            update_inventory = True
669
 
            inv = self.inventory
 
695
            inv = self.root_inventory
670
696
            to_dir_id = to_entry[0][2]
671
697
            to_dir_ie = inv[to_dir_id]
672
698
        else:
705
731
            from_entry = self._get_entry(path=from_rel)
706
732
            if from_entry == (None, None):
707
733
                raise errors.BzrMoveFailedError(from_rel,to_dir,
708
 
                    errors.NotVersionedError(path=str(from_rel)))
 
734
                    errors.NotVersionedError(path=from_rel))
709
735
 
710
736
            from_id = from_entry[0][2]
711
737
            to_rel = pathjoin(to_dir, from_tail)
852
878
                rollback_rename()
853
879
                raise
854
880
            result.append((from_rel, to_rel))
855
 
            state._dirblock_state = dirstate.DirState.IN_MEMORY_MODIFIED
 
881
            state._mark_modified()
856
882
            self._make_dirty(reset_inventory=False)
857
883
 
858
884
        return result
868
894
    @needs_read_lock
869
895
    def path2id(self, path):
870
896
        """Return the id for path in this tree."""
 
897
        if isinstance(path, list):
 
898
            if path == []:
 
899
                path = [""]
 
900
            path = osutils.pathjoin(*path)
871
901
        path = path.strip('/')
872
902
        entry = self._get_entry(path=path)
873
903
        if entry == (None, None):
886
916
        for tree in trees:
887
917
            if not (isinstance(tree, DirStateRevisionTree) and tree._revision_id in
888
918
                parents):
889
 
                return super(WorkingTree4, self).paths2ids(paths, trees, require_versioned)
 
919
                return super(DirStateWorkingTree, self).paths2ids(paths,
 
920
                    trees, require_versioned)
890
921
        search_indexes = [0] + [1 + parents.index(tree._revision_id) for tree in trees]
891
922
        # -- make all paths utf8 --
892
923
        paths_utf8 = set()
950
981
                    all_versioned = False
951
982
                    break
952
983
            if not all_versioned:
953
 
                raise errors.PathsNotVersionedError(paths)
 
984
                raise errors.PathsNotVersionedError(
 
985
                    [p.decode('utf-8') for p in paths])
954
986
        # -- remove redundancy in supplied paths to prevent over-scanning --
955
987
        search_paths = osutils.minimum_path_selection(paths)
956
 
        # sketch: 
 
988
        # sketch:
957
989
        # for all search_indexs in each path at or under each element of
958
990
        # search_paths, if the detail is relocated: add the id, and add the
959
991
        # relocated path as one to search if its not searched already. If the
1005
1037
            found_dir_names = set(dir_name_id[:2] for dir_name_id in found)
1006
1038
            for dir_name in split_paths:
1007
1039
                if dir_name not in found_dir_names:
1008
 
                    raise errors.PathsNotVersionedError(paths)
 
1040
                    raise errors.PathsNotVersionedError(
 
1041
                        [p.decode('utf-8') for p in paths])
1009
1042
 
1010
1043
        for dir_name_id, trees_info in found.iteritems():
1011
1044
            for index in search_indexes:
1015
1048
 
1016
1049
    def read_working_inventory(self):
1017
1050
        """Read the working inventory.
1018
 
        
 
1051
 
1019
1052
        This is a meaningless operation for dirstate, but we obey it anyhow.
1020
1053
        """
1021
 
        return self.inventory
 
1054
        return self.root_inventory
1022
1055
 
1023
1056
    @needs_read_lock
1024
1057
    def revision_tree(self, revision_id):
1039
1072
    def set_last_revision(self, new_revision):
1040
1073
        """Change the last revision in the working tree."""
1041
1074
        parents = self.get_parent_ids()
1042
 
        if new_revision in (NULL_REVISION, None):
 
1075
        if new_revision in (_mod_revision.NULL_REVISION, None):
1043
1076
            if len(parents) >= 2:
1044
1077
                raise AssertionError(
1045
1078
                    "setting the last parent to none with a pending merge is "
1052
1085
    @needs_tree_write_lock
1053
1086
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
1054
1087
        """Set the parent ids to revision_ids.
1055
 
        
 
1088
 
1056
1089
        See also set_parent_trees. This api will try to retrieve the tree data
1057
1090
        for each element of revision_ids from the trees repository. If you have
1058
1091
        tree data already available, it is more efficient to use
1110
1143
                real_trees.append((rev_id, tree))
1111
1144
            else:
1112
1145
                real_trees.append((rev_id,
1113
 
                    self.branch.repository.revision_tree(None)))
 
1146
                    self.branch.repository.revision_tree(
 
1147
                        _mod_revision.NULL_REVISION)))
1114
1148
                ghosts.append(rev_id)
1115
1149
            accepted_revisions.add(rev_id)
1116
 
        dirstate.set_parent_trees(real_trees, ghosts=ghosts)
 
1150
        updated = False
 
1151
        if (len(real_trees) == 1
 
1152
            and not ghosts
 
1153
            and self.branch.repository._format.fast_deltas
 
1154
            and isinstance(real_trees[0][1],
 
1155
                revisiontree.InventoryRevisionTree)
 
1156
            and self.get_parent_ids()):
 
1157
            rev_id, rev_tree = real_trees[0]
 
1158
            basis_id = self.get_parent_ids()[0]
 
1159
            # There are times when basis_tree won't be in
 
1160
            # self.branch.repository, (switch, for example)
 
1161
            try:
 
1162
                basis_tree = self.branch.repository.revision_tree(basis_id)
 
1163
            except errors.NoSuchRevision:
 
1164
                # Fall back to the set_parent_trees(), since we can't use
 
1165
                # _make_delta if we can't get the RevisionTree
 
1166
                pass
 
1167
            else:
 
1168
                delta = rev_tree.root_inventory._make_delta(
 
1169
                    basis_tree.root_inventory)
 
1170
                dirstate.update_basis_by_delta(delta, rev_id)
 
1171
                updated = True
 
1172
        if not updated:
 
1173
            dirstate.set_parent_trees(real_trees, ghosts=ghosts)
1117
1174
        self._make_dirty(reset_inventory=False)
1118
1175
 
1119
1176
    def _set_root_id(self, file_id):
1139
1196
 
1140
1197
    def unlock(self):
1141
1198
        """Unlock in format 4 trees needs to write the entire dirstate."""
1142
 
        # do non-implementation specific cleanup
1143
 
        self._cleanup()
1144
 
 
1145
1199
        if self._control_files._lock_count == 1:
 
1200
            # do non-implementation specific cleanup
 
1201
            self._cleanup()
 
1202
 
1146
1203
            # eventually we should do signature checking during read locks for
1147
1204
            # dirstate updates.
1148
1205
            if self._control_files._lock_mode == 'w':
1211
1268
                # just forget the whole block.
1212
1269
                entry_index = 0
1213
1270
                while entry_index < len(block[1]):
1214
 
                    # Mark this file id as having been removed
1215
1271
                    entry = block[1][entry_index]
1216
 
                    ids_to_unversion.discard(entry[0][2])
1217
 
                    if (entry[1][0][0] in 'ar' # don't remove absent or renamed
1218
 
                                               # entries
1219
 
                        or not state._make_absent(entry)):
 
1272
                    if entry[1][0][0] in 'ar':
 
1273
                        # don't remove absent or renamed entries
1220
1274
                        entry_index += 1
 
1275
                    else:
 
1276
                        # Mark this file id as having been removed
 
1277
                        ids_to_unversion.discard(entry[0][2])
 
1278
                        if not state._make_absent(entry):
 
1279
                            # The block has not shrunk.
 
1280
                            entry_index += 1
1221
1281
                # go to the next block. (At the moment we dont delete empty
1222
1282
                # dirblocks)
1223
1283
                block_index += 1
1244
1304
        # have to change the legacy inventory too.
1245
1305
        if self._inventory is not None:
1246
1306
            for file_id in file_ids:
1247
 
                self._inventory.remove_recursive_id(file_id)
 
1307
                if self._inventory.has_id(file_id):
 
1308
                    self._inventory.remove_recursive_id(file_id)
1248
1309
 
1249
1310
    @needs_tree_write_lock
1250
1311
    def rename_one(self, from_rel, to_rel, after=False):
1251
1312
        """See WorkingTree.rename_one"""
1252
1313
        self.flush()
1253
 
        WorkingTree.rename_one(self, from_rel, to_rel, after)
 
1314
        super(DirStateWorkingTree, self).rename_one(from_rel, to_rel, after)
1254
1315
 
1255
1316
    @needs_tree_write_lock
1256
1317
    def apply_inventory_delta(self, changes):
1275
1336
        if self._dirty:
1276
1337
            raise AssertionError("attempting to write an inventory when the "
1277
1338
                "dirstate is dirty will lose pending changes")
1278
 
        self.current_dirstate().set_state_from_inventory(inv)
1279
 
        self._make_dirty(reset_inventory=False)
1280
 
        if self._inventory is not None:
 
1339
        had_inventory = self._inventory is not None
 
1340
        # Setting self._inventory = None forces the dirstate to regenerate the
 
1341
        # working inventory. We do this because self.inventory may be inv, or
 
1342
        # may have been modified, and either case would prevent a clean delta
 
1343
        # being created.
 
1344
        self._inventory = None
 
1345
        # generate a delta,
 
1346
        delta = inv._make_delta(self.root_inventory)
 
1347
        # and apply it.
 
1348
        self.apply_inventory_delta(delta)
 
1349
        if had_inventory:
1281
1350
            self._inventory = inv
1282
1351
        self.flush()
1283
1352
 
1284
 
 
1285
 
class WorkingTreeFormat4(WorkingTreeFormat3):
1286
 
    """The first consolidated dirstate working tree format.
1287
 
 
1288
 
    This format:
1289
 
        - exists within a metadir controlling .bzr
1290
 
        - includes an explicit version marker for the workingtree control
1291
 
          files, separate from the BzrDir format
1292
 
        - modifies the hash cache format
1293
 
        - is new in bzr 0.15
1294
 
        - uses a LockDir to guard access to it.
1295
 
    """
1296
 
 
1297
 
    upgrade_recommended = False
1298
 
 
1299
 
    _tree_class = WorkingTree4
1300
 
 
1301
 
    def get_format_string(self):
1302
 
        """See WorkingTreeFormat.get_format_string()."""
1303
 
        return "Bazaar Working Tree Format 4 (bzr 0.15)\n"
1304
 
 
1305
 
    def get_format_description(self):
1306
 
        """See WorkingTreeFormat.get_format_description()."""
1307
 
        return "Working tree format 4"
 
1353
    @needs_tree_write_lock
 
1354
    def reset_state(self, revision_ids=None):
 
1355
        """Reset the state of the working tree.
 
1356
 
 
1357
        This does a hard-reset to a last-known-good state. This is a way to
 
1358
        fix if something got corrupted (like the .bzr/checkout/dirstate file)
 
1359
        """
 
1360
        if revision_ids is None:
 
1361
            revision_ids = self.get_parent_ids()
 
1362
        if not revision_ids:
 
1363
            base_tree = self.branch.repository.revision_tree(
 
1364
                _mod_revision.NULL_REVISION)
 
1365
            trees = []
 
1366
        else:
 
1367
            trees = zip(revision_ids,
 
1368
                        self.branch.repository.revision_trees(revision_ids))
 
1369
            base_tree = trees[0][1]
 
1370
        state = self.current_dirstate()
 
1371
        # We don't support ghosts yet
 
1372
        state.set_state_from_scratch(base_tree.root_inventory, trees, [])
 
1373
 
 
1374
 
 
1375
class ContentFilterAwareSHA1Provider(dirstate.SHA1Provider):
 
1376
 
 
1377
    def __init__(self, tree):
 
1378
        self.tree = tree
 
1379
 
 
1380
    def sha1(self, abspath):
 
1381
        """See dirstate.SHA1Provider.sha1()."""
 
1382
        filters = self.tree._content_filter_stack(
 
1383
            self.tree.relpath(osutils.safe_unicode(abspath)))
 
1384
        return _mod_filters.internal_size_sha_file_byname(abspath, filters)[1]
 
1385
 
 
1386
    def stat_and_sha1(self, abspath):
 
1387
        """See dirstate.SHA1Provider.stat_and_sha1()."""
 
1388
        filters = self.tree._content_filter_stack(
 
1389
            self.tree.relpath(osutils.safe_unicode(abspath)))
 
1390
        file_obj = file(abspath, 'rb', 65000)
 
1391
        try:
 
1392
            statvalue = os.fstat(file_obj.fileno())
 
1393
            if filters:
 
1394
                file_obj = _mod_filters.filtered_input_file(file_obj, filters)
 
1395
            sha1 = osutils.size_sha_file(file_obj)[1]
 
1396
        finally:
 
1397
            file_obj.close()
 
1398
        return statvalue, sha1
 
1399
 
 
1400
 
 
1401
class ContentFilteringDirStateWorkingTree(DirStateWorkingTree):
 
1402
    """Dirstate working tree that supports content filtering.
 
1403
 
 
1404
    The dirstate holds the hash and size of the canonical form of the file, 
 
1405
    and most methods must return that.
 
1406
    """
 
1407
 
 
1408
    def _file_content_summary(self, path, stat_result):
 
1409
        # This is to support the somewhat obsolete path_content_summary method
 
1410
        # with content filtering: see
 
1411
        # <https://bugs.launchpad.net/bzr/+bug/415508>.
 
1412
        #
 
1413
        # If the dirstate cache is up to date and knows the hash and size,
 
1414
        # return that.
 
1415
        # Otherwise if there are no content filters, return the on-disk size
 
1416
        # and leave the hash blank.
 
1417
        # Otherwise, read and filter the on-disk file and use its size and
 
1418
        # hash.
 
1419
        #
 
1420
        # The dirstate doesn't store the size of the canonical form so we
 
1421
        # can't trust it for content-filtered trees.  We just return None.
 
1422
        dirstate_sha1 = self._dirstate.sha1_from_stat(path, stat_result)
 
1423
        executable = self._is_executable_from_path_and_stat(path, stat_result)
 
1424
        return ('file', None, executable, dirstate_sha1)
 
1425
 
 
1426
 
 
1427
class WorkingTree4(DirStateWorkingTree):
 
1428
    """This is the Format 4 working tree.
 
1429
 
 
1430
    This differs from WorkingTree by:
 
1431
     - Having a consolidated internal dirstate, stored in a
 
1432
       randomly-accessible sorted file on disk.
 
1433
     - Not having a regular inventory attribute.  One can be synthesized
 
1434
       on demand but this is expensive and should be avoided.
 
1435
 
 
1436
    This is new in bzr 0.15.
 
1437
    """
 
1438
 
 
1439
 
 
1440
class WorkingTree5(ContentFilteringDirStateWorkingTree):
 
1441
    """This is the Format 5 working tree.
 
1442
 
 
1443
    This differs from WorkingTree4 by:
 
1444
     - Supporting content filtering.
 
1445
 
 
1446
    This is new in bzr 1.11.
 
1447
    """
 
1448
 
 
1449
 
 
1450
class WorkingTree6(ContentFilteringDirStateWorkingTree):
 
1451
    """This is the Format 6 working tree.
 
1452
 
 
1453
    This differs from WorkingTree5 by:
 
1454
     - Supporting a current view that may mask the set of files in a tree
 
1455
       impacted by most user operations.
 
1456
 
 
1457
    This is new in bzr 1.14.
 
1458
    """
 
1459
 
 
1460
    def _make_views(self):
 
1461
        return views.PathBasedViews(self)
 
1462
 
 
1463
 
 
1464
class DirStateWorkingTreeFormat(WorkingTreeFormatMetaDir):
 
1465
 
 
1466
    missing_parent_conflicts = True
 
1467
 
 
1468
    supports_versioned_directories = True
 
1469
 
 
1470
    _lock_class = LockDir
 
1471
    _lock_file_name = 'lock'
 
1472
 
 
1473
    def _open_control_files(self, a_bzrdir):
 
1474
        transport = a_bzrdir.get_workingtree_transport(None)
 
1475
        return LockableFiles(transport, self._lock_file_name,
 
1476
                             self._lock_class)
1308
1477
 
1309
1478
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
1310
1479
                   accelerator_tree=None, hardlink=False):
1311
1480
        """See WorkingTreeFormat.initialize().
1312
1481
 
1313
1482
        :param revision_id: allows creating a working tree at a different
1314
 
        revision than the branch is at.
 
1483
            revision than the branch is at.
1315
1484
        :param accelerator_tree: A tree which can be used for retrieving file
1316
1485
            contents more quickly than the revision tree, i.e. a workingtree.
1317
1486
            The revision tree will be used for cases where accelerator_tree's
1328
1497
        control_files = self._open_control_files(a_bzrdir)
1329
1498
        control_files.create_lock()
1330
1499
        control_files.lock_write()
1331
 
        transport.put_bytes('format', self.get_format_string(),
 
1500
        transport.put_bytes('format', self.as_string(),
1332
1501
            mode=a_bzrdir._get_file_mode())
1333
1502
        if from_branch is not None:
1334
1503
            branch = from_branch
1350
1519
        wt.lock_tree_write()
1351
1520
        try:
1352
1521
            self._init_custom_control_files(wt)
1353
 
            if revision_id in (None, NULL_REVISION):
 
1522
            if revision_id in (None, _mod_revision.NULL_REVISION):
1354
1523
                if branch.repository.supports_rich_root():
1355
1524
                    wt._set_root_id(generate_ids.gen_root_id())
1356
1525
                else:
1367
1536
                    pass
1368
1537
            if basis is None:
1369
1538
                basis = branch.repository.revision_tree(revision_id)
1370
 
            if revision_id == NULL_REVISION:
 
1539
            if revision_id == _mod_revision.NULL_REVISION:
1371
1540
                parents_list = []
1372
1541
            else:
1373
1542
                parents_list = [(revision_id, basis)]
1381
1550
                if basis_root_id is not None:
1382
1551
                    wt._set_root_id(basis_root_id)
1383
1552
                    wt.flush()
 
1553
                if wt.supports_content_filtering():
 
1554
                    # The original tree may not have the same content filters
 
1555
                    # applied so we can't safely build the inventory delta from
 
1556
                    # the source tree.
 
1557
                    delta_from_tree = False
 
1558
                else:
 
1559
                    delta_from_tree = True
1384
1560
                # delta_from_tree is safe even for DirStateRevisionTrees,
1385
1561
                # because wt4.apply_inventory_delta does not mutate the input
1386
1562
                # inventory entries.
1387
1563
                transform.build_tree(basis, wt, accelerator_tree,
1388
 
                                     hardlink=hardlink, delta_from_tree=True)
 
1564
                                     hardlink=hardlink,
 
1565
                                     delta_from_tree=delta_from_tree)
 
1566
                for hook in MutableTree.hooks['post_build_tree']:
 
1567
                    hook(wt)
1389
1568
            finally:
1390
1569
                basis.unlock()
1391
1570
        finally:
1395
1574
 
1396
1575
    def _init_custom_control_files(self, wt):
1397
1576
        """Subclasses with custom control files should override this method.
1398
 
        
 
1577
 
1399
1578
        The working tree and control files are locked for writing when this
1400
1579
        method is called.
1401
 
        
 
1580
 
1402
1581
        :param wt: the WorkingTree object
1403
1582
        """
1404
1583
 
 
1584
    def open(self, a_bzrdir, _found=False):
 
1585
        """Return the WorkingTree object for a_bzrdir
 
1586
 
 
1587
        _found is a private parameter, do not use it. It is used to indicate
 
1588
               if format probing has already been done.
 
1589
        """
 
1590
        if not _found:
 
1591
            # we are being called directly and must probe.
 
1592
            raise NotImplementedError
 
1593
        if not isinstance(a_bzrdir.transport, LocalTransport):
 
1594
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
 
1595
        wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
 
1596
        return wt
 
1597
 
1405
1598
    def _open(self, a_bzrdir, control_files):
1406
1599
        """Open the tree itself.
1407
1600
 
1415
1608
                           _control_files=control_files)
1416
1609
 
1417
1610
    def __get_matchingbzrdir(self):
 
1611
        return self._get_matchingbzrdir()
 
1612
 
 
1613
    def _get_matchingbzrdir(self):
 
1614
        """Overrideable method to get a bzrdir for testing."""
1418
1615
        # please test against something that will let us do tree references
1419
 
        return bzrdir.format_registry.make_bzrdir(
1420
 
            'dirstate-with-subtree')
 
1616
        return controldir.format_registry.make_bzrdir(
 
1617
            'development-subtree')
1421
1618
 
1422
1619
    _matchingbzrdir = property(__get_matchingbzrdir)
1423
1620
 
1424
1621
 
1425
 
class DirStateRevisionTree(Tree):
1426
 
    """A revision tree pulling the inventory from a dirstate."""
 
1622
class WorkingTreeFormat4(DirStateWorkingTreeFormat):
 
1623
    """The first consolidated dirstate working tree format.
 
1624
 
 
1625
    This format:
 
1626
        - exists within a metadir controlling .bzr
 
1627
        - includes an explicit version marker for the workingtree control
 
1628
          files, separate from the ControlDir format
 
1629
        - modifies the hash cache format
 
1630
        - is new in bzr 0.15
 
1631
        - uses a LockDir to guard access to it.
 
1632
    """
 
1633
 
 
1634
    upgrade_recommended = False
 
1635
 
 
1636
    _tree_class = WorkingTree4
 
1637
 
 
1638
    @classmethod
 
1639
    def get_format_string(cls):
 
1640
        """See WorkingTreeFormat.get_format_string()."""
 
1641
        return "Bazaar Working Tree Format 4 (bzr 0.15)\n"
 
1642
 
 
1643
    def get_format_description(self):
 
1644
        """See WorkingTreeFormat.get_format_description()."""
 
1645
        return "Working tree format 4"
 
1646
 
 
1647
 
 
1648
class WorkingTreeFormat5(DirStateWorkingTreeFormat):
 
1649
    """WorkingTree format supporting content filtering.
 
1650
    """
 
1651
 
 
1652
    upgrade_recommended = False
 
1653
 
 
1654
    _tree_class = WorkingTree5
 
1655
 
 
1656
    @classmethod
 
1657
    def get_format_string(cls):
 
1658
        """See WorkingTreeFormat.get_format_string()."""
 
1659
        return "Bazaar Working Tree Format 5 (bzr 1.11)\n"
 
1660
 
 
1661
    def get_format_description(self):
 
1662
        """See WorkingTreeFormat.get_format_description()."""
 
1663
        return "Working tree format 5"
 
1664
 
 
1665
    def supports_content_filtering(self):
 
1666
        return True
 
1667
 
 
1668
 
 
1669
class WorkingTreeFormat6(DirStateWorkingTreeFormat):
 
1670
    """WorkingTree format supporting views.
 
1671
    """
 
1672
 
 
1673
    upgrade_recommended = False
 
1674
 
 
1675
    _tree_class = WorkingTree6
 
1676
 
 
1677
    @classmethod
 
1678
    def get_format_string(cls):
 
1679
        """See WorkingTreeFormat.get_format_string()."""
 
1680
        return "Bazaar Working Tree Format 6 (bzr 1.14)\n"
 
1681
 
 
1682
    def get_format_description(self):
 
1683
        """See WorkingTreeFormat.get_format_description()."""
 
1684
        return "Working tree format 6"
 
1685
 
 
1686
    def _init_custom_control_files(self, wt):
 
1687
        """Subclasses with custom control files should override this method."""
 
1688
        wt._transport.put_bytes('views', '', mode=wt.bzrdir._get_file_mode())
 
1689
 
 
1690
    def supports_content_filtering(self):
 
1691
        return True
 
1692
 
 
1693
    def supports_views(self):
 
1694
        return True
 
1695
 
 
1696
    def _get_matchingbzrdir(self):
 
1697
        """Overrideable method to get a bzrdir for testing."""
 
1698
        # We use 'development-subtree' instead of '2a', because we have a
 
1699
        # few tests that want to test tree references
 
1700
        return bzrdir.format_registry.make_bzrdir('development-subtree')
 
1701
 
 
1702
 
 
1703
class DirStateRevisionTree(InventoryTree):
 
1704
    """A revision tree pulling the inventory from a dirstate.
 
1705
    
 
1706
    Note that this is one of the historical (ie revision) trees cached in the
 
1707
    dirstate for easy access, not the workingtree.
 
1708
    """
1427
1709
 
1428
1710
    def __init__(self, dirstate, revision_id, repository):
1429
1711
        self._dirstate = dirstate
1443
1725
    def annotate_iter(self, file_id,
1444
1726
                      default_revision=_mod_revision.CURRENT_REVISION):
1445
1727
        """See Tree.annotate_iter"""
1446
 
        text_key = (file_id, self.inventory[file_id].revision)
 
1728
        text_key = (file_id, self.get_file_revision(file_id))
1447
1729
        annotations = self._repository.texts.annotate(text_key)
1448
1730
        return [(key[-1], line) for (key, line) in annotations]
1449
1731
 
1450
 
    def _get_ancestors(self, default_revision):
1451
 
        return set(self._repository.get_ancestry(self._revision_id,
1452
 
                                                 topo_sorted=False))
1453
1732
    def _comparison_data(self, entry, path):
1454
1733
        """See Tree._comparison_data."""
1455
1734
        if entry is None:
1498
1777
        If either file_id or path is supplied, it is used as the key to lookup.
1499
1778
        If both are supplied, the fastest lookup is used, and an error is
1500
1779
        raised if they do not both point at the same row.
1501
 
        
 
1780
 
1502
1781
        :param file_id: An optional unicode file_id to be looked up.
1503
1782
        :param path: An optional unicode path to be looked up.
1504
1783
        :return: The dirstate row tuple for path/file_id, or (None, None)
1508
1787
        if path is not None:
1509
1788
            path = path.encode('utf8')
1510
1789
        parent_index = self._get_parent_index()
1511
 
        return self._dirstate._get_entry(parent_index, fileid_utf8=file_id, path_utf8=path)
 
1790
        return self._dirstate._get_entry(parent_index, fileid_utf8=file_id,
 
1791
            path_utf8=path)
1512
1792
 
1513
1793
    def _generate_inventory(self):
1514
1794
        """Create and set self.inventory from the dirstate object.
1571
1851
                elif kind == 'directory':
1572
1852
                    parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
1573
1853
                elif kind == 'symlink':
1574
 
                    inv_entry.executable = False
1575
 
                    inv_entry.text_size = None
1576
1854
                    inv_entry.symlink_target = utf8_decode(fingerprint)[0]
1577
1855
                elif kind == 'tree-reference':
1578
1856
                    inv_entry.reference_revision = fingerprint or None
1598
1876
        # Make sure the file exists
1599
1877
        entry = self._get_entry(file_id, path=path)
1600
1878
        if entry == (None, None): # do we raise?
1601
 
            return None
 
1879
            raise errors.NoSuchId(self, file_id)
1602
1880
        parent_index = self._get_parent_index()
1603
1881
        last_changed_revision = entry[1][parent_index][4]
1604
 
        return self._repository.get_revision(last_changed_revision).timestamp
 
1882
        try:
 
1883
            rev = self._repository.get_revision(last_changed_revision)
 
1884
        except errors.NoSuchRevision:
 
1885
            raise errors.FileTimestampUnavailable(self.id2path(file_id))
 
1886
        return rev.timestamp
1605
1887
 
1606
1888
    def get_file_sha1(self, file_id, path=None, stat_value=None):
1607
1889
        entry = self._get_entry(file_id=file_id, path=path)
1611
1893
            return parent_details[1]
1612
1894
        return None
1613
1895
 
 
1896
    @needs_read_lock
 
1897
    def get_file_revision(self, file_id):
 
1898
        inv, inv_file_id = self._unpack_file_id(file_id)
 
1899
        return inv[inv_file_id].revision
 
1900
 
1614
1901
    def get_file(self, file_id, path=None):
1615
1902
        return StringIO(self.get_file_text(file_id))
1616
1903
 
1617
 
    def get_file_lines(self, file_id):
1618
 
        return osutils.split_lines(self.get_file_text(file_id))
1619
 
 
1620
1904
    def get_file_size(self, file_id):
1621
1905
        """See Tree.get_file_size"""
1622
 
        return self.inventory[file_id].text_size
 
1906
        inv, inv_file_id = self._unpack_file_id(file_id)
 
1907
        return inv[inv_file_id].text_size
1623
1908
 
1624
 
    def get_file_text(self, file_id):
1625
 
        return list(self.iter_files_bytes([(file_id, None)]))[0][1]
 
1909
    def get_file_text(self, file_id, path=None):
 
1910
        content = None
 
1911
        for _, content_iter in self.iter_files_bytes([(file_id, None)]):
 
1912
            if content is not None:
 
1913
                raise AssertionError('iter_files_bytes returned'
 
1914
                    ' too many entries')
 
1915
            # For each entry returned by iter_files_bytes, we must consume the
 
1916
            # content_iter before we step the files iterator.
 
1917
            content = ''.join(content_iter)
 
1918
        if content is None:
 
1919
            raise AssertionError('iter_files_bytes did not return'
 
1920
                ' the requested data')
 
1921
        return content
1626
1922
 
1627
1923
    def get_reference_revision(self, file_id, path=None):
1628
 
        return self.inventory[file_id].reference_revision
 
1924
        inv, inv_file_id = self._unpack_file_id(file_id)
 
1925
        return inv[inv_file_id].reference_revision
1629
1926
 
1630
1927
    def iter_files_bytes(self, desired_files):
1631
1928
        """See Tree.iter_files_bytes.
1641
1938
                                       identifier))
1642
1939
        return self._repository.iter_files_bytes(repo_desired_files)
1643
1940
 
1644
 
    def get_symlink_target(self, file_id):
 
1941
    def get_symlink_target(self, file_id, path=None):
1645
1942
        entry = self._get_entry(file_id=file_id)
1646
1943
        parent_index = self._get_parent_index()
1647
1944
        if entry[1][parent_index][0] != 'l':
1648
1945
            return None
1649
1946
        else:
1650
 
            # At present, none of the tree implementations supports non-ascii
1651
 
            # symlink targets. So we will just assume that the dirstate path is
1652
 
            # correct.
1653
 
            return entry[1][parent_index][1]
 
1947
            target = entry[1][parent_index][1]
 
1948
            target = target.decode('utf8')
 
1949
            return target
1654
1950
 
1655
1951
    def get_revision_id(self):
1656
1952
        """Return the revision id for this tree."""
1657
1953
        return self._revision_id
1658
1954
 
1659
 
    def _get_inventory(self):
 
1955
    def _get_root_inventory(self):
1660
1956
        if self._inventory is not None:
1661
1957
            return self._inventory
1662
1958
        self._must_be_locked()
1663
1959
        self._generate_inventory()
1664
1960
        return self._inventory
1665
1961
 
 
1962
    root_inventory = property(_get_root_inventory,
 
1963
                         doc="Inventory of this Tree")
 
1964
 
 
1965
    @deprecated_method(deprecated_in((2, 5, 0)))
 
1966
    def _get_inventory(self):
 
1967
        return self.root_inventory
 
1968
 
1666
1969
    inventory = property(_get_inventory,
1667
1970
                         doc="Inventory of this Tree")
1668
1971
 
1677
1980
        entry = self._get_entry(file_id=file_id)[1]
1678
1981
        if entry is None:
1679
1982
            raise errors.NoSuchId(tree=self, file_id=file_id)
1680
 
        return dirstate.DirState._minikind_to_kind[entry[1][0]]
 
1983
        parent_index = self._get_parent_index()
 
1984
        return dirstate.DirState._minikind_to_kind[entry[parent_index][0]]
1681
1985
 
1682
1986
    def stored_kind(self, file_id):
1683
1987
        """See Tree.stored_kind"""
1685
1989
 
1686
1990
    def path_content_summary(self, path):
1687
1991
        """See Tree.path_content_summary."""
1688
 
        id = self.inventory.path2id(path)
1689
 
        if id is None:
 
1992
        inv, inv_file_id = self._path2inv_file_id(path)
 
1993
        if inv_file_id is None:
1690
1994
            return ('missing', None, None, None)
1691
 
        entry = self._inventory[id]
 
1995
        entry = inv[inv_file_id]
1692
1996
        kind = entry.kind
1693
1997
        if kind == 'file':
1694
1998
            return (kind, entry.text_size, entry.executable, entry.text_sha1)
1698
2002
            return (kind, None, None, None)
1699
2003
 
1700
2004
    def is_executable(self, file_id, path=None):
1701
 
        ie = self.inventory[file_id]
 
2005
        inv, inv_file_id = self._unpack_file_id(file_id)
 
2006
        ie = inv[inv_file_id]
1702
2007
        if ie.kind != "file":
1703
 
            return None
 
2008
            return False
1704
2009
        return ie.executable
1705
2010
 
1706
 
    def list_files(self, include_root=False):
 
2011
    def is_locked(self):
 
2012
        return self._locked
 
2013
 
 
2014
    def list_files(self, include_root=False, from_dir=None, recursive=True):
1707
2015
        # We use a standard implementation, because DirStateRevisionTree is
1708
2016
        # dealing with one of the parents of the current state
1709
 
        inv = self._get_inventory()
1710
 
        entries = inv.iter_entries()
1711
 
        if self.inventory.root is not None and not include_root:
 
2017
        if from_dir is None:
 
2018
            inv = self.root_inventory
 
2019
            from_dir_id = None
 
2020
        else:
 
2021
            inv, from_dir_id = self._path2inv_file_id(from_dir)
 
2022
            if from_dir_id is None:
 
2023
                # Directory not versioned
 
2024
                return
 
2025
        # FIXME: Support nested trees
 
2026
        entries = inv.iter_entries(from_dir=from_dir_id, recursive=recursive)
 
2027
        if inv.root is not None and not include_root and from_dir is None:
1712
2028
            entries.next()
1713
2029
        for path, entry in entries:
1714
2030
            yield path, 'V', entry.kind, entry.file_id, entry
1715
2031
 
1716
2032
    def lock_read(self):
1717
 
        """Lock the tree for a set of operations."""
 
2033
        """Lock the tree for a set of operations.
 
2034
 
 
2035
        :return: A bzrlib.lock.LogicalLockResult.
 
2036
        """
1718
2037
        if not self._locked:
1719
2038
            self._repository.lock_read()
1720
2039
            if self._dirstate._lock_token is None:
1721
2040
                self._dirstate.lock_read()
1722
2041
                self._dirstate_locked = True
1723
2042
        self._locked += 1
 
2043
        return LogicalLockResult(self.unlock)
1724
2044
 
1725
2045
    def _must_be_locked(self):
1726
2046
        if not self._locked:
1730
2050
    def path2id(self, path):
1731
2051
        """Return the id for path in this tree."""
1732
2052
        # lookup by path: faster than splitting and walking the ivnentory.
 
2053
        if isinstance(path, list):
 
2054
            if path == []:
 
2055
                path = [""]
 
2056
            path = osutils.pathjoin(*path)
1733
2057
        entry = self._get_entry(path=path)
1734
2058
        if entry == (None, None):
1735
2059
            return None
1753
2077
 
1754
2078
    def walkdirs(self, prefix=""):
1755
2079
        # TODO: jam 20070215 This is the lazy way by using the RevisionTree
1756
 
        # implementation based on an inventory.  
 
2080
        # implementation based on an inventory.
1757
2081
        # This should be cleaned up to use the much faster Dirstate code
1758
2082
        # So for now, we just build up the parent inventory, and extract
1759
2083
        # it the same way RevisionTree does.
1760
2084
        _directory = 'directory'
1761
 
        inv = self._get_inventory()
 
2085
        inv = self._get_root_inventory()
1762
2086
        top_id = inv.path2id(prefix)
1763
2087
        if top_id is None:
1764
2088
            pending = []
1788
2112
 
1789
2113
class InterDirStateTree(InterTree):
1790
2114
    """Fast path optimiser for changes_from with dirstate trees.
1791
 
    
1792
 
    This is used only when both trees are in the dirstate working file, and 
1793
 
    the source is any parent within the dirstate, and the destination is 
 
2115
 
 
2116
    This is used only when both trees are in the dirstate working file, and
 
2117
    the source is any parent within the dirstate, and the destination is
1794
2118
    the current working tree of the same dirstate.
1795
2119
    """
1796
2120
    # this could be generalized to allow comparisons between any trees in the
1805
2129
    def make_source_parent_tree(source, target):
1806
2130
        """Change the source tree into a parent of the target."""
1807
2131
        revid = source.commit('record tree')
1808
 
        target.branch.repository.fetch(source.branch.repository, revid)
 
2132
        target.branch.fetch(source.branch, revid)
1809
2133
        target.set_parent_ids([revid])
1810
2134
        return target.basis_tree(), target
1811
2135
 
 
2136
    @classmethod
 
2137
    def make_source_parent_tree_python_dirstate(klass, test_case, source, target):
 
2138
        result = klass.make_source_parent_tree(source, target)
 
2139
        result[1]._iter_changes = dirstate.ProcessEntryPython
 
2140
        return result
 
2141
 
 
2142
    @classmethod
 
2143
    def make_source_parent_tree_compiled_dirstate(klass, test_case, source,
 
2144
                                                  target):
 
2145
        from bzrlib.tests.test__dirstate_helpers import \
 
2146
            compiled_dirstate_helpers_feature
 
2147
        test_case.requireFeature(compiled_dirstate_helpers_feature)
 
2148
        from bzrlib._dirstate_helpers_pyx import ProcessEntryC
 
2149
        result = klass.make_source_parent_tree(source, target)
 
2150
        result[1]._iter_changes = ProcessEntryC
 
2151
        return result
 
2152
 
1812
2153
    _matching_from_tree_format = WorkingTreeFormat4()
1813
2154
    _matching_to_tree_format = WorkingTreeFormat4()
1814
 
    _test_mutable_trees_to_test_trees = make_source_parent_tree
 
2155
 
 
2156
    @classmethod
 
2157
    def _test_mutable_trees_to_test_trees(klass, test_case, source, target):
 
2158
        # This method shouldn't be called, because we have python and C
 
2159
        # specific flavours.
 
2160
        raise NotImplementedError
1815
2161
 
1816
2162
    def iter_changes(self, include_unchanged=False,
1817
2163
                      specific_files=None, pb=None, extra_trees=[],
1835
2181
            output. An unversioned file is defined as one with (False, False)
1836
2182
            for the versioned pair.
1837
2183
        """
1838
 
        utf8_decode = cache_utf8._utf8_decode
1839
 
        _minikind_to_kind = dirstate.DirState._minikind_to_kind
1840
 
        cmp_by_dirs = dirstate.cmp_by_dirs
1841
 
        # NB: show_status depends on being able to pass in non-versioned files
1842
 
        # and report them as unknown
1843
2184
        # TODO: handle extra trees in the dirstate.
1844
2185
        if (extra_trees or specific_files == []):
1845
2186
            # we can't fast-path these cases (yet)
1846
 
            for f in super(InterDirStateTree, self).iter_changes(
 
2187
            return super(InterDirStateTree, self).iter_changes(
1847
2188
                include_unchanged, specific_files, pb, extra_trees,
1848
 
                require_versioned, want_unversioned=want_unversioned):
1849
 
                yield f
1850
 
            return
 
2189
                require_versioned, want_unversioned=want_unversioned)
1851
2190
        parent_ids = self.target.get_parent_ids()
1852
2191
        if not (self.source._revision_id in parent_ids
1853
 
                or self.source._revision_id == NULL_REVISION):
 
2192
                or self.source._revision_id == _mod_revision.NULL_REVISION):
1854
2193
            raise AssertionError(
1855
2194
                "revision {%s} is not stored in {%s}, but %s "
1856
2195
                "can only be used for trees stored in the dirstate"
1857
2196
                % (self.source._revision_id, self.target, self.iter_changes))
1858
2197
        target_index = 0
1859
 
        if self.source._revision_id == NULL_REVISION:
 
2198
        if self.source._revision_id == _mod_revision.NULL_REVISION:
1860
2199
            source_index = None
1861
2200
            indices = (target_index,)
1862
2201
        else:
1870
2209
        if specific_files:
1871
2210
            specific_files_utf8 = set()
1872
2211
            for path in specific_files:
 
2212
                # Note, if there are many specific files, using cache_utf8
 
2213
                # would be good here.
1873
2214
                specific_files_utf8.add(path.encode('utf8'))
1874
2215
            specific_files = specific_files_utf8
1875
2216
        else:
1876
2217
            specific_files = set([''])
1877
2218
        # -- specific_files is now a utf8 path set --
 
2219
 
1878
2220
        # -- get the state object and prepare it.
1879
2221
        state = self.target.current_dirstate()
1880
2222
        state._read_dirblocks_if_needed()
1881
 
        def _entries_for_path(path):
1882
 
            """Return a list with all the entries that match path for all ids.
1883
 
            """
1884
 
            dirname, basename = os.path.split(path)
1885
 
            key = (dirname, basename, '')
1886
 
            block_index, present = state._find_block_index_from_key(key)
1887
 
            if not present:
1888
 
                # the block which should contain path is absent.
1889
 
                return []
1890
 
            result = []
1891
 
            block = state._dirblocks[block_index][1]
1892
 
            entry_index, _ = state._find_entry_index(key, block)
1893
 
            # we may need to look at multiple entries at this path: walk while the specific_files match.
1894
 
            while (entry_index < len(block) and
1895
 
                block[entry_index][0][0:2] == key[0:2]):
1896
 
                result.append(block[entry_index])
1897
 
                entry_index += 1
1898
 
            return result
1899
2223
        if require_versioned:
1900
2224
            # -- check all supplied paths are versioned in a search tree. --
1901
 
            all_versioned = True
 
2225
            not_versioned = []
1902
2226
            for path in specific_files:
1903
 
                path_entries = _entries_for_path(path)
 
2227
                path_entries = state._entries_for_path(path)
1904
2228
                if not path_entries:
1905
2229
                    # this specified path is not present at all: error
1906
 
                    all_versioned = False
1907
 
                    break
 
2230
                    not_versioned.append(path.decode('utf-8'))
 
2231
                    continue
1908
2232
                found_versioned = False
1909
2233
                # for each id at this path
1910
2234
                for entry in path_entries:
1917
2241
                if not found_versioned:
1918
2242
                    # none of the indexes was not 'absent' at all ids for this
1919
2243
                    # path.
1920
 
                    all_versioned = False
1921
 
                    break
1922
 
            if not all_versioned:
1923
 
                raise errors.PathsNotVersionedError(specific_files)
 
2244
                    not_versioned.append(path.decode('utf-8'))
 
2245
            if len(not_versioned) > 0:
 
2246
                raise errors.PathsNotVersionedError(not_versioned)
1924
2247
        # -- remove redundancy in supplied specific_files to prevent over-scanning --
1925
 
        search_specific_files = set()
1926
 
        for path in specific_files:
1927
 
            other_specific_files = specific_files.difference(set([path]))
1928
 
            if not osutils.is_inside_any(other_specific_files, path):
1929
 
                # this is a top level path, we must check it.
1930
 
                search_specific_files.add(path)
1931
 
        # sketch: 
1932
 
        # compare source_index and target_index at or under each element of search_specific_files.
1933
 
        # follow the following comparison table. Note that we only want to do diff operations when
1934
 
        # the target is fdl because thats when the walkdirs logic will have exposed the pathinfo 
1935
 
        # for the target.
1936
 
        # cases:
1937
 
        # 
1938
 
        # Source | Target | disk | action
1939
 
        #   r    | fdlt   |      | add source to search, add id path move and perform
1940
 
        #        |        |      | diff check on source-target
1941
 
        #   r    | fdlt   |  a   | dangling file that was present in the basis. 
1942
 
        #        |        |      | ???
1943
 
        #   r    |  a     |      | add source to search
1944
 
        #   r    |  a     |  a   | 
1945
 
        #   r    |  r     |      | this path is present in a non-examined tree, skip.
1946
 
        #   r    |  r     |  a   | this path is present in a non-examined tree, skip.
1947
 
        #   a    | fdlt   |      | add new id
1948
 
        #   a    | fdlt   |  a   | dangling locally added file, skip
1949
 
        #   a    |  a     |      | not present in either tree, skip
1950
 
        #   a    |  a     |  a   | not present in any tree, skip
1951
 
        #   a    |  r     |      | not present in either tree at this path, skip as it
1952
 
        #        |        |      | may not be selected by the users list of paths.
1953
 
        #   a    |  r     |  a   | not present in either tree at this path, skip as it
1954
 
        #        |        |      | may not be selected by the users list of paths.
1955
 
        #  fdlt  | fdlt   |      | content in both: diff them
1956
 
        #  fdlt  | fdlt   |  a   | deleted locally, but not unversioned - show as deleted ?
1957
 
        #  fdlt  |  a     |      | unversioned: output deleted id for now
1958
 
        #  fdlt  |  a     |  a   | unversioned and deleted: output deleted id
1959
 
        #  fdlt  |  r     |      | relocated in this tree, so add target to search.
1960
 
        #        |        |      | Dont diff, we will see an r,fd; pair when we reach
1961
 
        #        |        |      | this id at the other path.
1962
 
        #  fdlt  |  r     |  a   | relocated in this tree, so add target to search.
1963
 
        #        |        |      | Dont diff, we will see an r,fd; pair when we reach
1964
 
        #        |        |      | this id at the other path.
1965
 
 
1966
 
        # for all search_indexs in each path at or under each element of
1967
 
        # search_specific_files, if the detail is relocated: add the id, and add the
1968
 
        # relocated path as one to search if its not searched already. If the
1969
 
        # detail is not relocated, add the id.
1970
 
        searched_specific_files = set()
1971
 
        NULL_PARENT_DETAILS = dirstate.DirState.NULL_PARENT_DETAILS
1972
 
        # Using a list so that we can access the values and change them in
1973
 
        # nested scope. Each one is [path, file_id, entry]
1974
 
        last_source_parent = [None, None]
1975
 
        last_target_parent = [None, None]
 
2248
        search_specific_files = osutils.minimum_path_selection(specific_files)
1976
2249
 
1977
2250
        use_filesystem_for_exec = (sys.platform != 'win32')
1978
 
 
1979
 
        # Just a sentry, so that _process_entry can say that this
1980
 
        # record is handled, but isn't interesting to process (unchanged)
1981
 
        uninteresting = object()
1982
 
 
1983
 
        old_dirname_to_file_id = {}
1984
 
        new_dirname_to_file_id = {}
1985
 
        # TODO: jam 20070516 - Avoid the _get_entry lookup overhead by
1986
 
        #       keeping a cache of directories that we have seen.
1987
 
 
1988
 
        def _process_entry(entry, path_info):
1989
 
            """Compare an entry and real disk to generate delta information.
1990
 
 
1991
 
            :param path_info: top_relpath, basename, kind, lstat, abspath for
1992
 
                the path of entry. If None, then the path is considered absent.
1993
 
                (Perhaps we should pass in a concrete entry for this ?)
1994
 
                Basename is returned as a utf8 string because we expect this
1995
 
                tuple will be ignored, and don't want to take the time to
1996
 
                decode.
1997
 
            :return: None if these don't match
1998
 
                     A tuple of information about the change, or
1999
 
                     the object 'uninteresting' if these match, but are
2000
 
                     basically identical.
2001
 
            """
2002
 
            if source_index is None:
2003
 
                source_details = NULL_PARENT_DETAILS
2004
 
            else:
2005
 
                source_details = entry[1][source_index]
2006
 
            target_details = entry[1][target_index]
2007
 
            target_minikind = target_details[0]
2008
 
            if path_info is not None and target_minikind in 'fdlt':
2009
 
                if not (target_index == 0):
2010
 
                    raise AssertionError()
2011
 
                link_or_sha1 = state.update_entry(entry, abspath=path_info[4],
2012
 
                                                  stat_value=path_info[3])
2013
 
                # The entry may have been modified by update_entry
2014
 
                target_details = entry[1][target_index]
2015
 
                target_minikind = target_details[0]
2016
 
            else:
2017
 
                link_or_sha1 = None
2018
 
            file_id = entry[0][2]
2019
 
            source_minikind = source_details[0]
2020
 
            if source_minikind in 'fdltr' and target_minikind in 'fdlt':
2021
 
                # claimed content in both: diff
2022
 
                #   r    | fdlt   |      | add source to search, add id path move and perform
2023
 
                #        |        |      | diff check on source-target
2024
 
                #   r    | fdlt   |  a   | dangling file that was present in the basis.
2025
 
                #        |        |      | ???
2026
 
                if source_minikind in 'r':
2027
 
                    # add the source to the search path to find any children it
2028
 
                    # has.  TODO ? : only add if it is a container ?
2029
 
                    if not osutils.is_inside_any(searched_specific_files,
2030
 
                                                 source_details[1]):
2031
 
                        search_specific_files.add(source_details[1])
2032
 
                    # generate the old path; this is needed for stating later
2033
 
                    # as well.
2034
 
                    old_path = source_details[1]
2035
 
                    old_dirname, old_basename = os.path.split(old_path)
2036
 
                    path = pathjoin(entry[0][0], entry[0][1])
2037
 
                    old_entry = state._get_entry(source_index,
2038
 
                                                 path_utf8=old_path)
2039
 
                    # update the source details variable to be the real
2040
 
                    # location.
2041
 
                    if old_entry == (None, None):
2042
 
                        raise errors.CorruptDirstate(state._filename,
2043
 
                            "entry '%s/%s' is considered renamed from %r"
2044
 
                            " but source does not exist\n"
2045
 
                            "entry: %s" % (entry[0][0], entry[0][1], old_path, entry))
2046
 
                    source_details = old_entry[1][source_index]
2047
 
                    source_minikind = source_details[0]
2048
 
                else:
2049
 
                    old_dirname = entry[0][0]
2050
 
                    old_basename = entry[0][1]
2051
 
                    old_path = path = None
2052
 
                if path_info is None:
2053
 
                    # the file is missing on disk, show as removed.
2054
 
                    content_change = True
2055
 
                    target_kind = None
2056
 
                    target_exec = False
2057
 
                else:
2058
 
                    # source and target are both versioned and disk file is present.
2059
 
                    target_kind = path_info[2]
2060
 
                    if target_kind == 'directory':
2061
 
                        if path is None:
2062
 
                            old_path = path = pathjoin(old_dirname, old_basename)
2063
 
                        new_dirname_to_file_id[path] = file_id
2064
 
                        if source_minikind != 'd':
2065
 
                            content_change = True
2066
 
                        else:
2067
 
                            # directories have no fingerprint
2068
 
                            content_change = False
2069
 
                        target_exec = False
2070
 
                    elif target_kind == 'file':
2071
 
                        if source_minikind != 'f':
2072
 
                            content_change = True
2073
 
                        else:
2074
 
                            # We could check the size, but we already have the
2075
 
                            # sha1 hash.
2076
 
                            content_change = (link_or_sha1 != source_details[1])
2077
 
                        # Target details is updated at update_entry time
2078
 
                        if use_filesystem_for_exec:
2079
 
                            # We don't need S_ISREG here, because we are sure
2080
 
                            # we are dealing with a file.
2081
 
                            target_exec = bool(stat.S_IEXEC & path_info[3].st_mode)
2082
 
                        else:
2083
 
                            target_exec = target_details[3]
2084
 
                    elif target_kind == 'symlink':
2085
 
                        if source_minikind != 'l':
2086
 
                            content_change = True
2087
 
                        else:
2088
 
                            content_change = (link_or_sha1 != source_details[1])
2089
 
                        target_exec = False
2090
 
                    elif target_kind == 'tree-reference':
2091
 
                        if source_minikind != 't':
2092
 
                            content_change = True
2093
 
                        else:
2094
 
                            content_change = False
2095
 
                        target_exec = False
2096
 
                    else:
2097
 
                        raise Exception, "unknown kind %s" % path_info[2]
2098
 
                if source_minikind == 'd':
2099
 
                    if path is None:
2100
 
                        old_path = path = pathjoin(old_dirname, old_basename)
2101
 
                    old_dirname_to_file_id[old_path] = file_id
2102
 
                # parent id is the entry for the path in the target tree
2103
 
                if old_dirname == last_source_parent[0]:
2104
 
                    source_parent_id = last_source_parent[1]
2105
 
                else:
2106
 
                    try:
2107
 
                        source_parent_id = old_dirname_to_file_id[old_dirname]
2108
 
                    except KeyError:
2109
 
                        source_parent_entry = state._get_entry(source_index,
2110
 
                                                               path_utf8=old_dirname)
2111
 
                        source_parent_id = source_parent_entry[0][2]
2112
 
                    if source_parent_id == entry[0][2]:
2113
 
                        # This is the root, so the parent is None
2114
 
                        source_parent_id = None
2115
 
                    else:
2116
 
                        last_source_parent[0] = old_dirname
2117
 
                        last_source_parent[1] = source_parent_id
2118
 
                new_dirname = entry[0][0]
2119
 
                if new_dirname == last_target_parent[0]:
2120
 
                    target_parent_id = last_target_parent[1]
2121
 
                else:
2122
 
                    try:
2123
 
                        target_parent_id = new_dirname_to_file_id[new_dirname]
2124
 
                    except KeyError:
2125
 
                        # TODO: We don't always need to do the lookup, because the
2126
 
                        #       parent entry will be the same as the source entry.
2127
 
                        target_parent_entry = state._get_entry(target_index,
2128
 
                                                               path_utf8=new_dirname)
2129
 
                        if target_parent_entry == (None, None):
2130
 
                            raise AssertionError(
2131
 
                                "Could not find target parent in wt: %s\nparent of: %s"
2132
 
                                % (new_dirname, entry))
2133
 
                        target_parent_id = target_parent_entry[0][2]
2134
 
                    if target_parent_id == entry[0][2]:
2135
 
                        # This is the root, so the parent is None
2136
 
                        target_parent_id = None
2137
 
                    else:
2138
 
                        last_target_parent[0] = new_dirname
2139
 
                        last_target_parent[1] = target_parent_id
2140
 
 
2141
 
                source_exec = source_details[3]
2142
 
                if (include_unchanged
2143
 
                    or content_change
2144
 
                    or source_parent_id != target_parent_id
2145
 
                    or old_basename != entry[0][1]
2146
 
                    or source_exec != target_exec
2147
 
                    ):
2148
 
                    if old_path is None:
2149
 
                        old_path = path = pathjoin(old_dirname, old_basename)
2150
 
                        old_path_u = utf8_decode(old_path)[0]
2151
 
                        path_u = old_path_u
2152
 
                    else:
2153
 
                        old_path_u = utf8_decode(old_path)[0]
2154
 
                        if old_path == path:
2155
 
                            path_u = old_path_u
2156
 
                        else:
2157
 
                            path_u = utf8_decode(path)[0]
2158
 
                    source_kind = _minikind_to_kind[source_minikind]
2159
 
                    return (entry[0][2],
2160
 
                           (old_path_u, path_u),
2161
 
                           content_change,
2162
 
                           (True, True),
2163
 
                           (source_parent_id, target_parent_id),
2164
 
                           (utf8_decode(old_basename)[0], utf8_decode(entry[0][1])[0]),
2165
 
                           (source_kind, target_kind),
2166
 
                           (source_exec, target_exec))
2167
 
                else:
2168
 
                    return uninteresting
2169
 
            elif source_minikind in 'a' and target_minikind in 'fdlt':
2170
 
                # looks like a new file
2171
 
                path = pathjoin(entry[0][0], entry[0][1])
2172
 
                # parent id is the entry for the path in the target tree
2173
 
                # TODO: these are the same for an entire directory: cache em.
2174
 
                parent_id = state._get_entry(target_index,
2175
 
                                             path_utf8=entry[0][0])[0][2]
2176
 
                if parent_id == entry[0][2]:
2177
 
                    parent_id = None
2178
 
                if path_info is not None:
2179
 
                    # Present on disk:
2180
 
                    if use_filesystem_for_exec:
2181
 
                        # We need S_ISREG here, because we aren't sure if this
2182
 
                        # is a file or not.
2183
 
                        target_exec = bool(
2184
 
                            stat.S_ISREG(path_info[3].st_mode)
2185
 
                            and stat.S_IEXEC & path_info[3].st_mode)
2186
 
                    else:
2187
 
                        target_exec = target_details[3]
2188
 
                    return (entry[0][2],
2189
 
                           (None, utf8_decode(path)[0]),
2190
 
                           True,
2191
 
                           (False, True),
2192
 
                           (None, parent_id),
2193
 
                           (None, utf8_decode(entry[0][1])[0]),
2194
 
                           (None, path_info[2]),
2195
 
                           (None, target_exec))
2196
 
                else:
2197
 
                    # Its a missing file, report it as such.
2198
 
                    return (entry[0][2],
2199
 
                           (None, utf8_decode(path)[0]),
2200
 
                           False,
2201
 
                           (False, True),
2202
 
                           (None, parent_id),
2203
 
                           (None, utf8_decode(entry[0][1])[0]),
2204
 
                           (None, None),
2205
 
                           (None, False))
2206
 
            elif source_minikind in 'fdlt' and target_minikind in 'a':
2207
 
                # unversioned, possibly, or possibly not deleted: we dont care.
2208
 
                # if its still on disk, *and* theres no other entry at this
2209
 
                # path [we dont know this in this routine at the moment -
2210
 
                # perhaps we should change this - then it would be an unknown.
2211
 
                old_path = pathjoin(entry[0][0], entry[0][1])
2212
 
                # parent id is the entry for the path in the target tree
2213
 
                parent_id = state._get_entry(source_index, path_utf8=entry[0][0])[0][2]
2214
 
                if parent_id == entry[0][2]:
2215
 
                    parent_id = None
2216
 
                return (entry[0][2],
2217
 
                       (utf8_decode(old_path)[0], None),
2218
 
                       True,
2219
 
                       (True, False),
2220
 
                       (parent_id, None),
2221
 
                       (utf8_decode(entry[0][1])[0], None),
2222
 
                       (_minikind_to_kind[source_minikind], None),
2223
 
                       (source_details[3], None))
2224
 
            elif source_minikind in 'fdlt' and target_minikind in 'r':
2225
 
                # a rename; could be a true rename, or a rename inherited from
2226
 
                # a renamed parent. TODO: handle this efficiently. Its not
2227
 
                # common case to rename dirs though, so a correct but slow
2228
 
                # implementation will do.
2229
 
                if not osutils.is_inside_any(searched_specific_files, target_details[1]):
2230
 
                    search_specific_files.add(target_details[1])
2231
 
            elif source_minikind in 'ra' and target_minikind in 'ra':
2232
 
                # neither of the selected trees contain this file,
2233
 
                # so skip over it. This is not currently directly tested, but
2234
 
                # is indirectly via test_too_much.TestCommands.test_conflicts.
2235
 
                pass
2236
 
            else:
2237
 
                raise AssertionError("don't know how to compare "
2238
 
                    "source_minikind=%r, target_minikind=%r"
2239
 
                    % (source_minikind, target_minikind))
2240
 
                ## import pdb;pdb.set_trace()
2241
 
            return None
2242
 
 
2243
 
        while search_specific_files:
2244
 
            # TODO: the pending list should be lexically sorted?  the
2245
 
            # interface doesn't require it.
2246
 
            current_root = search_specific_files.pop()
2247
 
            current_root_unicode = current_root.decode('utf8')
2248
 
            searched_specific_files.add(current_root)
2249
 
            # process the entries for this containing directory: the rest will be
2250
 
            # found by their parents recursively.
2251
 
            root_entries = _entries_for_path(current_root)
2252
 
            root_abspath = self.target.abspath(current_root_unicode)
2253
 
            try:
2254
 
                root_stat = os.lstat(root_abspath)
2255
 
            except OSError, e:
2256
 
                if e.errno == errno.ENOENT:
2257
 
                    # the path does not exist: let _process_entry know that.
2258
 
                    root_dir_info = None
2259
 
                else:
2260
 
                    # some other random error: hand it up.
2261
 
                    raise
2262
 
            else:
2263
 
                root_dir_info = ('', current_root,
2264
 
                    osutils.file_kind_from_stat_mode(root_stat.st_mode), root_stat,
2265
 
                    root_abspath)
2266
 
                if root_dir_info[2] == 'directory':
2267
 
                    if self.target._directory_is_tree_reference(
2268
 
                        current_root.decode('utf8')):
2269
 
                        root_dir_info = root_dir_info[:2] + \
2270
 
                            ('tree-reference',) + root_dir_info[3:]
2271
 
 
2272
 
            if not root_entries and not root_dir_info:
2273
 
                # this specified path is not present at all, skip it.
2274
 
                continue
2275
 
            path_handled = False
2276
 
            for entry in root_entries:
2277
 
                result = _process_entry(entry, root_dir_info)
2278
 
                if result is not None:
2279
 
                    path_handled = True
2280
 
                    if result is not uninteresting:
2281
 
                        yield result
2282
 
            if want_unversioned and not path_handled and root_dir_info:
2283
 
                new_executable = bool(
2284
 
                    stat.S_ISREG(root_dir_info[3].st_mode)
2285
 
                    and stat.S_IEXEC & root_dir_info[3].st_mode)
2286
 
                yield (None,
2287
 
                       (None, current_root_unicode),
2288
 
                       True,
2289
 
                       (False, False),
2290
 
                       (None, None),
2291
 
                       (None, splitpath(current_root_unicode)[-1]),
2292
 
                       (None, root_dir_info[2]),
2293
 
                       (None, new_executable)
2294
 
                      )
2295
 
            initial_key = (current_root, '', '')
2296
 
            block_index, _ = state._find_block_index_from_key(initial_key)
2297
 
            if block_index == 0:
2298
 
                # we have processed the total root already, but because the
2299
 
                # initial key matched it we should skip it here.
2300
 
                block_index +=1
2301
 
            if root_dir_info and root_dir_info[2] == 'tree-reference':
2302
 
                current_dir_info = None
2303
 
            else:
2304
 
                dir_iterator = osutils._walkdirs_utf8(root_abspath, prefix=current_root)
2305
 
                try:
2306
 
                    current_dir_info = dir_iterator.next()
2307
 
                except OSError, e:
2308
 
                    # on win32, python2.4 has e.errno == ERROR_DIRECTORY, but
2309
 
                    # python 2.5 has e.errno == EINVAL,
2310
 
                    #            and e.winerror == ERROR_DIRECTORY
2311
 
                    e_winerror = getattr(e, 'winerror', None)
2312
 
                    win_errors = (ERROR_DIRECTORY, ERROR_PATH_NOT_FOUND)
2313
 
                    # there may be directories in the inventory even though
2314
 
                    # this path is not a file on disk: so mark it as end of
2315
 
                    # iterator
2316
 
                    if e.errno in (errno.ENOENT, errno.ENOTDIR, errno.EINVAL):
2317
 
                        current_dir_info = None
2318
 
                    elif (sys.platform == 'win32'
2319
 
                          and (e.errno in win_errors
2320
 
                               or e_winerror in win_errors)):
2321
 
                        current_dir_info = None
2322
 
                    else:
2323
 
                        raise
2324
 
                else:
2325
 
                    if current_dir_info[0][0] == '':
2326
 
                        # remove .bzr from iteration
2327
 
                        bzr_index = bisect_left(current_dir_info[1], ('.bzr',))
2328
 
                        if current_dir_info[1][bzr_index][0] != '.bzr':
2329
 
                            raise AssertionError()
2330
 
                        del current_dir_info[1][bzr_index]
2331
 
            # walk until both the directory listing and the versioned metadata
2332
 
            # are exhausted. 
2333
 
            if (block_index < len(state._dirblocks) and
2334
 
                osutils.is_inside(current_root, state._dirblocks[block_index][0])):
2335
 
                current_block = state._dirblocks[block_index]
2336
 
            else:
2337
 
                current_block = None
2338
 
            while (current_dir_info is not None or
2339
 
                   current_block is not None):
2340
 
                if (current_dir_info and current_block
2341
 
                    and current_dir_info[0][0] != current_block[0]):
2342
 
                    if cmp_by_dirs(current_dir_info[0][0], current_block[0]) < 0:
2343
 
                        # filesystem data refers to paths not covered by the dirblock.
2344
 
                        # this has two possibilities:
2345
 
                        # A) it is versioned but empty, so there is no block for it
2346
 
                        # B) it is not versioned.
2347
 
 
2348
 
                        # if (A) then we need to recurse into it to check for
2349
 
                        # new unknown files or directories.
2350
 
                        # if (B) then we should ignore it, because we don't
2351
 
                        # recurse into unknown directories.
2352
 
                        path_index = 0
2353
 
                        while path_index < len(current_dir_info[1]):
2354
 
                                current_path_info = current_dir_info[1][path_index]
2355
 
                                if want_unversioned:
2356
 
                                    if current_path_info[2] == 'directory':
2357
 
                                        if self.target._directory_is_tree_reference(
2358
 
                                            current_path_info[0].decode('utf8')):
2359
 
                                            current_path_info = current_path_info[:2] + \
2360
 
                                                ('tree-reference',) + current_path_info[3:]
2361
 
                                    new_executable = bool(
2362
 
                                        stat.S_ISREG(current_path_info[3].st_mode)
2363
 
                                        and stat.S_IEXEC & current_path_info[3].st_mode)
2364
 
                                    yield (None,
2365
 
                                        (None, utf8_decode(current_path_info[0])[0]),
2366
 
                                        True,
2367
 
                                        (False, False),
2368
 
                                        (None, None),
2369
 
                                        (None, utf8_decode(current_path_info[1])[0]),
2370
 
                                        (None, current_path_info[2]),
2371
 
                                        (None, new_executable))
2372
 
                                # dont descend into this unversioned path if it is
2373
 
                                # a dir
2374
 
                                if current_path_info[2] in ('directory',
2375
 
                                                            'tree-reference'):
2376
 
                                    del current_dir_info[1][path_index]
2377
 
                                    path_index -= 1
2378
 
                                path_index += 1
2379
 
 
2380
 
                        # This dir info has been handled, go to the next
2381
 
                        try:
2382
 
                            current_dir_info = dir_iterator.next()
2383
 
                        except StopIteration:
2384
 
                            current_dir_info = None
2385
 
                    else:
2386
 
                        # We have a dirblock entry for this location, but there
2387
 
                        # is no filesystem path for this. This is most likely
2388
 
                        # because a directory was removed from the disk.
2389
 
                        # We don't have to report the missing directory,
2390
 
                        # because that should have already been handled, but we
2391
 
                        # need to handle all of the files that are contained
2392
 
                        # within.
2393
 
                        for current_entry in current_block[1]:
2394
 
                            # entry referring to file not present on disk.
2395
 
                            # advance the entry only, after processing.
2396
 
                            result = _process_entry(current_entry, None)
2397
 
                            if result is not None:
2398
 
                                if result is not uninteresting:
2399
 
                                    yield result
2400
 
                        block_index +=1
2401
 
                        if (block_index < len(state._dirblocks) and
2402
 
                            osutils.is_inside(current_root,
2403
 
                                              state._dirblocks[block_index][0])):
2404
 
                            current_block = state._dirblocks[block_index]
2405
 
                        else:
2406
 
                            current_block = None
2407
 
                    continue
2408
 
                entry_index = 0
2409
 
                if current_block and entry_index < len(current_block[1]):
2410
 
                    current_entry = current_block[1][entry_index]
2411
 
                else:
2412
 
                    current_entry = None
2413
 
                advance_entry = True
2414
 
                path_index = 0
2415
 
                if current_dir_info and path_index < len(current_dir_info[1]):
2416
 
                    current_path_info = current_dir_info[1][path_index]
2417
 
                    if current_path_info[2] == 'directory':
2418
 
                        if self.target._directory_is_tree_reference(
2419
 
                            current_path_info[0].decode('utf8')):
2420
 
                            current_path_info = current_path_info[:2] + \
2421
 
                                ('tree-reference',) + current_path_info[3:]
2422
 
                else:
2423
 
                    current_path_info = None
2424
 
                advance_path = True
2425
 
                path_handled = False
2426
 
                while (current_entry is not None or
2427
 
                    current_path_info is not None):
2428
 
                    if current_entry is None:
2429
 
                        # the check for path_handled when the path is adnvaced
2430
 
                        # will yield this path if needed.
2431
 
                        pass
2432
 
                    elif current_path_info is None:
2433
 
                        # no path is fine: the per entry code will handle it.
2434
 
                        result = _process_entry(current_entry, current_path_info)
2435
 
                        if result is not None:
2436
 
                            if result is not uninteresting:
2437
 
                                yield result
2438
 
                    elif (current_entry[0][1] != current_path_info[1]
2439
 
                          or current_entry[1][target_index][0] in 'ar'):
2440
 
                        # The current path on disk doesn't match the dirblock
2441
 
                        # record. Either the dirblock is marked as absent, or
2442
 
                        # the file on disk is not present at all in the
2443
 
                        # dirblock. Either way, report about the dirblock
2444
 
                        # entry, and let other code handle the filesystem one.
2445
 
 
2446
 
                        # Compare the basename for these files to determine
2447
 
                        # which comes first
2448
 
                        if current_path_info[1] < current_entry[0][1]:
2449
 
                            # extra file on disk: pass for now, but only
2450
 
                            # increment the path, not the entry
2451
 
                            advance_entry = False
2452
 
                        else:
2453
 
                            # entry referring to file not present on disk.
2454
 
                            # advance the entry only, after processing.
2455
 
                            result = _process_entry(current_entry, None)
2456
 
                            if result is not None:
2457
 
                                if result is not uninteresting:
2458
 
                                    yield result
2459
 
                            advance_path = False
2460
 
                    else:
2461
 
                        result = _process_entry(current_entry, current_path_info)
2462
 
                        if result is not None:
2463
 
                            path_handled = True
2464
 
                            if result is not uninteresting:
2465
 
                                yield result
2466
 
                    if advance_entry and current_entry is not None:
2467
 
                        entry_index += 1
2468
 
                        if entry_index < len(current_block[1]):
2469
 
                            current_entry = current_block[1][entry_index]
2470
 
                        else:
2471
 
                            current_entry = None
2472
 
                    else:
2473
 
                        advance_entry = True # reset the advance flaga
2474
 
                    if advance_path and current_path_info is not None:
2475
 
                        if not path_handled:
2476
 
                            # unversioned in all regards
2477
 
                            if want_unversioned:
2478
 
                                new_executable = bool(
2479
 
                                    stat.S_ISREG(current_path_info[3].st_mode)
2480
 
                                    and stat.S_IEXEC & current_path_info[3].st_mode)
2481
 
                                try:
2482
 
                                    relpath_unicode = utf8_decode(current_path_info[0])[0]
2483
 
                                except UnicodeDecodeError:
2484
 
                                    raise errors.BadFilenameEncoding(
2485
 
                                        current_path_info[0], osutils._fs_enc)
2486
 
                                yield (None,
2487
 
                                    (None, relpath_unicode),
2488
 
                                    True,
2489
 
                                    (False, False),
2490
 
                                    (None, None),
2491
 
                                    (None, utf8_decode(current_path_info[1])[0]),
2492
 
                                    (None, current_path_info[2]),
2493
 
                                    (None, new_executable))
2494
 
                            # dont descend into this unversioned path if it is
2495
 
                            # a dir
2496
 
                            if current_path_info[2] in ('directory'):
2497
 
                                del current_dir_info[1][path_index]
2498
 
                                path_index -= 1
2499
 
                        # dont descend the disk iterator into any tree 
2500
 
                        # paths.
2501
 
                        if current_path_info[2] == 'tree-reference':
2502
 
                            del current_dir_info[1][path_index]
2503
 
                            path_index -= 1
2504
 
                        path_index += 1
2505
 
                        if path_index < len(current_dir_info[1]):
2506
 
                            current_path_info = current_dir_info[1][path_index]
2507
 
                            if current_path_info[2] == 'directory':
2508
 
                                if self.target._directory_is_tree_reference(
2509
 
                                    current_path_info[0].decode('utf8')):
2510
 
                                    current_path_info = current_path_info[:2] + \
2511
 
                                        ('tree-reference',) + current_path_info[3:]
2512
 
                        else:
2513
 
                            current_path_info = None
2514
 
                        path_handled = False
2515
 
                    else:
2516
 
                        advance_path = True # reset the advance flagg.
2517
 
                if current_block is not None:
2518
 
                    block_index += 1
2519
 
                    if (block_index < len(state._dirblocks) and
2520
 
                        osutils.is_inside(current_root, state._dirblocks[block_index][0])):
2521
 
                        current_block = state._dirblocks[block_index]
2522
 
                    else:
2523
 
                        current_block = None
2524
 
                if current_dir_info is not None:
2525
 
                    try:
2526
 
                        current_dir_info = dir_iterator.next()
2527
 
                    except StopIteration:
2528
 
                        current_dir_info = None
 
2251
        iter_changes = self.target._iter_changes(include_unchanged,
 
2252
            use_filesystem_for_exec, search_specific_files, state,
 
2253
            source_index, target_index, want_unversioned, self.target)
 
2254
        return iter_changes.iter_changes()
2529
2255
 
2530
2256
    @staticmethod
2531
2257
    def is_compatible(source, target):
2532
2258
        # the target must be a dirstate working tree
2533
 
        if not isinstance(target, WorkingTree4):
 
2259
        if not isinstance(target, DirStateWorkingTree):
2534
2260
            return False
2535
 
        # the source must be a revtreee or dirstate rev tree.
 
2261
        # the source must be a revtree or dirstate rev tree.
2536
2262
        if not isinstance(source,
2537
2263
            (revisiontree.RevisionTree, DirStateRevisionTree)):
2538
2264
            return False
2539
2265
        # the source revid must be in the target dirstate
2540
 
        if not (source._revision_id == NULL_REVISION or
 
2266
        if not (source._revision_id == _mod_revision.NULL_REVISION or
2541
2267
            source._revision_id in target.get_parent_ids()):
2542
 
            # TODO: what about ghosts? it may well need to 
 
2268
            # TODO: what about ghosts? it may well need to
2543
2269
            # check for them explicitly.
2544
2270
            return False
2545
2271
        return True
2555
2281
 
2556
2282
    def convert(self, tree):
2557
2283
        # lock the control files not the tree, so that we dont get tree
2558
 
        # on-unlock behaviours, and so that noone else diddles with the 
 
2284
        # on-unlock behaviours, and so that noone else diddles with the
2559
2285
        # tree during upgrade.
2560
2286
        tree._control_files.lock_write()
2561
2287
        try:
2588
2314
    def update_format(self, tree):
2589
2315
        """Change the format marker."""
2590
2316
        tree._transport.put_bytes('format',
2591
 
            self.target_format.get_format_string(),
 
2317
            self.target_format.as_string(),
 
2318
            mode=tree.bzrdir._get_file_mode())
 
2319
 
 
2320
 
 
2321
class Converter4to5(object):
 
2322
    """Perform an in-place upgrade of format 4 to format 5 trees."""
 
2323
 
 
2324
    def __init__(self):
 
2325
        self.target_format = WorkingTreeFormat5()
 
2326
 
 
2327
    def convert(self, tree):
 
2328
        # lock the control files not the tree, so that we don't get tree
 
2329
        # on-unlock behaviours, and so that no-one else diddles with the
 
2330
        # tree during upgrade.
 
2331
        tree._control_files.lock_write()
 
2332
        try:
 
2333
            self.update_format(tree)
 
2334
        finally:
 
2335
            tree._control_files.unlock()
 
2336
 
 
2337
    def update_format(self, tree):
 
2338
        """Change the format marker."""
 
2339
        tree._transport.put_bytes('format',
 
2340
            self.target_format.as_string(),
 
2341
            mode=tree.bzrdir._get_file_mode())
 
2342
 
 
2343
 
 
2344
class Converter4or5to6(object):
 
2345
    """Perform an in-place upgrade of format 4 or 5 to format 6 trees."""
 
2346
 
 
2347
    def __init__(self):
 
2348
        self.target_format = WorkingTreeFormat6()
 
2349
 
 
2350
    def convert(self, tree):
 
2351
        # lock the control files not the tree, so that we don't get tree
 
2352
        # on-unlock behaviours, and so that no-one else diddles with the
 
2353
        # tree during upgrade.
 
2354
        tree._control_files.lock_write()
 
2355
        try:
 
2356
            self.init_custom_control_files(tree)
 
2357
            self.update_format(tree)
 
2358
        finally:
 
2359
            tree._control_files.unlock()
 
2360
 
 
2361
    def init_custom_control_files(self, tree):
 
2362
        """Initialize custom control files."""
 
2363
        tree._transport.put_bytes('views', '',
 
2364
            mode=tree.bzrdir._get_file_mode())
 
2365
 
 
2366
    def update_format(self, tree):
 
2367
        """Change the format marker."""
 
2368
        tree._transport.put_bytes('format',
 
2369
            self.target_format.as_string(),
2592
2370
            mode=tree.bzrdir._get_file_mode())