/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

(broken) merge aaron's workingtree format changes

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 
    # should be deprecated - this is slow and in any case treating them as a
377
 
    # container is (we now know) bad style -- mbp 20070302
378
 
    ## @deprecated_method(zero_fifteen)
379
364
    def __iter__(self):
380
365
        """Iterate through file_ids for this tree.
381
366
 
387
372
            if osutils.lexists(self.abspath(path)):
388
373
                yield ie.file_id
389
374
 
390
 
    def all_file_ids(self):
391
 
        """See Tree.iter_all_file_ids"""
392
 
        return set(self.inventory)
393
 
 
394
375
    def __repr__(self):
395
376
        return "<%s of %s>" % (self.__class__.__name__,
396
377
                               getattr(self, 'basedir', None))
397
378
 
398
379
    def abspath(self, filename):
399
380
        return pathjoin(self.basedir, filename)
400
 
 
 
381
    
401
382
    def basis_tree(self):
402
383
        """Return RevisionTree for the current last revision.
403
 
 
 
384
        
404
385
        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).
 
386
        empty tree - one obtained by calling repository.revision_tree(None).
407
387
        """
408
388
        try:
409
389
            revision_id = self.get_parent_ids()[0]
411
391
            # no parents, return an empty revision tree.
412
392
            # in the future this should return the tree for
413
393
            # 'empty:' - the implicit root empty tree.
414
 
            return self.branch.repository.revision_tree(
415
 
                       _mod_revision.NULL_REVISION)
 
394
            return self.branch.repository.revision_tree(None)
416
395
        try:
417
396
            return self.revision_tree(revision_id)
418
397
        except errors.NoSuchRevision:
422
401
        # at this point ?
423
402
        try:
424
403
            return self.branch.repository.revision_tree(revision_id)
425
 
        except (errors.RevisionNotPresent, errors.NoSuchRevision):
 
404
        except errors.RevisionNotPresent:
426
405
            # the basis tree *may* be a ghost or a low level error may have
427
 
            # occurred. If the revision is present, its a problem, if its not
 
406
            # occured. If the revision is present, its a problem, if its not
428
407
            # its a ghost.
429
408
            if self.branch.repository.has_revision(revision_id):
430
409
                raise
431
410
            # the basis tree is a ghost so return an empty tree.
432
 
            return self.branch.repository.revision_tree(
433
 
                       _mod_revision.NULL_REVISION)
434
 
 
435
 
    def _cleanup(self):
436
 
        self._flush_ignore_list_cache()
 
411
            return self.branch.repository.revision_tree(None)
 
412
 
 
413
    @staticmethod
 
414
    @deprecated_method(zero_eight)
 
415
    def create(branch, directory):
 
416
        """Create a workingtree for branch at directory.
 
417
 
 
418
        If existing_directory already exists it must have a .bzr directory.
 
419
        If it does not exist, it will be created.
 
420
 
 
421
        This returns a new WorkingTree object for the new checkout.
 
422
 
 
423
        TODO FIXME RBC 20060124 when we have checkout formats in place this
 
424
        should accept an optional revisionid to checkout [and reject this if
 
425
        checking out into the same dir as a pre-checkout-aware branch format.]
 
426
 
 
427
        XXX: When BzrDir is present, these should be created through that 
 
428
        interface instead.
 
429
        """
 
430
        warnings.warn('delete WorkingTree.create', stacklevel=3)
 
431
        transport = get_transport(directory)
 
432
        if branch.bzrdir.root_transport.base == transport.base:
 
433
            # same dir 
 
434
            return branch.bzrdir.create_workingtree()
 
435
        # different directory, 
 
436
        # create a branch reference
 
437
        # and now a working tree.
 
438
        raise NotImplementedError
 
439
 
 
440
    @staticmethod
 
441
    @deprecated_method(zero_eight)
 
442
    def create_standalone(directory):
 
443
        """Create a checkout and a branch and a repo at directory.
 
444
 
 
445
        Directory must exist and be empty.
 
446
 
 
447
        please use BzrDir.create_standalone_workingtree
 
448
        """
 
449
        return bzrdir.BzrDir.create_standalone_workingtree(directory)
437
450
 
438
451
    def relpath(self, path):
439
452
        """Return the local path portion from a given path.
440
 
 
441
 
        The path may be absolute or relative. If its a relative path it is
 
453
        
 
454
        The path may be absolute or relative. If its a relative path it is 
442
455
        interpreted relative to the python current working directory.
443
456
        """
444
457
        return osutils.relpath(self.basedir, path)
446
459
    def has_filename(self, filename):
447
460
        return osutils.lexists(self.abspath(filename))
448
461
 
449
 
    def get_file(self, file_id, path=None, filtered=True):
450
 
        return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
451
 
 
452
 
    def get_file_with_stat(self, file_id, path=None, filtered=True,
453
 
        _fstat=os.fstat):
454
 
        """See Tree.get_file_with_stat."""
455
 
        if path is None:
456
 
            path = self.id2path(file_id)
457
 
        file_obj = self.get_file_byname(path, filtered=False)
458
 
        stat_value = _fstat(file_obj.fileno())
459
 
        if filtered and self.supports_content_filtering():
460
 
            filters = self._content_filter_stack(path)
461
 
            file_obj = filtered_input_file(file_obj, filters)
462
 
        return (file_obj, stat_value)
463
 
 
464
 
    def get_file_text(self, file_id, path=None, filtered=True):
465
 
        return self.get_file(file_id, path=path, filtered=filtered).read()
466
 
 
467
 
    def get_file_byname(self, filename, filtered=True):
468
 
        path = self.abspath(filename)
469
 
        f = file(path, 'rb')
470
 
        if filtered and self.supports_content_filtering():
471
 
            filters = self._content_filter_stack(filename)
472
 
            return filtered_input_file(f, filters)
473
 
        else:
474
 
            return f
475
 
 
476
 
    def get_file_lines(self, file_id, path=None, filtered=True):
477
 
        """See Tree.get_file_lines()"""
478
 
        file = self.get_file(file_id, path, filtered=filtered)
479
 
        try:
480
 
            return file.readlines()
481
 
        finally:
482
 
            file.close()
 
462
    def get_file(self, file_id):
 
463
        file_id = osutils.safe_file_id(file_id)
 
464
        return self.get_file_byname(self.id2path(file_id))
 
465
 
 
466
    def get_file_text(self, file_id):
 
467
        file_id = osutils.safe_file_id(file_id)
 
468
        return self.get_file(file_id).read()
 
469
 
 
470
    def get_file_byname(self, filename):
 
471
        return file(self.abspath(filename), 'rb')
483
472
 
484
473
    @needs_read_lock
485
 
    def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
 
474
    def annotate_iter(self, file_id):
486
475
        """See Tree.annotate_iter
487
476
 
488
477
        This implementation will use the basis tree implementation if possible.
492
481
        incorrectly attributed to CURRENT_REVISION (but after committing, the
493
482
        attribution will be correct).
494
483
        """
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
 
484
        file_id = osutils.safe_file_id(file_id)
 
485
        basis = self.basis_tree()
 
486
        changes = self._iter_changes(basis, True, [self.id2path(file_id)],
 
487
            require_versioned=True).next()
 
488
        changed_content, kind = changes[2], changes[6]
 
489
        if not changed_content:
 
490
            return basis.annotate_iter(file_id)
 
491
        if kind[1] is None:
 
492
            return None
 
493
        import annotate
 
494
        if kind[0] != 'file':
 
495
            old_lines = []
 
496
        else:
 
497
            old_lines = list(basis.annotate_iter(file_id))
 
498
        old = [old_lines]
 
499
        for tree in self.branch.repository.revision_trees(
 
500
            self.get_parent_ids()[1:]):
 
501
            if file_id not in tree:
 
502
                continue
 
503
            old.append(list(tree.annotate_iter(file_id)))
 
504
        return annotate.reannotate(old, self.get_file(file_id).readlines(),
 
505
                                   CURRENT_REVISION)
538
506
 
539
507
    def get_parent_ids(self):
540
508
        """See Tree.get_parent_ids.
541
 
 
 
509
        
542
510
        This implementation reads the pending merges list and last_revision
543
511
        value and uses that to decide what the parents list should be.
544
512
        """
545
 
        last_rev = _mod_revision.ensure_null(self._last_revision())
546
 
        if _mod_revision.NULL_REVISION == last_rev:
 
513
        last_rev = self._last_revision()
 
514
        if last_rev is None:
547
515
            parents = []
548
516
        else:
549
517
            parents = [last_rev]
550
518
        try:
551
 
            merges_bytes = self._transport.get_bytes('pending-merges')
 
519
            merges_file = self._control_files.get('pending-merges')
552
520
        except errors.NoSuchFile:
553
521
            pass
554
522
        else:
555
 
            for l in osutils.split_lines(merges_bytes):
556
 
                revision_id = l.rstrip('\n')
 
523
            for l in merges_file.readlines():
 
524
                revision_id = osutils.safe_revision_id(l.rstrip('\n'))
557
525
                parents.append(revision_id)
558
526
        return parents
559
527
 
561
529
    def get_root_id(self):
562
530
        """Return the id of this trees root"""
563
531
        return self._inventory.root.file_id
564
 
 
 
532
        
565
533
    def _get_store_filename(self, file_id):
566
534
        ## XXX: badly named; this is not in the store at all
 
535
        file_id = osutils.safe_file_id(file_id)
567
536
        return self.abspath(self.id2path(file_id))
568
537
 
569
538
    @needs_read_lock
570
 
    def clone(self, to_bzrdir, revision_id=None):
 
539
    def clone(self, to_bzrdir, revision_id=None, basis=None):
571
540
        """Duplicate this working tree into to_bzr, including all state.
572
 
 
 
541
        
573
542
        Specifically modified files are kept as modified, but
574
543
        ignored and unknown files are discarded.
575
544
 
576
545
        If you want to make a new line of development, see bzrdir.sprout()
577
546
 
578
547
        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
 
548
            If not None, the cloned tree will have its last revision set to 
 
