← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Vincent Ladeuil
  • Date: 2017-01-30 14:30:10 UTC
  • mfrom: (6615.3.7 merges)
  • mto: This revision was merged to the branch mainline in revision 6621.
  • Revision ID: v.ladeuil+lp@free.fr-20170130143010-p31t1ranfeqbaeki
Merge  2.7 into trunk including fix for bug #1657238

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/workingtree.py
1
 
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
29
29
WorkingTree.open(dir).
30
30
"""
31
31
 
32
 
# 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)
 
32
from __future__ import absolute_import
38
33
 
39
34
from cStringIO import StringIO
40
35
import os
50
45
import stat
51
46
import re
52
47
 
53
 
import bzrlib
54
48
from bzrlib import (
55
49
    branch,
56
 
    bzrdir,
57
50
    conflicts as _mod_conflicts,
 
51
    controldir,
58
52
    errors,
 
53
    filters as _mod_filters,
59
54
    generate_ids,
60
55
    globbing,
61
56
    graph as _mod_graph,
62
 
    hashcache,
63
57
    ignores,
64
58
    inventory,
65
59
    merge,
66
60
    revision as _mod_revision,
67
61
    revisiontree,
68
 
    textui,
69
 
    trace,
 
62
    rio as _mod_rio,
 
63
    shelf,
70
64
    transform,
 
65
    transport,
71
66
    ui,
72
67
    views,
73
68
    xml5,
74
69
    xml7,
75
70
    )
76
 
import bzrlib.branch
77
 
from bzrlib.transport import get_transport
78
 
from bzrlib.workingtree_4 import (
79
 
    WorkingTreeFormat4,
80
 
    WorkingTreeFormat5,
81
 
    WorkingTreeFormat6,
82
 
    )
83
71
""")
84
72
 
85
 
from bzrlib import symbol_versioning
 
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
 
86
80
from bzrlib.decorators import needs_read_lock, needs_write_lock
87
 
from bzrlib.lockable_files import LockableFiles
88
 
from bzrlib.lockdir import LockDir
 
81
from bzrlib.i18n import gettext
 
82
from bzrlib.lock import LogicalLockResult
89
83
import bzrlib.mutabletree
90
84
from bzrlib.mutabletree import needs_tree_write_lock
91
85
from bzrlib import osutils
97
91
    realpath,
98
92
    safe_unicode,
99
93
    splitpath,
100
 
    supports_executable,
101
94
    )
102
 
from bzrlib.filters import filtered_input_file
103
95
from bzrlib.trace import mutter, note
104
 
from bzrlib.transport.local import LocalTransport
105
 
from bzrlib.progress import DummyProgress, ProgressPhase
106
96
from bzrlib.revision import CURRENT_REVISION
107
 
from bzrlib.rio import RioReader, rio_file, Stanza
108
97
from bzrlib.symbol_versioning import (
109
98
    deprecated_passed,
110
99
    DEPRECATED_PARAMETER,
112
101
 
113
102
 
114
103
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.
115
107
CONFLICT_HEADER_1 = "BZR conflict list format 1"
116
108
 
117
109
ERROR_PATH_NOT_FOUND = 3    # WindowsError errno code, equivalent to ENOENT
172
164
        return ''
173
165
 
174
166
 
175
 
class WorkingTree(bzrlib.mutabletree.MutableTree):
 
167
class WorkingTree(bzrlib.mutabletree.MutableTree,
 
168
    controldir.ControlComponent):
176
169
    """Working copy tree.
177
170
 
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.
 
171
    :ivar basedir: The root of the tree on disk. This is a unicode path object
 
172
        (as opposed to a URL).
183
173
    """
184
174
 
185
175
    # override this to set the strategy for storing views
188
178
 
189
179
    def __init__(self, basedir='.',
190
180
                 branch=DEPRECATED_PARAMETER,
191
 
                 _inventory=None,
192
 
                 _control_files=None,
193
181
                 _internal=False,
 
182
                 _transport=None,
194
183
                 _format=None,
195
184
                 _bzrdir=None):
196
185
        """Construct a WorkingTree instance. This is not a public API.
209
198
        else:
210
199
            self._branch = self.bzrdir.open_branch()
211
200
        self.basedir = realpath(basedir)
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()
 
201
        self._transport = _transport
251
202
        self._rules_searcher = None
252
203
        self.views = self._make_views()
253
204
 
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()
 
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)
264
224
 
265
225
    branch = property(
266
226
        fget=lambda self: self._branch,
270
230
            the working tree has been constructed from.
271
231
            """)
272
232
 
 
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
 
273
243
    def break_lock(self):
274
244
        """Break a lock if one is present from another instance.
275
245
 
278
248
 
279
249
        This will probe the repository for its lock as well.
280
250
        """
281
 
        self._control_files.break_lock()
282
 
        self.branch.break_lock()
 
251
        raise NotImplementedError(self.break_lock)
283
252
 
284
253
    def requires_rich_root(self):
285
254
        return self._format.requires_rich_root
293
262
    def supports_views(self):
294
263
        return self.views.supports_views()
295
264
 
296
 
    def _set_inventory(self, inv, dirty):
297
 
        """Set the internal cached inventory.
 
265
    def get_config_stack(self):
 
266
        """Retrieve the config stack for this tree.
298
267
 
299
 
        :param inv: The inventory to set.
300
 
        :param dirty: A boolean indicating whether the inventory is the same
301
 
            logical inventory as whats on disk. If True the inventory is not
302
 
            the same and should be written to disk or data will be lost, if
303
 
            False then the inventory is the same as that on disk and any
304
 
            serialisation would be unneeded overhead.
 
268
        :return: A ``bzrlib.config.Stack``
305
269
        """
306
 
        self._inventory = inv
307
 
        self._inventory_is_modified = dirty
 
270
        # For the moment, just provide the branch config stack.
 
271
        return self.branch.get_config_stack()
308
272
 
309
273
    @staticmethod
310
274
    def open(path=None, _unsupported=False):
313
277
        """
314
278
        if path is None:
315
279
            path = osutils.getcwd()
316
 
        control = bzrdir.BzrDir.open(path, _unsupported)
317
 
        return control.open_workingtree(_unsupported)
 
280
        control = controldir.ControlDir.open(path, _unsupported=_unsupported)
 
281
        return control.open_workingtree(unsupported=_unsupported)
318
282
 
319
283
    @staticmethod
320
284
    def open_containing(path=None):
331
295
        """
332
296
        if path is None:
333
297
            path = osutils.getcwd()
334
 
        control, relpath = bzrdir.BzrDir.open_containing(path)
335
 
 
 
298
        control, relpath = controldir.ControlDir.open_containing(path)
336
299
        return control.open_workingtree(), relpath
337
300
 
338
301
    @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
339
368
    def open_downlevel(path=None):
340
369
        """Open an unsupported working tree.
341
370
 
354
383
                return True, None
355
384
            else:
356
385
                return True, tree
357
 
        transport = get_transport(location)
358
 
        iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
 
386
        t = transport.get_transport(location)
 
387
        iterator = controldir.ControlDir.find_bzrdirs(t, evaluate=evaluate,
359
388
                                              list_current=list_current)
360
 
        return [t for t in iterator if t is not None]
361
 
 
362
 
    # should be deprecated - this is slow and in any case treating them as a
363
 
    # container is (we now know) bad style -- mbp 20070302
364
 
    ## @deprecated_method(zero_fifteen)
365
 
    def __iter__(self):
366
 
        """Iterate through file_ids for this tree.
367
 
 
368
 
        file_ids are in a WorkingTree if they are in the working inventory
369
 
        and the working file exists.
370
 
        """
371
 
        inv = self._inventory
372
 
        for path, ie in inv.iter_entries():
373
 
            if osutils.lexists(self.abspath(path)):
374
 
                yield ie.file_id
375
 
 
376
 
    def all_file_ids(self):
377
 
        """See Tree.iter_all_file_ids"""
378
 
        return set(self.inventory)
 
389
        return [tr for tr in iterator if tr is not None]
379
390
 
380
391
    def __repr__(self):
381
392
        return "<%s of %s>" % (self.__class__.__name__,
436
447
        return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
437
448
 
438
449
    def get_file_with_stat(self, file_id, path=None, filtered=True,
439
 
        _fstat=os.fstat):
 
450
                           _fstat=osutils.fstat):
440
451
        """See Tree.get_file_with_stat."""
441
452
        if path is None:
442
453
            path = self.id2path(file_id)
444
455
        stat_value = _fstat(file_obj.fileno())
445
456
        if filtered and self.supports_content_filtering():
446
457
            filters = self._content_filter_stack(path)
447
 
            file_obj = filtered_input_file(file_obj, filters)
 
458
            file_obj = _mod_filters.filtered_input_file(file_obj, filters)
448
459
        return (file_obj, stat_value)
449
460
 
450
461
    def get_file_text(self, file_id, path=None, filtered=True):
451
 
        return self.get_file(file_id, path=path, filtered=filtered).read()
 
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()
452
467
 
453
468
    def get_file_byname(self, filename, filtered=True):
454
469
        path = self.abspath(filename)
455
470
        f = file(path, 'rb')
456
471
        if filtered and self.supports_content_filtering():
457
472
            filters = self._content_filter_stack(filename)
458
 
            return filtered_input_file(f, filters)
 
473
            return _mod_filters.filtered_input_file(f, filters)
459
474
        else:
460
475
            return f
461
476
 
467
482
        finally:
468
483
            file.close()
469
484
 
470
 
    @needs_read_lock
471
 
    def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
472
 
        """See Tree.annotate_iter
473
 
 
474
 
        This implementation will use the basis tree implementation if possible.
475
 
        Lines not in the basis are attributed to CURRENT_REVISION
476
 
 
477
 
        If there are pending merges, lines added by those merges will be
478
 
        incorrectly attributed to CURRENT_REVISION (but after committing, the
479
 
        attribution will be correct).
480
 
        """
481
 
        maybe_file_parent_keys = []
482
 
        for parent_id in self.get_parent_ids():
483
 
            try:
484
 
                parent_tree = self.revision_tree(parent_id)
485
 
            except errors.NoSuchRevisionInTree:
486
 
                parent_tree = self.branch.repository.revision_tree(parent_id)
487
 
            parent_tree.lock_read()
488
 
            try:
489
 
                if file_id not in parent_tree:
490
 
                    continue
491
 
                ie = parent_tree.inventory[file_id]
492
 
                if ie.kind != 'file':
493
 
                    # Note: this is slightly unnecessary, because symlinks and
494
 
                    # directories have a "text" which is the empty text, and we
495
 
                    # know that won't mess up annotations. But it seems cleaner
496
 
                    continue
497
 
                parent_text_key = (file_id, ie.revision)
498
 
                if parent_text_key not in maybe_file_parent_keys:
499
 
                    maybe_file_parent_keys.append(parent_text_key)
500
 
            finally:
501
 
                parent_tree.unlock()
502
 
        graph = _mod_graph.Graph(self.branch.repository.texts)
503
 
        heads = graph.heads(maybe_file_parent_keys)
504
 
        file_parent_keys = []
505
 
        for key in maybe_file_parent_keys:
506
 
            if key in heads:
507
 
                file_parent_keys.append(key)
508
 
 
509
 
        # Now we have the parents of this content
510
 
        annotator = self.branch.repository.texts.get_annotator()
511
 
        text = self.get_file(file_id).read()
512
 
        this_key =(file_id, default_revision)
513
 
        annotator.add_special_text(this_key, file_parent_keys, text)
514
 
        annotations = [(key[-1], line)
515
 
                       for key, line in annotator.annotate_flat(this_key)]
516
 
        return annotations
517
 
 
518
 
    def _get_ancestors(self, default_revision):
519
 
        ancestors = set([default_revision])
520
 
        for parent_id in self.get_parent_ids():
521
 
            ancestors.update(self.branch.repository.get_ancestry(
522
 
                             parent_id, topo_sorted=False))
523
 
        return ancestors
524
 
 
525
485
    def get_parent_ids(self):
526
486
        """See Tree.get_parent_ids.
527
487
 
534
494
        else:
535
495
            parents = [last_rev]
536
496
        try:
537
 
            merges_file = self._transport.get('pending-merges')
 
497
            merges_bytes = self._transport.get_bytes('pending-merges')
538
498
        except errors.NoSuchFile:
539
499
            pass
540
500
        else:
541
 
            for l in merges_file.readlines():
 
501
            for l in osutils.split_lines(merges_bytes):
542
502
                revision_id = l.rstrip('\n')
543
503
                parents.append(revision_id)
544
504
        return parents
545
505
 
546
 
    @needs_read_lock
547
506
    def get_root_id(self):
548
507
        """Return the id of this trees root"""
549
 
        return self._inventory.root.file_id
550
 
 
551
 
    def _get_store_filename(self, file_id):
552
 
        ## XXX: badly named; this is not in the store at all
553
 
        return self.abspath(self.id2path(file_id))
 
508
        raise NotImplementedError(self.get_root_id)
554
509
 
555
510
    @needs_read_lock
556
 
    def clone(self, to_bzrdir, revision_id=None):
 
511
    def clone(self, to_controldir, revision_id=None):
557
512
        """Duplicate this working tree into to_bzr, including all state.
