/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

(Andrew Bennetts, Robert Collins) Create a new test helper start_bzr_subprocess which is paired with finish_bzr_subprocess, allowing tests that need to interact with the upcoming bzr serve command.

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,
71
73
from bzrlib.merge import merge_inner, transform_tree
72
74
from bzrlib.osutils import (
73
75
                            abspath,
74
 
                            appendpath,
75
76
                            compact_date,
76
77
                            file_kind,
77
78
                            isdir,
80
81
                            pumpfile,
81
82
                            safe_unicode,
82
83
                            splitpath,
83
 
                            rand_bytes,
 
84
                            rand_chars,
84
85
                            normpath,
85
86
                            realpath,
86
87
                            relpath,
90
91
from bzrlib.progress import DummyProgress, ProgressPhase
91
92
from bzrlib.revision import NULL_REVISION
92
93
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
 
94
from bzrlib.symbol_versioning import (deprecated_passed,
 
95
        deprecated_method,
 
96
        deprecated_function,
 
97
        DEPRECATED_PARAMETER,
 
98
        zero_eight,
 
99
        zero_eleven,
 
100
        )
 
101
from bzrlib.trace import mutter, note
96
102
from bzrlib.transform import build_tree
97
 
from bzrlib.trace import mutter, note
98
103
from bzrlib.transport import get_transport
99
104
from bzrlib.transport.local import LocalTransport
 
105
from bzrlib.textui import show_status
 
106
import bzrlib.tree
100
107
import bzrlib.ui
101
108
import bzrlib.xml5
102
109
 
103
110
 
 
111
# the regex removes any weird characters; we don't escape them 
 
112
# but rather just pull them out
 
113
_gen_file_id_re = re.compile(r'[^\w.]')
 
114
_gen_id_suffix = None
 
115
_gen_id_serial = 0
 
116
 
 
117
 
 
118
def _next_id_suffix():
 
119
    """Create a new file id suffix that is reasonably unique.
 
120
    
 
121
    On the first call we combine the current time with 64 bits of randomness
 
122
    to give a highly probably globally unique number. Then each call in the same
 
123
    process adds 1 to a serial number we append to that unique value.
 
124
    """
 
125
    # XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather 
 
126
    # than having to move the id randomness out of the inner loop like this.
 
127
    # XXX TODO: for the global randomness this uses we should add the thread-id
 
128
    # before the serial #.
 
129
    global _gen_id_suffix, _gen_id_serial
 
130
    if _gen_id_suffix is None:
 
131
        _gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
 
132
    _gen_id_serial += 1
 
133
    return _gen_id_suffix + str(_gen_id_serial)
 
134
 
 
135
 
104
136
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))
 
137
    """Return new file id for the basename 'name'.
 
138
 
 
139
    The uniqueness is supplied from _next_id_suffix.
 
140
    """
 
141
    # The real randomness is in the _next_id_suffix, the
 
142
    # rest of the identifier is just to be nice.
 
143
    # So we:
 
144
    # 1) Remove non-ascii word characters to keep the ids portable
 
145
    # 2) squash to lowercase, so the file id doesn't have to
 
146
    #    be escaped (case insensitive filesystems would bork for ids
 
147
    #    that only differred in case without escaping).
 
148
    # 3) truncate the filename to 20 chars. Long filenames also bork on some
 
149
    #    filesystems
 
150
    # 4) Removing starting '.' characters to prevent the file ids from
 
151
    #    being considered hidden.
 
152
    ascii_word_only = _gen_file_id_re.sub('', name.lower())
 
153
    short_no_dots = ascii_word_only.lstrip('.')[:20]
 
154
    return short_no_dots + _next_id_suffix()
131
155
 
132
156
 
133
157
def gen_root_id():
135
159
    return gen_file_id('TREE_ROOT')
136
160
 
137
161
 
 
162
def needs_tree_write_lock(unbound):
 
163
    """Decorate unbound to take out and release a tree_write lock."""
 
164
    def tree_write_locked(self, *args, **kwargs):
 
165
        self.lock_tree_write()
 
166
        try:
 
167
            return unbound(self, *args, **kwargs)
 
168
        finally:
 
169
            self.unlock()
 
170
    tree_write_locked.__doc__ = unbound.__doc__
 
171
    tree_write_locked.__name__ = unbound.__name__
 
172
    return tree_write_locked
 
173
 
 
174
 
138
175
class TreeEntry(object):
139
 
    """An entry that implements the minium interface used by commands.
 
176
    """An entry that implements the minimum interface used by commands.
140
177
 
141
178
    This needs further inspection, it may be better to have 
142
179
    InventoryEntries without ids - though that seems wrong. For now,
218
255
        self.bzrdir = _bzrdir
219
256
        if not _internal:
220
257
            # not created via open etc.
221
 
            warn("WorkingTree() is deprecated as of bzr version 0.8. "
 
258
            warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
222
259
                 "Please use bzrdir.open_workingtree or WorkingTree.open().",
223
260
                 DeprecationWarning,
224
261
                 stacklevel=2)
225
262
            wt = WorkingTree.open(basedir)
226
 
            self.branch = wt.branch
 
263
            self._branch = wt.branch
227
264
            self.basedir = wt.basedir
228
265
            self._control_files = wt._control_files
229
266
            self._hashcache = wt._hashcache
238
275
        mutter("opening working tree %r", basedir)
239
276
        if deprecated_passed(branch):
240
277
            if not _internal:
241
 
                warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
 
278
                warnings.warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
242
279
                     " Please use bzrdir.open_workingtree() or"
243
280
                     " WorkingTree.open().",
244
281
                     DeprecationWarning,
245
282
                     stacklevel=2
246
283
                     )
247
 
            self.branch = branch
 
284
            self._branch = branch
248
285
        else:
249
 
            self.branch = self.bzrdir.open_branch()
250
 
        assert isinstance(self.branch, Branch), \
251
 
            "branch %r is not a Branch" % self.branch
 
286
            self._branch = self.bzrdir.open_branch()
252
287
        self.basedir = realpath(basedir)
253
288
        # if branch is at our basedir and is a format 6 or less
254
289
        if isinstance(self._format, WorkingTreeFormat2):
255
290
            # share control object
256
291
            self._control_files = self.branch.control_files
257
292
        else:
258
 
            # only ready for format 3
259
 
            assert isinstance(self._format, WorkingTreeFormat3)
 
293
            # assume all other formats have their own control files.
260
294
            assert isinstance(_control_files, LockableFiles), \
261
295
                    "_control_files must be a LockableFiles, not %r" \
262
296
                    % _control_files
267
301
        # if needed, or, when the cache sees a change, append it to the hash
268
302
        # cache file, and have the parser take the most recent entry for a
269
303
        # given path only.
270
 
        cache_filename = self.bzrdir.get_workingtree_transport(None).abspath('stat-cache')
 
304
        cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
271
305
        hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
272
306
        hc.read()
273
307
        # is this scan needed ? it makes things kinda slow.
274
 
        hc.scan()
 
308
        #hc.scan()
275
309
 
276
310
        if hc.needs_write:
277
311
            mutter("write hc")
282
316
        else:
283
317
            self._set_inventory(_inventory)
284
318
 
 
319
    branch = property(
 
320
        fget=lambda self: self._branch,
 
321
        doc="""The branch this WorkingTree is connected to.
 
322
 
 
323
            This cannot be set - it is reflective of the actual disk structure
 
324
            the working tree has been constructed from.
 
325
            """)
 
326
 
 
327
    def break_lock(self):
 
328
        """Break a lock if one is present from another instance.
 
329
 
 
330
        Uses the ui factory to ask for confirmation if the lock may be from
 
331
        an active process.
 
332
 
 
333
        This will probe the repository for its lock as well.
 
334
        """
 
335
        self._control_files.break_lock()
 
336
        self.branch.break_lock()
 
337
 
285
338
    def _set_inventory(self, inv):
 
339
        assert inv.root is not None
286
340
        self._inventory = inv
287
341
        self.path2id = self._inventory.path2id
288
342
 
289
343
    def is_control_filename(self, filename):
290
344
        """True if filename is the name of a control file in this tree.
291
345
        
 
346
        :param filename: A filename within the tree. This is a relative path
 
347
        from the root of this tree.
 
348
 
292
349
        This is true IF and ONLY IF the filename is part of the meta data
293
350
        that bzr controls in this tree. I.E. a random .bzr directory placed
294
351
        on disk will not be a control file for this tree.
295
352
        """
