← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

https://launchpad.net/bugs/524184
NEWS section template into a separate file

Show diffs side-by-side

added added

removed removed

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