← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Martin Pool
  • Date: 2009-07-10 07:47:21 UTC
  • mto: This revision was merged to the branch mainline in revision 4566.
  • Revision ID: mbp@sourcefrog.net-20090710074721-hbq7cl8rvwf8vz6s
Add an option for unlock errors to be non-fatal

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/workingtree.py
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008 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
 
    graph as _mod_graph,
57
61
    hashcache,
58
62
    ignores,
59
63
    inventory,
60
64
    merge,
61
65
    revision as _mod_revision,
62
66
    revisiontree,
63
 
    rio as _mod_rio,
 
67
    textui,
 
68
    trace,
64
69
    transform,
65
 
    transport,
66
70
    ui,
67
71
    views,
68
72
    xml5,
69
73
    xml7,
70
74
    )
 
75
import bzrlib.branch
 
76
from bzrlib.transport import get_transport
 
77
from bzrlib.workingtree_4 import (
 
78
    WorkingTreeFormat4,
 
79
    WorkingTreeFormat5,
 
80
    WorkingTreeFormat6,
 
81
    )
71
82
""")
72
83
 
73
84
from bzrlib import symbol_versioning
74
85
from bzrlib.decorators import needs_read_lock, needs_write_lock
75
 
from bzrlib.lock import LogicalLockResult
 
86
from bzrlib.lockable_files import LockableFiles
 
87
from bzrlib.lockdir import LockDir
76
88
import bzrlib.mutabletree
77
89
from bzrlib.mutabletree import needs_tree_write_lock
78
90
from bzrlib import osutils
86
98
    splitpath,
87
99
    supports_executable,
88
100
    )
 
101
from bzrlib.filters import filtered_input_file
89
102
from bzrlib.trace import mutter, note
 
103
from bzrlib.transport.local import LocalTransport
 
104
from bzrlib.progress import DummyProgress, ProgressPhase
90
105
from bzrlib.revision import CURRENT_REVISION
 
106
from bzrlib.rio import RioReader, rio_file, Stanza
91
107
from bzrlib.symbol_versioning import (
92
108
    deprecated_passed,
93
109
    DEPRECATED_PARAMETER,
95
111
 
96
112
 
97
113
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
114
CONFLICT_HEADER_1 = "BZR conflict list format 1"
102
115
 
103
116
ERROR_PATH_NOT_FOUND = 3    # WindowsError errno code, equivalent to ENOENT
158
171
        return ''
159
172
 
160
173
 
161
 
class WorkingTree(bzrlib.mutabletree.MutableTree,
162
 
    controldir.ControlComponent):
 
174
class WorkingTree(bzrlib.mutabletree.MutableTree):
163
175
    """Working copy tree.
164
176
 
165
 
    :ivar basedir: The root of the tree on disk. This is a unicode path object
166
 
        (as opposed to a URL).
 
177
    The inventory is held in the `Branch` working-inventory, and the
 
178
    files are in a directory on disk.
 
179
 
 
180
    It is possible for a `WorkingTree` to have a filename which is
 
181
    not listed in the Inventory and vice versa.
167
182
    """
168
183
 
169
184
    # override this to set the strategy for storing views
172
187
 
173
188
    def __init__(self, basedir='.',
174
189
                 branch=DEPRECATED_PARAMETER,
 
190
                 _inventory=None,
175
191
                 _control_files=None,
176
192
                 _internal=False,
177
193
                 _format=None,
192
208
        else:
193
209
            self._branch = self.bzrdir.open_branch()
194
210
        self.basedir = realpath(basedir)
195
 
        self._control_files = _control_files
 
211
        # if branch is at our basedir and is a format 6 or less
 
212
        if isinstance(self._format, WorkingTreeFormat2):
 
213
            # share control object
 
214
            self._control_files = self.branch.control_files
 
215
        else:
 
216
            # assume all other formats have their own control files.
 
217
            self._control_files = _control_files
196
218
        self._transport = self._control_files._transport
197
219
        # update the whole cache up front and write to disk if anything changed;
198
220
        # in the future we might want to do this more selectively
214
236
            mutter("write hc")
215
237
            hc.write()
216
238
 
 
239
        if _inventory is None:
 
240
            # This will be acquired on lock_read() or lock_write()
 
241
            self._inventory_is_modified = False
 
242
            self._inventory = None
 
243
        else:
 
244
            # the caller of __init__ has provided an inventory,
 
245
            # we assume they know what they are doing - as its only
 
246
            # the Format factory and creation methods that are
 
247
            # permitted to do this.
 
248
            self._set_inventory(_inventory, dirty=False)
217
249
        self._detect_case_handling()
218
250
        self._rules_searcher = None
219
251
        self.views = self._make_views()
220
252
 
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
253
    def _detect_case_handling(self):
242
254
        wt_trans = self.bzrdir.get_workingtree_transport(None)
243
255
        try:
244
 
            wt_trans.stat(self._format.case_sensitive_filename)
 
256
            wt_trans.stat("FoRMaT")
245
257
        except errors.NoSuchFile:
246
258
            self.case_sensitive = True
247
259
        else:
280
292
    def supports_views(self):
281
293
        return self.views.supports_views()
282
294
 
 
295
    def _set_inventory(self, inv, dirty):
 
296
        """Set the internal cached inventory.
 
297
 
 
298
        :param inv: The inventory to set.
 
299
        :param dirty: A boolean indicating whether the inventory is the same
 
300
            logical inventory as whats on disk. If True the inventory is not
 
301
            the same and should be written to disk or data will be lost, if
 
302
            False then the inventory is the same as that on disk and any
 
303
            serialisation would be unneeded overhead.
 
304
        """
 
305
        self._inventory = inv
 
306
        self._inventory_is_modified = dirty
 
307
 
283
308
    @staticmethod
284
309
    def open(path=None, _unsupported=False):
285
310
        """Open an existing working tree at path.
306
331
        if path is None:
307
332
            path = osutils.getcwd()
308
333
        control, relpath = bzrdir.BzrDir.open_containing(path)
 
334
 
309
335
        return control.open_workingtree(), relpath
310
336
 
311
337
    @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
338
    def open_downlevel(path=None):
379
339
        """Open an unsupported working tree.
380
340
 
393
353
                return True, None
394
354
            else:
395
355
                return True, tree
396
 
        t = transport.get_transport(location)
397
 
        iterator = bzrdir.BzrDir.find_bzrdirs(t, evaluate=evaluate,
 
356
        transport = get_transport(location)
 
357
        iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
398
358
                                              list_current=list_current)
399
 
        return [tr for tr in iterator if tr is not None]
 
359
        return [t for t in iterator if t is not None]
 
360
 
 
361
    # should be deprecated - this is slow and in any case treating them as a
 
362
    # container is (we now know) bad style -- mbp 20070302
 
363
    ## @deprecated_method(zero_fifteen)
 
364
    def __iter__(self):
 
365
        """Iterate through file_ids for this tree.
 
366
 
 
367
        file_ids are in a WorkingTree if they are in the working inventory
 
368
        and the working file exists.
 
369
        """
 
370
        inv = self._inventory
 
371
        for path, ie in inv.iter_entries():
 
372
            if osutils.lexists(self.abspath(path)):
 
373
                yield ie.file_id
400
374
 
401
375
    def all_file_ids(self):
402
376
        """See Tree.iter_all_file_ids"""
403
 
        raise NotImplementedError(self.all_file_ids)
 
377
        return set(self.inventory)
404
378
 
405
379
    def __repr__(self):
406
380
        return "<%s of %s>" % (self.__class__.__name__,
461
435
        return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
462
436
 
463
437
    def get_file_with_stat(self, file_id, path=None, filtered=True,
464
 
                           _fstat=osutils.fstat):
 
438
        _fstat=os.fstat):
465
439
        """See Tree.get_file_with_stat."""
466
440
        if path is None:
467
441
            path = self.id2path(file_id)
469
443
        stat_value = _fstat(file_obj.fileno())
470
444
        if filtered and self.supports_content_filtering():
471
445
            filters = self._content_filter_stack(path)
472
 
            file_obj = _mod_filters.filtered_input_file(file_obj, filters)
 
446
            file_obj = filtered_input_file(file_obj, filters)
473
447
        return (file_obj, stat_value)
474
448
 
475
449
    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()
 
450
        return self.get_file(file_id, path=path, filtered=filtered).read()
481
451
 
482
452
    def get_file_byname(self, filename, filtered=True):
483
453
        path = self.abspath(filename)
484
454
        f = file(path, 'rb')
485
455
        if filtered and self.supports_content_filtering():
486
456
            filters = self._content_filter_stack(filename)
487
 
            return _mod_filters.filtered_input_file(f, filters)
 
457
            return filtered_input_file(f, filters)
488
458
        else:
489
459
            return f
490
460
 
496
466
        finally:
497
467
            file.close()
498
468
 
 
469
    @needs_read_lock
 
470
    def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
 
471
        """See Tree.annotate_iter
 
472
 
 
473
        This implementation will use the basis tree implementation if possible.
 
474
        Lines not in the basis are attributed to CURRENT_REVISION
 
475
 
 
476
        If there are pending merges, lines added by those merges will be
 
477
        incorrectly attributed to CURRENT_REVISION (but after committing, the
 
478
        attribution will be correct).
 
479
        """
 
480
        basis = self.basis_tree()
 
481
        basis.lock_read()
 
482
        try:
 
483
            changes = self.iter_changes(basis, True, [self.id2path(file_id)],
 
484
                require_versioned=True).next()
 
485
            changed_content, kind = changes[2], changes[6]
 
486
            if not changed_content:
 
487
                return basis.annotate_iter(file_id)
 
488
            if kind[1] is None:
 
489
                return None
 
490
            import annotate
 
491
            if kind[0] != 'file':
 
492
                old_lines = []
 
493
            else:
 
494
                old_lines = list(basis.annotate_iter(file_id))
 
495
            old = [old_lines]
 
496
            for tree in self.branch.repository.revision_trees(
 
497
                self.get_parent_ids()[1:]):
 
498
                if file_id not in tree:
 
499
                    continue
 
500
                old.append(list(tree.annotate_iter(file_id)))
 
501
            return annotate.reannotate(old, self.get_file(file_id).readlines(),
 
502
                                       default_revision)
 
503
        finally:
 
504
            basis.unlock()
 
505
 
 
506
    def _get_ancestors(self, default_revision):
 
507
        ancestors = set([default_revision])
 
508
        for parent_id in self.get_parent_ids():
 
509
            ancestors.update(self.branch.repository.get_ancestry(
 
510
                             parent_id, topo_sorted=False))
 
511
        return ancestors
 
512
 
499
513
    def get_parent_ids(self):
500
514
        """See Tree.get_parent_ids.
501
515
 
508
522
        else:
509
523
            parents = [last_rev]
510
524
        try:
511
 
            merges_bytes = self._transport.get_bytes('pending-merges')
 
525
            merges_file = self._transport.get('pending-merges')
512
526
        except errors.NoSuchFile:
513
527
            pass
514
528
        else:
515
 
            for l in osutils.split_lines(merges_bytes):
 
529
            for l in merges_file.readlines():
516
530
                revision_id = l.rstrip('\n')
517
531
                parents.append(revision_id)
518
532
        return parents
519
533
 
 
534
    @needs_read_lock
520
535
    def get_root_id(self):
521
536
        """Return the id of this trees root"""
522
 
        raise NotImplementedError(self.get_root_id)
 
537
        return self._inventory.root.file_id
 
538
 
 
539
    def _get_store_filename(self, file_id):
 
540
        ## XXX: badly named; this is not in the store at all
 
541
        return self.abspath(self.id2path(file_id))
523
542
 
524
543
    @needs_read_lock
525
544
    def clone(self, to_bzrdir, revision_id=None):
555
574
    def id2abspath(self, file_id):
556
575
        return self.abspath(self.id2path(file_id))
557
576
 
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)
 
577
    def has_id(self, file_id):
 
578
        # files that have been deleted are excluded
 
579
        inv = self.inventory
 
580
        if not inv.has_id(file_id):
 
581
            return False
 
