~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Patch Queue Manager
  • Date: 2016-04-21 04:10:52 UTC
  • mfrom: (6616.1.1 fix-en-user-guide)
  • Revision ID: pqm@pqm.ubuntu.com-20160421041052-clcye7ns1qcl2n7w
(richard-wilbur) Ensure build of English use guide always uses English text
 even when user's locale specifies a different language. (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2005-2011 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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
from __future__ import absolute_import
38
33
 
39
34
from cStringIO import StringIO
40
35
import os
48
43
import itertools
49
44
import operator
50
45
import stat
51
 
from time import time
52
 
import warnings
53
46
import re
54
47
 
55
 
import bzrlib
56
48
from bzrlib import (
57
49
    branch,
58
 
    bzrdir,
59
50
    conflicts as _mod_conflicts,
60
 
    dirstate,
 
51
    controldir,
61
52
    errors,
 
53
    filters as _mod_filters,
62
54
    generate_ids,
63
55
    globbing,
64
 
    hashcache,
 
56
    graph as _mod_graph,
65
57
    ignores,
 
58
    inventory,
66
59
    merge,
67
60
    revision as _mod_revision,
68
61
    revisiontree,
69
 
    repository,
70
 
    textui,
71
 
    trace,
 
62
    rio as _mod_rio,
 
63
    shelf,
72
64
    transform,
 
65
    transport,
73
66
    ui,
74
 
    urlutils,
 
67
    views,
75
68
    xml5,
76
 
    xml6,
77
69
    xml7,
78
70
    )
79
 
import bzrlib.branch
80
 
from bzrlib.transport import get_transport
81
 
import bzrlib.ui
82
 
from bzrlib.workingtree_4 import WorkingTreeFormat4
83
71
""")
84
72
 
85
 
from bzrlib import symbol_versioning
 
73
# Explicitly import bzrlib.bzrdir so that the BzrProber
 
74
# is guaranteed to be registered.
 
75
from bzrlib import (
 
76
    bzrdir,
 
77
    symbol_versioning,
 
78
    )
 
79
 
86
80
from bzrlib.decorators import needs_read_lock, needs_write_lock
87
 
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID, TreeReference
88
 
from bzrlib.lockable_files import LockableFiles, TransportLock
89
 
from bzrlib.lockdir import LockDir
 
81
from bzrlib.i18n import gettext
 
82
from bzrlib.lock import LogicalLockResult
90
83
import bzrlib.mutabletree
91
84
from bzrlib.mutabletree import needs_tree_write_lock
92
85
from bzrlib import osutils
93
86
from bzrlib.osutils import (
94
 
    compact_date,
95
87
    file_kind,
96
88
    isdir,
97
89
    normpath,
98
90
    pathjoin,
99
 
    rand_chars,
100
91
    realpath,
101
92
    safe_unicode,
102
93
    splitpath,
103
 
    supports_executable,
104
94
    )
105
95
from bzrlib.trace import mutter, note
106
 
from bzrlib.transport.local import LocalTransport
107
 
from bzrlib.progress import DummyProgress, ProgressPhase
108
 
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
109
 
from bzrlib.rio import RioReader, rio_file, Stanza
110
 
from bzrlib.symbol_versioning import (deprecated_passed,
111
 
        deprecated_method,
112
 
        deprecated_function,
113
 
        DEPRECATED_PARAMETER,
114
 
        )
 
96
from bzrlib.revision import CURRENT_REVISION
 
97
from bzrlib.symbol_versioning import (
 
98
    deprecated_passed,
 
99
    DEPRECATED_PARAMETER,
 
100
    )
115
101
 
116
102
 
117
103
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
 
104
# TODO: Modifying the conflict objects or their type is currently nearly
 
105
# impossible as there is no clear relationship between the working tree format
 
106
# and the conflict list file format.
118
107
CONFLICT_HEADER_1 = "BZR conflict list format 1"
119
108
 
120
109
ERROR_PATH_NOT_FOUND = 3    # WindowsError errno code, equivalent to ENOENT
123
112
class TreeEntry(object):
124
113
    """An entry that implements the minimum interface used by commands.
125
114
 
126
 
    This needs further inspection, it may be better to have 
 
115
    This needs further inspection, it may be better to have
127
116
    InventoryEntries without ids - though that seems wrong. For now,
128
117
    this is a parallel hierarchy to InventoryEntry, and needs to become
129
118
    one of several things: decorates to that hierarchy, children of, or
132
121
    no InventoryEntry available - i.e. for unversioned objects.
133
122
    Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
134
123
    """
135
 
 
 
124
 
136
125
    def __eq__(self, other):
137
126
        # yes, this us ugly, TODO: best practice __eq__ style.
138
127
        return (isinstance(other, TreeEntry)
139
128
                and other.__class__ == self.__class__)
140
 
 
 
129
 
141
130
    def kind_character(self):
142
131
        return "???"
143
132
 
175
164
        return ''
176
165
 
177
166
 
178
 
class WorkingTree(bzrlib.mutabletree.MutableTree):
 
167
class WorkingTree(bzrlib.mutabletree.MutableTree,
 
168
    controldir.ControlComponent):
179
169
    """Working copy tree.
180
170
 
181
 
    The inventory is held in the `Branch` working-inventory, and the
182
 
    files are in a directory on disk.
183
 
 
184
 
    It is possible for a `WorkingTree` to have a filename which is
185
 
    not listed in the Inventory and vice versa.
 
171
    :ivar basedir: The root of the tree on disk. This is a unicode path object
 
172
        (as opposed to a URL).
186
173
    """
187
174
 
 
175
    # override this to set the strategy for storing views
 
176
    def _make_views(self):
 
177
        return views.DisabledViews(self)
 
178
 
188
179
    def __init__(self, basedir='.',
189
180
                 branch=DEPRECATED_PARAMETER,
190
 
                 _inventory=None,
191
 
                 _control_files=None,
192
181
                 _internal=False,
 
182
                 _transport=None,
193
183
                 _format=None,
194
184
                 _bzrdir=None):
195
185
        """Construct a WorkingTree instance. This is not a public API.
208
198
        else:
209
199
            self._branch = self.bzrdir.open_branch()
210
200
        self.basedir = realpath(basedir)
211
 
        # if branch is at our basedir and is a format 6 or less
212
 
        if isinstance(self._format, WorkingTreeFormat2):
213
 
            # share control object
214
 
            self._control_files = self.branch.control_files
215
 
        else:
216
 
            # assume all other formats have their own control files.
217
 
            self._control_files = _control_files
218
 
        self._transport = self._control_files._transport
219
 
        # update the whole cache up front and write to disk if anything changed;
220
 
        # in the future we might want to do this more selectively
221
 
        # two possible ways offer themselves : in self._unlock, write the cache
222
 
        # if needed, or, when the cache sees a change, append it to the hash
223
 
        # cache file, and have the parser take the most recent entry for a
224
 
        # given path only.
225
 
        wt_trans = self.bzrdir.get_workingtree_transport(None)
226
 
        cache_filename = wt_trans.local_abspath('stat-cache')
227
 
        self._hashcache = hashcache.HashCache(basedir, cache_filename,
228
 
            self.bzrdir._get_file_mode())
229
 
        hc = self._hashcache
230
 
        hc.read()
231
 
        # is this scan needed ? it makes things kinda slow.
232
 
        #hc.scan()
233
 
 
234
 
        if hc.needs_write:
235
 
            mutter("write hc")
236
 
            hc.write()
237
 
 
238
 
        if _inventory is None:
239
 
            # This will be acquired on lock_read() or lock_write()
240
 
            self._inventory_is_modified = False
241
 
            self._inventory = None
242
 
        else:
243
 
            # the caller of __init__ has provided an inventory,
244
 
            # we assume they know what they are doing - as its only
245
 
            # the Format factory and creation methods that are
246
 
            # permitted to do this.
247
 
            self._set_inventory(_inventory, dirty=False)
248
 
        self._detect_case_handling()
 
201
        self._transport = _transport
249
202
        self._rules_searcher = None
250
 
 
251
 
    def _detect_case_handling(self):
252
 
        wt_trans = self.bzrdir.get_workingtree_transport(None)
253
 
        try:
254
 
            wt_trans.stat("FoRMaT")
255
 
        except errors.NoSuchFile:
256
 
            self.case_sensitive = True
257
 
        else:
258
 
            self.case_sensitive = False
259
 
 
260
 
        self._setup_directory_is_tree_reference()
 
203
        self.views = self._make_views()
 
204
 
 
205
    @property
 
206
    def user_transport(self):
 
207
        return self.bzrdir.user_transport
 
208
 
 
209
    @property
 
210
    def control_transport(self):
 
211
        return self._transport
 
212
 
 
213
    def is_control_filename(self, filename):
 
214
        """True if filename is the name of a control file in this tree.
 
215
 
 
216
        :param filename: A filename within the tree. This is a relative path
 
217
            from the root of this tree.
 
218
 
 
219
        This is true IF and ONLY IF the filename is part of the meta data
 
220
        that bzr controls in this tree. I.E. a random .bzr directory placed
 
221
        on disk will not be a control file for this tree.
 
222
        """
 
223
        return self.bzrdir.is_control_filename(filename)
261
224
 
