~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-02-11 04:02:41 UTC
  • mfrom: (5017.2.2 tariff)
  • Revision ID: pqm@pqm.ubuntu.com-20100211040241-w6n021dz0uus341n
(mbp) add import-tariff tests

Show diffs side-by-side

added added

removed removed

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