/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

[merge] bzr.dev 2255

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
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
"""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
# TODO: Give the workingtree sole responsibility for the working inventory;
 
33
# remove the variable and references to it from the branch.  This may require
 
34
# updating the commit code so as to update the inventory within the working
 
35
# copy, and making sure there's only one WorkingTree for any directory on disk.
 
36
# At the moment they may alias the inventory and have old copies of it in
 
37
# memory.  (Now done? -- mbp 20060309)
 
38
 
 
39
from cStringIO import StringIO
 
40
import os
 
41
 
 
42
from bzrlib.lazy_import import lazy_import
 
43
lazy_import(globals(), """
 
44
from bisect import bisect_left
 
45
import collections
 
46
from copy import deepcopy
 
47
import errno
 
48
import itertools
 
49
import operator
 
50
import stat
 
51
from time import time
 
52
import warnings
 
53
 
 
54
import bzrlib
 
55
from bzrlib import (
 
56
    bzrdir,
 
57
    conflicts as _mod_conflicts,
 
58
    errors,
 
59
    generate_ids,
 
60
    globbing,
 
61
    hashcache,
 
62
    ignores,
 
63
    merge,
 
64
    osutils,
 
65
    revisiontree,
 
66
    textui,
 
67
    transform,
 
68
    urlutils,
 
69
    xml5,
 
70
    xml6,
 
71
    )
 
72
import bzrlib.branch
 
73
from bzrlib.transport import get_transport
 
74
import bzrlib.ui
 
75
""")
 
76
 
 
77
from bzrlib import symbol_versioning
 
78
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
79
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID
 
80
from bzrlib.lockable_files import LockableFiles, TransportLock
 
81
from bzrlib.lockdir import LockDir
 
82
import bzrlib.mutabletree
 
83
from bzrlib.mutabletree import needs_tree_write_lock
 
84
from bzrlib.osutils import (
 
85
    compact_date,
 
86
    file_kind,
 
87
    isdir,
 
88
    normpath,
 
89
    pathjoin,
 
90
    rand_chars,
 
91
    realpath,
 
92
    safe_unicode,
 
93
    splitpath,
 
94
    supports_executable,
 
95
    )
 
96
from bzrlib.trace import mutter, note
 
97
from bzrlib.transport.local import LocalTransport
 
98
from bzrlib.progress import DummyProgress, ProgressPhase
 
99
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
 
100
from bzrlib.rio import RioReader, rio_file, Stanza
 
101
from bzrlib.symbol_versioning import (deprecated_passed,
 
102
        deprecated_method,
 
103
        deprecated_function,
 
104
        DEPRECATED_PARAMETER,
 
105
        zero_eight,
 
106
        zero_eleven,
 
107
        zero_thirteen,
 
108
        )
 
109
 
 
110
 
 
111
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
 
112
CONFLICT_HEADER_1 = "BZR conflict list format 1"
 
113
 
 
114
 
 
115
@deprecated_function(zero_thirteen)
 
116
def gen_file_id(name):
 
117
    """Return new file id for the basename 'name'.
 
118
 
 
119
    Use bzrlib.generate_ids.gen_file_id() instead
 
120
    """
 
121
    return generate_ids.gen_file_id(name)
 
122
 
 
123
 
 
124
@deprecated_function(zero_thirteen)
 
125
def gen_root_id():
 
126
    """Return a new tree-root file id.
 
127
 
 
128
    This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
 
129
    """
 
130
    return generate_ids.gen_root_id()
 
131
 
 
132
 
 
133
class TreeEntry(object):
 
134
    """An entry that implements the minimum interface used by commands.
 
135
 
 
136
    This needs further inspection, it may be better to have 
 
137
    InventoryEntries without ids - though that seems wrong. For now,
 
138
    this is a parallel hierarchy to InventoryEntry, and needs to become
 
139
    one of several things: decorates to that hierarchy, children of, or
 
140
    parents of it.
 
141
    Another note is that these objects are currently only used when there is
 
142
    no InventoryEntry available - i.e. for unversioned objects.
 
143
    Perhaps they should be UnversionedEntry et al. ? - RBC 20051003
 
144
    """
 
145
 
 
146
    def __eq__(self, other):
 
147
        # yes, this us ugly, TODO: best practice __eq__ style.
 
148
        return (isinstance(other, TreeEntry)
 
149
                and other.__class__ == self.__class__)
 
150
 
 
151
    def kind_character(self):
 
152
        return "???"
 
153
 
 
154
 
 
155
class TreeDirectory(TreeEntry):
 
156
    """See TreeEntry. This is a directory in a working tree."""
 
157
 
 
158
    def __eq__(self, other):
 
159
        return (isinstance(other, TreeDirectory)
 
160
                and other.__class__ == self.__class__)
 
161
 
 
162
    def kind_character(self):
 
163
        return "/"
 
164
 
 
165
 
 
166
class TreeFile(TreeEntry):
 
167
    """See TreeEntry. This is a regular file in a working tree."""
 
168
 
 
169
    def __eq__(self, other):
 
170
        return (isinstance(other, TreeFile)
 
171
                and other.__class__ == self.__class__)
 
172
 
 
173
    def kind_character(self):
 
174
        return ''
 
175
 
 
176
 
 
177
class TreeLink(TreeEntry):
 
178
    """See TreeEntry. This is a symlink in a working tree."""
 
179
 
 
180
    def __eq__(self, other):
 
181
        return (isinstance(other, TreeLink)
 
182
                and other.__class__ == self.__class__)
 
183
 
 
184
    def kind_character(self):
 
185
        return ''
 
186
 
 
187
 
 
188
class WorkingTree(bzrlib.mutabletree.MutableTree):
 
189
    """Working copy tree.
 
190
 
 
191
    The inventory is held in the `Branch` working-inventory, and the
 
192
    files are in a directory on disk.
 
193
 
 
194
    It is possible for a `WorkingTree` to have a filename which is
 
195
    not listed in the Inventory and vice versa.
 
196
    """
 
197
 
 
198
    def __init__(self, basedir='.',
 
199
                 branch=DEPRECATED_PARAMETER,
 
200
                 _inventory=None,
 
201
                 _control_files=None,
 
202
                 _internal=False,
 
203
                 _format=None,
 
204
                 _bzrdir=None):
 
205
        """Construct a WorkingTree for basedir.
 
206
 
 
207
        If the branch is not supplied, it is opened automatically.
 
208
        If the branch is supplied, it must be the branch for this basedir.
 
209
        (branch.base is not cross checked, because for remote branches that
 
210
        would be meaningless).
 
211
        """
 
212
        self._format = _format
 
213
        self.bzrdir = _bzrdir
 
214
        if not _internal:
 
215
            # not created via open etc.
 
216
            warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
 
217
                 "Please use bzrdir.open_workingtree or WorkingTree.open().",
 
218
                 DeprecationWarning,
 
219
                 stacklevel=2)
 
220
            wt = WorkingTree.open(basedir)
 
221
            self._branch = wt.branch
 
222
            self.basedir = wt.basedir
 
223
            self._control_files = wt._control_files
 
224
            self._hashcache = wt._hashcache
 
225
            self._set_inventory(wt._inventory, dirty=False)
 
226
            self._format = wt._format
 
227
            self.bzrdir = wt.bzrdir
 
228
        assert isinstance(basedir, basestring), \
 
229
            "base directory %r is not a string" % basedir
 
230
        basedir = safe_unicode(basedir)
 
231
        mutter("opening working tree %r", basedir)
 
232
        if deprecated_passed(branch):
 
233
            if not _internal:
 
234
                warnings.warn("WorkingTree(..., branch=XXX) is deprecated"
 
235
                     " as of bzr 0.8. Please use bzrdir.open_workingtree() or"
 
236
                     " WorkingTree.open().",
 
237
                     DeprecationWarning,
 
238
                     stacklevel=2
 
239
                     )
 
240
            self._branch = branch
 
241
        else:
 
242
            self._branch = self.bzrdir.open_branch()
 
243
        self.basedir = realpath(basedir)
 
244
        # if branch is at our basedir and is a format 6 or less
 
245
        if isinstance(self._format, WorkingTreeFormat2):
 
246
            # share control object
 
247
            self._control_files = self.branch.control_files
 
248
        else:
 
249
            # assume all other formats have their own control files.
 
250
            assert isinstance(_control_files, LockableFiles), \
 
251
                    "_control_files must be a LockableFiles, not %r" \
 
252
                    % _control_files
 
253
            self._control_files = _control_files
 
254
        # update the whole cache up front and write to disk if anything changed;
 
255
        # in the future we might want to do this more selectively
 
256
        # two possible ways offer themselves : in self._unlock, write the cache
 
257
        # if needed, or, when the cache sees a change, append it to the hash
 
258
        # cache file, and have the parser take the most recent entry for a
 
259
        # given path only.
 
260
        wt_trans = self.bzrdir.get_workingtree_transport(None)
 
261
        cache_filename = wt_trans.local_abspath('stat-cache')
 
262
        self._hashcache = hashcache.HashCache(basedir, cache_filename,
 
263
                                              self._control_files._file_mode)
 
264
        hc = self._hashcache
 
265
        hc.read()
 
266
        # is this scan needed ? it makes things kinda slow.
 
267
        #hc.scan()
 
268
 
 
269
        if hc.needs_write:
 
270
            mutter("write hc")
 
271
            hc.write()
 
272
 
 
273
        if _inventory is None:
 
274
            self._inventory_is_modified = False
 
275
            self.read_working_inventory()
 
276
        else:
 
277
            # the caller of __init__ has provided an inventory,
 
278
            # we assume they know what they are doing - as its only
 
279
            # the Format factory and creation methods that are
 
280
            # permitted to do this.
 
281
            self._set_inventory(_inventory, dirty=False)
 
282
 
 
283
    branch = property(
 
284
        fget=lambda self: self._branch,
 
285
        doc="""The branch this WorkingTree is connected to.
 
286
 
 
287
            This cannot be set - it is reflective of the actual disk structure
 
288
            the working tree has been constructed from.
 
289
            """)
 
290
 
 
291
    def break_lock(self):
 
292
        """Break a lock if one is present from another instance.
 
293
 
 
294
        Uses the ui factory to ask for confirmation if the lock may be from
 
295
        an active process.
 
296
 
 
297
        This will probe the repository for its lock as well.
 
298
        """
 
299
        self._control_files.break_lock()
 
300
        self.branch.break_lock()
 
301
 
 
302
    def _set_inventory(self, inv, dirty):
 
303
        """Set the internal cached inventory.
 
304
 
 
305
        :param inv: The inventory to set.
 
306
        :param dirty: A boolean indicating whether the inventory is the same
 
307
            logical inventory as whats on disk. If True the inventory is not
 
308
            the same and should be written to disk or data will be lost, if
 
309
            False then the inventory is the same as that on disk and any
 
310
            serialisation would be unneeded overhead.
 
311
        """
 
312
        assert inv.root is not None
 
313
        self._inventory = inv
 
314
        self._inventory_is_modified = dirty
 
315
 
 
316
    @staticmethod
 
317
    def open(path=None, _unsupported=False):
 
318
        """Open an existing working tree at path.
 
319
 
 
320
        """
 
321
        if path is None:
 
322
            path = os.path.getcwdu()
 
323
        control = bzrdir.BzrDir.open(path, _unsupported)
 
324
        return control.open_workingtree(_unsupported)
 
325
        
 
326
    @staticmethod
 
327
    def open_containing(path=None):
 
328
        """Open an existing working tree which has its root about path.
 
329
        
 
330
        This probes for a working tree at path and searches upwards from there.
 
331
 
 
332
        Basically we keep looking up until we find the control directory or
 
333
        run into /.  If there isn't one, raises NotBranchError.
 
334
        TODO: give this a new exception.
 
335
        If there is one, it is returned, along with the unused portion of path.
 
336
 
 
337
        :return: The WorkingTree that contains 'path', and the rest of path
 
338
        """
 
339
        if path is None:
 
340
            path = osutils.getcwd()
 
341
        control, relpath = bzrdir.BzrDir.open_containing(path)
 
342
 
 
343
        return control.open_workingtree(), relpath
 
344
 
 
345
    @staticmethod
 
346
    def open_downlevel(path=None):
 
347
        """Open an unsupported working tree.
 
348
 
 
349
        Only intended for advanced situations like upgrading part of a bzrdir.
 
350
        """
 
351
        return WorkingTree.open(path, _unsupported=True)
 
352
 
 
353
    def __iter__(self):
 
354
        """Iterate through file_ids for this tree.
 
355
 
 
356
        file_ids are in a WorkingTree if they are in the working inventory
 
357
        and the working file exists.
 
358
        """
 
359
        inv = self._inventory
 
360
        for path, ie in inv.iter_entries():
 
361
            if osutils.lexists(self.abspath(path)):
 
362
                yield ie.file_id
 
363
 
 
364
    def __repr__(self):
 
365
        return "<%s of %s>" % (self.__class__.__name__,
 
366
                               getattr(self, 'basedir', None))
 
367
 
 
368
    def abspath(self, filename):
 
369
        return pathjoin(self.basedir, filename)
 
370
    
 
371
    def basis_tree(self):
 
372
        """Return RevisionTree for the current last revision.
 
