/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Aaron Bentley
  • Date: 2007-02-09 07:16:20 UTC
  • mfrom: (2272 +trunk)
  • mto: (2255.6.1 dirstate)
  • mto: This revision was merged to the branch mainline in revision 2322.
  • Revision ID: aaron.bentley@utoronto.ca-20070209071620-gp2n7vtjyb0f2x1e
Merge from bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""WorkingTree object and friends.
18
18
 
19
19
A WorkingTree represents the editable working copy of a branch.
20
 
Operations which represent the WorkingTree are also done here,
21
 
such as renaming or adding files.  The WorkingTree has an inventory
22
 
which is updated by these operations.  A commit produces a
 
20
Operations which represent the WorkingTree are also done here, 
 
21
such as renaming or adding files.  The WorkingTree has an inventory 
 
22
which is updated by these operations.  A commit produces a 
23
23
new revision based on the workingtree and its inventory.
24
24
 
25
25
At the moment every WorkingTree has its own branch.  Remote
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
38
 
33
39
from cStringIO import StringIO
34
40
import os
35
 
import sys
36
41
 
37
42
from bzrlib.lazy_import import lazy_import
38
43
lazy_import(globals(), """
39
 
from bisect import bisect_left
40
44
import collections
 
45
from copy import deepcopy
41
46
import errno
42
 
import itertools
43
 
import operator
44
47
import stat
45
 
import re
 
48
from time import time
 
49
import warnings
46
50
 
47
51
import bzrlib
48
52
from bzrlib import (
52
56
    errors,
53
57
    generate_ids,
54
58
    globbing,
55
 
    graph as _mod_graph,
56
59
    hashcache,
57
60
    ignores,
58
 
    inventory,
59
61
    merge,
60
 
    revision as _mod_revision,
61
 
    revisiontree,
62
 
    trace,
 
62
    osutils,
 
63
    repository,
 
64
    textui,
63
65
    transform,
64
 
    ui,
65
 
    views,
 
66
    urlutils,
66
67
    xml5,
 
68
    xml6,
67
69
    xml7,
68
70
    )
69
71
import bzrlib.branch
70
72
from bzrlib.transport import get_transport
71
 
from bzrlib.workingtree_4 import (
72
 
    WorkingTreeFormat4,
73
 
    WorkingTreeFormat5,
74
 
    WorkingTreeFormat6,
75
 
    )
 
73
import bzrlib.ui
76
74
""")
77
75
 
78
76
from bzrlib import symbol_versioning
79
77
from bzrlib.decorators import needs_read_lock, needs_write_lock
80
 
from bzrlib.lockable_files import LockableFiles
 
78
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
 
79
from bzrlib.lockable_files import LockableFiles, TransportLock
81
80
from bzrlib.lockdir import LockDir
82
81
import bzrlib.mutabletree
83
82
from bzrlib.mutabletree import needs_tree_write_lock
84
 
from bzrlib import osutils
85
83
from bzrlib.osutils import (
 
84
    compact_date,
86
85
    file_kind,
87
86
    isdir,
88
87
    normpath,
89
88
    pathjoin,
 
89
    rand_chars,
90
90
    realpath,
91
91
    safe_unicode,
92
92
    splitpath,
93
93
    supports_executable,
94
94
    )
95
 
from bzrlib.filters import filtered_input_file
96
95
from bzrlib.trace import mutter, note
97
96
from bzrlib.transport.local import LocalTransport
98
 
from bzrlib.revision import CURRENT_REVISION
 
97
import bzrlib.tree
 
98
from bzrlib.progress import DummyProgress, ProgressPhase
 
99
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
 
100
import bzrlib.revisiontree
99
101
from bzrlib.rio import RioReader, rio_file, Stanza
100
 
from bzrlib.symbol_versioning import (
101
 
    deprecated_passed,
102
 
    DEPRECATED_PARAMETER,
103
 
    )
 
102
from bzrlib.symbol_versioning import (deprecated_passed,
 
103
        deprecated_method,
 
104
        deprecated_function,
 
105
        DEPRECATED_PARAMETER,
 
106
        zero_eight,
 
107
        zero_eleven,
 
108
        zero_thirteen,
 
109
        )
104
110
 
105
111
 
106
112
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
107
 
# TODO: Modifying the conflict objects or their type is currently nearly
108
 
# impossible as there is no clear relationship between the working tree format
109
 
# and the conflict list file format.
110
113
CONFLICT_HEADER_1 = "BZR conflict list format 1"
111
114
 
112
 
ERROR_PATH_NOT_FOUND = 3    # WindowsError errno code, equivalent to ENOENT
 
115
 
 
116
@deprecated_function(zero_thirteen)
 
117
def gen_file_id(name):
 
118
    """Return new file id for the basename 'name'.
 
119
 
 
120
    Use bzrlib.generate_ids.gen_file_id() instead
 
121
    """
 
122
    return generate_ids.gen_file_id(name)
 
123
 
 
124
 
 
125
@deprecated_function(zero_thirteen)
 
126
def gen_root_id():
 
127
    """Return a new tree-root file id.
 
128
 
 
129
    This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
 
130
    """
 
131
    return generate_ids.gen_root_id()
113
132
 
114
133
 
115
134
class TreeEntry(object):
116
135
    """An entry that implements the minimum interface used by commands.
117
136
 
118
 
    This needs further inspection, it may be better to have
 
137
    This needs further inspection, it may be better to have 
119
138
    InventoryEntries without ids - though that seems wrong. For now,
120
139
    this is a parallel hierarchy to InventoryEntry, and needs to become
121
140
    one of several things: decorates to that hierarchy, children of, or
124
143
    no InventoryEntry available - i.e. for unversioned objects.
125
144
    Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
126
145
    """
127
 
 
 
146
 
128
147
    def __eq__(self, other):
129
148
        # yes, this us ugly, TODO: best practice __eq__ style.
130
149
        return (isinstance(other, TreeEntry)
131
150
                and other.__class__ == self.__class__)
132
 
 
 
151
 
133
152
    def kind_character(self):
134
153
        return "???"
135
154
 
167
186
        return ''
168
187
 
169
188
 
170
 
class WorkingTree(bzrlib.mutabletree.MutableTree,
171
 
    bzrdir.ControlComponent):
 
189
class WorkingTree(bzrlib.mutabletree.MutableTree):
172
190
    """Working copy tree.
173
191
 
174
192
    The inventory is held in the `Branch` working-inventory, and the
178
196
    not listed in the Inventory and vice versa.
179
197
    """
180
198
 
181
 
    # override this to set the strategy for storing views
182
 
    def _make_views(self):
183
 
        return views.DisabledViews(self)
184
 
 
185
199
    def __init__(self, basedir='.',
186
200
                 branch=DEPRECATED_PARAMETER,
187
201
                 _inventory=None,
189
203
                 _internal=False,
190
204
                 _format=None,
191
205
                 _bzrdir=None):
192
 
        """Construct a WorkingTree instance. This is not a public API.
 
206
        """Construct a WorkingTree for basedir.
193
207
 
194
 
        :param branch: A branch to override probing for the branch.
 
208
        If the branch is not supplied, it is opened automatically.
 
209
        If the branch is supplied, it must be the branch for this basedir.
 
210
        (branch.base is not cross checked, because for remote branches that
 
211
        would be meaningless).
195
212
        """
196
213
        self._format = _format
197
214
        self.bzrdir = _bzrdir
198
215
        if not _internal:
199
 
            raise errors.BzrError("Please use bzrdir.open_workingtree or "
200
 
                "WorkingTree.open() to obtain a WorkingTree.")
 
216
            # not created via open etc.
 
217
            warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
 
218
                 "Please use bzrdir.open_workingtree or WorkingTree.open().",
 
219
                 DeprecationWarning,
 
220
                 stacklevel=2)
 
221
            wt = WorkingTree.open(basedir)
 
222
            self._branch = wt.branch
 
223
            self.basedir = wt.basedir
 
224
            self._control_files = wt._control_files
 
225
            self._hashcache = wt._hashcache
 
226
            self._set_inventory(wt._inventory, dirty=False)
 
227
            self._format = wt._format
 
228
            self.bzrdir = wt.bzrdir
 
229
        assert isinstance(basedir, basestring), \
 
230
            "base directory %r is not a string" % basedir
201
231
        basedir = safe_unicode(basedir)
202
232
        mutter("opening working tree %r", basedir)
203
233
        if deprecated_passed(branch):
 
234
            if not _internal:
 
235
                warnings.warn("WorkingTree(..., branch=XXX) is deprecated"
 
236
                     " as of bzr 0.8. Please use bzrdir.open_workingtree() or"
 
237
                     " WorkingTree.open().",
 
238
                     DeprecationWarning,
 
239
                     stacklevel=2
 
240
                     )
204
241
            self._branch = branch
205
242
        else:
206
243
            self._branch = self.bzrdir.open_branch()
211
248
            self._control_files = self.branch.control_files
212
249
        else:
213
250
            # assume all other formats have their own control files.
 
251
            assert isinstance(_control_files, LockableFiles), \
 
252
                    "_control_files must be a LockableFiles, not %r" \
 
253
                    % _control_files
214
254
            self._control_files = _control_files
215
 
        self._transport = self._control_files._transport
216
255
        # update the whole cache up front and write to disk if anything changed;
217
256
        # in the future we might want to do this more selectively
218
257
        # two possible ways offer themselves : in self._unlock, write the cache
222
261
        wt_trans = self.bzrdir.get_workingtree_transport(None)
223
262
        cache_filename = wt_trans.local_abspath('stat-cache')
224
263
        self._hashcache = hashcache.HashCache(basedir, cache_filename,
225
 
            self.bzrdir._get_file_mode(),
226
 
            self._content_filter_stack_provider())
 
264
                                              self._control_files._file_mode)
227
265
        hc = self._hashcache
228
266
        hc.read()
229
267
        # is this scan needed ? it makes things kinda slow.
234
272
            hc.write()
235
273
 
236
274
        if _inventory is None:
237
 
            # This will be acquired on lock_read() or lock_write()
238
275
            self._inventory_is_modified = False
239
 
            self._inventory = None
 
276
            self.read_working_inventory()
240
277
        else:
241
278
            # the caller of __init__ has provided an inventory,
242
279
            # we assume they know what they are doing - as its only
243
280
            # the Format factory and creation methods that are
244
281
            # permitted to do this.
245
282
            self._set_inventory(_inventory, dirty=False)
246
 
        self._detect_case_handling()
247
 
        self._rules_searcher = None
248
 
        self.views = self._make_views()
249
 
 
250
 
    @property
251
 
    def user_transport(self):
252
 
        return self.bzrdir.user_transport
253
 
 
254
 
    @property
255
 
    def control_transport(self):
256
 
        return self._transport
257
 
 
258
 
    def _detect_case_handling(self):
259
 
        wt_trans = self.bzrdir.get_workingtree_transport(None)
260
 
        try:
261
 
            wt_trans.stat("FoRMaT")
262
 
        except errors.NoSuchFile:
263
 
            self.case_sensitive = True
264
 
        else:
265
 
            self.case_sensitive = False
266
 
 
267
 
        self._setup_directory_is_tree_reference()
268
283
 
269
284
    branch = property(
270
285
        fget=lambda self: self._branch,
285
300
        self._control_files.break_lock()
286
301
        self.branch.break_lock()
287
302
 
288
 
    def _get_check_refs(self):
289
 
        """Return the references needed to perform a check of this tree.
290
 
        
291
 
        The default implementation returns no refs, and is only suitable for
292
 
        trees that have no local caching and can commit on ghosts at any time.
293
 
 
294
 
        :seealso: bzrlib.check for details about check_refs.
295
 
        """
296
 
        return []
297
 
 
298
303
    def requires_rich_root(self):
299
304
        return self._format.requires_rich_root
300
305
 
301
306
    def supports_tree_reference(self):
302
 
        return False
303
 
 
304
 
    def supports_content_filtering(self):
305
 
        return self._format.supports_content_filtering()
306
 
 
307
 
    def supports_views(self):
308
 
        return self.views.supports_views()
 
307
        return getattr(self._format, 'supports_tree_reference', False)
309
308
 
310
309
    def _set_inventory(self, inv, dirty):
311
310
        """Set the internal cached inventory.
317
316
            False then the inventory is the same as that on disk and any
318
317
            serialisation would be unneeded overhead.
319
318
        """
 
319
        assert inv.root is not None
320
320
        self._inventory = inv
321
321
        self._inventory_is_modified = dirty
322
322
 
326
326
 
327
327
        """
328
328
        if path is None:
329
 
            path = osutils.getcwd()
 
329
            path = os.path.getcwdu()
330
330
        control = bzrdir.BzrDir.open(path, _unsupported)
331
331
        return control.open_workingtree(_unsupported)
332
 
 
 
332
        
333
333
    @staticmethod
334
334
    def open_containing(path=None):
335
335
        """Open an existing working tree which has its root about path.
336
 
 
 
336
        
337
337
        This probes for a working tree at path and searches upwards from there.
338
338
 
339
339
        Basically we keep looking up until we find the control directory or
357
357
        """
358
358
        return WorkingTree.open(path, _unsupported=True)
359
359
 
360
 
    @staticmethod
361
 
    def find_trees(location):
362
 
        def list_current(transport):
363
 
            return [d for d in transport.list_dir('') if d != '.bzr']
364
 
        def evaluate(bzrdir):
365
 
            try:
366
 
                tree = bzrdir.open_workingtree()
367
 
            except errors.NoWorkingTree:
368
 
                return True, None
369
 
            else:
370
 
                return True, tree
371
 
        transport = get_transport(location)
372
 
        iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
373
 
                                              list_current=list_current)
374
 
        return [t for t in iterator if t is not None]
375
 
 
376
 
    # should be deprecated - this is slow and in any case treating them as a
377
 
    # container is (we now know) bad style -- mbp 20070302
378
 
    ## @deprecated_method(zero_fifteen)
379
360
    def __iter__(self):
380
361
        """Iterate through file_ids for this tree.
381
362
 
387
368
            if osutils.lexists(self.abspath(path)):
388
369
                yield ie.file_id
389
370
 
390
 
    def all_file_ids(self):
391
 
        """See Tree.iter_all_file_ids"""
392
 
        return set(self.inventory)
393
 
 
394
371
    def __repr__(self):
395
372
        return "<%s of %s>" % (self.__class__.__name__,
396
373
                               getattr(self, 'basedir', None))
397
374
 
398
375
    def abspath(self, filename):
399
376
        return pathjoin(self.basedir, filename)
400
 
 
 
377
    
401
378
    def basis_tree(self):
402
379
        """Return RevisionTree for the current last revision.
403
 
 
 
380
        
404
381
        If the left most parent is a ghost then the returned tree will be an
405
 
        empty tree - one obtained by calling
406
 
        repository.revision_tree(NULL_REVISION).
 
382
        empty tree - one obtained by calling repository.revision_tree(None).
