/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: John Arbash Meinel
  • Date: 2006-10-06 05:53:44 UTC
  • mfrom: (2063 +trunk)
  • mto: This revision was merged to the branch mainline in revision 2071.
  • Revision ID: john@arbash-meinel.com-20061006055344-e73b97b7c6ca6e72
[merge] bzr.dev 2063

Show diffs side-by-side

added added

removed removed

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