/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-12-15 15:42:02 UTC
  • mfrom: (2182.3.12 annotate_show_ids)
  • Revision ID: pqm@pqm.ubuntu.com-20061215154202-8f239c218ab6fe7d
(John Arbash Meinel) Fix annotate tests which fail in certain timezones

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
    ignores,
 
59
    merge,
 
60
    osutils,
 
61
    textui,
 
62
    transform,
 
63
    urlutils,
 
64
    xml5,
 
65
    xml6,
 
66
    )
 
67
import bzrlib.branch
 
68
from bzrlib.transport import get_transport
 
69
import bzrlib.ui
 
70
""")
 
71
 
 
72
from bzrlib import symbol_versioning
55
73
from bzrlib.decorators import needs_read_lock, needs_write_lock
56
 
import bzrlib.errors as errors
57
74
from bzrlib.errors import (BzrCheckError,
58
75
                           BzrError,
59
76
                           ConflictFormatError,
60
 
                           DivergedBranches,
61
77
                           WeaveRevisionNotPresent,
62
78
                           NotBranchError,
63
79
                           NoSuchFile,
65
81
                           MergeModifiedFormatError,
66
82
                           UnsupportedOperation,
67
83
                           )
68
 
from bzrlib.inventory import InventoryEntry, Inventory
 
84
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID
69
85
from bzrlib.lockable_files import LockableFiles, TransportLock
70
86
from bzrlib.lockdir import LockDir
71
 
from bzrlib.merge import merge_inner, transform_tree
 
87
import bzrlib.mutabletree
 
88
from bzrlib.mutabletree import needs_tree_write_lock
72
89
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
 
                            )
 
90
    compact_date,
 
91
    file_kind,
 
92
    isdir,
 
93
    pathjoin,
 
94
    safe_unicode,
 
95
    splitpath,
 
96
    rand_chars,
 
97
    normpath,
 
98
    realpath,
 
99
    supports_executable,
 
100
    )
 
101
from bzrlib.trace import mutter, note
 
102
from bzrlib.transport.local import LocalTransport
 
103
import bzrlib.tree
90
104
from bzrlib.progress import DummyProgress, ProgressPhase
91
105
from bzrlib.revision import NULL_REVISION
 
106
import bzrlib.revisiontree
92
107
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
 
 
 
108
from bzrlib.symbol_versioning import (deprecated_passed,
 
109
        deprecated_method,
 
110
        deprecated_function,
 
111
        DEPRECATED_PARAMETER,
 
112
        zero_eight,
 
113
        zero_eleven,
 
114
        zero_thirteen,
 
115
        )
 
116
 
 
117
 
 
118
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
 
119
CONFLICT_HEADER_1 = "BZR conflict list format 1"
 
120
 
 
121
 
 
122
@deprecated_function(zero_thirteen)
104
123
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
 
 
 
124
    """Return new file id for the basename 'name'.
 
125
 
 
126
    Use bzrlib.generate_ids.gen_file_id() instead
 
127
    """
 
128
    return generate_ids.gen_file_id(name)
 
129
 
 
130
 
 
131
@deprecated_function(zero_thirteen)
133
132
def gen_root_id():
134
 
    """Return a new tree-root file id."""
135
 
    return gen_file_id('TREE_ROOT')
 
133
    """Return a new tree-root file id.
 
134
 
 
135
    This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
 
136
    """
 
137
    return generate_ids.gen_root_id()
136
138
 
137
139
 
138
140
class TreeEntry(object):
139
 
    """An entry that implements the minium interface used by commands.
 
141
    """An entry that implements the minimum interface used by commands.
140
142
 
141
143
    This needs further inspection, it may be better to have 
142
144
    InventoryEntries without ids - though that seems wrong. For now,
190
192
        return ''
191
193
 
192
194
 
193
 
class WorkingTree(bzrlib.tree.Tree):
 
195
class WorkingTree(bzrlib.mutabletree.MutableTree):
194
196
    """Working copy tree.
195
197
 
196
198
    The inventory is held in the `Branch` working-inventory, and the
218
220
        self.bzrdir = _bzrdir
219
221
        if not _internal:
220
222
            # not created via open etc.
221
 
            warn("WorkingTree() is deprecated as of bzr version 0.8. "
 
223
            warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
222
224
                 "Please use bzrdir.open_workingtree or WorkingTree.open().",
223
225
                 DeprecationWarning,
224
226
                 stacklevel=2)
225
227
            wt = WorkingTree.open(basedir)
226
 
            self.branch = wt.branch
 
228
            self._branch = wt.branch
227
229
            self.basedir = wt.basedir
228
230
            self._control_files = wt._control_files
229
231
            self._hashcache = wt._hashcache
230
 
            self._set_inventory(wt._inventory)
 
232
            self._set_inventory(wt._inventory, dirty=False)
231
233
            self._format = wt._format
232
234
            self.bzrdir = wt.bzrdir
233
235
        from bzrlib.hashcache import HashCache
238
240
        mutter("opening working tree %r", basedir)
239
241
        if deprecated_passed(branch):
240
242
            if not _internal:
241
 
                warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
 
243
                warnings.warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
242
244
                     " Please use bzrdir.open_workingtree() or"
243
245
                     " WorkingTree.open().",
244
246
                     DeprecationWarning,
245
247
                     stacklevel=2
246
248
                     )
247
 
            self.branch = branch
 
249
            self._branch = branch
248
250
        else:
249
 
            self.branch = self.bzrdir.open_branch()
250
 
        assert isinstance(self.branch, Branch), \
251
 
            "branch %r is not a Branch" % self.branch
 
251
            self._branch = self.bzrdir.open_branch()
252
252
        self.basedir = realpath(basedir)
253
253
        # if branch is at our basedir and is a format 6 or less
254
254
        if isinstance(self._format, WorkingTreeFormat2):
255
255
            # share control object
256
256
            self._control_files = self.branch.control_files
257
257
        else:
258
 
            # only ready for format 3
259
 
            assert isinstance(self._format, WorkingTreeFormat3)
 
258
            # assume all other formats have their own control files.
260
259
            assert isinstance(_control_files, LockableFiles), \
261
260
                    "_control_files must be a LockableFiles, not %r" \
262
261
                    % _control_files
267
266
        # if needed, or, when the cache sees a change, append it to the hash
268
267
        # cache file, and have the parser take the most recent entry for a
269
268
        # given path only.
270
 
        cache_filename = self.bzrdir.get_workingtree_transport(None).abspath('stat-cache')
 
269
        cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
271
270
        hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
272
271
        hc.read()
273
272
        # is this scan needed ? it makes things kinda slow.
274
 
        hc.scan()
 
273
        #hc.scan()
275
274
 
276
275
        if hc.needs_write:
277
276
            mutter("write hc")
278
277
            hc.write()
279
278
 
280
279
        if _inventory is None:
281
 
            self._set_inventory(self.read_working_inventory())
 
280
            self._inventory_is_modified = False
 
281
            self.read_working_inventory()
282
282
        else:
283
 
            self._set_inventory(_inventory)
284
 
 
285
 
    def _set_inventory(self, inv):
 
283
            # the caller of __init__ has provided an inventory,
 
284
            # we assume they know what they are doing - as its only
 
285
            # the Format factory and creation methods that are
 
286
            # permitted to do this.
 
287
            self._set_inventory(_inventory, dirty=False)
 
288
 
 
289
    branch = property(
 
290
        fget=lambda self: self._branch,
 
291
        doc="""The branch this WorkingTree is connected to.
 
292
 
 
293
            This cannot be set - it is reflective of the actual disk structure
 
294
            the working tree has been constructed from.
 
295
            """)
 
296
 
 
297
    def break_lock(self):
 
298
        """Break a lock if one is present from another instance.
 
299
 
 
300
        Uses the ui factory to ask for confirmation if the lock may be from
 
301
        an active process.
 
302
 
 
303
        This will probe the repository for its lock as well.
 
304
        """
 
305
        self._control_files.break_lock()
 
306
        self.branch.break_lock()
 
307
 
 
308
    def _set_inventory(self, inv, dirty):
 
309
        """Set the internal cached inventory.
 
310
 
 
311
        :param inv: The inventory to set.
 
312
        :param dirty: A boolean indicating whether the inventory is the same
 
313
            logical inventory as whats on disk. If True the inventory is not
 
314
            the same and should be written to disk or data will be lost, if
 
315
            False then the inventory is the same as that on disk and any
 
316
            serialisation would be unneeded overhead.
 
317
        """
 
318
        assert inv.root is not None
286
319
        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
 
320
        self._inventory_is_modified = dirty
301
321
 
302
322
    @staticmethod
303
323
    def open(path=None, _unsupported=False):
319
339
        run into /.  If there isn't one, raises NotBranchError.
320
340
        TODO: give this a new exception.
321
341
        If there is one, it is returned, along with the unused portion of path.
 
342
 
 
343
        :return: The WorkingTree that contains 'path', and the rest of path
322
344
        """
323
345
        if path is None:
324
 
            path = os.getcwdu()
 
346
            path = osutils.getcwd()
325
347
        control, relpath = bzrdir.BzrDir.open_containing(path)
 
348
 
326
349
        return control.open_workingtree(), relpath
327
350
 
328
351
    @staticmethod
341
364
        """