262
225
    branch = property(
263
226
        fget=lambda self: self._branch,
267
230
            the working tree has been constructed from.
268
231
            """)
269
232
 
 
233
    def has_versioned_directories(self):
 
234
        """See `Tree.has_versioned_directories`."""
 
235
        return self._format.supports_versioned_directories
 
236
 
 
237
    def _supports_executable(self):
 
238
        if sys.platform == 'win32':
 
239
            return False
 
240
        # FIXME: Ideally this should check the file system
 
241
        return True
 
242
 
270
243
    def break_lock(self):
271
244
        """Break a lock if one is present from another instance.
272
245
 
275
248
 
276
249
        This will probe the repository for its lock as well.
277
250
        """
278
 
        self._control_files.break_lock()
279
 
        self.branch.break_lock()
 
251
        raise NotImplementedError(self.break_lock)
280
252
 
281
253
    def requires_rich_root(self):
282
254
        return self._format.requires_rich_root
284
256
    def supports_tree_reference(self):
285
257
        return False
286
258
 
287
 
    def _set_inventory(self, inv, dirty):
288
 
        """Set the internal cached inventory.
289
 
 
290
 
        :param inv: The inventory to set.
291
 
        :param dirty: A boolean indicating whether the inventory is the same
292
 
            logical inventory as whats on disk. If True the inventory is not
293
 
            the same and should be written to disk or data will be lost, if
294
 
            False then the inventory is the same as that on disk and any
295
 
            serialisation would be unneeded overhead.
 
259
    def supports_content_filtering(self):
 
260
        return self._format.supports_content_filtering()
 
261
 
 
262
    def supports_views(self):
 
263
        return self.views.supports_views()
 
264
 
 
265
    def get_config_stack(self):
 
266
        """Retrieve the config stack for this tree.
 
267
 
 
268
        :return: A ``bzrlib.config.Stack``
296
269
        """
297
 
        self._inventory = inv
298
 
        self._inventory_is_modified = dirty
 
270
        # For the moment, just provide the branch config stack.
 
271
        return self.branch.get_config_stack()
299
272
 
300
273
    @staticmethod
301
274
    def open(path=None, _unsupported=False):
303
276
 
304
277
        """
305
278
        if path is None:
306
 
            path = os.path.getcwdu()
307
 
        control = bzrdir.BzrDir.open(path, _unsupported)
308
 
        return control.open_workingtree(_unsupported)
309
 
        
 
279
            path = osutils.getcwd()
 
280
        control = controldir.ControlDir.open(path, _unsupported=_unsupported)
 
281
        return control.open_workingtree(unsupported=_unsupported)
 
282
 
310
283
    @staticmethod
311
284
    def open_containing(path=None):
312
285
        """Open an existing working tree which has its root about path.
313
 
        
 
286
 
314
287
        This probes for a working tree at path and searches upwards from there.
315
288
 
316
289
        Basically we keep looking up until we find the control directory or
322
295
        """
323
296
        if path is None:
324
297
            path = osutils.getcwd()
325
 
        control, relpath = bzrdir.BzrDir.open_containing(path)
326
 
 
 
298
        control, relpath = controldir.ControlDir.open_containing(path)
327
299
        return control.open_workingtree(), relpath
328
300
 
329
301
    @staticmethod
 
302
    def open_containing_paths(file_list, default_directory=None,
 
303
                              canonicalize=True, apply_view=True):
 
304
        """Open the WorkingTree that contains a set of paths.
 
305
 
 
306
        Fail if the paths given are not all in a single tree.
 
307
 
 
308
        This is used for the many command-line interfaces that take a list of
 
309
        any number of files and that require they all be in the same tree.
 
310
        """
 
311
        if default_directory is None:
 
312
            default_directory = u'.'
 
313
        # recommended replacement for builtins.internal_tree_files
 
314
        if file_list is None or len(file_list) == 0:
 
315
            tree = WorkingTree.open_containing(default_directory)[0]
 
316
            # XXX: doesn't really belong here, and seems to have the strange
 
317
            # side effect of making it return a bunch of files, not the whole
 
318
            # tree -- mbp 20100716
 
319
            if tree.supports_views() and apply_view:
 
320
                view_files = tree.views.lookup_view()
 
321
                if view_files:
 
322
                    file_list = view_files
 
323
                    view_str = views.view_display_str(view_files)
 
324
                    note(gettext("Ignoring files outside view. View is %s") % view_str)
 
325
            return tree, file_list
 
326
        if default_directory == u'.':
 
327
            seed = file_list[0]
 
328
        else:
 
329
            seed = default_directory
 
330
            file_list = [osutils.pathjoin(default_directory, f)
 
331
                         for f in file_list]
 
332
        tree = WorkingTree.open_containing(seed)[0]
 
333
        return tree, tree.safe_relpath_files(file_list, canonicalize,
 
334
                                             apply_view=apply_view)
 
335
 
 
336
    def safe_relpath_files(self, file_list, canonicalize=True, apply_view=True):
 
337
        """Convert file_list into a list of relpaths in tree.
 
338
 
 
339
        :param self: A tree to operate on.
 
340
        :param file_list: A list of user provided paths or None.
 
341
        :param apply_view: if True and a view is set, apply it or check that
 
342
            specified files are within it
 
343
        :return: A list of relative paths.
 
344
        :raises errors.PathNotChild: When a provided path is in a different self
 
345
            than self.
 
346
        """
 
347
        if file_list is None:
 
348
            return None
 
349
        if self.supports_views() and apply_view:
 
350
            view_files = self.views.lookup_view()
 
351
        else:
 
352
            view_files = []
 
353
        new_list = []
 
354
        # self.relpath exists as a "thunk" to osutils, but canonical_relpath
 
355
        # doesn't - fix that up here before we enter the loop.
 
356
        if canonicalize:
 
357
            fixer = lambda p: osutils.canonical_relpath(self.basedir, p)
 
358
        else:
 
359
            fixer = self.relpath
 
360
        for filename in file_list:
 
361
            relpath = fixer(osutils.dereference_path(filename))
 
362
            if view_files and not osutils.is_inside_any(view_files, relpath):
 
363
                raise errors.FileOutsideView(filename, view_files)
 
364
            new_list.append(relpath)
 
365
        return new_list
 
366
 
 
367
    @staticmethod
330
368
    def open_downlevel(path=None):
331
369
        """Open an unsupported working tree.
332
370
 
345
383
                return True, None
346
384
            else:
347
385
                return True, tree
348
 
        transport = get_transport(location)
349
 
        iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
 
386
        t = transport.get_transport(location)
 
387
        iterator = controldir.ControlDir.find_bzrdirs(t, evaluate=evaluate,
350
388
                                              list_current=list_current)
351
 
        return [t for t in iterator if t is not None]
352
 
 
353
 
    # should be deprecated - this is slow and in any case treating them as a
354
 
    # container is (we now know) bad style -- mbp 20070302
355
 
    ## @deprecated_method(zero_fifteen)
356
 
    def __iter__(self):
357
 
        """Iterate through file_ids for this tree.
358
 
 
359
 
        file_ids are in a WorkingTree if they are in the working inventory
360
 
        and the working file exists.
361
 
        """
362
 
        inv = self._inventory
363
 
        for path, ie in inv.iter_entries():
364
 
            if osutils.lexists(self.abspath(path)):
365
 
                yield ie.file_id
366
 
 
367
 
    def all_file_ids(self):
368
 
        """See Tree.iter_all_file_ids"""
369
 
        return set(self.inventory)
 
389
        return [tr for tr in iterator if tr is not None]
370
390
 
371
391
    def __repr__(self):
372
392
        return "<%s of %s>" % (self.__class__.__name__,
377
397
 
378
398
    def basis_tree(self):
379
399
        """Return RevisionTree for the current last revision.
380
 
        
 
400
 
381
401
        If the left most parent is a ghost then the returned tree will be an
382
 
        empty tree - one obtained by calling repository.revision_tree(None).
 
402
        empty tree - one obtained by calling
 
403
        repository.revision_tree(NULL_REVISION).
383
404
        """
384
405
        try:
385
406
            revision_id = self.get_parent_ids()[0]
387
408
            # no parents, return an empty revision tree.
388
409
            # in the future this should return the tree for
389
410
            # 'empty:' - the implicit root empty tree.
390
 
            return self.branch.repository.revision_tree(None)
 
411
            return self.branch.repository.revision_tree(
 
412
                       _mod_revision.NULL_REVISION)
391
413
        try:
392
414
            return self.revision_tree(revision_id)
393
415
        except errors.NoSuchRevision:
399
421
            return self.branch.repository.revision_tree(revision_id)
400
422
        except (errors.RevisionNotPresent, errors.NoSuchRevision):
401
423
            # the basis tree *may* be a ghost or a low level error may have
402
 
            # occured. If the revision is present, its a problem, if its not
 
424
            # occurred. If the revision is present, its a problem, if its not
403
425
            # its a ghost.
404
426
            if self.branch.repository.has_revision(revision_id):
405
427
                raise
406
428
            # the basis tree is a ghost so return an empty tree.
407
 
            return self.branch.repository.revision_tree(None)
 
429
            return self.branch.repository.revision_tree(
 
430
                       _mod_revision.NULL_REVISION)
408
431
 
409
432
    def _cleanup(self):
410
433
        self._flush_ignore_list_cache()
411
434
 
412
435
    def relpath(self, path):
413
436
        """Return the local path portion from a given path.
414
 
        
415
 
        The path may be absolute or relative. If its a relative path it is 
 
437
 
 
438
        The path may be absolute or relative. If its a relative path it is
416
439
        interpreted relative to the python current working directory.
417
440
        """
418
441
        return osutils.relpath(self.basedir, path)
420
443
    def has_filename(self, filename):
421
444
        return osutils.lexists(self.abspath(filename))
422
445
 
423
 
    def get_file(self, file_id, path=None):
 
446
    def get_file(self, file_id, path=None, filtered=True):
 
447
        return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
 
448
 
 
449
    def get_file_with_stat(self, file_id, path=None, filtered=True,
 
450
                           _fstat=osutils.fstat):
 
451
        """See Tree.get_file_with_stat."""
424
452
        if path is None:
425
453
            path = self.id2path(file_id)
426
 
        return self.get_file_byname(path)
427
 
 
428
 
    def get_file_text(self, file_id):
429
 
        return self.get_file(file_id).read()
430
 
 
431
 
    def get_file_byname(self, filename):
432
 
        return file(self.abspath(filename), 'rb')
433
 
 
434
 
    @needs_read_lock
435
 
    def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
436
 
        """See Tree.annotate_iter
437
 
 
438
 
        This implementation will use the basis tree implementation if possible.
439
 
        Lines not in the basis are attributed to CURRENT_REVISION
440
 
 
441
 
        If there are pending merges, lines added by those merges will be
442
 
        incorrectly attributed to CURRENT_REVISION (but after committing, the
443
 
        attribution will be correct).
444
 
        """
445
 
        basis = self.basis_tree()
446
 
        basis.lock_read()
447
 
        try:
448
 
            changes = self.iter_changes(basis, True, [self.id2path(file_id)],
449
 
                require_versioned=True).next()
450
 
            changed_content, kind = changes[2], changes[6]
451
 
            if not changed_content:
452
 
                return basis.annotate_iter(file_id)
453
 
            if kind[1] is None:
454
 
                return None
455
 
            import annotate
456
 
            if kind[0] != 'file':
457
 
                old_lines = []
458
 
            else:
459
 
                old_lines = list(basis.annotate_iter(file_id))
460
 
            old = [old_lines]
461
 
            for tree in self.branch.repository.revision_trees(
462
 
                self.get_parent_ids()[1:]):
463
 
                if file_id not in tree:
464
 
                    continue
465
 
                old.append(list(tree.annotate_iter(file_id)))
466
 
            return annotate.reannotate(old, self.get_file(file_id).readlines(),
467
 
                                       default_revision)
468
 
        finally:
469
 
            basis.unlock()
470
 
 
471
 
    def _get_ancestors(self, default_revision):
472
 
        ancestors = set([default_revision])
473
 
        for parent_id in self.get_parent_ids():
474
 
            ancestors.update(self.branch.repository.get_ancestry(
475
 
                             parent_id, topo_sorted=False))
476
 
        return ancestors
 
454
        file_obj = self.get_file_byname(path, filtered=False)
 
455
        stat_value = _fstat(file_obj.fileno())
 
456
        if filtered and self.supports_content_filtering():
 
457
            filters = self._content_filter_stack(path)
 
458
            file_obj = _mod_filters.filtered_input_file(file_obj, filters)
 
459
        return (file_obj, stat_value)
 
460
 
 
461
    def get_file_text(self, file_id, path=None, filtered=True):
 
462
        my_file = self.get_file(file_id, path=path, filtered=filtered)
 
463
        try:
 
464
            return my_file.read()
 
465
        finally:
 
466
            my_file.close()
 
467
 
 
468
    def get_file_byname(self, filename, filtered=True):
 
469
        path = self.abspath(filename)
 
470
        f = file(path, 'rb')
 
471
        if filtered and self.supports_content_filtering():
 
472
            filters = self._content_filter_stack(filename)
 
473
            return _mod_filters.filtered_input_file(f, filters)
 
474
        else:
 
475
            return f
 
476
 
 
477
    def get_file_lines(self, file_id, path=None, filtered=True):
 
478
        """See Tree.get_file_lines()"""
 
479
        file = self.get_file(file_id, path, filtered=filtered)
 
480
        try:
 
481
            return file.readlines()
 
482
        finally:
 
483
            file.close()
477
484
 
478
485
    def get_parent_ids(self):
479
486
        """See Tree.get_parent_ids.
480
 
        
 
487
 
481
488
        This implementation reads the pending merges list and last_revision
482
489
        value and uses that to decide what the parents list should be.
483
490
        """
487
494
        else:
488
495
            parents = [last_rev]
489
496
        try:
490
 
            merges_file = self._transport.get('pending-merges')
 
497
            merges_bytes = self._transport.get_bytes('pending-merges')
491
498
        except errors.NoSuchFile:
492
499
            pass
493
500
        else:
494
 
            for l in merges_file.readlines():
 
501
            for l in osutils.split_lines(merges_bytes):
495
502
                revision_id = l.rstrip('\n')
496
503
                parents.append(revision_id)
497
504
        return parents
498
505
 
499
 
    @needs_read_lock
500
506
    def get_root_id(self):
501
507
        """Return the id of this trees root"""
502
 
        return self._inventory.root.file_id
503
 
        
504
 
    def _get_store_filename(self, file_id):
505
 
        ## XXX: badly named; this is not in the store at all
506
 
        return self.abspath(self.id2path(file_id))
 
508
        raise NotImplementedError(self.get_root_id)
507
509
 
508
510
    @needs_read_lock
509
 
    def clone(self, to_bzrdir, revision_id=None):
 
511
    def clone(self, to_controldir, revision_id=None):
510
512
        """Duplicate this working tree into to_bzr, including all state.
511
 
        
 
513
 
512
514
        Specifically modified files are kept as modified, but
513
515
        ignored and unknown files are discarded.
514
516
 
515
 
        If you want to make a new line of development, see bzrdir.sprout()
 
517
        If you want to make a new line of development, see ControlDir.sprout()
516
518
 
517
519
        revision
518
 
            If not None, the cloned tree will have its last revision set to 
519
 
            revision, and and difference between the source trees last revision
 
520
            If not None, the cloned tree will have its last revision set to
 
521
            revision, and difference between the source trees last revision
520
522
            and this one merged in.
521
523
        """
522
524
        # assumes the target bzr dir format is compatible.
523
 
        result = to_bzrdir.create_workingtree()
 
525
        result = to_controldir.create_workingtree()
524
526
        self.copy_content_into(result, revision_id)
525
527
        return result
526
528
 
533
535
        else:
534
536
            # TODO now merge from tree.last_revision to revision (to preserve
535
537
            # user local changes)
536
 
            merge.transform_tree(tree, self)
537
 
            tree.set_parent_ids([revision_id])
 
538
            try:
 
539
                other_tree = self.revision_tree(revision_id)
 
540
            except errors.NoSuchRevision:
 
541
                other_tree = self.branch.repository.revision_tree(revision_id)
 
542
 
 
543
            merge.transform_tree(tree, other_tree)
 
544
            if revision_id == _mod_revision.NULL_REVISION:
 
545
                new_parents = []
 
546
            else:
 
547
                new_parents = [revision_id]
 
548
            tree.set_parent_ids(new_parents)
538
549
 
539
550
    def id2abspath(self, file_id):
540
551
        return self.abspath(self.id2path(file_id))
541
552
 
542
 
    def has_id(self, file_id):
543
 
        # files that have been deleted are excluded
544
 
        inv = self.inventory
545
 
        if not inv.has_id(file_id):
546
 
            return False
547
 
        path = inv.id2path(file_id)
548
 
        return osutils.lexists(self.abspath(path))
549
 
 
550
 
    def has_or_had_id(self, file_id):
551
 
        if file_id == self.inventory.root.file_id:
552
 
            return True
553
 
        return self.inventory.has_id(file_id)
554
 
 
555
 
    __contains__ = has_id
 
553
    def _check_for_tree_references(self, iterator):
 
554
        """See if directories have become tree-references."""
 
555
        blocked_parent_ids = set()
 
556
        for path, ie in iterator:
 
557
            if ie.parent_id in blocked_parent_ids:
 
558
                # This entry was pruned because one of its parents became a
 
559
                # TreeReference. If this is a directory, mark it as blocked.
 
560
                if ie.kind == 'directory':
 
561
                    blocked_parent_ids.add(ie.file_id)
 
562
                continue
 
563
            if ie.kind == 'directory' and self._directory_is_tree_reference(path):
 
564
                # This InventoryDirectory needs to be a TreeReference
 
565
                ie = inventory.TreeReference(ie.file_id, ie.name, ie.parent_id)
 
566
                blocked_parent_ids.add(ie.file_id)
 
567
            yield path, ie
 
568
 
 
569
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
 
570
        """See Tree.iter_entries_by_dir()"""
 
571
        # The only trick here is that if we supports_tree_reference then we
 
572
        # need to detect if a directory becomes a tree-reference.
 
573
        iterator = super(WorkingTree, self).iter_entries_by_dir(
 
574
                specific_file_ids=specific_file_ids,
 
575
                yield_parents=yield_parents)
 
576
        if not self.supports_tree_reference():
 
577
            return iterator
 
578
        else:
 
579
            return self._check_for_tree_references(iterator)
556
580
 
557
581
    def get_file_size(self, file_id):
558
582
        """See Tree.get_file_size"""
 
583
        # XXX: this returns the on-disk size; it should probably return the
 
584
        # canonical size
559
585
        try:
560
586
            return os.path.getsize(self.id2abspath(file_id))
561
587
        except OSError, e:
564
590
            else:
565
591
                return None
566
592
 
567
 
    @needs_read_lock
568
 
    def get_file_sha1(self, file_id, path=None, stat_value=None):
569
 
        if not path:
570
 
            path = self._inventory.id2path(file_id)
571
 
        return self._hashcache.get_sha1(path, stat_value)
572
 
 
573
 
    def get_file_mtime(self, file_id, path=None):
574
 
        if not path:
575
 
            path = self.inventory.id2path(file_id)
576
 
        return os.lstat(self.abspath(path)).st_mtime
577
 
 
578
 
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
579
 
        file_id = self.path2id(path)
580
 
        return self._inventory[file_id].executable
581
 
 
582
 
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
583
 
        mode = stat_result.st_mode
584
 
        return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
585
 
 
586
 
    if not supports_executable():
587
 
        def is_executable(self, file_id, path=None):
588
 
            return self._inventory[file_id].executable
589
 
 
590
 
        _is_executable_from_path_and_stat = \
591
 
            _is_executable_from_path_and_stat_from_basis
592
 
    else:
593
 
        def is_executable(self, file_id, path=None):
594
 
            if not path:
595
 
                path = self.id2path(file_id)
596
 
            mode = os.lstat(self.abspath(path)).st_mode
597
 
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
598
 
 
599
 
        _is_executable_from_path_and_stat = \
600
 
            _is_executable_from_path_and_stat_from_stat
601
 
 
602
 
    @needs_tree_write_lock
603
 
    def _add(self, files, ids, kinds):
604
 
        """See MutableTree._add."""
605
 
        # TODO: Re-adding a file that is removed in the working copy
606
 
        # should probably put it back with the previous ID.
607
 
        # the read and write working inventory should not occur in this 
608
 
        # function - they should be part of lock_write and unlock.
609
 
        inv = self.inventory
610
 
        for f, file_id, kind in zip(files, ids, kinds):
611
 
            if file_id is None:
612
 
                inv.add_path(f, kind=kind)
613
 
            else:
614
 
                inv.add_path(f, kind=kind, file_id=file_id)
615
 
            self._inventory_is_modified = True
616
 
 
617
593
    @needs_tree_write_lock
618
594
    def _gather_kinds(self, files, kinds):
619
595
        """See MutableTree._gather_kinds."""
634
610
        and setting the list to its value plus revision_id.
635
611
 
636
612
        :param revision_id: The revision id to add to the parent list. It may
637
 
        be a ghost revision as long as its not the first parent to be added,
638
 
        or the allow_leftmost_as_ghost parameter is set True.
 
613
            be a ghost revision as long as its not the first parent to be
 
614
            added, or the allow_leftmost_as_ghost parameter is set True.
639
615
        :param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
640
616
        """
641
617
        parents = self.get_parent_ids() + [revision_id]
692
668
            raise
693
669
        kind = _mapper(stat_result.st_mode)
694
670
        if kind == 'file':
695
 
            size = stat_result.st_size
696
 
            # try for a stat cache lookup
697
 
            executable = self._is_executable_from_path_and_stat(path, stat_result)
698
 
            return (kind, size, executable, self._sha_from_stat(
699
 
                path, stat_result))
 
671
            return self._file_content_summary(path, stat_result)
700
672
        elif kind == 'directory':
701
673
            # perhaps it looks like a plain directory, but it's really a
702
674
            # reference.
704
676
                kind = 'tree-reference'
705
677
            return kind, None, None, None
706
678
        elif kind == 'symlink':
707
 
            return ('symlink', None, None, os.readlink(abspath))
 
679
            target = osutils.readlink(abspath)
 
680
            return ('symlink', None, None, target)
708
681
        else:
709
682
            return (kind, None, None, None)
710
683
 
 
684
    def _file_content_summary(self, path, stat_result):
 
685
        size = stat_result.st_size
 
686
        executable = self._is_executable_from_path_and_stat(path, stat_result)
 
687
        # try for a stat cache lookup
 
688
        return ('file', size, executable, self._sha_from_stat(
 
689
            path, stat_result))
 
690
 
711
691
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
712
692
        """Common ghost checking functionality from set_parent_*.
713
693
 
723
703
    def _set_merges_from_parent_ids(self, parent_ids):
724
704
        merges = parent_ids[1:]
725
705
        self._transport.put_bytes('pending-merges', '\n'.join(merges),
726
 
            mode=self._control_files._file_mode)
 
706
            mode=self.bzrdir._get_file_mode())
727
707
 
728
708
    def _filter_parent_ids_by_ancestry(self, revision_ids):
729
709
        """Check that all merged revisions are proper 'heads'.
730
710
 
731
711
        This will always return the first revision_id, and any merged revisions
732
 
        which are 
 
712
        which are
733
713
        """
734
714
        if len(revision_ids) == 0:
735
715
            return revision_ids
740
720
            if revision_id in heads and revision_id not in new_revision_ids:
741
721
                new_revision_ids.append(revision_id)
742
722
        if new_revision_ids != revision_ids:
743
 
            trace.mutter('requested to set revision_ids = %s,'
 
723
            mutter('requested to set revision_ids = %s,'
744
724
                         ' but filtered to %s', revision_ids, new_revision_ids)
745
725
        return new_revision_ids
746
726
 
747
727
    @needs_tree_write_lock
748
728
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
749
729
        """Set the parent ids to revision_ids.
750
 
        
 
730
 
751
731
        See also set_parent_trees. This api will try to retrieve the tree data
752
732
        for each element of revision_ids from the trees repository. If you have
753
733
        tree data already available, it is more efficient to use
772
752
        self._set_merges_from_parent_ids(revision_ids)
773
753
 
774
754
    @needs_tree_write_lock
775
 
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
776
 
        """See MutableTree.set_parent_trees."""
777
 
        parent_ids = [rev for (rev, tree) in parents_list]
778
 
        for revision_id in parent_ids:
779
 
            _mod_revision.check_not_reserved_id(revision_id)
780
 
 
781
 
        self._check_parents_for_ghosts(parent_ids,
782
 
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
783
 
 
784
 
        parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
785
 
 
786
 
        if len(parent_ids) == 0:
787
 
            leftmost_parent_id = _mod_revision.NULL_REVISION
788
 
            leftmost_parent_tree = None
789
 
        else:
790
 
            leftmost_parent_id, leftmost_parent_tree = parents_list[0]
791
 
 
792
 
        if self._change_last_revision(leftmost_parent_id):
793
 
            if leftmost_parent_tree is None:
794
 
                # If we don't have a tree, fall back to reading the
795
 
                # parent tree from the repository.
796
 
                self._cache_basis_inventory(leftmost_parent_id)
797
 
            else:
798
 
                inv = leftmost_parent_tree.inventory
799
 
                xml = self._create_basis_xml_from_inventory(
800
 
                                        leftmost_parent_id, inv)
801
 
                self._write_basis_inventory(xml)
802
 
        self._set_merges_from_parent_ids(parent_ids)
803
 
 
804
 
    @needs_tree_write_lock
805
755
    def set_pending_merges(self, rev_list):
806
756
        parents = self.get_parent_ids()
807
757
        leftmost = parents[:1]
810
760
 
811
761
    @needs_tree_write_lock
812
762
    def set_merge_modified(self, modified_hashes):
813
 
        def iter_stanzas():
814
 
            for file_id, hash in modified_hashes.iteritems():
815
 
                yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
816
 
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
 
763
        """Set the merge modified hashes."""
 
764
        raise NotImplementedError(self.set_merge_modified)
817
765
 
818
766
    def _sha_from_stat(self, path, stat_result):
819
767
        """Get a sha digest from the tree's stat cache.
825
773
        """
826
774
        return None
827
775
 
828
 
    def _put_rio(self, filename, stanzas, header):
829
 
        self._must_be_locked()
830
 
        my_file = rio_file(stanzas, header)
831
 
        self._transport.put_file(filename, my_file,
832
 
            mode=self._control_files._file_mode)
833
 
 
834
776
    @needs_write_lock # because merge pulls data into the branch.
835
777
    def merge_from_branch(self, branch, to_revision=None, from_revision=None,
836
 
        merge_type=None):
 
778
                          merge_type=None, force=False):
837
779
        """Merge from a branch into this working tree.
838
780
 
839
781
        :param branch: The branch to merge from.
843
785
            branch.last_revision().
844
786
        """
845
787
        from bzrlib.merge import Merger, Merge3Merger
846
 
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
847
 
        try:
848
 
            merger = Merger(self.branch, this_tree=self, pb=pb)
849
 
            merger.pp = ProgressPhase("Merge phase", 5, pb)
850
 
            merger.pp.next_phase()
851
 
            # check that there are no
852
 
            # local alterations
853
 
            merger.check_basis(check_clean=True, require_commits=False)
854
 
            if to_revision is None:
855
 
                to_revision = _mod_revision.ensure_null(branch.last_revision())
856
 
            merger.other_rev_id = to_revision
857
 
            if _mod_revision.is_null(merger.other_rev_id):
858
 
                raise errors.NoCommits(branch)
859
 
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
860
 
            merger.other_basis = merger.other_rev_id
861
 
            merger.other_tree = self.branch.repository.revision_tree(
862
 
                merger.other_rev_id)
863
 
            merger.other_branch = branch
864
 
            merger.pp.next_phase()
865
 
            if from_revision is None:
866
 
                merger.find_base()
867
 
            else:
868
 
                merger.set_base_revision(from_revision, branch)
869
 
            if merger.base_rev_id == merger.other_rev_id:
870
 
                raise errors.PointlessMerge
871
 
            merger.backup_files = False
872
 
            if merge_type is None:
873
 
                merger.merge_type = Merge3Merger
874
 
            else:
875
 
                merger.merge_type = merge_type
876
 
            merger.set_interesting_files(None)
877
 
            merger.show_base = False
878
 
            merger.reprocess = False
879
 
            conflicts = merger.do_merge()
880
 
            merger.set_pending()
881
 
        finally:
882
 
            pb.finished()
 
788
        merger = Merger(self.branch, this_tree=self)
 
789
        # check that there are no local alterations
 
790
        if not force and self.has_changes():
 
791
            raise errors.UncommittedChanges(self)
 
792
        if to_revision is None:
 
793
            to_revision = _mod_revision.ensure_null(branch.last_revision())
 
794
        merger.other_rev_id = to_revision
 
795
        if _mod_revision.is_null(merger.other_rev_id):
 
796
            raise errors.NoCommits(branch)
 
797
        self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
798
        merger.other_basis = merger.other_rev_id
 
799
        merger.other_tree = self.branch.repository.revision_tree(
 
800
            merger.other_rev_id)
 
801
        merger.other_branch = branch
 
802
        if from_revision is None:
 
803
            merger.find_base()
 
804
        else:
 
805
            merger.set_base_revision(from_revision, branch)
 
806
        if merger.base_rev_id == merger.other_rev_id:
 
807
            raise errors.PointlessMerge
 
808
        merger.backup_files = False
 
809
        if merge_type is None:
 
810
            merger.merge_type = Merge3Merger
 
811
        else:
 
812
            merger.merge_type = merge_type
 
813
        merger.set_interesting_files(None)
 
814
        merger.show_base = False
 
815
        merger.reprocess = False
 
816
        conflicts = merger.do_merge()
 
817
        merger.set_pending()
883
818
        return conflicts
884
819
 
885
 
    @needs_read_lock
886
820
    def merge_modified(self):
887
821
        """Return a dictionary of files modified by a merge.
888
822
 
889
 
        The list is initialized by WorkingTree.set_merge_modified, which is 
 
823
        The list is initialized by WorkingTree.set_merge_modified, which is
890
824
        typically called after we make some automatic updates to the tree
891
825
        because of a merge.
892
826
 
893
827
        This returns a map of file_id->sha1, containing only files which are
894
828
        still in the working inventory and have that text hash.
895
829
        """
896
 
        try:
897
 
            hashfile = self._transport.get('merge-hashes')
898
 
        except errors.NoSuchFile:
899
 
            return {}
900
 
        merge_hashes = {}
901
 
        try:
902
 
            if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
903
 
                raise errors.MergeModifiedFormatError()
904
 
        except StopIteration:
905
 
            raise errors.MergeModifiedFormatError()
906
 
        for s in RioReader(hashfile):
907
 
            # RioReader reads in Unicode, so convert file_ids back to utf8
908
 
            file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
909
 
            if file_id not in self.inventory:
910
 
                continue
911
 
            text_hash = s.get("hash")
912
 
            if text_hash == self.get_file_sha1(file_id):
913
 
                merge_hashes[file_id] = text_hash
914
 
        return merge_hashes
 
830
        raise NotImplementedError(self.merge_modified)
915
831
 
916
832
    @needs_write_lock
917
833
    def mkdir(self, path, file_id=None):
922
838
        self.add(path, file_id, 'directory')
923
839
        return file_id
924
840
 
925
 
    def get_symlink_target(self, file_id):
926
 
        return os.readlink(self.id2abspath(file_id))
 
841
    def get_symlink_target(self, file_id, path=None):
 
842
        if path is not None:
 
843
            abspath = self.abspath(path)
 
844
        else:
 
845
            abspath = self.id2abspath(file_id)
 
846
        target = osutils.readlink(abspath)
 
847
        return target
927
848
 
928
 
    @needs_write_lock
929
849
    def subsume(self, other_tree):
930
 
        def add_children(inventory, entry):
931
 
            for child_entry in entry.children.values():
932
 
                inventory._byid[child_entry.file_id] = child_entry
933
 
                if child_entry.kind == 'directory':
934
 
                    add_children(inventory, child_entry)
935
 
        if other_tree.get_root_id() == self.get_root_id():
936
 
            raise errors.BadSubsumeSource(self, other_tree,
937
 
                                          'Trees have the same root')
938
 
        try:
939
 
            other_tree_path = self.relpath(other_tree.basedir)
940
 
        except errors.PathNotChild:
941
 
            raise errors.BadSubsumeSource(self, other_tree,
942
 
                'Tree is not contained by the other')
943
 
        new_root_parent = self.path2id(osutils.dirname(other_tree_path))
944
 
        if new_root_parent is None:
945
 
            raise errors.BadSubsumeSource(self, other_tree,
946
 
                'Parent directory is not versioned.')
947
 
        # We need to ensure that the result of a fetch will have a
948
 
        # versionedfile for the other_tree root, and only fetching into
949
 
        # RepositoryKnit2 guarantees that.
950
 
        if not self.branch.repository.supports_rich_root():
951
 
            raise errors.SubsumeTargetNeedsUpgrade(other_tree)
952
 
        other_tree.lock_tree_write()
953
 
        try:
954
 
            new_parents = other_tree.get_parent_ids()
955
 
            other_root = other_tree.inventory.root
956
 
            other_root.parent_id = new_root_parent
957
 
            other_root.name = osutils.basename(other_tree_path)
958
 
            self.inventory.add(other_root)
959
 
            add_children(self.inventory, other_root)
960
 
            self._write_inventory(self.inventory)
961
 
            # normally we don't want to fetch whole repositories, but i think
962
 
            # here we really do want to consolidate the whole thing.
963
 
            for parent_id in other_tree.get_parent_ids():
964
 
                self.branch.fetch(other_tree.branch, parent_id)
965
 
                self.add_parent_tree_id(parent_id)
966
 
        finally:
967
 
            other_tree.unlock()
968
 
        other_tree.bzrdir.retire_bzrdir()
 
850
        raise NotImplementedError(self.subsume)
969
851
 
970
852
    def _setup_directory_is_tree_reference(self):
971
853
        if self._branch.repository._format.supports_tree_reference:
979
861
        return False
980
862
 
981
863
    def _directory_may_be_tree_reference(self, relpath):
982
 
        # as a special case, if a directory contains control files then 
 
864
        # as a special case, if a directory contains control files then
983
865
        # it's a tree reference, except that the root of the tree is not
984
866
        return relpath and osutils.isdir(self.abspath(relpath) + u"/.bzr")
985
867
        # TODO: We could ask all the control formats whether they
993
875
        # checkout in a subdirectory.  This can be avoided by not adding
994
876
        # it.  mbp 20070306
995
877
 
996
 
    @needs_tree_write_lock
997
878
    def extract(self, file_id, format=None):
998
879
        """Extract a subtree from this tree.
999
 
        
 
880
 
1000
881
        A new branch will be created, relative to the path for this tree.
1001
882
        """
1002
 
        self.flush()
1003
 
        def mkdirs(path):
1004
 
            segments = osutils.splitpath(path)
1005
 
            transport = self.branch.bzrdir.root_transport
1006
 
            for name in segments:
1007
 
                transport = transport.clone(name)
1008
 
                transport.ensure_base()
1009
 
            return transport
1010
 
            
1011
 
        sub_path = self.id2path(file_id)
1012
 
        branch_transport = mkdirs(sub_path)
1013
 
        if format is None:
1014
 
            format = self.bzrdir.cloning_metadir()
1015
 
        branch_transport.ensure_base()
1016
 
        branch_bzrdir = format.initialize_on_transport(branch_transport)
1017
 
        try:
1018
 
            repo = branch_bzrdir.find_repository()
1019
 
        except errors.NoRepositoryPresent:
1020
 
            repo = branch_bzrdir.create_repository()
1021
 
        if not repo.supports_rich_root():
1022
 
            raise errors.RootNotRich()
1023
 
        new_branch = branch_bzrdir.create_branch()
1024
 
        new_branch.pull(self.branch)
1025
 
        for parent_id in self.get_parent_ids():
1026
 
            new_branch.fetch(self.branch, parent_id)
1027
 
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
1028
 
        if tree_transport.base != branch_transport.base:
1029
 
            tree_bzrdir = format.initialize_on_transport(tree_transport)
1030
 
            branch.BranchReferenceFormat().initialize(tree_bzrdir, new_branch)
1031
 
        else:
1032
 
            tree_bzrdir = branch_bzrdir
1033
 
        wt = tree_bzrdir.create_workingtree(NULL_REVISION)
1034
 
        wt.set_parent_ids(self.get_parent_ids())
1035
 
        my_inv = self.inventory
1036
 
        child_inv = Inventory(root_id=None)
1037
 
        new_root = my_inv[file_id]
1038
 
        my_inv.remove_recursive_id(file_id)
1039
 
        new_root.parent_id = None
1040
 
        child_inv.add(new_root)
1041
 
        self._write_inventory(my_inv)
1042
 
        wt._write_inventory(child_inv)
1043
 
        return wt
1044
 
 
1045
 
    def _serialize(self, inventory, out_file):
1046
 
        xml5.serializer_v5.write_inventory(self._inventory, out_file,
1047
 
            working=True)
1048
 
 
1049
 
    def _deserialize(selt, in_file):
1050
 
        return xml5.serializer_v5.read_inventory(in_file)
 
883
        raise NotImplementedError(self.extract)
1051
884
 
1052
885
    def flush(self):
1053
 
        """Write the in memory inventory to disk."""
1054
 
        # TODO: Maybe this should only write on dirty ?
1055
 
        if self._control_files._lock_mode != 'w':
1056
 
            raise errors.NotWriteLocked(self)
1057
 
        sio = StringIO()
1058
 
        self._serialize(self._inventory, sio)
1059
 
        sio.seek(0)
1060
 
        self._transport.put_file('inventory', sio,
1061
 
            mode=self._control_files._file_mode)
1062
 
        self._inventory_is_modified = False
 
886
        """Write the in memory meta data to disk."""
 
887
        raise NotImplementedError(self.flush)
1063
888
 
1064
889
    def _kind(self, relpath):
1065
890
        return osutils.file_kind(self.abspath(relpath))
1066
891
 
1067
 
    def list_files(self, include_root=False):
1068
 
        """Recursively list all files as (path, class, kind, id, entry).
 
892
    def list_files(self, include_root=False, from_dir=None, recursive=True):
 
893
        """List all files as (path, class, kind, id, entry).
1069
894
 
1070
895
        Lists, but does not descend into unversioned directories.
1071
 
 
1072
896
        This does not include files that have been deleted in this
1073
 
        tree.
 
897
        tree. Skips the control directory.
1074
898
 
1075
 
        Skips the control directory.
 
899
        :param include_root: if True, return an entry for the root
 
900
        :param from_dir: start from this directory or None for the root
 
901
        :param recursive: whether to recurse into subdirectories or not
1076
902
        """
1077
 
        # list_files is an iterator, so @needs_read_lock doesn't work properly
1078
 
        # with it. So callers should be careful to always read_lock the tree.
1079
 
        if not self.is_locked():
1080
 
            raise errors.ObjectNotLocked(self)
1081
 
 
1082
 
        inv = self.inventory
1083
 
        if include_root is True:
1084
 
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1085
 
        # Convert these into local objects to save lookup times
1086
 
        pathjoin = osutils.pathjoin
1087
 
        file_kind = self._kind
1088
 
 
1089
 
        # transport.base ends in a slash, we want the piece
1090
 
        # between the last two slashes
1091
 
        transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1092
 
 
1093
 
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1094
 
 
1095
 
        # directory file_id, relative path, absolute path, reverse sorted children
1096
 
        children = os.listdir(self.basedir)
1097
 
        children.sort()
1098
 
        # jam 20060527 The kernel sized tree seems equivalent whether we 
1099
 
        # use a deque and popleft to keep them sorted, or if we use a plain
1100
 
        # list and just reverse() them.
1101
 
        children = collections.deque(children)
1102
 
        stack = [(inv.root.file_id, u'', self.basedir, children)]
1103
 
        while stack:
1104
 
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1105
 
 
1106
 
            while children:
1107
 
                f = children.popleft()
1108
 
                ## TODO: If we find a subdirectory with its own .bzr
1109
 
                ## directory, then that is a separate tree and we
1110
 
                ## should exclude it.
1111
 
 
1112
 
                # the bzrdir for this tree
1113
 
                if transport_base_dir == f:
1114
 
                    continue
1115
 
 
1116
 
                # we know that from_dir_relpath and from_dir_abspath never end in a slash
1117
 
                # and 'f' doesn't begin with one, we can do a string op, rather
1118
 
                # than the checks of pathjoin(), all relative paths will have an extra slash
1119
 
                # at the beginning
1120
 
                fp = from_dir_relpath + '/' + f
1121
 
 
1122
 
                # absolute path
1123
 
                fap = from_dir_abspath + '/' + f
1124
 
                
1125
 
                f_ie = inv.get_child(from_dir_id, f)
1126
 
                if f_ie:
1127
 
                    c = 'V'
1128
 
                elif self.is_ignored(fp[1:]):
1129
 
                    c = 'I'
1130
 
                else:
1131
 
                    # we may not have found this file, because of a unicode issue
1132
 
                    f_norm, can_access = osutils.normalized_filename(f)
1133
 
                    if f == f_norm or not can_access:
1134
 
                        # No change, so treat this file normally
1135
 
                        c = '?'
1136
 
                    else:
1137
 
                        # this file can be accessed by a normalized path
1138
 
                        # check again if it is versioned
1139
 
                        # these lines are repeated here for performance
1140
 
                        f = f_norm
1141
 
                        fp = from_dir_relpath + '/' + f
1142
 
                        fap = from_dir_abspath + '/' + f
1143
 
                        f_ie = inv.get_child(from_dir_id, f)
1144
 
                        if f_ie:
1145
 
                            c = 'V'
1146
 
                        elif self.is_ignored(fp[1:]):
1147
 
                            c = 'I'
1148
 
                        else:
1149
 
                            c = '?'
1150
 
 
1151
 
                fk = file_kind(fap)
1152
 
 
1153
 
                # make a last minute entry
1154
 
                if f_ie:
1155
 
                    yield fp[1:], c, fk, f_ie.file_id, f_ie
1156
 
                else:
1157
 
                    try:
1158
 
                        yield fp[1:], c, fk, None, fk_entries[fk]()
1159
 
                    except KeyError:
1160
 
                        yield fp[1:], c, fk, None, TreeEntry()
1161
 
                    continue
1162
 
                
1163
 
                if fk != 'directory':
1164
 
                    continue
1165
 
 
1166
 
                # But do this child first
1167
 
                new_children = os.listdir(fap)
1168
 
                new_children.sort()
1169
 
                new_children = collections.deque(new_children)
1170
 
                stack.append((f_ie.file_id, fp, fap, new_children))
1171
 
                # Break out of inner loop,
1172
 
                # so that we start outer loop with child
1173
 
                break
1174
 
            else:
1175
 
                # if we finished all children, pop it off the stack
1176
 
                stack.pop()
1177
 
 
1178
 
    @needs_tree_write_lock
1179
 
    def move(self, from_paths, to_dir=None, after=False, **kwargs):
 
903
        raise NotImplementedError(self.list_files)
 
904
 
 
905
    def move(self, from_paths, to_dir=None, after=False):
1180
906
        """Rename files.
1181
907
 
1182
 
        to_dir must exist in the inventory.
 
908
        to_dir must be known to the working tree.
1183
909
 
1184
910
        If to_dir exists and is a directory, the files are moved into
1185
 
        it, keeping their old names.  
 
911
        it, keeping their old names.
1186
912
 
1187
913
        Note that to_dir is only the last component of the new name;
1188
914
        this doesn't change the directory.
1191
917
        independently.
1192
918
 
1193
919
        The first mode moves the file in the filesystem and updates the
1194
 
        inventory. The second mode only updates the inventory without
1195
 
        touching the file on the filesystem. This is the new mode introduced
1196
 
        in version 0.15.
 
920
        working tree metadata. The second mode only updates the working tree
 
921
        metadata without touching the file on the filesystem.
1197
922
 
1198
923
        move uses the second mode if 'after == True' and the target is not
1199
924
        versioned but present in the working tree.
1211
936
        This returns a list of (from_path, to_path) pairs for each
1212
937
        entry that is moved.
1213
938
        """
1214
 
        rename_entries = []
1215
 
        rename_tuples = []
1216
 
 
1217
 
        # check for deprecated use of signature
1218
 
        if to_dir is None:
1219
 
            to_dir = kwargs.get('to_name', None)
1220
 
            if to_dir is None:
1221
 
                raise TypeError('You must supply a target directory')
1222
 
            else:
1223
 
                symbol_versioning.warn('The parameter to_name was deprecated'
1224
 
                                       ' in version 0.13. Use to_dir instead',
1225
 
                                       DeprecationWarning)
1226
 
 
1227
 
        # check destination directory
1228
 
        if isinstance(from_paths, basestring):
1229
 
            raise ValueError()
1230
 
        inv = self.inventory
1231
 
        to_abs = self.abspath(to_dir)
1232
 
        if not isdir(to_abs):
1233
 
            raise errors.BzrMoveFailedError('',to_dir,
1234
 
                errors.NotADirectory(to_abs))
1235
 
        if not self.has_filename(to_dir):
1236
 
            raise errors.BzrMoveFailedError('',to_dir,
1237
 
                errors.NotInWorkingDirectory(to_dir))
1238
 
        to_dir_id = inv.path2id(to_dir)
1239
 
        if to_dir_id is None:
1240
 
            raise errors.BzrMoveFailedError('',to_dir,
1241
 
                errors.NotVersionedError(path=str(to_dir)))
1242
 
 
1243
 
        to_dir_ie = inv[to_dir_id]
1244
 
        if to_dir_ie.kind != 'directory':
1245
 
            raise errors.BzrMoveFailedError('',to_dir,
1246
 
                errors.NotADirectory(to_abs))
1247
 
 
1248
 
        # create rename entries and tuples
1249
 
        for from_rel in from_paths:
1250
 
            from_tail = splitpath(from_rel)[-1]
1251
 
            from_id = inv.path2id(from_rel)
1252
 
            if from_id is None:
1253
 
                raise errors.BzrMoveFailedError(from_rel,to_dir,
1254
 
                    errors.NotVersionedError(path=str(from_rel)))
1255
 
 
1256
 
            from_entry = inv[from_id]
1257
 
            from_parent_id = from_entry.parent_id
1258
 
            to_rel = pathjoin(to_dir, from_tail)
1259
 
            rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1260
 
                                         from_id=from_id,
1261
 
                                         from_tail=from_tail,
1262
 
                                         from_parent_id=from_parent_id,
1263
 
                                         to_rel=to_rel, to_tail=from_tail,
1264
 
                                         to_parent_id=to_dir_id)
1265
 
            rename_entries.append(rename_entry)
1266
 
            rename_tuples.append((from_rel, to_rel))
1267
 
 
1268
 
        # determine which move mode to use. checks also for movability
1269
 
        rename_entries = self._determine_mv_mode(rename_entries, after)
1270
 
 
1271
 
        original_modified = self._inventory_is_modified
1272
 
        try:
1273
 
            if len(from_paths):
1274
 
                self._inventory_is_modified = True
1275
 
            self._move(rename_entries)
1276
 
        except:
1277
 
            # restore the inventory on error
1278
 
            self._inventory_is_modified = original_modified
1279
 
            raise
1280
 
        self._write_inventory(inv)
1281
 
        return rename_tuples
1282
 
 
1283
 
    def _determine_mv_mode(self, rename_entries, after=False):
1284
 
        """Determines for each from-to pair if both inventory and working tree
1285
 
        or only the inventory has to be changed.
1286
 
 
1287
 
        Also does basic plausability tests.
1288
 
        """
1289
 
        inv = self.inventory
1290
 
 
1291
 
        for rename_entry in rename_entries:
1292
 
            # store to local variables for easier reference
1293
 
            from_rel = rename_entry.from_rel
1294
 
            from_id = rename_entry.from_id
1295
 
            to_rel = rename_entry.to_rel
1296
 
            to_id = inv.path2id(to_rel)
1297
 
            only_change_inv = False
1298
 
 
1299
 
            # check the inventory for source and destination
1300
 
            if from_id is None:
1301
 
                raise errors.BzrMoveFailedError(from_rel,to_rel,
1302
 
                    errors.NotVersionedError(path=str(from_rel)))
1303
 
            if to_id is not None:
1304
 
                raise errors.BzrMoveFailedError(from_rel,to_rel,
1305
 
                    errors.AlreadyVersionedError(path=str(to_rel)))
1306
 
 
1307
 
            # try to determine the mode for rename (only change inv or change
1308
 
            # inv and file system)
1309
 
            if after:
1310
 
                if not self.has_filename(to_rel):
1311
 
                    raise errors.BzrMoveFailedError(from_id,to_rel,
1312
 
                        errors.NoSuchFile(path=str(to_rel),
1313
 
                        extra="New file has not been created yet"))
1314
 
                only_change_inv = True
1315
 
            elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1316
 
                only_change_inv = True
1317
 
            elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1318
 
                only_change_inv = False
1319
 
            elif (not self.case_sensitive
1320
 
                  and from_rel.lower() == to_rel.lower()
1321
 
                  and self.has_filename(from_rel)):
1322
 
                only_change_inv = False
1323
 
            else:
1324
 
                # something is wrong, so lets determine what exactly
1325
 
                if not self.has_filename(from_rel) and \
1326
 
                   not self.has_filename(to_rel):
1327
 
                    raise errors.BzrRenameFailedError(from_rel,to_rel,
1328
 
                        errors.PathsDoNotExist(paths=(str(from_rel),
1329
 
                        str(to_rel))))
1330
 
                else:
1331
 
                    raise errors.RenameFailedFilesExist(from_rel, to_rel)
1332
 
            rename_entry.only_change_inv = only_change_inv
1333
 
        return rename_entries
1334
 
 
1335
 
    def _move(self, rename_entries):
1336
 
        """Moves a list of files.
1337
 
 
1338
 
        Depending on the value of the flag 'only_change_inv', the
1339
 
        file will be moved on the file system or not.
1340
 
        """
1341
 
        inv = self.inventory
1342
 
        moved = []
1343
 
 
1344
 
        for entry in rename_entries:
1345
 
            try:
1346
 
                self._move_entry(entry)
1347
 
            except:
1348
 
                self._rollback_move(moved)
1349
 
                raise
1350
 
            moved.append(entry)
1351
 
 
1352
 
    def _rollback_move(self, moved):
1353
 
        """Try to rollback a previous move in case of an filesystem error."""
1354
 
        inv = self.inventory
1355
 
        for entry in moved:
1356
 
            try:
1357
 
                self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
1358
 
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
1359
 
                    entry.from_tail, entry.from_parent_id,
1360
 
                    entry.only_change_inv))
