/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: Martin Pool
  • Date: 2006-10-06 02:04:17 UTC
  • mfrom: (1908.10.1 bench_usecases.merge2)
  • mto: This revision was merged to the branch mainline in revision 2068.
  • Revision ID: mbp@sourcefrog.net-20061006020417-4949ca86f4417a4d
merge additional fix from cfbolz

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
39
39
# At the moment they may alias the inventory and have old copies of it in
40
40
# memory.  (Now done? -- mbp 20060309)
41
41
 
 
42
from binascii import hexlify
 
43
import collections
42
44
from copy import deepcopy
43
45
from cStringIO import StringIO
44
46
import errno
45
47
import fnmatch
46
48
import os
 
49
import re
47
50
import stat
48
 
 
 
51
from time import time
 
52
import warnings
49
53
 
 
54
import bzrlib
 
55
from bzrlib import bzrdir, errors, ignores, osutils, urlutils
50
56
from bzrlib.atomicfile import AtomicFile
51
 
from bzrlib.branch import (Branch,
52
 
                           quotefn)
 
57
import bzrlib.branch
53
58
from bzrlib.conflicts import Conflict, ConflictList, CONFLICT_SUFFIXES
54
 
import bzrlib.bzrdir as bzrdir
55
59
from bzrlib.decorators import needs_read_lock, needs_write_lock
56
 
import bzrlib.errors as errors
57
60
from bzrlib.errors import (BzrCheckError,
58
61
                           BzrError,
59
62
                           ConflictFormatError,
60
 
                           DivergedBranches,
61
63
                           WeaveRevisionNotPresent,
62
64
                           NotBranchError,
63
65
                           NoSuchFile,
69
71
from bzrlib.lockable_files import LockableFiles, TransportLock
70
72
from bzrlib.lockdir import LockDir
71
73
from bzrlib.merge import merge_inner, transform_tree
 
74
import bzrlib.mutabletree
 
75
from bzrlib.mutabletree import needs_tree_write_lock
72
76
from bzrlib.osutils import (
73
77
                            abspath,
74
 
                            appendpath,
75
78
                            compact_date,
76
79
                            file_kind,
77
80
                            isdir,
80
83
                            pumpfile,
81
84
                            safe_unicode,
82
85
                            splitpath,
83
 
                            rand_bytes,
 
86
                            rand_chars,
84
87
                            normpath,
85
88
                            realpath,
86
89
                            relpath,
89
92
                            )
90
93
from bzrlib.progress import DummyProgress, ProgressPhase
91
94
from bzrlib.revision import NULL_REVISION
 
95
import bzrlib.revisiontree
92
96
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
 
97
from bzrlib.symbol_versioning import (deprecated_passed,
 
98
        deprecated_method,
 
99
        deprecated_function,
 
100
        DEPRECATED_PARAMETER,
 
101
        zero_eight,
 
102
        zero_eleven,
 
103
        )
 
104
from bzrlib.trace import mutter, note
96
105
from bzrlib.transform import build_tree
97
 
from bzrlib.trace import mutter, note
98
106
from bzrlib.transport import get_transport
99
107
from bzrlib.transport.local import LocalTransport
 
108
from bzrlib.textui import show_status
100
109
import bzrlib.ui
101
110
import bzrlib.xml5
102
111
 
103
112
 
 
113
# the regex removes any weird characters; we don't escape them 
 
114
# but rather just pull them out
 
115
_gen_file_id_re = re.compile(r'[^\w.]')
 
116
_gen_id_suffix = None
 
117
_gen_id_serial = 0
 
118
 
 
119
 
 
120
def _next_id_suffix():
 
121
    """Create a new file id suffix that is reasonably unique.
 
122
    
 
123
    On the first call we combine the current time with 64 bits of randomness
 
124
    to give a highly probably globally unique number. Then each call in the same
 
125
    process adds 1 to a serial number we append to that unique value.
 
126
    """
 
127
    # XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather 
 
128
    # than having to move the id randomness out of the inner loop like this.
 
129
    # XXX TODO: for the global randomness this uses we should add the thread-id
 
130
    # before the serial #.
 
131
    global _gen_id_suffix, _gen_id_serial
 
132
    if _gen_id_suffix is None:
 
133
        _gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
 
134
    _gen_id_serial += 1
 
135
    return _gen_id_suffix + str(_gen_id_serial)
 
136
 
 
137
 
104
138
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))
 
139
    """Return new file id for the basename 'name'.
 
140
 
 
141
    The uniqueness is supplied from _next_id_suffix.
 
142
    """
 
143
    # The real randomness is in the _next_id_suffix, the
 
144
    # rest of the identifier is just to be nice.
 
145
    # So we:
 
146
    # 1) Remove non-ascii word characters to keep the ids portable
 
147
    # 2) squash to lowercase, so the file id doesn't have to
 
148
    #    be escaped (case insensitive filesystems would bork for ids
 
149
    #    that only differred in case without escaping).
 
150
    # 3) truncate the filename to 20 chars. Long filenames also bork on some
 
151
    #    filesystems
 
152
    # 4) Removing starting '.' characters to prevent the file ids from
 
153
    #    being considered hidden.
 
154
    ascii_word_only = _gen_file_id_re.sub('', name.lower())
 
155
    short_no_dots = ascii_word_only.lstrip('.')[:20]
 
156
    return short_no_dots + _next_id_suffix()
131
157
 
132
158
 
133
159
def gen_root_id():
136
162
 
137
163
 
138
164
class TreeEntry(object):
139
 
    """An entry that implements the minium interface used by commands.
 
165
    """An entry that implements the minimum interface used by commands.
140
166
 
141
167
    This needs further inspection, it may be better to have 
142
168
    InventoryEntries without ids - though that seems wrong. For now,
190
216
        return ''
191
217
 
192
218
 
193
 
class WorkingTree(bzrlib.tree.Tree):
 
219
class WorkingTree(bzrlib.mutabletree.MutableTree):
194
220
    """Working copy tree.
195
221
 
196
222
    The inventory is held in the `Branch` working-inventory, and the
218
244
        self.bzrdir = _bzrdir
219
245
        if not _internal:
220
246
            # not created via open etc.
221
 
            warn("WorkingTree() is deprecated as of bzr version 0.8. "
 
247
            warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
222
248
                 "Please use bzrdir.open_workingtree or WorkingTree.open().",
223
249
                 DeprecationWarning,
224
250
                 stacklevel=2)
225
251
            wt = WorkingTree.open(basedir)
226
 
            self.branch = wt.branch
 
252
            self._branch = wt.branch
227
253
            self.basedir = wt.basedir
228
254
            self._control_files = wt._control_files
229
255
            self._hashcache = wt._hashcache
238
264
        mutter("opening working tree %r", basedir)
239
265
        if deprecated_passed(branch):
240
266
            if not _internal:
241
 
                warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
 
267
                warnings.warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
242
268
                     " Please use bzrdir.open_workingtree() or"
243
269
                     " WorkingTree.open().",
244
270
                     DeprecationWarning,
245
271
                     stacklevel=2
246
272
                     )
247
 
            self.branch = branch
 
273
            self._branch = branch
248
274
        else:
249
 
            self.branch = self.bzrdir.open_branch()
250
 
        assert isinstance(self.branch, Branch), \
251
 
            "branch %r is not a Branch" % self.branch
 
275
            self._branch = self.bzrdir.open_branch()
252
276
        self.basedir = realpath(basedir)
253
277
        # if branch is at our basedir and is a format 6 or less
254
278
        if isinstance(self._format, WorkingTreeFormat2):
255
279
            # share control object
256
280
            self._control_files = self.branch.control_files
257
281
        else:
258
 
            # only ready for format 3
259
 
            assert isinstance(self._format, WorkingTreeFormat3)
 
282
            # assume all other formats have their own control files.
260
283
            assert isinstance(_control_files, LockableFiles), \
261
284
                    "_control_files must be a LockableFiles, not %r" \
262
285
                    % _control_files
267
290
        # if needed, or, when the cache sees a change, append it to the hash
268
291
        # cache file, and have the parser take the most recent entry for a
269
292
        # given path only.
270
 
        cache_filename = self.bzrdir.get_workingtree_transport(None).abspath('stat-cache')
 
293
        cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
271
294
        hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
272
295
        hc.read()
273
296
        # is this scan needed ? it makes things kinda slow.
274
 
        hc.scan()
 
297
        #hc.scan()
275
298
 
276
299
        if hc.needs_write:
277
300
            mutter("write hc")
282
305
        else:
283
306
            self._set_inventory(_inventory)
284
307
 
 
308
    branch = property(
 
309
        fget=lambda self: self._branch,
 
310
        doc="""The branch this WorkingTree is connected to.
 