296
 
        try:
297
 
            self.bzrdir.transport.relpath(self.abspath(filename))
298
 
            return True
299
 
        except errors.PathNotChild:
300
 
            return False
 
353
        return self.bzrdir.is_control_filename(filename)
301
354
 
302
355
    @staticmethod
303
356
    def open(path=None, _unsupported=False):
319
372
        run into /.  If there isn't one, raises NotBranchError.
320
373
        TODO: give this a new exception.
321
374
        If there is one, it is returned, along with the unused portion of path.
 
375
 
 
376
        :return: The WorkingTree that contains 'path', and the rest of path
322
377
        """
323
378
        if path is None:
324
 
            path = os.getcwdu()
 
379
            path = osutils.getcwd()
325
380
        control, relpath = bzrdir.BzrDir.open_containing(path)
 
381
 
326
382
        return control.open_workingtree(), relpath
327
383
 
328
384
    @staticmethod
341
397
        """
342
398
        inv = self._inventory
343
399
        for path, ie in inv.iter_entries():
344
 
            if bzrlib.osutils.lexists(self.abspath(path)):
 
400
            if osutils.lexists(self.abspath(path)):
345
401
                yield ie.file_id
346
402
 
347
403
    def __repr__(self):
352
408
        return pathjoin(self.basedir, filename)
353
409
    
354
410
    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:
 
411
        """Return RevisionTree for the current last revision.
 
412
        
 
413
        If the left most parent is a ghost then the returned tree will be an
 
414
        empty tree - one obtained by calling repository.revision_tree(None).
 
415
        """
 
416
        try:
 
417
            revision_id = self.get_parent_ids()[0]
 
418
        except IndexError:
 
419
            # no parents, return an empty revision tree.
 
420
            # in the future this should return the tree for
 
421
            # 'empty:' - the implicit root empty tree.
 
422
            return self.branch.repository.revision_tree(None)
 
423
        else:
358
424
            try:
359
425
                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)
 
426
                inv = bzrlib.xml6.serializer_v6.read_inventory_from_string(xml)
 
427
                if inv is not None and inv.revision_id == revision_id:
 
428
                    return bzrlib.tree.RevisionTree(self.branch.repository, 
 
429
                                                    inv, revision_id)
 
430
            except (NoSuchFile, errors.BadInventoryFormat):
 
431
                pass
 
432
        # No cached copy available, retrieve from the repository.
 
433
        # FIXME? RBC 20060403 should we cache the inventory locally
 
434
        # at this point ?
 
435
        try:
 
436
            return self.branch.repository.revision_tree(revision_id)
 
437
        except errors.RevisionNotPresent:
 
438
            # the basis tree *may* be a ghost or a low level error may have
 
439
            # occured. If the revision is present, its a problem, if its not
 
440
            # its a ghost.
 
441
            if self.branch.repository.has_revision(revision_id):
 
442
                raise
 
443
            # the basis tree is a ghost so return an empty tree.
 
444
            return self.branch.repository.revision_tree(None)
368
445
 
369
446
    @staticmethod
370
447
    @deprecated_method(zero_eight)
383
460
        XXX: When BzrDir is present, these should be created through that 
384
461
        interface instead.
385
462
        """
386
 
        warn('delete WorkingTree.create', stacklevel=3)
 
463
        warnings.warn('delete WorkingTree.create', stacklevel=3)
387
464
        transport = get_transport(directory)
388
465
        if branch.bzrdir.root_transport.base == transport.base:
389
466
            # same dir 
404
481
        """
405
482
        return bzrdir.BzrDir.create_standalone_workingtree(directory)
406
483
 
407
 
    def relpath(self, abs):
408
 
        """Return the local path portion from a given absolute path."""
409
 
        return relpath(self.basedir, abs)
 
484
    def relpath(self, path):
 
485
        """Return the local path portion from a given path.
 
486
        
 
487
        The path may be absolute or relative. If its a relative path it is 
 
488
        interpreted relative to the python current working directory.
 
489
        """
 
490
        return relpath(self.basedir, path)
410
491
 
411
492
    def has_filename(self, filename):
412
 
        return bzrlib.osutils.lexists(self.abspath(filename))
 
493
        return osutils.lexists(self.abspath(filename))
413
494
 
414
495
    def get_file(self, file_id):
415
496
        return self.get_file_byname(self.id2path(file_id))
416
497
 
 
498
    def get_file_text(self, file_id):
 
499
        return self.get_file(file_id).read()
 
500
 
417
501
    def get_file_byname(self, filename):
418
502
        return file(self.abspath(filename), 'rb')
419
503
 
 
504
    def get_parent_ids(self):
 
505
        """See Tree.get_parent_ids.
 
506
        
 
507
        This implementation reads the pending merges list and last_revision
 
508
        value and uses that to decide what the parents list should be.
 
509
        """
 
510
        last_rev = self._last_revision()
 
511
        if last_rev is None:
 
512
            parents = []
 
513
        else:
 
514
            parents = [last_rev]
 
515
        try:
 
516
            merges_file = self._control_files.get_utf8('pending-merges')
 
517
        except NoSuchFile:
 
518
            pass
 
519
        else:
 
520
            for l in merges_file.readlines():
 
521
                parents.append(l.rstrip('\n'))
 
522
        return parents
 
523
 
420
524
    def get_root_id(self):
421
525
        """Return the id of this trees root"""
422
526
        inv = self.read_working_inventory()
455
559
        if revision_id is None:
456
560
            transform_tree(tree, self)
457
561
        else:
458
 
            # TODO now merge from tree.last_revision to revision
 
562
            # TODO now merge from tree.last_revision to revision (to preserve
 
563
            # user local changes)
459
564
            transform_tree(tree, self)
460
 
            tree.set_last_revision(revision_id)
 
565
            tree.set_parent_ids([revision_id])
461
566
 
462
567
    @needs_write_lock
463
568
    def commit(self, message=None, revprops=None, *args, **kwargs):
471
576
        # but with branch a kwarg now, passing in args as is results in the
472
577
        #message being used for the branch
473
578
        args = (DEPRECATED_PARAMETER, message, ) + args
474
 
        Commit().commit(working_tree=self, revprops=revprops, *args, **kwargs)
475
 
        self._set_inventory(self.read_working_inventory())
 
579
        committed_id = Commit().commit( working_tree=self, revprops=revprops,
 
580
            *args, **kwargs)
 
581
        return committed_id
476
582
 
477
583
    def id2abspath(self, file_id):
478
584
        return self.abspath(self.id2path(file_id))
483
589
        if not inv.has_id(file_id):
484
590
            return False
485
591
        path = inv.id2path(file_id)
486
 
        return bzrlib.osutils.lexists(self.abspath(path))
 
592
        return osutils.lexists(self.abspath(path))
487
593
 
488
594
    def has_or_had_id(self, file_id):
489
595
        if file_id == self.inventory.root.file_id:
496
602
        return os.path.getsize(self.id2abspath(file_id))
497
603
 
498
604
    @needs_read_lock
499
 
    def get_file_sha1(self, file_id):
500
 
        path = self._inventory.id2path(file_id)
 
605
    def get_file_sha1(self, file_id, path=None):
 
606
        if not path:
 
607
            path = self._inventory.id2path(file_id)
501
608
        return self._hashcache.get_sha1(path)
502
609
 
503
 
    def is_executable(self, file_id):
504
 
        if not supports_executable():
 
610
    def get_file_mtime(self, file_id, path=None):
 
611
        if not path:
 
612
            path = self._inventory.id2path(file_id)
 
613
        return os.lstat(self.abspath(path)).st_mtime
 
614
 
 
615
    if not supports_executable():
 
616
        def is_executable(self, file_id, path=None):
505
617
            return self._inventory[file_id].executable
506
 
        else:
507
 
            path = self._inventory.id2path(file_id)
 
618
    else:
 
619
        def is_executable(self, file_id, path=None):
 
620
            if not path:
 
621
                path = self._inventory.id2path(file_id)
508
622
            mode = os.lstat(self.abspath(path)).st_mode
509
 
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
 
623
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
510
624
 
511
 
    @needs_write_lock
 
625
    @needs_tree_write_lock
512
626
    def add(self, files, ids=None):
