← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

Merge bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/workingtree.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""WorkingTree object and friends.
18
18
 
19
19
A WorkingTree represents the editable working copy of a branch.
20
 
Operations which represent the WorkingTree are also done here,
21
 
such as renaming or adding files.  The WorkingTree has an inventory
22
 
which is updated by these operations.  A commit produces a
 
20
Operations which represent the WorkingTree are also done here, 
 
21
such as renaming or adding files.  The WorkingTree has an inventory 
 
22
which is updated by these operations.  A commit produces a 
23
23
new revision based on the workingtree and its inventory.
24
24
 
25
25
At the moment every WorkingTree has its own branch.  Remote
29
29
WorkingTree.open(dir).
30
30
"""
31
31
 
 
32
# TODO: Give the workingtree sole responsibility for the working inventory;
 
33
# remove the variable and references to it from the branch.  This may require
 
34
# updating the commit code so as to update the inventory within the working
 
35
# copy, and making sure there's only one WorkingTree for any directory on disk.
 
36
# At the moment they may alias the inventory and have old copies of it in
 
37
# memory.  (Now done? -- mbp 20060309)
32
38
 
33
39
from cStringIO import StringIO
34
40
import os
35
 
import sys
36
41
 
37
42
from bzrlib.lazy_import import lazy_import
38
43
lazy_import(globals(), """
39
44
from bisect import bisect_left
40
45
import collections
 
46
from copy import deepcopy
41
47
import errno
42
48
import itertools
43
49
import operator
44
50
import stat
 
51
from time import time
 
52
import warnings
45
53
import re
46
54
 
47
55
import bzrlib
49
57
    branch,
50
58
    bzrdir,
51
59
    conflicts as _mod_conflicts,
 
60
    dirstate,
52
61
    errors,
53
62
    generate_ids,
54
63
    globbing,
55
 
    graph as _mod_graph,
56
64
    hashcache,
57
65
    ignores,
58
 
    inventory,
59
66
    merge,
60
 
    revision as _mod_revision,
 
67
    osutils,
61
68
    revisiontree,
62
 
    trace,
 
69
    repository,
 
70
    textui,
63
71
    transform,
64
 
    ui,
65
 
    views,
 
72
    urlutils,
66
73
    xml5,
 
74
    xml6,
67
75
    xml7,
68
76
    )
69
77
import bzrlib.branch
70
78
from bzrlib.transport import get_transport
71
 
from bzrlib.workingtree_4 import (
72
 
    WorkingTreeFormat4,
73
 
    WorkingTreeFormat5,
74
 
    WorkingTreeFormat6,
75
 
    )
 
79
import bzrlib.ui
 
80
from bzrlib.workingtree_4 import WorkingTreeFormat4
76
81
""")
77
82
 
78
83
from bzrlib import symbol_versioning
79
84
from bzrlib.decorators import needs_read_lock, needs_write_lock
80
 
from bzrlib.lockable_files import LockableFiles
 
85
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
 
86
from bzrlib.lockable_files import LockableFiles, TransportLock
81
87
from bzrlib.lockdir import LockDir
82
88
import bzrlib.mutabletree
83
89
from bzrlib.mutabletree import needs_tree_write_lock
84
 
from bzrlib import osutils
85
90
from bzrlib.osutils import (
 
91
    compact_date,
86
92
    file_kind,
87
93
    isdir,
88
94
    normpath,
89
95
    pathjoin,
 
96
    rand_chars,
90
97
    realpath,
91
98
    safe_unicode,
92
99
    splitpath,
93
100
    supports_executable,
94
101
    )
95
 
from bzrlib.filters import filtered_input_file
96
102
from bzrlib.trace import mutter, note
97
103
from bzrlib.transport.local import LocalTransport
98
 
from bzrlib.revision import CURRENT_REVISION
 
104
from bzrlib.progress import DummyProgress, ProgressPhase
 
105
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
99
106
from bzrlib.rio import RioReader, rio_file, Stanza
100
 
from bzrlib.symbol_versioning import (
101
 
    deprecated_passed,
102
 
    DEPRECATED_PARAMETER,
103
 
    )
 
107
from bzrlib.symbol_versioning import (deprecated_passed,
 
108
        deprecated_method,
 
109
        deprecated_function,
 
110
        DEPRECATED_PARAMETER,
 
111
        zero_eight,
 
112
        zero_eleven,
 
113
        zero_thirteen,
 
114
        )
104
115
 
105
116
 
106
117
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
107
 
# TODO: Modifying the conflict objects or their type is currently nearly
108
 
# impossible as there is no clear relationship between the working tree format
109
 
# and the conflict list file format.
110
118
CONFLICT_HEADER_1 = "BZR conflict list format 1"
111
119
 
112
 
ERROR_PATH_NOT_FOUND = 3    # WindowsError errno code, equivalent to ENOENT
 
120
 
 
121
@deprecated_function(zero_thirteen)
 
122
def gen_file_id(name):
 
123
    """Return new file id for the basename 'name'.
 
124
 
 
125
    Use bzrlib.generate_ids.gen_file_id() instead
 
126
    """
 
127
    return generate_ids.gen_file_id(name)
 
128
 
 
129
 
 
130
@deprecated_function(zero_thirteen)
 
131
def gen_root_id():
 
132
    """Return a new tree-root file id.
 
133
 
 
134
    This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
 
135
    """
 
136
    return generate_ids.gen_root_id()
113
137
 
114
138
 
115
139
class TreeEntry(object):
116
140
    """An entry that implements the minimum interface used by commands.
117
141
 
118
 
    This needs further inspection, it may be better to have
 
142
    This needs further inspection, it may be better to have 
119
143
    InventoryEntries without ids - though that seems wrong. For now,
120
144
    this is a parallel hierarchy to InventoryEntry, and needs to become
121
145
    one of several things: decorates to that hierarchy, children of, or
124
148
    no InventoryEntry available - i.e. for unversioned objects.
125
149
    Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
126
150
    """
127
 
 
 
151
 
128
152
    def __eq__(self, other):
129
153
        # yes, this us ugly, TODO: best practice __eq__ style.
130
154
        return (isinstance(other, TreeEntry)
131
155
                and other.__class__ == self.__class__)
132
 
 
 
156
 
133
157
    def kind_character(self):
134
158
        return "???"
135
159
 
167
191
        return ''
168
192
 
169
193
 
170
 
class WorkingTree(bzrlib.mutabletree.MutableTree,
171
 
    bzrdir.ControlComponent):
 
194
class WorkingTree(bzrlib.mutabletree.MutableTree):
172
195
    """Working copy tree.
173
196
 
174
197
    The inventory is held in the `Branch` working-inventory, and the
178
201
    not listed in the Inventory and vice versa.
179
202
    """
180
203
 
181
 
    # override this to set the strategy for storing views
182
 
    def _make_views(self):
183
 
        return views.DisabledViews(self)
184
 
 
185
204
    def __init__(self, basedir='.',
186
205
                 branch=DEPRECATED_PARAMETER,
187
206
                 _inventory=None,
198
217
        if not _internal:
199
218
            raise errors.BzrError("Please use bzrdir.open_workingtree or "
200
219
                "WorkingTree.open() to obtain a WorkingTree.")
 
220
        assert isinstance(basedir, basestring), \
 
221
            "base directory %r is not a string" % basedir
201
222
        basedir = safe_unicode(basedir)
202
223
        mutter("opening working tree %r", basedir)
203
224
        if deprecated_passed(branch):
211
232
            self._control_files = self.branch.control_files
212
233
        else:
213
234
            # assume all other formats have their own control files.
 
235
            assert isinstance(_control_files, LockableFiles), \
 
236
                    "_control_files must be a LockableFiles, not %r" \
 
237
                    % _control_files
214
238
            self._control_files = _control_files
215
 
        self._transport = self._control_files._transport
216
239
        # update the whole cache up front and write to disk if anything changed;
217
240
        # in the future we might want to do this more selectively
218
241
        # two possible ways offer themselves : in self._unlock, write the cache
222
245
        wt_trans = self.bzrdir.get_workingtree_transport(None)
223
246
        cache_filename = wt_trans.local_abspath('stat-cache')
224
247
        self._hashcache = hashcache.HashCache(basedir, cache_filename,
225
 
            self.bzrdir._get_file_mode(),
226
 
            self._content_filter_stack_provider())
 
248
                                              self._control_files._file_mode)
227
249
        hc = self._hashcache
228
250
        hc.read()
229
251
        # is this scan needed ? it makes things kinda slow.
243
265
            # the Format factory and creation methods that are
244
266
            # permitted to do this.
245
267
            self._set_inventory(_inventory, dirty=False)
246
 
        self._detect_case_handling()
247
 
        self._rules_searcher = None
248
 
        self.views = self._make_views()
249
 
 
250
 
    @property
251
 
    def user_transport(self):
252
 
        return self.bzrdir.user_transport
253
 
 
254
 
    @property
255
 
    def control_transport(self):
256
 
        return self._transport
257
 
 
258
 
    def _detect_case_handling(self):
259
 
        wt_trans = self.bzrdir.get_workingtree_transport(None)
260
 
        try:
261
 
            wt_trans.stat("FoRMaT")
262
 
        except errors.NoSuchFile:
263
 
            self.case_sensitive = True
264
 
        else:
265
 
            self.case_sensitive = False
266
 
 
267
 
        self._setup_directory_is_tree_reference()
268
268
 
269
269
    branch = property(
270
270
        fget=lambda self: self._branch,
285
285
        self._control_files.break_lock()
286
286
        self.branch.break_lock()
287
287
 
288
 
    def _get_check_refs(self):
289
 
        """Return the references needed to perform a check of this tree.
290
 
        
291
 
        The default implementation returns no refs, and is only suitable for
292
 
        trees that have no local caching and can commit on ghosts at any time.
293
 
 
294
 
        :seealso: bzrlib.check for details about check_refs.
295
 
        """
296
 
        return []
297
 
 
298
288
    def requires_rich_root(self):
299
289
        return self._format.requires_rich_root
300
290
 
301
291
    def supports_tree_reference(self):
302
292
        return False
303
293
 
304
 
    def supports_content_filtering(self):
305
 
        return self._format.supports_content_filtering()
306
 
 
307
 
    def supports_views(self):
308
 
        return self.views.supports_views()
309
 
 
310
294
    def _set_inventory(self, inv, dirty):
311
295
        """Set the internal cached inventory.
312
296
 
317
301
            False then the inventory is the same as that on disk and any
318
302
            serialisation would be unneeded overhead.
319
303
        """
 
304
        assert inv.root is not None
320
305
        self._inventory = inv
321
306
        self._inventory_is_modified = dirty
322
307
 
326
311
 
327
312
        """
328
313
        if path is None:
329
 
            path = osutils.getcwd()
 
314
            path = os.path.getcwdu()
330
315
        control = bzrdir.BzrDir.open(path, _unsupported)
331
316
        return control.open_workingtree(_unsupported)
332
 
 
 
317
        
333
318
    @staticmethod
334
319
    def open_containing(path=None):
335
320
        """Open an existing working tree which has its root about path.
336
 
 
 
321
        
337
322
        This probes for a working tree at path and searches upwards from there.
338
323
 
339
324
        Basically we keep looking up until we find the control directory or
357
342
        """
358
343
        return WorkingTree.open(path, _unsupported=True)
359
344
 
360
 
    @staticmethod
361
 
    def find_trees(location):
362
 
        def list_current(transport):
363
 
            return [d for d in transport.list_dir('') if d != '.bzr']
364
 
        def evaluate(bzrdir):
365
 
            try:
366
 
                tree = bzrdir.open_workingtree()
367
 
            except errors.NoWorkingTree:
368
 
                return True, None
369
 
            else:
370
 
                return True, tree
371
 
        transport = get_transport(location)
372
 
        iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
373
 
                                              list_current=list_current)
374
 
        return [t for t in iterator if t is not None]
375
 
 
376
345
    # should be deprecated - this is slow and in any case treating them as a
377
346
    # container is (we now know) bad style -- mbp 20070302
378
347
    ## @deprecated_method(zero_fifteen)
387
356
            if osutils.lexists(self.abspath(path)):
388
357
                yield ie.file_id
389
358
 
390
 
    def all_file_ids(self):
391
 
        """See Tree.iter_all_file_ids"""
392
 
        return set(self.inventory)
393
 
 
394
359
    def __repr__(self):
395
360
        return "<%s of %s>" % (self.__class__.__name__,
396
361
                               getattr(self, 'basedir', None))
397
362
 
398
363
    def abspath(self, filename):
399
364
        return pathjoin(self.basedir, filename)
400
 
 
 
365
    
401
366
    def basis_tree(self):
402
367
        """Return RevisionTree for the current last revision.
403
 
 
 
368
        
404
369
        If the left most parent is a ghost then the returned tree will be an
405
 
        empty tree - one obtained by calling
406
 
        repository.revision_tree(NULL_REVISION).
 
370
        empty tree - one obtained by calling repository.revision_tree(None).
407
371
        """
408
372
        try:
409
373
            revision_id = self.get_parent_ids()[0]
411
375
            # no parents, return an empty revision tree.
412
376
            # in the future this should return the tree for
413
377
            # 'empty:' - the implicit root empty tree.
414
 
            return self.branch.repository.revision_tree(
415
 
                       _mod_revision.NULL_REVISION)
 
378
            return self.branch.repository.revision_tree(None)
416
379
        try:
417
380
            return self.revision_tree(revision_id)
418
381
        except errors.NoSuchRevision:
422
385
        # at this point ?
423
386
        try:
424
387
            return self.branch.repository.revision_tree(revision_id)
425
 
        except (errors.RevisionNotPresent, errors.NoSuchRevision):
 
388
        except errors.RevisionNotPresent:
426
389
            # the basis tree *may* be a ghost or a low level error may have
427
 
            # occurred. If the revision is present, its a problem, if its not
 
390
            # occured. If the revision is present, its a problem, if its not
428
391
            # its a ghost.
429
392
            if self.branch.repository.has_revision(revision_id):
430
393
                raise
431
394
            # the basis tree is a ghost so return an empty tree.
432
 
            return self.branch.repository.revision_tree(
433
 
                       _mod_revision.NULL_REVISION)
434
 
 
435
 
    def _cleanup(self):
436
 
        self._flush_ignore_list_cache()
 
