/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Robert Collins
  • Date: 2007-02-02 16:17:55 UTC
  • mto: (2257.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 2258.
  • Revision ID: robertc@robertcollins.net-20070202161755-zy2d68928wqwehj6
Allow 'import bzrlib.plugins.NAME' to work when the plugin NAME has not
yet been loaded by load_plugins(). This allows plugins to depend on each
other for code reuse without requiring users to perform file-renaming
gymnastics. (Robert Collins)

Show diffs side-by-side

added added

removed removed

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