/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: Robert Collins
  • Date: 2007-10-04 05:30:08 UTC
  • mfrom: (2881.1.1 knits)
  • mto: This revision was merged to the branch mainline in revision 2885.
  • Revision ID: robertc@robertcollins.net-20071004053008-aquje8fyntc8q69h
Fix knit test fallout from final readv api change.

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."""
 
454
    def get_file(self, file_id, path=None):
456
455
        if path is None:
 
456
            file_id = osutils.safe_file_id(file_id)
457
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()
 
458
        return self.get_file_byname(path)
 
459
 
 
460
    def get_file_text(self, file_id):
 
461
        file_id = osutils.safe_file_id(file_id)
 
462
        return self.get_file(file_id).read()
 
463
 
 
464
    def get_file_byname(self, filename):
 
465
        return file(self.abspath(filename), 'rb')
484
466
 
485
467
    @needs_read_lock
486
468
    def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
493
475
        incorrectly attributed to CURRENT_REVISION (but after committing, the
494
476
        attribution will be correct).
495
477
        """
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
 
478
        file_id = osutils.safe_file_id(file_id)
 
479
        basis = self.basis_tree()
 
480
        basis.lock_read()
 
481
        try:
 
482
            changes = self._iter_changes(basis, True, [self.id2path(file_id)],
 
483
                require_versioned=True).next()
 
484
            changed_content, kind = changes[2], changes[6]
 
485
            if not changed_content:
 
486
                return basis.annotate_iter(file_id)
 
487
            if kind[1] is None:
 
488
                return None
 
489
            import annotate
 
490
            if kind[0] != 'file':
 
491
                old_lines = []
 
492
            else:
 
493
                old_lines = list(basis.annotate_iter(file_id))
 
494
            old = [old_lines]
 
495
            for tree in self.branch.repository.revision_trees(
 
496
                self.get_parent_ids()[1:]):
 
497
                if file_id not in tree:
 
498
                    continue
 
499
                old.append(list(tree.annotate_iter(file_id)))
 
500
            return annotate.reannotate(old, self.get_file(file_id).readlines(),
 
501
                                       default_revision)
 
502
        finally:
 
503
            basis.unlock()
532
504
 
533
505
    def _get_ancestors(self, default_revision):
534
506
        ancestors = set([default_revision])
539
511
 
540
512
    def get_parent_ids(self):
541
513
        """See Tree.get_parent_ids.
542
 
 
 
514
        
543
515
        This implementation reads the pending merges list and last_revision
544
516
        value and uses that to decide what the parents list should be.
545
517
        """
549
521
        else:
550
522
            parents = [last_rev]
551
523
        try:
552
 
            merges_bytes = self._transport.get_bytes('pending-merges')
 
524
            merges_file = self._control_files.get('pending-merges')
553
525
        except errors.NoSuchFile:
554
526
            pass
555
527
        else:
556
 
            for l in osutils.split_lines(merges_bytes):
557
 
                revision_id = l.rstrip('\n')
 
528
            for l in merges_file.readlines():
 
529
                revision_id = osutils.safe_revision_id(l.rstrip('\n'))
558
530
                parents.append(revision_id)
559
531
        return parents
560
532
 
562
534
    def get_root_id(self):
563
535
        """Return the id of this trees root"""
564
536
        return self._inventory.root.file_id
565
 
 
 
537
        
566
538
    def _get_store_filename(self, file_id):
567
539
        ## XXX: badly named; this is not in the store at all
 
540
        file_id = osutils.safe_file_id(file_id)
568
541
        return self.abspath(self.id2path(file_id))
569
542
 
570
543
    @needs_read_lock
571
544
    def clone(self, to_bzrdir, revision_id=None):
572
545
        """Duplicate this working tree into to_bzr, including all state.
573
 
 
 
546
        
574
547
        Specifically modified files are kept as modified, but
575
548
        ignored and unknown files are discarded.
576
549
 
577
550
        If you want to make a new line of development, see bzrdir.sprout()
578
551
 
579
552
        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
 
553
            If not None, the cloned tree will have its last revision set to 
 
554
            revision, and and difference between the source trees last revision
582
555
            and this one merged in.
583
556
        """
584
557
        # assumes the target bzr dir format is compatible.
585
 
        result = to_bzrdir.create_workingtree()
 
558
        result = self._format.initialize(to_bzrdir)
586
559
        self.copy_content_into(result, revision_id)
587
560
        return result
588
561
 
599
572
            tree.set_parent_ids([revision_id])
600
573
 
601
574
    def id2abspath(self, file_id):
 
575
        file_id = osutils.safe_file_id(file_id)
602
576
        return self.abspath(self.id2path(file_id))
603
577
 
604
578
    def has_id(self, file_id):
605
579
        # files that have been deleted are excluded
 
580
        file_id = osutils.safe_file_id(file_id)
606
581
        inv = self.inventory
607
582
        if not inv.has_id(file_id):
608
583
            return False
610
585
        return osutils.lexists(self.abspath(path))
611
586
 
612
587
    def has_or_had_id(self, file_id):
 
588
        file_id = osutils.safe_file_id(file_id)
613
589
        if file_id == self.inventory.root.file_id:
614
590
            return True
615
591
        return self.inventory.has_id(file_id)
617
593
    __contains__ = has_id
618
594
 
619
595
    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
 
596
        file_id = osutils.safe_file_id(file_id)
 
597
        return os.path.getsize(self.id2abspath(file_id))
630
598
 
631
599
    @needs_read_lock
632
600
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
601
        file_id = osutils.safe_file_id(file_id)
633
602
        if not path:
634
603
            path = self._inventory.id2path(file_id)
635
604
        return self._hashcache.get_sha1(path, stat_value)
636
605
 
637
606
    def get_file_mtime(self, file_id, path=None):
 
607
        file_id = osutils.safe_file_id(file_id)
638
608
        if not path:
639
609
            path = self.inventory.id2path(file_id)
640
610
        return os.lstat(self.abspath(path)).st_mtime
641
611
 
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
612
    if not supports_executable():
655
613
        def is_executable(self, file_id, path=None):
 
614
            file_id = osutils.safe_file_id(file_id)
656
615
            return self._inventory[file_id].executable
657
 
 
658
 
        _is_executable_from_path_and_stat = \
659
 
            _is_executable_from_path_and_stat_from_basis
660
616
    else:
661
617
        def is_executable(self, file_id, path=None):
662
618
            if not path:
 
619
                file_id = osutils.safe_file_id(file_id)
663
620
                path = self.id2path(file_id)
664
621
            mode = os.lstat(self.abspath(path)).st_mode
665
622
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
666
623
 
667
 
        _is_executable_from_path_and_stat = \
668
 
            _is_executable_from_path_and_stat_from_stat
669
 
 
670
624
    @needs_tree_write_lock
671
625
    def _add(self, files, ids, kinds):
672
626
        """See MutableTree._add."""
673
627
        # TODO: Re-adding a file that is removed in the working copy
674
628
        # should probably put it back with the previous ID.
675
 
        # the read and write working inventory should not occur in this
 
629
        # the read and write working inventory should not occur in this 
676
630
        # function - they should be part of lock_write and unlock.
677
631
        inv = self.inventory
678
632
        for f, file_id, kind in zip(files, ids, kinds):
 
633
            assert kind is not None
679
634
            if file_id is None:
680
635
                inv.add_path(f, kind=kind)
681
636
            else:
 
637
                file_id = osutils.safe_file_id(file_id)
682
638
                inv.add_path(f, kind=kind, file_id=file_id)
683
639
            self._inventory_is_modified = True
684
640
 
746
702
        if updated:
747
703
            self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
748
704
 
