/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 updated set_parents api.

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
        )
 
100
from bzrlib.trace import mutter, note
96
101
from bzrlib.transform import build_tree
97
 
from bzrlib.trace import mutter, note
98
102
from bzrlib.transport import get_transport
99
103
from bzrlib.transport.local import LocalTransport
 
104
from bzrlib.textui import show_status
 
105
import bzrlib.tree
100
106
import bzrlib.ui
101
107
import bzrlib.xml5
102
108
 
103
109
 
 
110
# the regex removes any weird characters; we don't escape them 
 
111
# but rather just pull them out
 
112
_gen_file_id_re = re.compile(r'[^\w.]')
 
113
_gen_id_suffix = None
 
114
_gen_id_serial = 0
 
115
 
 
116
 
 
117
def _next_id_suffix():
 
118
    """Create a new file id suffix that is reasonably unique.
 
119
    
 
120
    On the first call we combine the current time with 64 bits of randomness
 
121
    to give a highly probably globally unique number. Then each call in the same
 
122
    process adds 1 to a serial number we append to that unique value.
 
123
    """
 
124
    # XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather 
 
125
    # than having to move the id randomness out of the inner loop like this.
 
126
    # XXX TODO: for the global randomness this uses we should add the thread-id
 
127
    # before the serial #.
 
128
    global _gen_id_suffix, _gen_id_serial
 
129
    if _gen_id_suffix is None:
 
130
        _gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
 
131
    _gen_id_serial += 1
 
132
    return _gen_id_suffix + str(_gen_id_serial)
 
133
 
 
134
 
104
135
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))
 
136
    """Return new file id for the basename 'name'.
 
137
 
 
138
    The uniqueness is supplied from _next_id_suffix.
 
139
    """
 
140
    # The real randomness is in the _next_id_suffix, the
 
141
    # rest of the identifier is just to be nice.
 
142
    # So we:
 
143
    # 1) Remove non-ascii word characters to keep the ids portable
 
144
    # 2) squash to lowercase, so the file id doesn't have to
 
145
    #    be escaped (case insensitive filesystems would bork for ids
 
146
    #    that only differred in case without escaping).
 
147
    # 3) truncate the filename to 20 chars. Long filenames also bork on some
 
148
    #    filesystems
 
149
    # 4) Removing starting '.' characters to prevent the file ids from
 
150
    #    being considered hidden.
 
151
    ascii_word_only = _gen_file_id_re.sub('', name.lower())
 
152
    short_no_dots = ascii_word_only.lstrip('.')[:20]
 
153
    return short_no_dots + _next_id_suffix()
131
154
 
132
155
 
133
156
def gen_root_id():
136
159
 
137
160
 
138
161
class TreeEntry(object):
139
 
    """An entry that implements the minium interface used by commands.
 
162
    """An entry that implements the minimum interface used by commands.
140
163
 
141
164
    This needs further inspection, it may be better to have 
142
165
    InventoryEntries without ids - though that seems wrong. For now,
218
241
        self.bzrdir = _bzrdir
219
242
        if not _internal:
220
243
            # not created via open etc.
221
 
            warn("WorkingTree() is deprecated as of bzr version 0.8. "
 
244
            warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
222
245
                 "Please use bzrdir.open_workingtree or WorkingTree.open().",
223
246
                 DeprecationWarning,
224
247
                 stacklevel=2)
225
248
            wt = WorkingTree.open(basedir)
226
 
            self.branch = wt.branch
 
249
            self._branch = wt.branch
227
250
            self.basedir = wt.basedir
228
251
            self._control_files = wt._control_files
229
252
            self._hashcache = wt._hashcache
238
261
        mutter("opening working tree %r", basedir)
239
262
        if deprecated_passed(branch):
240
263
            if not _internal:
241
 
                warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
 
264
                warnings.warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
242
265
                     " Please use bzrdir.open_workingtree() or"
243
266
                     " WorkingTree.open().",
244
267
                     DeprecationWarning,
245
268
                     stacklevel=2
246
269
                     )
247
 
            self.branch = branch
 
270
            self._branch = branch
248
271
        else:
249
 
            self.branch = self.bzrdir.open_branch()
250
 
        assert isinstance(self.branch, Branch), \
251
 
            "branch %r is not a Branch" % self.branch
 
272
            self._branch = self.bzrdir.open_branch()
252
273
        self.basedir = realpath(basedir)
253
274
        # if branch is at our basedir and is a format 6 or less
254
275
        if isinstance(self._format, WorkingTreeFormat2):
255
276
            # share control object
256
277
            self._control_files = self.branch.control_files
257
278
        else:
258
 
            # only ready for format 3
259
 
            assert isinstance(self._format, WorkingTreeFormat3)
 
279
            # assume all other formats have their own control files.
260
280
            assert isinstance(_control_files, LockableFiles), \
261
281
                    "_control_files must be a LockableFiles, not %r" \
262
282
                    % _control_files
267
287
        # if needed, or, when the cache sees a change, append it to the hash
268
288
        # cache file, and have the parser take the most recent entry for a
269
289
        # given path only.
270
 
        cache_filename = self.bzrdir.get_workingtree_transport(None).abspath('stat-cache')
 
290
        cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
271
291
        hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
272
292
        hc.read()
273
293
        # is this scan needed ? it makes things kinda slow.
274
 
        hc.scan()
 
294
        #hc.scan()
275
295
 
276
296
        if hc.needs_write:
277
297
            mutter("write hc")
282
302
        else:
283
303
            self._set_inventory(_inventory)
284
304
 
 
305
    branch = property(
 
306
        fget=lambda self: self._branch,
 
307
        doc="""The branch this WorkingTree is connected to.
 
308
 
 
309
            This cannot be set - it is reflective of the actual disk structure
 
310
            the working tree has been constructed from.
 
311
            """)
 
312
 
 
313
    def break_lock(self):
 
314
        """Break a lock if one is present from another instance.
 
315
 
 
316
        Uses the ui factory to ask for confirmation if the lock may be from
 
317
        an active process.
 
318
 
 
319
        This will probe the repository for its lock as well.
 
320
        """
 
321
        self._control_files.break_lock()
 
322
        self.branch.break_lock()
 
323
 
285
324
    def _set_inventory(self, inv):
 
325
        assert inv.root is not None
286
326
        self._inventory = inv
287
327
        self.path2id = self._inventory.path2id
288
328
 
289
329
    def is_control_filename(self, filename):
290
330
        """True if filename is the name of a control file in this tree.
291
331
        
 
332
        :param filename: A filename within the tree. This is a relative path
 
333
        from the root of this tree.
 
334
 
292
335
        This is true IF and ONLY IF the filename is part of the meta data
293
336
        that bzr controls in this tree. I.E. a random .bzr directory placed
294
337
        on disk will not be a control file for this tree.
295
338
        """
