~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-08-17 07:52:09 UTC
  • mfrom: (1910.3.4 trivial)
  • Revision ID: pqm@pqm.ubuntu.com-20060817075209-e85a1f9e05ff8b87
(andrew) Trivial fixes to NotImplemented errors.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
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
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
 
32
35
# TODO: Give the workingtree sole responsibility for the working inventory;
33
36
# remove the variable and references to it from the branch.  This may require
34
37
# updating the commit code so as to update the inventory within the working
36
39
# At the moment they may alias the inventory and have old copies of it in
37
40
# memory.  (Now done? -- mbp 20060309)
38
41
 
 
42
from binascii import hexlify
 
43
import collections
 
44
from copy import deepcopy
39
45
from cStringIO import StringIO
 
46
import errno
 
47
import fnmatch
40
48
import os
41
 
import sys
42
 
 
43
 
from bzrlib.lazy_import import lazy_import
44
 
lazy_import(globals(), """
45
 
from bisect import bisect_left
46
 
import collections
47
 
import errno
48
 
import itertools
49
 
import operator
 
49
import re
50
50
import stat
51
51
from time import time
52
52
import warnings
53
 
import re
54
53
 
55
54
import bzrlib
56
 
from bzrlib import (
57
 
    branch,
58
 
    bzrdir,
59
 
    conflicts as _mod_conflicts,
60
 
    dirstate,
61
 
    errors,
62
 
    generate_ids,
63
 
    globbing,
64
 
    hashcache,
65
 
    ignores,
66
 
    merge,
67
 
    osutils,
68
 
    revision as _mod_revision,
69
 
    revisiontree,
70
 
    repository,
71
 
    textui,
72
 
    trace,
73
 
    transform,
74
 
    ui,
75
 
    urlutils,
76
 
    xml5,
77
 
    xml6,
78
 
    xml7,
79
 
    )
 
55
from bzrlib import bzrdir, errors, ignores, osutils, urlutils
 
56
from bzrlib.atomicfile import AtomicFile
80
57
import bzrlib.branch
81
 
from bzrlib.transport import get_transport
82
 
import bzrlib.ui
83
 
from bzrlib.workingtree_4 import WorkingTreeFormat4
84
 
""")
85
 
 
86
 
from bzrlib import symbol_versioning
 
58
from bzrlib.conflicts import Conflict, ConflictList, CONFLICT_SUFFIXES
87
59
from bzrlib.decorators import needs_read_lock, needs_write_lock
88
 
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
 
60
from bzrlib.errors import (BzrCheckError,
 
61
                           BzrError,
 
62
                           ConflictFormatError,
 
63
                           WeaveRevisionNotPresent,
 
64
                           NotBranchError,
 
65
                           NoSuchFile,
 
66
                           NotVersionedError,
 
67
                           MergeModifiedFormatError,
 
68
                           UnsupportedOperation,
 
69
                           )
 
70
from bzrlib.inventory import InventoryEntry, Inventory
89
71
from bzrlib.lockable_files import LockableFiles, TransportLock
90
72
from bzrlib.lockdir import LockDir
91
 
import bzrlib.mutabletree
92
 
from bzrlib.mutabletree import needs_tree_write_lock
 
73
from bzrlib.merge import merge_inner, transform_tree
93
74
from bzrlib.osutils import (
94
 
    compact_date,
95
 
    file_kind,
96
 
    isdir,
97
 
    normpath,
98
 
    pathjoin,
99
 
    rand_chars,
100
 
    realpath,
101
 
    safe_unicode,
102
 
    splitpath,
103
 
    supports_executable,
104
 
    )
105
 
from bzrlib.trace import mutter, note
106
 
from bzrlib.transport.local import LocalTransport
 
75
                            abspath,
 
76
                            compact_date,
 
77
                            file_kind,
 
78
                            isdir,
 
79
                            getcwd,
 
80
                            pathjoin,
 
81
                            pumpfile,
 
82
                            safe_unicode,
 
83
                            splitpath,
 
84
                            rand_chars,
 
85
                            normpath,
 
86
                            realpath,
 
87
                            relpath,
 
88
                            rename,
 
89
                            supports_executable,
 
90
                            )
107
91
from bzrlib.progress import DummyProgress, ProgressPhase
108
 
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
 
92
from bzrlib.revision import NULL_REVISION
109
93
from bzrlib.rio import RioReader, rio_file, Stanza
110
94
from bzrlib.symbol_versioning import (deprecated_passed,
111
95
        deprecated_method,
112
96
        deprecated_function,
113
97
        DEPRECATED_PARAMETER,
114
98
        zero_eight,
115
 
        zero_eleven,
116
 
        zero_thirteen,
117
99
        )
118
 
 
119
 
 
120
 
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
121
 
CONFLICT_HEADER_1 = "BZR conflict list format 1"
122
 
 
123
 
ERROR_PATH_NOT_FOUND = 3    # WindowsError errno code, equivalent to ENOENT
124
 
 
125
 
 
126
 
@deprecated_function(zero_thirteen)
 
100
from bzrlib.trace import mutter, note
 
101
from bzrlib.transform import build_tree
 
102
from bzrlib.transport import get_transport
 
103
from bzrlib.transport.local import LocalTransport
 
104
from bzrlib.textui import show_status
 
105
import bzrlib.tree
 
106
import bzrlib.ui
 
107
import bzrlib.xml5
 
108
 
 
109
 
 
110
# the regex removes any weird characters; we don't escape them 
 
111
# but rather just pull them out
 
112
_gen_file_id_re = re.compile(r'[^\w.]')
 
113
_gen_id_suffix = None
 
114
_gen_id_serial = 0
 
115
 
 
116
 
 
117
def _next_id_suffix():
 
118
    """Create a new file id suffix that is reasonably unique.
 
119
    
 
120
    On the first call we combine the current time with 64 bits of randomness
 
121
    to give a highly probably globally unique number. Then each call in the same
 
122
    process adds 1 to a serial number we append to that unique value.
 
123
    """
 
124
    # XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather 
 
125
    # than having to move the id randomness out of the inner loop like this.
 
126
    # XXX TODO: for the global randomness this uses we should add the thread-id
 
127
    # before the serial #.
 
128
    global _gen_id_suffix, _gen_id_serial
 
129
    if _gen_id_suffix is None:
 
130
        _gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
 
131
    _gen_id_serial += 1
 
132
    return _gen_id_suffix + str(_gen_id_serial)
 
133
 
 
134
 
127
135
def gen_file_id(name):
128
136
    """Return new file id for the basename 'name'.
129
137
 
130
 
    Use bzrlib.generate_ids.gen_file_id() instead
 
138
    The uniqueness is supplied from _next_id_suffix.
131
139
    """
132
 
    return generate_ids.gen_file_id(name)
133
 
 
134
 
 
135
 
@deprecated_function(zero_thirteen)
 
140
    # The real randomness is in the _next_id_suffix, the
 
141
    # rest of the identifier is just to be nice.
 
142
    # So we:
 
143
    # 1) Remove non-ascii word characters to keep the ids portable
 
144
    # 2) squash to lowercase, so the file id doesn't have to
 
145
    #    be escaped (case insensitive filesystems would bork for ids
 
146
    #    that only differred in case without escaping).
 
147
    # 3) truncate the filename to 20 chars. Long filenames also bork on some
 
148
    #    filesystems
 
149
    # 4) Removing starting '.' characters to prevent the file ids from
 
150
    #    being considered hidden.
 
151
    ascii_word_only = _gen_file_id_re.sub('', name.lower())
 
152
    short_no_dots = ascii_word_only.lstrip('.')[:20]
 
153
    return short_no_dots + _next_id_suffix()
 
154
 
 
155
 
136
156
def gen_root_id():
137
 
    """Return a new tree-root file id.
138
 
 
139
 
    This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
140
 
    """
141
 
    return generate_ids.gen_root_id()
 
157
    """Return a new tree-root file id."""
 
158
    return gen_file_id('TREE_ROOT')
142
159
 
143
160
 
144
161
class TreeEntry(object):
196
213
        return ''
197
214
 
198
215
 
199
 
class WorkingTree(bzrlib.mutabletree.MutableTree):
 
216
class WorkingTree(bzrlib.tree.Tree):
200
217
    """Working copy tree.
201
218
 
202
219
    The inventory is held in the `Branch` working-inventory, and the
213
230
                 _internal=False,
214
231
                 _format=None,
215
232
                 _bzrdir=None):
216
 
        """Construct a WorkingTree instance. This is not a public API.
 
233
        """Construct a WorkingTree for basedir.
217
234
 
218
 
        :param branch: A branch to override probing for the branch.
 
235
        If the branch is not supplied, it is opened automatically.
 
236
        If the branch is supplied, it must be the branch for this basedir.
 
237
        (branch.base is not cross checked, because for remote branches that
 
238
        would be meaningless).
219
239
        """
220
240
        self._format = _format
221
241
        self.bzrdir = _bzrdir
222
242
        if not _internal:
223
 
            raise errors.BzrError("Please use bzrdir.open_workingtree or "
224
 
                "WorkingTree.open() to obtain a WorkingTree.")
 
243
            # not created via open etc.
 
244
            warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
 
245
                 "Please use bzrdir.open_workingtree or WorkingTree.open().",
 
246
                 DeprecationWarning,
 
247
                 stacklevel=2)
 
248
            wt = WorkingTree.open(basedir)
 
249
            self._branch = wt.branch
 
250
            self.basedir = wt.basedir
 
251
            self._control_files = wt._control_files
 
252
            self._hashcache = wt._hashcache
 
253
            self._set_inventory(wt._inventory)
 
254
            self._format = wt._format
 
255
            self.bzrdir = wt.bzrdir
 
256
        from bzrlib.hashcache import HashCache
 
257
        from bzrlib.trace import note, mutter
225
258
        assert isinstance(basedir, basestring), \
226
259
            "base directory %r is not a string" % basedir
227
260
        basedir = safe_unicode(basedir)
228
261
        mutter("opening working tree %r", basedir)
229
262
        if deprecated_passed(branch):
 
263
            if not _internal:
 
264
                warnings.warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
 
265
                     " Please use bzrdir.open_workingtree() or"
 
266
                     " WorkingTree.open().",
 
267
                     DeprecationWarning,
 
268
                     stacklevel=2
 
269
                     )
230
270
            self._branch = branch
231
271
        else:
232
272
            self._branch = self.bzrdir.open_branch()
247
287
        # if needed, or, when the cache sees a change, append it to the hash
248
288
        # cache file, and have the parser take the most recent entry for a
249
289
        # given path only.
250
 
        wt_trans = self.bzrdir.get_workingtree_transport(None)
251
 
        cache_filename = wt_trans.local_abspath('stat-cache')
252
 
        self._hashcache = hashcache.HashCache(basedir, cache_filename,
253
 
                                              self._control_files._file_mode)
254
 
        hc = self._hashcache
 
290
        cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
 
291
        hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
255
292
        hc.read()
256
293
        # is this scan needed ? it makes things kinda slow.
257
294
        #hc.scan()
261
298
            hc.write()
262
299
 
263
300
        if _inventory is None:
264
 
            # This will be acquired on lock_read() or lock_write()
265
 
            self._inventory_is_modified = False
266
 
            self._inventory = None
 
301
            self._set_inventory(self.read_working_inventory())
267
302
        else:
268
 
            # the caller of __init__ has provided an inventory,
269
 
            # we assume they know what they are doing - as its only
270
 
            # the Format factory and creation methods that are
271
 
            # permitted to do this.
272
 
            self._set_inventory(_inventory, dirty=False)
 
303
            self._set_inventory(_inventory)
273
304
 