749
 
    def path_content_summary(self, path, _lstat=os.lstat,
 
705
    def path_content_summary(self, path, _lstat=osutils.lstat,
750
706
        _mapper=osutils.file_kind_from_stat_mode):
751
707
        """See Tree.path_content_summary."""
752
708
        abspath = self.abspath(path)
760
716
            raise
761
717
        kind = _mapper(stat_result.st_mode)
762
718
        if kind == 'file':
763
 
            return self._file_content_summary(path, stat_result)
 
719
            size = stat_result.st_size
 
720
            # try for a stat cache lookup
 
721
            if not supports_executable():
 
722
                executable = None # caller can decide policy.
 
723
            else:
 
724
                mode = stat_result.st_mode
 
725
                executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
 
726
            return (kind, size, executable, self._sha_from_stat(
 
727
                path, stat_result))
764
728
        elif kind == 'directory':
765
729
            # perhaps it looks like a plain directory, but it's really a
766
730
            # reference.
768
732
                kind = 'tree-reference'
769
733
            return kind, None, None, None
770
734
        elif kind == 'symlink':
771
 
            target = osutils.readlink(abspath)
772
 
            return ('symlink', None, None, target)
 
735
            return ('symlink', None, None, os.readlink(abspath))
773
736
        else:
774
737
            return (kind, None, None, None)
775
738
 
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))
 
739
    @deprecated_method(zero_eleven)
 
740
    @needs_read_lock
 
741
    def pending_merges(self):
 
742
        """Return a list of pending merges.
 
743
 
 
744
        These are revisions that have been merged into the working
 
745
        directory but not yet committed.
 
746
 
 
747
        As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
 
748
        instead - which is available on all tree objects.
 
749
        """
 
750
        return self.get_parent_ids()[1:]
782
751
 
783
752
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
784
753
        """Common ghost checking functionality from set_parent_*.
794
763
 
795
764
    def _set_merges_from_parent_ids(self, parent_ids):
796
765
        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
 
766
        self._control_files.put_bytes('pending-merges', '\n'.join(merges))
818
767
 
819
768
    @needs_tree_write_lock
820
769
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
821
770
        """Set the parent ids to revision_ids.
822
 
 
 
771
        
823
772
        See also set_parent_trees. This api will try to retrieve the tree data
824
773
        for each element of revision_ids from the trees repository. If you have
825
774
        tree data already available, it is more efficient to use
829
778
        :param revision_ids: The revision_ids to set as the parent ids of this
830
779
            working tree. Any of these may be ghosts.
831
780
        """
 
781
        revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
832
782
        self._check_parents_for_ghosts(revision_ids,
833
783
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
834
784
        for revision_id in revision_ids:
835
785
            _mod_revision.check_not_reserved_id(revision_id)
836
786
 
837
 
        revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
838
 
 
839
787
        if len(revision_ids) > 0:
840
788
            self.set_last_revision(revision_ids[0])
841
789
        else:
846
794
    @needs_tree_write_lock
847
795
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
848
796
        """See MutableTree.set_parent_trees."""
849
 
        parent_ids = [rev for (rev, tree) in parents_list]
 
797
        parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
850
798
        for revision_id in parent_ids:
851
799
            _mod_revision.check_not_reserved_id(revision_id)
852
800
 
853
801
        self._check_parents_for_ghosts(parent_ids,
854
802
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
855
803
 
856
 
        parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
857
 
 
858
804
        if len(parent_ids) == 0:
859
805
            leftmost_parent_id = _mod_revision.NULL_REVISION
860
806
            leftmost_parent_tree = None
900
846
    def _put_rio(self, filename, stanzas, header):
901
847
        self._must_be_locked()
902
848
        my_file = rio_file(stanzas, header)
903
 
        self._transport.put_file(filename, my_file,
904
 
            mode=self.bzrdir._get_file_mode())
 
849
        self._control_files.put(filename, my_file)
905
850
 
906
851
    @needs_write_lock # because merge pulls data into the branch.
907
852
    def merge_from_branch(self, branch, to_revision=None, from_revision=None,
908
 
                          merge_type=None, force=False):
 
853
        merge_type=None):
909
854
        """Merge from a branch into this working tree.
910
855
 
911
856
        :param branch: The branch to merge from.
915
860
            branch.last_revision().
916
861
        """
917
862
        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()
 
863
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
864
        try:
 
865
            merger = Merger(self.branch, this_tree=self, pb=pb)
 
866
            merger.pp = ProgressPhase("Merge phase", 5, pb)
 
867
            merger.pp.next_phase()
 
868
            # check that there are no
 
869
            # local alterations
 
870
            merger.check_basis(check_clean=True, require_commits=False)
 
871
            if to_revision is None:
 
872
                to_revision = _mod_revision.ensure_null(branch.last_revision())
 
873
            else:
 
874
                to_revision = osutils.safe_revision_id(to_revision)
 
875
            merger.other_rev_id = to_revision
 
876
            if _mod_revision.is_null(merger.other_rev_id):
 
877
                raise errors.NoCommits(branch)
 
878
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
879
            merger.other_basis = merger.other_rev_id
 
880
            merger.other_tree = self.branch.repository.revision_tree(
 
881
                merger.other_rev_id)
 
882
            merger.other_branch = branch
 
883
            merger.pp.next_phase()
 
884
            if from_revision is None:
 
885
                merger.find_base()
 
886
            else:
 
887
                merger.set_base_revision(from_revision, branch)
 
888
            if merger.base_rev_id == merger.other_rev_id:
 
889
                raise errors.PointlessMerge
 
890
            merger.backup_files = False
 
891
            if merge_type is None:
 
892
                merger.merge_type = Merge3Merger
 
893
            else:
 
894
                merger.merge_type = merge_type
 
895
            merger.set_interesting_files(None)
 
896
            merger.show_base = False
 
897
            merger.reprocess = False
 
898
            conflicts = merger.do_merge()
 
899
            merger.set_pending()
 
900
        finally:
 
901
            pb.finished()
948
902
        return conflicts
949
903
 
950
904
    @needs_read_lock
951
905
    def merge_modified(self):
952
906
        """Return a dictionary of files modified by a merge.
953
907
 
954
 
        The list is initialized by WorkingTree.set_merge_modified, which is
 
908
        The list is initialized by WorkingTree.set_merge_modified, which is 
955
909
        typically called after we make some automatic updates to the tree
956
910
        because of a merge.
957
911
 
959
913
        still in the working inventory and have that text hash.
960
914
        """
961
915
        try:
962
 
            hashfile = self._transport.get('merge-hashes')
 
916
            hashfile = self._control_files.get('merge-hashes')
963
917
        except errors.NoSuchFile:
964
918
            return {}
 
919
        merge_hashes = {}
965
920
        try:
966
 
            merge_hashes = {}
967
 
            try:
968
 
                if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
969
 
                    raise errors.MergeModifiedFormatError()
970
 
            except StopIteration:
 
921
            if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
971
922
                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()
 
923
        except StopIteration:
 
924
            raise errors.MergeModifiedFormatError()
 
925
        for s in RioReader(hashfile):
 
926
            # RioReader reads in Unicode, so convert file_ids back to utf8
 
927
            file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
 
928
            if file_id not in self.inventory:
 
929
                continue
 
930
            text_hash = s.get("hash")
 
931
            if text_hash == self.get_file_sha1(file_id):
 
932
                merge_hashes[file_id] = text_hash
 
933
        return merge_hashes
983
934
 
984
935
    @needs_write_lock
985
936
    def mkdir(self, path, file_id=None):
991
942
        return file_id
992
943
 
993
944
    def get_symlink_target(self, file_id):
994
 
        abspath = self.id2abspath(file_id)
995
 
        target = osutils.readlink(abspath)
996
 
        return target
 
945
        file_id = osutils.safe_file_id(file_id)
 
946
        return os.readlink(self.id2abspath(file_id))
997
947
 
998
948
    @needs_write_lock
999
949
    def subsume(self, other_tree):
1037
987
            other_tree.unlock()
1038
988
        other_tree.bzrdir.retire_bzrdir()
1039
989
 
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
 
990
    def _directory_is_tree_reference(self, relpath):
 
991
        # as a special case, if a directory contains control files then 
1053
992
        # it's a tree reference, except that the root of the tree is not
1054
993
        return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
1055
994
        # TODO: We could ask all the control formats whether they
1066
1005
    @needs_tree_write_lock
1067
1006
    def extract(self, file_id, format=None):
1068
1007
        """Extract a subtree from this tree.
1069
 
 
 
1008
        
