~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: John Arbash Meinel
  • Date: 2010-08-23 21:36:06 UTC
  • mto: This revision was merged to the branch mainline in revision 5390.
  • Revision ID: john@arbash-meinel.com-20100823213606-1pk5w1nyaz9kz9k0
Lots of compatibility changes for python2.4 and mingw32 compilers.

gcc has strtoll available, and does the wrong thing if you use _strtoi64 (it implicitly
defines it to return an 'int' which isn't a 64-bit integer.)

Further, python2.4 doesn't support the %lu syntax, only having %ld and %d. So we go
back to casting everything into real python objects and then stringifying them, but
only for python 2.4.

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