582
        path = inv.id2path(file_id)
 
583
        return osutils.lexists(self.abspath(path))
 
584
 
 
585
    def has_or_had_id(self, file_id):
 
586
        if file_id == self.inventory.root.file_id:
 
587
            return True
 
588
        return self.inventory.has_id(file_id)
 
589
 
 
590
    __contains__ = has_id
585
591
 
586
592
    def get_file_size(self, file_id):
587
593
        """See Tree.get_file_size"""
588
 
        # XXX: this returns the on-disk size; it should probably return the
589
 
        # canonical size
590
594
        try:
591
595
            return os.path.getsize(self.id2abspath(file_id))
592
596
        except OSError, e:
595
599
            else:
596
600
                return None
597
601
 
 
602
    @needs_read_lock
 
603
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
604
        if not path:
 
605
            path = self._inventory.id2path(file_id)
 
606
        return self._hashcache.get_sha1(path, stat_value)
 
607
 
 
608
    def get_file_mtime(self, file_id, path=None):
 
609
        if not path:
 
610
            path = self.inventory.id2path(file_id)
 
611
        return os.lstat(self.abspath(path)).st_mtime
 
612
 
 
613
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
 
614
        file_id = self.path2id(path)
 
615
        return self._inventory[file_id].executable
 
616
 
 
617
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
 
618
        mode = stat_result.st_mode
 
619
        return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
 
620
 
 
621
    if not supports_executable():
 
622
        def is_executable(self, file_id, path=None):
 
623
            return self._inventory[file_id].executable
 
624
 
 
625
        _is_executable_from_path_and_stat = \
 
626
            _is_executable_from_path_and_stat_from_basis
 
627
    else:
 
628
        def is_executable(self, file_id, path=None):
 
629
            if not path:
 
630
                path = self.id2path(file_id)
 
631
            mode = os.lstat(self.abspath(path)).st_mode
 
632
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
 
633
 
 
634
        _is_executable_from_path_and_stat = \
 
635
            _is_executable_from_path_and_stat_from_stat
 
636
 
 
637
    @needs_tree_write_lock
 
638
    def _add(self, files, ids, kinds):
 
639
        """See MutableTree._add."""
 
640
        # TODO: Re-adding a file that is removed in the working copy
 
641
        # should probably put it back with the previous ID.
 
642
        # the read and write working inventory should not occur in this
 
643
        # function - they should be part of lock_write and unlock.
 
644
        inv = self.inventory
 
645
        for f, file_id, kind in zip(files, ids, kinds):
 
646
            if file_id is None:
 
647
                inv.add_path(f, kind=kind)
 
648
            else:
 
649
                inv.add_path(f, kind=kind, file_id=file_id)
 
650
            self._inventory_is_modified = True
 
651
 
598
652
    @needs_tree_write_lock
599
653
    def _gather_kinds(self, files, kinds):
600
654
        """See MutableTree._gather_kinds."""
615
669
        and setting the list to its value plus revision_id.
616
670
 
617
671
        :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.
 
672
        be a ghost revision as long as its not the first parent to be added,
 
673
        or the allow_leftmost_as_ghost parameter is set True.
620
674
        :param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
621
675
        """
622
676
        parents = self.get_parent_ids() + [revision_id]
673
727
            raise
674
728
        kind = _mapper(stat_result.st_mode)
675
729
        if kind == 'file':
676
 
            return self._file_content_summary(path, stat_result)
 
730
            size = stat_result.st_size
 
731
            # try for a stat cache lookup
 
732
            executable = self._is_executable_from_path_and_stat(path, stat_result)
 
733
            return (kind, size, executable, self._sha_from_stat(
 
734
                path, stat_result))
677
735
        elif kind == 'directory':
678
736
            # perhaps it looks like a plain directory, but it's really a
679
737
            # reference.
686
744
        else:
687
745
            return (kind, None, None, None)
688
746
 
689
 
    def _file_content_summary(self, path, stat_result):
690
 
        size = stat_result.st_size
691
 
        executable = self._is_executable_from_path_and_stat(path, stat_result)
692
 
        # try for a stat cache lookup
693
 
        return ('file', size, executable, self._sha_from_stat(
694
 
            path, stat_result))
695
 
 
696
747
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
697
748
        """Common ghost checking functionality from set_parent_*.
698
749
 
725
776
            if revision_id in heads and revision_id not in new_revision_ids:
726
777
                new_revision_ids.append(revision_id)
727
778
        if new_revision_ids != revision_ids:
728
 
            mutter('requested to set revision_ids = %s,'
 
779
            trace.mutter('requested to set revision_ids = %s,'
729
780
                         ' but filtered to %s', revision_ids, new_revision_ids)
730
781
        return new_revision_ids
731
782
 
757
808
        self._set_merges_from_parent_ids(revision_ids)
758
809
 
759
810
    @needs_tree_write_lock
 
811
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
 
812
        """See MutableTree.set_parent_trees."""
 
813
        parent_ids = [rev for (rev, tree) in parents_list]
 
814
        for revision_id in parent_ids:
 
815
            _mod_revision.check_not_reserved_id(revision_id)
 
816
 
 
817
        self._check_parents_for_ghosts(parent_ids,
 
818
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
819
 
 
820
        parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
 
821
 
 
822
        if len(parent_ids) == 0:
 
823
            leftmost_parent_id = _mod_revision.NULL_REVISION
 
824
            leftmost_parent_tree = None
 
825
        else:
 
826
            leftmost_parent_id, leftmost_parent_tree = parents_list[0]
 
827
 
 
828
        if self._change_last_revision(leftmost_parent_id):
 
829
            if leftmost_parent_tree is None:
 
830
                # If we don't have a tree, fall back to reading the
 
831
                # parent tree from the repository.
 
832
                self._cache_basis_inventory(leftmost_parent_id)
 
833
            else:
 
834
                inv = leftmost_parent_tree.inventory
 
835
                xml = self._create_basis_xml_from_inventory(
 
836
                                        leftmost_parent_id, inv)
 
837
                self._write_basis_inventory(xml)
 
838
        self._set_merges_from_parent_ids(parent_ids)
 
839
 
 
840
    @needs_tree_write_lock
760
841
    def set_pending_merges(self, rev_list):
761
842
        parents = self.get_parent_ids()
762
843
        leftmost = parents[:1]
767
848
    def set_merge_modified(self, modified_hashes):
768
849
        def iter_stanzas():
769
850
            for file_id, hash in modified_hashes.iteritems():
770
 
                yield _mod_rio.Stanza(file_id=file_id.decode('utf8'),
771
 
                    hash=hash)
 
851
                yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
772
852
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
773
853
 
774
854
    def _sha_from_stat(self, path, stat_result):
783
863
 
784
864
    def _put_rio(self, filename, stanzas, header):
785
865
        self._must_be_locked()
786
 
        my_file = _mod_rio.rio_file(stanzas, header)
 
866
        my_file = rio_file(stanzas, header)
787
867
        self._transport.put_file(filename, my_file,
788
868
            mode=self.bzrdir._get_file_mode())
789
869
 
790
870
    @needs_write_lock # because merge pulls data into the branch.
791
871
    def merge_from_branch(self, branch, to_revision=None, from_revision=None,
792
 
                          merge_type=None, force=False):
 
872
        merge_type=None):
793
873
        """Merge from a branch into this working tree.
794
874
 
795
875
        :param branch: The branch to merge from.
799
879
            branch.last_revision().
800
880
        """
801
881
        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()
 
882
        pb = ui.ui_factory.nested_progress_bar()
 
883
        try:
 
884
            merger = Merger(self.branch, this_tree=self, pb=pb)
 
885
            merger.pp = ProgressPhase("Merge phase", 5, pb)
 
886
            merger.pp.next_phase()
 
887
            # check that there are no
 
888
            # local alterations
 
889
            merger.check_basis(check_clean=True, require_commits=False)
 
890
            if to_revision is None:
 
891
                to_revision = _mod_revision.ensure_null(branch.last_revision())
 
892
            merger.other_rev_id = to_revision
 
893
            if _mod_revision.is_null(merger.other_rev_id):
 
894
                raise errors.NoCommits(branch)
 
895
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
896
            merger.other_basis = merger.other_rev_id
 
897
            merger.other_tree = self.branch.repository.revision_tree(
 
898
                merger.other_rev_id)
 
899
            merger.other_branch = branch
 
900
            merger.pp.next_phase()
 
901
            if from_revision is None:
 
902
                merger.find_base()
 
903
            else:
 
904
                merger.set_base_revision(from_revision, branch)
 
905
            if merger.base_rev_id == merger.other_rev_id:
 
906
                raise errors.PointlessMerge
 
907
            merger.backup_files = False
 
908
            if merge_type is None:
 
909
                merger.merge_type = Merge3Merger
 
910
            else:
 
911
                merger.merge_type = merge_type
 
912
            merger.set_interesting_files(None)
 
913
            merger.show_base = False
 
914
            merger.reprocess = False
 
915
            conflicts = merger.do_merge()
 
916
            merger.set_pending()
 
917
        finally:
 
918
            pb.finished()
832
919
        return conflicts
833
920
 
 
921
    @needs_read_lock
834
922
    def merge_modified(self):
835
923
        """Return a dictionary of files modified by a merge.
836
924
 
841
929
        This returns a map of file_id->sha1, containing only files which are
842
930
        still in the working inventory and have that text hash.
843
931
        """
844
 
        raise NotImplementedError(self.merge_modified)
 
932
        try:
 
933
            hashfile = self._transport.get('merge-hashes')
 
934
        except errors.NoSuchFile:
 
935
            return {}
 
936
        try:
 
937
            merge_hashes = {}
 
938
            try:
 
939
                if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
 
940
                    raise errors.MergeModifiedFormatError()
 
941
            except StopIteration:
 
942
                raise errors.MergeModifiedFormatError()
 
943
            for s in RioReader(hashfile):
 
944
                # RioReader reads in Unicode, so convert file_ids back to utf8
 
945
                file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
 
946
                if file_id not in self.inventory:
 
947
                    continue
 
948
                text_hash = s.get("hash")
 
949
                if text_hash == self.get_file_sha1(file_id):
 
950
                    merge_hashes[file_id] = text_hash
 
951
            return merge_hashes
 
952
        finally:
 
953
            hashfile.close()
845
954
 
846
955
    @needs_write_lock
847
956
    def mkdir(self, path, file_id=None):
852
961
        self.add(path, file_id, 'directory')
853
962
        return file_id
854
963
 
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)
 
964
    def get_symlink_target(self, file_id):
 
965
        abspath = self.id2abspath(file_id)
860
966
        target = osutils.readlink(abspath)
861
967
        return target
862
968
 
 
969
    @needs_write_lock
863
970
    def subsume(self, other_tree):
864
 
        raise NotImplementedError(self.subsume)
 
971
        def add_children(inventory, entry):
 
972
            for child_entry in entry.children.values():
 
973
                inventory._byid[child_entry.file_id] = child_entry
 
974
                if child_entry.kind == 'directory':
 
975
                    add_children(inventory, child_entry)
 
976
        if other_tree.get_root_id() == self.get_root_id():
 
977
            raise errors.BadSubsumeSource(self, other_tree,
 
978
                                          'Trees have the same root')
 
979
        try:
 
980
            other_tree_path = self.relpath(other_tree.basedir)
 
981
        except errors.PathNotChild:
 
982
            raise errors.BadSubsumeSource(self, other_tree,
 
983
                'Tree is not contained by the other')
 
984
        new_root_parent = self.path2id(osutils.dirname(other_tree_path))
 
985
        if new_root_parent is None:
 
986
            raise errors.BadSubsumeSource(self, other_tree,
 
987
                'Parent directory is not versioned.')
 
988
        # We need to ensure that the result of a fetch will have a
 
989
        # versionedfile for the other_tree root, and only fetching into
 
990
        # RepositoryKnit2 guarantees that.
 
991
        if not self.branch.repository.supports_rich_root():
 
992
            raise errors.SubsumeTargetNeedsUpgrade(other_tree)
 
993
        other_tree.lock_tree_write()
 
