/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

Merge bzr.dev

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
    @needs_tree_write_lock
 
679
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
 
680
        """Set the parent ids to revision_ids.
 
681
        
 
682
        See also set_parent_trees. This api will try to retrieve the tree data
 
683
        for each element of revision_ids from the trees repository. If you have
 
684
        tree data already available, it is more efficient to use
 
685
        set_parent_trees rather than set_parent_ids. set_parent_ids is however
 
686
        an easier API to use.
 
687
 
 
688
        :param revision_ids: The revision_ids to set as the parent ids of this
 
689
            working tree. Any of these may be ghosts.
 
690
        """
 
691
        if len(revision_ids) > 0:
 
692
            leftmost_id = revision_ids[0]
 
693
            if (not allow_leftmost_as_ghost and not
 
694
                self.branch.repository.has_revision(leftmost_id)):
 
695
                raise errors.GhostRevisionUnusableHere(leftmost_id)
 
696
            self.set_last_revision(leftmost_id)
 
697
        else:
 
698
            self.set_last_revision(None)
 
699
        merges = revision_ids[1:]
 
700
        self._control_files.put_utf8('pending-merges', '\n'.join(merges))
 
701
 
 
702
    @needs_tree_write_lock
 
703
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
 
704
        """See MutableTree.set_parent_trees."""
 
705
        # parent trees are not used in current format trees, delegate to
 
706
        # set_parent_ids
 
