/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/workingtree_4.py

  • Committer: Aaron Bentley
  • Date: 2008-02-24 17:19:56 UTC
  • mto: This revision was merged to the branch mainline in revision 3235.
  • Revision ID: aaron@aaronbentley.com-20080224171956-0qu73pf4pol2utu4
Clean error if filesystem does not support hard-links

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