/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

[merge] bzr.dev 2255

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
 
 
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
29
29
WorkingTree.open(dir).
30
30
"""
31
31
 
32
 
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
33
 
CONFLICT_HEADER_1 = "BZR conflict list format 1"
34
 
 
35
32
# TODO: Give the workingtree sole responsibility for the working inventory;
36
33
# remove the variable and references to it from the branch.  This may require
37
34
# updating the commit code so as to update the inventory within the working
39
36
# At the moment they may alias the inventory and have old copies of it in
40
37
# memory.  (Now done? -- mbp 20060309)
41
38
 
 
39
from cStringIO import StringIO
 
40
import os
 
41
 
 
42
from bzrlib.lazy_import import lazy_import
 
43
lazy_import(globals(), """
 
44
import collections
42
45
from copy import deepcopy
43
 
from cStringIO import StringIO
44
46
import errno
45
 
import fnmatch
46
 
import os
47
47
import stat
48
 
 
49
 
 
50
 
from bzrlib.atomicfile import AtomicFile
51
 
from bzrlib.branch import (Branch,
52
 
                           quotefn)
53
 
from bzrlib.conflicts import Conflict, ConflictList, CONFLICT_SUFFIXES
54
 
import bzrlib.bzrdir as bzrdir
 
48
from time import time
 
49
import warnings
 
50
 
 
51
import bzrlib
 
52
from bzrlib import (
 
53
    bzrdir,
 
54
    conflicts as _mod_conflicts,
 
55
    errors,
 
56
    generate_ids,
 
57
    globbing,
 
58
    hashcache,
 
59
    ignores,
 
60
    merge,
 
61
    osutils,
 
62
    revisiontree,
 
63
    textui,
 
64
    transform,
 
65
    urlutils,
 
66
    xml5,
 
67
    xml6,
 
68
    )
 
69
import bzrlib.branch
 
70
from bzrlib.transport import get_transport
 
71
import bzrlib.ui
 
72
""")
 
73
 
 
74
from bzrlib import symbol_versioning
55
75
from bzrlib.decorators import needs_read_lock, needs_write_lock
56
 
import bzrlib.errors as errors
57
 
from bzrlib.errors import (BzrCheckError,
58
 
                           BzrError,
59
 
                           ConflictFormatError,
60
 
                           DivergedBranches,
61
 
                           WeaveRevisionNotPresent,
62
 
                           NotBranchError,
63
 
                           NoSuchFile,
64
 
                           NotVersionedError,
65
 
                           MergeModifiedFormatError,
66
 
                           UnsupportedOperation,
67
 
                           )
68
 
from bzrlib.inventory import InventoryEntry, Inventory
 
76
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID
69
77
from bzrlib.lockable_files import LockableFiles, TransportLock
70
78
from bzrlib.lockdir import LockDir
71
 
from bzrlib.merge import merge_inner, transform_tree
 
79
import bzrlib.mutabletree
 
80
from bzrlib.mutabletree import needs_tree_write_lock
72
81
from bzrlib.osutils import (
73
 
                            abspath,
74
 
                            appendpath,
75
 
                            compact_date,
76
 
                            file_kind,
77
 
                            isdir,
78
 
                            getcwd,
79
 
                            pathjoin,
80
 
                            pumpfile,
81
 
                            safe_unicode,
82
 
                            splitpath,
83
 
                            rand_bytes,
84
 
                            normpath,
85
 
                            realpath,
86
 
                            relpath,
87
 
                            rename,
88
 
                            supports_executable,
89
 
                            )
 
82
    compact_date,
 
83
    file_kind,
 
84
    isdir,
 
85
    normpath,
 
86
    pathjoin,
 
87
    rand_chars,
 
88
    realpath,
 
89
    safe_unicode,
 
90
    splitpath,
 
91
    supports_executable,
 
92
    )
 
93
from bzrlib.trace import mutter, note
 
94
from bzrlib.transport.local import LocalTransport
90
95
from bzrlib.progress import DummyProgress, ProgressPhase
91
 
from bzrlib.revision import NULL_REVISION
 
96
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
92
97
from bzrlib.rio import RioReader, rio_file, Stanza
93
 
from bzrlib.symbol_versioning import *
94
 
from bzrlib.textui import show_status
95
 
import bzrlib.tree
96
 
from bzrlib.transform import build_tree
97
 
from bzrlib.trace import mutter, note
98
 
from bzrlib.transport import get_transport
99
 
from bzrlib.transport.local import LocalTransport
100
 
import bzrlib.ui
101
 
import bzrlib.xml5
102
 
 
103
 
 
 
98
from bzrlib.symbol_versioning import (deprecated_passed,
 
99
        deprecated_method,
 
100
        deprecated_function,
 
101
        DEPRECATED_PARAMETER,
 
102
        zero_eight,
 
103
        zero_eleven,
 
104
        zero_thirteen,
 
105
        )
 
106
 
 
107
 
 
108
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
 
109
CONFLICT_HEADER_1 = "BZR conflict list format 1"
 
110
 
 
111
 
 
112
@deprecated_function(zero_thirteen)
104
113
def gen_file_id(name):
105
 
    """Return new file id.
106
 
 
107
 
    This should probably generate proper UUIDs, but for the moment we
108
 
    cope with just randomness because running uuidgen every time is
109
 
    slow."""
110
 
    import re
111
 
    from binascii import hexlify
112
 
    from time import time
113
 
 
114
 
    # get last component
115
 
    idx = name.rfind('/')
116
 
    if idx != -1:
117
 
        name = name[idx+1 : ]
118
 
    idx = name.rfind('\\')
119
 
    if idx != -1:
120
 
        name = name[idx+1 : ]
121
 
 
122
 
    # make it not a hidden file
123
 
    name = name.lstrip('.')
124
 
 
125
 
    # remove any wierd characters; we don't escape them but rather
126
 
    # just pull them out
127
 
    name = re.sub(r'[^\w.]', '', name)
128
 
 
129
 
    s = hexlify(rand_bytes(8))
130
 
    return '-'.join((name, compact_date(time()), s))
131
 
 
132
 
 
 
114
    """Return new file id for the basename 'name'.
 
115
 
 
116
    Use bzrlib.generate_ids.gen_file_id() instead
 
117
    """
 
118
    return generate_ids.gen_file_id(name)
 
119
 
 
120
 
 
121
@deprecated_function(zero_thirteen)
133
122
def gen_root_id():
134
 
    """Return a new tree-root file id."""
135
 
    return gen_file_id('TREE_ROOT')
 
123
    """Return a new tree-root file id.
 
124
 
 
125
    This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
 
126
    """
 
127
    return generate_ids.gen_root_id()
136
128
 
137
129
 
138
130
class TreeEntry(object):
139
 
    """An entry that implements the minium interface used by commands.
 
131
    """An entry that implements the minimum interface used by commands.
140
132
 
141
133
    This needs further inspection, it may be better to have 
142
134
    InventoryEntries without ids - though that seems wrong. For now,
190
182
        return ''
191
183
 
192
184
 
193
 
class WorkingTree(bzrlib.tree.Tree):
 
185
class WorkingTree(bzrlib.mutabletree.MutableTree):
194
186
    """Working copy tree.
195
187
 
196
188
    The inventory is held in the `Branch` working-inventory, and the
218
210
        self.bzrdir = _bzrdir
219
211
        if not _internal:
220
212
            # not created via open etc.
221
 
            warn("WorkingTree() is deprecated as of bzr version 0.8. "
 
213
            warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
222
214
                 "Please use bzrdir.open_workingtree or WorkingTree.open().",
223
215
                 DeprecationWarning,
224
216
                 stacklevel=2)
225
217
            wt = WorkingTree.open(basedir)
226
 
            self.branch = wt.branch
 
218
            self._branch = wt.branch
227
219
            self.basedir = wt.basedir
228
220
            self._control_files = wt._control_files
229
221
            self._hashcache = wt._hashcache
230
 
            self._set_inventory(wt._inventory)
 
222
            self._set_inventory(wt._inventory, dirty=False)
231
223
            self._format = wt._format
232
224
            self.bzrdir = wt.bzrdir
233
 
        from bzrlib.hashcache import HashCache
234
 
        from bzrlib.trace import note, mutter
235
225
        assert isinstance(basedir, basestring), \
236
226
            "base directory %r is not a string" % basedir
237
227
        basedir = safe_unicode(basedir)
238
228
        mutter("opening working tree %r", basedir)
239
229
        if deprecated_passed(branch):
240
230
            if not _internal:
241
 
                warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
242
 
                     " Please use bzrdir.open_workingtree() or"
 
231
                warnings.warn("WorkingTree(..., branch=XXX) is deprecated"
 
232
                     " as of bzr 0.8. Please use bzrdir.open_workingtree() or"
243
233
                     " WorkingTree.open().",
244
234
                     DeprecationWarning,
245
235
                     stacklevel=2
246
236
                     )
247
 
            self.branch = branch
 
237
            self._branch = branch
248
238
        else:
249
 
            self.branch = self.bzrdir.open_branch()
250
 
        assert isinstance(self.branch, Branch), \
251
 
            "branch %r is not a Branch" % self.branch
 
239
            self._branch = self.bzrdir.open_branch()
252
240
        self.basedir = realpath(basedir)
253
241
        # if branch is at our basedir and is a format 6 or less
254
242
        if isinstance(self._format, WorkingTreeFormat2):
255
243
            # share control object
256
244
            self._control_files = self.branch.control_files
257
245
        else:
258
 
            # only ready for format 3
259
 
            assert isinstance(self._format, WorkingTreeFormat3)
 
246
            # assume all other formats have their own control files.
260
247
            assert isinstance(_control_files, LockableFiles), \
261
248
                    "_control_files must be a LockableFiles, not %r" \
262
249
                    % _control_files
267
254
        # if needed, or, when the cache sees a change, append it to the hash
268
255
        # cache file, and have the parser take the most recent entry for a
269
256
        # given path only.
270
 
        cache_filename = self.bzrdir.get_workingtree_transport(None).abspath('stat-cache')
271
 
        hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
 
257
        wt_trans = self.bzrdir.get_workingtree_transport(None)
 
258
        cache_filename = wt_trans.local_abspath('stat-cache')
 
259
        self._hashcache = hashcache.HashCache(basedir, cache_filename,
 
260
                                              self._control_files._file_mode)
 
261
        hc = self._hashcache
272
262
        hc.read()
273
263
        # is this scan needed ? it makes things kinda slow.
274
 
        hc.scan()
 
264
        #hc.scan()
275
265
 
276
266
        if hc.needs_write:
277
267
            mutter("write hc")
278
268
            hc.write()
279
269
 
280
270
        if _inventory is None:
281
 
            self._set_inventory(self.read_working_inventory())
 
271
            self._inventory_is_modified = False
 
272
            self.read_working_inventory()
282
273
        else:
283
 
            self._set_inventory(_inventory)
284
 
 
285
 
    def _set_inventory(self, inv):
 
274
            # the caller of __init__ has provided an inventory,
 
275
            # we assume they know what they are doing - as its only
 
276
            # the Format factory and creation methods that are
 
277
            # permitted to do this.
 
278
            self._set_inventory(_inventory, dirty=False)
 
279
 
 
280
    branch = property(
 
281
        fget=lambda self: self._branch,
 
282
        doc="""The branch this WorkingTree is connected to.
 
283
 
 
284
            This cannot be set - it is reflective of the actual disk structure
 
285
            the working tree has been constructed from.
 
286
            """)
 
287
 
 
288
    def break_lock(self):
 
289
        """Break a lock if one is present from another instance.
 
290
 
 
291
        Uses the ui factory to ask for confirmation if the lock may be from
 
292
        an active process.
 
293
 
 
294
        This will probe the repository for its lock as well.
 
295
        """
 
296
        self._control_files.break_lock()
 
297
        self.branch.break_lock()
 
298
 
 
299
    def _set_inventory(self, inv, dirty):
 
300
        """Set the internal cached inventory.
 
301
 
 
302
        :param inv: The inventory to set.
 
303
        :param dirty: A boolean indicating whether the inventory is the same
 
304
            logical inventory as whats on disk. If True the inventory is not
 
305
            the same and should be written to disk or data will be lost, if
 
306
            False then the inventory is the same as that on disk and any
 
307
            serialisation would be unneeded overhead.
 
308
        """
 
309
        assert inv.root is not None
286
310
        self._inventory = inv
287
 
        self.path2id = self._inventory.path2id
288
 
 
289
 
    def is_control_filename(self, filename):
290
 
        """True if filename is the name of a control file in this tree.
291
 
        
292
 
        This is true IF and ONLY IF the filename is part of the meta data
293
 
        that bzr controls in this tree. I.E. a random .bzr directory placed
294
 
        on disk will not be a control file for this tree.
295
 
        """
296
 
        try:
297
 
            self.bzrdir.transport.relpath(self.abspath(filename))
298
 
            return True
299
 
        except errors.PathNotChild:
300
 
            return False
 
311
        self._inventory_is_modified = dirty
301
312
 
302
313
    @staticmethod
303
314
    def open(path=None, _unsupported=False):
319
330
        run into /.  If there isn't one, raises NotBranchError.
320
331
        TODO: give this a new exception.
321
332
        If there is one, it is returned, along with the unused portion of path.
 
333
 
 
334
        :return: The WorkingTree that contains 'path', and the rest of path
322
335
        """
323
336
        if path is None:
324
 
            path = os.getcwdu()
 
337
            path = osutils.getcwd()
325
338
        control, relpath = bzrdir.BzrDir.open_containing(path)
 
339
 
326
340
        return control.open_workingtree(), relpath
327
341
 
328
342
    @staticmethod
341
355
        """