558
513
 
559
514
        Specifically modified files are kept as modified, but
560
515
        ignored and unknown files are discarded.
561
516
 
562
 
        If you want to make a new line of development, see bzrdir.sprout()
 
517
        If you want to make a new line of development, see ControlDir.sprout()
563
518
 
564
519
        revision
565
520
            If not None, the cloned tree will have its last revision set to
567
522
            and this one merged in.
568
523
        """
569
524
        # assumes the target bzr dir format is compatible.
570
 
        result = to_bzrdir.create_workingtree()
 
525
        result = to_controldir.create_workingtree()
571
526
        self.copy_content_into(result, revision_id)
572
527
        return result
573
528
 
580
535
        else:
581
536
            # TODO now merge from tree.last_revision to revision (to preserve
582
537
            # user local changes)
583
 
            merge.transform_tree(tree, self)
584
 
            tree.set_parent_ids([revision_id])
 
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)
585
549
 
586
550
    def id2abspath(self, file_id):
587
551
        return self.abspath(self.id2path(file_id))
588
552
 
589
 
    def has_id(self, file_id):
590
 
        # files that have been deleted are excluded
591
 
        inv = self.inventory
592
 
        if not inv.has_id(file_id):
593
 
            return False
594
 
        path = inv.id2path(file_id)
595
 
        return osutils.lexists(self.abspath(path))
596
 
 
597
 
    def has_or_had_id(self, file_id):
598
 
        if file_id == self.inventory.root.file_id:
599
 
            return True
600
 
        return self.inventory.has_id(file_id)
601
 
 
602
 
    __contains__ = has_id
 
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)
603
580
 
604
581
    def get_file_size(self, file_id):
605
582
        """See Tree.get_file_size"""
 
583
        # XXX: this returns the on-disk size; it should probably return the
 
584
        # canonical size
606
585
        try:
607
586
            return os.path.getsize(self.id2abspath(file_id))
608
587
        except OSError, e:
611
590
            else:
612
591
                return None
613
592
 
614
 
    @needs_read_lock
615
 
    def get_file_sha1(self, file_id, path=None, stat_value=None):
616
 
        if not path:
617
 
            path = self._inventory.id2path(file_id)
618
 
        return self._hashcache.get_sha1(path, stat_value)
619
 
 
620
 
    def get_file_mtime(self, file_id, path=None):
621
 
        if not path:
622
 
            path = self.inventory.id2path(file_id)
623
 
        return os.lstat(self.abspath(path)).st_mtime
624
 
 
625
 
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
626
 
        file_id = self.path2id(path)
627
 
        return self._inventory[file_id].executable
628
 
 
629
 
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
630
 
        mode = stat_result.st_mode
631
 
        return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
632
 
 
633
 
    if not supports_executable():
634
 
        def is_executable(self, file_id, path=None):
635
 
            return self._inventory[file_id].executable
636
 
 
637
 
        _is_executable_from_path_and_stat = \
638
 
            _is_executable_from_path_and_stat_from_basis
639
 
    else:
640
 
        def is_executable(self, file_id, path=None):
641
 
            if not path:
642
 
                path = self.id2path(file_id)
643
 
            mode = os.lstat(self.abspath(path)).st_mode
644
 
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
645
 
 
646
 
        _is_executable_from_path_and_stat = \
647
 
            _is_executable_from_path_and_stat_from_stat
648
 
 
649
 
    @needs_tree_write_lock
650
 
    def _add(self, files, ids, kinds):
651
 
        """See MutableTree._add."""
652
 
        # TODO: Re-adding a file that is removed in the working copy
653
 
        # should probably put it back with the previous ID.
654
 
        # the read and write working inventory should not occur in this
655
 
        # function - they should be part of lock_write and unlock.
656
 
        inv = self.inventory
657
 
        for f, file_id, kind in zip(files, ids, kinds):
658
 
            if file_id is None:
659
 
                inv.add_path(f, kind=kind)
660
 
            else:
661
 
                inv.add_path(f, kind=kind, file_id=file_id)
662
 
            self._inventory_is_modified = True
663
 
 
664
593
    @needs_tree_write_lock
665
594
    def _gather_kinds(self, files, kinds):
666
595
        """See MutableTree._gather_kinds."""
681
610
        and setting the list to its value plus revision_id.
682
611
 
683
612
        :param revision_id: The revision id to add to the parent list. It may
684
 
        be a ghost revision as long as its not the first parent to be added,
685
 
        or the allow_leftmost_as_ghost parameter is set True.
 
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.
686
615
        :param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
687
616
        """
688
617
        parents = self.get_parent_ids() + [revision_id]
739
668
            raise
740
669
        kind = _mapper(stat_result.st_mode)
741
670
        if kind == 'file':
742
 
            size = stat_result.st_size
743
 
            # try for a stat cache lookup
744
 
            executable = self._is_executable_from_path_and_stat(path, stat_result)
745
 
            return (kind, size, executable, self._sha_from_stat(
746
 
                path, stat_result))
 
671
            return self._file_content_summary(path, stat_result)
747
672
        elif kind == 'directory':
748
673
            # perhaps it looks like a plain directory, but it's really a
749
674
            # reference.
756
681
        else:
757
682
            return (kind, None, None, None)
758
683
 
 
684
    def _file_content_summary(self, path, stat_result):
 
685
        size = stat_result.st_size
 
686
        executable = self._is_executable_from_path_and_stat(path, stat_result)
 
687
        # try for a stat cache lookup
 
688
        return ('file', size, executable, self._sha_from_stat(
 
689
            path, stat_result))
 
690
 
759
691
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
760
692
        """Common ghost checking functionality from set_parent_*.
761
693
 
788
720
            if revision_id in heads and revision_id not in new_revision_ids:
789
721
                new_revision_ids.append(revision_id)
790
722
        if new_revision_ids != revision_ids:
791
 
            trace.mutter('requested to set revision_ids = %s,'
 
723
            mutter('requested to set revision_ids = %s,'
792
724
                         ' but filtered to %s', revision_ids, new_revision_ids)
793
725
        return new_revision_ids
794
726
 
820
752
        self._set_merges_from_parent_ids(revision_ids)
821
753
 
822
754
    @needs_tree_write_lock
823
 
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
824
 
        """See MutableTree.set_parent_trees."""
825
 
        parent_ids = [rev for (rev, tree) in parents_list]
826
 
        for revision_id in parent_ids:
827
 
            _mod_revision.check_not_reserved_id(revision_id)
828
 
 
829
 
        self._check_parents_for_ghosts(parent_ids,
830
 
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
831
 
 
832
 
        parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
833
 
 
834
 
        if len(parent_ids) == 0:
835
 
            leftmost_parent_id = _mod_revision.NULL_REVISION
836
 
            leftmost_parent_tree = None
837
 
        else:
838
 
            leftmost_parent_id, leftmost_parent_tree = parents_list[0]
839
 
 
840
 
        if self._change_last_revision(leftmost_parent_id):
841
 
            if leftmost_parent_tree is None:
842
 
                # If we don't have a tree, fall back to reading the
843
 
                # parent tree from the repository.
844
 
                self._cache_basis_inventory(leftmost_parent_id)
845
 
            else:
846
 
                inv = leftmost_parent_tree.inventory
847
 
                xml = self._create_basis_xml_from_inventory(
848
 
                                        leftmost_parent_id, inv)
849
 
                self._write_basis_inventory(xml)
850
 
        self._set_merges_from_parent_ids(parent_ids)
851
 
 
852
 
    @needs_tree_write_lock
853
755
    def set_pending_merges(self, rev_list):
854
756
        parents = self.get_parent_ids()
855
757
        leftmost = parents[:1]
858
760
 
859
761
    @needs_tree_write_lock
860
762
    def set_merge_modified(self, modified_hashes):
861
 
        def iter_stanzas():
862
 
            for file_id, hash in modified_hashes.iteritems():
863
 
                yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
864
 
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
 
763
        """Set the merge modified hashes."""
 
764
        raise NotImplementedError(self.set_merge_modified)
865
765
 
866
766
    def _sha_from_stat(self, path, stat_result):
867
767
        """Get a sha digest from the tree's stat cache.
873
773
        """
874
774
        return None
875
775
 
876
 
    def _put_rio(self, filename, stanzas, header):
877
 
        self._must_be_locked()
878
 
        my_file = rio_file(stanzas, header)
879
 
        self._transport.put_file(filename, my_file,
880
 
            mode=self.bzrdir._get_file_mode())
881
 
 
882
776
    @needs_write_lock # because merge pulls data into the branch.
883
777
    def merge_from_branch(self, branch, to_revision=None, from_revision=None,
884
 
        merge_type=None):
 
778
                          merge_type=None, force=False):
885
779
        """Merge from a branch into this working tree.
886
780
 
887
781
        :param branch: The branch to merge from.
891
785
            branch.last_revision().
892
786
        """
893
787
        from bzrlib.merge import Merger, Merge3Merger
894
 
        pb = ui.ui_factory.nested_progress_bar()
895
 
        try:
896
 
            merger = Merger(self.branch, this_tree=self, pb=pb)
897
 
            merger.pp = ProgressPhase("Merge phase", 5, pb)
898
 
            merger.pp.next_phase()
899
 
            # check that there are no
900
 
            # local alterations
901
 
            merger.check_basis(check_clean=True, require_commits=False)
902
 
            if to_revision is None:
903
 
                to_revision = _mod_revision.ensure_null(branch.last_revision())
904
 
            merger.other_rev_id = to_revision
905
 
            if _mod_revision.is_null(merger.other_rev_id):
906
 
                raise errors.NoCommits(branch)
907
 
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
908
 
            merger.other_basis = merger.other_rev_id
909
 
            merger.other_tree = self.branch.repository.revision_tree(
910
 
                merger.other_rev_id)
911
 
            merger.other_branch = branch
912
 
            merger.pp.next_phase()
913
 
            if from_revision is None:
914
 
                merger.find_base()
915
 
            else:
916
 
                merger.set_base_revision(from_revision, branch)
917
 
            if merger.base_rev_id == merger.other_rev_id:
918
 
                raise errors.PointlessMerge
919
 
            merger.backup_files = False
920
 
            if merge_type is None:
921
 
                merger.merge_type = Merge3Merger
922
 
            else:
923
 
                merger.merge_type = merge_type
924
 
            merger.set_interesting_files(None)
925
 
            merger.show_base = False
926
 
            merger.reprocess = False
927
 
            conflicts = merger.do_merge()
928
 
            merger.set_pending()
929
 
        finally:
930
 
            pb.finished()
 
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()
931
818
        return conflicts
932
819
 
933
 
    @needs_read_lock
934
820
    def merge_modified(self):
935
821
        """Return a dictionary of files modified by a merge.
936
822
 
941
827
        This returns a map of file_id->sha1, containing only files which are
942
828
        still in the working inventory and have that text hash.