296
 
        try:
297
 
            self.bzrdir.transport.relpath(self.abspath(filename))
298
 
            return True
299
 
        except errors.PathNotChild:
300
 
            return False
 
339
        return self.bzrdir.is_control_filename(filename)
301
340
 
302
341
    @staticmethod
303
342
    def open(path=None, _unsupported=False):
319
358
        run into /.  If there isn't one, raises NotBranchError.
320
359
        TODO: give this a new exception.
321
360
        If there is one, it is returned, along with the unused portion of path.
 
361
 
 
362
        :return: The WorkingTree that contains 'path', and the rest of path
322
363
        """
323
364
        if path is None:
324
 
            path = os.getcwdu()
 
365
            path = osutils.getcwd()
325
366
        control, relpath = bzrdir.BzrDir.open_containing(path)
 
367
 
326
368
        return control.open_workingtree(), relpath
327
369
 
328
370
    @staticmethod
341
383
        """
342
384
        inv = self._inventory
343
385
        for path, ie in inv.iter_entries():
344
 
            if bzrlib.osutils.lexists(self.abspath(path)):
 
386
            if osutils.lexists(self.abspath(path)):
345
387
                yield ie.file_id
346
388
 
347
389
    def __repr__(self):
352
394
        return pathjoin(self.basedir, filename)
353
395
    
354
396
    def basis_tree(self):
355
 
        """Return RevisionTree for the current last revision."""
 
397
        """Return RevisionTree for the current last revision.
 
398
        
 
399
        If the left most parent is a ghost then the returned tree will be an
 
400
        empty tree - one obtained by calling repository.revision_tree(None).
 
401
        """
356
402
        revision_id = self.last_revision()
357
403
        if revision_id is not None:
358
404
            try:
359
405
                xml = self.read_basis_inventory()
360
406
                inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
 
407
                inv.root.revision = revision_id
361
408
            except NoSuchFile:
362
409
                inv = None
363
410
            if inv is not None and inv.revision_id == revision_id:
364
411
                return bzrlib.tree.RevisionTree(self.branch.repository, inv,
365
412
                                                revision_id)
366
413
        # FIXME? RBC 20060403 should we cache the inventory here ?
367
 
        return self.branch.repository.revision_tree(revision_id)
 
414
        try:
 
415
            return self.branch.repository.revision_tree(revision_id)
 
416
        except errors.RevisionNotPresent:
 
417
            # the basis tree *may* be a ghost or a low level error may have
 
418
            # occured. If the revision is present, its a problem, if its not
 
419
            # its a ghost.
 
420
            if self.branch.repository.has_revision(revision_id):
 
421
                raise
 
422
            # the basis tree is a ghost so return an empty tree.
 
423
            return self.branch.repository.revision_tree(None)
368
424
 
369
425
    @staticmethod
370
426
    @deprecated_method(zero_eight)
383
439
        XXX: When BzrDir is present, these should be created through that 
384
440
        interface instead.
385
441
        """
386
 
        warn('delete WorkingTree.create', stacklevel=3)
 
442
        warnings.warn('delete WorkingTree.create', stacklevel=3)
387
443
        transport = get_transport(directory)
388
444
        if branch.bzrdir.root_transport.base == transport.base:
389
445
            # same dir 
404
460
        """
405
461
        return bzrdir.BzrDir.create_standalone_workingtree(directory)
406
462
 
407
 
    def relpath(self, abs):
408
 
        """Return the local path portion from a given absolute path."""
409
 
        return relpath(self.basedir, abs)
 
463
    def relpath(self, path):
 
464
        """Return the local path portion from a given path.
 
465
        
 
466
        The path may be absolute or relative. If its a relative path it is 
 
467
        interpreted relative to the python current working directory.
 
468
        """
 
469
        return relpath(self.basedir, path)
410
470
 
411
471
    def has_filename(self, filename):
412
 
        return bzrlib.osutils.lexists(self.abspath(filename))
 
472
        return osutils.lexists(self.abspath(filename))
413
473
 
414
474
    def get_file(self, file_id):
415
475
        return self.get_file_byname(self.id2path(file_id))
416
476
 
 
477
    def get_file_text(self, file_id):
 
478
        return self.get_file(file_id).read()
 
479
 
417
480
    def get_file_byname(self, filename):
418
481
        return file(self.abspath(filename), 'rb')
419
482
 
 
483
    def get_parent_ids(self):
 
484
        """See Tree.get_parent_ids.
 
485
        
 
486
        This implementation reads the pending merges list and last_revision
 
487
        value and uses that to decide what the parents list should be.
 
488
        """
 
489
        last_rev = self.last_revision()
 
490
        if last_rev is None:
 
491
            parents = []
 
492
        else:
 
493
            parents = [last_rev]
 
494
        other_parents = self.pending_merges()
 
495
        return parents + other_parents
 
496
 
420
497
    def get_root_id(self):
421
498
        """Return the id of this trees root"""
422
499
        inv = self.read_working_inventory()
455
532
        if revision_id is None:
456
533
            transform_tree(tree, self)
457
534
        else:
458
 
            # TODO now merge from tree.last_revision to revision
 
535
            # TODO now merge from tree.last_revision to revision (to preserve
 
536
            # user local changes)
459
537
            transform_tree(tree, self)
460
 
            tree.set_last_revision(revision_id)
 
538
            tree.set_parent_ids([revision_id])
461
539
 
462
540
    @needs_write_lock
463
541
    def commit(self, message=None, revprops=None, *args, **kwargs):
471
549
        # but with branch a kwarg now, passing in args as is results in the
472
550
        #message being used for the branch
473
551
        args = (DEPRECATED_PARAMETER, message, ) + args
474
 
        Commit().commit(working_tree=self, revprops=revprops, *args, **kwargs)
 
552
        committed_id = Commit().commit( working_tree=self, revprops=revprops,
 
553
            *args, **kwargs)
475
554
        self._set_inventory(self.read_working_inventory())
 
555
        return committed_id
476
556
 
477
557
    def id2abspath(self, file_id):
478
558
        return self.abspath(self.id2path(file_id))
483
563
        if not inv.has_id(file_id):
484
564
            return False
485
565
        path = inv.id2path(file_id)
486
 
        return bzrlib.osutils.lexists(self.abspath(path))
 
566
        return osutils.lexists(self.abspath(path))
487
567
 
488
568
    def has_or_had_id(self, file_id):
489
569
        if file_id == self.inventory.root.file_id:
496
576
        return os.path.getsize(self.id2abspath(file_id))
497
577
 
498
578
    @needs_read_lock