373
        
 
374
        If the left most parent is a ghost then the returned tree will be an
 
375
        empty tree - one obtained by calling repository.revision_tree(None).
 
376
        """
 
377
        try:
 
378
            revision_id = self.get_parent_ids()[0]
 
379
        except IndexError:
 
380
            # no parents, return an empty revision tree.
 
381
            # in the future this should return the tree for
 
382
            # 'empty:' - the implicit root empty tree.
 
383
            return self.branch.repository.revision_tree(None)
 
384
        try:
 
385
            return self.revision_tree(revision_id)
 
386
        except errors.NoSuchRevision:
 
387
            pass
 
388
        # No cached copy available, retrieve from the repository.
 
389
        # FIXME? RBC 20060403 should we cache the inventory locally
 
390
        # at this point ?
 
391
        try:
 
392
            return self.branch.repository.revision_tree(revision_id)
 
393
        except errors.RevisionNotPresent:
 
394
            # the basis tree *may* be a ghost or a low level error may have
 
395
            # occured. If the revision is present, its a problem, if its not
 
396
            # its a ghost.
 
397
            if self.branch.repository.has_revision(revision_id):
 
398
                raise
 
399
            # the basis tree is a ghost so return an empty tree.
 
400
            return self.branch.repository.revision_tree(None)
 
401
 
 
402
    @staticmethod
 
403
    @deprecated_method(zero_eight)
 
404
    def create(branch, directory):
 
405
        """Create a workingtree for branch at directory.
 
406
 
 
407
        If existing_directory already exists it must have a .bzr directory.
 
408
        If it does not exist, it will be created.
 
409
 
 
410
        This returns a new WorkingTree object for the new checkout.
 
411
 
 
412
        TODO FIXME RBC 20060124 when we have checkout formats in place this
 
413
        should accept an optional revisionid to checkout [and reject this if
 
414
        checking out into the same dir as a pre-checkout-aware branch format.]
 
415
 
 
416
        XXX: When BzrDir is present, these should be created through that 
 
417
        interface instead.
 
418
        """
 
419
        warnings.warn('delete WorkingTree.create', stacklevel=3)
 
420
        transport = get_transport(directory)
 
421
        if branch.bzrdir.root_transport.base == transport.base:
 
422
            # same dir 
 
423
            return branch.bzrdir.create_workingtree()
 
424
        # different directory, 
 
425
        # create a branch reference
 
426
        # and now a working tree.
 
427
        raise NotImplementedError
 
428
 
 
429
    @staticmethod
 
430
    @deprecated_method(zero_eight)
 
431
    def create_standalone(directory):
 
432
        """Create a checkout and a branch and a repo at directory.
 
433
 
 
434
        Directory must exist and be empty.
 
435
 
 
436
        please use BzrDir.create_standalone_workingtree
 
437
        """
 
438
        return bzrdir.BzrDir.create_standalone_workingtree(directory)
 
439
 
 
440
    def relpath(self, path):
 
441
        """Return the local path portion from a given path.
 
442
        
 
443
        The path may be absolute or relative. If its a relative path it is 
 
444
        interpreted relative to the python current working directory.
 
445
        """
 
446
        return osutils.relpath(self.basedir, path)
 
447
 
 
448
    def has_filename(self, filename):
 
449
        return osutils.lexists(self.abspath(filename))
 
450
 
 
451
    def get_file(self, file_id):
 
452
        return self.get_file_byname(self.id2path(file_id))
 
453
 
 
454
    def get_file_text(self, file_id):
 
455
        return self.get_file(file_id).read()
 
456
 
 
457
    def get_file_byname(self, filename):
 
458
        return file(self.abspath(filename), 'rb')
 
459
 
 
460
    def annotate_iter(self, file_id):
 
461
        """See Tree.annotate_iter
 
462
 
 
463
        This implementation will use the basis tree implementation if possible.
 
464
        Lines not in the basis are attributed to CURRENT_REVISION
 
465
 
 
466
        If there are pending merges, lines added by those merges will be
 
467
        incorrectly attributed to CURRENT_REVISION (but after committing, the
 
468
        attribution will be correct).
 
469
        """
 
470
        basis = self.basis_tree()
 
471
        changes = self._iter_changes(basis, True, [file_id]).next()
 
472
        changed_content, kind = changes[2], changes[6]
 
473
        if not changed_content:
 
474
            return basis.annotate_iter(file_id)
 
475
        if kind[1] is None:
 
476
            return None
 
477
        import annotate
 
478
        if kind[0] != 'file':
 
479
            old_lines = []
 
480
        else:
 
481
            old_lines = list(basis.annotate_iter(file_id))
 
482
        old = [old_lines]
 
483
        for tree in self.branch.repository.revision_trees(
 
484
            self.get_parent_ids()[1:]):
 
485
            if file_id not in tree:
 
486
                continue
 
487
            old.append(list(tree.annotate_iter(file_id)))
 
488
        return annotate.reannotate(old, self.get_file(file_id).readlines(),
 
489
                                   CURRENT_REVISION)
 
490
 
 
491
    def get_parent_ids(self):
 
492
        """See Tree.get_parent_ids.
 
493
        
 
494
        This implementation reads the pending merges list and last_revision
 
495
        value and uses that to decide what the parents list should be.
 
496
        """
 
497
        last_rev = self._last_revision()
 
498
        if last_rev is None:
 
499
            parents = []
 
500
        else:
 
501
            parents = [last_rev]
 
502
        try:
 
503
            merges_file = self._control_files.get_utf8('pending-merges')
 
504
        except errors.NoSuchFile:
 
505
            pass
 
506
        else:
 
507
            for l in merges_file.readlines():
 
508
                parents.append(l.rstrip('\n'))
 
509
        return parents
 
510
 
 
511
    @needs_read_lock
 
512
    def get_root_id(self):
 
513
        """Return the id of this trees root"""
 
514
        return self._inventory.root.file_id
 
515
        
 
516
    def _get_store_filename(self, file_id):
 
517
        ## XXX: badly named; this is not in the store at all
 
518
        return self.abspath(self.id2path(file_id))
 
519
 
 
520
    @needs_read_lock
 
521
    def clone(self, to_bzrdir, revision_id=None, basis=None):
 
522
        """Duplicate this working tree into to_bzr, including all state.
 
523
        
 
524
        Specifically modified files are kept as modified, but
 
525
        ignored and unknown files are discarded.
 
526
 
 
527
        If you want to make a new line of development, see bzrdir.sprout()
 
528
 
 
529
        revision
 
530
            If not None, the cloned tree will have its last revision set to 
 
531
            revision, and and difference between the source trees last revision
 
532
            and this one merged in.
 
533
 
 
534
        basis
 
535
            If not None, a closer copy of a tree which may have some files in
 
536
            common, and which file content should be preferentially copied from.
 
537
        """
 
538
        # assumes the target bzr dir format is compatible.
 
539
        result = self._format.initialize(to_bzrdir)
 
540
        self.copy_content_into(result, revision_id)
 
541
        return result
 
542
 
 
543
    @needs_read_lock
 
544
    def copy_content_into(self, tree, revision_id=None):
 
545
        """Copy the current content and user files of this tree into tree."""
 
546
        tree.set_root_id(self.get_root_id())
 
547
        if revision_id is None:
 
548
            merge.transform_tree(tree, self)
 
549
        else:
 
550
            # TODO now merge from tree.last_revision to revision (to preserve
 
551
            # user local changes)
 
552
            merge.transform_tree(tree, self)
 
553
            tree.set_parent_ids([revision_id])
 
554
 
 
555
    def id2abspath(self, file_id):
 
556
        return self.abspath(self.id2path(file_id))
 
557
 
 
558
    def has_id(self, file_id):
 
559
        # files that have been deleted are excluded
 
560
        inv = self._inventory
 
561
        if not inv.has_id(file_id):
 
562
            return False
 
563
        path = inv.id2path(file_id)
 
564
        return osutils.lexists(self.abspath(path))
 
565
 
 
566
    def has_or_had_id(self, file_id):
 
567
        if file_id == self.inventory.root.file_id:
 
568
            return True
 
569
        return self.inventory.has_id(file_id)
 
570
 
 
571
    __contains__ = has_id
 
572
 
 
573
    def get_file_size(self, file_id):
 
574
        return os.path.getsize(self.id2abspath(file_id))
 
575
 
 
576
    @needs_read_lock
 
577
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
578
        if not path:
 
579
            path = self._inventory.id2path(file_id)
 
580
        return self._hashcache.get_sha1(path, stat_value)
 
581
 
 
582
    def get_file_mtime(self, file_id, path=None):
 
583
        if not path:
 
584
            path = self._inventory.id2path(file_id)
 
585
        return os.lstat(self.abspath(path)).st_mtime
 
586
 
 
587
    if not supports_executable():
 
588
        def is_executable(self, file_id, path=None):
 
589
            return self._inventory[file_id].executable
 
590
    else:
 
591
        def is_executable(self, file_id, path=None):
 
592
            if not path:
 
593
                path = self._inventory.id2path(file_id)
 
594
            mode = os.lstat(self.abspath(path)).st_mode
 
595
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
 
596
 
 
597
    @needs_write_lock
 
598
    def _add(self, files, ids, kinds):
 
599
        """See MutableTree._add."""
 
600
        # TODO: Re-adding a file that is removed in the working copy
 
601
        # should probably put it back with the previous ID.
 
602
        # the read and write working inventory should not occur in this 
 
603
        # function - they should be part of lock_write and unlock.
 
604
        inv = self.read_working_inventory()
 
605
        for f, file_id, kind in zip(files, ids, kinds):
 
606
            assert kind is not None
 
607
            if file_id is None:
 
608
                inv.add_path(f, kind=kind)
 
609
            else:
 
610
                inv.add_path(f, kind=kind, file_id=file_id)
 
611
        self._write_inventory(inv)
 
612
 
 
613
    @needs_tree_write_lock
 
614
    def _gather_kinds(self, files, kinds):
 
615
        """See MutableTree._gather_kinds."""
 
616
        for pos, f in enumerate(files):
 
617
            if kinds[pos] is None:
 
618
                fullpath = normpath(self.abspath(f))
 
619
                try:
 
620
                    kinds[pos] = file_kind(fullpath)
 
621
                except OSError, e:
 
622
                    if e.errno == errno.ENOENT:
 
623
                        raise errors.NoSuchFile(fullpath)
 
624
 
 
625
    @needs_write_lock
 
626
    def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
 
627
        """Add revision_id as a parent.
 
628
 
 
629
        This is equivalent to retrieving the current list of parent ids
 
630
        and setting the list to its value plus revision_id.
 
631
 
 
632
        :param revision_id: The revision id to add to the parent list. It may
 
633
        be a ghost revision as long as its not the first parent to be added,
 
634
        or the allow_leftmost_as_ghost parameter is set True.
 
635
        :param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
 
636
        """
 
637
        parents = self.get_parent_ids() + [revision_id]
 
638
        self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
 
639
            or allow_leftmost_as_ghost)
 
640
 
 
641
    @needs_tree_write_lock
 
642
    def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
 
643
        """Add revision_id, tree tuple as a parent.
 
644
 
 
645
        This is equivalent to retrieving the current list of parent trees
 
646
        and setting the list to its value plus parent_tuple. See also
 
647
        add_parent_tree_id - if you only have a parent id available it will be
 
648
        simpler to use that api. If you have the parent already available, using
 
649
        this api is preferred.
 
650
 
 
651
        :param parent_tuple: The (revision id, tree) to add to the parent list.
 
652
            If the revision_id is a ghost, pass None for the tree.
 
653
        :param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
 
654
        """
 
655
        parent_ids = self.get_parent_ids() + [parent_tuple[0]]
 
656
        if len(parent_ids) > 1:
 
657
            # the leftmost may have already been a ghost, preserve that if it
 
658
            # was.
 
659
            allow_leftmost_as_ghost = True
 
660
        self.set_parent_ids(parent_ids,
 
661
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
662
 
 
663
    @needs_tree_write_lock
 
664
    def add_pending_merge(self, *revision_ids):
 
665
        # TODO: Perhaps should check at this point that the
 
666
        # history of the revision is actually present?
 
667
        parents = self.get_parent_ids()
 
668
        updated = False
 
669
        for rev_id in revision_ids:
 
670
            if rev_id in parents:
 
671
                continue
 
672
            parents.append(rev_id)
 
673
            updated = True
 
674
        if updated:
 
675
            self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
 
676
 
 
677
    @deprecated_method(zero_eleven)
 
678
    @needs_read_lock
 
679
    def pending_merges(self):
 
680
        """Return a list of pending merges.
 
681
 
 
682
        These are revisions that have been merged into the working
 
683
        directory but not yet committed.
 
684
 
 
685
        As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
 