342
356
        inv = self._inventory
343
357
        for path, ie in inv.iter_entries():
344
 
            if bzrlib.osutils.lexists(self.abspath(path)):
 
358
            if osutils.lexists(self.abspath(path)):
345
359
                yield ie.file_id
346
360
 
347
361
    def __repr__(self):
352
366
        return pathjoin(self.basedir, filename)
353
367
    
354
368
    def basis_tree(self):
355
 
        """Return RevisionTree for the current last revision."""
356
 
        revision_id = self.last_revision()
357
 
        if revision_id is not None:
358
 
            try:
359
 
                xml = self.read_basis_inventory()
360
 
                inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
361
 
            except NoSuchFile:
362
 
                inv = None
363
 
            if inv is not None and inv.revision_id == revision_id:
364
 
                return bzrlib.tree.RevisionTree(self.branch.repository, inv,
365
 
                                                revision_id)
366
 
        # FIXME? RBC 20060403 should we cache the inventory here ?
367
 
        return self.branch.repository.revision_tree(revision_id)
 
369
        """Return RevisionTree for the current last revision.
 
370
        
 
371
        If the left most parent is a ghost then the returned tree will be an
 
372
        empty tree - one obtained by calling repository.revision_tree(None).
 
373
        """
 
374
        try:
 
375
            revision_id = self.get_parent_ids()[0]
 
376
        except IndexError:
 
377
            # no parents, return an empty revision tree.
 
378
            # in the future this should return the tree for
 
379
            # 'empty:' - the implicit root empty tree.
 
380
            return self.branch.repository.revision_tree(None)
 
381
        try:
 
382
            return self.revision_tree(revision_id)
 
383
        except errors.NoSuchRevision:
 
384
            pass
 
385
        # No cached copy available, retrieve from the repository.
 
386
        # FIXME? RBC 20060403 should we cache the inventory locally
 
387
        # at this point ?
 
388
        try:
 
389
            return self.branch.repository.revision_tree(revision_id)
 
390
        except errors.RevisionNotPresent:
 
391
            # the basis tree *may* be a ghost or a low level error may have
 
392
            # occured. If the revision is present, its a problem, if its not
 
393
            # its a ghost.
 
394
            if self.branch.repository.has_revision(revision_id):
 
395
                raise
 
396
            # the basis tree is a ghost so return an empty tree.
 
397
            return self.branch.repository.revision_tree(None)
368
398
 
369
399
    @staticmethod
370
400
    @deprecated_method(zero_eight)
383
413
        XXX: When BzrDir is present, these should be created through that 
384
414
        interface instead.
385
415
        """
386
 
        warn('delete WorkingTree.create', stacklevel=3)
 
416
        warnings.warn('delete WorkingTree.create', stacklevel=3)
387
417
        transport = get_transport(directory)
388
418
        if branch.bzrdir.root_transport.base == transport.base:
389
419
            # same dir 
404
434
        """
405
435
        return bzrdir.BzrDir.create_standalone_workingtree(directory)
406
436
 
407
 
    def relpath(self, abs):
408
 
        """Return the local path portion from a given absolute path."""
409
 
        return relpath(self.basedir, abs)
 
437
    def relpath(self, path):
 
438
        """Return the local path portion from a given path.
 
439
        
 
440
        The path may be absolute or relative. If its a relative path it is 
 
441
        interpreted relative to the python current working directory.
 
442
        """
 
443
        return osutils.relpath(self.basedir, path)
410
444
 
411
445
    def has_filename(self, filename):
412
 
        return bzrlib.osutils.lexists(self.abspath(filename))
 
446
        return osutils.lexists(self.abspath(filename))
413
447
 
414
448
    def get_file(self, file_id):
415
449
        return self.get_file_byname(self.id2path(file_id))
416
450
 
 
451
    def get_file_text(self, file_id):
 
452
        return self.get_file(file_id).read()
 
453
 
417
454
    def get_file_byname(self, filename):
418
455
        return file(self.abspath(filename), 'rb')
419
456
 
 
457
    def annotate_iter(self, file_id):
 
458
        """See Tree.annotate_iter
 
459
 
 
460
        This implementation will use the basis tree implementation if possible.
 
461
        Lines not in the basis are attributed to CURRENT_REVISION
 
462
 
 
463
        If there are pending merges, lines added by those merges will be
 
464
        incorrectly attributed to CURRENT_REVISION (but after committing, the
 
465
        attribution will be correct).
 
466
        """
 
467
        basis = self.basis_tree()
 
468
        changes = self._iter_changes(basis, True, [file_id]).next()
 
469
        changed_content, kind = changes[2], changes[6]
 
470
        if not changed_content:
 
471
            return basis.annotate_iter(file_id)
 
472
        if kind[1] is None:
 
473
            return None
 
474
        import annotate
 
475
        if kind[0] != 'file':
 
476
            old_lines = []
 
477
        else:
 
478
            old_lines = list(basis.annotate_iter(file_id))
 
479
        old = [old_lines]
 
480
        for tree in self.branch.repository.revision_trees(
 
481
            self.get_parent_ids()[1:]):
 
482
            if file_id not in tree:
 
483
                continue
 
484
            old.append(list(tree.annotate_iter(file_id)))
 
485
        return annotate.reannotate(old, self.get_file(file_id).readlines(),
 
486
                                   CURRENT_REVISION)
 
487
 
 
488
    def get_parent_ids(self):
 
489
        """See Tree.get_parent_ids.
 
490
        
 
491
        This implementation reads the pending merges list and last_revision
 
492
        value and uses that to decide what the parents list should be.
 
493
        """
 
494
        last_rev = self._last_revision()
 
495
        if last_rev is None:
 
496
            parents = []
 
497
        else:
 
498
            parents = [last_rev]
 
499
        try:
 
500
            merges_file = self._control_files.get_utf8('pending-merges')
 
501
        except errors.NoSuchFile:
 
502
            pass
 
503
        else:
 
504
            for l in merges_file.readlines():
 
505
                parents.append(l.rstrip('\n'))
 
506
        return parents
 
507
 
 
508
    @needs_read_lock
420
509
    def get_root_id(self):
421
510
        """Return the id of this trees root"""
422
 
        inv = self.read_working_inventory()
423
 
        return inv.root.file_id
 
511
        return self._inventory.root.file_id
424
512
        
425
513
    def _get_store_filename(self, file_id):
426
514
        ## XXX: badly named; this is not in the store at all
452
540
    @needs_read_lock
453
541
    def copy_content_into(self, tree, revision_id=None):
454
542
        """Copy the current content and user files of this tree into tree."""
 
543
        tree.set_root_id(self.get_root_id())
455
544
        if revision_id is None:
456
 
            transform_tree(tree, self)
 
545
            merge.transform_tree(tree, self)
457
546
        else:
458
 
            # TODO now merge from tree.last_revision to revision
459
 
            transform_tree(tree, self)
460
 
            tree.set_last_revision(revision_id)
461
 
 
462
 
    @needs_write_lock
463
 
    def commit(self, message=None, revprops=None, *args, **kwargs):
464
 
        # avoid circular imports
465
 
        from bzrlib.commit import Commit
466
 
        if revprops is None:
467
 
            revprops = {}
468
 
        if not 'branch-nick' in revprops:
469
 
            revprops['branch-nick'] = self.branch.nick
470
 
        # args for wt.commit start at message from the Commit.commit method,
471
 
        # but with branch a kwarg now, passing in args as is results in the
472
 
        #message being used for the branch
473
 
        args = (DEPRECATED_PARAMETER, message, ) + args
474
 
        Commit().commit(working_tree=self, revprops=revprops, *args, **kwargs)
475
 
        self._set_inventory(self.read_working_inventory())
 
547
            # TODO now merge from tree.last_revision to revision (to preserve
 
548
            # user local changes)
 
549
            merge.transform_tree(tree, self)
 
550
            tree.set_parent_ids([revision_id])
476
551
 
477
552
    def id2abspath(self, file_id):
478
553
        return self.abspath(self.id2path(file_id))
483
558
        if not inv.has_id(file_id):
484
559
            return False
485
560
        path = inv.id2path(file_id)
486
 
        return bzrlib.osutils.lexists(self.abspath(path))
 
561
        return osutils.lexists(self.abspath(path))
487
562
 
488
563
    def has_or_had_id(self, file_id):
489
564
        if file_id == self.inventory.root.file_id:
496
571
        return os.path.getsize(self.id2abspath(file_id))
497
572
 
498
573
    @needs_read_lock
499
 
    def get_file_sha1(self, file_id):
500
 
        path = self._inventory.id2path(file_id)
501
 
        return self._hashcache.get_sha1(path)
502
 
 
503
 
    def is_executable(self, file_id):
504
 
        if not supports_executable():
 
574
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
575
        if not path:
 
576
            path = self._inventory.id2path(file_id)
 
577
        return self._hashcache.get_sha1(path, stat_value)
 
578
 
 
579
    def get_file_mtime(self, file_id, path=None):
 
580
        if not path:
 
581
            path = self._inventory.id2path(file_id)
 
582
        return os.lstat(self.abspath(path)).st_mtime
 
583
 
 
584
    if not supports_executable():
 
585
        def is_executable(self, file_id, path=None):
505
586
            return self._inventory[file_id].executable
506
 
        else:
507
 
            path = self._inventory.id2path(file_id)
 
587
    else:
 
588
        def is_executable(self, file_id, path=None):
 
589
            if not path:
 
590
                path = self._inventory.id2path(file_id)
508
591
            mode = os.lstat(self.abspath(path)).st_mode
509
 
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
 
592
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
510
593
 
511
594
    @needs_write_lock
512
 
    def add(self, files, ids=None):
513
 
        """Make files versioned.
514
 
 
515
 
        Note that the command line normally calls smart_add instead,
516
 
        which can automatically recurse.
517
 
 
518
 
        This adds the files to the inventory, so that they will be
519
 
        recorded by the next commit.
520
 
 
521
 
        files
522
 
            List of paths to add, relative to the base of the tree.
523
 
 
524
 
        ids
525
 
            If set, use these instead of automatically generated ids.
526
 
            Must be the same length as the list of files, but may
527
 
            contain None for ids that are to be autogenerated.
528
 
 
529
 
        TODO: Perhaps have an option to add the ids even if the files do
530
 
              not (yet) exist.
531
 
 
532
 
        TODO: Perhaps callback with the ids and paths as they're added.
533
 
        """
 
595
    def _add(self, files, ids, kinds):
 
596
        """See MutableTree._add."""
534
597
        # TODO: Re-adding a file that is removed in the working copy
535
598
        # should probably put it back with the previous ID.
536
 
        if isinstance(files, basestring):
537
 
            assert(ids is None or isinstance(ids, basestring))
538
 
            files = [files]
539
 
            if ids is not None:
540
 
                ids = [ids]
541
 
 
542
 
        if ids is None:
543
 
            ids = [None] * len(files)
544
 
        else:
545
 
            assert(len(ids) == len(files))
546
 
 
 
599
        # the read and write working inventory should not occur in this 
 
600
        # function - they should be part of lock_write and unlock.
547
601
        inv = self.read_working_inventory()
548
 
        for f,file_id in zip(files, ids):
549
 
            if self.is_control_filename(f):
550
 
                raise BzrError("cannot add control file %s" % quotefn(f))
551
 
 
552
 
            fp = splitpath(f)
553
 
 
554
 
            if len(fp) == 0:
555
 
                raise BzrError("cannot add top-level %r" % f)
556
 
 
557
 
            fullpath = normpath(self.abspath(f))
558
 
 
559
 
            try:
560
 
                kind = file_kind(fullpath)
561
 
            except OSError, e:
562
 
                if e.errno == errno.ENOENT:
563
 
                    raise NoSuchFile(fullpath)
564
 
                # maybe something better?
565
 
                raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
566
 
 
567
 
            if not InventoryEntry.versionable_kind(kind):
568
 
                raise BzrError('cannot add: not a versionable file ('
569
 
                               'i.e. regular file, symlink or directory): %s' % quotefn(f))
570
 
 
 
602
        for f, file_id, kind in zip(files, ids, kinds):
 
603
            assert kind is not None
571
604
            if file_id is None:
572
 
                file_id = gen_file_id(f)
573
 
            inv.add_path(f, kind=kind, file_id=file_id)
574
 
 
575
 
            mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
 
605
                inv.add_path(f, kind=kind)
 
606
            else:
 
607
                inv.add_path(f, kind=kind, file_id=file_id)
576
608
        self._write_inventory(inv)
577
609
 
 
610
    @needs_tree_write_lock
 
611
    def _gather_kinds(self, files, kinds):
 
612
        """See MutableTree._gather_kinds."""
 
613
        for pos, f in enumerate(files):
 
614
            if kinds[pos] is None:
 
615
                fullpath = normpath(self.abspath(f))
 
616
                try:
 
617
                    kinds[pos] = file_kind(fullpath)
 
618
                except OSError, e:
 
619
                    if e.errno == errno.ENOENT:
 
620
                        raise errors.NoSuchFile(fullpath)
 
621
 
578
622
    @needs_write_lock
 
623
    def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
 
624
        """Add revision_id as a parent.
 
625
 
 
626
        This is equivalent to retrieving the current list of parent ids
 
627
        and setting the list to its value plus revision_id.
 
628
 
 
629
        :param revision_id: The revision id to add to the parent list. It may
 
630
        be a ghost revision as long as its not the first parent to be added,
 
631
        or the allow_leftmost_as_ghost parameter is set True.
 
632
        :param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
 
633
        """
 