943
829
        """
944
 
        try:
945
 
            hashfile = self._transport.get('merge-hashes')
946
 
        except errors.NoSuchFile:
947
 
            return {}
948
 
        try:
949
 
            merge_hashes = {}
950
 
            try:
951
 
                if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
952
 
                    raise errors.MergeModifiedFormatError()
953
 
            except StopIteration:
954
 
                raise errors.MergeModifiedFormatError()
955
 
            for s in RioReader(hashfile):
956
 
                # RioReader reads in Unicode, so convert file_ids back to utf8
957
 
                file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
958
 
                if file_id not in self.inventory:
959
 
                    continue
960
 
                text_hash = s.get("hash")
961
 
                if text_hash == self.get_file_sha1(file_id):
962
 
                    merge_hashes[file_id] = text_hash
963
 
            return merge_hashes
964
 
        finally:
965
 
            hashfile.close()
 
830
        raise NotImplementedError(self.merge_modified)
966
831
 
967
832
    @needs_write_lock
968
833
    def mkdir(self, path, file_id=None):
973
838
        self.add(path, file_id, 'directory')
974
839
        return file_id
975
840
 
976
 
    def get_symlink_target(self, file_id):
977
 
        abspath = self.id2abspath(file_id)
 
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)
978
846
        target = osutils.readlink(abspath)
979
847
        return target
980
848
 
981
 
    @needs_write_lock
982
849
    def subsume(self, other_tree):
983
 
        def add_children(inventory, entry):
984
 
            for child_entry in entry.children.values():
985
 
                inventory._byid[child_entry.file_id] = child_entry
986
 
                if child_entry.kind == 'directory':
987
 
                    add_children(inventory, child_entry)
988
 
        if other_tree.get_root_id() == self.get_root_id():
989
 
            raise errors.BadSubsumeSource(self, other_tree,
990
 
                                          'Trees have the same root')
991
 
        try:
992
 
            other_tree_path = self.relpath(other_tree.basedir)
993
 
        except errors.PathNotChild:
994
 
            raise errors.BadSubsumeSource(self, other_tree,
995
 
                'Tree is not contained by the other')
996
 
        new_root_parent = self.path2id(osutils.dirname(other_tree_path))
997
 
        if new_root_parent is None:
998
 
            raise errors.BadSubsumeSource(self, other_tree,
999
 
                'Parent directory is not versioned.')
1000
 
        # We need to ensure that the result of a fetch will have a
1001
 
        # versionedfile for the other_tree root, and only fetching into
1002
 
        # RepositoryKnit2 guarantees that.
1003
 
        if not self.branch.repository.supports_rich_root():
1004
 
            raise errors.SubsumeTargetNeedsUpgrade(other_tree)
1005
 
        other_tree.lock_tree_write()
1006
 
        try:
1007
 
            new_parents = other_tree.get_parent_ids()
1008
 
            other_root = other_tree.inventory.root
1009
 
            other_root.parent_id = new_root_parent
1010
 
            other_root.name = osutils.basename(other_tree_path)
1011
 
            self.inventory.add(other_root)
1012
 
            add_children(self.inventory, other_root)
1013
 
            self._write_inventory(self.inventory)
1014
 
            # normally we don't want to fetch whole repositories, but i think
1015
 
            # here we really do want to consolidate the whole thing.
1016
 
            for parent_id in other_tree.get_parent_ids():
1017
 
                self.branch.fetch(other_tree.branch, parent_id)
1018
 
                self.add_parent_tree_id(parent_id)
1019
 
        finally:
1020
 
            other_tree.unlock()
1021
 
        other_tree.bzrdir.retire_bzrdir()
 
850
        raise NotImplementedError(self.subsume)
1022
851
 
1023
852
    def _setup_directory_is_tree_reference(self):
1024
853
        if self._branch.repository._format.supports_tree_reference:
1046
875
        # checkout in a subdirectory.  This can be avoided by not adding
1047
876
        # it.  mbp 20070306
1048
877
 
1049
 
    @needs_tree_write_lock
1050
878
    def extract(self, file_id, format=None):
1051
879
        """Extract a subtree from this tree.
1052
880
 
1053
881
        A new branch will be created, relative to the path for this tree.
1054
882
        """
1055
 
        self.flush()
1056
 
        def mkdirs(path):
1057
 
            segments = osutils.splitpath(path)
1058
 
            transport = self.branch.bzrdir.root_transport
1059
 
            for name in segments:
1060
 
                transport = transport.clone(name)
1061
 
                transport.ensure_base()
1062
 
            return transport
1063
 
 
1064
 
        sub_path = self.id2path(file_id)
1065
 
        branch_transport = mkdirs(sub_path)
1066
 
        if format is None:
1067
 
            format = self.bzrdir.cloning_metadir()
1068
 
        branch_transport.ensure_base()
1069
 
        branch_bzrdir = format.initialize_on_transport(branch_transport)
1070
 
        try:
1071
 
            repo = branch_bzrdir.find_repository()
1072
 
        except errors.NoRepositoryPresent:
1073
 
            repo = branch_bzrdir.create_repository()
1074
 
        if not repo.supports_rich_root():
1075
 
            raise errors.RootNotRich()
1076
 
        new_branch = branch_bzrdir.create_branch()
1077
 
        new_branch.pull(self.branch)
1078
 
        for parent_id in self.get_parent_ids():
1079
 
            new_branch.fetch(self.branch, parent_id)
1080
 
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
1081
 
        if tree_transport.base != branch_transport.base:
1082
 
            tree_bzrdir = format.initialize_on_transport(tree_transport)
1083
 
            branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1084
 
        else:
1085
 
            tree_bzrdir = branch_bzrdir
1086
 
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1087
 
        wt.set_parent_ids(self.get_parent_ids())
1088
 
        my_inv = self.inventory
1089
 
        child_inv = inventory.Inventory(root_id=None)
1090
 
        new_root = my_inv[file_id]
1091
 
        my_inv.remove_recursive_id(file_id)
1092
 
        new_root.parent_id = None
1093
 
        child_inv.add(new_root)
1094
 
        self._write_inventory(my_inv)
1095
 
        wt._write_inventory(child_inv)
1096
 
        return wt
1097
 
 
1098
 
    def _serialize(self, inventory, out_file):
1099
 
        xml5.serializer_v5.write_inventory(self._inventory, out_file,
1100
 
            working=True)
1101
 
 
1102
 
    def _deserialize(selt, in_file):
1103
 
        return xml5.serializer_v5.read_inventory(in_file)
 
883
        raise NotImplementedError(self.extract)
1104
884
 
1105
885
    def flush(self):
1106
 
        """Write the in memory inventory to disk."""
1107
 
        # TODO: Maybe this should only write on dirty ?
1108
 
        if self._control_files._lock_mode != 'w':
1109
 
            raise errors.NotWriteLocked(self)
1110
 
        sio = StringIO()
1111
 
        self._serialize(self._inventory, sio)
1112
 
        sio.seek(0)
1113
 
        self._transport.put_file('inventory', sio,
1114
 
            mode=self.bzrdir._get_file_mode())
1115
 
        self._inventory_is_modified = False
 
886
        """Write the in memory meta data to disk."""
 
887
        raise NotImplementedError(self.flush)
1116
888
 
1117
889
    def _kind(self, relpath):
1118
890
        return osutils.file_kind(self.abspath(relpath))
1124
896
        This does not include files that have been deleted in this
1125
897
        tree. Skips the control directory.
1126
898
 
1127
 
        :param include_root: if True, do not return an entry for the root
 
899
        :param include_root: if True, return an entry for the root
1128
900
        :param from_dir: start from this directory or None for the root
1129
901
        :param recursive: whether to recurse into subdirectories or not
1130
902
        """
1131
 
        # list_files is an iterator, so @needs_read_lock doesn't work properly
1132
 
        # with it. So callers should be careful to always read_lock the tree.
1133
 
        if not self.is_locked():
1134
 
            raise errors.ObjectNotLocked(self)
1135
 
 
1136
 
        inv = self.inventory
1137
 
        if from_dir is None and include_root is True:
1138
 
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1139
 
        # Convert these into local objects to save lookup times
1140
 
        pathjoin = osutils.pathjoin
1141
 
        file_kind = self._kind
1142
 
 
1143
 
        # transport.base ends in a slash, we want the piece
1144
 
        # between the last two slashes
1145
 
        transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1146
 
 
1147
 
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1148
 
 
1149
 
        # directory file_id, relative path, absolute path, reverse sorted children
1150
 
        if from_dir is not None:
1151
 
            from_dir_id = inv.path2id(from_dir)
1152
 
            if from_dir_id is None:
1153
 
                # Directory not versioned
1154
 
                return
1155
 
            from_dir_abspath = pathjoin(self.basedir, from_dir)
1156
 
        else:
1157
 
            from_dir_id = inv.root.file_id
1158
 
            from_dir_abspath = self.basedir
1159
 
        children = os.listdir(from_dir_abspath)
1160
 
        children.sort()
1161
 
        # jam 20060527 The kernel sized tree seems equivalent whether we
1162
 
        # use a deque and popleft to keep them sorted, or if we use a plain
1163
 
        # list and just reverse() them.
1164
 
        children = collections.deque(children)
1165
 
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
1166
 
        while stack:
1167
 
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1168
 
 
1169
 
            while children:
1170
 
                f = children.popleft()
1171
 
                ## TODO: If we find a subdirectory with its own .bzr
1172
 
                ## directory, then that is a separate tree and we
1173
 
                ## should exclude it.
1174
 
 
1175
 
                # the bzrdir for this tree
1176
 
                if transport_base_dir == f:
1177
 
                    continue
1178
 
 
1179
 
                # we know that from_dir_relpath and from_dir_abspath never end in a slash
1180
 
                # and 'f' doesn't begin with one, we can do a string op, rather
1181
 
                # than the checks of pathjoin(), all relative paths will have an extra slash
1182
 
                # at the beginning
1183
 
                fp = from_dir_relpath + '/' + f
1184
 
 
1185
 
                # absolute path
1186
 
                fap = from_dir_abspath + '/' + f
1187
 
 
1188
 
                f_ie = inv.get_child(from_dir_id, f)
1189
 
                if f_ie:
1190
 
                    c = 'V'
1191
 
                elif self.is_ignored(fp[1:]):
1192
 
                    c = 'I'
1193
 
                else:
1194
 
                    # we may not have found this file, because of a unicode issue
1195
 
                    f_norm, can_access = osutils.normalized_filename(f)
1196
 
                    if f == f_norm or not can_access:
1197
 
                        # No change, so treat this file normally
1198
 
                        c = '?'
1199
 
                    else:
1200
 
                        # this file can be accessed by a normalized path
1201
 
                        # check again if it is versioned
1202
 
                        # these lines are repeated here for performance
1203
 
                        f = f_norm
1204
 
                        fp = from_dir_relpath + '/' + f
1205
 
                        fap = from_dir_abspath + '/' + f
1206
 
                        f_ie = inv.get_child(from_dir_id, f)
1207
 
                        if f_ie:
1208
 
                            c = 'V'
1209
 
                        elif self.is_ignored(fp[1:]):
1210
 
                            c = 'I'
1211
 
                        else:
1212
 
                            c = '?'
1213
 
 
1214
 
                fk = file_kind(fap)
1215
 
 
1216
 
                # make a last minute entry
1217
 
                if f_ie:
1218
 
                    yield fp[1:], c, fk, f_ie.file_id, f_ie
1219
 
                else:
1220
 
                    try:
1221
 
                        yield fp[1:], c, fk, None, fk_entries[fk]()
1222
 
                    except KeyError:
1223
 
                        yield fp[1:], c, fk, None, TreeEntry()
1224
 
                    continue
1225
 
 
1226
 
                if fk != 'directory':
1227
 
                    continue
1228
 
 
1229
 
                # But do this child first if recursing down
1230
 
                if recursive:
1231
 
                    new_children = os.listdir(fap)
1232
 
                    new_children.sort()
1233
 
                    new_children = collections.deque(new_children)
1234
 
                    stack.append((f_ie.file_id, fp, fap, new_children))
1235
 
                    # Break out of inner loop,
1236
 
                    # so that we start outer loop with child
1237
 
                    break
1238
 
            else:
1239
 
                # if we finished all children, pop it off the stack
1240
 
                stack.pop()
1241
 
 
1242
 
    @needs_tree_write_lock
1243
 
    def move(self, from_paths, to_dir=None, after=False, **kwargs):
 
903
        raise NotImplementedError(self.list_files)
 
904
 
 
905
    def move(self, from_paths, to_dir=None, after=False):
1244
906
        """Rename files.
1245
907
 
1246
 
        to_dir must exist in the inventory.
 
908
        to_dir must be known to the working tree.
1247
909
 
1248
910
        If to_dir exists and is a directory, the files are moved into
1249
911
        it, keeping their old names.
1255
917
        independently.
1256
918
 
1257
919
        The first mode moves the file in the filesystem and updates the
1258
 
        inventory. The second mode only updates the inventory without
1259
 
        touching the file on the filesystem. This is the new mode introduced
1260
 
        in version 0.15.
 
920
        working tree metadata. The second mode only updates the working tree
 
921
        metadata without touching the file on the filesystem.
1261
922
 
1262
923
        move uses the second mode if 'after == True' and the target is not
1263
924
        versioned but present in the working tree.
1275
936
        This returns a list of (from_path, to_path) pairs for each
1276
937
        entry that is moved.
1277
938
        """
1278
 
        rename_entries = []
1279
 
        rename_tuples = []
1280
 
 
1281
 
        # check for deprecated use of signature
1282
 
        if to_dir is None:
1283
 
            to_dir = kwargs.get('to_name', None)
1284
 
            if to_dir is None:
1285
 
                raise TypeError('You must supply a target directory')
1286
 
            else:
1287
 
                symbol_versioning.warn('The parameter to_name was deprecated'
1288
 
                                       ' in version 0.13. Use to_dir instead',
1289
 
                                       DeprecationWarning)
1290
 
 
1291
 
        # check destination directory