1361
 
            except errors.BzrMoveFailedError, e:
1362
 
                raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1363
 
                        " The working tree is in an inconsistent state."
1364
 
                        " Please consider doing a 'bzr revert'."
1365
 
                        " Error message is: %s" % e)
1366
 
 
1367
 
    def _move_entry(self, entry):
1368
 
        inv = self.inventory
1369
 
        from_rel_abs = self.abspath(entry.from_rel)
1370
 
        to_rel_abs = self.abspath(entry.to_rel)
1371
 
        if from_rel_abs == to_rel_abs:
1372
 
            raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1373
 
                "Source and target are identical.")
1374
 
 
1375
 
        if not entry.only_change_inv:
1376
 
            try:
1377
 
                osutils.rename(from_rel_abs, to_rel_abs)
1378
 
            except OSError, e:
1379
 
                raise errors.BzrMoveFailedError(entry.from_rel,
1380
 
                    entry.to_rel, e[1])
1381
 
        inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
 
939
        raise NotImplementedError(self.move)
1382
940
 
1383
941
    @needs_tree_write_lock
1384
942
    def rename_one(self, from_rel, to_rel, after=False):
1388
946
 
1389
947
        rename_one has several 'modes' to work. First, it can rename a physical
1390
948
        file and change the file_id. That is the normal mode. Second, it can
1391
 
        only change the file_id without touching any physical file. This is
1392
 
        the new mode introduced in version 0.15.
 
949
        only change the file_id without touching any physical file.
1393
950
 
1394
 
        rename_one uses the second mode if 'after == True' and 'to_rel' is not
1395
 
        versioned but present in the working tree.
 
951
        rename_one uses the second mode if 'after == True' and 'to_rel' is
 
952
        either not versioned or newly added, and present in the working tree.
1396
953
 
1397
954
        rename_one uses the second mode if 'after == False' and 'from_rel' is
1398
955
        versioned but no longer in the working tree, and 'to_rel' is not
1404
961
 
1405
962
        Everything else results in an error.
1406
963
        """
1407
 
        inv = self.inventory
1408
 
        rename_entries = []
1409
 
 
1410
 
        # create rename entries and tuples
1411
 
        from_tail = splitpath(from_rel)[-1]
1412
 
        from_id = inv.path2id(from_rel)
1413
 
        if from_id is None:
1414
 
            raise errors.BzrRenameFailedError(from_rel,to_rel,
1415
 
                errors.NotVersionedError(path=str(from_rel)))
1416
 
        from_entry = inv[from_id]
1417
 
        from_parent_id = from_entry.parent_id
1418
 
        to_dir, to_tail = os.path.split(to_rel)
1419
 
        to_dir_id = inv.path2id(to_dir)
1420
 
        rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1421
 
                                     from_id=from_id,
1422
 
                                     from_tail=from_tail,
1423
 
                                     from_parent_id=from_parent_id,
1424
 
                                     to_rel=to_rel, to_tail=to_tail,
1425
 
                                     to_parent_id=to_dir_id)
1426
 
        rename_entries.append(rename_entry)
1427
 
 
1428
 
        # determine which move mode to use. checks also for movability
1429
 
        rename_entries = self._determine_mv_mode(rename_entries, after)
1430
 
 
1431
 
        # check if the target changed directory and if the target directory is
1432
 
        # versioned
1433
 
        if to_dir_id is None:
1434
 
            raise errors.BzrMoveFailedError(from_rel,to_rel,
1435
 
                errors.NotVersionedError(path=str(to_dir)))
1436
 
 
1437
 
        # all checks done. now we can continue with our actual work
1438
 
        mutter('rename_one:\n'
1439
 
               '  from_id   {%s}\n'
1440
 
               '  from_rel: %r\n'
1441
 
               '  to_rel:   %r\n'
1442
 
               '  to_dir    %r\n'
1443
 
               '  to_dir_id {%s}\n',
1444
 
               from_id, from_rel, to_rel, to_dir, to_dir_id)
1445
 
 
1446
 
        self._move(rename_entries)
1447
 
        self._write_inventory(inv)
1448
 
 
1449
 
    class _RenameEntry(object):
1450
 
        def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1451
 
                     to_rel, to_tail, to_parent_id, only_change_inv=False):
1452
 
            self.from_rel = from_rel
1453
 
            self.from_id = from_id
1454
 
            self.from_tail = from_tail
1455
 
            self.from_parent_id = from_parent_id
1456
 
            self.to_rel = to_rel
1457
 
            self.to_tail = to_tail
1458
 
            self.to_parent_id = to_parent_id
1459
 
            self.only_change_inv = only_change_inv
 
964
        raise NotImplementedError(self.rename_one)
1460
965
 
1461
966
    @needs_read_lock
1462
967
    def unknowns(self):
1465
970
        These are files in the working directory that are not versioned or
1466
971
        control files or ignored.
1467
972
        """
1468
 
        # force the extras method to be fully executed before returning, to 
 
973
        # force the extras method to be fully executed before returning, to
1469
974
        # prevent race conditions with the lock
1470
975
        return iter(
1471
976
            [subp for subp in self.extras() if not self.is_ignored(subp)])
1472
977
 
1473
 
    @needs_tree_write_lock
1474
978
    def unversion(self, file_ids):
1475
979
        """Remove the file ids in file_ids from the current versioned set.
1476
980
 
1480
984
        :param file_ids: The file ids to stop versioning.
1481
985
        :raises: NoSuchId if any fileid is not currently versioned.
1482
986
        """
1483
 
        for file_id in file_ids:
1484
 
            if self._inventory.has_id(file_id):
1485
 
                self._inventory.remove_recursive_id(file_id)
1486
 
            else:
1487
 
                raise errors.NoSuchId(self, file_id)
1488
 
        if len(file_ids):
1489
 
            # in the future this should just set a dirty bit to wait for the 
1490
 
            # final unlock. However, until all methods of workingtree start
1491
 
            # with the current in -memory inventory rather than triggering 
1492
 
            # a read, it is more complex - we need to teach read_inventory
1493
 
            # to know when to read, and when to not read first... and possibly
1494
 
            # to save first when the in memory one may be corrupted.
1495
 
            # so for now, we just only write it if it is indeed dirty.
1496
 
            # - RBC 20060907
1497
 
            self._write_inventory(self._inventory)
1498
 
    
1499
 
    def _iter_conflicts(self):
1500
 
        conflicted = set()
1501
 
        for info in self.list_files():
1502
 
            path = info[0]
1503
 
            stem = get_conflicted_stem(path)
1504
 
            if stem is None:
1505
 
                continue
1506
 
            if stem not in conflicted:
1507
 
                conflicted.add(stem)
1508
 
                yield stem
 
987
        raise NotImplementedError(self.unversion)
1509
988
 
1510
989
    @needs_write_lock
1511
990
    def pull(self, source, overwrite=False, stop_revision=None,
1512
 
             change_reporter=None, possible_transports=None):
1513
 
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
991
             change_reporter=None, possible_transports=None, local=False,
 
992
             show_base=False):
1514
993
        source.lock_read()
1515
994
        try:
1516
 
            pp = ProgressPhase("Pull phase", 2, top_pb)
1517
 
            pp.next_phase()
1518
995
            old_revision_info = self.branch.last_revision_info()
1519
996
            basis_tree = self.basis_tree()
1520
997
            count = self.branch.pull(source, overwrite, stop_revision,
1521
 
                                     possible_transports=possible_transports)
 
998
                                     possible_transports=possible_transports,
 
999
                                     local=local)
1522
1000
            new_revision_info = self.branch.last_revision_info()
1523
1001
            if new_revision_info != old_revision_info:
1524
 
                pp.next_phase()
1525
1002
                repository = self.branch.repository
1526
 
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1003
                if repository._format.fast_deltas:
 
1004
                    parent_ids = self.get_parent_ids()
 
1005
                    if parent_ids:
 
1006
                        basis_id = parent_ids[0]
 
1007
                        basis_tree = repository.revision_tree(basis_id)
1527
1008
                basis_tree.lock_read()
1528
1009
                try:
1529
1010
                    new_basis_tree = self.branch.basis_tree()
1532
1013
                                new_basis_tree,
1533
1014
                                basis_tree,
1534
1015
                                this_tree=self,
1535
 
                                pb=pb,
1536
 
                                change_reporter=change_reporter)
1537
 
                    if (basis_tree.inventory.root is None and
1538
 
                        new_basis_tree.inventory.root is not None):
1539
 
                        self.set_root_id(new_basis_tree.get_root_id())
 
1016
                                pb=None,
 
1017
                                change_reporter=change_reporter,
 
1018
                                show_base=show_base)
 
1019
                    basis_root_id = basis_tree.get_root_id()
 
1020
                    new_root_id = new_basis_tree.get_root_id()
 
1021
                    if new_root_id is not None and basis_root_id != new_root_id:
 
1022
                        self.set_root_id(new_root_id)
1540
1023
                finally:
1541
 
                    pb.finished()
1542
1024
                    basis_tree.unlock()
1543
1025
                # TODO - dedup parents list with things merged by pull ?
1544
1026
                # reuse the revisiontree we merged against to set the new
1545
1027
                # tree data.
1546
 
                parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1547
 
                # we have to pull the merge trees out again, because 
1548
 
                # merge_inner has set the ids. - this corner is not yet 
 
1028
                parent_trees = []
 
1029
                if self.branch.last_revision() != _mod_revision.NULL_REVISION:
 
1030
                    parent_trees.append(
 
1031
                        (self.branch.last_revision(), new_basis_tree))
 
1032
                # we have to pull the merge trees out again, because
 
1033
                # merge_inner has set the ids. - this corner is not yet
1549
1034
                # layered well enough to prevent double handling.
1550
1035
                # XXX TODO: Fix the double handling: telling the tree about
1551
1036
                # the already known parent data is wasteful.
1557
1042
            return count
1558
1043
        finally:
1559
1044
            source.unlock()
1560
 
            top_pb.finished()
1561
1045
 
1562
1046
    @needs_write_lock
1563
1047
    def put_file_bytes_non_atomic(self, file_id, bytes):
1567
1051
            stream.write(bytes)
1568
1052
        finally:
1569
1053
            stream.close()
1570
 
        # TODO: update the hashcache here ?
1571
1054
 
1572
1055
    def extras(self):
1573
1056
        """Yield all unversioned files in this WorkingTree.
1579
1062
        Currently returned depth-first, sorted by name within directories.
1580
1063
        This is the same order used by 'osutils.walkdirs'.
1581
1064
        """
1582
 
        ## TODO: Work from given directory downwards
1583
 
        for path, dir_entry in self.inventory.directories():
1584
 
            # mutter("search for unknowns in %r", path)
1585
 
            dirabs = self.abspath(path)
1586
 
            if not isdir(dirabs):
1587
 
                # e.g. directory deleted
1588
 
                continue
1589
 
 
1590
 
            fl = []
1591
 
            for subf in os.listdir(dirabs):
1592
 
                if subf == '.bzr':
1593
 
                    continue
1594
 
                if subf not in dir_entry.children:
1595
 
                    try:
1596
 
                        (subf_norm,
1597
 
                         can_access) = osutils.normalized_filename(subf)
