~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree_4.py

  • Committer: Martin Pool
  • Date: 2007-04-04 06:17:31 UTC
  • mto: This revision was merged to the branch mainline in revision 2397.
  • Revision ID: mbp@sourcefrog.net-20070404061731-tt2xrzllqhbodn83
Contents of TODO file moved into bug tracker

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""WorkingTree4 format and implementation.
18
18
 
43
43
    bzrdir,
44
44
    cache_utf8,
45
45
    conflicts as _mod_conflicts,
46
 
    debug,
47
46
    delta,
48
47
    dirstate,
49
48
    errors,
50
49
    generate_ids,
51
50
    globbing,
 
51
    hashcache,
52
52
    ignores,
53
53
    merge,
54
54
    osutils,
55
 
    revision as _mod_revision,
56
55
    revisiontree,
57
56
    textui,
58
 
    trace,
59
57
    transform,
60
58
    urlutils,
61
 
    views,
62
59
    xml5,
63
60
    xml6,
64
61
    )
69
66
 
70
67
from bzrlib import symbol_versioning
71
68
from bzrlib.decorators import needs_read_lock, needs_write_lock
72
 
from bzrlib.filters import filtered_input_file, internal_size_sha_file_byname
73
69
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, entry_factory
 
70
from bzrlib.lockable_files import LockableFiles, TransportLock
 