1070
1009
        A new branch will be created, relative to the path for this tree.
1071
1010
        """
1072
1011
        self.flush()
1077
1016
                transport = transport.clone(name)
1078
1017
                transport.ensure_base()
1079
1018
            return transport
1080
 
 
 
1019
            
1081
1020
        sub_path = self.id2path(file_id)
1082
1021
        branch_transport = mkdirs(sub_path)
1083
1022
        if format is None:
1084
 
            format = self.bzrdir.cloning_metadir()
 
1023
            format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
1085
1024
        branch_transport.ensure_base()
1086
1025
        branch_bzrdir = format.initialize_on_transport(branch_transport)
1087
1026
        try:
1088
1027
            repo = branch_bzrdir.find_repository()
1089
1028
        except errors.NoRepositoryPresent:
1090
1029
            repo = branch_bzrdir.create_repository()
1091
 
        if not repo.supports_rich_root():
1092
 
            raise errors.RootNotRich()
 
1030
            assert repo.supports_rich_root()
 
1031
        else:
 
1032
            if not repo.supports_rich_root():
 
1033
                raise errors.RootNotRich()
1093
1034
        new_branch = branch_bzrdir.create_branch()
1094
1035
        new_branch.pull(self.branch)
1095
1036
        for parent_id in self.get_parent_ids():
1097
1038
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
1098
1039
        if tree_transport.base != branch_transport.base:
1099
1040
            tree_bzrdir = format.initialize_on_transport(tree_transport)
1100
 
            branch.BranchReferenceFormat().initialize(tree_bzrdir,
1101
 
                target_branch=new_branch)
 
1041
            branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1102
1042
        else:
1103
1043
            tree_bzrdir = branch_bzrdir
1104
 
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
 
1044
        wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1105
1045
        wt.set_parent_ids(self.get_parent_ids())
1106
1046
        my_inv = self.inventory
1107
 
        child_inv = inventory.Inventory(root_id=None)
 
1047
        child_inv = Inventory(root_id=None)
1108
1048
        new_root = my_inv[file_id]
1109
1049
        my_inv.remove_recursive_id(file_id)
1110
1050
        new_root.parent_id = None
1128
1068
        sio = StringIO()
1129
1069
        self._serialize(self._inventory, sio)
1130
1070
        sio.seek(0)
1131
 
        self._transport.put_file('inventory', sio,
1132
 
            mode=self.bzrdir._get_file_mode())
 
1071
        self._control_files.put('inventory', sio)
1133
1072
        self._inventory_is_modified = False
1134
1073
 
1135
1074
    def _kind(self, relpath):
1136
1075
        return osutils.file_kind(self.abspath(relpath))
1137
1076
 
1138
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
1139
 
        """List all files as (path, class, kind, id, entry).
 
1077
    def list_files(self, include_root=False):
 
1078
        """Recursively list all files as (path, class, kind, id, entry).
1140
1079
 
1141
1080
        Lists, but does not descend into unversioned directories.
 
1081
 
1142
1082
        This does not include files that have been deleted in this
1143
 
        tree. Skips the control directory.
 
1083
        tree.
1144
1084
 
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
 
1085
        Skips the control directory.
1148
1086
        """
1149
1087
        # list_files is an iterator, so @needs_read_lock doesn't work properly
1150
1088
        # with it. So callers should be careful to always read_lock the tree.
1152
1090
            raise errors.ObjectNotLocked(self)
1153
1091
 
1154
1092
        inv = self.inventory
1155
 
        if from_dir is None and include_root is True:
 
1093
        if include_root is True:
1156
1094
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1157
1095
        # Convert these into local objects to save lookup times
1158
1096
        pathjoin = osutils.pathjoin
1165
1103
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1166
1104
 
1167
1105
        # 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)
 
1106
        children = os.listdir(self.basedir)
1178
1107
        children.sort()
1179
 
        # jam 20060527 The kernel sized tree seems equivalent whether we
 
1108
        # jam 20060527 The kernel sized tree seems equivalent whether we 
1180
1109
        # use a deque and popleft to keep them sorted, or if we use a plain
1181
1110
        # list and just reverse() them.
1182
1111
        children = collections.deque(children)
1183
 
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
 
1112
        stack = [(inv.root.file_id, u'', self.basedir, children)]
1184
1113
        while stack:
1185
1114
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1186
1115
 
1202
1131
 
1203
1132
                # absolute path
1204
1133
                fap = from_dir_abspath + '/' + f
1205
 
 
 
1134
                
1206
1135
                f_ie = inv.get_child(from_dir_id, f)
1207
1136
                if f_ie:
1208
1137
                    c = 'V'
1240
1169
                    except KeyError:
1241
1170
                        yield fp[1:], c, fk, None, TreeEntry()
1242
1171
                    continue
1243
 
 
 
1172
                
1244
1173
                if fk != 'directory':
1245
1174
                    continue
1246
1175
 
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
 
1176
                # But do this child first
 
1177
                new_children = os.listdir(fap)
 
1178
                new_children.sort()
 
1179
                new_children = collections.deque(new_children)
 
1180
                stack.append((f_ie.file_id, fp, fap, new_children))
 
1181
                # Break out of inner loop,
 
1182
                # so that we start outer loop with child
 
1183
                break
1256
1184
            else:
1257
1185
                # if we finished all children, pop it off the stack
1258
1186
                stack.pop()
1264
1192
        to_dir must exist in the inventory.
1265
1193
 
1266
1194
        If to_dir exists and is a directory, the files are moved into
1267
 
        it, keeping their old names.
 
1195
        it, keeping their old names.  
1268
1196
 
1269
1197
        Note that to_dir is only the last component of the new name;
1270
1198
        this doesn't change the directory.
1307
1235
                                       DeprecationWarning)
1308
1236
 
1309
1237
        # check destination directory
1310
 
        if isinstance(from_paths, basestring):
1311
 
            raise ValueError()
 
1238
        assert not isinstance(from_paths, basestring)
1312
1239
        inv = self.inventory
1313
1240
        to_abs = self.abspath(to_dir)
1314
1241
        if not isdir(to_abs):
1398
1325
                only_change_inv = True
1399
1326
            elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1400
1327
                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
1328
            else:
1406
1329
                # something is wrong, so lets determine what exactly
1407
1330
                if not self.has_filename(from_rel) and \
1410
1333
                        errors.PathsDoNotExist(paths=(str(from_rel),
1411
1334
                        str(to_rel))))
1412
1335
                else:
1413
 
                    raise errors.RenameFailedFilesExist(from_rel, to_rel)
 
1336
                    raise errors.RenameFailedFilesExist(from_rel, to_rel,
 
1337
                        extra="(Use --after to update the Bazaar id)")
1414
1338
            rename_entry.only_change_inv = only_change_inv
1415
1339
        return rename_entries
1416
1340
 
1436
1360
        inv = self.inventory
1437
1361
        for entry in moved:
1438
1362
            try:
1439
 
                self._move_entry(WorkingTree._RenameEntry(
1440
 
                    entry.to_rel, entry.from_id,
 
1363
                self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1441
1364
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
1442
1365
                    entry.from_tail, entry.from_parent_id,
1443
1366
                    entry.only_change_inv))
1494
1417
        from_tail = splitpath(from_rel)[-1]
1495
1418
        from_id = inv.path2id(from_rel)
1496
1419
        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]
 
1420
            raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1421
                errors.NotVersionedError(path=str(from_rel)))
 
1422
        from_entry = inv[from_id]
1508
1423
        from_parent_id = from_entry.parent_id
1509
1424
        to_dir, to_tail = os.path.split(to_rel)
1510
1425
        to_dir_id = inv.path2id(to_dir)
1556
1471
        These are files in the working directory that are not versioned or
1557
1472
        control files or ignored.
1558
1473
        """
1559
 
        # force the extras method to be fully executed before returning, to
 
1474
        # force the extras method to be fully executed before returning, to 
1560
1475
        # prevent race conditions with the lock
1561
1476
        return iter(
1562
1477
            [subp for subp in self.extras() if not self.is_ignored(subp)])
1572
1487
        :raises: NoSuchId if any fileid is not currently versioned.
1573
1488
        """
