~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-09-27 19:48:46 UTC
  • mfrom: (2045.1.3 jam-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20060927194846-b26e0ca2dd3f8519
Lukáš Lalinský: TransportNotPossible has a bad docstring

Show diffs side-by-side

added added

removed removed

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