~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree_4.py

  • Committer: John Arbash Meinel
  • Date: 2011-05-11 11:35:28 UTC
  • mto: This revision was merged to the branch mainline in revision 5851.
  • Revision ID: john@arbash-meinel.com-20110511113528-qepibuwxicjrbb2h
Break compatibility with python <2.6.

This includes auditing the code for places where we were doing
explicit 'sys.version' checks and removing them as appropriate.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2007-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""WorkingTree4 format and implementation.
18
18
 
28
28
 
29
29
from bzrlib.lazy_import import lazy_import
30
30
lazy_import(globals(), """
31
 
from bisect import bisect_left
32
 
import collections
33
 
from copy import deepcopy
34
31
import errno
35
 
import itertools
36
 
import operator
37
32
import stat
38
 
from time import time
39
 
import warnings
40
33
 
41
 
import bzrlib
42
34
from bzrlib import (
43
35
    bzrdir,
44
36
    cache_utf8,
45
37
    conflicts as _mod_conflicts,
46
38
    debug,
47
 
    delta,
48
39
    dirstate,
49
40
    errors,
 
41
    filters as _mod_filters,
50
42
    generate_ids,
51
 
    globbing,
52
 
    ignores,
53
 
    merge,
54
43
    osutils,
55
44
    revision as _mod_revision,
56
45
    revisiontree,
57
 
    textui,
58
46
    trace,
59
47
    transform,
60
 
    urlutils,
61
 
    xml5,
62
 
    xml6,
 
48
    views,
63
49
    )
64
 
import bzrlib.branch
65
 
from bzrlib.transport import get_transport
66
 
import bzrlib.ui
67
50
""")
68
51
 
69
 
from bzrlib import symbol_versioning
70
52
from bzrlib.decorators import needs_read_lock, needs_write_lock
71
 
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, entry_factory
72
 
from bzrlib.lockable_files import LockableFiles, TransportLock
 
53
from bzrlib.inventory import Inventory, ROOT_ID, entry_factory
 
54
from bzrlib.lock import LogicalLockResult
 
55
from bzrlib.lockable_files import LockableFiles
73
56
from bzrlib.lockdir import LockDir
74
 
import bzrlib.mutabletree
75
57
from bzrlib.mutabletree import needs_tree_write_lock
76
58
from bzrlib.osutils import (
77
59
    file_kind,
78
60
    isdir,
79
 
    normpath,
80
61
    pathjoin,
81
 
    rand_chars,
82
62
    realpath,
83
63
    safe_unicode,
84
 
    splitpath,
85
64
    )
86
 
from bzrlib.trace import mutter, note
87
65
from bzrlib.transport.local import LocalTransport
88
 
from bzrlib.tree import InterTree
89
 
from bzrlib.progress import DummyProgress, ProgressPhase
90
 
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
91
 
from bzrlib.rio import RioReader, rio_file, Stanza
92
 
from bzrlib.symbol_versioning import (deprecated_passed,
93
 
        deprecated_method,
94
 
        deprecated_function,
95
 
        DEPRECATED_PARAMETER,
96
 
        )
97
 
from bzrlib.tree import Tree
98
 
from bzrlib.workingtree import WorkingTree, WorkingTree3, WorkingTreeFormat3
99
 
 
100
 
 
101
 
# This is the Windows equivalent of ENOTDIR
102
 
# It is defined in pywin32.winerror, but we don't want a strong dependency for
103
 
# just an error code.
104
 
ERROR_PATH_NOT_FOUND = 3
105
 
ERROR_DIRECTORY = 267
106
 
 
107
 
 
108
 
class WorkingTree4(WorkingTree3):
109
 
    """This is the Format 4 working tree.
110
 
 
111
 
    This differs from WorkingTree3 by:
112
 
     - Having a consolidated internal dirstate, stored in a
113
 
       randomly-accessible sorted file on disk.
114
 
     - Not having a regular inventory attribute.  One can be synthesized 
115
 
       on demand but this is expensive and should be avoided.
116
 
 
117
 
    This is new in bzr 0.15.
118
 
    """
 
66
from bzrlib.tree import (
 
67
    InterTree,
 
68
    InventoryTree,
 
69
    )
 
70
from bzrlib.workingtree import (
 
71
    InventoryWorkingTree,
 
72
    WorkingTree,
 
73
    WorkingTreeFormat,
 
74
    )
 
75
 
 
76
 
 
77
class DirStateWorkingTree(InventoryWorkingTree):
 
78
 
 
79
    _DEFAULT_WORTH_SAVING_LIMIT = 10
119
80
 
