~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: John Arbash Meinel
  • Date: 2007-03-02 16:51:24 UTC
  • mto: This revision was merged to the branch mainline in revision 2321.
  • Revision ID: john@arbash-meinel.com-20070302165124-pzxf42224e9j7ju2
Update the 'escaped store' tests to use both unicode and utf8 file ids.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""WorkingTree object and friends.
18
18
 
19
19
A WorkingTree represents the editable working copy of a branch.
20
 
Operations which represent the WorkingTree are also done here,
21
 
such as renaming or adding files.  The WorkingTree has an inventory
22
 
which is updated by these operations.  A commit produces a
 
20
Operations which represent the WorkingTree are also done here, 
 
21
such as renaming or adding files.  The WorkingTree has an inventory 
 
22
which is updated by these operations.  A commit produces a 
23
23
new revision based on the workingtree and its inventory.
24
24
 
25
25
At the moment every WorkingTree has its own branch.  Remote
29
29
WorkingTree.open(dir).
30
30
"""
31
31
 
 
32
# TODO: Give the workingtree sole responsibility for the working inventory;
 
33
# remove the variable and references to it from the branch.  This may require
 
34
# updating the commit code so as to update the inventory within the working
 
35
# copy, and making sure there's only one WorkingTree for any directory on disk.
 
36
# At the moment they may alias the inventory and have old copies of it in
 
37
# memory.  (Now done? -- mbp 20060309)
32
38
 
33
39
from cStringIO import StringIO
34
40
import os
35
 
import sys
36
41
 
37
42
from bzrlib.lazy_import import lazy_import
38
43
lazy_import(globals(), """
39
 
from bisect import bisect_left
40
44
import collections
 
45
from copy import deepcopy
41
46
import errno
42
 
import itertools
43
 
import operator
44
47
import stat
45
 
import re
 
48
from time import time
 
49
import warnings
46
50
 
47
51
import bzrlib
48
52
from bzrlib import (
49
 
    branch,
50
53
    bzrdir,
51
54
    conflicts as _mod_conflicts,
52
55
    errors,
53
56
    generate_ids,
54
57
    globbing,
55
 
    graph as _mod_graph,
56
58
    hashcache,
57
59
    ignores,
58
 
    inventory,
59
60
    merge,
60
 
    revision as _mod_revision,
61
 
    revisiontree,
62
 
    trace,
 
61
    osutils,
 
62
    textui,
63
63
    transform,
64
 
    ui,
65
 
    views,
 
64
    urlutils,
66
65
    xml5,
67
 
    xml7,
 
66
    xml6,
68
67
    )
69
68
import bzrlib.branch
70
69
from bzrlib.transport import get_transport
71
 
from bzrlib.workingtree_4 import (
72
 
    WorkingTreeFormat4,
73
 
    WorkingTreeFormat5,
74
 
    WorkingTreeFormat6,
75
 
    )
 
70
import bzrlib.ui
76
71
""")
77
72
 
78
73
from bzrlib import symbol_versioning
79
74
from bzrlib.decorators import needs_read_lock, needs_write_lock
80
 
from bzrlib.lockable_files import LockableFiles
 
75
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID
 
76
from bzrlib.lockable_files import LockableFiles, TransportLock
81
77
from bzrlib.lockdir import LockDir
82
78
import bzrlib.mutabletree
83
79
from bzrlib.mutabletree import needs_tree_write_lock
84
 
from bzrlib import osutils
85
80
from bzrlib.osutils import (
 
81
    compact_date,
86
82
    file_kind,
87
83
    isdir,
88
84
    normpath,
89
85
    pathjoin,
 
86
    rand_chars,
90
87
    realpath,
91
88
    safe_unicode,
92
89
    splitpath,
93
90
    supports_executable,
94
91
    )
95
 
from bzrlib.filters import filtered_input_file
96
92
from bzrlib.trace import mutter, note
97
93
from bzrlib.transport.local import LocalTransport
98
 
from bzrlib.revision import CURRENT_REVISION
 
94
import bzrlib.tree
 
95
from bzrlib.progress import DummyProgress, ProgressPhase
 
96
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
 
97
import bzrlib.revisiontree
99
98
from bzrlib.rio import RioReader, rio_file, Stanza
100
 
from bzrlib.symbol_versioning import (
101
 
    deprecated_passed,
102
 
    DEPRECATED_PARAMETER,
103
 
    )
 
99
from bzrlib.symbol_versioning import (deprecated_passed,
 
100
        deprecated_method,
 
101
        deprecated_function,
 
102
        DEPRECATED_PARAMETER,
 
103
        zero_eight,
 
104
        zero_eleven,
 
105
        zero_thirteen,
 
106
        )
104
107
 
105
108
 
106
109
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
110
CONFLICT_HEADER_1 = "BZR conflict list format 1"
111
111
 
112
 
ERROR_PATH_NOT_FOUND = 3    # WindowsError errno code, equivalent to ENOENT
 
112
 
 
113
@deprecated_function(zero_thirteen)
 
114
def gen_file_id(name):
 
115
    """Return new file id for the basename 'name'.
 
116
 
 
117
    Use bzrlib.generate_ids.gen_file_id() instead
 
118
    """
 
119
    return generate_ids.gen_file_id(name)
 
120
 
 
121
 
 
122
@deprecated_function(zero_thirteen)
 
123
def gen_root_id():
 
124
    """Return a new tree-root file id.
 
125
 
 
126
    This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
 
127
    """
 
128
    return generate_ids.gen_root_id()
113
129
 
114
130
 
115
131
class TreeEntry(object):
116
132
    """An entry that implements the minimum interface used by commands.
117
133
 
118
 
    This needs further inspection, it may be better to have
 
134
    This needs further inspection, it may be better to have 
119
135
    InventoryEntries without ids - though that seems wrong. For now,
120
136
    this is a parallel hierarchy to InventoryEntry, and needs to become
121
137
    one of several things: decorates to that hierarchy, children of, or
124
140
    no InventoryEntry available - i.e. for unversioned objects.
125
141
    Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
126
142
    """
127
 
 
 
143
 
128
144
    def __eq__(self, other):
129
145
        # yes, this us ugly, TODO: best practice __eq__ style.
130
146
        return (isinstance(other, TreeEntry)
131
147
                and other.__class__ == self.__class__)
132
 
 
 
148
 
133
149
    def kind_character(self):
134
150
        return "???"
135
151
 
167
183
        return ''
168
184
 
169
185
 
170
 
class WorkingTree(bzrlib.mutabletree.MutableTree,
171
 
    bzrdir.ControlComponent):
 
186
class WorkingTree(bzrlib.mutabletree.MutableTree):
172
187
    """Working copy tree.
173
188
 
174
189
    The inventory is held in the `Branch` working-inventory, and the
178
193
    not listed in the Inventory and vice versa.
179
194
    """
180
195
 
181
 
    # override this to set the strategy for storing views
182
 
    def _make_views(self):
183
 
        return views.DisabledViews(self)
184
 
 
185
196
    def __init__(self, basedir='.',
186
197
                 branch=DEPRECATED_PARAMETER,
187
198
                 _inventory=None,
189
200
                 _internal=False,
190
201
                 _format=None,
191
202
                 _bzrdir=None):
192
 
        """Construct a WorkingTree instance. This is not a public API.
 
203
        """Construct a WorkingTree for basedir.
193
204
 
194
 
        :param branch: A branch to override probing for the branch.
 
205
        If the branch is not supplied, it is opened automatically.
 
206
        If the branch is supplied, it must be the branch for this basedir.
 
207
        (branch.base is not cross checked, because for remote branches that
 
208
        would be meaningless).
195
209
        """
196
210
        self._format = _format
197
211
        self.bzrdir = _bzrdir
198
212
        if not _internal:
199
 
            raise errors.BzrError("Please use bzrdir.open_workingtree or "
200
 
                "WorkingTree.open() to obtain a WorkingTree.")
 
213
            # not created via open etc.
 
214
            warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
 
215
                 "Please use bzrdir.open_workingtree or WorkingTree.open().",
 
216
                 DeprecationWarning,
 
217
                 stacklevel=2)
 
218
            wt = WorkingTree.open(basedir)
 
219
            self._branch = wt.branch
 
220
            self.basedir = wt.basedir
 
221
            self._control_files = wt._control_files
 
222
            self._hashcache = wt._hashcache
 
223
            self._set_inventory(wt._inventory, dirty=False)
 
224
            self._format = wt._format
 
225
            self.bzrdir = wt.bzrdir
 
226
        assert isinstance(basedir, basestring), \
 
227
            "base directory %r is not a string" % basedir
201
228
        basedir = safe_unicode(basedir)
202
229
        mutter("opening working tree %r", basedir)
203
230
        if deprecated_passed(branch):
 
231
            if not _internal:
 
232
                warnings.warn("WorkingTree(..., branch=XXX) is deprecated"
 
233
                     " as of bzr 0.8. Please use bzrdir.open_workingtree() or"
 
234
                     " WorkingTree.open().",
 
235
                     DeprecationWarning,
 
236
                     stacklevel=2
 
237
                     )
204
238
            self._branch = branch
205
239
        else:
206
240
            self._branch = self.bzrdir.open_branch()
211
245
            self._control_files = self.branch.control_files
212
246
        else:
213
247
            # assume all other formats have their own control files.
 
248
            assert isinstance(_control_files, LockableFiles), \
 
249
                    "_control_files must be a LockableFiles, not %r" \
 
250
                    % _control_files
214
251
            self._control_files = _control_files
215
 
        self._transport = self._control_files._transport
216
252
        # update the whole cache up front and write to disk if anything changed;
217
253
        # in the future we might want to do this more selectively
218
254
        # two possible ways offer themselves : in self._unlock, write the cache
222
258
        wt_trans = self.bzrdir.get_workingtree_transport(None)
223
259
        cache_filename = wt_trans.local_abspath('stat-cache')
224
260
        self._hashcache = hashcache.HashCache(basedir, cache_filename,
225
 
            self.bzrdir._get_file_mode(),
226
 
            self._content_filter_stack_provider())
 
261
                                              self._control_files._file_mode)
227
262
        hc = self._hashcache
228
263
        hc.read()
229
264
        # is this scan needed ? it makes things kinda slow.
234
269
            hc.write()
235
270
 
236
271
        if _inventory is None:
237
 
            # This will be acquired on lock_read() or lock_write()
238
272
            self._inventory_is_modified = False
239
 
            self._inventory = None
 
273
            self.read_working_inventory()
240
274
        else:
241
275
            # the caller of __init__ has provided an inventory,
242
276
            # we assume they know what they are doing - as its only
243
277
            # the Format factory and creation methods that are
244
278
            # permitted to do this.
245
279
            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
280
 
