~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Robert Collins
  • Date: 2010-05-11 08:36:16 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100511083616-b8fjb19zomwupid0
Make all lock methods return Result objects, rather than lock_read returning self, as per John's review.

Show diffs side-by-side

added added

removed removed

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