513
627
        """Make files versioned.
514
628
 
547
661
        inv = self.read_working_inventory()
548
662
        for f,file_id in zip(files, ids):
549
663
            if self.is_control_filename(f):
550
 
                raise BzrError("cannot add control file %s" % quotefn(f))
 
664
                raise errors.ForbiddenControlFileError(filename=f)
551
665
 
552
666
            fp = splitpath(f)
553
667
 
555
669
                raise BzrError("cannot add top-level %r" % f)
556
670
 
557
671
            fullpath = normpath(self.abspath(f))
558
 
 
559
672
            try:
560
673
                kind = file_kind(fullpath)
561
674
            except OSError, e:
562
675
                if e.errno == errno.ENOENT:
563
676
                    raise NoSuchFile(fullpath)
564
 
                # maybe something better?
565
 
                raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
566
 
 
567
677
            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
 
 
 
678
                raise errors.BadFileKindError(filename=f, kind=kind)
571
679
            if file_id is None:
572
 
                file_id = gen_file_id(f)
573
 
            inv.add_path(f, kind=kind, file_id=file_id)
 
680
                inv.add_path(f, kind=kind)
 
681
            else:
 
682
                inv.add_path(f, kind=kind, file_id=file_id)
574
683
 
575
 
            mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
576
684
        self._write_inventory(inv)
577
685
 
578
 
    @needs_write_lock
 
686
    @needs_tree_write_lock
 
687
    def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
 
688
        """Add revision_id as a parent.
 
689
 
 
690
        This is equivalent to retrieving the current list of parent ids
 
691
        and setting the list to its value plus revision_id.
 
692
 
 
693
        :param revision_id: The revision id to add to the parent list. It may
 
694
        be a ghost revision as long as its not the first parent to be added,
 
695
        or the allow_leftmost_as_ghost parameter is set True.
 
696
        :param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
 
697
        """
 
698
        parents = self.get_parent_ids() + [revision_id]
 
699
        self.set_parent_ids(parents,
 
700
            allow_leftmost_as_ghost=len(parents) > 1 or allow_leftmost_as_ghost)
 
701
 
 
702
    @needs_tree_write_lock
 
703
    def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
 
704
        """Add revision_id, tree tuple as a parent.
 
705
 
 
706
        This is equivalent to retrieving the current list of parent trees
 
707
        and setting the list to its value plus parent_tuple. See also
 
708
        add_parent_tree_id - if you only have a parent id available it will be
 
709
        simpler to use that api. If you have the parent already available, using
 
710
        this api is preferred.
 
711
 
 
712
        :param parent_tuple: The (revision id, tree) to add to the parent list.
 
713
            If the revision_id is a ghost, pass None for the tree.
 
714
        :param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
 
715
        """
 
716
        parent_ids = self.get_parent_ids() + [parent_tuple[0]]
 
717
        if len(parent_ids) > 1:
 
718
            # the leftmost may have already been a ghost, preserve that if it
 
719
            # was.
 
720
            allow_leftmost_as_ghost = True
 
721
        self.set_parent_ids(parent_ids,
 
722
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
723
 
 
724
    @needs_tree_write_lock
579
725
    def add_pending_merge(self, *revision_ids):
580
726
        # TODO: Perhaps should check at this point that the
581
727
        # history of the revision is actually present?
582
 
        p = self.pending_merges()
 
728
        parents = self.get_parent_ids()
583
729
        updated = False
584
730
        for rev_id in revision_ids:
585
 
            if rev_id in p:
 
731
            if rev_id in parents:
586
732
                continue
587
 
            p.append(rev_id)
 
733
            parents.append(rev_id)
588
734
            updated = True
589
735
        if updated:
590
 
            self.set_pending_merges(p)
 
736
            self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
591
737
 
 
738
    @deprecated_method(zero_eleven)
592
739
    @needs_read_lock
593
740
    def pending_merges(self):
594
741
        """Return a list of pending merges.
595
742
 
596
743
        These are revisions that have been merged into the working
597
744
        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
 
745
 
 
746
        As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
 
747
        instead - which is available on all tree objects.
 
748
        """
 
749
        return self.get_parent_ids()[1:]
 
750
 
 
751
    @needs_tree_write_lock
 
752
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
 
753
        """Set the parent ids to revision_ids.
 
754
        
 
755
        See also set_parent_trees. This api will try to retrieve the tree data
 
756
        for each element of revision_ids from the trees repository. If you have
 
757
        tree data already available, it is more efficient to use
 
758
        set_parent_trees rather than set_parent_ids. set_parent_ids is however
 
759
        an easier API to use.
 
760
 
 
761
        :param revision_ids: The revision_ids to set as the parent ids of this
 
762
            working tree. Any of these may be ghosts.
 
763
        """
 
764
        if len(revision_ids) > 0:
 
765
            leftmost_id = revision_ids[0]
 
766
            if (not allow_leftmost_as_ghost and not
 
767
                self.branch.repository.has_revision(leftmost_id)):
 
768
                raise errors.GhostRevisionUnusableHere(leftmost_id)
 
769
            self.set_last_revision(leftmost_id)
 
770
        else:
 
771
            self.set_last_revision(None)
 
772
        merges = revision_ids[1:]
 
773
        self._control_files.put_utf8('pending-merges', '\n'.join(merges))
 
774
 
 
775
    @needs_tree_write_lock
 
776
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
 
777
        """Set the parents of the working tree.
 
778
 
 
779
        :param parents_list: A list of (revision_id, tree) tuples. 
 
780
            If tree is None, then that element is treated as an unreachable
 
781
            parent tree - i.e. a ghost.
 
782
        """
 
783
        # parent trees are not used in current format trees, delegate to
 
784
        # set_parent_ids
 
785
        self.set_parent_ids([rev for (rev, tree) in parents_list],
 
786
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
787
 
 
788
    @needs_tree_write_lock
611
789
    def set_pending_merges(self, rev_list):
612
 
        self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
 
790
        parents = self.get_parent_ids()
 
791
        leftmost = parents[:1]
 
792
        new_parents = leftmost + rev_list
 
793
        self.set_parent_ids(new_parents)
613
794
 
614
 
    @needs_write_lock
 
795
    @needs_tree_write_lock
615
796
    def set_merge_modified(self, modified_hashes):
616
797
        def iter_stanzas():
617
798
            for file_id, hash in modified_hashes.iteritems():
618
799
                yield Stanza(file_id=file_id, hash=hash)
619
800
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
620
801
 
621
 
    @needs_write_lock
 
802
    @needs_tree_write_lock
622
803
    def _put_rio(self, filename, stanzas, header):
623
804
        my_file = rio_file(stanzas, header)
624
805
        self._control_files.put(filename, my_file)
625
806
 
 
807
    @needs_write_lock # because merge pulls data into the branch.
 
808
    def merge_from_branch(self, branch, to_revision=None):
 
809
        """Merge from a branch into this working tree.
 
810
 
 
811
        :param branch: The branch to merge from.
 
812
        :param to_revision: If non-None, the merge will merge to to_revision, but 
 
813
            not beyond it. to_revision does not need to be in the history of
 
814
            the branch when it is supplied. If None, to_revision defaults to
 
815
            branch.last_revision().
 
816
        """
 
817
        from bzrlib.merge import Merger, Merge3Merger
 
818
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
819
        try:
 
820
            merger = Merger(self.branch, this_tree=self, pb=pb)
 
821
            merger.pp = ProgressPhase("Merge phase", 5, pb)
 
822
            merger.pp.next_phase()
 
823
            # check that there are no
 
824
            # local alterations
 
825
            merger.check_basis(check_clean=True, require_commits=False)
 
826
            if to_revision is None:
 
827
                to_revision = branch.last_revision()
 
828
            merger.other_rev_id = to_revision
 
829
            if merger.other_rev_id is None:
 
830
                raise error.NoCommits(branch)
 
831
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
832
            merger.other_basis = merger.other_rev_id
 
833
            merger.other_tree = self.branch.repository.revision_tree(
 
834
                merger.other_rev_id)
 
835
            merger.pp.next_phase()
 
836
            merger.find_base()
 
837
            if merger.base_rev_id == merger.other_rev_id:
 
838
                raise errors.PointlessMerge
 
839
            merger.backup_files = False
 
840
            merger.merge_type = Merge3Merger
 
841
            merger.set_interesting_files(None)
 
842
            merger.show_base = False
 
843
            merger.reprocess = False
 
844
            conflicts = merger.do_merge()
 
845
            merger.set_pending()
 
846
        finally:
 
847
            pb.finished()
 
848
        return conflicts
 
849
 
626
850
    @needs_read_lock
627
851
    def merge_modified(self):
628
852
        try:
656
880
            return '?'
657
881
 
658
882
    def list_files(self):
659
 
        """Recursively list all files as (path, class, kind, id).
 