707
        self.set_parent_ids([rev for (rev, tree) in parents_list],
 
708
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
709
 
 
710
    @needs_tree_write_lock
611
711
    def set_pending_merges(self, rev_list):
612
 
        self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
 
712
        parents = self.get_parent_ids()
 
713
        leftmost = parents[:1]
 
714
        new_parents = leftmost + rev_list
 
715
        self.set_parent_ids(new_parents)
613
716
 
614
 
    @needs_write_lock
 
717
    @needs_tree_write_lock
615
718
    def set_merge_modified(self, modified_hashes):
616
719
        def iter_stanzas():
617
720
            for file_id, hash in modified_hashes.iteritems():
618
721
                yield Stanza(file_id=file_id, hash=hash)
619
722
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
620
723
 
621
 
    @needs_write_lock
 
724
    @needs_tree_write_lock
622
725
    def _put_rio(self, filename, stanzas, header):
623
726
        my_file = rio_file(stanzas, header)
624
727
        self._control_files.put(filename, my_file)
625
728
 
 
729
    @needs_write_lock # because merge pulls data into the branch.
 
730
    def merge_from_branch(self, branch, to_revision=None):
 
731
        """Merge from a branch into this working tree.
 
732
 
 
733
        :param branch: The branch to merge from.
 
734
        :param to_revision: If non-None, the merge will merge to to_revision, but 
 
735
            not beyond it. to_revision does not need to be in the history of
 
736
            the branch when it is supplied. If None, to_revision defaults to
 
737
            branch.last_revision().
 
738
        """
 
739
        from bzrlib.merge import Merger, Merge3Merger
 
740
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
741
        try:
 
742
            merger = Merger(self.branch, this_tree=self, pb=pb)
 
743
            merger.pp = ProgressPhase("Merge phase", 5, pb)
 
744
            merger.pp.next_phase()
 
745
            # check that there are no
 
746
            # local alterations
 
747
            merger.check_basis(check_clean=True, require_commits=False)
 
748
            if to_revision is None:
 
749
                to_revision = branch.last_revision()
 
750
            merger.other_rev_id = to_revision
 
751
            if merger.other_rev_id is None:
 
752
                raise error.NoCommits(branch)
 
753
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
754
            merger.other_basis = merger.other_rev_id
 
755
            merger.other_tree = self.branch.repository.revision_tree(
 
756
                merger.other_rev_id)
 
757
            merger.pp.next_phase()
 
758
            merger.find_base()
 
759
            if merger.base_rev_id == merger.other_rev_id:
 
760
                raise errors.PointlessMerge
 
761
            merger.backup_files = False
 
762
            merger.merge_type = Merge3Merger
 
763
            merger.set_interesting_files(None)
 
764
            merger.show_base = False
 
765
            merger.reprocess = False
 
766
            conflicts = merger.do_merge()
 
767
            merger.set_pending()
 
768
        finally:
 
769
            pb.finished()
 
770
        return conflicts
 
771
 
626
772
    @needs_read_lock
627
773
    def merge_modified(self):
628
774
        try:
644
790
                merge_hashes[file_id] = hash
645
791
        return merge_hashes
646
792
 
 
793
    @needs_write_lock
 
794
    def mkdir(self, path, file_id=None):
 
795
        """See MutableTree.mkdir()."""
 
796
        if file_id is None:
 
797
            file_id = gen_file_id(os.path.basename(path))
 
798
        os.mkdir(self.abspath(path))
 
799
        self.add(path, file_id, 'directory')
 
800
        return file_id
 
801
 
647
802
    def get_symlink_target(self, file_id):
648
803
        return os.readlink(self.id2abspath(file_id))
649
804
 
656
811
            return '?'
657
812
 
658
813
    def list_files(self):
659
 
        """Recursively list all files as (path, class, kind, id).
 
814
        """Recursively list all files as (path, class, kind, id, entry).
660
815
 
661
816
        Lists, but does not descend into unversioned directories.
662
817
 
666
821
        Skips the control directory.
667
822
        """
668
823
        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:
 
824
        # Convert these into local objects to save lookup times
 
825
        pathjoin = osutils.pathjoin
 
826
        file_kind = osutils.file_kind
 
827
 
 
828
        # transport.base ends in a slash, we want the piece
 
829
        # between the last two slashes
 
830
        transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
 
831
 
 
832
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
 
833
 
 
834
        # directory file_id, relative path, absolute path, reverse sorted children
 
835
        children = os.listdir(self.basedir)
 
836
        children.sort()
 
837
        # jam 20060527 The kernel sized tree seems equivalent whether we 
 
838
        # use a deque and popleft to keep them sorted, or if we use a plain
 
839
        # list and just reverse() them.
 
840
        children = collections.deque(children)
 
841
        stack = [(inv.root.file_id, u'', self.basedir, children)]
 
842
        while stack:
 
843
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
 
844
 
 
845
            while children:
 
846
                f = children.popleft()
674
847
                ## TODO: If we find a subdirectory with its own .bzr
675
848
                ## directory, then that is a separate tree and we
676
849
                ## should exclude it.
677
850
 
678
851
                # the bzrdir for this tree
679
 
                if self.bzrdir.transport.base.endswith(f + '/'):
 
852
                if transport_base_dir == f:
680
853
                    continue
681
854
 
682
 
                # path within tree
683
 
                fp = appendpath(from_dir_relpath, f)
 
855
                # we know that from_dir_relpath and from_dir_abspath never end in a slash
 
856
                # and 'f' doesn't begin with one, we can do a string op, rather
 
857
                # than the checks of pathjoin(), all relative paths will have an extra slash
 
858
                # at the beginning
 
859
                fp = from_dir_relpath + '/' + f
684
860
 
685
861
                # absolute path
686
 
                fap = appendpath(dp, f)
 
862
                fap = from_dir_abspath + '/' + f
687
863
                
688
864
                f_ie = inv.get_child(from_dir_id, f)
689
865
                if f_ie:
690
866
                    c = 'V'
691
 
                elif self.is_ignored(fp):
 
867
                elif self.is_ignored(fp[1:]):
692
868
                    c = 'I'
693
869
                else:
694
 
                    c = '?'
 
870
                    # we may not have found this file, because of a unicode issue
 
871
                    f_norm, can_access = osutils.normalized_filename(f)
 
872
                    if f == f_norm or not can_access:
 
873
                        # No change, so treat this file normally
 
874
                        c = '?'
 
875
                    else:
 
876
                        # this file can be accessed by a normalized path
 
877
                        # check again if it is versioned
 
878
                        # these lines are repeated here for performance
 
879
                        f = f_norm
 
880
                        fp = from_dir_relpath + '/' + f
 
881
                        fap = from_dir_abspath + '/' + f
 
882
                        f_ie = inv.get_child(from_dir_id, f)
 
883
                        if f_ie:
 
884
                            c = 'V'
 
885
                        elif self.is_ignored(fp[1:]):
 
886
                            c = 'I'
 
887
                        else:
 
888
                            c = '?'
695
889
 
696
890
                fk = file_kind(fap)
697
891
 
703
897
 
704
898
                # make a last minute entry
705
899
                if f_ie:
706
 
                    entry = f_ie
 
900
                    yield fp[1:], c, fk, f_ie.file_id, f_ie
707
901
                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()
 
902
                    try:
 
903
                        yield fp[1:], c, fk, None, fk_entries[fk]()
 
904
                    except KeyError:
 
905
                        yield fp[1:], c, fk, None, TreeEntry()
 
906
                    continue
716
907
                
717
 
                yield fp, c, fk, (f_ie and f_ie.file_id), entry
718
 
 
719
908
                if fk != 'directory':
720
909
                    continue
721
910
 
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
 
911
                # But do this child first
 
912
                new_children = os.listdir(fap)
 
913
                new_children.sort()
 
914
                new_children = collections.deque(new_children)
 
915
                stack.append((f_ie.file_id, fp, fap, new_children))
 
916
                # Break out of inner loop, so that we start outer loop with child
 
917
                break
 
918
            else:
 
919
                # if we finished all children, pop it off the stack
 
920
                stack.pop()
 
921
 
 
922
    @needs_tree_write_lock
733
923
    def move(self, from_paths, to_name):
734
924
        """Rename files.
735
925
 
754
944
        if not self.has_filename(to_name):
755
945
            raise BzrError("destination %r not in working directory" % to_abs)
756
946
        to_dir_id = inv.path2id(to_name)
757
 
        if to_dir_id == None and to_name != '':
 
947
        if to_dir_id is None and to_name != '':
758
948
            raise BzrError("destination %r is not a versioned directory" % to_name)
759
949
        to_dir_ie = inv[to_dir_id]
760
 
        if to_dir_ie.kind not in ('directory', 'root_directory'):
 
950
        if to_dir_ie.kind != 'directory':
761
951
            raise BzrError("destination %r is not a directory" % to_abs)
762
952
 
763
953
        to_idpath = inv.get_idpath(to_dir_id)
766
956
            if not self.has_filename(f):
767
957
                raise BzrError("%r does not exist in working tree" % f)
768
958
            f_id = inv.path2id(f)
769
 
            if f_id == None:
 
959
            if f_id is None:
770
960
                raise BzrError("%r is not versioned" % f)
771
961
            name_tail = splitpath(f)[-1]
772
 
            dest_path = appendpath(to_name, name_tail)
 
962
            dest_path = pathjoin(to_name, name_tail)
773
963
            if self.has_filename(dest_path):
774
964
                raise BzrError("destination %r already exists" % dest_path)
775
965
            if f_id in to_idpath:
782
972
        try:
783
973
            for f in from_paths:
784
974
                name_tail = splitpath(f)[-1]
785
 
                dest_path = appendpath(to_name, name_tail)
 
975
                dest_path = pathjoin(to_name, name_tail)
786
976
                result.append((f, dest_path))
787
977
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
788
978
                try:
798
988
        self._write_inventory(inv)
799
989
        return result
800
990
 
801
 
    @needs_write_lock
 
991
    @needs_tree_write_lock
802
992
    def rename_one(self, from_rel, to_rel):
803
993
        """Rename one file.
804
994
 
811
1001
            raise BzrError("can't rename: new working file %r already exists" % to_rel)
812
1002
 
813
1003
        file_id = inv.path2id(from_rel)
814
 
        if file_id == None:
 
1004
        if file_id is None:
815
1005
            raise BzrError("can't rename: old name %r is not versioned" % from_rel)
816
1006
 
817
1007
        entry = inv[file_id]
823
1013
 
824
1014
        to_dir, to_tail = os.path.split(to_rel)
825
1015
        to_dir_id = inv.path2id(to_dir)
826
 
        if to_dir_id == None and to_dir != '':
 
1016
        if to_dir_id is None and to_dir != '':
827
1017
            raise BzrError("can't determine destination directory id for %r" % to_dir)
828
1018
 
829
1019
        mutter("rename_one:")
852
1042
 
853
1043
        These are files in the working directory that are not versioned or
854
1044
        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
1045
        """
869
1046
        for subp in self.extras():
870
1047
            if not self.is_ignored(subp):
871
1048
                yield subp
872
 
 
 
1049
    
 
1050
    @needs_tree_write_lock
 
1051
    def unversion(self, file_ids):
 
1052
        """Remove the file ids in file_ids from the current versioned set.
 
1053
 
 
1054
        When a file_id is unversioned, all of its children are automatically
 
1055
        unversioned.
 
1056
 
 
1057
        :param file_ids: The file ids to stop versioning.
 
1058
        :raises: NoSuchId if any fileid is not currently versioned.
 
1059
        """
 
1060
        for file_id in file_ids:
 
1061
            if self._inventory.has_id(file_id):
 
1062
                self._inventory.remove_recursive_id(file_id)
 
1063
            else:
 
1064
                raise errors.NoSuchId(self, file_id)
 
1065
        if len(file_ids):
 
1066
            # in the future this should just set a dirty bit to wait for the 
 
1067
            # final unlock. However, until all methods of workingtree start
 
1068
            # with the current in -memory inventory rather than triggering 
 
1069
            # a read, it is more complex - we need to teach read_inventory
 
1070
            # to know when to read, and when to not read first... and possibly
 
1071
            # to save first when the in memory one may be corrupted.
 
1072
            # so for now, we just only write it if it is indeed dirty.
 
1073
            # - RBC 20060907
 
1074
            self._write_inventory(self._inventory)
 
1075
    
873
1076
    @deprecated_method(zero_eight)
874
1077
    def iter_conflicts(self):
875
1078
        """List all files in the tree that have text or content conflicts.
878
1081
 
879
1082
    def _iter_conflicts(self):
880
1083
        conflicted = set()
881
 
        for path in (s[0] for s in self.list_files()):
 
1084
        for info in self.list_files():
 
1085
            path = info[0]
882
1086
            stem = get_conflicted_stem(path)
883
1087
            if stem is None:
884
1088
                continue
906
1110
                repository = self.branch.repository
907
1111
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
908
1112
                try:
 
1113
                    new_basis_tree = self.branch.basis_tree()
909
1114
                    merge_inner(self.branch,
910
 
                                self.branch.basis_tree(),
911
 
                                basis_tree, 
912
 
                                this_tree=self, 
 
1115
                                new_basis_tree,
 
1116
                                basis_tree,
 
1117
                                this_tree=self,
913
1118
                                pb=pb)
914
1119
                finally:
915
1120
                    pb.finished()
916
 
                self.set_last_revision(self.branch.last_revision())
 
1121
                # TODO - dedup parents list with things merged by pull ?
 
1122
                # reuse the revisiontree we merged against to set the new
 
1123
                # tree data.
 
1124
                parent_trees = [(self.branch.last_revision(), new_basis_tree)]
 
1125
                # we have to pull the merge trees out again, because 
 
1126
                # merge_inner has set the ids. - this corner is not yet 
 
1127
                # layered well enough to prevent double handling.
 
1128
                merges = self.get_parent_ids()[1:]
 
1129
                parent_trees.extend([
 
1130
                    (parent, repository.revision_tree(parent)) for
 
1131
                     parent in merges])
 
1132
                self.set_parent_trees(parent_trees)
917
1133
            return count
918
1134
        finally:
919
1135
            source.unlock()
920
1136
            top_pb.finished()
921
1137
 
 
1138
    @needs_write_lock
 
1139
    def put_file_bytes_non_atomic(self, file_id, bytes):
 
1140
        """See MutableTree.put_file_bytes_non_atomic."""
 
1141
        stream = file(self.id2abspath(file_id), 'wb')
 
1142
        try:
 
1143
            stream.write(bytes)
 
1144
        finally:
 
1145
            stream.close()
 
1146
        # TODO: update the hashcache here ?
 
1147
 
922
1148
    def extras(self):
923
1149
        """Yield all unknown files in this WorkingTree.
924
1150
 
930
1156
        """
931
1157
        ## TODO: Work from given directory downwards
932
1158
        for path, dir_entry in self.inventory.directories():
933
 
            mutter("search for unknowns in %r", path)
 
1159
            # mutter("search for unknowns in %r", path)
934
1160
            dirabs = self.abspath(path)
935
1161
            if not isdir(dirabs):
936
1162
                # e.g. directory deleted
938
1164
 
939
1165
            fl = []
940
1166
            for subf in os.listdir(dirabs):
941
 
                if (subf != '.bzr'
942
 
                    and (subf not in dir_entry.children)):
943
 
                    fl.append(subf)
 
1167
                if subf == '.bzr':
 
1168
                    continue
 
1169
                if subf not in dir_entry.children:
 
1170
                    subf_norm, can_access = osutils.normalized_filename(subf)
 
1171
                    if subf_norm != subf and can_access:
 
1172
                        if subf_norm not in dir_entry.children:
 
1173
                            fl.append(subf_norm)
 
1174
                    else:
 
1175
                        fl.append(subf)
944
1176
            
945
1177
            fl.sort()
946
1178
            for subf in fl:
947
 
                subp = appendpath(path, subf)
 
1179
                subp = pathjoin(path, subf)
948
1180
                yield subp
949
1181
 
 
1182
    def _translate_ignore_rule(self, rule):
 
1183
        """Translate a single ignore rule to a regex.
 
1184
 
 
1185
        There are two types of ignore rules.  Those that do not contain a / are
 
1186
        matched against the tail of the filename (that is, they do not care
 
1187
        what directory the file is in.)  Rules which do contain a slash must
 
1188
        match the entire path.  As a special case, './' at the start of the
 
1189
        string counts as a slash in the string but is removed before matching
 
1190
        (e.g. ./foo.c, ./src/foo.c)
 
1191
 
 
1192
        :return: The translated regex.
 
1193
        """
 
1194
        if rule[:2] in ('./', '.\\'):
 
1195
            # rootdir rule
 
1196
            result = fnmatch.translate(rule[2:])
 
1197
        elif '/' in rule or '\\' in rule:
 
1198
            # path prefix 
 
1199
            result = fnmatch.translate(rule)
 
1200
        else:
 
1201
            # default rule style.
 
1202
            result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
 
1203
        assert result[-1] == '$', "fnmatch.translate did not add the expected $"
 
1204
        return "(" + result + ")"
 
1205
 
 
1206
    def _combine_ignore_rules(self, rules):
 
1207
        """Combine a list of ignore rules into a single regex object.
 
1208
 
 
1209
        Each individual rule is combined with | to form a big regex, which then
 
1210
        has $ added to it to form something like ()|()|()$. The group index for
 
1211
        each subregex's outermost group is placed in a dictionary mapping back 
 
1212
        to the rule. This allows quick identification of the matching rule that
 
1213
        triggered a match.
 
1214
        :return: a list of the compiled regex and the matching-group index 
 
1215
        dictionaries. We return a list because python complains if you try to 
 
1216
        combine more than 100 regexes.
 
1217
        """
 
1218
        result = []
 
1219
        groups = {}
 
1220
        next_group = 0
 
1221
        translated_rules = []
 
1222
        for rule in rules:
 
1223
            translated_rule = self._translate_ignore_rule(rule)
 
1224
            compiled_rule = re.compile(translated_rule)
 
1225
            groups[next_group] = rule
 
1226
            next_group += compiled_rule.groups
 
1227
            translated_rules.append(translated_rule)
 
1228
            if next_group == 99:
 
1229
                result.append((re.compile("|".join(translated_rules)), groups))
 
1230
                groups = {}
 
1231
                next_group = 0
 
1232
                translated_rules = []
 
1233
        if len(translated_rules):
 
1234
            result.append((re.compile("|".join(translated_rules)), groups))
 
1235
        return result
950
1236
 
951
1237
    def ignored_files(self):
952
1238
        """Yield list of PATH, IGNORE_PATTERN"""
953
1239
        for subp in self.extras():
954
1240
            pat = self.is_ignored(subp)
955
 
            if pat != None:
 
1241
            if pat is not None:
956
1242
                yield subp, pat
957
1243
 
958
 
 
959
1244
    def get_ignore_list(self):
960
1245
        """Return list of ignore patterns.
961
1246
 
962
1247
        Cached in the Tree object after the first call.
963
1248
        """
964
 
        if hasattr(self, '_ignorelist'):
965
 
            return self._ignorelist
966
 
 
967
 
        l = bzrlib.DEFAULT_IGNORE[:]
 
1249
        ignoreset = getattr(self, '_ignoreset', None)
 
1250
        if ignoreset is not None:
 
1251
            return ignoreset
 
1252
 
 
1253
        ignore_globs = set(bzrlib.DEFAULT_IGNORE)
 
1254
        ignore_globs.update(ignores.get_runtime_ignores())
 
1255
 
 
1256
        ignore_globs.update(ignores.get_user_ignores())
 
1257
 
968
1258
        if self.has_filename(bzrlib.IGNORE_FILENAME):
969
1259
            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
 
 
 
1260
            try:
 
1261
                ignore_globs.update(ignores.parse_ignore_file(f))
 
1262
            finally:
 
1263
                f.close()
 
1264
 
 
1265
        self._ignoreset = ignore_globs
 
1266
        self._ignore_regex = self._combine_ignore_rules(ignore_globs)
 
1267
        return ignore_globs
 
1268
 
 
1269
    def _get_ignore_rules_as_regex(self):
 
1270
        """Return a regex of the ignore rules and a mapping dict.
 
1271
 
 
1272
        :return: (ignore rules compiled regex, dictionary mapping rule group 
 
1273
        indices to original rule.)
 
1274
        """
 
1275
        if getattr(self, '_ignoreset', None) is None:
 
1276
            self.get_ignore_list()
 
1277
        return self._ignore_regex
974
1278
 
975
1279
    def is_ignored(self, filename):
976
1280
        r"""Check whether the filename matches an ignore pattern.
990
1294
        # treat dotfiles correctly and allows * to match /.
991
1295
        # Eventually it should be replaced with something more
992
1296
        # 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
 
1297
    
 
1298
        rules = self._get_ignore_rules_as_regex()
 
1299
        for regex, mapping in rules:
 
1300
            match = regex.match(filename)
 
1301
            if match is not None:
 
1302
                # one or more of the groups in mapping will have a non-None
 
1303
                # group match.
 
1304
                groups = match.groups()
 
1305
                rules = [mapping[group] for group in 
 
1306
                    mapping if groups[group] is not None]
 
1307
                return rules[0]
 
1308
        return None
1012
1309
 
1013
1310
    def kind(self, file_id):
1014
1311
        return file_kind(self.id2abspath(file_id))
1015
1312
 
1016
 
    @needs_read_lock
1017
1313
    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().
 
1314
        """Return the last revision of the branch for this tree.
 
1315
 
 
1316
        This format tree does not support a separate marker for last-revision
 
1317
        compared to the branch.
 
1318
 
 
1319
        See MutableTree.last_revision
1023
1320
        """
 
1321
        return self._last_revision()
 
1322
 
 
1323
    @needs_read_lock
 
1324
    def _last_revision(self):
 
1325
        """helper for get_parent_ids."""
1024
1326
        return self.branch.last_revision()
1025
1327
 
 
1328
    def is_locked(self):
 
1329
        return self._control_files.is_locked()
 
1330
 
1026
1331
    def lock_read(self):
1027
1332
        """See Branch.lock_read, and WorkingTree.unlock."""
1028
1333
        self.branch.lock_read()
1032
1337
            self.branch.unlock()
1033
1338
            raise
1034
1339
 
 
1340
    def lock_tree_write(self):
 
1341
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
 
1342
        self.branch.lock_read()
 
1343
        try:
 
1344
            return self._control_files.lock_write()
 
1345
        except:
 
1346
            self.branch.unlock()
 
1347
            raise
 
1348
 
1035
1349
    def lock_write(self):
1036
 
        """See Branch.lock_write, and WorkingTree.unlock."""
 
1350
        """See MutableTree.lock_write, and WorkingTree.unlock."""
1037
1351
        self.branch.lock_write()
1038
1352
        try:
1039
1353
            return self._control_files.lock_write()
1041
1355
            self.branch.unlock()
1042
1356
            raise
1043
1357
 
 
1358
    def get_physical_lock_status(self):
 
1359
        return self._control_files.get_physical_lock_status()
 
1360
 
1044
1361
    def _basis_inventory_name(self):
1045
 
        return 'basis-inventory'
 
1362
        return 'basis-inventory-cache'
1046
1363
 
1047
 
    @needs_write_lock
 
1364
    @needs_tree_write_lock
1048
1365
    def set_last_revision(self, new_revision):
1049
1366
        """Change the last revision in the working tree."""
1050
1367
        if self._change_last_revision(new_revision):
1059
1376
        if new_revision is None:
1060
1377
            self.branch.set_revision_history([])
1061
1378
            return False
1062
 
        # current format is locked in with the branch
1063
 
        revision_history = self.branch.revision_history()
1064
1379
        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])
 