549
            revision, and and difference between the source trees last revision
581
550
            and this one merged in.
 
551
 
 
552
        basis
 
553
            If not None, a closer copy of a tree which may have some files in
 
554
            common, and which file content should be preferentially copied from.
582
555
        """
583
556
        # assumes the target bzr dir format is compatible.
584
 
        result = to_bzrdir.create_workingtree()
 
557
        result = self._format.initialize(to_bzrdir)
585
558
        self.copy_content_into(result, revision_id)
586
559
        return result
587
560
 
598
571
            tree.set_parent_ids([revision_id])
599
572
 
600
573
    def id2abspath(self, file_id):
 
574
        file_id = osutils.safe_file_id(file_id)
601
575
        return self.abspath(self.id2path(file_id))
602
576
 
603
577
    def has_id(self, file_id):
604
578
        # files that have been deleted are excluded
 
579
        file_id = osutils.safe_file_id(file_id)
605
580
        inv = self.inventory
606
581
        if not inv.has_id(file_id):
607
582
            return False
609
584
        return osutils.lexists(self.abspath(path))
610
585
 
611
586
    def has_or_had_id(self, file_id):
 
587
        file_id = osutils.safe_file_id(file_id)
612
588
        if file_id == self.inventory.root.file_id:
613
589
            return True
614
590
        return self.inventory.has_id(file_id)
616
592
    __contains__ = has_id
617
593
 
618
594
    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
 
595
        file_id = osutils.safe_file_id(file_id)
 
596
        return os.path.getsize(self.id2abspath(file_id))
629
597
 
630
598
    @needs_read_lock
631
599
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
600
        file_id = osutils.safe_file_id(file_id)
632
601
        if not path:
633
602
            path = self._inventory.id2path(file_id)
634
603
        return self._hashcache.get_sha1(path, stat_value)
635
604
 
636
605
    def get_file_mtime(self, file_id, path=None):
 
606
        file_id = osutils.safe_file_id(file_id)
637
607
        if not path:
638
 
            path = self.inventory.id2path(file_id)
 
608
            path = self._inventory.id2path(file_id)
639
609
        return os.lstat(self.abspath(path)).st_mtime
640
610
 
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
611
    if not supports_executable():
654
612
        def is_executable(self, file_id, path=None):
 
613
            file_id = osutils.safe_file_id(file_id)
655
614
            return self._inventory[file_id].executable
656
 
 
657
 
        _is_executable_from_path_and_stat = \
658
 
            _is_executable_from_path_and_stat_from_basis
659
615
    else:
660
616
        def is_executable(self, file_id, path=None):
661
617
            if not path:
 
618
                file_id = osutils.safe_file_id(file_id)
662
619
                path = self.id2path(file_id)
663
620
            mode = os.lstat(self.abspath(path)).st_mode
664
621
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
665
622
 
666
 
        _is_executable_from_path_and_stat = \
667
 
            _is_executable_from_path_and_stat_from_stat
668
 
 
669
 
    @needs_tree_write_lock
 
623
    @needs_write_lock
670
624
    def _add(self, files, ids, kinds):
671
625
        """See MutableTree._add."""
672
626
        # TODO: Re-adding a file that is removed in the working copy
673
627
        # should probably put it back with the previous ID.
674
 
        # the read and write working inventory should not occur in this
 
628
        # the read and write working inventory should not occur in this 
675
629
        # function - they should be part of lock_write and unlock.
676
 
        inv = self.inventory
 
630
        inv = self.read_working_inventory()
677
631
        for f, file_id, kind in zip(files, ids, kinds):
 
632
            assert kind is not None
678
633
            if file_id is None:
679
634
                inv.add_path(f, kind=kind)
680
635
            else:
 
636
                file_id = osutils.safe_file_id(file_id)
681
637
                inv.add_path(f, kind=kind, file_id=file_id)
682
 
            self._inventory_is_modified = True
 
638
        self._write_inventory(inv)
683
639
 
684
640
    @needs_tree_write_lock
685
641
    def _gather_kinds(self, files, kinds):
745
701
        if updated:
746
702
            self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
747
703
 
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))
 
704
    @deprecated_method(zero_eleven)
 
705
    @needs_read_lock
 
706
    def pending_merges(self):
 
707
        """Return a list of pending merges.
 
708
 
 
709
        These are revisions that have been merged into the working
 
710
        directory but not yet committed.
 
711
 
 
712
        As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
 
713
        instead - which is available on all tree objects.
 
714
        """
 
715
        return self.get_parent_ids()[1:]
781
716
 
782
717
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
783
718
        """Common ghost checking functionality from set_parent_*.
793
728
 
794
729
    def _set_merges_from_parent_ids(self, parent_ids):
795
730
        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
 
731
        self._control_files.put_bytes('pending-merges', '\n'.join(merges))
817
732
 
818
733
    @needs_tree_write_lock
819
734
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
820
735
        """Set the parent ids to revision_ids.
821
 
 
 
736
        
822
737
        See also set_parent_trees. This api will try to retrieve the tree data
823
738
        for each element of revision_ids from the trees repository. If you have
824
739
        tree data already available, it is more efficient to use
828
743
        :param revision_ids: The revision_ids to set as the parent ids of this
829
744
            working tree. Any of these may be ghosts.
830
745
        """
 
746
        revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