395
            return self.branch.repository.revision_tree(None)
 
396
 
 
397
    @staticmethod
 
398
    @deprecated_method(zero_eight)
 
399
    def create(branch, directory):
 
400
        """Create a workingtree for branch at directory.
 
401
 
 
402
        If existing_directory already exists it must have a .bzr directory.
 
403
        If it does not exist, it will be created.
 
404
 
 
405
        This returns a new WorkingTree object for the new checkout.
 
406
 
 
407
        TODO FIXME RBC 20060124 when we have checkout formats in place this
 
408
        should accept an optional revisionid to checkout [and reject this if
 
409
        checking out into the same dir as a pre-checkout-aware branch format.]
 
410
 
 
411
        XXX: When BzrDir is present, these should be created through that 
 
412
        interface instead.
 
413
        """
 
414
        warnings.warn('delete WorkingTree.create', stacklevel=3)
 
415
        transport = get_transport(directory)
 
416
        if branch.bzrdir.root_transport.base == transport.base:
 
417
            # same dir 
 
418
            return branch.bzrdir.create_workingtree()
 
419
        # different directory, 
 
420
        # create a branch reference
 
421
        # and now a working tree.
 
422
        raise NotImplementedError
 
423
 
 
424
    @staticmethod
 
425
    @deprecated_method(zero_eight)
 
426
    def create_standalone(directory):
 
427
        """Create a checkout and a branch and a repo at directory.
 
428
 
 
429
        Directory must exist and be empty.
 
430
 
 
431
        please use BzrDir.create_standalone_workingtree
 
432
        """
 
433
        return bzrdir.BzrDir.create_standalone_workingtree(directory)
437
434
 
438
435
    def relpath(self, path):
439
436
        """Return the local path portion from a given path.
440
 
 
441
 
        The path may be absolute or relative. If its a relative path it is
 
437
        
 
438
        The path may be absolute or relative. If its a relative path it is 
442
439
        interpreted relative to the python current working directory.
443
440
        """
444
441
        return osutils.relpath(self.basedir, path)
446
443
    def has_filename(self, filename):
447
444
        return osutils.lexists(self.abspath(filename))
448
445
 
449
 
    def get_file(self, file_id, path=None, filtered=True):
450
 
        return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
451
 
 
452
 
    def get_file_with_stat(self, file_id, path=None, filtered=True,
453
 
        _fstat=os.fstat):
454
 
        """See Tree.get_file_with_stat."""
455
 
        if path is None:
456
 
            path = self.id2path(file_id)
457
 
        file_obj = self.get_file_byname(path, filtered=False)
458
 
        stat_value = _fstat(file_obj.fileno())
459
 
        if filtered and self.supports_content_filtering():
460
 
            filters = self._content_filter_stack(path)
461
 
            file_obj = filtered_input_file(file_obj, filters)
462
 
        return (file_obj, stat_value)
463
 
 
464
 
    def get_file_text(self, file_id, path=None, filtered=True):
465
 
        return self.get_file(file_id, path=path, filtered=filtered).read()
466
 
 
467
 
    def get_file_byname(self, filename, filtered=True):
468
 
        path = self.abspath(filename)
469
 
        f = file(path, 'rb')
470
 
        if filtered and self.supports_content_filtering():
471
 
            filters = self._content_filter_stack(filename)
472
 
            return filtered_input_file(f, filters)
473
 
        else:
474
 
            return f
475
 
 
476
 
    def get_file_lines(self, file_id, path=None, filtered=True):
477
 
        """See Tree.get_file_lines()"""
478
 
        file = self.get_file(file_id, path, filtered=filtered)
479
 
        try:
480
 
            return file.readlines()
481
 
        finally:
482
 
            file.close()
 
446
    def get_file(self, file_id):
 
447
        file_id = osutils.safe_file_id(file_id)
 
448
        return self.get_file_byname(self.id2path(file_id))
 
449
 
 
450
    def get_file_text(self, file_id):
 
451
        file_id = osutils.safe_file_id(file_id)
 
452
        return self.get_file(file_id).read()
 
453
 
 
454
    def get_file_byname(self, filename):
 
455
        return file(self.abspath(filename), 'rb')
483
456
 
484
457
    @needs_read_lock
485
 
    def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
 
458
    def annotate_iter(self, file_id):
486
459
        """See Tree.annotate_iter
487
460
 
488
461
        This implementation will use the basis tree implementation if possible.
492
465
        incorrectly attributed to CURRENT_REVISION (but after committing, the
493
466
        attribution will be correct).
494
467
        """
495
 
        maybe_file_parent_keys = []
496
 
        for parent_id in self.get_parent_ids():
497
 
            try:
498
 
                parent_tree = self.revision_tree(parent_id)
499
 
            except errors.NoSuchRevisionInTree:
500
 
                parent_tree = self.branch.repository.revision_tree(parent_id)
501
 
            parent_tree.lock_read()
502
 
            try:
503
 
                if file_id not in parent_tree:
504
 
                    continue
505
 
                ie = parent_tree.inventory[file_id]
506
 
                if ie.kind != 'file':
507
 
                    # Note: this is slightly unnecessary, because symlinks and
508
 
                    # directories have a "text" which is the empty text, and we
509
 
                    # know that won't mess up annotations. But it seems cleaner
510
 
                    continue
511
 
                parent_text_key = (file_id, ie.revision)
512
 
                if parent_text_key not in maybe_file_parent_keys:
513
 
                    maybe_file_parent_keys.append(parent_text_key)
514
 
            finally:
515
 
                parent_tree.unlock()
516
 
        graph = _mod_graph.Graph(self.branch.repository.texts)
517
 
        heads = graph.heads(maybe_file_parent_keys)
518
 
        file_parent_keys = []
519
 
        for key in maybe_file_parent_keys:
520
 
            if key in heads:
521
 
                file_parent_keys.append(key)
522
 
 
523
 
        # Now we have the parents of this content
524
 
        annotator = self.branch.repository.texts.get_annotator()
525
 
        text = self.get_file(file_id).read()
526
 
        this_key =(file_id, default_revision)
527
 
        annotator.add_special_text(this_key, file_parent_keys, text)
528
 
        annotations = [(key[-1], line)
529
 
                       for key, line in annotator.annotate_flat(this_key)]
530
 
        return annotations
531
 
 
532
 
    def _get_ancestors(self, default_revision):
533
 
        ancestors = set([default_revision])
534
 
        for parent_id in self.get_parent_ids():
535
 
            ancestors.update(self.branch.repository.get_ancestry(
536
 
                             parent_id, topo_sorted=False))
537
 
        return ancestors
 
468
        file_id = osutils.safe_file_id(file_id)
 
469
        basis = self.basis_tree()
 
470
        basis.lock_read()
 
471
        try:
 
472
            changes = self._iter_changes(basis, True, [self.id2path(file_id)],
 
473
                require_versioned=True).next()
 
474
            changed_content, kind = changes[2], changes[6]
 
475
            if not changed_content:
 
476
                return basis.annotate_iter(file_id)
 
477
            if kind[1] is None:
 
478
                return None
 
479
            import annotate
 
480
            if kind[0] != 'file':
 
481
                old_lines = []
 
482
            else:
 
483
                old_lines = list(basis.annotate_iter(file_id))
 
484
            old = [old_lines]
 
485
            for tree in self.branch.repository.revision_trees(
 
486
                self.get_parent_ids()[1:]):
 
487
                if file_id not in tree:
 
488
                    continue
 
489
                old.append(list(tree.annotate_iter(file_id)))
 
490
            return annotate.reannotate(old, self.get_file(file_id).readlines(),
 
491
                                       CURRENT_REVISION)
 
492
        finally:
 
493
            basis.unlock()
538
494
 
539
495
    def get_parent_ids(self):
540
496
        """See Tree.get_parent_ids.
541
 
 
 
497
        
542
498
        This implementation reads the pending merges list and last_revision
543
499
        value and uses that to decide what the parents list should be.
544
500
        """
545
 
        last_rev = _mod_revision.ensure_null(self._last_revision())
546
 
        if _mod_revision.NULL_REVISION == last_rev:
 
501
        last_rev = self._last_revision()
 
502
        if last_rev is None:
547
503
            parents = []
548
504
        else:
549
505
            parents = [last_rev]
550
506
        try:
551
 
            merges_bytes = self._transport.get_bytes('pending-merges')
 
507
            merges_file = self._control_files.get('pending-merges')
552
508
        except errors.NoSuchFile:
553
509
            pass
554
510
        else:
555
 
            for l in osutils.split_lines(merges_bytes):
556
 
                revision_id = l.rstrip('\n')
 
511
            for l in merges_file.readlines():
 
512
                revision_id = osutils.safe_revision_id(l.rstrip('\n'))
557
513
                parents.append(revision_id)
558
514
        return parents
559
515
 
561
517
    def get_root_id(self):
562
518
        """Return the id of this trees root"""
563
519
        return self._inventory.root.file_id
564
 
 
 
520
        
565
521
    def _get_store_filename(self, file_id):
566
522
        ## XXX: badly named; this is not in the store at all
 
523
        file_id = osutils.safe_file_id(file_id)
567
524
        return self.abspath(self.id2path(file_id))
568
525
 
569
526
    @needs_read_lock
570
 
    def clone(self, to_bzrdir, revision_id=None):
 
527
    def clone(self, to_bzrdir, revision_id=None, basis=None):
571
528
        """Duplicate this working tree into to_bzr, including all state.
572
 
 
 
529
        
573
530
        Specifically modified files are kept as modified, but
574
531
        ignored and unknown files are discarded.
575
532
 
576
533
        If you want to make a new line of development, see bzrdir.sprout()
577
534
 
578
535
        revision
579
 
            If not None, the cloned tree will have its last revision set to
580
 
            revision, and difference between the source trees last revision
 
536
            If not None, the cloned tree will have its last revision set to 
 
537
            revision, and and difference between the source trees last revision
581
538
            and this one merged in.
 
539
 
 
540
        basis
 
541
            If not None, a closer copy of a tree which may have some files in
 
542
            common, and which file content should be preferentially copied from.
582
543
        """
583
544
        # assumes the target bzr dir format is compatible.
584
 
        result = to_bzrdir.create_workingtree()
 
545
        result = self._format.initialize(to_bzrdir)
585
546
        self.copy_content_into(result, revision_id)
586
547
        return result
587
548
 
598
559
            tree.set_parent_ids([revision_id])
599
560
 
600
561
    def id2abspath(self, file_id):
 
562
        file_id = osutils.safe_file_id(file_id)
601
563
        return self.abspath(self.id2path(file_id))
602
564
 
603
565
    def has_id(self, file_id):
604
566
        # files that have been deleted are excluded
 
567
        file_id = osutils.safe_file_id(file_id)
605
568
        inv = self.inventory
606
569
        if not inv.has_id(file_id):
607
570
            return False
609
572
        return osutils.lexists(self.abspath(path))
610
573
 
611
574
    def has_or_had_id(self, file_id):
 
575
        file_id = osutils.safe_file_id(file_id)
612
576
        if file_id == self.inventory.root.file_id:
613
577
            return True
614
578
        return self.inventory.has_id(file_id)
616
580
    __contains__ = has_id
617
581
 
618
582
    def get_file_size(self, file_id):
619
 
        """See Tree.get_file_size"""
620
 
        # XXX: this returns the on-disk size; it should probably return the
621
 
        # canonical size
622
 
        try:
623
 
            return os.path.getsize(self.id2abspath(file_id))
624
 
        except OSError, e:
625
 
            if e.errno != errno.ENOENT:
626
 
                raise
627
 
            else:
628
 
                return None
 
583
        file_id = osutils.safe_file_id(file_id)
 
584
        return os.path.getsize(self.id2abspath(file_id))
629
585
 
630
586
    @needs_read_lock
631
587
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
588
        file_id = osutils.safe_file_id(file_id)
632
589
        if not path:
633
590
            path = self._inventory.id2path(file_id)
634
591
        return self._hashcache.get_sha1(path, stat_value)
635
592
 
636
593
    def get_file_mtime(self, file_id, path=None):
 
594
        file_id = osutils.safe_file_id(file_id)
637
595
        if not path:
638
596
            path = self.inventory.id2path(file_id)
639
597
        return os.lstat(self.abspath(path)).st_mtime
640
598
 
641
 
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
642
 
        file_id = self.path2id(path)
643
 
        if file_id is None:
644
 
            # For unversioned files on win32, we just assume they are not
645
 
            # executable
646
 
            return False
647
 
        return self._inventory[file_id].executable
648
 
 
649
 
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
650
 
        mode = stat_result.st_mode
651
 
        return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
652
 
 
653
599
    if not supports_executable():
654
600
        def is_executable(self, file_id, path=None):
 
601
            file_id = osutils.safe_file_id(file_id)
655
602
            return self._inventory[file_id].executable
656
 
 
657
 
        _is_executable_from_path_and_stat = \
658
 
            _is_executable_from_path_and_stat_from_basis
659
603
    else:
660
604
        def is_executable(self, file_id, path=None):
661
605
            if not path:
 
606
                file_id = osutils.safe_file_id(file_id)
662
607
                path = self.id2path(file_id)
663
608
            mode = os.lstat(self.abspath(path)).st_mode
664
609
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
665
610
 
666
 
        _is_executable_from_path_and_stat = \
667
 
            _is_executable_from_path_and_stat_from_stat
668
 
 
669
611
    @needs_tree_write_lock
670
612
    def _add(self, files, ids, kinds):
671
613
        """See MutableTree._add."""
672
614
        # TODO: Re-adding a file that is removed in the working copy
673
615
        # should probably put it back with the previous ID.
674
 
        # the read and write working inventory should not occur in this
 
616
        # the read and write working inventory should not occur in this 
675
617
        # function - they should be part of lock_write and unlock.
676
 
        inv = self.inventory
 
618
        inv = self.read_working_inventory()
677
619
        for f, file_id, kind in zip(files, ids, kinds):
 
620
            assert kind is not None
678
621
            if file_id is None:
679
622
                inv.add_path(f, kind=kind)
680
623
            else:
 
624
                file_id = osutils.safe_file_id(file_id)
681
625
                inv.add_path(f, kind=kind, file_id=file_id)
682
 
            self._inventory_is_modified = True
 
626
        self._write_inventory(inv)
683
627
 
684
628
    @needs_tree_write_lock