274
305
    branch = property(
275
306
        fget=lambda self: self._branch,
290
321
        self._control_files.break_lock()
291
322
        self.branch.break_lock()
292
323
 
293
 
    def requires_rich_root(self):
294
 
        return self._format.requires_rich_root
295
 
 
296
 
    def supports_tree_reference(self):
297
 
        return False
298
 
 
299
 
    def _set_inventory(self, inv, dirty):
300
 
        """Set the internal cached inventory.
301
 
 
302
 
        :param inv: The inventory to set.
303
 
        :param dirty: A boolean indicating whether the inventory is the same
304
 
            logical inventory as whats on disk. If True the inventory is not
305
 
            the same and should be written to disk or data will be lost, if
306
 
            False then the inventory is the same as that on disk and any
307
 
            serialisation would be unneeded overhead.
308
 
        """
 
324
    def _set_inventory(self, inv):
309
325
        assert inv.root is not None
310
326
        self._inventory = inv
311
 
        self._inventory_is_modified = dirty
 
327
        self.path2id = self._inventory.path2id
 
328
 
 
329
    def is_control_filename(self, filename):
 
330
        """True if filename is the name of a control file in this tree.
 
331
        
 
332
        :param filename: A filename within the tree. This is a relative path
 
333
        from the root of this tree.
 
334
 
 
335
        This is true IF and ONLY IF the filename is part of the meta data
 
336
        that bzr controls in this tree. I.E. a random .bzr directory placed
 
337
        on disk will not be a control file for this tree.
 
338
        """
 
339
        return self.bzrdir.is_control_filename(filename)
312
340
 
313
341
    @staticmethod
314
342
    def open(path=None, _unsupported=False):
347
375
        """
348
376
        return WorkingTree.open(path, _unsupported=True)
349
377
 
350
 
    # should be deprecated - this is slow and in any case treating them as a
351
 
    # container is (we now know) bad style -- mbp 20070302
352
 
    ## @deprecated_method(zero_fifteen)
353
378
    def __iter__(self):
354
379
        """Iterate through file_ids for this tree.
355
380
 
367
392
 
368
393
    def abspath(self, filename):
369
394
        return pathjoin(self.basedir, filename)
370
 
 
 
395
    
371
396
    def basis_tree(self):
372
 
        """Return RevisionTree for the current last revision.
373
 
        
374
 
        If the left most parent is a ghost then the returned tree will be an
375
 
        empty tree - one obtained by calling repository.revision_tree(None).
376
 
        """
377
 
        try:
378
 
            revision_id = self.get_parent_ids()[0]
379
 
        except IndexError:
380
 
            # no parents, return an empty revision tree.
381
 
            # in the future this should return the tree for
382
 
            # 'empty:' - the implicit root empty tree.
383
 
            return self.branch.repository.revision_tree(None)
384
 
        try:
385
 
            return self.revision_tree(revision_id)
386
 
        except errors.NoSuchRevision:
387
 
            pass
388
 
        # No cached copy available, retrieve from the repository.
389
 
        # FIXME? RBC 20060403 should we cache the inventory locally
390
 
        # at this point ?
391
 
        try:
392
 
            return self.branch.repository.revision_tree(revision_id)
393
 
        except errors.RevisionNotPresent:
394
 
            # the basis tree *may* be a ghost or a low level error may have
395
 
            # occured. If the revision is present, its a problem, if its not
396
 
            # its a ghost.
397
 
            if self.branch.repository.has_revision(revision_id):
398
 
                raise
399
 
            # the basis tree is a ghost so return an empty tree.
400
 
            return self.branch.repository.revision_tree(None)
401
 
 
402
 
    def _cleanup(self):
403
 
        self._flush_ignore_list_cache()
 
397
        """Return RevisionTree for the current last revision."""
 
398
        revision_id = self.last_revision()
 
399
        if revision_id is not None:
 
400
            try:
 
401
                xml = self.read_basis_inventory()
 
402
                inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
 
403
                inv.root.revision = revision_id
 
404
            except NoSuchFile:
 
405
                inv = None
 
406
            if inv is not None and inv.revision_id == revision_id:
 
407
                return bzrlib.tree.RevisionTree(self.branch.repository, inv,
 
408
                                                revision_id)
 
409
        # FIXME? RBC 20060403 should we cache the inventory here ?
 
410
        return self.branch.repository.revision_tree(revision_id)
404
411
 
405
412
    @staticmethod
406
413
    @deprecated_method(zero_eight)
446
453
        The path may be absolute or relative. If its a relative path it is 
447
454
        interpreted relative to the python current working directory.
448
455
        """
449
 
        return osutils.relpath(self.basedir, path)
 
456
        return relpath(self.basedir, path)
450
457
 
451
458
    def has_filename(self, filename):
452
459
        return osutils.lexists(self.abspath(filename))
453
460
 
454
 
    def get_file(self, file_id, path=None):
455
 
        if path is None:
456
 
            path = self.id2path(file_id)
457
 
        return self.get_file_byname(path)
 
461
    def get_file(self, file_id):
 
462
        return self.get_file_byname(self.id2path(file_id))
458
463
 
459
464
    def get_file_text(self, file_id):
460
465
        return self.get_file(file_id).read()
462
467
    def get_file_byname(self, filename):
463
468
        return file(self.abspath(filename), 'rb')
464
469
 
465
 
    @needs_read_lock
466
 
    def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
467
 
        """See Tree.annotate_iter
468
 
 
469
 
        This implementation will use the basis tree implementation if possible.
470
 
        Lines not in the basis are attributed to CURRENT_REVISION
471
 
 
472
 
        If there are pending merges, lines added by those merges will be
473
 
        incorrectly attributed to CURRENT_REVISION (but after committing, the
474
 
        attribution will be correct).
475
 
        """
476
 
        basis = self.basis_tree()
477
 
        basis.lock_read()
478
 
        try:
479
 
            changes = self._iter_changes(basis, True, [self.id2path(file_id)],
480
 
                require_versioned=True).next()
481
 
            changed_content, kind = changes[2], changes[6]
482
 
            if not changed_content:
483
 
                return basis.annotate_iter(file_id)
484
 
            if kind[1] is None:
485
 
                return None
486
 
            import annotate
487
 
            if kind[0] != 'file':
488
 
                old_lines = []
489
 
            else:
490
 
                old_lines = list(basis.annotate_iter(file_id))
491
 
            old = [old_lines]
492
 
            for tree in self.branch.repository.revision_trees(
493
 
                self.get_parent_ids()[1:]):
494
 
                if file_id not in tree:
495
 
                    continue
496
 
                old.append(list(tree.annotate_iter(file_id)))
497
 
            return annotate.reannotate(old, self.get_file(file_id).readlines(),
498
 
                                       default_revision)
499
 
        finally:
500
 
            basis.unlock()
501
 
 
502
 
    def _get_ancestors(self, default_revision):
503
 
        ancestors = set([default_revision])
504
 
        for parent_id in self.get_parent_ids():
505
 
            ancestors.update(self.branch.repository.get_ancestry(
506
 
                             parent_id, topo_sorted=False))
507
 
        return ancestors
508
 
 
509
470
    def get_parent_ids(self):
510
471
        """See Tree.get_parent_ids.
511
472
        
512
473
        This implementation reads the pending merges list and last_revision
513
474
        value and uses that to decide what the parents list should be.
514
475
        """
515
 
        last_rev = _mod_revision.ensure_null(self._last_revision())
516
 
        if _mod_revision.NULL_REVISION == last_rev:
 
476
        last_rev = self.last_revision()
 
477
        if last_rev is None:
517
478
            parents = []
518
479
        else:
519
480
            parents = [last_rev]
520
 
        try:
521
 
            merges_file = self._control_files.get('pending-merges')
522
 
        except errors.NoSuchFile:
523
 
            pass
524
 
        else:
525
 
            for l in merges_file.readlines():
526
 
                revision_id = l.rstrip('\n')
527
 
                parents.append(revision_id)
528
 
        return parents
 
481
        other_parents = self.pending_merges()
 
482
        return parents + other_parents
529
483
 
530
 
    @needs_read_lock
531
484
    def get_root_id(self):
532
485
        """Return the id of this trees root"""
533
 
        return self._inventory.root.file_id
 
486
        inv = self.read_working_inventory()
 
487
        return inv.root.file_id
534
488
        
535
489
    def _get_store_filename(self, file_id):
536
490
        ## XXX: badly named; this is not in the store at all
537
491
        return self.abspath(self.id2path(file_id))
538
492
 
539
493
    @needs_read_lock
540
 
    def clone(self, to_bzrdir, revision_id=None):
 
494
    def clone(self, to_bzrdir, revision_id=None, basis=None):
541
495
        """Duplicate this working tree into to_bzr, including all state.
542
496
        
543
497
        Specifically modified files are kept as modified, but
549
503
            If not None, the cloned tree will have its last revision set to 
550
504
            revision, and and difference between the source trees last revision
551
505
            and this one merged in.
 
506
 
 
507
        basis
 
508
            If not None, a closer copy of a tree which may have some files in
 
509
            common, and which file content should be preferentially copied from.
552
510
        """
553
511
        # assumes the target bzr dir format is compatible.
554
512
        result = self._format.initialize(to_bzrdir)
558
516
    @needs_read_lock
559
517
    def copy_content_into(self, tree, revision_id=None):
560
518
        """Copy the current content and user files of this tree into tree."""
561
 
        tree.set_root_id(self.get_root_id())
562
519
        if revision_id is None:
563
 
            merge.transform_tree(tree, self)
 
520
            transform_tree(tree, self)
564
521
        else:
565
 
            # TODO now merge from tree.last_revision to revision (to preserve
566
 
            # user local changes)
567
 
            merge.transform_tree(tree, self)
568
 
            tree.set_parent_ids([revision_id])
 
522
            # TODO now merge from tree.last_revision to revision
 
523
            transform_tree(tree, self)
 
524
            tree.set_last_revision(revision_id)
 
525
 
 
526
    @needs_write_lock
 
527
    def commit(self, message=None, revprops=None, *args, **kwargs):
 
528
        # avoid circular imports
 
529
        from bzrlib.commit import Commit
 
530
        if revprops is None:
 
531
            revprops = {}
 
532
        if not 'branch-nick' in revprops:
 
533
            revprops['branch-nick'] = self.branch.nick
 
534
        # args for wt.commit start at message from the Commit.commit method,
 
535
        # but with branch a kwarg now, passing in args as is results in the
 
536
        #message being used for the branch
 
537
        args = (DEPRECATED_PARAMETER, message, ) + args
 
538
        committed_id = Commit().commit( working_tree=self, revprops=revprops,
 
539
            *args, **kwargs)
 
540
        self._set_inventory(self.read_working_inventory())
 
541
        return committed_id
569
542
 
570
543
    def id2abspath(self, file_id):
571
544
        return self.abspath(self.id2path(file_id))
572
545
 
573
546
    def has_id(self, file_id):
574
547
        # files that have been deleted are excluded
575
 
        inv = self.inventory
 
548
        inv = self._inventory
576
549
        if not inv.has_id(file_id):
577
550
            return False
578
551
        path = inv.id2path(file_id)
589
562
        return os.path.getsize(self.id2abspath(file_id))
590
563
 
591
564
    @needs_read_lock
592
 
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
565
    def get_file_sha1(self, file_id, path=None):
593
566
        if not path:
594
567
            path = self._inventory.id2path(file_id)
595
 
        return self._hashcache.get_sha1(path, stat_value)
 
568
        return self._hashcache.get_sha1(path)
596
569
 
597
570
    def get_file_mtime(self, file_id, path=None):
598
571
        if not path:
599
 
            path = self.inventory.id2path(file_id)
 
572
            path = self._inventory.id2path(file_id)
600
573
        return os.lstat(self.abspath(path)).st_mtime
601
574
 
602
 
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
603
 
        file_id = self.path2id(path)
604
 
        return self._inventory[file_id].executable
605
 
 
606
 
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
607
 
        mode = stat_result.st_mode
608
 
        return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
609
 
 
610
575
    if not supports_executable():
611
576
        def is_executable(self, file_id, path=None):
612
577
            return self._inventory[file_id].executable
613
 
 
614
 
        _is_executable_from_path_and_stat = \
615
 
            _is_executable_from_path_and_stat_from_basis
616
578
    else:
617
579
        def is_executable(self, file_id, path=None):
618
580
            if not path:
619
 
                path = self.id2path(file_id)
 
581
                path = self._inventory.id2path(file_id)
620
582
            mode = os.lstat(self.abspath(path)).st_mode
621
583
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
622
584
 
623
 
        _is_executable_from_path_and_stat = \
624
 
            _is_executable_from_path_and_stat_from_stat
625
 
 
626
 
    @needs_tree_write_lock
627
 
    def _add(self, files, ids, kinds):
628
 
        """See MutableTree._add."""
 
585
    @needs_write_lock
 
586
    def add(self, files, ids=None):
 
587
        """Make files versioned.
 
588
 
 
589
        Note that the command line normally calls smart_add instead,
 
590
        which can automatically recurse.
 
591
 
 
592
        This adds the files to the inventory, so that they will be
 
593
        recorded by the next commit.
 
594
 
 
595
        files
 
596
            List of paths to add, relative to the base of the tree.
 
597
 
 
598
        ids
 
599
            If set, use these instead of automatically generated ids.
 
600
            Must be the same length as the list of files, but may
 
601
            contain None for ids that are to be autogenerated.
 
602
 
 
603
        TODO: Perhaps have an option to add the ids even if the files do
 
604
              not (yet) exist.
 
605
 
 
606
        TODO: Perhaps callback with the ids and paths as they're added.
 
607
        """
629
608
        # TODO: Re-adding a file that is removed in the working copy
630
609
        # should probably put it back with the previous ID.
631
 
        # the read and write working inventory should not occur in this 
632
 
        # function - they should be part of lock_write and unlock.
633
 
        inv = self.inventory
634
 
        for f, file_id, kind in zip(files, ids, kinds):
635
 
            assert kind is not None
 
610
        if isinstance(files, basestring):
 
611
            assert(ids is None or isinstance(ids, basestring))
 
612
            files = [files]
 
613
            if ids is not None:
 
614
                ids = [ids]
 
615
 
 
616
        if ids is None:
 
617
            ids = [None] * len(files)
 
618
        else:
 
619
            assert(len(ids) == len(files))
 
620
 
 
621
        inv = self.read_working_inventory()
 
622
        for f,file_id in zip(files, ids):
 
623
            if self.is_control_filename(f):
 
624
                raise errors.ForbiddenControlFileError(filename=f)
 
625
 
 
626
            fp = splitpath(f)
 
627
 
 
628
            if len(fp) == 0:
 
629
                raise BzrError("cannot add top-level %r" % f)
 
630
 
 
631
            fullpath = normpath(self.abspath(f))
 
632
            try:
 
633
                kind = file_kind(fullpath)
 
634
            except OSError, e:
 
635
                if e.errno == errno.ENOENT:
 
636
                    raise NoSuchFile(fullpath)
 
637
            if not InventoryEntry.versionable_kind(kind):
 
638
                raise errors.BadFileKindError(filename=f, kind=kind)
636
639
            if file_id is None:
637
640
                inv.add_path(f, kind=kind)
638
641
            else:
639
642
                inv.add_path(f, kind=kind, file_id=file_id)
640
 
            self._inventory_is_modified = True
641
643
 
642
 
    @needs_tree_write_lock
643
 
    def _gather_kinds(self, files, kinds):
644
 
        """See MutableTree._gather_kinds."""
645
 
        for pos, f in enumerate(files):
646
 
            if kinds[pos] is None:
647
 
                fullpath = normpath(self.abspath(f))
648
 
                try:
649
 
                    kinds[pos] = file_kind(fullpath)
650
 
                except OSError, e:
651
 
                    if e.errno == errno.ENOENT:
652
 
                        raise errors.NoSuchFile(fullpath)
 
644
        self._write_inventory(inv)
653
645
 
654
646
    @needs_write_lock
655
 
    def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
656
 
        """Add revision_id as a parent.
657
 
 
658
 
        This is equivalent to retrieving the current list of parent ids
659
 
        and setting the list to its value plus revision_id.
660
 
 
661
 
        :param revision_id: The revision id to add to the parent list. It may
662
 
        be a ghost revision as long as its not the first parent to be added,
663
 
        or the allow_leftmost_as_ghost parameter is set True.
664
 
        :param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
665
 
        """
666
 
        parents = self.get_parent_ids() + [revision_id]
667
 
        self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
668
 
            or allow_leftmost_as_ghost)
669
 
 
670
 
    @needs_tree_write_lock
671
 
    def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
672
 
        """Add revision_id, tree tuple as a parent.
673
 
 
674
 
        This is equivalent to retrieving the current list of parent trees
675
 
        and setting the list to its value plus parent_tuple. See also
676
 
        add_parent_tree_id - if you only have a parent id available it will be
677
 
        simpler to use that api. If you have the parent already available, using
678
 
        this api is preferred.
679
 
 
680
 
        :param parent_tuple: The (revision id, tree) to add to the parent list.
681
 
            If the revision_id is a ghost, pass None for the tree.
682
 
        :param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
683
 
        """
684
 
        parent_ids = self.get_parent_ids() + [parent_tuple[0]]
685
 
        if len(parent_ids) > 1:
686
 
            # the leftmost may have already been a ghost, preserve that if it
687
 
            # was.
688
 
            allow_leftmost_as_ghost = True
689
 
        self.set_parent_ids(parent_ids,
690
 
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
691
 
 
692
 
    @needs_tree_write_lock
693
647
    def add_pending_merge(self, *revision_ids):
694
648
        # TODO: Perhaps should check at this point that the
695
649
        # history of the revision is actually present?
696
 
        parents = self.get_parent_ids()
 
650
        p = self.pending_merges()
697
651
        updated = False
698
652
        for rev_id in revision_ids:
699
 
            if rev_id in parents:
 
653
            if rev_id in p:
700
654
                continue
701
 
            parents.append(rev_id)
 
655
            p.append(rev_id)
702
656
            updated = True
703
657
        if updated:
704
 
            self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
705
 
 
706
 
    def path_content_summary(self, path, _lstat=osutils.lstat,
707
 
        _mapper=osutils.file_kind_from_stat_mode):
708
 
        """See Tree.path_content_summary."""
709
 
        abspath = self.abspath(path)
710
 
        try:
711
 
            stat_result = _lstat(abspath)
712
 
        except OSError, e:
713
 
            if getattr(e, 'errno', None) == errno.ENOENT:
714
 
                # no file.
715
 
                return ('missing', None, None, None)
716
 
            # propagate other errors
717
 
            raise
718
 
        kind = _mapper(stat_result.st_mode)
719
 
        if kind == 'file':
720
 
            size = stat_result.st_size
721
 
            # try for a stat cache lookup
722
 
            executable = self._is_executable_from_path_and_stat(path, stat_result)
723
 
            return (kind, size, executable, self._sha_from_stat(
724
 
                path, stat_result))
725
 
        elif kind == 'directory':
726
 
            # perhaps it looks like a plain directory, but it's really a
727
 
            # reference.
728
 
            if self._directory_is_tree_reference(path):
729
 
                kind = 'tree-reference'
730
 
            return kind, None, None, None
731
 
        elif kind == 'symlink':
732
 
            return ('symlink', None, None, os.readlink(abspath))
733
 
        else:
734
 
            return (kind, None, None, None)
735
 
 
736
 
    @deprecated_method(zero_eleven)
 
658
            self.set_pending_merges(p)
 
659
 
737
660
    @needs_read_lock
738
661
    def pending_merges(self):
739
662
        """Return a list of pending merges.
740
663
 
741
664
        These are revisions that have been merged into the working
742
665
        directory but not yet committed.
743
 
 
744
 
        As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
745
 
        instead - which is available on all tree objects.
746
 
        """
747
 
        return self.get_parent_ids()[1:]
748
 
 
749
 
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
750
 
        """Common ghost checking functionality from set_parent_*.
751
 
 
752
 
        This checks that the left hand-parent exists if there are any
753
 
        revisions present.
754
 
        """
755
 
        if len(revision_ids) > 0:
756
 
            leftmost_id = revision_ids[0]
757
 
            if (not allow_leftmost_as_ghost and not
758
 
                self.branch.repository.has_revision(leftmost_id)):
759
 
                raise errors.GhostRevisionUnusableHere(leftmost_id)
760
 
 
761
 
    def _set_merges_from_parent_ids(self, parent_ids):
762
 
        merges = parent_ids[1:]
763
 
        self._control_files.put_bytes('pending-merges', '\n'.join(merges))
764
 
 
765
 
    @needs_tree_write_lock
766
 
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
767
 
        """Set the parent ids to revision_ids.
768
 
        
769
 
        See also set_parent_trees. This api will try to retrieve the tree data
770
 
        for each element of revision_ids from the trees repository. If you have
771
 
        tree data already available, it is more efficient to use
772
 
        set_parent_trees rather than set_parent_ids. set_parent_ids is however
773
 
        an easier API to use.
774
 
 
775
 
        :param revision_ids: The revision_ids to set as the parent ids of this
776
 
            working tree. Any of these may be ghosts.
777
 
        """
778
 
        self._check_parents_for_ghosts(revision_ids,
779
 
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
780
 
        for revision_id in revision_ids:
781
 
            _mod_revision.check_not_reserved_id(revision_id)
782
 
 
783
 
        if len(revision_ids) > 0:
784
 
            self.set_last_revision(revision_ids[0])
785
 
        else:
786
 
            self.set_last_revision(_mod_revision.NULL_REVISION)
787
 
 
788
 
        self._set_merges_from_parent_ids(revision_ids)
789
 
 
790
 
    @needs_tree_write_lock
791
 
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
792
 
        """See MutableTree.set_parent_trees."""
793
 
        parent_ids = [rev for (rev, tree) in parents_list]
794
 
        for revision_id in parent_ids:
795
 
            _mod_revision.check_not_reserved_id(revision_id)
796
 
 
797
 
        self._check_parents_for_ghosts(parent_ids,
798
 
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
799
 
 
800
 
        if len(parent_ids) == 0:
801
 
            leftmost_parent_id = _mod_revision.NULL_REVISION
802
 
            leftmost_parent_tree = None
803
 
        else:
804
 
            leftmost_parent_id, leftmost_parent_tree = parents_list[0]
805
 
 
806
 
        if self._change_last_revision(leftmost_parent_id):
807
 
            if leftmost_parent_tree is None:
808
 
                # If we don't have a tree, fall back to reading the
809
 
                # parent tree from the repository.
810
 
                self._cache_basis_inventory(leftmost_parent_id)
811
 
            else:
812
 
                inv = leftmost_parent_tree.inventory
813
 
                xml = self._create_basis_xml_from_inventory(
814
 
                                        leftmost_parent_id, inv)
815
 
                self._write_basis_inventory(xml)
816
 
        self._set_merges_from_parent_ids(parent_ids)
817
 
 
818
 
    @needs_tree_write_lock
 
666
        """
 
667
        try:
 
668
            merges_file = self._control_files.get_utf8('pending-merges')
 
669
        except NoSuchFile:
 
670
            return []
 
671
        p = []
 
672
        for l in merges_file.readlines():
 
673
            p.append(l.rstrip('\n'))
 
674
        return p
 
675
 
 
676
    @needs_write_lock
819
677
    def set_pending_merges(self, rev_list):
820
 
        parents = self.get_parent_ids()
821
 
        leftmost = parents[:1]
822
 
        new_parents = leftmost + rev_list
823
 
        self.set_parent_ids(new_parents)
 
678
        self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
824
679
 
825
 
    @needs_tree_write_lock
 
680
    @needs_write_lock
826
681
    def set_merge_modified(self, modified_hashes):
827
682
        def iter_stanzas():
828
683
            for file_id, hash in modified_hashes.iteritems():
829
 
                yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
 
684
                yield Stanza(file_id=file_id, hash=hash)
830
685
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
831
686
 
832
 
    def _sha_from_stat(self, path, stat_result):
833
 
        """Get a sha digest from the tree's stat cache.
834
 
 
835
 
        The default implementation assumes no stat cache is present.
836
 
 
837
 
        :param path: The path.
838
 
        :param stat_result: The stat result being looked up.
839
 
        """
840
 
        return None
841
 
 
 
687
    @needs_write_lock
842
688
    def _put_rio(self, filename, stanzas, header):
843
 
        self._must_be_locked()
844
689
        my_file = rio_file(stanzas, header)
845
690
        self._control_files.put(filename, my_file)
846
691
 
847
 
    @needs_write_lock # because merge pulls data into the branch.
848
 
    def merge_from_branch(self, branch, to_revision=None, from_revision=None,
849
 
        merge_type=None):
850
 
        """Merge from a branch into this working tree.
851
 
 
852
 
        :param branch: The branch to merge from.
853
 
        :param to_revision: If non-None, the merge will merge to to_revision,
854
 
            but not beyond it. to_revision does not need to be in the history
855
 
            of the branch when it is supplied. If None, to_revision defaults to
856
 
            branch.last_revision().
857
 
        """
858
 
        from bzrlib.merge import Merger, Merge3Merger
859
 
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
860
 
        try:
861
 
            merger = Merger(self.branch, this_tree=self, pb=pb)
862
 
            merger.pp = ProgressPhase("Merge phase", 5, pb)
863
 
            merger.pp.next_phase()
864
 
            # check that there are no
865
 
            # local alterations
866
 
            merger.check_basis(check_clean=True, require_commits=False)
867
 
            if to_revision is None:
868
 
                to_revision = _mod_revision.ensure_null(branch.last_revision())
869
 
            merger.other_rev_id = to_revision
870
 
            if _mod_revision.is_null(merger.other_rev_id):
871
 
                raise errors.NoCommits(branch)
872
 
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
873
 
            merger.other_basis = merger.other_rev_id
874
 
            merger.other_tree = self.branch.repository.revision_tree(
875
 
                merger.other_rev_id)
876
 
            merger.other_branch = branch
877
 
            merger.pp.next_phase()
878
 
            if from_revision is None:
879
 
                merger.find_base()
880
 
            else:
881
 
                merger.set_base_revision(from_revision, branch)
882
 
            if merger.base_rev_id == merger.other_rev_id:
883
 
                raise errors.PointlessMerge
884
 
            merger.backup_files = False
885
 
            if merge_type is None:
886
 
                merger.merge_type = Merge3Merger
887
 
            else:
888
 
                merger.merge_type = merge_type
889
 
            merger.set_interesting_files(None)
890
 
            merger.show_base = False
891
 
            merger.reprocess = False
892
 
            conflicts = merger.do_merge()
893
 
            merger.set_pending()
894
 
        finally:
895
 
            pb.finished()
896
 
        return conflicts
897
 
 
898
692
    @needs_read_lock
899
693
    def merge_modified(self):
900
 
        """Return a dictionary of files modified by a merge.
901
 
 
902
 
        The list is initialized by WorkingTree.set_merge_modified, which is 
903
 
        typically called after we make some automatic updates to the tree
904
 
        because of a merge.
905
 
 
906
 
        This returns a map of file_id->sha1, containing only files which are
907
 
        still in the working inventory and have that text hash.
908
 
        """
909
694
        try:
910
695
            hashfile = self._control_files.get('merge-hashes')
911
 
        except errors.NoSuchFile:
 
696
        except NoSuchFile:
912
697
            return {}
913
698
        merge_hashes = {}
914
699
        try:
915
700
            if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
916
 
                raise errors.MergeModifiedFormatError()
 
701
                raise MergeModifiedFormatError()
917
702
        except StopIteration:
918
 
            raise errors.MergeModifiedFormatError()
 
703
            raise MergeModifiedFormatError()
919
704
        for s in RioReader(hashfile):
920
 
            # RioReader reads in Unicode, so convert file_ids back to utf8
921
 
            file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
 
705
            file_id = s.get("file_id")
922
706
            if file_id not in self.inventory:
923
707
                continue
924
 
            text_hash = s.get("hash")
925
 
            if text_hash == self.get_file_sha1(file_id):
926
 
                merge_hashes[file_id] = text_hash
 
708
            hash = s.get("hash")
 
709
            if hash == self.get_file_sha1(file_id):
 
710
                merge_hashes[file_id] = hash
927
711
        return merge_hashes
928
712
 
929
 
    @needs_write_lock
930
 
    def mkdir(self, path, file_id=None):
931
 
        """See MutableTree.mkdir()."""
932
 
        if file_id is None:
933
 
            file_id = generate_ids.gen_file_id(os.path.basename(path))
934
 
        os.mkdir(self.abspath(path))
935
 
        self.add(path, file_id, 'directory')
936
 
        return file_id
937
 
 
938
713
    def get_symlink_target(self, file_id):
939
714
        return os.readlink(self.id2abspath(file_id))
940
715
 
941
 
    @needs_write_lock
942
 
    def subsume(self, other_tree):
943
 
        def add_children(inventory, entry):
944
 
            for child_entry in entry.children.values():
945
 
                inventory._byid[child_entry.file_id] = child_entry
946
 
                if child_entry.kind == 'directory':
947
 
                    add_children(inventory, child_entry)
948
 
        if other_tree.get_root_id() == self.get_root_id():
949
 
            raise errors.BadSubsumeSource(self, other_tree,
950
 
                                          'Trees have the same root')
951
 
        try:
952
 
            other_tree_path = self.relpath(other_tree.basedir)
953
 
        except errors.PathNotChild:
954
 
            raise errors.BadSubsumeSource(self, other_tree,
955
 
                'Tree is not contained by the other')
956
 
        new_root_parent = self.path2id(osutils.dirname(other_tree_path))
957
 
        if new_root_parent is None:
958
 
            raise errors.BadSubsumeSource(self, other_tree,
959
 
                'Parent directory is not versioned.')
960
 
        # We need to ensure that the result of a fetch will have a
961
 
        # versionedfile for the other_tree root, and only fetching into
962
 
        # RepositoryKnit2 guarantees that.
963
 
        if not self.branch.repository.supports_rich_root():
964
 
            raise errors.SubsumeTargetNeedsUpgrade(other_tree)
965
 
        other_tree.lock_tree_write()
966
 
        try:
967
 
            new_parents = other_tree.get_parent_ids()
968
 
            other_root = other_tree.inventory.root
969
 
            other_root.parent_id = new_root_parent
970
 
            other_root.name = osutils.basename(other_tree_path)
971
 
            self.inventory.add(other_root)
972
 
            add_children(self.inventory, other_root)
973
 
            self._write_inventory(self.inventory)
974
 
            # normally we don't want to fetch whole repositories, but i think
975
 
            # here we really do want to consolidate the whole thing.
976
 
            for parent_id in other_tree.get_parent_ids():
977
 
                self.branch.fetch(other_tree.branch, parent_id)
978
 
                self.add_parent_tree_id(parent_id)
979
 
        finally:
980
 
            other_tree.unlock()
981
 
        other_tree.bzrdir.retire_bzrdir()
982
 
 
983
 
    def _directory_is_tree_reference(self, relpath):
984
 
        # as a special case, if a directory contains control files then 
985
 
        # it's a tree reference, except that the root of the tree is not
986
 
        return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
987
 
        # TODO: We could ask all the control formats whether they
988
 
        # recognize this directory, but at the moment there's no cheap api
989
 
        # to do that.  Since we probably can only nest bzr checkouts and
990
 
        # they always use this name it's ok for now.  -- mbp 20060306
991
 
        #
992
 
        # FIXME: There is an unhandled case here of a subdirectory
993
 
        # containing .bzr but not a branch; that will probably blow up
994
 
        # when you try to commit it.  It might happen if there is a
995
 
        # checkout in a subdirectory.  This can be avoided by not adding
996
 
        # it.  mbp 20070306
997
 
 
998
 
    @needs_tree_write_lock
999
 
    def extract(self, file_id, format=None):
1000
 
        """Extract a subtree from this tree.
1001
 
        
1002
 
        A new branch will be created, relative to the path for this tree.
1003
 
        """
1004
 
        self.flush()
1005
 
        def mkdirs(path):
1006
 
            segments = osutils.splitpath(path)
1007
 
            transport = self.branch.bzrdir.root_transport
1008
 
            for name in segments:
1009
 
                transport = transport.clone(name)
1010
 
                transport.ensure_base()
1011
 
            return transport
1012
 
            
1013
 
        sub_path = self.id2path(file_id)
1014
 
        branch_transport = mkdirs(sub_path)
1015
 
        if format is None:
1016
 
            format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
1017
 
        branch_transport.ensure_base()
1018
 
        branch_bzrdir = format.initialize_on_transport(branch_transport)
1019
 
        try:
1020
 
            repo = branch_bzrdir.find_repository()
1021
 
        except errors.NoRepositoryPresent:
1022
 
            repo = branch_bzrdir.create_repository()
1023
 
            assert repo.supports_rich_root()
1024
 
        else:
1025
 
            if not repo.supports_rich_root():
1026
 
                raise errors.RootNotRich()
1027
 
        new_branch = branch_bzrdir.create_branch()
1028
 
        new_branch.pull(self.branch)
1029
 
        for parent_id in self.get_parent_ids():
1030
 
            new_branch.fetch(self.branch, parent_id)
1031
 
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
1032
 
        if tree_transport.base != branch_transport.base:
1033
 
            tree_bzrdir = format.initialize_on_transport(tree_transport)
1034
 
            branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1035
 
        else:
1036
 
            tree_bzrdir = branch_bzrdir
1037
 
        wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1038
 
        wt.set_parent_ids(self.get_parent_ids())
1039
 
        my_inv = self.inventory
1040
 
        child_inv = Inventory(root_id=None)
1041
 
        new_root = my_inv[file_id]
1042
 
        my_inv.remove_recursive_id(file_id)
1043
 
        new_root.parent_id = None
1044
 
        child_inv.add(new_root)
1045
 
        self._write_inventory(my_inv)
1046
 
        wt._write_inventory(child_inv)
1047
 
        return wt
1048
 
 
1049
 
    def _serialize(self, inventory, out_file):
1050
 
        xml5.serializer_v5.write_inventory(self._inventory, out_file,
1051
 
            working=True)
1052
 
 
1053
 
    def _deserialize(selt, in_file):
1054
 
        return xml5.serializer_v5.read_inventory(in_file)
1055
 
 
1056
 
    def flush(self):
1057
 
        """Write the in memory inventory to disk."""
1058
 
        # TODO: Maybe this should only write on dirty ?
1059
 
        if self._control_files._lock_mode != 'w':
1060
 
            raise errors.NotWriteLocked(self)
1061
 
        sio = StringIO()
1062
 
        self._serialize(self._inventory, sio)
1063
 
        sio.seek(0)
1064
 
        self._control_files.put('inventory', sio)
1065
 
        self._inventory_is_modified = False
1066
 
 
1067
 
    def _kind(self, relpath):
1068
 
        return osutils.file_kind(self.abspath(relpath))
1069
 
 
1070
 
    def list_files(self, include_root=False):
 
716
    def file_class(self, filename):
 
717
        if self.path2id(filename):
 
718
            return 'V'
 
719
        elif self.is_ignored(filename):
 
720
            return 'I'
 
721
        else:
 
722
            return '?'
 
723
 
 
724
    def list_files(self):
1071
725
        """Recursively list all files as (path, class, kind, id, entry).
1072
726
 
1073
727
        Lists, but does not descend into unversioned directories.
1077
731
 
1078
732
        Skips the control directory.
1079
733
        """
1080
 
        # list_files is an iterator, so @needs_read_lock doesn't work properly
1081
 
        # with it. So callers should be careful to always read_lock the tree.
1082
 
        if not self.is_locked():
1083
 
            raise errors.ObjectNotLocked(self)
1084
 
 
1085
 
        inv = self.inventory
1086
 
        if include_root is True:
1087
 
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
 
734
        inv = self._inventory
1088
735
        # Convert these into local objects to save lookup times
1089
736
        pathjoin = osutils.pathjoin
1090
 
        file_kind = self._kind
 
737
        file_kind = osutils.file_kind
1091
738
 
1092
739
        # transport.base ends in a slash, we want the piece
1093
740
        # between the last two slashes
1153
800
 
1154
801
                fk = file_kind(fap)
1155
802
 
 
803
                if f_ie:
 
804
                    if f_ie.kind != fk:
 
805
                        raise BzrCheckError("file %r entered as kind %r id %r, "
 
806
                                            "now of kind %r"
 
807
                                            % (fap, f_ie.kind, f_ie.file_id, fk))
 
808
 
1156
809
                # make a last minute entry
1157
810
                if f_ie:
1158
811
                    yield fp[1:], c, fk, f_ie.file_id, f_ie
1171
824
                new_children.sort()
1172
825
                new_children = collections.deque(new_children)
1173
826
                stack.append((f_ie.file_id, fp, fap, new_children))
1174
 
                # Break out of inner loop,
1175
 
                # so that we start outer loop with child
 
827
                # Break out of inner loop, so that we start outer loop with child
1176
828
                break
1177
829
            else:
1178
830
                # if we finished all children, pop it off the stack
1179
831
                stack.pop()
1180
832
 
1181
 
    @needs_tree_write_lock
1182
 
    def move(self, from_paths, to_dir=None, after=False, **kwargs):
 
833
 
 
834
    @needs_write_lock
 
835
    def move(self, from_paths, to_name):
1183
836
        """Rename files.
1184
837
 
1185
 
        to_dir must exist in the inventory.
 
838
        to_name must exist in the inventory.
1186
839
 
1187
 
        If to_dir exists and is a directory, the files are moved into
 
840
        If to_name exists and is a directory, the files are moved into
1188
841
        it, keeping their old names.  
1189
842
 
1190
 
        Note that to_dir is only the last component of the new name;
 
843
        Note that to_name is only the last component of the new name;
1191
844
        this doesn't change the directory.
1192
845
 
1193
 
        For each entry in from_paths the move mode will be determined
1194
 
        independently.
1195
 
 
1196
 
        The first mode moves the file in the filesystem and updates the
1197
 
        inventory. The second mode only updates the inventory without
1198
 
        touching the file on the filesystem. This is the new mode introduced
1199
 
        in version 0.15.
1200
 
 
1201
 
        move uses the second mode if 'after == True' and the target is not
1202
 
        versioned but present in the working tree.
1203
 
 
1204
 
        move uses the second mode if 'after == False' and the source is
1205
 
        versioned but no longer in the working tree, and the target is not
1206
 
        versioned but present in the working tree.
1207
 
 
1208
 
        move uses the first mode if 'after == False' and the source is
1209
 
        versioned and present in the working tree, and the target is not
1210
 
        versioned and not present in the working tree.
1211
 
 
1212
 
        Everything else results in an error.
1213
 
 
1214
846
        This returns a list of (from_path, to_path) pairs for each
1215
847
        entry that is moved.
1216
848
        """
1217
 
        rename_entries = []
1218
 
        rename_tuples = []
1219
 
 
1220
 
        # check for deprecated use of signature
1221
 
        if to_dir is None:
1222
 
            to_dir = kwargs.get('to_name', None)
1223
 
            if to_dir is None:
1224
 
                raise TypeError('You must supply a target directory')
1225
 
            else:
1226
 
                symbol_versioning.warn('The parameter to_name was deprecated'
1227
 
                                       ' in version 0.13. Use to_dir instead',
1228
 
                                       DeprecationWarning)
1229
 
 
1230
 
        # check destination directory
 
849
        result = []
 
850
        ## TODO: Option to move IDs only
1231
851
        assert not isinstance(from_paths, basestring)
1232
852
        inv = self.inventory
1233
 
        to_abs = self.abspath(to_dir)
 
853
        to_abs = self.abspath(to_name)
1234
854
        if not isdir(to_abs):
1235
 
            raise errors.BzrMoveFailedError('',to_dir,
1236
 
                errors.NotADirectory(to_abs))
1237
 
        if not self.has_filename(to_dir):
1238
 
            raise errors.BzrMoveFailedError('',to_dir,
1239
 
                errors.NotInWorkingDirectory(to_dir))
1240
 
        to_dir_id = inv.path2id(to_dir)
1241
 
        if to_dir_id is None:
1242
 
            raise errors.BzrMoveFailedError('',to_dir,
1243
 
                errors.NotVersionedError(path=str(to_dir)))
1244
 
 
 
855
            raise BzrError("destination %r is not a directory" % to_abs)
 
856
        if not self.has_filename(to_name):
 
857
            raise BzrError("destination %r not in working directory" % to_abs)
 
858
        to_dir_id = inv.path2id(to_name)
 
859
        if to_dir_id == None and to_name != '':
 
860
            raise BzrError("destination %r is not a versioned directory" % to_name)
1245
861
        to_dir_ie = inv[to_dir_id]
1246
862
        if to_dir_ie.kind != 'directory':
1247
 
            raise errors.BzrMoveFailedError('',to_dir,
1248
 
                errors.NotADirectory(to_abs))
1249
 
 
1250
 
        # create rename entries and tuples
1251
 
        for from_rel in from_paths:
1252
 
            from_tail = splitpath(from_rel)[-1]
1253
 
            from_id = inv.path2id(from_rel)
1254
 
            if from_id is None:
1255
 
                raise errors.BzrMoveFailedError(from_rel,to_dir,
1256
 
                    errors.NotVersionedError(path=str(from_rel)))
1257
 
 
1258
 
            from_entry = inv[from_id]
1259
 
            from_parent_id = from_entry.parent_id
1260
 
            to_rel = pathjoin(to_dir, from_tail)
1261
 
            rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1262
 
                                         from_id=from_id,
1263
 
                                         from_tail=from_tail,
1264
 
                                         from_parent_id=from_parent_id,
1265
 
                                         to_rel=to_rel, to_tail=from_tail,
1266
 
                                         to_parent_id=to_dir_id)
