/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-03-09 02:08:38 UTC
  • mfrom: (2327.1.1 jam-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20070309020838-1dd7e652bc5c30ff
(Dmitry Vasiliev) Support for Putty SSH, and improved vendor support

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
2
 
 
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
 
 
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
29
29
WorkingTree.open(dir).
30
30
"""
31
31
 
32
 
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
33
 
CONFLICT_HEADER_1 = "BZR conflict list format 1"
34
 
 
35
32
# TODO: Give the workingtree sole responsibility for the working inventory;
36
33
# remove the variable and references to it from the branch.  This may require
37
34
# updating the commit code so as to update the inventory within the working
39
36
# At the moment they may alias the inventory and have old copies of it in
40
37
# memory.  (Now done? -- mbp 20060309)
41
38
 
 
39
from cStringIO import StringIO
 
40
import os
 
41
 
 
42
from bzrlib.lazy_import import lazy_import
 
43
lazy_import(globals(), """
 
44
from bisect import bisect_left
 
45
import collections
42
46
from copy import deepcopy
43
 
from cStringIO import StringIO
44
47
import errno
45
 
import fnmatch
46
 
import os
 
48
import itertools
 
49
import operator
47
50
import stat
48
 
 
49
 
 
50
 
from bzrlib.atomicfile import AtomicFile
51
 
from bzrlib.branch import (Branch,
52
 
                           quotefn)
53
 
from bzrlib.conflicts import Conflict, ConflictList, CONFLICT_SUFFIXES
54
 
import bzrlib.bzrdir as bzrdir
 
51
from time import time
 
52
import warnings
 
53
import re
 
54
 
 
55
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
    revisiontree,
 
69
    repository,
 
70
    textui,
 
71
    transform,
 
72
    urlutils,
 
73
    xml5,
 
74
    xml6,
 
75
    xml7,
 
76
    )
 
77
import bzrlib.branch
 
78
from bzrlib.transport import get_transport
 
79
import bzrlib.ui
 
80
from bzrlib.workingtree_4 import WorkingTreeFormat4
 
81
""")
 
82
 
 
83
from bzrlib import symbol_versioning
55
84
from bzrlib.decorators import needs_read_lock, needs_write_lock
56
 
import bzrlib.errors as errors
57
 
from bzrlib.errors import (BzrCheckError,
58
 
                           BzrError,
59
 
                           ConflictFormatError,
60
 
                           DivergedBranches,
61
 
                           WeaveRevisionNotPresent,
62
 
                           NotBranchError,
63
 
                           NoSuchFile,
64
 
                           NotVersionedError,
65
 
                           MergeModifiedFormatError,
66
 
                           UnsupportedOperation,
67
 
                           )
68
 
from bzrlib.inventory import InventoryEntry, Inventory
 
85
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
69
86
from bzrlib.lockable_files import LockableFiles, TransportLock
70
87
from bzrlib.lockdir import LockDir
71
 
from bzrlib.merge import merge_inner, transform_tree
 
88
import bzrlib.mutabletree
 
89
from bzrlib.mutabletree import needs_tree_write_lock
72
90
from bzrlib.osutils import (
73
 
                            abspath,
74
 
                            appendpath,
75
 
                            compact_date,
76
 
                            file_kind,
77
 
                            isdir,
78
 
                            getcwd,
79
 
                            pathjoin,
80
 
                            pumpfile,
81
 
                            safe_unicode,
82
 
                            splitpath,
83
 
                            rand_bytes,
84
 
                            normpath,
85
 
                            realpath,
86
 
                            relpath,
87
 
                            rename,
88
 
                            supports_executable,
89
 
                            )
 
91
    compact_date,
 
92
    file_kind,
 
93
    isdir,
 
94
    normpath,
 
95
    pathjoin,
 
96
    rand_chars,
 
97
    realpath,
 
98
    safe_unicode,
 
99
    splitpath,
 
100
    supports_executable,
 
101
    )
 
102
from bzrlib.trace import mutter, note
 
103
from bzrlib.transport.local import LocalTransport
90
104
from bzrlib.progress import DummyProgress, ProgressPhase
91
 
from bzrlib.revision import NULL_REVISION
 
105
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
92
106
from bzrlib.rio import RioReader, rio_file, Stanza
93
 
from bzrlib.symbol_versioning import *
94
 
from bzrlib.textui import show_status
95
 
import bzrlib.tree
96
 
from bzrlib.transform import build_tree
97
 
from bzrlib.trace import mutter, note
98
 
from bzrlib.transport import get_transport
99
 
from bzrlib.transport.local import LocalTransport
100
 
import bzrlib.ui
101
 
import bzrlib.xml5
102
 
 
103
 
 
 
107
from bzrlib.symbol_versioning import (deprecated_passed,
 
108
        deprecated_method,
 
109
        deprecated_function,
 
110
        DEPRECATED_PARAMETER,
 
111
        zero_eight,
 
112
        zero_eleven,
 
113
        zero_thirteen,
 
114
        )
 
115
 
 
116
 
 
117
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
 
118
CONFLICT_HEADER_1 = "BZR conflict list format 1"
 
119
 
 
120
 
 
121
@deprecated_function(zero_thirteen)
104
122
def gen_file_id(name):
105
 
    """Return new file id.
106
 
 
107
 
    This should probably generate proper UUIDs, but for the moment we
108
 
    cope with just randomness because running uuidgen every time is
109
 
    slow."""
110
 
    import re
111
 
    from binascii import hexlify
112
 
    from time import time
113
 
 
114
 
    # get last component
115
 
    idx = name.rfind('/')
116
 
    if idx != -1:
117
 
        name = name[idx+1 : ]
118
 
    idx = name.rfind('\\')
119
 
    if idx != -1:
120
 
        name = name[idx+1 : ]
121
 
 
122
 
    # make it not a hidden file
123
 
    name = name.lstrip('.')
124
 
 
125
 
    # remove any wierd characters; we don't escape them but rather
126
 
    # just pull them out
127
 
    name = re.sub(r'[^\w.]', '', name)
128
 
 
129
 
    s = hexlify(rand_bytes(8))
130
 
    return '-'.join((name, compact_date(time()), s))
131
 
 
132
 
 
 
123
    """Return new file id for the basename 'name'.
 
124
 
 
125
    Use bzrlib.generate_ids.gen_file_id() instead
 
126
    """
 
127
    return generate_ids.gen_file_id(name)
 
128
 
 
129
 
 
130
@deprecated_function(zero_thirteen)
133
131
def gen_root_id():
134
 
    """Return a new tree-root file id."""
135
 
    return gen_file_id('TREE_ROOT')
 
132
    """Return a new tree-root file id.
 
133
 
 
134
    This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
 
135
    """
 
136
    return generate_ids.gen_root_id()
136
137
 
137
138
 
138
139
class TreeEntry(object):
139
 
    """An entry that implements the minium interface used by commands.
 
140
    """An entry that implements the minimum interface used by commands.
140
141
 
141
142
    This needs further inspection, it may be better to have 
142
143
    InventoryEntries without ids - though that seems wrong. For now,
190
191
        return ''
191
192
 
192
193
 
193
 
class WorkingTree(bzrlib.tree.Tree):
 
194
class WorkingTree(bzrlib.mutabletree.MutableTree):
194
195
    """Working copy tree.
195
196
 
196
197
    The inventory is held in the `Branch` working-inventory, and the
218
219
        self.bzrdir = _bzrdir
219
220
        if not _internal:
220
221
            # not created via open etc.
221
 
            warn("WorkingTree() is deprecated as of bzr version 0.8. "
 
222
            warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
222
223
                 "Please use bzrdir.open_workingtree or WorkingTree.open().",
223
224
                 DeprecationWarning,
224
225
                 stacklevel=2)
225
226
            wt = WorkingTree.open(basedir)
226
 
            self.branch = wt.branch
 
227
            self._branch = wt.branch
227
228
            self.basedir = wt.basedir
228
229
            self._control_files = wt._control_files
229
230
            self._hashcache = wt._hashcache
230
 
            self._set_inventory(wt._inventory)
 
231
            self._set_inventory(wt._inventory, dirty=False)
231
232
            self._format = wt._format
232
233
            self.bzrdir = wt.bzrdir
233
 
        from bzrlib.hashcache import HashCache
234
 
        from bzrlib.trace import note, mutter
235
234
        assert isinstance(basedir, basestring), \
236
235
            "base directory %r is not a string" % basedir
237
236
        basedir = safe_unicode(basedir)
238
237
        mutter("opening working tree %r", basedir)
239
238
        if deprecated_passed(branch):
240
239
            if not _internal:
241
 
                warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
242
 
                     " Please use bzrdir.open_workingtree() or"
 
240
                warnings.warn("WorkingTree(..., branch=XXX) is deprecated"
 
241
                     " as of bzr 0.8. Please use bzrdir.open_workingtree() or"
243
242
                     " WorkingTree.open().",
244
243
                     DeprecationWarning,
245
244
                     stacklevel=2
246
245
                     )
247
 
            self.branch = branch
 
246
            self._branch = branch
248
247
        else:
249
 
            self.branch = self.bzrdir.open_branch()
250
 
        assert isinstance(self.branch, Branch), \
251
 
            "branch %r is not a Branch" % self.branch
 
248
            self._branch = self.bzrdir.open_branch()
252
249
        self.basedir = realpath(basedir)
253
250
        # if branch is at our basedir and is a format 6 or less
254
251
        if isinstance(self._format, WorkingTreeFormat2):
255
252
            # share control object
256
253
            self._control_files = self.branch.control_files
257
254
        else:
258
 
            # only ready for format 3
259
 
            assert isinstance(self._format, WorkingTreeFormat3)
 
255
            # assume all other formats have their own control files.
260
256
            assert isinstance(_control_files, LockableFiles), \
261
257
                    "_control_files must be a LockableFiles, not %r" \
262
258
                    % _control_files
267
263
        # if needed, or, when the cache sees a change, append it to the hash
268
264
        # cache file, and have the parser take the most recent entry for a
269
265
        # given path only.
270
 
        cache_filename = self.bzrdir.get_workingtree_transport(None).abspath('stat-cache')
271
 
        hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
 
266
        wt_trans = self.bzrdir.get_workingtree_transport(None)
 
267
        cache_filename = wt_trans.local_abspath('stat-cache')
 
268
        self._hashcache = hashcache.HashCache(basedir, cache_filename,
 
269
                                              self._control_files._file_mode)
 
270
        hc = self._hashcache
272
271
        hc.read()
273
272
        # is this scan needed ? it makes things kinda slow.
274
 
        hc.scan()
 
273
        #hc.scan()
275
274
 
276
275
        if hc.needs_write:
277
276
            mutter("write hc")
278
277
            hc.write()
279
278
 
280
279
        if _inventory is None:
281
 
            self._set_inventory(self.read_working_inventory())
 
280
            self._inventory_is_modified = False
 
281
            self.read_working_inventory()
282
282
        else:
283
 
            self._set_inventory(_inventory)
284
 
 
285
 
    def _set_inventory(self, inv):
 
283
            # the caller of __init__ has provided an inventory,
 
284
            # we assume they know what they are doing - as its only
 
285
            # the Format factory and creation methods that are
 
286
            # permitted to do this.
 
287
            self._set_inventory(_inventory, dirty=False)
 
288
 
 
289
    branch = property(
 
290
        fget=lambda self: self._branch,
 
291
        doc="""The branch this WorkingTree is connected to.
 
292
 
 
293
            This cannot be set - it is reflective of the actual disk structure
 
294
            the working tree has been constructed from.
 
295
            """)
 
296
 
 
297
    def break_lock(self):
 
298
        """Break a lock if one is present from another instance.
 
299
 
 
300
        Uses the ui factory to ask for confirmation if the lock may be from
 
301
        an active process.
 
302
 
 
303
        This will probe the repository for its lock as well.
 
304
        """
 
305
        self._control_files.break_lock()
 
306
        self.branch.break_lock()
 
307
 
 
308
    def requires_rich_root(self):
 
309
        return self._format.requires_rich_root
 
310
 
 
311
    def supports_tree_reference(self):
 
312
        return False
 
313
 
 
314
    def _set_inventory(self, inv, dirty):
 
315
        """Set the internal cached inventory.
 
316
 
 
317
        :param inv: The inventory to set.
 
318
        :param dirty: A boolean indicating whether the inventory is the same
 
319
            logical inventory as whats on disk. If True the inventory is not
 
320
            the same and should be written to disk or data will be lost, if
 
321
            False then the inventory is the same as that on disk and any
 
322
            serialisation would be unneeded overhead.
 
323
        """
 
324
        assert inv.root is not None
286
325
        self._inventory = inv
287
 
        self.path2id = self._inventory.path2id
288
 
 
289
 
    def is_control_filename(self, filename):
290
 
        """True if filename is the name of a control file in this tree.
291
 
        
292
 
        This is true IF and ONLY IF the filename is part of the meta data
293
 
        that bzr controls in this tree. I.E. a random .bzr directory placed
294
 
        on disk will not be a control file for this tree.
295
 
        """
296
 
        try:
297
 
            self.bzrdir.transport.relpath(self.abspath(filename))
298
 
            return True
299
 
        except errors.PathNotChild:
300
 
            return False
 
326
        self._inventory_is_modified = dirty
301
327
 
302
328
    @staticmethod
303
329
    def open(path=None, _unsupported=False):
319
345
        run into /.  If there isn't one, raises NotBranchError.
320
346
        TODO: give this a new exception.
321
347
        If there is one, it is returned, along with the unused portion of path.
 
348
 
 
349
        :return: The WorkingTree that contains 'path', and the rest of path
322
350
        """
323
351
        if path is None:
324
 
            path = os.getcwdu()
 
352
            path = osutils.getcwd()
325
353
        control, relpath = bzrdir.BzrDir.open_containing(path)
 
354
 
326
355
        return control.open_workingtree(), relpath
327
356
 
328
357
    @staticmethod
333
362
        """
334
363
        return WorkingTree.open(path, _unsupported=True)
335
364
 
 
365
    # should be deprecated - this is slow and in any case treating them as a
 
366
    # container is (we now know) bad style -- mbp 20070302
 
367
    ## @deprecated_method(zero_fifteen)
336
368
    def __iter__(self):
337
369
        """Iterate through file_ids for this tree.
338
370
 
341
373
        """
342
374
        inv = self._inventory
343
375
        for path, ie in inv.iter_entries():
344
 
            if bzrlib.osutils.lexists(self.abspath(path)):
 
376
            if osutils.lexists(self.abspath(path)):
345
377
                yield ie.file_id
346
378
 
347
379
    def __repr__(self):
352
384
        return pathjoin(self.basedir, filename)
353
385
    
354
386
    def basis_tree(self):
355
 
        """Return RevisionTree for the current last revision."""
356
 
        revision_id = self.last_revision()
357
 
        if revision_id is not None:
358
 
            try:
359
 
                xml = self.read_basis_inventory()
360
 
                inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
361
 
            except NoSuchFile:
362
 
                inv = None
363
 
            if inv is not None and inv.revision_id == revision_id:
364
 
                return bzrlib.tree.RevisionTree(self.branch.repository, inv,
365
 
                                                revision_id)
366
 
        # FIXME? RBC 20060403 should we cache the inventory here ?
367
 
        return self.branch.repository.revision_tree(revision_id)
 
387
        """Return RevisionTree for the current last revision.
 
388
        
 
389
        If the left most parent is a ghost then the returned tree will be an
 
390
        empty tree - one obtained by calling repository.revision_tree(None).
 
391
        """
 
392
        try:
 
393
            revision_id = self.get_parent_ids()[0]
 
394
        except IndexError:
 
395
            # no parents, return an empty revision tree.
 
396
            # in the future this should return the tree for
 
397
            # 'empty:' - the implicit root empty tree.
 
398
            return self.branch.repository.revision_tree(None)
 
399
        try:
 
400
            return self.revision_tree(revision_id)
 
401
        except errors.NoSuchRevision:
 
402
            pass
 
403
        # No cached copy available, retrieve from the repository.
 
404
        # FIXME? RBC 20060403 should we cache the inventory locally
 
405
        # at this point ?
 
406
        try:
 
407
            return self.branch.repository.revision_tree(revision_id)
 
408
        except errors.RevisionNotPresent:
 
409
            # the basis tree *may* be a ghost or a low level error may have
 
410
            # occured. If the revision is present, its a problem, if its not
 
411
            # its a ghost.
 
412
            if self.branch.repository.has_revision(revision_id):
 
413
                raise
 