120
81
    def __init__(self, basedir,
121
82
                 branch,
131
92
        """
132
93
        self._format = _format
133
94
        self.bzrdir = _bzrdir
134
 
        assert isinstance(basedir, basestring), \
135
 
            "base directory %r is not a string" % basedir
136
95
        basedir = safe_unicode(basedir)
137
 
        mutter("opening working tree %r", basedir)
 
96
        trace.mutter("opening working tree %r", basedir)
138
97
        self._branch = branch
139
 
        assert isinstance(self.branch, bzrlib.branch.Branch), \
140
 
            "branch %r is not a Branch" % self.branch
141
98
        self.basedir = realpath(basedir)
142
99
        # if branch is at our basedir and is a format 6 or less
143
100
        # assume all other formats have their own control files.
144
 
        assert isinstance(_control_files, LockableFiles), \
145
 
            "_control_files must be a LockableFiles, not %r" % _control_files
146
101
        self._control_files = _control_files
 
102
        self._transport = self._control_files._transport
147
103
        self._dirty = None
148
104
        #-------------
149
105
        # during a read or write lock these objects are set, and are
151
107
        self._dirstate = None
152
108
        self._inventory = None
153
109
        #-------------
 
110
        self._setup_directory_is_tree_reference()
 
111
        self._detect_case_handling()
 
112
        self._rules_searcher = None
 
113
        self.views = self._make_views()
 
114
        #--- allow tests to select the dirstate iter_changes implementation
 
115
        self._iter_changes = dirstate._process_entry
154
116
 
155
117
    @needs_tree_write_lock
156
118
    def _add(self, files, ids, kinds):
171
133
            state.add(f, file_id, kind, None, '')
172
134
        self._make_dirty(reset_inventory=True)
173
135
 
 
136
    def _get_check_refs(self):
 
137
        """Return the references needed to perform a check of this tree."""
 
138
        return [('trees', self.last_revision())]
 
139
 
174
140
    def _make_dirty(self, reset_inventory):
175
141
        """Make the tree state dirty.
176
142
 
184
150
    @needs_tree_write_lock
185
151
    def add_reference(self, sub_tree):
186
152
        # use standard implementation, which calls back to self._add
187
 
        # 
 
153
        #
188
154
        # So we don't store the reference_revision in the working dirstate,
189
 
        # it's just recorded at the moment of commit. 
 
155
        # it's just recorded at the moment of commit.
190
156
        self._add_reference(sub_tree)
191
157
 
192
158
    def break_lock(self):
228
194
 
229
195
    def _comparison_data(self, entry, path):
230
196
        kind, executable, stat_value = \
231
 
            WorkingTree3._comparison_data(self, entry, path)
 
197
            WorkingTree._comparison_data(self, entry, path)
232
198
        # it looks like a plain directory, but it's really a reference -- see
233
199
        # also kind()
234
 
        if (self._repo_supports_tree_reference and
235
 
            kind == 'directory' and
236
 
            self._directory_is_tree_reference(path)):
 
200
        if (self._repo_supports_tree_reference and kind == 'directory'
 
201
            and entry is not None and entry.kind == 'tree-reference'):
237
202
            kind = 'tree-reference'
238
203
        return kind, executable, stat_value
239
204
 
241
206
    def commit(self, message=None, revprops=None, *args, **kwargs):
242
207
        # mark the tree as dirty post commit - commit
243
208
        # can change the current versioned list by doing deletes.
244
 
        result = WorkingTree3.commit(self, message, revprops, *args, **kwargs)
 
209
        result = WorkingTree.commit(self, message, revprops, *args, **kwargs)
245
210
        self._make_dirty(reset_inventory=True)
246
211
        return result
247
212
 
265
230
            return self._dirstate
266
231
        local_path = self.bzrdir.get_workingtree_transport(None
267
232
            ).local_abspath('dirstate')
268
 
        self._dirstate = dirstate.DirState.on_file(local_path)
 
233
        self._dirstate = dirstate.DirState.on_file(local_path,
 
234
            self._sha1_provider(), self._worth_saving_limit())
269
235
        return self._dirstate
270
236
 
 
237
    def _sha1_provider(self):
 
238
        """A function that returns a SHA1Provider suitable for this tree.
 
239
 
 
240
        :return: None if content filtering is not supported by this tree.
 
241
          Otherwise, a SHA1Provider is returned that sha's the canonical
 
242
          form of files, i.e. after read filters are applied.
 
243
        """
 
244
        if self.supports_content_filtering():
 
245
            return ContentFilterAwareSHA1Provider(self)
 
246
        else:
 
247
            return None
 
248
 
 
249
    def _worth_saving_limit(self):
 
250
        """How many hash changes are ok before we must save the dirstate.
 
251
 
 
252
        :return: an integer. -1 means never save.
 
253
        """
 
254
        config = self.branch.get_config()
 
255
        val = config.get_user_option('bzr.workingtree.worth_saving_limit')
 
256
        if val is None:
 
257
            val = self._DEFAULT_WORTH_SAVING_LIMIT
 
258
        else:
 
259
            try:
 
260
                val = int(val)
 
261
            except ValueError, e:
 
262
                trace.warning('Invalid config value for'
 
263
                              ' "bzr.workingtree.worth_saving_limit"'
 
264
                              ' value %r is not an integer.'
 
265
                              % (val,))
 
266
                val = self._DEFAULT_WORTH_SAVING_LIMIT
 
267
        return val
 
268
 
271
269
    def filter_unversioned_files(self, paths):
272
270
        """Filter out paths that are versioned.
273
271
 
305
303
 
306
304
    def _generate_inventory(self):
307
305
        """Create and set self.inventory from the dirstate object.
308
 
        
 
306
 
309
307
        This is relatively expensive: we have to walk the entire dirstate.
310
308
        Ideally we would not, and can deprecate this function.
311
309
        """
315
313
        state._read_dirblocks_if_needed()
316
314
        root_key, current_entry = self._get_entry(path='')
317
315
        current_id = root_key[2]
318
 
        assert current_entry[0][0] == 'd' # directory
 
316
        if not (current_entry[0][0] == 'd'): # directory
 
317
            raise AssertionError(current_entry)
319
318
        inv = Inventory(root_id=current_id)
320
319
        # Turn some things into local variables
321
320
        minikind_to_kind = dirstate.DirState._minikind_to_kind
354
353
                    # add this entry to the parent map.
355
354
                    parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
356
355
                elif kind == 'tree-reference':
357
 
                    assert self._repo_supports_tree_reference, \
358
 
                        "repository of %r " \
359
 
                        "doesn't support tree references " \
360
 
                        "required by entry %r" \
361
 
                        % (self, name)
 
356
                    if not self._repo_supports_tree_reference:
 
357
                        raise errors.UnsupportedOperation(
 
358
                            self._generate_inventory,
 
359
                            self.branch.repository)
362
360
                    inv_entry.reference_revision = link_or_sha1 or None
363
361
                elif kind != 'symlink':
364
362
                    raise AssertionError("unknown kind %r" % kind)
365
363
                # These checks cost us around 40ms on a 55k entry tree
366
 
                assert file_id not in inv_byid, ('file_id %s already in'
367
 
                    ' inventory as %s' % (file_id, inv_byid[file_id]))
368
 
                assert name_unicode not in parent_ie.children
 
364
                if file_id in inv_byid:
 
365
                    raise AssertionError('file_id %s already in'
 
366
                        ' inventory as %s' % (file_id, inv_byid[file_id]))
 
367
                if name_unicode in parent_ie.children:
 
368
                    raise AssertionError('name %r already in parent'
 
369
                        % (name_unicode,))
369
370
                inv_byid[file_id] = inv_entry
370
371
                parent_ie.children[name_unicode] = inv_entry
371
372
        self._inventory = inv
376
377
        If either file_id or path is supplied, it is used as the key to lookup.
377
378
        If both are supplied, the fastest lookup is used, and an error is
378
379
        raised if they do not both point at the same row.
379
 
        
 
380
 
380
381
        :param file_id: An optional unicode file_id to be looked up.
381
382
        :param path: An optional unicode path to be looked up.
382
383
        :return: The dirstate row tuple for path/file_id, or (None, None)
400
401
        state = self.current_dirstate()
401
402
        if stat_value is None:
402
403
            try:
403
 
                stat_value = os.lstat(file_abspath)
 
404
                stat_value = osutils.lstat(file_abspath)
404
405
            except OSError, e:
405
406
                if e.errno == errno.ENOENT:
406
407
                    return None
407
408
                else:
408
409
                    raise
409
 
        link_or_sha1 = state.update_entry(entry, file_abspath,
410
 
                                          stat_value=stat_value)
 
410
        link_or_sha1 = dirstate.update_entry(state, entry, file_abspath,
 
411
            stat_value=stat_value)
411
412
        if entry[1][0][0] == 'f':
412
 
            return link_or_sha1
 
413
            if link_or_sha1 is None:
 
414
                file_obj, statvalue = self.get_file_with_stat(file_id, path)
 
415
                try:
 
416
                    sha1 = osutils.sha_file(file_obj)
 
417
                finally:
 
418
                    file_obj.close()
 
419
                self._observed_sha1(file_id, path, (sha1, statvalue))
 
420
                return sha1
 
421
            else:
 
422
                return link_or_sha1
413
423
        return None
414
424
 
415
425
    def _get_inventory(self):
429
439
    @needs_read_lock
430
440
    def get_parent_ids(self):
431
441
        """See Tree.get_parent_ids.
432
 
        
 
442
 
433
443
        This implementation requests the ids list from the dirstate file.
434
444
        """
435
445
        return self.current_dirstate().get_parent_ids()
457
467
        return osutils.lexists(pathjoin(
458
468
                    self.basedir, row[0].decode('utf8'), row[1].decode('utf8')))
459
469
 
 
470
    def has_or_had_id(self, file_id):
 
471
        state = self.current_dirstate()
 
472
        row, parents = self._get_entry(file_id=file_id)
 
473
        return row is not None
 
474
 
460
475
    @needs_read_lock
461
476
    def id2path(self, file_id):
462
477
        "Convert a file-id to a path."
492
507
 
493
508
            Note: The caller is expected to take a read-lock before calling this.
494
509
            """
 
510
            self._must_be_locked()
495
511
            if not path:
496
512
                path = self.id2path(file_id)
497
 
            mode = os.lstat(self.abspath(path)).st_mode
 
513
            mode = osutils.lstat(self.abspath(path)).st_mode
498
514
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
499
515
 
 
516
    def all_file_ids(self):
 
517
        """See Tree.iter_all_file_ids"""
 
518
        self._must_be_locked()
 
519
        result = set()
 
520
        for key, tree_details in self.current_dirstate()._iter_entries():
 
521
            if tree_details[0][0] in ('a', 'r'): # relocated
 
522
                continue
 
523
            result.add(key[2])
 
524
        return result
 
525
 
500
526
    @needs_read_lock
501
527
    def __iter__(self):
502
528
        """Iterate through file_ids for this tree.
515
541
        return iter(result)
516
542
 
517
543
    def iter_references(self):
 
544
        if not self._repo_supports_tree_reference:
 
545
            # When the repo doesn't support references, we will have nothing to
 
546
            # return
 
547
            return
518
548
        for key, tree_details in self.current_dirstate()._iter_entries():
519
549
            if tree_details[0][0] in ('a', 'r'): # absent, relocated
520
550
                # not relevant to the working tree
522
552
            if not key[1]:
523
553
                # the root is not a reference.
524
554
                continue
525
 
            path = pathjoin(self.basedir, key[0].decode('utf8'), key[1].decode('utf8'))
 
555
            relpath = pathjoin(key[0].decode('utf8'), key[1].decode('utf8'))
526
556
            try:
527
 
                if self._kind(path) == 'tree-reference':
528
 
                    yield path, key[2]
 
557
                if self._kind(relpath) == 'tree-reference':
 
558
                    yield relpath, key[2]
529
559
            except errors.NoSuchFile:
530
560
                # path is missing on disk.
531
561
                continue
532
562
 
 
563
    def _observed_sha1(self, file_id, path, (sha1, statvalue)):
 
564
        """See MutableTree._observed_sha1."""
 
565
        state = self.current_dirstate()
 
566
        entry = self._get_entry(file_id=file_id, path=path)
 
567
        state._observed_sha1(entry, sha1, statvalue)
 
568
 
533
569
    def kind(self, file_id):
534
570
        """Return the kind of a file.
535
571
 
539
575
        Note: The caller is expected to take a read-lock before calling this.
540
576
        """
541
577
        relpath = self.id2path(file_id)
542
 
        assert relpath != None, \
543
 
            "path for id {%s} is None!" % file_id
 
578
        if relpath is None:
 
579
            raise AssertionError(
 
580
                "path for id {%s} is None!" % file_id)
544
581
        return self._kind(relpath)
545
582
 
546
583
    def _kind(self, relpath):
547
584
        abspath = self.abspath(relpath)
548
585
        kind = file_kind(abspath)
549
 
        if (self._repo_supports_tree_reference and
550
 
            kind == 'directory' and
551
 
            self._directory_is_tree_reference(relpath)):
552
 
            kind = 'tree-reference'
 
586
        if (self._repo_supports_tree_reference and kind == 'directory'):
 
587
            entry = self._get_entry(path=relpath)
 
588
            if entry[1] is not None:
 
589
                if entry[1][0][0] == 't':
 
590
                    kind = 'tree-reference'
553
591
        return kind
554
592
 
555
593
    @needs_read_lock
562
600
            return _mod_revision.NULL_REVISION
563
601
 
564
602
    def lock_read(self):
565
 
        """See Branch.lock_read, and WorkingTree.unlock."""
 
603
        """See Branch.lock_read, and WorkingTree.unlock.
 
604
 
 
605
        :return: A bzrlib.lock.LogicalLockResult.
 
606
        """
566
607
        self.branch.lock_read()
567
608
        try:
568
609
            self._control_files.lock_read()
581
622
        except:
582
623
            self.branch.unlock()
583
624
            raise
 
625
        return LogicalLockResult(self.unlock)
584
626
 
585
627
    def _lock_self_write(self):
586
628
        """This should be called after the branch is locked."""
601
643
        except:
602
644
            self.branch.unlock()
603
645
            raise
 
646
        return LogicalLockResult(self.unlock)
604
647
 
605
648
    def lock_tree_write(self):
606
 
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
 
649
        """See MutableTree.lock_tree_write, and WorkingTree.unlock.
 
650
 
 
651
        :return: A bzrlib.lock.LogicalLockResult.
 
652
        """
607
653
        self.branch.lock_read()
608
 
        self._lock_self_write()
 
654
        return self._lock_self_write()
609
655
 
610
656
    def lock_write(self):
611
 
        """See MutableTree.lock_write, and WorkingTree.unlock."""
 
657
        """See MutableTree.lock_write, and WorkingTree.unlock.
 
658
 
 
659
        :return: A bzrlib.lock.LogicalLockResult.
 
660
        """
612
661
        self.branch.lock_write()
613
 
        self._lock_self_write()
 
662
        return self._lock_self_write()
614
663
 
615
664
    @needs_tree_write_lock
616
665
    def move(self, from_paths, to_dir, after=False):
618
667
        result = []
619
668
        if not from_paths:
620
669
            return result
621
 
 
622
670
        state = self.current_dirstate()
623
 
 
624
 
        assert not isinstance(from_paths, basestring)
 
671
        if isinstance(from_paths, basestring):
 
672
            raise ValueError()
625
673
        to_dir_utf8 = to_dir.encode('utf8')
626
674
        to_entry_dirname, to_basename = os.path.split(to_dir_utf8)
627
675
        id_index = state._get_id_index()
649
697
        if self._inventory is not None:
650
698
            update_inventory = True
651
699
            inv = self.inventory
 
700
            to_dir_id = to_entry[0][2]
652
701
            to_dir_ie = inv[to_dir_id]
653
 
            to_dir_id = to_entry[0][2]
654
702
        else:
655
703
            update_inventory = False
656
704
 
687
735
            from_entry = self._get_entry(path=from_rel)
688
736
            if from_entry == (None, None):
689
737
                raise errors.BzrMoveFailedError(from_rel,to_dir,
690
 
                    errors.NotVersionedError(path=str(from_rel)))
 
738
                    errors.NotVersionedError(path=from_rel))
691
739
 
692
740
            from_id = from_entry[0][2]
693
741
            to_rel = pathjoin(to_dir, from_tail)
782
830
                if minikind == 'd':
783
831
                    def update_dirblock(from_dir, to_key, to_dir_utf8):
784
832
                        """Recursively update all entries in this dirblock."""
785
 
                        assert from_dir != '', "renaming root not supported"
 
833
                        if from_dir == '':
 
834
                            raise AssertionError("renaming root not supported")
786
835
                        from_key = (from_dir, '')
787
836
                        from_block_idx, present = \
788
837
                            state._find_block_index_from_key(from_key)
801
850
 
802
851
                        # Grab a copy since move_one may update the list.
803
852
                        for entry in from_block[1][:]:
804
 
                            assert entry[0][0] == from_dir
 
853
                            if not (entry[0][0] == from_dir):
 
854
                                raise AssertionError()
805
855
                            cur_details = entry[1][0]
806
856
                            to_key = (to_dir_utf8, entry[0][1], entry[0][2])
807
857
                            from_path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
832
882
                rollback_rename()
833
883
                raise
834
884
            result.append((from_rel, to_rel))
835
 
            state._dirblock_state = dirstate.DirState.IN_MEMORY_MODIFIED
 
885
            state._mark_modified()
836
886
            self._make_dirty(reset_inventory=False)
837
887
 
838
888
        return result
866
916
        for tree in trees:
867
917
            if not (isinstance(tree, DirStateRevisionTree) and tree._revision_id in
868
918
                parents):
869
 
                return super(WorkingTree4, self).paths2ids(paths, trees, require_versioned)
 
919
                return super(DirStateWorkingTree, self).paths2ids(paths,
 
920
                    trees, require_versioned)
870
921
        search_indexes = [0] + [1 + parents.index(tree._revision_id) for tree in trees]
871
922
        # -- make all paths utf8 --
872
923
        paths_utf8 = set()
933
984
                raise errors.PathsNotVersionedError(paths)
934
985
        # -- remove redundancy in supplied paths to prevent over-scanning --
935
986
        search_paths = osutils.minimum_path_selection(paths)
936
 
        # sketch: 
 
987
        # sketch:
937
988
        # for all search_indexs in each path at or under each element of
938
989
        # search_paths, if the detail is relocated: add the id, and add the
939
990
        # relocated path as one to search if its not searched already. If the
995
1046
 
996
1047
    def read_working_inventory(self):
997
1048
        """Read the working inventory.
998
 
        
 
1049
 
999
1050
        This is a meaningless operation for dirstate, but we obey it anyhow.
1000
1051
        """
1001
1052
        return self.inventory
1019
1070
    def set_last_revision(self, new_revision):
1020
1071
        """Change the last revision in the working tree."""
1021
1072
        parents = self.get_parent_ids()
1022
 
        if new_revision in (NULL_REVISION, None):
1023
 
            assert len(parents) < 2, (
1024
 
                "setting the last parent to none with a pending merge is "
1025
 
                "unsupported.")
 
1073
        if new_revision in (_mod_revision.NULL_REVISION, None):
 
1074
            if len(parents) >= 2:
 
1075
                raise AssertionError(
 
1076
                    "setting the last parent to none with a pending merge is "
 
1077
                    "unsupported.")
1026
1078
            self.set_parent_ids([])
1027
1079
        else:
1028
1080
            self.set_parent_ids([new_revision] + parents[1:],
1031
1083
    @needs_tree_write_lock
1032
1084
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
1033
1085
        """Set the parent ids to revision_ids.
1034
 
        
 
1086
 
1035
1087
        See also set_parent_trees. This api will try to retrieve the tree data
1036
1088
        for each element of revision_ids from the trees repository. If you have
1037
1089
        tree data already available, it is more efficient to use
1069
1121
                raise errors.GhostRevisionUnusableHere(parents_list[0][0])
1070
1122
        real_trees = []
1071
1123
        ghosts = []
 
1124
 
 
1125
        parent_ids = [rev_id for rev_id, tree in parents_list]
 
1126
        graph = self.branch.repository.get_graph()
 
1127
        heads = graph.heads(parent_ids)
 
1128
        accepted_revisions = set()
 
1129
 
1072
1130
        # convert absent trees to the null tree, which we convert back to
1073
1131
        # missing on access.
1074
1132
        for rev_id, tree in parents_list:
 
1133
            if len(accepted_revisions) > 0:
 
1134
                # we always accept the first tree
 
1135
                if rev_id in accepted_revisions or rev_id not in heads:
 
1136
                    # We have already included either this tree, or its
 
1137
                    # descendent, so we skip it.
 
1138
                    continue
1075
1139
            _mod_revision.check_not_reserved_id(rev_id)
1076
1140
            if tree is not None:
1077
1141
                real_trees.append((rev_id, tree))
1078
1142
            else:
1079
1143
                real_trees.append((rev_id,
1080
 
                    self.branch.repository.revision_tree(None)))
 
1144
                    self.branch.repository.revision_tree(
 
1145
                        _mod_revision.NULL_REVISION)))