1292
 
        if isinstance(from_paths, basestring):
1293
 
            raise ValueError()
1294
 
        inv = self.inventory
1295
 
        to_abs = self.abspath(to_dir)
1296
 
        if not isdir(to_abs):
1297
 
            raise errors.BzrMoveFailedError('',to_dir,
1298
 
                errors.NotADirectory(to_abs))
1299
 
        if not self.has_filename(to_dir):
1300
 
            raise errors.BzrMoveFailedError('',to_dir,
1301
 
                errors.NotInWorkingDirectory(to_dir))
1302
 
        to_dir_id = inv.path2id(to_dir)
1303
 
        if to_dir_id is None:
1304
 
            raise errors.BzrMoveFailedError('',to_dir,
1305
 
                errors.NotVersionedError(path=str(to_dir)))
1306
 
 
1307
 
        to_dir_ie = inv[to_dir_id]
1308
 
        if to_dir_ie.kind != 'directory':
1309
 
            raise errors.BzrMoveFailedError('',to_dir,
1310
 
                errors.NotADirectory(to_abs))
1311
 
 
1312
 
        # create rename entries and tuples
1313
 
        for from_rel in from_paths:
1314
 
            from_tail = splitpath(from_rel)[-1]
1315
 
            from_id = inv.path2id(from_rel)
1316
 
            if from_id is None:
1317
 
                raise errors.BzrMoveFailedError(from_rel,to_dir,
1318
 
                    errors.NotVersionedError(path=str(from_rel)))
1319
 
 
1320
 
            from_entry = inv[from_id]
1321
 
            from_parent_id = from_entry.parent_id
1322
 
            to_rel = pathjoin(to_dir, from_tail)
1323
 
            rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1324
 
                                         from_id=from_id,
1325
 
                                         from_tail=from_tail,
1326
 
                                         from_parent_id=from_parent_id,
1327
 
                                         to_rel=to_rel, to_tail=from_tail,
1328
 
                                         to_parent_id=to_dir_id)
1329
 
            rename_entries.append(rename_entry)
1330
 
            rename_tuples.append((from_rel, to_rel))
1331
 
 
1332
 
        # determine which move mode to use. checks also for movability
1333
 
        rename_entries = self._determine_mv_mode(rename_entries, after)
1334
 
 
1335
 
        original_modified = self._inventory_is_modified
1336
 
        try:
1337
 
            if len(from_paths):
1338
 
                self._inventory_is_modified = True
1339
 
            self._move(rename_entries)
1340
 
        except:
1341
 
            # restore the inventory on error
1342
 
            self._inventory_is_modified = original_modified
1343
 
            raise
1344
 
        self._write_inventory(inv)
1345
 
        return rename_tuples
1346
 
 
1347
 
    def _determine_mv_mode(self, rename_entries, after=False):
1348
 
        """Determines for each from-to pair if both inventory and working tree
1349
 
        or only the inventory has to be changed.
1350
 
 
1351
 
        Also does basic plausability tests.
1352
 
        """
1353
 
        inv = self.inventory
1354
 
 
1355
 
        for rename_entry in rename_entries:
1356
 
            # store to local variables for easier reference
1357
 
            from_rel = rename_entry.from_rel
1358
 
            from_id = rename_entry.from_id
1359
 
            to_rel = rename_entry.to_rel
1360
 
            to_id = inv.path2id(to_rel)
1361
 
            only_change_inv = False
1362
 
 
1363
 
            # check the inventory for source and destination
1364
 
            if from_id is None:
1365
 
                raise errors.BzrMoveFailedError(from_rel,to_rel,
1366
 
                    errors.NotVersionedError(path=str(from_rel)))
1367
 
            if to_id is not None:
1368
 
                raise errors.BzrMoveFailedError(from_rel,to_rel,
1369
 
                    errors.AlreadyVersionedError(path=str(to_rel)))
1370
 
 
1371
 
            # try to determine the mode for rename (only change inv or change
1372
 
            # inv and file system)
1373
 
            if after:
1374
 
                if not self.has_filename(to_rel):
1375
 
                    raise errors.BzrMoveFailedError(from_id,to_rel,
1376
 
                        errors.NoSuchFile(path=str(to_rel),
1377
 
                        extra="New file has not been created yet"))
1378
 
                only_change_inv = True
1379
 
            elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1380
 
                only_change_inv = True
1381
 
            elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1382
 
                only_change_inv = False
1383
 
            elif (not self.case_sensitive
1384
 
                  and from_rel.lower() == to_rel.lower()
1385
 
                  and self.has_filename(from_rel)):
1386
 
                only_change_inv = False
1387
 
            else:
1388
 
                # something is wrong, so lets determine what exactly
1389
 
                if not self.has_filename(from_rel) and \
1390
 
                   not self.has_filename(to_rel):
1391
 
                    raise errors.BzrRenameFailedError(from_rel,to_rel,
1392
 
                        errors.PathsDoNotExist(paths=(str(from_rel),
1393
 
                        str(to_rel))))
1394
 
                else:
1395
 
                    raise errors.RenameFailedFilesExist(from_rel, to_rel)
1396
 
            rename_entry.only_change_inv = only_change_inv
1397
 
        return rename_entries
1398
 
 
1399
 
    def _move(self, rename_entries):
1400
 
        """Moves a list of files.
1401
 
 
1402
 
        Depending on the value of the flag 'only_change_inv', the
1403
 
        file will be moved on the file system or not.
1404
 
        """
1405
 
        inv = self.inventory
1406
 
        moved = []
1407
 
 
1408
 
        for entry in rename_entries:
1409
 
            try:
1410
 
                self._move_entry(entry)
1411
 
            except:
1412
 
                self._rollback_move(moved)
1413
 
                raise
1414
 
            moved.append(entry)
1415
 
 
1416
 
    def _rollback_move(self, moved):
1417
 
        """Try to rollback a previous move in case of an filesystem error."""
1418
 
        inv = self.inventory
1419
 
        for entry in moved:
1420
 
            try:
1421
 
                self._move_entry(WorkingTree._RenameEntry(
1422
 
                    entry.to_rel, entry.from_id,
1423
 
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
1424
 
                    entry.from_tail, entry.from_parent_id,
1425
 
                    entry.only_change_inv))
1426
 
            except errors.BzrMoveFailedError, e:
1427
 
                raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1428
 
                        " The working tree is in an inconsistent state."
1429
 
                        " Please consider doing a 'bzr revert'."
1430
 
                        " Error message is: %s" % e)
1431
 
 
1432
 
    def _move_entry(self, entry):
1433
 
        inv = self.inventory
1434
 
        from_rel_abs = self.abspath(entry.from_rel)
1435
 
        to_rel_abs = self.abspath(entry.to_rel)
1436
 
        if from_rel_abs == to_rel_abs:
1437
 
            raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1438
 
                "Source and target are identical.")
1439
 
 
1440
 
        if not entry.only_change_inv:
1441
 
            try:
1442
 
                osutils.rename(from_rel_abs, to_rel_abs)
1443
 
            except OSError, e:
1444
 
                raise errors.BzrMoveFailedError(entry.from_rel,
1445
 
                    entry.to_rel, e[1])
1446
 
        inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
 
939
        raise NotImplementedError(self.move)
1447
940
 
1448
941
    @needs_tree_write_lock
1449
942
    def rename_one(self, from_rel, to_rel, after=False):
1453
946
 
1454
947
        rename_one has several 'modes' to work. First, it can rename a physical
1455
948
        file and change the file_id. That is the normal mode. Second, it can
1456
 
        only change the file_id without touching any physical file. This is
1457
 
        the new mode introduced in version 0.15.
 
949
        only change the file_id without touching any physical file.
1458
950
 
1459
 
        rename_one uses the second mode if 'after == True' and 'to_rel' is not
1460
 
        versioned but present in the working tree.
 
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.
1461
953
 
1462
954
        rename_one uses the second mode if 'after == False' and 'from_rel' is
1463
955
        versioned but no longer in the working tree, and 'to_rel' is not
1469
961
 
1470
962
        Everything else results in an error.
1471
963
        """
1472
 
        inv = self.inventory
1473
 
        rename_entries = []
1474
 
 
1475
 
        # create rename entries and tuples
1476
 
        from_tail = splitpath(from_rel)[-1]
1477
 
        from_id = inv.path2id(from_rel)
1478
 
        if from_id is None:
1479
 
            # if file is missing in the inventory maybe it's in the basis_tree
1480
 
            basis_tree = self.branch.basis_tree()
1481
 
            from_id = basis_tree.path2id(from_rel)
1482
 
            if from_id is None:
1483
 
                raise errors.BzrRenameFailedError(from_rel,to_rel,
1484
 
                    errors.NotVersionedError(path=str(from_rel)))
1485
 
            # put entry back in the inventory so we can rename it
1486
 
            from_entry = basis_tree.inventory[from_id].copy()
1487
 
            inv.add(from_entry)
1488
 
        else:
1489
 
            from_entry = inv[from_id]
1490
 
        from_parent_id = from_entry.parent_id
1491
 
        to_dir, to_tail = os.path.split(to_rel)
1492
 
        to_dir_id = inv.path2id(to_dir)
1493
 
        rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1494
 
                                     from_id=from_id,
1495
 
                                     from_tail=from_tail,
1496
 
                                     from_parent_id=from_parent_id,
1497
 
                                     to_rel=to_rel, to_tail=to_tail,
1498
 
                                     to_parent_id=to_dir_id)
1499
 
        rename_entries.append(rename_entry)
1500
 
 
1501
 
        # determine which move mode to use. checks also for movability
1502
 
        rename_entries = self._determine_mv_mode(rename_entries, after)
1503
 
 
1504
 
        # check if the target changed directory and if the target directory is
1505
 
        # versioned
1506
 
        if to_dir_id is None:
1507
 
            raise errors.BzrMoveFailedError(from_rel,to_rel,
1508
 
                errors.NotVersionedError(path=str(to_dir)))
1509
 
 
1510
 
        # all checks done. now we can continue with our actual work
1511
 
        mutter('rename_one:\n'
1512
 
               '  from_id   {%s}\n'
1513
 
               '  from_rel: %r\n'
1514
 
               '  to_rel:   %r\n'
1515
 
               '  to_dir    %r\n'
1516
 
               '  to_dir_id {%s}\n',
1517
 
               from_id, from_rel, to_rel, to_dir, to_dir_id)
1518
 
 
1519
 
        self._move(rename_entries)
1520
 
        self._write_inventory(inv)
1521
 
 
1522
 
    class _RenameEntry(object):
1523
 
        def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1524
 
                     to_rel, to_tail, to_parent_id, only_change_inv=False):
1525
 
            self.from_rel = from_rel
1526
 
            self.from_id = from_id
1527
 
            self.from_tail = from_tail
1528
 
            self.from_parent_id = from_parent_id
1529
 
            self.to_rel = to_rel
1530
 
            self.to_tail = to_tail
1531
 
            self.to_parent_id = to_parent_id
1532
 
            self.only_change_inv = only_change_inv
 
964
        raise NotImplementedError(self.rename_one)
1533
965
 
1534
966
    @needs_read_lock
1535
967
    def unknowns(self):
1543
975
        return iter(
1544
976
            [subp for subp in self.extras() if not self.is_ignored(subp)])
1545
977
 
1546
 
    @needs_tree_write_lock
1547
978
    def unversion(self, file_ids):
1548
979
        """Remove the file ids in file_ids from the current versioned set.
1549
980
 
1553
984
        :param file_ids: The file ids to stop versioning.
1554
985
        :raises: NoSuchId if any fileid is not currently versioned.
