~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Aaron Bentley
  • Date: 2007-07-23 14:27:42 UTC
  • mto: (1551.19.24 Aaron's mergeable stuff)
  • mto: This revision was merged to the branch mainline in revision 2649.
  • Revision ID: abentley@panoramicfeedback.com-20070723142742-98ye8w4au9bjg5q0
Status honours selected paths for conflicts (#127606)

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)
434
 
 
435
 
    def _cleanup(self):
436
 
        self._flush_ignore_list_cache()
 
400
            return self.branch.repository.revision_tree(None)
 
401
 
 
402
    @staticmethod
 
403
    @deprecated_method(zero_eight)
 
404
    def create(branch, directory):
 
405
        """Create a workingtree for branch at directory.
 
406
 
 
407
        If existing_directory already exists it must have a .bzr directory.
 
408
        If it does not exist, it will be created.
 
409
 
 
410
        This returns a new WorkingTree object for the new checkout.
 
411
 
 
412
        TODO FIXME RBC 20060124 when we have checkout formats in place this
 
413
        should accept an optional revisionid to checkout [and reject this if
 
414
        checking out into the same dir as a pre-checkout-aware branch format.]
 
415
 
 
416
        XXX: When BzrDir is present, these should be created through that 
 
417
        interface instead.
 
418
        """
 
419
        warnings.warn('delete WorkingTree.create', stacklevel=3)
 
420
        transport = get_transport(directory)
 
421
        if branch.bzrdir.root_transport.base == transport.base:
 
422
            # same dir 
 
423
            return branch.bzrdir.create_workingtree()
 
424
        # different directory, 
 
425
        # create a branch reference
 
426
        # and now a working tree.
 
427
        raise NotImplementedError
 
428
 
 
429
    @staticmethod
 
430
    @deprecated_method(zero_eight)
 
431
    def create_standalone(directory):
 
432
        """Create a checkout and a branch and a repo at directory.
 
433
 
 
434
        Directory must exist and be empty.
 
435
 
 
436
        please use BzrDir.create_standalone_workingtree
 
437
        """
 
438
        return bzrdir.BzrDir.create_standalone_workingtree(directory)
437
439
 
438
440
    def relpath(self, path):
439
441
        """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
 
442
        
 
443
        The path may be absolute or relative. If its a relative path it is 
442
444
        interpreted relative to the python current working directory.
443
445
        """
444
446
        return osutils.relpath(self.basedir, path)
446
448
    def has_filename(self, filename):
447
449
        return osutils.lexists(self.abspath(filename))
448
450
 
449
 
    def get_file(self, file_id, path=None, filtered=True):
450
 
        return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
451
 
 
452
 
    def get_file_with_stat(self, file_id, path=None, filtered=True,
453
 
        _fstat=os.fstat):
454
 
        """See Tree.get_file_with_stat."""
455
 
        if path is None:
456
 
            path = self.id2path(file_id)
457
 
        file_obj = self.get_file_byname(path, filtered=False)
458
 
        stat_value = _fstat(file_obj.fileno())
459
 
        if filtered and self.supports_content_filtering():
460
 
            filters = self._content_filter_stack(path)
461
 
            file_obj = filtered_input_file(file_obj, filters)
462
 
        return (file_obj, stat_value)
463
 
 
464
 
    def get_file_text(self, file_id, path=None, filtered=True):
465
 
        return self.get_file(file_id, path=path, filtered=filtered).read()
466
 
 
467
 
    def get_file_byname(self, filename, filtered=True):
468
 
        path = self.abspath(filename)
469
 
        f = file(path, 'rb')
470
 
        if filtered and self.supports_content_filtering():
471
 
            filters = self._content_filter_stack(filename)
472
 
            return filtered_input_file(f, filters)
473
 
        else:
474
 
            return f
475
 
 
476
 
    def get_file_lines(self, file_id, path=None, filtered=True):
477
 
        """See Tree.get_file_lines()"""
478
 
        file = self.get_file(file_id, path, filtered=filtered)
479
 
        try:
480
 
            return file.readlines()
481
 
        finally:
482
 
            file.close()
 
451
    def get_file(self, file_id):
 
452
        file_id = osutils.safe_file_id(file_id)
 
453
        return self.get_file_byname(self.id2path(file_id))
 
454
 
 
455
    def get_file_text(self, file_id):
 
456
        file_id = osutils.safe_file_id(file_id)
 
457
        return self.get_file(file_id).read()
 
458
 
 
459
    def get_file_byname(self, filename):
 
460
        return file(self.abspath(filename), 'rb')
483
461
 
484
462
    @needs_read_lock
485
463
    def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
492
470
        incorrectly attributed to CURRENT_REVISION (but after committing, the
493
471
        attribution will be correct).
494
472
        """
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
 
473
        file_id = osutils.safe_file_id(file_id)
 
474
        basis = self.basis_tree()
 
475
        basis.lock_read()
 
476
        try:
 
477
            changes = self._iter_changes(basis, True, [self.id2path(file_id)],
 
478
                require_versioned=True).next()
 
479
            changed_content, kind = changes[2], changes[6]
 
480
            if not changed_content:
 
481
                return basis.annotate_iter(file_id)
 
482
            if kind[1] is None:
 
483
                return None
 
484
            import annotate
 
485
            if kind[0] != 'file':
 
486
                old_lines = []
 
487
            else:
 
488
                old_lines = list(basis.annotate_iter(file_id))
 
489
            old = [old_lines]
 
490
            for tree in self.branch.repository.revision_trees(
 
491
                self.get_parent_ids()[1:]):
 
492
                if file_id not in tree:
 
493
                    continue
 
494
                old.append(list(tree.annotate_iter(file_id)))
 
495
            return annotate.reannotate(old, self.get_file(file_id).readlines(),
 
496
                                       default_revision)
 
497
        finally:
 
498
            basis.unlock()
531
499
 
532
500
    def _get_ancestors(self, default_revision):
533
501
        ancestors = set([default_revision])
538
506
 
539
507
    def get_parent_ids(self):
540
508
        """See Tree.get_parent_ids.
541
 
 
 
509
        
542
510
        This implementation reads the pending merges list and last_revision
543
511
        value and uses that to decide what the parents list should be.
544
512
        """
548
516
        else:
549
517
            parents = [last_rev]
550
518
        try:
551
 
            merges_bytes = self._transport.get_bytes('pending-merges')
 
519
            merges_file = self._control_files.get('pending-merges')
552
520
        except errors.NoSuchFile:
553
521
            pass
554
522
        else:
555
 
            for l in osutils.split_lines(merges_bytes):
556
 
                revision_id = l.rstrip('\n')
 
523
            for l in merges_file.readlines():
 
524
                revision_id = osutils.safe_revision_id(l.rstrip('\n'))
557
525
                parents.append(revision_id)
558
526
        return parents
559
527
 
561
529
    def get_root_id(self):
562
530
        """Return the id of this trees root"""
563
531
        return self._inventory.root.file_id
564
 
 
 
532
        
565
533
    def _get_store_filename(self, file_id):
566
534
        ## XXX: badly named; this is not in the store at all
 
535
        file_id = osutils.safe_file_id(file_id)
567
536
        return self.abspath(self.id2path(file_id))
568
537
 
569
538
    @needs_read_lock
570
539
    def clone(self, to_bzrdir, revision_id=None):
571
540
        """Duplicate this working tree into to_bzr, including all state.
572
 
 
 
541
        
573
542
        Specifically modified files are kept as modified, but
574
543
        ignored and unknown files are discarded.
575
544
 
576
545
        If you want to make a new line of development, see bzrdir.sprout()
577
546
 
578
547
        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
 
548
            If not None, the cloned tree will have its last revision set to 
 
549
            revision, and and difference between the source trees last revision
581
550
            and this one merged in.
582
551
        """
583
552
        # assumes the target bzr dir format is compatible.
584
 
        result = to_bzrdir.create_workingtree()
 
553
        result = self._format.initialize(to_bzrdir)
585
554
        self.copy_content_into(result, revision_id)
586
555
        return result
587
556
 
598
567
            tree.set_parent_ids([revision_id])
599
568
 
600
569
    def id2abspath(self, file_id):
 
570
        file_id = osutils.safe_file_id(file_id)
601
571
        return self.abspath(self.id2path(file_id))
602
572
 
603
573
    def has_id(self, file_id):
604
574
        # files that have been deleted are excluded
 
575
        file_id = osutils.safe_file_id(file_id)
605
576
        inv = self.inventory
606
577
        if not inv.has_id(file_id):
607
578
            return False
609
580
        return osutils.lexists(self.abspath(path))
610
581
 
611
582
    def has_or_had_id(self, file_id):
 
583
        file_id = osutils.safe_file_id(file_id)
612
584
        if file_id == self.inventory.root.file_id:
613
585
            return True
614
586
        return self.inventory.has_id(file_id)
616
588
    __contains__ = has_id
617
589
 
618
590
    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
 
591
        file_id = osutils.safe_file_id(file_id)
 
592
        return os.path.getsize(self.id2abspath(file_id))
629
593
 
630
594
    @needs_read_lock
631
595
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
596
        file_id = osutils.safe_file_id(file_id)
632
597
        if not path:
633
598
            path = self._inventory.id2path(file_id)
634
599
        return self._hashcache.get_sha1(path, stat_value)
635
600
 
636
601
    def get_file_mtime(self, file_id, path=None):
 
602
        file_id = osutils.safe_file_id(file_id)
637
603
        if not path:
638
604
            path = self.inventory.id2path(file_id)
639
605
        return os.lstat(self.abspath(path)).st_mtime
640
606
 
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
607
    if not supports_executable():
654
608
        def is_executable(self, file_id, path=None):
 
609
            file_id = osutils.safe_file_id(file_id)
655
610
            return self._inventory[file_id].executable
656
 
 
657
 
        _is_executable_from_path_and_stat = \
658
 
            _is_executable_from_path_and_stat_from_basis
659
611
    else:
660
612
        def is_executable(self, file_id, path=None):
661
613
            if not path:
 
614
                file_id = osutils.safe_file_id(file_id)
662
615
                path = self.id2path(file_id)
663
616
            mode = os.lstat(self.abspath(path)).st_mode
664
617
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
665
618
 
666
 
        _is_executable_from_path_and_stat = \
667
 
            _is_executable_from_path_and_stat_from_stat
668
 
 
669
619
    @needs_tree_write_lock
670
620
    def _add(self, files, ids, kinds):
671
621
        """See MutableTree._add."""
672
622
        # TODO: Re-adding a file that is removed in the working copy
673
623
        # should probably put it back with the previous ID.
674
 
        # the read and write working inventory should not occur in this
 
624
        # the read and write working inventory should not occur in this 
675
625
        # function - they should be part of lock_write and unlock.
676
626
        inv = self.inventory
677
627
        for f, file_id, kind in zip(files, ids, kinds):
 
628
            assert kind is not None
678
629
            if file_id is None:
679
630
                inv.add_path(f, kind=kind)
680
631
            else:
 
632
                file_id = osutils.safe_file_id(file_id)
681
633
                inv.add_path(f, kind=kind, file_id=file_id)
682
634
            self._inventory_is_modified = True
683
635
 
745
697
        if updated:
746
698
            self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
747
699
 
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))
 
700
    @deprecated_method(zero_eleven)
 
701
    @needs_read_lock
 
702
    def pending_merges(self):
 
703
        """Return a list of pending merges.
 
704
 
 
705
        These are revisions that have been merged into the working
 
706
        directory but not yet committed.
 
707
 
 
708
        As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
 
709
        instead - which is available on all tree objects.
 
710
        """
 
711
        return self.get_parent_ids()[1:]
781
712
 
782
713
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
783
714
        """Common ghost checking functionality from set_parent_*.
793
724
 
794
725
    def _set_merges_from_parent_ids(self, parent_ids):
795
726
        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
 
727
        self._control_files.put_bytes('pending-merges', '\n'.join(merges))
817
728
 
818
729
    @needs_tree_write_lock
819
730
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
820
731
        """Set the parent ids to revision_ids.
821
 
 
 
732
        
822
733
        See also set_parent_trees. This api will try to retrieve the tree data
823
734
        for each element of revision_ids from the trees repository. If you have
824
735
        tree data already available, it is more efficient to use
828
739
        :param revision_ids: The revision_ids to set as the parent ids of this
829
740
            working tree. Any of these may be ghosts.
830
741
        """
 
742
        revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
831
743
        self._check_parents_for_ghosts(revision_ids,
832
744
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
833
745
        for revision_id in revision_ids:
834
746
            _mod_revision.check_not_reserved_id(revision_id)
835
747
 
836
 
        revision_ids = self._filter_parent_ids_by_ancestry(revision_ids)
837
 
 
838
748
        if len(revision_ids) > 0:
839
749
            self.set_last_revision(revision_ids[0])
840
750
        else:
845
755
    @needs_tree_write_lock
846
756
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
847
757
        """See MutableTree.set_parent_trees."""
848
 
        parent_ids = [rev for (rev, tree) in parents_list]
 
758
        parent_ids = [osutils.safe_revision_id(rev) for (rev, tree) in parents_list]
849
759
        for revision_id in parent_ids:
850
760
            _mod_revision.check_not_reserved_id(revision_id)
851
761
 
852
762
        self._check_parents_for_ghosts(parent_ids,
853
763
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
854
764
 
855
 
        parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
856
 
 
857
765
        if len(parent_ids) == 0:
858
766
            leftmost_parent_id = _mod_revision.NULL_REVISION
859
767
            leftmost_parent_tree = None
886
794
                yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
887
795
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
888
796
 
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
797
    def _put_rio(self, filename, stanzas, header):
900
798
        self._must_be_locked()
901
799
        my_file = rio_file(stanzas, header)
902
 
        self._transport.put_file(filename, my_file,
903
 
            mode=self.bzrdir._get_file_mode())
 
800
        self._control_files.put(filename, my_file)
904
801
 
905
802
    @needs_write_lock # because merge pulls data into the branch.
906
 
    def merge_from_branch(self, branch, to_revision=None, from_revision=None,
907
 
                          merge_type=None, force=False):
 
803
    def merge_from_branch(self, branch, to_revision=None):
908
804
        """Merge from a branch into this working tree.
909
805
 
910
806
        :param branch: The branch to merge from.
914
810
            branch.last_revision().
915
811
        """
916
812
        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:
 
813
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
814
        try:
 
815
            merger = Merger(self.branch, this_tree=self, pb=pb)
 
816
            merger.pp = ProgressPhase("Merge phase", 5, pb)
 
817
            merger.pp.next_phase()
 
818
            # check that there are no
 
819
            # local alterations
 
820
            merger.check_basis(check_clean=True, require_commits=False)
 
821
            if to_revision is None:
 
822
                to_revision = _mod_revision.ensure_null(branch.last_revision())
 
823
            else:
 
824
                to_revision = osutils.safe_revision_id(to_revision)
 
825
            merger.other_rev_id = to_revision
 
826
            if _mod_revision.is_null(merger.other_rev_id):
 
827
                raise errors.NoCommits(branch)
 
828
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
829
            merger.other_basis = merger.other_rev_id
 
830
            merger.other_tree = self.branch.repository.revision_tree(
 
831
                merger.other_rev_id)
 
832
            merger.other_branch = branch
 
833
            merger.pp.next_phase()
932
834
            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:
 
835
            if merger.base_rev_id == merger.other_rev_id:
 
836
                raise errors.PointlessMerge
 
837
            merger.backup_files = False
939
838
            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()
 
839
            merger.set_interesting_files(None)
 
840
            merger.show_base = False
 
841
            merger.reprocess = False
 
842
            conflicts = merger.do_merge()
 
843
            merger.set_pending()
 
844
        finally:
 
845
            pb.finished()
947
846
        return conflicts
948
847
 
949
848
    @needs_read_lock
950
849
    def merge_modified(self):
951
850
        """Return a dictionary of files modified by a merge.
952
851
 
953
 
        The list is initialized by WorkingTree.set_merge_modified, which is
 
852
        The list is initialized by WorkingTree.set_merge_modified, which is 
954
853
        typically called after we make some automatic updates to the tree
955
854
        because of a merge.
956
855
 
958
857
        still in the working inventory and have that text hash.
959
858
        """
960
859
        try:
961
 
            hashfile = self._transport.get('merge-hashes')
 
860
            hashfile = self._control_files.get('merge-hashes')
962
861
        except errors.NoSuchFile:
963
862
            return {}
 
863
        merge_hashes = {}
964
864
        try:
965
 
            merge_hashes = {}
966
 
            try:
967
 
                if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
968
 
                    raise errors.MergeModifiedFormatError()
969
 
            except StopIteration:
 
865
            if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
970
866
                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()
 
867
        except StopIteration:
 
868
            raise errors.MergeModifiedFormatError()
 
869
        for s in RioReader(hashfile):
 
870
            # RioReader reads in Unicode, so convert file_ids back to utf8
 
871
            file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
 
872
            if file_id not in self.inventory:
 
873
                continue
 
874
            text_hash = s.get("hash")
 
875
            if text_hash == self.get_file_sha1(file_id):
 
876
                merge_hashes[file_id] = text_hash
 
877
        return merge_hashes
982
878
 
983
879
    @needs_write_lock
984
880
    def mkdir(self, path, file_id=None):
990
886
        return file_id
991
887
 
992
888
    def get_symlink_target(self, file_id):
993
 
        abspath = self.id2abspath(file_id)
994
 
        target = osutils.readlink(abspath)
995
 
        return target
 
889
        file_id = osutils.safe_file_id(file_id)
 
890
        return os.readlink(self.id2abspath(file_id))
996
891
 
997
892
    @needs_write_lock
998
893
    def subsume(self, other_tree):
1036
931
            other_tree.unlock()
1037
932
        other_tree.bzrdir.retire_bzrdir()
1038
933
 
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
934
    @needs_tree_write_lock
1066
935
    def extract(self, file_id, format=None):
1067
936
        """Extract a subtree from this tree.
1068
 
 
 
937
        
1069
938
        A new branch will be created, relative to the path for this tree.
1070
939
        """
1071
940
        self.flush()
1076
945
                transport = transport.clone(name)
1077
946
                transport.ensure_base()
1078
947
            return transport
1079
 
 
 
948
            
1080
949
        sub_path = self.id2path(file_id)
1081
950
        branch_transport = mkdirs(sub_path)
1082
951
        if format is None:
1083
 
            format = self.bzrdir.cloning_metadir()
 
952
            format = bzrdir.format_registry.make_bzrdir('dirstate-with-subtree')
1084
953
        branch_transport.ensure_base()
1085
954
        branch_bzrdir = format.initialize_on_transport(branch_transport)
1086
955
        try:
1087
956
            repo = branch_bzrdir.find_repository()
1088
957
        except errors.NoRepositoryPresent:
1089
958
            repo = branch_bzrdir.create_repository()
1090
 
        if not repo.supports_rich_root():
1091
 
            raise errors.RootNotRich()
 
959
            assert repo.supports_rich_root()
 
960
        else:
 
961
            if not repo.supports_rich_root():
 
962
                raise errors.RootNotRich()
1092
963
        new_branch = branch_bzrdir.create_branch()
1093
964
        new_branch.pull(self.branch)
1094
965
        for parent_id in self.get_parent_ids():
1096
967
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
1097
968
        if tree_transport.base != branch_transport.base:
1098
969
            tree_bzrdir = format.initialize_on_transport(tree_transport)
1099
 
            branch.BranchReferenceFormat().initialize(tree_bzrdir,
1100
 
                target_branch=new_branch)
 
970
            branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1101
971
        else:
1102
972
            tree_bzrdir = branch_bzrdir
1103
 
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
 
973
        wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1104
974
        wt.set_parent_ids(self.get_parent_ids())
1105
975
        my_inv = self.inventory
1106
 
        child_inv = inventory.Inventory(root_id=None)
 
976
        child_inv = Inventory(root_id=None)
1107
977
        new_root = my_inv[file_id]
1108
978
        my_inv.remove_recursive_id(file_id)
1109
979
        new_root.parent_id = None
1113
983
        return wt
1114
984
 
1115
985
    def _serialize(self, inventory, out_file):
1116
 
        xml5.serializer_v5.write_inventory(self._inventory, out_file,
1117
 
            working=True)
 
986
        xml5.serializer_v5.write_inventory(self._inventory, out_file)
1118
987
 
1119
988
    def _deserialize(selt, in_file):
1120
989
        return xml5.serializer_v5.read_inventory(in_file)
1127
996
        sio = StringIO()
1128
997
        self._serialize(self._inventory, sio)
1129
998
        sio.seek(0)
1130
 
        self._transport.put_file('inventory', sio,
1131
 
            mode=self.bzrdir._get_file_mode())
 
999
        self._control_files.put('inventory', sio)
1132
1000
        self._inventory_is_modified = False
1133
1001
 
1134
1002
    def _kind(self, relpath):
1135
1003
        return osutils.file_kind(self.abspath(relpath))
1136
1004
 
1137
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
1138
 
        """List all files as (path, class, kind, id, entry).
 
1005
    def list_files(self, include_root=False):
 
1006
        """Recursively list all files as (path, class, kind, id, entry).
1139
1007
 
1140
1008
        Lists, but does not descend into unversioned directories.
 
1009
 
1141
1010
        This does not include files that have been deleted in this
1142
 
        tree. Skips the control directory.
 
1011
        tree.
1143
1012
 
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
 
1013
        Skips the control directory.
1147
1014
        """
1148
1015
        # list_files is an iterator, so @needs_read_lock doesn't work properly
1149
1016
        # with it. So callers should be careful to always read_lock the tree.
1151
1018
            raise errors.ObjectNotLocked(self)
1152
1019
 
1153
1020
        inv = self.inventory
1154
 
        if from_dir is None and include_root is True:
 
1021
        if include_root is True:
1155
1022
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1156
1023
        # Convert these into local objects to save lookup times
1157
1024
        pathjoin = osutils.pathjoin
1164
1031
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1165
1032
 
1166
1033
        # 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)
 
1034
        children = os.listdir(self.basedir)
1177
1035
        children.sort()
1178
 
        # jam 20060527 The kernel sized tree seems equivalent whether we
 
1036
        # jam 20060527 The kernel sized tree seems equivalent whether we 
1179
1037
        # use a deque and popleft to keep them sorted, or if we use a plain
1180
1038
        # list and just reverse() them.
1181
1039
        children = collections.deque(children)
1182
 
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
 
1040
        stack = [(inv.root.file_id, u'', self.basedir, children)]
1183
1041
        while stack:
1184
1042
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1185
1043
 
1201
1059
 
1202
1060
                # absolute path
1203
1061
                fap = from_dir_abspath + '/' + f
1204
 
 
 
1062
                
1205
1063
                f_ie = inv.get_child(from_dir_id, f)
1206
1064
                if f_ie:
1207
1065
                    c = 'V'
1239
1097
                    except KeyError:
1240
1098
                        yield fp[1:], c, fk, None, TreeEntry()
1241
1099
                    continue
1242
 
 
 
1100
                
1243
1101
                if fk != 'directory':
1244
1102
                    continue
1245
1103
 
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
 
1104
                # But do this child first
 
1105
                new_children = os.listdir(fap)
 
1106
                new_children.sort()
 
1107
                new_children = collections.deque(new_children)
 
1108
                stack.append((f_ie.file_id, fp, fap, new_children))
 
1109
                # Break out of inner loop,
 
1110
                # so that we start outer loop with child
 
1111
                break
1255
1112
            else:
1256
1113
                # if we finished all children, pop it off the stack
1257
1114
                stack.pop()
1263
1120
        to_dir must exist in the inventory.
1264
1121
 
1265
1122
        If to_dir exists and is a directory, the files are moved into
1266
 
        it, keeping their old names.
 
1123
        it, keeping their old names.  
1267
1124
 
1268
1125
        Note that to_dir is only the last component of the new name;
1269
1126
        this doesn't change the directory.
1306
1163
                                       DeprecationWarning)
1307
1164
 
1308
1165
        # check destination directory
1309
 
        if isinstance(from_paths, basestring):
1310
 
            raise ValueError()
 
1166
        assert not isinstance(from_paths, basestring)
1311
1167
        inv = self.inventory
1312
1168
        to_abs = self.abspath(to_dir)
1313
1169
        if not isdir(to_abs):
1397
1253
                only_change_inv = True
1398
1254
            elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1399
1255
                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
1256
            else:
1405
1257
                # something is wrong, so lets determine what exactly
1406
1258
                if not self.has_filename(from_rel) and \
1409
1261
                        errors.PathsDoNotExist(paths=(str(from_rel),
1410
1262
                        str(to_rel))))
1411
1263
                else:
1412
 
                    raise errors.RenameFailedFilesExist(from_rel, to_rel)
 
1264
                    raise errors.RenameFailedFilesExist(from_rel, to_rel,
 
1265
                        extra="(Use --after to update the Bazaar id)")
1413
1266
            rename_entry.only_change_inv = only_change_inv
1414
1267
        return rename_entries
1415
1268
 
1435
1288
        inv = self.inventory
1436
1289
        for entry in moved:
1437
1290
            try:
1438
 
                self._move_entry(WorkingTree._RenameEntry(
1439
 
                    entry.to_rel, entry.from_id,
 
1291
                self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1440
1292
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
1441
1293
                    entry.from_tail, entry.from_parent_id,
1442
1294
                    entry.only_change_inv))
1493
1345
        from_tail = splitpath(from_rel)[-1]
1494
1346
        from_id = inv.path2id(from_rel)
1495
1347
        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]
 
1348
            raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1349
                errors.NotVersionedError(path=str(from_rel)))
 
1350
        from_entry = inv[from_id]
1507
1351
        from_parent_id = from_entry.parent_id
1508
1352
        to_dir, to_tail = os.path.split(to_rel)
1509
1353
        to_dir_id = inv.path2id(to_dir)
1555
1399
        These are files in the working directory that are not versioned or
1556
1400
        control files or ignored.
1557
1401
        """
1558
 
        # force the extras method to be fully executed before returning, to
 
1402
        # force the extras method to be fully executed before returning, to 
1559
1403
        # prevent race conditions with the lock
1560
1404
        return iter(
1561
1405
            [subp for subp in self.extras() if not self.is_ignored(subp)])
1571
1415
        :raises: NoSuchId if any fileid is not currently versioned.
1572
1416
        """
1573
1417
        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:
 
1418
            file_id = osutils.safe_file_id(file_id)
1577
1419
            if self._inventory.has_id(file_id):
1578
1420
                self._inventory.remove_recursive_id(file_id)
 
1421
            else:
 
1422
                raise errors.NoSuchId(self, file_id)
1579
1423
        if len(file_ids):
1580
 
            # in the future this should just set a dirty bit to wait for the
 
1424
            # in the future this should just set a dirty bit to wait for the 
1581
1425
            # final unlock. However, until all methods of workingtree start
1582
 
            # with the current in -memory inventory rather than triggering
 
1426
            # with the current in -memory inventory rather than triggering 
1583
1427
            # a read, it is more complex - we need to teach read_inventory
1584
1428
            # to know when to read, and when to not read first... and possibly
1585
1429
            # to save first when the in memory one may be corrupted.
1586
1430
            # so for now, we just only write it if it is indeed dirty.
1587
1431
            # - RBC 20060907
1588
1432
            self._write_inventory(self._inventory)
 
1433
    
 
1434
    @deprecated_method(zero_eight)
 
1435
    def iter_conflicts(self):
 
1436
        """List all files in the tree that have text or content conflicts.
 
1437
        DEPRECATED.  Use conflicts instead."""
 
1438
        return self._iter_conflicts()
1589
1439
 
1590
1440
    def _iter_conflicts(self):
1591
1441
        conflicted = set()
1600
1450
 
1601
1451
    @needs_write_lock
1602
1452
    def pull(self, source, overwrite=False, stop_revision=None,
1603
 
             change_reporter=None, possible_transports=None, local=False):
 
1453
             change_reporter=None):
 
1454
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1604
1455
        source.lock_read()
1605
1456
        try:
 
1457
            pp = ProgressPhase("Pull phase", 2, top_pb)
 
1458
            pp.next_phase()
1606
1459
            old_revision_info = self.branch.last_revision_info()
1607
1460
            basis_tree = self.basis_tree()
1608
 
            count = self.branch.pull(source, overwrite, stop_revision,
1609
 
                                     possible_transports=possible_transports,
1610
 
                                     local=local)
 
1461
            count = self.branch.pull(source, overwrite, stop_revision)
1611
1462
            new_revision_info = self.branch.last_revision_info()
1612
1463
            if new_revision_info != old_revision_info:
 
1464
                pp.next_phase()
1613
1465
                repository = self.branch.repository
 
1466
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
1614
1467
                basis_tree.lock_read()
1615
1468
                try:
1616
1469
                    new_basis_tree = self.branch.basis_tree()
1619
1472
                                new_basis_tree,
1620
1473
                                basis_tree,
1621
1474
                                this_tree=self,
1622
 
                                pb=None,
 
1475
                                pb=pb,
1623
1476
                                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)
 
1477
                    if (basis_tree.inventory.root is None and
 
1478
                        new_basis_tree.inventory.root is not None):
 
1479
                        self.set_root_id(new_basis_tree.inventory.root.file_id)
1628
1480
                finally:
 
1481
                    pb.finished()
1629
1482
                    basis_tree.unlock()
1630
1483
                # TODO - dedup parents list with things merged by pull ?
1631
1484
                # reuse the revisiontree we merged against to set the new
1632
1485
                # tree data.
1633
1486
                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
 
1487
                # we have to pull the merge trees out again, because 
 
1488
                # merge_inner has set the ids. - this corner is not yet 
1636
1489
                # layered well enough to prevent double handling.
1637
1490
                # XXX TODO: Fix the double handling: telling the tree about
1638
1491
                # the already known parent data is wasteful.
1644
1497
            return count
1645
1498
        finally:
1646
1499
            source.unlock()
 
1500
            top_pb.finished()
1647
1501
 
1648
1502
    @needs_write_lock
1649
1503
    def put_file_bytes_non_atomic(self, file_id, bytes):
1650
1504
        """See MutableTree.put_file_bytes_non_atomic."""
 
1505
        file_id = osutils.safe_file_id(file_id)
1651
1506
        stream = file(self.id2abspath(file_id), 'wb')
1652
1507
        try:
1653
1508
            stream.write(bytes)
1675
1530
 
1676
1531
            fl = []
1677
1532
            for subf in os.listdir(dirabs):
1678
 
                if self.bzrdir.is_control_filename(subf):
 
1533
                if subf == '.bzr':
1679
1534
                    continue
1680
1535
                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)
 
1536
                    subf_norm, can_access = osutils.normalized_filename(subf)
1689
1537
                    if subf_norm != subf and can_access:
1690
1538
                        if subf_norm not in dir_entry.children:
1691
1539
                            fl.append(subf_norm)
1692
1540
                    else:
1693
1541
                        fl.append(subf)
1694
 
 
 
1542
            
1695
1543
            fl.sort()
1696
1544
            for subf in fl:
1697
1545
                subp = pathjoin(path, subf)
1713
1561
        if ignoreset is not None:
1714
1562
            return ignoreset
1715
1563
 
1716
 
        ignore_globs = set()
 
1564
        ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1717
1565
        ignore_globs.update(ignores.get_runtime_ignores())
1718
1566
        ignore_globs.update(ignores.get_user_ignores())
1719
1567
        if self.has_filename(bzrlib.IGNORE_FILENAME):
1734
1582
        r"""Check whether the filename matches an ignore pattern.
1735
1583
 
1736
1584
        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.
 
1585
        others match against only the last component.
1740
1586
 
1741
1587
        If the file is ignored, returns the pattern which caused it to
1742
1588
        be ignored, otherwise None.  So this can simply be used as a
1743
1589
        boolean if desired."""
1744
1590
        if getattr(self, '_ignoreglobster', None) is None:
1745
 
            self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
 
1591
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
1746
1592
        return self._ignoreglobster.match(filename)
1747
1593
 
1748
1594
    def kind(self, file_id):
1749
1595
        return file_kind(self.id2abspath(file_id))
1750
1596
 
1751
 
    def stored_kind(self, file_id):
1752
 
        """See Tree.stored_kind"""
1753
 
        return self.inventory[file_id].kind
1754
 
 
1755
1597
    def _comparison_data(self, entry, path):
1756
1598
        abspath = self.abspath(path)
1757
1599
        try:
1788
1630
    @needs_read_lock
1789
1631
    def _last_revision(self):
1790
1632
        """helper for get_parent_ids."""
1791
 
        return _mod_revision.ensure_null(self.branch.last_revision())
 
1633
        return self.branch.last_revision()
1792
1634
 
1793
1635
    def is_locked(self):
1794
1636
        return self._control_files.is_locked()
1839
1681
    def _reset_data(self):
1840
1682
        """Reset transient data that cannot be revalidated."""
1841
1683
        self._inventory_is_modified = False
1842
 
        f = self._transport.get('inventory')
1843
 
        try:
1844
 
            result = self._deserialize(f)
1845
 
        finally:
1846
 
            f.close()
 
1684
        result = self._deserialize(self._control_files.get('inventory'))
1847
1685
        self._set_inventory(result, dirty=False)
1848
1686
 
1849
1687
    @needs_tree_write_lock
1850
1688
    def set_last_revision(self, new_revision):
1851
1689
        """Change the last revision in the working tree."""
 
1690
        new_revision = osutils.safe_revision_id(new_revision)
1852
1691
        if self._change_last_revision(new_revision):
1853
1692
            self._cache_basis_inventory(new_revision)
1854
1693
 
1855
1694
    def _change_last_revision(self, new_revision):
1856
1695
        """Template method part of set_last_revision to perform the change.
1857
 
 
 
1696
        
1858
1697
        This is used to allow WorkingTree3 instances to not affect branch
1859
1698
        when their last revision is set.
1860
1699
        """
1870
1709
 
1871
1710
    def _write_basis_inventory(self, xml):
1872
1711
        """Write the basis inventory XML to the basis-inventory file"""
 
1712
        assert isinstance(xml, str), 'serialised xml must be bytestring.'
1873
1713
        path = self._basis_inventory_name()
1874
1714
        sio = StringIO(xml)
1875
 
        self._transport.put_file(path, sio,
1876
 
            mode=self.bzrdir._get_file_mode())
 
1715
        self._control_files.put(path, sio)
1877
1716
 
1878
1717
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
1879
1718
        """Create the text that will be saved in basis-inventory"""
1880
 
        inventory.revision_id = revision_id
 
1719
        # TODO: jam 20070209 This should be redundant, as the revision_id
 
1720
        #       as all callers should have already converted the revision_id to
 
1721
        #       utf8
 
1722
        inventory.revision_id = osutils.safe_revision_id(revision_id)
1881
1723
        return xml7.serializer_v7.write_inventory_to_string(inventory)
1882
1724
 
1883
1725
    def _cache_basis_inventory(self, new_revision):
1886
1728
        # as commit already has that ready-to-use [while the format is the
1887
1729
        # same, that is].
1888
1730
        try:
1889
 
            # this double handles the inventory - unpack and repack -
 
1731
            # this double handles the inventory - unpack and repack - 
1890
1732
            # but is easier to understand. We can/should put a conditional
1891
1733
            # in here based on whether the inventory is in the latest format
1892
1734
            # - perhaps we should repack all inventories on a repository
1893
1735
            # upgrade ?
1894
1736
            # the fast path is to copy the raw xml from the repository. If the
1895
 
            # xml contains 'revision_id="', then we assume the right
 
1737
            # xml contains 'revision_id="', then we assume the right 
1896
1738
            # revision_id is set. We must check for this full string, because a
1897
1739
            # root node id can legitimately look like 'revision_id' but cannot
1898
1740
            # contain a '"'.
1899
 
            xml = self.branch.repository._get_inventory_xml(new_revision)
 
1741
            xml = self.branch.repository.get_inventory_xml(new_revision)
1900
1742
            firstline = xml.split('\n', 1)[0]
1901
 
            if (not 'revision_id="' in firstline or
 
1743
            if (not 'revision_id="' in firstline or 
1902
1744
                'format="7"' not in firstline):
1903
 
                inv = self.branch.repository._serializer.read_inventory_from_string(
1904
 
                    xml, new_revision)
 
1745
                inv = self.branch.repository.deserialise_inventory(
 
1746
                    new_revision, xml)
1905
1747
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
1906
1748
            self._write_basis_inventory(xml)
1907
1749
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1910
1752
    def read_basis_inventory(self):
1911
1753
        """Read the cached basis inventory."""
1912
1754
        path = self._basis_inventory_name()
1913
 
        return self._transport.get_bytes(path)
1914
 
 
 
1755
        return self._control_files.get(path).read()
 
1756
        
1915
1757
    @needs_read_lock
1916
1758
    def read_working_inventory(self):
1917
1759
        """Read the working inventory.
1918
 
 
 
1760
        
1919
1761
        :raises errors.InventoryModified: read_working_inventory will fail
1920
1762
            when the current in memory inventory has been modified.
1921
1763
        """
1922
 
        # conceptually this should be an implementation detail of the tree.
 
1764
        # conceptually this should be an implementation detail of the tree. 
1923
1765
        # XXX: Deprecate this.
1924
1766
        # ElementTree does its own conversion from UTF-8, so open in
1925
1767
        # binary.
1926
1768
        if self._inventory_is_modified:
1927
1769
            raise errors.InventoryModified(self)
1928
 
        f = self._transport.get('inventory')
1929
 
        try:
1930
 
            result = self._deserialize(f)
1931
 
        finally:
1932
 
            f.close()
 
1770
        result = self._deserialize(self._control_files.get('inventory'))
1933
1771
        self._set_inventory(result, dirty=False)
1934
1772
        return result
1935
1773
 
1943
1781
        :force: Delete files and directories, even if they are changed and
1944
1782
            even if the directories are not empty.
1945
1783
        """
 
1784
        ## TODO: Normalize names
 
1785
 
1946
1786
        if isinstance(files, basestring):
1947
1787
            files = [files]
1948
1788
 
1949
1789
        inv_delta = []
1950
1790
 
1951
1791
        new_files=set()
1952
 
        unknown_nested_files=set()
1953
 
        if to_file is None:
1954
 
            to_file = sys.stdout
 
1792
        unknown_files_in_directory=set()
1955
1793
 
1956
1794
        def recurse_directory_to_add_files(directory):
1957
 
            # Recurse directory and add all files
 
1795
            # recurse directory and add all files
1958
1796
            # so we can check if they have changed.
1959
1797
            for parent_info, file_infos in\
1960
 
                self.walkdirs(directory):
1961
 
                for relpath, basename, kind, lstat, fileid, kind in file_infos:
1962
 
                    # Is it versioned or ignored?
1963
 
                    if self.path2id(relpath) or self.is_ignored(relpath):
1964
 
                        # Add nested content for deletion.
1965
 
                        new_files.add(relpath)
1966
 
                    else:
1967
 
                        # Files which are not versioned and not ignored
1968
 
                        # should be treated as unknown.
1969
 
                        unknown_nested_files.add((relpath, None, kind))
 
1798
                osutils.walkdirs(self.abspath(directory),
 
1799
                    directory):
 
1800
                for relpath, basename, kind, lstat, abspath in file_infos:
 
1801
                    if kind == 'file':
 
1802
                        if self.path2id(relpath): #is it versioned?
 
1803
                            new_files.add(relpath)
 
1804
                        else:
 
1805
                            unknown_files_in_directory.add(
 
1806
                                (relpath, None, kind))
1970
1807
 
1971
1808
        for filename in files:
1972
1809
            # Get file name into canonical form.
1974
1811
            filename = self.relpath(abspath)
1975
1812
            if len(filename) > 0:
1976
1813
                new_files.add(filename)
1977
 
                recurse_directory_to_add_files(filename)
1978
 
 
1979
 
        files = list(new_files)
 
1814
                if osutils.isdir(abspath):
 
1815
                    recurse_directory_to_add_files(filename)
 
1816
        files = [f for f in new_files]
1980
1817
 
1981
1818
        if len(files) == 0:
1982
1819
            return # nothing to do
1983
1820
 
1984
1821
        # Sort needed to first handle directory content before the directory
1985
1822
        files.sort(reverse=True)
1986
 
 
1987
 
        # Bail out if we are going to delete files we shouldn't
1988
1823
        if not keep_files and not force:
1989
 
            has_changed_files = len(unknown_nested_files) > 0
 
1824
            has_changed_files = len(unknown_files_in_directory) > 0
1990
1825
            if not has_changed_files:
1991
1826
                for (file_id, path, content_change, versioned, parent_id, name,
1992
 
                     kind, executable) in self.iter_changes(self.basis_tree(),
 
1827
                     kind, executable) in self._iter_changes(self.basis_tree(),
1993
1828
                         include_unchanged=True, require_versioned=False,
1994
1829
                         want_unversioned=True, specific_files=files):
1995
 
                    if versioned == (False, False):
1996
 
                        # The record is unknown ...
1997
 
                        if not self.is_ignored(path[1]):
1998
 
                            # ... but not ignored
1999
 
                            has_changed_files = True
2000
 
                            break
2001
 
                    elif content_change and (kind[1] is not None):
2002
 
                        # Versioned and changed, but not deleted
 
1830
                    # check if it's unknown OR changed but not deleted:
 
1831
                    if (versioned == (False, False)
 
1832
                        or (content_change and kind[1] != None)):
2003
1833
                        has_changed_files = True
2004
1834
                        break
2005
1835
 
2006
1836
            if has_changed_files:
2007
 
                # Make delta show ALL applicable changes in error message.
 
1837
                # make delta to show ALL applicable changes in error message.
2008
1838
                tree_delta = self.changes_from(self.basis_tree(),
2009
 
                    require_versioned=False, want_unversioned=True,
2010
1839
                    specific_files=files)
2011
 
                for unknown_file in unknown_nested_files:
2012
 
                    if unknown_file not in tree_delta.unversioned:
2013
 
                        tree_delta.unversioned.extend((unknown_file,))
 
1840
                for unknown_file in unknown_files_in_directory:
 
1841
                    tree_delta.unversioned.extend((unknown_file,))
2014
1842
                raise errors.BzrRemoveChangedFilesError(tree_delta)
2015
1843
 
2016
 
        # Build inv_delta and delete files where applicable,
2017
 
        # do this before any modifications to inventory.
 
1844
        # do this before any modifications
2018
1845
        for f in files:
2019
1846
            fid = self.path2id(f)
2020
 
            message = None
 
1847
            message=None
2021
1848
            if not fid:
2022
 
                message = "%s is not versioned." % (f,)
 
1849
                message="%s is not versioned." % (f,)
2023
1850
            else:
2024
1851
                if verbose:
2025
1852
                    # having removed it, it must be either ignored or unknown
2027
1854
                        new_status = 'I'
2028
1855
                    else:
2029
1856
                        new_status = '?'
2030
 
                    # XXX: Really should be a more abstract reporter interface
2031
 
                    kind_ch = osutils.kind_marker(self.kind(fid))
2032
 
                    to_file.write(new_status + '       ' + f + kind_ch + '\n')
2033
 
                # Unversion file
 
1857
                    textui.show_status(new_status, self.kind(fid), f,
 
1858
                                       to_file=to_file)
 
1859
                # unversion file
2034
1860
                inv_delta.append((f, None, fid, None))
2035
 
                message = "removed %s" % (f,)
 
1861
                message="removed %s" % (f,)
2036
1862
 
2037
1863
            if not keep_files:
2038
1864
                abs_path = self.abspath(f)
2039
1865
                if osutils.lexists(abs_path):
2040
1866
                    if (osutils.isdir(abs_path) and
2041
1867
                        len(os.listdir(abs_path)) > 0):
2042
 
                        if force:
2043
 
                            osutils.rmtree(abs_path)
2044
 
                        else:
2045
 
                            message = "%s is not an empty directory "\
2046
 
                                "and won't be deleted." % (f,)
 
1868
                        message="%s is not empty directory "\
 
1869
                            "and won't be deleted." % (f,)
2047
1870
                    else:
2048
1871
                        osutils.delete_any(abs_path)
2049
 
                        message = "deleted %s" % (f,)
 
1872
                        message="deleted %s" % (f,)
2050
1873
                elif message is not None:
2051
 
                    # Only care if we haven't done anything yet.
2052
 
                    message = "%s does not exist." % (f,)
 
1874
                    # only care if we haven't done anything yet.
 
1875
                    message="%s does not exist." % (f,)
2053
1876
 
2054
 
            # Print only one message (if any) per file.
 
1877
            # print only one message (if any) per file.
2055
1878
            if message is not None:
2056
1879
                note(message)
2057
1880
        self.apply_inventory_delta(inv_delta)
2058
1881
 
2059
1882
    @needs_tree_write_lock
2060
 
    def revert(self, filenames=None, old_tree=None, backups=True,
2061
 
               pb=None, report_changes=False):
 
1883
    def revert(self, filenames, old_tree=None, backups=True, 
 
1884
               pb=DummyProgress(), report_changes=False):
2062
1885
        from bzrlib.conflicts import resolve
2063
 
        if filenames == []:
2064
 
            filenames = None
2065
 
            symbol_versioning.warn('Using [] to revert all files is deprecated'
2066
 
                ' as of bzr 0.91.  Please use None (the default) instead.',
2067
 
                DeprecationWarning, stacklevel=2)
2068
1886
        if old_tree is None:
2069
 
            basis_tree = self.basis_tree()
2070
 
            basis_tree.lock_read()
2071
 
            old_tree = basis_tree
 
1887
            old_tree = self.basis_tree()
 
1888
        conflicts = transform.revert(self, old_tree, filenames, backups, pb,
 
1889
                                     report_changes)
 
1890
        if not len(filenames):
 
1891
            self.set_parent_ids(self.get_parent_ids()[:1])
 
1892
            resolve(self)
2072
1893
        else:
2073
 
            basis_tree = None
2074
 
        try:
2075
 
            conflicts = transform.revert(self, old_tree, filenames, backups, pb,
2076
 
                                         report_changes)
2077
 
            if filenames is None and len(self.get_parent_ids()) > 1:
2078
 
                parent_trees = []
2079
 
                last_revision = self.last_revision()
2080
 
                if last_revision != _mod_revision.NULL_REVISION:
2081
 
                    if basis_tree is None:
2082
 
                        basis_tree = self.basis_tree()
2083
 
                        basis_tree.lock_read()
2084
 
                    parent_trees.append((last_revision, basis_tree))
2085
 
                self.set_parent_trees(parent_trees)
2086
 
                resolve(self)
2087
 
            else:
2088
 
                resolve(self, filenames, ignore_misses=True, recursive=True)
2089
 
        finally:
2090
 
            if basis_tree is not None:
2091
 
                basis_tree.unlock()
 
1894
            resolve(self, filenames, ignore_misses=True)
2092
1895
        return conflicts
2093
1896
 
2094
1897
    def revision_tree(self, revision_id):
2121
1924
    def set_inventory(self, new_inventory_list):
2122
1925
        from bzrlib.inventory import (Inventory,
2123
1926
                                      InventoryDirectory,
 
1927
                                      InventoryEntry,
2124
1928
                                      InventoryFile,
2125
1929
                                      InventoryLink)
2126
1930
        inv = Inventory(self.get_root_id())
2128
1932
            name = os.path.basename(path)
2129
1933
            if name == "":
2130
1934
                continue
2131
 
            # fixme, there should be a factory function inv,add_??
 
1935
            # fixme, there should be a factory function inv,add_?? 
2132
1936
            if kind == 'directory':
2133
1937
                inv.add(InventoryDirectory(file_id, name, parent))
2134
1938
            elif kind == 'file':
2142
1946
    @needs_tree_write_lock
2143
1947
    def set_root_id(self, file_id):
2144
1948
        """Set the root id for this tree."""
2145
 
        # for compatability
 
1949
        # for compatability 
2146
1950
        if file_id is None:
2147
 
            raise ValueError(
2148
 
                'WorkingTree.set_root_id with fileid=None')
2149
 
        file_id = osutils.safe_file_id(file_id)
 
1951
            symbol_versioning.warn(symbol_versioning.zero_twelve
 
1952
                % 'WorkingTree.set_root_id with fileid=None',
 
1953
                DeprecationWarning,
 
1954
                stacklevel=3)
 
1955
            file_id = ROOT_ID
 
1956
        else:
 
1957
            file_id = osutils.safe_file_id(file_id)
2150
1958
        self._set_root_id(file_id)
2151
1959
 
2152
1960
    def _set_root_id(self, file_id):
2153
1961
        """Set the root id for this tree, in a format specific manner.
2154
1962
 
2155
 
        :param file_id: The file id to assign to the root. It must not be
 
1963
        :param file_id: The file id to assign to the root. It must not be 
2156
1964
            present in the current inventory or an error will occur. It must
2157
1965
            not be None, but rather a valid file id.
2158
1966
        """
2177
1985
 
2178
1986
    def unlock(self):
2179
1987
        """See Branch.unlock.
2180
 
 
 
1988
        
2181
1989
        WorkingTree locking just uses the Branch locking facilities.
2182
1990
        This is current because all working trees have an embedded branch
2183
1991
        within them. IF in the future, we were to make branch data shareable
2184
 
        between multiple working trees, i.e. via shared storage, then we
 
1992
        between multiple working trees, i.e. via shared storage, then we 
2185
1993
        would probably want to lock both the local tree, and the branch.
2186
1994
        """
2187
1995
        raise NotImplementedError(self.unlock)
2188
1996
 
2189
 
    _marker = object()
2190
 
 
2191
 
    def update(self, change_reporter=None, possible_transports=None,
2192
 
               revision=None, old_tip=_marker):
 
1997
    def update(self, change_reporter=None):
2193
1998
        """Update a working tree along its branch.
2194
1999
 
2195
2000
        This will update the branch if its bound too, which means we have
2213
2018
        - Merge current state -> basis tree of the master w.r.t. the old tree
2214
2019
          basis.
2215
2020
        - Do a 'normal' merge of the old branch basis if it is relevant.
2216
 
 
2217
 
        :param revision: The target revision to update to. Must be in the
2218
 
            revision history.
2219
 
        :param old_tip: If branch.update() has already been run, the value it
2220
 
            returned (old tip of the branch or None). _marker is used
2221
 
            otherwise.
2222
2021
        """
2223
 
        if self.branch.get_bound_location() is not None:
 
2022
        if self.branch.get_master_branch() is not None:
2224
2023
            self.lock_write()
2225
 
            update_branch = (old_tip is self._marker)
 
2024
            update_branch = True
2226
2025
        else:
2227
2026
            self.lock_tree_write()
2228
2027
            update_branch = False
2229
2028
        try:
2230
2029
            if update_branch:
2231
 
                old_tip = self.branch.update(possible_transports)
 
2030
                old_tip = self.branch.update()
2232
2031
            else:
2233
 
                if old_tip is self._marker:
2234
 
                    old_tip = None
2235
 
            return self._update_tree(old_tip, change_reporter, revision)
 
2032
                old_tip = None
 
2033
            return self._update_tree(old_tip, change_reporter)
2236
2034
        finally:
2237
2035
            self.unlock()
2238
2036
 
2239
2037
    @needs_tree_write_lock
2240
 
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
 
2038
    def _update_tree(self, old_tip=None, change_reporter=None):
2241
2039
        """Update a tree to the master branch.
2242
2040
 
2243
2041
        :param old_tip: if supplied, the previous tip revision the branch,
2249
2047
        # cant set that until we update the working trees last revision to be
2250
2048
        # one from the new branch, because it will just get absorbed by the
2251
2049
        # parent de-duplication logic.
2252
 
        #
 
2050
        # 
2253
2051
        # We MUST save it even if an error occurs, because otherwise the users
2254
2052
        # local work is unreferenced and will appear to have been lost.
2255
 
        #
2256
 
        nb_conflicts = 0
 
2053
        # 
 
2054
        result = 0
2257
2055
        try:
2258
2056
            last_rev = self.get_parent_ids()[0]
2259
2057
        except IndexError:
2260
2058
            last_rev = _mod_revision.NULL_REVISION
2261
 
        if revision is None:
2262
 
            revision = self.branch.last_revision()
2263
 
 
2264
 
        old_tip = old_tip or _mod_revision.NULL_REVISION
2265
 
 
2266
 
        if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
2267
 
            # the branch we are bound to was updated
2268
 
            # merge those changes in first
2269
 
            base_tree  = self.basis_tree()
2270
 
            other_tree = self.branch.repository.revision_tree(old_tip)
2271
 
            nb_conflicts = merge.merge_inner(self.branch, other_tree,
2272
 
                                             base_tree, this_tree=self,
2273
 
                                             change_reporter=change_reporter)
2274
 
            if nb_conflicts:
2275
 
                self.add_parent_tree((old_tip, other_tree))
2276
 
                trace.note('Rerun update after fixing the conflicts.')
2277
 
                return nb_conflicts
2278
 
 
2279
 
        if last_rev != _mod_revision.ensure_null(revision):
2280
 
            # the working tree is up to date with the branch
2281
 
            # we can merge the specified revision from master
2282
 
            to_tree = self.branch.repository.revision_tree(revision)
2283
 
            to_root_id = to_tree.get_root_id()
2284
 
 
 
2059
        if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
 
2060
            # merge tree state up to new branch tip.
2285
2061
            basis = self.basis_tree()
2286
2062
            basis.lock_read()
2287
2063
            try:
2288
 
                if (basis.inventory.root is None
2289
 
                    or basis.inventory.root.file_id != to_root_id):
2290
 
                    self.set_root_id(to_root_id)
 
2064
                to_tree = self.branch.basis_tree()
 
2065
                if basis.inventory.root is None:
 
2066
                    self.set_root_id(to_tree.inventory.root.file_id)
2291
2067
                    self.flush()
 
2068
                result += merge.merge_inner(
 
2069
                                      self.branch,
 
2070
                                      to_tree,
 
2071
                                      basis,
 
2072
                                      this_tree=self,
 
2073
                                      change_reporter=change_reporter)
2292
2074
            finally:
2293
2075
                basis.unlock()
2294
 
 
2295
 
            # determine the branch point
2296
 
            graph = self.branch.repository.get_graph()
2297
 
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2298
 
                                                last_rev)
2299
 
            base_tree = self.branch.repository.revision_tree(base_rev_id)
2300
 
 
2301
 
            nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2302
 
                                             this_tree=self,
2303
 
                                             change_reporter=change_reporter)
2304
 
            self.set_last_revision(revision)
2305
2076
            # TODO - dedup parents list with things merged by pull ?
2306
2077
            # reuse the tree we've updated to to set the basis:
2307
 
            parent_trees = [(revision, to_tree)]
 
2078
            parent_trees = [(self.branch.last_revision(), to_tree)]
2308
2079
            merges = self.get_parent_ids()[1:]
2309
2080
            # Ideally we ask the tree for the trees here, that way the working
2310
 
            # tree can decide whether to give us the entire tree or give us a
 
2081
            # tree can decide whether to give us teh entire tree or give us a
2311
2082
            # lazy initialised tree. dirstate for instance will have the trees
2312
2083
            # in ram already, whereas a last-revision + basis-inventory tree
2313
2084
            # will not, but also does not need them when setting parents.
2314
2085
            for parent in merges:
2315
2086
                parent_trees.append(
2316
2087
                    (parent, self.branch.repository.revision_tree(parent)))
2317
 
            if not _mod_revision.is_null(old_tip):
 
2088
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2318
2089
                parent_trees.append(
2319
2090
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
2320
2091
            self.set_parent_trees(parent_trees)
2321
2092
            last_rev = parent_trees[0][0]
2322
 
        return nb_conflicts
 
2093
        else:
 
2094
            # the working tree had the same last-revision as the master
 
2095
            # branch did. We may still have pivot local work from the local
 
2096
            # branch into old_tip:
 
2097
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
 
2098
                self.add_parent_tree_id(old_tip)
 
2099
        if (old_tip is not None and not _mod_revision.is_null(old_tip)
 
2100
            and old_tip != last_rev):
 
2101
            # our last revision was not the prior branch last revision
 
2102
            # and we have converted that last revision to a pending merge.
 
2103
            # base is somewhere between the branch tip now
 
2104
            # and the now pending merge
 
2105
 
 
2106
            # Since we just modified the working tree and inventory, flush out
 
2107
            # the current state, before we modify it again.
 
2108
            # TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
 
2109
            #       requires it only because TreeTransform directly munges the
 
2110
            #       inventory and calls tree._write_inventory(). Ultimately we
 
2111
            #       should be able to remove this extra flush.
 
2112
            self.flush()
 
2113
            graph = self.branch.repository.get_graph()
 
2114
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
 
2115
                                                old_tip)
 
2116
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
2117
            other_tree = self.branch.repository.revision_tree(old_tip)
 
2118
            result += merge.merge_inner(
 
2119
                                  self.branch,
 
2120
                                  other_tree,
 
2121
                                  base_tree,
 
2122
                                  this_tree=self,
 
2123
                                  change_reporter=change_reporter)
 
2124
        return result
2323
2125
 
2324
2126
    def _write_hashcache_if_dirty(self):
2325
2127
        """Write out the hashcache if it is dirty."""
2409
2211
            current_inv = None
2410
2212
            inv_finished = True
2411
2213
        while not inv_finished or not disk_finished:
2412
 
            if current_disk:
2413
 
                ((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2414
 
                    cur_disk_dir_content) = current_disk
2415
 
            else:
2416
 
                ((cur_disk_dir_relpath, cur_disk_dir_path_from_top),
2417
 
                    cur_disk_dir_content) = ((None, None), None)
2418
2214
            if not disk_finished:
2419
2215
                # strip out .bzr dirs
2420
 
                if (cur_disk_dir_path_from_top[top_strip_len:] == '' and
2421
 
                    len(cur_disk_dir_content) > 0):
2422
 
                    # osutils.walkdirs can be made nicer -
 
2216
                if current_disk[0][1][top_strip_len:] == '':
 
2217
                    # osutils.walkdirs can be made nicer - 
2423
2218
                    # yield the path-from-prefix rather than the pathjoined
2424
2219
                    # value.
2425
 
                    bzrdir_loc = bisect_left(cur_disk_dir_content,
2426
 
                        ('.bzr', '.bzr'))
2427
 
                    if (bzrdir_loc < len(cur_disk_dir_content)
2428
 
                        and self.bzrdir.is_control_filename(
2429
 
                            cur_disk_dir_content[bzrdir_loc][0])):
 
2220
                    bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
 
2221
                    if current_disk[1][bzrdir_loc][0] == '.bzr':
2430
2222
                        # we dont yield the contents of, or, .bzr itself.
2431
 
                        del cur_disk_dir_content[bzrdir_loc]
 
2223
                        del current_disk[1][bzrdir_loc]
2432
2224
            if inv_finished:
2433
2225
                # everything is unknown
2434
2226
                direction = 1
2436
2228
                # everything is missing
2437
2229
                direction = -1
2438
2230
            else:
2439
 
                direction = cmp(current_inv[0][0], cur_disk_dir_relpath)
 
2231
                direction = cmp(current_inv[0][0], current_disk[0][0])
2440
2232
            if direction > 0:
2441
2233
                # disk is before inventory - unknown
2442
2234
                dirblock = [(relpath, basename, kind, stat, None, None) for
2443
 
                    relpath, basename, kind, stat, top_path in
2444
 
                    cur_disk_dir_content]
2445
 
                yield (cur_disk_dir_relpath, None), dirblock
 
2235
                    relpath, basename, kind, stat, top_path in current_disk[1]]
 
2236
                yield (current_disk[0][0], None), dirblock
2446
2237
                try:
2447
2238
                    current_disk = disk_iterator.next()
2448
2239
                except StopIteration:
2450
2241
            elif direction < 0:
2451
2242
                # inventory is before disk - missing.
2452
2243
                dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
2453
 
                    for relpath, basename, dkind, stat, fileid, kind in
 
2244
                    for relpath, basename, dkind, stat, fileid, kind in 
2454
2245
                    current_inv[1]]
2455
2246
                yield (current_inv[0][0], current_inv[0][1]), dirblock
2456
2247
                try:
2462
2253
                # merge the inventory and disk data together
2463
2254
                dirblock = []
2464
2255
                for relpath, subiterator in itertools.groupby(sorted(
2465
 
                    current_inv[1] + cur_disk_dir_content,
2466
 
                    key=operator.itemgetter(0)), operator.itemgetter(1)):
 
2256
                    current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
2467
2257
                    path_elements = list(subiterator)
2468
2258
                    if len(path_elements) == 2:
2469
2259
                        inv_row, disk_row = path_elements
2522
2312
                relroot = ""
2523
2313
            # FIXME: stash the node in pending
2524
2314
            entry = inv[top_id]
2525
 
            if entry.kind == 'directory':
2526
 
                for name, child in entry.sorted_children():
2527
 
                    dirblock.append((relroot + name, name, child.kind, None,
2528
 
                        child.file_id, child.kind
2529
 
                        ))
 
2315
            for name, child in entry.sorted_children():
 
2316
                dirblock.append((relroot + name, name, child.kind, None,
 
2317
                    child.file_id, child.kind
 
2318
                    ))
2530
2319
            yield (currentdir[0], entry.file_id), dirblock
2531
2320
            # push the user specified dirs from dirblock
2532
2321
            for dir in reversed(dirblock):
2565
2354
        self.set_conflicts(un_resolved)
2566
2355
        return un_resolved, resolved
2567
2356
 
2568
 
    @needs_read_lock
2569
 
    def _check(self, references):
2570
 
        """Check the tree for consistency.
2571
 
 
2572
 
        :param references: A dict with keys matching the items returned by
2573
 
            self._get_check_refs(), and values from looking those keys up in
2574
 
            the repository.
2575
 
        """
2576
 
        tree_basis = self.basis_tree()
2577
 
        tree_basis.lock_read()
2578
 
        try:
2579
 
            repo_basis = references[('trees', self.last_revision())]
2580
 
            if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2581
 
                raise errors.BzrCheckError(
2582
 
                    "Mismatched basis inventory content.")
2583
 
            self._validate()
2584
 
        finally:
2585
 
            tree_basis.unlock()
2586
 
 
2587
2357
    def _validate(self):
2588
2358
        """Validate internal structures.
2589
2359
 
2595
2365
        """
2596
2366
        return
2597
2367
 
2598
 
    def _get_rules_searcher(self, default_searcher):
2599
 
        """See Tree._get_rules_searcher."""
2600
 
        if self._rules_searcher is None:
2601
 
            self._rules_searcher = super(WorkingTree,
2602
 
                self)._get_rules_searcher(default_searcher)
2603
 
        return self._rules_searcher
2604
 
 
2605
 
    def get_shelf_manager(self):
2606
 
        """Return the ShelfManager for this WorkingTree."""
2607
 
        from bzrlib.shelf import ShelfManager
2608
 
        return ShelfManager(self, self._transport)
2609
 
 
2610
2368
 
2611
2369
class WorkingTree2(WorkingTree):
2612
2370
    """This is the Format 2 working tree.
2613
2371
 
2614
 
    This was the first weave based working tree.
 
2372
    This was the first weave based working tree. 
2615
2373
     - uses os locks for locking.
2616
2374
     - uses the branch last-revision.
2617
2375
    """
2627
2385
        if self._inventory is None:
2628
2386
            self.read_working_inventory()
2629
2387
 
2630
 
    def _get_check_refs(self):
2631
 
        """Return the references needed to perform a check of this tree."""
2632
 
        return [('trees', self.last_revision())]
2633
 
 
2634
2388
    def lock_tree_write(self):
2635
2389
        """See WorkingTree.lock_tree_write().
2636
2390
 
2645
2399
            raise
2646
2400
 
2647
2401
    def unlock(self):
2648
 
        # do non-implementation specific cleanup
2649
 
        self._cleanup()
2650
 
 
2651
2402
        # we share control files:
2652
2403
        if self._control_files._lock_count == 3:
2653
2404
            # _inventory_is_modified is always False during a read lock.
2654
2405
            if self._inventory_is_modified:
2655
2406
                self.flush()
2656
2407
            self._write_hashcache_if_dirty()
2657
 
 
 
2408
                    
2658
2409
        # reverse order of locking.
2659
2410
        try:
2660
2411
            return self._control_files.unlock()
2676
2427
    def _last_revision(self):
2677
2428
        """See Mutable.last_revision."""
2678
2429
        try:
2679
 
            return self._transport.get_bytes('last-revision')
 
2430
            return osutils.safe_revision_id(
 
2431
                        self._control_files.get('last-revision').read())
2680
2432
        except errors.NoSuchFile:
2681
 
            return _mod_revision.NULL_REVISION
 
2433
            return None
2682
2434
 
2683
2435
    def _change_last_revision(self, revision_id):
2684
2436
        """See WorkingTree._change_last_revision."""
2685
 
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
 
2437
        if revision_id is None or revision_id == NULL_REVISION:
2686
2438
            try:
2687
 
                self._transport.delete('last-revision')
 
2439
                self._control_files._transport.delete('last-revision')
2688
2440
            except errors.NoSuchFile:
2689
2441
                pass
2690
2442
            return False
2691
2443
        else:
2692
 
            self._transport.put_bytes('last-revision', revision_id,
2693
 
                mode=self.bzrdir._get_file_mode())
 
2444
            self._control_files.put_bytes('last-revision', revision_id)
2694
2445
            return True
2695
2446
 
2696
 
    def _get_check_refs(self):
2697
 
        """Return the references needed to perform a check of this tree."""
2698
 
        return [('trees', self.last_revision())]
2699
 
 
2700
2447
    @needs_tree_write_lock
2701
2448
    def set_conflicts(self, conflicts):
2702
 
        self._put_rio('conflicts', conflicts.to_stanzas(),
 
2449
        self._put_rio('conflicts', conflicts.to_stanzas(), 
2703
2450
                      CONFLICT_HEADER_1)
2704
2451
 
2705
2452
    @needs_tree_write_lock
2712
2459
    @needs_read_lock
2713
2460
    def conflicts(self):
2714
2461
        try:
2715
 
            confile = self._transport.get('conflicts')
 
2462
            confile = self._control_files.get('conflicts')
2716
2463
        except errors.NoSuchFile:
2717
2464
            return _mod_conflicts.ConflictList()
2718
2465
        try:
2719
 
            try:
2720
 
                if confile.next() != CONFLICT_HEADER_1 + '\n':
2721
 
                    raise errors.ConflictFormatError()
2722
 
            except StopIteration:
 
2466
            if confile.next() != CONFLICT_HEADER_1 + '\n':
2723
2467
                raise errors.ConflictFormatError()
2724
 
            return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2725
 
        finally:
2726
 
            confile.close()
 
2468
        except StopIteration:
 
2469
            raise errors.ConflictFormatError()
 
2470
        return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2727
2471
 
2728
2472
    def unlock(self):
2729
 
        # do non-implementation specific cleanup
2730
 
        self._cleanup()
2731
2473
        if self._control_files._lock_count == 1:
2732
2474
            # _inventory_is_modified is always False during a read lock.
2733
2475
            if self._inventory_is_modified:
2746
2488
            return path[:-len(suffix)]
2747
2489
 
2748
2490
 
 
2491
@deprecated_function(zero_eight)
 
2492
def is_control_file(filename):
 
2493
    """See WorkingTree.is_control_filename(filename)."""
 
2494
    ## FIXME: better check
 
2495
    filename = normpath(filename)
 
2496
    while filename != '':
 
2497
        head, tail = os.path.split(filename)
 
2498
        ## mutter('check %r for control file' % ((head, tail),))
 
2499
        if tail == '.bzr':
 
2500
            return True
 
2501
        if filename == head:
 
2502
            break
 
2503
        filename = head
 
2504
    return False
 
2505
 
 
2506
 
2749
2507
class WorkingTreeFormat(object):
2750
2508
    """An encapsulation of the initialization and open routines for a format.
2751
2509
 
2754
2512
     * a format string,
2755
2513
     * an open routine.
2756
2514
 
2757
 
    Formats are placed in an dict by their format string for reference
 
2515
    Formats are placed in an dict by their format string for reference 
2758
2516
    during workingtree opening. Its not required that these be instances, they
2759
 
    can be classes themselves with class methods - it simply depends on
 
2517
    can be classes themselves with class methods - it simply depends on 
2760
2518
    whether state is needed for a given format or not.
2761
2519
 
2762
2520
    Once a format is deprecated, just deprecate the initialize and open
2763
 
    methods on the format class. Do not deprecate the object, as the
 
2521
    methods on the format class. Do not deprecate the object, as the 
2764
2522
    object will be created every time regardless.
2765
2523
    """
2766
2524
 
2779
2537
        """Return the format for the working tree object in a_bzrdir."""
2780
2538
        try:
2781
2539
            transport = a_bzrdir.get_workingtree_transport(None)
2782
 
            format_string = transport.get_bytes("format")
 
2540
            format_string = transport.get("format").read()
2783
2541
            return klass._formats[format_string]
2784
2542
        except errors.NoSuchFile:
2785
2543
            raise errors.NoWorkingTree(base=transport.base)
2786
2544
        except KeyError:
2787
 
            raise errors.UnknownFormatError(format=format_string,
2788
 
                                            kind="working tree")
 
2545
            raise errors.UnknownFormatError(format=format_string)
2789
2546
 
2790
2547
    def __eq__(self, other):
2791
2548
        return self.__class__ is other.__class__
2810
2567
        """Is this format supported?
2811
2568
 
2812
2569
        Supported formats can be initialized and opened.
2813
 
        Unsupported formats may not support initialization or committing or
 
2570
        Unsupported formats may not support initialization or committing or 
2814
2571
        some other features depending on the reason for not being supported.
2815
2572
        """
2816
2573
        return True
2817
2574
 
2818
 
    def supports_content_filtering(self):
2819
 
        """True if this format supports content filtering."""
2820
 
        return False
2821
 
 
2822
 
    def supports_views(self):
2823
 
        """True if this format supports stored views."""
2824
 
        return False
2825
 
 
2826
2575
    @classmethod
2827
2576
    def register_format(klass, format):
2828
2577
        klass._formats[format.get_format_string()] = format
2833
2582
 
2834
2583
    @classmethod
2835
2584
    def unregister_format(klass, format):
 
2585
        assert klass._formats[format.get_format_string()] is format
2836
2586
        del klass._formats[format.get_format_string()]
2837
2587
 
2838
2588
 
2839
2589
class WorkingTreeFormat2(WorkingTreeFormat):
2840
 
    """The second working tree format.
 
2590
    """The second working tree format. 
2841
2591
 
2842
2592
    This format modified the hash cache from the format 1 hash cache.
2843
2593
    """
2848
2598
        """See WorkingTreeFormat.get_format_description()."""
2849
2599
        return "Working tree format 2"
2850
2600
 
2851
 
    def _stub_initialize_on_transport(self, transport, file_mode):
2852
 
        """Workaround: create control files for a remote working tree.
2853
 
 
 
2601
    def stub_initialize_remote(self, control_files):
 
2602
        """As a special workaround create critical control files for a remote working tree
 
2603
        
2854
2604
        This ensures that it can later be updated and dealt with locally,
2855
 
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
 
2605
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with 
2856
2606
        no working tree.  (See bug #43064).
2857
2607
        """
2858
2608
        sio = StringIO()
2859
 
        inv = inventory.Inventory()
2860
 
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
 
2609
        inv = Inventory()
 
2610
        xml5.serializer_v5.write_inventory(inv, sio)
2861
2611
        sio.seek(0)
2862
 
        transport.put_file('inventory', sio, file_mode)
2863
 
        transport.put_bytes('pending-merges', '', file_mode)
2864
 
 
2865
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2866
 
                   accelerator_tree=None, hardlink=False):
 
2612
        control_files.put('inventory', sio)
 
2613
 
 
2614
        control_files.put_bytes('pending-merges', '')
 
2615
        
 
2616
 
 
2617
    def initialize(self, a_bzrdir, revision_id=None):
2867
2618
        """See WorkingTreeFormat.initialize()."""
2868
2619
        if not isinstance(a_bzrdir.transport, LocalTransport):
2869
2620
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2870
 
        if from_branch is not None:
2871
 
            branch = from_branch
2872
 
        else:
2873
 
            branch = a_bzrdir.open_branch()
 
2621
        branch = a_bzrdir.open_branch()
2874
2622
        if revision_id is None:
2875
2623
            revision_id = _mod_revision.ensure_null(branch.last_revision())
 
2624
        else:
 
2625
            revision_id = osutils.safe_revision_id(revision_id)
2876
2626
        branch.lock_write()
2877
2627
        try:
2878
2628
            branch.generate_revision_history(revision_id)
2879
2629
        finally:
2880
2630
            branch.unlock()
2881
 
        inv = inventory.Inventory()
 
2631
        inv = Inventory()
2882
2632
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2883
2633
                         branch,
2884
2634
                         inv,
2887
2637
                         _bzrdir=a_bzrdir)
2888
2638
        basis_tree = branch.repository.revision_tree(revision_id)
2889
2639
        if basis_tree.inventory.root is not None:
2890
 
            wt.set_root_id(basis_tree.get_root_id())
 
2640
            wt.set_root_id(basis_tree.inventory.root.file_id)
2891
2641
        # set the parent list and cache the basis tree.
2892
2642
        if _mod_revision.is_null(revision_id):
2893
2643
            parent_trees = []
2929
2679
        - is new in bzr 0.8
2930
2680
        - uses a LockDir to guard access for writes.
2931
2681
    """
2932
 
 
 
2682
    
2933
2683
    upgrade_recommended = True
2934
2684
 
2935
2685
    def get_format_string(self):
2952
2702
 
2953
2703
    def _open_control_files(self, a_bzrdir):
2954
2704
        transport = a_bzrdir.get_workingtree_transport(None)
2955
 
        return LockableFiles(transport, self._lock_file_name,
 
2705
        return LockableFiles(transport, self._lock_file_name, 
2956
2706
                             self._lock_class)
2957
2707
 
2958
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2959
 
                   accelerator_tree=None, hardlink=False):
 
2708
    def initialize(self, a_bzrdir, revision_id=None):
2960
2709
        """See WorkingTreeFormat.initialize().
2961
 
 
2962
 
        :param revision_id: if supplied, create a working tree at a different
2963
 
            revision than the branch is at.
2964
 
        :param accelerator_tree: A tree which can be used for retrieving file
2965
 
            contents more quickly than the revision tree, i.e. a workingtree.
2966
 
            The revision tree will be used for cases where accelerator_tree's
2967
 
            content is different.
2968
 
        :param hardlink: If true, hard-link files from accelerator_tree,
2969
 
            where possible.
 
2710
        
 
2711
        revision_id allows creating a working tree at a different
 
2712
        revision than the branch is at.
2970
2713
        """
2971
2714
        if not isinstance(a_bzrdir.transport, LocalTransport):
2972
2715
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2974
2717
        control_files = self._open_control_files(a_bzrdir)
2975
2718
        control_files.create_lock()
2976
2719
        control_files.lock_write()
2977
 
        transport.put_bytes('format', self.get_format_string(),
2978
 
            mode=a_bzrdir._get_file_mode())
2979
 
        if from_branch is not None:
2980
 
            branch = from_branch
2981
 
        else:
2982
 
            branch = a_bzrdir.open_branch()
 
2720
        control_files.put_utf8('format', self.get_format_string())
 
2721
        branch = a_bzrdir.open_branch()
2983
2722
        if revision_id is None:
2984
2723
            revision_id = _mod_revision.ensure_null(branch.last_revision())
 
2724
        else:
 
2725
            revision_id = osutils.safe_revision_id(revision_id)
2985
2726
        # WorkingTree3 can handle an inventory which has a unique root id.
2986
2727
        # as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2987
2728
        # those trees. And because there isn't a format bump inbetween, we
3000
2741
            basis_tree = branch.repository.revision_tree(revision_id)
3001
2742
            # only set an explicit root id if there is one to set.
3002
2743
            if basis_tree.inventory.root is not None:
3003
 
                wt.set_root_id(basis_tree.get_root_id())
3004
 
            if revision_id == _mod_revision.NULL_REVISION:
 
2744
                wt.set_root_id(basis_tree.inventory.root.file_id)
 
2745
            if revision_id == NULL_REVISION:
3005
2746
                wt.set_parent_trees([])
3006
2747
            else:
3007
2748
                wt.set_parent_trees([(revision_id, basis_tree)])
3014
2755
        return wt
3015
2756
 
3016
2757
    def _initial_inventory(self):
3017
 
        return inventory.Inventory()
 
2758
        return Inventory()
3018
2759
 
3019
2760
    def __init__(self):
3020
2761
        super(WorkingTreeFormat3, self).__init__()
3035
2776
 
3036
2777
    def _open(self, a_bzrdir, control_files):
3037
2778
        """Open the tree itself.
3038
 
 
 
2779
        
3039
2780
        :param a_bzrdir: the dir for the tree.
3040
2781
        :param control_files: the control files for the tree.
3041
2782
        """
3049
2790
        return self.get_format_string()
3050
2791
 
3051
2792
 
3052
 
__default_format = WorkingTreeFormat6()
 
2793
__default_format = WorkingTreeFormat4()
3053
2794
WorkingTreeFormat.register_format(__default_format)
3054
 
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3055
 
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3056
2795
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3057
2796
WorkingTreeFormat.set_default_format(__default_format)
3058
2797
# formats which have no format string are not discoverable