634
        parents = self.get_parent_ids() + [revision_id]
 
635
        self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
 
636
            or allow_leftmost_as_ghost)
 
637
 
 
638
    @needs_tree_write_lock
 
639
    def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
 
640
        """Add revision_id, tree tuple as a parent.
 
641
 
 
642
        This is equivalent to retrieving the current list of parent trees
 
643
        and setting the list to its value plus parent_tuple. See also
 
644
        add_parent_tree_id - if you only have a parent id available it will be
 
645
        simpler to use that api. If you have the parent already available, using
 
646
        this api is preferred.
 
647
 
 
648
        :param parent_tuple: The (revision id, tree) to add to the parent list.
 
649
            If the revision_id is a ghost, pass None for the tree.
 
650
        :param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
 
651
        """
 
652
        parent_ids = self.get_parent_ids() + [parent_tuple[0]]
 
653
        if len(parent_ids) > 1:
 
654
            # the leftmost may have already been a ghost, preserve that if it
 
655
            # was.
 
656
            allow_leftmost_as_ghost = True
 
657
        self.set_parent_ids(parent_ids,
 
658
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
659
 
 
660
    @needs_tree_write_lock
579
661
    def add_pending_merge(self, *revision_ids):
580
662
        # TODO: Perhaps should check at this point that the
581
663
        # history of the revision is actually present?
582
 
        p = self.pending_merges()
 
664
        parents = self.get_parent_ids()
583
665
        updated = False
584
666
        for rev_id in revision_ids:
585
 
            if rev_id in p:
 
667
            if rev_id in parents:
586
668
                continue
587
 
            p.append(rev_id)
 
669
            parents.append(rev_id)
588
670
            updated = True
589
671
        if updated:
590
 
            self.set_pending_merges(p)
 
672
            self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
591
673
 
 
674
    @deprecated_method(zero_eleven)
592
675
    @needs_read_lock
593
676
    def pending_merges(self):
594
677
        """Return a list of pending merges.
595
678
 
596
679
        These are revisions that have been merged into the working
597
680
        directory but not yet committed.
598
 
        """
599
 
        try:
600
 
            merges_file = self._control_files.get_utf8('pending-merges')
601
 
        except OSError, e:
602
 
            if e.errno != errno.ENOENT:
603
 
                raise
604
 
            return []
605
 
        p = []
606
 
        for l in merges_file.readlines():
607
 
            p.append(l.rstrip('\n'))
608
 
        return p
609
 
 
610
 
    @needs_write_lock
 
681
 
 
682
        As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
 
683
        instead - which is available on all tree objects.
 
684
        """
 
685
        return self.get_parent_ids()[1:]
 
686
 
 
687
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
 
688
        """Common ghost checking functionality from set_parent_*.
 
689
 
 
690
        This checks that the left hand-parent exists if there are any
 
691
        revisions present.
 
692
        """
 
693
        if len(revision_ids) > 0:
 
694
            leftmost_id = revision_ids[0]
 
695
            if (not allow_leftmost_as_ghost and not
 
696
                self.branch.repository.has_revision(leftmost_id)):
 
697
                raise errors.GhostRevisionUnusableHere(leftmost_id)
 
698
 
 
699
    def _set_merges_from_parent_ids(self, parent_ids):
 
700
        merges = parent_ids[1:]
 
701
        self._control_files.put_utf8('pending-merges', '\n'.join(merges))
 
702
 
 
703
    @needs_tree_write_lock
 
704
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
 
705
        """Set the parent ids to revision_ids.
 
706
        
 
707
        See also set_parent_trees. This api will try to retrieve the tree data
 
708
        for each element of revision_ids from the trees repository. If you have
 
709
        tree data already available, it is more efficient to use
 
710
        set_parent_trees rather than set_parent_ids. set_parent_ids is however
 
711
        an easier API to use.
 
712
 
 
713
        :param revision_ids: The revision_ids to set as the parent ids of this
 
714
            working tree. Any of these may be ghosts.
 
715
        """
 
716
        self._check_parents_for_ghosts(revision_ids,
 
717
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
718
 
 
719
        if len(revision_ids) > 0:
 
720
            self.set_last_revision(revision_ids[0])
 
721
        else:
 
722
            self.set_last_revision(None)
 
723
 
 
724
        self._set_merges_from_parent_ids(revision_ids)
 
725
 
 
726
    @needs_tree_write_lock
 
727
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
 
728
        """See MutableTree.set_parent_trees."""
 
729
        parent_ids = [rev for (rev, tree) in parents_list]
 
730
 
 
731
        self._check_parents_for_ghosts(parent_ids,
 
732
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
733
 
 
734
        if len(parent_ids) == 0:
 
735
            leftmost_parent_id = None
 
736
            leftmost_parent_tree = None
 
737
        else:
 
738
            leftmost_parent_id, leftmost_parent_tree = parents_list[0]
 
739
 
 
740
        if self._change_last_revision(leftmost_parent_id):
 
741
            if leftmost_parent_tree is None:
 
742
                # If we don't have a tree, fall back to reading the
 
743
                # parent tree from the repository.
 
744
                self._cache_basis_inventory(leftmost_parent_id)
 
745
            else:
 
746
                inv = leftmost_parent_tree.inventory
 
747
                xml = self._create_basis_xml_from_inventory(
 
748
                                        leftmost_parent_id, inv)
 
749
                self._write_basis_inventory(xml)
 
750
        self._set_merges_from_parent_ids(parent_ids)
 
751
 
 
752
    @needs_tree_write_lock
611
753
    def set_pending_merges(self, rev_list):
612
 
        self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
 
754
        parents = self.get_parent_ids()
 
755
        leftmost = parents[:1]
 
756
        new_parents = leftmost + rev_list
 
757
        self.set_parent_ids(new_parents)
613
758
 
614
 
    @needs_write_lock
 
759
    @needs_tree_write_lock
615
760
    def set_merge_modified(self, modified_hashes):
616
761
        def iter_stanzas():
617
762
            for file_id, hash in modified_hashes.iteritems():
618
763
                yield Stanza(file_id=file_id, hash=hash)
619
764
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
620
765
 
621
 
    @needs_write_lock
 
766
    @needs_tree_write_lock
622
767
    def _put_rio(self, filename, stanzas, header):
623
768
        my_file = rio_file(stanzas, header)
624
769
        self._control_files.put(filename, my_file)
625
770
 
 
771
    @needs_write_lock # because merge pulls data into the branch.
 
772
    def merge_from_branch(self, branch, to_revision=None):
 
773
        """Merge from a branch into this working tree.
 
774
 
 
775
        :param branch: The branch to merge from.
 
776
        :param to_revision: If non-None, the merge will merge to to_revision,
 
777
            but not beyond it. to_revision does not need to be in the history
 
778
            of the branch when it is supplied. If None, to_revision defaults to
 
779
            branch.last_revision().
 
780
        """
 
781
        from bzrlib.merge import Merger, Merge3Merger
 
782
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
783
        try:
 
784
            merger = Merger(self.branch, this_tree=self, pb=pb)
 
785
            merger.pp = ProgressPhase("Merge phase", 5, pb)
 
786
            merger.pp.next_phase()
 
787
            # check that there are no
 
788
            # local alterations
 
789
            merger.check_basis(check_clean=True, require_commits=False)
 
790
            if to_revision is None:
 
791
                to_revision = branch.last_revision()
 
792
            merger.other_rev_id = to_revision
 
793
            if merger.other_rev_id is None:
 
794
                raise error.NoCommits(branch)
 
795
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
796
            merger.other_basis = merger.other_rev_id
 
797
            merger.other_tree = self.branch.repository.revision_tree(
 
798
                merger.other_rev_id)
 
799
            merger.pp.next_phase()
 
800
            merger.find_base()
 
801
            if merger.base_rev_id == merger.other_rev_id:
 
802
                raise errors.PointlessMerge
 
803
            merger.backup_files = False
 
804
            merger.merge_type = Merge3Merger
 
805
            merger.set_interesting_files(None)
 
806
            merger.show_base = False
 
807
            merger.reprocess = False
 
808
            conflicts = merger.do_merge()
 
809
            merger.set_pending()
 
810
        finally:
 
811
            pb.finished()
 
812
        return conflicts
 
813
 
626
814
    @needs_read_lock
627
815
    def merge_modified(self):
628
816
        try:
629
817
            hashfile = self._control_files.get('merge-hashes')
630
 
        except NoSuchFile:
 
818
        except errors.NoSuchFile:
631
819
            return {}
632
820
        merge_hashes = {}
633
821
        try:
634
822
            if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
635
 
                raise MergeModifiedFormatError()
 
823
                raise errors.MergeModifiedFormatError()
636
824
        except StopIteration:
637
 
            raise MergeModifiedFormatError()
 
825
            raise errors.MergeModifiedFormatError()
638
826
        for s in RioReader(hashfile):
639
827
            file_id = s.get("file_id")
640
828
            if file_id not in self.inventory:
644
832
                merge_hashes[file_id] = hash
645
833
        return merge_hashes
646
834
 
 
835
    @needs_write_lock
 
836
    def mkdir(self, path, file_id=None):
 
837
        """See MutableTree.mkdir()."""
 
838
        if file_id is None:
 
839
            file_id = generate_ids.gen_file_id(os.path.basename(path))
 
840
        os.mkdir(self.abspath(path))
 
841
        self.add(path, file_id, 'directory')
 
842
        return file_id
 
843
 
647
844
    def get_symlink_target(self, file_id):
648
845
        return os.readlink(self.id2abspath(file_id))
649
846
 
655
852
        else:
656
853
            return '?'
657
854
 
658
 
    def list_files(self):
659
 
        """Recursively list all files as (path, class, kind, id).
 
855
    def flush(self):
 
856
        """Write the in memory inventory to disk."""
 
857
        # TODO: Maybe this should only write on dirty ?
 
858
        if self._control_files._lock_mode != 'w':
 
859
            raise errors.NotWriteLocked(self)
 
860
        sio = StringIO()
 
861
        xml5.serializer_v5.write_inventory(self._inventory, sio)
 
862
        sio.seek(0)
 
863
        self._control_files.put('inventory', sio)
 
864
        self._inventory_is_modified = False
 
865
 
 
866
    def list_files(self, include_root=False):
 
867
        """Recursively list all files as (path, class, kind, id, entry).
660
868
 
661
869
        Lists, but does not descend into unversioned directories.
662
870
 
666
874
        Skips the control directory.
667
875
        """
668
876
        inv = self._inventory
669
 
 
670
 
        def descend(from_dir_relpath, from_dir_id, dp):
671
 
            ls = os.listdir(dp)
672
 
            ls.sort()
673
 
            for f in ls:
 
877
        if include_root is True:
 
878
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
 
879
        # Convert these into local objects to save lookup times
 
880
        pathjoin = osutils.pathjoin
 
881
        file_kind = osutils.file_kind
 
882
 
 
883
        # transport.base ends in a slash, we want the piece
 
884
        # between the last two slashes
 
885
        transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
 
886
 
 
887
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
 
888
 
 
889
        # directory file_id, relative path, absolute path, reverse sorted children
 
890
        children = os.listdir(self.basedir)
 
891
        children.sort()
 
892
        # jam 20060527 The kernel sized tree seems equivalent whether we 
 
893
        # use a deque and popleft to keep them sorted, or if we use a plain
 
894
        # list and just reverse() them.
 
895
        children = collections.deque(children)
 
896
        stack = [(inv.root.file_id, u'', self.basedir, children)]
 
897
        while stack:
 
898
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
 
899
 
 
900
            while children:
 
901
                f = children.popleft()
674
902
                ## TODO: If we find a subdirectory with its own .bzr
675
903
                ## directory, then that is a separate tree and we
676
904
                ## should exclude it.
677
905
 
678
906
                # the bzrdir for this tree
679
 
                if self.bzrdir.transport.base.endswith(f + '/'):
 
907
                if transport_base_dir == f:
680
908
                    continue
681
909
 
682
 
                # path within tree
683
 
                fp = appendpath(from_dir_relpath, f)
 
910
                # we know that from_dir_relpath and from_dir_abspath never end in a slash
 
911
                # and 'f' doesn't begin with one, we can do a string op, rather
 
912
                # than the checks of pathjoin(), all relative paths will have an extra slash
 
913
                # at the beginning
 
914
                fp = from_dir_relpath + '/' + f
684
915
 
685
916
                # absolute path
686
 
                fap = appendpath(dp, f)
 
917
                fap = from_dir_abspath + '/' + f
687
918
                
688
919
                f_ie = inv.get_child(from_dir_id, f)
689
920
                if f_ie:
690
921
                    c = 'V'
691
 
                elif self.is_ignored(fp):
 
922
                elif self.is_ignored(fp[1:]):
692
923
                    c = 'I'
693
924
                else:
694
 
                    c = '?'
 
925
                    # we may not have found this file, because of a unicode issue
 
926
                    f_norm, can_access = osutils.normalized_filename(f)
 
927
                    if f == f_norm or not can_access:
 
928
                        # No change, so treat this file normally
 
929
                        c = '?'
 
930
                    else:
 
931
                        # this file can be accessed by a normalized path
 
932
                        # check again if it is versioned
 
933
                        # these lines are repeated here for performance
 
934
                        f = f_norm
 
935
                        fp = from_dir_relpath + '/' + f
 
936
                        fap = from_dir_abspath + '/' + f
 
937
                        f_ie = inv.get_child(from_dir_id, f)
 
938
                        if f_ie:
 
939
                            c = 'V'
 
940
                        elif self.is_ignored(fp[1:]):
 
941
                            c = 'I'
 
942
                        else:
 
943
                            c = '?'
695
944
 
696
945
                fk = file_kind(fap)
697
946
 
698
947
                if f_ie:
699
948
                    if f_ie.kind != fk:
700
 
                        raise BzrCheckError("file %r entered as kind %r id %r, "
701
 
                                            "now of kind %r"
702
 
                                            % (fap, f_ie.kind, f_ie.file_id, fk))
 
949
                        raise errors.BzrCheckError(
 
950
                            "file %r entered as kind %r id %r, now of kind %r"
 
951
                            % (fap, f_ie.kind, f_ie.file_id, fk))
703
952
 
704
953
                # make a last minute entry
705
954
                if f_ie:
706
 
                    entry = f_ie
 
955
                    yield fp[1:], c, fk, f_ie.file_id, f_ie
707
956
                else:
708
 
                    if fk == 'directory':
709
 
                        entry = TreeDirectory()
710
 
                    elif fk == 'file':
711
 
                        entry = TreeFile()
712
 
                    elif fk == 'symlink':
713
 
                        entry = TreeLink()
714
 
                    else:
715
 
                        entry = TreeEntry()
 
957
                    try:
 
958
                        yield fp[1:], c, fk, None, fk_entries[fk]()
 
959
                    except KeyError:
 
960
                        yield fp[1:], c, fk, None, TreeEntry()
 
961
                    continue
716
962
                
717
 
                yield fp, c, fk, (f_ie and f_ie.file_id), entry
718
 
 
719
963
                if fk != 'directory':
720
964
                    continue
721
965
 
722
 
                if c != 'V':
723
 
                    # don't descend unversioned directories
724
 
                    continue
725
 
                
726
 
                for ff in descend(fp, f_ie.file_id, fap):
727
 
                    yield ff
728
 
 
729
 
        for f in descend(u'', inv.root.file_id, self.basedir):
730
 
            yield f
731
 
 
732
 
    @needs_write_lock
733
 
    def move(self, from_paths, to_name):
 
966
                # But do this child first
 
967
                new_children = os.listdir(fap)
 
968
                new_children.sort()
 
969
                new_children = collections.deque(new_children)
 
970
                stack.append((f_ie.file_id, fp, fap, new_children))
 
971
                # Break out of inner loop,
 
972
                # so that we start outer loop with child
 
973
                break
 
974
            else:
 
975
                # if we finished all children, pop it off the stack
 
976
                stack.pop()
 
977
 
 
978
    @needs_tree_write_lock
 
979
    def move(self, from_paths, to_dir=None, after=False, **kwargs):
734
980
        """Rename files.
735
981
 
736
 
        to_name must exist in the inventory.
 
982
        to_dir must exist in the inventory.
737
983
 
738
 
        If to_name exists and is a directory, the files are moved into
 
984
        If to_dir exists and is a directory, the files are moved into
739
985
        it, keeping their old names.  
740
986
 
741
 
        Note that to_name is only the last component of the new name;
 
987
        Note that to_dir is only the last component of the new name;
742
988
        this doesn't change the directory.
743
989
 
 
990
        For each entry in from_paths the move mode will be determined
 
991
        independently.
 
992
 
 
993
        The first mode moves the file in the filesystem and updates the
 
994
        inventory. The second mode only updates the inventory without
 
995
        touching the file on the filesystem. This is the new mode introduced
 
996
        in version 0.15.
 
997
 
 
998
        move uses the second mode if 'after == True' and the target is not
 
999
        versioned but present in the working tree.
 
1000
 
 
1001
        move uses the second mode if 'after == False' and the source is
 
1002
        versioned but no longer in the working tree, and the target is not
 
1003
        versioned but present in the working tree.
 
1004
 
 
1005
        move uses the first mode if 'after == False' and the source is
 
1006
        versioned and present in the working tree, and the target is not
 
1007
        versioned and not present in the working tree.
 
1008
 
 
1009
        Everything else results in an error.
 
1010
 
744
1011
        This returns a list of (from_path, to_path) pairs for each
745
1012
        entry that is moved.
746
1013
        """
747
 
        result = []
748
 
        ## TODO: Option to move IDs only
 
1014
        rename_entries = []
 
1015
        rename_tuples = []
 
1016
 
 
1017
        # check for deprecated use of signature
 
1018
        if to_dir is None:
 
1019
            to_dir = kwargs.get('to_name', None)
 
1020
            if to_dir is None:
 
1021
                raise TypeError('You must supply a target directory')
 
1022
            else:
 
1023
                symbol_versioning.warn('The parameter to_name was deprecated'
 
1024
                                       ' in version 0.13. Use to_dir instead',
 
1025
                                       DeprecationWarning)
 
1026
 
 
1027
        # check destination directory
749
1028
        assert not isinstance(from_paths, basestring)
750
1029
        inv = self.inventory
751
 
        to_abs = self.abspath(to_name)
 
1030
        to_abs = self.abspath(to_dir)
752
1031
        if not isdir(to_abs):
753
 
            raise BzrError("destination %r is not a directory" % to_abs)
754
 
        if not self.has_filename(to_name):
755
 
            raise BzrError("destination %r not in working directory" % to_abs)
756
 
        to_dir_id = inv.path2id(to_name)
757
 
        if to_dir_id == None and to_name != '':
758
 
            raise BzrError("destination %r is not a versioned directory" % to_name)
 
1032
            raise errors.BzrMoveFailedError('',to_dir,
 
1033
                errors.NotADirectory(to_abs))
 
1034
        if not self.has_filename(to_dir):
 
1035
            raise errors.BzrMoveFailedError('',to_dir,
 
1036
                errors.NotInWorkingDirectory(to_dir))
 
1037
        to_dir_id = inv.path2id(to_dir)
 
1038
        if to_dir_id is None:
 
1039
            raise errors.BzrMoveFailedError('',to_dir,
 
1040
                errors.NotVersionedError(path=str(to_dir)))
 
1041
 
759
1042
        to_dir_ie = inv[to_dir_id]
760
 
        if to_dir_ie.kind not in ('directory', 'root_directory'):
761
 
            raise BzrError("destination %r is not a directory" % to_abs)
762
 
 
763
 
        to_idpath = inv.get_idpath(to_dir_id)
764
 
 
765
 
        for f in from_paths:
766
 
            if not self.has_filename(f):
767
 
                raise BzrError("%r does not exist in working tree" % f)
768
 
            f_id = inv.path2id(f)
769
 
            if f_id == None:
770
 
                raise BzrError("%r is not versioned" % f)
771
 
            name_tail = splitpath(f)[-1]
772
 
            dest_path = appendpath(to_name, name_tail)
773
 
            if self.has_filename(dest_path):
774
 
                raise BzrError("destination %r already exists" % dest_path)
775
 
            if f_id in to_idpath:
776
 
                raise BzrError("can't move %r to a subdirectory of itself" % f)
777
 
 
778
 
        # OK, so there's a race here, it's possible that someone will
779
 
        # create a file in this interval and then the rename might be
780
 
        # left half-done.  But we should have caught most problems.
781
 
        orig_inv = deepcopy(self.inventory)
 
1043
        if to_dir_ie.kind != 'directory':
 
1044
            raise errors.BzrMoveFailedError('',to_dir,
 
1045
                errors.NotADirectory(to_abs))
 
1046
 
 
1047
        # create rename entries and tuples
 
1048
        for from_rel in from_paths:
 
1049
            from_tail = splitpath(from_rel)[-1]
 
1050
            from_id = inv.path2id(from_rel)
 
1051
            if from_id is None:
 
1052
                raise errors.BzrMoveFailedError(from_rel,to_dir,
 
1053
                    errors.NotVersionedError(path=str(from_rel)))
 
1054
 
 
1055
            from_entry = inv[from_id]
 
1056
            from_parent_id = from_entry.parent_id
 
1057
            to_rel = pathjoin(to_dir, from_tail)
 
1058
            rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
 
1059
                                         from_id=from_id,
 
1060
                                         from_tail=from_tail,
 
1061
                                         from_parent_id=from_parent_id,
 
1062
                                         to_rel=to_rel, to_tail=from_tail,
 
1063
                                         to_parent_id=to_dir_id)
 