1081
1146
                ghosts.append(rev_id)
 
1147
            accepted_revisions.add(rev_id)
1082
1148
        dirstate.set_parent_trees(real_trees, ghosts=ghosts)
1083
1149
        self._make_dirty(reset_inventory=False)
1084
1150
 
1177
1243
                # just forget the whole block.
1178
1244
                entry_index = 0
1179
1245
                while entry_index < len(block[1]):
1180
 
                    # Mark this file id as having been removed
1181
1246
                    entry = block[1][entry_index]
1182
 
                    ids_to_unversion.discard(entry[0][2])
1183
 
                    if (entry[1][0][0] in 'ar' # don't remove absent or renamed
1184
 
                                               # entries
1185
 
                        or not state._make_absent(entry)):
 
1247
                    if entry[1][0][0] in 'ar':
 
1248
                        # don't remove absent or renamed entries
1186
1249
                        entry_index += 1
 
1250
                    else:
 
1251
                        # Mark this file id as having been removed
 
1252
                        ids_to_unversion.discard(entry[0][2])
 
1253
                        if not state._make_absent(entry):
 
1254
                            # The block has not shrunk.
 
1255
                            entry_index += 1
1187
1256
                # go to the next block. (At the moment we dont delete empty
1188
1257
                # dirblocks)
1189
1258
                block_index += 1
1210
1279
        # have to change the legacy inventory too.
1211
1280
        if self._inventory is not None:
1212
1281
            for file_id in file_ids:
1213
 
                self._inventory.remove_recursive_id(file_id)
 
1282
                if self._inventory.has_id(file_id):
 
1283
                    self._inventory.remove_recursive_id(file_id)
 
1284
 
 
1285
    @needs_tree_write_lock
 
1286
    def rename_one(self, from_rel, to_rel, after=False):
 
1287
        """See WorkingTree.rename_one"""
 
1288
        self.flush()
 
1289
        super(DirStateWorkingTree, self).rename_one(from_rel, to_rel, after)
 
1290
 
 
1291
    @needs_tree_write_lock
 
1292
    def apply_inventory_delta(self, changes):
 
1293
        """See MutableTree.apply_inventory_delta"""
 
1294
        state = self.current_dirstate()
 
1295
        state.update_by_delta(changes)
 
1296
        self._make_dirty(reset_inventory=True)
1214
1297
 
1215
1298
    def update_basis_by_delta(self, new_revid, delta):
1216
1299
        """See MutableTree.update_basis_by_delta."""
1217
 
        assert self.last_revision() != new_revid
 
1300
        if self.last_revision() == new_revid:
 
1301
            raise AssertionError()
1218
1302
        self.current_dirstate().update_basis_by_delta(delta, new_revid)
1219
1303
 
1220
1304
    @needs_read_lock
1224
1308
    @needs_tree_write_lock
1225
1309
    def _write_inventory(self, inv):
1226
1310
        """Write inventory as the current inventory."""
1227
 
        assert not self._dirty, ("attempting to write an inventory when the "
1228
 
            "dirstate is dirty will cause data loss")
1229
 
        self.current_dirstate().set_state_from_inventory(inv)
1230
 
        self._make_dirty(reset_inventory=False)
1231
 
        if self._inventory is not None:
 
1311
        if self._dirty:
 
1312
            raise AssertionError("attempting to write an inventory when the "
 
1313
                "dirstate is dirty will lose pending changes")
 
1314
        had_inventory = self._inventory is not None
 
1315
        # Setting self._inventory = None forces the dirstate to regenerate the
 
1316
        # working inventory. We do this because self.inventory may be inv, or
 
1317
        # may have been modified, and either case would prevent a clean delta
 
1318
        # being created.
 
1319
        self._inventory = None
 
1320
        # generate a delta,
 
1321
        delta = inv._make_delta(self.inventory)
 
1322
        # and apply it.
 
1323
        self.apply_inventory_delta(delta)
 
1324
        if had_inventory:
1232
1325
            self._inventory = inv
1233
1326
        self.flush()
1234
1327
 
1235
 
 
1236
 
class WorkingTreeFormat4(WorkingTreeFormat3):
1237
 
    """The first consolidated dirstate working tree format.
1238
 
 
1239
 
    This format:
1240
 
        - exists within a metadir controlling .bzr
1241
 
        - includes an explicit version marker for the workingtree control
1242
 
          files, separate from the BzrDir format
1243
 
        - modifies the hash cache format
1244
 
        - is new in bzr 0.15
1245
 
        - uses a LockDir to guard access to it.
1246
 
    """
1247
 
 
1248
 
    upgrade_recommended = False
1249
 
 
1250
 
    def get_format_string(self):
1251
 
        """See WorkingTreeFormat.get_format_string()."""
1252
 
        return "Bazaar Working Tree Format 4 (bzr 0.15)\n"
1253
 
 
1254
 
    def get_format_description(self):
1255
 
        """See WorkingTreeFormat.get_format_description()."""
1256
 
        return "Working tree format 4"
1257
 
 
1258
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None):
 
1328
    @needs_tree_write_lock
 
1329
    def reset_state(self, revision_ids=None):
 
1330
        """Reset the state of the working tree.
 
1331
 
 
1332
        This does a hard-reset to a last-known-good state. This is a way to
 
1333
        fix if something got corrupted (like the .bzr/checkout/dirstate file)
 
1334
        """
 
1335
        if revision_ids is None:
 
1336
            revision_ids = self.get_parent_ids()
 
1337
        if not revision_ids:
 
1338
            base_tree = self.branch.repository.revision_tree(
 
1339
                _mod_revision.NULL_REVISION)
 
1340
            trees = []
 
1341
        else:
 
1342
            trees = zip(revision_ids,
 
1343
                        self.branch.repository.revision_trees(revision_ids))
 
1344
            base_tree = trees[0][1]
 
1345
        state = self.current_dirstate()
 
1346
        # We don't support ghosts yet
 
1347
        state.set_state_from_scratch(base_tree.inventory, trees, [])
 
1348
 
 
1349
 
 
1350
class ContentFilterAwareSHA1Provider(dirstate.SHA1Provider):
 
1351
 
 
1352
    def __init__(self, tree):
 
1353
        self.tree = tree
 
1354
 
 
1355
    def sha1(self, abspath):
 
1356
        """See dirstate.SHA1Provider.sha1()."""
 
1357
        filters = self.tree._content_filter_stack(
 
1358
            self.tree.relpath(osutils.safe_unicode(abspath)))
 
1359
        return _mod_filters.internal_size_sha_file_byname(abspath, filters)[1]
 
1360
 
 
1361
    def stat_and_sha1(self, abspath):
 
1362
        """See dirstate.SHA1Provider.stat_and_sha1()."""
 
1363
        filters = self.tree._content_filter_stack(
 
1364
            self.tree.relpath(osutils.safe_unicode(abspath)))
 
1365
        file_obj = file(abspath, 'rb', 65000)
 
1366
        try:
 
1367
            statvalue = os.fstat(file_obj.fileno())
 
1368
            if filters:
 
1369
                file_obj = _mod_filters.filtered_input_file(file_obj, filters)
 
1370
            sha1 = osutils.size_sha_file(file_obj)[1]
 
1371
        finally:
 
1372
            file_obj.close()
 
1373
        return statvalue, sha1
 
1374
 
 
1375
 
 
1376
class ContentFilteringDirStateWorkingTree(DirStateWorkingTree):
 
1377
    """Dirstate working tree that supports content filtering.
 
1378
 
 
1379
    The dirstate holds the hash and size of the canonical form of the file, 
 
1380
    and most methods must return that.
 
1381
    """
 
1382
 
 
1383
    def _file_content_summary(self, path, stat_result):
 
1384
        # This is to support the somewhat obsolete path_content_summary method
 
1385
        # with content filtering: see
 
1386
        # <https://bugs.launchpad.net/bzr/+bug/415508>.
 
1387
        #
 
1388
        # If the dirstate cache is up to date and knows the hash and size,
 
1389
        # return that.
 
1390
        # Otherwise if there are no content filters, return the on-disk size
 
1391
        # and leave the hash blank.
 
1392
        # Otherwise, read and filter the on-disk file and use its size and
 
1393
        # hash.
 
1394
        #
 
1395
        # The dirstate doesn't store the size of the canonical form so we
 
1396
        # can't trust it for content-filtered trees.  We just return None.
 
1397
        dirstate_sha1 = self._dirstate.sha1_from_stat(path, stat_result)
 
1398
        executable = self._is_executable_from_path_and_stat(path, stat_result)
 
1399
        return ('file', None, executable, dirstate_sha1)
 
1400
 
 
1401
 
 
1402
class WorkingTree4(DirStateWorkingTree):
 
1403
    """This is the Format 4 working tree.
 
1404
 
 
1405
    This differs from WorkingTree by:
 
1406
     - Having a consolidated internal dirstate, stored in a
 
1407
       randomly-accessible sorted file on disk.
 
1408
     - Not having a regular inventory attribute.  One can be synthesized
 
1409
       on demand but this is expensive and should be avoided.
 
1410
 
 
1411
    This is new in bzr 0.15.
 
1412
    """
 
1413
 
 
1414
 
 
1415
class WorkingTree5(ContentFilteringDirStateWorkingTree):
 
1416
    """This is the Format 5 working tree.
 
1417
 
 
1418
    This differs from WorkingTree4 by:
 
1419
     - Supporting content filtering.
 
1420
 
 
1421
    This is new in bzr 1.11.
 
1422
    """
 
1423
 
 
1424
 
 
1425
class WorkingTree6(ContentFilteringDirStateWorkingTree):
 
1426
    """This is the Format 6 working tree.
 
1427
 
 
1428
    This differs from WorkingTree5 by:
 
1429
     - Supporting a current view that may mask the set of files in a tree
 
1430
       impacted by most user operations.
 
1431
 
 
1432
    This is new in bzr 1.14.
 
1433
    """
 
1434
 
 
1435
    def _make_views(self):
 
1436
        return views.PathBasedViews(self)
 
1437
 
 
1438
 
 
1439
class DirStateWorkingTreeFormat(WorkingTreeFormat):
 
1440
 
 
1441
    missing_parent_conflicts = True
 
1442
 
 
1443
    _lock_class = LockDir
 
1444
    _lock_file_name = 'lock'
 
1445
 
 
1446
    def _open_control_files(self, a_bzrdir):
 
1447
        transport = a_bzrdir.get_workingtree_transport(None)
 
1448
        return LockableFiles(transport, self._lock_file_name,
 
1449
                             self._lock_class)
 
1450
 
 
1451
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
 
1452
                   accelerator_tree=None, hardlink=False):