1598
 
                    except UnicodeDecodeError:
1599
 
                        path_os_enc = path.encode(osutils._fs_enc)
1600
 
                        relpath = path_os_enc + '/' + subf
1601
 
                        raise errors.BadFilenameEncoding(relpath,
1602
 
                                                         osutils._fs_enc)
1603
 
                    if subf_norm != subf and can_access:
1604
 
                        if subf_norm not in dir_entry.children:
1605
 
                            fl.append(subf_norm)
1606
 
                    else:
1607
 
                        fl.append(subf)
1608
 
            
1609
 
            fl.sort()
1610
 
            for subf in fl:
1611
 
                subp = pathjoin(path, subf)
1612
 
                yield subp
 
1065
        raise NotImplementedError(self.extras)
1613
1066
 
1614
1067
    def ignored_files(self):
1615
1068
        """Yield list of PATH, IGNORE_PATTERN"""
1648
1101
        r"""Check whether the filename matches an ignore pattern.
1649
1102
 
1650
1103
        Patterns containing '/' or '\' need to match the whole path;
1651
 
        others match against only the last component.
 
1104
        others match against only the last component.  Patterns starting
 
1105
        with '!' are ignore exceptions.  Exceptions take precedence
 
1106
        over regular patterns and cause the filename to not be ignored.
1652
1107
 
1653
1108
        If the file is ignored, returns the pattern which caused it to
1654
1109
        be ignored, otherwise None.  So this can simply be used as a
1655
1110
        boolean if desired."""
1656
1111
        if getattr(self, '_ignoreglobster', None) is None:
1657
 
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
 
1112
            self._ignoreglobster = globbing.ExceptionGlobster(self.get_ignore_list())
1658
1113
        return self._ignoreglobster.match(filename)
1659
1114
 
1660
1115
    def kind(self, file_id):
1662
1117
 
1663
1118
    def stored_kind(self, file_id):
1664
1119
        """See Tree.stored_kind"""
1665
 
        return self.inventory[file_id].kind
 
1120
        raise NotImplementedError(self.stored_kind)
1666
1121
 
1667
1122
    def _comparison_data(self, entry, path):
1668
1123
        abspath = self.abspath(path)
1678
1133
        else:
1679
1134
            mode = stat_value.st_mode
1680
1135
            kind = osutils.file_kind_from_stat_mode(mode)
1681
 
            if not supports_executable():
 
1136
            if not self._supports_executable():
1682
1137
                executable = entry is not None and entry.executable
1683
1138
            else:
1684
1139
                executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1703
1158
        return _mod_revision.ensure_null(self.branch.last_revision())
1704
1159
 
1705
1160
    def is_locked(self):
1706
 
        return self._control_files.is_locked()
1707
 
 
1708
 
    def _must_be_locked(self):
1709
 
        if not self.is_locked():
1710
 
            raise errors.ObjectNotLocked(self)
 
1161
        """Check if this tree is locked."""
 
1162
        raise NotImplementedError(self.is_locked)
1711
1163
 
1712
1164
    def lock_read(self):
1713
 
        """See Branch.lock_read, and WorkingTree.unlock."""
1714
 
        if not self.is_locked():
1715
 
            self._reset_data()
1716
 
        self.branch.lock_read()
1717
 
        try:
1718
 
            return self._control_files.lock_read()
1719
 
        except:
1720
 
            self.branch.unlock()
1721
 
            raise
 
1165
        """Lock the tree for reading.
 
1166
 
 
1167
        This also locks the branch, and can be unlocked via self.unlock().
 
1168
 
 
1169
        :return: A bzrlib.lock.LogicalLockResult.
 
1170
        """
 
1171
        raise NotImplementedError(self.lock_read)
1722
1172
 
1723
1173
    def lock_tree_write(self):
1724
 
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1725
 
        if not self.is_locked():
1726
 
            self._reset_data()
1727
 
        self.branch.lock_read()
1728
 
        try:
1729
 
            return self._control_files.lock_write()
1730
 
        except:
1731
 
            self.branch.unlock()
1732
 
            raise
 
1174
        """See MutableTree.lock_tree_write, and WorkingTree.unlock.
 
1175
 
 
1176
        :return: A bzrlib.lock.LogicalLockResult.
 
1177
        """
 
1178
        raise NotImplementedError(self.lock_tree_write)
1733
1179
 
1734
1180
    def lock_write(self):
1735
 
        """See MutableTree.lock_write, and WorkingTree.unlock."""
1736
 
        if not self.is_locked():
1737
 
            self._reset_data()
1738
 
        self.branch.lock_write()
1739
 
        try:
1740
 
            return self._control_files.lock_write()
1741
 
        except:
1742
 
            self.branch.unlock()
1743
 
            raise
 
1181
        """See MutableTree.lock_write, and WorkingTree.unlock.
 
1182
 
 
1183
        :return: A bzrlib.lock.LogicalLockResult.
 
1184
        """
 
1185
        raise NotImplementedError(self.lock_write)
1744
1186
 
1745
1187
    def get_physical_lock_status(self):
1746
 
        return self._control_files.get_physical_lock_status()
1747
 
 
1748
 
    def _basis_inventory_name(self):
1749
 
        return 'basis-inventory-cache'
1750
 
 
1751
 
    def _reset_data(self):
1752
 
        """Reset transient data that cannot be revalidated."""
1753
 
        self._inventory_is_modified = False
1754
 
        result = self._deserialize(self._transport.get('inventory'))
1755
 
        self._set_inventory(result, dirty=False)
1756
 
 
1757
 
    @needs_tree_write_lock
 
1188
        raise NotImplementedError(self.get_physical_lock_status)
 
1189
 
1758
1190
    def set_last_revision(self, new_revision):
1759
1191
        """Change the last revision in the working tree."""
1760
 
        if self._change_last_revision(new_revision):
1761
 
            self._cache_basis_inventory(new_revision)
 
1192
        raise NotImplementedError(self.set_last_revision)
1762
1193
 
1763
1194
    def _change_last_revision(self, new_revision):
1764
1195
        """Template method part of set_last_revision to perform the change.
1765
 
        
 
1196
 
1766
1197
        This is used to allow WorkingTree3 instances to not affect branch
1767
1198
        when their last revision is set.
1768
1199
        """
1769
1200
        if _mod_revision.is_null(new_revision):
1770
 
            self.branch.set_revision_history([])
 
1201
            self.branch.set_last_revision_info(0, new_revision)
1771
1202
            return False
 
1203
        _mod_revision.check_not_reserved_id(new_revision)
1772
1204
        try:
1773
1205
            self.branch.generate_revision_history(new_revision)
1774
1206
        except errors.NoSuchRevision:
1775
1207
            # not present in the repo - dont try to set it deeper than the tip
1776
 
            self.branch.set_revision_history([new_revision])
 
1208
            self.branch._set_revision_history([new_revision])
1777
1209
        return True
1778
1210
 
1779
 
    def _write_basis_inventory(self, xml):
1780
 
        """Write the basis inventory XML to the basis-inventory file"""
1781
 
        path = self._basis_inventory_name()
1782
 
        sio = StringIO(xml)
1783
 
        self._transport.put_file(path, sio,
1784
 
            mode=self._control_files._file_mode)
1785
 
 
1786
 
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
1787
 
        """Create the text that will be saved in basis-inventory"""
1788
 
        inventory.revision_id = revision_id
1789
 
        return xml7.serializer_v7.write_inventory_to_string(inventory)
1790
 
 
1791
 
    def _cache_basis_inventory(self, new_revision):
1792
 
        """Cache new_revision as the basis inventory."""
1793
 
        # TODO: this should allow the ready-to-use inventory to be passed in,
1794
 
        # as commit already has that ready-to-use [while the format is the
1795
 
        # same, that is].
1796
 
        try:
1797
 
            # this double handles the inventory - unpack and repack - 
1798
 
            # but is easier to understand. We can/should put a conditional
1799
 
            # in here based on whether the inventory is in the latest format
1800
 
            # - perhaps we should repack all inventories on a repository
1801
 
            # upgrade ?
1802
 
            # the fast path is to copy the raw xml from the repository. If the
1803
 
            # xml contains 'revision_id="', then we assume the right 
1804
 
            # revision_id is set. We must check for this full string, because a
1805
 
            # root node id can legitimately look like 'revision_id' but cannot
1806
 
            # contain a '"'.
1807
 
            xml = self.branch.repository.get_inventory_xml(new_revision)
1808
 
            firstline = xml.split('\n', 1)[0]
1809
 
            if (not 'revision_id="' in firstline or 
1810
 
                'format="7"' not in firstline):
1811
 
                inv = self.branch.repository.deserialise_inventory(
1812
 
                    new_revision, xml)
1813
 
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
1814
 
            self._write_basis_inventory(xml)
1815
 
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1816
 
            pass
1817
 
 
1818
 
    def read_basis_inventory(self):
1819
 
        """Read the cached basis inventory."""
1820
 
        path = self._basis_inventory_name()
1821
 
        return self._transport.get_bytes(path)
1822
 
        
1823
 
    @needs_read_lock
1824
 
    def read_working_inventory(self):
1825
 
        """Read the working inventory.
1826
 
        
1827
 
        :raises errors.InventoryModified: read_working_inventory will fail
1828
 
            when the current in memory inventory has been modified.
1829
 
        """
1830
 
        # conceptually this should be an implementation detail of the tree. 
1831
 
        # XXX: Deprecate this.
1832
 
        # ElementTree does its own conversion from UTF-8, so open in
1833
 
        # binary.
1834
 
        if self._inventory_is_modified:
1835
 
            raise errors.InventoryModified(self)
1836
 
        result = self._deserialize(self._transport.get('inventory'))
1837
 
        self._set_inventory(result, dirty=False)
1838
 
        return result
1839
 
 
1840
1211
    @needs_tree_write_lock
1841
1212
    def remove(self, files, verbose=False, to_file=None, keep_files=True,
1842
1213
        force=False):
1843
 
        """Remove nominated files from the working inventory.
 
1214
        """Remove nominated files from the working tree metadata.
1844
1215
 
1845
1216
        :files: File paths relative to the basedir.
1846
1217
        :keep_files: If true, the files will also be kept.
1852
1223
 
1853
1224
        inv_delta = []
1854
1225
 
1855
 
        new_files=set()
 
1226
        all_files = set() # specified and nested files 
1856
1227
        unknown_nested_files=set()
 
1228
        if to_file is None:
 
1229
            to_file = sys.stdout
 
1230
 
 
1231
        files_to_backup = []
1857
1232
 
1858
1233
        def recurse_directory_to_add_files(directory):
1859
1234
            # Recurse directory and add all files
1860
1235
            # so we can check if they have changed.
1861
 
            for parent_info, file_infos in\
1862
 
                self.walkdirs(directory):
 
1236
            for parent_info, file_infos in self.walkdirs(directory):
1863
1237
                for relpath, basename, kind, lstat, fileid, kind in file_infos:
1864
1238
                    # Is it versioned or ignored?
1865
 
                    if self.path2id(relpath) or self.is_ignored(relpath):
 
1239
                    if self.path2id(relpath):
1866
1240
                        # Add nested content for deletion.
1867
 
                        new_files.add(relpath)
 
1241
                        all_files.add(relpath)
1868
1242
                    else:
1869
 
                        # Files which are not versioned and not ignored
 
1243
                        # Files which are not versioned
1870
1244
                        # should be treated as unknown.
1871
 
                        unknown_nested_files.add((relpath, None, kind))
 
1245
                        files_to_backup.append(relpath)
1872
1246
 
1873
1247
        for filename in files:
1874
1248
            # Get file name into canonical form.
1875
1249
            abspath = self.abspath(filename)
1876
1250
            filename = self.relpath(abspath)
1877
1251
            if len(filename) > 0:
1878
 
                new_files.add(filename)
 
1252
                all_files.add(filename)
1879
1253
                recurse_directory_to_add_files(filename)
1880
1254
 
1881
 
        files = list(new_files)
 
1255
        files = list(all_files)
1882
1256
 
1883
1257
        if len(files) == 0:
1884
1258
            return # nothing to do
1888
1262
 
1889
1263
        # Bail out if we are going to delete files we shouldn't
1890
1264
        if not keep_files and not force:
1891
 
            has_changed_files = len(unknown_nested_files) > 0
1892
 
            if not has_changed_files:
1893
 
                for (file_id, path, content_change, versioned, parent_id, name,
1894
 
                     kind, executable) in self.iter_changes(self.basis_tree(),
1895
 
                         include_unchanged=True, require_versioned=False,
1896
 
                         want_unversioned=True, specific_files=files):
1897
 
                    if versioned == (False, False):
1898
 
                        # The record is unknown ...
1899
 
                        if not self.is_ignored(path[1]):
1900
 
                            # ... but not ignored
1901
 
                            has_changed_files = True
1902
 
                            break
1903
 
                    elif content_change and (kind[1] is not None):
1904
 
                        # Versioned and changed, but not deleted
1905
 
                        has_changed_files = True
1906
 
                        break
1907
 
 
1908
 
            if has_changed_files:
1909
 
                # Make delta show ALL applicable changes in error message.
1910
 
                tree_delta = self.changes_from(self.basis_tree(),
1911
 
                    require_versioned=False, want_unversioned=True,
1912
 
                    specific_files=files)
1913
 
                for unknown_file in unknown_nested_files:
1914
 
                    if unknown_file not in tree_delta.unversioned:
1915
 
                        tree_delta.unversioned.extend((unknown_file,))
1916
 
                raise errors.BzrRemoveChangedFilesError(tree_delta)
1917
 
 
1918
 
        # Build inv_delta and delete files where applicaple,
1919
 
        # do this before any modifications to inventory.
 
1265
            for (file_id, path, content_change, versioned, parent_id, name,
 
1266
                 kind, executable) in self.iter_changes(self.basis_tree(),
 
1267
                     include_unchanged=True, require_versioned=False,
 
1268
                     want_unversioned=True, specific_files=files):
 
1269
                if versioned[0] == False:
 
1270
                    # The record is unknown or newly added
 
1271
                    files_to_backup.append(path[1])
 
1272
                elif (content_change and (kind[1] is not None) and
 
1273
                        osutils.is_inside_any(files, path[1])):
 
1274
                    # Versioned and changed, but not deleted, and still
 
1275
                    # in one of the dirs to be deleted.
 
1276
                    files_to_backup.append(path[1])
 
1277
 
 
1278
        def backup(file_to_backup):
 
1279
            backup_name = self.bzrdir._available_backup_name(file_to_backup)
 
1280
            osutils.rename(abs_path, self.abspath(backup_name))
 
1281
            return "removed %s (but kept a copy: %s)" % (file_to_backup,
 
1282
                                                         backup_name)
 
1283
 
 
1284
        # Build inv_delta and delete files where applicable,
 
1285
        # do this before any modifications to meta data.
1920
1286
        for f in files:
1921
1287
            fid = self.path2id(f)
1922
1288
            message = None
1929
1295
                        new_status = 'I'
1930
1296
                    else:
1931
1297
                        new_status = '?'
1932
 
                    textui.show_status(new_status, self.kind(fid), f,
1933
 
                                       to_file=to_file)
 
1298
                    # XXX: Really should be a more abstract reporter interface
 
1299
                    kind_ch = osutils.kind_marker(self.kind(fid))
 
1300
                    to_file.write(new_status + '       ' + f + kind_ch + '\n')
1934
1301
                # Unversion file
1935
1302
                inv_delta.append((f, None, fid, None))
1936
1303
                message = "removed %s" % (f,)
1942
1309
                        len(os.listdir(abs_path)) > 0):
1943
1310
                        if force:
1944
1311
                            osutils.rmtree(abs_path)
 
1312
                            message = "deleted %s" % (f,)
1945
1313
                        else:
1946
 
                            message = "%s is not an empty directory "\
1947
 
                                "and won't be deleted." % (f,)
 
1314
                            message = backup(f)
1948
1315
                    else:
1949
 
                        osutils.delete_any(abs_path)
1950
 
                        message = "deleted %s" % (f,)
 
1316
                        if f in files_to_backup:
 
1317
                            message = backup(f)
 
1318
                        else:
 
1319
                            osutils.delete_any(abs_path)
 
1320
                            message = "deleted %s" % (f,)
1951
1321
                elif message is not None:
1952
1322
                    # Only care if we haven't done anything yet.
1953
1323
                    message = "%s does not exist." % (f,)
1959
1329
 
1960
1330
    @needs_tree_write_lock
1961
1331
    def revert(self, filenames=None, old_tree=None, backups=True,
1962
 
               pb=DummyProgress(), report_changes=False):
 
1332
               pb=None, report_changes=False):
1963
1333
        from bzrlib.conflicts import resolve
1964
 
        if filenames == []:
1965
 
            filenames = None
1966
 
            symbol_versioning.warn('Using [] to revert all files is deprecated'
1967
 
                ' as of bzr 0.91.  Please use None (the default) instead.',
1968
 
                DeprecationWarning, stacklevel=2)
1969
1334
        if old_tree is None:
1970
1335
            basis_tree = self.basis_tree()
1971
1336
            basis_tree.lock_read()
1978
1343
            if filenames is None and len(self.get_parent_ids()) > 1:
1979
1344
                parent_trees = []
1980
1345
                last_revision = self.last_revision()
1981
 
                if last_revision != NULL_REVISION:
 
1346
                if last_revision != _mod_revision.NULL_REVISION:
1982
1347
                    if basis_tree is None:
1983
1348
                        basis_tree = self.basis_tree()
1984
1349
                        basis_tree.lock_read()
1992
1357
                basis_tree.unlock()
1993
1358
        return conflicts
1994
1359
 
 
1360
    @needs_write_lock
 
1361
    def store_uncommitted(self):
 
1362
        """Store uncommitted changes from the tree in the branch."""
 
1363
        target_tree = self.basis_tree()
 
1364
        shelf_creator = shelf.ShelfCreator(self, target_tree)
 
1365
        try:
 
1366
            if not shelf_creator.shelve_all():
 
1367
                return
 
1368
            self.branch.store_uncommitted(shelf_creator)
 
1369
            shelf_creator.transform()
 
1370
        finally:
 
1371
            shelf_creator.finalize()
 
1372
        note('Uncommitted changes stored in branch "%s".', self.branch.nick)
 
1373
 
 
1374
    @needs_write_lock
 
1375
    def restore_uncommitted(self):
 
1376
        """Restore uncommitted changes from the branch into the tree."""
 
1377
        unshelver = self.branch.get_unshelver(self)
 
1378
        if unshelver is None:
 
1379
            return
 
1380
        try:
 
1381
            merger = unshelver.make_merger()
 
1382
            merger.ignore_zero = True
 
1383
            merger.do_merge()
 
1384
            self.branch.store_uncommitted(None)
 
1385
        finally:
 
1386
            unshelver.finalize()
 
1387
 
1995
1388
    def revision_tree(self, revision_id):
1996
1389
        """See Tree.revision_tree.
1997
1390
 
1998
1391
        WorkingTree can supply revision_trees for the basis revision only
1999
1392
        because there is only one cached inventory in the bzr directory.
2000
1393
        """
2001
 
        if revision_id == self.last_revision():
2002
 
            try:
2003
 
                xml = self.read_basis_inventory()
2004
 
            except errors.NoSuchFile:
2005
 
                pass
2006
 
            else:
2007
 
                try:
2008
 
                    inv = xml7.serializer_v7.read_inventory_from_string(xml)
2009
 
                    # dont use the repository revision_tree api because we want
2010
 
                    # to supply the inventory.
2011
 
                    if inv.revision_id == revision_id:
2012
 
                        return revisiontree.RevisionTree(self.branch.repository,
2013
 
                            inv, revision_id)
2014
 
                except errors.BadInventoryFormat:
2015
 
                    pass
2016
 
        # raise if there was no inventory, or if we read the wrong inventory.
2017
 
        raise errors.NoSuchRevisionInTree(self, revision_id)
2018
 
 
2019
 
    # XXX: This method should be deprecated in favour of taking in a proper
2020
 
    # new Inventory object.
2021
 
    @needs_tree_write_lock
2022
 
    def set_inventory(self, new_inventory_list):
2023
 
        from bzrlib.inventory import (Inventory,
2024
 
                                      InventoryDirectory,
2025
 
                                      InventoryEntry,
2026
 
                                      InventoryFile,
2027
 
                                      InventoryLink)
2028
 
        inv = Inventory(self.get_root_id())
2029
 
        for path, file_id, parent, kind in new_inventory_list:
2030
 
            name = os.path.basename(path)
2031
 
            if name == "":
2032
 
                continue
2033
 
            # fixme, there should be a factory function inv,add_?? 
2034
 
            if kind == 'directory':
2035
 
                inv.add(InventoryDirectory(file_id, name, parent))
2036
 
            elif kind == 'file':
2037
 
                inv.add(InventoryFile(file_id, name, parent))
2038
 
            elif kind == 'symlink':
2039
 
                inv.add(InventoryLink(file_id, name, parent))
2040
 
            else:
2041
 
                raise errors.BzrError("unknown kind %r" % kind)
2042
 
        self._write_inventory(inv)
 
1394
        raise NotImplementedError(self.revision_tree)
2043
1395
 
2044
1396
    @needs_tree_write_lock
2045
1397
    def set_root_id(self, file_id):
2046
1398
        """Set the root id for this tree."""
2047
 
        # for compatability 
 
1399
        # for compatability
2048
1400
        if file_id is None:
2049
1401
            raise ValueError(
2050
1402
                'WorkingTree.set_root_id with fileid=None')
2054
1406
    def _set_root_id(self, file_id):
2055
1407
        """Set the root id for this tree, in a format specific manner.
2056
1408
 
2057
 
        :param file_id: The file id to assign to the root. It must not be 
 
1409
        :param file_id: The file id to assign to the root. It must not be
2058
1410
            present in the current inventory or an error will occur. It must
2059
1411
            not be None, but rather a valid file id.
2060
1412
        """
2061
 
        inv = self._inventory
2062
 
        orig_root_id = inv.root.file_id
2063
 
        # TODO: it might be nice to exit early if there was nothing
2064
 
        # to do, saving us from trigger a sync on unlock.
2065
 
        self._inventory_is_modified = True
2066
 
        # we preserve the root inventory entry object, but
2067
 
        # unlinkit from the byid index
2068
 
        del inv._byid[inv.root.file_id]
2069
 
        inv.root.file_id = file_id
2070
 
        # and link it into the index with the new changed id.
2071
 
        inv._byid[inv.root.file_id] = inv.root
2072
 
        # and finally update all children to reference the new id.
2073
 
        # XXX: this should be safe to just look at the root.children
2074
 
        # list, not the WHOLE INVENTORY.
2075
 
        for fid in inv:
2076
 
            entry = inv[fid]
2077
 
            if entry.parent_id == orig_root_id:
2078
 
                entry.parent_id = inv.root.file_id
 
1413
        raise NotImplementedError(self._set_root_id)
2079
1414
 
2080
1415
    def unlock(self):
2081
1416
        """See Branch.unlock.
2082
 
        
 
1417
 
2083
1418
        WorkingTree locking just uses the Branch locking facilities.
2084
1419
        This is current because all working trees have an embedded branch
2085
1420
        within them. IF in the future, we were to make branch data shareable
2086
 
        between multiple working trees, i.e. via shared storage, then we 
 
1421
        between multiple working trees, i.e. via shared storage, then we
2087
1422
        would probably want to lock both the local tree, and the branch.
2088
1423
        """
2089
1424
        raise NotImplementedError(self.unlock)
2090
1425
 
2091
 
    def update(self, change_reporter=None, possible_transports=None):
 
1426
    _marker = object()
 
