~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

(jameinel) (bug #780544) when updating the WT,
 allow it to be done with a fast delta,
 rather than setting the state from scratch. (John A Meinel)

Show diffs side-by-side

added added

removed removed

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