1259
1453
        """See WorkingTreeFormat.initialize().
1260
1454
 
1261
1455
        :param revision_id: allows creating a working tree at a different
1262
1456
        revision than the branch is at.
 
1457
        :param accelerator_tree: A tree which can be used for retrieving file
 
1458
            contents more quickly than the revision tree, i.e. a workingtree.
 
1459
            The revision tree will be used for cases where accelerator_tree's
 
1460
            content is different.
 
1461
        :param hardlink: If true, hard-link files from accelerator_tree,
 
1462
            where possible.
1263
1463
 
1264
1464
        These trees get an initial random root id, if their repository supports
1265
1465
        rich root data, TREE_ROOT otherwise.
1270
1470
        control_files = self._open_control_files(a_bzrdir)
1271
1471
        control_files.create_lock()
1272
1472
        control_files.lock_write()
1273
 
        control_files.put_utf8('format', self.get_format_string())
 
1473
        transport.put_bytes('format', self.get_format_string(),
 
1474
            mode=a_bzrdir._get_file_mode())
1274
1475
        if from_branch is not None:
1275
1476
            branch = from_branch
1276
1477
        else:
1282
1483
        state = dirstate.DirState.initialize(local_path)
1283
1484
        state.unlock()
1284
1485
        del state
1285
 
        wt = WorkingTree4(a_bzrdir.root_transport.local_abspath('.'),
 
1486
        wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
1286
1487
                         branch,
1287
1488
                         _format=self,
1288
1489
                         _bzrdir=a_bzrdir,
1290
1491
        wt._new_tree()
1291
1492
        wt.lock_tree_write()
1292
1493
        try:
1293
 
            if revision_id in (None, NULL_REVISION):
 
1494
            self._init_custom_control_files(wt)
 
1495
            if revision_id in (None, _mod_revision.NULL_REVISION):
1294
1496
                if branch.repository.supports_rich_root():
1295
1497
                    wt._set_root_id(generate_ids.gen_root_id())
1296
1498
                else:
1297
1499
                    wt._set_root_id(ROOT_ID)
1298
1500
                wt.flush()
1299
 
            wt.set_last_revision(revision_id)
1300
 
            wt.flush()
1301
 
            basis = wt.basis_tree()
 
1501
            basis = None
 
1502
            # frequently, we will get here due to branching.  The accelerator
 
1503
            # tree will be the tree from the branch, so the desired basis
 
1504
            # tree will often be a parent of the accelerator tree.
 
1505
            if accelerator_tree is not None:
 
1506
                try:
 
1507
                    basis = accelerator_tree.revision_tree(revision_id)
 
1508
                except errors.NoSuchRevision:
 
1509
                    pass
 
1510
            if basis is None:
 
1511
                basis = branch.repository.revision_tree(revision_id)
 
1512
            if revision_id == _mod_revision.NULL_REVISION:
 
1513
                parents_list = []
 
1514
            else:
 
1515
                parents_list = [(revision_id, basis)]
1302
1516
            basis.lock_read()
1303
 
            # if the basis has a root id we have to use that; otherwise we use
1304
 
            # a new random one
1305
 
            basis_root_id = basis.get_root_id()
1306
 
            if basis_root_id is not None:
1307
 
                wt._set_root_id(basis_root_id)
 
1517
            try:
 
1518
                wt.set_parent_trees(parents_list, allow_leftmost_as_ghost=True)
1308
1519
                wt.flush()
1309
 
            transform.build_tree(basis, wt)
1310
 
            basis.unlock()
 
1520
                # if the basis has a root id we have to use that; otherwise we
 
1521
                # use a new random one
 
1522
                basis_root_id = basis.get_root_id()
 
1523
                if basis_root_id is not None:
 
1524
                    wt._set_root_id(basis_root_id)
 
1525
                    wt.flush()
 
1526
                if wt.supports_content_filtering():
 
1527
                    # The original tree may not have the same content filters
 
1528
                    # applied so we can't safely build the inventory delta from
 
1529
                    # the source tree.
 
1530
                    delta_from_tree = False
 
1531
                else:
 
1532
                    delta_from_tree = True
 
1533
                # delta_from_tree is safe even for DirStateRevisionTrees,
 
1534
                # because wt4.apply_inventory_delta does not mutate the input
 
1535
                # inventory entries.
 
1536
                transform.build_tree(basis, wt, accelerator_tree,
 
1537
                                     hardlink=hardlink,
 
1538
                                     delta_from_tree=delta_from_tree)
 
1539
            finally:
 
1540
                basis.unlock()
1311
1541
        finally:
1312
1542
            control_files.unlock()
1313
1543
            wt.unlock()
1314
1544
        return wt
1315
1545
 
 
1546
    def _init_custom_control_files(self, wt):
 
1547
        """Subclasses with custom control files should override this method.
 
1548
 
 
1549
        The working tree and control files are locked for writing when this
 
1550
        method is called.
 
1551
 
 
1552
        :param wt: the WorkingTree object
 
1553
        """
 
1554
 
 
1555
    def open(self, a_bzrdir, _found=False):
 
1556
        """Return the WorkingTree object for a_bzrdir
 
1557
 
 
1558
        _found is a private parameter, do not use it. It is used to indicate
 
1559
               if format probing has already been done.
 
1560
        """
 
1561
        if not _found:
 
1562
            # we are being called directly and must probe.
 
1563
            raise NotImplementedError
 
1564
        if not isinstance(a_bzrdir.transport, LocalTransport):
 
1565
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
 
1566
        wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
 
1567
        return wt
 
1568
 
1316
1569
    def _open(self, a_bzrdir, control_files):
1317
1570
        """Open the tree itself.
1318
1571
 
1319
1572
        :param a_bzrdir: the dir for the tree.
1320
1573
        :param control_files: the control files for the tree.
1321
1574
        """
1322
 
        return WorkingTree4(a_bzrdir.root_transport.local_abspath('.'),
 
1575
        return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
1323
1576
                           branch=a_bzrdir.open_branch(),
1324
1577
                           _format=self,
1325
1578
                           _bzrdir=a_bzrdir,
1326
1579
                           _control_files=control_files)
1327
1580
 
1328
1581
    def __get_matchingbzrdir(self):
 
1582
        return self._get_matchingbzrdir()
 
1583
 
 
1584
    def _get_matchingbzrdir(self):
 
1585
        """Overrideable method to get a bzrdir for testing."""
1329
1586
        # please test against something that will let us do tree references
1330
1587
        return bzrdir.format_registry.make_bzrdir(
1331
1588
            'dirstate-with-subtree')
1333
1590
    _matchingbzrdir = property(__get_matchingbzrdir)
1334
1591
 
1335
1592
 
1336
 
class DirStateRevisionTree(Tree):
1337
 
    """A revision tree pulling the inventory from a dirstate."""
 
1593
class WorkingTreeFormat4(DirStateWorkingTreeFormat):
 
1594
    """The first consolidated dirstate working tree format.
 
1595
 
 
1596
    This format:
 
1597
        - exists within a metadir controlling .bzr
 
1598
        - includes an explicit version marker for the workingtree control
 
1599
          files, separate from the BzrDir format
 
1600
        - modifies the hash cache format
 
1601
        - is new in bzr 0.15
 
1602
        - uses a LockDir to guard access to it.
 
1603
    """
 
1604
 
 
1605
    upgrade_recommended = False
 
1606
 
 
1607
    _tree_class = WorkingTree4
 
1608
 
 
1609
    def get_format_string(self):
 
1610
        """See WorkingTreeFormat.get_format_string()."""
 
1611
        return "Bazaar Working Tree Format 4 (bzr 0.15)\n"
 
1612
 
 
1613
    def get_format_description(self):
 
1614
        """See WorkingTreeFormat.get_format_description()."""
 
1615
        return "Working tree format 4"
 
1616
 
 
1617
 
 
1618
class WorkingTreeFormat5(DirStateWorkingTreeFormat):
 
1619
    """WorkingTree format supporting content filtering.
 
1620
    """
 
1621
 
 
1622
    upgrade_recommended = False
 
1623
 
 
1624
    _tree_class = WorkingTree5
 
1625
 
 
1626
    def get_format_string(self):
 
1627
        """See WorkingTreeFormat.get_format_string()."""
 
1628
        return "Bazaar Working Tree Format 5 (bzr 1.11)\n"
 
1629
 
 
1630
    def get_format_description(self):
 
1631
        """See WorkingTreeFormat.get_format_description()."""
 
1632
        return "Working tree format 5"
 
1633
 
 
1634
    def supports_content_filtering(self):
 
1635
        return True
 
1636
 
 
1637
 
 
1638
class WorkingTreeFormat6(DirStateWorkingTreeFormat):
 
1639
    """WorkingTree format supporting views.
 
1640
    """
 
1641
 
 
1642
    upgrade_recommended = False
 
1643
 
 
1644
    _tree_class = WorkingTree6
 
1645
 
 
1646
    def get_format_string(self):
 
1647
        """See WorkingTreeFormat.get_format_string()."""
 
1648
        return "Bazaar Working Tree Format 6 (bzr 1.14)\n"
 
1649
 
 
1650
    def get_format_description(self):
 
1651
        """See WorkingTreeFormat.get_format_description()."""
 
1652
        return "Working tree format 6"
 
1653
 
 
1654
    def _init_custom_control_files(self, wt):
 
1655
        """Subclasses with custom control files should override this method."""
 
1656
        wt._transport.put_bytes('views', '', mode=wt.bzrdir._get_file_mode())
 
1657
 
 
1658
    def supports_content_filtering(self):
 
1659
        return True
 
1660
 
 
1661
    def supports_views(self):
 
1662
        return True
 
1663
 
 
1664
 
 
1665
class DirStateRevisionTree(InventoryTree):
 
1666
    """A revision tree pulling the inventory from a dirstate.
 
1667
    
 
1668
    Note that this is one of the historical (ie revision) trees cached in the
 
1669
    dirstate for easy access, not the workingtree.
 
1670
    """
1338
1671
 
1339
1672
    def __init__(self, dirstate, revision_id, repository):
1340
1673
        self._dirstate = dirstate
1343
1676
        self._inventory = None
1344
1677
        self._locked = 0
1345
1678
        self._dirstate_locked = False
 
1679
        self._repo_supports_tree_reference = getattr(
 
1680
            repository._format, "supports_tree_reference",
 
1681
            False)
1346
1682
 
1347
1683
    def __repr__(self):
1348
1684
        return "<%s of %s in %s>" % \
1351
1687
    def annotate_iter(self, file_id,
1352
1688
                      default_revision=_mod_revision.CURRENT_REVISION):
1353
1689
        """See Tree.annotate_iter"""
1354
 
        w = self._get_weave(file_id)
1355
 
        return w.annotate_iter(self.inventory[file_id].revision)
 
1690
        text_key = (file_id, self.get_file_revision(file_id))
 
1691
        annotations = self._repository.texts.annotate(text_key)
 
1692
        return [(key[-1], line) for (key, line) in annotations]
1356
1693
 
1357
1694
    def _get_ancestors(self, default_revision):
1358
1695
        return set(self._repository.get_ancestry(self._revision_id,
1379
1716
    def get_root_id(self):
1380
1717
        return self.path2id('')
1381
1718
 
 
1719
    def id2path(self, file_id):
 
1720
        "Convert a file-id to a path."
 
1721
        entry = self._get_entry(file_id=file_id)
 
1722
        if entry == (None, None):
 
1723
            raise errors.NoSuchId(tree=self, file_id=file_id)
 
1724
        path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
 
1725
        return path_utf8.decode('utf8')
 
1726
 
 
1727
    def iter_references(self):
 
1728
        if not self._repo_supports_tree_reference:
 
1729
            # When the repo doesn't support references, we will have nothing to
 
1730
            # return
 
1731
            return iter([])
 
1732
        # Otherwise, fall back to the default implementation
 
1733
        return super(DirStateRevisionTree, self).iter_references()
 
1734
 
1382
1735
    def _get_parent_index(self):
1383
1736
        """Return the index in the dirstate referenced by this tree."""
1384
1737
        return self._dirstate.get_parent_ids().index(self._revision_id) + 1
1389
1742
        If either file_id or path is supplied, it is used as the key to lookup.
1390
1743
        If both are supplied, the fastest lookup is used, and an error is
1391
1744
        raised if they do not both point at the same row.
1392
 
        
 
1745
 
1393
1746
        :param file_id: An optional unicode file_id to be looked up.
1394
1747
        :param path: An optional unicode path to be looked up.
1395
1748
        :return: The dirstate row tuple for path/file_id, or (None, None)
1409
1762
 
1410
1763
        This is relatively expensive: we have to walk the entire dirstate.
1411
1764
        """
1412
 
        assert self._locked, 'cannot generate inventory of an unlocked '\
1413
 
            'dirstate revision tree'
 
1765
        if not self._locked:
 
1766
            raise AssertionError(
 
1767
                'cannot generate inventory of an unlocked '
 
1768
                'dirstate revision tree')
1414
1769
        # separate call for profiling - makes it clear where the costs are.
1415
1770
        self._dirstate._read_dirblocks_if_needed()
1416
 
        assert self._revision_id in self._dirstate.get_parent_ids(), \
1417
 
            'parent %s has disappeared from %s' % (
1418
 
            self._revision_id, self._dirstate.get_parent_ids())
 
1771
        if self._revision_id not in self._dirstate.get_parent_ids():
 
1772
            raise AssertionError(
 
1773
                'parent %s has disappeared from %s' % (
 
1774
                self._revision_id, self._dirstate.get_parent_ids()))
1419
1775
        parent_index = self._dirstate.get_parent_ids().index(self._revision_id) + 1
1420
1776
        # This is identical now to the WorkingTree _generate_inventory except
1421
1777
        # for the tree index use.
1422
1778
        root_key, current_entry = self._dirstate._get_entry(parent_index, path_utf8='')
1423
1779
        current_id = root_key[2]