1267
 
            rename_entries.append(rename_entry)
1268
 
            rename_tuples.append((from_rel, to_rel))
1269
 
 
1270
 
        # determine which move mode to use. checks also for movability
1271
 
        rename_entries = self._determine_mv_mode(rename_entries, after)
1272
 
 
1273
 
        original_modified = self._inventory_is_modified
 
863
            raise BzrError("destination %r is not a directory" % to_abs)
 
864
 
 
865
        to_idpath = inv.get_idpath(to_dir_id)
 
866
 
 
867
        for f in from_paths:
 
868
            if not self.has_filename(f):
 
869
                raise BzrError("%r does not exist in working tree" % f)
 
870
            f_id = inv.path2id(f)
 
871
            if f_id == None:
 
872
                raise BzrError("%r is not versioned" % f)
 
873
            name_tail = splitpath(f)[-1]
 
874
            dest_path = pathjoin(to_name, name_tail)
 
875
            if self.has_filename(dest_path):
 
876
                raise BzrError("destination %r already exists" % dest_path)
 
877
            if f_id in to_idpath:
 
878
                raise BzrError("can't move %r to a subdirectory of itself" % f)
 
879
 
 
880
        # OK, so there's a race here, it's possible that someone will
 
881
        # create a file in this interval and then the rename might be
 
