/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: John Arbash Meinel
  • Date: 2007-02-26 21:17:03 UTC
  • mto: (2255.11.3 dirstate)
  • mto: This revision was merged to the branch mainline in revision 2322.
  • Revision ID: john@arbash-meinel.com-20070226211703-hqcam97hrxohk5jc
Make set_root_id() a no-op if the id doesn't change,
and change the test_merge_core tests to flush the state to disk, since
they are hanging onto a write lock.

Show diffs side-by-side

added added

removed removed

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