/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-11-16 18:33:33 UTC
  • mfrom: (2138.1.1 robuster.external.diff)
  • Revision ID: pqm@pqm.ubuntu.com-20061116183333-5f56523d7b44e564
(Dmitry Vasiliev) Robuster external diff output handling.

Show diffs side-by-side

added added

removed removed

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