882
        # left half-done.  But we should have caught most problems.
 
883
        orig_inv = deepcopy(self.inventory)
1274
884
        try:
1275
 
            if len(from_paths):
1276
 
                self._inventory_is_modified = True
1277
 
            self._move(rename_entries)
 
885
            for f in from_paths:
 
886
                name_tail = splitpath(f)[-1]
 
887
                dest_path = pathjoin(to_name, name_tail)
 
888
                result.append((f, dest_path))
 
889
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
 
890
                try:
 
891
                    rename(self.abspath(f), self.abspath(dest_path))
 
892
                except OSError, e:
 
893
                    raise BzrError("failed to rename %r to %r: %s" %
 
894
                                   (f, dest_path, e[1]),
 
895
                            ["rename rolled back"])
1278
896
        except:
1279
897
            # restore the inventory on error
1280
 
            self._inventory_is_modified = original_modified
 
898
            self._set_inventory(orig_inv)
1281
899
            raise
1282
900
        self._write_inventory(inv)
1283
 
        return rename_tuples
1284
 
 
1285
 
    def _determine_mv_mode(self, rename_entries, after=False):
1286
 
        """Determines for each from-to pair if both inventory and working tree
1287
 
        or only the inventory has to be changed.
1288
 
 
1289
 
        Also does basic plausability tests.
1290
 
        """
1291
 
        inv = self.inventory
1292
 
 
1293
 
        for rename_entry in rename_entries:
1294
 
            # store to local variables for easier reference
1295
 
            from_rel = rename_entry.from_rel
1296
 
            from_id = rename_entry.from_id
1297
 
            to_rel = rename_entry.to_rel
1298
 
            to_id = inv.path2id(to_rel)
1299
 
            only_change_inv = False
1300
 
 
1301
 
            # check the inventory for source and destination
1302
 
            if from_id is None:
1303
 
                raise errors.BzrMoveFailedError(from_rel,to_rel,
1304
 
                    errors.NotVersionedError(path=str(from_rel)))
1305
 
            if to_id is not None:
1306
 
                raise errors.BzrMoveFailedError(from_rel,to_rel,
1307
 
                    errors.AlreadyVersionedError(path=str(to_rel)))
1308
 
 
1309
 
            # try to determine the mode for rename (only change inv or change
1310
 
            # inv and file system)
1311
 
            if after:
1312
 
                if not self.has_filename(to_rel):
1313
 
                    raise errors.BzrMoveFailedError(from_id,to_rel,
1314
 
                        errors.NoSuchFile(path=str(to_rel),
1315
 
                        extra="New file has not been created yet"))
1316
 
                only_change_inv = True
1317
 
            elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1318
 
                only_change_inv = True
1319
 
            elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1320
 
                only_change_inv = False
1321
 
            else:
1322
 
                # something is wrong, so lets determine what exactly
1323
 
                if not self.has_filename(from_rel) and \
1324
 
                   not self.has_filename(to_rel):
1325
 
                    raise errors.BzrRenameFailedError(from_rel,to_rel,
1326
 
                        errors.PathsDoNotExist(paths=(str(from_rel),
1327
 
                        str(to_rel))))
1328
 
                else:
1329
 
                    raise errors.RenameFailedFilesExist(from_rel, to_rel,
1330
 
                        extra="(Use --after to update the Bazaar id)")
1331
 
            rename_entry.only_change_inv = only_change_inv
1332
 
        return rename_entries
1333
 
 
1334
 
    def _move(self, rename_entries):
1335
 
        """Moves a list of files.
1336
 
 
1337
 
        Depending on the value of the flag 'only_change_inv', the
1338
 
        file will be moved on the file system or not.
1339
 
        """
1340
 
        inv = self.inventory
1341
 
        moved = []
1342
 
 
1343
 
        for entry in rename_entries:
1344
 
            try:
1345
 
                self._move_entry(entry)
1346
 
            except:
1347
 
                self._rollback_move(moved)
1348
 
                raise
1349
 
            moved.append(entry)
1350
 
 
1351
 
    def _rollback_move(self, moved):
1352
 
        """Try to rollback a previous move in case of an filesystem error."""
1353
 
        inv = self.inventory
1354
 
        for entry in moved:
1355
 
            try:
1356
 
                self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1357
 
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
1358
 
                    entry.from_tail, entry.from_parent_id,
1359
 
                    entry.only_change_inv))
1360
 
            except errors.BzrMoveFailedError, e:
1361
 
                raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1362
 
                        " The working tree is in an inconsistent state."
1363
 
                        " Please consider doing a 'bzr revert'."
1364
 
                        " Error message is: %s" % e)
1365
 
 
1366
 
    def _move_entry(self, entry):
1367
 
        inv = self.inventory
1368
 
        from_rel_abs = self.abspath(entry.from_rel)
1369
 
        to_rel_abs = self.abspath(entry.to_rel)
1370
 
        if from_rel_abs == to_rel_abs:
1371
 
            raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1372
 
                "Source and target are identical.")
1373
 
 
1374
 
        if not entry.only_change_inv:
1375
 
            try:
1376
 
                osutils.rename(from_rel_abs, to_rel_abs)
1377
 
            except OSError, e:
1378
 
                raise errors.BzrMoveFailedError(entry.from_rel,
1379
 
                    entry.to_rel, e[1])
1380
 
        inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
1381
 
 
1382
 
    @needs_tree_write_lock
1383
 
    def rename_one(self, from_rel, to_rel, after=False):
 
901
        return result
 
902
 
 
903
    @needs_write_lock
 
904
    def rename_one(self, from_rel, to_rel):
1384
905
        """Rename one file.
1385
906
 
1386
907
        This can change the directory or the filename or both.
1387
 
 
1388
 
        rename_one has several 'modes' to work. First, it can rename a physical
1389
 
        file and change the file_id. That is the normal mode. Second, it can
1390
 
        only change the file_id without touching any physical file. This is
1391
 
        the new mode introduced in version 0.15.
1392
 
 
1393
 
        rename_one uses the second mode if 'after == True' and 'to_rel' is not
1394
 
        versioned but present in the working tree.
1395
 
 
1396
 
        rename_one uses the second mode if 'after == False' and 'from_rel' is
1397
 
        versioned but no longer in the working tree, and 'to_rel' is not
1398
 
        versioned but present in the working tree.
1399
 
 
1400
 
        rename_one uses the first mode if 'after == False' and 'from_rel' is
1401
 
        versioned and present in the working tree, and 'to_rel' is not
1402
 
        versioned and not present in the working tree.
1403
 
 
1404
 
        Everything else results in an error.
1405
908
        """
1406
909
        inv = self.inventory
1407
 
        rename_entries = []
1408
 
 
1409
 
        # create rename entries and tuples
1410
 
        from_tail = splitpath(from_rel)[-1]
1411
 
        from_id = inv.path2id(from_rel)
1412
 
        if from_id is None:
1413
 
            raise errors.BzrRenameFailedError(from_rel,to_rel,
1414
 
                errors.NotVersionedError(path=str(from_rel)))
1415
 
        from_entry = inv[from_id]
1416
 
        from_parent_id = from_entry.parent_id
 
910
        if not self.has_filename(from_rel):
 
911
            raise BzrError("can't rename: old working file %r does not exist" % from_rel)
 
912
        if self.has_filename(to_rel):
 
913
            raise BzrError("can't rename: new working file %r already exists" % to_rel)
 
914
 
 
915
        file_id = inv.path2id(from_rel)
 
916
        if file_id == None:
 
917
            raise BzrError("can't rename: old name %r is not versioned" % from_rel)
 
918
 
 
919
        entry = inv[file_id]
 
920
        from_parent = entry.parent_id
 
921
        from_name = entry.name
 
922
        
 
923
        if inv.path2id(to_rel):
 
924
            raise BzrError("can't rename: new name %r is already versioned" % to_rel)
 
925
 
1417
926
        to_dir, to_tail = os.path.split(to_rel)
1418
927
        to_dir_id = inv.path2id(to_dir)
1419
 
        rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1420
 
                                     from_id=from_id,
1421
 
                                     from_tail=from_tail,
1422
 
                                     from_parent_id=from_parent_id,
1423
 
                                     to_rel=to_rel, to_tail=to_tail,
1424
 
                                     to_parent_id=to_dir_id)
1425
 
        rename_entries.append(rename_entry)
1426
 
 
1427
 
        # determine which move mode to use. checks also for movability
1428
 
        rename_entries = self._determine_mv_mode(rename_entries, after)
1429
 
 
1430
 
        # check if the target changed directory and if the target directory is
1431
 
        # versioned
1432
 
        if to_dir_id is None:
1433
 
            raise errors.BzrMoveFailedError(from_rel,to_rel,
1434
 
                errors.NotVersionedError(path=str(to_dir)))
1435
 
 
1436
 
        # all checks done. now we can continue with our actual work
1437
 
        mutter('rename_one:\n'
1438
 
               '  from_id   {%s}\n'
1439
 
               '  from_rel: %r\n'
1440
 
               '  to_rel:   %r\n'
1441
 
               '  to_dir    %r\n'
1442
 
               '  to_dir_id {%s}\n',
1443
 
               from_id, from_rel, to_rel, to_dir, to_dir_id)
1444
 
 
1445
 
        self._move(rename_entries)
 
928
        if to_dir_id == None and to_dir != '':
 
929
            raise BzrError("can't determine destination directory id for %r" % to_dir)
 
930
 
 
931
        mutter("rename_one:")
 
932
        mutter("  file_id    {%s}" % file_id)
 
933
        mutter("  from_rel   %r" % from_rel)
 
934
        mutter("  to_rel     %r" % to_rel)
 
935
        mutter("  to_dir     %r" % to_dir)
 
936
        mutter("  to_dir_id  {%s}" % to_dir_id)
 
937
 
 
938
        inv.rename(file_id, to_dir_id, to_tail)
 
939
 
 
940
        from_abs = self.abspath(from_rel)
 
941
        to_abs = self.abspath(to_rel)
 
942
        try:
 
943
            rename(from_abs, to_abs)
 
944
        except OSError, e:
 
945
            inv.rename(file_id, from_parent, from_name)
 
946
            raise BzrError("failed to rename %r to %r: %s"
 
947
                    % (from_abs, to_abs, e[1]),
 
948
                    ["rename rolled back"])
1446
949
        self._write_inventory(inv)
1447
950
 
1448
 
    class _RenameEntry(object):
1449
 
        def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1450
 
                     to_rel, to_tail, to_parent_id, only_change_inv=False):
1451
 
            self.from_rel = from_rel
1452
 
            self.from_id = from_id
1453
 
            self.from_tail = from_tail
1454
 
            self.from_parent_id = from_parent_id
1455
 
            self.to_rel = to_rel
1456
 
            self.to_tail = to_tail
1457
 
            self.to_parent_id = to_parent_id
1458
 
            self.only_change_inv = only_change_inv
1459
 
 
1460
951
    @needs_read_lock
1461
952
    def unknowns(self):
1462
953
        """Return all unknown files.
1464
955
        These are files in the working directory that are not versioned or
1465
956
        control files or ignored.
1466
957
        """
1467
 
        # force the extras method to be fully executed before returning, to 
1468
 
        # prevent race conditions with the lock
1469
 
        return iter(
1470
 
            [subp for subp in self.extras() if not self.is_ignored(subp)])
1471
 
 
1472
 
    @needs_tree_write_lock
1473
 
    def unversion(self, file_ids):
1474
 
        """Remove the file ids in file_ids from the current versioned set.
1475
 
 
1476
 
        When a file_id is unversioned, all of its children are automatically
1477
 
        unversioned.
1478
 
 
1479
 
        :param file_ids: The file ids to stop versioning.
1480
 
        :raises: NoSuchId if any fileid is not currently versioned.
1481
 
        """
1482
 
        for file_id in file_ids:
1483
 
            if self._inventory.has_id(file_id):
1484
 
                self._inventory.remove_recursive_id(file_id)