1555
986
        """
1556
 
        for file_id in file_ids:
1557
 
            if file_id not in self._inventory:
1558
 
                raise errors.NoSuchId(self, file_id)
1559
 
        for file_id in file_ids:
1560
 
            if self._inventory.has_id(file_id):
1561
 
                self._inventory.remove_recursive_id(file_id)
1562
 
        if len(file_ids):
1563
 
            # in the future this should just set a dirty bit to wait for the
1564
 
            # final unlock. However, until all methods of workingtree start
1565
 
            # with the current in -memory inventory rather than triggering
1566
 
            # a read, it is more complex - we need to teach read_inventory
1567
 
            # to know when to read, and when to not read first... and possibly
1568
 
            # to save first when the in memory one may be corrupted.
1569
 
            # so for now, we just only write it if it is indeed dirty.
1570
 
            # - RBC 20060907
1571
 
            self._write_inventory(self._inventory)
1572
 
 
1573
 
    def _iter_conflicts(self):
1574
 
        conflicted = set()
1575
 
        for info in self.list_files():
1576
 
            path = info[0]
1577
 
            stem = get_conflicted_stem(path)
1578
 
            if stem is None:
1579
 
                continue
1580
 
            if stem not in conflicted:
1581
 
                conflicted.add(stem)
1582
 
                yield stem
 
987
        raise NotImplementedError(self.unversion)
1583
988
 
1584
989
    @needs_write_lock
1585
990
    def pull(self, source, overwrite=False, stop_revision=None,
1586
 
             change_reporter=None, possible_transports=None, local=False):
1587
 
        top_pb = ui.ui_factory.nested_progress_bar()
 
991
             change_reporter=None, possible_transports=None, local=False,
 
992
             show_base=False):
1588
993
        source.lock_read()
1589
994
        try:
1590
 
            pp = ProgressPhase("Pull phase", 2, top_pb)
1591
 
            pp.next_phase()
1592
995
            old_revision_info = self.branch.last_revision_info()
1593
996
            basis_tree = self.basis_tree()
1594
997
            count = self.branch.pull(source, overwrite, stop_revision,
1596
999
                                     local=local)
1597
1000
            new_revision_info = self.branch.last_revision_info()
1598
1001
            if new_revision_info != old_revision_info:
1599
 
                pp.next_phase()
1600
1002
                repository = self.branch.repository
1601
 
                pb = ui.ui_factory.nested_progress_bar()
 
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)
1602
1008
                basis_tree.lock_read()
1603
1009
                try:
1604
1010
                    new_basis_tree = self.branch.basis_tree()
1607
1013
                                new_basis_tree,
1608
1014
                                basis_tree,
1609
1015
                                this_tree=self,
1610
 
                                pb=pb,
1611
 
                                change_reporter=change_reporter)
1612
 
                    if (basis_tree.inventory.root is None and
1613
 
                        new_basis_tree.inventory.root is not None):
1614
 
                        self.set_root_id(new_basis_tree.get_root_id())
 
1016
                                pb=None,
 
1017
                                change_reporter=change_reporter,
 
1018
                                show_base=show_base)
 
1019
                    basis_root_id = basis_tree.get_root_id()
 
1020
                    new_root_id = new_basis_tree.get_root_id()
 
1021
                    if new_root_id is not None and basis_root_id != new_root_id:
 
1022
                        self.set_root_id(new_root_id)
1615
1023
                finally:
1616
 
                    pb.finished()
1617
1024
                    basis_tree.unlock()
1618
1025
                # TODO - dedup parents list with things merged by pull ?
1619
1026
                # reuse the revisiontree we merged against to set the new
1620
1027
                # tree data.
1621
 
                parent_trees = [(self.branch.last_revision(), new_basis_tree)]
 
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))
1622
1032
                # we have to pull the merge trees out again, because
1623
1033
                # merge_inner has set the ids. - this corner is not yet
1624
1034
                # layered well enough to prevent double handling.
1632
1042
            return count
1633
1043
        finally:
1634
1044
            source.unlock()
1635
 
            top_pb.finished()
1636
1045
 
1637
1046
    @needs_write_lock
1638
1047
    def put_file_bytes_non_atomic(self, file_id, bytes):
1642
1051
            stream.write(bytes)
1643
1052
        finally:
1644
1053
            stream.close()
1645
 
        # TODO: update the hashcache here ?
1646
1054
 
1647
1055
    def extras(self):
1648
1056
        """Yield all unversioned files in this WorkingTree.
1654
1062
        Currently returned depth-first, sorted by name within directories.
1655
1063
        This is the same order used by 'osutils.walkdirs'.
1656
1064
        """
1657
 
        ## TODO: Work from given directory downwards
1658
 
        for path, dir_entry in self.inventory.directories():
1659
 
            # mutter("search for unknowns in %r", path)
1660
 
            dirabs = self.abspath(path)
1661
 
            if not isdir(dirabs):
1662
 
                # e.g. directory deleted
1663
 
                continue
1664
 
 
1665
 
            fl = []
1666
 
            for subf in os.listdir(dirabs):
1667
 
                if self.bzrdir.is_control_filename(subf):
1668
 
                    continue
1669
 
                if subf not in dir_entry.children:
1670
 
                    try:
1671
 
                        (subf_norm,
1672
 
                         can_access) = osutils.normalized_filename(subf)
1673
 
                    except UnicodeDecodeError:
1674
 
                        path_os_enc = path.encode(osutils._fs_enc)
1675
 
                        relpath = path_os_enc + '/' + subf
1676
 
                        raise errors.BadFilenameEncoding(relpath,
1677
 
                                                         osutils._fs_enc)
1678
 
                    if subf_norm != subf and can_access:
1679
 
                        if subf_norm not in dir_entry.children:
1680
 
                            fl.append(subf_norm)
1681
 
                    else:
1682
 
                        fl.append(subf)
1683
 
 
1684
 
            fl.sort()
1685
 
            for subf in fl:
1686
 
                subp = pathjoin(path, subf)
1687
 
                yield subp
 
1065
        raise NotImplementedError(self.extras)
1688
1066
 
1689
1067
    def ignored_files(self):
1690
1068
        """Yield list of PATH, IGNORE_PATTERN"""
1723
1101
        r"""Check whether the filename matches an ignore pattern.
1724
1102
 
1725
1103
        Patterns containing '/' or '\' need to match the whole path;
1726
 
        others match against only the last component.
 
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.
1727
1107
 
1728
1108
        If the file is ignored, returns the pattern which caused it to
1729
1109
        be ignored, otherwise None.  So this can simply be used as a
1730
1110
        boolean if desired."""
1731
1111
        if getattr(self, '_ignoreglobster', None) is None:
1732
 
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
 
1112
            self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
1733
1113
        return self._ignoreglobster.match(filename)
1734
1114
 
1735
1115
    def kind(self, file_id):
1737
1117
 
1738
1118
    def stored_kind(self, file_id):
1739
1119
        """See Tree.stored_kind"""
1740
 
        return self.inventory[file_id].kind
 
1120
        raise NotImplementedError(self.stored_kind)
1741
1121
 
1742
1122
    def _comparison_data(self, entry, path):
1743
1123
        abspath = self.abspath(path)
1753
1133
        else:
1754
1134
            mode = stat_value.st_mode
1755
1135
            kind = osutils.file_kind_from_stat_mode(mode)
1756
 
            if not supports_executable():
 
1136
            if not self._supports_executable():
1757
1137
                executable = entry is not None and entry.executable
1758
1138
            else:
1759
1139
                executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1778
1158
        return _mod_revision.ensure_null(self.branch.last_revision())
1779
1159
 
1780
1160
    def is_locked(self):
1781
 
        return self._control_files.is_locked()
1782
 
 
1783
 
    def _must_be_locked(self):
1784
 
        if not self.is_locked():
1785
 
            raise errors.ObjectNotLocked(self)
 
1161
        """Check if this tree is locked."""
 
1162
        raise NotImplementedError(self.is_locked)
1786
1163
 
1787
1164
    def lock_read(self):
1788
 
        """See Branch.lock_read, and WorkingTree.unlock."""
1789
 
        if not self.is_locked():
1790
 
            self._reset_data()
1791
 
        self.branch.lock_read()
1792
 
        try:
1793
 
            return self._control_files.lock_read()
1794
 
        except:
1795
 
            self.branch.unlock()
1796
 
            raise
 
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)
1797
1172
 
1798
1173
    def lock_tree_write(self):
1799
 
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1800
 
        if not self.is_locked():
1801
 
            self._reset_data()
1802
 
        self.branch.lock_read()
1803
 
        try:
1804
 
            return self._control_files.lock_write()
1805
 
        except:
1806
 
            self.branch.unlock()
1807
 
            raise
 
1174
        """See MutableTree.lock_tree_write, and WorkingTree.unlock.
 
1175
 
 
1176
        :return: A bzrlib.lock.LogicalLockResult.
 
1177
        """
 
1178
        raise NotImplementedError(self.lock_tree_write)
1808
1179
 
1809
1180
    def lock_write(self):
1810
 
        """See MutableTree.lock_write, and WorkingTree.unlock."""
1811
 
        if not self.is_locked():
1812
 
            self._reset_data()
1813
 
        self.branch.lock_write()
1814
 
        try:
1815
 
            return self._control_files.lock_write()
1816
 
        except:
1817
 
            self.branch.unlock()
1818
 
            raise
 
1181
        """See MutableTree.lock_write, and WorkingTree.unlock.
 
1182
 
 
1183
        :return: A bzrlib.lock.LogicalLockResult.
 
1184
        """
 
1185
        raise NotImplementedError(self.lock_write)
1819
1186
 
1820
1187
    def get_physical_lock_status(self):
1821
 
        return self._control_files.get_physical_lock_status()
1822
 
 
1823
 
    def _basis_inventory_name(self):
1824
 
        return 'basis-inventory-cache'
1825
 
 
1826
 
    def _reset_data(self):
1827
 
        """Reset transient data that cannot be revalidated."""
1828
 
        self._inventory_is_modified = False
1829
 
        result = self._deserialize(self._transport.get('inventory'))
1830
 
        self._set_inventory(result, dirty=False)
1831
 
 
1832
 
    @needs_tree_write_lock
 
1188
        raise NotImplementedError(self.get_physical_lock_status)
 
1189
 
1833
1190
    def set_last_revision(self, new_revision):
1834
1191
        """Change the last revision in the working tree."""
1835
 
        if self._change_last_revision(new_revision):
1836
 
            self._cache_basis_inventory(new_revision)
 
1192
        raise NotImplementedError(self.set_last_revision)
1837
1193
 
1838
1194
    def _change_last_revision(self, new_revision):
1839
1195
        """Template method part of set_last_revision to perform the change.
1842
1198
        when their last revision is set.
1843
1199
        """
1844
1200
        if _mod_revision.is_null(new_revision):
1845
 
            self.branch.set_revision_history([])
 
1201
            self.branch.set_last_revision_info(0, new_revision)
1846
1202
            return False
 
1203
        _mod_revision.check_not_reserved_id(new_revision)
1847
1204
        try:
1848
1205
            self.branch.generate_revision_history(new_revision)
1849
1206
        except errors.NoSuchRevision:
1850
1207
            # not present in the repo - dont try to set it deeper than the tip
1851
 
            self.branch.set_revision_history([new_revision])
 
1208
            self.branch._set_revision_history([new_revision])
1852
1209
        return True
1853
1210
 
1854
 
    def _write_basis_inventory(self, xml):
1855
 
        """Write the basis inventory XML to the basis-inventory file"""
1856
 
        path = self._basis_inventory_name()
1857
 
        sio = StringIO(xml)
1858
 
        self._transport.put_file(path, sio,
1859
 
            mode=self.bzrdir._get_file_mode())
1860
 
 
1861
 
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
1862
 
        """Create the text that will be saved in basis-inventory"""
1863
 
        inventory.revision_id = revision_id
1864
 
        return xml7.serializer_v7.write_inventory_to_string(inventory)
1865
 
 
1866
 
    def _cache_basis_inventory(self, new_revision):
1867
 
        """Cache new_revision as the basis inventory."""
1868
 
        # TODO: this should allow the ready-to-use inventory to be passed in,
1869
 
        # as commit already has that ready-to-use [while the format is the
1870
 
        # same, that is].
1871
 
        try:
1872
 
            # this double handles the inventory - unpack and repack -
1873
 
            # but is easier to understand. We can/should put a conditional
1874
 
            # in here based on whether the inventory is in the latest format
1875
 
            # - perhaps we should repack all inventories on a repository
1876
 
            # upgrade ?
1877
 
            # the fast path is to copy the raw xml from the repository. If the
1878
 
            # xml contains 'revision_id="', then we assume the right
1879
 
            # revision_id is set. We must check for this full string, because a
1880
 
            # root node id can legitimately look like 'revision_id' but cannot
1881
 
            # contain a '"'.
1882
 
            xml = self.branch.repository.get_inventory_xml(new_revision)
1883
 
            firstline = xml.split('\n', 1)[0]
1884
 
            if (not 'revision_id="' in firstline or
1885
 
                'format="7"' not in firstline):
1886
 
                inv = self.branch.repository.deserialise_inventory(
1887
 
                    new_revision, xml)
1888
 
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
1889
 
            self._write_basis_inventory(xml)
1890
 
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1891
 
            pass
1892
 
 
1893
 
    def read_basis_inventory(self):
1894
 
        """Read the cached basis inventory."""
1895
 
        path = self._basis_inventory_name()
1896
 
        return self._transport.get_bytes(path)
1897
 
 
1898
 
    @needs_read_lock
1899
 
    def read_working_inventory(self):
1900
 
        """Read the working inventory.
1901
 
 
1902
 
        :raises errors.InventoryModified: read_working_inventory will fail