342
365
        inv = self._inventory
343
366
        for path, ie in inv.iter_entries():
344
 
            if bzrlib.osutils.lexists(self.abspath(path)):
 
367
            if osutils.lexists(self.abspath(path)):
345
368
                yield ie.file_id
346
369
 
347
370
    def __repr__(self):
352
375
        return pathjoin(self.basedir, filename)
353
376
    
354
377
    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:
 
378
        """Return RevisionTree for the current last revision.
 
379
        
 
380
        If the left most parent is a ghost then the returned tree will be an
 
381
        empty tree - one obtained by calling repository.revision_tree(None).
 
382
        """
 
383
        try:
 
384
            revision_id = self.get_parent_ids()[0]
 
385
        except IndexError:
 
386
            # no parents, return an empty revision tree.
 
387
            # in the future this should return the tree for
 
388
            # 'empty:' - the implicit root empty tree.
 
389
            return self.branch.repository.revision_tree(None)
 
390
        else:
358
391
            try:
359
392
                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)
 
393
                inv = xml6.serializer_v6.read_inventory_from_string(xml)
 
394
                if inv is not None and inv.revision_id == revision_id:
 
395
                    return bzrlib.revisiontree.RevisionTree(
 
396
                        self.branch.repository, inv, revision_id)
 
397
            except (NoSuchFile, errors.BadInventoryFormat):
 
398
                pass
 
399
        # No cached copy available, retrieve from the repository.
 
400
        # FIXME? RBC 20060403 should we cache the inventory locally
 
401
        # at this point ?
 
402
        try:
 
403
            return self.branch.repository.revision_tree(revision_id)
 
404
        except errors.RevisionNotPresent:
 
405
            # the basis tree *may* be a ghost or a low level error may have
 
406
            # occured. If the revision is present, its a problem, if its not
 
407
            # its a ghost.
 
408
            if self.branch.repository.has_revision(revision_id):
 
409
                raise
 
410
            # the basis tree is a ghost so return an empty tree.
 
411
            return self.branch.repository.revision_tree(None)
368
412
 
369
413
    @staticmethod
370
414
    @deprecated_method(zero_eight)
383
427
        XXX: When BzrDir is present, these should be created through that 
384
428
        interface instead.
385
429
        """
386
 
        warn('delete WorkingTree.create', stacklevel=3)
 
430
        warnings.warn('delete WorkingTree.create', stacklevel=3)
387
431
        transport = get_transport(directory)
388
432
        if branch.bzrdir.root_transport.base == transport.base:
389
433
            # same dir 
404
448
        """
405
449
        return bzrdir.BzrDir.create_standalone_workingtree(directory)
406
450
 
407
 
    def relpath(self, abs):
408
 
        """Return the local path portion from a given absolute path."""
409
 
        return relpath(self.basedir, abs)
 
451
    def relpath(self, path):
 
452
        """Return the local path portion from a given path.
 
453
        
 
454
        The path may be absolute or relative. If its a relative path it is 
 
455
        interpreted relative to the python current working directory.
 
456
        """
 
457
        return osutils.relpath(self.basedir, path)
410
458
 
411
459
    def has_filename(self, filename):
412
 
        return bzrlib.osutils.lexists(self.abspath(filename))
 
460
        return osutils.lexists(self.abspath(filename))
413
461
 
414
462
    def get_file(self, file_id):
415
463
        return self.get_file_byname(self.id2path(file_id))
416
464
 
 
465
    def get_file_text(self, file_id):
 
466
        return self.get_file(file_id).read()
 
467
 
417
468
    def get_file_byname(self, filename):
418
469
        return file(self.abspath(filename), 'rb')
419
470
 
 
471
    def get_parent_ids(self):
 
472
        """See Tree.get_parent_ids.
 
473
        
 
474
        This implementation reads the pending merges list and last_revision
 
475
        value and uses that to decide what the parents list should be.
 
476
        """
 
477
        last_rev = self._last_revision()
 
478
        if last_rev is None:
 
479
            parents = []
 
480
        else:
 
481
            parents = [last_rev]
 
482
        try:
 
483
            merges_file = self._control_files.get_utf8('pending-merges')
 
484
        except NoSuchFile:
 
485
            pass
 
486
        else:
 
487
            for l in merges_file.readlines():
 
488
                parents.append(l.rstrip('\n'))
 
489
        return parents
 
490
 
 
491
    @needs_read_lock
420
492
    def get_root_id(self):
421
493
        """Return the id of this trees root"""
422
 
        inv = self.read_working_inventory()
423
 
        return inv.root.file_id
 
494
        return self._inventory.root.file_id
424
495
        
425
496
    def _get_store_filename(self, file_id):
426
497
        ## XXX: badly named; this is not in the store at all
452
523
    @needs_read_lock
453
524
    def copy_content_into(self, tree, revision_id=None):
454
525
        """Copy the current content and user files of this tree into tree."""
 
526
        tree.set_root_id(self.get_root_id())
455
527
        if revision_id is None:
456
 
            transform_tree(tree, self)
 
528
            merge.transform_tree(tree, self)
457
529
        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())
 
530
            # TODO now merge from tree.last_revision to revision (to preserve
 
531
            # user local changes)
 
532
            merge.transform_tree(tree, self)
 
533
            tree.set_parent_ids([revision_id])
476
534
 
477
535
    def id2abspath(self, file_id):
478
536
        return self.abspath(self.id2path(file_id))
483
541
        if not inv.has_id(file_id):
484
542
            return False
485
543
        path = inv.id2path(file_id)
486
 
        return bzrlib.osutils.lexists(self.abspath(path))
 
544
        return osutils.lexists(self.abspath(path))
487
545
 
488
546
    def has_or_had_id(self, file_id):
489
547
        if file_id == self.inventory.root.file_id:
496
554
        return os.path.getsize(self.id2abspath(file_id))
497
555
 
498
556
    @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():
 
557
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
558
        if not path:
 
559
            path = self._inventory.id2path(file_id)
 
560
        return self._hashcache.get_sha1(path, stat_value)
 
561
 
 
562
    def get_file_mtime(self, file_id, path=None):
 
563
        if not path:
 
564
            path = self._inventory.id2path(file_id)
 
565
        return os.lstat(self.abspath(path)).st_mtime
 
566
 
 
567
    if not supports_executable():
 
568
        def is_executable(self, file_id, path=None):
505
569
            return self._inventory[file_id].executable
506
 
        else:
507
 
            path = self._inventory.id2path(file_id)
 
570
    else:
 
571
        def is_executable(self, file_id, path=None):
 
572
            if not path:
 
573
                path = self._inventory.id2path(file_id)
508
574
            mode = os.lstat(self.abspath(path)).st_mode
509
 
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
 
575
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
510
576
 
511
577
    @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
 
        """
 
578
    def _add(self, files, ids, kinds):
 
579
        """See MutableTree._add."""
534
580
        # TODO: Re-adding a file that is removed in the working copy
535
581
        # 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
 
 
 
582
        # the read and write working inventory should not occur in this 
 
583
        # function - they should be part of lock_write and unlock.
547
584
        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
 
 
 
585
        for f, file_id, kind in zip(files, ids, kinds):
 
586
            assert kind is not None
571
587
            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))
 
588
                inv.add_path(f, kind=kind)
 
589
            else:
 
590
                inv.add_path(f, kind=kind, file_id=file_id)
576
591
        self._write_inventory(inv)
577
592
 
 
593
    @needs_tree_write_lock
 
594
    def _gather_kinds(self, files, kinds):
 
595
        """See MutableTree._gather_kinds."""
 
596
        for pos, f in enumerate(files):
 
597
            if kinds[pos] is None:
 
598
                fullpath = normpath(self.abspath(f))
 
599
                try:
 
600
                    kinds[pos] = file_kind(fullpath)
 
601
                except OSError, e:
 
602
                    if e.errno == errno.ENOENT:
 
603
                        raise NoSuchFile(fullpath)
 
604
 
578
605
    @needs_write_lock
 
606
    def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
 
607
        """Add revision_id as a parent.
 
608
 
 
609
        This is equivalent to retrieving the current list of parent ids
 
610
        and setting the list to its value plus revision_id.
 
611
 
 
612
        :param revision_id: The revision id to add to the parent list. It may
 
613
        be a ghost revision as long as its not the first parent to be added,
 
614
        or the allow_leftmost_as_ghost parameter is set True.
 
615
        :param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
 
616
        """
 
617
        parents = self.get_parent_ids() + [revision_id]
 
618
        self.set_parent_ids(parents,
 
619
            allow_leftmost_as_ghost=len(parents) > 1 or allow_leftmost_as_ghost)
 
620
 
 
621
    @needs_tree_write_lock
 
622
    def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
 
623
        """Add revision_id, tree tuple as a parent.
 
624
 
 
625
        This is equivalent to retrieving the current list of parent trees
 
626
        and setting the list to its value plus parent_tuple. See also
 
627
        add_parent_tree_id - if you only have a parent id available it will be
 
628
        simpler to use that api. If you have the parent already available, using
 
629
        this api is preferred.
 
630
 
 
631
        :param parent_tuple: The (revision id, tree) to add to the parent list.
 
632
            If the revision_id is a ghost, pass None for the tree.
 
633
        :param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
 