269
281
    branch = property(
270
282
        fget=lambda self: self._branch,
285
297
        self._control_files.break_lock()
286
298
        self.branch.break_lock()
287
299
 
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
300
    def _set_inventory(self, inv, dirty):
311
301
        """Set the internal cached inventory.
312
302
 
317
307
            False then the inventory is the same as that on disk and any
318
308
            serialisation would be unneeded overhead.
319
309
        """
 
310
        assert inv.root is not None
320
311
        self._inventory = inv
321
312
        self._inventory_is_modified = dirty
322
313
 
326
317
 
327
318
        """
328
319
        if path is None:
329
 
            path = osutils.getcwd()
 
320
            path = os.path.getcwdu()
330
321
        control = bzrdir.BzrDir.open(path, _unsupported)
331
322
        return control.open_workingtree(_unsupported)
332
 
 
 
323
        
333
324
    @staticmethod
334
325
    def open_containing(path=None):
335
326
        """Open an existing working tree which has its root about path.
336
 
 
 
327
        
337
328
        This probes for a working tree at path and searches upwards from there.
338
329
 
339
330
        Basically we keep looking up until we find the control directory or
357
348
        """
358
349
        return WorkingTree.open(path, _unsupported=True)
359
350
 
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
351
    def __iter__(self):
380
352
        """Iterate through file_ids for this tree.
381
353
 
387
359
            if osutils.lexists(self.abspath(path)):
388
360
                yield ie.file_id
389
361
 
390
 
    def all_file_ids(self):
391
 
        """See Tree.iter_all_file_ids"""
392
 
        return set(self.inventory)
393
 
 
394
362
    def __repr__(self):
395
363
        return "<%s of %s>" % (self.__class__.__name__,
396
364
                               getattr(self, 'basedir', None))
397
365
 
398
366
    def abspath(self, filename):
399
367
        return pathjoin(self.basedir, filename)
400
 
 
 
368
    
401
369
    def basis_tree(self):
402
370
        """Return RevisionTree for the current last revision.
403
 
 
 
371
        
404
372
        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).
 
373
        empty tree - one obtained by calling repository.revision_tree(None).
407
374
        """
408
375
        try:
409
376
            revision_id = self.get_parent_ids()[0]
411
378
            # no parents, return an empty revision tree.
412
379
            # in the future this should return the tree for
413
380
            # 'empty:' - the implicit root empty tree.
414
 
            return self.branch.repository.revision_tree(
415
 
                       _mod_revision.NULL_REVISION)
416
 
        try:
417
 
            return self.revision_tree(revision_id)
418
 
        except errors.NoSuchRevision:
419
 
            pass
 
381
            return self.branch.repository.revision_tree(None)
 
382
        else:
 
383
            try:
 
384
                xml = self.read_basis_inventory()
 
385
                inv = xml6.serializer_v6.read_inventory_from_string(xml)
 
386
                if inv is not None and inv.revision_id == revision_id:
 
387
                    return bzrlib.revisiontree.RevisionTree(
 
388
                        self.branch.repository, inv, revision_id)
 
389
            except (errors.NoSuchFile, errors.BadInventoryFormat):
 
390
                pass
420
391
        # No cached copy available, retrieve from the repository.
421
392
        # FIXME? RBC 20060403 should we cache the inventory locally
422
393
        # at this point ?
423
394
        try:
424
395
            return self.branch.repository.revision_tree(revision_id)
425
 
        except (errors.RevisionNotPresent, errors.NoSuchRevision):
 
396
        except errors.RevisionNotPresent:
426
397
            # 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
 
398
            # occured. If the revision is present, its a problem, if its not
428
399
            # its a ghost.
429
400
            if self.branch.repository.has_revision(revision_id):
430
401
                raise
431
402
            # 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()
 
403
            return self.branch.repository.revision_tree(None)
 
404
 
 
405
    @staticmethod
 
406
    @deprecated_method(zero_eight)
 
407
    def create(branch, directory):
 
408
        """Create a workingtree for branch at directory.
 
409
 
 
410
        If existing_directory already exists it must have a .bzr directory.
 
411
        If it does not exist, it will be created.
 
412
 
 
413
        This returns a new WorkingTree object for the new checkout.
 
414
 
 
415
        TODO FIXME RBC 20060124 when we have checkout formats in place this
 
416
        should accept an optional revisionid to checkout [and reject this if
 
417
        checking out into the same dir as a pre-checkout-aware branch format.]
 
418
 
 
419
        XXX: When BzrDir is present, these should be created through that 
 
420
        interface instead.
 
421
        """
 
422
        warnings.warn('delete WorkingTree.create', stacklevel=3)
 
423
        transport = get_transport(directory)
 
424
        if branch.bzrdir.root_transport.base == transport.base:
 
425
            # same dir 
 
426
            return branch.bzrdir.create_workingtree()
 
427
        # different directory, 
 
428
        # create a branch reference
 
429
        # and now a working tree.
 
430
        raise NotImplementedError
 
431
 
 
432
    @staticmethod
 
433
    @deprecated_method(zero_eight)
 
434
    def create_standalone(directory):
 
435
        """Create a checkout and a branch and a repo at directory.
 
436
 
 
437
        Directory must exist and be empty.
 
438
 
 
439
        please use BzrDir.create_standalone_workingtree
 
440
        """
 
441
        return bzrdir.BzrDir.create_standalone_workingtree(directory)
437
442
 
438
443
    def relpath(self, path):
439
444
        """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
 
445
        
 
446
        The path may be absolute or relative. If its a relative path it is 
442
447
        interpreted relative to the python current working directory.
443
448
        """
444
449
        return osutils.relpath(self.basedir, path)
446
451
    def has_filename(self, filename):
447
452
        return osutils.lexists(self.abspath(filename))
448
453
 
449
 
    def get_file(self, file_id, path=None, filtered=True):
450
 
        return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
451
 
 
452
 
    def get_file_with_stat(self, file_id, path=None, filtered=True,
453
 
        _fstat=os.fstat):
454
 
        """See Tree.get_file_with_stat."""
455
 
        if path is None:
456
 
            path = self.id2path(file_id)
457
 
        file_obj = self.get_file_byname(path, filtered=False)
458
 
        stat_value = _fstat(file_obj.fileno())
459
 
        if filtered and self.supports_content_filtering():
460
 
            filters = self._content_filter_stack(path)
461
 
            file_obj = filtered_input_file(file_obj, filters)
462
 
        return (file_obj, stat_value)
463
 
 
464
 
    def get_file_text(self, file_id, path=None, filtered=True):
465
 
        return self.get_file(file_id, path=path, filtered=filtered).read()
466
 
 
467
 
    def get_file_byname(self, filename, filtered=True):
468
 
        path = self.abspath(filename)
469
 
        f = file(path, 'rb')
470
 
        if filtered and self.supports_content_filtering():
471
 
            filters = self._content_filter_stack(filename)
472
 
            return filtered_input_file(f, filters)
473
 
        else:
474
 
            return f
475
 
 
476
 
    def get_file_lines(self, file_id, path=None, filtered=True):
477
 
        """See Tree.get_file_lines()"""
478
 
        file = self.get_file(file_id, path, filtered=filtered)
479
 
        try:
480
 
            return file.readlines()
481
 
        finally:
482
 
            file.close()
483
 
 
484
 
    @needs_read_lock
485
 
    def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
 
454
    def get_file(self, file_id):
 
455
        file_id = osutils.safe_file_id(file_id)
 
456
        return self.get_file_byname(self.id2path(file_id))
 
457
 
 
458
    def get_file_text(self, file_id):
 
459
        file_id = osutils.safe_file_id(file_id)
 
460
        return self.get_file(file_id).read()
 
461
 
 
462
    def get_file_byname(self, filename):
 
463
        return file(self.abspath(filename), 'rb')
 
464
 
 
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
605
 
        inv = self.inventory
 
569
        file_id = osutils.safe_file_id(file_id)
 
570
        inv = self._inventory
606
571
        if not inv.has_id(file_id):
607
572
            return False
608
573
        path = inv.id2path(file_id)
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:
662
 
                path = self.id2path(file_id)
 
608
                file_id = osutils.safe_file_id(file_id)
 
609
                path = self._inventory.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
 
 
899
787
    def _put_rio(self, filename, stanzas, header):
900
788
        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
839
        """Return a dictionary of files modified by a merge.
952
840
 
953
 
        The list is initialized by WorkingTree.set_merge_modified, which is
 
841
        The list is initialized by WorkingTree.set_merge_modified, which is 
954
842
        typically called after we make some automatic updates to the tree
955
843
        because of a merge.
956
844
 
958
846
        still in the working inventory and have that text hash.
959
847
        """
960
848
        try:
961
 
            hashfile = self._transport.get('merge-hashes')
 
849
            hashfile = self._control_files.get('merge-hashes')
962
850
        except errors.NoSuchFile:
963
851
            return {}
 
852
        merge_hashes = {}
964
853
        try:
965
 
            merge_hashes = {}
966
 
            try:
967
 
                if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
968
 
                    raise errors.MergeModifiedFormatError()
969
 
            except StopIteration:
 
854
            if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
970
855
                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()
 
856
        except StopIteration:
 
857
            raise errors.MergeModifiedFormatError()
 
858
        for s in RioReader(hashfile):
 
859
            file_id = s.get("file_id")
 
860
            if file_id not in self.inventory:
 
861
                continue
 
862
            text_hash = s.get("hash")
 
863
            if text_hash == self.get_file_sha1(file_id):
 
864
                merge_hashes[file_id] = text_hash
 
865
        return merge_hashes
982
866
 
983
867
    @needs_write_lock
984
868
    def mkdir(self, path, file_id=None):
990
874
        return file_id
991
875
 
992
876
    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)
 
877
        return os.readlink(self.id2abspath(file_id))
 
878
 
 
879
    def file_class(self, filename):
 
880
        if self.path2id(filename):
 
881
            return 'V'
 
882
        elif self.is_ignored(filename):
 
883
            return 'I'
 
884
        else:
 
885
            return '?'
1121
886
 
1122
887
    def flush(self):
1123
888
        """Write the in memory inventory to disk."""
1125
890
        if self._control_files._lock_mode != 'w':
1126
891
            raise errors.NotWriteLocked(self)
1127
892
        sio = StringIO()
1128
 
        self._serialize(self._inventory, sio)
 
893
        xml5.serializer_v5.write_inventory(self._inventory, sio)
1129
894
        sio.seek(0)
1130
 
        self._transport.put_file('inventory', sio,
1131
 
            mode=self.bzrdir._get_file_mode())
 
895
        self._control_files.put('inventory', sio)
1132
896
        self._inventory_is_modified = False
1133
897
 
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).
 
898
    def list_files(self, include_root=False):
 
899
        """Recursively list all files as (path, class, kind, id, entry).
1139
900
 
1140
901
        Lists, but does not descend into unversioned directories.
 
902
 
1141
903
        This does not include files that have been deleted in this
1142
 
        tree. Skips the control directory.
 
904
        tree.
1143
905
 
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
 
906
        Skips the control directory.
1147
907
        """
1148
 
        # list_files is an iterator, so @needs_read_lock doesn't work properly
1149
 
        # with it. So callers should be careful to always read_lock the tree.
1150
 
        if not self.is_locked():
1151
 
            raise errors.ObjectNotLocked(self)
1152
 
 
1153
 
        inv = self.inventory
1154
 
        if from_dir is None and include_root is True:
 
908
        inv = self._inventory
 
909
        if include_root is True:
1155
910
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1156
911
        # Convert these into local objects to save lookup times
1157
912
        pathjoin = osutils.pathjoin
1158
 
        file_kind = self._kind
 
913
        file_kind = osutils.file_kind
1159
914
 
1160
915
        # transport.base ends in a slash, we want the piece
1161
916
        # between the last two slashes
1164
919
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1165
920
 
1166
921
        # 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)
 
922
        children = os.listdir(self.basedir)
1177
923
        children.sort()
1178
 
        # jam 20060527 The kernel sized tree seems equivalent whether we
 
924
        # jam 20060527 The kernel sized tree seems equivalent whether we 
1179
925
        # use a deque and popleft to keep them sorted, or if we use a plain
1180
926
        # list and just reverse() them.
1181
927
        children = collections.deque(children)
1182
 
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
 
928
        stack = [(inv.root.file_id, u'', self.basedir, children)]