994
        try:
 
995
            new_parents = other_tree.get_parent_ids()
 
996
            other_root = other_tree.inventory.root
 
997
            other_root.parent_id = new_root_parent
 
998
            other_root.name = osutils.basename(other_tree_path)
 
999
            self.inventory.add(other_root)
 
1000
            add_children(self.inventory, other_root)
 
1001
            self._write_inventory(self.inventory)
 
1002
            # normally we don't want to fetch whole repositories, but i think
 
1003
            # here we really do want to consolidate the whole thing.
 
1004
            for parent_id in other_tree.get_parent_ids():
 
1005
                self.branch.fetch(other_tree.branch, parent_id)
 
1006
                self.add_parent_tree_id(parent_id)
 
1007
        finally:
 
1008
            other_tree.unlock()
 
1009
        other_tree.bzrdir.retire_bzrdir()
865
1010
 
866
1011
    def _setup_directory_is_tree_reference(self):
867
1012
        if self._branch.repository._format.supports_tree_reference:
889
1034
        # checkout in a subdirectory.  This can be avoided by not adding
890
1035
        # it.  mbp 20070306
891
1036
 
 
1037
    @needs_tree_write_lock
892
1038
    def extract(self, file_id, format=None):
893
1039
        """Extract a subtree from this tree.
894
1040
 
895
1041
        A new branch will be created, relative to the path for this tree.
896
1042
        """
897
 
        raise NotImplementedError(self.extract)
 
1043
        self.flush()
 
1044
        def mkdirs(path):
 
1045
            segments = osutils.splitpath(path)
 
1046
            transport = self.branch.bzrdir.root_transport
 
1047
            for name in segments:
 
1048
                transport = transport.clone(name)
 
1049
                transport.ensure_base()
 
1050
            return transport
 
1051
 
 
1052
        sub_path = self.id2path(file_id)
 
1053
        branch_transport = mkdirs(sub_path)
 
1054
        if format is None:
 
1055
            format = self.bzrdir.cloning_metadir()
 
1056
        branch_transport.ensure_base()
 
1057
        branch_bzrdir = format.initialize_on_transport(branch_transport)
 
1058
        try:
 
1059
            repo = branch_bzrdir.find_repository()
 
1060
        except errors.NoRepositoryPresent:
 
1061
            repo = branch_bzrdir.create_repository()
 
1062
        if not repo.supports_rich_root():
 
1063
            raise errors.RootNotRich()
 
1064
        new_branch = branch_bzrdir.create_branch()
 
1065
        new_branch.pull(self.branch)
 
1066
        for parent_id in self.get_parent_ids():
 
1067
            new_branch.fetch(self.branch, parent_id)
 
1068
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
 
1069
        if tree_transport.base != branch_transport.base:
 
1070
            tree_bzrdir = format.initialize_on_transport(tree_transport)
 
1071
            branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
 
1072
        else:
 
1073
            tree_bzrdir = branch_bzrdir
 
1074
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
 
1075
        wt.set_parent_ids(self.get_parent_ids())
 
1076
        my_inv = self.inventory
 
1077
        child_inv = inventory.Inventory(root_id=None)
 
1078
        new_root = my_inv[file_id]
 
1079
        my_inv.remove_recursive_id(file_id)
 
1080
        new_root.parent_id = None
 
1081
        child_inv.add(new_root)
 
1082
        self._write_inventory(my_inv)
 
1083
        wt._write_inventory(child_inv)
 
1084
        return wt
 
1085
 
 
1086
    def _serialize(self, inventory, out_file):
 
1087
        xml5.serializer_v5.write_inventory(self._inventory, out_file,
 
1088
            working=True)
 
1089
 
 
1090
    def _deserialize(selt, in_file):
 
1091
        return xml5.serializer_v5.read_inventory(in_file)
898
1092
 
899
1093
    def flush(self):
900
 
        """Write the in memory meta data to disk."""
901
 
        raise NotImplementedError(self.flush)
 
1094
        """Write the in memory inventory to disk."""
 
1095
        # TODO: Maybe this should only write on dirty ?
 
1096
        if self._control_files._lock_mode != 'w':
 
1097
            raise errors.NotWriteLocked(self)
 
1098
        sio = StringIO()
 
1099
        self._serialize(self._inventory, sio)
 
1100
        sio.seek(0)
 
1101
        self._transport.put_file('inventory', sio,
 
1102
            mode=self.bzrdir._get_file_mode())
 
1103
        self._inventory_is_modified = False
902
1104
 
903
1105
    def _kind(self, relpath):
904
1106
        return osutils.file_kind(self.abspath(relpath))
910
1112
        This does not include files that have been deleted in this
911
1113
        tree. Skips the control directory.
912
1114
 
913
 
        :param include_root: if True, return an entry for the root
 
1115
        :param include_root: if True, do not return an entry for the root
914
1116
        :param from_dir: start from this directory or None for the root
915
1117
        :param recursive: whether to recurse into subdirectories or not
916
1118
        """
917
 
        raise NotImplementedError(self.list_files)
918
 
 
919
 
    def move(self, from_paths, to_dir=None, after=False):
 
1119
        # list_files is an iterator, so @needs_read_lock doesn't work properly
 
1120
        # with it. So callers should be careful to always read_lock the tree.
 
1121
        if not self.is_locked():
 
1122
            raise errors.ObjectNotLocked(self)
 
1123
 
 
1124
        inv = self.inventory
 
1125
        if from_dir is None and include_root is True:
 
1126
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
 
1127
        # Convert these into local objects to save lookup times
 
1128
        pathjoin = osutils.pathjoin
 
1129
        file_kind = self._kind
 
1130
 
 
1131
        # transport.base ends in a slash, we want the piece
 
1132
        # between the last two slashes
 
1133
        transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
 
1134
 
 
1135
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
 
1136
 
 
1137
        # directory file_id, relative path, absolute path, reverse sorted children
 
1138
        if from_dir is not None:
 
1139
            from_dir_id = inv.path2id(from_dir)
 
1140
            if from_dir_id is None:
 
1141
                # Directory not versioned
 
1142
                return
 
1143
            from_dir_abspath = pathjoin(self.basedir, from_dir)
 
1144
        else:
 
1145
            from_dir_id = inv.root.file_id
 
1146
            from_dir_abspath = self.basedir
 
1147
        children = os.listdir(from_dir_abspath)
 
1148
        children.sort()
 
1149
        # jam 20060527 The kernel sized tree seems equivalent whether we
 
1150
        # use a deque and popleft to keep them sorted, or if we use a plain
 
1151
        # list and just reverse() them.
 
1152
        children = collections.deque(children)
 
1153
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
 
1154
        while stack:
 
1155
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
 
1156
 
 
1157
            while children:
 
1158
                f = children.popleft()
 
1159
                ## TODO: If we find a subdirectory with its own .bzr
 
1160
                ## directory, then that is a separate tree and we
 
1161
                ## should exclude it.
 
1162
 
 
1163
                # the bzrdir for this tree
 
1164
                if transport_base_dir == f:
 
1165
                    continue
 
1166
 
 
1167
                # we know that from_dir_relpath and from_dir_abspath never end in a slash
 
1168
                # and 'f' doesn't begin with one, we can do a string op, rather
 
1169
                # than the checks of pathjoin(), all relative paths will have an extra slash
 
1170
                # at the beginning
 
1171
                fp = from_dir_relpath + '/' + f
 
1172
 
 
1173
                # absolute path
 
1174
                fap = from_dir_abspath + '/' + f
 
1175
 
 
1176
                f_ie = inv.get_child(from_dir_id, f)
 
1177
                if f_ie:
 
1178
                    c = 'V'
 
1179
                elif self.is_ignored(fp[1:]):
 
1180
                    c = 'I'
 
1181
                else:
 
1182
                    # we may not have found this file, because of a unicode issue
 
1183
                    f_norm, can_access = osutils.normalized_filename(f)
 
1184
                    if f == f_norm or not can_access:
 
1185
                        # No change, so treat this file normally
 
1186
                        c = '?'
 
1187
                    else:
 
1188
                        # this file can be accessed by a normalized path
 
1189
                        # check again if it is versioned
 
1190
                        # these lines are repeated here for performance
 
1191
                        f = f_norm
 
1192
                        fp = from_dir_relpath + '/' + f
 
1193
                        fap = from_dir_abspath + '/' + f
 
1194
                        f_ie = inv.get_child(from_dir_id, f)
 
1195
                        if f_ie:
 
1196
                            c = 'V'
 
1197
                        elif self.is_ignored(fp[1:]):
 
1198
                            c = 'I'
 
1199
                        else:
 
1200
                            c = '?'
 
1201
 
 
1202
                fk = file_kind(fap)
 
1203
 
 
1204
                # make a last minute entry
 
1205
                if f_ie:
 
1206
                    yield fp[1:], c, fk, f_ie.file_id, f_ie
 
1207
                else:
 
1208
                    try:
 
1209
                        yield fp[1:], c, fk, None, fk_entries[fk]()
 
1210
                    except KeyError:
 
1211
                        yield fp[1:], c, fk, None, TreeEntry()
 
1212
                    continue
 
1213
 
 
1214
                if fk != 'directory':
 
1215
                    continue
 
1216
 
 
1217
                # But do this child first if recursing down
 
1218
                if recursive:
 
1219
                    new_children = os.listdir(fap)
 
1220
                    new_children.sort()
 
1221
                    new_children = collections.deque(new_children)
 
1222
                    stack.append((f_ie.file_id, fp, fap, new_children))
 
1223
                    # Break out of inner loop,
 
1224
                    # so that we start outer loop with child
 
1225
                    break
 
1226
            else:
 
1227
                # if we finished all children, pop it off the stack
 
1228
                stack.pop()
 
1229
 
 
1230
    @needs_tree_write_lock
 
1231
    def move(self, from_paths, to_dir=None, after=False, **kwargs):
920
1232
        """Rename files.
921
1233
 
922
 
        to_dir must be known to the working tree.
 
1234
        to_dir must exist in the inventory.
923
1235
 
924
1236
        If to_dir exists and is a directory, the files are moved into
925
1237
        it, keeping their old names.
931
1243
        independently.
932
1244
 
933
1245
        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.
 
1246
        inventory. The second mode only updates the inventory without
 
1247
        touching the file on the filesystem. This is the new mode introduced
 
1248
        in version 0.15.
936
1249
 
937
1250
        move uses the second mode if 'after == True' and the target is not
938
1251
        versioned but present in the working tree.
950
1263
        This returns a list of (from_path, to_path) pairs for each
951
1264
        entry that is moved.
