~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree_4.py

  • Committer: Andrew Bennetts
  • Date: 2007-03-28 07:08:42 UTC
  • mfrom: (2380 +trunk)
  • mto: (2018.5.146 hpss)
  • mto: This revision was merged to the branch mainline in revision 2414.
  • Revision ID: andrew.bennetts@canonical.com-20070328070842-r843houy668oxb9o
Merge from bzr.dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
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
 
16
 
 
17
"""WorkingTree4 format and implementation.
 
18
 
 
19
WorkingTree4 provides the dirstate based working tree logic.
 
20
 
 
21
To get a WorkingTree, call bzrdir.open_workingtree() or
 
22
WorkingTree.open(dir).
 
23
"""
 
24
 
 
25
from cStringIO import StringIO
 
26
import os
 
27
import sys
 
28
 
 
29
from bzrlib.lazy_import import lazy_import
 
30
lazy_import(globals(), """
 
31
from bisect import bisect_left
 
32
import collections
 
33
from copy import deepcopy
 
34
import errno
 
35
import itertools
 
36
import operator
 
37
import stat
 
38
from time import time
 
39
import warnings
 
40
 
 
41
import bzrlib
 
42
from bzrlib import (
 
43
    bzrdir,
 
44
    cache_utf8,
 
45
    conflicts as _mod_conflicts,
 
46
    delta,
 
47
    dirstate,
 
48
    errors,
 
49
    generate_ids,
 
50
    globbing,
 
51
    hashcache,
 
52
    ignores,
 
53
    merge,
 
54
    osutils,
 
55
    revisiontree,
 
56
    textui,
 
57
    transform,
 
58
    urlutils,
 
59
    xml5,
 
60
    xml6,
 
61
    )
 
62
import bzrlib.branch
 
63
from bzrlib.transport import get_transport
 
64
import bzrlib.ui
 
65
""")
 
66
 
 
67
from bzrlib import symbol_versioning
 
68
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
69
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, entry_factory
 
70
from bzrlib.lockable_files import LockableFiles, TransportLock
 
71
from bzrlib.lockdir import LockDir
 
72
import bzrlib.mutabletree
 
73
from bzrlib.mutabletree import needs_tree_write_lock
 
74
from bzrlib.osutils import (
 
75
    file_kind,
 
76
    isdir,
 
77
    normpath,
 
78
    pathjoin,
 
79
    rand_chars,
 
80
    realpath,
 
81
    safe_unicode,
 
82
    splitpath,
 
83
    )
 
84
from bzrlib.trace import mutter, note
 
85
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_DIRECTORY = 267
 
103
 
 
104
 
 
105
class WorkingTree4(WorkingTree3):
 
106
    """This is the Format 4 working tree.
 
107
 
 
108
    This differs from WorkingTree3 by:
 
109
     - Having a consolidated internal dirstate, stored in a
 
110
       randomly-accessible sorted file on disk.
 
111
     - Not having a regular inventory attribute.  One can be synthesized 
 
112
       on demand but this is expensive and should be avoided.
 
113
 
 
114
    This is new in bzr 0.15.
 
115
    """
 
116
 
 
117
    def __init__(self, basedir,
 
118
                 branch,
 
119
                 _control_files=None,
 
120
                 _format=None,
 
121
                 _bzrdir=None):
 
122
        """Construct a WorkingTree for basedir.
 
123
 
 
124
        If the branch is not supplied, it is opened automatically.
 
125
        If the branch is supplied, it must be the branch for this basedir.
 
126
        (branch.base is not cross checked, because for remote branches that
 
127
        would be meaningless).
 
128
        """
 
129
        self._format = _format
 
130
        self.bzrdir = _bzrdir
 
131
        from bzrlib.trace import note, mutter
 
132
        assert isinstance(basedir, basestring), \
 
133
            "base directory %r is not a string" % basedir
 
134
        basedir = safe_unicode(basedir)
 
135
        mutter("opening working tree %r", basedir)
 
136
        self._branch = branch
 
137
        assert isinstance(self.branch, bzrlib.branch.Branch), \
 
138
            "branch %r is not a Branch" % self.branch
 
139
        self.basedir = realpath(basedir)
 
140
        # if branch is at our basedir and is a format 6 or less
 
141
        # assume all other formats have their own control files.
 
142
        assert isinstance(_control_files, LockableFiles), \
 
143
            "_control_files must be a LockableFiles, not %r" % _control_files
 
144
        self._control_files = _control_files
 
145
        self._dirty = None
 
146
        #-------------
 
147
        # during a read or write lock these objects are set, and are
 
148
        # None the rest of the time.
 
149
        self._dirstate = None
 
150
        self._inventory = None
 
151
        #-------------
 
152
 
 
153
    @needs_tree_write_lock
 
154
    def _add(self, files, ids, kinds):
 
155
        """See MutableTree._add."""
 
156
        state = self.current_dirstate()
 
157
        for f, file_id, kind in zip(files, ids, kinds):
 
158
            f = f.strip('/')
 
159
            assert '//' not in f
 
160
            assert '..' not in f
 
161
            if self.path2id(f):
 
162
                # special case tree root handling.
 
163
                if f == '' and self.path2id(f) == ROOT_ID:
 
164
                    state.set_path_id('', generate_ids.gen_file_id(f))
 
165
                continue
 
166
            if file_id is None:
 
167
                file_id = generate_ids.gen_file_id(f)
 
168
            # deliberately add the file with no cached stat or sha1
 
169
            # - on the first access it will be gathered, and we can
 
170
            # always change this once tests are all passing.
 
171
            state.add(f, file_id, kind, None, '')
 
172
        self._make_dirty(reset_inventory=True)
 
173
 
 
174
    def _make_dirty(self, reset_inventory):
 
175
        """Make the tree state dirty.
 
176
 
 
177
        :param reset_inventory: True if the cached inventory should be removed
 
178
            (presuming there is one).
 
179
        """
 
180
        self._dirty = True
 
181
        if reset_inventory and self._inventory is not None:
 
182
            self._inventory = None
 
183
 
 
184
    @needs_tree_write_lock
 
185
    def add_reference(self, sub_tree):
 
186
        # use standard implementation, which calls back to self._add
 
187
        # 
 
188
        # So we don't store the reference_revision in the working dirstate,
 
189
        # it's just recorded at the moment of commit. 
 
190
        self._add_reference(sub_tree)
 
191
 
 
192
    def break_lock(self):
 
193
        """Break a lock if one is present from another instance.
 
194
 
 
195
        Uses the ui factory to ask for confirmation if the lock may be from
 
196
        an active process.
 
197
 
 
198
        This will probe the repository for its lock as well.
 
199
        """
 
200
        # if the dirstate is locked by an active process, reject the break lock
 
201
        # call.
 
202
        try:
 
203
            if self._dirstate is None:
 
204
                clear = True
 
205
            else:
 
206
                clear = False
 
207
            state = self._current_dirstate()
 
208
            if state._lock_token is not None:
 
209
                # we already have it locked. sheese, cant break our own lock.
 
210
                raise errors.LockActive(self.basedir)
 
211
            else:
 
212
                try:
 
213
                    # try for a write lock - need permission to get one anyhow
 
214
                    # to break locks.
 
215
                    state.lock_write()
 
216
                except errors.LockContention:
 
217
                    # oslocks fail when a process is still live: fail.
 
218
                    # TODO: get the locked lockdir info and give to the user to
 
219
                    # assist in debugging.
 
220
                    raise errors.LockActive(self.basedir)
 
221
                else:
 
222
                    state.unlock()
 
223
        finally:
 
224
            if clear:
 
225
                self._dirstate = None
 
226
        self._control_files.break_lock()
 
227
        self.branch.break_lock()
 
228
 
 
229
    def _comparison_data(self, entry, path):
 
230
        kind, executable, stat_value = \
 
231
            WorkingTree3._comparison_data(self, entry, path)
 
232
        # it looks like a plain directory, but it's really a reference -- see
 
233
        # also kind()
 
234
        if (self._repo_supports_tree_reference and
 
235
            kind == 'directory' and
 
236
            self._directory_is_tree_reference(path)):
 
237
            kind = 'tree-reference'
 
238
        return kind, executable, stat_value
 
239
 
 
240
    @needs_write_lock
 
241
    def commit(self, message=None, revprops=None, *args, **kwargs):
 
242
        # mark the tree as dirty post commit - commit
 
243
        # can change the current versioned list by doing deletes.
 
244
        result = WorkingTree3.commit(self, message, revprops, *args, **kwargs)
 
245
        self._make_dirty(reset_inventory=True)
 
246
        return result
 
247
 
 
248
    def current_dirstate(self):
 
249
        """Return the current dirstate object.
 
250
 
 
251
        This is not part of the tree interface and only exposed for ease of
 
252
        testing.
 
253
 
 
254
        :raises errors.NotWriteLocked: when not in a lock.
 
255
        """
 
256
        self._must_be_locked()
 
257
        return self._current_dirstate()
 
258
 
 
259
    def _current_dirstate(self):
 
260
        """Internal function that does not check lock status.
 
261
 
 
262
        This is needed for break_lock which also needs the dirstate.
 
263
        """
 
264
        if self._dirstate is not None:
 
265
            return self._dirstate
 
266
        local_path = self.bzrdir.get_workingtree_transport(None
 
267
            ).local_abspath('dirstate')
 
268
        self._dirstate = dirstate.DirState.on_file(local_path)
 
269
        return self._dirstate
 
270
 
 
271
    def _directory_is_tree_reference(self, relpath):
 
272
        # as a special case, if a directory contains control files then 
 
273
        # it's a tree reference, except that the root of the tree is not
 
274
        return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
 
275
        # TODO: We could ask all the control formats whether they
 
276
        # recognize this directory, but at the moment there's no cheap api
 
277
        # to do that.  Since we probably can only nest bzr checkouts and
 
278
        # they always use this name it's ok for now.  -- mbp 20060306
 
279
        #
 
280
        # FIXME: There is an unhandled case here of a subdirectory
 
281
        # containing .bzr but not a branch; that will probably blow up
 
282
        # when you try to commit it.  It might happen if there is a
 
283
        # checkout in a subdirectory.  This can be avoided by not adding
 
284
        # it.  mbp 20070306
 
285
 
 
286
    def filter_unversioned_files(self, paths):
 
287
        """Filter out paths that are versioned.
 
288
 
 
289
        :return: set of paths.
 
290
        """
 
291
        # TODO: make a generic multi-bisect routine roughly that should list
 
292
        # the paths, then process one half at a time recursively, and feed the
 
293
        # results of each bisect in further still
 
294
        paths = sorted(paths)
 
295
        result = set()
 
296
        state = self.current_dirstate()
 
297
        # TODO we want a paths_to_dirblocks helper I think
 
298
        for path in paths:
 
299
            dirname, basename = os.path.split(path.encode('utf8'))
 
300
            _, _, _, path_is_versioned = state._get_block_entry_index(
 
301
                dirname, basename, 0)
 
302
            if not path_is_versioned:
 
303
                result.add(path)
 
304
        return result
 
305
 
 
306
    def flush(self):
 
307
        """Write all cached data to disk."""
 
308
        if self._control_files._lock_mode != 'w':
 
309
            raise errors.NotWriteLocked(self)
 
310
        self.current_dirstate().save()
 
311
        self._inventory = None
 
312
        self._dirty = False
 
313
 
 
314
    @needs_tree_write_lock
 
315
    def _gather_kinds(self, files, kinds):
 
316
        """See MutableTree._gather_kinds."""
 
317
        for pos, f in enumerate(files):
 
318
            if kinds[pos] is None:
 
319
                kinds[pos] = self._kind(f)
 
320
 
 
321
    def _generate_inventory(self):
 
322
        """Create and set self.inventory from the dirstate object.
 
323
        
 
324
        This is relatively expensive: we have to walk the entire dirstate.
 
325
        Ideally we would not, and can deprecate this function.
 
326
        """
 
327
        #: uncomment to trap on inventory requests.
 
328
        # import pdb;pdb.set_trace()
 
329
        state = self.current_dirstate()
 
330
        state._read_dirblocks_if_needed()
 
331
        root_key, current_entry = self._get_entry(path='')
 
332
        current_id = root_key[2]
 
333
        assert current_entry[0][0] == 'd' # directory
 
334
        inv = Inventory(root_id=current_id)
 
335
        # Turn some things into local variables
 
336
        minikind_to_kind = dirstate.DirState._minikind_to_kind
 
337
        factory = entry_factory
 
338
        utf8_decode = cache_utf8._utf8_decode
 
339
        inv_byid = inv._byid
 
340
        # we could do this straight out of the dirstate; it might be fast
 
341
        # and should be profiled - RBC 20070216
 
342
        parent_ies = {'' : inv.root}
 
343
        for block in state._dirblocks[1:]: # skip the root
 
344
            dirname = block[0]
 
345
            try:
 
346
                parent_ie = parent_ies[dirname]
 
347
            except KeyError:
 
348
                # all the paths in this block are not versioned in this tree
 
349
                continue
 
350
            for key, entry in block[1]:
 
351
                minikind, link_or_sha1, size, executable, stat = entry[0]
 
352
                if minikind in ('a', 'r'): # absent, relocated
 
353
                    # a parent tree only entry
 
354
                    continue
 
355
                name = key[1]
 
356
                name_unicode = utf8_decode(name)[0]
 
357
                file_id = key[2]
 
358
                kind = minikind_to_kind[minikind]
 
359
                inv_entry = factory[kind](file_id, name_unicode,
 
360
                                          parent_ie.file_id)
 
361
                if kind == 'file':
 
362
                    # This is only needed on win32, where this is the only way
 
363
                    # we know the executable bit.
 