1427
 
 
1428
    def update(self, change_reporter=None, possible_transports=None,
 
1429
               revision=None, old_tip=_marker, show_base=False):
2092
1430
        """Update a working tree along its branch.
2093
1431
 
2094
1432
        This will update the branch if its bound too, which means we have
2109
1447
        - Restore the wt.basis->wt.state changes.
2110
1448
 
2111
1449
        There isn't a single operation at the moment to do that, so we:
 
1450
 
2112
1451
        - Merge current state -> basis tree of the master w.r.t. the old tree
2113
1452
          basis.
2114
1453
        - Do a 'normal' merge of the old branch basis if it is relevant.
 
1454
 
 
1455
        :param revision: The target revision to update to. Must be in the
 
1456
            revision history.
 
1457
        :param old_tip: If branch.update() has already been run, the value it
 
1458
            returned (old tip of the branch or None). _marker is used
 
1459
            otherwise.
2115
1460
        """
2116
1461
        if self.branch.get_bound_location() is not None:
2117
1462
            self.lock_write()
2118
 
            update_branch = True
 
1463
            update_branch = (old_tip is self._marker)
2119
1464
        else:
2120
1465
            self.lock_tree_write()
2121
1466
            update_branch = False
2123
1468
            if update_branch:
2124
1469
                old_tip = self.branch.update(possible_transports)
2125
1470
            else:
2126
 
                old_tip = None
2127
 
            return self._update_tree(old_tip, change_reporter)
 
1471
                if old_tip is self._marker:
 
1472
                    old_tip = None
 
1473
            return self._update_tree(old_tip, change_reporter, revision, show_base)
2128
1474
        finally:
2129
1475
            self.unlock()
2130
1476
 
2131
1477
    @needs_tree_write_lock
2132
 
    def _update_tree(self, old_tip=None, change_reporter=None):
 
1478
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None,
 
1479
                     show_base=False):
2133
1480
        """Update a tree to the master branch.
2134
1481
 
2135
1482
        :param old_tip: if supplied, the previous tip revision the branch,
2141
1488
        # cant set that until we update the working trees last revision to be
2142
1489
        # one from the new branch, because it will just get absorbed by the
2143
1490
        # parent de-duplication logic.
2144
 
        # 
 
1491
        #
2145
1492
        # We MUST save it even if an error occurs, because otherwise the users
2146
1493
        # local work is unreferenced and will appear to have been lost.
2147
 
        # 
2148
 
        result = 0
 
1494
        #
 
1495
        nb_conflicts = 0
2149
1496
        try:
2150
1497
            last_rev = self.get_parent_ids()[0]
2151
1498
        except IndexError:
2152
1499
            last_rev = _mod_revision.NULL_REVISION
2153
 
        if last_rev != _mod_revision.ensure_null(self.branch.last_revision()):
2154
 
            # merge tree state up to new branch tip.
 
1500
        if revision is None:
 
1501
            revision = self.branch.last_revision()
 
1502
 
 
1503
        old_tip = old_tip or _mod_revision.NULL_REVISION
 
1504
 
 
1505
        if not _mod_revision.is_null(old_tip) and old_tip != last_rev:
 
1506
            # the branch we are bound to was updated
 
1507
            # merge those changes in first
 
1508
            base_tree  = self.basis_tree()
 
1509
            other_tree = self.branch.repository.revision_tree(old_tip)
 
1510
            nb_conflicts = merge.merge_inner(self.branch, other_tree,
 
1511
                                             base_tree, this_tree=self,
 
1512
                                             change_reporter=change_reporter,
 
1513
                                             show_base=show_base)
 
1514
            if nb_conflicts:
 
1515
                self.add_parent_tree((old_tip, other_tree))
 
1516
                note(gettext('Rerun update after fixing the conflicts.'))
 
1517
                return nb_conflicts
 
1518
 
 
1519
        if last_rev != _mod_revision.ensure_null(revision):
 
1520
            # the working tree is up to date with the branch
 
1521
            # we can merge the specified revision from master
 
1522
            to_tree = self.branch.repository.revision_tree(revision)
 
1523
            to_root_id = to_tree.get_root_id()
 
1524
 
2155
1525
            basis = self.basis_tree()
2156
1526
            basis.lock_read()
2157
1527
            try:
2158
 
                to_tree = self.branch.basis_tree()
2159
 
                if basis.inventory.root is None:
2160
 
                    self.set_root_id(to_tree.get_root_id())
 
1528
                if (basis.get_root_id() is None or basis.get_root_id() != to_root_id):
 
1529
                    self.set_root_id(to_root_id)
2161
1530
                    self.flush()
2162
 
                result += merge.merge_inner(
2163
 
                                      self.branch,
2164
 
                                      to_tree,
2165
 
                                      basis,
2166
 
                                      this_tree=self,
2167
 
                                      change_reporter=change_reporter)
2168
1531
            finally:
2169
1532
                basis.unlock()
 
1533
 
 
1534
            # determine the branch point
 
1535
            graph = self.branch.repository.get_graph()
 
1536
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
 
1537
                                                last_rev)
 
1538
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
1539
 
 
1540
            nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
 
1541
                                             this_tree=self,
 
1542
                                             change_reporter=change_reporter,
 
1543
                                             show_base=show_base)
 
1544
            self.set_last_revision(revision)
2170
1545
            # TODO - dedup parents list with things merged by pull ?
2171
1546
            # reuse the tree we've updated to to set the basis:
2172
 
            parent_trees = [(self.branch.last_revision(), to_tree)]
 
1547
            parent_trees = [(revision, to_tree)]
2173
1548
            merges = self.get_parent_ids()[1:]
2174
1549
            # Ideally we ask the tree for the trees here, that way the working
2175
 
            # tree can decide whether to give us teh entire tree or give us a
 
1550
            # tree can decide whether to give us the entire tree or give us a
2176
1551
            # lazy initialised tree. dirstate for instance will have the trees
2177
1552
            # in ram already, whereas a last-revision + basis-inventory tree
2178
1553
            # will not, but also does not need them when setting parents.
2179
1554
            for parent in merges:
2180
1555
                parent_trees.append(
2181
1556
                    (parent, self.branch.repository.revision_tree(parent)))
2182
 
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
 
1557
            if not _mod_revision.is_null(old_tip):
2183
1558
                parent_trees.append(
2184
1559
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
2185
1560
            self.set_parent_trees(parent_trees)
2186
1561
            last_rev = parent_trees[0][0]
2187
 
        else:
2188
 
            # the working tree had the same last-revision as the master
2189
 
            # branch did. We may still have pivot local work from the local
2190
 
            # branch into old_tip:
2191
 
            if (old_tip is not None and not _mod_revision.is_null(old_tip)):
2192
 
                self.add_parent_tree_id(old_tip)
2193
 
        if (old_tip is not None and not _mod_revision.is_null(old_tip)
2194
 
            and old_tip != last_rev):
2195
 
            # our last revision was not the prior branch last revision
2196
 
            # and we have converted that last revision to a pending merge.
2197
 
            # base is somewhere between the branch tip now
2198
 
            # and the now pending merge
2199
 
 
2200
 
            # Since we just modified the working tree and inventory, flush out
2201
 
            # the current state, before we modify it again.
2202
 
            # TODO: jam 20070214 WorkingTree3 doesn't require this, dirstate
2203
 
            #       requires it only because TreeTransform directly munges the
2204
 
            #       inventory and calls tree._write_inventory(). Ultimately we
2205
 
            #       should be able to remove this extra flush.
2206
 
            self.flush()
2207
 
            graph = self.branch.repository.get_graph()
2208
 
            base_rev_id = graph.find_unique_lca(self.branch.last_revision(),
2209
 
                                                old_tip)
2210
 
            base_tree = self.branch.repository.revision_tree(base_rev_id)
2211
 
            other_tree = self.branch.repository.revision_tree(old_tip)
2212
 
            result += merge.merge_inner(
2213
 
                                  self.branch,
2214
 
                                  other_tree,
2215
 
                                  base_tree,
2216
 
                                  this_tree=self,
2217
 
                                  change_reporter=change_reporter)
2218
 
        return result
2219
 
 
2220
 
    def _write_hashcache_if_dirty(self):
2221
 
        """Write out the hashcache if it is dirty."""
2222
 
        if self._hashcache.needs_write:
2223
 
            try:
2224
 
                self._hashcache.write()
2225
 
            except OSError, e:
2226
 
                if e.errno not in (errno.EPERM, errno.EACCES):
2227
 
                    raise
2228
 
                # TODO: jam 20061219 Should this be a warning? A single line
2229
 
                #       warning might be sufficient to let the user know what
2230
 
                #       is going on.
2231
 
                mutter('Could not write hashcache for %s\nError: %s',
2232
 
                       self._hashcache.cache_file_name(), e)
2233
 
 
2234
 
    @needs_tree_write_lock
2235
 
    def _write_inventory(self, inv):
2236
 
        """Write inventory as the current inventory."""
2237
 
        self._set_inventory(inv, dirty=True)
2238
 
        self.flush()
 
1562
        return nb_conflicts
2239
1563
 
2240
1564
    def set_conflicts(self, arg):
2241
1565
        raise errors.UnsupportedOperation(self.set_conflicts, self)
2243
1567
    def add_conflicts(self, arg):
2244
1568
        raise errors.UnsupportedOperation(self.add_conflicts, self)
2245
1569
 
2246
 
    @needs_read_lock
2247
1570
    def conflicts(self):
2248
 
        conflicts = _mod_conflicts.ConflictList()
2249
 
        for conflicted in self._iter_conflicts():
2250
 
            text = True
2251
 
            try:
2252
 
                if file_kind(self.abspath(conflicted)) != "file":
2253
 
                    text = False
2254
 
            except errors.NoSuchFile:
2255
 
                text = False
2256
 
            if text is True:
2257
 
                for suffix in ('.THIS', '.OTHER'):
2258
 
                    try:
2259
 
                        kind = file_kind(self.abspath(conflicted+suffix))
2260
 
                        if kind != "file":
2261
 
                            text = False
2262
 
                    except errors.NoSuchFile:
2263
 
                        text = False
2264
 
                    if text == False:
2265
 
                        break
2266
 
            ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2267
 
            conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2268
 
                             path=conflicted,
2269
 
                             file_id=self.path2id(conflicted)))
2270
 
        return conflicts
 
1571
        raise NotImplementedError(self.conflicts)
2271
1572
 
2272
1573
    def walkdirs(self, prefix=""):
2273
1574
        """Walk the directories of this tree.
2320
1621
                    # value.
2321
1622
                    bzrdir_loc = bisect_left(cur_disk_dir_content,
2322
1623
                        ('.bzr', '.bzr'))
2323
 
                    if cur_disk_dir_content[bzrdir_loc][0] == '.bzr':
 
1624
                    if (bzrdir_loc < len(cur_disk_dir_content)
 
1625
                        and self.bzrdir.is_control_filename(
 
1626
                            cur_disk_dir_content[bzrdir_loc][0])):
2324
1627
                        # we dont yield the contents of, or, .bzr itself.
2325
1628
                        del cur_disk_dir_content[bzrdir_loc]
2326
1629
            if inv_finished:
2391
1694
    def _walkdirs(self, prefix=""):
2392
1695
        """Walk the directories of this tree.
2393
1696
 
2394
 
           :prefix: is used as the directrory to start with.
2395
 
           returns a generator which yields items in the form:
2396
 
                ((curren_directory_path, fileid),
2397
 
                 [(file1_path, file1_name, file1_kind, None, file1_id,
2398
 
                   file1_kind), ... ])
 
1697
        :param prefix: is used as the directrory to start with.
 
1698
        :returns: a generator which yields items in the form::
 
1699
 
 
1700
            ((curren_directory_path, fileid),
 
1701
             [(file1_path, file1_name, file1_kind, None, file1_id,
 
1702
               file1_kind), ... ])
2399
1703
        """
2400
 
        _directory = 'directory'
2401
 
        # get the root in the inventory
2402
 
        inv = self.inventory
2403
 
        top_id = inv.path2id(prefix)
2404
 
        if top_id is None:
2405
 
            pending = []
2406
 
        else:
2407
 
            pending = [(prefix, '', _directory, None, top_id, None)]
2408
 
        while pending:
2409
 
            dirblock = []
2410
 
            currentdir = pending.pop()
2411
 
            # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2412
 
            top_id = currentdir[4]
2413
 
            if currentdir[0]:
2414
 
                relroot = currentdir[0] + '/'
2415
 
            else:
2416
 
                relroot = ""
2417
 
            # FIXME: stash the node in pending
2418
 
            entry = inv[top_id]
2419
 
            if entry.kind == 'directory':
2420
 
                for name, child in entry.sorted_children():
2421
 
                    dirblock.append((relroot + name, name, child.kind, None,
2422
 
                        child.file_id, child.kind
2423
 
                        ))
2424
 
            yield (currentdir[0], entry.file_id), dirblock
2425
 
            # push the user specified dirs from dirblock
2426
 
            for dir in reversed(dirblock):
2427
 
                if dir[2] == _directory:
2428
 
                    pending.append(dir)
 
1704
        raise NotImplementedError(self._walkdirs)
2429
1705
 
2430
1706
    @needs_tree_write_lock
2431
1707
    def auto_resolve(self):
2435
1711
        are considered 'resolved', because bzr always puts conflict markers
2436
1712
        into files that have text conflicts.  The corresponding .THIS .BASE and
2437
1713
        .OTHER files are deleted, as per 'resolve'.
 
1714
 
2438
1715
        :return: a tuple of ConflictLists: (un_resolved, resolved).
2439
1716
        """
2440
1717
        un_resolved = _mod_conflicts.ConflictList()
2459
1736
        self.set_conflicts(un_resolved)
2460
1737
        return un_resolved, resolved
2461
1738
 
2462
 
    @needs_read_lock
2463
 
    def _check(self):
2464
 
        tree_basis = self.basis_tree()
2465
 
        tree_basis.lock_read()
2466
 
        try:
2467
 
            repo_basis = self.branch.repository.revision_tree(
2468
 
                self.last_revision())
2469
 
            if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2470
 
                raise errors.BzrCheckError(
2471
 
                    "Mismatched basis inventory content.")
2472
 
            self._validate()
2473
 
        finally:
2474
 
            tree_basis.unlock()
2475
 
 
2476
1739
    def _validate(self):
2477
1740
        """Validate internal structures.
2478
1741
 
2484
1747
        """
2485
1748
        return
2486
1749
 
2487
 
    @needs_read_lock
 
1750
    def check_state(self):
 
1751
        """Check that the working state is/isn't valid."""
 
1752
        raise NotImplementedError(self.check_state)
 
1753
 
 
1754
    def reset_state(self, revision_ids=None):
 
1755
        """Reset the state of the working tree.
 
1756
 
 
1757
        This does a hard-reset to a last-known-good state. This is a way to
 
1758
        fix if something got corrupted (like the .bzr/checkout/dirstate file)
 
1759
        """
 
1760
        raise NotImplementedError(self.reset_state)
 
1761
 
2488
1762
    def _get_rules_searcher(self, default_searcher):
2489
1763
        """See Tree._get_rules_searcher."""
2490
1764
        if self._rules_searcher is None:
2492
1766
                self)._get_rules_searcher(default_searcher)
2493
1767
        return self._rules_searcher
2494
1768
 
2495
 
 
2496
 
class WorkingTree2(WorkingTree):
2497
 
    """This is the Format 2 working tree.
2498
 
 
2499
 
    This was the first weave based working tree. 
2500
 
     - uses os locks for locking.
2501
 
     - uses the branch last-revision.
 
1769
    def get_shelf_manager(self):
 
1770
        """Return the ShelfManager for this WorkingTree."""
 
1771
        from bzrlib.shelf import ShelfManager
 
1772
        return ShelfManager(self, self._transport)
 
1773
 
 
1774
 
 
1775
class InventoryWorkingTree(WorkingTree,
 
1776
        bzrlib.mutabletree.MutableInventoryTree):
 
1777
    """Base class for working trees that are inventory-oriented.
 
1778
 
 
1779
    The inventory is held in the `Branch` working-inventory, and the
 
1780
    files are in a directory on disk.
 
1781
 
 
1782
    It is possible for a `WorkingTree` to have a filename which is
 
1783
    not listed in the Inventory and vice versa.
2502
1784
    """
2503
1785
 
2504
 
    def __init__(self, *args, **kwargs):
2505
 
        super(WorkingTree2, self).__init__(*args, **kwargs)
2506
 
        # WorkingTree2 has more of a constraint that self._inventory must
2507
 
        # exist. Because this is an older format, we don't mind the overhead
2508
 
        # caused by the extra computation here.
2509
 
 
2510
 
        # Newer WorkingTree's should only have self._inventory set when they
2511
 
        # have a read lock.
2512
 
        if self._inventory is None:
2513
 
            self.read_working_inventory()
 
1786
    def __init__(self, basedir='.',
 
1787
                 branch=DEPRECATED_PARAMETER,
 
1788
                 _inventory=None,
 
1789
                 _control_files=None,
 
1790
                 _internal=False,
 
1791
                 _format=None,
 
1792
                 _bzrdir=None):
 
1793
        """Construct a InventoryWorkingTree instance. This is not a public API.
 
1794
 
 
1795
        :param branch: A branch to override probing for the branch.
 
1796
        """
 
1797
        super(InventoryWorkingTree, self).__init__(basedir=basedir,
 
1798
            branch=branch, _transport=_control_files._transport,
 
1799
            _internal=_internal, _format=_format, _bzrdir=_bzrdir)
 
1800
 
 
1801
        self._control_files = _control_files
 
1802
        self._detect_case_handling()
 
1803
 
 
1804
        if _inventory is None:
 
1805
            # This will be acquired on lock_read() or lock_write()
 
1806
            self._inventory_is_modified = False
 
1807
            self._inventory = None
 
1808
        else:
 
1809
            # the caller of __init__ has provided an inventory,
 
1810
            # we assume they know what they are doing - as its only
 
1811
            # the Format factory and creation methods that are
 
1812
            # permitted to do this.
 
1813
            self._set_inventory(_inventory, dirty=False)
 
1814
 
 
1815
    def _set_inventory(self, inv, dirty):
 
1816
        """Set the internal cached inventory.
 
1817
 
 
1818
        :param inv: The inventory to set.
 
1819
        :param dirty: A boolean indicating whether the inventory is the same
 
1820
            logical inventory as whats on disk. If True the inventory is not
 
1821
            the same and should be written to disk or data will be lost, if
 
1822
            False then the inventory is the same as that on disk and any
 
1823
            serialisation would be unneeded overhead.
 
1824
        """
 
1825
        self._inventory = inv
 
1826
        self._inventory_is_modified = dirty
 
1827
 
 
1828
    def _detect_case_handling(self):
 
1829
        wt_trans = self.bzrdir.get_workingtree_transport(None)
 
1830
        try:
 
1831
            wt_trans.stat(self._format.case_sensitive_filename)
 
1832
        except errors.NoSuchFile:
 
1833
            self.case_sensitive = True
 
1834
        else:
 
1835
            self.case_sensitive = False
 
1836
 
 
1837
        self._setup_directory_is_tree_reference()
 
1838
 
 
1839
    def _serialize(self, inventory, out_file):
 
1840
        xml5.serializer_v5.write_inventory(self._inventory, out_file,
 
1841
            working=True)
 
1842
 
 
1843
    def _deserialize(selt, in_file):
 
1844
        return xml5.serializer_v5.read_inventory(in_file)
 
1845
 
 
1846
    def break_lock(self):
 
1847
        """Break a lock if one is present from another instance.
 
1848
 
 
1849
        Uses the ui factory to ask for confirmation if the lock may be from
 
1850
        an active process.
 
1851
 
 
1852
        This will probe the repository for its lock as well.
 
1853
        """
 
1854
        self._control_files.break_lock()
 
1855
        self.branch.break_lock()
 
1856
 
 
1857
    def is_locked(self):
 
1858
        return self._control_files.is_locked()
 
1859
 
 
1860
    def _must_be_locked(self):
 
1861
        if not self.is_locked():
 
1862
            raise errors.ObjectNotLocked(self)
 
1863
 
 
1864
    def lock_read(self):
 
1865
        """Lock the tree for reading.
 
1866
 
 
1867
        This also locks the branch, and can be unlocked via self.unlock().
 
1868
 
 
1869
        :return: A bzrlib.lock.LogicalLockResult.
 
1870
        """
 
1871
        if not self.is_locked():
 
1872
            self._reset_data()
 
1873
        self.branch.lock_read()
 
1874
        try:
 
1875
            self._control_files.lock_read()
 
1876
            return LogicalLockResult(self.unlock)
 
1877
        except:
 
1878
            self.branch.unlock()
 
1879
            raise
2514
1880
 
2515
1881
    def lock_tree_write(self):
2516
 
        """See WorkingTree.lock_tree_write().
2517
 
 
2518
 
        In Format2 WorkingTrees we have a single lock for the branch and tree
2519
 
        so lock_tree_write() degrades to lock_write().
2520
 
        """
 
1882
        """See MutableTree.lock_tree_write, and WorkingTree.unlock.
 
1883
 
 
1884
        :return: A bzrlib.lock.LogicalLockResult.
 
1885
        """
 
1886
        if not self.is_locked():
 
1887
            self._reset_data()
 
1888
        self.branch.lock_read()
 
1889
        try:
 
1890
            self._control_files.lock_write()
 
1891
            return LogicalLockResult(self.unlock)
 
1892
        except:
 
1893
            self.branch.unlock()
 
1894
            raise
 
1895
 
 
1896
    def lock_write(self):
 
1897
        """See MutableTree.lock_write, and WorkingTree.unlock.
 
1898
 
 
1899
        :return: A bzrlib.lock.LogicalLockResult.
 
1900
        """
 
1901
        if not self.is_locked():
 
1902
            self._reset_data()
2521
1903
        self.branch.lock_write()
2522
1904
        try:
2523
 
            return self._control_files.lock_write()
 
1905
            self._control_files.lock_write()
 
1906
            return LogicalLockResult(self.unlock)
2524
1907
        except:
2525
1908
            self.branch.unlock()
2526
1909
            raise
2527
1910
 
2528
 
    def unlock(self):
2529
 
        # do non-implementation specific cleanup
2530
 
        self._cleanup()
2531
 
 
2532
 
        # we share control files:
2533
 
        if self._control_files._lock_count == 3:
2534
 
            # _inventory_is_modified is always False during a read lock.
2535
 
            if self._inventory_is_modified:
2536
 
                self.flush()
2537
 
            self._write_hashcache_if_dirty()
2538
 
                    
2539
 
        # reverse order of locking.
 
1911
    def get_physical_lock_status(self):
 
1912
        return self._control_files.get_physical_lock_status()
 
1913
 
 
1914
    @needs_tree_write_lock
 
1915
    def _write_inventory(self, inv):
 
1916
        """Write inventory as the current inventory."""
 
1917
        self._set_inventory(inv, dirty=True)
 
1918
        self.flush()
 
1919
 
 
1920
    # XXX: This method should be deprecated in favour of taking in a proper
 
1921
    # new Inventory object.
 
1922
    @needs_tree_write_lock
 
1923
    def set_inventory(self, new_inventory_list):
 
1924
        from bzrlib.inventory import (Inventory,
 
1925
                                      InventoryDirectory,
 
1926
                                      InventoryFile,
 
1927
                                      InventoryLink)
 
1928
        inv = Inventory(self.get_root_id())
 
1929
        for path, file_id, parent, kind in new_inventory_list:
 
1930
            name = os.path.basename(path)
 
1931
            if name == "":
 
1932
                continue
 
1933
            # fixme, there should be a factory function inv,add_??
 
1934
            if kind == 'directory':
 
1935
                inv.add(InventoryDirectory(file_id, name, parent))
 
1936
            elif kind == 'file':
 
1937
                inv.add(InventoryFile(file_id, name, parent))
 
1938
            elif kind == 'symlink':
 
1939
                inv.add(InventoryLink(file_id, name, parent))
 
1940
            else:
 
1941
                raise errors.BzrError("unknown kind %r" % kind)
 
1942
        self._write_inventory(inv)
 
1943
 
 
1944
    def _write_basis_inventory(self, xml):
 
1945
        """Write the basis inventory XML to the basis-inventory file"""
 
1946
        path = self._basis_inventory_name()
 
1947
        sio = StringIO(xml)
 
1948
        self._transport.put_file(path, sio,
 
1949
            mode=self.bzrdir._get_file_mode())
 
1950
 
 
1951
    def _reset_data(self):
 
1952
        """Reset transient data that cannot be revalidated."""
 
1953
        self._inventory_is_modified = False
 
1954
        f = self._transport.get('inventory')
2540
1955
        try:
2541
 
            return self._control_files.unlock()
 
1956
            result = self._deserialize(f)
2542
1957
        finally:
2543
 
            self.branch.unlock()
2544
 
 
2545
 
 
2546
 
class WorkingTree3(WorkingTree):
2547
 
    """This is the Format 3 working tree.
