/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 brzlib/workingtree.py

  • Committer: Jelmer Vernooij
  • Date: 2017-05-21 12:41:27 UTC
  • mto: This revision was merged to the branch mainline in revision 6623.
  • Revision ID: jelmer@jelmer.uk-20170521124127-iv8etg0vwymyai6y
s/bzr/brz/ in apport config.

Show diffs side-by-side

added added

removed removed

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