/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Jelmer Vernooij
  • Date: 2011-12-19 10:58:39 UTC
  • mfrom: (6383 +trunk)
  • mto: This revision was merged to the branch mainline in revision 6386.
  • Revision ID: jelmer@canonical.com-20111219105839-uji05ck4rkm1mj4j
Merge bzr.dev.

Show diffs side-by-side

added added

removed removed

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