634
        """
 
635
        parent_ids = self.get_parent_ids() + [parent_tuple[0]]
 
636
        if len(parent_ids) > 1:
 
637
            # the leftmost may have already been a ghost, preserve that if it
 
638
            # was.
 
639
            allow_leftmost_as_ghost = True
 
640
        self.set_parent_ids(parent_ids,
 
641
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
642
 
 
643
    @needs_tree_write_lock
579
644
    def add_pending_merge(self, *revision_ids):
580
645
        # TODO: Perhaps should check at this point that the
581
646
        # history of the revision is actually present?
582
 
        p = self.pending_merges()
 
647
        parents = self.get_parent_ids()
583
648
        updated = False
584
649
        for rev_id in revision_ids:
585
 
            if rev_id in p:
 
650
            if rev_id in parents:
586
651
                continue
587
 
            p.append(rev_id)
 
652
            parents.append(rev_id)
588
653
            updated = True
589
654
        if updated:
590
 
            self.set_pending_merges(p)
 
655
            self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
591
656
 
 
657
    @deprecated_method(zero_eleven)
592
658
    @needs_read_lock
593
659
    def pending_merges(self):
594
660
        """Return a list of pending merges.
595
661
 
596
662
        These are revisions that have been merged into the working
597
663
        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
 
664
 
 
665
        As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
 
666
        instead - which is available on all tree objects.
 
667
        """
 
668
        return self.get_parent_ids()[1:]
 
669
 
 
670
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
 
671
        """Common ghost checking functionality from set_parent_*.
 
672
 
 
673
        This checks that the left hand-parent exists if there are any
 
674
        revisions present.
 
675
        """
 
676
        if len(revision_ids) > 0:
 
677
            leftmost_id = revision_ids[0]
 
678
            if (not allow_leftmost_as_ghost and not
 
679
                self.branch.repository.has_revision(leftmost_id)):
 
680
                raise errors.GhostRevisionUnusableHere(leftmost_id)
 
681
 
 
682
    def _set_merges_from_parent_ids(self, parent_ids):
 
683
        merges = parent_ids[1:]
 
684
        self._control_files.put_utf8('pending-merges', '\n'.join(merges))
 
685
 
 
686
    @needs_tree_write_lock
 
687
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
 
688
        """Set the parent ids to revision_ids.
 
689
        
 
690
        See also set_parent_trees. This api will try to retrieve the tree data
 
691
        for each element of revision_ids from the trees repository. If you have
 
692
        tree data already available, it is more efficient to use
 
693
        set_parent_trees rather than set_parent_ids. set_parent_ids is however
 
694
        an easier API to use.
 
695
 
 
696
        :param revision_ids: The revision_ids to set as the parent ids of this
 
697
            working tree. Any of these may be ghosts.
 
698
        """
 
699
        self._check_parents_for_ghosts(revision_ids,
 
700
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
701
 
 
702
        if len(revision_ids) > 0:
 
703
            self.set_last_revision(revision_ids[0])
 
704
        else:
 
705
            self.set_last_revision(None)
 
706
 
 
707
        self._set_merges_from_parent_ids(revision_ids)
 
708
 
 
709
    @needs_tree_write_lock
 
710
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
 
711
        """See MutableTree.set_parent_trees."""
 
712
        parent_ids = [rev for (rev, tree) in parents_list]
 
713
 
 
714
        self._check_parents_for_ghosts(parent_ids,
 
715
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
716
 
 
717
        if len(parent_ids) == 0:
 
718
            leftmost_parent_id = None
 
719
            leftmost_parent_tree = None
 
720
        else:
 
721
            leftmost_parent_id, leftmost_parent_tree = parents_list[0]
 
722
 
 
723
        if self._change_last_revision(leftmost_parent_id):
 
724
            if leftmost_parent_tree is None:
 
725
                # If we don't have a tree, fall back to reading the
 
726
                # parent tree from the repository.
 
727
                self._cache_basis_inventory(leftmost_parent_id)
 
728
            else:
 
729
                inv = leftmost_parent_tree.inventory
 
730
                xml = self._create_basis_xml_from_inventory(
 
731
                                        leftmost_parent_id, inv)
 
732
                self._write_basis_inventory(xml)
 
733
        self._set_merges_from_parent_ids(parent_ids)
 
734
 
 
735
    @needs_tree_write_lock
611
736
    def set_pending_merges(self, rev_list):
612
 
        self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
 
737
        parents = self.get_parent_ids()
 
738
        leftmost = parents[:1]
 
739
        new_parents = leftmost + rev_list
 
740
        self.set_parent_ids(new_parents)
613
741
 
614
 
    @needs_write_lock
 
742
    @needs_tree_write_lock
615
743
    def set_merge_modified(self, modified_hashes):
616
744
        def iter_stanzas():
617
745
            for file_id, hash in modified_hashes.iteritems():
618
746
                yield Stanza(file_id=file_id, hash=hash)
619
747
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
620
748
 
621
 
    @needs_write_lock
 
749
    @needs_tree_write_lock
622
750
    def _put_rio(self, filename, stanzas, header):
623
751
        my_file = rio_file(stanzas, header)
624
752
        self._control_files.put(filename, my_file)
625
753
 
 
754
    @needs_write_lock # because merge pulls data into the branch.
 
755
    def merge_from_branch(self, branch, to_revision=None):
 
756
        """Merge from a branch into this working tree.
 
757
 
 
758
        :param branch: The branch to merge from.
 
759
        :param to_revision: If non-None, the merge will merge to to_revision, but 
 
760
            not beyond it. to_revision does not need to be in the history of
 
761
            the branch when it is supplied. If None, to_revision defaults to
 
762
            branch.last_revision().
 
763
        """
 
764
        from bzrlib.merge import Merger, Merge3Merger
 
765
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
766
        try:
 
767
            merger = Merger(self.branch, this_tree=self, pb=pb)
 
768
            merger.pp = ProgressPhase("Merge phase", 5, pb)
 
769
            merger.pp.next_phase()
 
770
            # check that there are no
 
771
            # local alterations
 
772
            merger.check_basis(check_clean=True, require_commits=False)
 
773
            if to_revision is None:
 
774
                to_revision = branch.last_revision()
 
775
            merger.other_rev_id = to_revision
 
776
            if merger.other_rev_id is None:
 
777
                raise error.NoCommits(branch)
 
778
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
779
            merger.other_basis = merger.other_rev_id
 
780
            merger.other_tree = self.branch.repository.revision_tree(
 
781
                merger.other_rev_id)
 
782
            merger.pp.next_phase()
 
783
            merger.find_base()
 
784
            if merger.base_rev_id == merger.other_rev_id:
 
785
                raise errors.PointlessMerge
 
786
            merger.backup_files = False
 
787
            merger.merge_type = Merge3Merger
 
788
            merger.set_interesting_files(None)
 
789
            merger.show_base = False
 
790
            merger.reprocess = False
 
791
            conflicts = merger.do_merge()
 
792
            merger.set_pending()
 
793
        finally:
 
794
            pb.finished()
 
795
        return conflicts
 
796
 
626
797
    @needs_read_lock
627
798
    def merge_modified(self):
628
799
        try:
644
815
                merge_hashes[file_id] = hash
645
816
        return merge_hashes
646
817
 
 
818
    @needs_write_lock
 
819
    def mkdir(self, path, file_id=None):
 
820
        """See MutableTree.mkdir()."""
 
821
        if file_id is None:
 
822
            file_id = generate_ids.gen_file_id(os.path.basename(path))
 
823
        os.mkdir(self.abspath(path))
 
824
        self.add(path, file_id, 'directory')
 
825
        return file_id
 
826
 
647
827
    def get_symlink_target(self, file_id):
648
828
        return os.readlink(self.id2abspath(file_id))
649
829
 
655
835
        else:
656
836
            return '?'
657
837
 
658
 
    def list_files(self):
659
 
        """Recursively list all files as (path, class, kind, id).
 
838
    def flush(self):
 
839
        """Write the in memory inventory to disk."""
 
840
        # TODO: Maybe this should only write on dirty ?
 
841
        if self._control_files._lock_mode != 'w':
 
842
            raise errors.NotWriteLocked(self)
 
843
        sio = StringIO()
 
844
        xml5.serializer_v5.write_inventory(self._inventory, sio)
 
845
        sio.seek(0)
 
846
        self._control_files.put('inventory', sio)
 
847
        self._inventory_is_modified = False
 
848
 
 
849
    def list_files(self, include_root=False):
 
850
        """Recursively list all files as (path, class, kind, id, entry).
660
851
 
661
852
        Lists, but does not descend into unversioned directories.
662
853
 
666
857
        Skips the control directory.
667
858
        """
668
859
        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:
 
860
        if include_root is True:
 
861
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
 
862
        # Convert these into local objects to save lookup times
 
863
        pathjoin = osutils.pathjoin
 
864
        file_kind = osutils.file_kind
 
865
 
 
866
        # transport.base ends in a slash, we want the piece
 
867
        # between the last two slashes
 
868
        transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
 
869
 
 
870
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
 
871
 
 
872
        # directory file_id, relative path, absolute path, reverse sorted children
 
873
        children = os.listdir(self.basedir)
 
874
        children.sort()
 
875
        # jam 20060527 The kernel sized tree seems equivalent whether we 
 