1183
929
        while stack:
1184
930
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1185
931
 
1201
947
 
1202
948
                # absolute path
1203
949
                fap = from_dir_abspath + '/' + f
1204
 
 
 
950
                
1205
951
                f_ie = inv.get_child(from_dir_id, f)
1206
952
                if f_ie:
1207
953
                    c = 'V'
1230
976
 
1231
977
                fk = file_kind(fap)
1232
978
 
 
979
                if f_ie:
 
980
                    if f_ie.kind != fk:
 
981
                        raise errors.BzrCheckError(
 
982
                            "file %r entered as kind %r id %r, now of kind %r"
 
983
                            % (fap, f_ie.kind, f_ie.file_id, fk))
 
984
 
1233
985
                # make a last minute entry
1234
986
                if f_ie:
1235
987
                    yield fp[1:], c, fk, f_ie.file_id, f_ie
1239
991
                    except KeyError:
1240
992
                        yield fp[1:], c, fk, None, TreeEntry()
1241
993
                    continue
1242
 
 
 
994
                
1243
995
                if fk != 'directory':
1244
996
                    continue
1245
997
 
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
 
998
                # But do this child first
 
999
                new_children = os.listdir(fap)
 
1000
                new_children.sort()
 
1001
                new_children = collections.deque(new_children)
 
1002
                stack.append((f_ie.file_id, fp, fap, new_children))
 
1003
                # Break out of inner loop,
 
1004
                # so that we start outer loop with child
 
1005
                break
1255
1006
            else:
1256
1007
                # if we finished all children, pop it off the stack
1257
1008
                stack.pop()
1263
1014
        to_dir must exist in the inventory.
1264
1015
 
1265
1016
        If to_dir exists and is a directory, the files are moved into
1266
 
        it, keeping their old names.
 
1017
        it, keeping their old names.  
1267
1018
 
1268
1019
        Note that to_dir is only the last component of the new name;
1269
1020
        this doesn't change the directory.
1306
1057
                                       DeprecationWarning)
1307
1058
 
1308
1059
        # check destination directory
1309
 
        if isinstance(from_paths, basestring):
1310
 
            raise ValueError()
 
1060
        assert not isinstance(from_paths, basestring)
1311
1061
        inv = self.inventory
1312
1062
        to_abs = self.abspath(to_dir)
1313
1063
        if not isdir(to_abs):
1397
1147
                only_change_inv = True
1398
1148
            elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1399
1149
                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
1150
            else:
1405
1151
                # something is wrong, so lets determine what exactly
1406
1152
                if not self.has_filename(from_rel) and \
1409
1155
                        errors.PathsDoNotExist(paths=(str(from_rel),
1410
1156
                        str(to_rel))))
1411
1157
                else:
1412
 
                    raise errors.RenameFailedFilesExist(from_rel, to_rel)
 
1158
                    raise errors.RenameFailedFilesExist(from_rel, to_rel,
 
1159
                        extra="(Use --after to update the Bazaar id)")
1413
1160
            rename_entry.only_change_inv = only_change_inv
1414
1161
        return rename_entries
1415
1162
 
1435
1182
        inv = self.inventory
1436
1183
        for entry in moved:
1437
1184
            try:
1438
 
                self._move_entry(WorkingTree._RenameEntry(
1439
 
                    entry.to_rel, entry.from_id,
 
1185
                self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1440
1186
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
1441
1187
                    entry.from_tail, entry.from_parent_id,
1442
1188
                    entry.only_change_inv))
1493
1239
        from_tail = splitpath(from_rel)[-1]
1494
1240
        from_id = inv.path2id(from_rel)
1495
1241
        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]
 
1242
            raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1243
                errors.NotVersionedError(path=str(from_rel)))
 
1244
        from_entry = inv[from_id]
1507
1245
        from_parent_id = from_entry.parent_id
1508
1246
        to_dir, to_tail = os.path.split(to_rel)
1509
1247
        to_dir_id = inv.path2id(to_dir)
1555
1293
        These are files in the working directory that are not versioned or
1556
1294
        control files or ignored.
1557
1295
        """
1558
 
        # force the extras method to be fully executed before returning, to
1559
 
        # prevent race conditions with the lock
1560
 
        return iter(
1561
 
            [subp for subp in self.extras() if not self.is_ignored(subp)])
1562
 
 
 
1296
        for subp in self.extras():
 
1297
            if not self.is_ignored(subp):
 
1298
                yield subp
 
1299
    
1563
1300
    @needs_tree_write_lock
1564
1301
    def unversion(self, file_ids):
1565
1302
        """Remove the file ids in file_ids from the current versioned set.
1571
1308
        :raises: NoSuchId if any fileid is not currently versioned.
1572
1309
        """
1573
1310
        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:
 
1311
            file_id = osutils.safe_file_id(file_id)
1577
1312
            if self._inventory.has_id(file_id):
1578
1313
                self._inventory.remove_recursive_id(file_id)
 
1314
            else:
 
1315
                raise errors.NoSuchId(self, file_id)
1579
1316
        if len(file_ids):
1580
 
            # in the future this should just set a dirty bit to wait for the
 
1317
            # in the future this should just set a dirty bit to wait for the 
1581
1318
            # final unlock. However, until all methods of workingtree start
1582
 
            # with the current in -memory inventory rather than triggering
 
1319
            # with the current in -memory inventory rather than triggering 
1583
1320
            # a read, it is more complex - we need to teach read_inventory
1584
1321
            # to know when to read, and when to not read first... and possibly
1585
1322
            # to save first when the in memory one may be corrupted.
1586
1323
            # so for now, we just only write it if it is indeed dirty.
1587
1324
            # - RBC 20060907
1588
1325
            self._write_inventory(self._inventory)
 
1326
    
 
1327
    @deprecated_method(zero_eight)
 
1328
    def iter_conflicts(self):
 
1329
        """List all files in the tree that have text or content conflicts.
 
1330
        DEPRECATED.  Use conflicts instead."""
 
1331
        return self._iter_conflicts()
1589
1332
 
1590
1333
    def _iter_conflicts(self):
1591
1334
        conflicted = set()
1600
1343
 
1601
1344
    @needs_write_lock
1602
1345
    def pull(self, source, overwrite=False, stop_revision=None,
1603
 
             change_reporter=None, possible_transports=None, local=False):
 
1346
             change_reporter=None):
 
1347
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1604
1348
        source.lock_read()
1605
1349
        try:
 
1350
            pp = ProgressPhase("Pull phase", 2, top_pb)
 
1351
            pp.next_phase()
1606
1352
            old_revision_info = self.branch.last_revision_info()
1607
1353
            basis_tree = self.basis_tree()
1608
 
            count = self.branch.pull(source, overwrite, stop_revision,
1609
 
                                     possible_transports=possible_transports,
1610
 
                                     local=local)
 
1354
            count = self.branch.pull(source, overwrite, stop_revision)
1611
1355
            new_revision_info = self.branch.last_revision_info()
1612
1356
            if new_revision_info != old_revision_info:
 
1357
                pp.next_phase()
1613
1358
                repository = self.branch.repository
1614
 
                basis_tree.lock_read()
 
1359
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
1615
1360
                try:
1616
1361
                    new_basis_tree = self.branch.basis_tree()
1617
1362
                    merge.merge_inner(
1619
1364
                                new_basis_tree,
1620
1365
                                basis_tree,
1621
1366
                                this_tree=self,
1622
 
                                pb=None,
 
1367
                                pb=pb,
1623
1368
                                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)
 
1369
                    if (basis_tree.inventory.root is None and
 
1370
                        new_basis_tree.inventory.root is not None):
 
1371
                        self.set_root_id(new_basis_tree.inventory.root.file_id)
1628
1372
                finally:
1629
 
                    basis_tree.unlock()
 
1373
                    pb.finished()
1630
1374
                # TODO - dedup parents list with things merged by pull ?
1631
1375
                # reuse the revisiontree we merged against to set the new
1632
1376
                # tree data.
1633
1377
                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
 
1378
                # we have to pull the merge trees out again, because 
 
1379
                # merge_inner has set the ids. - this corner is not yet 
1636
1380
                # layered well enough to prevent double handling.
1637
 
                # XXX TODO: Fix the double handling: telling the tree about
1638
 
                # the already known parent data is wasteful.
1639
1381
                merges = self.get_parent_ids()[1:]
1640
1382
                parent_trees.extend([
1641
1383
                    (parent, repository.revision_tree(parent)) for
1644
1386
            return count
1645
1387
        finally:
1646
1388
            source.unlock()
 
1389
            top_pb.finished()
1647
1390
 
1648
1391
    @needs_write_lock
1649
1392
    def put_file_bytes_non_atomic(self, file_id, bytes):
1650
1393
        """See MutableTree.put_file_bytes_non_atomic."""
 
1394
        file_id = osutils.safe_file_id(file_id)
1651
1395
        stream = file(self.id2abspath(file_id), 'wb')
1652
1396
        try:
1653
1397
            stream.write(bytes)
1656
1400
        # TODO: update the hashcache here ?
1657
1401
 
1658
1402
    def extras(self):
1659
 
        """Yield all unversioned files in this WorkingTree.
 
1403
        """Yield all unknown files in this WorkingTree.
1660
1404
 
1661
 
        If there are any unversioned directories then only the directory is
1662
 
        returned, not all its children.  But if there are unversioned files
 
1405
        If there are any unknown directories then only the directory is
 
1406
        returned, not all its children.  But if there are unknown files
1663
1407
        under a versioned subdirectory, they are returned.
1664
1408
 
1665
1409
        Currently returned depth-first, sorted by name within directories.
1666
 
        This is the same order used by 'osutils.walkdirs'.
1667
1410
        """
1668
1411
        ## TODO: Work from given directory downwards
1669
1412
        for path, dir_entry in self.inventory.directories():
1675
1418
 
1676
1419
            fl = []
1677
1420
            for subf in os.listdir(dirabs):
1678
 
                if self.bzrdir.is_control_filename(subf):
 
1421
                if subf == '.bzr':
1679
1422
                    continue
1680
1423
                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)
 
1424
                    subf_norm, can_access = osutils.normalized_filename(subf)
1689
1425
                    if subf_norm != subf and can_access:
1690
1426
                        if subf_norm not in dir_entry.children:
1691
1427
                            fl.append(subf_norm)
1692
1428
                    else:
1693
1429
                        fl.append(subf)
1694
 
 
 
1430
            
1695
1431
            fl.sort()
1696
1432
            for subf in fl:
1697
1433
                subp = pathjoin(path, subf)
1698
1434
                yield subp
1699
1435
 
 
1436
 
1700
1437
    def ignored_files(self):
1701
1438
        """Yield list of PATH, IGNORE_PATTERN"""
1702
1439
        for subp in self.extras():
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()
1799
1530
 
1800
1531
    def lock_read(self):
1801
1532
        """See Branch.lock_read, and WorkingTree.unlock."""
1802
 
        if not self.is_locked():
1803
 
            self._reset_data()
1804
1533
        self.branch.lock_read()
1805
1534
        try:
1806
1535
            return self._control_files.lock_read()
1810
1539
 
1811
1540
    def lock_tree_write(self):
1812
1541
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1813
 
        if not self.is_locked():
1814
 
            self._reset_data()
1815
1542
        self.branch.lock_read()
1816
1543
        try:
1817
1544
            return self._control_files.lock_write()
1821
1548
 
1822
1549
    def lock_write(self):
1823
1550
        """See MutableTree.lock_write, and WorkingTree.unlock."""
