/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: Alexander Belchenko
  • Date: 2007-01-30 10:51:38 UTC
  • mto: This revision was merged to the branch mainline in revision 2259.
  • Revision ID: bialix@ukr.net-20070130105138-280dj0ayzeh886rb
trace.py: open_tracefile(): win98-compatible detection of location for .bzr.log

It's also change default location of .bzr.log on Windows 2000/XP as well:
now it in user's My Documents folder, so it's much better 
for users without administarator priveleges.

Also workaround win32-specific issue with file.tell().

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
# Copyright (C) 2005, 2006 Canonical Ltd
2
 
 
 
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
 
 
39
from cStringIO import StringIO
 
40
import os
 
41
 
 
42
from bzrlib.lazy_import import lazy_import
 
43
lazy_import(globals(), """
 
44
import collections
42
45
from copy import deepcopy
43
 
from cStringIO import StringIO
44
46
import errno
45
 
import fnmatch
46
 
import os
47
47
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
 
48
from time import time
 
49
import warnings
 
50
 
 
51
import bzrlib
 
52
from bzrlib import (
 
53
    bzrdir,
 
54
    conflicts as _mod_conflicts,
 
55
    errors,
 
56
    generate_ids,
 
57
    globbing,
 
58
    hashcache,
 
59
    ignores,
 
60
    merge,
 
61
    osutils,
 
62
    textui,
 
63
    transform,
 
64
    urlutils,
 
65
    xml5,
 
66
    xml6,
 
67
    )
 
68
import bzrlib.branch
 
69
from bzrlib.transport import get_transport
 
70
import bzrlib.ui
 
71
""")
 
72
 
 
73
from bzrlib import symbol_versioning
55
74
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
 
75
from bzrlib.inventory import InventoryEntry, Inventory, ROOT_ID
69
76
from bzrlib.lockable_files import LockableFiles, TransportLock
70
77
from bzrlib.lockdir import LockDir
71
 
from bzrlib.merge import merge_inner, transform_tree
 
78
import bzrlib.mutabletree
 
79
from bzrlib.mutabletree import needs_tree_write_lock
72
80
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
 
                            )
 
81
    compact_date,
 
82
    file_kind,
 
83
    isdir,
 
84
    normpath,
 
85
    pathjoin,
 
86
    rand_chars,
 
87
    realpath,
 
88
    safe_unicode,
 
89
    splitpath,
 
90
    supports_executable,
 
91
    )
 
92
from bzrlib.trace import mutter, note
 
93
from bzrlib.transport.local import LocalTransport
 
94
import bzrlib.tree
90
95
from bzrlib.progress import DummyProgress, ProgressPhase
91
 
from bzrlib.revision import NULL_REVISION
 
96
from bzrlib.revision import NULL_REVISION, CURRENT_REVISION
 
97
import bzrlib.revisiontree
92
98
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
 
 
 
99
from bzrlib.symbol_versioning import (deprecated_passed,
 
100
        deprecated_method,
 
101
        deprecated_function,
 
102
        DEPRECATED_PARAMETER,
 
103
        zero_eight,
 
104
        zero_eleven,
 
105
        zero_thirteen,
 
106
        )
 
107
 
 
108
 
 
109
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
 
110
CONFLICT_HEADER_1 = "BZR conflict list format 1"
 
111
 
 
112
 
 
113
@deprecated_function(zero_thirteen)
104
114
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
 
 
 
115
    """Return new file id for the basename 'name'.
 
116
 
 
117
    Use bzrlib.generate_ids.gen_file_id() instead
 
118
    """
 
119
    return generate_ids.gen_file_id(name)
 
120
 
 
121
 
 
122
@deprecated_function(zero_thirteen)
133
123
def gen_root_id():
134
 
    """Return a new tree-root file id."""
135
 
    return gen_file_id('TREE_ROOT')
 
124
    """Return a new tree-root file id.
 
125
 
 
126
    This has been deprecated in favor of bzrlib.generate_ids.gen_root_id()
 
127
    """
 
128
    return generate_ids.gen_root_id()
136
129
 
137
130
 
138
131
class TreeEntry(object):
139
 
    """An entry that implements the minium interface used by commands.
 
132
    """An entry that implements the minimum interface used by commands.
140
133
 
141
134
    This needs further inspection, it may be better to have 
142
135
    InventoryEntries without ids - though that seems wrong. For now,
190
183
        return ''
191
184
 
192
185
 
193
 
class WorkingTree(bzrlib.tree.Tree):
 
186
class WorkingTree(bzrlib.mutabletree.MutableTree):
194
187
    """Working copy tree.
195
188
 
196
189
    The inventory is held in the `Branch` working-inventory, and the
218
211
        self.bzrdir = _bzrdir
219
212
        if not _internal:
220
213
            # not created via open etc.
221
 
            warn("WorkingTree() is deprecated as of bzr version 0.8. "
 
214
            warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
222
215
                 "Please use bzrdir.open_workingtree or WorkingTree.open().",
223
216
                 DeprecationWarning,
224
217
                 stacklevel=2)
225
218
            wt = WorkingTree.open(basedir)
226
 
            self.branch = wt.branch
 
219
            self._branch = wt.branch
227
220
            self.basedir = wt.basedir
228
221
            self._control_files = wt._control_files
229
222
            self._hashcache = wt._hashcache
230
 
            self._set_inventory(wt._inventory)
 
223
            self._set_inventory(wt._inventory, dirty=False)
231
224
            self._format = wt._format
232
225
            self.bzrdir = wt.bzrdir
233
 
        from bzrlib.hashcache import HashCache
234
 
        from bzrlib.trace import note, mutter
235
226
        assert isinstance(basedir, basestring), \
236
227
            "base directory %r is not a string" % basedir
237
228
        basedir = safe_unicode(basedir)
238
229
        mutter("opening working tree %r", basedir)
239
230
        if deprecated_passed(branch):
240
231
            if not _internal:
241
 
                warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
242
 
                     " Please use bzrdir.open_workingtree() or"
 
232
                warnings.warn("WorkingTree(..., branch=XXX) is deprecated"
 
233
                     " as of bzr 0.8. Please use bzrdir.open_workingtree() or"
243
234
                     " WorkingTree.open().",
244
235
                     DeprecationWarning,
245
236
                     stacklevel=2
246
237
                     )
247
 
            self.branch = branch
 
238
            self._branch = branch
248
239
        else:
249
 
            self.branch = self.bzrdir.open_branch()
250
 
        assert isinstance(self.branch, Branch), \
251
 
            "branch %r is not a Branch" % self.branch
 
240
            self._branch = self.bzrdir.open_branch()
252
241
        self.basedir = realpath(basedir)
253
242
        # if branch is at our basedir and is a format 6 or less
254
243
        if isinstance(self._format, WorkingTreeFormat2):
255
244
            # share control object
256
245
            self._control_files = self.branch.control_files
257
246
        else:
258
 
            # only ready for format 3
259
 
            assert isinstance(self._format, WorkingTreeFormat3)
 
247
            # assume all other formats have their own control files.
260
248
            assert isinstance(_control_files, LockableFiles), \
261
249
                    "_control_files must be a LockableFiles, not %r" \
262
250
                    % _control_files
267
255
        # if needed, or, when the cache sees a change, append it to the hash
268
256
        # cache file, and have the parser take the most recent entry for a
269
257
        # 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)
 
258
        wt_trans = self.bzrdir.get_workingtree_transport(None)
 
259
        cache_filename = wt_trans.local_abspath('stat-cache')
 
260
        self._hashcache = hashcache.HashCache(basedir, cache_filename,
 
261
                                              self._control_files._file_mode)
 
262
        hc = self._hashcache
272
263
        hc.read()
273
264
        # is this scan needed ? it makes things kinda slow.
274
 
        hc.scan()
 
265
        #hc.scan()
275
266
 
276
267
        if hc.needs_write:
277
268
            mutter("write hc")
278
269
            hc.write()
279
270
 
280
271
        if _inventory is None:
281
 
            self._set_inventory(self.read_working_inventory())
 
272
            self._inventory_is_modified = False
 
273
            self.read_working_inventory()
282
274
        else:
283
 
            self._set_inventory(_inventory)
284
 
 
285
 
    def _set_inventory(self, inv):
 
275
            # the caller of __init__ has provided an inventory,
 
276
            # we assume they know what they are doing - as its only
 
277
            # the Format factory and creation methods that are
 
278
            # permitted to do this.
 
279
            self._set_inventory(_inventory, dirty=False)
 
280
 
 
281
    branch = property(
 
282
        fget=lambda self: self._branch,
 
283
        doc="""The branch this WorkingTree is connected to.
 
284
 
 
285
            This cannot be set - it is reflective of the actual disk structure
 
286
            the working tree has been constructed from.
 
287
            """)
 
288
 
 
289
    def break_lock(self):
 
290
        """Break a lock if one is present from another instance.
 
291
 
 
292
        Uses the ui factory to ask for confirmation if the lock may be from
 
293
        an active process.
 
294
 
 
295
        This will probe the repository for its lock as well.
 
296
        """
 
297
        self._control_files.break_lock()
 
298
        self.branch.break_lock()
 
299
 
 
300
    def _set_inventory(self, inv, dirty):
 
301
        """Set the internal cached inventory.
 
302
 
 
303
        :param inv: The inventory to set.
 
304
        :param dirty: A boolean indicating whether the inventory is the same
 
305
            logical inventory as whats on disk. If True the inventory is not
 
306
            the same and should be written to disk or data will be lost, if
 
307
            False then the inventory is the same as that on disk and any
 
308
            serialisation would be unneeded overhead.
 
309
        """
 
310
        assert inv.root is not None
286
311
        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
 
312
        self._inventory_is_modified = dirty
301
313
 
302
314
    @staticmethod
303
315
    def open(path=None, _unsupported=False):
319
331
        run into /.  If there isn't one, raises NotBranchError.
320
332
        TODO: give this a new exception.
321
333
        If there is one, it is returned, along with the unused portion of path.
 
334
 
 
335
        :return: The WorkingTree that contains 'path', and the rest of path
322
336
        """
323
337
        if path is None:
324
 
            path = os.getcwdu()
 
338
            path = osutils.getcwd()
325
339
        control, relpath = bzrdir.BzrDir.open_containing(path)
 
340
 
326
341
        return control.open_workingtree(), relpath
327
342
 
328
343
    @staticmethod
341
356
        """
342
357
        inv = self._inventory
343
358
        for path, ie in inv.iter_entries():
344
 
            if bzrlib.osutils.lexists(self.abspath(path)):
 
359
            if osutils.lexists(self.abspath(path)):
345
360
                yield ie.file_id
346
361
 
347
362
    def __repr__(self):
352
367
        return pathjoin(self.basedir, filename)
353
368
    
354
369
    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:
 
370
        """Return RevisionTree for the current last revision.
 
371
        
 
372
        If the left most parent is a ghost then the returned tree will be an
 
373
        empty tree - one obtained by calling repository.revision_tree(None).
 
