/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Aaron Bentley
  • Date: 2012-07-19 18:28:25 UTC
  • mto: This revision was merged to the branch mainline in revision 6540.
  • Revision ID: aaron@aaronbentley.com-20120719182825-izn34owl7vr6abjg
RemoveĀ unusedĀ 'message'

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
29
29
WorkingTree.open(dir).
30
30
"""
31
31
 
 
32
from __future__ import absolute_import
32
33
 
33
34
from cStringIO import StringIO
34
35
import os
44
45
import stat
45
46
import re
46
47
 
47
 
import bzrlib
48
48
from bzrlib import (
49
49
    branch,
50
 
    bzrdir,
51
50
    conflicts as _mod_conflicts,
 
51
    controldir,
52
52
    errors,
 
53
    filters as _mod_filters,
53
54
    generate_ids,
54
55
    globbing,
55
56
    graph as _mod_graph,
56
 
    hashcache,
57
57
    ignores,
58
58
    inventory,
59
59
    merge,
60
60
    revision as _mod_revision,
61
61
    revisiontree,
62
 
    trace,
 
62
    rio as _mod_rio,
 
63
    shelf,
63
64
    transform,
 
65
    transport,
64
66
    ui,
65
67
    views,
66
68
    xml5,
67
69
    xml7,
68
70
    )
69
 
import bzrlib.branch
70
 
from bzrlib.transport import get_transport
71
 
from bzrlib.workingtree_4 import (
72
 
    WorkingTreeFormat4,
73
 
    WorkingTreeFormat5,
74
 
    WorkingTreeFormat6,
75
 
    )
76
71
""")
77
72
 
78
 
from bzrlib import symbol_versioning
 
73
# Explicitly import bzrlib.bzrdir so that the BzrProber
 
74
# is guaranteed to be registered.
 
75
from bzrlib import (
 
76
    bzrdir,
 
77
    symbol_versioning,
 
78
    )
 
79
 
79
80
from bzrlib.decorators import needs_read_lock, needs_write_lock
80
 
from bzrlib.lockable_files import LockableFiles
81
 
from bzrlib.lockdir import LockDir
 
81
from bzrlib.i18n import gettext
 
82
from bzrlib.lock import LogicalLockResult
82
83
import bzrlib.mutabletree
83
84
from bzrlib.mutabletree import needs_tree_write_lock
84
85
from bzrlib import osutils
90
91
    realpath,
91
92
    safe_unicode,
92
93
    splitpath,
93
 
    supports_executable,
94
94
    )
95
 
from bzrlib.filters import filtered_input_file
96
95
from bzrlib.trace import mutter, note
97
 
from bzrlib.transport.local import LocalTransport
98
96
from bzrlib.revision import CURRENT_REVISION
99
 
from bzrlib.rio import RioReader, rio_file, Stanza
100
97
from bzrlib.symbol_versioning import (
101
98
    deprecated_passed,
102
99
    DEPRECATED_PARAMETER,
168
165
 
169
166
 
170
167
class WorkingTree(bzrlib.mutabletree.MutableTree,
171
 
    bzrdir.ControlComponent):
 
168
    controldir.ControlComponent):
172
169
    """Working copy tree.
173
170
 
174
 
    The inventory is held in the `Branch` working-inventory, and the
175
 
    files are in a directory on disk.
176
 
 
177
 
    It is possible for a `WorkingTree` to have a filename which is
178
 
    not listed in the Inventory and vice versa.
 
171
    :ivar basedir: The root of the tree on disk. This is a unicode path object
 
172
        (as opposed to a URL).
179
173
    """
180
174
 
181
175
    # override this to set the strategy for storing views
184
178
 
185
179
    def __init__(self, basedir='.',
186
180
                 branch=DEPRECATED_PARAMETER,
187
 
                 _inventory=None,
188
 
                 _control_files=None,
189
181
                 _internal=False,
 
182
                 _transport=None,
190
183
                 _format=None,
191
184
                 _bzrdir=None):
192
185
        """Construct a WorkingTree instance. This is not a public API.
205
198
        else:
206
199
            self._branch = self.bzrdir.open_branch()
207
200
        self.basedir = realpath(basedir)
208
 
        # if branch is at our basedir and is a format 6 or less
209
 
        if isinstance(self._format, WorkingTreeFormat2):
210
 
            # share control object
211
 
            self._control_files = self.branch.control_files
212
 
        else:
213
 
            # assume all other formats have their own control files.
214
 
            self._control_files = _control_files
215
 
        self._transport = self._control_files._transport
216
 
        # update the whole cache up front and write to disk if anything changed;
217
 
        # in the future we might want to do this more selectively
218
 
        # two possible ways offer themselves : in self._unlock, write the cache
219
 
        # if needed, or, when the cache sees a change, append it to the hash
220
 
        # cache file, and have the parser take the most recent entry for a
221
 
        # given path only.
222
 
        wt_trans = self.bzrdir.get_workingtree_transport(None)
223
 
        cache_filename = wt_trans.local_abspath('stat-cache')
224
 
        self._hashcache = hashcache.HashCache(basedir, cache_filename,
225
 
            self.bzrdir._get_file_mode(),
226
 
            self._content_filter_stack_provider())
227
 
        hc = self._hashcache
228
 
        hc.read()
229
 
        # is this scan needed ? it makes things kinda slow.
230
 
        #hc.scan()
231
 
 
232
 
        if hc.needs_write:
233
 
            mutter("write hc")
234
 
            hc.write()
235
 
 
236
 
        if _inventory is None:
237
 
            # This will be acquired on lock_read() or lock_write()
238
 
            self._inventory_is_modified = False
239
 
            self._inventory = None
240
 
        else:
241
 
            # the caller of __init__ has provided an inventory,
242
 
            # we assume they know what they are doing - as its only
243
 
            # the Format factory and creation methods that are
244
 
            # permitted to do this.
245
 
            self._set_inventory(_inventory, dirty=False)
246
 
        self._detect_case_handling()
 
201
        self._transport = _transport
247
202
        self._rules_searcher = None
248
203
        self.views = self._make_views()
249
204
 
255
210
    def control_transport(self):
256
211
        return self._transport
257
212
 
258
 
    def _detect_case_handling(self):
259
 
        wt_trans = self.bzrdir.get_workingtree_transport(None)
260
 
        try:
261
 
            wt_trans.stat("FoRMaT")
262
 
        except errors.NoSuchFile:
263
 
            self.case_sensitive = True
264
 
        else:
265
 
            self.case_sensitive = False
266
 
 
267
 
        self._setup_directory_is_tree_reference()
 
213
    def is_control_filename(self, filename):
 
214
        """True if filename is the name of a control file in this tree.
 
215
 
 
216
        :param filename: A filename within the tree. This is a relative path
 
217
            from the root of this tree.
 
218
 
 
219
        This is true IF and ONLY IF the filename is part of the meta data
 
220
        that bzr controls in this tree. I.E. a random .bzr directory placed
 
221
        on disk will not be a control file for this tree.
 
222
        """
 
223
        return self.bzrdir.is_control_filename(filename)
268
224
 
269
225
    branch = property(
270
226
        fget=lambda self: self._branch,
274
230
            the working tree has been constructed from.
275
231
            """)
276
232
 
 
233
    def has_versioned_directories(self):
 
234
        """See `Tree.has_versioned_directories`."""
 
235
        return self._format.supports_versioned_directories
 
236
 
 
237
    def _supports_executable(self):
 
238
        if sys.platform == 'win32':
 
239
            return False
 
240
        # FIXME: Ideally this should check the file system
 
241
        return True
 
242
 
277
243
    def break_lock(self):
278
244
        """Break a lock if one is present from another instance.
279
245
 
282
248
 
283
249
        This will probe the repository for its lock as well.
284
250
        """
285
 
        self._control_files.break_lock()
286
 
        self.branch.break_lock()
287
 
 
288
 
    def _get_check_refs(self):
289
 
        """Return the references needed to perform a check of this tree.
290
 
        
291
 
        The default implementation returns no refs, and is only suitable for
292
 
        trees that have no local caching and can commit on ghosts at any time.
293
 
 
294
 
        :seealso: bzrlib.check for details about check_refs.
295
 
        """
296
 
        return []
 
251
        raise NotImplementedError(self.break_lock)
297
252
 
298
253
    def requires_rich_root(self):
299
254
        return self._format.requires_rich_root
307
262
    def supports_views(self):
308
263
        return self.views.supports_views()
309
264
 
310
 
    def _set_inventory(self, inv, dirty):
311
 
        """Set the internal cached inventory.
 
265
    def get_config_stack(self):
 
266
        """Retrieve the config stack for this tree.
312
267
 
313
 
        :param inv: The inventory to set.
314
 
        :param dirty: A boolean indicating whether the inventory is the same
315
 
            logical inventory as whats on disk. If True the inventory is not
316
 
            the same and should be written to disk or data will be lost, if
317
 
            False then the inventory is the same as that on disk and any
318
 
            serialisation would be unneeded overhead.
 
268
        :return: A ``bzrlib.config.Stack``
319
269
        """
320
 
        self._inventory = inv
321
 
        self._inventory_is_modified = dirty
 
270
        # For the moment, just provide the branch config stack.
 
271
        return self.branch.get_config_stack()
322
272
 
323
273
    @staticmethod
324
274
    def open(path=None, _unsupported=False):
327
277
        """
328
278
        if path is None:
329
279
            path = osutils.getcwd()
330
 
        control = bzrdir.BzrDir.open(path, _unsupported)
331
 
        return control.open_workingtree(_unsupported)
 
280
        control = controldir.ControlDir.open(path, _unsupported=_unsupported)
 
281
        return control.open_workingtree(unsupported=_unsupported)
332
282
 
333
283
    @staticmethod
334
284
    def open_containing(path=None):
345
295
        """
346
296
        if path is None:
347
297
            path = osutils.getcwd()
348
 
        control, relpath = bzrdir.BzrDir.open_containing(path)
349
 
 
 
298
        control, relpath = controldir.ControlDir.open_containing(path)
350
299
        return control.open_workingtree(), relpath
351
300
 
352
301
    @staticmethod
 
302
    def open_containing_paths(file_list, default_directory=None,
 
303
                              canonicalize=True, apply_view=True):
 
304
        """Open the WorkingTree that contains a set of paths.
 
305
 
 
306
        Fail if the paths given are not all in a single tree.
 
307
 
 
308
        This is used for the many command-line interfaces that take a list of
 
309
        any number of files and that require they all be in the same tree.
 
310
        """
 
311
        if default_directory is None:
 
312
            default_directory = u'.'
 
313
        # recommended replacement for builtins.internal_tree_files
 
314
        if file_list is None or len(file_list) == 0:
 
315
            tree = WorkingTree.open_containing(default_directory)[0]
 
316
            # XXX: doesn't really belong here, and seems to have the strange
 
317
            # side effect of making it return a bunch of files, not the whole
 
318
            # tree -- mbp 20100716
 
319
            if tree.supports_views() and apply_view:
 
320
                view_files = tree.views.lookup_view()
 
321
                if view_files:
 
322
                    file_list = view_files
 
323
                    view_str = views.view_display_str(view_files)
 
324
                    note(gettext("Ignoring files outside view. View is %s") % view_str)
 
325
            return tree, file_list
 
326
        if default_directory == u'.':
 
327
            seed = file_list[0]
 
328
        else:
 
329
            seed = default_directory
 
330
            file_list = [osutils.pathjoin(default_directory, f)
 
331
                         for f in file_list]
 
332
        tree = WorkingTree.open_containing(seed)[0]
 
333
        return tree, tree.safe_relpath_files(file_list, canonicalize,
 
334
                                             apply_view=apply_view)
 
335
 
 
336
    def safe_relpath_files(self, file_list, canonicalize=True, apply_view=True):
 
337
        """Convert file_list into a list of relpaths in tree.
 
338
 
 
339
        :param self: A tree to operate on.
 
340
        :param file_list: A list of user provided paths or None.
 
341
        :param apply_view: if True and a view is set, apply it or check that
 
342
            specified files are within it
 
343
        :return: A list of relative paths.
 
344
        :raises errors.PathNotChild: When a provided path is in a different self
 
345
            than self.
 
346
        """
 
347
        if file_list is None:
 
348
            return None
 
349
        if self.supports_views() and apply_view:
 
350
            view_files = self.views.lookup_view()
 
351
        else:
 
352
            view_files = []
 
353
        new_list = []
 
354
        # self.relpath exists as a "thunk" to osutils, but canonical_relpath
 
355
        # doesn't - fix that up here before we enter the loop.
 
356
        if canonicalize:
 
357
            fixer = lambda p: osutils.canonical_relpath(self.basedir, p)
 
358
        else:
 
359
            fixer = self.relpath
 
360
        for filename in file_list:
 
361
            relpath = fixer(osutils.dereference_path(filename))
 
362
            if view_files and not osutils.is_inside_any(view_files, relpath):
 
363
                raise errors.FileOutsideView(filename, view_files)
 
364
            new_list.append(relpath)
 
365
        return new_list
 
366
 
 
367
    @staticmethod
353
368
    def open_downlevel(path=None):
354
369
        """Open an unsupported working tree.
355
370
 
368
383
                return True, None
369
384
            else:
370
385
                return True, tree
371
 
        transport = get_transport(location)
372
 
        iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
 
386
        t = transport.get_transport(location)
 
387
        iterator = controldir.ControlDir.find_bzrdirs(t, evaluate=evaluate,
373
388
                                              list_current=list_current)
374
 
        return [t for t in iterator if t is not None]
375
 
 
376
 
    # should be deprecated - this is slow and in any case treating them as a
377
 
    # container is (we now know) bad style -- mbp 20070302
378
 
    ## @deprecated_method(zero_fifteen)
379
 
    def __iter__(self):
380
 
        """Iterate through file_ids for this tree.
381
 
 
382
 
        file_ids are in a WorkingTree if they are in the working inventory
383
 
        and the working file exists.
384
 
        """
385
 
        inv = self._inventory
386
 
        for path, ie in inv.iter_entries():
387
 
            if osutils.lexists(self.abspath(path)):
388
 
                yield ie.file_id
389
 
 
390
 
    def all_file_ids(self):
391
 
        """See Tree.iter_all_file_ids"""
392
 
        return set(self.inventory)
 
389
        return [tr for tr in iterator if tr is not None]
393
390
 
394
391
    def __repr__(self):
395
392
        return "<%s of %s>" % (self.__class__.__name__,
450
447
        return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
451
448
 
452
449
    def get_file_with_stat(self, file_id, path=None, filtered=True,
453
 
        _fstat=os.fstat):
 
450
                           _fstat=osutils.fstat):
454
451
        """See Tree.get_file_with_stat."""
455
452
        if path is None:
456
453
            path = self.id2path(file_id)
458
455
        stat_value = _fstat(file_obj.fileno())
459
456
        if filtered and self.supports_content_filtering():
460
457
            filters = self._content_filter_stack(path)
461
 
            file_obj = filtered_input_file(file_obj, filters)
 
458
            file_obj = _mod_filters.filtered_input_file(file_obj, filters)
462
459
        return (file_obj, stat_value)
463
460
 
464
461
    def get_file_text(self, file_id, path=None, filtered=True):
465
 
        return self.get_file(file_id, path=path, filtered=filtered).read()
 
462
        my_file = self.get_file(file_id, path=path, filtered=filtered)
 
463
        try:
 
464
            return my_file.read()
 
465
        finally:
 
466
            my_file.close()
466
467
 
467
468
    def get_file_byname(self, filename, filtered=True):
468
469
        path = self.abspath(filename)
469
470
        f = file(path, 'rb')
470
471
        if filtered and self.supports_content_filtering():
471
472
            filters = self._content_filter_stack(filename)
472
 
            return filtered_input_file(f, filters)
 
473
            return _mod_filters.filtered_input_file(f, filters)
473
474
        else:
474
475
            return f
475
476
 
481
482
        finally:
482
483
            file.close()
483
484
 
484
 
    @needs_read_lock
485
 
    def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
486
 
        """See Tree.annotate_iter
487
 
 
488
 
        This implementation will use the basis tree implementation if possible.
489
 
        Lines not in the basis are attributed to CURRENT_REVISION
490
 
 
491
 
        If there are pending merges, lines added by those merges will be
492
 
        incorrectly attributed to CURRENT_REVISION (but after committing, the
493
 
        attribution will be correct).
494
 
        """
495
 
        maybe_file_parent_keys = []
496
 
        for parent_id in self.get_parent_ids():
497
 
            try:
498
 
                parent_tree = self.revision_tree(parent_id)
499
 
            except errors.NoSuchRevisionInTree:
500
 
                parent_tree = self.branch.repository.revision_tree(parent_id)
501
 
            parent_tree.lock_read()
502
 
            try:
503
 
                if file_id not in parent_tree:
504
 
                    continue
505
 
                ie = parent_tree.inventory[file_id]
506
 
                if ie.kind != 'file':
507
 
                    # Note: this is slightly unnecessary, because symlinks and
508
 
                    # directories have a "text" which is the empty text, and we
509
 
                    # know that won't mess up annotations. But it seems cleaner
510
 
                    continue
511
 
                parent_text_key = (file_id, ie.revision)
512
 
                if parent_text_key not in maybe_file_parent_keys:
513
 
                    maybe_file_parent_keys.append(parent_text_key)
514
 
            finally:
515
 
                parent_tree.unlock()
516
 
        graph = _mod_graph.Graph(self.branch.repository.texts)
517
 
        heads = graph.heads(maybe_file_parent_keys)
518
 
        file_parent_keys = []
519
 
        for key in maybe_file_parent_keys:
520
 
            if key in heads:
521
 
                file_parent_keys.append(key)
522
 
 
523
 
        # Now we have the parents of this content
524
 
        annotator = self.branch.repository.texts.get_annotator()
525
 
        text = self.get_file(file_id).read()
526
 
        this_key =(file_id, default_revision)
527
 
        annotator.add_special_text(this_key, file_parent_keys, text)
528
 
        annotations = [(key[-1], line)
529
 
                       for key, line in annotator.annotate_flat(this_key)]
530
 
        return annotations
531
 
 
532
 
    def _get_ancestors(self, default_revision):
533
 
        ancestors = set([default_revision])
534
 
        for parent_id in self.get_parent_ids():
535
 
            ancestors.update(self.branch.repository.get_ancestry(
536
 
                             parent_id, topo_sorted=False))
537
 
        return ancestors
538
 
 
539
485
    def get_parent_ids(self):
540
486
        """See Tree.get_parent_ids.
541
487
 
557
503
                parents.append(revision_id)
558
504
        return parents
559
505
 
560
 
    @needs_read_lock
561
506
    def get_root_id(self):
562
507
        """Return the id of this trees root"""
563
 
        return self._inventory.root.file_id
564
 
 
565
 
    def _get_store_filename(self, file_id):
566
 
        ## XXX: badly named; this is not in the store at all
567
 
        return self.abspath(self.id2path(file_id))
 
508
        raise NotImplementedError(self.get_root_id)
568
509
 
569
510
    @needs_read_lock
570
 
    def clone(self, to_bzrdir, revision_id=None):
 
511
    def clone(self, to_controldir, revision_id=None):
571
512
        """Duplicate this working tree into to_bzr, including all state.
572
513
 
573
514
        Specifically modified files are kept as modified, but
574
515
        ignored and unknown files are discarded.
575
516
 
576
 
        If you want to make a new line of development, see bzrdir.sprout()
 
517
        If you want to make a new line of development, see ControlDir.sprout()
577
518
 
578
519
        revision
579
520
            If not None, the cloned tree will have its last revision set to
581
522
            and this one merged in.
