~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Jelmer Vernooij
  • Date: 2011-09-26 15:21:01 UTC
  • mfrom: (6165.2.3 avoid-revision-history)
  • mto: This revision was merged to the branch mainline in revision 6216.
  • Revision ID: jelmer@samba.org-20110926152101-afcxw1hikybyivfd
merge avoid-revision-history.

Show diffs side-by-side

added added

removed removed

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