685
629
    def _gather_kinds(self, files, kinds):
745
689
        if updated:
746
690
            self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
747
691
 
748
 
    def path_content_summary(self, path, _lstat=os.lstat,
749
 
        _mapper=osutils.file_kind_from_stat_mode):
750
 
        """See Tree.path_content_summary."""
751
 
        abspath = self.abspath(path)
752
 
        try:
753
 
            stat_result = _lstat(abspath)
754
 
        except OSError, e:
755
 
            if getattr(e, 'errno', None) == errno.ENOENT:
756
 
                # no file.
757
 
                return ('missing', None, None, None)
758
 
            # propagate other errors
759
 
            raise
760
 
        kind = _mapper(stat_result.st_mode)
761
 
        if kind == 'file':
762
 
            return self._file_content_summary(path, stat_result)
763
 
        elif kind == 'directory':
764
 
            # perhaps it looks like a plain directory, but it's really a
765
 
            # reference.
766
 
            if self._directory_is_tree_reference(path):
767
 
                kind = 'tree-reference'
768
 
            return kind, None, None, None
769
 
        elif kind == 'symlink':
770
 
            target = osutils.readlink(abspath)
771
 
            return ('symlink', None, None, target)
772
 
        else:
773
 
            return (kind, None, None, None)
774
 
 
775
 
    def _file_content_summary(self, path, stat_result):
776
 
        size = stat_result.st_size
777
 
        executable = self._is_executable_from_path_and_stat(path, stat_result)
778
 
        # try for a stat cache lookup
779
 
        return ('file', size, executable, self._sha_from_stat(
780
 
            path, stat_result))
 
692
    @deprecated_method(zero_eleven)
 
693
    @needs_read_lock
 
694
    def pending_merges(self):
 
695
        """Return a list of pending merges.
 
696
 
 
697
        These are revisions that have been merged into the working
 
698
        directory but not yet committed.
 
699
 
 
700
        As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
 
701
        instead - which is available on all tree objects.
 
702
        """
 
703
        return self.get_parent_ids()[1:]
781
704
 
782
705
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
783
706
        """Common ghost checking functionality from set_parent_*.
793
716
 
794
717
    def _set_merges_from_parent_ids(self, parent_ids):
795
718
        merges = parent_ids[1:]
796
 
        self._transport.put_bytes('pending-merges', '\n'.join(merges),
797
 
            mode=self.bzrdir._get_file_mode())
798
 
 
799
 
    def _filter_parent_ids_by_ancestry(self, revision_ids):
800
 
        """Check that all merged revisions are proper 'heads'.
801
 
 
802
 
        This will always return the first revision_id, and any merged revisions
803
 
        which are
804
 
        """
805
 
        if len(revision_ids) == 0:
806
 
            return revision_ids
807
 
        graph = self.branch.repository.get_graph()
808
 
        heads = graph.heads(revision_ids)
809
 
        new_revision_ids = revision_ids[:1]
810
 
        for revision_id in revision_ids[1:]:
811
 
            if revision_id in heads and revision_id not in new_revision_ids:
812
 
                new_revision_ids.append(revision_id)
813
 
        if new_revision_ids != revision_ids:
814
 
            trace.mutter('requested to set revision_ids = %s,'
815
 
                         ' but filtered to %s', revision_ids, new_revision_ids)
816
 
        return new_revision_ids
 
719
        self._control_files.put_bytes('pending-merges', '\n'.join(merges))
817
720
 
818
721
    @needs_tree_write_lock
819
722
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
820
723
        """Set the parent ids to revision_ids.
821
 
 
 
724
        
822
725
        See also set_parent_trees. This api will try to retrieve the tree data
823
726
        for each element of revision_ids from the trees repository. If you have
824
727
        tree data already available, it is more efficient to use
828
731
        :param revision_ids: The revision_ids to set as the parent ids of this
829
732
            working tree. Any of these may be ghosts.
830
733
        """
 
734
        revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
831
735
        self._check_parents_for_ghosts(revision_ids,
832
736
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
833
 
        for revision_id in revision_ids:
834
 
            _mod_revision.check_not_reserved_id(revision_id)
835
 
 
836
 
        revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
837
737
 
838
738
        if len(revision_ids) > 0:
839
739
            self.set_last_revision(revision_ids[0])
840
740
        else:
841
 
            self.set_last_revision(_mod_revision.NULL_REVISION)
 
741
            self.set_last_revision(None)
842
742
 
843
743
        self._set_merges_from_parent_ids(revision_ids)
844
744
 
845
745
    @needs_tree_write_lock
846
746
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
847
747
        """See MutableTree.set_parent_trees."""
848
 
        parent_ids = [rev for (rev, tree) in parents_list]
849
 
        for revision_id in parent_ids:
850
 
            _mod_revision.check_not_reserved_id(revision_id)
 
748
        parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
851
749
 
852
750
        self._check_parents_for_ghosts(parent_ids,
853
751
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
854
752
 
855
 
        parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
856
 
 
857
753
        if len(parent_ids) == 0:
858
 
            leftmost_parent_id = _mod_revision.NULL_REVISION
 
754
            leftmost_parent_id = None
859
755
            leftmost_parent_tree = None
860
756
        else:
861
757
            leftmost_parent_id, leftmost_parent_tree = parents_list[0]
886
782
                yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
887
783
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
888
784
 
889
 
    def _sha_from_stat(self, path, stat_result):
890
 
        """Get a sha digest from the tree's stat cache.
891
 
 
892
 
        The default implementation assumes no stat cache is present.
893
 
 
894
 
        :param path: The path.
895
 
        :param stat_result: The stat result being looked up.
896
 
        """
897
 
        return None
898
 
 
899
785
    def _put_rio(self, filename, stanzas, header):
900
786
        self._must_be_locked()
901
787
        my_file = rio_file(stanzas, header)
902
 
        self._transport.put_file(filename, my_file,
903
 
            mode=self.bzrdir._get_file_mode())
 
788
        self._control_files.put(filename, my_file)
904
789
 
905
790
    @needs_write_lock # because merge pulls data into the branch.
906
 
    def merge_from_branch(self, branch, to_revision=None, from_revision=None,
907
 
                          merge_type=None, force=False):
 
791
    def merge_from_branch(self, branch, to_revision=None):
908
792
        """Merge from a branch into this working tree.
909
793
 
910
794
        :param branch: The branch to merge from.
914
798
            branch.last_revision().
915
799
        """
916
800
        from bzrlib.merge import Merger, Merge3Merger
917
 
        merger = Merger(self.branch, this_tree=self)
918
 
        # check that there are no local alterations
919
 
        if not force and self.has_changes():
920
 
            raise errors.UncommittedChanges(self)
921
 
        if to_revision is None:
922
 
            to_revision = _mod_revision.ensure_null(branch.last_revision())
923
 
        merger.other_rev_id = to_revision
924
 
        if _mod_revision.is_null(merger.other_rev_id):
925
 
            raise errors.NoCommits(branch)
926
 
        self.branch.fetch(branch, last_revision=merger.other_rev_id)
927
 
        merger.other_basis = merger.other_rev_id
928
 
        merger.other_tree = self.branch.repository.revision_tree(
929
 
            merger.other_rev_id)
930
 
        merger.other_branch = branch
931
 
        if from_revision is None:
 
801
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
802
        try:
 
803
            merger = Merger(self.branch, this_tree=self, pb=pb)
 
804
            merger.pp = ProgressPhase("Merge phase", 5, pb)
 
805
            merger.pp.next_phase()
 
806
            # check that there are no
 
807
            # local alterations
 
808
            merger.check_basis(check_clean=True, require_commits=False)
 
809
            if to_revision is None:
 
810
                to_revision = branch.last_revision()
 
811
            else:
 
812
                to_revision = osutils.safe_revision_id(to_revision)
 
813
            merger.other_rev_id = to_revision
 
814
            if merger.other_rev_id is None:
 
815
                raise error.NoCommits(branch)
 
816
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
817
            merger.other_basis = merger.other_rev_id
 
818
            merger.other_tree = self.branch.repository.revision_tree(
 
819
                merger.other_rev_id)
 
820
            merger.other_branch = branch
 
821
            merger.pp.next_phase()
932
822
            merger.find_base()
933
 
        else:
934
 
            merger.set_base_revision(from_revision, branch)
935
 
        if merger.base_rev_id == merger.other_rev_id:
936
 
            raise errors.PointlessMerge
937
 
        merger.backup_files = False
938
 
        if merge_type is None:
 
823
            if merger.base_rev_id == merger.other_rev_id:
 
824
                raise errors.PointlessMerge
 
825
            merger.backup_files = False
939
826
            merger.merge_type = Merge3Merger
940
 
        else:
941
 
            merger.merge_type = merge_type
942
 
        merger.set_interesting_files(None)
943
 
        merger.show_base = False
944
 
        merger.reprocess = False
945
 
        conflicts = merger.do_merge()
946
 
        merger.set_pending()
 
827
            merger.set_interesting_files(None)
 
828
            merger.show_base = False
 
829
            merger.reprocess = False
 
830
            conflicts = merger.do_merge()
 
831
            merger.set_pending()
 
832
        finally:
 
833
            pb.finished()
947
834
        return conflicts
948
835
 
949
836
    @needs_read_lock
950
837
    def merge_modified(self):
951
838
        """Return a dictionary of files modified by a merge.
952
839
 
953
 
        The list is initialized by WorkingTree.set_merge_modified, which is
 
840
        The list is initialized by WorkingTree.set_merge_modified, which is 
954
841
        typically called after we make some automatic updates to the tree
955
842
        because of a merge.
956
843
 
958
845
        still in the working inventory and have that text hash.
959
846
        """
960
847
        try:
961
 
            hashfile = self._transport.get('merge-hashes')
 
848
            hashfile = self._control_files.get('merge-hashes')
962
849
        except errors.NoSuchFile:
963
850
            return {}
 
851
        merge_hashes = {}
964
852
        try:
965
 
            merge_hashes = {}
966
 
            try:
967
 
                if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
968
 
                    raise errors.MergeModifiedFormatError()
969
 
            except StopIteration:
 
853
            if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
970
854
                raise errors.MergeModifiedFormatError()
971
 
            for s in RioReader(hashfile):
972
 
                # RioReader reads in Unicode, so convert file_ids back to utf8
973
 
                file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
974
 
                if file_id not in self.inventory:
975
 
                    continue
976
 
                text_hash = s.get("hash")
977
 
                if text_hash == self.get_file_sha1(file_id):
978
 
                    merge_hashes[file_id] = text_hash
979
 
            return merge_hashes
980
 
        finally:
981
 
            hashfile.close()
 
855
        except StopIteration:
 
856
            raise errors.MergeModifiedFormatError()
 
857
        for s in RioReader(hashfile):
 
858
            # RioReader reads in Unicode, so convert file_ids back to utf8
 
859
            file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
 
860
            if file_id not in self.inventory:
 
861
                continue
 
862
            text_hash = s.get("hash")
 
863
            if text_hash == self.get_file_sha1(file_id):
 
864
                merge_hashes[file_id] = text_hash
 
865
        return merge_hashes
982
866
 
983
867
    @needs_write_lock
984
868
    def mkdir(self, path, file_id=None):
990
874
        return file_id
991
875
 
992
876
    def get_symlink_target(self, file_id):
993
 
        abspath = self.id2abspath(file_id)
994
 
        target = osutils.readlink(abspath)
995
 
        return target
 
877
        file_id = osutils.safe_file_id(file_id)
 
878
        return os.readlink(self.id2abspath(file_id))
996
879
 
997
880
    @needs_write_lock
998
881
    def subsume(self, other_tree):
1036
919
            other_tree.unlock()
1037
920
        other_tree.bzrdir.retire_bzrdir()
1038
921
 
1039
 
    def _setup_directory_is_tree_reference(self):
1040
 
        if self._branch.repository._format.supports_tree_reference:
1041
 
            self._directory_is_tree_reference = \
1042
 
                self._directory_may_be_tree_reference
1043
 
        else:
1044
 
            self._directory_is_tree_reference = \
1045
 
                self._directory_is_never_tree_reference
1046
 
 
1047
 
    def _directory_is_never_tree_reference(self, relpath):
1048
 
        return False
1049
 
 
1050
 
    def _directory_may_be_tree_reference(self, relpath):
1051
 
        # as a special case, if a directory contains control files then
1052
 
        # it's a tree reference, except that the root of the tree is not
1053
 
        return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1054
 
        # TODO: We could ask all the control formats whether they
1055
 
        # recognize this directory, but at the moment there's no cheap api
1056
 
        # to do that.  Since we probably can only nest bzr checkouts and
1057
 
        # they always use this name it's ok for now.  -- mbp 20060306
1058
 
        #
1059
 
        # FIXME: There is an unhandled case here of a subdirectory
1060
 
        # containing .bzr but not a branch; that will probably blow up
1061
 
        # when you try to commit it.  It might happen if there is a
1062
 
        # checkout in a subdirectory.  This can be avoided by not adding
1063
 
        # it.  mbp 20070306
1064
 
 
1065
922
    @needs_tree_write_lock
1066
923
    def extract(self, file_id, format=None):
1067
924
        """Extract a subtree from this tree.
1068
 
 
 
925
        
1069
926
        A new branch will be created, relative to the path for this tree.