1064
            rename_entries.append(rename_entry)
 
1065
            rename_tuples.append((from_rel, to_rel))
 
1066
 
 
1067
        # determine which move mode to use. checks also for movability
 
1068
        rename_entries = self._determine_mv_mode(rename_entries, after)
 
1069
 
 
1070
        original_modified = self._inventory_is_modified
782
1071
        try:
783
 
            for f in from_paths:
784
 
                name_tail = splitpath(f)[-1]
785
 
                dest_path = appendpath(to_name, name_tail)
786
 
                result.append((f, dest_path))
787
 
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
788
 
                try:
789
 
                    rename(self.abspath(f), self.abspath(dest_path))
790
 
                except OSError, e:
791
 
                    raise BzrError("failed to rename %r to %r: %s" %
792
 
                                   (f, dest_path, e[1]),
793
 
                            ["rename rolled back"])
 
1072
            if len(from_paths):
 
1073
                self._inventory_is_modified = True
 
1074
            self._move(rename_entries)
794
1075
        except:
795
1076
            # restore the inventory on error
796
 
            self._set_inventory(orig_inv)
 
1077
            self._inventory_is_modified = original_modified
797
1078
            raise
798
1079
        self._write_inventory(inv)
799
 
        return result
800
 
 
801
 
    @needs_write_lock
802
 
    def rename_one(self, from_rel, to_rel):
 
1080
        return rename_tuples
 
1081
 
 
1082
    def _determine_mv_mode(self, rename_entries, after=False):
 
1083
        """Determines for each from-to pair if both inventory and working tree
 
1084
        or only the inventory has to be changed.
 
1085
 
 
1086
        Also does basic plausability tests.
 
1087
        """
 
1088
        inv = self.inventory
 
1089
 
 
1090
        for rename_entry in rename_entries:
 
1091
            # store to local variables for easier reference
 
1092
            from_rel = rename_entry.from_rel
 
1093
            from_id = rename_entry.from_id
 
1094
            to_rel = rename_entry.to_rel
 
1095
            to_id = inv.path2id(to_rel)
 
1096
            only_change_inv = False
 
1097
 
 
1098
            # check the inventory for source and destination
 
1099
            if from_id is None:
 
1100
                raise errors.BzrMoveFailedError(from_rel,to_rel,
 
1101
                    errors.NotVersionedError(path=str(from_rel)))
 
1102
            if to_id is not None:
 
1103
                raise errors.BzrMoveFailedError(from_rel,to_rel,
 
1104
                    errors.AlreadyVersionedError(path=str(to_rel)))
 
1105
 
 
1106
            # try to determine the mode for rename (only change inv or change
 
1107
            # inv and file system)
 
1108
            if after:
 
1109
                if not self.has_filename(to_rel):
 
1110
                    raise errors.BzrMoveFailedError(from_id,to_rel,
 
1111
                        errors.NoSuchFile(path=str(to_rel),
 
1112
                        extra="New file has not been created yet"))
 
1113
                only_change_inv = True
 
1114
            elif not self.has_filename(from_rel) and self.has_filename(to_rel):
 
1115
                only_change_inv = True
 
1116
            elif self.has_filename(from_rel) and not self.has_filename(to_rel):
 
1117
                only_change_inv = False
 
1118
            else:
 
1119
                # something is wrong, so lets determine what exactly
 
1120
                if not self.has_filename(from_rel) and \
 
1121
                   not self.has_filename(to_rel):
 
1122
                    raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1123
                        errors.PathsDoNotExist(paths=(str(from_rel),
 
1124
                        str(to_rel))))
 
1125
                else:
 
1126
                    raise errors.RenameFailedFilesExist(from_rel, to_rel,
 
1127
                        extra="(Use --after to update the Bazaar id)")
 
1128
            rename_entry.only_change_inv = only_change_inv
 
1129
        return rename_entries
 
1130
 
 
1131
    def _move(self, rename_entries):
 
1132
        """Moves a list of files.
 
1133
 
 
1134
        Depending on the value of the flag 'only_change_inv', the
 
1135
        file will be moved on the file system or not.
 
1136
        """
 
1137
        inv = self.inventory
 
1138
        moved = []
 
1139
 
 
1140
        for entry in rename_entries:
 
1141
            try:
 
1142
                self._move_entry(entry)
 
1143
            except:
 
1144
                self._rollback_move(moved)
 
1145
                raise
 
1146
            moved.append(entry)
 
1147
 
 
1148
    def _rollback_move(self, moved):
 
1149
        """Try to rollback a previous move in case of an filesystem error."""
 
1150
        inv = self.inventory
 
1151
        for entry in moved:
 
1152
            try:
 
1153
                self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
 
1154
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
 
1155
                    entry.from_tail, entry.from_parent_id,
 
1156
                    entry.only_change_inv))
 
1157
            except errors.BzrMoveFailedError, e:
 
1158
                raise errors.BzrMoveFailedError( '', '', "Rollback failed."
 
1159
                        " The working tree is in an inconsistent state."
 
1160
                        " Please consider doing a 'bzr revert'."
 
1161
                        " Error message is: %s" % e)
 
1162
 
 
1163
    def _move_entry(self, entry):
 
1164
        inv = self.inventory
 
1165
        from_rel_abs = self.abspath(entry.from_rel)
 
1166
        to_rel_abs = self.abspath(entry.to_rel)
 
1167
        if from_rel_abs == to_rel_abs:
 