407
383
        """
408
384
        try:
409
385
            revision_id = self.get_parent_ids()[0]
411
387
            # no parents, return an empty revision tree.
412
388
            # in the future this should return the tree for
413
389
            # 'empty:' - the implicit root empty tree.
414
 
            return self.branch.repository.revision_tree(
415
 
                       _mod_revision.NULL_REVISION)
416
 
        try:
417
 
            return self.revision_tree(revision_id)
418
 
        except errors.NoSuchRevision:
419
 
            pass
 
390
            return self.branch.repository.revision_tree(None)
 
391
        else:
 
392
            try:
 
393
                xml = self.read_basis_inventory()
 
394
                inv = xml6.serializer_v6.read_inventory_from_string(xml)
 
395
                if inv is not None and inv.revision_id == revision_id:
 
396
                    return bzrlib.revisiontree.RevisionTree(
 
397
                        self.branch.repository, inv, revision_id)
 
398
            except (errors.NoSuchFile, errors.BadInventoryFormat):
 
399
                pass
420
400
        # No cached copy available, retrieve from the repository.
421
401
        # FIXME? RBC 20060403 should we cache the inventory locally
422
402
        # at this point ?
423
403
        try:
424
404
            return self.branch.repository.revision_tree(revision_id)
425
 
        except (errors.RevisionNotPresent, errors.NoSuchRevision):
 
405
        except errors.RevisionNotPresent:
426
406
            # the basis tree *may* be a ghost or a low level error may have
427
 
            # occurred. If the revision is present, its a problem, if its not
 
407
            # occured. If the revision is present, its a problem, if its not
428
408
            # its a ghost.
429
409
            if self.branch.repository.has_revision(revision_id):
430
410
                raise
431
411
            # the basis tree is a ghost so return an empty tree.
432
 
            return self.branch.repository.revision_tree(
433
 
                       _mod_revision.NULL_REVISION)
434
 
 
435
 
    def _cleanup(self):
436
 
        self._flush_ignore_list_cache()
 
412
            return self.branch.repository.revision_tree(None)
 
413
 
 
414
    @staticmethod
 
415
    @deprecated_method(zero_eight)
 
416
    def create(branch, directory):
 
417
        """Create a workingtree for branch at directory.
 
418
 
 
419
        If existing_directory already exists it must have a .bzr directory.
 
420
        If it does not exist, it will be created.
 
421
 
 
422
        This returns a new WorkingTree object for the new checkout.
 
423
 
 
424
        TODO FIXME RBC 20060124 when we have checkout formats in place this
 
425
        should accept an optional revisionid to checkout [and reject this if
 
426
        checking out into the same dir as a pre-checkout-aware branch format.]
 
427
 
 
428
        XXX: When BzrDir is present, these should be created through that 
 
429
        interface instead.
 
430
        """
 
431
        warnings.warn('delete WorkingTree.create', stacklevel=3)
 
432
        transport = get_transport(directory)
 
433
        if branch.bzrdir.root_transport.base == transport.base:
 
434
            # same dir 
 
435
            return branch.bzrdir.create_workingtree()
 
436
        # different directory, 
 
437
        # create a branch reference
 
438
        # and now a working tree.
 
439
        raise NotImplementedError
 
440
 
 
441
    @staticmethod
 
442
    @deprecated_method(zero_eight)
 
443
    def create_standalone(directory):
 
444
        """Create a checkout and a branch and a repo at directory.
 
445
 
 
446
        Directory must exist and be empty.
 
447
 
 
448
        please use BzrDir.create_standalone_workingtree
 
449
        """
 
450
        return bzrdir.BzrDir.create_standalone_workingtree(directory)
437
451
 
438
452
    def relpath(self, path):
439
453
        """Return the local path portion from a given path.
440
 
 
441
 
        The path may be absolute or relative. If its a relative path it is
 
454
        
 
455
        The path may be absolute or relative. If its a relative path it is 
442
456
        interpreted relative to the python current working directory.
443
457
        """
444
458
        return osutils.relpath(self.basedir, path)
446
460
    def has_filename(self, filename):
447
461
        return osutils.lexists(self.abspath(filename))
448
462
 
449
 
    def get_file(self, file_id, path=None, filtered=True):
450
 
        return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
451
 
 
452
 
    def get_file_with_stat(self, file_id, path=None, filtered=True,
453
 
        _fstat=os.fstat):
454
 
        """See Tree.get_file_with_stat."""
455
 
        if path is None:
456
 
            path = self.id2path(file_id)
457
 
        file_obj = self.get_file_byname(path, filtered=False)
458
 
        stat_value = _fstat(file_obj.fileno())
459
 
        if filtered and self.supports_content_filtering():
460
 
            filters = self._content_filter_stack(path)
461
 
            file_obj = filtered_input_file(file_obj, filters)
462
 
        return (file_obj, stat_value)
463
 
 
464
 
    def get_file_text(self, file_id, path=None, filtered=True):
465
 
        return self.get_file(file_id, path=path, filtered=filtered).read()
466
 
 
467
 
    def get_file_byname(self, filename, filtered=True):
468
 
        path = self.abspath(filename)
469
 
        f = file(path, 'rb')
470
 
        if filtered and self.supports_content_filtering():
471
 
            filters = self._content_filter_stack(filename)
472
 
            return filtered_input_file(f, filters)
473
 
        else:
474
 
            return f
475
 
 
476
 
    def get_file_lines(self, file_id, path=None, filtered=True):
477
 
        """See Tree.get_file_lines()"""
478
 
        file = self.get_file(file_id, path, filtered=filtered)
479
 
        try:
480
 
            return file.readlines()
481
 
        finally:
482
 
            file.close()
483
 
 
484
 
    @needs_read_lock
485
 
    def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
 
463
    def get_file(self, file_id):
 
464
        return self.get_file_byname(self.id2path(file_id))
 
465
 
 
466
    def get_file_text(self, file_id):
 
467
        return self.get_file(file_id).read()
 
468
 
 
469
    def get_file_byname(self, filename):
 
470
        return file(self.abspath(filename), 'rb')
 
471
 
 
472
    def annotate_iter(self, file_id):
486
473
        """See Tree.annotate_iter
487
474
 
488
475
        This implementation will use the basis tree implementation if possible.
492
479
        incorrectly attributed to CURRENT_REVISION (but after committing, the
493
480
        attribution will be correct).
494
481
        """
495
 
        maybe_file_parent_keys = []
496
 
        for parent_id in self.get_parent_ids():
497
 
            try:
498
 
                parent_tree = self.revision_tree(parent_id)
499
 
            except errors.NoSuchRevisionInTree:
500
 
                parent_tree = self.branch.repository.revision_tree(parent_id)
501
 
            parent_tree.lock_read()
502
 
            try:
503
 
                if file_id not in parent_tree:
504
 
                    continue
505
 
                ie = parent_tree.inventory[file_id]
506
 
                if ie.kind != 'file':
507
 
                    # Note: this is slightly unnecessary, because symlinks and
508
 
                    # directories have a "text" which is the empty text, and we
509
 
                    # know that won't mess up annotations. But it seems cleaner
510
 
                    continue
511
 
                parent_text_key = (file_id, ie.revision)
512
 
                if parent_text_key not in maybe_file_parent_keys:
513
 
                    maybe_file_parent_keys.append(parent_text_key)
514
 
            finally:
515
 
                parent_tree.unlock()
516
 
        graph = _mod_graph.Graph(self.branch.repository.texts)
517
 
        heads = graph.heads(maybe_file_parent_keys)
518
 
        file_parent_keys = []
519
 
        for key in maybe_file_parent_keys:
520
 
            if key in heads:
521
 
                file_parent_keys.append(key)
522
 
 
523
 
        # Now we have the parents of this content
524
 
        annotator = self.branch.repository.texts.get_annotator()
525
 
        text = self.get_file(file_id).read()
526
 
        this_key =(file_id, default_revision)
527
 
        annotator.add_special_text(this_key, file_parent_keys, text)
528
 
        annotations = [(key[-1], line)
529
 
                       for key, line in annotator.annotate_flat(this_key)]
530
 
        return annotations
531
 
 
532
 
    def _get_ancestors(self, default_revision):
533
 
        ancestors = set([default_revision])
534
 
        for parent_id in self.get_parent_ids():
535
 
            ancestors.update(self.branch.repository.get_ancestry(
536
 
                             parent_id, topo_sorted=False))
537
 
        return ancestors
 
482
        basis = self.basis_tree()
 
483
        changes = self._iter_changes(basis, True, [file_id]).next()
 
484
        changed_content, kind = changes[2], changes[6]
 
485
        if not changed_content:
 
486
            return basis.annotate_iter(file_id)
 
487
        if kind[1] is None:
 
488
            return None
 
489
        import annotate
 
490
        if kind[0] != 'file':
 
491
            old_lines = []
 
492
        else:
 
493
            old_lines = list(basis.annotate_iter(file_id))
 
494
        old = [old_lines]
 
495
        for tree in self.branch.repository.revision_trees(
 
496
            self.get_parent_ids()[1:]):
 
497
            if file_id not in tree:
 
498
                continue
 
499
            old.append(list(tree.annotate_iter(file_id)))
 
500
        return annotate.reannotate(old, self.get_file(file_id).readlines(),
 
501
                                   CURRENT_REVISION)
538
502
 
539
503
    def get_parent_ids(self):
540
504
        """See Tree.get_parent_ids.
541
 
 
 
505
        
542
506
        This implementation reads the pending merges list and last_revision
543
507
        value and uses that to decide what the parents list should be.
544
508
        """
545
 
        last_rev = _mod_revision.ensure_null(self._last_revision())
546
 
        if _mod_revision.NULL_REVISION == last_rev:
 
509
        last_rev = self._last_revision()
 
510
        if last_rev is None:
547
511
            parents = []
548
512
        else:
549
513
            parents = [last_rev]
550
514
        try:
551
 
            merges_bytes = self._transport.get_bytes('pending-merges')
 
515
            merges_file = self._control_files.get_utf8('pending-merges')
552
516
        except errors.NoSuchFile:
553
517
            pass
554
518
        else:
555
 
            for l in osutils.split_lines(merges_bytes):
556
 
                revision_id = l.rstrip('\n')
557
 
                parents.append(revision_id)
 
519
            for l in merges_file.readlines():
 
520
                parents.append(l.rstrip('\n'))
558
521
        return parents
559
522
 
560
523
    @needs_read_lock
561
524
    def get_root_id(self):
562
525
        """Return the id of this trees root"""
563
526
        return self._inventory.root.file_id
564
 
 
 
527
        
565
528
    def _get_store_filename(self, file_id):
566
529
        ## XXX: badly named; this is not in the store at all
567
530
        return self.abspath(self.id2path(file_id))
568
531
 
569
532
    @needs_read_lock
570
 
    def clone(self, to_bzrdir, revision_id=None):
 
533
    def clone(self, to_bzrdir, revision_id=None, basis=None):
571
534
        """Duplicate this working tree into to_bzr, including all state.
572
 
 
 
535
        
573
536
        Specifically modified files are kept as modified, but
574
537
        ignored and unknown files are discarded.
575
538
 
576
539
        If you want to make a new line of development, see bzrdir.sprout()
577
540
 
578
541
        revision
579
 
            If not None, the cloned tree will have its last revision set to
580
 
            revision, and difference between the source trees last revision
 
542
            If not None, the cloned tree will have its last revision set to 
 
543
            revision, and and difference between the source trees last revision
581
544
            and this one merged in.
 
545
 
 
546
        basis
 
547
            If not None, a closer copy of a tree which may have some files in
 
548
            common, and which file content should be preferentially copied from.
582
549
        """
583
550
        # assumes the target bzr dir format is compatible.
584
 
        result = to_bzrdir.create_workingtree()
 
551
        result = self._format.initialize(to_bzrdir)
585
552
        self.copy_content_into(result, revision_id)
586
553
        return result
587
554
 
602
569
 
603
570
    def has_id(self, file_id):
604
571
        # files that have been deleted are excluded
605
 
        inv = self.inventory
 
572
        inv = self._inventory
606
573
        if not inv.has_id(file_id):
607
574
            return False
608
575
        path = inv.id2path(file_id)
616
583
    __contains__ = has_id
617
584
 
618
585
    def get_file_size(self, file_id):
619
 
        """See Tree.get_file_size"""
620
 
        # XXX: this returns the on-disk size; it should probably return the
621
 
        # canonical size
622
 
        try:
623
 
            return os.path.getsize(self.id2abspath(file_id))
624
 
        except OSError, e:
625
 
            if e.errno != errno.ENOENT:
626
 
                raise
627
 
            else:
628
 
                return None
 
586
        return os.path.getsize(self.id2abspath(file_id))
629
587
 
630
588
    @needs_read_lock
631
589
    def get_file_sha1(self, file_id, path=None, stat_value=None):
635
593
 
636
594
    def get_file_mtime(self, file_id, path=None):
637
595
        if not path:
638
 
            path = self.inventory.id2path(file_id)
 
596
            path = self._inventory.id2path(file_id)
639
597
        return os.lstat(self.abspath(path)).st_mtime
640
598
 
641
 
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
642
 
        file_id = self.path2id(path)
643
 
        if file_id is None:
644
 
            # For unversioned files on win32, we just assume they are not
645
 
            # executable
646
 
            return False
647
 
        return self._inventory[file_id].executable
648
 
 
649
 
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
650
 
        mode = stat_result.st_mode
651
 
        return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
652
 
 
653
599
    if not supports_executable():
654
600
        def is_executable(self, file_id, path=None):
655
601
            return self._inventory[file_id].executable
656
 
 
657
 
        _is_executable_from_path_and_stat = \
658
 
            _is_executable_from_path_and_stat_from_basis
659
602
    else:
660
603
        def is_executable(self, file_id, path=None):
661
604
            if not path:
662
 
                path = self.id2path(file_id)
 
605
                path = self._inventory.id2path(file_id)
663
606
            mode = os.lstat(self.abspath(path)).st_mode
664
607
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
665
608
 
666
 
        _is_executable_from_path_and_stat = \
667
 
            _is_executable_from_path_and_stat_from_stat
668
 
 
669
 
    @needs_tree_write_lock
 
609
    @needs_write_lock
670
610
    def _add(self, files, ids, kinds):
671
611
        """See MutableTree._add."""
672
612
        # TODO: Re-adding a file that is removed in the working copy
673
613
        # should probably put it back with the previous ID.
674
 
        # the read and write working inventory should not occur in this
 
614
        # the read and write working inventory should not occur in this 
675
615
        # function - they should be part of lock_write and unlock.
676
 
        inv = self.inventory
 
616
        inv = self.read_working_inventory()
677
617
        for f, file_id, kind in zip(files, ids, kinds):
 
618
            assert kind is not None
678
619
            if file_id is None:
679
620
                inv.add_path(f, kind=kind)
680
621
            else:
681
622
                inv.add_path(f, kind=kind, file_id=file_id)
682
 
            self._inventory_is_modified = True
 
623
        self._write_inventory(inv)
 
624
 
 
625
    def add_reference(self, sub_tree):
 
626
        """Add a TreeReference to the tree, pointing at sub_tree"""
 
627
        raise errors.UnsupportedOperation(self.add_reference, self)
683
628
 
684
629
    @needs_tree_write_lock
685
630
    def _gather_kinds(self, files, kinds):
745
690
        if updated:
746
691
            self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
747
692
 
748
 
    def path_content_summary(self, path, _lstat=os.lstat,
749
 
        _mapper=osutils.file_kind_from_stat_mode):
750
 
        """See Tree.path_content_summary."""
751
 
        abspath = self.abspath(path)
752
 
        try:
753
 
            stat_result = _lstat(abspath)
754
 
        except OSError, e:
755
 
            if getattr(e, 'errno', None) == errno.ENOENT:
756
 
                # no file.
757
 
                return ('missing', None, None, None)
758
 
            # propagate other errors
759
 
            raise
760
 
        kind = _mapper(stat_result.st_mode)
761
 
        if kind == 'file':
762
 
            return self._file_content_summary(path, stat_result)
763
 
        elif kind == 'directory':
764
 
            # perhaps it looks like a plain directory, but it's really a
765
 
            # reference.
766
 
            if self._directory_is_tree_reference(path):
767
 
                kind = 'tree-reference'
768
 
            return kind, None, None, None
769
 
        elif kind == 'symlink':
770
 
            target = osutils.readlink(abspath)
771
 
            return ('symlink', None, None, target)
772
 
        else:
773
 
            return (kind, None, None, None)
774
 
 
775
 
    def _file_content_summary(self, path, stat_result):
776
 
        size = stat_result.st_size
777
 
        executable = self._is_executable_from_path_and_stat(path, stat_result)
778
 
        # try for a stat cache lookup
779
 
        return ('file', size, executable, self._sha_from_stat(
780
 
            path, stat_result))
 
693
    @deprecated_method(zero_eleven)
 
694
    @needs_read_lock
 
695
    def pending_merges(self):
 
696
        """Return a list of pending merges.
 