1070
927
        """
1071
928
        self.flush()
1074
931
            transport = self.branch.bzrdir.root_transport
1075
932
            for name in segments:
1076
933
                transport = transport.clone(name)
1077
 
                transport.ensure_base()
 
934
                try:
 
935
                    transport.mkdir('.')
 
936
                except errors.FileExists:
 
937
                    pass
1078
938
            return transport
1079
 
 
 
939
            
1080
940
        sub_path = self.id2path(file_id)
1081
941
        branch_transport = mkdirs(sub_path)
1082
942
        if format is None:
1083
 
            format = self.bzrdir.cloning_metadir()
1084
 
        branch_transport.ensure_base()
 
943
            format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
 
944
        try:
 
945
            branch_transport.mkdir('.')
 
946
        except errors.FileExists:
 
947
            pass
1085
948
        branch_bzrdir = format.initialize_on_transport(branch_transport)
1086
949
        try:
1087
950
            repo = branch_bzrdir.find_repository()
1088
951
        except errors.NoRepositoryPresent:
1089
952
            repo = branch_bzrdir.create_repository()
1090
 
        if not repo.supports_rich_root():
1091
 
            raise errors.RootNotRich()
 
953
            assert repo.supports_rich_root()
 
954
        else:
 
955
            if not repo.supports_rich_root():
 
956
                raise errors.RootNotRich()
1092
957
        new_branch = branch_bzrdir.create_branch()
1093
958
        new_branch.pull(self.branch)
1094
959
        for parent_id in self.get_parent_ids():
1096
961
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
1097
962
        if tree_transport.base != branch_transport.base:
1098
963
            tree_bzrdir = format.initialize_on_transport(tree_transport)
1099
 
            branch.BranchReferenceFormat().initialize(tree_bzrdir,
1100
 
                target_branch=new_branch)
 
964
            branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1101
965
        else:
1102
966
            tree_bzrdir = branch_bzrdir
1103
 
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
 
967
        wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1104
968
        wt.set_parent_ids(self.get_parent_ids())
1105
969
        my_inv = self.inventory
1106
 
        child_inv = inventory.Inventory(root_id=None)
 
970
        child_inv = Inventory(root_id=None)
1107
971
        new_root = my_inv[file_id]
1108
972
        my_inv.remove_recursive_id(file_id)
1109
973
        new_root.parent_id = None
1113
977
        return wt
1114
978
 
1115
979
    def _serialize(self, inventory, out_file):
1116
 
        xml5.serializer_v5.write_inventory(self._inventory, out_file,
1117
 
            working=True)
 
980
        xml5.serializer_v5.write_inventory(self._inventory, out_file)
1118
981
 
1119
982
    def _deserialize(selt, in_file):
1120
983
        return xml5.serializer_v5.read_inventory(in_file)
1127
990
        sio = StringIO()
1128
991
        self._serialize(self._inventory, sio)
1129
992
        sio.seek(0)
1130
 
        self._transport.put_file('inventory', sio,
1131
 
            mode=self.bzrdir._get_file_mode())
 
993
        self._control_files.put('inventory', sio)
1132
994
        self._inventory_is_modified = False
1133
995
 
1134
996
    def _kind(self, relpath):
1135
997
        return osutils.file_kind(self.abspath(relpath))
1136
998
 
1137
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
1138
 
        """List all files as (path, class, kind, id, entry).
 
999
    def list_files(self, include_root=False):
 
1000
        """Recursively list all files as (path, class, kind, id, entry).
1139
1001
 
1140
1002
        Lists, but does not descend into unversioned directories.
 
1003
 
1141
1004
        This does not include files that have been deleted in this
1142
 
        tree. Skips the control directory.
 
1005
        tree.
1143
1006
 
1144
 
        :param include_root: if True, return an entry for the root
1145
 
        :param from_dir: start from this directory or None for the root
1146
 
        :param recursive: whether to recurse into subdirectories or not
 
1007
        Skips the control directory.
1147
1008
        """
1148
1009
        # list_files is an iterator, so @needs_read_lock doesn't work properly
1149
1010
        # with it. So callers should be careful to always read_lock the tree.
1151
1012
            raise errors.ObjectNotLocked(self)
1152
1013
 
1153
1014
        inv = self.inventory
1154
 
        if from_dir is None and include_root is True:
 
1015
        if include_root is True:
1155
1016
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1156
1017
        # Convert these into local objects to save lookup times
1157
1018
        pathjoin = osutils.pathjoin
1164
1025
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1165
1026
 
1166
1027
        # directory file_id, relative path, absolute path, reverse sorted children
1167
 
        if from_dir is not None:
1168
 
            from_dir_id = inv.path2id(from_dir)
1169
 
            if from_dir_id is None:
1170
 
                # Directory not versioned
1171
 
                return
1172
 
            from_dir_abspath = pathjoin(self.basedir, from_dir)
1173
 
        else:
1174
 
            from_dir_id = inv.root.file_id
1175
 
            from_dir_abspath = self.basedir
1176
 
        children = os.listdir(from_dir_abspath)
 
1028
        children = os.listdir(self.basedir)
1177
1029
        children.sort()
1178
 
        # jam 20060527 The kernel sized tree seems equivalent whether we
 
1030
        # jam 20060527 The kernel sized tree seems equivalent whether we 
1179
1031
        # use a deque and popleft to keep them sorted, or if we use a plain
1180
1032
        # list and just reverse() them.
1181
1033
        children = collections.deque(children)
1182
 
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
 
1034
        stack = [(inv.root.file_id, u'', self.basedir, children)]
1183
1035
        while stack:
1184
1036
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1185
1037
 
1201
1053
 
1202
1054
                # absolute path
1203
1055
                fap = from_dir_abspath + '/' + f
1204
 
 
 
1056
                
1205
1057
                f_ie = inv.get_child(from_dir_id, f)
1206
1058
                if f_ie:
1207
1059
                    c = 'V'
1239
1091
                    except KeyError:
1240
1092
                        yield fp[1:], c, fk, None, TreeEntry()
1241
1093
                    continue
1242
 
 
 
1094
                
1243
1095
                if fk != 'directory':
1244
1096
                    continue
1245
1097
 
1246
 
                # But do this child first if recursing down
1247
 
                if recursive:
1248
 
                    new_children = os.listdir(fap)
1249
 
                    new_children.sort()
1250
 
                    new_children = collections.deque(new_children)
1251
 
                    stack.append((f_ie.file_id, fp, fap, new_children))
1252
 
                    # Break out of inner loop,
1253
 
                    # so that we start outer loop with child
1254
 
                    break
 
1098
                # But do this child first
 
1099
                new_children = os.listdir(fap)
 
1100
                new_children.sort()
 
1101
                new_children = collections.deque(new_children)
 
1102
                stack.append((f_ie.file_id, fp, fap, new_children))
 
1103
                # Break out of inner loop,
 
1104
                # so that we start outer loop with child
 
1105
                break
1255
1106
            else:
1256
1107
                # if we finished all children, pop it off the stack
1257
1108
                stack.pop()
1263
1114
        to_dir must exist in the inventory.
1264
1115
 
1265
1116
        If to_dir exists and is a directory, the files are moved into
1266
 
        it, keeping their old names.
 
1117
        it, keeping their old names.  
1267
1118
 
1268
1119
        Note that to_dir is only the last component of the new name;
1269
1120
        this doesn't change the directory.
1306
1157
                                       DeprecationWarning)
1307
1158
 
1308
1159
        # check destination directory
1309
 
        if isinstance(from_paths, basestring):
1310
 
            raise ValueError()
 
1160
        assert not isinstance(from_paths, basestring)
1311
1161
        inv = self.inventory
1312
1162
        to_abs = self.abspath(to_dir)
1313
1163
        if not isdir(to_abs):
1397
1247
                only_change_inv = True
1398
1248
            elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1399
1249
                only_change_inv = False
1400
 
            elif (not self.case_sensitive
1401
 
                  and from_rel.lower() == to_rel.lower()
1402
 
                  and self.has_filename(from_rel)):
1403
 
                only_change_inv = False
1404
1250
            else:
1405
1251
                # something is wrong, so lets determine what exactly
1406
1252
                if not self.has_filename(from_rel) and \
1409
1255
                        errors.PathsDoNotExist(paths=(str(from_rel),
1410
1256
                        str(to_rel))))
1411
1257
                else:
1412
 
                    raise errors.RenameFailedFilesExist(from_rel, to_rel)
 
1258
                    raise errors.RenameFailedFilesExist(from_rel, to_rel,
 
1259
                        extra="(Use --after to update the Bazaar id)")
1413
1260
            rename_entry.only_change_inv = only_change_inv
1414
1261
        return rename_entries
1415
1262
 
1435
1282
        inv = self.inventory
1436
1283
        for entry in moved:
1437
1284
            try:
1438
 
                self._move_entry(WorkingTree._RenameEntry(
1439
 
                    entry.to_rel, entry.from_id,
 
1285
                self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1440
1286
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
1441
1287
                    entry.from_tail, entry.from_parent_id,
1442
1288
                    entry.only_change_inv))
1493
1339
        from_tail = splitpath(from_rel)[-1]
1494
1340
        from_id = inv.path2id(from_rel)
1495
1341
        if from_id is None:
1496
 
            # if file is missing in the inventory maybe it's in the basis_tree
1497
 
            basis_tree = self.branch.basis_tree()
1498
 
            from_id = basis_tree.path2id(from_rel)
1499
 
            if from_id is None:
1500
 
                raise errors.BzrRenameFailedError(from_rel,to_rel,
1501
 
                    errors.NotVersionedError(path=str(from_rel)))
1502
 
            # put entry back in the inventory so we can rename it
1503
 
            from_entry = basis_tree.inventory[from_id].copy()
1504
 
            inv.add(from_entry)
1505
 
        else:
1506
 
            from_entry = inv[from_id]
 
1342
            raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1343
                errors.NotVersionedError(path=str(from_rel)))
 
1344
        from_entry = inv[from_id]
1507
1345
        from_parent_id = from_entry.parent_id
1508
1346
        to_dir, to_tail = os.path.split(to_rel)
1509
1347
        to_dir_id = inv.path2id(to_dir)
1555
1393
        These are files in the working directory that are not versioned or
1556
1394
        control files or ignored.
1557
1395
        """
1558
 
        # force the extras method to be fully executed before returning, to
 
1396
        # force the extras method to be fully executed before returning, to 
1559
1397
        # prevent race conditions with the lock
1560
1398
        return iter(
1561
1399
            [subp for subp in self.extras() if not self.is_ignored(subp)])
1562
 
 
 
1400
    
1563
1401
    @needs_tree_write_lock
1564
1402
    def unversion(self, file_ids):
1565
1403
        """Remove the file ids in file_ids from the current versioned set.
1571
1409
        :raises: NoSuchId if any fileid is not currently versioned.
1572
1410
        """
1573
1411
        for file_id in file_ids:
1574
 
            if file_id not in self._inventory:
1575
 
                raise errors.NoSuchId(self, file_id)
1576
 
        for file_id in file_ids:
 
1412
            file_id = osutils.safe_file_id(file_id)
1577
1413
            if self._inventory.has_id(file_id):
1578
1414
                self._inventory.remove_recursive_id(file_id)
 
1415
            else:
 
1416
                raise errors.NoSuchId(self, file_id)
1579
1417
        if len(file_ids):
1580
 
            # in the future this should just set a dirty bit to wait for the
 
1418
            # in the future this should just set a dirty bit to wait for the 
1581
1419
            # final unlock. However, until all methods of workingtree start
1582
 
            # with the current in -memory inventory rather than triggering
 
1420
            # with the current in -memory inventory rather than triggering 
1583
1421
            # a read, it is more complex - we need to teach read_inventory
1584
1422
            # to know when to read, and when to not read first... and possibly
1585
1423
            # to save first when the in memory one may be corrupted.
1586
1424
            # so for now, we just only write it if it is indeed dirty.
1587
1425
            # - RBC 20060907
1588
1426
            self._write_inventory(self._inventory)
 
1427
    
 
1428
    @deprecated_method(zero_eight)
 
1429
    def iter_conflicts(self):
 
1430
        """List all files in the tree that have text or content conflicts.
 
1431
        DEPRECATED.  Use conflicts instead."""
 
1432
        return self._iter_conflicts()
1589
1433
 
1590
1434
    def _iter_conflicts(self):
1591
1435
        conflicted = set()
1600
1444
 
1601
1445
    @needs_write_lock
1602
1446
    def pull(self, source, overwrite=False, stop_revision=None,
1603
 
             change_reporter=None, possible_transports=None, local=False):
 
1447
             change_reporter=None):
 
1448
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1604
1449
        source.lock_read()
1605
1450
        try:
 
1451
            pp = ProgressPhase("Pull phase", 2, top_pb)
 
1452
            pp.next_phase()
1606
1453
            old_revision_info = self.branch.last_revision_info()
1607
1454
            basis_tree = self.basis_tree()
1608
 
            count = self.branch.pull(source, overwrite, stop_revision,
1609
 
                                     possible_transports=possible_transports,
1610
 
                                     local=local)
 
1455
            count = self.branch.pull(source, overwrite, stop_revision)
1611
1456
            new_revision_info = self.branch.last_revision_info()
1612
1457
            if new_revision_info != old_revision_info:
 
1458
                pp.next_phase()
1613
1459
                repository = self.branch.repository
 
1460
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
1614
1461
                basis_tree.lock_read()
1615
1462
                try:
1616
1463
                    new_basis_tree = self.branch.basis_tree()
1619
1466
                                new_basis_tree,
1620
1467
                                basis_tree,
1621
1468
                                this_tree=self,
1622
 
                                pb=None,
 
1469
                                pb=pb,
1623
1470
                                change_reporter=change_reporter)
1624
 
                    basis_root_id = basis_tree.get_root_id()
1625
 
                    new_root_id = new_basis_tree.get_root_id()
1626
 
                    if basis_root_id != new_root_id:
1627
 
                        self.set_root_id(new_root_id)
 
1471
                    if (basis_tree.inventory.root is None and
 
1472
                        new_basis_tree.inventory.root is not None):
 
1473
                        self.set_root_id(new_basis_tree.inventory.root.file_id)
1628
1474
                finally:
 
1475
                    pb.finished()
1629
1476
                    basis_tree.unlock()
1630
1477
                # TODO - dedup parents list with things merged by pull ?
1631
1478
                # reuse the revisiontree we merged against to set the new
1632
1479
                # tree data.
1633
1480
                parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1634
 
                # we have to pull the merge trees out again, because
1635
 
                # merge_inner has set the ids. - this corner is not yet
 
1481
                # we have to pull the merge trees out again, because 
 
1482
                # merge_inner has set the ids. - this corner is not yet 
1636
1483
                # layered well enough to prevent double handling.
1637
1484
                # XXX TODO: Fix the double handling: telling the tree about
1638
1485
                # the already known parent data is wasteful.
1644
1491
            return count
1645
1492
        finally:
1646
1493
            source.unlock()
 
1494
            top_pb.finished()
1647
1495
 
1648
1496
    @needs_write_lock
1649
1497
    def put_file_bytes_non_atomic(self, file_id, bytes):
1650
1498
        """See MutableTree.put_file_bytes_non_atomic."""
 
1499
        file_id = osutils.safe_file_id(file_id)
1651
1500
        stream = file(self.id2abspath(file_id), 'wb')
1652
1501
        try:
1653
1502
            stream.write(bytes)
1675
1524
 
1676
1525
            fl = []
1677
1526
            for subf in os.listdir(dirabs):
1678
 
                if self.bzrdir.is_control_filename(subf):
 
1527
                if subf == '.bzr':
1679
1528
                    continue
1680
1529
                if subf not in dir_entry.children:
1681
 
                    try:
1682
 
                        (subf_norm,
1683
 
                         can_access) = osutils.normalized_filename(subf)
1684
 
                    except UnicodeDecodeError:
1685
 
                        path_os_enc = path.encode(osutils._fs_enc)
1686
 
                        relpath = path_os_enc + '/' + subf
1687
 
                        raise errors.BadFilenameEncoding(relpath,
1688
 
                                                         osutils._fs_enc)
 
1530
                    subf_norm, can_access = osutils.normalized_filename(subf)
1689
1531
                    if subf_norm != subf and can_access:
1690
1532
                        if subf_norm not in dir_entry.children:
1691
1533
                            fl.append(subf_norm)
1692
1534
                    else:
1693
1535
                        fl.append(subf)
1694
 
 
 
1536
            
1695
1537
            fl.sort()
1696
1538
            for subf in fl:
1697
1539
                subp = pathjoin(path, subf)
1713
1555
        if ignoreset is not None:
1714
1556
            return ignoreset
1715
1557
 
1716
 
        ignore_globs = set()
 
1558
        ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1717
1559
        ignore_globs.update(ignores.get_runtime_ignores())
1718
1560
        ignore_globs.update(ignores.get_user_ignores())
1719
1561
        if self.has_filename(bzrlib.IGNORE_FILENAME):
1734
1576
        r"""Check whether the filename matches an ignore pattern.