1168
            raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
 
1169
                "Source and target are identical.")
 
1170
 
 
1171
        if not entry.only_change_inv:
 
1172
            try:
 
1173
                osutils.rename(from_rel_abs, to_rel_abs)
 
1174
            except OSError, e:
 
1175
                raise errors.BzrMoveFailedError(entry.from_rel,
 
1176
                    entry.to_rel, e[1])
 
1177
        inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
 
1178
 
 
1179
    @needs_tree_write_lock
 
1180
    def rename_one(self, from_rel, to_rel, after=False):
803
1181
        """Rename one file.
804
1182
 
805
1183
        This can change the directory or the filename or both.
 
1184
 
 
1185
        rename_one has several 'modes' to work. First, it can rename a physical
 
1186
        file and change the file_id. That is the normal mode. Second, it can
 
1187
        only change the file_id without touching any physical file. This is
 
1188
        the new mode introduced in version 0.15.
 
1189
 
 
1190
        rename_one uses the second mode if 'after == True' and 'to_rel' is not
 
1191
        versioned but present in the working tree.
 
1192
 
 
1193
        rename_one uses the second mode if 'after == False' and 'from_rel' is
 
1194
        versioned but no longer in the working tree, and 'to_rel' is not
 
1195
        versioned but present in the working tree.
 
1196
 
 
1197
        rename_one uses the first mode if 'after == False' and 'from_rel' is
 
1198
        versioned and present in the working tree, and 'to_rel' is not
 
1199
        versioned and not present in the working tree.
 
1200
 
 
1201
        Everything else results in an error.
806
1202
        """
807
1203
        inv = self.inventory
808
 
        if not self.has_filename(from_rel):
809
 
            raise BzrError("can't rename: old working file %r does not exist" % from_rel)
810
 
        if self.has_filename(to_rel):
811
 
            raise BzrError("can't rename: new working file %r already exists" % to_rel)
812
 
 
813
 
        file_id = inv.path2id(from_rel)
814
 
        if file_id == None:
815
 
            raise BzrError("can't rename: old name %r is not versioned" % from_rel)
816
 
 
817
 
        entry = inv[file_id]
818
 
        from_parent = entry.parent_id
819
 
        from_name = entry.name
820
 
        
821
 
        if inv.path2id(to_rel):
822
 
            raise BzrError("can't rename: new name %r is already versioned" % to_rel)
823
 
 
 
1204
        rename_entries = []
 
1205
 
 
1206
        # create rename entries and tuples
 
1207
        from_tail = splitpath(from_rel)[-1]
 
1208
        from_id = inv.path2id(from_rel)
 
1209
        if from_id is None:
 
1210
            raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1211
                errors.NotVersionedError(path=str(from_rel)))
 
1212
        from_entry = inv[from_id]
 
1213
        from_parent_id = from_entry.parent_id
824
1214
        to_dir, to_tail = os.path.split(to_rel)
825
1215
        to_dir_id = inv.path2id(to_dir)
826
 
        if to_dir_id == None and to_dir != '':
827
 
            raise BzrError("can't determine destination directory id for %r" % to_dir)
828
 
 
829
 
        mutter("rename_one:")
830
 
        mutter("  file_id    {%s}" % file_id)
831
 
        mutter("  from_rel   %r" % from_rel)
832
 
        mutter("  to_rel     %r" % to_rel)
833
 
        mutter("  to_dir     %r" % to_dir)
834
 
        mutter("  to_dir_id  {%s}" % to_dir_id)
835
 
 
836
 
        inv.rename(file_id, to_dir_id, to_tail)
837
 
 
838
 
        from_abs = self.abspath(from_rel)
839
 
        to_abs = self.abspath(to_rel)
840
 
        try:
841
 
            rename(from_abs, to_abs)
842
 
        except OSError, e:
843
 
            inv.rename(file_id, from_parent, from_name)
844
 
            raise BzrError("failed to rename %r to %r: %s"
845
 
                    % (from_abs, to_abs, e[1]),
846
 
                    ["rename rolled back"])
 
1216
        rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
 
1217
                                     from_id=from_id,
 
1218
                                     from_tail=from_tail,
 
1219
                                     from_parent_id=from_parent_id,
 
1220
                                     to_rel=to_rel, to_tail=to_tail,
 
1221
                                     to_parent_id=to_dir_id)
 
1222
        rename_entries.append(rename_entry)
 
1223
 
 
1224
        # determine which move mode to use. checks also for movability
 
1225
        rename_entries = self._determine_mv_mode(rename_entries, after)
 
1226
 
 
1227
        # check if the target changed directory and if the target directory is
 
1228
        # versioned
 
1229
        if to_dir_id is None:
 
1230
            raise errors.BzrMoveFailedError(from_rel,to_rel,
 
1231
                errors.NotVersionedError(path=str(to_dir)))
 
1232
 
 
1233
        # all checks done. now we can continue with our actual work
 
1234
        mutter('rename_one:\n'
 
1235
               '  from_id   {%s}\n'
 
1236
               '  from_rel: %r\n'
 
1237
               '  to_rel:   %r\n'
 
1238
               '  to_dir    %r\n'
 
1239
               '  to_dir_id {%s}\n',
 
1240
               from_id, from_rel, to_rel, to_dir, to_dir_id)
 
1241
 
 
1242
        self._move(rename_entries)
847
1243
        self._write_inventory(inv)
848
1244
 
 
1245
    class _RenameEntry(object):
 
1246
        def __init__(self, from_rel, from_id, from_tail, from_parent_id,
 
1247
                     to_rel, to_tail, to_parent_id, only_change_inv=False):
 
1248
            self.from_rel = from_rel
 
1249
            self.from_id = from_id
 
1250
            self.from_tail = from_tail
 
1251
            self.from_parent_id = from_parent_id
 
1252
            self.to_rel = to_rel
 
1253
            self.to_tail = to_tail
 
1254
            self.to_parent_id = to_parent_id
 
1255
            self.only_change_inv = only_change_inv
 
1256
 
849
1257
    @needs_read_lock
850
1258
    def unknowns(self):
851
1259
        """Return all unknown files.
852
1260
 
853
1261
        These are files in the working directory that are not versioned or
854
1262
        control files or ignored.
855
 
        
856
 
        >>> from bzrlib.bzrdir import ScratchDir
857
 
        >>> d = ScratchDir(files=['foo', 'foo~'])
858
 
        >>> b = d.open_branch()
859
 
        >>> tree = d.open_workingtree()
860
 
        >>> map(str, tree.unknowns())
861
 
        ['foo']
862
 
        >>> tree.add('foo')
863
 
        >>> list(b.unknowns())
864
 
        []
865
 
        >>> tree.remove('foo')
866
 
        >>> list(b.unknowns())
867
 
        [u'foo']
868
1263
        """
869
1264
        for subp in self.extras():
870
1265
            if not self.is_ignored(subp):
871
1266
                yield subp
872
 
 
 
1267
    
 
1268
    @needs_tree_write_lock
 
1269
    def unversion(self, file_ids):
 
1270
        """Remove the file ids in file_ids from the current versioned set.
 
1271
 
 
1272
        When a file_id is unversioned, all of its children are automatically
 
1273
        unversioned.
 
1274
 
 
1275
        :param file_ids: The file ids to stop versioning.
 
1276
        :raises: NoSuchId if any fileid is not currently versioned.
 
1277
        """
 
1278
        for file_id in file_ids:
 
1279
            if self._inventory.has_id(file_id):
 
1280
                self._inventory.remove_recursive_id(file_id)
 
1281
            else:
 
1282
                raise errors.NoSuchId(self, file_id)
 
1283
        if len(file_ids):
 
1284
            # in the future this should just set a dirty bit to wait for the 
 
1285
            # final unlock. However, until all methods of workingtree start
 
1286
            # with the current in -memory inventory rather than triggering 
 
1287
            # a read, it is more complex - we need to teach read_inventory
 
1288
            # to know when to read, and when to not read first... and possibly
 
1289
            # to save first when the in memory one may be corrupted.
 
1290
            # so for now, we just only write it if it is indeed dirty.
 
1291
            # - RBC 20060907
 
1292
            self._write_inventory(self._inventory)
 
1293
    
873
1294
    @deprecated_method(zero_eight)
874
1295
    def iter_conflicts(self):
875
1296
        """List all files in the tree that have text or content conflicts.
878
1299
 
879
1300
    def _iter_conflicts(self):
880
1301
        conflicted = set()
881
 
        for path in (s[0] for s in self.list_files()):
 
1302
        for info in self.list_files():
 
1303
            path = info[0]
882
1304
            stem = get_conflicted_stem(path)
883
1305
            if stem is None:
884
1306
                continue
906
1328
                repository = self.branch.repository
907
1329
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
908
1330
                try:
909
 
                    merge_inner(self.branch,
910
 
                                self.branch.basis_tree(),
911
 
                                basis_tree, 
912
 
                                this_tree=self, 
 
1331
                    new_basis_tree = self.branch.basis_tree()
 
1332
                    merge.merge_inner(
 
1333
                                self.branch,
 
1334
                                new_basis_tree,
 
1335
                                basis_tree,
 
1336
                                this_tree=self,
913
1337
                                pb=pb)
 
1338
                    if (basis_tree.inventory.root is None and
 
1339
                        new_basis_tree.inventory.root is not None):
 
1340
                        self.set_root_id(new_basis_tree.inventory.root.file_id)
914
1341
                finally:
915
1342
                    pb.finished()
916
 
                self.set_last_revision(self.branch.last_revision())
 
1343
                # TODO - dedup parents list with things merged by pull ?
 
1344
                # reuse the revisiontree we merged against to set the new
 
1345
                # tree data.
 
1346
                parent_trees = [(self.branch.last_revision(), new_basis_tree)]
 
1347
                # we have to pull the merge trees out again, because 
 
1348
                # merge_inner has set the ids. - this corner is not yet 
 
1349
                # layered well enough to prevent double handling.
 
1350
                merges = self.get_parent_ids()[1:]
 
1351
                parent_trees.extend([
 
1352
                    (parent, repository.revision_tree(parent)) for
 
1353
                     parent in merges])
 
1354
                self.set_parent_trees(parent_trees)
917
1355
            return count
918
1356
        finally:
919
1357
            source.unlock()
920
1358
            top_pb.finished()
921
1359
 
 
1360
    @needs_write_lock
 
1361
    def put_file_bytes_non_atomic(self, file_id, bytes):
 
1362
        """See MutableTree.put_file_bytes_non_atomic."""
 
1363
        stream = file(self.id2abspath(file_id), 'wb')
 
1364
        try:
 
1365
            stream.write(bytes)
 
1366
        finally:
 
1367
            stream.close()
 
1368
        # TODO: update the hashcache here ?
 
1369
 
922
1370
    def extras(self):
923
1371
        """Yield all unknown files in this WorkingTree.
924
1372
 
930
1378
        """
931
1379
        ## TODO: Work from given directory downwards
932
1380
        for path, dir_entry in self.inventory.directories():
933
 
            mutter("search for unknowns in %r", path)
 
1381
            # mutter("search for unknowns in %r", path)
934
1382
            dirabs = self.abspath(path)
935
1383
            if not isdir(dirabs):
936
1384
                # e.g. directory deleted
938
1386
 
939
1387
            fl = []
940
1388
            for subf in os.listdir(dirabs):
941
 
                if (subf != '.bzr'
942
 
                    and (subf not in dir_entry.children)):
943
 
                    fl.append(subf)
 
1389
                if subf == '.bzr':
 
1390
                    continue
 
1391
                if subf not in dir_entry.children:
 
1392
                    subf_norm, can_access = osutils.normalized_filename(subf)
 
1393
                    if subf_norm != subf and can_access:
 
1394
                        if subf_norm not in dir_entry.children:
 
1395
                            fl.append(subf_norm)
 
1396
                    else:
 
1397
                        fl.append(subf)
944
1398
            
945
1399
            fl.sort()
946
1400
            for subf in fl:
947
 
                subp = appendpath(path, subf)
 
1401
                subp = pathjoin(path, subf)
948
1402
                yield subp
949
1403
 
950
1404
 
952
1406
        """Yield list of PATH, IGNORE_PATTERN"""
953
1407
        for subp in self.extras():
954
1408
            pat = self.is_ignored(subp)
955
 
            if pat != None:
 
1409
            if pat is not None:
956
1410
                yield subp, pat
957
1411
 
958
 
 
959
1412
    def get_ignore_list(self):
960
1413
        """Return list of ignore patterns.
961
1414
 
962
1415
        Cached in the Tree object after the first call.
963
1416
        """
964
 
        if hasattr(self, '_ignorelist'):
965
 
            return self._ignorelist
 
1417
        ignoreset = getattr(self, '_ignoreset', None)
 
1418
        if ignoreset is not None:
 
1419
            return ignoreset
966
1420
 
967
 
        l = bzrlib.DEFAULT_IGNORE[:]
 
1421
        ignore_globs = set(bzrlib.DEFAULT_IGNORE)
 
1422
        ignore_globs.update(ignores.get_runtime_ignores())
 
1423
        ignore_globs.update(ignores.get_user_ignores())
968
1424
        if self.has_filename(bzrlib.IGNORE_FILENAME):
969
1425
            f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
970
 
            l.extend([line.rstrip("\n\r") for line in f.readlines()])
971
 
        self._ignorelist = l
972
 
        return l
 
1426
            try:
 
1427
                ignore_globs.update(ignores.parse_ignore_file(f))
 
1428
            finally:
 
1429
                f.close()
 
1430
        self._ignoreset = ignore_globs
 
1431
        return ignore_globs
973
1432
 
 
1433
    def _flush_ignore_list_cache(self):
 
1434
        """Resets the cached ignore list to force a cache rebuild."""
 
1435
        self._ignoreset = None
 
1436
        self._ignoreglobster = None
974
1437
 
975
1438
    def is_ignored(self, filename):
976
1439
        r"""Check whether the filename matches an ignore pattern.
