/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: Robert Collins
  • Date: 2008-09-19 06:53:41 UTC
  • mto: (3696.5.1 commit-updates)
  • mto: This revision was merged to the branch mainline in revision 3741.
  • Revision ID: robertc@robertcollins.net-20080919065341-5t5w1p2gi926nfia
First cut - make it work - at updating the tree stat cache during commit.

Show diffs side-by-side

added added

removed removed

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