1735
1577
 
1736
1578
        Patterns containing '/' or '\' need to match the whole path;
1737
 
        others match against only the last component.  Patterns starting
1738
 
        with '!' are ignore exceptions.  Exceptions take precedence
1739
 
        over regular patterns and cause the filename to not be ignored.
 
1579
        others match against only the last component.
1740
1580
 
1741
1581
        If the file is ignored, returns the pattern which caused it to
1742
1582
        be ignored, otherwise None.  So this can simply be used as a
1743
1583
        boolean if desired."""
1744
1584
        if getattr(self, '_ignoreglobster', None) is None:
1745
 
            self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
 
1585
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1746
1586
        return self._ignoreglobster.match(filename)
1747
1587
 
1748
1588
    def kind(self, file_id):
1749
1589
        return file_kind(self.id2abspath(file_id))
1750
1590
 
1751
 
    def stored_kind(self, file_id):
1752
 
        """See Tree.stored_kind"""
1753
 
        return self.inventory[file_id].kind
1754
 
 
1755
1591
    def _comparison_data(self, entry, path):
1756
1592
        abspath = self.abspath(path)
1757
1593
        try:
1767
1603
            mode = stat_value.st_mode
1768
1604
            kind = osutils.file_kind_from_stat_mode(mode)
1769
1605
            if not supports_executable():
1770
 
                executable = entry is not None and entry.executable
 
1606
                executable = entry.executable
1771
1607
            else:
1772
1608
                executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1773
1609
        return kind, executable, stat_value
1788
1624
    @needs_read_lock
1789
1625
    def _last_revision(self):
1790
1626
        """helper for get_parent_ids."""
1791
 
        return _mod_revision.ensure_null(self.branch.last_revision())
 
1627
        return self.branch.last_revision()
1792
1628
 
1793
1629
    def is_locked(self):
1794
1630
        return self._control_files.is_locked()
1798
1634
            raise errors.ObjectNotLocked(self)
1799
1635
 
1800
1636
    def lock_read(self):
1801
 
        """Lock the tree for reading.
1802
 
 
1803
 
        This also locks the branch, and can be unlocked via self.unlock().
1804
 
 
1805
 
        :return: An object with an unlock method which will release the lock
1806
 
            obtained.
1807
 
        """
 
1637
        """See Branch.lock_read, and WorkingTree.unlock."""
1808
1638
        if not self.is_locked():
1809
1639
            self._reset_data()
1810
1640
        self.branch.lock_read()
1811
1641
        try:
1812
 
            self._control_files.lock_read()
1813
 
            return self
 
1642
            return self._control_files.lock_read()
1814
1643
        except:
1815
1644
            self.branch.unlock()
1816
1645
            raise
1817
1646
 
1818
1647
    def lock_tree_write(self):
1819
 
        """See MutableTree.lock_tree_write, and WorkingTree.unlock.
1820
 
 
1821
 
        :return: An object with an unlock method which will release the lock
1822
 
            obtained.
1823
 
        """
 
1648
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1824
1649
        if not self.is_locked():
1825
1650
            self._reset_data()
1826
1651
        self.branch.lock_read()
1827
1652
        try:
1828
 
            self._control_files.lock_write()
1829
 
            return self
 
1653
            return self._control_files.lock_write()
1830
1654
        except:
1831
1655
            self.branch.unlock()
1832
1656
            raise
1833
1657
 
1834
1658
    def lock_write(self):
1835
 
        """See MutableTree.lock_write, and WorkingTree.unlock.
1836
 
 
1837
 
        :return: An object with an unlock method which will release the lock
1838
 
            obtained.
1839
 
        """
 
1659
        """See MutableTree.lock_write, and WorkingTree.unlock."""
1840
1660
        if not self.is_locked():
1841
1661
            self._reset_data()
1842
1662
        self.branch.lock_write()
1843
1663
        try:
1844
 
            self._control_files.lock_write()
1845
 
            return self
 
1664
            return self._control_files.lock_write()
1846
1665
        except:
1847
1666
            self.branch.unlock()
1848
1667
            raise
1856
1675
    def _reset_data(self):
1857
1676
        """Reset transient data that cannot be revalidated."""
1858
1677
        self._inventory_is_modified = False
1859
 
        f = self._transport.get('inventory')
1860
 
        try:
1861
 
            result = self._deserialize(f)
1862
 
        finally:
1863
 
            f.close()
 
1678
        result = self._deserialize(self._control_files.get('inventory'))
1864
1679
        self._set_inventory(result, dirty=False)
1865
1680
 
1866
1681
    @needs_tree_write_lock
1867
1682
    def set_last_revision(self, new_revision):
1868
1683
        """Change the last revision in the working tree."""
 
1684
        new_revision = osutils.safe_revision_id(new_revision)
1869
1685
        if self._change_last_revision(new_revision):
1870
1686
            self._cache_basis_inventory(new_revision)
1871
1687
 
1872
1688
    def _change_last_revision(self, new_revision):
1873
1689
        """Template method part of set_last_revision to perform the change.
1874
 
 
 
1690
        
1875
1691
        This is used to allow WorkingTree3 instances to not affect branch
1876
1692
        when their last revision is set.
1877
1693
        """
1878
 
        if _mod_revision.is_null(new_revision):
 
1694
        if new_revision is None:
1879
1695
            self.branch.set_revision_history([])
1880
1696
            return False
1881
1697
        try:
1887
1703
 
1888
1704
    def _write_basis_inventory(self, xml):
1889
1705
        """Write the basis inventory XML to the basis-inventory file"""
 
1706
        assert isinstance(xml, str), 'serialised xml must be bytestring.'
1890
1707
        path = self._basis_inventory_name()
1891
1708
        sio = StringIO(xml)
1892
 
        self._transport.put_file(path, sio,
1893
 
            mode=self.bzrdir._get_file_mode())
 
1709
        self._control_files.put(path, sio)
1894
1710
 
1895
1711
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
1896
1712
        """Create the text that will be saved in basis-inventory"""
1897
 
        inventory.revision_id = revision_id
 
1713
        # TODO: jam 20070209 This should be redundant, as the revision_id
 
1714
        #       as all callers should have already converted the revision_id to
 
1715
        #       utf8
 
1716
        inventory.revision_id = osutils.safe_revision_id(revision_id)
1898
1717
        return xml7.serializer_v7.write_inventory_to_string(inventory)
1899
1718
 
1900
1719
    def _cache_basis_inventory(self, new_revision):
1903
1722
        # as commit already has that ready-to-use [while the format is the
1904
1723
        # same, that is].
1905
1724
        try:
1906
 
            # this double handles the inventory - unpack and repack -
 
1725
            # this double handles the inventory - unpack and repack - 
1907
1726
            # but is easier to understand. We can/should put a conditional
1908
1727
            # in here based on whether the inventory is in the latest format
1909
1728
            # - perhaps we should repack all inventories on a repository
1910
1729
            # upgrade ?
1911
1730
            # the fast path is to copy the raw xml from the repository. If the
1912
 
            # xml contains 'revision_id="', then we assume the right
 
1731
            # xml contains 'revision_id="', then we assume the right 
1913
1732
            # revision_id is set. We must check for this full string, because a
1914
1733
            # root node id can legitimately look like 'revision_id' but cannot
1915
1734
            # contain a '"'.
1916
 
            xml = self.branch.repository._get_inventory_xml(new_revision)
 
1735
            xml = self.branch.repository.get_inventory_xml(new_revision)
1917
1736
            firstline = xml.split('\n', 1)[0]
1918
 
            if (not 'revision_id="' in firstline or
 
1737
            if (not 'revision_id="' in firstline or 
1919
1738
                'format="7"' not in firstline):
1920
 
                inv = self.branch.repository._serializer.read_inventory_from_string(
1921
 
                    xml, new_revision)
 
1739
                inv = self.branch.repository.deserialise_inventory(
 
1740
                    new_revision, xml)
1922
1741
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
1923
1742
            self._write_basis_inventory(xml)
1924
1743
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1927
1746
    def read_basis_inventory(self):
1928
1747
        """Read the cached basis inventory."""
1929
1748
        path = self._basis_inventory_name()
1930
 
        return self._transport.get_bytes(path)
1931
 
 
 
1749
        return self._control_files.get(path).read()
 
1750
        
1932
1751
    @needs_read_lock
1933
1752
    def read_working_inventory(self):
1934
1753
        """Read the working inventory.
1935
 
 
 
1754
        
1936
1755
        :raises errors.InventoryModified: read_working_inventory will fail
1937
1756
            when the current in memory inventory has been modified.
1938
1757
        """
1939
 
        # conceptually this should be an implementation detail of the tree.
 
1758
        # conceptually this should be an implementation detail of the tree. 
1940
1759
        # XXX: Deprecate this.
1941
1760
        # ElementTree does its own conversion from UTF-8, so open in
1942
1761
        # binary.
1943
1762
        if self._inventory_is_modified:
1944
1763
            raise errors.InventoryModified(self)
1945
 
        f = self._transport.get('inventory')
1946
 
        try:
1947
 
            result = self._deserialize(f)
1948
 
        finally:
1949
 
            f.close()
 
1764
        result = self._deserialize(self._control_files.get('inventory'))
1950
1765
        self._set_inventory(result, dirty=False)
1951
1766
        return result
1952
1767
 
1953
1768
    @needs_tree_write_lock
1954
 
    def remove(self, files, verbose=False, to_file=None, keep_files=True,
1955
 
        force=False):
1956
 
        """Remove nominated files from the working inventory.
1957
 
 
1958
 
        :files: File paths relative to the basedir.
1959
 
        :keep_files: If true, the files will also be kept.
1960
 
        :force: Delete files and directories, even if they are changed and
1961
 
            even if the directories are not empty.
 
1769
    def remove(self, files, verbose=False, to_file=None):
 
1770
        """Remove nominated files from the working inventory..
 
1771
 
 
1772
        This does not remove their text.  This does not run on XXX on what? RBC
 
1773
 
 
1774
        TODO: Refuse to remove modified files unless --force is given?
 
1775
 
 
1776
        TODO: Do something useful with directories.
 
1777
 
 
1778
        TODO: Should this remove the text or not?  Tough call; not
 
1779
        removing may be useful and the user can just use use rm, and
 
1780
        is the opposite of add.  Removing it is consistent with most
 
1781
        other tools.  Maybe an option.
1962
1782
        """
 
1783
        ## TODO: Normalize names
 
1784
        ## TODO: Remove nested loops; better scalability
1963
1785
        if isinstance(files, basestring):
1964
1786
            files = [files]
1965
1787
 
1966
 
        inv_delta = []
1967
 
 
1968
 
        new_files=set()
1969
 
        unknown_nested_files=set()
1970
 
        if to_file is None:
1971
 
            to_file = sys.stdout
1972
 
 
1973
 
        def recurse_directory_to_add_files(directory):
1974
 
            # Recurse directory and add all files
1975
 
            # so we can check if they have changed.
1976
 
            for parent_info, file_infos in\
1977
 
                self.walkdirs(directory):
1978
 
                for relpath, basename, kind, lstat, fileid, kind in file_infos:
1979
 
                    # Is it versioned or ignored?
1980
 
                    if self.path2id(relpath) or self.is_ignored(relpath):
1981
 
                        # Add nested content for deletion.
1982
 
                        new_files.add(relpath)
1983
 
                    else:
1984
 
                        # Files which are not versioned and not ignored
1985
 
                        # should be treated as unknown.
1986
 
                        unknown_nested_files.add((relpath, None, kind))
1987
 
 
1988
 
        for filename in files:
1989
 
            # Get file name into canonical form.
1990
 
            abspath = self.abspath(filename)
1991
 
            filename = self.relpath(abspath)
1992
 
            if len(filename) > 0:
1993
 
                new_files.add(filename)
1994
 
                recurse_directory_to_add_files(filename)
1995
 
 
1996
 
        files = list(new_files)
1997
 
 
1998
 
        if len(files) == 0:
1999
 
            return # nothing to do
2000
 
 
2001
 
        # Sort needed to first handle directory content before the directory
2002
 
        files.sort(reverse=True)
2003
 
 
2004
 
        # Bail out if we are going to delete files we shouldn't
2005
 
        if not keep_files and not force:
2006
 
            has_changed_files = len(unknown_nested_files) > 0
2007
 
            if not has_changed_files:
2008
 
                for (file_id, path, content_change, versioned, parent_id, name,
2009
 
                     kind, executable) in self.iter_changes(self.basis_tree(),
2010
 
                         include_unchanged=True, require_versioned=False,
2011
 
                         want_unversioned=True, specific_files=files):
