/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to breezy/workingtree.py

  • Committer: Jelmer Vernooij
  • Date: 2017-06-07 01:17:16 UTC
  • mto: (6653.3.7 bzrwt)
  • mto: This revision was merged to the branch mainline in revision 6668.
  • Revision ID: jelmer@jelmer.uk-20170607011716-hsqdox2pyaqcm4kn
Fix some more tests.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/workingtree.py
1
 
# Copyright (C) 2005-2010 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
18
18
 
19
19
A WorkingTree represents the editable working copy of a branch.
20
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
 
new revision based on the workingtree and its inventory.
 
21
such as renaming or adding files.  
24
22
 
25
23
At the moment every WorkingTree has its own branch.  Remote
26
24
WorkingTrees aren't supported.
29
27
WorkingTree.open(dir).
30
28
"""
31
29
 
 
30
from __future__ import absolute_import
32
31
 
33
 
from cStringIO import StringIO
 
32
import errno
34
33
import os
 
34
import re
35
35
import sys
36
36
 
37
 
from bzrlib.lazy_import import lazy_import
 
37
import breezy
 
38
 
 
39
from .lazy_import import lazy_import
38
40
lazy_import(globals(), """
39
41
from bisect import bisect_left
40
 
import collections
41
 
import errno
42
42
import itertools
43
43
import operator
44
44
import stat
45
 
import re
46
45
 
47
 
import bzrlib
48
 