311
 
 
312
            This cannot be set - it is reflective of the actual disk structure
 
313
            the working tree has been constructed from.
 
314
            """)
 
315
 
 
316
    def break_lock(self):
 
317
        """Break a lock if one is present from another instance.
 
318
 
 
319
        Uses the ui factory to ask for confirmation if the lock may be from
 
320
        an active process.
 
321
 
 
322
        This will probe the repository for its lock as well.
 
323
        """
 
324
        self._control_files.break_lock()
 
325
        self.branch.break_lock()
 
326
 
285
327
    def _set_inventory(self, inv):
 
328
        assert inv.root is not None
286
329
        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
301
330
 
302
331
    @staticmethod
303
332
    def open(path=None, _unsupported=False):
319
348
        run into /.  If there isn't one, raises NotBranchError.
320
349
        TODO: give this a new exception.
321
350
        If there is one, it is returned, along with the unused portion of path.
 
351
 
 
352
        :return: The WorkingTree that contains 'path', and the rest of path
322
353
        """
323
354
        if path is None:
324
 
            path = os.getcwdu()
 
355
            path = osutils.getcwd()
325
356
        control, relpath = bzrdir.BzrDir.open_containing(path)
 
357
 
326
358
        return control.open_workingtree(), relpath
327
359
 
328
360
    @staticmethod
341
373
        """
342
374
        inv = self._inventory
343
375
        for path, ie in inv.iter_entries():
344
 
            if bzrlib.osutils.lexists(self.abspath(path)):
 
376
            if osutils.lexists(self.abspath(path)):
345
377
                yield ie.file_id
346
378
 
347
379
    def __repr__(self):
352
384
        return pathjoin(self.basedir, filename)
353
385
    
354
386
    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:
 
387
        """Return RevisionTree for the current last revision.
 
388
        
 
389
        If the left most parent is a ghost then the returned tree will be an
 
390
        empty tree - one obtained by calling repository.revision_tree(None).
 
391
        """
 
392
        try:
 
393
            revision_id = self.get_parent_ids()[0]
 
394
        except IndexError:
 
395
            # no parents, return an empty revision tree.
 
396
            # in the future this should return the tree for
 
397
            # 'empty:' - the implicit root empty tree.
 
398
            return self.branch.repository.revision_tree(None)
 
399
        else:
358
400
            try:
359
401
                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)
 
402
                inv = bzrlib.xml6.serializer_v6.read_inventory_from_string(xml)
 
403
                if inv is not None and inv.revision_id == revision_id:
 
404
                    return bzrlib.tree.RevisionTree(self.branch.repository, 
 
405
                                                    inv, revision_id)
 
406
            except (NoSuchFile, errors.BadInventoryFormat):
 
407
                pass
 
408
        # No cached copy available, retrieve from the repository.
 
409
        # FIXME? RBC 20060403 should we cache the inventory locally
 
410
        # at this point ?
 
411
        try:
 
412
            return self.branch.repository.revision_tree(revision_id)
 
413
        except errors.RevisionNotPresent:
 
414
            # the basis tree *may* be a ghost or a low level error may have
 
415
            # occured. If the revision is present, its a problem, if its not
 
416
            # its a ghost.
 
417
            if self.branch.repository.has_revision(revision_id):
 
418
                raise
 
419
            # the basis tree is a ghost so return an empty tree.
 
420
            return self.branch.repository.revision_tree(None)
368
421
 
369
422
    @staticmethod
370
423
    @deprecated_method(zero_eight)
383
436
        XXX: When BzrDir is present, these should be created through that 
384
437
        interface instead.
385
438
        """
386
 
        warn('delete WorkingTree.create', stacklevel=3)
 
439
        warnings.warn('delete WorkingTree.create', stacklevel=3)
387
440
        transport = get_transport(directory)
388
441
        if branch.bzrdir.root_transport.base == transport.base:
389
442
            # same dir 
404
457
        """
405
458
        return bzrdir.BzrDir.create_standalone_workingtree(directory)
406
459
 
407
 
    def relpath(self, abs):
408
 
        """Return the local path portion from a given absolute path."""
409
 
        return relpath(self.basedir, abs)
 
460
    def relpath(self, path):
 
461
        """Return the local path portion from a given path.
 
462
        
 
463
        The path may be absolute or relative. If its a relative path it is 
 
464
        interpreted relative to the python current working directory.
 
465
        """
 
466
        return relpath(self.basedir, path)
410
467
 
411
468
    def has_filename(self, filename):
412
 
        return bzrlib.osutils.lexists(self.abspath(filename))
 
469
        return osutils.lexists(self.abspath(filename))
413
470
 
414
471
    def get_file(self, file_id):
415
472
        return self.get_file_byname(self.id2path(file_id))
416
473
 
 
474
    def get_file_text(self, file_id):
 
475
        return self.get_file(file_id).read()
 
476
 
417
477
    def get_file_byname(self, filename):
418
478
        return file(self.abspath(filename), 'rb')
419
479
 
 
480
    def get_parent_ids(self):
 
481
        """See Tree.get_parent_ids.
 
482
        
 
483
        This implementation reads the pending merges list and last_revision
 
484
        value and uses that to decide what the parents list should be.
 
485
        """
 
486
        last_rev = self._last_revision()
 
487
        if last_rev is None:
 
488
            parents = []
 
489
        else:
 
490
            parents = [last_rev]
 
491
        try:
 
492
            merges_file = self._control_files.get_utf8('pending-merges')
 
493
        except NoSuchFile:
 
494
            pass
 
495
        else:
 
496
            for l in merges_file.readlines():
 
497
                parents.append(l.rstrip('\n'))
 
498
        return parents
 
499
 
420
500
    def get_root_id(self):
421
501
        """Return the id of this trees root"""
422
502
        inv = self.read_working_inventory()
455
535
        if revision_id is None:
456
536
            transform_tree(tree, self)
457
537
        else:
458
 
            # TODO now merge from tree.last_revision to revision
 
538
            # TODO now merge from tree.last_revision to revision (to preserve
 
539
            # user local changes)
459
540
            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())
 
541
            tree.set_parent_ids([revision_id])
476
542
 
477
543
    def id2abspath(self, file_id):
478
544
        return self.abspath(self.id2path(file_id))
483
549
        if not inv.has_id(file_id):
484
550
            return False
485
551
        path = inv.id2path(file_id)
486
 
        return bzrlib.osutils.lexists(self.abspath(path))
 
552
        return osutils.lexists(self.abspath(path))
487
553
 
488
554
    def has_or_had_id(self, file_id):
489
555
        if file_id == self.inventory.root.file_id:
496
562
        return os.path.getsize(self.id2abspath(file_id))
497
563
 
498
564
    @needs_read_lock
499
 
    def get_file_sha1(self, file_id):
500
 
        path = self._inventory.id2path(file_id)
 
565
    def get_file_sha1(self, file_id, path=None):
 
566
        if not path:
 
567
            path = self._inventory.id2path(file_id)
501
568
        return self._hashcache.get_sha1(path)
502
569
 
503
 
    def is_executable(self, file_id):
504
 
        if not supports_executable():
 
570
    def get_file_mtime(self, file_id, path=None):
 
571
        if not path:
 
572
            path = self._inventory.id2path(file_id)
 
573
        return os.lstat(self.abspath(path)).st_mtime
 
574
 
 
575
    if not supports_executable():
 
576
        def is_executable(self, file_id, path=None):
505
577
            return self._inventory[file_id].executable
506
 
        else:
507
 
            path = self._inventory.id2path(file_id)
 
578
    else:
 
579
        def is_executable(self, file_id, path=None):
 
580
            if not path:
 
581
                path = self._inventory.id2path(file_id)
508
582
            mode = os.lstat(self.abspath(path)).st_mode
509
 
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
 
583
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
510
584
 
511
585
    @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
 
        """
 
586
    def _add(self, files, ids, kinds):
 
587
        """See MutableTree._add."""
534
588
        # TODO: Re-adding a file that is removed in the working copy
535
589
        # 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
 
 
 
590
        # the read and write working inventory should not occur in this 
 
591
        # function - they should be part of lock_write and unlock.
547
592
        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
 
 
 