364
                    inv_entry.executable = executable
 
365
                    # not strictly needed: working tree
 
366
                    #inv_entry.text_size = size
 
367
                    #inv_entry.text_sha1 = sha1
 
368
                elif kind == 'directory':
 
369
                    # add this entry to the parent map.
 
370
                    parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
 
371
                elif kind == 'tree-reference':
 
372
                    assert self._repo_supports_tree_reference, \
 
373
                        "repository of %r " \
 
374
                        "doesn't support tree references " \
 
375
                        "required by entry %r" \
 
376
                        % (self, name)
 
377
                    inv_entry.reference_revision = link_or_sha1 or None
 
378
                elif kind != 'symlink':
 
379
                    raise AssertionError("unknown kind %r" % kind)
 
380
                # These checks cost us around 40ms on a 55k entry tree
 
381
                assert file_id not in inv_byid, ('file_id %s already in'
 
382
                    ' inventory as %s' % (file_id, inv_byid[file_id]))
 
383
                assert name_unicode not in parent_ie.children
 
384
                inv_byid[file_id] = inv_entry
 
385
                parent_ie.children[name_unicode] = inv_entry
 
386
        self._inventory = inv
 
387
 
 
388
    def _get_entry(self, file_id=None, path=None):
 
389
        """Get the dirstate row for file_id or path.
 
390
 
 
391
        If either file_id or path is supplied, it is used as the key to lookup.
 
392
        If both are supplied, the fastest lookup is used, and an error is
 
393
        raised if they do not both point at the same row.
 
394
        
 
395
        :param file_id: An optional unicode file_id to be looked up.
 
396
        :param path: An optional unicode path to be looked up.
 
397
        :return: The dirstate row tuple for path/file_id, or (None, None)
 
398
        """
 
399
        if file_id is None and path is None:
 
400
            raise errors.BzrError('must supply file_id or path')
 
401
        state = self.current_dirstate()
 
402
        if path is not None:
 
403
            path = path.encode('utf8')
 
404
        return state._get_entry(0, fileid_utf8=file_id, path_utf8=path)
 
405
 
 
406
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
407
        # check file id is valid unconditionally.
 
408
        entry = self._get_entry(file_id=file_id, path=path)
 
409
        assert entry[0] is not None, 'what error should this raise'
 
410
        if path is None:
 
411
            path = pathjoin(entry[0][0], entry[0][1]).decode('utf8')
 
412
 
 
413
        file_abspath = self.abspath(path)
 
414
        state = self.current_dirstate()
 
415
        link_or_sha1 = state.update_entry(entry, file_abspath,
 
416
                                          stat_value=stat_value)
 
417
        if entry[1][0][0] == 'f':
 
418
            return link_or_sha1
 
419
        return None
 
420
 
 
421
    def _get_inventory(self):
 
422
        """Get the inventory for the tree. This is only valid within a lock."""
 
423
        if self._inventory is not None:
 
424
            return self._inventory
 
425
        self._must_be_locked()
 
426
        self._generate_inventory()
 
427
        return self._inventory
 
428
 
 
429
    inventory = property(_get_inventory,
 
430
                         doc="Inventory of this Tree")
 
431
 
 
432
    @needs_read_lock
 
433
    def get_parent_ids(self):
 
434
        """See Tree.get_parent_ids.
 
435
        
 
436
        This implementation requests the ids list from the dirstate file.
 
437
        """
 
438
        return self.current_dirstate().get_parent_ids()
 
439
 
 
440
    def get_reference_revision(self, file_id, path=None):
 
441
        # referenced tree's revision is whatever's currently there
 
442
        return self.get_nested_tree(file_id, path).last_revision()
 
443
 
 
444
    def get_nested_tree(self, file_id, path=None):
 
445
        if path is None:
 
446
            path = self.id2path(file_id)
 
447
        # else: check file_id is at path?
 
448
        return WorkingTree.open(self.abspath(path))
 
449
 
 
450
    @needs_read_lock
 
451
    def get_root_id(self):
 
452
        """Return the id of this trees root"""
 
453
        return self._get_entry(path='')[0][2]
 
454
 
 
455
    def has_id(self, file_id):
 
456
        state = self.current_dirstate()
 
457
        file_id = osutils.safe_file_id(file_id)
 
458
        row, parents = self._get_entry(file_id=file_id)
 
459
        if row is None:
 
460
            return False
 
461
        return osutils.lexists(pathjoin(
 
462
                    self.basedir, row[0].decode('utf8'), row[1].decode('utf8')))
 
463
 
 
464
    @needs_read_lock
 
465
    def id2path(self, file_id):
 
466
        file_id = osutils.safe_file_id(file_id)
 
467
        state = self.current_dirstate()
 
468
        entry = self._get_entry(file_id=file_id)
 
469
        if entry == (None, None):
 
470
            raise errors.NoSuchId(tree=self, file_id=file_id)
 
471
        path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
 
472
        return path_utf8.decode('utf8')
 
473
 
 
474
    if not osutils.supports_executable():
 
475
        @needs_read_lock
 
476
        def is_executable(self, file_id, path=None):
 
477
            file_id = osutils.safe_file_id(file_id)
 
478
            entry = self._get_entry(file_id=file_id, path=path)
 
479
            if entry == (None, None):
 
480
                return False
 
481
            return entry[1][0][3]
 
482
    else:
 
483
        @needs_read_lock
 
484
        def is_executable(self, file_id, path=None):
 
485
            if not path:
 
486
                file_id = osutils.safe_file_id(file_id)
 
487
                path = self.id2path(file_id)
 
488
            mode = os.lstat(self.abspath(path)).st_mode
 
489
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
 
490
 
 
491
    @needs_read_lock
 
492
    def __iter__(self):
 
493
        """Iterate through file_ids for this tree.
 
494
 
 
495
        file_ids are in a WorkingTree if they are in the working inventory
 
496
        and the working file exists.
 
497
        """
 
498
        result = []
 
499
        for key, tree_details in self.current_dirstate()._iter_entries():
 
500
            if tree_details[0][0] in ('a', 'r'): # absent, relocated
 
501
                # not relevant to the working tree
 
502
                continue
 
503
            path = pathjoin(self.basedir, key[0].decode('utf8'), key[1].decode('utf8'))
 
504
            if osutils.lexists(path):
 
505
                result.append(key[2])
 
506
        return iter(result)
 
507
 
 
508
    def iter_references(self):
 
509
        for key, tree_details in self.current_dirstate()._iter_entries():
 
510
            if tree_details[0][0] in ('a', 'r'): # absent, relocated
 
511
                # not relevant to the working tree
 
512
                continue
 
513
            if not key[1]:
 
514
                # the root is not a reference.
 
515
                continue
 
516
            path = pathjoin(self.basedir, key[0].decode('utf8'), key[1].decode('utf8'))
 
517
            try:
 
518
                if self._kind(path) == 'tree-reference':
 
519
                    yield path, key[2]
 
520
            except errors.NoSuchFile:
 
521
                # path is missing on disk.
 
522
                continue
 
523
 
 
524
    @needs_read_lock
 
525
    def kind(self, file_id):
 
526
        """Return the kind of a file.
 
527
 
 
528
        This is always the actual kind that's on disk, regardless of what it
 
529
        was added as.
 
530
        """
 
531
        relpath = self.id2path(file_id)
 
532
        assert relpath != None, \
 
533
            "path for id {%s} is None!" % file_id
 
534
        return self._kind(relpath)
 
535
 
 
536
    def _kind(self, relpath):
 
537
        abspath = self.abspath(relpath)
 
538
        kind = file_kind(abspath)
 
539
        if (self._repo_supports_tree_reference and
 
540
            kind == 'directory' and
 
541
            self._directory_is_tree_reference(relpath)):
 
542
            kind = 'tree-reference'
 
543
        return kind
 
544
 
 
545
    @needs_read_lock
 
546
    def _last_revision(self):
 
547
        """See Mutable.last_revision."""
 
548
        parent_ids = self.current_dirstate().get_parent_ids()
 
549
        if parent_ids:
 
550
            return parent_ids[0]
 
551
        else:
 
552
            return None
 
553
 
 
554
    def lock_read(self):
 
555
        """See Branch.lock_read, and WorkingTree.unlock."""
 
556
        self.branch.lock_read()
 
557
        try:
 
558
            self._control_files.lock_read()
 
559
            try:
 
560
                state = self.current_dirstate()
 
561
                if not state._lock_token:
 
562
                    state.lock_read()
 
563
                # set our support for tree references from the repository in
 
564
                # use.
 
565
                self._repo_supports_tree_reference = getattr(
 
566
                    self.branch.repository._format, "support_tree_reference",
 
567
                    False)
 
568
            except:
 
569
                self._control_files.unlock()
 
570
                raise
 
571
        except:
 
572
            self.branch.unlock()
 
573
            raise
 
574
 
 
575
    def _lock_self_write(self):
 
576
        """This should be called after the branch is locked."""
 
577
        try:
 
578
            self._control_files.lock_write()
 
579
            try:
 
580
                state = self.current_dirstate()
 
581
                if not state._lock_token:
 
582
                    state.lock_write()
 
583
                # set our support for tree references from the repository in
 
584
                # use.
 
585
                self._repo_supports_tree_reference = getattr(
 
586
                    self.branch.repository._format, "support_tree_reference",
 
587
                    False)
 
588
            except:
 
589
                self._control_files.unlock()
 
590
                raise
 
591
        except:
 
592
            self.branch.unlock()
 
593
            raise
 
594
 
 
595
    def lock_tree_write(self):
 
596
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
 
597
        self.branch.lock_read()
 
598
        self._lock_self_write()
 
599
 
 
600
    def lock_write(self):
 
601
        """See MutableTree.lock_write, and WorkingTree.unlock."""
 
602
        self.branch.lock_write()
 
603
        self._lock_self_write()
 
604
 
 
605
    @needs_tree_write_lock
 
606
    def move(self, from_paths, to_dir, after=False):
 
607
        """See WorkingTree.move()."""
 
608
        result = []
 
609
        if not from_paths:
 
610
            return result
 
611
 
 
612
        state = self.current_dirstate()
 
613
 
 
614
        assert not isinstance(from_paths, basestring)
 
615
        to_dir_utf8 = to_dir.encode('utf8')
 
616
        to_entry_dirname, to_basename = os.path.split(to_dir_utf8)
 
617
        id_index = state._get_id_index()
 
618
        # check destination directory
 
619
        # get the details for it
 
620
        to_entry_block_index, to_entry_entry_index, dir_present, entry_present = \
 
621
            state._get_block_entry_index(to_entry_dirname, to_basename, 0)
 
622
        if not entry_present:
 
623
            raise errors.BzrMoveFailedError('', to_dir,
 
624
                errors.NotVersionedError(to_dir))
 
625
        to_entry = state._dirblocks[to_entry_block_index][1][to_entry_entry_index]
 
626
        # get a handle on the block itself.
 
627
        to_block_index = state._ensure_block(
 
628
            to_entry_block_index, to_entry_entry_index, to_dir_utf8)
 
629
        to_block = state._dirblocks[to_block_index]
 
630
        to_abs = self.abspath(to_dir)
 
631
        if not isdir(to_abs):
 
632
            raise errors.BzrMoveFailedError('',to_dir,
 
633
                errors.NotADirectory(to_abs))
 
634
 
 
635
        if to_entry[1][0][0] != 'd':
 
636
            raise errors.BzrMoveFailedError('',to_dir,
 
637
                errors.NotADirectory(to_abs))
 
638
 
 
639
        if self._inventory is not None:
 
640
            update_inventory = True
 
641
            inv = self.inventory
 
642
            to_dir_ie = inv[to_dir_id]
 
643
            to_dir_id = to_entry[0][2]
 
644
        else:
 
645
            update_inventory = False
 
646
 
 
647
        rollbacks = []
 
648
        def move_one(old_entry, from_path_utf8, minikind, executable,
 
649
                     fingerprint, packed_stat, size,
 
650
                     to_block, to_key, to_path_utf8):
 
651
            state._make_absent(old_entry)
 
652
            from_key = old_entry[0]
 
653
            rollbacks.append(
 
654
                lambda:state.update_minimal(from_key,
 
655
                    minikind,
 
656
                    executable=executable,
 
657
                    fingerprint=fingerprint,
 
658
                    packed_stat=packed_stat,
 
659
                    size=size,
 
660
                    path_utf8=from_path_utf8))
 
661
            state.update_minimal(to_key,
 
662
                    minikind,
 
663
                    executable=executable,
 
664
                    fingerprint=fingerprint,
 
665
                    packed_stat=packed_stat,
 
666
                    size=size,
 
667
                    path_utf8=to_path_utf8)
 
668
            added_entry_index, _ = state._find_entry_index(to_key, to_block[1])
 
669
            new_entry = to_block[1][added_entry_index]
 
670
            rollbacks.append(lambda:state._make_absent(new_entry))
 
671
 
 
672
        # create rename entries and tuples
 
673
        for from_rel in from_paths:
 
674
            # from_rel is 'pathinroot/foo/bar'
 
675
            from_rel_utf8 = from_rel.encode('utf8')
 
676
            from_dirname, from_tail = osutils.split(from_rel)
 
677
            from_dirname, from_tail_utf8 = osutils.split(from_rel_utf8)
 
678
            from_entry = self._get_entry(path=from_rel)
 
679
            if from_entry == (None, None):
 
680
                raise errors.BzrMoveFailedError(from_rel,to_dir,
 
681
                    errors.NotVersionedError(path=str(from_rel)))
 
682
 
 
683
            from_id = from_entry[0][2]
 
684
            to_rel = pathjoin(to_dir, from_tail)
 
