/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

[merge] bzr.dev 2294

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
44
from bisect import bisect_left
40
45
import collections
 
46
from copy import deepcopy
41
47
import errno
42
48
import itertools
43
49
import operator
44
50
import stat
45
 
import re
 
51
from time import time
 
52
import warnings
46
53
 
47
54
import bzrlib
48
55
from bzrlib import (
49
 
    branch,
50
56
    bzrdir,
51
57
    conflicts as _mod_conflicts,
 
58
    dirstate,
52
59
    errors,
53
60
    generate_ids,
54
61
    globbing,
55
 
    graph as _mod_graph,
56
62
    hashcache,
57
63
    ignores,
58
 
    inventory,
59
64
    merge,
60
 
    revision as _mod_revision,
 
65
    osutils,
61
66
    revisiontree,
62
 
    trace,
 
67
    textui,
63
68
    transform,
64
 
    ui,
65
 
    views,
 
69
    urlutils,
66
70
    xml5,
67
 
    xml7,
 
71
    xml6,
68
72
    )
69
73
import bzrlib.branch
70
74
from bzrlib.transport import get_transport
71
 
from bzrlib.workingtree_4 import (
72
 
    WorkingTreeFormat4,
73
 
    WorkingTreeFormat5,
74
 
    WorkingTreeFormat6,
75
 
    )
 
75
import bzrlib.ui
 
76
from bzrlib.workingtree_4 import WorkingTreeFormat4
76
77
""")
77
78
 
78
79
from bzrlib import symbol_versioning
79
80
from bzrlib.decorators import needs_read_lock, needs_write_lock
80
 
from bzrlib.lockable_files import LockableFiles
 
81
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID
 
82
from bzrlib.lockable_files import LockableFiles, TransportLock
81
83
from bzrlib.lockdir import LockDir
82
84
import bzrlib.mutabletree
83
85
from bzrlib.mutabletree import needs_tree_write_lock
84
 
from bzrlib import osutils
85
86
from bzrlib.osutils import (
 
87
    compact_date,
86
88
    file_kind,
87
89
    isdir,
88
90
    normpath,
89
91
    pathjoin,
 
92
    rand_chars,
90
93
    realpath,
91
94
    safe_unicode,
92
95
    splitpath,
93
96
    supports_executable,
94
97
    )
95
 
from bzrlib.filters import filtered_input_file
96
98
from bzrlib.trace import mutter, note
97
99
from bzrlib.transport.local import LocalTransport
98
 
from bzrlib.revision import CURRENT_REVISION
 
100
from bzrlib.progress import DummyProgress, ProgressPhase
 
101
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
99
102
from bzrlib.rio import RioReader, rio_file, Stanza
100
 
from bzrlib.symbol_versioning import (
101
 
    deprecated_passed,
102
 
    DEPRECATED_PARAMETER,
103
 
    )
 
103
from bzrlib.symbol_versioning import (deprecated_passed,
 
104
        deprecated_method,
 
105
        deprecated_function,
 
106
        DEPRECATED_PARAMETER,
 
107
        zero_eight,
 
108
        zero_eleven,
 
109
        zero_thirteen,
 
110
        )
104
111
 
105
112
 
106
113
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
114
CONFLICT_HEADER_1 = "BZR conflict list format 1"
111
115
 
112
 
ERROR_PATH_NOT_FOUND = 3    # WindowsError errno code, equivalent to ENOENT
 
116
 
 
117
@deprecated_function(zero_thirteen)
 
118
def gen_file_id(name):
 
119
    """Return new file id for the basename 'name'.
 
120
 
 
121
    Use bzrlib.generate_ids.gen_file_id() instead
 
122
    """
 
123
    return generate_ids.gen_file_id(name)
 
124
 
 
125
 
 
126
@deprecated_function(zero_thirteen)
 
127
def gen_root_id():
 
128
    """Return a new tree-root file id.
 
129
 
 
130
    This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
 
131
    """
 
132
    return generate_ids.gen_root_id()
113
133
 
114
134
 
115
135
class TreeEntry(object):
116
136
    """An entry that implements the minimum interface used by commands.
117
137
 
118
 
    This needs further inspection, it may be better to have
 
138
    This needs further inspection, it may be better to have 
119
139
    InventoryEntries without ids - though that seems wrong. For now,
120
140
    this is a parallel hierarchy to InventoryEntry, and needs to become
121
141
    one of several things: decorates to that hierarchy, children of, or
124
144
    no InventoryEntry available - i.e. for unversioned objects.
125
145
    Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
126
146
    """
127
 
 
 
147
 
128
148
    def __eq__(self, other):
129
149
        # yes, this us ugly, TODO: best practice __eq__ style.
130
150
        return (isinstance(other, TreeEntry)
131
151
                and other.__class__ == self.__class__)
132
 
 
 
152
 
133
153
    def kind_character(self):
134
154
        return "???"
135
155
 
167
187
        return ''
168
188
 
169
189
 
170
 
class WorkingTree(bzrlib.mutabletree.MutableTree,
171
 
    bzrdir.ControlComponent):
 
190
class WorkingTree(bzrlib.mutabletree.MutableTree):
172
191
    """Working copy tree.
173
192
 
174
193
    The inventory is held in the `Branch` working-inventory, and the
178
197
    not listed in the Inventory and vice versa.
179
198
    """
180
199
 
181
 
    # override this to set the strategy for storing views
182
 
    def _make_views(self):
183
 
        return views.DisabledViews(self)
184
 
 
185
200
    def __init__(self, basedir='.',
186
201
                 branch=DEPRECATED_PARAMETER,
187
202
                 _inventory=None,
189
204
                 _internal=False,
190
205
                 _format=None,
191
206
                 _bzrdir=None):
192
 
        """Construct a WorkingTree instance. This is not a public API.
 
207
        """Construct a WorkingTree for basedir.
193
208
 
194
 
        :param branch: A branch to override probing for the branch.
 
209
        If the branch is not supplied, it is opened automatically.
 
210
        If the branch is supplied, it must be the branch for this basedir.
 
211
        (branch.base is not cross checked, because for remote branches that
 
212
        would be meaningless).
195
213
        """
196
214
        self._format = _format
197
215
        self.bzrdir = _bzrdir
198
216
        if not _internal:
199
 
            raise errors.BzrError("Please use bzrdir.open_workingtree or "
200
 
                "WorkingTree.open() to obtain a WorkingTree.")
 
217
            # not created via open etc.
 
218
            warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
 
219
                 "Please use bzrdir.open_workingtree or WorkingTree.open().",
 
220
                 DeprecationWarning,
 
221
                 stacklevel=2)
 
222
            wt = WorkingTree.open(basedir)
 
223
            self._branch = wt.branch
 
224
            self.basedir = wt.basedir
 
225
            self._control_files = wt._control_files
 
226
            self._hashcache = wt._hashcache
 
227
            self._set_inventory(wt._inventory, dirty=False)
 
228
            self._format = wt._format
 
229
            self.bzrdir = wt.bzrdir
 
230
        assert isinstance(basedir, basestring), \
 
231
            "base directory %r is not a string" % basedir
201
232
        basedir = safe_unicode(basedir)
202
233
        mutter("opening working tree %r", basedir)
203
234
        if deprecated_passed(branch):
 
235
            if not _internal:
 
236
                warnings.warn("WorkingTree(..., branch=XXX) is deprecated"
 
237
                     " as of bzr 0.8. Please use bzrdir.open_workingtree() or"
 
238
                     " WorkingTree.open().",
 
239
                     DeprecationWarning,
 
240
                     stacklevel=2
 
241
                     )
204
242
            self._branch = branch
205
243
        else:
206
244
            self._branch = self.bzrdir.open_branch()
211
249
            self._control_files = self.branch.control_files
212
250
        else:
213
251
            # assume all other formats have their own control files.
 
252
            assert isinstance(_control_files, LockableFiles), \
 
253
                    "_control_files must be a LockableFiles, not %r" \
 
254
                    % _control_files
214
255
            self._control_files = _control_files
215
 
        self._transport = self._control_files._transport
216
256
        # update the whole cache up front and write to disk if anything changed;
217
257
        # in the future we might want to do this more selectively
218
258
        # two possible ways offer themselves : in self._unlock, write the cache
222
262
        wt_trans = self.bzrdir.get_workingtree_transport(None)
223
263
        cache_filename = wt_trans.local_abspath('stat-cache')
224
264
        self._hashcache = hashcache.HashCache(basedir, cache_filename,
225
 
            self.bzrdir._get_file_mode(),
226
 
            self._content_filter_stack_provider())
 
265
                                              self._control_files._file_mode)
227
266
        hc = self._hashcache
228
267
        hc.read()
229
268
        # is this scan needed ? it makes things kinda slow.
234
273
            hc.write()
235
274
 
236
275
        if _inventory is None:
237
 
            # This will be acquired on lock_read() or lock_write()
238
276
            self._inventory_is_modified = False
239
 
            self._inventory = None
 
277
            self.read_working_inventory()
240
278
        else:
241
279
            # the caller of __init__ has provided an inventory,
242
280
            # we assume they know what they are doing - as its only
243
281
            # the Format factory and creation methods that are
244
282
            # permitted to do this.
245
283
            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
284
 