593
        for f, file_id, kind in zip(files, ids, kinds):
 
594
            assert kind is not None
571
595
            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))
 
596
                inv.add_path(f, kind=kind)
 
597
            else:
 
598
                inv.add_path(f, kind=kind, file_id=file_id)
576
599
        self._write_inventory(inv)
577
600
 
 
601
    @needs_tree_write_lock
 
602
    def _gather_kinds(self, files, kinds):
 
603
        """See MutableTree._gather_kinds."""
 
604
        for pos, f in enumerate(files):
 
605
            if kinds[pos] is None:
 
606
                fullpath = normpath(self.abspath(f))
 
607
                try:
 
608
                    kinds[pos] = file_kind(fullpath)
 
609
                except OSError, e:
 
610
                    if e.errno == errno.ENOENT:
 
611
                        raise NoSuchFile(fullpath)
 
612
 
578
613
    @needs_write_lock
 
614
    def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
 
615
        """Add revision_id as a parent.
 
616
 
 
617
        This is equivalent to retrieving the current list of parent ids
 
618
        and setting the list to its value plus revision_id.
 
619
 
 
620
        :param revision_id: The revision id to add to the parent list. It may
 
621
        be a ghost revision as long as its not the first parent to be added,
 
622
        or the allow_leftmost_as_ghost parameter is set True.
 
623
        :param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
 
624
        """
 
625
        parents = self.get_parent_ids() + [revision_id]
 
626
        self.set_parent_ids(parents,
 
627
            allow_leftmost_as_ghost=len(parents) > 1 or allow_leftmost_as_ghost)
 
628
 
 
629
    @needs_tree_write_lock
 
630
    def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
 
631
        """Add revision_id, tree tuple as a parent.
 
632
 
 
633
        This is equivalent to retrieving the current list of parent trees
 
634
        and setting the list to its value plus parent_tuple. See also
 
635
        add_parent_tree_id - if you only have a parent id available it will be
 
636
        simpler to use that api. If you have the parent already available, using
 
637
        this api is preferred.
 
638
 
 
639
        :param parent_tuple: The (revision id, tree) to add to the parent list.
 
640
            If the revision_id is a ghost, pass None for the tree.
 
641
        :param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
 
642
        """
 
643
        parent_ids = self.get_parent_ids() + [parent_tuple[0]]
 
644
        if len(parent_ids) > 1:
 
645
            # the leftmost may have already been a ghost, preserve that if it
 
646
            # was.
 
647
            allow_leftmost_as_ghost = True
 
