~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree_4.py

  • Committer: Martin Pool
  • Date: 2005-04-28 07:24:55 UTC
  • Revision ID: mbp@sourcefrog.net-20050428072453-7b99afa993a1e549
todo

Show diffs side-by-side

added added

removed removed

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