/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: John Arbash Meinel
  • Date: 2007-03-29 14:07:49 UTC
  • mto: This revision was merged to the branch mainline in revision 2387.
  • Revision ID: john@arbash-meinel.com-20070329140749-8pb42n6lu0k96z3y
(Robert Widhopf-Fenk, bug #98591) Remove --verbose flag from 'bzr bundle'.
The old changeset code used to use --verbose to change the output format slightly.
By making a rename pair be a full delete + add. But it is no longer used, and
is not even a parameter for run() anymore.

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