686
        instead - which is available on all tree objects.
 
687
        """
 
688
        return self.get_parent_ids()[1:]
 
689
 
 
690
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
 
691
        """Common ghost checking functionality from set_parent_*.
 
692
 
 
693
        This checks that the left hand-parent exists if there are any
 
694
        revisions present.
 
695
        """
 
696
        if len(revision_ids) > 0:
 
697
            leftmost_id = revision_ids[0]
 
698
            if (not allow_leftmost_as_ghost and not
 
699
                self.branch.repository.has_revision(leftmost_id)):
 
700
                raise errors.GhostRevisionUnusableHere(leftmost_id)
 
701
 
 
702
    def _set_merges_from_parent_ids(self, parent_ids):
 
703
        merges = parent_ids[1:]
 
704
        self._control_files.put_utf8('pending-merges', '\n'.join(merges))
 
705
 
 
706
    @needs_tree_write_lock
 
707
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
 
708
        """Set the parent ids to revision_ids.
 
709
        
 
710
        See also set_parent_trees. This api will try to retrieve the tree data
 
711
        for each element of revision_ids from the trees repository. If you have
 
712
        tree data already available, it is more efficient to use
 
713
        set_parent_trees rather than set_parent_ids. set_parent_ids is however
 
714
        an easier API to use.
 
715
 
 
716
        :param revision_ids: The revision_ids to set as the parent ids of this
 
717
            working tree. Any of these may be ghosts.
 
718
        """
 
719
        self._check_parents_for_ghosts(revision_ids,
 
720
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
721
 
 
722
        if len(revision_ids) > 0:
 
723
            self.set_last_revision(revision_ids[0])
 
724
        else:
 
725
            self.set_last_revision(None)
 
726
 
 
727
        self._set_merges_from_parent_ids(revision_ids)
 
728
 
 
729
    @needs_tree_write_lock
 
730
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
 
731
        """See MutableTree.set_parent_trees."""
 
732
        parent_ids = [rev for (rev, tree) in parents_list]
 
733
 
 
734
        self._check_parents_for_ghosts(parent_ids,
 
735
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
736
 
 
737
        if len(parent_ids) == 0:
 
738
            leftmost_parent_id = None
 
739
            leftmost_parent_tree = None
 
740
        else:
 
741
            leftmost_parent_id, leftmost_parent_tree = parents_list[0]
 
742
 
 
743
        if self._change_last_revision(leftmost_parent_id):
 
744
            if leftmost_parent_tree is None:
 
745
                # If we don't have a tree, fall back to reading the
 
746
                # parent tree from the repository.
 
747
                self._cache_basis_inventory(leftmost_parent_id)
 
748
            else:
 
749
                inv = leftmost_parent_tree.inventory
 
750
                xml = self._create_basis_xml_from_inventory(
 
751
                                        leftmost_parent_id, inv)
 
752
                self._write_basis_inventory(xml)
 
753
        self._set_merges_from_parent_ids(parent_ids)
 
754
 
 
755
    @needs_tree_write_lock
 
756
    def set_pending_merges(self, rev_list):
 
757
        parents = self.get_parent_ids()
 
758
        leftmost = parents[:1]
 
759
        new_parents = leftmost + rev_list
 
760
        self.set_parent_ids(new_parents)
 
761
 
 
762
    @needs_tree_write_lock
 
763
    def set_merge_modified(self, modified_hashes):
 
764
        def iter_stanzas():
 
765
            for file_id, hash in modified_hashes.iteritems():
 
766
                yield Stanza(file_id=file_id, hash=hash)
 
767
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
 
768
 
 
769
    @needs_tree_write_lock
 
770
    def _put_rio(self, filename, stanzas, header):
 
771
        my_file = rio_file(stanzas, header)
 
772
        self._control_files.put(filename, my_file)
 
773
 
 
774
    @needs_write_lock # because merge pulls data into the branch.
 
775
    def merge_from_branch(self, branch, to_revision=None):
 
776
        """Merge from a branch into this working tree.
 
777
 
 
778
        :param branch: The branch to merge from.
 
779
        :param to_revision: If non-None, the merge will merge to to_revision,
 
780
            but not beyond it. to_revision does not need to be in the history
 
781
            of the branch when it is supplied. If None, to_revision defaults to
 
782
            branch.last_revision().
 
783
        """
 
784
        from bzrlib.merge import Merger, Merge3Merger
 
785
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
786
        try:
 
787
            merger = Merger(self.branch, this_tree=self, pb=pb)
 
788
            merger.pp = ProgressPhase("Merge phase", 5, pb)
 
789
            merger.pp.next_phase()
 
790
            # check that there are no
 
791
            # local alterations
 
792
            merger.check_basis(check_clean=True, require_commits=False)
 
793
            if to_revision is None:
 
794
                to_revision = branch.last_revision()
 
795
            merger.other_rev_id = to_revision
 
796
            if merger.other_rev_id is None:
 
797
                raise error.NoCommits(branch)
 
798
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
799
            merger.other_basis = merger.other_rev_id
 
800
            merger.other_tree = self.branch.repository.revision_tree(
 
801
                merger.other_rev_id)
 
802
            merger.pp.next_phase()
 
803
            merger.find_base()
 
804
            if merger.base_rev_id == merger.other_rev_id:
 
805
                raise errors.PointlessMerge
 
806
            merger.backup_files = False
 
807
            merger.merge_type = Merge3Merger
 
808
            merger.set_interesting_files(None)
 
809
            merger.show_base = False
 
810
            merger.reprocess = False
 
811
            conflicts = merger.do_merge()
 
812
            merger.set_pending()
 
813
        finally:
 
814
            pb.finished()
 
815
        return conflicts
 
816
 
 
817
    @needs_read_lock
 
818
    def merge_modified(self):
 
819
        try:
 
820
            hashfile = self._control_files.get('merge-hashes')
 
821
        except errors.NoSuchFile:
 
822
            return {}
 
823
        merge_hashes = {}
 
824
        try:
 
825
            if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
 
826
                raise errors.MergeModifiedFormatError()
 
827
        except StopIteration:
 
828
            raise errors.MergeModifiedFormatError()
 
829
        for s in RioReader(hashfile):
 
830
            file_id = s.get("file_id")
 
831
            if file_id not in self.inventory:
 
832
                continue
 
833
            hash = s.get("hash")
 
834
            if hash == self.get_file_sha1(file_id):
 
835
                merge_hashes[file_id] = hash
 
836
        return merge_hashes
 
837
 
 
838
    @needs_write_lock
 
839
    def mkdir(self, path, file_id=None):
 
840
        """See MutableTree.mkdir()."""
 
841
        if file_id is None:
 
842
            file_id = generate_ids.gen_file_id(os.path.basename(path))
 
843
        os.mkdir(self.abspath(path))
 
844
        self.add(path, file_id, 'directory')
 
845
        return file_id
 
846
 
 
847
    def get_symlink_target(self, file_id):
 
848
        return os.readlink(self.id2abspath(file_id))
 
849
 
 
850
    def file_class(self, filename):
 
851
        if self.path2id(filename):
 
852
            return 'V'
 
853
        elif self.is_ignored(filename):
 
854
            return 'I'
 
855
        else:
 
856
            return '?'
 
857
 
 
858
    def flush(self):
 
859
        """Write the in memory inventory to disk."""
 
860
        # TODO: Maybe this should only write on dirty ?
 
861
        if self._control_files._lock_mode != 'w':
 
862
            raise errors.NotWriteLocked(self)
 
863
        sio = StringIO()
 
864
        xml5.serializer_v5.write_inventory(self._inventory, sio)
 
865
        sio.seek(0)
 
866
        self._control_files.put('inventory', sio)
 
867
        self._inventory_is_modified = False
 
868
 
 
869
    def list_files(self, include_root=False):
 
870
        """Recursively list all files as (path, class, kind, id, entry).
 
871
 
 
872
        Lists, but does not descend into unversioned directories.
 
873
 
 
874
        This does not include files that have been deleted in this
 
875
        tree.
 
876
 
 
877
        Skips the control directory.
 
878
        """
 
879
        inv = self._inventory
 
880
        if include_root is True:
 
881
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
 
882
        # Convert these into local objects to save lookup times
 
883
        pathjoin = osutils.pathjoin
 
884
        file_kind = osutils.file_kind
 
885
 
 
886
        # transport.base ends in a slash, we want the piece
 
887
        # between the last two slashes
 
888
        transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
 
889
 
 
890
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
 
891
 
 
892
        # directory file_id, relative path, absolute path, reverse sorted children
 
893
        children = os.listdir(self.basedir)
 
894
        children.sort()
 
895
        # jam 20060527 The kernel sized tree seems equivalent whether we 
 
896
        # use a deque and popleft to keep them sorted, or if we use a plain
 
897
        # list and just reverse() them.
 
898
        children = collections.deque(children)
 
899
        stack = [(inv.root.file_id, u'', self.basedir, children)]
 
900
        while stack:
 
901
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
 
902
 
 
903
            while children:
 
904
                f = children.popleft()
 
905
                ## TODO: If we find a subdirectory with its own .bzr
 
906
                ## directory, then that is a separate tree and we
 
907
                ## should exclude it.
 
908
 
 
909
                # the bzrdir for this tree
 
910
                if transport_base_dir == f:
 
911
                    continue
 
912
 
 
913
                # we know that from_dir_relpath and from_dir_abspath never end in a slash
 
914
                # and 'f' doesn't begin with one, we can do a string op, rather
 
915
                # than the checks of pathjoin(), all relative paths will have an extra slash
 
916
                # at the beginning
 
917
                fp = from_dir_relpath + '/' + f
 
918
 
 
919
                # absolute path
 
920
                fap = from_dir_abspath + '/' + f
 
921
                
 
922
                f_ie = inv.get_child(from_dir_id, f)
 
923
                if f_ie:
 
924
                    c = 'V'
 
925
                elif self.is_ignored(fp[1:]):
 
926
                    c = 'I'
 
927
                else:
 
928
                    # we may not have found this file, because of a unicode issue
 
929
                    f_norm, can_access = osutils.normalized_filename(f)
 
930
                    if f == f_norm or not can_access:
 
931
                        # No change, so treat this file normally
 
932
                        c = '?'
 
933
                    else:
 
934
                        # this file can be accessed by a normalized path
 
935
                        # check again if it is versioned
 
936
                        # these lines are repeated here for performance
 
937
                        f = f_norm
 
938
                        fp = from_dir_relpath + '/' + f
 
939
                        fap = from_dir_abspath + '/' + f
 
940
                        f_ie = inv.get_child(from_dir_id, f)
 
941
                        if f_ie:
 
942
                            c = 'V'
 
943
                        elif self.is_ignored(fp[1:]):
 
944
                            c = 'I'
 
945
                        else:
 
946
                            c = '?'
 
947
 
 
948
                fk = file_kind(fap)
 
949
 
 
950
                if f_ie:
 
951
                    if f_ie.kind != fk:
 
952
                        raise errors.BzrCheckError(
 
953
                            "file %r entered as kind %r id %r, now of kind %r"
 
954
                            % (fap, f_ie.kind, f_ie.file_id, fk))
 
955
 
 
956
                # make a last minute entry
 
957
                if f_ie:
 
958
                    yield fp[1:], c, fk, f_ie.file_id, f_ie
 
959
                else:
 
960
                    try:
 
961
                        yield fp[1:], c, fk, None, fk_entries[fk]()
 
962
                    except KeyError:
 
963
                        yield fp[1:], c, fk, None, TreeEntry()
 
964
                    continue
 
965
                
 
966
                if fk != 'directory':
 
967
                    continue
 
968
 
 
969
                # But do this child first
 
970
                new_children = os.listdir(fap)
 
971
                new_children.sort()
 
972
                new_children = collections.deque(new_children)
 
973
                stack.append((f_ie.file_id, fp, fap, new_children))
 
974
                # Break out of inner loop,
 
975
                # so that we start outer loop with child
 
976
                break
 
977
            else:
 
978
                # if we finished all children, pop it off the stack
 
979
                stack.pop()
 
980
 
 
981
    @needs_tree_write_lock
 
982
    def move(self, from_paths, to_dir=None, after=False, **kwargs):
 
983
        """Rename files.
 
984
 
 
985
        to_dir must exist in the inventory.
 
986
 
 
987
        If to_dir exists and is a directory, the files are moved into
 
988
        it, keeping their old names.  
 
989
 
 
990
        Note that to_dir is only the last component of the new name;
 
991
        this doesn't change the directory.
 
992
 
 
993
        For each entry in from_paths the move mode will be determined
 
994
        independently.
 
995
 
 
996
        The first mode moves the file in the filesystem and updates the
 
997
        inventory. The second mode only updates the inventory without
 
998
        touching the file on the filesystem. This is the new mode introduced
 
999
        in version 0.15.
 
1000
 
 
1001
        move uses the second mode if 'after == True' and the target is not
 
1002
        versioned but present in the working tree.
 