414
            # the basis tree is a ghost so return an empty tree.
 
415
            return self.branch.repository.revision_tree(None)
368
416
 
369
417
    @staticmethod
370
418
    @deprecated_method(zero_eight)
383
431
        XXX: When BzrDir is present, these should be created through that 
384
432
        interface instead.
385
433
        """
386
 
        warn('delete WorkingTree.create', stacklevel=3)
 
434
        warnings.warn('delete WorkingTree.create', stacklevel=3)
387
435
        transport = get_transport(directory)
388
436
        if branch.bzrdir.root_transport.base == transport.base:
389
437
            # same dir 
404
452
        """
405
453
        return bzrdir.BzrDir.create_standalone_workingtree(directory)
406
454
 
407
 
    def relpath(self, abs):
408
 
        """Return the local path portion from a given absolute path."""
409
 
        return relpath(self.basedir, abs)
 
455
    def relpath(self, path):
 
456
        """Return the local path portion from a given path.
 
457
        
 
458
        The path may be absolute or relative. If its a relative path it is 
 
459
        interpreted relative to the python current working directory.
 
460
        """
 
461
        return osutils.relpath(self.basedir, path)
410
462
 
411
463
    def has_filename(self, filename):
412
 
        return bzrlib.osutils.lexists(self.abspath(filename))
 
464
        return osutils.lexists(self.abspath(filename))
413
465
 
414
466
    def get_file(self, file_id):
 
467
        file_id = osutils.safe_file_id(file_id)
415
468
        return self.get_file_byname(self.id2path(file_id))
416
469
 
 
470
    def get_file_text(self, file_id):
 
471
        file_id = osutils.safe_file_id(file_id)
 
472
        return self.get_file(file_id).read()
 
473
 
417
474
    def get_file_byname(self, filename):
418
475
        return file(self.abspath(filename), 'rb')
419
476
 
 
477
    @needs_read_lock
 
478
    def annotate_iter(self, file_id):
 
479
        """See Tree.annotate_iter
 
480
 
 
481
        This implementation will use the basis tree implementation if possible.
 
482
        Lines not in the basis are attributed to CURRENT_REVISION
 
483
 
 
484
        If there are pending merges, lines added by those merges will be
 
485
        incorrectly attributed to CURRENT_REVISION (but after committing, the
 
486
        attribution will be correct).
 
487
        """
 
488
        file_id = osutils.safe_file_id(file_id)
 
489
        basis = self.basis_tree()
 
490
        basis.lock_read()
 
491
        try:
 
492
            changes = self._iter_changes(basis, True, [self.id2path(file_id)],
 
493
                require_versioned=True).next()
 
494
            changed_content, kind = changes[2], changes[6]
 
495
            if not changed_content:
 
496
                return basis.annotate_iter(file_id)
 
497
            if kind[1] is None:
 
498
                return None
 
499
            import annotate
 
500
            if kind[0] != 'file':
 
501
                old_lines = []
 
502
            else:
 
503
                old_lines = list(basis.annotate_iter(file_id))
 
504
            old = [old_lines]
 
505
            for tree in self.branch.repository.revision_trees(
 
506
                self.get_parent_ids()[1:]):
 
507
                if file_id not in tree:
 
508
                    continue
 
509
                old.append(list(tree.annotate_iter(file_id)))
 
510
            return annotate.reannotate(old, self.get_file(file_id).readlines(),
 
511
                                       CURRENT_REVISION)
 
512
        finally:
 
513
            basis.unlock()
 
514
 
 
515
    def get_parent_ids(self):
 
516
        """See Tree.get_parent_ids.
 
517
        
 
518
        This implementation reads the pending merges list and last_revision
 
519
        value and uses that to decide what the parents list should be.
 
520
        """
 
521
        last_rev = self._last_revision()
 
522
        if last_rev is None:
 
523
            parents = []
 
524
        else:
 
525
            parents = [last_rev]
 
526
        try:
 
527
            merges_file = self._control_files.get('pending-merges')
 
528
        except errors.NoSuchFile:
 
529
            pass
 
530
        else:
 
531
            for l in merges_file.readlines():
 
532
                revision_id = osutils.safe_revision_id(l.rstrip('\n'))
 
533
                parents.append(revision_id)
 
534
        return parents
 
535
 
 
536
    @needs_read_lock
420
537
    def get_root_id(self):
421
538
        """Return the id of this trees root"""
422
 
        inv = self.read_working_inventory()
423
 
        return inv.root.file_id
 
539
        return self._inventory.root.file_id
424
540
        
425
541
    def _get_store_filename(self, file_id):
426
542
        ## XXX: badly named; this is not in the store at all
 
543
        file_id = osutils.safe_file_id(file_id)
427
544
        return self.abspath(self.id2path(file_id))
428
545
 
429
546
    @needs_read_lock
452
569
    @needs_read_lock
453
570
    def copy_content_into(self, tree, revision_id=None):
454
571
        """Copy the current content and user files of this tree into tree."""
 
572
        tree.set_root_id(self.get_root_id())
455
573
        if revision_id is None:
456
 
            transform_tree(tree, self)
 
574
            merge.transform_tree(tree, self)
457
575
        else:
458
 
            # TODO now merge from tree.last_revision to revision
459
 
            transform_tree(tree, self)
460
 
            tree.set_last_revision(revision_id)
461
 
 
462
 
    @needs_write_lock
463
 
    def commit(self, message=None, revprops=None, *args, **kwargs):
464
 
        # avoid circular imports
465
 
        from bzrlib.commit import Commit
466
 
        if revprops is None:
467
 
            revprops = {}
468
 
        if not 'branch-nick' in revprops:
469
 
            revprops['branch-nick'] = self.branch.nick
470
 
        # args for wt.commit start at message from the Commit.commit method,
471
 
        # but with branch a kwarg now, passing in args as is results in the
472
 
        #message being used for the branch
473
 
        args = (DEPRECATED_PARAMETER, message, ) + args
474
 
        Commit().commit(working_tree=self, revprops=revprops, *args, **kwargs)
475
 
        self._set_inventory(self.read_working_inventory())
 
576
            # TODO now merge from tree.last_revision to revision (to preserve
 
577
            # user local changes)
 
578
            merge.transform_tree(tree, self)
 
579
            tree.set_parent_ids([revision_id])
476
580
 
477
581
    def id2abspath(self, file_id):
 
582
        file_id = osutils.safe_file_id(file_id)
478
583
        return self.abspath(self.id2path(file_id))
479
584
 
480
585
    def has_id(self, file_id):
481
586
        # files that have been deleted are excluded
482
 
        inv = self._inventory
 
587
        file_id = osutils.safe_file_id(file_id)
 
588
        inv = self.inventory
483
589
        if not inv.has_id(file_id):
484
590
            return False
485
591
        path = inv.id2path(file_id)
486
 
        return bzrlib.osutils.lexists(self.abspath(path))
 
592
        return osutils.lexists(self.abspath(path))
487
593
 
488
594
    def has_or_had_id(self, file_id):
 
595
        file_id = osutils.safe_file_id(file_id)
489
596
        if file_id == self.inventory.root.file_id:
490
597
            return True
491
598
        return self.inventory.has_id(file_id)
493
600
    __contains__ = has_id
494
601
 
495
602
    def get_file_size(self, file_id):
 
603
        file_id = osutils.safe_file_id(file_id)
496
604
        return os.path.getsize(self.id2abspath(file_id))
497
605
 
498
606
    @needs_read_lock
499
 
    def get_file_sha1(self, file_id):
500
 
        path = self._inventory.id2path(file_id)
501
 
        return self._hashcache.get_sha1(path)
502
 
 
503
 
    def is_executable(self, file_id):
504
 
        if not supports_executable():
 
607
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
608
        file_id = osutils.safe_file_id(file_id)
 
609
        if not path:
 
610
            path = self._inventory.id2path(file_id)
 
611
        return self._hashcache.get_sha1(path, stat_value)
 
612
 
 
613
    def get_file_mtime(self, file_id, path=None):
 
614
        file_id = osutils.safe_file_id(file_id)
 
615
        if not path:
 
616
            path = self.inventory.id2path(file_id)
 
617
        return os.lstat(self.abspath(path)).st_mtime
 
618
 
 
619
    if not supports_executable():
 
620
        def is_executable(self, file_id, path=None):
 
621
            file_id = osutils.safe_file_id(file_id)
505
622
            return self._inventory[file_id].executable
506
 
        else:
507
 
            path = self._inventory.id2path(file_id)
 
623
    else:
 
624
        def is_executable(self, file_id, path=None):
 
625
            if not path:
 
626
                file_id = osutils.safe_file_id(file_id)
 
627
                path = self.id2path(file_id)
508
628
            mode = os.lstat(self.abspath(path)).st_mode
509
 
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
510
 
 
511
 
    @needs_write_lock
512
 
    def add(self, files, ids=None):
513
 
        """Make files versioned.
514
 
 
515
 
        Note that the command line normally calls smart_add instead,
516
 
        which can automatically recurse.
517
 
 
518
 
        This adds the files to the inventory, so that they will be
519
 
        recorded by the next commit.
520
 
 
521
 
        files
522
 
            List of paths to add, relative to the base of the tree.
523
 
 
524
 
        ids
525
 
            If set, use these instead of automatically generated ids.
526
 
            Must be the same length as the list of files, but may
527
 
            contain None for ids that are to be autogenerated.
528
 
 
529
 
        TODO: Perhaps have an option to add the ids even if the files do
530
 
              not (yet) exist.
531
 
 
532
 
        TODO: Perhaps callback with the ids and paths as they're added.
533
 
        """
 
629
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
 
630
 
 
631
    @needs_tree_write_lock
 
632
    def _add(self, files, ids, kinds):
 
633
        """See MutableTree._add."""
534
634
        # TODO: Re-adding a file that is removed in the working copy
535
635
        # should probably put it back with the previous ID.
536
 
        if isinstance(files, basestring):
537
 
            assert(ids is None or isinstance(ids, basestring))
538
 
            files = [files]
539
 
            if ids is not None:
540
 
                ids = [ids]
541
 
 
542
 
        if ids is None:
543
 
            ids = [None] * len(files)
544
 
        else:
545
 
            assert(len(ids) == len(files))
546
 
 
 
636
        # the read and write working inventory should not occur in this 
 
637
        # function - they should be part of lock_write and unlock.
547
638
        inv = self.read_working_inventory()
548
 
        for f,file_id in zip(files, ids):
549
 
            if self.is_control_filename(f):
550
 
                raise BzrError("cannot add control file %s" % quotefn(f))
551
 
 
552
 
            fp = splitpath(f)
553
 
 
554
 
            if len(fp) == 0:
555
 
                raise BzrError("cannot add top-level %r" % f)
556
 
 
557
 
            fullpath = normpath(self.abspath(f))
558
 
 
559
 
            try:
560
 
                kind = file_kind(fullpath)
561
 
            except OSError, e:
562
 
                if e.errno == errno.ENOENT:
563
 
                    raise NoSuchFile(fullpath)
564
 
                # maybe something better?
565
 
                raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
566
 
 
567
 
            if not InventoryEntry.versionable_kind(kind):
568
 
                raise BzrError('cannot add: not a versionable file ('
569
 
                               'i.e. regular file, symlink or directory): %s' % quotefn(f))
570
 
 
 
639
        for f, file_id, kind in zip(files, ids, kinds):
 
640
            assert kind is not None
571
641
            if file_id is None:
572
 
                file_id = gen_file_id(f)
573
 
            inv.add_path(f, kind=kind, file_id=file_id)
574
 
 
575
 
            mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
 
642
                inv.add_path(f, kind=kind)
 
643
            else:
 
644
                file_id = osutils.safe_file_id(file_id)
 
645
                inv.add_path(f, kind=kind, file_id=file_id)
576
646
        self._write_inventory(inv)
577
647
 
 
648
    @needs_tree_write_lock
 
649
    def _gather_kinds(self, files, kinds):
 
650
        """See MutableTree._gather_kinds."""
 
651
        for pos, f in enumerate(files):
 
652
            if kinds[pos] is None:
 
653
                fullpath = normpath(self.abspath(f))
 
654
                try:
 
655
                    kinds[pos] = file_kind(fullpath)
 
656
                except OSError, e:
 
657
                    if e.errno == errno.ENOENT:
 
658
                        raise errors.NoSuchFile(fullpath)
 
659
 
578
660
    @needs_write_lock
 
661
    def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
 
662
        """Add revision_id as a parent.
 
663
 
 
664
        This is equivalent to retrieving the current list of parent ids
 
665
        and setting the list to its value plus revision_id.
 
666
 
 
667
        :param revision_id: The revision id to add to the parent list. It may
 
668
        be a ghost revision as long as its not the first parent to be added,
 
669
        or the allow_leftmost_as_ghost parameter is set True.
 
670
        :param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
 
671
        """
 
672
        parents = self.get_parent_ids() + [revision_id]
 
673
        self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
 
674
            or allow_leftmost_as_ghost)
 
675
 
 
676
    @needs_tree_write_lock
 
677
    def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
 
678
        """Add revision_id, tree tuple as a parent.
 
679
 
 
680
        This is equivalent to retrieving the current list of parent trees
 
681
        and setting the list to its value plus parent_tuple. See also
 
682
        add_parent_tree_id - if you only have a parent id available it will be
 
683
        simpler to use that api. If you have the parent already available, using
 
684
        this api is preferred.
 
685
 
 
686
        :param parent_tuple: The (revision id, tree) to add to the parent list.
 
687
            If the revision_id is a ghost, pass None for the tree.
 
688
        :param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
 
689
        """
 
690
        parent_ids = self.get_parent_ids() + [parent_tuple[0]]
 
691
        if len(parent_ids) > 1:
 
692
            # the leftmost may have already been a ghost, preserve that if it
 
693
            # was.
 
694
            allow_leftmost_as_ghost = True
 
