~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Aaron Bentley
  • Date: 2007-01-16 13:12:54 UTC
  • mto: (2230.3.47 branch6)
  • mto: This revision was merged to the branch mainline in revision 2290.
  • Revision ID: aaron.bentley@utoronto.ca-20070116131254-sjruli93timappd4
work in progress bind stuff

Show diffs side-by-side

added added

removed removed

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