71
from bzrlib.lockdir import LockDir
74
72
import bzrlib.mutabletree
75
73
from bzrlib.mutabletree import needs_tree_write_lock
76
74
from bzrlib.osutils import (
98
96
from bzrlib.workingtree import WorkingTree, WorkingTree3, WorkingTreeFormat3
99
97
 
100
98
 
101
 
class DirStateWorkingTree(WorkingTree3):
 
99
# This is the Windows equivalent of ENOTDIR
 
100
# It is defined in pywin32.winerror, but we don't want a strong dependency for
 
101
# just an error code.
 
102
ERROR_DIRECTORY = 267
 
103
 
 
104
 
 
105
class WorkingTree4(WorkingTree3):
 
106
    """This is the Format 4 working tree.
 
107
 
 
108
    This differs from WorkingTree3 by:
 
109
     - Having a consolidated internal dirstate, stored in a
 
110
       randomly-accessible sorted file on disk.
 
111
     - Not having a regular inventory attribute.  One can be synthesized 
 
112
       on demand but this is expensive and should be avoided.
 
113
 
 
114
    This is new in bzr 0.15.
 
115
    """
 
116
 
102
117
    def __init__(self, basedir,
103
118
                 branch,
104
119
                 _control_files=None,
113
128
        """
114
129
        self._format = _format
115
130
        self.bzrdir = _bzrdir
 
131
        from bzrlib.trace import note, mutter
 
132
        assert isinstance(basedir, basestring), \
 
133
            "base directory %r is not a string" % basedir
116
134
        basedir = safe_unicode(basedir)
117
135
        mutter("opening working tree %r", basedir)
118
136
        self._branch = branch
 
137
        assert isinstance(self.branch, bzrlib.branch.Branch), \
 
138
            "branch %r is not a Branch" % self.branch
119
139
        self.basedir = realpath(basedir)
120
140
        # if branch is at our basedir and is a format 6 or less
121
141
        # assume all other formats have their own control files.
 
142
        assert isinstance(_control_files, LockableFiles), \
 
143
            "_control_files must be a LockableFiles, not %r" % _control_files
122
144
        self._control_files = _control_files
123
 
        self._transport = self._control_files._transport
124
145
        self._dirty = None
125
146
        #-------------
126
147
        # during a read or write lock these objects are set, and are
128
149
        self._dirstate = None
129
150
        self._inventory = None
130
151
        #-------------
131
 
        self._setup_directory_is_tree_reference()
132
 
        self._detect_case_handling()
133
 
        self._rules_searcher = None
134
 
        self.views = self._make_views()
135
 
        #--- allow tests to select the dirstate iter_changes implementation
136
 
        self._iter_changes = dirstate._process_entry
137
152
 
138
153
    @needs_tree_write_lock
139
154
    def _add(self, files, ids, kinds):
141
156
        state = self.current_dirstate()
142
157
        for f, file_id, kind in zip(files, ids, kinds):
143
158
            f = f.strip('/')
 
159
            assert '//' not in f
 
160
            assert '..' not in f
144
161
            if self.path2id(f):
145
162
                # special case tree root handling.
146
163
                if f == '' and self.path2id(f) == ROOT_ID:
167
184
    @needs_tree_write_lock
168
185
    def add_reference(self, sub_tree):
169
186
        # use standard implementation, which calls back to self._add
170
 
        #
 
187
        # 
171
188
        # So we don't store the reference_revision in the working dirstate,
172
 
        # it's just recorded at the moment of commit.
 
189
        # it's just recorded at the moment of commit. 
173
190
        self._add_reference(sub_tree)
174
191
 
175
192
    def break_lock(self):
214
231
            WorkingTree3._comparison_data(self, entry, path)
215
232
        # it looks like a plain directory, but it's really a reference -- see
216
233
        # also kind()
217
 
        if (self._repo_supports_tree_reference and kind == 'directory'
218
 
            and entry is not None and entry.kind == 'tree-reference'):
 
234
        if (self._repo_supports_tree_reference and
 
235
            kind == 'directory' and
 
236
            self._directory_is_tree_reference(path)):
219
237
            kind = 'tree-reference'
220
238
        return kind, executable, stat_value
221
239
 
247
265
            return self._dirstate
248
266
        local_path = self.bzrdir.get_workingtree_transport(None
249
267
            ).local_abspath('dirstate')
250
 
        self._dirstate = dirstate.DirState.on_file(local_path,
251
 
            self._sha1_provider())
 
268
        self._dirstate = dirstate.DirState.on_file(local_path)
252
269
        return self._dirstate
253
270
 
254
 
    def _sha1_provider(self):
255
 
        """A function that returns a SHA1Provider suitable for this tree.
256
 
 
257
 
        :return: None if content filtering is not supported by this tree.
258
 
          Otherwise, a SHA1Provider is returned that sha's the canonical
259
 
          form of files, i.e. after read filters are applied.
260
 
        """
261
 
        if self.supports_content_filtering():
262
 
            return ContentFilterAwareSHA1Provider(self)
263
 
        else:
264
 
            return None
 
271
    def _directory_is_tree_reference(self, relpath):
 
272
        # as a special case, if a directory contains control files then 
 
273
        # it's a tree reference, except that the root of the tree is not
 
274
        return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
 
275
        # TODO: We could ask all the control formats whether they
 
276
        # recognize this directory, but at the moment there's no cheap api
 
277
        # to do that.  Since we probably can only nest bzr checkouts and
 
278
        # they always use this name it's ok for now.  -- mbp 20060306
 
279
        #
 
280
        # FIXME: There is an unhandled case here of a subdirectory
 
281
        # containing .bzr but not a branch; that will probably blow up
 
282
        # when you try to commit it.  It might happen if there is a
 
283
        # checkout in a subdirectory.  This can be avoided by not adding
 
284
        # it.  mbp 20070306
265
285
 
266
286
    def filter_unversioned_files(self, paths):
267
287
        """Filter out paths that are versioned.
300
320
 
301
321
    def _generate_inventory(self):
302
322
        """Create and set self.inventory from the dirstate object.
303
 
 
 
323
        
304
324
        This is relatively expensive: we have to walk the entire dirstate.
305
325
        Ideally we would not, and can deprecate this function.
306
326
        """
310
330
        state._read_dirblocks_if_needed()
311
331
        root_key, current_entry = self._get_entry(path='')
312
332
        current_id = root_key[2]
313
 
        if not (current_entry[0][0] == 'd'): # directory
314
 
            raise AssertionError(current_entry)
 
333
        assert current_entry[0][0] == 'd' # directory
315
334
        inv = Inventory(root_id=current_id)
316
335
        # Turn some things into local variables
317
336
        minikind_to_kind = dirstate.DirState._minikind_to_kind
350
369
                    # add this entry to the parent map.
351
370
                    parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
352
371
                elif kind == 'tree-reference':
353
 
                    if not self._repo_supports_tree_reference:
354
 
                        raise errors.UnsupportedOperation(
355
 
                            self._generate_inventory,
356
 
                            self.branch.repository)
 
372
                    assert self._repo_supports_tree_reference, \
 
373
                        "repository of %r " \
 
374
                        "doesn't support tree references " \
 
375
                        "required by entry %r" \
 
376
                        % (self, name)
357
377
                    inv_entry.reference_revision = link_or_sha1 or None
358
378
                elif kind != 'symlink':
359
379
                    raise AssertionError("unknown kind %r" % kind)
360
380
                # These checks cost us around 40ms on a 55k entry tree
361
 
                if file_id in inv_byid:
362
 
                    raise AssertionError('file_id %s already in'
363
 
                        ' inventory as %s' % (file_id, inv_byid[file_id]))
364
 
                if name_unicode in parent_ie.children:
365
 
                    raise AssertionError('name %r already in parent'
366
 
                        % (name_unicode,))
 
381
                assert file_id not in inv_byid, ('file_id %s already in'
 
382
                    ' inventory as %s' % (file_id, inv_byid[file_id]))
 
383
                assert name_unicode not in parent_ie.children
367
384
                inv_byid[file_id] = inv_entry
368
385
                parent_ie.children[name_unicode] = inv_entry
369
386
        self._inventory = inv
374
391
        If either file_id or path is supplied, it is used as the key to lookup.
375
392
        If both are supplied, the fastest lookup is used, and an error is
376
393
        raised if they do not both point at the same row.
377
 
 
 
394
        
378
395
        :param file_id: An optional unicode file_id to be looked up.
379
396
        :param path: An optional unicode path to be looked up.
380
397
        :return: The dirstate row tuple for path/file_id, or (None, None)
389
406
    def get_file_sha1(self, file_id, path=None, stat_value=None):
390
407
        # check file id is valid unconditionally.
391
408
        entry = self._get_entry(file_id=file_id, path=path)
392
 
        if entry[0] is None:
393
 
            raise errors.NoSuchId(self, file_id)
 
409
        assert entry[0] is not None, 'what error should this raise'
394
410
        if path is None:
395
411
            path = pathjoin(entry[0][0], entry[0][1]).decode('utf8')
396
412
 
397
413
        file_abspath = self.abspath(path)
398
414
        state = self.current_dirstate()
399
 
        if stat_value is None:
400
 
            try:
401
 
                stat_value = os.lstat(file_abspath)
402
 
            except OSError, e:
403
 
                if e.errno == errno.ENOENT:
404
 
                    return None
405
 
                else:
406
 
                    raise
407
 
        link_or_sha1 = dirstate.update_entry(state, entry, file_abspath,
408
 
            stat_value=stat_value)
 
415
        link_or_sha1 = state.update_entry(entry, file_abspath,
 
416
                                          stat_value=stat_value)
409
417
        if entry[1][0][0] == 'f':
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
 
418
            return link_or_sha1
420
419
        return None
421
420
 
422
421
    def _get_inventory(self):
423
422
        """Get the inventory for the tree. This is only valid within a lock."""
424
 
        if 'evil' in debug.debug_flags:
425
 
            trace.mutter_callsite(2,
426
 
                "accessing .inventory forces a size of tree translation.")
427
423
        if self._inventory is not None:
428
424
            return self._inventory
429
425
        self._must_be_locked()
436
432
    @needs_read_lock
437
433
    def get_parent_ids(self):
438
434
        """See Tree.get_parent_ids.
439
 
 
 
435
        
440
436
        This implementation requests the ids list from the dirstate file.
441
437
        """
442
438
        return self.current_dirstate().get_parent_ids()
458
454
 
459
455
    def has_id(self, file_id):
460
456
        state = self.current_dirstate()
 
457
        file_id = osutils.safe_file_id(file_id)
461
458
        row, parents = self._get_entry(file_id=file_id)
462
459
        if row is None:
463
460
            return False
466
463
 
467
464
    @needs_read_lock
468
465
    def id2path(self, file_id):
469
 
        "Convert a file-id to a path."
 
466
        file_id = osutils.safe_file_id(file_id)
470
467
        state = self.current_dirstate()
471
468
        entry = self._get_entry(file_id=file_id)
472
469
        if entry == (None, None):
474
471
        path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
475
472
        return path_utf8.decode('utf8')
476
473
 
477
 
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
478
 
        entry = self._get_entry(path=path)
479
 
        if entry == (None, None):
480
 
            return False # Missing entries are not executable
481
 
        return entry[1][0][3] # Executable?
482
 
 
483
474
    if not osutils.supports_executable():
 
475
        @needs_read_lock
484
476
        def is_executable(self, file_id, path=None):
485
 
            """Test if a file is executable or not.
486
 
 
487
 
            Note: The caller is expected to take a read-lock before calling this.
488
 
            """
 
477
            file_id = osutils.safe_file_id(file_id)
489
478
            entry = self._get_entry(file_id=file_id, path=path)
490
479
            if entry == (None, None):
491
480
                return False
492
481
            return entry[1][0][3]
493
 
 
494
 
        _is_executable_from_path_and_stat = \
495
 
            _is_executable_from_path_and_stat_from_basis
496
482
    else:
 
483
        @needs_read_lock
497
484
        def is_executable(self, file_id, path=None):
498
 
            """Test if a file is executable or not.
499
 
 
500
 
            Note: The caller is expected to take a read-lock before calling this.
501
 
            """
502
 
            self._must_be_locked()
503
485
            if not path:
 
486
                file_id = osutils.safe_file_id(file_id)
504
487
                path = self.id2path(file_id)
505
488
            mode = os.lstat(self.abspath(path)).st_mode
506
489
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
507
490
 
508
 
    def all_file_ids(self):
509
 
        """See Tree.iter_all_file_ids"""
510
 
        self._must_be_locked()
511
 
        result = set()
512
 
        for key, tree_details in self.current_dirstate()._iter_entries():
513
 
            if tree_details[0][0] in ('a', 'r'): # relocated
514
 
                continue
515
 
            result.add(key[2])
516
 
        return result
517
 
 
518
491
    @needs_read_lock
519
492
    def __iter__(self):
520
493
        """Iterate through file_ids for this tree.
533
506
        return iter(result)
534
507
 
535
508
    def iter_references(self):
536
 
        if not self._repo_supports_tree_reference:
537
 
            # When the repo doesn't support references, we will have nothing to
538
 
            # return
539
 
            return
540
509
        for key, tree_details in self.current_dirstate()._iter_entries():
541
510
            if tree_details[0][0] in ('a', 'r'): # absent, relocated
542
511
                # not relevant to the working tree
544
513
            if not key[1]:
545
514
                # the root is not a reference.
546
515
                continue
547
 
            relpath = pathjoin(key[0].decode('utf8'), key[1].decode('utf8'))
 
516
            path = pathjoin(self.basedir, key[0].decode('utf8'), key[1].decode('utf8'))
548
517
            try:
549
 
                if self._kind(relpath) == 'tree-reference':
550
 
                    yield relpath, key[2]
 
518
                if self._kind(path) == 'tree-reference':
 
519
                    yield path, key[2]
551
520
            except errors.NoSuchFile:
552
521
                # path is missing on disk.
553
522
                continue
554
523
 
555
 
    def _observed_sha1(self, file_id, path, (sha1, statvalue)):
556
 
        """See MutableTree._observed_sha1."""
557
 
        state = self.current_dirstate()
558
 
        entry = self._get_entry(file_id=file_id, path=path)
559
 
        state._observed_sha1(entry, sha1, statvalue)
560
 
 
 
524
    @needs_read_lock
561
525
    def kind(self, file_id):
562
526
        """Return the kind of a file.
563
527
 
564
528
        This is always the actual kind that's on disk, regardless of what it
565
529
        was added as.
566
 
 
567
 
        Note: The caller is expected to take a read-lock before calling this.
568
530
        """
569
531
        relpath = self.id2path(file_id)
570
 
        if relpath is None:
571
 
            raise AssertionError(
572
 
                "path for id {%s} is None!" % file_id)
 
532
        assert relpath != None, \
 
533
            "path for id {%s} is None!" % file_id
573
534
        return self._kind(relpath)
574
535
 
575
536
    def _kind(self, relpath):
576
537
        abspath = self.abspath(relpath)
577
538
        kind = file_kind(abspath)
578
 
        if (self._repo_supports_tree_reference and kind == 'directory'):
579
 
            entry = self._get_entry(path=relpath)
580
 
            if entry[1] is not None:
581
 
                if entry[1][0][0] == 't':
582
 
                    kind = 'tree-reference'
 
539
        if (self._repo_supports_tree_reference and
 
540
            kind == 'directory' and
 
541
            self._directory_is_tree_reference(relpath)):
 
542
            kind = 'tree-reference'
583
543
        return kind
584
544
 
585
545
    @needs_read_lock
589
549
        if parent_ids:
590
550
            return parent_ids[0]
591
551
        else:
592
 
            return _mod_revision.NULL_REVISION
 
552
            return None
593
553
 
594
554
    def lock_read(self):
595
555
        """See Branch.lock_read, and WorkingTree.unlock."""
648
608
        result = []
649
609
        if not from_paths:
650
610
            return result
 
611
 
651
612
        state = self.current_dirstate()
652
 
        if isinstance(from_paths, basestring):
653
 
            raise ValueError()
 
613
 
 
614
        assert not isinstance(from_paths, basestring)
654
615
        to_dir_utf8 = to_dir.encode('utf8')
655
616
        to_entry_dirname, to_basename = os.path.split(to_dir_utf8)
656
617
        id_index = state._get_id_index()
678
639
        if self._inventory is not None:
679
640
            update_inventory = True
680
641
            inv = self.inventory
 
642
            to_dir_ie = inv[to_dir_id]
681
643
            to_dir_id = to_entry[0][2]
682
 
            to_dir_ie = inv[to_dir_id]
683
644
        else:
684
645
            update_inventory = False
685
646
 
708
669
            new_entry = to_block[1][added_entry_index]
709
670
            rollbacks.append(lambda:state._make_absent(new_entry))
710
671
 
 
672
        # create rename entries and tuples
711
673
        for from_rel in from_paths:
712
674
            # from_rel is 'pathinroot/foo/bar'
713
675
            from_rel_utf8 = from_rel.encode('utf8')
749
711
                if from_missing: # implicitly just update our path mapping
750
712
                    move_file = False
751
713
                elif not after:
752
 
                    raise errors.RenameFailedFilesExist(from_rel, to_rel)
 
714
                    raise errors.RenameFailedFilesExist(from_rel, to_rel,
 
715
                        extra="(Use --after to update the Bazaar id)")
753
716
 
754
717
            rollbacks = []
755
718
            def rollback_rename():
810
773
 
811
774
                if minikind == 'd':
812
775
                    def update_dirblock(from_dir, to_key, to_dir_utf8):
813
 
                        """Recursively update all entries in this dirblock."""
814
 
                        if from_dir == '':
815
 
                            raise AssertionError("renaming root not supported")
 
776
                        """all entries in this block need updating.
 
777
 
 
778
                        TODO: This is pretty ugly, and doesn't support
 
779
                        reverting, but it works.
 
780
                        """
 
781
                        assert from_dir != '', "renaming root not supported"
816
782
                        from_key = (from_dir, '')
817
783
                        from_block_idx, present = \
818
784
                            state._find_block_index_from_key(from_key)
828
794
                        to_block_index = state._ensure_block(
829
795
                            to_block_index, to_entry_index, to_dir_utf8)
830
796
                        to_block = state._dirblocks[to_block_index]
831
 
 
832
 
                        # Grab a copy since move_one may update the list.
833
 
                        for entry in from_block[1][:]:
834
 
                            if not (entry[0][0] == from_dir):
835
 
                                raise AssertionError()
 
797
                        for entry in from_block[1]:
 
798
                            assert entry[0][0] == from_dir
836
799
                            cur_details = entry[1][0]
837
800
                            to_key = (to_dir_utf8, entry[0][1], entry[0][2])
838
801
                            from_path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
839
802
                            to_path_utf8 = osutils.pathjoin(to_dir_utf8, entry[0][1])
840
803
                            minikind = cur_details[0]
841
 
                            if minikind in 'ar':
842
 
                                # Deleted children of a renamed directory
843
 
                                # Do not need to be updated.
844
 
                                # Children that have been renamed out of this
845
 
                                # directory should also not be updated
846
 
                                continue
847
804
                            move_one(entry, from_path_utf8=from_path_utf8,
848
805
                                     minikind=minikind,
849
806
                                     executable=cur_details[3],
897
854
        for tree in trees:
898
855
            if not (isinstance(tree, DirStateRevisionTree) and tree._revision_id in
899
856
                parents):
900
 
                return super(DirStateWorkingTree, self).paths2ids(paths,
901
 
                    trees, require_versioned)
 
857
                return super(WorkingTree4, self).paths2ids(paths, trees, require_versioned)
902
858
        search_indexes = [0] + [1 + parents.index(tree._revision_id) for tree in trees]
903
859
        # -- make all paths utf8 --
904
860
        paths_utf8 = set()
964
920
            if not all_versioned:
965
921
                raise errors.PathsNotVersionedError(paths)
966
922
        # -- remove redundancy in supplied paths to prevent over-scanning --
967
 
        search_paths = osutils.minimum_path_selection(paths)
968
 
        # sketch:
 
923
        search_paths = set()
 
924
        for path in paths:
 
925
            other_paths = paths.difference(set([path]))
 
926
            if not osutils.is_inside_any(other_paths, path):
 
927
                # this is a top level path, we must check it.
 
928
                search_paths.add(path)
 
929
        # sketch: 
969
930
        # for all search_indexs in each path at or under each element of
970
931
        # search_paths, if the detail is relocated: add the id, and add the
971
932
        # relocated path as one to search if its not searched already. If the
1027
988
 
1028
989
    def read_working_inventory(self):
1029
990
        """Read the working inventory.
1030
 
 
 
991
        
1031
992
        This is a meaningless operation for dirstate, but we obey it anyhow.
1032
993
        """
1033
994
        return self.inventory
1038
999
 
1039
1000
        WorkingTree4 supplies revision_trees for any basis tree.
1040
1001
        """
 
1002
        revision_id = osutils.safe_revision_id(revision_id)
1041
1003
        dirstate = self.current_dirstate()
1042
1004
        parent_ids = dirstate.get_parent_ids()
1043
1005
        if revision_id not in parent_ids:
1050
1012
    @needs_tree_write_lock
1051
1013
    def set_last_revision(self, new_revision):
1052
1014
        """Change the last revision in the working tree."""
 
1015
        new_revision = osutils.safe_revision_id(new_revision)
1053
1016
        parents = self.get_parent_ids()
1054
1017
        if new_revision in (NULL_REVISION, None):
1055
 
            if len(parents) >= 2:
1056
 
                raise AssertionError(
1057
 
                    "setting the last parent to none with a pending merge is "
1058
 
                    "unsupported.")
 
1018
            assert len(parents) < 2, (
 
1019
                "setting the last parent to none with a pending merge is "
 
1020
                "unsupported.")
1059
1021
            self.set_parent_ids([])
1060
1022
        else:
1061
1023
            self.set_parent_ids([new_revision] + parents[1:],
1064
1026
    @needs_tree_write_lock
1065
1027
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
1066
1028
        """Set the parent ids to revision_ids.
1067
 
 
 
1029
        
1068
1030
        See also set_parent_trees. This api will try to retrieve the tree data
1069
1031
        for each element of revision_ids from the trees repository. If you have
1070
1032
        tree data already available, it is more efficient to use
1074
1036
        :param revision_ids: The revision_ids to set as the parent ids of this
1075
1037
            working tree. Any of these may be ghosts.
1076
1038
        """
 
1039
        revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1077
1040
        trees = []
1078
1041
        for revision_id in revision_ids:
1079
1042
            try:
1085
1048
            except (errors.NoSuchRevision, errors.RevisionNotPresent):
1086
1049
                revtree = None
1087
1050
            trees.append((revision_id, revtree))
 
1051
        self.current_dirstate()._validate()
1088
1052
        self.set_parent_trees(trees,
1089
1053
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
1054
        self.current_dirstate()._validate()
1090
1055
 
1091
1056
    @needs_tree_write_lock
1092
1057
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
1097
1062
            parent tree - i.e. a ghost.
1098
1063
        """
1099
1064
        dirstate = self.current_dirstate()
 
1065
        dirstate._validate()
1100
1066
        if len(parents_list) > 0:
1101
1067
            if not allow_leftmost_as_ghost and parents_list[0][1] is None:
1102
1068
                raise errors.GhostRevisionUnusableHere(parents_list[0][0])
1103
1069
        real_trees = []
1104
1070
        ghosts = []
1105
 
 
1106
 
        parent_ids = [rev_id for rev_id, tree in parents_list]
1107
 
        graph = self.branch.repository.get_graph()
1108
 
        heads = graph.heads(parent_ids)
1109
 
        accepted_revisions = set()
1110
 
 
1111
1071
        # convert absent trees to the null tree, which we convert back to
1112
1072
        # missing on access.
1113
1073
        for rev_id, tree in parents_list:
1114
 
            if len(accepted_revisions) > 0:
1115
 
                # we always accept the first tree
1116
 
                if rev_id in accepted_revisions or rev_id not in heads:
1117
 
                    # We have already included either this tree, or its
1118
 
                    # descendent, so we skip it.
1119
 
                    continue
1120
 
            _mod_revision.check_not_reserved_id(rev_id)
 
1074
            rev_id = osutils.safe_revision_id(rev_id)
1121
1075
            if tree is not None:
1122
1076
                real_trees.append((rev_id, tree))
1123
1077
            else:
1124
1078
                real_trees.append((rev_id,
1125
 
                    self.branch.repository.revision_tree(
1126
 
                        _mod_revision.NULL_REVISION)))
 
1079
                    self.branch.repository.revision_tree(None)))
1127
1080
                ghosts.append(rev_id)
1128
 
            accepted_revisions.add(rev_id)
 
1081
        dirstate._validate()
1129
1082
        dirstate.set_parent_trees(real_trees, ghosts=ghosts)
 
1083
        dirstate._validate()
1130
1084
        self._make_dirty(reset_inventory=False)
 
1085
        dirstate._validate()
1131
1086
 
1132
1087
    def _set_root_id(self, file_id):
1133
1088
        """See WorkingTree.set_root_id."""
1136
1091
        if state._dirblock_state == dirstate.DirState.IN_MEMORY_MODIFIED:
1137
1092
            self._make_dirty(reset_inventory=True)
1138
1093
 
1139
 
    def _sha_from_stat(self, path, stat_result):
1140
 
        """Get a sha digest from the tree's stat cache.
1141
 
 
1142
 
        The default implementation assumes no stat cache is present.
1143
 
 
1144
 
        :param path: The path.
1145
 
        :param stat_result: The stat result being looked up.
1146
 
        """
1147
 
        return self.current_dirstate().sha1_from_stat(path, stat_result)
1148
 
 
1149
1094
    @needs_read_lock
1150
1095
    def supports_tree_reference(self):
1151
1096
        return self._repo_supports_tree_reference
1152
1097
 
1153
1098
    def unlock(self):
1154
1099
        """Unlock in format 4 trees needs to write the entire dirstate."""
1155
 
        # do non-implementation specific cleanup
1156
 
        self._cleanup()
1157
 
 
1158
1100
        if self._control_files._lock_count == 1:
1159
1101
            # eventually we should do signature checking during read locks for
1160
1102
            # dirstate updates.
1191
1133
            return
1192
1134
        state = self.current_dirstate()
1193
1135
        state._read_dirblocks_if_needed()
1194
 
        ids_to_unversion = set(file_ids)
 
1136
        ids_to_unversion = set()
 
1137
        for file_id in file_ids:
 
1138
            ids_to_unversion.add(osutils.safe_file_id(file_id))
1195
1139
        paths_to_unversion = set()
1196
1140
        # sketch:
1197
1141
        # check if the root is to be unversioned, if so, assert for now.
1227
1171
                    # Mark this file id as having been removed
1228
1172
                    entry = block[1][entry_index]
1229
1173
                    ids_to_unversion.discard(entry[0][2])
1230
 
                    if (entry[1][0][0] in 'ar' # don't remove absent or renamed
1231
 
                                               # entries
 
1174
                    if (entry[1][0][0] == 'a'
1232
1175
                        or not state._make_absent(entry)):
1233
1176
                        entry_index += 1
1234
1177
                # go to the next block. (At the moment we dont delete empty
1259
1202
            for file_id in file_ids:
1260
1203
                self._inventory.remove_recursive_id(file_id)
1261
1204
 
1262
 
    @needs_tree_write_lock
1263
 
    def rename_one(self, from_rel, to_rel, after=False):
1264
 
        """See WorkingTree.rename_one"""
1265
 
        self.flush()
1266
 
        WorkingTree.rename_one(self, from_rel, to_rel, after)
1267
 
 
1268
 
    @needs_tree_write_lock
1269
 
    def apply_inventory_delta(self, changes):
1270
 
        """See MutableTree.apply_inventory_delta"""
1271
 
        state = self.current_dirstate()
1272
 
        state.update_by_delta(changes)
1273
 
        self._make_dirty(reset_inventory=True)
1274
 
 
1275
 
    def update_basis_by_delta(self, new_revid, delta):
1276
 
        """See MutableTree.update_basis_by_delta."""
1277
 
        if self.last_revision() == new_revid:
1278
 
            raise AssertionError()
1279
 
        self.current_dirstate().update_basis_by_delta(delta, new_revid)
1280
 
 
1281
1205
    @needs_read_lock
1282
1206
    def _validate(self):
1283
1207
        self._dirstate._validate()
1285
1209
    @needs_tree_write_lock
1286
1210
    def _write_inventory(self, inv):
1287
1211
        """Write inventory as the current inventory."""
1288
 
        if self._dirty:
1289
 
            raise AssertionError("attempting to write an inventory when the "
1290
 
                "dirstate is dirty will lose pending changes")
 
1212
        assert not self._dirty, "attempting to write an inventory when the dirstate is dirty will cause data loss"
1291
1213
        self.current_dirstate().set_state_from_inventory(inv)
1292
1214
        self._make_dirty(reset_inventory=False)
1293
1215
        if self._inventory is not None:
1295
1217
        self.flush()
1296
1218
 
1297
1219
 
1298
 
class ContentFilterAwareSHA1Provider(dirstate.SHA1Provider):
1299
 
 
1300
 
    def __init__(self, tree):
1301
 
        self.tree = tree
1302
 
 
1303
 
    def sha1(self, abspath):
1304
 
        """See dirstate.SHA1Provider.sha1()."""
1305
 
        filters = self.tree._content_filter_stack(
1306
 
            self.tree.relpath(osutils.safe_unicode(abspath)))
1307
 
        return internal_size_sha_file_byname(abspath, filters)[1]
1308
 
 
1309
 
    def stat_and_sha1(self, abspath):
1310
 
        """See dirstate.SHA1Provider.stat_and_sha1()."""
1311
 
        filters = self.tree._content_filter_stack(
1312
 
            self.tree.relpath(osutils.safe_unicode(abspath)))
1313
 
        file_obj = file(abspath, 'rb', 65000)
1314
 
        try:
1315
 
            statvalue = os.fstat(file_obj.fileno())
1316
 
            if filters:
1317
 
                file_obj = filtered_input_file(file_obj, filters)
1318
 
            sha1 = osutils.size_sha_file(file_obj)[1]
1319
 
        finally:
1320
 
            file_obj.close()
1321
 
        return statvalue, sha1
1322
 
 
1323
 
 
1324
 
class WorkingTree4(DirStateWorkingTree):
1325
 
    """This is the Format 4 working tree.
1326
 
 
1327
 
    This differs from WorkingTree3 by:
1328
 
     - Having a consolidated internal dirstate, stored in a
1329
 
       randomly-accessible sorted file on disk.
1330
 
     - Not having a regular inventory attribute.  One can be synthesized
1331
 
       on demand but this is expensive and should be avoided.
1332
 
 
1333
 
    This is new in bzr 0.15.
1334
 
    """
1335
 
 
1336
 
 
1337
 
class WorkingTree5(DirStateWorkingTree):
1338
 
    """This is the Format 5 working tree.
1339
 
 
1340
 
    This differs from WorkingTree4 by:
1341
 
     - Supporting content filtering.
1342
 
 
1343
 
    This is new in bzr 1.11.
1344
 
    """
1345
 
 
1346
 
 
1347
 
class WorkingTree6(DirStateWorkingTree):
1348
 
    """This is the Format 6 working tree.
1349
 
 
1350
 
    This differs from WorkingTree5 by:
1351
 
     - Supporting a current view that may mask the set of files in a tree
1352
 
       impacted by most user operations.
1353
 
 
1354
 
    This is new in bzr 1.14.
1355
 
    """
1356
 
 
1357
 
    def _make_views(self):
1358
 
        return views.PathBasedViews(self)
1359
 
 
1360
 
 
1361
 
class DirStateWorkingTreeFormat(WorkingTreeFormat3):
1362
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
1363
 
                   accelerator_tree=None, hardlink=False):
 
1220
class WorkingTreeFormat4(WorkingTreeFormat3):
 
1221
    """The first consolidated dirstate working tree format.
 
1222
 
 
1223
    This format:
 
1224
        - exists within a metadir controlling .bzr
 
1225
        - includes an explicit version marker for the workingtree control
 
1226
          files, separate from the BzrDir format
 
1227
        - modifies the hash cache format
 
1228
        - is new in bzr 0.15
 
1229
        - uses a LockDir to guard access to it.
 
1230
    """
 
1231
 
 
1232
    upgrade_recommended = False
 
1233
 
 
1234
    def get_format_string(self):
 
1235
        """See WorkingTreeFormat.get_format_string()."""
 
1236
        return "Bazaar Working Tree Format 4 (bzr 0.15)\n"
 
1237
 
 
1238
    def get_format_description(self):
 
1239
        """See WorkingTreeFormat.get_format_description()."""
 
1240
        return "Working tree format 4"
 
1241
 
 
1242
    def initialize(self, a_bzrdir, revision_id=None):
1364
1243
        """See WorkingTreeFormat.initialize().
1365
1244
 
1366
1245
        :param revision_id: allows creating a working tree at a different
1367
1246
        revision than the branch is at.
1368
 
        :param accelerator_tree: A tree which can be used for retrieving file
1369
 
            contents more quickly than the revision tree, i.e. a workingtree.
1370
 
            The revision tree will be used for cases where accelerator_tree's
1371
 
            content is different.
1372
 
        :param hardlink: If true, hard-link files from accelerator_tree,
1373
 
            where possible.
1374
1247
 
1375
 
        These trees get an initial random root id, if their repository supports
1376
 
        rich root data, TREE_ROOT otherwise.
 
1248
        These trees get an initial random root id.
1377
1249
        """
 
1250
        revision_id = osutils.safe_revision_id(revision_id)
1378
1251
        if not isinstance(a_bzrdir.transport, LocalTransport):
1379
1252
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
1380
1253
        transport = a_bzrdir.get_workingtree_transport(self)
1381
1254
        control_files = self._open_control_files(a_bzrdir)
1382
1255
        control_files.create_lock()
1383
1256
        control_files.lock_write()
1384
 
        transport.put_bytes('format', self.get_format_string(),
1385
 
            mode=a_bzrdir._get_file_mode())
1386
 
        if from_branch is not None:
1387
 
            branch = from_branch
1388
 
        else:
1389
 
            branch = a_bzrdir.open_branch()
 
1257
        control_files.put_utf8('format', self.get_format_string())
 
1258
        branch = a_bzrdir.open_branch()
1390
1259
        if revision_id is None:
1391
1260
            revision_id = branch.last_revision()
1392
1261
        local_path = transport.local_abspath('dirstate')
1394
1263
        state = dirstate.DirState.initialize(local_path)
1395
1264
        state.unlock()
1396
1265
        del state
1397
 
        wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
 
1266
        wt = WorkingTree4(a_bzrdir.root_transport.local_abspath('.'),
1398
1267
                         branch,
1399
1268
                         _format=self,
1400
1269
                         _bzrdir=a_bzrdir,
1401
1270
                         _control_files=control_files)
1402
1271
        wt._new_tree()
1403
1272
        wt.lock_tree_write()
 
1273
        wt.current_dirstate()._validate()
1404
1274
        try:
1405
 
            self._init_custom_control_files(wt)
1406
1275
            if revision_id in (None, NULL_REVISION):
1407
 
                if branch.repository.supports_rich_root():
1408
 
                    wt._set_root_id(generate_ids.gen_root_id())
1409
 
                else:
1410
 
                    wt._set_root_id(ROOT_ID)
 
1276
                wt._set_root_id(generate_ids.gen_root_id())
1411
1277
                wt.flush()
1412
 
            basis = None
1413
 
            # frequently, we will get here due to branching.  The accelerator
1414
 
            # tree will be the tree from the branch, so the desired basis
1415
 
            # tree will often be a parent of the accelerator tree.
1416
 
            if accelerator_tree is not None:
1417
 
                try:
1418
 
                    basis = accelerator_tree.revision_tree(revision_id)
1419
 
                except errors.NoSuchRevision:
1420
 
                    pass
1421
 
            if basis is None:
1422
 
                basis = branch.repository.revision_tree(revision_id)
1423
 
            if revision_id == NULL_REVISION:
1424
 
                parents_list = []
1425
 
            else:
1426
 
                parents_list = [(revision_id, basis)]
 
1278
                wt.current_dirstate()._validate()
 
1279
            wt.set_last_revision(revision_id)
 
1280
            wt.flush()
 
1281
            basis = wt.basis_tree()
1427
1282
            basis.lock_read()
1428
 
            try:
1429
 
                wt.set_parent_trees(parents_list, allow_leftmost_as_ghost=True)
 
1283
            # if the basis has a root id we have to use that; otherwise we use
 
1284
            # a new random one
 
1285
            basis_root_id = basis.get_root_id()
 
1286
            if basis_root_id is not None:
 
1287
                wt._set_root_id(basis_root_id)
1430
1288
                wt.flush()
1431
 
                # if the basis has a root id we have to use that; otherwise we
1432
 
                # use a new random one
1433
 
                basis_root_id = basis.get_root_id()
1434
 
                if basis_root_id is not None:
1435
 
                    wt._set_root_id(basis_root_id)
1436
 
                    wt.flush()
1437
 
                # delta_from_tree is safe even for DirStateRevisionTrees,
1438
 
                # because wt4.apply_inventory_delta does not mutate the input
1439
 
                # inventory entries.
1440
 
                transform.build_tree(basis, wt, accelerator_tree,
1441
 
                                     hardlink=hardlink, delta_from_tree=True)
1442
 
            finally:
1443
 
                basis.unlock()
 
1289
            transform.build_tree(basis, wt)
 
1290
            basis.unlock()
1444
1291
        finally:
1445
1292
            control_files.unlock()
1446
1293
            wt.unlock()
1447
1294
        return wt
1448
1295
 
1449
 
    def _init_custom_control_files(self, wt):
1450
 
        """Subclasses with custom control files should override this method.
1451
 
 
1452
 
        The working tree and control files are locked for writing when this
1453
 
        method is called.
1454
 
 
1455
 
        :param wt: the WorkingTree object
1456
 
        """
1457
 
 
1458
1296
    def _open(self, a_bzrdir, control_files):
1459
1297
        """Open the tree itself.
1460
1298
 
1461
1299
        :param a_bzrdir: the dir for the tree.
1462
1300
        :param control_files: the control files for the tree.
1463
1301
        """
1464
 
        return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
 
1302
        return WorkingTree4(a_bzrdir.root_transport.local_abspath('.'),
1465
1303
                           branch=a_bzrdir.open_branch(),
1466
1304
                           _format=self,
1467
1305
                           _bzrdir=a_bzrdir,
1468
1306
                           _control_files=control_files)
1469
1307
 
1470
1308
    def __get_matchingbzrdir(self):
1471
 
        return self._get_matchingbzrdir()
1472
 
 
1473
 
    def _get_matchingbzrdir(self):
1474
 
        """Overrideable method to get a bzrdir for testing."""
1475
1309
        # please test against something that will let us do tree references
1476
1310
        return bzrdir.format_registry.make_bzrdir(
1477
1311
            'dirstate-with-subtree')
1479
1313
    _matchingbzrdir = property(__get_matchingbzrdir)
1480
1314
 
1481
1315
 
1482
 
class WorkingTreeFormat4(DirStateWorkingTreeFormat):
1483
 
    """The first consolidated dirstate working tree format.
1484
 
 
1485
 
    This format:
1486
 
        - exists within a metadir controlling .bzr
1487
 
        - includes an explicit version marker for the workingtree control
1488
 
          files, separate from the BzrDir format
1489
 
        - modifies the hash cache format
1490
 
        - is new in bzr 0.15
1491
 
        - uses a LockDir to guard access to it.
1492
 
    """
1493
 
 
1494
 
    upgrade_recommended = False
1495
 
 
1496
 
    _tree_class = WorkingTree4
1497
 
 
1498
 
    def get_format_string(self):
1499
 
        """See WorkingTreeFormat.get_format_string()."""
1500
 
        return "Bazaar Working Tree Format 4 (bzr 0.15)\n"
1501
 
 
1502
 
    def get_format_description(self):
1503
 
        """See WorkingTreeFormat.get_format_description()."""
1504
 
        return "Working tree format 4"
1505
 
 
1506
 
 
1507
 
class WorkingTreeFormat5(DirStateWorkingTreeFormat):
1508
 
    """WorkingTree format supporting content filtering.
1509
 
    """
1510
 
 
1511
 
    upgrade_recommended = False
1512
 
 
1513
 
    _tree_class = WorkingTree5
1514
 
 
1515
 
    def get_format_string(self):
1516
 
        """See WorkingTreeFormat.get_format_string()."""
1517
 
        return "Bazaar Working Tree Format 5 (bzr 1.11)\n"
1518
 
 
1519
 
    def get_format_description(self):
1520
 
        """See WorkingTreeFormat.get_format_description()."""
1521
 
        return "Working tree format 5"
1522
 
 
1523
 
    def supports_content_filtering(self):
1524
 
        return True
1525
 
 
1526
 
 
1527
 
class WorkingTreeFormat6(DirStateWorkingTreeFormat):
1528
 
    """WorkingTree format supporting views.
1529
 
    """
1530
 
 
1531
 
    upgrade_recommended = False
1532
 
 
1533
 
    _tree_class = WorkingTree6
1534
 
 
1535
 
    def get_format_string(self):
1536
 
        """See WorkingTreeFormat.get_format_string()."""
1537
 
        return "Bazaar Working Tree Format 6 (bzr 1.14)\n"
1538
 
 
1539
 
    def get_format_description(self):
1540
 
        """See WorkingTreeFormat.get_format_description()."""
1541
 
        return "Working tree format 6"
1542
 
 
1543
 
    def _init_custom_control_files(self, wt):
1544
 
        """Subclasses with custom control files should override this method."""
1545
 
        wt._transport.put_bytes('views', '', mode=wt.bzrdir._get_file_mode())
1546
 
 
1547
 
    def supports_content_filtering(self):
1548
 
        return True
1549
 
 
1550
 
    def supports_views(self):
1551
 
        return True
1552
 
 
1553
 
 
1554
1316
class DirStateRevisionTree(Tree):
1555
1317
    """A revision tree pulling the inventory from a dirstate."""
1556
1318
 
1557
1319
    def __init__(self, dirstate, revision_id, repository):
1558
1320
        self._dirstate = dirstate
1559
 
        self._revision_id = revision_id
 
1321
        self._revision_id = osutils.safe_revision_id(revision_id)
1560
1322
        self._repository = repository
1561
1323
        self._inventory = None
1562
1324
        self._locked = 0
1563
1325
        self._dirstate_locked = False
1564
 
        self._repo_supports_tree_reference = getattr(
1565
 
            repository._format, "supports_tree_reference",
1566
 
            False)
1567
1326
 
1568
1327
    def __repr__(self):
1569
1328
        return "<%s of %s in %s>" % \
1570
1329
            (self.__class__.__name__, self._revision_id, self._dirstate)
1571
1330
 
1572
 
    def annotate_iter(self, file_id,
1573
 
                      default_revision=_mod_revision.CURRENT_REVISION):
 
1331
    def annotate_iter(self, file_id):
1574
1332
        """See Tree.annotate_iter"""
1575
 
        text_key = (file_id, self.inventory[file_id].revision)
1576
 
        annotations = self._repository.texts.annotate(text_key)
1577
 
        return [(key[-1], line) for (key, line) in annotations]
 
1333
        w = self._repository.weave_store.get_weave(file_id,
 
1334
                           self._repository.get_transaction())
 
1335
        return w.annotate_iter(self.inventory[file_id].revision)
1578
1336
 
1579
 
    def _get_ancestors(self, default_revision):
1580
 
        return set(self._repository.get_ancestry(self._revision_id,
1581
 
                                                 topo_sorted=False))
1582
1337
    def _comparison_data(self, entry, path):
1583
1338
        """See Tree._comparison_data."""
1584
1339
        if entry is None:
1601
1356
    def get_root_id(self):
1602
1357
        return self.path2id('')
1603
1358
 
1604
 
    def id2path(self, file_id):
1605
 
        "Convert a file-id to a path."
1606
 
        entry = self._get_entry(file_id=file_id)
1607
 
        if entry == (None, None):
1608
 
            raise errors.NoSuchId(tree=self, file_id=file_id)
1609
 
        path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
1610
 
        return path_utf8.decode('utf8')
1611
 
 
1612
 
    def iter_references(self):
1613
 
        if not self._repo_supports_tree_reference:
1614
 
            # When the repo doesn't support references, we will have nothing to
1615
 
            # return
1616
 
            return iter([])
1617
 
        # Otherwise, fall back to the default implementation
1618
 
        return super(DirStateRevisionTree, self).iter_references()
1619
 
 
1620
1359
    def _get_parent_index(self):
1621
1360
        """Return the index in the dirstate referenced by this tree."""
1622
1361
        return self._dirstate.get_parent_ids().index(self._revision_id) + 1
1627
1366
        If either file_id or path is supplied, it is used as the key to lookup.
1628
1367
        If both are supplied, the fastest lookup is used, and an error is
1629
1368
        raised if they do not both point at the same row.
1630
 
 
 
1369
        
1631
1370
        :param file_id: An optional unicode file_id to be looked up.
1632
1371
        :param path: An optional unicode path to be looked up.
1633
1372
        :return: The dirstate row tuple for path/file_id, or (None, None)
1634
1373
        """
1635
1374
        if file_id is None and path is None:
1636
1375
            raise errors.BzrError('must supply file_id or path')
 
1376
        file_id = osutils.safe_file_id(file_id)
1637
1377
        if path is not None:
1638
1378
            path = path.encode('utf8')
1639
1379
        parent_index = self._get_parent_index()
1647
1387
 
1648
1388
        This is relatively expensive: we have to walk the entire dirstate.
1649
1389
        """
1650
 
        if not self._locked:
1651
 
            raise AssertionError(
1652
 
                'cannot generate inventory of an unlocked '
1653
 
                'dirstate revision tree')
 
1390
        assert self._locked, 'cannot generate inventory of an unlocked '\
 
1391
            'dirstate revision tree'
1654
1392
        # separate call for profiling - makes it clear where the costs are.
1655
1393
        self._dirstate._read_dirblocks_if_needed()
1656
 
        if self._revision_id not in self._dirstate.get_parent_ids():
1657
 
            raise AssertionError(
1658
 
                'parent %s has disappeared from %s' % (
1659
 
                self._revision_id, self._dirstate.get_parent_ids()))
 
1394
        assert self._revision_id in self._dirstate.get_parent_ids(), \
 
1395
            'parent %s has disappeared from %s' % (
 
1396
            self._revision_id, self._dirstate.get_parent_ids())
1660
1397
        parent_index = self._dirstate.get_parent_ids().index(self._revision_id) + 1
1661
1398
        # This is identical now to the WorkingTree _generate_inventory except
1662
1399
        # for the tree index use.
1663
1400
        root_key, current_entry = self._dirstate._get_entry(parent_index, path_utf8='')
1664
1401
        current_id = root_key[2]
1665
 
        if current_entry[parent_index][0] != 'd':
1666
 
            raise AssertionError()
 
1402
        assert current_entry[parent_index][0] == 'd'
1667
1403
        inv = Inventory(root_id=current_id, revision_id=self._revision_id)
1668
1404
        inv.root.revision = current_entry[parent_index][4]
1669
1405
        # Turn some things into local variables
1709
1445
                    raise AssertionError("cannot convert entry %r into an InventoryEntry"
1710
1446
                            % entry)
1711
1447
                # These checks cost us around 40ms on a 55k entry tree
1712
 
                if file_id in inv_byid:
1713
 
                    raise AssertionError('file_id %s already in'
1714
 
                        ' inventory as %s' % (file_id, inv_byid[file_id]))
1715
 
                if name_unicode in parent_ie.children:
1716
 
                    raise AssertionError('name %r already in parent'
1717
 
                        % (name_unicode,))
 
1448
                assert file_id not in inv_byid
 
1449
                assert name_unicode not in parent_ie.children
1718
1450
                inv_byid[file_id] = inv_entry
1719
1451
                parent_ie.children[name_unicode] = inv_entry
1720
1452
        self._inventory = inv
1740
1472
            return parent_details[1]
1741
1473
        return None
1742
1474
 
1743
 
    def get_file(self, file_id, path=None):
 
1475
    def get_file(self, file_id):
1744
1476
        return StringIO(self.get_file_text(file_id))
1745
1477
 
 
1478
    def get_file_lines(self, file_id):
 
1479
        ie = self.inventory[file_id]
 
1480
        return self._repository.weave_store.get_weave(file_id,
 
1481
                self._repository.get_transaction()).get_lines(ie.revision)
 
1482
 
1746
1483
    def get_file_size(self, file_id):
1747
 
        """See Tree.get_file_size"""
1748
1484
        return self.inventory[file_id].text_size
1749
1485
 
1750
 
    def get_file_text(self, file_id, path=None):
1751
 
        _, content = list(self.iter_files_bytes([(file_id, None)]))[0]
1752
 
        return ''.join(content)
 
1486
    def get_file_text(self, file_id):
 
1487
        return ''.join(self.get_file_lines(file_id))
1753
1488
 
1754
1489
    def get_reference_revision(self, file_id, path=None):
1755
1490
        return self.inventory[file_id].reference_revision
1756
1491
 
1757
 
    def iter_files_bytes(self, desired_files):
1758
 
        """See Tree.iter_files_bytes.
1759
 
 
1760
 
        This version is implemented on top of Repository.iter_files_bytes"""
1761
 
        parent_index = self._get_parent_index()
1762
 
        repo_desired_files = []
1763
 
        for file_id, identifier in desired_files:
1764
 
            entry = self._get_entry(file_id)
1765
 
            if entry == (None, None):
1766
 
                raise errors.NoSuchId(self, file_id)
1767
 
            repo_desired_files.append((file_id, entry[1][parent_index][4],
1768
 
                                       identifier))
1769
 
        return self._repository.iter_files_bytes(repo_desired_files)
1770
 
 
1771
1492
    def get_symlink_target(self, file_id):
1772
1493
        entry = self._get_entry(file_id=file_id)
1773
1494
        parent_index = self._get_parent_index()
1774
1495
        if entry[1][parent_index][0] != 'l':
1775
1496
            return None
1776
1497
        else:
1777
 
            target = entry[1][parent_index][1]
1778
 
            target = target.decode('utf8')
1779
 
            return target
 
1498
            # At present, none of the tree implementations supports non-ascii
 
1499
            # symlink targets. So we will just assume that the dirstate path is
 
1500
            # correct.
 
1501
            return entry[1][parent_index][1]
1780
1502
 
1781
1503
    def get_revision_id(self):
1782
1504
        """Return the revision id for this tree."""
1800
1522
        return bool(self.path2id(filename))
1801
1523
 
1802
1524
    def kind(self, file_id):
1803
 
        entry = self._get_entry(file_id=file_id)[1]
1804
 
        if entry is None:
1805
 
            raise errors.NoSuchId(tree=self, file_id=file_id)
1806
 
        return dirstate.DirState._minikind_to_kind[entry[1][0]]
1807
 
 
1808
 
    def stored_kind(self, file_id):
1809
 
        """See Tree.stored_kind"""
1810
 
        return self.kind(file_id)
1811
 
 
1812
 
    def path_content_summary(self, path):
1813
 
        """See Tree.path_content_summary."""
1814
 
        id = self.inventory.path2id(path)
1815
 
        if id is None:
1816
 
            return ('missing', None, None, None)
1817
 
        entry = self._inventory[id]
1818
 
        kind = entry.kind
1819
 
        if kind == 'file':
1820
 
            return (kind, entry.text_size, entry.executable, entry.text_sha1)
1821
 
        elif kind == 'symlink':
1822
 
            return (kind, None, None, entry.symlink_target)
1823
 
        else:
1824
 
            return (kind, None, None, None)
 
1525
        return self.inventory[file_id].kind
1825
1526
 
1826
1527
    def is_executable(self, file_id, path=None):
1827
1528
        ie = self.inventory[file_id]
1873
1574
                self._dirstate_locked = False
1874
1575
            self._repository.unlock()
1875
1576
 
1876
 
    @needs_read_lock
1877
 
    def supports_tree_reference(self):
1878
 
        return self._repo_supports_tree_reference
1879
 
 
1880
1577
    def walkdirs(self, prefix=""):
1881
1578
        # TODO: jam 20070215 This is the lazy way by using the RevisionTree
1882
 
        # implementation based on an inventory.
 
1579
        # implementation based on an inventory.  
1883
1580
        # This should be cleaned up to use the much faster Dirstate code
1884
1581
        # So for now, we just build up the parent inventory, and extract
1885
1582
        # it the same way RevisionTree does.
1914
1611
 
1915
1612
class InterDirStateTree(InterTree):
1916
1613
    """Fast path optimiser for changes_from with dirstate trees.
1917
 
 
1918
 
    This is used only when both trees are in the dirstate working file, and
1919
 
    the source is any parent within the dirstate, and the destination is
 
1614
    
 
1615
    This is used only when both trees are in the dirstate working file, and 
 
1616
    the source is any parent within the dirstate, and the destination is 
1920
1617
    the current working tree of the same dirstate.
1921
1618
    """
1922
1619
    # this could be generalized to allow comparisons between any trees in the
1935
1632
        target.set_parent_ids([revid])
1936
1633
        return target.basis_tree(), target
1937
1634
 
1938
 
    @classmethod
1939
 
    def make_source_parent_tree_python_dirstate(klass, test_case, source, target):
1940
 
        result = klass.make_source_parent_tree(source, target)
1941
 
        result[1]._iter_changes = dirstate.ProcessEntryPython
1942
 
        return result
1943
 
 
1944
 
    @classmethod
1945
 
    def make_source_parent_tree_compiled_dirstate(klass, test_case, source, target):
1946
 
        from bzrlib.tests.test__dirstate_helpers import \
1947
 
            CompiledDirstateHelpersFeature
1948
 
        if not CompiledDirstateHelpersFeature.available():
1949
 
            from bzrlib.tests import UnavailableFeature
1950
 
            raise UnavailableFeature(CompiledDirstateHelpersFeature)
1951
 
        from bzrlib._dirstate_helpers_c import ProcessEntryC
1952
 
        result = klass.make_source_parent_tree(source, target)
1953
 
        result[1]._iter_changes = ProcessEntryC
1954
 
        return result
1955
 
 
1956
1635
    _matching_from_tree_format = WorkingTreeFormat4()
1957
1636
    _matching_to_tree_format = WorkingTreeFormat4()
1958
 
 
1959
 
    @classmethod
1960
 
    def _test_mutable_trees_to_test_trees(klass, test_case, source, target):
1961
 
        # This method shouldn't be called, because we have python and C
1962
 
        # specific flavours.
1963
 
        raise NotImplementedError
1964
 
 
1965
 
    def iter_changes(self, include_unchanged=False,
 
1637
    _test_mutable_trees_to_test_trees = make_source_parent_tree
 
1638
 
 
1639
    def _iter_changes(self, include_unchanged=False,
1966
1640
                      specific_files=None, pb=None, extra_trees=[],
1967
1641
                      require_versioned=True, want_unversioned=False):
1968
1642
        """Return the changes from source to target.
1969
1643
 
1970
 
        :return: An iterator that yields tuples. See InterTree.iter_changes
 
1644
        :return: An iterator that yields tuples. See InterTree._iter_changes
1971
1645
            for details.
1972
1646
        :param specific_files: An optional list of file paths to restrict the
1973
1647
            comparison to. When mapping filenames to ids, all matches in all
1984
1658
            output. An unversioned file is defined as one with (False, False)
1985
1659
            for the versioned pair.
1986
1660
        """
 
1661
        utf8_decode_or_none = cache_utf8._utf8_decode_with_None
 
1662
        _minikind_to_kind = dirstate.DirState._minikind_to_kind
1987
1663
        # NB: show_status depends on being able to pass in non-versioned files
1988
1664
        # and report them as unknown
1989
1665
        # TODO: handle extra trees in the dirstate.
1990
 
        if (extra_trees or specific_files == []):
 
1666
        # TODO: handle comparisons as an empty tree as a different special
 
1667
        # case? mbp 20070226
 
1668
        if extra_trees or (self.source._revision_id == NULL_REVISION):
1991
1669
            # we can't fast-path these cases (yet)
1992
 
            return super(InterDirStateTree, self).iter_changes(
 
1670
            for f in super(InterDirStateTree, self)._iter_changes(
1993
1671
                include_unchanged, specific_files, pb, extra_trees,
1994
 
                require_versioned, want_unversioned=want_unversioned)
 
1672
                require_versioned, want_unversioned=want_unversioned):
 
1673
                yield f
 
1674
            return
1995
1675
        parent_ids = self.target.get_parent_ids()
1996
 
        if not (self.source._revision_id in parent_ids
1997
 
                or self.source._revision_id == NULL_REVISION):
1998
 
            raise AssertionError(
1999
 
                "revision {%s} is not stored in {%s}, but %s "
2000
 
                "can only be used for trees stored in the dirstate"
2001
 
                % (self.source._revision_id, self.target, self.iter_changes))
 
1676
        assert (self.source._revision_id in parent_ids), \
 
1677
                "revision {%s} is not stored in {%s}, but %s " \
 
1678
                "can only be used for trees stored in the dirstate" \
 
1679
                % (self.source._revision_id, self.target, self._iter_changes)
2002
1680
        target_index = 0
2003
1681
        if self.source._revision_id == NULL_REVISION:
2004
1682
            source_index = None
2005
1683
            indices = (target_index,)
2006
1684
        else:
2007
 
            if not (self.source._revision_id in parent_ids):
2008
 
                raise AssertionError(
2009
 
                    "Failure: source._revision_id: %s not in target.parent_ids(%s)" % (
2010
 
                    self.source._revision_id, parent_ids))
 
1685
            assert (self.source._revision_id in parent_ids), \
 
1686
                "Failure: source._revision_id: %s not in target.parent_ids(%s)" % (
 
1687
                self.source._revision_id, parent_ids)
2011
1688
            source_index = 1 + parent_ids.index(self.source._revision_id)
2012
 
            indices = (source_index, target_index)
 
1689
            indices = (source_index,target_index)
2013
1690
        # -- make all specific_files utf8 --
2014
1691
        if specific_files:
2015
1692
            specific_files_utf8 = set()
2016
1693
            for path in specific_files:
2017
 
                # Note, if there are many specific files, using cache_utf8
2018
 
                # would be good here.
2019
1694
                specific_files_utf8.add(path.encode('utf8'))
2020
1695
            specific_files = specific_files_utf8
2021
1696
        else:
2022
1697
            specific_files = set([''])
2023
1698
        # -- specific_files is now a utf8 path set --
2024
 
        search_specific_files = set()
2025
1699
        # -- get the state object and prepare it.
2026
1700
        state = self.target.current_dirstate()
2027
1701
        state._read_dirblocks_if_needed()
 
1702
        def _entries_for_path(path):
 
1703
            """Return a list with all the entries that match path for all ids.
 
1704
            """
 
1705
            dirname, basename = os.path.split(path)
 
1706
            key = (dirname, basename, '')
 
1707
            block_index, present = state._find_block_index_from_key(key)
 
1708
            if not present:
 
1709
                # the block which should contain path is absent.
 
1710
                return []
 
1711
            result = []
 
1712
            block = state._dirblocks[block_index][1]
 
1713
            entry_index, _ = state._find_entry_index(key, block)
 
1714
            # we may need to look at multiple entries at this path: walk while the specific_files match.
 
1715
            while (entry_index < len(block) and
 
1716
                block[entry_index][0][0:2] == key[0:2]):
 
1717
                result.append(block[entry_index])
 
1718
                entry_index += 1
 
1719
            return result
2028
1720
        if require_versioned:
2029
1721
            # -- check all supplied paths are versioned in a search tree. --
2030
1722
            all_versioned = True
2031
1723
            for path in specific_files:
2032
 
                path_entries = state._entries_for_path(path)
 
1724
                path_entries = _entries_for_path(path)
2033
1725
                if not path_entries:
2034
1726
                    # this specified path is not present at all: error
2035
1727
                    all_versioned = False
2051
1743
            if not all_versioned:
2052
1744
                raise errors.PathsNotVersionedError(specific_files)
2053
1745
        # -- remove redundancy in supplied specific_files to prevent over-scanning --
 
1746
        search_specific_files = set()
2054
1747
        for path in specific_files:
2055
1748
            other_specific_files = specific_files.difference(set([path]))
2056
1749
            if not osutils.is_inside_any(other_specific_files, path):
2057
1750
                # this is a top level path, we must check it.
2058
1751
                search_specific_files.add(path)
 
1752
        # sketch: 
 
1753
        # compare source_index and target_index at or under each element of search_specific_files.
 
1754
        # follow the following comparison table. Note that we only want to do diff operations when
 
1755
        # the target is fdl because thats when the walkdirs logic will have exposed the pathinfo 
 
1756
        # for the target.
 
1757
        # cases:
 
1758
        # 
 
1759
        # Source | Target | disk | action
 
1760
        #   r    | fdlt   |      | add source to search, add id path move and perform
 
1761
        #        |        |      | diff check on source-target
 
1762
        #   r    | fdlt   |  a   | dangling file that was present in the basis. 
 
1763
        #        |        |      | ???
 
1764
        #   r    |  a     |      | add source to search
 
1765
        #   r    |  a     |  a   | 
 
1766
        #   r    |  r     |      | this path is present in a non-examined tree, skip.
 
1767
        #   r    |  r     |  a   | this path is present in a non-examined tree, skip.
 
1768
        #   a    | fdlt   |      | add new id
 
1769
        #   a    | fdlt   |  a   | dangling locally added file, skip
 
1770
        #   a    |  a     |      | not present in either tree, skip
 
1771
        #   a    |  a     |  a   | not present in any tree, skip
 
1772
        #   a    |  r     |      | not present in either tree at this path, skip as it
 
1773
        #        |        |      | may not be selected by the users list of paths.
 
1774
        #   a    |  r     |  a   | not present in either tree at this path, skip as it
 
1775
        #        |        |      | may not be selected by the users list of paths.
 
1776
        #  fdlt  | fdlt   |      | content in both: diff them
 
1777
        #  fdlt  | fdlt   |  a   | deleted locally, but not unversioned - show as deleted ?
 
1778
        #  fdlt  |  a     |      | unversioned: output deleted id for now
 
1779
        #  fdlt  |  a     |  a   | unversioned and deleted: output deleted id
 
1780
        #  fdlt  |  r     |      | relocated in this tree, so add target to search.
 
1781
        #        |        |      | Dont diff, we will see an r,fd; pair when we reach
 
1782
        #        |        |      | this id at the other path.
 
1783
        #  fdlt  |  r     |  a   | relocated in this tree, so add target to search.
 
1784
        #        |        |      | Dont diff, we will see an r,fd; pair when we reach
 
1785
        #        |        |      | this id at the other path.
 
1786
 
 
1787
        # for all search_indexs in each path at or under each element of
 
1788
        # search_specific_files, if the detail is relocated: add the id, and add the
 
1789
        # relocated path as one to search if its not searched already. If the
 
1790
        # detail is not relocated, add the id.
 
1791
        searched_specific_files = set()
 
1792
        NULL_PARENT_DETAILS = dirstate.DirState.NULL_PARENT_DETAILS
 
1793
        # Using a list so that we can access the values and change them in
 
1794
        # nested scope. Each one is [path, file_id, entry]
 
1795
        last_source_parent = [None, None, None]
 
1796
        last_target_parent = [None, None, None]
2059
1797
 
2060
1798
        use_filesystem_for_exec = (sys.platform != 'win32')
2061
 
        iter_changes = self.target._iter_changes(include_unchanged,
2062
 
            use_filesystem_for_exec, search_specific_files, state,
2063
 
            source_index, target_index, want_unversioned, self.target)
2064
 
        return iter_changes.iter_changes()
 
1799
 
 
1800
        def _process_entry(entry, path_info):
 
1801
            """Compare an entry and real disk to generate delta information.
 
1802
 
 
1803
            :param path_info: top_relpath, basename, kind, lstat, abspath for
 
1804
                the path of entry. If None, then the path is considered absent.
 
1805
                (Perhaps we should pass in a concrete entry for this ?)
 
1806
                Basename is returned as a utf8 string because we expect this
 
1807
                tuple will be ignored, and don't want to take the time to
 
1808
                decode.
 
1809
            """
 
1810
            if source_index is None:
 
1811
                source_details = NULL_PARENT_DETAILS
 
1812
            else:
 
1813
                source_details = entry[1][source_index]
 
1814
            target_details = entry[1][target_index]
 
1815
            target_minikind = target_details[0]
 
1816
            if path_info is not None and target_minikind in 'fdlt':
 
1817
                assert target_index == 0
 
1818
                link_or_sha1 = state.update_entry(entry, abspath=path_info[4],
 
1819
                                                  stat_value=path_info[3])
 
1820
                # The entry may have been modified by update_entry
 
1821
                target_details = entry[1][target_index]
 
1822
                target_minikind = target_details[0]
 
1823
            else:
 
1824
                link_or_sha1 = None
 
1825
            source_minikind = source_details[0]
 
1826
            if source_minikind in 'fdltr' and target_minikind in 'fdlt':
 
1827
                # claimed content in both: diff
 
1828
                #   r    | fdlt   |      | add source to search, add id path move and perform
 
1829
                #        |        |      | diff check on source-target
 
1830
                #   r    | fdlt   |  a   | dangling file that was present in the basis.
 
1831
                #        |        |      | ???
 
1832
                if source_minikind in 'r':
 
1833
                    # add the source to the search path to find any children it
 
1834
                    # has.  TODO ? : only add if it is a container ?
 
1835
                    if not osutils.is_inside_any(searched_specific_files,
 
1836
                                                 source_details[1]):
 
1837
                        search_specific_files.add(source_details[1])
 
1838
                    # generate the old path; this is needed for stating later
 
1839
                    # as well.
 
1840
                    old_path = source_details[1]
 
1841
                    old_dirname, old_basename = os.path.split(old_path)
 
1842
                    path = pathjoin(entry[0][0], entry[0][1])
 
1843
                    old_entry = state._get_entry(source_index,
 
1844
                                                 path_utf8=old_path)
 
1845
                    # update the source details variable to be the real
 
1846
                    # location.
 
1847
                    source_details = old_entry[1][source_index]
 
1848
                    source_minikind = source_details[0]
 
1849
                else:
 
1850
                    old_dirname = entry[0][0]
 
1851
                    old_basename = entry[0][1]
 
1852
                    old_path = path = pathjoin(old_dirname, old_basename)
 
1853
                if path_info is None:
 
1854
                    # the file is missing on disk, show as removed.
 
1855
                    content_change = True
 
1856
                    target_kind = None
 
1857
                    target_exec = False
 
1858
                else:
 
1859
                    # source and target are both versioned and disk file is present.
 
1860
                    target_kind = path_info[2]
 
1861
                    if target_kind == 'directory':
 
1862
                        if source_minikind != 'd':
 
1863
                            content_change = True
 
1864
                        else:
 
1865
                            # directories have no fingerprint
 
1866
                            content_change = False
 
1867
                        target_exec = False
 
1868
                    elif target_kind == 'file':
 
1869
                        if source_minikind != 'f':
 
1870
                            content_change = True
 
1871
                        else:
 
1872
                            # We could check the size, but we already have the
 
1873
                            # sha1 hash.
 
1874
                            content_change = (link_or_sha1 != source_details[1])
 
1875
                        # Target details is updated at update_entry time
 
1876
                        if use_filesystem_for_exec:
 
1877
                            # We don't need S_ISREG here, because we are sure
 
1878
                            # we are dealing with a file.
 
1879
                            target_exec = bool(stat.S_IEXEC & path_info[3].st_mode)
 
1880
                        else:
 
1881
                            target_exec = target_details[3]
 
1882
                    elif target_kind == 'symlink':
 
1883
                        if source_minikind != 'l':
 
1884
                            content_change = True
 
1885
                        else:
 
1886
                            content_change = (link_or_sha1 != source_details[1])
 
1887
                        target_exec = False
 
1888
                    elif target_kind == 'tree-reference':
 
1889
                        if source_minikind != 't':
 
1890
                            content_change = True
 
1891
                        else:
 
1892
                            content_change = False
 
1893
                        target_exec = False
 
1894
                    else:
 
1895
                        raise Exception, "unknown kind %s" % path_info[2]
 
1896
                # parent id is the entry for the path in the target tree
 
1897
                if old_dirname == last_source_parent[0]:
 
1898
                    source_parent_id = last_source_parent[1]
 
1899
                else:
 
1900
                    source_parent_entry = state._get_entry(source_index,
 
1901
                                                           path_utf8=old_dirname)
 
1902
                    source_parent_id = source_parent_entry[0][2]
 
1903
                    if source_parent_id == entry[0][2]:
 
1904
                        # This is the root, so the parent is None
 
1905
                        source_parent_id = None
 
1906
                    else:
 
1907
                        last_source_parent[0] = old_dirname
 
1908
                        last_source_parent[1] = source_parent_id
 
1909
                        last_source_parent[2] = source_parent_entry
 
1910
                new_dirname = entry[0][0]
 
1911
                if new_dirname == last_target_parent[0]:
 
1912
                    target_parent_id = last_target_parent[1]
 
1913
                else:
 
1914
                    # TODO: We don't always need to do the lookup, because the
 
1915
                    #       parent entry will be the same as the source entry.
 
1916
                    target_parent_entry = state._get_entry(target_index,
 
1917
                                                           path_utf8=new_dirname)
 
1918
                    target_parent_id = target_parent_entry[0][2]
 
1919
                    if target_parent_id == entry[0][2]:
 
1920
                        # This is the root, so the parent is None
 
1921
                        target_parent_id = None
 
1922
                    else:
 
1923
                        last_target_parent[0] = new_dirname
 
1924
                        last_target_parent[1] = target_parent_id
 
1925
                        last_target_parent[2] = target_parent_entry
 
1926
 
 
1927
                source_exec = source_details[3]
 
1928
                return ((entry[0][2], (old_path, path), content_change,
 
1929
                        (True, True),
 
1930
                        (source_parent_id, target_parent_id),
 
1931
                        (old_basename, entry[0][1]),
 
1932
                        (_minikind_to_kind[source_minikind], target_kind),
 
1933
                        (source_exec, target_exec)),)
 
1934
            elif source_minikind in 'a' and target_minikind in 'fdlt':
 
1935
                # looks like a new file
 
1936
                if path_info is not None:
 
1937
                    path = pathjoin(entry[0][0], entry[0][1])
 
1938
                    # parent id is the entry for the path in the target tree
 
1939
                    # TODO: these are the same for an entire directory: cache em.
 
1940
                    parent_id = state._get_entry(target_index,
 
1941
                                                 path_utf8=entry[0][0])[0][2]
 
1942
                    if parent_id == entry[0][2]:
 
1943
                        parent_id = None
 
1944
                    if use_filesystem_for_exec:
 
1945
                        # We need S_ISREG here, because we aren't sure if this
 
1946
                        # is a file or not.
 
1947
                        target_exec = bool(
 
1948
                            stat.S_ISREG(path_info[3].st_mode)
 
1949
                            and stat.S_IEXEC & path_info[3].st_mode)
 
1950
                    else:
 
1951
                        target_exec = target_details[3]
 
1952
                    return ((entry[0][2], (None, path), True,
 
1953
                            (False, True),
 
1954
                            (None, parent_id),
 
1955
                            (None, entry[0][1]),
 
1956
                            (None, path_info[2]),
 
1957
                            (None, target_exec)),)
 
1958
                else:
 
1959
                    # but its not on disk: we deliberately treat this as just
 
1960
                    # never-present. (Why ?! - RBC 20070224)
 
1961
                    pass
 
1962
            elif source_minikind in 'fdlt' and target_minikind in 'a':
 
1963
                # unversioned, possibly, or possibly not deleted: we dont care.
 
1964
                # if its still on disk, *and* theres no other entry at this
 
1965
                # path [we dont know this in this routine at the moment -
 
1966
                # perhaps we should change this - then it would be an unknown.
 
1967
                old_path = pathjoin(entry[0][0], entry[0][1])
 
1968
                # parent id is the entry for the path in the target tree
 
1969
                parent_id = state._get_entry(source_index, path_utf8=entry[0][0])[0][2]
 
1970
                if parent_id == entry[0][2]:
 
1971
                    parent_id = None
 
1972
                return ((entry[0][2], (old_path, None), True,
 
1973
                        (True, False),
 
1974
                        (parent_id, None),
 
1975
                        (entry[0][1], None),
 
1976
                        (_minikind_to_kind[source_minikind], None),
 
1977
                        (source_details[3], None)),)
 
1978
            elif source_minikind in 'fdlt' and target_minikind in 'r':
 
1979
                # a rename; could be a true rename, or a rename inherited from
 
1980
                # a renamed parent. TODO: handle this efficiently. Its not
 
1981
                # common case to rename dirs though, so a correct but slow
 
1982
                # implementation will do.
 
1983
                if not osutils.is_inside_any(searched_specific_files, target_details[1]):
 
1984
                    search_specific_files.add(target_details[1])
 
1985
            elif source_minikind in 'ra' and target_minikind in 'ra':
 
1986
                # neither of the selected trees contain this file,
 
1987
                # so skip over it. This is not currently directly tested, but
 
1988
                # is indirectly via test_too_much.TestCommands.test_conflicts.
 
1989
                pass
 
1990
            else:
 
1991
                raise AssertionError("don't know how to compare "
 
1992
                    "source_minikind=%r, target_minikind=%r"
 
1993
                    % (source_minikind, target_minikind))
 
1994
                ## import pdb;pdb.set_trace()
 
1995
            return ()
 
1996
 
 
1997
        while search_specific_files:
 
1998
            # TODO: the pending list should be lexically sorted?  the
 
1999
            # interface doesn't require it.
 
2000
            current_root = search_specific_files.pop()
 
2001
            current_root_unicode = current_root.decode('utf8')
 
2002
            searched_specific_files.add(current_root)
 
2003
            # process the entries for this containing directory: the rest will be
 
2004
            # found by their parents recursively.
 
2005
            root_entries = _entries_for_path(current_root)
 
2006
            root_abspath = self.target.abspath(current_root_unicode)
 
2007
            try:
 
2008
                root_stat = os.lstat(root_abspath)
 
2009
            except OSError, e:
 
2010
                if e.errno == errno.ENOENT:
 
2011
                    # the path does not exist: let _process_entry know that.
 
2012
                    root_dir_info = None
 
2013
                else:
 
2014
                    # some other random error: hand it up.
 
2015
                    raise
 
2016
            else:
 
2017
                root_dir_info = ('', current_root,
 
2018
                    osutils.file_kind_from_stat_mode(root_stat.st_mode), root_stat,
 
2019
                    root_abspath)
 
2020
                if root_dir_info[2] == 'directory':
 
2021
                    if self.target._directory_is_tree_reference(
 
2022
                        current_root.decode('utf8')):
 
2023
                        root_dir_info = root_dir_info[:2] + \
 
2024
                            ('tree-reference',) + root_dir_info[3:]
 
2025
 
 
2026
            if not root_entries and not root_dir_info:
 
2027
                # this specified path is not present at all, skip it.
 
2028
                continue
 
2029
            path_handled = False
 
2030
            for entry in root_entries:
 
2031
                for result in _process_entry(entry, root_dir_info):
 
2032
                    # this check should probably be outside the loop: one
 
2033
                    # 'iterate two trees' api, and then _iter_changes filters
 
2034
                    # unchanged pairs. - RBC 20070226
 
2035
                    path_handled = True
 
2036
                    if (include_unchanged
 
2037
                        or result[2]                    # content change
 
2038
                        or result[3][0] != result[3][1] # versioned status
 
2039
                        or result[4][0] != result[4][1] # parent id
 
2040
                        or result[5][0] != result[5][1] # name
 
2041
                        or result[6][0] != result[6][1] # kind
 
2042
                        or result[7][0] != result[7][1] # executable
 
2043
                        ):
 
2044
                        yield (result[0],
 
2045
                               (utf8_decode_or_none(result[1][0]),
 
2046
                                utf8_decode_or_none(result[1][1])),
 
2047
                               result[2],
 
2048
                               result[3],
 
2049
                               result[4],
 
2050
                               (utf8_decode_or_none(result[5][0]),
 
2051
                                utf8_decode_or_none(result[5][1])),
 
2052
                               result[6],
 
2053
                               result[7],
 
2054
                              )
 
2055
            if want_unversioned and not path_handled and root_dir_info:
 
2056
                new_executable = bool(
 
2057
                    stat.S_ISREG(root_dir_info[3].st_mode)
 
2058
                    and stat.S_IEXEC & root_dir_info[3].st_mode)
 
2059
                yield (None,
 
2060
                       (None, current_root_unicode),
 
2061
                       True,
 
2062
                       (False, False),
 
2063
                       (None, None),
 
2064
                       (None, splitpath(current_root_unicode)[-1]),
 
2065
                       (None, root_dir_info[2]),
 
2066
                       (None, new_executable)
 
2067
                      )
 
2068
            initial_key = (current_root, '', '')
 
2069
            block_index, _ = state._find_block_index_from_key(initial_key)
 
2070
            if block_index == 0:
 
2071
                # we have processed the total root already, but because the
 
2072
                # initial key matched it we should skip it here.
 
2073
                block_index +=1
 
2074
            if root_dir_info and root_dir_info[2] == 'tree-reference':
 
2075
                current_dir_info = None
 
2076
            else:
 
2077
                dir_iterator = osutils._walkdirs_utf8(root_abspath, prefix=current_root)
 
2078
                try:
 
2079
                    current_dir_info = dir_iterator.next()
 
2080
                except OSError, e:
 
2081
                    # on win32, python2.4 has e.errno == ERROR_DIRECTORY, but
 
2082
                    # python 2.5 has e.errno == EINVAL,
 
2083
                    #            and e.winerror == ERROR_DIRECTORY
 
2084
                    e_winerror = getattr(e, 'winerror', None)
 
2085
                    # there may be directories in the inventory even though
 
2086
                    # this path is not a file on disk: so mark it as end of
 
2087
                    # iterator
 
2088
                    if e.errno in (errno.ENOENT, errno.ENOTDIR, errno.EINVAL):
 
2089
                        current_dir_info = None
 
2090
                    elif (sys.platform == 'win32'
 
2091
                          and ERROR_DIRECTORY in (e.errno, e_winerror)):
 
2092
                        current_dir_info = None
 
2093
                    else:
 
2094
                        raise
 
2095
                else:
 
2096
                    if current_dir_info[0][0] == '':
 
2097
                        # remove .bzr from iteration
 
2098
                        bzr_index = bisect_left(current_dir_info[1], ('.bzr',))
 
2099
                        assert current_dir_info[1][bzr_index][0] == '.bzr'
 
2100
                        del current_dir_info[1][bzr_index]
 
2101
            # walk until both the directory listing and the versioned metadata
 
2102
            # are exhausted. 
 
2103
            if (block_index < len(state._dirblocks) and
 
2104
                osutils.is_inside(current_root, state._dirblocks[block_index][0])):
 
2105
                current_block = state._dirblocks[block_index]
 
2106
            else:
 
2107
                current_block = None
 
2108
            while (current_dir_info is not None or
 
2109
                   current_block is not None):
 
2110
                if (current_dir_info and current_block
 
2111
                    and current_dir_info[0][0] != current_block[0]):
 
2112
                    if current_dir_info[0][0] < current_block[0] :
 
2113
                        # filesystem data refers to paths not covered by the dirblock.
 
2114
                        # this has two possibilities:
 
2115
                        # A) it is versioned but empty, so there is no block for it
 
2116
                        # B) it is not versioned.
 
2117
                        # in either case it was processed by the containing directories walk:
 
2118
                        # if it is root/foo, when we walked root we emitted it,
 
2119
                        # or if we ere given root/foo to walk specifically, we
 
2120
                        # emitted it when checking the walk-root entries
 
2121
                        # advance the iterator and loop - we dont need to emit it.
 
2122
                        try:
 
2123
                            current_dir_info = dir_iterator.next()
 
2124
                        except StopIteration:
 
2125
                            current_dir_info = None
 
2126
                    else:
 
2127
                        # We have a dirblock entry for this location, but there
 
2128
                        # is no filesystem path for this. This is most likely
 
2129
                        # because a directory was removed from the disk.
 
2130
                        # We don't have to report the missing directory,
 
2131
                        # because that should have already been handled, but we
 
2132
                        # need to handle all of the files that are contained
 
2133
                        # within.
 
2134
                        for current_entry in current_block[1]:
 
2135
                            # entry referring to file not present on disk.
 
2136
                            # advance the entry only, after processing.
 
2137
                            for result in _process_entry(current_entry, None):
 
2138
                                # this check should probably be outside the loop: one
 
2139
                                # 'iterate two trees' api, and then _iter_changes filters
 
2140
                                # unchanged pairs. - RBC 20070226
 
2141
                                if (include_unchanged
 
2142
                                    or result[2]                    # content change
 
2143
                                    or result[3][0] != result[3][1] # versioned status
 
2144
                                    or result[4][0] != result[4][1] # parent id
 
2145
                                    or result[5][0] != result[5][1] # name
 
2146
                                    or result[6][0] != result[6][1] # kind
 
2147
                                    or result[7][0] != result[7][1] # executable
 
2148
                                    ):
 
2149
                                    yield (result[0],
 
2150
                                           (utf8_decode_or_none(result[1][0]),
 
2151
                                            utf8_decode_or_none(result[1][1])),
 
2152
                                           result[2],
 
2153
                                           result[3],
 
2154
                                           result[4],
 
2155
                                           (utf8_decode_or_none(result[5][0]),
 
2156
                                            utf8_decode_or_none(result[5][1])),
 
2157
                                           result[6],
 
2158
                                           result[7],
 
2159
                                          )
 
2160
                        block_index +=1
 
2161
                        if (block_index < len(state._dirblocks) and
 
2162
                            osutils.is_inside(current_root,
 
2163
                                              state._dirblocks[block_index][0])):
 
2164
                            current_block = state._dirblocks[block_index]
 
2165
                        else:
 
2166
                            current_block = None
 
2167
                    continue
 
2168
                entry_index = 0
 
2169
                if current_block and entry_index < len(current_block[1]):
 
2170
                    current_entry = current_block[1][entry_index]
 
2171
                else:
 
2172
                    current_entry = None
 
2173
                advance_entry = True
 
2174
                path_index = 0
 
2175
                if current_dir_info and path_index < len(current_dir_info[1]):
 
2176
                    current_path_info = current_dir_info[1][path_index]
 
2177
                    if current_path_info[2] == 'directory':
 
2178
                        if self.target._directory_is_tree_reference(
 
2179
                            current_path_info[0].decode('utf8')):
 
2180
                            current_path_info = current_path_info[:2] + \
 
2181
                                ('tree-reference',) + current_path_info[3:]
 
2182
                else:
 
2183
                    current_path_info = None
 
2184
                advance_path = True
 
2185
                path_handled = False
 
2186
                while (current_entry is not None or
 
2187
                    current_path_info is not None):
 
2188
                    if current_entry is None:
 
2189
                        # the check for path_handled when the path is adnvaced
 
2190
                        # will yield this path if needed.
 
2191
                        pass
 
2192
                    elif current_path_info is None:
 
2193
                        # no path is fine: the per entry code will handle it.
 
2194
                        for result in _process_entry(current_entry, current_path_info):
 
2195
                            # this check should probably be outside the loop: one
 
2196
                            # 'iterate two trees' api, and then _iter_changes filters
 
2197
                            # unchanged pairs. - RBC 20070226
 
2198
                            if (include_unchanged
 
2199
                                or result[2]                    # content change
 
2200
                                or result[3][0] != result[3][1] # versioned status
 
2201
                                or result[4][0] != result[4][1] # parent id
 
2202
                                or result[5][0] != result[5][1] # name
 
2203
                                or result[6][0] != result[6][1] # kind
 
2204
                                or result[7][0] != result[7][1] # executable
 
2205
                                ):
 
2206
                                yield (result[0],
 
2207
                                       (utf8_decode_or_none(result[1][0]),
 
2208
                                        utf8_decode_or_none(result[1][1])),
 
2209
                                       result[2],
 
2210
                                       result[3],
 
2211
                                       result[4],
 
2212
                                       (utf8_decode_or_none(result[5][0]),
 
2213
                                        utf8_decode_or_none(result[5][1])),
 
2214
                                       result[6],
 
2215
                                       result[7],
 
2216
                                      )
 
2217
                    elif current_entry[0][1] != current_path_info[1]:
 
2218
                        if current_path_info[1] < current_entry[0][1]:
 
2219
                            # extra file on disk: pass for now, but only
 
2220
                            # increment the path, not the entry
 
2221
                            advance_entry = False
 
2222
                        else:
 
2223
                            # entry referring to file not present on disk.
 
2224
                            # advance the entry only, after processing.
 
2225
                            for result in _process_entry(current_entry, None):
 
2226
                                # this check should probably be outside the loop: one
 
2227
                                # 'iterate two trees' api, and then _iter_changes filters
 
2228
                                # unchanged pairs. - RBC 20070226
 
2229
                                path_handled = True
 
2230
                                if (include_unchanged
 
2231
                                    or result[2]                    # content change
 
2232
                                    or result[3][0] != result[3][1] # versioned status
 
2233
                                    or result[4][0] != result[4][1] # parent id
 
2234
                                    or result[5][0] != result[5][1] # name
 
2235
                                    or result[6][0] != result[6][1] # kind
 
2236
                                    or result[7][0] != result[7][1] # executable
 
2237
                                    ):
 
2238
                                    yield (result[0],
 
2239
                                           (utf8_decode_or_none(result[1][0]),
 
2240
                                            utf8_decode_or_none(result[1][1])),
 
2241
                                           result[2],
 
2242
                                           result[3],
 
2243
                                           result[4],
 
2244
                                           (utf8_decode_or_none(result[5][0]),
 
2245
                                            utf8_decode_or_none(result[5][1])),
 
2246
                                           result[6],
 
2247
                                           result[7],
 
2248
                                          )
 
2249
                            advance_path = False
 
2250
                    else:
 
2251
                        for result in _process_entry(current_entry, current_path_info):
 
2252
                            # this check should probably be outside the loop: one
 
2253
                            # 'iterate two trees' api, and then _iter_changes filters
 
2254
                            # unchanged pairs. - RBC 20070226
 
2255
                            path_handled = True
 
2256
                            if (include_unchanged
 
2257
                                or result[2]                    # content change
 
2258
                                or result[3][0] != result[3][1] # versioned status
 
2259
                                or result[4][0] != result[4][1] # parent id
 
2260
                                or result[5][0] != result[5][1] # name
 
2261
                                or result[6][0] != result[6][1] # kind
 
2262
                                or result[7][0] != result[7][1] # executable
 
2263
                                ):
 
2264
                                yield (result[0],
 
2265
                                       (utf8_decode_or_none(result[1][0]),
 
2266
                                        utf8_decode_or_none(result[1][1])),
 
2267
                                       result[2],
 
2268
                                       result[3],
 
2269
                                       result[4],
 
2270
                                       (utf8_decode_or_none(result[5][0]),
 
2271
                                        utf8_decode_or_none(result[5][1])),
 
2272
                                       result[6],
 
2273
                                       result[7],
 
2274
                                      )
 
2275
                    if advance_entry and current_entry is not None:
 
2276
                        entry_index += 1
 
2277
                        if entry_index < len(current_block[1]):
 
2278
                            current_entry = current_block[1][entry_index]
 
2279
                        else:
 
2280
                            current_entry = None
 
2281
                    else:
 
2282
                        advance_entry = True # reset the advance flaga
 
2283
                    if advance_path and current_path_info is not None:
 
2284
                        if not path_handled:
 
2285
                            # unversioned in all regards
 
2286
                            if want_unversioned:
 
2287
                                new_executable = bool(
 
2288
                                    stat.S_ISREG(current_path_info[3].st_mode)
 
2289
                                    and stat.S_IEXEC & current_path_info[3].st_mode)
 
2290
                                if want_unversioned:
 
2291
                                    yield (None,
 
2292
                                        (None, utf8_decode_or_none(current_path_info[0])),
 
2293
                                        True,
 
2294
                                        (False, False),
 
2295
                                        (None, None),
 
2296
                                        (None, utf8_decode_or_none(current_path_info[1])),
 
2297
                                        (None, current_path_info[2]),
 
2298
                                        (None, new_executable))
 
2299
                            # dont descend into this unversioned path if it is
 
2300
                            # a dir
 
2301
                            if current_path_info[2] in ('directory'):
 
2302
                                del current_dir_info[1][path_index]
 
2303
                                path_index -= 1
 
2304
                        # dont descend the disk iterator into any tree 
 
2305
                        # paths.
 
2306
                        if current_path_info[2] == 'tree-reference':
 
2307
                            del current_dir_info[1][path_index]
 
2308
                            path_index -= 1
 
2309
                        path_index += 1
 
2310
                        if path_index < len(current_dir_info[1]):
 
2311
                            current_path_info = current_dir_info[1][path_index]
 
2312
                            if current_path_info[2] == 'directory':
 
2313
                                if self.target._directory_is_tree_reference(
 
2314
                                    current_path_info[0].decode('utf8')):
 
2315
                                    current_path_info = current_path_info[:2] + \
 
2316
                                        ('tree-reference',) + current_path_info[3:]
 
2317
                        else:
 
2318
                            current_path_info = None
 
2319
                        path_handled = False
 
2320
                    else:
 
2321
                        advance_path = True # reset the advance flagg.
 
2322
                if current_block is not None:
 
2323
                    block_index += 1
 
2324
                    if (block_index < len(state._dirblocks) and
 
2325
                        osutils.is_inside(current_root, state._dirblocks[block_index][0])):
 
2326
                        current_block = state._dirblocks[block_index]
 
2327
                    else:
 
2328
                        current_block = None
 
2329
                if current_dir_info is not None:
 
2330
                    try:
 
2331
                        current_dir_info = dir_iterator.next()
 
2332
                    except StopIteration:
 
2333
                        current_dir_info = None
 
2334
 
2065
2335
 
2066
2336
    @staticmethod
2067
2337
    def is_compatible(source, target):
2068
2338
        # the target must be a dirstate working tree
2069
 
        if not isinstance(target, DirStateWorkingTree):
 
2339
        if not isinstance(target, WorkingTree4):
2070
2340
            return False
2071
 
        # the source must be a revtree or dirstate rev tree.
 
2341
        # the source must be a revtreee or dirstate rev tree.
2072
2342
        if not isinstance(source,
2073
2343
            (revisiontree.RevisionTree, DirStateRevisionTree)):
2074
2344
            return False
2075
2345
        # the source revid must be in the target dirstate
2076
2346
        if not (source._revision_id == NULL_REVISION or
2077
2347
            source._revision_id in target.get_parent_ids()):
2078
 
            # TODO: what about ghosts? it may well need to
 
2348
            # TODO: what about ghosts? it may well need to 
2079
2349
            # check for them explicitly.
2080
2350
            return False
2081
2351
        return True
2091
2361
 
2092
2362
    def convert(self, tree):
2093
2363
        # lock the control files not the tree, so that we dont get tree
2094
 
        # on-unlock behaviours, and so that noone else diddles with the
 
2364
        # on-unlock behaviours, and so that noone else diddles with the 
2095
2365
        # tree during upgrade.
2096
2366
        tree._control_files.lock_write()
2097
2367
        try:
2123
2393
 
2124
2394
    def update_format(self, tree):
2125
2395
        """Change the format marker."""
2126
 
        tree._transport.put_bytes('format',
2127
 
            self.target_format.get_format_string(),
2128
 
            mode=tree.bzrdir._get_file_mode())
2129
 
 
2130
 
 
2131
 
class Converter4to5(object):
2132
 
    """Perform an in-place upgrade of format 4 to format 5 trees."""
2133
 
 
2134
 
    def __init__(self):
2135
 
        self.target_format = WorkingTreeFormat5()
2136
 
 
2137
 
    def convert(self, tree):
2138
 
        # lock the control files not the tree, so that we don't get tree
2139
 
        # on-unlock behaviours, and so that no-one else diddles with the
2140
 
        # tree during upgrade.
2141
 
        tree._control_files.lock_write()
2142
 
        try:
2143
 
            self.update_format(tree)
2144
 
        finally:
2145
 
            tree._control_files.unlock()
2146
 
 
2147
 
    def update_format(self, tree):
2148
 
        """Change the format marker."""
2149
 
        tree._transport.put_bytes('format',
2150
 
            self.target_format.get_format_string(),
2151
 
            mode=tree.bzrdir._get_file_mode())
2152
 
 
2153
 
 
2154
 
class Converter4or5to6(object):
2155
 
    """Perform an in-place upgrade of format 4 or 5 to format 6 trees."""
2156
 
 
2157
 
    def __init__(self):
2158
 
        self.target_format = WorkingTreeFormat6()
2159
 
 
2160
 
    def convert(self, tree):
2161
 
        # lock the control files not the tree, so that we don't get tree
2162
 
        # on-unlock behaviours, and so that no-one else diddles with the
2163
 
        # tree during upgrade.
2164
 
        tree._control_files.lock_write()
2165
 
        try:
2166
 
            self.init_custom_control_files(tree)
2167
 
            self.update_format(tree)
2168
 
        finally:
2169
 
            tree._control_files.unlock()
2170
 
 
2171
 
    def init_custom_control_files(self, tree):
2172
 
        """Initialize custom control files."""
2173
 
        tree._transport.put_bytes('views', '',
2174
 
            mode=tree.bzrdir._get_file_mode())
2175
 
 
2176
 
    def update_format(self, tree):
2177
 
        """Change the format marker."""
2178
 
        tree._transport.put_bytes('format',
2179
 
            self.target_format.get_format_string(),
2180
 
            mode=tree.bzrdir._get_file_mode())
 
2396
        tree._control_files.put_utf8('format',
 
2397
            self.target_format.get_format_string())