685
            to_rel_utf8 = pathjoin(to_dir_utf8, from_tail_utf8)
 
686
            item_to_entry = self._get_entry(path=to_rel)
 
687
            if item_to_entry != (None, None):
 
688
                raise errors.BzrMoveFailedError(from_rel, to_rel,
 
689
                    "Target is already versioned.")
 
690
 
 
691
            if from_rel == to_rel:
 
692
                raise errors.BzrMoveFailedError(from_rel, to_rel,
 
693
                    "Source and target are identical.")
 
694
 
 
695
            from_missing = not self.has_filename(from_rel)
 
696
            to_missing = not self.has_filename(to_rel)
 
697
            if after:
 
698
                move_file = False
 
699
            else:
 
700
                move_file = True
 
701
            if to_missing:
 
702
                if not move_file:
 
703
                    raise errors.BzrMoveFailedError(from_rel, to_rel,
 
704
                        errors.NoSuchFile(path=to_rel,
 
705
                        extra="New file has not been created yet"))
 
706
                elif from_missing:
 
707
                    # neither path exists
 
708
                    raise errors.BzrRenameFailedError(from_rel, to_rel,
 
709
                        errors.PathsDoNotExist(paths=(from_rel, to_rel)))
 
710
            else:
 
711
                if from_missing: # implicitly just update our path mapping
 
712
                    move_file = False
 
713
                elif not after:
 
714
                    raise errors.RenameFailedFilesExist(from_rel, to_rel,
 
715
                        extra="(Use --after to update the Bazaar id)")
 
716
 
 
717
            rollbacks = []
 
718
            def rollback_rename():
 
719
                """A single rename has failed, roll it back."""
 
720
                # roll back everything, even if we encounter trouble doing one
 
721
                # of them.
 
722
                #
 
723
                # TODO: at least log the other exceptions rather than just
 
724
                # losing them mbp 20070307
 
725
                exc_info = None
 
726
                for rollback in reversed(rollbacks):
 
727
                    try:
 
728
                        rollback()
 
729
                    except Exception, e:
 
730
                        exc_info = sys.exc_info()
 
731
                if exc_info:
 
732
                    raise exc_info[0], exc_info[1], exc_info[2]
 
733
 
 
734
            # perform the disk move first - its the most likely failure point.
 
735
            if move_file:
 
736
                from_rel_abs = self.abspath(from_rel)
 
737
                to_rel_abs = self.abspath(to_rel)
 
738
                try:
 
739
                    osutils.rename(from_rel_abs, to_rel_abs)
 
740
                except OSError, e:
 
741
                    raise errors.BzrMoveFailedError(from_rel, to_rel, e[1])
 
742
                rollbacks.append(lambda: osutils.rename(to_rel_abs, from_rel_abs))
 
743
            try:
 
744
                # perform the rename in the inventory next if needed: its easy
 
745
                # to rollback
 
746
                if update_inventory:
 
747
                    # rename the entry
 
748
                    from_entry = inv[from_id]
 
749
                    current_parent = from_entry.parent_id
 
750
                    inv.rename(from_id, to_dir_id, from_tail)
 
751
                    rollbacks.append(
 
752
                        lambda: inv.rename(from_id, current_parent, from_tail))
 
753
                # finally do the rename in the dirstate, which is a little
 
754
                # tricky to rollback, but least likely to need it.
 
755
                old_block_index, old_entry_index, dir_present, file_present = \
 
756
                    state._get_block_entry_index(from_dirname, from_tail_utf8, 0)
 
757
                old_block = state._dirblocks[old_block_index][1]
 
758
                old_entry = old_block[old_entry_index]
 
759
                from_key, old_entry_details = old_entry
 
760
                cur_details = old_entry_details[0]
 
761
                # remove the old row
 
762
                to_key = ((to_block[0],) + from_key[1:3])
 
763
                minikind = cur_details[0]
 
764
                move_one(old_entry, from_path_utf8=from_rel_utf8,
 
765
                         minikind=minikind,
 
766
                         executable=cur_details[3],
 
767
                         fingerprint=cur_details[1],
 
768
                         packed_stat=cur_details[4],
 
769
                         size=cur_details[2],
 
770
                         to_block=to_block,
 
771
                         to_key=to_key,
 
772
                         to_path_utf8=to_rel_utf8)
 
773
 
 
774
                if minikind == 'd':
 
775
                    def update_dirblock(from_dir, to_key, to_dir_utf8):
 
776
                        """all entries in this block need updating.
 
777
 
 
778
                        TODO: This is pretty ugly, and doesn't support
 
779
                        reverting, but it works.
 
780
                        """
 
781
                        assert from_dir != '', "renaming root not supported"
 
782
                        from_key = (from_dir, '')
 
783
                        from_block_idx, present = \
 
784
                            state._find_block_index_from_key(from_key)
 
785
                        if not present:
 
786
                            # This is the old record, if it isn't present, then
 
787
                            # there is theoretically nothing to update.
 
788
                            # (Unless it isn't present because of lazy loading,
 
789
                            # but we don't do that yet)
 
790
                            return
 
791
                        from_block = state._dirblocks[from_block_idx]
 
792
                        to_block_index, to_entry_index, _, _ = \
 
793
                            state._get_block_entry_index(to_key[0], to_key[1], 0)
 
794
                        to_block_index = state._ensure_block(
 
795
                            to_block_index, to_entry_index, to_dir_utf8)
 
796
                        to_block = state._dirblocks[to_block_index]
 
797
                        for entry in from_block[1]:
 
798
                            assert entry[0][0] == from_dir
 
799
                            cur_details = entry[1][0]
 
800
                            to_key = (to_dir_utf8, entry[0][1], entry[0][2])
 
801
                            from_path_utf8 = osutils.pathjoin(entry[0][0], entry[0][1])
 
802
                            to_path_utf8 = osutils.pathjoin(to_dir_utf8, entry[0][1])
 
803
                            minikind = cur_details[0]
 
804
                            move_one(entry, from_path_utf8=from_path_utf8,
 
805
                                     minikind=minikind,
 
806
                                     executable=cur_details[3],
 
807
                                     fingerprint=cur_details[1],
 
808
                                     packed_stat=cur_details[4],
 
809
                                     size=cur_details[2],
 
810
                                     to_block=to_block,
 
811
                                     to_key=to_key,
 
812
                                     to_path_utf8=to_rel_utf8)
 
813
                            if minikind == 'd':
 
814
                                # We need to move all the children of this
 
815
                                # entry
 
816
                                update_dirblock(from_path_utf8, to_key,
 
817
                                                to_path_utf8)
 
818
                    update_dirblock(from_rel_utf8, to_key, to_rel_utf8)
 
819
            except:
 
820
                rollback_rename()
 
821
                raise
 
822
            result.append((from_rel, to_rel))
 
823
            state._dirblock_state = dirstate.DirState.IN_MEMORY_MODIFIED
 
824
            self._make_dirty(reset_inventory=False)
 
825
 
 
826
        return result
 
827
 
 
828
    def _must_be_locked(self):
 
829
        if not self._control_files._lock_count:
 
830
            raise errors.ObjectNotLocked(self)
 
831
 
 
832
    def _new_tree(self):
 
833
        """Initialize the state in this tree to be a new tree."""
 
834
        self._dirty = True
 
835
 
 
836
    @needs_read_lock
 
837
    def path2id(self, path):
 
838
        """Return the id for path in this tree."""
 
839
        path = path.strip('/')
 
840
        entry = self._get_entry(path=path)
 
841
        if entry == (None, None):
 
842
            return None
 
843
        return entry[0][2]
 
844
 
 
845
    def paths2ids(self, paths, trees=[], require_versioned=True):
 
846
        """See Tree.paths2ids().
 
847
 
 
848
        This specialisation fast-paths the case where all the trees are in the
 
849
        dirstate.
 
850
        """
 
851
        if paths is None:
 
852
            return None
 
853
        parents = self.get_parent_ids()
 
854
        for tree in trees:
 
855
            if not (isinstance(tree, DirStateRevisionTree) and tree._revision_id in
 
856
                parents):
 
857
                return super(WorkingTree4, self).paths2ids(paths, trees, require_versioned)
 
858
        search_indexes = [0] + [1 + parents.index(tree._revision_id) for tree in trees]
 
859
        # -- make all paths utf8 --
 
860
        paths_utf8 = set()
 
861
        for path in paths:
 
862
            paths_utf8.add(path.encode('utf8'))
 
863
        paths = paths_utf8
 
864
        # -- paths is now a utf8 path set --
 
865
        # -- get the state object and prepare it.
 
866
        state = self.current_dirstate()
 
867
        if False and (state._dirblock_state == dirstate.DirState.NOT_IN_MEMORY
 
868
            and '' not in paths):
 
869
            paths2ids = self._paths2ids_using_bisect
 
870
        else:
 
871
            paths2ids = self._paths2ids_in_memory
 
872
        return paths2ids(paths, search_indexes,
 
873
                         require_versioned=require_versioned)
 
874
 
 
875
    def _paths2ids_in_memory(self, paths, search_indexes,
 
876
                             require_versioned=True):
 
877
        state = self.current_dirstate()
 
878
        state._read_dirblocks_if_needed()
 
879
        def _entries_for_path(path):
 
880
            """Return a list with all the entries that match path for all ids.
 
881
            """
 
882
            dirname, basename = os.path.split(path)
 
883
            key = (dirname, basename, '')
 
884
            block_index, present = state._find_block_index_from_key(key)
 
885
            if not present:
 
886
                # the block which should contain path is absent.
 
887
                return []
 
888
            result = []
 
889
            block = state._dirblocks[block_index][1]
 
890
            entry_index, _ = state._find_entry_index(key, block)
 
891
            # we may need to look at multiple entries at this path: walk while the paths match.
 
892
            while (entry_index < len(block) and
 
893
                block[entry_index][0][0:2] == key[0:2]):
 
894
                result.append(block[entry_index])
 
895
                entry_index += 1
 
896
            return result
 
897
        if require_versioned:
 
898
            # -- check all supplied paths are versioned in a search tree. --
 
899
            all_versioned = True
 
900
            for path in paths:
 
901
                path_entries = _entries_for_path(path)
 
902
                if not path_entries:
 
903
                    # this specified path is not present at all: error
 
904
                    all_versioned = False
 
905
                    break
 
906
                found_versioned = False
 
907
                # for each id at this path
 
908
                for entry in path_entries:
 
909
                    # for each tree.
 
910
                    for index in search_indexes:
 
911
                        if entry[1][index][0] != 'a': # absent
 
912
                            found_versioned = True
 
913
                            # all good: found a versioned cell
 
914
                            break
 
915
                if not found_versioned:
 
916
                    # none of the indexes was not 'absent' at all ids for this
 
917
                    # path.
 
918
                    all_versioned = False
 
919
                    break
 
920
            if not all_versioned:
 
921
                raise errors.PathsNotVersionedError(paths)
 
922
        # -- remove redundancy in supplied paths to prevent over-scanning --
 
923
        search_paths = set()
 
924
        for path in paths:
 
925
            other_paths = paths.difference(set([path]))
 
926
            if not osutils.is_inside_any(other_paths, path):
 
927
                # this is a top level path, we must check it.
 
928
                search_paths.add(path)
 
929
        # sketch: 
 
930
        # for all search_indexs in each path at or under each element of
 
931
        # search_paths, if the detail is relocated: add the id, and add the
 
932
        # relocated path as one to search if its not searched already. If the
 
933
        # detail is not relocated, add the id.
 
934
        searched_paths = set()
 
935
        found_ids = set()
 
936
        def _process_entry(entry):
 
937
            """Look at search_indexes within entry.
 
938
 
 
939
            If a specific tree's details are relocated, add the relocation
 
940
            target to search_paths if not searched already. If it is absent, do
 
941
            nothing. Otherwise add the id to found_ids.
 
942
            """
 
943
            for index in search_indexes:
 
944
                if entry[1][index][0] == 'r': # relocated
 
945
                    if not osutils.is_inside_any(searched_paths, entry[1][index][1]):
 
946
                        search_paths.add(entry[1][index][1])
 
947
                elif entry[1][index][0] != 'a': # absent
 
948
                    found_ids.add(entry[0][2])
 
949
        while search_paths:
 
950
            current_root = search_paths.pop()
 
951
            searched_paths.add(current_root)
 
952
            # process the entries for this containing directory: the rest will be
 
953
            # found by their parents recursively.
 
954
            root_entries = _entries_for_path(current_root)
 
955
            if not root_entries:
 
956
                # this specified path is not present at all, skip it.
 
957
                continue
 
958
            for entry in root_entries:
 
959
                _process_entry(entry)
 
960
            initial_key = (current_root, '', '')
 
961
            block_index, _ = state._find_block_index_from_key(initial_key)
 
962
            while (block_index < len(state._dirblocks) and
 
963
                osutils.is_inside(current_root, state._dirblocks[block_index][0])):
 
964
                for entry in state._dirblocks[block_index][1]:
 
965
                    _process_entry(entry)
 
966
                block_index += 1
 
967
        return found_ids
 
968
 
 
969
    def _paths2ids_using_bisect(self, paths, search_indexes,
 
970
                                require_versioned=True):
 
971
        state = self.current_dirstate()
 
972
        found_ids = set()
 
973
 
 
974
        split_paths = sorted(osutils.split(p) for p in paths)
 
975
        found = state._bisect_recursive(split_paths)
 
976
 
 
977
        if require_versioned:
 
978
            found_dir_names = set(dir_name_id[:2] for dir_name_id in found)
 
979
            for dir_name in split_paths:
 
980
                if dir_name not in found_dir_names:
 
981
                    raise errors.PathsNotVersionedError(paths)
 
982
 
 
983
        for dir_name_id, trees_info in found.iteritems():
 