695
        self.set_parent_ids(parent_ids,
 
696
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
697
 
 
698
    @needs_tree_write_lock
579
699
    def add_pending_merge(self, *revision_ids):
580
700
        # TODO: Perhaps should check at this point that the
581
701
        # history of the revision is actually present?
582
 
        p = self.pending_merges()
 
702
        parents = self.get_parent_ids()
583
703
        updated = False
584
704
        for rev_id in revision_ids:
585
 
            if rev_id in p:
 
705
            if rev_id in parents:
586
706
                continue
587
 
            p.append(rev_id)
 
707
            parents.append(rev_id)
588
708
            updated = True
589
709
        if updated:
590
 
            self.set_pending_merges(p)
 
710
            self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
591
711
 
 
712
    @deprecated_method(zero_eleven)
592
713
    @needs_read_lock
593
714
    def pending_merges(self):
594
715
        """Return a list of pending merges.
595
716
 
596
717
        These are revisions that have been merged into the working
597
718
        directory but not yet committed.
598
 
        """
599
 
        try:
600
 
            merges_file = self._control_files.get_utf8('pending-merges')
601
 
        except OSError, e:
602
 
            if e.errno != errno.ENOENT:
603
 
                raise
604
 
            return []
605
 
        p = []
606
 
        for l in merges_file.readlines():
607
 
            p.append(l.rstrip('\n'))
608
 
        return p
609
 
 
610
 
    @needs_write_lock
 
719
 
 
720
        As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
 
721
        instead - which is available on all tree objects.
 
722
        """
 
723
        return self.get_parent_ids()[1:]
 
724
 
 
725
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
 
726
        """Common ghost checking functionality from set_parent_*.
 
727
 
 
728
        This checks that the left hand-parent exists if there are any
 
729
        revisions present.
 
730
        """
 
731
        if len(revision_ids) > 0:
 
732
            leftmost_id = revision_ids[0]
 
733
            if (not allow_leftmost_as_ghost and not
 
734
                self.branch.repository.has_revision(leftmost_id)):
 
735
                raise errors.GhostRevisionUnusableHere(leftmost_id)
 
736
 
 
737
    def _set_merges_from_parent_ids(self, parent_ids):
 
738
        merges = parent_ids[1:]
 
739
        self._control_files.put_bytes('pending-merges', '\n'.join(merges))
 
740
 
 
741
    @needs_tree_write_lock
 
742
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
 
743
        """Set the parent ids to revision_ids.
 
744
        
 
745
        See also set_parent_trees. This api will try to retrieve the tree data
 
746
        for each element of revision_ids from the trees repository. If you have
 
747
        tree data already available, it is more efficient to use
 
748
        set_parent_trees rather than set_parent_ids. set_parent_ids is however
 
749
        an easier API to use.
 
750
 
 
751
        :param revision_ids: The revision_ids to set as the parent ids of this
 
752
            working tree. Any of these may be ghosts.
 
753
        """
 
754
        revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
 
755
        self._check_parents_for_ghosts(revision_ids,
 
756
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
757
 
 
758
        if len(revision_ids) > 0:
 
759
            self.set_last_revision(revision_ids[0])
 
760
        else:
 
761
            self.set_last_revision(None)
 
762
 
 
763
        self._set_merges_from_parent_ids(revision_ids)
 
764
 
 
765
    @needs_tree_write_lock
 
766
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
 
767
        """See MutableTree.set_parent_trees."""
 
768
        parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
 
769
 
 
770
        self._check_parents_for_ghosts(parent_ids,
 
771
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
772
 
 
773
        if len(parent_ids) == 0:
 
774
            leftmost_parent_id = None
 
775
            leftmost_parent_tree = None
 
776
        else:
 
777
            leftmost_parent_id, leftmost_parent_tree = parents_list[0]
 
778
 
 
779
        if self._change_last_revision(leftmost_parent_id):
 
780
            if leftmost_parent_tree is None:
 
781
                # If we don't have a tree, fall back to reading the
 
782
                # parent tree from the repository.
 
783
                self._cache_basis_inventory(leftmost_parent_id)
 
784
            else:
 
785
                inv = leftmost_parent_tree.inventory
 
786
                xml = self._create_basis_xml_from_inventory(
 
787
                                        leftmost_parent_id, inv)
 
788
                self._write_basis_inventory(xml)
 
789
        self._set_merges_from_parent_ids(parent_ids)
 
790
 
 
791
    @needs_tree_write_lock
611
792
    def set_pending_merges(self, rev_list):
612
 
        self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
 
793
        parents = self.get_parent_ids()
 
794
        leftmost = parents[:1]
 
795
        new_parents = leftmost + rev_list
 
796
        self.set_parent_ids(new_parents)
613
797
 
614
 
    @needs_write_lock
 
798
    @needs_tree_write_lock
615
799
    def set_merge_modified(self, modified_hashes):
616
800
        def iter_stanzas():
617
801
            for file_id, hash in modified_hashes.iteritems():
618
 
                yield Stanza(file_id=file_id, hash=hash)
 
802
                yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
619
803
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
620
804
 
621
 
    @needs_write_lock
622
805
    def _put_rio(self, filename, stanzas, header):
 
806
        self._must_be_locked()
623
807
        my_file = rio_file(stanzas, header)
624
808
        self._control_files.put(filename, my_file)
625
809
 
 
810
    @needs_write_lock # because merge pulls data into the branch.
 
811
    def merge_from_branch(self, branch, to_revision=None):
 
812
        """Merge from a branch into this working tree.
 
813
 
 
814
        :param branch: The branch to merge from.
 
815
        :param to_revision: If non-None, the merge will merge to to_revision,
 
816
            but not beyond it. to_revision does not need to be in the history
 
817
            of the branch when it is supplied. If None, to_revision defaults to
 
818
            branch.last_revision().
 
819
        """
 
820
        from bzrlib.merge import Merger, Merge3Merger
 
821
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
822
        try:
 
823
            merger = Merger(self.branch, this_tree=self, pb=pb)
 
824
            merger.pp = ProgressPhase("Merge phase", 5, pb)
 
825
            merger.pp.next_phase()
 
826
            # check that there are no
 
827
            # local alterations
 
828
            merger.check_basis(check_clean=True, require_commits=False)
 
829
            if to_revision is None:
 
830
                to_revision = branch.last_revision()
 
831
            else:
 
832
                to_revision = osutils.safe_revision_id(to_revision)
 
833
            merger.other_rev_id = to_revision
 
834
            if merger.other_rev_id is None:
 
835
                raise error.NoCommits(branch)
 
836
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
837
            merger.other_basis = merger.other_rev_id
 
838
            merger.other_tree = self.branch.repository.revision_tree(
 
839
                merger.other_rev_id)
 
840
            merger.other_branch = branch
 
841
            merger.pp.next_phase()
 
842
            merger.find_base()
 
843
            if merger.base_rev_id == merger.other_rev_id:
 
844
                raise errors.PointlessMerge
 
845
            merger.backup_files = False
 
846
            merger.merge_type = Merge3Merger
 
847
            merger.set_interesting_files(None)
 
848
            merger.show_base = False
 
849
            merger.reprocess = False
 
850
            conflicts = merger.do_merge()
 
851
            merger.set_pending()
 
852
        finally:
 
853
            pb.finished()
 
854
        return conflicts
 
855
 
626
856
    @needs_read_lock
627
857
    def merge_modified(self):
 
858
        """Return a dictionary of files modified by a merge.
 
859
 
 
860
        The list is initialized by WorkingTree.set_merge_modified, which is 
 
861
        typically called after we make some automatic updates to the tree
 
862
        because of a merge.
 
863
 
 
864
        This returns a map of file_id->sha1, containing only files which are
 
865
        still in the working inventory and have that text hash.
 
866
        """
628
867
        try:
629
868
            hashfile = self._control_files.get('merge-hashes')
630
 
        except NoSuchFile:
 
869
        except errors.NoSuchFile:
631
870
            return {}
632
871
        merge_hashes = {}
633
872
        try:
634
873
            if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
635
 
                raise MergeModifiedFormatError()
 
874
                raise errors.MergeModifiedFormatError()
636
875
        except StopIteration:
637
 
            raise MergeModifiedFormatError()
 
876
            raise errors.MergeModifiedFormatError()
638
877
        for s in RioReader(hashfile):
639
 
            file_id = s.get("file_id")
 
878
            # RioReader reads in Unicode, so convert file_ids back to utf8
 
879
            file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
640
880
            if file_id not in self.inventory:
641
881
                continue
642
 
            hash = s.get("hash")
643
 
            if hash == self.get_file_sha1(file_id):
644
 
                merge_hashes[file_id] = hash
 
882
            text_hash = s.get("hash")
 
883
            if text_hash == self.get_file_sha1(file_id):
 
884
                merge_hashes[file_id] = text_hash
645
885
        return merge_hashes
646
886
 
 
887
    @needs_write_lock
 
888
    def mkdir(self, path, file_id=None):
 
889
        """See MutableTree.mkdir()."""
 
890
        if file_id is None:
 
891
            file_id = generate_ids.gen_file_id(os.path.basename(path))
 
892
        os.mkdir(self.abspath(path))
 
893
        self.add(path, file_id, 'directory')
 
894
        return file_id
 
895
 
647
896
    def get_symlink_target(self, file_id):
 
897
        file_id = osutils.safe_file_id(file_id)
648
898
        return os.readlink(self.id2abspath(file_id))
649
899
 
650
 
    def file_class(self, filename):
651
 
        if self.path2id(filename):
652
 
            return 'V'
653
 
        elif self.is_ignored(filename):
654
 
            return 'I'
655
 
        else:
656
 
            return '?'
657
 
 
658
 
    def list_files(self):
659
 
        """Recursively list all files as (path, class, kind, id).
 
900
    @needs_write_lock
 
901
    def subsume(self, other_tree):
 
902
        def add_children(inventory, entry):
 
903
            for child_entry in entry.children.values():
 
904
                inventory._byid[child_entry.file_id] = child_entry
 
905
                if child_entry.kind == 'directory':
 
906
                    add_children(inventory, child_entry)
 
907
        if other_tree.get_root_id() == self.get_root_id():
 
908
            raise errors.BadSubsumeSource(self, other_tree,
 
909
                                          'Trees have the same root')
 
910
        try:
 
911
            other_tree_path = self.relpath(other_tree.basedir)
 
912
        except errors.PathNotChild:
 
913
            raise errors.BadSubsumeSource(self, other_tree,
 
914
                'Tree is not contained by the other')
 
915
        new_root_parent = self.path2id(osutils.dirname(other_tree_path))
 
916
        if new_root_parent is None:
 
917
            raise errors.BadSubsumeSource(self, other_tree,
 
918
                'Parent directory is not versioned.')
 
919
        # We need to ensure that the result of a fetch will have a
 
920
        # versionedfile for the other_tree root, and only fetching into
 
921
        # RepositoryKnit2 guarantees that.
 
922
        if not self.branch.repository.supports_rich_root():
 
923
            raise errors.SubsumeTargetNeedsUpgrade(other_tree)
 
924
        other_tree.lock_tree_write()
 
925
        try:
 
926
            new_parents = other_tree.get_parent_ids()
 
927
            other_root = other_tree.inventory.root
 
928
            other_root.parent_id = new_root_parent
 
929
            other_root.name = osutils.basename(other_tree_path)
 
930
            self.inventory.add(other_root)
 
931
            add_children(self.inventory, other_root)
 
932
            self._write_inventory(self.inventory)
 
933
            # normally we don't want to fetch whole repositories, but i think
 
934
            # here we really do want to consolidate the whole thing.
 
935
            for parent_id in other_tree.get_parent_ids():
 
936
                self.branch.fetch(other_tree.branch, parent_id)
 
937
                self.add_parent_tree_id(parent_id)
 
938
        finally:
 
939
            other_tree.unlock()
 
940
        other_tree.bzrdir.retire_bzrdir()
 
941
 
 
942
    @needs_tree_write_lock
 
943
    def extract(self, file_id, format=None):
 
944
        """Extract a subtree from this tree.
 
945
        
 
946
        A new branch will be created, relative to the path for this tree.
 
947
        """
 
948
        self.flush()
 
949
        def mkdirs(path):
 
950
            segments = osutils.splitpath(path)
 
951
            transport = self.branch.bzrdir.root_transport
 
952
            for name in segments:
 
953
                transport = transport.clone(name)
 
954
                try:
 
955
                    transport.mkdir('.')
 
956
                except errors.FileExists:
 
957
                    pass
 
958
            return transport
 
959
            
 
960
        sub_path = self.id2path(file_id)
 
961
        branch_transport = mkdirs(sub_path)
 
962
        if format is None:
 
963
            format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
 
964
        try:
 
965
            branch_transport.mkdir('.')
 
966
        except errors.FileExists:
 
967
            pass
 
968
        branch_bzrdir = format.initialize_on_transport(branch_transport)
 
969
        try:
 
970
            repo = branch_bzrdir.find_repository()
 
971
        except errors.NoRepositoryPresent:
 
972
            repo = branch_bzrdir.create_repository()
 
973
            assert repo.supports_rich_root()
 
974
        else:
 
975
            if not repo.supports_rich_root():
 
976
                raise errors.RootNotRich()
 
977
        new_branch = branch_bzrdir.create_branch()
 
978
        new_branch.pull(self.branch)
 
979
        for parent_id in self.get_parent_ids():
 
980
            new_branch.fetch(self.branch, parent_id)
 
981
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
 
982
        if tree_transport.base != branch_transport.base:
 
983
            tree_bzrdir = format.initialize_on_transport(tree_transport)
 
984
            branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
 
985
        else:
 
986
            tree_bzrdir = branch_bzrdir
 
987
        wt = tree_bzrdir.create_workingtree(NULL_REVISION)
 
988
        wt.set_parent_ids(self.get_parent_ids())
 
989
        my_inv = self.inventory
 
990
        child_inv = Inventory(root_id=None)
 
991
        new_root = my_inv[file_id]
 
992
        my_inv.remove_recursive_id(file_id)
 
993
        new_root.parent_id = None
 
994
        child_inv.add(new_root)
 
995
        self._write_inventory(my_inv)
 
996
        wt._write_inventory(child_inv)
 
997
        return wt
 
998
 
 
999
    def _serialize(self, inventory, out_file):
 
1000
        xml5.serializer_v5.write_inventory(self._inventory, out_file)
 
1001
 
 
1002
    def _deserialize(selt, in_file):
 
1003
        return xml5.serializer_v5.read_inventory(in_file)
 
1004
 
 
1005
    def flush(self):
 
1006
        """Write the in memory inventory to disk."""
 
1007
        # TODO: Maybe this should only write on dirty ?
 
1008
        if self._control_files._lock_mode != 'w':
 
1009
            raise errors.NotWriteLocked(self)
 
1010
        sio = StringIO()
 
1011
        self._serialize(self._inventory, sio)
 
1012
        sio.seek(0)
 
1013
        self._control_files.put('inventory', sio)
 
1014
        self._inventory_is_modified = False
 
1015
 
 
1016
    def list_files(self, include_root=False):
 
1017
        """Recursively list all files as (path, class, kind, id, entry).
660
1018
 
661
1019
        Lists, but does not descend into unversioned directories.
662
1020
 
665
1023
 
666
1024
        Skips the control directory.
667
1025
        """
668
 
        inv = self._inventory
669
 
 
670
 
        def descend(from_dir_relpath, from_dir_id, dp):
671
 
            ls = os.listdir(dp)
672
 
            ls.sort()
673
 
            for f in ls:
 
1026
        # list_files is an iterator, so @needs_read_lock doesn't work properly
 
1027
        # with it. So callers should be careful to always read_lock the tree.
 
1028
        if not self.is_locked():
 
1029
            raise errors.ObjectNotLocked(self)
 
1030
 
 
1031
        inv = self.inventory
 
1032
        if include_root is True:
 
1033
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
 
1034
        # Convert these into local objects to save lookup times
 
1035
        pathjoin = osutils.pathjoin
 
1036
        file_kind = osutils.file_kind
 
1037
 
 
1038
        # transport.base ends in a slash, we want the piece
 
1039
        # between the last two slashes
 
1040
        transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
 
1041
 
 
1042
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
 
1043
 
 
1044
        # directory file_id, relative path, absolute path, reverse sorted children
 
1045
        children = os.listdir(self.basedir)
 
1046
        children.sort()
 
1047
        # jam 20060527 The kernel sized tree seems equivalent whether we 
 
1048
        # use a deque and popleft to keep them sorted, or if we use a plain
 
1049
        # list and just reverse() them.
 
1050
        children = collections.deque(children)
 
1051
        stack = [(inv.root.file_id, u'', self.basedir, children)]
 
1052
        while stack:
 
1053
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
 
1054
 
 
1055
            while children:
 
1056
                f = children.popleft()
674
1057
                ## TODO: If we find a subdirectory with its own .bzr
675
1058
                ## directory, then that is a separate tree and we
676
1059
                ## should exclude it.
677
1060
 
678
1061
                # the bzrdir for this tree
679
 
                if self.bzrdir.transport.base.endswith(f + '/'):
 
1062
                if transport_base_dir == f:
680
1063
                    continue
681
1064
 
682
 
                # path within tree
683
 
                fp = appendpath(from_dir_relpath, f)
 
1065
                # we know that from_dir_relpath and from_dir_abspath never end in a slash
 
1066
                # and 'f' doesn't begin with one, we can do a string op, rather
 
1067
                # than the checks of pathjoin(), all relative paths will have an extra slash
 
1068
                # at the beginning
 
1069
                fp = from_dir_relpath + '/' + f
684
1070
 
685
1071
                # absolute path
686
 
                fap = appendpath(dp, f)
 
1072
                fap = from_dir_abspath + '/' + f
687
1073
                
688
1074
                f_ie = inv.get_child(from_dir_id, f)
689
1075
                if f_ie:
690
1076
                    c = 'V'
691
 
                elif self.is_ignored(fp):
 
1077
                elif self.is_ignored(fp[1:]):
692
1078
                    c = 'I'
693
1079
                else:
694
 
                    c = '?'
 
1080
                    # we may not have found this file, because of a unicode issue
 
1081
                    f_norm, can_access = osutils.normalized_filename(f)
 
1082
                    if f == f_norm or not can_access:
 
1083
                        # No change, so treat this file normally
 
1084
                        c = '?'
 
1085
                    else:
 
1086
                        # this file can be accessed by a normalized path
 
1087
                        # check again if it is versioned
 
1088
                        # these lines are repeated here for performance
 
1089
                        f = f_norm
 
1090
                        fp = from_dir_relpath + '/' + f
 
1091
                        fap = from_dir_abspath + '/' + f
 
1092
                        f_ie = inv.get_child(from_dir_id, f)
 
1093
                        if f_ie:
 
1094
                            c = 'V'
 
1095
                        elif self.is_ignored(fp[1:]):
 
1096
                            c = 'I'
 
1097
                        else:
 
1098
                            c = '?'
695
1099
 
696
1100
                fk = file_kind(fap)
697
1101
 
698
1102
                if f_ie:
699
1103
                    if f_ie.kind != fk:
700
 
                        raise BzrCheckError("file %r entered as kind %r id %r, "
701
 
                                            "now of kind %r"
702
 
                                            % (fap, f_ie.kind, f_ie.file_id, fk))
 
1104
                        raise errors.BzrCheckError(
 
1105
                            "file %r entered as kind %r id %r, now of kind %r"
 
1106
                            % (fap, f_ie.kind, f_ie.file_id, fk))
703
1107
 
704
1108
                # make a last minute entry
705
1109
                if f_ie:
706
 
                    entry = f_ie
 
1110
                    yield fp[1:], c, fk, f_ie.file_id, f_ie
707
1111
                else:
708
 
                    if fk == 'directory':
709
 
                        entry = TreeDirectory()
710
 
                    elif fk == 'file':
711
 
                        entry = TreeFile()
712
 
                    elif fk == 'symlink':
713
 
                        entry = TreeLink()
714
 
                    else:
715
 
                        entry = TreeEntry()
 
1112
                    try:
 
1113
                        yield fp[1:], c, fk, None, fk_entries[fk]()
 
1114
                    except KeyError:
 
1115
                        yield fp[1:], c, fk, None, TreeEntry()
 
1116
                    continue
716
1117
                
717
 
                yield fp, c, fk, (f_ie and f_ie.file_id), entry
718
 
 
719
1118
                if fk != 'directory':
720
1119
                    continue
721
1120
 
722
 
                if c != 'V':
723
 
                    # don't descend unversioned directories
724
 
                    continue
725
 
                
726
 
                for ff in descend(fp, f_ie.file_id, fap):
727
 
                    yield ff
728
 
 
729
 
        for f in descend(u'', inv.root.file_id, self.basedir):
730
 
            yield f
731
 
 
732
 
    @needs_write_lock
733
 
    def move(self, from_paths, to_name):
 
1121
                # But do this child first
 
1122
                new_children = os.listdir(fap)
 
1123
                new_children.sort()
 
1124
                new_children = collections.deque(new_children)
 
1125
                stack.append((f_ie.file_id, fp, fap, new_children))
 
1126
                # Break out of inner loop,
 
1127
                # so that we start outer loop with child
 
1128
                break
 
1129
            else:
 
1130
                # if we finished all children, pop it off the stack
 
1131
                stack.pop()
 
1132
 
 
1133
    @needs_tree_write_lock
 
1134
    def move(self, from_paths, to_dir=None, after=False, **kwargs):
734
1135
        """Rename files.
735
1136
 
736
 
        to_name must exist in the inventory.
 
1137
        to_dir must exist in the inventory.
737
1138
 
738
 
        If to_name exists and is a directory, the files are moved into
 
1139
        If to_dir exists and is a directory, the files are moved into
739
1140
        it, keeping their old names.  
740
1141
 
741
 
        Note that to_name is only the last component of the new name;
 
1142
        Note that to_dir is only the last component of the new name;
742
1143
        this doesn't change the directory.
743
1144
 
 
1145
        For each entry in from_paths the move mode will be determined
 
1146
        independently.
 
1147
 
 
1148
        The first mode moves the file in the filesystem and updates the
 
1149
        inventory. The second mode only updates the inventory without
 
1150
        touching the file on the filesystem. This is the new mode introduced
 
1151
        in version 0.15.
 
1152
 
 
1153
        move uses the second mode if 'after == True' and the target is not
 
1154
        versioned but present in the working tree.
 
1155
 
 
1156
        move uses the second mode if 'after == False' and the source is
 
1157
        versioned but no longer in the working tree, and the target is not
 
1158
        versioned but present in the working tree.
 
1159
 
 
1160
        move uses the first mode if 'after == False' and the source is
 
1161
        versioned and present in the working tree, and the target is not
 
1162
        versioned and not present in the working tree.
 
1163
 
 
1164
        Everything else results in an error.
 
1165
 
744
1166
        This returns a list of (from_path, to_path) pairs for each
745
1167
        entry that is moved.
746
1168
        """
747
 
        result = []
748
 
        ## TODO: Option to move IDs only
 
1169
        rename_entries = []
 
1170
        rename_tuples = []
 
1171
 
 
1172
        # check for deprecated use of signature
 
1173
        if to_dir is None:
 
1174
            to_dir = kwargs.get('to_name', None)
 
1175
            if to_dir is None:
 
1176
                raise TypeError('You must supply a target directory')
 
1177
            else:
 
1178
                symbol_versioning.warn('The parameter to_name was deprecated'
 
1179
                                       ' in version 0.13. Use to_dir instead',
 
1180
                                       DeprecationWarning)
 
1181
 
 
1182
        # check destination directory
749
1183
        assert not isinstance(from_paths, basestring)
750
1184
        inv = self.inventory
751
 
        to_abs = self.abspath(to_name)
 
1185
        to_abs = self.abspath(to_dir)
752
1186
        if not isdir(to_abs):
753
 
            raise BzrError("destination %r is not a directory" % to_abs)
754
 
        if not self.has_filename(to_name):
755
 
            raise BzrError("destination %r not in working directory" % to_abs)
756
 
        to_dir_id = inv.path2id(to_name)
757
 
        if to_dir_id == None and to_name != '':
758
 
            raise BzrError("destination %r is not a versioned directory" % to_name)
 
1187
            raise errors.BzrMoveFailedError('',to_dir,
 
1188
                errors.NotADirectory(to_abs))
 
1189
        if not self.has_filename(to_dir):
 
1190
            raise errors.BzrMoveFailedError('',to_dir,
 
1191
                errors.NotInWorkingDirectory(to_dir))
 
1192
        to_dir_id = inv.path2id(to_dir)
 
1193
        if to_dir_id is None:
 
1194
            raise errors.BzrMoveFailedError('',to_dir,
 
1195
                errors.NotVersionedError(path=str(to_dir)))
 
1196
 
759
1197
        to_dir_ie = inv[to_dir_id]
760
 
        if to_dir_ie.kind not in ('directory', 'root_directory'):
761
 
            raise BzrError("destination %r is not a directory" % to_abs)
762
 
 
763
 
        to_idpath = inv.get_idpath(to_dir_id)
764
 
 
765
 
        for f in from_paths:
766
 
            if not self.has_filename(f):
767
 
                raise BzrError("%r does not exist in working tree" % f)
768
 
            f_id = inv.path2id(f)
769
 
            if f_id == None:
770
 
                raise BzrError("%r is not versioned" % f)
771
 
            name_tail = splitpath(f)[-1]
772
 
            dest_path = appendpath(to_name, name_tail)
773
 
            if self.has_filename(dest_path):
774
 
                raise BzrError("destination %r already exists" % dest_path)
775
 
            if f_id in to_idpath:
776
 
                raise BzrError("can't move %r to a subdirectory of itself" % f)
777
 
 
778
 
        # OK, so there's a race here, it's possible that someone will
779
 
        # create a file in this interval and then the rename might be
780
 
        # left half-done.  But we should have caught most problems.
781
 
        orig_inv = deepcopy(self.inventory)
 
1198
        if to_dir_ie.kind != 'directory':
 
1199
            raise errors.BzrMoveFailedError('',to_dir,
 
1200
                errors.NotADirectory(to_abs))
 
1201
 
 
1202
        # create rename entries and tuples
 
1203
        for from_rel in from_paths:
 
1204
            from_tail = splitpath(from_rel)[-1]
 
1205
            from_id = inv.path2id(from_rel)
 
1206
            if from_id is None:
 
1207
                raise errors.BzrMoveFailedError(from_rel,to_dir,
 
1208
                    errors.NotVersionedError(path=str(from_rel)))
 
1209
 
 
1210
            from_entry = inv[from_id]
 
1211
            from_parent_id = from_entry.parent_id
 
1212
            to_rel = pathjoin(to_dir, from_tail)
 
1213
            rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
 
1214
                                         from_id=from_id,
 
1215
                                         from_tail=from_tail,
 
1216
                                         from_parent_id=from_parent_id,
 
1217
                                         to_rel=to_rel, to_tail=from_tail,
 
1218
                                         to_parent_id=to_dir_id)
 