981
1444
        If the file is ignored, returns the pattern which caused it to
982
1445
        be ignored, otherwise None.  So this can simply be used as a
983
1446
        boolean if desired."""
984
 
 
985
 
        # TODO: Use '**' to match directories, and other extended
986
 
        # globbing stuff from cvs/rsync.
987
 
 
988
 
        # XXX: fnmatch is actually not quite what we want: it's only
989
 
        # approximately the same as real Unix fnmatch, and doesn't
990
 
        # treat dotfiles correctly and allows * to match /.
991
 
        # Eventually it should be replaced with something more
992
 
        # accurate.
993
 
        
994
 
        for pat in self.get_ignore_list():
995
 
            if '/' in pat or '\\' in pat:
996
 
                
997
 
                # as a special case, you can put ./ at the start of a
998
 
                # pattern; this is good to match in the top-level
999
 
                # only;
1000
 
                
1001
 
                if (pat[:2] == './') or (pat[:2] == '.\\'):
1002
 
                    newpat = pat[2:]
1003
 
                else:
1004
 
                    newpat = pat
1005
 
                if fnmatch.fnmatchcase(filename, newpat):
1006
 
                    return pat
1007
 
            else:
1008
 
                if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
1009
 
                    return pat
1010
 
        else:
1011
 
            return None
 
1447
        if getattr(self, '_ignoreglobster', None) is None:
 
1448
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
 
1449
        return self._ignoreglobster.match(filename)
1012
1450
 
1013
1451
    def kind(self, file_id):
1014
1452
        return file_kind(self.id2abspath(file_id))
1015
1453
 
1016
 
    @needs_read_lock
 
1454
    def _comparison_data(self, entry, path):
 
1455
        abspath = self.abspath(path)
 
1456
        try:
 
1457
            stat_value = os.lstat(abspath)
 
1458
        except OSError, e:
 
1459
            if getattr(e, 'errno', None) == errno.ENOENT:
 
1460
                stat_value = None
 
1461
                kind = None
 
1462
                executable = False
 
1463
            else:
 
1464
                raise
 
1465
        else:
 
1466
            mode = stat_value.st_mode
 
1467
            kind = osutils.file_kind_from_stat_mode(mode)
 
1468
            if not supports_executable():
 
1469
                executable = entry.executable
 
1470
            else:
 
1471
                executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
 
1472
        return kind, executable, stat_value
 
1473
 
 
1474
    def _file_size(self, entry, stat_value):
 
1475
        return stat_value.st_size
 
1476
 
1017
1477
    def last_revision(self):
1018
 
        """Return the last revision id of this working tree.
1019
 
 
1020
 
        In early branch formats this was == the branch last_revision,
1021
 
        but that cannot be relied upon - for working tree operations,
1022
 
        always use tree.last_revision().
 
1478
        """Return the last revision of the branch for this tree.
 
1479
 
 
1480
        This format tree does not support a separate marker for last-revision
 
1481
        compared to the branch.
 
1482
 
 
1483
        See MutableTree.last_revision
1023
1484
        """
 
1485
        return self._last_revision()
 
1486
 
 
1487
    @needs_read_lock
 
1488
    def _last_revision(self):
 
1489
        """helper for get_parent_ids."""
1024
1490
        return self.branch.last_revision()
1025
1491
 
 
1492
    def is_locked(self):
 
1493
        return self._control_files.is_locked()
 
1494
 
1026
1495
    def lock_read(self):
1027
1496
        """See Branch.lock_read, and WorkingTree.unlock."""
1028
1497
        self.branch.lock_read()
1032
1501
            self.branch.unlock()
1033
1502
            raise
1034
1503
 
 
1504
    def lock_tree_write(self):
 
1505
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
 
1506
        self.branch.lock_read()
 
1507
        try:
 
1508
            return self._control_files.lock_write()
 
1509
        except:
 
1510
            self.branch.unlock()
 
1511
            raise
 
1512
 
1035
1513
    def lock_write(self):
1036
 
        """See Branch.lock_write, and WorkingTree.unlock."""
 
1514
        """See MutableTree.lock_write, and WorkingTree.unlock."""
1037
1515
        self.branch.lock_write()
1038
1516
        try:
1039
1517
            return self._control_files.lock_write()
1041
1519
            self.branch.unlock()
1042
1520
            raise
1043
1521
 
 
1522
    def get_physical_lock_status(self):
 
1523
        return self._control_files.get_physical_lock_status()
 
1524
 
1044
1525
    def _basis_inventory_name(self):
1045
 
        return 'basis-inventory'
 
1526
        return 'basis-inventory-cache'
1046
1527
 
1047
 
    @needs_write_lock
 
1528
    @needs_tree_write_lock
1048
1529
    def set_last_revision(self, new_revision):
1049
1530
        """Change the last revision in the working tree."""
1050
1531
        if self._change_last_revision(new_revision):
1059
1540
        if new_revision is None:
1060
1541
            self.branch.set_revision_history([])
1061
1542
            return False
1062
 
        # current format is locked in with the branch
1063
 
        revision_history = self.branch.revision_history()
1064
1543
        try:
1065
 
            position = revision_history.index(new_revision)
1066
 
        except ValueError:
1067
 
            raise errors.NoSuchRevision(self.branch, new_revision)
1068
 
        self.branch.set_revision_history(revision_history[:position + 1])
 
1544
            self.branch.generate_revision_history(new_revision)
 
1545
        except errors.NoSuchRevision:
 
1546
            # not present in the repo - dont try to set it deeper than the tip
 
1547
            self.branch.set_revision_history([new_revision])
1069
1548
        return True
1070
1549
 
 
1550
    def _write_basis_inventory(self, xml):
 
1551
        """Write the basis inventory XML to the basis-inventory file"""
 
1552
        assert isinstance(xml, str), 'serialised xml must be bytestring.'
 
1553
        path = self._basis_inventory_name()
 
1554
        sio = StringIO(xml)
 
1555
        self._control_files.put(path, sio)
 
1556
 
 
1557
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
 
1558
        """Create the text that will be saved in basis-inventory"""
 
1559
        inventory.revision_id = revision_id
 
1560
        return xml6.serializer_v6.write_inventory_to_string(inventory)
 
1561
 
1071
1562
    def _cache_basis_inventory(self, new_revision):
1072
1563
        """Cache new_revision as the basis inventory."""
 
1564
        # TODO: this should allow the ready-to-use inventory to be passed in,
 
1565
        # as commit already has that ready-to-use [while the format is the
 
1566
        # same, that is].
1073
1567
        try:
1074
1568
            # this double handles the inventory - unpack and repack - 
1075
1569
            # but is easier to understand. We can/should put a conditional
1076
1570
            # in here based on whether the inventory is in the latest format
1077
1571
            # - perhaps we should repack all inventories on a repository
1078
1572
            # upgrade ?
1079
 
            inv = self.branch.repository.get_inventory(new_revision)
1080
 
            inv.revision_id = new_revision
1081
 
            xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1082
 
 
1083
 
            path = self._basis_inventory_name()
1084
 
            self._control_files.put_utf8(path, xml)
1085
 
        except WeaveRevisionNotPresent:
 
1573
            # the fast path is to copy the raw xml from the repository. If the
 
1574
            # xml contains 'revision_id="', then we assume the right 
 
1575
            # revision_id is set. We must check for this full string, because a
 
1576
            # root node id can legitimately look like 'revision_id' but cannot
 
1577
            # contain a '"'.
 
1578
            xml = self.branch.repository.get_inventory_xml(new_revision)
 
1579
            firstline = xml.split('\n', 1)[0]
 
1580
            if (not 'revision_id="' in firstline or 
 
1581
                'format="6"' not in firstline):
 
1582
                inv = self.branch.repository.deserialise_inventory(
 
1583
                    new_revision, xml)
 
1584
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
 
1585
            self._write_basis_inventory(xml)
 
1586
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1086
1587
            pass
1087
1588
 
1088
1589
    def read_basis_inventory(self):
1089
1590
        """Read the cached basis inventory."""
1090
1591
        path = self._basis_inventory_name()
1091
 
        return self._control_files.get_utf8(path).read()
 
1592
        return self._control_files.get(path).read()
1092
1593
        
1093
1594
    @needs_read_lock
1094
1595
    def read_working_inventory(self):
1095
 
        """Read the working inventory."""
 
1596
        """Read the working inventory.
 
1597
        
 
1598
        :raises errors.InventoryModified: read_working_inventory will fail
 
1599
            when the current in memory inventory has been modified.
 
1600
        """
 
1601
        # conceptually this should be an implementation detail of the tree. 
 
1602
        # XXX: Deprecate this.
1096
1603
        # ElementTree does its own conversion from UTF-8, so open in
1097
1604
        # binary.