499
 
    def get_file_sha1(self, file_id):
500
 
        path = self._inventory.id2path(file_id)
 
579
    def get_file_sha1(self, file_id, path=None):
 
580
        if not path:
 
581
            path = self._inventory.id2path(file_id)
501
582
        return self._hashcache.get_sha1(path)
502
583
 
503
 
    def is_executable(self, file_id):
504
 
        if not supports_executable():
 
584
    def get_file_mtime(self, file_id, path=None):
 
585
        if not path:
 
586
            path = self._inventory.id2path(file_id)
 
587
        return os.lstat(self.abspath(path)).st_mtime
 
588
 
 
589
    if not supports_executable():
 
590
        def is_executable(self, file_id, path=None):
505
591
            return self._inventory[file_id].executable
506
 
        else:
507
 
            path = self._inventory.id2path(file_id)
 
592
    else:
 
593
        def is_executable(self, file_id, path=None):
 
594
            if not path:
 
595
                path = self._inventory.id2path(file_id)
508
596
            mode = os.lstat(self.abspath(path)).st_mode
509
 
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
 
597
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
510
598
 
511
599
    @needs_write_lock
512
600
    def add(self, files, ids=None):
547
635
        inv = self.read_working_inventory()
548
636
        for f,file_id in zip(files, ids):
549
637
            if self.is_control_filename(f):
550
 
                raise BzrError("cannot add control file %s" % quotefn(f))
 
638
                raise errors.ForbiddenControlFileError(filename=f)
551
639
 
552
640
            fp = splitpath(f)
553
641
 
555
643
                raise BzrError("cannot add top-level %r" % f)
556
644
 
557
645
            fullpath = normpath(self.abspath(f))
558
 
 
559
646
            try:
560
647
                kind = file_kind(fullpath)
561
648
            except OSError, e:
562
649
                if e.errno == errno.ENOENT:
563
650
                    raise NoSuchFile(fullpath)
564
 
                # maybe something better?
565
 
                raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
566
 
 
567
651
            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
 
 
 
652
                raise errors.BadFileKindError(filename=f, kind=kind)
571
653
            if file_id is None:
572
 
                file_id = gen_file_id(f)
573
 
            inv.add_path(f, kind=kind, file_id=file_id)
 
654
                inv.add_path(f, kind=kind)
 
655
            else:
 
656
                inv.add_path(f, kind=kind, file_id=file_id)
574
657
 
575
 
            mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
576
658
        self._write_inventory(inv)
577
659
 
578
660
    @needs_write_lock
 
661
    def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
 
662
        """Add revision_id as a parent.
 
663
 
 
664
        This is equivalent to retrieving the current list of parent ids
 
665
        and setting the list to its value plus revision_id.
 
666
 
 
667
        :param revision_id: The revision id to add to the parent list. It may
 
668
        be a ghost revision as long as its not the first parent to be added,
 
669
        or the allow_leftmost_as_ghost parameter is set True.
 
670
        :param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
 
671
        """
 