952
1265
        """
953
 
        raise NotImplementedError(self.move)
 
1266
        rename_entries = []
 
1267
        rename_tuples = []
 
1268
 
 
1269
        # check for deprecated use of signature
 
1270
        if to_dir is None:
 
1271
            to_dir = kwargs.get('to_name', None)
 
1272
            if to_dir is None:
 
1273
                raise TypeError('You must supply a target directory')
 
1274
            else:
 
1275
                symbol_versioning.warn('The parameter to_name was deprecated'
 
1276
                                       ' in version 0.13. Use to_dir instead',
 
1277
                                       DeprecationWarning)
 
1278
 
 
1279
        # check destination directory
 
1280
        if isinstance(from_paths, basestring):
 
1281
            raise ValueError()
 
1282
        inv = self.inventory
 
1283
        to_abs = self.abspath(to_dir)
 
1284
        if not isdir(to_abs):
 
1285
            raise errors.BzrMoveFailedError('',to_dir,
 
1286
                errors.NotADirectory(to_abs))
 
1287
        if not self.has_filename(to_dir):
 
1288
            raise errors.BzrMoveFailedError('',to_dir,
 
1289
                errors.NotInWorkingDirectory(to_dir))
 
1290
        to_dir_id = inv.path2id(to_dir)
 
1291
        if to_dir_id is None:
 
1292
            raise errors.BzrMoveFailedError('',to_dir,
 
1293
                errors.NotVersionedError(path=str(to_dir)))
 
1294
 
 
1295
        to_dir_ie = inv[to_dir_id]
 
1296
        if to_dir_ie.kind != 'directory':
 
1297
            raise errors.BzrMoveFailedError('',to_dir,
 
1298
                errors.NotADirectory(to_abs))
 
1299
 
 
1300
        # create rename entries and tuples
 
1301
        for from_rel in from_paths:
 
1302
            from_tail = splitpath(from_rel)[-1]
 
1303
            from_id = inv.path2id(from_rel)
 
1304
            if from_id is None:
 
1305
                raise errors.BzrMoveFailedError(from_rel,to_dir,
 
1306
                    errors.NotVersionedError(path=str(from_rel)))
 
1307
 
 
1308
            from_entry = inv[from_id]
 
1309
            from_parent_id = from_entry.parent_id
 
1310
            to_rel = pathjoin(to_dir, from_tail)
 
1311
            rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
 
1312
                                         from_id=from_id,
 
1313
                                         from_tail=from_tail,
 
1314
                                         from_parent_id=from_parent_id,
 
1315
                                         to_rel=to_rel, to_tail=from_tail,
 
1316
                                         to_parent_id=to_dir_id)
 
1317
            rename_entries.append(rename_entry)
 
1318
            rename_tuples.append((from_rel, to_rel))
 
1319
 
 
1320
        # determine which move mode to use. checks also for movability
 
1321
        rename_entries = self._determine_mv_mode(rename_entries, after)
 
1322
 
 
1323
        original_modified = self._inventory_is_modified
 
1324
        try:
 
1325
            if len(from_paths):
 
1326
                self._inventory_is_modified = True
 
1327
            self._move(rename_entries)
 
1328
        except:
 
1329
            # restore the inventory on error
 
1330
            self._inventory_is_modified = original_modified
 
1331
            raise
 
1332
        self._write_inventory(inv)
 
1333
        return rename_tuples
 
1334
 
 
1335
    def _determine_mv_mode(self, rename_entries, after=False):
 
1336
        """Determines for each from-to pair if both inventory and working tree
 
1337
        or only the inventory has to be changed.
 
1338
 
 
1339
        Also does basic plausability tests.
 
1340
        """
 
1341
        inv = self.inventory
 
1342
 
 
1343
        for rename_entry in rename_entries:
 
1344
            # store to local variables for easier reference
 
1345
            from_rel = rename_entry.from_rel
 
1346
            from_id = rename_entry.from_id
 
1347
            to_rel = rename_entry.to_rel
 
1348
            to_id = inv.path2id(to_rel)
 
1349
            only_change_inv = False
 
1350
 
 
1351
            # check the inventory for source and destination
 
1352
            if from_id is None:
 
1353
                raise errors.BzrMoveFailedError(from_rel,to_rel,
 
1354
                    errors.NotVersionedError(path=str(from_rel)))
 
1355
            if to_id is not None:
 
1356
                raise errors.BzrMoveFailedError(from_rel,to_rel,
 
1357
                    errors.AlreadyVersionedError(path=str(to_rel)))
 
1358
 
 
1359
            # try to determine the mode for rename (only change inv or change
 
1360
            # inv and file system)
 
1361
            if after:
 
1362
                if not self.has_filename(to_rel):
 
1363
                    raise errors.BzrMoveFailedError(from_id,to_rel,
 
1364
                        errors.NoSuchFile(path=str(to_rel),
 
1365
                        extra="New file has not been created yet"))
 
1366
                only_change_inv = True
 
1367
            elif not self.has_filename(from_rel) and self.has_filename(to_rel):
 
1368
                only_change_inv = True
 
1369
            elif self.has_filename(from_rel) and not self.has_filename(to_rel):
 
1370
                only_change_inv = False
 
1371
            elif (not self.case_sensitive
 
1372
                  and from_rel.lower() == to_rel.lower()
 
1373
                  and self.has_filename(from_rel)):
 
1374
                only_change_inv = False
 
1375
            else:
 
1376
                # something is wrong, so lets determine what exactly
 
1377
                if not self.has_filename(from_rel) and \
 
1378
                   not self.has_filename(to_rel):
 
1379
                    raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1380
                        errors.PathsDoNotExist(paths=(str(from_rel),
 
1381
                        str(to_rel))))
 
1382
                else:
 
1383
                    raise errors.RenameFailedFilesExist(from_rel, to_rel)
 
1384
            rename_entry.only_change_inv = only_change_inv
 
1385
        return rename_entries
 
1386
 
 
1387
    def _move(self, rename_entries):
 
1388
        """Moves a list of files.
 
1389
 
 
1390
        Depending on the value of the flag 'only_change_inv', the
 
1391
        file will be moved on the file system or not.
 
1392
        """
 
1393
        inv = self.inventory
 
1394
        moved = []
 
1395
 
 
1396
        for entry in rename_entries:
 
1397
            try:
 
1398
                self._move_entry(entry)
 
1399
            except:
 
1400
                self._rollback_move(moved)
 
1401
                raise
 
1402
            moved.append(entry)
 
1403
 
 
1404
    def _rollback_move(self, moved):
 
1405
        """Try to rollback a previous move in case of an filesystem error."""
 
1406
        inv = self.inventory
 
1407
        for entry in moved:
 
1408
            try:
 
1409
                self._move_entry(WorkingTree._RenameEntry(
 
1410
                    entry.to_rel, entry.from_id,
 
1411
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
 
1412
                    entry.from_tail, entry.from_parent_id,
 
1413
                    entry.only_change_inv))
 
1414
            except errors.BzrMoveFailedError, e:
 
1415
                raise errors.BzrMoveFailedError( '', '', "Rollback failed."
 
1416
                        " The working tree is in an inconsistent state."
 
1417
                        " Please consider doing a 'bzr revert'."
 
1418
                        " Error message is: %s" % e)
 
1419
 
 
1420
    def _move_entry(self, entry):
 
1421
        inv = self.inventory
 
1422
        from_rel_abs = self.abspath(entry.from_rel)
 
1423
        to_rel_abs = self.abspath(entry.to_rel)
 
1424
        if from_rel_abs == to_rel_abs:
 
1425
            raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
 
1426
                "Source and target are identical.")
 
1427
 
 
1428
        if not entry.only_change_inv:
 
1429
            try:
 
1430
                osutils.rename(from_rel_abs, to_rel_abs)
 
1431
            except OSError, e:
 
1432
                raise errors.BzrMoveFailedError(entry.from_rel,
 
1433
                    entry.to_rel, e[1])
 
1434
        inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
954
1435
 
955
1436
    @needs_tree_write_lock
956
1437
    def rename_one(self, from_rel, to_rel, after=False):
960
1441
 
961
1442
        rename_one has several 'modes' to work. First, it can rename a physical
962
1443
        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.
 
1444
        only change the file_id without touching any physical file. This is
 
1445
        the new mode introduced in version 0.15.
964
1446
 
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.
 
1447
        rename_one uses the second mode if 'after == True' and 'to_rel' is not
 
1448
        versioned but present in the working tree.
967
1449
 
968
1450
        rename_one uses the second mode if 'after == False' and 'from_rel' is
969
1451
        versioned but no longer in the working tree, and 'to_rel' is not
975
1457
 
976
1458
        Everything else results in an error.
977
1459
        """
978
 
        raise NotImplementedError(self.rename_one)
 
1460
        inv = self.inventory
 
1461
        rename_entries = []
 
1462
 
 
1463
        # create rename entries and tuples
 
1464
        from_tail = splitpath(from_rel)[-1]
 
1465
        from_id = inv.path2id(from_rel)
 
1466
        if from_id is None:
 
1467
            raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1468
                errors.NotVersionedError(path=str(from_rel)))
 
1469
        from_entry = inv[from_id]
 
1470
        from_parent_id = from_entry.parent_id
 
1471
        to_dir, to_tail = os.path.split(to_rel)
 
1472
        to_dir_id = inv.path2id(to_dir)
 
1473
        rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
 
1474
                                     from_id=from_id,
 
1475
                                     from_tail=from_tail,
 
1476
                                     from_parent_id=from_parent_id,
 
1477
                                     to_rel=to_rel, to_tail=to_tail,
 
1478
                                     to_parent_id=to_dir_id)
 
1479
        rename_entries.append(rename_entry)
 
1480
 
 
1481
        # determine which move mode to use. checks also for movability
 
1482
        rename_entries = self._determine_mv_mode(rename_entries, after)
 
1483
 
 
1484
        # check if the target changed directory and if the target directory is
 
1485
        # versioned
 
1486
        if to_dir_id is None:
 
1487
            raise errors.BzrMoveFailedError(from_rel,to_rel,
 
1488
                errors.NotVersionedError(path=str(to_dir)))
 
1489
 
 
1490
        # all checks done. now we can continue with our actual work
 
1491
        mutter('rename_one:\n'
 
1492
               '  from_id   {%s}\n'
 
1493
               '  from_rel: %r\n'
 
1494
               '  to_rel:   %r\n'
 
1495
               '  to_dir    %r\n'
 
1496
               '  to_dir_id {%s}\n',
 
1497
               from_id, from_rel, to_rel, to_dir, to_dir_id)
 
1498
 
 
1499
        self._move(rename_entries)
 
1500
        self._write_inventory(inv)
 
1501
 
 
1502
    class _RenameEntry(object):
 
1503
        def __init__(self, from_rel, from_id, from_tail, from_parent_id,
 
1504
                     to_rel, to_tail, to_parent_id, only_change_inv=False):
 
1505
            self.from_rel = from_rel
 
1506
            self.from_id = from_id
 
1507
            self.from_tail = from_tail
 
1508
            self.from_parent_id = from_parent_id
 
1509
            self.to_rel = to_rel
 
1510
            self.to_tail = to_tail
 
1511
            self.to_parent_id = to_parent_id
 
1512
            self.only_change_inv = only_change_inv
979
1513
 
980
1514
    @needs_read_lock
981
1515
    def unknowns(self):
989
1523
        return iter(
990
1524
            [subp for subp in self.extras() if not self.is_ignored(subp)])
991
1525
 
 
1526
    @needs_tree_write_lock
992
1527
    def unversion(self, file_ids):
993
1528
        """Remove the file ids in file_ids from the current versioned set.
994
1529
 
998
1533
        :param file_ids: The file ids to stop versioning.
999
1534
        :raises: NoSuchId if any fileid is not currently versioned.
1000
1535
        """
1001
 
        raise NotImplementedError(self.unversion)
 
1536
        for file_id in file_ids:
 
1537
            if file_id not in self._inventory:
 
1538
                raise errors.NoSuchId(self, file_id)
 
1539
        for file_id in file_ids:
 
1540
            if self._inventory.has_id(file_id):
 
1541
                self._inventory.remove_recursive_id(file_id)
 
1542
        if len(file_ids):
 
1543
            # in the future this should just set a dirty bit to wait for the
 
1544
            # final unlock. However, until all methods of workingtree start
 
1545
            # with the current in -memory inventory rather than triggering
 
1546
            # a read, it is more complex - we need to teach read_inventory
 
1547
            # to know when to read, and when to not read first... and possibly
 
1548
            # to save first when the in memory one may be corrupted.
 
1549
            # so for now, we just only write it if it is indeed dirty.
 
1550
            # - RBC 20060907
 
1551
            self._write_inventory(self._inventory)
 
1552
 
 
1553
    def _iter_conflicts(self):
 
1554
        conflicted = set()
 
1555
        for info in self.list_files():
 
1556
            path = info[0]
 
1557
            stem = get_conflicted_stem(path)
 
1558
            if stem is None:
 
1559
                continue
 
1560
            if stem not in conflicted:
 
1561
                conflicted.add(stem)
 
1562
                yield stem
1002
1563
 
1003
1564
    @needs_write_lock
1004
1565
    def pull(self, source, overwrite=False, stop_revision=None,
1005
 
             change_reporter=None, possible_transports=None, local=False,
1006
 
             show_base=False):
 
1566
             change_reporter=None, possible_transports=None, local=False):
 
1567
        top_pb = ui.ui_factory.nested_progress_bar()
1007
1568
        source.lock_read()