1824
 
        if not self.is_locked():
1825
 
            self._reset_data()
1826
1551
        self.branch.lock_write()
1827
1552
        try:
1828
1553
            return self._control_files.lock_write()
1836
1561
    def _basis_inventory_name(self):
1837
1562
        return 'basis-inventory-cache'
1838
1563
 
1839
 
    def _reset_data(self):
1840
 
        """Reset transient data that cannot be revalidated."""
1841
 
        self._inventory_is_modified = False
1842
 
        f = self._transport.get('inventory')
1843
 
        try:
1844
 
            result = self._deserialize(f)
1845
 
        finally:
1846
 
            f.close()
1847
 
        self._set_inventory(result, dirty=False)
1848
 
 
1849
1564
    @needs_tree_write_lock
1850
1565
    def set_last_revision(self, new_revision):
1851
1566
        """Change the last revision in the working tree."""
 
1567
        new_revision = osutils.safe_revision_id(new_revision)
1852
1568
        if self._change_last_revision(new_revision):
1853
1569
            self._cache_basis_inventory(new_revision)
1854
1570
 
1855
1571
    def _change_last_revision(self, new_revision):
1856
1572
        """Template method part of set_last_revision to perform the change.
1857
 
 
 
1573
        
1858
1574
        This is used to allow WorkingTree3 instances to not affect branch
1859
1575
        when their last revision is set.
1860
1576
        """
1861
 
        if _mod_revision.is_null(new_revision):
 
1577
        if new_revision is None:
1862
1578
            self.branch.set_revision_history([])
1863
1579
            return False
1864
1580
        try:
1870
1586
 
1871
1587
    def _write_basis_inventory(self, xml):
1872
1588
        """Write the basis inventory XML to the basis-inventory file"""
 
1589
        assert isinstance(xml, str), 'serialised xml must be bytestring.'
1873
1590
        path = self._basis_inventory_name()
1874
1591
        sio = StringIO(xml)
1875
 
        self._transport.put_file(path, sio,
1876
 
            mode=self.bzrdir._get_file_mode())
 
1592
        self._control_files.put(path, sio)
1877
1593
 
1878
1594
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
1879
1595
        """Create the text that will be saved in basis-inventory"""
1880
 
        inventory.revision_id = revision_id
1881
 
        return xml7.serializer_v7.write_inventory_to_string(inventory)
 
1596
        # TODO: jam 20070209 This should be redundant, as the revision_id
 
1597
        #       as all callers should have already converted the revision_id to
 
1598
        #       utf8
 
1599
        inventory.revision_id = osutils.safe_revision_id(revision_id)
 
1600
        return xml6.serializer_v6.write_inventory_to_string(inventory)
1882
1601
 
1883
1602
    def _cache_basis_inventory(self, new_revision):
1884
1603
        """Cache new_revision as the basis inventory."""
1886
1605
        # as commit already has that ready-to-use [while the format is the
1887
1606
        # same, that is].
1888
1607
        try:
1889
 
            # this double handles the inventory - unpack and repack -
 
1608
            # this double handles the inventory - unpack and repack - 
1890
1609
            # but is easier to understand. We can/should put a conditional
1891
1610
            # in here based on whether the inventory is in the latest format
1892
1611
            # - perhaps we should repack all inventories on a repository
1893
1612
            # upgrade ?
1894
1613
            # the fast path is to copy the raw xml from the repository. If the
1895
 
            # xml contains 'revision_id="', then we assume the right
 
1614
            # xml contains 'revision_id="', then we assume the right 
1896
1615
            # revision_id is set. We must check for this full string, because a
1897
1616
            # root node id can legitimately look like 'revision_id' but cannot
1898
1617
            # contain a '"'.
1899
 
            xml = self.branch.repository._get_inventory_xml(new_revision)
 
1618
            xml = self.branch.repository.get_inventory_xml(new_revision)
1900
1619
            firstline = xml.split('\n', 1)[0]
1901
 
            if (not 'revision_id="' in firstline or
1902
 
                'format="7"' not in firstline):
1903
 
                inv = self.branch.repository._serializer.read_inventory_from_string(
1904
 
                    xml, new_revision)
 
1620
            if (not 'revision_id="' in firstline or 
 
1621
                'format="6"' not in firstline):
 
1622
                inv = self.branch.repository.deserialise_inventory(
 
1623
                    new_revision, xml)
1905
1624
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
1906
1625
            self._write_basis_inventory(xml)
1907
1626
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1910
1629
    def read_basis_inventory(self):
1911
1630
        """Read the cached basis inventory."""
1912
1631
        path = self._basis_inventory_name()
1913
 
        return self._transport.get_bytes(path)
1914
 
 
 
1632
        return self._control_files.get(path).read()
 
1633
        
1915
1634
    @needs_read_lock
1916
1635
    def read_working_inventory(self):
1917
1636
        """Read the working inventory.
1918
 
 
 
1637
        
1919
1638
        :raises errors.InventoryModified: read_working_inventory will fail
1920
1639
            when the current in memory inventory has been modified.
1921
1640
        """
1922
 
        # conceptually this should be an implementation detail of the tree.
 
1641
        # conceptually this should be an implementation detail of the tree. 
1923
1642
        # XXX: Deprecate this.
1924
1643
        # ElementTree does its own conversion from UTF-8, so open in
1925
1644
        # binary.
1926
1645
        if self._inventory_is_modified:
1927
1646
            raise errors.InventoryModified(self)
1928
 
        f = self._transport.get('inventory')
1929
 
        try:
1930
 
            result = self._deserialize(f)
1931
 
        finally:
1932
 
            f.close()
 
1647
        result = xml5.serializer_v5.read_inventory(
 
1648
            self._control_files.get('inventory'))
1933
1649
        self._set_inventory(result, dirty=False)
1934
1650
        return result
1935
1651
 
1936
1652
    @needs_tree_write_lock
1937
 
    def remove(self, files, verbose=False, to_file=None, keep_files=True,
1938
 
        force=False):
1939
 
        """Remove nominated files from the working inventory.
1940
 
 
1941
 
        :files: File paths relative to the basedir.
1942
 
        :keep_files: If true, the files will also be kept.
1943
 
        :force: Delete files and directories, even if they are changed and
1944
 
            even if the directories are not empty.
 
1653
    def remove(self, files, verbose=False, to_file=None):
 
1654
        """Remove nominated files from the working inventory..
 
1655
 
 
1656
        This does not remove their text.  This does not run on XXX on what? RBC
 
1657
 
 
1658
        TODO: Refuse to remove modified files unless --force is given?
 
1659
 
 
1660
        TODO: Do something useful with directories.
 
1661
 
 
1662
        TODO: Should this remove the text or not?  Tough call; not
 
1663
        removing may be useful and the user can just use use rm, and
 
1664
        is the opposite of add.  Removing it is consistent with most
 
1665
        other tools.  Maybe an option.
1945
1666
        """
 
1667
        ## TODO: Normalize names
 
1668
        ## TODO: Remove nested loops; better scalability
1946
1669
        if isinstance(files, basestring):
1947
1670
            files = [files]
1948
1671
 
1949
 
        inv_delta = []
1950
 
 
1951
 
        new_files=set()
1952
 
        unknown_nested_files=set()
1953
 
        if to_file is None:
1954
 
            to_file = sys.stdout
1955
 
 
1956
 
        def recurse_directory_to_add_files(directory):
1957
 
            # Recurse directory and add all files
1958
 
            # so we can check if they have changed.
1959
 
            for parent_info, file_infos in\
1960
 
                self.walkdirs(directory):
1961
 
                for relpath, basename, kind, lstat, fileid, kind in file_infos:
1962
 
                    # Is it versioned or ignored?
1963
 
                    if self.path2id(relpath) or self.is_ignored(relpath):
1964
 
                        # Add nested content for deletion.
1965
 
                        new_files.add(relpath)
1966
 
                    else:
1967
 
                        # Files which are not versioned and not ignored
1968
 
                        # should be treated as unknown.
1969
 
                        unknown_nested_files.add((relpath, None, kind))
1970
 
 
1971
 
        for filename in files:
1972
 
            # Get file name into canonical form.
1973
 
            abspath = self.abspath(filename)
1974
 
            filename = self.relpath(abspath)
1975
 
            if len(filename) > 0:
1976
 
                new_files.add(filename)
1977
 
                recurse_directory_to_add_files(filename)
1978
 
 
1979
 
        files = list(new_files)
1980
 
 
1981
 
        if len(files) == 0:
1982
 
            return # nothing to do
1983
 
 
1984
 
        # Sort needed to first handle directory content before the directory
1985
 
        files.sort(reverse=True)
1986
 
 
1987
 
        # Bail out if we are going to delete files we shouldn't
1988
 
        if not keep_files and not force:
1989
 
            has_changed_files = len(unknown_nested_files) > 0
1990
 
            if not has_changed_files:
1991
 
                for (file_id, path, content_change, versioned, parent_id, name,
1992
 
                     kind, executable) in self.iter_changes(self.basis_tree(),
1993
 
                         include_unchanged=True, require_versioned=False,
1994
 
                         want_unversioned=True, specific_files=files):
1995
 
                    if versioned == (False, False):
1996
 
                        # The record is unknown ...
1997
 
                        if not self.is_ignored(path[1]):
1998
 
                            # ... but not ignored
1999
 
                            has_changed_files = True
2000
 
                            break
2001
 
                    elif content_change and (kind[1] is not None):
2002
 
                        # Versioned and changed, but not deleted
2003
 
                        has_changed_files = True
2004
 
                        break
2005
 
 
2006
 
            if has_changed_files:
2007
 
                # Make delta show ALL applicable changes in error message.
2008
 
                tree_delta = self.changes_from(self.basis_tree(),
2009
 
                    require_versioned=False, want_unversioned=True,
2010
 
                    specific_files=files)
2011
 
                for unknown_file in unknown_nested_files:
2012
 
                    if unknown_file not in tree_delta.unversioned:
2013
 
                        tree_delta.unversioned.extend((unknown_file,))
2014
 
                raise errors.BzrRemoveChangedFilesError(tree_delta)
2015
 
 
2016
 
        # Build inv_delta and delete files where applicable,
2017
 
        # do this before any modifications to inventory.
 
1672
        inv = self.inventory
 
1673
 
 
1674
        # do this before any modifications
2018
1675
        for f in files:
2019
 
            fid = self.path2id(f)
2020
 
            message = None
 
1676
            fid = inv.path2id(f)
2021
1677
            if not fid:
2022
 
                message = "%s is not versioned." % (f,)
 
1678
                note("%s is not versioned."%f)
2023
1679
            else:
2024
1680
                if verbose:
2025
 
                    # having removed it, it must be either ignored or unknown
 
1681
                    # having remove it, it must be either ignored or unknown
2026
1682
                    if self.is_ignored(f):
2027
1683
                        new_status = 'I'
2028
1684
                    else:
2029
1685
                        new_status = '?'
2030
 
                    # XXX: Really should be a more abstract reporter interface
2031
 
                    kind_ch = osutils.kind_marker(self.kind(fid))
2032
 
                    to_file.write(new_status + '       ' + f + kind_ch + '\n')
2033
 
                # Unversion file
2034
 
                inv_delta.append((f, None, fid, None))
2035
 
                message = "removed %s" % (f,)
2036
 
 
2037
 
            if not keep_files:
2038
 
                abs_path = self.abspath(f)
2039
 
                if osutils.lexists(abs_path):
2040
 
                    if (osutils.isdir(abs_path) and
2041
 
                        len(os.listdir(abs_path)) > 0):
2042
 
                        if force:
2043
 
                            osutils.rmtree(abs_path)
2044
 
                        else:
2045
 
                            message = "%s is not an empty directory "\
2046
 
                                "and won't be deleted." % (f,)
2047
 
                    else:
2048
 
                        osutils.delete_any(abs_path)
2049
 
                        message = "deleted %s" % (f,)
2050
 
                elif message is not None:
2051
 
                    # Only care if we haven't done anything yet.
2052
 
                    message = "%s does not exist." % (f,)
2053
 
 
2054
 
            # Print only one message (if any) per file.
2055
 
            if message is not None:
2056
 
                note(message)
2057
 
        self.apply_inventory_delta(inv_delta)
 
1686
                    textui.show_status(new_status, inv[fid].kind, f,
 
1687
                                       to_file=to_file)
 
1688
                del inv[fid]
 
1689
 
 
1690
        self._write_inventory(inv)
2058
1691
 
2059
1692
    @needs_tree_write_lock
2060
 
    def revert(self, filenames=None, old_tree=None, backups=True,
2061
 
               pb=None, report_changes=False):
 
1693
    def revert(self, filenames, old_tree=None, backups=True, 
 
1694
               pb=DummyProgress(), report_changes=False):
2062
1695
        from bzrlib.conflicts import resolve
2063
 
        if filenames == []:
2064
 
            filenames = None
2065
 
            symbol_versioning.warn('Using [] to revert all files is deprecated'
2066
 
                ' as of bzr 0.91.  Please use None (the default) instead.',
2067
 
                DeprecationWarning, stacklevel=2)
2068
1696
        if old_tree is None:
2069
 
            basis_tree = self.basis_tree()
2070
 
            basis_tree.lock_read()
2071
 
            old_tree = basis_tree
 
1697
            old_tree = self.basis_tree()
 
1698
        conflicts = transform.revert(self, old_tree, filenames, backups, pb,
 
1699
                                     report_changes)
 
1700
        if not len(filenames):
 
1701
            self.set_parent_ids(self.get_parent_ids()[:1])
 
1702
            resolve(self)
2072
1703
        else:
2073
 
            basis_tree = None
2074
 
        try:
2075
 
            conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2076
 
                                         report_changes)
2077
 
            if filenames is None and len(self.get_parent_ids()) > 1:
2078
 
                parent_trees = []
2079
 
                last_revision = self.last_revision()
2080
 
                if last_revision != _mod_revision.NULL_REVISION:
2081
 
                    if basis_tree is None:
2082
 
                        basis_tree = self.basis_tree()
2083
 
                        basis_tree.lock_read()
2084
 
                    parent_trees.append((last_revision, basis_tree))
2085
 
                self.set_parent_trees(parent_trees)
2086
 
                resolve(self)
2087
 
            else:
2088
 
                resolve(self, filenames, ignore_misses=True, recursive=True)
2089
 
        finally:
2090
 
            if basis_tree is not None:
2091
 
                basis_tree.unlock()
 
1704
            resolve(self, filenames, ignore_misses=True)
2092
1705
        return conflicts
2093
1706
 
2094
 
    def revision_tree(self, revision_id):
2095
 
        """See Tree.revision_tree.
