~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Robert Collins
  • Date: 2006-07-20 13:00:31 UTC
  • mto: (1852.9.1 Tree.compare().)
  • mto: This revision was merged to the branch mainline in revision 1890.
  • Revision ID: robertc@robertcollins.net-20060720130031-d26103a427ea10f3
StartĀ treeĀ implementationĀ tests.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
2
 
#
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
2
 
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
#
 
7
 
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
#
 
12
 
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""WorkingTree object and friends.
18
18
 
19
19
A WorkingTree represents the editable working copy of a branch.
20
 
Operations which represent the WorkingTree are also done here,
21
 
such as renaming or adding files.  The WorkingTree has an inventory
22
 
which is updated by these operations.  A commit produces a
 
20
Operations which represent the WorkingTree are also done here, 
 
21
such as renaming or adding files.  The WorkingTree has an inventory 
 
22
which is updated by these operations.  A commit produces a 
23
23
new revision based on the workingtree and its inventory.
24
24
 
25
25
At the moment every WorkingTree has its own branch.  Remote
29
29
WorkingTree.open(dir).
30
30
"""
31
31
 
 
32
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
 
33
CONFLICT_HEADER_1 = "BZR conflict list format 1"
 
34
 
32
35
# TODO: Give the workingtree sole responsibility for the working inventory;
33
36
# remove the variable and references to it from the branch.  This may require
34
37
# updating the commit code so as to update the inventory within the working
36
39
# At the moment they may alias the inventory and have old copies of it in
37
40
# memory.  (Now done? -- mbp 20060309)
38
41
 
 
42
from binascii import hexlify
 
43
import collections
 
44
from copy import deepcopy
39
45
from cStringIO import StringIO
 
46
import errno
 
47
import fnmatch
40
48
import os
41
 
import sys
42
 
 
43
 
from bzrlib.lazy_import import lazy_import
44
 
lazy_import(globals(), """
45
 
from bisect import bisect_left
46
 
import collections
47
 
import errno
48
 
import itertools
49
 
import operator
 
49
import re
50
50
import stat
51
 
import re
 
51
from time import time
 
52
import warnings
52
53
 
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
 
    )
 
54
from bzrlib import bzrdir, errors, osutils, urlutils
 
55
from bzrlib.atomicfile import AtomicFile
75
56
import bzrlib.branch
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
 
57
from bzrlib.conflicts import Conflict, ConflictList, CONFLICT_SUFFIXES
85
58
from bzrlib.decorators import needs_read_lock, needs_write_lock
86
 
from bzrlib.lockable_files import LockableFiles
 
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
87
71
from bzrlib.lockdir import LockDir
88
 
import bzrlib.mutabletree
89
 
from bzrlib.mutabletree import needs_tree_write_lock
90
 
from bzrlib import osutils
 
72
from bzrlib.merge import merge_inner, transform_tree
91
73
from bzrlib.osutils import (
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
 
74
                            abspath,
 
75
                            compact_date,
 
76
                            file_kind,
 
77
                            isdir,
 
78
                            getcwd,
 
79
                            pathjoin,
 
80
                            pumpfile,
 
81
                            safe_unicode,
 
82
                            splitpath,
 
83
                            rand_chars,
 
84
                            normpath,
 
85
                            realpath,
 
86
                            relpath,
 
87
                            rename,
 
88
                            supports_executable,
 
89
                            )
 
90
from bzrlib.progress import DummyProgress, ProgressPhase
 
91
from bzrlib.revision import NULL_REVISION
 
92
from bzrlib.rio import RioReader, rio_file, Stanza
 
93
from bzrlib.symbol_versioning import (deprecated_passed,
 
94
        deprecated_method,
 
95
        deprecated_function,
 
96
        DEPRECATED_PARAMETER,
 
97
        zero_eight,
 
98
        )
102
99
from bzrlib.trace import mutter, note
 
100
from bzrlib.transform import build_tree
 
101
from bzrlib.transport import get_transport
103
102
from bzrlib.transport.local import LocalTransport
104
 
from bzrlib.progress import DummyProgress, ProgressPhase
105
 
from bzrlib.revision import CURRENT_REVISION
106
 
from bzrlib.rio import RioReader, rio_file, Stanza
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
 
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')
120
151
 
121
152
 
122
153
class TreeEntry(object):
123
154
    """An entry that implements the minimum interface used by commands.
124
155
 
125
 
    This needs further inspection, it may be better to have
 
156
    This needs further inspection, it may be better to have 
126
157
    InventoryEntries without ids - though that seems wrong. For now,
127
158
    this is a parallel hierarchy to InventoryEntry, and needs to become
128
159
    one of several things: decorates to that hierarchy, children of, or
131
162
    no InventoryEntry available - i.e. for unversioned objects.
132
163
    Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
133
164
    """
134
 
 
 
165
 
135
166
    def __eq__(self, other):
136
167
        # yes, this us ugly, TODO: best practice __eq__ style.
137
168
        return (isinstance(other, TreeEntry)
138
169
                and other.__class__ == self.__class__)
139
 
 
 
170
 
140
171
    def kind_character(self):
141
172
        return "???"
142
173
 
174
205
        return ''
175
206
 
176
207
 
177
 
class WorkingTree(bzrlib.mutabletree.MutableTree):
 
208
class WorkingTree(bzrlib.tree.Tree):
178
209
    """Working copy tree.
179
210
 
180
211
    The inventory is held in the `Branch` working-inventory, and the
184
215
    not listed in the Inventory and vice versa.
185
216
    """
186
217
 
187
 
    # override this to set the strategy for storing views
188
 
    def _make_views(self):
189
 
        return views.DisabledViews(self)
190
 
 
191
218
    def __init__(self, basedir='.',
192
219
                 branch=DEPRECATED_PARAMETER,
193
220
                 _inventory=None,
195
222
                 _internal=False,
196
223
                 _format=None,
197
224
                 _bzrdir=None):
198
 
        """Construct a WorkingTree instance. This is not a public API.
 
225
        """Construct a WorkingTree for basedir.
199
226
 
200
 
        :param branch: A branch to override probing for the branch.
 
227
        If the branch is not supplied, it is opened automatically.
 
228
        If the branch is supplied, it must be the branch for this basedir.
 
229
        (branch.base is not cross checked, because for remote branches that
 
230
        would be meaningless).