883
        """Recursively list all files as (path, class, kind, id, entry).
660
884
 
661
885
        Lists, but does not descend into unversioned directories.
662
886
 
666
890
        Skips the control directory.
667
891
        """
668
892
        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:
 
893
        # Convert these into local objects to save lookup times
 
894
        pathjoin = osutils.pathjoin
 
895
        file_kind = osutils.file_kind
 
896
 
 
897
        # transport.base ends in a slash, we want the piece
 
898
        # between the last two slashes
 
899
        transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
 
900
 
 
901
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
 
902
 
 
903
        # directory file_id, relative path, absolute path, reverse sorted children
 
904
        children = os.listdir(self.basedir)
 
905
        children.sort()
 
906
        # jam 20060527 The kernel sized tree seems equivalent whether we 
 
907
        # use a deque and popleft to keep them sorted, or if we use a plain
 
908
        # list and just reverse() them.
 
909
        children = collections.deque(children)
 
910
        stack = [(inv.root.file_id, u'', self.basedir, children)]
 
911
        while stack:
 
912
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
 
913
 
 
914
            while children:
 
915
                f = children.popleft()
674
916
                ## TODO: If we find a subdirectory with its own .bzr
675
917
                ## directory, then that is a separate tree and we
676
918
                ## should exclude it.
677
919
 
678
920
                # the bzrdir for this tree
679
 
                if self.bzrdir.transport.base.endswith(f + '/'):
 
921
                if transport_base_dir == f:
680
922
                    continue
681
923
 
682
 
                # path within tree
683
 
                fp = appendpath(from_dir_relpath, f)
 
924
                # we know that from_dir_relpath and from_dir_abspath never end in a slash
 
925
                # and 'f' doesn't begin with one, we can do a string op, rather
 
926
                # than the checks of pathjoin(), all relative paths will have an extra slash
 
927
                # at the beginning
 
928
                fp = from_dir_relpath + '/' + f
684
929
 
685
930
                # absolute path
686
 
                fap = appendpath(dp, f)
 
931
                fap = from_dir_abspath + '/' + f
687
932
                
688
933
                f_ie = inv.get_child(from_dir_id, f)
689
934
                if f_ie:
690
935
                    c = 'V'
691
 
                elif self.is_ignored(fp):
 
936
                elif self.is_ignored(fp[1:]):
692
937
                    c = 'I'
693
938
                else:
694
 
                    c = '?'
 
939
                    # we may not have found this file, because of a unicode issue
 
940
                    f_norm, can_access = osutils.normalized_filename(f)
 
941
                    if f == f_norm or not can_access:
 
942
                        # No change, so treat this file normally
 
943
                        c = '?'
 
944
                    else:
 
945
                        # this file can be accessed by a normalized path
 
946
                        # check again if it is versioned
 
947
                        # these lines are repeated here for performance
 
948
                        f = f_norm
 
949
                        fp = from_dir_relpath + '/' + f
 
950
                        fap = from_dir_abspath + '/' + f
 
951
                        f_ie = inv.get_child(from_dir_id, f)
 
952
                        if f_ie:
 
953
                            c = 'V'
 
954
                        elif self.is_ignored(fp[1:]):
 
955
                            c = 'I'
 
956
                        else:
 
957
                            c = '?'
695
958
 
696
959
                fk = file_kind(fap)
697
960
 
703
966
 
704
967
                # make a last minute entry
705
968
                if f_ie:
706
 
                    entry = f_ie
 
969
                    yield fp[1:], c, fk, f_ie.file_id, f_ie
707
970
                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()
 
971
                    try:
 
972
                        yield fp[1:], c, fk, None, fk_entries[fk]()
 
973
                    except KeyError:
 
974
                        yield fp[1:], c, fk, None, TreeEntry()
 
975
                    continue
716
976
                
717
 
                yield fp, c, fk, (f_ie and f_ie.file_id), entry
718
 
 
719
977
                if fk != 'directory':
720
978
                    continue
721
979
 
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
 
980
                # But do this child first
 
981
                new_children = os.listdir(fap)
 
982
                new_children.sort()
 
983
                new_children = collections.deque(new_children)
 
984
                stack.append((f_ie.file_id, fp, fap, new_children))
 
985
                # Break out of inner loop, so that we start outer loop with child
 
986
                break
 
987
            else:
 
988
                # if we finished all children, pop it off the stack
 
989
                stack.pop()
 
990
 
 
991
    @needs_tree_write_lock
733
992
    def move(self, from_paths, to_name):
734
993
        """Rename files.
735
994
 
754
1013
        if not self.has_filename(to_name):
755
1014
            raise BzrError("destination %r not in working directory" % to_abs)
756
1015
        to_dir_id = inv.path2id(to_name)
757
 
        if to_dir_id == None and to_name != '':
 
1016
        if to_dir_id is None and to_name != '':
758
1017
            raise BzrError("destination %r is not a versioned directory" % to_name)
759
1018
        to_dir_ie = inv[to_dir_id]
760
 
        if to_dir_ie.kind not in ('directory', 'root_directory'):
 
1019
        if to_dir_ie.kind != 'directory':
761
1020
            raise BzrError("destination %r is not a directory" % to_abs)
762
1021
 
763
1022
        to_idpath = inv.get_idpath(to_dir_id)
766
1025
            if not self.has_filename(f):
767
1026
                raise BzrError("%r does not exist in working tree" % f)
768
1027
            f_id = inv.path2id(f)
769
 
            if f_id == None:
 
1028
            if f_id is None:
770
1029
                raise BzrError("%r is not versioned" % f)
771
1030
            name_tail = splitpath(f)[-1]
772
 
            dest_path = appendpath(to_name, name_tail)
 
1031
            dest_path = pathjoin(to_name, name_tail)
773
1032
            if self.has_filename(dest_path):
774
1033
                raise BzrError("destination %r already exists" % dest_path)
775
1034
            if f_id in to_idpath:
782
1041
        try:
783
1042
            for f in from_paths:
784
1043
                name_tail = splitpath(f)[-1]
785
 
                dest_path = appendpath(to_name, name_tail)
 
1044
                dest_path = pathjoin(to_name, name_tail)
786
1045
                result.append((f, dest_path))
787
1046
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
788
1047
                try:
798
1057
        self._write_inventory(inv)
799
1058
        return result
800
1059
 
801
 
    @needs_write_lock
 
1060
    @needs_tree_write_lock
802
1061
    def rename_one(self, from_rel, to_rel):
803
1062
        """Rename one file.
804
1063
 
811
1070
            raise BzrError("can't rename: new working file %r already exists" % to_rel)
812
1071
 
813
1072
        file_id = inv.path2id(from_rel)
814
 
        if file_id == None:
 
1073
        if file_id is None:
815
1074
            raise BzrError("can't rename: old name %r is not versioned" % from_rel)
816
1075
 
817
1076
        entry = inv[file_id]
823
1082
 
824
1083
        to_dir, to_tail = os.path.split(to_rel)
825
1084
        to_dir_id = inv.path2id(to_dir)
826
 
        if to_dir_id == None and to_dir != '':
 
1085
        if to_dir_id is None and to_dir != '':
827
1086
            raise BzrError("can't determine destination directory id for %r" % to_dir)
828
1087
 
829
1088
        mutter("rename_one:")
852
1111
 
853
1112
        These are files in the working directory that are not versioned or
854
1113
        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
1114
        """
869
1115
        for subp in self.extras():
870
1116
            if not self.is_ignored(subp):
871
1117
                yield subp
872
 
 
 
1118
    
 
1119
    @needs_tree_write_lock
 
1120
    def unversion(self, file_ids):
 
1121
        """Remove the file ids in file_ids from the current versioned set.
 
1122
 
 
1123
        When a file_id is unversioned, all of its children are automatically
 
1124
        unversioned.
 
1125
 
 
1126
        :param file_ids: The file ids to stop versioning.
 