697
 
 
698
        These are revisions that have been merged into the working
 
699
        directory but not yet committed.
 
700
 
 
701
        As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
 
702
        instead - which is available on all tree objects.
 
703
        """
 
704
        return self.get_parent_ids()[1:]
781
705
 
782
706
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
783
707
        """Common ghost checking functionality from set_parent_*.
793
717
 
794
718
    def _set_merges_from_parent_ids(self, parent_ids):
795
719
        merges = parent_ids[1:]
796
 
        self._transport.put_bytes('pending-merges', '\n'.join(merges),
797
 
            mode=self.bzrdir._get_file_mode())
798
 
 
799
 
    def _filter_parent_ids_by_ancestry(self, revision_ids):
800
 
        """Check that all merged revisions are proper 'heads'.
801
 
 
802
 
        This will always return the first revision_id, and any merged revisions
803
 
        which are
804
 
        """
805
 
        if len(revision_ids) == 0:
806
 
            return revision_ids
807
 
        graph = self.branch.repository.get_graph()
808
 
        heads = graph.heads(revision_ids)
809
 
        new_revision_ids = revision_ids[:1]
810
 
        for revision_id in revision_ids[1:]:
811
 
            if revision_id in heads and revision_id not in new_revision_ids:
812
 
                new_revision_ids.append(revision_id)
813
 
        if new_revision_ids != revision_ids:
814
 
            trace.mutter('requested to set revision_ids = %s,'
815
 
                         ' but filtered to %s', revision_ids, new_revision_ids)
816
 
        return new_revision_ids
 
720
        self._control_files.put_utf8('pending-merges', '\n'.join(merges))
817
721
 
818
722
    @needs_tree_write_lock
819
723
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
820
724
        """Set the parent ids to revision_ids.
821
 
 
 
725
        
822
726
        See also set_parent_trees. This api will try to retrieve the tree data
823
727
        for each element of revision_ids from the trees repository. If you have
824
728
        tree data already available, it is more efficient to use
830
734
        """
