~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Martin Pool
  • Date: 2010-02-23 07:43:11 UTC
  • mfrom: (4797.2.20 2.1)
  • mto: This revision was merged to the branch mainline in revision 5055.
  • Revision ID: mbp@sourcefrog.net-20100223074311-gnj55xdhrgz9l94e
Merge 2.1 back to trunk

Show diffs side-by-side

added added

removed removed

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