from bzrlib import (
 
46
from breezy import (
49
47
    branch,
50
 
    bzrdir,
51
48
    conflicts as _mod_conflicts,
 
49
    controldir,
52
50
    errors,
 
51
    filters as _mod_filters,
53
52
    generate_ids,
54
53
    globbing,
55
 
    graph as _mod_graph,
56
 
    hashcache,
57
54
    ignores,
58
 
    inventory,
59
55
    merge,
60
56
    revision as _mod_revision,
61
 
    revisiontree,
62
 
    trace,
 
57
    shelf,
63
58
    transform,
64
59
    ui,
65
60
    views,
66
 
    xml5,
67
 
    xml7,
68
 
    )
69
 
import bzrlib.branch
70
 
from bzrlib.transport import get_transport
71
 
from bzrlib.workingtree_4 import (
72
 
    WorkingTreeFormat4,
73
 
    WorkingTreeFormat5,
74
 
    WorkingTreeFormat6,
75
61
    )
76
62
""")
77
63
 
78
 
from bzrlib import symbol_versioning
79
 
from bzrlib.decorators import needs_read_lock, needs_write_lock
80
 
from bzrlib.lockable_files import LockableFiles
81
 
from bzrlib.lockdir import LockDir
82
 
import bzrlib.mutabletree
83
 
from bzrlib.mutabletree import needs_tree_write_lock
84
 
from bzrlib import osutils
85
 
from bzrlib.osutils import (
86
 
    file_kind,
87
 
    isdir,
88
 
    normpath,
89
 
    pathjoin,
90
 
    realpath,
91
 
    safe_unicode,
92
 
    splitpath,
93
 
    supports_executable,
94
 
    )
95
 
from bzrlib.filters import filtered_input_file
96
 
from bzrlib.trace import mutter, note
97
 
from bzrlib.transport.local import LocalTransport
98
 
from bzrlib.revision import CURRENT_REVISION
99
 
from bzrlib.rio import RioReader, rio_file, Stanza
100
 
from bzrlib.symbol_versioning import (
101
 
    deprecated_passed,
102
 
    DEPRECATED_PARAMETER,
103
 
    )
104
 
 
105
 
 
106
 
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
107
 
# TODO: Modifying the conflict objects or their type is currently nearly
108
 
# impossible as there is no clear relationship between the working tree format
109
 
# and the conflict list file format.
110
 
CONFLICT_HEADER_1 = "BZR conflict list format 1"
 
64
from . import (
 
65
    osutils,
 
66
    )
 
67
from .decorators import needs_read_lock, needs_write_lock
 
68
from .i18n import gettext
 
69
from . import mutabletree
 
70
from .mutabletree import needs_tree_write_lock
 
71
from .trace import mutter, note
 
72
 
111
73
 
112
74
ERROR_PATH_NOT_FOUND = 3    # WindowsError errno code, equivalent to ENOENT
113
75
 
167
129
        return ''
168
130
 
169
131
 
170
 
class WorkingTree(bzrlib.mutabletree.MutableTree,
171
 
    bzrdir.ControlComponent):
 
132
class WorkingTree(mutabletree.MutableTree,
 
133
    controldir.ControlComponent):
172
134
    """Working copy tree.
173
135
 
174
 
    The inventory is held in the `Branch` working-inventory, and the
175
 
    files are in a directory on disk.
176
 
 
177
 
    It is possible for a `WorkingTree` to have a filename which is
178
 
    not listed in the Inventory and vice versa.
 
136
    :ivar basedir: The root of the tree on disk. This is a unicode path object
 
137
        (as opposed to a URL).
179
138
    """
180
139
 
181
140
    # override this to set the strategy for storing views
183
142
        return views.DisabledViews(self)
184
143
 
185
144
    def __init__(self, basedir='.',
186
 
                 branch=DEPRECATED_PARAMETER,
187
 
                 _inventory=None,
188
 
                 _control_files=None,
 
145
                 branch=None,
189
146
                 _internal=False,
 
147
                 _transport=None,
190
148
                 _format=None,
191
149
                 _bzrdir=None):
192
150
        """Construct a WorkingTree instance. This is not a public API.
198
156
        if not _internal:
199
157
            raise errors.BzrError("Please use bzrdir.open_workingtree or "
200
158
                "WorkingTree.open() to obtain a WorkingTree.")
201
 
        basedir = safe_unicode(basedir)
 
159
        basedir = osutils.safe_unicode(basedir)
202
160
        mutter("opening working tree %r", basedir)
203
 
        if deprecated_passed(branch):
 
161
        if branch is not None:
204
162
            self._branch = branch
205
163
        else:
206
164
            self._branch = self.bzrdir.open_branch()
207
 
        self.basedir = realpath(basedir)
208
 
        # if branch is at our basedir and is a format 6 or less
209
 
        if isinstance(self._format, WorkingTreeFormat2):
210
 
            # share control object
211
 
            self._control_files = self.branch.control_files
212
 
        else:
213
 
            # assume all other formats have their own control files.
214
 
            self._control_files = _control_files
215
 
        self._transport = self._control_files._transport
216
 
        # update the whole cache up front and write to disk if anything changed;
217
 
        # in the future we might want to do this more selectively
218
 
        # two possible ways offer themselves : in self._unlock, write the cache
219
 
        # if needed, or, when the cache sees a change, append it to the hash
220
 
        # cache file, and have the parser take the most recent entry for a
221
 
        # given path only.
222
 
        wt_trans = self.bzrdir.get_workingtree_transport(None)
223
 
        cache_filename = wt_trans.local_abspath('stat-cache')
224
 
        self._hashcache = hashcache.HashCache(basedir, cache_filename,
225
 
            self.bzrdir._get_file_mode(),
226
 
            self._content_filter_stack_provider())
227
 
        hc = self._hashcache
228
 
        hc.read()
229
 
        # is this scan needed ? it makes things kinda slow.
230
 
        #hc.scan()
231
 
 
232
 
        if hc.needs_write:
233
 
            mutter("write hc")
234
 
            hc.write()
235
 
 
236
 
        if _inventory is None:
237
 
            # This will be acquired on lock_read() or lock_write()
238
 
            self._inventory_is_modified = False
239
 
            self._inventory = None
240
 
        else:
241
 
            # the caller of __init__ has provided an inventory,
242
 
            # we assume they know what they are doing - as its only
243
 
            # the Format factory and creation methods that are
244
 
            # permitted to do this.
245
 
            self._set_inventory(_inventory, dirty=False)
246
 
        self._detect_case_handling()
 
165
        self.basedir = osutils.realpath(basedir)
 
166
        self._transport = _transport
247
167
        self._rules_searcher = None
248
168
        self.views = self._make_views()
249
169
 
255
175
    def control_transport(self):
256
176
        return self._transport
257
177
 
258
 
    def _detect_case_handling(self):
259
 
        wt_trans = self.bzrdir.get_workingtree_transport(None)
260
 
        try:
261
 
            wt_trans.stat("FoRMaT")
262
 
        except errors.NoSuchFile:
263
 
            self.case_sensitive = True
264
 
        else:
265
 
            self.case_sensitive = False
266
 
 
267
 
        self._setup_directory_is_tree_reference()
 
178
    def is_control_filename(self, filename):
 
179
        """True if filename is the name of a control file in this tree.
 
180
 
 
181
        :param filename: A filename within the tree. This is a relative path
 
182
            from the root of this tree.
 
183
 
 
184
        This is true IF and ONLY IF the filename is part of the meta data
 
185
        that bzr controls in this tree. I.E. a random .bzr directory placed
 
186
        on disk will not be a control file for this tree.
 
187
        """
 
188
        return self.bzrdir.is_control_filename(filename)
268
189
 
269
190
    branch = property(
270
191
        fget=lambda self: self._branch,
274
195
            the working tree has been constructed from.
275
196
            """)
276
197
 
 
198
    def has_versioned_directories(self):
 
199
        """See `Tree.has_versioned_directories`."""
 
200
        return self._format.supports_versioned_directories
 
201
 
 
202
    def _supports_executable(self):
 
203
        if sys.platform == 'win32':
 
204
            return False
 
205
        # FIXME: Ideally this should check the file system
 
206
        return True
 
207
 
277
208
    def break_lock(self):
278
209
        """Break a lock if one is present from another instance.
279
210
 
282
213
 
283
214
        This will probe the repository for its lock as well.
284
215
        """
285
 
        self._control_files.break_lock()
286
 
        self.branch.break_lock()
287
 
 
288
 
    def _get_check_refs(self):
289
 
        """Return the references needed to perform a check of this tree.
290
 
        
291
 
        The default implementation returns no refs, and is only suitable for
292
 
        trees that have no local caching and can commit on ghosts at any time.
293
 
 
294
 
        :seealso: bzrlib.check for details about check_refs.
295
 
        """
296
 
        return []
 
216
        raise NotImplementedError(self.break_lock)
297
217
 
298
218
    def requires_rich_root(self):
299
219
        return self._format.requires_rich_root
307
227
    def supports_views(self):
308
228
        return self.views.supports_views()
309
229
 
310
 
    def _set_inventory(self, inv, dirty):
311
 
        """Set the internal cached inventory.
 
230
    def get_config_stack(self):
 
231
        """Retrieve the config stack for this tree.
312
232
 
313
 
        :param inv: The inventory to set.
314
 
        :param dirty: A boolean indicating whether the inventory is the same
315
 
            logical inventory as whats on disk. If True the inventory is not
316
 
            the same and should be written to disk or data will be lost, if
317
 
            False then the inventory is the same as that on disk and any
318
 
            serialisation would be unneeded overhead.
 
233
        :return: A ``breezy.config.Stack``
319
234
        """
320
 
        self._inventory = inv
321
 
        self._inventory_is_modified = dirty
 
235
        # For the moment, just provide the branch config stack.
 
236
        return self.branch.get_config_stack()
322
237
 
323
238
    @staticmethod
324
239
    def open(path=None, _unsupported=False):
327
242
        """
328
243
        if path is None:
329
244
            path = osutils.getcwd()
330
 
        control = bzrdir.BzrDir.open(path, _unsupported)
331
 
        return control.open_workingtree(_unsupported)
 
245
        control = controldir.ControlDir.open(path, _unsupported=_unsupported)
 
246
        return control.open_workingtree(unsupported=_unsupported)
332
247
 
333
248
    @staticmethod
334
249
    def open_containing(path=None):
345
260
        """
346
261
        if path is None:
347
262
            path = osutils.getcwd()
348
 
        control, relpath = bzrdir.BzrDir.open_containing(path)
349
 
 
 
263
        control, relpath = controldir.ControlDir.open_containing(path)
350
264
        return control.open_workingtree(), relpath
351
265
 
352
266
    @staticmethod
 
267
    def open_containing_paths(file_list, default_directory=None,
 
268
                              canonicalize=True, apply_view=True):
 
269
        """Open the WorkingTree that contains a set of paths.
 
270
 
 
271
        Fail if the paths given are not all in a single tree.
 
272
 
 
273
        This is used for the many command-line interfaces that take a list of
 
274
        any number of files and that require they all be in the same tree.
 
275
        """
 
276
        if default_directory is None:
 
277
            default_directory = u'.'
 
278
        # recommended replacement for builtins.internal_tree_files
 
279
        if file_list is None or len(file_list) == 0:
 
280
            tree = WorkingTree.open_containing(default_directory)[0]
 
281
            # XXX: doesn't really belong here, and seems to have the strange
 
282
            # side effect of making it return a bunch of files, not the whole
 
283
            # tree -- mbp 20100716
 
284
            if tree.supports_views() and apply_view:
 
285
                view_files = tree.views.lookup_view()
 
286
                if view_files:
 
287
                    file_list = view_files
 
288
                    view_str = views.view_display_str(view_files)
 
289
                    note(gettext("Ignoring files outside view. View is %s") % view_str)
 
290
            return tree, file_list
 
291
        if default_directory == u'.':
 
292
            seed = file_list[0]
 
293
        else:
 
294
            seed = default_directory
 
295
            file_list = [osutils.pathjoin(default_directory, f)
 
296
                         for f in file_list]
 
297
        tree = WorkingTree.open_containing(seed)[0]
 
298
        return tree, tree.safe_relpath_files(file_list, canonicalize,
 
299
                                             apply_view=apply_view)
 
300
 
 
301
    def safe_relpath_files(self, file_list, canonicalize=True, apply_view=True):
 
302
        """Convert file_list into a list of relpaths in tree.
 
303
 
 
304
        :param self: A tree to operate on.
 
305
        :param file_list: A list of user provided paths or None.
 
306
        :param apply_view: if True and a view is set, apply it or check that
 
307
            specified files are within it
 
308
        :return: A list of relative paths.
 
309
        :raises errors.PathNotChild: When a provided path is in a different self
 
310
            than self.
 
311
        """
 
312
        if file_list is None:
 
313
            return None
 
314
        if self.supports_views() and apply_view:
 
315
            view_files = self.views.lookup_view()
 
316
        else:
 
317
            view_files = []
 
318
        new_list = []
 
319
        # self.relpath exists as a "thunk" to osutils, but canonical_relpath
 
320
        # doesn't - fix that up here before we enter the loop.
 
321
        if canonicalize:
 
322
            fixer = lambda p: osutils.canonical_relpath(self.basedir, p)
 
323
        else:
 
324
            fixer = self.relpath
 
325
        for filename in file_list:
 
326
            relpath = fixer(osutils.dereference_path(filename))
 
327
            if view_files and not osutils.is_inside_any(view_files, relpath):
 
328
                raise errors.FileOutsideView(filename, view_files)
 
329
            new_list.append(relpath)
 
330
        return new_list
 
331
 
 
332
    @staticmethod
353
333
    def open_downlevel(path=None):
354
334
        """Open an unsupported working tree.
355
335
 
368
348
                return True, None
369
349
            else:
370
350
                return True, tree
371
 
        transport = get_transport(location)
372
 
        iterator = bzrdir.BzrDir.find_bzrdirs(transport, evaluate=evaluate,
 
351
        t = transport.get_transport(location)
 
352
        iterator = controldir.ControlDir.find_bzrdirs(t, evaluate=evaluate,
373
353
                                              list_current=list_current)
374
 
        return [t for t in iterator if t is not None]
375
 
 
376
 
    # should be deprecated - this is slow and in any case treating them as a
377
 
    # container is (we now know) bad style -- mbp 20070302
378
 
    ## @deprecated_method(zero_fifteen)
379
 
    def __iter__(self):
380
 
        """Iterate through file_ids for this tree.
381
 
 
382
 
        file_ids are in a WorkingTree if they are in the working inventory
383
 
        and the working file exists.
384
 
        """
385
 
        inv = self._inventory
386
 
        for path, ie in inv.iter_entries():
387
 
            if osutils.lexists(self.abspath(path)):
388
 
                yield ie.file_id
389
 
 
390
 
    def all_file_ids(self):
391
 
        """See Tree.iter_all_file_ids"""
392
 
        return set(self.inventory)
 
354
        return [tr for tr in iterator if tr is not None]
393
355
 
394
356
    def __repr__(self):
395
357
        return "<%s of %s>" % (self.__class__.__name__,
396
358
                               getattr(self, 'basedir', None))
397
359
 
398
360
    def abspath(self, filename):
399
 
        return pathjoin(self.basedir, filename)
 
361
        return osutils.pathjoin(self.basedir, filename)
400
362
 
401
363
    def basis_tree(self):
402
364
        """Return RevisionTree for the current last revision.
450
412
        return self.get_file_with_stat(file_id, path, filtered=filtered)[0]
451
413
 
452
414
    def get_file_with_stat(self, file_id, path=None, filtered=True,
453
 
        _fstat=os.fstat):
 
415
                           _fstat=osutils.fstat):
454
416
        """See Tree.get_file_with_stat."""
455
417
        if path is None:
456
418
            path = self.id2path(file_id)
458
420
        stat_value = _fstat(file_obj.fileno())
459
421
        if filtered and self.supports_content_filtering():
460
422
            filters = self._content_filter_stack(path)
461
 
            file_obj = filtered_input_file(file_obj, filters)
 
423
            file_obj = _mod_filters.filtered_input_file(file_obj, filters)
462
424
        return (file_obj, stat_value)
463
425
 
464
426
    def get_file_text(self, file_id, path=None, filtered=True):
465
 
        return self.get_file(file_id, path=path, filtered=filtered).read()
 
427
        my_file = self.get_file(file_id, path=path, filtered=filtered)
 
428
        try:
 
429
            return my_file.read()
 
430
        finally:
 
431
            my_file.close()
466
432
 
467
433
    def get_file_byname(self, filename, filtered=True):
468
434
        path = self.abspath(filename)
469
435
        f = file(path, 'rb')
470
436
        if filtered and self.supports_content_filtering():
471
437
            filters = self._content_filter_stack(filename)
472
 
            return filtered_input_file(f, filters)
 
438
            return _mod_filters.filtered_input_file(f, filters)
473
439
        else:
474
440
            return f
475
441
 
481
447
        finally:
482
448
            file.close()
483
449
 
484
 
    @needs_read_lock
485
 
    def annotate_iter(self, file_id, default_revision=CURRENT_REVISION):
486
 
        """See Tree.annotate_iter
487
 
 
488
 
        This implementation will use the basis tree implementation if possible.
489
 
        Lines not in the basis are attributed to CURRENT_REVISION
490
 
 
491
 
        If there are pending merges, lines added by those merges will be
492
 
        incorrectly attributed to CURRENT_REVISION (but after committing, the
493
 
        attribution will be correct).
494
 
        """
495
 
        maybe_file_parent_keys = []
496
 
        for parent_id in self.get_parent_ids():
497
 
            try:
498
 
                parent_tree = self.revision_tree(parent_id)
499
 
            except errors.NoSuchRevisionInTree:
500
 
                parent_tree = self.branch.repository.revision_tree(parent_id)
501
 
            parent_tree.lock_read()
502
 
            try:
503
 
                if file_id not in parent_tree:
504
 
                    continue
505
 
                ie = parent_tree.inventory[file_id]
506
 
                if ie.kind != 'file':
507
 
                    # Note: this is slightly unnecessary, because symlinks and
508
 
                    # directories have a "text" which is the empty text, and we
509
 
                    # know that won't mess up annotations. But it seems cleaner
510
 
                    continue
511
 
                parent_text_key = (file_id, ie.revision)
512
 
                if parent_text_key not in maybe_file_parent_keys:
513
 
                    maybe_file_parent_keys.append(parent_text_key)
514
 
            finally:
515
 
                parent_tree.unlock()
516
 
        graph = _mod_graph.Graph(self.branch.repository.texts)
517
 
        heads = graph.heads(maybe_file_parent_keys)
518
 
        file_parent_keys = []
519
 
        for key in maybe_file_parent_keys:
520
 
            if key in heads:
521
 
                file_parent_keys.append(key)
522
 
 
523
 
        # Now we have the parents of this content
524
 
        annotator = self.branch.repository.texts.get_annotator()
525
 
        text = self.get_file(file_id).read()
526
 
        this_key =(file_id, default_revision)
527
 
        annotator.add_special_text(this_key, file_parent_keys, text)
528
 
        annotations = [(key[-1], line)
529
 
                       for key, line in annotator.annotate_flat(this_key)]
530
 
        return annotations
531
 
 
532
 
    def _get_ancestors(self, default_revision):
533
 
        ancestors = set([default_revision])
534
 
        for parent_id in self.get_parent_ids():
535
 
            ancestors.update(self.branch.repository.get_ancestry(
536
 
                             parent_id, topo_sorted=False))
537
 
        return ancestors
538
 
 
539
450
    def get_parent_ids(self):
540
451
        """See Tree.get_parent_ids.
541
452
 
557
468
                parents.append(revision_id)
558
469
        return parents
559
470
 
560
 
    @needs_read_lock
561
471
    def get_root_id(self):
562
472
        """Return the id of this trees root"""
563
 
        return self._inventory.root.file_id
564
 
 
565
 
    def _get_store_filename(self, file_id):
566
 
        ## XXX: badly named; this is not in the store at all
567
 
        return self.abspath(self.id2path(file_id))
 
473
        raise NotImplementedError(self.get_root_id)
568
474
 
569
475
    @needs_read_lock
570
 
    def clone(self, to_bzrdir, revision_id=None):
 
476
    def clone(self, to_controldir, revision_id=None):
571
477
        """Duplicate this working tree into to_bzr, including all state.
572
478
 
573
479
        Specifically modified files are kept as modified, but
574
480
        ignored and unknown files are discarded.
575
481
 
576
 
        If you want to make a new line of development, see bzrdir.sprout()
 
482
        If you want to make a new line of development, see ControlDir.sprout()
577
483
 
578
484
        revision
579
485
            If not None, the cloned tree will have its last revision set to
581
487
            and this one merged in.
582
488
        """
583
489
        # assumes the target bzr dir format is compatible.
584
 
        result = to_bzrdir.create_workingtree()
 
490
        result = to_controldir.create_workingtree()
585
491
        self.copy_content_into(result, revision_id)
586
492
        return result
587
493
 
594
500
        else:
595
501
            # TODO now merge from tree.last_revision to revision (to preserve
596
502
            # user local changes)
597
 
            merge.transform_tree(tree, self)
598
 
            tree.set_parent_ids([revision_id])
 
503
            try:
 
504
                other_tree = self.revision_tree(revision_id)
 
505
            except errors.NoSuchRevision:
 
506
                other_tree = self.branch.repository.revision_tree(revision_id)
 
507
 
 
508
            merge.transform_tree(tree, other_tree)
 
509
            if revision_id == _mod_revision.NULL_REVISION:
 
510
                new_parents = []
 
511
            else:
 
512
                new_parents = [revision_id]
 
513
            tree.set_parent_ids(new_parents)
599
514
 
600
515
    def id2abspath(self, file_id):
601
516
        return self.abspath(self.id2path(file_id))
602
517
 
603
 
    def has_id(self, file_id):
604
 
        # files that have been deleted are excluded
605
 
        inv = self.inventory
606
 
        if not inv.has_id(file_id):
607
 
            return False
608
 
        path = inv.id2path(file_id)
609
 
        return osutils.lexists(self.abspath(path))
610
 
 
611
 
    def has_or_had_id(self, file_id):
612
 
        if file_id == self.inventory.root.file_id:
613
 
            return True
614
 
        return self.inventory.has_id(file_id)
615
 
 
616
 
    __contains__ = has_id
617
 
 
618
518
    def get_file_size(self, file_id):
619
519
        """See Tree.get_file_size"""
620
520
        # XXX: this returns the on-disk size; it should probably return the
621
521
        # canonical size
622
522
        try:
623
523
            return os.path.getsize(self.id2abspath(file_id))
624
 
        except OSError, e:
 
524
        except OSError as e:
625
525
            if e.errno != errno.ENOENT:
626
526
                raise
627
527
            else:
628
528
                return None
629
529
 
630
 
    @needs_read_lock
631
 
    def get_file_sha1(self, file_id, path=None, stat_value=None):
632
 
        if not path:
633
 
            path = self._inventory.id2path(file_id)
634
 
        return self._hashcache.get_sha1(path, stat_value)
635
 
 
636
 
    def get_file_mtime(self, file_id, path=None):
637
 
        if not path:
638
 
            path = self.inventory.id2path(file_id)
639
 
        return os.lstat(self.abspath(path)).st_mtime
640
 
 
641
 
    def _is_executable_from_path_and_stat_from_basis(self, path, stat_result):
642
 
        file_id = self.path2id(path)
643
 
        if file_id is None:
644
 
            # For unversioned files on win32, we just assume they are not
645
 
            # executable
646
 
            return False
647
 
        return self._inventory[file_id].executable
648
 
 
649
 
    def _is_executable_from_path_and_stat_from_stat(self, path, stat_result):
650
 
        mode = stat_result.st_mode
651
 
        return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
652
 
 
653
 
    if not supports_executable():
654
 
        def is_executable(self, file_id, path=None):
655
 
            return self._inventory[file_id].executable
656
 
 
657
 
        _is_executable_from_path_and_stat = \
658
 
            _is_executable_from_path_and_stat_from_basis
659
 
    else:
660
 
        def is_executable(self, file_id, path=None):
661
 
            if not path:
662
 
                path = self.id2path(file_id)
663
 
            mode = os.lstat(self.abspath(path)).st_mode
664
 
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
665
 
 
666
 
        _is_executable_from_path_and_stat = \
667
 
            _is_executable_from_path_and_stat_from_stat
668
 
 
669
 
    @needs_tree_write_lock
670
 
    def _add(self, files, ids, kinds):
671
 
        """See MutableTree._add."""
672
 
        # TODO: Re-adding a file that is removed in the working copy
673
 
        # should probably put it back with the previous ID.
674
 
        # the read and write working inventory should not occur in this
675
 
        # function - they should be part of lock_write and unlock.
676
 
        inv = self.inventory
677
 
        for f, file_id, kind in zip(files, ids, kinds):
678
 
            if file_id is None:
679
 
                inv.add_path(f, kind=kind)
680
 
            else:
681
 
                inv.add_path(f, kind=kind, file_id=file_id)
682
 
            self._inventory_is_modified = True
683
 
 
684
530
    @needs_tree_write_lock
685
531
    def _gather_kinds(self, files, kinds):
686
532
        """See MutableTree._gather_kinds."""
687
533
        for pos, f in enumerate(files):
688
534
            if kinds[pos] is None:
689
 
                fullpath = normpath(self.abspath(f))
 
535
                fullpath = osutils.normpath(self.abspath(f))
690
536
                try:
691
 
                    kinds[pos] = file_kind(fullpath)
692
 
                except OSError, e:
 
537
                    kinds[pos] = osutils.file_kind(fullpath)
 
538
                except OSError as e:
693
539
                    if e.errno == errno.ENOENT:
694
540
                        raise errors.NoSuchFile(fullpath)
695
541
 
701
547
        and setting the list to its value plus revision_id.
702
548
 
703
549
        :param revision_id: The revision id to add to the parent list. It may
704
 
        be a ghost revision as long as its not the first parent to be added,
705
 
        or the allow_leftmost_as_ghost parameter is set True.
 
550
            be a ghost revision as long as its not the first parent to be
 
551
            added, or the allow_leftmost_as_ghost parameter is set True.
706
552
        :param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
707
553
        """
708
554
        parents = self.get_parent_ids() + [revision_id]
751
597
        abspath = self.abspath(path)
752
598
        try:
753
599
            stat_result = _lstat(abspath)
754
 
        except OSError, e:
 
600
        except OSError as e:
755
601
            if getattr(e, 'errno', None) == errno.ENOENT:
756
602
                # no file.
757
603
                return ('missing', None, None, None)
811
657
            if revision_id in heads and revision_id not in new_revision_ids:
812
658
                new_revision_ids.append(revision_id)
813
659
        if new_revision_ids != revision_ids:
814
 
            trace.mutter('requested to set revision_ids = %s,'
 
660
            mutter('requested to set revision_ids = %s,'
815
661
                         ' but filtered to %s', revision_ids, new_revision_ids)
816
662
        return new_revision_ids
817
663
 
843
689
        self._set_merges_from_parent_ids(revision_ids)
844
690
 
845
691
    @needs_tree_write_lock
846
 
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
847
 
        """See MutableTree.set_parent_trees."""
848
 
        parent_ids = [rev for (rev, tree) in parents_list]
849
 
        for revision_id in parent_ids:
850
 
            _mod_revision.check_not_reserved_id(revision_id)
851
 
 
852
 
        self._check_parents_for_ghosts(parent_ids,
853
 
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
854
 
 
855
 
        parent_ids = self._filter_parent_ids_by_ancestry(parent_ids)
856
 
 
857
 
        if len(parent_ids) == 0:
858
 
            leftmost_parent_id = _mod_revision.NULL_REVISION
859
 
            leftmost_parent_tree = None
860
 
        else:
861
 
            leftmost_parent_id, leftmost_parent_tree = parents_list[0]
862
 
 
863
 
        if self._change_last_revision(leftmost_parent_id):
864
 
            if leftmost_parent_tree is None:
865
 
                # If we don't have a tree, fall back to reading the
866
 
                # parent tree from the repository.
867
 
                self._cache_basis_inventory(leftmost_parent_id)
868
 
            else:
869
 
                inv = leftmost_parent_tree.inventory
870
 
                xml = self._create_basis_xml_from_inventory(
871
 
                                        leftmost_parent_id, inv)
872
 
                self._write_basis_inventory(xml)
873
 
        self._set_merges_from_parent_ids(parent_ids)
874
 
 
875
 
    @needs_tree_write_lock
876
692
    def set_pending_merges(self, rev_list):
877
693
        parents = self.get_parent_ids()
878
694
        leftmost = parents[:1]
881
697
 
882
698
    @needs_tree_write_lock
883
699
    def set_merge_modified(self, modified_hashes):
884
 
        def iter_stanzas():
885
 
            for file_id, hash in modified_hashes.iteritems():
886
 
                yield Stanza(file_id=file_id.decode('utf8'), hash=hash)
887
 
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
 
700
        """Set the merge modified hashes."""
 
701
        raise NotImplementedError(self.set_merge_modified)
888
702
 
889
703
    def _sha_from_stat(self, path, stat_result):
890
704
        """Get a sha digest from the tree's stat cache.
896
710
        """
897
711
        return None
898
712
 
899
 
    def _put_rio(self, filename, stanzas, header):
900
 
        self._must_be_locked()
901
 
        my_file = rio_file(stanzas, header)
902
 
        self._transport.put_file(filename, my_file,
903
 
            mode=self.bzrdir._get_file_mode())
904
 
 
905
713
    @needs_write_lock # because merge pulls data into the branch.
906
714
    def merge_from_branch(self, branch, to_revision=None, from_revision=None,
907
715
                          merge_type=None, force=False):
913
721
            of the branch when it is supplied. If None, to_revision defaults to
914
722
            branch.last_revision().
915
723
        """
916
 
        from bzrlib.merge import Merger, Merge3Merger
 
724
        from .merge import Merger, Merge3Merger
917
725
        merger = Merger(self.branch, this_tree=self)
918
726
        # check that there are no local alterations
919
727
        if not force and self.has_changes():
946
754
        merger.set_pending()
947
755
        return conflicts
948
756
 
949
 
    @needs_read_lock
950
757
    def merge_modified(self):
951
758
        """Return a dictionary of files modified by a merge.
952
759
 
957
764
        This returns a map of file_id->sha1, containing only files which are
958
765
        still in the working inventory and have that text hash.
959
766
        """
960
 
        try:
961
 
            hashfile = self._transport.get('merge-hashes')
962
 
        except errors.NoSuchFile:
963
 
            return {}
964
 
        try:
965
 
            merge_hashes = {}
966
 
            try:
967
 
                if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
968
 
                    raise errors.MergeModifiedFormatError()
969
 
            except StopIteration:
970
 
                raise errors.MergeModifiedFormatError()
971
 
            for s in RioReader(hashfile):
972
 
                # RioReader reads in Unicode, so convert file_ids back to utf8
973
 
                file_id = osutils.safe_file_id(s.get("file_id"), warn=False)
974
 
                if file_id not in self.inventory:
975
 
                    continue
976
 
                text_hash = s.get("hash")
977
 
                if text_hash == self.get_file_sha1(file_id):
978
 
                    merge_hashes[file_id] = text_hash
979
 
            return merge_hashes
980
 
        finally:
981
 
            hashfile.close()
 
767
        raise NotImplementedError(self.merge_modified)
982
768
 
983
769
    @needs_write_lock
984
770
    def mkdir(self, path, file_id=None):
989
775
        self.add(path, file_id, 'directory')
990
776
        return file_id
991
777
 
992
 
    def get_symlink_target(self, file_id):
993
 
        abspath = self.id2abspath(file_id)
 
778
    def get_symlink_target(self, file_id, path=None):
 
779
        if path is not None:
 
780
            abspath = self.abspath(path)
 
781
        else:
 
782
            abspath = self.id2abspath(file_id)
994
783
        target = osutils.readlink(abspath)
995
784
        return target
996
785
 
997
 
    @needs_write_lock
998
786
    def subsume(self, other_tree):
999
 
        def add_children(inventory, entry):
1000
 
            for child_entry in entry.children.values():
1001
 
                inventory._byid[child_entry.file_id] = child_entry
1002
 
                if child_entry.kind == 'directory':
1003
 
                    add_children(inventory, child_entry)
1004
 
        if other_tree.get_root_id() == self.get_root_id():
1005
 
            raise errors.BadSubsumeSource(self, other_tree,
1006
 
                                          'Trees have the same root')
1007
 
        try:
1008
 
            other_tree_path = self.relpath(other_tree.basedir)
1009
 
        except errors.PathNotChild:
1010
 
            raise errors.BadSubsumeSource(self, other_tree,
1011
 
                'Tree is not contained by the other')
1012
 
        new_root_parent = self.path2id(osutils.dirname(other_tree_path))
1013
 
        if new_root_parent is None:
1014
 
            raise errors.BadSubsumeSource(self, other_tree,
1015
 
                'Parent directory is not versioned.')
1016
 
        # We need to ensure that the result of a fetch will have a
1017
 
        # versionedfile for the other_tree root, and only fetching into
1018
 
        # RepositoryKnit2 guarantees that.
1019
 
        if not self.branch.repository.supports_rich_root():
1020
 
            raise errors.SubsumeTargetNeedsUpgrade(other_tree)
1021
 
        other_tree.lock_tree_write()
1022
 
        try:
1023
 
            new_parents = other_tree.get_parent_ids()
1024
 
            other_root = other_tree.inventory.root
1025
 
            other_root.parent_id = new_root_parent
1026
 
            other_root.name = osutils.basename(other_tree_path)
1027
 
            self.inventory.add(other_root)
1028
 
            add_children(self.inventory, other_root)
1029
 
            self._write_inventory(self.inventory)
1030
 
            # normally we don't want to fetch whole repositories, but i think
1031
 
            # here we really do want to consolidate the whole thing.
1032
 
            for parent_id in other_tree.get_parent_ids():
1033
 
                self.branch.fetch(other_tree.branch, parent_id)
1034
 
                self.add_parent_tree_id(parent_id)
1035
 
        finally:
1036
 
            other_tree.unlock()
1037
 
        other_tree.bzrdir.retire_bzrdir()
 
787
        raise NotImplementedError(self.subsume)
1038
788
 
1039
789
    def _setup_directory_is_tree_reference(self):
1040
790
        if self._branch.repository._format.supports_tree_reference:
1062
812
        # checkout in a subdirectory.  This can be avoided by not adding
1063
813
        # it.  mbp 20070306
1064
814
 
1065
 
    @needs_tree_write_lock
1066
815
    def extract(self, file_id, format=None):
1067
816
        """Extract a subtree from this tree.
1068
817
 
1069
818
        A new branch will be created, relative to the path for this tree.
1070
819
        """
1071
 
        self.flush()
1072
 
        def mkdirs(path):
1073
 
            segments = osutils.splitpath(path)
1074
 
            transport = self.branch.bzrdir.root_transport
1075
 
            for name in segments:
1076
 
                transport = transport.clone(name)
1077
 
                transport.ensure_base()
1078
 
            return transport
1079
 
 
1080
 
        sub_path = self.id2path(file_id)
1081
 
        branch_transport = mkdirs(sub_path)
1082
 
        if format is None:
1083
 
            format = self.bzrdir.cloning_metadir()
1084
 
        branch_transport.ensure_base()
1085
 
        branch_bzrdir = format.initialize_on_transport(branch_transport)
1086
 
        try:
1087
 
            repo = branch_bzrdir.find_repository()
1088
 
        except errors.NoRepositoryPresent:
1089
 
            repo = branch_bzrdir.create_repository()
1090
 
        if not repo.supports_rich_root():
1091
 
            raise errors.RootNotRich()
1092
 
        new_branch = branch_bzrdir.create_branch()
1093
 
        new_branch.pull(self.branch)
1094
 
        for parent_id in self.get_parent_ids():
1095
 
            new_branch.fetch(self.branch, parent_id)
1096
 
        tree_transport = self.bzrdir.root_transport.clone(sub_path)
1097
 
        if tree_transport.base != branch_transport.base:
1098
 
            tree_bzrdir = format.initialize_on_transport(tree_transport)
1099
 
            branch.BranchReferenceFormat().initialize(tree_bzrdir,
1100
 
                target_branch=new_branch)
1101
 
        else:
1102
 
            tree_bzrdir = branch_bzrdir
1103
 
        wt = tree_bzrdir.create_workingtree(_mod_revision.NULL_REVISION)
1104
 
        wt.set_parent_ids(self.get_parent_ids())
1105
 
        my_inv = self.inventory
1106
 
        child_inv = inventory.Inventory(root_id=None)
1107
 
        new_root = my_inv[file_id]
1108
 
        my_inv.remove_recursive_id(file_id)
1109
 
        new_root.parent_id = None
1110
 
        child_inv.add(new_root)
1111
 
        self._write_inventory(my_inv)
1112
 
        wt._write_inventory(child_inv)
1113
 
        return wt
1114
 
 
1115
 
    def _serialize(self, inventory, out_file):
1116
 
        xml5.serializer_v5.write_inventory(self._inventory, out_file,
1117
 
            working=True)
1118
 
 
1119
 
    def _deserialize(selt, in_file):
1120
 
        return xml5.serializer_v5.read_inventory(in_file)
 
820
        raise NotImplementedError(self.extract)
1121
821
 
1122
822
    def flush(self):
1123
 
        """Write the in memory inventory to disk."""
1124
 
        # TODO: Maybe this should only write on dirty ?
1125
 
        if self._control_files._lock_mode != 'w':
1126
 
            raise errors.NotWriteLocked(self)
1127
 
        sio = StringIO()
1128
 
        self._serialize(self._inventory, sio)
1129
 
        sio.seek(0)
1130
 
        self._transport.put_file('inventory', sio,
1131
 
            mode=self.bzrdir._get_file_mode())
1132
 
        self._inventory_is_modified = False
 
823
        """Write the in memory meta data to disk."""
 
824
        raise NotImplementedError(self.flush)
1133
825
 
1134
826
    def _kind(self, relpath):
1135
827
        return osutils.file_kind(self.abspath(relpath))
1145
837
        :param from_dir: start from this directory or None for the root
1146
838
        :param recursive: whether to recurse into subdirectories or not
1147
839
        """
1148
 
        # list_files is an iterator, so @needs_read_lock doesn't work properly
1149
 
        # with it. So callers should be careful to always read_lock the tree.
1150
 
        if not self.is_locked():
1151
 
            raise errors.ObjectNotLocked(self)
1152
 
 
1153
 
        inv = self.inventory
1154
 
        if from_dir is None and include_root is True:
1155
 
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
1156
 
        # Convert these into local objects to save lookup times
1157
 
        pathjoin = osutils.pathjoin
1158
 
        file_kind = self._kind
1159
 
 
1160
 
        # transport.base ends in a slash, we want the piece
1161
 
        # between the last two slashes
1162
 
        transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
1163
 
 
1164
 
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
1165
 
 
1166
 
        # directory file_id, relative path, absolute path, reverse sorted children
1167
 
        if from_dir is not None:
1168
 
            from_dir_id = inv.path2id(from_dir)
1169
 
            if from_dir_id is None:
1170
 
                # Directory not versioned
1171
 
                return
1172
 
            from_dir_abspath = pathjoin(self.basedir, from_dir)
1173
 
        else:
1174
 
            from_dir_id = inv.root.file_id
1175
 
            from_dir_abspath = self.basedir
1176
 
        children = os.listdir(from_dir_abspath)
1177
 
        children.sort()
1178
 
        # jam 20060527 The kernel sized tree seems equivalent whether we
1179
 
        # use a deque and popleft to keep them sorted, or if we use a plain
1180
 
        # list and just reverse() them.
1181
 
        children = collections.deque(children)
1182
 
        stack = [(from_dir_id, u'', from_dir_abspath, children)]
1183
 
        while stack:
1184
 
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
1185
 
 
1186
 
            while children:
1187
 
                f = children.popleft()
1188
 
                ## TODO: If we find a subdirectory with its own .bzr
1189
 
                ## directory, then that is a separate tree and we
1190
 
                ## should exclude it.
1191
 
 
1192
 
                # the bzrdir for this tree
1193
 
                if transport_base_dir == f:
1194
 
                    continue
1195
 
 
1196
 
                # we know that from_dir_relpath and from_dir_abspath never end in a slash
1197
 
                # and 'f' doesn't begin with one, we can do a string op, rather
1198
 
                # than the checks of pathjoin(), all relative paths will have an extra slash
1199
 
                # at the beginning
1200
 
                fp = from_dir_relpath + '/' + f
1201
 
 
1202
 
                # absolute path
1203
 
                fap = from_dir_abspath + '/' + f
1204
 
 
1205
 
                f_ie = inv.get_child(from_dir_id, f)
1206
 
                if f_ie:
1207
 
                    c = 'V'
1208
 
                elif self.is_ignored(fp[1:]):
1209
 
                    c = 'I'
1210
 
                else:
1211
 
                    # we may not have found this file, because of a unicode issue
1212
 
                    f_norm, can_access = osutils.normalized_filename(f)
1213
 
                    if f == f_norm or not can_access:
1214
 
                        # No change, so treat this file normally
1215
 
                        c = '?'
1216
 
                    else:
1217
 
                        # this file can be accessed by a normalized path
1218
 
                        # check again if it is versioned
1219
 
                        # these lines are repeated here for performance
1220
 
                        f = f_norm
1221
 
                        fp = from_dir_relpath + '/' + f
1222
 
                        fap = from_dir_abspath + '/' + f
1223
 
                        f_ie = inv.get_child(from_dir_id, f)
1224
 
                        if f_ie:
1225
 
                            c = 'V'
1226
 
                        elif self.is_ignored(fp[1:]):
1227
 
                            c = 'I'
1228
 
                        else:
1229
 
                            c = '?'
1230
 
 
1231
 
                fk = file_kind(fap)
1232
 
 
1233
 
                # make a last minute entry
1234
 
                if f_ie:
1235
 
                    yield fp[1:], c, fk, f_ie.file_id, f_ie
1236
 
                else:
1237
 
                    try:
1238
 
                        yield fp[1:], c, fk, None, fk_entries[fk]()
1239
 
                    except KeyError:
1240
 
                        yield fp[1:], c, fk, None, TreeEntry()
1241
 
                    continue
1242
 
 
1243
 
                if fk != 'directory':
1244
 
                    continue
1245
 
 
1246
 
                # But do this child first if recursing down
1247
 
                if recursive:
1248
 
                    new_children = os.listdir(fap)
1249
 
                    new_children.sort()
1250
 
                    new_children = collections.deque(new_children)
1251
 
                    stack.append((f_ie.file_id, fp, fap, new_children))
1252
 
                    # Break out of inner loop,
1253
 
                    # so that we start outer loop with child
1254
 
                    break
1255
 
            else:
1256
 
                # if we finished all children, pop it off the stack
1257
 
                stack.pop()
1258
 
 
1259
 
    @needs_tree_write_lock
1260
 
    def move(self, from_paths, to_dir=None, after=False, **kwargs):
 
840
        raise NotImplementedError(self.list_files)
 
841
 
 
842
    def move(self, from_paths, to_dir=None, after=False):
1261
843
        """Rename files.
1262
844
 
1263
 
        to_dir must exist in the inventory.
 
845
        to_dir must be known to the working tree.
1264
846
 
1265
847
        If to_dir exists and is a directory, the files are moved into
1266
848
        it, keeping their old names.
1272
854
        independently.
1273
855
 
1274
856
        The first mode moves the file in the filesystem and updates the
1275
 
        inventory. The second mode only updates the inventory without
1276
 
        touching the file on the filesystem. This is the new mode introduced
1277
 
        in version 0.15.
 
857
        working tree metadata. The second mode only updates the working tree
 
858
        metadata without touching the file on the filesystem.
1278
859
 
1279
860
        move uses the second mode if 'after == True' and the target is not
1280
861
        versioned but present in the working tree.
1292
873
        This returns a list of (from_path, to_path) pairs for each
1293
874
        entry that is moved.
1294
875
        """
1295
 
        rename_entries = []
1296
 
        rename_tuples = []
1297
 
 
1298
 
        # check for deprecated use of signature
1299
 
        if to_dir is None:
1300
 
            to_dir = kwargs.get('to_name', None)
1301
 
            if to_dir is None:
1302
 
                raise TypeError('You must supply a target directory')
1303
 
            else:
1304
 
                symbol_versioning.warn('The parameter to_name was deprecated'
1305
 
                                       ' in version 0.13. Use to_dir instead',
1306
 
                                       DeprecationWarning)
1307
 
 
1308
 
        # check destination directory
1309
 
        if isinstance(from_paths, basestring):
1310
 
            raise ValueError()
1311
 
        inv = self.inventory
1312
 
        to_abs = self.abspath(to_dir)
1313
 
        if not isdir(to_abs):
1314
 
            raise errors.BzrMoveFailedError('',to_dir,
1315
 
                errors.NotADirectory(to_abs))
1316
 
        if not self.has_filename(to_dir):
1317
 
            raise errors.BzrMoveFailedError('',to_dir,
1318
 
                errors.NotInWorkingDirectory(to_dir))
1319
 
        to_dir_id = inv.path2id(to_dir)
1320
 
        if to_dir_id is None:
1321
 
            raise errors.BzrMoveFailedError('',to_dir,
1322
 
                errors.NotVersionedError(path=str(to_dir)))
1323
 
 
1324
 
        to_dir_ie = inv[to_dir_id]
1325
 
        if to_dir_ie.kind != 'directory':
1326
 
            raise errors.BzrMoveFailedError('',to_dir,
1327
 
                errors.NotADirectory(to_abs))
1328
 
 
1329
 
        # create rename entries and tuples
1330
 
        for from_rel in from_paths:
1331
 
            from_tail = splitpath(from_rel)[-1]
1332
 
            from_id = inv.path2id(from_rel)
1333
 
            if from_id is None:
1334
 
                raise errors.BzrMoveFailedError(from_rel,to_dir,
1335
 
                    errors.NotVersionedError(path=str(from_rel)))
1336
 
 
1337
 
            from_entry = inv[from_id]
1338
 
            from_parent_id = from_entry.parent_id
1339
 
            to_rel = pathjoin(to_dir, from_tail)
1340
 
            rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1341
 
                                         from_id=from_id,
1342
 
                                         from_tail=from_tail,
1343
 
                                         from_parent_id=from_parent_id,
1344
 
                                         to_rel=to_rel, to_tail=from_tail,
1345
 
                                         to_parent_id=to_dir_id)
1346
 
            rename_entries.append(rename_entry)
1347
 
            rename_tuples.append((from_rel, to_rel))
1348
 
 
1349
 
        # determine which move mode to use. checks also for movability
1350
 
        rename_entries = self._determine_mv_mode(rename_entries, after)
1351
 
 
1352
 
        original_modified = self._inventory_is_modified
1353
 
        try:
1354
 
            if len(from_paths):
1355
 
                self._inventory_is_modified = True
1356
 
            self._move(rename_entries)
1357
 
        except:
1358
 
            # restore the inventory on error
1359
 
            self._inventory_is_modified = original_modified
1360
 
            raise
1361
 
        self._write_inventory(inv)
1362
 
        return rename_tuples
1363
 
 
1364
 
    def _determine_mv_mode(self, rename_entries, after=False):
1365
 
        """Determines for each from-to pair if both inventory and working tree
1366
 
        or only the inventory has to be changed.
1367
 
 
1368
 
        Also does basic plausability tests.
1369
 
        """
1370
 
        inv = self.inventory
1371
 
 
1372
 
        for rename_entry in rename_entries:
1373
 
            # store to local variables for easier reference
1374
 
            from_rel = rename_entry.from_rel
1375
 
            from_id = rename_entry.from_id
1376
 
            to_rel = rename_entry.to_rel
1377
 
            to_id = inv.path2id(to_rel)
1378
 
            only_change_inv = False
1379
 
 
1380
 
            # check the inventory for source and destination
1381
 
            if from_id is None:
1382
 
                raise errors.BzrMoveFailedError(from_rel,to_rel,
1383
 
                    errors.NotVersionedError(path=str(from_rel)))
1384
 
            if to_id is not None:
1385
 
                raise errors.BzrMoveFailedError(from_rel,to_rel,
1386
 
                    errors.AlreadyVersionedError(path=str(to_rel)))
1387
 
 
1388
 
            # try to determine the mode for rename (only change inv or change
1389
 
            # inv and file system)
1390
 
            if after:
1391
 
                if not self.has_filename(to_rel):
1392
 
                    raise errors.BzrMoveFailedError(from_id,to_rel,
1393
 
                        errors.NoSuchFile(path=str(to_rel),
1394
 
                        extra="New file has not been created yet"))
1395
 
                only_change_inv = True
1396
 
            elif not self.has_filename(from_rel) and self.has_filename(to_rel):
1397
 
                only_change_inv = True
1398
 
            elif self.has_filename(from_rel) and not self.has_filename(to_rel):
1399
 
                only_change_inv = False
1400
 
            elif (not self.case_sensitive
1401
 
                  and from_rel.lower() == to_rel.lower()
1402
 
                  and self.has_filename(from_rel)):
1403
 
                only_change_inv = False
1404
 
            else:
1405
 
                # something is wrong, so lets determine what exactly
1406
 
                if not self.has_filename(from_rel) and \
1407
 
                   not self.has_filename(to_rel):
1408
 
                    raise errors.BzrRenameFailedError(from_rel,to_rel,
1409
 
                        errors.PathsDoNotExist(paths=(str(from_rel),
1410
 
                        str(to_rel))))
1411
 
                else:
1412
 
                    raise errors.RenameFailedFilesExist(from_rel, to_rel)
1413
 
            rename_entry.only_change_inv = only_change_inv
1414
 
        return rename_entries
1415
 
 
1416
 
    def _move(self, rename_entries):
1417
 
        """Moves a list of files.
1418
 
 
1419
 
        Depending on the value of the flag 'only_change_inv', the
1420
 
        file will be moved on the file system or not.
1421
 
        """
1422
 
        inv = self.inventory
1423
 
        moved = []
1424
 
 
1425
 
        for entry in rename_entries:
1426
 
            try:
1427
 
                self._move_entry(entry)
1428
 
            except:
1429
 
                self._rollback_move(moved)
1430
 
                raise
1431
 
            moved.append(entry)
1432
 
 
1433
 
    def _rollback_move(self, moved):
1434
 
        """Try to rollback a previous move in case of an filesystem error."""
1435
 
        inv = self.inventory
1436
 
        for entry in moved:
1437
 
            try:
1438
 
                self._move_entry(WorkingTree._RenameEntry(
1439
 
                    entry.to_rel, entry.from_id,
1440
 
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
1441
 
                    entry.from_tail, entry.from_parent_id,
1442
 
                    entry.only_change_inv))
1443
 
            except errors.BzrMoveFailedError, e:
1444
 
                raise errors.BzrMoveFailedError( '', '', "Rollback failed."
1445
 
                        " The working tree is in an inconsistent state."
1446
 
                        " Please consider doing a 'bzr revert'."
1447
 
                        " Error message is: %s" % e)
1448
 
 
1449
 
    def _move_entry(self, entry):
1450
 
        inv = self.inventory
1451
 
        from_rel_abs = self.abspath(entry.from_rel)
1452
 
        to_rel_abs = self.abspath(entry.to_rel)
1453
 
        if from_rel_abs == to_rel_abs:
1454
 
            raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
1455
 
                "Source and target are identical.")
1456
 
 
1457
 
        if not entry.only_change_inv:
1458
 
            try:
1459
 
                osutils.rename(from_rel_abs, to_rel_abs)
1460
 
            except OSError, e:
1461
 
                raise errors.BzrMoveFailedError(entry.from_rel,
1462
 
                    entry.to_rel, e[1])
1463
 
        inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
 
876
        raise NotImplementedError(self.move)
1464
877
 
1465
878
    @needs_tree_write_lock
1466
879
    def rename_one(self, from_rel, to_rel, after=False):
1470
883
 
1471
884
        rename_one has several 'modes' to work. First, it can rename a physical
1472
885
        file and change the file_id. That is the normal mode. Second, it can
1473
 
        only change the file_id without touching any physical file. This is
1474
 
        the new mode introduced in version 0.15.
 
886
        only change the file_id without touching any physical file.
1475
887
 
1476
 
        rename_one uses the second mode if 'after == True' and 'to_rel' is not
1477
 
        versioned but present in the working tree.
 
888
        rename_one uses the second mode if 'after == True' and 'to_rel' is
 
889
        either not versioned or newly added, and present in the working tree.
1478
890
 
1479
891
        rename_one uses the second mode if 'after == False' and 'from_rel' is
1480
892
        versioned but no longer in the working tree, and 'to_rel' is not
1486
898
 
1487
899
        Everything else results in an error.
1488
900
        """
1489
 
        inv = self.inventory
1490
 
        rename_entries = []
1491
 
 
1492
 
        # create rename entries and tuples
1493
 
        from_tail = splitpath(from_rel)[-1]
1494
 
        from_id = inv.path2id(from_rel)
1495
 
        if from_id is None:
1496
 
            # if file is missing in the inventory maybe it's in the basis_tree
1497
 
            basis_tree = self.branch.basis_tree()
1498
 
            from_id = basis_tree.path2id(from_rel)
1499
 
            if from_id is None:
1500
 
                raise errors.BzrRenameFailedError(from_rel,to_rel,
1501
 
                    errors.NotVersionedError(path=str(from_rel)))
1502
 
            # put entry back in the inventory so we can rename it
1503
 
            from_entry = basis_tree.inventory[from_id].copy()
1504
 
            inv.add(from_entry)
1505
 
        else:
1506
 
            from_entry = inv[from_id]
1507
 
        from_parent_id = from_entry.parent_id
1508
 
        to_dir, to_tail = os.path.split(to_rel)
1509
 
        to_dir_id = inv.path2id(to_dir)
1510
 
        rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
1511
 
                                     from_id=from_id,
1512
 
                                     from_tail=from_tail,
1513
 
                                     from_parent_id=from_parent_id,
1514
 
                                     to_rel=to_rel, to_tail=to_tail,
1515
 
                                     to_parent_id=to_dir_id)
1516
 
        rename_entries.append(rename_entry)
1517
 
 
1518
 
        # determine which move mode to use. checks also for movability
1519
 
        rename_entries = self._determine_mv_mode(rename_entries, after)
1520
 
 
1521
 
        # check if the target changed directory and if the target directory is
1522
 
        # versioned
1523
 
        if to_dir_id is None:
1524
 
            raise errors.BzrMoveFailedError(from_rel,to_rel,
1525
 
                errors.NotVersionedError(path=str(to_dir)))
1526
 
 
1527
 
        # all checks done. now we can continue with our actual work
1528
 
        mutter('rename_one:\n'
1529
 
               '  from_id   {%s}\n'
1530
 
               '  from_rel: %r\n'
1531
 
               '  to_rel:   %r\n'
1532
 
               '  to_dir    %r\n'
1533
 
               '  to_dir_id {%s}\n',
1534
 
               from_id, from_rel, to_rel, to_dir, to_dir_id)
1535
 
 
1536
 
        self._move(rename_entries)
1537
 
        self._write_inventory(inv)
1538
 
 
1539
 
    class _RenameEntry(object):
1540
 
        def __init__(self, from_rel, from_id, from_tail, from_parent_id,
1541
 
                     to_rel, to_tail, to_parent_id, only_change_inv=False):
1542
 
            self.from_rel = from_rel
1543
 
            self.from_id = from_id
1544
 
            self.from_tail = from_tail
1545
 
            self.from_parent_id = from_parent_id
1546
 
            self.to_rel = to_rel
1547
 
            self.to_tail = to_tail
1548
 
            self.to_parent_id = to_parent_id
1549
 
            self.only_change_inv = only_change_inv
 
901
        raise NotImplementedError(self.rename_one)
1550
902
 
1551
903
    @needs_read_lock
1552
904
    def unknowns(self):
1560
912
        return iter(
1561
913
            [subp for subp in self.extras() if not self.is_ignored(subp)])
1562
914
 
1563
 
    @needs_tree_write_lock
1564
915
    def unversion(self, file_ids):
1565
916
        """Remove the file ids in file_ids from the current versioned set.
1566
917
 
1570
921
        :param file_ids: The file ids to stop versioning.
1571
922
        :raises: NoSuchId if any fileid is not currently versioned.
1572
923
        """
1573
 
        for file_id in file_ids:
1574
 
            if file_id not in self._inventory:
1575
 
                raise errors.NoSuchId(self, file_id)
1576
 
        for file_id in file_ids:
1577
 
            if self._inventory.has_id(file_id):
1578
 
                self._inventory.remove_recursive_id(file_id)
1579
 
        if len(file_ids):
1580
 
            # in the future this should just set a dirty bit to wait for the
1581
 
            # final unlock. However, until all methods of workingtree start
1582
 
            # with the current in -memory inventory rather than triggering
1583
 
            # a read, it is more complex - we need to teach read_inventory
1584
 
            # to know when to read, and when to not read first... and possibly
1585
 
            # to save first when the in memory one may be corrupted.
1586
 
            # so for now, we just only write it if it is indeed dirty.
1587
 
            # - RBC 20060907
1588
 
            self._write_inventory(self._inventory)
1589
 
 
1590
 
    def _iter_conflicts(self):
1591
 
        conflicted = set()
1592
 
        for info in self.list_files():
1593
 
            path = info[0]
1594
 
            stem = get_conflicted_stem(path)
1595
 
            if stem is None:
1596
 
                continue
1597
 
            if stem not in conflicted:
1598
 
                conflicted.add(stem)
1599
 
                yield stem
 
924
        raise NotImplementedError(self.unversion)
1600
925
 
1601
926
    @needs_write_lock
1602
927
    def pull(self, source, overwrite=False, stop_revision=None,
1603
 
             change_reporter=None, possible_transports=None, local=False):
 
928
             change_reporter=None, possible_transports=None, local=False,
 
929
             show_base=False):
1604
930
        source.lock_read()
1605
931
        try:
1606
932
            old_revision_info = self.branch.last_revision_info()
1611
937
            new_revision_info = self.branch.last_revision_info()
1612
938
            if new_revision_info != old_revision_info:
1613
939
                repository = self.branch.repository
 
940
                if repository._format.fast_deltas:
 
941
                    parent_ids = self.get_parent_ids()
 
942
                    if parent_ids:
 
943
                        basis_id = parent_ids[0]
 
944
                        basis_tree = repository.revision_tree(basis_id)
1614
945
                basis_tree.lock_read()
1615
946
                try:
1616
947
                    new_basis_tree = self.branch.basis_tree()
1620
951
                                basis_tree,
1621
952
                                this_tree=self,
1622
953
                                pb=None,
1623
 
                                change_reporter=change_reporter)
 
954
                                change_reporter=change_reporter,
 
955
                                show_base=show_base)
1624
956
                    basis_root_id = basis_tree.get_root_id()
1625
957
                    new_root_id = new_basis_tree.get_root_id()
1626
 
                    if basis_root_id != new_root_id:
 
958
                    if new_root_id is not None and basis_root_id != new_root_id:
1627
959
                        self.set_root_id(new_root_id)
1628
960
                finally:
1629
961
                    basis_tree.unlock()
1630
962
                # TODO - dedup parents list with things merged by pull ?
1631
963
                # reuse the revisiontree we merged against to set the new
1632
964
                # tree data.
1633
 
                parent_trees = [(self.branch.last_revision(), new_basis_tree)]
 
965
                parent_trees = []
 
966
                if self.branch.last_revision() != _mod_revision.NULL_REVISION:
 
967
                    parent_trees.append(
 
968
                        (self.branch.last_revision(), new_basis_tree))
1634
969
                # we have to pull the merge trees out again, because
1635
970
                # merge_inner has set the ids. - this corner is not yet
1636
971
                # layered well enough to prevent double handling.
1653
988
            stream.write(bytes)
1654
989
        finally:
1655
990
            stream.close()
1656
 
        # TODO: update the hashcache here ?
1657
991
 
1658
992
    def extras(self):
1659
993
        """Yield all unversioned files in this WorkingTree.
1665
999
        Currently returned depth-first, sorted by name within directories.
1666
1000
        This is the same order used by 'osutils.walkdirs'.
1667
1001
        """
1668
 
        ## TODO: Work from given directory downwards
1669
 
        for path, dir_entry in self.inventory.directories():
1670
 
            # mutter("search for unknowns in %r", path)
1671
 
            dirabs = self.abspath(path)
1672
 
            if not isdir(dirabs):
1673
 
                # e.g. directory deleted
1674
 
                continue
1675
 
 
1676
 
            fl = []
1677
 
            for subf in os.listdir(dirabs):
1678
 
                if self.bzrdir.is_control_filename(subf):
1679
 
                    continue
1680
 
                if subf not in dir_entry.children:
1681
 
                    try:
1682
 
                        (subf_norm,
1683
 
                         can_access) = osutils.normalized_filename(subf)
1684
 
                    except UnicodeDecodeError:
1685
 
                        path_os_enc = path.encode(osutils._fs_enc)
1686
 
                        relpath = path_os_enc + '/' + subf
1687
 
                        raise errors.BadFilenameEncoding(relpath,
1688
 
                                                         osutils._fs_enc)
1689
 
                    if subf_norm != subf and can_access:
1690
 
                        if subf_norm not in dir_entry.children:
1691
 
                            fl.append(subf_norm)
1692
 
                    else:
1693
 
                        fl.append(subf)
1694
 
 
1695
 
            fl.sort()
1696
 
            for subf in fl:
1697
 
                subp = pathjoin(path, subf)
1698
 
                yield subp
 
1002
        raise NotImplementedError(self.extras)
1699
1003
 
1700
1004
    def ignored_files(self):
1701
1005
        """Yield list of PATH, IGNORE_PATTERN"""
1716
1020
        ignore_globs = set()
1717
1021
        ignore_globs.update(ignores.get_runtime_ignores())
1718
1022
        ignore_globs.update(ignores.get_user_ignores())
1719
 
        if self.has_filename(bzrlib.IGNORE_FILENAME):
1720
 
            f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
 
1023
        if self.has_filename(breezy.IGNORE_FILENAME):
 
1024
            f = self.get_file_byname(breezy.IGNORE_FILENAME)
1721
1025
            try:
1722
1026
                ignore_globs.update(ignores.parse_ignore_file(f))
1723
1027
            finally:
1746
1050
        return self._ignoreglobster.match(filename)
1747
1051
 
1748
1052
    def kind(self, file_id):
1749
 
        return file_kind(self.id2abspath(file_id))
 
1053
        return osutils.file_kind(self.id2abspath(file_id))
1750
1054
 
1751
1055
    def stored_kind(self, file_id):
1752
1056
        """See Tree.stored_kind"""
1753
 
        return self.inventory[file_id].kind
 
1057
        raise NotImplementedError(self.stored_kind)
1754
1058
 
1755
1059
    def _comparison_data(self, entry, path):
1756
1060
        abspath = self.abspath(path)
1757
1061
        try:
1758
1062
            stat_value = os.lstat(abspath)
1759
 
        except OSError, e:
 
1063
        except OSError as e:
1760
1064
            if getattr(e, 'errno', None) == errno.ENOENT:
1761
1065
                stat_value = None
1762
1066
                kind = None
1766
1070
        else:
1767
1071
            mode = stat_value.st_mode
1768
1072
            kind = osutils.file_kind_from_stat_mode(mode)
1769
 
            if not supports_executable():
 
1073
            if not self._supports_executable():
1770
1074
                executable = entry is not None and entry.executable
1771
1075
            else:
1772
1076
                executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
1791
1095
        return _mod_revision.ensure_null(self.branch.last_revision())
1792
1096
 
1793
1097
    def is_locked(self):
1794
 
        return self._control_files.is_locked()
1795
 
 
1796
 
    def _must_be_locked(self):
1797
 
        if not self.is_locked():
1798
 
            raise errors.ObjectNotLocked(self)
 
1098
        """Check if this tree is locked."""
 
1099
        raise NotImplementedError(self.is_locked)
1799
1100
 
1800
1101
    def lock_read(self):
1801
 
        """See Branch.lock_read, and WorkingTree.unlock."""
1802
 
        if not self.is_locked():
1803
 
            self._reset_data()
1804
 
        self.branch.lock_read()
1805
 
        try:
1806
 
            return self._control_files.lock_read()
1807
 
        except:
1808
 
            self.branch.unlock()
1809
 
            raise
 
1102
        """Lock the tree for reading.
 
1103
 
 
1104
        This also locks the branch, and can be unlocked via self.unlock().
 
1105
 
 
1106
        :return: A breezy.lock.LogicalLockResult.
 
1107
        """
 
1108
        raise NotImplementedError(self.lock_read)
1810
1109
 
1811
1110
    def lock_tree_write(self):
1812
 
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1813
 
        if not self.is_locked():
1814
 
            self._reset_data()
1815
 
        self.branch.lock_read()
1816
 
        try:
1817
 
            return self._control_files.lock_write()
1818
 
        except:
1819
 
            self.branch.unlock()
1820
 
            raise
 
1111
        """See MutableTree.lock_tree_write, and WorkingTree.unlock.
 
1112
 
 
1113
        :return: A breezy.lock.LogicalLockResult.
 
1114
        """
 
1115
        raise NotImplementedError(self.lock_tree_write)
1821
1116
 
1822
1117
    def lock_write(self):
1823
 
        """See MutableTree.lock_write, and WorkingTree.unlock."""
1824
 
        if not self.is_locked():
1825
 
            self._reset_data()
1826
 
        self.branch.lock_write()
1827
 
        try:
1828
 
            return self._control_files.lock_write()
1829
 
        except:
1830
 
            self.branch.unlock()
1831
 
            raise
 
1118
        """See MutableTree.lock_write, and WorkingTree.unlock.
 
1119
 
 
1120
        :return: A breezy.lock.LogicalLockResult.
 
1121
        """
 
1122
        raise NotImplementedError(self.lock_write)
1832
1123
 
1833
1124
    def get_physical_lock_status(self):
1834
 
        return self._control_files.get_physical_lock_status()
1835
 
 
1836
 
    def _basis_inventory_name(self):
1837
 
        return 'basis-inventory-cache'
1838
 
 
1839
 
    def _reset_data(self):
1840
 
        """Reset transient data that cannot be revalidated."""
1841
 
        self._inventory_is_modified = False
1842
 
        f = self._transport.get('inventory')
1843
 
        try:
1844
 
            result = self._deserialize(f)
1845
 
        finally:
1846
 
            f.close()
1847
 
        self._set_inventory(result, dirty=False)
1848
 
 
1849
 
    @needs_tree_write_lock
 
1125
        raise NotImplementedError(self.get_physical_lock_status)
 
1126
 
1850
1127
    def set_last_revision(self, new_revision):
1851
1128
        """Change the last revision in the working tree."""
1852
 
        if self._change_last_revision(new_revision):
1853
 
            self._cache_basis_inventory(new_revision)
 
1129
        raise NotImplementedError(self.set_last_revision)
1854
1130
 
1855
1131
    def _change_last_revision(self, new_revision):
1856
1132
        """Template method part of set_last_revision to perform the change.
1859
1135
        when their last revision is set.
1860
1136
        """
1861
1137
        if _mod_revision.is_null(new_revision):
1862
 
            self.branch.set_revision_history([])
 
1138
            self.branch.set_last_revision_info(0, new_revision)
1863
1139
            return False
 
1140
        _mod_revision.check_not_reserved_id(new_revision)
1864
1141
        try:
1865
1142
            self.branch.generate_revision_history(new_revision)
1866
1143
        except errors.NoSuchRevision:
1867
1144
            # not present in the repo - dont try to set it deeper than the tip
1868
 
            self.branch.set_revision_history([new_revision])
 
1145
            self.branch._set_revision_history([new_revision])
1869
1146
        return True
1870
1147
 
1871
 
    def _write_basis_inventory(self, xml):
1872
 
        """Write the basis inventory XML to the basis-inventory file"""
1873
 
        path = self._basis_inventory_name()
1874
 
        sio = StringIO(xml)
1875
 
        self._transport.put_file(path, sio,
1876
 
            mode=self.bzrdir._get_file_mode())
1877
 
 
1878
 
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
1879
 
        """Create the text that will be saved in basis-inventory"""
1880
 
        inventory.revision_id = revision_id
1881
 
        return xml7.serializer_v7.write_inventory_to_string(inventory)
1882
 
 
1883
 
    def _cache_basis_inventory(self, new_revision):
1884
 
        """Cache new_revision as the basis inventory."""
1885
 
        # TODO: this should allow the ready-to-use inventory to be passed in,
1886
 
        # as commit already has that ready-to-use [while the format is the
1887
 
        # same, that is].
1888
 
        try:
1889
 
            # this double handles the inventory - unpack and repack -
1890
 
            # but is easier to understand. We can/should put a conditional
1891
 
            # in here based on whether the inventory is in the latest format
1892
 
            # - perhaps we should repack all inventories on a repository
1893
 
            # upgrade ?
1894
 
            # the fast path is to copy the raw xml from the repository. If the
1895
 
            # xml contains 'revision_id="', then we assume the right
1896
 
            # revision_id is set. We must check for this full string, because a
1897
 
            # root node id can legitimately look like 'revision_id' but cannot
1898
 
            # contain a '"'.
1899
 
            xml = self.branch.repository._get_inventory_xml(new_revision)
1900
 
            firstline = xml.split('\n', 1)[0]
1901
 
            if (not 'revision_id="' in firstline or
1902
 
                'format="7"' not in firstline):
1903
 
                inv = self.branch.repository._serializer.read_inventory_from_string(
1904
 
                    xml, new_revision)
1905
 
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
1906
 
            self._write_basis_inventory(xml)
1907
 
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1908
 
            pass
1909
 
 
1910
 
    def read_basis_inventory(self):
1911
 
        """Read the cached basis inventory."""
1912
 
        path = self._basis_inventory_name()
1913
 
        return self._transport.get_bytes(path)
1914
 
 
1915
 
    @needs_read_lock
1916
 
    def read_working_inventory(self):
1917
 
        """Read the working inventory.
1918
 
 
1919
 
        :raises errors.InventoryModified: read_working_inventory will fail
1920
 
            when the current in memory inventory has been modified.
1921
 
        """
1922
 
        # conceptually this should be an implementation detail of the tree.
1923
 
        # XXX: Deprecate this.
1924
 
        # ElementTree does its own conversion from UTF-8, so open in
1925
 
        # binary.
1926
 
        if self._inventory_is_modified:
1927
 
            raise errors.InventoryModified(self)
1928
 
        f = self._transport.get('inventory')
1929
 
        try:
1930
 
            result = self._deserialize(f)
1931
 
        finally:
1932
 
            f.close()
1933
 
        self._set_inventory(result, dirty=False)
1934
 
        return result
1935
 
 
1936
1148
    @needs_tree_write_lock
1937
1149
    def remove(self, files, verbose=False, to_file=None, keep_files=True,
1938
1150
        force=False):
1939
 
        """Remove nominated files from the working inventory.
 
1151
        """Remove nominated files from the working tree metadata.
1940
1152
 
1941
1153
        :files: File paths relative to the basedir.
1942
1154
        :keep_files: If true, the files will also be kept.
1948
1160
 
1949
1161
        inv_delta = []
1950
1162
 
1951
 
        new_files=set()
 
1163
        all_files = set() # specified and nested files 
1952
1164
        unknown_nested_files=set()
1953
1165
        if to_file is None:
1954
1166
            to_file = sys.stdout
1955
1167
 
 
1168
        files_to_backup = []
 
1169
 
1956
1170
        def recurse_directory_to_add_files(directory):
1957
1171
            # Recurse directory and add all files
1958
1172
            # so we can check if they have changed.
1959
 
            for parent_info, file_infos in\
1960
 
                self.walkdirs(directory):
 
1173
            for parent_info, file_infos in self.walkdirs(directory):
1961
1174
                for relpath, basename, kind, lstat, fileid, kind in file_infos:
1962
1175
                    # Is it versioned or ignored?
1963
 
                    if self.path2id(relpath) or self.is_ignored(relpath):
 
1176
                    if self.path2id(relpath):
1964
1177
                        # Add nested content for deletion.
1965
 
                        new_files.add(relpath)
 
1178
                        all_files.add(relpath)
1966
1179
                    else:
1967
 
                        # Files which are not versioned and not ignored
 
1180
                        # Files which are not versioned
1968
1181
                        # should be treated as unknown.
1969
 
                        unknown_nested_files.add((relpath, None, kind))
 
1182
                        files_to_backup.append(relpath)
1970
1183
 
1971
1184
        for filename in files:
1972
1185
            # Get file name into canonical form.
1973
1186
            abspath = self.abspath(filename)
1974
1187
            filename = self.relpath(abspath)
1975
1188
            if len(filename) > 0:
1976
 
                new_files.add(filename)
 
1189
                all_files.add(filename)
1977
1190
                recurse_directory_to_add_files(filename)
1978
1191
 
1979
 
        files = list(new_files)
 
1192
        files = list(all_files)
1980
1193
 
1981
1194
        if len(files) == 0:
1982
1195
            return # nothing to do
1986
1199
 
1987
1200
        # Bail out if we are going to delete files we shouldn't
1988
1201
        if not keep_files and not force:
1989
 
            has_changed_files = len(unknown_nested_files) > 0
1990
 
            if not has_changed_files:
1991
 
                for (file_id, path, content_change, versioned, parent_id, name,
1992
 
                     kind, executable) in self.iter_changes(self.basis_tree(),
1993
 
                         include_unchanged=True, require_versioned=False,
1994
 
                         want_unversioned=True, specific_files=files):
1995
 
                    if versioned == (False, False):
1996
 
                        # The record is unknown ...
1997
 
                        if not self.is_ignored(path[1]):
1998
 
                            # ... but not ignored
1999
 
                            has_changed_files = True
2000
 
                            break
2001
 
                    elif content_change and (kind[1] is not None):
2002
 
                        # Versioned and changed, but not deleted
2003
 
                        has_changed_files = True
2004
 
                        break
 
1202
            for (file_id, path, content_change, versioned, parent_id, name,
 
1203
                 kind, executable) in self.iter_changes(self.basis_tree(),
 
1204
                     include_unchanged=True, require_versioned=False,
 
1205
                     want_unversioned=True, specific_files=files):
 
1206
                if versioned[0] == False:
 
1207
                    # The record is unknown or newly added
 
1208
                    files_to_backup.append(path[1])
 
1209
                elif (content_change and (kind[1] is not None) and
 
1210
                        osutils.is_inside_any(files, path[1])):
 
1211
                    # Versioned and changed, but not deleted, and still
 
1212
                    # in one of the dirs to be deleted.
 
1213
                    files_to_backup.append(path[1])
2005
1214
 
2006
 
            if has_changed_files:
2007
 
                # Make delta show ALL applicable changes in error message.
2008
 
                tree_delta = self.changes_from(self.basis_tree(),
2009
 
                    require_versioned=False, want_unversioned=True,
2010
 
                    specific_files=files)
2011
 
                for unknown_file in unknown_nested_files:
2012
 
                    if unknown_file not in tree_delta.unversioned:
2013
 
                        tree_delta.unversioned.extend((unknown_file,))
2014
 
                raise errors.BzrRemoveChangedFilesError(tree_delta)
 
1215
        def backup(file_to_backup):
 
1216
            backup_name = self.bzrdir._available_backup_name(file_to_backup)
 
1217
            osutils.rename(abs_path, self.abspath(backup_name))
 
1218
            return "removed %s (but kept a copy: %s)" % (file_to_backup,
 
1219
                                                         backup_name)
2015
1220
 
2016
1221
        # Build inv_delta and delete files where applicable,
2017
 
        # do this before any modifications to inventory.
 
1222
        # do this before any modifications to meta data.
2018
1223
        for f in files:
2019
1224
            fid = self.path2id(f)
2020
1225
            message = None
2041
1246
                        len(os.listdir(abs_path)) > 0):
2042
1247
                        if force:
2043
1248
                            osutils.rmtree(abs_path)
 
1249
                            message = "deleted %s" % (f,)
2044
1250
                        else:
2045
 
                            message = "%s is not an empty directory "\
2046
 
                                "and won't be deleted." % (f,)
 
1251
                            message = backup(f)
2047
1252
                    else:
2048
 
                        osutils.delete_any(abs_path)
2049
 
                        message = "deleted %s" % (f,)
 
1253
                        if f in files_to_backup:
 
1254
                            message = backup(f)
 
1255
                        else:
 
1256
                            osutils.delete_any(abs_path)
 
1257
                            message = "deleted %s" % (f,)
2050
1258
                elif message is not None:
2051
1259
                    # Only care if we haven't done anything yet.
2052
1260
                    message = "%s does not exist." % (f,)
2059
1267
    @needs_tree_write_lock
2060
1268
    def revert(self, filenames=None, old_tree=None, backups=True,
2061
1269
               pb=None, report_changes=False):
2062
 
        from bzrlib.conflicts import resolve
2063
 
        if filenames == []:
2064
 
            filenames = None
2065
 
            symbol_versioning.warn('Using [] to revert all files is deprecated'
2066
 
                ' as of bzr 0.91.  Please use None (the default) instead.',
2067
 
                DeprecationWarning, stacklevel=2)
 
1270
        from .conflicts import resolve
2068
1271
        if old_tree is None:
2069
1272
            basis_tree = self.basis_tree()
2070
1273
            basis_tree.lock_read()
2091
1294
                basis_tree.unlock()
2092
1295
        return conflicts
2093
1296
 
 
1297
    @needs_write_lock
 
1298
    def store_uncommitted(self):
 
1299
        """Store uncommitted changes from the tree in the branch."""
 
1300
        target_tree = self.basis_tree()
 
1301
        shelf_creator = shelf.ShelfCreator(self, target_tree)
 
1302
        try:
 
1303
            if not shelf_creator.shelve_all():
 
1304
                return
 
1305
            self.branch.store_uncommitted(shelf_creator)
 
1306
            shelf_creator.transform()
 
1307
        finally:
 
1308
            shelf_creator.finalize()
 
1309
        note('Uncommitted changes stored in branch "%s".', self.branch.nick)
 
1310
 
 
1311
    @needs_write_lock
 
1312
    def restore_uncommitted(self):
 
1313
        """Restore uncommitted changes from the branch into the tree."""
 
1314
        unshelver = self.branch.get_unshelver(self)
 
1315
        if unshelver is None:
 
1316
            return
 
1317
        try:
 
1318
            merger = unshelver.make_merger()
 
1319
            merger.ignore_zero = True
 
1320
            merger.do_merge()
 
1321
            self.branch.store_uncommitted(None)
 
1322
        finally:
 
1323
            unshelver.finalize()
 
1324
 
2094
1325
    def revision_tree(self, revision_id):
2095
1326
        """See Tree.revision_tree.
2096
1327
 
2097
1328
        WorkingTree can supply revision_trees for the basis revision only
2098
1329
        because there is only one cached inventory in the bzr directory.
2099
1330
        """
2100
 
        if revision_id == self.last_revision():
2101
 
            try:
2102
 
                xml = self.read_basis_inventory()
2103
 
            except errors.NoSuchFile:
2104
 
                pass
2105
 
            else:
2106
 
                try:
2107
 
                    inv = xml7.serializer_v7.read_inventory_from_string(xml)
2108
 
                    # dont use the repository revision_tree api because we want
2109
 
                    # to supply the inventory.
2110
 
                    if inv.revision_id == revision_id:
2111
 
                        return revisiontree.RevisionTree(self.branch.repository,
2112
 
                            inv, revision_id)
2113
 
                except errors.BadInventoryFormat:
2114
 
                    pass
2115
 
        # raise if there was no inventory, or if we read the wrong inventory.
2116
 
        raise errors.NoSuchRevisionInTree(self, revision_id)
2117
 
 
2118
 
    # XXX: This method should be deprecated in favour of taking in a proper
2119
 
    # new Inventory object.
2120
 
    @needs_tree_write_lock
2121
 
    def set_inventory(self, new_inventory_list):
2122
 
        from bzrlib.inventory import (Inventory,
2123
 
                                      InventoryDirectory,
2124
 
                                      InventoryFile,
2125
 
                                      InventoryLink)
2126
 
        inv = Inventory(self.get_root_id())
2127
 
        for path, file_id, parent, kind in new_inventory_list:
2128
 
            name = os.path.basename(path)
2129
 
            if name == "":
2130
 
                continue
2131
 
            # fixme, there should be a factory function inv,add_??
2132
 
            if kind == 'directory':
2133
 
                inv.add(InventoryDirectory(file_id, name, parent))
2134
 
            elif kind == 'file':
2135
 
                inv.add(InventoryFile(file_id, name, parent))
2136
 
            elif kind == 'symlink':
2137
 
                inv.add(InventoryLink(file_id, name, parent))
2138
 
            else:
2139
 
                raise errors.BzrError("unknown kind %r" % kind)
2140
 
        self._write_inventory(inv)
 
1331
        raise NotImplementedError(self.revision_tree)
2141
1332
 
2142
1333
    @needs_tree_write_lock
2143
1334
    def set_root_id(self, file_id):
2156
1347
            present in the current inventory or an error will occur. It must
2157
1348
            not be None, but rather a valid file id.
2158
1349
        """
2159
 
        inv = self._inventory
2160
 
        orig_root_id = inv.root.file_id
2161
 
        # TODO: it might be nice to exit early if there was nothing
2162
 
        # to do, saving us from trigger a sync on unlock.
2163
 
        self._inventory_is_modified = True
2164
 
        # we preserve the root inventory entry object, but
2165
 
        # unlinkit from the byid index
2166
 
        del inv._byid[inv.root.file_id]
2167
 
        inv.root.file_id = file_id
2168
 
        # and link it into the index with the new changed id.
2169
 
        inv._byid[inv.root.file_id] = inv.root
2170
 
        # and finally update all children to reference the new id.
2171
 
        # XXX: this should be safe to just look at the root.children
2172
 
        # list, not the WHOLE INVENTORY.
2173
 
        for fid in inv:
2174
 
            entry = inv[fid]
2175
 
            if entry.parent_id == orig_root_id:
2176
 
                entry.parent_id = inv.root.file_id
 
1350
        raise NotImplementedError(self._set_root_id)
2177
1351
 
2178
1352
    def unlock(self):
2179
1353
        """See Branch.unlock.
2189
1363
    _marker = object()
2190
1364
 
2191
1365
    def update(self, change_reporter=None, possible_transports=None,
2192
 
               revision=None, old_tip=_marker):
 
1366
               revision=None, old_tip=_marker, show_base=False):
2193
1367
        """Update a working tree along its branch.
2194
1368
 
2195
1369
        This will update the branch if its bound too, which means we have
2210
1384
        - Restore the wt.basis->wt.state changes.
2211
1385
 
2212
1386
        There isn't a single operation at the moment to do that, so we:
 
1387
 
2213
1388
        - Merge current state -> basis tree of the master w.r.t. the old tree
2214
1389
          basis.
2215
1390
        - Do a 'normal' merge of the old branch basis if it is relevant.
2232
1407
            else:
2233
1408
                if old_tip is self._marker:
2234
1409
                    old_tip = None
2235
 
            return self._update_tree(old_tip, change_reporter, revision)
 
1410
            return self._update_tree(old_tip, change_reporter, revision, show_base)
2236
1411
        finally:
2237
1412
            self.unlock()
2238
1413
 
2239
1414
    @needs_tree_write_lock
2240
 
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None):
 