582
523
        """
583
524
        # assumes the target bzr dir format is compatible.
584
 
        result = to_bzrdir.create_workingtree()
 
525
        result = to_controldir.create_workingtree()
585
526
        self.copy_content_into(result, revision_id)
586
527
        return result
587
528
 
595
536
            # TODO now merge from tree.last_revision to revision (to preserve
596
537
            # user local changes)
597
538
            merge.transform_tree(tree, self)
598
 
            tree.set_parent_ids([revision_id])
 
539
            if revision_id == _mod_revision.NULL_REVISION:
 
540
                new_parents = []
 
541
            else:
 
542
                new_parents = [revision_id]
 
543
            tree.set_parent_ids(new_parents)
599
544
 
600
545
    def id2abspath(self, file_id):
601
546
        return self.abspath(self.id2path(file_id))
602
547
 
603
 
    def has_id(self, file_id):
604
 
        # files that have been deleted are excluded
605
 
        inv = self.inventory
606
 
        if not inv.has_id(file_id):
607
 
            return False
608
 
        path = inv.id2path(file_id)
609
 
        return osutils.lexists(self.abspath(path))
610
 
 
611
 
    def has_or_had_id(self, file_id):
612
 
        if file_id == self.inventory.root.file_id:
613
 
            return True
614
 
        return self.inventory.has_id(file_id)
615
 
 
616
 
    __contains__ = has_id
 
548
    def _check_for_tree_references(self, iterator):
 
549
        """See if directories have become tree-references."""
 
550
        blocked_parent_ids = set()
 
551
        for path, ie in iterator:
 
552
            if ie.parent_id in blocked_parent_ids:
 
553
                # This entry was pruned because one of its parents became a
 
554
                # TreeReference. If this is a directory, mark it as blocked.
 
555
                if ie.kind == 'directory':
 
556
                    blocked_parent_ids.add(ie.file_id)
 
557
                continue
 
558
            if ie.kind == 'directory' and self._directory_is_tree_reference(path):
 
559
                # This InventoryDirectory needs to be a TreeReference
 
560
                ie = inventory.TreeReference(ie.file_id, ie.name, ie.parent_id)
 
561
                blocked_parent_ids.add(ie.file_id)
 
562
            yield path, ie
 
563
 
 
564
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
 
565
        """See Tree.iter_entries_by_dir()"""
 
566
        # The only trick here is that if we supports_tree_reference then we
 
567
        # need to detect if a directory becomes a tree-reference.
 
568
        iterator = super(WorkingTree, self).iter_entries_by_dir(
 
569
                specific_file_ids=specific_file_ids,
 
570
                yield_parents=yield_parents)
 
571
        if not self.supports_tree_reference():
 
572
            return iterator
 
573
        else:
 
574
            return self._check_for_tree_references(iterator)
617
575
 
618
576
    def get_file_size(self, file_id):
619
577
        """See Tree.get_file_size"""
627
585
            else:
628
586
                return None
629
587
 
630
 
    @needs_read_lock
631
 
    def get_file_sha1(self, file_id, path=None, stat_value=None):
632
 
        if not path:
633
 
            path = self._inventory.id2path(file_id)
634
 
        return self._hashcache.get_sha1(path, stat_value)
635
 
 
636
 
    def get_file_mtime(self, file_id, path=None):
637
 
        if not path:
638
 
            path = self.inventory.id2path(file_id)
639
 
        return os.lstat(self.abspath(path)).st_mtime
640
 
 
641
 
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
642
 
        file_id = self.path2id(path)
643
 
        if file_id is None:
644
 
            # For unversioned files on win32, we just assume they are not
645
 
            # executable
646
 
            return False
647
 
        return self._inventory[file_id].executable
648
 
 
649
 
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
650
 
        mode = stat_result.st_mode
651
 
        return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
652
 
 
653
 
    if not supports_executable():
654
 
        def is_executable(self, file_id, path=None):
655
 
            return self._inventory[file_id].executable
656
 
 
657
 
        _is_executable_from_path_and_stat = \
658
 
            _is_executable_from_path_and_stat_from_basis
659
 
    else:
660
 
        def is_executable(self, file_id, path=None):
661
 
            if not path:
662
 
                path = self.id2path(file_id)
663
 
            mode = os.lstat(self.abspath(path)).st_mode
664
 
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
665
 
 
666
 
        _is_executable_from_path_and_stat = \
667
 
            _is_executable_from_path_and_stat_from_stat
668
 
 
669
 
    @needs_tree_write_lock
670
 
    def _add(self, files, ids, kinds):
671
 
        """See MutableTree._add."""
672
 
        # TODO: Re-adding a file that is removed in the working copy
673
 
        # should probably put it back with the previous ID.
674
 
        # the read and write working inventory should not occur in this
675
 
        # function - they should be part of lock_write and unlock.
676
 
        inv = self.inventory
677
 
        for f, file_id, kind in zip(files, ids, kinds):
678
 
            if file_id is None:
679
 
                inv.add_path(f, kind=kind)
680
 
            else:
681
 
                inv.add_path(f, kind=kind, file_id=file_id)
682
 
            self._inventory_is_modified = True
683
 
 
684
588
    @needs_tree_write_lock
685
589
    def _gather_kinds(self, files, kinds):
686
590
        """See MutableTree._gather_kinds."""
701
605
        and setting the list to its value plus revision_id.
702
606
 
703
607
        :param revision_id: The revision id to add to the parent list. It may
704
 
        be a ghost revision as long as its not the first parent to be added,
705
 
        or the allow_leftmost_as_ghost parameter is set True.
 
608
            be a ghost revision as long as its not the first parent to be
 
609
            added, or the allow_leftmost_as_ghost parameter is set True.
706
610
        :param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
707
611
        """
708
612
        parents = self.get_parent_ids() + [revision_id]
811
715
            if revision_id in heads and revision_id not in new_revision_ids:
812
716
                new_revision_ids.append(revision_id)
813
717
        if new_revision_ids != revision_ids:
814
 
            trace.mutter('requested to set revision_ids = %s,'
 
718
            mutter('requested to set revision_ids = %s,'
815
719
                         ' but filtered to %s', revision_ids, new_revision_ids)
816
720
        return new_revision_ids
817
721
 
843
747
        self._set_merges_from_parent_ids(revision_ids)
844
748
 
845
749
    @needs_tree_write_lock
846
 
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
847
 
        """See MutableTree.set_parent_trees."""
848
 
        parent_ids = [rev for (rev, tree) in parents_list]
849
 
        for revision_id in parent_ids:
850
 
            _mod_revision.check_not_reserved_id(revision_id)
851
 
 
852
 
        self._check_parents_for_ghosts(parent_ids,
853
 
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
854
 
 
855
 
        parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
856
 
 
857
 
        if len(parent_ids) == 0:
858
 
            leftmost_parent_id = _mod_revision.NULL_REVISION
859
 
            leftmost_parent_tree = None
860
 
        else:
861
 
            leftmost_parent_id, leftmost_parent_tree = parents_list[0]
862
 
 
863
 
        if self._change_last_revision(leftmost_parent_id):
864
 
            if leftmost_parent_tree is None:
865
 
                # If we don't have a tree, fall back to reading the
866
 
                # parent tree from the repository.
867
 
                self._cache_basis_inventory(leftmost_parent_id)
868
 
            else:
869
 
                inv = leftmost_parent_tree.inventory
870
 
                xml = self._create_basis_xml_from_inventory(
871
 
                                        leftmost_parent_id, inv)
872
 
                self._write_basis_inventory(xml)
873
 
        self._set_merges_from_parent_ids(parent_ids)
874
 
 
875
 
    @needs_tree_write_lock
876
750
    def set_pending_merges(self, rev_list):
877
751
        parents = self.get_parent_ids()
878
752
        leftmost = parents[:1]
881
755
 
882
756
    @needs_tree_write_lock
883
757
    def set_merge_modified(self, modified_hashes):
884
 
        def iter_stanzas():
885
 
            for file_id, hash in modified_hashes.iteritems():
886
 
                yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
887
 
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
 
758
        """Set the merge modified hashes."""
 
759
        raise NotImplementedError(self.set_merge_modified)
888
760
 
889
761
    def _sha_from_stat(self, path, stat_result):
890
762
        """Get a sha digest from the tree's stat cache.
896
768
        """
897
769
        return None
898
770
 
899
 
    def _put_rio(self, filename, stanzas, header):
900
 
        self._must_be_locked()
901
 
        my_file = rio_file(stanzas, header)
902
 
        self._transport.put_file(filename, my_file,
903
 
            mode=self.bzrdir._get_file_mode())
904
 
 
905
771
    @needs_write_lock # because merge pulls data into the branch.
906
772
    def merge_from_branch(self, branch, to_revision=None, from_revision=None,
907
773
                          merge_type=None, force=False):
946
812
        merger.set_pending()
947
813
        return conflicts
948
814
 
949
 
    @needs_read_lock
950
815
    def merge_modified(self):
951
816
        """Return a dictionary of files modified by a merge.
952
817
 
957
822
        This returns a map of file_id->sha1, containing only files which are
958
823
        still in the working inventory and have that text hash.
959
824
        """
960
 
        try:
961
 
            hashfile = self._transport.get('merge-hashes')
962
 
        except errors.NoSuchFile:
963
 
            return {}
964
 
        try:
965
 
            merge_hashes = {}
966
 
            try:
967
 
                if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
968
 
                    raise errors.MergeModifiedFormatError()
969
 
            except StopIteration:
970
 
                raise errors.MergeModifiedFormatError()
971
 
            for s in RioReader(hashfile):
972
 
                # RioReader reads in Unicode, so convert file_ids back to utf8
973
 
                file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
974
 
                if file_id not in self.inventory:
975
 
                    continue
976
 
                text_hash = s.get("hash")
977
 
                if text_hash == self.get_file_sha1(file_id):
978
 
                    merge_hashes[file_id] = text_hash
979
 
            return merge_hashes
980
 
        finally:
981
 
            hashfile.close()
 
825
        raise NotImplementedError(self.merge_modified)
982
826
 
983
827
    @needs_write_lock
984
828
    def mkdir(self, path, file_id=None):
989
833
        self.add(path, file_id, 'directory')
990
834
        return file_id
991
835
 
992
 
    def get_symlink_target(self, file_id):
993
 
        abspath = self.id2abspath(file_id)
 
836
    def get_symlink_target(self, file_id, path=None):
 
837
        if path is not None:
 
838
            abspath = self.abspath(path)
 
839
        else:
 
840
            abspath = self.id2abspath(file_id)
994
841
        target = osutils.readlink(abspath)
995
842
        return target
996
843
 
997
 
    @needs_write_lock
998
844
    def subsume(self, other_tree):
999
 
        def add_children(inventory, entry):
1000
 
            for child_entry in entry.children.values():
1001
 
                inventory._byid[child_entry.file_id] = child_entry
1002
 
                if child_entry.kind == 'directory':
1003
 
                    add_children(inventory, child_entry)
1004
 
        if other_tree.get_root_id() == self.get_root_id():
1005
 
            raise errors.BadSubsumeSource(self, other_tree,
1006
 
                                          'Trees have the same root')
1007
 
        try:
1008
 
            other_tree_path = self.relpath(other_tree.basedir)
1009
 
        except errors.PathNotChild:
1010
 
            raise errors.BadSubsumeSource(self, other_tree,
1011
 
                'Tree is not contained by the other')
1012
 
        new_root_parent = self.path2id(osutils.dirname(other_tree_path))
1013
 
        if new_root_parent is None:
1014
 
            raise errors.BadSubsumeSource(self, other_tree,
1015
 
                'Parent directory is not versioned.')
1016
 
        # We need to ensure that the result of a fetch will have a
1017
 
        # versionedfile for the other_tree root, and only fetching into
1018
 
        # RepositoryKnit2 guarantees that.
1019
 
        if not self.branch.repository.supports_rich_root():
1020
 
            raise errors.SubsumeTargetNeedsUpgrade(other_tree)
1021
 
        other_tree.lock_tree_write()
1022
 
        try:
1023
 
            new_parents = other_tree.get_parent_ids()
1024
 
            other_root = other_tree.inventory.root
1025
 
            other_root.parent_id = new_root_parent
1026
 
            other_root.name = osutils.basename(other_tree_path)
1027
 
            self.inventory.add(other_root)
1028
 
            add_children(self.inventory, other_root)
1029
 
            self._write_inventory(self.inventory)
1030
 
            # normally we don't want to fetch whole repositories, but i think
1031
 
            # here we really do want to consolidate the whole thing.
1032
 
            for parent_id in other_tree.get_parent_ids():
1033
 
                self.branch.fetch(other_tree.branch, parent_id)
1034
 
                self.add_parent_tree_id(parent_id)
1035
 
        finally:
1036
 
            other_tree.unlock()
1037
 
        other_tree.bzrdir.retire_bzrdir()
 
845
        raise NotImplementedError(self.subsume)
1038
846
 
1039
847
    def _setup_directory_is_tree_reference(self):
1040
848
        if self._branch.repository._format.supports_tree_reference:
1062
870
        # checkout in a subdirectory.  This can be avoided by not adding
1063
871
        # it.  mbp 20070306
1064
872
 
1065
 
    @needs_tree_write_lock
1066
873
    def extract(self, file_id, format=None):
1067
874
        """Extract a subtree from this tree.
1068
875
 
1069
876
        A new branch will be created, relative to the path for this tree.
1070
877
        """
1071
 
        self.flush()
1072
 
        def mkdirs(path):
1073
 
            segments = osutils.splitpath(path)
1074
 
            transport = self.branch.bzrdir.root_transport
1075
 
            for name in segments:
1076
 
                transport = transport.clone(name)
1077
 
                transport.ensure_base()
1078
 
            return transport
1079
 
 
1080
 
        sub_path = self.id2path(file_id)
1081
 
        branch_transport = mkdirs(sub_path)
1082
 
        if format is None:
1083
 
            format = self.bzrdir.cloning_metadir()
1084
 
        branch_transport.ensure_base()
1085
 
        branch_bzrdir = format.initialize_on_transport(branch_transport)
1086
 
        try:
1087
 
            repo = branch_bzrdir.find_repository()
1088
 
        except errors.NoRepositoryPresent:
1089
 
            repo = branch_bzrdir.create_repository()
1090
 
        if not repo.supports_rich_root():
1091
 
            raise errors.RootNotRich()
1092
 
        new_branch = branch_bzrdir.create_branch()
1093
 
        new_branch.pull(self.branch)
1094
 
        for parent_id in self.get_parent_ids():
1095
 
            new_branch.fetch(self.branch, parent_id)
1096
 
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
1097
 
        if tree_transport.base != branch_transport.base:
1098
 
            tree_bzrdir = format.initialize_on_transport(tree_transport)
1099
 
            branch.BranchReferenceFormat().initialize(tree_bzrdir,
1100
 
                target_branch=new_branch)
1101
 
        else:
1102
 
            tree_bzrdir = branch_bzrdir
1103
 
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1104
 
        wt.set_parent_ids(self.get_parent_ids())
1105
 
        my_inv = self.inventory
1106
 
        child_inv = inventory.Inventory(root_id=None)
1107
 
        new_root = my_inv[file_id]
1108
 
        my_inv.remove_recursive_id(file_id)
1109
 
        new_root.parent_id = None
1110
 
        child_inv.add(new_root)
1111
 
        self._write_inventory(my_inv)
1112
 
        wt._write_inventory(child_inv)
1113
 
        return wt
1114
 
 
1115
 
    def _serialize(self, inventory, out_file):
1116
 
        xml5.serializer_v5.write_inventory(self._inventory, out_file,
1117
 
            working=True)
1118
 
 
1119
 
    def _deserialize(selt, in_file):
1120
 
        return xml5.serializer_v5.read_inventory(in_file)
 
878
        raise NotImplementedError(self.extract)
1121
879
 
1122
880
    def flush(self):
1123
 
        """Write the in memory inventory to disk."""
1124
 
        # TODO: Maybe this should only write on dirty ?
1125
 
        if self._control_files._lock_mode != 'w':
1126
 
            raise errors.NotWriteLocked(self)
1127
 
        sio = StringIO()
1128
 
        self._serialize(self._inventory, sio)
1129
 
        sio.seek(0)
1130
 
        self._transport.put_file('inventory', sio,
1131
 
            mode=self.bzrdir._get_file_mode())
1132
 
        self._inventory_is_modified = False
 
881
        """Write the in memory meta data to disk."""
 
882
        raise NotImplementedError(self.flush)
1133
883
 
1134
884
    def _kind(self, relpath):
1135
885
        return osutils.file_kind(self.abspath(relpath))
1145
895
        :param from_dir: start from this directory or None for the root
1146
896
        :param recursive: whether to recurse into subdirectories or not
1147
897
        """
1148
 
        # list_files is an iterator, so @needs_read_lock doesn't work properly
1149
 
        # with it. So callers should be careful to always read_lock the tree.
1150
 
        if not self.is_locked():
1151
 
            raise errors.ObjectNotLocked(self)
1152
 
 
1153
 
        inv = self.inventory
1154
 
        if from_dir is None and include_root is True:
1155
 
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1156
 
        # Convert these into local objects to save lookup times
1157
 
        pathjoin = osutils.pathjoin
1158
 
        file_kind = self._kind
1159
 
 
1160
 
        # transport.base ends in a slash, we want the piece
1161
 
        # between the last two slashes
1162
 
        transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1163
 
 
1164
 
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1165
 
 
1166
 
        # directory file_id, relative path, absolute path, reverse sorted children
1167
 
        if from_dir is not None:
1168
 
            from_dir_id = inv.path2id(from_dir)
1169
 
            if from_dir_id is None:
1170
 
                # Directory not versioned
1171
 
                return
1172
 
            from_dir_abspath = pathjoin(self.basedir, from_dir)
1173
 
        else:
1174
 
            from_dir_id = inv.root.file_id
1175
 
            from_dir_abspath = self.basedir
1176
 
        children = os.listdir(from_dir_abspath)
1177
 
        children.sort()
1178
 
        # jam 20060527 The kernel sized tree seems equivalent whether we
1179
 
        # use a deque and popleft to keep them sorted, or if we use a plain
1180
 
        # list and just reverse() them.
1181
 
        children = collections.deque(children)
1182
 
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
1183
 
        while stack:
1184
 
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1185
 
 
1186
 
            while children:
1187
 
                f = children.popleft()
1188
 
                ## TODO: If we find a subdirectory with its own .bzr
1189
 
                ## directory, then that is a separate tree and we
1190
 
                ## should exclude it.
1191
 
 
1192
 
                # the bzrdir for this tree
1193
 
                if transport_base_dir == f:
1194
 
                    continue
1195
 
 
1196
 
                # we know that from_dir_relpath and from_dir_abspath never end in a slash
1197
 
                # and 'f' doesn't begin with one, we can do a string op, rather
1198
 
                # than the checks of pathjoin(), all relative paths will have an extra slash
1199
 
                # at the beginning
1200
 
                fp = from_dir_relpath + '/' + f
1201
 
 
1202
 
                # absolute path
1203
 
                fap = from_dir_abspath + '/' + f
1204
 
 
1205
 
                f_ie = inv.get_child(from_dir_id, f)
1206
 
                if f_ie:
1207
 
                    c = 'V'
1208
 
                elif self.is_ignored(fp[1:]):
1209
 
                    c = 'I'
1210
 
                else:
1211
 
                    # we may not have found this file, because of a unicode issue
1212
 
                    f_norm, can_access = osutils.normalized_filename(f)
1213
 
                    if f == f_norm or not can_access:
1214
 
                        # No change, so treat this file normally
1215
 
                        c = '?'
1216
 
                    else:
1217
 
                        # this file can be accessed by a normalized path
1218
 
                        # check again if it is versioned
1219
 
                        # these lines are repeated here for performance
1220
 
                        f = f_norm
1221
 
                        fp = from_dir_relpath + '/' + f
1222
 
                        fap = from_dir_abspath + '/' + f
1223
 
                        f_ie = inv.get_child(from_dir_id, f)
1224
 
                        if f_ie:
1225
 
                            c = 'V'
1226
 
                        elif self.is_ignored(fp[1:]):
1227
 
                            c = 'I'
1228
 
                        else:
1229
 
                            c = '?'
1230
 
 
1231
 
                fk = file_kind(fap)
1232
 
 
1233
 
                # make a last minute entry
1234
 
                if f_ie:
1235
 
                    yield fp[1:], c, fk, f_ie.file_id, f_ie
1236
 
                else:
1237
 
                    try:
1238
 
                        yield fp[1:], c, fk, None, fk_entries[fk]()
1239
 
                    except KeyError:
1240
 
                        yield fp[1:], c, fk, None, TreeEntry()
1241
 
                    continue
1242
 
 
1243
 
                if fk != 'directory':
1244
 
                    continue
1245
 
 
1246
 
                # But do this child first if recursing down
1247
 
                if recursive:
1248
 
                    new_children = os.listdir(fap)
1249
 
                    new_children.sort()
1250
 
                    new_children = collections.deque(new_children)
1251
 
                    stack.append((f_ie.file_id, fp, fap, new_children))
1252
 
                    # Break out of inner loop,
1253
 
                    # so that we start outer loop with child
1254
 
                    break
1255
 
            else:
1256
 
                # if we finished all children, pop it off the stack
1257
 
                stack.pop()
1258
 
 
1259
 
    @needs_tree_write_lock
1260
 
    def move(self, from_paths, to_dir=None, after=False, **kwargs):
 
898
        raise NotImplementedError(self.list_files)
 
899
 
 
900
    def move(self, from_paths, to_dir=None, after=False):
1261
901
        """Rename files.
1262
902
 
1263
 
        to_dir must exist in the inventory.
 
903
        to_dir must be known to the working tree.
1264
904
 
1265
905
        If to_dir exists and is a directory, the files are moved into
1266
906
        it, keeping their old names.
1272
912
        independently.
1273
913
 
1274
914
        The first mode moves the file in the filesystem and updates the
1275
 
        inventory. The second mode only updates the inventory without
1276
 
        touching the file on the filesystem. This is the new mode introduced
1277
 
        in version 0.15.
 
915
        working tree metadata. The second mode only updates the working tree
 
916
        metadata without touching the file on the filesystem.
1278
917
 
1279
918
        move uses the second mode if 'after == True' and the target is not
1280
919
        versioned but present in the working tree.
1292
931
        This returns a list of (from_path, to_path) pairs for each
1293
932
        entry that is moved.
1294
933
        """
1295
 
        rename_entries = []
1296
 
        rename_tuples = []
1297
 
 
1298
 
        # check for deprecated use of signature
1299
 
        if to_dir is None:
1300
 
            to_dir = kwargs.get('to_name', None)
1301
 
            if to_dir is None:
1302
 
                raise TypeError('You must supply a target directory')
1303
 
            else:
1304
 
                symbol_versioning.warn('The parameter to_name was deprecated'
1305
 
                                       ' in version 0.13. Use to_dir instead',
1306
 
                                       DeprecationWarning)
1307
 
 
1308
 
        # check destination directory
1309
 
        if isinstance(from_paths, basestring):
1310
 
            raise ValueError()
1311
 
        inv = self.inventory
1312
 
        to_abs = self.abspath(to_dir)
1313
 
        if not isdir(to_abs):
1314
 
            raise errors.BzrMoveFailedError('',to_dir,
1315
 
                errors.NotADirectory(to_abs))
1316
 
        if not self.has_filename(to_dir):
1317
 
            raise errors.BzrMoveFailedError('',to_dir,
1318
 
                errors.NotInWorkingDirectory(to_dir))
1319
 
        to_dir_id = inv.path2id(to_dir)
1320
 
        if to_dir_id is None:
1321
 
            raise errors.BzrMoveFailedError('',to_dir,
1322
 
                errors.NotVersionedError(path=str(to_dir)))
1323
 
 
1324
 
        to_dir_ie = inv[to_dir_id]
1325
 
        if to_dir_ie.kind != 'directory':
1326
 
            raise errors.BzrMoveFailedError('',to_dir,
1327
 
                errors.NotADirectory(to_abs))
1328
 
 
1329
 
        # create rename entries and tuples
1330
 
        for from_rel in from_paths:
1331
 
            from_tail = splitpath(from_rel)[-1]
1332
 
            from_id = inv.path2id(from_rel)
1333
 
            if from_id is None:
1334
 
                raise errors.BzrMoveFailedError(from_rel,to_dir,
1335
 
                    errors.NotVersionedError(path=str(from_rel)))
1336
 
 
1337
 
            from_entry = inv[from_id]
1338
 
            from_parent_id = from_entry.parent_id
1339
 
            to_rel = pathjoin(to_dir, from_tail)
1340
 
            rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1341
 
                                         from_id=from_id,
1342
 
                                         from_tail=from_tail,
1343
 
                                         from_parent_id=from_parent_id,
1344
 
                                         to_rel=to_rel, to_tail=from_tail,
1345
 
                                         to_parent_id=to_dir_id)
1346
 
            rename_entries.append(rename_entry)
1347
 
            rename_tuples.append((from_rel, to_rel))
1348
 
 
1349
 
        # determine which move mode to use. checks also for movability
1350
 
        rename_entries = self._determine_mv_mode(rename_entries, after)
1351
 
 
1352
 
        original_modified = self._inventory_is_modified
1353
 
        try:
1354
 
            if len(from_paths):
1355
 
                self._inventory_is_modified = True
1356
 
            self._move(rename_entries)
1357
 
        except:
1358
 
            # restore the inventory on error
1359
 
            self._inventory_is_modified = original_modified
1360
 
            raise
1361
 
        self._write_inventory(inv)
1362
 
        return rename_tuples
1363
 
 
1364
 
    def _determine_mv_mode(self, rename_entries, after=False):
1365
 
        """Determines for each from-to pair if both inventory and working tree
1366
 
        or only the inventory has to be changed.
1367
 
 
1368
 
        Also does basic plausability tests.
1369
 
        """
1370
 
        inv = self.inventory
1371
 
 
1372
 
        for rename_entry in rename_entries:
1373
 
            # store to local variables for easier reference
1374
 
            from_rel = rename_entry.from_rel
1375
 
            from_id = rename_entry.from_id
1376
 
            to_rel = rename_entry.to_rel
1377
 
            to_id = inv.path2id(to_rel)
1378
 
            only_change_inv = False
1379
 
 
1380
 
            # check the inventory for source and destination
1381
 
            if from_id is None:
1382
 
                raise errors.BzrMoveFailedError(from_rel,to_rel,
1383
 
                    errors.NotVersionedError(path=str(from_rel)))
1384
 
            if to_id is not None:
1385
 
                raise errors.BzrMoveFailedError(from_rel,to_rel,
1386
 
                    errors.AlreadyVersionedError(path=str(to_rel)))
1387
 
 
1388
 
            # try to determine the mode for rename (only change inv or change
1389
 
            # inv and file system)
1390
 
            if after:
1391
 
                if not self.has_filename(to_rel):
1392
 
                    raise errors.BzrMoveFailedError(from_id,to_rel,
1393
 
                        errors.NoSuchFile(path=str(to_rel),
1394
 
                        extra="New file has not been created yet"))
1395
 
                only_change_inv = True
1396
 
            elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1397
 
                only_change_inv = True
1398
 
            elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1399
 
                only_change_inv = False
1400
 
            elif (not self.case_sensitive
1401
 
                  and from_rel.lower() == to_rel.lower()
1402
 
                  and self.has_filename(from_rel)):
1403
 
                only_change_inv = False
1404
 
            else:
1405
 
                # something is wrong, so lets determine what exactly
1406
 
                if not self.has_filename(from_rel) and \
1407
 
                   not self.has_filename(to_rel):
1408
 
                    raise errors.BzrRenameFailedError(from_rel,to_rel,
1409
 
                        errors.PathsDoNotExist(paths=(str(from_rel),
1410
 
                        str(to_rel))))
1411
 
                else:
1412
 
                    raise errors.RenameFailedFilesExist(from_rel, to_rel)
1413
 
            rename_entry.only_change_inv = only_change_inv
1414
 
        return rename_entries
1415
 
 
1416
 
    def _move(self, rename_entries):
1417
 
        """Moves a list of files.
1418
 
 
1419
 
        Depending on the value of the flag 'only_change_inv', the
1420
 
        file will be moved on the file system or not.
1421
 
        """
1422
 
        inv = self.inventory
1423
 
        moved = []
1424
 
 
1425
 
        for entry in rename_entries:
1426
 
            try:
1427
 
                self._move_entry(entry)
1428
 
            except:
1429
 
                self._rollback_move(moved)
1430
 
                raise
1431
 
            moved.append(entry)
1432
 
 
1433
 
    def _rollback_move(self, moved):
1434
 
        """Try to rollback a previous move in case of an filesystem error."""
1435
 
        inv = self.inventory
1436
 
        for entry in moved:
1437
 
            try:
1438
 
                self._move_entry(WorkingTree._RenameEntry(
1439
 
                    entry.to_rel, entry.from_id,
1440
 
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
1441
 
                    entry.from_tail, entry.from_parent_id,
1442
 
                    entry.only_change_inv))
1443
 
            except errors.BzrMoveFailedError, e:
1444
 
                raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1445
 
                        " The working tree is in an inconsistent state."
1446
 
                        " Please consider doing a 'bzr revert'."
1447
 
                        " Error message is: %s" % e)
1448
 
 
1449
 
    def _move_entry(self, entry):
1450
 
        inv = self.inventory
1451
 
        from_rel_abs = self.abspath(entry.from_rel)
1452
 
        to_rel_abs = self.abspath(entry.to_rel)
1453
 
        if from_rel_abs == to_rel_abs:
1454
 
            raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1455
 
                "Source and target are identical.")
1456
 
 
1457
 
        if not entry.only_change_inv:
1458
 
            try:
1459
 
                osutils.rename(from_rel_abs, to_rel_abs)
1460
 
            except OSError, e:
1461
 
                raise errors.BzrMoveFailedError(entry.from_rel,
1462
 
                    entry.to_rel, e[1])
1463
 
        inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
 
934
        raise NotImplementedError(self.move)
1464
935
 
1465
936
    @needs_tree_write_lock
1466
937
    def rename_one(self, from_rel, to_rel, after=False):
1470
941
 
1471
942
        rename_one has several 'modes' to work. First, it can rename a physical
1472
943
        file and change the file_id. That is the normal mode. Second, it can
1473
 
        only change the file_id without touching any physical file. This is
1474
 
        the new mode introduced in version 0.15.
 
944
        only change the file_id without touching any physical file.
1475
945
 
1476
 
        rename_one uses the second mode if 'after == True' and 'to_rel' is not
1477
 
        versioned but present in the working tree.
 
946
        rename_one uses the second mode if 'after == True' and 'to_rel' is
 
947
        either not versioned or newly added, and present in the working tree.
1478
948
 
1479
949
        rename_one uses the second mode if 'after == False' and 'from_rel' is
1480
950
        versioned but no longer in the working tree, and 'to_rel' is not
1486
956
 
1487
957
        Everything else results in an error.
1488
958
        """
1489
 
        inv = self.inventory
1490
 
        rename_entries = []
1491
 
 
1492
 
        # create rename entries and tuples
1493
 
        from_tail = splitpath(from_rel)[-1]
1494
 
        from_id = inv.path2id(from_rel)
1495
 
        if from_id is None:
1496
 
            # if file is missing in the inventory maybe it's in the basis_tree
1497
 
            basis_tree = self.branch.basis_tree()
1498
 
            from_id = basis_tree.path2id(from_rel)
1499
 
            if from_id is None:
1500
 
                raise errors.BzrRenameFailedError(from_rel,to_rel,
1501
 
                    errors.NotVersionedError(path=str(from_rel)))
1502
 
            # put entry back in the inventory so we can rename it
1503
 
            from_entry = basis_tree.inventory[from_id].copy()
1504
 
            inv.add(from_entry)
1505
 
        else:
1506
 
            from_entry = inv[from_id]
1507
 
        from_parent_id = from_entry.parent_id
1508
 
        to_dir, to_tail = os.path.split(to_rel)
1509
 
        to_dir_id = inv.path2id(to_dir)
1510
 
        rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1511
 
                                     from_id=from_id,
1512
 
                                     from_tail=from_tail,
1513
 
                                     from_parent_id=from_parent_id,
1514
 
                                     to_rel=to_rel, to_tail=to_tail,
1515
 
                                     to_parent_id=to_dir_id)
1516
 
        rename_entries.append(rename_entry)
1517
 
 
1518
 
        # determine which move mode to use. checks also for movability
1519
 
        rename_entries = self._determine_mv_mode(rename_entries, after)
1520
 
 
1521
 
        # check if the target changed directory and if the target directory is
1522
 
        # versioned
1523
 
        if to_dir_id is None:
1524
 
            raise errors.BzrMoveFailedError(from_rel,to_rel,
1525
 
                errors.NotVersionedError(path=str(to_dir)))
1526
 
 
1527
 
        # all checks done. now we can continue with our actual work
1528
 
        mutter('rename_one:\n'
1529
 
               '  from_id   {%s}\n'
1530
 
               '  from_rel: %r\n'
1531
 
               '  to_rel:   %r\n'
1532
 
               '  to_dir    %r\n'
1533
 
               '  to_dir_id {%s}\n',
1534
 
               from_id, from_rel, to_rel, to_dir, to_dir_id)
1535
 
 
1536
 
        self._move(rename_entries)
1537
 
        self._write_inventory(inv)
1538
 
 
1539
 
    class _RenameEntry(object):
1540
 
        def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1541
 
                     to_rel, to_tail, to_parent_id, only_change_inv=False):
