~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Martin Pool
  • Date: 2010-06-02 05:03:31 UTC
  • mto: This revision was merged to the branch mainline in revision 5279.
  • Revision ID: mbp@canonical.com-20100602050331-n2p1qt8hfsahspnv
Correct more sloppy use of the term 'Linux'

Show diffs side-by-side

added added

removed removed

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