1574
1489
        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:
 
1490
            file_id = osutils.safe_file_id(file_id)
1578
1491
            if self._inventory.has_id(file_id):
1579
1492
                self._inventory.remove_recursive_id(file_id)
 
1493
            else:
 
1494
                raise errors.NoSuchId(self, file_id)
1580
1495
        if len(file_ids):
1581
 
            # in the future this should just set a dirty bit to wait for the
 
1496
            # in the future this should just set a dirty bit to wait for the 
1582
1497
            # final unlock. However, until all methods of workingtree start
1583
 
            # with the current in -memory inventory rather than triggering
 
1498
            # with the current in -memory inventory rather than triggering 
1584
1499
            # a read, it is more complex - we need to teach read_inventory
1585
1500
            # to know when to read, and when to not read first... and possibly
1586
1501
            # to save first when the in memory one may be corrupted.
1587
1502
            # so for now, we just only write it if it is indeed dirty.
1588
1503
            # - RBC 20060907
1589
1504
            self._write_inventory(self._inventory)
 
1505
    
 
1506
    @deprecated_method(zero_eight)
 
1507
    def iter_conflicts(self):
 
1508
        """List all files in the tree that have text or content conflicts.
 
1509
        DEPRECATED.  Use conflicts instead."""
 
1510
        return self._iter_conflicts()
1590
1511
 
1591
1512
    def _iter_conflicts(self):
1592
1513
        conflicted = set()
1601
1522
 
1602
1523
    @needs_write_lock
1603
1524
    def pull(self, source, overwrite=False, stop_revision=None,
1604
 
             change_reporter=None, possible_transports=None, local=False):
 
1525
             change_reporter=None):
 
1526
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1605
1527
        source.lock_read()
1606
1528
        try:
 
1529
            pp = ProgressPhase("Pull phase", 2, top_pb)
 
1530
            pp.next_phase()
1607
1531
            old_revision_info = self.branch.last_revision_info()
1608
1532
            basis_tree = self.basis_tree()
1609
 
            count = self.branch.pull(source, overwrite, stop_revision,
1610
 
                                     possible_transports=possible_transports,
1611
 
                                     local=local)
 
1533
            count = self.branch.pull(source, overwrite, stop_revision)
1612
1534
            new_revision_info = self.branch.last_revision_info()
1613
1535
            if new_revision_info != old_revision_info:
 
1536
                pp.next_phase()
1614
1537
                repository = self.branch.repository
 
1538
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
1615
1539
                basis_tree.lock_read()
1616
1540
                try:
1617
1541
                    new_basis_tree = self.branch.basis_tree()
1620
1544
                                new_basis_tree,
1621
1545
                                basis_tree,
1622
1546
                                this_tree=self,
1623
 
                                pb=None,
 
1547
                                pb=pb,
1624
1548
                                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)
 
1549
                    if (basis_tree.inventory.root is None and
 
1550
                        new_basis_tree.inventory.root is not None):
 
1551
                        self.set_root_id(new_basis_tree.inventory.root.file_id)
1629
1552
                finally:
 
1553
                    pb.finished()
1630
1554
                    basis_tree.unlock()
1631
1555
                # TODO - dedup parents list with things merged by pull ?
1632
1556
                # reuse the revisiontree we merged against to set the new
1633
1557
                # tree data.
1634
1558
                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
 
1559
                # we have to pull the merge trees out again, because 
 
1560
                # merge_inner has set the ids. - this corner is not yet 
1637
1561
                # layered well enough to prevent double handling.
1638
1562
                # XXX TODO: Fix the double handling: telling the tree about
1639
1563
                # the already known parent data is wasteful.
1645
1569
            return count
1646
1570
        finally:
1647
1571
            source.unlock()
 
1572
            top_pb.finished()
1648
1573
 
1649
1574
    @needs_write_lock
1650
1575
    def put_file_bytes_non_atomic(self, file_id, bytes):
1651
1576
        """See MutableTree.put_file_bytes_non_atomic."""
 
1577
        file_id = osutils.safe_file_id(file_id)
1652
1578
        stream = file(self.id2abspath(file_id), 'wb')
1653
1579
        try:
1654
1580
            stream.write(bytes)
1676
1602
 
1677
1603
            fl = []
1678
1604
            for subf in os.listdir(dirabs):
1679
 
                if self.bzrdir.is_control_filename(subf):
 
1605
                if subf == '.bzr':
1680
1606
                    continue
1681
1607
                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)
 
1608
                    subf_norm, can_access = osutils.normalized_filename(subf)
1690
1609
                    if subf_norm != subf and can_access:
1691
1610
                        if subf_norm not in dir_entry.children:
1692
1611
                            fl.append(subf_norm)
1693
1612
                    else:
1694
1613
                        fl.append(subf)
1695
 
 
 
1614
            
1696
1615
            fl.sort()
1697
1616
            for subf in fl:
1698
1617
                subp = pathjoin(path, subf)
1735
1654
        r"""Check whether the filename matches an ignore pattern.
1736
1655
 
1737
1656
        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.
 
1657
        others match against only the last component.
1741
1658
 
1742
1659
        If the file is ignored, returns the pattern which caused it to
1743
1660
        be ignored, otherwise None.  So this can simply be used as a
1744
1661
        boolean if desired."""
1745
1662
        if getattr(self, '_ignoreglobster', None) is None:
1746
 
            self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
 
1663
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1747
1664
        return self._ignoreglobster.match(filename)
1748
1665
 
1749
1666
    def kind(self, file_id):
1750
1667
        return file_kind(self.id2abspath(file_id))
1751
1668
 
1752
 
    def stored_kind(self, file_id):
1753
 
        """See Tree.stored_kind"""
1754
 
        return self.inventory[file_id].kind
1755
 
 
1756
1669
    def _comparison_data(self, entry, path):
1757
1670
        abspath = self.abspath(path)
1758
1671
        try:
1799
1712
            raise errors.ObjectNotLocked(self)
1800
1713
 
1801
1714
    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
 
        """
 
1715
        """See Branch.lock_read, and WorkingTree.unlock."""
1808
1716
        if not self.is_locked():
1809
1717
            self._reset_data()
1810
1718
        self.branch.lock_read()
1811
1719
        try:
1812
 
            self._control_files.lock_read()
1813
 
            return LogicalLockResult(self.unlock)
 
1720
            return self._control_files.lock_read()
1814
1721
        except:
1815
1722
            self.branch.unlock()
1816
1723
            raise
1817
1724
 
1818
1725
    def lock_tree_write(self):
1819
 
        """See MutableTree.lock_tree_write, and WorkingTree.unlock.
1820
 
 
1821
 
        :return: A bzrlib.lock.LogicalLockResult.
1822
 
        """
 
1726
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1823
1727
        if not self.is_locked():
1824
1728
            self._reset_data()
1825
1729
        self.branch.lock_read()
1826
1730
        try:
1827
 
            self._control_files.lock_write()
1828
 
            return LogicalLockResult(self.unlock)
 
1731
            return self._control_files.lock_write()
1829
1732
        except:
1830
1733
            self.branch.unlock()
1831
1734
            raise
1832
1735
 
1833
1736
    def lock_write(self):
1834
 
        """See MutableTree.lock_write, and WorkingTree.unlock.
1835
 
 
1836
 
        :return: A bzrlib.lock.LogicalLockResult.
1837
 
        """
 
1737
        """See MutableTree.lock_write, and WorkingTree.unlock."""
1838
1738
        if not self.is_locked():
1839
1739
            self._reset_data()
1840
1740
        self.branch.lock_write()
1841
1741
        try:
1842
 
            self._control_files.lock_write()
1843
 
            return LogicalLockResult(self.unlock)
 
1742
            return self._control_files.lock_write()
1844
1743
        except:
1845
1744
            self.branch.unlock()
1846
1745
            raise
1854
1753
    def _reset_data(self):
1855
1754
        """Reset transient data that cannot be revalidated."""
1856
1755
        self._inventory_is_modified = False
1857
 
        f = self._transport.get('inventory')
1858
 
        try:
1859
 
            result = self._deserialize(f)
1860
 
        finally:
1861
 
            f.close()
 
1756
        result = self._deserialize(self._control_files.get('inventory'))
1862
1757
        self._set_inventory(result, dirty=False)
1863
1758
 
1864
1759
    @needs_tree_write_lock
1865
1760
    def set_last_revision(self, new_revision):
1866
1761
        """Change the last revision in the working tree."""
 
1762
        new_revision = osutils.safe_revision_id(new_revision)
1867
1763
        if self._change_last_revision(new_revision):
1868
1764
            self._cache_basis_inventory(new_revision)
1869
1765
 
1870
1766
    def _change_last_revision(self, new_revision):
1871
1767
        """Template method part of set_last_revision to perform the change.