648
        self.set_parent_ids(parent_ids,
 
649
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
650
 
 
651
    @needs_tree_write_lock
579
652
    def add_pending_merge(self, *revision_ids):
580
653
        # TODO: Perhaps should check at this point that the
581
654
        # history of the revision is actually present?
582
 
        p = self.pending_merges()
 
655
        parents = self.get_parent_ids()
583
656
        updated = False
584
657
        for rev_id in revision_ids:
585
 
            if rev_id in p:
 
658
            if rev_id in parents:
586
659
                continue
587
 
            p.append(rev_id)
 
660
            parents.append(rev_id)
588
661
            updated = True
589
662
        if updated:
590
 
            self.set_pending_merges(p)
 
663
            self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
591
664
 
 
665
    @deprecated_method(zero_eleven)
592
666
    @needs_read_lock
593
667
    def pending_merges(self):
594
668
        """Return a list of pending merges.
595
669
 
596
670
        These are revisions that have been merged into the working
597
671
        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
 
672
 
 
673
        As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
 
674
        instead - which is available on all tree objects.
 
675
        """
 
676
        return self.get_parent_ids()[1:]
 
677
 
 
678
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
 
679
        """Common ghost checking functionality from set_parent_*.
 
680
 
 
681
        This checks that the left hand-parent exists if there are any
 
682
        revisions present.
 
683
        """
 
684
        if len(revision_ids) > 0:
 
685
            leftmost_id = revision_ids[0]
 
686
            if (not allow_leftmost_as_ghost and not
 
687
                self.branch.repository.has_revision(leftmost_id)):
 
688
                raise errors.GhostRevisionUnusableHere(leftmost_id)
 
689
 
 
690
    def _set_merges_from_parent_ids(self, parent_ids):
 
691
        merges = parent_ids[1:]
 
692
        self._control_files.put_utf8('pending-merges', '\n'.join(merges))
 
693
 
 
694
    @needs_tree_write_lock
 
695
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
 
696
        """Set the parent ids to revision_ids.
 
697
        
 
698
        See also set_parent_trees. This api will try to retrieve the tree data
 
699
        for each element of revision_ids from the trees repository. If you have
 
700
        tree data already available, it is more efficient to use
 
701
        set_parent_trees rather than set_parent_ids. set_parent_ids is however
 
702
        an easier API to use.
 
703
 
 
704
        :param revision_ids: The revision_ids to set as the parent ids of this
 
705
            working tree. Any of these may be ghosts.
 
706
        """
 
707
        self._check_parents_for_ghosts(revision_ids,
 
708
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
709
 
 
710
        if len(revision_ids) > 0:
 
711
            self.set_last_revision(revision_ids[0])
 
712
        else:
 
713
            self.set_last_revision(None)
 
714
 
 
715
        self._set_merges_from_parent_ids(revision_ids)
 
716
 
 
717
    @needs_tree_write_lock
 
718
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
 
719
        """See MutableTree.set_parent_trees."""
 
720
        parent_ids = [rev for (rev, tree) in parents_list]
 
721
 
 
722
        self._check_parents_for_ghosts(parent_ids,
 
723
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
724
 
 
725
        if len(parent_ids) == 0:
 
726
            leftmost_parent_id = None
 
727
            leftmost_parent_tree = None
 
728
        else:
 
729
            leftmost_parent_id, leftmost_parent_tree = parents_list[0]
 
730
 
 
731
        if self._change_last_revision(leftmost_parent_id):
 
732
            if leftmost_parent_tree is None:
 
733
                # If we don't have a tree, fall back to reading the
 
734
                # parent tree from the repository.
 
735
                self._cache_basis_inventory(leftmost_parent_id)
 
736
            else:
 
737
                inv = leftmost_parent_tree.inventory
 
738
                xml = self._create_basis_xml_from_inventory(
 
739
                                        leftmost_parent_id, inv)
 
740
                self._write_basis_inventory(xml)
 
741
        self._set_merges_from_parent_ids(parent_ids)
 
742
 
 
743
    @needs_tree_write_lock
611
744
    def set_pending_merges(self, rev_list):
612
 
        self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
 
745
        parents = self.get_parent_ids()
 
746
        leftmost = parents[:1]
 
747
        new_parents = leftmost + rev_list
 
748
        self.set_parent_ids(new_parents)
613
749
 
614
 
    @needs_write_lock
 
750
    @needs_tree_write_lock
615
751
    def set_merge_modified(self, modified_hashes):
616
752
        def iter_stanzas():
617
753
            for file_id, hash in modified_hashes.iteritems():
618
754
                yield Stanza(file_id=file_id, hash=hash)
619
755
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
620
756
 
621
 
    @needs_write_lock
 
757
    @needs_tree_write_lock
622
758
    def _put_rio(self, filename, stanzas, header):
623
759
        my_file = rio_file(stanzas, header)
624
760
        self._control_files.put(filename, my_file)
625
761
 
 
762
    @needs_write_lock # because merge pulls data into the branch.
 
763
    def merge_from_branch(self, branch, to_revision=None):
 
764
        """Merge from a branch into this working tree.
 
765
 
 
766
        :param branch: The branch to merge from.
 
767
        :param to_revision: If non-None, the merge will merge to to_revision, but 
 
768
            not beyond it. to_revision does not need to be in the history of
 
769
            the branch when it is supplied. If None, to_revision defaults to
 
770
            branch.last_revision().
 
771
        """
 
772
        from bzrlib.merge import Merger, Merge3Merger
 
773
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
774
        try:
 
775
            merger = Merger(self.branch, this_tree=self, pb=pb)
 
776
            merger.pp = ProgressPhase("Merge phase", 5, pb)
 
777
            merger.pp.next_phase()
 
778
            # check that there are no
 
779
            # local alterations
 
780
            merger.check_basis(check_clean=True, require_commits=False)
 
781
            if to_revision is None:
 
782
                to_revision = branch.last_revision()
 
783
            merger.other_rev_id = to_revision
 
784
            if merger.other_rev_id is None:
 
785
                raise error.NoCommits(branch)
 
786
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
787
            merger.other_basis = merger.other_rev_id
 
788
            merger.other_tree = self.branch.repository.revision_tree(
 
789
                merger.other_rev_id)
 
790
            merger.pp.next_phase()
 
791
            merger.find_base()
 
792
            if merger.base_rev_id == merger.other_rev_id:
 
793
                raise errors.PointlessMerge
 
794
            merger.backup_files = False
 
795
            merger.merge_type = Merge3Merger
 
796
            merger.set_interesting_files(None)
 
797
            merger.show_base = False
 
798
            merger.reprocess = False
 
799
            conflicts = merger.do_merge()
 
800
            merger.set_pending()
 
801
        finally:
 
802
            pb.finished()
 
803
        return conflicts
 
804
 
626
805
    @needs_read_lock
627
806
    def merge_modified(self):
628
807
        try:
644
823
                merge_hashes[file_id] = hash
645
824
        return merge_hashes
646
825
 
 
826
    @needs_write_lock
 
827
    def mkdir(self, path, file_id=None):
 
828
        """See MutableTree.mkdir()."""
 
829
        if file_id is None:
 
830
            file_id = gen_file_id(os.path.basename(path))
 
831
        os.mkdir(self.abspath(path))
 
832
        self.add(path, file_id, 'directory')
 
833
        return file_id
 
834
 
647
835
    def get_symlink_target(self, file_id):
648
836
        return os.readlink(self.id2abspath(file_id))
649
837
 
655
843
        else:
656
844
            return '?'
657
845
 
658
 
    def list_files(self):
659
 
        """Recursively list all files as (path, class, kind, id).
 
846
    def list_files(self, include_root=False):
 
847
        """Recursively list all files as (path, class, kind, id, entry).
660
848
 
661
849
        Lists, but does not descend into unversioned directories.
662
850
 
666
854
        Skips the control directory.
667
855
        """
668
856
        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:
 
857
        if include_root is True:
 
858
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
 
859
        # Convert these into local objects to save lookup times
 
860
        pathjoin = osutils.pathjoin
 
861
        file_kind = osutils.file_kind
 
862
 
 
863
        # transport.base ends in a slash, we want the piece
 
864
        # between the last two slashes
 
865
        transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
 
866
 
 
867
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
 
868
 
 
869
        # directory file_id, relative path, absolute path, reverse sorted children
 
870
        children = os.listdir(self.basedir)
 
871
        children.sort()
 
872
        # jam 20060527 The kernel sized tree seems equivalent whether we 
 
873
        # use a deque and popleft to keep them sorted, or if we use a plain
 
874
        # list and just reverse() them.
 
875
        children = collections.deque(children)
 
876
        stack = [(inv.root.file_id, u'', self.basedir, children)]
 
877
        while stack:
 
878
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
 
879
 
 
880
            while children:
 
881
                f = children.popleft()
674
882
                ## TODO: If we find a subdirectory with its own .bzr
675
883
                ## directory, then that is a separate tree and we
676
884
                ## should exclude it.
677
885
 
678
886
                # the bzrdir for this tree
679
 
                if self.bzrdir.transport.base.endswith(f + '/'):
 
887
                if transport_base_dir == f:
680
888
                    continue
681
889
 
682
 
                # path within tree
683
 
                fp = appendpath(from_dir_relpath, f)
 
890
                # we know that from_dir_relpath and from_dir_abspath never end in a slash
 
891
                # and 'f' doesn't begin with one, we can do a string op, rather
 
892
                # than the checks of pathjoin(), all relative paths will have an extra slash
 
893
                # at the beginning
 
894
                fp = from_dir_relpath + '/' + f
684
895
 
685
896
                # absolute path
686
 
                fap = appendpath(dp, f)
 
897
                fap = from_dir_abspath + '/' + f
687
898
                
688
899
                f_ie = inv.get_child(from_dir_id, f)
689
900
                if f_ie:
690
901
                    c = 'V'
691
 
                elif self.is_ignored(fp):
 
902
                elif self.is_ignored(fp[1:]):
692
903
                    c = 'I'
693
904
                else:
694
 
                    c = '?'
 
905
                    # we may not have found this file, because of a unicode issue
 
906
                    f_norm, can_access = osutils.normalized_filename(f)
 
907
                    if f == f_norm or not can_access:
 
908
                        # No change, so treat this file normally
 
909
                        c = '?'
 
910
                    else:
 
911
                        # this file can be accessed by a normalized path
 
912
                        # check again if it is versioned
 
913
                        # these lines are repeated here for performance
 
914
                        f = f_norm
 
915
                        fp = from_dir_relpath + '/' + f
 
916
                        fap = from_dir_abspath + '/' + f
 
917
                        f_ie = inv.get_child(from_dir_id, f)
 
918
                        if f_ie:
 
919
                            c = 'V'
 
920
                        elif self.is_ignored(fp[1:]):
 
921
                            c = 'I'
 
922
                        else:
 
923
                            c = '?'
695
924
 
696
925
                fk = file_kind(fap)
697
926
 
703
932
 
704
933
                # make a last minute entry
705
934
                if f_ie:
706
 
                    entry = f_ie
 
935
                    yield fp[1:], c, fk, f_ie.file_id, f_ie
707
936
                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()
 
937
                    try:
 
938
                        yield fp[1:], c, fk, None, fk_entries[fk]()
 
939
                    except KeyError:
 
940
                        yield fp[1:], c, fk, None, TreeEntry()
 
941
                    continue
716
942
                
717
 
                yield fp, c, fk, (f_ie and f_ie.file_id), entry
718
 
 
719
943
                if fk != 'directory':
720
944
                    continue
721
945
 
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
 
946
                # But do this child first
 
947
                new_children = os.listdir(fap)
 
948
                new_children.sort()
 
949
                new_children = collections.deque(new_children)
 
950
                stack.append((f_ie.file_id, fp, fap, new_children))
 
951
                # Break out of inner loop, so that we start outer loop with child
 
952
                break
 
953
            else:
 
954
                # if we finished all children, pop it off the stack
 
955
                stack.pop()
 
956
 
 
957
    @needs_tree_write_lock
733
958
    def move(self, from_paths, to_name):
734
959
        """Rename files.
735
960
 
754
979
        if not self.has_filename(to_name):
755
980
            raise BzrError("destination %r not in working directory" % to_abs)
756
981
        to_dir_id = inv.path2id(to_name)
757
 
        if to_dir_id == None and to_name != '':
 
982
        if to_dir_id is None and to_name != '':
758
983
            raise BzrError("destination %r is not a versioned directory" % to_name)
759
984
        to_dir_ie = inv[to_dir_id]
760
 
        if to_dir_ie.kind not in ('directory', 'root_directory'):
 
985
        if to_dir_ie.kind != 'directory':
761
986
            raise BzrError("destination %r is not a directory" % to_abs)
762
987
 
763
988
        to_idpath = inv.get_idpath(to_dir_id)
766
991
            if not self.has_filename(f):
767
992
                raise BzrError("%r does not exist in working tree" % f)
768
993
            f_id = inv.path2id(f)
769
 
            if f_id == None:
 
994
            if f_id is None:
770
995
                raise BzrError("%r is not versioned" % f)
771
996
            name_tail = splitpath(f)[-1]
772
 
            dest_path = appendpath(to_name, name_tail)
 
997
            dest_path = pathjoin(to_name, name_tail)
773
998
            if self.has_filename(dest_path):
774
999
                raise BzrError("destination %r already exists" % dest_path)
775
1000
            if f_id in to_idpath:
782
1007
        try:
783
1008
            for f in from_paths:
784
1009
                name_tail = splitpath(f)[-1]
785
 
                dest_path = appendpath(to_name, name_tail)
 
1010
                dest_path = pathjoin(to_name, name_tail)
786
1011
                result.append((f, dest_path))
787
1012
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
788
1013
                try:
798
1023
        self._write_inventory(inv)
799
1024
        return result
800
1025
 
801
 
    @needs_write_lock
 
1026
    @needs_tree_write_lock
802
1027
    def rename_one(self, from_rel, to_rel):
803
1028
        """Rename one file.
804
1029
 
811
1036
            raise BzrError("can't rename: new working file %r already exists" % to_rel)
812
1037
 
813
1038
        file_id = inv.path2id(from_rel)
814
 
        if file_id == None:
 
1039
        if file_id is None:
815
1040
            raise BzrError("can't rename: old name %r is not versioned" % from_rel)
816
1041
 
817
1042
        entry = inv[file_id]
823
1048
 
824
1049
        to_dir, to_tail = os.path.split(to_rel)
825
1050
        to_dir_id = inv.path2id(to_dir)
826
 
        if to_dir_id == None and to_dir != '':
 
1051
        if to_dir_id is None and to_dir != '':
827
1052
            raise BzrError("can't determine destination directory id for %r" % to_dir)
828
1053
 
829
1054
        mutter("rename_one:")
852
1077
 
853
1078
        These are files in the working directory that are not versioned or
854
1079
        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
1080
        """
869
1081
        for subp in self.extras():
870
1082
            if not self.is_ignored(subp):
871
1083
                yield subp
872
 
 
 
1084
    
 
1085
    @needs_tree_write_lock
 
1086
    def unversion(self, file_ids):
 
1087
        """Remove the file ids in file_ids from the current versioned set.
 
1088
 
 
1089
        When a file_id is unversioned, all of its children are automatically
 
1090
        unversioned.
 
1091
 
 
1092
        :param file_ids: The file ids to stop versioning.
 
1093
        :raises: NoSuchId if any fileid is not currently versioned.
 
1094
        """
 
1095
        for file_id in file_ids:
 
1096
            if self._inventory.has_id(file_id):
 
1097
                self._inventory.remove_recursive_id(file_id)
 
1098
            else:
 
1099
                raise errors.NoSuchId(self, file_id)
 
1100
        if len(file_ids):
 
1101
            # in the future this should just set a dirty bit to wait for the 
 
1102
            # final unlock. However, until all methods of workingtree start
 
1103
            # with the current in -memory inventory rather than triggering 
 
1104
            # a read, it is more complex - we need to teach read_inventory
 
1105
            # to know when to read, and when to not read first... and possibly
 
1106
            # to save first when the in memory one may be corrupted.
 
1107
            # so for now, we just only write it if it is indeed dirty.
 
1108
            # - RBC 20060907
 
1109
            self._write_inventory(self._inventory)
 
1110
    
873
1111
    @deprecated_method(zero_eight)
874
1112
    def iter_conflicts(self):
875
1113
        """List all files in the tree that have text or content conflicts.
878
1116
 
879
1117
    def _iter_conflicts(self):
880
1118
        conflicted = set()
881
 
        for path in (s[0] for s in self.list_files()):
 
1119
        for info in self.list_files():
 
1120
            path = info[0]
882
1121
            stem = get_conflicted_stem(path)
883
1122
            if stem is None:
884
1123
                continue
906
1145
                repository = self.branch.repository
907
1146
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
908
1147
                try:
 
1148
                    new_basis_tree = self.branch.basis_tree()
909
1149
                    merge_inner(self.branch,
910
 
                                self.branch.basis_tree(),
911
 
                                basis_tree, 
912
 
                                this_tree=self, 
 
1150
                                new_basis_tree,
 
1151
                                basis_tree,
 
1152
                                this_tree=self,
913
1153
                                pb=pb)
914
1154
                finally:
915
1155
                    pb.finished()
916
 
                self.set_last_revision(self.branch.last_revision())
 
1156
                # TODO - dedup parents list with things merged by pull ?
 
1157
                # reuse the revisiontree we merged against to set the new
 
1158
                # tree data.
 
1159
                parent_trees = [(self.branch.last_revision(), new_basis_tree)]
 
1160
                # we have to pull the merge trees out again, because 
 
1161
                # merge_inner has set the ids. - this corner is not yet 
 
1162
                # layered well enough to prevent double handling.
 
1163
                merges = self.get_parent_ids()[1:]
 
1164
                parent_trees.extend([
 
1165
                    (parent, repository.revision_tree(parent)) for
 
1166
                     parent in merges])
 
1167
                self.set_parent_trees(parent_trees)
917
1168
            return count
918
1169
        finally:
919
1170
            source.unlock()
920
1171
            top_pb.finished()
921
1172
 
 
1173
    @needs_write_lock
 
1174
    def put_file_bytes_non_atomic(self, file_id, bytes):
 
1175
        """See MutableTree.put_file_bytes_non_atomic."""
 
1176
        stream = file(self.id2abspath(file_id), 'wb')
 
1177
        try:
 
1178
            stream.write(bytes)
 
1179
        finally:
 
1180
            stream.close()
 
1181
        # TODO: update the hashcache here ?
 
1182
 
922
1183
    def extras(self):
923
1184
        """Yield all unknown files in this WorkingTree.
924
1185
 
930
1191
        """
931
1192
        ## TODO: Work from given directory downwards
932
1193
        for path, dir_entry in self.inventory.directories():
933
 
            mutter("search for unknowns in %r", path)
 
1194
            # mutter("search for unknowns in %r", path)
934
1195
            dirabs = self.abspath(path)
935
1196
            if not isdir(dirabs):
936
1197
                # e.g. directory deleted
938
1199
 
939
1200
            fl = []
940
1201
            for subf in os.listdir(dirabs):
941
 
                if (subf != '.bzr'
942
 
                    and (subf not in dir_entry.children)):
943
 
                    fl.append(subf)
 
1202
                if subf == '.bzr':
 
1203
                    continue
 
1204
                if subf not in dir_entry.children:
 
1205
                    subf_norm, can_access = osutils.normalized_filename(subf)
 
1206
                    if subf_norm != subf and can_access:
 
1207
                        if subf_norm not in dir_entry.children:
 
1208
                            fl.append(subf_norm)
 
1209
                    else:
 
1210
                        fl.append(subf)
944
1211
            
945
1212
            fl.sort()
946
1213
            for subf in fl:
947
 
                subp = appendpath(path, subf)
 
1214
                subp = pathjoin(path, subf)
948
1215
                yield subp
949
1216
 
 
1217
    def _translate_ignore_rule(self, rule):
 
1218
        """Translate a single ignore rule to a regex.
 
1219
 
 
1220
        There are two types of ignore rules.  Those that do not contain a / are
 
1221
        matched against the tail of the filename (that is, they do not care
 
1222
        what directory the file is in.)  Rules which do contain a slash must
 
1223
        match the entire path.  As a special case, './' at the start of the
 
1224
        string counts as a slash in the string but is removed before matching
 
1225
        (e.g. ./foo.c, ./src/foo.c)
 
1226
 
 
1227
        :return: The translated regex.
 
1228
        """
 
1229
        if rule[:2] in ('./', '.\\'):
 
1230
            # rootdir rule
 
1231
            result = fnmatch.translate(rule[2:])
 
1232
        elif '/' in rule or '\\' in rule:
 
1233
            # path prefix 
 
1234
            result = fnmatch.translate(rule)
 
1235
        else:
 
1236
            # default rule style.
 
1237
            result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
 
1238
        assert result[-1] == '$', "fnmatch.translate did not add the expected $"
 
1239
        return "(" + result + ")"
 
1240
 
 
1241
    def _combine_ignore_rules(self, rules):
 
1242
        """Combine a list of ignore rules into a single regex object.
 
1243
 
 
1244
        Each individual rule is combined with | to form a big regex, which then
 
1245
        has $ added to it to form something like ()|()|()$. The group index for
 
1246
        each subregex's outermost group is placed in a dictionary mapping back 
 
1247
        to the rule. This allows quick identification of the matching rule that
 
1248
        triggered a match.
 
1249
        :return: a list of the compiled regex and the matching-group index 
 
1250
        dictionaries. We return a list because python complains if you try to 
 
1251
        combine more than 100 regexes.
 
1252
        """
 
1253
        result = []
 
1254
        groups = {}
 
1255
        next_group = 0
 
1256
        translated_rules = []
 
1257
        for rule in rules:
 
1258
            translated_rule = self._translate_ignore_rule(rule)
 
1259
            compiled_rule = re.compile(translated_rule)
 
1260
            groups[next_group] = rule
 
1261
            next_group += compiled_rule.groups
 
1262
            translated_rules.append(translated_rule)
 
1263
            if next_group == 99:
 
1264
                result.append((re.compile("|".join(translated_rules)), groups))
 
1265
                groups = {}
 
1266
                next_group = 0
 
1267
                translated_rules = []
 
1268
        if len(translated_rules):
 
1269
            result.append((re.compile("|".join(translated_rules)), groups))
 
1270
        return result
950
1271
 
951
1272
    def ignored_files(self):
952
1273
        """Yield list of PATH, IGNORE_PATTERN"""
953
1274
        for subp in self.extras():
954
1275
            pat = self.is_ignored(subp)
955
 
            if pat != None:
 
1276
            if pat is not None:
956
1277
                yield subp, pat
957
1278
 
958
 
 
959
1279
    def get_ignore_list(self):
960
1280
        """Return list of ignore patterns.
961
1281
 
962
1282
        Cached in the Tree object after the first call.
963
1283
        """
964
 
        if hasattr(self, '_ignorelist'):
965
 
            return self._ignorelist
966
 
 
967
 
        l = bzrlib.DEFAULT_IGNORE[:]
 
1284
        ignoreset = getattr(self, '_ignoreset', None)
 
1285
        if ignoreset is not None:
 
1286
            return ignoreset
 
1287
 
 
1288
        ignore_globs = set(bzrlib.DEFAULT_IGNORE)
 
1289
        ignore_globs.update(ignores.get_runtime_ignores())
 
1290
 
 
1291
        ignore_globs.update(ignores.get_user_ignores())
 
1292
 
968
1293
        if self.has_filename(bzrlib.IGNORE_FILENAME):
969
1294
            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
973
 
 
 
1295
            try:
 
1296
                ignore_globs.update(ignores.parse_ignore_file(f))
 
1297
            finally:
 
1298
                f.close()
 
1299
 
 
1300
        self._ignoreset = ignore_globs
 
1301
        self._ignore_regex = self._combine_ignore_rules(ignore_globs)
 
1302
        return ignore_globs
 
1303
 
 
1304
    def _get_ignore_rules_as_regex(self):
 
1305
        """Return a regex of the ignore rules and a mapping dict.
 
1306
 
 
1307
        :return: (ignore rules compiled regex, dictionary mapping rule group 
 
1308
        indices to original rule.)
 
1309
        """
 
1310
        if getattr(self, '_ignoreset', None) is None:
 
1311
            self.get_ignore_list()
 
1312
        return self._ignore_regex
974
1313
 
975
1314
    def is_ignored(self, filename):
976
1315
        r"""Check whether the filename matches an ignore pattern.
990
1329
        # treat dotfiles correctly and allows * to match /.
991
1330
        # Eventually it should be replaced with something more
992
1331
        # 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
 
1332
    
 
1333
        rules = self._get_ignore_rules_as_regex()
 
1334
        for regex, mapping in rules:
 
1335
            match = regex.match(filename)
 
1336
            if match is not None:
 
1337
                # one or more of the groups in mapping will have a non-None
 
1338
                # group match.
 
1339
                groups = match.groups()
 
1340
                rules = [mapping[group] for group in 
 
1341
                    mapping if groups[group] is not None]
 
1342
                return rules[0]
 
1343
        return None
1012
1344
 
1013
1345
    def kind(self, file_id):
1014
1346
        return file_kind(self.id2abspath(file_id))
1015
1347
 
1016
 
    @needs_read_lock
1017
1348
    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().
 
1349
        """Return the last revision of the branch for this tree.
 
1350
 
 
1351
        This format tree does not support a separate marker for last-revision
 
1352
        compared to the branch.
 
1353
 
 
1354
        See MutableTree.last_revision
1023
1355
        """
 
1356
        return self._last_revision()
 
1357
 
 
1358
    @needs_read_lock
 
1359
    def _last_revision(self):
 
1360
        """helper for get_parent_ids."""
1024
1361
        return self.branch.last_revision()
1025
1362
 
 
1363
    def is_locked(self):
 
1364
        return self._control_files.is_locked()
 
1365
 
1026
1366
    def lock_read(self):
1027
1367
        """See Branch.lock_read, and WorkingTree.unlock."""
1028
1368
        self.branch.lock_read()
1032
1372
            self.branch.unlock()
1033
1373
            raise
1034
1374
 
 
1375
    def lock_tree_write(self):
 
1376
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
 
1377
        self.branch.lock_read()
 
1378
        try:
 
1379
            return self._control_files.lock_write()
 
1380
        except:
 
1381
            self.branch.unlock()
 
1382
            raise
 
1383
 
1035
1384
    def lock_write(self):
1036
 
        """See Branch.lock_write, and WorkingTree.unlock."""
 
1385
        """See MutableTree.lock_write, and WorkingTree.unlock."""
1037
1386
        self.branch.lock_write()
1038
1387
        try:
1039
1388
            return self._control_files.lock_write()
1041
1390
            self.branch.unlock()
1042
1391
            raise
1043
1392
 
 
1393
    def get_physical_lock_status(self):
 
1394
        return self._control_files.get_physical_lock_status()
 
1395
 
1044
1396
    def _basis_inventory_name(self):
1045
 
        return 'basis-inventory'
 
1397
        return 'basis-inventory-cache'
1046
1398
 
1047
 
    @needs_write_lock
 
1399
    @needs_tree_write_lock
1048
1400
    def set_last_revision(self, new_revision):
1049
1401
        """Change the last revision in the working tree."""
1050
1402
        if self._change_last_revision(new_revision):
1059
1411
        if new_revision is None:
1060
1412
            self.branch.set_revision_history([])
1061
1413
            return False
1062
 
        # current format is locked in with the branch
1063
 
        revision_history = self.branch.revision_history()
1064
1414
        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])
 
1415
            self.branch.generate_revision_history(new_revision)
 
1416
        except errors.NoSuchRevision:
 
1417
            # not present in the repo - dont try to set it deeper than the tip
 
1418
            self.branch.set_revision_history([new_revision])
1069
1419
        return True
1070
1420
 
 
1421
    def _write_basis_inventory(self, xml):
 
1422
        """Write the basis inventory XML to the basis-inventory file"""
 
1423
        assert isinstance(xml, str), 'serialised xml must be bytestring.'
 
1424
        path = self._basis_inventory_name()
 
1425
        sio = StringIO(xml)
 
1426
        self._control_files.put(path, sio)
 
1427
 
 
1428
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
 
1429
        """Create the text that will be saved in basis-inventory"""
 
1430
        inventory.revision_id = revision_id
 
1431
        return bzrlib.xml6.serializer_v6.write_inventory_to_string(inventory)
 
1432
 
1071
1433
    def _cache_basis_inventory(self, new_revision):
1072
1434
        """Cache new_revision as the basis inventory."""
 
1435
        # TODO: this should allow the ready-to-use inventory to be passed in,
 
1436
        # as commit already has that ready-to-use [while the format is the
 
1437
        # same, that is].
1073
1438
        try:
1074
1439
            # this double handles the inventory - unpack and repack - 
1075
1440
            # but is easier to understand. We can/should put a conditional
1076
1441
            # in here based on whether the inventory is in the latest format
1077
1442
            # - perhaps we should repack all inventories on a repository
1078
1443
            # 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:
 
1444
            # the fast path is to copy the raw xml from the repository. If the
 
1445
            # xml contains 'revision_id="', then we assume the right 
 
1446
            # revision_id is set. We must check for this full string, because a
 
1447
            # root node id can legitimately look like 'revision_id' but cannot
 
1448
            # contain a '"'.
 
1449
            xml = self.branch.repository.get_inventory_xml(new_revision)
 
1450
            firstline = xml.split('\n', 1)[0]
 
1451
            if (not 'revision_id="' in firstline or 
 
1452
                'format="6"' not in firstline):
 
1453
                inv = self.branch.repository.deserialise_inventory(
 
1454
                    new_revision, xml)
 
1455
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
 
1456
            self._write_basis_inventory(xml)
 
1457
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1086
1458
            pass
1087
1459
 
1088
1460
    def read_basis_inventory(self):
1089
1461
        """Read the cached basis inventory."""
1090
1462
        path = self._basis_inventory_name()
1091
 
        return self._control_files.get_utf8(path).read()
 
1463
        return self._control_files.get(path).read()
1092
1464
        
1093
1465
    @needs_read_lock
1094
1466
    def read_working_inventory(self):
1100
1472
        self._set_inventory(result)
1101
1473
        return result
1102
1474
 
1103
 
    @needs_write_lock
1104
 
    def remove(self, files, verbose=False):
 
1475
    @needs_tree_write_lock
 
1476
    def remove(self, files, verbose=False, to_file=None):
1105
1477
        """Remove nominated files from the working inventory..
1106
1478
 
1107
1479
        This does not remove their text.  This does not run on XXX on what? RBC
1129
1501
                # TODO: Perhaps make this just a warning, and continue?
1130
1502
                # This tends to happen when 
1131
1503
                raise NotVersionedError(path=f)
1132
 
            mutter("remove inventory entry %s {%s}", quotefn(f), fid)
1133
1504
            if verbose:
1134
1505
                # having remove it, it must be either ignored or unknown
1135
1506
                if self.is_ignored(f):
1136
1507
                    new_status = 'I'
1137
1508
                else:
1138
1509
                    new_status = '?'
1139
 
                show_status(new_status, inv[fid].kind, quotefn(f))
 
1510
                show_status(new_status, inv[fid].kind, f, to_file=to_file)
1140
1511
            del inv[fid]
1141
1512
 
1142
1513
        self._write_inventory(inv)
1143
1514
 
1144
 
    @needs_write_lock
 
1515
    @needs_tree_write_lock
1145
1516
    def revert(self, filenames, old_tree=None, backups=True, 
1146
1517
               pb=DummyProgress()):
1147
1518
        from transform import revert
1150
1521
            old_tree = self.basis_tree()
1151
1522
        conflicts = revert(self, old_tree, filenames, backups, pb)
1152
1523
        if not len(filenames):
1153
 
            self.set_pending_merges([])
 
1524
            self.set_parent_ids(self.get_parent_ids()[:1])
1154
1525
            resolve(self)
1155
1526
        else:
1156
1527
            resolve(self, filenames, ignore_misses=True)
1158
1529
 
1159
1530
    # XXX: This method should be deprecated in favour of taking in a proper
1160
1531
    # new Inventory object.
1161
 
    @needs_write_lock
 
1532
    @needs_tree_write_lock
1162
1533
    def set_inventory(self, new_inventory_list):
1163
1534
        from bzrlib.inventory import (Inventory,
1164
1535
                                      InventoryDirectory,
1181
1552
                raise BzrError("unknown kind %r" % kind)
1182
1553
        self._write_inventory(inv)
1183
1554
 
1184
 
    @needs_write_lock
 
1555
    @needs_tree_write_lock
1185
1556
    def set_root_id(self, file_id):
1186
1557
        """Set the root id for this tree."""
1187
1558
        inv = self.read_working_inventory()
1204
1575
        between multiple working trees, i.e. via shared storage, then we 
1205
1576
        would probably want to lock both the local tree, and the branch.
1206
1577
        """
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
 
1578
        raise NotImplementedError(self.unlock)
1229
1579
 
1230
1580
    @needs_write_lock
1231
1581
    def update(self):
1248
1598
        Do a 'normal' merge of the old branch basis if it is relevant.
1249
1599
        """
1250
1600
        old_tip = self.branch.update()
1251
 
        if old_tip is not None:
1252
 
            self.add_pending_merge(old_tip)
1253
 
        self.branch.lock_read()
 
1601
        # here if old_tip is not None, it is the old tip of the branch before
 
1602
        # it was updated from the master branch. This should become a pending
 
1603
        # merge in the working tree to preserve the user existing work.  we
 
1604
        # cant set that until we update the working trees last revision to be
 
1605
        # one from the new branch, because it will just get absorbed by the
 
1606
        # parent de-duplication logic.
 
1607
        # 
 
1608
        # We MUST save it even if an error occurs, because otherwise the users
 
1609
        # local work is unreferenced and will appear to have been lost.
 
1610
        # 
 
1611
        result = 0
1254
1612
        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
1284
 
        finally:
1285
 
            self.branch.unlock()
 
1613
            last_rev = self.get_parent_ids()[0]
 
1614
        except IndexError:
 
1615
            last_rev = None
 
1616
        if last_rev != self.branch.last_revision():
 
1617
            # merge tree state up to new branch tip.
 
1618
            basis = self.basis_tree()
 
1619
            to_tree = self.branch.basis_tree()
 
1620
            result += merge_inner(self.branch,
 
1621
                                  to_tree,
 
1622
                                  basis,
 
1623
                                  this_tree=self)
 
1624
            # TODO - dedup parents list with things merged by pull ?
 
1625
            # reuse the tree we've updated to to set the basis:
 
1626
            parent_trees = [(self.branch.last_revision(), to_tree)]
 
1627
            merges = self.get_parent_ids()[1:]
 
1628
            # Ideally we ask the tree for the trees here, that way the working
 
1629
            # tree can decide whether to give us teh entire tree or give us a
 
1630
            # lazy initialised tree. dirstate for instance will have the trees
 
1631
            # in ram already, whereas a last-revision + basis-inventory tree
 
1632
            # will not, but also does not need them when setting parents.
 
1633
            for parent in merges:
 
1634
                parent_trees.append(
 
1635
                    (parent, self.branch.repository.revision_tree(parent)))
 
1636
            if old_tip is not None:
 
1637
                parent_trees.append(
 
1638
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
 
1639
            self.set_parent_trees(parent_trees)
 
1640
            last_rev = parent_trees[0][0]
 
1641
        else:
 
1642
            # the working tree had the same last-revision as the master
 
1643
            # branch did. We may still have pivot local work from the local
 
1644
            # branch into old_tip:
 
1645
            if old_tip is not None:
 
1646
                self.add_parent_tree_id(old_tip)
 
1647
        if old_tip and old_tip != last_rev:
 
1648
            # our last revision was not the prior branch last revision
 
1649
            # and we have converted that last revision to a pending merge.
 
1650
            # base is somewhere between the branch tip now
 
1651
            # and the now pending merge
 
1652
            from bzrlib.revision import common_ancestor
 
1653
            try:
 
1654
                base_rev_id = common_ancestor(self.branch.last_revision(),
 
1655
                                              old_tip,
 
1656
                                              self.branch.repository)
 
1657
            except errors.NoCommonAncestor:
 
1658
                base_rev_id = None
 
1659
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
1660
            other_tree = self.branch.repository.revision_tree(old_tip)
 
1661
            result += merge_inner(self.branch,
 
1662
                                  other_tree,
 
1663
                                  base_tree,
 
1664
                                  this_tree=self)
 
1665
        return result
1286
1666
 
1287
 
    @needs_write_lock
 
1667
    @needs_tree_write_lock
1288
1668
    def _write_inventory(self, inv):
1289
1669
        """Write inventory as the current inventory."""
1290
1670
        sio = StringIO()
1297
1677
    def set_conflicts(self, arg):
1298
1678
        raise UnsupportedOperation(self.set_conflicts, self)
1299
1679
 
 
1680
    def add_conflicts(self, arg):
 
1681
        raise UnsupportedOperation(self.add_conflicts, self)
 
1682
 
1300
1683
    @needs_read_lock
1301
1684
    def conflicts(self):
1302
1685
        conflicts = ConflictList()
1305
1688
            try:
1306
1689
                if file_kind(self.abspath(conflicted)) != "file":
1307
1690
                    text = False
1308
 
            except OSError, e:
1309
 
                if e.errno == errno.ENOENT:
1310
 
                    text = False
1311
 
                else:
1312
 
                    raise
 
1691
            except errors.NoSuchFile:
 
1692
                text = False
1313
1693
            if text is True:
1314
1694
                for suffix in ('.THIS', '.OTHER'):
1315
1695
                    try:
1316
1696
                        kind = file_kind(self.abspath(conflicted+suffix))
1317
 
                    except OSError, e:
1318
 
                        if e.errno == errno.ENOENT:
 
1697
                        if kind != "file":
1319
1698
                            text = False
1320
 
                            break
1321
 
                        else:
1322
 
                            raise
1323
 
                    if kind != "file":
 
1699
                    except errors.NoSuchFile:
1324
1700
                        text = False
 
1701
                    if text == False:
1325
1702
                        break
1326
1703
            ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1327
1704
            conflicts.append(Conflict.factory(ctype, path=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._hashcache.needs_write and self._control_files._lock_count==3:
 
1733
            self._hashcache.write()
 
1734
        # reverse order of locking.
 
1735
        try:
 
1736
            return self._control_files.unlock()
 
1737
        finally:
 
1738
            self.branch.unlock()
 
1739
 
 
1740
 
1332
1741
class WorkingTree3(WorkingTree):
1333
1742
    """This is the Format 3 working tree.
1334
1743
 
1340
1749
    """
1341
1750
 
1342
1751
    @needs_read_lock
1343
 
    def last_revision(self):
1344
 
        """See WorkingTree.last_revision."""
 
1752
    def _last_revision(self):
 
1753
        """See Mutable.last_revision."""
1345
1754
        try:
1346
1755
            return self._control_files.get_utf8('last-revision').read()
1347
1756
        except NoSuchFile:
1356
1765
                pass
1357
1766
            return False
1358
1767
        else:
1359
 
            try:
1360
 
                self.branch.revision_history().index(revision_id)
1361
 
            except ValueError:
1362
 
                raise errors.NoSuchRevision(self.branch, revision_id)
1363
1768
            self._control_files.put_utf8('last-revision', revision_id)
1364
1769
            return True
1365
1770
 
1366
 
    @needs_write_lock
 
1771
    @needs_tree_write_lock
1367
1772
    def set_conflicts(self, conflicts):
1368
1773
        self._put_rio('conflicts', conflicts.to_stanzas(), 
1369
1774
                      CONFLICT_HEADER_1)
1370
1775
 
 
1776
    @needs_tree_write_lock
 
1777
    def add_conflicts(self, new_conflicts):
 
1778
        conflict_set = set(self.conflicts())
 
1779
        conflict_set.update(set(list(new_conflicts)))
 
1780
        self.set_conflicts(ConflictList(sorted(conflict_set,
 
1781
                                               key=Conflict.sort_key)))
 
1782
 
1371
1783
    @needs_read_lock
1372
1784
    def conflicts(self):
1373
1785
        try:
1381
1793
            raise ConflictFormatError()
1382
1794
        return ConflictList.from_stanzas(RioReader(confile))
1383
1795
 
 
1796
    def unlock(self):
 
1797
        if self._hashcache.needs_write and self._control_files._lock_count==1:
 
1798
            self._hashcache.write()
 
1799
        # reverse order of locking.
 
1800
        try:
 
1801
            return self._control_files.unlock()
 
1802
        finally:
 
1803
            self.branch.unlock()
 
1804
 
1384
1805
 
1385
1806
def get_conflicted_stem(path):
1386
1807
    for suffix in CONFLICT_SUFFIXES:
1437
1858
        except NoSuchFile:
1438
1859
            raise errors.NoWorkingTree(base=transport.base)
1439
1860
        except KeyError:
1440
 
            raise errors.UnknownFormatError(format_string)
 
1861
            raise errors.UnknownFormatError(format=format_string)
1441
1862
 
1442
1863
    @classmethod
1443
1864
    def get_default_format(klass):
1486
1907
        """See WorkingTreeFormat.get_format_description()."""
1487
1908
        return "Working tree format 2"
1488
1909
 
 
1910
    def stub_initialize_remote(self, control_files):
 
1911
        """As a special workaround create critical control files for a remote working tree
 
1912
        
 
1913
        This ensures that it can later be updated and dealt with locally,
 
1914
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with 
 
1915
        no working tree.  (See bug #43064).
 
1916
        """
 
1917
        sio = StringIO()
 
1918
        inv = Inventory()
 
1919
        bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
 
1920
        sio.seek(0)
 
1921
        control_files.put('inventory', sio)
 
1922
 
 
1923
        control_files.put_utf8('pending-merges', '')
 
1924
        
 
1925
 
1489
1926
    def initialize(self, a_bzrdir, revision_id=None):
1490
1927
        """See WorkingTreeFormat.initialize()."""
1491
1928
        if not isinstance(a_bzrdir.transport, LocalTransport):
1503
1940
            finally:
1504
1941
                branch.unlock()
1505
1942
        revision = branch.last_revision()
1506
 
        inv = Inventory() 
1507
 
        wt = WorkingTree(a_bzrdir.root_transport.base,
 
1943
        inv = Inventory()
 
1944
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1508
1945
                         branch,
1509
1946
                         inv,
1510
1947
                         _internal=True,
1512
1949
                         _bzrdir=a_bzrdir)
1513
1950
        wt._write_inventory(inv)
1514
1951
        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)
 
1952
        basis_tree = branch.repository.revision_tree(revision)
 
1953
        wt.set_parent_trees([(revision, basis_tree)])
 
1954
        build_tree(basis_tree, wt)
1518
1955
        return wt
1519
1956
 
1520
1957
    def __init__(self):
1532
1969
            raise NotImplementedError
1533
1970
        if not isinstance(a_bzrdir.transport, LocalTransport):
1534
1971
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
1535
 
        return WorkingTree(a_bzrdir.root_transport.base,
 
1972
        return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1536
1973
                           _internal=True,
1537
1974
                           _format=self,
1538
1975
                           _bzrdir=a_bzrdir)
1547
1984
          files, separate from the BzrDir format
1548
1985
        - modifies the hash cache format
1549
1986
        - is new in bzr 0.8
1550
 
        - uses a LockDir to guard access to the repository
 
1987
        - uses a LockDir to guard access for writes.
1551
1988
    """
1552
1989
 
1553
1990
    def get_format_string(self):
1569
2006
    def initialize(self, a_bzrdir, revision_id=None):
1570
2007
        """See WorkingTreeFormat.initialize().
1571
2008
        
1572
 
        revision_id allows creating a working tree at a differnet
 
2009
        revision_id allows creating a working tree at a different
1573
2010
        revision than the branch is at.
1574
2011
        """
1575
2012
        if not isinstance(a_bzrdir.transport, LocalTransport):
1577
2014
        transport = a_bzrdir.get_workingtree_transport(self)
1578
2015
        control_files = self._open_control_files(a_bzrdir)
1579
2016
        control_files.create_lock()
 
2017
        control_files.lock_write()
1580
2018
        control_files.put_utf8('format', self.get_format_string())
1581
2019
        branch = a_bzrdir.open_branch()
1582
2020
        if revision_id is None:
1583
2021
            revision_id = branch.last_revision()
1584
2022
        inv = Inventory() 
1585
 
        wt = WorkingTree3(a_bzrdir.root_transport.base,
 
2023
        wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1586
2024
                         branch,
1587
2025
                         inv,
1588
2026
                         _internal=True,
1589
2027
                         _format=self,
1590
2028
                         _bzrdir=a_bzrdir,
1591
2029
                         _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)
 
2030
        wt.lock_tree_write()
 
2031
        try:
 
2032
            wt._write_inventory(inv)
 
2033
            wt.set_root_id(inv.root.file_id)
 
2034
            basis_tree = branch.repository.revision_tree(revision_id)
 
2035
            if revision_id == bzrlib.revision.NULL_REVISION:
 
2036
                wt.set_parent_trees([])
 
2037
            else:
 
2038
                wt.set_parent_trees([(revision_id, basis_tree)])
 
2039
            build_tree(basis_tree, wt)
 
2040
        finally:
 
2041
            wt.unlock()
 
2042
            control_files.unlock()
1597
2043
        return wt
1598
2044
 
1599
2045
    def __init__(self):
1611
2057
            raise NotImplementedError
1612
2058
        if not isinstance(a_bzrdir.transport, LocalTransport):
1613
2059
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
1614
 
        control_files = self._open_control_files(a_bzrdir)
1615
 
        return WorkingTree3(a_bzrdir.root_transport.base,
 
2060
        return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
 
2061
 
 
2062
    def _open(self, a_bzrdir, control_files):
 
2063
        """Open the tree itself.
 
2064
        
 
2065
        :param a_bzrdir: the dir for the tree.
 
2066
        :param control_files: the control files for the tree.
 
2067
        """
 
2068
        return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1616
2069
                           _internal=True,
1617
2070
                           _format=self,
1618
2071
                           _bzrdir=a_bzrdir,
1645
2098
        self._transport_readonly_server = transport_readonly_server
1646
2099
        self._formats = formats
1647
2100
    
 
2101
    def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
 
2102
        """Clone test for adaption."""
 
2103
        new_test = deepcopy(test)
 
2104
        new_test.transport_server = self._transport_server
 
2105
        new_test.transport_readonly_server = self._transport_readonly_server
 
2106
        new_test.bzrdir_format = bzrdir_format
 
2107
        new_test.workingtree_format = workingtree_format
 
2108
        def make_new_test_id():
 
2109
            new_id = "%s(%s)" % (test.id(), variation)
 
2110
            return lambda: new_id
 
2111
        new_test.id = make_new_test_id()
 
2112
        return new_test
 
2113
    
1648
2114
    def adapt(self, test):
1649
2115
        from bzrlib.tests import TestSuite
1650
2116
        result = TestSuite()
1651
2117
        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()
 
2118
            new_test = self._clone_test(
 
2119
                test,
 
2120
                bzrdir_format,
 
2121
                workingtree_format, workingtree_format.__class__.__name__)
1661
2122
            result.addTest(new_test)
1662
2123
        return result