1415
    def _update_tree(self, old_tip=None, change_reporter=None, revision=None,
 
1416
                     show_base=False):
2241
1417
        """Update a tree to the master branch.
2242
1418
 
2243
1419
        :param old_tip: if supplied, the previous tip revision the branch,
2270
1446
            other_tree = self.branch.repository.revision_tree(old_tip)
2271
1447
            nb_conflicts = merge.merge_inner(self.branch, other_tree,
2272
1448
                                             base_tree, this_tree=self,
2273
 
                                             change_reporter=change_reporter)
 
1449
                                             change_reporter=change_reporter,
 
1450
                                             show_base=show_base)
2274
1451
            if nb_conflicts:
2275
1452
                self.add_parent_tree((old_tip, other_tree))
2276
 
                trace.note('Rerun update after fixing the conflicts.')
 
1453
                note(gettext('Rerun update after fixing the conflicts.'))
2277
1454
                return nb_conflicts
2278
1455
 
2279
1456
        if last_rev != _mod_revision.ensure_null(revision):
2285
1462
            basis = self.basis_tree()
2286
1463
            basis.lock_read()
2287
1464
            try:
2288
 
                if (basis.inventory.root is None
2289
 
                    or basis.inventory.root.file_id != to_root_id):
 
1465
                if (basis.get_root_id() is None or basis.get_root_id() != to_root_id):
2290
1466
                    self.set_root_id(to_root_id)
2291
1467
                    self.flush()
2292
1468
            finally:
2300
1476
 
2301
1477
            nb_conflicts = merge.merge_inner(self.branch, to_tree, base_tree,
2302
1478
                                             this_tree=self,
2303
 
                                             change_reporter=change_reporter)
 
1479
                                             change_reporter=change_reporter,
 
1480
                                             show_base=show_base)
2304
1481
            self.set_last_revision(revision)
2305
1482
            # TODO - dedup parents list with things merged by pull ?
2306
1483
            # reuse the tree we've updated to to set the basis:
2321
1498
            last_rev = parent_trees[0][0]
2322
1499
        return nb_conflicts
2323
1500
 
2324
 
    def _write_hashcache_if_dirty(self):
2325
 
        """Write out the hashcache if it is dirty."""
2326
 
        if self._hashcache.needs_write:
2327
 
            try:
2328
 
                self._hashcache.write()
2329
 
            except OSError, e:
2330
 
                if e.errno not in (errno.EPERM, errno.EACCES):
2331
 
                    raise
2332
 
                # TODO: jam 20061219 Should this be a warning? A single line
2333
 
                #       warning might be sufficient to let the user know what
2334
 
                #       is going on.
2335
 
                mutter('Could not write hashcache for %s\nError: %s',
2336
 
                       self._hashcache.cache_file_name(), e)
2337
 
 
2338
 
    @needs_tree_write_lock
2339
 
    def _write_inventory(self, inv):
2340
 
        """Write inventory as the current inventory."""
2341
 
        self._set_inventory(inv, dirty=True)
2342
 
        self.flush()
2343
 
 
2344
1501
    def set_conflicts(self, arg):
2345
1502
        raise errors.UnsupportedOperation(self.set_conflicts, self)
2346
1503
 
2347
1504
    def add_conflicts(self, arg):
2348
1505
        raise errors.UnsupportedOperation(self.add_conflicts, self)
2349
1506
 
2350
 
    @needs_read_lock
2351
1507
    def conflicts(self):
2352
 
        conflicts = _mod_conflicts.ConflictList()
2353
 
        for conflicted in self._iter_conflicts():
2354
 
            text = True
2355
 
            try:
2356
 
                if file_kind(self.abspath(conflicted)) != "file":
2357
 
                    text = False
2358
 
            except errors.NoSuchFile:
2359
 
                text = False
2360
 
            if text is True:
2361
 
                for suffix in ('.THIS', '.OTHER'):
2362
 
                    try:
2363
 
                        kind = file_kind(self.abspath(conflicted+suffix))
2364
 
                        if kind != "file":
2365
 
                            text = False
2366
 
                    except errors.NoSuchFile:
2367
 
                        text = False
2368
 
                    if text == False:
2369
 
                        break
2370
 
            ctype = {True: 'text conflict', False: 'contents conflict'}[text]
2371
 
            conflicts.append(_mod_conflicts.Conflict.factory(ctype,
2372
 
                             path=conflicted,
2373
 
                             file_id=self.path2id(conflicted)))
2374
 
        return conflicts
 
1508
        raise NotImplementedError(self.conflicts)
2375
1509
 
2376
1510
    def walkdirs(self, prefix=""):
2377
1511
        """Walk the directories of this tree.