1003
 
 
1004
        move uses the second mode if 'after == False' and the source is
 
1005
        versioned but no longer in the working tree, and the target is not
 
1006
        versioned but present in the working tree.
 
1007
 
 
1008
        move uses the first mode if 'after == False' and the source is
 
1009
        versioned and present in the working tree, and the target is not
 
1010
        versioned and not present in the working tree.
 
1011
 
 
1012
        Everything else results in an error.
 
1013
 
 
1014
        This returns a list of (from_path, to_path) pairs for each
 
1015
        entry that is moved.
 
1016
        """
 
1017
        rename_entries = []
 
1018
        rename_tuples = []
 
1019
 
 
1020
        # check for deprecated use of signature
 
1021
        if to_dir is None:
 
1022
            to_dir = kwargs.get('to_name', None)
 
1023
            if to_dir is None:
 
1024
                raise TypeError('You must supply a target directory')
 
1025
            else:
 
1026
                symbol_versioning.warn('The parameter to_name was deprecated'
 
1027
                                       ' in version 0.13. Use to_dir instead',
 
1028
                                       DeprecationWarning)
 
1029
 
 
1030
        # check destination directory
 
1031
        assert not isinstance(from_paths, basestring)
 
1032
        inv = self.inventory
 
1033
        to_abs = self.abspath(to_dir)
 
1034
        if not isdir(to_abs):
 
1035
            raise errors.BzrMoveFailedError('',to_dir,
 
1036
                errors.NotADirectory(to_abs))
 
1037
        if not self.has_filename(to_dir):
 
1038
            raise errors.BzrMoveFailedError('',to_dir,
 
1039
                errors.NotInWorkingDirectory(to_dir))
 
1040
        to_dir_id = inv.path2id(to_dir)
 
1041
        if to_dir_id is None:
 
1042
            raise errors.BzrMoveFailedError('',to_dir,
 
1043
                errors.NotVersionedError(path=str(to_dir)))
 
1044
 
 
1045
        to_dir_ie = inv[to_dir_id]
 
1046
        if to_dir_ie.kind != 'directory':
 
1047
            raise errors.BzrMoveFailedError('',to_dir,
 
1048
                errors.NotADirectory(to_abs))
 
1049
 
 
1050
        # create rename entries and tuples
 
1051
        for from_rel in from_paths:
 
1052
            from_tail = splitpath(from_rel)[-1]
 
1053
            from_id = inv.path2id(from_rel)
 
1054
            if from_id is None:
 
1055
                raise errors.BzrMoveFailedError(from_rel,to_dir,
 
1056
                    errors.NotVersionedError(path=str(from_rel)))
 
1057
 
 
1058
            from_entry = inv[from_id]
 
1059
            from_parent_id = from_entry.parent_id
 
1060
            to_rel = pathjoin(to_dir, from_tail)
 
1061
            rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
 
1062
                                         from_id=from_id,
 
1063
                                         from_tail=from_tail,
 
1064
                                         from_parent_id=from_parent_id,
 
1065
                                         to_rel=to_rel, to_tail=from_tail,
 
1066
                                         to_parent_id=to_dir_id)
 
1067
            rename_entries.append(rename_entry)
 
1068
            rename_tuples.append((from_rel, to_rel))
 
1069
 
 
1070
        # determine which move mode to use. checks also for movability
 
1071
        rename_entries = self._determine_mv_mode(rename_entries, after)
 
1072
 
 
1073
        original_modified = self._inventory_is_modified
 
1074
        try:
 
1075
            if len(from_paths):
 
1076
                self._inventory_is_modified = True
 
1077
            self._move(rename_entries)
 
1078
        except:
 
1079
            # restore the inventory on error
 
1080
            self._inventory_is_modified = original_modified
 
1081
            raise
 
1082
        self._write_inventory(inv)
 
1083
        return rename_tuples
 
1084
 
 
1085
    def _determine_mv_mode(self, rename_entries, after=False):
 
1086
        """Determines for each from-to pair if both inventory and working tree
 
1087
        or only the inventory has to be changed.
 
1088
 
 
1089
        Also does basic plausability tests.
 
1090
        """
 
1091
        inv = self.inventory
 
1092
 
 
1093
        for rename_entry in rename_entries:
 
1094
            # store to local variables for easier reference
 
1095
            from_rel = rename_entry.from_rel
 
1096
            from_id = rename_entry.from_id
 
1097
            to_rel = rename_entry.to_rel
 
1098
            to_id = inv.path2id(to_rel)
 
1099
            only_change_inv = False
 
1100
 
 
1101
            # check the inventory for source and destination
 
1102
            if from_id is None:
 
1103
                raise errors.BzrMoveFailedError(from_rel,to_rel,
 
1104
                    errors.NotVersionedError(path=str(from_rel)))
 
1105
            if to_id is not None:
 
1106
                raise errors.BzrMoveFailedError(from_rel,to_rel,
 
1107
                    errors.AlreadyVersionedError(path=str(to_rel)))
 
1108
 
 
1109
            # try to determine the mode for rename (only change inv or change
 
1110
            # inv and file system)
 
1111
            if after:
 
1112
                if not self.has_filename(to_rel):
 
1113
                    raise errors.BzrMoveFailedError(from_id,to_rel,
 
1114
                        errors.NoSuchFile(path=str(to_rel),
 
1115
                        extra="New file has not been created yet"))
 
1116
                only_change_inv = True
 
1117
            elif not self.has_filename(from_rel) and self.has_filename(to_rel):
 
1118
                only_change_inv = True
 
1119
            elif self.has_filename(from_rel) and not self.has_filename(to_rel):
 
1120
                only_change_inv = False
 
1121
            else:
 
1122
                # something is wrong, so lets determine what exactly
 
1123
                if not self.has_filename(from_rel) and \
 
1124
                   not self.has_filename(to_rel):
 
1125
                    raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1126
                        errors.PathsDoNotExist(paths=(str(from_rel),
 
1127
                        str(to_rel))))
 
1128
                else:
 
1129
                    raise errors.RenameFailedFilesExist(from_rel, to_rel,
 
1130
                        extra="(Use --after to update the Bazaar id)")
 
1131
            rename_entry.only_change_inv = only_change_inv
 
1132
        return rename_entries
 
1133
 
 
1134
    def _move(self, rename_entries):
 
1135
        """Moves a list of files.
 
1136
 
 
1137
        Depending on the value of the flag 'only_change_inv', the
 
1138
        file will be moved on the file system or not.
 
1139
        """
 
1140
        inv = self.inventory
 
1141
        moved = []
 
1142
 
 
1143
        for entry in rename_entries:
 
1144
            try:
 
1145
                self._move_entry(entry)
 
1146
            except:
 
1147
                self._rollback_move(moved)
 
1148
                raise
 
1149
            moved.append(entry)
 
1150
 
 
1151
    def _rollback_move(self, moved):
 
1152
        """Try to rollback a previous move in case of an filesystem error."""
 
1153
        inv = self.inventory
 
1154
        for entry in moved:
 
1155
            try:
 
1156
                self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
 
1157
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
 
1158
                    entry.from_tail, entry.from_parent_id,
 
1159
                    entry.only_change_inv))
 
1160
            except errors.BzrMoveFailedError, e:
 
1161
                raise errors.BzrMoveFailedError( '', '', "Rollback failed."
 
1162
                        " The working tree is in an inconsistent state."
 
1163
                        " Please consider doing a 'bzr revert'."
 
1164
                        " Error message is: %s" % e)
 
1165
 
 
1166
    def _move_entry(self, entry):
 
1167
        inv = self.inventory
 
1168
        from_rel_abs = self.abspath(entry.from_rel)
 
1169
        to_rel_abs = self.abspath(entry.to_rel)
 
1170
        if from_rel_abs == to_rel_abs:
 
1171
            raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
 
1172
                "Source and target are identical.")
 
1173
 
 
1174
        if not entry.only_change_inv:
 
1175
            try:
 
1176
                osutils.rename(from_rel_abs, to_rel_abs)
 
1177
            except OSError, e:
 
1178
                raise errors.BzrMoveFailedError(entry.from_rel,
 
1179
                    entry.to_rel, e[1])
 
1180
        inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
 
1181
 
 
1182
    @needs_tree_write_lock
 
1183
    def rename_one(self, from_rel, to_rel, after=False):
 
1184
        """Rename one file.
 
1185
 
 
1186
        This can change the directory or the filename or both.
 
1187
 
 
1188
        rename_one has several 'modes' to work. First, it can rename a physical
 
1189
        file and change the file_id. That is the normal mode. Second, it can
 
1190
        only change the file_id without touching any physical file. This is
 
1191
        the new mode introduced in version 0.15.
 
1192
 
 
1193
        rename_one uses the second mode if 'after == True' and 'to_rel' is not
 
1194
        versioned but present in the working tree.
 
1195
 
 
1196
        rename_one uses the second mode if 'after == False' and 'from_rel' is
 
1197
        versioned but no longer in the working tree, and 'to_rel' is not
 
1198
        versioned but present in the working tree.
 
1199
 
 
1200
        rename_one uses the first mode if 'after == False' and 'from_rel' is
 
1201
        versioned and present in the working tree, and 'to_rel' is not
 
1202
        versioned and not present in the working tree.
 
1203
 
 
1204
        Everything else results in an error.
 
1205
        """
 
1206
        inv = self.inventory
 
1207
        rename_entries = []
 
1208
 
 
1209
        # create rename entries and tuples
 
1210
        from_tail = splitpath(from_rel)[-1]
 
1211
        from_id = inv.path2id(from_rel)
 
1212
        if from_id is None:
 
1213
            raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1214
                errors.NotVersionedError(path=str(from_rel)))
 
1215
        from_entry = inv[from_id]
 
1216
        from_parent_id = from_entry.parent_id
 
1217
        to_dir, to_tail = os.path.split(to_rel)
 
1218
        to_dir_id = inv.path2id(to_dir)
 
1219
        rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
 
1220
                                     from_id=from_id,
 
1221
                                     from_tail=from_tail,
 
1222
                                     from_parent_id=from_parent_id,
 
1223
                                     to_rel=to_rel, to_tail=to_tail,
 
1224
                                     to_parent_id=to_dir_id)
 
1225
        rename_entries.append(rename_entry)
 
1226
 
 
1227
        # determine which move mode to use. checks also for movability
 
1228
        rename_entries = self._determine_mv_mode(rename_entries, after)
 
1229
 
 
1230
        # check if the target changed directory and if the target directory is
 
1231
        # versioned
 
1232
        if to_dir_id is None:
 
1233
            raise errors.BzrMoveFailedError(from_rel,to_rel,
 
1234
                errors.NotVersionedError(path=str(to_dir)))
 
1235
 
 
1236
        # all checks done. now we can continue with our actual work
 
1237
        mutter('rename_one:\n'
 
1238
               '  from_id   {%s}\n'
 
1239
               '  from_rel: %r\n'
 
1240
               '  to_rel:   %r\n'
 
1241
               '  to_dir    %r\n'
 
1242
               '  to_dir_id {%s}\n',
 
1243
               from_id, from_rel, to_rel, to_dir, to_dir_id)
 
1244
 
 
1245
        self._move(rename_entries)
 
1246
        self._write_inventory(inv)
 
1247
 
 
1248
    class _RenameEntry(object):
 
1249
        def __init__(self, from_rel, from_id, from_tail, from_parent_id,
 
1250
                     to_rel, to_tail, to_parent_id, only_change_inv=False):
 
1251
            self.from_rel = from_rel
 
1252
            self.from_id = from_id
 
1253
            self.from_tail = from_tail
 
1254
            self.from_parent_id = from_parent_id
 
1255
            self.to_rel = to_rel
 
1256
            self.to_tail = to_tail
 
1257
            self.to_parent_id = to_parent_id
 
1258
            self.only_change_inv = only_change_inv
 
1259
 
 
1260
    @needs_read_lock
 
1261
    def unknowns(self):
 
1262
        """Return all unknown files.
 
1263
 
 
1264
        These are files in the working directory that are not versioned or
 
1265
        control files or ignored.
 
1266
        """
 
1267
        for subp in self.extras():
 
1268
            if not self.is_ignored(subp):
 
1269
                yield subp
 
1270
    
 
1271
    @needs_tree_write_lock
 
1272
    def unversion(self, file_ids):
 
1273
        """Remove the file ids in file_ids from the current versioned set.
 
1274
 
 
1275
        When a file_id is unversioned, all of its children are automatically
 
1276
        unversioned.
 
1277
 
 
1278
        :param file_ids: The file ids to stop versioning.
 
1279
        :raises: NoSuchId if any fileid is not currently versioned.
 