876
        # use a deque and popleft to keep them sorted, or if we use a plain
 
877
        # list and just reverse() them.
 
878
        children = collections.deque(children)
 
879
        stack = [(inv.root.file_id, u'', self.basedir, children)]
 
880
        while stack:
 
881
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
 
882
 
 
883
            while children:
 
884
                f = children.popleft()
674
885
                ## TODO: If we find a subdirectory with its own .bzr
675
886
                ## directory, then that is a separate tree and we
676
887
                ## should exclude it.
677
888
 
678
889
                # the bzrdir for this tree
679
 
                if self.bzrdir.transport.base.endswith(f + '/'):
 
890
                if transport_base_dir == f:
680
891
                    continue
681
892
 
682
 
                # path within tree
683
 
                fp = appendpath(from_dir_relpath, f)
 
893
                # we know that from_dir_relpath and from_dir_abspath never end in a slash
 
894
                # and 'f' doesn't begin with one, we can do a string op, rather
 
895
                # than the checks of pathjoin(), all relative paths will have an extra slash
 
896
                # at the beginning
 
897
                fp = from_dir_relpath + '/' + f
684
898
 
685
899
                # absolute path
686
 
                fap = appendpath(dp, f)
 
900
                fap = from_dir_abspath + '/' + f
687
901
                
688
902
                f_ie = inv.get_child(from_dir_id, f)
689
903
                if f_ie:
690
904
                    c = 'V'
691
 
                elif self.is_ignored(fp):
 
905
                elif self.is_ignored(fp[1:]):
692
906
                    c = 'I'
693
907
                else:
694
 
                    c = '?'
 
908
                    # we may not have found this file, because of a unicode issue
 
909
                    f_norm, can_access = osutils.normalized_filename(f)
 
910
                    if f == f_norm or not can_access:
 
911
                        # No change, so treat this file normally
 
912
                        c = '?'
 
913
                    else:
 
914
                        # this file can be accessed by a normalized path
 
915
                        # check again if it is versioned
 
916
                        # these lines are repeated here for performance
 
917
                        f = f_norm
 
918
                        fp = from_dir_relpath + '/' + f
 
919
                        fap = from_dir_abspath + '/' + f
 
920
                        f_ie = inv.get_child(from_dir_id, f)
 
921
                        if f_ie:
 
922
                            c = 'V'
 
923
                        elif self.is_ignored(fp[1:]):
 
924
                            c = 'I'
 
925
                        else:
 
926
                            c = '?'
695
927
 
696
928
                fk = file_kind(fap)
697
929
 
703
935
 
704
936
                # make a last minute entry
705
937
                if f_ie:
706
 
                    entry = f_ie
 
938
                    yield fp[1:], c, fk, f_ie.file_id, f_ie
707
939
                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()
 
940
                    try:
 
941
                        yield fp[1:], c, fk, None, fk_entries[fk]()
 
942
                    except KeyError:
 
943
                        yield fp[1:], c, fk, None, TreeEntry()
 
944
                    continue
716
945
                
717
 
                yield fp, c, fk, (f_ie and f_ie.file_id), entry
718
 
 
719
946
                if fk != 'directory':
720
947
                    continue
721
948
 
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
 
949
                # But do this child first
 
950
                new_children = os.listdir(fap)
 
951
                new_children.sort()
 
952
                new_children = collections.deque(new_children)
 
953
                stack.append((f_ie.file_id, fp, fap, new_children))
 
954
                # Break out of inner loop, so that we start outer loop with child
 
955
                break
 
956
            else:
 
957
                # if we finished all children, pop it off the stack
 
958
                stack.pop()
 
959
 
 
960
    @needs_tree_write_lock
733
961
    def move(self, from_paths, to_name):
734
962
        """Rename files.
735
963
 
754
982
        if not self.has_filename(to_name):
755
983
            raise BzrError("destination %r not in working directory" % to_abs)
756
984
        to_dir_id = inv.path2id(to_name)
757
 
        if to_dir_id == None and to_name != '':
 
985
        if to_dir_id is None and to_name != '':
758
986
            raise BzrError("destination %r is not a versioned directory" % to_name)
759
987
        to_dir_ie = inv[to_dir_id]
760
 
        if to_dir_ie.kind not in ('directory', 'root_directory'):
 
988
        if to_dir_ie.kind != 'directory':
761
989
            raise BzrError("destination %r is not a directory" % to_abs)
762
990
 
763
991
        to_idpath = inv.get_idpath(to_dir_id)
766
994
            if not self.has_filename(f):
767
995
                raise BzrError("%r does not exist in working tree" % f)
768
996
            f_id = inv.path2id(f)
769
 
            if f_id == None:
 
997
            if f_id is None:
770
998
                raise BzrError("%r is not versioned" % f)
771
999
            name_tail = splitpath(f)[-1]
772
 
            dest_path = appendpath(to_name, name_tail)
 
1000
            dest_path = pathjoin(to_name, name_tail)
773
1001
            if self.has_filename(dest_path):
774
1002
                raise BzrError("destination %r already exists" % dest_path)
775
1003
            if f_id in to_idpath:
779
1007
        # create a file in this interval and then the rename might be
780
1008
        # left half-done.  But we should have caught most problems.
781
1009
        orig_inv = deepcopy(self.inventory)
 
1010
        original_modified = self._inventory_is_modified
782
1011
        try:
 
1012
            if len(from_paths):
 
1013
                self._inventory_is_modified = True
783
1014
            for f in from_paths:
784
1015
                name_tail = splitpath(f)[-1]
785
 
                dest_path = appendpath(to_name, name_tail)
 
1016
                dest_path = pathjoin(to_name, name_tail)
786
1017
                result.append((f, dest_path))
787
1018
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
788
1019
                try:
789
 
                    rename(self.abspath(f), self.abspath(dest_path))
 
1020
                    osutils.rename(self.abspath(f), self.abspath(dest_path))
790
1021
                except OSError, e:
791
1022
                    raise BzrError("failed to rename %r to %r: %s" %
792
 
                                   (f, dest_path, e[1]),
793
 
                            ["rename rolled back"])
 
1023
                                   (f, dest_path, e[1]))
794
1024
        except:
795
1025
            # restore the inventory on error
796
 
            self._set_inventory(orig_inv)
 
1026
            self._set_inventory(orig_inv, dirty=original_modified)
797
1027
            raise
798
1028
        self._write_inventory(inv)
799
1029
        return result
800
1030
 
801
 
    @needs_write_lock
 
1031
    @needs_tree_write_lock
802
1032
    def rename_one(self, from_rel, to_rel):
803
1033
        """Rename one file.
804
1034
 
811
1041
            raise BzrError("can't rename: new working file %r already exists" % to_rel)
812
1042
 
813
1043
        file_id = inv.path2id(from_rel)
814
 
        if file_id == None:
 
1044
        if file_id is None:
815
1045
            raise BzrError("can't rename: old name %r is not versioned" % from_rel)
816
1046
 
817
1047
        entry = inv[file_id]
823
1053
 
824
1054
        to_dir, to_tail = os.path.split(to_rel)
825
1055
        to_dir_id = inv.path2id(to_dir)
826
 
        if to_dir_id == None and to_dir != '':
 
1056
        if to_dir_id is None and to_dir != '':
827
1057
            raise BzrError("can't determine destination directory id for %r" % to_dir)
828
1058
 
829
1059
        mutter("rename_one:")
838
1068
        from_abs = self.abspath(from_rel)
839
1069
        to_abs = self.abspath(to_rel)
840
1070
        try:
841
 
            rename(from_abs, to_abs)
 
1071
            osutils.rename(from_abs, to_abs)
842
1072
        except OSError, e:
843
1073
            inv.rename(file_id, from_parent, from_name)
844
1074
            raise BzrError("failed to rename %r to %r: %s"
845
 
                    % (from_abs, to_abs, e[1]),
846
 
                    ["rename rolled back"])
 
1075
                    % (from_abs, to_abs, e[1]))
847
1076
        self._write_inventory(inv)
848
1077
 
849
1078
    @needs_read_lock
852
1081
 
853
1082
        These are files in the working directory that are not versioned or
854
1083
        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
1084
        """
869
1085
        for subp in self.extras():
870
1086
            if not self.is_ignored(subp):
871
1087
                yield subp
872
 
 
 
1088
    
 
1089
    @needs_tree_write_lock
 
1090
    def unversion(self, file_ids):
 
1091
        """Remove the file ids in file_ids from the current versioned set.
 
1092
 
 
1093
        When a file_id is unversioned, all of its children are automatically
 
1094
        unversioned.
 
1095
 
 
1096
        :param file_ids: The file ids to stop versioning.
 
1097
        :raises: NoSuchId if any fileid is not currently versioned.
 
1098
        """
 
1099
        for file_id in file_ids:
 
1100
            if self._inventory.has_id(file_id):
 
1101
                self._inventory.remove_recursive_id(file_id)
 
1102
            else:
 
1103
                raise errors.NoSuchId(self, file_id)
 
1104
        if len(file_ids):
 
1105
            # in the future this should just set a dirty bit to wait for the 
 
1106
            # final unlock. However, until all methods of workingtree start
 
1107
            # with the current in -memory inventory rather than triggering 
 
1108
            # a read, it is more complex - we need to teach read_inventory
 
1109
            # to know when to read, and when to not read first... and possibly
 
1110
            # to save first when the in memory one may be corrupted.
 
1111
            # so for now, we just only write it if it is indeed dirty.
 
1112
            # - RBC 20060907
 
1113
            self._write_inventory(self._inventory)
 
1114
    
873
1115
    @deprecated_method(zero_eight)
874
1116
    def iter_conflicts(self):
875
1117
        """List all files in the tree that have text or content conflicts.
