/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: Canonical.com Patch Queue Manager
  • Date: 2010-07-03 00:00:54 UTC
  • mfrom: (5325.2.1 doc)
  • Revision ID: pqm@pqm.ubuntu.com-20100703000054-331rh98r3u7s211l
(jameinel) a couple of doc cleanups about the ppa (Martin Pool)

Show diffs side-by-side

added added

removed removed

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