1872
 
 
 
1768
        
1873
1769
        This is used to allow WorkingTree3 instances to not affect branch
1874
1770
        when their last revision is set.
1875
1771
        """
1885
1781
 
1886
1782
    def _write_basis_inventory(self, xml):
1887
1783
        """Write the basis inventory XML to the basis-inventory file"""
 
1784
        assert isinstance(xml, str), 'serialised xml must be bytestring.'
1888
1785
        path = self._basis_inventory_name()
1889
1786
        sio = StringIO(xml)
1890
 
        self._transport.put_file(path, sio,
1891
 
            mode=self.bzrdir._get_file_mode())
 
1787
        self._control_files.put(path, sio)
1892
1788
 
1893
1789
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
1894
1790
        """Create the text that will be saved in basis-inventory"""
1895
 
        inventory.revision_id = revision_id
 
1791
        # TODO: jam 20070209 This should be redundant, as the revision_id
 
1792
        #       as all callers should have already converted the revision_id to
 
1793
        #       utf8
 
1794
        inventory.revision_id = osutils.safe_revision_id(revision_id)
1896
1795
        return xml7.serializer_v7.write_inventory_to_string(inventory)
1897
1796
 
1898
1797
    def _cache_basis_inventory(self, new_revision):
1901
1800
        # as commit already has that ready-to-use [while the format is the
1902
1801
        # same, that is].
1903
1802
        try:
1904
 
            # this double handles the inventory - unpack and repack -
 
1803
            # this double handles the inventory - unpack and repack - 
1905
1804
            # but is easier to understand. We can/should put a conditional
1906
1805
            # in here based on whether the inventory is in the latest format
1907
1806
            # - perhaps we should repack all inventories on a repository
1908
1807
            # upgrade ?
1909
1808
            # the fast path is to copy the raw xml from the repository. If the
1910
 
            # xml contains 'revision_id="', then we assume the right
 
1809
            # xml contains 'revision_id="', then we assume the right 
1911
1810
            # revision_id is set. We must check for this full string, because a
1912
1811
            # root node id can legitimately look like 'revision_id' but cannot
1913
1812
            # contain a '"'.
1914
 
            xml = self.branch.repository._get_inventory_xml(new_revision)
 
1813
            xml = self.branch.repository.get_inventory_xml(new_revision)
1915
1814
            firstline = xml.split('\n', 1)[0]
1916
 
            if (not 'revision_id="' in firstline or
 
1815
            if (not 'revision_id="' in firstline or 
1917
1816
                'format="7"' not in firstline):
1918
 
                inv = self.branch.repository._serializer.read_inventory_from_string(
1919
 
                    xml, new_revision)
 
1817
                inv = self.branch.repository.deserialise_inventory(
 
1818
                    new_revision, xml)
1920
1819
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
1921
1820
            self._write_basis_inventory(xml)
1922
1821
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1925
1824
    def read_basis_inventory(self):
1926
1825
        """Read the cached basis inventory."""
1927
1826
        path = self._basis_inventory_name()
1928
 
        return self._transport.get_bytes(path)
1929
 
 
 
1827
        return self._control_files.get(path).read()
 
1828
        
1930
1829
    @needs_read_lock
1931
1830
    def read_working_inventory(self):
1932
1831
        """Read the working inventory.
1933
 
 
 
1832
        
1934
1833
        :raises errors.InventoryModified: read_working_inventory will fail
1935
1834
            when the current in memory inventory has been modified.
1936
1835
        """
1937
 
        # conceptually this should be an implementation detail of the tree.
 
1836
        # conceptually this should be an implementation detail of the tree. 
1938
1837
        # XXX: Deprecate this.
1939
1838
        # ElementTree does its own conversion from UTF-8, so open in
1940
1839
        # binary.
1941
1840
        if self._inventory_is_modified:
1942
1841
            raise errors.InventoryModified(self)
1943
 
        f = self._transport.get('inventory')
1944
 
        try:
1945
 
            result = self._deserialize(f)
1946
 
        finally:
1947
 
            f.close()
 
1842
        result = self._deserialize(self._control_files.get('inventory'))
1948
1843
        self._set_inventory(result, dirty=False)
1949
1844
        return result
1950
1845
 
1965
1860
 
1966
1861
        new_files=set()
1967
1862
        unknown_nested_files=set()
1968
 
        if to_file is None:
1969
 
            to_file = sys.stdout
1970
1863
 
1971
1864
        def recurse_directory_to_add_files(directory):
1972
1865
            # Recurse directory and add all files
1973
1866
            # 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:
 
1867
            for parent_info, file_infos in\
 
1868
                osutils.walkdirs(self.abspath(directory),
 
1869
                    directory):
 
1870
                for relpath, basename, kind, lstat, abspath in file_infos:
1976
1871
                    # Is it versioned or ignored?
1977
1872
                    if self.path2id(relpath) or self.is_ignored(relpath):
1978
1873
                        # Add nested content for deletion.
1988
1883
            filename = self.relpath(abspath)
1989
1884
            if len(filename) > 0:
1990
1885
                new_files.add(filename)
1991
 
                recurse_directory_to_add_files(filename)
 
1886
                if osutils.isdir(abspath):
 
1887
                    recurse_directory_to_add_files(filename)
1992
1888
 
1993
1889
        files = list(new_files)
1994
1890
 
2003
1899
            has_changed_files = len(unknown_nested_files) > 0
2004
1900
            if not has_changed_files:
2005
1901
                for (file_id, path, content_change, versioned, parent_id, name,
2006
 
                     kind, executable) in self.iter_changes(self.basis_tree(),
 
1902
                     kind, executable) in self._iter_changes(self.basis_tree(),
2007
1903
                         include_unchanged=True, require_versioned=False,
2008
1904
                         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.
 
1905
                    # Check if it's an unknown (but not ignored) OR
 
1906
                    # changed (but not deleted) :
 
1907
                    if not self.is_ignored(path[1]) and (
 
1908
                        versioned == (False, False) or
 
1909
                        content_change and kind[1] != None):
2019
1910
                        has_changed_files = True
2020
1911
                        break
2021
1912
 
2029
1920
                        tree_delta.unversioned.extend((unknown_file,))
2030
1921
                raise errors.BzrRemoveChangedFilesError(tree_delta)
2031
1922
 
2032
 
        # Build inv_delta and delete files where applicable,
 
1923
        # Build inv_delta and delete files where applicaple,
2033
1924
        # do this before any modifications to inventory.
2034
1925
        for f in files:
2035
1926
            fid = self.path2id(f)
2043
1934
                        new_status = 'I'
2044
1935
                    else:
2045
1936
                        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')
 
1937
                    textui.show_status(new_status, self.kind(fid), f,
 
1938
                                       to_file=to_file)
2049
1939
                # Unversion file
2050
1940
                inv_delta.append((f, None, fid, None))
2051
1941
                message = "removed %s" % (f,)
2074
1964
 
2075
1965
    @needs_tree_write_lock
2076
1966
    def revert(self, filenames=None, old_tree=None, backups=True,
2077
 
               pb=None, report_changes=False):
 
1967
               pb=DummyProgress(), report_changes=False):
2078
1968
        from bzrlib.conflicts import resolve
2079
1969
        if filenames == []:
2080
1970
            filenames = None
2082
1972
                ' as of bzr 0.91.  Please use None (the default) instead.',
2083
1973
                DeprecationWarning, stacklevel=2)
2084
1974
        if old_tree is None:
2085
 
            basis_tree = self.basis_tree()
2086
 
            basis_tree.lock_read()
2087
 
            old_tree = basis_tree
 
1975
            old_tree = self.basis_tree()
 
1976
        conflicts = transform.revert(self, old_tree, filenames, backups, pb,
 
1977
                                     report_changes)
 
1978
        if filenames is None:
 
1979
            self.set_parent_ids(self.get_parent_ids()[:1])
 
1980
            resolve(self)
2088
1981
        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()
 
1982
            resolve(self, filenames, ignore_misses=True)
2108
1983
        return conflicts
2109
1984
 
2110
1985
    def revision_tree(self, revision_id):
2137
2012
    def set_inventory(self, new_inventory_list):
2138
2013
        from bzrlib.inventory import (Inventory,
2139
2014
                                      InventoryDirectory,
 
2015
                                      InventoryEntry,
2140
2016
                                      InventoryFile,
2141
2017
                                      InventoryLink)
2142
2018
        inv = Inventory(self.get_root_id())
2144
2020
            name = os.path.basename(path)
2145
2021
            if name == "":
2146
2022
                continue
2147
 
            # fixme, there should be a factory function inv,add_??
 
2023
            # fixme, there should be a factory function inv,add_?? 
2148
2024
            if kind == 'directory':
2149
2025
                inv.add(InventoryDirectory(file_id, name, parent))
2150
2026
            elif kind == 'file':
2158
2034
    @needs_tree_write_lock
2159
2035
    def set_root_id(self, file_id):
2160
2036
        """Set the root id for this tree."""
2161
 
        # for compatability
 
2037
        # for compatability 
2162
2038
        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)
 
2039
            symbol_versioning.warn(symbol_versioning.zero_twelve
 
2040
                % 'WorkingTree.set_root_id with fileid=None',
 
2041
                DeprecationWarning,
 
2042
                stacklevel=3)
 
2043
            file_id = ROOT_ID
 
2044
        else:
 
2045
            file_id = osutils.safe_file_id(file_id)
2166
2046
        self._set_root_id(file_id)
2167
2047
 
2168
2048
    def _set_root_id(self, file_id):
2169
2049
        """Set the root id for this tree, in a format specific manner.