2394
1528
        inventory_iterator = self._walkdirs(prefix)
2395
1529
        disk_iterator = osutils.walkdirs(disk_top, prefix)
2396
1530
        try:
2397
 
            current_disk = disk_iterator.next()
 
1531
            current_disk = next(disk_iterator)
2398
1532
            disk_finished = False
2399
 
        except OSError, e:
 
1533
        except OSError as e:
2400
1534
            if not (e.errno == errno.ENOENT or
2401
1535
                (sys.platform == 'win32' and e.errno == ERROR_PATH_NOT_FOUND)):
2402
1536
                raise
2403
1537
            current_disk = None
2404
1538
            disk_finished = True
2405
1539
        try:
2406
 
            current_inv = inventory_iterator.next()
 
1540
            current_inv = next(inventory_iterator)
2407
1541
            inv_finished = False
2408
1542
        except StopIteration:
2409
1543
            current_inv = None
2444
1578
                    cur_disk_dir_content]
2445
1579
                yield (cur_disk_dir_relpath, None), dirblock
2446
1580
                try:
2447
 
                    current_disk = disk_iterator.next()
 
1581
                    current_disk = next(disk_iterator)
2448
1582
                except StopIteration:
2449
1583
                    disk_finished = True
2450
1584
            elif direction < 0:
2454
1588
                    current_inv[1]]
2455
1589
                yield (current_inv[0][0], current_inv[0][1]), dirblock
2456
1590
                try:
2457
 
                    current_inv = inventory_iterator.next()
 
1591
                    current_inv = next(inventory_iterator)
2458
1592
                except StopIteration:
2459
1593
                    inv_finished = True
2460
1594
            else:
2486
1620
                        raise NotImplementedError('unreachable code')
2487
1621
                yield current_inv[0], dirblock
2488
1622
                try:
2489
 
                    current_inv = inventory_iterator.next()
 
1623
                    current_inv = next(inventory_iterator)
2490
1624
                except StopIteration:
2491
1625
                    inv_finished = True
2492
1626
                try:
2493
 
                    current_disk = disk_iterator.next()
 
1627
                    current_disk = next(disk_iterator)
2494
1628
                except StopIteration:
2495
1629
                    disk_finished = True
2496
1630
 
2497
1631
    def _walkdirs(self, prefix=""):
2498
1632
        """Walk the directories of this tree.
2499
1633
 
2500
 
           :prefix: is used as the directrory to start with.
2501
 
           returns a generator which yields items in the form:
2502
 
                ((curren_directory_path, fileid),
2503
 
                 [(file1_path, file1_name, file1_kind, None, file1_id,
2504
 
                   file1_kind), ... ])
 
1634
        :param prefix: is used as the directrory to start with.
 
1635
        :returns: a generator which yields items in the form::
 
1636
 
 
1637
            ((curren_directory_path, fileid),
 
1638
             [(file1_path, file1_name, file1_kind, None, file1_id,
 
1639
               file1_kind), ... ])
2505
1640
        """