2012
 
                    if versioned == (False, False):
2013
 
                        # The record is unknown ...
2014
 
                        if not self.is_ignored(path[1]):
2015
 
                            # ... but not ignored
2016
 
                            has_changed_files = True
2017
 
                            break
2018
 
                    elif content_change and (kind[1] is not None):
2019
 
                        # Versioned and changed, but not deleted
2020
 
                        has_changed_files = True
2021
 
                        break
2022
 
 
2023
 
            if has_changed_files:
2024
 
                # Make delta show ALL applicable changes in error message.
2025
 
                tree_delta = self.changes_from(self.basis_tree(),
2026
 
                    require_versioned=False, want_unversioned=True,
2027
 
                    specific_files=files)
2028
 
                for unknown_file in unknown_nested_files:
2029
 
                    if unknown_file not in tree_delta.unversioned:
2030
 
                        tree_delta.unversioned.extend((unknown_file,))
2031
 
                raise errors.BzrRemoveChangedFilesError(tree_delta)
2032
 
 
2033
 
        # Build inv_delta and delete files where applicable,
2034
 
        # do this before any modifications to inventory.
 
1788
        inv = self.inventory
 
1789
 
 
1790
        # do this before any modifications
2035
1791
        for f in files:
2036
 
            fid = self.path2id(f)
2037
 
            message = None
 
1792
            fid = inv.path2id(f)
2038
1793
            if not fid:
2039
 
                message = "%s is not versioned." % (f,)
 
1794
                note("%s is not versioned."%f)
2040
1795
            else:
2041
1796
                if verbose:
2042
 
                    # having removed it, it must be either ignored or unknown
 
1797
                    # having remove it, it must be either ignored or unknown
2043
1798
                    if self.is_ignored(f):
2044
1799
                        new_status = 'I'
2045
1800
                    else:
2046
1801
                        new_status = '?'
2047
 
                    # XXX: Really should be a more abstract reporter interface
2048
 
                    kind_ch = osutils.kind_marker(self.kind(fid))
2049
 
                    to_file.write(new_status + '       ' + f + kind_ch + '\n')
2050
 
                # Unversion file
2051
 
                inv_delta.append((f, None, fid, None))
2052
 
                message = "removed %s" % (f,)
2053
 
 
2054
 
            if not keep_files:
2055
 
                abs_path = self.abspath(f)
2056
 
                if osutils.lexists(abs_path):
2057
 
                    if (osutils.isdir(abs_path) and
2058
 
                        len(os.listdir(abs_path)) > 0):
2059
 
                        if force:
2060
 
                            osutils.rmtree(abs_path)
2061
 
                        else:
2062
 
                            message = "%s is not an empty directory "\
2063
 
                                "and won't be deleted." % (f,)
2064
 
                    else:
2065
 
                        osutils.delete_any(abs_path)
2066
 
                        message = "deleted %s" % (f,)
2067
 
                elif message is not None:
2068
 
                    # Only care if we haven't done anything yet.
2069
 
                    message = "%s does not exist." % (f,)
2070
 
 
2071
 
            # Print only one message (if any) per file.
2072
 
            if message is not None:
2073
 
                note(message)
2074
 
        self.apply_inventory_delta(inv_delta)
 
1802
                    textui.show_status(new_status, inv[fid].kind, f,
 
1803
                                       to_file=to_file)
 
1804
                del inv[fid]
 
1805
 
 
1806
        self._write_inventory(inv)
2075
1807
 
2076
1808
    @needs_tree_write_lock
2077
 
    def revert(self, filenames=None, old_tree=None, backups=True,
2078
 
               pb=None, report_changes=False):
 
1809
    def revert(self, filenames, old_tree=None, backups=True, 
 
1810
               pb=DummyProgress(), report_changes=False):
2079
1811
        from bzrlib.conflicts import resolve
2080
 
        if filenames == []:
2081
 
            filenames = None
2082
 
            symbol_versioning.warn('Using [] to revert all files is deprecated'
2083
 
                ' as of bzr 0.91.  Please use None (the default) instead.',
2084
 
                DeprecationWarning, stacklevel=2)
2085
1812
        if old_tree is None:
2086
 
            basis_tree = self.basis_tree()
2087
 
            basis_tree.lock_read()
2088
 
            old_tree = basis_tree
 
1813
            old_tree = self.basis_tree()
 
1814
        conflicts = transform.revert(self, old_tree, filenames, backups, pb,
 
1815
                                     report_changes)
 
1816
        if not len(filenames):
 
1817
            self.set_parent_ids(self.get_parent_ids()[:1])
 
1818
            resolve(self)
2089
1819
        else:
2090
 
            basis_tree = None
2091
 
        try:
2092
 
            conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2093
 
                                         report_changes)
2094
 
            if filenames is None and len(self.get_parent_ids()) > 1:
2095
 
                parent_trees = []
2096
 
                last_revision = self.last_revision()
2097
 
                if last_revision != _mod_revision.NULL_REVISION:
2098
 
                    if basis_tree is None:
2099
 
                        basis_tree = self.basis_tree()
2100
 
                        basis_tree.lock_read()
2101
 
                    parent_trees.append((last_revision, basis_tree))
2102
 
                self.set_parent_trees(parent_trees)
2103
 
                resolve(self)
2104
 
            else:
2105
 
                resolve(self, filenames, ignore_misses=True, recursive=True)
2106
 
        finally:
2107
 
            if basis_tree is not None:
2108
 
                basis_tree.unlock()
 
1820
            resolve(self, filenames, ignore_misses=True)
2109
1821
        return conflicts
2110
1822
 
2111
1823
    def revision_tree(self, revision_id):
2138
1850
    def set_inventory(self, new_inventory_list):
2139
1851
        from bzrlib.inventory import (Inventory,
2140
1852
                                      InventoryDirectory,
 
1853
                                      InventoryEntry,
2141
1854
                                      InventoryFile,
2142
1855
                                      InventoryLink)
2143
1856
        inv = Inventory(self.get_root_id())
2145
1858
            name = os.path.basename(path)
2146
1859
            if name == "":
2147
1860
                continue
2148
 
            # fixme, there should be a factory function inv,add_??
 
1861
            # fixme, there should be a factory function inv,add_?? 
2149
1862
            if kind == 'directory':
2150
1863
                inv.add(InventoryDirectory(file_id, name, parent))
2151
1864
            elif kind == 'file':
2159
1872
    @needs_tree_write_lock
2160
1873
    def set_root_id(self, file_id):
2161
1874
        """Set the root id for this tree."""
2162
 
        # for compatability
 
1875
        # for compatability 
2163
1876
        if file_id is None:
2164
 
            raise ValueError(
2165
 
                'WorkingTree.set_root_id with fileid=None')
2166
 
        file_id = osutils.safe_file_id(file_id)
 
1877
            symbol_versioning.warn(symbol_versioning.zero_twelve
 
1878
                % 'WorkingTree.set_root_id with fileid=None',
 
1879
                DeprecationWarning,
 
1880
                stacklevel=3)
 
1881
            file_id = ROOT_ID
 
1882
        else:
 
1883
            file_id = osutils.safe_file_id(file_id)
2167
1884
        self._set_root_id(file_id)
2168
1885
 
2169
1886
    def _set_root_id(self, file_id):
2170
1887
        """Set the root id for this tree, in a format specific manner.
2171
1888
 
2172
 
        :param file_id: The file id to assign to the root. It must not be
 
1889
        :param file_id: The file id to assign to the root. It must not be 
2173
1890
            present in the current inventory or an error will occur. It must
2174
1891
            not be None, but rather a valid file id.
2175
1892
        """
2194
1911
 
2195
1912
    def unlock(self):
2196
1913
        """See Branch.unlock.
2197
 
 
 
1914
        
2198
1915
        WorkingTree locking just uses the Branch locking facilities.
2199
1916
        This is current because all working trees have an embedded branch
2200
1917
        within them. IF in the future, we were to make branch data shareable
2201
 
        between multiple working trees, i.e. via shared storage, then we
 
1918
        between multiple working trees, i.e. via shared storage, then we 
2202
1919
        would probably want to lock both the local tree, and the branch.
2203
1920
        """
2204
1921
        raise NotImplementedError(self.unlock)
2205
1922
 
2206
 
    _marker = object()
2207
 
 
2208
 
    def update(self, change_reporter=None, possible_transports=None,
2209
 
               revision=None, old_tip=_marker):
 
1923
    def update(self):
2210
1924
        """Update a working tree along its branch.
2211
1925
 
2212
1926
        This will update the branch if its bound too, which means we have
2230
1944
        - Merge current state -> basis tree of the master w.r.t. the old tree
2231
1945
          basis.
2232
1946
        - Do a 'normal' merge of the old branch basis if it is relevant.
2233
 
 
2234
 
        :param revision: The target revision to update to. Must be in the
2235
 
            revision history.
2236
 
        :param old_tip: If branch.update() has already been run, the value it
2237
 
            returned (old tip of the branch or None). _marker is used
2238
 
            otherwise.
2239
1947
        """
2240
 
        if self.branch.get_bound_location() is not None:
 
1948
        if self.branch.get_master_branch() is not None:
2241
1949
            self.lock_write()
2242
 
            update_branch = (old_tip is self._marker)
 
1950
            update_branch = True
2243
1951
        else:
2244
1952
            self.lock_tree_write()
2245
1953
            update_branch = False
2246
1954
        try:
2247
1955
            if update_branch:
2248
 
                old_tip = self.branch.update(possible_transports)
 
1956
                old_tip = self.branch.update()
2249
1957
            else:
2250
 
                if old_tip is self._marker:
2251
 
                    old_tip = None
2252
 
            return self._update_tree(old_tip, change_reporter, revision)
 
1958
                old_tip = None
 
1959
            return self._update_tree(old_tip)
2253
1960
        finally:
2254
1961
            self.unlock()
2255
1962
 
2256
1963
    @needs_tree_write_lock
2257
 
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
 
1964
    def _update_tree(self, old_tip=None):
2258
1965
        """Update a tree to the master branch.
2259
1966
 
2260
1967
        :param old_tip: if supplied, the previous tip revision the branch,
2266
1973
        # cant set that until we update the working trees last revision to be
2267
1974
        # one from the new branch, because it will just get absorbed by the
2268
1975
        # parent de-duplication logic.
2269
 
        #
 
1976
        # 
2270
1977
        # We MUST save it even if an error occurs, because otherwise the users
2271
1978
        # local work is unreferenced and will appear to have been lost.
2272
 
        #
2273
 
        nb_conflicts = 0
 
1979
        # 
 
1980
        result = 0
2274
1981
        try:
2275
1982
            last_rev = self.get_parent_ids()[0]
2276
1983
        except IndexError:
2277
 
            last_rev = _mod_revision.NULL_REVISION
2278
 
        if revision is None:
2279
 
            revision = self.branch.last_revision()
2280
 
 
2281
 
        old_tip = old_tip or _mod_revision.NULL_REVISION
2282
 
 
2283
 
        if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2284
 
            # the branch we are bound to was updated
2285
 
            # merge those changes in first
2286
 
            base_tree  = self.basis_tree()
2287
 
            other_tree = self.branch.repository.revision_tree(old_tip)
2288
 
            nb_conflicts = merge.merge_inner(self.branch, other_tree,
2289
 
                                             base_tree, this_tree=self,
2290
 
                                             change_reporter=change_reporter)
2291
 
            if nb_conflicts:
2292
 
                self.add_parent_tree((old_tip, other_tree))
2293
 
                trace.note('Rerun update after fixing the conflicts.')
2294
 
                return nb_conflicts
2295
 
 
2296
 
        if last_rev != _mod_revision.ensure_null(revision):
2297
 
            # the working tree is up to date with the branch
2298
 
            # we can merge the specified revision from master
2299
 
            to_tree = self.branch.repository.revision_tree(revision)
2300
 
            to_root_id = to_tree.get_root_id()
2301
 
 
 
1984
            last_rev = None
 
1985
        if last_rev != self.branch.last_revision():
 
1986
            # merge tree state up to new branch tip.
2302
1987
            basis = self.basis_tree()
2303
1988
            basis.lock_read()
2304
1989
            try:
2305
 
                if (basis.inventory.root is None
2306
 
                    or basis.inventory.root.file_id != to_root_id):
2307
 
                    self.set_root_id(to_root_id)
 
1990
                to_tree = self.branch.basis_tree()
 
1991
                if basis.inventory.root is None:
 
1992
                    self.set_root_id(to_tree.inventory.root.file_id)
2308
1993
                    self.flush()
 
1994
                result += merge.merge_inner(
 
1995
                                      self.branch,
 
1996
                                      to_tree,
 
1997
                                      basis,
 
1998
                                      this_tree=self)
2309
1999
            finally:
2310
2000
                basis.unlock()
2311
 
 
2312
 
            # determine the branch point
2313
 
            graph = self.branch.repository.get_graph()
2314
 
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2315
 
                                                last_rev)
2316
 
            base_tree = self.branch.repository.revision_tree(base_rev_id)
2317
 
 
2318
 
            nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2319
 
                                             this_tree=self,
2320
 
                                             change_reporter=change_reporter)
2321
 
            self.set_last_revision(revision)
2322
2001
            # TODO - dedup parents list with things merged by pull ?
2323
2002
            # reuse the tree we've updated to to set the basis:
2324
 
            parent_trees = [(revision, to_tree)]
 
2003
            parent_trees = [(self.branch.last_revision(), to_tree)]
2325
2004
            merges = self.get_parent_ids()[1:]
2326
2005
            # Ideally we ask the tree for the trees here, that way the working
2327
 
            # tree can decide whether to give us the entire tree or give us a
 
2006
            # tree can decide whether to give us teh entire tree or give us a
2328
2007
            # lazy initialised tree. dirstate for instance will have the trees
2329
2008
            # in ram already, whereas a last-revision + basis-inventory tree
2330
2009
            # will not, but also does not need them when setting parents.
2331
2010
            for parent in merges:
2332
2011
                parent_trees.append(
2333
2012
                    (parent, self.branch.repository.revision_tree(parent)))
2334
 
            if not _mod_revision.is_null(old_tip):
 
2013
            if old_tip is not None:
2335
2014
                parent_trees.append(
2336
2015
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
2337
2016
            self.set_parent_trees(parent_trees)
2338
2017
            last_rev = parent_trees[0][0]
2339
 
        return nb_conflicts
 
2018
        else:
 
2019
            # the working tree had the same last-revision as the master
 
2020
            # branch did. We may still have pivot local work from the local
 
2021
            # branch into old_tip:
 
2022
            if old_tip is not None:
 
2023
                self.add_parent_tree_id(old_tip)
 
2024
        if old_tip and old_tip != last_rev:
 
2025
            # our last revision was not the prior branch last revision
 
2026
            # and we have converted that last revision to a pending merge.
 
2027
            # base is somewhere between the branch tip now
 
2028
            # and the now pending merge
 
2029
 
 
2030
            # Since we just modified the working tree and inventory, flush out
 
2031
            # the current state, before we modify it again.
 
2032
            # TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
 
2033
            #       requires it only because TreeTransform directly munges the
 
2034
            #       inventory and calls tree._write_inventory(). Ultimately we
 
2035
            #       should be able to remove this extra flush.
 
2036
            self.flush()
 
2037
            from bzrlib.revision import common_ancestor
 
2038
            try:
 
2039
                base_rev_id = common_ancestor(self.branch.last_revision(),
 
2040
                                              old_tip,
 
2041
                                              self.branch.repository)
 
2042
            except errors.NoCommonAncestor:
 
2043
                base_rev_id = None
 
2044
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
2045
            other_tree = self.branch.repository.revision_tree(old_tip)
 
2046
            result += merge.merge_inner(
 
2047
                                  self.branch,
 
2048
                                  other_tree,
 
2049
                                  base_tree,
 
2050
                                  this_tree=self)
 
2051
        return result
2340
2052
 
2341
2053
    def _write_hashcache_if_dirty(self):
2342
2054
        """Write out the hashcache if it is dirty."""
2393
2105
    def walkdirs(self, prefix=""):
2394
2106
        """Walk the directories of this tree.