672
        self.set_parent_ids(self.get_parent_ids() + [revision_id],
 
673
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
674
 
 
675
    @needs_write_lock
 
676
    def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
 
677
        """Add revision_id, tree tuple as a parent.
 
678
 
 
679
        This is equivalent to retrieving the current list of parent trees
 
680
        and setting the list to its value plus parent_tuple. See also
 
681
        add_parent_tree_id - if you only have a parent id available it will be
 
682
        simpler to use that api. If you have the parent already available, using
 
683
        this api is preferred.
 
684
 
 
685
        :param parent_tuple: The (revision id, tree) to add to the parent list.
 
686
            If the revision_id is a ghost, pass None for the tree.
 
687
        :param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
 
688
        """
 
689
        self.set_parent_ids(self.get_parent_ids() + [parent_tuple[0]],
 
690
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
691
 
 
692
    @needs_write_lock
579
693
    def add_pending_merge(self, *revision_ids):
580
694
        # TODO: Perhaps should check at this point that the
581
695
        # history of the revision is actually present?
582
696
        p = self.pending_merges()
 
697
        existing_parents = self.get_parent_ids()
583
698
        updated = False
584
699
        for rev_id in revision_ids:
585
700
            if rev_id in p:
586
701
                continue
 
702
            if rev_id in existing_parents:
 
703
                continue
587
704
            p.append(rev_id)
588
705
            updated = True
589
706
        if updated:
598
715
        """
599
716
        try:
600
717
            merges_file = self._control_files.get_utf8('pending-merges')
601
 
        except OSError, e:
602
 
            if e.errno != errno.ENOENT:
603
 
                raise
 
718
        except NoSuchFile:
604
719
            return []
605
720
        p = []
606
721
        for l in merges_file.readlines():
608
723
        return p
609
724
 
610
725
    @needs_write_lock
 
726
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
 
727
        """Set the parent ids to revision_ids.
 
728
        
 
729
        See also set_parent_trees. This api will try to retrieve the tree data
 
730
        for each element of revision_ids from the trees repository. If you have
 
731
        tree data already available, it is more efficient to use
 
732
        set_parent_trees rather than set_parent_ids. set_parent_ids is however
 
733
        an easier API to use.
 
734
 
 
735
        :param revision_ids: The revision_ids to set as the parent ids of this
 
736
            working tree. Any of these may be ghosts.
 
737
        """
 
738
        trees = []
 
739
        for rev_id in revision_ids:
 
740
            try:
 
741
                trees.append(
 
742
                    (rev_id, self.branch.repository.revision_tree(rev_id)))
 
743
            except errors.RevisionNotPresent:
 
744
                trees.append((rev_id, None))
 
745
        self.set_parent_trees(trees,
 
746
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
747
 
 
748
    @needs_write_lock
 
749
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
 
750
        """Set the parents of the working tree.
 
751
 
 
752
        :param parents_list: A list of (revision_id, tree) tuples. 
 
753
            If tree is None, then that element is treated as an unreachable
 
754
            parent tree - i.e. a ghost.
 
755
        """
 
756
        if len(parents_list) > 0:
 
757
            leftmost_id = parents_list[0][0]
 
758
            if (not allow_leftmost_as_ghost and not
 
759
                self.branch.repository.has_revision(leftmost_id)):
 
760
                raise errors.GhostRevisionUnusableHere(leftmost_id)
 
761
            self.set_last_revision(leftmost_id)
 
762
        else:
 
763
            self.set_last_revision(None)
 
764
        merges = parents_list[1:]
 
765
        self.set_pending_merges([revid for revid, tree in merges])
 
766
 
 
767
    @needs_write_lock
611
768
    def set_pending_merges(self, rev_list):
 
769
        if self.last_revision() is None:
 
770
            new_last_list = rev_list[:1]
 
771
            rev_list = rev_list[1:]
 
772
            if new_last_list:
 
773
                self.set_last_revision(new_last_list[0])
612
774
        self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
613
775
 
614
776
    @needs_write_lock
656
818
            return '?'
657
819
 
658
820
    def list_files(self):
659
 
        """Recursively list all files as (path, class, kind, id).
 
821
        """Recursively list all files as (path, class, kind, id, entry).
660
822
 
661
823
        Lists, but does not descend into unversioned directories.
662
824
 
666
828
        Skips the control directory.
667
829
        """
668
830
        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:
 
831
        # Convert these into local objects to save lookup times
 
832
        pathjoin = osutils.pathjoin
 
833
        file_kind = osutils.file_kind
 
834
 
 
835
        # transport.base ends in a slash, we want the piece
 
836
        # between the last two slashes
 
837
        transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
 
838
 
 
839
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
 
840
 
 
841
        # directory file_id, relative path, absolute path, reverse sorted children
 
842
        children = os.listdir(self.basedir)
 
843
        children.sort()
 
844
        # jam 20060527 The kernel sized tree seems equivalent whether we 
 
845
        # use a deque and popleft to keep them sorted, or if we use a plain
 
846
        # list and just reverse() them.
 
847
        children = collections.deque(children)
 
848
        stack = [(inv.root.file_id, u'', self.basedir, children)]
 
849
        while stack:
 
850
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
 
851
 
 
852
            while children:
 
853
                f = children.popleft()
674
854
                ## TODO: If we find a subdirectory with its own .bzr
675
855
                ## directory, then that is a separate tree and we
676
856
                ## should exclude it.
677
857
 
678
858
                # the bzrdir for this tree
679
 
                if self.bzrdir.transport.base.endswith(f + '/'):
 
859
                if transport_base_dir == f:
680
860
                    continue
681
861
 
682
 
                # path within tree
683
 
                fp = appendpath(from_dir_relpath, f)
 
862
                # we know that from_dir_relpath and from_dir_abspath never end in a slash
 
863
                # and 'f' doesn't begin with one, we can do a string op, rather
 
864
                # than the checks of pathjoin(), all relative paths will have an extra slash
 
865
                # at the beginning
 
866
                fp = from_dir_relpath + '/' + f
684
867
 
685
868
                # absolute path
686
 
                fap = appendpath(dp, f)
 
869
                fap = from_dir_abspath + '/' + f
687
870
                
688
871
                f_ie = inv.get_child(from_dir_id, f)
689
872
                if f_ie:
690
873
                    c = 'V'
691
 
                elif self.is_ignored(fp):
 
874
                elif self.is_ignored(fp[1:]):
692
875
                    c = 'I'
693
876
                else:
694
 
                    c = '?'
 
877
                    # we may not have found this file, because of a unicode issue
 
878
                    f_norm, can_access = osutils.normalized_filename(f)
 
879
                    if f == f_norm or not can_access:
 
880
                        # No change, so treat this file normally
 
881
                        c = '?'
 
882
                    else:
 
883
                        # this file can be accessed by a normalized path
 
884
                        # check again if it is versioned
 
885
                        # these lines are repeated here for performance
 
886
                        f = f_norm
 
887
                        fp = from_dir_relpath + '/' + f
 
888
                        fap = from_dir_abspath + '/' + f
 
889
                        f_ie = inv.get_child(from_dir_id, f)
 
890
                        if f_ie:
 
891
                            c = 'V'
 
892
                        elif self.is_ignored(fp[1:]):
 
893
                            c = 'I'
 
894
                        else:
 
895
                            c = '?'
695
896
 
696
897
                fk = file_kind(fap)
697
898
 
703
904
 
704
905
                # make a last minute entry
705
906
                if f_ie:
706
 
                    entry = f_ie
 
907
                    yield fp[1:], c, fk, f_ie.file_id, f_ie
707
908
                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()
 
909
                    try:
 
910
                        yield fp[1:], c, fk, None, fk_entries[fk]()
 
911
                    except KeyError:
 
912
                        yield fp[1:], c, fk, None, TreeEntry()
 
913
                    continue
716
914
                
717
 
                yield fp, c, fk, (f_ie and f_ie.file_id), entry
718
 
 
719
915
                if fk != 'directory':
720
916
                    continue
721
917
 
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
 
918
                # But do this child first
 
919
                new_children = os.listdir(fap)
 
920
                new_children.sort()
 
921
                new_children = collections.deque(new_children)
 
922
                stack.append((f_ie.file_id, fp, fap, new_children))
 
923
                # Break out of inner loop, so that we start outer loop with child
 
924
                break
 
925
            else:
 
926
                # if we finished all children, pop it off the stack
 
927
                stack.pop()
728
928
 
729
 
        for f in descend(u'', inv.root.file_id, self.basedir):
730
 
            yield f
731
929
 
732
930
    @needs_write_lock
733
931
    def move(self, from_paths, to_name):
757
955
        if to_dir_id == None and to_name != '':
758
956
            raise BzrError("destination %r is not a versioned directory" % to_name)
759
957
        to_dir_ie = inv[to_dir_id]
760
 
        if to_dir_ie.kind not in ('directory', 'root_directory'):
 
958
        if to_dir_ie.kind != 'directory':
761
959
            raise BzrError("destination %r is not a directory" % to_abs)
762
960
 
763
961
        to_idpath = inv.get_idpath(to_dir_id)
769
967
            if f_id == None:
770
968
                raise BzrError("%r is not versioned" % f)
771
969
            name_tail = splitpath(f)[-1]
772
 
            dest_path = appendpath(to_name, name_tail)
 
970
            dest_path = pathjoin(to_name, name_tail)
773
971
            if self.has_filename(dest_path):
774
972
                raise BzrError("destination %r already exists" % dest_path)
775
973
            if f_id in to_idpath:
782
980
        try:
783
981
            for f in from_paths:
784
982
                name_tail = splitpath(f)[-1]
785
 
                dest_path = appendpath(to_name, name_tail)
 
983
                dest_path = pathjoin(to_name, name_tail)
786
984
                result.append((f, dest_path))
787
985
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
788
986
                try:
852
1050
 
853
1051
        These are files in the working directory that are not versioned or
854
1052
        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
1053
        """
869
1054
        for subp in self.extras():
870
1055
            if not self.is_ignored(subp):
878
1063
 
879
1064
    def _iter_conflicts(self):
880
1065
        conflicted = set()
881
 
        for path in (s[0] for s in self.list_files()):
 
1066
        for info in self.list_files():
 
1067
            path = info[0]
882
1068
            stem = get_conflicted_stem(path)
883
1069
            if stem is None:
884
1070
                continue
906
1092
                repository = self.branch.repository
907
1093
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
908
1094
                try:
 
1095
                    new_basis_tree = self.branch.basis_tree()
909
1096
                    merge_inner(self.branch,
910
 
                                self.branch.basis_tree(),
911
 
                                basis_tree, 
912
 
                                this_tree=self, 
 
1097
                                new_basis_tree,
 
1098
                                basis_tree,
 
1099
                                this_tree=self,
913
1100
                                pb=pb)
914
1101
                finally:
915
1102
                    pb.finished()
916
 
                self.set_last_revision(self.branch.last_revision())
 
1103
                # TODO - dedup parents list with things merged by pull ?
 
1104
                # reuse the revisiontree we merged against to set the new
 
1105
                # tree data.
 
1106
                parent_trees = [(self.branch.last_revision(), new_basis_tree)]
 
1107
                # we have to pull the merge trees out again, because 
 
1108
                # merge_inner has set the ids. - this corner is not yet 
 
1109
                # layered well enough to prevent double handling.
 
1110
                merges = self.get_parent_ids()[1:]
 
1111
                parent_trees.extend([
 
1112
                    (parent, repository.revision_tree(parent)) for
 
1113
                     parent in merges])
 
1114
                self.set_parent_trees(parent_trees)
917
1115
            return count
918
1116
        finally:
919
1117
            source.unlock()
930
1128
        """
931
1129
        ## TODO: Work from given directory downwards
932
1130
        for path, dir_entry in self.inventory.directories():
933
 
            mutter("search for unknowns in %r", path)
 
1131
            # mutter("search for unknowns in %r", path)
934
1132
            dirabs = self.abspath(path)
935
1133
            if not isdir(dirabs):
936
1134
                # e.g. directory deleted
938
1136
 
939
1137
            fl = []
940
1138
            for subf in os.listdir(dirabs):
941
 
                if (subf != '.bzr'
942
 
                    and (subf not in dir_entry.children)):
943
 
                    fl.append(subf)
 
1139
                if subf == '.bzr':
 
1140
                    continue
 
1141
                if subf not in dir_entry.children:
 
1142
                    subf_norm, can_access = osutils.normalized_filename(subf)
 
1143
                    if subf_norm != subf and can_access:
 
1144
                        if subf_norm not in dir_entry.children:
 
1145
                            fl.append(subf_norm)
 
1146
                    else:
 
1147
                        fl.append(subf)
944
1148
            
945
1149
            fl.sort()
946
1150
            for subf in fl:
947
 
                subp = appendpath(path, subf)
 
1151
                subp = pathjoin(path, subf)
948
1152
                yield subp
949
1153
 
 
1154
    def _translate_ignore_rule(self, rule):
 
1155
        """Translate a single ignore rule to a regex.
 
1156
 
 
1157
        There are two types of ignore rules.  Those that do not contain a / are
 
1158
        matched against the tail of the filename (that is, they do not care
 
1159
        what directory the file is in.)  Rules which do contain a slash must
 
1160
        match the entire path.  As a special case, './' at the start of the
 
1161
        string counts as a slash in the string but is removed before matching
 
1162
        (e.g. ./foo.c, ./src/foo.c)
 
1163
 
 
1164
        :return: The translated regex.
 
1165
        """
 
1166
        if rule[:2] in ('./', '.\\'):
 
1167
            # rootdir rule
 
1168
            result = fnmatch.translate(rule[2:])
 
1169
        elif '/' in rule or '\\' in rule:
 
1170
            # path prefix 
 
1171
            result = fnmatch.translate(rule)
 
1172
        else:
 
1173
            # default rule style.
 
1174
            result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
 
1175
        assert result[-1] == '$', "fnmatch.translate did not add the expected $"
 
1176
        return "(" + result + ")"
 
1177
 
 
1178
    def _combine_ignore_rules(self, rules):
 
1179
        """Combine a list of ignore rules into a single regex object.
 
1180
 
 
1181
        Each individual rule is combined with | to form a big regex, which then
 
1182
        has $ added to it to form something like ()|()|()$. The group index for
 
1183
        each subregex's outermost group is placed in a dictionary mapping back 
 
1184
        to the rule. This allows quick identification of the matching rule that
 
1185
        triggered a match.
 
1186
        :return: a list of the compiled regex and the matching-group index 
 
1187
        dictionaries. We return a list because python complains if you try to 
 
1188
        combine more than 100 regexes.
 
1189
        """
 
1190
        result = []
 
1191
        groups = {}
 
1192
        next_group = 0
 
1193
        translated_rules = []
 
1194
        for rule in rules:
 
1195
            translated_rule = self._translate_ignore_rule(rule)
 
1196
            compiled_rule = re.compile(translated_rule)
 
1197
            groups[next_group] = rule
 
1198
            next_group += compiled_rule.groups
 
1199
            translated_rules.append(translated_rule)
 
1200
            if next_group == 99:
 
1201
                result.append((re.compile("|".join(translated_rules)), groups))
 
1202
                groups = {}
 
1203
                next_group = 0
 
1204
                translated_rules = []
 
1205
        if len(translated_rules):
 
1206
            result.append((re.compile("|".join(translated_rules)), groups))
 
1207
        return result
950
1208
 
951
1209
    def ignored_files(self):
952
1210
        """Yield list of PATH, IGNORE_PATTERN"""
955
1213
            if pat != None:
956
1214
                yield subp, pat
957
1215
 
958
 
 
959
1216
    def get_ignore_list(self):
960
1217
        """Return list of ignore patterns.
961
1218
 
962
1219
        Cached in the Tree object after the first call.
963
1220
        """
964
 
        if hasattr(self, '_ignorelist'):
965
 
            return self._ignorelist
966
 
 
967
 
        l = bzrlib.DEFAULT_IGNORE[:]
 
1221
        ignoreset = getattr(self, '_ignoreset', None)
 
1222
        if ignoreset is not None:
 
1223
            return ignoreset
 
1224
 
 
1225
        ignore_globs = set(bzrlib.DEFAULT_IGNORE)
 
1226
        ignore_globs.update(ignores.get_runtime_ignores())
 
1227
 
 
1228
        ignore_globs.update(ignores.get_user_ignores())
 
1229
 
968
1230
        if self.has_filename(bzrlib.IGNORE_FILENAME):
969
1231
            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
 
 
 
1232
            try:
 
1233
                ignore_globs.update(ignores.parse_ignore_file(f))
 
1234
            finally:
 
1235
                f.close()
 
1236
 
 
1237
        self._ignoreset = ignore_globs
 
1238
        self._ignore_regex = self._combine_ignore_rules(ignore_globs)
 
1239
        return ignore_globs
 
1240
 
 
1241
    def _get_ignore_rules_as_regex(self):
 
1242
        """Return a regex of the ignore rules and a mapping dict.
 
1243
 
 
1244
        :return: (ignore rules compiled regex, dictionary mapping rule group 
 
1245
        indices to original rule.)
 
1246
        """
 
1247
        if getattr(self, '_ignoreset', None) is None:
 
1248
            self.get_ignore_list()
 
1249
        return self._ignore_regex
974
1250
 
975
1251
    def is_ignored(self, filename):
976
1252
        r"""Check whether the filename matches an ignore pattern.
990
1266
        # treat dotfiles correctly and allows * to match /.
991
1267
        # Eventually it should be replaced with something more
992
1268
        # 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
 
1269
    
 
1270
        rules = self._get_ignore_rules_as_regex()
 
1271
        for regex, mapping in rules:
 
1272
            match = regex.match(filename)
 
1273
            if match is not None:
 
1274
                # one or more of the groups in mapping will have a non-None
 
1275
                # group match.
 
1276
                groups = match.groups()
 
1277
                rules = [mapping[group] for group in 
 
1278
                    mapping if groups[group] is not None]
 
1279
                return rules[0]
 
1280
        return None
1012
1281
 
1013
1282
    def kind(self, file_id):
1014
1283
        return file_kind(self.id2abspath(file_id))
1023
1292
        """
1024
1293
        return self.branch.last_revision()
1025
1294
 
 
1295
    def is_locked(self):
 
1296
        return self._control_files.is_locked()
 
1297
 
1026
1298
    def lock_read(self):
1027
1299
        """See Branch.lock_read, and WorkingTree.unlock."""
1028
1300
        self.branch.lock_read()
1041
1313
            self.branch.unlock()
1042
1314
            raise
1043
1315
 
 
1316
    def get_physical_lock_status(self):
 
1317
        return self._control_files.get_physical_lock_status()
 
1318
 
1044
1319
    def _basis_inventory_name(self):
1045
1320
        return 'basis-inventory'
1046
1321
 
1059
1334
        if new_revision is None:
1060
1335
            self.branch.set_revision_history([])
1061
1336
            return False
1062
 
        # current format is locked in with the branch
1063
 
        revision_history = self.branch.revision_history()
1064
1337
        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])
 
