~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Benoît Pierre
  • Date: 2009-11-02 22:24:29 UTC
  • mto: (4634.96.1 integration-2.0)
  • mto: This revision was merged to the branch mainline in revision 4798.
  • Revision ID: benoit.pierre@gmail.com-20091102222429-xqdyo6n8odh3xbbd
Small fix for handling of short option names in shellcomplete_on_options.

Show diffs side-by-side

added added

removed removed

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