1219
            rename_entries.append(rename_entry)
 
1220
            rename_tuples.append((from_rel, to_rel))
 
1221
 
 
1222
        # determine which move mode to use. checks also for movability
 
1223
        rename_entries = self._determine_mv_mode(rename_entries, after)
 
1224
 
 
1225
        original_modified = self._inventory_is_modified
782
1226
        try:
783
 
            for f in from_paths:
784
 
                name_tail = splitpath(f)[-1]
785
 
                dest_path = appendpath(to_name, name_tail)
786
 
                result.append((f, dest_path))
787
 
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
788
 
                try:
789
 
                    rename(self.abspath(f), self.abspath(dest_path))
790
 
                except OSError, e:
791
 
                    raise BzrError("failed to rename %r to %r: %s" %
792
 
                                   (f, dest_path, e[1]),
793
 
                            ["rename rolled back"])
 
1227
            if len(from_paths):
 
1228
                self._inventory_is_modified = True
 
1229
            self._move(rename_entries)
794
1230
        except:
795
1231
            # restore the inventory on error
796
 
            self._set_inventory(orig_inv)
 
1232
            self._inventory_is_modified = original_modified
797
1233
            raise
798
1234
        self._write_inventory(inv)
799
 
        return result
800
 
 
801
 
    @needs_write_lock
802
 
    def rename_one(self, from_rel, to_rel):
 
1235
        return rename_tuples
 
1236
 
 
1237
    def _determine_mv_mode(self, rename_entries, after=False):
 
1238
        """Determines for each from-to pair if both inventory and working tree
 
1239
        or only the inventory has to be changed.
 
1240
 
 
1241
        Also does basic plausability tests.
 
1242
        """
 
1243
        inv = self.inventory
 
1244
 
 
1245
        for rename_entry in rename_entries:
 
1246
            # store to local variables for easier reference
 
1247
            from_rel = rename_entry.from_rel
 
1248
            from_id = rename_entry.from_id
 
1249
            to_rel = rename_entry.to_rel
 
1250
            to_id = inv.path2id(to_rel)
 
1251
            only_change_inv = False
 
1252
 
 
1253
            # check the inventory for source and destination
 
1254
            if from_id is None:
 
1255
                raise errors.BzrMoveFailedError(from_rel,to_rel,
 
1256
                    errors.NotVersionedError(path=str(from_rel)))
 
1257
            if to_id is not None:
 
1258
                raise errors.BzrMoveFailedError(from_rel,to_rel,
 
1259
                    errors.AlreadyVersionedError(path=str(to_rel)))
 
1260
 
 
1261
            # try to determine the mode for rename (only change inv or change
 
1262
            # inv and file system)
 
1263
            if after:
 
1264
                if not self.has_filename(to_rel):
 
1265
                    raise errors.BzrMoveFailedError(from_id,to_rel,
 
1266
                        errors.NoSuchFile(path=str(to_rel),
 
1267
                        extra="New file has not been created yet"))
 
1268
                only_change_inv = True
 
1269
            elif not self.has_filename(from_rel) and self.has_filename(to_rel):
 
1270
                only_change_inv = True
 
1271
            elif self.has_filename(from_rel) and not self.has_filename(to_rel):
 
1272
                only_change_inv = False
 
1273
            else:
 
1274
                # something is wrong, so lets determine what exactly
 
1275
                if not self.has_filename(from_rel) and \
 
1276
                   not self.has_filename(to_rel):
 
1277
                    raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1278
                        errors.PathsDoNotExist(paths=(str(from_rel),
 
1279
                        str(to_rel))))
 
1280
                else:
 
1281
                    raise errors.RenameFailedFilesExist(from_rel, to_rel,
 
1282
                        extra="(Use --after to update the Bazaar id)")
 
1283
            rename_entry.only_change_inv = only_change_inv
 
1284
        return rename_entries
 
1285
 
 
1286
    def _move(self, rename_entries):
 
1287
        """Moves a list of files.
 
1288
 
 
1289
        Depending on the value of the flag 'only_change_inv', the
 
1290
        file will be moved on the file system or not.
 
1291
        """
 
1292
        inv = self.inventory
 
1293
        moved = []
 
1294
 
 
1295
        for entry in rename_entries:
 
1296
            try:
 
1297
                self._move_entry(entry)
 
1298
            except:
 
1299
                self._rollback_move(moved)
 
1300
                raise
 
1301
            moved.append(entry)
 
1302
 
 
1303
    def _rollback_move(self, moved):
 
1304
        """Try to rollback a previous move in case of an filesystem error."""
 
1305
        inv = self.inventory
 
1306
        for entry in moved:
 
1307
            try:
 
1308
                self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
 
1309
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
 
1310
                    entry.from_tail, entry.from_parent_id,
 
1311
                    entry.only_change_inv))
 
1312
            except errors.BzrMoveFailedError, e:
 
1313
                raise errors.BzrMoveFailedError( '', '', "Rollback failed."
 
1314
                        " The working tree is in an inconsistent state."
 
1315
                        " Please consider doing a 'bzr revert'."
 
1316
                        " Error message is: %s" % e)
 
1317
 
 
1318
    def _move_entry(self, entry):
 
1319
        inv = self.inventory
 
1320
        from_rel_abs = self.abspath(entry.from_rel)
 
1321
        to_rel_abs = self.abspath(entry.to_rel)
 
1322
        if from_rel_abs == to_rel_abs:
 
1323
            raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
 
1324
                "Source and target are identical.")
 
1325
 
 
1326
        if not entry.only_change_inv:
 
1327
            try:
 
1328
                osutils.rename(from_rel_abs, to_rel_abs)
 
1329
            except OSError, e:
 
1330
                raise errors.BzrMoveFailedError(entry.from_rel,
 
1331
                    entry.to_rel, e[1])
 
1332
        inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
 
1333
 
 
1334
    @needs_tree_write_lock
 
1335
    def rename_one(self, from_rel, to_rel, after=False):
803
1336
        """Rename one file.
804
1337
 
805
1338
        This can change the directory or the filename or both.
 
1339
 
 
1340
        rename_one has several 'modes' to work. First, it can rename a physical
 
1341
        file and change the file_id. That is the normal mode. Second, it can
 
1342
        only change the file_id without touching any physical file. This is
 
1343
        the new mode introduced in version 0.15.
 
1344
 
 
1345
        rename_one uses the second mode if 'after == True' and 'to_rel' is not
 
1346
        versioned but present in the working tree.
 
1347
 
 
1348
        rename_one uses the second mode if 'after == False' and 'from_rel' is
 
1349
        versioned but no longer in the working tree, and 'to_rel' is not
 
1350
        versioned but present in the working tree.
 
1351
 
 
1352
        rename_one uses the first mode if 'after == False' and 'from_rel' is
 
1353
        versioned and present in the working tree, and 'to_rel' is not
 
1354
        versioned and not present in the working tree.
 
1355
 
 
1356
        Everything else results in an error.
806
1357
        """
807
1358
        inv = self.inventory
808
 
        if not self.has_filename(from_rel):
809
 
            raise BzrError("can't rename: old working file %r does not exist" % from_rel)
810
 
        if self.has_filename(to_rel):
811
 
            raise BzrError("can't rename: new working file %r already exists" % to_rel)
812
 
 
813
 
        file_id = inv.path2id(from_rel)
814
 
        if file_id == None:
815
 
            raise BzrError("can't rename: old name %r is not versioned" % from_rel)
816
 
 
817
 
        entry = inv[file_id]
818
 
        from_parent = entry.parent_id
819
 
        from_name = entry.name
820
 
        
821
 
        if inv.path2id(to_rel):
822
 
            raise BzrError("can't rename: new name %r is already versioned" % to_rel)
823
 
 
 
1359
        rename_entries = []
 
1360
 
 
1361
        # create rename entries and tuples
 
1362
        from_tail = splitpath(from_rel)[-1]
 
1363
        from_id = inv.path2id(from_rel)
 
1364
        if from_id is None:
 
1365
            raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1366
                errors.NotVersionedError(path=str(from_rel)))
 
1367
        from_entry = inv[from_id]
 
1368
        from_parent_id = from_entry.parent_id
824
1369
        to_dir, to_tail = os.path.split(to_rel)
825
1370
        to_dir_id = inv.path2id(to_dir)
826
 
        if to_dir_id == None and to_dir != '':
827
 
            raise BzrError("can't determine destination directory id for %r" % to_dir)
828
 
 
829
 
        mutter("rename_one:")
830
 
        mutter("  file_id    {%s}" % file_id)
831
 
        mutter("  from_rel   %r" % from_rel)
832
 
        mutter("  to_rel     %r" % to_rel)