1338
            self.branch.generate_revision_history(new_revision)
 
1339
        except errors.NoSuchRevision:
 
1340
            # not present in the repo - dont try to set it deeper than the tip
 
1341
            self.branch.set_revision_history([new_revision])
1069
1342
        return True
1070
1343
 
1071
1344
    def _cache_basis_inventory(self, new_revision):
1072
1345
        """Cache new_revision as the basis inventory."""
 
1346
        # TODO: this should allow the ready-to-use inventory to be passed in,
 
1347
        # as commit already has that ready-to-use [while the format is the
 
1348
        # same, that is].
1073
1349
        try:
1074
1350
            # this double handles the inventory - unpack and repack - 
1075
1351
            # but is easier to understand. We can/should put a conditional
1076
1352
            # in here based on whether the inventory is in the latest format
1077
1353
            # - perhaps we should repack all inventories on a repository
1078
1354
            # 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
 
 
 
1355
            # the fast path is to copy the raw xml from the repository. If the
 
1356
            # xml contains 'revision_id="', then we assume the right 
 
1357
            # revision_id is set. We must check for this full string, because a
 
1358
            # root node id can legitimately look like 'revision_id' but cannot
 
1359
            # contain a '"'.
 
1360
            xml = self.branch.repository.get_inventory_xml(new_revision)
 