201
231
        """
202
232
        self._format = _format
203
233
        self.bzrdir = _bzrdir
204
234
        if not _internal:
205
 
            raise errors.BzrError("Please use bzrdir.open_workingtree or "
206
 
                "WorkingTree.open() to obtain a WorkingTree.")
 
235
            # not created via open etc.
 
236
            warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
 
237
                 "Please use bzrdir.open_workingtree or WorkingTree.open().",
 
238
                 DeprecationWarning,
 
239
                 stacklevel=2)
 
240
            wt = WorkingTree.open(basedir)
 
241
            self._branch = wt.branch
 
242
            self.basedir = wt.basedir
 
243
            self._control_files = wt._control_files
 
244
            self._hashcache = wt._hashcache
 
245
            self._set_inventory(wt._inventory)
 
246
            self._format = wt._format
 
247
            self.bzrdir = wt.bzrdir
 
248
        from bzrlib.hashcache import HashCache
 
249
        from bzrlib.trace import note, mutter
 
250
        assert isinstance(basedir, basestring), \
 
251
            "base directory %r is not a string" % basedir
207
252
        basedir = safe_unicode(basedir)
208
253
        mutter("opening working tree %r", basedir)
209
254
        if deprecated_passed(branch):
 
255
            if not _internal:
 
256
                warnings.warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
 
257
                     " Please use bzrdir.open_workingtree() or"
 
258
                     " WorkingTree.open().",
 
259
                     DeprecationWarning,
 
260
                     stacklevel=2
 
261
                     )
210
262
            self._branch = branch
211
263
        else:
212
264
            self._branch = self.bzrdir.open_branch()
217
269
            self._control_files = self.branch.control_files
218
270
        else:
219
271
            # 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
220
275
            self._control_files = _control_files
221
 
        self._transport = self._control_files._transport
222
276
        # update the whole cache up front and write to disk if anything changed;
223
277
        # in the future we might want to do this more selectively
224
278
        # two possible ways offer themselves : in self._unlock, write the cache
225
279
        # if needed, or, when the cache sees a change, append it to the hash
226
280
        # cache file, and have the parser take the most recent entry for a
227
281
        # given path only.
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
 
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)
234
284
        hc.read()
235
285
        # is this scan needed ? it makes things kinda slow.
236
286
        #hc.scan()
240
290
            hc.write()
241
291
 
242
292
        if _inventory is None:
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()
 
293
            self._set_inventory(self.read_working_inventory())
 
294
        else:
 
295
            self._set_inventory(_inventory)
266
296
 
267
297
    branch = property(
268
298
        fget=lambda self: self._branch,
283
313
        self._control_files.break_lock()
284
314
        self.branch.break_lock()
285
315
 
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
 
        """
 
316
    def _set_inventory(self, inv):
318
317
        self._inventory = inv
319
 
        self._inventory_is_modified = dirty
 
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)
320
331
 
321
332
    @staticmethod
322
333
    def open(path=None, _unsupported=False):
324
335
 
325
336
        """
326
337
        if path is None:
327
 
            path = osutils.getcwd()
 
338
            path = os.path.getcwdu()
328
339
        control = bzrdir.BzrDir.open(path, _unsupported)
329
340
        return control.open_workingtree(_unsupported)
330
 
 
 
341
        
331
342
    @staticmethod
332
343
    def open_containing(path=None):
333
344
        """Open an existing working tree which has its root about path.
334
 
 
 
345
        
335
346
        This probes for a working tree at path and searches upwards from there.
336
347
 
337
348
        Basically we keep looking up until we find the control directory or
355
366
        """
356
367
        return WorkingTree.open(path, _unsupported=True)
357
368
 
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)
377
369
    def __iter__(self):
378
370
        """Iterate through file_ids for this tree.
379
371
 
382
374
        """
383
375
        inv = self._inventory
384
376
        for path, ie in inv.iter_entries():
385
 
            if osutils.lexists(self.abspath(path)):
 
377
            if bzrlib.osutils.lexists(self.abspath(path)):
386
378
                yield ie.file_id
387
379
 
388
 
    def all_file_ids(self):
389
 
        """See Tree.iter_all_file_ids"""
390
 
        return set(self.inventory)
391
 
 
392
380
    def __repr__(self):
393
381
        return "<%s of %s>" % (self.__class__.__name__,
394
382
                               getattr(self, 'basedir', None))
395
383
 
396
384
    def abspath(self, filename):
397
385
        return pathjoin(self.basedir, filename)
398
 
 
 
386
    
399
387
    def basis_tree(self):
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()
 
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)
435
439
 
436
440
    def relpath(self, path):
437
441
        """Return the local path portion from a given path.
438
 
 
439
 
        The path may be absolute or relative. If its a relative path it is
 
442
        
 
443
        The path may be absolute or relative. If its a relative path it is 
440
444
        interpreted relative to the python current working directory.
441
445
        """
442
 
        return osutils.relpath(self.basedir, path)
 
446
        return relpath(self.basedir, path)
443
447
 
444
448
    def has_filename(self, filename):
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
 
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')
536
456
 
537
457
    def get_parent_ids(self):
538
458
        """See Tree.get_parent_ids.
539
 
 
 
459
        
540
460
        This implementation reads the pending merges list and last_revision
541
461
        value and uses that to decide what the parents list should be.
542
462
        """
543
 
        last_rev = _mod_revision.ensure_null(self._last_revision())
544
 
        if _mod_revision.NULL_REVISION == last_rev:
 
463
        last_rev = self.last_revision()
 
464
        if last_rev is None:
545
465
            parents = []
546
466
        else:
547
467
            parents = [last_rev]
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
 
468
        other_parents = self.pending_merges()
 
469
        return parents + other_parents
557
470
 
558
 
    @needs_read_lock
559
471
    def get_root_id(self):
560
472
        """Return the id of this trees root"""
561
 
        return self._inventory.root.file_id
562
 
 
 
473
        inv = self.read_working_inventory()
 
474
        return inv.root.file_id
 
475
        
563
476
    def _get_store_filename(self, file_id):
564
477
        ## XXX: badly named; this is not in the store at all
565
478
        return self.abspath(self.id2path(file_id))
566
479
 
567
480
    @needs_read_lock
568
 
    def clone(self, to_bzrdir, revision_id=None):
 
481
    def clone(self, to_bzrdir, revision_id=None, basis=None):
569
482
        """Duplicate this working tree into to_bzr, including all state.
570
 
 
 
483
        
571
484
        Specifically modified files are kept as modified, but
572
485
        ignored and unknown files are discarded.
573
486
 
574
487
        If you want to make a new line of development, see bzrdir.sprout()
575
488
 
576
489
        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
 
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
579
492
            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.