1485
 
            else:
1486
 
                raise errors.NoSuchId(self, file_id)
1487
 
        if len(file_ids):
1488
 
            # in the future this should just set a dirty bit to wait for the 
1489
 
            # final unlock. However, until all methods of workingtree start
1490
 
            # with the current in -memory inventory rather than triggering 
1491
 
            # a read, it is more complex - we need to teach read_inventory
1492
 
            # to know when to read, and when to not read first... and possibly
1493
 
            # to save first when the in memory one may be corrupted.
1494
 
            # so for now, we just only write it if it is indeed dirty.
1495
 
            # - RBC 20060907
1496
 
            self._write_inventory(self._inventory)
1497
 
    
 
958
        for subp in self.extras():
 
959
            if not self.is_ignored(subp):
 
960
                yield subp
 
961
 
1498
962
    @deprecated_method(zero_eight)
1499
963
    def iter_conflicts(self):
1500
964
        """List all files in the tree that have text or content conflicts.
1513
977
                yield stem
1514
978
 
1515
979
    @needs_write_lock
1516
 
    def pull(self, source, overwrite=False, stop_revision=None,
1517
 
             change_reporter=None, possible_transports=None):
 
980
    def pull(self, source, overwrite=False, stop_revision=None):
1518
981
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1519
982
        source.lock_read()
1520
983
        try:
1521
984
            pp = ProgressPhase("Pull phase", 2, top_pb)
1522
985
            pp.next_phase()
1523
 
            old_revision_info = self.branch.last_revision_info()
 
986
            old_revision_history = self.branch.revision_history()
1524
987
            basis_tree = self.basis_tree()
1525
 
            count = self.branch.pull(source, overwrite, stop_revision,
1526
 
                                     possible_transports=possible_transports)
1527
 
            new_revision_info = self.branch.last_revision_info()
1528
 
            if new_revision_info != old_revision_info:
 
988
            count = self.branch.pull(source, overwrite, stop_revision)
 
989
            new_revision_history = self.branch.revision_history()
 
990
            if new_revision_history != old_revision_history:
1529
991
                pp.next_phase()
 
992
                if len(old_revision_history):
 
993
                    other_revision = old_revision_history[-1]
 
994
                else:
 
995
                    other_revision = None
1530
996
                repository = self.branch.repository
1531
997
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
1532
 
                basis_tree.lock_read()
1533
998
                try:
1534
 
                    new_basis_tree = self.branch.basis_tree()
1535
 
                    merge.merge_inner(
1536
 
                                self.branch,
1537
 
                                new_basis_tree,
1538
 
                                basis_tree,
1539
 
                                this_tree=self,
1540
 
                                pb=pb,
1541
 
                                change_reporter=change_reporter)
1542
 
                    if (basis_tree.inventory.root is None and
1543
 
                        new_basis_tree.inventory.root is not None):
1544
 
                        self.set_root_id(new_basis_tree.inventory.root.file_id)
 
999
                    merge_inner(self.branch,
 
1000
                                self.branch.basis_tree(),
 
1001
                                basis_tree, 
 
1002
                                this_tree=self, 
 
1003
                                pb=pb)
1545
1004
                finally:
1546
1005
                    pb.finished()
1547
 
                    basis_tree.unlock()
1548
 
                # TODO - dedup parents list with things merged by pull ?
1549
 
                # reuse the revisiontree we merged against to set the new
1550
 
                # tree data.
1551
 
                parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1552
 
                # we have to pull the merge trees out again, because 
1553
 
                # merge_inner has set the ids. - this corner is not yet 
1554
 
                # layered well enough to prevent double handling.
1555
 
                # XXX TODO: Fix the double handling: telling the tree about
1556
 
                # the already known parent data is wasteful.
1557
 
                merges = self.get_parent_ids()[1:]
1558
 
                parent_trees.extend([
1559
 
                    (parent, repository.revision_tree(parent)) for
1560
 
                     parent in merges])
1561
 
                self.set_parent_trees(parent_trees)
 
1006
                self.set_last_revision(self.branch.last_revision())
1562
1007
            return count
1563
1008
        finally:
1564
1009
            source.unlock()
1565
1010
            top_pb.finished()
1566
1011
 
1567
 
    @needs_write_lock
1568
 
    def put_file_bytes_non_atomic(self, file_id, bytes):
1569
 
        """See MutableTree.put_file_bytes_non_atomic."""
1570
 
        stream = file(self.id2abspath(file_id), 'wb')
1571
 
        try:
1572
 
            stream.write(bytes)
1573
 
        finally:
1574
 
            stream.close()
1575
 
        # TODO: update the hashcache here ?
1576
 
 
1577
1012
    def extras(self):
1578
 
        """Yield all unversioned files in this WorkingTree.
 
1013
        """Yield all unknown files in this WorkingTree.
1579
1014
 
1580
 
        If there are any unversioned directories then only the directory is
1581
 
        returned, not all its children.  But if there are unversioned files
 
1015
        If there are any unknown directories then only the directory is
 
1016
        returned, not all its children.  But if there are unknown files
1582
1017
        under a versioned subdirectory, they are returned.
1583
1018
 
1584
1019
        Currently returned depth-first, sorted by name within directories.
1585
 
        This is the same order used by 'osutils.walkdirs'.
1586
1020
        """
1587
1021
        ## TODO: Work from given directory downwards
1588
1022
        for path, dir_entry in self.inventory.directories():
1609
1043
                subp = pathjoin(path, subf)
1610
1044
                yield subp
1611
1045
 
 
1046
    def _translate_ignore_rule(self, rule):
 
1047
        """Translate a single ignore rule to a regex.
 
1048
 
 
1049
        There are two types of ignore rules.  Those that do not contain a / are
 
1050
        matched against the tail of the filename (that is, they do not care
 
1051
        what directory the file is in.)  Rules which do contain a slash must
 
1052
        match the entire path.  As a special case, './' at the start of the
 
1053
        string counts as a slash in the string but is removed before matching
 
1054
        (e.g. ./foo.c, ./src/foo.c)
 
1055
 
 
1056
        :return: The translated regex.
 
1057
        """
 
1058
        if rule[:2] in ('./', '.\\'):
 
1059
            # rootdir rule
 
1060
            result = fnmatch.translate(rule[2:])
 
1061
        elif '/' in rule or '\\' in rule:
 
1062
            # path prefix 
 
1063
            result = fnmatch.translate(rule)
 
1064
        else:
 
1065
            # default rule style.
 
1066
            result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
 
1067
        assert result[-1] == '$', "fnmatch.translate did not add the expected $"
 
1068
        return "(" + result + ")"
 
1069
 
 
1070
    def _combine_ignore_rules(self, rules):
 
1071
        """Combine a list of ignore rules into a single regex object.
 
1072
 
 
1073
        Each individual rule is combined with | to form a big regex, which then
 
1074
        has $ added to it to form something like ()|()|()$. The group index for
 
1075
        each subregex's outermost group is placed in a dictionary mapping back 
 
1076
        to the rule. This allows quick identification of the matching rule that
 
1077
        triggered a match.
 
1078
        :return: a list of the compiled regex and the matching-group index 
 
1079
        dictionaries. We return a list because python complains if you try to 
 
1080
        combine more than 100 regexes.
 
1081
        """
 
1082
        result = []
 
1083
        groups = {}
 
1084
        next_group = 0
 
1085
        translated_rules = []
 
1086
        for rule in rules:
 
1087
            translated_rule = self._translate_ignore_rule(rule)
 
1088
            compiled_rule = re.compile(translated_rule)
 
1089
            groups[next_group] = rule
 
1090
            next_group += compiled_rule.groups
 
1091
            translated_rules.append(translated_rule)
 
1092
            if next_group == 99:
 
1093
                result.append((re.compile("|".join(translated_rules)), groups))
 
1094
                groups = {}
 
1095
                next_group = 0
 
1096
                translated_rules = []
 
1097
        if len(translated_rules):
 
1098
            result.append((re.compile("|".join(translated_rules)), groups))
 
1099
        return result
 
1100
 
1612
1101
    def ignored_files(self):
1613
1102
        """Yield list of PATH, IGNORE_PATTERN"""
1614
1103
        for subp in self.extras():
1615
1104
            pat = self.is_ignored(subp)
1616
 
            if pat is not None:
 
1105
            if pat != None:
1617
1106
                yield subp, pat
1618
1107
 
1619
1108
    def get_ignore_list(self):
1625
1114
        if ignoreset is not None:
1626
1115
            return ignoreset
1627
1116
 
1628
 
        ignore_globs = set()
 
1117
        ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1629
1118
        ignore_globs.update(ignores.get_runtime_ignores())
 
1119
 
1630
1120
        ignore_globs.update(ignores.get_user_ignores())
 
1121
 
1631
1122
        if self.has_filename(bzrlib.IGNORE_FILENAME):
1632
1123
            f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1633
1124
            try:
1634
1125
                ignore_globs.update(ignores.parse_ignore_file(f))
1635
1126
            finally:
1636
1127
                f.close()
 
1128
 
1637
1129
        self._ignoreset = ignore_globs
 
1130
        self._ignore_regex = self._combine_ignore_rules(ignore_globs)
1638
1131
        return ignore_globs
1639
1132
 
1640
 
    def _flush_ignore_list_cache(self):
1641
 
        """Resets the cached ignore list to force a cache rebuild."""
1642
 
        self._ignoreset = None
1643
 
        self._ignoreglobster = None
 
1133
    def _get_ignore_rules_as_regex(self):
 
1134
        """Return a regex of the ignore rules and a mapping dict.
 
1135
 
 
1136
        :return: (ignore rules compiled regex, dictionary mapping rule group 
 
1137
        indices to original rule.)
 
1138
        """
 
1139
        if getattr(self, '_ignoreset', None) is None:
 
1140
            self.get_ignore_list()
 
1141
        return self._ignore_regex
1644
1142
 
1645
1143
    def is_ignored(self, filename):
1646
1144
        r"""Check whether the filename matches an ignore pattern.
1651
1149
        If the file is ignored, returns the pattern which caused it to
1652
1150
        be ignored, otherwise None.  So this can simply be used as a
1653
1151
        boolean if desired."""
1654
 
        if getattr(self, '_ignoreglobster', None) is None:
1655
 
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1656
 
        return self._ignoreglobster.match(filename)
 
1152
 
 
1153
        # TODO: Use '**' to match directories, and other extended
 
1154
        # globbing stuff from cvs/rsync.
 
1155
 
 
1156
        # XXX: fnmatch is actually not quite what we want: it's only
 
1157
        # approximately the same as real Unix fnmatch, and doesn't
 
1158
        # treat dotfiles correctly and allows * to match /.
 
1159
        # Eventually it should be replaced with something more
 
1160
        # accurate.
 
1161
    
 
1162
        rules = self._get_ignore_rules_as_regex()
 
1163
        for regex, mapping in rules:
 
1164
            match = regex.match(filename)
 
1165
            if match is not None:
 
1166
                # one or more of the groups in mapping will have a non-None group 
 
1167
                # match.
 
1168
                groups = match.groups()
 
1169
                rules = [mapping[group] for group in 
 
1170
                    mapping if groups[group] is not None]
 
1171
                return rules[0]
 
1172
        return None
1657
1173
 
1658
1174
    def kind(self, file_id):
1659
1175
        return file_kind(self.id2abspath(file_id))
1660
1176
 
1661
 
    def _comparison_data(self, entry, path):
1662
 
        abspath = self.abspath(path)
1663
 
        try:
1664
 
            stat_value = os.lstat(abspath)
1665
 
        except OSError, e:
1666
 
            if getattr(e, 'errno', None) == errno.ENOENT:
1667
 
                stat_value = None
1668
 
                kind = None
1669
 
                executable = False
1670
 
            else:
1671
 
                raise
1672
 
        else:
1673
 
            mode = stat_value.st_mode
1674
 
            kind = osutils.file_kind_from_stat_mode(mode)
1675
 
            if not supports_executable():
1676
 
                executable = entry is not None and entry.executable
1677
 
            else:
1678
 
                executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1679
 
        return kind, executable, stat_value
1680
 
 
1681
 
    def _file_size(self, entry, stat_value):
1682
 
        return stat_value.st_size
1683
 
 
 
1177
    @needs_read_lock
1684
1178
    def last_revision(self):
1685
 
        """Return the last revision of the branch for this tree.
1686
 
 
1687
 
        This format tree does not support a separate marker for last-revision
1688
 
        compared to the branch.
1689
 
 
1690
 
        See MutableTree.last_revision
 
1179
        """Return the last revision id of this working tree.
 
1180
 
 
1181
        In early branch formats this was == the branch last_revision,
 
1182
        but that cannot be relied upon - for working tree operations,
 
1183
        always use tree.last_revision().
1691
1184
        """
1692
 
        return self._last_revision()
1693
 
 
1694
 
    @needs_read_lock
1695
 
    def _last_revision(self):
1696
 
        """helper for get_parent_ids."""
1697
 
        return _mod_revision.ensure_null(self.branch.last_revision())
 
1185
        return self.branch.last_revision()
1698
1186
 
1699
1187
    def is_locked(self):
1700
1188
        return self._control_files.is_locked()
1701
1189
 
1702
 
    def _must_be_locked(self):
1703
 
        if not self.is_locked():
1704
 
            raise errors.ObjectNotLocked(self)
1705
 
 
1706
1190
    def lock_read(self):
1707
1191
        """See Branch.lock_read, and WorkingTree.unlock."""
1708
 
        if not self.is_locked():
1709
 
            self._reset_data()
1710
1192
        self.branch.lock_read()
1711
1193
        try:
1712
1194
            return self._control_files.lock_read()
1714
1196
            self.branch.unlock()
1715
1197
            raise
1716
1198
 
1717
 
    def lock_tree_write(self):
1718
 
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1719
 
        if not self.is_locked():
1720
 
            self._reset_data()
1721
 
        self.branch.lock_read()
1722
 
        try:
1723
 
            return self._control_files.lock_write()
1724
 
        except:
1725
 
            self.branch.unlock()
1726
 
            raise
1727
 
 
1728
1199
    def lock_write(self):
1729
 
        """See MutableTree.lock_write, and WorkingTree.unlock."""
1730
 
        if not self.is_locked():
1731
 
            self._reset_data()
 
1200
        """See Branch.lock_write, and WorkingTree.unlock."""
1732
1201
        self.branch.lock_write()
1733
1202
        try:
1734
1203
            return self._control_files.lock_write()
1740
1209
        return self._control_files.get_physical_lock_status()
1741
1210
 
1742
1211
    def _basis_inventory_name(self):
1743
 
        return 'basis-inventory-cache'
1744
 
 
1745
 
    def _reset_data(self):
1746
 
        """Reset transient data that cannot be revalidated."""
1747
 
        self._inventory_is_modified = False
1748
 
        result = self._deserialize(self._control_files.get('inventory'))
1749
 
        self._set_inventory(result, dirty=False)
1750
 
 
1751
 
    @needs_tree_write_lock
 
1212
        return 'basis-inventory'
 
1213
 
 
1214
    @needs_write_lock
1752
1215
    def set_last_revision(self, new_revision):
1753
1216
        """Change the last revision in the working tree."""
1754
1217
        if self._change_last_revision(new_revision):
1760
1223
        This is used to allow WorkingTree3 instances to not affect branch
1761
1224
        when their last revision is set.
1762
1225
        """
1763
 
        if _mod_revision.is_null(new_revision):
 
1226
        if new_revision is None:
1764
1227
            self.branch.set_revision_history([])
1765
1228
            return False
1766
1229
        try:
1770
1233
            self.branch.set_revision_history([new_revision])
1771
1234
        return True
1772
1235
 
1773
 
    def _write_basis_inventory(self, xml):
1774
 
        """Write the basis inventory XML to the basis-inventory file"""
1775
 
        assert isinstance(xml, str), 'serialised xml must be bytestring.'
1776
 
        path = self._basis_inventory_name()
1777
 
        sio = StringIO(xml)
1778
 
        self._control_files.put(path, sio)
1779
 
 
1780
 
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
1781
 
        """Create the text that will be saved in basis-inventory"""
1782
 
        inventory.revision_id = revision_id
1783
 
        return xml7.serializer_v7.write_inventory_to_string(inventory)
1784
 
 
1785
1236
    def _cache_basis_inventory(self, new_revision):
1786
1237
        """Cache new_revision as the basis inventory."""
1787
1238
        # TODO: this should allow the ready-to-use inventory to be passed in,
1799
1250
            # root node id can legitimately look like 'revision_id' but cannot
1800
1251
            # contain a '"'.
1801
1252
            xml = self.branch.repository.get_inventory_xml(new_revision)
