~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-07-12 12:36:57 UTC
  • mfrom: (1732.3.4 bzr.revnoX)
  • Revision ID: pqm@pqm.ubuntu.com-20060712123657-365eeb32b69308bf
(matthieu) revno:x:url revision spec

Show diffs side-by-side

added added

removed removed

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