2096
 
 
2097
 
        WorkingTree can supply revision_trees for the basis revision only
2098
 
        because there is only one cached inventory in the bzr directory.
2099
 
        """
2100
 
        if revision_id == self.last_revision():
2101
 
            try:
2102
 
                xml = self.read_basis_inventory()
2103
 
            except errors.NoSuchFile:
2104
 
                pass
2105
 
            else:
2106
 
                try:
2107
 
                    inv = xml7.serializer_v7.read_inventory_from_string(xml)
2108
 
                    # dont use the repository revision_tree api because we want
2109
 
                    # to supply the inventory.
2110
 
                    if inv.revision_id == revision_id:
2111
 
                        return revisiontree.RevisionTree(self.branch.repository,
2112
 
                            inv, revision_id)
2113
 
                except errors.BadInventoryFormat:
2114
 
                    pass
2115
 
        # raise if there was no inventory, or if we read the wrong inventory.
2116
 
        raise errors.NoSuchRevisionInTree(self, revision_id)
2117
 
 
2118
1707
    # XXX: This method should be deprecated in favour of taking in a proper
2119
1708
    # new Inventory object.
2120
1709
    @needs_tree_write_lock
2121
1710
    def set_inventory(self, new_inventory_list):
2122
1711
        from bzrlib.inventory import (Inventory,
2123
1712
                                      InventoryDirectory,
 
1713
                                      InventoryEntry,
2124
1714
                                      InventoryFile,
2125
1715
                                      InventoryLink)
2126
1716
        inv = Inventory(self.get_root_id())
2128
1718
            name = os.path.basename(path)
2129
1719
            if name == "":
2130
1720
                continue
2131
 
            # fixme, there should be a factory function inv,add_??
 
1721
            # fixme, there should be a factory function inv,add_?? 
2132
1722
            if kind == 'directory':
2133
1723
                inv.add(InventoryDirectory(file_id, name, parent))
2134
1724
            elif kind == 'file':
2142
1732
    @needs_tree_write_lock
2143
1733
    def set_root_id(self, file_id):
2144
1734
        """Set the root id for this tree."""
2145
 
        # for compatability
 
1735
        # for compatability 
2146
1736
        if file_id is None:
2147
 
            raise ValueError(
2148
 
                'WorkingTree.set_root_id with fileid=None')
2149
 
        file_id = osutils.safe_file_id(file_id)
2150
 
        self._set_root_id(file_id)
2151
 
 
2152
 
    def _set_root_id(self, file_id):
2153
 
        """Set the root id for this tree, in a format specific manner.
2154
 
 
2155
 
        :param file_id: The file id to assign to the root. It must not be
2156
 
            present in the current inventory or an error will occur. It must
2157
 
            not be None, but rather a valid file id.
2158
 
        """
 
1737
            symbol_versioning.warn(symbol_versioning.zero_twelve
 
1738
                % 'WorkingTree.set_root_id with fileid=None',
 
1739
                DeprecationWarning,
 
1740
                stacklevel=3)
 
1741
            file_id = ROOT_ID
 
1742
        else:
 
1743
            file_id = osutils.safe_file_id(file_id)
2159
1744
        inv = self._inventory
2160
1745
        orig_root_id = inv.root.file_id
2161
1746
        # TODO: it might be nice to exit early if there was nothing
2177
1762
 
2178
1763
    def unlock(self):
2179
1764
        """See Branch.unlock.
2180
 
 
 
1765
        
2181
1766
        WorkingTree locking just uses the Branch locking facilities.
2182
1767
        This is current because all working trees have an embedded branch
2183
1768
        within them. IF in the future, we were to make branch data shareable
2184
 
        between multiple working trees, i.e. via shared storage, then we
 
1769
        between multiple working trees, i.e. via shared storage, then we 
2185
1770
        would probably want to lock both the local tree, and the branch.
2186
1771
        """
2187
1772
        raise NotImplementedError(self.unlock)
2188
1773
 
2189
 
    _marker = object()
2190
 
 
2191
 
    def update(self, change_reporter=None, possible_transports=None,
2192
 
               revision=None, old_tip=_marker):
 
1774
    def update(self):
2193
1775
        """Update a working tree along its branch.
2194
1776
 
2195
1777
        This will update the branch if its bound too, which means we have
2213
1795
        - Merge current state -> basis tree of the master w.r.t. the old tree
2214
1796
          basis.
2215
1797
        - Do a 'normal' merge of the old branch basis if it is relevant.
2216
 
 
2217
 
        :param revision: The target revision to update to. Must be in the
2218
 
            revision history.
2219
 
        :param old_tip: If branch.update() has already been run, the value it
2220
 
            returned (old tip of the branch or None). _marker is used
2221
 
            otherwise.
2222
1798
        """
2223
 
        if self.branch.get_bound_location() is not None:
 
1799
        if self.branch.get_master_branch() is not None:
2224
1800
            self.lock_write()
2225
 
            update_branch = (old_tip is self._marker)
 
1801
            update_branch = True
2226
1802
        else:
2227
1803
            self.lock_tree_write()
2228
1804
            update_branch = False
2229
1805
        try:
2230
1806
            if update_branch:
2231
 
                old_tip = self.branch.update(possible_transports)
 
1807
                old_tip = self.branch.update()
2232
1808
            else:
2233
 
                if old_tip is self._marker:
2234
 
                    old_tip = None
2235
 
            return self._update_tree(old_tip, change_reporter, revision)
 
1809
                old_tip = None
 
1810
            return self._update_tree(old_tip)
2236
1811
        finally:
2237
1812
            self.unlock()
2238
1813
 
2239
1814
    @needs_tree_write_lock
2240
 
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
 
1815
    def _update_tree(self, old_tip=None):
2241
1816
        """Update a tree to the master branch.
2242
1817
 
2243
1818
        :param old_tip: if supplied, the previous tip revision the branch,
2249
1824
        # cant set that until we update the working trees last revision to be
2250
1825
        # one from the new branch, because it will just get absorbed by the
2251
1826
        # parent de-duplication logic.
2252
 
        #
 
1827
        # 
2253
1828
        # We MUST save it even if an error occurs, because otherwise the users
2254
1829
        # local work is unreferenced and will appear to have been lost.
2255
 
        #
2256
 
        nb_conflicts = 0
 
1830
        # 
 
1831
        result = 0
2257
1832
        try:
2258
1833
            last_rev = self.get_parent_ids()[0]
2259
1834
        except IndexError:
2260
 
            last_rev = _mod_revision.NULL_REVISION
2261
 
        if revision is None:
2262
 
            revision = self.branch.last_revision()
2263
 
 
2264
 
        old_tip = old_tip or _mod_revision.NULL_REVISION
2265
 
 
2266
 
        if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2267
 
            # the branch we are bound to was updated
2268
 
            # merge those changes in first
2269
 
            base_tree  = self.basis_tree()
2270
 
            other_tree = self.branch.repository.revision_tree(old_tip)
2271
 
            nb_conflicts = merge.merge_inner(self.branch, other_tree,
2272
 
                                             base_tree, this_tree=self,
2273
 
                                             change_reporter=change_reporter)
2274
 
            if nb_conflicts:
2275
 
                self.add_parent_tree((old_tip, other_tree))
2276
 
                trace.note('Rerun update after fixing the conflicts.')
2277
 
                return nb_conflicts
2278
 
 
2279
 
        if last_rev != _mod_revision.ensure_null(revision):
2280
 
            # the working tree is up to date with the branch
2281
 
            # we can merge the specified revision from master
2282
 
            to_tree = self.branch.repository.revision_tree(revision)
2283
 
            to_root_id = to_tree.get_root_id()
2284
 
 
 
1835
            last_rev = None
 
1836
        if last_rev != self.branch.last_revision():
 
1837
            # merge tree state up to new branch tip.
2285
1838
            basis = self.basis_tree()
2286
 
            basis.lock_read()
2287
 
            try:
2288
 
                if (basis.inventory.root is None
2289
 
                    or basis.inventory.root.file_id != to_root_id):
2290
 
                    self.set_root_id(to_root_id)
2291
 
                    self.flush()
2292
 
            finally:
2293
 
                basis.unlock()
2294
 
 
2295
 
            # determine the branch point
2296
 
            graph = self.branch.repository.get_graph()
2297
 
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2298
 
                                                last_rev)
2299
 
            base_tree = self.branch.repository.revision_tree(base_rev_id)