831
735
        self._check_parents_for_ghosts(revision_ids,
832
736
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
833
 
        for revision_id in revision_ids:
834
 
            _mod_revision.check_not_reserved_id(revision_id)
835
 
 
836
 
        revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
837
737
 
838
738
        if len(revision_ids) > 0:
839
739
            self.set_last_revision(revision_ids[0])
840
740
        else:
841
 
            self.set_last_revision(_mod_revision.NULL_REVISION)
 
741
            self.set_last_revision(None)
842
742
 
843
743
        self._set_merges_from_parent_ids(revision_ids)
844
744
 
846
746
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
847
747
        """See MutableTree.set_parent_trees."""
848
748
        parent_ids = [rev for (rev, tree) in parents_list]
849
 
        for revision_id in parent_ids:
850
 
            _mod_revision.check_not_reserved_id(revision_id)
851
749
 
852
750
        self._check_parents_for_ghosts(parent_ids,
853
751
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
854
752
 
855
 
        parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
856
 
 
857
753
        if len(parent_ids) == 0:
858
 
            leftmost_parent_id = _mod_revision.NULL_REVISION
 
754
            leftmost_parent_id = None
859
755
            leftmost_parent_tree = None
860
756
        else:
861
757
            leftmost_parent_id, leftmost_parent_tree = parents_list[0]
883
779
    def set_merge_modified(self, modified_hashes):
884
780
        def iter_stanzas():
885
781
            for file_id, hash in modified_hashes.iteritems():
886
 
                yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
 
782
                yield Stanza(file_id=file_id, hash=hash)
887
783
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
888
784
 
889
 
    def _sha_from_stat(self, path, stat_result):
890
 
        """Get a sha digest from the tree's stat cache.
891
 
 
892
 
        The default implementation assumes no stat cache is present.
893
 
 
894
 
        :param path: The path.
895
 
        :param stat_result: The stat result being looked up.
896
 
        """
897
 
        return None
898
 
 
 
785
    @needs_tree_write_lock
899
786
    def _put_rio(self, filename, stanzas, header):
900
 
        self._must_be_locked()
901
787
        my_file = rio_file(stanzas, header)
902
 
        self._transport.put_file(filename, my_file,
903
 
            mode=self.bzrdir._get_file_mode())
 
788
        self._control_files.put(filename, my_file)
904
789
 
905
790
    @needs_write_lock # because merge pulls data into the branch.
906
 
    def merge_from_branch(self, branch, to_revision=None, from_revision=None,
907
 
                          merge_type=None, force=False):
 
791
    def merge_from_branch(self, branch, to_revision=None):
908
792
        """Merge from a branch into this working tree.
909
793
 
910
794
        :param branch: The branch to merge from.
914
798
            branch.last_revision().
915
799
        """
916
800
        from bzrlib.merge import Merger, Merge3Merger
917
 
        merger = Merger(self.branch, this_tree=self)
918
 
        # check that there are no local alterations
919
 
        if not force and self.has_changes():
920
 
            raise errors.UncommittedChanges(self)
921
 
        if to_revision is None:
922
 
            to_revision = _mod_revision.ensure_null(branch.last_revision())
923
 
        merger.other_rev_id = to_revision
924
 
        if _mod_revision.is_null(merger.other_rev_id):
925
 
            raise errors.NoCommits(branch)
926
 
        self.branch.fetch(branch, last_revision=merger.other_rev_id)
927
 
        merger.other_basis = merger.other_rev_id
928
 
        merger.other_tree = self.branch.repository.revision_tree(
929
 
            merger.other_rev_id)
930
 
        merger.other_branch = branch
931
 
        if from_revision is None:
 
801
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
802
        try:
 
803
            merger = Merger(self.branch, this_tree=self, pb=pb)
 
804
            merger.pp = ProgressPhase("Merge phase", 5, pb)
 
805
            merger.pp.next_phase()
 
806
            # check that there are no
 
807
            # local alterations
 
808
            merger.check_basis(check_clean=True, require_commits=False)
 
809
            if to_revision is None:
 
810
                to_revision = branch.last_revision()
 
811
            merger.other_rev_id = to_revision
 
812
            if merger.other_rev_id is None:
 
813
                raise error.NoCommits(branch)
 
814
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
815
            merger.other_basis = merger.other_rev_id
 
816
            merger.other_tree = self.branch.repository.revision_tree(
 
817
                merger.other_rev_id)
 
818
            merger.other_branch = branch
 
819
            merger.pp.next_phase()
932
820
            merger.find_base()
933
 
        else:
934
 
            merger.set_base_revision(from_revision, branch)
935
 
        if merger.base_rev_id == merger.other_rev_id:
936
 
            raise errors.PointlessMerge
937
 
        merger.backup_files = False
938
 
        if merge_type is None:
 
821
            if merger.base_rev_id == merger.other_rev_id:
 
822
                raise errors.PointlessMerge
 
823
            merger.backup_files = False
939
824
            merger.merge_type = Merge3Merger
940
 
        else:
941
 
            merger.merge_type = merge_type
942
 
        merger.set_interesting_files(None)
943
 
        merger.show_base = False
944
 
        merger.reprocess = False
945
 
        conflicts = merger.do_merge()
946
 
        merger.set_pending()
 
825
            merger.set_interesting_files(None)
 
826
            merger.show_base = False
 
827
            merger.reprocess = False
 
828
            conflicts = merger.do_merge()
 
829
            merger.set_pending()
 
830
        finally:
 
831
            pb.finished()
947
832
        return conflicts
948
833
 
949
 
    @needs_read_lock
950
 
    def merge_modified(self):
951
 
        """Return a dictionary of files modified by a merge.
952
 
 
953
 
        The list is initialized by WorkingTree.set_merge_modified, which is
954
 
        typically called after we make some automatic updates to the tree
955
 
        because of a merge.
956
 
 
957
 
        This returns a map of file_id->sha1, containing only files which are
958
 
        still in the working inventory and have that text hash.
959
 
        """
960
 
        try:
961
 
            hashfile = self._transport.get('merge-hashes')
962
 
        except errors.NoSuchFile:
963
 
            return {}
964
 
        try:
965
 
            merge_hashes = {}
966
 
            try:
967
 
                if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
968
 
                    raise errors.MergeModifiedFormatError()
969
 
            except StopIteration:
970
 
                raise errors.MergeModifiedFormatError()
971
 
            for s in RioReader(hashfile):
972
 
                # RioReader reads in Unicode, so convert file_ids back to utf8
973
 
                file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
974
 
                if file_id not in self.inventory:
975
 
                    continue
976
 
                text_hash = s.get("hash")
977
 
                if text_hash == self.get_file_sha1(file_id):
978
 
                    merge_hashes[file_id] = text_hash
979
 
            return merge_hashes
980
 
        finally:
981
 
            hashfile.close()
982
 
 
983
 
    @needs_write_lock
984
 
    def mkdir(self, path, file_id=None):
985
 
        """See MutableTree.mkdir()."""
986
 
        if file_id is None:
987
 
            file_id = generate_ids.gen_file_id(os.path.basename(path))
988
 
        os.mkdir(self.abspath(path))
989
 
        self.add(path, file_id, 'directory')
990
 
        return file_id
991
 
 
992
 
    def get_symlink_target(self, file_id):
993
 
        abspath = self.id2abspath(file_id)
994
 
        target = osutils.readlink(abspath)
995
 
        return target
996
 
 
997
834
    @needs_write_lock
998
835
    def subsume(self, other_tree):
999
836
        def add_children(inventory, entry):
1002
839
                if child_entry.kind == 'directory':
1003
840
                    add_children(inventory, child_entry)
1004
841
        if other_tree.get_root_id() == self.get_root_id():
1005
 
            raise errors.BadSubsumeSource(self, other_tree,
 
842
            raise errors.BadSubsumeSource(self, other_tree, 
1006
843
                                          'Trees have the same root')
1007
844
        try:
1008
845
            other_tree_path = self.relpath(other_tree.basedir)
1009
846
        except errors.PathNotChild:
1010
 
            raise errors.BadSubsumeSource(self, other_tree,
 
847
            raise errors.BadSubsumeSource(self, other_tree, 
1011
848
                'Tree is not contained by the other')
1012
849
        new_root_parent = self.path2id(osutils.dirname(other_tree_path))
1013
850
        if new_root_parent is None:
1014
 
            raise errors.BadSubsumeSource(self, other_tree,
 
851
            raise errors.BadSubsumeSource(self, other_tree, 
1015
852
                'Parent directory is not versioned.')
1016
853
        # We need to ensure that the result of a fetch will have a
1017
854
        # versionedfile for the other_tree root, and only fetching into
1020
857
            raise errors.SubsumeTargetNeedsUpgrade(other_tree)
1021
858
        other_tree.lock_tree_write()
1022
859
        try:
1023
 
            new_parents = other_tree.get_parent_ids()
 
860
            for parent_id in other_tree.get_parent_ids():
 
861
                self.branch.fetch(other_tree.branch, parent_id)
 
862
                self.add_parent_tree_id(parent_id)
1024
863
            other_root = other_tree.inventory.root
1025
864
            other_root.parent_id = new_root_parent
1026
865
            other_root.name = osutils.basename(other_tree_path)
1027
866
            self.inventory.add(other_root)
1028
867
            add_children(self.inventory, other_root)
1029
868
            self._write_inventory(self.inventory)
1030
 
            # normally we don't want to fetch whole repositories, but i think
1031
 
            # here we really do want to consolidate the whole thing.
1032
 
            for parent_id in other_tree.get_parent_ids():
1033
 
                self.branch.fetch(other_tree.branch, parent_id)
1034
 
                self.add_parent_tree_id(parent_id)
1035
869
        finally:
1036
870
            other_tree.unlock()
1037
 
        other_tree.bzrdir.retire_bzrdir()
1038
 
 
1039
 
    def _setup_directory_is_tree_reference(self):
1040
 
        if self._branch.repository._format.supports_tree_reference:
1041
 
            self._directory_is_tree_reference = \
1042
 
                self._directory_may_be_tree_reference
1043
 
        else:
1044
 
            self._directory_is_tree_reference = \
1045
 
                self._directory_is_never_tree_reference
1046
 
 
1047
 
    def _directory_is_never_tree_reference(self, relpath):
1048
 
        return False
1049
 
 
1050
 
    def _directory_may_be_tree_reference(self, relpath):
1051
 
        # as a special case, if a directory contains control files then
1052
 
        # it's a tree reference, except that the root of the tree is not
1053
 
        return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1054
 
        # TODO: We could ask all the control formats whether they
1055
 
        # recognize this directory, but at the moment there's no cheap api
1056
 
        # to do that.  Since we probably can only nest bzr checkouts and
1057
 
        # they always use this name it's ok for now.  -- mbp 20060306
1058
 
        #
1059
 
        # FIXME: There is an unhandled case here of a subdirectory
1060
 
        # containing .bzr but not a branch; that will probably blow up
1061
 
        # when you try to commit it.  It might happen if there is a
1062
 
        # checkout in a subdirectory.  This can be avoided by not adding
1063
 
        # it.  mbp 20070306
 
871
        other_tree.bzrdir.destroy_workingtree_metadata()
1064
872
 
1065
873
    @needs_tree_write_lock
1066
874
    def extract(self, file_id, format=None):
1067
875
        """Extract a subtree from this tree.
1068
 
 
 
876
        
1069
877
        A new branch will be created, relative to the path for this tree.
1070
878
        """
1071
 
        self.flush()
1072
879
        def mkdirs(path):
1073
880
            segments = osutils.splitpath(path)
1074
881
            transport = self.branch.bzrdir.root_transport
1075
882
            for name in segments:
1076
883
                transport = transport.clone(name)
1077
 
                transport.ensure_base()
 
884
                try:
 
885
                    transport.mkdir('.')
 
886
                except errors.FileExists:
 
887
                    pass
1078
888
            return transport
1079
 
 
 
889
            
1080
890
        sub_path = self.id2path(file_id)
1081
891
        branch_transport = mkdirs(sub_path)
1082
892
        if format is None:
1083
 
            format = self.bzrdir.cloning_metadir()
1084
 
        branch_transport.ensure_base()
 
893
            format = bzrdir.format_registry.make_bzrdir('experimental-knit2')
 
894
        try:
 
895
            branch_transport.mkdir('.')
 
896
        except errors.FileExists:
 
897
            pass
1085
898
        branch_bzrdir = format.initialize_on_transport(branch_transport)
1086
899
        try:
1087
900
            repo = branch_bzrdir.find_repository()
1088
901
        except errors.NoRepositoryPresent:
1089
902
            repo = branch_bzrdir.create_repository()
1090
 
        if not repo.supports_rich_root():
1091
 
            raise errors.RootNotRich()
 
903
            assert repo.supports_rich_root()
 
904
        else:
 
905
            if not repo.supports_rich_root():
 
906
                raise errors.RootNotRich()
1092
907
        new_branch = branch_bzrdir.create_branch()
1093
908
        new_branch.pull(self.branch)
1094
909
        for parent_id in self.get_parent_ids():
1096
911
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
1097
912
        if tree_transport.base != branch_transport.base:
1098
913
            tree_bzrdir = format.initialize_on_transport(tree_transport)
1099
 
            branch.BranchReferenceFormat().initialize(tree_bzrdir,
1100
 
                target_branch=new_branch)
 
914
            branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1101
915
        else:
1102
916
            tree_bzrdir = branch_bzrdir
1103
 
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
 
917
        wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1104
918
        wt.set_parent_ids(self.get_parent_ids())
1105
919
        my_inv = self.inventory
1106
 
        child_inv = inventory.Inventory(root_id=None)
 
920
        child_inv = Inventory(root_id=None)
1107
921
        new_root = my_inv[file_id]
1108
922
        my_inv.remove_recursive_id(file_id)
1109
923
        new_root.parent_id = None
1112
926
        wt._write_inventory(child_inv)
1113
927
        return wt
1114
928
 
1115
 
    def _serialize(self, inventory, out_file):
1116
 
        xml5.serializer_v5.write_inventory(self._inventory, out_file,
1117
 
            working=True)
1118
 
 
1119
 
    def _deserialize(selt, in_file):
1120
 
        return xml5.serializer_v5.read_inventory(in_file)
 
929
    @needs_read_lock
 
930
    def merge_modified(self):
 
931
        try:
 
932
            hashfile = self._control_files.get('merge-hashes')
 
933
        except errors.NoSuchFile:
 
934
            return {}
 
935
        merge_hashes = {}
 
936
        try:
 
937
            if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
 
938
                raise errors.MergeModifiedFormatError()
 
939
        except StopIteration:
 
940
            raise errors.MergeModifiedFormatError()
 
941
        for s in RioReader(hashfile):
 
942
            file_id = s.get("file_id")
 
943
            if file_id not in self.inventory:
 
944
                continue
 
945
            hash = s.get("hash")
 
946
            if hash == self.get_file_sha1(file_id):
 
947
                merge_hashes[file_id] = hash
 
948
        return merge_hashes
 
949
 
 
950
    @needs_write_lock
 
951
    def mkdir(self, path, file_id=None):
 
952
        """See MutableTree.mkdir()."""
 
953
        if file_id is None:
 
954
            file_id = generate_ids.gen_file_id(os.path.basename(path))
 
955
        os.mkdir(self.abspath(path))
 
956
        self.add(path, file_id, 'directory')
 
957
        return file_id
 
958
 
 
959
    def get_symlink_target(self, file_id):
 
960
        return os.readlink(self.id2abspath(file_id))
 
961
 
 
962
    def file_class(self, filename):
 
963
        if self.path2id(filename):
 
964
            return 'V'
 
965
        elif self.is_ignored(filename):
 
966
            return 'I'
 
967
        else:
 
968
            return '?'
1121
969
 
1122
970
    def flush(self):
1123
971
        """Write the in memory inventory to disk."""
1127
975
        sio = StringIO()
1128
976
        self._serialize(self._inventory, sio)
1129
977
        sio.seek(0)
1130
 
        self._transport.put_file('inventory', sio,
1131
 
            mode=self.bzrdir._get_file_mode())
 
978
        self._control_files.put('inventory', sio)
1132
979
        self._inventory_is_modified = False
1133
980
 
1134
 
    def _kind(self, relpath):
1135
 
        return osutils.file_kind(self.abspath(relpath))
1136
 
 
1137
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
1138
 
        """List all files as (path, class, kind, id, entry).
 
981
    def _serialize(self, inventory, out_file):
 
982
        xml5.serializer_v5.write_inventory(self._inventory, out_file)
 
983
 
 
984
    def _deserialize(selt, in_file):
 
985
        return xml5.serializer_v5.read_inventory(in_file)
 
986
 
 
987
    def list_files(self, include_root=False):
 
988
        """Recursively list all files as (path, class, kind, id, entry).
1139
989
 
1140
990
        Lists, but does not descend into unversioned directories.
 
991
 
1141
992
        This does not include files that have been deleted in this
1142
 
        tree. Skips the control directory.
 
993
        tree.
1143
994
 
1144
 
        :param include_root: if True, return an entry for the root
1145
 
        :param from_dir: start from this directory or None for the root
1146
 
        :param recursive: whether to recurse into subdirectories or not
 
995
        Skips the control directory.
1147
996
        """
1148
 
        # list_files is an iterator, so @needs_read_lock doesn't work properly
1149
 
        # with it. So callers should be careful to always read_lock the tree.
1150
 
        if not self.is_locked():
1151
 
            raise errors.ObjectNotLocked(self)
1152
 
 
1153
 
        inv = self.inventory
1154
 
        if from_dir is None and include_root is True:
 
997
        inv = self._inventory
 
998
        if include_root is True:
1155
999
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1156
1000
        # Convert these into local objects to save lookup times
1157
1001
        pathjoin = osutils.pathjoin
1158
 
        file_kind = self._kind
 
1002
        file_kind = osutils.file_kind
1159
1003
 
1160
1004
        # transport.base ends in a slash, we want the piece
1161
1005
        # between the last two slashes
1164
1008
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1165
1009
 
1166
1010
        # directory file_id, relative path, absolute path, reverse sorted children
1167
 
        if from_dir is not None:
1168
 
            from_dir_id = inv.path2id(from_dir)
1169
 
            if from_dir_id is None:
1170
 
                # Directory not versioned
1171
 
                return
1172
 
            from_dir_abspath = pathjoin(self.basedir, from_dir)
1173
 
        else:
1174
 
            from_dir_id = inv.root.file_id
1175
 
            from_dir_abspath = self.basedir
1176
 
        children = os.listdir(from_dir_abspath)
 
1011
        children = os.listdir(self.basedir)
1177
1012
        children.sort()
1178
 
        # jam 20060527 The kernel sized tree seems equivalent whether we
 
1013
        # jam 20060527 The kernel sized tree seems equivalent whether we 
1179
1014
        # use a deque and popleft to keep them sorted, or if we use a plain
1180
1015
        # list and just reverse() them.
1181
1016
        children = collections.deque(children)
1182
 
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
 
1017
        stack = [(inv.root.file_id, u'', self.basedir, children)]
1183
1018
        while stack:
1184
1019
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1185
1020
 
1201
1036
 
1202
1037
                # absolute path
1203
1038
                fap = from_dir_abspath + '/' + f
1204
 
 
 
1039
                
1205
1040
                f_ie = inv.get_child(from_dir_id, f)
1206
1041
                if f_ie:
1207
1042
                    c = 'V'
1230
1065
 
1231
1066
                fk = file_kind(fap)
1232
1067
 
 
1068
                if f_ie:
 
1069
                    if f_ie.kind != fk:
 
1070
                        raise errors.BzrCheckError(
 
1071
                            "file %r entered as kind %r id %r, now of kind %r"
 
1072
                            % (fap, f_ie.kind, f_ie.file_id, fk))
 
1073
 
1233
1074
                # make a last minute entry
1234
1075
                if f_ie:
1235
1076
                    yield fp[1:], c, fk, f_ie.file_id, f_ie
1239
1080
                    except KeyError:
1240
1081
                        yield fp[1:], c, fk, None, TreeEntry()
1241
1082
                    continue
1242
 
 
 
1083
                
1243
1084
                if fk != 'directory':
1244
1085
                    continue
1245
1086
 
1246
 
                # But do this child first if recursing down
1247
 
                if recursive:
1248
 
                    new_children = os.listdir(fap)
1249
 
                    new_children.sort()
1250
 
                    new_children = collections.deque(new_children)
1251
 
                    stack.append((f_ie.file_id, fp, fap, new_children))
1252
 
                    # Break out of inner loop,
1253
 
                    # so that we start outer loop with child
1254
 
                    break
 
1087
                # But do this child first
 
1088
                new_children = os.listdir(fap)
 
1089
                new_children.sort()
 
1090
                new_children = collections.deque(new_children)
 
1091
                stack.append((f_ie.file_id, fp, fap, new_children))
 
1092
                # Break out of inner loop,
 
1093
                # so that we start outer loop with child
 
1094
                break
1255
1095
            else:
1256
1096
                # if we finished all children, pop it off the stack
1257
1097
                stack.pop()
1263
1103
        to_dir must exist in the inventory.
1264
1104
 
1265
1105
        If to_dir exists and is a directory, the files are moved into
1266
 
        it, keeping their old names.
 
1106
        it, keeping their old names.  
1267
1107
 
1268
1108
        Note that to_dir is only the last component of the new name;
1269
1109
        this doesn't change the directory.
1306
1146
                                       DeprecationWarning)
1307
1147
 
1308
1148
        # check destination directory
1309
 
        if isinstance(from_paths, basestring):
1310
 
            raise ValueError()
 
1149
        assert not isinstance(from_paths, basestring)
1311
1150
        inv = self.inventory
1312
1151
        to_abs = self.abspath(to_dir)
1313
1152
        if not isdir(to_abs):
1397
1236
                only_change_inv = True
1398
1237
            elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1399
1238
                only_change_inv = False
1400
 
            elif (not self.case_sensitive
1401
 
                  and from_rel.lower() == to_rel.lower()
1402
 
                  and self.has_filename(from_rel)):
1403
 
                only_change_inv = False
1404
1239
            else:
1405
1240
                # something is wrong, so lets determine what exactly
1406
1241
                if not self.has_filename(from_rel) and \
1409
1244
                        errors.PathsDoNotExist(paths=(str(from_rel),
1410
1245
                        str(to_rel))))
1411
1246
                else:
1412
 
                    raise errors.RenameFailedFilesExist(from_rel, to_rel)
 
1247
                    raise errors.RenameFailedFilesExist(from_rel, to_rel,
 
1248
                        extra="(Use --after to update the Bazaar id)")
1413
1249
            rename_entry.only_change_inv = only_change_inv
1414
1250
        return rename_entries
1415
1251
 
1435
1271
        inv = self.inventory
1436
1272
        for entry in moved:
1437
1273
            try:
1438
 
                self._move_entry(WorkingTree._RenameEntry(
1439
 
                    entry.to_rel, entry.from_id,
 
1274
                self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1440
1275
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
1441
1276
                    entry.from_tail, entry.from_parent_id,
1442
1277
                    entry.only_change_inv))
1493
1328
        from_tail = splitpath(from_rel)[-1]
1494
1329
        from_id = inv.path2id(from_rel)
1495
1330
        if from_id is None:
1496
 
            # if file is missing in the inventory maybe it's in the basis_tree
1497
 
            basis_tree = self.branch.basis_tree()
1498
 
            from_id = basis_tree.path2id(from_rel)
1499
 
            if from_id is None:
1500
 
                raise errors.BzrRenameFailedError(from_rel,to_rel,
1501
 
                    errors.NotVersionedError(path=str(from_rel)))
1502
 
            # put entry back in the inventory so we can rename it
1503
 
            from_entry = basis_tree.inventory[from_id].copy()
1504
 
            inv.add(from_entry)
1505
 
        else:
1506
 
            from_entry = inv[from_id]
 
1331
            raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1332
                errors.NotVersionedError(path=str(from_rel)))
 
1333
        from_entry = inv[from_id]
1507
1334
        from_parent_id = from_entry.parent_id
1508
1335
        to_dir, to_tail = os.path.split(to_rel)
1509
1336
        to_dir_id = inv.path2id(to_dir)
1555
1382
        These are files in the working directory that are not versioned or
1556
1383
        control files or ignored.
1557
1384
        """
1558
 
        # force the extras method to be fully executed before returning, to
1559
 
        # prevent race conditions with the lock
1560
 
        return iter(
1561
 
            [subp for subp in self.extras() if not self.is_ignored(subp)])
1562
 
 
 
1385
        for subp in self.extras():
 
1386
            if not self.is_ignored(subp):
 
1387
                yield subp
 
1388
    
1563
1389
    @needs_tree_write_lock
1564
1390
    def unversion(self, file_ids):
1565
1391
        """Remove the file ids in file_ids from the current versioned set.
1571
1397
        :raises: NoSuchId if any fileid is not currently versioned.
1572
1398
        """
1573
1399
        for file_id in file_ids:
1574
 
            if file_id not in self._inventory:
1575
 
                raise errors.NoSuchId(self, file_id)
1576
 
        for file_id in file_ids:
1577
1400
            if self._inventory.has_id(file_id):
1578
1401
                self._inventory.remove_recursive_id(file_id)
 
1402
            else:
 
1403
                raise errors.NoSuchId(self, file_id)
1579
1404
        if len(file_ids):
1580
 
            # in the future this should just set a dirty bit to wait for the
 
1405
            # in the future this should just set a dirty bit to wait for the 
1581
1406
            # final unlock. However, until all methods of workingtree start
1582
 
            # with the current in -memory inventory rather than triggering
 
1407
            # with the current in -memory inventory rather than triggering 
1583
1408
            # a read, it is more complex - we need to teach read_inventory
1584
1409
            # to know when to read, and when to not read first... and possibly
1585
1410
            # to save first when the in memory one may be corrupted.
1586
1411
            # so for now, we just only write it if it is indeed dirty.
1587
1412
            # - RBC 20060907
1588
1413
            self._write_inventory(self._inventory)
 
1414
    
 
1415
    @deprecated_method(zero_eight)
 
1416
    def iter_conflicts(self):
 
1417
        """List all files in the tree that have text or content conflicts.
 
1418
        DEPRECATED.  Use conflicts instead."""
 
1419
        return self._iter_conflicts()
1589
1420
 
1590
1421
    def _iter_conflicts(self):
1591
1422
        conflicted = set()
1599
1430
                yield stem
1600
1431
 
1601
1432
    @needs_write_lock
1602
 
    def pull(self, source, overwrite=False, stop_revision=None,
1603
 
             change_reporter=None, possible_transports=None, local=False):
 
1433
    def pull(self, source, overwrite=False, stop_revision=None):
 
1434
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1604
1435
        source.lock_read()
1605
1436
        try:
 
1437
            pp = ProgressPhase("Pull phase", 2, top_pb)
 
1438
            pp.next_phase()
1606
1439
            old_revision_info = self.branch.last_revision_info()
1607
1440
            basis_tree = self.basis_tree()
1608
 
            count = self.branch.pull(source, overwrite, stop_revision,
1609
 
                                     possible_transports=possible_transports,
1610
 
                                     local=local)
 
1441
            count = self.branch.pull(source, overwrite, stop_revision)
1611
1442
            new_revision_info = self.branch.last_revision_info()
1612
1443
            if new_revision_info != old_revision_info:
 
1444
                pp.next_phase()
1613
1445
                repository = self.branch.repository
1614
 
                basis_tree.lock_read()
 
1446
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
1615
1447
                try:
1616
1448
                    new_basis_tree = self.branch.basis_tree()
1617
1449
                    merge.merge_inner(
1619
1451
                                new_basis_tree,
1620
1452
                                basis_tree,
1621
1453
                                this_tree=self,
1622
 
                                pb=None,
1623
 
                                change_reporter=change_reporter)
1624
 
                    basis_root_id = basis_tree.get_root_id()
1625
 
                    new_root_id = new_basis_tree.get_root_id()
1626
 
                    if basis_root_id != new_root_id:
1627
 
                        self.set_root_id(new_root_id)
 
1454
                                pb=pb)
 
1455
                    if (basis_tree.inventory.root is None and
 
1456
                        new_basis_tree.inventory.root is not None):
 
1457
                        self.set_root_id(new_basis_tree.inventory.root.file_id)
1628
1458
                finally:
1629
 
                    basis_tree.unlock()
 
1459
                    pb.finished()
1630
1460
                # TODO - dedup parents list with things merged by pull ?
1631
1461
                # reuse the revisiontree we merged against to set the new
1632
1462
                # tree data.
1633
1463
                parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1634
 
                # we have to pull the merge trees out again, because
1635
 
                # merge_inner has set the ids. - this corner is not yet
 
1464
                # we have to pull the merge trees out again, because 
 
1465
                # merge_inner has set the ids. - this corner is not yet 
1636
1466
                # layered well enough to prevent double handling.
1637
 
                # XXX TODO: Fix the double handling: telling the tree about
1638
 
                # the already known parent data is wasteful.
1639
1467
                merges = self.get_parent_ids()[1:]
1640
1468
                parent_trees.extend([
1641
1469
                    (parent, repository.revision_tree(parent)) for
1644
1472
            return count
1645
1473
        finally:
1646
1474
            source.unlock()
 
1475
            top_pb.finished()
1647
1476
 
1648
1477
    @needs_write_lock
1649
1478
    def put_file_bytes_non_atomic(self, file_id, bytes):
1656
1485
        # TODO: update the hashcache here ?
1657
1486
 
1658
1487
    def extras(self):
1659
 
        """Yield all unversioned files in this WorkingTree.
 
1488
        """Yield all unknown files in this WorkingTree.
1660
1489
 
1661
 
        If there are any unversioned directories then only the directory is
1662
 
        returned, not all its children.  But if there are unversioned files
 
1490
        If there are any unknown directories then only the directory is
 
1491
        returned, not all its children.  But if there are unknown files
1663
1492
        under a versioned subdirectory, they are returned.
1664
1493
 
1665
1494
        Currently returned depth-first, sorted by name within directories.
1666
 
        This is the same order used by 'osutils.walkdirs'.
1667
1495
        """
1668
1496
        ## TODO: Work from given directory downwards
1669
1497
        for path, dir_entry in self.inventory.directories():
1675
1503
 
1676
1504
            fl = []
1677
1505
            for subf in os.listdir(dirabs):
1678
 
                if self.bzrdir.is_control_filename(subf):
 
1506
                if subf == '.bzr':
1679
1507
                    continue
1680
1508
                if subf not in dir_entry.children:
1681
 
                    try:
1682
 
                        (subf_norm,
1683
 
                         can_access) = osutils.normalized_filename(subf)
1684
 
                    except UnicodeDecodeError:
1685
 
                        path_os_enc = path.encode(osutils._fs_enc)
1686
 
                        relpath = path_os_enc + '/' + subf
1687
 
                        raise errors.BadFilenameEncoding(relpath,
1688
 
                                                         osutils._fs_enc)
 
1509
                    subf_norm, can_access = osutils.normalized_filename(subf)
1689
1510
                    if subf_norm != subf and can_access:
1690
1511
                        if subf_norm not in dir_entry.children:
1691
1512
                            fl.append(subf_norm)
1692
1513
                    else:
1693
1514
                        fl.append(subf)
1694
 
 
 
1515
            
1695
1516
            fl.sort()
1696
1517
            for subf in fl:
1697
1518
                subp = pathjoin(path, subf)
1698
1519
                yield subp
1699
1520
 
 
1521
 
1700
1522
    def ignored_files(self):
1701
1523
        """Yield list of PATH, IGNORE_PATTERN"""
1702
1524
        for subp in self.extras():
1713
1535
        if ignoreset is not None:
1714
1536
            return ignoreset
1715
1537
 
1716
 
        ignore_globs = set()
 
1538
        ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1717
1539
        ignore_globs.update(ignores.get_runtime_ignores())
1718
1540
        ignore_globs.update(ignores.get_user_ignores())
1719
1541
        if self.has_filename(bzrlib.IGNORE_FILENAME):
1734
1556
        r"""Check whether the filename matches an ignore pattern.
1735
1557
 
1736
1558
        Patterns containing '/' or '\' need to match the whole path;
1737
 
        others match against only the last component.  Patterns starting
1738
 
        with '!' are ignore exceptions.  Exceptions take precedence
1739
 
        over regular patterns and cause the filename to not be ignored.
 
1559
        others match against only the last component.
1740
1560
 
1741
1561
        If the file is ignored, returns the pattern which caused it to
1742
1562
        be ignored, otherwise None.  So this can simply be used as a
1743
1563
        boolean if desired."""
1744
1564
        if getattr(self, '_ignoreglobster', None) is None:
1745
 
            self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
 
1565
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1746
1566
        return self._ignoreglobster.match(filename)
1747
1567
 
1748
1568
    def kind(self, file_id):
1749
1569
        return file_kind(self.id2abspath(file_id))
1750
1570
 
1751
 
    def stored_kind(self, file_id):
1752
 
        """See Tree.stored_kind"""
1753
 
        return self.inventory[file_id].kind
1754
 
 
1755
1571
    def _comparison_data(self, entry, path):
1756
1572
        abspath = self.abspath(path)
1757
1573
        try:
1767
1583
            mode = stat_value.st_mode
1768
1584
            kind = osutils.file_kind_from_stat_mode(mode)
1769
1585
            if not supports_executable():
1770
 
                executable = entry is not None and entry.executable
 
1586
                executable = entry.executable
1771
1587
            else:
1772
1588
                executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1773
1589
        return kind, executable, stat_value
1788
1604
    @needs_read_lock
1789
1605
    def _last_revision(self):
1790
1606
        """helper for get_parent_ids."""
1791
 
        return _mod_revision.ensure_null(self.branch.last_revision())
 
1607
        return self.branch.last_revision()
1792
1608
 
1793
1609
    def is_locked(self):
1794
1610
        return self._control_files.is_locked()
1795
1611
 
1796
 
    def _must_be_locked(self):
1797
 
        if not self.is_locked():
1798
 
            raise errors.ObjectNotLocked(self)
1799
 
 
1800
1612
    def lock_read(self):
1801
1613
        """See Branch.lock_read, and WorkingTree.unlock."""
1802
 
        if not self.is_locked():
1803
 
            self._reset_data()
1804
1614
        self.branch.lock_read()
1805
1615
        try:
1806
1616
            return self._control_files.lock_read()
1810
1620
 
1811
1621
    def lock_tree_write(self):
1812
1622
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1813
 
        if not self.is_locked():
1814
 
            self._reset_data()
1815
1623
        self.branch.lock_read()
1816
1624
        try:
1817
1625
            return self._control_files.lock_write()
1821
1629
 
1822
1630
    def lock_write(self):
1823
1631
        """See MutableTree.lock_write, and WorkingTree.unlock."""
1824
 
        if not self.is_locked():
1825
 
            self._reset_data()
1826
1632
        self.branch.lock_write()
1827
1633
        try:
1828
1634
            return self._control_files.lock_write()
1836
1642
    def _basis_inventory_name(self):
1837
1643
        return 'basis-inventory-cache'
1838
1644
 
1839
 
    def _reset_data(self):
1840
 
        """Reset transient data that cannot be revalidated."""
1841
 
        self._inventory_is_modified = False
1842
 
        f = self._transport.get('inventory')
1843
 
        try:
1844
 
            result = self._deserialize(f)
1845
 
        finally:
1846
 
            f.close()
1847
 
        self._set_inventory(result, dirty=False)
1848
 
 
1849
1645
    @needs_tree_write_lock
1850
1646
    def set_last_revision(self, new_revision):
1851
1647
        """Change the last revision in the working tree."""
1854
1650
 
1855
1651
    def _change_last_revision(self, new_revision):
1856
1652
        """Template method part of set_last_revision to perform the change.
1857
 
 
 
1653
        
1858
1654
        This is used to allow WorkingTree3 instances to not affect branch
1859
1655
        when their last revision is set.
1860
1656
        """
1861
 
        if _mod_revision.is_null(new_revision):
 
1657
        if new_revision is None:
1862
1658
            self.branch.set_revision_history([])
1863
1659
            return False
1864
1660
        try:
1870
1666
 
1871
1667
    def _write_basis_inventory(self, xml):
1872
1668
        """Write the basis inventory XML to the basis-inventory file"""
 
1669
        assert isinstance(xml, str), 'serialised xml must be bytestring.'
1873
1670
        path = self._basis_inventory_name()
1874
1671
        sio = StringIO(xml)
1875
 
        self._transport.put_file(path, sio,
1876
 
            mode=self.bzrdir._get_file_mode())
 
1672
        self._control_files.put(path, sio)
1877
1673
 
1878
1674
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
1879
1675
        """Create the text that will be saved in basis-inventory"""
1886
1682
        # as commit already has that ready-to-use [while the format is the
1887
1683
        # same, that is].
1888
1684
        try:
1889
 
            # this double handles the inventory - unpack and repack -
 
1685
            # this double handles the inventory - unpack and repack - 
1890
1686
            # but is easier to understand. We can/should put a conditional
1891
1687
            # in here based on whether the inventory is in the latest format
1892
1688
            # - perhaps we should repack all inventories on a repository
1893
1689
            # upgrade ?
1894
1690
            # the fast path is to copy the raw xml from the repository. If the
1895
 
            # xml contains 'revision_id="', then we assume the right
 
1691
            # xml contains 'revision_id="', then we assume the right 
1896
1692
            # revision_id is set. We must check for this full string, because a
1897
1693
            # root node id can legitimately look like 'revision_id' but cannot
1898
1694
            # contain a '"'.
1899
 
            xml = self.branch.repository._get_inventory_xml(new_revision)
 
1695
            xml = self.branch.repository.get_inventory_xml(new_revision)
1900
1696
            firstline = xml.split('\n', 1)[0]
1901
 
            if (not 'revision_id="' in firstline or
 
1697
            if (not 'revision_id="' in firstline or 
1902
1698
                'format="7"' not in firstline):
1903
 
                inv = self.branch.repository._serializer.read_inventory_from_string(
1904
 
                    xml, new_revision)
 
1699
                inv = self.branch.repository.deserialise_inventory(
 
1700
                    new_revision, xml)
1905
1701
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
1906
1702
            self._write_basis_inventory(xml)
1907
1703
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1910
1706
    def read_basis_inventory(self):
1911
1707
        """Read the cached basis inventory."""
1912
1708
        path = self._basis_inventory_name()
1913
 
        return self._transport.get_bytes(path)
1914
 
 
 
1709
        return self._control_files.get(path).read()
 
1710
        
1915
1711
    @needs_read_lock
1916
1712
    def read_working_inventory(self):
1917
1713
        """Read the working inventory.
1918
 
 
 
1714
        
1919
1715
        :raises errors.InventoryModified: read_working_inventory will fail
1920
1716
            when the current in memory inventory has been modified.
1921
1717
        """
1922
 
        # conceptually this should be an implementation detail of the tree.
 
1718
        # conceptually this should be an implementation detail of the tree. 
1923
1719
        # XXX: Deprecate this.
1924
1720
        # ElementTree does its own conversion from UTF-8, so open in
1925
1721
        # binary.
1926
1722
        if self._inventory_is_modified:
1927
1723
            raise errors.InventoryModified(self)
1928
 
        f = self._transport.get('inventory')
1929
 
        try:
1930
 
            result = self._deserialize(f)
1931
 
        finally:
1932
 
            f.close()
 
1724
        result = self._deserialize(self._control_files.get('inventory'))
1933
1725
        self._set_inventory(result, dirty=False)
1934
1726
        return result
1935
1727
 
1936
1728
    @needs_tree_write_lock
1937
 
    def remove(self, files, verbose=False, to_file=None, keep_files=True,
1938
 
        force=False):
1939
 
        """Remove nominated files from the working inventory.
1940
 
 
1941
 
        :files: File paths relative to the basedir.
1942
 
        :keep_files: If true, the files will also be kept.
1943
 
        :force: Delete files and directories, even if they are changed and
1944
 
            even if the directories are not empty.
 
1729
    def remove(self, files, verbose=False, to_file=None):
 
1730
        """Remove nominated files from the working inventory..
 
1731
 
 
1732
        This does not remove their text.  This does not run on XXX on what? RBC
 
1733
 
 
1734
        TODO: Refuse to remove modified files unless --force is given?
 
1735
 
 
1736
        TODO: Do something useful with directories.
 
1737
 
 
1738
        TODO: Should this remove the text or not?  Tough call; not
 
1739
        removing may be useful and the user can just use use rm, and
 
1740
        is the opposite of add.  Removing it is consistent with most
 
1741
        other tools.  Maybe an option.
1945
1742
        """
 
1743
        ## TODO: Normalize names
 
1744
        ## TODO: Remove nested loops; better scalability
1946
1745
        if isinstance(files, basestring):
1947
1746
            files = [files]
1948
1747
 
1949
 
        inv_delta = []
1950
 
 
1951
 
        new_files=set()
1952
 
        unknown_nested_files=set()
1953
 
        if to_file is None:
1954
 
            to_file = sys.stdout
1955
 
 
1956
 
        def recurse_directory_to_add_files(directory):
1957
 
            # Recurse directory and add all files
1958
 
            # so we can check if they have changed.
1959
 
            for parent_info, file_infos in\
1960
 
                self.walkdirs(directory):
1961
 
                for relpath, basename, kind, lstat, fileid, kind in file_infos:
1962
 
                    # Is it versioned or ignored?
1963
 
                    if self.path2id(relpath) or self.is_ignored(relpath):
1964
 
                        # Add nested content for deletion.
1965
 
                        new_files.add(relpath)
1966
 
                    else:
1967
 
                        # Files which are not versioned and not ignored
1968
 
                        # should be treated as unknown.
1969
 
                        unknown_nested_files.add((relpath, None, kind))
1970
 
 
1971
 
        for filename in files:
1972
 
            # Get file name into canonical form.
1973
 
            abspath = self.abspath(filename)
1974
 
            filename = self.relpath(abspath)
1975
 
            if len(filename) > 0:
1976
 
                new_files.add(filename)
1977
 
                recurse_directory_to_add_files(filename)
1978
 
 
1979
 
        files = list(new_files)
1980
 
 
1981
 
        if len(files) == 0:
1982
 
            return # nothing to do
1983
 
 
1984
 
        # Sort needed to first handle directory content before the directory
1985
 
        files.sort(reverse=True)
1986
 
 
1987
 
        # Bail out if we are going to delete files we shouldn't
1988
 
        if not keep_files and not force:
1989
 
            has_changed_files = len(unknown_nested_files) > 0
1990
 
            if not has_changed_files:
1991
 
                for (file_id, path, content_change, versioned, parent_id, name,
1992
 
                     kind, executable) in self.iter_changes(self.basis_tree(),
1993
 
                         include_unchanged=True, require_versioned=False,
1994
 
                         want_unversioned=True, specific_files=files):
1995
 
                    if versioned == (False, False):
1996
 
                        # The record is unknown ...
1997
 
                        if not self.is_ignored(path[1]):
1998
 
                            # ... but not ignored
1999
 
                            has_changed_files = True
2000
 
                            break
2001
 
                    elif content_change and (kind[1] is not None):
2002
 
                        # Versioned and changed, but not deleted
2003
 
                        has_changed_files = True
2004
 
                        break
2005
 
 
2006
 
            if has_changed_files:
2007
 
                # Make delta show ALL applicable changes in error message.
2008
 
                tree_delta = self.changes_from(self.basis_tree(),
2009
 
                    require_versioned=False, want_unversioned=True,
2010
 
                    specific_files=files)
2011
 
                for unknown_file in unknown_nested_files:
2012
 
                    if unknown_file not in tree_delta.unversioned:
2013
 
                        tree_delta.unversioned.extend((unknown_file,))
2014
 
                raise errors.BzrRemoveChangedFilesError(tree_delta)
2015
 
 
2016
 
        # Build inv_delta and delete files where applicable,
2017
 
        # do this before any modifications to inventory.
 
1748
        inv = self.inventory
 
1749
 
 
1750
        # do this before any modifications
2018
1751
        for f in files:
2019
 
            fid = self.path2id(f)
2020
 
            message = None
 
1752
            fid = inv.path2id(f)
2021
1753
            if not fid:
2022
 
                message = "%s is not versioned." % (f,)
 
1754
                note("%s is not versioned."%f)
2023
1755
            else:
2024
1756
                if verbose:
2025
 
                    # having removed it, it must be either ignored or unknown
 
1757
                    # having remove it, it must be either ignored or unknown
2026
1758
                    if self.is_ignored(f):
2027
1759
                        new_status = 'I'
2028
1760
                    else:
2029
1761
                        new_status = '?'
2030
 
                    # XXX: Really should be a more abstract reporter interface
2031
 
                    kind_ch = osutils.kind_marker(self.kind(fid))
2032
 
                    to_file.write(new_status + '       ' + f + kind_ch + '\n')
2033
 
                # Unversion file
2034
 
                inv_delta.append((f, None, fid, None))
2035
 
                message = "removed %s" % (f,)
2036
 
 
2037
 
            if not keep_files:
2038
 
                abs_path = self.abspath(f)
2039
 
                if osutils.lexists(abs_path):
2040
 
                    if (osutils.isdir(abs_path) and
2041
 
                        len(os.listdir(abs_path)) > 0):
2042
 
                        if force:
2043
 
                            osutils.rmtree(abs_path)
2044
 
                        else:
2045
 
                            message = "%s is not an empty directory "\
2046
 
                                "and won't be deleted." % (f,)
2047
 
                    else:
2048
 
                        osutils.delete_any(abs_path)
2049
 
                        message = "deleted %s" % (f,)
2050
 
                elif message is not None:
2051
 
                    # Only care if we haven't done anything yet.
2052
 
                    message = "%s does not exist." % (f,)
2053
 
 
2054
 
            # Print only one message (if any) per file.
2055
 
            if message is not None:
2056
 
                note(message)
2057
 
        self.apply_inventory_delta(inv_delta)
 
1762
                    textui.show_status(new_status, inv[fid].kind, f,
 
1763
                                       to_file=to_file)
 
1764
                del inv[fid]
 
1765
 
 
1766
        self._write_inventory(inv)
2058
1767
 
2059
1768
    @needs_tree_write_lock
2060
 
    def revert(self, filenames=None, old_tree=None, backups=True,
2061
 
               pb=None, report_changes=False):
 
1769
    def revert(self, filenames, old_tree=None, backups=True, 
 
1770
               pb=DummyProgress(), report_changes=False):
2062
1771
        from bzrlib.conflicts import resolve
2063
 
        if filenames == []:
2064
 
            filenames = None
2065
 
            symbol_versioning.warn('Using [] to revert all files is deprecated'
2066
 
                ' as of bzr 0.91.  Please use None (the default) instead.',
2067
 
                DeprecationWarning, stacklevel=2)
2068
1772
        if old_tree is None:
2069
 
            basis_tree = self.basis_tree()
2070
 
            basis_tree.lock_read()
2071
 
            old_tree = basis_tree
 
1773
            old_tree = self.basis_tree()
 
1774
        conflicts = transform.revert(self, old_tree, filenames, backups, pb,
 
1775
                                     report_changes)
 
1776
        if not len(filenames):
 
1777
            self.set_parent_ids(self.get_parent_ids()[:1])
 
1778
            resolve(self)
2072
1779
        else:
2073
 
            basis_tree = None
2074
 
        try:
2075
 
            conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2076
 
                                         report_changes)
2077
 
            if filenames is None and len(self.get_parent_ids()) > 1:
2078
 
                parent_trees = []
2079
 
                last_revision = self.last_revision()
2080
 
                if last_revision != _mod_revision.NULL_REVISION:
2081
 
                    if basis_tree is None:
2082
 
                        basis_tree = self.basis_tree()
2083
 
                        basis_tree.lock_read()
2084
 
                    parent_trees.append((last_revision, basis_tree))
2085
 
                self.set_parent_trees(parent_trees)
2086
 
                resolve(self)
2087
 
            else:
2088
 
                resolve(self, filenames, ignore_misses=True, recursive=True)
2089
 
        finally:
2090
 
            if basis_tree is not None:
2091
 
                basis_tree.unlock()
 
1780
            resolve(self, filenames, ignore_misses=True)
2092
1781
        return conflicts
2093
1782
 
2094
 
    def revision_tree(self, revision_id):
2095
 
        """See Tree.revision_tree.
2096
 
 
2097
 
        WorkingTree can supply revision_trees for the basis revision only
2098
 
        because there is only one cached inventory in the bzr directory.
2099
 
        """
2100
 
        if revision_id == self.last_revision():
2101
 
            try:
2102
 
                xml = self.read_basis_inventory()
2103
 
            except errors.NoSuchFile:
2104
 
                pass
2105
 
            else:
2106
 
                try:
2107
 
                    inv = xml7.serializer_v7.read_inventory_from_string(xml)
2108
 
                    # dont use the repository revision_tree api because we want
2109
 
                    # to supply the inventory.
2110
 
                    if inv.revision_id == revision_id:
2111
 
                        return revisiontree.RevisionTree(self.branch.repository,
2112
 
                            inv, revision_id)
2113
 
                except errors.BadInventoryFormat:
2114
 
                    pass
2115
 
        # raise if there was no inventory, or if we read the wrong inventory.
2116
 
        raise errors.NoSuchRevisionInTree(self, revision_id)
2117
 
 
2118
1783
    # XXX: This method should be deprecated in favour of taking in a proper
2119
1784
    # new Inventory object.
2120
1785
    @needs_tree_write_lock
2121
1786
    def set_inventory(self, new_inventory_list):
2122
1787
        from bzrlib.inventory import (Inventory,
2123
1788
                                      InventoryDirectory,
 
1789
                                      InventoryEntry,
2124
1790
                                      InventoryFile,
2125
1791
                                      InventoryLink)
2126
1792
        inv = Inventory(self.get_root_id())
2128
1794
            name = os.path.basename(path)
2129
1795
            if name == "":
2130
1796
                continue
2131
 
            # fixme, there should be a factory function inv,add_??
 
1797
            # fixme, there should be a factory function inv,add_?? 
2132
1798
            if kind == 'directory':
2133
1799
                inv.add(InventoryDirectory(file_id, name, parent))
2134
1800
            elif kind == 'file':
2142
1808
    @needs_tree_write_lock
2143
1809
    def set_root_id(self, file_id):
2144
1810
        """Set the root id for this tree."""
2145
 
        # for compatability
 
1811
        # for compatability 
2146
1812
        if file_id is None:
2147
 
            raise ValueError(
2148
 
                'WorkingTree.set_root_id with fileid=None')
2149
 
        file_id = osutils.safe_file_id(file_id)
2150
 
        self._set_root_id(file_id)
2151
 
 
2152
 
    def _set_root_id(self, file_id):
2153
 
        """Set the root id for this tree, in a format specific manner.
2154
 
 
2155
 
        :param file_id: The file id to assign to the root. It must not be
2156
 
            present in the current inventory or an error will occur. It must
2157
 
            not be None, but rather a valid file id.
2158
 
        """
 
1813
            symbol_versioning.warn(symbol_versioning.zero_twelve
 
1814
                % 'WorkingTree.set_root_id with fileid=None',
 
1815
                DeprecationWarning,
 
1816
                stacklevel=3)
 
1817
            file_id = ROOT_ID
2159
1818
        inv = self._inventory
2160
1819
        orig_root_id = inv.root.file_id
2161
1820
        # TODO: it might be nice to exit early if there was nothing
2177
1836
 
2178
1837
    def unlock(self):
2179
1838
        """See Branch.unlock.
2180
 
 
 
1839
        
2181
1840
        WorkingTree locking just uses the Branch locking facilities.
2182
1841
        This is current because all working trees have an embedded branch
2183
1842
        within them. IF in the future, we were to make branch data shareable
2184
 
        between multiple working trees, i.e. via shared storage, then we
 
1843
        between multiple working trees, i.e. via shared storage, then we 
2185
1844
        would probably want to lock both the local tree, and the branch.
2186
1845
        """
2187
1846
        raise NotImplementedError(self.unlock)
2188
1847
 
2189
 
    _marker = object()
2190
 
 
2191
 
    def update(self, change_reporter=None, possible_transports=None,
2192
 
               revision=None, old_tip=_marker):
 
1848
    def update(self):
2193
1849
        """Update a working tree along its branch.
2194
1850
 
2195
1851
        This will update the branch if its bound too, which means we have
2213
1869
        - Merge current state -> basis tree of the master w.r.t. the old tree
2214
1870
          basis.
2215
1871
        - Do a 'normal' merge of the old branch basis if it is relevant.
2216
 
 
2217
 
        :param revision: The target revision to update to. Must be in the
2218
 
            revision history.
2219
 
        :param old_tip: If branch.update() has already been run, the value it
2220
 
            returned (old tip of the branch or None). _marker is used
2221
 
            otherwise.
2222
1872
        """
2223
 
        if self.branch.get_bound_location() is not None:
 
1873
        if self.branch.get_master_branch() is not None:
2224
1874
            self.lock_write()
2225
 
            update_branch = (old_tip is self._marker)
 
1875
            update_branch = True
2226
1876
        else:
2227
1877
            self.lock_tree_write()
2228
1878
            update_branch = False
2229
1879
        try:
2230
1880
            if update_branch:
2231
 
                old_tip = self.branch.update(possible_transports)
 
1881
                old_tip = self.branch.update()
2232
1882
            else:
2233
 
                if old_tip is self._marker:
2234
 
                    old_tip = None
2235
 
            return self._update_tree(old_tip, change_reporter, revision)
 
1883
                old_tip = None
 
1884
            return self._update_tree(old_tip)
2236
1885
        finally:
2237
1886
            self.unlock()
2238
1887
 
2239
1888
    @needs_tree_write_lock
2240
 
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
 
1889
    def _update_tree(self, old_tip=None):
2241
1890
        """Update a tree to the master branch.
2242
1891
 
2243
1892
        :param old_tip: if supplied, the previous tip revision the branch,
2249
1898
        # cant set that until we update the working trees last revision to be
2250
1899
        # one from the new branch, because it will just get absorbed by the
2251
1900
        # parent de-duplication logic.
2252
 
        #
 
1901
        # 
2253
1902
        # We MUST save it even if an error occurs, because otherwise the users
2254
1903
        # local work is unreferenced and will appear to have been lost.
2255
 
        #
2256
 
        nb_conflicts = 0
 
1904
        # 
 
1905
        result = 0
2257
1906
        try:
2258
1907
            last_rev = self.get_parent_ids()[0]
2259
1908
        except IndexError:
2260
 
            last_rev = _mod_revision.NULL_REVISION
2261
 
        if revision is None:
2262
 
            revision = self.branch.last_revision()
2263
 
 
2264
 
        old_tip = old_tip or _mod_revision.NULL_REVISION
2265
 
 
2266
 
        if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2267
 
            # the branch we are bound to was updated
2268
 
            # merge those changes in first
2269
 
            base_tree  = self.basis_tree()
2270
 
            other_tree = self.branch.repository.revision_tree(old_tip)
2271
 
            nb_conflicts = merge.merge_inner(self.branch, other_tree,
2272
 
                                             base_tree, this_tree=self,
2273
 
                                             change_reporter=change_reporter)
2274
 
            if nb_conflicts:
2275
 
                self.add_parent_tree((old_tip, other_tree))
2276
 
                trace.note('Rerun update after fixing the conflicts.')
2277
 
                return nb_conflicts
2278
 
 
2279
 
        if last_rev != _mod_revision.ensure_null(revision):
2280
 
            # the working tree is up to date with the branch
2281
 
            # we can merge the specified revision from master
2282
 
            to_tree = self.branch.repository.revision_tree(revision)
2283
 
            to_root_id = to_tree.get_root_id()
2284
 
 
 
1909
            last_rev = None
 
1910
        if last_rev != self.branch.last_revision():
 
1911
            # merge tree state up to new branch tip.
2285
1912
            basis = self.basis_tree()
2286
 
            basis.lock_read()
2287
 
            try:
2288
 
                if (basis.inventory.root is None
2289
 
                    or basis.inventory.root.file_id != to_root_id):
2290
 
                    self.set_root_id(to_root_id)
2291
 
                    self.flush()
2292
 
            finally:
2293
 
                basis.unlock()
2294
 
 
2295
 
            # determine the branch point
2296
 
            graph = self.branch.repository.get_graph()
2297
 
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2298
 
                                                last_rev)
2299
 
            base_tree = self.branch.repository.revision_tree(base_rev_id)
2300
 
 
2301
 
            nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2302
 
                                             this_tree=self,
2303
 
                                             change_reporter=change_reporter)
2304
 
            self.set_last_revision(revision)
 
1913
            to_tree = self.branch.basis_tree()
 
1914
            if basis.inventory.root is None:
 
1915
                self.set_root_id(to_tree.inventory.root.file_id)
 
1916
            result += merge.merge_inner(
 
1917
                                  self.branch,
 
1918
                                  to_tree,
 
1919
                                  basis,
 
1920
                                  this_tree=self)
2305
1921
            # TODO - dedup parents list with things merged by pull ?
2306
1922
            # reuse the tree we've updated to to set the basis:
2307
 
            parent_trees = [(revision, to_tree)]
 
1923
            parent_trees = [(self.branch.last_revision(), to_tree)]
2308
1924
            merges = self.get_parent_ids()[1:]
2309
1925
            # Ideally we ask the tree for the trees here, that way the working
2310
 
            # tree can decide whether to give us the entire tree or give us a
 
1926
            # tree can decide whether to give us teh entire tree or give us a
2311
1927
            # lazy initialised tree. dirstate for instance will have the trees
2312
1928
            # in ram already, whereas a last-revision + basis-inventory tree
2313
1929
            # will not, but also does not need them when setting parents.
2314
1930
            for parent in merges:
2315
1931
                parent_trees.append(
2316
1932
                    (parent, self.branch.repository.revision_tree(parent)))
2317
 
            if not _mod_revision.is_null(old_tip):
 
1933
            if old_tip is not None:
2318
1934
                parent_trees.append(
2319
1935
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
2320
1936
            self.set_parent_trees(parent_trees)
2321
1937
            last_rev = parent_trees[0][0]
2322
 
        return nb_conflicts
 
1938
        else:
 
1939
            # the working tree had the same last-revision as the master
 
1940
            # branch did. We may still have pivot local work from the local
 
1941
            # branch into old_tip:
 
1942
            if old_tip is not None:
 
1943
                self.add_parent_tree_id(old_tip)
 
1944
        if old_tip and old_tip != last_rev:
 
1945
            # our last revision was not the prior branch last revision
 
1946
            # and we have converted that last revision to a pending merge.
 
1947
            # base is somewhere between the branch tip now
 
1948
            # and the now pending merge
 
1949
            from bzrlib.revision import common_ancestor
 
1950
            try:
 
1951
                base_rev_id = common_ancestor(self.branch.last_revision(),
 
1952
                                              old_tip,
 
1953
                                              self.branch.repository)
 
1954
            except errors.NoCommonAncestor:
 
1955
                base_rev_id = None
 
1956
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
1957
            other_tree = self.branch.repository.revision_tree(old_tip)
 
1958
            result += merge.merge_inner(
 
1959
                                  self.branch,
 
1960
                                  other_tree,
 
1961
                                  base_tree,
 
1962
                                  this_tree=self)
 
1963
        return result
2323
1964
 
2324
1965
    def _write_hashcache_if_dirty(self):
2325
1966
        """Write out the hashcache if it is dirty."""
2373
2014
                             file_id=self.path2id(conflicted)))
2374
2015
        return conflicts
2375
2016
 
2376
 
    def walkdirs(self, prefix=""):
2377
 
        """Walk the directories of this tree.
2378
 
 
2379
 
        returns a generator which yields items in the form:
2380
 
                ((curren_directory_path, fileid),
2381
 
                 [(file1_path, file1_name, file1_kind, (lstat), file1_id,
2382
 
                   file1_kind), ... ])
2383
 
 
2384
 
        This API returns a generator, which is only valid during the current
2385
 
        tree transaction - within a single lock_read or lock_write duration.
2386
 
 
2387
 
        If the tree is not locked, it may cause an error to be raised,
2388
 
        depending on the tree implementation.
2389
 
        """
2390
 
        disk_top = self.abspath(prefix)
2391
 
        if disk_top.endswith('/'):
2392
 
            disk_top = disk_top[:-1]
2393
 
        top_strip_len = len(disk_top) + 1
2394
 
        inventory_iterator = self._walkdirs(prefix)
2395
 
        disk_iterator = osutils.walkdirs(disk_top, prefix)
2396
 
        try:
2397
 
            current_disk = disk_iterator.next()
2398
 
            disk_finished = False
2399
 
        except OSError, e:
2400
 
            if not (e.errno == errno.ENOENT or
2401
 
                (sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2402
 
                raise
2403
 
            current_disk = None
2404
 
            disk_finished = True
2405
 
        try:
2406
 
            current_inv = inventory_iterator.next()
2407
 
            inv_finished = False
2408
 
        except StopIteration:
2409
 
            current_inv = None
2410
 
            inv_finished = True
2411
 
        while not inv_finished or not disk_finished:
2412
 
            if current_disk:
2413
 
                ((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2414
 
                    cur_disk_dir_content) = current_disk
2415
 
            else:
2416
 
                ((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2417
 
                    cur_disk_dir_content) = ((None, None), None)
2418
 
            if not disk_finished:
2419
 
                # strip out .bzr dirs
2420
 
                if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2421
 
                    len(cur_disk_dir_content) > 0):
2422
 
                    # osutils.walkdirs can be made nicer -
2423
 
                    # yield the path-from-prefix rather than the pathjoined
2424
 
                    # value.
2425
 
                    bzrdir_loc = bisect_left(cur_disk_dir_content,
2426
 
                        ('.bzr', '.bzr'))
2427
 
                    if (bzrdir_loc < len(cur_disk_dir_content)
2428
 
                        and self.bzrdir.is_control_filename(
2429
 
                            cur_disk_dir_content[bzrdir_loc][0])):
2430
 
                        # we dont yield the contents of, or, .bzr itself.
2431
 
                        del cur_disk_dir_content[bzrdir_loc]
2432
 
            if inv_finished:
2433
 
                # everything is unknown
2434
 
                direction = 1
2435
 
            elif disk_finished:
2436
 
                # everything is missing
2437
 
                direction = -1
2438
 
            else:
2439
 
                direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2440
 
            if direction > 0:
2441
 
                # disk is before inventory - unknown
2442
 
                dirblock = [(relpath, basename, kind, stat, None, None) for
2443
 
                    relpath, basename, kind, stat, top_path in
2444
 
                    cur_disk_dir_content]
2445
 
                yield (cur_disk_dir_relpath, None), dirblock
2446
 
                try:
2447
 
                    current_disk = disk_iterator.next()
2448
 
                except StopIteration:
2449
 
                    disk_finished = True
2450
 
            elif direction < 0:
2451
 
                # inventory is before disk - missing.
2452
 
                dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2453
 
                    for relpath, basename, dkind, stat, fileid, kind in
2454
 
                    current_inv[1]]
2455
 
                yield (current_inv[0][0], current_inv[0][1]), dirblock
2456
 
                try:
2457
 
                    current_inv = inventory_iterator.next()
2458
 
                except StopIteration:
2459
 
                    inv_finished = True
2460
 
            else:
2461
 
                # versioned present directory
2462
 
                # merge the inventory and disk data together
2463
 
                dirblock = []
2464
 
                for relpath, subiterator in itertools.groupby(sorted(
2465
 
                    current_inv[1] + cur_disk_dir_content,
2466
 
                    key=operator.itemgetter(0)), operator.itemgetter(1)):
2467
 
                    path_elements = list(subiterator)
2468
 
                    if len(path_elements) == 2:
2469
 
                        inv_row, disk_row = path_elements
2470
 
                        # versioned, present file
2471
 
                        dirblock.append((inv_row[0],
2472
 
                            inv_row[1], disk_row[2],
2473
 
                            disk_row[3], inv_row[4],
2474
 
                            inv_row[5]))
2475
 
                    elif len(path_elements[0]) == 5:
2476
 
                        # unknown disk file
2477
 
                        dirblock.append((path_elements[0][0],
2478
 
                            path_elements[0][1], path_elements[0][2],
2479
 
                            path_elements[0][3], None, None))
2480
 
                    elif len(path_elements[0]) == 6:
2481
 
                        # versioned, absent file.
2482
 
                        dirblock.append((path_elements[0][0],
2483
 
                            path_elements[0][1], 'unknown', None,
2484
 
                            path_elements[0][4], path_elements[0][5]))
2485
 
                    else:
2486
 
                        raise NotImplementedError('unreachable code')
2487
 
                yield current_inv[0], dirblock
2488
 
                try:
2489
 
                    current_inv = inventory_iterator.next()
2490
 
                except StopIteration:
2491
 
                    inv_finished = True
2492
 
                try:
2493
 
                    current_disk = disk_iterator.next()
2494
 
                except StopIteration:
2495
 
                    disk_finished = True
2496
 
 
2497
 
    def _walkdirs(self, prefix=""):
2498
 
        """Walk the directories of this tree.
2499
 
 
2500
 
           :prefix: is used as the directrory to start with.
2501
 
           returns a generator which yields items in the form:
2502
 
                ((curren_directory_path, fileid),
2503
 
                 [(file1_path, file1_name, file1_kind, None, file1_id,
2504
 
                   file1_kind), ... ])
2505
 
        """
2506
 
        _directory = 'directory'
2507
 
        # get the root in the inventory
2508
 
        inv = self.inventory
2509
 
        top_id = inv.path2id(prefix)
2510
 
        if top_id is None:
2511
 
            pending = []
2512
 
        else:
2513
 
            pending = [(prefix, '', _directory, None, top_id, None)]
2514
 
        while pending:
2515
 
            dirblock = []
2516
 
            currentdir = pending.pop()
2517
 
            # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2518
 
            top_id = currentdir[4]
2519
 
            if currentdir[0]:
2520
 
                relroot = currentdir[0] + '/'
2521
 
            else:
2522
 
                relroot = ""
2523
 
            # FIXME: stash the node in pending
2524
 
            entry = inv[top_id]
2525
 
            if entry.kind == 'directory':
2526
 
                for name, child in entry.sorted_children():
2527
 
                    dirblock.append((relroot + name, name, child.kind, None,
2528
 
                        child.file_id, child.kind
2529
 
                        ))
2530
 
            yield (currentdir[0], entry.file_id), dirblock
2531
 
            # push the user specified dirs from dirblock
2532
 
            for dir in reversed(dirblock):
2533
 
                if dir[2] == _directory:
2534
 
                    pending.append(dir)
2535
 
 
2536
 
    @needs_tree_write_lock
2537
 
    def auto_resolve(self):
2538
 
        """Automatically resolve text conflicts according to contents.
2539
 
 
2540
 
        Only text conflicts are auto_resolvable. Files with no conflict markers
2541
 
        are considered 'resolved', because bzr always puts conflict markers
2542
 
        into files that have text conflicts.  The corresponding .THIS .BASE and
2543
 
        .OTHER files are deleted, as per 'resolve'.
2544
 
        :return: a tuple of ConflictLists: (un_resolved, resolved).
2545
 
        """
2546
 
        un_resolved = _mod_conflicts.ConflictList()
2547
 
        resolved = _mod_conflicts.ConflictList()
2548
 
        conflict_re = re.compile('^(<{7}|={7}|>{7})')
2549
 
        for conflict in self.conflicts():
2550
 
            if (conflict.typestring != 'text conflict' or
2551
 
                self.kind(conflict.file_id) != 'file'):
2552
 
                un_resolved.append(conflict)
2553
 
                continue
2554
 
            my_file = open(self.id2abspath(conflict.file_id), 'rb')
2555
 
            try:
2556
 
                for line in my_file:
2557
 
                    if conflict_re.search(line):
2558
 
                        un_resolved.append(conflict)
2559
 
                        break
2560
 
                else:
2561
 
                    resolved.append(conflict)
2562
 
            finally:
2563
 
                my_file.close()
2564
 
        resolved.remove_files(self)
2565
 
        self.set_conflicts(un_resolved)
2566
 
        return un_resolved, resolved
2567
 
 
2568
 
    @needs_read_lock
2569
 
    def _check(self, references):
2570
 
        """Check the tree for consistency.
2571
 
 
2572
 
        :param references: A dict with keys matching the items returned by
2573
 
            self._get_check_refs(), and values from looking those keys up in
2574
 
            the repository.
2575
 
        """
2576
 
        tree_basis = self.basis_tree()
2577
 
        tree_basis.lock_read()
2578
 
        try:
2579
 
            repo_basis = references[('trees', self.last_revision())]
2580
 
            if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2581
 
                raise errors.BzrCheckError(
2582
 
                    "Mismatched basis inventory content.")
2583
 
            self._validate()
2584
 
        finally:
2585
 
            tree_basis.unlock()
2586
 
 
2587
 
    def _validate(self):
2588
 
        """Validate internal structures.
2589
 
 
2590
 
        This is meant mostly for the test suite. To give it a chance to detect
2591
 
        corruption after actions have occurred. The default implementation is a
2592
 
        just a no-op.
2593
 
 
2594
 
        :return: None. An exception should be raised if there is an error.
2595
 
        """
2596
 
        return
2597
 
 
2598
 
    def _get_rules_searcher(self, default_searcher):
2599
 
        """See Tree._get_rules_searcher."""
2600
 
        if self._rules_searcher is None:
2601
 
            self._rules_searcher = super(WorkingTree,
2602
 
                self)._get_rules_searcher(default_searcher)
2603
 
        return self._rules_searcher
2604
 
 
2605
 
    def get_shelf_manager(self):
2606
 
        """Return the ShelfManager for this WorkingTree."""
2607
 
        from bzrlib.shelf import ShelfManager
2608
 
        return ShelfManager(self, self._transport)
2609
 
 
2610
2017
 
2611
2018
class WorkingTree2(WorkingTree):
2612
2019
    """This is the Format 2 working tree.
2613
2020
 
2614
 
    This was the first weave based working tree.
 
2021
    This was the first weave based working tree. 
2615
2022
     - uses os locks for locking.
2616
2023
     - uses the branch last-revision.
2617
2024
    """
2618
2025
 
2619
 
    def __init__(self, *args, **kwargs):
2620
 
        super(WorkingTree2, self).__init__(*args, **kwargs)
2621
 
        # WorkingTree2 has more of a constraint that self._inventory must
2622
 
        # exist. Because this is an older format, we don't mind the overhead
2623
 
        # caused by the extra computation here.
2624
 
 
2625
 
        # Newer WorkingTree's should only have self._inventory set when they
2626
 
        # have a read lock.
2627
 
        if self._inventory is None:
2628
 
            self.read_working_inventory()
2629
 
 
2630
 
    def _get_check_refs(self):
2631
 
        """Return the references needed to perform a check of this tree."""
2632
 
        return [('trees', self.last_revision())]
2633
 
 
2634
2026
    def lock_tree_write(self):
2635
2027
        """See WorkingTree.lock_tree_write().
2636
2028
 
2645
2037
            raise
2646
2038
 
2647
2039
    def unlock(self):
2648
 
        # do non-implementation specific cleanup
2649
 
        self._cleanup()
2650
 
 
2651
2040
        # we share control files:
2652
2041
        if self._control_files._lock_count == 3:
2653
2042
            # _inventory_is_modified is always False during a read lock.
2654
2043
            if self._inventory_is_modified:
2655
2044
                self.flush()
2656
2045
            self._write_hashcache_if_dirty()
2657
 
 
 
2046
                    
2658
2047
        # reverse order of locking.
2659
2048
        try:
2660
2049
            return self._control_files.unlock()
2676
2065
    def _last_revision(self):
2677
2066
        """See Mutable.last_revision."""
2678
2067
        try:
2679
 
            return self._transport.get_bytes('last-revision')
 
2068
            return self._control_files.get_utf8('last-revision').read()
2680
2069
        except errors.NoSuchFile:
2681
 
            return _mod_revision.NULL_REVISION
 
2070
            return None
2682
2071
 
2683
2072
    def _change_last_revision(self, revision_id):
2684
2073
        """See WorkingTree._change_last_revision."""
2685
 
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
 
2074
        if revision_id is None or revision_id == NULL_REVISION:
2686
2075
            try:
2687
 
                self._transport.delete('last-revision')
 
2076
                self._control_files._transport.delete('last-revision')
2688
2077
            except errors.NoSuchFile:
2689
2078
                pass
2690
2079
            return False
2691
2080
        else:
2692
 
            self._transport.put_bytes('last-revision', revision_id,
2693
 
                mode=self.bzrdir._get_file_mode())
 
2081
            self._control_files.put_utf8('last-revision', revision_id)
2694
2082
            return True
2695
2083
 
2696
 
    def _get_check_refs(self):
2697
 
        """Return the references needed to perform a check of this tree."""
2698
 
        return [('trees', self.last_revision())]
2699
 
 
2700
2084
    @needs_tree_write_lock
2701
2085
    def set_conflicts(self, conflicts):
2702
 
        self._put_rio('conflicts', conflicts.to_stanzas(),
 
2086
        self._put_rio('conflicts', conflicts.to_stanzas(), 
2703
2087
                      CONFLICT_HEADER_1)
2704
2088
 
2705
2089
    @needs_tree_write_lock
2712
2096
    @needs_read_lock
2713
2097
    def conflicts(self):
2714
2098
        try:
2715
 
            confile = self._transport.get('conflicts')
 
2099
            confile = self._control_files.get('conflicts')
2716
2100
        except errors.NoSuchFile:
2717
2101
            return _mod_conflicts.ConflictList()
2718
2102
        try:
2719
 
            try:
2720
 
                if confile.next() != CONFLICT_HEADER_1 + '\n':
2721
 
                    raise errors.ConflictFormatError()
2722
 
            except StopIteration:
 
2103
            if confile.next() != CONFLICT_HEADER_1 + '\n':
2723
2104
                raise errors.ConflictFormatError()
2724
 
            return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2725
 
        finally:
2726
 
            confile.close()
 
2105
        except StopIteration:
 
2106
            raise errors.ConflictFormatError()
 
2107
        return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2727
2108
 
2728
2109
    def unlock(self):
2729
 
        # do non-implementation specific cleanup
2730
 
        self._cleanup()
2731
2110
        if self._control_files._lock_count == 1:
2732
2111
            # _inventory_is_modified is always False during a read lock.
2733
2112
            if self._inventory_is_modified:
2740
2119
            self.branch.unlock()
2741
2120
 
2742
2121
 
 
2122
class WorkingTree4(WorkingTree3):
 
2123
 
 
2124
    def _serialize(self, inventory, out_file):
 
2125
        xml7.serializer_v7.write_inventory(self._inventory, out_file)
 
2126
 
 
2127
    def _deserialize(selt, in_file):
 
2128
        return xml7.serializer_v7.read_inventory(in_file)
 
2129
 
 
2130
    def _comparison_data(self, entry, path):
 
2131
        kind, executable, stat_value = \
 
2132
            WorkingTree3._comparison_data(self, entry, path)
 
2133
        if kind == 'directory' and entry.kind == 'tree-reference':
 
2134
            kind = 'tree-reference'
 
2135
        return kind, executable, stat_value
 
2136
 
 
2137
    def add_reference(self, sub_tree):
 
2138
        try:
 
2139
            sub_tree_path = self.relpath(sub_tree.basedir)
 
2140
        except errors.PathNotChild:
 
2141
            raise errors.BadReferenceTarget(self, sub_tree, 
 
2142
                                            'Target not inside tree.')
 
2143
        parent_id = self.path2id(osutils.dirname(sub_tree_path))
 
2144
        name = osutils.basename(sub_tree_path)
 
2145
        sub_tree_id = sub_tree.get_root_id()
 
2146
        if sub_tree_id == self.get_root_id():
 
2147
            raise errors.BadReferenceTarget(self, sub_tree, 
 
2148
                                     'Trees have the same root id.')
 
2149
        if sub_tree_id in self.inventory:
 
2150
            raise errors.BadReferenceTarget(self, sub_tree, 
 
2151
                                            'Root id already present in tree')
 
2152
        entry = TreeReference(sub_tree_id, name, parent_id, None, 
 
2153
                              None)
 
2154
        self.inventory.add(entry)
 
2155
        self._write_inventory(self.inventory)
 
2156
 
 
2157
    def get_nested_tree(self, entry, path=None):
 
2158
        if path is None:
 
2159
            path = self.id2path(entry.file_id)
 
2160
        return WorkingTree.open(self.abspath(path))
 
2161
 
 
2162
    def get_reference_revision(self, entry, path=None):
 
2163
        return self.get_nested_tree(entry, path).last_revision()
 
2164
 
 
2165
 
2743
2166
def get_conflicted_stem(path):
2744
2167
    for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2745
2168
        if path.endswith(suffix):
2746
2169
            return path[:-len(suffix)]
2747
2170
 
 
2171
@deprecated_function(zero_eight)
 
2172
def is_control_file(filename):
 
2173
    """See WorkingTree.is_control_filename(filename)."""
 
2174
    ## FIXME: better check
 
2175
    filename = normpath(filename)
 
2176
    while filename != '':
 
2177
        head, tail = os.path.split(filename)
 
2178
        ## mutter('check %r for control file' % ((head, tail),))
 
2179
        if tail == '.bzr':
 
2180
            return True
 
2181
        if filename == head:
 
2182
            break
 
2183
        filename = head
 
2184
    return False
 
2185
 
2748
2186
 
2749
2187
class WorkingTreeFormat(object):
2750
2188
    """An encapsulation of the initialization and open routines for a format.
2754
2192
     * a format string,
2755
2193
     * an open routine.
2756
2194
 
2757
 
    Formats are placed in an dict by their format string for reference
 
2195
    Formats are placed in an dict by their format string for reference 
2758
2196
    during workingtree opening. Its not required that these be instances, they
2759
 
    can be classes themselves with class methods - it simply depends on
 
2197
    can be classes themselves with class methods - it simply depends on 
2760
2198
    whether state is needed for a given format or not.
2761
2199
 
2762
2200
    Once a format is deprecated, just deprecate the initialize and open
2763
 
    methods on the format class. Do not deprecate the object, as the
 
2201
    methods on the format class. Do not deprecate the object, as the 
2764
2202
    object will be created every time regardless.
2765
2203
    """
2766
2204
 
2772
2210
 
2773
2211
    requires_rich_root = False
2774
2212
 
2775
 
    upgrade_recommended = False
2776
 
 
2777
2213
    @classmethod
2778
2214
    def find_format(klass, a_bzrdir):
2779
2215
        """Return the format for the working tree object in a_bzrdir."""
2780
2216
        try:
2781
2217
            transport = a_bzrdir.get_workingtree_transport(None)
2782
 
            format_string = transport.get_bytes("format")
 
2218
            format_string = transport.get("format").read()
2783
2219
            return klass._formats[format_string]
2784
2220
        except errors.NoSuchFile:
2785
2221
            raise errors.NoWorkingTree(base=transport.base)
2786
2222
        except KeyError:
2787
 
            raise errors.UnknownFormatError(format=format_string,
2788
 
                                            kind="working tree")
2789
 
 
2790
 
    def __eq__(self, other):
2791
 
        return self.__class__ is other.__class__
2792
 
 
2793
 
    def __ne__(self, other):
2794
 
        return not (self == other)
 
2223
            raise errors.UnknownFormatError(format=format_string)
2795
2224
 
2796
2225
    @classmethod
2797
2226
    def get_default_format(klass):
2810
2239
        """Is this format supported?
2811
2240
 
2812
2241
        Supported formats can be initialized and opened.
2813
 
        Unsupported formats may not support initialization or committing or
 
2242
        Unsupported formats may not support initialization or committing or 
2814
2243
        some other features depending on the reason for not being supported.
2815
2244
        """
2816
2245
        return True
2817
2246
 
2818
 
    def supports_content_filtering(self):
2819
 
        """True if this format supports content filtering."""
2820
 
        return False
2821
 
 
2822
 
    def supports_views(self):
2823
 
        """True if this format supports stored views."""
2824
 
        return False
2825
 
 
2826
2247
    @classmethod
2827
2248
    def register_format(klass, format):
2828
2249
        klass._formats[format.get_format_string()] = format
2833
2254
 
2834
2255
    @classmethod
2835
2256
    def unregister_format(klass, format):
 
2257
        assert klass._formats[format.get_format_string()] is format
2836
2258
        del klass._formats[format.get_format_string()]
2837
2259
 
2838
2260
 
 
2261
 
2839
2262
class WorkingTreeFormat2(WorkingTreeFormat):
2840
 
    """The second working tree format.
 
2263
    """The second working tree format. 
2841
2264
 
2842
2265
    This format modified the hash cache from the format 1 hash cache.
2843
2266
    """
2844
2267
 
2845
 
    upgrade_recommended = True
2846
 
 
2847
2268
    def get_format_description(self):
2848
2269
        """See WorkingTreeFormat.get_format_description()."""
2849
2270
        return "Working tree format 2"
2850
2271
 
2851
 
    def _stub_initialize_on_transport(self, transport, file_mode):
2852
 
        """Workaround: create control files for a remote working tree.
2853
 
 
 
2272
    def stub_initialize_remote(self, control_files):
 
2273
        """As a special workaround create critical control files for a remote working tree
 
2274
        
2854
2275
        This ensures that it can later be updated and dealt with locally,
2855
 
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
 
2276
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with 
2856
2277
        no working tree.  (See bug #43064).
2857
2278
        """
2858
2279
        sio = StringIO()
2859
 
        inv = inventory.Inventory()
2860
 
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
 
2280
        inv = Inventory()
 
2281
        xml5.serializer_v5.write_inventory(inv, sio)
2861
2282
        sio.seek(0)
2862
 
        transport.put_file('inventory', sio, file_mode)
2863
 
        transport.put_bytes('pending-merges', '', file_mode)
2864
 
 
2865
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2866
 
                   accelerator_tree=None, hardlink=False):
 
2283
        control_files.put('inventory', sio)
 
2284
 
 
2285
        control_files.put_utf8('pending-merges', '')
 
2286
        
 
2287
 
 
2288
    def initialize(self, a_bzrdir, revision_id=None):
2867
2289
        """See WorkingTreeFormat.initialize()."""
2868
2290
        if not isinstance(a_bzrdir.transport, LocalTransport):
2869
2291
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2870
 
        if from_branch is not None:
2871
 
            branch = from_branch
2872
 
        else:
2873
 
            branch = a_bzrdir.open_branch()
2874
 
        if revision_id is None:
2875
 
            revision_id = _mod_revision.ensure_null(branch.last_revision())
2876
 
        branch.lock_write()
2877
 
        try:
2878
 
            branch.generate_revision_history(revision_id)
2879
 
        finally:
2880
 
            branch.unlock()
2881
 
        inv = inventory.Inventory()
 
2292
        branch = a_bzrdir.open_branch()
 
2293
        if revision_id is not None:
 
2294
            branch.lock_write()
 
2295
            try:
 
2296
                revision_history = branch.revision_history()
 
2297
                try:
 
2298
                    position = revision_history.index(revision_id)
 
2299
                except ValueError:
 
2300
                    raise errors.NoSuchRevision(branch, revision_id)
 
2301
                branch.set_revision_history(revision_history[:position + 1])
 
2302
            finally:
 
2303
                branch.unlock()
 
2304
        revision = branch.last_revision()
 
2305
        inv = Inventory()
2882
2306
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2883
2307
                         branch,
2884
2308
                         inv,
2885
2309
                         _internal=True,
2886
2310
                         _format=self,
2887
2311
                         _bzrdir=a_bzrdir)
2888
 
        basis_tree = branch.repository.revision_tree(revision_id)
 
2312
        basis_tree = branch.repository.revision_tree(revision)
2889
2313
        if basis_tree.inventory.root is not None:
2890
 
            wt.set_root_id(basis_tree.get_root_id())
 
2314
            wt.set_root_id(basis_tree.inventory.root.file_id)
2891
2315
        # set the parent list and cache the basis tree.
2892
 
        if _mod_revision.is_null(revision_id):
2893
 
            parent_trees = []
2894
 
        else:
2895
 
            parent_trees = [(revision_id, basis_tree)]
2896
 
        wt.set_parent_trees(parent_trees)
 
2316
        wt.set_parent_trees([(revision, basis_tree)])
2897
2317
        transform.build_tree(basis_tree, wt)
2898
2318
        return wt
2899
2319
 
2912
2332
            raise NotImplementedError
2913
2333
        if not isinstance(a_bzrdir.transport, LocalTransport):
2914
2334
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2915
 
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
 
2335
        return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2916
2336
                           _internal=True,
2917
2337
                           _format=self,
2918
2338
                           _bzrdir=a_bzrdir)
2919
 
        return wt
 
2339
 
2920
2340
 
2921
2341
class WorkingTreeFormat3(WorkingTreeFormat):
2922
2342
    """The second working tree format updated to record a format marker.
2930
2350
        - uses a LockDir to guard access for writes.
2931
2351
    """
2932
2352
 
2933
 
    upgrade_recommended = True
2934
 
 
2935
2353
    def get_format_string(self):
2936
2354
        """See WorkingTreeFormat.get_format_string()."""
2937
2355
        return "Bazaar-NG Working Tree format 3"
2942
2360
 
2943
2361
    _lock_file_name = 'lock'
2944
2362
    _lock_class = LockDir
2945
 
 
2946
2363
    _tree_class = WorkingTree3
2947
2364
 
2948
2365
    def __get_matchingbzrdir(self):
2952
2369
 
2953
2370
    def _open_control_files(self, a_bzrdir):
2954
2371
        transport = a_bzrdir.get_workingtree_transport(None)
2955
 
        return LockableFiles(transport, self._lock_file_name,
 
2372
        return LockableFiles(transport, self._lock_file_name, 
2956
2373
                             self._lock_class)
2957
2374
 
2958
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2959
 
                   accelerator_tree=None, hardlink=False):
 
2375
    def initialize(self, a_bzrdir, revision_id=None):
2960
2376
        """See WorkingTreeFormat.initialize().
2961
 
 
2962
 
        :param revision_id: if supplied, create a working tree at a different
2963
 
            revision than the branch is at.
2964
 
        :param accelerator_tree: A tree which can be used for retrieving file
2965
 
            contents more quickly than the revision tree, i.e. a workingtree.
2966
 
            The revision tree will be used for cases where accelerator_tree's
2967
 
            content is different.
2968
 
        :param hardlink: If true, hard-link files from accelerator_tree,
2969
 
            where possible.
 
2377
        
 
2378
        revision_id allows creating a working tree at a different
 
2379
        revision than the branch is at.
2970
2380
        """
2971
2381
        if not isinstance(a_bzrdir.transport, LocalTransport):
2972
2382
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2974
2384
        control_files = self._open_control_files(a_bzrdir)
2975
2385
        control_files.create_lock()
2976
2386
        control_files.lock_write()
2977
 
        transport.put_bytes('format', self.get_format_string(),
2978
 
            mode=a_bzrdir._get_file_mode())
2979
 
        if from_branch is not None:
2980
 
            branch = from_branch
2981
 
        else:
2982
 
            branch = a_bzrdir.open_branch()
 
2387
        control_files.put_utf8('format', self.get_format_string())
 
2388
        branch = a_bzrdir.open_branch()
2983
2389
        if revision_id is None:
2984
 
            revision_id = _mod_revision.ensure_null(branch.last_revision())
2985
 
        # WorkingTree3 can handle an inventory which has a unique root id.
2986
 
        # as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2987
 
        # those trees. And because there isn't a format bump inbetween, we
2988
 
        # are maintaining compatibility with older clients.
2989
 
        # inv = Inventory(root_id=gen_root_id())
 
2390
            revision_id = branch.last_revision()
2990
2391
        inv = self._initial_inventory()
2991
2392
        wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2992
2393
                         branch,
3000
2401
            basis_tree = branch.repository.revision_tree(revision_id)
3001
2402
            # only set an explicit root id if there is one to set.
3002
2403
            if basis_tree.inventory.root is not None:
3003
 
                wt.set_root_id(basis_tree.get_root_id())
3004
 
            if revision_id == _mod_revision.NULL_REVISION:
 
2404
                wt.set_root_id(basis_tree.inventory.root.file_id)
 
2405
            if revision_id == NULL_REVISION:
3005
2406
                wt.set_parent_trees([])
3006
2407
            else:
3007
2408
                wt.set_parent_trees([(revision_id, basis_tree)])
3014
2415
        return wt
3015
2416
 
3016
2417
    def _initial_inventory(self):
3017
 
        return inventory.Inventory()
 
2418
        return Inventory()
3018
2419
 
3019
2420
    def __init__(self):
3020
2421
        super(WorkingTreeFormat3, self).__init__()
3030
2431
            raise NotImplementedError
3031
2432
        if not isinstance(a_bzrdir.transport, LocalTransport):
3032
2433
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
3033
 
        wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3034
 
        return wt
 
2434
        return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3035
2435
 
3036
2436
    def _open(self, a_bzrdir, control_files):
3037
2437
        """Open the tree itself.
3038
 
 
 
2438
        
3039
2439
        :param a_bzrdir: the dir for the tree.
3040
2440
        :param control_files: the control files for the tree.
3041
2441
        """
3049
2449
        return self.get_format_string()
3050
2450
 
3051
2451
 
3052
 
__default_format = WorkingTreeFormat6()
 
2452
class WorkingTreeFormat4(WorkingTreeFormat3):
 
2453
    
 
2454
    """Working tree format that supports unique roots and nested trees"""
 
2455
 
 
2456
    _tree_class = WorkingTree4
 
2457
 
 
2458
    requires_rich_root = True
 
2459
 
 
2460
    supports_tree_reference = True
 
2461
 
 
2462
    def __init__(self):
 
2463
        WorkingTreeFormat3.__init__(self)
 
2464
        
 
2465
    def __get_matchingbzrdir(self):
 
2466
        return bzrdir.format_registry.make_bzrdir('experimental-knit3')
 
2467
 
 
2468
    _matchingbzrdir = property(__get_matchingbzrdir)
 
2469
 
 
2470
    def get_format_string(self):
 
2471
        """See WorkingTreeFormat.get_format_string()."""
 
2472
        return "Bazaar-NG Working Tree format 4"
 
2473
 
 
2474
    def get_format_description(self):
 
2475
        """See WorkingTreeFormat.get_format_description()."""
 
2476
        return "Working tree format 4"
 
2477
 
 
2478
    def _initial_inventory(self):
 
2479
        return Inventory(root_id=generate_ids.gen_root_id())
 
2480
 
 
2481
# formats which have no format string are not discoverable
 
2482
# and not independently creatable, so are not registered.
 
2483
__default_format = WorkingTreeFormat3()
3053
2484
WorkingTreeFormat.register_format(__default_format)
3054
 
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3055
2485
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3056
 
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3057
2486
WorkingTreeFormat.set_default_format(__default_format)
3058
 
# formats which have no format string are not discoverable
3059
 
# and not independently creatable, so are not registered.
3060
2487
_legacy_formats = [WorkingTreeFormat2(),
3061
2488
                   ]
 
2489
 
 
2490
 
 
2491
class WorkingTreeTestProviderAdapter(object):
 
2492
    """A tool to generate a suite testing multiple workingtree formats at once.
 
2493
 
 
2494
    This is done by copying the test once for each transport and injecting
 
2495
    the transport_server, transport_readonly_server, and workingtree_format
 
2496
    classes into each copy. Each copy is also given a new id() to make it
 
2497
    easy to identify.
 
2498
    """
 
2499
 
 
2500
    def __init__(self, transport_server, transport_readonly_server, formats):
 
2501
        self._transport_server = transport_server
 
2502
        self._transport_readonly_server = transport_readonly_server
 
2503
        self._formats = formats
 
2504
    
 
2505
    def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
 
2506
        """Clone test for adaption."""
 
2507
        new_test = deepcopy(test)
 
2508
        new_test.transport_server = self._transport_server
 
2509
        new_test.transport_readonly_server = self._transport_readonly_server
 
2510
        new_test.bzrdir_format = bzrdir_format
 
2511
        new_test.workingtree_format = workingtree_format
 
2512
        def make_new_test_id():
 
2513
            new_id = "%s(%s)" % (test.id(), variation)
 
2514
            return lambda: new_id
 
2515
        new_test.id = make_new_test_id()
 
2516
        return new_test
 
2517
    
 
2518
    def adapt(self, test):
 
2519
        from bzrlib.tests import TestSuite
 
2520
        result = TestSuite()
 
2521
        for workingtree_format, bzrdir_format in self._formats:
 
2522
            new_test = self._clone_test(
 
2523
                test,
 
2524
                bzrdir_format,
 
2525
                workingtree_format, workingtree_format.__class__.__name__)
 
2526
            result.addTest(new_test)
 
2527
        return result