580
497
        """
581
498
        # assumes the target bzr dir format is compatible.
582
 
        result = to_bzrdir.create_workingtree()
 
499
        result = self._format.initialize(to_bzrdir)
583
500
        self.copy_content_into(result, revision_id)
584
501
        return result
585
502
 
586
503
    @needs_read_lock
587
504
    def copy_content_into(self, tree, revision_id=None):
588
505
        """Copy the current content and user files of this tree into tree."""
589
 
        tree.set_root_id(self.get_root_id())
590
506
        if revision_id is None:
591
 
            merge.transform_tree(tree, self)
 
507
            transform_tree(tree, self)
592
508
        else:
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])
 
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
597
529
 
598
530
    def id2abspath(self, file_id):
599
531
        return self.abspath(self.id2path(file_id))
600
532
 
601
533
    def has_id(self, file_id):
602
534
        # files that have been deleted are excluded
603
 
        inv = self.inventory
 
535
        inv = self._inventory
604
536
        if not inv.has_id(file_id):
605
537
            return False
606
538
        path = inv.id2path(file_id)
607
 
        return osutils.lexists(self.abspath(path))
 
539
        return bzrlib.osutils.lexists(self.abspath(path))
608
540
 
609
541
    def has_or_had_id(self, file_id):
610
542
        if file_id == self.inventory.root.file_id:
614
546
    __contains__ = has_id
615
547
 
616
548
    def get_file_size(self, 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
 
549
        return os.path.getsize(self.id2abspath(file_id))
627
550
 
628
551
    @needs_read_lock
629
 
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
552
    def get_file_sha1(self, file_id, path=None):
630
553
        if not path:
631
554
            path = self._inventory.id2path(file_id)
632
 
        return self._hashcache.get_sha1(path, stat_value)
 
555
        return self._hashcache.get_sha1(path)
633
556
 
634
557
    def get_file_mtime(self, file_id, path=None):
635
558
        if not path:
636
 
            path = self.inventory.id2path(file_id)
 
559
            path = self._inventory.id2path(file_id)
637
560
        return os.lstat(self.abspath(path)).st_mtime
638
561
 
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
 
 
651
562
    if not supports_executable():
652
563
        def is_executable(self, file_id, path=None):
653
564
            return self._inventory[file_id].executable
654
 
 
655
 
        _is_executable_from_path_and_stat = \
656
 
            _is_executable_from_path_and_stat_from_basis
657
565
    else:
658
566
        def is_executable(self, file_id, path=None):
659
567
            if not path:
660
 
                path = self.id2path(file_id)
 
568
                path = self._inventory.id2path(file_id)
661
569
            mode = os.lstat(self.abspath(path)).st_mode
662
570
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
663
571
 
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."""
 
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
        """
670
595
        # TODO: Re-adding a file that is removed in the working copy
671
596
        # should probably put it back with the previous ID.
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):
 
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)
676
626
            if file_id is None:
677
627
                inv.add_path(f, kind=kind)
678
628
            else:
679
629
                inv.add_path(f, kind=kind, file_id=file_id)
680
 
            self._inventory_is_modified = True
681
630
 
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)
 
631
        self._write_inventory(inv)
693
632
 
694
633
    @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
733
634
    def add_pending_merge(self, *revision_ids):
734
635
        # TODO: Perhaps should check at this point that the
735
636
        # history of the revision is actually present?
736
 
        parents = self.get_parent_ids()
 
637
        p = self.pending_merges()
737
638
        updated = False
738
639
        for rev_id in revision_ids:
739
 
            if rev_id in parents:
 
640
            if rev_id in p:
740
641
                continue
741
 
            parents.append(rev_id)
 
642
            p.append(rev_id)
742
643
            updated = True
743
644
        if updated:
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)
 
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
        """
750
654
        try:
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
 
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
874
664
    def set_pending_merges(self, 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)
 
665
        self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
879
666
 
880
 
    @needs_tree_write_lock
 
667
    @needs_write_lock
881
668
    def set_merge_modified(self, modified_hashes):
882
669
        def iter_stanzas():
883
670
            for file_id, hash in modified_hashes.iteritems():
884
 
                yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
 
671
                yield Stanza(file_id=file_id, hash=hash)
885
672
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
886
673
 
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
 
 
 
674
    @needs_write_lock
897
675
    def _put_rio(self, filename, stanzas, header):
898
 
        self._must_be_locked()
899
676
        my_file = rio_file(stanzas, header)
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
 
677
        self._control_files.put(filename, my_file)
953
678
 
954
679
    @needs_read_lock
955
680
    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
 
        """
965
681
        try:
966
 
            hashfile = self._transport.get('merge-hashes')
967
 
        except errors.NoSuchFile:
 
682
            hashfile = self._control_files.get('merge-hashes')
 
683
        except NoSuchFile:
968
684
            return {}
 
685
        merge_hashes = {}
969
686
        try:
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
 
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
996
699
 
997
700
    def get_symlink_target(self, file_id):
998
 
        abspath = self.id2abspath(file_id)
999
 
        target = osutils.readlink(abspath)
1000
 
        return target
1001
 
 
1002
 
    @needs_write_lock
1003
 
    def subsume(self, other_tree):
1004
 
        def add_children(inventory, entry):
1005
 
            for child_entry in entry.children.values():
1006
 
                inventory._byid[child_entry.file_id] = child_entry
1007
 
                if child_entry.kind == 'directory':
1008
 
                    add_children(inventory, child_entry)
1009
 
        if other_tree.get_root_id() == self.get_root_id():
1010
 
            raise errors.BadSubsumeSource(self, other_tree,
1011
 
                                          'Trees have the same root')
1012
 
        try:
1013
 
            other_tree_path = self.relpath(other_tree.basedir)
1014
 
        except errors.PathNotChild:
1015
 
            raise errors.BadSubsumeSource(self, other_tree,
1016
 
                'Tree is not contained by the other')
1017
 
        new_root_parent = self.path2id(osutils.dirname(other_tree_path))
1018
 
        if new_root_parent is None:
1019
 
            raise errors.BadSubsumeSource(self, other_tree,
1020
 
                'Parent directory is not versioned.')
1021
 
        # We need to ensure that the result of a fetch will have a
1022
 
        # versionedfile for the other_tree root, and only fetching into
1023
 
        # RepositoryKnit2 guarantees that.
1024
 
        if not self.branch.repository.supports_rich_root():
1025
 
            raise errors.SubsumeTargetNeedsUpgrade(other_tree)
1026
 
        other_tree.lock_tree_write()
1027
 
        try:
1028
 
            new_parents = other_tree.get_parent_ids()
1029
 
            other_root = other_tree.inventory.root
1030
 
            other_root.parent_id = new_root_parent
1031
 
            other_root.name = osutils.basename(other_tree_path)
1032
 
            self.inventory.add(other_root)
1033
 
            add_children(self.inventory, other_root)
1034
 
            self._write_inventory(self.inventory)
1035
 
            # normally we don't want to fetch whole repositories, but i think
1036
 
            # here we really do want to consolidate the whole thing.
1037
 
            for parent_id in other_tree.get_parent_ids():
1038
 
                self.branch.fetch(other_tree.branch, parent_id)
1039
 
                self.add_parent_tree_id(parent_id)
1040
 
        finally:
1041
 
            other_tree.unlock()
1042
 
        other_tree.bzrdir.retire_bzrdir()
1043
 
 
1044
 
    def _setup_directory_is_tree_reference(self):
1045
 
        if self._branch.repository._format.supports_tree_reference:
1046
 
            self._directory_is_tree_reference = \
1047
 
                self._directory_may_be_tree_reference
1048
 
        else:
1049
 
            self._directory_is_tree_reference = \
1050
 
                self._directory_is_never_tree_reference
1051
 
 
1052
 
    def _directory_is_never_tree_reference(self, relpath):
1053
 
        return False
1054
 
 
1055
 
    def _directory_may_be_tree_reference(self, relpath):
1056
 
        # as a special case, if a directory contains control files then
1057
 
        # it's a tree reference, except that the root of the tree is not
1058
 
        return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1059
 
        # TODO: We could ask all the control formats whether they
1060
 
        # recognize this directory, but at the moment there's no cheap api
1061
 
        # to do that.  Since we probably can only nest bzr checkouts and
1062
 
        # they always use this name it's ok for now.  -- mbp 20060306
1063
 
        #
1064
 
        # FIXME: There is an unhandled case here of a subdirectory
1065
 
        # containing .bzr but not a branch; that will probably blow up
1066
 
        # when you try to commit it.  It might happen if there is a
1067
 
        # checkout in a subdirectory.  This can be avoided by not adding
1068
 
        # it.  mbp 20070306
1069
 
 
1070
 
    @needs_tree_write_lock
1071
 
    def extract(self, file_id, format=None):
1072
 
        """Extract a subtree from this tree.
