~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Martin Pool
  • Date: 2007-09-24 06:00:49 UTC
  • mto: This revision was merged to the branch mainline in revision 2859.
  • Revision ID: mbp@sourcefrog.net-20070924060049-016r89ialgbf886s
Add unit test for _rollover_trace_maybe

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