1542
 
            self.from_rel = from_rel
1543
 
            self.from_id = from_id
1544
 
            self.from_tail = from_tail
1545
 
            self.from_parent_id = from_parent_id
1546
 
            self.to_rel = to_rel
1547
 
            self.to_tail = to_tail
1548
 
            self.to_parent_id = to_parent_id
1549
 
            self.only_change_inv = only_change_inv
 
959
        raise NotImplementedError(self.rename_one)
1550
960
 
1551
961
    @needs_read_lock
1552
962
    def unknowns(self):
1560
970
        return iter(
1561
971
            [subp for subp in self.extras() if not self.is_ignored(subp)])
1562
972
 
1563
 
    @needs_tree_write_lock
1564
973
    def unversion(self, file_ids):
1565
974
        """Remove the file ids in file_ids from the current versioned set.
1566
975
 
1570
979
        :param file_ids: The file ids to stop versioning.
1571
980
        :raises: NoSuchId if any fileid is not currently versioned.
1572
981
        """
1573
 
        for file_id in file_ids:
1574
 
            if file_id not in self._inventory:
1575
 
                raise errors.NoSuchId(self, file_id)
1576
 
        for file_id in file_ids:
1577
 
            if self._inventory.has_id(file_id):
1578
 
                self._inventory.remove_recursive_id(file_id)
1579
 
        if len(file_ids):
1580
 
            # in the future this should just set a dirty bit to wait for the
1581
 
            # final unlock. However, until all methods of workingtree start
1582
 
            # with the current in -memory inventory rather than triggering
1583
 
            # a read, it is more complex - we need to teach read_inventory
1584
 
            # to know when to read, and when to not read first... and possibly
1585
 
            # to save first when the in memory one may be corrupted.
1586
 
            # so for now, we just only write it if it is indeed dirty.
1587
 
            # - RBC 20060907
1588
 
            self._write_inventory(self._inventory)
1589
 
 
1590
 
    def _iter_conflicts(self):
1591
 
        conflicted = set()
1592
 
        for info in self.list_files():
1593
 
            path = info[0]
1594
 
            stem = get_conflicted_stem(path)
1595
 
            if stem is None:
1596
 
                continue
1597
 
            if stem not in conflicted:
1598
 
                conflicted.add(stem)
1599
 
                yield stem
 
982
        raise NotImplementedError(self.unversion)
1600
983
 
1601
984
    @needs_write_lock
1602
985
    def pull(self, source, overwrite=False, stop_revision=None,
1603
 
             change_reporter=None, possible_transports=None, local=False):
 
986
             change_reporter=None, possible_transports=None, local=False,
 
987
             show_base=False):
1604
988
        source.lock_read()
1605
989
        try:
1606
990
            old_revision_info = self.branch.last_revision_info()
1611
995
            new_revision_info = self.branch.last_revision_info()
1612
996
            if new_revision_info != old_revision_info:
1613
997
                repository = self.branch.repository
 
998
                if repository._format.fast_deltas:
 
999
                    parent_ids = self.get_parent_ids()
 
1000
                    if parent_ids:
 
1001
                        basis_id = parent_ids[0]
 
1002
                        basis_tree = repository.revision_tree(basis_id)
1614
1003
                basis_tree.lock_read()
1615
1004
                try:
1616
1005
                    new_basis_tree = self.branch.basis_tree()
1620
1009
                                basis_tree,
1621
1010
                                this_tree=self,
1622
1011
                                pb=None,
1623
 
                                change_reporter=change_reporter)
 
1012
                                change_reporter=change_reporter,
 
1013
                                show_base=show_base)
1624
1014
                    basis_root_id = basis_tree.get_root_id()
1625
1015
                    new_root_id = new_basis_tree.get_root_id()
1626
 
                    if basis_root_id != new_root_id:
 
1016
                    if new_root_id is not None and basis_root_id != new_root_id:
1627
1017
                        self.set_root_id(new_root_id)
1628
1018
                finally:
1629
1019
                    basis_tree.unlock()
1630
1020
                # TODO - dedup parents list with things merged by pull ?
1631
1021
                # reuse the revisiontree we merged against to set the new
1632
1022
                # tree data.
1633
 
                parent_trees = [(self.branch.last_revision(), new_basis_tree)]
 
1023
                parent_trees = []
 
1024
                if self.branch.last_revision() != _mod_revision.NULL_REVISION:
 
1025
                    parent_trees.append(
 
1026
                        (self.branch.last_revision(), new_basis_tree))
1634
1027
                # we have to pull the merge trees out again, because
1635
1028
                # merge_inner has set the ids. - this corner is not yet
1636
1029
                # layered well enough to prevent double handling.
1653
1046
            stream.write(bytes)
1654
1047
        finally:
1655
1048
            stream.close()
1656
 
        # TODO: update the hashcache here ?
1657
1049
 
1658
1050
    def extras(self):
1659
1051
        """Yield all unversioned files in this WorkingTree.
1665
1057
        Currently returned depth-first, sorted by name within directories.
1666
1058
        This is the same order used by 'osutils.walkdirs'.
1667
1059
        """
1668
 
        ## TODO: Work from given directory downwards
1669
 
        for path, dir_entry in self.inventory.directories():
1670
 
            # mutter("search for unknowns in %r", path)
1671
 
            dirabs = self.abspath(path)
1672
 
            if not isdir(dirabs):
1673
 
                # e.g. directory deleted
1674
 
                continue
1675
 
 
1676
 
            fl = []
1677
 
            for subf in os.listdir(dirabs):
1678
 
                if self.bzrdir.is_control_filename(subf):
1679
 
                    continue
1680
 
                if subf not in dir_entry.children:
1681
 
                    try:
1682
 
                        (subf_norm,
1683
 
                         can_access) = osutils.normalized_filename(subf)
1684
 
                    except UnicodeDecodeError:
1685
 
                        path_os_enc = path.encode(osutils._fs_enc)
1686
 
                        relpath = path_os_enc + '/' + subf
1687
 
                        raise errors.BadFilenameEncoding(relpath,
1688
 
                                                         osutils._fs_enc)
1689
 
                    if subf_norm != subf and can_access:
1690
 
                        if subf_norm not in dir_entry.children:
1691
 
                            fl.append(subf_norm)
1692
 
                    else:
1693
 
                        fl.append(subf)
1694
 
 
1695
 
            fl.sort()
1696
 
            for subf in fl:
1697
 
                subp = pathjoin(path, subf)
1698
 
                yield subp
 
1060
        raise NotImplementedError(self.extras)
1699
1061
 
1700
1062
    def ignored_files(self):
1701
1063
        """Yield list of PATH, IGNORE_PATTERN"""
1750
1112
 
1751
1113
    def stored_kind(self, file_id):
1752
1114
        """See Tree.stored_kind"""
1753
 
        return self.inventory[file_id].kind
 
1115
        raise NotImplementedError(self.stored_kind)
1754
1116
 
1755
1117
    def _comparison_data(self, entry, path):
1756
1118
        abspath = self.abspath(path)
1766
1128
        else:
1767
1129
            mode = stat_value.st_mode
1768
1130
            kind = osutils.file_kind_from_stat_mode(mode)
1769
 
            if not supports_executable():
 
1131
            if not self._supports_executable():
1770
1132
                executable = entry is not None and entry.executable
1771
1133
            else:
1772
1134
                executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1791
1153
        return _mod_revision.ensure_null(self.branch.last_revision())
1792
1154
 
1793
1155
    def is_locked(self):
1794
 
        return self._control_files.is_locked()
1795
 
 
1796
 
    def _must_be_locked(self):
1797
 
        if not self.is_locked():
1798
 
            raise errors.ObjectNotLocked(self)
 
1156
        """Check if this tree is locked."""
 
1157
        raise NotImplementedError(self.is_locked)
1799
1158
 
1800
1159
    def lock_read(self):
1801
 
        """See Branch.lock_read, and WorkingTree.unlock."""
1802
 
        if not self.is_locked():
1803
 
            self._reset_data()
1804
 
        self.branch.lock_read()
1805
 
        try:
1806
 
            return self._control_files.lock_read()
1807
 
        except:
1808
 
            self.branch.unlock()
1809
 
            raise
 
1160
        """Lock the tree for reading.
 
1161
 
 
1162
        This also locks the branch, and can be unlocked via self.unlock().
 
1163
 
 
1164
        :return: A bzrlib.lock.LogicalLockResult.
 
1165
        """
 
1166
        raise NotImplementedError(self.lock_read)
1810
1167
 
1811
1168
    def lock_tree_write(self):
1812
 
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1813
 
        if not self.is_locked():
1814
 
            self._reset_data()
1815
 
        self.branch.lock_read()
1816
 
        try:
1817
 
            return self._control_files.lock_write()
1818
 
        except:
1819
 
            self.branch.unlock()
1820
 
            raise
 
1169
        """See MutableTree.lock_tree_write, and WorkingTree.unlock.
 
1170
 
 
1171
        :return: A bzrlib.lock.LogicalLockResult.
 
1172
        """
 
1173
        raise NotImplementedError(self.lock_tree_write)
1821
1174
 
1822
1175
    def lock_write(self):
1823
 
        """See MutableTree.lock_write, and WorkingTree.unlock."""
1824
 
        if not self.is_locked():
1825
 
            self._reset_data()
1826
 
        self.branch.lock_write()
1827
 
        try:
1828
 
            return self._control_files.lock_write()
1829
 
        except:
1830
 
            self.branch.unlock()