831
747
        self._check_parents_for_ghosts(revision_ids,
832
748
            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
749
 
838
750
        if len(revision_ids) > 0:
839
751
            self.set_last_revision(revision_ids[0])
840
752
        else:
841
 
            self.set_last_revision(_mod_revision.NULL_REVISION)
 
753
            self.set_last_revision(None)
842
754
 
843
755
        self._set_merges_from_parent_ids(revision_ids)
844
756
 
845
757
    @needs_tree_write_lock
846
758
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
847
759
        """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)
 
760
        parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
851
761
 
852
762
        self._check_parents_for_ghosts(parent_ids,
853
763
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
854
764
 
855
 
        parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
856
 
 
857
765
        if len(parent_ids) == 0:
858
 
            leftmost_parent_id = _mod_revision.NULL_REVISION
 
766
            leftmost_parent_id = None
859
767
            leftmost_parent_tree = None
860
768
        else:
861
769
            leftmost_parent_id, leftmost_parent_tree = parents_list[0]
886
794
                yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
887
795
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
888
796
 
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
 
 
 
797
    @needs_tree_write_lock
899
798
    def _put_rio(self, filename, stanzas, header):
900
 
        self._must_be_locked()
901
799
        my_file = rio_file(stanzas, header)
902
 
        self._transport.put_file(filename, my_file,
903
 
            mode=self.bzrdir._get_file_mode())
 
800
        self._control_files.put(filename, my_file)
904
801
 
905
802
    @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):
 
803
    def merge_from_branch(self, branch, to_revision=None):
908
804
        """Merge from a branch into this working tree.
909
805
 
910
806
        :param branch: The branch to merge from.
914
810
            branch.last_revision().
915
811
        """
916
812
        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:
 
813
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
814
        try:
 
815
            merger = Merger(self.branch, this_tree=self, pb=pb)
 
816
            merger.pp = ProgressPhase("Merge phase", 5, pb)
 
817
            merger.pp.next_phase()
 
818
            # check that there are no
 
819
            # local alterations
 
820
            merger.check_basis(check_clean=True, require_commits=False)
 
821
            if to_revision is None:
 
822
                to_revision = branch.last_revision()
 
823
            else:
 
824
                to_revision = osutils.safe_revision_id(to_revision)
 
825
            merger.other_rev_id = to_revision
 
826
            if merger.other_rev_id is None:
 
827
                raise error.NoCommits(branch)
 
828
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
829
            merger.other_basis = merger.other_rev_id
 
830
            merger.other_tree = self.branch.repository.revision_tree(
 
831
                merger.other_rev_id)
 
832
            merger.other_branch = branch
 
833
            merger.pp.next_phase()
932
834
            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:
 
835
            if merger.base_rev_id == merger.other_rev_id:
 
836
                raise errors.PointlessMerge
 
837
            merger.backup_files = False
939
838
            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()
 
839
            merger.set_interesting_files(None)
 
840
            merger.show_base = False
 
841
            merger.reprocess = False
 
842
            conflicts = merger.do_merge()
 
843
            merger.set_pending()
 
844
        finally:
 
845
            pb.finished()
947
846
        return conflicts
948
847
 
949
 
    @needs_read_lock
950
 
    def merge_modified(self):
951
 
        """Return a dictionary of files modified by a merge.
952
 
 
953
 
        The list is initialized by WorkingTree.set_merge_modified, which is
954
 
        typically called after we make some automatic updates to the tree
955
 
        because of a merge.
956
 
 
957
 
        This returns a map of file_id->sha1, containing only files which are
958
 
        still in the working inventory and have that text hash.
959
 
        """
960
 
        try:
961
 
            hashfile = self._transport.get('merge-hashes')
962
 
        except errors.NoSuchFile:
963
 
            return {}
964
 
        try:
965
 
            merge_hashes = {}
966
 
            try:
967
 
                if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
968
 
                    raise errors.MergeModifiedFormatError()
969
 
            except StopIteration:
970
 
                raise errors.MergeModifiedFormatError()
971
 
            for s in RioReader(hashfile):
972
 
                # RioReader reads in Unicode, so convert file_ids back to utf8
973
 
                file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
974
 
                if file_id not in self.inventory:
975
 
                    continue
976
 
                text_hash = s.get("hash")
977
 
                if text_hash == self.get_file_sha1(file_id):
978
 
                    merge_hashes[file_id] = text_hash
979
 
            return merge_hashes
980
 
        finally:
981
 
            hashfile.close()
982
 
 
983
 
    @needs_write_lock
984
 
    def mkdir(self, path, file_id=None):
985
 
        """See MutableTree.mkdir()."""
986
 
        if file_id is None:
987
 
            file_id = generate_ids.gen_file_id(os.path.basename(path))
988
 
        os.mkdir(self.abspath(path))
989
 
        self.add(path, file_id, 'directory')
990
 
        return file_id
991
 
 
992
 
    def get_symlink_target(self, file_id):
993
 
        abspath = self.id2abspath(file_id)
994
 
        target = osutils.readlink(abspath)
995
 
        return target
996
 
 
997
848
    @needs_write_lock
998
849
    def subsume(self, other_tree):
999
850
        def add_children(inventory, entry):
1002
853
                if child_entry.kind == 'directory':
1003
854
                    add_children(inventory, child_entry)
1004
855
        if other_tree.get_root_id() == self.get_root_id():
1005
 
            raise errors.BadSubsumeSource(self, other_tree,
 
856
            raise errors.BadSubsumeSource(self, other_tree, 
1006
857
                                          'Trees have the same root')
1007
858
        try:
1008
859
            other_tree_path = self.relpath(other_tree.basedir)
1009
860
        except errors.PathNotChild:
1010
 
            raise errors.BadSubsumeSource(self, other_tree,
 
861
            raise errors.BadSubsumeSource(self, other_tree, 
1011
862
                'Tree is not contained by the other')
1012
863
        new_root_parent = self.path2id(osutils.dirname(other_tree_path))
1013
864
        if new_root_parent is None:
1014
 
            raise errors.BadSubsumeSource(self, other_tree,
 
865
            raise errors.BadSubsumeSource(self, other_tree, 
1015
866
                'Parent directory is not versioned.')
1016
867
        # We need to ensure that the result of a fetch will have a
1017
868
        # versionedfile for the other_tree root, and only fetching into
1020
871
            raise errors.SubsumeTargetNeedsUpgrade(other_tree)
1021
872
        other_tree.lock_tree_write()
1022
873
        try:
1023
 
            new_parents = other_tree.get_parent_ids()
 
874
            for parent_id in other_tree.get_parent_ids():
 
875
                self.branch.fetch(other_tree.branch, parent_id)
 
876
                self.add_parent_tree_id(parent_id)
1024
877
            other_root = other_tree.inventory.root
1025
878
            other_root.parent_id = new_root_parent
1026
879
            other_root.name = osutils.basename(other_tree_path)
1027
880
            self.inventory.add(other_root)
1028
881
            add_children(self.inventory, other_root)
1029
882
            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
883
        finally:
1036
884
            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
 
885
        other_tree.bzrdir.destroy_workingtree_metadata()
1064
886
 
1065
887
    @needs_tree_write_lock
1066
888
    def extract(self, file_id, format=None):
1067
889
        """Extract a subtree from this tree.
1068
 
 
 
890
        
1069
891
        A new branch will be created, relative to the path for this tree.
1070
892
        """
1071
 
        self.flush()
1072
893
        def mkdirs(path):
1073
894
            segments = osutils.splitpath(path)
1074
895
            transport = self.branch.bzrdir.root_transport
1075
896
            for name in segments:
1076
897
                transport = transport.clone(name)
1077
 
                transport.ensure_base()
 
898
                try:
 
899
                    transport.mkdir('.')
 
900
                except errors.FileExists:
 
901
                    pass
1078
902
            return transport
1079
 
 
 
903
            
1080
904
        sub_path = self.id2path(file_id)
1081
905
        branch_transport = mkdirs(sub_path)
1082
906
        if format is None:
1083
 
            format = self.bzrdir.cloning_metadir()
1084
 
        branch_transport.ensure_base()
 
907
            format = bzrdir.format_registry.make_bzrdir('experimental-knit2')
 
908
        try:
 
909
            branch_transport.mkdir('.')
 
910
        except errors.FileExists:
 
911
            pass
1085
912
        branch_bzrdir = format.initialize_on_transport(branch_transport)
1086
913
        try:
1087
914
            repo = branch_bzrdir.find_repository()
1088
915
        except errors.NoRepositoryPresent:
1089
916
            repo = branch_bzrdir.create_repository()
1090
 
        if not repo.supports_rich_root():
1091
 
            raise errors.RootNotRich()
 
917
            assert repo.supports_rich_root()
 
918
        else:
 
919
            if not repo.supports_rich_root():
 
920
                raise errors.RootNotRich()
1092
921
        new_branch = branch_bzrdir.create_branch()
1093
922
        new_branch.pull(self.branch)
1094
923
        for parent_id in self.get_parent_ids():
1096
925
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
1097
926
        if tree_transport.base != branch_transport.base:
1098
927
            tree_bzrdir = format.initialize_on_transport(tree_transport)
1099
 
            branch.BranchReferenceFormat().initialize(tree_bzrdir,
1100
 
                target_branch=new_branch)
 
928
            branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1101
929
        else:
1102
930
            tree_bzrdir = branch_bzrdir
1103
 
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
 
931
        wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1104
932
        wt.set_parent_ids(self.get_parent_ids())
1105
933
        my_inv = self.inventory
1106
 
        child_inv = inventory.Inventory(root_id=None)
 
934
        child_inv = Inventory(root_id=None)
1107
935
        new_root = my_inv[file_id]
1108
936
        my_inv.remove_recursive_id(file_id)
1109
937
        new_root.parent_id = None
1113
941
        return wt
1114
942
 
1115
943
    def _serialize(self, inventory, out_file):
1116
 
        xml5.serializer_v5.write_inventory(self._inventory, out_file,
1117
 
            working=True)
 
944
        xml5.serializer_v5.write_inventory(self._inventory, out_file)
1118
945
 
1119
946
    def _deserialize(selt, in_file):
1120
947
        return xml5.serializer_v5.read_inventory(in_file)
1127
954
        sio = StringIO()
1128
955
        self._serialize(self._inventory, sio)
1129
956
        sio.seek(0)
1130
 
        self._transport.put_file('inventory', sio,
1131
 
            mode=self.bzrdir._get_file_mode())
 
957
        self._control_files.put('inventory', sio)
1132
958
        self._inventory_is_modified = False
1133
959
 
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).
 
960
    def list_files(self, include_root=False):
 
961
        """Recursively list all files as (path, class, kind, id, entry).
1139
962
 
1140
963
        Lists, but does not descend into unversioned directories.
 
964
 
1141
965
        This does not include files that have been deleted in this
1142
 
        tree. Skips the control directory.
 
966
        tree.
1143
967
 
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
 
968
        Skips the control directory.
1147
969
        """
1148
970
        # list_files is an iterator, so @needs_read_lock doesn't work properly
1149
971
        # with it. So callers should be careful to always read_lock the tree.
1151
973
            raise errors.ObjectNotLocked(self)
1152
974
 
1153
975
        inv = self.inventory
1154
 
        if from_dir is None and include_root is True:
 
976
        if include_root is True:
1155
977
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1156
978
        # Convert these into local objects to save lookup times
1157
979
        pathjoin = osutils.pathjoin
1158
 
        file_kind = self._kind
 
980
        file_kind = osutils.file_kind
1159
981
 
1160
982
        # transport.base ends in a slash, we want the piece
1161
983
        # between the last two slashes
1164
986
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1165
987
 
1166
988
        # 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)
 
989
        children = os.listdir(self.basedir)
1177
990
        children.sort()
1178
 
        # jam 20060527 The kernel sized tree seems equivalent whether we
 
991
        # jam 20060527 The kernel sized tree seems equivalent whether we 
1179
992
        # use a deque and popleft to keep them sorted, or if we use a plain
1180
993
        # list and just reverse() them.
1181
994
        children = collections.deque(children)
1182
 
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
 
995
        stack = [(inv.root.file_id, u'', self.basedir, children)]
1183
996
        while stack:
1184
997
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1185
998
 
1201
1014
 
1202
1015
                # absolute path
1203
1016
                fap = from_dir_abspath + '/' + f
1204
 
 
 
1017
                
1205
1018
                f_ie = inv.get_child(from_dir_id, f)
1206
1019
                if f_ie:
1207
1020
                    c = 'V'
1230
1043
 
1231
1044
                fk = file_kind(fap)
1232
1045
 
 
1046
                if f_ie:
 
1047
                    if f_ie.kind != fk:
 
1048
                        raise errors.BzrCheckError(
 
1049
                            "file %r entered as kind %r id %r, now of kind %r"
 
1050
                            % (fap, f_ie.kind, f_ie.file_id, fk))
 
1051
 
1233
1052
                # make a last minute entry
1234
1053
                if f_ie:
1235
1054
                    yield fp[1:], c, fk, f_ie.file_id, f_ie
1239
1058
                    except KeyError:
1240
1059
                        yield fp[1:], c, fk, None, TreeEntry()
1241
1060
                    continue
1242
 
 
 
1061
                
1243
1062
                if fk != 'directory':
1244
1063
                    continue
1245
1064
 
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
 
1065
                # But do this child first
 
1066
                new_children = os.listdir(fap)
 
1067
                new_children.sort()
 
1068
                new_children = collections.deque(new_children)
 
1069
                stack.append((f_ie.file_id, fp, fap, new_children))
 
1070
                # Break out of inner loop,
 
1071
                # so that we start outer loop with child
 
1072
                break
1255
1073
            else:
1256
1074
                # if we finished all children, pop it off the stack
1257
1075
                stack.pop()
1263
1081
        to_dir must exist in the inventory.
1264
1082
 
1265
1083
        If to_dir exists and is a directory, the files are moved into
1266
 
        it, keeping their old names.
 
1084
        it, keeping their old names.  
1267
1085
 
1268
1086
        Note that to_dir is only the last component of the new name;
1269
1087
        this doesn't change the directory.
1306
1124
                                       DeprecationWarning)
1307
1125
 
1308
1126
        # check destination directory
1309
 
        if isinstance(from_paths, basestring):
1310
 
            raise ValueError()
 
1127
        assert not isinstance(from_paths, basestring)
1311
1128
        inv = self.inventory
1312
1129
        to_abs = self.abspath(to_dir)
1313
1130
        if not isdir(to_abs):
1397
1214
                only_change_inv = True
1398
1215
            elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1399
1216
                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
1217
            else:
1405
1218
                # something is wrong, so lets determine what exactly
1406
1219
                if not self.has_filename(from_rel) and \
1409
1222
                        errors.PathsDoNotExist(paths=(str(from_rel),
1410
1223
                        str(to_rel))))
1411
1224
                else:
1412
 
                    raise errors.RenameFailedFilesExist(from_rel, to_rel)
 
1225
                    raise errors.RenameFailedFilesExist(from_rel, to_rel,
 
1226
                        extra="(Use --after to update the Bazaar id)")
1413
1227
            rename_entry.only_change_inv = only_change_inv
1414
1228
        return rename_entries
1415
1229
 
1435
1249
        inv = self.inventory
1436
1250
        for entry in moved:
1437
1251
            try:
1438
 
                self._move_entry(WorkingTree._RenameEntry(
1439
 
                    entry.to_rel, entry.from_id,
 
1252
                self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1440
1253
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
1441
1254
                    entry.from_tail, entry.from_parent_id,
1442
1255
                    entry.only_change_inv))
1493
1306
        from_tail = splitpath(from_rel)[-1]
1494
1307
        from_id = inv.path2id(from_rel)
1495
1308
        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]
 
1309
            raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1310
                errors.NotVersionedError(path=str(from_rel)))
 
1311
        from_entry = inv[from_id]
1507
1312
        from_parent_id = from_entry.parent_id
1508
1313
        to_dir, to_tail = os.path.split(to_rel)
1509
1314
        to_dir_id = inv.path2id(to_dir)
1555
1360
        These are files in the working directory that are not versioned or
1556
1361
        control files or ignored.
1557
1362
        """
1558
 
        # force the extras method to be fully executed before returning, to
 
1363
        # force the extras method to be fully executed before returning, to 
1559
1364
        # prevent race conditions with the lock
1560
1365
        return iter(
1561
1366
            [subp for subp in self.extras() if not self.is_ignored(subp)])
1562
 
 
 
1367
    
1563
1368
    @needs_tree_write_lock
1564
1369
    def unversion(self, file_ids):
1565
1370
        """Remove the file ids in file_ids from the current versioned set.
1571
1376
        :raises: NoSuchId if any fileid is not currently versioned.
1572
1377
        """
1573
1378
        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:
 
1379
            file_id = osutils.safe_file_id(file_id)
1577
1380
            if self._inventory.has_id(file_id):
1578
1381
                self._inventory.remove_recursive_id(file_id)
 
1382
            else:
 
1383
                raise errors.NoSuchId(self, file_id)
1579
1384
        if len(file_ids):
1580
 
            # in the future this should just set a dirty bit to wait for the
 
1385
            # in the future this should just set a dirty bit to wait for the 
1581
1386
            # final unlock. However, until all methods of workingtree start
1582
 
            # with the current in -memory inventory rather than triggering
 
1387
            # with the current in -memory inventory rather than triggering 
1583
1388
            # a read, it is more complex - we need to teach read_inventory
1584
1389
            # to know when to read, and when to not read first... and possibly
1585
1390
            # to save first when the in memory one may be corrupted.
1586
1391
            # so for now, we just only write it if it is indeed dirty.
1587
1392
            # - RBC 20060907
1588
1393
            self._write_inventory(self._inventory)
 
1394
    
 
1395
    @deprecated_method(zero_eight)
 
1396
    def iter_conflicts(self):
 
1397
        """List all files in the tree that have text or content conflicts.
 
1398
        DEPRECATED.  Use conflicts instead."""
 
1399
        return self._iter_conflicts()
1589
1400
 
1590
1401
    def _iter_conflicts(self):
1591
1402
        conflicted = set()
1600
1411
 
1601
1412
    @needs_write_lock
1602
1413
    def pull(self, source, overwrite=False, stop_revision=None,
1603
 
             change_reporter=None, possible_transports=None, local=False):
 
1414
             change_reporter=None):
 