1424
 
        assert current_entry[parent_index][0] == 'd'
 
1780
        if current_entry[parent_index][0] != 'd':
 
1781
            raise AssertionError()
1425
1782
        inv = Inventory(root_id=current_id, revision_id=self._revision_id)
1426
1783
        inv.root.revision = current_entry[parent_index][4]
1427
1784
        # Turn some things into local variables
1458
1815
                elif kind == 'directory':
1459
1816
                    parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
1460
1817
                elif kind == 'symlink':
1461
 
                    inv_entry.executable = False
1462
 
                    inv_entry.text_size = None
1463
1818
                    inv_entry.symlink_target = utf8_decode(fingerprint)[0]
1464
1819
                elif kind == 'tree-reference':
1465
1820
                    inv_entry.reference_revision = fingerprint or None
1467
1822
                    raise AssertionError("cannot convert entry %r into an InventoryEntry"
1468
1823
                            % entry)
1469
1824
                # These checks cost us around 40ms on a 55k entry tree
1470
 
                assert file_id not in inv_byid
1471
 
                assert name_unicode not in parent_ie.children
 
1825
                if file_id in inv_byid:
 
1826
                    raise AssertionError('file_id %s already in'
 
1827
                        ' inventory as %s' % (file_id, inv_byid[file_id]))
 
1828
                if name_unicode in parent_ie.children:
 
1829
                    raise AssertionError('name %r already in parent'
 
1830
                        % (name_unicode,))
1472
1831
                inv_byid[file_id] = inv_entry
1473
1832
                parent_ie.children[name_unicode] = inv_entry
1474
1833
        self._inventory = inv
1484
1843
            return None
1485
1844
        parent_index = self._get_parent_index()
1486
1845
        last_changed_revision = entry[1][parent_index][4]
1487
 
        return self._repository.get_revision(last_changed_revision).timestamp
 
1846
        try:
 
1847
            rev = self._repository.get_revision(last_changed_revision)
 
1848
        except errors.NoSuchRevision:
 
1849
            raise errors.FileTimestampUnavailable(self.id2path(file_id))
 
1850
        return rev.timestamp
1488
1851
 
1489
1852
    def get_file_sha1(self, file_id, path=None, stat_value=None):
1490
1853
        entry = self._get_entry(file_id=file_id, path=path)
1494
1857
            return parent_details[1]
1495
1858
        return None
1496
1859
 
1497
 
    @symbol_versioning.deprecated_method(symbol_versioning.zero_ninety)
1498
 
    def get_weave(self, file_id):
1499
 
        return self._get_weave(file_id)
1500
 
 
1501
 
    def _get_weave(self, file_id):
1502
 
        return self._repository.weave_store.get_weave(file_id,
1503
 
                self._repository.get_transaction())
 
1860
    @needs_read_lock
 
1861
    def get_file_revision(self, file_id):
 
1862
        return self.inventory[file_id].revision
1504
1863
 
1505
1864
    def get_file(self, file_id, path=None):
1506
1865
        return StringIO(self.get_file_text(file_id))
1507
1866
 
1508
 
    def get_file_lines(self, file_id):
1509
 
        ie = self.inventory[file_id]
1510
 
        return self._get_weave(file_id).get_lines(ie.revision)
1511
 
 
1512
1867
    def get_file_size(self, file_id):
 
1868
        """See Tree.get_file_size"""
1513
1869
        return self.inventory[file_id].text_size
1514
1870
 
1515
 
    def get_file_text(self, file_id):
1516
 
        return ''.join(self.get_file_lines(file_id))
 
1871
    def get_file_text(self, file_id, path=None):
 
1872
        _, content = list(self.iter_files_bytes([(file_id, None)]))[0]
 
1873
        return ''.join(content)
1517
1874
 
1518
1875
    def get_reference_revision(self, file_id, path=None):
1519
1876
        return self.inventory[file_id].reference_revision
1538
1895
        if entry[1][parent_index][0] != 'l':
1539
1896
            return None
1540
1897
        else:
1541
 
            # At present, none of the tree implementations supports non-ascii
1542
 
            # symlink targets. So we will just assume that the dirstate path is
1543
 
            # correct.
1544
 
            return entry[1][parent_index][1]
 
1898
            target = entry[1][parent_index][1]
 
1899
            target = target.decode('utf8')
 
1900
            return target
1545
1901
 
1546
1902
    def get_revision_id(self):
1547
1903
        """Return the revision id for this tree."""
1565
1921
        return bool(self.path2id(filename))
1566
1922
 
1567
1923
    def kind(self, file_id):
1568
 
        return self.inventory[file_id].kind
 
1924
        entry = self._get_entry(file_id=file_id)[1]
 
1925
        if entry is None:
 
1926
            raise errors.NoSuchId(tree=self, file_id=file_id)
 
1927
        parent_index = self._get_parent_index()
 
1928
        return dirstate.DirState._minikind_to_kind[entry[parent_index][0]]
 
1929
 
 
1930
    def stored_kind(self, file_id):
 
1931
        """See Tree.stored_kind"""
 
1932
        return self.kind(file_id)
1569
1933
 
1570
1934
    def path_content_summary(self, path):
1571
1935
        """See Tree.path_content_summary."""
1584
1948
    def is_executable(self, file_id, path=None):
1585
1949
        ie = self.inventory[file_id]
1586
1950
        if ie.kind != "file":
1587
 
            return None
 
1951
            return False
1588
1952
        return ie.executable
1589
1953
 
1590
 
    def list_files(self, include_root=False):
 
1954
    def is_locked(self):
 
1955
        return self._locked
 
1956
 
 
1957
    def list_files(self, include_root=False, from_dir=None, recursive=True):
1591
1958
        # We use a standard implementation, because DirStateRevisionTree is
1592
1959
        # dealing with one of the parents of the current state
1593
1960
        inv = self._get_inventory()
1594
 
        entries = inv.iter_entries()
1595
 
        if self.inventory.root is not None and not include_root:
 
1961
        if from_dir is None:
 
1962
            from_dir_id = None
 
1963
        else:
 
1964
            from_dir_id = inv.path2id(from_dir)
 
1965
            if from_dir_id is None:
 
1966
                # Directory not versioned
 
1967
                return
 
1968
        entries = inv.iter_entries(from_dir=from_dir_id, recursive=recursive)
 
1969
        if inv.root is not None and not include_root and from_dir is None:
1596
1970
            entries.next()
1597
1971
        for path, entry in entries:
1598
1972
            yield path, 'V', entry.kind, entry.file_id, entry
1599
1973
 
1600
1974
    def lock_read(self):
1601
 
        """Lock the tree for a set of operations."""
 
1975
        """Lock the tree for a set of operations.
 
1976
 
 
1977
        :return: A bzrlib.lock.LogicalLockResult.
 
1978
        """
1602
1979
        if not self._locked:
1603
1980
            self._repository.lock_read()
1604
1981
            if self._dirstate._lock_token is None:
1605
1982
                self._dirstate.lock_read()
1606
1983
                self._dirstate_locked = True
1607
1984
        self._locked += 1
 
1985
        return LogicalLockResult(self.unlock)
1608
1986
 
1609
1987
    def _must_be_locked(self):
1610
1988
        if not self._locked:
1631
2009
                self._dirstate_locked = False
1632
2010
            self._repository.unlock()
1633
2011
 
 
2012
    @needs_read_lock
 
2013
    def supports_tree_reference(self):
 
2014
        return self._repo_supports_tree_reference
 
2015
 
1634
2016
    def walkdirs(self, prefix=""):
1635
2017
        # TODO: jam 20070215 This is the lazy way by using the RevisionTree
1636
 
        # implementation based on an inventory.  
 
2018
        # implementation based on an inventory.
1637
2019
        # This should be cleaned up to use the much faster Dirstate code
1638
2020
        # So for now, we just build up the parent inventory, and extract
1639
2021
        # it the same way RevisionTree does.
1668
2050
 
1669
2051
class InterDirStateTree(InterTree):
1670
2052
    """Fast path optimiser for changes_from with dirstate trees.
1671
 
    
1672
 
    This is used only when both trees are in the dirstate working file, and 
1673
 
    the source is any parent within the dirstate, and the destination is 
 
2053
 
 
2054
    This is used only when both trees are in the dirstate working file, and
 
2055
    the source is any parent within the dirstate, and the destination is
1674
2056
    the current working tree of the same dirstate.
1675
2057
    """
1676
2058
    # this could be generalized to allow comparisons between any trees in the
1685
2067
    def make_source_parent_tree(source, target):
1686
2068
        """Change the source tree into a parent of the target."""
1687
2069
        revid = source.commit('record tree')
1688
 
        target.branch.repository.fetch(source.branch.repository, revid)
 
2070
        target.branch.fetch(source.branch, revid)
1689
2071
        target.set_parent_ids([revid])
1690
2072
        return target.basis_tree(), target
1691
2073
 
 
2074
    @classmethod
 
2075
    def make_source_parent_tree_python_dirstate(klass, test_case, source, target):
 
2076
        result = klass.make_source_parent_tree(source, target)
 
2077
        result[1]._iter_changes = dirstate.ProcessEntryPython
 
2078
        return result
 
2079
 
 
2080
    @classmethod
 
2081
    def make_source_parent_tree_compiled_dirstate(klass, test_case, source,
 
2082
                                                  target):
 
2083
        from bzrlib.tests.test__dirstate_helpers import \
 
2084
            compiled_dirstate_helpers_feature
 
2085
        test_case.requireFeature(compiled_dirstate_helpers_feature)
 
2086
        from bzrlib._dirstate_helpers_pyx import ProcessEntryC
 
2087
        result = klass.make_source_parent_tree(source, target)
 
2088
        result[1]._iter_changes = ProcessEntryC
 
2089
        return result
 
2090
 
1692
2091
    _matching_from_tree_format = WorkingTreeFormat4()
1693
2092
    _matching_to_tree_format = WorkingTreeFormat4()
1694
 
    _test_mutable_trees_to_test_trees = make_source_parent_tree