2548
 
 
2549
 
    This differs from the base WorkingTree by:
2550
 
     - having its own file lock
2551
 
     - having its own last-revision property.
2552
 
 
2553
 
    This is new in bzr 0.8
2554
 
    """
2555
 
 
2556
 
    @needs_read_lock
2557
 
    def _last_revision(self):
2558
 
        """See Mutable.last_revision."""
 
1958
            f.close()
 
1959
        self._set_inventory(result, dirty=False)
 
1960
 
 
1961
    def _set_root_id(self, file_id):
 
1962
        """Set the root id for this tree, in a format specific manner.
 
1963
 
 
1964
        :param file_id: The file id to assign to the root. It must not be
 
1965
            present in the current inventory or an error will occur. It must
 
1966
            not be None, but rather a valid file id.
 
1967
        """
 
1968
        inv = self._inventory
 
1969
        orig_root_id = inv.root.file_id
 
1970
        # TODO: it might be nice to exit early if there was nothing
 
1971
        # to do, saving us from trigger a sync on unlock.
 
1972
        self._inventory_is_modified = True
 
1973
        # we preserve the root inventory entry object, but
 
1974
        # unlinkit from the byid index
 
1975
        del inv._byid[inv.root.file_id]
 
1976
        inv.root.file_id = file_id
 
1977
        # and link it into the index with the new changed id.
 
1978
        inv._byid[inv.root.file_id] = inv.root
 
1979
        # and finally update all children to reference the new id.
 
1980
        # XXX: this should be safe to just look at the root.children
 
1981
        # list, not the WHOLE INVENTORY.
 
1982
        for fid in inv:
 
1983
            entry = inv[fid]
 
1984
            if entry.parent_id == orig_root_id:
 
1985
                entry.parent_id = inv.root.file_id
 
1986
 
 
1987
    @needs_tree_write_lock
 
1988
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
 
1989
        """See MutableTree.set_parent_trees."""
 
1990
        parent_ids = [rev for (rev, tree) in parents_list]
 
1991
        for revision_id in parent_ids:
 
1992
            _mod_revision.check_not_reserved_id(revision_id)
 
1993
 
 
1994
        self._check_parents_for_ghosts(parent_ids,
 
1995
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
1996
 
 
1997
        parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
 
1998
 
 
1999
        if len(parent_ids) == 0:
 
2000
            leftmost_parent_id = _mod_revision.NULL_REVISION
 
2001
            leftmost_parent_tree = None
 
2002
        else:
 
2003
            leftmost_parent_id, leftmost_parent_tree = parents_list[0]
 
2004
 
 
2005
        if self._change_last_revision(leftmost_parent_id):
 
2006
            if leftmost_parent_tree is None:
 
2007
                # If we don't have a tree, fall back to reading the
 
2008
                # parent tree from the repository.
 
2009
                self._cache_basis_inventory(leftmost_parent_id)
 
2010
            else:
 
2011
                inv = leftmost_parent_tree.root_inventory
 
2012
                xml = self._create_basis_xml_from_inventory(
 
2013
                                        leftmost_parent_id, inv)
 
2014
                self._write_basis_inventory(xml)
 
2015
        self._set_merges_from_parent_ids(parent_ids)
 
2016
 
 
2017
    def _cache_basis_inventory(self, new_revision):
 
2018
        """Cache new_revision as the basis inventory."""
 
2019
        # TODO: this should allow the ready-to-use inventory to be passed in,
 
2020
        # as commit already has that ready-to-use [while the format is the
 
2021
        # same, that is].
2559
2022
        try:
2560
 
            return self._transport.get_bytes('last-revision')
2561
 
        except errors.NoSuchFile:
2562
 
            return _mod_revision.NULL_REVISION
2563
 
 
2564
 
    def _change_last_revision(self, revision_id):
2565
 
        """See WorkingTree._change_last_revision."""
2566
 
        if revision_id is None or revision_id == NULL_REVISION:
2567
 
            try:
2568
 
                self._transport.delete('last-revision')
2569
 
            except errors.NoSuchFile:
2570
 
                pass
2571
 
            return False
2572
 
        else:
2573
 
            self._transport.put_bytes('last-revision', revision_id,
2574
 
                mode=self._control_files._file_mode)
2575
 
            return True
 
2023
            # this double handles the inventory - unpack and repack -
 
2024
            # but is easier to understand. We can/should put a conditional
 
2025
            # in here based on whether the inventory is in the latest format
 
2026
            # - perhaps we should repack all inventories on a repository
 
2027
            # upgrade ?
 
2028
            # the fast path is to copy the raw xml from the repository. If the
 
2029
            # xml contains 'revision_id="', then we assume the right
 
2030
            # revision_id is set. We must check for this full string, because a
 
2031
            # root node id can legitimately look like 'revision_id' but cannot
 
2032
            # contain a '"'.
 
2033
            xml = self.branch.repository._get_inventory_xml(new_revision)
 
2034
            firstline = xml.split('\n', 1)[0]
 
2035
            if (not 'revision_id="' in firstline or
 
2036
                'format="7"' not in firstline):
 
2037
                inv = self.branch.repository._serializer.read_inventory_from_string(
 
2038
                    xml, new_revision)
 
2039
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
 
2040
            self._write_basis_inventory(xml)
 
2041
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
 
2042
            pass
 
2043
 
 
2044
    def _basis_inventory_name(self):
 
2045
        return 'basis-inventory-cache'
 
2046
 
 
2047
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
 
2048
        """Create the text that will be saved in basis-inventory"""
 
2049
        inventory.revision_id = revision_id
 
2050
        return xml7.serializer_v7.write_inventory_to_string(inventory)
2576
2051
 
2577
2052
    @needs_tree_write_lock
2578
2053
    def set_conflicts(self, conflicts):
2579
 
        self._put_rio('conflicts', conflicts.to_stanzas(), 
 
2054
        self._put_rio('conflicts', conflicts.to_stanzas(),
2580
2055
                      CONFLICT_HEADER_1)
2581
2056
 
2582
2057
    @needs_tree_write_lock
2593
2068
        except errors.NoSuchFile:
2594
2069
            return _mod_conflicts.ConflictList()
2595
2070
        try:
2596
 
            if confile.next() != CONFLICT_HEADER_1 + '\n':
 
2071
            try:
 
2072
                if confile.next() != CONFLICT_HEADER_1 + '\n':
 
2073
                    raise errors.ConflictFormatError()
 
2074
            except StopIteration:
2597
2075
                raise errors.ConflictFormatError()
2598
 
        except StopIteration:
2599
 
            raise errors.ConflictFormatError()
2600
 
        return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2601
 
 
2602
 
    def unlock(self):
2603
 
        # do non-implementation specific cleanup
2604
 
        self._cleanup()
2605
 
        if self._control_files._lock_count == 1:
2606
 
            # _inventory_is_modified is always False during a read lock.
2607
 
            if self._inventory_is_modified:
2608
 
                self.flush()
2609
 
            self._write_hashcache_if_dirty()
2610
 
        # reverse order of locking.
2611
 
        try:
2612
 
            return self._control_files.unlock()
2613
 
        finally:
2614
 
            self.branch.unlock()
2615
 
 
2616
 
 
2617
 
def get_conflicted_stem(path):
2618
 
    for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2619
 
        if path.endswith(suffix):
2620
 
            return path[:-len(suffix)]
2621
 
 
2622
 
 
2623
 
class WorkingTreeFormat(object):
 
2076
            reader = _mod_rio.RioReader(confile)
 
2077
            return _mod_conflicts.ConflictList.from_stanzas(reader)
 
2078
        finally:
 
2079
            confile.close()
 
2080
 
 
2081
    def read_basis_inventory(self):
 
2082
        """Read the cached basis inventory."""
 
2083
        path = self._basis_inventory_name()
 
2084
        return self._transport.get_bytes(path)
 
2085
 
 
2086
    @needs_read_lock
 
2087
    def read_working_inventory(self):
 
2088
        """Read the working inventory.
 
2089
 
 
2090
        :raises errors.InventoryModified: read_working_inventory will fail
 
2091
            when the current in memory inventory has been modified.
 
2092
        """
 
2093
        # conceptually this should be an implementation detail of the tree.
 
2094
        # XXX: Deprecate this.
 
2095
        # ElementTree does its own conversion from UTF-8, so open in
 
2096
        # binary.
 
2097
        if self._inventory_is_modified:
 
2098
            raise errors.InventoryModified(self)
 
2099
        f = self._transport.get('inventory')
 
2100
        try:
 
2101
            result = self._deserialize(f)
 
2102
        finally:
 
2103
            f.close()
 
2104
        self._set_inventory(result, dirty=False)
 
2105
        return result
 
2106
 
 
2107
    @needs_read_lock
 
2108
    def get_root_id(self):
 
2109
        """Return the id of this trees root"""
 
2110
        return self._inventory.root.file_id
 
2111
 
 
2112
    def has_id(self, file_id):
 
2113
        # files that have been deleted are excluded
 
2114
        inv, inv_file_id = self._unpack_file_id(file_id)
 
2115
        if not inv.has_id(inv_file_id):
 
2116
            return False
 
2117
        path = inv.id2path(inv_file_id)
 
2118
        return osutils.lexists(self.abspath(path))
 
2119
 
 
2120
    def has_or_had_id(self, file_id):
 
2121
        if file_id == self.get_root_id():
 
2122
            return True
 
2123
        inv, inv_file_id = self._unpack_file_id(file_id)
 
2124
        return inv.has_id(inv_file_id)
 
2125
 
 
2126
    def all_file_ids(self):
 
2127
        """Iterate through file_ids for this tree.
 
2128
 
 
2129
        file_ids are in a WorkingTree if they are in the working inventory
 
2130
        and the working file exists.
 
2131
        """
 
2132
        ret = set()
 
2133
        for path, ie in self.iter_entries_by_dir():
 
2134
            ret.add(ie.file_id)
 
2135
        return ret
 
2136
 
 
2137
    @needs_tree_write_lock
 
2138
    def set_last_revision(self, new_revision):
 
2139
        """Change the last revision in the working tree."""
 
2140
        if self._change_last_revision(new_revision):
 
2141
            self._cache_basis_inventory(new_revision)
 
2142
 
 
2143
    def _get_check_refs(self):
 
2144
        """Return the references needed to perform a check of this tree.
 
2145
        
 
2146
        The default implementation returns no refs, and is only suitable for
 
2147
        trees that have no local caching and can commit on ghosts at any time.
 
2148
 
 
2149
        :seealso: bzrlib.check for details about check_refs.
 
2150
        """
 
2151
        return []
 
2152
 
 
2153
    @needs_read_lock
 
2154
    def _check(self, references):
 
2155
        """Check the tree for consistency.
 
2156
 
 
2157
        :param references: A dict with keys matching the items returned by
 
2158
            self._get_check_refs(), and values from looking those keys up in
 
2159
            the repository.
 
2160
        """
 
2161
        tree_basis = self.basis_tree()
 
2162
        tree_basis.lock_read()
 
2163
        try:
 
2164
            repo_basis = references[('trees', self.last_revision())]
 
2165
            if len(list(repo_basis.iter_changes(tree_basis))) > 0:
 
2166
                raise errors.BzrCheckError(
 
2167
                    "Mismatched basis inventory content.")
 
2168
            self._validate()
 
2169
        finally:
 
2170
            tree_basis.unlock()
 
2171
 
 
2172
    @needs_read_lock
 
2173
    def check_state(self):
 
2174
        """Check that the working state is/isn't valid."""
 
2175
        check_refs = self._get_check_refs()
 
2176
        refs = {}
 
2177
        for ref in check_refs:
 
2178
            kind, value = ref
 
2179
            if kind == 'trees':
 
2180
                refs[ref] = self.branch.repository.revision_tree(value)
 
2181
        self._check(refs)
 
2182
 
 
2183
    @needs_tree_write_lock
 
2184
    def reset_state(self, revision_ids=None):
 
2185
        """Reset the state of the working tree.
 
2186
 
 
2187
        This does a hard-reset to a last-known-good state. This is a way to
 
2188
        fix if something got corrupted (like the .bzr/checkout/dirstate file)
 
2189
        """
 
2190
        if revision_ids is None:
 
2191
            revision_ids = self.get_parent_ids()
 
2192
        if not revision_ids:
 
2193
            rt = self.branch.repository.revision_tree(
 
2194
                _mod_revision.NULL_REVISION)
 
2195
        else:
 
2196
            rt = self.branch.repository.revision_tree(revision_ids[0])
 
2197
        self._write_inventory(rt.root_inventory)
 
2198
        self.set_parent_ids(revision_ids)
 
2199
 
 
2200
    def flush(self):
 
2201
        """Write the in memory inventory to disk."""
 
2202
        # TODO: Maybe this should only write on dirty ?
 
2203
        if self._control_files._lock_mode != 'w':
 
2204
            raise errors.NotWriteLocked(self)
 
2205
        sio = StringIO()
 
2206
        self._serialize(self._inventory, sio)
 
2207
        sio.seek(0)
 
2208
        self._transport.put_file('inventory', sio,
 
2209
            mode=self.bzrdir._get_file_mode())
 
2210
        self._inventory_is_modified = False
 
2211
 
 
2212
    def get_file_mtime(self, file_id, path=None):
 
2213
        """See Tree.get_file_mtime."""
 
2214
        if not path:
 
2215
            path = self.id2path(file_id)
 
2216
        try:
 
2217
            return os.lstat(self.abspath(path)).st_mtime
 
2218
        except OSError, e:
 
2219
            if e.errno == errno.ENOENT:
 
2220
                raise errors.FileTimestampUnavailable(path)
 
2221
            raise
 
2222
 
 
2223
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
 
2224
        inv, file_id = self._path2inv_file_id(path)
 
2225
        if file_id is None:
 
2226
            # For unversioned files on win32, we just assume they are not
 
2227
            # executable
 
2228
            return False
 
2229
        return inv[file_id].executable
 
2230
 
 
2231
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
 
2232
        mode = stat_result.st_mode
 
2233
        return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
 
2234
 
 
2235
    def is_executable(self, file_id, path=None):
 
2236
        if not self._supports_executable():
 
2237
            inv, inv_file_id = self._unpack_file_id(file_id)
 
2238
            return inv[inv_file_id].executable
 
2239
        else:
 
2240
            if not path:
 
2241
                path = self.id2path(file_id)
 
2242
            mode = os.lstat(self.abspath(path)).st_mode
 
2243
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
 
2244
 
 
2245
    def _is_executable_from_path_and_stat(self, path, stat_result):
 
2246
        if not self._supports_executable():
 
2247
            return self._is_executable_from_path_and_stat_from_basis(path, stat_result)
 
2248
        else:
 
2249
            return self._is_executable_from_path_and_stat_from_stat(path, stat_result)
 
2250
 
 
2251
    @needs_tree_write_lock
 
2252
    def _add(self, files, ids, kinds):
 
2253
        """See MutableTree._add."""
 
2254
        # TODO: Re-adding a file that is removed in the working copy
 
2255
        # should probably put it back with the previous ID.
 
2256
        # the read and write working inventory should not occur in this
 
2257
        # function - they should be part of lock_write and unlock.
 
2258
        # FIXME: nested trees
 
2259
        inv = self.root_inventory
 
2260
        for f, file_id, kind in zip(files, ids, kinds):
 
2261
            if file_id is None:
 
2262
                inv.add_path(f, kind=kind)
 
2263
            else:
 
2264
                inv.add_path(f, kind=kind, file_id=file_id)
 
2265
            self._inventory_is_modified = True
 
2266
 
 
2267
    def revision_tree(self, revision_id):
 
2268
        """See WorkingTree.revision_id."""
 
2269
        if revision_id == self.last_revision():
 
2270
            try:
 
2271
                xml = self.read_basis_inventory()
 
2272
            except errors.NoSuchFile:
 
2273
                pass
 
2274
            else:
 
2275
                try:
 
2276
                    inv = xml7.serializer_v7.read_inventory_from_string(xml)
 
2277
                    # dont use the repository revision_tree api because we want
 
2278
                    # to supply the inventory.
 
2279
                    if inv.revision_id == revision_id:
 
2280
                        return revisiontree.InventoryRevisionTree(
 
2281
                            self.branch.repository, inv, revision_id)
 
2282
                except errors.BadInventoryFormat:
 
2283
                    pass
 
2284
        # raise if there was no inventory, or if we read the wrong inventory.
 
2285
        raise errors.NoSuchRevisionInTree(self, revision_id)
 
2286
 
 
2287
    @needs_read_lock
 
2288
    def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
 
2289
        """See Tree.annotate_iter
 
2290
 
 
2291
        This implementation will use the basis tree implementation if possible.
 
2292
        Lines not in the basis are attributed to CURRENT_REVISION
 
2293
 
 
2294
        If there are pending merges, lines added by those merges will be
 
2295
        incorrectly attributed to CURRENT_REVISION (but after committing, the
 
2296
        attribution will be correct).
 
2297
        """
 
2298
        maybe_file_parent_keys = []
 
2299
        for parent_id in self.get_parent_ids():
 
2300
            try:
 
2301
                parent_tree = self.revision_tree(parent_id)
 
2302
            except errors.NoSuchRevisionInTree:
 
2303
                parent_tree = self.branch.repository.revision_tree(parent_id)
 
2304
            parent_tree.lock_read()
 
2305
            try:
 
2306
                try:
 
2307
                    kind = parent_tree.kind(file_id)
 
2308
                except errors.NoSuchId:
 
2309
                    continue
 
2310
                if kind != 'file':
 
2311
                    # Note: this is slightly unnecessary, because symlinks and
 
2312
                    # directories have a "text" which is the empty text, and we
 
2313
                    # know that won't mess up annotations. But it seems cleaner
 
2314
                    continue
 
2315
                parent_text_key = (
 
2316
                    file_id, parent_tree.get_file_revision(file_id))
 
2317
                if parent_text_key not in maybe_file_parent_keys:
 
2318
                    maybe_file_parent_keys.append(parent_text_key)
 
2319
            finally:
 
2320
                parent_tree.unlock()
 
2321
        graph = _mod_graph.Graph(self.branch.repository.texts)
 
2322
        heads = graph.heads(maybe_file_parent_keys)
 
2323
        file_parent_keys = []
 
2324
        for key in maybe_file_parent_keys:
 
2325
            if key in heads:
 
2326
                file_parent_keys.append(key)
 
2327
 
 
2328
        # Now we have the parents of this content
 
2329
        annotator = self.branch.repository.texts.get_annotator()
 
2330
        text = self.get_file_text(file_id)
 
2331
        this_key =(file_id, default_revision)
 
2332
        annotator.add_special_text(this_key, file_parent_keys, text)
 
2333
        annotations = [(key[-1], line)
 
2334
                       for key, line in annotator.annotate_flat(this_key)]
 
2335
        return annotations
 
2336
 
 
2337
    def _put_rio(self, filename, stanzas, header):
 
2338
        self._must_be_locked()
 
2339
        my_file = _mod_rio.rio_file(stanzas, header)
 
2340
        self._transport.put_file(filename, my_file,
 
2341
            mode=self.bzrdir._get_file_mode())
 
2342
 
 
2343
    @needs_tree_write_lock
 
2344
    def set_merge_modified(self, modified_hashes):
 
2345
        def iter_stanzas():
 
2346
            for file_id, hash in modified_hashes.iteritems():
 
2347
                yield _mod_rio.Stanza(file_id=file_id.decode('utf8'),
 
2348
                    hash=hash)
 
2349
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
 
2350
 
 
2351
    @needs_read_lock
 
2352
    def merge_modified(self):
 
2353
        """Return a dictionary of files modified by a merge.
 
2354
 
 
2355
        The list is initialized by WorkingTree.set_merge_modified, which is
 
2356
        typically called after we make some automatic updates to the tree
 
2357
        because of a merge.
 
2358
 
 
2359
        This returns a map of file_id->sha1, containing only files which are
 
2360
        still in the working inventory and have that text hash.
 
2361
        """
 
2362
        try:
 
2363
            hashfile = self._transport.get('merge-hashes')
 
2364
        except errors.NoSuchFile:
 
2365
            return {}
 
2366
        try:
 
2367
            merge_hashes = {}
 
2368
            try:
 
2369
                if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
 
2370
                    raise errors.MergeModifiedFormatError()
 
2371
            except StopIteration:
 
2372
                raise errors.MergeModifiedFormatError()
 
2373
            for s in _mod_rio.RioReader(hashfile):
 
2374
                # RioReader reads in Unicode, so convert file_ids back to utf8
 
2375
                file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
 
2376
                if not self.has_id(file_id):
 
2377
                    continue
 
2378
                text_hash = s.get("hash")
 
2379
                if text_hash == self.get_file_sha1(file_id):
 
2380
                    merge_hashes[file_id] = text_hash
 
2381
            return merge_hashes
 
2382
        finally:
 
2383
            hashfile.close()
 
2384
 
 
2385
    @needs_write_lock
 
2386
    def subsume(self, other_tree):
 
2387
        def add_children(inventory, entry):
 
2388
            for child_entry in entry.children.values():
 
2389
                inventory._byid[child_entry.file_id] = child_entry
 
2390
                if child_entry.kind == 'directory':
 
2391
                    add_children(inventory, child_entry)
 
2392
        if other_tree.get_root_id() == self.get_root_id():
 
2393
            raise errors.BadSubsumeSource(self, other_tree,
 
2394
                                          'Trees have the same root')
 
2395
        try:
 
2396
            other_tree_path = self.relpath(other_tree.basedir)
 
2397
        except errors.PathNotChild:
 
2398
            raise errors.BadSubsumeSource(self, other_tree,
 
2399
                'Tree is not contained by the other')
 
2400
        new_root_parent = self.path2id(osutils.dirname(other_tree_path))
 
2401
        if new_root_parent is None:
 
2402
            raise errors.BadSubsumeSource(self, other_tree,
 
2403
                'Parent directory is not versioned.')
 
2404
        # We need to ensure that the result of a fetch will have a
 
2405
        # versionedfile for the other_tree root, and only fetching into
 
2406
        # RepositoryKnit2 guarantees that.
 
2407
        if not self.branch.repository.supports_rich_root():
 
2408
            raise errors.SubsumeTargetNeedsUpgrade(other_tree)
 
2409
        other_tree.lock_tree_write()
 
2410
        try:
 
2411
            new_parents = other_tree.get_parent_ids()
 
2412
            other_root = other_tree.root_inventory.root
 
2413
            other_root.parent_id = new_root_parent
 
2414
            other_root.name = osutils.basename(other_tree_path)
 