1073
 
 
1074
 
        A new branch will be created, relative to the path for this tree.
1075
 
        """
1076
 
        self.flush()
1077
 
        def mkdirs(path):
1078
 
            segments = osutils.splitpath(path)
1079
 
            transport = self.branch.bzrdir.root_transport
1080
 
            for name in segments:
1081
 
                transport = transport.clone(name)
1082
 
                transport.ensure_base()
1083
 
            return transport
1084
 
 
1085
 
        sub_path = self.id2path(file_id)
1086
 
        branch_transport = mkdirs(sub_path)
1087
 
        if format is None:
1088
 
            format = self.bzrdir.cloning_metadir()
1089
 
        branch_transport.ensure_base()
1090
 
        branch_bzrdir = format.initialize_on_transport(branch_transport)
1091
 
        try:
1092
 
            repo = branch_bzrdir.find_repository()
1093
 
        except errors.NoRepositoryPresent:
1094
 
            repo = branch_bzrdir.create_repository()
1095
 
        if not repo.supports_rich_root():
1096
 
            raise errors.RootNotRich()
1097
 
        new_branch = branch_bzrdir.create_branch()
1098
 
        new_branch.pull(self.branch)
1099
 
        for parent_id in self.get_parent_ids():
1100
 
            new_branch.fetch(self.branch, parent_id)
1101
 
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
1102
 
        if tree_transport.base != branch_transport.base:
1103
 
            tree_bzrdir = format.initialize_on_transport(tree_transport)
1104
 
            branch.BranchReferenceFormat().initialize(tree_bzrdir, 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).
 
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).
1143
713
 
1144
714
        Lists, but does not descend into unversioned directories.
 
715
 
1145
716
        This does not include files that have been deleted in this
1146
 
        tree. Skips the control directory.
 
717
        tree.
1147
718
 
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
 
719
        Skips the control directory.
1151
720
        """
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)
 
721
        inv = self._inventory
1160
722
        # Convert these into local objects to save lookup times
1161
 
        pathjoin = osutils.pathjoin
1162
 
        file_kind = self._kind
 
723
        pathjoin = bzrlib.osutils.pathjoin
 
724
        file_kind = bzrlib.osutils.file_kind
1163
725
 
1164
726
        # transport.base ends in a slash, we want the piece
1165
727
        # between the last two slashes
1168
730
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1169
731
 
1170
732
        # directory file_id, relative path, absolute path, reverse sorted children
1171
 
        if from_dir is not None:
1172
 
            from_dir_id = inv.path2id(from_dir)
1173
 
            if from_dir_id is None:
1174
 
                # Directory not versioned
1175
 
                return
1176
 
            from_dir_abspath = pathjoin(self.basedir, from_dir)
1177
 
        else:
1178
 
            from_dir_id = inv.root.file_id
1179
 
            from_dir_abspath = self.basedir
1180
 
        children = os.listdir(from_dir_abspath)
 
733
        children = os.listdir(self.basedir)
1181
734
        children.sort()
1182
 
        # jam 20060527 The kernel sized tree seems equivalent whether we
 
735
        # jam 20060527 The kernel sized tree seems equivalent whether we 
1183
736
        # use a deque and popleft to keep them sorted, or if we use a plain
1184
737
        # list and just reverse() them.
1185
738
        children = collections.deque(children)
1186
 
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
 
739
        stack = [(inv.root.file_id, u'', self.basedir, children)]
1187
740
        while stack:
1188
741
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1189
742
 
1205
758
 
1206
759
                # absolute path
1207
760
                fap = from_dir_abspath + '/' + f
1208
 
 
 
761
                
1209
762
                f_ie = inv.get_child(from_dir_id, f)
1210
763
                if f_ie:
1211
764
                    c = 'V'
1234
787
 
1235
788
                fk = file_kind(fap)
1236
789
 
 
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
 
1237
796
                # make a last minute entry
1238
797
                if f_ie:
1239
798
                    yield fp[1:], c, fk, f_ie.file_id, f_ie
1243
802
                    except KeyError:
1244
803
                        yield fp[1:], c, fk, None, TreeEntry()
1245
804
                    continue
1246
 
 
 
805
                
1247
806
                if fk != 'directory':
1248
807
                    continue
1249
808
 
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
 
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
1259
816
            else:
1260
817
                # if we finished all children, pop it off the stack
1261
818
                stack.pop()
1262
819
 
1263
 
    @needs_tree_write_lock
1264
 
    def move(self, from_paths, to_dir=None, after=False, **kwargs):
 
820
 
 
821
    @needs_write_lock
 
822
    def move(self, from_paths, to_name):
1265
823
        """Rename files.
1266
824
 
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;
 
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;
1273
831
        this doesn't change the directory.
1274
832
 
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
 
 
1296
833
        This returns a list of (from_path, to_path) pairs for each
1297
834
        entry that is moved.
1298
835
        """
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()
 
836
        result = []
 
837
        ## TODO: Option to move IDs only
 
838
        assert not isinstance(from_paths, basestring)
1315
839
        inv = self.inventory
1316
 
        to_abs = self.abspath(to_dir)
 
840
        to_abs = self.abspath(to_name)
1317
841
        if not isdir(to_abs):
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
 
 
 
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)
1328
848
        to_dir_ie = inv[to_dir_id]
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
 
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)
1357
871
        try:
1358
 
            if len(from_paths):
1359
 
                self._inventory_is_modified = True
1360
 
            self._move(rename_entries)
 
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"])
1361
883
        except:
1362
884
            # restore the inventory on error
1363
 
            self._inventory_is_modified = original_modified
 
885
            self._set_inventory(orig_inv)
1364
886
            raise
1365
887
        self._write_inventory(inv)
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):
 
888
        return result
 
889
 
 
890
    @needs_write_lock
 
891
    def rename_one(self, from_rel, to_rel):
1471
892
        """Rename one file.
1472
893
 
1473
894
        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.
1492
895
        """
1493
896
        inv = self.inventory
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
 
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
 
1512
913
        to_dir, to_tail = os.path.split(to_rel)
1513
914
        to_dir_id = inv.path2id(to_dir)
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)
 
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"])
1541
936
        self._write_inventory(inv)
1542
937
 
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
 
 
1555
938
    @needs_read_lock
1556
939
    def unknowns(self):
1557
940
        """Return all unknown files.
1559
942
        These are files in the working directory that are not versioned or
1560
943
        control files or ignored.
1561
944
        """
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)
 
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()
1593
954
 
1594
955
    def _iter_conflicts(self):
1595
956
        conflicted = set()
1603
964
                yield stem
1604
965
 