269
285
    branch = property(
270
286
        fget=lambda self: self._branch,
285
301
        self._control_files.break_lock()
286
302
        self.branch.break_lock()
287
303
 
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
 
    def requires_rich_root(self):
299
 
        return self._format.requires_rich_root
300
 
 
301
 
    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()
309
 
 
310
304
    def _set_inventory(self, inv, dirty):
311
305
        """Set the internal cached inventory.
312
306
 
317
311
            False then the inventory is the same as that on disk and any
318
312
            serialisation would be unneeded overhead.
319
313
        """
 
314
        assert inv.root is not None
320
315
        self._inventory = inv
321
316
        self._inventory_is_modified = dirty
322
317
 
326
321
 
327
322
        """
328
323
        if path is None:
329
 
            path = osutils.getcwd()
 
324
            path = os.path.getcwdu()
330
325
        control = bzrdir.BzrDir.open(path, _unsupported)
331
326
        return control.open_workingtree(_unsupported)
332
 
 
 
327
        
333
328
    @staticmethod
334
329
    def open_containing(path=None):
335
330
        """Open an existing working tree which has its root about path.
336
 
 
 
331
        
337
332
        This probes for a working tree at path and searches upwards from there.
338
333
 
339
334
        Basically we keep looking up until we find the control directory or
357
352
        """
358
353
        return WorkingTree.open(path, _unsupported=True)
359
354
 
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
355
    def __iter__(self):
380
356
        """Iterate through file_ids for this tree.
381
357
 
387
363
            if osutils.lexists(self.abspath(path)):
388
364
                yield ie.file_id
389
365
 
390
 
    def all_file_ids(self):
391
 
        """See Tree.iter_all_file_ids"""
392
 
        return set(self.inventory)
393
 
 
394
366
    def __repr__(self):
395
367
        return "<%s of %s>" % (self.__class__.__name__,
396
368
                               getattr(self, 'basedir', None))
397
369
 
398
370
    def abspath(self, filename):
399
371
        return pathjoin(self.basedir, filename)
400
 
 
 
372
    
401
373
    def basis_tree(self):
402
374
        """Return RevisionTree for the current last revision.
403
 
 
 
375
        
404
376
        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).
 
377
        empty tree - one obtained by calling repository.revision_tree(None).
407
378
        """
408
379
        try:
409
380
            revision_id = self.get_parent_ids()[0]
411
382
            # no parents, return an empty revision tree.
412
383
            # in the future this should return the tree for
413
384
            # 'empty:' - the implicit root empty tree.
414
 
            return self.branch.repository.revision_tree(
415
 
                       _mod_revision.NULL_REVISION)
 
385
            return self.branch.repository.revision_tree(None)
416
386
        try:
417
387
            return self.revision_tree(revision_id)
418
388
        except errors.NoSuchRevision:
422
392
        # at this point ?
423
393
        try:
424
394
            return self.branch.repository.revision_tree(revision_id)
425
 
        except (errors.RevisionNotPresent, errors.NoSuchRevision):
 
395
        except errors.RevisionNotPresent:
426
396
            # 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
 
397
            # occured. If the revision is present, its a problem, if its not
428
398
            # its a ghost.
429
399
            if self.branch.repository.has_revision(revision_id):
430
400
                raise
431
401
            # 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()
 
402
            return self.branch.repository.revision_tree(None)
 
403
 
 
404
    @staticmethod
 
405
    @deprecated_method(zero_eight)
 
406
    def create(branch, directory):
 
407
        """Create a workingtree for branch at directory.
 
408
 
 
409
        If existing_directory already exists it must have a .bzr directory.
 
410
        If it does not exist, it will be created.
 
411
 
 
412
        This returns a new WorkingTree object for the new checkout.
 
413
 
 
414
        TODO FIXME RBC 20060124 when we have checkout formats in place this
 
415
        should accept an optional revisionid to checkout [and reject this if
 
416
        checking out into the same dir as a pre-checkout-aware branch format.]
 
417
 
 
418
        XXX: When BzrDir is present, these should be created through that 
 
419
        interface instead.
 
420
        """
 
421
        warnings.warn('delete WorkingTree.create', stacklevel=3)
 
422
        transport = get_transport(directory)
 
423
        if branch.bzrdir.root_transport.base == transport.base:
 
424
            # same dir 
 
425
            return branch.bzrdir.create_workingtree()
 
426
        # different directory, 
 
427
        # create a branch reference
 
428
        # and now a working tree.
 
429
        raise NotImplementedError
 
430
 
 
431
    @staticmethod
 
432
    @deprecated_method(zero_eight)
 
433
    def create_standalone(directory):
 
434
        """Create a checkout and a branch and a repo at directory.
 
435
 
 
436
        Directory must exist and be empty.
 
437
 
 
438
        please use BzrDir.create_standalone_workingtree
 
439
        """
 
440
        return bzrdir.BzrDir.create_standalone_workingtree(directory)
437
441
 
438
442
    def relpath(self, path):
439
443
        """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
 
444
        
 
445
        The path may be absolute or relative. If its a relative path it is 
442
446
        interpreted relative to the python current working directory.
443
447
        """
444
448
        return osutils.relpath(self.basedir, path)
446
450
    def has_filename(self, filename):
447
451
        return osutils.lexists(self.abspath(filename))
448
452
 
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()
 
453
    def get_file(self, file_id):
 
454
        return self.get_file_byname(self.id2path(file_id))
 
455
 
 
456
    def get_file_text(self, file_id):
 
457
        return self.get_file(file_id).read()
 
458
 
 
459
    def get_file_byname(self, filename):
 
460
        return file(self.abspath(filename), 'rb')
483
461
 
484
462
    @needs_read_lock
485
 
    def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
 
463
    def annotate_iter(self, file_id):
486
464
        """See Tree.annotate_iter
487
465
 
488
466
        This implementation will use the basis tree implementation if possible.
492
470
        incorrectly attributed to CURRENT_REVISION (but after committing, the
493
471
        attribution will be correct).
494
472
        """
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
 
473
        basis = self.basis_tree()
 
474
        changes = self._iter_changes(basis, True, [file_id]).next()
 
475
        changed_content, kind = changes[2], changes[6]
 
476
        if not changed_content:
 
477
            return basis.annotate_iter(file_id)
 
478
        if kind[1] is None:
 
479
            return None
 
480
        import annotate
 
481
        if kind[0] != 'file':
 
482
            old_lines = []
 
483
        else:
 
484
            old_lines = list(basis.annotate_iter(file_id))
 
485
        old = [old_lines]
 
486
        for tree in self.branch.repository.revision_trees(
 
487
            self.get_parent_ids()[1:]):
 
488
            if file_id not in tree:
 
489
                continue
 
490
            old.append(list(tree.annotate_iter(file_id)))
 
491
        return annotate.reannotate(old, self.get_file(file_id).readlines(),
 
492
                                   CURRENT_REVISION)
538
493
 
539
494
    def get_parent_ids(self):
540
495
        """See Tree.get_parent_ids.
541
 
 
 
496
        
542
497
        This implementation reads the pending merges list and last_revision
543
498
        value and uses that to decide what the parents list should be.
544
499
        """
545
 
        last_rev = _mod_revision.ensure_null(self._last_revision())
546
 
        if _mod_revision.NULL_REVISION == last_rev:
 
500
        last_rev = self._last_revision()
 
501
        if last_rev is None:
547
502
            parents = []
548
503
        else:
549
504
            parents = [last_rev]
550
505
        try:
551
 
            merges_bytes = self._transport.get_bytes('pending-merges')
 
506
            merges_file = self._control_files.get('pending-merges')
552
507
        except errors.NoSuchFile:
553
508
            pass
554
509
        else:
555
 
            for l in osutils.split_lines(merges_bytes):
556
 
                revision_id = l.rstrip('\n')
 
510
            for l in merges_file.readlines():
 
511
                revision_id = osutils.safe_revision_id(l.rstrip('\n'))
557
512
                parents.append(revision_id)
558
513
        return parents
559
514
 
561
516
    def get_root_id(self):
562
517
        """Return the id of this trees root"""
563
518
        return self._inventory.root.file_id
564
 
 
 
519
        
565
520
    def _get_store_filename(self, file_id):
566
521
        ## XXX: badly named; this is not in the store at all
567
522
        return self.abspath(self.id2path(file_id))
568
523
 
569
524
    @needs_read_lock
570
 
    def clone(self, to_bzrdir, revision_id=None):
 
525
    def clone(self, to_bzrdir, revision_id=None, basis=None):
571
526
        """Duplicate this working tree into to_bzr, including all state.
572
 
 
 
527
        
573
528
        Specifically modified files are kept as modified, but
574
529
        ignored and unknown files are discarded.
575
530
 
576
531
        If you want to make a new line of development, see bzrdir.sprout()
577
532
 
578
533
        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
 
534
            If not None, the cloned tree will have its last revision set to 
 
535
            revision, and and difference between the source trees last revision
581
536
            and this one merged in.
 
537
 
 
538
        basis
 
539
            If not None, a closer copy of a tree which may have some files in
 
540
            common, and which file content should be preferentially copied from.
582
541
        """
583
542
        # assumes the target bzr dir format is compatible.
584
 
        result = to_bzrdir.create_workingtree()
 
543
        result = self._format.initialize(to_bzrdir)
585
544
        self.copy_content_into(result, revision_id)
586
545
        return result
587
546
 
616
575
    __contains__ = has_id
617
576
 
618
577
    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
 
578
        return os.path.getsize(self.id2abspath(file_id))
629
579
 
630
580
    @needs_read_lock
631
581
    def get_file_sha1(self, file_id, path=None, stat_value=None):
635
585
 
636
586
    def get_file_mtime(self, file_id, path=None):
637
587
        if not path:
638
 
            path = self.inventory.id2path(file_id)
 
588
            path = self._inventory.id2path(file_id)
639
589
        return os.lstat(self.abspath(path)).st_mtime
640
590
 
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
591
    if not supports_executable():
654
592
        def is_executable(self, file_id, path=None):
655
593
            return self._inventory[file_id].executable
656
 
 
657
 
        _is_executable_from_path_and_stat = \
658
 
            _is_executable_from_path_and_stat_from_basis
659
594
    else:
660
595
        def is_executable(self, file_id, path=None):
661
596
            if not path:
663
598
            mode = os.lstat(self.abspath(path)).st_mode
664
599
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
665
600
 
666
 
        _is_executable_from_path_and_stat = \
667
 
            _is_executable_from_path_and_stat_from_stat
668
 
 
669
 
    @needs_tree_write_lock
 
601
    @needs_write_lock
670
602
    def _add(self, files, ids, kinds):
671
603
        """See MutableTree._add."""
672
604
        # TODO: Re-adding a file that is removed in the working copy
673
605
        # should probably put it back with the previous ID.
674
 
        # the read and write working inventory should not occur in this
 
606
        # the read and write working inventory should not occur in this 
675
607
        # function - they should be part of lock_write and unlock.
676
 
        inv = self.inventory
 
608
        inv = self.read_working_inventory()
677
609
        for f, file_id, kind in zip(files, ids, kinds):
 
610
            assert kind is not None
678
611
            if file_id is None:
679
612
                inv.add_path(f, kind=kind)
680
613
            else:
681
614
                inv.add_path(f, kind=kind, file_id=file_id)
682
 
            self._inventory_is_modified = True
 
615
        self._write_inventory(inv)
683
616
 
684
617
    @needs_tree_write_lock
685
618
    def _gather_kinds(self, files, kinds):
745
678
        if updated:
746
679
            self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
747
680
 
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))
 
681
    @deprecated_method(zero_eleven)
 
682
    @needs_read_lock
 
683
    def pending_merges(self):
 
684
        """Return a list of pending merges.
 
685
 
 
686
        These are revisions that have been merged into the working
 
687
        directory but not yet committed.
 
688
 
 
689
        As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
 
690
        instead - which is available on all tree objects.
 
691
        """
 
692
        return self.get_parent_ids()[1:]
781
693
 