2170
2050
 
2171
 
        :param file_id: The file id to assign to the root. It must not be
 
2051
        :param file_id: The file id to assign to the root. It must not be 
2172
2052
            present in the current inventory or an error will occur. It must
2173
2053
            not be None, but rather a valid file id.
2174
2054
        """
2193
2073
 
2194
2074
    def unlock(self):
2195
2075
        """See Branch.unlock.
2196
 
 
 
2076
        
2197
2077
        WorkingTree locking just uses the Branch locking facilities.
2198
2078
        This is current because all working trees have an embedded branch
2199
2079
        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
 
2080
        between multiple working trees, i.e. via shared storage, then we 
2201
2081
        would probably want to lock both the local tree, and the branch.
2202
2082
        """
2203
2083
        raise NotImplementedError(self.unlock)
2204
2084
 
2205
 
    _marker = object()
2206
 
 
2207
 
    def update(self, change_reporter=None, possible_transports=None,
2208
 
               revision=None, old_tip=_marker):
 
2085
    def update(self, change_reporter=None, possible_transports=None):
2209
2086
        """Update a working tree along its branch.
2210
2087
 
2211
2088
        This will update the branch if its bound too, which means we have
2229
2106
        - Merge current state -> basis tree of the master w.r.t. the old tree
2230
2107
          basis.
2231
2108
        - 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
2109
        """
2239
 
        if self.branch.get_bound_location() is not None:
 
2110
        if self.branch.get_master_branch(possible_transports) is not None:
2240
2111
            self.lock_write()
2241
 
            update_branch = (old_tip is self._marker)
 
2112
            update_branch = True
2242
2113
        else:
2243
2114
            self.lock_tree_write()
2244
2115
            update_branch = False
2246
2117
            if update_branch:
2247
2118
                old_tip = self.branch.update(possible_transports)
2248
2119
            else:
2249
 
                if old_tip is self._marker:
2250
 
                    old_tip = None
2251
 
            return self._update_tree(old_tip, change_reporter, revision)
 
2120
                old_tip = None
 
2121
            return self._update_tree(old_tip, change_reporter)
2252
2122
        finally:
2253
2123
            self.unlock()
2254
2124
 
2255
2125
    @needs_tree_write_lock
2256
 
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
 
2126
    def _update_tree(self, old_tip=None, change_reporter=None):
2257
2127
        """Update a tree to the master branch.
2258
2128
 
2259
2129
        :param old_tip: if supplied, the previous tip revision the branch,
2265
2135
        # cant set that until we update the working trees last revision to be
2266
2136
        # one from the new branch, because it will just get absorbed by the
2267
2137
        # parent de-duplication logic.
2268
 
        #
 
2138
        # 
2269
2139
        # We MUST save it even if an error occurs, because otherwise the users
2270
2140
        # local work is unreferenced and will appear to have been lost.
2271
 
        #
2272
 
        nb_conflicts = 0
 
2141
        # 
 
2142
        result = 0
2273
2143
        try:
2274
2144
            last_rev = self.get_parent_ids()[0]
2275
2145
        except IndexError:
2276
2146
            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
 
 
 
2147
        if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
 
2148
            # merge tree state up to new branch tip.
2301
2149
            basis = self.basis_tree()
2302
2150
            basis.lock_read()
2303
2151
            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)
 
2152
                to_tree = self.branch.basis_tree()
 
2153
                if basis.inventory.root is None:
 
2154
                    self.set_root_id(to_tree.inventory.root.file_id)
2307
2155
                    self.flush()
 
2156
                result += merge.merge_inner(
 
2157
                                      self.branch,
 
2158
                                      to_tree,
 
2159
                                      basis,
 
2160
                                      this_tree=self,
 
2161
                                      change_reporter=change_reporter)
2308
2162
            finally:
2309
2163
                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
2164
            # TODO - dedup parents list with things merged by pull ?
2322
2165
            # reuse the tree we've updated to to set the basis:
2323
 
            parent_trees = [(revision, to_tree)]
 
2166
            parent_trees = [(self.branch.last_revision(), to_tree)]
2324
2167
            merges = self.get_parent_ids()[1:]
2325
2168
            # 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
 
2169
            # tree can decide whether to give us teh entire tree or give us a
2327
2170
            # lazy initialised tree. dirstate for instance will have the trees
2328
2171
            # in ram already, whereas a last-revision + basis-inventory tree
2329
2172
            # will not, but also does not need them when setting parents.
2330
2173
            for parent in merges:
2331
2174
                parent_trees.append(
2332
2175
                    (parent, self.branch.repository.revision_tree(parent)))
2333
 
            if not _mod_revision.is_null(old_tip):
 
2176
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2334
2177
                parent_trees.append(
2335
2178
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
2336
2179
            self.set_parent_trees(parent_trees)
2337
2180
            last_rev = parent_trees[0][0]
2338
 
        return nb_conflicts
 
2181
        else:
 
2182
            # the working tree had the same last-revision as the master
 
2183
            # branch did. We may still have pivot local work from the local
 
2184
            # branch into old_tip:
 
2185
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
 
2186
                self.add_parent_tree_id(old_tip)
 
2187
        if (old_tip is not None and not _mod_revision.is_null(old_tip)
 
2188
            and old_tip != last_rev):
 
2189
            # our last revision was not the prior branch last revision
 
2190
            # and we have converted that last revision to a pending merge.
 
2191
            # base is somewhere between the branch tip now
 
2192
            # and the now pending merge
 
2193
 
 
2194
            # Since we just modified the working tree and inventory, flush out
 
2195
            # the current state, before we modify it again.
 
2196
            # TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
 
2197
            #       requires it only because TreeTransform directly munges the
 
2198
            #       inventory and calls tree._write_inventory(). Ultimately we
 
2199
            #       should be able to remove this extra flush.
 
2200
            self.flush()
 
2201
            graph = self.branch.repository.get_graph()
 
2202
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
 
2203
                                                old_tip)
 
