/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: 2007-12-20 20:44:45 UTC
  • mto: This revision was merged to the branch mainline in revision 3235.
  • Revision ID: abentley@panoramicfeedback.com-20071220204445-9o2f10gvvd8e4rks
Implement hard-link support for branch and checkout

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