782
694
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
783
695
        """Common ghost checking functionality from set_parent_*.
793
705
 
794
706
    def _set_merges_from_parent_ids(self, parent_ids):
795
707
        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
 
708
        self._control_files.put_utf8('pending-merges', '\n'.join(merges))
817
709
 
818
710
    @needs_tree_write_lock
819
711
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
820
712
        """Set the parent ids to revision_ids.
821
 
 
 
713
        
822
714
        See also set_parent_trees. This api will try to retrieve the tree data
823
715
        for each element of revision_ids from the trees repository. If you have
824
716
        tree data already available, it is more efficient to use
828
720
        :param revision_ids: The revision_ids to set as the parent ids of this
829
721
            working tree. Any of these may be ghosts.
830
722
        """
 
723
        revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
831
724
        self._check_parents_for_ghosts(revision_ids,
832
725
            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
726
 
838
727
        if len(revision_ids) > 0:
839
728
            self.set_last_revision(revision_ids[0])
840
729
        else:
841
 
            self.set_last_revision(_mod_revision.NULL_REVISION)
 
730
            self.set_last_revision(None)
842
731
 
843
732
        self._set_merges_from_parent_ids(revision_ids)
844
733
 
845
734
    @needs_tree_write_lock
846
735
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
847
736
        """See MutableTree.set_parent_trees."""
848
 
        parent_ids = [rev for (rev, tree) in parents_list]
849
 
        for revision_id in parent_ids:
850
 
            _mod_revision.check_not_reserved_id(revision_id)
 
737
        parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
851
738
 
852
739
        self._check_parents_for_ghosts(parent_ids,
853
740
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
854
741
 
855
 
        parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
856
 
 
857
742
        if len(parent_ids) == 0:
858
 
            leftmost_parent_id = _mod_revision.NULL_REVISION
 
743
            leftmost_parent_id = None
859
744
            leftmost_parent_tree = None
860
745
        else:
861
746
            leftmost_parent_id, leftmost_parent_tree = parents_list[0]
883
768
    def set_merge_modified(self, modified_hashes):
884
769
        def iter_stanzas():
885
770
            for file_id, hash in modified_hashes.iteritems():
886
 
                yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
 
771
                yield Stanza(file_id=file_id, hash=hash)
887
772
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
888
773
 
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
 
 
 
774
    @needs_tree_write_lock
899
775
    def _put_rio(self, filename, stanzas, header):
900
 
        self._must_be_locked()
901
776
        my_file = rio_file(stanzas, header)
902
 
        self._transport.put_file(filename, my_file,
903
 
            mode=self.bzrdir._get_file_mode())
 
777
        self._control_files.put(filename, my_file)
904
778
 
905
779
    @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):
 
780
    def merge_from_branch(self, branch, to_revision=None):
908
781
        """Merge from a branch into this working tree.
909
782
 
910
783
        :param branch: The branch to merge from.
914
787
            branch.last_revision().
915
788
        """
916
789
        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:
 
790
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
791
        try:
 
792
            merger = Merger(self.branch, this_tree=self, pb=pb)
 
793
            merger.pp = ProgressPhase("Merge phase", 5, pb)
 
794
            merger.pp.next_phase()
 
795
            # check that there are no
 
796
            # local alterations
 
797
            merger.check_basis(check_clean=True, require_commits=False)
 
798
            if to_revision is None:
 
799
                to_revision = branch.last_revision()
 
800
            else:
 
801
                to_revision = osutils.safe_revision_id(to_revision)
 
802
            merger.other_rev_id = to_revision
 
803
            if merger.other_rev_id is None:
 
804
                raise error.NoCommits(branch)
 
805
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
806
            merger.other_basis = merger.other_rev_id
 
807
            merger.other_tree = self.branch.repository.revision_tree(
 
808
                merger.other_rev_id)
 
809
            merger.pp.next_phase()
932
810
            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:
 
811
            if merger.base_rev_id == merger.other_rev_id:
 
812
                raise errors.PointlessMerge
 
813
            merger.backup_files = False
939
814
            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()
 
815
            merger.set_interesting_files(None)
 
816
            merger.show_base = False
 
817
            merger.reprocess = False
 
818
            conflicts = merger.do_merge()
 
819
            merger.set_pending()
 
820
        finally:
 
821
            pb.finished()
947
822
        return conflicts
948
823
 
949
824
    @needs_read_lock
950
825
    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
826
        try:
961
 
            hashfile = self._transport.get('merge-hashes')
 
827
            hashfile = self._control_files.get('merge-hashes')
962
828
        except errors.NoSuchFile:
963
829
            return {}
 
830
        merge_hashes = {}
964
831
        try:
965
 
            merge_hashes = {}
966
 
            try:
967
 
                if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
968
 
                    raise errors.MergeModifiedFormatError()
969
 
            except StopIteration:
 
832
            if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
970
833
                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()
 
834
        except StopIteration:
 
835
            raise errors.MergeModifiedFormatError()
 
836
        for s in RioReader(hashfile):
 
837
            file_id = s.get("file_id")
 
838
            if file_id not in self.inventory:
 
839
                continue
 
840
            hash = s.get("hash")
 
841
            if hash == self.get_file_sha1(file_id):
 
842
                merge_hashes[file_id] = hash
 
843
        return merge_hashes
982
844
 
983
845
    @needs_write_lock
984
846
    def mkdir(self, path, file_id=None):
990
852
        return file_id
991
853
 
992
854
    def get_symlink_target(self, file_id):
993
 
        abspath = self.id2abspath(file_id)
994
 
        target = osutils.readlink(abspath)
995
 
        return target
996
 
 
997
 
    @needs_write_lock
998
 
    def subsume(self, other_tree):
999
 
        def add_children(inventory, entry):
1000
 
            for child_entry in entry.children.values():
1001
 
                inventory._byid[child_entry.file_id] = child_entry
1002
 
                if child_entry.kind == 'directory':
1003
 
                    add_children(inventory, child_entry)
1004
 
        if other_tree.get_root_id() == self.get_root_id():
1005
 
            raise errors.BadSubsumeSource(self, other_tree,
1006
 
                                          'Trees have the same root')
1007
 
        try:
1008
 
            other_tree_path = self.relpath(other_tree.basedir)
1009
 
        except errors.PathNotChild:
1010
 
            raise errors.BadSubsumeSource(self, other_tree,
1011
 
                'Tree is not contained by the other')
1012
 
        new_root_parent = self.path2id(osutils.dirname(other_tree_path))
1013
 
        if new_root_parent is None:
1014
 
            raise errors.BadSubsumeSource(self, other_tree,
1015
 
                'Parent directory is not versioned.')
1016
 
        # We need to ensure that the result of a fetch will have a
1017
 
        # versionedfile for the other_tree root, and only fetching into
1018
 
        # RepositoryKnit2 guarantees that.
1019
 
        if not self.branch.repository.supports_rich_root():
1020
 
            raise errors.SubsumeTargetNeedsUpgrade(other_tree)
1021
 
        other_tree.lock_tree_write()
1022
 
        try:
1023
 
            new_parents = other_tree.get_parent_ids()
1024
 
            other_root = other_tree.inventory.root
1025
 
            other_root.parent_id = new_root_parent
1026
 
            other_root.name = osutils.basename(other_tree_path)
1027
 
            self.inventory.add(other_root)
1028
 
            add_children(self.inventory, other_root)
1029
 
            self._write_inventory(self.inventory)
1030
 
            # normally we don't want to fetch whole repositories, but i think
1031
 
            # here we really do want to consolidate the whole thing.
1032
 
            for parent_id in other_tree.get_parent_ids():
1033
 
                self.branch.fetch(other_tree.branch, parent_id)
1034
 
                self.add_parent_tree_id(parent_id)
1035
 
        finally:
1036
 
            other_tree.unlock()
1037
 
        other_tree.bzrdir.retire_bzrdir()
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
1064
 
 
1065
 
    @needs_tree_write_lock
1066
 
    def extract(self, file_id, format=None):
1067
 
        """Extract a subtree from this tree.
1068
 
 
1069
 
        A new branch will be created, relative to the path for this tree.
1070
 
        """
1071
 
        self.flush()
1072
 
        def mkdirs(path):
1073
 
            segments = osutils.splitpath(path)
1074
 
            transport = self.branch.bzrdir.root_transport
1075
 
            for name in segments:
1076
 
                transport = transport.clone(name)
1077
 
                transport.ensure_base()
1078
 
            return transport
1079
 
 
1080
 
        sub_path = self.id2path(file_id)
1081
 
        branch_transport = mkdirs(sub_path)
1082
 
        if format is None:
1083
 
            format = self.bzrdir.cloning_metadir()
1084
 
        branch_transport.ensure_base()
1085
 
        branch_bzrdir = format.initialize_on_transport(branch_transport)
1086
 
        try:
1087
 
            repo = branch_bzrdir.find_repository()
1088
 
        except errors.NoRepositoryPresent:
1089
 
            repo = branch_bzrdir.create_repository()
1090
 
        if not repo.supports_rich_root():
1091
 
            raise errors.RootNotRich()
1092
 
        new_branch = branch_bzrdir.create_branch()
1093
 
        new_branch.pull(self.branch)
1094
 
        for parent_id in self.get_parent_ids():
1095
 
            new_branch.fetch(self.branch, parent_id)
1096
 
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
1097
 
        if tree_transport.base != branch_transport.base:
1098
 
            tree_bzrdir = format.initialize_on_transport(tree_transport)
1099
 
            branch.BranchReferenceFormat().initialize(tree_bzrdir,
1100
 
                target_branch=new_branch)
1101
 
        else:
1102
 
            tree_bzrdir = branch_bzrdir
1103
 
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1104
 
        wt.set_parent_ids(self.get_parent_ids())
1105
 
        my_inv = self.inventory
1106
 
        child_inv = inventory.Inventory(root_id=None)
1107
 
        new_root = my_inv[file_id]
1108
 
        my_inv.remove_recursive_id(file_id)
1109
 
        new_root.parent_id = None
1110
 
        child_inv.add(new_root)
1111
 
        self._write_inventory(my_inv)
1112
 
        wt._write_inventory(child_inv)
1113
 
        return wt
1114
 
 
1115
 
    def _serialize(self, inventory, out_file):
1116
 
        xml5.serializer_v5.write_inventory(self._inventory, out_file,
1117
 
            working=True)
1118
 
 
1119
 
    def _deserialize(selt, in_file):
1120
 
        return xml5.serializer_v5.read_inventory(in_file)
 
855
        return os.readlink(self.id2abspath(file_id))
 
856
 
 
857
    def file_class(self, filename):
 
858
        if self.path2id(filename):
 
859
            return 'V'
 
860
        elif self.is_ignored(filename):
 
861
            return 'I'
 
862
        else:
 
863
            return '?'
1121
864
 
1122
865
    def flush(self):
1123
866
        """Write the in memory inventory to disk."""
1125
868
        if self._control_files._lock_mode != 'w':
1126
869
            raise errors.NotWriteLocked(self)
1127
870
        sio = StringIO()
1128
 
        self._serialize(self._inventory, sio)
 
871
        xml5.serializer_v5.write_inventory(self._inventory, sio)
1129
872
        sio.seek(0)
1130
 
        self._transport.put_file('inventory', sio,
1131
 
            mode=self.bzrdir._get_file_mode())
 
873
        self._control_files.put('inventory', sio)
1132
874
        self._inventory_is_modified = False
1133
875
 
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).
 
876
    def list_files(self, include_root=False):
 
877
        """Recursively list all files as (path, class, kind, id, entry).