1008
1569
        try:
 
1570
            pp = ProgressPhase("Pull phase", 2, top_pb)
 
1571
            pp.next_phase()
1009
1572
            old_revision_info = self.branch.last_revision_info()
1010
1573
            basis_tree = self.basis_tree()
1011
1574
            count = self.branch.pull(source, overwrite, stop_revision,
1013
1576
                                     local=local)
1014
1577
            new_revision_info = self.branch.last_revision_info()
1015
1578
            if new_revision_info != old_revision_info:
 
1579
                pp.next_phase()
1016
1580
                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)
 
1581
                pb = ui.ui_factory.nested_progress_bar()
1022
1582
                basis_tree.lock_read()
1023
1583
                try:
1024
1584
                    new_basis_tree = self.branch.basis_tree()
1027
1587
                                new_basis_tree,
1028
1588
                                basis_tree,
1029
1589
                                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)
 
1590
                                pb=pb,
 
1591
                                change_reporter=change_reporter)
 
1592
                    if (basis_tree.inventory.root is None and
 
1593
                        new_basis_tree.inventory.root is not None):
 
1594
                        self.set_root_id(new_basis_tree.get_root_id())
1037
1595
                finally:
 
1596
                    pb.finished()
1038
1597
                    basis_tree.unlock()
1039
1598
                # TODO - dedup parents list with things merged by pull ?
1040
1599
                # reuse the revisiontree we merged against to set the new
1053
1612
            return count
1054
1613
        finally:
1055
1614
            source.unlock()
 
1615
            top_pb.finished()
1056
1616
 
1057
1617
    @needs_write_lock
1058
1618
    def put_file_bytes_non_atomic(self, file_id, bytes):
1074
1634
        Currently returned depth-first, sorted by name within directories.
1075
1635
        This is the same order used by 'osutils.walkdirs'.
1076
1636
        """
1077
 
        raise NotImplementedError(self.extras)
 
1637
        ## TODO: Work from given directory downwards
 
1638
        for path, dir_entry in self.inventory.directories():
 
1639
            # mutter("search for unknowns in %r", path)
 
1640
            dirabs = self.abspath(path)
 
1641
            if not isdir(dirabs):
 
1642
                # e.g. directory deleted
 
1643
                continue
 
1644
 
 
1645
            fl = []
 
1646
            for subf in os.listdir(dirabs):
 
1647
                if self.bzrdir.is_control_filename(subf):
 
1648
                    continue
 
1649
                if subf not in dir_entry.children:
 
1650
                    try:
 
1651
                        (subf_norm,
 
1652
                         can_access) = osutils.normalized_filename(subf)
 
1653
                    except UnicodeDecodeError:
 
1654
                        path_os_enc = path.encode(osutils._fs_enc)
 
1655
                        relpath = path_os_enc + '/' + subf
 
1656
                        raise errors.BadFilenameEncoding(relpath,
 
1657
                                                         osutils._fs_enc)
 
1658
                    if subf_norm != subf and can_access:
 
1659
                        if subf_norm not in dir_entry.children:
 
1660
                            fl.append(subf_norm)
 
1661
                    else:
 
1662
                        fl.append(subf)
 
1663
 
 
1664
            fl.sort()
 
1665
            for subf in fl:
 
1666
                subp = pathjoin(path, subf)
 
1667
                yield subp
1078
1668
 
1079
1669
    def ignored_files(self):
1080
1670
        """Yield list of PATH, IGNORE_PATTERN"""
1113
1703
        r"""Check whether the filename matches an ignore pattern.
1114
1704
 
1115
1705
        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.
 
1706
        others match against only the last component.
1119
1707
 
1120
1708
        If the file is ignored, returns the pattern which caused it to
1121
1709
        be ignored, otherwise None.  So this can simply be used as a
1122
1710
        boolean if desired."""
1123
1711
        if getattr(self, '_ignoreglobster', None) is None:
1124
 
            self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
 
1712
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1125
1713
        return self._ignoreglobster.match(filename)
1126
1714
 
1127
1715
    def kind(self, file_id):
1129
1717
 
1130
1718
    def stored_kind(self, file_id):
1131
1719
        """See Tree.stored_kind"""
1132
 
        raise NotImplementedError(self.stored_kind)
 
1720
        return self.inventory[file_id].kind
1133
1721
 
1134
1722
    def _comparison_data(self, entry, path):
1135
1723
        abspath = self.abspath(path)
1177
1765
            raise errors.ObjectNotLocked(self)
1178
1766
 
1179
1767
    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
 
        """
 
1768
        """See Branch.lock_read, and WorkingTree.unlock."""
1186
1769
        if not self.is_locked():
1187
1770
            self._reset_data()
1188
1771
        self.branch.lock_read()
1189
1772
        try:
1190
 
            self._control_files.lock_read()
1191
 
            return LogicalLockResult(self.unlock)
 
1773
            return self._control_files.lock_read()
1192
1774
        except:
1193
1775
            self.branch.unlock()
1194
1776
            raise
1195
1777
 
1196
1778
    def lock_tree_write(self):
1197
 
        """See MutableTree.lock_tree_write, and WorkingTree.unlock.
1198
 
 
1199
 
        :return: A bzrlib.lock.LogicalLockResult.
1200
 
        """
 
1779
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1201
1780
        if not self.is_locked():
1202
1781
            self._reset_data()
1203
1782
        self.branch.lock_read()
1204
1783
        try:
1205
 
            self._control_files.lock_write()
1206
 
            return LogicalLockResult(self.unlock)
 
1784
            return self._control_files.lock_write()
1207
1785
        except:
1208
1786
            self.branch.unlock()
1209
1787
            raise
1210
1788
 
1211
1789
    def lock_write(self):
1212
 
        """See MutableTree.lock_write, and WorkingTree.unlock.
1213
 
 
1214
 
        :return: A bzrlib.lock.LogicalLockResult.
1215
 
        """
 
1790
        """See MutableTree.lock_write, and WorkingTree.unlock."""
1216
1791
        if not self.is_locked():
1217
1792
            self._reset_data()
1218
1793
        self.branch.lock_write()
1219
1794
        try:
1220
 
            self._control_files.lock_write()
1221
 
            return LogicalLockResult(self.unlock)
 
1795
            return self._control_files.lock_write()
1222
1796
        except:
1223
1797
            self.branch.unlock()
1224
1798
            raise
1226
1800
    def get_physical_lock_status(self):
1227
1801
        return self._control_files.get_physical_lock_status()
1228
1802
 
 
1803
    def _basis_inventory_name(self):
 
1804
        return 'basis-inventory-cache'
 
1805
 
1229
1806
    def _reset_data(self):
1230
1807
        """Reset transient data that cannot be revalidated."""
1231
 
        raise NotImplementedError(self._reset_data)
 
1808
        self._inventory_is_modified = False
 
1809
        result = self._deserialize(self._transport.get('inventory'))
 
1810
        self._set_inventory(result, dirty=False)
1232
1811
 
 
1812
    @needs_tree_write_lock
1233
1813
    def set_last_revision(self, new_revision):
1234
1814
        """Change the last revision in the working tree."""
1235
 
        raise NotImplementedError(self.set_last_revision)
 
1815
        if self._change_last_revision(new_revision):
 
1816
            self._cache_basis_inventory(new_revision)
1236
1817
 
1237
1818
    def _change_last_revision(self, new_revision):
1238
1819
        """Template method part of set_last_revision to perform the change.
1241
1822
        when their last revision is set.
1242
1823
        """
1243
1824
        if _mod_revision.is_null(new_revision):
1244
 
            self.branch.set_last_revision_info(0, new_revision)
 
1825
            self.branch.set_revision_history([])
1245
1826
            return False
1246
 
        _mod_revision.check_not_reserved_id(new_revision)
1247
1827
        try:
1248
1828
            self.branch.generate_revision_history(new_revision)
1249
1829
        except errors.NoSuchRevision:
1250
1830
            # not present in the repo - dont try to set it deeper than the tip
1251
 
            self.branch._set_revision_history([new_revision])
 
1831
            self.branch.set_revision_history([new_revision])
1252
1832
        return True
1253
1833
 
 
1834
    def _write_basis_inventory(self, xml):
 
1835
        """Write the basis inventory XML to the basis-inventory file"""
 
1836
        path = self._basis_inventory_name()
 
1837
        sio = StringIO(xml)
 
1838
        self._transport.put_file(path, sio,
 
1839
            mode=self.bzrdir._get_file_mode())
 
1840
 
 
1841
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
 
1842
        """Create the text that will be saved in basis-inventory"""
 
1843
        inventory.revision_id = revision_id
 
1844
        return xml7.serializer_v7.write_inventory_to_string(inventory)
 
1845
 
 
1846
    def _cache_basis_inventory(self, new_revision):
 
1847
        """Cache new_revision as the basis inventory."""
 
1848
        # TODO: this should allow the ready-to-use inventory to be passed in,
 
1849
        # as commit already has that ready-to-use [while the format is the
 
1850
        # same, that is].
 
1851
        try:
 
1852
            # this double handles the inventory - unpack and repack -
 
1853
            # but is easier to understand. We can/should put a conditional
 
1854
            # in here based on whether the inventory is in the latest format
 
1855
            # - perhaps we should repack all inventories on a repository
 
1856
            # upgrade ?
 
1857
            # the fast path is to copy the raw xml from the repository. If the
 
1858
            # xml contains 'revision_id="', then we assume the right
 
1859
            # revision_id is set. We must check for this full string, because a
 
1860
            # root node id can legitimately look like 'revision_id' but cannot
 
1861
            # contain a '"'.
 
1862
            xml = self.branch.repository.get_inventory_xml(new_revision)
 
1863
            firstline = xml.split('\n', 1)[0]
 
1864
            if (not 'revision_id="' in firstline or
 
1865
                'format="7"' not in firstline):
 
1866
                inv = self.branch.repository.deserialise_inventory(
 
1867
                    new_revision, xml)
 
1868
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
 
1869
            self._write_basis_inventory(xml)
 
1870
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
 
1871
            pass
 
1872
 
 
1873
    def read_basis_inventory(self):
 
1874
        """Read the cached basis inventory."""
 
1875
        path = self._basis_inventory_name()
 
1876
        return self._transport.get_bytes(path)
 
1877
 
 
1878
    @needs_read_lock
 
1879
    def read_working_inventory(self):
 
1880
        """Read the working inventory.
 
1881
 
 
1882
        :raises errors.InventoryModified: read_working_inventory will fail
 
1883
            when the current in memory inventory has been modified.
 
1884
        """
 
1885
        # conceptually this should be an implementation detail of the tree.
 
1886
        # XXX: Deprecate this.
 
1887
        # ElementTree does its own conversion from UTF-8, so open in
 
1888
        # binary.
 
1889
        if self._inventory_is_modified:
 
1890
            raise errors.InventoryModified(self)
 
1891
        result = self._deserialize(self._transport.get('inventory'))
 
1892
        self._set_inventory(result, dirty=False)
 
1893
        return result
 
1894
 
1254
1895
    @needs_tree_write_lock
1255
1896
    def remove(self, files, verbose=False, to_file=None, keep_files=True,
1256
1897
        force=False):
1257
 
        """Remove nominated files from the working tree metadata.
 
1898
        """Remove nominated files from the working inventory.
1258
1899
 
1259
1900
        :files: File paths relative to the basedir.
1260
1901
        :keep_files: If true, the files will also be kept.
1266
1907
 
1267
1908
        inv_delta = []
1268
1909
 
1269
 
        all_files = set() # specified and nested files 
 
1910
        new_files=set()
1270
1911
        unknown_nested_files=set()
1271
 
        if to_file is None:
1272
 
            to_file = sys.stdout
1273
 
 
1274
 
        files_to_backup = []
1275
1912
 
1276
1913
        def recurse_directory_to_add_files(directory):
1277
1914
            # Recurse directory and add all files
1278
1915
            # so we can check if they have changed.
1279
 
            for parent_info, file_infos in self.walkdirs(directory):
 
1916
            for parent_info, file_infos in\
 
1917
                self.walkdirs(directory):
