/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: John Arbash Meinel
  • Date: 2011-09-01 16:54:46 UTC
  • mto: This revision was merged to the branch mainline in revision 6133.
  • Revision ID: john@arbash-meinel.com-20110901165446-8q61mct72u4tdmu6
Add some tests for how the estimator works.

We have to be pretty 'loose' about the tests because zlib
is platform dependent.

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