~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

  • Committer: Robert Collins
  • Date: 2005-10-06 22:15:52 UTC
  • mfrom: (1185.13.2)
  • mto: This revision was merged to the branch mainline in revision 1420.
  • Revision ID: robertc@robertcollins.net-20051006221552-9b15c96fa504e0ad
mergeĀ fromĀ upstream

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
2
 
#
 
1
# Copyright (C) 2005 Canonical Ltd
 
2
 
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
#
 
7
 
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
#
 
12
 
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
"""WorkingTree object and friends.
18
 
 
19
 
A WorkingTree represents the editable working copy of a branch.
20
 
Operations which represent the WorkingTree are also done here, 
21
 
such as renaming or adding files.  The WorkingTree has an inventory 
22
 
which is updated by these operations.  A commit produces a 
23
 
new revision based on the workingtree and its inventory.
24
 
 
25
 
At the moment every WorkingTree has its own branch.  Remote
26
 
WorkingTrees aren't supported.
27
 
 
28
 
To get a WorkingTree, call bzrdir.open_workingtree() or
29
 
WorkingTree.open(dir).
30
 
"""
31
 
 
32
 
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
33
 
CONFLICT_HEADER_1 = "BZR conflict list format 1"
34
 
 
35
 
# TODO: Give the workingtree sole responsibility for the working inventory;
36
 
# remove the variable and references to it from the branch.  This may require
37
 
# updating the commit code so as to update the inventory within the working
38
 
# copy, and making sure there's only one WorkingTree for any directory on disk.
39
 
# At the moment they may alias the inventory and have old copies of it in
40
 
# memory.  (Now done? -- mbp 20060309)
41
 
 
42
 
from binascii import hexlify
43
 
import collections
44
 
from copy import deepcopy
45
 
from cStringIO import StringIO
46
 
import errno
47
 
import fnmatch
 
17
# TODO: Don't allow WorkingTrees to be constructed for remote branches.
 
18
 
 
19
# FIXME: I don't know if writing out the cache from the destructor is really a
 
20
# good idea, because destructors are considered poor taste in Python, and
 
21
# it's not predictable when it will be written out.
 
22
 
48
23
import os
49
 
import re
50
24
import stat
51
 
from time import time
52
 
import warnings
53
 
 
54
 
import bzrlib
55
 
from bzrlib import bzrdir, errors, ignores, osutils, urlutils
56
 
from bzrlib.atomicfile import AtomicFile
57
 
import bzrlib.branch
58
 
from bzrlib.conflicts import Conflict, ConflictList, CONFLICT_SUFFIXES
59
 
from bzrlib.decorators import needs_read_lock, needs_write_lock
60
 
from bzrlib.errors import (BzrCheckError,
61
 
                           BzrError,
62
 
                           ConflictFormatError,
63
 
                           WeaveRevisionNotPresent,
64
 
                           NotBranchError,
65
 
                           NoSuchFile,
66
 
                           NotVersionedError,
67
 
                           MergeModifiedFormatError,
68
 
                           UnsupportedOperation,
69
 
                           )
70
 
from bzrlib.inventory import InventoryEntry, Inventory
71
 
from bzrlib.lockable_files import LockableFiles, TransportLock
72
 
from bzrlib.lockdir import LockDir
73
 
from bzrlib.merge import merge_inner, transform_tree
74
 
import bzrlib.mutabletree
75
 
from bzrlib.mutabletree import needs_tree_write_lock
76
 
from bzrlib.osutils import (
77
 
                            abspath,
78
 
                            compact_date,
79
 
                            file_kind,
80
 
                            isdir,
81
 
                            getcwd,
82
 
                            pathjoin,
83
 
                            pumpfile,
84
 
                            safe_unicode,
85
 
                            splitpath,
86
 
                            rand_chars,
87
 
                            normpath,
88
 
                            realpath,
89
 
                            relpath,
90
 
                            rename,
91
 
                            supports_executable,
92
 
                            )
93
 
from bzrlib.progress import DummyProgress, ProgressPhase
94
 
from bzrlib.revision import NULL_REVISION
95
 
import bzrlib.revisiontree
96
 
from bzrlib.rio import RioReader, rio_file, Stanza
97
 
from bzrlib.symbol_versioning import (deprecated_passed,
98
 
        deprecated_method,
99
 
        deprecated_function,
100
 
        DEPRECATED_PARAMETER,
101
 
        zero_eight,
102
 
        zero_eleven,
103
 
        )
104
 
from bzrlib.trace import mutter, note
105
 
from bzrlib.transform import build_tree
106
 
from bzrlib.transport import get_transport
107
 
from bzrlib.transport.local import LocalTransport
108
 
from bzrlib.textui import show_status
109
 
import bzrlib.ui
110
 
import bzrlib.xml5
111
 
 
112
 
 
113
 
# the regex removes any weird characters; we don't escape them 
114
 
# but rather just pull them out
115
 
_gen_file_id_re = re.compile(r'[^\w.]')
116
 
_gen_id_suffix = None
117
 
_gen_id_serial = 0
118
 
 
119
 
 
120
 
def _next_id_suffix():
121
 
    """Create a new file id suffix that is reasonably unique.
122
 
    
123
 
    On the first call we combine the current time with 64 bits of randomness
124
 
    to give a highly probably globally unique number. Then each call in the same
125
 
    process adds 1 to a serial number we append to that unique value.
126
 
    """
127
 
    # XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather 
128
 
    # than having to move the id randomness out of the inner loop like this.
129
 
    # XXX TODO: for the global randomness this uses we should add the thread-id
130
 
    # before the serial #.
131
 
    global _gen_id_suffix, _gen_id_serial
132
 
    if _gen_id_suffix is None:
133
 
        _gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
134
 
    _gen_id_serial += 1
135
 
    return _gen_id_suffix + str(_gen_id_serial)
136
 
 
137
 
 
138
 
def gen_file_id(name):
139
 
    """Return new file id for the basename 'name'.
140
 
 
141
 
    The uniqueness is supplied from _next_id_suffix.
142
 
    """
143
 
    # The real randomness is in the _next_id_suffix, the
144
 
    # rest of the identifier is just to be nice.
145
 
    # So we:
146
 
    # 1) Remove non-ascii word characters to keep the ids portable
147
 
    # 2) squash to lowercase, so the file id doesn't have to
148
 
    #    be escaped (case insensitive filesystems would bork for ids
149
 
    #    that only differred in case without escaping).
150
 
    # 3) truncate the filename to 20 chars. Long filenames also bork on some
151
 
    #    filesystems
152
 
    # 4) Removing starting '.' characters to prevent the file ids from
153
 
    #    being considered hidden.
154
 
    ascii_word_only = _gen_file_id_re.sub('', name.lower())
155
 
    short_no_dots = ascii_word_only.lstrip('.')[:20]
156
 
    return short_no_dots + _next_id_suffix()
157
 
 
158
 
 
159
 
def gen_root_id():
160
 
    """Return a new tree-root file id."""
161
 
    return gen_file_id('TREE_ROOT')
162
 
 
 
25
import fnmatch
 
26
        
 
27
import bzrlib.tree
 
28
from bzrlib.osutils import appendpath, file_kind, isdir, splitpath
 
29
from bzrlib.errors import BzrCheckError
 
30
from bzrlib.trace import mutter
163
31
 
164
32
class TreeEntry(object):
165
 
    """An entry that implements the minimum interface used by commands.
 
33
    """An entry that implements the minium interface used by commands.
166
34
 
167
35
    This needs further inspection, it may be better to have 
168
36
    InventoryEntries without ids - though that seems wrong. For now,
216
84
        return ''
217
85
 
218
86
 
219
 
class WorkingTree(bzrlib.mutabletree.MutableTree):
 
87
class WorkingTree(bzrlib.tree.Tree):
220
88
    """Working copy tree.
221
89
 
222
90
    The inventory is held in the `Branch` working-inventory, and the
225
93
    It is possible for a `WorkingTree` to have a filename which is
226
94
    not listed in the Inventory and vice versa.
227
95
    """
228
 
 
229
 
    def __init__(self, basedir='.',
230
 
                 branch=DEPRECATED_PARAMETER,
231
 
                 _inventory=None,
232
 
                 _control_files=None,
233
 
                 _internal=False,
234
 
                 _format=None,
235
 
                 _bzrdir=None):
236
 
        """Construct a WorkingTree for basedir.
237
 
 
238
 
        If the branch is not supplied, it is opened automatically.
239
 
        If the branch is supplied, it must be the branch for this basedir.
240
 
        (branch.base is not cross checked, because for remote branches that
241
 
        would be meaningless).
242
 
        """
243
 
        self._format = _format
244
 
        self.bzrdir = _bzrdir
245
 
        if not _internal:
246
 
            # not created via open etc.
247
 
            warnings.warn("WorkingTree() is deprecated as of bzr version 0.8. "
248
 
                 "Please use bzrdir.open_workingtree or WorkingTree.open().",
249
 
                 DeprecationWarning,
250
 
                 stacklevel=2)
251
 
            wt = WorkingTree.open(basedir)
252
 
            self._branch = wt.branch
253
 
            self.basedir = wt.basedir
254
 
            self._control_files = wt._control_files
255
 
            self._hashcache = wt._hashcache
256
 
            self._set_inventory(wt._inventory)
257
 
            self._format = wt._format
258
 
            self.bzrdir = wt.bzrdir
 
96
    def __init__(self, basedir, inv):
259
97
        from bzrlib.hashcache import HashCache
260
98
        from bzrlib.trace import note, mutter
261
 
        assert isinstance(basedir, basestring), \
262
 
            "base directory %r is not a string" % basedir
263
 
        basedir = safe_unicode(basedir)
264
 
        mutter("opening working tree %r", basedir)
265
 
        if deprecated_passed(branch):
266
 
            if not _internal:
267
 
                warnings.warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
268
 
                     " Please use bzrdir.open_workingtree() or"
269
 
                     " WorkingTree.open().",
270
 
                     DeprecationWarning,
271
 
                     stacklevel=2
272
 
                     )
273
 
            self._branch = branch
274
 
        else:
275
 
            self._branch = self.bzrdir.open_branch()
276
 
        self.basedir = realpath(basedir)
277
 
        # if branch is at our basedir and is a format 6 or less
278
 
        if isinstance(self._format, WorkingTreeFormat2):
279
 
            # share control object
280
 
            self._control_files = self.branch.control_files
281
 
        else:
282
 
            # assume all other formats have their own control files.
283
 
            assert isinstance(_control_files, LockableFiles), \
284
 
                    "_control_files must be a LockableFiles, not %r" \
285
 
                    % _control_files
286
 
            self._control_files = _control_files
 
99
 
 
100
        self._inventory = inv
 
101
        self.basedir = basedir
 
102
        self.path2id = inv.path2id
 
103
 
287
104
        # update the whole cache up front and write to disk if anything changed;
288
105
        # in the future we might want to do this more selectively
289
 
        # two possible ways offer themselves : in self._unlock, write the cache
290
 
        # if needed, or, when the cache sees a change, append it to the hash
291
 
        # cache file, and have the parser take the most recent entry for a
292
 
        # given path only.
293
 
        cache_filename = self.bzrdir.get_workingtree_transport(None).local_abspath('stat-cache')
