/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Ian Clatworthy
  • Date: 2007-08-10 05:17:09 UTC
  • mto: (2733.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 2734.
  • Revision ID: ian.clatworthy@internode.on.net-20070810051709-0rnxlur94samh192
move most existing topics into the User Guide dir for English

Show diffs side-by-side

added added

removed removed

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