1831
 
            raise
 
1176
        """See MutableTree.lock_write, and WorkingTree.unlock.
 
1177
 
 
1178
        :return: A bzrlib.lock.LogicalLockResult.
 
1179
        """
 
1180
        raise NotImplementedError(self.lock_write)
1832
1181
 
1833
1182
    def get_physical_lock_status(self):
1834
 
        return self._control_files.get_physical_lock_status()
1835
 
 
1836
 
    def _basis_inventory_name(self):
1837
 
        return 'basis-inventory-cache'
1838
 
 
1839
 
    def _reset_data(self):
1840
 
        """Reset transient data that cannot be revalidated."""
1841
 
        self._inventory_is_modified = False
1842
 
        f = self._transport.get('inventory')
1843
 
        try:
1844
 
            result = self._deserialize(f)
1845
 
        finally:
1846
 
            f.close()
1847
 
        self._set_inventory(result, dirty=False)
1848
 
 
1849
 
    @needs_tree_write_lock
 
1183
        raise NotImplementedError(self.get_physical_lock_status)
 
1184
 
1850
1185
    def set_last_revision(self, new_revision):
1851
1186
        """Change the last revision in the working tree."""
1852
 
        if self._change_last_revision(new_revision):
1853
 
            self._cache_basis_inventory(new_revision)
 
1187
        raise NotImplementedError(self.set_last_revision)
1854
1188
 
1855
1189
    def _change_last_revision(self, new_revision):
1856
1190
        """Template method part of set_last_revision to perform the change.
1859
1193
        when their last revision is set.
1860
1194
        """
1861
1195
        if _mod_revision.is_null(new_revision):
1862
 
            self.branch.set_revision_history([])
 
1196
            self.branch.set_last_revision_info(0, new_revision)
1863
1197
            return False
 
1198
        _mod_revision.check_not_reserved_id(new_revision)
1864
1199
        try:
1865
1200
            self.branch.generate_revision_history(new_revision)
1866
1201
        except errors.NoSuchRevision:
1867
1202
            # not present in the repo - dont try to set it deeper than the tip
1868
 
            self.branch.set_revision_history([new_revision])
 
1203
            self.branch._set_revision_history([new_revision])
1869
1204
        return True
1870
1205
 
1871
 
    def _write_basis_inventory(self, xml):
1872
 
        """Write the basis inventory XML to the basis-inventory file"""
1873
 
        path = self._basis_inventory_name()
1874
 
        sio = StringIO(xml)
1875
 
        self._transport.put_file(path, sio,
1876
 
            mode=self.bzrdir._get_file_mode())
1877
 
 
1878
 
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
1879
 
        """Create the text that will be saved in basis-inventory"""
1880
 
        inventory.revision_id = revision_id
1881
 
        return xml7.serializer_v7.write_inventory_to_string(inventory)
1882
 
 
1883
 
    def _cache_basis_inventory(self, new_revision):
1884
 
        """Cache new_revision as the basis inventory."""
1885
 
        # TODO: this should allow the ready-to-use inventory to be passed in,
1886
 
        # as commit already has that ready-to-use [while the format is the
1887
 
        # same, that is].
1888
 
        try:
1889
 
            # this double handles the inventory - unpack and repack -
1890
 
            # but is easier to understand. We can/should put a conditional
1891
 
            # in here based on whether the inventory is in the latest format
1892
 
            # - perhaps we should repack all inventories on a repository
1893
 
            # upgrade ?
1894
 
            # the fast path is to copy the raw xml from the repository. If the
1895
 
            # xml contains 'revision_id="', then we assume the right
1896
 
            # revision_id is set. We must check for this full string, because a
1897
 
            # root node id can legitimately look like 'revision_id' but cannot
1898
 
            # contain a '"'.
1899
 
            xml = self.branch.repository._get_inventory_xml(new_revision)
1900
 
            firstline = xml.split('\n', 1)[0]
1901
 
            if (not 'revision_id="' in firstline or
1902
 
                'format="7"' not in firstline):
1903
 
                inv = self.branch.repository._serializer.read_inventory_from_string(
1904
 
                    xml, new_revision)
1905
 
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
1906
 
            self._write_basis_inventory(xml)
1907
 
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1908
 
            pass
1909
 
 
1910
 
    def read_basis_inventory(self):
1911
 
        """Read the cached basis inventory."""
1912
 
        path = self._basis_inventory_name()
1913
 
        return self._transport.get_bytes(path)
1914
 
 
1915
 
    @needs_read_lock
1916
 
    def read_working_inventory(self):
1917
 
        """Read the working inventory.
1918
 
 
1919
 
        :raises errors.InventoryModified: read_working_inventory will fail
1920
 
            when the current in memory inventory has been modified.
1921
 
        """
1922
 
        # conceptually this should be an implementation detail of the tree.
1923
 
        # XXX: Deprecate this.
1924
 
        # ElementTree does its own conversion from UTF-8, so open in
1925
 
        # binary.
1926
 
        if self._inventory_is_modified:
1927
 
            raise errors.InventoryModified(self)
1928
 
        f = self._transport.get('inventory')
1929
 
        try:
1930
 
            result = self._deserialize(f)
1931
 
        finally:
1932
 
            f.close()
1933
 
        self._set_inventory(result, dirty=False)
1934
 
        return result
1935
 
 
1936
1206
    @needs_tree_write_lock
1937
1207
    def remove(self, files, verbose=False, to_file=None, keep_files=True,
1938
1208
        force=False):
1939
 
        """Remove nominated files from the working inventory.
 
1209
        """Remove nominated files from the working tree metadata.
1940
1210
 
1941
1211
        :files: File paths relative to the basedir.
1942
1212
        :keep_files: If true, the files will also be kept.
1948
1218
 
1949
1219
        inv_delta = []
1950
1220
 
1951
 
        new_files=set()
 
1221
        all_files = set() # specified and nested files 
1952
1222
        unknown_nested_files=set()
1953
1223
        if to_file is None:
1954
1224
            to_file = sys.stdout
1955
1225
 
 
1226
        files_to_backup = []
 
1227
 
1956
1228
        def recurse_directory_to_add_files(directory):
1957
1229
            # Recurse directory and add all files
1958
1230
            # so we can check if they have changed.
1959
 
            for parent_info, file_infos in\
1960
 
                self.walkdirs(directory):
 
1231
            for parent_info, file_infos in self.walkdirs(directory):
1961
1232
                for relpath, basename, kind, lstat, fileid, kind in file_infos:
1962
1233
                    # Is it versioned or ignored?
1963
 
                    if self.path2id(relpath) or self.is_ignored(relpath):
 
1234
                    if self.path2id(relpath):
1964
1235
                        # Add nested content for deletion.
1965
 
                        new_files.add(relpath)
 
1236
                        all_files.add(relpath)
1966
1237
                    else:
1967
 
                        # Files which are not versioned and not ignored
 
1238
                        # Files which are not versioned
1968
1239
                        # should be treated as unknown.
1969
 
                        unknown_nested_files.add((relpath, None, kind))
 
1240
                        files_to_backup.append(relpath)
1970
1241
 
1971
1242
        for filename in files:
1972
1243
            # Get file name into canonical form.
1973
1244
            abspath = self.abspath(filename)
1974
1245
            filename = self.relpath(abspath)
1975
1246
            if len(filename) > 0:
1976
 
                new_files.add(filename)
 
1247
                all_files.add(filename)
1977
1248
                recurse_directory_to_add_files(filename)
1978
1249
 
1979
 
        files = list(new_files)
 
1250
        files = list(all_files)
1980
1251
 
1981
1252
        if len(files) == 0:
1982
1253
            return # nothing to do
1986
1257
 
1987
1258
        # Bail out if we are going to delete files we shouldn't
1988
1259
        if not keep_files and not force:
1989
 
            has_changed_files = len(unknown_nested_files) > 0
1990
 
            if not has_changed_files:
1991
 
                for (file_id, path, content_change, versioned, parent_id, name,
1992
 
                     kind, executable) in self.iter_changes(self.basis_tree(),
1993
 
                         include_unchanged=True, require_versioned=False,
1994
 
                         want_unversioned=True, specific_files=files):
1995
 
                    if versioned == (False, False):
1996
 
                        # The record is unknown ...
1997
 
                        if not self.is_ignored(path[1]):
1998
 
                            # ... but not ignored
1999
 
                            has_changed_files = True
2000
 
                            break
2001
 
                    elif content_change and (kind[1] is not None):
2002
 
                        # Versioned and changed, but not deleted
2003
 
                        has_changed_files = True
2004
 
                        break
 
1260
            for (file_id, path, content_change, versioned, parent_id, name,
 
1261
                 kind, executable) in self.iter_changes(self.basis_tree(),
 
1262
                     include_unchanged=True, require_versioned=False,
 
1263
                     want_unversioned=True, specific_files=files):
 
1264
                if versioned[0] == False:
 
1265
                    # The record is unknown or newly added
 
1266
                    files_to_backup.append(path[1])
 
1267
                elif (content_change and (kind[1] is not None) and
 
1268
                        osutils.is_inside_any(files, path[1])):
 
1269
                    # Versioned and changed, but not deleted, and still
 
1270
                    # in one of the dirs to be deleted.
 
1271
                    files_to_backup.append(path[1])
2005
1272
 
2006
 
            if has_changed_files:
2007
 
                # Make delta show ALL applicable changes in error message.
2008
 
                tree_delta = self.changes_from(self.basis_tree(),
2009
 
                    require_versioned=False, want_unversioned=True,
2010
 
                    specific_files=files)
2011
 
                for unknown_file in unknown_nested_files:
2012
 
                    if unknown_file not in tree_delta.unversioned:
2013
 
                        tree_delta.unversioned.extend((unknown_file,))
2014
 
                raise errors.BzrRemoveChangedFilesError(tree_delta)
 
1273
        def backup(file_to_backup):
 
1274
            backup_name = self.bzrdir._available_backup_name(file_to_backup)
 
1275
            osutils.rename(abs_path, self.abspath(backup_name))
 
1276
            return "removed %s (but kept a copy: %s)" % (file_to_backup,
 
1277
                                                         backup_name)
2015
1278
 
2016
1279
        # Build inv_delta and delete files where applicable,
2017
 
        # do this before any modifications to inventory.
 
1280
        # do this before any modifications to meta data.
2018
1281
        for f in files:
2019
1282
            fid = self.path2id(f)
2020
1283
            message = None
2041
1304
                        len(os.listdir(abs_path)) > 0):
2042
1305
                        if force:
2043
1306
                            osutils.rmtree(abs_path)
 
1307
                            message = "deleted %s" % (f,)
2044
1308
                        else:
2045
 
                            message = "%s is not an empty directory "\
2046
 
                                "and won't be deleted." % (f,)
 
1309
                            message = backup(f)
2047
1310
                    else:
2048
 
                        osutils.delete_any(abs_path)
2049
 
                        message = "deleted %s" % (f,)
 
1311
                        if f in files_to_backup:
 
1312
                            message = backup(f)
 
1313
                        else:
 
1314
                            osutils.delete_any(abs_path)
 
1315
                            message = "deleted %s" % (f,)
2050
1316
                elif message is not None:
2051
1317
                    # Only care if we haven't done anything yet.
2052
1318
                    message = "%s does not exist." % (f,)
2060
1326
    def revert(self, filenames=None, old_tree=None, backups=True,
2061
1327
               pb=None, report_changes=False):
2062
1328
        from bzrlib.conflicts import resolve
2063
 
        if filenames == []:
2064
 
            filenames = None
2065
 
            symbol_versioning.warn('Using [] to revert all files is deprecated'
2066
 
                ' as of bzr 0.91.  Please use None (the default) instead.',
2067
 
                DeprecationWarning, stacklevel=2)
2068
1329
        if old_tree is None:
2069
1330
            basis_tree = self.basis_tree()
2070
1331
            basis_tree.lock_read()
2091
1352
                basis_tree.unlock()
2092
1353
        return conflicts
2093
1354
 
 
1355
    @needs_write_lock
 
1356
    def store_uncommitted(self):
 
1357
        """Store uncommitted changes from the tree in the branch."""
 
1358
        target_tree = self.basis_tree()
 
1359
        shelf_creator = shelf.ShelfCreator(self, target_tree)
 
1360
        try:
 
1361
            if not shelf_creator.shelve_all():
 
1362
                return
 
1363
            self.branch.store_uncommitted(shelf_creator)
 
1364
            shelf_creator.transform()
 
1365
        finally:
 
1366
            shelf_creator.finalize()
 
1367
        note('Uncommitted changes stored in branch "%s".', self.branch.nick)
 
1368
 
 
1369
    @needs_write_lock
 
1370
    def restore_uncommitted(self):
 
1371
        """Restore uncommitted changes from the branch into the tree."""
 
1372
        unshelver = self.branch.get_unshelver(self)
 
1373
        if unshelver is None:
 
1374
            return
 
1375
        try:
 
1376
            merger = unshelver.make_merger()
 
1377
            merger.ignore_zero = True
 
1378
            merger.do_merge()
 
1379
            self.branch.store_uncommitted(None)
 
1380
        finally:
 
1381
            unshelver.finalize()
 
1382
 
2094
1383
    def revision_tree(self, revision_id):
2095
1384
        """See Tree.revision_tree.
2096
1385
 
2097
1386
        WorkingTree can supply revision_trees for the basis revision only
2098
1387
        because there is only one cached inventory in the bzr directory.
2099
1388
        """
2100
 
        if revision_id == self.last_revision():
2101
 
            try:
2102
 
                xml = self.read_basis_inventory()
2103
 
            except errors.NoSuchFile:
2104
 
                pass
2105
 
            else:
2106
 
                try:
2107
 
                    inv = xml7.serializer_v7.read_inventory_from_string(xml)
2108
 
                    # dont use the repository revision_tree api because we want
2109
 
                    # to supply the inventory.
2110
 
                    if inv.revision_id == revision_id:
2111
 
                        return revisiontree.RevisionTree(self.branch.repository,
2112
 
                            inv, revision_id)
2113
 
                except errors.BadInventoryFormat:
2114
 
                    pass
2115
 
        # raise if there was no inventory, or if we read the wrong inventory.
2116
 
        raise errors.NoSuchRevisionInTree(self, revision_id)
2117
 
 
2118
 
    # XXX: This method should be deprecated in favour of taking in a proper
2119
 
    # new Inventory object.
2120
 
    @needs_tree_write_lock
2121
 
    def set_inventory(self, new_inventory_list):
2122
 
        from bzrlib.inventory import (Inventory,
2123
 
                                      InventoryDirectory,
2124
 
                                      InventoryFile,
2125
 
                                      InventoryLink)
2126
 
        inv = Inventory(self.get_root_id())
2127
 
        for path, file_id, parent, kind in new_inventory_list:
2128
 
            name = os.path.basename(path)
2129
 
            if name == "":
2130
 
                continue
2131
 
            # fixme, there should be a factory function inv,add_??
2132
 
            if kind == 'directory':
2133
 
                inv.add(InventoryDirectory(file_id, name, parent))
2134
 
            elif kind == 'file':
2135
 
                inv.add(InventoryFile(file_id, name, parent))
2136
 
            elif kind == 'symlink':
2137
 
                inv.add(InventoryLink(file_id, name, parent))
2138
 
            else:
2139
 
                raise errors.BzrError("unknown kind %r" % kind)
2140
 
        self._write_inventory(inv)
 
1389
        raise NotImplementedError(self.revision_tree)
2141
1390
 
2142
1391
    @needs_tree_write_lock
2143
1392
    def set_root_id(self, file_id):
2156
1405
            present in the current inventory or an error will occur. It must
2157
1406
            not be None, but rather a valid file id.
2158
1407
        """
2159
 
        inv = self._inventory
2160
 
        orig_root_id = inv.root.file_id
2161
 
        # TODO: it might be nice to exit early if there was nothing
2162
 
        # to do, saving us from trigger a sync on unlock.
2163
 
        self._inventory_is_modified = True
2164
 
        # we preserve the root inventory entry object, but
2165
 
        # unlinkit from the byid index
2166
 
        del inv._byid[inv.root.file_id]
2167
 
        inv.root.file_id = file_id
2168
 
        # and link it into the index with the new changed id.
2169
 
        inv._byid[inv.root.file_id] = inv.root
2170
 
        # and finally update all children to reference the new id.
2171
 
        # XXX: this should be safe to just look at the root.children
2172
 
        # list, not the WHOLE INVENTORY.
2173
 
        for fid in inv:
2174
 
            entry = inv[fid]
2175
 
            if entry.parent_id == orig_root_id:
2176
 
                entry.parent_id = inv.root.file_id
 
1408
        raise NotImplementedError(self._set_root_id)
2177
1409
 
2178
1410
    def unlock(self):
2179
1411
        """See Branch.unlock.
2189
1421
    _marker = object()
2190
1422
 
2191
1423
    def update(self, change_reporter=None, possible_transports=None,
2192
 
               revision=None, old_tip=_marker):
 
1424
               revision=None, old_tip=_marker, show_base=False):
2193
1425
        """Update a working tree along its branch.
2194
1426
 
2195
1427
        This will update the branch if its bound too, which means we have
2210
1442
        - Restore the wt.basis->wt.state changes.
2211
1443
 
2212
1444
        There isn't a single operation at the moment to do that, so we:
 
1445
 
2213
1446
        - Merge current state -> basis tree of the master w.r.t. the old tree
2214
1447
          basis.
2215
1448
        - Do a 'normal' merge of the old branch basis if it is relevant.
2232
1465
            else:
2233
1466
                if old_tip is self._marker:
2234
1467
                    old_tip = None
2235
 
            return self._update_tree(old_tip, change_reporter, revision)
 
1468
            return self._update_tree(old_tip, change_reporter, revision, show_base)
2236
1469
        finally:
2237
1470
            self.unlock()
2238
1471
 
2239
1472
    @needs_tree_write_lock
2240
 
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
 
1473
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None,
 
1474
                     show_base=False):
2241
1475
        """Update a tree to the master branch.
2242
1476
 
2243
1477
        :param old_tip: if supplied, the previous tip revision the branch,
2270
1504
            other_tree = self.branch.repository.revision_tree(old_tip)
2271
1505
            nb_conflicts = merge.merge_inner(self.branch, other_tree,
2272
1506
                                             base_tree, this_tree=self,
2273
 
                                             change_reporter=change_reporter)
 
1507
                                             change_reporter=change_reporter,
 
1508
                                             show_base=show_base)
2274
1509
            if nb_conflicts:
2275
1510
                self.add_parent_tree((old_tip, other_tree))
2276
 
                trace.note('Rerun update after fixing the conflicts.')
 
1511
                note(gettext('Rerun update after fixing the conflicts.'))
2277
1512
                return nb_conflicts
2278
1513
 
2279
1514
        if last_rev != _mod_revision.ensure_null(revision):
2285
1520
            basis = self.basis_tree()
2286
1521
            basis.lock_read()
2287
1522
            try:
2288
 
                if (basis.inventory.root is None
2289
 
                    or basis.inventory.root.file_id != to_root_id):
 
1523
                if (basis.get_root_id() is None or basis.get_root_id() != to_root_id):
2290
1524
                    self.set_root_id(to_root_id)
2291
1525
                    self.flush()
2292
1526
            finally:
2300
1534
 
2301
1535
            nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2302
1536
                                             this_tree=self,
2303
 
                                             change_reporter=change_reporter)
 
1537
                                             change_reporter=change_reporter,
 
1538
                                             show_base=show_base)
2304
1539
            self.set_last_revision(revision)
2305
1540
            # TODO - dedup parents list with things merged by pull ?
2306
1541
            # reuse the tree we've updated to to set the basis:
2321
1556
            last_rev = parent_trees[0][0]
2322
1557
        return nb_conflicts
2323
1558
 
2324
 
    def _write_hashcache_if_dirty(self):
2325
 
        """Write out the hashcache if it is dirty."""
2326
 
        if self._hashcache.needs_write:
2327
 
            try:
2328
 
                self._hashcache.write()
2329
 
            except OSError, e:
2330
 
                if e.errno not in (errno.EPERM, errno.EACCES):
2331
 
                    raise
2332
 
                # TODO: jam 20061219 Should this be a warning? A single line
2333
 
                #       warning might be sufficient to let the user know what
2334
 
                #       is going on.
2335
 
                mutter('Could not write hashcache for %s\nError: %s',
2336
 
                       self._hashcache.cache_file_name(), e)
2337
 
 
2338
 
    @needs_tree_write_lock
2339
 
    def _write_inventory(self, inv):
2340
 
        """Write inventory as the current inventory."""
2341
 
        self._set_inventory(inv, dirty=True)
2342
 
        self.flush()
2343
 
 
2344
1559
    def set_conflicts(self, arg):
2345
1560
        raise errors.UnsupportedOperation(self.set_conflicts, self)
2346
1561
 
2347
1562
    def add_conflicts(self, arg):