1280
        """
 
1281
        for file_id in file_ids:
 
1282
            if self._inventory.has_id(file_id):
 
1283
                self._inventory.remove_recursive_id(file_id)
 
1284
            else:
 
1285
                raise errors.NoSuchId(self, file_id)
 
1286
        if len(file_ids):
 
1287
            # in the future this should just set a dirty bit to wait for the 
 
1288
            # final unlock. However, until all methods of workingtree start
 
1289
            # with the current in -memory inventory rather than triggering 
 
1290
            # a read, it is more complex - we need to teach read_inventory
 
1291
            # to know when to read, and when to not read first... and possibly
 
1292
            # to save first when the in memory one may be corrupted.
 
1293
            # so for now, we just only write it if it is indeed dirty.
 
1294
            # - RBC 20060907
 
1295
            self._write_inventory(self._inventory)
 
1296
    
 
1297
    @deprecated_method(zero_eight)
 
1298
    def iter_conflicts(self):
 
1299
        """List all files in the tree that have text or content conflicts.
 
1300
        DEPRECATED.  Use conflicts instead."""
 
1301
        return self._iter_conflicts()
 
1302
 
 
1303
    def _iter_conflicts(self):
 
1304
        conflicted = set()
 
1305
        for info in self.list_files():
 
1306
            path = info[0]
 
1307
            stem = get_conflicted_stem(path)
 
1308
            if stem is None:
 
1309
                continue
 
1310
            if stem not in conflicted:
 
1311
                conflicted.add(stem)
 
1312
                yield stem
 
1313
 
 
1314
    @needs_write_lock
 
1315
    def pull(self, source, overwrite=False, stop_revision=None):
 
1316
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1317
        source.lock_read()
 
1318
        try:
 
1319
            pp = ProgressPhase("Pull phase", 2, top_pb)
 
1320
            pp.next_phase()
 
1321
            old_revision_history = self.branch.revision_history()
 
1322
            basis_tree = self.basis_tree()
 
1323
            count = self.branch.pull(source, overwrite, stop_revision)
 
1324
            new_revision_history = self.branch.revision_history()
 
1325
            if new_revision_history != old_revision_history:
 
1326
                pp.next_phase()
 
1327
                if len(old_revision_history):
 
1328
                    other_revision = old_revision_history[-1]
 
1329
                else:
 
1330
                    other_revision = None
 
1331
                repository = self.branch.repository
 
1332
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1333
                try:
 
1334
                    new_basis_tree = self.branch.basis_tree()
 
1335
                    merge.merge_inner(
 
1336
                                self.branch,
 
1337
                                new_basis_tree,
 
1338
                                basis_tree,
 
1339
                                this_tree=self,
 
1340
                                pb=pb)
 
1341
                    if (basis_tree.inventory.root is None and
 
1342
                        new_basis_tree.inventory.root is not None):
 
1343
                        self.set_root_id(new_basis_tree.inventory.root.file_id)
 
1344
                finally:
 
1345
                    pb.finished()
 
1346
                # TODO - dedup parents list with things merged by pull ?
 
1347
                # reuse the revisiontree we merged against to set the new
 
1348
                # tree data.
 
1349
                parent_trees = [(self.branch.last_revision(), new_basis_tree)]
 
1350
                # we have to pull the merge trees out again, because 
 
1351
                # merge_inner has set the ids. - this corner is not yet 
 
1352
                # layered well enough to prevent double handling.
 
1353
                merges = self.get_parent_ids()[1:]
 
1354
                parent_trees.extend([
 
1355
                    (parent, repository.revision_tree(parent)) for
 
1356
                     parent in merges])
 
1357
                self.set_parent_trees(parent_trees)
 
1358
            return count
 
1359
        finally:
 
1360
            source.unlock()
 
1361
            top_pb.finished()
 
1362
 
 
1363
    @needs_write_lock
 
1364
    def put_file_bytes_non_atomic(self, file_id, bytes):
 
1365
        """See MutableTree.put_file_bytes_non_atomic."""
 
1366
        stream = file(self.id2abspath(file_id), 'wb')
 
1367
        try:
 
1368
            stream.write(bytes)
 
1369
        finally:
 
1370
            stream.close()
 
1371
        # TODO: update the hashcache here ?
 
1372
 
 
1373
    def extras(self):
 
1374
        """Yield all unknown files in this WorkingTree.
 
1375
 
 
1376
        If there are any unknown directories then only the directory is
 
1377
        returned, not all its children.  But if there are unknown files
 
1378
        under a versioned subdirectory, they are returned.
 
1379
 
 
1380
        Currently returned depth-first, sorted by name within directories.
 
1381
        """
 
1382
        ## TODO: Work from given directory downwards
 
1383
        for path, dir_entry in self.inventory.directories():
 
1384
            # mutter("search for unknowns in %r", path)
 
1385
            dirabs = self.abspath(path)
 
1386
            if not isdir(dirabs):
 
1387
                # e.g. directory deleted
 
1388
                continue
 
1389
 
 
1390
            fl = []
 
1391
            for subf in os.listdir(dirabs):
 
1392
                if subf == '.bzr':
 
1393
                    continue
 
1394
                if subf not in dir_entry.children:
 
1395
                    subf_norm, can_access = osutils.normalized_filename(subf)
 
1396
                    if subf_norm != subf and can_access:
 
1397
                        if subf_norm not in dir_entry.children:
 
1398
                            fl.append(subf_norm)
 
1399
                    else:
 
1400
                        fl.append(subf)
 
1401
            
 
1402
            fl.sort()
 
1403
            for subf in fl:
 
1404
                subp = pathjoin(path, subf)
 
1405
                yield subp
 
1406
 
 
1407
 
 
1408
    def ignored_files(self):
 
1409
        """Yield list of PATH, IGNORE_PATTERN"""
 
1410
        for subp in self.extras():
 
1411
            pat = self.is_ignored(subp)
 
1412
            if pat is not None:
 
1413
                yield subp, pat
 
1414
 
 
1415
    def get_ignore_list(self):
 
1416
        """Return list of ignore patterns.
 
1417
 
 
1418
        Cached in the Tree object after the first call.
 
1419
        """
 
1420
        ignoreset = getattr(self, '_ignoreset', None)
 
1421
        if ignoreset is not None:
 
1422
            return ignoreset
 
1423
 
 
1424
        ignore_globs = set(bzrlib.DEFAULT_IGNORE)
 
1425
        ignore_globs.update(ignores.get_runtime_ignores())
 
1426
        ignore_globs.update(ignores.get_user_ignores())
 
1427
        if self.has_filename(bzrlib.IGNORE_FILENAME):
 
1428
            f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
 
1429
            try:
 
1430
                ignore_globs.update(ignores.parse_ignore_file(f))
 
1431
            finally:
 
1432
                f.close()
 
1433
        self._ignoreset = ignore_globs
 
1434
        return ignore_globs
 
1435
 
 
1436
    def _flush_ignore_list_cache(self):
 
1437
        """Resets the cached ignore list to force a cache rebuild."""
 
1438
        self._ignoreset = None
 
1439
        self._ignoreglobster = None
 
1440
 
 
1441
    def is_ignored(self, filename):
 
1442
        r"""Check whether the filename matches an ignore pattern.
 
1443
 
 
1444
        Patterns containing '/' or '\' need to match the whole path;
 
1445
        others match against only the last component.
 
1446
 
 
1447
        If the file is ignored, returns the pattern which caused it to
 
1448
        be ignored, otherwise None.  So this can simply be used as a
 
1449
        boolean if desired."""
 
1450
        if getattr(self, '_ignoreglobster', None) is None:
 
1451
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
 
1452
        return self._ignoreglobster.match(filename)
 
1453
 
 
1454
    def kind(self, file_id):
 
1455
        return file_kind(self.id2abspath(file_id))
 
1456
 
 
1457
    def _comparison_data(self, entry, path):
 
1458
        abspath = self.abspath(path)
 
1459
        try:
 
1460
            stat_value = os.lstat(abspath)
 
1461
        except OSError, e:
 
1462
            if getattr(e, 'errno', None) == errno.ENOENT:
 
1463
                stat_value = None
 
1464
                kind = None
 
1465
                executable = False
 
1466
            else:
 
1467
                raise
 
1468
        else:
 
1469
            mode = stat_value.st_mode
 
1470
            kind = osutils.file_kind_from_stat_mode(mode)
 
1471
            if not supports_executable():
 
1472
                executable = entry.executable
 
1473
            else:
 
1474
                executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
 
1475
        return kind, executable, stat_value
 
1476
 
 
1477
    def _file_size(self, entry, stat_value):
 
1478
        return stat_value.st_size
 
1479
 
 
1480
    def last_revision(self):
 
1481
        """Return the last revision of the branch for this tree.
 
1482
 
 
1483
        This format tree does not support a separate marker for last-revision
 
1484
        compared to the branch.
 
1485
 
 
1486
        See MutableTree.last_revision
 
1487
        """
 
1488
        return self._last_revision()
 
1489
 
 
1490
    @needs_read_lock
 
1491
    def _last_revision(self):
 
1492
        """helper for get_parent_ids."""
 
1493
        return self.branch.last_revision()
 
1494
 
 
1495
    def is_locked(self):
 
1496
        return self._control_files.is_locked()
 
1497
 
 
1498
    def lock_read(self):
 
1499
        """See Branch.lock_read, and WorkingTree.unlock."""
 
1500
        self.branch.lock_read()
 
1501
        try:
 
1502
            return self._control_files.lock_read()
 
1503
        except:
 
1504
            self.branch.unlock()
 
1505
            raise
 
1506
 
 
1507
    def lock_tree_write(self):
 
1508
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
 
1509
        self.branch.lock_read()
 
1510
        try:
 
1511
            return self._control_files.lock_write()
 
1512
        except:
 
1513
            self.branch.unlock()
 
1514
            raise
 
1515
 
 
1516
    def lock_write(self):
 
1517
        """See MutableTree.lock_write, and WorkingTree.unlock."""
 
1518
        self.branch.lock_write()
 
1519
        try:
 
1520
            return self._control_files.lock_write()
 
1521
        except:
 
1522
            self.branch.unlock()
 
1523
            raise
 
1524
 
 
1525
    def get_physical_lock_status(self):
 
1526
        return self._control_files.get_physical_lock_status()
 
1527
 
 
1528
    def _basis_inventory_name(self):
 
1529
        return 'basis-inventory-cache'
 
1530
 
 
1531
    @needs_tree_write_lock
 
1532
    def set_last_revision(self, new_revision):
 
1533
        """Change the last revision in the working tree."""
 
1534
        if self._change_last_revision(new_revision):
 
1535
            self._cache_basis_inventory(new_revision)
 
1536
 
 
1537
    def _change_last_revision(self, new_revision):
 
1538
        """Template method part of set_last_revision to perform the change.
 
1539
        
 
1540
        This is used to allow WorkingTree3 instances to not affect branch
 
1541
        when their last revision is set.
 
1542
        """
 
1543
        if new_revision is None:
 
1544
            self.branch.set_revision_history([])
 
1545
            return False
 
1546
        try:
 
1547
            self.branch.generate_revision_history(new_revision)
 
1548
        except errors.NoSuchRevision:
 
1549
            # not present in the repo - dont try to set it deeper than the tip
 
1550
            self.branch.set_revision_history([new_revision])
 
1551
        return True
 
1552
 
 
1553
    def _write_basis_inventory(self, xml):
 
1554
        """Write the basis inventory XML to the basis-inventory file"""
 
1555
        assert isinstance(xml, str), 'serialised xml must be bytestring.'
 
1556
        path = self._basis_inventory_name()
 
1557
        sio = StringIO(xml)
 
1558
        self._control_files.put(path, sio)
 
1559
 
 
1560
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
 
1561
        """Create the text that will be saved in basis-inventory"""
 
1562
        inventory.revision_id = revision_id
 
1563
        return xml6.serializer_v6.write_inventory_to_string(inventory)
 
1564
 
 
1565
    def _cache_basis_inventory(self, new_revision):
 
1566
        """Cache new_revision as the basis inventory."""
 
1567
        # TODO: this should allow the ready-to-use inventory to be passed in,
 
1568
        # as commit already has that ready-to-use [while the format is the
 
1569
        # same, that is].
 
1570
        try:
 
1571
            # this double handles the inventory - unpack and repack - 
 
1572
            # but is easier to understand. We can/should put a conditional
 
1573
            # in here based on whether the inventory is in the latest format
 
1574
            # - perhaps we should repack all inventories on a repository
 
1575
            # upgrade ?
 
1576
            # the fast path is to copy the raw xml from the repository. If the
 
1577
            # xml contains 'revision_id="', then we assume the right 
 
1578
            # revision_id is set. We must check for this full string, because a
 
1579
            # root node id can legitimately look like 'revision_id' but cannot
 
1580
            # contain a '"'.
 
1581
            xml = self.branch.repository.get_inventory_xml(new_revision)
 
1582
            firstline = xml.split('\n', 1)[0]
 
1583
            if (not 'revision_id="' in firstline or 
 
1584
                'format="6"' not in firstline):
 
1585
                inv = self.branch.repository.deserialise_inventory(
 
1586
                    new_revision, xml)
 
1587
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
 
1588
            self._write_basis_inventory(xml)
 
1589
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
 
1590
            pass
 
1591
 
 
1592
    def read_basis_inventory(self):
 
1593
        """Read the cached basis inventory."""
 
1594
        path = self._basis_inventory_name()
 
1595
        return self._control_files.get(path).read()
 
1596
        
 
1597
    @needs_read_lock
 
1598
    def read_working_inventory(self):
 
1599
        """Read the working inventory.
 