2204
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
2205
            other_tree = self.branch.repository.revision_tree(old_tip)
 
2206
            result += merge.merge_inner(
 
2207
                                  self.branch,
 
2208
                                  other_tree,
 
2209
                                  base_tree,
 
2210
                                  this_tree=self,
 
2211
                                  change_reporter=change_reporter)
 
2212
        return result
2339
2213
 
2340
2214
    def _write_hashcache_if_dirty(self):
2341
2215
        """Write out the hashcache if it is dirty."""
2425
2299
            current_inv = None
2426
2300
            inv_finished = True
2427
2301
        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
2302
            if not disk_finished:
2435
2303
                # 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 -
 
2304
                if current_disk[0][1][top_strip_len:] == '':
 
2305
                    # osutils.walkdirs can be made nicer - 
2439
2306
                    # yield the path-from-prefix rather than the pathjoined
2440
2307
                    # 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])):
 
2308
                    bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
 
2309
                    if current_disk[1][bzrdir_loc][0] == '.bzr':
2446
2310
                        # we dont yield the contents of, or, .bzr itself.
2447
 
                        del cur_disk_dir_content[bzrdir_loc]
 
2311
                        del current_disk[1][bzrdir_loc]
2448
2312
            if inv_finished:
2449
2313
                # everything is unknown
2450
2314
                direction = 1
2452
2316
                # everything is missing
2453
2317
                direction = -1
2454
2318
            else:
2455
 
                direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
 
2319
                direction = cmp(current_inv[0][0], current_disk[0][0])
2456
2320
            if direction > 0:
2457
2321
                # disk is before inventory - unknown
2458
2322
                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
 
2323
                    relpath, basename, kind, stat, top_path in current_disk[1]]
 
2324
                yield (current_disk[0][0], None), dirblock
2462
2325
                try:
2463
2326
                    current_disk = disk_iterator.next()
2464
2327
                except StopIteration:
2466
2329
            elif direction < 0:
2467
2330
                # inventory is before disk - missing.
2468
2331
                dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2469
 
                    for relpath, basename, dkind, stat, fileid, kind in
 
2332
                    for relpath, basename, dkind, stat, fileid, kind in 
2470
2333
                    current_inv[1]]
2471
2334
                yield (current_inv[0][0], current_inv[0][1]), dirblock
2472
2335
                try:
2478
2341
                # merge the inventory and disk data together
2479
2342
                dirblock = []
2480
2343
                for relpath, subiterator in itertools.groupby(sorted(
2481
 
                    current_inv[1] + cur_disk_dir_content,
2482
 
                    key=operator.itemgetter(0)), operator.itemgetter(1)):
 
2344
                    current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2483
2345
                    path_elements = list(subiterator)
2484
2346
                    if len(path_elements) == 2:
2485
2347
                        inv_row, disk_row = path_elements
2538
2400
                relroot = ""
2539
2401
            # FIXME: stash the node in pending
2540
2402
            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
 
                        ))
 
2403
            for name, child in entry.sorted_children():
 
2404
                dirblock.append((relroot + name, name, child.kind, None,
 
2405
                    child.file_id, child.kind
 
2406
                    ))
2546
2407
            yield (currentdir[0], entry.file_id), dirblock
2547
2408
            # push the user specified dirs from dirblock
2548
2409
            for dir in reversed(dirblock):
2581
2442
        self.set_conflicts(un_resolved)
2582
2443
        return un_resolved, resolved
2583
2444
 
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
2445
    def _validate(self):
2604
2446
        """Validate internal structures.
2605
2447
 
2611
2453
        """
2612
2454
        return
2613
2455
 
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
2456
 
2627
2457
class WorkingTree2(WorkingTree):
2628
2458
    """This is the Format 2 working tree.
2629
2459
 
2630
 
    This was the first weave based working tree.
 
2460
    This was the first weave based working tree. 
2631
2461
     - uses os locks for locking.
2632
2462
     - uses the branch last-revision.
2633
2463
    """
2643
2473
        if self._inventory is None:
2644
2474
            self.read_working_inventory()
2645
2475
 
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
2476
    def lock_tree_write(self):
2651
2477
        """See WorkingTree.lock_tree_write().
2652
2478
 
2653
2479
        In Format2 WorkingTrees we have a single lock for the branch and tree
2654
2480
        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
2481
        """
2659
2482
        self.branch.lock_write()
2660
2483
        try:
2661
 
            self._control_files.lock_write()
2662
 
            return self
 
2484
            return self._control_files.lock_write()
2663
2485
        except:
2664
2486
            self.branch.unlock()
2665
2487
            raise
2674
2496
            if self._inventory_is_modified:
2675
2497
                self.flush()
2676
2498
            self._write_hashcache_if_dirty()
2677
 
 
 
2499
                    
2678
2500
        # reverse order of locking.
2679
2501
        try:
2680
2502
            return self._control_files.unlock()
2696
2518
    def _last_revision(self):
2697
2519
        """See Mutable.last_revision."""
2698
2520
        try:
2699
 
            return self._transport.get_bytes('last-revision')
 
2521
            return osutils.safe_revision_id(
 
2522
                        self._control_files.get('last-revision').read())
2700
2523
        except errors.NoSuchFile:
2701
2524
            return _mod_revision.NULL_REVISION
2702
2525
 
2703
2526
    def _change_last_revision(self, revision_id):
2704
2527
        """See WorkingTree._change_last_revision."""
2705
 
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
 
2528
        if revision_id is None or revision_id == NULL_REVISION:
2706
2529
            try:
2707
 
                self._transport.delete('last-revision')
 
2530
                self._control_files._transport.delete('last-revision')
2708
2531
            except errors.NoSuchFile:
2709
2532
                pass
2710
2533
            return False
2711
2534
        else:
2712
 
            self._transport.put_bytes('last-revision', revision_id,
2713
 
                mode=self.bzrdir._get_file_mode())
 
2535
            self._control_files.put_bytes('last-revision', revision_id)
2714
2536
            return True
2715
2537
 
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
2538
    @needs_tree_write_lock
2721
2539
    def set_conflicts(self, conflicts):