2348
1563
        raise errors.UnsupportedOperation(self.add_conflicts, self)
2349
1564
 
2350
 
    @needs_read_lock
2351
1565
    def conflicts(self):
2352
 
        conflicts = _mod_conflicts.ConflictList()
2353
 
        for conflicted in self._iter_conflicts():
2354
 
            text = True
2355
 
            try:
2356
 
                if file_kind(self.abspath(conflicted)) != "file":
2357
 
                    text = False
2358
 
            except errors.NoSuchFile:
2359
 
                text = False
2360
 
            if text is True:
2361
 
                for suffix in ('.THIS', '.OTHER'):
2362
 
                    try:
2363
 
                        kind = file_kind(self.abspath(conflicted+suffix))
2364
 
                        if kind != "file":
2365
 
                            text = False
2366
 
                    except errors.NoSuchFile:
2367
 
                        text = False
2368
 
                    if text == False:
2369
 
                        break
2370
 
            ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2371
 
            conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2372
 
                             path=conflicted,
2373
 
                             file_id=self.path2id(conflicted)))
2374
 
        return conflicts
 
1566
        raise NotImplementedError(self.conflicts)
2375
1567
 
2376
1568
    def walkdirs(self, prefix=""):
2377
1569
        """Walk the directories of this tree.
2497
1689
    def _walkdirs(self, prefix=""):
2498
1690
        """Walk the directories of this tree.
2499
1691
 
2500
 
           :prefix: is used as the directrory to start with.
2501
 
           returns a generator which yields items in the form:
2502
 
                ((curren_directory_path, fileid),
2503
 
                 [(file1_path, file1_name, file1_kind, None, file1_id,
2504
 
                   file1_kind), ... ])
 
1692
        :param prefix: is used as the directrory to start with.
 
1693
        :returns: a generator which yields items in the form::
 
1694
 
 
1695
            ((curren_directory_path, fileid),
 
1696
             [(file1_path, file1_name, file1_kind, None, file1_id,
 
1697
               file1_kind), ... ])
2505
1698
        """
2506
 
        _directory = 'directory'
2507
 
        # get the root in the inventory
2508
 
        inv = self.inventory
2509
 
        top_id = inv.path2id(prefix)
2510
 
        if top_id is None:
2511
 
            pending = []
2512
 
        else:
2513
 
            pending = [(prefix, '', _directory, None, top_id, None)]
2514
 
        while pending:
2515
 
            dirblock = []
2516
 
            currentdir = pending.pop()
2517
 
            # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2518
 
            top_id = currentdir[4]
2519
 
            if currentdir[0]:
2520
 
                relroot = currentdir[0] + '/'
2521
 
            else:
2522
 
                relroot = ""
2523
 
            # FIXME: stash the node in pending
2524
 
            entry = inv[top_id]
2525
 
            if entry.kind == 'directory':
2526
 
                for name, child in entry.sorted_children():
2527
 
                    dirblock.append((relroot + name, name, child.kind, None,
2528
 
                        child.file_id, child.kind
2529
 
                        ))
2530
 
            yield (currentdir[0], entry.file_id), dirblock
2531
 
            # push the user specified dirs from dirblock
2532
 
            for dir in reversed(dirblock):
2533
 
                if dir[2] == _directory:
2534
 
                    pending.append(dir)
 
1699
        raise NotImplementedError(self._walkdirs)
2535
1700
 
2536
1701
    @needs_tree_write_lock
2537
1702
    def auto_resolve(self):
2541
1706
        are considered 'resolved', because bzr always puts conflict markers
2542
1707
        into files that have text conflicts.  The corresponding .THIS .BASE and
2543
1708
        .OTHER files are deleted, as per 'resolve'.
 
1709
 
2544
1710
        :return: a tuple of ConflictLists: (un_resolved, resolved).
2545
1711
        """
2546
1712
        un_resolved = _mod_conflicts.ConflictList()
2565
1731
        self.set_conflicts(un_resolved)
2566
1732
        return un_resolved, resolved
2567
1733
 
2568
 
    @needs_read_lock
2569
 
    def _check(self, references):
2570
 
        """Check the tree for consistency.
2571
 
 
2572
 
        :param references: A dict with keys matching the items returned by
2573
 
            self._get_check_refs(), and values from looking those keys up in
2574
 
            the repository.
2575
 
        """
2576
 
        tree_basis = self.basis_tree()
2577
 
        tree_basis.lock_read()
2578
 
        try:
2579
 
            repo_basis = references[('trees', self.last_revision())]
2580
 
            if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2581
 
                raise errors.BzrCheckError(
2582
 
                    "Mismatched basis inventory content.")
2583
 
            self._validate()
2584
 
        finally:
2585
 
            tree_basis.unlock()
2586
 
 
2587
1734
    def _validate(self):
2588
1735
        """Validate internal structures.
2589
1736
 
2595
1742
        """
2596
1743
        return
2597
1744
 
 
1745
    def check_state(self):
 
1746
        """Check that the working state is/isn't valid."""
 
1747
        raise NotImplementedError(self.check_state)
 
1748
 
 
1749
    def reset_state(self, revision_ids=None):
 
1750
        """Reset the state of the working tree.
 
1751
 
 
1752
        This does a hard-reset to a last-known-good state. This is a way to
 
1753
        fix if something got corrupted (like the .bzr/checkout/dirstate file)
 
1754
        """
 
1755
        raise NotImplementedError(self.reset_state)
 
1756
 
2598
1757
    def _get_rules_searcher(self, default_searcher):
2599
1758
        """See Tree._get_rules_searcher."""
2600
1759
        if self._rules_searcher is None:
2608
1767
        return ShelfManager(self, self._transport)
2609
1768
 
2610
1769
 
2611
 
class WorkingTree2(WorkingTree):
2612
 
    """This is the Format 2 working tree.
2613
 
 
2614
 
    This was the first weave based working tree.
2615
 
     - uses os locks for locking.
2616
 
     - uses the branch last-revision.
 
1770
class InventoryWorkingTree(WorkingTree,
 
1771
        bzrlib.mutabletree.MutableInventoryTree):
 
1772
    """Base class for working trees that are inventory-oriented.
 
1773
 
 
1774
    The inventory is held in the `Branch` working-inventory, and the
 
1775
    files are in a directory on disk.
 
1776
 
 
1777
    It is possible for a `WorkingTree` to have a filename which is
 
1778
    not listed in the Inventory and vice versa.
2617
1779
    """
2618
1780
 
2619
 
    def __init__(self, *args, **kwargs):
2620
 
        super(WorkingTree2, self).__init__(*args, **kwargs)
2621
 
        # WorkingTree2 has more of a constraint that self._inventory must
2622
 
        # exist. Because this is an older format, we don't mind the overhead
2623
 
        # caused by the extra computation here.
2624
 
 
2625
 
        # Newer WorkingTree's should only have self._inventory set when they
2626
 
        # have a read lock.
2627
 
        if self._inventory is None:
2628
 
            self.read_working_inventory()
2629
 
 
2630
 
    def _get_check_refs(self):
2631
 
        """Return the references needed to perform a check of this tree."""
2632
 
        return [('trees', self.last_revision())]
 
1781
    def __init__(self, basedir='.',
 
1782
                 branch=DEPRECATED_PARAMETER,
 
1783
                 _inventory=None,
 
1784
                 _control_files=None,
 
1785
                 _internal=False,
 
1786
                 _format=None,
 
1787
                 _bzrdir=None):
 
1788
        """Construct a InventoryWorkingTree instance. This is not a public API.
 
1789
 
 
1790
        :param branch: A branch to override probing for the branch.
 
1791
        """
 
1792
        super(InventoryWorkingTree, self).__init__(basedir=basedir,
 
1793
            branch=branch, _transport=_control_files._transport,
 
1794
            _internal=_internal, _format=_format, _bzrdir=_bzrdir)
 
1795
 
 
1796
        self._control_files = _control_files
 
1797
        self._detect_case_handling()
 
1798
 
 
1799
        if _inventory is None:
 
1800
            # This will be acquired on lock_read() or lock_write()
 
1801
            self._inventory_is_modified = False
 
1802
            self._inventory = None
 
1803
        else:
 
1804
            # the caller of __init__ has provided an inventory,
 
1805
            # we assume they know what they are doing - as its only
 
1806
            # the Format factory and creation methods that are
 
1807
            # permitted to do this.
 
1808
            self._set_inventory(_inventory, dirty=False)
 
1809
 
 
1810
    def _set_inventory(self, inv, dirty):
 
1811
        """Set the internal cached inventory.
 
1812
 
 
1813
        :param inv: The inventory to set.
 
1814
        :param dirty: A boolean indicating whether the inventory is the same
 
1815
            logical inventory as whats on disk. If True the inventory is not
 
1816
            the same and should be written to disk or data will be lost, if
 
1817
            False then the inventory is the same as that on disk and any
 
1818
            serialisation would be unneeded overhead.
 
1819
        """
 
1820
        self._inventory = inv
 
1821
        self._inventory_is_modified = dirty
 
1822
 
 
1823
    def _detect_case_handling(self):
 
1824
        wt_trans = self.bzrdir.get_workingtree_transport(None)
 
1825
        try:
 
1826
            wt_trans.stat(self._format.case_sensitive_filename)
 
1827
        except errors.NoSuchFile:
 
1828
            self.case_sensitive = True
 
1829
        else:
 
1830
            self.case_sensitive = False
 
1831
 
 
1832
        self._setup_directory_is_tree_reference()
 
1833
 
 
1834
    def _serialize(self, inventory, out_file):
 
1835
        xml5.serializer_v5.write_inventory(self._inventory, out_file,
 
1836
            working=True)
 
1837
 
 
1838
    def _deserialize(selt, in_file):
 
1839
        return xml5.serializer_v5.read_inventory(in_file)
 
1840
 
 
1841
    def break_lock(self):
 
1842
        """Break a lock if one is present from another instance.
 
1843
 
 
1844
        Uses the ui factory to ask for confirmation if the lock may be from
 
1845
        an active process.
 
1846
 
 
1847
        This will probe the repository for its lock as well.
 
1848
        """
 
1849
        self._control_files.break_lock()
 
1850
        self.branch.break_lock()
 
1851
 
 
1852
    def is_locked(self):
 
1853
        return self._control_files.is_locked()
 
1854
 
 
1855
    def _must_be_locked(self):
 
1856
        if not self.is_locked():
 
1857
            raise errors.ObjectNotLocked(self)
 
1858
 
 
1859
    def lock_read(self):
 
1860
        """Lock the tree for reading.
 
1861
 
 
1862
        This also locks the branch, and can be unlocked via self.unlock().
 
1863
 
 
1864
        :return: A bzrlib.lock.LogicalLockResult.
 
1865
        """
 
1866
        if not self.is_locked():
 
1867
            self._reset_data()
 
1868
        self.branch.lock_read()
 
1869
        try:
 
1870
            self._control_files.lock_read()
 
1871
            return LogicalLockResult(self.unlock)
 
1872
        except:
 
1873
            self.branch.unlock()
 
1874
            raise
2633
1875
 
2634
1876
    def lock_tree_write(self):
2635
 
        """See WorkingTree.lock_tree_write().
2636
 
 
2637
 
        In Format2 WorkingTrees we have a single lock for the branch and tree
2638
 
        so lock_tree_write() degrades to lock_write().
2639
 
        """
 
1877
        """See MutableTree.lock_tree_write, and WorkingTree.unlock.
 
1878
 
 
1879
        :return: A bzrlib.lock.LogicalLockResult.
 
1880
        """
 
1881
        if not self.is_locked():
 
1882
            self._reset_data()
 
1883
        self.branch.lock_read()
 
1884
        try:
 
1885
            self._control_files.lock_write()
 
1886
            return LogicalLockResult(self.unlock)
 
1887
        except:
 
1888
            self.branch.unlock()
 
1889
            raise
 
1890
 
 
1891
    def lock_write(self):
 
1892
        """See MutableTree.lock_write, and WorkingTree.unlock.
 
1893
 
 
1894
        :return: A bzrlib.lock.LogicalLockResult.
 
1895
        """
 
1896
        if not self.is_locked():
 
1897
            self._reset_data()
2640
1898
        self.branch.lock_write()
2641
1899
        try:
2642
 
            return self._control_files.lock_write()
 
1900
            self._control_files.lock_write()
 
1901
            return LogicalLockResult(self.unlock)
2643
1902
        except:
2644
1903
            self.branch.unlock()
2645
1904
            raise
2646
1905
 
2647
 
    def unlock(self):
2648
 
        # do non-implementation specific cleanup
2649
 
        self._cleanup()
2650
 
 
2651
 
        # we share control files:
2652
 
        if self._control_files._lock_count == 3:
2653
 
            # _inventory_is_modified is always False during a read lock.
2654
 
            if self._inventory_is_modified:
2655
 
                self.flush()
2656
 
            self._write_hashcache_if_dirty()
2657
 
 
2658
 
        # reverse order of locking.
 
1906
    def get_physical_lock_status(self):
 
1907
        return self._control_files.get_physical_lock_status()
 
1908
 
 
1909
    @needs_tree_write_lock
 
1910
    def _write_inventory(self, inv):
 
1911
        """Write inventory as the current inventory."""
 
1912
        self._set_inventory(inv, dirty=True)
 
1913
        self.flush()
 
1914
 
 
1915
    # XXX: This method should be deprecated in favour of taking in a proper
 
1916
    # new Inventory object.
 
1917
    @needs_tree_write_lock
 
1918
    def set_inventory(self, new_inventory_list):
 
1919
        from bzrlib.inventory import (Inventory,
 
1920
                                      InventoryDirectory,
 
1921
                                      InventoryFile,
 
1922
                                      InventoryLink)
 
1923
        inv = Inventory(self.get_root_id())
 
1924
        for path, file_id, parent, kind in new_inventory_list:
 
1925
            name = os.path.basename(path)
 
1926
            if name == "":
 
1927
                continue
 
1928
            # fixme, there should be a factory function inv,add_??
 
1929
            if kind == 'directory':
 
1930
                inv.add(InventoryDirectory(file_id, name, parent))
 
1931
            elif kind == 'file':
 
1932
                inv.add(InventoryFile(file_id, name, parent))
 
1933
            elif kind == 'symlink':
 
1934
                inv.add(InventoryLink(file_id, name, parent))
 
1935
            else:
 
1936
                raise errors.BzrError("unknown kind %r" % kind)
 
1937
        self._write_inventory(inv)
 
1938
 
 
1939
    def _write_basis_inventory(self, xml):
 
1940
        """Write the basis inventory XML to the basis-inventory file"""
 
1941
        path = self._basis_inventory_name()
 
1942
        sio = StringIO(xml)
 
1943
        self._transport.put_file(path, sio,
 
1944
            mode=self.bzrdir._get_file_mode())
 
1945
 
 
1946
    def _reset_data(self):
 
1947
        """Reset transient data that cannot be revalidated."""
 
1948
        self._inventory_is_modified = False
 
1949
        f = self._transport.get('inventory')
2659
1950
        try:
2660
 
            return self._control_files.unlock()
 
1951
            result = self._deserialize(f)
2661
1952
        finally:
2662
 
            self.branch.unlock()
2663
 
 
2664
 
 
2665
 
class WorkingTree3(WorkingTree):
2666
 
    """This is the Format 3 working tree.
2667
 
 
2668
 
    This differs from the base WorkingTree by:
2669
 
     - having its own file lock
2670
 
     - having its own last-revision property.
2671
 
 
2672
 
    This is new in bzr 0.8
2673
 
    """
2674
 
 
2675
 
    @needs_read_lock
2676
 
    def _last_revision(self):
2677
 
        """See Mutable.last_revision."""
 
1953
            f.close()
 
1954
        self._set_inventory(result, dirty=False)
 
1955
 
 
1956
    def _set_root_id(self, file_id):
 
1957
        """Set the root id for this tree, in a format specific manner.
 
1958
 
 
1959
        :param file_id: The file id to assign to the root. It must not be
 
1960
            present in the current inventory or an error will occur. It must
 
1961
            not be None, but rather a valid file id.
 
1962
        """
 
1963
        inv = self._inventory
 
1964
        orig_root_id = inv.root.file_id
 
1965
        # TODO: it might be nice to exit early if there was nothing
 
1966
        # to do, saving us from trigger a sync on unlock.
 
1967
        self._inventory_is_modified = True
 
1968
        # we preserve the root inventory entry object, but
 
1969
        # unlinkit from the byid index
 
1970
        del inv._byid[inv.root.file_id]
 
1971
        inv.root.file_id = file_id
 
1972
        # and link it into the index with the new changed id.
 
1973
        inv._byid[inv.root.file_id] = inv.root
 
1974
        # and finally update all children to reference the new id.
 
1975
        # XXX: this should be safe to just look at the root.children
 
1976
        # list, not the WHOLE INVENTORY.
 
1977
        for fid in inv:
 
1978
            entry = inv[fid]
 
1979
            if entry.parent_id == orig_root_id:
 
1980
                entry.parent_id = inv.root.file_id
 
1981
 
 
1982
    @needs_tree_write_lock
 
1983
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
 
1984
        """See MutableTree.set_parent_trees."""
 
1985
        parent_ids = [rev for (rev, tree) in parents_list]
 
1986
        for revision_id in parent_ids:
 
1987
            _mod_revision.check_not_reserved_id(revision_id)
 
1988
 
 
1989
        self._check_parents_for_ghosts(parent_ids,
 
1990
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
1991
 
 
1992
        parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
 
1993
 
 
1994
        if len(parent_ids) == 0:
 
1995
            leftmost_parent_id = _mod_revision.NULL_REVISION
 
1996
            leftmost_parent_tree = None
 
1997
        else:
 
1998
            leftmost_parent_id, leftmost_parent_tree = parents_list[0]
 
1999
 
 
2000
        if self._change_last_revision(leftmost_parent_id):
 
2001
            if leftmost_parent_tree is None:
 
2002
                # If we don't have a tree, fall back to reading the
 
2003
                # parent tree from the repository.
 
2004
                self._cache_basis_inventory(leftmost_parent_id)
 
2005
            else:
 
2006
                inv = leftmost_parent_tree.root_inventory
 
2007
                xml = self._create_basis_xml_from_inventory(
 
2008
                                        leftmost_parent_id, inv)
 
2009
                self._write_basis_inventory(xml)
 
2010
        self._set_merges_from_parent_ids(parent_ids)
 
2011
 
 
2012
    def _cache_basis_inventory(self, new_revision):
 
2013
        """Cache new_revision as the basis inventory."""
 
2014
        # TODO: this should allow the ready-to-use inventory to be passed in,
 
2015
        # as commit already has that ready-to-use [while the format is the
 
2016
        # same, that is].
2678
2017
        try:
2679
 
            return self._transport.get_bytes('last-revision')
2680
 
        except errors.NoSuchFile:
2681
 
            return _mod_revision.NULL_REVISION
2682
 
 
2683
 
    def _change_last_revision(self, revision_id):
2684
 
        """See WorkingTree._change_last_revision."""
2685
 
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2686
 
            try:
2687
 
                self._transport.delete('last-revision')
2688
 
            except errors.NoSuchFile:
2689
 
                pass
2690
 
            return False
2691
 
        else:
2692
 
            self._transport.put_bytes('last-revision', revision_id,
2693
 
                mode=self.bzrdir._get_file_mode())
2694
 
            return True
2695
 
 
2696
 
    def _get_check_refs(self):
2697
 
        """Return the references needed to perform a check of this tree."""
2698
 
        return [('trees', self.last_revision())]
 
2018
            # this double handles the inventory - unpack and repack -
 
2019
            # but is easier to understand. We can/should put a conditional
 
2020
            # in here based on whether the inventory is in the latest format
 
2021
            # - perhaps we should repack all inventories on a repository
 
2022
            # upgrade ?
 
2023
            # the fast path is to copy the raw xml from the repository. If the
 
2024
            # xml contains 'revision_id="', then we assume the right
 
2025
            # revision_id is set. We must check for this full string, because a
 
2026
            # root node id can legitimately look like 'revision_id' but cannot
 
2027
            # contain a '"'.
 
2028
            xml = self.branch.repository._get_inventory_xml(new_revision)
 
2029
            firstline = xml.split('\n', 1)[0]
 
2030
            if (not 'revision_id="' in firstline or
 
2031
                'format="7"' not in firstline):
 
2032
                inv = self.branch.repository._serializer.read_inventory_from_string(
 
2033
                    xml, new_revision)
 
2034
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
 
2035
            self._write_basis_inventory(xml)
 
2036
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
 
2037
            pass
 
2038
 
 
2039
    def _basis_inventory_name(self):
 
2040
        return 'basis-inventory-cache'
 
2041
 
 
2042
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
 
2043
        """Create the text that will be saved in basis-inventory"""
 
2044
        inventory.revision_id = revision_id
 
2045
        return xml7.serializer_v7.write_inventory_to_string(inventory)
2699
2046
 
2700
2047
    @needs_tree_write_lock
2701
2048
    def set_conflicts(self, conflicts):
2721
2068
                    raise errors.ConflictFormatError()
2722
2069
            except StopIteration:
2723
2070
                raise errors.ConflictFormatError()
2724
 
            return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
 
2071
            reader = _mod_rio.RioReader(confile)
 
2072
            return _mod_conflicts.ConflictList.from_stanzas(reader)
2725
2073
        finally:
2726
2074
            confile.close()
2727
2075
 
2728
 
    def unlock(self):
2729
 
        # do non-implementation specific cleanup
2730
 
        self._cleanup()
2731
 
        if self._control_files._lock_count == 1:
2732
 
            # _inventory_is_modified is always False during a read lock.
2733
 
            if self._inventory_is_modified:
2734
 
                self.flush()
2735
 
            self._write_hashcache_if_dirty()
2736
 
        # reverse order of locking.
2737
 
        try:
2738
 
            return self._control_files.unlock()
2739
 
        finally:
2740
 
            self.branch.unlock()
2741
 
 
2742
 
 
2743
 
def get_conflicted_stem(path):
2744
 
    for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2745
 
        if path.endswith(suffix):
2746
 
            return path[:-len(suffix)]
2747
 
 
2748
 
 
2749
 
class WorkingTreeFormat(object):
 
2076
    def read_basis_inventory(self):
 
2077
        """Read the cached basis inventory."""
 
2078
        path = self._basis_inventory_name()
 
2079
        return self._transport.get_bytes(path)
 
2080
 
 
2081
    @needs_read_lock
 
2082
    def read_working_inventory(self):
 
2083
        """Read the working inventory.
 