2415
            self.root_inventory.add(other_root)
 
2416
            add_children(self.root_inventory, other_root)
 
2417
            self._write_inventory(self.root_inventory)
 
2418
            # normally we don't want to fetch whole repositories, but i think
 
2419
            # here we really do want to consolidate the whole thing.
 
2420
            for parent_id in other_tree.get_parent_ids():
 
2421
                self.branch.fetch(other_tree.branch, parent_id)
 
2422
                self.add_parent_tree_id(parent_id)
 
2423
        finally:
 
2424
            other_tree.unlock()
 
2425
        other_tree.bzrdir.retire_bzrdir()
 
2426
 
 
2427
    @needs_tree_write_lock
 
2428
    def extract(self, file_id, format=None):
 
2429
        """Extract a subtree from this tree.
 
2430
 
 
2431
        A new branch will be created, relative to the path for this tree.
 
2432
        """
 
2433
        self.flush()
 
2434
        def mkdirs(path):
 
2435
            segments = osutils.splitpath(path)
 
2436
            transport = self.branch.bzrdir.root_transport
 
2437
            for name in segments:
 
2438
                transport = transport.clone(name)
 
2439
                transport.ensure_base()
 
2440
            return transport
 
2441
 
 
2442
        sub_path = self.id2path(file_id)
 
2443
        branch_transport = mkdirs(sub_path)
 
2444
        if format is None:
 
2445
            format = self.bzrdir.cloning_metadir()
 
2446
        branch_transport.ensure_base()
 
2447
        branch_bzrdir = format.initialize_on_transport(branch_transport)
 
2448
        try:
 
2449
            repo = branch_bzrdir.find_repository()
 
2450
        except errors.NoRepositoryPresent:
 
2451
            repo = branch_bzrdir.create_repository()
 
2452
        if not repo.supports_rich_root():
 
2453
            raise errors.RootNotRich()
 
2454
        new_branch = branch_bzrdir.create_branch()
 
2455
        new_branch.pull(self.branch)
 
2456
        for parent_id in self.get_parent_ids():
 
2457
            new_branch.fetch(self.branch, parent_id)
 
2458
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
 
2459
        if tree_transport.base != branch_transport.base:
 
2460
            tree_bzrdir = format.initialize_on_transport(tree_transport)
 
2461
            tree_bzrdir.set_branch_reference(new_branch)
 
2462
        else:
 
2463
            tree_bzrdir = branch_bzrdir
 
2464
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
 
2465
        wt.set_parent_ids(self.get_parent_ids())
 
2466
        # FIXME: Support nested trees
 
2467
        my_inv = self.root_inventory
 
2468
        child_inv = inventory.Inventory(root_id=None)
 
2469
        new_root = my_inv[file_id]
 
2470
        my_inv.remove_recursive_id(file_id)
 
2471
        new_root.parent_id = None
 
2472
        child_inv.add(new_root)
 
2473
        self._write_inventory(my_inv)
 
2474
        wt._write_inventory(child_inv)
 
2475
        return wt
 
2476
 
 
2477
    def list_files(self, include_root=False, from_dir=None, recursive=True):
 
2478
        """List all files as (path, class, kind, id, entry).
 
2479
 
 
2480
        Lists, but does not descend into unversioned directories.
 
2481
        This does not include files that have been deleted in this
 
2482
        tree. Skips the control directory.
 
2483
 
 
2484
        :param include_root: if True, return an entry for the root
 
2485
        :param from_dir: start from this directory or None for the root
 
2486
        :param recursive: whether to recurse into subdirectories or not
 
2487
        """
 
2488
        # list_files is an iterator, so @needs_read_lock doesn't work properly
 
2489
        # with it. So callers should be careful to always read_lock the tree.
 
2490
        if not self.is_locked():
 
2491
            raise errors.ObjectNotLocked(self)
 
2492
 
 
2493
        if from_dir is None and include_root is True:
 
2494
            yield ('', 'V', 'directory', self.get_root_id(), self.root_inventory.root)
 
2495
        # Convert these into local objects to save lookup times
 
2496
        pathjoin = osutils.pathjoin
 
2497
        file_kind = self._kind
 
2498
 
 
2499
        # transport.base ends in a slash, we want the piece
 
2500
        # between the last two slashes
 
2501
        transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
 
2502
 
 
2503
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
 
2504
 
 
2505
        # directory file_id, relative path, absolute path, reverse sorted children
 
2506
        if from_dir is not None:
 
2507
            inv, from_dir_id = self._path2inv_file_id(from_dir)
 
2508
            if from_dir_id is None:
 
2509
                # Directory not versioned
 
2510
                return
 
2511
            from_dir_abspath = pathjoin(self.basedir, from_dir)
 
2512
        else:
 
2513
            inv = self.root_inventory
 
2514
            from_dir_id = inv.root.file_id
 
2515
            from_dir_abspath = self.basedir
 
2516
        children = os.listdir(from_dir_abspath)
 
2517
        children.sort()
 
2518
        # jam 20060527 The kernel sized tree seems equivalent whether we
 
2519
        # use a deque and popleft to keep them sorted, or if we use a plain
 
2520
        # list and just reverse() them.
 
2521
        children = collections.deque(children)
 
2522
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
 
2523
        while stack:
 
2524
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
 
2525
 
 
2526
            while children:
 
2527
                f = children.popleft()
 
2528
                ## TODO: If we find a subdirectory with its own .bzr
 
2529
                ## directory, then that is a separate tree and we
 
2530
                ## should exclude it.
 
2531
 
 
2532
                # the bzrdir for this tree
 
2533
                if transport_base_dir == f:
 
2534
                    continue
 
2535
 
 
2536
                # we know that from_dir_relpath and from_dir_abspath never end in a slash
 
2537
                # and 'f' doesn't begin with one, we can do a string op, rather
 
2538
                # than the checks of pathjoin(), all relative paths will have an extra slash
 
2539
                # at the beginning
 
2540
                fp = from_dir_relpath + '/' + f
 
2541
 
 
2542
                # absolute path
 
2543
                fap = from_dir_abspath + '/' + f
 
2544
 
 
2545
                dir_ie = inv[from_dir_id]
 
2546
                if dir_ie.kind == 'directory':
 
2547
                    f_ie = dir_ie.children.get(f)
 
2548
                else:
 
2549
                    f_ie = None
 
2550
                if f_ie:
 
2551
                    c = 'V'
 
2552
                elif self.is_ignored(fp[1:]):
 
2553
                    c = 'I'
 
2554
                else:
 
2555
                    # we may not have found this file, because of a unicode
 
2556
                    # issue, or because the directory was actually a symlink.
 
2557
                    f_norm, can_access = osutils.normalized_filename(f)
 
2558
                    if f == f_norm or not can_access:
 
2559
                        # No change, so treat this file normally
 
2560
                        c = '?'
 
2561
                    else:
 
2562
                        # this file can be accessed by a normalized path
 
2563
                        # check again if it is versioned
 
2564
                        # these lines are repeated here for performance
 
2565
                        f = f_norm
 
2566
                        fp = from_dir_relpath + '/' + f
 
2567
                        fap = from_dir_abspath + '/' + f
 
2568
                        f_ie = inv.get_child(from_dir_id, f)
 
2569
                        if f_ie:
 
2570
                            c = 'V'
 
2571
                        elif self.is_ignored(fp[1:]):
 
2572
                            c = 'I'
 
2573
                        else:
 
2574
                            c = '?'
 
2575
 
 
2576
                fk = file_kind(fap)
 
2577
 
 
2578
                # make a last minute entry
 
2579
                if f_ie:
 
2580
                    yield fp[1:], c, fk, f_ie.file_id, f_ie
 
2581
                else:
 
2582
                    try:
 
2583
                        yield fp[1:], c, fk, None, fk_entries[fk]()
 
2584
                    except KeyError:
 
2585
                        yield fp[1:], c, fk, None, TreeEntry()
 
2586
                    continue
 
2587
 
 
2588
                if fk != 'directory':
 
2589
                    continue
 
2590
 
 
2591
                # But do this child first if recursing down
 
2592
                if recursive:
 
2593
                    new_children = os.listdir(fap)
 
2594
                    new_children.sort()
 
2595
                    new_children = collections.deque(new_children)
 
2596
                    stack.append((f_ie.file_id, fp, fap, new_children))
 
2597
                    # Break out of inner loop,
 
2598
                    # so that we start outer loop with child
 
2599
                    break
 
2600
            else:
 
2601
                # if we finished all children, pop it off the stack
 
2602
                stack.pop()
 
2603
 
 
2604
    @needs_tree_write_lock
 
2605
    def move(self, from_paths, to_dir=None, after=False):
 
2606
        """Rename files.
 
2607
 
 
2608
        to_dir must exist in the inventory.
 
2609
 
 
2610
        If to_dir exists and is a directory, the files are moved into
 
2611
        it, keeping their old names.
 
2612
 
 
2613
        Note that to_dir is only the last component of the new name;
 
2614
        this doesn't change the directory.
 
2615
 
 
2616
        For each entry in from_paths the move mode will be determined
 
2617
        independently.
 
2618
 
 
2619
        The first mode moves the file in the filesystem and updates the
 
2620
        inventory. The second mode only updates the inventory without
 
2621
        touching the file on the filesystem.
 
2622
 
 
2623
        move uses the second mode if 'after == True' and the target is
 
2624
        either not versioned or newly added, and present in the working tree.
 
2625
 
 
2626
        move uses the second mode if 'after == False' and the source is
 
2627
        versioned but no longer in the working tree, and the target is not
 
2628
        versioned but present in the working tree.
 
2629
 
 
2630
        move uses the first mode if 'after == False' and the source is
 
2631
        versioned and present in the working tree, and the target is not
 
2632
        versioned and not present in the working tree.
 
2633
 
 
2634
        Everything else results in an error.
 
2635
 
 
2636
        This returns a list of (from_path, to_path) pairs for each
 
2637
        entry that is moved.
 
2638
        """
 
2639
        rename_entries = []
 
2640
        rename_tuples = []
 
2641
 
 
2642
        invs_to_write = set()
 
2643
 
 
2644
        # check for deprecated use of signature
 
2645
        if to_dir is None:
 
2646
            raise TypeError('You must supply a target directory')
 
2647
        # check destination directory
 
2648
        if isinstance(from_paths, basestring):
 
2649
            raise ValueError()
 
2650
        to_abs = self.abspath(to_dir)
 
2651
        if not isdir(to_abs):
 
2652
            raise errors.BzrMoveFailedError('',to_dir,
 
2653
                errors.NotADirectory(to_abs))
 
2654
        if not self.has_filename(to_dir):
 
2655
            raise errors.BzrMoveFailedError('',to_dir,
 
2656
                errors.NotInWorkingDirectory(to_dir))
 
2657
        to_inv, to_dir_id = self._path2inv_file_id(to_dir)
 
2658
        if to_dir_id is None:
 
2659
            raise errors.BzrMoveFailedError('',to_dir,
 
2660
                errors.NotVersionedError(path=to_dir))
 
2661
 
 
2662
        to_dir_ie = to_inv[to_dir_id]
 
2663
        if to_dir_ie.kind != 'directory':
 
2664
            raise errors.BzrMoveFailedError('',to_dir,
 
2665
                errors.NotADirectory(to_abs))
 
2666
 
 
2667
        # create rename entries and tuples
 
2668
        for from_rel in from_paths:
 
2669
            from_tail = splitpath(from_rel)[-1]
 
2670
            from_inv, from_id = self._path2inv_file_id(from_rel)
 
2671
            if from_id is None:
 
2672
                raise errors.BzrMoveFailedError(from_rel,to_dir,
 
2673
                    errors.NotVersionedError(path=from_rel))
 
2674
 
 
2675
            from_entry = from_inv[from_id]
 
2676
            from_parent_id = from_entry.parent_id
 
2677
            to_rel = pathjoin(to_dir, from_tail)
 
2678
            rename_entry = InventoryWorkingTree._RenameEntry(
 
2679
                from_rel=from_rel,
 
2680
                from_id=from_id,
 
2681
                from_tail=from_tail,
 
2682
                from_parent_id=from_parent_id,
 
2683
                to_rel=to_rel, to_tail=from_tail,
 
2684
                to_parent_id=to_dir_id)
 
2685
            rename_entries.append(rename_entry)
 
2686
            rename_tuples.append((from_rel, to_rel))
 
2687
 
 
2688
        # determine which move mode to use. checks also for movability
 
2689
        rename_entries = self._determine_mv_mode(rename_entries, after)
 
2690
 
 
2691
        original_modified = self._inventory_is_modified
 
2692
        try:
 
2693
            if len(from_paths):
 
2694
                self._inventory_is_modified = True
 
2695
            self._move(rename_entries)
 
2696
        except:
 
2697
            # restore the inventory on error
 
2698
            self._inventory_is_modified = original_modified
 
2699
            raise
 
2700
        #FIXME: Should potentially also write the from_invs
 
2701
        self._write_inventory(to_inv)
 
2702
        return rename_tuples
 
2703
 
 
2704
    @needs_tree_write_lock
 
2705
    def rename_one(self, from_rel, to_rel, after=False):
 
2706
        """Rename one file.
 
2707
 
 
2708
        This can change the directory or the filename or both.
 
2709
 
 
2710
        rename_one has several 'modes' to work. First, it can rename a physical
 
2711
        file and change the file_id. That is the normal mode. Second, it can
 
2712
        only change the file_id without touching any physical file.
 
2713
 
 
2714
        rename_one uses the second mode if 'after == True' and 'to_rel' is not
 
2715
        versioned but present in the working tree.
 
2716
 
 
2717
        rename_one uses the second mode if 'after == False' and 'from_rel' is
 
2718
        versioned but no longer in the working tree, and 'to_rel' is not
 
2719
        versioned but present in the working tree.
 
2720
 
 
2721
        rename_one uses the first mode if 'after == False' and 'from_rel' is
 
2722
        versioned and present in the working tree, and 'to_rel' is not
 
2723
        versioned and not present in the working tree.
 
2724
 
 
2725
        Everything else results in an error.
 
2726
        """
 
2727
        rename_entries = []
 
2728
 
 
2729
        # create rename entries and tuples
 
2730
        from_tail = splitpath(from_rel)[-1]
 
2731
        from_inv, from_id = self._path2inv_file_id(from_rel)
 
2732
        if from_id is None:
 
2733
            # if file is missing in the inventory maybe it's in the basis_tree
 
2734
            basis_tree = self.branch.basis_tree()
 
2735
            from_id = basis_tree.path2id(from_rel)
 
2736
            if from_id is None:
 
2737
                raise errors.BzrRenameFailedError(from_rel,to_rel,
 
2738
                    errors.NotVersionedError(path=from_rel))
 
2739
            # put entry back in the inventory so we can rename it
 
2740
            from_entry = basis_tree.root_inventory[from_id].copy()
 
2741
            from_inv.add(from_entry)
 
2742
        else:
 
2743
            from_inv, from_inv_id = self._unpack_file_id(from_id)
 
2744
            from_entry = from_inv[from_inv_id]
 
2745
        from_parent_id = from_entry.parent_id
 
2746
        to_dir, to_tail = os.path.split(to_rel)
 
2747
        to_inv, to_dir_id = self._path2inv_file_id(to_dir)
 
2748
        rename_entry = InventoryWorkingTree._RenameEntry(from_rel=from_rel,
 
2749
                                     from_id=from_id,
 
2750
                                     from_tail=from_tail,
 
2751
                                     from_parent_id=from_parent_id,
 
2752
                                     to_rel=to_rel, to_tail=to_tail,
 
2753
                                     to_parent_id=to_dir_id)
 
2754
        rename_entries.append(rename_entry)
 
2755
 
 
2756
        # determine which move mode to use. checks also for movability
 
2757
        rename_entries = self._determine_mv_mode(rename_entries, after)
 
2758
 
 
2759
        # check if the target changed directory and if the target directory is
 
2760
        # versioned
 
2761
        if to_dir_id is None:
 
2762
            raise errors.BzrMoveFailedError(from_rel,to_rel,
 
2763
                errors.NotVersionedError(path=to_dir))
 
2764
 
 
2765
        # all checks done. now we can continue with our actual work
 
2766
        mutter('rename_one:\n'
 
2767
               '  from_id   {%s}\n'
 
2768
               '  from_rel: %r\n'
 
2769
               '  to_rel:   %r\n'
 
2770
               '  to_dir    %r\n'
 
2771
               '  to_dir_id {%s}\n',
 
2772
               from_id, from_rel, to_rel, to_dir, to_dir_id)
 
2773
 
 
2774
        self._move(rename_entries)
 
2775
        self._write_inventory(to_inv)
 
2776
 
 
2777
    class _RenameEntry(object):
 
2778
        def __init__(self, from_rel, from_id, from_tail, from_parent_id,
 
2779
                     to_rel, to_tail, to_parent_id, only_change_inv=False,
 
2780
                     change_id=False):
 
2781
            self.from_rel = from_rel
 
2782
            self.from_id = from_id
 
2783
            self.from_tail = from_tail
 
2784
            self.from_parent_id = from_parent_id
 
2785
            self.to_rel = to_rel
 
2786
            self.to_tail = to_tail
 
2787
            self.to_parent_id = to_parent_id
 
2788
            self.change_id = change_id
 
2789
            self.only_change_inv = only_change_inv
 
2790
 
 
2791
    def _determine_mv_mode(self, rename_entries, after=False):
 
2792
        """Determines for each from-to pair if both inventory and working tree
 
2793
        or only the inventory has to be changed.
 
2794
 
 
2795
        Also does basic plausability tests.
 
2796
        """
 
2797
        # FIXME: Handling of nested trees
 
2798
        inv = self.root_inventory
 
2799
 
 
2800
        for rename_entry in rename_entries:
 
2801
            # store to local variables for easier reference
 
2802
            from_rel = rename_entry.from_rel
 
2803
            from_id = rename_entry.from_id
 
2804
            to_rel = rename_entry.to_rel
 
2805
            to_id = inv.path2id(to_rel)
 
2806
            only_change_inv = False
 
2807
            change_id = False
 
2808
 
 
2809
            # check the inventory for source and destination
 
2810
            if from_id is None:
 
2811
                raise errors.BzrMoveFailedError(from_rel,to_rel,
 
2812
                    errors.NotVersionedError(path=from_rel))
 
2813
            if to_id is not None:
 
2814
                allowed = False
 
2815
                # allow it with --after but only if dest is newly added
 
2816
                if after:
 
2817
                    basis = self.basis_tree()
 
2818
                    basis.lock_read()
 
2819
                    try:
 
2820
                        if not basis.has_id(to_id):
 
2821
                            rename_entry.change_id = True
 
2822
                            allowed = True
 
2823
                    finally:
 
2824
                        basis.unlock()
 
2825
                if not allowed:
 
2826
                    raise errors.BzrMoveFailedError(from_rel,to_rel,
 
2827
                        errors.AlreadyVersionedError(path=to_rel))
 
2828
 
 
2829
            # try to determine the mode for rename (only change inv or change
 
2830
            # inv and file system)
 
2831
            if after:
 
2832
                if not self.has_filename(to_rel):
 
2833
                    raise errors.BzrMoveFailedError(from_id,to_rel,
 
2834
                        errors.NoSuchFile(path=to_rel,
 
2835
                        extra="New file has not been created yet"))
 
2836
                only_change_inv = True
 
2837
            elif not self.has_filename(from_rel) and self.has_filename(to_rel):
 
2838
                only_change_inv = True
 
2839
            elif self.has_filename(from_rel) and not self.has_filename(to_rel):
 
2840
                only_change_inv = False
 
2841
            elif (not self.case_sensitive
 
2842
                  and from_rel.lower() == to_rel.lower()
 
2843
                  and self.has_filename(from_rel)):
 
2844
                only_change_inv = False
 
2845
            else:
 
2846
                # something is wrong, so lets determine what exactly
 
2847
                if not self.has_filename(from_rel) and \
 
2848
                   not self.has_filename(to_rel):
 
2849
                    raise errors.BzrRenameFailedError(from_rel, to_rel,
 
2850
                        errors.PathsDoNotExist(paths=(from_rel, to_rel)))
 
2851
                else:
 
2852
                    raise errors.RenameFailedFilesExist(from_rel, to_rel)
 
2853
            rename_entry.only_change_inv = only_change_inv
 
2854
        return rename_entries
 
2855
 
 
2856
    def _move(self, rename_entries):
 
2857
        """Moves a list of files.
 
2858
 
 
2859
        Depending on the value of the flag 'only_change_inv', the
 
2860
        file will be moved on the file system or not.
 
2861
        """
 
2862
        moved = []
 
2863
 
 
2864
        for entry in rename_entries:
 
2865
            try:
 
2866
                self._move_entry(entry)
 
2867
            except:
 
2868
                self._rollback_move(moved)
 
2869
                raise
 
2870
            moved.append(entry)
 
2871
 
 
2872
    def _rollback_move(self, moved):
 
2873
        """Try to rollback a previous move in case of an filesystem error."""
 
2874
        for entry in moved:
 
2875
            try:
 
2876
                self._move_entry(WorkingTree._RenameEntry(
 
2877
                    entry.to_rel, entry.from_id,
 
2878
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
 
2879
                    entry.from_tail, entry.from_parent_id,
 
2880
                    entry.only_change_inv))
 
2881
            except errors.BzrMoveFailedError, e:
 
2882
                raise errors.BzrMoveFailedError( '', '', "Rollback failed."
 
2883
                        " The working tree is in an inconsistent state."
 
2884
                        " Please consider doing a 'bzr revert'."
 
2885
                        " Error message is: %s" % e)
 
2886
 
 
2887
    def _move_entry(self, entry):
 
2888
        inv = self.root_inventory
 
2889
        from_rel_abs = self.abspath(entry.from_rel)
 
2890
        to_rel_abs = self.abspath(entry.to_rel)
 
2891
        if from_rel_abs == to_rel_abs:
 
2892
            raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
 
2893
                "Source and target are identical.")
 
2894
 
 
2895
        if not entry.only_change_inv:
 
2896
            try:
 
2897
                osutils.rename(from_rel_abs, to_rel_abs)
 
2898
            except OSError, e:
 
2899
                raise errors.BzrMoveFailedError(entry.from_rel,
 
2900
                    entry.to_rel, e[1])
 
2901
        if entry.change_id:
 
2902
            to_id = inv.path2id(entry.to_rel)
 
2903
            inv.remove_recursive_id(to_id)
 
2904
        inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
 
2905
 
 
2906
    @needs_tree_write_lock
 
2907
    def unversion(self, file_ids):
 
2908
        """Remove the file ids in file_ids from the current versioned set.
 
2909
 
 
2910
        When a file_id is unversioned, all of its children are automatically
 
2911
        unversioned.
 
2912
 
 
2913
        :param file_ids: The file ids to stop versioning.
 
2914
        :raises: NoSuchId if any fileid is not currently versioned.
 
2915
        """
 
2916
        for file_id in file_ids:
 
2917
            if not self._inventory.has_id(file_id):
 
2918
                raise errors.NoSuchId(self, file_id)
 
2919
        for file_id in file_ids:
 
2920
            if self._inventory.has_id(file_id):
 
2921
                self._inventory.remove_recursive_id(file_id)
 
2922
        if len(file_ids):
 
2923
            # in the future this should just set a dirty bit to wait for the
 
2924
            # final unlock. However, until all methods of workingtree start
 
2925
            # with the current in -memory inventory rather than triggering
 
2926
            # a read, it is more complex - we need to teach read_inventory
 
2927
            # to know when to read, and when to not read first... and possibly
 
2928
            # to save first when the in memory one may be corrupted.
 
2929
            # so for now, we just only write it if it is indeed dirty.
 