1361
            if not 'revision_id="' in xml.split('\n', 1)[0]:
 
1362
                inv = self.branch.repository.deserialise_inventory(
 
1363
                    new_revision, xml)
 
1364
                inv.revision_id = new_revision
 
1365
                xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
 
1366
            assert isinstance(xml, str), 'serialised xml must be bytestring.'
1083
1367
            path = self._basis_inventory_name()
1084
 
            self._control_files.put_utf8(path, xml)
1085
 
        except WeaveRevisionNotPresent:
 
1368
            sio = StringIO(xml)
 
1369
            self._control_files.put(path, sio)
 
1370
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1086
1371
            pass
1087
1372
 
1088
1373
    def read_basis_inventory(self):
1089
1374
        """Read the cached basis inventory."""
1090
1375
        path = self._basis_inventory_name()
1091
 
        return self._control_files.get_utf8(path).read()
 
1376
        return self._control_files.get(path).read()
1092
1377
        
1093
1378
    @needs_read_lock
1094
1379
    def read_working_inventory(self):
1101
1386
        return result
1102
1387
 
1103
1388
    @needs_write_lock
1104
 
    def remove(self, files, verbose=False):
 
1389
    def remove(self, files, verbose=False, to_file=None):
1105
1390
        """Remove nominated files from the working inventory..
1106
1391
 
1107
1392
        This does not remove their text.  This does not run on XXX on what? RBC
1129
1414
                # TODO: Perhaps make this just a warning, and continue?
1130
1415
                # This tends to happen when 
1131
1416
                raise NotVersionedError(path=f)
1132
 
            mutter("remove inventory entry %s {%s}", quotefn(f), fid)
1133
1417
            if verbose:
1134
1418
                # having remove it, it must be either ignored or unknown
1135
1419
                if self.is_ignored(f):
1136
1420
                    new_status = 'I'
1137
1421
                else:
1138
1422
                    new_status = '?'
1139
 
                show_status(new_status, inv[fid].kind, quotefn(f))
 
1423
                show_status(new_status, inv[fid].kind, f, to_file=to_file)
1140
1424
            del inv[fid]
1141
1425
 
1142
1426
        self._write_inventory(inv)
1204
1488
        between multiple working trees, i.e. via shared storage, then we 
1205
1489
        would probably want to lock both the local tree, and the branch.
1206
1490
        """
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
 
1491
        raise NotImplementedError(self.unlock)
1229
1492
 
1230
1493
    @needs_write_lock
1231
1494
    def update(self):
1248
1511
        Do a 'normal' merge of the old branch basis if it is relevant.