1802
 
            firstline = xml.split('\n', 1)[0]
1803
 
            if (not 'revision_id="' in firstline or 
1804
 
                'format="7"' not in firstline):
 
1253
            if not 'revision_id="' in xml.split('\n', 1)[0]:
1805
1254
                inv = self.branch.repository.deserialise_inventory(
1806
1255
                    new_revision, xml)
1807
 
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
1808
 
            self._write_basis_inventory(xml)
 
1256
                inv.revision_id = new_revision
 
1257
                xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
 
1258
            assert isinstance(xml, str), 'serialised xml must be bytestring.'
 
1259
            path = self._basis_inventory_name()
 
1260
            sio = StringIO(xml)
 
1261
            self._control_files.put(path, sio)
1809
1262
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1810
1263
            pass
1811
1264
 
1816
1269
        
1817
1270
    @needs_read_lock
1818
1271
    def read_working_inventory(self):
1819
 
        """Read the working inventory.
1820
 
        
1821
 
        :raises errors.InventoryModified: read_working_inventory will fail
1822
 
            when the current in memory inventory has been modified.
1823
 
        """
1824
 
        # conceptually this should be an implementation detail of the tree. 
1825
 
        # XXX: Deprecate this.
 
1272
        """Read the working inventory."""
1826
1273
        # ElementTree does its own conversion from UTF-8, so open in
1827
1274
        # binary.
1828
 
        if self._inventory_is_modified:
1829
 
            raise errors.InventoryModified(self)
1830
 
        result = self._deserialize(self._control_files.get('inventory'))
1831
 
        self._set_inventory(result, dirty=False)
 
1275
        result = bzrlib.xml5.serializer_v5.read_inventory(
 
1276
            self._control_files.get('inventory'))
 
1277
        self._set_inventory(result)
1832
1278
        return result
1833
1279
 
1834
 
    @needs_tree_write_lock
1835
 
    def remove(self, files, verbose=False, to_file=None, keep_files=True,
1836
 
        force=False):
1837
 
        """Remove nominated files from the working inventory.
1838
 
 
1839
 
        :files: File paths relative to the basedir.
1840
 
        :keep_files: If true, the files will also be kept.
1841
 
        :force: Delete files and directories, even if they are changed and
1842
 
            even if the directories are not empty.
 
1280
    @needs_write_lock
 
1281
    def remove(self, files, verbose=False, to_file=None):
 
1282
        """Remove nominated files from the working inventory..
 
1283
 
 
1284
        This does not remove their text.  This does not run on XXX on what? RBC
 
1285
 
 
1286
        TODO: Refuse to remove modified files unless --force is given?
 
1287
 
 
1288
        TODO: Do something useful with directories.
 
1289
 
 
1290
        TODO: Should this remove the text or not?  Tough call; not
 
1291
        removing may be useful and the user can just use use rm, and
 
1292
        is the opposite of add.  Removing it is consistent with most
 
1293
        other tools.  Maybe an option.
1843
1294
        """
 
1295
        ## TODO: Normalize names
 
1296
        ## TODO: Remove nested loops; better scalability
1844
1297
        if isinstance(files, basestring):
1845
1298
            files = [files]
1846
1299
 
1847
 
        inv_delta = []
1848
 
 
1849
 
        new_files=set()
1850
 
        unknown_nested_files=set()
1851
 
 
1852
 
        def recurse_directory_to_add_files(directory):
1853
 
            # Recurse directory and add all files
1854
 
            # so we can check if they have changed.
1855
 
            for parent_info, file_infos in\
1856
 
                osutils.walkdirs(self.abspath(directory),
1857
 
                    directory):
1858
 
                for relpath, basename, kind, lstat, abspath in file_infos:
1859
 
                    # Is it versioned or ignored?
1860
 
                    if self.path2id(relpath) or self.is_ignored(relpath):
1861
 
                        # Add nested content for deletion.
1862
 
                        new_files.add(relpath)
1863
 
                    else:
1864
 
                        # Files which are not versioned and not ignored
1865
 
                        # should be treated as unknown.
1866
 
                        unknown_nested_files.add((relpath, None, kind))
1867
 
 
1868
 
        for filename in files:
1869
 
            # Get file name into canonical form.
1870
 
            abspath = self.abspath(filename)
1871
 
            filename = self.relpath(abspath)
1872
 
            if len(filename) > 0:
1873
 
                new_files.add(filename)
1874
 
                if osutils.isdir(abspath):
1875
 
                    recurse_directory_to_add_files(filename)
1876
 
 
1877
 
        files = list(new_files)
1878
 
 
1879
 
        if len(files) == 0:
1880
 
            return # nothing to do
1881
 
 
1882
 
        # Sort needed to first handle directory content before the directory
1883
 
        files.sort(reverse=True)
1884
 
 
1885
 
        # Bail out if we are going to delete files we shouldn't
1886
 
        if not keep_files and not force:
1887
 
            has_changed_files = len(unknown_nested_files) > 0
1888
 
            if not has_changed_files:
1889
 
                for (file_id, path, content_change, versioned, parent_id, name,
1890
 
                     kind, executable) in self._iter_changes(self.basis_tree(),
1891
 
                         include_unchanged=True, require_versioned=False,
1892
 
                         want_unversioned=True, specific_files=files):
1893
 
                    # Check if it's an unknown (but not ignored) OR
1894
 
                    # changed (but not deleted) :
1895
 
                    if not self.is_ignored(path[1]) and (
1896
 
                        versioned == (False, False) or
1897
 
                        content_change and kind[1] != None):
1898
 
                        has_changed_files = True
1899
 
                        break
1900
 
 
1901
 
            if has_changed_files:
1902
 
                # Make delta show ALL applicable changes in error message.
1903
 
                tree_delta = self.changes_from(self.basis_tree(),
1904
 
                    require_versioned=False, want_unversioned=True,
1905
 
                    specific_files=files)
1906
 
                for unknown_file in unknown_nested_files:
1907
 
                    if unknown_file not in tree_delta.unversioned:
1908
 
                        tree_delta.unversioned.extend((unknown_file,))
1909
 
                raise errors.BzrRemoveChangedFilesError(tree_delta)
1910
 
 
1911
 
        # Build inv_delta and delete files where applicaple,
1912
 
        # do this before any modifications to inventory.
 
1300
        inv = self.inventory
 
1301
 
 
1302
        # do this before any modifications
1913
1303
        for f in files:
1914
 
            fid = self.path2id(f)
1915
 
            message = None
 
1304
            fid = inv.path2id(f)
1916
1305
            if not fid:
1917
 
                message = "%s is not versioned." % (f,)
1918
 
            else:
1919
 
                if verbose:
1920
 
                    # having removed it, it must be either ignored or unknown
1921
 
                    if self.is_ignored(f):
1922
 
                        new_status = 'I'
1923
 
                    else:
1924
 
                        new_status = '?'
1925
 
                    textui.show_status(new_status, self.kind(fid), f,
1926
 
                                       to_file=to_file)
1927
 
                # Unversion file
1928
 
                inv_delta.append((f, None, fid, None))
1929
 
                message = "removed %s" % (f,)
1930
 
 
1931
 
            if not keep_files:
1932
 
                abs_path = self.abspath(f)
1933
 
                if osutils.lexists(abs_path):
1934
 
                    if (osutils.isdir(abs_path) and
1935
 
                        len(os.listdir(abs_path)) > 0):
1936
 
                        if force:
1937
 
                            osutils.rmtree(abs_path)
1938
 
                        else:
1939
 
                            message = "%s is not an empty directory "\
1940
 
                                "and won't be deleted." % (f,)
1941
 
                    else:
1942
 
                        osutils.delete_any(abs_path)
1943
 
                        message = "deleted %s" % (f,)
1944
 
                elif message is not None:
1945
 
                    # Only care if we haven't done anything yet.
1946
 
                    message = "%s does not exist." % (f,)
1947
 
 
1948
 
            # Print only one message (if any) per file.
1949
 
            if message is not None:
1950
 
                note(message)
1951
 
        self.apply_inventory_delta(inv_delta)
1952
 
 
1953
 
    @needs_tree_write_lock
1954
 
    def revert(self, filenames=None, old_tree=None, backups=True,
1955
 
               pb=DummyProgress(), report_changes=False):
1956
 
        from bzrlib.conflicts import resolve
1957
 
        if filenames == []:
1958
 
            filenames = None
1959
 
            symbol_versioning.warn('Using [] to revert all files is deprecated'
1960
 
                ' as of bzr 0.91.  Please use None (the default) instead.',
1961
 
                DeprecationWarning, stacklevel=2)
 
1306
                # TODO: Perhaps make this just a warning, and continue?
 
1307
                # This tends to happen when 
 
1308
                raise NotVersionedError(path=f)
 
1309
            if verbose:
 
1310
                # having remove it, it must be either ignored or unknown
 
1311
                if self.is_ignored(f):
 
1312
                    new_status = 'I'
 
1313
                else:
 
1314
                    new_status = '?'
 
1315
                show_status(new_status, inv[fid].kind, f, to_file=to_file)
 
1316
            del inv[fid]
 
1317
 
 
1318
        self._write_inventory(inv)
 
1319
 
 
1320
    @needs_write_lock
 
1321
    def revert(self, filenames, old_tree=None, backups=True, 
 
1322
               pb=DummyProgress()):
 
1323
        from transform import revert
 
1324
        from conflicts import resolve
1962
1325
        if old_tree is None:
1963
1326
            old_tree = self.basis_tree()
1964
 
        conflicts = transform.revert(self, old_tree, filenames, backups, pb,
1965
 
                                     report_changes)
1966
 
        if filenames is None:
1967
 
            self.set_parent_ids(self.get_parent_ids()[:1])
 
1327
        conflicts = revert(self, old_tree, filenames, backups, pb)
 
1328
        if not len(filenames):
 
1329
            self.set_pending_merges([])
1968
1330
            resolve(self)
1969
1331
        else:
1970
1332
            resolve(self, filenames, ignore_misses=True)
1971
1333
        return conflicts
1972
1334
 
1973
 
    def revision_tree(self, revision_id):
1974
 
        """See Tree.revision_tree.
1975
 
 
1976
 
        WorkingTree can supply revision_trees for the basis revision only
1977
 
        because there is only one cached inventory in the bzr directory.
1978
 
        """
1979
 
        if revision_id == self.last_revision():
1980
 
            try:
1981
 
                xml = self.read_basis_inventory()
1982
 
            except errors.NoSuchFile:
1983
 
                pass
1984
 
            else:
1985
 
                try:
1986
 
                    inv = xml7.serializer_v7.read_inventory_from_string(xml)
1987
 
                    # dont use the repository revision_tree api because we want
1988
 
                    # to supply the inventory.
1989
 
                    if inv.revision_id == revision_id:
1990
 
                        return revisiontree.RevisionTree(self.branch.repository,
1991
 
                            inv, revision_id)
1992
 
                except errors.BadInventoryFormat:
1993
 
                    pass
1994
 
        # raise if there was no inventory, or if we read the wrong inventory.
1995
 
        raise errors.NoSuchRevisionInTree(self, revision_id)
1996
 
 
1997
1335
    # XXX: This method should be deprecated in favour of taking in a proper
1998
1336
    # new Inventory object.
1999
 
    @needs_tree_write_lock
 
1337
    @needs_write_lock
2000
1338
    def set_inventory(self, new_inventory_list):
2001
1339
        from bzrlib.inventory import (Inventory,
2002
1340
                                      InventoryDirectory,
2016
1354
            elif kind == 'symlink':
2017
1355
                inv.add(InventoryLink(file_id, name, parent))
2018
1356
            else:
2019
 
                raise errors.BzrError("unknown kind %r" % kind)
 
1357
                raise BzrError("unknown kind %r" % kind)
2020
1358
        self._write_inventory(inv)
2021
1359
 
2022
 
    @needs_tree_write_lock
 
1360
    @needs_write_lock
2023
1361
    def set_root_id(self, file_id):
2024
1362
        """Set the root id for this tree."""
2025
 
        # for compatability 
2026
 
        if file_id is None:
2027
 
            symbol_versioning.warn(symbol_versioning.zero_twelve
2028
 
                % 'WorkingTree.set_root_id with fileid=None',
2029
 
                DeprecationWarning,
2030
 
                stacklevel=3)
2031
 
            file_id = ROOT_ID
2032
 
        else:
2033
 
            file_id = osutils.safe_file_id(file_id)
2034
 
        self._set_root_id(file_id)
2035
 
 
2036
 
    def _set_root_id(self, file_id):
2037
 
        """Set the root id for this tree, in a format specific manner.
2038
 
 
2039
 
        :param file_id: The file id to assign to the root. It must not be 
2040
 
            present in the current inventory or an error will occur. It must
2041
 
            not be None, but rather a valid file id.
2042
 
        """
2043
 
        inv = self._inventory
 
1363
        inv = self.read_working_inventory()
2044
1364
        orig_root_id = inv.root.file_id
2045
 
        # TODO: it might be nice to exit early if there was nothing
2046
 
        # to do, saving us from trigger a sync on unlock.
2047
 
        self._inventory_is_modified = True
2048
 
        # we preserve the root inventory entry object, but
2049
 
        # unlinkit from the byid index
2050
1365
        del inv._byid[inv.root.file_id]
2051
1366
        inv.root.file_id = file_id
2052
 
        # and link it into the index with the new changed id.
2053
1367
        inv._byid[inv.root.file_id] = inv.root
2054
 
        # and finally update all children to reference the new id.
2055
 
        # XXX: this should be safe to just look at the root.children
2056
 
        # list, not the WHOLE INVENTORY.
2057
1368
        for fid in inv:
2058
1369
            entry = inv[fid]
2059
1370
            if entry.parent_id == orig_root_id:
2060
1371
                entry.parent_id = inv.root.file_id
 
1372
        self._write_inventory(inv)
2061
1373
 
2062
1374
    def unlock(self):
2063
1375
        """See Branch.unlock.
2070
1382
        """
2071
1383
        raise NotImplementedError(self.unlock)
2072
1384
 
2073
 
    def update(self, change_reporter=None, possible_transports=None):
 
1385
    @needs_write_lock
 
1386
    def update(self):
2074
1387
        """Update a working tree along its branch.
2075
1388
 
2076
 
        This will update the branch if its bound too, which means we have
2077
 
        multiple trees involved:
2078
 
 
2079
 
        - The new basis tree of the master.
2080
 
        - The old basis tree of the branch.
2081
 
        - The old basis tree of the working tree.
2082
 
        - The current working tree state.
2083
 
 
2084
 
        Pathologically, all three may be different, and non-ancestors of each
2085
 
        other.  Conceptually we want to:
2086
 
 
2087
 
        - Preserve the wt.basis->wt.state changes
2088
 
        - Transform the wt.basis to the new master basis.
2089
 
        - Apply a merge of the old branch basis to get any 'local' changes from
2090
 
          it into the tree.
2091
 
        - Restore the wt.basis->wt.state changes.
 
1389
        This will update the branch if its bound too, which means we have multiple trees involved:
 
1390
        The new basis tree of the master.
 
1391
        The old basis tree of the branch.
 
1392
        The old basis tree of the working tree.
 
1393
        The current working tree state.
 
1394
        pathologically all three may be different, and non ancestors of each other.
 
1395
        Conceptually we want to:
 
1396
        Preserve the wt.basis->wt.state changes
 
1397
        Transform the wt.basis to the new master basis.
 
1398
        Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
 
1399
        Restore the wt.basis->wt.state changes.
2092
1400
 
2093
1401
        There isn't a single operation at the moment to do that, so we:
2094
 
        - Merge current state -> basis tree of the master w.r.t. the old tree
2095
 
          basis.
2096
 
        - Do a 'normal' merge of the old branch basis if it is relevant.
2097
 
        """
2098
 
        if self.branch.get_master_branch(possible_transports) is not None:
2099
 
            self.lock_write()
2100
 
            update_branch = True
2101
 
        else:
2102
 
            self.lock_tree_write()
2103
 
            update_branch = False
2104
 
        try:
2105
 
            if update_branch:
2106
 
                old_tip = self.branch.update(possible_transports)
2107
 
            else:
2108
 
                old_tip = None
2109
 
            return self._update_tree(old_tip, change_reporter)
2110
 
        finally:
2111
 
            self.unlock()
2112
 
 
2113
 
    @needs_tree_write_lock
2114
 
    def _update_tree(self, old_tip=None, change_reporter=None):
2115
 
        """Update a tree to the master branch.
2116
 
 
2117
 
        :param old_tip: if supplied, the previous tip revision the branch,
2118
 
            before it was changed to the master branch's tip.
