/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-05-27 01:58:44 UTC
  • mfrom: (5193.4.24 gio-transport)
  • Revision ID: pqm@pqm.ubuntu.com-20100527015844-ya4jahnwjx5y8ej2
(lifeless) Add a gio based transport using gio+ as a prefix to get at the
 gio logic. (Mattias Eriksson)

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