2506
 
        _directory = 'directory'
2507
 
        # get the root in the inventory
2508
 
        inv = self.inventory
2509
 
        top_id = inv.path2id(prefix)
2510
 
        if top_id is None:
2511
 
            pending = []
2512
 
        else:
2513
 
            pending = [(prefix, '', _directory, None, top_id, None)]
2514
 
        while pending:
2515
 
            dirblock = []
2516
 
            currentdir = pending.pop()
2517
 
            # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
2518
 
            top_id = currentdir[4]
2519
 
            if currentdir[0]:
2520
 
                relroot = currentdir[0] + '/'
2521
 
            else:
2522
 
                relroot = ""
2523
 
            # FIXME: stash the node in pending
2524
 
            entry = inv[top_id]
2525
 
            if entry.kind == 'directory':
2526
 
                for name, child in entry.sorted_children():
2527
 
                    dirblock.append((relroot + name, name, child.kind, None,
2528
 
                        child.file_id, child.kind
2529
 
                        ))
2530
 
            yield (currentdir[0], entry.file_id), dirblock
2531
 
            # push the user specified dirs from dirblock
2532
 
            for dir in reversed(dirblock):
2533
 
                if dir[2] == _directory:
2534
 
                    pending.append(dir)
 
1641
        raise NotImplementedError(self._walkdirs)