833
 
        mutter("  to_dir     %r" % to_dir)
834
 
        mutter("  to_dir_id  {%s}" % to_dir_id)
835
 
 
836
 
        inv.rename(file_id, to_dir_id, to_tail)
837
 
 
838
 
        from_abs = self.abspath(from_rel)
839
 
        to_abs = self.abspath(to_rel)
840
 
        try:
841
 
            rename(from_abs, to_abs)
842
 
        except OSError, e:
843
 
            inv.rename(file_id, from_parent, from_name)
844
 
            raise BzrError("failed to rename %r to %r: %s"
845
 
                    % (from_abs, to_abs, e[1]),
846
 
                    ["rename rolled back"])
 
1371
        rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
 
1372
                                     from_id=from_id,
 
1373
                                     from_tail=from_tail,
 
1374
                                     from_parent_id=from_parent_id,
 
1375
                                     to_rel=to_rel, to_tail=to_tail,
 
1376
                                     to_parent_id=to_dir_id)
 
1377
        rename_entries.append(rename_entry)
 
1378
 
 
1379
        # determine which move mode to use. checks also for movability
 
1380
        rename_entries = self._determine_mv_mode(rename_entries, after)
 
1381
 
 
1382
        # check if the target changed directory and if the target directory is
 
1383
        # versioned
 
1384
        if to_dir_id is None:
 
1385
            raise errors.BzrMoveFailedError(from_rel,to_rel,
 
1386
                errors.NotVersionedError(path=str(to_dir)))
 
1387
 
 
1388
        # all checks done. now we can continue with our actual work
 
1389
        mutter('rename_one:\n'
 
1390
               '  from_id   {%s}\n'
 
1391
               '  from_rel: %r\n'
 
1392
               '  to_rel:   %r\n'
 
1393
               '  to_dir    %r\n'
 
1394
               '  to_dir_id {%s}\n',
 
1395
               from_id, from_rel, to_rel, to_dir, to_dir_id)
 
1396
 
 
1397
        self._move(rename_entries)
847
1398
        self._write_inventory(inv)
848
1399
 
 
1400
    class _RenameEntry(object):
 
1401
        def __init__(self, from_rel, from_id, from_tail, from_parent_id,
 
1402
                     to_rel, to_tail, to_parent_id, only_change_inv=False):
 
1403
            self.from_rel = from_rel
 
1404
            self.from_id = from_id
 
1405
            self.from_tail = from_tail
 
1406
            self.from_parent_id = from_parent_id
 
1407
            self.to_rel = to_rel
 
1408
            self.to_tail = to_tail
 
1409
            self.to_parent_id = to_parent_id
 
1410
            self.only_change_inv = only_change_inv
 
1411
 
849
1412
    @needs_read_lock
850
1413
    def unknowns(self):
851
1414
        """Return all unknown files.
852
1415
 
853
1416
        These are files in the working directory that are not versioned or
854
1417
        control files or ignored.
855
 
        
856
 
        >>> from bzrlib.bzrdir import ScratchDir
857
 
        >>> d = ScratchDir(files=['foo', 'foo~'])
858
 
        >>> b = d.open_branch()
859
 
        >>> tree = d.open_workingtree()
860
 
        >>> map(str, tree.unknowns())
861
 
        ['foo']
862
 
        >>> tree.add('foo')
863
 
        >>> list(b.unknowns())
864
 
        []
865
 
        >>> tree.remove('foo')
866
 
        >>> list(b.unknowns())
867
 
        [u'foo']
868
 
        """
869
 
        for subp in self.extras():
870
 
            if not self.is_ignored(subp):
871
 
                yield subp
872
 
 
 
1418
        """
 
1419
        # force the extras method to be fully executed before returning, to 
 
1420
        # prevent race conditions with the lock
 
1421
        return iter(
 
1422
            [subp for subp in self.extras() if not self.is_ignored(subp)])
 
1423
    
 
1424
    @needs_tree_write_lock
 
1425
    def unversion(self, file_ids):
 
1426
        """Remove the file ids in file_ids from the current versioned set.
 
1427
 
 
1428
        When a file_id is unversioned, all of its children are automatically
 
1429
        unversioned.
 
1430
 
 
1431
        :param file_ids: The file ids to stop versioning.
 
1432
        :raises: NoSuchId if any fileid is not currently versioned.
 
1433
        """
 
1434
        for file_id in file_ids:
 
1435
            file_id = osutils.safe_file_id(file_id)
 
1436
            if self._inventory.has_id(file_id):
 
1437
                self._inventory.remove_recursive_id(file_id)
 
1438
            else:
 
1439
                raise errors.NoSuchId(self, file_id)
 
1440
        if len(file_ids):
 
1441
            # in the future this should just set a dirty bit to wait for the 
 
1442
            # final unlock. However, until all methods of workingtree start
 
1443
            # with the current in -memory inventory rather than triggering 
 
1444
            # a read, it is more complex - we need to teach read_inventory
 
1445
            # to know when to read, and when to not read first... and possibly
 
1446
            # to save first when the in memory one may be corrupted.
 
1447
            # so for now, we just only write it if it is indeed dirty.
 
1448
            # - RBC 20060907
 
1449
            self._write_inventory(self._inventory)
 
1450
    
873
1451
    @deprecated_method(zero_eight)
874
1452
    def iter_conflicts(self):
875
1453
        """List all files in the tree that have text or content conflicts.
878
1456
 
879
1457
    def _iter_conflicts(self):
880
1458
        conflicted = set()
881
 
        for path in (s[0] for s in self.list_files()):
 
1459
        for info in self.list_files():
 
1460
            path = info[0]
882
1461
            stem = get_conflicted_stem(path)
883
1462
            if stem is None:
884
1463
                continue
887
1466
                yield stem
888
1467
 
889
1468
    @needs_write_lock
890
 
    def pull(self, source, overwrite=False, stop_revision=None):
 
1469
    def pull(self, source, overwrite=False, stop_revision=None,
 
1470
             change_reporter=None):
891
1471
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
892
1472
        source.lock_read()
893
1473
        try:
894
1474
            pp = ProgressPhase("Pull phase", 2, top_pb)
895
1475
            pp.next_phase()
896
 
            old_revision_history = self.branch.revision_history()
 
1476
            old_revision_info = self.branch.last_revision_info()
897
1477
            basis_tree = self.basis_tree()
898
1478
            count = self.branch.pull(source, overwrite, stop_revision)
899
 
            new_revision_history = self.branch.revision_history()
900
 
            if new_revision_history != old_revision_history:
 
1479
            new_revision_info = self.branch.last_revision_info()
 
1480
            if new_revision_info != old_revision_info:
901
1481
                pp.next_phase()
902
 
                if len(old_revision_history):
903
 
                    other_revision = old_revision_history[-1]
904
 
                else:
905
 
                    other_revision = None
906
1482
                repository = self.branch.repository
907
1483
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1484
                basis_tree.lock_read()
908
1485
                try:
909
 
                    merge_inner(self.branch,
910
 
                                self.branch.basis_tree(),
911
 
                                basis_tree, 
912
 
                                this_tree=self, 
913
 
                                pb=pb)
 
1486
                    new_basis_tree = self.branch.basis_tree()
 
1487
                    merge.merge_inner(
 
1488
                                self.branch,
 
1489
                                new_basis_tree,
 
1490
                                basis_tree,
 
1491
                                this_tree=self,
 
1492
                                pb=pb,
 
1493
                                change_reporter=change_reporter)
 
1494
                    if (basis_tree.inventory.root is None and
 
1495
                        new_basis_tree.inventory.root is not None):
 
1496
                        self.set_root_id(new_basis_tree.inventory.root.file_id)
914
1497
                finally:
915
1498
                    pb.finished()
916
 
                self.set_last_revision(self.branch.last_revision())
 
1499
                    basis_tree.unlock()
 
1500
                # TODO - dedup parents list with things merged by pull ?
 
1501
                # reuse the revisiontree we merged against to set the new
 
1502
                # tree data.
 
1503
                parent_trees = [(self.branch.last_revision(), new_basis_tree)]
 
1504
                # we have to pull the merge trees out again, because 
 
1505
                # merge_inner has set the ids. - this corner is not yet 
 
1506
                # layered well enough to prevent double handling.
 
1507
                # XXX TODO: Fix the double handling: telling the tree about
 
1508
                # the already known parent data is wasteful.
 
1509
                merges = self.get_parent_ids()[1:]
 
1510
                parent_trees.extend([
 
1511
                    (parent, repository.revision_tree(parent)) for
 
1512
                     parent in merges])
 
1513
                self.set_parent_trees(parent_trees)
917
1514
            return count
918
1515
        finally:
919
1516
            source.unlock()
920
1517
            top_pb.finished()
921
1518
 
 
1519
    @needs_write_lock
 
1520
    def put_file_bytes_non_atomic(self, file_id, bytes):
 
1521
        """See MutableTree.put_file_bytes_non_atomic."""
 
1522
        file_id = osutils.safe_file_id(file_id)
 
1523
        stream = file(self.id2abspath(file_id), 'wb')
 
1524
        try:
 
1525
            stream.write(bytes)
 
1526
        finally:
 
1527
            stream.close()
 
1528
        # TODO: update the hashcache here ?
 
1529
 
922
1530
    def extras(self):
923
 
        """Yield all unknown files in this WorkingTree.
 
1531
        """Yield all unversioned files in this WorkingTree.
924
1532
 
925
 
        If there are any unknown directories then only the directory is
926
 
        returned, not all its children.  But if there are unknown files
 
1533
        If there are any unversioned directories then only the directory is
 
1534
        returned, not all its children.  But if there are unversioned files
927
1535
        under a versioned subdirectory, they are returned.
928
1536
 
929
1537
        Currently returned depth-first, sorted by name within directories.
 
1538
        This is the same order used by 'osutils.walkdirs'.
930
1539
        """
931
1540
        ## TODO: Work from given directory downwards
932
1541
        for path, dir_entry in self.inventory.directories():
933
 
            mutter("search for unknowns in %r", path)
 
1542
            # mutter("search for unknowns in %r", path)
934
1543
            dirabs = self.abspath(path)
935
1544
            if not isdir(dirabs):
936
1545
                # e.g. directory deleted
938
1547
 
939
1548
            fl = []
940
1549
            for subf in os.listdir(dirabs):
941
 
                if (subf != '.bzr'
942
 
                    and (subf not in dir_entry.children)):
943
 
                    fl.append(subf)
 
1550
                if subf == '.bzr':
 
1551
                    continue
 
1552
                if subf not in dir_entry.children:
 
1553
                    subf_norm, can_access = osutils.normalized_filename(subf)
 
1554
                    if subf_norm != subf and can_access:
 
1555
                        if subf_norm not in dir_entry.children:
 
1556
                            fl.append(subf_norm)
 
1557
                    else:
 
1558
                        fl.append(subf)
944
1559
            
945
1560
            fl.sort()
946
1561
            for subf in fl:
947
 
                subp = appendpath(path, subf)
 
1562
                subp = pathjoin(path, subf)
948
1563
                yield subp
949
1564
 
950
 
 
951
1565
    def ignored_files(self):
952
1566
        """Yield list of PATH, IGNORE_PATTERN"""
953
1567
        for subp in self.extras():
954
1568
            pat = self.is_ignored(subp)
955
 
            if pat != None:
 
1569
            if pat is not None:
956
1570
                yield subp, pat
957
1571
 
958
 
 
959
1572
    def get_ignore_list(self):
960
1573
        """Return list of ignore patterns.
961
1574
 
962
1575
        Cached in the Tree object after the first call.
963
1576
        """
964
 
        if hasattr(self, '_ignorelist'):
965
 
            return self._ignorelist
 
1577
        ignoreset = getattr(self, '_ignoreset', None)
 
1578
        if ignoreset is not None:
 
1579
            return ignoreset
966
1580
 
967
 
        l = bzrlib.DEFAULT_IGNORE[:]
 
1581
        ignore_globs = set(bzrlib.DEFAULT_IGNORE)
 
1582
        ignore_globs.update(ignores.get_runtime_ignores())
 
1583
        ignore_globs.update(ignores.get_user_ignores())
968
1584
        if self.has_filename(bzrlib.IGNORE_FILENAME):
969
1585
            f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
970
 
            l.extend([line.rstrip("\n\r") for line in f.readlines()])
971
 
        self._ignorelist = l
972
 
        return l
 
1586
            try:
 
1587
                ignore_globs.update(ignores.parse_ignore_file(f))
 
1588
            finally:
 
1589
                f.close()
 
1590
        self._ignoreset = ignore_globs
 
1591
        return ignore_globs
973
1592
 
 
1593
    def _flush_ignore_list_cache(self):
 
1594
        """Resets the cached ignore list to force a cache rebuild."""
 
1595
        self._ignoreset = None
 
1596
        self._ignoreglobster = None
974
1597
 
975
1598
    def is_ignored(self, filename):
976
1599
        r"""Check whether the filename matches an ignore pattern.
981
1604
        If the file is ignored, returns the pattern which caused it to
982
1605
        be ignored, otherwise None.  So this can simply be used as a
983
1606
        boolean if desired."""
984
 
 
985
 
        # TODO: Use '**' to match directories, and other extended
986
 
        # globbing stuff from cvs/rsync.
987
 
 
988
 
        # XXX: fnmatch is actually not quite what we want: it's only
989
 
        # approximately the same as real Unix fnmatch, and doesn't
990
 
        # treat dotfiles correctly and allows * to match /.
991
 
        # Eventually it should be replaced with something more
992
 
        # accurate.
993
 
        
994
 
        for pat in self.get_ignore_list():
995
 
            if '/' in pat or '\\' in pat:
996
 
                
997
 
                # as a special case, you can put ./ at the start of a
998
 
                # pattern; this is good to match in the top-level
999
 
                # only;
1000
 
                
1001
 
                if (pat[:2] == './') or (pat[:2] == '.\\'):
1002
 
                    newpat = pat[2:]
1003
 
                else:
1004
 
                    newpat = pat
1005
 
                if fnmatch.fnmatchcase(filename, newpat):
1006
 
                    return pat
1007
 
            else:
1008
 
                if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
1009
 
                    return pat
1010
 
        else:
1011
 
            return None
 
1607
        if getattr(self, '_ignoreglobster', None) is None:
 
1608
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
 
1609
        return self._ignoreglobster.match(filename)
1012
1610
 
1013
1611
    def kind(self, file_id):
1014
1612
        return file_kind(self.id2abspath(file_id))
1015
1613
 
1016
 
    @needs_read_lock
 
1614
    def _comparison_data(self, entry, path):
 
1615
        abspath = self.abspath(path)
 
1616
        try:
 
1617
            stat_value = os.lstat(abspath)
 
1618
        except OSError, e:
 
1619
            if getattr(e, 'errno', None) == errno.ENOENT:
 
1620
                stat_value = None
 
1621
                kind = None
 
1622
                executable = False
 
1623
            else:
 
1624
                raise
 
1625
        else:
 
1626
            mode = stat_value.st_mode
 
1627
            kind = osutils.file_kind_from_stat_mode(mode)
 
1628
            if not supports_executable():
 
1629
                executable = entry.executable
 
1630
            else:
 
1631
                executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
 
1632
        return kind, executable, stat_value
 
1633
 
 
1634
    def _file_size(self, entry, stat_value):
 
1635
        return stat_value.st_size
 
1636
 
1017
1637
    def last_revision(self):
1018
 
        """Return the last revision id of this working tree.
1019
 
 
1020
 
        In early branch formats this was == the branch last_revision,
1021
 
        but that cannot be relied upon - for working tree operations,
1022
 
        always use tree.last_revision().
 
1638
        """Return the last revision of the branch for this tree.
 
1639
 
 
1640
        This format tree does not support a separate marker for last-revision
 
1641
        compared to the branch.
 
1642
 
 
1643
        See MutableTree.last_revision
1023
1644
        """
 
1645
        return self._last_revision()
 
1646
 
 
1647
    @needs_read_lock
 
1648
    def _last_revision(self):
 
1649
        """helper for get_parent_ids."""
1024
1650
        return self.branch.last_revision()
1025
1651
 
 
1652
    def is_locked(self):
 
1653
        return self._control_files.is_locked()
 
1654
 
 
1655
    def _must_be_locked(self):
 
1656
        if not self.is_locked():
 
1657
            raise errors.ObjectNotLocked(self)
 
1658
 
1026
1659
    def lock_read(self):
1027
1660
        """See Branch.lock_read, and WorkingTree.unlock."""
 