1903
 
            when the current in memory inventory has been modified.
1904
 
        """
1905
 
        # conceptually this should be an implementation detail of the tree.
1906
 
        # XXX: Deprecate this.
1907
 
        # ElementTree does its own conversion from UTF-8, so open in
1908
 
        # binary.
1909
 
        if self._inventory_is_modified:
1910
 
            raise errors.InventoryModified(self)
1911
 
        result = self._deserialize(self._transport.get('inventory'))
1912
 
        self._set_inventory(result, dirty=False)
1913
 
        return result
1914
 
 
1915
1211
    @needs_tree_write_lock
1916
1212
    def remove(self, files, verbose=False, to_file=None, keep_files=True,
1917
1213
        force=False):
1918
 
        """Remove nominated files from the working inventory.
 
1214
        """Remove nominated files from the working tree metadata.
1919
1215
 
1920
1216
        :files: File paths relative to the basedir.
1921
1217
        :keep_files: If true, the files will also be kept.
1927
1223
 
1928
1224
        inv_delta = []
1929
1225
 
1930
 
        new_files=set()
 
1226
        all_files = set() # specified and nested files 
1931
1227
        unknown_nested_files=set()
 
1228
        if to_file is None:
 
1229
            to_file = sys.stdout
 
1230
 
 
1231
        files_to_backup = []
1932
1232
 
1933
1233
        def recurse_directory_to_add_files(directory):
1934
1234
            # Recurse directory and add all files
1935
1235
            # so we can check if they have changed.
1936
 
            for parent_info, file_infos in\
1937
 
                self.walkdirs(directory):
 
1236
            for parent_info, file_infos in self.walkdirs(directory):
1938
1237
                for relpath, basename, kind, lstat, fileid, kind in file_infos:
1939
1238
                    # Is it versioned or ignored?
1940
 
                    if self.path2id(relpath) or self.is_ignored(relpath):
 
1239
                    if self.path2id(relpath):
1941
1240
                        # Add nested content for deletion.
1942
 
                        new_files.add(relpath)
 
1241
                        all_files.add(relpath)
1943
1242
                    else:
1944
 
                        # Files which are not versioned and not ignored
 
1243
                        # Files which are not versioned
1945
1244
                        # should be treated as unknown.
1946
 
                        unknown_nested_files.add((relpath, None, kind))
 
1245
                        files_to_backup.append(relpath)
1947
1246
 
1948
1247
        for filename in files:
1949
1248
            # Get file name into canonical form.
1950
1249
            abspath = self.abspath(filename)
1951
1250
            filename = self.relpath(abspath)
1952
1251
            if len(filename) > 0:
1953
 
                new_files.add(filename)
 
1252
                all_files.add(filename)
1954
1253
                recurse_directory_to_add_files(filename)
1955
1254
 
1956
 
        files = list(new_files)
 
1255
        files = list(all_files)
1957
1256
 
1958
1257
        if len(files) == 0:
1959
1258
            return # nothing to do
1963
1262
 
1964
1263
        # Bail out if we are going to delete files we shouldn't
1965
1264
        if not keep_files and not force:
1966
 
            has_changed_files = len(unknown_nested_files) > 0
1967
 
            if not has_changed_files:
1968
 
                for (file_id, path, content_change, versioned, parent_id, name,
1969
 
                     kind, executable) in self.iter_changes(self.basis_tree(),
1970
 
                         include_unchanged=True, require_versioned=False,
1971
 
                         want_unversioned=True, specific_files=files):
1972
 
                    if versioned == (False, False):
1973
 
                        # The record is unknown ...
1974
 
                        if not self.is_ignored(path[1]):
1975
 
                            # ... but not ignored
1976
 
                            has_changed_files = True
1977
 
                            break
1978
 
                    elif content_change and (kind[1] is not None):
1979
 
                        # Versioned and changed, but not deleted
1980
 
                        has_changed_files = True
1981
 
                        break
 
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
1277
 
1983
 
            if has_changed_files:
1984
 
                # Make delta show ALL applicable changes in error message.
1985
 
                tree_delta = self.changes_from(self.basis_tree(),
1986
 
                    require_versioned=False, want_unversioned=True,
1987
 
                    specific_files=files)
1988
 
                for unknown_file in unknown_nested_files:
1989
 
                    if unknown_file not in tree_delta.unversioned:
1990
 
                        tree_delta.unversioned.extend((unknown_file,))
1991
 
                raise errors.BzrRemoveChangedFilesError(tree_delta)
 
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)
1992
1283
 
1993
1284
        # Build inv_delta and delete files where applicable,
1994
 
        # do this before any modifications to inventory.
 
1285
        # do this before any modifications to meta data.
1995
1286
        for f in files:
1996
1287
            fid = self.path2id(f)
1997
1288
            message = None
2004
1295
                        new_status = 'I'
2005
1296
                    else:
2006
1297
                        new_status = '?'
2007
 
                    textui.show_status(new_status, self.kind(fid), f,
2008
 
                                       to_file=to_file)
 
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')
2009
1301
                # Unversion file
2010
1302
                inv_delta.append((f, None, fid, None))
2011
1303
                message = "removed %s" % (f,)
2017
1309
                        len(os.listdir(abs_path)) > 0):
2018
1310
                        if force:
2019
1311
                            osutils.rmtree(abs_path)
 
1312
                            message = "deleted %s" % (f,)
2020
1313
                        else:
2021
 
                            message = "%s is not an empty directory "\
2022
 
                                "and won't be deleted." % (f,)
 
1314
                            message = backup(f)
2023
1315
                    else:
2024
 
                        osutils.delete_any(abs_path)
2025
 
                        message = "deleted %s" % (f,)
 
1316
                        if f in files_to_backup:
 
1317
                            message = backup(f)
 
1318
                        else:
 
1319
                            osutils.delete_any(abs_path)
 
1320
                            message = "deleted %s" % (f,)
2026
1321
                elif message is not None:
2027
1322
                    # Only care if we haven't done anything yet.
2028
1323
                    message = "%s does not exist." % (f,)
2034
1329
 
2035
1330
    @needs_tree_write_lock
2036
1331
    def revert(self, filenames=None, old_tree=None, backups=True,
2037
 
               pb=DummyProgress(), report_changes=False):
 
1332
               pb=None, report_changes=False):
2038
1333
        from bzrlib.conflicts import resolve
2039
 
        if filenames == []:
2040
 
            filenames = None
2041
 
            symbol_versioning.warn('Using [] to revert all files is deprecated'
2042
 
                ' as of bzr 0.91.  Please use None (the default) instead.',
2043
 
                DeprecationWarning, stacklevel=2)
2044
1334
        if old_tree is None:
2045
1335
            basis_tree = self.basis_tree()
2046
1336
            basis_tree.lock_read()
2067
1357
                basis_tree.unlock()
2068
1358
        return conflicts
2069
1359
 
 
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
 
2070
1388
    def revision_tree(self, revision_id):
2071
1389
        """See Tree.revision_tree.
2072
1390
 
2073
1391
        WorkingTree can supply revision_trees for the basis revision only
2074
1392
        because there is only one cached inventory in the bzr directory.
2075
1393
        """
2076
 
        if revision_id == self.last_revision():
2077
 
            try:
2078
 
                xml = self.read_basis_inventory()
2079
 
            except errors.NoSuchFile:
2080
 
                pass
2081
 
            else:
2082
 
                try:
2083
 
                    inv = xml7.serializer_v7.read_inventory_from_string(xml)
2084
 
                    # dont use the repository revision_tree api because we want
2085
 
                    # to supply the inventory.
2086
 
                    if inv.revision_id == revision_id:
2087
 
                        return revisiontree.RevisionTree(self.branch.repository,
2088
 
                            inv, revision_id)
2089
 
                except errors.BadInventoryFormat:
2090
 
                    pass
2091
 
        # raise if there was no inventory, or if we read the wrong inventory.
2092
 
        raise errors.NoSuchRevisionInTree(self, revision_id)
2093
 
 
2094
 
    # XXX: This method should be deprecated in favour of taking in a proper
2095
 
    # new Inventory object.
2096
 
    @needs_tree_write_lock
2097
 
    def set_inventory(self, new_inventory_list):
2098
 
        from bzrlib.inventory import (Inventory,
2099
 
                                      InventoryDirectory,
2100
 
                                      InventoryFile,
2101
 
                                      InventoryLink)
2102
 
        inv = Inventory(self.get_root_id())
2103
 
        for path, file_id, parent, kind in new_inventory_list:
2104
 
            name = os.path.basename(path)
2105
 
            if name == "":
2106
 
                continue
2107
 
            # fixme, there should be a factory function inv,add_??
2108
 
            if kind == 'directory':
2109
 
                inv.add(InventoryDirectory(file_id, name, parent))
2110
 
            elif kind == 'file':
2111
 
                inv.add(InventoryFile(file_id, name, parent))
2112
 
            elif kind == 'symlink':
2113
 
                inv.add(InventoryLink(file_id, name, parent))
2114
 
            else:
2115
 
                raise errors.BzrError("unknown kind %r" % kind)
2116
 
        self._write_inventory(inv)
 
1394
        raise NotImplementedError(self.revision_tree)
2117
1395
 
2118
1396
    @needs_tree_write_lock
2119
1397
    def set_root_id(self, file_id):
2132
1410
            present in the current inventory or an error will occur. It must
2133
1411
            not be None, but rather a valid file id.
2134
1412
        """
2135
 
        inv = self._inventory
2136
 
        orig_root_id = inv.root.file_id
2137
 
        # TODO: it might be nice to exit early if there was nothing
2138
 
        # to do, saving us from trigger a sync on unlock.
2139
 
        self._inventory_is_modified = True
2140
 
        # we preserve the root inventory entry object, but
2141
 
        # unlinkit from the byid index
2142
 
        del inv._byid[inv.root.file_id]
2143
 
        inv.root.file_id = file_id
2144
 
        # and link it into the index with the new changed id.
2145
 
        inv._byid[inv.root.file_id] = inv.root
2146
 
        # and finally update all children to reference the new id.
2147
 
        # XXX: this should be safe to just look at the root.children
2148
 
        # list, not the WHOLE INVENTORY.
2149
 
        for fid in inv:
2150
 
            entry = inv[fid]
2151
 
            if entry.parent_id == orig_root_id:
2152
 
                entry.parent_id = inv.root.file_id
 
1413
        raise NotImplementedError(self._set_root_id)
2153
1414
 
2154
1415
    def unlock(self):
2155
1416
        """See Branch.unlock.
2162
1423
        """
2163
1424
        raise NotImplementedError(self.unlock)
2164
1425
 
2165
 
    def update(self, change_reporter=None, possible_transports=None):
 
1426
    _marker = object()
 
1427
 
 
1428
    def update(self, change_reporter=None, possible_transports=None,
 
1429
               revision=None, old_tip=_marker, show_base=False):
2166
1430
        """Update a working tree along its branch.
2167
1431
 
2168
1432
        This will update the branch if its bound too, which means we have
2183
1447
        - Restore the wt.basis->wt.state changes.
2184
1448
 
2185
1449
        There isn't a single operation at the moment to do that, so we:
 
1450
 
2186
1451
        - Merge current state -> basis tree of the master w.r.t. the old tree
2187
1452
          basis.
2188
1453
        - 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.
2189
1460
        """
2190
1461
        if self.branch.get_bound_location() is not None:
2191
1462
            self.lock_write()
2192
 
            update_branch = True
 
1463
            update_branch = (old_tip is self._marker)
2193
1464
        else:
2194
1465
            self.lock_tree_write()
2195
1466
            update_branch = False
2197
1468
            if update_branch:
2198
1469
                old_tip = self.branch.update(possible_transports)
2199
1470
            else:
2200
 
                old_tip = None
2201
 
            return self._update_tree(old_tip, change_reporter)
 
1471
                if old_tip is self._marker:
 
1472
                    old_tip = None
 
1473
            return self._update_tree(old_tip, change_reporter, revision, show_base)
2202
1474
        finally:
2203
1475
            self.unlock()
2204
1476
 
2205
1477
    @needs_tree_write_lock
2206
 
    def _update_tree(self, old_tip=None, change_reporter=None):
 
1478
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None,
 
1479
                     show_base=False):
