~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Jelmer Vernooij
  • Date: 2012-01-27 16:27:09 UTC
  • mto: This revision was merged to the branch mainline in revision 6449.
  • Revision ID: jelmer@samba.org-20120127162709-eq21rt2enb9giauw
Fix support for tree-reference unpacking in 2a.

Show diffs side-by-side

added added

removed removed

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