1249
1512
        """
1250
1513
        old_tip = self.branch.update()
1251
 
        if old_tip is not None:
1252
 
            self.add_pending_merge(old_tip)
1253
 
        self.branch.lock_read()
1254
 
        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()
 
1514
        # here if old_tip is not None, it is the old tip of the branch before
 
1515
        # it was updated from the master branch. This should become a pending
 
1516
        # merge in the working tree to preserve the user existing work.  we
 
1517
        # cant set that until we update the working trees last revision to be
 
1518
        # one from the new branch, because it will just get absorbed by the
 
1519
        # parent de-duplication logic.
 
1520
        # 
 
1521
        # We MUST save it even if an error occurs, because otherwise the users
 
1522
        # local work is unreferenced and will appear to have been lost.
 
1523
        # 
 
1524
        result = 0
 
1525
        if self.last_revision() != self.branch.last_revision():
 
1526
            # merge tree state up to new branch tip.
 
1527
            basis = self.basis_tree()
 
1528
            to_tree = self.branch.basis_tree()
 
1529
            result += merge_inner(self.branch,
 
1530
                                  to_tree,
 
1531
                                  basis,
 
1532
                                  this_tree=self)
 
1533
            # TODO - dedup parents list with things merged by pull ?
 
1534
            # reuse the tree we've updated to to set the basis:
 
1535
            parent_trees = [(self.branch.last_revision(), to_tree)]
 
1536
            merges = self.get_parent_ids()[1:]
 
1537
            # Ideally we ask the tree for the trees here, that way the working
 
1538
            # tree can decide whether to give us teh entire tree or give us a
 
1539
            # lazy initialised tree. dirstate for instance will have the trees
 
1540
            # in ram already, whereas a last-revision + basis-inventory tree
 
1541
            # will not, but also does not need them when setting parents.
 
1542
            for parent in merges:
 
1543
                parent_trees.append(
 
1544
                    (parent, self.branch.repository.revision_tree(parent)))
 
1545
            if old_tip is not None:
 
1546
                parent_trees.append(
 
1547
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
 
1548
            self.set_parent_trees(parent_trees)
 
1549
        else:
 
1550
            # the working tree had the same last-revision as the master
 
1551
            # branch did. We may still have pivot local work from the local
 
1552
            # branch into old_tip:
 
1553
            if old_tip is not None:
 
1554
                self.add_pending_merge(old_tip)
 
1555
        if old_tip and old_tip != self.last_revision():
 
1556
            # our last revision was not the prior branch last revision
 
1557
            # and we have converted that last revision to a pending merge.
 
1558
            # base is somewhere between the branch tip now
 
1559
            # and the now pending merge
 
1560
            from bzrlib.revision import common_ancestor
 
1561
            try:
 
1562
                base_rev_id = common_ancestor(self.branch.last_revision(),
 
1563
                                              old_tip,
 
1564
                                              self.branch.repository)
 
1565
            except errors.NoCommonAncestor:
 
1566
                base_rev_id = None
 
1567
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
1568
            other_tree = self.branch.repository.revision_tree(old_tip)
 
1569
            result += merge_inner(self.branch,
 
1570
                                  other_tree,
 
1571
                                  base_tree,
 
1572
                                  this_tree=self)
 
1573
        return result
1286
1574
 
1287
1575
    @needs_write_lock
1288
1576
    def _write_inventory(self, inv):
1297
1585
    def set_conflicts(self, arg):
1298
1586
        raise UnsupportedOperation(self.set_conflicts, self)
1299
1587
 
 
1588
    def add_conflicts(self, arg):
 
1589
        raise UnsupportedOperation(self.add_conflicts, self)
 
1590
 
1300
1591
    @needs_read_lock
1301
1592
    def conflicts(self):
1302
1593
        conflicts = ConflictList()
1305
1596
            try:
1306
1597
                if file_kind(self.abspath(conflicted)) != "file":
1307
1598
                    text = False
1308
 
            except OSError, e:
1309
 
                if e.errno == errno.ENOENT:
1310
 
                    text = False
1311
 
                else:
1312
 
                    raise
 
1599
            except errors.NoSuchFile:
 
1600
                text = False
1313
1601
            if text is True:
1314
1602
                for suffix in ('.THIS', '.OTHER'):
1315
1603
                    try:
1316
1604
                        kind = file_kind(self.abspath(conflicted+suffix))
1317
 
                    except OSError, e:
1318
 
                        if e.errno == errno.ENOENT:
 
1605
                        if kind != "file":
1319
1606
                            text = False
1320
 
                            break
1321
 
                        else:
1322
 
                            raise
1323
 
                    if kind != "file":
 
1607
                    except errors.NoSuchFile:
1324
1608
                        text = False
 
1609
                    if text == False:
1325
1610
                        break
1326
1611
            ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1327
1612
            conflicts.append(Conflict.factory(ctype, path=conflicted,
1329
1614
        return conflicts
1330
1615
 
1331
1616
 
 
1617
class WorkingTree2(WorkingTree):
 
1618
    """This is the Format 2 working tree.
 
1619
 
 
1620
    This was the first weave based working tree. 
 
1621
     - uses os locks for locking.
 
1622
     - uses the branch last-revision.
 
1623
    """
 
1624
 
 
1625
    def unlock(self):
 
1626
        # we share control files:
 
1627
        if self._hashcache.needs_write and self._control_files._lock_count==3:
 
1628
            self._hashcache.write()
 
1629
        # reverse order of locking.
 
1630
        try:
 
1631
            return self._control_files.unlock()
 
1632
        finally:
 
1633
            self.branch.unlock()
 
1634
 
 
1635
 
1332
1636
class WorkingTree3(WorkingTree):
1333
1637
    """This is the Format 3 working tree.
1334
1638
 
1356
1660
                pass
1357
1661
            return False
1358
1662
        else:
1359
 
            try:
1360
 
                self.branch.revision_history().index(revision_id)
1361
 
            except ValueError:
1362
 
                raise errors.NoSuchRevision(self.branch, revision_id)
1363
1663
            self._control_files.put_utf8('last-revision', revision_id)
1364
1664
            return True
1365
1665
 
1368
1668
        self._put_rio('conflicts', conflicts.to_stanzas(), 
1369
1669
                      CONFLICT_HEADER_1)
1370
1670
 
 
1671
    @needs_write_lock
 
1672
    def add_conflicts(self, new_conflicts):
 
1673
        conflict_set = set(self.conflicts())
 
1674
        conflict_set.update(set(list(new_conflicts)))
 
1675
        self.set_conflicts(ConflictList(sorted(conflict_set,
 
1676
                                               key=Conflict.sort_key)))
 
1677
 
1371
1678
    @needs_read_lock
1372
1679
    def conflicts(self):
1373
1680
        try:
1381
1688
            raise ConflictFormatError()
1382
1689
        return ConflictList.from_stanzas(RioReader(confile))
1383
1690
 
 
1691
    def unlock(self):
 
1692
        if self._hashcache.needs_write and self._control_files._lock_count==1:
 
1693
            self._hashcache.write()
 
1694
        # reverse order of locking.
 
1695
        try:
 
1696
            return self._control_files.unlock()
 
1697
        finally:
 
1698
            self.branch.unlock()
 