1380
            self.branch.generate_revision_history(new_revision)
 
1381
        except errors.NoSuchRevision:
 
1382
            # not present in the repo - dont try to set it deeper than the tip
 
1383
            self.branch.set_revision_history([new_revision])
1069
1384
        return True
1070
1385
 
1071
1386
    def _cache_basis_inventory(self, new_revision):
1072
1387
        """Cache new_revision as the basis inventory."""
 
1388
        # TODO: this should allow the ready-to-use inventory to be passed in,
 
1389
        # as commit already has that ready-to-use [while the format is the
 
1390
        # same, that is].
1073
1391
        try:
1074
1392
            # this double handles the inventory - unpack and repack - 
1075
1393
            # but is easier to understand. We can/should put a conditional
1076
1394
            # in here based on whether the inventory is in the latest format
1077
1395
            # - perhaps we should repack all inventories on a repository
1078
1396
            # 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
 
 
 
1397
            # the fast path is to copy the raw xml from the repository. If the
 
1398
            # xml contains 'revision_id="', then we assume the right 
 
1399
            # revision_id is set. We must check for this full string, because a
 
1400
            # root node id can legitimately look like 'revision_id' but cannot
 
1401
            # contain a '"'.
 
1402
            xml = self.branch.repository.get_inventory_xml(new_revision)
 