1280
1918
                for relpath, basename, kind, lstat, fileid, kind in file_infos:
1281
1919
                    # Is it versioned or ignored?
1282
 
                    if self.path2id(relpath):
 
1920
                    if self.path2id(relpath) or self.is_ignored(relpath):
1283
1921
                        # Add nested content for deletion.
1284
 
                        all_files.add(relpath)
 
1922
                        new_files.add(relpath)
1285
1923
                    else:
1286
 
                        # Files which are not versioned
 
1924
                        # Files which are not versioned and not ignored
1287
1925
                        # should be treated as unknown.
1288
 
                        files_to_backup.append(relpath)
 
1926
                        unknown_nested_files.add((relpath, None, kind))
1289
1927
 
1290
1928
        for filename in files:
1291
1929
            # Get file name into canonical form.
1292
1930
            abspath = self.abspath(filename)
1293
1931
            filename = self.relpath(abspath)
1294
1932
            if len(filename) > 0:
1295
 
                all_files.add(filename)
 
1933
                new_files.add(filename)
1296
1934
                recurse_directory_to_add_files(filename)
1297
1935
 
1298
 
        files = list(all_files)
 
1936
        files = list(new_files)
1299
1937
 
1300
1938
        if len(files) == 0:
1301
1939
            return # nothing to do
1305
1943
 
1306
1944
        # Bail out if we are going to delete files we shouldn't
1307
1945
        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])
 
1946
            has_changed_files = len(unknown_nested_files) > 0
 
1947
            if not has_changed_files:
 
1948
                for (file_id, path, content_change, versioned, parent_id, name,
 
1949
                     kind, executable) in self.iter_changes(self.basis_tree(),
 
1950
                         include_unchanged=True, require_versioned=False,
 
1951
                         want_unversioned=True, specific_files=files):
 
1952
                    if versioned == (False, False):
 
1953
                        # The record is unknown ...
 
1954
                        if not self.is_ignored(path[1]):
 
1955
                            # ... but not ignored
 
1956
                            has_changed_files = True
 
1957
                            break
 
1958
                    elif content_change and (kind[1] is not None):
 
1959
                        # Versioned and changed, but not deleted
 
1960
                        has_changed_files = True
 
1961
                        break
1320
1962
 
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)
 
1963
            if has_changed_files:
 
1964
                # Make delta show ALL applicable changes in error message.
 
1965
                tree_delta = self.changes_from(self.basis_tree(),
 
1966
                    require_versioned=False, want_unversioned=True,
 
1967
                    specific_files=files)
 
1968
                for unknown_file in unknown_nested_files:
 
1969
                    if unknown_file not in tree_delta.unversioned:
 
1970
                        tree_delta.unversioned.extend((unknown_file,))
 
1971
                raise errors.BzrRemoveChangedFilesError(tree_delta)
1326
1972
 
1327
1973
        # Build inv_delta and delete files where applicable,
1328
 
        # do this before any modifications to meta data.
 
1974
        # do this before any modifications to inventory.
1329
1975
        for f in files:
1330
1976
            fid = self.path2id(f)
1331
1977
            message = None
1338
1984
                        new_status = 'I'
1339
1985
                    else:
1340
1986
                        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')
 
1987
                    textui.show_status(new_status, self.kind(fid), f,
 
1988
                                       to_file=to_file)
1344
1989
                # Unversion file
1345
1990
                inv_delta.append((f, None, fid, None))
1346
1991
                message = "removed %s" % (f,)
1352
1997
                        len(os.listdir(abs_path)) > 0):
1353
1998
                        if force:
1354
1999
                            osutils.rmtree(abs_path)
1355
 
                            message = "deleted %s" % (f,)
1356
2000
                        else:
1357
 
                            message = backup(f)
 
2001
                            message = "%s is not an empty directory "\
 
2002
                                "and won't be deleted." % (f,)
1358
2003
                    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,)
 
2004
                        osutils.delete_any(abs_path)
 
2005
                        message = "deleted %s" % (f,)
1364
2006
                elif message is not None:
1365
2007
                    # Only care if we haven't done anything yet.
1366
2008
                    message = "%s does not exist." % (f,)
1372
2014
 
1373
2015
    @needs_tree_write_lock
1374
2016
    def revert(self, filenames=None, old_tree=None, backups=True,
1375
 
               pb=None, report_changes=False):
 
2017
               pb=DummyProgress(), report_changes=False):
1376
2018
        from bzrlib.conflicts import resolve
 
2019
        if filenames == []:
 
2020
            filenames = None
 
2021
            symbol_versioning.warn('Using [] to revert all files is deprecated'
 
2022
                ' as of bzr 0.91.  Please use None (the default) instead.',
 
2023
                DeprecationWarning, stacklevel=2)
1377
2024
        if old_tree is None:
1378
2025
            basis_tree = self.basis_tree()
1379
2026
            basis_tree.lock_read()
1406
2053
        WorkingTree can supply revision_trees for the basis revision only
1407
2054
        because there is only one cached inventory in the bzr directory.
1408
2055
        """
1409
 
        raise NotImplementedError(self.revision_tree)
 
2056
        if revision_id == self.last_revision():
 
2057
            try:
 
2058
                xml = self.read_basis_inventory()
 
2059
            except errors.NoSuchFile:
 
2060
                pass
 
2061
            else:
 
2062
                try:
 
2063
                    inv = xml7.serializer_v7.read_inventory_from_string(xml)
 
2064
                    # dont use the repository revision_tree api because we want
 
2065
                    # to supply the inventory.
 
2066
                    if inv.revision_id == revision_id:
 
2067
                        return revisiontree.RevisionTree(self.branch.repository,
 
2068
                            inv, revision_id)
 
2069
                except errors.BadInventoryFormat:
 
2070
                    pass
 
2071
        # raise if there was no inventory, or if we read the wrong inventory.
 
2072
        raise errors.NoSuchRevisionInTree(self, revision_id)
 
2073
 
 
2074
    # XXX: This method should be deprecated in favour of taking in a proper
 
2075
    # new Inventory object.
 
2076
    @needs_tree_write_lock
 
2077
    def set_inventory(self, new_inventory_list):
 
2078
        from bzrlib.inventory import (Inventory,
 
2079
                                      InventoryDirectory,
 
2080
                                      InventoryFile,
 
2081
                                      InventoryLink)
 
2082
        inv = Inventory(self.get_root_id())
 
2083
        for path, file_id, parent, kind in new_inventory_list:
 
2084
            name = os.path.basename(path)
 
2085
            if name == "":
 
2086
                continue
 
2087
            # fixme, there should be a factory function inv,add_??
 
2088
            if kind == 'directory':
 
2089
                inv.add(InventoryDirectory(file_id, name, parent))
 
2090
            elif kind == 'file':
 
2091
                inv.add(InventoryFile(file_id, name, parent))
 
2092
            elif kind == 'symlink':
 
2093
                inv.add(InventoryLink(file_id, name, parent))
 
2094
            else:
 
2095
                raise errors.BzrError("unknown kind %r" % kind)
 
2096
        self._write_inventory(inv)
1410
2097
 
1411
2098
    @needs_tree_write_lock
1412
2099
    def set_root_id(self, file_id):
1425
2112
            present in the current inventory or an error will occur. It must
1426
2113
            not be None, but rather a valid file id.
1427
2114
        """
1428
 
        raise NotImplementedError(self._set_root_id)
 
2115
        inv = self._inventory
 
2116
        orig_root_id = inv.root.file_id
 
2117
        # TODO: it might be nice to exit early if there was nothing
 
2118
        # to do, saving us from trigger a sync on unlock.
 
2119
        self._inventory_is_modified = True
 
2120
        # we preserve the root inventory entry object, but
 
2121
        # unlinkit from the byid index
 
2122
        del inv._byid[inv.root.file_id]
 
2123
        inv.root.file_id = file_id
 
2124
        # and link it into the index with the new changed id.
 
2125
        inv._byid[inv.root.file_id] = inv.root
 
2126
        # and finally update all children to reference the new id.
 
2127
        # XXX: this should be safe to just look at the root.children
 
2128
        # list, not the WHOLE INVENTORY.
 
2129
        for fid in inv:
 
2130
            entry = inv[fid]
 
2131
            if entry.parent_id == orig_root_id:
 
2132
                entry.parent_id = inv.root.file_id
1429
2133
 
1430
2134
    def unlock(self):
1431
2135
        """See Branch.unlock.
1438
2142
        """
1439
2143
        raise NotImplementedError(self.unlock)
1440
2144
 
1441
 
    _marker = object()
1442
 
 
1443
 
    def update(self, change_reporter=None, possible_transports=None,
1444
 
               revision=None, old_tip=_marker, show_base=False):
 
2145
    def update(self, change_reporter=None, possible_transports=None):
1445
2146
        """Update a working tree along its branch.
1446
2147
 
1447
2148
        This will update the branch if its bound too, which means we have
1462
2163
        - Restore the wt.basis->wt.state changes.
1463
2164
 
1464
2165
        There isn't a single operation at the moment to do that, so we:
1465
 
 
1466
2166
        - Merge current state -> basis tree of the master w.r.t. the old tree
1467
2167
          basis.
1468
2168
        - 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
2169
        """
1476
2170
        if self.branch.get_bound_location() is not None:
1477
2171
            self.lock_write()
1478
 
            update_branch = (old_tip is self._marker)
 
2172
            update_branch = True
1479
2173
        else:
1480
2174
            self.lock_tree_write()
1481
2175
            update_branch = False
1483
2177
            if update_branch:
1484
2178
                old_tip = self.branch.update(possible_transports)
1485
2179
            else:
1486
 
                if old_tip is self._marker:
1487
 
                    old_tip = None
1488
 
            return self._update_tree(old_tip, change_reporter, revision, show_base)
 
2180
                old_tip = None
 
2181
            return self._update_tree(old_tip, change_reporter)
1489
2182
        finally:
1490
2183
            self.unlock()
1491
2184
 
1492
2185
    @needs_tree_write_lock
1493
 
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None,
1494
 
                     show_base=False):
 
2186
    def _update_tree(self, old_tip=None, change_reporter=None):