294
 
        hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
 
106
        hc = self._hashcache = HashCache(basedir)
295
107
        hc.read()
296
 
        # is this scan needed ? it makes things kinda slow.
297
 
        #hc.scan()
 
108
        hc.scan()
298
109
 
299
110
        if hc.needs_write:
300
111
            mutter("write hc")
301
112
            hc.write()
302
 
 
303
 
        if _inventory is None:
304
 
            self._set_inventory(self.read_working_inventory())
305
 
        else:
306
 
            self._set_inventory(_inventory)
307
 
 
308
 
    branch = property(
309
 
        fget=lambda self: self._branch,
310
 
        doc="""The branch this WorkingTree is connected to.
311
 
 
312
 
            This cannot be set - it is reflective of the actual disk structure
313
 
            the working tree has been constructed from.
314
 
            """)
315
 
 
316
 
    def break_lock(self):
317
 
        """Break a lock if one is present from another instance.
318
 
 
319
 
        Uses the ui factory to ask for confirmation if the lock may be from
320
 
        an active process.
321
 
 
322
 
        This will probe the repository for its lock as well.
323
 
        """
324
 
        self._control_files.break_lock()
325
 
        self.branch.break_lock()
326
 
 
327
 
    def _set_inventory(self, inv):
328
 
        assert inv.root is not None
329
 
        self._inventory = inv
330
 
 
331
 
    @staticmethod
332
 
    def open(path=None, _unsupported=False):
333
 
        """Open an existing working tree at path.
334
 
 
335
 
        """
336
 
        if path is None:
337
 
            path = os.path.getcwdu()
338
 
        control = bzrdir.BzrDir.open(path, _unsupported)
339
 
        return control.open_workingtree(_unsupported)
340
 
        
341
 
    @staticmethod
342
 
    def open_containing(path=None):
343
 
        """Open an existing working tree which has its root about path.
344
 
        
345
 
        This probes for a working tree at path and searches upwards from there.
346
 
 
347
 
        Basically we keep looking up until we find the control directory or
348
 
        run into /.  If there isn't one, raises NotBranchError.
349
 
        TODO: give this a new exception.
350
 
        If there is one, it is returned, along with the unused portion of path.
351
 
 
352
 
        :return: The WorkingTree that contains 'path', and the rest of path
353
 
        """
354
 
        if path is None:
355
 
            path = osutils.getcwd()
356
 
        control, relpath = bzrdir.BzrDir.open_containing(path)
357
 
 
358
 
        return control.open_workingtree(), relpath
359
 
 
360
 
    @staticmethod
361
 
    def open_downlevel(path=None):
362
 
        """Open an unsupported working tree.
363
 
 
364
 
        Only intended for advanced situations like upgrading part of a bzrdir.
365
 
        """
366
 
        return WorkingTree.open(path, _unsupported=True)
 
113
            
 
114
            
 
115
    def __del__(self):
 
116
        if self._hashcache.needs_write:
 
117
            self._hashcache.write()
 
118
 
367
119
 
368
120
    def __iter__(self):
369
121
        """Iterate through file_ids for this tree.
373
125
        """
374
126
        inv = self._inventory
375
127
        for path, ie in inv.iter_entries():
376
 
            if osutils.lexists(self.abspath(path)):
 
128
            if bzrlib.osutils.lexists(self.abspath(path)):
377
129
                yield ie.file_id
378
130
 
 
131
 
379
132
    def __repr__(self):
380
133
        return "<%s of %s>" % (self.__class__.__name__,
381
134
                               getattr(self, 'basedir', None))
382
135
 
 
136
 
 
137
 
383
138
    def abspath(self, filename):
384
 
        return pathjoin(self.basedir, filename)
385
 
    
386
 
    def basis_tree(self):
387
 
        """Return RevisionTree for the current last revision.
388
 
        
389
 
        If the left most parent is a ghost then the returned tree will be an
390
 
        empty tree - one obtained by calling repository.revision_tree(None).
391
 
        """
392
 
        try:
393
 
            revision_id = self.get_parent_ids()[0]
394
 
        except IndexError:
395
 
            # no parents, return an empty revision tree.
396
 
            # in the future this should return the tree for
397
 
            # 'empty:' - the implicit root empty tree.
398
 
            return self.branch.repository.revision_tree(None)
399
 
        else:
400
 
            try:
401
 
                xml = self.read_basis_inventory()
402
 
                inv = bzrlib.xml6.serializer_v6.read_inventory_from_string(xml)
403
 
                if inv is not None and inv.revision_id == revision_id:
404
 
                    return bzrlib.tree.RevisionTree(self.branch.repository, 
405
 
                                                    inv, revision_id)
406
 
            except (NoSuchFile, errors.BadInventoryFormat):
407
 
                pass
408
 
        # No cached copy available, retrieve from the repository.
409
 
        # FIXME? RBC 20060403 should we cache the inventory locally
410
 
        # at this point ?
411
 
        try:
412
 
            return self.branch.repository.revision_tree(revision_id)
413
 
        except errors.RevisionNotPresent:
414
 
            # the basis tree *may* be a ghost or a low level error may have
415
 
            # occured. If the revision is present, its a problem, if its not
416
 
            # its a ghost.
417
 
            if self.branch.repository.has_revision(revision_id):
418
 
                raise
419
 
            # the basis tree is a ghost so return an empty tree.
420
 
            return self.branch.repository.revision_tree(None)
421
 
 
422
 
    @staticmethod
423
 
    @deprecated_method(zero_eight)
424
 
    def create(branch, directory):
425
 
        """Create a workingtree for branch at directory.
426
 
 
427
 
        If existing_directory already exists it must have a .bzr directory.
428
 
        If it does not exist, it will be created.
429
 
 
430
 
        This returns a new WorkingTree object for the new checkout.
431
 
 
432
 
        TODO FIXME RBC 20060124 when we have checkout formats in place this
433
 
        should accept an optional revisionid to checkout [and reject this if
434
 
        checking out into the same dir as a pre-checkout-aware branch format.]
435
 
 
436
 
        XXX: When BzrDir is present, these should be created through that 
437
 
        interface instead.
438
 
        """
439
 
        warnings.warn('delete WorkingTree.create', stacklevel=3)
440
 
        transport = get_transport(directory)
441
 
        if branch.bzrdir.root_transport.base == transport.base:
442
 
            # same dir 
443
 
            return branch.bzrdir.create_workingtree()
444
 
        # different directory, 
445
 
        # create a branch reference
446
 
        # and now a working tree.
447
 
        raise NotImplementedError
448
 
 
449
 
    @staticmethod
450
 
    @deprecated_method(zero_eight)
451
 
    def create_standalone(directory):
452
 
        """Create a checkout and a branch and a repo at directory.
453
 
 
454
 
        Directory must exist and be empty.
455
 
 
456
 
        please use BzrDir.create_standalone_workingtree
457
 
        """
458
 
        return bzrdir.BzrDir.create_standalone_workingtree(directory)
459
 
 
460
 
    def relpath(self, path):
461
 
        """Return the local path portion from a given path.
462
 
        
463
 
        The path may be absolute or relative. If its a relative path it is 
464
 
        interpreted relative to the python current working directory.
465
 
        """
466
 
        return relpath(self.basedir, path)
 
139
        return os.path.join(self.basedir, filename)
467
140
 
468
141
    def has_filename(self, filename):
469
 
        return osutils.lexists(self.abspath(filename))
 
142
        return bzrlib.osutils.lexists(self.abspath(filename))
470
143
 
471
144
    def get_file(self, file_id):
472
145
        return self.get_file_byname(self.id2path(file_id))
473
146
 
474
 
    def get_file_text(self, file_id):
475
 
        return self.get_file(file_id).read()
476
 
 
477
147
    def get_file_byname(self, filename):
478
148
        return file(self.abspath(filename), 'rb')
479
149
 
480
 
    def get_parent_ids(self):
481
 
        """See Tree.get_parent_ids.
482
 
        
483
 
        This implementation reads the pending merges list and last_revision
484
 
        value and uses that to decide what the parents list should be.
485
 
        """
486
 
        last_rev = self._last_revision()
487
 
        if last_rev is None:
488
 
            parents = []
489
 
        else:
490
 
            parents = [last_rev]
491
 
        try:
492
 
            merges_file = self._control_files.get_utf8('pending-merges')
493
 
        except NoSuchFile:
494
 
            pass
495
 
        else:
496
 
            for l in merges_file.readlines():
497
 
                parents.append(l.rstrip('\n'))
498
 
        return parents
499
 
 
500
 
    def get_root_id(self):
501
 
        """Return the id of this trees root"""
502
 
        inv = self.read_working_inventory()
503
 
        return inv.root.file_id
504
 
        
505
150
    def _get_store_filename(self, file_id):
506
 
        ## XXX: badly named; this is not in the store at all
 
151
        ## XXX: badly named; this isn't in the store at all
507
152
        return self.abspath(self.id2path(file_id))
508
153
 
509
 
    @needs_read_lock
510
 
    def clone(self, to_bzrdir, revision_id=None, basis=None):
511
 
        """Duplicate this working tree into to_bzr, including all state.
512
 
        
513
 
        Specifically modified files are kept as modified, but
514
 
        ignored and unknown files are discarded.
515
 
 
516
 
        If you want to make a new line of development, see bzrdir.sprout()
517
 
 
518
 
        revision
519
 
            If not None, the cloned tree will have its last revision set to 
520
 
            revision, and and difference between the source trees last revision
521
 
            and this one merged in.
522
 
 
523
 
        basis
524
 
            If not None, a closer copy of a tree which may have some files in
525
 
            common, and which file content should be preferentially copied from.
526
 
        """
527
 
        # assumes the target bzr dir format is compatible.
528
 
        result = self._format.initialize(to_bzrdir)
529
 
        self.copy_content_into(result, revision_id)
530
 
        return result
531
 
 
532
 
    @needs_read_lock
533
 
    def copy_content_into(self, tree, revision_id=None):
534
 
        """Copy the current content and user files of this tree into tree."""
535
 
        if revision_id is None:
536
 
            transform_tree(tree, self)
537
 
        else:
538
 
            # TODO now merge from tree.last_revision to revision (to preserve
539
 
            # user local changes)
540
 
            transform_tree(tree, self)
541
 
            tree.set_parent_ids([revision_id])
542
154
 
543
155
    def id2abspath(self, file_id):
544
156
        return self.abspath(self.id2path(file_id))
545
157
 
 
158
                
546
159
    def has_id(self, file_id):
547
160
        # files that have been deleted are excluded
548
161
        inv = self._inventory
549
162
        if not inv.has_id(file_id):
550
163
            return False
551
164
        path = inv.id2path(file_id)
552
 
        return osutils.lexists(self.abspath(path))
 
165
        return bzrlib.osutils.lexists(self.abspath(path))
553
166
 
554
 
    def has_or_had_id(self, file_id):
555
 
        if file_id == self.inventory.root.file_id:
556
 
            return True
557
 
        return self.inventory.has_id(file_id)
558
167
 
559
168
    __contains__ = has_id
 
169
    
560
170
 
561
171
    def get_file_size(self, file_id):
562
172
        return os.path.getsize(self.id2abspath(file_id))
563
173
 
564
 
    @needs_read_lock