1403
            firstline = xml.split('\n', 1)[0]
 
1404
            if (not 'revision_id="' in firstline or 
 
1405
                'format="6"' not in firstline):
 
1406
                inv = self.branch.repository.deserialise_inventory(
 
1407
                    new_revision, xml)
 
1408
                inv.revision_id = new_revision
 
1409
                xml = bzrlib.xml6.serializer_v6.write_inventory_to_string(inv)
 
1410
            assert isinstance(xml, str), 'serialised xml must be bytestring.'
1083
1411
            path = self._basis_inventory_name()
1084
 
            self._control_files.put_utf8(path, xml)
1085
 
        except WeaveRevisionNotPresent:
 
1412
            sio = StringIO(xml)
 
1413
            self._control_files.put(path, sio)
 
1414
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1086
1415
            pass
1087
1416
 
1088
1417
    def read_basis_inventory(self):
1089
1418
        """Read the cached basis inventory."""
1090
1419
        path = self._basis_inventory_name()
1091
 
        return self._control_files.get_utf8(path).read()
 
1420
        return self._control_files.get(path).read()
1092
1421
        
1093
1422
    @needs_read_lock
1094
1423
    def read_working_inventory(self):
1100
1429
        self._set_inventory(result)
1101
1430
        return result
1102
1431
 