1495
2187
        """Update a tree to the master branch.
1496
2188
 
1497
2189
        :param old_tip: if supplied, the previous tip revision the branch,
1507
2199
        # We MUST save it even if an error occurs, because otherwise the users
1508
2200
        # local work is unreferenced and will appear to have been lost.
1509
2201
        #
1510
 
        nb_conflicts = 0
 
2202
        result = 0
1511
2203
        try:
1512
2204
            last_rev = self.get_parent_ids()[0]
1513
2205
        except IndexError:
1514
2206
            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
 
 
 
2207
        if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
 
2208
            # merge tree state up to new branch tip.
1540
2209
            basis = self.basis_tree()
1541
2210
            basis.lock_read()
1542
2211
            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)
 
2212
                to_tree = self.branch.basis_tree()
 
2213
                if basis.inventory.root is None:
 
2214
                    self.set_root_id(to_tree.get_root_id())
1545
2215
                    self.flush()
 
2216
                result += merge.merge_inner(
 
2217
                                      self.branch,
 
2218
                                      to_tree,
 
2219
                                      basis,
 
2220
                                      this_tree=self,
 
2221
                                      change_reporter=change_reporter)
1546
2222
            finally:
1547
2223
                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
2224
            # TODO - dedup parents list with things merged by pull ?
1561
2225
            # reuse the tree we've updated to to set the basis:
1562
 
            parent_trees = [(revision, to_tree)]
 
2226
            parent_trees = [(self.branch.last_revision(), to_tree)]
1563
2227
            merges = self.get_parent_ids()[1:]
1564
2228
            # Ideally we ask the tree for the trees here, that way the working
1565
2229
            # tree can decide whether to give us the entire tree or give us a
1569
2233
            for parent in merges:
1570
2234
                parent_trees.append(
1571
2235
                    (parent, self.branch.repository.revision_tree(parent)))
1572
 
            if not _mod_revision.is_null(old_tip):
 
2236
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
1573
2237
                parent_trees.append(
1574
2238
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
1575
2239
            self.set_parent_trees(parent_trees)
1576
2240
            last_rev = parent_trees[0][0]
1577
 
        return nb_conflicts
 
2241
        else:
 
2242
            # the working tree had the same last-revision as the master
 
2243
            # branch did. We may still have pivot local work from the local
 
2244
            # branch into old_tip:
 
2245
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
 
2246
                self.add_parent_tree_id(old_tip)
 
2247
        if (old_tip is not None and not _mod_revision.is_null(old_tip)
 
2248
            and old_tip != last_rev):
 
2249
            # our last revision was not the prior branch last revision
 
2250
            # and we have converted that last revision to a pending merge.
 
2251
            # base is somewhere between the branch tip now
 
2252
            # and the now pending merge
 
2253
 
 
2254
            # Since we just modified the working tree and inventory, flush out
 
2255
            # the current state, before we modify it again.
 
2256
            # TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
 
2257
            #       requires it only because TreeTransform directly munges the
 
2258
            #       inventory and calls tree._write_inventory(). Ultimately we
 
2259
            #       should be able to remove this extra flush.
 
2260
            self.flush()
 
2261
            graph = self.branch.repository.get_graph()
 
2262
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
 
2263
                                                old_tip)
 
2264
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
2265
            other_tree = self.branch.repository.revision_tree(old_tip)
 
2266
            result += merge.merge_inner(
 
2267
                                  self.branch,
 
2268
                                  other_tree,
 
2269
                                  base_tree,
 
2270
                                  this_tree=self,
 
2271
                                  change_reporter=change_reporter)
 
2272
        return result
1578
2273
 
1579
2274
    def _write_hashcache_if_dirty(self):
1580
2275
        """Write out the hashcache if it is dirty."""
1588
2283
                #       warning might be sufficient to let the user know what
1589
2284
                #       is going on.
1590
2285
                mutter('Could not write hashcache for %s\nError: %s',
1591
 
                              self._hashcache.cache_file_name(), e)
 
2286
                       self._hashcache.cache_file_name(), e)
 
2287
 
 
2288
    @needs_tree_write_lock
 
2289
    def _write_inventory(self, inv):
 
2290
        """Write inventory as the current inventory."""
 
2291
        self._set_inventory(inv, dirty=True)
 
2292
        self.flush()
1592
2293
 
1593
2294
    def set_conflicts(self, arg):
1594
2295
        raise errors.UnsupportedOperation(self.set_conflicts, self)
1596
2297
    def add_conflicts(self, arg):
1597
2298
        raise errors.UnsupportedOperation(self.add_conflicts, self)
1598
2299
 
 
2300
    @needs_read_lock
1599
2301
    def conflicts(self):
1600
 
        raise NotImplementedError(self.conflicts)
 
2302
        conflicts = _mod_conflicts.ConflictList()
 
2303
        for conflicted in self._iter_conflicts():
 
2304
            text = True
 
2305
            try:
 
2306
                if file_kind(self.abspath(conflicted)) != "file":
 
2307
                    text = False
 
2308
            except errors.NoSuchFile:
 
2309
                text = False
 
2310
            if text is True:
 
2311
                for suffix in ('.THIS', '.OTHER'):
 
2312
                    try:
 
2313
                        kind = file_kind(self.abspath(conflicted+suffix))
 
2314
                        if kind != "file":
 
2315
                            text = False
 
2316
                    except errors.NoSuchFile:
 
2317
                        text = False
 
2318
                    if text == False:
 
2319
                        break
 
2320
            ctype = {True: 'text conflict', False: 'contents conflict'}[text]
 
2321
            conflicts.append(_mod_conflicts.Conflict.factory(ctype,
 
2322
                             path=conflicted,
 
2323
                             file_id=self.path2id(conflicted)))
 
2324
        return conflicts
1601
2325
 
1602
2326
    def walkdirs(self, prefix=""):
1603
2327
        """Walk the directories of this tree.
1723
2447
    def _walkdirs(self, prefix=""):
1724
2448
        """Walk the directories of this tree.
1725
2449
 
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), ... ])
 
2450
           :prefix: is used as the directrory to start with.
 
2451
           returns a generator which yields items in the form:
 
2452
                ((curren_directory_path, fileid),
 
2453
                 [(file1_path, file1_name, file1_kind, None, file1_id,
 
2454
                   file1_kind), ... ])
1732
2455
        """
1733
 
        raise NotImplementedError(self._walkdirs)
 
2456
        _directory = 'directory'
 
2457
        # get the root in the inventory
 
2458
        inv = self.inventory
 
2459
        top_id = inv.path2id(prefix)
 
2460
        if top_id is None:
 
2461
            pending = []
 
2462
        else:
 
2463
            pending = [(prefix, '', _directory, None, top_id, None)]
 
2464
        while pending:
 
2465
            dirblock = []
 
2466
            currentdir = pending.pop()
 
2467
            # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
 
2468
            top_id = currentdir[4]
 
2469
            if currentdir[0]:
 
2470
                relroot = currentdir[0] + '/'
 
2471
            else:
 
2472
                relroot = ""
 
2473
            # FIXME: stash the node in pending
 
2474
            entry = inv[top_id]
 
2475
            if entry.kind == 'directory':
 
2476
                for name, child in entry.sorted_children():
 
2477
                    dirblock.append((relroot + name, name, child.kind, None,
 
2478
                        child.file_id, child.kind
 
2479
                        ))
 
2480
            yield (currentdir[0], entry.file_id), dirblock
 
2481
            # push the user specified dirs from dirblock
 
2482
            for dir in reversed(dirblock):
 
2483
                if dir[2] == _directory:
 
2484
                    pending.append(dir)
1734
2485
 
1735
2486
    @needs_tree_write_lock
1736
2487
    def auto_resolve(self):
1740
2491
        are considered 'resolved', because bzr always puts conflict markers
1741
2492
        into files that have text conflicts.  The corresponding .THIS .BASE and
1742
2493
        .OTHER files are deleted, as per 'resolve'.
1743
 
 
1744
2494
        :return: a tuple of ConflictLists: (un_resolved, resolved).
1745
2495
        """
1746
2496
        un_resolved = _mod_conflicts.ConflictList()
1765
2515
        self.set_conflicts(un_resolved)
1766
2516
        return un_resolved, resolved
1767
2517
 
 
2518
    @needs_read_lock
 
2519
    def _check(self):
 
2520
        tree_basis = self.basis_tree()
 
2521
        tree_basis.lock_read()
 
2522
        try:
 
2523
            repo_basis = self.branch.repository.revision_tree(
 
2524
                self.last_revision())
 
2525
            if len(list(repo_basis.iter_changes(tree_basis))) > 0:
 
2526
                raise errors.BzrCheckError(
 
2527
                    "Mismatched basis inventory content.")
 
2528
            self._validate()
 
2529
        finally:
 
2530
            tree_basis.unlock()
 
2531
 
1768
2532
    def _validate(self):
1769
2533
        """Validate internal structures.
1770
2534
 
1776
2540
        """
1777
2541
        return
1778
2542
 
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
 
 
 
2543
    @needs_read_lock
1791
2544
    def _get_rules_searcher(self, default_searcher):
1792
2545
        """See Tree._get_rules_searcher."""
1793
2546
        if self._rules_searcher is None:
1801
2554
        return ShelfManager(self, self._transport)
1802
2555
 
1803
2556
 
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.
 
2557
class WorkingTree2(WorkingTree):
 
2558
    """This is the Format 2 working tree.
 
2559
 
 
2560
    This was the first weave based working tree.
 
2561
     - uses os locks for locking.
 
2562
     - uses the branch last-revision.
1813
2563
    """
1814
2564
 
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)
 
2565
    def __init__(self, *args, **kwargs):
 
2566
        super(WorkingTree2, self).__init__(*args, **kwargs)
 
2567
        # WorkingTree2 has more of a constraint that self._inventory must
 
2568
        # exist. Because this is an older format, we don't mind the overhead
 
2569
        # caused by the extra computation here.
 
2570
 
 
2571
        # Newer WorkingTree's should only have self._inventory set when they
 
2572
        # have a read lock.
 
2573
        if self._inventory is None:
 
2574
            self.read_working_inventory()
 
2575
 
 
2576
    def lock_tree_write(self):
 
2577
        """See WorkingTree.lock_tree_write().
 
2578
 
 
2579
        In Format2 WorkingTrees we have a single lock for the branch and tree
 
2580
        so lock_tree_write() degrades to lock_write().
 
2581
        """
 
2582
        self.branch.lock_write()
 
2583
        try:
 
2584
            return self._control_files.lock_write()
 
2585
        except:
 
2586
            self.branch.unlock()
 
2587
            raise
 
2588
 
 
2589
    def unlock(self):
 
2590
        # do non-implementation specific cleanup
 
2591
        self._cleanup()
 
2592
 
 
2593
        # we share control files:
 
2594
        if self._control_files._lock_count == 3:
 
2595
            # _inventory_is_modified is always False during a read lock.
 
2596
            if self._inventory_is_modified:
 
2597
                self.flush()
 
2598
            self._write_hashcache_if_dirty()
 
2599
 
 
2600
        # reverse order of locking.
 
2601
        try:
 
2602
            return self._control_files.unlock()
1904
2603
        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
 
2604
            self.branch.unlock()
 
2605
 
 
2606
 
 
2607
class WorkingTree3(WorkingTree):
 
2608
    """This is the Format 3 working tree.
 
2609
 
 
2610
    This differs from the base WorkingTree by:
 
2611
     - having its own file lock
 
2612
     - having its own last-revision property.
 
2613
 
 
2614
    This is new in bzr 0.8
 
2615
    """
 
2616
 
 
2617
    @needs_read_lock
 
2618
    def _last_revision(self):
 
2619
        """See Mutable.last_revision."""
 
2620
        try:
 
2621
            return self._transport.get_bytes('last-revision')
 
2622
        except errors.NoSuchFile:
 
2623
            return _mod_revision.NULL_REVISION
 
2624
 
 
2625
    def _change_last_revision(self, revision_id):
 
2626
        """See WorkingTree._change_last_revision."""
 
2627
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
 
2628
            try:
 
2629
                self._transport.delete('last-revision')
 
2630
            except errors.NoSuchFile:
 
2631
                pass
 
2632
            return False
1953
2633
        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)
 
2634
            self._transport.put_bytes('last-revision', revision_id,
 
2635
                mode=self.bzrdir._get_file_mode())
 
2636
            return True
2002
2637
 
2003
2638
    @needs_tree_write_lock
2004
2639
    def set_conflicts(self, conflicts):
2024
2659
                    raise errors.ConflictFormatError()
2025
2660
            except StopIteration:
2026
2661
                raise errors.ConflictFormatError()
2027
 
            reader = _mod_rio.RioReader(confile)
2028
 
            return _mod_conflicts.ConflictList.from_stanzas(reader)
 
2662
            return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2029
2663
        finally:
2030
2664
            confile.close()
2031
2665
 
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):
 
2666
    def unlock(self):
 
2667
        # do non-implementation specific cleanup
 
2668
        self._cleanup()
 
2669
        if self._control_files._lock_count == 1:
 
2670
            # _inventory_is_modified is always False during a read lock.
 
2671
            if self._inventory_is_modified:
 
2672
                self.flush()
 
2673
            self._write_hashcache_if_dirty()
 
2674
        # reverse order of locking.
 
2675
        try:
 
2676
            return self._control_files.unlock()
 
2677
        finally:
 
2678
            self.branch.unlock()
 
2679
 
 
2680
 
 
2681
def get_conflicted_stem(path):
 
2682
    for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
 
2683
        if path.endswith(suffix):
 
2684
            return path[:-len(suffix)]
 
2685
 
 
2686
 
 
2687
class WorkingTreeFormat(object):
2985
2688
    """An encapsulation of the initialization and open routines for a format.
2986
2689
 
2987
2690
    Formats provide three things:
2999
2702
    object will be created every time regardless.