1139
878
 
1140
879
        Lists, but does not descend into unversioned directories.
 
880
 
1141
881
        This does not include files that have been deleted in this
1142
 
        tree. Skips the control directory.
 
882
        tree.
1143
883
 
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
 
884
        Skips the control directory.
1147
885
        """
1148
886
        # list_files is an iterator, so @needs_read_lock doesn't work properly
1149
887
        # with it. So callers should be careful to always read_lock the tree.
1151
889
            raise errors.ObjectNotLocked(self)
1152
890
 
1153
891
        inv = self.inventory
1154
 
        if from_dir is None and include_root is True:
 
892
        if include_root is True:
1155
893
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1156
894
        # Convert these into local objects to save lookup times
1157
895
        pathjoin = osutils.pathjoin
1158
 
        file_kind = self._kind
 
896
        file_kind = osutils.file_kind
1159
897
 
1160
898
        # transport.base ends in a slash, we want the piece
1161
899
        # between the last two slashes
1164
902
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1165
903
 
1166
904
        # 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)
 
905
        children = os.listdir(self.basedir)
1177
906
        children.sort()
1178
 
        # jam 20060527 The kernel sized tree seems equivalent whether we
 
907
        # jam 20060527 The kernel sized tree seems equivalent whether we 
1179
908
        # use a deque and popleft to keep them sorted, or if we use a plain
1180
909
        # list and just reverse() them.
1181
910
        children = collections.deque(children)
1182
 
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
 
911
        stack = [(inv.root.file_id, u'', self.basedir, children)]
1183
912
        while stack:
1184
913
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1185
914
 
1201
930
 
1202
931
                # absolute path
1203
932
                fap = from_dir_abspath + '/' + f
1204
 
 
 
933
                
1205
934
                f_ie = inv.get_child(from_dir_id, f)
1206
935
                if f_ie:
1207
936
                    c = 'V'
1230
959
 
1231
960
                fk = file_kind(fap)
1232
961
 
 
962
                if f_ie:
 
963
                    if f_ie.kind != fk:
 
964
                        raise errors.BzrCheckError(
 
965
                            "file %r entered as kind %r id %r, now of kind %r"
 
966
                            % (fap, f_ie.kind, f_ie.file_id, fk))
 
967
 
1233
968
                # make a last minute entry
1234
969
                if f_ie:
1235
970
                    yield fp[1:], c, fk, f_ie.file_id, f_ie
1239
974
                    except KeyError:
1240
975
                        yield fp[1:], c, fk, None, TreeEntry()
1241
976
                    continue
1242
 
 
 
977
                
1243
978
                if fk != 'directory':
1244
979
                    continue
1245
980
 
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
 
981
                # But do this child first
 
982
                new_children = os.listdir(fap)
 
983
                new_children.sort()
 
984
                new_children = collections.deque(new_children)
 
985
                stack.append((f_ie.file_id, fp, fap, new_children))
 
986
                # Break out of inner loop,
 
987
                # so that we start outer loop with child
 
988
                break
1255
989
            else:
1256
990
                # if we finished all children, pop it off the stack
1257
991
                stack.pop()
1263
997
        to_dir must exist in the inventory.
1264
998
 
1265
999
        If to_dir exists and is a directory, the files are moved into
1266
 
        it, keeping their old names.
 
1000
        it, keeping their old names.  
1267
1001
 
1268
1002
        Note that to_dir is only the last component of the new name;
1269
1003
        this doesn't change the directory.
1306
1040
                                       DeprecationWarning)
1307
1041
 
1308
1042
        # check destination directory
1309
 
        if isinstance(from_paths, basestring):
1310
 
            raise ValueError()
 
1043
        assert not isinstance(from_paths, basestring)
1311
1044
        inv = self.inventory
1312
1045
        to_abs = self.abspath(to_dir)
1313
1046
        if not isdir(to_abs):
1397
1130
                only_change_inv = True
1398
1131
            elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1399
1132
                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
1133
            else:
1405
1134
                # something is wrong, so lets determine what exactly
1406
1135
                if not self.has_filename(from_rel) and \
1409
1138
                        errors.PathsDoNotExist(paths=(str(from_rel),
1410
1139
                        str(to_rel))))
1411
1140
                else:
1412
 
                    raise errors.RenameFailedFilesExist(from_rel, to_rel)
 
1141
                    raise errors.RenameFailedFilesExist(from_rel, to_rel,
 
1142
                        extra="(Use --after to update the Bazaar id)")
1413
1143
            rename_entry.only_change_inv = only_change_inv
1414
1144
        return rename_entries
1415
1145
 
1435
1165
        inv = self.inventory
1436
1166
        for entry in moved:
1437
1167
            try:
1438
 
                self._move_entry(WorkingTree._RenameEntry(
1439
 
                    entry.to_rel, entry.from_id,
 
1168
                self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1440
1169
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
1441
1170
                    entry.from_tail, entry.from_parent_id,
1442
1171
                    entry.only_change_inv))
1493
1222
        from_tail = splitpath(from_rel)[-1]
1494
1223
        from_id = inv.path2id(from_rel)
1495
1224
        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]
 
1225
            raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1226
                errors.NotVersionedError(path=str(from_rel)))
 
1227
        from_entry = inv[from_id]
1507
1228
        from_parent_id = from_entry.parent_id
1508
1229
        to_dir, to_tail = os.path.split(to_rel)
1509
1230
        to_dir_id = inv.path2id(to_dir)
1555
1276
        These are files in the working directory that are not versioned or
1556
1277
        control files or ignored.
1557
1278
        """
1558
 
        # force the extras method to be fully executed before returning, to
 
1279
        # force the extras method to be fully executed before returning, to 
1559
1280
        # prevent race conditions with the lock
1560
1281
        return iter(
1561
1282
            [subp for subp in self.extras() if not self.is_ignored(subp)])
1562
 
 
 
1283
    
1563
1284
    @needs_tree_write_lock
1564
1285
    def unversion(self, file_ids):
1565
1286
        """Remove the file ids in file_ids from the current versioned set.
1571
1292
        :raises: NoSuchId if any fileid is not currently versioned.
1572
1293
        """
1573
1294
        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
1295
            if self._inventory.has_id(file_id):
1578
1296
                self._inventory.remove_recursive_id(file_id)
 
1297
            else:
 
1298
                raise errors.NoSuchId(self, file_id)
1579
1299
        if len(file_ids):
1580
 
            # in the future this should just set a dirty bit to wait for the
 
1300
            # in the future this should just set a dirty bit to wait for the 
1581
1301
            # final unlock. However, until all methods of workingtree start
1582
 
            # with the current in -memory inventory rather than triggering
 
1302
            # with the current in -memory inventory rather than triggering 
1583
1303
            # a read, it is more complex - we need to teach read_inventory
1584
1304
            # to know when to read, and when to not read first... and possibly
1585
1305
            # to save first when the in memory one may be corrupted.
1586
1306
            # so for now, we just only write it if it is indeed dirty.
1587
1307
            # - RBC 20060907
1588
1308
            self._write_inventory(self._inventory)
 
1309
    
 
1310
    @deprecated_method(zero_eight)
 
1311
    def iter_conflicts(self):
 
1312
        """List all files in the tree that have text or content conflicts.
 
1313
        DEPRECATED.  Use conflicts instead."""
 
1314
        return self._iter_conflicts()
1589
1315
 
1590
1316
    def _iter_conflicts(self):
1591
1317
        conflicted = set()
1600
1326
 
1601
1327
    @needs_write_lock
1602
1328
    def pull(self, source, overwrite=False, stop_revision=None,
1603
 
             change_reporter=None, possible_transports=None, local=False):
 
1329
             change_reporter=None):
 
1330
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1604
1331
        source.lock_read()
1605
1332
        try:
 
1333
            pp = ProgressPhase("Pull phase", 2, top_pb)
 
1334
            pp.next_phase()
1606
1335
            old_revision_info = self.branch.last_revision_info()
1607
1336
            basis_tree = self.basis_tree()
1608
 
            count = self.branch.pull(source, overwrite, stop_revision,
1609
 
                                     possible_transports=possible_transports,
1610
 
                                     local=local)
 
1337
            count = self.branch.pull(source, overwrite, stop_revision)
1611
1338
            new_revision_info = self.branch.last_revision_info()
1612
1339
            if new_revision_info != old_revision_info:
 
1340
                pp.next_phase()
1613
1341
                repository = self.branch.repository
 
1342
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
1614
1343
                basis_tree.lock_read()
1615
1344
                try:
1616
1345
                    new_basis_tree = self.branch.basis_tree()
1619
1348
                                new_basis_tree,
1620
1349
                                basis_tree,
1621
1350
                                this_tree=self,
1622
 
                                pb=None,
 
1351
                                pb=pb,
1623
1352
                                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)
 
1353
                    if (basis_tree.inventory.root is None and
 
1354
                        new_basis_tree.inventory.root is not None):
 
1355
                        self.set_root_id(new_basis_tree.inventory.root.file_id)
1628
1356
                finally:
 
1357
                    pb.finished()
1629
1358
                    basis_tree.unlock()
1630
1359
                # TODO - dedup parents list with things merged by pull ?
1631
1360
                # reuse the revisiontree we merged against to set the new
1632
1361
                # tree data.
1633
1362
                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
 
1363
                # we have to pull the merge trees out again, because 
 
1364
                # merge_inner has set the ids. - this corner is not yet 
1636
1365
                # layered well enough to prevent double handling.
1637
1366
                # XXX TODO: Fix the double handling: telling the tree about
1638
1367
                # the already known parent data is wasteful.
1644
1373
            return count
1645
1374
        finally:
1646
1375
            source.unlock()
 
1376
            top_pb.finished()
1647
1377
 
1648
1378
    @needs_write_lock
1649
1379
    def put_file_bytes_non_atomic(self, file_id, bytes):