1605
966
    @needs_write_lock
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()
 
967
    def pull(self, source, overwrite=False, stop_revision=None):
 
968
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1609
969
        source.lock_read()
1610
970
        try:
1611
971
            pp = ProgressPhase("Pull phase", 2, top_pb)
1612
972
            pp.next_phase()
1613
 
            old_revision_info = self.branch.last_revision_info()
 
973
            old_revision_history = self.branch.revision_history()
1614
974
            basis_tree = self.basis_tree()
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:
 
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:
1620
978
                pp.next_phase()
 
979
                if len(old_revision_history):
 
980
                    other_revision = old_revision_history[-1]
 
981
                else:
 
982
                    other_revision = None
1621
983
                repository = self.branch.repository
1622
 
                pb = ui.ui_factory.nested_progress_bar()
1623
 
                basis_tree.lock_read()
 
984
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
1624
985
                try:
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)
 
986
                    merge_inner(self.branch,
 
987
                                self.branch.basis_tree(),
 
988
                                basis_tree, 
 
989
                                this_tree=self, 
 
990
                                pb=pb)
1637
991
                finally:
1638
992
                    pb.finished()
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)
 
993
                self.set_last_revision(self.branch.last_revision())
1654
994
            return count
1655
995
        finally:
1656
996
            source.unlock()
1657
997
            top_pb.finished()
1658
998
 
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
 
 
1669
999
    def extras(self):
1670
 
        """Yield all unversioned files in this WorkingTree.
 
1000
        """Yield all unknown files in this WorkingTree.
1671
1001
 
1672
 
        If there are any unversioned directories then only the directory is
1673
 
        returned, not all its children.  But if there are unversioned files
 
1002
        If there are any unknown directories then only the directory is
 
1003
        returned, not all its children.  But if there are unknown files
1674
1004
        under a versioned subdirectory, they are returned.
1675
1005
 
1676
1006
        Currently returned depth-first, sorted by name within directories.
1677
 
        This is the same order used by 'osutils.walkdirs'.
1678
1007
        """
1679
1008
        ## TODO: Work from given directory downwards
1680
1009
        for path, dir_entry in self.inventory.directories():
1681
 
            # mutter("search for unknowns in %r", path)
 
1010
            mutter("search for unknowns in %r", path)
1682
1011
            dirabs = self.abspath(path)
1683
1012
            if not isdir(dirabs):
1684
1013
                # e.g. directory deleted
1686
1015
 
1687
1016
            fl = []
1688
1017
            for subf in os.listdir(dirabs):
1689
 
                if self.bzrdir.is_control_filename(subf):
 
1018
                if subf == '.bzr':
1690
1019
                    continue
1691
1020
                if subf not in dir_entry.children:
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)
 
1021
                    subf_norm, can_access = osutils.normalized_filename(subf)
1700
1022
                    if subf_norm != subf and can_access:
1701
1023
                        if subf_norm not in dir_entry.children:
1702
1024
                            fl.append(subf_norm)
1703
1025
                    else:
1704
1026
                        fl.append(subf)
1705
 
 
 
1027
            
1706
1028
            fl.sort()
1707
1029
            for subf in fl:
1708
1030
                subp = pathjoin(path, subf)
1709
1031
                yield subp
1710
1032
 
 
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
 
1711
1088
    def ignored_files(self):
1712
1089
        """Yield list of PATH, IGNORE_PATTERN"""
1713
1090
        for subp in self.extras():
1714
1091
            pat = self.is_ignored(subp)
1715
 
            if pat is not None:
 
1092
            if pat != None:
1716
1093
                yield subp, pat
1717
1094
 
1718
1095
    def get_ignore_list(self):
1720
1097
 
1721
1098
        Cached in the Tree object after the first call.
1722
1099
        """
1723
 
        ignoreset = getattr(self, '_ignoreset', None)
1724
 
        if ignoreset is not None:
1725
 
            return ignoreset
 
1100
        if hasattr(self, '_ignorelist'):
 
1101
            return self._ignorelist
1726
1102
 
1727
 
        ignore_globs = set()
1728
 
        ignore_globs.update(ignores.get_runtime_ignores())
1729
 
        ignore_globs.update(ignores.get_user_ignores())
 
1103
        l = []
1730
1104
        if self.has_filename(bzrlib.IGNORE_FILENAME):
1731
1105
            f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
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
 
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
1743
1121
 
1744
1122
    def is_ignored(self, filename):
1745
1123
        r"""Check whether the filename matches an ignore pattern.
1746
1124
 
1747
1125
        Patterns containing '/' or '\' need to match the whole path;
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.
 
1126
        others match against only the last component.
1751
1127
 
1752
1128
        If the file is ignored, returns the pattern which caused it to
1753
1129
        be ignored, otherwise None.  So this can simply be used as a
1754
1130
        boolean if desired."""
1755
 
        if getattr(self, '_ignoreglobster', None) is None:
1756
 
            self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
1757
 
        return self._ignoreglobster.match(filename)
 
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
1758
1152
 
1759
1153
    def kind(self, file_id):
1760
1154
        return file_kind(self.id2abspath(file_id))
1761
1155
 
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
 
 
 
1156
    @needs_read_lock
1789
1157
    def last_revision(self):
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
 
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().
1796
1163
        """
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())
 
1164
        return self.branch.last_revision()
1803
1165
 
1804
1166
    def is_locked(self):
1805
1167
        return self._control_files.is_locked()
1806
1168
 
1807
 
    def _must_be_locked(self):
1808
 
        if not self.is_locked():
1809
 
            raise errors.ObjectNotLocked(self)
1810
 
 
1811
1169
    def lock_read(self):
1812
1170
        """See Branch.lock_read, and WorkingTree.unlock."""
1813
 
        if not self.is_locked():
1814
 
            self._reset_data()
1815
1171
        self.branch.lock_read()
1816
1172
        try:
1817
1173
            return self._control_files.lock_read()
1819
1175
            self.branch.unlock()
1820
1176
            raise
1821
1177
 
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
 
 
1833
1178
    def lock_write(self):
1834
 
        """See MutableTree.lock_write, and WorkingTree.unlock."""
1835
 
        if not self.is_locked():
1836
 
            self._reset_data()
 
1179
        """See Branch.lock_write, and WorkingTree.unlock."""
1837
1180
        self.branch.lock_write()
1838
1181
        try:
1839
1182
            return self._control_files.lock_write()
1845
1188
        return self._control_files.get_physical_lock_status()
1846
1189
 
1847
1190
    def _basis_inventory_name(self):
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
 
1191
        return 'basis-inventory'
 
1192
 
 
1193
    @needs_write_lock
1861
1194
    def set_last_revision(self, new_revision):
1862
1195
        """Change the last revision in the working tree."""
1863
1196
        if self._change_last_revision(new_revision):
1865
1198
 
1866
1199
    def _change_last_revision(self, new_revision):
1867
1200
        """Template method part of set_last_revision to perform the change.
1868
 
 
 
1201
        
1869
1202
        This is used to allow WorkingTree3 instances to not affect branch
1870
1203
        when their last revision is set.