1098
 
        result = bzrlib.xml5.serializer_v5.read_inventory(
 
1605
        if self._inventory_is_modified:
 
1606
            raise errors.InventoryModified(self)
 
1607
        result = xml5.serializer_v5.read_inventory(
1099
1608
            self._control_files.get('inventory'))
1100
 
        self._set_inventory(result)
 
1609
        self._set_inventory(result, dirty=False)
1101
1610
        return result
1102
1611
 
1103
 
    @needs_write_lock
1104
 
    def remove(self, files, verbose=False):
 
1612
    @needs_tree_write_lock
 
1613
    def remove(self, files, verbose=False, to_file=None):
1105
1614
        """Remove nominated files from the working inventory..
1106
1615
 
1107
1616
        This does not remove their text.  This does not run on XXX on what? RBC
1128
1637
            if not fid:
1129
1638
                # TODO: Perhaps make this just a warning, and continue?
1130
1639
                # This tends to happen when 
1131
 
                raise NotVersionedError(path=f)
1132
 
            mutter("remove inventory entry %s {%s}", quotefn(f), fid)
 
1640
                raise errors.NotVersionedError(path=f)
1133
1641
            if verbose:
1134
1642
                # having remove it, it must be either ignored or unknown
1135
1643
                if self.is_ignored(f):
1136
1644
                    new_status = 'I'
1137
1645
                else:
1138
1646
                    new_status = '?'
1139
 
                show_status(new_status, inv[fid].kind, quotefn(f))
 
1647
                textui.show_status(new_status, inv[fid].kind, f,
 
1648
                                   to_file=to_file)
1140
1649
            del inv[fid]
1141
1650
 
1142
1651
        self._write_inventory(inv)
1143
1652
 
1144
 
    @needs_write_lock
 
1653
    @needs_tree_write_lock
1145
1654
    def revert(self, filenames, old_tree=None, backups=True, 
1146
 
               pb=DummyProgress()):
1147
 
        from transform import revert
1148
 
        from conflicts import resolve
 
1655
               pb=DummyProgress(), report_changes=False):
 
1656
        from bzrlib.conflicts import resolve
1149
1657
        if old_tree is None:
1150
1658
            old_tree = self.basis_tree()
1151
 
        conflicts = revert(self, old_tree, filenames, backups, pb)
 
1659
        conflicts = transform.revert(self, old_tree, filenames, backups, pb,
 
1660
                                     report_changes)
1152
1661
        if not len(filenames):
1153
 
            self.set_pending_merges([])
 
1662
            self.set_parent_ids(self.get_parent_ids()[:1])
1154
1663
            resolve(self)
1155
1664
        else:
1156
1665
            resolve(self, filenames, ignore_misses=True)
1157
1666
        return conflicts
1158
1667
 
 
1668
    def revision_tree(self, revision_id):
 
1669
        """See Tree.revision_tree.
 
1670
 
 
1671
        WorkingTree can supply revision_trees for the basis revision only
 
1672
        because there is only one cached inventory in the bzr directory.
 
1673
        """
 
1674
        if revision_id == self.last_revision():
 
1675
            try:
 
1676
                xml = self.read_basis_inventory()
 
1677
            except NoSuchFile:
 
1678
                pass
 
1679
            else:
 
1680
                try:
 
1681
                    inv = xml6.serializer_v6.read_inventory_from_string(xml)
 
1682
                    # dont use the repository revision_tree api because we want
 
1683
                    # to supply the inventory.
 
1684
                    if inv.revision_id == revision_id:
 
1685
                        return revisiontree.RevisionTree(self.branch.repository,
 
1686
                            inv, revision_id)
 
1687
                except errors.BadInventoryFormat:
 
1688
                    pass
 
1689
        # raise if there was no inventory, or if we read the wrong inventory.
 
1690
        raise errors.NoSuchRevisionInTree(self, revision_id)
 
1691
 
1159
1692
    # XXX: This method should be deprecated in favour of taking in a proper
1160
1693
    # new Inventory object.
1161
 
    @needs_write_lock
 
1694
    @needs_tree_write_lock
1162
1695
    def set_inventory(self, new_inventory_list):
1163
1696
        from bzrlib.inventory import (Inventory,
1164
1697
                                      InventoryDirectory,
1178
1711
            elif kind == 'symlink':
1179
1712
                inv.add(InventoryLink(file_id, name, parent))
1180
1713
            else:
1181
 
                raise BzrError("unknown kind %r" % kind)
 
1714
                raise errors.BzrError("unknown kind %r" % kind)
1182
1715
        self._write_inventory(inv)
1183
1716
 
1184
 
    @needs_write_lock
 
1717
    @needs_tree_write_lock
1185
1718
    def set_root_id(self, file_id):
1186
1719
        """Set the root id for this tree."""
1187
 
        inv = self.read_working_inventory()
 
1720
        # for compatability 
 
1721
        if file_id is None:
 
1722
            symbol_versioning.warn(symbol_versioning.zero_twelve
 
1723
                % 'WorkingTree.set_root_id with fileid=None',
 
1724
                DeprecationWarning,
 
1725
                stacklevel=3)
 
1726
            file_id = ROOT_ID
 
1727
        inv = self._inventory
1188
1728
        orig_root_id = inv.root.file_id
 
1729
        # TODO: it might be nice to exit early if there was nothing
 
1730
        # to do, saving us from trigger a sync on unlock.
 
1731
        self._inventory_is_modified = True
 
1732
        # we preserve the root inventory entry object, but
 
1733
        # unlinkit from the byid index
1189
1734
        del inv._byid[inv.root.file_id]
1190
1735
        inv.root.file_id = file_id
 
1736
        # and link it into the index with the new changed id.
1191
1737
        inv._byid[inv.root.file_id] = inv.root
 
1738
        # and finally update all children to reference the new id.
 
1739
        # XXX: this should be safe to just look at the root.children
 
1740
        # list, not the WHOLE INVENTORY.
1192
1741
        for fid in inv:
1193
1742
            entry = inv[fid]
1194
1743
            if entry.parent_id == orig_root_id:
1195
1744
                entry.parent_id = inv.root.file_id
1196
 
        self._write_inventory(inv)
1197
1745
 
1198
1746
    def unlock(self):
1199
1747
        """See Branch.unlock.
1204
1752
        between multiple working trees, i.e. via shared storage, then we 
1205
1753
        would probably want to lock both the local tree, and the branch.
1206
1754
        """
1207
 
        # FIXME: We want to write out the hashcache only when the last lock on
1208
 
        # this working copy is released.  Peeking at the lock count is a bit
1209
 
        # of a nasty hack; probably it's better to have a transaction object,
1210
 
        # which can do some finalization when it's either successfully or
1211
 
        # unsuccessfully completed.  (Denys's original patch did that.)
1212
 
        # RBC 20060206 hookinhg into transaction will couple lock and transaction
1213
 
        # wrongly. Hookinh into unllock on the control files object is fine though.
1214
 
        
1215
 
        # TODO: split this per format so there is no ugly if block
1216
 
        if self._hashcache.needs_write and (
1217
 
            # dedicated lock files
1218
 
            self._control_files._lock_count==1 or 
1219
 
            # shared lock files
1220
 
            (self._control_files is self.branch.control_files and 
1221
 
             self._control_files._lock_count==3)):
1222
 
            self._hashcache.write()
1223
 
        # reverse order of locking.
1224
 
        result = self._control_files.unlock()
1225
 
        try:
1226
 
            self.branch.unlock()
1227
 
        finally:
1228
 
            return result
 
1755
        raise NotImplementedError(self.unlock)
1229
1756
 
1230
 
    @needs_write_lock
1231
1757
    def update(self):
1232
1758
        """Update a working tree along its branch.
1233
1759
 
1234
 
        This will update the branch if its bound too, which means we have multiple trees involved:
1235
 
        The new basis tree of the master.
1236
 
        The old basis tree of the branch.
1237
 
        The old basis tree of the working tree.
1238
 
        The current working tree state.
1239
 
        pathologically all three may be different, and non ancestors of each other.
1240
 
        Conceptually we want to:
1241
 
        Preserve the wt.basis->wt.state changes
1242
 
        Transform the wt.basis to the new master basis.
1243
 
        Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1244
 
        Restore the wt.basis->wt.state changes.
 
1760
        This will update the branch if its bound too, which means we have
 
1761
        multiple trees involved:
 
1762
 
 
1763
        - The new basis tree of the master.
 
1764
        - The old basis tree of the branch.
 
1765
        - The old basis tree of the working tree.
 
1766
        - The current working tree state.
 
1767
 
 
1768
        Pathologically, all three may be different, and non-ancestors of each
 
1769
        other.  Conceptually we want to:
 
1770
 
 
1771
        - Preserve the wt.basis->wt.state changes
 
1772
        - Transform the wt.basis to the new master basis.
 
1773
        - Apply a merge of the old branch basis to get any 'local' changes from
 
1774
          it into the tree.
 
1775
        - Restore the wt.basis->wt.state changes.
1245
1776
 
1246
1777
        There isn't a single operation at the moment to do that, so we:
1247
 
        Merge current state -> basis tree of the master w.r.t. the old tree basis.
1248
 
        Do a 'normal' merge of the old branch basis if it is relevant.
 
1778
        - Merge current state -> basis tree of the master w.r.t. the old tree
 
1779
          basis.
 
1780
        - Do a 'normal' merge of the old branch basis if it is relevant.
1249
1781
        """
1250
 
        old_tip = self.branch.update()
1251
 
        if old_tip is not None:
1252
 
            self.add_pending_merge(old_tip)
1253
 
        self.branch.lock_read()
 
1782
        if self.branch.get_master_branch() is not None:
 
1783
            self.lock_write()
 
1784
            update_branch = True
 
1785
        else:
 
1786
            self.lock_tree_write()
 
1787
            update_branch = False
1254
1788
        try:
1255
 
            result = 0
1256
 
            if self.last_revision() != self.branch.last_revision():
1257
 
                # merge tree state up to new branch tip.
1258
 
                basis = self.basis_tree()
1259
 
                to_tree = self.branch.basis_tree()
1260
 
                result += merge_inner(self.branch,
1261
 
                                      to_tree,
1262
 
                                      basis,
1263
 
                                      this_tree=self)
1264
 
                self.set_last_revision(self.branch.last_revision())
1265
 
            if old_tip and old_tip != self.last_revision():
1266
 
                # our last revision was not the prior branch last reivison
1267
 
                # and we have converted that last revision to a pending merge.
1268
 
                # base is somewhere between the branch tip now
1269
 
                # and the now pending merge
1270
 
                from bzrlib.revision import common_ancestor
1271
 
                try:
1272
 
                    base_rev_id = common_ancestor(self.branch.last_revision(),
1273
 
                                                  old_tip,
1274
 
                                                  self.branch.repository)
1275
 
                except errors.NoCommonAncestor:
1276
 
                    base_rev_id = None
1277
 
                base_tree = self.branch.repository.revision_tree(base_rev_id)
1278
 
                other_tree = self.branch.repository.revision_tree(old_tip)
1279
 
                result += merge_inner(self.branch,
1280
 
                                      other_tree,
1281
 
                                      base_tree,
1282
 
                                      this_tree=self)
1283
 
            return result
 
1789
            if update_branch:
 
1790
                old_tip = self.branch.update()
 
1791
            else:
 
1792
                old_tip = None
 
1793
            return self._update_tree(old_tip)
1284
1794
        finally:
1285
 
            self.branch.unlock()
1286
 
 
1287
 
    @needs_write_lock
 
1795
            self.unlock()
 
1796
 
 
1797
    @needs_tree_write_lock
 
1798
    def _update_tree(self, old_tip=None):
 
1799
        """Update a tree to the master branch.
 
1800
 
 
1801
        :param old_tip: if supplied, the previous tip revision the branch,
 
1802
            before it was changed to the master branch's tip.
 
1803
        """
 
1804
        # here if old_tip is not None, it is the old tip of the branch before
 
1805
        # it was updated from the master branch. This should become a pending
 
1806
        # merge in the working tree to preserve the user existing work.  we
 
1807
        # cant set that until we update the working trees last revision to be
 
1808
        # one from the new branch, because it will just get absorbed by the
 
1809
        # parent de-duplication logic.
 
1810
        # 
 
1811
        # We MUST save it even if an error occurs, because otherwise the users
 
1812
        # local work is unreferenced and will appear to have been lost.
 
1813
        # 
 
1814
        result = 0
 
1815
        try:
 
1816
            last_rev = self.get_parent_ids()[0]
 
1817
        except IndexError:
 
1818
            last_rev = None
 
1819
        if last_rev != self.branch.last_revision():
 
1820
            # merge tree state up to new branch tip.
 
1821
            basis = self.basis_tree()
 
1822
            to_tree = self.branch.basis_tree()
 
1823
            if basis.inventory.root is None:
 
1824
                self.set_root_id(to_tree.inventory.root.file_id)
 
1825
            result += merge.merge_inner(
 
1826
                                  self.branch,
 
1827
                                  to_tree,
 
1828
                                  basis,
 
1829
                                  this_tree=self)
 
1830
            # TODO - dedup parents list with things merged by pull ?
 
1831
            # reuse the tree we've updated to to set the basis:
 
1832
            parent_trees = [(self.branch.last_revision(), to_tree)]
 
1833
            merges = self.get_parent_ids()[1:]
 
1834
            # Ideally we ask the tree for the trees here, that way the working
 
1835
            # tree can decide whether to give us teh entire tree or give us a
 
1836
            # lazy initialised tree. dirstate for instance will have the trees
 
1837
            # in ram already, whereas a last-revision + basis-inventory tree
 
1838
            # will not, but also does not need them when setting parents.
 
1839
            for parent in merges:
 
1840
                parent_trees.append(
 
1841
                    (parent, self.branch.repository.revision_tree(parent)))
 
1842
            if old_tip is not None:
 
1843
                parent_trees.append(
 
1844
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
 
1845
            self.set_parent_trees(parent_trees)
 
1846
            last_rev = parent_trees[0][0]
 
1847
        else:
 
1848
            # the working tree had the same last-revision as the master
 
1849
            # branch did. We may still have pivot local work from the local
 
1850
            # branch into old_tip:
 
1851
            if old_tip is not None:
 
1852
                self.add_parent_tree_id(old_tip)
 
1853
        if old_tip and old_tip != last_rev:
 
1854
            # our last revision was not the prior branch last revision
 
1855
            # and we have converted that last revision to a pending merge.
 
1856
            # base is somewhere between the branch tip now
 
1857
            # and the now pending merge
 
1858
            from bzrlib.revision import common_ancestor
 
1859
            try:
 
1860
                base_rev_id = common_ancestor(self.branch.last_revision(),
 
1861
                                              old_tip,
 
1862
                                              self.branch.repository)
 
1863
            except errors.NoCommonAncestor:
 
1864
                base_rev_id = None
 
1865
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
1866
            other_tree = self.branch.repository.revision_tree(old_tip)
 
1867
            result += merge.merge_inner(
 
1868
                                  self.branch,
 
1869
                                  other_tree,
 
1870
                                  base_tree,
 
1871
                                  this_tree=self)
 
1872
        return result
 
1873
 
 
1874
    def _write_hashcache_if_dirty(self):
 
1875
        """Write out the hashcache if it is dirty."""
 
1876
        if self._hashcache.needs_write:
 
1877
            try:
 
1878
                self._hashcache.write()
 
1879
            except OSError, e:
 
1880
                if e.errno not in (errno.EPERM, errno.EACCES):
 
1881
                    raise
 
1882
                # TODO: jam 20061219 Should this be a warning? A single line
 
1883
                #       warning might be sufficient to let the user know what
 
1884
                #       is going on.
 
1885
                mutter('Could not write hashcache for %s\nError: %s',
 
1886
                       self._hashcache.cache_file_name(), e)
 
1887
 
 
1888
    @needs_tree_write_lock
1288
1889
    def _write_inventory(self, inv):
1289
1890
        """Write inventory as the current inventory."""
1290
 
        sio = StringIO()
1291
 
        bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1292
 
        sio.seek(0)
1293
 
        self._control_files.put('inventory', sio)
1294
 
        self._set_inventory(inv)
1295
 
        mutter('wrote working inventory')
 
1891
        self._set_inventory(inv, dirty=True)
 
1892
        self.flush()
1296
1893
 
1297
1894
    def set_conflicts(self, arg):
1298
 
        raise UnsupportedOperation(self.set_conflicts, self)
 
1895
        raise errors.UnsupportedOperation(self.set_conflicts, self)
 
1896
 
 
1897
    def add_conflicts(self, arg):
 
1898
        raise errors.UnsupportedOperation(self.add_conflicts, self)
1299
1899
 
1300
1900
    @needs_read_lock
1301
1901
    def conflicts(self):
1302
 
        conflicts = ConflictList()
 
1902
        conflicts = _mod_conflicts.ConflictList()
1303
1903
        for conflicted in self._iter_conflicts():
1304
1904
            text = True
1305
1905
            try:
1306
1906
                if file_kind(self.abspath(conflicted)) != "file":
1307
1907
                    text = False
1308
 
            except OSError, e:
1309
 
                if e.errno == errno.ENOENT:
1310
 
                    text = False
1311
 
                else:
1312
 
                    raise
 
1908
            except errors.NoSuchFile:
 
1909
                text = False
1313
1910
            if text is True:
1314
1911
                for suffix in ('.THIS', '.OTHER'):
1315
1912
                    try:
1316
1913
                        kind = file_kind(self.abspath(conflicted+suffix))
1317
 
                    except OSError, e:
1318
 
                        if e.errno == errno.ENOENT:
 
1914
                        if kind != "file":
1319
1915
                            text = False
1320
 
                            break
1321
 
                        else:
1322
 
                            raise
1323
 
                    if kind != "file":
 
1916
                    except errors.NoSuchFile:
1324
1917
                        text = False
 
1918
                    if text == False:
1325
1919
                        break
1326
1920
            ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1327
 
            conflicts.append(Conflict.factory(ctype, path=conflicted,
 
1921
            conflicts.append(_mod_conflicts.Conflict.factory(ctype,
 
1922
                             path=conflicted,
1328
1923
                             file_id=self.path2id(conflicted)))
1329
1924
        return conflicts
1330
1925
 
1331
1926
 
 
1927
class WorkingTree2(WorkingTree):
 
1928
    """This is the Format 2 working tree.
 
1929
 
 
1930
    This was the first weave based working tree. 
 
1931
     - uses os locks for locking.
 
1932
     - uses the branch last-revision.
 
1933
    """
 
1934
 
 
1935
    def lock_tree_write(self):
 
1936
        """See WorkingTree.lock_tree_write().
 
1937
 
 
1938
        In Format2 WorkingTrees we have a single lock for the branch and tree
 
1939
        so lock_tree_write() degrades to lock_write().
 
1940
        """
 
1941
        self.branch.lock_write()
 
1942
        try:
 
1943
            return self._control_files.lock_write()
 
1944
        except:
 
1945
            self.branch.unlock()
 
1946
            raise
 
1947
 
 
1948
    def unlock(self):
 
1949
        # we share control files:
 
1950
        if self._control_files._lock_count == 3:
 
1951
            # _inventory_is_modified is always False during a read lock.
 
1952
            if self._inventory_is_modified:
 
1953
                self.flush()
 
1954
            self._write_hashcache_if_dirty()
 
1955
                    
 
1956
        # reverse order of locking.
 
1957
        try:
 
1958
            return self._control_files.unlock()
 
1959
        finally:
 
1960
            self.branch.unlock()
 
1961
 
 
1962
 
1332
1963
class WorkingTree3(WorkingTree):
1333
1964
    """This is the Format 3 working tree.
1334
1965
 
1340
1971
    """
1341
1972
 
1342
1973
    @needs_read_lock
1343
 
    def last_revision(self):
1344
 
        """See WorkingTree.last_revision."""
 
1974
    def _last_revision(self):
 
1975
        """See Mutable.last_revision."""
1345
1976
        try:
1346
1977
            return self._control_files.get_utf8('last-revision').read()
1347
 
        except NoSuchFile:
 
1978
        except errors.NoSuchFile:
1348
1979
            return None
1349
1980
 
1350
1981
    def _change_last_revision(self, revision_id):
1356
1987
                pass
1357
1988
            return False
1358
1989
        else:
1359
 
            try:
1360
 
                self.branch.revision_history().index(revision_id)
1361
 
            except ValueError:
1362
 
                raise errors.NoSuchRevision(self.branch, revision_id)
1363
1990
            self._control_files.put_utf8('last-revision', revision_id)
1364
1991
            return True
1365
1992
 
1366
 
    @needs_write_lock
 
1993
    @needs_tree_write_lock
1367
1994
    def set_conflicts(self, conflicts):
1368
1995
        self._put_rio('conflicts', conflicts.to_stanzas(), 
1369
1996
                      CONFLICT_HEADER_1)
1370
1997
 
 
1998
    @needs_tree_write_lock
 
1999
    def add_conflicts(self, new_conflicts):
 
2000
        conflict_set = set(self.conflicts())
 
2001
        conflict_set.update(set(list(new_conflicts)))
 
2002
        self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
 
2003
                                       key=_mod_conflicts.Conflict.sort_key)))
 
2004
 
1371
2005
    @needs_read_lock
1372
2006
    def conflicts(self):
1373
2007
        try:
1374
2008
            confile = self._control_files.get('conflicts')
1375
 
        except NoSuchFile:
1376
 
            return ConflictList()
 
2009
        except errors.NoSuchFile:
 
2010
            return _mod_conflicts.ConflictList()
1377
2011
        try:
1378
2012
            if confile.next() != CONFLICT_HEADER_1 + '\n':
1379
 
                raise ConflictFormatError()
 
2013
                raise errors.ConflictFormatError()
1380
2014
        except StopIteration:
1381
 
            raise ConflictFormatError()
1382
 
        return ConflictList.from_stanzas(RioReader(confile))
 
2015
            raise errors.ConflictFormatError()
 
2016
        return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
 
2017
 
 
2018
    def unlock(self):
 
2019
        if self._control_files._lock_count == 1:
 
2020
            # _inventory_is_modified is always False during a read lock.
 
2021
            if self._inventory_is_modified:
 
2022
                self.flush()
 
2023
            self._write_hashcache_if_dirty()
 
2024
        # reverse order of locking.
 
2025
        try:
 
2026
            return self._control_files.unlock()
 
2027
        finally:
 
2028
            self.branch.unlock()
1383
2029
 
1384
2030
 
1385
2031
def get_conflicted_stem(path):
1386
 
    for suffix in CONFLICT_SUFFIXES:
 
2032
    for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
1387
2033
        if path.endswith(suffix):
1388
2034
            return path[:-len(suffix)]
1389
2035
 
1434
2080
            transport = a_bzrdir.get_workingtree_transport(None)
1435
2081
            format_string = transport.get("format").read()
1436
2082
            return klass._formats[format_string]
1437
 
        except NoSuchFile:
 
2083
        except errors.NoSuchFile:
1438
2084
            raise errors.NoWorkingTree(base=transport.base)
1439
2085
        except KeyError:
1440
 
            raise errors.UnknownFormatError(format_string)
 
2086
            raise errors.UnknownFormatError(format=format_string)
1441
2087
 
1442
2088
    @classmethod
1443
2089
    def get_default_format(klass):
1486
2132
        """See WorkingTreeFormat.get_format_description()."""
1487
2133
        return "Working tree format 2"
1488
2134
 
 
2135
    def stub_initialize_remote(self, control_files):
 
2136
        """As a special workaround create critical control files for a remote working tree
 
2137
        
 
2138
        This ensures that it can later be updated and dealt with locally,
 
2139
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with 
 
2140
        no working tree.  (See bug #43064).
 
2141
        """
 
2142
        sio = StringIO()
 
2143
        inv = Inventory()
 
2144
        xml5.serializer_v5.write_inventory(inv, sio)
 
2145
        sio.seek(0)
 
2146
        control_files.put('inventory', sio)
 
2147
 
 
2148
        control_files.put_utf8('pending-merges', '')
 
2149
        
 
2150
 
1489
2151
    def initialize(self, a_bzrdir, revision_id=None):
1490
2152
        """See WorkingTreeFormat.initialize()."""
1491
2153
        if not isinstance(a_bzrdir.transport, LocalTransport):
1503
2165
            finally:
1504
2166
                branch.unlock()
1505
2167
        revision = branch.last_revision()
1506
 
        inv = Inventory() 
1507
 
        wt = WorkingTree(a_bzrdir.root_transport.base,
 
2168
        inv = Inventory()
 
2169
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1508
2170
                         branch,
1509
2171
                         inv,
1510
2172
                         _internal=True,
1511
2173
                         _format=self,
1512
2174
                         _bzrdir=a_bzrdir)
1513
 
        wt._write_inventory(inv)
1514
 
        wt.set_root_id(inv.root.file_id)
1515
 
        wt.set_last_revision(revision)
1516
 
        wt.set_pending_merges([])
1517
 
        build_tree(wt.basis_tree(), wt)
 
2175
        basis_tree = branch.repository.revision_tree(revision)
 
2176
        if basis_tree.inventory.root is not None:
 
2177
            wt.set_root_id(basis_tree.inventory.root.file_id)
 
2178
        # set the parent list and cache the basis tree.
 
2179
        wt.set_parent_trees([(revision, basis_tree)])
 
2180
        transform.build_tree(basis_tree, wt)
1518
2181
        return wt
1519
2182
 
1520
2183
    def __init__(self):
1532
2195
            raise NotImplementedError
1533
2196
        if not isinstance(a_bzrdir.transport, LocalTransport):
1534
2197
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
1535
 
        return WorkingTree(a_bzrdir.root_transport.base,
 
2198
        return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1536
2199
                           _internal=True,
1537
2200
                           _format=self,
1538
2201
                           _bzrdir=a_bzrdir)
1547
2210
          files, separate from the BzrDir format
1548
2211
        - modifies the hash cache format
1549
2212
        - is new in bzr 0.8
1550
 
        - uses a LockDir to guard access to the repository
 
2213
        - uses a LockDir to guard access for writes.
1551
2214
    """
1552
2215
 
1553
2216
    def get_format_string(self):
1569
2232
    def initialize(self, a_bzrdir, revision_id=None):
1570
2233
        """See WorkingTreeFormat.initialize().
1571
2234
        
1572
 
        revision_id allows creating a working tree at a differnet
 
2235
        revision_id allows creating a working tree at a different
1573
2236
        revision than the branch is at.
1574
2237
        """
1575
2238
        if not isinstance(a_bzrdir.transport, LocalTransport):
1577
2240
        transport = a_bzrdir.get_workingtree_transport(self)
1578
2241
        control_files = self._open_control_files(a_bzrdir)
1579
2242
        control_files.create_lock()
 
2243
        control_files.lock_write()
1580
2244
        control_files.put_utf8('format', self.get_format_string())
1581
2245
        branch = a_bzrdir.open_branch()
1582
2246
        if revision_id is None:
1583
2247
            revision_id = branch.last_revision()
1584
 
        inv = Inventory() 
1585
 
        wt = WorkingTree3(a_bzrdir.root_transport.base,
 
2248
        # WorkingTree3 can handle an inventory which has a unique root id.
 
2249
        # as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
 
2250
        # those trees. And because there isn't a format bump inbetween, we
 
2251
        # are maintaining compatibility with older clients.
 
2252
        # inv = Inventory(root_id=gen_root_id())
 
2253
        inv = Inventory()
 
2254
        wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1586
2255
                         branch,
1587
2256
                         inv,
1588
2257
                         _internal=True,
1589
2258
                         _format=self,
1590
2259
                         _bzrdir=a_bzrdir,
1591
2260
                         _control_files=control_files)
1592
 
        wt._write_inventory(inv)
1593
 
        wt.set_root_id(inv.root.file_id)
1594
 
        wt.set_last_revision(revision_id)
1595
 
        wt.set_pending_merges([])
1596
 
        build_tree(wt.basis_tree(), wt)
 
2261
        wt.lock_tree_write()
 
2262
        try:
 
2263
            basis_tree = branch.repository.revision_tree(revision_id)
 
2264
            # only set an explicit root id if there is one to set.
 
2265
            if basis_tree.inventory.root is not None:
 
2266
                wt.set_root_id(basis_tree.inventory.root.file_id)
 
2267
            if revision_id == NULL_REVISION:
 
2268
                wt.set_parent_trees([])
 
2269
            else:
 
2270
                wt.set_parent_trees([(revision_id, basis_tree)])
 
2271
            transform.build_tree(basis_tree, wt)
 
2272
        finally:
 
2273
            # Unlock in this order so that the unlock-triggers-flush in
 
2274
            # WorkingTree is given a chance to fire.
 
2275
            control_files.unlock()
 
2276
            wt.unlock()
1597
2277
        return wt
1598
2278
 
1599
2279
    def __init__(self):
1611
2291
            raise NotImplementedError
1612
2292
        if not isinstance(a_bzrdir.transport, LocalTransport):
1613
2293
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
1614
 
        control_files = self._open_control_files(a_bzrdir)
1615
 
        return WorkingTree3(a_bzrdir.root_transport.base,
 
2294
        return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
 
2295
 
 
2296
    def _open(self, a_bzrdir, control_files):
 
2297
        """Open the tree itself.
 
2298
        
 
2299
        :param a_bzrdir: the dir for the tree.
 
2300
        :param control_files: the control files for the tree.
 
2301
        """
 
2302
        return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1616
2303
                           _internal=True,
1617
2304
                           _format=self,
1618
2305
                           _bzrdir=a_bzrdir,
1645
2332
        self._transport_readonly_server = transport_readonly_server
1646
2333
        self._formats = formats
1647
2334
    
 
2335
    def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
 
2336
        """Clone test for adaption."""
 
2337
        new_test = deepcopy(test)
 
2338
        new_test.transport_server = self._transport_server
 
2339
        new_test.transport_readonly_server = self._transport_readonly_server
 
2340
        new_test.bzrdir_format = bzrdir_format
 
2341
        new_test.workingtree_format = workingtree_format
 
2342
        def make_new_test_id():
 
2343
            new_id = "%s(%s)" % (test.id(), variation)
 
2344
            return lambda: new_id
 
2345
        new_test.id = make_new_test_id()
 
2346
        return new_test
 
2347
    
1648
2348
    def adapt(self, test):
1649
2349
        from bzrlib.tests import TestSuite
1650
2350
        result = TestSuite()
1651
2351
        for workingtree_format, bzrdir_format in self._formats:
1652
 
            new_test = deepcopy(test)
1653
 
            new_test.transport_server = self._transport_server
1654
 
            new_test.transport_readonly_server = self._transport_readonly_server
1655
 
            new_test.bzrdir_format = bzrdir_format
1656
 
            new_test.workingtree_format = workingtree_format
1657
 
            def make_new_test_id():
1658
 
                new_id = "%s(%s)" % (new_test.id(), workingtree_format.__class__.__name__)
1659
 
                return lambda: new_id
1660
 
            new_test.id = make_new_test_id()
 
2352
            new_test = self._clone_test(
 
2353
                test,
 
2354
                bzrdir_format,
 
2355
                workingtree_format, workingtree_format.__class__.__name__)
1661
2356
            result.addTest(new_test)
1662
2357
        return result