2535
1642
 
2536
1643
    @needs_tree_write_lock
2537
1644
    def auto_resolve(self):
2541
1648
        are considered 'resolved', because bzr always puts conflict markers
2542
1649
        into files that have text conflicts.  The corresponding .THIS .BASE and
2543
1650
        .OTHER files are deleted, as per 'resolve'.
 
1651
 
2544
1652
        :return: a tuple of ConflictLists: (un_resolved, resolved).
2545
1653
        """
2546
1654
        un_resolved = _mod_conflicts.ConflictList()
2565
1673
        self.set_conflicts(un_resolved)
2566
1674
        return un_resolved, resolved
2567
1675
 
2568
 
    @needs_read_lock
2569
 
    def _check(self, references):
2570
 
        """Check the tree for consistency.
2571
 
 
2572
 
        :param references: A dict with keys matching the items returned by
2573
 
            self._get_check_refs(), and values from looking those keys up in
2574
 
            the repository.
2575
 
        """
2576
 
        tree_basis = self.basis_tree()
2577
 
        tree_basis.lock_read()
2578
 
        try:
2579
 
            repo_basis = references[('trees', self.last_revision())]
2580
 
            if len(list(repo_basis.iter_changes(tree_basis))) > 0:
2581
 
                raise errors.BzrCheckError(
2582
 
                    "Mismatched basis inventory content.")
2583
 
            self._validate()
2584
 
        finally:
2585
 
            tree_basis.unlock()
2586
 
 
2587
1676
    def _validate(self):
2588
1677
        """Validate internal structures.
2589
1678
 
2595
1684
        """
2596
1685
        return
2597
1686
 
 
1687
    def check_state(self):
 
1688
        """Check that the working state is/isn't valid."""
 
1689
        raise NotImplementedError(self.check_state)
 
1690
 
 
1691
    def reset_state(self, revision_ids=None):
 
1692
        """Reset the state of the working tree.
 
1693
 
 
1694
        This does a hard-reset to a last-known-good state. This is a way to
 
1695
        fix if something got corrupted (like the .bzr/checkout/dirstate file)
 
1696
        """
 
1697
        raise NotImplementedError(self.reset_state)
 
1698
 
2598
1699
    def _get_rules_searcher(self, default_searcher):
2599
1700
        """See Tree._get_rules_searcher."""
2600
1701
        if self._rules_searcher is None:
2604
1705
 
2605
1706
    def get_shelf_manager(self):
2606
1707
        """Return the ShelfManager for this WorkingTree."""
2607
 
        from bzrlib.shelf import ShelfManager
 
1708
        from .shelf import ShelfManager
2608
1709
        return ShelfManager(self, self._transport)
2609
1710
 
2610
1711
 
2611
 
class WorkingTree2(WorkingTree):
2612
 
    """This is the Format 2 working tree.
2613
 
 
2614
 
    This was the first weave based working tree.
2615
 
     - uses os locks for locking.
2616
 
     - uses the branch last-revision.
2617
 
    """
2618
 
 
2619
 
    def __init__(self, *args, **kwargs):
2620
 
        super(WorkingTree2, self).__init__(*args, **kwargs)
2621
 
        # WorkingTree2 has more of a constraint that self._inventory must
2622
 
        # exist. Because this is an older format, we don't mind the overhead
2623
 
        # caused by the extra computation here.
2624
 
 
2625
 
        # Newer WorkingTree's should only have self._inventory set when they
2626
 
        # have a read lock.
2627
 
        if self._inventory is None:
2628
 
            self.read_working_inventory()
2629
 
 
2630
 
    def _get_check_refs(self):
2631
 
        """Return the references needed to perform a check of this tree."""
2632
 
        return [('trees', self.last_revision())]
2633
 
 
2634
 
    def lock_tree_write(self):
2635
 
        """See WorkingTree.lock_tree_write().
2636
 
 
2637
 
        In Format2 WorkingTrees we have a single lock for the branch and tree
2638
 
        so lock_tree_write() degrades to lock_write().
2639
 
        """
2640
 
        self.branch.lock_write()
2641
 
        try:
2642
 
            return self._control_files.lock_write()
2643
 
        except:
2644
 
            self.branch.unlock()
2645
 
            raise
2646
 
 
2647
 
    def unlock(self):
2648
 
        # do non-implementation specific cleanup
2649
 
        self._cleanup()
2650
 
 
2651
 
        # we share control files:
2652
 
        if self._control_files._lock_count == 3:
2653
 
            # _inventory_is_modified is always False during a read lock.
2654
 
            if self._inventory_is_modified:
2655
 
                self.flush()
2656
 
            self._write_hashcache_if_dirty()
2657
 
 
2658
 
        # reverse order of locking.
2659
 
        try:
2660
 
            return self._control_files.unlock()
2661
 
        finally:
2662
 
            self.branch.unlock()
2663
 
 
2664
 
 
2665
 
class WorkingTree3(WorkingTree):
2666
 
    """This is the Format 3 working tree.
2667
 
 
2668
 
    This differs from the base WorkingTree by:
2669
 
     - having its own file lock
2670
 
     - having its own last-revision property.
2671
 
 
2672
 
    This is new in bzr 0.8
2673
 
    """
2674
 
 
2675
 
    @needs_read_lock
2676
 
    def _last_revision(self):
2677
 
        """See Mutable.last_revision."""
2678
 
        try:
2679
 
            return self._transport.get_bytes('last-revision')
2680
 
        except errors.NoSuchFile:
2681
 
            return _mod_revision.NULL_REVISION
2682
 
 
2683
 
    def _change_last_revision(self, revision_id):
2684
 
        """See WorkingTree._change_last_revision."""
2685
 
        if revision_id is None or revision_id == _mod_revision.NULL_REVISION:
2686
 
            try:
2687
 
                self._transport.delete('last-revision')
2688
 
            except errors.NoSuchFile:
2689
 
                pass
2690
 
            return False
2691
 
        else:
2692
 
            self._transport.put_bytes('last-revision', revision_id,
2693
 
                mode=self.bzrdir._get_file_mode())
2694
 
            return True
2695
 
 
2696
 
    def _get_check_refs(self):
2697
 
        """Return the references needed to perform a check of this tree."""
2698
 
        return [('trees', self.last_revision())]
2699
 
 
2700
 
    @needs_tree_write_lock
2701
 
    def set_conflicts(self, conflicts):
2702
 
        self._put_rio('conflicts', conflicts.to_stanzas(),
2703
 
                      CONFLICT_HEADER_1)
2704
 
 
2705
 
    @needs_tree_write_lock
2706
 
    def add_conflicts(self, new_conflicts):
2707
 
        conflict_set = set(self.conflicts())
2708
 
        conflict_set.update(set(list(new_conflicts)))
2709
 
        self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
2710
 
                                       key=_mod_conflicts.Conflict.sort_key)))
2711
 
 
2712
 
    @needs_read_lock
2713
 
    def conflicts(self):
2714
 
        try:
2715
 
            confile = self._transport.get('conflicts')
2716
 
        except errors.NoSuchFile:
2717
 
            return _mod_conflicts.ConflictList()
2718
 
        try:
2719
 
            try:
2720
 
                if confile.next() != CONFLICT_HEADER_1 + '\n':
2721
 
                    raise errors.ConflictFormatError()
2722
 
            except StopIteration:
2723
 
                raise errors.ConflictFormatError()
2724
 
            return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
2725
 
        finally:
2726
 
            confile.close()
2727
 
 
2728
 
    def unlock(self):
2729
 
        # do non-implementation specific cleanup
2730
 
        self._cleanup()
2731
 
        if self._control_files._lock_count == 1:
2732
 
            # _inventory_is_modified is always False during a read lock.
2733
 
            if self._inventory_is_modified:
2734
 
                self.flush()
2735
 
            self._write_hashcache_if_dirty()
2736
 
        # reverse order of locking.
2737
 
        try:
2738
 
            return self._control_files.unlock()
2739
 
        finally:
2740
 
            self.branch.unlock()
2741
 
 
2742
 
 
2743
 
def get_conflicted_stem(path):
2744
 
    for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
2745
 
        if path.endswith(suffix):
2746
 
            return path[:-len(suffix)]
2747
 
 
2748
 
 
2749
 
class WorkingTreeFormat(object):
 
1712
class WorkingTreeFormatRegistry(controldir.ControlComponentFormatRegistry):
 
1713
    """Registry for working tree formats."""
 
1714
 
 
1715
    def __init__(self, other_registry=None):
 
1716
        super(WorkingTreeFormatRegistry, self).__init__(other_registry)
 
1717
        self._default_format = None
 
1718
        self._default_format_key = None
 
1719
 
 
1720
    def get_default(self):
 
1721
        """Return the current default format."""
 
1722
        if (self._default_format_key is not None and
 
1723
            self._default_format is None):
 
1724
            self._default_format = self.get(self._default_format_key)
 
1725
        return self._default_format
 
1726
 
 
1727
    def set_default(self, format):
 
1728
        """Set the default format."""
 