2084
 
 
2085
        :raises errors.InventoryModified: read_working_inventory will fail
 
2086
            when the current in memory inventory has been modified.
 
2087
        """
 
2088
        # conceptually this should be an implementation detail of the tree.
 
2089
        # XXX: Deprecate this.
 
2090
        # ElementTree does its own conversion from UTF-8, so open in
 
2091
        # binary.
 
2092
        if self._inventory_is_modified:
 
2093
            raise errors.InventoryModified(self)
 
2094
        f = self._transport.get('inventory')
 
2095
        try:
 
2096
            result = self._deserialize(f)
 
2097
        finally:
 
2098
            f.close()
 
2099
        self._set_inventory(result, dirty=False)
 
2100
        return result
 
2101
 
 
2102
    @needs_read_lock
 
2103
    def get_root_id(self):
 
2104
        """Return the id of this trees root"""
 
2105
        return self._inventory.root.file_id
 
2106
 
 
2107
    def has_id(self, file_id):
 
2108
        # files that have been deleted are excluded
 
2109
        inv, inv_file_id = self._unpack_file_id(file_id)
 
2110
        if not inv.has_id(inv_file_id):
 
2111
            return False
 
2112
        path = inv.id2path(inv_file_id)
 
2113
        return osutils.lexists(self.abspath(path))
 
2114
 
 
2115
    def has_or_had_id(self, file_id):
 
2116
        if file_id == self.get_root_id():
 
2117
            return True
 
2118
        inv, inv_file_id = self._unpack_file_id(file_id)
 
2119
        return inv.has_id(inv_file_id)
 
2120
 
 
2121
    def all_file_ids(self):
 
2122
        """Iterate through file_ids for this tree.
 
2123
 
 
2124
        file_ids are in a WorkingTree if they are in the working inventory
 
2125
        and the working file exists.
 
2126
        """
 
2127
        ret = set()
 
2128
        for path, ie in self.iter_entries_by_dir():
 
2129
            ret.add(ie.file_id)
 
2130
        return ret
 
2131
 
 
2132
    @needs_tree_write_lock
 
2133
    def set_last_revision(self, new_revision):
 
2134
        """Change the last revision in the working tree."""
 
2135
        if self._change_last_revision(new_revision):
 
2136
            self._cache_basis_inventory(new_revision)
 
2137
 
 
2138
    def _get_check_refs(self):
 
2139
        """Return the references needed to perform a check of this tree.
 
2140
        
 
2141
        The default implementation returns no refs, and is only suitable for
 
2142
        trees that have no local caching and can commit on ghosts at any time.
 
2143
 
 
2144
        :seealso: bzrlib.check for details about check_refs.
 
2145
        """
 
2146
        return []
 
2147
 
 
2148
    @needs_read_lock
 
2149
    def _check(self, references):
 
2150
        """Check the tree for consistency.
 
2151
 
 
2152
        :param references: A dict with keys matching the items returned by
 
2153
            self._get_check_refs(), and values from looking those keys up in
 
2154
            the repository.
 
2155
        """
 
2156
        tree_basis = self.basis_tree()
 
2157
        tree_basis.lock_read()
 
2158
        try:
 
2159
            repo_basis = references[('trees', self.last_revision())]
 
2160
            if len(list(repo_basis.iter_changes(tree_basis))) > 0:
 
2161
                raise errors.BzrCheckError(
 
2162
                    "Mismatched basis inventory content.")
 
2163
            self._validate()
 
2164
        finally:
 
2165
            tree_basis.unlock()
 
2166
 
 
2167
    @needs_read_lock
 
2168
    def check_state(self):
 
2169
        """Check that the working state is/isn't valid."""
 
2170
        check_refs = self._get_check_refs()
 
2171
        refs = {}
 
2172
        for ref in check_refs:
 
2173
            kind, value = ref
 
2174
            if kind == 'trees':
 
2175
                refs[ref] = self.branch.repository.revision_tree(value)
 
2176
        self._check(refs)
 
2177
 
 
2178
    @needs_tree_write_lock
 
2179
    def reset_state(self, revision_ids=None):
 
2180
        """Reset the state of the working tree.
 
2181
 
 
2182
        This does a hard-reset to a last-known-good state. This is a way to
 
2183
        fix if something got corrupted (like the .bzr/checkout/dirstate file)
 
2184
        """
 
2185
        if revision_ids is None:
 
2186
            revision_ids = self.get_parent_ids()
 
2187
        if not revision_ids:
 
2188
            rt = self.branch.repository.revision_tree(
 
2189
                _mod_revision.NULL_REVISION)
 
2190
        else:
 
2191
            rt = self.branch.repository.revision_tree(revision_ids[0])
 
2192
        self._write_inventory(rt.root_inventory)
 
2193
        self.set_parent_ids(revision_ids)
 
2194
 
 
2195
    def flush(self):
 
2196
        """Write the in memory inventory to disk."""
 
2197
        # TODO: Maybe this should only write on dirty ?
 
2198
        if self._control_files._lock_mode != 'w':
 
2199
            raise errors.NotWriteLocked(self)
 
2200
        sio = StringIO()
 
2201
        self._serialize(self._inventory, sio)
 
2202
        sio.seek(0)
 
2203
        self._transport.put_file('inventory', sio,
 
2204
            mode=self.bzrdir._get_file_mode())
 
2205
        self._inventory_is_modified = False
 
2206
 
 
2207
    def get_file_mtime(self, file_id, path=None):
 
2208
        """See Tree.get_file_mtime."""
 
2209
        if not path:
 
2210
            path = self.id2path(file_id)
 
2211
        try:
 
2212
            return os.lstat(self.abspath(path)).st_mtime
 
2213
        except OSError, e:
 
2214
            if e.errno == errno.ENOENT:
 
2215
                raise errors.FileTimestampUnavailable(path)
 
2216
            raise
 
2217
 
 
2218
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
 
2219
        inv, file_id = self._path2inv_file_id(path)
 
2220
        if file_id is None:
 
2221
            # For unversioned files on win32, we just assume they are not
 
2222
            # executable
 
2223
            return False
 
2224
        return inv[file_id].executable
 
2225
 
 
2226
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
 
2227
        mode = stat_result.st_mode
 
2228
        return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
 
2229
 
 
2230
    def is_executable(self, file_id, path=None):
 
2231
        if not self._supports_executable():
 
2232
            inv, inv_file_id = self._unpack_file_id(file_id)
 
2233
            return inv[inv_file_id].executable
 
2234
        else:
 
2235
            if not path:
 
2236
                path = self.id2path(file_id)
 
2237
            mode = os.lstat(self.abspath(path)).st_mode
 
2238
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
 
2239
 
 
2240
    def _is_executable_from_path_and_stat(self, path, stat_result):
 
2241
        if not self._supports_executable():
 
2242
            return self._is_executable_from_path_and_stat_from_basis(path, stat_result)
 
2243
        else:
 
2244
            return self._is_executable_from_path_and_stat_from_stat(path, stat_result)
 
2245
 
 
2246
    @needs_tree_write_lock
 
2247
    def _add(self, files, ids, kinds):
 
2248
        """See MutableTree._add."""
 
2249
        # TODO: Re-adding a file that is removed in the working copy
 
2250
        # should probably put it back with the previous ID.
 
2251
        # the read and write working inventory should not occur in this
 
2252
        # function - they should be part of lock_write and unlock.
 
2253
        # FIXME: nested trees
 
2254
        inv = self.root_inventory
 
2255
        for f, file_id, kind in zip(files, ids, kinds):
 
2256
            if file_id is None:
 
2257
                inv.add_path(f, kind=kind)
 
2258
            else:
 
2259
                inv.add_path(f, kind=kind, file_id=file_id)
 
2260
            self._inventory_is_modified = True
 
2261
 
 
2262
    def revision_tree(self, revision_id):
 
2263
        """See WorkingTree.revision_id."""
 
2264
        if revision_id == self.last_revision():
 
2265
            try:
 
2266
                xml = self.read_basis_inventory()
 
2267
            except errors.NoSuchFile:
 
2268
                pass
 
2269
            else:
 
2270
                try:
 
2271
                    inv = xml7.serializer_v7.read_inventory_from_string(xml)
 
2272
                    # dont use the repository revision_tree api because we want
 
2273
                    # to supply the inventory.
 
2274
                    if inv.revision_id == revision_id:
 
2275
                        return revisiontree.InventoryRevisionTree(
 
2276
                            self.branch.repository, inv, revision_id)
 
2277
                except errors.BadInventoryFormat:
 
2278
                    pass
 
2279
        # raise if there was no inventory, or if we read the wrong inventory.
 
2280
        raise errors.NoSuchRevisionInTree(self, revision_id)
 
2281
 
 
2282
    @needs_read_lock
 
2283
    def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
 
2284
        """See Tree.annotate_iter
 
2285
 
 
2286
        This implementation will use the basis tree implementation if possible.
 
2287
        Lines not in the basis are attributed to CURRENT_REVISION
 
2288
 
 
2289
        If there are pending merges, lines added by those merges will be
 
2290
        incorrectly attributed to CURRENT_REVISION (but after committing, the
 
2291
        attribution will be correct).
 
2292
        """
 
2293
        maybe_file_parent_keys = []
 
2294
        for parent_id in self.get_parent_ids():
 
2295
            try:
 
2296
                parent_tree = self.revision_tree(parent_id)
 
2297
            except errors.NoSuchRevisionInTree:
 
2298
                parent_tree = self.branch.repository.revision_tree(parent_id)
 
2299
            parent_tree.lock_read()
 
2300
            try:
 
2301
                try:
 
2302
                    kind = parent_tree.kind(file_id)
 
2303
                except errors.NoSuchId:
 
2304
                    continue
 
2305
                if kind != 'file':
 
2306
                    # Note: this is slightly unnecessary, because symlinks and
 
2307
                    # directories have a "text" which is the empty text, and we
 
2308
                    # know that won't mess up annotations. But it seems cleaner
 
2309
                    continue
 
2310
                parent_text_key = (
 
2311
                    file_id, parent_tree.get_file_revision(file_id))
 
2312
                if parent_text_key not in maybe_file_parent_keys:
 
2313
                    maybe_file_parent_keys.append(parent_text_key)
 
2314
            finally:
 
2315
                parent_tree.unlock()
 
2316
        graph = _mod_graph.Graph(self.branch.repository.texts)
 
2317
        heads = graph.heads(maybe_file_parent_keys)
 
2318
        file_parent_keys = []
 
2319
        for key in maybe_file_parent_keys:
 
2320
            if key in heads:
 
2321
                file_parent_keys.append(key)
 
2322
 
 
2323
        # Now we have the parents of this content
 
2324
        annotator = self.branch.repository.texts.get_annotator()
 
2325
        text = self.get_file_text(file_id)
 
2326
        this_key =(file_id, default_revision)
 
2327
        annotator.add_special_text(this_key, file_parent_keys, text)
 
2328
        annotations = [(key[-1], line)
 
2329
                       for key, line in annotator.annotate_flat(this_key)]
 
2330
        return annotations
 
2331
 
 
2332
    def _put_rio(self, filename, stanzas, header):
 
2333
        self._must_be_locked()
 
2334
        my_file = _mod_rio.rio_file(stanzas, header)
 
2335
        self._transport.put_file(filename, my_file,
 
2336
            mode=self.bzrdir._get_file_mode())
 
2337
 
 
2338
    @needs_tree_write_lock
 
2339
    def set_merge_modified(self, modified_hashes):
 
2340
        def iter_stanzas():
 
2341
            for file_id, hash in modified_hashes.iteritems():
 
2342
                yield _mod_rio.Stanza(file_id=file_id.decode('utf8'),
 
2343
                    hash=hash)
 
2344
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
 
2345
 
 
2346
    @needs_read_lock
 
2347
    def merge_modified(self):
 
2348
        """Return a dictionary of files modified by a merge.
 
2349
 
 
2350
        The list is initialized by WorkingTree.set_merge_modified, which is
 
2351
        typically called after we make some automatic updates to the tree
 
2352
        because of a merge.
 
2353
 
 
2354
        This returns a map of file_id->sha1, containing only files which are
 
2355
        still in the working inventory and have that text hash.
 
2356
        """
 
2357
        try:
 
2358
            hashfile = self._transport.get('merge-hashes')
 
2359
        except errors.NoSuchFile:
 
2360
            return {}
 
2361
        try:
 
2362
            merge_hashes = {}
 
2363
            try:
 
2364
                if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
 
2365
                    raise errors.MergeModifiedFormatError()
 
2366
            except StopIteration:
 
2367
                raise errors.MergeModifiedFormatError()
 
2368
            for s in _mod_rio.RioReader(hashfile):
 
2369
                # RioReader reads in Unicode, so convert file_ids back to utf8
 
2370
                file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
 
2371
                if not self.has_id(file_id):
 
2372
                    continue
 
2373
                text_hash = s.get("hash")
 
2374
                if text_hash == self.get_file_sha1(file_id):
 
2375
                    merge_hashes[file_id] = text_hash
 
2376
            return merge_hashes
 
2377
        finally:
 
2378
            hashfile.close()
 
2379
 
 
2380
    @needs_write_lock
 
2381
    def subsume(self, other_tree):
 
2382
        def add_children(inventory, entry):
 
2383
            for child_entry in entry.children.values():
 
2384
                inventory._byid[child_entry.file_id] = child_entry
 
2385
                if child_entry.kind == 'directory':
 
2386
                    add_children(inventory, child_entry)
 
2387
        if other_tree.get_root_id() == self.get_root_id():
 
2388
            raise errors.BadSubsumeSource(self, other_tree,
 
2389
                                          'Trees have the same root')
 
2390
        try:
 
2391
            other_tree_path = self.relpath(other_tree.basedir)
 
2392
        except errors.PathNotChild:
 
2393
            raise errors.BadSubsumeSource(self, other_tree,
 
2394
                'Tree is not contained by the other')
 
2395
        new_root_parent = self.path2id(osutils.dirname(other_tree_path))
 
2396
        if new_root_parent is None:
 
2397
            raise errors.BadSubsumeSource(self, other_tree,
 
2398
                'Parent directory is not versioned.')
 
2399
        # We need to ensure that the result of a fetch will have a
 
2400
        # versionedfile for the other_tree root, and only fetching into
 
2401
        # RepositoryKnit2 guarantees that.
 
2402
        if not self.branch.repository.supports_rich_root():
 
2403
            raise errors.SubsumeTargetNeedsUpgrade(other_tree)
 
2404
        other_tree.lock_tree_write()
 
2405
        try:
 
2406
            new_parents = other_tree.get_parent_ids()
 
2407
            other_root = other_tree.root_inventory.root
 
2408
            other_root.parent_id = new_root_parent
 
2409
            other_root.name = osutils.basename(other_tree_path)
 
2410
            self.root_inventory.add(other_root)
 
2411
            add_children(self.root_inventory, other_root)
 
2412
            self._write_inventory(self.root_inventory)
 
2413
            # normally we don't want to fetch whole repositories, but i think
 
2414
            # here we really do want to consolidate the whole thing.
 
2415
            for parent_id in other_tree.get_parent_ids():
 
2416
                self.branch.fetch(other_tree.branch, parent_id)
 
2417
                self.add_parent_tree_id(parent_id)
 
2418
        finally:
 
2419
            other_tree.unlock()
 
2420
        other_tree.bzrdir.retire_bzrdir()
 
2421
 
 
2422
    @needs_tree_write_lock
 
2423
    def extract(self, file_id, format=None):
 
2424
        """Extract a subtree from this tree.
 
2425
 
 
2426
        A new branch will be created, relative to the path for this tree.
 
2427
        """
 
2428
        self.flush()
 
2429
        def mkdirs(path):
 
2430
            segments = osutils.splitpath(path)
 
2431
            transport = self.branch.bzrdir.root_transport
 
2432
            for name in segments:
 
2433
                transport = transport.clone(name)
 
2434
                transport.ensure_base()
 
2435
            return transport
 
2436
 
 
2437
        sub_path = self.id2path(file_id)
 
2438
        branch_transport = mkdirs(sub_path)
 
2439
        if format is None:
 
2440
            format = self.bzrdir.cloning_metadir()
 
2441
        branch_transport.ensure_base()
 
2442
        branch_bzrdir = format.initialize_on_transport(branch_transport)
 
2443
        try:
 
2444
            repo = branch_bzrdir.find_repository()
 
2445
        except errors.NoRepositoryPresent:
 
2446
            repo = branch_bzrdir.create_repository()
 
2447
        if not repo.supports_rich_root():
 
2448
            raise errors.RootNotRich()
 
2449
        new_branch = branch_bzrdir.create_branch()
 
2450
        new_branch.pull(self.branch)
 
2451
        for parent_id in self.get_parent_ids():
 
2452
            new_branch.fetch(self.branch, parent_id)
 
2453
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
 
2454
        if tree_transport.base != branch_transport.base:
 
2455
            tree_bzrdir = format.initialize_on_transport(tree_transport)
 
2456
            tree_bzrdir.set_branch_reference(new_branch)
 
2457
        else:
 
2458
            tree_bzrdir = branch_bzrdir
 
2459
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
 
2460
        wt.set_parent_ids(self.get_parent_ids())
 
2461
        # FIXME: Support nested trees
 
2462
        my_inv = self.root_inventory
 
2463
        child_inv = inventory.Inventory(root_id=None)
 
2464
        new_root = my_inv[file_id]
 
2465
        my_inv.remove_recursive_id(file_id)
 
2466
        new_root.parent_id = None
 
2467
        child_inv.add(new_root)
 
2468
        self._write_inventory(my_inv)
 
2469
        wt._write_inventory(child_inv)
 
2470
        return wt
 
2471
 
 
2472
    def list_files(self, include_root=False, from_dir=None, recursive=True):
 
2473
        """List all files as (path, class, kind, id, entry).
 
2474
 
 
2475
        Lists, but does not descend into unversioned directories.
 
2476
        This does not include files that have been deleted in this
 
2477
        tree. Skips the control directory.
 
2478
 
 
2479
        :param include_root: if True, return an entry for the root
 
2480
        :param from_dir: start from this directory or None for the root
 
2481
        :param recursive: whether to recurse into subdirectories or not
 
2482
        """
 
2483
        # list_files is an iterator, so @needs_read_lock doesn't work properly
 
2484
        # with it. So callers should be careful to always read_lock the tree.
 
2485
        if not self.is_locked():
 
2486
            raise errors.ObjectNotLocked(self)
 
2487
 
 
2488
        if from_dir is None and include_root is True:
 
2489
            yield ('', 'V', 'directory', self.get_root_id(), self.root_inventory.root)
 
2490
        # Convert these into local objects to save lookup times
 
2491
        pathjoin = osutils.pathjoin
 
2492
        file_kind = self._kind
 
2493
 
 
2494
        # transport.base ends in a slash, we want the piece
 
2495
        # between the last two slashes
 
2496
        transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
 
2497
 
 
2498
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
 
2499
 
 
2500
        # directory file_id, relative path, absolute path, reverse sorted children
 
2501
        if from_dir is not None:
 
2502
            inv, from_dir_id = self._path2inv_file_id(from_dir)
 
2503
            if from_dir_id is None:
 
2504
                # Directory not versioned
 
2505
                return
 
