~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Jelmer Vernooij
  • Date: 2012-03-21 10:48:58 UTC
  • mto: This revision was merged to the branch mainline in revision 6515.
  • Revision ID: jelmer@vernstok.nl-20120321104858-nho0dkromtrwxfum
Remove some unused imports.

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