1103
 
    @needs_write_lock
1104
 
    def remove(self, files, verbose=False):
 
1432
    @needs_tree_write_lock
 
1433
    def remove(self, files, verbose=False, to_file=None):
1105
1434
        """Remove nominated files from the working inventory..
1106
1435
 
1107
1436
        This does not remove their text.  This does not run on XXX on what? RBC
1129
1458
                # TODO: Perhaps make this just a warning, and continue?
1130
1459
                # This tends to happen when 
1131
1460
                raise NotVersionedError(path=f)
1132
 
            mutter("remove inventory entry %s {%s}", quotefn(f), fid)
1133
1461
            if verbose:
1134
1462
                # having remove it, it must be either ignored or unknown
1135
1463
                if self.is_ignored(f):
1136
1464
                    new_status = 'I'
1137
1465
                else:
1138
1466
                    new_status = '?'
1139
 
                show_status(new_status, inv[fid].kind, quotefn(f))
 
1467
                show_status(new_status, inv[fid].kind, f, to_file=to_file)
1140
1468
            del inv[fid]
1141
1469
 
1142
1470
        self._write_inventory(inv)
1143
1471
 
1144
 
    @needs_write_lock
 
1472
    @needs_tree_write_lock
1145
1473
    def revert(self, filenames, old_tree=None, backups=True, 
1146
1474
               pb=DummyProgress()):
1147
1475
        from transform import revert
1150
1478
            old_tree = self.basis_tree()
1151
1479
        conflicts = revert(self, old_tree, filenames, backups, pb)
1152
1480
        if not len(filenames):
1153
 
            self.set_pending_merges([])
 
1481
            self.set_parent_ids(self.get_parent_ids()[:1])
1154
1482
            resolve(self)
1155
1483
        else:
1156
1484
            resolve(self, filenames, ignore_misses=True)
1158
1486
 
1159
1487
    # XXX: This method should be deprecated in favour of taking in a proper
1160
1488
    # new Inventory object.
1161
 
    @needs_write_lock
 
1489
    @needs_tree_write_lock
1162
1490
    def set_inventory(self, new_inventory_list):
1163
1491
        from bzrlib.inventory import (Inventory,
1164
1492
                                      InventoryDirectory,
1181
1509
                raise BzrError("unknown kind %r" % kind)
1182
1510
        self._write_inventory(inv)
1183
1511
 
1184
 
    @needs_write_lock
 
1512
    @needs_tree_write_lock
1185
1513
    def set_root_id(self, file_id):
1186
1514
        """Set the root id for this tree."""
1187
1515
        inv = self.read_working_inventory()
1204
1532
        between multiple working trees, i.e. via shared storage, then we 
1205
1533
        would probably want to lock both the local tree, and the branch.
1206
1534
        """
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
 