2506
            from_dir_abspath = pathjoin(self.basedir, from_dir)
 
2507
        else:
 
2508
            inv = self.root_inventory
 
2509
            from_dir_id = inv.root.file_id
 
2510
            from_dir_abspath = self.basedir
 
2511
        children = os.listdir(from_dir_abspath)
 
2512
        children.sort()
 
2513
        # jam 20060527 The kernel sized tree seems equivalent whether we
 
2514
        # use a deque and popleft to keep them sorted, or if we use a plain
 
2515
        # list and just reverse() them.
 
2516
        children = collections.deque(children)
 
2517
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
 
2518
        while stack:
 
2519
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
 
2520
 
 
2521
            while children:
 
2522
                f = children.popleft()
 
2523
                ## TODO: If we find a subdirectory with its own .bzr
 
2524
                ## directory, then that is a separate tree and we
 
2525
                ## should exclude it.
 
2526
 
 
2527
                # the bzrdir for this tree
 
2528
                if transport_base_dir == f:
 
2529
                    continue
 
2530
 
 
2531
                # we know that from_dir_relpath and from_dir_abspath never end in a slash
 
2532
                # and 'f' doesn't begin with one, we can do a string op, rather
 
2533
                # than the checks of pathjoin(), all relative paths will have an extra slash
 
2534
                # at the beginning
 
2535
                fp = from_dir_relpath + '/' + f
 
2536
 
 
2537
                # absolute path
 
2538
                fap = from_dir_abspath + '/' + f
 
2539
 
 
2540
                dir_ie = inv[from_dir_id]
 
2541
                if dir_ie.kind == 'directory':
 
2542
                    f_ie = dir_ie.children.get(f)
 
2543
                else:
 
2544
                    f_ie = None
 
2545
                if f_ie:
 
2546
                    c = 'V'
 
2547
                elif self.is_ignored(fp[1:]):
 
2548
                    c = 'I'
 
2549
                else:
 
2550
                    # we may not have found this file, because of a unicode
 
2551
                    # issue, or because the directory was actually a symlink.
 
2552
                    f_norm, can_access = osutils.normalized_filename(f)
 
2553
                    if f == f_norm or not can_access:
 
2554
                        # No change, so treat this file normally
 
2555
                        c = '?'
 
2556
                    else:
 
2557
                        # this file can be accessed by a normalized path
 
2558
                        # check again if it is versioned
 
2559
                        # these lines are repeated here for performance
 
2560
                        f = f_norm
 
2561
                        fp = from_dir_relpath + '/' + f
 
2562
                        fap = from_dir_abspath + '/' + f
 
2563
                        f_ie = inv.get_child(from_dir_id, f)
 
2564
                        if f_ie:
 
2565
                            c = 'V'
 
2566
                        elif self.is_ignored(fp[1:]):
 
2567
                            c = 'I'
 
2568
                        else:
 
2569
                            c = '?'
 
2570
 
 
2571
                fk = file_kind(fap)
 
2572
 
 
2573
                # make a last minute entry
 
2574
                if f_ie:
 
2575
                    yield fp[1:], c, fk, f_ie.file_id, f_ie
 
2576
                else:
 
2577
                    try:
 
2578
                        yield fp[1:], c, fk, None, fk_entries[fk]()
 
2579
                    except KeyError:
 
2580
                        yield fp[1:], c, fk, None, TreeEntry()
 
2581
                    continue
 
2582
 
 
2583
                if fk != 'directory':
 
2584
                    continue
 
2585
 
 
2586
                # But do this child first if recursing down
 
2587
                if recursive:
 
2588
                    new_children = os.listdir(fap)
 
2589
                    new_children.sort()
 
2590
                    new_children = collections.deque(new_children)
 
2591
                    stack.append((f_ie.file_id, fp, fap, new_children))
 
2592
                    # Break out of inner loop,
 
2593
                    # so that we start outer loop with child
 
2594
                    break
 
2595
            else:
 
2596
                # if we finished all children, pop it off the stack
 
2597
                stack.pop()
 
2598
 
 
2599
    @needs_tree_write_lock
 
2600
    def move(self, from_paths, to_dir=None, after=False):
 
2601
        """Rename files.
 
2602
 
 
2603
        to_dir must exist in the inventory.
 
2604
 
 
2605
        If to_dir exists and is a directory, the files are moved into
 
2606
        it, keeping their old names.
 
2607
 
 
2608
        Note that to_dir is only the last component of the new name;
 
2609
        this doesn't change the directory.
 
2610
 
 
2611
        For each entry in from_paths the move mode will be determined
 
2612
        independently.
 
2613
 
 
2614
        The first mode moves the file in the filesystem and updates the
 
2615
        inventory. The second mode only updates the inventory without
 
2616
        touching the file on the filesystem.
 
2617
 
 
2618
        move uses the second mode if 'after == True' and the target is
 
2619
        either not versioned or newly added, and present in the working tree.
 
2620
 
 
2621
        move uses the second mode if 'after == False' and the source is
 
2622
        versioned but no longer in the working tree, and the target is not
 
2623
        versioned but present in the working tree.
 
2624
 
 
2625
        move uses the first mode if 'after == False' and the source is
 
2626
        versioned and present in the working tree, and the target is not
 
2627
        versioned and not present in the working tree.
 
2628
 
 
2629
        Everything else results in an error.
 
2630
 
 
2631
        This returns a list of (from_path, to_path) pairs for each
 
2632
        entry that is moved.
 
2633
        """
 
2634
        rename_entries = []
 
2635
        rename_tuples = []
 
2636
 
 
2637
        invs_to_write = set()
 
2638
 
 
2639
        # check for deprecated use of signature
 
2640
        if to_dir is None:
 
2641
            raise TypeError('You must supply a target directory')
 
2642
        # check destination directory
 
2643
        if isinstance(from_paths, basestring):
 
2644
            raise ValueError()
 
2645
        to_abs = self.abspath(to_dir)
 
2646
        if not isdir(to_abs):
 
2647
            raise errors.BzrMoveFailedError('',to_dir,
 
2648
                errors.NotADirectory(to_abs))
 
2649
        if not self.has_filename(to_dir):
 
2650
            raise errors.BzrMoveFailedError('',to_dir,
 
2651
                errors.NotInWorkingDirectory(to_dir))
 
2652
        to_inv, to_dir_id = self._path2inv_file_id(to_dir)
 
2653
        if to_dir_id is None:
 
2654
            raise errors.BzrMoveFailedError('',to_dir,
 
2655
                errors.NotVersionedError(path=to_dir))
 
2656
 
 
2657
        to_dir_ie = to_inv[to_dir_id]
 
2658
        if to_dir_ie.kind != 'directory':
 
2659
            raise errors.BzrMoveFailedError('',to_dir,
 
2660
                errors.NotADirectory(to_abs))
 
2661
 
 
2662
        # create rename entries and tuples
 
2663
        for from_rel in from_paths:
 
2664
            from_tail = splitpath(from_rel)[-1]
 
2665
            from_inv, from_id = self._path2inv_file_id(from_rel)
 
2666
            if from_id is None:
 
2667
                raise errors.BzrMoveFailedError(from_rel,to_dir,
 
2668
                    errors.NotVersionedError(path=from_rel))
 
2669
 
 
2670
            from_entry = from_inv[from_id]
 
2671
            from_parent_id = from_entry.parent_id
 
2672
            to_rel = pathjoin(to_dir, from_tail)
 
2673
            rename_entry = InventoryWorkingTree._RenameEntry(
 
2674
                from_rel=from_rel,
 
2675
                from_id=from_id,
 
2676
                from_tail=from_tail,
 
2677
                from_parent_id=from_parent_id,
 
2678
                to_rel=to_rel, to_tail=from_tail,
 
2679
                to_parent_id=to_dir_id)
 
2680
            rename_entries.append(rename_entry)
 
2681
            rename_tuples.append((from_rel, to_rel))
 
2682
 
 
2683
        # determine which move mode to use. checks also for movability
 
2684
        rename_entries = self._determine_mv_mode(rename_entries, after)
 
2685
 
 
2686
        original_modified = self._inventory_is_modified
 
2687
        try:
 
2688
            if len(from_paths):
 
2689
                self._inventory_is_modified = True
 
2690
            self._move(rename_entries)
 
2691
        except:
 
2692
            # restore the inventory on error
 
2693
            self._inventory_is_modified = original_modified
 
2694
            raise
 
2695
        #FIXME: Should potentially also write the from_invs
 
2696
        self._write_inventory(to_inv)
 
2697
        return rename_tuples
 
2698
 
 
2699
    @needs_tree_write_lock
 
2700
    def rename_one(self, from_rel, to_rel, after=False):
 
2701
        """Rename one file.
 
2702
 
 
2703
        This can change the directory or the filename or both.
 
2704
 
 
2705
        rename_one has several 'modes' to work. First, it can rename a physical
 
2706
        file and change the file_id. That is the normal mode. Second, it can
 
2707
        only change the file_id without touching any physical file.
 
2708
 
 
2709
        rename_one uses the second mode if 'after == True' and 'to_rel' is not
 
2710
        versioned but present in the working tree.
 
2711
 
 
2712
        rename_one uses the second mode if 'after == False' and 'from_rel' is
 
2713
        versioned but no longer in the working tree, and 'to_rel' is not
 
2714
        versioned but present in the working tree.
 
2715
 
 
2716
        rename_one uses the first mode if 'after == False' and 'from_rel' is
 
2717
        versioned and present in the working tree, and 'to_rel' is not
 
2718
        versioned and not present in the working tree.
 
2719
 
 
2720
        Everything else results in an error.
 
2721
        """
 
2722
        rename_entries = []
 
2723
 
 
2724
        # create rename entries and tuples
 
2725
        from_tail = splitpath(from_rel)[-1]
 
2726
        from_inv, from_id = self._path2inv_file_id(from_rel)
 
2727
        if from_id is None:
 
2728
            # if file is missing in the inventory maybe it's in the basis_tree
 
2729
            basis_tree = self.branch.basis_tree()
 
2730
            from_id = basis_tree.path2id(from_rel)
 
2731
            if from_id is None:
 
2732
                raise errors.BzrRenameFailedError(from_rel,to_rel,
 
2733
                    errors.NotVersionedError(path=from_rel))
 
2734
            # put entry back in the inventory so we can rename it
 
2735
            from_entry = basis_tree.root_inventory[from_id].copy()
 
2736
            from_inv.add(from_entry)
 
2737
        else:
 
2738
            from_inv, from_inv_id = self._unpack_file_id(from_id)
 
2739
            from_entry = from_inv[from_inv_id]
 
2740
        from_parent_id = from_entry.parent_id
 
2741
        to_dir, to_tail = os.path.split(to_rel)
 
2742
        to_inv, to_dir_id = self._path2inv_file_id(to_dir)
 
2743
        rename_entry = InventoryWorkingTree._RenameEntry(from_rel=from_rel,
 
2744
                                     from_id=from_id,
 
2745
                                     from_tail=from_tail,
 
2746
                                     from_parent_id=from_parent_id,
 
2747
                                     to_rel=to_rel, to_tail=to_tail,
 
2748
                                     to_parent_id=to_dir_id)
 
2749
        rename_entries.append(rename_entry)
 
2750
 
 
2751
        # determine which move mode to use. checks also for movability
 
2752
        rename_entries = self._determine_mv_mode(rename_entries, after)
 
2753
 
 
2754
        # check if the target changed directory and if the target directory is
 
2755
        # versioned
 
2756
        if to_dir_id is None:
 
2757
            raise errors.BzrMoveFailedError(from_rel,to_rel,
 
2758
                errors.NotVersionedError(path=to_dir))
 
2759
 
 
2760
        # all checks done. now we can continue with our actual work
 
2761
        mutter('rename_one:\n'
 
2762
               '  from_id   {%s}\n'
 
2763
               '  from_rel: %r\n'
 
2764
               '  to_rel:   %r\n'
 
2765
               '  to_dir    %r\n'
 
2766
               '  to_dir_id {%s}\n',
 
2767
               from_id, from_rel, to_rel, to_dir, to_dir_id)
 
2768
 
 
2769
        self._move(rename_entries)
 
2770
        self._write_inventory(to_inv)
 
2771
 
 
2772
    class _RenameEntry(object):
 
2773
        def __init__(self, from_rel, from_id, from_tail, from_parent_id,
 
2774
                     to_rel, to_tail, to_parent_id, only_change_inv=False,
 
2775
                     change_id=False):
 
2776
            self.from_rel = from_rel
 
2777
            self.from_id = from_id
 
2778
            self.from_tail = from_tail
 
2779
            self.from_parent_id = from_parent_id
 
2780
            self.to_rel = to_rel
 
2781
            self.to_tail = to_tail
 
2782
            self.to_parent_id = to_parent_id
 
2783
            self.change_id = change_id
 
2784
            self.only_change_inv = only_change_inv
 
2785
 
 
2786
    def _determine_mv_mode(self, rename_entries, after=False):
 
2787
        """Determines for each from-to pair if both inventory and working tree
 
2788
        or only the inventory has to be changed.
 
2789
 
 
2790
        Also does basic plausability tests.
 
2791
        """
 
2792
        # FIXME: Handling of nested trees
 
2793
        inv = self.root_inventory
 
2794
 
 
2795
        for rename_entry in rename_entries:
 
2796
            # store to local variables for easier reference
 
2797
            from_rel = rename_entry.from_rel
 
2798
            from_id = rename_entry.from_id
 
2799
            to_rel = rename_entry.to_rel
 
2800
            to_id = inv.path2id(to_rel)
 
2801
            only_change_inv = False
 
2802
            change_id = False
 
2803
 
 
2804
            # check the inventory for source and destination
 
2805
            if from_id is None:
 
2806
                raise errors.BzrMoveFailedError(from_rel,to_rel,
 
2807
                    errors.NotVersionedError(path=from_rel))
 
2808
            if to_id is not None:
 
2809
                allowed = False
 
2810
                # allow it with --after but only if dest is newly added
 
2811
                if after:
 
2812
                    basis = self.basis_tree()
 
2813
                    basis.lock_read()
 
2814
                    try:
 
2815
                        if not basis.has_id(to_id):
 
2816
                            rename_entry.change_id = True
 
2817
                            allowed = True
 
2818
                    finally:
 
2819
                        basis.unlock()
 
2820
                if not allowed:
 
2821
                    raise errors.BzrMoveFailedError(from_rel,to_rel,
 
2822
                        errors.AlreadyVersionedError(path=to_rel))
 
2823
 
 
2824
            # try to determine the mode for rename (only change inv or change
 
2825
            # inv and file system)
 
2826
            if after:
 
2827
                if not self.has_filename(to_rel):
 
2828
                    raise errors.BzrMoveFailedError(from_id,to_rel,
 
2829
                        errors.NoSuchFile(path=to_rel,
 
2830
                        extra="New file has not been created yet"))
 
2831
                only_change_inv = True
 
2832
            elif not self.has_filename(from_rel) and self.has_filename(to_rel):
 
2833
                only_change_inv = True
 
2834
            elif self.has_filename(from_rel) and not self.has_filename(to_rel):
 
2835
                only_change_inv = False
 
2836
            elif (not self.case_sensitive
 
2837
                  and from_rel.lower() == to_rel.lower()
 
2838
                  and self.has_filename(from_rel)):
 
2839
                only_change_inv = False
 
2840
            else:
 
2841
                # something is wrong, so lets determine what exactly
 
2842
                if not self.has_filename(from_rel) and \
 
2843
                   not self.has_filename(to_rel):
 
2844
                    raise errors.BzrRenameFailedError(from_rel, to_rel,
 
2845
                        errors.PathsDoNotExist(paths=(from_rel, to_rel)))
 
2846
                else:
 
2847
                    raise errors.RenameFailedFilesExist(from_rel, to_rel)
 
2848
            rename_entry.only_change_inv = only_change_inv
 
2849
        return rename_entries
 
2850
 
 
2851
    def _move(self, rename_entries):
 
2852
        """Moves a list of files.
 
2853
 
 
2854
        Depending on the value of the flag 'only_change_inv', the
 
2855
        file will be moved on the file system or not.
 
2856
        """
 
2857
        moved = []
 
2858
 
 
2859
        for entry in rename_entries:
 
2860
            try:
 
2861
                self._move_entry(entry)
 
2862
            except:
 
2863
                self._rollback_move(moved)
 
2864
                raise
 
2865
            moved.append(entry)
 
2866
 
 
2867
    def _rollback_move(self, moved):
 
2868
        """Try to rollback a previous move in case of an filesystem error."""
 
2869
        for entry in moved:
 
2870
            try:
 
2871
                self._move_entry(WorkingTree._RenameEntry(
 
2872
                    entry.to_rel, entry.from_id,
 
2873
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
 
2874
                    entry.from_tail, entry.from_parent_id,
 
2875
                    entry.only_change_inv))
 
2876
            except errors.BzrMoveFailedError, e:
 
2877
                raise errors.BzrMoveFailedError( '', '', "Rollback failed."
 
2878
                        " The working tree is in an inconsistent state."
 
2879
                        " Please consider doing a 'bzr revert'."
 
2880
                        " Error message is: %s" % e)
 
2881
 
 
2882
    def _move_entry(self, entry):
 
2883
        inv = self.root_inventory
 
2884
        from_rel_abs = self.abspath(entry.from_rel)
 
2885
        to_rel_abs = self.abspath(entry.to_rel)
 
2886
        if from_rel_abs == to_rel_abs:
 
2887
            raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
 
2888
                "Source and target are identical.")
 
2889
 
 
2890
        if not entry.only_change_inv:
 
2891
            try:
 
2892
                osutils.rename(from_rel_abs, to_rel_abs)
 
2893
            except OSError, e:
 
2894
                raise errors.BzrMoveFailedError(entry.from_rel,
 
2895
                    entry.to_rel, e[1])
 
2896
        if entry.change_id:
 
2897
            to_id = inv.path2id(entry.to_rel)
 
2898
            inv.remove_recursive_id(to_id)
 
2899
        inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
 
2900
 
 
2901
    @needs_tree_write_lock
 
2902
    def unversion(self, file_ids):
 
2903
        """Remove the file ids in file_ids from the current versioned set.
 
2904
 
 
2905
        When a file_id is unversioned, all of its children are automatically
 
2906
        unversioned.
 
2907
 
 
2908
        :param file_ids: The file ids to stop versioning.
 
2909
        :raises: NoSuchId if any fileid is not currently versioned.
 
2910
        """
 
2911
        for file_id in file_ids:
 
2912
            if not self._inventory.has_id(file_id):
 
2913
                raise errors.NoSuchId(self, file_id)
 
2914
        for file_id in file_ids:
 
2915
            if self._inventory.has_id(file_id):
 
2916
                self._inventory.remove_recursive_id(file_id)
 
2917
        if len(file_ids):
 
2918
            # in the future this should just set a dirty bit to wait for the
 
2919
            # final unlock. However, until all methods of workingtree start
 
2920
            # with the current in -memory inventory rather than triggering
 
2921
            # a read, it is more complex - we need to teach read_inventory
 
2922
            # to know when to read, and when to not read first... and possibly
 
2923
            # to save first when the in memory one may be corrupted.
 
2924
            # so for now, we just only write it if it is indeed dirty.
 
2925
            # - RBC 20060907
 
2926
            self._write_inventory(self._inventory)
 
2927
 
 
2928
    def stored_kind(self, file_id):
 
2929
        """See Tree.stored_kind"""
 
2930
        inv, inv_file_id = self._unpack_file_id(file_id)
 
2931
        return inv[inv_file_id].kind
 
2932
 
 
2933
    def extras(self):
 
2934
        """Yield all unversioned files in this WorkingTree.
 
2935
 
 
2936
        If there are any unversioned directories then only the directory is
 
2937
        returned, not all its children.  But if there are unversioned files
 
2938
        under a versioned subdirectory, they are returned.
 
2939
 
 
2940
        Currently returned depth-first, sorted by name within directories.
 
2941
        This is the same order used by 'osutils.walkdirs'.
 
2942
        """
 
2943
        ## TODO: Work from given directory downwards
 
2944
        for path, dir_entry in self.iter_entries_by_dir():
 
2945
            if dir_entry.kind != 'directory':
 
2946
                continue
 
2947
            # mutter("search for unknowns in %r", path)
 
2948
            dirabs = self.abspath(path)
 
2949
            if not isdir(dirabs):
 
2950
                # e.g. directory deleted
 
2951
                continue
 
2952
 
 
2953
            fl = []
 
2954
            for subf in os.listdir(dirabs):
 
2955
                if self.bzrdir.is_control_filename(subf):
 
2956
                    continue
 
2957
                if subf not in dir_entry.children:
 
2958
                    try:
 
2959
                        (subf_norm,
 
2960
                         can_access) = osutils.normalized_filename(subf)
 
2961
                    except UnicodeDecodeError:
 
2962
                        path_os_enc = path.encode(osutils._fs_enc)
 