1695
 
 
1696
 
    def _iter_changes(self, include_unchanged=False,
 
2093
 
 
2094
    @classmethod
 
2095
    def _test_mutable_trees_to_test_trees(klass, test_case, source, target):
 
2096
        # This method shouldn't be called, because we have python and C
 
2097
        # specific flavours.
 
2098
        raise NotImplementedError
 
2099
 
 
2100
    def iter_changes(self, include_unchanged=False,
1697
2101
                      specific_files=None, pb=None, extra_trees=[],
1698
2102
                      require_versioned=True, want_unversioned=False):
1699
2103
        """Return the changes from source to target.
1700
2104
 
1701
 
        :return: An iterator that yields tuples. See InterTree._iter_changes
 
2105
        :return: An iterator that yields tuples. See InterTree.iter_changes
1702
2106
            for details.
1703
2107
        :param specific_files: An optional list of file paths to restrict the
1704
2108
            comparison to. When mapping filenames to ids, all matches in all
1715
2119
            output. An unversioned file is defined as one with (False, False)
1716
2120
            for the versioned pair.
1717
2121
        """
1718
 
        utf8_decode = cache_utf8._utf8_decode
1719
 
        _minikind_to_kind = dirstate.DirState._minikind_to_kind
1720
 
        cmp_by_dirs = dirstate.cmp_by_dirs
1721
 
        # NB: show_status depends on being able to pass in non-versioned files
1722
 
        # and report them as unknown
1723
2122
        # TODO: handle extra trees in the dirstate.
1724
 
        # TODO: handle comparisons as an empty tree as a different special
1725
 
        # case? mbp 20070226
1726
 
        if (extra_trees or (self.source._revision_id == NULL_REVISION)
1727
 
            or specific_files == []):
 
2123
        if (extra_trees or specific_files == []):
1728
2124
            # we can't fast-path these cases (yet)
1729
 
            for f in super(InterDirStateTree, self)._iter_changes(
 
2125
            return super(InterDirStateTree, self).iter_changes(
1730
2126
                include_unchanged, specific_files, pb, extra_trees,
1731
 
                require_versioned, want_unversioned=want_unversioned):
1732
 
                yield f
1733
 
            return
 
2127
                require_versioned, want_unversioned=want_unversioned)
1734
2128
        parent_ids = self.target.get_parent_ids()
1735
 
        assert (self.source._revision_id in parent_ids), \
1736
 
                "revision {%s} is not stored in {%s}, but %s " \
1737
 
                "can only be used for trees stored in the dirstate" \
1738
 
                % (self.source._revision_id, self.target, self._iter_changes)
 
2129
        if not (self.source._revision_id in parent_ids
 
2130
                or self.source._revision_id == _mod_revision.NULL_REVISION):
 
2131
            raise AssertionError(
 
2132
                "revision {%s} is not stored in {%s}, but %s "
 
2133
                "can only be used for trees stored in the dirstate"
 
2134
                % (self.source._revision_id, self.target, self.iter_changes))
1739
2135
        target_index = 0
1740
 
        if self.source._revision_id == NULL_REVISION:
 
2136
        if self.source._revision_id == _mod_revision.NULL_REVISION:
1741
2137
            source_index = None
1742
2138
            indices = (target_index,)
1743
2139
        else:
1744
 
            assert (self.source._revision_id in parent_ids), \
1745
 
                "Failure: source._revision_id: %s not in target.parent_ids(%s)" % (
1746
 
                self.source._revision_id, parent_ids)
 
2140
            if not (self.source._revision_id in parent_ids):
 
2141
                raise AssertionError(
 
2142
                    "Failure: source._revision_id: %s not in target.parent_ids(%s)" % (
 
2143
                    self.source._revision_id, parent_ids))
1747
2144
            source_index = 1 + parent_ids.index(self.source._revision_id)
1748
 
            indices = (source_index,target_index)
 
2145
            indices = (source_index, target_index)
1749
2146
        # -- make all specific_files utf8 --
1750
2147
        if specific_files:
1751
2148
            specific_files_utf8 = set()
1752
2149
            for path in specific_files:
 
2150
                # Note, if there are many specific files, using cache_utf8
 
2151
                # would be good here.
1753
2152
                specific_files_utf8.add(path.encode('utf8'))
1754
2153
            specific_files = specific_files_utf8
1755
2154
        else:
1756
2155
            specific_files = set([''])
1757
2156
        # -- specific_files is now a utf8 path set --
 
2157
 
1758
2158
        # -- get the state object and prepare it.
1759
2159
        state = self.target.current_dirstate()
1760
2160
        state._read_dirblocks_if_needed()
1761
 
        def _entries_for_path(path):
1762
 
            """Return a list with all the entries that match path for all ids.
1763
 
            """
1764
 
            dirname, basename = os.path.split(path)
1765
 
            key = (dirname, basename, '')
1766
 
            block_index, present = state._find_block_index_from_key(key)
1767
 
            if not present:
1768
 
                # the block which should contain path is absent.
1769
 
                return []
1770
 
            result = []
1771
 
            block = state._dirblocks[block_index][1]
1772
 
            entry_index, _ = state._find_entry_index(key, block)
1773
 
            # we may need to look at multiple entries at this path: walk while the specific_files match.
1774
 
            while (entry_index < len(block) and
1775
 
                block[entry_index][0][0:2] == key[0:2]):
1776
 
                result.append(block[entry_index])
1777
 
                entry_index += 1
1778
 
            return result
1779
2161
        if require_versioned:
1780
2162
            # -- check all supplied paths are versioned in a search tree. --
1781
 
            all_versioned = True
 
2163
            not_versioned = []
1782
2164
            for path in specific_files:
1783
 
                path_entries = _entries_for_path(path)
 
2165
                path_entries = state._entries_for_path(path)
1784
2166
                if not path_entries:
1785
2167
                    # this specified path is not present at all: error
1786
 
                    all_versioned = False
1787
 
                    break
 
2168
                    not_versioned.append(path)
 
2169
                    continue
1788
2170
                found_versioned = False
1789
2171
                # for each id at this path
1790
2172
                for entry in path_entries:
1797
2179
                if not found_versioned:
1798
2180
                    # none of the indexes was not 'absent' at all ids for this
1799
2181
                    # path.
1800
 
                    all_versioned = False
1801
 
                    break
1802
 
            if not all_versioned:
1803
 
                raise errors.PathsNotVersionedError(specific_files)
 
2182
                    not_versioned.append(path)
 
2183
            if len(not_versioned) > 0:
 
2184
                raise errors.PathsNotVersionedError(not_versioned)
1804
2185
        # -- remove redundancy in supplied specific_files to prevent over-scanning --
1805
 
        search_specific_files = set()
1806
 
        for path in specific_files:
1807
 
            other_specific_files = specific_files.difference(set([path]))
1808
 
            if not osutils.is_inside_any(other_specific_files, path):
1809
 
                # this is a top level path, we must check it.
1810
 
                search_specific_files.add(path)
1811
 
        # sketch: 
1812
 
        # compare source_index and target_index at or under each element of search_specific_files.
1813
 
        # follow the following comparison table. Note that we only want to do diff operations when
1814
 
        # the target is fdl because thats when the walkdirs logic will have exposed the pathinfo 
1815
 
        # for the target.
1816
 
        # cases:
1817
 
        # 
1818
 
        # Source | Target | disk | action
1819
 
        #   r    | fdlt   |      | add source to search, add id path move and perform
1820
 
        #        |        |      | diff check on source-target
1821
 
        #   r    | fdlt   |  a   | dangling file that was present in the basis. 
1822
 
        #        |        |      | ???
1823
 
        #   r    |  a     |      | add source to search
1824
 
        #   r    |  a     |  a   | 
1825
 
        #   r    |  r     |      | this path is present in a non-examined tree, skip.
1826
 
        #   r    |  r     |  a   | this path is present in a non-examined tree, skip.
1827
 
        #   a    | fdlt   |      | add new id
1828
 
        #   a    | fdlt   |  a   | dangling locally added file, skip
1829
 
        #   a    |  a     |      | not present in either tree, skip
1830
 
        #   a    |  a     |  a   | not present in any tree, skip
1831
 
        #   a    |  r     |      | not present in either tree at this path, skip as it
1832
 
        #        |        |      | may not be selected by the users list of paths.
1833
 
        #   a    |  r     |  a   | not present in either tree at this path, skip as it
1834
 
        #        |        |      | may not be selected by the users list of paths.
1835
 
        #  fdlt  | fdlt   |      | content in both: diff them
1836
 
        #  fdlt  | fdlt   |  a   | deleted locally, but not unversioned - show as deleted ?
1837
 
        #  fdlt  |  a     |      | unversioned: output deleted id for now
1838
 
        #  fdlt  |  a     |  a   | unversioned and deleted: output deleted id
1839
 
        #  fdlt  |  r     |      | relocated in this tree, so add target to search.
1840
 
        #        |        |      | Dont diff, we will see an r,fd; pair when we reach
1841
 
        #        |        |      | this id at the other path.
1842
 
        #  fdlt  |  r     |  a   | relocated in this tree, so add target to search.
1843
 
        #        |        |      | Dont diff, we will see an r,fd; pair when we reach
1844
 
        #        |        |      | this id at the other path.
1845
 
 
1846
 
        # for all search_indexs in each path at or under each element of
1847
 
        # search_specific_files, if the detail is relocated: add the id, and add the
1848
 
        # relocated path as one to search if its not searched already. If the
1849
 
        # detail is not relocated, add the id.
1850
 
        searched_specific_files = set()
1851
 
        NULL_PARENT_DETAILS = dirstate.DirState.NULL_PARENT_DETAILS
1852
 
        # Using a list so that we can access the values and change them in
1853
 
        # nested scope. Each one is [path, file_id, entry]
1854
 
        last_source_parent = [None, None]
1855
 
        last_target_parent = [None, None]
 
2186
        search_specific_files = osutils.minimum_path_selection(specific_files)
1856
2187
 
1857
2188
        use_filesystem_for_exec = (sys.platform != 'win32')
1858
 
 
1859
 
        # Just a sentry, so that _process_entry can say that this
1860
 
        # record is handled, but isn't interesting to process (unchanged)
1861
 
        uninteresting = object()
1862
 
 
1863
 
 
1864
 
        old_dirname_to_file_id = {}
1865
 
        new_dirname_to_file_id = {}
1866
 
        # TODO: jam 20070516 - Avoid the _get_entry lookup overhead by
1867
 
        #       keeping a cache of directories that we have seen.
1868
 
 
1869
 
        def _process_entry(entry, path_info):
1870
 
            """Compare an entry and real disk to generate delta information.
1871
 
 
1872
 
            :param path_info: top_relpath, basename, kind, lstat, abspath for
1873
 
                the path of entry. If None, then the path is considered absent.
1874
 
                (Perhaps we should pass in a concrete entry for this ?)
1875
 
                Basename is returned as a utf8 string because we expect this
1876
 
                tuple will be ignored, and don't want to take the time to
1877
 
                decode.
1878
 
            :return: None if these don't match
1879
 
                     A tuple of information about the change, or
1880
 
                     the object 'uninteresting' if these match, but are
1881
 
                     basically identical.
1882
 
            """
1883
 
            if source_index is None:
1884
 
                source_details = NULL_PARENT_DETAILS
1885
 
            else:
1886
 
                source_details = entry[1][source_index]
1887
 
            target_details = entry[1][target_index]
1888
 
            target_minikind = target_details[0]
1889
 
            if path_info is not None and target_minikind in 'fdlt':
1890
 
                assert target_index == 0
1891
 
                link_or_sha1 = state.update_entry(entry, abspath=path_info[4],
1892
 
                                                  stat_value=path_info[3])
1893
 
                # The entry may have been modified by update_entry
1894
 
                target_details = entry[1][target_index]
1895
 
                target_minikind = target_details[0]
1896
 
            else:
1897
 
                link_or_sha1 = None
1898
 
            file_id = entry[0][2]
1899
 
            source_minikind = source_details[0]
1900
 
            if source_minikind in 'fdltr' and target_minikind in 'fdlt':
1901
 
                # claimed content in both: diff
1902
 
                #   r    | fdlt   |      | add source to search, add id path move and perform
1903
 
                #        |        |      | diff check on source-target
1904
 
                #   r    | fdlt   |  a   | dangling file that was present in the basis.
1905
 
                #        |        |      | ???
1906
 
                if source_minikind in 'r':
1907
 
                    # add the source to the search path to find any children it
1908
 
                    # has.  TODO ? : only add if it is a container ?
1909
 
                    if not osutils.is_inside_any(searched_specific_files,
1910
 
                                                 source_details[1]):
1911
 
                        search_specific_files.add(source_details[1])
1912
 
                    # generate the old path; this is needed for stating later
1913
 
                    # as well.
1914
 
                    old_path = source_details[1]
1915
 
                    old_dirname, old_basename = os.path.split(old_path)
1916
 
                    path = pathjoin(entry[0][0], entry[0][1])
1917
 
                    old_entry = state._get_entry(source_index,
1918
 
                                                 path_utf8=old_path)
1919
 
                    # update the source details variable to be the real
1920
 
                    # location.
1921
 
                    source_details = old_entry[1][source_index]
1922
 
                    source_minikind = source_details[0]
1923
 
                else:
1924
 
                    old_dirname = entry[0][0]
1925
 
                    old_basename = entry[0][1]
1926
 
                    old_path = path = None
1927
 
                if path_info is None:
1928
 
                    # the file is missing on disk, show as removed.
1929
 
                    content_change = True
1930
 
                    target_kind = None
1931
 
                    target_exec = False
1932
 
                else:
1933
 
                    # source and target are both versioned and disk file is present.
1934
 
                    target_kind = path_info[2]
1935
 
                    if target_kind == 'directory':
1936
 
                        if path is None:
1937
 
                            old_path = path = pathjoin(old_dirname, old_basename)
1938
 
                        new_dirname_to_file_id[path] = file_id
1939
 
                        if source_minikind != 'd':
1940
 
                            content_change = True
1941
 
                        else:
1942
 
                            # directories have no fingerprint
1943
 
                            content_change = False
1944
 
                        target_exec = False
1945
 
                    elif target_kind == 'file':
1946
 
                        if source_minikind != 'f':
1947
 
                            content_change = True
1948
 
                        else:
1949
 
                            # We could check the size, but we already have the
1950
 
                            # sha1 hash.
1951
 
                            content_change = (link_or_sha1 != source_details[1])
1952
 
                        # Target details is updated at update_entry time
1953
 
                        if use_filesystem_for_exec:
1954
 
                            # We don't need S_ISREG here, because we are sure
1955
 
                            # we are dealing with a file.
1956
 
                            target_exec = bool(stat.S_IEXEC & path_info[3].st_mode)
1957
 
                        else:
1958
 
                            target_exec = target_details[3]
1959
 
                    elif target_kind == 'symlink':
1960
 
                        if source_minikind != 'l':
1961
 
                            content_change = True
1962
 
                        else:
1963
 
                            content_change = (link_or_sha1 != source_details[1])
1964
 
                        target_exec = False
1965
 
                    elif target_kind == 'tree-reference':
1966
 
                        if source_minikind != 't':
1967
 
                            content_change = True
1968
 
                        else:
1969
 
                            content_change = False
1970
 
                        target_exec = False
1971
 
                    else:
1972
 
                        raise Exception, "unknown kind %s" % path_info[2]
1973
 
                if source_minikind == 'd':
1974
 
                    if path is None:
1975
 
                        old_path = path = pathjoin(old_dirname, old_basename)
1976
 
                    old_dirname_to_file_id[old_path] = file_id
1977
 
                # parent id is the entry for the path in the target tree
1978
 
                if old_dirname == last_source_parent[0]:
1979
 
                    source_parent_id = last_source_parent[1]
1980
 
                else:
1981
 
                    try:
1982
 
                        source_parent_id = old_dirname_to_file_id[old_dirname]
1983
 
                    except KeyError:
1984
 
                        source_parent_entry = state._get_entry(source_index,
1985
 
                                                               path_utf8=old_dirname)
1986
 
                        source_parent_id = source_parent_entry[0][2]
1987
 
                    if source_parent_id == entry[0][2]:
1988
 
                        # This is the root, so the parent is None
1989
 
                        source_parent_id = None
1990
 
                    else:
1991
 
                        last_source_parent[0] = old_dirname
1992
 
                        last_source_parent[1] = source_parent_id
1993
 
                new_dirname = entry[0][0]
1994
 
                if new_dirname == last_target_parent[0]:
1995
 
                    target_parent_id = last_target_parent[1]
1996
 
                else:
1997
 
                    try:
1998
 
                        target_parent_id = new_dirname_to_file_id[new_dirname]
1999
 
                    except KeyError:
2000
 
                        # TODO: We don't always need to do the lookup, because the
2001
 
                        #       parent entry will be the same as the source entry.
2002
 
                        target_parent_entry = state._get_entry(target_index,
2003
 
                                                               path_utf8=new_dirname)
2004
 
                        assert target_parent_entry != (None, None), (
2005
 
                            "Could not find target parent in wt: %s\nparent of: %s"
2006
 
                            % (new_dirname, entry))
2007
 
                        target_parent_id = target_parent_entry[0][2]
2008
 
                    if target_parent_id == entry[0][2]:
2009
 
                        # This is the root, so the parent is None
2010
 
                        target_parent_id = None
2011
 
                    else:
2012
 
                        last_target_parent[0] = new_dirname
2013
 
                        last_target_parent[1] = target_parent_id
2014
 
 
2015
 
                source_exec = source_details[3]
2016
 
                if (include_unchanged
2017
 
                    or content_change
2018
 
                    or source_parent_id != target_parent_id
2019
 
                    or old_basename != entry[0][1]
2020
 
                    or source_exec != target_exec
2021
 
                    ):
2022
 
                    if old_path is None:
2023
 
                        old_path = path = pathjoin(old_dirname, old_basename)
2024
 
                        old_path_u = utf8_decode(old_path)[0]
2025
 
                        path_u = old_path_u
2026
 
                    else:
2027
 
                        old_path_u = utf8_decode(old_path)[0]
2028
 
                        if old_path == path:
2029
 
                            path_u = old_path_u
2030
 
                        else:
2031
 
                            path_u = utf8_decode(path)[0]
2032
 
                    source_kind = _minikind_to_kind[source_minikind]
2033
 
                    return (entry[0][2],
2034
 
                           (old_path_u, path_u),
2035
 
                           content_change,
2036
 
                           (True, True),
2037
 
                           (source_parent_id, target_parent_id),
2038
 
                           (utf8_decode(old_basename)[0], utf8_decode(entry[0][1])[0]),
2039
 
                           (source_kind, target_kind),
2040
 
                           (source_exec, target_exec))
2041
 
                else:
2042
 
                    return uninteresting
2043
 
            elif source_minikind in 'a' and target_minikind in 'fdlt':
2044
 
                # looks like a new file
2045
 
                if path_info is not None:
2046
 
                    path = pathjoin(entry[0][0], entry[0][1])
2047
 
                    # parent id is the entry for the path in the target tree
2048
 
                    # TODO: these are the same for an entire directory: cache em.
2049
 
                    parent_id = state._get_entry(target_index,
2050
 
                                                 path_utf8=entry[0][0])[0][2]
2051
 
                    if parent_id == entry[0][2]:
2052
 
                        parent_id = None
2053
 
                    if use_filesystem_for_exec:
2054
 
                        # We need S_ISREG here, because we aren't sure if this
2055
 
                        # is a file or not.
2056
 
                        target_exec = bool(
2057
 
                            stat.S_ISREG(path_info[3].st_mode)
2058
 
                            and stat.S_IEXEC & path_info[3].st_mode)
2059
 
                    else:
2060
 
                        target_exec = target_details[3]
2061
 
                    return (entry[0][2],
2062
 
                           (None, utf8_decode(path)[0]),
2063
 
                           True,
2064
 
                           (False, True),
2065
 
                           (None, parent_id),
2066
 
                           (None, utf8_decode(entry[0][1])[0]),
2067
 
                           (None, path_info[2]),
2068
 
                           (None, target_exec))
2069
 
                else:
2070
 
                    # but its not on disk: we deliberately treat this as just
2071
 
                    # never-present. (Why ?! - RBC 20070224)
2072
 
                    pass
2073
 
            elif source_minikind in 'fdlt' and target_minikind in 'a':
2074
 
                # unversioned, possibly, or possibly not deleted: we dont care.
2075
 
                # if its still on disk, *and* theres no other entry at this
2076
 
                # path [we dont know this in this routine at the moment -
2077
 
                # perhaps we should change this - then it would be an unknown.
2078
 
                old_path = pathjoin(entry[0][0], entry[0][1])
2079
 
                # parent id is the entry for the path in the target tree
2080
 
                parent_id = state._get_entry(source_index, path_utf8=entry[0][0])[0][2]
2081
 
                if parent_id == entry[0][2]:
2082
 
                    parent_id = None
2083
 
                return (entry[0][2],
2084
 
                       (utf8_decode(old_path)[0], None),
2085
 
                       True,
2086
 
                       (True, False),
2087
 
                       (parent_id, None),
2088
 
                       (utf8_decode(entry[0][1])[0], None),
2089
 
                       (_minikind_to_kind[source_minikind], None),
2090
 
                       (source_details[3], None))
2091
 
            elif source_minikind in 'fdlt' and target_minikind in 'r':
2092
 
                # a rename; could be a true rename, or a rename inherited from
2093
 
                # a renamed parent. TODO: handle this efficiently. Its not
2094
 
                # common case to rename dirs though, so a correct but slow
2095
 
                # implementation will do.
2096
 
                if not osutils.is_inside_any(searched_specific_files, target_details[1]):
2097
 
                    search_specific_files.add(target_details[1])
2098
 
            elif source_minikind in 'ra' and target_minikind in 'ra':
2099
 
                # neither of the selected trees contain this file,
2100
 
                # so skip over it. This is not currently directly tested, but
2101
 
                # is indirectly via test_too_much.TestCommands.test_conflicts.
2102
 
                pass
2103
 
            else:
2104
 
                raise AssertionError("don't know how to compare "
2105
 
                    "source_minikind=%r, target_minikind=%r"
2106
 
                    % (source_minikind, target_minikind))
2107
 
                ## import pdb;pdb.set_trace()
2108
 
            return None
2109
 
 
2110
 
        while search_specific_files:
2111
 
            # TODO: the pending list should be lexically sorted?  the
2112
 
            # interface doesn't require it.
2113
 
            current_root = search_specific_files.pop()
2114
 
            current_root_unicode = current_root.decode('utf8')
2115
 
            searched_specific_files.add(current_root)
2116
 
            # process the entries for this containing directory: the rest will be
2117
 
            # found by their parents recursively.
2118
 
            root_entries = _entries_for_path(current_root)
2119
 
            root_abspath = self.target.abspath(current_root_unicode)
2120
 
            try:
2121
 
                root_stat = os.lstat(root_abspath)
2122
 
            except OSError, e:
2123
 
                if e.errno == errno.ENOENT:
2124
 
                    # the path does not exist: let _process_entry know that.
2125
 
                    root_dir_info = None
2126
 
                else:
2127
 
                    # some other random error: hand it up.
2128
 
                    raise
2129
 
            else:
2130
 
                root_dir_info = ('', current_root,
2131
 
                    osutils.file_kind_from_stat_mode(root_stat.st_mode), root_stat,
2132
 
                    root_abspath)
2133
 
                if root_dir_info[2] == 'directory':
2134
 
                    if self.target._directory_is_tree_reference(
2135
 
                        current_root.decode('utf8')):
2136
 
                        root_dir_info = root_dir_info[:2] + \
2137
 
                            ('tree-reference',) + root_dir_info[3:]
2138
 
 
2139
 
            if not root_entries and not root_dir_info:
2140
 
                # this specified path is not present at all, skip it.
2141
 
                continue
2142
 
            path_handled = False
2143
 
            for entry in root_entries:
2144
 
                result = _process_entry(entry, root_dir_info)
2145
 
                if result is not None:
2146
 
                    path_handled = True
2147
 
                    if result is not uninteresting:
2148
 
                        yield result
2149
 
            if want_unversioned and not path_handled and root_dir_info:
2150
 
                new_executable = bool(
2151
 
                    stat.S_ISREG(root_dir_info[3].st_mode)
2152
 
                    and stat.S_IEXEC & root_dir_info[3].st_mode)
2153
 
                yield (None,
2154
 
                       (None, current_root_unicode),
2155
 
                       True,
2156
 
                       (False, False),
2157
 
                       (None, None),
2158
 
                       (None, splitpath(current_root_unicode)[-1]),
2159
 
                       (None, root_dir_info[2]),
2160
 
                       (None, new_executable)
2161
 
                      )
2162
 
            initial_key = (current_root, '', '')
2163
 
            block_index, _ = state._find_block_index_from_key(initial_key)
2164
 
            if block_index == 0:
2165
 
                # we have processed the total root already, but because the
2166
 
                # initial key matched it we should skip it here.
2167
 
                block_index +=1
2168
 
            if root_dir_info and root_dir_info[2] == 'tree-reference':
2169
 
                current_dir_info = None
2170
 
            else:
2171
 
                dir_iterator = osutils._walkdirs_utf8(root_abspath, prefix=current_root)
2172
 
                try:
2173
 
                    current_dir_info = dir_iterator.next()
2174
 
                except OSError, e:
2175
 
                    # on win32, python2.4 has e.errno == ERROR_DIRECTORY, but
2176
 
                    # python 2.5 has e.errno == EINVAL,
2177
 
                    #            and e.winerror == ERROR_DIRECTORY
2178
 
                    e_winerror = getattr(e, 'winerror', None)
2179
 
                    win_errors = (ERROR_DIRECTORY, ERROR_PATH_NOT_FOUND)
2180
 
                    # there may be directories in the inventory even though
2181
 
                    # this path is not a file on disk: so mark it as end of
2182
 
                    # iterator
2183
 
                    if e.errno in (errno.ENOENT, errno.ENOTDIR, errno.EINVAL):
2184
 
                        current_dir_info = None
2185
 
                    elif (sys.platform == 'win32'
2186
 
                          and (e.errno in win_errors
2187
 
                               or e_winerror in win_errors)):
2188
 
                        current_dir_info = None
2189
 
                    else:
2190
 
                        raise
2191
 
                else:
2192
 
                    if current_dir_info[0][0] == '':
2193
 
                        # remove .bzr from iteration
2194
 
                        bzr_index = bisect_left(current_dir_info[1], ('.bzr',))
2195
 
                        assert current_dir_info[1][bzr_index][0] == '.bzr'
2196
 
                        del current_dir_info[1][bzr_index]
2197
 
            # walk until both the directory listing and the versioned metadata
2198
 
            # are exhausted. 
2199
 
            if (block_index < len(state._dirblocks) and
2200
 
                osutils.is_inside(current_root, state._dirblocks[block_index][0])):
2201
 
                current_block = state._dirblocks[block_index]
2202
 
            else:
2203
 
                current_block = None
2204
 
            while (current_dir_info is not None or
2205
 
                   current_block is not None):
2206
 
                if (current_dir_info and current_block
2207
 
                    and current_dir_info[0][0] != current_block[0]):
2208
 
                    if cmp_by_dirs(current_dir_info[0][0], current_block[0]) < 0:
2209
 
                        # filesystem data refers to paths not covered by the dirblock.
2210
 
                        # this has two possibilities:
2211
 
                        # A) it is versioned but empty, so there is no block for it
2212
 
                        # B) it is not versioned.
2213
 
 
2214
 
                        # if (A) then we need to recurse into it to check for
2215
 
                        # new unknown files or directories.
2216
 
                        # if (B) then we should ignore it, because we don't
2217
 
                        # recurse into unknown directories.
2218
 
                        path_index = 0
2219
 
                        while path_index < len(current_dir_info[1]):
2220
 
                                current_path_info = current_dir_info[1][path_index]
2221
 
                                if want_unversioned:
2222
 
                                    if current_path_info[2] == 'directory':
2223
 
                                        if self.target._directory_is_tree_reference(
2224
 
                                            current_path_info[0].decode('utf8')):
2225
 
                                            current_path_info = current_path_info[:2] + \
2226
 
                                                ('tree-reference',) + current_path_info[3:]
2227
 
                                    new_executable = bool(
2228
 
                                        stat.S_ISREG(current_path_info[3].st_mode)
2229
 
                                        and stat.S_IEXEC & current_path_info[3].st_mode)
2230
 
                                    yield (None,
2231
 
                                        (None, utf8_decode(current_path_info[0])[0]),
2232
 
                                        True,
2233
 
                                        (False, False),
2234
 
                                        (None, None),
2235
 
                                        (None, utf8_decode(current_path_info[1])[0]),
2236
 
                                        (None, current_path_info[2]),
2237
 
                                        (None, new_executable))
2238
 
                                # dont descend into this unversioned path if it is
2239
 
                                # a dir
2240
 
                                if current_path_info[2] in ('directory',
2241
 
                                                            'tree-reference'):
2242
 
                                    del current_dir_info[1][path_index]
2243
 
                                    path_index -= 1
2244
 
                                path_index += 1
2245
 
 
2246
 
                        # This dir info has been handled, go to the next
2247
 
                        try:
2248
 
                            current_dir_info = dir_iterator.next()
2249
 
                        except StopIteration:
2250
 
                            current_dir_info = None
2251
 
                    else:
2252
 
                        # We have a dirblock entry for this location, but there
2253
 
                        # is no filesystem path for this. This is most likely
2254
 
                        # because a directory was removed from the disk.
2255
 
                        # We don't have to report the missing directory,
2256
 
                        # because that should have already been handled, but we
2257
 
                        # need to handle all of the files that are contained
2258
 
                        # within.
2259
 
                        for current_entry in current_block[1]:
2260
 
                            # entry referring to file not present on disk.
2261
 
                            # advance the entry only, after processing.
2262
 
                            result = _process_entry(current_entry, None)
2263
 
                            if result is not None:
2264
 
                                if result is not uninteresting:
2265
 
                                    yield result
2266
 
                        block_index +=1
2267
 
                        if (block_index < len(state._dirblocks) and
2268
 
                            osutils.is_inside(current_root,
2269
 
                                              state._dirblocks[block_index][0])):
2270
 
                            current_block = state._dirblocks[block_index]
2271
 
                        else:
2272
 
                            current_block = None
2273
 
                    continue
2274
 
                entry_index = 0
2275
 
                if current_block and entry_index < len(current_block[1]):
2276
 
                    current_entry = current_block[1][entry_index]
2277
 
                else:
2278
 
                    current_entry = None
2279
 
                advance_entry = True
2280
 
                path_index = 0
2281
 
                if current_dir_info and path_index < len(current_dir_info[1]):
2282
 
                    current_path_info = current_dir_info[1][path_index]
2283
 
                    if current_path_info[2] == 'directory':
2284
 
                        if self.target._directory_is_tree_reference(
2285
 
                            current_path_info[0].decode('utf8')):
2286
 
                            current_path_info = current_path_info[:2] + \
2287
 
                                ('tree-reference',) + current_path_info[3:]
2288
 
                else:
2289
 
                    current_path_info = None
2290
 
                advance_path = True
2291
 
                path_handled = False
2292
 
                while (current_entry is not None or
2293
 
                    current_path_info is not None):
2294
 
                    if current_entry is None:
2295
 
                        # the check for path_handled when the path is adnvaced
2296
 
                        # will yield this path if needed.
2297
 
                        pass
2298
 
                    elif current_path_info is None:
2299
 
                        # no path is fine: the per entry code will handle it.
2300
 
                        result = _process_entry(current_entry, current_path_info)
2301
 
                        if result is not None:
2302
 
                            if result is not uninteresting:
2303
 
                                yield result
2304
 
                    elif (current_entry[0][1] != current_path_info[1]
2305
 
                          or current_entry[1][target_index][0] in 'ar'):
2306
 
                        # The current path on disk doesn't match the dirblock
2307
 
                        # record. Either the dirblock is marked as absent, or
2308
 
                        # the file on disk is not present at all in the
2309
 
                        # dirblock. Either way, report about the dirblock
2310
 
                        # entry, and let other code handle the filesystem one.
2311
 
 
2312
 
                        # Compare the basename for these files to determine
2313
 
                        # which comes first
2314
 
                        if current_path_info[1] < current_entry[0][1]:
2315
 
                            # extra file on disk: pass for now, but only
2316
 
                            # increment the path, not the entry
2317
 
                            advance_entry = False
2318
 
                        else:
2319
 
                            # entry referring to file not present on disk.
2320
 
                            # advance the entry only, after processing.
2321
 
                            result = _process_entry(current_entry, None)
2322
 
                            if result is not None:
2323
 
                                if result is not uninteresting:
2324
 
                                    yield result
2325
 
                            advance_path = False
2326
 
                    else:
2327
 
                        result = _process_entry(current_entry, current_path_info)
2328
 
                        if result is not None:
2329
 
                            path_handled = True
2330
 
                            if result is not uninteresting:
2331
 
                                yield result
2332
 
                    if advance_entry and current_entry is not None:
2333
 
                        entry_index += 1
2334
 
                        if entry_index < len(current_block[1]):
2335
 
                            current_entry = current_block[1][entry_index]
2336
 
                        else:
2337
 
                            current_entry = None
2338
 
                    else:
2339
 
                        advance_entry = True # reset the advance flaga
2340
 
                    if advance_path and current_path_info is not None:
2341
 
                        if not path_handled:
2342
 
                            # unversioned in all regards
2343
 
                            if want_unversioned:
2344
 
                                new_executable = bool(
2345
 
                                    stat.S_ISREG(current_path_info[3].st_mode)
2346
 
                                    and stat.S_IEXEC & current_path_info[3].st_mode)
2347
 
                                yield (None,
2348
 
                                    (None, utf8_decode(current_path_info[0])[0]),
2349
 
                                    True,
2350
 
                                    (False, False),
2351
 
                                    (None, None),
2352
 
                                    (None, utf8_decode(current_path_info[1])[0]),
2353
 
                                    (None, current_path_info[2]),
2354
 
                                    (None, new_executable))
2355
 
                            # dont descend into this unversioned path if it is
2356
 
                            # a dir
2357
 
                            if current_path_info[2] in ('directory'):
2358
 
                                del current_dir_info[1][path_index]
2359
 
                                path_index -= 1
2360
 
                        # dont descend the disk iterator into any tree 
2361
 
                        # paths.
2362
 
                        if current_path_info[2] == 'tree-reference':
2363
 
                            del current_dir_info[1][path_index]
2364
 
                            path_index -= 1
2365
 
                        path_index += 1
2366
 
                        if path_index < len(current_dir_info[1]):
2367
 
                            current_path_info = current_dir_info[1][path_index]
2368
 
                            if current_path_info[2] == 'directory':
2369
 
                                if self.target._directory_is_tree_reference(
2370
 
                                    current_path_info[0].decode('utf8')):
2371
 
                                    current_path_info = current_path_info[:2] + \
2372
 
                                        ('tree-reference',) + current_path_info[3:]
2373
 
                        else:
2374
 
                            current_path_info = None
2375
 
                        path_handled = False
2376
 
                    else:
2377
 
                        advance_path = True # reset the advance flagg.
2378
 
                if current_block is not None:
2379
 
                    block_index += 1
2380
 
                    if (block_index < len(state._dirblocks) and
2381
 
                        osutils.is_inside(current_root, state._dirblocks[block_index][0])):
2382
 
                        current_block = state._dirblocks[block_index]
2383
 
                    else:
2384
 
                        current_block = None
2385
 
                if current_dir_info is not None:
2386
 
                    try:
2387
 
                        current_dir_info = dir_iterator.next()
2388
 
                    except StopIteration:
2389
 
                        current_dir_info = None
2390
 
 
 
2189
        iter_changes = self.target._iter_changes(include_unchanged,
 
2190
            use_filesystem_for_exec, search_specific_files, state,
 
2191
            source_index, target_index, want_unversioned, self.target)
 
2192
        return iter_changes.iter_changes()
2391
2193
 
2392
2194
    @staticmethod
2393
2195
    def is_compatible(source, target):
2394
2196
        # the target must be a dirstate working tree
2395
 
        if not isinstance(target, WorkingTree4):
 
2197
        if not isinstance(target, DirStateWorkingTree):
2396
2198
            return False
2397
 
        # the source must be a revtreee or dirstate rev tree.
 
2199
        # the source must be a revtree or dirstate rev tree.
2398
2200
        if not isinstance(source,
2399
2201
            (revisiontree.RevisionTree, DirStateRevisionTree)):
2400
2202
            return False
2401
2203
        # the source revid must be in the target dirstate
2402
 
        if not (source._revision_id == NULL_REVISION or
 
2204
        if not (source._revision_id == _mod_revision.NULL_REVISION or
2403
2205
            source._revision_id in target.get_parent_ids()):
2404
 
            # TODO: what about ghosts? it may well need to 
 
2206
            # TODO: what about ghosts? it may well need to
2405
2207
            # check for them explicitly.
2406
2208
            return False
2407
2209
        return True
2417
2219
 
2418
2220
    def convert(self, tree):
2419
2221
        # lock the control files not the tree, so that we dont get tree
2420
 
        # on-unlock behaviours, and so that noone else diddles with the 
 
2222
        # on-unlock behaviours, and so that noone else diddles with the
2421
2223
        # tree during upgrade.
2422
2224
        tree._control_files.lock_write()
2423
2225
        try:
2449
2251
 
2450
2252
    def update_format(self, tree):
2451
2253
        """Change the format marker."""
2452
 
        tree._control_files.put_utf8('format',
2453
 
            self.target_format.get_format_string())
 
2254
        tree._transport.put_bytes('format',
 
2255
            self.target_format.get_format_string(),
 
2256
            mode=tree.bzrdir._get_file_mode())
 
2257
 
 
2258
 
 
2259
class Converter4to5(object):
 
2260
    """Perform an in-place upgrade of format 4 to format 5 trees."""
 
2261
 
 
2262
    def __init__(self):
 
2263
        self.target_format = WorkingTreeFormat5()
 
2264
 
 
2265
    def convert(self, tree):
 
2266
        # lock the control files not the tree, so that we don't get tree
 
2267
        # on-unlock behaviours, and so that no-one else diddles with the
 
2268
        # tree during upgrade.
 
2269
        tree._control_files.lock_write()
 
2270
        try:
 
2271
            self.update_format(tree)
 
2272
        finally:
 
2273
            tree._control_files.unlock()
 
2274
 
 
2275
    def update_format(self, tree):
 
2276
        """Change the format marker."""
 
2277
        tree._transport.put_bytes('format',
 
2278
            self.target_format.get_format_string(),
 
2279
            mode=tree.bzrdir._get_file_mode())
 
2280
 
 
2281
 
 
2282
class Converter4or5to6(object):
 
2283
    """Perform an in-place upgrade of format 4 or 5 to format 6 trees."""
 
2284
 
 
2285
    def __init__(self):
 
2286
        self.target_format = WorkingTreeFormat6()
 
2287
 
 
2288
    def convert(self, tree):
 
2289
        # lock the control files not the tree, so that we don't get tree
 
2290
        # on-unlock behaviours, and so that no-one else diddles with the
 
2291
        # tree during upgrade.
 
2292
        tree._control_files.lock_write()
 
2293
        try:
 
2294
            self.init_custom_control_files(tree)
 
2295
            self.update_format(tree)
 
2296
        finally:
 
2297
            tree._control_files.unlock()
 
2298
 
 
2299
    def init_custom_control_files(self, tree):
 
2300
        """Initialize custom control files."""
 
2301
        tree._transport.put_bytes('views', '',
 
2302
            mode=tree.bzrdir._get_file_mode())
 
2303
 
 
2304
    def update_format(self, tree):
 
2305
        """Change the format marker."""
 
2306
        tree._transport.put_bytes('format',
 
2307
            self.target_format.get_format_string(),
 
2308
            mode=tree.bzrdir._get_file_mode())