374
        """
 
375
        try:
 
376
            revision_id = self.get_parent_ids()[0]
 
377
        except IndexError:
 
378
            # no parents, return an empty revision tree.
 
379
            # in the future this should return the tree for
 
380
            # 'empty:' - the implicit root empty tree.
 
381
            return self.branch.repository.revision_tree(None)
 
382
        else:
358
383
            try:
359
384
                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)
 
385
                inv = xml6.serializer_v6.read_inventory_from_string(xml)
 
386
                if inv is not None and inv.revision_id == revision_id:
 
387
                    return bzrlib.revisiontree.RevisionTree(
 
388
                        self.branch.repository, inv, revision_id)
 
389
            except (errors.NoSuchFile, errors.BadInventoryFormat):
 
390
                pass
 
391
        # No cached copy available, retrieve from the repository.
 
392
        # FIXME? RBC 20060403 should we cache the inventory locally
 
393
        # at this point ?
 
394
        try:
 
395
            return self.branch.repository.revision_tree(revision_id)
 
396
        except errors.RevisionNotPresent:
 
397
            # the basis tree *may* be a ghost or a low level error may have
 
398
            # occured. If the revision is present, its a problem, if its not
 
399
            # its a ghost.
 
400
            if self.branch.repository.has_revision(revision_id):
 
401
                raise
 
402
            # the basis tree is a ghost so return an empty tree.
 
403
            return self.branch.repository.revision_tree(None)
368
404
 
369
405
    @staticmethod
370
406
    @deprecated_method(zero_eight)
383
419
        XXX: When BzrDir is present, these should be created through that 
384
420
        interface instead.
385
421
        """
386
 
        warn('delete WorkingTree.create', stacklevel=3)
 
422
        warnings.warn('delete WorkingTree.create', stacklevel=3)
387
423
        transport = get_transport(directory)
388
424
        if branch.bzrdir.root_transport.base == transport.base:
389
425
            # same dir 
404
440
        """
405
441
        return bzrdir.BzrDir.create_standalone_workingtree(directory)
406
442
 
407
 
    def relpath(self, abs):
408
 
        """Return the local path portion from a given absolute path."""
409
 
        return relpath(self.basedir, abs)
 
443
    def relpath(self, path):
 
444
        """Return the local path portion from a given path.
 
445
        
 
446
        The path may be absolute or relative. If its a relative path it is 
 
447
        interpreted relative to the python current working directory.
 
448
        """
 
449
        return osutils.relpath(self.basedir, path)
410
450
 
411
451
    def has_filename(self, filename):
412
 
        return bzrlib.osutils.lexists(self.abspath(filename))
 
452
        return osutils.lexists(self.abspath(filename))
413
453
 
414
454
    def get_file(self, file_id):
415
455
        return self.get_file_byname(self.id2path(file_id))
416
456
 
 
457
    def get_file_text(self, file_id):
 
458
        return self.get_file(file_id).read()
 
459
 
417
460
    def get_file_byname(self, filename):
418
461
        return file(self.abspath(filename), 'rb')
419
462
 
 
463
    def annotate_iter(self, file_id):
 
464
        """See Tree.annotate_iter
 
465
 
 
466
        This implementation will use the basis tree implementation if possible.
 
467
        Lines not in the basis are attributed to CURRENT_REVISION
 
468
 
 
469
        If there are pending merges, lines added by those merges will be
 
470
        incorrectly attributed to CURRENT_REVISION (but after committing, the
 
471
        attribution will be correct).
 
472
        """
 
473
        basis = self.basis_tree()
 
474
        changes = self._iter_changes(basis, True, [file_id]).next()
 
475
        changed_content, kind = changes[2], changes[6]
 
476
        if not changed_content:
 
477
            return basis.annotate_iter(file_id)
 
478
        if kind[1] is None:
 
479
            return None
 
480
        import annotate
 
481
        if kind[0] != 'file':
 
482
            old_lines = []
 
483
        else:
 
484
            old_lines = list(basis.annotate_iter(file_id))
 
485
        old = [old_lines]
 
486
        for tree in self.branch.repository.revision_trees(
 
487
            self.get_parent_ids()[1:]):
 
488
            if file_id not in tree:
 
489
                continue
 
490
            old.append(list(tree.annotate_iter(file_id)))
 
491
        return annotate.reannotate(old, self.get_file(file_id).readlines(),
 
492
                                   CURRENT_REVISION)
 
493
 
 
494
    def get_parent_ids(self):
 
495
        """See Tree.get_parent_ids.
 
496
        
 
497
        This implementation reads the pending merges list and last_revision
 
498
        value and uses that to decide what the parents list should be.
 
499
        """
 
500
        last_rev = self._last_revision()
 
501
        if last_rev is None:
 
502
            parents = []
 
503
        else:
 
504
            parents = [last_rev]
 
505
        try:
 
506
            merges_file = self._control_files.get_utf8('pending-merges')
 
507
        except errors.NoSuchFile:
 
508
            pass
 
509
        else:
 
510
            for l in merges_file.readlines():
 
511
                parents.append(l.rstrip('\n'))
 
512
        return parents
 
513
 
 
514
    @needs_read_lock
420
515
    def get_root_id(self):
421
516
        """Return the id of this trees root"""
422
 
        inv = self.read_working_inventory()
423
 
        return inv.root.file_id
 
517
        return self._inventory.root.file_id
424
518
        
425
519
    def _get_store_filename(self, file_id):
426
520
        ## XXX: badly named; this is not in the store at all
452
546
    @needs_read_lock
453
547
    def copy_content_into(self, tree, revision_id=None):
454
548
        """Copy the current content and user files of this tree into tree."""
 
549
        tree.set_root_id(self.get_root_id())
455
550
        if revision_id is None:
456
 
            transform_tree(tree, self)
 
551
            merge.transform_tree(tree, self)
457
552
        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())
 
553
            # TODO now merge from tree.last_revision to revision (to preserve
 
554
            # user local changes)
 
555
            merge.transform_tree(tree, self)
 
556
            tree.set_parent_ids([revision_id])
476
557
 
477
558
    def id2abspath(self, file_id):
478
559
        return self.abspath(self.id2path(file_id))
483
564
        if not inv.has_id(file_id):
484
565
            return False
485
566
        path = inv.id2path(file_id)
486
 
        return bzrlib.osutils.lexists(self.abspath(path))
 
567
        return osutils.lexists(self.abspath(path))
487
568
 
488
569
    def has_or_had_id(self, file_id):
489
570
        if file_id == self.inventory.root.file_id:
496
577
        return os.path.getsize(self.id2abspath(file_id))
497
578
 
498
579
    @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():
 
580
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
581
        if not path:
 
582
            path = self._inventory.id2path(file_id)
 
583
        return self._hashcache.get_sha1(path, stat_value)
 
584
 
 
585
    def get_file_mtime(self, file_id, path=None):
 
586
        if not path:
 
587
            path = self._inventory.id2path(file_id)
 
588
        return os.lstat(self.abspath(path)).st_mtime
 
589
 
 
590
    if not supports_executable():
 
591
        def is_executable(self, file_id, path=None):
505
592
            return self._inventory[file_id].executable
506
 
        else:
507
 
            path = self._inventory.id2path(file_id)
 
593
    else:
 
594
        def is_executable(self, file_id, path=None):
 
595
            if not path:
 
596
                path = self._inventory.id2path(file_id)
508
597
            mode = os.lstat(self.abspath(path)).st_mode
509
 
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
 
598
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
510
599
 
511
600
    @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
 
        """
 
601
    def _add(self, files, ids, kinds):
 
602
        """See MutableTree._add."""
534
603
        # TODO: Re-adding a file that is removed in the working copy
535
604
        # 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
 
 
 
605
        # the read and write working inventory should not occur in this 
 
606
        # function - they should be part of lock_write and unlock.
547
607
        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
 
 
 
608
        for f, file_id, kind in zip(files, ids, kinds):
 
609
            assert kind is not None
571
610
            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))
 
611
                inv.add_path(f, kind=kind)
 
612
            else:
 
613
                inv.add_path(f, kind=kind, file_id=file_id)
576
614
        self._write_inventory(inv)
577
615
 
 
616
    @needs_tree_write_lock
 
617
    def _gather_kinds(self, files, kinds):
 
618
        """See MutableTree._gather_kinds."""
 
619
        for pos, f in enumerate(files):
 
620
            if kinds[pos] is None:
 
621
                fullpath = normpath(self.abspath(f))
 
622
                try:
 
623
                    kinds[pos] = file_kind(fullpath)
 
624
                except OSError, e:
 
625
                    if e.errno == errno.ENOENT:
 
626
                        raise errors.NoSuchFile(fullpath)
 
627
 
578
628
    @needs_write_lock
 
629
    def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
 
630
        """Add revision_id as a parent.
 
631
 
 
632
        This is equivalent to retrieving the current list of parent ids
 
633
        and setting the list to its value plus revision_id.
 
634
 
 
635
        :param revision_id: The revision id to add to the parent list. It may
 
636
        be a ghost revision as long as its not the first parent to be added,
 
637
        or the allow_leftmost_as_ghost parameter is set True.
 
638
        :param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
 
639
        """
 
640
        parents = self.get_parent_ids() + [revision_id]
 
641
        self.set_parent_ids(parents, allow_leftmost_as_ghost=len(parents) > 1
 
642
            or allow_leftmost_as_ghost)
 
643
 
 
644
    @needs_tree_write_lock
 
645
    def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
 
646
        """Add revision_id, tree tuple as a parent.
 
647
 
 
648
        This is equivalent to retrieving the current list of parent trees
 
649
        and setting the list to its value plus parent_tuple. See also
 
650
        add_parent_tree_id - if you only have a parent id available it will be
 
651
        simpler to use that api. If you have the parent already available, using
 
652
        this api is preferred.
 
653
 
 
654
        :param parent_tuple: The (revision id, tree) to add to the parent list.
 
655
            If the revision_id is a ghost, pass None for the tree.
 
656
        :param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
 
657
        """
 
658
        parent_ids = self.get_parent_ids() + [parent_tuple[0]]
 
659
        if len(parent_ids) > 1:
 
660
            # the leftmost may have already been a ghost, preserve that if it
 
661
            # was.
 
662
            allow_leftmost_as_ghost = True
 