2119
 
        """
2120
 
        # here if old_tip is not None, it is the old tip of the branch before
2121
 
        # it was updated from the master branch. This should become a pending
2122
 
        # merge in the working tree to preserve the user existing work.  we
2123
 
        # cant set that until we update the working trees last revision to be
2124
 
        # one from the new branch, because it will just get absorbed by the
2125
 
        # parent de-duplication logic.
2126
 
        # 
2127
 
        # We MUST save it even if an error occurs, because otherwise the users
2128
 
        # local work is unreferenced and will appear to have been lost.
2129
 
        # 
2130
 
        result = 0
2131
 
        try:
2132
 
            last_rev = self.get_parent_ids()[0]
2133
 
        except IndexError:
2134
 
            last_rev = _mod_revision.NULL_REVISION
2135
 
        if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2136
 
            # merge tree state up to new branch tip.
2137
 
            basis = self.basis_tree()
2138
 
            basis.lock_read()
2139
 
            try:
 
1402
        Merge current state -> basis tree of the master w.r.t. the old tree basis.
 
1403
        Do a 'normal' merge of the old branch basis if it is relevant.
 
1404
        """
 
1405
        old_tip = self.branch.update()
 
1406
        if old_tip is not None:
 
1407
            self.add_pending_merge(old_tip)
 
1408
        self.branch.lock_read()
 
1409
        try:
 
1410
            result = 0
 
1411
            if self.last_revision() != self.branch.last_revision():
 
1412
                # merge tree state up to new branch tip.
 
1413
                basis = self.basis_tree()
2140
1414
                to_tree = self.branch.basis_tree()
2141
 
                if basis.inventory.root is None:
2142
 
                    self.set_root_id(to_tree.inventory.root.file_id)
2143
 
                    self.flush()
2144
 
                result += merge.merge_inner(
2145
 
                                      self.branch,
 
1415
                result += merge_inner(self.branch,
2146
1416
                                      to_tree,
2147
1417
                                      basis,
2148
 
                                      this_tree=self,
2149
 
                                      change_reporter=change_reporter)
2150
 
            finally:
2151
 
                basis.unlock()
2152
 
            # TODO - dedup parents list with things merged by pull ?
2153
 
            # reuse the tree we've updated to to set the basis:
2154
 
            parent_trees = [(self.branch.last_revision(), to_tree)]
2155
 
            merges = self.get_parent_ids()[1:]
2156
 
            # Ideally we ask the tree for the trees here, that way the working
2157
 
            # tree can decide whether to give us teh entire tree or give us a
2158
 
            # lazy initialised tree. dirstate for instance will have the trees
2159
 
            # in ram already, whereas a last-revision + basis-inventory tree
2160
 
            # will not, but also does not need them when setting parents.
2161
 
            for parent in merges:
2162
 
                parent_trees.append(
2163
 
                    (parent, self.branch.repository.revision_tree(parent)))
2164
 
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2165
 
                parent_trees.append(
2166
 
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
2167
 
            self.set_parent_trees(parent_trees)
2168
 
            last_rev = parent_trees[0][0]
2169
 
        else:
2170
 
            # the working tree had the same last-revision as the master
2171
 
            # branch did. We may still have pivot local work from the local
2172
 
            # branch into old_tip:
2173
 
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2174
 
                self.add_parent_tree_id(old_tip)
2175
 
        if (old_tip is not None and not _mod_revision.is_null(old_tip)
2176
 
            and old_tip != last_rev):
2177
 
            # our last revision was not the prior branch last revision
2178
 
            # and we have converted that last revision to a pending merge.
2179
 
            # base is somewhere between the branch tip now
2180
 
            # and the now pending merge
2181
 
 
2182
 
            # Since we just modified the working tree and inventory, flush out
2183
 
            # the current state, before we modify it again.
2184
 
            # TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2185
 
            #       requires it only because TreeTransform directly munges the
2186
 
            #       inventory and calls tree._write_inventory(). Ultimately we
2187
 
            #       should be able to remove this extra flush.
2188
 
            self.flush()
2189
 
            graph = self.branch.repository.get_graph()
2190
 
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2191
 
                                                old_tip)
2192
 
            base_tree = self.branch.repository.revision_tree(base_rev_id)
2193
 
            other_tree = self.branch.repository.revision_tree(old_tip)
2194
 
            result += merge.merge_inner(
2195
 
                                  self.branch,
2196
 
                                  other_tree,
2197
 
                                  base_tree,
2198
 
                                  this_tree=self,
2199
 
                                  change_reporter=change_reporter)
2200
 
        return result
2201
 
 
2202
 
    def _write_hashcache_if_dirty(self):
2203
 
        """Write out the hashcache if it is dirty."""
2204
 
        if self._hashcache.needs_write:
2205
 
            try:
2206
 
                self._hashcache.write()
2207
 
            except OSError, e:
2208
 
                if e.errno not in (errno.EPERM, errno.EACCES):
2209
 
                    raise
2210
 
                # TODO: jam 20061219 Should this be a warning? A single line
2211
 
                #       warning might be sufficient to let the user know what
2212
 
                #       is going on.
2213
 
                mutter('Could not write hashcache for %s\nError: %s',
2214
 
                       self._hashcache.cache_file_name(), e)
2215
 
 
2216
 
    @needs_tree_write_lock
 
1418
                                      this_tree=self)
 
1419
                self.set_last_revision(self.branch.last_revision())
 
1420
            if old_tip and old_tip != self.last_revision():
 
1421
                # our last revision was not the prior branch last revision
 
1422
                # and we have converted that last revision to a pending merge.
 
1423
                # base is somewhere between the branch tip now
 
1424
                # and the now pending merge
 
1425
                from bzrlib.revision import common_ancestor
 
1426
                try:
 
1427
                    base_rev_id = common_ancestor(self.branch.last_revision(),
 
1428
                                                  old_tip,
 
1429
                                                  self.branch.repository)
 
1430
                except errors.NoCommonAncestor:
 
1431
                    base_rev_id = None
 
1432
                base_tree = self.branch.repository.revision_tree(base_rev_id)
 
1433
                other_tree = self.branch.repository.revision_tree(old_tip)
 
1434
                result += merge_inner(self.branch,
 
1435
                                      other_tree,
 
1436
                                      base_tree,
 
1437
                                      this_tree=self)
 
1438
            return result
 
1439
        finally:
 
1440
            self.branch.unlock()
 
1441
 
 
1442
    @needs_write_lock
2217
1443
    def _write_inventory(self, inv):
2218
1444
        """Write inventory as the current inventory."""
2219
 
        self._set_inventory(inv, dirty=True)
2220
 
        self.flush()
 
1445
        sio = StringIO()
 
1446
        bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
 
1447
        sio.seek(0)
 
1448
        self._control_files.put('inventory', sio)
 
1449
        self._set_inventory(inv)
 
1450
        mutter('wrote working inventory')
2221
1451
 
2222
1452
    def set_conflicts(self, arg):
2223
 
        raise errors.UnsupportedOperation(self.set_conflicts, self)
 
1453
        raise UnsupportedOperation(self.set_conflicts, self)
2224
1454
 
2225
1455
    def add_conflicts(self, arg):
2226
 
        raise errors.UnsupportedOperation(self.add_conflicts, self)
 
1456
        raise UnsupportedOperation(self.add_conflicts, self)
2227
1457
 
2228
1458
    @needs_read_lock
2229
1459
    def conflicts(self):
2230
 
        conflicts = _mod_conflicts.ConflictList()
 
1460
        conflicts = ConflictList()
2231
1461
        for conflicted in self._iter_conflicts():
2232
1462
            text = True
2233
1463
            try:
2246
1476
                    if text == False:
2247
1477
                        break
2248
1478
            ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2249
 
            conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2250
 
                             path=conflicted,
 
1479
            conflicts.append(Conflict.factory(ctype, path=conflicted,
2251
1480
                             file_id=self.path2id(conflicted)))
2252
1481
        return conflicts
2253
1482
 
2254
 
    def walkdirs(self, prefix=""):
2255
 
        """Walk the directories of this tree.
2256
 
 
2257
 
        returns a generator which yields items in the form:
2258
 
                ((curren_directory_path, fileid),
2259
 
                 [(file1_path, file1_name, file1_kind, (lstat), file1_id,
2260
 
                   file1_kind), ... ])
2261
 
 
2262
 
        This API returns a generator, which is only valid during the current
2263
 
        tree transaction - within a single lock_read or lock_write duration.
2264
 
 
2265
 
        If the tree is not locked, it may cause an error to be raised,
2266
 
        depending on the tree implementation.
2267
 
        """
2268
 
        disk_top = self.abspath(prefix)
2269
 
        if disk_top.endswith('/'):
2270
 
            disk_top = disk_top[:-1]
2271
 
        top_strip_len = len(disk_top) + 1
2272
 
        inventory_iterator = self._walkdirs(prefix)
2273
 
        disk_iterator = osutils.walkdirs(disk_top, prefix)
2274
 
        try:
2275
 
            current_disk = disk_iterator.next()
2276
 
            disk_finished = False
2277
 
        except OSError, e:
2278
 
            if not (e.errno == errno.ENOENT or
2279
 
                (sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2280
 
                raise
2281
 
            current_disk = None
2282
 
            disk_finished = True
2283
 
        try:
2284
 
            current_inv = inventory_iterator.next()
2285
 
            inv_finished = False
2286
 
        except StopIteration:
2287
 
            current_inv = None
2288
 
            inv_finished = True
2289
 
        while not inv_finished or not disk_finished:
2290
 
            if not disk_finished:
2291
 
                # strip out .bzr dirs
2292
 
                if current_disk[0][1][top_strip_len:] == '':
2293
 
                    # osutils.walkdirs can be made nicer - 
2294
 
                    # yield the path-from-prefix rather than the pathjoined
2295
 
                    # value.
2296
 
                    bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
2297
 
                    if current_disk[1][bzrdir_loc][0] == '.bzr':
2298
 
                        # we dont yield the contents of, or, .bzr itself.
2299
 
                        del current_disk[1][bzrdir_loc]
2300
 
            if inv_finished:
2301
 
                # everything is unknown
2302
 
                direction = 1
2303
 
            elif disk_finished:
2304
 
                # everything is missing
2305
 
                direction = -1
2306
 
            else:
2307
 
                direction = cmp(current_inv[0][0], current_disk[0][0])
2308
 
            if direction > 0:
2309
 
                # disk is before inventory - unknown
2310
 
                dirblock = [(relpath, basename, kind, stat, None, None) for
2311
 
                    relpath, basename, kind, stat, top_path in current_disk[1]]
2312
 
                yield (current_disk[0][0], None), dirblock
2313
 
                try:
2314
 
                    current_disk = disk_iterator.next()
2315
 
                except StopIteration:
2316
 
                    disk_finished = True
2317
 
            elif direction < 0:
2318
 
                # inventory is before disk - missing.
2319
 
                dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2320
 
                    for relpath, basename, dkind, stat, fileid, kind in 
2321
 
                    current_inv[1]]
2322
 
                yield (current_inv[0][0], current_inv[0][1]), dirblock
2323
 
                try:
2324
 
                    current_inv = inventory_iterator.next()
2325
 
                except StopIteration:
2326
 
                    inv_finished = True
2327
 
            else:
2328
 
                # versioned present directory
2329
 
                # merge the inventory and disk data together
2330
 
                dirblock = []
2331
 
                for relpath, subiterator in itertools.groupby(sorted(
2332
 
                    current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2333
 
                    path_elements = list(subiterator)
2334
 
                    if len(path_elements) == 2:
2335
 
                        inv_row, disk_row = path_elements
2336
 
                        # versioned, present file
2337
 
                        dirblock.append((inv_row[0],
2338
 
                            inv_row[1], disk_row[2],
2339
 
                            disk_row[3], inv_row[4],
2340
 
                            inv_row[5]))
2341
 
                    elif len(path_elements[0]) == 5:
2342
 
                        # unknown disk file
2343
 
                        dirblock.append((path_elements[0][0],
2344
 
                            path_elements[0][1], path_elements[0][2],
2345
 
                            path_elements[0][3], None, None))
2346
 
                    elif len(path_elements[0]) == 6:
2347
 
                        # versioned, absent file.
2348
 
                        dirblock.append((path_elements[0][0],
2349
 
                            path_elements[0][1], 'unknown', None,
2350
 
                            path_elements[0][4], path_elements[0][5]))
2351
 
                    else:
2352
 
                        raise NotImplementedError('unreachable code')
2353
 
                yield current_inv[0], dirblock
2354
 
                try:
2355
 
                    current_inv = inventory_iterator.next()
2356
 
                except StopIteration:
2357
 
                    inv_finished = True
2358
 
                try:
2359
 
                    current_disk = disk_iterator.next()
2360
 
                except StopIteration:
2361
 
                    disk_finished = True
2362
 
 
2363
 
    def _walkdirs(self, prefix=""):
2364
 
        """Walk the directories of this tree.
2365
 
 
2366
 
           :prefix: is used as the directrory to start with.
2367
 
           returns a generator which yields items in the form:
2368
 
                ((curren_directory_path, fileid),
2369
 
                 [(file1_path, file1_name, file1_kind, None, file1_id,
2370
 
                   file1_kind), ... ])
2371
 
        """
2372
 
        _directory = 'directory'
2373
 
        # get the root in the inventory
2374
 
        inv = self.inventory
2375
 
        top_id = inv.path2id(prefix)
2376
 
        if top_id is None:
2377
 
            pending = []
2378
 
        else:
2379
 
            pending = [(prefix, '', _directory, None, top_id, None)]
2380
 
        while pending:
2381
 
            dirblock = []
2382
 
            currentdir = pending.pop()
2383
 
            # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2384
 
            top_id = currentdir[4]
2385
 
            if currentdir[0]:
2386
 
                relroot = currentdir[0] + '/'
2387
 
            else:
2388
 
                relroot = ""
2389
 
            # FIXME: stash the node in pending
2390
 
            entry = inv[top_id]
2391
 
            for name, child in entry.sorted_children():
2392
 
                dirblock.append((relroot + name, name, child.kind, None,
2393
 
                    child.file_id, child.kind
2394
 
                    ))
2395
 
            yield (currentdir[0], entry.file_id), dirblock
2396
 
            # push the user specified dirs from dirblock
2397
 
            for dir in reversed(dirblock):
2398
 
                if dir[2] == _directory:
2399
 
                    pending.append(dir)
2400
 
 
2401
 
    @needs_tree_write_lock
2402
 
    def auto_resolve(self):
2403
 
        """Automatically resolve text conflicts according to contents.
2404
 
 
2405
 
        Only text conflicts are auto_resolvable. Files with no conflict markers
2406
 
        are considered 'resolved', because bzr always puts conflict markers
2407
 
        into files that have text conflicts.  The corresponding .THIS .BASE and
2408
 
        .OTHER files are deleted, as per 'resolve'.
2409
 
        :return: a tuple of ConflictLists: (un_resolved, resolved).
2410
 
        """
2411
 
        un_resolved = _mod_conflicts.ConflictList()
2412
 
        resolved = _mod_conflicts.ConflictList()
2413
 
        conflict_re = re.compile('^(<{7}|={7}|>{7})')
2414
 
        for conflict in self.conflicts():
2415
 
            if (conflict.typestring != 'text conflict' or
2416
 
                self.kind(conflict.file_id) != 'file'):
2417
 
                un_resolved.append(conflict)
2418
 
                continue
2419
 
            my_file = open(self.id2abspath(conflict.file_id), 'rb')
2420
 
            try:
2421
 
                for line in my_file:
2422
 
                    if conflict_re.search(line):
2423
 
                        un_resolved.append(conflict)
2424
 
                        break
2425
 
                else:
2426
 
                    resolved.append(conflict)
2427
 
            finally:
2428
 
                my_file.close()
2429
 
        resolved.remove_files(self)
2430
 
        self.set_conflicts(un_resolved)
2431
 
        return un_resolved, resolved
2432
 
 
2433
 
    def _validate(self):
2434
 
        """Validate internal structures.
2435
 
 
2436
 
        This is meant mostly for the test suite. To give it a chance to detect
2437
 
        corruption after actions have occurred. The default implementation is a
2438
 
        just a no-op.
2439
 
 
2440
 
        :return: None. An exception should be raised if there is an error.
2441
 
        """
2442
 
        return
2443
 
 
2444
1483
 
2445
1484
class WorkingTree2(WorkingTree):
2446
1485
    """This is the Format 2 working tree.
2450
1489
     - uses the branch last-revision.
2451
1490
    """
2452
1491
 
2453
 
    def __init__(self, *args, **kwargs):
2454
 
        super(WorkingTree2, self).__init__(*args, **kwargs)
2455
 
        # WorkingTree2 has more of a constraint that self._inventory must
2456
 
        # exist. Because this is an older format, we don't mind the overhead
2457
 
        # caused by the extra computation here.
2458
 
 
2459
 
        # Newer WorkingTree's should only have self._inventory set when they
2460
 
        # have a read lock.
2461
 
        if self._inventory is None:
2462
 
            self.read_working_inventory()
2463
 
 
2464
 
    def lock_tree_write(self):
2465
 
        """See WorkingTree.lock_tree_write().
2466
 
 
2467
 
        In Format2 WorkingTrees we have a single lock for the branch and tree
2468
 
        so lock_tree_write() degrades to lock_write().
2469
 
        """
2470
 
        self.branch.lock_write()
2471
 
        try:
2472
 
            return self._control_files.lock_write()
2473
 
        except:
2474
 
            self.branch.unlock()
2475
 
            raise
2476
 
 
2477
1492
    def unlock(self):
2478
 
        # do non-implementation specific cleanup
2479
 
        self._cleanup()
2480
 
 
2481
1493
        # we share control files:
2482
 
        if self._control_files._lock_count == 3:
2483
 
            # _inventory_is_modified is always False during a read lock.
2484
 
            if self._inventory_is_modified:
2485
 
                self.flush()
2486
 
            self._write_hashcache_if_dirty()
2487
 
                    
 
1494
        if self._hashcache.needs_write and self._control_files._lock_count==3:
 
1495
            self._hashcache.write()
2488
1496
        # reverse order of locking.
2489
1497
        try:
2490
1498
            return self._control_files.unlock()
2503
1511
    """
2504
1512
 
2505
1513
    @needs_read_lock
2506
 
    def _last_revision(self):
2507
 
        """See Mutable.last_revision."""
 
1514
    def last_revision(self):
 
1515
        """See WorkingTree.last_revision."""
2508
1516
        try:
2509
 
            return self._control_files.get('last-revision').read()
2510
 
        except errors.NoSuchFile:
2511
 
            return _mod_revision.NULL_REVISION
 
1517
            return self._control_files.get_utf8('last-revision').read()
 
1518
        except NoSuchFile:
 
1519
            return None
2512
1520
 
2513
1521
    def _change_last_revision(self, revision_id):
2514
1522
        """See WorkingTree._change_last_revision."""
2519
1527
                pass
2520
1528
            return False
2521
1529
        else:
2522
 
            self._control_files.put_bytes('last-revision', revision_id)
 
1530
            self._control_files.put_utf8('last-revision', revision_id)
2523
1531
            return True
2524
1532
 
2525
 
    @needs_tree_write_lock
 
1533
    @needs_write_lock
2526
1534
    def set_conflicts(self, conflicts):
2527
1535
        self._put_rio('conflicts', conflicts.to_stanzas(), 
2528
1536
                      CONFLICT_HEADER_1)
2529
1537
 
2530
 
    @needs_tree_write_lock
 
1538
    @needs_write_lock
2531
1539
    def add_conflicts(self, new_conflicts):
2532
1540
        conflict_set = set(self.conflicts())
2533
1541
        conflict_set.update(set(list(new_conflicts)))
2534
 
        self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2535
 
                                       key=_mod_conflicts.Conflict.sort_key)))
 
1542
        self.set_conflicts(ConflictList(sorted(conflict_set,
 
1543
                                               key=Conflict.sort_key)))
2536
1544
 
2537
1545
    @needs_read_lock
2538
1546
    def conflicts(self):
2539
1547
        try:
2540
1548
            confile = self._control_files.get('conflicts')
2541
 
        except errors.NoSuchFile:
2542
 
            return _mod_conflicts.ConflictList()
 
1549
        except NoSuchFile:
 
1550
            return ConflictList()
2543
1551
        try:
2544
1552
            if confile.next() != CONFLICT_HEADER_1 + '\n':
2545
 
                raise errors.ConflictFormatError()
 
1553
                raise ConflictFormatError()
2546
1554
        except StopIteration:
2547
 
            raise errors.ConflictFormatError()
2548
 
        return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
 
1555
            raise ConflictFormatError()
 
1556
        return ConflictList.from_stanzas(RioReader(confile))
2549
1557
 
2550
1558
    def unlock(self):
2551
 
        # do non-implementation specific cleanup
2552
 
        self._cleanup()
2553
 
        if self._control_files._lock_count == 1:
2554
 
            # _inventory_is_modified is always False during a read lock.
2555
 
            if self._inventory_is_modified:
2556
 
                self.flush()
2557
 
            self._write_hashcache_if_dirty()
 
1559
        if self._hashcache.needs_write and self._control_files._lock_count==1:
 
1560
            self._hashcache.write()
2558
1561
        # reverse order of locking.
2559
1562
        try:
2560
1563
            return self._control_files.unlock()
2563
1566
 
2564
1567
 
2565
1568
def get_conflicted_stem(path):
2566
 
    for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
 
1569
    for suffix in CONFLICT_SUFFIXES:
2567
1570
        if path.endswith(suffix):
2568
1571
            return path[:-len(suffix)]
2569
1572
 
2570
 
 
2571
1573
@deprecated_function(zero_eight)
2572
1574
def is_control_file(filename):
2573
1575
    """See WorkingTree.is_control_filename(filename)."""
2608
1610
    _formats = {}
2609
1611
    """The known formats."""
2610
1612
 
2611
 
    requires_rich_root = False
2612
 
 
2613
 
    upgrade_recommended = False
2614
 
 
2615
1613
    @classmethod
2616
1614
    def find_format(klass, a_bzrdir):
2617
1615
        """Return the format for the working tree object in a_bzrdir."""
2619
1617
            transport = a_bzrdir.get_workingtree_transport(None)
2620
1618
            format_string = transport.get("format").read()
2621
1619
            return klass._formats[format_string]
2622
 
        except errors.NoSuchFile:
 
1620
        except NoSuchFile:
2623
1621
            raise errors.NoWorkingTree(base=transport.base)
2624
1622
        except KeyError:
2625
1623
            raise errors.UnknownFormatError(format=format_string)
2626
1624
 
2627
 
    def __eq__(self, other):
2628
 
        return self.__class__ is other.__class__
2629
 
 
2630
 
    def __ne__(self, other):
2631
 
        return not (self == other)
2632
 
 
2633
1625
    @classmethod
2634
1626
    def get_default_format(klass):
2635
1627
        """Return the current default format."""
2666
1658
        del klass._formats[format.get_format_string()]
2667
1659
 
2668
1660
 
 
1661
 
2669
1662
class WorkingTreeFormat2(WorkingTreeFormat):
2670
1663
    """The second working tree format. 
2671
1664
 
2672
1665
    This format modified the hash cache from the format 1 hash cache.
2673
1666
    """
2674
1667
 
2675
 
    upgrade_recommended = True
2676
 
 
2677
1668
    def get_format_description(self):
2678
1669
        """See WorkingTreeFormat.get_format_description()."""
2679
1670
        return "Working tree format 2"
2687
1678
        """
2688
1679
        sio = StringIO()
2689
1680
        inv = Inventory()
2690
 
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
 
1681
        bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
2691
1682
        sio.seek(0)
2692
1683
        control_files.put('inventory', sio)
2693
1684
 
2694
 
        control_files.put_bytes('pending-merges', '')
 
1685
        control_files.put_utf8('pending-merges', '')
2695
1686
        
2696
1687
 
2697
1688
    def initialize(self, a_bzrdir, revision_id=None):
2699
1690
        if not isinstance(a_bzrdir.transport, LocalTransport):
2700
1691
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2701
1692
        branch = a_bzrdir.open_branch()
2702
 
        if revision_id is None:
2703
 
            revision_id = _mod_revision.ensure_null(branch.last_revision())
2704
 
        branch.lock_write()
2705
 
        try:
2706
 
            branch.generate_revision_history(revision_id)
2707
 
        finally:
2708
 
            branch.unlock()
2709
 
        inv = Inventory()
 
1693
        if revision_id is not None:
 
1694
            branch.lock_write()
 
1695
            try:
 
1696
                revision_history = branch.revision_history()
 
1697
                try:
 
1698
                    position = revision_history.index(revision_id)
 
1699
                except ValueError:
 
1700
                    raise errors.NoSuchRevision(branch, revision_id)
 
1701
                branch.set_revision_history(revision_history[:position + 1])
 
1702
            finally:
 
1703
                branch.unlock()
 
1704
        revision = branch.last_revision()
 
1705
        inv = Inventory() 
2710
1706
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2711
1707
                         branch,
2712
1708
                         inv,
2713
1709
                         _internal=True,
2714
1710
                         _format=self,
2715
1711
                         _bzrdir=a_bzrdir)
2716
 
        basis_tree = branch.repository.revision_tree(revision_id)
2717
 
        if basis_tree.inventory.root is not None:
2718
 
            wt.set_root_id(basis_tree.inventory.root.file_id)
2719
 
        # set the parent list and cache the basis tree.
2720
 
        if _mod_revision.is_null(revision_id):
2721
 
            parent_trees = []
2722
 
        else:
2723
 
            parent_trees = [(revision_id, basis_tree)]
2724
 
        wt.set_parent_trees(parent_trees)
2725
 
        transform.build_tree(basis_tree, wt)
 
1712
        wt._write_inventory(inv)
 
1713
        wt.set_root_id(inv.root.file_id)
 
1714
        wt.set_last_revision(revision)
 
1715
        wt.set_pending_merges([])
 
1716
        build_tree(wt.basis_tree(), wt)
2726
1717
        return wt
2727
1718
 
2728
1719
    def __init__(self):
2740
1731
            raise NotImplementedError
2741
1732
        if not isinstance(a_bzrdir.transport, LocalTransport):
2742
1733
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2743
 
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
 
1734
        return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2744
1735
                           _internal=True,
2745
1736
                           _format=self,
2746
1737
                           _bzrdir=a_bzrdir)
2747
 
        return wt
 
1738
 
2748
1739
 
2749
1740
class WorkingTreeFormat3(WorkingTreeFormat):
2750
1741
    """The second working tree format updated to record a format marker.
2757
1748
        - is new in bzr 0.8
2758
1749
        - uses a LockDir to guard access for writes.
2759
1750
    """
2760
 
    
2761
 
    upgrade_recommended = True
2762
1751
 
2763
1752
    def get_format_string(self):
2764
1753
        """See WorkingTreeFormat.get_format_string()."""
2771
1760
    _lock_file_name = 'lock'
2772
1761
    _lock_class = LockDir
2773
1762
 
2774
 
    _tree_class = WorkingTree3
2775
 
 
2776
 
    def __get_matchingbzrdir(self):
2777
 
        return bzrdir.BzrDirMetaFormat1()
2778
 
 
2779
 
    _matchingbzrdir = property(__get_matchingbzrdir)
2780
 
 
2781
1763
    def _open_control_files(self, a_bzrdir):
2782
1764
        transport = a_bzrdir.get_workingtree_transport(None)
2783
1765
        return LockableFiles(transport, self._lock_file_name, 
2798
1780
        control_files.put_utf8('format', self.get_format_string())
2799
1781
        branch = a_bzrdir.open_branch()
2800
1782
        if revision_id is None:
2801
 
            revision_id = _mod_revision.ensure_null(branch.last_revision())
2802
 
        # WorkingTree3 can handle an inventory which has a unique root id.
2803
 
        # as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2804
 
        # those trees. And because there isn't a format bump inbetween, we
2805
 
        # are maintaining compatibility with older clients.
2806
 
        # inv = Inventory(root_id=gen_root_id())
2807
 
        inv = self._initial_inventory()
2808
 
        wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
 
1783
            revision_id = branch.last_revision()
 
1784
        inv = Inventory() 
 
1785
        wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2809
1786
                         branch,
2810
1787
                         inv,
2811
1788
                         _internal=True,
2812
1789
                         _format=self,
2813
1790
                         _bzrdir=a_bzrdir,
2814
1791
                         _control_files=control_files)
2815
 
        wt.lock_tree_write()
 
1792
        wt.lock_write()
2816
1793
        try:
2817
 
            basis_tree = branch.repository.revision_tree(revision_id)
2818
 
            # only set an explicit root id if there is one to set.
2819
 
            if basis_tree.inventory.root is not None:
2820
 
                wt.set_root_id(basis_tree.inventory.root.file_id)
2821
 
            if revision_id == NULL_REVISION:
2822
 
                wt.set_parent_trees([])
2823
 
            else:
2824
 
                wt.set_parent_trees([(revision_id, basis_tree)])
2825
 
            transform.build_tree(basis_tree, wt)
 
1794
            wt._write_inventory(inv)
 
1795
            wt.set_root_id(inv.root.file_id)
 
1796
            wt.set_last_revision(revision_id)
 
1797
            wt.set_pending_merges([])
 
1798
            build_tree(wt.basis_tree(), wt)
2826
1799
        finally:
2827
 
            # Unlock in this order so that the unlock-triggers-flush in
2828
 
            # WorkingTree is given a chance to fire.
 
1800
            wt.unlock()
2829
1801
            control_files.unlock()
2830
 
            wt.unlock()
2831
1802
        return wt
2832
1803
 
2833
 
    def _initial_inventory(self):
2834
 
        return Inventory()
2835
 
 
2836
1804
    def __init__(self):
2837
1805
        super(WorkingTreeFormat3, self).__init__()
 
1806
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2838
1807
 
2839
1808
    def open(self, a_bzrdir, _found=False):
2840
1809
        """Return the WorkingTree object for a_bzrdir
2847
1816
            raise NotImplementedError
2848
1817
        if not isinstance(a_bzrdir.transport, LocalTransport):
2849
1818
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2850
 
        wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2851
 
        return wt
 
1819
        return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2852
1820
 
2853
1821
    def _open(self, a_bzrdir, control_files):
2854
1822
        """Open the tree itself.
2856
1824
        :param a_bzrdir: the dir for the tree.
2857
1825
        :param control_files: the control files for the tree.
2858
1826
        """
2859
 
        return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2860
 
                                _internal=True,
2861
 
                                _format=self,
2862
 
                                _bzrdir=a_bzrdir,
2863
 
                                _control_files=control_files)
 
1827
        return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
 
1828
                           _internal=True,
 
1829
                           _format=self,
 
1830
                           _bzrdir=a_bzrdir,
 
1831
                           _control_files=control_files)
2864
1832
 
2865
1833
    def __str__(self):
2866
1834
        return self.get_format_string()
2867
1835
 
2868
1836
 
2869
 
__default_format = WorkingTreeFormat4()
 
1837
# formats which have no format string are not discoverable
 
1838
# and not independently creatable, so are not registered.
 
1839
__default_format = WorkingTreeFormat3()
2870
1840
WorkingTreeFormat.register_format(__default_format)
2871
 
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2872
1841
WorkingTreeFormat.set_default_format(__default_format)
2873
 
# formats which have no format string are not discoverable
2874
 
# and not independently creatable, so are not registered.
2875
1842
_legacy_formats = [WorkingTreeFormat2(),
2876
1843
                   ]
 
1844
 
 
1845
 
 
1846
class WorkingTreeTestProviderAdapter(object):
 
1847
    """A tool to generate a suite testing multiple workingtree formats at once.
 
1848
 
 
1849
    This is done by copying the test once for each transport and injecting
 
1850
    the transport_server, transport_readonly_server, and workingtree_format
 
1851
    classes into each copy. Each copy is also given a new id() to make it
 
1852
    easy to identify.
 
1853
    """
 
1854
 
 
1855
    def __init__(self, transport_server, transport_readonly_server, formats):
 
1856
        self._transport_server = transport_server
 
1857
        self._transport_readonly_server = transport_readonly_server
 
1858
        self._formats = formats
 
1859
    
 
1860
    def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
 
1861
        """Clone test for adaption."""
 
1862
        new_test = deepcopy(test)
 
1863
        new_test.transport_server = self._transport_server
 
1864
        new_test.transport_readonly_server = self._transport_readonly_server
 
1865
        new_test.bzrdir_format = bzrdir_format
 
1866
        new_test.workingtree_format = workingtree_format
 
1867
        def make_new_test_id():
 
1868
            new_id = "%s(%s)" % (test.id(), variation)
 
1869
            return lambda: new_id
 
1870
        new_test.id = make_new_test_id()
 
1871
        return new_test
 
1872
    
 
1873
    def adapt(self, test):
 
1874
        from bzrlib.tests import TestSuite
 
1875
        result = TestSuite()
 
1876
        for workingtree_format, bzrdir_format in self._formats:
 
1877
            new_test = self._clone_test(
 
1878
                test,
 
1879
                bzrdir_format,
 
1880
                workingtree_format, workingtree_format.__class__.__name__)
 
1881
            result.addTest(new_test)
 
1882
        return result