1661
        if not self.is_locked():
 
1662
            self._reset_data()
1028
1663
        self.branch.lock_read()
1029
1664
        try:
1030
1665
            return self._control_files.lock_read()
1032
1667
            self.branch.unlock()
1033
1668
            raise
1034
1669
 
 
1670
    def lock_tree_write(self):
 
1671
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
 
1672
        if not self.is_locked():
 
1673
            self._reset_data()
 
1674
        self.branch.lock_read()
 
1675
        try:
 
1676
            return self._control_files.lock_write()
 
1677
        except:
 
1678
            self.branch.unlock()
 
1679
            raise
 
1680
 
1035
1681
    def lock_write(self):
1036
 
        """See Branch.lock_write, and WorkingTree.unlock."""
 
1682
        """See MutableTree.lock_write, and WorkingTree.unlock."""
 
1683
        if not self.is_locked():
 
1684
            self._reset_data()
1037
1685
        self.branch.lock_write()
1038
1686
        try:
1039
1687
            return self._control_files.lock_write()
1041
1689
            self.branch.unlock()
1042
1690
            raise
1043
1691
 
 
1692
    def get_physical_lock_status(self):
 
1693
        return self._control_files.get_physical_lock_status()
 
1694
 
1044
1695
    def _basis_inventory_name(self):
1045
 
        return 'basis-inventory'
1046
 
 
1047
 
    @needs_write_lock
 
1696
        return 'basis-inventory-cache'
 
1697
 
 
1698
    def _reset_data(self):
 
1699
        """Reset transient data that cannot be revalidated."""
 
1700
        self._inventory_is_modified = False
 
1701
        result = self._deserialize(self._control_files.get('inventory'))
 
1702
        self._set_inventory(result, dirty=False)
 
1703
 
 
1704
    @needs_tree_write_lock
1048
1705
    def set_last_revision(self, new_revision):
1049
1706
        """Change the last revision in the working tree."""
 
1707
        new_revision = osutils.safe_revision_id(new_revision)
1050
1708
        if self._change_last_revision(new_revision):
1051
1709
            self._cache_basis_inventory(new_revision)
1052
1710
 
1059
1717
        if new_revision is None:
1060
1718
            self.branch.set_revision_history([])
1061
1719
            return False
1062
 
        # current format is locked in with the branch
1063
 
        revision_history = self.branch.revision_history()
1064
1720
        try:
1065
 
            position = revision_history.index(new_revision)
1066
 
        except ValueError:
1067
 
            raise errors.NoSuchRevision(self.branch, new_revision)
1068
 
        self.branch.set_revision_history(revision_history[:position + 1])
 
1721
            self.branch.generate_revision_history(new_revision)
 
1722
        except errors.NoSuchRevision:
 
1723
            # not present in the repo - dont try to set it deeper than the tip
 
1724
            self.branch.set_revision_history([new_revision])
1069
1725
        return True
1070
1726
 
 
1727
    def _write_basis_inventory(self, xml):
 
1728
        """Write the basis inventory XML to the basis-inventory file"""
 
1729
        assert isinstance(xml, str), 'serialised xml must be bytestring.'
 
1730
        path = self._basis_inventory_name()
 
1731
        sio = StringIO(xml)
 
1732
        self._control_files.put(path, sio)
 
1733
 
 
1734
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
 
1735
        """Create the text that will be saved in basis-inventory"""
 
1736
        # TODO: jam 20070209 This should be redundant, as the revision_id
 
1737
        #       as all callers should have already converted the revision_id to
 
1738
        #       utf8
 
1739
        inventory.revision_id = osutils.safe_revision_id(revision_id)
 
1740
        return xml7.serializer_v7.write_inventory_to_string(inventory)
 
1741
 
1071
1742
    def _cache_basis_inventory(self, new_revision):
1072
1743
        """Cache new_revision as the basis inventory."""
 
1744
        # TODO: this should allow the ready-to-use inventory to be passed in,
 
1745
        # as commit already has that ready-to-use [while the format is the
 
1746
        # same, that is].
1073
1747
        try:
1074
1748
            # this double handles the inventory - unpack and repack - 
1075
1749
            # but is easier to understand. We can/should put a conditional
1076
1750
            # in here based on whether the inventory is in the latest format
1077
1751
            # - perhaps we should repack all inventories on a repository
1078
1752
            # upgrade ?
1079
 
            inv = self.branch.repository.get_inventory(new_revision)
1080
 
            inv.revision_id = new_revision
1081
 
            xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1082
 
 
1083
 
            path = self._basis_inventory_name()
1084
 
            self._control_files.put_utf8(path, xml)
1085
 
        except WeaveRevisionNotPresent:
 
1753
            # the fast path is to copy the raw xml from the repository. If the
 
1754
            # xml contains 'revision_id="', then we assume the right 
 
1755
            # revision_id is set. We must check for this full string, because a
 
1756
            # root node id can legitimately look like 'revision_id' but cannot
 
1757
            # contain a '"'.
 
1758
            xml = self.branch.repository.get_inventory_xml(new_revision)
 
1759
            firstline = xml.split('\n', 1)[0]
 
1760
            if (not 'revision_id="' in firstline or 
 
1761
                'format="7"' not in firstline):
 
1762
                inv = self.branch.repository.deserialise_inventory(
 
1763
                    new_revision, xml)
 
1764
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
 
1765
            self._write_basis_inventory(xml)
 
1766
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1086
1767
            pass
1087
1768
 
1088
1769
    def read_basis_inventory(self):
1089
1770
        """Read the cached basis inventory."""
1090
1771
        path = self._basis_inventory_name()
1091
 
        return self._control_files.get_utf8(path).read()
 
1772
        return self._control_files.get(path).read()
1092
1773
        
1093
1774
    @needs_read_lock
1094
1775
    def read_working_inventory(self):
1095
 
        """Read the working inventory."""
 
1776
        """Read the working inventory.
 
1777
        
 
1778
        :raises errors.InventoryModified: read_working_inventory will fail
 
1779
            when the current in memory inventory has been modified.
 
1780
        """
 
1781
        # conceptually this should be an implementation detail of the tree. 
 
1782
        # XXX: Deprecate this.
1096
1783
        # ElementTree does its own conversion from UTF-8, so open in
1097
1784
        # binary.
1098
 
        result = bzrlib.xml5.serializer_v5.read_inventory(
1099
 
            self._control_files.get('inventory'))
1100
 
        self._set_inventory(result)
 
1785
        if self._inventory_is_modified:
 
1786
            raise errors.InventoryModified(self)
 
1787
        result = self._deserialize(self._control_files.get('inventory'))
 
1788
        self._set_inventory(result, dirty=False)
1101
1789
        return result
1102
1790
 
1103
 
    @needs_write_lock
1104
 
    def remove(self, files, verbose=False):
 
1791
    @needs_tree_write_lock
 
1792
    def remove(self, files, verbose=False, to_file=None):
1105
1793
        """Remove nominated files from the working inventory..
1106
1794
 
1107
1795
        This does not remove their text.  This does not run on XXX on what? RBC
1126
1814
        for f in files:
1127
1815
            fid = inv.path2id(f)
1128
1816
            if not fid:
1129
 
                # TODO: Perhaps make this just a warning, and continue?
1130
 
                # This tends to happen when 
1131
 
                raise NotVersionedError(path=f)
1132
 
            mutter("remove inventory entry %s {%s}", quotefn(f), fid)
1133
 
            if verbose:
1134
 
                # having remove it, it must be either ignored or unknown
1135
 
                if self.is_ignored(f):
1136
 
                    new_status = 'I'
1137
 
                else:
1138
 
                    new_status = '?'
1139
 
                show_status(new_status, inv[fid].kind, quotefn(f))
1140
 
            del inv[fid]
 
1817
                note("%s is not versioned."%f)
 
1818
            else:
 
1819
                if verbose:
 
1820
                    # having remove it, it must be either ignored or unknown
 
1821
                    if self.is_ignored(f):
 
1822
                        new_status = 'I'
 
1823
                    else:
 
1824
                        new_status = '?'
 
1825
                    textui.show_status(new_status, inv[fid].kind, f,
 
1826
                                       to_file=to_file)
 
1827
                del inv[fid]
1141
1828
 
1142
1829
        self._write_inventory(inv)
1143
1830
 
1144
 
    @needs_write_lock
 
1831
    @needs_tree_write_lock
1145
1832
    def revert(self, filenames, old_tree=None, backups=True, 
1146
 
               pb=DummyProgress()):
1147
 
        from transform import revert
1148
 
        from conflicts import resolve
 
1833
               pb=DummyProgress(), report_changes=False):
 
1834
        from bzrlib.conflicts import resolve
1149
1835
        if old_tree is None:
1150
1836
            old_tree = self.basis_tree()
1151
 
        conflicts = revert(self, old_tree, filenames, backups, pb)
 
1837
        conflicts = transform.revert(self, old_tree, filenames, backups, pb,
 
1838
                                     report_changes)
1152
1839
        if not len(filenames):
1153
 
            self.set_pending_merges([])
 
1840
            self.set_parent_ids(self.get_parent_ids()[:1])
1154
1841
            resolve(self)
1155
1842
        else:
1156
1843
            resolve(self, filenames, ignore_misses=True)
1157
1844
        return conflicts
1158
1845
 
 
1846
    def revision_tree(self, revision_id):
 
1847
        """See Tree.revision_tree.
 
1848
 
 
1849
        WorkingTree can supply revision_trees for the basis revision only
 
1850
        because there is only one cached inventory in the bzr directory.
 
1851
        """
 
1852
        if revision_id == self.last_revision():
 
1853
            try:
 
1854
                xml = self.read_basis_inventory()
 
1855
            except errors.NoSuchFile:
 
1856
                pass
 
1857
            else:
 
1858
                try:
 
1859
                    inv = xml7.serializer_v7.read_inventory_from_string(xml)
 
1860
                    # dont use the repository revision_tree api because we want
 
1861
                    # to supply the inventory.
 
1862
                    if inv.revision_id == revision_id:
 
1863
                        return revisiontree.RevisionTree(self.branch.repository,
 
1864
                            inv, revision_id)
 
1865
                except errors.BadInventoryFormat:
 
1866
                    pass
 
1867
        # raise if there was no inventory, or if we read the wrong inventory.
 
1868
        raise errors.NoSuchRevisionInTree(self, revision_id)
 
1869
 
1159
1870
    # XXX: This method should be deprecated in favour of taking in a proper
1160
1871
    # new Inventory object.
1161
 
    @needs_write_lock
 
1872
    @needs_tree_write_lock
1162
1873
    def set_inventory(self, new_inventory_list):
1163
1874
        from bzrlib.inventory import (Inventory,
1164
1875
                                      InventoryDirectory,
1178
1889
            elif kind == 'symlink':
1179
1890
                inv.add(InventoryLink(file_id, name, parent))
1180
1891
            else:
1181
 
                raise BzrError("unknown kind %r" % kind)
 
1892
                raise errors.BzrError("unknown kind %r" % kind)
1182
1893
        self._write_inventory(inv)
1183
1894
 
1184
 
    @needs_write_lock
 
1895
    @needs_tree_write_lock
1185
1896
    def set_root_id(self, file_id):
1186
1897
        """Set the root id for this tree."""
1187
 
        inv = self.read_working_inventory()
 
1898
        # for compatability 
 
1899
        if file_id is None:
 
1900
            symbol_versioning.warn(symbol_versioning.zero_twelve
 
1901
                % 'WorkingTree.set_root_id with fileid=None',
 
1902
                DeprecationWarning,
 
1903
                stacklevel=3)
 
1904
            file_id = ROOT_ID
 
1905
        else:
 
1906
            file_id = osutils.safe_file_id(file_id)
 
1907
        self._set_root_id(file_id)
 
1908
 
 
1909
    def _set_root_id(self, file_id):
 
1910
        """Set the root id for this tree, in a format specific manner.
 
1911
 
 
1912
        :param file_id: The file id to assign to the root. It must not be 
 
1913
            present in the current inventory or an error will occur. It must
 
1914
            not be None, but rather a valid file id.
 
1915
        """
 
1916
        inv = self._inventory
1188
1917
        orig_root_id = inv.root.file_id
 
1918
        # TODO: it might be nice to exit early if there was nothing
 
1919
        # to do, saving us from trigger a sync on unlock.
 
1920
        self._inventory_is_modified = True
 
1921
        # we preserve the root inventory entry object, but
 
1922
        # unlinkit from the byid index
1189
1923
        del inv._byid[inv.root.file_id]
1190
1924
        inv.root.file_id = file_id
 
1925
        # and link it into the index with the new changed id.
1191
1926
        inv._byid[inv.root.file_id] = inv.root
 
1927
        # and finally update all children to reference the new id.
 
1928
        # XXX: this should be safe to just look at the root.children
 
1929
        # list, not the WHOLE INVENTORY.
1192
1930
        for fid in inv:
1193
1931
            entry = inv[fid]
1194
1932
            if entry.parent_id == orig_root_id:
1195
1933
                entry.parent_id = inv.root.file_id
1196
 
        self._write_inventory(inv)
1197
1934
 
1198
1935
    def unlock(self):
1199
1936
        """See Branch.unlock.
1204
1941
        between multiple working trees, i.e. via shared storage, then we 
1205
1942
        would probably want to lock both the local tree, and the branch.
1206
1943
        """
1207
 
        # FIXME: We want to write out the hashcache only when the last lock on
1208
 
        # this working copy is released.  Peeking at the lock count is a bit
1209
 
        # of a nasty hack; probably it's better to have a transaction object,
1210
 
        # which can do some finalization when it's either successfully or
1211
 
        # unsuccessfully completed.  (Denys's original patch did that.)
1212
 
        # RBC 20060206 hookinhg into transaction will couple lock and transaction
1213
 
        # wrongly. Hookinh into unllock on the control files object is fine though.
1214
 
        
1215
 
        # TODO: split this per format so there is no ugly if block
1216
 
        if self._hashcache.needs_write and (
1217
 
            # dedicated lock files
1218
 
            self._control_files._lock_count==1 or 
1219
 
            # shared lock files
1220
 
            (self._control_files is self.branch.control_files and 
1221
 
             self._control_files._lock_count==3)):
1222
 
            self._hashcache.write()
1223
 
        # reverse order of locking.
1224
 
        result = self._control_files.unlock()
1225
 
        try:
1226
 
            self.branch.unlock()
1227
 
        finally:
1228
 
            return result
 
1944
        raise NotImplementedError(self.unlock)
1229
1945
 
1230
 
    @needs_write_lock
1231
1946
    def update(self):
1232
1947
        """Update a working tree along its branch.
1233
1948
 
1234
 
        This will update the branch if its bound too, which means we have multiple trees involved:
1235
 
        The new basis tree of the master.
1236
 
        The old basis tree of the branch.
1237
 
        The old basis tree of the working tree.
1238
 
        The current working tree state.
1239
 
        pathologically all three may be different, and non ancestors of each other.
1240
 
        Conceptually we want to:
1241
 
        Preserve the wt.basis->wt.state changes
1242
 
        Transform the wt.basis to the new master basis.
1243
 
        Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1244
 
        Restore the wt.basis->wt.state changes.
 
1949
        This will update the branch if its bound too, which means we have
 
1950
        multiple trees involved:
 
1951
 
 
1952
        - The new basis tree of the master.
 
1953
        - The old basis tree of the branch.
 
1954
        - The old basis tree of the working tree.
 
1955
        - The current working tree state.
 
1956
 
 
1957
        Pathologically, all three may be different, and non-ancestors of each
 
1958
        other.  Conceptually we want to:
 
1959
 
 
1960
        - Preserve the wt.basis->wt.state changes
 
1961
        - Transform the wt.basis to the new master basis.
 
1962
        - Apply a merge of the old branch basis to get any 'local' changes from
 
1963
          it into the tree.
 
1964
        - Restore the wt.basis->wt.state changes.
1245
1965
 
1246
1966
        There isn't a single operation at the moment to do that, so we:
1247
 
        Merge current state -> basis tree of the master w.r.t. the old tree basis.
1248
 
        Do a 'normal' merge of the old branch basis if it is relevant.
1249
 
        """
1250
 
        old_tip = self.branch.update()
1251
 
        if old_tip is not None:
1252
 
            self.add_pending_merge(old_tip)
1253
 
        self.branch.lock_read()
1254
 
        try:
1255
 
            result = 0
1256
 
            if self.last_revision() != self.branch.last_revision():
1257
 
                # merge tree state up to new branch tip.
1258
 
                basis = self.basis_tree()
 
1967
        - Merge current state -> basis tree of the master w.r.t. the old tree
 
1968
          basis.
 
1969
        - Do a 'normal' merge of the old branch basis if it is relevant.
 
1970
        """
 