1600
        
 
1601
        :raises errors.InventoryModified: read_working_inventory will fail
 
1602
            when the current in memory inventory has been modified.
 
1603
        """
 
1604
        # conceptually this should be an implementation detail of the tree. 
 
1605
        # XXX: Deprecate this.
 
1606
        # ElementTree does its own conversion from UTF-8, so open in
 
1607
        # binary.
 
1608
        if self._inventory_is_modified:
 
1609
            raise errors.InventoryModified(self)
 
1610
        result = xml5.serializer_v5.read_inventory(
 
1611
            self._control_files.get('inventory'))
 
1612
        self._set_inventory(result, dirty=False)
 
1613
        return result
 
1614
 
 
1615
    @needs_tree_write_lock
 
1616
    def remove(self, files, verbose=False, to_file=None):
 
1617
        """Remove nominated files from the working inventory..
 
1618
 
 
1619
        This does not remove their text.  This does not run on XXX on what? RBC
 
1620
 
 
1621
        TODO: Refuse to remove modified files unless --force is given?
 
1622
 
 
1623
        TODO: Do something useful with directories.
 
1624
 
 
1625
        TODO: Should this remove the text or not?  Tough call; not
 
1626
        removing may be useful and the user can just use use rm, and
 
1627
        is the opposite of add.  Removing it is consistent with most
 
1628
        other tools.  Maybe an option.
 
1629
        """
 
1630
        ## TODO: Normalize names
 
1631
        ## TODO: Remove nested loops; better scalability
 
1632
        if isinstance(files, basestring):
 
1633
            files = [files]
 
1634
 
 
1635
        inv = self.inventory
 
1636
 
 
1637
        # do this before any modifications
 
1638
        for f in files:
 
1639
            fid = inv.path2id(f)
 
1640
            if not fid:
 
1641
                # TODO: Perhaps make this just a warning, and continue?
 
1642
                # This tends to happen when 
 
1643
                raise errors.NotVersionedError(path=f)
 
1644
            if verbose:
 
1645
                # having remove it, it must be either ignored or unknown
 
1646
                if self.is_ignored(f):
 
1647
                    new_status = 'I'
 
1648
                else:
 
1649
                    new_status = '?'
 
1650
                textui.show_status(new_status, inv[fid].kind, f,
 
1651
                                   to_file=to_file)
 
1652
            del inv[fid]
 
1653
 
 
1654
        self._write_inventory(inv)
 
1655
 
 
1656
    @needs_tree_write_lock
 
1657
    def revert(self, filenames, old_tree=None, backups=True, 
 
1658
               pb=DummyProgress(), report_changes=False):
 
1659
        from bzrlib.conflicts import resolve
 
1660
        if old_tree is None:
 
1661
            old_tree = self.basis_tree()
 
1662
        conflicts = transform.revert(self, old_tree, filenames, backups, pb,
 
1663
                                     report_changes)
 
1664
        if not len(filenames):
 
1665
            self.set_parent_ids(self.get_parent_ids()[:1])
 
1666
            resolve(self)
 
1667
        else:
 
1668
            resolve(self, filenames, ignore_misses=True)
 
1669
        return conflicts
 
1670
 
 
1671
    def revision_tree(self, revision_id):
 
1672
        """See Tree.revision_tree.
 
1673
 
 
1674
        WorkingTree can supply revision_trees for the basis revision only
 
1675
        because there is only one cached inventory in the bzr directory.
 
1676
        """
 
1677
        if revision_id == self.last_revision():
 
1678
            try:
 
1679
                xml = self.read_basis_inventory()
 
1680
            except errors.NoSuchFile:
 
1681
                pass
 
1682
            else:
 
1683
                try:
 
1684
                    inv = xml6.serializer_v6.read_inventory_from_string(xml)
 
1685
                    # dont use the repository revision_tree api because we want
 
1686
                    # to supply the inventory.
 
1687
                    if inv.revision_id == revision_id:
 
1688
                        return revisiontree.RevisionTree(self.branch.repository,
 
1689
                            inv, revision_id)
 
1690
                except errors.BadInventoryFormat:
 
1691
                    pass
 
1692
        # raise if there was no inventory, or if we read the wrong inventory.
 
1693
        raise errors.NoSuchRevisionInTree(self, revision_id)
 
1694
 
 
1695
    # XXX: This method should be deprecated in favour of taking in a proper
 
1696
    # new Inventory object.
 
1697
    @needs_tree_write_lock
 
1698
    def set_inventory(self, new_inventory_list):
 
1699
        from bzrlib.inventory import (Inventory,
 
1700
                                      InventoryDirectory,
 
1701
                                      InventoryEntry,
 
1702
                                      InventoryFile,
 
1703
                                      InventoryLink)
 
1704
        inv = Inventory(self.get_root_id())
 
1705
        for path, file_id, parent, kind in new_inventory_list:
 
1706
            name = os.path.basename(path)
 
1707
            if name == "":
 
1708
                continue
 
1709
            # fixme, there should be a factory function inv,add_?? 
 
1710
            if kind == 'directory':
 
1711
                inv.add(InventoryDirectory(file_id, name, parent))
 
1712
            elif kind == 'file':
 
1713
                inv.add(InventoryFile(file_id, name, parent))
 
1714
            elif kind == 'symlink':
 
1715
                inv.add(InventoryLink(file_id, name, parent))
 
1716
            else:
 
1717
                raise errors.BzrError("unknown kind %r" % kind)
 
1718
        self._write_inventory(inv)
 
1719
 
 
1720
    @needs_tree_write_lock
 
1721
    def set_root_id(self, file_id):
 
1722
        """Set the root id for this tree."""
 
1723
        # for compatability 
 
1724
        if file_id is None:
 
1725
            symbol_versioning.warn(symbol_versioning.zero_twelve
 
1726
                % 'WorkingTree.set_root_id with fileid=None',
 
1727
                DeprecationWarning,
 
1728
                stacklevel=3)
 
1729
            file_id = ROOT_ID
 
1730
        inv = self._inventory
 
1731
        orig_root_id = inv.root.file_id
 
1732
        # TODO: it might be nice to exit early if there was nothing
 
1733
        # to do, saving us from trigger a sync on unlock.
 
1734
        self._inventory_is_modified = True
 
1735
        # we preserve the root inventory entry object, but
 
1736
        # unlinkit from the byid index
 
1737
        del inv._byid[inv.root.file_id]
 
1738
        inv.root.file_id = file_id
 
1739
        # and link it into the index with the new changed id.
 
1740
        inv._byid[inv.root.file_id] = inv.root
 
1741
        # and finally update all children to reference the new id.
 
1742
        # XXX: this should be safe to just look at the root.children
 
1743
        # list, not the WHOLE INVENTORY.
 
1744
        for fid in inv:
 
1745
            entry = inv[fid]
 
1746
            if entry.parent_id == orig_root_id:
 
1747
                entry.parent_id = inv.root.file_id
 
1748
 
 
1749
    def unlock(self):
 
1750
        """See Branch.unlock.
 
1751
        
 
1752
        WorkingTree locking just uses the Branch locking facilities.
 
1753
        This is current because all working trees have an embedded branch
 
1754
        within them. IF in the future, we were to make branch data shareable
 
1755
        between multiple working trees, i.e. via shared storage, then we 
 
1756
        would probably want to lock both the local tree, and the branch.
 
1757
        """
 
1758
        raise NotImplementedError(self.unlock)
 
1759
 
 
1760
    def update(self):
 
1761
        """Update a working tree along its branch.
 
1762
 
 
1763
        This will update the branch if its bound too, which means we have
 
1764
        multiple trees involved:
 
1765
 
 
1766
        - The new basis tree of the master.
 
1767
        - The old basis tree of the branch.
 
1768
        - The old basis tree of the working tree.
 
1769
        - The current working tree state.
 
1770
 
 
1771
        Pathologically, all three may be different, and non-ancestors of each
 
1772
        other.  Conceptually we want to:
 
1773
 
 
1774
        - Preserve the wt.basis->wt.state changes
 
1775
        - Transform the wt.basis to the new master basis.
 
1776
        - Apply a merge of the old branch basis to get any 'local' changes from
 
1777
          it into the tree.
 
1778
        - Restore the wt.basis->wt.state changes.
 
1779
 
 
1780
        There isn't a single operation at the moment to do that, so we:
 
1781
        - Merge current state -> basis tree of the master w.r.t. the old tree
 
1782
          basis.
 
1783
        - Do a 'normal' merge of the old branch basis if it is relevant.
 
1784
        """
 
1785
        if self.branch.get_master_branch() is not None:
 
1786
            self.lock_write()
 
1787
            update_branch = True
 
1788
        else:
 
1789
            self.lock_tree_write()
 
1790
            update_branch = False
 
1791
        try:
 
1792
            if update_branch:
 
1793
                old_tip = self.branch.update()
 
1794
            else:
 
1795
                old_tip = None
 
1796
            return self._update_tree(old_tip)
 
1797
        finally:
 
1798
            self.unlock()
 
1799
 
 
1800
    @needs_tree_write_lock
 
1801
    def _update_tree(self, old_tip=None):
 
1802
        """Update a tree to the master branch.
 
1803
 
 
1804
        :param old_tip: if supplied, the previous tip revision the branch,
 
1805
            before it was changed to the master branch's tip.
 