2930
            # - RBC 20060907
 
2931
            self._write_inventory(self._inventory)
 
2932
 
 
2933
    def stored_kind(self, file_id):
 
2934
        """See Tree.stored_kind"""
 
2935
        inv, inv_file_id = self._unpack_file_id(file_id)
 
2936
        return inv[inv_file_id].kind
 
2937
 
 
2938
    def extras(self):
 
2939
        """Yield all unversioned files in this WorkingTree.
 
2940
 
 
2941
        If there are any unversioned directories then only the directory is
 
2942
        returned, not all its children.  But if there are unversioned files
 
2943
        under a versioned subdirectory, they are returned.
 
2944
 
 
2945
        Currently returned depth-first, sorted by name within directories.
 
2946
        This is the same order used by 'osutils.walkdirs'.
 
2947
        """
 
2948
        ## TODO: Work from given directory downwards
 
2949
        for path, dir_entry in self.iter_entries_by_dir():
 
2950
            if dir_entry.kind != 'directory':
 
2951
                continue
 
2952
            # mutter("search for unknowns in %r", path)
 
2953
            dirabs = self.abspath(path)
 
2954
            if not isdir(dirabs):
 
2955
                # e.g. directory deleted
 
2956
                continue
 
2957
 
 
2958
            fl = []
 
2959
            for subf in os.listdir(dirabs):
 
2960
                if self.bzrdir.is_control_filename(subf):
 
2961
                    continue
 
2962
                if subf not in dir_entry.children:
 
2963
                    try:
 
2964
                        (subf_norm,
 
2965
                         can_access) = osutils.normalized_filename(subf)
 
2966
                    except UnicodeDecodeError:
 
2967
                        path_os_enc = path.encode(osutils._fs_enc)
 
2968
                        relpath = path_os_enc + '/' + subf
 
2969
                        raise errors.BadFilenameEncoding(relpath,
 
2970
                                                         osutils._fs_enc)
 
2971
                    if subf_norm != subf and can_access:
 
2972
                        if subf_norm not in dir_entry.children:
 
2973
                            fl.append(subf_norm)
 
2974
                    else:
 
2975
                        fl.append(subf)
 
2976
 
 
2977
            fl.sort()
 
2978
            for subf in fl:
 
2979
                subp = pathjoin(path, subf)
 
2980
                yield subp
 
2981
 
 
2982
    def _walkdirs(self, prefix=""):
 
2983
        """Walk the directories of this tree.
 
2984
 
 
2985
        :param prefix: is used as the directrory to start with.
 
2986
        :returns: a generator which yields items in the form::
 
2987
 
 
2988
            ((curren_directory_path, fileid),
 
2989
             [(file1_path, file1_name, file1_kind, None, file1_id,
 
2990
               file1_kind), ... ])
 
2991
        """
 
2992
        _directory = 'directory'
 
2993
        # get the root in the inventory
 
2994
        inv, top_id = self._path2inv_file_id(prefix)
 
2995
        if top_id is None:
 
2996
            pending = []
 
2997
        else:
 
2998
            pending = [(prefix, '', _directory, None, top_id, None)]
 
2999
        while pending:
 
3000
            dirblock = []
 
3001
            currentdir = pending.pop()
 
3002
            # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
 
3003
            top_id = currentdir[4]
 
3004
            if currentdir[0]:
 
3005
                relroot = currentdir[0] + '/'
 
3006
            else:
 
3007
                relroot = ""
 
3008
            # FIXME: stash the node in pending
 
3009
            entry = inv[top_id]
 
3010
            if entry.kind == 'directory':
 
3011
                for name, child in entry.sorted_children():
 
3012
                    dirblock.append((relroot + name, name, child.kind, None,
 
3013
                        child.file_id, child.kind
 
3014
                        ))
 
3015
            yield (currentdir[0], entry.file_id), dirblock
 
3016
            # push the user specified dirs from dirblock
 
3017
            for dir in reversed(dirblock):
 
3018
                if dir[2] == _directory:
 
3019
                    pending.append(dir)
 
3020
 
 
3021
    @needs_write_lock
 
3022
    def update_feature_flags(self, updated_flags):
 
3023
        """Update the feature flags for this branch.
 
3024
 
 
3025
        :param updated_flags: Dictionary mapping feature names to necessities
 
3026
            A necessity can be None to indicate the feature should be removed
 
3027
        """
 
3028
        self._format._update_feature_flags(updated_flags)
 
3029
        self.control_transport.put_bytes('format', self._format.as_string())
 
3030
 
 
3031
 
 
3032
class WorkingTreeFormatRegistry(controldir.ControlComponentFormatRegistry):
 
3033
    """Registry for working tree formats."""
 
3034
 
 
3035
    def __init__(self, other_registry=None):
 
3036
        super(WorkingTreeFormatRegistry, self).__init__(other_registry)
 
3037
        self._default_format = None
 
3038
        self._default_format_key = None
 
3039
 
 
3040
    def get_default(self):
 
3041
        """Return the current default format."""
 
3042
        if (self._default_format_key is not None and
 
3043
            self._default_format is None):
 
3044
            self._default_format = self.get(self._default_format_key)
 
3045
        return self._default_format
 
3046
 
 
3047
    def set_default(self, format):
 
3048
        """Set the default format."""
 
3049
        self._default_format = format
 
3050
        self._default_format_key = None
 
3051
 
 
3052
    def set_default_key(self, format_string):
 
3053
        """Set the default format by its format string."""
 
3054
        self._default_format_key = format_string
 
3055
        self._default_format = None
 
3056
 
 
3057
 
 
3058
format_registry = WorkingTreeFormatRegistry()
 
3059
 
 
3060
 
 
3061
class WorkingTreeFormat(controldir.ControlComponentFormat):
2624
3062
    """An encapsulation of the initialization and open routines for a format.
2625
3063
 
2626
3064
    Formats provide three things:
2628
3066
     * a format string,
2629
3067
     * an open routine.
2630
3068
 
2631
 
    Formats are placed in an dict by their format string for reference 
 
3069
    Formats are placed in an dict by their format string for reference
2632
3070
    during workingtree opening. Its not required that these be instances, they
2633
 
    can be classes themselves with class methods - it simply depends on 
 
3071
    can be classes themselves with class methods - it simply depends on
2634
3072
    whether state is needed for a given format or not.
2635
3073
 
2636
3074
    Once a format is deprecated, just deprecate the initialize and open
2637
 
    methods on the format class. Do not deprecate the object, as the 
 
3075
    methods on the format class. Do not deprecate the object, as the
2638
3076
    object will be created every time regardless.
2639
3077
    """
2640
3078
 
2641
 
    _default_format = None
2642
 
    """The default format used for new trees."""
2643
 
 
2644
 
    _formats = {}
2645
 
    """The known formats."""
2646
 
 
2647
3079
    requires_rich_root = False
2648
3080
 
2649
3081
    upgrade_recommended = False
2650
3082
 
2651
 
    @classmethod
2652
 
    def find_format(klass, a_bzrdir):
2653
 
        """Return the format for the working tree object in a_bzrdir."""
2654
 
        try:
2655
 
            transport = a_bzrdir.get_workingtree_transport(None)
2656
 
            format_string = transport.get("format").read()
2657
 
            return klass._formats[format_string]
2658
 
        except errors.NoSuchFile:
2659
 
            raise errors.NoWorkingTree(base=transport.base)
2660
 
        except KeyError:
2661
 
            raise errors.UnknownFormatError(format=format_string,
2662
 
                                            kind="working tree")
 
3083
    requires_normalized_unicode_filenames = False
 
3084
 
 
3085
    case_sensitive_filename = "FoRMaT"
 
3086
 
 
3087
    missing_parent_conflicts = False
 
3088
    """If this format supports missing parent conflicts."""
 
3089
 
 
3090
    supports_versioned_directories = None
 
3091
 
 
3092
    def initialize(self, controldir, revision_id=None, from_branch=None,
 
3093
                   accelerator_tree=None, hardlink=False):
 
3094
        """Initialize a new working tree in controldir.
 
3095
 
 
3096
        :param controldir: ControlDir to initialize the working tree in.
 
3097
        :param revision_id: allows creating a working tree at a different
 
3098
            revision than the branch is at.
 
3099
        :param from_branch: Branch to checkout
 
3100
        :param accelerator_tree: A tree which can be used for retrieving file
 
3101
            contents more quickly than the revision tree, i.e. a workingtree.
 
3102
            The revision tree will be used for cases where accelerator_tree's
 
3103
            content is different.
 
3104
        :param hardlink: If true, hard-link files from accelerator_tree,
 
3105
            where possible.
 
3106
        """
 
3107
        raise NotImplementedError(self.initialize)
2663
3108
 
2664
3109
    def __eq__(self, other):
2665
3110
        return self.__class__ is other.__class__
2667
3112
    def __ne__(self, other):
2668
3113
        return not (self == other)
2669
3114
 
2670
 
    @classmethod
2671
 
    def get_default_format(klass):
2672
 
        """Return the current default format."""
2673
 
        return klass._default_format
2674
 
 
2675
 
    def get_format_string(self):
2676
 
        """Return the ASCII format string that identifies this format."""
2677
 
        raise NotImplementedError(self.get_format_string)
2678
 
 
2679
3115
    def get_format_description(self):
2680
3116
        """Return the short description for this format."""
2681
3117
        raise NotImplementedError(self.get_format_description)
2684
3120
        """Is this format supported?
2685
3121
 
2686
3122
        Supported formats can be initialized and opened.
2687
 
        Unsupported formats may not support initialization or committing or 
 
3123
        Unsupported formats may not support initialization or committing or
2688
3124
        some other features depending on the reason for not being supported.
2689
3125
        """
2690
3126
        return True
2691
3127
 
2692
 
    @classmethod
2693
 
    def register_format(klass, format):
2694
 
        klass._formats[format.get_format_string()] = format
2695
 
 
2696
 
    @classmethod
2697
 
    def set_default_format(klass, format):
2698
 
        klass._default_format = format
2699
 
 
2700
 
    @classmethod
2701
 
    def unregister_format(klass, format):
2702
 
        del klass._formats[format.get_format_string()]
2703
 
 
2704
 
 
2705
 
class WorkingTreeFormat2(WorkingTreeFormat):
2706
 
    """The second working tree format. 
2707
 
 
2708
 
    This format modified the hash cache from the format 1 hash cache.
2709
 
    """
2710
 
 
2711
 
    upgrade_recommended = True
2712
 
 
2713
 
    def get_format_description(self):
2714
 
        """See WorkingTreeFormat.get_format_description()."""
2715
 
        return "Working tree format 2"
2716
 
 
2717
 
    def _stub_initialize_on_transport(self, transport, file_mode):
2718
 
        """Workaround: create control files for a remote working tree.
2719
 
 
2720
 
        This ensures that it can later be updated and dealt with locally,
2721
 
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2722
 
        no working tree.  (See bug #43064).
2723
 
        """
2724
 
        sio = StringIO()
2725
 
        inv = Inventory()
2726
 
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
2727
 
        sio.seek(0)
2728
 
        transport.put_file('inventory', sio, file_mode)
2729
 
        transport.put_bytes('pending-merges', '', file_mode)
2730
 
 
2731
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2732
 
                   accelerator_tree=None, hardlink=False):
2733
 
        """See WorkingTreeFormat.initialize()."""
2734
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
2735
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2736
 
        if from_branch is not None:
2737
 
            branch = from_branch
2738
 
        else:
2739
 
            branch = a_bzrdir.open_branch()
2740
 
        if revision_id is None:
2741
 
            revision_id = _mod_revision.ensure_null(branch.last_revision())
2742
 
        branch.lock_write()
2743
 
        try:
2744
 
            branch.generate_revision_history(revision_id)
2745
 
        finally:
2746
 
            branch.unlock()
2747
 
        inv = Inventory()
2748
 
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2749
 
                         branch,
2750
 
                         inv,
2751
 
                         _internal=True,
2752
 
                         _format=self,
2753
 
                         _bzrdir=a_bzrdir)
2754
 
        basis_tree = branch.repository.revision_tree(revision_id)
2755
 
        if basis_tree.inventory.root is not None:
2756
 
            wt.set_root_id(basis_tree.get_root_id())
2757
 
        # set the parent list and cache the basis tree.
2758
 
        if _mod_revision.is_null(revision_id):
2759
 
            parent_trees = []
2760
 
        else:
2761
 
            parent_trees = [(revision_id, basis_tree)]
2762
 
        wt.set_parent_trees(parent_trees)
2763
 
        transform.build_tree(basis_tree, wt)
2764
 
        return wt
2765
 
 
2766
 
    def __init__(self):
2767
 
        super(WorkingTreeFormat2, self).__init__()
2768
 
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
2769
 
 
2770
 
    def open(self, a_bzrdir, _found=False):
2771
 
        """Return the WorkingTree object for a_bzrdir
2772
 
 
2773
 
        _found is a private parameter, do not use it. It is used to indicate
2774
 
               if format probing has already been done.
2775
 
        """
2776
 
        if not _found:
2777
 
            # we are being called directly and must probe.
2778
 
            raise NotImplementedError
2779
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
2780
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2781
 
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2782
 
                           _internal=True,
2783
 
                           _format=self,
2784
 
                           _bzrdir=a_bzrdir)
2785
 
        return wt
2786
 
 
2787
 
class WorkingTreeFormat3(WorkingTreeFormat):
2788
 
    """The second working tree format updated to record a format marker.
2789
 
 
2790
 
    This format:
2791
 
        - exists within a metadir controlling .bzr
2792
 
        - includes an explicit version marker for the workingtree control
2793
 
          files, separate from the BzrDir format
2794
 
        - modifies the hash cache format
2795
 
        - is new in bzr 0.8
2796
 
        - uses a LockDir to guard access for writes.
2797
 
    """
2798
 
    
2799
 
    upgrade_recommended = True
2800
 
 
2801
 
    def get_format_string(self):
2802
 
        """See WorkingTreeFormat.get_format_string()."""
2803
 
        return "Bazaar-NG Working Tree format 3"
2804
 
 
2805
 
    def get_format_description(self):
2806
 
        """See WorkingTreeFormat.get_format_description()."""
2807
 
        return "Working tree format 3"
2808
 
 
2809
 
    _lock_file_name = 'lock'
2810
 
    _lock_class = LockDir
2811
 
 
2812
 
    _tree_class = WorkingTree3
2813
 
 
2814
 
    def __get_matchingbzrdir(self):
2815
 
        return bzrdir.BzrDirMetaFormat1()
2816
 
 
2817
 
    _matchingbzrdir = property(__get_matchingbzrdir)
2818
 
 
2819
 
    def _open_control_files(self, a_bzrdir):
2820
 
        transport = a_bzrdir.get_workingtree_transport(None)
2821
 
        return LockableFiles(transport, self._lock_file_name, 
2822
 
                             self._lock_class)
2823
 
 
2824
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2825
 
                   accelerator_tree=None, hardlink=False):
2826
 
        """See WorkingTreeFormat.initialize().
2827
 
        
2828
 
        :param revision_id: if supplied, create a working tree at a different
2829
 
            revision than the branch is at.
2830
 
        :param accelerator_tree: A tree which can be used for retrieving file
2831
 
            contents more quickly than the revision tree, i.e. a workingtree.
2832
 
            The revision tree will be used for cases where accelerator_tree's
2833
 
            content is different.
2834
 
        :param hardlink: If true, hard-link files from accelerator_tree,
2835
 
            where possible.
2836
 
        """
2837
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
2838
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2839
 
        transport = a_bzrdir.get_workingtree_transport(self)
2840
 
        control_files = self._open_control_files(a_bzrdir)
2841
 
        control_files.create_lock()
2842
 
        control_files.lock_write()
2843
 
        transport.put_bytes('format', self.get_format_string(),
2844
 
            mode=control_files._file_mode)
2845
 
        if from_branch is not None:
2846
 
            branch = from_branch
2847
 
        else:
2848
 
            branch = a_bzrdir.open_branch()
2849
 
        if revision_id is None:
2850
 
            revision_id = _mod_revision.ensure_null(branch.last_revision())
2851
 
        # WorkingTree3 can handle an inventory which has a unique root id.
2852
 
        # as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2853
 
        # those trees. And because there isn't a format bump inbetween, we
2854
 
        # are maintaining compatibility with older clients.
2855
 
        # inv = Inventory(root_id=gen_root_id())
2856
 
        inv = self._initial_inventory()
2857
 
        wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2858
 
                         branch,
2859
 
                         inv,
2860
 
                         _internal=True,
2861
 
                         _format=self,
2862
 
                         _bzrdir=a_bzrdir,
2863
 
                         _control_files=control_files)
2864
 
        wt.lock_tree_write()
2865
 
        try:
2866
 
            basis_tree = branch.repository.revision_tree(revision_id)
2867
 
            # only set an explicit root id if there is one to set.
2868
 
            if basis_tree.inventory.root is not None:
2869
 
                wt.set_root_id(basis_tree.get_root_id())
2870
 
            if revision_id == NULL_REVISION:
2871
 
                wt.set_parent_trees([])
2872
 
            else:
2873
 
                wt.set_parent_trees([(revision_id, basis_tree)])
2874
 
            transform.build_tree(basis_tree, wt)
2875
 
        finally:
2876
 
            # Unlock in this order so that the unlock-triggers-flush in
2877
 
            # WorkingTree is given a chance to fire.
2878
 
            control_files.unlock()
2879
 
            wt.unlock()
2880
 
        return wt
2881
 
 
2882
 
    def _initial_inventory(self):
2883
 
        return Inventory()
2884
 
 
2885
 
    def __init__(self):
2886
 
        super(WorkingTreeFormat3, self).__init__()
2887
 
 
2888
 
    def open(self, a_bzrdir, _found=False):
2889
 
        """Return the WorkingTree object for a_bzrdir
2890
 
 
2891
 
        _found is a private parameter, do not use it. It is used to indicate
2892
 
               if format probing has already been done.
2893
 
        """
2894
 
        if not _found:
2895
 
            # we are being called directly and must probe.
2896
 
            raise NotImplementedError
2897
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
2898
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2899
 
        wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2900
 
        return wt
2901
 
 
2902
 
    def _open(self, a_bzrdir, control_files):
2903
 
        """Open the tree itself.
2904
 
        
2905
 
        :param a_bzrdir: the dir for the tree.
2906
 
        :param control_files: the control files for the tree.
2907
 
        """
2908
 
        return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2909
 
                                _internal=True,
2910
 
                                _format=self,
2911
 
                                _bzrdir=a_bzrdir,
2912
 
                                _control_files=control_files)
2913
 
 
2914
 
    def __str__(self):
2915
 
        return self.get_format_string()
2916
 
 
2917
 
 
2918
 
__default_format = WorkingTreeFormat4()
2919
 
WorkingTreeFormat.register_format(__default_format)
2920
 
WorkingTreeFormat.register_format(WorkingTreeFormat3())
2921
 
WorkingTreeFormat.set_default_format(__default_format)
2922
 
# formats which have no format string are not discoverable
2923
 
# and not independently creatable, so are not registered.
2924
 
_legacy_formats = [WorkingTreeFormat2(),
2925
 
                   ]
 
3128
    def supports_content_filtering(self):
 
3129
        """True if this format supports content filtering."""
 
3130
        return False
 
3131
 
 
3132
    def supports_views(self):
 
3133
        """True if this format supports stored views."""
 
3134
        return False
 
3135
 
 
3136
    def get_controldir_for_branch(self):
 
3137
        """Get the control directory format for creating branches.
 
3138
 
 
3139
        This is to support testing of working tree formats that can not exist
 
3140
        in the same control directory as a branch.
 
3141
        """
 
3142
        return self._matchingbzrdir
 
3143
 
 
3144
 
 
3145
class WorkingTreeFormatMetaDir(bzrdir.BzrFormat, WorkingTreeFormat):
 
3146
    """Base class for working trees that live in bzr meta directories."""
 
3147
 
 
3148
    def __init__(self):
 
3149
        WorkingTreeFormat.__init__(self)
 
3150
        bzrdir.BzrFormat.__init__(self)
 
3151
 
 
3152
    @classmethod
 
3153
    def find_format_string(klass, controldir):
 
3154
        """Return format name for the working tree object in controldir."""
 
3155
        try:
 
3156
            transport = controldir.get_workingtree_transport(None)
 
3157
            return transport.get_bytes("format")
 
3158
        except errors.NoSuchFile:
 
3159
            raise errors.NoWorkingTree(base=transport.base)
 
3160
 
 
3161
    @classmethod
 
3162
    def find_format(klass, controldir):
 
3163
        """Return the format for the working tree object in controldir."""
 
3164
        format_string = klass.find_format_string(controldir)
 
3165
        return klass._find_format(format_registry, 'working tree',
 
3166
                format_string)
 
3167
 
 
3168
    def check_support_status(self, allow_unsupported, recommend_upgrade=True,
 
3169
            basedir=None):
 
3170
        WorkingTreeFormat.check_support_status(self,
 
3171
            allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
 
3172
            basedir=basedir)
 
3173
        bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
 
3174
            recommend_upgrade=recommend_upgrade, basedir=basedir)
 
3175
 
 
3176
    def get_controldir_for_branch(self):
 
3177
        """Get the control directory format for creating branches.
 
3178
 
 
3179
        This is to support testing of working tree formats that can not exist
 
3180
        in the same control directory as a branch.
 
3181
        """
 
3182
        return self._matchingbzrdir
 
3183
 
 
3184
 
 
3185
class WorkingTreeFormatMetaDir(bzrdir.BzrFormat, WorkingTreeFormat):
 
3186
    """Base class for working trees that live in bzr meta directories."""
 
3187
 
 
3188
    def __init__(self):
 
3189
        WorkingTreeFormat.__init__(self)
 
3190
        bzrdir.BzrFormat.__init__(self)
 
3191
 
 
3192
    @classmethod
 
3193
    def find_format_string(klass, controldir):
 
3194
        """Return format name for the working tree object in controldir."""
 
3195
        try:
 
3196
            transport = controldir.get_workingtree_transport(None)
 
3197
            return transport.get_bytes("format")
 
3198
        except errors.NoSuchFile:
 
3199
            raise errors.NoWorkingTree(base=transport.base)
 
3200
 
 
3201
    @classmethod
 
3202
    def find_format(klass, controldir):
 
3203
        """Return the format for the working tree object in controldir."""
 
3204
        format_string = klass.find_format_string(controldir)
 
3205
        return klass._find_format(format_registry, 'working tree',
 
3206
                format_string)
 
3207
 
 
3208
    def check_support_status(self, allow_unsupported, recommend_upgrade=True,
 
3209
            basedir=None):
 
3210
        WorkingTreeFormat.check_support_status(self,
 
3211
            allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
 
3212
            basedir=basedir)
 
3213
        bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
 
3214
            recommend_upgrade=recommend_upgrade, basedir=basedir)
 
3215
 
 
3216
 
 
3217
format_registry.register_lazy("Bazaar Working Tree Format 4 (bzr 0.15)\n",
 
3218
    "bzrlib.workingtree_4", "WorkingTreeFormat4")
 
3219
format_registry.register_lazy("Bazaar Working Tree Format 5 (bzr 1.11)\n",
 
3220
    "bzrlib.workingtree_4", "WorkingTreeFormat5")
 
3221
format_registry.register_lazy("Bazaar Working Tree Format 6 (bzr 1.14)\n",
 
3222
    "bzrlib.workingtree_4", "WorkingTreeFormat6")
 
3223
format_registry.register_lazy("Bazaar-NG Working Tree format 3",
 
3224
    "bzrlib.workingtree_3", "WorkingTreeFormat3")
 
3225
format_registry.set_default_key("Bazaar Working Tree Format 6 (bzr 1.14)\n")