/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

(gz) Fix deprecations of win32utils path function unicode wrappers (Martin
 Packman)

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