~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

[merge] bzr.dev 2298 (broken)

Show diffs side-by-side

added added

removed removed

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