~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Aaron Bentley
  • Date: 2006-12-13 17:21:18 UTC
  • mfrom: (2182.2.2 bzr.73948)
  • mto: This revision was merged to the branch mainline in revision 2184.
  • Revision ID: abentley@panoramicfeedback.com-20061213172118-pscayc7d4sbvo5uf
Make test HTTP server's range handling more spec-compliant (Vincent Ladeuil)

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