2395
2107
 
2396
 
        returns a generator which yields items in the form:
2397
 
                ((curren_directory_path, fileid),
2398
 
                 [(file1_path, file1_name, file1_kind, (lstat), file1_id,
2399
 
                   file1_kind), ... ])
2400
 
 
2401
2108
        This API returns a generator, which is only valid during the current
2402
2109
        tree transaction - within a single lock_read or lock_write duration.
2403
2110
 
2404
 
        If the tree is not locked, it may cause an error to be raised,
2405
 
        depending on the tree implementation.
 
2111
        If the tree is not locked, it may cause an error to be raised, depending
 
2112
        on the tree implementation.
2406
2113
        """
2407
2114
        disk_top = self.abspath(prefix)
2408
2115
        if disk_top.endswith('/'):
2414
2121
            current_disk = disk_iterator.next()
2415
2122
            disk_finished = False
2416
2123
        except OSError, e:
2417
 
            if not (e.errno == errno.ENOENT or
2418
 
                (sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
 
2124
            if e.errno != errno.ENOENT:
2419
2125
                raise
2420
2126
            current_disk = None
2421
2127
            disk_finished = True
2426
2132
            current_inv = None
2427
2133
            inv_finished = True
2428
2134
        while not inv_finished or not disk_finished:
2429
 
            if current_disk:
2430
 
                ((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2431
 
                    cur_disk_dir_content) = current_disk
2432
 
            else:
2433
 
                ((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2434
 
                    cur_disk_dir_content) = ((None, None), None)
2435
2135
            if not disk_finished:
2436
2136
                # strip out .bzr dirs
2437
 
                if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2438
 
                    len(cur_disk_dir_content) > 0):
2439
 
                    # osutils.walkdirs can be made nicer -
 
2137
                if current_disk[0][1][top_strip_len:] == '':
 
2138
                    # osutils.walkdirs can be made nicer - 
2440
2139
                    # yield the path-from-prefix rather than the pathjoined
2441
2140
                    # value.
2442
 
                    bzrdir_loc = bisect_left(cur_disk_dir_content,
2443
 
                        ('.bzr', '.bzr'))
2444
 
                    if (bzrdir_loc < len(cur_disk_dir_content)
2445
 
                        and self.bzrdir.is_control_filename(
2446
 
                            cur_disk_dir_content[bzrdir_loc][0])):
 
2141
                    bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
 
2142
                    if current_disk[1][bzrdir_loc][0] == '.bzr':
2447
2143
                        # we dont yield the contents of, or, .bzr itself.
2448
 
                        del cur_disk_dir_content[bzrdir_loc]
 
2144
                        del current_disk[1][bzrdir_loc]
2449
2145
            if inv_finished:
2450
2146
                # everything is unknown
2451
2147
                direction = 1
2453
2149
                # everything is missing
2454
2150
                direction = -1
2455
2151
            else:
2456
 
                direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
 
2152
                direction = cmp(current_inv[0][0], current_disk[0][0])
2457
2153
            if direction > 0:
2458
2154
                # disk is before inventory - unknown
2459
2155
                dirblock = [(relpath, basename, kind, stat, None, None) for
2460
 
                    relpath, basename, kind, stat, top_path in
2461
 
                    cur_disk_dir_content]
2462
 
                yield (cur_disk_dir_relpath, None), dirblock
 
2156
                    relpath, basename, kind, stat, top_path in current_disk[1]]
 
2157
                yield (current_disk[0][0], None), dirblock
2463
2158
                try:
2464
2159
                    current_disk = disk_iterator.next()
2465
2160
                except StopIteration:
2467
2162
            elif direction < 0:
2468
2163
                # inventory is before disk - missing.
2469
2164
                dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2470
 
                    for relpath, basename, dkind, stat, fileid, kind in
 
2165
                    for relpath, basename, dkind, stat, fileid, kind in 
2471
2166
                    current_inv[1]]
2472
2167
                yield (current_inv[0][0], current_inv[0][1]), dirblock
2473
2168
                try:
2479
2174
                # merge the inventory and disk data together
2480
2175
                dirblock = []
2481
2176
                for relpath, subiterator in itertools.groupby(sorted(
2482
 
                    current_inv[1] + cur_disk_dir_content,
2483
 
                    key=operator.itemgetter(0)), operator.itemgetter(1)):
 
2177
                    current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2484
2178
                    path_elements = list(subiterator)
2485
2179
                    if len(path_elements) == 2:
2486
2180
                        inv_row, disk_row = path_elements
2512
2206
                    disk_finished = True
2513
2207
 
2514
2208
    def _walkdirs(self, prefix=""):
2515
 
        """Walk the directories of this tree.
2516
 
 
2517
 
           :prefix: is used as the directrory to start with.
2518
 
           returns a generator which yields items in the form:
2519
 
                ((curren_directory_path, fileid),
2520
 
                 [(file1_path, file1_name, file1_kind, None, file1_id,
2521
 
                   file1_kind), ... ])
2522
 
        """
2523
2209
        _directory = 'directory'
2524
2210
        # get the root in the inventory
2525
2211
        inv = self.inventory
2539
2225
                relroot = ""
2540
2226
            # FIXME: stash the node in pending
2541
2227
            entry = inv[top_id]
2542
 
            if entry.kind == 'directory':
2543
 
                for name, child in entry.sorted_children():
2544
 
                    dirblock.append((relroot + name, name, child.kind, None,
2545
 
                        child.file_id, child.kind
2546
 
                        ))
 
2228
            for name, child in entry.sorted_children():
 
2229
                dirblock.append((relroot + name, name, child.kind, None,
 
2230
                    child.file_id, child.kind
 
2231
                    ))
2547
2232
            yield (currentdir[0], entry.file_id), dirblock
2548
2233
            # push the user specified dirs from dirblock
2549
2234
            for dir in reversed(dirblock):
2582
2267
        self.set_conflicts(un_resolved)
2583
2268
        return un_resolved, resolved
2584
2269
 
2585
 
    @needs_read_lock
2586
 
    def _check(self, references):
2587
 
        """Check the tree for consistency.
2588
 
 
2589
 
        :param references: A dict with keys matching the items returned by
2590
 
            self._get_check_refs(), and values from looking those keys up in
2591
 
            the repository.
2592
 
        """
2593
 
        tree_basis = self.basis_tree()
2594
 
        tree_basis.lock_read()
2595
 
        try:
2596
 
            repo_basis = references[('trees', self.last_revision())]
2597
 
            if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2598
 
                raise errors.BzrCheckError(
2599
 
                    "Mismatched basis inventory content.")
2600
 
            self._validate()
2601
 
        finally:
2602
 
            tree_basis.unlock()
2603
 
 
2604
 
    def _validate(self):
2605
 
        """Validate internal structures.
2606
 
 
2607
 
        This is meant mostly for the test suite. To give it a chance to detect
2608
 
        corruption after actions have occurred. The default implementation is a
2609
 
        just a no-op.
2610
 
 
2611
 
        :return: None. An exception should be raised if there is an error.
2612
 
        """
2613
 
        return
2614
 
 
2615
 
    def _get_rules_searcher(self, default_searcher):
2616
 
        """See Tree._get_rules_searcher."""
2617
 
        if self._rules_searcher is None:
2618
 
            self._rules_searcher = super(WorkingTree,
2619
 
                self)._get_rules_searcher(default_searcher)
2620
 
        return self._rules_searcher
2621
 
 
2622
 
    def get_shelf_manager(self):
2623
 
        """Return the ShelfManager for this WorkingTree."""
2624
 
        from bzrlib.shelf import ShelfManager
2625
 
        return ShelfManager(self, self._transport)
2626
 
 
2627
2270
 
2628
2271
class WorkingTree2(WorkingTree):
2629
2272
    """This is the Format 2 working tree.
2630
2273
 
2631
 
    This was the first weave based working tree.
 
2274
    This was the first weave based working tree. 
2632
2275
     - uses os locks for locking.
2633
2276
     - uses the branch last-revision.
2634
2277
    """
2644
2287
        if self._inventory is None:
2645
2288
            self.read_working_inventory()
2646
2289
 
2647
 
    def _get_check_refs(self):
2648
 
        """Return the references needed to perform a check of this tree."""
2649
 
        return [('trees', self.last_revision())]
2650
 
 
2651
2290
    def lock_tree_write(self):
2652
2291
        """See WorkingTree.lock_tree_write().
2653
2292
 
2654
2293
        In Format2 WorkingTrees we have a single lock for the branch and tree
2655
2294
        so lock_tree_write() degrades to lock_write().
2656
 
 
2657
 
        :return: An object with an unlock method which will release the lock
2658
 
            obtained.
2659
2295
        """
2660
2296
        self.branch.lock_write()
2661
2297
        try:
2662
 
            self._control_files.lock_write()
2663
 
            return self
 
2298
            return self._control_files.lock_write()
2664
2299
        except:
2665
2300
            self.branch.unlock()
2666
2301
            raise
2667
2302
 
2668
2303
    def unlock(self):
2669
 
        # do non-implementation specific cleanup
2670
 
        self._cleanup()
2671
 
 
2672
2304
        # we share control files:
2673
2305
        if self._control_files._lock_count == 3:
2674
2306
            # _inventory_is_modified is always False during a read lock.
2675
2307
            if self._inventory_is_modified:
2676
2308
                self.flush()
2677
2309
            self._write_hashcache_if_dirty()
2678
 
 
 
2310
                    
2679
2311
        # reverse order of locking.
2680
2312
        try:
2681
2313
            return self._control_files.unlock()
2697
2329
    def _last_revision(self):
2698
2330
        """See Mutable.last_revision."""
2699
2331
        try:
2700
 
            return self._transport.get_bytes('last-revision')
 
2332
            return osutils.safe_revision_id(
 
2333
                        self._control_files.get('last-revision').read())
2701
2334
        except errors.NoSuchFile:
2702
 
            return _mod_revision.NULL_REVISION
 
2335
            return None
2703
2336
 
2704
2337
    def _change_last_revision(self, revision_id):
2705
2338
        """See WorkingTree._change_last_revision."""
2706
 
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
 
2339
        if revision_id is None or revision_id == NULL_REVISION:
2707
2340
            try:
2708
 
                self._transport.delete('last-revision')
 
2341
                self._control_files._transport.delete('last-revision')
2709
2342
            except errors.NoSuchFile:
2710
2343
                pass
2711
2344
            return False
2712
2345
        else:
2713
 
            self._transport.put_bytes('last-revision', revision_id,
2714
 
                mode=self.bzrdir._get_file_mode())
 
2346
            self._control_files.put_bytes('last-revision', revision_id)
2715
2347
            return True
2716
2348
 
2717
 
    def _get_check_refs(self):
2718
 
        """Return the references needed to perform a check of this tree."""
2719
 
        return [('trees', self.last_revision())]
2720
 
 
2721
2349
    @needs_tree_write_lock
2722
2350
    def set_conflicts(self, conflicts):
2723
 
        self._put_rio('conflicts', conflicts.to_stanzas(),
 
2351
        self._put_rio('conflicts', conflicts.to_stanzas(), 
2724
2352
                      CONFLICT_HEADER_1)
2725
2353
 
2726
2354
    @needs_tree_write_lock
2733
2361
    @needs_read_lock
2734
2362
    def conflicts(self):
2735
2363
        try:
2736
 
            confile = self._transport.get('conflicts')
 
2364
            confile = self._control_files.get('conflicts')
2737
2365
        except errors.NoSuchFile:
2738
2366
            return _mod_conflicts.ConflictList()
2739
2367
        try:
2740
 
            try:
2741
 
                if confile.next() != CONFLICT_HEADER_1 + '\n':
2742
 
                    raise errors.ConflictFormatError()
2743
 
            except StopIteration:
 
2368
            if confile.next() != CONFLICT_HEADER_1 + '\n':
2744
2369
                raise errors.ConflictFormatError()
2745
 
            return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2746
 
        finally:
2747
 
            confile.close()
 
2370
        except StopIteration:
 
2371
            raise errors.ConflictFormatError()
 
2372
        return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2748
2373
 
2749
2374
    def unlock(self):
2750
 
        # do non-implementation specific cleanup
2751
 
        self._cleanup()
2752
2375
        if self._control_files._lock_count == 1:
2753
2376
            # _inventory_is_modified is always False during a read lock.
2754
2377
            if self._inventory_is_modified:
2767
2390
            return path[:-len(suffix)]
2768
2391
 
2769
2392
 
 
2393
@deprecated_function(zero_eight)
 
2394
def is_control_file(filename):
 
2395
    """See WorkingTree.is_control_filename(filename)."""
 
2396
    ## FIXME: better check
 
2397
    filename = normpath(filename)
 
2398
    while filename != '':
 
2399
        head, tail = os.path.split(filename)
 
2400
        ## mutter('check %r for control file' % ((head, tail),))
 
2401
        if tail == '.bzr':
 
2402
            return True
 
2403
        if filename == head:
 
2404
            break
 
2405
        filename = head
 
2406
    return False
 
2407
 
 
2408
 
2770
2409
class WorkingTreeFormat(object):
2771
2410
    """An encapsulation of the initialization and open routines for a format.
