~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree_4.py

  • Committer: Vincent Ladeuil
  • Date: 2013-07-13 22:35:15 UTC
  • mto: This revision was merged to the branch mainline in revision 6581.
  • Revision ID: v.ladeuil+lp@free.fr-20130713223515-wftce3su3nu2oov6
Support utf-8 platform names

Show diffs side-by-side

added added

removed removed

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