/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-01-30 23:05:35 UTC
  • mto: This revision was merged to the branch mainline in revision 2259.
  • Revision ID: bialix@ukr.net-20070130230535-kx1rd478rtigyc3v
standalone installer: win98 support

Show diffs side-by-side

added added

removed removed

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