1415
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1604
1416
        source.lock_read()
1605
1417
        try:
 
1418
            pp = ProgressPhase("Pull phase", 2, top_pb)
 
1419
            pp.next_phase()
1606
1420
            old_revision_info = self.branch.last_revision_info()
1607
1421
            basis_tree = self.basis_tree()
1608
 
            count = self.branch.pull(source, overwrite, stop_revision,
1609
 
                                     possible_transports=possible_transports,
1610
 
                                     local=local)
 
1422
            count = self.branch.pull(source, overwrite, stop_revision)
1611
1423
            new_revision_info = self.branch.last_revision_info()
1612
1424
            if new_revision_info != old_revision_info:
 
1425
                pp.next_phase()
1613
1426
                repository = self.branch.repository
 
1427
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
1614
1428
                basis_tree.lock_read()
1615
1429
                try:
1616
1430
                    new_basis_tree = self.branch.basis_tree()
1619
1433
                                new_basis_tree,
1620
1434
                                basis_tree,
1621
1435
                                this_tree=self,
1622
 
                                pb=None,
 
1436
                                pb=pb,
1623
1437
                                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)
 
1438
                    if (basis_tree.inventory.root is None and
 
1439
                        new_basis_tree.inventory.root is not None):
 
1440
                        self.set_root_id(new_basis_tree.inventory.root.file_id)
1628
1441
                finally:
 
1442
                    pb.finished()
1629
1443
                    basis_tree.unlock()
1630
1444
                # TODO - dedup parents list with things merged by pull ?
1631
1445
                # reuse the revisiontree we merged against to set the new
1632
1446
                # tree data.
1633
1447
                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
 
1448
                # we have to pull the merge trees out again, because 
 
1449
                # merge_inner has set the ids. - this corner is not yet 
1636
1450
                # layered well enough to prevent double handling.
1637
1451
                # XXX TODO: Fix the double handling: telling the tree about
1638
1452
                # the already known parent data is wasteful.
1644
1458
            return count
1645
1459
        finally:
1646
1460
            source.unlock()
 
1461
            top_pb.finished()
1647
1462
 
1648
1463
    @needs_write_lock
1649
1464
    def put_file_bytes_non_atomic(self, file_id, bytes):
1650
1465
        """See MutableTree.put_file_bytes_non_atomic."""
 
1466
        file_id = osutils.safe_file_id(file_id)
1651
1467
        stream = file(self.id2abspath(file_id), 'wb')
1652
1468
        try:
1653
1469
            stream.write(bytes)
1656
1472
        # TODO: update the hashcache here ?
1657
1473
 
1658
1474
    def extras(self):
1659
 
        """Yield all unversioned files in this WorkingTree.
 
1475
        """Yield all unknown files in this WorkingTree.
1660
1476
 
1661
 
        If there are any unversioned directories then only the directory is
1662
 
        returned, not all its children.  But if there are unversioned files
 
1477
        If there are any unknown directories then only the directory is
 
1478
        returned, not all its children.  But if there are unknown files
1663
1479
        under a versioned subdirectory, they are returned.
1664
1480
 
1665
1481
        Currently returned depth-first, sorted by name within directories.
1666
 
        This is the same order used by 'osutils.walkdirs'.
1667
1482
        """
1668
1483
        ## TODO: Work from given directory downwards
1669
1484
        for path, dir_entry in self.inventory.directories():
1675
1490
 
1676
1491
            fl = []
1677
1492
            for subf in os.listdir(dirabs):
1678
 
                if self.bzrdir.is_control_filename(subf):
 
1493
                if subf == '.bzr':
1679
1494
                    continue
1680
1495
                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)
 
1496
                    subf_norm, can_access = osutils.normalized_filename(subf)
1689
1497
                    if subf_norm != subf and can_access:
1690
1498
                        if subf_norm not in dir_entry.children:
1691
1499
                            fl.append(subf_norm)
1692
1500
                    else:
1693
1501
                        fl.append(subf)
1694
 
 
 
1502
            
1695
1503
            fl.sort()
1696
1504
            for subf in fl:
1697
1505
                subp = pathjoin(path, subf)
1713
1521
        if ignoreset is not None:
1714
1522
            return ignoreset
1715
1523
 
1716
 
        ignore_globs = set()
 
1524
        ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1717
1525
        ignore_globs.update(ignores.get_runtime_ignores())
1718
1526
        ignore_globs.update(ignores.get_user_ignores())
1719
1527
        if self.has_filename(bzrlib.IGNORE_FILENAME):
1734
1542
        r"""Check whether the filename matches an ignore pattern.
1735
1543
 
1736
1544
        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.
 
1545
        others match against only the last component.
1740
1546
 
1741
1547
        If the file is ignored, returns the pattern which caused it to
1742
1548
        be ignored, otherwise None.  So this can simply be used as a
1743
1549
        boolean if desired."""
1744
1550
        if getattr(self, '_ignoreglobster', None) is None:
1745
 
            self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
 
1551
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1746
1552
        return self._ignoreglobster.match(filename)
1747
1553
 
1748
1554
    def kind(self, file_id):
1749
1555
        return file_kind(self.id2abspath(file_id))
1750
1556
 
1751
 
    def stored_kind(self, file_id):
1752
 
        """See Tree.stored_kind"""
1753
 
        return self.inventory[file_id].kind
1754
 
 
1755
1557
    def _comparison_data(self, entry, path):
1756
1558
        abspath = self.abspath(path)
1757
1559
        try:
1767
1569
            mode = stat_value.st_mode
1768
1570
            kind = osutils.file_kind_from_stat_mode(mode)
1769
1571
            if not supports_executable():
1770
 
                executable = entry is not None and entry.executable
 
1572
                executable = entry.executable
1771
1573
            else:
1772
1574
                executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1773
1575
        return kind, executable, stat_value
1788
1590
    @needs_read_lock
1789
1591
    def _last_revision(self):
1790
1592
        """helper for get_parent_ids."""
1791
 
        return _mod_revision.ensure_null(self.branch.last_revision())
 
1593
        return self.branch.last_revision()
1792
1594
 
1793
1595
    def is_locked(self):
1794
1596
        return self._control_files.is_locked()
1795
1597
 
1796
 
    def _must_be_locked(self):
1797
 
        if not self.is_locked():
1798
 
            raise errors.ObjectNotLocked(self)
1799
 
 
1800
1598
    def lock_read(self):
1801
1599
        """See Branch.lock_read, and WorkingTree.unlock."""
1802
 
        if not self.is_locked():
1803
 
            self._reset_data()
1804
1600
        self.branch.lock_read()
1805
1601
        try:
1806
1602
            return self._control_files.lock_read()
1810
1606
 
1811
1607
    def lock_tree_write(self):
1812
1608
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1813
 
        if not self.is_locked():
1814
 
            self._reset_data()
1815
1609
        self.branch.lock_read()
1816
1610
        try:
1817
1611
            return self._control_files.lock_write()
1821
1615
 
1822
1616
    def lock_write(self):
1823
1617
        """See MutableTree.lock_write, and WorkingTree.unlock."""
1824
 
        if not self.is_locked():
1825
 
            self._reset_data()
1826
1618
        self.branch.lock_write()
1827
1619
        try:
1828
1620
            return self._control_files.lock_write()
1836
1628
    def _basis_inventory_name(self):
1837
1629
        return 'basis-inventory-cache'
1838
1630
 
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
1631
    @needs_tree_write_lock
1850
1632
    def set_last_revision(self, new_revision):
1851
1633
        """Change the last revision in the working tree."""
 
1634
        new_revision = osutils.safe_revision_id(new_revision)
1852
1635
        if self._change_last_revision(new_revision):
1853
1636
            self._cache_basis_inventory(new_revision)
1854
1637
 
1855
1638
    def _change_last_revision(self, new_revision):
1856
1639
        """Template method part of set_last_revision to perform the change.
