/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-07-03 07:35:46 UTC
  • mfrom: (2574.1.1 ianc-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20070703073546-9dv8bocak8u3ou6m
(Vincent Ladeuil) Fix #115209 - Unable to handle http code 400: Bad Request When issuing too many ranges

Show diffs side-by-side

added added

removed removed

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