1871
1204
        """
1872
 
        if _mod_revision.is_null(new_revision):
 
1205
        if new_revision is None:
1873
1206
            self.branch.set_revision_history([])
1874
1207
            return False
 
1208
        # current format is locked in with the branch
 
1209
        revision_history = self.branch.revision_history()
1875
1210
        try:
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])
 
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])
1880
1215
        return True
1881
1216
 
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
 
 
1894
1217
    def _cache_basis_inventory(self, new_revision):
1895
1218
        """Cache new_revision as the basis inventory."""
1896
1219
        # TODO: this should allow the ready-to-use inventory to be passed in,
1897
1220
        # as commit already has that ready-to-use [while the format is the
1898
1221
        # same, that is].
1899
1222
        try:
1900
 
            # this double handles the inventory - unpack and repack -
 
1223
            # this double handles the inventory - unpack and repack - 
1901
1224
            # but is easier to understand. We can/should put a conditional
1902
1225
            # in here based on whether the inventory is in the latest format
1903
1226
            # - perhaps we should repack all inventories on a repository
1904
1227
            # upgrade ?
1905
1228
            # the fast path is to copy the raw xml from the repository. If the
1906
 
            # xml contains 'revision_id="', then we assume the right
 
1229
            # xml contains 'revision_id="', then we assume the right 
1907
1230
            # revision_id is set. We must check for this full string, because a
1908
1231
            # root node id can legitimately look like 'revision_id' but cannot
1909
1232
            # contain a '"'.
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):
 
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:
1919
1244
            pass
1920
1245
 
1921
1246
    def read_basis_inventory(self):
1922
1247
        """Read the cached basis inventory."""
1923
1248
        path = self._basis_inventory_name()
1924
 
        return self._transport.get_bytes(path)
1925
 
 
 
1249
        return self._control_files.get(path).read()
 
1250
        
1926
1251
    @needs_read_lock
1927
1252
    def read_working_inventory(self):
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.
 
1253
        """Read the working inventory."""
1935
1254
        # ElementTree does its own conversion from UTF-8, so open in
1936
1255
        # binary.
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)
 
1256
        result = bzrlib.xml5.serializer_v5.read_inventory(
 
1257
            self._control_files.get('inventory'))
 
1258
        self._set_inventory(result)
1945
1259
        return result
1946
1260
 
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.
 
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.
1956
1275
        """
 
1276
        ## TODO: Normalize names
 
1277
        ## TODO: Remove nested loops; better scalability
1957
1278
        if isinstance(files, basestring):
1958
1279
            files = [files]
1959
1280
 
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.
 
1281
        inv = self.inventory
 
1282
 
 
1283
        # do this before any modifications
2029
1284
        for f in files:
2030
 
            fid = self.path2id(f)
2031
 
            message = None
 
1285
            fid = inv.path2id(f)
2032
1286
            if not fid:
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)
 
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
2079
1306
        if old_tree is None:
2080
 
            basis_tree = self.basis_tree()
2081
 
            basis_tree.lock_read()
2082
 
            old_tree = basis_tree
 
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)
2083
1312
        else:
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()
 
1313
            resolve(self, filenames, ignore_misses=True)
2103
1314
        return conflicts
2104
1315
 
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
 
 
2129
1316
    # XXX: This method should be deprecated in favour of taking in a proper
2130
1317
    # new Inventory object.
2131
 
    @needs_tree_write_lock
 
1318
    @needs_write_lock
2132
1319
    def set_inventory(self, new_inventory_list):
2133
1320
        from bzrlib.inventory import (Inventory,
2134
1321
                                      InventoryDirectory,
 
1322
                                      InventoryEntry,
2135
1323
                                      InventoryFile,
2136
1324
                                      InventoryLink)
2137
1325
        inv = Inventory(self.get_root_id())
2139
1327
            name = os.path.basename(path)
2140
1328
            if name == "":
2141
1329
                continue
2142
 
            # fixme, there should be a factory function inv,add_??
 
1330
            # fixme, there should be a factory function inv,add_?? 
2143
1331
            if kind == 'directory':
2144
1332
                inv.add(InventoryDirectory(file_id, name, parent))
2145
1333
            elif kind == 'file':
2147
1335
            elif kind == 'symlink':
2148
1336
                inv.add(InventoryLink(file_id, name, parent))
2149
1337
            else:
2150
 
                raise errors.BzrError("unknown kind %r" % kind)
 
1338
                raise BzrError("unknown kind %r" % kind)
2151
1339
        self._write_inventory(inv)
2152
1340
 
2153
 
    @needs_tree_write_lock
 
1341
    @needs_write_lock
2154
1342
    def set_root_id(self, file_id):
2155
1343
        """Set the root id for this tree."""
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
 
1344
        inv = self.read_working_inventory()
2171
1345
        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
2177
1346
        del inv._byid[inv.root.file_id]
2178
1347
        inv.root.file_id = file_id
2179
 
        # and link it into the index with the new changed id.
2180
1348
        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.
2184
1349
        for fid in inv:
2185
1350
            entry = inv[fid]
2186
1351
            if entry.parent_id == orig_root_id:
2187
1352
                entry.parent_id = inv.root.file_id
 
1353
        self._write_inventory(inv)
2188
1354
 
2189
1355
    def unlock(self):
2190
1356
        """See Branch.unlock.
2191
 
 
 
1357
        
2192
1358
        WorkingTree locking just uses the Branch locking facilities.
2193
1359
        This is current because all working trees have an embedded branch
2194
1360
        within them. IF in the future, we were to make branch data shareable
2195
 
        between multiple working trees, i.e. via shared storage, then we
 
1361
        between multiple working trees, i.e. via shared storage, then we 
2196
1362
        would probably want to lock both the local tree, and the branch.
2197
1363
        """
2198
1364
        raise NotImplementedError(self.unlock)
2199
1365
 
2200
 
    _marker = object()
2201
 
 
2202
 
    def update(self, change_reporter=None, possible_transports=None,
2203
 
               revision=None, old_tip=_marker):
 
1366
    @needs_write_lock
 
1367
    def update(self):
2204
1368
        """Update a working tree along its branch.
2205
1369
 
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.
 
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.
2222
1381
 
2223
1382
        There isn't a single operation at the moment to do that, so we:
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,
 
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,
2290
1397
                                      to_tree,
2291
1398
                                      basis,
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
 
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
2361
1424
    def _write_inventory(self, inv):
2362
1425
        """Write inventory as the current inventory."""
2363
 
        self._set_inventory(inv, dirty=True)
2364
 
        self.flush()
 
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')
2365
1432
 
2366
1433
    def set_conflicts(self, arg):
2367
 
        raise errors.UnsupportedOperation(self.set_conflicts, self)
 
1434
        raise UnsupportedOperation(self.set_conflicts, self)
2368
1435
 
2369
1436
    def add_conflicts(self, arg):
2370
 
        raise errors.UnsupportedOperation(self.add_conflicts, self)
 
1437
        raise UnsupportedOperation(self.add_conflicts, self)
2371
1438
 
2372
1439
    @needs_read_lock
2373
1440
    def conflicts(self):
2374
 
        conflicts = _mod_conflicts.ConflictList()
 
1441
        conflicts = ConflictList()
2375
1442
        for conflicted in self._iter_conflicts():
2376
1443
            text = True
2377
1444
            try:
2390
1457
                    if text == False:
2391
1458
                        break
2392
1459
            ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2393
 
            conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2394
 
                             path=conflicted,
 
1460
            conflicts.append(Conflict.factory(ctype, path=conflicted,
2395
1461
                             file_id=self.path2id(conflicted)))
2396
1462
        return conflicts
2397
1463
 
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
 
 
2632
1464
 
2633
1465
class WorkingTree2(WorkingTree):
2634
1466
    """This is the Format 2 working tree.