663
        self.set_parent_ids(parent_ids,
 
664
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
665
 
 
666
    @needs_tree_write_lock
579
667
    def add_pending_merge(self, *revision_ids):
580
668
        # TODO: Perhaps should check at this point that the
581
669
        # history of the revision is actually present?
582
 
        p = self.pending_merges()
 
670
        parents = self.get_parent_ids()
583
671
        updated = False
584
672
        for rev_id in revision_ids:
585
 
            if rev_id in p:
 
673
            if rev_id in parents:
586
674
                continue
587
 
            p.append(rev_id)
 
675
            parents.append(rev_id)
588
676
            updated = True
589
677
        if updated:
590
 
            self.set_pending_merges(p)
 
678
            self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
591
679
 
 
680
    @deprecated_method(zero_eleven)
592
681
    @needs_read_lock
593
682
    def pending_merges(self):
594
683
        """Return a list of pending merges.
595
684
 
596
685
        These are revisions that have been merged into the working
597
686
        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
 
687
 
 
688
        As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
 
689
        instead - which is available on all tree objects.
 
690
        """
 
691
        return self.get_parent_ids()[1:]
 
692
 
 
693
    def _check_parents_for_ghosts(self, revision_ids, allow_leftmost_as_ghost):
 
694
        """Common ghost checking functionality from set_parent_*.
 
695
 
 
696
        This checks that the left hand-parent exists if there are any
 
697
        revisions present.
 
698
        """
 
699
        if len(revision_ids) > 0:
 
700
            leftmost_id = revision_ids[0]
 
701
            if (not allow_leftmost_as_ghost and not
 
702
                self.branch.repository.has_revision(leftmost_id)):
 
703
                raise errors.GhostRevisionUnusableHere(leftmost_id)
 
704
 
 
705
    def _set_merges_from_parent_ids(self, parent_ids):
 
706
        merges = parent_ids[1:]
 
707
        self._control_files.put_utf8('pending-merges', '\n'.join(merges))
 
708
 
 
709
    @needs_tree_write_lock
 
710
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
 
711
        """Set the parent ids to revision_ids.
 
712
        
 
713
        See also set_parent_trees. This api will try to retrieve the tree data
 
714
        for each element of revision_ids from the trees repository. If you have
 
715
        tree data already available, it is more efficient to use
 
716
        set_parent_trees rather than set_parent_ids. set_parent_ids is however
 
717
        an easier API to use.
 
718
 
 
719
        :param revision_ids: The revision_ids to set as the parent ids of this
 
720
            working tree. Any of these may be ghosts.
 
721
        """
 
722
        self._check_parents_for_ghosts(revision_ids,
 
723
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
724
 
 
725
        if len(revision_ids) > 0:
 
726
            self.set_last_revision(revision_ids[0])
 
727
        else:
 
728
            self.set_last_revision(None)
 
729
 
 
730
        self._set_merges_from_parent_ids(revision_ids)
 
731
 
 
732
    @needs_tree_write_lock
 
733
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
 
734
        """See MutableTree.set_parent_trees."""
 
735
        parent_ids = [rev for (rev, tree) in parents_list]
 
736
 
 
737
        self._check_parents_for_ghosts(parent_ids,
 
738
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
 
739
 
 
740
        if len(parent_ids) == 0:
 
741
            leftmost_parent_id = None
 
742
            leftmost_parent_tree = None
 
743
        else:
 
744
            leftmost_parent_id, leftmost_parent_tree = parents_list[0]
 
745
 
 
746
        if self._change_last_revision(leftmost_parent_id):
 
747
            if leftmost_parent_tree is None:
 
748
                # If we don't have a tree, fall back to reading the
 
749
                # parent tree from the repository.
 
750
                self._cache_basis_inventory(leftmost_parent_id)
 
751
            else:
 
752
                inv = leftmost_parent_tree.inventory
 
753
                xml = self._create_basis_xml_from_inventory(
 
754
                                        leftmost_parent_id, inv)
 
755
                self._write_basis_inventory(xml)
 
756
        self._set_merges_from_parent_ids(parent_ids)
 
757
 
 
758
    @needs_tree_write_lock
611
759
    def set_pending_merges(self, rev_list):
612
 
        self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
 
760
        parents = self.get_parent_ids()
 
761
        leftmost = parents[:1]
 
762
        new_parents = leftmost + rev_list
 
763
        self.set_parent_ids(new_parents)
613
764
 
614
 
    @needs_write_lock
 
765
    @needs_tree_write_lock
615
766
    def set_merge_modified(self, modified_hashes):
616
767
        def iter_stanzas():
617
768
            for file_id, hash in modified_hashes.iteritems():
618
769
                yield Stanza(file_id=file_id, hash=hash)
619
770
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
620
771
 
621
 
    @needs_write_lock
 
772
    @needs_tree_write_lock
622
773
    def _put_rio(self, filename, stanzas, header):
623
774
        my_file = rio_file(stanzas, header)
624
775
        self._control_files.put(filename, my_file)
625
776
 
 
777
    @needs_write_lock # because merge pulls data into the branch.
 
778
    def merge_from_branch(self, branch, to_revision=None):
 
779
        """Merge from a branch into this working tree.
 
780
 
 
781
        :param branch: The branch to merge from.
 
782
        :param to_revision: If non-None, the merge will merge to to_revision,
 
783
            but not beyond it. to_revision does not need to be in the history
 
784
            of the branch when it is supplied. If None, to_revision defaults to
 
785
            branch.last_revision().
 
786
        """
 
787
        from bzrlib.merge import Merger, Merge3Merger
 
788
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
789
        try:
 
790
            merger = Merger(self.branch, this_tree=self, pb=pb)
 
791
            merger.pp = ProgressPhase("Merge phase", 5, pb)
 
792
            merger.pp.next_phase()
 
793
            # check that there are no
 
794
            # local alterations
 
795
            merger.check_basis(check_clean=True, require_commits=False)
 
796
            if to_revision is None:
 
797
                to_revision = branch.last_revision()
 
798
            merger.other_rev_id = to_revision
 
799
            if merger.other_rev_id is None:
 
800
                raise error.NoCommits(branch)
 
801
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
 
802
            merger.other_basis = merger.other_rev_id
 
803
            merger.other_tree = self.branch.repository.revision_tree(
 
804
                merger.other_rev_id)
 
805
            merger.pp.next_phase()
 
806
            merger.find_base()
 
807
            if merger.base_rev_id == merger.other_rev_id:
 
808
                raise errors.PointlessMerge
 
809
            merger.backup_files = False
 
810
            merger.merge_type = Merge3Merger
 
811
            merger.set_interesting_files(None)
 
812
            merger.show_base = False
 
813
            merger.reprocess = False
 
814
            conflicts = merger.do_merge()
 
815
            merger.set_pending()
 
816
        finally:
 
817
            pb.finished()
 
818
        return conflicts
 
819
 
626
820
    @needs_read_lock
627
821
    def merge_modified(self):
628
822
        try:
629
823
            hashfile = self._control_files.get('merge-hashes')
630
 
        except NoSuchFile:
 
824
        except errors.NoSuchFile:
631
825
            return {}
632
826
        merge_hashes = {}
633
827
        try:
634
828
            if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
635
 
                raise MergeModifiedFormatError()
 
829
                raise errors.MergeModifiedFormatError()
636
830
        except StopIteration:
637
 
            raise MergeModifiedFormatError()
 
831
            raise errors.MergeModifiedFormatError()
638
832
        for s in RioReader(hashfile):
639
833
            file_id = s.get("file_id")
640
834
            if file_id not in self.inventory:
644
838
                merge_hashes[file_id] = hash
645
839
        return merge_hashes
646
840
 
 
841
    @needs_write_lock
 
842
    def mkdir(self, path, file_id=None):
 
843
        """See MutableTree.mkdir()."""
 
844
        if file_id is None:
 
845
            file_id = generate_ids.gen_file_id(os.path.basename(path))
 
846
        os.mkdir(self.abspath(path))
 
847
        self.add(path, file_id, 'directory')
 
848
        return file_id
 
849
 
647
850
    def get_symlink_target(self, file_id):
648
851
        return os.readlink(self.id2abspath(file_id))
649
852
 
655
858
        else:
656
859
            return '?'
657
860
 
658
 
    def list_files(self):
659
 
        """Recursively list all files as (path, class, kind, id).
 
861
    def flush(self):
 
862
        """Write the in memory inventory to disk."""
 
863
        # TODO: Maybe this should only write on dirty ?
 
864
        if self._control_files._lock_mode != 'w':
 
865
            raise errors.NotWriteLocked(self)
 
866
        sio = StringIO()
 
867
        xml5.serializer_v5.write_inventory(self._inventory, sio)
 
868
        sio.seek(0)
 
869
        self._control_files.put('inventory', sio)
 
870
        self._inventory_is_modified = False
 
871
 
 
872
    def list_files(self, include_root=False):
 
873
        """Recursively list all files as (path, class, kind, id, entry).
660
874
 
661
875
        Lists, but does not descend into unversioned directories.
662
876
 
666
880
        Skips the control directory.
667
881
        """
668
882
        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:
 
883
        if include_root is True:
 
884
            yield ('', 'V', 'directory', inv.root.file_id, inv.root)
 
885
        # Convert these into local objects to save lookup times
 
886
        pathjoin = osutils.pathjoin
 
887
        file_kind = osutils.file_kind
 
888
 
 
889
        # transport.base ends in a slash, we want the piece
 
890
        # between the last two slashes
 
891
        transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
 
892
 
 
893
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
 
894
 
 
895
        # directory file_id, relative path, absolute path, reverse sorted children
 
896
        children = os.listdir(self.basedir)
 
897
        children.sort()
 
898
        # jam 20060527 The kernel sized tree seems equivalent whether we 
 
899
        # use a deque and popleft to keep them sorted, or if we use a plain
 
900
        # list and just reverse() them.
 
901
        children = collections.deque(children)
 
902
        stack = [(inv.root.file_id, u'', self.basedir, children)]
 
903
        while stack:
 
904
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
 
905
 
 
906
            while children:
 
907
                f = children.popleft()
674
908
                ## TODO: If we find a subdirectory with its own .bzr
675
909
                ## directory, then that is a separate tree and we
676
910
                ## should exclude it.
677
911
 
678
912
                # the bzrdir for this tree
679
 
                if self.bzrdir.transport.base.endswith(f + '/'):
 
913
                if transport_base_dir == f:
680
914
                    continue
681
915
 
682
 
                # path within tree
683
 
                fp = appendpath(from_dir_relpath, f)
 
916
                # we know that from_dir_relpath and from_dir_abspath never end in a slash
 
917
                # and 'f' doesn't begin with one, we can do a string op, rather
 
918
                # than the checks of pathjoin(), all relative paths will have an extra slash
 
919
                # at the beginning
 
920
                fp = from_dir_relpath + '/' + f
684
921
 
685
922
                # absolute path
686
 
                fap = appendpath(dp, f)
 
923
                fap = from_dir_abspath + '/' + f
687
924
                
688
925
                f_ie = inv.get_child(from_dir_id, f)
689
926
                if f_ie:
690
927
                    c = 'V'
691
 
                elif self.is_ignored(fp):
 
928
                elif self.is_ignored(fp[1:]):
692
929
                    c = 'I'
693
930
                else:
694
 
                    c = '?'
 
931
                    # we may not have found this file, because of a unicode issue
 
932
                    f_norm, can_access = osutils.normalized_filename(f)
 
933
                    if f == f_norm or not can_access:
 
934
                        # No change, so treat this file normally
 
935
                        c = '?'
 
936
                    else:
 
937
                        # this file can be accessed by a normalized path
 
938
                        # check again if it is versioned
 
939
                        # these lines are repeated here for performance
 
940
                        f = f_norm
 
941
                        fp = from_dir_relpath + '/' + f
 
942
                        fap = from_dir_abspath + '/' + f
 
943
                        f_ie = inv.get_child(from_dir_id, f)
 
944
                        if f_ie:
 
945
                            c = 'V'
 
946
                        elif self.is_ignored(fp[1:]):
 
947
                            c = 'I'
 
948
                        else:
 
949
                            c = '?'
695
950
 
696
951
                fk = file_kind(fap)
697
952
 
698
953
                if f_ie:
699
954
                    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))
 
955
                        raise errors.BzrCheckError(
 
956
                            "file %r entered as kind %r id %r, now of kind %r"
 
957
                            % (fap, f_ie.kind, f_ie.file_id, fk))
703
958
 
704
959
                # make a last minute entry
705
960
                if f_ie:
706
 
                    entry = f_ie
 
961
                    yield fp[1:], c, fk, f_ie.file_id, f_ie
707
962
                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()
 
963
                    try:
 
964
                        yield fp[1:], c, fk, None, fk_entries[fk]()
 
965
                    except KeyError:
 
966
                        yield fp[1:], c, fk, None, TreeEntry()
 
967
                    continue
716
968
                
717
 
                yield fp, c, fk, (f_ie and f_ie.file_id), entry
718
 
 
719
969
                if fk != 'directory':
720
970
                    continue
721
971
 
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):
 
972
                # But do this child first
 
973
                new_children = os.listdir(fap)
 
974
                new_children.sort()
 
975
                new_children = collections.deque(new_children)
 
976
                stack.append((f_ie.file_id, fp, fap, new_children))
 
977
                # Break out of inner loop,
 
978
                # so that we start outer loop with child
 
979
                break
 
980
            else:
 
981
                # if we finished all children, pop it off the stack
 
982
                stack.pop()
 
983
 
 
984
    @needs_tree_write_lock
 
985
    def move(self, from_paths, to_dir=None, after=False, **kwargs):
734
986
        """Rename files.
735
987
 
736
 
        to_name must exist in the inventory.
 
988
        to_dir must exist in the inventory.
737
989
 
738
 
        If to_name exists and is a directory, the files are moved into
 
990
        If to_dir exists and is a directory, the files are moved into
739
991
        it, keeping their old names.  
740
992
 
741
 
        Note that to_name is only the last component of the new name;
 
993
        Note that to_dir is only the last component of the new name;
742
994
        this doesn't change the directory.
743
995
 
 
996
        For each entry in from_paths the move mode will be determined
 
997
        independently.
 
998
 
 
999
        The first mode moves the file in the filesystem and updates the
 
1000
        inventory. The second mode only updates the inventory without
 
1001
        touching the file on the filesystem. This is the new mode introduced
 
1002
        in version 0.15.
 
1003
 
 
1004
        move uses the second mode if 'after == True' and the target is not
 
1005
        versioned but present in the working tree.
 
1006
 
 
1007
        move uses the second mode if 'after == False' and the source is
 
1008
        versioned but no longer in the working tree, and the target is not
 
1009
        versioned but present in the working tree.
 
1010
 
 
1011
        move uses the first mode if 'after == False' and the source is
 
1012
        versioned and present in the working tree, and the target is not
 
1013
        versioned and not present in the working tree.
 
1014
 
 
1015
        Everything else results in an error.
 
1016
 
744
1017
        This returns a list of (from_path, to_path) pairs for each
745
1018
        entry that is moved.
746
1019
        """
747
 
        result = []
748
 
        ## TODO: Option to move IDs only
 
1020
        rename_entries = []
 
1021
        rename_tuples = []
 
1022
 
 
1023
        # check for deprecated use of signature
 
1024
        if to_dir is None:
 
1025
            to_dir = kwargs.get('to_name', None)
 
1026
            if to_dir is None:
 
1027
                raise TypeError('You must supply a target directory')
 
1028
            else:
 
1029
                symbol_versioning.warn('The parameter to_name was deprecated'
 
1030
                                       ' in version 0.13. Use to_dir instead',
 
1031
                                       DeprecationWarning)
 
1032
 
 
1033
        # check destination directory
749
1034
        assert not isinstance(from_paths, basestring)
750
1035
        inv = self.inventory
751
 
        to_abs = self.abspath(to_name)
 
1036
        to_abs = self.abspath(to_dir)
752
1037
        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)
 
1038
            raise errors.BzrMoveFailedError('',to_dir,
 
1039
                errors.NotADirectory(to_abs))
 
1040
        if not self.has_filename(to_dir):
 
1041
            raise errors.BzrMoveFailedError('',to_dir,
 
1042
                errors.NotInWorkingDirectory(to_dir))
 
1043
        to_dir_id = inv.path2id(to_dir)
 
1044
        if to_dir_id is None:
 
1045
            raise errors.BzrMoveFailedError('',to_dir,
 
1046
                errors.NotVersionedError(path=str(to_dir)))
 
1047
 
759
1048
        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)
 
1049
        if to_dir_ie.kind != 'directory':
 
1050
            raise errors.BzrMoveFailedError('',to_dir,
 
1051
                errors.NotADirectory(to_abs))
 
1052
 
 
1053
        # create rename entries and tuples
 
1054
        for from_rel in from_paths:
 
1055
            from_tail = splitpath(from_rel)[-1]
 
1056
            from_id = inv.path2id(from_rel)
 
1057
            if from_id is None:
 
1058
                raise errors.BzrMoveFailedError(from_rel,to_dir,
 
1059
                    errors.NotVersionedError(path=str(from_rel)))
 
1060
 
 
1061
            from_entry = inv[from_id]
 
1062
            from_parent_id = from_entry.parent_id
 
1063
            to_rel = pathjoin(to_dir, from_tail)
 
1064
            rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
 
1065
                                         from_id=from_id,
 
1066
                                         from_tail=from_tail,
 
1067
                                         from_parent_id=from_parent_id,
 
1068
                                         to_rel=to_rel, to_tail=from_tail,
 
1069
                                         to_parent_id=to_dir_id)
 
1070
            rename_entries.append(rename_entry)
 
1071
            rename_tuples.append((from_rel, to_rel))
 
1072
 
 
1073
        # determine which move mode to use. checks also for movability
 
1074
        rename_entries = self._determine_mv_mode(rename_entries, after)
 
1075
 
 
1076
        original_modified = self._inventory_is_modified
782
1077
        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"])
 
1078
            if len(from_paths):
 
1079
                self._inventory_is_modified = True
 
1080
            self._move(rename_entries)
794
1081
        except:
795
1082
            # restore the inventory on error
796
 
            self._set_inventory(orig_inv)
 
1083
            self._inventory_is_modified = original_modified
797
1084
            raise
798
1085
        self._write_inventory(inv)
799
 
        return result
800
 
 
801
 
    @needs_write_lock
802
 
    def rename_one(self, from_rel, to_rel):
 
1086
        return rename_tuples
 
1087
 
 
1088
    def _determine_mv_mode(self, rename_entries, after=False):
 
1089
        """Determines for each from-to pair if both inventory and working tree
 
1090
        or only the inventory has to be changed.
 
1091
 
 
1092
        Also does basic plausability tests.
 
1093
        """
 
1094
        inv = self.inventory
 
1095
 
 
1096
        for rename_entry in rename_entries:
 
1097
            # store to local variables for easier reference
 
1098
            from_rel = rename_entry.from_rel
 
1099
            from_id = rename_entry.from_id
 
1100
            to_rel = rename_entry.to_rel
 
1101
            to_id = inv.path2id(to_rel)
 
1102
            only_change_inv = False
 
1103
 
 
1104
            # check the inventory for source and destination
 
1105
            if from_id is None:
 
1106
                raise errors.BzrMoveFailedError(from_rel,to_rel,
 
1107
                    errors.NotVersionedError(path=str(from_rel)))
 
1108
            if to_id is not None:
 
1109
                raise errors.BzrMoveFailedError(from_rel,to_rel,
 
1110
                    errors.AlreadyVersionedError(path=str(to_rel)))
 
1111
 
 
1112
            # try to determine the mode for rename (only change inv or change
 
1113
            # inv and file system)
 
1114
            if after:
 
1115
                if not self.has_filename(to_rel):
 
1116
                    raise errors.BzrMoveFailedError(from_id,to_rel,
 
1117
                        errors.NoSuchFile(path=str(to_rel),
 
1118
                        extra="New file has not been created yet"))
 
1119
                only_change_inv = True
 
1120
            elif not self.has_filename(from_rel) and self.has_filename(to_rel):
 
1121
                only_change_inv = True
 
1122
            elif self.has_filename(from_rel) and not self.has_filename(to_rel):
 
1123
                only_change_inv = False
 
1124
            else:
 
1125
                # something is wrong, so lets determine what exactly
 
1126
                if not self.has_filename(from_rel) and \
 
1127
                   not self.has_filename(to_rel):
 
1128
                    raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1129
                        errors.PathsDoNotExist(paths=(str(from_rel),
 
1130
                        str(to_rel))))
 
1131
                else:
 
1132
                    raise errors.RenameFailedFilesExist(from_rel, to_rel,
 
1133
                        extra="(Use --after to update the Bazaar id)")
 
1134
            rename_entry.only_change_inv = only_change_inv
 
1135
        return rename_entries
 
1136
 
 
1137
    def _move(self, rename_entries):
 
1138
        """Moves a list of files.
 
1139
 
 
1140
        Depending on the value of the flag 'only_change_inv', the
 
1141
        file will be moved on the file system or not.
 
1142
        """
 
1143
        inv = self.inventory
 
1144
        moved = []
 
1145
 
 
1146
        for entry in rename_entries:
 
1147
            try:
 
1148
                self._move_entry(entry)
 
1149
            except:
 
1150
                self._rollback_move(moved)
 
1151
                raise
 
1152
            moved.append(entry)
 
1153
 
 
1154
    def _rollback_move(self, moved):
 
1155
        """Try to rollback a previous move in case of an filesystem error."""
 
1156
        inv = self.inventory
 
1157
        for entry in moved:
 
1158
            try:
 
1159
                self._move_entry(_RenameEntry(entry.to_rel, entry.from_id,
 
1160
                    entry.to_tail, entry.to_parent_id, entry.from_rel,
 
1161
                    entry.from_tail, entry.from_parent_id,
 
1162
                    entry.only_change_inv))
 
1163
            except errors.BzrMoveFailedError, e:
 
1164
                raise errors.BzrMoveFailedError( '', '', "Rollback failed."
 
1165
                        " The working tree is in an inconsistent state."
 
1166
                        " Please consider doing a 'bzr revert'."
 
1167
                        " Error message is: %s" % e)
 
1168
 
 
1169
    def _move_entry(self, entry):
 
1170
        inv = self.inventory
 
1171
        from_rel_abs = self.abspath(entry.from_rel)
 
1172
        to_rel_abs = self.abspath(entry.to_rel)
 
1173
        if from_rel_abs == to_rel_abs:
 
1174
            raise errors.BzrMoveFailedError(entry.from_rel, entry.to_rel,
 
1175
                "Source and target are identical.")
 
1176
 
 
1177
        if not entry.only_change_inv:
 
1178
            try:
 
1179
                osutils.rename(from_rel_abs, to_rel_abs)
 
1180
            except OSError, e:
 
1181
                raise errors.BzrMoveFailedError(entry.from_rel,
 
1182
                    entry.to_rel, e[1])
 
1183
        inv.rename(entry.from_id, entry.to_parent_id, entry.to_tail)
 
1184
 
 
1185
    @needs_tree_write_lock
 
1186
    def rename_one(self, from_rel, to_rel, after=False):
803
1187
        """Rename one file.
804
1188
 
805
1189
        This can change the directory or the filename or both.
 
1190
 
 
1191
        rename_one has several 'modes' to work. First, it can rename a physical
 
1192
        file and change the file_id. That is the normal mode. Second, it can
 
1193
        only change the file_id without touching any physical file. This is
 
1194
        the new mode introduced in version 0.15.
 
1195
 
 
1196
        rename_one uses the second mode if 'after == True' and 'to_rel' is not
 
1197
        versioned but present in the working tree.
 
1198
 
 
1199
        rename_one uses the second mode if 'after == False' and 'from_rel' is
 
1200
        versioned but no longer in the working tree, and 'to_rel' is not
 
1201
        versioned but present in the working tree.
 
1202
 
 
1203
        rename_one uses the first mode if 'after == False' and 'from_rel' is
 
1204
        versioned and present in the working tree, and 'to_rel' is not
 
1205
        versioned and not present in the working tree.
 
1206
 
 
1207
        Everything else results in an error.
806
1208
        """
807
1209
        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
 
 
 
1210
        rename_entries = []
 
1211
 
 
1212
        # create rename entries and tuples
 
1213
        from_tail = splitpath(from_rel)[-1]
 
1214
        from_id = inv.path2id(from_rel)
 
1215
        if from_id is None:
 
1216
            raise errors.BzrRenameFailedError(from_rel,to_rel,
 
1217
                errors.NotVersionedError(path=str(from_rel)))
 
1218
        from_entry = inv[from_id]
 
1219
        from_parent_id = from_entry.parent_id
824
1220
        to_dir, to_tail = os.path.split(to_rel)
825
1221
        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"])
 
1222
        rename_entry = WorkingTree._RenameEntry(from_rel=from_rel,
 
1223
                                     from_id=from_id,
 
1224
                                     from_tail=from_tail,
 
1225
                                     from_parent_id=from_parent_id,
 
1226
                                     to_rel=to_rel, to_tail=to_tail,
 
1227
                                     to_parent_id=to_dir_id)
 
1228
        rename_entries.append(rename_entry)
 
1229
 
 
1230
        # determine which move mode to use. checks also for movability
 
1231
        rename_entries = self._determine_mv_mode(rename_entries, after)
 
1232
 
 
1233
        # check if the target changed directory and if the target directory is
 
1234
        # versioned
 
1235
        if to_dir_id is None:
 
1236
            raise errors.BzrMoveFailedError(from_rel,to_rel,
 
1237
                errors.NotVersionedError(path=str(to_dir)))
 
1238
 
 
1239
        # all checks done. now we can continue with our actual work
 
1240
        mutter('rename_one:\n'
 
1241
               '  from_id   {%s}\n'
 
1242
               '  from_rel: %r\n'
 
1243
               '  to_rel:   %r\n'
 
1244
               '  to_dir    %r\n'
 
1245
               '  to_dir_id {%s}\n',
 
1246
               from_id, from_rel, to_rel, to_dir, to_dir_id)
 
1247
 
 
1248
        self._move(rename_entries)
847
1249
        self._write_inventory(inv)
848
1250
 
 
1251
    class _RenameEntry(object):
 
1252
        def __init__(self, from_rel, from_id, from_tail, from_parent_id,
 
1253
                     to_rel, to_tail, to_parent_id, only_change_inv=False):
 
1254
            self.from_rel = from_rel
 
1255
            self.from_id = from_id
 
1256
            self.from_tail = from_tail
 
1257
            self.from_parent_id = from_parent_id
 
1258
            self.to_rel = to_rel
 
1259
            self.to_tail = to_tail
 
1260
            self.to_parent_id = to_parent_id
 
1261
            self.only_change_inv = only_change_inv
 
1262
 
849
1263
    @needs_read_lock
850
1264
    def unknowns(self):
851
1265
        """Return all unknown files.
852
1266
 
853
1267
        These are files in the working directory that are not versioned or
854
1268
        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
1269
        """
869
1270
        for subp in self.extras():
870
1271
            if not self.is_ignored(subp):
871
1272
                yield subp
872
 
 
 
1273
    
 
1274
    @needs_tree_write_lock
 
1275
    def unversion(self, file_ids):
 
1276
        """Remove the file ids in file_ids from the current versioned set.
 
1277
 
 
1278
        When a file_id is unversioned, all of its children are automatically
 
1279
        unversioned.
 
1280
 
 
1281
        :param file_ids: The file ids to stop versioning.
 
1282
        :raises: NoSuchId if any fileid is not currently versioned.
 
1283
        """
 
1284
        for file_id in file_ids:
 
1285
            if self._inventory.has_id(file_id):
 
1286
                self._inventory.remove_recursive_id(file_id)
 
1287
            else:
 
1288
                raise errors.NoSuchId(self, file_id)
 
1289
        if len(file_ids):
 
1290
            # in the future this should just set a dirty bit to wait for the 
 
1291
            # final unlock. However, until all methods of workingtree start
 
1292
            # with the current in -memory inventory rather than triggering 
 
1293
            # a read, it is more complex - we need to teach read_inventory
 
1294
            # to know when to read, and when to not read first... and possibly
 
1295
            # to save first when the in memory one may be corrupted.
 
1296
            # so for now, we just only write it if it is indeed dirty.
 
1297
            # - RBC 20060907
 
1298
            self._write_inventory(self._inventory)
 
1299
    
873
1300
    @deprecated_method(zero_eight)
874
1301
    def iter_conflicts(self):
875
1302
        """List all files in the tree that have text or content conflicts.
878
1305
 
879
1306
    def _iter_conflicts(self):
880
1307
        conflicted = set()
881
 
        for path in (s[0] for s in self.list_files()):
 
1308
        for info in self.list_files():
 
1309
            path = info[0]
882
1310
            stem = get_conflicted_stem(path)
883
1311
            if stem is None:
884
1312
                continue
906
1334
                repository = self.branch.repository
907
1335
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
908
1336
                try:
909
 
                    merge_inner(self.branch,
910
 
                                self.branch.basis_tree(),
911
 
                                basis_tree, 
912
 
                                this_tree=self, 
 
1337
                    new_basis_tree = self.branch.basis_tree()
 
1338
                    merge.merge_inner(
 
1339
                                self.branch,
 
1340
                                new_basis_tree,
 
1341
                                basis_tree,
 
1342
                                this_tree=self,
913
1343
                                pb=pb)
 
1344
                    if (basis_tree.inventory.root is None and
 
1345
                        new_basis_tree.inventory.root is not None):
 
1346
                        self.set_root_id(new_basis_tree.inventory.root.file_id)
914
1347
                finally:
915
1348
                    pb.finished()
916
 
                self.set_last_revision(self.branch.last_revision())
 
1349
                # TODO - dedup parents list with things merged by pull ?
 
1350
                # reuse the revisiontree we merged against to set the new
 
1351
                # tree data.
 
1352
                parent_trees = [(self.branch.last_revision(), new_basis_tree)]
 
1353
                # we have to pull the merge trees out again, because 
 
1354
                # merge_inner has set the ids. - this corner is not yet 
 
1355
                # layered well enough to prevent double handling.
 
1356
                merges = self.get_parent_ids()[1:]
 
1357
                parent_trees.extend([
 
1358
                    (parent, repository.revision_tree(parent)) for
 
1359
                     parent in merges])
 
1360
                self.set_parent_trees(parent_trees)
917
1361
            return count
918
1362
        finally:
919
1363
            source.unlock()
920
1364
            top_pb.finished()
921
1365
 
 
1366
    @needs_write_lock
 
1367
    def put_file_bytes_non_atomic(self, file_id, bytes):
 
1368
        """See MutableTree.put_file_bytes_non_atomic."""
 
1369
        stream = file(self.id2abspath(file_id), 'wb')
 
1370
        try:
 
1371
            stream.write(bytes)
 
1372
        finally:
 
1373
            stream.close()
 
1374
        # TODO: update the hashcache here ?
 
1375
 
922
1376
    def extras(self):
923
1377
        """Yield all unknown files in this WorkingTree.
924
1378
 
930
1384
        """
931
1385
        ## TODO: Work from given directory downwards
932
1386
        for path, dir_entry in self.inventory.directories():
933
 
            mutter("search for unknowns in %r", path)
 
1387
            # mutter("search for unknowns in %r", path)
934
1388
            dirabs = self.abspath(path)
935
1389
            if not isdir(dirabs):
936
1390
                # e.g. directory deleted
938
1392
 
939
1393
            fl = []
940
1394
            for subf in os.listdir(dirabs):
941
 
                if (subf != '.bzr'
942
 
                    and (subf not in dir_entry.children)):
943
 
                    fl.append(subf)
 
1395
                if subf == '.bzr':
 
1396
                    continue
 
1397
                if subf not in dir_entry.children:
 
1398
                    subf_norm, can_access = osutils.normalized_filename(subf)
 
1399
                    if subf_norm != subf and can_access:
 
1400
                        if subf_norm not in dir_entry.children:
 
1401
                            fl.append(subf_norm)
 
1402
                    else:
 
1403
                        fl.append(subf)
944
1404
            
945
1405
            fl.sort()
946
1406
            for subf in fl:
947
 
                subp = appendpath(path, subf)
 
1407
                subp = pathjoin(path, subf)
948
1408
                yield subp
949
1409
 
950
1410
 
952
1412
        """Yield list of PATH, IGNORE_PATTERN"""
953
1413
        for subp in self.extras():
954
1414
            pat = self.is_ignored(subp)
955
 
            if pat != None:
 
1415
            if pat is not None:
956
1416
                yield subp, pat
957
1417
 
958
 
 
959
1418
    def get_ignore_list(self):
960
1419
        """Return list of ignore patterns.
961
1420
 
962
1421
        Cached in the Tree object after the first call.
963
1422
        """
964
 
        if hasattr(self, '_ignorelist'):
965
 
            return self._ignorelist
 
1423
        ignoreset = getattr(self, '_ignoreset', None)
 
1424
        if ignoreset is not None:
 
1425
            return ignoreset
966
1426
 
967
 
        l = bzrlib.DEFAULT_IGNORE[:]
 
1427
        ignore_globs = set(bzrlib.DEFAULT_IGNORE)
 
1428
        ignore_globs.update(ignores.get_runtime_ignores())
 
1429
        ignore_globs.update(ignores.get_user_ignores())
968
1430
        if self.has_filename(bzrlib.IGNORE_FILENAME):
969
1431
            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
 
1432
            try:
 
1433
                ignore_globs.update(ignores.parse_ignore_file(f))
 
1434
            finally:
 
1435
                f.close()
 
1436
        self._ignoreset = ignore_globs
 
1437
        return ignore_globs
973
1438
 
 
1439
    def _flush_ignore_list_cache(self):
 
1440
        """Resets the cached ignore list to force a cache rebuild."""
 
1441
        self._ignoreset = None
 
1442
        self._ignoreglobster = None
974
1443
 
975
1444
    def is_ignored(self, filename):
976
1445
        r"""Check whether the filename matches an ignore pattern.
981
1450
        If the file is ignored, returns the pattern which caused it to
982
1451
        be ignored, otherwise None.  So this can simply be used as a
983
1452
        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
 
1453
        if getattr(self, '_ignoreglobster', None) is None:
 
1454
            self._ignoreglobster = globbing.Globster(self.get_ignore_list())
 
1455
        return self._ignoreglobster.match(filename)
1012
1456
 
1013
1457
    def kind(self, file_id):
1014
1458
        return file_kind(self.id2abspath(file_id))
1015
1459
 
1016
 
    @needs_read_lock
 
1460
    def _comparison_data(self, entry, path):
 
1461
        abspath = self.abspath(path)
 
1462
        try:
 
1463
            stat_value = os.lstat(abspath)
 
1464
        except OSError, e:
 
1465
            if getattr(e, 'errno', None) == errno.ENOENT:
 
1466
                stat_value = None
 
1467
                kind = None
 
1468
                executable = False
 
1469
            else:
 
1470
                raise
 
1471
        else:
 
1472
            mode = stat_value.st_mode
 
1473
            kind = osutils.file_kind_from_stat_mode(mode)
 
1474
            if not supports_executable():
 
1475
                executable = entry.executable
 
1476
            else:
 
1477
                executable = bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
 
1478
        return kind, executable, stat_value
 
1479
 
 
1480
    def _file_size(self, entry, stat_value):
 
1481
        return stat_value.st_size
 
1482
 
1017
1483
    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().
 
1484
        """Return the last revision of the branch for this tree.
 
1485
 
 
1486
        This format tree does not support a separate marker for last-revision
 
1487
        compared to the branch.
 
1488
 
 
1489
        See MutableTree.last_revision
1023
1490
        """
 
1491
        return self._last_revision()
 
1492
 
 
1493
    @needs_read_lock
 
1494
    def _last_revision(self):
 
1495
        """helper for get_parent_ids."""
1024
1496
        return self.branch.last_revision()
1025
1497
 
 
1498
    def is_locked(self):
 
1499
        return self._control_files.is_locked()
 
1500
 
1026
1501
    def lock_read(self):
1027
1502
        """See Branch.lock_read, and WorkingTree.unlock."""
1028
1503
        self.branch.lock_read()
1032
1507
            self.branch.unlock()
1033
1508
            raise
1034
1509
 
 
1510
    def lock_tree_write(self):
 
1511
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
 
1512
        self.branch.lock_read()
 
1513
        try:
 
1514
            return self._control_files.lock_write()
 
1515
        except:
 
1516
            self.branch.unlock()
 
1517
            raise
 
1518
 
1035
1519
    def lock_write(self):
1036
 
        """See Branch.lock_write, and WorkingTree.unlock."""
 
1520
        """See MutableTree.lock_write, and WorkingTree.unlock."""
1037
1521
        self.branch.lock_write()
1038
1522
        try:
1039
1523
            return self._control_files.lock_write()
1041
1525
            self.branch.unlock()
1042
1526
            raise
1043
1527
 
 
1528
    def get_physical_lock_status(self):
 
1529
        return self._control_files.get_physical_lock_status()
 
1530
 
1044
1531
    def _basis_inventory_name(self):
1045
 
        return 'basis-inventory'
 
1532
        return 'basis-inventory-cache'
1046
1533
 
1047
 
    @needs_write_lock
 
1534
    @needs_tree_write_lock
1048
1535
    def set_last_revision(self, new_revision):
1049
1536
        """Change the last revision in the working tree."""
1050
1537
        if self._change_last_revision(new_revision):
1059
1546
        if new_revision is None:
1060
1547
            self.branch.set_revision_history([])
1061
1548
            return False
1062
 
        # current format is locked in with the branch
1063
 
        revision_history = self.branch.revision_history()
1064
1549
        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])
 
1550
            self.branch.generate_revision_history(new_revision)
 
1551
        except errors.NoSuchRevision:
 
1552
            # not present in the repo - dont try to set it deeper than the tip
 
1553
            self.branch.set_revision_history([new_revision])
1069
1554
        return True
1070
1555
 
 
1556
    def _write_basis_inventory(self, xml):
 
1557
        """Write the basis inventory XML to the basis-inventory file"""
 
1558
        assert isinstance(xml, str), 'serialised xml must be bytestring.'
 
1559
        path = self._basis_inventory_name()
 
1560
        sio = StringIO(xml)
 
1561
        self._control_files.put(path, sio)
 
1562
 
 
1563
    def _create_basis_xml_from_inventory(self, revision_id, inventory):
 
1564
        """Create the text that will be saved in basis-inventory"""
 
1565
        inventory.revision_id = revision_id
 
1566
        return xml6.serializer_v6.write_inventory_to_string(inventory)
 
1567
 
1071
1568
    def _cache_basis_inventory(self, new_revision):
1072
1569
        """Cache new_revision as the basis inventory."""
 
1570
        # TODO: this should allow the ready-to-use inventory to be passed in,
 
1571
        # as commit already has that ready-to-use [while the format is the
 
1572
        # same, that is].
1073
1573
        try:
1074
1574
            # this double handles the inventory - unpack and repack - 
1075
1575
            # but is easier to understand. We can/should put a conditional
1076
1576
            # in here based on whether the inventory is in the latest format
1077
1577
            # - perhaps we should repack all inventories on a repository
1078
1578
            # 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:
 
1579
            # the fast path is to copy the raw xml from the repository. If the
 
1580
            # xml contains 'revision_id="', then we assume the right 
 
1581
            # revision_id is set. We must check for this full string, because a
 
1582
            # root node id can legitimately look like 'revision_id' but cannot
 
1583
            # contain a '"'.
 
1584
            xml = self.branch.repository.get_inventory_xml(new_revision)
 
1585
            firstline = xml.split('\n', 1)[0]
 
1586
            if (not 'revision_id="' in firstline or 
 
1587
                'format="6"' not in firstline):
 
1588
                inv = self.branch.repository.deserialise_inventory(
 
1589
                    new_revision, xml)
 
1590
                xml = self._create_basis_xml_from_inventory(new_revision, inv)
 
1591
            self._write_basis_inventory(xml)
 
1592
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1086
1593
            pass
1087
1594
 
1088
1595
    def read_basis_inventory(self):
1089
1596
        """Read the cached basis inventory."""
1090
1597
        path = self._basis_inventory_name()
1091
 
        return self._control_files.get_utf8(path).read()
 
1598
        return self._control_files.get(path).read()
1092
1599
        
1093
1600
    @needs_read_lock
1094
1601
    def read_working_inventory(self):
1095
 
        """Read the working inventory."""
 
1602
        """Read the working inventory.
 
1603
        
 
1604
        :raises errors.InventoryModified: read_working_inventory will fail
 
1605
            when the current in memory inventory has been modified.
 
1606
        """
 
1607
        # conceptually this should be an implementation detail of the tree. 
 
1608
        # XXX: Deprecate this.
1096
1609
        # ElementTree does its own conversion from UTF-8, so open in
1097
1610
        # binary.
1098
 
        result = bzrlib.xml5.serializer_v5.read_inventory(
 
1611
        if self._inventory_is_modified:
 
1612
            raise errors.InventoryModified(self)
 
1613
        result = xml5.serializer_v5.read_inventory(
1099
1614
            self._control_files.get('inventory'))
1100
 
        self._set_inventory(result)
 
1615
        self._set_inventory(result, dirty=False)
1101
1616
        return result
1102
1617
 
1103
 
    @needs_write_lock
1104
 
    def remove(self, files, verbose=False):
 
1618
    @needs_tree_write_lock
 
1619
    def remove(self, files, verbose=False, to_file=None):
1105
1620
        """Remove nominated files from the working inventory..
1106
1621
 
1107
1622
        This does not remove their text.  This does not run on XXX on what? RBC
1128
1643
            if not fid:
1129
1644
                # TODO: Perhaps make this just a warning, and continue?
1130
1645
                # This tends to happen when 
1131
 
                raise NotVersionedError(path=f)
1132
 
            mutter("remove inventory entry %s {%s}", quotefn(f), fid)
 
1646
                raise errors.NotVersionedError(path=f)
1133
1647
            if verbose:
1134
1648
                # having remove it, it must be either ignored or unknown
1135
1649
                if self.is_ignored(f):
1136
1650
                    new_status = 'I'
1137
1651
                else:
1138
1652
                    new_status = '?'
1139
 
                show_status(new_status, inv[fid].kind, quotefn(f))
 
1653
                textui.show_status(new_status, inv[fid].kind, f,
 
1654
                                   to_file=to_file)
1140
1655
            del inv[fid]
1141
1656
 
1142
1657
        self._write_inventory(inv)
1143
1658
 
1144
 
    @needs_write_lock
 
1659
    @needs_tree_write_lock
1145
1660
    def revert(self, filenames, old_tree=None, backups=True, 
1146
1661
               pb=DummyProgress()):
1147
 
        from transform import revert
1148
 
        from conflicts import resolve
 
1662
        from bzrlib.conflicts import resolve
1149
1663
        if old_tree is None:
1150
1664
            old_tree = self.basis_tree()
1151
 
        conflicts = revert(self, old_tree, filenames, backups, pb)
 
1665
        conflicts = transform.revert(self, old_tree, filenames, backups, pb)
1152
1666
        if not len(filenames):
1153
 
            self.set_pending_merges([])
 
1667
            self.set_parent_ids(self.get_parent_ids()[:1])
1154
1668
            resolve(self)
1155
1669
        else:
1156
1670
            resolve(self, filenames, ignore_misses=True)
1158
1672
 
1159
1673
    # XXX: This method should be deprecated in favour of taking in a proper
1160
1674
    # new Inventory object.
1161
 
    @needs_write_lock
 
1675
    @needs_tree_write_lock
1162
1676
    def set_inventory(self, new_inventory_list):
1163
1677
        from bzrlib.inventory import (Inventory,
1164
1678
                                      InventoryDirectory,
1178
1692
            elif kind == 'symlink':
1179
1693
                inv.add(InventoryLink(file_id, name, parent))
1180
1694
            else:
1181
 
                raise BzrError("unknown kind %r" % kind)
 
1695
                raise errors.BzrError("unknown kind %r" % kind)
1182
1696
        self._write_inventory(inv)
1183
1697
 
1184
 
    @needs_write_lock
 
1698
    @needs_tree_write_lock
1185
1699
    def set_root_id(self, file_id):
1186
1700
        """Set the root id for this tree."""
1187
 
        inv = self.read_working_inventory()
 
1701
        # for compatability 
 
1702
        if file_id is None:
 
1703
            symbol_versioning.warn(symbol_versioning.zero_twelve
 
1704
                % 'WorkingTree.set_root_id with fileid=None',
 
1705
                DeprecationWarning,
 
1706
                stacklevel=3)
 
1707
            file_id = ROOT_ID
 
1708
        inv = self._inventory
1188
1709
        orig_root_id = inv.root.file_id
 
1710
        # TODO: it might be nice to exit early if there was nothing
 
1711
        # to do, saving us from trigger a sync on unlock.
 
1712
        self._inventory_is_modified = True
 
1713
        # we preserve the root inventory entry object, but
 
1714
        # unlinkit from the byid index
1189
1715
        del inv._byid[inv.root.file_id]
1190
1716
        inv.root.file_id = file_id
 
1717
        # and link it into the index with the new changed id.
1191
1718
        inv._byid[inv.root.file_id] = inv.root
 
1719
        # and finally update all children to reference the new id.
 
1720
        # XXX: this should be safe to just look at the root.children
 
1721
        # list, not the WHOLE INVENTORY.
1192
1722
        for fid in inv:
1193
1723
            entry = inv[fid]
1194
1724
            if entry.parent_id == orig_root_id:
1195
1725
                entry.parent_id = inv.root.file_id
1196
 
        self._write_inventory(inv)
1197
1726
 
1198
1727
    def unlock(self):
1199
1728
        """See Branch.unlock.
1204
1733
        between multiple working trees, i.e. via shared storage, then we 
1205
1734
        would probably want to lock both the local tree, and the branch.
1206
1735
        """
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
 
1736
        raise NotImplementedError(self.unlock)
1229
1737
 
1230
 
    @needs_write_lock
1231
1738
    def update(self):
1232
1739
        """Update a working tree along its branch.
1233
1740
 
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.
 
1741
        This will update the branch if its bound too, which means we have
 
1742
        multiple trees involved:
 
1743
 
 
1744
        - The new basis tree of the master.
 
1745
        - The old basis tree of the branch.
 
1746
        - The old basis tree of the working tree.
 
1747
        - The current working tree state.
 
1748
 
 
1749
        Pathologically, all three may be different, and non-ancestors of each
 
1750
        other.  Conceptually we want to:
 
1751
 
 
1752
        - Preserve the wt.basis->wt.state changes
 
1753
        - Transform the wt.basis to the new master basis.
 
1754
        - Apply a merge of the old branch basis to get any 'local' changes from
 
1755
          it into the tree.
 
1756
        - Restore the wt.basis->wt.state changes.
1245
1757
 
1246
1758
        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.
 
1759
        - Merge current state -> basis tree of the master w.r.t. the old tree
 
1760
          basis.
 
1761
        - Do a 'normal' merge of the old branch basis if it is relevant.
1249
1762
        """
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()
 
1763
        if self.branch.get_master_branch() is not None:
 
1764
            self.lock_write()
 
1765
            update_branch = True
 
1766
        else:
 
1767
            self.lock_tree_write()
 
1768
            update_branch = False
1254
1769
        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()
1259
 
                to_tree = self.branch.basis_tree()
1260
 
                result += merge_inner(self.branch,
1261
 
                                      to_tree,
1262
 
                                      basis,
1263
 
                                      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
 
1770
            if update_branch:
 
1771
                old_tip = self.branch.update()
 
1772
            else:
 
1773
                old_tip = None
 
1774
            return self._update_tree(old_tip)
1284
1775
        finally:
1285
 
            self.branch.unlock()
1286
 
 
1287
 
    @needs_write_lock
 
1776
            self.unlock()
 
1777
 
 
1778
    @needs_tree_write_lock
 
1779
    def _update_tree(self, old_tip=None):
 
1780
        """Update a tree to the master branch.
 
1781
 
 
1782
        :param old_tip: if supplied, the previous tip revision the branch,
 
1783
            before it was changed to the master branch's tip.
 
1784
        """
 
1785
        # here if old_tip is not None, it is the old tip of the branch before
 
1786
        # it was updated from the master branch. This should become a pending
 
1787
        # merge in the working tree to preserve the user existing work.  we
 
1788
        # cant set that until we update the working trees last revision to be
 
1789
        # one from the new branch, because it will just get absorbed by the
 
1790
        # parent de-duplication logic.
 
1791
        # 
 
1792
        # We MUST save it even if an error occurs, because otherwise the users
 
1793
        # local work is unreferenced and will appear to have been lost.
 
1794
        # 
 
1795
        result = 0
 
1796
        try:
 
1797
            last_rev = self.get_parent_ids()[0]
 
1798
        except IndexError:
 
1799
            last_rev = None
 
1800
        if last_rev != self.branch.last_revision():
 
1801
            # merge tree state up to new branch tip.
 
1802
            basis = self.basis_tree()
 
1803
            to_tree = self.branch.basis_tree()
 
1804
            if basis.inventory.root is None:
 
1805
                self.set_root_id(to_tree.inventory.root.file_id)
 
1806
            result += merge.merge_inner(
 
1807
                                  self.branch,
 
1808
                                  to_tree,
 
1809
                                  basis,
 
1810
                                  this_tree=self)
 
1811
            # TODO - dedup parents list with things merged by pull ?
 
1812
            # reuse the tree we've updated to to set the basis:
 
1813
            parent_trees = [(self.branch.last_revision(), to_tree)]
 
1814
            merges = self.get_parent_ids()[1:]
 
1815
            # Ideally we ask the tree for the trees here, that way the working
 
1816
            # tree can decide whether to give us teh entire tree or give us a
 
1817
            # lazy initialised tree. dirstate for instance will have the trees
 
1818
            # in ram already, whereas a last-revision + basis-inventory tree
 
1819
            # will not, but also does not need them when setting parents.
 
1820
            for parent in merges:
 
1821
                parent_trees.append(
 
1822
                    (parent, self.branch.repository.revision_tree(parent)))
 
1823
            if old_tip is not None:
 
1824
                parent_trees.append(
 
1825
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
 
1826
            self.set_parent_trees(parent_trees)
 
1827
            last_rev = parent_trees[0][0]
 
1828
        else:
 
1829
            # the working tree had the same last-revision as the master
 
1830
            # branch did. We may still have pivot local work from the local
 
1831
            # branch into old_tip:
 
1832
            if old_tip is not None:
 
1833
                self.add_parent_tree_id(old_tip)
 
1834
        if old_tip and old_tip != last_rev:
 
1835
            # our last revision was not the prior branch last revision
 
1836
            # and we have converted that last revision to a pending merge.
 
1837
            # base is somewhere between the branch tip now
 
1838
            # and the now pending merge
 
1839
            from bzrlib.revision import common_ancestor
 
1840
            try:
 
1841
                base_rev_id = common_ancestor(self.branch.last_revision(),
 
1842
                                              old_tip,
 
1843
                                              self.branch.repository)
 
1844
            except errors.NoCommonAncestor:
 
1845
                base_rev_id = None
 
1846
            base_tree = self.branch.repository.revision_tree(base_rev_id)
 
1847
            other_tree = self.branch.repository.revision_tree(old_tip)
 
1848
            result += merge.merge_inner(
 
1849
                                  self.branch,
 
1850
                                  other_tree,
 
1851
                                  base_tree,
 
1852
                                  this_tree=self)
 
1853
        return result
 
1854
 
 
1855
    def _write_hashcache_if_dirty(self):
 
1856
        """Write out the hashcache if it is dirty."""
 
1857
        if self._hashcache.needs_write:
 
1858
            try:
 
1859
                self._hashcache.write()
 
1860
            except OSError, e:
 
1861
                if e.errno not in (errno.EPERM, errno.EACCES):
 
1862
                    raise
 
1863
                # TODO: jam 20061219 Should this be a warning? A single line
 
1864
                #       warning might be sufficient to let the user know what
 
1865
                #       is going on.
 
1866
                mutter('Could not write hashcache for %s\nError: %s',
 
1867
                       self._hashcache.cache_file_name(), e)
 
1868
 
 
1869
    @needs_tree_write_lock
1288
1870
    def _write_inventory(self, inv):
1289
1871
        """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')
 
1872
        self._set_inventory(inv, dirty=True)
 
1873
        self.flush()
1296
1874
 
1297
1875
    def set_conflicts(self, arg):
1298
 
        raise UnsupportedOperation(self.set_conflicts, self)
 
1876
        raise errors.UnsupportedOperation(self.set_conflicts, self)
 
1877
 
 
1878
    def add_conflicts(self, arg):
 
1879
        raise errors.UnsupportedOperation(self.add_conflicts, self)
1299
1880
 
1300
1881
    @needs_read_lock
1301
1882
    def conflicts(self):
1302
 
        conflicts = ConflictList()
 
1883
        conflicts = _mod_conflicts.ConflictList()
1303
1884
        for conflicted in self._iter_conflicts():
1304
1885
            text = True
1305
1886
            try:
1306
1887
                if file_kind(self.abspath(conflicted)) != "file":
1307
1888
                    text = False
1308
 
            except OSError, e:
1309
 
                if e.errno == errno.ENOENT:
1310
 
                    text = False
1311
 
                else:
1312
 
                    raise
 
1889
            except errors.NoSuchFile:
 
1890
                text = False
1313
1891
            if text is True:
1314
1892
                for suffix in ('.THIS', '.OTHER'):
1315
1893
                    try:
1316
1894
                        kind = file_kind(self.abspath(conflicted+suffix))
1317
 
                    except OSError, e:
1318
 
                        if e.errno == errno.ENOENT:
 
1895
                        if kind != "file":
1319
1896
                            text = False
1320
 
                            break
1321
 
                        else:
1322
 
                            raise
1323
 
                    if kind != "file":
 
1897
                    except errors.NoSuchFile:
1324
1898
                        text = False
 
1899
                    if text == False:
1325
1900
                        break
1326
1901
            ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1327
 
            conflicts.append(Conflict.factory(ctype, path=conflicted,
 
1902
            conflicts.append(_mod_conflicts.Conflict.factory(ctype,
 
1903
                             path=conflicted,
1328
1904
                             file_id=self.path2id(conflicted)))
1329
1905
        return conflicts
1330
1906
 
1331
1907
 
 
1908
class WorkingTree2(WorkingTree):
 
1909
    """This is the Format 2 working tree.
 
1910
 
 
1911
    This was the first weave based working tree. 
 
1912
     - uses os locks for locking.
 
1913
     - uses the branch last-revision.
 
1914
    """
 
1915
 
 
1916
    def lock_tree_write(self):
 
1917
        """See WorkingTree.lock_tree_write().
 
1918
 
 
1919
        In Format2 WorkingTrees we have a single lock for the branch and tree
 
1920
        so lock_tree_write() degrades to lock_write().
 
1921
        """
 
1922
        self.branch.lock_write()
 
1923
        try:
 
1924
            return self._control_files.lock_write()
 
1925
        except:
 
1926
            self.branch.unlock()
 
1927
            raise
 
1928
 
 
1929
    def unlock(self):
 
1930
        # we share control files:
 
1931
        if self._control_files._lock_count == 3:
 
1932
            # _inventory_is_modified is always False during a read lock.
 
1933
            if self._inventory_is_modified:
 
1934
                self.flush()
 
1935
            self._write_hashcache_if_dirty()
 
1936
                    
 
1937
        # reverse order of locking.
 
1938
        try:
 
1939
            return self._control_files.unlock()
 
1940
        finally:
 
1941
            self.branch.unlock()
 
1942
 
 
1943
 
1332
1944
class WorkingTree3(WorkingTree):
1333
1945
    """This is the Format 3 working tree.
1334
1946
 
1340
1952
    """
1341
1953
 
1342
1954
    @needs_read_lock
1343
 
    def last_revision(self):
1344
 
        """See WorkingTree.last_revision."""
 
1955
    def _last_revision(self):
 
1956
        """See Mutable.last_revision."""
1345
1957
        try:
1346
1958
            return self._control_files.get_utf8('last-revision').read()
1347
 
        except NoSuchFile:
 
1959
        except errors.NoSuchFile:
1348
1960
            return None
1349
1961
 
1350
1962
    def _change_last_revision(self, revision_id):
1356
1968
                pass
1357
1969
            return False
1358
1970
        else:
1359
 
            try:
1360
 
                self.branch.revision_history().index(revision_id)
1361
 
            except ValueError:
1362
 
                raise errors.NoSuchRevision(self.branch, revision_id)
1363
1971
            self._control_files.put_utf8('last-revision', revision_id)
1364
1972
            return True
1365
1973
 
1366
 
    @needs_write_lock
 
1974
    @needs_tree_write_lock
1367
1975
    def set_conflicts(self, conflicts):
1368
1976
        self._put_rio('conflicts', conflicts.to_stanzas(), 
1369
1977
                      CONFLICT_HEADER_1)
1370
1978
 
 
1979
    @needs_tree_write_lock
 
1980
    def add_conflicts(self, new_conflicts):
 
1981
        conflict_set = set(self.conflicts())
 
1982
        conflict_set.update(set(list(new_conflicts)))
 
1983
        self.set_conflicts(_mod_conflicts.ConflictList(sorted(conflict_set,
 
1984
                                       key=_mod_conflicts.Conflict.sort_key)))
 
1985
 
1371
1986
    @needs_read_lock
1372
1987
    def conflicts(self):
1373
1988
        try:
1374
1989
            confile = self._control_files.get('conflicts')
1375
 
        except NoSuchFile:
1376
 
            return ConflictList()
 
1990
        except errors.NoSuchFile:
 
1991
            return _mod_conflicts.ConflictList()
1377
1992
        try:
1378
1993
            if confile.next() != CONFLICT_HEADER_1 + '\n':
1379
 
                raise ConflictFormatError()
 
1994
                raise errors.ConflictFormatError()
1380
1995
        except StopIteration:
1381
 
            raise ConflictFormatError()
1382
 
        return ConflictList.from_stanzas(RioReader(confile))
 
1996
            raise errors.ConflictFormatError()
 
1997
        return _mod_conflicts.ConflictList.from_stanzas(RioReader(confile))
 
1998
 
 
1999
    def unlock(self):
 
2000
        if self._control_files._lock_count == 1:
 
2001
            # _inventory_is_modified is always False during a read lock.
 
2002
            if self._inventory_is_modified:
 
2003
                self.flush()
 
2004
            self._write_hashcache_if_dirty()
 
2005
        # reverse order of locking.
 
2006
        try:
 
2007
            return self._control_files.unlock()
 
2008
        finally:
 
2009
            self.branch.unlock()
1383
2010
 
1384
2011
 
1385
2012
def get_conflicted_stem(path):
1386
 
    for suffix in CONFLICT_SUFFIXES:
 
2013
    for suffix in _mod_conflicts.CONFLICT_SUFFIXES:
1387
2014
        if path.endswith(suffix):
1388
2015
            return path[:-len(suffix)]
1389
2016
 
1434
2061
            transport = a_bzrdir.get_workingtree_transport(None)
1435
2062
            format_string = transport.get("format").read()
1436
2063
            return klass._formats[format_string]
1437
 
        except NoSuchFile:
 
2064
        except errors.NoSuchFile:
1438
2065
            raise errors.NoWorkingTree(base=transport.base)
1439
2066
        except KeyError:
1440
 
            raise errors.UnknownFormatError(format_string)
 
2067
            raise errors.UnknownFormatError(format=format_string)
1441
2068
 
1442
2069
    @classmethod
1443
2070
    def get_default_format(klass):
1486
2113
        """See WorkingTreeFormat.get_format_description()."""
1487
2114
        return "Working tree format 2"
1488
2115
 
 
2116
    def stub_initialize_remote(self, control_files):
 
2117
        """As a special workaround create critical control files for a remote working tree
 
2118
        
 
2119
        This ensures that it can later be updated and dealt with locally,
 
2120
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with 
 
2121
        no working tree.  (See bug #43064).
 
2122
        """
 
2123
        sio = StringIO()
 
2124
        inv = Inventory()
 
2125
        xml5.serializer_v5.write_inventory(inv, sio)
 
2126
        sio.seek(0)
 
2127
        control_files.put('inventory', sio)
 
2128
 
 
2129
        control_files.put_utf8('pending-merges', '')
 
2130
        
 
2131
 
1489
2132
    def initialize(self, a_bzrdir, revision_id=None):
1490
2133
        """See WorkingTreeFormat.initialize()."""
1491
2134
        if not isinstance(a_bzrdir.transport, LocalTransport):
1503
2146
            finally:
1504
2147
                branch.unlock()
1505
2148
        revision = branch.last_revision()
1506
 
        inv = Inventory() 
1507
 
        wt = WorkingTree(a_bzrdir.root_transport.base,
 
2149
        inv = Inventory()
 
2150
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1508
2151
                         branch,
1509
2152
                         inv,
1510
2153
                         _internal=True,
1511
2154
                         _format=self,
1512
2155
                         _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)
 
2156
        basis_tree = branch.repository.revision_tree(revision)
 
2157
        if basis_tree.inventory.root is not None:
 
2158
            wt.set_root_id(basis_tree.inventory.root.file_id)
 
2159
        # set the parent list and cache the basis tree.
 
2160
        wt.set_parent_trees([(revision, basis_tree)])
 
2161
        transform.build_tree(basis_tree, wt)
1518
2162
        return wt
1519
2163
 
1520
2164
    def __init__(self):
1532
2176
            raise NotImplementedError
1533
2177
        if not isinstance(a_bzrdir.transport, LocalTransport):
1534
2178
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
1535
 
        return WorkingTree(a_bzrdir.root_transport.base,
 
2179
        return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1536
2180
                           _internal=True,
1537
2181
                           _format=self,
1538
2182
                           _bzrdir=a_bzrdir)
1547
2191
          files, separate from the BzrDir format
1548
2192
        - modifies the hash cache format
1549
2193
        - is new in bzr 0.8
1550
 
        - uses a LockDir to guard access to the repository
 
2194
        - uses a LockDir to guard access for writes.
1551
2195
    """
1552
2196
 
1553
2197
    def get_format_string(self):
1569
2213
    def initialize(self, a_bzrdir, revision_id=None):
1570
2214
        """See WorkingTreeFormat.initialize().
1571
2215
        
1572
 
        revision_id allows creating a working tree at a differnet
 
2216
        revision_id allows creating a working tree at a different
1573
2217
        revision than the branch is at.
1574
2218
        """
1575
2219
        if not isinstance(a_bzrdir.transport, LocalTransport):
1577
2221
        transport = a_bzrdir.get_workingtree_transport(self)
1578
2222
        control_files = self._open_control_files(a_bzrdir)
1579
2223
        control_files.create_lock()
 
2224
        control_files.lock_write()
1580
2225
        control_files.put_utf8('format', self.get_format_string())
1581
2226
        branch = a_bzrdir.open_branch()
1582
2227
        if revision_id is None:
1583
2228
            revision_id = branch.last_revision()
1584
 
        inv = Inventory() 
1585
 
        wt = WorkingTree3(a_bzrdir.root_transport.base,
 
2229
        # WorkingTree3 can handle an inventory which has a unique root id.
 
2230
        # as of bzr 0.12. However, bzr 0.11 and earlier fail to handle
 
2231
        # those trees. And because there isn't a format bump inbetween, we
 
2232
        # are maintaining compatibility with older clients.
 
2233
        # inv = Inventory(root_id=gen_root_id())
 
2234
        inv = Inventory()
 
2235
        wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1586
2236
                         branch,
1587
2237
                         inv,
1588
2238
                         _internal=True,
1589
2239
                         _format=self,
1590
2240
                         _bzrdir=a_bzrdir,
1591
2241
                         _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)
 
2242
        wt.lock_tree_write()
 
2243
        try:
 
2244
            basis_tree = branch.repository.revision_tree(revision_id)
 
2245
            # only set an explicit root id if there is one to set.
 
2246
            if basis_tree.inventory.root is not None:
 
2247
                wt.set_root_id(basis_tree.inventory.root.file_id)
 
2248
            if revision_id == NULL_REVISION:
 
2249
                wt.set_parent_trees([])
 
2250
            else:
 
2251
                wt.set_parent_trees([(revision_id, basis_tree)])
 
2252
            transform.build_tree(basis_tree, wt)
 
2253
        finally:
 
2254
            # Unlock in this order so that the unlock-triggers-flush in
 
2255
            # WorkingTree is given a chance to fire.
 
2256
            control_files.unlock()
 
2257
            wt.unlock()
1597
2258
        return wt
1598
2259
 
1599
2260
    def __init__(self):
1611
2272
            raise NotImplementedError
1612
2273
        if not isinstance(a_bzrdir.transport, LocalTransport):
1613
2274
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
1614
 
        control_files = self._open_control_files(a_bzrdir)
1615
 
        return WorkingTree3(a_bzrdir.root_transport.base,
 
2275
        return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
 
2276
 
 
2277
    def _open(self, a_bzrdir, control_files):
 
2278
        """Open the tree itself.
 
2279
        
 
2280
        :param a_bzrdir: the dir for the tree.
 
2281
        :param control_files: the control files for the tree.
 
2282
        """
 
2283
        return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1616
2284
                           _internal=True,
1617
2285
                           _format=self,
1618
2286
                           _bzrdir=a_bzrdir,
1645
2313
        self._transport_readonly_server = transport_readonly_server
1646
2314
        self._formats = formats
1647
2315
    
 
2316
    def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
 
2317
        """Clone test for adaption."""
 
2318
        new_test = deepcopy(test)
 
2319
        new_test.transport_server = self._transport_server
 
2320
        new_test.transport_readonly_server = self._transport_readonly_server
 
2321
        new_test.bzrdir_format = bzrdir_format
 
2322
        new_test.workingtree_format = workingtree_format
 
2323
        def make_new_test_id():
 
2324
            new_id = "%s(%s)" % (test.id(), variation)
 
2325
            return lambda: new_id
 
2326
        new_test.id = make_new_test_id()
 
2327
        return new_test
 
2328
    
1648
2329
    def adapt(self, test):
1649
2330
        from bzrlib.tests import TestSuite
1650
2331
        result = TestSuite()
1651
2332
        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()
 
2333
            new_test = self._clone_test(
 
2334
                test,
 
2335
                bzrdir_format,
 
2336
                workingtree_format, workingtree_format.__class__.__name__)
1661
2337
            result.addTest(new_test)
1662
2338
        return result