~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Jelmer Vernooij
  • Date: 2011-09-05 14:16:12 UTC
  • mto: (6123.1.5 +trunk)
  • mto: This revision was merged to the branch mainline in revision 6124.
  • Revision ID: jelmer@samba.org-20110905141612-o8t6zu2tjezh2vk3
Move flags to BranchFormat.

Show diffs side-by-side

added added

removed removed

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