/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

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