565
 
    def get_file_sha1(self, file_id, path=None):
566
 
        if not path:
567
 
            path = self._inventory.id2path(file_id)
 
174
    def get_file_sha1(self, file_id):
 
175
        path = self._inventory.id2path(file_id)
568
176
        return self._hashcache.get_sha1(path)
569
177
 
570
 
    def get_file_mtime(self, file_id, path=None):
571
 
        if not path:
572
 
            path = self._inventory.id2path(file_id)
573
 
        return os.lstat(self.abspath(path)).st_mtime
574
178
 
575
 
    if not supports_executable():
576
 
        def is_executable(self, file_id, path=None):
 
179
    def is_executable(self, file_id):
 
180
        if os.name == "nt":
577
181
            return self._inventory[file_id].executable
578
 
    else:
579
 
        def is_executable(self, file_id, path=None):
580
 
            if not path:
581
 
                path = self._inventory.id2path(file_id)
 
182
        else:
 
183
            path = self._inventory.id2path(file_id)
582
184
            mode = os.lstat(self.abspath(path)).st_mode
583
 
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC & mode)
584
 
 
585
 
    @needs_write_lock
586
 
    def _add(self, files, ids, kinds):
587
 
        """See MutableTree._add."""
588
 
        # TODO: Re-adding a file that is removed in the working copy
589
 
        # should probably put it back with the previous ID.
590
 
        # the read and write working inventory should not occur in this 
591
 
        # function - they should be part of lock_write and unlock.
592
 
        inv = self.read_working_inventory()
593
 
        for f, file_id, kind in zip(files, ids, kinds):
594
 
            assert kind is not None
595
 
            if file_id is None:
596
 
                inv.add_path(f, kind=kind)
597
 
            else:
598
 
                inv.add_path(f, kind=kind, file_id=file_id)
599
 
        self._write_inventory(inv)
600
 
 
601
 
    @needs_tree_write_lock
602
 
    def _gather_kinds(self, files, kinds):
603
 
        """See MutableTree._gather_kinds."""
604
 
        for pos, f in enumerate(files):
605
 
            if kinds[pos] is None:
606
 
                fullpath = normpath(self.abspath(f))
607
 
                try:
608
 
                    kinds[pos] = file_kind(fullpath)
609
 
                except OSError, e:
610
 
                    if e.errno == errno.ENOENT:
611
 
                        raise NoSuchFile(fullpath)
612
 
 
613
 
    @needs_write_lock
614
 
    def add_parent_tree_id(self, revision_id, allow_leftmost_as_ghost=False):
615
 
        """Add revision_id as a parent.
616
 
 
617
 
        This is equivalent to retrieving the current list of parent ids
618
 
        and setting the list to its value plus revision_id.
619
 
 
620
 
        :param revision_id: The revision id to add to the parent list. It may
621
 
        be a ghost revision as long as its not the first parent to be added,
622
 
        or the allow_leftmost_as_ghost parameter is set True.
623
 
        :param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
624
 
        """
625
 
        parents = self.get_parent_ids() + [revision_id]
626
 
        self.set_parent_ids(parents,
627
 
            allow_leftmost_as_ghost=len(parents) > 1 or allow_leftmost_as_ghost)
628
 
 
629
 
    @needs_tree_write_lock
630
 
    def add_parent_tree(self, parent_tuple, allow_leftmost_as_ghost=False):
631
 
        """Add revision_id, tree tuple as a parent.
632
 
 
633
 
        This is equivalent to retrieving the current list of parent trees
634
 
        and setting the list to its value plus parent_tuple. See also
635
 
        add_parent_tree_id - if you only have a parent id available it will be
636
 
        simpler to use that api. If you have the parent already available, using
637
 
        this api is preferred.
638
 
 
639
 
        :param parent_tuple: The (revision id, tree) to add to the parent list.
640
 
            If the revision_id is a ghost, pass None for the tree.
641
 
        :param allow_leftmost_as_ghost: Allow the first parent to be a ghost.
642
 
        """
643
 
        parent_ids = self.get_parent_ids() + [parent_tuple[0]]
644
 
        if len(parent_ids) > 1:
645
 
            # the leftmost may have already been a ghost, preserve that if it
646
 
            # was.
647
 
            allow_leftmost_as_ghost = True