3000
2703
    """
3001
2704
 
 
2705
    _default_format = None
 
2706
    """The default format used for new trees."""
 
2707
 
 
2708
    _formats = {}
 
2709
    """The known formats."""
 
2710
 
3002
2711
    requires_rich_root = False
3003
2712
 
3004
2713
    upgrade_recommended = False
3005
2714
 
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
2715
    @classmethod
3016
 
    def find_format_string(klass, a_bzrdir):
3017
 
        """Return format name for the working tree object in a_bzrdir."""
 
2716
    def find_format(klass, a_bzrdir):
 
2717
        """Return the format for the working tree object in a_bzrdir."""
3018
2718
        try:
3019
2719
            transport = a_bzrdir.get_workingtree_transport(None)
3020
 
            return transport.get_bytes("format")
 
2720
            format_string = transport.get("format").read()
 
2721
            return klass._formats[format_string]
3021
2722
        except errors.NoSuchFile:
3022
2723
            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
2724
        except KeyError:
3031
2725
            raise errors.UnknownFormatError(format=format_string,
3032
2726
                                            kind="working tree")
3033
2727
 
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
2728
    def __eq__(self, other):
3052
2729
        return self.__class__ is other.__class__
3053
2730
 
3055
2732
        return not (self == other)
3056
2733
 
3057
2734
    @classmethod
3058
 
    @symbol_versioning.deprecated_method(
3059
 
        symbol_versioning.deprecated_in((2, 4, 0)))
3060
2735
    def get_default_format(klass):
3061
2736
        """Return the current default format."""
3062
 
        return format_registry.get_default()
 
2737
        return klass._default_format
3063
2738
 
3064
2739
    def get_format_string(self):
3065
2740
        """Return the ASCII format string that identifies this format."""
3087
2762
        return False
3088
2763
 
3089
2764
    @classmethod
3090
 
    @symbol_versioning.deprecated_method(
3091
 
        symbol_versioning.deprecated_in((2, 4, 0)))
3092
2765
    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)))
 
2766
        klass._formats[format.get_format_string()] = format
 
2767
 
 
2768
    @classmethod
3116
2769
    def set_default_format(klass, format):
3117
 
        format_registry.set_default(format)
 
2770
        klass._default_format = format
3118
2771
 
3119
2772
    @classmethod
3120
 
    @symbol_versioning.deprecated_method(
3121
 
        symbol_versioning.deprecated_in((2, 4, 0)))
3122
2773
    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")
 
2774
        del klass._formats[format.get_format_string()]
 
2775
 
 
2776
 
 
2777
class WorkingTreeFormat2(WorkingTreeFormat):
 
2778
    """The second working tree format.
 
2779
 
 
2780
    This format modified the hash cache from the format 1 hash cache.
 
2781
    """
 
2782
 
 
2783
    upgrade_recommended = True
 
2784
 
 
2785
    def get_format_description(self):
 
2786
        """See WorkingTreeFormat.get_format_description()."""
 
2787
        return "Working tree format 2"
 
2788
 
 
2789
    def _stub_initialize_on_transport(self, transport, file_mode):
 
2790
        """Workaround: create control files for a remote working tree.
 
2791
 
 
2792
        This ensures that it can later be updated and dealt with locally,
 
2793
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
 
2794
        no working tree.  (See bug #43064).
 
2795
        """
 
2796
        sio = StringIO()
 
2797
        inv = inventory.Inventory()
 
2798
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
 
2799
        sio.seek(0)
 
2800
        transport.put_file('inventory', sio, file_mode)
 
2801
        transport.put_bytes('pending-merges', '', file_mode)
 
2802
 
 
2803
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
 
2804
                   accelerator_tree=None, hardlink=False):
 
2805
        """See WorkingTreeFormat.initialize()."""
 
2806
        if not isinstance(a_bzrdir.transport, LocalTransport):
 
2807
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
 
2808
        if from_branch is not None:
 
2809
            branch = from_branch
 
2810
        else:
 
2811
            branch = a_bzrdir.open_branch()
 
2812
        if revision_id is None:
 
2813
            revision_id = _mod_revision.ensure_null(branch.last_revision())
 
2814
        branch.lock_write()
 
2815
        try:
 
2816
            branch.generate_revision_history(revision_id)
 
2817
        finally:
 
2818
            branch.unlock()
 
2819
        inv = inventory.Inventory()
 
2820
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
 
2821
                         branch,
 
2822
                         inv,
 
2823
                         _internal=True,
 
2824
                         _format=self,
 
2825
                         _bzrdir=a_bzrdir)
 
2826
        basis_tree = branch.repository.revision_tree(revision_id)
 
2827
        if basis_tree.inventory.root is not None:
 
2828
            wt.set_root_id(basis_tree.get_root_id())
 
2829
        # set the parent list and cache the basis tree.
 
2830
        if _mod_revision.is_null(revision_id):
 
2831
            parent_trees = []
 
2832
        else:
 
2833
            parent_trees = [(revision_id, basis_tree)]
 
2834
        wt.set_parent_trees(parent_trees)
 
2835
        transform.build_tree(basis_tree, wt)
 
2836
        return wt
 
2837
 
 
2838
    def __init__(self):
 
2839
        super(WorkingTreeFormat2, self).__init__()
 
2840
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
 
2841
 
 
2842
    def open(self, a_bzrdir, _found=False):
 
2843
        """Return the WorkingTree object for a_bzrdir
 
2844
 
 
2845
        _found is a private parameter, do not use it. It is used to indicate
 
2846
               if format probing has already been done.
 
2847
        """
 
2848
        if not _found:
 
2849
            # we are being called directly and must probe.
 
2850
            raise NotImplementedError
 
2851
        if not isinstance(a_bzrdir.transport, LocalTransport):
 
2852
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
 
2853
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
 
2854
                           _internal=True,
 
2855
                           _format=self,
 
2856
                           _bzrdir=a_bzrdir)
 
2857
        return wt
 
2858
 
 
2859
class WorkingTreeFormat3(WorkingTreeFormat):
 
2860
    """The second working tree format updated to record a format marker.
 
2861
 
 
2862
    This format:
 
2863
        - exists within a metadir controlling .bzr
 
2864
        - includes an explicit version marker for the workingtree control
 
2865
          files, separate from the BzrDir format
 
2866
        - modifies the hash cache format
 
2867
        - is new in bzr 0.8
 
2868
        - uses a LockDir to guard access for writes.
 
2869
    """
 
2870
 
 
2871
    upgrade_recommended = True
 
2872
 
 
2873
    def get_format_string(self):
 
2874
        """See WorkingTreeFormat.get_format_string()."""
 
2875
        return "Bazaar-NG Working Tree format 3"
 
2876
 
 
2877
    def get_format_description(self):
 
2878
        """See WorkingTreeFormat.get_format_description()."""
 
2879
        return "Working tree format 3"
 
2880
 
 
2881
    _lock_file_name = 'lock'
 
2882
    _lock_class = LockDir
 
2883
 
 
2884
    _tree_class = WorkingTree3
 
2885
 
 
2886
    def __get_matchingbzrdir(self):
 
2887
        return bzrdir.BzrDirMetaFormat1()
 
2888
 
 
2889
    _matchingbzrdir = property(__get_matchingbzrdir)
 
2890
 
 
2891
    def _open_control_files(self, a_bzrdir):
 
2892
        transport = a_bzrdir.get_workingtree_transport(None)
 
2893
        return LockableFiles(transport, self._lock_file_name,
 
2894
                             self._lock_class)
 
2895
 
 
2896
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
 
2897
                   accelerator_tree=None, hardlink=False):
 
2898
        """See WorkingTreeFormat.initialize().
 
2899
 
 
2900
        :param revision_id: if supplied, create a working tree at a different
 
2901
            revision than the branch is at.
 
2902
        :param accelerator_tree: A tree which can be used for retrieving file
 
2903
            contents more quickly than the revision tree, i.e. a workingtree.
 
2904
            The revision tree will be used for cases where accelerator_tree's
 
2905
            content is different.
 
2906
        :param hardlink: If true, hard-link files from accelerator_tree,
 
2907
            where possible.
 
2908
        """
 
2909
        if not isinstance(a_bzrdir.transport, LocalTransport):
 
2910
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
 
2911
        transport = a_bzrdir.get_workingtree_transport(self)
 
2912
        control_files = self._open_control_files(a_bzrdir)
 
2913
        control_files.create_lock()
 
2914
        control_files.lock_write()
 
2915
        transport.put_bytes('format', self.get_format_string(),
 
2916
            mode=a_bzrdir._get_file_mode())
 
2917
        if from_branch is not None:
 
2918
            branch = from_branch
 
2919
        else:
 
2920
            branch = a_bzrdir.open_branch()
 
2921
        if revision_id is None:
 
2922
            revision_id = _mod_revision.ensure_null(branch.last_revision())
 
2923
        # WorkingTree3 can handle an inventory which has a unique root id.
 
2924
        # as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
 
2925
        # those trees. And because there isn't a format bump inbetween, we
 
2926
        # are maintaining compatibility with older clients.
 
2927
        # inv = Inventory(root_id=gen_root_id())
 
2928
        inv = self._initial_inventory()
 
2929
        wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
 
2930
                         branch,
 
2931
                         inv,
 
2932
                         _internal=True,
 
2933
                         _format=self,
 
2934
                         _bzrdir=a_bzrdir,
 
2935
                         _control_files=control_files)
 
2936
        wt.lock_tree_write()
 
2937
        try:
 
2938
            basis_tree = branch.repository.revision_tree(revision_id)
 
2939
            # only set an explicit root id if there is one to set.
 
2940
            if basis_tree.inventory.root is not None:
 
2941
                wt.set_root_id(basis_tree.get_root_id())
 
2942
            if revision_id == _mod_revision.NULL_REVISION:
 
2943
                wt.set_parent_trees([])
 
2944
            else:
 
2945
                wt.set_parent_trees([(revision_id, basis_tree)])
 
2946
            transform.build_tree(basis_tree, wt)
 
2947
        finally:
 
2948
            # Unlock in this order so that the unlock-triggers-flush in
 
2949
            # WorkingTree is given a chance to fire.
 
2950
            control_files.unlock()
 
2951
            wt.unlock()
 
2952
        return wt
 
2953
 
 
2954
    def _initial_inventory(self):
 
2955
        return inventory.Inventory()
 
2956
 
 
2957
    def __init__(self):
 
2958
        super(WorkingTreeFormat3, self).__init__()
 
2959
 
 
2960
    def open(self, a_bzrdir, _found=False):
 
2961
        """Return the WorkingTree object for a_bzrdir
 
2962
 
 
2963
        _found is a private parameter, do not use it. It is used to indicate
 
2964
               if format probing has already been done.
 
2965
        """
 
2966
        if not _found:
 
2967
            # we are being called directly and must probe.
 
2968
            raise NotImplementedError
 
2969
        if not isinstance(a_bzrdir.transport, LocalTransport):
 
2970
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
 
2971
        wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
 
2972
        return wt
 
2973
 
 
2974
    def _open(self, a_bzrdir, control_files):
 
2975
        """Open the tree itself.
 
2976
 
 
2977
        :param a_bzrdir: the dir for the tree.
 
2978
        :param control_files: the control files for the tree.
 
2979
        """
 
2980
        return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
 
2981
                                _internal=True,
 
2982
                                _format=self,
 
2983
                                _bzrdir=a_bzrdir,
 
2984
                                _control_files=control_files)
 
2985
 
 
2986
    def __str__(self):
 
2987
        return self.get_format_string()
 
2988
 
 
2989
 
 
2990
__default_format = WorkingTreeFormat4()
 
2991
WorkingTreeFormat.register_format(__default_format)
 
2992
WorkingTreeFormat.register_format(WorkingTreeFormat6())
 
2993
WorkingTreeFormat.register_format(WorkingTreeFormat5())
 
2994
WorkingTreeFormat.register_format(WorkingTreeFormat3())
 
2995
WorkingTreeFormat.set_default_format(__default_format)
 
2996
# formats which have no format string are not discoverable
 
2997
# and not independently creatable, so are not registered.
 
2998
_legacy_formats = [WorkingTreeFormat2(),
 
2999
                   ]