1656
1386
        # TODO: update the hashcache here ?
1657
1387
 
1658
1388
    def extras(self):
1659
 
        """Yield all unversioned files in this WorkingTree.
 
1389
        """Yield all unknown files in this WorkingTree.
1660
1390
 
1661
 
        If there are any unversioned directories then only the directory is
1662
 
        returned, not all its children.  But if there are unversioned files
 
1391
        If there are any unknown directories then only the directory is
 
1392
        returned, not all its children.  But if there are unknown files
1663
1393
        under a versioned subdirectory, they are returned.
1664
1394
 
1665
1395
        Currently returned depth-first, sorted by name within directories.
1666
 
        This is the same order used by 'osutils.walkdirs'.
1667
1396
        """
1668
1397
        ## TODO: Work from given directory downwards
1669
1398
        for path, dir_entry in self.inventory.directories():
1675
1404
 
1676
1405
            fl = []
1677
1406
            for subf in os.listdir(dirabs):
1678
 
                if self.bzrdir.is_control_filename(subf):
 
1407
                if subf == '.bzr':
1679
1408
                    continue
1680
1409
                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)
 
1410
                    subf_norm, can_access = osutils.normalized_filename(subf)
1689
1411
                    if subf_norm != subf and can_access:
1690
1412
                        if subf_norm not in dir_entry.children:
1691
1413
                            fl.append(subf_norm)
1692
1414
                    else:
1693
1415
                        fl.append(subf)
1694
 
 
 
1416
            
1695
1417
            fl.sort()
1696
1418
            for subf in fl:
1697
1419
                subp = pathjoin(path, subf)
1713
1435
        if ignoreset is not None:
1714
1436
            return ignoreset
1715
1437
 
1716
 
        ignore_globs = set()
 
1438
        ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1717
1439
        ignore_globs.update(ignores.get_runtime_ignores())
1718
1440
        ignore_globs.update(ignores.get_user_ignores())
1719
1441
        if self.has_filename(bzrlib.IGNORE_FILENAME):
1734
1456
        r"""Check whether the filename matches an ignore pattern.
1735
1457
 
1736
1458
        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.
 
1459
        others match against only the last component.
1740
1460
 
1741
1461
        If the file is ignored, returns the pattern which caused it to
1742
1462
        be ignored, otherwise None.  So this can simply be used as a
1743
1463
        boolean if desired."""
1744
1464
        if getattr(self, '_ignoreglobster', None) is None:
1745
 
            self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
 
1465
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1746
1466
        return self._ignoreglobster.match(filename)
1747
1467
 
1748
1468
    def kind(self, file_id):
1749
1469
        return file_kind(self.id2abspath(file_id))
1750
1470
 
1751
 
    def stored_kind(self, file_id):
1752
 
        """See Tree.stored_kind"""
1753
 
        return self.inventory[file_id].kind
1754
 
 
1755
1471
    def _comparison_data(self, entry, path):
1756
1472
        abspath = self.abspath(path)
1757
1473
        try:
1767
1483
            mode = stat_value.st_mode
1768
1484
            kind = osutils.file_kind_from_stat_mode(mode)
1769
1485
            if not supports_executable():
1770
 
                executable = entry is not None and entry.executable
 
1486
                executable = entry.executable
1771
1487
            else:
1772
1488
                executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1773
1489
        return kind, executable, stat_value
1788
1504
    @needs_read_lock
1789
1505
    def _last_revision(self):
1790
1506
        """helper for get_parent_ids."""
1791
 
        return _mod_revision.ensure_null(self.branch.last_revision())
 
1507
        return self.branch.last_revision()
1792
1508
 
1793
1509
    def is_locked(self):
1794
1510
        return self._control_files.is_locked()
1795
1511
 
1796
 
    def _must_be_locked(self):
1797
 
        if not self.is_locked():
1798
 
            raise errors.ObjectNotLocked(self)
1799
 
 
1800
1512
    def lock_read(self):
1801
1513
        """See Branch.lock_read, and WorkingTree.unlock."""
1802
 
        if not self.is_locked():
1803
 
            self._reset_data()
1804
1514
        self.branch.lock_read()
1805
1515
        try:
1806
1516
            return self._control_files.lock_read()
1810
1520
 
1811
1521
    def lock_tree_write(self):
1812
1522
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1813
 
        if not self.is_locked():
1814
 
            self._reset_data()
1815
1523
        self.branch.lock_read()
1816
1524
        try:
1817
1525
            return self._control_files.lock_write()
1821
1529
 
1822
1530
    def lock_write(self):
1823
1531
        """See MutableTree.lock_write, and WorkingTree.unlock."""
1824
 
        if not self.is_locked():
1825
 
            self._reset_data()
1826
1532
        self.branch.lock_write()
1827
1533
        try:
1828
1534
            return self._control_files.lock_write()
1836
1542
    def _basis_inventory_name(self):
1837
1543
        return 'basis-inventory-cache'
1838
1544
 
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
1545
    @needs_tree_write_lock
1850
1546
    def set_last_revision(self, new_revision):
1851
1547
        """Change the last revision in the working tree."""
 
1548
        new_revision = osutils.safe_revision_id(new_revision)
1852
1549
        if self._change_last_revision(new_revision):
1853
1550
            self._cache_basis_inventory(new_revision)
1854
1551
 
1855
1552
    def _change_last_revision(self, new_revision):
1856
1553
        """Template method part of set_last_revision to perform the change.
1857
 
 
 
1554
        
1858
1555
        This is used to allow WorkingTree3 instances to not affect branch
1859
1556
        when their last revision is set.
1860
1557
        """
1861
 
        if _mod_revision.is_null(new_revision):
 
1558
        if new_revision is None:
1862
1559
            self.branch.set_revision_history([])
1863
1560
            return False
1864
1561
        try:
1870
1567
 
1871
1568
    def _write_basis_inventory(self, xml):
1872
1569
        """Write the basis inventory XML to the basis-inventory file"""
 
1570
        assert isinstance(xml, str), 'serialised xml must be bytestring.'
1873
1571
        path = self._basis_inventory_name()
1874
1572
        sio = StringIO(xml)
1875
 
        self._transport.put_file(path, sio,
1876
 
            mode=self.bzrdir._get_file_mode())
 
1573
        self._control_files.put(path, sio)
1877
1574
 
1878
1575
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
1879
1576
        """Create the text that will be saved in basis-inventory"""
1880
 
        inventory.revision_id = revision_id
1881
 
        return xml7.serializer_v7.write_inventory_to_string(inventory)
 
1577
        # TODO: jam 20070209 This should be redundant, as the revision_id
 
1578
        #       as all callers should have already converted the revision_id to
 
1579
        #       utf8
 
1580
        inventory.revision_id = osutils.safe_revision_id(revision_id)
 
1581
        return xml6.serializer_v6.write_inventory_to_string(inventory)
1882
1582
 
1883
1583
    def _cache_basis_inventory(self, new_revision):
1884
1584
        """Cache new_revision as the basis inventory."""
1886
1586
        # as commit already has that ready-to-use [while the format is the
1887
1587
        # same, that is].
1888
1588
        try:
1889
 
            # this double handles the inventory - unpack and repack -
 
1589
            # this double handles the inventory - unpack and repack - 
1890
1590
            # but is easier to understand. We can/should put a conditional
1891
1591
            # in here based on whether the inventory is in the latest format
1892
1592
            # - perhaps we should repack all inventories on a repository
1893
1593
            # upgrade ?
1894
1594
            # the fast path is to copy the raw xml from the repository. If the
1895
 
            # xml contains 'revision_id="', then we assume the right
 
1595
            # xml contains 'revision_id="', then we assume the right 
1896
1596
            # revision_id is set. We must check for this full string, because a
1897
1597
            # root node id can legitimately look like 'revision_id' but cannot
1898
1598
            # contain a '"'.
1899
 
            xml = self.branch.repository._get_inventory_xml(new_revision)
 
1599
            xml = self.branch.repository.get_inventory_xml(new_revision)
1900
1600
            firstline = xml.split('\n', 1)[0]
1901
 
            if (not 'revision_id="' in firstline or
1902
 
                'format="7"' not in firstline):
1903
 
                inv = self.branch.repository._serializer.read_inventory_from_string(
1904
 
                    xml, new_revision)
 
1601
            if (not 'revision_id="' in firstline or 
 
1602
                'format="6"' not in firstline):
 
1603
                inv = self.branch.repository.deserialise_inventory(
 
1604
                    new_revision, xml)
1905
1605
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
1906
1606
            self._write_basis_inventory(xml)
1907
1607
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1910
1610
    def read_basis_inventory(self):
1911
1611
        """Read the cached basis inventory."""
1912
1612
        path = self._basis_inventory_name()
1913
 
        return self._transport.get_bytes(path)
1914
 
 
 
1613
        return self._control_files.get(path).read()
 
1614
        
1915
1615
    @needs_read_lock
1916
1616
    def read_working_inventory(self):
1917
1617
        """Read the working inventory.
1918
 
 
 
1618
        
1919
1619
        :raises errors.InventoryModified: read_working_inventory will fail
1920
1620
            when the current in memory inventory has been modified.
1921
1621
        """
1922
 
        # conceptually this should be an implementation detail of the tree.
 
1622
        # conceptually this should be an implementation detail of the tree. 
1923
1623
        # XXX: Deprecate this.
1924
1624
        # ElementTree does its own conversion from UTF-8, so open in
1925
1625
        # binary.
1926
1626
        if self._inventory_is_modified:
1927
1627
            raise errors.InventoryModified(self)
1928
 
        f = self._transport.get('inventory')
1929
 
        try:
1930
 
            result = self._deserialize(f)
1931
 
        finally:
1932
 
            f.close()
 
1628
        result = xml5.serializer_v5.read_inventory(
 
1629
            self._control_files.get('inventory'))
1933
1630
        self._set_inventory(result, dirty=False)
1934
1631
        return result
1935
1632
 
1936
1633
    @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.
 
1634
    def remove(self, files, verbose=False, to_file=None):
 
1635
        """Remove nominated files from the working inventory..
 
1636
 
 
1637
        This does not remove their text.  This does not run on XXX on what? RBC
 
1638
 
 
1639
        TODO: Refuse to remove modified files unless --force is given?
 
1640
 
 
1641
        TODO: Do something useful with directories.
 
1642
 
 
1643
        TODO: Should this remove the text or not?  Tough call; not
 
1644
        removing may be useful and the user can just use use rm, and
 
1645
        is the opposite of add.  Removing it is consistent with most
 
1646
        other tools.  Maybe an option.