648
 
        self.set_parent_ids(parent_ids,
649
 
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
650
 
 
651
 
    @needs_tree_write_lock
652
 
    def add_pending_merge(self, *revision_ids):
653
 
        # TODO: Perhaps should check at this point that the
654
 
        # history of the revision is actually present?
655
 
        parents = self.get_parent_ids()
656
 
        updated = False
657
 
        for rev_id in revision_ids:
658
 
            if rev_id in parents:
659
 
                continue
660
 
            parents.append(rev_id)
661
 
            updated = True
662
 
        if updated:
663
 
            self.set_parent_ids(parents, allow_leftmost_as_ghost=True)
664
 
 
665
 
    @deprecated_method(zero_eleven)
666
 
    @needs_read_lock
667
 
    def pending_merges(self):
668
 
        """Return a list of pending merges.
669
 
 
670
 
        These are revisions that have been merged into the working
671
 
        directory but not yet committed.
672
 
 
673
 
        As of 0.11 this is deprecated. Please see WorkingTree.get_parent_ids()
674
 
        instead - which is available on all tree objects.
675
 
        """
676
 
        return self.get_parent_ids()[1:]
677
 
 
678
 
    @needs_tree_write_lock
679
 
    def set_parent_ids(self, revision_ids, allow_leftmost_as_ghost=False):
680
 
        """Set the parent ids to revision_ids.
681
 
        
682
 
        See also set_parent_trees. This api will try to retrieve the tree data
683
 
        for each element of revision_ids from the trees repository. If you have
684
 
        tree data already available, it is more efficient to use
685
 
        set_parent_trees rather than set_parent_ids. set_parent_ids is however
686
 
        an easier API to use.
687
 
 
688
 
        :param revision_ids: The revision_ids to set as the parent ids of this
689
 
            working tree. Any of these may be ghosts.
690
 
        """
691
 
        if len(revision_ids) > 0:
692
 
            leftmost_id = revision_ids[0]
693
 
            if (not allow_leftmost_as_ghost and not
694
 
                self.branch.repository.has_revision(leftmost_id)):
695
 
                raise errors.GhostRevisionUnusableHere(leftmost_id)
696
 
            self.set_last_revision(leftmost_id)
697
 
        else:
698
 
            self.set_last_revision(None)
699
 
        merges = revision_ids[1:]
700
 
        self._control_files.put_utf8('pending-merges', '\n'.join(merges))
701
 
 
702
 
    @needs_tree_write_lock
703
 
    def set_parent_trees(self, parents_list, allow_leftmost_as_ghost=False):
704
 
        """See MutableTree.set_parent_trees."""
705
 
        # parent trees are not used in current format trees, delegate to
706
 
        # set_parent_ids
707
 
        self.set_parent_ids([rev for (rev, tree) in parents_list],
708
 
            allow_leftmost_as_ghost=allow_leftmost_as_ghost)
709
 
 
710
 
    @needs_tree_write_lock
711
 
    def set_pending_merges(self, rev_list):
712
 
        parents = self.get_parent_ids()
713
 
        leftmost = parents[:1]
714
 
        new_parents = leftmost + rev_list
715
 
        self.set_parent_ids(new_parents)
716
 
 
717
 
    @needs_tree_write_lock
718
 
    def set_merge_modified(self, modified_hashes):
719
 
        def iter_stanzas():
720
 
            for file_id, hash in modified_hashes.iteritems():
721
 
                yield Stanza(file_id=file_id, hash=hash)
722
 
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
723
 
 
724
 
    @needs_tree_write_lock
725
 
    def _put_rio(self, filename, stanzas, header):
726
 
        my_file = rio_file(stanzas, header)
727
 
        self._control_files.put(filename, my_file)
728
 
 
729
 
    @needs_write_lock # because merge pulls data into the branch.
730
 
    def merge_from_branch(self, branch, to_revision=None):
731
 
        """Merge from a branch into this working tree.
732
 
 
733
 
        :param branch: The branch to merge from.
734
 
        :param to_revision: If non-None, the merge will merge to to_revision, but 
735
 
            not beyond it. to_revision does not need to be in the history of
736
 
            the branch when it is supplied. If None, to_revision defaults to
737
 
            branch.last_revision().
738
 
        """
739
 
        from bzrlib.merge import Merger, Merge3Merger
740
 
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
741
 
        try:
742
 
            merger = Merger(self.branch, this_tree=self, pb=pb)
743
 
            merger.pp = ProgressPhase("Merge phase", 5, pb)
744
 
            merger.pp.next_phase()
745
 
            # check that there are no
746
 
            # local alterations
747
 
            merger.check_basis(check_clean=True, require_commits=False)
748
 
            if to_revision is None:
749
 
                to_revision = branch.last_revision()
750
 
            merger.other_rev_id = to_revision
751
 
            if merger.other_rev_id is None:
752
 
                raise error.NoCommits(branch)
753
 
            self.branch.fetch(branch, last_revision=merger.other_rev_id)
754
 
            merger.other_basis = merger.other_rev_id
755
 
            merger.other_tree = self.branch.repository.revision_tree(
756
 
                merger.other_rev_id)
757
 
            merger.pp.next_phase()
758
 
            merger.find_base()
759
 
            if merger.base_rev_id == merger.other_rev_id:
760
 
                raise errors.PointlessMerge
761
 
            merger.backup_files = False
762
 
            merger.merge_type = Merge3Merger
763
 
            merger.set_interesting_files(None)
764
 
            merger.show_base = False
765
 
            merger.reprocess = False
766
 
            conflicts = merger.do_merge()
767
 
            merger.set_pending()
768
 
        finally:
769
 
            pb.finished()
770
 
        return conflicts
771
 
 
772
 
    @needs_read_lock
773
 
    def merge_modified(self):
774
 
        try:
775
 
            hashfile = self._control_files.get('merge-hashes')
776
 
        except NoSuchFile:
777
 
            return {}
778
 
        merge_hashes = {}
779
 
        try:
780
 
            if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
781
 
                raise MergeModifiedFormatError()
782
 
        except StopIteration:
783
 
            raise MergeModifiedFormatError()
784
 
        for s in RioReader(hashfile):
785
 
            file_id = s.get("file_id")
786
 
            if file_id not in self.inventory:
787
 
                continue
788
 
            hash = s.get("hash")
789
 
            if hash == self.get_file_sha1(file_id):
790
 
                merge_hashes[file_id] = hash
791
 
        return merge_hashes
792
 
 
793
 
    @needs_write_lock
794
 
    def mkdir(self, path, file_id=None):
795
 
        """See MutableTree.mkdir()."""
796
 
        if file_id is None:
797
 
            file_id = gen_file_id(os.path.basename(path))
798
 
        os.mkdir(self.abspath(path))
799
 
        self.add(path, file_id, 'directory')
800
 
        return file_id
 
185
            return bool(stat.S_ISREG(mode) and stat.S_IEXEC&mode)
801
186
 
802
187
    def get_symlink_target(self, file_id):
803
 
        return os.readlink(self.id2abspath(file_id))
 
188
        return os.readlink(self.id2path(file_id))
804
189
 
805
190
    def file_class(self, filename):
806
191
        if self.path2id(filename):
810
195
        else:
811
196
            return '?'
812
197
 
 
198
 
813
199
    def list_files(self):
814
 
        """Recursively list all files as (path, class, kind, id, entry).
 
200
        """Recursively list all files as (path, class, kind, id).
815
201
 
816
202
        Lists, but does not descend into unversioned directories.
817
203
 
821
207
        Skips the control directory.
822
208
        """
823
209
        inv = self._inventory
824
 
        # Convert these into local objects to save lookup times
825
 
        pathjoin = osutils.pathjoin
826
 
        file_kind = osutils.file_kind
827
 
 
828
 
        # transport.base ends in a slash, we want the piece
829
 
        # between the last two slashes
830
 
        transport_base_dir = self.bzrdir.transport.base.rsplit('/', 2)[1]
831
 
 
832
 
        fk_entries = {'directory':TreeDirectory, 'file':TreeFile, 'symlink':TreeLink}
833
 
 
834
 
        # directory file_id, relative path, absolute path, reverse sorted children
835
 
        children = os.listdir(self.basedir)
836
 
        children.sort()
837
 
        # jam 20060527 The kernel sized tree seems equivalent whether we 
838
 
        # use a deque and popleft to keep them sorted, or if we use a plain
839
 
        # list and just reverse() them.
840
 
        children = collections.deque(children)
841
 
        stack = [(inv.root.file_id, u'', self.basedir, children)]
842
 
        while stack:
843
 
            from_dir_id, from_dir_relpath, from_dir_abspath, children = stack[-1]
844
 
 
845
 
            while children:
846
 
                f = children.popleft()
 
210
 
 
211
        def descend(from_dir_relpath, from_dir_id, dp):
 
212
            ls = os.listdir(dp)
 
213
            ls.sort()
 
214
            for f in ls:
847
215
                ## TODO: If we find a subdirectory with its own .bzr
848
216
                ## directory, then that is a separate tree and we
849
217
                ## should exclude it.
850
 
 
851
 
                # the bzrdir for this tree
852
 
                if transport_base_dir == f:
 
218
                if bzrlib.BZRDIR == f:
853
219
                    continue
854
220
 
855
 
                # we know that from_dir_relpath and from_dir_abspath never end in a slash
856
 
                # and 'f' doesn't begin with one, we can do a string op, rather
857
 
                # than the checks of pathjoin(), all relative paths will have an extra slash
858
 
                # at the beginning
859
 
                fp = from_dir_relpath + '/' + f
 
221
                # path within tree
 
222
                fp = appendpath(from_dir_relpath, f)
860
223
 
861
224
                # absolute path
862
 
                fap = from_dir_abspath + '/' + f
 
225
                fap = appendpath(dp, f)
863
226
                
864
227
                f_ie = inv.get_child(from_dir_id, f)
865
228
                if f_ie:
866
229
                    c = 'V'
867
 
                elif self.is_ignored(fp[1:]):
 
230
                elif self.is_ignored(fp):
868
231
                    c = 'I'
869
232
                else:
870
 
                    # we may not have found this file, because of a unicode issue
871
 
                    f_norm, can_access = osutils.normalized_filename(f)
872
 
                    if f == f_norm or not can_access:
873
 
                        # No change, so treat this file normally
874
 
                        c = '?'
875
 
                    else:
876
 
                        # this file can be accessed by a normalized path
877
 
                        # check again if it is versioned
878
 
                        # these lines are repeated here for performance
879
 
                        f = f_norm
880
 
                        fp = from_dir_relpath + '/' + f
881
 
                        fap = from_dir_abspath + '/' + f
882
 
                        f_ie = inv.get_child(from_dir_id, f)
883
 
                        if f_ie:
884
 
                            c = 'V'
885
 
                        elif self.is_ignored(fp[1:]):
886
 
                            c = 'I'
887
 
                        else:
888
 
                            c = '?'
 
233
                    c = '?'
889
234
 
890
235
                fk = file_kind(fap)
891
236
 
897
242
 
898
243
                # make a last minute entry
899
244
                if f_ie:
900
 
                    yield fp[1:], c, fk, f_ie.file_id, f_ie
 
245
                    entry = f_ie
901
246
                else:
902
 
                    try:
903
 
                        yield fp[1:], c, fk, None, fk_entries[fk]()
904
 
                    except KeyError:
905
 
                        yield fp[1:], c, fk, None, TreeEntry()
906
 
                    continue
 
247
                    if fk == 'directory':
 
248
                        entry = TreeDirectory()
 
249
                    elif fk == 'file':
 
250
                        entry = TreeFile()
 
251
                    elif fk == 'symlink':
 
252
                        entry = TreeLink()
 
253
                    else:
 
254
                        entry = TreeEntry()
907
255
                
 
256
                yield fp, c, fk, (f_ie and f_ie.file_id), entry
 
257
 
908
258
                if fk != 'directory':
909
259
                    continue
910
260
 
911
 
                # But do this child first
912
 
                new_children = os.listdir(fap)
913
 
                new_children.sort()
914
 
                new_children = collections.deque(new_children)
915
 
                stack.append((f_ie.file_id, fp, fap, new_children))
916
 
                # Break out of inner loop, so that we start outer loop with child
917
 
                break
918
 
            else:
919
 
                # if we finished all children, pop it off the stack
920
 
                stack.pop()
921
 
 
922
 
    @needs_tree_write_lock
923
 
    def move(self, from_paths, to_name):
924
 
        """Rename files.
925
 
 
926
 
        to_name must exist in the inventory.
927
 
 
928
 
        If to_name exists and is a directory, the files are moved into
929
 
        it, keeping their old names.  
930
 
 
931
 
        Note that to_name is only the last component of the new name;
932
 
        this doesn't change the directory.
933
 
 
934
 
        This returns a list of (from_path, to_path) pairs for each
935
 
        entry that is moved.
936
 
        """
937
 
        result = []
938
 
        ## TODO: Option to move IDs only
939
 
        assert not isinstance(from_paths, basestring)
940
 
        inv = self.inventory
941
 
        to_abs = self.abspath(to_name)
942
 
        if not isdir(to_abs):
943
 
            raise BzrError("destination %r is not a directory" % to_abs)
944
 
        if not self.has_filename(to_name):
945
 
            raise BzrError("destination %r not in working directory" % to_abs)
946
 
        to_dir_id = inv.path2id(to_name)
947
 
        if to_dir_id is None and to_name != '':
948
 
            raise BzrError("destination %r is not a versioned directory" % to_name)
949
 
        to_dir_ie = inv[to_dir_id]
950
 
        if to_dir_ie.kind != 'directory':
951
 
            raise BzrError("destination %r is not a directory" % to_abs)
952
 
 
953
 
        to_idpath = inv.get_idpath(to_dir_id)
954
 
 
955
 
        for f in from_paths:
956
 
            if not self.has_filename(f):
957
 
                raise BzrError("%r does not exist in working tree" % f)
958
 
            f_id = inv.path2id(f)
959
 
            if f_id is None:
960
 
                raise BzrError("%r is not versioned" % f)
961
 
            name_tail = splitpath(f)[-1]
962
 
            dest_path = pathjoin(to_name, name_tail)
963
 
            if self.has_filename(dest_path):
964
 
                raise BzrError("destination %r already exists" % dest_path)
965
 
            if f_id in to_idpath:
966
 
                raise BzrError("can't move %r to a subdirectory of itself" % f)
967
 
 
968
 
        # OK, so there's a race here, it's possible that someone will
969
 
        # create a file in this interval and then the rename might be
970
 
        # left half-done.  But we should have caught most problems.
971
 
        orig_inv = deepcopy(self.inventory)
972
 
        try:
973
 
            for f in from_paths:
974
 
                name_tail = splitpath(f)[-1]
975
 
                dest_path = pathjoin(to_name, name_tail)
976
 
                result.append((f, dest_path))
977
 
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
978
 
                try:
979
 
                    rename(self.abspath(f), self.abspath(dest_path))
980
 
                except OSError, e:
981
 
                    raise BzrError("failed to rename %r to %r: %s" %
982
 
                                   (f, dest_path, e[1]),
983
 
                            ["rename rolled back"])
984
 
        except:
985
 
            # restore the inventory on error
986
 
            self._set_inventory(orig_inv)
987
 
            raise
988
 
        self._write_inventory(inv)
989
 
        return result
990
 
 
991
 
    @needs_tree_write_lock
992
 
    def rename_one(self, from_rel, to_rel):
993
 
        """Rename one file.
994
 
 
995
 
        This can change the directory or the filename or both.
996
 
        """
997
 
        inv = self.inventory
998
 
        if not self.has_filename(from_rel):
999
 
            raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1000
 
        if self.has_filename(to_rel):
1001
 
            raise BzrError("can't rename: new working file %r already exists" % to_rel)
1002
 
 
1003
 
        file_id = inv.path2id(from_rel)
1004
 
        if file_id is None:
1005
 
            raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1006
 
 
1007
 
        entry = inv[file_id]
1008
 
        from_parent = entry.parent_id
1009
 
        from_name = entry.name
1010
 
        
1011
 
        if inv.path2id(to_rel):
1012
 
            raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1013
 
 
1014
 
        to_dir, to_tail = os.path.split(to_rel)
1015
 
        to_dir_id = inv.path2id(to_dir)
1016
 
        if to_dir_id is None and to_dir != '':
1017
 
            raise BzrError("can't determine destination directory id for %r" % to_dir)
1018
 
 
1019
 
        mutter("rename_one:")
1020
 
        mutter("  file_id    {%s}" % file_id)
1021
 
        mutter("  from_rel   %r" % from_rel)
1022
 
        mutter("  to_rel     %r" % to_rel)
1023
 
        mutter("  to_dir     %r" % to_dir)
1024
 
        mutter("  to_dir_id  {%s}" % to_dir_id)
1025
 
 
1026
 
        inv.rename(file_id, to_dir_id, to_tail)
1027
 
 
1028
 
        from_abs = self.abspath(from_rel)
1029
 
        to_abs = self.abspath(to_rel)
1030
 
        try:
1031
 
            rename(from_abs, to_abs)
1032
 
        except OSError, e:
1033
 
            inv.rename(file_id, from_parent, from_name)
1034
 
            raise BzrError("failed to rename %r to %r: %s"
1035
 
                    % (from_abs, to_abs, e[1]),
1036
 
                    ["rename rolled back"])
1037
 
        self._write_inventory(inv)
1038
 
 
1039
 
    @needs_read_lock
 
261
                if c != 'V':
 
262
                    # don't descend unversioned directories
 
263
                    continue
 
264
                
 
265
                for ff in descend(fp, f_ie.file_id, fap):
 
266
                    yield ff
 
267
 
 
268
        for f in descend('', inv.root.file_id, self.basedir):
 
269
            yield f
 
270
            
 
271
 
 
272
 
1040
273
    def unknowns(self):
1041
 
        """Return all unknown files.
1042
 
 
1043
 
        These are files in the working directory that are not versioned or
1044
 
        control files or ignored.
1045
 
        """
1046
274
        for subp in self.extras():
1047
275
            if not self.is_ignored(subp):
1048
276
                yield subp
1049
 
    
1050
 
    @needs_tree_write_lock
1051
 
    def unversion(self, file_ids):
1052
 
        """Remove the file ids in file_ids from the current versioned set.
1053
 
 
1054
 
        When a file_id is unversioned, all of its children are automatically
1055
 
        unversioned.
1056
 
 
1057
 
        :param file_ids: The file ids to stop versioning.
1058
 
        :raises: NoSuchId if any fileid is not currently versioned.
1059
 
        """
1060
 
        for file_id in file_ids:
1061
 
            if self._inventory.has_id(file_id):
1062
 
                self._inventory.remove_recursive_id(file_id)
1063
 
            else:
1064
 
                raise errors.NoSuchId(self, file_id)
1065
 
        if len(file_ids):
1066
 
            # in the future this should just set a dirty bit to wait for the 
1067
 
            # final unlock. However, until all methods of workingtree start
1068
 
            # with the current in -memory inventory rather than triggering 
1069
 
            # a read, it is more complex - we need to teach read_inventory
1070
 
            # to know when to read, and when to not read first... and possibly
1071
 
            # to save first when the in memory one may be corrupted.
1072
 
            # so for now, we just only write it if it is indeed dirty.
1073
 
            # - RBC 20060907
1074
 
            self._write_inventory(self._inventory)
1075
 
    
1076
 
    @deprecated_method(zero_eight)
 
277
 
1077
278
    def iter_conflicts(self):
1078
 
        """List all files in the tree that have text or content conflicts.
1079
 
        DEPRECATED.  Use conflicts instead."""
1080
 
        return self._iter_conflicts()
1081
 
 
1082
 
    def _iter_conflicts(self):
1083
279
        conflicted = set()
1084
 
        for info in self.list_files():
1085
 
            path = info[0]
 
280
        for path in (s[0] for s in self.list_files()):
1086
281
            stem = get_conflicted_stem(path)
1087
282
            if stem is None:
1088
283
                continue
1090
285
                conflicted.add(stem)
1091
286
                yield stem
1092
287
 
1093
 
    @needs_write_lock
1094
 
    def pull(self, source, overwrite=False, stop_revision=None):
1095
 
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
1096
 
        source.lock_read()
1097
 
        try:
1098
 
            pp = ProgressPhase("Pull phase", 2, top_pb)
1099
 
            pp.next_phase()
1100
 
            old_revision_history = self.branch.revision_history()
1101
 
            basis_tree = self.basis_tree()
1102
 
            count = self.branch.pull(source, overwrite, stop_revision)
1103
 
            new_revision_history = self.branch.revision_history()
1104
 
            if new_revision_history != old_revision_history:
1105
 
                pp.next_phase()
1106
 
                if len(old_revision_history):
1107
 
                    other_revision = old_revision_history[-1]
1108
 
                else:
1109
 
                    other_revision = None
1110
 
                repository = self.branch.repository
1111
 
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
1112
 
                try:
1113
 
                    new_basis_tree = self.branch.basis_tree()
1114
 
                    merge_inner(self.branch,
1115
 
                                new_basis_tree,
1116
 
                                basis_tree,
1117
 
                                this_tree=self,
1118
 
                                pb=pb)
1119
 
                finally:
1120
 
                    pb.finished()
1121
 
                # TODO - dedup parents list with things merged by pull ?
1122
 
                # reuse the revisiontree we merged against to set the new
1123
 
                # tree data.
1124
 
                parent_trees = [(self.branch.last_revision(), new_basis_tree)]
1125
 
                # we have to pull the merge trees out again, because 
1126
 
                # merge_inner has set the ids. - this corner is not yet 
1127
 
                # layered well enough to prevent double handling.
1128
 
                merges = self.get_parent_ids()[1:]
1129
 
                parent_trees.extend([
1130
 
                    (parent, repository.revision_tree(parent)) for
1131
 
                     parent in merges])
1132
 
                self.set_parent_trees(parent_trees)
1133
 
            return count
1134
 
        finally:
1135
 
            source.unlock()
1136
 
            top_pb.finished()
1137
 
 
1138
 
    @needs_write_lock
1139
 
    def put_file_bytes_non_atomic(self, file_id, bytes):
1140
 
        """See MutableTree.put_file_bytes_non_atomic."""
1141
 
        stream = file(self.id2abspath(file_id), 'wb')
1142
 
        try:
1143
 
            stream.write(bytes)
1144
 
        finally:
1145
 
            stream.close()
1146
 
        # TODO: update the hashcache here ?
1147
 
 
1148
288
    def extras(self):
1149
289
        """Yield all unknown files in this WorkingTree.
1150
290
 
1156
296
        """
1157
297
        ## TODO: Work from given directory downwards
1158
298
        for path, dir_entry in self.inventory.directories():
1159
 
            # mutter("search for unknowns in %r", path)
 
299
            mutter("search for unknowns in %r" % path)
1160
300
            dirabs = self.abspath(path)
1161
301
            if not isdir(dirabs):
1162
302
                # e.g. directory deleted
1164
304
 
1165
305
            fl = []
1166
306
            for subf in os.listdir(dirabs):
1167
 
                if subf == '.bzr':
1168
 
                    continue
1169
 
                if subf not in dir_entry.children:
1170
 
                    subf_norm, can_access = osutils.normalized_filename(subf)
1171
 
                    if subf_norm != subf and can_access:
1172
 
                        if subf_norm not in dir_entry.children:
1173
 
                            fl.append(subf_norm)
1174
 
                    else:
1175
 
                        fl.append(subf)
 
307
                if (subf != '.bzr'
 
308
                    and (subf not in dir_entry.children)):
 
309
                    fl.append(subf)
1176
310
            
1177
311
            fl.sort()
1178
312
            for subf in fl:
1179
 
                subp = pathjoin(path, subf)
 
313
                subp = appendpath(path, subf)
1180
314
                yield subp
1181
315
 
1182
 
    def _translate_ignore_rule(self, rule):
1183
 
        """Translate a single ignore rule to a regex.
1184
 
 
1185
 
        There are two types of ignore rules.  Those that do not contain a / are
1186
 
        matched against the tail of the filename (that is, they do not care
1187
 
        what directory the file is in.)  Rules which do contain a slash must
1188
 
        match the entire path.  As a special case, './' at the start of the
1189
 
        string counts as a slash in the string but is removed before matching
1190
 
        (e.g. ./foo.c, ./src/foo.c)
1191
 
 
1192
 
        :return: The translated regex.
1193
 
        """
1194
 
        if rule[:2] in ('./', '.\\'):
1195
 
            # rootdir rule
1196
 
            result = fnmatch.translate(rule[2:])
1197
 
        elif '/' in rule or '\\' in rule:
1198
 
            # path prefix 
1199
 
            result = fnmatch.translate(rule)
1200
 
        else:
1201
 
            # default rule style.
1202
 
            result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
1203
 
        assert result[-1] == '$', "fnmatch.translate did not add the expected $"
1204
 
        return "(" + result + ")"
1205
 
 
1206
 
    def _combine_ignore_rules(self, rules):
1207
 
        """Combine a list of ignore rules into a single regex object.
1208
 
 
1209
 
        Each individual rule is combined with | to form a big regex, which then
1210
 
        has $ added to it to form something like ()|()|()$. The group index for
1211
 
        each subregex's outermost group is placed in a dictionary mapping back 
1212
 
        to the rule. This allows quick identification of the matching rule that
1213
 
        triggered a match.
1214
 
        :return: a list of the compiled regex and the matching-group index 
1215
 
        dictionaries. We return a list because python complains if you try to 
1216
 
        combine more than 100 regexes.
1217
 
        """
1218
 
        result = []
1219
 
        groups = {}
1220
 
        next_group = 0
1221
 
        translated_rules = []
1222
 
        for rule in rules:
1223
 
            translated_rule = self._translate_ignore_rule(rule)
1224
 
            compiled_rule = re.compile(translated_rule)
1225
 
            groups[next_group] = rule
1226
 
            next_group += compiled_rule.groups
1227
 
            translated_rules.append(translated_rule)
1228
 
            if next_group == 99:
1229
 
                result.append((re.compile("|".join(translated_rules)), groups))
1230
 
                groups = {}
1231
 
                next_group = 0
1232
 
                translated_rules = []
1233
 
        if len(translated_rules):
1234
 
            result.append((re.compile("|".join(translated_rules)), groups))
1235
 
        return result
1236
316
 
1237
317
    def ignored_files(self):
1238
318
        """Yield list of PATH, IGNORE_PATTERN"""
1239
319
        for subp in self.extras():
1240
320
            pat = self.is_ignored(subp)
1241
 
            if pat is not None:
 
321
            if pat != None:
1242
322
                yield subp, pat
1243
323
 
 
324
 
1244
325
    def get_ignore_list(self):
1245
326
        """Return list of ignore patterns.
1246
327
 
1247
328
        Cached in the Tree object after the first call.
1248
329
        """
1249
 
        ignoreset = getattr(self, '_ignoreset', None)
1250
 
        if ignoreset is not None:
1251
 
            return ignoreset
1252
 
 
1253
 
        ignore_globs = set(bzrlib.DEFAULT_IGNORE)
1254
 
        ignore_globs.update(ignores.get_runtime_ignores())
1255
 
 
1256
 
        ignore_globs.update(ignores.get_user_ignores())
1257
 
 
 
330
        if hasattr(self, '_ignorelist'):
 
331
            return self._ignorelist
 
332
 
 
333
        l = bzrlib.DEFAULT_IGNORE[:]
1258
334
        if self.has_filename(bzrlib.IGNORE_FILENAME):
1259
335
            f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1260
 
            try:
1261
 
                ignore_globs.update(ignores.parse_ignore_file(f))
1262
 
            finally:
1263
 
                f.close()
1264
 
 
1265
 
        self._ignoreset = ignore_globs
1266
 
        self._ignore_regex = self._combine_ignore_rules(ignore_globs)
1267
 
        return ignore_globs
1268
 
 
1269
 
    def _get_ignore_rules_as_regex(self):
1270
 
        """Return a regex of the ignore rules and a mapping dict.
1271
 
 
1272
 
        :return: (ignore rules compiled regex, dictionary mapping rule group 
1273
 
        indices to original rule.)
1274
 
        """
1275
 
        if getattr(self, '_ignoreset', None) is None:
1276
 
            self.get_ignore_list()
1277
 
        return self._ignore_regex
 
336
            l.extend([line.rstrip("\n\r") for line in f.readlines()])
 
337
        self._ignorelist = l
 
338
        return l
 
339
 
1278
340
 
1279
341
    def is_ignored(self, filename):
1280
342
        r"""Check whether the filename matches an ignore pattern.
1294
356
        # treat dotfiles correctly and allows * to match /.
1295
357
        # Eventually it should be replaced with something more
1296
358
        # accurate.
1297
 
    
1298
 
        rules = self._get_ignore_rules_as_regex()
1299
 
        for regex, mapping in rules:
1300
 
            match = regex.match(filename)
1301
 
            if match is not None:
1302
 
                # one or more of the groups in mapping will have a non-None
1303
 
                # group match.
1304
 
                groups = match.groups()
1305
 
                rules = [mapping[group] for group in 
1306
 
                    mapping if groups[group] is not None]
1307
 
                return rules[0]
1308
 
        return None
1309
 
 
1310
 
    def kind(self, file_id):
1311
 
        return file_kind(self.id2abspath(file_id))
1312
 
 
1313
 
    def last_revision(self):
1314
 
        """Return the last revision of the branch for this tree.
1315
 
 
1316
 
        This format tree does not support a separate marker for last-revision
1317
 
        compared to the branch.
1318
 
 
1319
 
        See MutableTree.last_revision
1320
 
        """
1321
 
        return self._last_revision()
1322
 
 
1323
 
    @needs_read_lock
1324
 
    def _last_revision(self):
1325
 
        """helper for get_parent_ids."""
1326
 
        return self.branch.last_revision()
1327
 
 
1328
 
    def is_locked(self):
1329
 
        return self._control_files.is_locked()
1330
 
 
1331
 
    def lock_read(self):
1332
 
        """See Branch.lock_read, and WorkingTree.unlock."""
1333
 
        self.branch.lock_read()
1334
 
        try:
1335
 
            return self._control_files.lock_read()
1336
 
        except:
1337
 
            self.branch.unlock()
1338
 
            raise
1339
 
 
1340
 
    def lock_tree_write(self):
1341
 
        """See MutableTree.lock_tree_write, and WorkingTree.unlock."""
1342
 
        self.branch.lock_read()
1343
 
        try:
1344
 
            return self._control_files.lock_write()
1345
 
        except:
1346
 
            self.branch.unlock()
1347
 
            raise
1348
 
 
1349
 
    def lock_write(self):
1350
 
        """See MutableTree.lock_write, and WorkingTree.unlock."""
1351
 
        self.branch.lock_write()
1352
 
        try:
1353
 
            return self._control_files.lock_write()
1354
 
        except:
1355
 
            self.branch.unlock()
1356
 
            raise
1357
 
 
1358
 
    def get_physical_lock_status(self):
1359
 
        return self._control_files.get_physical_lock_status()
1360
 
 
1361
 
    def _basis_inventory_name(self):
1362
 
        return 'basis-inventory-cache'
1363
 
 
1364
 
    @needs_tree_write_lock
1365
 
    def set_last_revision(self, new_revision):
1366
 
        """Change the last revision in the working tree."""
1367
 
        if self._change_last_revision(new_revision):
1368
 
            self._cache_basis_inventory(new_revision)
1369
 
 
1370
 
    def _change_last_revision(self, new_revision):
1371
 
        """Template method part of set_last_revision to perform the change.
1372
 
        
1373
 
        This is used to allow WorkingTree3 instances to not affect branch
1374
 
        when their last revision is set.
1375
 
        """
1376
 
        if new_revision is None:
1377
 
            self.branch.set_revision_history([])
1378
 
            return False
1379
 
        try:
1380
 
            self.branch.generate_revision_history(new_revision)
1381
 
        except errors.NoSuchRevision:
1382
 
            # not present in the repo - dont try to set it deeper than the tip
1383
 
            self.branch.set_revision_history([new_revision])
1384
 
        return True
1385
 
 
1386
 
    def _cache_basis_inventory(self, new_revision):
1387
 
        """Cache new_revision as the basis inventory."""
1388
 
        # TODO: this should allow the ready-to-use inventory to be passed in,
1389
 
        # as commit already has that ready-to-use [while the format is the
1390
 
        # same, that is].
1391
 
        try:
1392
 
            # this double handles the inventory - unpack and repack - 
1393
 
            # but is easier to understand. We can/should put a conditional
1394
 
            # in here based on whether the inventory is in the latest format
1395
 
            # - perhaps we should repack all inventories on a repository
1396
 
            # upgrade ?
1397
 
            # the fast path is to copy the raw xml from the repository. If the
1398
 
            # xml contains 'revision_id="', then we assume the right 
1399
 
            # revision_id is set. We must check for this full string, because a
1400
 
            # root node id can legitimately look like 'revision_id' but cannot
1401
 
            # contain a '"'.
1402
 
            xml = self.branch.repository.get_inventory_xml(new_revision)
1403
 
            firstline = xml.split('\n', 1)[0]
1404
 
            if (not 'revision_id="' in firstline or 
1405
 
                'format="6"' not in firstline):
1406
 
                inv = self.branch.repository.deserialise_inventory(
1407
 
                    new_revision, xml)
1408
 
                inv.revision_id = new_revision
1409
 
                xml = bzrlib.xml6.serializer_v6.write_inventory_to_string(inv)
1410
 
            assert isinstance(xml, str), 'serialised xml must be bytestring.'
1411
 
            path = self._basis_inventory_name()
1412
 
            sio = StringIO(xml)
1413
 
            self._control_files.put(path, sio)
1414
 
        except (errors.NoSuchRevision, errors.RevisionNotPresent):
1415
 
            pass
1416
 
 
1417
 
    def read_basis_inventory(self):
1418
 
        """Read the cached basis inventory."""
1419
 
        path = self._basis_inventory_name()
1420
 
        return self._control_files.get(path).read()
1421
 
        
1422
 
    @needs_read_lock
1423
 
    def read_working_inventory(self):
1424
 
        """Read the working inventory."""
1425
 
        # ElementTree does its own conversion from UTF-8, so open in
1426
 
        # binary.
1427
 
        result = bzrlib.xml5.serializer_v5.read_inventory(
1428
 
            self._control_files.get('inventory'))
1429
 
        self._set_inventory(result)
1430
 
        return result
1431
 
 
1432
 
    @needs_tree_write_lock
1433
 
    def remove(self, files, verbose=False, to_file=None):
1434
 
        """Remove nominated files from the working inventory..
1435
 
 
1436
 
        This does not remove their text.  This does not run on XXX on what? RBC
1437
 
 
1438
 
        TODO: Refuse to remove modified files unless --force is given?
1439
 
 
1440
 
        TODO: Do something useful with directories.
1441
 
 
1442
 
        TODO: Should this remove the text or not?  Tough call; not
1443
 
        removing may be useful and the user can just use use rm, and
1444
 
        is the opposite of add.  Removing it is consistent with most
1445
 
        other tools.  Maybe an option.
1446
 
        """
1447
 
        ## TODO: Normalize names
1448
 
        ## TODO: Remove nested loops; better scalability
1449
 
        if isinstance(files, basestring):
1450
 
            files = [files]
1451
 
 
1452
 
        inv = self.inventory
1453
 
 
1454
 
        # do this before any modifications
1455
 
        for f in files:
1456
 
            fid = inv.path2id(f)
1457
 
            if not fid:
1458
 
                # TODO: Perhaps make this just a warning, and continue?
1459
 
                # This tends to happen when 
1460
 
                raise NotVersionedError(path=f)
1461
 
            if verbose:
1462
 
                # having remove it, it must be either ignored or unknown
1463
 
                if self.is_ignored(f):
1464
 
                    new_status = 'I'
 
359
        
 
360
        for pat in self.get_ignore_list():
 
361
            if '/' in pat or '\\' in pat:
 
362
                
 
363
                # as a special case, you can put ./ at the start of a
 
364
                # pattern; this is good to match in the top-level
 
365
                # only;
 
366
                
 
367
                if (pat[:2] == './') or (pat[:2] == '.\\'):
 
368
                    newpat = pat[2:]
1465
369
                else:
1466
 
                    new_status = '?'
1467
 
                show_status(new_status, inv[fid].kind, f, to_file=to_file)
1468
 
            del inv[fid]
1469
 
 
1470
 
        self._write_inventory(inv)
1471
 
 
1472
 
    @needs_tree_write_lock
1473
 
    def revert(self, filenames, old_tree=None, backups=True, 
1474
 
               pb=DummyProgress()):
1475
 
        from transform import revert
1476
 
        from conflicts import resolve
1477
 
        if old_tree is None:
1478
 
            old_tree = self.basis_tree()
1479
 
        conflicts = revert(self, old_tree, filenames, backups, pb)
1480
 
        if not len(filenames):
1481
 
            self.set_parent_ids(self.get_parent_ids()[:1])
1482
 
            resolve(self)
1483
 
        else:
1484
 
            resolve(self, filenames, ignore_misses=True)
1485
 
        return conflicts
1486
 
 
1487
 
    # XXX: This method should be deprecated in favour of taking in a proper
1488
 
    # new Inventory object.
1489
 
    @needs_tree_write_lock
1490
 
    def set_inventory(self, new_inventory_list):
1491
 
        from bzrlib.inventory import (Inventory,
1492
 
                                      InventoryDirectory,
1493
 
                                      InventoryEntry,
1494
 
                                      InventoryFile,
1495
 
                                      InventoryLink)
1496
 
        inv = Inventory(self.get_root_id())
1497
 
        for path, file_id, parent, kind in new_inventory_list:
1498
 
            name = os.path.basename(path)
1499
 
            if name == "":
1500
 
                continue
1501
 
            # fixme, there should be a factory function inv,add_?? 
1502
 
            if kind == 'directory':
1503
 
                inv.add(InventoryDirectory(file_id, name, parent))
1504
 
            elif kind == 'file':
1505
 
                inv.add(InventoryFile(file_id, name, parent))
1506
 
            elif kind == 'symlink':
1507
 
                inv.add(InventoryLink(file_id, name, parent))
 
370
                    newpat = pat
 
371
                if fnmatch.fnmatchcase(filename, newpat):
 
372
                    return pat
1508
373
            else:
1509
 
                raise BzrError("unknown kind %r" % kind)
1510
 
        self._write_inventory(inv)
1511
 
 
1512
 
    @needs_tree_write_lock
1513
 
    def set_root_id(self, file_id):
1514
 
        """Set the root id for this tree."""
1515
 
        inv = self.read_working_inventory()
1516
 
        orig_root_id = inv.root.file_id
1517
 
        del inv._byid[inv.root.file_id]
1518
 
        inv.root.file_id = file_id
1519
 
        inv._byid[inv.root.file_id] = inv.root
1520
 
        for fid in inv:
1521
 
            entry = inv[fid]
1522
 
            if entry.parent_id == orig_root_id:
1523
 
                entry.parent_id = inv.root.file_id
1524
 
        self._write_inventory(inv)
1525
 
 
1526
 
    def unlock(self):
1527
 
        """See Branch.unlock.
1528
 
        
1529
 
        WorkingTree locking just uses the Branch locking facilities.
1530
 
        This is current because all working trees have an embedded branch
1531
 
        within them. IF in the future, we were to make branch data shareable
1532
 
        between multiple working trees, i.e. via shared storage, then we 
1533
 
        would probably want to lock both the local tree, and the branch.
1534
 
        """
1535
 
        raise NotImplementedError(self.unlock)
1536
 
 
1537
 
    @needs_write_lock
1538
 
    def update(self):
1539
 
        """Update a working tree along its branch.
1540
 
 
1541
 
        This will update the branch if its bound too, which means we have multiple trees involved:
1542
 
        The new basis tree of the master.
1543
 
        The old basis tree of the branch.
1544
 
        The old basis tree of the working tree.
1545
 
        The current working tree state.
1546
 
        pathologically all three may be different, and non ancestors of each other.
1547
 
        Conceptually we want to:
1548
 
        Preserve the wt.basis->wt.state changes
1549
 
        Transform the wt.basis to the new master basis.
1550
 
        Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1551
 
        Restore the wt.basis->wt.state changes.
1552
 
 
1553
 
        There isn't a single operation at the moment to do that, so we:
1554
 
        Merge current state -> basis tree of the master w.r.t. the old tree basis.
1555
 
        Do a 'normal' merge of the old branch basis if it is relevant.
1556
 
        """
1557
 
        old_tip = self.branch.update()
1558
 
        # here if old_tip is not None, it is the old tip of the branch before
1559
 
        # it was updated from the master branch. This should become a pending
1560
 
        # merge in the working tree to preserve the user existing work.  we
1561
 
        # cant set that until we update the working trees last revision to be
1562
 
        # one from the new branch, because it will just get absorbed by the
1563
 
        # parent de-duplication logic.
1564
 
        # 
1565
 
        # We MUST save it even if an error occurs, because otherwise the users
1566
 
        # local work is unreferenced and will appear to have been lost.
1567
 
        # 
1568
 
        result = 0
1569
 
        try:
1570
 
            last_rev = self.get_parent_ids()[0]
1571
 
        except IndexError:
1572
 
            last_rev = None
1573
 
        if last_rev != self.branch.last_revision():
1574
 
            # merge tree state up to new branch tip.
1575
 
            basis = self.basis_tree()
1576
 
            to_tree = self.branch.basis_tree()
1577
 
            result += merge_inner(self.branch,
1578
 
                                  to_tree,
1579
 
                                  basis,
1580
 
                                  this_tree=self)
1581
 
            # TODO - dedup parents list with things merged by pull ?
1582
 
            # reuse the tree we've updated to to set the basis:
1583
 
            parent_trees = [(self.branch.last_revision(), to_tree)]
1584
 
            merges = self.get_parent_ids()[1:]
1585
 
            # Ideally we ask the tree for the trees here, that way the working
1586
 
            # tree can decide whether to give us teh entire tree or give us a
1587
 
            # lazy initialised tree. dirstate for instance will have the trees
1588
 
            # in ram already, whereas a last-revision + basis-inventory tree
1589
 
            # will not, but also does not need them when setting parents.
1590
 
            for parent in merges:
1591
 
                parent_trees.append(
1592
 
                    (parent, self.branch.repository.revision_tree(parent)))
1593
 
            if old_tip is not None:
1594
 
                parent_trees.append(
1595
 
                    (old_tip, self.branch.repository.revision_tree(old_tip)))
1596
 
            self.set_parent_trees(parent_trees)
1597
 
            last_rev = parent_trees[0][0]
 
374
                if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
 
375
                    return pat
1598
376
        else:
1599
 
            # the working tree had the same last-revision as the master
1600
 
            # branch did. We may still have pivot local work from the local
1601
 
            # branch into old_tip:
1602
 
            if old_tip is not None:
1603
 
                self.add_parent_tree_id(old_tip)
1604
 
        if old_tip and old_tip != last_rev:
1605
 
            # our last revision was not the prior branch last revision
1606
 
            # and we have converted that last revision to a pending merge.
1607
 
            # base is somewhere between the branch tip now
1608
 
            # and the now pending merge
1609
 
            from bzrlib.revision import common_ancestor
1610
 
            try:
1611
 
                base_rev_id = common_ancestor(self.branch.last_revision(),
1612
 
                                              old_tip,
1613
 
                                              self.branch.repository)
1614
 
            except errors.NoCommonAncestor:
1615
 
                base_rev_id = None
1616
 
            base_tree = self.branch.repository.revision_tree(base_rev_id)
1617
 
            other_tree = self.branch.repository.revision_tree(old_tip)
1618
 
            result += merge_inner(self.branch,
1619
 
                                  other_tree,
1620
 
                                  base_tree,
1621
 
                                  this_tree=self)
1622
 
        return result
1623
 
 
1624
 
    @needs_tree_write_lock
1625
 
    def _write_inventory(self, inv):
1626
 
        """Write inventory as the current inventory."""
1627
 
        sio = StringIO()
1628
 
        bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1629
 
        sio.seek(0)
1630
 
        self._control_files.put('inventory', sio)
1631
 
        self._set_inventory(inv)
1632
 
        mutter('wrote working inventory')
1633
 
 
1634
 
    def set_conflicts(self, arg):
1635
 
        raise UnsupportedOperation(self.set_conflicts, self)
1636
 
 
1637
 
    def add_conflicts(self, arg):
1638
 
        raise UnsupportedOperation(self.add_conflicts, self)
1639
 
 
1640
 
    @needs_read_lock
1641
 
    def conflicts(self):
1642
 
        conflicts = ConflictList()
1643
 
        for conflicted in self._iter_conflicts():
1644
 
            text = True
1645
 
            try:
1646
 
                if file_kind(self.abspath(conflicted)) != "file":
1647
 
                    text = False
1648
 
            except errors.NoSuchFile:
1649
 
                text = False
1650
 
            if text is True:
1651
 
                for suffix in ('.THIS', '.OTHER'):
1652
 
                    try:
1653
 
                        kind = file_kind(self.abspath(conflicted+suffix))
1654
 
                        if kind != "file":
1655
 
                            text = False
1656
 
                    except errors.NoSuchFile:
1657
 
                        text = False
1658
 
                    if text == False:
1659
 
                        break
1660
 
            ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1661
 
            conflicts.append(Conflict.factory(ctype, path=conflicted,
1662
 
                             file_id=self.path2id(conflicted)))
1663
 
        return conflicts
1664
 
 
1665
 
 
1666
 
class WorkingTree2(WorkingTree):
1667
 
    """This is the Format 2 working tree.
1668
 
 
1669
 
    This was the first weave based working tree. 
1670
 
     - uses os locks for locking.
1671
 
     - uses the branch last-revision.
1672
 
    """
1673
 
 
1674
 
    def lock_tree_write(self):
1675
 
        """See WorkingTree.lock_tree_write().
1676
 
 
1677
 
        In Format2 WorkingTrees we have a single lock for the branch and tree
1678
 
        so lock_tree_write() degrades to lock_write().
1679
 
        """
1680
 
        self.branch.lock_write()
1681
 
        try:
1682
 
            return self._control_files.lock_write()
1683
 
        except:
1684
 
            self.branch.unlock()
1685
 
            raise
1686
 
 
1687
 
    def unlock(self):
1688
 
        # we share control files:
1689
 
        if self._hashcache.needs_write and self._control_files._lock_count==3:
1690
 
            self._hashcache.write()
1691
 
        # reverse order of locking.
1692
 
        try:
1693
 
            return self._control_files.unlock()
1694
 
        finally:
1695
 
            self.branch.unlock()
1696
 
 
1697
 
 
1698
 
class WorkingTree3(WorkingTree):
1699
 
    """This is the Format 3 working tree.
1700
 
 
1701
 
    This differs from the base WorkingTree by:
1702
 
     - having its own file lock
1703
 
     - having its own last-revision property.
1704
 
 
1705
 
    This is new in bzr 0.8
1706
 
    """
1707
 
 
1708
 
    @needs_read_lock
1709
 
    def _last_revision(self):
1710
 
        """See Mutable.last_revision."""
1711
 
        try:
1712
 
            return self._control_files.get_utf8('last-revision').read()
1713
 
        except NoSuchFile:
1714
377
            return None
1715
378
 
1716
 
    def _change_last_revision(self, revision_id):
1717
 
        """See WorkingTree._change_last_revision."""
1718
 
        if revision_id is None or revision_id == NULL_REVISION:
1719
 
            try:
1720
 
                self._control_files._transport.delete('last-revision')
1721
 
            except errors.NoSuchFile:
1722
 
                pass
1723
 
            return False
1724
 
        else:
1725
 
            self._control_files.put_utf8('last-revision', revision_id)
1726
 
            return True
1727
 
 
1728
 
    @needs_tree_write_lock
1729
 
    def set_conflicts(self, conflicts):
1730
 
        self._put_rio('conflicts', conflicts.to_stanzas(), 
1731
 
                      CONFLICT_HEADER_1)
1732
 
 
1733
 
    @needs_tree_write_lock
1734
 
    def add_conflicts(self, new_conflicts):
1735
 
        conflict_set = set(self.conflicts())
1736
 
        conflict_set.update(set(list(new_conflicts)))
1737
 
        self.set_conflicts(ConflictList(sorted(conflict_set,
1738
 
                                               key=Conflict.sort_key)))
1739
 
 
1740
 
    @needs_read_lock
1741
 
    def conflicts(self):
1742
 
        try:
1743
 
            confile = self._control_files.get('conflicts')
1744
 
        except NoSuchFile:
1745
 
            return ConflictList()
1746
 
        try:
1747
 
            if confile.next() != CONFLICT_HEADER_1 + '\n':
1748
 
                raise ConflictFormatError()
1749
 
        except StopIteration:
1750
 
            raise ConflictFormatError()
1751
 
        return ConflictList.from_stanzas(RioReader(confile))
1752
 
 
1753
 
    def unlock(self):
1754
 
        if self._hashcache.needs_write and self._control_files._lock_count==1:
1755
 
            self._hashcache.write()
1756
 
        # reverse order of locking.
1757
 
        try:
1758
 
            return self._control_files.unlock()
1759
 
        finally:
1760
 
            self.branch.unlock()
1761
 
 
1762
 
 
 
379
CONFLICT_SUFFIXES = ('.THIS', '.BASE', '.OTHER')
1763
380
def get_conflicted_stem(path):
1764
381
    for suffix in CONFLICT_SUFFIXES:
1765
382
        if path.endswith(suffix):
1766
383
            return path[:-len(suffix)]
1767
 
 
1768
 
@deprecated_function(zero_eight)
1769
 
def is_control_file(filename):
1770
 
    """See WorkingTree.is_control_filename(filename)."""
1771
 
    ## FIXME: better check
1772
 
    filename = normpath(filename)
1773
 
    while filename != '':
1774
 
        head, tail = os.path.split(filename)
1775
 
        ## mutter('check %r for control file' % ((head, tail),))
1776
 
        if tail == '.bzr':
1777
 
            return True
1778
 
        if filename == head:
1779
 
            break
1780
 
        filename = head
1781
 
    return False
1782
 
 
1783
 
 
1784
 
class WorkingTreeFormat(object):
1785
 
    """An encapsulation of the initialization and open routines for a format.
1786
 
 
1787
 
    Formats provide three things:
1788
 
     * An initialization routine,
1789
 
     * a format string,
1790
 
     * an open routine.
1791
 
 
1792
 
    Formats are placed in an dict by their format string for reference 
1793
 
    during workingtree opening. Its not required that these be instances, they
1794
 
    can be classes themselves with class methods - it simply depends on 
1795
 
    whether state is needed for a given format or not.
1796
 
 
1797
 
    Once a format is deprecated, just deprecate the initialize and open
1798
 
    methods on the format class. Do not deprecate the object, as the 
1799
 
    object will be created every time regardless.
1800
 
    """
1801
 
 
1802
 
    _default_format = None
1803
 
    """The default format used for new trees."""
1804
 
 
1805
 
    _formats = {}
1806
 
    """The known formats."""
1807
 
 
1808
 
    @classmethod
1809
 
    def find_format(klass, a_bzrdir):
1810
 
        """Return the format for the working tree object in a_bzrdir."""
1811
 
        try:
1812
 
            transport = a_bzrdir.get_workingtree_transport(None)
1813
 
            format_string = transport.get("format").read()
1814
 
            return klass._formats[format_string]
1815
 
        except NoSuchFile:
1816
 
            raise errors.NoWorkingTree(base=transport.base)
1817
 
        except KeyError:
1818
 
            raise errors.UnknownFormatError(format=format_string)
1819
 
 
1820
 
    @classmethod
1821
 
    def get_default_format(klass):
1822
 
        """Return the current default format."""
1823
 
        return klass._default_format
1824
 
 
1825
 
    def get_format_string(self):
1826
 
        """Return the ASCII format string that identifies this format."""
1827
 
        raise NotImplementedError(self.get_format_string)
1828
 
 
1829
 
    def get_format_description(self):
1830
 
        """Return the short description for this format."""
1831
 
        raise NotImplementedError(self.get_format_description)
1832
 
 
1833
 
    def is_supported(self):
1834
 
        """Is this format supported?
1835
 
 
1836
 
        Supported formats can be initialized and opened.
1837
 
        Unsupported formats may not support initialization or committing or 
1838
 
        some other features depending on the reason for not being supported.
1839
 
        """
1840
 
        return True
1841
 
 
1842
 
    @classmethod
1843
 
    def register_format(klass, format):
1844
 
        klass._formats[format.get_format_string()] = format
1845
 
 
1846
 
    @classmethod
1847
 
    def set_default_format(klass, format):
1848
 
        klass._default_format = format
1849
 
 
1850
 
    @classmethod
1851
 
    def unregister_format(klass, format):
1852
 
        assert klass._formats[format.get_format_string()] is format
1853
 
        del klass._formats[format.get_format_string()]
1854
 
 
1855
 
 
1856
 
 
1857
 
class WorkingTreeFormat2(WorkingTreeFormat):
1858
 
    """The second working tree format. 
1859
 
 
1860
 
    This format modified the hash cache from the format 1 hash cache.
1861
 
    """
1862
 
 
1863
 
    def get_format_description(self):
1864
 
        """See WorkingTreeFormat.get_format_description()."""
1865
 
        return "Working tree format 2"
1866
 
 
1867
 
    def stub_initialize_remote(self, control_files):
1868
 
        """As a special workaround create critical control files for a remote working tree
1869
 
        
1870
 
        This ensures that it can later be updated and dealt with locally,
1871
 
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with 
1872
 
        no working tree.  (See bug #43064).
1873
 
        """
1874
 
        sio = StringIO()
1875
 
        inv = Inventory()
1876
 
        bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1877
 
        sio.seek(0)
1878
 
        control_files.put('inventory', sio)
1879
 
 
1880
 
        control_files.put_utf8('pending-merges', '')
1881
 
        
1882
 
 
1883
 
    def initialize(self, a_bzrdir, revision_id=None):
1884
 
        """See WorkingTreeFormat.initialize()."""
1885
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
1886
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
1887
 
        branch = a_bzrdir.open_branch()
1888
 
        if revision_id is not None:
1889
 
            branch.lock_write()
1890
 
            try:
1891
 
                revision_history = branch.revision_history()
1892
 
                try:
1893
 
                    position = revision_history.index(revision_id)
1894
 
                except ValueError:
1895
 
                    raise errors.NoSuchRevision(branch, revision_id)
1896
 
                branch.set_revision_history(revision_history[:position + 1])
1897
 
            finally:
1898
 
                branch.unlock()
1899
 
        revision = branch.last_revision()
1900
 
        inv = Inventory()
1901
 
        wt = WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1902
 
                         branch,
1903
 
                         inv,
1904
 
                         _internal=True,
1905
 
                         _format=self,
1906
 
                         _bzrdir=a_bzrdir)