2635
1467
 
2636
 
    This was the first weave based working tree.
 
1468
    This was the first weave based working tree. 
2637
1469
     - uses os locks for locking.
2638
1470
     - uses the branch last-revision.
2639
1471
    """
2640
1472
 
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
 
 
2669
1473
    def unlock(self):
2670
 
        # do non-implementation specific cleanup
2671
 
        self._cleanup()
2672
 
 
2673
1474
        # we share control files:
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
 
 
 
1475
        if self._hashcache.needs_write and self._control_files._lock_count==3:
 
1476
            self._hashcache.write()
2680
1477
        # reverse order of locking.
2681
1478
        try:
2682
1479
            return self._control_files.unlock()
2695
1492
    """
2696
1493
 
2697
1494
    @needs_read_lock
2698
 
    def _last_revision(self):
2699
 
        """See Mutable.last_revision."""
 
1495
    def last_revision(self):
 
1496
        """See WorkingTree.last_revision."""
2700
1497
        try:
2701
 
            return self._transport.get_bytes('last-revision')
2702
 
        except errors.NoSuchFile:
2703
 
            return _mod_revision.NULL_REVISION
 
1498
            return self._control_files.get_utf8('last-revision').read()
 
1499
        except NoSuchFile:
 
1500
            return None
2704
1501
 
2705
1502
    def _change_last_revision(self, revision_id):
2706
1503
        """See WorkingTree._change_last_revision."""
2707
 
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
 
1504
        if revision_id is None or revision_id == NULL_REVISION:
2708
1505
            try:
2709
 
                self._transport.delete('last-revision')
 
1506
                self._control_files._transport.delete('last-revision')
2710
1507
            except errors.NoSuchFile:
2711
1508
                pass
2712
1509
            return False
2713
1510
        else:
2714
 
            self._transport.put_bytes('last-revision', revision_id,
2715
 
                mode=self.bzrdir._get_file_mode())
 
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)
2716
1516
            return True
2717
1517
 
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
 
1518
    @needs_write_lock
2723
1519
    def set_conflicts(self, conflicts):
2724
 
        self._put_rio('conflicts', conflicts.to_stanzas(),
 
1520
        self._put_rio('conflicts', conflicts.to_stanzas(), 
2725
1521
                      CONFLICT_HEADER_1)
2726
1522
 
2727
 
    @needs_tree_write_lock
 
1523
    @needs_write_lock
2728
1524
    def add_conflicts(self, new_conflicts):
2729
1525
        conflict_set = set(self.conflicts())
2730
1526
        conflict_set.update(set(list(new_conflicts)))
2731
 
        self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2732
 
                                       key=_mod_conflicts.Conflict.sort_key)))
 
1527
        self.set_conflicts(ConflictList(sorted(conflict_set,
 
1528
                                               key=Conflict.sort_key)))
2733
1529
 
2734
1530
    @needs_read_lock
2735
1531
    def conflicts(self):
2736
1532
        try:
2737
 
            confile = self._transport.get('conflicts')
2738
 
        except errors.NoSuchFile:
2739
 
            return _mod_conflicts.ConflictList()
 
1533
            confile = self._control_files.get('conflicts')
 
1534
        except NoSuchFile:
 
1535
            return ConflictList()
2740
1536
        try:
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()
 
1537
            if confile.next() != CONFLICT_HEADER_1 + '\n':
 
1538
                raise ConflictFormatError()
 
1539
        except StopIteration:
 
1540
            raise ConflictFormatError()
 
1541
        return ConflictList.from_stanzas(RioReader(confile))
2749
1542
 
2750
1543
    def unlock(self):
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()
 
1544
        if self._hashcache.needs_write and self._control_files._lock_count==1:
 
1545
            self._hashcache.write()
2758
1546
        # reverse order of locking.
2759
1547
        try:
2760
1548
            return self._control_files.unlock()
2763
1551
 
2764
1552
 
2765
1553
def get_conflicted_stem(path):
2766
 
    for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
 
1554
    for suffix in CONFLICT_SUFFIXES:
2767
1555
        if path.endswith(suffix):
2768
1556
            return path[:-len(suffix)]
2769
1557
 
 
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
 
2770
1573
 
2771
1574
class WorkingTreeFormat(object):
2772
1575
    """An encapsulation of the initialization and open routines for a format.
2776
1579
     * a format string,
2777
1580
     * an open routine.
2778
1581
 
2779
 
    Formats are placed in an dict by their format string for reference
 
1582
    Formats are placed in an dict by their format string for reference 
2780
1583
    during workingtree opening. Its not required that these be instances, they
2781
 
    can be classes themselves with class methods - it simply depends on
 
1584
    can be classes themselves with class methods - it simply depends on 
2782
1585
    whether state is needed for a given format or not.
2783
1586
 
2784
1587
    Once a format is deprecated, just deprecate the initialize and open
2785
 
    methods on the format class. Do not deprecate the object, as the
 
1588
    methods on the format class. Do not deprecate the object, as the 
2786
1589
    object will be created every time regardless.
2787
1590
    """
2788
1591
 
2792
1595
    _formats = {}
2793
1596
    """The known formats."""
2794
1597
 
2795
 
    requires_rich_root = False
2796
 
 
2797
 
    upgrade_recommended = False
2798
 
 
2799
1598
    @classmethod
2800
1599
    def find_format(klass, a_bzrdir):
2801
1600
        """Return the format for the working tree object in a_bzrdir."""
2802
1601
        try:
2803
1602
            transport = a_bzrdir.get_workingtree_transport(None)
2804
 
            format_string = transport.get_bytes("format")
 
1603
            format_string = transport.get("format").read()
2805
1604
            return klass._formats[format_string]
2806
 
        except errors.NoSuchFile:
 
1605
        except NoSuchFile:
2807
1606
            raise errors.NoWorkingTree(base=transport.base)
2808
1607
        except KeyError:
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)
 
1608
            raise errors.UnknownFormatError(format=format_string)
2817
1609
 
2818
1610
    @classmethod
2819
1611
    def get_default_format(klass):
2832
1624
        """Is this format supported?
2833
1625
 
2834
1626
        Supported formats can be initialized and opened.
2835
 
        Unsupported formats may not support initialization or committing or
 
1627
        Unsupported formats may not support initialization or committing or 
2836
1628
        some other features depending on the reason for not being supported.
2837
1629
        """
2838
1630
        return True
2839
1631
 
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
 
 
2848
1632
    @classmethod
2849
1633
    def register_format(klass, format):
