/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: Kent Gibson
  • Date: 2006-12-08 12:59:11 UTC
  • mto: (2178.1.1 jam-integration)
  • mto: This revision was merged to the branch mainline in revision 2179.
  • Revision ID: warthog618@gmail.com-20061208125911-wsnbxy7aydzjb47s
Implement JAM's review suggestions.

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