1729
        self._default_format = format
 
1730
        self._default_format_key = None
 
1731
 
 
1732
    def set_default_key(self, format_string):
 
1733
        """Set the default format by its format string."""
 
1734
        self._default_format_key = format_string
 
1735
        self._default_format = None
 
1736
 
 
1737
 
 
1738
format_registry = WorkingTreeFormatRegistry()
 
1739
 
 
1740
 
 
1741
class WorkingTreeFormat(controldir.ControlComponentFormat):
2750
1742
    """An encapsulation of the initialization and open routines for a format.
2751
1743
 
2752
1744
    Formats provide three things:
2764
1756
    object will be created every time regardless.
2765
1757
    """
2766
1758
 
2767
 
    _default_format = None
2768
 
    """The default format used for new trees."""
2769
 
 
2770
 
    _formats = {}
2771
 
    """The known formats."""
2772
 
 
2773
1759
    requires_rich_root = False
2774
1760
 
2775
1761
    upgrade_recommended = False
2776
1762
 
2777
 
    @classmethod
2778
 
    def find_format(klass, a_bzrdir):
2779
 
        """Return the format for the working tree object in a_bzrdir."""
2780
 
        try:
2781
 
            transport = a_bzrdir.get_workingtree_transport(None)
2782
 
            format_string = transport.get_bytes("format")
2783
 
            return klass._formats[format_string]
2784
 
        except errors.NoSuchFile:
2785
 
            raise errors.NoWorkingTree(base=transport.base)
2786
 
        except KeyError:
2787
 
            raise errors.UnknownFormatError(format=format_string,
2788
 
                                            kind="working tree")
 
1763
    requires_normalized_unicode_filenames = False
 
1764
 
 
1765
    case_sensitive_filename = "FoRMaT"
 
1766
 
 
1767
    missing_parent_conflicts = False
 
1768
    """If this format supports missing parent conflicts."""
 
1769
 
 
1770
    supports_versioned_directories = None
 
1771
 
 
1772
    def initialize(self, controldir, revision_id=None, from_branch=None,
 
1773
                   accelerator_tree=None, hardlink=False):
 
1774
        """Initialize a new working tree in controldir.
 
1775
 
 
1776
        :param controldir: ControlDir to initialize the working tree in.
 
1777
        :param revision_id: allows creating a working tree at a different
 
1778
            revision than the branch is at.
 
1779
        :param from_branch: Branch to checkout
 
1780
        :param accelerator_tree: A tree which can be used for retrieving file
 
1781
            contents more quickly than the revision tree, i.e. a workingtree.
 
1782
            The revision tree will be used for cases where accelerator_tree's
 
1783
            content is different.
 
1784
        :param hardlink: If true, hard-link files from accelerator_tree,
 
1785
            where possible.
 
1786
        """
 
1787
        raise NotImplementedError(self.initialize)
2789
1788
 
2790
1789
    def __eq__(self, other):
2791
1790
        return self.__class__ is other.__class__
2793
1792
    def __ne__(self, other):
2794
1793
        return not (self == other)
2795
1794
 
2796
 
    @classmethod
2797
 
    def get_default_format(klass):
2798
 
        """Return the current default format."""
2799
 
        return klass._default_format
2800
 
 
2801
 
    def get_format_string(self):
2802
 
        """Return the ASCII format string that identifies this format."""
2803
 
        raise NotImplementedError(self.get_format_string)
2804
 
 
2805
1795
    def get_format_description(self):
2806
1796
        """Return the short description for this format."""
2807
1797
        raise NotImplementedError(self.get_format_description)
2823
1813
        """True if this format supports stored views."""
2824
1814
        return False
2825
1815
 
2826
 
    @classmethod
2827
 
    def register_format(klass, format):
2828
 
        klass._formats[format.get_format_string()] = format
2829
 
 
2830
 
    @classmethod
2831
 
    def set_default_format(klass, format):
2832
 
        klass._default_format = format
2833
 
 
2834
 
    @classmethod
2835
 
    def unregister_format(klass, format):
2836
 
        del klass._formats[format.get_format_string()]
2837
 
 
2838
 
 
2839
 
class WorkingTreeFormat2(WorkingTreeFormat):
2840
 
    """The second working tree format.
2841
 
 
2842
 
    This format modified the hash cache from the format 1 hash cache.
2843
 
    """
2844
 
 
2845
 
    upgrade_recommended = True
2846
 
 
2847
 
    def get_format_description(self):
2848
 
        """See WorkingTreeFormat.get_format_description()."""
2849
 
        return "Working tree format 2"
2850
 
 
2851
 
    def _stub_initialize_on_transport(self, transport, file_mode):
2852
 
        """Workaround: create control files for a remote working tree.
2853
 
 
2854
 
        This ensures that it can later be updated and dealt with locally,
2855
 
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with
2856
 
        no working tree.  (See bug #43064).
2857
 
        """
2858
 
        sio = StringIO()
2859
 
        inv = inventory.Inventory()
2860
 
        xml5.serializer_v5.write_inventory(inv, sio, working=True)
2861
 
        sio.seek(0)
2862
 
        transport.put_file('inventory', sio, file_mode)
2863
 
        transport.put_bytes('pending-merges', '', file_mode)
2864
 
 
2865
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2866
 
                   accelerator_tree=None, hardlink=False):
2867
 
        """See WorkingTreeFormat.initialize()."""
2868
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
2869
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2870
 
        if from_branch is not None:
2871
 
            branch = from_branch
2872
 
        else:
2873
 
            branch = a_bzrdir.open_branch()
2874
 
        if revision_id is None:
2875
 
            revision_id = _mod_revision.ensure_null(branch.last_revision())
2876
 
        branch.lock_write()
2877
 
        try:
2878
 
            branch.generate_revision_history(revision_id)
2879
 
        finally:
2880
 
            branch.unlock()
2881
 
        inv = inventory.Inventory()
2882
 
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2883
 
                         branch,
2884
 
                         inv,
2885
 
                         _internal=True,
2886
 
                         _format=self,
2887
 
                         _bzrdir=a_bzrdir)
2888
 
        basis_tree = branch.repository.revision_tree(revision_id)
2889
 
        if basis_tree.inventory.root is not None:
2890
 
            wt.set_root_id(basis_tree.get_root_id())
2891
 
        # set the parent list and cache the basis tree.
2892
 
        if _mod_revision.is_null(revision_id):
2893
 
            parent_trees = []
2894
 
        else:
2895
 
            parent_trees = [(revision_id, basis_tree)]
2896
 
        wt.set_parent_trees(parent_trees)
2897
 
        transform.build_tree(basis_tree, wt)
2898
 
        return wt
2899
 
 
2900
 
    def __init__(self):
2901
 
        super(WorkingTreeFormat2, self).__init__()
2902
 
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
2903
 
 
2904
 
    def open(self, a_bzrdir, _found=False):
2905
 
        """Return the WorkingTree object for a_bzrdir
2906
 
 
2907
 
        _found is a private parameter, do not use it. It is used to indicate
2908
 
               if format probing has already been done.
2909
 
        """
2910
 
        if not _found:
2911
 
            # we are being called directly and must probe.
2912
 
            raise NotImplementedError
2913
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
2914
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2915
 
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
2916
 
                           _internal=True,
2917
 
                           _format=self,
2918
 
                           _bzrdir=a_bzrdir)
2919
 
        return wt
2920
 
 
2921
 
class WorkingTreeFormat3(WorkingTreeFormat):
2922
 
    """The second working tree format updated to record a format marker.
2923
 
 
2924
 
    This format:
2925
 
        - exists within a metadir controlling .bzr
2926
 
        - includes an explicit version marker for the workingtree control
2927
 
          files, separate from the BzrDir format
2928
 
        - modifies the hash cache format
2929
 
        - is new in bzr 0.8
2930
 
        - uses a LockDir to guard access for writes.
2931
 
    """
2932
 
 
2933
 
    upgrade_recommended = True
2934
 
 
2935
 
    def get_format_string(self):
2936
 
        """See WorkingTreeFormat.get_format_string()."""
2937
 
        return "Bazaar-NG Working Tree format 3"
2938
 
 
2939
 
    def get_format_description(self):
2940
 
        """See WorkingTreeFormat.get_format_description()."""
2941
 
        return "Working tree format 3"
2942
 
 
2943
 
    _lock_file_name = 'lock'
2944
 
    _lock_class = LockDir
2945
 
 
2946
 
    _tree_class = WorkingTree3
2947
 
 
2948
 
    def __get_matchingbzrdir(self):
2949
 
        return bzrdir.BzrDirMetaFormat1()
2950
 
 
2951
 
    _matchingbzrdir = property(__get_matchingbzrdir)
2952
 
 
2953
 
    def _open_control_files(self, a_bzrdir):
2954
 
        transport = a_bzrdir.get_workingtree_transport(None)
2955
 
        return LockableFiles(transport, self._lock_file_name,
2956
 
                             self._lock_class)
2957
 
 
2958
 
    def initialize(self, a_bzrdir, revision_id=None, from_branch=None,
2959
 
                   accelerator_tree=None, hardlink=False):
2960
 
        """See WorkingTreeFormat.initialize().
2961
 
 
2962
 
        :param revision_id: if supplied, create a working tree at a different
2963
 
            revision than the branch is at.
2964
 
        :param accelerator_tree: A tree which can be used for retrieving file
2965
 
            contents more quickly than the revision tree, i.e. a workingtree.
2966
 
            The revision tree will be used for cases where accelerator_tree's
2967
 
            content is different.
2968
 
        :param hardlink: If true, hard-link files from accelerator_tree,
2969
 
            where possible.
2970
 
        """
2971
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
2972
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2973
 
        transport = a_bzrdir.get_workingtree_transport(self)
2974
 
        control_files = self._open_control_files(a_bzrdir)
2975
 
        control_files.create_lock()
2976
 
        control_files.lock_write()
2977
 
        transport.put_bytes('format', self.get_format_string(),
2978
 
            mode=a_bzrdir._get_file_mode())
2979
 
        if from_branch is not None:
2980
 
            branch = from_branch
2981
 
        else:
2982
 
            branch = a_bzrdir.open_branch()
2983
 
        if revision_id is None:
2984
 
            revision_id = _mod_revision.ensure_null(branch.last_revision())
2985
 
        # WorkingTree3 can handle an inventory which has a unique root id.
2986
 
        # as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
2987
 
        # those trees. And because there isn't a format bump inbetween, we
2988
 
        # are maintaining compatibility with older clients.
2989
 
        # inv = Inventory(root_id=gen_root_id())
2990
 
        inv = self._initial_inventory()
2991
 
        wt = self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
2992
 
                         branch,
2993
 
                         inv,
2994
 
                         _internal=True,
2995
 
                         _format=self,
2996
 
                         _bzrdir=a_bzrdir,
2997
 
                         _control_files=control_files)
2998
 
        wt.lock_tree_write()
2999
 
        try:
3000
 
            basis_tree = branch.repository.revision_tree(revision_id)
3001
 
            # only set an explicit root id if there is one to set.
3002
 
            if basis_tree.inventory.root is not None:
3003
 
                wt.set_root_id(basis_tree.get_root_id())
3004
 
            if revision_id == _mod_revision.NULL_REVISION:
3005
 
                wt.set_parent_trees([])
3006
 
            else:
3007
 
                wt.set_parent_trees([(revision_id, basis_tree)])
3008
 
            transform.build_tree(basis_tree, wt)
3009
 
        finally:
3010
 
            # Unlock in this order so that the unlock-triggers-flush in
3011
 
            # WorkingTree is given a chance to fire.
3012
 
            control_files.unlock()
3013
 
            wt.unlock()
3014
 
        return wt
3015
 
 
3016
 
    def _initial_inventory(self):
3017
 
        return inventory.Inventory()
3018
 
 
3019
 
    def __init__(self):
3020
 
        super(WorkingTreeFormat3, self).__init__()
3021
 
 
3022
 
    def open(self, a_bzrdir, _found=False):
3023
 
        """Return the WorkingTree object for a_bzrdir
3024
 
 
3025
 
        _found is a private parameter, do not use it. It is used to indicate
3026
 
               if format probing has already been done.
3027
 
        """
3028
 
        if not _found:
3029
 
            # we are being called directly and must probe.
3030
 
            raise NotImplementedError
3031
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
3032
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
3033
 
        wt = self._open(a_bzrdir, self._open_control_files(a_bzrdir))
3034
 
        return wt
3035
 
 
3036
 
    def _open(self, a_bzrdir, control_files):
3037
 
        """Open the tree itself.
3038
 
 
3039
 
        :param a_bzrdir: the dir for the tree.
3040
 
        :param control_files: the control files for the tree.
3041
 
        """
3042
 
        return self._tree_class(a_bzrdir.root_transport.local_abspath('.'),
3043
 
                                _internal=True,
3044
 
                                _format=self,
3045
 
                                _bzrdir=a_bzrdir,
3046
 
                                _control_files=control_files)
3047
 
 
3048
 
    def __str__(self):
3049
 
        return self.get_format_string()
3050
 
 
3051
 
 
3052
 
__default_format = WorkingTreeFormat6()
3053
 
WorkingTreeFormat.register_format(__default_format)
3054
 
WorkingTreeFormat.register_format(WorkingTreeFormat5())
3055
 
WorkingTreeFormat.register_format(WorkingTreeFormat4())
3056
 
WorkingTreeFormat.register_format(WorkingTreeFormat3())
3057
 
WorkingTreeFormat.set_default_format(__default_format)
3058
 
# formats which have no format string are not discoverable
3059
 
# and not independently creatable, so are not registered.
3060
 
_legacy_formats = [WorkingTreeFormat2(),
3061
 
                   ]
 
1816
    def get_controldir_for_branch(self):
 
1817
        """Get the control directory format for creating branches.
 
1818
 
 
1819
        This is to support testing of working tree formats that can not exist
 
1820
        in the same control directory as a branch.
 
1821
        """
 
1822
        return self._matchingbzrdir
 
1823
 
 
1824
 
 
1825
format_registry.register_lazy("Bazaar Working Tree Format 4 (bzr 0.15)\n",
 
1826
    "breezy.workingtree_4", "WorkingTreeFormat4")
 
1827
format_registry.register_lazy("Bazaar Working Tree Format 5 (bzr 1.11)\n",
 
1828
    "breezy.workingtree_4", "WorkingTreeFormat5")
 
1829
format_registry.register_lazy("Bazaar Working Tree Format 6 (bzr 1.14)\n",
 
1830
    "breezy.workingtree_4", "WorkingTreeFormat6")
 
1831
format_registry.register_lazy("Bazaar-NG Working Tree format 3",
 
1832
    "breezy.workingtree_3", "WorkingTreeFormat3")
 
1833
format_registry.set_default_key("Bazaar Working Tree Format 6 (bzr 1.14)\n")