~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Robert Collins
  • Date: 2010-05-11 08:44:59 UTC
  • mfrom: (5221 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100511084459-pb0uinna9zs3wu59
Merge trunk - resolve conflicts.

Show diffs side-by-side

added added

removed removed

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