2772
2411
 
2775
2414
     * a format string,
2776
2415
     * an open routine.
2777
2416
 
2778
 
    Formats are placed in an dict by their format string for reference
 
2417
    Formats are placed in an dict by their format string for reference 
2779
2418
    during workingtree opening. Its not required that these be instances, they
2780
 
    can be classes themselves with class methods - it simply depends on
 
2419
    can be classes themselves with class methods - it simply depends on 
2781
2420
    whether state is needed for a given format or not.
2782
2421
 
2783
2422
    Once a format is deprecated, just deprecate the initialize and open
2784
 
    methods on the format class. Do not deprecate the object, as the
 
2423
    methods on the format class. Do not deprecate the object, as the 
2785
2424
    object will be created every time regardless.
2786
2425
    """
2787
2426
 
2793
2432
 
2794
2433
    requires_rich_root = False
2795
2434
 
2796
 
    upgrade_recommended = False
2797
 
 
2798
2435
    @classmethod
2799
2436
    def find_format(klass, a_bzrdir):
2800
2437
        """Return the format for the working tree object in a_bzrdir."""
2801
2438
        try:
2802
2439
            transport = a_bzrdir.get_workingtree_transport(None)
2803
 
            format_string = transport.get_bytes("format")
 
2440
            format_string = transport.get("format").read()
2804
2441
            return klass._formats[format_string]
2805
2442
        except errors.NoSuchFile:
2806
2443
            raise errors.NoWorkingTree(base=transport.base)
2807
2444
        except KeyError:
2808
 
            raise errors.UnknownFormatError(format=format_string,
2809
 
                                            kind="working tree")
 
2445
            raise errors.UnknownFormatError(format=format_string)
2810
2446
 
2811
2447
    def __eq__(self, other):
2812
2448
        return self.__class__ is other.__class__
2831
2467
        """Is this format supported?
2832
2468
 
2833
2469
        Supported formats can be initialized and opened.
2834
 
        Unsupported formats may not support initialization or committing or
 
2470
        Unsupported formats may not support initialization or committing or 
2835
2471
        some other features depending on the reason for not being supported.
2836
2472
        """
2837
2473
        return True
2838
2474
 
2839
 
    def supports_content_filtering(self):
2840
 
        """True if this format supports content filtering."""
2841
 
        return False
2842
 
 
2843
 
    def supports_views(self):
2844
 
        """True if this format supports stored views."""
2845
 
        return False
2846
 
 
2847
2475
    @classmethod
2848
2476
    def register_format(klass, format):
2849
2477
        klass._formats[format.get_format_string()] = format
2854
2482
 
2855
2483
    @classmethod
2856
2484
    def unregister_format(klass, format):
 
2485
        assert klass._formats[format.get_format_string()] is format
2857
2486
        del klass._formats[format.get_format_string()]
2858
2487
 
2859
2488
 
 
2489
 
2860
2490
class WorkingTreeFormat2(WorkingTreeFormat):
2861
 
    """The second working tree format.
 
2491
    """The second working tree format. 
2862
2492
 
2863
2493
    This format modified the hash cache from the format 1 hash cache.
2864
2494
    """
2865
2495
 
2866
 
    upgrade_recommended = True
2867
 
 
2868
2496
    def get_format_description(self):
2869
2497
        """See WorkingTreeFormat.get_format_description()."""
2870
2498
        return "Working tree format 2"
2871
2499
 
2872
 
    def _stub_initialize_on_transport(self, transport, file_mode):
2873
 
        """Workaround: create control files for a remote working tree.
2874
 
 
 
2500
    def stub_initialize_remote(self, control_files):
 
2501
        """As a special workaround create critical control files for a remote working tree
 
2502
        
2875
2503
        This ensures that it can later be updated and dealt with locally,
2876
 
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
 
2504
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with 
2877
2505
        no working tree.  (See bug #43064).
2878
2506
        """
2879
2507
        sio = StringIO()
2880
 
        inv = inventory.Inventory()
2881
 
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
 
2508
        inv = Inventory()
 
2509
        xml5.serializer_v5.write_inventory(inv, sio)
2882
2510
        sio.seek(0)
2883
 
        transport.put_file('inventory', sio, file_mode)
2884
 
        transport.put_bytes('pending-merges', '', file_mode)
2885
 
 
2886
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2887
 
                   accelerator_tree=None, hardlink=False):
 
2511
        control_files.put('inventory', sio)
 
2512
 
 
2513
        control_files.put_bytes('pending-merges', '')
 
2514
        
 
2515
 
 
2516
    def initialize(self, a_bzrdir, revision_id=None):
2888
2517
        """See WorkingTreeFormat.initialize()."""
2889
2518
        if not isinstance(a_bzrdir.transport, LocalTransport):
2890
2519
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2891
 
        if from_branch is not None:
2892
 
            branch = from_branch
2893
 
        else:
2894
 
            branch = a_bzrdir.open_branch()
2895
 
        if revision_id is None:
2896
 
            revision_id = _mod_revision.ensure_null(branch.last_revision())
2897
 
        branch.lock_write()
2898
 
        try:
2899
 
            branch.generate_revision_history(revision_id)
2900
 
        finally:
2901
 
            branch.unlock()
2902
 
        inv = inventory.Inventory()
 
2520
        branch = a_bzrdir.open_branch()
 
2521
        if revision_id is not None:
 
2522
            revision_id = osutils.safe_revision_id(revision_id)
 
2523
            branch.lock_write()
 
2524
            try:
 
2525
                revision_history = branch.revision_history()
 
2526
                try:
 
2527
                    position = revision_history.index(revision_id)
 
2528
                except ValueError:
 
2529
                    raise errors.NoSuchRevision(branch, revision_id)
 
2530
                branch.set_revision_history(revision_history[:position + 1])
 
2531
            finally:
 
2532
                branch.unlock()
 
2533
        revision = branch.last_revision()
 
2534
        inv = Inventory()
2903
2535
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2904
2536
                         branch,
2905
2537
                         inv,
2906
2538
                         _internal=True,
2907
2539
                         _format=self,
2908
2540
                         _bzrdir=a_bzrdir)
2909
 
        basis_tree = branch.repository.revision_tree(revision_id)
 
2541
        basis_tree = branch.repository.revision_tree(revision)
2910
2542
        if basis_tree.inventory.root is not None:
2911
 
            wt.set_root_id(basis_tree.get_root_id())
 
2543
            wt.set_root_id(basis_tree.inventory.root.file_id)
2912
2544
        # set the parent list and cache the basis tree.
2913
 
        if _mod_revision.is_null(revision_id):
2914
 
            parent_trees = []
2915
 
        else:
2916
 
            parent_trees = [(revision_id, basis_tree)]
2917
 
        wt.set_parent_trees(parent_trees)
 
2545
        wt.set_parent_trees([(revision, basis_tree)])
2918
2546
        transform.build_tree(basis_tree, wt)
2919
2547
        return wt
2920
2548
 
2933
2561
            raise NotImplementedError
2934
2562
        if not isinstance(a_bzrdir.transport, LocalTransport):
2935
2563
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2936
 
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
 
2564
        return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2937
2565
                           _internal=True,
2938
2566
                           _format=self,
2939
2567
                           _bzrdir=a_bzrdir)
2940
 
        return wt
 
2568
 
2941
2569
 
2942
2570
class WorkingTreeFormat3(WorkingTreeFormat):
2943
2571
    """The second working tree format updated to record a format marker.
2951
2579
        - uses a LockDir to guard access for writes.
2952
2580
    """
2953
2581
 
2954
 
    upgrade_recommended = True
2955
 
 
2956
2582
    def get_format_string(self):
2957
2583
        """See WorkingTreeFormat.get_format_string()."""
2958
2584
        return "Bazaar-NG Working Tree format 3"
2973
2599
 
2974
2600
    def _open_control_files(self, a_bzrdir):
2975
2601
        transport = a_bzrdir.get_workingtree_transport(None)
2976
 
        return LockableFiles(transport, self._lock_file_name,
 
2602
        return LockableFiles(transport, self._lock_file_name, 
2977
2603
                             self._lock_class)
2978
2604
 
2979
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2980
 
                   accelerator_tree=None, hardlink=False):
 
2605
    def initialize(self, a_bzrdir, revision_id=None):
2981
2606
        """See WorkingTreeFormat.initialize().
2982
 
 
2983
 
        :param revision_id: if supplied, create a working tree at a different
2984
 
            revision than the branch is at.
2985
 
        :param accelerator_tree: A tree which can be used for retrieving file
2986
 
            contents more quickly than the revision tree, i.e. a workingtree.
2987
 
            The revision tree will be used for cases where accelerator_tree's
2988
 
            content is different.
2989
 
        :param hardlink: If true, hard-link files from accelerator_tree,
2990
 
            where possible.
 
2607
        
 
2608
        revision_id allows creating a working tree at a different
 
2609
        revision than the branch is at.
2991
2610
        """
2992
2611
        if not isinstance(a_bzrdir.transport, LocalTransport):
2993
2612
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2995
2614
        control_files = self._open_control_files(a_bzrdir)
2996
2615
        control_files.create_lock()
2997
2616
        control_files.lock_write()
2998
 
        transport.put_bytes('format', self.get_format_string(),
2999
 
            mode=a_bzrdir._get_file_mode())
3000
 
        if from_branch is not None:
3001
 
            branch = from_branch
 
2617
        control_files.put_utf8('format', self.get_format_string())
 
2618
        branch = a_bzrdir.open_branch()
 
2619
        if revision_id is None:
 
2620
            revision_id = branch.last_revision()
3002
2621
        else:
3003
 
            branch = a_bzrdir.open_branch()
3004
 
        if revision_id is None:
3005
 
            revision_id = _mod_revision.ensure_null(branch.last_revision())
 
2622
            revision_id = osutils.safe_revision_id(revision_id)
3006
2623
        # WorkingTree3 can handle an inventory which has a unique root id.
3007
2624
        # as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
3008
2625
        # those trees. And because there isn't a format bump inbetween, we
3021
2638
            basis_tree = branch.repository.revision_tree(revision_id)
3022
2639
            # only set an explicit root id if there is one to set.
3023
2640
            if basis_tree.inventory.root is not None:
3024
 
                wt.set_root_id(basis_tree.get_root_id())
3025
 
            if revision_id == _mod_revision.NULL_REVISION:
 
2641
                wt.set_root_id(basis_tree.inventory.root.file_id)
 
2642
            if revision_id == NULL_REVISION:
3026
2643
                wt.set_parent_trees([])
3027
2644
            else:
3028
2645
                wt.set_parent_trees([(revision_id, basis_tree)])
3035
2652
        return wt
3036
2653
 
3037
2654
    def _initial_inventory(self):
3038
 
        return inventory.Inventory()
 
2655
        return Inventory()
3039
2656
 
3040
2657
    def __init__(self):
3041
2658
        super(WorkingTreeFormat3, self).__init__()
3051
2668
            raise NotImplementedError
3052
2669
        if not isinstance(a_bzrdir.transport, LocalTransport):
3053
2670
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
3054
 
        wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3055
 
        return wt
 
2671
        return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3056
2672
 
3057
2673
    def _open(self, a_bzrdir, control_files):
3058
2674
        """Open the tree itself.
3059
 
 
 
2675
        
3060
2676
        :param a_bzrdir: the dir for the tree.
3061
2677
        :param control_files: the control files for the tree.
3062
2678
        """
3070
2686
        return self.get_format_string()
3071
2687
 
3072
2688
 
3073
 
__default_format = WorkingTreeFormat6()
 
2689
__default_format = WorkingTreeFormat4()
3074
2690
WorkingTreeFormat.register_format(__default_format)
3075
 
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3076
 
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3077
2691
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3078
2692
WorkingTreeFormat.set_default_format(__default_format)
3079
2693
# formats which have no format string are not discoverable
3080
2694
# and not independently creatable, so are not registered.
3081
2695
_legacy_formats = [WorkingTreeFormat2(),
3082
2696
                   ]
 
2697
 
 
2698
 
 
2699
class WorkingTreeTestProviderAdapter(object):
 
2700
    """A tool to generate a suite testing multiple workingtree formats at once.
 
2701
 
 
2702
    This is done by copying the test once for each transport and injecting
 
2703
    the transport_server, transport_readonly_server, and workingtree_format
 
2704
    classes into each copy. Each copy is also given a new id() to make it
 
2705
    easy to identify.
 
2706
    """
 
2707
 
 
2708
    def __init__(self, transport_server, transport_readonly_server, formats):
 
2709
        self._transport_server = transport_server
 
2710
        self._transport_readonly_server = transport_readonly_server
 
2711
        self._formats = formats
 
2712
    
 
2713
    def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
 
2714
        """Clone test for adaption."""
 
2715
        new_test = deepcopy(test)
 
2716
        new_test.transport_server = self._transport_server
 
2717
        new_test.transport_readonly_server = self._transport_readonly_server
 
2718
        new_test.bzrdir_format = bzrdir_format
 
2719
        new_test.workingtree_format = workingtree_format
 
2720
        def make_new_test_id():
 
2721
            new_id = "%s(%s)" % (test.id(), variation)
 
2722
            return lambda: new_id
 
2723
        new_test.id = make_new_test_id()
 
2724
        return new_test
 
2725
    
 
2726
    def adapt(self, test):
 
2727
        from bzrlib.tests import TestSuite
 
2728
        result = TestSuite()
 
2729
        for workingtree_format, bzrdir_format in self._formats:
 
2730
            new_test = self._clone_test(
 
2731
                test,
 
2732
                bzrdir_format,
 
2733
                workingtree_format, workingtree_format.__class__.__name__)
 
2734
            result.addTest(new_test)
 
2735
        return result