~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-12-09 02:53:42 UTC
  • mfrom: (4873.2.3 2.1.0b4-win32-test-imports)
  • Revision ID: pqm@pqm.ubuntu.com-20091209025342-sidvxfcqdgxmuz59
(jam) Get the test suite running again on Windows, (bug #492561)

Show diffs side-by-side

added added

removed removed

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