1127
        :raises: NoSuchId if any fileid is not currently versioned.
 
1128
        """
 
1129
        for file_id in file_ids:
 
1130
            if self._inventory.has_id(file_id):
 
1131
                self._inventory.remove_recursive_id(file_id)
 
1132
            else:
 
1133
                raise errors.NoSuchId(self, file_id)
 
1134
        if len(file_ids):
 
1135
            # in the future this should just set a dirty bit to wait for the 
 
1136
            # final unlock. However, until all methods of workingtree start
 
1137
            # with the current in -memory inventory rather than triggering 
 
1138
            # a read, it is more complex - we need to teach read_inventory
 
1139
            # to know when to read, and when to not read first... and possibly
 
1140
            # to save first when the in memory one may be corrupted.
 
1141
            # so for now, we just only write it if it is indeed dirty.
 
1142
            # - RBC 20060907
 
1143
            self._write_inventory(self._inventory)
 
1144
    
873
1145
    @deprecated_method(zero_eight)
874
1146
    def iter_conflicts(self):
875
1147
        """List all files in the tree that have text or content conflicts.
878
1150
 
879
1151
    def _iter_conflicts(self):
880
1152
        conflicted = set()
881
 
        for path in (s[0] for s in self.list_files()):
 
1153
        for info in self.list_files():
 
1154
            path = info[0]
882
1155
            stem = get_conflicted_stem(path)
883
1156
            if stem is None:
884
1157
                continue
906
1179
                repository = self.branch.repository
907
1180
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
908
1181
                try:
 
1182
                    new_basis_tree = self.branch.basis_tree()
909
1183
                    merge_inner(self.branch,
910
 
                                self.branch.basis_tree(),
911
 
                                basis_tree, 
912
 
                                this_tree=self, 
 
1184
                                new_basis_tree,
 
1185
                                basis_tree,
 
1186
                                this_tree=self,
913
1187
                                pb=pb)
914
1188
                finally:
915
1189
                    pb.finished()
916
 
                self.set_last_revision(self.branch.last_revision())
 
1190
                # TODO - dedup parents list with things merged by pull ?
 
1191
                # reuse the revisiontree we merged against to set the new
 
1192
                # tree data.
 
1193
                parent_trees = [(self.branch.last_revision(), new_basis_tree)]
 
1194
                # we have to pull the merge trees out again, because 
 
1195
                # merge_inner has set the ids. - this corner is not yet 
 
1196
                # layered well enough to prevent double handling.
 
1197
                merges = self.get_parent_ids()[1:]
 
1198
                parent_trees.extend([
 
1199
                    (parent, repository.revision_tree(parent)) for
 
1200
                     parent in merges])
 
1201
                self.set_parent_trees(parent_trees)
917
1202
            return count
918
1203
        finally:
919
1204
            source.unlock()
930
1215
        """
931
1216
        ## TODO: Work from given directory downwards
932
1217
        for path, dir_entry in self.inventory.directories():
933
 
            mutter("search for unknowns in %r", path)
 
1218
            # mutter("search for unknowns in %r", path)
934
1219
            dirabs = self.abspath(path)
935
1220
            if not isdir(dirabs):
936
1221
                # e.g. directory deleted
938
1223
 
939
1224
            fl = []
940
1225
            for subf in os.listdir(dirabs):
941
 
                if (subf != '.bzr'
942
 
                    and (subf not in dir_entry.children)):
943
 
                    fl.append(subf)
 
1226
                if subf == '.bzr':
 
1227
                    continue
 
1228
                if subf not in dir_entry.children:
 
1229
                    subf_norm, can_access = osutils.normalized_filename(subf)
 
1230
                    if subf_norm != subf and can_access:
 
1231
                        if subf_norm not in dir_entry.children:
 
1232
                            fl.append(subf_norm)
 
1233
                    else:
 
1234
                        fl.append(subf)
944
1235
            
945
1236
            fl.sort()
946
1237
            for subf in fl:
947
 
                subp = appendpath(path, subf)
 
1238
                subp = pathjoin(path, subf)
948
1239
                yield subp
949
1240
 
 
1241
    def _translate_ignore_rule(self, rule):
 
1242
        """Translate a single ignore rule to a regex.
 
1243
 
 
1244
        There are two types of ignore rules.  Those that do not contain a / are
 
1245
        matched against the tail of the filename (that is, they do not care
 
1246
        what directory the file is in.)  Rules which do contain a slash must
 
1247
        match the entire path.  As a special case, './' at the start of the
 
1248
        string counts as a slash in the string but is removed before matching
 
1249
        (e.g. ./foo.c, ./src/foo.c)
 
1250
 
 
1251
        :return: The translated regex.
 
1252
        """
 
1253
        if rule[:2] in ('./', '.\\'):
 
1254
            # rootdir rule
 
1255
            result = fnmatch.translate(rule[2:])
 
1256
        elif '/' in rule or '\\' in rule:
 
1257
            # path prefix 
 
1258
            result = fnmatch.translate(rule)
 
1259
        else:
 
1260
            # default rule style.
 
1261
            result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
 
1262
        assert result[-1] == '$', "fnmatch.translate did not add the expected $"
 
1263
        return "(" + result + ")"
 
1264
 
 
1265
    def _combine_ignore_rules(self, rules):
 
1266
        """Combine a list of ignore rules into a single regex object.
 
1267
 
 
1268
        Each individual rule is combined with | to form a big regex, which then
 
1269
        has $ added to it to form something like ()|()|()$. The group index for
 
1270
        each subregex's outermost group is placed in a dictionary mapping back 
 
1271
        to the rule. This allows quick identification of the matching rule that
 
1272
        triggered a match.
 
1273
        :return: a list of the compiled regex and the matching-group index 
 
1274
        dictionaries. We return a list because python complains if you try to 
 
1275
        combine more than 100 regexes.
 
1276
        """
 
1277
        result = []
 
1278
        groups = {}
 
1279
        next_group = 0
 
1280
        translated_rules = []
 
1281
        for rule in rules:
 
1282
            translated_rule = self._translate_ignore_rule(rule)
 
1283
            compiled_rule = re.compile(translated_rule)
 
1284
            groups[next_group] = rule
 
1285
            next_group += compiled_rule.groups
 
1286
            translated_rules.append(translated_rule)
 
1287
            if next_group == 99:
 
1288
                result.append((re.compile("|".join(translated_rules)), groups))
 
1289
                groups = {}
 
1290
                next_group = 0
 
1291
                translated_rules = []
 
1292
        if len(translated_rules):
 
1293
            result.append((re.compile("|".join(translated_rules)), groups))
 
1294
        return result
950
1295
 
951
1296
    def ignored_files(self):
952
1297
        """Yield list of PATH, IGNORE_PATTERN"""
953
1298
        for subp in self.extras():
954
1299
            pat = self.is_ignored(subp)
955
 
            if pat != None:
 
1300
            if pat is not None:
956
1301
                yield subp, pat
957
1302
 
958
 
 
959
1303
    def get_ignore_list(self):
960
1304
        """Return list of ignore patterns.
961
1305
 
962
1306
        Cached in the Tree object after the first call.
963
1307
        """
964
 
        if hasattr(self, '_ignorelist'):
965
 
            return self._ignorelist
966
 
 
967
 
        l = bzrlib.DEFAULT_IGNORE[:]
 
1308
        ignoreset = getattr(self, '_ignoreset', None)
 
1309
        if ignoreset is not None:
 
1310
            return ignoreset
 
1311
 
 
1312
        ignore_globs = set(bzrlib.DEFAULT_IGNORE)
 
1313
        ignore_globs.update(ignores.get_runtime_ignores())
 
1314
 
 
1315
        ignore_globs.update(ignores.get_user_ignores())
 
1316
 
968
1317
        if self.has_filename(bzrlib.IGNORE_FILENAME):
969
1318
            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
 
 
 
1319
            try:
 
1320
                ignore_globs.update(ignores.parse_ignore_file(f))
 
1321
            finally:
 
1322
                f.close()
 
1323
 
 
1324
        self._ignoreset = ignore_globs
 
1325
        self._ignore_regex = self._combine_ignore_rules(ignore_globs)
 
1326
        return ignore_globs
 
1327
 
 
1328
    def _get_ignore_rules_as_regex(self):
 
1329
        """Return a regex of the ignore rules and a mapping dict.
 