2963
                        relpath = path_os_enc + '/' + subf
 
2964
                        raise errors.BadFilenameEncoding(relpath,
 
2965
                                                         osutils._fs_enc)
 
2966
                    if subf_norm != subf and can_access:
 
2967
                        if subf_norm not in dir_entry.children:
 
2968
                            fl.append(subf_norm)
 
2969
                    else:
 
2970
                        fl.append(subf)
 
2971
 
 
2972
            fl.sort()
 
2973
            for subf in fl:
 
2974
                subp = pathjoin(path, subf)
 
2975
                yield subp
 
2976
 
 
2977
    def _walkdirs(self, prefix=""):
 
2978
        """Walk the directories of this tree.
 
2979
 
 
2980
        :param prefix: is used as the directrory to start with.
 
2981
        :returns: a generator which yields items in the form::
 
2982
 
 
2983
            ((curren_directory_path, fileid),
 
2984
             [(file1_path, file1_name, file1_kind, None, file1_id,
 
2985
               file1_kind), ... ])
 
2986
        """
 
2987
        _directory = 'directory'
 
2988
        # get the root in the inventory
 
2989
        inv, top_id = self._path2inv_file_id(prefix)
 
2990
        if top_id is None:
 
2991
            pending = []
 
2992
        else:
 
2993
            pending = [(prefix, '', _directory, None, top_id, None)]
 
2994
        while pending:
 
2995
            dirblock = []
 
2996
            currentdir = pending.pop()
 
2997
            # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
 
2998
            top_id = currentdir[4]
 
2999
            if currentdir[0]:
 
3000
                relroot = currentdir[0] + '/'
 
3001
            else:
 
3002
                relroot = ""
 
3003
            # FIXME: stash the node in pending
 
3004
            entry = inv[top_id]
 
3005
            if entry.kind == 'directory':
 
3006
                for name, child in entry.sorted_children():
 
3007
                    dirblock.append((relroot + name, name, child.kind, None,
 
3008
                        child.file_id, child.kind
 
3009
                        ))
 
3010
            yield (currentdir[0], entry.file_id), dirblock
 
3011
            # push the user specified dirs from dirblock
 
3012
            for dir in reversed(dirblock):
 
3013
                if dir[2] == _directory:
 
3014
                    pending.append(dir)
 
3015
 
 
3016
    @needs_write_lock
 
3017
    def update_feature_flags(self, updated_flags):
 
3018
        """Update the feature flags for this branch.
 
3019
 
 
3020
        :param updated_flags: Dictionary mapping feature names to necessities
 
3021
            A necessity can be None to indicate the feature should be removed
 
3022
        """
 
3023
        self._format._update_feature_flags(updated_flags)
 
3024
        self.control_transport.put_bytes('format', self._format.as_string())
 
3025
 
 
3026
 
 
3027
class WorkingTreeFormatRegistry(controldir.ControlComponentFormatRegistry):
 
3028
    """Registry for working tree formats."""
 
3029
 
 
3030
    def __init__(self, other_registry=None):
 
3031
        super(WorkingTreeFormatRegistry, self).__init__(other_registry)
 
3032
        self._default_format = None
 
3033
        self._default_format_key = None
 
3034
 
 
3035
    def get_default(self):
 
3036
        """Return the current default format."""
 
3037
        if (self._default_format_key is not None and
 
3038
            self._default_format is None):
 
3039
            self._default_format = self.get(self._default_format_key)
 
3040
        return self._default_format
 
3041
 
 
3042
    def set_default(self, format):
 
3043
        """Set the default format."""
 
3044
        self._default_format = format
 
3045
        self._default_format_key = None
 
3046
 
 
3047
    def set_default_key(self, format_string):
 
3048
        """Set the default format by its format string."""
 
3049
        self._default_format_key = format_string
 
3050
        self._default_format = None
 
3051
 
 
3052
 
 
3053
format_registry = WorkingTreeFormatRegistry()
 
3054
 
 
3055
 
 
3056
class WorkingTreeFormat(controldir.ControlComponentFormat):
2750
3057
    """An encapsulation of the initialization and open routines for a format.
2751
3058
 
2752
3059
    Formats provide three things:
2764
3071
    object will be created every time regardless.
2765
3072
    """
2766
3073
 
2767
 
    _default_format = None
2768
 
    """The default format used for new trees."""
2769
 
 
2770
 
    _formats = {}
2771
 
    """The known formats."""
2772
 
 
2773
3074
    requires_rich_root = False
2774
3075
 
2775
3076
    upgrade_recommended = False
2776
3077
 
2777
 
    @classmethod
2778
 
    def find_format(klass, a_bzrdir):
2779
 
        """Return the format for the working tree object in a_bzrdir."""
2780
 
        try:
2781
 
            transport = a_bzrdir.get_workingtree_transport(None)
2782
 
            format_string = transport.get_bytes("format")
2783
 
            return klass._formats[format_string]
2784
 
        except errors.NoSuchFile:
2785
 
            raise errors.NoWorkingTree(base=transport.base)
2786
 
        except KeyError:
2787
 
            raise errors.UnknownFormatError(format=format_string,
2788
 
                                            kind="working tree")
 
3078
    requires_normalized_unicode_filenames = False
 
3079
 
 
3080
    case_sensitive_filename = "FoRMaT"
 
3081
 
 
3082
    missing_parent_conflicts = False
 
3083
    """If this format supports missing parent conflicts."""
 
3084
 
 
3085
    supports_versioned_directories = None
 
3086
 
 
3087
    def initialize(self, controldir, revision_id=None, from_branch=None,
 
3088
                   accelerator_tree=None, hardlink=False):
 
3089
        """Initialize a new working tree in controldir.
 
3090
 
 
3091
        :param controldir: ControlDir to initialize the working tree in.
 
3092
        :param revision_id: allows creating a working tree at a different
 
3093
            revision than the branch is at.
 
3094
        :param from_branch: Branch to checkout
 
3095
        :param accelerator_tree: A tree which can be used for retrieving file
 
3096
            contents more quickly than the revision tree, i.e. a workingtree.
 
3097
            The revision tree will be used for cases where accelerator_tree's
 
3098
            content is different.
 
3099
        :param hardlink: If true, hard-link files from accelerator_tree,
 
3100
            where possible.
 
3101
        """
 
3102
        raise NotImplementedError(self.initialize)
2789
3103
 
2790
3104
    def __eq__(self, other):
2791
3105
        return self.__class__ is other.__class__
2793
3107
    def __ne__(self, other):
2794
3108
        return not (self == other)
2795
3109
 
2796
 
    @classmethod
2797
 
    def get_default_format(klass):
2798
 
        """Return the current default format."""
2799
 
        return klass._default_format
2800
 
 
2801
 
    def get_format_string(self):
2802
 
        """Return the ASCII format string that identifies this format."""
2803
 
        raise NotImplementedError(self.get_format_string)
2804
 
 
2805
3110
    def get_format_description(self):
2806
3111
        """Return the short description for this format."""
2807
3112
        raise NotImplementedError(self.get_format_description)
2823
3128
        """True if this format supports stored views."""
2824
3129
        return False
2825
3130
 
2826
 
    @classmethod
2827
 
    def register_format(klass, format):
2828
 
        klass._formats[format.get_format_string()] = format
2829
 
 
2830
 
    @classmethod
2831
 
    def set_default_format(klass, format):
2832
 
        klass._default_format = format
2833
 
 
2834
 
    @classmethod
2835
 
    def unregister_format(klass, format):
2836
 
        del klass._formats[format.get_format_string()]
2837
 
 
2838
 
 
2839
 
class WorkingTreeFormat2(WorkingTreeFormat):
2840
 
    """The second working tree format.
2841
 
 
2842
 
    This format modified the hash cache from the format 1 hash cache.
2843
 
    """
2844
 
 
2845
 
    upgrade_recommended = True
2846
 
 
2847
 
    def get_format_description(self):
2848
 
        """See WorkingTreeFormat.get_format_description()."""
2849
 
        return "Working tree format 2"
2850
 
 
2851
 
    def _stub_initialize_on_transport(self, transport, file_mode):
2852
 
        """Workaround: create control files for a remote working tree.
2853
 
 
2854
 
        This ensures that it can later be updated and dealt with locally,
2855
 
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2856
 
        no working tree.  (See bug #43064).
2857
 
        """
2858
 
        sio = StringIO()
2859
 
        inv = inventory.Inventory()
2860
 
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
2861
 
        sio.seek(0)
2862
 
        transport.put_file('inventory', sio, file_mode)
2863
 
        transport.put_bytes('pending-merges', '', file_mode)
2864
 
 
2865
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2866
 
                   accelerator_tree=None, hardlink=False):
2867
 
        """See WorkingTreeFormat.initialize()."""
2868
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
2869
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2870
 
        if from_branch is not None:
2871
 
            branch = from_branch
2872
 
        else:
2873
 
            branch = a_bzrdir.open_branch()
2874
 
        if revision_id is None:
2875
 
            revision_id = _mod_revision.ensure_null(branch.last_revision())
2876
 
        branch.lock_write()
2877
 
        try:
2878
 
            branch.generate_revision_history(revision_id)
2879
 
        finally:
2880
 
            branch.unlock()
2881
 
        inv = inventory.Inventory()
2882
 
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2883
 
                         branch,
2884
 
                         inv,
2885
 
                         _internal=True,
2886
 
                         _format=self,
2887
 
                         _bzrdir=a_bzrdir)
2888
 
        basis_tree = branch.repository.revision_tree(revision_id)
2889
 
        if basis_tree.inventory.root is not None:
2890
 
            wt.set_root_id(basis_tree.get_root_id())
2891
 
        # set the parent list and cache the basis tree.
2892
 
        if _mod_revision.is_null(revision_id):
2893
 
            parent_trees = []
2894
 
        else:
2895
 
            parent_trees = [(revision_id, basis_tree)]
2896
 
        wt.set_parent_trees(parent_trees)
2897
 
        transform.build_tree(basis_tree, wt)
2898
 
        return wt
2899
 
 
2900
 
    def __init__(self):
2901
 
        super(WorkingTreeFormat2, self).__init__()
2902
 
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
2903
 
 
2904
 
    def open(self, a_bzrdir, _found=False):
2905
 
        """Return the WorkingTree object for a_bzrdir
2906
 
 
2907
 
        _found is a private parameter, do not use it. It is used to indicate
2908
 
               if format probing has already been done.
2909
 
        """
2910
 
        if not _found:
2911
 
            # we are being called directly and must probe.
2912
 
            raise NotImplementedError
2913
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
2914
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2915
 
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2916
 
                           _internal=True,
2917
 
                           _format=self,
2918
 
                           _bzrdir=a_bzrdir)
2919
 
        return wt
2920
 
 
2921
 
class WorkingTreeFormat3(WorkingTreeFormat):
2922
 
    """The second working tree format updated to record a format marker.
2923
 
 
2924
 
    This format:
2925
 
        - exists within a metadir controlling .bzr
2926
 
        - includes an explicit version marker for the workingtree control
2927
 
          files, separate from the BzrDir format
2928
 
        - modifies the hash cache format
2929
 
        - is new in bzr 0.8
2930
 
        - uses a LockDir to guard access for writes.
2931
 
    """
2932
 
 
2933
 
    upgrade_recommended = True
2934
 
 
2935
 
    def get_format_string(self):
2936
 
        """See WorkingTreeFormat.get_format_string()."""
2937
 
        return "Bazaar-NG Working Tree format 3"
2938
 
 
2939
 
    def get_format_description(self):
2940
 
        """See WorkingTreeFormat.get_format_description()."""
2941
 
        return "Working tree format 3"
2942
 
 
2943
 
    _lock_file_name = 'lock'
2944
 
    _lock_class = LockDir
2945
 
 
2946
 
    _tree_class = WorkingTree3
2947
 
 
2948
 
    def __get_matchingbzrdir(self):
2949
 
        return bzrdir.BzrDirMetaFormat1()
2950
 
 
2951
 
    _matchingbzrdir = property(__get_matchingbzrdir)
2952
 
 
2953
 
    def _open_control_files(self, a_bzrdir):
2954
 
        transport = a_bzrdir.get_workingtree_transport(None)
2955
 
        return LockableFiles(transport, self._lock_file_name,
2956
 
                             self._lock_class)
2957
 
 
2958
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2959
 
                   accelerator_tree=None, hardlink=False):
2960
 
        """See WorkingTreeFormat.initialize().
2961
 
 
2962
 
        :param revision_id: if supplied, create a working tree at a different
2963
 
            revision than the branch is at.
2964
 
        :param accelerator_tree: A tree which can be used for retrieving file
2965
 
            contents more quickly than the revision tree, i.e. a workingtree.
2966
 
            The revision tree will be used for cases where accelerator_tree's
2967
 
            content is different.
2968
 
        :param hardlink: If true, hard-link files from accelerator_tree,
2969
 
            where possible.
2970
 
        """
2971
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
2972
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2973
 
        transport = a_bzrdir.get_workingtree_transport(self)
2974
 
        control_files = self._open_control_files(a_bzrdir)
2975
 
        control_files.create_lock()
2976
 
        control_files.lock_write()
2977
 
        transport.put_bytes('format', self.get_format_string(),
2978
 
            mode=a_bzrdir._get_file_mode())
2979
 
        if from_branch is not None:
2980
 
            branch = from_branch
2981
 
        else:
2982
 
            branch = a_bzrdir.open_branch()
2983
 
        if revision_id is None:
2984
 
            revision_id = _mod_revision.ensure_null(branch.last_revision())
2985
 
        # WorkingTree3 can handle an inventory which has a unique root id.
2986
 
        # as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2987
 
        # those trees. And because there isn't a format bump inbetween, we
2988
 
        # are maintaining compatibility with older clients.
2989
 
        # inv = Inventory(root_id=gen_root_id())
2990
 
        inv = self._initial_inventory()
2991
 
        wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2992
 
                         branch,
2993
 
                         inv,
2994
 
                         _internal=True,
2995
 
                         _format=self,
2996
 
                         _bzrdir=a_bzrdir,
2997
 
                         _control_files=control_files)
2998
 
        wt.lock_tree_write()
2999
 
        try:
3000
 
            basis_tree = branch.repository.revision_tree(revision_id)
3001
 
            # only set an explicit root id if there is one to set.
3002
 
            if basis_tree.inventory.root is not None:
3003
 
                wt.set_root_id(basis_tree.get_root_id())
3004
 
            if revision_id == _mod_revision.NULL_REVISION:
3005
 
                wt.set_parent_trees([])
3006
 
            else:
3007
 
                wt.set_parent_trees([(revision_id, basis_tree)])
3008
 
            transform.build_tree(basis_tree, wt)
3009
 
        finally:
3010
 
            # Unlock in this order so that the unlock-triggers-flush in
3011
 
            # WorkingTree is given a chance to fire.
3012
 
            control_files.unlock()
3013
 
            wt.unlock()
3014
 
        return wt
3015
 
 
3016
 
    def _initial_inventory(self):
3017
 
        return inventory.Inventory()
3018
 
 
3019
 
    def __init__(self):
3020
 
        super(WorkingTreeFormat3, self).__init__()
3021
 
 
3022
 
    def open(self, a_bzrdir, _found=False):
3023
 
        """Return the WorkingTree object for a_bzrdir
3024
 
 
3025
 
        _found is a private parameter, do not use it. It is used to indicate
3026
 
               if format probing has already been done.
3027
 
        """
3028
 
        if not _found:
3029
 
            # we are being called directly and must probe.
3030
 
            raise NotImplementedError
3031
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
3032
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
3033
 
        wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3034
 
        return wt
3035
 
 
3036
 
    def _open(self, a_bzrdir, control_files):
3037
 
        """Open the tree itself.
3038
 
 
3039
 
        :param a_bzrdir: the dir for the tree.
3040
 
        :param control_files: the control files for the tree.
3041
 
        """
3042
 
        return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3043
 
                                _internal=True,
3044
 
                                _format=self,
3045
 
                                _bzrdir=a_bzrdir,
3046
 
                                _control_files=control_files)
3047
 
 
3048
 
    def __str__(self):
3049
 
        return self.get_format_string()
3050
 
 
3051
 
 
3052
 
__default_format = WorkingTreeFormat6()
3053
 
WorkingTreeFormat.register_format(__default_format)
3054
 
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3055
 
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3056
 
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3057
 
WorkingTreeFormat.set_default_format(__default_format)
3058
 
# formats which have no format string are not discoverable
3059
 
# and not independently creatable, so are not registered.
3060
 
_legacy_formats = [WorkingTreeFormat2(),
3061
 
                   ]
 
3131
    def get_controldir_for_branch(self):
 
3132
        """Get the control directory format for creating branches.
 
3133
 
 
3134
        This is to support testing of working tree formats that can not exist
 
3135
        in the same control directory as a branch.
 
3136
        """
 
3137
        return self._matchingbzrdir
 
3138
 
 
3139
 
 
3140
class WorkingTreeFormatMetaDir(bzrdir.BzrFormat, WorkingTreeFormat):
 
3141
    """Base class for working trees that live in bzr meta directories."""
 
3142
 
 
3143
    def __init__(self):
 
3144
        WorkingTreeFormat.__init__(self)
 
3145
        bzrdir.BzrFormat.__init__(self)
 
3146
 
 
3147
    @classmethod
 
3148
    def find_format_string(klass, controldir):
 
3149
        """Return format name for the working tree object in controldir."""
 
3150
        try:
 
3151
            transport = controldir.get_workingtree_transport(None)
 
3152
            return transport.get_bytes("format")
 
3153
        except errors.NoSuchFile:
 
3154
            raise errors.NoWorkingTree(base=transport.base)
 
3155
 
 
3156
    @classmethod
 
3157
    def find_format(klass, controldir):
 
3158
        """Return the format for the working tree object in controldir."""
 
3159
        format_string = klass.find_format_string(controldir)
 
3160
        return klass._find_format(format_registry, 'working tree',
 
3161
                format_string)
 
3162
 
 
3163
    def check_support_status(self, allow_unsupported, recommend_upgrade=True,
 
3164
            basedir=None):
 
3165
        WorkingTreeFormat.check_support_status(self,
 
3166
            allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
 
3167
            basedir=basedir)
 
3168
        bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
 
3169
            recommend_upgrade=recommend_upgrade, basedir=basedir)
 
3170
 
 
3171
    def get_controldir_for_branch(self):
 
3172
        """Get the control directory format for creating branches.
 
3173
 
 
3174
        This is to support testing of working tree formats that can not exist
 
3175
        in the same control directory as a branch.
 
3176
        """
 
3177
        return self._matchingbzrdir
 
3178
 
 
3179
 
 
3180
class WorkingTreeFormatMetaDir(bzrdir.BzrFormat, WorkingTreeFormat):
 
3181
    """Base class for working trees that live in bzr meta directories."""
 
3182
 
 
3183
    def __init__(self):
 
3184
        WorkingTreeFormat.__init__(self)
 
3185
        bzrdir.BzrFormat.__init__(self)
 
3186
 
 
3187
    @classmethod
 
3188
    def find_format_string(klass, controldir):
 
3189
        """Return format name for the working tree object in controldir."""
 
3190
        try:
 
3191
            transport = controldir.get_workingtree_transport(None)
 
3192
            return transport.get_bytes("format")
 
3193
        except errors.NoSuchFile:
 
3194
            raise errors.NoWorkingTree(base=transport.base)
 
3195
 
 
3196
    @classmethod
 
3197
    def find_format(klass, controldir):
 
3198
        """Return the format for the working tree object in controldir."""
 
3199
        format_string = klass.find_format_string(controldir)
 
3200
        return klass._find_format(format_registry, 'working tree',
 
3201
                format_string)
 
3202
 
 
3203
    def check_support_status(self, allow_unsupported, recommend_upgrade=True,
 
3204
            basedir=None):
 
3205
        WorkingTreeFormat.check_support_status(self,
 
3206
            allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
 
3207
            basedir=basedir)
 
3208
        bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
 
3209
            recommend_upgrade=recommend_upgrade, basedir=basedir)
 
3210
 
 
3211
 
 
3212
format_registry.register_lazy("Bazaar Working Tree Format 4 (bzr 0.15)\n",
 
3213
    "bzrlib.workingtree_4", "WorkingTreeFormat4")
 
3214
format_registry.register_lazy("Bazaar Working Tree Format 5 (bzr 1.11)\n",
 
3215
    "bzrlib.workingtree_4", "WorkingTreeFormat5")
 
3216
format_registry.register_lazy("Bazaar Working Tree Format 6 (bzr 1.14)\n",
 
3217
    "bzrlib.workingtree_4", "WorkingTreeFormat6")
 
3218
format_registry.register_lazy("Bazaar-NG Working Tree format 3",
 
3219
    "bzrlib.workingtree_3", "WorkingTreeFormat3")
 
3220
format_registry.set_default_key("Bazaar Working Tree Format 6 (bzr 1.14)\n")