/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: Canonical.com Patch Queue Manager
  • Date: 2006-10-16 10:03:21 UTC
  • mfrom: (1988.4.6 dotted-revno-input.)
  • Revision ID: pqm@pqm.ubuntu.com-20061016100321-c4951c9fc020dbd0
(Robert Collins) Output dotted decimal revision numbers during log, and accept them as revision specifiers.

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