984
            for index in search_indexes:
 
985
                if trees_info[index][0] not in ('r', 'a'):
 
986
                    found_ids.add(dir_name_id[2])
 
987
        return found_ids
 
988
 
 
989
    def read_working_inventory(self):
 
990
        """Read the working inventory.
 
991
        
 
992
        This is a meaningless operation for dirstate, but we obey it anyhow.
 
993
        """
 
994
        return self.inventory
 
995
 
 
996
    @needs_read_lock
 
997
    def revision_tree(self, revision_id):
 
998
        """See Tree.revision_tree.
 
999
 
 
1000
        WorkingTree4 supplies revision_trees for any basis tree.
 
1001
        """
 
1002
        revision_id = osutils.safe_revision_id(revision_id)
 
1003
        dirstate = self.current_dirstate()
 
1004
        parent_ids = dirstate.get_parent_ids()
 
1005
        if revision_id not in parent_ids:
 
1006
            raise errors.NoSuchRevisionInTree(self, revision_id)
 
1007
        if revision_id in dirstate.get_ghosts():
 
1008
            raise errors.NoSuchRevisionInTree(self, revision_id)
 
1009
        return DirStateRevisionTree(dirstate, revision_id,
 
1010
            self.branch.repository)
 
1011
 
 
1012
    @needs_tree_write_lock
 
1013
    def set_last_revision(self, new_revision):
 
1014
        """Change the last revision in the working tree."""
 
1015
        new_revision = osutils.safe_revision_id(new_revision)
 
1016
        parents = self.get_parent_ids()
 
1017
        if new_revision in (NULL_REVISION, None):
 
1018
            assert len(parents) < 2, (
 
1019
                "setting the last parent to none with a pending merge is "
 
1020
                "unsupported.")
 
1021
            self.set_parent_ids([])
 
1022
        else:
 
1023
            self.set_parent_ids([new_revision] + parents[1:],
 
1024
                allow_leftmost_as_ghost=True)
 
1025
 
 
1026
    @needs_tree_write_lock
 
1027
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
 
1028
        """Set the parent ids to revision_ids.
 
1029
        
 
1030
        See also set_parent_trees. This api will try to retrieve the tree data
 
1031
        for each element of revision_ids from the trees repository. If you have
 
1032
        tree data already available, it is more efficient to use
 
1033
        set_parent_trees rather than set_parent_ids. set_parent_ids is however
 
1034
        an easier API to use.
 
1035
 
 
1036
        :param revision_ids: The revision_ids to set as the parent ids of this
 
1037
            working tree. Any of these may be ghosts.
 
1038
        """
 
1039
        revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
 
1040
        trees = []
 
1041
        for revision_id in revision_ids:
 
1042
            try:
 
1043
                revtree = self.branch.repository.revision_tree(revision_id)
 
1044
                # TODO: jam 20070213 KnitVersionedFile raises
 
1045
                #       RevisionNotPresent rather than NoSuchRevision if a
 
1046
                #       given revision_id is not present. Should Repository be
 
1047
                #       catching it and re-raising NoSuchRevision?
 
1048
            except (errors.NoSuchRevision, errors.RevisionNotPresent):
 
1049
                revtree = None
 
1050
            trees.append((revision_id, revtree))
 
1051
        self.current_dirstate()._validate()
 