2850
1634
        klass._formats[format.get_format_string()] = format
2855
1639
 
2856
1640
    @classmethod
2857
1641
    def unregister_format(klass, format):
 
1642
        assert klass._formats[format.get_format_string()] is format
2858
1643
        del klass._formats[format.get_format_string()]
2859
1644
 
2860
1645
 
 
1646
 
2861
1647
class WorkingTreeFormat2(WorkingTreeFormat):
2862
 
    """The second working tree format.
 
1648
    """The second working tree format. 
2863
1649
 
2864
1650
    This format modified the hash cache from the format 1 hash cache.
2865
1651
    """
2866
1652
 
2867
 
    upgrade_recommended = True
2868
 
 
2869
1653
    def get_format_description(self):
2870
1654
        """See WorkingTreeFormat.get_format_description()."""
2871
1655
        return "Working tree format 2"
2872
1656
 
2873
 
    def _stub_initialize_on_transport(self, transport, file_mode):
2874
 
        """Workaround: create control files for a remote working tree.
2875
 
 
 
1657
    def stub_initialize_remote(self, control_files):
 
1658
        """As a special workaround create critical control files for a remote working tree
 
1659
        
2876
1660
        This ensures that it can later be updated and dealt with locally,
2877
 
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
 
1661
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with 
2878
1662
        no working tree.  (See bug #43064).
2879
1663
        """
2880
1664
        sio = StringIO()
2881
 
        inv = inventory.Inventory()
2882
 
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
 
1665
        inv = Inventory()
 
1666
        bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
2883
1667
        sio.seek(0)
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):
 
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):
2889
1674
        """See WorkingTreeFormat.initialize()."""
2890
1675
        if not isinstance(a_bzrdir.transport, LocalTransport):
2891
1676
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
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()
 
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() 
2904
1691
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2905
1692
                         branch,
2906
1693
                         inv,
2907
1694
                         _internal=True,
2908
1695
                         _format=self,
2909
1696
                         _bzrdir=a_bzrdir)
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)
 
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)
2920
1702
        return wt
2921
1703
 
2922
1704
    def __init__(self):
2934
1716
            raise NotImplementedError
2935
1717
        if not isinstance(a_bzrdir.transport, LocalTransport):
2936
1718
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2937
 
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
 
1719
        return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2938
1720
                           _internal=True,
2939
1721
                           _format=self,
2940
1722
                           _bzrdir=a_bzrdir)
2941
 
        return wt
 
1723
 
2942
1724
 
2943
1725
class WorkingTreeFormat3(WorkingTreeFormat):
2944
1726
    """The second working tree format updated to record a format marker.
2952
1734
        - uses a LockDir to guard access for writes.
2953
1735
    """
2954
1736
 
2955
 
    upgrade_recommended = True
2956
 
 
2957
1737
    def get_format_string(self):
2958
1738
        """See WorkingTreeFormat.get_format_string()."""
2959
1739
        return "Bazaar-NG Working Tree format 3"
2965
1745
    _lock_file_name = 'lock'
2966
1746
    _lock_class = LockDir
2967
1747
 
2968
 
    _tree_class = WorkingTree3
2969
 
 
2970
 
    def __get_matchingbzrdir(self):
2971
 
        return bzrdir.BzrDirMetaFormat1()
2972
 
 
2973
 
    _matchingbzrdir = property(__get_matchingbzrdir)
2974
 
 
2975
1748
    def _open_control_files(self, a_bzrdir):
2976
1749
        transport = a_bzrdir.get_workingtree_transport(None)
2977
 
        return LockableFiles(transport, self._lock_file_name,
 
1750
        return LockableFiles(transport, self._lock_file_name, 
2978
1751
                             self._lock_class)
2979
1752
 
2980
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2981
 
                   accelerator_tree=None, hardlink=False):
 
1753
    def initialize(self, a_bzrdir, revision_id=None):
2982
1754
        """See WorkingTreeFormat.initialize().
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.
 
1755
        
 
1756
        revision_id allows creating a working tree at a different
 
1757
        revision than the branch is at.
2992
1758
        """
2993
1759
        if not isinstance(a_bzrdir.transport, LocalTransport):
2994
1760
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2996
1762
        control_files = self._open_control_files(a_bzrdir)
2997
1763
        control_files.create_lock()
2998
1764
        control_files.lock_write()
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()
 
1765
        control_files.put_utf8('format', self.get_format_string())
 
1766
        branch = a_bzrdir.open_branch()
3005
1767
        if revision_id is None:
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('.'),
 
1768
            revision_id = branch.last_revision()
 
1769
        inv = Inventory() 
 
1770
        wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
3014
1771
                         branch,
3015
1772
                         inv,
3016
1773
                         _internal=True,
3017
1774
                         _format=self,
3018
1775
                         _bzrdir=a_bzrdir,
3019
1776
                         _control_files=control_files)
3020
 
        wt.lock_tree_write()
 
1777
        wt.lock_write()
3021
1778
        try:
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)
 
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)
3031
1784
        finally:
3032
 
            # Unlock in this order so that the unlock-triggers-flush in
3033
 
            # WorkingTree is given a chance to fire.
 
1785
            wt.unlock()
3034
1786
            control_files.unlock()
3035
 
            wt.unlock()
3036
1787
        return wt
3037
1788
 
3038
 
    def _initial_inventory(self):
3039
 
        return inventory.Inventory()
3040
 
 
3041
1789
    def __init__(self):
3042
1790
        super(WorkingTreeFormat3, self).__init__()
 
1791
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
3043
1792
 
3044
1793
    def open(self, a_bzrdir, _found=False):
3045
1794
        """Return the WorkingTree object for a_bzrdir
3052
1801
            raise NotImplementedError
3053
1802
        if not isinstance(a_bzrdir.transport, LocalTransport):
3054
1803
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
3055
 
        wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3056
 
        return wt
 
1804
        return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3057
1805
 
3058
1806
    def _open(self, a_bzrdir, control_files):
3059
1807
        """Open the tree itself.
3060
 
 
 
1808
        
3061
1809
        :param a_bzrdir: the dir for the tree.
3062
1810
        :param control_files: the control files for the tree.
3063
1811
        """
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)
 
1812
        return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
 
1813
                           _internal=True,
 
1814
                           _format=self,
 
1815
                           _bzrdir=a_bzrdir,
 
1816
                           _control_files=control_files)
3069
1817
 
3070
1818
    def __str__(self):
3071
1819
        return self.get_format_string()
3072
1820
 
3073
1821
 
3074
 
__default_format = WorkingTreeFormat6()
 
1822
# formats which have no format string are not discoverable
 
1823
# and not independently creatable, so are not registered.
 
1824
__default_format = WorkingTreeFormat3()
3075
1825
WorkingTreeFormat.register_format(__default_format)
3076
 
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3077
 
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3078
 
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3079
1826
WorkingTreeFormat.set_default_format(__default_format)
3080
 
# formats which have no format string are not discoverable
3081
 
# and not independently creatable, so are not registered.
3082
1827
_legacy_formats = [WorkingTreeFormat2(),
3083
1828
                   ]
 
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