~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: John Arbash Meinel
  • Date: 2006-08-15 14:06:37 UTC
  • mto: This revision was merged to the branch mainline in revision 1926.
  • Revision ID: john@arbash-meinel.com-20060815140637-fa80ad04e689d5e4
Fix accidental import removal

Show diffs side-by-side

added added

removed removed

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