/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

(jelmer) Use the absolute_import feature everywhere in bzrlib,
 and add a source test to make sure it's used everywhere. (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

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