878
1120
 
879
1121
    def _iter_conflicts(self):
880
1122
        conflicted = set()
881
 
        for path in (s[0] for s in self.list_files()):
 
1123
        for info in self.list_files():
 
1124
            path = info[0]
882
1125
            stem = get_conflicted_stem(path)
883
1126
            if stem is None:
884
1127
                continue
906
1149
                repository = self.branch.repository
907
1150
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
908
1151
                try:
909
 
                    merge_inner(self.branch,
910
 
                                self.branch.basis_tree(),
911
 
                                basis_tree, 
912
 
                                this_tree=self, 
 
1152
                    new_basis_tree = self.branch.basis_tree()
 
1153
                    merge.merge_inner(
 
1154
                                self.branch,
 
1155
                                new_basis_tree,
 
1156
                                basis_tree,
 
1157
                                this_tree=self,
913
1158
                                pb=pb)
 
1159
                    if (basis_tree.inventory.root is None and
 
1160
                        new_basis_tree.inventory.root is not None):
 
1161
                        self.set_root_id(new_basis_tree.inventory.root.file_id)
914
1162
                finally:
915
1163
                    pb.finished()
916
 
                self.set_last_revision(self.branch.last_revision())
 
1164
                # TODO - dedup parents list with things merged by pull ?
 
1165
                # reuse the revisiontree we merged against to set the new
 
1166
                # tree data.
 
1167
                parent_trees = [(self.branch.last_revision(), new_basis_tree)]
 
1168
                # we have to pull the merge trees out again, because 
 
1169
                # merge_inner has set the ids. - this corner is not yet 
 
1170
                # layered well enough to prevent double handling.
 
1171
                merges = self.get_parent_ids()[1:]
 
1172
                parent_trees.extend([
 
1173
                    (parent, repository.revision_tree(parent)) for
 
1174
                     parent in merges])
 
1175
                self.set_parent_trees(parent_trees)
917
1176
            return count
918
1177
        finally:
919
1178
            source.unlock()
920
1179
            top_pb.finished()
921
1180
 
 
1181
    @needs_write_lock
 
1182
    def put_file_bytes_non_atomic(self, file_id, bytes):
 
1183
        """See MutableTree.put_file_bytes_non_atomic."""
 
1184
        stream = file(self.id2abspath(file_id), 'wb')
 
1185
        try:
 
1186
            stream.write(bytes)
 
1187
        finally:
 
1188
            stream.close()
 
1189
        # TODO: update the hashcache here ?
 
1190
 
922
1191
    def extras(self):
923
1192
        """Yield all unknown files in this WorkingTree.
924
1193
 
930
1199
        """
931
1200
        ## TODO: Work from given directory downwards
932
1201
        for path, dir_entry in self.inventory.directories():
933
 
            mutter("search for unknowns in %r", path)
 
1202
            # mutter("search for unknowns in %r", path)
934
1203
            dirabs = self.abspath(path)
935
1204
            if not isdir(dirabs):
936
1205
                # e.g. directory deleted
938
1207
 
939
1208
            fl = []
940
1209
            for subf in os.listdir(dirabs):
941
 
                if (subf != '.bzr'
942
 
                    and (subf not in dir_entry.children)):
943
 
                    fl.append(subf)
 
1210
                if subf == '.bzr':
 
1211
                    continue
 
1212
                if subf not in dir_entry.children:
 
1213
                    subf_norm, can_access = osutils.normalized_filename(subf)
 
1214
                    if subf_norm != subf and can_access:
 
1215
                        if subf_norm not in dir_entry.children:
 
1216
                            fl.append(subf_norm)
 
1217
                    else:
 
1218
                        fl.append(subf)
944
1219
            
945
1220
            fl.sort()
946
1221
            for subf in fl:
947
 
                subp = appendpath(path, subf)
 
1222
                subp = pathjoin(path, subf)
948
1223
                yield subp
949
1224
 
950
1225
 
952
1227
        """Yield list of PATH, IGNORE_PATTERN"""
953
1228
        for subp in self.extras():
954
1229
            pat = self.is_ignored(subp)
955
 
            if pat != None:
 
1230
            if pat is not None:
956
1231
                yield subp, pat
957
1232
 
958
 
 
959
1233
    def get_ignore_list(self):
960
1234
        """Return list of ignore patterns.
961
1235
 
962
1236
        Cached in the Tree object after the first call.
963
1237
        """
964
 
        if hasattr(self, '_ignorelist'):
965
 
            return self._ignorelist
 
1238
        ignoreset = getattr(self, '_ignoreset', None)
 
1239
        if ignoreset is not None:
 
1240
            return ignoreset
966
1241
 
967
 
        l = bzrlib.DEFAULT_IGNORE[:]
 
1242
        ignore_globs = set(bzrlib.DEFAULT_IGNORE)
 
1243
        ignore_globs.update(ignores.get_runtime_ignores())
 
1244
        ignore_globs.update(ignores.get_user_ignores())
968
1245
        if self.has_filename(bzrlib.IGNORE_FILENAME):
969
1246
            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
 
1247
            try:
 
1248
                ignore_globs.update(ignores.parse_ignore_file(f))
 
1249
            finally:
 
1250
                f.close()
 
1251
        self._ignoreset = ignore_globs
 
1252
        return ignore_globs
973
1253
 
 
1254
    def _flush_ignore_list_cache(self):
 
1255
        """Resets the cached ignore list to force a cache rebuild."""
 
1256
        self._ignoreset = None
 
1257
        self._ignoreglobster = None
974
1258
 
975
1259
    def is_ignored(self, filename):
976
1260
        r"""Check whether the filename matches an ignore pattern.
981
1265
        If the file is ignored, returns the pattern which caused it to
982
1266
        be ignored, otherwise None.  So this can simply be used as a
983
1267
        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
 
1268
        if getattr(self, '_ignoreglobster', None) is None:
 
1269
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
 
1270
        return self._ignoreglobster.match(filename)
1012
1271
 
1013
1272
    def kind(self, file_id):
1014
1273
        return file_kind(self.id2abspath(file_id))
1015
1274
 
1016
 
    @needs_read_lock
 
1275
    def _comparison_data(self, entry, path):
 
1276
        abspath = self.abspath(path)
 
1277
        try:
 
1278
            stat_value = os.lstat(abspath)
 
1279
        except OSError, e:
 
1280
            if getattr(e, 'errno', None) == errno.ENOENT:
 
1281
                stat_value = None
 
1282
                kind = None
 
1283
                executable = False
 
1284
            else:
 
1285
                raise
 
1286
        else:
 
1287
            mode = stat_value.st_mode
 
1288
            kind = osutils.file_kind_from_stat_mode(mode)
 
1289
            if not supports_executable():
 
1290
                executable = entry.executable
 
1291
            else:
 
1292
                executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
 
1293
        return kind, executable, stat_value
 
1294
 
 
1295
    def _file_size(self, entry, stat_value):
 
1296
        return stat_value.st_size
 
1297
 
1017
1298
    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().
 
1299
        """Return the last revision of the branch for this tree.
 
1300
 
 
1301
        This format tree does not support a separate marker for last-revision
 
1302
        compared to the branch.
 
1303
 
 
1304
        See MutableTree.last_revision
1023
1305
        """
 
1306
        return self._last_revision()
 
1307
 
 
1308
    @needs_read_lock
 
1309
    def _last_revision(self):
 
1310
        """helper for get_parent_ids."""
1024
1311
        return self.branch.last_revision()
1025
1312
 
 
1313
    def is_locked(self):
 
1314
        return self._control_files.is_locked()
 
1315
 
1026
1316
    def lock_read(self):
1027
1317
        """See Branch.lock_read, and WorkingTree.unlock."""
1028
1318
        self.branch.lock_read()
1032
1322
            self.branch.unlock()
1033
1323
            raise
1034
1324
 
 
1325
    def lock_tree_write(self):
 
1326
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
 
1327
        self.branch.lock_read()
 
1328
        try:
 
1329
            return self._control_files.lock_write()
 
1330
        except:
 
1331
            self.branch.unlock()
 
1332
            raise
 
1333
 
1035
1334
    def lock_write(self):
1036
 
        """See Branch.lock_write, and WorkingTree.unlock."""
 
1335
        """See MutableTree.lock_write, and WorkingTree.unlock."""
1037
1336
        self.branch.lock_write()
1038
1337
        try:
1039
1338
            return self._control_files.lock_write()
1041
1340
            self.branch.unlock()
1042
1341
            raise
1043
1342
 
 
1343
    def get_physical_lock_status(self):
 
1344
        return self._control_files.get_physical_lock_status()
 
1345
 
1044
1346
    def _basis_inventory_name(self):
1045
 
        return 'basis-inventory'
 
1347
        return 'basis-inventory-cache'
1046
1348
 
1047
 
    @needs_write_lock
 
1349
    @needs_tree_write_lock
1048
1350
    def set_last_revision(self, new_revision):
1049
1351
        """Change the last revision in the working tree."""
1050
1352
        if self._change_last_revision(new_revision):
1059
1361
        if new_revision is None:
1060
1362
            self.branch.set_revision_history([])
1061
1363
            return False
1062
 
        # current format is locked in with the branch
1063
 
        revision_history = self.branch.revision_history()
1064
1364
        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])
 
1365
            self.branch.generate_revision_history(new_revision)
 
1366
        except errors.NoSuchRevision:
 
1367
            # not present in the repo - dont try to set it deeper than the tip
 
1368
            self.branch.set_revision_history([new_revision])
1069
1369
        return True
1070
1370
 
 
1371
    def _write_basis_inventory(self, xml):
 
1372
        """Write the basis inventory XML to the basis-inventory file"""
 
1373
        assert isinstance(xml, str), 'serialised xml must be bytestring.'
 
1374
        path = self._basis_inventory_name()
 
1375
        sio = StringIO(xml)
 
1376
        self._control_files.put(path, sio)
 
1377
 
 
1378
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
 
1379
        """Create the text that will be saved in basis-inventory"""
 
1380
        inventory.revision_id = revision_id
 
1381
        return xml6.serializer_v6.write_inventory_to_string(inventory)
 
1382
 
1071
1383
    def _cache_basis_inventory(self, new_revision):
1072
1384
        """Cache new_revision as the basis inventory."""
 
1385
        # TODO: this should allow the ready-to-use inventory to be passed in,
 
1386
        # as commit already has that ready-to-use [while the format is the
 
1387
        # same, that is].
1073
1388
        try:
1074
1389
            # this double handles the inventory - unpack and repack - 
1075
1390
            # but is easier to understand. We can/should put a conditional
1076
1391
            # in here based on whether the inventory is in the latest format
1077
1392
            # - perhaps we should repack all inventories on a repository
1078
1393
            # 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:
 
1394
            # the fast path is to copy the raw xml from the repository. If the
 
1395
            # xml contains 'revision_id="', then we assume the right 
 
1396
            # revision_id is set. We must check for this full string, because a
 
1397
            # root node id can legitimately look like 'revision_id' but cannot
 
1398
            # contain a '"'.
 
1399
            xml = self.branch.repository.get_inventory_xml(new_revision)
 
1400
            firstline = xml.split('\n', 1)[0]
 
1401
            if (not 'revision_id="' in firstline or 
 
1402
                'format="6"' not in firstline):
 
1403
                inv = self.branch.repository.deserialise_inventory(
 
1404
                    new_revision, xml)
 
1405
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
 
1406
            self._write_basis_inventory(xml)
 
1407
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1086
1408
            pass
1087
1409
 
1088
1410
    def read_basis_inventory(self):
1089
1411
        """Read the cached basis inventory."""
1090
1412
        path = self._basis_inventory_name()
1091
 
        return self._control_files.get_utf8(path).read()
 
1413
        return self._control_files.get(path).read()
1092
1414
        
1093
1415
    @needs_read_lock
1094
1416
    def read_working_inventory(self):
1095
 
        """Read the working inventory."""
 
1417
        """Read the working inventory.
 
1418
        
 
1419
        :raises errors.InventoryModified: read_working_inventory will fail
 
1420
            when the current in memory inventory has been modified.
 
1421
        """
 
1422
        # conceptually this should be an implementation detail of the tree. 
 
1423
        # XXX: Deprecate this.
1096
1424
        # ElementTree does its own conversion from UTF-8, so open in
1097
1425
        # binary.
1098
 
        result = bzrlib.xml5.serializer_v5.read_inventory(
 
1426
        if self._inventory_is_modified:
 
1427
            raise errors.InventoryModified(self)
 
1428
        result = xml5.serializer_v5.read_inventory(
1099
1429
            self._control_files.get('inventory'))
1100
 
        self._set_inventory(result)
 
1430
        self._set_inventory(result, dirty=False)
1101
1431
        return result
1102
1432
 
1103
 
    @needs_write_lock
1104
 
    def remove(self, files, verbose=False):
 
1433
    @needs_tree_write_lock
 
1434
    def remove(self, files, verbose=False, to_file=None):
1105
1435
        """Remove nominated files from the working inventory..
1106
1436
 
1107
1437
        This does not remove their text.  This does not run on XXX on what? RBC
1129
1459
                # TODO: Perhaps make this just a warning, and continue?
1130
1460
                # This tends to happen when 
1131
1461
                raise NotVersionedError(path=f)
1132
 
            mutter("remove inventory entry %s {%s}", quotefn(f), fid)
1133
1462
            if verbose:
1134
1463
                # having remove it, it must be either ignored or unknown
1135
1464
                if self.is_ignored(f):
1136
1465
                    new_status = 'I'
1137
1466
                else:
1138
1467
                    new_status = '?'
1139
 
                show_status(new_status, inv[fid].kind, quotefn(f))
 
1468
                textui.show_status(new_status, inv[fid].kind, f,
 
1469
                                   to_file=to_file)
1140
1470
            del inv[fid]
1141
1471
 
1142
1472
        self._write_inventory(inv)
1143
1473
 
1144
 
    @needs_write_lock
 
1474
    @needs_tree_write_lock
1145
1475
    def revert(self, filenames, old_tree=None, backups=True, 
1146
1476
               pb=DummyProgress()):
1147
 
        from transform import revert
1148
 
        from conflicts import resolve
 
1477
        from bzrlib.conflicts import resolve
1149
1478
        if old_tree is None:
1150
1479
            old_tree = self.basis_tree()
1151
 
        conflicts = revert(self, old_tree, filenames, backups, pb)
 
1480
        conflicts = transform.revert(self, old_tree, filenames, backups, pb)
1152
1481
        if not len(filenames):
1153
 
            self.set_pending_merges([])
 
1482
            self.set_parent_ids(self.get_parent_ids()[:1])
1154
1483
            resolve(self)
1155
1484
        else:
1156
1485
            resolve(self, filenames, ignore_misses=True)
1158
1487
 
1159
1488
    # XXX: This method should be deprecated in favour of taking in a proper
1160
1489
    # new Inventory object.
1161
 
    @needs_write_lock
 
1490
    @needs_tree_write_lock
1162
1491
    def set_inventory(self, new_inventory_list):
1163
1492
        from bzrlib.inventory import (Inventory,
1164
1493
                                      InventoryDirectory,
1181
1510
                raise BzrError("unknown kind %r" % kind)
1182
1511
        self._write_inventory(inv)
1183
1512
 
1184
 
    @needs_write_lock
 
1513
    @needs_tree_write_lock
1185
1514
    def set_root_id(self, file_id):
1186
1515
        """Set the root id for this tree."""
1187
 
        inv = self.read_working_inventory()
 
1516
        # for compatability 
 
1517
        if file_id is None:
 
1518
            symbol_versioning.warn(symbol_versioning.zero_twelve
 
1519
                % 'WorkingTree.set_root_id with fileid=None',
 
1520
                DeprecationWarning,
 
1521
                stacklevel=3)
 
1522
            file_id = ROOT_ID
 
1523
        inv = self._inventory
1188
1524
        orig_root_id = inv.root.file_id
 
1525
        # TODO: it might be nice to exit early if there was nothing
 
1526
        # to do, saving us from trigger a sync on unlock.
 
1527
        self._inventory_is_modified = True
 
1528
        # we preserve the root inventory entry object, but
 
1529
        # unlinkit from the byid index
1189
1530
        del inv._byid[inv.root.file_id]
1190
1531
        inv.root.file_id = file_id
 
1532
        # and link it into the index with the new changed id.
1191
1533
        inv._byid[inv.root.file_id] = inv.root
 
1534
        # and finally update all children to reference the new id.
 
1535
        # XXX: this should be safe to just look at the root.children
 
1536
        # list, not the WHOLE INVENTORY.
1192
1537
        for fid in inv:
1193
1538
            entry = inv[fid]
1194
1539
            if entry.parent_id == orig_root_id:
1195
1540
                entry.parent_id = inv.root.file_id
1196
 
        self._write_inventory(inv)
1197
1541
 
1198
1542
    def unlock(self):
1199
1543
        """See Branch.unlock.
1204
1548
        between multiple working trees, i.e. via shared storage, then we 
1205
1549
        would probably want to lock both the local tree, and the branch.
1206
1550
        """
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
 
1551
        raise NotImplementedError(self.unlock)
1229
1552
 
1230
 
    @needs_write_lock
1231
1553
    def update(self):
1232
1554
        """Update a working tree along its branch.
1233
1555
 
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.
 
1556
        This will update the branch if its bound too, which means we have
 
1557
        multiple trees involved:
 
1558
 
 
1559
        - The new basis tree of the master.
 
1560
        - The old basis tree of the branch.
 
1561
        - The old basis tree of the working tree.
 
1562
        - The current working tree state.
 
1563
 
 
1564
        Pathologically, all three may be different, and non-ancestors of each
 
1565
        other.  Conceptually we want to:
 
1566
 
 
1567
        - Preserve the wt.basis->wt.state changes
 
1568
        - Transform the wt.basis to the new master basis.
 
1569
        - Apply a merge of the old branch basis to get any 'local' changes from
 
1570
          it into the tree.
 
1571
        - Restore the wt.basis->wt.state changes.
1245
1572
 
1246
1573
        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.
 
1574
        - Merge current state -> basis tree of the master w.r.t. the old tree
 
1575
          basis.
 
1576
        - Do a 'normal' merge of the old branch basis if it is relevant.
1249
1577
        """
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()
 
1578
        if self.branch.get_master_branch() is not None:
 
1579
            self.lock_write()
 
1580
            update_branch = True
 
1581
        else:
 
1582
            self.lock_tree_write()
 
1583
            update_branch = False
1254
1584
        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
 
1585
            if update_branch:
 
1586
                old_tip = self.branch.update()
 
1587
            else:
 
1588
                old_tip = None
 
1589
            return self._update_tree(old_tip)
1284
1590
        finally:
1285
 
            self.branch.unlock()
1286
 
 
1287
 
    @needs_write_lock
 
1591
            self.unlock()
 
1592
 
 
1593
    @needs_tree_write_lock
 
1594
    def _update_tree(self, old_tip=None):
 
1595
        """Update a tree to the master branch.
 
1596
 
 
1597
        :param old_tip: if supplied, the previous tip revision the branch,
 
1598
            before it was changed to the master branch's tip.
 
1599
        """
 
1600
        # here if old_tip is not None, it is the old tip of the branch before
 
1601
        # it was updated from the master branch. This should become a pending
 
1602
        # merge in the working tree to preserve the user existing work.  we
 
1603
        # cant set that until we update the working trees last revision to be
 
1604
        # one from the new branch, because it will just get absorbed by the
 
1605
        # parent de-duplication logic.
 
1606
        # 
 
1607
        # We MUST save it even if an error occurs, because otherwise the users
 
1608
        # local work is unreferenced and will appear to have been lost.
 
1609
        # 
 
1610
        result = 0
 
1611
        try:
 
1612
            last_rev = self.get_parent_ids()[0]
 
1613
        except IndexError:
 
1614
            last_rev = None
 
1615
        if last_rev != self.branch.last_revision():
 
1616
            # merge tree state up to new branch tip.
 
1617
            basis = self.basis_tree()
 
1618
            to_tree = self.branch.basis_tree()
 
1619
            if basis.inventory.root is None:
 
1620
                self.set_root_id(to_tree.inventory.root.file_id)
 
1621
            result += merge.merge_inner(
 
1622
                                  self.branch,
 
1623
                                  to_tree,
 
1624
                                  basis,
 
1625
                                  this_tree=self)
 
1626
            # TODO - dedup parents list with things merged by pull ?
 
1627
            # reuse the tree we've updated to to set the basis:
 
1628
            parent_trees = [(self.branch.last_revision(), to_tree)]
 
1629
            merges = self.get_parent_ids()[1:]
 
1630
            # Ideally we ask the tree for the trees here, that way the working
 
1631
            # tree can decide whether to give us teh entire tree or give us a
 
1632
            # lazy initialised tree. dirstate for instance will have the trees
 
1633
            # in ram already, whereas a last-revision + basis-inventory tree
 
1634
            # will not, but also does not need them when setting parents.
 
1635
            for parent in merges:
 
1636
                parent_trees.append(
 
1637
                    (parent, self.branch.repository.revision_tree(parent)))
 
1638
            if old_tip is not None:
 
1639
                parent_trees.append(
 
1640
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
 
1641
            self.set_parent_trees(parent_trees)
 
1642
            last_rev = parent_trees[0][0]
 
1643
        else:
 
1644
            # the working tree had the same last-revision as the master
 
1645
            # branch did. We may still have pivot local work from the local
 
1646
            # branch into old_tip:
 
1647
            if old_tip is not None:
 
1648
                self.add_parent_tree_id(old_tip)
 
1649
        if old_tip and old_tip != last_rev:
 
1650
            # our last revision was not the prior branch last revision
 
1651
            # and we have converted that last revision to a pending merge.
 
1652
            # base is somewhere between the branch tip now
 
1653
            # and the now pending merge
 
1654
            from bzrlib.revision import common_ancestor
 
1655
            try:
 
1656
                base_rev_id = common_ancestor(self.branch.last_revision(),
 
1657
                                              old_tip,
 
1658
                                              self.branch.repository)
 
1659
            except errors.NoCommonAncestor:
 
1660
                base_rev_id = None
 
1661
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
1662
            other_tree = self.branch.repository.revision_tree(old_tip)
 
1663
            result += merge.merge_inner(
 
1664
                                  self.branch,
 
1665
                                  other_tree,
 
1666
                                  base_tree,
 
1667
                                  this_tree=self)
 
1668
        return result
 
1669
 
 
1670
    @needs_tree_write_lock
1288
1671
    def _write_inventory(self, inv):
1289
1672
        """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')
 
1673
        self._set_inventory(inv, dirty=True)
 
1674
        self.flush()
1296
1675
 
1297
1676
    def set_conflicts(self, arg):
1298
1677
        raise UnsupportedOperation(self.set_conflicts, self)
1299
1678
 
 
1679
    def add_conflicts(self, arg):
 
1680
        raise UnsupportedOperation(self.add_conflicts, self)
 
1681
 
1300
1682
    @needs_read_lock
1301
1683
    def conflicts(self):
1302
 
        conflicts = ConflictList()
 
1684
        conflicts = _mod_conflicts.ConflictList()
1303
1685
        for conflicted in self._iter_conflicts():
1304
1686
            text = True
1305
1687
            try:
1306
1688
                if file_kind(self.abspath(conflicted)) != "file":
1307
1689
                    text = False
1308
 
            except OSError, e:
1309
 
                if e.errno == errno.ENOENT:
1310
 
                    text = False
1311
 
                else:
1312
 
                    raise
 
1690
            except errors.NoSuchFile:
 
1691
                text = False
1313
1692
            if text is True:
1314
1693
                for suffix in ('.THIS', '.OTHER'):
1315
1694
                    try:
1316
1695
                        kind = file_kind(self.abspath(conflicted+suffix))
1317
 
                    except OSError, e:
1318
 
                        if e.errno == errno.ENOENT:
 
1696
                        if kind != "file":
1319
1697
                            text = False
1320
 
                            break
1321
 
                        else:
1322
 
                            raise
1323
 
                    if kind != "file":
 
1698
                    except errors.NoSuchFile:
1324
1699
                        text = False
 
1700
                    if text == False:
1325
1701
                        break
1326
1702
            ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1327
 
            conflicts.append(Conflict.factory(ctype, path=conflicted,
 
1703
            conflicts.append(_mod_conflicts.Conflict.factory(ctype,
 
1704
                             path=conflicted,
1328
1705
                             file_id=self.path2id(conflicted)))
1329
1706
        return conflicts
1330
1707
 
1331
1708
 
 
1709
class WorkingTree2(WorkingTree):
 
1710
    """This is the Format 2 working tree.
 
1711
 
 
1712
    This was the first weave based working tree. 
 
1713
     - uses os locks for locking.
 
1714
     - uses the branch last-revision.
 
1715
    """
 
1716
 
 
1717
    def lock_tree_write(self):
 
1718
        """See WorkingTree.lock_tree_write().
 
1719
 
 
1720
        In Format2 WorkingTrees we have a single lock for the branch and tree
 
1721
        so lock_tree_write() degrades to lock_write().
 
1722
        """
 
1723
        self.branch.lock_write()
 
1724
        try:
 
1725
            return self._control_files.lock_write()
 
1726
        except:
 
1727
            self.branch.unlock()
 
1728
            raise
 
1729
 
 
1730
    def unlock(self):
 
1731
        # we share control files:
 
1732
        if self._control_files._lock_count == 3:
 
1733
            # _inventory_is_modified is always False during a read lock.
 
1734
            if self._inventory_is_modified:
 
1735
                self.flush()
 
1736
            if self._hashcache.needs_write:
 
1737
                self._hashcache.write()
 
1738
        # reverse order of locking.
 
1739
        try:
 
1740
            return self._control_files.unlock()
 
1741
        finally:
 
1742
            self.branch.unlock()
 
1743
 
 
1744
 
1332
1745
class WorkingTree3(WorkingTree):
1333
1746
    """This is the Format 3 working tree.
1334
1747
 
1340
1753
    """
1341
1754
 
1342
1755
    @needs_read_lock
1343
 
    def last_revision(self):
1344
 
        """See WorkingTree.last_revision."""
 
1756
    def _last_revision(self):
 
1757
        """See Mutable.last_revision."""
1345
1758
        try:
1346
1759
            return self._control_files.get_utf8('last-revision').read()
1347
1760
        except NoSuchFile:
1356
1769
                pass
1357
1770
            return False
1358
1771
        else:
1359
 
            try:
1360
 
                self.branch.revision_history().index(revision_id)
1361
 
            except ValueError:
1362
 
                raise errors.NoSuchRevision(self.branch, revision_id)
1363
1772
            self._control_files.put_utf8('last-revision', revision_id)
1364
1773
            return True
1365
1774
 
1366
 
    @needs_write_lock
 
1775
    @needs_tree_write_lock
1367
1776
    def set_conflicts(self, conflicts):
1368
1777
        self._put_rio('conflicts', conflicts.to_stanzas(), 
1369
1778
                      CONFLICT_HEADER_1)
1370
1779
 
 
1780
    @needs_tree_write_lock
 
1781
    def add_conflicts(self, new_conflicts):
 
1782
        conflict_set = set(self.conflicts())
 
1783
        conflict_set.update(set(list(new_conflicts)))
 
1784
        self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
 
1785
                                       key=_mod_conflicts.Conflict.sort_key)))
 
1786
 
1371
1787
    @needs_read_lock
1372
1788
    def conflicts(self):
1373
1789
        try:
1374
1790
            confile = self._control_files.get('conflicts')
1375
1791
        except NoSuchFile:
1376
 
            return ConflictList()
 
1792
            return _mod_conflicts.ConflictList()
1377
1793
        try:
1378
1794
            if confile.next() != CONFLICT_HEADER_1 + '\n':
1379
1795
                raise ConflictFormatError()
1380
1796
        except StopIteration:
1381
1797
            raise ConflictFormatError()
1382
 
        return ConflictList.from_stanzas(RioReader(confile))
 
1798
        return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
 
1799
 
 
1800
    def unlock(self):
 
1801
        if self._control_files._lock_count == 1:
 
1802
            # _inventory_is_modified is always False during a read lock.
 
1803
            if self._inventory_is_modified:
 
1804
                self.flush()
 
1805
            if self._hashcache.needs_write:
 
1806
                self._hashcache.write()
 
1807
        # reverse order of locking.
 
1808
        try:
 
1809
            return self._control_files.unlock()
 
1810
        finally:
 
1811
            self.branch.unlock()
1383
1812
 
1384
1813
 
1385
1814
def get_conflicted_stem(path):
1386
 
    for suffix in CONFLICT_SUFFIXES:
 
1815
    for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
1387
1816
        if path.endswith(suffix):
1388
1817
            return path[:-len(suffix)]
1389
1818
 
1437
1866
        except NoSuchFile:
1438
1867
            raise errors.NoWorkingTree(base=transport.base)
1439
1868
        except KeyError:
1440
 
            raise errors.UnknownFormatError(format_string)
 
1869
            raise errors.UnknownFormatError(format=format_string)
1441
1870
 
1442
1871
    @classmethod
1443
1872
    def get_default_format(klass):
1486
1915
        """See WorkingTreeFormat.get_format_description()."""
1487
1916
        return "Working tree format 2"
1488
1917
 
 
1918
    def stub_initialize_remote(self, control_files):
 
1919
        """As a special workaround create critical control files for a remote working tree
 
1920
        
 
1921
        This ensures that it can later be updated and dealt with locally,
 
1922
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with 
 
1923
        no working tree.  (See bug #43064).
 
1924
        """
 
1925
        sio = StringIO()
 
1926
        inv = Inventory()
 
1927
        xml5.serializer_v5.write_inventory(inv, sio)
 
1928
        sio.seek(0)
 
1929
        control_files.put('inventory', sio)
 
1930
 
 
1931
        control_files.put_utf8('pending-merges', '')
 
1932
        
 
1933
 
1489
1934
    def initialize(self, a_bzrdir, revision_id=None):
1490
1935
        """See WorkingTreeFormat.initialize()."""
1491
1936
        if not isinstance(a_bzrdir.transport, LocalTransport):
1503
1948
            finally:
1504
1949
                branch.unlock()
1505
1950
        revision = branch.last_revision()
1506
 
        inv = Inventory() 
1507
 
        wt = WorkingTree(a_bzrdir.root_transport.base,
 
1951
        inv = Inventory()
 
1952
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1508
1953
                         branch,
1509
1954
                         inv,
1510
1955
                         _internal=True,
1511
1956
                         _format=self,
1512
1957
                         _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)
 
1958
        basis_tree = branch.repository.revision_tree(revision)
 
1959
        if basis_tree.inventory.root is not None:
 
1960
            wt.set_root_id(basis_tree.inventory.root.file_id)
 
1961
        # set the parent list and cache the basis tree.
 
1962
        wt.set_parent_trees([(revision, basis_tree)])
 
1963
        transform.build_tree(basis_tree, wt)
1518
1964
        return wt
1519
1965
 
1520
1966
    def __init__(self):
1532
1978
            raise NotImplementedError
1533
1979
        if not isinstance(a_bzrdir.transport, LocalTransport):
1534
1980
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
1535
 
        return WorkingTree(a_bzrdir.root_transport.base,
 
1981
        return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1536
1982
                           _internal=True,
1537
1983
                           _format=self,
1538
1984
                           _bzrdir=a_bzrdir)
1547
1993
          files, separate from the BzrDir format
1548
1994
        - modifies the hash cache format
1549
1995
        - is new in bzr 0.8
1550
 
        - uses a LockDir to guard access to the repository
 
1996
        - uses a LockDir to guard access for writes.
1551
1997
    """
1552
1998
 
1553
1999
    def get_format_string(self):
1569
2015
    def initialize(self, a_bzrdir, revision_id=None):
1570
2016
        """See WorkingTreeFormat.initialize().
1571
2017
        
1572
 
        revision_id allows creating a working tree at a differnet
 
2018
        revision_id allows creating a working tree at a different
1573
2019
        revision than the branch is at.
1574
2020
        """
1575
2021
        if not isinstance(a_bzrdir.transport, LocalTransport):
1577
2023
        transport = a_bzrdir.get_workingtree_transport(self)
1578
2024
        control_files = self._open_control_files(a_bzrdir)
1579
2025
        control_files.create_lock()
 
2026
        control_files.lock_write()
1580
2027
        control_files.put_utf8('format', self.get_format_string())
1581
2028
        branch = a_bzrdir.open_branch()
1582
2029
        if revision_id is None:
1583
2030
            revision_id = branch.last_revision()
1584
 
        inv = Inventory() 
1585
 
        wt = WorkingTree3(a_bzrdir.root_transport.base,
 
2031
        # WorkingTree3 can handle an inventory which has a unique root id.
 
2032
        # as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
 
2033
        # those trees. And because there isn't a format bump inbetween, we
 
2034
        # are maintaining compatibility with older clients.
 
2035
        # inv = Inventory(root_id=gen_root_id())
 
2036
        inv = Inventory()
 
2037
        wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1586
2038
                         branch,
1587
2039
                         inv,
1588
2040
                         _internal=True,
1589
2041
                         _format=self,
1590
2042
                         _bzrdir=a_bzrdir,
1591
2043
                         _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)
 
2044
        wt.lock_tree_write()
 
2045
        try:
 
2046
            basis_tree = branch.repository.revision_tree(revision_id)
 
2047
            # only set an explicit root id if there is one to set.
 
2048
            if basis_tree.inventory.root is not None:
 
2049
                wt.set_root_id(basis_tree.inventory.root.file_id)
 
2050
            if revision_id == NULL_REVISION:
 
2051
                wt.set_parent_trees([])
 
2052
            else:
 
2053
                wt.set_parent_trees([(revision_id, basis_tree)])
 
2054
            transform.build_tree(basis_tree, wt)
 
2055
        finally:
 
2056
            # Unlock in this order so that the unlock-triggers-flush in
 
2057
            # WorkingTree is given a chance to fire.
 
2058
            control_files.unlock()
 
2059
            wt.unlock()
1597
2060
        return wt
1598
2061
 
1599
2062
    def __init__(self):
1611
2074
            raise NotImplementedError
1612
2075
        if not isinstance(a_bzrdir.transport, LocalTransport):
1613
2076
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
1614
 
        control_files = self._open_control_files(a_bzrdir)
1615
 
        return WorkingTree3(a_bzrdir.root_transport.base,
 
2077
        return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
 
2078
 
 
2079
    def _open(self, a_bzrdir, control_files):
 
2080
        """Open the tree itself.
 
2081
        
 
2082
        :param a_bzrdir: the dir for the tree.
 
2083
        :param control_files: the control files for the tree.
 
2084
        """
 
2085
        return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1616
2086
                           _internal=True,
1617
2087
                           _format=self,
1618
2088
                           _bzrdir=a_bzrdir,
1645
2115
        self._transport_readonly_server = transport_readonly_server
1646
2116
        self._formats = formats
1647
2117
    
 
2118
    def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
 
2119
        """Clone test for adaption."""
 
2120
        new_test = deepcopy(test)
 
2121
        new_test.transport_server = self._transport_server
 
2122
        new_test.transport_readonly_server = self._transport_readonly_server
 
2123
        new_test.bzrdir_format = bzrdir_format
 
2124
        new_test.workingtree_format = workingtree_format
 
2125
        def make_new_test_id():
 
2126
            new_id = "%s(%s)" % (test.id(), variation)
 
2127
            return lambda: new_id
 
2128
        new_test.id = make_new_test_id()
 
2129
        return new_test
 
2130
    
1648
2131
    def adapt(self, test):
1649
2132
        from bzrlib.tests import TestSuite
1650
2133
        result = TestSuite()
1651
2134
        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()
 
2135
            new_test = self._clone_test(
 
2136
                test,
 
2137
                bzrdir_format,
 
2138
                workingtree_format, workingtree_format.__class__.__name__)
1661
2139
            result.addTest(new_test)
1662
2140
        return result