1535
        raise NotImplementedError(self.unlock)
1229
1536
 
1230
1537
    @needs_write_lock
1231
1538
    def update(self):
1248
1555
        Do a 'normal' merge of the old branch basis if it is relevant.
1249
1556
        """
1250
1557
        old_tip = self.branch.update()
1251
 
        if old_tip is not None:
1252
 
            self.add_pending_merge(old_tip)
1253
 
        self.branch.lock_read()
 
1558
        # here if old_tip is not None, it is the old tip of the branch before
 
1559
        # it was updated from the master branch. This should become a pending
 
1560
        # merge in the working tree to preserve the user existing work.  we
 
1561
        # cant set that until we update the working trees last revision to be
 
1562
        # one from the new branch, because it will just get absorbed by the
 
1563
        # parent de-duplication logic.
 
1564
        # 
 
1565
        # We MUST save it even if an error occurs, because otherwise the users
 
1566
        # local work is unreferenced and will appear to have been lost.
 
1567
        # 
 
1568
        result = 0
1254
1569
        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()
 
1570
            last_rev = self.get_parent_ids()[0]
 
1571
        except IndexError:
 
1572
            last_rev = None
 
1573
        if last_rev != self.branch.last_revision():
 
1574
            # merge tree state up to new branch tip.
 
1575
            basis = self.basis_tree()
 
1576
            to_tree = self.branch.basis_tree()
 
1577
            result += merge_inner(self.branch,
 
1578
                                  to_tree,
 
1579
                                  basis,
 
1580
                                  this_tree=self)
 
1581
            # TODO - dedup parents list with things merged by pull ?
 
1582
            # reuse the tree we've updated to to set the basis:
 
1583
            parent_trees = [(self.branch.last_revision(), to_tree)]
 
1584
            merges = self.get_parent_ids()[1:]
 
1585
            # Ideally we ask the tree for the trees here, that way the working
 
1586
            # tree can decide whether to give us teh entire tree or give us a
 
1587
            # lazy initialised tree. dirstate for instance will have the trees
 
1588
            # in ram already, whereas a last-revision + basis-inventory tree
 
1589
            # will not, but also does not need them when setting parents.
 
1590
            for parent in merges:
 
1591
                parent_trees.append(
 
1592
                    (parent, self.branch.repository.revision_tree(parent)))
 
1593
            if old_tip is not None:
 
1594
                parent_trees.append(
 
1595
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
 
1596
            self.set_parent_trees(parent_trees)
 
1597
            last_rev = parent_trees[0][0]
 
1598
        else:
 
1599
            # the working tree had the same last-revision as the master
 
1600
            # branch did. We may still have pivot local work from the local
 
1601
            # branch into old_tip:
 
1602
            if old_tip is not None:
 
1603
                self.add_parent_tree_id(old_tip)
 
1604
        if old_tip and old_tip != last_rev:
 
1605
            # our last revision was not the prior branch last revision
 
1606
            # and we have converted that last revision to a pending merge.
 
1607
            # base is somewhere between the branch tip now
 
1608
            # and the now pending merge
 
1609
            from bzrlib.revision import common_ancestor
 
1610
            try:
 
1611
                base_rev_id = common_ancestor(self.branch.last_revision(),
 
1612
                                              old_tip,
 
1613
                                              self.branch.repository)
 
1614
            except errors.NoCommonAncestor:
 
1615
                base_rev_id = None
 
1616
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
1617
            other_tree = self.branch.repository.revision_tree(old_tip)
 
1618
            result += merge_inner(self.branch,
 
1619
                                  other_tree,
 
1620
                                  base_tree,
 
1621
                                  this_tree=self)
 
1622
        return result
1286
1623
 
1287
 
    @needs_write_lock
 
1624
    @needs_tree_write_lock
1288
1625
    def _write_inventory(self, inv):
1289
1626
        """Write inventory as the current inventory."""
1290
1627
        sio = StringIO()
1297
1634
    def set_conflicts(self, arg):
1298
1635
        raise UnsupportedOperation(self.set_conflicts, self)
1299
1636
 
 
1637
    def add_conflicts(self, arg):
 
1638
        raise UnsupportedOperation(self.add_conflicts, self)
 
1639
 
1300
1640
    @needs_read_lock
1301
1641
    def conflicts(self):
1302
1642
        conflicts = ConflictList()
1305
1645
            try:
1306
1646
                if file_kind(self.abspath(conflicted)) != "file":
1307
1647
                    text = False
1308
 
            except OSError, e:
1309
 
                if e.errno == errno.ENOENT:
1310
 
                    text = False
1311
 
                else:
1312
 
                    raise
 
1648
            except errors.NoSuchFile:
 
1649
                text = False
1313
1650
            if text is True:
1314
1651
                for suffix in ('.THIS', '.OTHER'):
1315
1652
                    try:
1316
1653
                        kind = file_kind(self.abspath(conflicted+suffix))
1317
 
                    except OSError, e:
1318
 
                        if e.errno == errno.ENOENT:
 
1654
                        if kind != "file":
1319
1655
                            text = False
1320
 
                            break
1321
 
                        else:
1322
 
                            raise
1323
 
                    if kind != "file":
 
1656
                    except errors.NoSuchFile:
1324
1657
                        text = False
 
1658
                    if text == False:
1325
1659
                        break
1326
1660
            ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1327
1661
            conflicts.append(Conflict.factory(ctype, path=conflicted,
1329
1663
        return conflicts
1330
1664
 
1331
1665
 
 
1666
class WorkingTree2(WorkingTree):
 
1667
    """This is the Format 2 working tree.
 
