~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Aaron Bentley
  • Date: 2006-06-21 14:30:57 UTC
  • mfrom: (1801.1.1 bzr.dev)
  • mto: This revision was merged to the branch mainline in revision 1803.
  • Revision ID: abentley@panoramicfeedback.com-20060621143057-776e4b8d707e430e
Install benchmarks. (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

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