1907
 
        wt._write_inventory(inv)
1908
 
        wt.set_root_id(inv.root.file_id)
1909
 
        basis_tree = branch.repository.revision_tree(revision)
1910
 
        wt.set_parent_trees([(revision, basis_tree)])
1911
 
        build_tree(basis_tree, wt)
1912
 
        return wt
1913
 
 
1914
 
    def __init__(self):
1915
 
        super(WorkingTreeFormat2, self).__init__()
1916
 
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
1917
 
 
1918
 
    def open(self, a_bzrdir, _found=False):
1919
 
        """Return the WorkingTree object for a_bzrdir
1920
 
 
1921
 
        _found is a private parameter, do not use it. It is used to indicate
1922
 
               if format probing has already been done.
1923
 
        """
1924
 
        if not _found:
1925
 
            # we are being called directly and must probe.
1926
 
            raise NotImplementedError
1927
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
1928
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
1929
 
        return WorkingTree2(a_bzrdir.root_transport.local_abspath('.'),
1930
 
                           _internal=True,
1931
 
                           _format=self,
1932
 
                           _bzrdir=a_bzrdir)
1933
 
 
1934
 
 
1935
 
class WorkingTreeFormat3(WorkingTreeFormat):
1936
 
    """The second working tree format updated to record a format marker.
1937
 
 
1938
 
    This format:
1939
 
        - exists within a metadir controlling .bzr
1940
 
        - includes an explicit version marker for the workingtree control
1941
 
          files, separate from the BzrDir format
1942
 
        - modifies the hash cache format
1943
 
        - is new in bzr 0.8
1944
 
        - uses a LockDir to guard access for writes.
1945
 
    """