1330
 
 
1331
        :return: (ignore rules compiled regex, dictionary mapping rule group 
 
1332
        indices to original rule.)
 
1333
        """
 
1334
        if getattr(self, '_ignoreset', None) is None:
 
1335
            self.get_ignore_list()
 
1336
        return self._ignore_regex
974
1337
 
975
1338
    def is_ignored(self, filename):
976
1339
        r"""Check whether the filename matches an ignore pattern.
990
1353
        # treat dotfiles correctly and allows * to match /.
991
1354
        # Eventually it should be replaced with something more
992
1355
        # 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
 
1356
    
 
1357
        rules = self._get_ignore_rules_as_regex()
 
1358
        for regex, mapping in rules:
 
1359
            match = regex.match(filename)
 
1360
            if match is not None:
 
1361
                # one or more of the groups in mapping will have a non-None
 
1362
                # group match.
 
1363
                groups = match.groups()
 
1364
                rules = [mapping[group] for group in 
 
1365
                    mapping if groups[group] is not None]
 
1366
                return rules[0]
 
1367
        return None
1012
1368
 
1013
1369
    def kind(self, file_id):
1014
1370
        return file_kind(self.id2abspath(file_id))
1015
1371
 
1016
 
    @needs_read_lock
1017
1372
    def last_revision(self):
1018
1373
        """Return the last revision id of this working tree.
1019
1374
 
1020
 
        In early branch formats this was == the branch last_revision,
 
1375
        In early branch formats this was the same as the branch last_revision,
1021
1376
        but that cannot be relied upon - for working tree operations,
1022
 
        always use tree.last_revision().
 
1377
        always use tree.last_revision(). This returns the left most parent id,
 
1378
        or None if there are no parents.
 
1379
 
 
1380
        This was deprecated as of 0.11. Please use get_parent_ids instead.
1023
1381
        """
 
1382
        return self._last_revision()
 
1383
 
 
1384
    @needs_read_lock
 
1385
    def _last_revision(self):
 
1386
        """helper for get_parent_ids."""
1024
1387
        return self.branch.last_revision()
1025
1388
 
 
1389
    def is_locked(self):
 
1390
        return self._control_files.is_locked()
 
1391
 
1026
1392
    def lock_read(self):
1027
1393
        """See Branch.lock_read, and WorkingTree.unlock."""
1028
1394
        self.branch.lock_read()
1032
1398
            self.branch.unlock()
1033
1399
            raise
1034
1400
 
 
1401
    def lock_tree_write(self):
 
1402
        """Lock the working tree for write, and the branch for read.
 
1403
 
 
1404
        This is useful for operations which only need to mutate the working
 
1405
        tree. Taking out branch write locks is a relatively expensive process
 
1406
        and may fail if the branch is on read only media. So branch write locks
 
1407
        should only be taken out when we are modifying branch data - such as in
 
1408
        operations like commit, pull, uncommit and update.
 
1409
        """
 
1410
        self.branch.lock_read()
 
1411
        try:
 
1412
            return self._control_files.lock_write()
 
1413
        except:
 
1414
            self.branch.unlock()
 
1415
            raise
 
1416
 
1035
1417
    def lock_write(self):
1036
1418
        """See Branch.lock_write, and WorkingTree.unlock."""
1037
1419
        self.branch.lock_write()
1041
1423
            self.branch.unlock()
1042
1424
            raise
1043
1425
 
 
1426
    def get_physical_lock_status(self):
 
1427
        return self._control_files.get_physical_lock_status()
 
1428
 
1044
1429
    def _basis_inventory_name(self):
1045
 
        return 'basis-inventory'
 
1430
        return 'basis-inventory-cache'
1046
1431
 
1047
 
    @needs_write_lock
 
1432
    @needs_tree_write_lock
1048
1433
    def set_last_revision(self, new_revision):
1049
1434
        """Change the last revision in the working tree."""
1050
1435
        if self._change_last_revision(new_revision):
1059
1444
        if new_revision is None:
1060
1445
            self.branch.set_revision_history([])
1061
1446
            return False
1062
 
        # current format is locked in with the branch
1063
 
        revision_history = self.branch.revision_history()
1064
1447
        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])
 
1448
            self.branch.generate_revision_history(new_revision)
 
1449
        except errors.NoSuchRevision:
 
1450
            # not present in the repo - dont try to set it deeper than the tip
 
1451
            self.branch.set_revision_history([new_revision])
1069
1452
        return True
1070
1453
 
1071
1454
    def _cache_basis_inventory(self, new_revision):
1072
1455
        """Cache new_revision as the basis inventory."""
 
1456
        # TODO: this should allow the ready-to-use inventory to be passed in,
 
1457
        # as commit already has that ready-to-use [while the format is the
 
1458
        # same, that is].
1073
1459
        try:
1074
1460
            # this double handles the inventory - unpack and repack - 
1075
1461
            # but is easier to understand. We can/should put a conditional
1076
1462
            # in here based on whether the inventory is in the latest format
1077
1463
            # - perhaps we should repack all inventories on a repository
1078
1464
            # 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
 
 
 
1465
            # the fast path is to copy the raw xml from the repository. If the
 
1466
            # xml contains 'revision_id="', then we assume the right 
 
1467
            # revision_id is set. We must check for this full string, because a
 
1468
            # root node id can legitimately look like 'revision_id' but cannot
 
1469
            # contain a '"'.
 
1470
            xml = self.branch.repository.get_inventory_xml(new_revision)
 
1471
            firstline = xml.split('\n', 1)[0]
 
1472
            if (not 'revision_id="' in firstline or 
 
1473
                'format="6"' not in firstline):
 
1474
                inv = self.branch.repository.deserialise_inventory(
 
1475
                    new_revision, xml)
 
1476
                inv.revision_id = new_revision
 
1477
                xml = bzrlib.xml6.serializer_v6.write_inventory_to_string(inv)
 
1478
            assert isinstance(xml, str), 'serialised xml must be bytestring.'
1083
1479
            path = self._basis_inventory_name()
1084
 
            self._control_files.put_utf8(path, xml)
1085
 
        except WeaveRevisionNotPresent:
 
1480
            sio = StringIO(xml)
 
1481
            self._control_files.put(path, sio)
 
1482
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1086
1483
            pass
1087
1484
 
1088
1485
    def read_basis_inventory(self):
1089
1486
        """Read the cached basis inventory."""
1090
1487
        path = self._basis_inventory_name()
1091
 
        return self._control_files.get_utf8(path).read()
 
1488
        return self._control_files.get(path).read()
1092
1489
        
1093
1490
    @needs_read_lock
1094
1491
    def read_working_inventory(self):
1100
1497
        self._set_inventory(result)
1101
1498
        return result
1102
1499
 
1103
 
    @needs_write_lock
1104
 
    def remove(self, files, verbose=False):
 
1500
    @needs_tree_write_lock
 
1501
    def remove(self, files, verbose=False, to_file=None):
1105
1502
        """Remove nominated files from the working inventory..
1106
1503
 
1107
1504
        This does not remove their text.  This does not run on XXX on what? RBC
1129
1526
                # TODO: Perhaps make this just a warning, and continue?
1130
1527
                # This tends to happen when 
1131
1528
                raise NotVersionedError(path=f)
1132
 
            mutter("remove inventory entry %s {%s}", quotefn(f), fid)
1133
1529
            if verbose:
1134
1530
                # having remove it, it must be either ignored or unknown
1135
1531
                if self.is_ignored(f):
1136
1532
                    new_status = 'I'
1137
1533
                else:
1138
1534
                    new_status = '?'
1139
 
                show_status(new_status, inv[fid].kind, quotefn(f))
 
1535
                show_status(new_status, inv[fid].kind, f, to_file=to_file)
1140
1536
            del inv[fid]
1141
1537
 
1142
1538
        self._write_inventory(inv)
1143
1539
 
1144
 
    @needs_write_lock
 
1540
    @needs_tree_write_lock
1145
1541
    def revert(self, filenames, old_tree=None, backups=True, 
1146
1542
               pb=DummyProgress()):
1147
1543
        from transform import revert
1150
1546
            old_tree = self.basis_tree()
1151
1547
        conflicts = revert(self, old_tree, filenames, backups, pb)
1152
1548
        if not len(filenames):
1153
 
            self.set_pending_merges([])
 
1549
            self.set_parent_ids(self.get_parent_ids()[:1])
1154
1550
            resolve(self)
1155
1551
        else:
1156
1552
            resolve(self, filenames, ignore_misses=True)
1158
1554
 
1159
1555
    # XXX: This method should be deprecated in favour of taking in a proper
1160
1556
    # new Inventory object.
1161
 
    @needs_write_lock
 
1557
    @needs_tree_write_lock
1162
1558
    def set_inventory(self, new_inventory_list):
1163
1559
        from bzrlib.inventory import (Inventory,
1164
1560
                                      InventoryDirectory,
1181
1577
                raise BzrError("unknown kind %r" % kind)
1182
1578
        self._write_inventory(inv)
1183
1579
 
1184
 
    @needs_write_lock
 
1580
    @needs_tree_write_lock
1185
1581
    def set_root_id(self, file_id):
1186
1582
        """Set the root id for this tree."""
1187
1583
        inv = self.read_working_inventory()
1204
1600
        between multiple working trees, i.e. via shared storage, then we 
1205
1601
        would probably want to lock both the local tree, and the branch.
1206
1602
        """
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
 