1971
        if self.branch.get_master_branch() is not None:
 
1972
            self.lock_write()
 
1973
            update_branch = True
 
1974
        else:
 
1975
            self.lock_tree_write()
 
1976
            update_branch = False
 
1977
        try:
 
1978
            if update_branch:
 
1979
                old_tip = self.branch.update()
 
1980
            else:
 
1981
                old_tip = None
 
1982
            return self._update_tree(old_tip)
 
1983
        finally:
 
1984
            self.unlock()
 
1985
 
 
1986
    @needs_tree_write_lock
 
1987
    def _update_tree(self, old_tip=None):
 
1988
        """Update a tree to the master branch.
 
1989
 
 
1990
        :param old_tip: if supplied, the previous tip revision the branch,
 
1991
            before it was changed to the master branch's tip.
 
1992
        """
 
1993
        # here if old_tip is not None, it is the old tip of the branch before
 
1994
        # it was updated from the master branch. This should become a pending
 
1995
        # merge in the working tree to preserve the user existing work.  we
 
1996
        # cant set that until we update the working trees last revision to be
 
1997
        # one from the new branch, because it will just get absorbed by the
 
1998
        # parent de-duplication logic.
 
1999
        # 
 
2000
        # We MUST save it even if an error occurs, because otherwise the users
 
2001
        # local work is unreferenced and will appear to have been lost.
 
2002
        # 
 
2003
        result = 0
 
2004
        try:
 
2005
            last_rev = self.get_parent_ids()[0]
 
2006
        except IndexError:
 
2007
            last_rev = None
 
2008
        if last_rev != self.branch.last_revision():
 
2009
            # merge tree state up to new branch tip.
 
2010
            basis = self.basis_tree()
 
2011
            basis.lock_read()
 
2012
            try:
1259
2013
                to_tree = self.branch.basis_tree()