1945
1647
        """
 
1648
        ## TODO: Normalize names
 
1649
        ## TODO: Remove nested loops; better scalability
1946
1650
        if isinstance(files, basestring):
1947
1651
            files = [files]
1948
1652
 
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.
 
1653
        inv = self.inventory
 
1654
 
 
1655
        # do this before any modifications
2018
1656
        for f in files:
2019
 
            fid = self.path2id(f)
2020
 
            message = None
 
1657
            fid = inv.path2id(f)
2021
1658
            if not fid:
2022
 
                message = "%s is not versioned." % (f,)
 
1659
                note("%s is not versioned."%f)
2023
1660
            else:
2024
1661
                if verbose:
2025
 
                    # having removed it, it must be either ignored or unknown
 
1662
                    # having remove it, it must be either ignored or unknown
2026
1663
                    if self.is_ignored(f):
2027
1664
                        new_status = 'I'
2028
1665
                    else:
2029
1666
                        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)
 
1667
                    textui.show_status(new_status, inv[fid].kind, f,
 
1668
                                       to_file=to_file)
 
1669
                del inv[fid]
 
1670
 
 
1671
        self._write_inventory(inv)
2058
1672
 
2059
1673
    @needs_tree_write_lock
2060
 
    def revert(self, filenames=None, old_tree=None, backups=True,
2061
 
               pb=None, report_changes=False):
 
1674
    def revert(self, filenames, old_tree=None, backups=True, 
 
1675
               pb=DummyProgress(), report_changes=False):
2062
1676
        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
1677
        if old_tree is None:
2069
 
            basis_tree = self.basis_tree()
2070
 
            basis_tree.lock_read()
2071
 
            old_tree = basis_tree
 
1678
            old_tree = self.basis_tree()
 
1679
        conflicts = transform.revert(self, old_tree, filenames, backups, pb,
 
1680
                                     report_changes)
 
1681
        if not len(filenames):
 
1682
            self.set_parent_ids(self.get_parent_ids()[:1])
 
1683
            resolve(self)
2072
1684
        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()
 
1685
            resolve(self, filenames, ignore_misses=True)
2092
1686
        return conflicts
2093
1687
 
2094
1688
    def revision_tree(self, revision_id):
2104
1698
                pass
2105
1699
            else:
2106
1700
                try:
2107
 
                    inv = xml7.serializer_v7.read_inventory_from_string(xml)
 
1701
                    inv = xml6.serializer_v6.read_inventory_from_string(xml)
2108
1702
                    # dont use the repository revision_tree api because we want
2109
1703
                    # to supply the inventory.
2110
1704
                    if inv.revision_id == revision_id:
2121
1715
    def set_inventory(self, new_inventory_list):
2122
1716
        from bzrlib.inventory import (Inventory,
2123
1717
                                      InventoryDirectory,
 
1718
                                      InventoryEntry,
2124
1719
                                      InventoryFile,
2125
1720
                                      InventoryLink)
2126
1721
        inv = Inventory(self.get_root_id())
2128
1723
            name = os.path.basename(path)
2129
1724
            if name == "":
2130
1725
                continue
2131
 
            # fixme, there should be a factory function inv,add_??
 
1726
            # fixme, there should be a factory function inv,add_?? 
2132
1727
            if kind == 'directory':
2133
1728
                inv.add(InventoryDirectory(file_id, name, parent))
2134
1729
            elif kind == 'file':
2142
1737
    @needs_tree_write_lock
2143
1738
    def set_root_id(self, file_id):
2144
1739
        """Set the root id for this tree."""
2145
 
        # for compatability
 
1740
        # for compatability 
2146
1741
        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)
 
1742
            symbol_versioning.warn(symbol_versioning.zero_twelve
 
1743
                % 'WorkingTree.set_root_id with fileid=None',
 
1744
                DeprecationWarning,
 
1745
                stacklevel=3)
 
1746
            file_id = ROOT_ID
2150
1747
        self._set_root_id(file_id)
2151
1748
 
2152
1749
    def _set_root_id(self, file_id):
2153
1750
        """Set the root id for this tree, in a format specific manner.
2154
1751
 
2155
 
        :param file_id: The file id to assign to the root. It must not be
 
1752
        :param file_id: The file id to assign to the root. It must not be 
2156
1753
            present in the current inventory or an error will occur. It must
2157
1754
            not be None, but rather a valid file id.
2158
1755
        """
2177
1774
 
2178
1775
    def unlock(self):
2179
1776
        """See Branch.unlock.
2180
 
 
 
1777
        
2181
1778
        WorkingTree locking just uses the Branch locking facilities.
2182
1779
        This is current because all working trees have an embedded branch
2183
1780
        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
 
1781
        between multiple working trees, i.e. via shared storage, then we 
2185
1782
        would probably want to lock both the local tree, and the branch.
2186
1783
        """
2187
1784
        raise NotImplementedError(self.unlock)
2188
1785
 
2189
 
    _marker = object()
2190
 
 
2191
 
    def update(self, change_reporter=None, possible_transports=None,
2192
 
               revision=None, old_tip=_marker):
 
1786
    def update(self):
2193
1787
        """Update a working tree along its branch.
2194
1788
 
2195
1789
        This will update the branch if its bound too, which means we have
2213
1807
        - Merge current state -> basis tree of the master w.r.t. the old tree
2214
1808
          basis.
2215
1809
        - 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
1810
        """
2223
 
        if self.branch.get_bound_location() is not None:
 
1811
        if self.branch.get_master_branch() is not None:
2224
1812
            self.lock_write()
2225
 
            update_branch = (old_tip is self._marker)
 
1813
            update_branch = True
2226
1814
        else:
2227
1815
            self.lock_tree_write()
2228
1816
            update_branch = False
2229
1817
        try:
2230
1818
            if update_branch:
2231
 
                old_tip = self.branch.update(possible_transports)
 
1819
                old_tip = self.branch.update()
2232
1820
            else:
2233
 
                if old_tip is self._marker:
2234
 
                    old_tip = None
2235
 
            return self._update_tree(old_tip, change_reporter, revision)
 
1821
                old_tip = None
 
1822
            return self._update_tree(old_tip)
2236
1823
        finally:
2237
1824
            self.unlock()
2238
1825
 
2239
1826
    @needs_tree_write_lock
2240
 
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
 
1827
    def _update_tree(self, old_tip=None):
2241
1828
        """Update a tree to the master branch.
2242
1829
 
2243
1830
        :param old_tip: if supplied, the previous tip revision the branch,
2249
1836
        # cant set that until we update the working trees last revision to be
2250
1837
        # one from the new branch, because it will just get absorbed by the
2251
1838
        # parent de-duplication logic.
2252
 
        #
 
1839
        # 
2253
1840
        # We MUST save it even if an error occurs, because otherwise the users
2254
1841
        # local work is unreferenced and will appear to have been lost.
2255
 
        #
2256
 
        nb_conflicts = 0
 
1842
        # 
 
1843
        result = 0
2257
1844
        try:
2258
1845
            last_rev = self.get_parent_ids()[0]
2259
1846
        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
 
 
 
1847
            last_rev = None
 
1848
        if last_rev != self.branch.last_revision():
 
1849
            # merge tree state up to new branch tip.
2285
1850
            basis = self.basis_tree()
2286
1851
            basis.lock_read()
2287
1852
            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()
 
1853
                to_tree = self.branch.basis_tree()
 
1854
                if basis.inventory.root is None:
 
1855
                    self.set_root_id(to_tree.inventory.root.file_id)
 
1856
                result += merge.merge_inner(
 
1857
                                      self.branch,
 
1858
                                      to_tree,
 
1859
                                      basis,
 
1860
                                      this_tree=self)
2292
1861
            finally:
2293
1862
                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)
2305
1863
            # TODO - dedup parents list with things merged by pull ?
2306
1864
            # reuse the tree we've updated to to set the basis:
2307
 
            parent_trees = [(revision, to_tree)]
 
1865
            parent_trees = [(self.branch.last_revision(), to_tree)]
2308
1866
            merges = self.get_parent_ids()[1:]
2309
1867
            # 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
 
1868
            # tree can decide whether to give us teh entire tree or give us a
2311
1869
            # lazy initialised tree. dirstate for instance will have the trees
2312
1870
            # in ram already, whereas a last-revision + basis-inventory tree
2313
1871
            # will not, but also does not need them when setting parents.
2314
1872
            for parent in merges:
2315
1873
                parent_trees.append(
2316
1874
                    (parent, self.branch.repository.revision_tree(parent)))
2317
 
            if not _mod_revision.is_null(old_tip):
 
1875
            if old_tip is not None:
