/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

merge dirstate

Show diffs side-by-side

added added

removed removed

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