1857
 
 
 
1640
        
1858
1641
        This is used to allow WorkingTree3 instances to not affect branch
1859
1642
        when their last revision is set.
1860
1643
        """
1861
 
        if _mod_revision.is_null(new_revision):
 
1644
        if new_revision is None:
1862
1645
            self.branch.set_revision_history([])
1863
1646
            return False
1864
1647
        try:
1870
1653
 
1871
1654
    def _write_basis_inventory(self, xml):
1872
1655
        """Write the basis inventory XML to the basis-inventory file"""
 
1656
        assert isinstance(xml, str), 'serialised xml must be bytestring.'
1873
1657
        path = self._basis_inventory_name()
1874
1658
        sio = StringIO(xml)
1875
 
        self._transport.put_file(path, sio,
1876
 
            mode=self.bzrdir._get_file_mode())
 
1659
        self._control_files.put(path, sio)
1877
1660
 
1878
1661
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
1879
1662
        """Create the text that will be saved in basis-inventory"""
1880
 
        inventory.revision_id = revision_id
 
1663
        # TODO: jam 20070209 This should be redundant, as the revision_id
 
1664
        #       as all callers should have already converted the revision_id to
 
1665
        #       utf8
 
1666
        inventory.revision_id = osutils.safe_revision_id(revision_id)
1881
1667
        return xml7.serializer_v7.write_inventory_to_string(inventory)
1882
1668
 
1883
1669
    def _cache_basis_inventory(self, new_revision):
1886
1672
        # as commit already has that ready-to-use [while the format is the
1887
1673
        # same, that is].
1888
1674
        try:
1889
 
            # this double handles the inventory - unpack and repack -
 
1675
            # this double handles the inventory - unpack and repack - 
1890
1676
            # but is easier to understand. We can/should put a conditional
1891
1677
            # in here based on whether the inventory is in the latest format
1892
1678
            # - perhaps we should repack all inventories on a repository
1893
1679
            # upgrade ?
1894
1680
            # the fast path is to copy the raw xml from the repository. If the
1895
 
            # xml contains 'revision_id="', then we assume the right
 
1681
            # xml contains 'revision_id="', then we assume the right 
1896
1682
            # revision_id is set. We must check for this full string, because a
1897
1683
            # root node id can legitimately look like 'revision_id' but cannot
1898
1684
            # contain a '"'.
1899
 
            xml = self.branch.repository._get_inventory_xml(new_revision)
 
1685
            xml = self.branch.repository.get_inventory_xml(new_revision)
1900
1686
            firstline = xml.split('\n', 1)[0]
1901
 
            if (not 'revision_id="' in firstline or
 
1687
            if (not 'revision_id="' in firstline or 
1902
1688
                'format="7"' not in firstline):
1903
 
                inv = self.branch.repository._serializer.read_inventory_from_string(
1904
 
                    xml, new_revision)
 
1689
                inv = self.branch.repository.deserialise_inventory(
 
1690
                    new_revision, xml)
1905
1691
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
1906
1692
            self._write_basis_inventory(xml)
1907
1693
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1910
1696
    def read_basis_inventory(self):
1911
1697
        """Read the cached basis inventory."""
1912
1698
        path = self._basis_inventory_name()
1913
 
        return self._transport.get_bytes(path)
1914
 
 
 
1699
        return self._control_files.get(path).read()
 
1700
        
1915
1701
    @needs_read_lock
1916
1702
    def read_working_inventory(self):
1917
1703
        """Read the working inventory.
1918
 
 
 
1704
        
1919
1705
        :raises errors.InventoryModified: read_working_inventory will fail
1920
1706
            when the current in memory inventory has been modified.
1921
1707
        """
1922
 
        # conceptually this should be an implementation detail of the tree.
 
1708
        # conceptually this should be an implementation detail of the tree. 
1923
1709
        # XXX: Deprecate this.
1924
1710
        # ElementTree does its own conversion from UTF-8, so open in
1925
1711
        # binary.
1926
1712
        if self._inventory_is_modified:
1927
1713
            raise errors.InventoryModified(self)
1928
 
        f = self._transport.get('inventory')
1929
 
        try:
1930
 
            result = self._deserialize(f)
1931
 
        finally:
1932
 
            f.close()
 
1714
        result = self._deserialize(self._control_files.get('inventory'))
1933
1715
        self._set_inventory(result, dirty=False)
1934
1716
        return result
1935
1717
 
1936
1718
    @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.
 
1719
    def remove(self, files, verbose=False, to_file=None):
 
1720
        """Remove nominated files from the working inventory..
 
1721
 
 
1722
        This does not remove their text.  This does not run on XXX on what? RBC
 
1723
 
 
1724
        TODO: Refuse to remove modified files unless --force is given?
 
1725
 
 
1726
        TODO: Do something useful with directories.
 
1727
 
 
1728
        TODO: Should this remove the text or not?  Tough call; not
 
1729
        removing may be useful and the user can just use use rm, and
 
1730
        is the opposite of add.  Removing it is consistent with most
 
1731
        other tools.  Maybe an option.
1945
1732
        """
 
1733
        ## TODO: Normalize names
 
1734
        ## TODO: Remove nested loops; better scalability
1946
1735
        if isinstance(files, basestring):
1947
1736
            files = [files]
1948
1737
 
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.
 
1738
        inv = self.inventory
 
1739
 
 
1740
        # do this before any modifications
2018
1741
        for f in files:
2019
 
            fid = self.path2id(f)
2020
 
            message = None
 
1742
            fid = inv.path2id(f)
2021
1743
            if not fid:
2022
 
                message = "%s is not versioned." % (f,)
 
1744
                note("%s is not versioned."%f)
2023
1745
            else:
2024
1746
                if verbose:
2025
 
                    # having removed it, it must be either ignored or unknown
 
1747
                    # having remove it, it must be either ignored or unknown
2026
1748
                    if self.is_ignored(f):
2027
1749
                        new_status = 'I'
2028
1750
                    else:
2029
1751
                        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)
 
1752
                    textui.show_status(new_status, inv[fid].kind, f,
 
1753
                                       to_file=to_file)
 
1754
                del inv[fid]
 
1755
 
 
1756
        self._write_inventory(inv)
2058
1757
 
2059
1758
    @needs_tree_write_lock
2060
 
    def revert(self, filenames=None, old_tree=None, backups=True,
2061
 
               pb=None, report_changes=False):
 
1759
    def revert(self, filenames, old_tree=None, backups=True, 
 
1760
               pb=DummyProgress(), report_changes=False):
2062
1761
        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
1762
        if old_tree is None:
2069
 
            basis_tree = self.basis_tree()
2070
 
            basis_tree.lock_read()
2071
 
            old_tree = basis_tree
 
1763
            old_tree = self.basis_tree()
 
1764
        conflicts = transform.revert(self, old_tree, filenames, backups, pb,
 
1765
                                     report_changes)
 
1766
        if not len(filenames):
 
1767
            self.set_parent_ids(self.get_parent_ids()[:1])
 
1768
            resolve(self)
2072
1769
        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()
 
1770
            resolve(self, filenames, ignore_misses=True)
2092
1771
        return conflicts
2093
1772
 
2094
1773
    def revision_tree(self, revision_id):
2121
1800
    def set_inventory(self, new_inventory_list):
2122
1801
        from bzrlib.inventory import (Inventory,
2123
1802
                                      InventoryDirectory,
 
1803
                                      InventoryEntry,
2124
1804
                                      InventoryFile,
2125
1805
                                      InventoryLink)
2126
1806
        inv = Inventory(self.get_root_id())
2128
1808
            name = os.path.basename(path)
2129
1809
            if name == "":
2130
1810
                continue
2131
 
            # fixme, there should be a factory function inv,add_??
 
1811
            # fixme, there should be a factory function inv,add_?? 
2132
1812
            if kind == 'directory':
2133
1813
                inv.add(InventoryDirectory(file_id, name, parent))
2134
1814
            elif kind == 'file':
2142
1822
    @needs_tree_write_lock
2143
1823
    def set_root_id(self, file_id):
2144
1824
        """Set the root id for this tree."""
2145
 
        # for compatability
 
1825
        # for compatability 
2146
1826
        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)
 
1827
            symbol_versioning.warn(symbol_versioning.zero_twelve
 
1828
                % 'WorkingTree.set_root_id with fileid=None',
 
1829
                DeprecationWarning,
 
1830
                stacklevel=3)
 
1831
            file_id = ROOT_ID
 
1832
        else:
 
1833
            file_id = osutils.safe_file_id(file_id)
2150
1834
        self._set_root_id(file_id)
2151
1835
 
2152
1836
    def _set_root_id(self, file_id):
2153
1837
        """Set the root id for this tree, in a format specific manner.