2318
1876
                parent_trees.append(
2319
1877
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
2320
1878
            self.set_parent_trees(parent_trees)
2321
1879
            last_rev = parent_trees[0][0]
2322
 
        return nb_conflicts
 
1880
        else:
 
1881
            # the working tree had the same last-revision as the master
 
1882
            # branch did. We may still have pivot local work from the local
 
1883
            # branch into old_tip:
 
1884
            if old_tip is not None:
 
1885
                self.add_parent_tree_id(old_tip)
 
1886
        if old_tip and old_tip != last_rev:
 
1887
            # our last revision was not the prior branch last revision
 
1888
            # and we have converted that last revision to a pending merge.
 
1889
            # base is somewhere between the branch tip now
 
1890
            # and the now pending merge
 
1891
 
 
1892
            # Since we just modified the working tree and inventory, flush out
 
1893
            # the current state, before we modify it again.
 
1894
            # TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
 
1895
            #       requires it only because TreeTransform directly munges the
 
1896
            #       inventory and calls tree._write_inventory(). Ultimately we
 
1897
            #       should be able to remove this extra flush.
 
1898
            self.flush()
 
1899
            from bzrlib.revision import common_ancestor
 
1900
            try:
 
1901
                base_rev_id = common_ancestor(self.branch.last_revision(),
 
1902
                                              old_tip,
 
1903
                                              self.branch.repository)
 
1904
            except errors.NoCommonAncestor:
 
1905
                base_rev_id = None
 
1906
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
1907
            other_tree = self.branch.repository.revision_tree(old_tip)
 
1908
            result += merge.merge_inner(
 
1909
                                  self.branch,
 
1910
                                  other_tree,
 
1911
                                  base_tree,
 
1912
                                  this_tree=self)
 
1913
        return result
2323
1914
 
2324
1915
    def _write_hashcache_if_dirty(self):
2325
1916
        """Write out the hashcache if it is dirty."""
2376
1967
    def walkdirs(self, prefix=""):
2377
1968
        """Walk the directories of this tree.
2378
1969
 
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
1970
        This API returns a generator, which is only valid during the current
2385
1971
        tree transaction - within a single lock_read or lock_write duration.
2386
1972
 
2387
 
        If the tree is not locked, it may cause an error to be raised,
2388
 
        depending on the tree implementation.
 
1973
        If the tree is not locked, it may cause an error to be raised, depending
 
1974
        on the tree implementation.
2389
1975
        """
2390
1976
        disk_top = self.abspath(prefix)
2391
1977
        if disk_top.endswith('/'):
2397
1983
            current_disk = disk_iterator.next()
2398
1984
            disk_finished = False
2399
1985
        except OSError, e:
2400
 
            if not (e.errno == errno.ENOENT or
2401
 
                (sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
 
1986
            if e.errno != errno.ENOENT:
2402
1987
                raise
2403
1988
            current_disk = None
2404
1989
            disk_finished = True
2409
1994
            current_inv = None
2410
1995
            inv_finished = True
2411
1996
        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
1997
            if not disk_finished:
2419
1998
                # 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 -
 
1999
                if current_disk[0][1][top_strip_len:] == '':
 
2000
                    # osutils.walkdirs can be made nicer - 
2423
2001
                    # yield the path-from-prefix rather than the pathjoined
2424
2002
                    # 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])):
 
2003
                    bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
 
2004
                    if current_disk[1][bzrdir_loc][0] == '.bzr':
2430
2005
                        # we dont yield the contents of, or, .bzr itself.
2431
 
                        del cur_disk_dir_content[bzrdir_loc]
 
2006
                        del current_disk[1][bzrdir_loc]
2432
2007
            if inv_finished:
2433
2008
                # everything is unknown
2434
2009
                direction = 1
2436
2011
                # everything is missing
2437
2012
                direction = -1
2438
2013
            else:
2439
 
                direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
 
2014
                direction = cmp(current_inv[0][0], current_disk[0][0])
2440
2015
            if direction > 0:
2441
2016
                # disk is before inventory - unknown
2442
2017
                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
 
2018
                    relpath, basename, kind, stat, top_path in current_disk[1]]
 
2019
                yield (current_disk[0][0], None), dirblock
2446
2020
                try:
2447
2021
                    current_disk = disk_iterator.next()
2448
2022
                except StopIteration:
2450
2024
            elif direction < 0:
2451
2025
                # inventory is before disk - missing.
2452
2026
                dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2453
 
                    for relpath, basename, dkind, stat, fileid, kind in
 
2027
                    for relpath, basename, dkind, stat, fileid, kind in 
2454
2028
                    current_inv[1]]
2455
2029
                yield (current_inv[0][0], current_inv[0][1]), dirblock
2456
2030
                try:
2462
2036
                # merge the inventory and disk data together
2463
2037
                dirblock = []
2464
2038
                for relpath, subiterator in itertools.groupby(sorted(
2465
 
                    current_inv[1] + cur_disk_dir_content,
2466
 
                    key=operator.itemgetter(0)), operator.itemgetter(1)):
 
2039
                    current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2467
2040
                    path_elements = list(subiterator)
2468
2041
                    if len(path_elements) == 2:
2469
2042
                        inv_row, disk_row = path_elements
2495
2068
                    disk_finished = True
2496
2069
 
2497
2070
    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
2071
        _directory = 'directory'
2507
2072
        # get the root in the inventory
2508
2073
        inv = self.inventory
2522
2087
                relroot = ""
2523
2088
            # FIXME: stash the node in pending
2524
2089
            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
 
                        ))
 
2090
            for name, child in entry.sorted_children():
 
2091
                dirblock.append((relroot + name, name, child.kind, None,
 
2092
                    child.file_id, child.kind
 
2093
                    ))
2530
2094
            yield (currentdir[0], entry.file_id), dirblock
2531
2095
            # push the user specified dirs from dirblock
2532
2096
            for dir in reversed(dirblock):
2533
2097
                if dir[2] == _directory:
2534
2098
                    pending.append(dir)
2535
2099
 
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
2100
 
2611
2101
class WorkingTree2(WorkingTree):
2612
2102
    """This is the Format 2 working tree.
2613
2103
 
2614
 
    This was the first weave based working tree.
 
2104
    This was the first weave based working tree. 
2615
2105
     - uses os locks for locking.
2616
2106
     - uses the branch last-revision.
2617
2107
    """
2618
2108
 
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
2109
    def lock_tree_write(self):
2635
2110
        """See WorkingTree.lock_tree_write().
2636
2111
 
2645
2120
            raise
2646
2121
 
2647
2122
    def unlock(self):
2648
 
        # do non-implementation specific cleanup
2649
 
        self._cleanup()
2650
 
 
2651
2123
        # we share control files:
2652
2124
        if self._control_files._lock_count == 3:
2653
2125
            # _inventory_is_modified is always False during a read lock.
2654
2126
            if self._inventory_is_modified:
2655
2127
                self.flush()
2656
2128
            self._write_hashcache_if_dirty()
2657
 
 
 
2129
                    
2658
2130
        # reverse order of locking.
2659
2131
        try:
2660
2132
            return self._control_files.unlock()
2676
2148
    def _last_revision(self):
2677
2149
        """See Mutable.last_revision."""
2678
2150
        try:
2679
 
            return self._transport.get_bytes('last-revision')
 
2151
            return osutils.safe_revision_id(
 
2152
                        self._control_files.get('last-revision').read())
2680
2153
        except errors.NoSuchFile:
2681
 
            return _mod_revision.NULL_REVISION
 
2154
            return None
2682
2155
 
2683
2156
    def _change_last_revision(self, revision_id):
2684
2157
        """See WorkingTree._change_last_revision."""
2685
 
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
 
2158
        if revision_id is None or revision_id == NULL_REVISION:
2686
2159
            try:
2687
 
                self._transport.delete('last-revision')
 
2160
                self._control_files._transport.delete('last-revision')
2688
2161
            except errors.NoSuchFile:
2689
2162
                pass
2690
2163
            return False
2691
2164
        else:
2692
 
            self._transport.put_bytes('last-revision', revision_id,
2693
 
                mode=self.bzrdir._get_file_mode())
 
2165
            self._control_files.put_utf8('last-revision', revision_id)
2694
2166
            return True
2695
2167
 
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
2168
    @needs_tree_write_lock
2701
2169
    def set_conflicts(self, conflicts):
2702
 
        self._put_rio('conflicts', conflicts.to_stanzas(),
 
2170
        self._put_rio('conflicts', conflicts.to_stanzas(), 
2703
2171
                      CONFLICT_HEADER_1)
2704
2172
 
2705
2173
    @needs_tree_write_lock
2712
2180
    @needs_read_lock
2713
2181
    def conflicts(self):
2714
2182
        try:
2715
 
            confile = self._transport.get('conflicts')
 
2183
            confile = self._control_files.get('conflicts')
2716
2184
        except errors.NoSuchFile:
2717
2185
            return _mod_conflicts.ConflictList()
2718
2186
        try:
2719
 
            try:
2720
 
                if confile.next() != CONFLICT_HEADER_1 + '\n':
2721
 
                    raise errors.ConflictFormatError()
2722
 
            except StopIteration:
 
2187
            if confile.next() != CONFLICT_HEADER_1 + '\n':
2723
2188
                raise errors.ConflictFormatError()
2724
 
            return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2725
 
        finally:
2726
 
            confile.close()
 
2189
        except StopIteration:
 
2190
            raise errors.ConflictFormatError()
 
2191
        return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2727
2192
 
2728
2193
    def unlock(self):
2729
 
        # do non-implementation specific cleanup
2730
 
        self._cleanup()
2731
2194
        if self._control_files._lock_count == 1:
2732
2195
            # _inventory_is_modified is always False during a read lock.
2733
2196
            if self._inventory_is_modified:
2746
2209
            return path[:-len(suffix)]
2747
2210
 
2748
2211
 
 
2212
@deprecated_function(zero_eight)
 
2213
def is_control_file(filename):
 
2214
    """See WorkingTree.is_control_filename(filename)."""
 
2215
    ## FIXME: better check
 
2216
    filename = normpath(filename)
 
2217
    while filename != '':
 
2218
        head, tail = os.path.split(filename)
 
2219
        ## mutter('check %r for control file' % ((head, tail),))
 
2220
        if tail == '.bzr':
 
2221
            return True
 
2222
        if filename == head:
 
2223
            break
 
2224
        filename = head
 
2225
    return False
 
2226
 
 
2227
 
2749
2228
class WorkingTreeFormat(object):
2750
2229
    """An encapsulation of the initialization and open routines for a format.
2751
2230
 
2754
2233
     * a format string,
2755
2234
     * an open routine.
2756
2235
 
2757
 
    Formats are placed in an dict by their format string for reference
 
2236
    Formats are placed in an dict by their format string for reference 
2758
2237
    during workingtree opening. Its not required that these be instances, they
2759
 
    can be classes themselves with class methods - it simply depends on
 
2238
    can be classes themselves with class methods - it simply depends on 
2760
2239
    whether state is needed for a given format or not.
2761
2240
 
2762
2241
    Once a format is deprecated, just deprecate the initialize and open
2763
 
    methods on the format class. Do not deprecate the object, as the
 
2242
    methods on the format class. Do not deprecate the object, as the 
2764
2243
    object will be created every time regardless.
2765
2244
    """
2766
2245
 
2770
2249
    _formats = {}
2771
2250
    """The known formats."""
2772
2251
 
2773
 
    requires_rich_root = False
2774
 
 
2775
 
    upgrade_recommended = False
2776
 
 
2777
2252
    @classmethod
2778
2253
    def find_format(klass, a_bzrdir):
2779
2254
        """Return the format for the working tree object in a_bzrdir."""
2780
2255
        try:
2781
2256
            transport = a_bzrdir.get_workingtree_transport(None)
2782
 
            format_string = transport.get_bytes("format")
 
2257
            format_string = transport.get("format").read()
2783
2258
            return klass._formats[format_string]
2784
2259
        except errors.NoSuchFile:
2785
2260
            raise errors.NoWorkingTree(base=transport.base)
2786
2261
        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)
 
2262
            raise errors.UnknownFormatError(format=format_string)
2795
2263
 
2796
2264
    @classmethod
2797
2265
    def get_default_format(klass):
2810
2278
        """Is this format supported?
2811
2279
 
2812
2280
        Supported formats can be initialized and opened.
2813
 
        Unsupported formats may not support initialization or committing or
 
2281
        Unsupported formats may not support initialization or committing or 
2814
2282
        some other features depending on the reason for not being supported.