1260
 
                result += merge_inner(self.branch,
 
2014
                if basis.inventory.root is None:
 
2015
                    self.set_root_id(to_tree.inventory.root.file_id)
 
2016
                    self.flush()
 
2017
                result += merge.merge_inner(
 
2018
                                      self.branch,
1261
2019
                                      to_tree,
1262
2020
                                      basis,
1263
2021
                                      this_tree=self)
1264
 
                self.set_last_revision(self.branch.last_revision())
1265
 
            if old_tip and old_tip != self.last_revision():
1266
 
                # our last revision was not the prior branch last reivison
1267
 
                # and we have converted that last revision to a pending merge.
1268
 
                # base is somewhere between the branch tip now
1269
 
                # and the now pending merge
1270
 
                from bzrlib.revision import common_ancestor
1271
 
                try:
1272
 
                    base_rev_id = common_ancestor(self.branch.last_revision(),
1273
 
                                                  old_tip,
1274
 
                                                  self.branch.repository)
1275
 
                except errors.NoCommonAncestor:
1276
 
                    base_rev_id = None
1277
 
                base_tree = self.branch.repository.revision_tree(base_rev_id)
1278
 
                other_tree = self.branch.repository.revision_tree(old_tip)
1279
 
                result += merge_inner(self.branch,
1280
 
                                      other_tree,
1281
 
                                      base_tree,
1282
 
                                      this_tree=self)
1283
 
            return result
1284
 
        finally:
1285
 
            self.branch.unlock()
1286
 
 
1287
 
    @needs_write_lock
 
2022
            finally:
 
2023
                basis.unlock()
 
2024
            # TODO - dedup parents list with things merged by pull ?
 
2025
            # reuse the tree we've updated to to set the basis:
 
2026
            parent_trees = [(self.branch.last_revision(), to_tree)]
 
2027
            merges = self.get_parent_ids()[1:]
 
2028
            # Ideally we ask the tree for the trees here, that way the working
 
2029
            # tree can decide whether to give us teh entire tree or give us a
 
2030
            # lazy initialised tree. dirstate for instance will have the trees
 
2031
            # in ram already, whereas a last-revision + basis-inventory tree
 
2032
            # will not, but also does not need them when setting parents.
 
2033
            for parent in merges:
 
2034
                parent_trees.append(
 
2035
                    (parent, self.branch.repository.revision_tree(parent)))
 
2036
            if old_tip is not None:
 
2037
                parent_trees.append(
 
2038
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
 
2039
            self.set_parent_trees(parent_trees)
 
2040
            last_rev = parent_trees[0][0]
 
2041
        else:
 
2042
            # the working tree had the same last-revision as the master
 
2043
            # branch did. We may still have pivot local work from the local
 
2044
            # branch into old_tip:
 
2045
            if old_tip is not None:
 
2046
                self.add_parent_tree_id(old_tip)
 
2047
        if old_tip and old_tip != last_rev:
 
2048
            # our last revision was not the prior branch last revision
 
2049
            # and we have converted that last revision to a pending merge.
 
2050
            # base is somewhere between the branch tip now
 
2051
            # and the now pending merge
 
2052
 
 
2053
            # Since we just modified the working tree and inventory, flush out
 
2054
            # the current state, before we modify it again.
 
2055
            # TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
 
2056
            #       requires it only because TreeTransform directly munges the
 
2057
            #       inventory and calls tree._write_inventory(). Ultimately we
 
2058
            #       should be able to remove this extra flush.
 
2059
            self.flush()
 
2060
            from bzrlib.revision import common_ancestor
 
2061
            try:
 
2062
                base_rev_id = common_ancestor(self.branch.last_revision(),
 
2063
                                              old_tip,
 
2064
                                              self.branch.repository)
 
2065
            except errors.NoCommonAncestor:
 
2066
                base_rev_id = None
 
2067
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
2068
            other_tree = self.branch.repository.revision_tree(old_tip)
 
2069
            result += merge.merge_inner(
 
2070
                                  self.branch,
 
2071
                                  other_tree,
 
2072
                                  base_tree,
 
2073
                                  this_tree=self)
 
2074
        return result
 
2075
 
 
2076
    def _write_hashcache_if_dirty(self):
 
2077
        """Write out the hashcache if it is dirty."""
 
2078
        if self._hashcache.needs_write:
 
2079
            try:
 
2080
                self._hashcache.write()
 
2081
            except OSError, e:
 
2082
                if e.errno not in (errno.EPERM, errno.EACCES):
 
2083
                    raise
 
2084
                # TODO: jam 20061219 Should this be a warning? A single line
 
2085
                #       warning might be sufficient to let the user know what
 
2086
                #       is going on.
 
2087
                mutter('Could not write hashcache for %s\nError: %s',
 
2088
                       self._hashcache.cache_file_name(), e)
 
2089
 
 
2090
    @needs_tree_write_lock
1288
2091
    def _write_inventory(self, inv):
1289
2092
        """Write inventory as the current inventory."""
1290
 
        sio = StringIO()
1291
 
        bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1292
 
        sio.seek(0)
1293
 
        self._control_files.put('inventory', sio)
1294
 
        self._set_inventory(inv)
1295
 
        mutter('wrote working inventory')
 
2093
        self._set_inventory(inv, dirty=True)
 
2094
        self.flush()
1296
2095
 
1297
2096
    def set_conflicts(self, arg):
1298
 
        raise UnsupportedOperation(self.set_conflicts, self)
 
2097
        raise errors.UnsupportedOperation(self.set_conflicts, self)
 
2098
 
 
2099
    def add_conflicts(self, arg):
 
2100
        raise errors.UnsupportedOperation(self.add_conflicts, self)
1299
2101
 
1300
2102
    @needs_read_lock
1301
2103
    def conflicts(self):
1302
 
        conflicts = ConflictList()
 
2104
        conflicts = _mod_conflicts.ConflictList()
1303
2105
        for conflicted in self._iter_conflicts():
1304
2106
            text = True
1305
2107
            try:
1306
2108
                if file_kind(self.abspath(conflicted)) != "file":
1307
2109
                    text = False
1308
 
            except OSError, e:
1309
 
                if e.errno == errno.ENOENT:
1310
 
                    text = False
1311
 
                else:
1312
 
                    raise
 
2110
            except errors.NoSuchFile:
 
2111
                text = False
1313
2112
            if text is True:
1314
2113
                for suffix in ('.THIS', '.OTHER'):
1315
2114
                    try:
1316
2115
                        kind = file_kind(self.abspath(conflicted+suffix))
1317
 
                    except OSError, e:
1318
 
                        if e.errno == errno.ENOENT:
 
2116
                        if kind != "file":
1319
2117
                            text = False
1320
 
                            break
1321
 
                        else:
1322
 
                            raise
1323
 
                    if kind != "file":
 
2118
                    except errors.NoSuchFile:
1324
2119
                        text = False
 
2120
                    if text == False:
1325
2121
                        break
1326
2122
            ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1327
 
            conflicts.append(Conflict.factory(ctype, path=conflicted,
 
2123
            conflicts.append(_mod_conflicts.Conflict.factory(ctype,
 
2124
                             path=conflicted,
1328
2125
                             file_id=self.path2id(conflicted)))
1329
2126
        return conflicts
1330
2127
 
 
2128
    def walkdirs(self, prefix=""):
 
2129
        """Walk the directories of this tree.
 
2130
 
 
2131
        This API returns a generator, which is only valid during the current
 
2132
        tree transaction - within a single lock_read or lock_write duration.
 
2133
 
 
2134
        If the tree is not locked, it may cause an error to be raised, depending
 
2135
        on the tree implementation.
 
2136
        """
 
2137
        disk_top = self.abspath(prefix)
 
2138
        if disk_top.endswith('/'):
 
2139
            disk_top = disk_top[:-1]
 
2140
        top_strip_len = len(disk_top) + 1
 
2141
        inventory_iterator = self._walkdirs(prefix)
 
2142
        disk_iterator = osutils.walkdirs(disk_top, prefix)
 
2143
        try:
 
2144
            current_disk = disk_iterator.next()
 
2145
            disk_finished = False
 
2146
        except OSError, e:
 
2147
            if e.errno != errno.ENOENT:
 
2148
                raise
 
2149
            current_disk = None
 
2150
            disk_finished = True
 
2151
        try:
 
2152
            current_inv = inventory_iterator.next()
 
2153
            inv_finished = False
 
2154
        except StopIteration:
 
2155
            current_inv = None
 
2156
            inv_finished = True
 
2157
        while not inv_finished or not disk_finished:
 
2158
            if not disk_finished:
 
2159
                # strip out .bzr dirs
 
2160
                if current_disk[0][1][top_strip_len:] == '':
 
2161
                    # osutils.walkdirs can be made nicer - 
 
2162
                    # yield the path-from-prefix rather than the pathjoined
 
2163
                    # value.
 
2164
                    bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
 
2165
                    if current_disk[1][bzrdir_loc][0] == '.bzr':
 
2166
                        # we dont yield the contents of, or, .bzr itself.
 
2167
                        del current_disk[1][bzrdir_loc]
 
2168
            if inv_finished:
 
2169
                # everything is unknown
 
2170
                direction = 1
 
2171
            elif disk_finished:
 
2172
                # everything is missing
 
2173
                direction = -1
 
2174
            else:
 
2175
                direction = cmp(current_inv[0][0], current_disk[0][0])
 
2176
            if direction > 0:
 
2177
                # disk is before inventory - unknown
 
2178
                dirblock = [(relpath, basename, kind, stat, None, None) for
 
2179
                    relpath, basename, kind, stat, top_path in current_disk[1]]
 
2180
                yield (current_disk[0][0], None), dirblock
 
2181
                try:
 
2182
                    current_disk = disk_iterator.next()
 
2183
                except StopIteration:
 
2184
                    disk_finished = True
 
2185
            elif direction < 0:
 
2186
                # inventory is before disk - missing.
 
2187
                dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
 
2188
                    for relpath, basename, dkind, stat, fileid, kind in 
 
2189
                    current_inv[1]]
 
2190
                yield (current_inv[0][0], current_inv[0][1]), dirblock
 
2191
                try:
 
2192
                    current_inv = inventory_iterator.next()
 
2193
                except StopIteration:
 
2194
                    inv_finished = True
 
2195
            else:
 
2196
                # versioned present directory
 
2197
                # merge the inventory and disk data together
 
2198
                dirblock = []
 
2199
                for relpath, subiterator in itertools.groupby(sorted(
 
2200
                    current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
 
2201
                    path_elements = list(subiterator)
 
2202
                    if len(path_elements) == 2:
 
2203
                        inv_row, disk_row = path_elements
 
2204
                        # versioned, present file
 
2205
                        dirblock.append((inv_row[0],
 
2206
                            inv_row[1], disk_row[2],
 
2207
                            disk_row[3], inv_row[4],
 
2208
                            inv_row[5]))
 
2209
                    elif len(path_elements[0]) == 5:
 
2210
                        # unknown disk file
 
2211
                        dirblock.append((path_elements[0][0],
 
2212
                            path_elements[0][1], path_elements[0][2],
 
2213
                            path_elements[0][3], None, None))
 
2214
                    elif len(path_elements[0]) == 6:
 
2215
                        # versioned, absent file.
 
2216
                        dirblock.append((path_elements[0][0],
 
2217
                            path_elements[0][1], 'unknown', None,
 
2218
                            path_elements[0][4], path_elements[0][5]))
 
2219
                    else:
 
2220
                        raise NotImplementedError('unreachable code')
 
2221
                yield current_inv[0], dirblock
 
2222
                try:
 
2223
                    current_inv = inventory_iterator.next()
 
2224
                except StopIteration:
 
2225
                    inv_finished = True
 
2226
                try:
 
2227
                    current_disk = disk_iterator.next()
 
2228
                except StopIteration:
 
2229
                    disk_finished = True
 
2230
 
 
2231
    def _walkdirs(self, prefix=""):
 
2232
        _directory = 'directory'
 
2233
        # get the root in the inventory
 
2234
        inv = self.inventory
 
2235
        top_id = inv.path2id(prefix)
 
2236
        if top_id is None:
 
2237
            pending = []
 
2238
        else:
 
2239
            pending = [(prefix, '', _directory, None, top_id, None)]
 
2240
        while pending:
 
2241
            dirblock = []
 
2242
            currentdir = pending.pop()
 
2243
            # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
 
2244
            top_id = currentdir[4]
 
2245
            if currentdir[0]:
 
2246
                relroot = currentdir[0] + '/'
 
2247
            else:
 
2248
                relroot = ""
 
2249
            # FIXME: stash the node in pending
 
2250
            entry = inv[top_id]
 
2251
            for name, child in entry.sorted_children():
 
2252
                dirblock.append((relroot + name, name, child.kind, None,
 
2253
                    child.file_id, child.kind
 
2254
                    ))
 
2255
            yield (currentdir[0], entry.file_id), dirblock
 
2256
            # push the user specified dirs from dirblock
 
2257
            for dir in reversed(dirblock):
 
2258
                if dir[2] == _directory:
 
2259
                    pending.append(dir)
 
2260
 
 
2261
    @needs_tree_write_lock
 
2262
    def auto_resolve(self):
 
2263
        """Automatically resolve text conflicts according to contents.
 
2264
 
 
2265
        Only text conflicts are auto_resolvable. Files with no conflict markers
 
2266
        are considered 'resolved', because bzr always puts conflict markers
 
2267
        into files that have text conflicts.  The corresponding .THIS .BASE and
 
2268
        .OTHER files are deleted, as per 'resolve'.
 
2269
        :return: a tuple of ConflictLists: (un_resolved, resolved).
 
2270
        """
 
2271
        un_resolved = _mod_conflicts.ConflictList()
 
2272
        resolved = _mod_conflicts.ConflictList()
 
2273
        conflict_re = re.compile('^(<{7}|={7}|>{7})')
 
2274
        for conflict in self.conflicts():
 
2275
            if (conflict.typestring != 'text conflict' or
 
2276
                self.kind(conflict.file_id) != 'file'):
 
2277
                un_resolved.append(conflict)
 
2278
                continue
 
2279
            my_file = open(self.id2abspath(conflict.file_id), 'rb')
 
2280
            try:
 
2281
                for line in my_file:
 
2282
                    if conflict_re.search(line):
 
2283
                        un_resolved.append(conflict)
 
2284
                        break
 
2285
                else:
 
2286
                    resolved.append(conflict)
 
2287
            finally:
 
2288
                my_file.close()
 
2289
        resolved.remove_files(self)
 
2290
        self.set_conflicts(un_resolved)
 
2291
        return un_resolved, resolved
 
2292
 
 
2293
 
 
2294
class WorkingTree2(WorkingTree):
 
2295
    """This is the Format 2 working tree.
 
2296
 
 
2297
    This was the first weave based working tree. 
 
2298
     - uses os locks for locking.
 
2299
     - uses the branch last-revision.
 
2300
    """
 
2301
 
 
2302
    def lock_tree_write(self):
 
2303
        """See WorkingTree.lock_tree_write().
 
2304
 
 
2305
        In Format2 WorkingTrees we have a single lock for the branch and tree
 
2306
        so lock_tree_write() degrades to lock_write().
 
2307
        """
 
2308
        self.branch.lock_write()
 
2309
        try:
 
2310
            return self._control_files.lock_write()
 
2311
        except:
 
2312
            self.branch.unlock()
 
2313
            raise
 
2314
 
 
2315
    def unlock(self):
 
2316
        # we share control files:
 
2317
        if self._control_files._lock_count == 3:
 
2318
            # _inventory_is_modified is always False during a read lock.
 
2319
            if self._inventory_is_modified:
 
2320
                self.flush()
 
2321
            self._write_hashcache_if_dirty()
 
2322
                    
 
2323
        # reverse order of locking.
 
2324
        try:
 
2325
            return self._control_files.unlock()
 
2326
        finally:
 
2327
            self.branch.unlock()
 
2328
 
1331
2329
 
1332
2330
class WorkingTree3(WorkingTree):
1333
2331
    """This is the Format 3 working tree.
1340
2338
    """
1341
2339
 
1342
2340
    @needs_read_lock
1343
 
    def last_revision(self):
1344
 
        """See WorkingTree.last_revision."""
 
2341
    def _last_revision(self):
 
2342
        """See Mutable.last_revision."""
1345
2343
        try:
1346
 
            return self._control_files.get_utf8('last-revision').read()
1347
 
        except NoSuchFile:
 
2344
            return osutils.safe_revision_id(
 
2345
                        self._control_files.get('last-revision').read())
 
2346
        except errors.NoSuchFile:
1348
2347
            return None
1349
2348
 
1350
2349
    def _change_last_revision(self, revision_id):
1356
2355
                pass
1357
2356
            return False
1358
2357
        else:
1359
 
            try:
1360
 
                self.branch.revision_history().index(revision_id)
1361
 
            except ValueError:
1362
 
                raise errors.NoSuchRevision(self.branch, revision_id)
1363
 
            self._control_files.put_utf8('last-revision', revision_id)
 
2358
            self._control_files.put_bytes('last-revision', revision_id)
1364
2359
            return True
1365
2360
 
1366
 
    @needs_write_lock
 
2361
    @needs_tree_write_lock
1367
2362
    def set_conflicts(self, conflicts):
1368
2363
        self._put_rio('conflicts', conflicts.to_stanzas(), 
1369
2364
                      CONFLICT_HEADER_1)
1370
2365
 
 
2366
    @needs_tree_write_lock
 
2367
    def add_conflicts(self, new_conflicts):
 
2368
        conflict_set = set(self.conflicts())
 
2369
        conflict_set.update(set(list(new_conflicts)))
 
2370
        self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
 
2371
                                       key=_mod_conflicts.Conflict.sort_key)))
 
2372
 
1371
2373
    @needs_read_lock
1372
2374
    def conflicts(self):
1373
2375
        try:
1374
2376
            confile = self._control_files.get('conflicts')
1375
 
        except NoSuchFile:
1376
 
            return ConflictList()
 
2377
        except errors.NoSuchFile:
 
2378
            return _mod_conflicts.ConflictList()
1377
2379
        try:
1378
2380
            if confile.next() != CONFLICT_HEADER_1 + '\n':
1379
 
                raise ConflictFormatError()
 
2381
                raise errors.ConflictFormatError()
1380
2382
        except StopIteration:
1381
 
            raise ConflictFormatError()
1382
 
        return ConflictList.from_stanzas(RioReader(confile))
 
2383
            raise errors.ConflictFormatError()
 
2384
        return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
 
2385
 
 
2386
    def unlock(self):
 
2387
        if self._control_files._lock_count == 1:
 
2388
            # _inventory_is_modified is always False during a read lock.
 
2389
            if self._inventory_is_modified:
 
2390
                self.flush()
 
2391
            self._write_hashcache_if_dirty()
 
2392
        # reverse order of locking.
 
2393
        try:
 
2394
            return self._control_files.unlock()
 
2395
        finally:
 
2396
            self.branch.unlock()
1383
2397
 
1384
2398
 
1385
2399
def get_conflicted_stem(path):
1386
 
    for suffix in CONFLICT_SUFFIXES:
 
2400
    for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
1387
2401
        if path.endswith(suffix):
1388
2402
            return path[:-len(suffix)]
1389
2403
 
 
2404
 
1390
2405
@deprecated_function(zero_eight)
1391
2406
def is_control_file(filename):
1392
2407
    """See WorkingTree.is_control_filename(filename)."""
1427
2442
    _formats = {}
1428
2443
    """The known formats."""
1429
2444
 
 
2445
    requires_rich_root = False
 
2446
 
1430
2447
    @classmethod
1431
2448
    def find_format(klass, a_bzrdir):
1432
2449
        """Return the format for the working tree object in a_bzrdir."""
1434
2451
            transport = a_bzrdir.get_workingtree_transport(None)
1435
2452
            format_string = transport.get("format").read()
1436
2453
            return klass._formats[format_string]
1437
 
        except NoSuchFile:
 
2454
        except errors.NoSuchFile:
1438
2455
            raise errors.NoWorkingTree(base=transport.base)
1439
2456
        except KeyError:
1440
 
            raise errors.UnknownFormatError(format_string)
 
2457
            raise errors.UnknownFormatError(format=format_string)
 
2458
 
 
2459
    def __eq__(self, other):
 
2460
        return self.__class__ is other.__class__
 
2461
 
 
2462
    def __ne__(self, other):
 
2463
        return not (self == other)
1441
2464
 
1442
2465
    @classmethod
1443
2466
    def get_default_format(klass):
1486
2509
        """See WorkingTreeFormat.get_format_description()."""
1487
2510
        return "Working tree format 2"
1488
2511
 
 
2512
    def stub_initialize_remote(self, control_files):
 
2513
        """As a special workaround create critical control files for a remote working tree
 
2514
        
 
2515
        This ensures that it can later be updated and dealt with locally,
 
2516
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with 
 
2517
        no working tree.  (See bug #43064).
 
2518
        """
 
2519
        sio = StringIO()
 
2520
        inv = Inventory()
 
2521
        xml5.serializer_v5.write_inventory(inv, sio)
 
2522
        sio.seek(0)
 
2523
        control_files.put('inventory', sio)
 
2524
 
 
2525
        control_files.put_bytes('pending-merges', '')
 
2526
        
 
2527
 
1489
2528
    def initialize(self, a_bzrdir, revision_id=None):
1490
2529
        """See WorkingTreeFormat.initialize()."""
1491
2530
        if not isinstance(a_bzrdir.transport, LocalTransport):
1492
2531
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
1493
2532
        branch = a_bzrdir.open_branch()
1494
2533
        if revision_id is not None:
 
2534
            revision_id = osutils.safe_revision_id(revision_id)
1495
2535
            branch.lock_write()
1496
2536
            try:
1497
2537
                revision_history = branch.revision_history()
1503
2543
            finally:
1504
2544
                branch.unlock()
1505
2545
        revision = branch.last_revision()
1506
 
        inv = Inventory() 
1507
 
        wt = WorkingTree(a_bzrdir.root_transport.base,
 
2546
        inv = Inventory()
 
2547
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1508
2548
                         branch,
1509
2549
                         inv,
1510
2550
                         _internal=True,
1511
2551
                         _format=self,
1512
2552
                         _bzrdir=a_bzrdir)
1513
 
        wt._write_inventory(inv)
1514
 
        wt.set_root_id(inv.root.file_id)
1515
 
        wt.set_last_revision(revision)
1516
 
        wt.set_pending_merges([])
1517
 
        build_tree(wt.basis_tree(), wt)
 
2553
        basis_tree = branch.repository.revision_tree(revision)
 
2554
        if basis_tree.inventory.root is not None:
 
2555
            wt.set_root_id(basis_tree.inventory.root.file_id)
 
2556
        # set the parent list and cache the basis tree.
 
2557
        wt.set_parent_trees([(revision, basis_tree)])
 
2558
        transform.build_tree(basis_tree, wt)
1518
2559
        return wt
1519
2560
 
1520
2561
    def __init__(self):
1532
2573
            raise NotImplementedError
1533
2574
        if not isinstance(a_bzrdir.transport, LocalTransport):
1534
2575
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
1535
 
        return WorkingTree(a_bzrdir.root_transport.base,
 
2576
        return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1536
2577
                           _internal=True,
1537
2578
                           _format=self,
1538
2579
                           _bzrdir=a_bzrdir)
1547
2588
          files, separate from the BzrDir format
1548
2589
        - modifies the hash cache format
1549
2590
        - is new in bzr 0.8
1550
 
        - uses a LockDir to guard access to the repository
 
2591
        - uses a LockDir to guard access for writes.
1551
2592
    """
1552
2593
 
1553
2594
    def get_format_string(self):
1561
2602
    _lock_file_name = 'lock'
1562
2603
    _lock_class = LockDir
1563
2604
 
 
2605
    _tree_class = WorkingTree3
 
2606
 
 
2607
    def __get_matchingbzrdir(self):
 
2608
        return bzrdir.BzrDirMetaFormat1()
 
2609
 
 
2610
    _matchingbzrdir = property(__get_matchingbzrdir)
 
2611
 
1564
2612
    def _open_control_files(self, a_bzrdir):
1565
2613
        transport = a_bzrdir.get_workingtree_transport(None)
1566
2614
        return LockableFiles(transport, self._lock_file_name, 
1569
2617
    def initialize(self, a_bzrdir, revision_id=None):
1570
2618
        """See WorkingTreeFormat.initialize().
1571
2619
        
1572
 
        revision_id allows creating a working tree at a differnet
 
2620
        revision_id allows creating a working tree at a different
1573
2621
        revision than the branch is at.
1574
2622
        """
1575
2623
        if not isinstance(a_bzrdir.transport, LocalTransport):
1577
2625
        transport = a_bzrdir.get_workingtree_transport(self)
1578
2626
        control_files = self._open_control_files(a_bzrdir)
1579
2627
        control_files.create_lock()
 
2628
        control_files.lock_write()
1580
2629
        control_files.put_utf8('format', self.get_format_string())
1581
2630
        branch = a_bzrdir.open_branch()
1582
2631
        if revision_id is None:
1583
2632
            revision_id = branch.last_revision()
1584
 
        inv = Inventory() 
1585
 
        wt = WorkingTree3(a_bzrdir.root_transport.base,
 
2633
        else:
 
2634
            revision_id = osutils.safe_revision_id(revision_id)
 
2635
        # WorkingTree3 can handle an inventory which has a unique root id.
 
2636
        # as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
 
2637
        # those trees. And because there isn't a format bump inbetween, we
 
2638
        # are maintaining compatibility with older clients.
 
2639
        # inv = Inventory(root_id=gen_root_id())
 
2640
        inv = self._initial_inventory()
 
2641
        wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
1586
2642
                         branch,
1587
2643
                         inv,
1588
2644
                         _internal=True,
1589
2645
                         _format=self,
1590
2646
                         _bzrdir=a_bzrdir,
1591
2647
                         _control_files=control_files)
1592
 
        wt._write_inventory(inv)
1593
 
        wt.set_root_id(inv.root.file_id)
1594
 
        wt.set_last_revision(revision_id)
1595
 
        wt.set_pending_merges([])
1596
 
        build_tree(wt.basis_tree(), wt)
 
2648
        wt.lock_tree_write()
 
2649
        try:
 
2650
            basis_tree = branch.repository.revision_tree(revision_id)
 
2651
            # only set an explicit root id if there is one to set.
 
2652
            if basis_tree.inventory.root is not None:
 
2653
                wt.set_root_id(basis_tree.inventory.root.file_id)
 
2654
            if revision_id == NULL_REVISION:
 
2655
                wt.set_parent_trees([])
 
2656
            else:
 
2657
                wt.set_parent_trees([(revision_id, basis_tree)])
 
2658
            transform.build_tree(basis_tree, wt)
 
2659
        finally:
 
2660
            # Unlock in this order so that the unlock-triggers-flush in
 
2661
            # WorkingTree is given a chance to fire.
 
2662
            control_files.unlock()
 
2663
            wt.unlock()
1597
2664
        return wt
1598
2665
 
 
2666
    def _initial_inventory(self):
 
2667
        return Inventory()
 
2668
 
1599
2669
    def __init__(self):
1600
2670
        super(WorkingTreeFormat3, self).__init__()
1601
 
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1602
2671
 
1603
2672
    def open(self, a_bzrdir, _found=False):
1604
2673
        """Return the WorkingTree object for a_bzrdir
1611
2680
            raise NotImplementedError
1612
2681
        if not isinstance(a_bzrdir.transport, LocalTransport):
1613
2682
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
1614
 
        control_files = self._open_control_files(a_bzrdir)
1615
 
        return WorkingTree3(a_bzrdir.root_transport.base,
1616
 
                           _internal=True,
1617
 
                           _format=self,
1618
 
                           _bzrdir=a_bzrdir,
1619
 
                           _control_files=control_files)
 
2683
        return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
 
2684
 
 
2685
    def _open(self, a_bzrdir, control_files):
 
2686
        """Open the tree itself.
 
2687
        
 
2688
        :param a_bzrdir: the dir for the tree.
 
2689
        :param control_files: the control files for the tree.
 
2690
        """
 
2691
        return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
 
2692
                                _internal=True,
 
2693
                                _format=self,
 
2694
                                _bzrdir=a_bzrdir,
 
2695
                                _control_files=control_files)
1620
2696
 
1621
2697
    def __str__(self):
1622
2698
        return self.get_format_string()
1623
2699
 
1624
2700
 
 
2701
__default_format = WorkingTreeFormat4()
 
2702
WorkingTreeFormat.register_format(__default_format)
 
2703
WorkingTreeFormat.register_format(WorkingTreeFormat3())
 
2704
WorkingTreeFormat.set_default_format(__default_format)
1625
2705
# formats which have no format string are not discoverable
1626
2706
# and not independently creatable, so are not registered.
1627
 
__default_format = WorkingTreeFormat3()
1628
 
WorkingTreeFormat.register_format(__default_format)
1629
 
WorkingTreeFormat.set_default_format(__default_format)
1630
2707
_legacy_formats = [WorkingTreeFormat2(),
1631
2708
                   ]
1632
2709
 
1645
2722
        self._transport_readonly_server = transport_readonly_server
1646
2723
        self._formats = formats
1647
2724
    
 
2725
    def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
 
2726
        """Clone test for adaption."""
 
2727
        new_test = deepcopy(test)
 
2728
        new_test.transport_server = self._transport_server
 
2729
        new_test.transport_readonly_server = self._transport_readonly_server
 
2730
        new_test.bzrdir_format = bzrdir_format
 
2731
        new_test.workingtree_format = workingtree_format
 
2732
        def make_new_test_id():
 
2733
            new_id = "%s(%s)" % (test.id(), variation)
 
2734
            return lambda: new_id
 
2735
        new_test.id = make_new_test_id()
 
2736
        return new_test
 
2737
    
1648
2738
    def adapt(self, test):
1649
2739
        from bzrlib.tests import TestSuite
1650
2740
        result = TestSuite()
1651
2741
        for workingtree_format, bzrdir_format in self._formats:
1652
 
            new_test = deepcopy(test)
1653
 
            new_test.transport_server = self._transport_server
1654
 
            new_test.transport_readonly_server = self._transport_readonly_server
1655
 
            new_test.bzrdir_format = bzrdir_format
1656
 
            new_test.workingtree_format = workingtree_format
1657
 
            def make_new_test_id():
1658
 
                new_id = "%s(%s)" % (new_test.id(), workingtree_format.__class__.__name__)
1659
 
                return lambda: new_id
1660
 
            new_test.id = make_new_test_id()
 
2742
            new_test = self._clone_test(
 
2743
                test,
 
2744
                bzrdir_format,
 
2745
                workingtree_format, workingtree_format.__class__.__name__)
1661
2746
            result.addTest(new_test)
1662
2747
        return result