2154
1838
 
2155
 
        :param file_id: The file id to assign to the root. It must not be
 
1839
        :param file_id: The file id to assign to the root. It must not be 
2156
1840
            present in the current inventory or an error will occur. It must
2157
1841
            not be None, but rather a valid file id.
2158
1842
        """
2177
1861
 
2178
1862
    def unlock(self):
2179
1863
        """See Branch.unlock.
2180
 
 
 
1864
        
2181
1865
        WorkingTree locking just uses the Branch locking facilities.
2182
1866
        This is current because all working trees have an embedded branch
2183
1867
        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
 
1868
        between multiple working trees, i.e. via shared storage, then we 
2185
1869
        would probably want to lock both the local tree, and the branch.
2186
1870
        """
2187
1871
        raise NotImplementedError(self.unlock)
2188
1872
 
2189
 
    _marker = object()
2190
 
 
2191
 
    def update(self, change_reporter=None, possible_transports=None,
2192
 
               revision=None, old_tip=_marker):
 
1873
    def update(self):
2193
1874
        """Update a working tree along its branch.
2194
1875
 
2195
1876
        This will update the branch if its bound too, which means we have
2213
1894
        - Merge current state -> basis tree of the master w.r.t. the old tree
2214
1895
          basis.
2215
1896
        - 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
1897
        """
2223
 
        if self.branch.get_bound_location() is not None:
 
1898
        if self.branch.get_master_branch() is not None:
2224
1899
            self.lock_write()
2225
 
            update_branch = (old_tip is self._marker)
 
1900
            update_branch = True
2226
1901
        else:
2227
1902
            self.lock_tree_write()
2228
1903
            update_branch = False
2229
1904
        try:
2230
1905
            if update_branch:
2231
 
                old_tip = self.branch.update(possible_transports)
 
1906
                old_tip = self.branch.update()
2232
1907
            else:
2233
 
                if old_tip is self._marker:
2234
 
                    old_tip = None
2235
 
            return self._update_tree(old_tip, change_reporter, revision)
 
1908
                old_tip = None
 
1909
            return self._update_tree(old_tip)
2236
1910
        finally:
2237
1911
            self.unlock()
2238
1912
 
2239
1913
    @needs_tree_write_lock
2240
 
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
 
1914
    def _update_tree(self, old_tip=None):
2241
1915
        """Update a tree to the master branch.
2242
1916
 
2243
1917
        :param old_tip: if supplied, the previous tip revision the branch,
2249
1923
        # cant set that until we update the working trees last revision to be
2250
1924
        # one from the new branch, because it will just get absorbed by the
2251
1925
        # parent de-duplication logic.
2252
 
        #
 
1926
        # 
2253
1927
        # We MUST save it even if an error occurs, because otherwise the users
2254
1928
        # local work is unreferenced and will appear to have been lost.
2255
 
        #
2256
 
        nb_conflicts = 0
 
1929
        # 
 
1930
        result = 0
2257
1931
        try:
2258
1932
            last_rev = self.get_parent_ids()[0]
2259
1933
        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
 
 
 
1934
            last_rev = None
 
1935
        if last_rev != self.branch.last_revision():
 
1936
            # merge tree state up to new branch tip.
2285
1937
            basis = self.basis_tree()
2286
1938
            basis.lock_read()
2287
1939
            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)
 
1940
                to_tree = self.branch.basis_tree()
 
1941
                if basis.inventory.root is None:
 
1942
                    self.set_root_id(to_tree.inventory.root.file_id)
2291
1943
                    self.flush()
 
1944
                result += merge.merge_inner(
 
1945
                                      self.branch,
 
1946
                                      to_tree,
 
1947
                                      basis,
 
1948
                                      this_tree=self)
2292
1949
            finally:
2293
1950
                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
1951
            # TODO - dedup parents list with things merged by pull ?
2306
1952
            # reuse the tree we've updated to to set the basis:
2307
 
            parent_trees = [(revision, to_tree)]
 
1953
            parent_trees = [(self.branch.last_revision(), to_tree)]
2308
1954
            merges = self.get_parent_ids()[1:]
2309
1955
            # 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
 
1956
            # tree can decide whether to give us teh entire tree or give us a
2311
1957
            # lazy initialised tree. dirstate for instance will have the trees
2312
1958
            # in ram already, whereas a last-revision + basis-inventory tree
2313
1959
            # will not, but also does not need them when setting parents.
2314
1960
            for parent in merges:
2315
1961
                parent_trees.append(
2316
1962
                    (parent, self.branch.repository.revision_tree(parent)))
2317
 
            if not _mod_revision.is_null(old_tip):
 
1963
            if old_tip is not None:
2318
1964
                parent_trees.append(
2319
1965
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
2320
1966
            self.set_parent_trees(parent_trees)
2321
1967
            last_rev = parent_trees[0][0]
2322
 
        return nb_conflicts
 
1968
        else:
 
1969
            # the working tree had the same last-revision as the master
 
1970
            # branch did. We may still have pivot local work from the local
 
1971
            # branch into old_tip:
 
1972
            if old_tip is not None:
 
1973
                self.add_parent_tree_id(old_tip)
 
1974
        if old_tip and old_tip != last_rev:
 
1975
            # our last revision was not the prior branch last revision
 
1976
            # and we have converted that last revision to a pending merge.
 
1977
            # base is somewhere between the branch tip now
 
1978
            # and the now pending merge
 
1979
 
 
1980
            # Since we just modified the working tree and inventory, flush out
 
1981
            # the current state, before we modify it again.
 
1982
            # TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
 
1983
            #       requires it only because TreeTransform directly munges the
 
1984
            #       inventory and calls tree._write_inventory(). Ultimately we
 
1985
            #       should be able to remove this extra flush.
 
1986
            self.flush()
 
1987
            from bzrlib.revision import common_ancestor
 
1988
            try:
 
1989
                base_rev_id = common_ancestor(self.branch.last_revision(),
 
1990
                                              old_tip,
 
1991
                                              self.branch.repository)
 
1992
            except errors.NoCommonAncestor:
 
1993
                base_rev_id = None
 
1994
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
1995
            other_tree = self.branch.repository.revision_tree(old_tip)
 
1996
            result += merge.merge_inner(
 
1997
                                  self.branch,
 
1998
                                  other_tree,
 
1999
                                  base_tree,
 
2000
                                  this_tree=self)
 
2001
        return result
2323
2002
 
2324
2003
    def _write_hashcache_if_dirty(self):
2325
2004
        """Write out the hashcache if it is dirty."""
2376
2055
    def walkdirs(self, prefix=""):
2377
2056
        """Walk the directories of this tree.
2378
2057
 
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
2058
        This API returns a generator, which is only valid during the current
2385
2059
        tree transaction - within a single lock_read or lock_write duration.
2386
2060
 
2387
 
        If the tree is not locked, it may cause an error to be raised,
2388
 
        depending on the tree implementation.
 
2061
        If the tree is not locked, it may cause an error to be raised, depending
 
2062
        on the tree implementation.
2389
2063
        """
2390
2064
        disk_top = self.abspath(prefix)
2391
2065
        if disk_top.endswith('/'):
2397
2071
            current_disk = disk_iterator.next()
2398
2072
            disk_finished = False
2399
2073
        except OSError, e:
2400
 
            if not (e.errno == errno.ENOENT or
2401
 
                (sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
 
2074
            if e.errno != errno.ENOENT:
2402
2075
                raise
2403
2076
            current_disk = None
2404
2077
            disk_finished = True
2409
2082
            current_inv = None
2410
2083
            inv_finished = True
2411
2084
        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
2085
            if not disk_finished:
2419
2086
                # 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 -
 
2087
                if current_disk[0][1][top_strip_len:] == '':
 
2088
                    # osutils.walkdirs can be made nicer - 
2423
2089
                    # yield the path-from-prefix rather than the pathjoined
2424
2090
                    # 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])):
 
2091
                    bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
 
2092
                    if current_disk[1][bzrdir_loc][0] == '.bzr':
2430
2093
                        # we dont yield the contents of, or, .bzr itself.
2431
 
                        del cur_disk_dir_content[bzrdir_loc]
 
2094
                        del current_disk[1][bzrdir_loc]
2432
2095
            if inv_finished:
2433
2096
                # everything is unknown
2434
2097
                direction = 1
2436
2099
                # everything is missing
2437
2100
                direction = -1
2438
2101
            else:
2439
 
                direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
 
2102
                direction = cmp(current_inv[0][0], current_disk[0][0])
2440
2103
            if direction > 0:
2441
2104
                # disk is before inventory - unknown
2442
2105
                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
 
2106
                    relpath, basename, kind, stat, top_path in current_disk[1]]
 
2107
                yield (current_disk[0][0], None), dirblock
2446
2108
                try:
2447
2109
                    current_disk = disk_iterator.next()
2448
2110
                except StopIteration:
2450
2112
            elif direction < 0:
2451
2113
                # inventory is before disk - missing.
2452
2114
                dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2453
 
                    for relpath, basename, dkind, stat, fileid, kind in
 
2115
                    for relpath, basename, dkind, stat, fileid, kind in 
2454
2116
                    current_inv[1]]
2455
2117
                yield (current_inv[0][0], current_inv[0][1]), dirblock
2456
2118
                try:
2462
2124
                # merge the inventory and disk data together
2463
2125
                dirblock = []
2464
2126
                for relpath, subiterator in itertools.groupby(sorted(
2465
 
                    current_inv[1] + cur_disk_dir_content,
2466
 
                    key=operator.itemgetter(0)), operator.itemgetter(1)):
 
2127
                    current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2467
2128
                    path_elements = list(subiterator)
2468
2129
                    if len(path_elements) == 2:
2469
2130
                        inv_row, disk_row = path_elements
2495
2156
                    disk_finished = True
2496
2157
 
2497
2158
    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
2159
        _directory = 'directory'
2507
2160
        # get the root in the inventory
2508
2161
        inv = self.inventory
2522
2175
                relroot = ""
2523
2176
            # FIXME: stash the node in pending
2524
2177
            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
 
                        ))
 
