/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: v.ladeuil+lp at free
  • Date: 2006-11-08 07:44:30 UTC
  • mfrom: (2123 +trunk)
  • mto: (2145.1.1 keepalive)
  • mto: This revision was merged to the branch mainline in revision 2146.
  • Revision ID: v.ladeuil+lp@free.fr-20061108074430-a9c08d4a475bd97f
Merge bzr.dev

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