1052
        self.set_parent_trees(trees,
 
1053
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
1054
        self.current_dirstate()._validate()
 
1055
 
 
1056
    @needs_tree_write_lock
 
1057
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
 
1058
        """Set the parents of the working tree.
 
1059
 
 
1060
        :param parents_list: A list of (revision_id, tree) tuples.
 
1061
            If tree is None, then that element is treated as an unreachable
 
1062
            parent tree - i.e. a ghost.
 
1063
        """
 
1064
        dirstate = self.current_dirstate()
 
1065
        dirstate._validate()
 
1066
        if len(parents_list) > 0:
 
1067
            if not allow_leftmost_as_ghost and parents_list[0][1] is None:
 
1068
                raise errors.GhostRevisionUnusableHere(parents_list[0][0])
 
1069
        real_trees = []
 
1070
        ghosts = []
 
1071
        # convert absent trees to the null tree, which we convert back to
 
1072
        # missing on access.
 
1073
        for rev_id, tree in parents_list:
 
1074
            rev_id = osutils.safe_revision_id(rev_id)
 
1075
            if tree is not None:
 
1076
                real_trees.append((rev_id, tree))
 
1077
            else:
 
1078
                real_trees.append((rev_id,
 
1079
                    self.branch.repository.revision_tree(None)))
 
1080
                ghosts.append(rev_id)
 
1081
        dirstate._validate()
 
1082
        dirstate.set_parent_trees(real_trees, ghosts=ghosts)
 
1083
        dirstate._validate()
 
1084
        self._make_dirty(reset_inventory=False)
 
1085
        dirstate._validate()
 
1086
 
 
1087
    def _set_root_id(self, file_id):
 
1088
        """See WorkingTree.set_root_id."""
 
1089
        state = self.current_dirstate()
 
1090
        state.set_path_id('', file_id)
 
1091
        if state._dirblock_state == dirstate.DirState.IN_MEMORY_MODIFIED:
 
1092
            self._make_dirty(reset_inventory=True)
 
1093
 
 
1094
    @needs_read_lock
 
1095
    def supports_tree_reference(self):
 
1096
        return self._repo_supports_tree_reference
 
1097
 
 
1098
    def unlock(self):
 
1099
        """Unlock in format 4 trees needs to write the entire dirstate."""
 
1100
        if self._control_files._lock_count == 1:
 
1101
            # eventually we should do signature checking during read locks for
 
1102
            # dirstate updates.
 
1103
            if self._control_files._lock_mode == 'w':
 
1104
                if self._dirty:
 
1105
                    self.flush()
 
1106
            if self._dirstate is not None:
 
1107
                # This is a no-op if there are no modifications.
 
1108
                self._dirstate.save()
 
1109
                self._dirstate.unlock()
 
1110
            # TODO: jam 20070301 We shouldn't have to wipe the dirstate at this
 
1111
            #       point. Instead, it could check if the header has been
 
1112
            #       modified when it is locked, and if not, it can hang on to
 
1113
            #       the data it has in memory.
 
1114
            self._dirstate = None
 
1115
            self._inventory = None
 
1116
        # reverse order of locking.
 
1117
        try:
 
1118
            return self._control_files.unlock()
 
1119
        finally:
 
1120
            self.branch.unlock()
 
1121
 
 
1122
    @needs_tree_write_lock
 
1123
    def unversion(self, file_ids):
 
1124
        """Remove the file ids in file_ids from the current versioned set.
 
1125
 
 
1126
        When a file_id is unversioned, all of its children are automatically
 
1127
        unversioned.
 
1128
 
 
1129
        :param file_ids: The file ids to stop versioning.
 
1130
        :raises: NoSuchId if any fileid is not currently versioned.
 
1131
        """
 
1132
        if not file_ids:
 
1133
            return
 
1134
        state = self.current_dirstate()
 
1135
        state._read_dirblocks_if_needed()
 
1136
        ids_to_unversion = set()
 
1137
        for file_id in file_ids:
 
1138
            ids_to_unversion.add(osutils.safe_file_id(file_id))
 
1139
        paths_to_unversion = set()
 
1140
        # sketch:
 
1141
        # check if the root is to be unversioned, if so, assert for now.
 
1142
        # walk the state marking unversioned things as absent.
 
1143
        # if there are any un-unversioned ids at the end, raise
 
1144
        for key, details in state._dirblocks[0][1]:
 
1145
            if (details[0][0] not in ('a', 'r') and # absent or relocated
 
1146
                key[2] in ids_to_unversion):
 
1147
                # I haven't written the code to unversion / yet - it should be
 
1148
                # supported.
 
1149
                raise errors.BzrError('Unversioning the / is not currently supported')
 
1150
        block_index = 0
 
1151
        while block_index < len(state._dirblocks):
 
1152
            # process one directory at a time.
 
1153
            block = state._dirblocks[block_index]
 
1154
            # first check: is the path one to remove - it or its children
 
1155
            delete_block = False
 
1156
            for path in paths_to_unversion:
 
1157
                if (block[0].startswith(path) and
 
1158
                    (len(block[0]) == len(path) or
 
1159
                     block[0][len(path)] == '/')):
 
1160
                    # this entire block should be deleted - its the block for a
 
1161
                    # path to unversion; or the child of one
 
1162
                    delete_block = True
 
1163
                    break
 
1164
            # TODO: trim paths_to_unversion as we pass by paths
 
1165
            if delete_block:
 
1166
                # this block is to be deleted: process it.
 
1167
                # TODO: we can special case the no-parents case and
 
1168
                # just forget the whole block.
 
1169
                entry_index = 0
 
1170
                while entry_index < len(block[1]):
 
1171
                    # Mark this file id as having been removed
 
1172
                    entry = block[1][entry_index]
 
1173
                    ids_to_unversion.discard(entry[0][2])
 
1174
                    if (entry[1][0][0] == 'a'
 
1175
                        or not state._make_absent(entry)):
 
1176
                        entry_index += 1
 
1177
                # go to the next block. (At the moment we dont delete empty
 
1178
                # dirblocks)
 
1179
                block_index += 1
 
1180
                continue
 
1181
            entry_index = 0
 
1182
            while entry_index < len(block[1]):
 
1183
                entry = block[1][entry_index]
 
1184
                if (entry[1][0][0] in ('a', 'r') or # absent, relocated
 
1185
                    # ^ some parent row.
 
1186
                    entry[0][2] not in ids_to_unversion):
 
1187
                    # ^ not an id to unversion
 
1188
                    entry_index += 1
 
1189
                    continue
 
1190
                if entry[1][0][0] == 'd':
 
1191
                    paths_to_unversion.add(pathjoin(entry[0][0], entry[0][1]))
 
1192
                if not state._make_absent(entry):
 
1193
                    entry_index += 1
 
1194
                # we have unversioned this id
 
1195
                ids_to_unversion.remove(entry[0][2])
 
1196
            block_index += 1
 
1197
        if ids_to_unversion:
 
1198
            raise errors.NoSuchId(self, iter(ids_to_unversion).next())
 
1199
        self._make_dirty(reset_inventory=False)
 
1200
        # have to change the legacy inventory too.
 
1201
        if self._inventory is not None:
 
1202
            for file_id in file_ids:
 
1203
                self._inventory.remove_recursive_id(file_id)
 
1204
 
 
1205
    @needs_tree_write_lock
 
1206
    def _write_inventory(self, inv):
 
1207
        """Write inventory as the current inventory."""
 
1208
        assert not self._dirty, "attempting to write an inventory when the dirstate is dirty will cause data loss"
 
1209
        self.current_dirstate().set_state_from_inventory(inv)
 
1210
        self._make_dirty(reset_inventory=False)
 
1211
        if self._inventory is not None:
 
1212
            self._inventory = inv
 
1213
        self.flush()
 
1214
 
 
1215
 
 
1216
class WorkingTreeFormat4(WorkingTreeFormat3):
 
1217
    """The first consolidated dirstate working tree format.
 
1218
 
 
1219
    This format:
 
1220
        - exists within a metadir controlling .bzr
 
1221
        - includes an explicit version marker for the workingtree control
 
1222
          files, separate from the BzrDir format
 
1223
        - modifies the hash cache format
 
1224
        - is new in bzr 0.15
 
1225
        - uses a LockDir to guard access to it.
 
1226
    """
 
1227
 
 
1228
    def get_format_string(self):
 
1229
        """See WorkingTreeFormat.get_format_string()."""
 
1230
        return "Bazaar Working Tree Format 4 (bzr 0.15)\n"
 
1231
 
 
1232
    def get_format_description(self):
 
1233
        """See WorkingTreeFormat.get_format_description()."""
 
1234
        return "Working tree format 4"
 
1235
 
 
1236
    def initialize(self, a_bzrdir, revision_id=None):
 
1237
        """See WorkingTreeFormat.initialize().
 
1238
 
 
1239
        :param revision_id: allows creating a working tree at a different
 
1240
        revision than the branch is at.
 
1241
 
 
1242
        These trees get an initial random root id.
 
1243
        """
 
1244
        revision_id = osutils.safe_revision_id(revision_id)
 
1245
        if not isinstance(a_bzrdir.transport, LocalTransport):
 
1246
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
 
1247
        transport = a_bzrdir.get_workingtree_transport(self)
 
1248
        control_files = self._open_control_files(a_bzrdir)
 
1249
        control_files.create_lock()
 
1250
        control_files.lock_write()
 
1251
        control_files.put_utf8('format', self.get_format_string())
 
1252
        branch = a_bzrdir.open_branch()
 
1253
        if revision_id is None:
 
1254
            revision_id = branch.last_revision()
 
1255
        local_path = transport.local_abspath('dirstate')
 
1256
        # write out new dirstate (must exist when we create the tree)
 
1257
        state = dirstate.DirState.initialize(local_path)
 
1258
        state.unlock()
 
1259
        wt = WorkingTree4(a_bzrdir.root_transport.local_abspath('.'),
 
1260
                         branch,
 
1261
                         _format=self,
 
1262
                         _bzrdir=a_bzrdir,
 
1263
                         _control_files=control_files)
 
1264
        wt._new_tree()
 
1265
        wt.lock_tree_write()
 
1266
        state._validate()
 
1267
        try:
 
1268
            if revision_id in (None, NULL_REVISION):
 
1269
                wt._set_root_id(generate_ids.gen_root_id())
 
1270
                wt.flush()
 
1271
                wt.current_dirstate()._validate()
 
1272
            wt.set_last_revision(revision_id)
 
1273
            wt.flush()
 
1274
            basis = wt.basis_tree()
 
1275
            basis.lock_read()
 
1276
            # if the basis has a root id we have to use that; otherwise we use
 
1277
            # a new random one
 
1278
            basis_root_id = basis.get_root_id()
 
1279
            if basis_root_id is not None:
 
1280
                wt._set_root_id(basis_root_id)
 
1281
                wt.flush()
 
1282
            transform.build_tree(basis, wt)
 
1283
            basis.unlock()
 
1284
        finally:
 
1285
            control_files.unlock()
 
1286
            wt.unlock()
 
1287
        return wt
 
1288
 
 
1289
    def _open(self, a_bzrdir, control_files):
 
1290
        """Open the tree itself.
 
1291
 
 
1292
        :param a_bzrdir: the dir for the tree.
 
1293
        :param control_files: the control files for the tree.
 
1294
        """
 
1295
        return WorkingTree4(a_bzrdir.root_transport.local_abspath('.'),
 
1296
                           branch=a_bzrdir.open_branch(),
 
1297
                           _format=self,
 
1298
                           _bzrdir=a_bzrdir,
 
1299
                           _control_files=control_files)
 
1300
 
 
1301
    def __get_matchingbzrdir(self):
 
1302
        # please test against something that will let us do tree references
 
1303
        return bzrdir.format_registry.make_bzrdir(
 
1304
            'dirstate-with-subtree')
 
1305
 
 
1306
    _matchingbzrdir = property(__get_matchingbzrdir)
 
1307
 
 
1308
 
 
1309
class DirStateRevisionTree(Tree):
 
1310
    """A revision tree pulling the inventory from a dirstate."""
 
1311
 
 
1312
    def __init__(self, dirstate, revision_id, repository):
 
1313
        self._dirstate = dirstate
 
1314
        self._revision_id = osutils.safe_revision_id(revision_id)
 
1315
        self._repository = repository
 
1316
        self._inventory = None
 
1317
        self._locked = 0
 
1318
        self._dirstate_locked = False
 
1319
 
 
1320
    def __repr__(self):
 
1321
        return "<%s of %s in %s>" % \
 
1322
            (self.__class__.__name__, self._revision_id, self._dirstate)
 
1323
 
 
1324
    def annotate_iter(self, file_id):
 
1325
        """See Tree.annotate_iter"""
 
1326
        w = self._repository.weave_store.get_weave(file_id,
 
1327
                           self._repository.get_transaction())
 
1328
        return w.annotate_iter(self.inventory[file_id].revision)
 
1329
 
 
1330
    def _comparison_data(self, entry, path):
 
1331
        """See Tree._comparison_data."""
 
1332
        if entry is None:
 
1333
            return None, False, None
 
1334
        # trust the entry as RevisionTree does, but this may not be
 
1335
        # sensible: the entry might not have come from us?
 
1336
        return entry.kind, entry.executable, None
 
1337
 
 
1338
    def _file_size(self, entry, stat_value):
 
1339
        return entry.text_size
 
1340
 
 
1341
    def filter_unversioned_files(self, paths):
 
1342
        """Filter out paths that are not versioned.
 
1343
 
 
1344
        :return: set of paths.
 
1345
        """
 
1346
        pred = self.has_filename
 
1347
        return set((p for p in paths if not pred(p)))
 
1348
 
 
1349
    def get_root_id(self):
 
1350
        return self.path2id('')
 
1351
 
 
1352
    def _get_parent_index(self):
 
1353
        """Return the index in the dirstate referenced by this tree."""
 
1354
        return self._dirstate.get_parent_ids().index(self._revision_id) + 1
 
1355
 
 
1356
    def _get_entry(self, file_id=None, path=None):
 
1357
        """Get the dirstate row for file_id or path.
 
1358
 
 
1359
        If either file_id or path is supplied, it is used as the key to lookup.
 
1360
        If both are supplied, the fastest lookup is used, and an error is
 
1361
        raised if they do not both point at the same row.
 
1362
        
 
1363
        :param file_id: An optional unicode file_id to be looked up.
 
1364
        :param path: An optional unicode path to be looked up.
 
1365
        :return: The dirstate row tuple for path/file_id, or (None, None)
 
1366
        """
 
1367
        if file_id is None and path is None:
 
1368
            raise errors.BzrError('must supply file_id or path')
 
1369
        file_id = osutils.safe_file_id(file_id)
 
1370
        if path is not None:
 
1371
            path = path.encode('utf8')
 
1372
        parent_index = self._get_parent_index()
 
1373
        return self._dirstate._get_entry(parent_index, fileid_utf8=file_id, path_utf8=path)
 
1374
 
 
1375
    def _generate_inventory(self):
 
1376
        """Create and set self.inventory from the dirstate object.
 
1377
 
 
1378
        (So this is only called the first time the inventory is requested for
 
1379
        this tree; it then remains in memory until it's out of date.)
 
1380
 
 
1381
        This is relatively expensive: we have to walk the entire dirstate.
 
1382
        """
 
1383
        assert self._locked, 'cannot generate inventory of an unlocked '\
 
1384
            'dirstate revision tree'
 
1385
        # separate call for profiling - makes it clear where the costs are.
 
1386
        self._dirstate._read_dirblocks_if_needed()
 
1387
        assert self._revision_id in self._dirstate.get_parent_ids(), \
 
1388
            'parent %s has disappeared from %s' % (
 
1389
            self._revision_id, self._dirstate.get_parent_ids())
 
1390
        parent_index = self._dirstate.get_parent_ids().index(self._revision_id) + 1
 
1391
        # This is identical now to the WorkingTree _generate_inventory except
 
1392
        # for the tree index use.
 
1393
        root_key, current_entry = self._dirstate._get_entry(parent_index, path_utf8='')
 
1394
        current_id = root_key[2]
 
1395
        assert current_entry[parent_index][0] == 'd'
 
1396
        inv = Inventory(root_id=current_id, revision_id=self._revision_id)
 
1397
        inv.root.revision = current_entry[parent_index][4]
 
1398
        # Turn some things into local variables
 
1399
        minikind_to_kind = dirstate.DirState._minikind_to_kind
 
1400
        factory = entry_factory
 
1401
        utf8_decode = cache_utf8._utf8_decode
 
1402
        inv_byid = inv._byid
 
1403
        # we could do this straight out of the dirstate; it might be fast
 
1404
        # and should be profiled - RBC 20070216
 
1405
        parent_ies = {'' : inv.root}
 
1406
        for block in self._dirstate._dirblocks[1:]: #skip root
 
1407
            dirname = block[0]
 
1408
            try:
 
1409
                parent_ie = parent_ies[dirname]
 
1410
            except KeyError:
 
1411
                # all the paths in this block are not versioned in this tree
 
1412
                continue
 
1413
            for key, entry in block[1]:
 
1414
                minikind, fingerprint, size, executable, revid = entry[parent_index]
 
1415
                if minikind in ('a', 'r'): # absent, relocated
 
1416
                    # not this tree
 
1417
                    continue
 
1418
                name = key[1]
 
1419
                name_unicode = utf8_decode(name)[0]
 
1420
                file_id = key[2]
 
1421
                kind = minikind_to_kind[minikind]
 
1422
                inv_entry = factory[kind](file_id, name_unicode,
 
1423
                                          parent_ie.file_id)
 
1424
                inv_entry.revision = revid
 
1425
                if kind == 'file':
 
1426
                    inv_entry.executable = executable
 
1427
                    inv_entry.text_size = size
 
1428
                    inv_entry.text_sha1 = fingerprint
 
1429
                elif kind == 'directory':
 
1430
                    parent_ies[(dirname + '/' + name).strip('/')] = inv_entry
 
1431
                elif kind == 'symlink':
 
1432
                    inv_entry.executable = False
 
1433
                    inv_entry.text_size = None
 
1434
                    inv_entry.symlink_target = utf8_decode(fingerprint)[0]
 
1435
                elif kind == 'tree-reference':
 
1436
                    inv_entry.reference_revision = fingerprint or None
 
1437
                else:
 
1438
                    raise AssertionError("cannot convert entry %r into an InventoryEntry"
 
1439
                            % entry)
 
1440
                # These checks cost us around 40ms on a 55k entry tree
 
1441
                assert file_id not in inv_byid
 
1442
                assert name_unicode not in parent_ie.children
 
1443
                inv_byid[file_id] = inv_entry
 
1444
                parent_ie.children[name_unicode] = inv_entry
 
1445
        self._inventory = inv
 
1446
 
 
1447
    def get_file_mtime(self, file_id, path=None):
 
1448
        """Return the modification time for this record.
 
1449
 
 
1450
        We return the timestamp of the last-changed revision.
 
1451
        """
 
1452
        # Make sure the file exists
 
1453
        entry = self._get_entry(file_id, path=path)
 
1454
        if entry == (None, None): # do we raise?
 
1455
            return None
 
1456
        parent_index = self._get_parent_index()
 
1457
        last_changed_revision = entry[1][parent_index][4]
 
1458
        return self._repository.get_revision(last_changed_revision).timestamp
 
1459
 
 
1460
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
1461
        entry = self._get_entry(file_id=file_id, path=path)
 
1462
        parent_index = self._get_parent_index()
 
1463
        parent_details = entry[1][parent_index]
 
1464
        if parent_details[0] == 'f':
 
1465
            return parent_details[1]
 
1466
        return None
 
1467
 
 
1468
    def get_file(self, file_id):
 
1469
        return StringIO(self.get_file_text(file_id))
 
1470
 
 
1471
    def get_file_lines(self, file_id):
 
1472
        ie = self.inventory[file_id]
 
1473
        return self._repository.weave_store.get_weave(file_id,
 
1474
                self._repository.get_transaction()).get_lines(ie.revision)
 
1475
 
 
1476
    def get_file_size(self, file_id):
 
1477
        return self.inventory[file_id].text_size
 
1478
 
 
1479
    def get_file_text(self, file_id):
 
1480
        return ''.join(self.get_file_lines(file_id))
 
1481
 
 
1482
    def get_reference_revision(self, file_id, path=None):
 
1483
        return self.inventory[file_id].reference_revision
 
1484
 
 
1485
    def get_symlink_target(self, file_id):
 
1486
        entry = self._get_entry(file_id=file_id)
 
1487
        parent_index = self._get_parent_index()
 
1488
        if entry[1][parent_index][0] != 'l':
 
1489
            return None
 
1490
        else:
 
1491
            # At present, none of the tree implementations supports non-ascii
 
1492
            # symlink targets. So we will just assume that the dirstate path is
 
1493
            # correct.
 
1494
            return entry[1][parent_index][1]
 
1495
 
 
1496
    def get_revision_id(self):
 
1497
        """Return the revision id for this tree."""
 
1498
        return self._revision_id
 
1499
 
 
1500
    def _get_inventory(self):
 
1501
        if self._inventory is not None:
 
1502
            return self._inventory
 
1503
        self._must_be_locked()
 
1504
        self._generate_inventory()
 
1505
        return self._inventory
 
1506
 
 
1507
    inventory = property(_get_inventory,
 
1508
                         doc="Inventory of this Tree")
 
1509
 
 
1510
    def get_parent_ids(self):
 
1511
        """The parents of a tree in the dirstate are not cached."""
 
1512
        return self._repository.get_revision(self._revision_id).parent_ids
 
1513
 
 
1514
    def has_filename(self, filename):
 
1515
        return bool(self.path2id(filename))
 
1516
 
 
1517
    def kind(self, file_id):
 
1518
        return self.inventory[file_id].kind
 
1519
 
 
1520
    def is_executable(self, file_id, path=None):
 
1521
        ie = self.inventory[file_id]
 
1522
        if ie.kind != "file":
 
1523
            return None
 
1524
        return ie.executable
 
1525
 
 
1526
    def list_files(self, include_root=False):
 
1527
        # We use a standard implementation, because DirStateRevisionTree is
 
1528
        # dealing with one of the parents of the current state
 
1529
        inv = self._get_inventory()
 
1530
        entries = inv.iter_entries()
 
1531
        if self.inventory.root is not None and not include_root:
 
1532
            entries.next()
 
1533
        for path, entry in entries:
 
1534
            yield path, 'V', entry.kind, entry.file_id, entry
 
1535
 
 
1536
    def lock_read(self):
 
1537
        """Lock the tree for a set of operations."""
 
1538
        if not self._locked:
 
1539
            self._repository.lock_read()
 
1540
            if self._dirstate._lock_token is None:
 
1541
                self._dirstate.lock_read()
 
1542
                self._dirstate_locked = True
 
1543
        self._locked += 1
 
1544
 
 
1545
    def _must_be_locked(self):
 
1546
        if not self._locked:
 
1547
            raise errors.ObjectNotLocked(self)
 
1548
 
 
1549
    @needs_read_lock
 
1550
    def path2id(self, path):
 
1551
        """Return the id for path in this tree."""
 
1552
        # lookup by path: faster than splitting and walking the ivnentory.
 
1553
        entry = self._get_entry(path=path)
 
1554
        if entry == (None, None):
 
1555
            return None
 
1556
        return entry[0][2]
 
1557
 
 
1558
    def unlock(self):
 
1559
        """Unlock, freeing any cache memory used during the lock."""
 
1560
        # outside of a lock, the inventory is suspect: release it.
 
1561
        self._locked -=1
 
1562
        if not self._locked:
 
1563
            self._inventory = None
 
1564
            self._locked = 0
 
1565
            if self._dirstate_locked:
 
1566
                self._dirstate.unlock()
 
1567
                self._dirstate_locked = False
 
1568
            self._repository.unlock()
 
1569
 
 
1570
    def walkdirs(self, prefix=""):
 
1571
        # TODO: jam 20070215 This is the lazy way by using the RevisionTree
 
1572
        # implementation based on an inventory.  
 
1573
        # This should be cleaned up to use the much faster Dirstate code
 
1574
        # So for now, we just build up the parent inventory, and extract
 
1575
        # it the same way RevisionTree does.
 
1576
        _directory = 'directory'
 
1577
        inv = self._get_inventory()
 
1578
        top_id = inv.path2id(prefix)
 
1579
        if top_id is None:
 
1580
            pending = []
 
1581
        else:
 
1582
            pending = [(prefix, top_id)]
 
1583
        while pending:
 
1584
            dirblock = []
 
1585
            relpath, file_id = pending.pop()
 
1586
            # 0 - relpath, 1- file-id
 
1587
            if relpath:
 
1588
                relroot = relpath + '/'
 
1589
            else:
 
1590
                relroot = ""
 
1591
            # FIXME: stash the node in pending
 
1592
            entry = inv[file_id]
 
1593
            for name, child in entry.sorted_children():
 
1594
                toppath = relroot + name
 
1595
                dirblock.append((toppath, name, child.kind, None,
 
1596
                    child.file_id, child.kind
 
1597
                    ))
 
1598
            yield (relpath, entry.file_id), dirblock
 
1599
            # push the user specified dirs from dirblock
 
1600
            for dir in reversed(dirblock):
 
1601
                if dir[2] == _directory:
 
1602
                    pending.append((dir[0], dir[4]))
 
1603
 
 
1604
 
 
1605
class InterDirStateTree(InterTree):
 
1606
    """Fast path optimiser for changes_from with dirstate trees.
 
1607
    
 
1608
    This is used only when both trees are in the dirstate working file, and 
 
1609
    the source is any parent within the dirstate, and the destination is 
 
1610
    the current working tree of the same dirstate.
 
1611
    """
 
1612
    # this could be generalized to allow comparisons between any trees in the
 
1613
    # dirstate, and possibly between trees stored in different dirstates.
 
1614
 
 
1615
    def __init__(self, source, target):
 
1616
        super(InterDirStateTree, self).__init__(source, target)
 
1617
        if not InterDirStateTree.is_compatible(source, target):
 
1618
            raise Exception, "invalid source %r and target %r" % (source, target)
 
1619
 
 
1620
    @staticmethod
 
1621
    def make_source_parent_tree(source, target):
 
1622
        """Change the source tree into a parent of the target."""
 
1623
        revid = source.commit('record tree')
 
1624
        target.branch.repository.fetch(source.branch.repository, revid)
 
1625
        target.set_parent_ids([revid])
 
1626
        return target.basis_tree(), target
 
1627
 
 
1628
    _matching_from_tree_format = WorkingTreeFormat4()
 
1629
    _matching_to_tree_format = WorkingTreeFormat4()
 
1630
    _test_mutable_trees_to_test_trees = make_source_parent_tree
 
1631
 
 
1632
    def _iter_changes(self, include_unchanged=False,
 
1633
                      specific_files=None, pb=None, extra_trees=[],
 
1634
                      require_versioned=True, want_unversioned=False):
 
1635
        """Return the changes from source to target.
 
1636
 
 
1637
        :return: An iterator that yields tuples. See InterTree._iter_changes
 
1638
            for details.
 
1639
        :param specific_files: An optional list of file paths to restrict the
 
1640
            comparison to. When mapping filenames to ids, all matches in all
 
1641
            trees (including optional extra_trees) are used, and all children of
 
1642
            matched directories are included.
 
1643
        :param include_unchanged: An optional boolean requesting the inclusion of
 
1644
            unchanged entries in the result.
 
1645
        :param extra_trees: An optional list of additional trees to use when
 
1646
            mapping the contents of specific_files (paths) to file_ids.
 
1647
        :param require_versioned: If True, all files in specific_files must be
 
1648
            versioned in one of source, target, extra_trees or
 
1649
            PathsNotVersionedError is raised.
 
1650
        :param want_unversioned: Should unversioned files be returned in the
 
1651
            output. An unversioned file is defined as one with (False, False)
 
1652
            for the versioned pair.
 
1653
        """
 
1654
        utf8_decode_or_none = cache_utf8._utf8_decode_with_None
 
1655
        _minikind_to_kind = dirstate.DirState._minikind_to_kind
 
1656
        # NB: show_status depends on being able to pass in non-versioned files
 
1657
        # and report them as unknown
 
1658
        # TODO: handle extra trees in the dirstate.
 
1659
        # TODO: handle comparisons as an empty tree as a different special
 
1660
        # case? mbp 20070226
 
1661
        if extra_trees or (self.source._revision_id == NULL_REVISION):
 
1662
            # we can't fast-path these cases (yet)
 
1663
            for f in super(InterDirStateTree, self)._iter_changes(
 
1664
                include_unchanged, specific_files, pb, extra_trees,
 
1665
                require_versioned, want_unversioned=want_unversioned):
 
1666
                yield f
 
1667
            return
 
1668
        parent_ids = self.target.get_parent_ids()
 
1669
        assert (self.source._revision_id in parent_ids), \
 
1670
                "revision {%s} is not stored in {%s}, but %s " \
 
1671
                "can only be used for trees stored in the dirstate" \
 
1672
                % (self.source._revision_id, self.target, self._iter_changes)
 
1673
        target_index = 0
 
1674
        if self.source._revision_id == NULL_REVISION:
 
1675
            source_index = None
 
1676
            indices = (target_index,)
 
1677
        else:
 
1678
            assert (self.source._revision_id in parent_ids), \
 
1679
                "Failure: source._revision_id: %s not in target.parent_ids(%s)" % (
 
1680
                self.source._revision_id, parent_ids)
 
1681
            source_index = 1 + parent_ids.index(self.source._revision_id)
 
1682
            indices = (source_index,target_index)
 
1683
        # -- make all specific_files utf8 --
 
1684
        if specific_files:
 
1685
            specific_files_utf8 = set()
 
1686
            for path in specific_files:
 
1687
                specific_files_utf8.add(path.encode('utf8'))
 
1688
            specific_files = specific_files_utf8
 
1689
        else:
 
1690
            specific_files = set([''])
 
1691
        # -- specific_files is now a utf8 path set --
 
1692
        # -- get the state object and prepare it.
 
1693
        state = self.target.current_dirstate()
 
1694
        state._read_dirblocks_if_needed()
 
1695
        def _entries_for_path(path):
 
1696
            """Return a list with all the entries that match path for all ids.
 
1697
            """
 
1698
            dirname, basename = os.path.split(path)
 
1699
            key = (dirname, basename, '')
 
1700
            block_index, present = state._find_block_index_from_key(key)
 
1701
            if not present:
 
1702
                # the block which should contain path is absent.
 
1703
                return []
 
1704
            result = []
 
1705
            block = state._dirblocks[block_index][1]
 
1706
            entry_index, _ = state._find_entry_index(key, block)
 
1707
            # we may need to look at multiple entries at this path: walk while the specific_files match.
 
1708
            while (entry_index < len(block) and
 
1709
                block[entry_index][0][0:2] == key[0:2]):
 
1710
                result.append(block[entry_index])
 
1711
                entry_index += 1
 
1712
            return result
 
1713
        if require_versioned:
 
1714
            # -- check all supplied paths are versioned in a search tree. --
 
1715
            all_versioned = True
 
1716
            for path in specific_files:
 
1717
                path_entries = _entries_for_path(path)
 
1718
                if not path_entries:
 
1719
                    # this specified path is not present at all: error
 
1720
                    all_versioned = False
 
1721
                    break
 
1722
                found_versioned = False
 
1723
                # for each id at this path
 
1724
                for entry in path_entries:
 
1725
                    # for each tree.
 
1726
                    for index in indices:
 
1727
                        if entry[1][index][0] != 'a': # absent
 
1728
                            found_versioned = True
 
1729
                            # all good: found a versioned cell
 
1730
                            break
 
1731
                if not found_versioned:
 
1732
                    # none of the indexes was not 'absent' at all ids for this
 
1733
                    # path.
 
1734
                    all_versioned = False
 
1735
                    break
 
1736
            if not all_versioned:
 
1737
                raise errors.PathsNotVersionedError(specific_files)
 
1738
        # -- remove redundancy in supplied specific_files to prevent over-scanning --
 
1739
        search_specific_files = set()
 
1740
        for path in specific_files:
 
1741
            other_specific_files = specific_files.difference(set([path]))
 
1742
            if not osutils.is_inside_any(other_specific_files, path):
 
1743
                # this is a top level path, we must check it.
 
1744
                search_specific_files.add(path)
 
1745
        # sketch: 
 
1746
        # compare source_index and target_index at or under each element of search_specific_files.
 
1747
        # follow the following comparison table. Note that we only want to do diff operations when
 
1748
        # the target is fdl because thats when the walkdirs logic will have exposed the pathinfo 
 
1749
        # for the target.
 
1750
        # cases:
 
1751
        # 
 
1752
        # Source | Target | disk | action
 
1753
        #   r    | fdlt   |      | add source to search, add id path move and perform
 
1754
        #        |        |      | diff check on source-target
 
1755
        #   r    | fdlt   |  a   | dangling file that was present in the basis. 
 
1756
        #        |        |      | ???
 
1757
        #   r    |  a     |      | add source to search
 
1758
        #   r    |  a     |  a   | 
 
1759
        #   r    |  r     |      | this path is present in a non-examined tree, skip.
 
1760
        #   r    |  r     |  a   | this path is present in a non-examined tree, skip.
 
1761
        #   a    | fdlt   |      | add new id
 
1762
        #   a    | fdlt   |  a   | dangling locally added file, skip
 
1763
        #   a    |  a     |      | not present in either tree, skip
 
1764
        #   a    |  a     |  a   | not present in any tree, skip
 
1765
        #   a    |  r     |      | not present in either tree at this path, skip as it
 
1766
        #        |        |      | may not be selected by the users list of paths.
 
1767
        #   a    |  r     |  a   | not present in either tree at this path, skip as it
 
1768
        #        |        |      | may not be selected by the users list of paths.
 
1769
        #  fdlt  | fdlt   |      | content in both: diff them
 
1770
        #  fdlt  | fdlt   |  a   | deleted locally, but not unversioned - show as deleted ?
 
1771
        #  fdlt  |  a     |      | unversioned: output deleted id for now
 
1772
        #  fdlt  |  a     |  a   | unversioned and deleted: output deleted id
 
1773
        #  fdlt  |  r     |      | relocated in this tree, so add target to search.
 
1774
        #        |        |      | Dont diff, we will see an r,fd; pair when we reach
 
1775
        #        |        |      | this id at the other path.
 
1776
        #  fdlt  |  r     |  a   | relocated in this tree, so add target to search.
 
1777
        #        |        |      | Dont diff, we will see an r,fd; pair when we reach
 
1778
        #        |        |      | this id at the other path.
 
1779
 
 
1780
        # for all search_indexs in each path at or under each element of
 
1781
        # search_specific_files, if the detail is relocated: add the id, and add the
 
1782
        # relocated path as one to search if its not searched already. If the
 
1783
        # detail is not relocated, add the id.
 
1784
        searched_specific_files = set()
 
1785
        NULL_PARENT_DETAILS = dirstate.DirState.NULL_PARENT_DETAILS
 
1786
        # Using a list so that we can access the values and change them in
 
1787
        # nested scope. Each one is [path, file_id, entry]
 
1788
        last_source_parent = [None, None, None]
 
1789
        last_target_parent = [None, None, None]
 
1790
 
 
1791
        use_filesystem_for_exec = (sys.platform != 'win32')
 
1792
 
 
1793
        def _process_entry(entry, path_info):
 
1794
            """Compare an entry and real disk to generate delta information.
 
1795
 
 
1796
            :param path_info: top_relpath, basename, kind, lstat, abspath for
 
1797
                the path of entry. If None, then the path is considered absent.
 
1798
                (Perhaps we should pass in a concrete entry for this ?)
 
1799
                Basename is returned as a utf8 string because we expect this
 
1800
                tuple will be ignored, and don't want to take the time to
 
1801
                decode.
 
1802
            """
 
1803
            if source_index is None:
 
1804
                source_details = NULL_PARENT_DETAILS
 
1805
            else:
 
1806
                source_details = entry[1][source_index]
 
1807
            target_details = entry[1][target_index]
 
1808
            target_minikind = target_details[0]
 
1809
            if path_info is not None and target_minikind in 'fdlt':
 
1810
                assert target_index == 0
 
1811
                link_or_sha1 = state.update_entry(entry, abspath=path_info[4],
 
1812
                                                  stat_value=path_info[3])
 
1813
                # The entry may have been modified by update_entry
 
1814
                target_details = entry[1][target_index]
 
1815
                target_minikind = target_details[0]
 
1816
            else:
 
1817
                link_or_sha1 = None
 
1818
            source_minikind = source_details[0]
 
1819
            if source_minikind in 'fdltr' and target_minikind in 'fdlt':
 
1820
                # claimed content in both: diff
 
1821
                #   r    | fdlt   |      | add source to search, add id path move and perform
 
1822
                #        |        |      | diff check on source-target
 
1823
                #   r    | fdlt   |  a   | dangling file that was present in the basis.
 
1824
                #        |        |      | ???
 
1825
                if source_minikind in 'r':
 
1826
                    # add the source to the search path to find any children it
 
1827
                    # has.  TODO ? : only add if it is a container ?
 
1828
                    if not osutils.is_inside_any(searched_specific_files,
 
1829
                                                 source_details[1]):
 
1830
                        search_specific_files.add(source_details[1])
 
1831
                    # generate the old path; this is needed for stating later
 
1832
                    # as well.
 
1833
                    old_path = source_details[1]
 
1834
                    old_dirname, old_basename = os.path.split(old_path)
 
1835
                    path = pathjoin(entry[0][0], entry[0][1])
 
1836
                    old_entry = state._get_entry(source_index,
 
1837
                                                 path_utf8=old_path)
 
1838
                    # update the source details variable to be the real
 
1839
                    # location.
 
1840
                    source_details = old_entry[1][source_index]
 
1841
                    source_minikind = source_details[0]
 
1842
                else:
 
1843
                    old_dirname = entry[0][0]
 
1844
                    old_basename = entry[0][1]
 
1845
                    old_path = path = pathjoin(old_dirname, old_basename)
 
1846
                if path_info is None:
 
1847
                    # the file is missing on disk, show as removed.
 
1848
                    content_change = True
 
1849
                    target_kind = None
 
1850
                    target_exec = False
 
1851
                else:
 
1852
                    # source and target are both versioned and disk file is present.
 
1853
                    target_kind = path_info[2]
 
1854
                    if target_kind == 'directory':
 
1855
                        if source_minikind != 'd':
 
1856
                            content_change = True
 
1857
                        else:
 
1858
                            # directories have no fingerprint
 
1859
                            content_change = False
 
1860
                        target_exec = False
 
1861
                    elif target_kind == 'file':
 
1862
                        if source_minikind != 'f':
 
1863
                            content_change = True
 
1864
                        else:
 
1865
                            # We could check the size, but we already have the
 
1866
                            # sha1 hash.
 
1867
                            content_change = (link_or_sha1 != source_details[1])
 
1868
                        # Target details is updated at update_entry time
 
1869
                        if use_filesystem_for_exec:
 
1870
                            # We don't need S_ISREG here, because we are sure
 
1871
                            # we are dealing with a file.
 
1872
                            target_exec = bool(stat.S_IEXEC & path_info[3].st_mode)
 
1873
                        else:
 
1874
                            target_exec = target_details[3]
 
1875
                    elif target_kind == 'symlink':
 
1876
                        if source_minikind != 'l':
 
1877
                            content_change = True
 
1878
                        else:
 
1879
                            content_change = (link_or_sha1 != source_details[1])
 
1880
                        target_exec = False
 
1881
                    elif target_kind == 'tree-reference':
 
1882
                        if source_minikind != 't':
 
1883
                            content_change = True
 
1884
                        else:
 
1885
                            content_change = False
 
1886
                        target_exec = False
 
1887
                    else:
 
1888
                        raise Exception, "unknown kind %s" % path_info[2]
 
1889
                # parent id is the entry for the path in the target tree
 
1890
                if old_dirname == last_source_parent[0]:
 
1891
                    source_parent_id = last_source_parent[1]
 
1892
                else:
 
1893
                    source_parent_entry = state._get_entry(source_index,
 
1894
                                                           path_utf8=old_dirname)
 
1895
                    source_parent_id = source_parent_entry[0][2]
 
1896
                    if source_parent_id == entry[0][2]:
 
1897
                        # This is the root, so the parent is None
 
1898
                        source_parent_id = None
 
1899
                    else:
 
1900
                        last_source_parent[0] = old_dirname
 
1901
                        last_source_parent[1] = source_parent_id
 
1902
                        last_source_parent[2] = source_parent_entry
 
1903
                new_dirname = entry[0][0]
 
1904
                if new_dirname == last_target_parent[0]:
 
1905
                    target_parent_id = last_target_parent[1]
 
1906
                else:
 
1907
                    # TODO: We don't always need to do the lookup, because the
 
1908
                    #       parent entry will be the same as the source entry.
 
1909
                    target_parent_entry = state._get_entry(target_index,
 
1910
                                                           path_utf8=new_dirname)
 
1911
                    target_parent_id = target_parent_entry[0][2]
 
1912
                    if target_parent_id == entry[0][2]:
 
1913
                        # This is the root, so the parent is None
 
1914
                        target_parent_id = None
 
1915
                    else:
 
1916
                        last_target_parent[0] = new_dirname
 
1917
                        last_target_parent[1] = target_parent_id
 
1918
                        last_target_parent[2] = target_parent_entry
 
1919
 
 
1920
                source_exec = source_details[3]
 
1921
                return ((entry[0][2], (old_path, path), content_change,
 
1922
                        (True, True),
 
1923
                        (source_parent_id, target_parent_id),
 
1924
                        (old_basename, entry[0][1]),
 
1925
                        (_minikind_to_kind[source_minikind], target_kind),
 
1926
                        (source_exec, target_exec)),)
 
1927
            elif source_minikind in 'a' and target_minikind in 'fdlt':
 
1928
                # looks like a new file
 
1929
                if path_info is not None:
 
1930
                    path = pathjoin(entry[0][0], entry[0][1])
 
1931
                    # parent id is the entry for the path in the target tree
 
1932
                    # TODO: these are the same for an entire directory: cache em.
 
1933
                    parent_id = state._get_entry(target_index,
 
1934
                                                 path_utf8=entry[0][0])[0][2]
 
1935
                    if parent_id == entry[0][2]:
 
1936
                        parent_id = None
 
1937
                    if use_filesystem_for_exec:
 
1938
                        # We need S_ISREG here, because we aren't sure if this
 
1939
                        # is a file or not.
 
1940
                        target_exec = bool(
 
1941
                            stat.S_ISREG(path_info[3].st_mode)
 
1942
                            and stat.S_IEXEC & path_info[3].st_mode)
 
1943
                    else:
 
1944
                        target_exec = target_details[3]
 
1945
                    return ((entry[0][2], (None, path), True,
 
1946
                            (False, True),
 
1947
                            (None, parent_id),
 
1948
                            (None, entry[0][1]),
 
1949
                            (None, path_info[2]),
 
1950
                            (None, target_exec)),)
 
1951
                else:
 
1952
                    # but its not on disk: we deliberately treat this as just
 
1953
                    # never-present. (Why ?! - RBC 20070224)
 
1954
                    pass
 
1955
            elif source_minikind in 'fdlt' and target_minikind in 'a':
 
1956
                # unversioned, possibly, or possibly not deleted: we dont care.
 
1957
                # if its still on disk, *and* theres no other entry at this
 
1958
                # path [we dont know this in this routine at the moment -
 
1959
                # perhaps we should change this - then it would be an unknown.
 
1960
                old_path = pathjoin(entry[0][0], entry[0][1])
 
1961
                # parent id is the entry for the path in the target tree
 
1962
                parent_id = state._get_entry(source_index, path_utf8=entry[0][0])[0][2]
 
1963
                if parent_id == entry[0][2]:
 
1964
                    parent_id = None
 
1965
                return ((entry[0][2], (old_path, None), True,
 
1966
                        (True, False),
 
1967
                        (parent_id, None),
 
1968
                        (entry[0][1], None),
 
1969
                        (_minikind_to_kind[source_minikind], None),
 
1970
                        (source_details[3], None)),)
 
1971
            elif source_minikind in 'fdlt' and target_minikind in 'r':
 
1972
                # a rename; could be a true rename, or a rename inherited from
 
1973
                # a renamed parent. TODO: handle this efficiently. Its not
 
1974
                # common case to rename dirs though, so a correct but slow
 
1975
                # implementation will do.
 
1976
                if not osutils.is_inside_any(searched_specific_files, target_details[1]):
 
1977
                    search_specific_files.add(target_details[1])
 
1978
            elif source_minikind in 'ra' and target_minikind in 'ra':
 
1979
                # neither of the selected trees contain this file,
 
1980
                # so skip over it. This is not currently directly tested, but
 
1981
                # is indirectly via test_too_much.TestCommands.test_conflicts.
 
1982
                pass
 
1983
            else:
 
1984
                raise AssertionError("don't know how to compare "
 
1985
                    "source_minikind=%r, target_minikind=%r"
 
1986
                    % (source_minikind, target_minikind))
 
1987
                ## import pdb;pdb.set_trace()
 
1988
            return ()
 
1989
 
 
1990
        while search_specific_files:
 
1991
            # TODO: the pending list should be lexically sorted?  the
 
1992
            # interface doesn't require it.
 
1993
            current_root = search_specific_files.pop()
 
1994
            current_root_unicode = current_root.decode('utf8')
 
1995
            searched_specific_files.add(current_root)
 
1996
            # process the entries for this containing directory: the rest will be
 
1997
            # found by their parents recursively.
 
1998
            root_entries = _entries_for_path(current_root)
 
1999
            root_abspath = self.target.abspath(current_root_unicode)
 
2000
            try:
 
2001
                root_stat = os.lstat(root_abspath)
 
2002
            except OSError, e:
 
2003
                if e.errno == errno.ENOENT:
 
2004
                    # the path does not exist: let _process_entry know that.
 
2005
                    root_dir_info = None
 
2006
                else:
 
2007
                    # some other random error: hand it up.
 
2008
                    raise
 
2009
            else:
 
2010
                root_dir_info = ('', current_root,
 
2011
                    osutils.file_kind_from_stat_mode(root_stat.st_mode), root_stat,
 
2012
                    root_abspath)
 
2013
                if root_dir_info[2] == 'directory':
 
2014
                    if self.target._directory_is_tree_reference(
 
2015
                        current_root.decode('utf8')):
 
2016
                        root_dir_info = root_dir_info[:2] + \
 
2017
                            ('tree-reference',) + root_dir_info[3:]
 
2018
 
 
2019
            if not root_entries and not root_dir_info:
 
2020
                # this specified path is not present at all, skip it.
 
2021
                continue
 
2022
            path_handled = False
 
2023
            for entry in root_entries:
 
2024
                for result in _process_entry(entry, root_dir_info):
 
2025
                    # this check should probably be outside the loop: one
 
2026
                    # 'iterate two trees' api, and then _iter_changes filters
 
2027
                    # unchanged pairs. - RBC 20070226
 
2028
                    path_handled = True
 
2029
                    if (include_unchanged
 
2030
                        or result[2]                    # content change
 
2031
                        or result[3][0] != result[3][1] # versioned status
 
2032
                        or result[4][0] != result[4][1] # parent id
 
2033
                        or result[5][0] != result[5][1] # name
 
2034
                        or result[6][0] != result[6][1] # kind
 
2035
                        or result[7][0] != result[7][1] # executable
 
2036
                        ):
 
2037
                        yield (result[0],
 
2038
                               (utf8_decode_or_none(result[1][0]),
 
2039
                                utf8_decode_or_none(result[1][1])),
 
2040
                               result[2],
 
2041
                               result[3],
 
2042
                               result[4],
 
2043
                               (utf8_decode_or_none(result[5][0]),
 
2044
                                utf8_decode_or_none(result[5][1])),
 
2045
                               result[6],
 
2046
                               result[7],
 
2047
                              )
 
2048
            if want_unversioned and not path_handled and root_dir_info:
 
2049
                new_executable = bool(
 
2050
                    stat.S_ISREG(root_dir_info[3].st_mode)
 
2051
                    and stat.S_IEXEC & root_dir_info[3].st_mode)
 
2052
                yield (None,
 
2053
                       (None, current_root_unicode),
 
2054
                       True,
 
2055
                       (False, False),
 
2056
                       (None, None),
 
2057
                       (None, splitpath(current_root_unicode)[-1]),
 
2058
                       (None, root_dir_info[2]),
 
2059
                       (None, new_executable)
 
2060
                      )
 
2061
            initial_key = (current_root, '', '')
 
2062
            block_index, _ = state._find_block_index_from_key(initial_key)
 
2063
            if block_index == 0:
 
2064
                # we have processed the total root already, but because the
 
2065
                # initial key matched it we should skip it here.
 
2066
                block_index +=1
 
2067
            if root_dir_info and root_dir_info[2] == 'tree-reference':
 
2068
                current_dir_info = None
 
2069
            else:
 
2070
                dir_iterator = osutils._walkdirs_utf8(root_abspath, prefix=current_root)
 
2071
                try:
 
2072
                    current_dir_info = dir_iterator.next()
 
2073
                except OSError, e:
 
2074
                    # on win32, python2.4 has e.errno == ERROR_DIRECTORY, but
 
2075
                    # python 2.5 has e.errno == EINVAL,
 
2076
                    #            and e.winerror == ERROR_DIRECTORY
 
2077
                    e_winerror = getattr(e, 'winerror', None)
 
2078
                    # there may be directories in the inventory even though
 
2079
                    # this path is not a file on disk: so mark it as end of
 
2080
                    # iterator
 
2081
                    if e.errno in (errno.ENOENT, errno.ENOTDIR, errno.EINVAL):
 
2082
                        current_dir_info = None
 
2083
                    elif (sys.platform == 'win32'
 
2084
                          and ERROR_DIRECTORY in (e.errno, e_winerror)):
 
2085
                        current_dir_info = None
 
2086
                    else:
 
2087
                        raise
 
2088
                else:
 
2089
                    if current_dir_info[0][0] == '':
 
2090
                        # remove .bzr from iteration
 
2091
                        bzr_index = bisect_left(current_dir_info[1], ('.bzr',))
 
2092
                        assert current_dir_info[1][bzr_index][0] == '.bzr'
 
2093
                        del current_dir_info[1][bzr_index]
 
2094
            # walk until both the directory listing and the versioned metadata
 
2095
            # are exhausted. 
 
2096
            if (block_index < len(state._dirblocks) and
 
2097
                osutils.is_inside(current_root, state._dirblocks[block_index][0])):
 
2098
                current_block = state._dirblocks[block_index]
 
2099
            else:
 
2100
                current_block = None
 
2101
            while (current_dir_info is not None or
 
2102
                   current_block is not None):
 
2103
                if (current_dir_info and current_block
 
2104
                    and current_dir_info[0][0] != current_block[0]):
 
2105
                    if current_dir_info[0][0] < current_block[0] :
 
2106
                        # filesystem data refers to paths not covered by the dirblock.
 
2107
                        # this has two possibilities:
 
2108
                        # A) it is versioned but empty, so there is no block for it
 
2109
                        # B) it is not versioned.
 
2110
                        # in either case it was processed by the containing directories walk:
 
2111
                        # if it is root/foo, when we walked root we emitted it,
 
2112
                        # or if we ere given root/foo to walk specifically, we
 
2113
                        # emitted it when checking the walk-root entries
 
2114
                        # advance the iterator and loop - we dont need to emit it.
 
2115
                        try:
 
2116
                            current_dir_info = dir_iterator.next()
 
2117
                        except StopIteration:
 
2118
                            current_dir_info = None
 
2119
                    else:
 
2120
                        # We have a dirblock entry for this location, but there
 
2121
                        # is no filesystem path for this. This is most likely
 
2122
                        # because a directory was removed from the disk.
 
2123
                        # We don't have to report the missing directory,
 
2124
                        # because that should have already been handled, but we
 
2125
                        # need to handle all of the files that are contained
 
2126
                        # within.
 
2127
                        for current_entry in current_block[1]:
 
2128
                            # entry referring to file not present on disk.
 
2129
                            # advance the entry only, after processing.
 
2130
                            for result in _process_entry(current_entry, None):
 
2131
                                # this check should probably be outside the loop: one
 
2132
                                # 'iterate two trees' api, and then _iter_changes filters
 
2133
                                # unchanged pairs. - RBC 20070226
 
2134
                                if (include_unchanged
 
2135
                                    or result[2]                    # content change
 
2136
                                    or result[3][0] != result[3][1] # versioned status
 
2137
                                    or result[4][0] != result[4][1] # parent id
 
2138
                                    or result[5][0] != result[5][1] # name
 
2139
                                    or result[6][0] != result[6][1] # kind
 
2140
                                    or result[7][0] != result[7][1] # executable
 
2141
                                    ):
 
2142
                                    yield (result[0],
 
2143
                                           (utf8_decode_or_none(result[1][0]),
 
2144
                                            utf8_decode_or_none(result[1][1])),
 
2145
                                           result[2],
 
2146
                                           result[3],
 
2147
                                           result[4],
 
2148
                                           (utf8_decode_or_none(result[5][0]),
 
2149
                                            utf8_decode_or_none(result[5][1])),
 
2150
                                           result[6],
 
2151
                                           result[7],
 
2152
                                          )
 
2153
                        block_index +=1
 
2154
                        if (block_index < len(state._dirblocks) and
 
2155
                            osutils.is_inside(current_root,
 
2156
                                              state._dirblocks[block_index][0])):
 
2157
                            current_block = state._dirblocks[block_index]
 
2158
                        else:
 
2159
                            current_block = None
 
2160
                    continue
 
2161
                entry_index = 0
 
2162
                if current_block and entry_index < len(current_block[1]):
 
2163
                    current_entry = current_block[1][entry_index]
 
2164
                else:
 
2165
                    current_entry = None
 
2166
                advance_entry = True
 
2167
                path_index = 0
 
2168
                if current_dir_info and path_index < len(current_dir_info[1]):
 
2169
                    current_path_info = current_dir_info[1][path_index]
 
2170
                    if current_path_info[2] == 'directory':
 
2171
                        if self.target._directory_is_tree_reference(
 
2172
                            current_path_info[0].decode('utf8')):
 
2173
                            current_path_info = current_path_info[:2] + \
 
2174
                                ('tree-reference',) + current_path_info[3:]
 
2175
                else:
 
2176
                    current_path_info = None
 
2177
                advance_path = True
 
2178
                path_handled = False
 
2179
                while (current_entry is not None or
 
2180
                    current_path_info is not None):
 
2181
                    if current_entry is None:
 
2182
                        # the check for path_handled when the path is adnvaced
 
2183
                        # will yield this path if needed.
 
2184
                        pass
 
2185
                    elif current_path_info is None:
 
2186
                        # no path is fine: the per entry code will handle it.
 
2187
                        for result in _process_entry(current_entry, current_path_info):
 
2188
                            # this check should probably be outside the loop: one
 
2189
                            # 'iterate two trees' api, and then _iter_changes filters
 
2190
                            # unchanged pairs. - RBC 20070226
 
2191
                            if (include_unchanged
 
2192
                                or result[2]                    # content change
 
2193
                                or result[3][0] != result[3][1] # versioned status
 
2194
                                or result[4][0] != result[4][1] # parent id
 
2195
                                or result[5][0] != result[5][1] # name
 
2196
                                or result[6][0] != result[6][1] # kind
 
2197
                                or result[7][0] != result[7][1] # executable
 
2198
                                ):
 
2199
                                yield (result[0],
 
2200
                                       (utf8_decode_or_none(result[1][0]),
 
2201
                                        utf8_decode_or_none(result[1][1])),
 
2202
                                       result[2],
 
2203
                                       result[3],
 
2204
                                       result[4],
 
2205
                                       (utf8_decode_or_none(result[5][0]),
 
2206
                                        utf8_decode_or_none(result[5][1])),
 
2207
                                       result[6],
 
2208
                                       result[7],
 
2209
                                      )
 
2210
                    elif current_entry[0][1] != current_path_info[1]:
 
2211
                        if current_path_info[1] < current_entry[0][1]:
 
2212
                            # extra file on disk: pass for now, but only
 
2213
                            # increment the path, not the entry
 
2214
                            advance_entry = False
 
2215
                        else:
 
2216
                            # entry referring to file not present on disk.
 
2217
                            # advance the entry only, after processing.
 
2218
                            for result in _process_entry(current_entry, None):
 
2219
                                # this check should probably be outside the loop: one
 
2220
                                # 'iterate two trees' api, and then _iter_changes filters
 
2221
                                # unchanged pairs. - RBC 20070226
 
2222
                                path_handled = True
 
2223
                                if (include_unchanged
 
2224
                                    or result[2]                    # content change
 
2225
                                    or result[3][0] != result[3][1] # versioned status
 
2226
                                    or result[4][0] != result[4][1] # parent id
 
2227
                                    or result[5][0] != result[5][1] # name
 
2228
                                    or result[6][0] != result[6][1] # kind
 
2229
                                    or result[7][0] != result[7][1] # executable
 
2230
                                    ):
 
2231
                                    yield (result[0],
 
2232
                                           (utf8_decode_or_none(result[1][0]),
 
2233
                                            utf8_decode_or_none(result[1][1])),
 
2234
                                           result[2],
 
2235
                                           result[3],
 
2236
                                           result[4],
 
2237
                                           (utf8_decode_or_none(result[5][0]),
 
2238
                                            utf8_decode_or_none(result[5][1])),
 
2239
                                           result[6],
 
2240
                                           result[7],
 
2241
                                          )
 
2242
                            advance_path = False
 
2243
                    else:
 
2244
                        for result in _process_entry(current_entry, current_path_info):
 
2245
                            # this check should probably be outside the loop: one
 
2246
                            # 'iterate two trees' api, and then _iter_changes filters
 
2247
                            # unchanged pairs. - RBC 20070226
 
2248
                            path_handled = True
 
2249
                            if (include_unchanged
 
2250
                                or result[2]                    # content change
 
2251
                                or result[3][0] != result[3][1] # versioned status
 
2252
                                or result[4][0] != result[4][1] # parent id
 
2253
                                or result[5][0] != result[5][1] # name
 
2254
                                or result[6][0] != result[6][1] # kind
 
2255
                                or result[7][0] != result[7][1] # executable
 
2256
                                ):
 
2257
                                yield (result[0],
 
2258
                                       (utf8_decode_or_none(result[1][0]),
 
2259
                                        utf8_decode_or_none(result[1][1])),
 
2260
                                       result[2],
 
2261
                                       result[3],
 
2262
                                       result[4],
 
2263
                                       (utf8_decode_or_none(result[5][0]),
 
2264
                                        utf8_decode_or_none(result[5][1])),
 
2265
                                       result[6],
 
2266
                                       result[7],
 
2267
                                      )
 
2268
                    if advance_entry and current_entry is not None:
 
2269
                        entry_index += 1
 
2270
                        if entry_index < len(current_block[1]):
 
2271
                            current_entry = current_block[1][entry_index]
 
2272
                        else:
 
2273
                            current_entry = None
 
2274
                    else:
 
2275
                        advance_entry = True # reset the advance flaga
 
2276
                    if advance_path and current_path_info is not None:
 
2277
                        if not path_handled:
 
2278
                            # unversioned in all regards
 
2279
                            if want_unversioned:
 
2280
                                new_executable = bool(
 
2281
                                    stat.S_ISREG(current_path_info[3].st_mode)
 
2282
                                    and stat.S_IEXEC & current_path_info[3].st_mode)
 
2283
                                if want_unversioned:
 
2284
                                    yield (None,
 
2285
                                        (None, utf8_decode_or_none(current_path_info[0])),
 
2286
                                        True,
 
2287
                                        (False, False),
 
2288
                                        (None, None),
 
2289
                                        (None, utf8_decode_or_none(current_path_info[1])),
 
2290
                                        (None, current_path_info[2]),
 
2291
                                        (None, new_executable))
 
2292
                            # dont descend into this unversioned path if it is
 
2293
                            # a dir
 
2294
                            if current_path_info[2] in ('directory'):
 
2295
                                del current_dir_info[1][path_index]
 
2296
                                path_index -= 1
 
2297
                        # dont descend the disk iterator into any tree 
 
2298
                        # paths.
 
2299
                        if current_path_info[2] == 'tree-reference':
 
2300
                            del current_dir_info[1][path_index]
 
2301
                            path_index -= 1
 
2302
                        path_index += 1
 
2303
                        if path_index < len(current_dir_info[1]):
 
2304
                            current_path_info = current_dir_info[1][path_index]
 
2305
                            if current_path_info[2] == 'directory':
 
2306
                                if self.target._directory_is_tree_reference(
 
2307
                                    current_path_info[0].decode('utf8')):
 
2308
                                    current_path_info = current_path_info[:2] + \
 
2309
                                        ('tree-reference',) + current_path_info[3:]
 
2310
                        else:
 
2311
                            current_path_info = None
 
2312
                        path_handled = False
 
2313
                    else:
 
2314
                        advance_path = True # reset the advance flagg.
 
2315
                if current_block is not None:
 
2316
                    block_index += 1
 
2317
                    if (block_index < len(state._dirblocks) and
 
2318
                        osutils.is_inside(current_root, state._dirblocks[block_index][0])):
 
2319
                        current_block = state._dirblocks[block_index]
 
2320
                    else:
 
2321
                        current_block = None
 
2322
                if current_dir_info is not None:
 
2323
                    try:
 
2324
                        current_dir_info = dir_iterator.next()
 
2325
                    except StopIteration:
 
2326
                        current_dir_info = None
 
2327
 
 
2328
 
 
2329
    @staticmethod
 
2330
    def is_compatible(source, target):
 
2331
        # the target must be a dirstate working tree
 
2332
        if not isinstance(target, WorkingTree4):
 
2333
            return False
 
2334
        # the source must be a revtreee or dirstate rev tree.
 
2335
        if not isinstance(source,
 
2336
            (revisiontree.RevisionTree, DirStateRevisionTree)):
 
2337
            return False
 
2338
        # the source revid must be in the target dirstate
 
2339
        if not (source._revision_id == NULL_REVISION or
 
2340
            source._revision_id in target.get_parent_ids()):
 
2341
            # TODO: what about ghosts? it may well need to 
 
2342
            # check for them explicitly.
 
2343
            return False
 
2344
        return True
 
2345
 
 
2346
InterTree.register_optimiser(InterDirStateTree)
 
2347
 
 
2348
 
 
2349
class Converter3to4(object):
 
2350
    """Perform an in-place upgrade of format 3 to format 4 trees."""
 
2351
 
 
2352
    def __init__(self):
 
2353
        self.target_format = WorkingTreeFormat4()
 
2354
 
 
2355
    def convert(self, tree):
 
2356
        # lock the control files not the tree, so that we dont get tree
 
2357
        # on-unlock behaviours, and so that noone else diddles with the 
 
2358
        # tree during upgrade.
 
2359
        tree._control_files.lock_write()
 
2360
        try:
 
2361
            tree.read_working_inventory()
 
2362
            self.create_dirstate_data(tree)
 
2363
            self.update_format(tree)
 
2364
            self.remove_xml_files(tree)
 
2365
        finally:
 
2366
            tree._control_files.unlock()
 
2367
 
 
2368
    def create_dirstate_data(self, tree):
 
2369
        """Create the dirstate based data for tree."""
 
2370
        local_path = tree.bzrdir.get_workingtree_transport(None
 
2371
            ).local_abspath('dirstate')
 
2372
        state = dirstate.DirState.from_tree(tree, local_path)
 
2373
        state.save()
 
2374
        state.unlock()
 
2375
 
 
2376
    def remove_xml_files(self, tree):
 
2377
        """Remove the oldformat 3 data."""
 
2378
        transport = tree.bzrdir.get_workingtree_transport(None)
 
2379
        for path in ['basis-inventory-cache', 'inventory', 'last-revision',
 
2380
            'pending-merges', 'stat-cache']:
 
2381
            try:
 
2382
                transport.delete(path)
 
2383
            except errors.NoSuchFile:
 
2384
                # some files are optional - just deal.
 
2385
                pass
 
2386
 
 
2387
    def update_format(self, tree):
 
2388
        """Change the format marker."""
 
2389
        tree._control_files.put_utf8('format',
 
2390
            self.target_format.get_format_string())