2178
            for name, child in entry.sorted_children():
 
2179
                dirblock.append((relroot + name, name, child.kind, None,
 
2180
                    child.file_id, child.kind
 
2181
                    ))
2530
2182
            yield (currentdir[0], entry.file_id), dirblock
2531
2183
            # push the user specified dirs from dirblock
2532
2184
            for dir in reversed(dirblock):
2533
2185
                if dir[2] == _directory:
2534
2186
                    pending.append(dir)
2535
2187
 
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
2188
 
2611
2189
class WorkingTree2(WorkingTree):
2612
2190
    """This is the Format 2 working tree.
2613
2191
 
2614
 
    This was the first weave based working tree.
 
2192
    This was the first weave based working tree. 
2615
2193
     - uses os locks for locking.
2616
2194
     - uses the branch last-revision.
2617
2195
    """
2618
2196
 
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
2197
    def lock_tree_write(self):
2635
2198
        """See WorkingTree.lock_tree_write().
2636
2199
 
2645
2208
            raise
2646
2209
 
2647
2210
    def unlock(self):
2648
 
        # do non-implementation specific cleanup
2649
 
        self._cleanup()
2650
 
 
2651
2211
        # we share control files:
2652
2212
        if self._control_files._lock_count == 3:
2653
2213
            # _inventory_is_modified is always False during a read lock.
2654
2214
            if self._inventory_is_modified:
2655
2215
                self.flush()
2656
2216
            self._write_hashcache_if_dirty()
2657
 
 
 
2217
                    
2658
2218
        # reverse order of locking.
2659
2219
        try:
2660
2220
            return self._control_files.unlock()
2676
2236
    def _last_revision(self):
2677
2237
        """See Mutable.last_revision."""
2678
2238
        try:
2679
 
            return self._transport.get_bytes('last-revision')
 
2239
            return osutils.safe_revision_id(
 
2240
                        self._control_files.get('last-revision').read())
2680
2241
        except errors.NoSuchFile:
2681
 
            return _mod_revision.NULL_REVISION
 
2242
            return None
2682
2243
 
2683
2244
    def _change_last_revision(self, revision_id):
2684
2245
        """See WorkingTree._change_last_revision."""
2685
 
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
 
2246
        if revision_id is None or revision_id == NULL_REVISION:
2686
2247
            try:
2687
 
                self._transport.delete('last-revision')
 
2248
                self._control_files._transport.delete('last-revision')
2688
2249
            except errors.NoSuchFile:
2689
2250
                pass
2690
2251
            return False
2691
2252
        else:
2692
 
            self._transport.put_bytes('last-revision', revision_id,
2693
 
                mode=self.bzrdir._get_file_mode())
 
2253
            self._control_files.put_bytes('last-revision', revision_id)
2694
2254
            return True
2695
2255
 
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
2256
    @needs_tree_write_lock
2701
2257
    def set_conflicts(self, conflicts):
2702
 
        self._put_rio('conflicts', conflicts.to_stanzas(),
 
2258
        self._put_rio('conflicts', conflicts.to_stanzas(), 
2703
2259
                      CONFLICT_HEADER_1)
2704
2260
 
2705
2261
    @needs_tree_write_lock
2712
2268
    @needs_read_lock
2713
2269
    def conflicts(self):
2714
2270
        try:
2715
 
            confile = self._transport.get('conflicts')
 
2271
            confile = self._control_files.get('conflicts')
2716
2272
        except errors.NoSuchFile:
2717
2273
            return _mod_conflicts.ConflictList()
2718
2274
        try:
2719
 
            try:
2720
 
                if confile.next() != CONFLICT_HEADER_1 + '\n':
2721
 
                    raise errors.ConflictFormatError()
2722
 
            except StopIteration:
 
2275
            if confile.next() != CONFLICT_HEADER_1 + '\n':
2723
2276
                raise errors.ConflictFormatError()
2724
 
            return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2725
 
        finally:
2726
 
            confile.close()
 
2277
        except StopIteration:
 
2278
            raise errors.ConflictFormatError()
 
2279
        return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2727
2280
 
2728
2281
    def unlock(self):
2729
 
        # do non-implementation specific cleanup
2730
 
        self._cleanup()
2731
2282
        if self._control_files._lock_count == 1:
2732
2283
            # _inventory_is_modified is always False during a read lock.
2733
2284
            if self._inventory_is_modified:
2740
2291
            self.branch.unlock()
2741
2292
 
2742
2293
 
 
2294
class WorkingTreeAB1(WorkingTree3):
 
2295
 
 
2296
    def _serialize(self, inventory, out_file):
 
2297
        xml7.serializer_v7.write_inventory(self._inventory, out_file)
 
2298
 
 
2299
    def _deserialize(selt, in_file):
 
2300
        return xml7.serializer_v7.read_inventory(in_file)
 
2301
 
 
2302
    def _comparison_data(self, entry, path):
 
2303
        kind, executable, stat_value = \
 
2304
            WorkingTree3._comparison_data(self, entry, path)
 
2305
        if kind == 'directory' and entry.kind == 'tree-reference':
 
2306
            kind = 'tree-reference'
 
2307
        return kind, executable, stat_value
 
2308
 
 
2309
    def kind(self, file_id):
 
2310
        kind = WorkingTree3.kind(self, file_id)
 
2311
        if kind == 'directory':
 
2312
            entry = self.inventory[file_id]
 
2313
            if entry.kind == 'tree-reference':
 
2314
                kind = 'tree-reference'
 
2315
        return kind
 
2316
 
 
2317
    def add_reference(self, sub_tree):
 
2318
        return self._add_reference(sub_tree)
 
2319
 
 
2320
    def get_nested_tree(self, entry, path=None):
 
2321
        if path is None:
 
2322
            path = self.id2path(entry.file_id)
 
2323
        return WorkingTree.open(self.abspath(path))
 
2324
 
 
2325
    def get_reference_revision(self, entry, path=None):
 
2326
        return self.get_nested_tree(entry, path).last_revision()
 
2327
 
 
2328
 
2743
2329
def get_conflicted_stem(path):
2744
2330
    for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2745
2331
        if path.endswith(suffix):
2746
2332
            return path[:-len(suffix)]
2747
2333
 
2748
2334
 
 
2335
@deprecated_function(zero_eight)
 
2336
def is_control_file(filename):
 
2337
    """See WorkingTree.is_control_filename(filename)."""
 
2338
    ## FIXME: better check
 
2339
    filename = normpath(filename)
 
2340
    while filename != '':
 
2341
        head, tail = os.path.split(filename)
 
2342
        ## mutter('check %r for control file' % ((head, tail),))
 
2343
        if tail == '.bzr':
 
2344
            return True
 
2345
        if filename == head:
 
2346
            break
 
2347
        filename = head
 
2348
    return False
 
2349
 
 
2350
 
2749
2351
class WorkingTreeFormat(object):
2750
2352
    """An encapsulation of the initialization and open routines for a format.
2751
2353
 
2754
2356
     * a format string,
2755
2357
     * an open routine.
2756
2358
 
2757
 
    Formats are placed in an dict by their format string for reference
 
2359
    Formats are placed in an dict by their format string for reference 
2758
2360
    during workingtree opening. Its not required that these be instances, they
2759
 
    can be classes themselves with class methods - it simply depends on
 
2361
    can be classes themselves with class methods - it simply depends on 
2760
2362
    whether state is needed for a given format or not.
2761
2363
 
2762
2364
    Once a format is deprecated, just deprecate the initialize and open
2763
 
    methods on the format class. Do not deprecate the object, as the
 
2365
    methods on the format class. Do not deprecate the object, as the 
2764
2366
    object will be created every time regardless.
2765
2367
    """
2766
2368
 
2772
2374
 
2773
2375
    requires_rich_root = False
2774
2376
 
2775
 
    upgrade_recommended = False
2776
 
 
2777
2377
    @classmethod
2778
2378
    def find_format(klass, a_bzrdir):
2779
2379
        """Return the format for the working tree object in a_bzrdir."""
2780
2380
        try:
2781
2381
            transport = a_bzrdir.get_workingtree_transport(None)
2782
 
            format_string = transport.get_bytes("format")
 
2382
            format_string = transport.get("format").read()
2783
2383
            return klass._formats[format_string]
2784
2384
        except errors.NoSuchFile:
2785
2385
            raise errors.NoWorkingTree(base=transport.base)
2786
2386
        except KeyError:
2787
 
            raise errors.UnknownFormatError(format=format_string,
2788
 
                                            kind="working tree")
 
2387
            raise errors.UnknownFormatError(format=format_string)
2789
2388
 
2790
2389
    def __eq__(self, other):
2791
2390
        return self.__class__ is other.__class__
2810
2409
        """Is this format supported?
2811
2410
 
2812
2411
        Supported formats can be initialized and opened.
2813
 
        Unsupported formats may not support initialization or committing or
 
2412
        Unsupported formats may not support initialization or committing or 
2814
2413
        some other features depending on the reason for not being supported.
2815
2414
        """
2816
2415
        return True
2817
2416
 
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
2417
    @classmethod
2827
2418
    def register_format(klass, format):
2828
2419
        klass._formats[format.get_format_string()] = format
2833
2424
 
2834
2425
    @classmethod
2835
2426
    def unregister_format(klass, format):
 
2427
        assert klass._formats[format.get_format_string()] is format
2836
2428
        del klass._formats[format.get_format_string()]
2837
2429
 
2838
2430
 
 
2431
 
2839
2432
class WorkingTreeFormat2(WorkingTreeFormat):
2840
 
    """The second working tree format.
 
2433
    """The second working tree format. 
2841
2434
 
2842
2435
    This format modified the hash cache from the format 1 hash cache.
2843
2436
    """
2844
2437
 
2845
 
    upgrade_recommended = True
2846
 
 
2847
2438
    def get_format_description(self):
2848
2439
        """See WorkingTreeFormat.get_format_description()."""
2849
2440
        return "Working tree format 2"