1603
        raise NotImplementedError(self.unlock)
1229
1604
 
1230
1605
    @needs_write_lock
1231
1606
    def update(self):
1248
1623
        Do a 'normal' merge of the old branch basis if it is relevant.
1249
1624
        """
1250
1625
        old_tip = self.branch.update()
1251
 
        if old_tip is not None:
1252
 
            self.add_pending_merge(old_tip)
1253
 
        self.branch.lock_read()
 
1626
        # here if old_tip is not None, it is the old tip of the branch before
 
1627
        # it was updated from the master branch. This should become a pending
 
1628
        # merge in the working tree to preserve the user existing work.  we
 
1629
        # cant set that until we update the working trees last revision to be
 
1630
        # one from the new branch, because it will just get absorbed by the
 
1631
        # parent de-duplication logic.
 
1632
        # 
 
1633
        # We MUST save it even if an error occurs, because otherwise the users
 
1634
        # local work is unreferenced and will appear to have been lost.
 
1635
        # 
 
1636
        result = 0
1254
1637
        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()
 
1638
            last_rev = self.get_parent_ids()[0]
 
1639
        except IndexError:
 
1640
            last_rev = None
 
1641
        if last_rev != self.branch.last_revision():
 
1642
            # merge tree state up to new branch tip.
 
1643
            basis = self.basis_tree()
 
1644
            to_tree = self.branch.basis_tree()
 
1645
            result += merge_inner(self.branch,
 
1646
                                  to_tree,
 
1647
                                  basis,
 
1648
                                  this_tree=self)
 
1649
            # TODO - dedup parents list with things merged by pull ?
 
1650
            # reuse the tree we've updated to to set the basis:
 
1651
            parent_trees = [(self.branch.last_revision(), to_tree)]
 
1652
            merges = self.get_parent_ids()[1:]
 
1653
            # Ideally we ask the tree for the trees here, that way the working
 
1654
            # tree can decide whether to give us teh entire tree or give us a
 
1655
            # lazy initialised tree. dirstate for instance will have the trees
 
1656
            # in ram already, whereas a last-revision + basis-inventory tree
 
1657
            # will not, but also does not need them when setting parents.
 
1658
            for parent in merges:
 
1659
                parent_trees.append(
 
1660
                    (parent, self.branch.repository.revision_tree(parent)))
 
1661
            if old_tip is not None:
 
1662
                parent_trees.append(
 
1663
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
 
1664
            self.set_parent_trees(parent_trees)
 
1665
            last_rev = parent_trees[0][0]
 
1666
        else:
 
1667
            # the working tree had the same last-revision as the master
 
1668
            # branch did. We may still have pivot local work from the local
 
1669
            # branch into old_tip:
 
1670
            if old_tip is not None:
 
1671
                self.add_parent_tree_id(old_tip)
 
1672
        if old_tip and old_tip != last_rev:
 
1673
            # our last revision was not the prior branch last revision
 
1674
            # and we have converted that last revision to a pending merge.
 
1675
            # base is somewhere between the branch tip now
 
1676
            # and the now pending merge
 
1677
            from bzrlib.revision import common_ancestor
 
1678
            try:
 
1679
                base_rev_id = common_ancestor(self.branch.last_revision(),
 
1680
                                              old_tip,
 
1681
                                              self.branch.repository)
 
1682
            except errors.NoCommonAncestor:
 
1683
                base_rev_id = None
 
1684
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
1685
            other_tree = self.branch.repository.revision_tree(old_tip)
 
1686
            result += merge_inner(self.branch,
 
1687
                                  other_tree,
 
1688
                                  base_tree,
 
1689
                                  this_tree=self)
 
1690
        return result
1286
1691
 
1287
 
    @needs_write_lock
 
1692
    @needs_tree_write_lock
1288
1693
    def _write_inventory(self, inv):
1289
1694
        """Write inventory as the current inventory."""
1290
1695
        sio = StringIO()
1297
1702
    def set_conflicts(self, arg):
1298
1703
        raise UnsupportedOperation(self.set_conflicts, self)
1299
1704
 
 
1705
    def add_conflicts(self, arg):
 
1706
        raise UnsupportedOperation(self.add_conflicts, self)
 
1707
 
1300
1708
    @needs_read_lock
1301
1709
    def conflicts(self):
1302
1710
        conflicts = ConflictList()
1305
1713
            try:
1306
1714
                if file_kind(self.abspath(conflicted)) != "file":
1307
1715
                    text = False
1308
 
            except OSError, e:
1309
 
                if e.errno == errno.ENOENT:
1310
 
                    text = False
1311
 
                else:
1312
 
                    raise
 
1716
            except errors.NoSuchFile:
 
1717
                text = False
1313
1718
            if text is True:
1314
1719
                for suffix in ('.THIS', '.OTHER'):
1315
1720
                    try:
1316
1721
                        kind = file_kind(self.abspath(conflicted+suffix))
1317
 
                    except OSError, e:
1318
 
                        if e.errno == errno.ENOENT:
 
1722
                        if kind != "file":
1319
1723
                            text = False
1320
 
                            break
1321
 
                        else:
1322
 
                            raise
1323
 
                    if kind != "file":
 
1724
                    except errors.NoSuchFile:
1324
1725
                        text = False
 
1726
                    if text == False:
1325
1727
                        break
1326
1728
            ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1327
1729
            conflicts.append(Conflict.factory(ctype, path=conflicted,
1329
1731
        return conflicts
1330
1732
 
1331
1733
 
 
1734
class WorkingTree2(WorkingTree):
 
1735
    """This is the Format 2 working tree.
 
1736
 
 
1737
    This was the first weave based working tree. 
 
1738
     - uses os locks for locking.
 
1739
     - uses the branch last-revision.
 
1740
    """
 
1741
 
 
1742
    def lock_tree_write(self):
 
1743
        """See WorkingTree.lock_tree_write().
 
1744
 
 
1745
        In Format2 WorkingTrees we have a single lock for the branch and tree
 
1746
        so lock_tree_write() degrades to lock_write().
 
1747
        """
 
1748
        self.branch.lock_write()
 
1749
        try:
 
1750
            return self._control_files.lock_write()
 
1751
        except:
 
1752
            self.branch.unlock()
 
1753
            raise
 
1754
 
 
1755
    def unlock(self):
 
1756
        # we share control files:
 
1757
        if self._hashcache.needs_write and self._control_files._lock_count==3:
 
1758
            self._hashcache.write()
 
1759
        # reverse order of locking.
 
1760
        try:
 
1761
            return self._control_files.unlock()
 
1762
        finally:
 
1763
            self.branch.unlock()
 
1764
 
 
1765
 
1332
1766
class WorkingTree3(WorkingTree):
1333
1767
    """This is the Format 3 working tree.
1334
1768
 
