/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: Alexander Belchenko
  • Date: 2007-03-11 19:39:37 UTC
  • mto: This revision was merged to the branch mainline in revision 2335.
  • Revision ID: bialix@ukr.net-20070311193937-nx38jief5kw8pp2f
external diff: no need for special code path for win32 (suggested by John Meinel)

Show diffs side-by-side

added added

removed removed

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