1668
 
 
1669
    This was the first weave based working tree. 
 
1670
     - uses os locks for locking.
 
1671
     - uses the branch last-revision.
 
1672
    """
 
1673
 
 
1674
    def lock_tree_write(self):
 
1675
        """See WorkingTree.lock_tree_write().
 
1676
 
 
1677
        In Format2 WorkingTrees we have a single lock for the branch and tree
 
1678
        so lock_tree_write() degrades to lock_write().
 
1679
        """
 
1680
        self.branch.lock_write()
 
1681
        try:
 
1682
            return self._control_files.lock_write()
 
1683
        except:
 
1684
            self.branch.unlock()
 
1685
            raise
 
1686
 
 
1687
    def unlock(self):
 
1688
        # we share control files:
 
1689
        if self._hashcache.needs_write and self._control_files._lock_count==3:
 
1690
            self._hashcache.write()
 
1691
        # reverse order of locking.
 
1692
        try:
 
1693
            return self._control_files.unlock()
 
1694
        finally:
 
1695
            self.branch.unlock()
 
1696
 
 
1697
 
1332
1698
class WorkingTree3(WorkingTree):
1333
1699
    """This is the Format 3 working tree.
1334
1700
 
1340
1706
    """
1341
1707
 
1342
1708
    @needs_read_lock
1343
 
    def last_revision(self):
1344
 
        """See WorkingTree.last_revision."""
 
1709
    def _last_revision(self):
 
1710
        """See Mutable.last_revision."""
1345
1711
        try:
1346
1712
            return self._control_files.get_utf8('last-revision').read()
1347
1713
        except NoSuchFile:
1356
1722
                pass
1357
1723
            return False
1358
1724
        else:
1359
 
            try:
1360
 
                self.branch.revision_history().index(revision_id)
1361
 
            except ValueError:
1362
 
                raise errors.NoSuchRevision(self.branch, revision_id)
1363
1725
            self._control_files.put_utf8('last-revision', revision_id)
1364
1726
            return True
1365
1727
 
1366
 
    @needs_write_lock
 
1728
    @needs_tree_write_lock
1367
1729
    def set_conflicts(self, conflicts):
1368
1730
        self._put_rio('conflicts', conflicts.to_stanzas(), 
1369
1731
                      CONFLICT_HEADER_1)
1370
1732
 
 
1733
    @needs_tree_write_lock
 
1734
    def add_conflicts(self, new_conflicts):
 
1735
        conflict_set = set(self.conflicts())
 
1736
        conflict_set.update(set(list(new_conflicts)))
 
1737
        self.set_conflicts(ConflictList(sorted(conflict_set,
 
1738
                                               key=Conflict.sort_key)))
 
1739
 
1371
1740
    @needs_read_lock
1372
1741
    def conflicts(self):
1373
1742
        try:
1381
1750
            raise ConflictFormatError()
1382
1751
        return ConflictList.from_stanzas(RioReader(confile))
1383
1752
 
 
1753
    def unlock(self):
 
1754
        if self._hashcache.needs_write and self._control_files._lock_count==1:
 
1755
            self._hashcache.write()
 
1756
        # reverse order of locking.
 
1757
        try:
 
1758
            return self._control_files.unlock()
 
1759
        finally:
 
1760
            self.branch.unlock()
 
1761
 
1384
1762
 
1385
1763
def get_conflicted_stem(path):
1386
1764
    for suffix in CONFLICT_SUFFIXES:
1437
1815
        except NoSuchFile:
1438
1816
            raise errors.NoWorkingTree(base=transport.base)
1439
1817
        except KeyError:
1440
 
            raise errors.UnknownFormatError(format_string)
 
1818
            raise errors.UnknownFormatError(format=format_string)
1441
1819
 
1442
1820
    @classmethod
1443
1821
    def get_default_format(klass):
1486
1864
        """See WorkingTreeFormat.get_format_description()."""
1487
1865
        return "Working tree format 2"
1488
1866
 
 
1867
    def stub_initialize_remote(self, control_files):
 
1868
        """As a special workaround create critical control files for a remote working tree
 
1869
        
 
1870
        This ensures that it can later be updated and dealt with locally,
 
1871
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with 
 