1946
 
 
1947
 
    def get_format_string(self):
1948
 
        """See WorkingTreeFormat.get_format_string()."""
1949
 
        return "Bazaar-NG Working Tree format 3"
1950
 
 
1951
 
    def get_format_description(self):
1952
 
        """See WorkingTreeFormat.get_format_description()."""
1953
 
        return "Working tree format 3"
1954
 
 
1955
 
    _lock_file_name = 'lock'
1956
 
    _lock_class = LockDir
1957
 
 
1958
 
    def _open_control_files(self, a_bzrdir):
1959
 
        transport = a_bzrdir.get_workingtree_transport(None)
1960
 
        return LockableFiles(transport, self._lock_file_name, 
1961
 
                             self._lock_class)
1962
 
 
1963
 
    def initialize(self, a_bzrdir, revision_id=None):
1964
 
        """See WorkingTreeFormat.initialize().
1965
 
        
1966
 
        revision_id allows creating a working tree at a different
1967
 
        revision than the branch is at.
1968
 
        """
1969
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
1970
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
1971
 
        transport = a_bzrdir.get_workingtree_transport(self)
1972
 
        control_files = self._open_control_files(a_bzrdir)
1973
 
        control_files.create_lock()
1974
 
        control_files.lock_write()
1975
 
        control_files.put_utf8('format', self.get_format_string())
