~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Vincent Ladeuil
  • Date: 2010-02-05 10:27:33 UTC
  • mto: (5008.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5009.
  • Revision ID: v.ladeuil+lp@free.fr-20100205102733-8wpjnqz6g4nvrbfu
All Conflict action method names start with 'action_' to avoid potential namespace collisions

Show diffs side-by-side

added added

removed removed

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