/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: Martin Pool
  • Date: 2007-03-22 07:04:04 UTC
  • mto: (2323.5.2 0.15)
  • mto: This revision was merged to the branch mainline in revision 2390.
  • Revision ID: mbp@sourcefrog.net-20070322070404-zzhbluric9k4wox1
Move responsibility for suggesting upgrades to ui object

Show diffs side-by-side

added added

removed removed

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