1806
        """
 
1807
        # here if old_tip is not None, it is the old tip of the branch before
 
1808
        # it was updated from the master branch. This should become a pending
 
1809
        # merge in the working tree to preserve the user existing work.  we
 
1810
        # cant set that until we update the working trees last revision to be
 
1811
        # one from the new branch, because it will just get absorbed by the
 
1812
        # parent de-duplication logic.
 
1813
        # 
 
1814
        # We MUST save it even if an error occurs, because otherwise the users
 
1815
        # local work is unreferenced and will appear to have been lost.
 
1816
        # 
 
1817
        result = 0
 
1818
        try:
 
1819
            last_rev = self.get_parent_ids()[0]
 
1820
        except IndexError:
 
1821
            last_rev = None
 
1822
        if last_rev != self.branch.last_revision():
 
1823
            # merge tree state up to new branch tip.
 
1824
            basis = self.basis_tree()
 
1825
            to_tree = self.branch.basis_tree()
 
1826
            if basis.inventory.root is None:
 
1827
                self.set_root_id(to_tree.inventory.root.file_id)
 
1828
            result += merge.merge_inner(
 
1829
                                  self.branch,
 
1830
                                  to_tree,
 
1831
                                  basis,
 
1832
                                  this_tree=self)
 
1833
            # TODO - dedup parents list with things merged by pull ?
 
1834
            # reuse the tree we've updated to to set the basis:
 
1835
            parent_trees = [(self.branch.last_revision(), to_tree)]
 
1836
            merges = self.get_parent_ids()[1:]
 
1837
            # Ideally we ask the tree for the trees here, that way the working
 
1838
            # tree can decide whether to give us teh entire tree or give us a
 
1839
            # lazy initialised tree. dirstate for instance will have the trees
 
1840
            # in ram already, whereas a last-revision + basis-inventory tree
 
1841
            # will not, but also does not need them when setting parents.
 
1842
            for parent in merges:
 
1843
                parent_trees.append(
 
1844
                    (parent, self.branch.repository.revision_tree(parent)))
 
1845
            if old_tip is not None:
 
1846
                parent_trees.append(
 
1847
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
 
1848
            self.set_parent_trees(parent_trees)
 
1849
            last_rev = parent_trees[0][0]
 
1850
        else:
 
1851
            # the working tree had the same last-revision as the master
 
1852
            # branch did. We may still have pivot local work from the local
 
1853
            # branch into old_tip:
 
1854
            if old_tip is not None:
 
1855
                self.add_parent_tree_id(old_tip)
 
1856
        if old_tip and old_tip != last_rev:
 
1857
            # our last revision was not the prior branch last revision
 
1858
            # and we have converted that last revision to a pending merge.
 
1859
            # base is somewhere between the branch tip now
 
1860
            # and the now pending merge
 
1861
            from bzrlib.revision import common_ancestor
 
1862
            try:
 
1863
                base_rev_id = common_ancestor(self.branch.last_revision(),
 
1864
                                              old_tip,
 
1865
                                              self.branch.repository)
 
1866
            except errors.NoCommonAncestor:
 
1867
                base_rev_id = None
 
1868
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
1869
            other_tree = self.branch.repository.revision_tree(old_tip)
 
1870
            result += merge.merge_inner(
 
1871
                                  self.branch,
 
1872
                                  other_tree,
 
1873
                                  base_tree,
 
1874
                                  this_tree=self)
 
1875
        return result
 
1876
 
 
1877
    def _write_hashcache_if_dirty(self):
 
1878
        """Write out the hashcache if it is dirty."""
 
1879
        if self._hashcache.needs_write:
 
1880
            try:
 
1881
                self._hashcache.write()
 
1882
            except OSError, e:
 
1883
                if e.errno not in (errno.EPERM, errno.EACCES):
 
1884
                    raise
 
1885
                # TODO: jam 20061219 Should this be a warning? A single line
 
1886
                #       warning might be sufficient to let the user know what
 
1887
                #       is going on.
 
1888
                mutter('Could not write hashcache for %s\nError: %s',
 
1889
                       self._hashcache.cache_file_name(), e)
 
1890
 
 
1891
    @needs_tree_write_lock
 
1892
    def _write_inventory(self, inv):
 
1893
        """Write inventory as the current inventory."""
 
1894
        self._set_inventory(inv, dirty=True)
 
1895
        self.flush()
 
1896
 
 
1897
    def set_conflicts(self, arg):
 
1898
        raise errors.UnsupportedOperation(self.set_conflicts, self)
 
1899
 
 
1900
    def add_conflicts(self, arg):
 
1901
        raise errors.UnsupportedOperation(self.add_conflicts, self)
 
1902
 
 
1903
    @needs_read_lock
 
1904
    def conflicts(self):
 
1905
        conflicts = _mod_conflicts.ConflictList()
 
1906
        for conflicted in self._iter_conflicts():
 
1907
            text = True
 
1908
            try:
 
1909
                if file_kind(self.abspath(conflicted)) != "file":
 
1910
                    text = False
 
1911
            except errors.NoSuchFile:
 
1912
                text = False
 
1913
            if text is True:
 
1914
                for suffix in ('.THIS', '.OTHER'):
 
1915
                    try:
 
1916
                        kind = file_kind(self.abspath(conflicted+suffix))
 
1917
                        if kind != "file":
 
1918
                            text = False
 
1919
                    except errors.NoSuchFile:
 
1920
                        text = False
 
1921
                    if text == False:
 
1922
                        break
 
1923
            ctype = {True: 'text conflict', False: 'contents conflict'}[text]
 
1924
            conflicts.append(_mod_conflicts.Conflict.factory(ctype,
 
1925
                             path=conflicted,
 
1926
                             file_id=self.path2id(conflicted)))
 
1927
        return conflicts
 
1928
 
 
1929
    def walkdirs(self, prefix=""):
 
1930
        disk_top = self.abspath(prefix)
 
1931
        if disk_top.endswith('/'):
 
1932
            disk_top = disk_top[:-1]
 
1933
        top_strip_len = len(disk_top) + 1
 
1934
        inventory_iterator = self._walkdirs(prefix)
 
1935
        disk_iterator = osutils.walkdirs(disk_top, prefix)
 
1936
        try:
 
1937
            current_disk = disk_iterator.next()
 
1938
            disk_finished = False
 
1939
        except OSError, e:
 
1940
            if e.errno != errno.ENOENT:
 
1941
                raise
 
1942
            current_disk = None
 
1943
            disk_finished = True
 
1944
        try:
 
1945
            current_inv = inventory_iterator.next()
 
1946
            inv_finished = False
 
1947
        except StopIteration:
 
1948
            current_inv = None
 
1949
            inv_finished = True
 
1950
        while not inv_finished or not disk_finished:
 
1951
            if not disk_finished:
 
1952
                # strip out .bzr dirs
 
1953
                if current_disk[0][1][top_strip_len:] == '':
 
1954
                    # osutils.walkdirs can be made nicer - 
 
1955
                    # yield the path-from-prefix rather than the pathjoined
 
1956
                    # value.
 
1957
                    bzrdir_loc = bisect_left(current_disk[1], ('.bzr', '.bzr'))
 
1958
                    if current_disk[1][bzrdir_loc][0] == '.bzr':
 
1959
                        # we dont yield the contents of, or, .bzr itself.
 
1960
                        del current_disk[1][bzrdir_loc]
 
1961
            if inv_finished:
 
1962
                # everything is unknown
 
1963
                direction = 1
 
1964
            elif disk_finished:
 
1965
                # everything is missing
 
1966
                direction = -1
 
1967
            else:
 
1968
                direction = cmp(current_inv[0][0], current_disk[0][0])
 
1969
            if direction > 0:
 
1970
                # disk is before inventory - unknown
 
1971
                dirblock = [(relpath, basename, kind, stat, None, None) for
 
1972
                    relpath, basename, kind, stat, top_path in current_disk[1]]
 
1973
                yield (current_disk[0][0], None), dirblock
 
1974
                try:
 
1975
                    current_disk = disk_iterator.next()
 
1976
                except StopIteration:
 
1977
                    disk_finished = True
 
1978
            elif direction < 0:
 
1979
                # inventory is before disk - missing.
 
1980
                dirblock = [(relpath, basename, 'unknown', None, fileid, kind)
 
1981
                    for relpath, basename, dkind, stat, fileid, kind in 
 
1982
                    current_inv[1]]
 
1983
                yield (current_inv[0][0], current_inv[0][1]), dirblock
 
1984
                try:
 
1985
                    current_inv = inventory_iterator.next()
 
1986
                except StopIteration:
 
1987
                    inv_finished = True
 
1988
            else:
 
1989
                # versioned present directory
 
1990
                # merge the inventory and disk data together
 
1991
                dirblock = []
 
1992
                for relpath, subiterator in itertools.groupby(sorted(
 
1993
                    current_inv[1] + current_disk[1], key=operator.itemgetter(0)), operator.itemgetter(1)):
 
1994
                    path_elements = list(subiterator)
 
1995
                    if len(path_elements) == 2:
 
1996
                        inv_row, disk_row = path_elements
 
1997
                        # versioned, present file
 
1998
                        dirblock.append((inv_row[0],
 
1999
                            inv_row[1], disk_row[2],
 
2000
                            disk_row[3], inv_row[4],
 
2001
                            inv_row[5]))
 
2002
                    elif len(path_elements[0]) == 5:
 
2003
                        # unknown disk file
 
2004
                        dirblock.append((path_elements[0][0],
 
2005
                            path_elements[0][1], path_elements[0][2],
 
2006
                            path_elements[0][3], None, None))
 
2007
                    elif len(path_elements[0]) == 6:
 
2008
                        # versioned, absent file.
 
2009
                        dirblock.append((path_elements[0][0],
 
2010
                            path_elements[0][1], 'unknown', None,
 
2011
                            path_elements[0][4], path_elements[0][5]))
 
2012
                    else:
 
2013
                        raise NotImplementedError('unreachable code')
 
2014
                yield current_inv[0], dirblock
 
2015
                try:
 
2016
                    current_inv = inventory_iterator.next()
 
2017
                except StopIteration:
 
2018
                    inv_finished = True
 
2019
                try:
 
2020
                    current_disk = disk_iterator.next()
 
2021
                except StopIteration:
 
2022
                    disk_finished = True
 
2023
 
 
2024
    def _walkdirs(self, prefix=""):
 
2025
        _directory = 'directory'
 
2026
        # get the root in the inventory
 
2027
        inv = self.inventory
 
2028
        top_id = inv.path2id(prefix)
 
2029
        if top_id is None:
 
2030
            pending = []
 
2031
        else:
 
2032
            pending = [(prefix, '', _directory, None, top_id, None)]
 
2033
        while pending:
 
2034
            dirblock = []
 
2035
            currentdir = pending.pop()
 
2036
            # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-id, 5-kind
 
2037
            top_id = currentdir[4]
 
2038
            if currentdir[0]:
 
2039
                relroot = currentdir[0] + '/'
 
2040
            else:
 
2041
                relroot = ""
 
2042
            # FIXME: stash the node in pending
 
2043
            entry = inv[top_id]
 
2044
            for name, child in entry.sorted_children():
 
2045
                dirblock.append((relroot + name, name, child.kind, None,
 
2046
                    child.file_id, child.kind
 
2047
                    ))
 
2048
            yield (currentdir[0], entry.file_id), dirblock
 
2049
            # push the user specified dirs from dirblock
 
2050
            for dir in reversed(dirblock):
 
2051
                if dir[2] == _directory:
 
2052
                    pending.append(dir)
 
2053
 
 
2054
 
 
2055
class WorkingTree2(WorkingTree):
 
2056
    """This is the Format 2 working tree.
 
2057
 
 
2058
    This was the first weave based working tree. 
 
2059
     - uses os locks for locking.
 
2060
     - uses the branch last-revision.
 
2061
    """
 
2062
 
 
2063
    def lock_tree_write(self):
 
2064
        """See WorkingTree.lock_tree_write().
 
2065
 
 
2066
        In Format2 WorkingTrees we have a single lock for the branch and tree
 
2067
        so lock_tree_write() degrades to lock_write().
 
2068
        """
 
2069
        self.branch.lock_write()
 
2070
        try:
 
2071
            return self._control_files.lock_write()
 
2072
        except:
 
2073
            self.branch.unlock()
 
2074
            raise
 
2075
 
 
2076
    def unlock(self):
 
2077
        # we share control files:
 
2078
        if self._control_files._lock_count == 3:
 
2079
            # _inventory_is_modified is always False during a read lock.
 
2080
            if self._inventory_is_modified:
 
2081
                self.flush()
 
2082
            self._write_hashcache_if_dirty()
 
2083
                    
 
2084
        # reverse order of locking.
 
2085
        try:
 
2086
            return self._control_files.unlock()
 
2087
        finally:
 
2088
            self.branch.unlock()
 
2089
 
 
2090
 
 
2091
class WorkingTree3(WorkingTree):
 
2092
    """This is the Format 3 working tree.
 
2093
 
 
2094
    This differs from the base WorkingTree by:
 
2095
     - having its own file lock
 
2096
     - having its own last-revision property.
 
2097
 
 
2098
    This is new in bzr 0.8
 
2099
    """
 
2100
 
 
2101
    @needs_read_lock
 
2102
    def _last_revision(self):
 
2103
        """See Mutable.last_revision."""
 
2104
        try:
 
2105
            return self._control_files.get_utf8('last-revision').read()
 
2106
        except errors.NoSuchFile:
 
2107
            return None
 
2108
 
 
2109
    def _change_last_revision(self, revision_id):
 
2110
        """See WorkingTree._change_last_revision."""
 
2111
        if revision_id is None or revision_id == NULL_REVISION:
 
2112
            try:
 
2113
                self._control_files._transport.delete('last-revision')
 
2114
            except errors.NoSuchFile:
 
2115
                pass
 
2116
            return False
 
2117
        else:
 
2118
            self._control_files.put_utf8('last-revision', revision_id)
 
2119
            return True
 
2120
 
 
2121
    @needs_tree_write_lock
 
2122
    def set_conflicts(self, conflicts):
 
2123
        self._put_rio('conflicts', conflicts.to_stanzas(), 
 
2124
                      CONFLICT_HEADER_1)
 
2125
 
 
2126
    @needs_tree_write_lock
 
2127
    def add_conflicts(self, new_conflicts):
 
2128
        conflict_set = set(self.conflicts())
 
2129
        conflict_set.update(set(list(new_conflicts)))
 
2130
        self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
 
2131
                                       key=_mod_conflicts.Conflict.sort_key)))
 
2132
 
 
2133
    @needs_read_lock
 
2134
    def conflicts(self):
 
2135
        try:
 
2136
            confile = self._control_files.get('conflicts')
 
2137
        except errors.NoSuchFile:
 
2138
            return _mod_conflicts.ConflictList()
 
2139
        try:
 
2140
            if confile.next() != CONFLICT_HEADER_1 + '\n':
 
2141
                raise errors.ConflictFormatError()
 
2142
        except StopIteration:
 
2143
            raise errors.ConflictFormatError()
 
2144
        return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
 
2145
 
 
2146
    def unlock(self):
 
2147
        if self._control_files._lock_count == 1:
 
2148
            # _inventory_is_modified is always False during a read lock.
 
2149
            if self._inventory_is_modified:
 
2150
                self.flush()
 
2151
            self._write_hashcache_if_dirty()
 
2152
        # reverse order of locking.
 
2153
        try:
 
2154
            return self._control_files.unlock()
 
2155
        finally:
 
2156
            self.branch.unlock()
 
2157
 
 
2158
 
 
2159
def get_conflicted_stem(path):
 
2160
    for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
 
2161
        if path.endswith(suffix):
 
2162
            return path[:-len(suffix)]
 
2163
 
 
2164
@deprecated_function(zero_eight)
 
2165
def is_control_file(filename):
 
2166
    """See WorkingTree.is_control_filename(filename)."""
 
2167
    ## FIXME: better check
 
2168
    filename = normpath(filename)
 
2169
    while filename != '':
 
2170
        head, tail = os.path.split(filename)
 
2171
        ## mutter('check %r for control file' % ((head, tail),))
 
2172
        if tail == '.bzr':
 
2173
            return True
 
2174
        if filename == head:
 
2175
            break
 
2176
        filename = head
 
2177
    return False
 
2178
 
 
2179
 
 
2180
class WorkingTreeFormat(object):
 
2181
    """An encapsulation of the initialization and open routines for a format.
 
