/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Aaron Bentley
  • Date: 2009-03-10 05:24:59 UTC
  • mto: This revision was merged to the branch mainline in revision 4112.
  • Revision ID: aaron@aaronbentley.com-20090310052459-9r5w2vvnklb92x99
Avoid autodetecting tree references in _comparison_data.

Show diffs side-by-side

added added

removed removed

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