2850
2441
 
2851
 
    def _stub_initialize_on_transport(self, transport, file_mode):
2852
 
        """Workaround: create control files for a remote working tree.
2853
 
 
 
2442
    def stub_initialize_remote(self, control_files):
 
2443
        """As a special workaround create critical control files for a remote working tree
 
2444
        
2854
2445
        This ensures that it can later be updated and dealt with locally,
2855
 
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
 
2446
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with 
2856
2447
        no working tree.  (See bug #43064).
2857
2448
        """
2858
2449
        sio = StringIO()
2859
 
        inv = inventory.Inventory()
2860
 
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
 
2450
        inv = Inventory()
 
2451
        xml5.serializer_v5.write_inventory(inv, sio)
2861
2452
        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):
 
2453
        control_files.put('inventory', sio)
 
2454
 
 
2455
        control_files.put_bytes('pending-merges', '')
 
2456
        
 
2457
 
 
2458
    def initialize(self, a_bzrdir, revision_id=None):
2867
2459
        """See WorkingTreeFormat.initialize()."""
2868
2460
        if not isinstance(a_bzrdir.transport, LocalTransport):
2869
2461
            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()
 
2462
        branch = a_bzrdir.open_branch()
 
2463
        if revision_id is not None:
 
2464
            revision_id = osutils.safe_revision_id(revision_id)
 
2465
            branch.lock_write()
 
2466
            try:
 
2467
                revision_history = branch.revision_history()
 
2468
                try:
 
2469
                    position = revision_history.index(revision_id)
 
2470
                except ValueError:
 
2471
                    raise errors.NoSuchRevision(branch, revision_id)
 
2472
                branch.set_revision_history(revision_history[:position + 1])
 
2473
            finally:
 
2474
                branch.unlock()
 
2475
        revision = branch.last_revision()
 
2476
        inv = Inventory()
2882
2477
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2883
2478
                         branch,
2884
2479
                         inv,
2885
2480
                         _internal=True,
2886
2481
                         _format=self,
2887
2482
                         _bzrdir=a_bzrdir)
2888
 
        basis_tree = branch.repository.revision_tree(revision_id)
 
2483
        basis_tree = branch.repository.revision_tree(revision)
2889
2484
        if basis_tree.inventory.root is not None:
2890
 
            wt.set_root_id(basis_tree.get_root_id())
 
2485
            wt.set_root_id(basis_tree.inventory.root.file_id)
2891
2486
        # 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)
 
2487
        wt.set_parent_trees([(revision, basis_tree)])
2897
2488
        transform.build_tree(basis_tree, wt)
2898
2489
        return wt
2899
2490
 
2912
2503
            raise NotImplementedError
2913
2504
        if not isinstance(a_bzrdir.transport, LocalTransport):
2914
2505
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2915
 
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
 
2506
        return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2916
2507
                           _internal=True,
2917
2508
                           _format=self,
2918
2509
                           _bzrdir=a_bzrdir)
2919
 
        return wt
 
2510
 
2920
2511
 
2921
2512
class WorkingTreeFormat3(WorkingTreeFormat):
2922
2513
    """The second working tree format updated to record a format marker.
2930
2521
        - uses a LockDir to guard access for writes.
2931
2522
    """
2932
2523
 
2933
 
    upgrade_recommended = True
2934
 
 
2935
2524
    def get_format_string(self):
2936
2525
        """See WorkingTreeFormat.get_format_string()."""
2937
2526
        return "Bazaar-NG Working Tree format 3"
2952
2541
 
2953
2542
    def _open_control_files(self, a_bzrdir):
2954
2543
        transport = a_bzrdir.get_workingtree_transport(None)
2955
 
        return LockableFiles(transport, self._lock_file_name,
 
2544
        return LockableFiles(transport, self._lock_file_name, 
2956
2545
                             self._lock_class)
2957
2546
 
2958
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2959
 
                   accelerator_tree=None, hardlink=False):
 
2547
    def initialize(self, a_bzrdir, revision_id=None):
2960
2548
        """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.
 
2549
        
 
2550
        revision_id allows creating a working tree at a different
 
2551
        revision than the branch is at.
2970
2552
        """
2971
2553
        if not isinstance(a_bzrdir.transport, LocalTransport):
2972
2554
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2974
2556
        control_files = self._open_control_files(a_bzrdir)
2975
2557
        control_files.create_lock()
2976
2558
        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
 
2559
        control_files.put_utf8('format', self.get_format_string())
 
2560
        branch = a_bzrdir.open_branch()
 
2561
        if revision_id is None:
 
2562
            revision_id = branch.last_revision()
2981
2563
        else:
2982
 
            branch = a_bzrdir.open_branch()
2983
 
        if revision_id is None:
2984
 
            revision_id = _mod_revision.ensure_null(branch.last_revision())
 
2564
            revision_id = osutils.safe_revision_id(revision_id)
2985
2565
        # WorkingTree3 can handle an inventory which has a unique root id.
2986
2566
        # as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2987
2567
        # those trees. And because there isn't a format bump inbetween, we
3000
2580
            basis_tree = branch.repository.revision_tree(revision_id)
3001
2581
            # only set an explicit root id if there is one to set.
3002
2582
            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:
 
2583
                wt.set_root_id(basis_tree.inventory.root.file_id)
 
2584
            if revision_id == NULL_REVISION:
3005
2585
                wt.set_parent_trees([])
3006
2586
            else:
3007
2587
                wt.set_parent_trees([(revision_id, basis_tree)])
3014
2594
        return wt
3015
2595
 
3016
2596
    def _initial_inventory(self):
3017
 
        return inventory.Inventory()
 
2597
        return Inventory()
3018
2598
 
3019
2599
    def __init__(self):
3020
2600
        super(WorkingTreeFormat3, self).__init__()
3030
2610
            raise NotImplementedError
3031
2611
        if not isinstance(a_bzrdir.transport, LocalTransport):
3032
2612
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
3033
 
        wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3034
 
        return wt
 
2613
        return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3035
2614
 
3036
2615
    def _open(self, a_bzrdir, control_files):
3037
2616
        """Open the tree itself.
3038
 
 
 
2617
        
3039
2618
        :param a_bzrdir: the dir for the tree.
3040
2619
        :param control_files: the control files for the tree.
3041
2620
        """
3049
2628
        return self.get_format_string()
3050
2629
 
3051
2630
 
3052
 
__default_format = WorkingTreeFormat6()
 
2631
class WorkingTreeFormatAB1(WorkingTreeFormat3):
 
2632
    """Working tree format that supports unique roots and nested trees"""
 
2633
 
 
2634
    _tree_class = WorkingTreeAB1
 
2635
 
 
2636
    requires_rich_root = True
 
2637
 
 
2638
    supports_tree_reference = True
 
2639
 
 
2640
    def __init__(self):
 
2641
        WorkingTreeFormat3.__init__(self)
 
2642
        
 
2643
    def __get_matchingbzrdir(self):
 
2644
        return bzrdir.format_registry.make_bzrdir('experimental-knit3')
 
2645
 
 
2646
    _matchingbzrdir = property(__get_matchingbzrdir)
 
2647
 
 
2648
    def get_format_string(self):
 
2649
        """See WorkingTreeFormat.get_format_string()."""
 
2650
        return "Bazaar-NG Working Tree format AB1"
 
2651
 
 
2652
    def get_format_description(self):
 
2653
        """See WorkingTreeFormat.get_format_description()."""
 
2654
        return "Working tree format 4"
 
2655
 
 
2656
    def _initial_inventory(self):
 
2657
        return Inventory(root_id=generate_ids.gen_root_id())
 
2658
 
 
2659
# formats which have no format string are not discoverable
 
2660
# and not independently creatable, so are not registered.
 
2661
__default_format = WorkingTreeFormat3()
3053
2662
WorkingTreeFormat.register_format(__default_format)
3054
 
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3055
2663
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3056
 
WorkingTreeFormat.register_format(WorkingTreeFormat3())
 
2664
WorkingTreeFormat.register_format(WorkingTreeFormatAB1())
3057
2665
WorkingTreeFormat.set_default_format(__default_format)
3058
2666
# formats which have no format string are not discoverable
3059
2667
# and not independently creatable, so are not registered.
3060
2668
_legacy_formats = [WorkingTreeFormat2(),
3061
2669
                   ]
 
2670
 
 
2671
 
 
2672
class WorkingTreeTestProviderAdapter(object):
 
2673
    """A tool to generate a suite testing multiple workingtree formats at once.
 
2674
 
 
2675
    This is done by copying the test once for each transport and injecting
 
2676
    the transport_server, transport_readonly_server, and workingtree_format
 
2677
    classes into each copy. Each copy is also given a new id() to make it
 
2678
    easy to identify.
 
2679
    """
 
2680
 
 
2681
    def __init__(self, transport_server, transport_readonly_server, formats):
 
2682
        self._transport_server = transport_server
 
2683
        self._transport_readonly_server = transport_readonly_server
 
2684
        self._formats = formats
 
2685
    
 
2686
    def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
 
2687
        """Clone test for adaption."""
 
2688
        new_test = deepcopy(test)
 
2689
        new_test.transport_server = self._transport_server
 
2690
        new_test.transport_readonly_server = self._transport_readonly_server
 
2691
        new_test.bzrdir_format = bzrdir_format
 
2692
        new_test.workingtree_format = workingtree_format
 
2693
        def make_new_test_id():
 
2694
            new_id = "%s(%s)" % (test.id(), variation)
 
2695
            return lambda: new_id
 
2696
        new_test.id = make_new_test_id()
 
2697
        return new_test
 
2698
    
 
2699
    def adapt(self, test):
 
2700
        from bzrlib.tests import TestSuite
 
2701
        result = TestSuite()
 
2702
        for workingtree_format, bzrdir_format in self._formats:
 
2703
            new_test = self._clone_test(
 
2704
                test,
 
2705
                bzrdir_format,
 
2706
                workingtree_format, workingtree_format.__class__.__name__)
 
2707
            result.addTest(new_test)
 
2708
        return result