2207
1480
        """Update a tree to the master branch.
2208
1481
 
2209
1482
        :param old_tip: if supplied, the previous tip revision the branch,
2219
1492
        # We MUST save it even if an error occurs, because otherwise the users
2220
1493
        # local work is unreferenced and will appear to have been lost.
2221
1494
        #
2222
 
        result = 0
 
1495
        nb_conflicts = 0
2223
1496
        try:
2224
1497
            last_rev = self.get_parent_ids()[0]
2225
1498
        except IndexError:
2226
1499
            last_rev = _mod_revision.NULL_REVISION
2227
 
        if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2228
 
            # merge tree state up to new branch tip.
 
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
 
2229
1525
            basis = self.basis_tree()
2230
1526
            basis.lock_read()
2231
1527
            try:
2232
 
                to_tree = self.branch.basis_tree()
2233
 
                if basis.inventory.root is None:
2234
 
                    self.set_root_id(to_tree.get_root_id())
 
1528
                if (basis.get_root_id() is None or basis.get_root_id() != to_root_id):
 
1529
                    self.set_root_id(to_root_id)
2235
1530
                    self.flush()
2236
 
                result += merge.merge_inner(
2237
 
                                      self.branch,
2238
 
                                      to_tree,
2239
 
                                      basis,
2240
 
                                      this_tree=self,
2241
 
                                      change_reporter=change_reporter)
2242
1531
            finally:
2243
1532
                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)
2244
1545
            # TODO - dedup parents list with things merged by pull ?
2245
1546
            # reuse the tree we've updated to to set the basis:
2246
 
            parent_trees = [(self.branch.last_revision(), to_tree)]
 
1547
            parent_trees = [(revision, to_tree)]
2247
1548
            merges = self.get_parent_ids()[1:]
2248
1549
            # Ideally we ask the tree for the trees here, that way the working
2249
1550
            # tree can decide whether to give us the entire tree or give us a
2253
1554
            for parent in merges:
2254
1555
                parent_trees.append(
2255
1556
                    (parent, self.branch.repository.revision_tree(parent)))
2256
 
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
 
1557
            if not _mod_revision.is_null(old_tip):
2257
1558
                parent_trees.append(
2258
1559
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
2259
1560
            self.set_parent_trees(parent_trees)
2260
1561
            last_rev = parent_trees[0][0]
2261
 
        else:
2262
 
            # the working tree had the same last-revision as the master
2263
 
            # branch did. We may still have pivot local work from the local
2264
 
            # branch into old_tip:
2265
 
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2266
 
                self.add_parent_tree_id(old_tip)
2267
 
        if (old_tip is not None and not _mod_revision.is_null(old_tip)
2268
 
            and old_tip != last_rev):
2269
 
            # our last revision was not the prior branch last revision
2270
 
            # and we have converted that last revision to a pending merge.
2271
 
            # base is somewhere between the branch tip now
2272
 
            # and the now pending merge
2273
 
 
2274
 
            # Since we just modified the working tree and inventory, flush out
2275
 
            # the current state, before we modify it again.
2276
 
            # TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2277
 
            #       requires it only because TreeTransform directly munges the
2278
 
            #       inventory and calls tree._write_inventory(). Ultimately we
2279
 
            #       should be able to remove this extra flush.
2280
 
            self.flush()
2281
 
            graph = self.branch.repository.get_graph()
2282
 
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2283
 
                                                old_tip)
2284
 
            base_tree = self.branch.repository.revision_tree(base_rev_id)
2285
 
            other_tree = self.branch.repository.revision_tree(old_tip)
2286
 
            result += merge.merge_inner(
2287
 
                                  self.branch,
2288
 
                                  other_tree,
2289
 
                                  base_tree,
2290
 
                                  this_tree=self,
2291
 
                                  change_reporter=change_reporter)
2292
 
        return result
2293
 
 
2294
 
    def _write_hashcache_if_dirty(self):
2295
 
        """Write out the hashcache if it is dirty."""
2296
 
        if self._hashcache.needs_write:
2297
 
            try:
2298
 
                self._hashcache.write()
2299
 
            except OSError, e:
2300
 
                if e.errno not in (errno.EPERM, errno.EACCES):
2301
 
                    raise
2302
 
                # TODO: jam 20061219 Should this be a warning? A single line
2303
 
                #       warning might be sufficient to let the user know what
2304
 
                #       is going on.
2305
 
                mutter('Could not write hashcache for %s\nError: %s',
2306
 
                       self._hashcache.cache_file_name(), e)
2307
 
 
2308
 
    @needs_tree_write_lock
2309
 
    def _write_inventory(self, inv):
2310
 
        """Write inventory as the current inventory."""
2311
 
        self._set_inventory(inv, dirty=True)
2312
 
        self.flush()
 
1562
        return nb_conflicts
2313
1563
 
2314
1564
    def set_conflicts(self, arg):
2315
1565
        raise errors.UnsupportedOperation(self.set_conflicts, self)
2317
1567
    def add_conflicts(self, arg):
2318
1568
        raise errors.UnsupportedOperation(self.add_conflicts, self)
2319
1569
 
2320
 
    @needs_read_lock
2321
1570
    def conflicts(self):
2322
 
        conflicts = _mod_conflicts.ConflictList()
2323
 
        for conflicted in self._iter_conflicts():
2324
 
            text = True
2325
 
            try:
2326
 
                if file_kind(self.abspath(conflicted)) != "file":
2327
 
                    text = False
2328
 
            except errors.NoSuchFile:
2329
 
                text = False
2330
 
            if text is True:
2331
 
                for suffix in ('.THIS', '.OTHER'):
2332
 
                    try:
2333
 
                        kind = file_kind(self.abspath(conflicted+suffix))
2334
 
                        if kind != "file":
2335
 
                            text = False
2336
 
                    except errors.NoSuchFile:
2337
 
                        text = False
2338
 
                    if text == False:
2339
 
                        break
2340
 
            ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2341
 
            conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2342
 
                             path=conflicted,
2343
 
                             file_id=self.path2id(conflicted)))
2344
 
        return conflicts
 
1571
        raise NotImplementedError(self.conflicts)
2345
1572
 
2346
1573
    def walkdirs(self, prefix=""):
2347
1574
        """Walk the directories of this tree.
2467
1694
    def _walkdirs(self, prefix=""):
2468
1695
        """Walk the directories of this tree.
2469
1696
 
2470
 
           :prefix: is used as the directrory to start with.
2471
 
           returns a generator which yields items in the form:
2472
 
                ((curren_directory_path, fileid),
2473
 
                 [(file1_path, file1_name, file1_kind, None, file1_id,
2474
 
                   file1_kind), ... ])
 
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), ... ])
2475
1703
        """
2476
 
        _directory = 'directory'
2477
 
        # get the root in the inventory
2478
 
        inv = self.inventory
2479
 
        top_id = inv.path2id(prefix)
2480
 
        if top_id is None:
2481
 
            pending = []
2482
 
        else:
2483
 
            pending = [(prefix, '', _directory, None, top_id, None)]
2484
 
        while pending:
2485
 
            dirblock = []
2486
 
            currentdir = pending.pop()
2487
 
            # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2488
 
            top_id = currentdir[4]
2489
 
            if currentdir[0]:
2490
 
                relroot = currentdir[0] + '/'
2491
 
            else:
2492
 
                relroot = ""
2493
 
            # FIXME: stash the node in pending
2494
 
            entry = inv[top_id]
2495
 
            if entry.kind == 'directory':
2496
 
                for name, child in entry.sorted_children():
2497
 
                    dirblock.append((relroot + name, name, child.kind, None,
2498
 
                        child.file_id, child.kind
2499
 
                        ))
2500
 
            yield (currentdir[0], entry.file_id), dirblock
2501
 
            # push the user specified dirs from dirblock
2502
 
            for dir in reversed(dirblock):
2503
 
                if dir[2] == _directory:
2504
 
                    pending.append(dir)
 
1704
        raise NotImplementedError(self._walkdirs)
2505
1705
 
2506
1706
    @needs_tree_write_lock
2507
1707
    def auto_resolve(self):
2511
1711
        are considered 'resolved', because bzr always puts conflict markers
2512
1712
        into files that have text conflicts.  The corresponding .THIS .BASE and
2513
1713
        .OTHER files are deleted, as per 'resolve'.
 
1714
 
2514
1715
        :return: a tuple of ConflictLists: (un_resolved, resolved).
2515
1716
        """
2516
1717
        un_resolved = _mod_conflicts.ConflictList()
2535
1736
        self.set_conflicts(un_resolved)
2536
1737
        return un_resolved, resolved
2537
1738
 
2538
 
    @needs_read_lock
2539
 
    def _check(self):
2540
 
        tree_basis = self.basis_tree()
2541
 
        tree_basis.lock_read()
2542
 
        try:
2543
 
            repo_basis = self.branch.repository.revision_tree(
2544
 
                self.last_revision())
2545
 
            if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2546
 
                raise errors.BzrCheckError(
2547
 
                    "Mismatched basis inventory content.")
2548
 
            self._validate()
2549
 
        finally:
2550
 
            tree_basis.unlock()
2551
 
 
2552
1739
    def _validate(self):
2553
1740
        """Validate internal structures.
2554
1741
 
2560
1747
        """
2561
1748
        return
2562
1749
 
2563
 
    @needs_read_lock
 
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
 
2564
1762
    def _get_rules_searcher(self, default_searcher):
2565
1763
        """See Tree._get_rules_searcher."""
2566
1764
        if self._rules_searcher is None:
2574
1772
        return ShelfManager(self, self._transport)
2575
1773
 
2576
1774
 
2577
 
class WorkingTree2(WorkingTree):
2578
 
    """This is the Format 2 working tree.
2579
 
 
2580
 
    This was the first weave based working tree.
2581
 
     - uses os locks for locking.
2582
 
     - uses the branch last-revision.
 
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.
2583
1784
    """
2584
1785
 
2585
 
    def __init__(self, *args, **kwargs):
2586
 
        super(WorkingTree2, self).__init__(*args, **kwargs)
2587
 
        # WorkingTree2 has more of a constraint that self._inventory must
2588
 
        # exist. Because this is an older format, we don't mind the overhead
2589
 
        # caused by the extra computation here.
2590
 
 
2591
 
        # Newer WorkingTree's should only have self._inventory set when they
2592
 
        # have a read lock.
2593
 
        if self._inventory is None:
2594
 
            self.read_working_inventory()
 
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
2595
1880
 
2596
1881
    def lock_tree_write(self):
2597
 
        """See WorkingTree.lock_tree_write().
2598
 
 
2599
 
        In Format2 WorkingTrees we have a single lock for the branch and tree
2600
 
        so lock_tree_write() degrades to lock_write().
2601
 
        """
 
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()
2602
1903
        self.branch.lock_write()
2603
1904
        try:
2604
 
            return self._control_files.lock_write()
 
1905
            self._control_files.lock_write()
 
1906
            return LogicalLockResult(self.unlock)
2605
1907
        except:
2606
1908
            self.branch.unlock()
2607
1909
            raise
2608
1910
 
2609
 
    def unlock(self):
2610
 
        # do non-implementation specific cleanup
2611
 
        self._cleanup()
2612
 
 
2613
 
        # we share control files:
2614
 
        if self._control_files._lock_count == 3:
2615
 
            # _inventory_is_modified is always False during a read lock.
2616
 
            if self._inventory_is_modified:
2617
 
                self.flush()
2618
 
            self._write_hashcache_if_dirty()
2619
 
 
2620
 
        # reverse order of locking.
 
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')
2621
1955
        try:
2622
 
            return self._control_files.unlock()
 
1956
            result = self._deserialize(f)
2623
1957
        finally:
2624
 
            self.branch.unlock()
2625
 
 
2626
 
 
2627
 
class WorkingTree3(WorkingTree):
2628
 
    """This is the Format 3 working tree.
2629
 
 
2630
 
    This differs from the base WorkingTree by:
2631
 
     - having its own file lock
2632
 
     - having its own last-revision property.
2633
 
 
2634
 
    This is new in bzr 0.8