2815
2283
        """
2816
2284
        return True
2817
2285
 
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
2286
    @classmethod
2827
2287
    def register_format(klass, format):
2828
2288
        klass._formats[format.get_format_string()] = format
2833
2293
 
2834
2294
    @classmethod
2835
2295
    def unregister_format(klass, format):
 
2296
        assert klass._formats[format.get_format_string()] is format
2836
2297
        del klass._formats[format.get_format_string()]
2837
2298
 
2838
2299
 
 
2300
 
2839
2301
class WorkingTreeFormat2(WorkingTreeFormat):
2840
 
    """The second working tree format.
 
2302
    """The second working tree format. 
2841
2303
 
2842
2304
    This format modified the hash cache from the format 1 hash cache.
2843
2305
    """
2844
2306
 
2845
 
    upgrade_recommended = True
2846
 
 
2847
2307
    def get_format_description(self):
2848
2308
        """See WorkingTreeFormat.get_format_description()."""
2849
2309
        return "Working tree format 2"
2850
2310
 
2851
 
    def _stub_initialize_on_transport(self, transport, file_mode):
2852
 
        """Workaround: create control files for a remote working tree.
2853
 
 
 
2311
    def stub_initialize_remote(self, control_files):
 
2312
        """As a special workaround create critical control files for a remote working tree
 
2313
        
2854
2314
        This ensures that it can later be updated and dealt with locally,
2855
 
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
 
2315
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with 
2856
2316
        no working tree.  (See bug #43064).
2857
2317
        """
2858
2318
        sio = StringIO()
2859
 
        inv = inventory.Inventory()
2860
 
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
 
2319
        inv = Inventory()
 
2320
        xml5.serializer_v5.write_inventory(inv, sio)
2861
2321
        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):
 
2322
        control_files.put('inventory', sio)
 
2323
 
 
2324
        control_files.put_utf8('pending-merges', '')
 
2325
        
 
2326
 
 
2327
    def initialize(self, a_bzrdir, revision_id=None):
2867
2328
        """See WorkingTreeFormat.initialize()."""
2868
2329
        if not isinstance(a_bzrdir.transport, LocalTransport):
2869
2330
            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()
 
2331
        branch = a_bzrdir.open_branch()
 
2332
        if revision_id is not None:
 
2333
            revision_id = osutils.safe_revision_id(revision_id)
 
2334
            branch.lock_write()
 
2335
            try:
 
2336
                revision_history = branch.revision_history()
 
2337
                try:
 
2338
                    position = revision_history.index(revision_id)
 
2339
                except ValueError:
 
2340
                    raise errors.NoSuchRevision(branch, revision_id)
 
2341
                branch.set_revision_history(revision_history[:position + 1])
 
2342
            finally:
 
2343
                branch.unlock()
 
2344
        revision = branch.last_revision()
 
2345
        inv = Inventory()
2882
2346
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2883
2347
                         branch,
2884
2348
                         inv,
2885
2349
                         _internal=True,
2886
2350
                         _format=self,
2887
2351
                         _bzrdir=a_bzrdir)
2888
 
        basis_tree = branch.repository.revision_tree(revision_id)
 
2352
        basis_tree = branch.repository.revision_tree(revision)
2889
2353
        if basis_tree.inventory.root is not None:
2890
 
            wt.set_root_id(basis_tree.get_root_id())
 
2354
            wt.set_root_id(basis_tree.inventory.root.file_id)
2891
2355
        # 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)
 
2356
        wt.set_parent_trees([(revision, basis_tree)])
2897
2357
        transform.build_tree(basis_tree, wt)
2898
2358
        return wt
2899
2359
 
2912
2372
            raise NotImplementedError
2913
2373
        if not isinstance(a_bzrdir.transport, LocalTransport):
2914
2374
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2915
 
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
 
2375
        return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2916
2376
                           _internal=True,
2917
2377
                           _format=self,
2918
2378
                           _bzrdir=a_bzrdir)
2919
 
        return wt
 
2379
 
2920
2380
 
2921
2381
class WorkingTreeFormat3(WorkingTreeFormat):
2922
2382
    """The second working tree format updated to record a format marker.
2930
2390
        - uses a LockDir to guard access for writes.
2931
2391
    """
2932
2392
 
2933
 
    upgrade_recommended = True
2934
 
 
2935
2393
    def get_format_string(self):
2936
2394
        """See WorkingTreeFormat.get_format_string()."""
2937
2395
        return "Bazaar-NG Working Tree format 3"
2943
2401
    _lock_file_name = 'lock'
2944
2402
    _lock_class = LockDir
2945
2403
 
2946
 
    _tree_class = WorkingTree3
2947
 
 
2948
 
    def __get_matchingbzrdir(self):
2949
 
        return bzrdir.BzrDirMetaFormat1()
2950
 
 
2951
 
    _matchingbzrdir = property(__get_matchingbzrdir)
2952
 
 
2953
2404
    def _open_control_files(self, a_bzrdir):
2954
2405
        transport = a_bzrdir.get_workingtree_transport(None)
2955
 
        return LockableFiles(transport, self._lock_file_name,
 
2406
        return LockableFiles(transport, self._lock_file_name, 
2956
2407
                             self._lock_class)
2957
2408
 
2958
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2959
 
                   accelerator_tree=None, hardlink=False):
 
2409
    def initialize(self, a_bzrdir, revision_id=None):
2960
2410
        """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.
 
2411
        
 
2412
        revision_id allows creating a working tree at a different
 
2413
        revision than the branch is at.
2970
2414
        """
2971
2415
        if not isinstance(a_bzrdir.transport, LocalTransport):
2972
2416
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2974
2418
        control_files = self._open_control_files(a_bzrdir)
2975
2419
        control_files.create_lock()
2976
2420
        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
 
2421
        control_files.put_utf8('format', self.get_format_string())
 
2422
        branch = a_bzrdir.open_branch()
 
2423
        if revision_id is None:
 
2424
            revision_id = branch.last_revision()
2981
2425
        else:
2982
 
            branch = a_bzrdir.open_branch()
2983
 
        if revision_id is None:
2984
 
            revision_id = _mod_revision.ensure_null(branch.last_revision())
 
2426
            revision_id = osutils.safe_revision_id(revision_id)
2985
2427
        # WorkingTree3 can handle an inventory which has a unique root id.
2986
2428
        # as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2987
2429
        # those trees. And because there isn't a format bump inbetween, we
2988
2430
        # are maintaining compatibility with older clients.
2989
2431
        # inv = Inventory(root_id=gen_root_id())
2990
 
        inv = self._initial_inventory()
2991
 
        wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
 
2432
        inv = Inventory()
 
2433
        wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2992
2434
                         branch,
2993
2435
                         inv,
2994
2436
                         _internal=True,
3000
2442
            basis_tree = branch.repository.revision_tree(revision_id)
3001
2443
            # only set an explicit root id if there is one to set.
3002
2444
            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:
 
2445
                wt.set_root_id(basis_tree.inventory.root.file_id)
 
2446
            if revision_id == NULL_REVISION:
3005
2447
                wt.set_parent_trees([])
3006
2448
            else:
3007
2449
                wt.set_parent_trees([(revision_id, basis_tree)])
3013
2455
            wt.unlock()
3014
2456
        return wt
3015
2457
 
3016
 
    def _initial_inventory(self):
3017
 
        return inventory.Inventory()
3018
 
 
3019
2458
    def __init__(self):
3020
2459
        super(WorkingTreeFormat3, self).__init__()
 
2460
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
3021
2461
 
3022
2462
    def open(self, a_bzrdir, _found=False):
3023
2463
        """Return the WorkingTree object for a_bzrdir
3030
2470
            raise NotImplementedError
3031
2471
        if not isinstance(a_bzrdir.transport, LocalTransport):
3032
2472
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
3033
 
        wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3034
 
        return wt
 
2473
        return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3035
2474
 
3036
2475
    def _open(self, a_bzrdir, control_files):
3037
2476
        """Open the tree itself.
3038
 
 
 
2477
        
3039
2478
        :param a_bzrdir: the dir for the tree.
3040
2479
        :param control_files: the control files for the tree.
3041
2480
        """
3042
 
        return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3043
 
                                _internal=True,
3044
 
                                _format=self,
3045
 
                                _bzrdir=a_bzrdir,
3046
 
                                _control_files=control_files)
 
2481
        return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
 
2482
                           _internal=True,
 
2483
                           _format=self,
 
2484
                           _bzrdir=a_bzrdir,
 
2485
                           _control_files=control_files)
3047
2486
 
3048
2487
    def __str__(self):
3049
2488
        return self.get_format_string()
3050
2489
 
3051
2490
 
3052
 
__default_format = WorkingTreeFormat6()
 
2491
__default_format = WorkingTreeFormat3()
3053
2492
WorkingTreeFormat.register_format(__default_format)
3054
 
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3055
2493
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3056
 
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3057
2494
WorkingTreeFormat.set_default_format(__default_format)
3058
2495
# formats which have no format string are not discoverable
3059
2496
# and not independently creatable, so are not registered.
3060
2497
_legacy_formats = [WorkingTreeFormat2(),
3061
2498
                   ]
 
2499
 
 
2500
 
 
2501
class WorkingTreeTestProviderAdapter(object):
 
2502
    """A tool to generate a suite testing multiple workingtree formats at once.
 
2503
 
 
2504
    This is done by copying the test once for each transport and injecting
 
2505
    the transport_server, transport_readonly_server, and workingtree_format
 
2506
    classes into each copy. Each copy is also given a new id() to make it
 
2507
    easy to identify.
 
2508
    """
 
2509
 
 
2510
    def __init__(self, transport_server, transport_readonly_server, formats):
 
2511
        self._transport_server = transport_server
 
2512
        self._transport_readonly_server = transport_readonly_server
 
2513
        self._formats = formats
 
2514
    
 
2515
    def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
 
2516
        """Clone test for adaption."""
 
2517
        new_test = deepcopy(test)
 
2518
        new_test.transport_server = self._transport_server
 
2519
        new_test.transport_readonly_server = self._transport_readonly_server
 
2520
        new_test.bzrdir_format = bzrdir_format
 
2521
        new_test.workingtree_format = workingtree_format
 
2522
        def make_new_test_id():
 
2523
            new_id = "%s(%s)" % (test.id(), variation)
 
2524
            return lambda: new_id
 
2525
        new_test.id = make_new_test_id()
 
2526
        return new_test
 
2527
    
 
2528
    def adapt(self, test):
 
2529
        from bzrlib.tests import TestSuite
 
2530
        result = TestSuite()
 
2531
        for workingtree_format, bzrdir_format in self._formats:
 
2532
            new_test = self._clone_test(
 
2533
                test,
 
2534
                bzrdir_format,
 
2535
                workingtree_format, workingtree_format.__class__.__name__)
 
2536
            result.addTest(new_test)
 
2537
        return result