2300
 
 
2301
 
            nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2302
 
                                             this_tree=self,
2303
 
                                             change_reporter=change_reporter)
2304
 
            self.set_last_revision(revision)
 
1839
            to_tree = self.branch.basis_tree()
 
1840
            if basis.inventory.root is None:
 
1841
                self.set_root_id(to_tree.inventory.root.file_id)
 
1842
            result += merge.merge_inner(
 
1843
                                  self.branch,
 
1844
                                  to_tree,
 
1845
                                  basis,
 
1846
                                  this_tree=self)
2305
1847
            # TODO - dedup parents list with things merged by pull ?
2306
1848
            # reuse the tree we've updated to to set the basis:
2307
 
            parent_trees = [(revision, to_tree)]
 
1849
            parent_trees = [(self.branch.last_revision(), to_tree)]
2308
1850
            merges = self.get_parent_ids()[1:]
2309
1851
            # Ideally we ask the tree for the trees here, that way the working
2310
 
            # tree can decide whether to give us the entire tree or give us a
 
1852
            # tree can decide whether to give us teh entire tree or give us a
2311
1853
            # lazy initialised tree. dirstate for instance will have the trees
2312
1854
            # in ram already, whereas a last-revision + basis-inventory tree
2313
1855
            # will not, but also does not need them when setting parents.
2314
1856
            for parent in merges:
2315
1857
                parent_trees.append(
2316
1858
                    (parent, self.branch.repository.revision_tree(parent)))
2317
 
            if not _mod_revision.is_null(old_tip):
 
1859
            if old_tip is not None:
2318
1860
                parent_trees.append(
2319
1861
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
2320
1862
            self.set_parent_trees(parent_trees)
2321
1863
            last_rev = parent_trees[0][0]
2322
 
        return nb_conflicts
 
1864
        else:
 
1865
            # the working tree had the same last-revision as the master
 
1866
            # branch did. We may still have pivot local work from the local
 
1867
            # branch into old_tip:
 
1868
            if old_tip is not None:
 
1869
                self.add_parent_tree_id(old_tip)
 
1870
        if old_tip and old_tip != last_rev:
 
1871
            # our last revision was not the prior branch last revision
 
1872
            # and we have converted that last revision to a pending merge.
 
1873
            # base is somewhere between the branch tip now
 
1874
            # and the now pending merge
 
1875
            from bzrlib.revision import common_ancestor
 
1876
            try:
 
1877
                base_rev_id = common_ancestor(self.branch.last_revision(),
 
1878
                                              old_tip,
 
1879
                                              self.branch.repository)
 
1880
            except errors.NoCommonAncestor:
 
1881
                base_rev_id = None
 
1882
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
1883
            other_tree = self.branch.repository.revision_tree(old_tip)
 
1884
            result += merge.merge_inner(
 
1885
                                  self.branch,
 
1886
                                  other_tree,
 
1887
                                  base_tree,
 
1888
                                  this_tree=self)
 
1889
        return result
2323
1890
 
2324
1891
    def _write_hashcache_if_dirty(self):
2325
1892
        """Write out the hashcache if it is dirty."""
2373
1940
                             file_id=self.path2id(conflicted)))
2374
1941
        return conflicts
2375
1942
 
2376
 
    def walkdirs(self, prefix=""):
2377
 
        """Walk the directories of this tree.
2378
 
 
2379
 
        returns a generator which yields items in the form:
2380
 
                ((curren_directory_path, fileid),
2381
 
                 [(file1_path, file1_name, file1_kind, (lstat), file1_id,
2382
 
                   file1_kind), ... ])
2383
 
 
2384
 
        This API returns a generator, which is only valid during the current
2385
 
        tree transaction - within a single lock_read or lock_write duration.
2386
 
 
2387
 
        If the tree is not locked, it may cause an error to be raised,
2388
 
        depending on the tree implementation.
2389
 
        """
2390
 
        disk_top = self.abspath(prefix)
2391
 
        if disk_top.endswith('/'):
2392
 
            disk_top = disk_top[:-1]
2393
 
        top_strip_len = len(disk_top) + 1
2394
 
        inventory_iterator = self._walkdirs(prefix)
2395
 
        disk_iterator = osutils.walkdirs(disk_top, prefix)
2396
 
        try:
2397
 
            current_disk = disk_iterator.next()
2398
 
            disk_finished = False
2399
 
        except OSError, e:
2400
 
            if not (e.errno == errno.ENOENT or
2401
 
                (sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2402
 
                raise
2403
 
            current_disk = None
2404
 
            disk_finished = True
2405
 
        try:
2406
 
            current_inv = inventory_iterator.next()
2407
 
            inv_finished = False
2408
 
        except StopIteration:
2409
 
            current_inv = None
2410
 
            inv_finished = True
2411
 
        while not inv_finished or not disk_finished:
2412
 
            if current_disk:
2413
 
                ((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2414
 
                    cur_disk_dir_content) = current_disk
2415
 
            else:
2416
 
                ((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2417
 
                    cur_disk_dir_content) = ((None, None), None)
2418
 
            if not disk_finished:
2419
 
                # strip out .bzr dirs
2420
 
                if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2421
 
                    len(cur_disk_dir_content) > 0):
2422
 
                    # osutils.walkdirs can be made nicer -
2423
 
                    # yield the path-from-prefix rather than the pathjoined
2424
 
                    # value.
2425
 
                    bzrdir_loc = bisect_left(cur_disk_dir_content,
2426
 
                        ('.bzr', '.bzr'))
2427
 
                    if (bzrdir_loc < len(cur_disk_dir_content)
2428
 
                        and self.bzrdir.is_control_filename(
2429
 
                            cur_disk_dir_content[bzrdir_loc][0])):
2430
 
                        # we dont yield the contents of, or, .bzr itself.
2431
 
                        del cur_disk_dir_content[bzrdir_loc]
2432
 
            if inv_finished:
2433
 
                # everything is unknown
2434
 
                direction = 1
2435
 
            elif disk_finished:
2436
 
                # everything is missing
2437
 
                direction = -1
2438
 
            else:
2439
 
                direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
2440
 
            if direction > 0:
2441
 
                # disk is before inventory - unknown
2442
 
                dirblock = [(relpath, basename, kind, stat, None, None) for
2443
 
                    relpath, basename, kind, stat, top_path in
2444
 
                    cur_disk_dir_content]
2445
 
                yield (cur_disk_dir_relpath, None), dirblock
2446
 
                try:
2447
 
                    current_disk = disk_iterator.next()
2448
 
                except StopIteration:
2449
 
                    disk_finished = True
2450
 
            elif direction < 0:
2451
 
                # inventory is before disk - missing.
2452
 
                dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2453
 
                    for relpath, basename, dkind, stat, fileid, kind in
2454
 
                    current_inv[1]]
2455
 
                yield (current_inv[0][0], current_inv[0][1]), dirblock
2456
 
                try:
2457
 
                    current_inv = inventory_iterator.next()
2458
 
                except StopIteration:
2459
 
                    inv_finished = True
2460
 
            else:
2461
 
                # versioned present directory
2462
 
                # merge the inventory and disk data together
2463
 
                dirblock = []
2464
 
                for relpath, subiterator in itertools.groupby(sorted(
2465
 
                    current_inv[1] + cur_disk_dir_content,
2466
 
                    key=operator.itemgetter(0)), operator.itemgetter(1)):
2467
 
                    path_elements = list(subiterator)
2468
 
                    if len(path_elements) == 2:
2469
 
                        inv_row, disk_row = path_elements
2470
 
                        # versioned, present file
2471
 
                        dirblock.append((inv_row[0],
2472
 
                            inv_row[1], disk_row[2],
2473
 
                            disk_row[3], inv_row[4],
2474
 
                            inv_row[5]))
2475
 
                    elif len(path_elements[0]) == 5:
2476
 
                        # unknown disk file
2477
 
                        dirblock.append((path_elements[0][0],
2478
 
                            path_elements[0][1], path_elements[0][2],
2479
 
                            path_elements[0][3], None, None))
2480
 
                    elif len(path_elements[0]) == 6:
2481
 
                        # versioned, absent file.
2482
 
                        dirblock.append((path_elements[0][0],
2483
 
                            path_elements[0][1], 'unknown', None,
2484
 
                            path_elements[0][4], path_elements[0][5]))
2485
 
                    else:
2486
 
                        raise NotImplementedError('unreachable code')
2487
 
                yield current_inv[0], dirblock
2488
 
                try:
2489
 
                    current_inv = inventory_iterator.next()
2490
 
                except StopIteration:
2491
 
                    inv_finished = True
2492
 
                try:
2493
 
                    current_disk = disk_iterator.next()
2494
 
                except StopIteration:
2495
 
                    disk_finished = True
2496
 
 
2497
 
    def _walkdirs(self, prefix=""):
2498
 
        """Walk the directories of this tree.
2499
 
 
2500
 
           :prefix: is used as the directrory to start with.
2501
 
           returns a generator which yields items in the form:
2502
 
                ((curren_directory_path, fileid),
2503
 
                 [(file1_path, file1_name, file1_kind, None, file1_id,
2504
 
                   file1_kind), ... ])
2505
 
        """
2506
 
        _directory = 'directory'
2507
 
        # get the root in the inventory
2508
 
        inv = self.inventory
2509
 
        top_id = inv.path2id(prefix)
2510
 
        if top_id is None:
2511
 
            pending = []
2512
 
        else:
2513
 
            pending = [(prefix, '', _directory, None, top_id, None)]
2514
 
        while pending:
2515
 
            dirblock = []
2516
 
            currentdir = pending.pop()
2517
 
            # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2518
 
            top_id = currentdir[4]
2519
 
            if currentdir[0]:
2520
 
                relroot = currentdir[0] + '/'
2521
 
            else:
2522
 
                relroot = ""
2523
 
            # FIXME: stash the node in pending
2524
 
            entry = inv[top_id]
2525
 
            if entry.kind == 'directory':
2526
 
                for name, child in entry.sorted_children():
2527
 
                    dirblock.append((relroot + name, name, child.kind, None,
2528
 
                        child.file_id, child.kind
2529
 
                        ))
2530
 
            yield (currentdir[0], entry.file_id), dirblock
2531
 
            # push the user specified dirs from dirblock
2532
 
            for dir in reversed(dirblock):
2533
 
                if dir[2] == _directory:
2534
 
                    pending.append(dir)
2535
 
 
2536
 
    @needs_tree_write_lock
2537
 
    def auto_resolve(self):
2538
 
        """Automatically resolve text conflicts according to contents.
2539
 
 
2540
 
        Only text conflicts are auto_resolvable. Files with no conflict markers
2541
 
        are considered 'resolved', because bzr always puts conflict markers
2542
 
        into files that have text conflicts.  The corresponding .THIS .BASE and
2543
 
        .OTHER files are deleted, as per 'resolve'.
2544
 
        :return: a tuple of ConflictLists: (un_resolved, resolved).
2545
 
        """
2546
 
        un_resolved = _mod_conflicts.ConflictList()
2547
 
        resolved = _mod_conflicts.ConflictList()
2548
 
        conflict_re = re.compile('^(<{7}|={7}|>{7})')
2549
 
        for conflict in self.conflicts():
2550
 
            if (conflict.typestring != 'text conflict' or
2551
 
                self.kind(conflict.file_id) != 'file'):
2552
 
                un_resolved.append(conflict)
2553
 
                continue
2554
 
            my_file = open(self.id2abspath(conflict.file_id), 'rb')
2555
 
            try:
2556
 
                for line in my_file:
2557
 
                    if conflict_re.search(line):
2558
 
                        un_resolved.append(conflict)
2559
 
                        break
2560
 
                else:
2561
 
                    resolved.append(conflict)
2562
 
            finally:
2563
 
                my_file.close()
2564
 
        resolved.remove_files(self)
2565
 
        self.set_conflicts(un_resolved)
2566
 
        return un_resolved, resolved
2567
 
 
2568
 
    @needs_read_lock
2569
 
    def _check(self, references):
2570
 
        """Check the tree for consistency.
2571
 
 
2572
 
        :param references: A dict with keys matching the items returned by
2573
 
            self._get_check_refs(), and values from looking those keys up in
2574
 
            the repository.
2575
 
        """
2576
 
        tree_basis = self.basis_tree()
2577
 
        tree_basis.lock_read()
2578
 
        try:
2579
 
            repo_basis = references[('trees', self.last_revision())]
2580
 
            if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2581
 
                raise errors.BzrCheckError(
2582
 
                    "Mismatched basis inventory content.")
2583
 
            self._validate()
2584
 
        finally:
2585
 
            tree_basis.unlock()
2586
 
 
2587
 
    def _validate(self):
2588
 
        """Validate internal structures.
2589
 
 
2590
 
        This is meant mostly for the test suite. To give it a chance to detect
2591
 
        corruption after actions have occurred. The default implementation is a
2592
 
        just a no-op.
2593
 
 
2594
 
        :return: None. An exception should be raised if there is an error.
2595
 
        """
2596
 
        return
2597
 
 
2598
 
    def _get_rules_searcher(self, default_searcher):
2599
 
        """See Tree._get_rules_searcher."""
2600
 
        if self._rules_searcher is None:
2601
 
            self._rules_searcher = super(WorkingTree,
2602
 
                self)._get_rules_searcher(default_searcher)
2603
 
        return self._rules_searcher
2604
 
 
2605
 
    def get_shelf_manager(self):
2606
 
        """Return the ShelfManager for this WorkingTree."""
2607
 
        from bzrlib.shelf import ShelfManager
2608
 
        return ShelfManager(self, self._transport)
2609
 
 
2610
1943
 
2611
1944
class WorkingTree2(WorkingTree):
2612
1945
    """This is the Format 2 working tree.
2613
1946
 
2614
 
    This was the first weave based working tree.
 
1947
    This was the first weave based working tree. 
2615
1948
     - uses os locks for locking.
2616
1949
     - uses the branch last-revision.
2617
1950
    """
2618
1951
 
2619
 
    def __init__(self, *args, **kwargs):
2620
 
        super(WorkingTree2, self).__init__(*args, **kwargs)
2621
 
        # WorkingTree2 has more of a constraint that self._inventory must
2622
 
        # exist. Because this is an older format, we don't mind the overhead
2623
 
        # caused by the extra computation here.
2624
 
 
2625
 
        # Newer WorkingTree's should only have self._inventory set when they
2626
 
        # have a read lock.
2627
 
        if self._inventory is None:
2628
 
            self.read_working_inventory()
2629
 
 
2630
 
    def _get_check_refs(self):
2631
 
        """Return the references needed to perform a check of this tree."""
2632
 
        return [('trees', self.last_revision())]
2633
 
 
2634
1952
    def lock_tree_write(self):
2635
1953
        """See WorkingTree.lock_tree_write().
2636
1954
 
2645
1963
            raise
2646
1964
 
2647
1965
    def unlock(self):
2648
 
        # do non-implementation specific cleanup
2649
 
        self._cleanup()
2650
 
 
2651
1966
        # we share control files:
2652
1967
        if self._control_files._lock_count == 3:
2653
1968
            # _inventory_is_modified is always False during a read lock.
2654
1969
            if self._inventory_is_modified:
2655
1970
                self.flush()
2656
1971
            self._write_hashcache_if_dirty()
2657
 
 
 
1972
                    
2658
1973
        # reverse order of locking.
2659
1974
        try:
2660
1975
            return self._control_files.unlock()
2676
1991
    def _last_revision(self):
2677
1992
        """See Mutable.last_revision."""
2678
1993
        try:
2679
 
            return self._transport.get_bytes('last-revision')
 
1994
            return osutils.safe_revision_id(
 
1995
                        self._control_files.get('last-revision').read())
2680
1996
        except errors.NoSuchFile:
2681
 
            return _mod_revision.NULL_REVISION
 
1997
            return None
2682
1998
 
2683
1999
    def _change_last_revision(self, revision_id):
2684
2000
        """See WorkingTree._change_last_revision."""
2685
 
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
 
2001
        if revision_id is None or revision_id == NULL_REVISION:
2686
2002
            try:
2687
 
                self._transport.delete('last-revision')
 
2003
                self._control_files._transport.delete('last-revision')
2688
2004
            except errors.NoSuchFile:
2689
2005
                pass
2690
2006
            return False
2691
2007
        else:
2692
 
            self._transport.put_bytes('last-revision', revision_id,
2693
 
                mode=self.bzrdir._get_file_mode())
 
2008
            self._control_files.put_bytes('last-revision', revision_id)
2694
2009
            return True
2695
2010
 
2696
 
    def _get_check_refs(self):
2697
 
        """Return the references needed to perform a check of this tree."""
2698
 
        return [('trees', self.last_revision())]
2699
 
 
2700
2011
    @needs_tree_write_lock
2701
2012
    def set_conflicts(self, conflicts):
2702
 
        self._put_rio('conflicts', conflicts.to_stanzas(),
 
2013
        self._put_rio('conflicts', conflicts.to_stanzas(), 
2703
2014
                      CONFLICT_HEADER_1)
2704
2015
 
2705
2016
    @needs_tree_write_lock
2712
2023
    @needs_read_lock
2713
2024
    def conflicts(self):
2714
2025
        try:
2715
 
            confile = self._transport.get('conflicts')
 
2026
            confile = self._control_files.get('conflicts')
2716
2027
        except errors.NoSuchFile:
2717
2028
            return _mod_conflicts.ConflictList()
2718
2029
        try:
2719
 
            try:
2720
 
                if confile.next() != CONFLICT_HEADER_1 + '\n':
2721
 
                    raise errors.ConflictFormatError()
2722
 
            except StopIteration:
 
2030
            if confile.next() != CONFLICT_HEADER_1 + '\n':
2723
2031
                raise errors.ConflictFormatError()
2724
 
            return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2725
 
        finally:
2726
 
            confile.close()
 
2032
        except StopIteration:
 
2033
            raise errors.ConflictFormatError()
 
2034
        return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2727
2035
 
2728
2036
    def unlock(self):
2729
 
        # do non-implementation specific cleanup
2730
 
        self._cleanup()
2731
2037
        if self._control_files._lock_count == 1:
2732
2038
            # _inventory_is_modified is always False during a read lock.
2733
2039
            if self._inventory_is_modified:
2745
2051
        if path.endswith(suffix):
2746
2052
            return path[:-len(suffix)]
2747
2053
 
 
2054
@deprecated_function(zero_eight)
 
2055
def is_control_file(filename):
 
2056
    """See WorkingTree.is_control_filename(filename)."""
 
2057
    ## FIXME: better check
 
2058
    filename = normpath(filename)
 
2059
    while filename != '':
 
2060
        head, tail = os.path.split(filename)
 
2061
        ## mutter('check %r for control file' % ((head, tail),))
 
2062
        if tail == '.bzr':
 
2063
            return True
 
2064
        if filename == head:
 
2065
            break
 
2066
        filename = head
 
2067
    return False
 
2068
 
2748
2069
 
2749
2070
class WorkingTreeFormat(object):
2750
2071
    """An encapsulation of the initialization and open routines for a format.
2754
2075
     * a format string,
2755
2076
     * an open routine.
2756
2077
 
2757
 
    Formats are placed in an dict by their format string for reference
 
2078
    Formats are placed in an dict by their format string for reference 
2758
2079
    during workingtree opening. Its not required that these be instances, they
2759
 
    can be classes themselves with class methods - it simply depends on
 
2080
    can be classes themselves with class methods - it simply depends on 
2760
2081
    whether state is needed for a given format or not.
2761
2082
 
2762
2083
    Once a format is deprecated, just deprecate the initialize and open
2763
 
    methods on the format class. Do not deprecate the object, as the
 
2084
    methods on the format class. Do not deprecate the object, as the 
2764
2085
    object will be created every time regardless.
2765
2086
    """
2766
2087
 
2770
2091
    _formats = {}
2771
2092
    """The known formats."""
2772
2093
 
2773
 
    requires_rich_root = False
2774
 
 
2775
 
    upgrade_recommended = False
2776
 
 
2777
2094
    @classmethod
2778
2095
    def find_format(klass, a_bzrdir):
2779
2096
        """Return the format for the working tree object in a_bzrdir."""
2780
2097
        try:
2781
2098
            transport = a_bzrdir.get_workingtree_transport(None)
2782
 
            format_string = transport.get_bytes("format")
 
2099
            format_string = transport.get("format").read()
2783
2100
            return klass._formats[format_string]
2784
2101
        except errors.NoSuchFile:
2785
2102
            raise errors.NoWorkingTree(base=transport.base)
2786
2103
        except KeyError:
2787
 
            raise errors.UnknownFormatError(format=format_string,
2788
 
                                            kind="working tree")
2789
 
 
2790
 
    def __eq__(self, other):
2791
 
        return self.__class__ is other.__class__
2792
 
 
2793
 
    def __ne__(self, other):
2794
 
        return not (self == other)
 
2104
            raise errors.UnknownFormatError(format=format_string)
2795
2105
 
2796
2106
    @classmethod
2797
2107
    def get_default_format(klass):
2810
2120
        """Is this format supported?
2811
2121
 
2812
2122
        Supported formats can be initialized and opened.
2813
 
        Unsupported formats may not support initialization or committing or
 
2123
        Unsupported formats may not support initialization or committing or 
2814
2124
        some other features depending on the reason for not being supported.
2815
2125
        """
2816
2126
        return True
2817
2127
 
2818
 
    def supports_content_filtering(self):
2819
 
        """True if this format supports content filtering."""
2820
 
        return False
2821
 
 
2822
 
    def supports_views(self):
2823
 
        """True if this format supports stored views."""
2824
 
        return False
2825
 
 
2826
2128
    @classmethod
2827
2129
    def register_format(klass, format):
2828
2130
        klass._formats[format.get_format_string()] = format
2833
2135
 
2834
2136
    @classmethod
2835
2137
    def unregister_format(klass, format):
 
2138
        assert klass._formats[format.get_format_string()] is format
2836
2139
        del klass._formats[format.get_format_string()]
2837
2140
 
2838
2141
 
 
2142
 
2839
2143
class WorkingTreeFormat2(WorkingTreeFormat):
2840
 
    """The second working tree format.
 
2144
    """The second working tree format. 
2841
2145
 
2842
2146
    This format modified the hash cache from the format 1 hash cache.
2843
2147
    """
2844
2148
 
2845
 
    upgrade_recommended = True
2846
 
 
2847
2149
    def get_format_description(self):
2848
2150
        """See WorkingTreeFormat.get_format_description()."""
2849
2151
        return "Working tree format 2"
2850
2152
 
2851
 
    def _stub_initialize_on_transport(self, transport, file_mode):
2852
 
        """Workaround: create control files for a remote working tree.
2853
 
 
 
2153
    def stub_initialize_remote(self, control_files):
 
2154
        """As a special workaround create critical control files for a remote working tree
 
2155
        
2854
2156
        This ensures that it can later be updated and dealt with locally,
2855
 
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
 
2157
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with 
2856
2158
        no working tree.  (See bug #43064).
2857
2159
        """
2858
2160
        sio = StringIO()
2859
 
        inv = inventory.Inventory()
2860
 
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
 
2161
        inv = Inventory()
 
2162
        xml5.serializer_v5.write_inventory(inv, sio)
2861
2163
        sio.seek(0)
2862
 
        transport.put_file('inventory', sio, file_mode)
2863
 
        transport.put_bytes('pending-merges', '', file_mode)
2864
 
 
2865
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2866
 
                   accelerator_tree=None, hardlink=False):
 
2164
        control_files.put('inventory', sio)
 
2165
 
 
2166
        control_files.put_bytes('pending-merges', '')
 
2167
        
 
2168
 
 
2169
    def initialize(self, a_bzrdir, revision_id=None):
2867
2170
        """See WorkingTreeFormat.initialize()."""
2868
2171
        if not isinstance(a_bzrdir.transport, LocalTransport):
2869
2172
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2870
 
        if from_branch is not None:
2871
 
            branch = from_branch
2872
 
        else:
2873
 
            branch = a_bzrdir.open_branch()
2874
 
        if revision_id is None:
2875
 
            revision_id = _mod_revision.ensure_null(branch.last_revision())
2876
 
        branch.lock_write()
2877
 
        try:
2878
 
            branch.generate_revision_history(revision_id)
2879
 
        finally:
2880
 
            branch.unlock()
2881
 
        inv = inventory.Inventory()
 
2173
        branch = a_bzrdir.open_branch()
 
2174
        if revision_id is not None:
 
2175
            revision_id = osutils.safe_revision_id(revision_id)
 
2176
            branch.lock_write()
 
2177
            try:
 
2178
                revision_history = branch.revision_history()
 
2179
                try:
 
2180
                    position = revision_history.index(revision_id)
 
2181
                except ValueError:
 
2182
                    raise errors.NoSuchRevision(branch, revision_id)
 
2183
                branch.set_revision_history(revision_history[:position + 1])
 
2184
            finally:
 
2185
                branch.unlock()
 
2186
        revision = branch.last_revision()
 
2187
        inv = Inventory()
2882
2188
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2883
2189
                         branch,
2884
2190
                         inv,
2885
2191
                         _internal=True,
2886
2192
                         _format=self,
2887
2193
                         _bzrdir=a_bzrdir)
2888
 
        basis_tree = branch.repository.revision_tree(revision_id)
 
2194
        basis_tree = branch.repository.revision_tree(revision)
2889
2195
        if basis_tree.inventory.root is not None:
2890
 
            wt.set_root_id(basis_tree.get_root_id())
 
2196
            wt.set_root_id(basis_tree.inventory.root.file_id)
2891
2197
        # set the parent list and cache the basis tree.
2892
 
        if _mod_revision.is_null(revision_id):
2893
 
            parent_trees = []
2894
 
        else:
2895
 
            parent_trees = [(revision_id, basis_tree)]
2896
 
        wt.set_parent_trees(parent_trees)
 
2198
        wt.set_parent_trees([(revision, basis_tree)])
2897
2199
        transform.build_tree(basis_tree, wt)
2898
2200
        return wt
2899
2201
 
2912
2214
            raise NotImplementedError
2913
2215
        if not isinstance(a_bzrdir.transport, LocalTransport):
2914
2216
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2915
 
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
 
2217
        return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2916
2218
                           _internal=True,
2917
2219
                           _format=self,
2918
2220
                           _bzrdir=a_bzrdir)
2919
 
        return wt
 
2221
 
2920
2222
 
2921
2223
class WorkingTreeFormat3(WorkingTreeFormat):
2922
2224
    """The second working tree format updated to record a format marker.
2930
2232
        - uses a LockDir to guard access for writes.
2931
2233
    """
2932
2234
 
2933
 
    upgrade_recommended = True
2934
 
 
2935
2235
    def get_format_string(self):
2936
2236
        """See WorkingTreeFormat.get_format_string()."""
2937
2237
        return "Bazaar-NG Working Tree format 3"
2943
2243
    _lock_file_name = 'lock'
2944
2244
    _lock_class = LockDir
2945
2245
 
2946
 
    _tree_class = WorkingTree3
2947
 
 
2948
 
    def __get_matchingbzrdir(self):
2949
 
        return bzrdir.BzrDirMetaFormat1()
2950
 
 
2951
 
    _matchingbzrdir = property(__get_matchingbzrdir)
2952
 
 
2953
2246
    def _open_control_files(self, a_bzrdir):
2954
2247
        transport = a_bzrdir.get_workingtree_transport(None)
2955
 
        return LockableFiles(transport, self._lock_file_name,
 
2248
        return LockableFiles(transport, self._lock_file_name, 
2956
2249
                             self._lock_class)
2957
2250
 
2958
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2959
 
                   accelerator_tree=None, hardlink=False):
 
2251
    def initialize(self, a_bzrdir, revision_id=None):
2960
2252
        """See WorkingTreeFormat.initialize().
2961
 
 
2962
 
        :param revision_id: if supplied, create a working tree at a different
2963
 
            revision than the branch is at.
2964
 
        :param accelerator_tree: A tree which can be used for retrieving file
2965
 
            contents more quickly than the revision tree, i.e. a workingtree.
2966
 
            The revision tree will be used for cases where accelerator_tree's
2967
 
            content is different.
2968
 
        :param hardlink: If true, hard-link files from accelerator_tree,
2969
 
            where possible.
 
2253
        
 
2254
        revision_id allows creating a working tree at a different
 
2255
        revision than the branch is at.
2970
2256
        """
2971
2257
        if not isinstance(a_bzrdir.transport, LocalTransport):
2972
2258
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2974
2260
        control_files = self._open_control_files(a_bzrdir)
2975
2261
        control_files.create_lock()
2976
2262
        control_files.lock_write()
2977
 
        transport.put_bytes('format', self.get_format_string(),
2978
 
            mode=a_bzrdir._get_file_mode())
2979
 
        if from_branch is not None:
2980
 
            branch = from_branch
 
2263
        control_files.put_utf8('format', self.get_format_string())
 
2264
        branch = a_bzrdir.open_branch()
 
2265
        if revision_id is None:
 
2266
            revision_id = branch.last_revision()
2981
2267
        else:
2982
 
            branch = a_bzrdir.open_branch()
2983
 
        if revision_id is None:
2984
 
            revision_id = _mod_revision.ensure_null(branch.last_revision())
 
2268
            revision_id = osutils.safe_revision_id(revision_id)
2985
2269
        # WorkingTree3 can handle an inventory which has a unique root id.
2986
2270
        # as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2987
2271
        # those trees. And because there isn't a format bump inbetween, we
2988
2272
        # are maintaining compatibility with older clients.
2989
2273
        # inv = Inventory(root_id=gen_root_id())
2990
 
        inv = self._initial_inventory()
2991
 
        wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
 
2274
        inv = Inventory()
 
2275
        wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2992
2276
                         branch,
2993
2277
                         inv,
2994
2278
                         _internal=True,
3000
2284
            basis_tree = branch.repository.revision_tree(revision_id)
3001
2285
            # only set an explicit root id if there is one to set.
3002
2286
            if basis_tree.inventory.root is not None:
3003
 
                wt.set_root_id(basis_tree.get_root_id())
3004
 
            if revision_id == _mod_revision.NULL_REVISION:
 
2287
                wt.set_root_id(basis_tree.inventory.root.file_id)
 
2288
            if revision_id == NULL_REVISION:
3005
2289
                wt.set_parent_trees([])
3006
2290
            else:
3007
2291
                wt.set_parent_trees([(revision_id, basis_tree)])
3013
2297
            wt.unlock()
3014
2298
        return wt
3015
2299
 
3016
 
    def _initial_inventory(self):
3017
 
        return inventory.Inventory()
3018
 
 
3019
2300
    def __init__(self):
3020
2301
        super(WorkingTreeFormat3, self).__init__()
 
2302
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
3021
2303
 
3022
2304
    def open(self, a_bzrdir, _found=False):
3023
2305
        """Return the WorkingTree object for a_bzrdir
3030
2312
            raise NotImplementedError
3031
2313
        if not isinstance(a_bzrdir.transport, LocalTransport):
3032
2314
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
3033
 
        wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3034
 
        return wt
 
2315
        return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3035
2316
 
3036
2317
    def _open(self, a_bzrdir, control_files):
3037
2318
        """Open the tree itself.
3038
 
 
 
2319
        
3039
2320
        :param a_bzrdir: the dir for the tree.
3040
2321
        :param control_files: the control files for the tree.
3041
2322
        """
3042
 
        return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3043
 
                                _internal=True,
3044
 
                                _format=self,
3045
 
                                _bzrdir=a_bzrdir,
3046
 
                                _control_files=control_files)
 
2323
        return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
 
2324
                           _internal=True,
 
2325
                           _format=self,
 
2326
                           _bzrdir=a_bzrdir,
 
2327
                           _control_files=control_files)
3047
2328
 
3048
2329
    def __str__(self):
3049
2330
        return self.get_format_string()
3050
2331
 
3051
2332
 
3052
 
__default_format = WorkingTreeFormat6()
 
2333
# formats which have no format string are not discoverable
 
2334
# and not independently creatable, so are not registered.
 
2335
__default_format = WorkingTreeFormat3()
3053
2336
WorkingTreeFormat.register_format(__default_format)
3054
 
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3055
 
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3056
 
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3057
2337
WorkingTreeFormat.set_default_format(__default_format)
3058
 
# formats which have no format string are not discoverable
3059
 
# and not independently creatable, so are not registered.
3060
2338
_legacy_formats = [WorkingTreeFormat2(),
3061
2339
                   ]
 
2340
 
 
2341
 
 
2342
class WorkingTreeTestProviderAdapter(object):
 
2343
    """A tool to generate a suite testing multiple workingtree formats at once.
 
2344
 
 
2345
    This is done by copying the test once for each transport and injecting
 
2346
    the transport_server, transport_readonly_server, and workingtree_format
 
2347
    classes into each copy. Each copy is also given a new id() to make it
 
2348
    easy to identify.
 
2349
    """
 
2350
 
 
2351
    def __init__(self, transport_server, transport_readonly_server, formats):
 
2352
        self._transport_server = transport_server
 
2353
        self._transport_readonly_server = transport_readonly_server
 
2354
        self._formats = formats
 
2355
    
 
2356
    def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
 
2357
        """Clone test for adaption."""
 
2358
        new_test = deepcopy(test)
 
2359
        new_test.transport_server = self._transport_server
 
2360
        new_test.transport_readonly_server = self._transport_readonly_server
 
2361
        new_test.bzrdir_format = bzrdir_format
 
2362
        new_test.workingtree_format = workingtree_format
 
2363
        def make_new_test_id():
 
2364
            new_id = "%s(%s)" % (test.id(), variation)
 
2365
            return lambda: new_id
 
2366
        new_test.id = make_new_test_id()
 
2367
        return new_test
 
2368
    
 
2369
    def adapt(self, test):
 
2370
        from bzrlib.tests import TestSuite
 
2371
        result = TestSuite()
 
2372
        for workingtree_format, bzrdir_format in self._formats:
 
2373
            new_test = self._clone_test(
 
2374
                test,
 
2375
                bzrdir_format,
 
2376
                workingtree_format, workingtree_format.__class__.__name__)
 
2377
            result.addTest(new_test)
 
2378
        return result