1340
1774
    """
1341
1775
 
1342
1776
    @needs_read_lock
1343
 
    def last_revision(self):
1344
 
        """See WorkingTree.last_revision."""
 
1777
    def _last_revision(self):
 
1778
        """See WorkingTree._last_revision."""
1345
1779
        try:
1346
1780
            return self._control_files.get_utf8('last-revision').read()
1347
1781
        except NoSuchFile:
1356
1790
                pass
1357
1791
            return False
1358
1792
        else:
1359
 
            try:
1360
 
                self.branch.revision_history().index(revision_id)
1361
 
            except ValueError:
1362
 
                raise errors.NoSuchRevision(self.branch, revision_id)
1363
1793
            self._control_files.put_utf8('last-revision', revision_id)
1364
1794
            return True
1365
1795
 
1366
 
    @needs_write_lock
 
1796
    @needs_tree_write_lock
1367
1797
    def set_conflicts(self, conflicts):
1368
1798
        self._put_rio('conflicts', conflicts.to_stanzas(), 
1369
1799
                      CONFLICT_HEADER_1)
1370
1800
 
 
1801
    @needs_tree_write_lock
 
1802
    def add_conflicts(self, new_conflicts):
 
1803
        conflict_set = set(self.conflicts())
 
1804
        conflict_set.update(set(list(new_conflicts)))
 
1805
        self.set_conflicts(ConflictList(sorted(conflict_set,
 
1806
                                               key=Conflict.sort_key)))
 
1807
 
1371
1808
    @needs_read_lock
1372
1809
    def conflicts(self):
1373
1810
        try:
1381
1818
            raise ConflictFormatError()
1382
1819
        return ConflictList.from_stanzas(RioReader(confile))
1383
1820
 
 
1821
    def unlock(self):
 
1822
        if self._hashcache.needs_write and self._control_files._lock_count==1:
 
1823
            self._hashcache.write()
 
1824
        # reverse order of locking.
 
1825
        try:
 
1826
            return self._control_files.unlock()
 
1827
        finally:
 
1828
            self.branch.unlock()
 
1829
 
1384
1830
 
1385
1831
def get_conflicted_stem(path):
1386
1832
    for suffix in CONFLICT_SUFFIXES:
1437
1883
        except NoSuchFile:
1438
1884
            raise errors.NoWorkingTree(base=transport.base)
1439
1885
        except KeyError:
1440
 
            raise errors.UnknownFormatError(format_string)
 
1886
            raise errors.UnknownFormatError(format=format_string)
1441
1887
 
1442
1888
    @classmethod
1443
1889
    def get_default_format(klass):
1486
1932
        """See WorkingTreeFormat.get_format_description()."""
1487
1933
        return "Working tree format 2"
1488
1934
 
 
1935
    def stub_initialize_remote(self, control_files):
 
1936
        """As a special workaround create critical control files for a remote working tree
 
1937
        
 
1938
        This ensures that it can later be updated and dealt with locally,
 
1939
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with 
 
1940
        no working tree.  (See bug #43064).
 
1941
        """
 
1942
        sio = StringIO()
 
1943
        inv = Inventory()
 
1944
        bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
 
1945
        sio.seek(0)
 
1946
        control_files.put('inventory', sio)
 
1947
 
 
1948
        control_files.put_utf8('pending-merges', '')
 
1949
        
 
1950
 
1489
1951
    def initialize(self, a_bzrdir, revision_id=None):
1490
1952
        """See WorkingTreeFormat.initialize()."""
1491
1953
        if not isinstance(a_bzrdir.transport, LocalTransport):
1503
1965
            finally:
1504
1966
                branch.unlock()
1505
1967
        revision = branch.last_revision()
1506
 
        inv = Inventory() 
1507
 
        wt = WorkingTree(a_bzrdir.root_transport.base,
 
1968
        inv = Inventory()
 
1969
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1508
1970
                         branch,
1509
1971
                         inv,
1510
1972
                         _internal=True,
1512
1974
                         _bzrdir=a_bzrdir)
1513
1975
        wt._write_inventory(inv)
1514
1976
        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)
 
1977
        basis_tree = branch.repository.revision_tree(revision)
 
1978
        wt.set_parent_trees([(revision, basis_tree)])
 
1979
        build_tree(basis_tree, wt)
1518
1980
        return wt
1519
1981
 
1520
1982
    def __init__(self):
1532
1994
            raise NotImplementedError
1533
1995
        if not isinstance(a_bzrdir.transport, LocalTransport):
1534
1996
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
1535
 
        return WorkingTree(a_bzrdir.root_transport.base,
 
1997
        return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1536
1998
                           _internal=True,
1537
1999
                           _format=self,
1538
2000
                           _bzrdir=a_bzrdir)
1547
2009
          files, separate from the BzrDir format
1548
2010
        - modifies the hash cache format
1549
2011
        - is new in bzr 0.8
1550
 
        - uses a LockDir to guard access to the repository
 
2012
        - uses a LockDir to guard access for writes.
1551
2013
    """
1552
2014
 
1553
2015
    def get_format_string(self):
1569
2031
    def initialize(self, a_bzrdir, revision_id=None):
1570
2032
        """See WorkingTreeFormat.initialize().
1571
2033
        
1572
 
        revision_id allows creating a working tree at a differnet
 
2034
        revision_id allows creating a working tree at a different
1573
2035
        revision than the branch is at.
1574
2036
        """
1575
2037
        if not isinstance(a_bzrdir.transport, LocalTransport):
1577
2039
        transport = a_bzrdir.get_workingtree_transport(self)
1578
2040
        control_files = self._open_control_files(a_bzrdir)
1579
2041
        control_files.create_lock()
 
2042
        control_files.lock_write()
1580
2043
        control_files.put_utf8('format', self.get_format_string())
1581
2044
        branch = a_bzrdir.open_branch()
1582
2045
        if revision_id is None:
1583
2046
            revision_id = branch.last_revision()
1584
2047
        inv = Inventory() 
1585
 
        wt = WorkingTree3(a_bzrdir.root_transport.base,
 
2048
        wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1586
2049
                         branch,
1587
2050
                         inv,
1588
2051
                         _internal=True,
1589
2052
                         _format=self,
1590
2053
                         _bzrdir=a_bzrdir,
1591
2054
                         _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)
 
2055
        wt.lock_tree_write()
 
2056
        try:
 
2057
            wt._write_inventory(inv)
 
2058
            wt.set_root_id(inv.root.file_id)
 
2059
            basis_tree = branch.repository.revision_tree(revision_id)
 
2060
            if revision_id == bzrlib.revision.NULL_REVISION:
 
2061
                wt.set_parent_trees([])
 
2062
            else:
 
2063
                wt.set_parent_trees([(revision_id, basis_tree)])
 
2064
            build_tree(basis_tree, wt)
 
2065
        finally:
 
2066
            wt.unlock()
 
2067
            control_files.unlock()
1597
2068
        return wt
1598
2069
 
1599
2070
    def __init__(self):
1611
2082
            raise NotImplementedError
1612
2083
        if not isinstance(a_bzrdir.transport, LocalTransport):
1613
2084
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
1614
 
        control_files = self._open_control_files(a_bzrdir)
1615
 
        return WorkingTree3(a_bzrdir.root_transport.base,
 
2085
        return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
 
2086
 
 
2087
    def _open(self, a_bzrdir, control_files):
 
2088
        """Open the tree itself.
 
2089
        
 
2090
        :param a_bzrdir: the dir for the tree.
 
2091
        :param control_files: the control files for the tree.
 
2092
        """
 
2093
        return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1616
2094
                           _internal=True,
1617
2095
                           _format=self,
1618
2096
                           _bzrdir=a_bzrdir,
1645
2123
        self._transport_readonly_server = transport_readonly_server
1646
2124
        self._formats = formats
1647
2125
    
 
2126
    def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
 
2127
        """Clone test for adaption."""
 
2128
        new_test = deepcopy(test)
 
2129
        new_test.transport_server = self._transport_server
 
2130
        new_test.transport_readonly_server = self._transport_readonly_server
 
2131
        new_test.bzrdir_format = bzrdir_format
 
2132
        new_test.workingtree_format = workingtree_format
 
2133
        def make_new_test_id():
 
2134
            new_id = "%s(%s)" % (test.id(), variation)
 
2135
            return lambda: new_id
 
2136
        new_test.id = make_new_test_id()
 
2137
        return new_test
 
2138
    
1648
2139
    def adapt(self, test):
1649
2140
        from bzrlib.tests import TestSuite
1650
2141
        result = TestSuite()
1651
2142
        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()
 
2143
            new_test = self._clone_test(
 
2144
                test,
 
2145
                bzrdir_format,
 
2146
                workingtree_format, workingtree_format.__class__.__name__)
1661
2147
            result.addTest(new_test)
1662
2148
        return result