2722
 
        self._put_rio('conflicts', conflicts.to_stanzas(),
 
2540
        self._put_rio('conflicts', conflicts.to_stanzas(), 
2723
2541
                      CONFLICT_HEADER_1)
2724
2542
 
2725
2543
    @needs_tree_write_lock
2732
2550
    @needs_read_lock
2733
2551
    def conflicts(self):
2734
2552
        try:
2735
 
            confile = self._transport.get('conflicts')
 
2553
            confile = self._control_files.get('conflicts')
2736
2554
        except errors.NoSuchFile:
2737
2555
            return _mod_conflicts.ConflictList()
2738
2556
        try:
2739
 
            try:
2740
 
                if confile.next() != CONFLICT_HEADER_1 + '\n':
2741
 
                    raise errors.ConflictFormatError()
2742
 
            except StopIteration:
 
2557
            if confile.next() != CONFLICT_HEADER_1 + '\n':
2743
2558
                raise errors.ConflictFormatError()
2744
 
            return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2745
 
        finally:
2746
 
            confile.close()
 
2559
        except StopIteration:
 
2560
            raise errors.ConflictFormatError()
 
2561
        return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2747
2562
 
2748
2563
    def unlock(self):
2749
2564
        # do non-implementation specific cleanup
2766
2581
            return path[:-len(suffix)]
2767
2582
 
2768
2583
 
 
2584
@deprecated_function(zero_eight)
 
2585
def is_control_file(filename):
 
2586
    """See WorkingTree.is_control_filename(filename)."""
 
2587
    ## FIXME: better check
 
2588
    filename = normpath(filename)
 
2589
    while filename != '':
 
2590
        head, tail = os.path.split(filename)
 
2591
        ## mutter('check %r for control file' % ((head, tail),))
 
2592
        if tail == '.bzr':
 
2593
            return True
 
2594
        if filename == head:
 
2595
            break
 
2596
        filename = head
 
2597
    return False
 
2598
 
 
2599
 
2769
2600
class WorkingTreeFormat(object):
2770
2601
    """An encapsulation of the initialization and open routines for a format.
2771
2602
 
2774
2605
     * a format string,
2775
2606
     * an open routine.
2776
2607
 
2777
 
    Formats are placed in an dict by their format string for reference
 
2608
    Formats are placed in an dict by their format string for reference 
2778
2609
    during workingtree opening. Its not required that these be instances, they
2779
 
    can be classes themselves with class methods - it simply depends on
 
2610
    can be classes themselves with class methods - it simply depends on 
2780
2611
    whether state is needed for a given format or not.
2781
2612
 
2782
2613
    Once a format is deprecated, just deprecate the initialize and open
2783
 
    methods on the format class. Do not deprecate the object, as the
 
2614
    methods on the format class. Do not deprecate the object, as the 
2784
2615
    object will be created every time regardless.
2785
2616
    """
2786
2617
 
2799
2630
        """Return the format for the working tree object in a_bzrdir."""
2800
2631
        try:
2801
2632
            transport = a_bzrdir.get_workingtree_transport(None)
2802
 
            format_string = transport.get_bytes("format")
 
2633
            format_string = transport.get("format").read()
2803
2634
            return klass._formats[format_string]
2804
2635
        except errors.NoSuchFile:
2805
2636
            raise errors.NoWorkingTree(base=transport.base)
2806
2637
        except KeyError:
2807
 
            raise errors.UnknownFormatError(format=format_string,
2808
 
                                            kind="working tree")
 
2638
            raise errors.UnknownFormatError(format=format_string)
2809
2639
 
2810
2640
    def __eq__(self, other):
2811
2641
        return self.__class__ is other.__class__
2830
2660
        """Is this format supported?
2831
2661
 
2832
2662
        Supported formats can be initialized and opened.
2833
 
        Unsupported formats may not support initialization or committing or
 
2663
        Unsupported formats may not support initialization or committing or 
2834
2664
        some other features depending on the reason for not being supported.
2835
2665
        """
2836
2666
        return True
2837
2667
 
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
2668
    @classmethod
2847
2669
    def register_format(klass, format):
2848
2670
        klass._formats[format.get_format_string()] = format
2853
2675
 
2854
2676
    @classmethod
2855
2677
    def unregister_format(klass, format):
 
2678
        assert klass._formats[format.get_format_string()] is format
2856
2679
        del klass._formats[format.get_format_string()]
2857
2680
 
2858
2681
 
2859
2682
class WorkingTreeFormat2(WorkingTreeFormat):
2860
 
    """The second working tree format.
 
2683
    """The second working tree format. 
2861
2684
 
2862
2685
    This format modified the hash cache from the format 1 hash cache.
2863
2686
    """
2868
2691
        """See WorkingTreeFormat.get_format_description()."""
2869
2692
        return "Working tree format 2"
2870
2693
 
2871
 
    def _stub_initialize_on_transport(self, transport, file_mode):
2872
 
        """Workaround: create control files for a remote working tree.
2873
 
 
 
2694
    def stub_initialize_remote(self, control_files):
 
2695
        """As a special workaround create critical control files for a remote working tree
 
2696
        
2874
2697
        This ensures that it can later be updated and dealt with locally,
2875
 
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
 
2698
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with 
2876
2699
        no working tree.  (See bug #43064).
2877
2700
        """
2878
2701
        sio = StringIO()
2879
 
        inv = inventory.Inventory()
 
2702
        inv = Inventory()
2880
2703
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
2881
2704
        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):
 
2705
        control_files.put('inventory', sio)
 
2706
 
 
2707
        control_files.put_bytes('pending-merges', '')
 
2708
        
 
2709
 
 
2710
    def initialize(self, a_bzrdir, revision_id=None):
2887
2711
        """See WorkingTreeFormat.initialize()."""
2888
2712
        if not isinstance(a_bzrdir.transport, LocalTransport):
2889
2713
            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()
 
2714
        branch = a_bzrdir.open_branch()
2894
2715
        if revision_id is None:
2895
2716
            revision_id = _mod_revision.ensure_null(branch.last_revision())
 
2717
        else:
 
2718
            revision_id = osutils.safe_revision_id(revision_id)
2896
2719
        branch.lock_write()
2897
2720
        try:
2898
2721
            branch.generate_revision_history(revision_id)
2899
2722
        finally:
2900
2723
            branch.unlock()
2901
 
        inv = inventory.Inventory()
 
2724
        inv = Inventory()
2902
2725
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2903
2726
                         branch,
2904
2727
                         inv,
2907
2730
                         _bzrdir=a_bzrdir)
2908
2731
        basis_tree = branch.repository.revision_tree(revision_id)
2909
2732
        if basis_tree.inventory.root is not None:
2910
 
            wt.set_root_id(basis_tree.get_root_id())
 
2733
            wt.set_root_id(basis_tree.inventory.root.file_id)
2911
2734
        # set the parent list and cache the basis tree.
2912
2735
        if _mod_revision.is_null(revision_id):
2913
2736
            parent_trees = []
2949
2772
        - is new in bzr 0.8
2950
2773
        - uses a LockDir to guard access for writes.
2951
2774
    """
2952
 
 
 
2775
    
2953
2776
    upgrade_recommended = True
2954
2777
 
2955
2778
    def get_format_string(self):
2972
2795
 
2973
2796
    def _open_control_files(self, a_bzrdir):
2974
2797
        transport = a_bzrdir.get_workingtree_transport(None)
2975
 
        return LockableFiles(transport, self._lock_file_name,
 
2798
        return LockableFiles(transport, self._lock_file_name, 
2976
2799
                             self._lock_class)
2977
2800
 
2978
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2979
 
                   accelerator_tree=None, hardlink=False):
 
2801
    def initialize(self, a_bzrdir, revision_id=None):
2980
2802
        """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.
 
2803
        
 
2804
        revision_id allows creating a working tree at a different
 
2805
        revision than the branch is at.
2990
2806
        """
2991
2807
        if not isinstance(a_bzrdir.transport, LocalTransport):
2992
2808
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2994
2810
        control_files = self._open_control_files(a_bzrdir)
2995
2811
        control_files.create_lock()
2996
2812
        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()
 
2813
        control_files.put_utf8('format', self.get_format_string())
 
2814
        branch = a_bzrdir.open_branch()
3003
2815
        if revision_id is None:
3004
2816
            revision_id = _mod_revision.ensure_null(branch.last_revision())
 
2817
        else:
 
2818
            revision_id = osutils.safe_revision_id(revision_id)
3005
2819
        # WorkingTree3 can handle an inventory which has a unique root id.
3006
2820
        # as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
3007
2821
        # those trees. And because there isn't a format bump inbetween, we
3020
2834
            basis_tree = branch.repository.revision_tree(revision_id)
3021
2835
            # only set an explicit root id if there is one to set.
3022
2836
            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:
 
2837
                wt.set_root_id(basis_tree.inventory.root.file_id)
 
2838
            if revision_id == NULL_REVISION:
3025
2839
                wt.set_parent_trees([])
3026
2840
            else:
3027
2841
                wt.set_parent_trees([(revision_id, basis_tree)])
3034
2848
        return wt
3035
2849
 
3036
2850
    def _initial_inventory(self):
3037
 
        return inventory.Inventory()
 
2851
        return Inventory()
3038
2852
 
3039
2853
    def __init__(self):
3040
2854
        super(WorkingTreeFormat3, self).__init__()
3055
2869
 
3056
2870
    def _open(self, a_bzrdir, control_files):
3057
2871
        """Open the tree itself.
3058
 
 
 
2872
        
3059
2873
        :param a_bzrdir: the dir for the tree.
3060
2874
        :param control_files: the control files for the tree.
3061
2875
        """
3069
2883
        return self.get_format_string()
3070
2884
 
3071
2885
 
3072
 
__default_format = WorkingTreeFormat6()
 
2886
__default_format = WorkingTreeFormat4()
3073
2887
WorkingTreeFormat.register_format(__default_format)
3074
 
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3075
 
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3076
2888
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3077
2889
WorkingTreeFormat.set_default_format(__default_format)
3078
2890
# formats which have no format string are not discoverable