1976
 
        branch = a_bzrdir.open_branch()
1977
 
        if revision_id is None:
1978
 
            revision_id = branch.last_revision()
1979
 
        inv = Inventory() 
1980
 
        wt = WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
1981
 
                         branch,
1982
 
                         inv,
1983
 
                         _internal=True,
1984
 
                         _format=self,
1985
 
                         _bzrdir=a_bzrdir,
1986
 
                         _control_files=control_files)
1987
 
        wt.lock_tree_write()
1988
 
        try:
1989
 
            wt._write_inventory(inv)
1990
 
            wt.set_root_id(inv.root.file_id)
1991
 
            basis_tree = branch.repository.revision_tree(revision_id)
1992
 
            if revision_id == bzrlib.revision.NULL_REVISION:
1993
 
                wt.set_parent_trees([])
1994
 
            else:
1995
 
                wt.set_parent_trees([(revision_id, basis_tree)])
1996
 
            build_tree(basis_tree, wt)
1997
 
        finally:
1998
 
            wt.unlock()
1999
 
            control_files.unlock()
2000
 
        return wt
2001
 
 
2002
 
    def __init__(self):
2003
 
        super(WorkingTreeFormat3, self).__init__()
2004
 
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2005
 
 
2006
 
    def open(self, a_bzrdir, _found=False):