2635
 
    """
2636
 
 
2637
 
    @needs_read_lock
2638
 
    def _last_revision(self):
2639
 
        """See Mutable.last_revision."""
 
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
 
2002
        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].
2640
2022
        try:
2641
 
            return self._transport.get_bytes('last-revision')
2642
 
        except errors.NoSuchFile:
2643
 
            return _mod_revision.NULL_REVISION
2644
 
 
2645
 
    def _change_last_revision(self, revision_id):
2646
 
        """See WorkingTree._change_last_revision."""
2647
 
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2648
 
            try:
2649
 
                self._transport.delete('last-revision')
2650
 
            except errors.NoSuchFile:
2651
 
                pass
2652
 
            return False
2653
 
        else:
2654
 
            self._transport.put_bytes('last-revision', revision_id,
2655
 
                mode=self.bzrdir._get_file_mode())
2656
 
            return True
 
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)
2657
2051
 
2658
2052
    @needs_tree_write_lock
2659
2053
    def set_conflicts(self, conflicts):
2679
2073
                    raise errors.ConflictFormatError()
2680
2074
            except StopIteration:
2681
2075
                raise errors.ConflictFormatError()
2682
 
            return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
 
2076
            reader = _mod_rio.RioReader(confile)
 
2077
            return _mod_conflicts.ConflictList.from_stanzas(reader)
2683
2078
        finally:
2684
2079
            confile.close()
2685
2080
 
2686
 
    def unlock(self):
2687
 
        # do non-implementation specific cleanup
2688
 
        self._cleanup()
2689
 
        if self._control_files._lock_count == 1:
2690
 
            # _inventory_is_modified is always False during a read lock.
2691
 
            if self._inventory_is_modified:
2692
 
                self.flush()
2693
 
            self._write_hashcache_if_dirty()
2694
 
        # reverse order of locking.
2695
 
        try:
2696
 
            return self._control_files.unlock()
2697
 
        finally:
2698
 
            self.branch.unlock()
2699
 
 
2700
 
 
2701
 
def get_conflicted_stem(path):
2702
 
    for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2703
 
        if path.endswith(suffix):
2704
 
            return path[:-len(suffix)]
2705
 
 
2706
 
 
2707
 
class WorkingTreeFormat(object):
 
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):
2708
3062
    """An encapsulation of the initialization and open routines for a format.
2709
3063
 
2710
3064
    Formats provide three things:
2722
3076
    object will be created every time regardless.
2723
3077
    """
2724
3078
 
2725
 
    _default_format = None
2726
 
    """The default format used for new trees."""
2727
 
 
2728
 
    _formats = {}
2729
 
    """The known formats."""
2730
 
 
2731
3079
    requires_rich_root = False
2732
3080
 
2733
3081
    upgrade_recommended = False
2734
3082
 
2735
 
    @classmethod
2736
 
    def find_format(klass, a_bzrdir):
2737
 
        """Return the format for the working tree object in a_bzrdir."""
2738
 
        try:
2739
 
            transport = a_bzrdir.get_workingtree_transport(None)
2740
 
            format_string = transport.get("format").read()
2741
 
            return klass._formats[format_string]
2742
 
        except errors.NoSuchFile:
2743
 
            raise errors.NoWorkingTree(base=transport.base)
2744
 
        except KeyError:
2745
 
            raise errors.UnknownFormatError(format=format_string,
2746
 
                                            kind="working tree")
 
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)
2747
3108
 
2748
3109
    def __eq__(self, other):
2749
3110
        return self.__class__ is other.__class__
2751
3112
    def __ne__(self, other):
2752
3113
        return not (self == other)
2753
3114
 
2754
 
    @classmethod
2755
 
    def get_default_format(klass):
2756
 
        """Return the current default format."""
2757
 
        return klass._default_format
2758
 
 
2759
 
    def get_format_string(self):
2760
 
        """Return the ASCII format string that identifies this format."""
2761
 
        raise NotImplementedError(self.get_format_string)
2762
 
 
2763
3115
    def get_format_description(self):
2764
3116
        """Return the short description for this format."""
2765
3117
        raise NotImplementedError(self.get_format_description)
2781
3133
        """True if this format supports stored views."""
2782
3134
        return False
2783
3135
 
2784
 
    @classmethod
2785
 
    def register_format(klass, format):
2786
 
        klass._formats[format.get_format_string()] = format
2787
 
 
2788
 
    @classmethod
2789
 
    def set_default_format(klass, format):
2790
 
        klass._default_format = format
2791
 
 
2792
 
    @classmethod
2793
 
    def unregister_format(klass, format):
2794
 
        del klass._formats[format.get_format_string()]
2795
 
 
2796
 
 
2797
 
class WorkingTreeFormat2(WorkingTreeFormat):
2798
 
    """The second working tree format.
2799
 
 
2800
 
    This format modified the hash cache from the format 1 hash cache.
2801
 
    """
2802
 
 
2803
 
    upgrade_recommended = True
2804
 
 
2805
 
    def get_format_description(self):
2806
 
        """See WorkingTreeFormat.get_format_description()."""
2807
 
        return "Working tree format 2"
2808
 
 
2809
 
    def _stub_initialize_on_transport(self, transport, file_mode):
2810
 
        """Workaround: create control files for a remote working tree.
2811
 
 
2812
 
        This ensures that it can later be updated and dealt with locally,
2813
 
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2814
 
        no working tree.  (See bug #43064).
2815
 
        """
2816
 
        sio = StringIO()
2817
 
        inv = inventory.Inventory()
2818
 
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
2819
 
        sio.seek(0)
2820
 
        transport.put_file('inventory', sio, file_mode)
2821
 
        transport.put_bytes('pending-merges', '', file_mode)
2822
 
 
2823
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2824
 
                   accelerator_tree=None, hardlink=False):
2825
 
        """See WorkingTreeFormat.initialize()."""
2826
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
2827
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2828
 
        if from_branch is not None:
2829
 
            branch = from_branch
2830
 
        else:
2831
 
            branch = a_bzrdir.open_branch()
2832
 
        if revision_id is None:
2833
 
            revision_id = _mod_revision.ensure_null(branch.last_revision())
2834
 
        branch.lock_write()
2835
 
        try:
2836
 
            branch.generate_revision_history(revision_id)
2837
 
        finally:
2838
 
            branch.unlock()
2839
 
        inv = inventory.Inventory()
2840
 
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2841
 
                         branch,
2842
 
                         inv,
2843
 
                         _internal=True,
2844
 
                         _format=self,
2845
 
                         _bzrdir=a_bzrdir)
2846
 
        basis_tree = branch.repository.revision_tree(revision_id)
2847
 
        if basis_tree.inventory.root is not None:
2848
 
            wt.set_root_id(basis_tree.get_root_id())
2849
 
        # set the parent list and cache the basis tree.
2850
 
        if _mod_revision.is_null(revision_id):
2851
 
            parent_trees = []
2852
 
        else:
2853
 
            parent_trees = [(revision_id, basis_tree)]
2854
 
        wt.set_parent_trees(parent_trees)
2855
 
        transform.build_tree(basis_tree, wt)
2856
 
        return wt
2857
 
 
2858
 
    def __init__(self):
2859
 
        super(WorkingTreeFormat2, self).__init__()
2860
 
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
2861
 
 
2862
 
    def open(self, a_bzrdir, _found=False):
2863
 
        """Return the WorkingTree object for a_bzrdir
2864
 
 
2865
 
        _found is a private parameter, do not use it. It is used to indicate
2866
 
               if format probing has already been done.
2867
 
        """
2868
 
        if not _found:
2869
 
            # we are being called directly and must probe.
2870
 
            raise NotImplementedError
2871
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
2872
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2873
 
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2874
 
                           _internal=True,
2875
 
                           _format=self,
2876
 
                           _bzrdir=a_bzrdir)
2877
 
        return wt
2878
 
 
2879
 
class WorkingTreeFormat3(WorkingTreeFormat):
2880
 
    """The second working tree format updated to record a format marker.
2881
 
 
2882
 
    This format:
2883
 
        - exists within a metadir controlling .bzr
2884
 
        - includes an explicit version marker for the workingtree control
2885
 
          files, separate from the BzrDir format
2886
 
        - modifies the hash cache format
2887
 
        - is new in bzr 0.8
2888
 
        - uses a LockDir to guard access for writes.
2889
 
    """
2890
 
 
2891
 
    upgrade_recommended = True
2892
 
 
2893
 
    def get_format_string(self):
2894
 
        """See WorkingTreeFormat.get_format_string()."""
2895
 
        return "Bazaar-NG Working Tree format 3"
2896
 
 
2897
 
    def get_format_description(self):
2898
 
        """See WorkingTreeFormat.get_format_description()."""
2899
 
        return "Working tree format 3"
2900
 
 
2901
 
    _lock_file_name = 'lock'
2902
 
    _lock_class = LockDir
2903
 
 
2904
 
    _tree_class = WorkingTree3
2905
 
 
2906
 
    def __get_matchingbzrdir(self):
2907
 
        return bzrdir.BzrDirMetaFormat1()
2908
 
 
2909
 
    _matchingbzrdir = property(__get_matchingbzrdir)
2910
 
 
2911
 
    def _open_control_files(self, a_bzrdir):
2912
 
        transport = a_bzrdir.get_workingtree_transport(None)
2913
 
        return LockableFiles(transport, self._lock_file_name,
2914
 
                             self._lock_class)
2915
 
 
2916
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2917
 
                   accelerator_tree=None, hardlink=False):
2918
 
        """See WorkingTreeFormat.initialize().
2919
 
 
2920
 
        :param revision_id: if supplied, create a working tree at a different
2921
 
            revision than the branch is at.
2922
 
        :param accelerator_tree: A tree which can be used for retrieving file
2923
 
            contents more quickly than the revision tree, i.e. a workingtree.
2924
 
            The revision tree will be used for cases where accelerator_tree's
2925
 
            content is different.
2926
 
        :param hardlink: If true, hard-link files from accelerator_tree,
2927
 
            where possible.
2928
 
        """
2929
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
2930
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2931
 
        transport = a_bzrdir.get_workingtree_transport(self)
2932
 
        control_files = self._open_control_files(a_bzrdir)
2933
 
        control_files.create_lock()
2934
 
        control_files.lock_write()
2935
 
        transport.put_bytes('format', self.get_format_string(),
2936
 
            mode=a_bzrdir._get_file_mode())
2937
 
        if from_branch is not None:
2938
 
            branch = from_branch
2939
 
        else:
2940
 
            branch = a_bzrdir.open_branch()
2941
 
        if revision_id is None:
2942
 
            revision_id = _mod_revision.ensure_null(branch.last_revision())
2943
 
        # WorkingTree3 can handle an inventory which has a unique root id.
2944
 
        # as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2945
 
        # those trees. And because there isn't a format bump inbetween, we
2946
 
        # are maintaining compatibility with older clients.
2947
 
        # inv = Inventory(root_id=gen_root_id())
2948
 
        inv = self._initial_inventory()
2949
 
        wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2950
 
                         branch,
2951
 
                         inv,
2952
 
                         _internal=True,
2953
 
                         _format=self,
2954
 
                         _bzrdir=a_bzrdir,
2955
 
                         _control_files=control_files)
2956
 
        wt.lock_tree_write()
2957
 
        try:
2958
 
            basis_tree = branch.repository.revision_tree(revision_id)
2959
 
            # only set an explicit root id if there is one to set.
2960
 
            if basis_tree.inventory.root is not None:
2961
 
                wt.set_root_id(basis_tree.get_root_id())
2962
 
            if revision_id == _mod_revision.NULL_REVISION:
2963
 
                wt.set_parent_trees([])
2964
 
            else:
2965
 
                wt.set_parent_trees([(revision_id, basis_tree)])
2966
 
            transform.build_tree(basis_tree, wt)
2967
 
        finally:
2968
 
            # Unlock in this order so that the unlock-triggers-flush in
2969
 
            # WorkingTree is given a chance to fire.
2970
 
            control_files.unlock()
2971
 
            wt.unlock()
2972
 
        return wt
2973
 
 
2974
 
    def _initial_inventory(self):
2975
 
        return inventory.Inventory()
2976
 
 
2977
 
    def __init__(self):
2978
 
        super(WorkingTreeFormat3, self).__init__()
2979
 
 
2980
 
    def open(self, a_bzrdir, _found=False):
2981
 
        """Return the WorkingTree object for a_bzrdir
2982
 
 
2983
 
        _found is a private parameter, do not use it. It is used to indicate
2984
 
               if format probing has already been done.
2985
 
        """
2986
 
        if not _found:
2987
 
            # we are being called directly and must probe.
2988
 
            raise NotImplementedError
2989
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
2990
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2991
 
        wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2992
 
        return wt
2993
 
 
2994
 
    def _open(self, a_bzrdir, control_files):
2995
 
        """Open the tree itself.
2996
 
 
2997
 
        :param a_bzrdir: the dir for the tree.
2998
 
        :param control_files: the control files for the tree.
2999
 
        """
3000
 
        return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3001
 
                                _internal=True,
3002
 
                                _format=self,
3003
 
                                _bzrdir=a_bzrdir,
3004
 
                                _control_files=control_files)
3005
 
 
3006
 
    def __str__(self):
3007
 
        return self.get_format_string()
3008
 
 
3009
 
 
3010
 
__default_format = WorkingTreeFormat4()
3011
 
WorkingTreeFormat.register_format(__default_format)
3012
 
WorkingTreeFormat.register_format(WorkingTreeFormat6())
3013
 
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3014
 
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3015
 
WorkingTreeFormat.set_default_format(__default_format)
3016
 
# formats which have no format string are not discoverable
3017
 
# and not independently creatable, so are not registered.
3018
 
_legacy_formats = [WorkingTreeFormat2(),
3019
 
                   ]
 
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")