1872
        no working tree.  (See bug #43064).
 
1873
        """
 
1874
        sio = StringIO()
 
1875
        inv = Inventory()
 
1876
        bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
 
1877
        sio.seek(0)
 
1878
        control_files.put('inventory', sio)
 
1879
 
 
1880
        control_files.put_utf8('pending-merges', '')
 
1881
        
 
1882
 
1489
1883
    def initialize(self, a_bzrdir, revision_id=None):
1490
1884
        """See WorkingTreeFormat.initialize()."""
1491
1885
        if not isinstance(a_bzrdir.transport, LocalTransport):
1503
1897
            finally:
1504
1898
                branch.unlock()
1505
1899
        revision = branch.last_revision()
1506
 
        inv = Inventory() 
1507
 
        wt = WorkingTree(a_bzrdir.root_transport.base,
 
1900
        inv = Inventory()
 
1901
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1508
1902
                         branch,
1509
1903
                         inv,
1510
1904
                         _internal=True,
1512
1906
                         _bzrdir=a_bzrdir)
1513
1907
        wt._write_inventory(inv)
1514
1908
        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)
 
1909
        basis_tree = branch.repository.revision_tree(revision)
 
1910
        wt.set_parent_trees([(revision, basis_tree)])
 
1911
        build_tree(basis_tree, wt)
1518
1912
        return wt
1519
1913
 
1520
1914
    def __init__(self):
1532
1926
            raise NotImplementedError
1533
1927
        if not isinstance(a_bzrdir.transport, LocalTransport):
1534
1928
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
1535
 
        return WorkingTree(a_bzrdir.root_transport.base,
 
1929
        return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1536
1930
                           _internal=True,
1537
1931
                           _format=self,
1538
1932
                           _bzrdir=a_bzrdir)
1547
1941
          files, separate from the BzrDir format
1548
1942
        - modifies the hash cache format
1549
1943
        - is new in bzr 0.8
1550
 
        - uses a LockDir to guard access to the repository
 
1944
        - uses a LockDir to guard access for writes.
1551
1945
    """
1552
1946
 
1553
1947
    def get_format_string(self):
1569
1963
    def initialize(self, a_bzrdir, revision_id=None):
1570
1964
        """See WorkingTreeFormat.initialize().
1571
1965
        
1572
 
        revision_id allows creating a working tree at a differnet
 
1966
        revision_id allows creating a working tree at a different
1573
1967
        revision than the branch is at.
1574
1968
        """
1575
1969
        if not isinstance(a_bzrdir.transport, LocalTransport):
1577
1971
        transport = a_bzrdir.get_workingtree_transport(self)
1578
1972
        control_files = self._open_control_files(a_bzrdir)
1579
1973
        control_files.create_lock()
 
1974
        control_files.lock_write()
1580
1975
        control_files.put_utf8('format', self.get_format_string())
1581
1976
        branch = a_bzrdir.open_branch()
1582
1977
        if revision_id is None:
1583
1978
            revision_id = branch.last_revision()
1584
1979
        inv = Inventory() 
1585
 
        wt = WorkingTree3(a_bzrdir.root_transport.base,
 
1980
        wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1586
1981
                         branch,
1587
1982
                         inv,
1588
1983
                         _internal=True,
1589
1984
                         _format=self,
1590
1985
                         _bzrdir=a_bzrdir,
1591
1986
                         _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)
 
1987
        wt.lock_tree_write()
 
1988
        try:
 
1989
            wt._write_inventory(inv)
 
1990
            wt.set_root_id(inv.root.file_id)
 
1991
            basis_tree = branch.repository.revision_tree(revision_id)
 
1992
            if revision_id == bzrlib.revision.NULL_REVISION:
 
1993
                wt.set_parent_trees([])
 
1994
            else:
 
1995
                wt.set_parent_trees([(revision_id, basis_tree)])
 
1996
            build_tree(basis_tree, wt)
 
1997
        finally:
 
1998
            wt.unlock()
 
1999
            control_files.unlock()
1597
2000
        return wt
1598
2001
 
1599
2002
    def __init__(self):
1611
2014
            raise NotImplementedError
1612
2015
        if not isinstance(a_bzrdir.transport, LocalTransport):
1613
2016
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
1614
 
        control_files = self._open_control_files(a_bzrdir)
1615
 
        return WorkingTree3(a_bzrdir.root_transport.base,
 
2017
        return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
 
2018
 
 
2019
    def _open(self, a_bzrdir, control_files):
 
2020
        """Open the tree itself.
 
2021
        
 
2022
        :param a_bzrdir: the dir for the tree.
 
2023
        :param control_files: the control files for the tree.
 
2024
        """
 
2025
        return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1616
2026
                           _internal=True,
1617
2027
                           _format=self,
1618
2028
                           _bzrdir=a_bzrdir,
1645
2055
        self._transport_readonly_server = transport_readonly_server
1646
2056
        self._formats = formats
1647
2057
    
 
2058
    def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
 
2059
        """Clone test for adaption."""
 
2060
        new_test = deepcopy(test)
 
2061
        new_test.transport_server = self._transport_server
 
2062
        new_test.transport_readonly_server = self._transport_readonly_server
 
2063
        new_test.bzrdir_format = bzrdir_format
 
2064
        new_test.workingtree_format = workingtree_format
 
2065
        def make_new_test_id():
 
2066
            new_id = "%s(%s)" % (test.id(), variation)
 
2067
            return lambda: new_id
 
2068
        new_test.id = make_new_test_id()
 
2069
        return new_test
 
2070
    
1648
2071
    def adapt(self, test):
1649
2072
        from bzrlib.tests import TestSuite
1650
2073
        result = TestSuite()
1651
2074
        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()
 
2075
            new_test = self._clone_test(
 
2076
                test,
 
2077
                bzrdir_format,
 
2078
                workingtree_format, workingtree_format.__class__.__name__)
1661
2079
            result.addTest(new_test)
1662
2080
        return result