2007
 
        """Return the WorkingTree object for a_bzrdir
2008
 
 
2009
 
        _found is a private parameter, do not use it. It is used to indicate
2010
 
               if format probing has already been done.
2011
 
        """
2012
 
        if not _found:
2013
 
            # we are being called directly and must probe.
2014
 
            raise NotImplementedError
2015
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
2016
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
2017
 
        return self._open(a_bzrdir, self._open_control_files(a_bzrdir))
2018
 
 
2019
 
    def _open(self, a_bzrdir, control_files):
2020
 
        """Open the tree itself.
2021
 
        
2022
 
        :param a_bzrdir: the dir for the tree.
2023
 
        :param control_files: the control files for the tree.
2024
 
        """
2025
 
        return WorkingTree3(a_bzrdir.root_transport.local_abspath('.'),
2026
 
                           _internal=True,
2027
 
                           _format=self,
2028
 
                           _bzrdir=a_bzrdir,
2029
 
                           _control_files=control_files)
2030
 
 
2031
 
    def __str__(self):
2032
 
        return self.get_format_string()
2033
 
 
2034
 
 
2035
 
# formats which have no format string are not discoverable
2036
 
# and not independently creatable, so are not registered.
2037
 
__default_format = WorkingTreeFormat3()
2038
 
WorkingTreeFormat.register_format(__default_format)
2039
 
WorkingTreeFormat.set_default_format(__default_format)
2040
 
_legacy_formats = [WorkingTreeFormat2(),
2041
 
                   ]
2042
 
 
2043
 
 
2044
 
class WorkingTreeTestProviderAdapter(object):
2045
 
    """A tool to generate a suite testing multiple workingtree formats at once.
2046
 
 
2047
 
    This is done by copying the test once for each transport and injecting
2048
 
    the transport_server, transport_readonly_server, and workingtree_format
2049
 
    classes into each copy. Each copy is also given a new id() to make it
2050
 
    easy to identify.
2051
 
    """
2052
 
 
2053
 
    def __init__(self, transport_server, transport_readonly_server, formats):
2054
 
        self._transport_server = transport_server
2055
 
        self._transport_readonly_server = transport_readonly_server
2056
 
        self._formats = formats
2057
 
    
2058
 
    def _clone_test(self, test, bzrdir_format, workingtree_format, variation):
2059
 
        """Clone test for adaption."""
2060
 
        new_test = deepcopy(test)
2061
 
        new_test.transport_server = self._transport_server
2062
 
        new_test.transport_readonly_server = self._transport_readonly_server
2063
 
        new_test.bzrdir_format = bzrdir_format
2064
 
        new_test.workingtree_format = workingtree_format
2065
 
        def make_new_test_id():
2066
 
            new_id = "%s(%s)" % (test.id(), variation)
2067
 
            return lambda: new_id
2068
 
        new_test.id = make_new_test_id()
2069
 
        return new_test
2070
 
    
2071
 
    def adapt(self, test):
2072
 
        from bzrlib.tests import TestSuite
2073
 
        result = TestSuite()
2074
 
        for workingtree_format, bzrdir_format in self._formats:
2075
 
            new_test = self._clone_test(
2076
 
                test,
2077
 
                bzrdir_format,
2078
 
                workingtree_format, workingtree_format.__class__.__name__)
2079
 
            result.addTest(new_test)
2080
 
        return result