1699
 
1384
1700
 
1385
1701
def get_conflicted_stem(path):
1386
1702
    for suffix in CONFLICT_SUFFIXES:
1437
1753
        except NoSuchFile:
1438
1754
            raise errors.NoWorkingTree(base=transport.base)
1439
1755
        except KeyError:
1440
 
            raise errors.UnknownFormatError(format_string)
 
1756
            raise errors.UnknownFormatError(format=format_string)
1441
1757
 
1442
1758
    @classmethod
1443
1759
    def get_default_format(klass):
1486
1802
        """See WorkingTreeFormat.get_format_description()."""
1487
1803
        return "Working tree format 2"
1488
1804
 
 
1805
    def stub_initialize_remote(self, control_files):
 
1806
        """As a special workaround create critical control files for a remote working tree
 
1807
        
 
1808
        This ensures that it can later be updated and dealt with locally,
 
1809
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with 
 
1810
        no working tree.  (See bug #43064).
 
1811
        """
 
1812
        sio = StringIO()
 
1813
        inv = Inventory()
 
1814
        bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
 
1815
        sio.seek(0)
 
1816
        control_files.put('inventory', sio)
 
1817
 
 
1818
        control_files.put_utf8('pending-merges', '')
 
1819
        
 
1820
 
1489
1821
    def initialize(self, a_bzrdir, revision_id=None):
1490
1822
        """See WorkingTreeFormat.initialize()."""
1491
1823
        if not isinstance(a_bzrdir.transport, LocalTransport):
1503
1835
            finally:
1504
1836
                branch.unlock()
1505
1837
        revision = branch.last_revision()
1506
 
        inv = Inventory() 
1507
 
        wt = WorkingTree(a_bzrdir.root_transport.base,
 
1838
        inv = Inventory()
 
1839
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1508
1840
                         branch,
1509
1841
                         inv,
1510
1842
                         _internal=True,
1512
1844
                         _bzrdir=a_bzrdir)
1513
1845
        wt._write_inventory(inv)
1514
1846
        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)
 
1847
        basis_tree = branch.repository.revision_tree(revision)
 
1848
        wt.set_parent_trees([(revision, basis_tree)])
 
1849
        build_tree(basis_tree, wt)
1518
1850
        return wt
1519
1851
 
1520
1852
    def __init__(self):
1532
1864
            raise NotImplementedError
1533
1865
        if not isinstance(a_bzrdir.transport, LocalTransport):
1534
1866
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
1535
 
        return WorkingTree(a_bzrdir.root_transport.base,
 
1867
        return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1536
1868
                           _internal=True,
1537
1869
                           _format=self,
1538
1870
                           _bzrdir=a_bzrdir)
1547
1879
          files, separate from the BzrDir format
1548
1880
        - modifies the hash cache format
1549
1881
        - is new in bzr 0.8
1550
 
        - uses a LockDir to guard access to the repository
 
1882
        - uses a LockDir to guard access for writes.
1551
1883
    """
1552
1884
 
1553
1885
    def get_format_string(self):
1569
1901
    def initialize(self, a_bzrdir, revision_id=None):
1570
1902
        """See WorkingTreeFormat.initialize().
1571
1903
        
1572
 
        revision_id allows creating a working tree at a differnet
 
1904
        revision_id allows creating a working tree at a different
1573
1905
        revision than the branch is at.
1574
1906
        """
1575
1907
        if not isinstance(a_bzrdir.transport, LocalTransport):
1577
1909
        transport = a_bzrdir.get_workingtree_transport(self)
1578
1910
        control_files = self._open_control_files(a_bzrdir)
1579
1911
        control_files.create_lock()
 
1912
        control_files.lock_write()
1580
1913
        control_files.put_utf8('format', self.get_format_string())
1581
1914
        branch = a_bzrdir.open_branch()
1582
1915
        if revision_id is None:
1583
1916
            revision_id = branch.last_revision()
1584
1917
        inv = Inventory() 
1585
 
        wt = WorkingTree3(a_bzrdir.root_transport.base,
 
1918
        wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1586
1919
                         branch,
1587
1920
                         inv,
1588
1921
                         _internal=True,
1589
1922
                         _format=self,
1590
1923
                         _bzrdir=a_bzrdir,
1591
1924
                         _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)
 
1925
        wt.lock_write()
 
1926
        try:
 
1927
            wt._write_inventory(inv)
 
1928
            wt.set_root_id(inv.root.file_id)
 
1929
            basis_tree = branch.repository.revision_tree(revision_id)
 
1930
            wt.set_parent_trees([(revision_id, basis_tree)])
 
1931
            build_tree(basis_tree, wt)
 
1932
        finally:
 
1933
            wt.unlock()
 
1934
            control_files.unlock()
1597
1935
        return wt
1598
1936
 
1599
1937
    def __init__(self):
1611
1949
            raise NotImplementedError
1612
1950
        if not isinstance(a_bzrdir.transport, LocalTransport):
1613
1951
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
1614
 
        control_files = self._open_control_files(a_bzrdir)
1615
 
        return WorkingTree3(a_bzrdir.root_transport.base,
 
1952
        return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
 
1953
 
 
1954
    def _open(self, a_bzrdir, control_files):
 
1955
        """Open the tree itself.
 
1956
        
 
1957
        :param a_bzrdir: the dir for the tree.
 
1958
        :param control_files: the control files for the tree.
 
1959
        """
 
1960
        return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1616
1961
                           _internal=True,
1617
1962
                           _format=self,
1618
1963
                           _bzrdir=a_bzrdir,
1645
1990
        self._transport_readonly_server = transport_readonly_server
1646
1991
        self._formats = formats
1647
1992
    
 
1993
    def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
 
1994
        """Clone test for adaption."""
 
1995
        new_test = deepcopy(test)
 
1996
        new_test.transport_server = self._transport_server
 
1997
        new_test.transport_readonly_server = self._transport_readonly_server
 
1998
        new_test.bzrdir_format = bzrdir_format
 
1999
        new_test.workingtree_format = workingtree_format
 
2000
        def make_new_test_id():
 
2001
            new_id = "%s(%s)" % (test.id(), variation)
 
2002
            return lambda: new_id
 
2003
        new_test.id = make_new_test_id()
 
2004
        return new_test
 
2005
    
1648
2006
    def adapt(self, test):
1649
2007
        from bzrlib.tests import TestSuite
1650
2008
        result = TestSuite()
1651
2009
        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()
 
2010
            new_test = self._clone_test(
 
2011
                test,
 
2012
                bzrdir_format,
 
2013
                workingtree_format, workingtree_format.__class__.__name__)
1661
2014
            result.addTest(new_test)
1662
2015
        return result