2182
 
 
2183
    Formats provide three things:
 
2184
     * An initialization routine,
 
2185
     * a format string,
 
2186
     * an open routine.
 
2187
 
 
2188
    Formats are placed in an dict by their format string for reference 
 
2189
    during workingtree opening. Its not required that these be instances, they
 
2190
    can be classes themselves with class methods - it simply depends on 
 
2191
    whether state is needed for a given format or not.
 
2192
 
 
2193
    Once a format is deprecated, just deprecate the initialize and open
 
2194
    methods on the format class. Do not deprecate the object, as the 
 
2195
    object will be created every time regardless.
 
2196
    """
 
2197
 
 
2198
    _default_format = None
 
2199
    """The default format used for new trees."""
 
2200
 
 
2201
    _formats = {}
 
2202
    """The known formats."""
 
2203
 
 
2204
    @classmethod
 
2205
    def find_format(klass, a_bzrdir):
 
2206
        """Return the format for the working tree object in a_bzrdir."""
 
2207
        try:
 
2208
            transport = a_bzrdir.get_workingtree_transport(None)
 
2209
            format_string = transport.get("format").read()
 
2210
            return klass._formats[format_string]
 
2211
        except errors.NoSuchFile:
 
2212
            raise errors.NoWorkingTree(base=transport.base)
 
2213
        except KeyError:
 
2214
            raise errors.UnknownFormatError(format=format_string)
 
2215
 
 
2216
    @classmethod
 
2217
    def get_default_format(klass):
 
2218
        """Return the current default format."""
 
2219
        return klass._default_format
 
2220
 
 
2221
    def get_format_string(self):
 
2222
        """Return the ASCII format string that identifies this format."""
 
2223
        raise NotImplementedError(self.get_format_string)
 
2224
 
 
2225
    def get_format_description(self):
 
2226
        """Return the short description for this format."""
 
2227
        raise NotImplementedError(self.get_format_description)
 
2228
 
 
2229
    def is_supported(self):
 
2230
        """Is this format supported?
 
2231
 
 
2232
        Supported formats can be initialized and opened.
 
2233
        Unsupported formats may not support initialization or committing or 
 
2234
        some other features depending on the reason for not being supported.
 
2235
        """
 
2236
        return True
 
2237
 
 
2238
    @classmethod
 
2239
    def register_format(klass, format):
 
2240
        klass._formats[format.get_format_string()] = format
 
2241
 
 
2242
    @classmethod
 
2243
    def set_default_format(klass, format):
 
2244
        klass._default_format = format
 
2245
 
 
2246
    @classmethod
 
2247
    def unregister_format(klass, format):
 
2248
        assert klass._formats[format.get_format_string()] is format
 
2249
        del klass._formats[format.get_format_string()]
 
2250
 
 
2251
 
 
2252
 
 
2253
class WorkingTreeFormat2(WorkingTreeFormat):
 
2254
    """The second working tree format. 
 
2255
 
 
2256
    This format modified the hash cache from the format 1 hash cache.
 
2257
    """
 
2258
 
 
2259
    def get_format_description(self):
 
2260
        """See WorkingTreeFormat.get_format_description()."""
 
2261
        return "Working tree format 2"
 
2262
 
 
2263
    def stub_initialize_remote(self, control_files):
 
2264
        """As a special workaround create critical control files for a remote working tree
 
2265
        
 
2266
        This ensures that it can later be updated and dealt with locally,
 
2267
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with 
 
2268
        no working tree.  (See bug #43064).
 
2269
        """
 
2270
        sio = StringIO()
 
2271
        inv = Inventory()
 
2272
        xml5.serializer_v5.write_inventory(inv, sio)
 
2273
        sio.seek(0)
 
2274
        control_files.put('inventory', sio)
 
2275
 
 
2276
        control_files.put_utf8('pending-merges', '')
 
2277
        
 
2278
 
 
2279
    def initialize(self, a_bzrdir, revision_id=None):
 
2280
        """See WorkingTreeFormat.initialize()."""
 
2281
        if not isinstance(a_bzrdir.transport, LocalTransport):
 
2282
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
 
2283
        branch = a_bzrdir.open_branch()
 
2284
        if revision_id is not None:
 
2285
            branch.lock_write()
 
2286
            try:
 
2287
                revision_history = branch.revision_history()
 
2288
                try:
 
2289
                    position = revision_history.index(revision_id)
 
2290
                except ValueError:
 
2291
                    raise errors.NoSuchRevision(branch, revision_id)
 
2292
                branch.set_revision_history(revision_history[:position + 1])
 
2293
            finally:
 
2294
                branch.unlock()
 
2295
        revision = branch.last_revision()
 
2296
        inv = Inventory()
 
2297
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
 
2298
                         branch,
 
2299
                         inv,
 
2300
                         _internal=True,
 
2301
                         _format=self,
 
2302
                         _bzrdir=a_bzrdir)
 
2303
        basis_tree = branch.repository.revision_tree(revision)
 
2304
        if basis_tree.inventory.root is not None:
 
2305
            wt.set_root_id(basis_tree.inventory.root.file_id)
 
2306
        # set the parent list and cache the basis tree.
 
2307
        wt.set_parent_trees([(revision, basis_tree)])
 
2308
        transform.build_tree(basis_tree, wt)
 
2309
        return wt
 
2310
 
 
2311
    def __init__(self):
 
2312
        super(WorkingTreeFormat2, self).__init__()
 
2313
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
 
2314
 
 
2315
    def open(self, a_bzrdir, _found=False):
 
2316
        """Return the WorkingTree object for a_bzrdir
 
2317
 
 
2318
        _found is a private parameter, do not use it. It is used to indicate
 
2319
               if format probing has already been done.
 
2320
        """
 
2321
        if not _found:
 
2322
            # we are being called directly and must probe.
 
2323
            raise NotImplementedError
 
2324
        if not isinstance(a_bzrdir.transport, LocalTransport):
 
2325
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
 
2326
        return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
 
2327
                           _internal=True,
 
2328
                           _format=self,
 
2329
                           _bzrdir=a_bzrdir)
 
2330
 
 
2331
 
 
2332
class WorkingTreeFormat3(WorkingTreeFormat):
 
2333
    """The second working tree format updated to record a format marker.
 
2334
 
 
2335
    This format:
 
2336
        - exists within a metadir controlling .bzr
 
2337
        - includes an explicit version marker for the workingtree control
 
2338
          files, separate from the BzrDir format
 
2339
        - modifies the hash cache format
 
2340
        - is new in bzr 0.8
 
2341
        - uses a LockDir to guard access for writes.
 
2342
    """
 
2343
 
 
2344
    def get_format_string(self):
 
2345
        """See WorkingTreeFormat.get_format_string()."""
 
2346
        return "Bazaar-NG Working Tree format 3"
 
2347
 
 
2348
    def get_format_description(self):
 
2349
        """See WorkingTreeFormat.get_format_description()."""
 
2350
        return "Working tree format 3"
 
2351
 
 
2352
    _lock_file_name = 'lock'
 
2353
    _lock_class = LockDir
 
2354
 
 
2355
    def _open_control_files(self, a_bzrdir):
 
2356
        transport = a_bzrdir.get_workingtree_transport(None)
 
2357
        return LockableFiles(transport, self._lock_file_name, 
 
2358
                             self._lock_class)
 
2359
 
 
2360
    def initialize(self, a_bzrdir, revision_id=None):
 
2361
        """See WorkingTreeFormat.initialize().
 
2362
        
 
2363
        revision_id allows creating a working tree at a different
 
2364
        revision than the branch is at.
 
2365
        """
 
2366
        if not isinstance(a_bzrdir.transport, LocalTransport):
 
2367
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
 
2368
        transport = a_bzrdir.get_workingtree_transport(self)
 
2369
        control_files = self._open_control_files(a_bzrdir)
 
2370
        control_files.create_lock()
 
2371
        control_files.lock_write()
 
2372
        control_files.put_utf8('format', self.get_format_string())
 
2373
        branch = a_bzrdir.open_branch()
 
2374
        if revision_id is None:
 
2375
            revision_id = branch.last_revision()
 
2376
        # WorkingTree3 can handle an inventory which has a unique root id.
 
2377
        # as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
 
2378
        # those trees. And because there isn't a format bump inbetween, we
 
2379
        # are maintaining compatibility with older clients.
 
2380
        # inv = Inventory(root_id=gen_root_id())
 
2381
        inv = Inventory()
 
2382
        wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
 
2383
                         branch,
 
2384
                         inv,
 
2385
                         _internal=True,
 
2386
                         _format=self,
 
2387
                         _bzrdir=a_bzrdir,
 
2388
                         _control_files=control_files)
 
2389
        wt.lock_tree_write()
 
2390
        try:
 
2391
            basis_tree = branch.repository.revision_tree(revision_id)
 
2392
            # only set an explicit root id if there is one to set.
 
2393
            if basis_tree.inventory.root is not None:
 
2394
                wt.set_root_id(basis_tree.inventory.root.file_id)
 
2395
            if revision_id == NULL_REVISION:
 
2396
                wt.set_parent_trees([])
 
2397
            else:
 
2398
                wt.set_parent_trees([(revision_id, basis_tree)])
 
2399
            transform.build_tree(basis_tree, wt)
 
2400
        finally:
 
2401
            # Unlock in this order so that the unlock-triggers-flush in
 
2402
            # WorkingTree is given a chance to fire.
 
2403
            control_files.unlock()
 
2404
            wt.unlock()
 
2405
        return wt
 
2406
 
 
2407
    def __init__(self):
 
2408
        super(WorkingTreeFormat3, self).__init__()
 
2409
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
 
2410
 
 
2411
    def open(self, a_bzrdir, _found=False):
 
2412
        """Return the WorkingTree object for a_bzrdir
 
2413
 
 
2414
        _found is a private parameter, do not use it. It is used to indicate
 
2415
               if format probing has already been done.
 
2416
        """
 
2417
        if not _found:
 
2418
            # we are being called directly and must probe.
 
2419
            raise NotImplementedError
 
2420
        if not isinstance(a_bzrdir.transport, LocalTransport):
 
2421
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
 
2422
        return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
 
2423
 
 
2424
    def _open(self, a_bzrdir, control_files):
 
2425
        """Open the tree itself.
 
2426
        
 
2427
        :param a_bzrdir: the dir for the tree.
 
2428
        :param control_files: the control files for the tree.
 
2429
        """
 
2430
        return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
 
2431
                           _internal=True,
 
2432
                           _format=self,
 
2433
                           _bzrdir=a_bzrdir,
 
2434
                           _control_files=control_files)
 
2435
 
 
2436
    def __str__(self):
 
2437
        return self.get_format_string()
 
2438
 
 
2439
 
 
2440
# formats which have no format string are not discoverable
 
2441
# and not independently creatable, so are not registered.
 
2442
__default_format = WorkingTreeFormat3()
 
2443
WorkingTreeFormat.register_format(__default_format)
 
2444
WorkingTreeFormat.set_default_format(__default_format)
 
2445
_legacy_formats = [WorkingTreeFormat2(),
 
2446
                   ]
 
2447
 
 
2448
 
 
2449
class WorkingTreeTestProviderAdapter(object):
 
2450
    """A tool to generate a suite testing multiple workingtree formats at once.
 
2451
 
 
2452
    This is done by copying the test once for each transport and injecting
 
2453
    the transport_server, transport_readonly_server, and workingtree_format
 
2454
    classes into each copy. Each copy is also given a new id() to make it
 
2455
    easy to identify.
 
2456
    """
 
2457
 
 
2458
    def __init__(self, transport_server, transport_readonly_server, formats):
 
2459
        self._transport_server = transport_server
 
2460
        self._transport_readonly_server = transport_readonly_server
 
2461
        self._formats = formats
 
2462
    
 
2463
    def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
 
2464
        """Clone test for adaption."""
 
2465
        new_test = deepcopy(test)
 
2466
        new_test.transport_server = self._transport_server
 
2467
        new_test.transport_readonly_server = self._transport_readonly_server
 
2468
        new_test.bzrdir_format = bzrdir_format
 
2469
        new_test.workingtree_format = workingtree_format
 
2470
        def make_new_test_id():
 
2471
            new_id = "%s(%s)" % (test.id(), variation)
 
2472
            return lambda: new_id
 
2473
        new_test.id = make_new_test_id()
 
2474
        return new_test
 
2475
    
 
2476
    def adapt(self, test):
 
2477
        from bzrlib.tests import TestSuite
 
2478
        result = TestSuite()
 
2479
        for workingtree_format, bzrdir_format in self._formats:
 
2480
            new_test = self._clone_test(
 
2481
                test,
 
2482
                bzrdir_format,
 
2483
                workingtree_format, workingtree_format.__class__.__name__)
 
2484
            result.addTest(new_test)
 
2485
        return result