~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/workingtree.py

Added more docs

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
 
1
# Copyright (C) 2005 Canonical Ltd
2
2
 
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
25
25
At the moment every WorkingTree has its own branch.  Remote
26
26
WorkingTrees aren't supported.
27
27
 
28
 
To get a WorkingTree, call bzrdir.open_workingtree() or
29
 
WorkingTree.open(dir).
 
28
To get a WorkingTree, call WorkingTree(dir[, branch])
30
29
"""
31
30
 
32
 
MERGE_MODIFIED_HEADER_1 = "BZR merge-modified list format 1"
33
 
CONFLICT_HEADER_1 = "BZR conflict list format 1"
 
31
 
 
32
# FIXME: I don't know if writing out the cache from the destructor is really a
 
33
# good idea, because destructors are considered poor taste in Python, and it's
 
34
# not predictable when it will be written out.
34
35
 
35
36
# TODO: Give the workingtree sole responsibility for the working inventory;
36
37
# remove the variable and references to it from the branch.  This may require
37
38
# updating the commit code so as to update the inventory within the working
38
39
# 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)
 
40
# At the momenthey may alias the inventory and have old copies of it in memory.
41
41
 
42
 
from binascii import hexlify
43
42
from copy import deepcopy
44
43
from cStringIO import StringIO
45
44
import errno
46
45
import fnmatch
47
46
import os
48
 
import re
49
47
import stat
50
 
from time import time
 
48
 
51
49
 
52
50
from bzrlib.atomicfile import AtomicFile
53
51
from bzrlib.branch import (Branch,
 
52
                           BzrBranchFormat4,
 
53
                           BzrBranchFormat5,
 
54
                           BzrBranchFormat6,
 
55
                           is_control_file,
54
56
                           quotefn)
55
 
from bzrlib.conflicts import Conflict, ConflictList, CONFLICT_SUFFIXES
56
 
import bzrlib.bzrdir as bzrdir
57
57
from bzrlib.decorators import needs_read_lock, needs_write_lock
58
 
import bzrlib.errors as errors
59
58
from bzrlib.errors import (BzrCheckError,
60
59
                           BzrError,
61
 
                           ConflictFormatError,
62
60
                           DivergedBranches,
63
61
                           WeaveRevisionNotPresent,
64
62
                           NotBranchError,
65
63
                           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
 
from bzrlib.osutils import (
75
 
                            abspath,
76
 
                            appendpath,
 
64
                           NotVersionedError)
 
65
from bzrlib.inventory import InventoryEntry
 
66
from bzrlib.lockable_files import LockableFiles
 
67
from bzrlib.osutils import (appendpath,
77
68
                            compact_date,
78
69
                            file_kind,
79
70
                            isdir,
82
73
                            pumpfile,
83
74
                            safe_unicode,
84
75
                            splitpath,
85
 
                            rand_chars,
 
76
                            rand_bytes,
 
77
                            abspath,
86
78
                            normpath,
87
79
                            realpath,
88
80
                            relpath,
89
81
                            rename,
90
82
                            supports_executable,
91
83
                            )
92
 
from bzrlib.progress import DummyProgress, ProgressPhase
93
 
from bzrlib.revision import NULL_REVISION
94
 
from bzrlib.rio import RioReader, rio_file, Stanza
95
84
from bzrlib.symbol_versioning import *
96
85
from bzrlib.textui import show_status
97
86
import bzrlib.tree
98
 
from bzrlib.transform import build_tree
99
 
from bzrlib.trace import mutter, note
 
87
from bzrlib.trace import mutter
100
88
from bzrlib.transport import get_transport
101
 
from bzrlib.transport.local import LocalTransport
102
 
import bzrlib.ui
103
89
import bzrlib.xml5
104
90
 
105
91
 
106
 
# the regex here does the following:
107
 
# 1) remove any weird characters; we don't escape them but rather
108
 
# just pull them out
109
 
 # 2) match leading '.'s to make it not hidden
110
 
_gen_file_id_re = re.compile(r'[^\w.]|(^\.*)')
111
 
_gen_id_suffix = None
112
 
_gen_id_serial = 0
113
 
 
114
 
 
115
 
def _next_id_suffix():
116
 
    """Create a new file id suffix that is reasonably unique.
117
 
    
118
 
    On the first call we combine the current time with 64 bits of randomness
119
 
    to give a highly probably globally unique number. Then each call in the same
120
 
    process adds 1 to a serial number we append to that unique value.
121
 
    """
122
 
    # XXX TODO: change bzrlib.add.smart_add to call workingtree.add() rather 
123
 
    # than having to move the id randomness out of the inner loop like this.
124
 
    # XXX TODO: for the global randomness this uses we should add the thread-id
125
 
    # before the serial #.
126
 
    global _gen_id_suffix, _gen_id_serial
127
 
    if _gen_id_suffix is None:
128
 
        _gen_id_suffix = "-%s-%s-" % (compact_date(time()), rand_chars(16))
129
 
    _gen_id_serial += 1
130
 
    return _gen_id_suffix + str(_gen_id_serial)
131
 
 
132
 
 
133
92
def gen_file_id(name):
134
 
    """Return new file id for the basename 'name'.
135
 
 
136
 
    The uniqueness is supplied from _next_id_suffix.
137
 
    """
138
 
    # XXX TODO: squash the filename to lowercase.
139
 
    # XXX TODO: truncate the filename to something like 20 or 30 chars.
140
 
    # XXX TODO: consider what to do with ids that look like illegal filepaths
141
 
    # on platforms we support.
142
 
    return _gen_file_id_re.sub('', name) + _next_id_suffix()
 
93
    """Return new file id.
 
94
 
 
95
    This should probably generate proper UUIDs, but for the moment we
 
96
    cope with just randomness because running uuidgen every time is
 
97
    slow."""
 
98
    import re
 
99
    from binascii import hexlify
 
100
    from time import time
 
101
 
 
102
    # get last component
 
103
    idx = name.rfind('/')
 
104
    if idx != -1:
 
105
        name = name[idx+1 : ]
 
106
    idx = name.rfind('\\')
 
107
    if idx != -1:
 
108
        name = name[idx+1 : ]
 
109
 
 
110
    # make it not a hidden file
 
111
    name = name.lstrip('.')
 
112
 
 
113
    # remove any wierd characters; we don't escape them but rather
 
114
    # just pull them out
 
115
    name = re.sub(r'[^\w.]', '', name)
 
116
 
 
117
    s = hexlify(rand_bytes(8))
 
118
    return '-'.join((name, compact_date(time()), s))
143
119
 
144
120
 
145
121
def gen_root_id():
212
188
    not listed in the Inventory and vice versa.
213
189
    """
214
190
 
215
 
    def __init__(self, basedir='.',
216
 
                 branch=DEPRECATED_PARAMETER,
217
 
                 _inventory=None,
218
 
                 _control_files=None,
219
 
                 _internal=False,
220
 
                 _format=None,
221
 
                 _bzrdir=None):
 
191
    def __init__(self, basedir='.', branch=None, _inventory=None, _control_files=None):
222
192
        """Construct a WorkingTree for basedir.
223
193
 
224
194
        If the branch is not supplied, it is opened automatically.
226
196
        (branch.base is not cross checked, because for remote branches that
227
197
        would be meaningless).
228
198
        """
229
 
        self._format = _format
230
 
        self.bzrdir = _bzrdir
231
 
        if not _internal:
232
 
            # not created via open etc.
233
 
            warn("WorkingTree() is deprecated as of bzr version 0.8. "
234
 
                 "Please use bzrdir.open_workingtree or WorkingTree.open().",
235
 
                 DeprecationWarning,
236
 
                 stacklevel=2)
237
 
            wt = WorkingTree.open(basedir)
238
 
            self._branch = wt.branch
239
 
            self.basedir = wt.basedir
240
 
            self._control_files = wt._control_files
241
 
            self._hashcache = wt._hashcache
242
 
            self._set_inventory(wt._inventory)
243
 
            self._format = wt._format
244
 
            self.bzrdir = wt.bzrdir
245
199
        from bzrlib.hashcache import HashCache
246
200
        from bzrlib.trace import note, mutter
247
201
        assert isinstance(basedir, basestring), \
248
202
            "base directory %r is not a string" % basedir
249
203
        basedir = safe_unicode(basedir)
250
 
        mutter("opening working tree %r", basedir)
251
 
        if deprecated_passed(branch):
252
 
            if not _internal:
253
 
                warn("WorkingTree(..., branch=XXX) is deprecated as of bzr 0.8."
254
 
                     " Please use bzrdir.open_workingtree() or"
255
 
                     " WorkingTree.open().",
256
 
                     DeprecationWarning,
257
 
                     stacklevel=2
258
 
                     )
259
 
            self._branch = branch
260
 
        else:
261
 
            self._branch = self.bzrdir.open_branch()
262
 
        assert isinstance(self.branch, Branch), \
263
 
            "branch %r is not a Branch" % self.branch
 
204
        mutter("openeing working tree %r", basedir)
 
205
        if branch is None:
 
206
            branch = Branch.open(basedir)
 
207
        assert isinstance(branch, Branch), \
 
208
            "branch %r is not a Branch" % branch
 
209
        self.branch = branch
264
210
        self.basedir = realpath(basedir)
265
211
        # if branch is at our basedir and is a format 6 or less
266
 
        if isinstance(self._format, WorkingTreeFormat2):
267
 
            # share control object
 
212
        if (isinstance(self.branch._branch_format,
 
213
                       (BzrBranchFormat4, BzrBranchFormat5, BzrBranchFormat6))
 
214
            # might be able to share control object
 
215
            and self.branch.base.split('/')[-2] == self.basedir.split('/')[-1]):
268
216
            self._control_files = self.branch.control_files
 
217
        elif _control_files is not None:
 
218
            assert False, "not done yet"
 
219
#            self._control_files = _control_files
269
220
        else:
270
 
            # only ready for format 3
271
 
            assert isinstance(self._format, WorkingTreeFormat3)
272
 
            assert isinstance(_control_files, LockableFiles), \
273
 
                    "_control_files must be a LockableFiles, not %r" \
274
 
                    % _control_files
275
 
            self._control_files = _control_files
 
221
            self._control_files = LockableFiles(
 
222
                get_transport(self.basedir).clone(bzrlib.BZRDIR), 'branch-lock')
 
223
 
276
224
        # update the whole cache up front and write to disk if anything changed;
277
225
        # in the future we might want to do this more selectively
278
226
        # two possible ways offer themselves : in self._unlock, write the cache
279
227
        # if needed, or, when the cache sees a change, append it to the hash
280
228
        # cache file, and have the parser take the most recent entry for a
281
229
        # given path only.
282
 
        cache_filename = self.bzrdir.get_workingtree_transport(None).abspath('stat-cache')
283
 
        hc = self._hashcache = HashCache(basedir, cache_filename, self._control_files._file_mode)
 
230
        hc = self._hashcache = HashCache(basedir)
284
231
        hc.read()
285
 
        # is this scan needed ? it makes things kinda slow.
286
232
        hc.scan()
287
233
 
288
234
        if hc.needs_write:
294
240
        else:
295
241
            self._set_inventory(_inventory)
296
242
 
297
 
    branch = property(
298
 
        fget=lambda self: self._branch,
299
 
        doc="""The branch this WorkingTree is connected to.
300
 
 
301
 
            This cannot be set - it is reflective of the actual disk structure
302
 
            the working tree has been constructed from.
303
 
            """)
304
 
 
305
 
    def break_lock(self):
306
 
        """Break a lock if one is present from another instance.
307
 
 
308
 
        Uses the ui factory to ask for confirmation if the lock may be from
309
 
        an active process.
310
 
 
311
 
        This will probe the repository for its lock as well.
312
 
        """
313
 
        self._control_files.break_lock()
314
 
        self.branch.break_lock()
315
 
 
316
243
    def _set_inventory(self, inv):
317
244
        self._inventory = inv
318
245
        self.path2id = self._inventory.path2id
319
246
 
320
 
    def is_control_filename(self, filename):
321
 
        """True if filename is the name of a control file in this tree.
322
 
        
323
 
        :param filename: A filename within the tree. This is a relative path
324
 
        from the root of this tree.
325
 
 
326
 
        This is true IF and ONLY IF the filename is part of the meta data
327
 
        that bzr controls in this tree. I.E. a random .bzr directory placed
328
 
        on disk will not be a control file for this tree.
329
 
        """
330
 
        return self.bzrdir.is_control_filename(filename)
331
 
 
332
 
    @staticmethod
333
 
    def open(path=None, _unsupported=False):
334
 
        """Open an existing working tree at path.
335
 
 
336
 
        """
337
 
        if path is None:
338
 
            path = os.path.getcwdu()
339
 
        control = bzrdir.BzrDir.open(path, _unsupported)
340
 
        return control.open_workingtree(_unsupported)
341
 
        
342
247
    @staticmethod
343
248
    def open_containing(path=None):
344
249
        """Open an existing working tree which has its root about path.
351
256
        If there is one, it is returned, along with the unused portion of path.
352
257
        """
353
258
        if path is None:
354
 
            path = os.getcwdu()
355
 
        control, relpath = bzrdir.BzrDir.open_containing(path)
356
 
        return control.open_workingtree(), relpath
357
 
 
358
 
    @staticmethod
359
 
    def open_downlevel(path=None):
360
 
        """Open an unsupported working tree.
361
 
 
362
 
        Only intended for advanced situations like upgrading part of a bzrdir.
363
 
        """
364
 
        return WorkingTree.open(path, _unsupported=True)
 
259
            path = getcwd()
 
260
        else:
 
261
            # sanity check.
 
262
            if path.find('://') != -1:
 
263
                raise NotBranchError(path=path)
 
264
        path = abspath(path)
 
265
        orig_path = path[:]
 
266
        tail = u''
 
267
        while True:
 
268
            try:
 
269
                return WorkingTree(path), tail
 
270
            except NotBranchError:
 
271
                pass
 
272
            if tail:
 
273
                tail = pathjoin(os.path.basename(path), tail)
 
274
            else:
 
275
                tail = os.path.basename(path)
 
276
            lastpath = path
 
277
            path = os.path.dirname(path)
 
278
            if lastpath == path:
 
279
                # reached the root, whatever that may be
 
280
                raise NotBranchError(path=orig_path)
365
281
 
366
282
    def __iter__(self):
367
283
        """Iterate through file_ids for this tree.
380
296
 
381
297
    def abspath(self, filename):
382
298
        return pathjoin(self.basedir, filename)
383
 
    
384
 
    def basis_tree(self):
385
 
        """Return RevisionTree for the current last revision."""
386
 
        revision_id = self.last_revision()
387
 
        if revision_id is not None:
388
 
            try:
389
 
                xml = self.read_basis_inventory()
390
 
                inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
391
 
            except NoSuchFile:
392
 
                inv = None
393
 
            if inv is not None and inv.revision_id == revision_id:
394
 
                return bzrlib.tree.RevisionTree(self.branch.repository, inv,
395
 
                                                revision_id)
396
 
        # FIXME? RBC 20060403 should we cache the inventory here ?
397
 
        return self.branch.repository.revision_tree(revision_id)
398
299
 
399
300
    @staticmethod
400
 
    @deprecated_method(zero_eight)
401
301
    def create(branch, directory):
402
302
        """Create a workingtree for branch at directory.
403
303
 
413
313
        XXX: When BzrDir is present, these should be created through that 
414
314
        interface instead.
415
315
        """
416
 
        warn('delete WorkingTree.create', stacklevel=3)
417
 
        transport = get_transport(directory)
418
 
        if branch.bzrdir.root_transport.base == transport.base:
419
 
            # same dir 
420
 
            return branch.bzrdir.create_workingtree()
421
 
        # different directory, 
422
 
        # create a branch reference
423
 
        # and now a working tree.
424
 
        raise NotImplementedError
 
316
        try:
 
317
            os.mkdir(directory)
 
318
        except OSError, e:
 
319
            if e.errno != errno.EEXIST:
 
320
                raise
 
321
        try:
 
322
            os.mkdir(pathjoin(directory, '.bzr'))
 
323
        except OSError, e:
 
324
            if e.errno != errno.EEXIST:
 
325
                raise
 
326
        inv = branch.repository.revision_tree(branch.last_revision()).inventory
 
327
        wt = WorkingTree(directory, branch, inv)
 
328
        wt._write_inventory(inv)
 
329
        if branch.last_revision() is not None:
 
330
            wt.set_last_revision(branch.last_revision())
 
331
        wt.set_pending_merges([])
 
332
        wt.revert([])
 
333
        return wt
425
334
 
426
335
    @staticmethod
427
 
    @deprecated_method(zero_eight)
428
336
    def create_standalone(directory):
429
 
        """Create a checkout and a branch and a repo at directory.
 
337
        """Create a checkout and a branch at directory.
430
338
 
431
339
        Directory must exist and be empty.
432
340
 
433
 
        please use BzrDir.create_standalone_workingtree
 
341
        XXX: When BzrDir is present, these should be created through that 
 
342
        interface instead.
434
343
        """
435
 
        return bzrdir.BzrDir.create_standalone_workingtree(directory)
 
344
        directory = safe_unicode(directory)
 
345
        b = Branch.create(directory)
 
346
        return WorkingTree.create(b, directory)
436
347
 
437
 
    def relpath(self, path):
438
 
        """Return the local path portion from a given path.
439
 
        
440
 
        The path may be absolute or relative. If its a relative path it is 
441
 
        interpreted relative to the python current working directory.
442
 
        """
443
 
        return relpath(self.basedir, path)
 
348
    def relpath(self, abs):
 
349
        """Return the local path portion from a given absolute path."""
 
350
        return relpath(self.basedir, abs)
444
351
 
445
352
    def has_filename(self, filename):
446
353
        return bzrlib.osutils.lexists(self.abspath(filename))
460
367
        ## XXX: badly named; this is not in the store at all
461
368
        return self.abspath(self.id2path(file_id))
462
369
 
463
 
    @needs_read_lock
464
 
    def clone(self, to_bzrdir, revision_id=None, basis=None):
465
 
        """Duplicate this working tree into to_bzr, including all state.
466
 
        
467
 
        Specifically modified files are kept as modified, but
468
 
        ignored and unknown files are discarded.
469
 
 
470
 
        If you want to make a new line of development, see bzrdir.sprout()
471
 
 
472
 
        revision
473
 
            If not None, the cloned tree will have its last revision set to 
474
 
            revision, and and difference between the source trees last revision
475
 
            and this one merged in.
476
 
 
477
 
        basis
478
 
            If not None, a closer copy of a tree which may have some files in
479
 
            common, and which file content should be preferentially copied from.
480
 
        """
481
 
        # assumes the target bzr dir format is compatible.
482
 
        result = self._format.initialize(to_bzrdir)
483
 
        self.copy_content_into(result, revision_id)
484
 
        return result
485
 
 
486
 
    @needs_read_lock
487
 
    def copy_content_into(self, tree, revision_id=None):
488
 
        """Copy the current content and user files of this tree into tree."""
489
 
        if revision_id is None:
490
 
            transform_tree(tree, self)
491
 
        else:
492
 
            # TODO now merge from tree.last_revision to revision
493
 
            transform_tree(tree, self)
494
 
            tree.set_last_revision(revision_id)
495
 
 
496
370
    @needs_write_lock
497
 
    def commit(self, message=None, revprops=None, *args, **kwargs):
498
 
        # avoid circular imports
 
371
    def commit(self, *args, **kwargs):
499
372
        from bzrlib.commit import Commit
500
 
        if revprops is None:
501
 
            revprops = {}
502
 
        if not 'branch-nick' in revprops:
503
 
            revprops['branch-nick'] = self.branch.nick
504
373
        # args for wt.commit start at message from the Commit.commit method,
505
374
        # but with branch a kwarg now, passing in args as is results in the
506
375
        #message being used for the branch
507
 
        args = (DEPRECATED_PARAMETER, message, ) + args
508
 
        Commit().commit(working_tree=self, revprops=revprops, *args, **kwargs)
 
376
        args = (DEPRECATED_PARAMETER, ) + args
 
377
        Commit().commit(working_tree=self, *args, **kwargs)
509
378
        self._set_inventory(self.read_working_inventory())
510
379
 
511
380
    def id2abspath(self, file_id):
580
449
 
581
450
        inv = self.read_working_inventory()
582
451
        for f,file_id in zip(files, ids):
583
 
            if self.is_control_filename(f):
 
452
            if is_control_file(f):
584
453
                raise BzrError("cannot add control file %s" % quotefn(f))
585
454
 
586
455
            fp = splitpath(f)
592
461
 
593
462
            try:
594
463
                kind = file_kind(fullpath)
595
 
            except OSError, e:
596
 
                if e.errno == errno.ENOENT:
597
 
                    raise NoSuchFile(fullpath)
 
464
            except OSError:
598
465
                # maybe something better?
599
466
                raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
600
467
 
603
470
                               'i.e. regular file, symlink or directory): %s' % quotefn(f))
604
471
 
605
472
            if file_id is None:
606
 
                inv.add_path(f, kind=kind)
607
 
            else:
608
 
                inv.add_path(f, kind=kind, file_id=file_id)
 
473
                file_id = gen_file_id(f)
 
474
            inv.add_path(f, kind=kind, file_id=file_id)
609
475
 
 
476
            mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
610
477
        self._write_inventory(inv)
611
478
 
612
479
    @needs_write_lock
645
512
    def set_pending_merges(self, rev_list):
646
513
        self._control_files.put_utf8('pending-merges', '\n'.join(rev_list))
647
514
 
648
 
    @needs_write_lock
649
 
    def set_merge_modified(self, modified_hashes):
650
 
        def iter_stanzas():
651
 
            for file_id, hash in modified_hashes.iteritems():
652
 
                yield Stanza(file_id=file_id, hash=hash)
653
 
        self._put_rio('merge-hashes', iter_stanzas(), MERGE_MODIFIED_HEADER_1)
654
 
 
655
 
    @needs_write_lock
656
 
    def _put_rio(self, filename, stanzas, header):
657
 
        my_file = rio_file(stanzas, header)
658
 
        self._control_files.put(filename, my_file)
659
 
 
660
 
    @needs_read_lock
661
 
    def merge_modified(self):
662
 
        try:
663
 
            hashfile = self._control_files.get('merge-hashes')
664
 
        except NoSuchFile:
665
 
            return {}
666
 
        merge_hashes = {}
667
 
        try:
668
 
            if hashfile.next() != MERGE_MODIFIED_HEADER_1 + '\n':
669
 
                raise MergeModifiedFormatError()
670
 
        except StopIteration:
671
 
            raise MergeModifiedFormatError()
672
 
        for s in RioReader(hashfile):
673
 
            file_id = s.get("file_id")
674
 
            if file_id not in self.inventory:
675
 
                continue
676
 
            hash = s.get("hash")
677
 
            if hash == self.get_file_sha1(file_id):
678
 
                merge_hashes[file_id] = hash
679
 
        return merge_hashes
680
 
 
681
515
    def get_symlink_target(self, file_id):
682
516
        return os.readlink(self.id2abspath(file_id))
683
517
 
689
523
        else:
690
524
            return '?'
691
525
 
 
526
 
692
527
    def list_files(self):
693
528
        """Recursively list all files as (path, class, kind, id).
694
529
 
708
543
                ## TODO: If we find a subdirectory with its own .bzr
709
544
                ## directory, then that is a separate tree and we
710
545
                ## should exclude it.
711
 
 
712
 
                # the bzrdir for this tree
713
 
                if self.bzrdir.transport.base.endswith(f + '/'):
 
546
                if bzrlib.BZRDIR == f:
714
547
                    continue
715
548
 
716
549
                # path within tree
887
720
        These are files in the working directory that are not versioned or
888
721
        control files or ignored.
889
722
        
890
 
        >>> from bzrlib.bzrdir import ScratchDir
891
 
        >>> d = ScratchDir(files=['foo', 'foo~'])
892
 
        >>> b = d.open_branch()
893
 
        >>> tree = d.open_workingtree()
 
723
        >>> from bzrlib.branch import ScratchBranch
 
724
        >>> b = ScratchBranch(files=['foo', 'foo~'])
 
725
        >>> tree = WorkingTree(b.base, b)
894
726
        >>> map(str, tree.unknowns())
895
727
        ['foo']
896
728
        >>> tree.add('foo')
904
736
            if not self.is_ignored(subp):
905
737
                yield subp
906
738
 
907
 
    @deprecated_method(zero_eight)
908
739
    def iter_conflicts(self):
909
 
        """List all files in the tree that have text or content conflicts.
910
 
        DEPRECATED.  Use conflicts instead."""
911
 
        return self._iter_conflicts()
912
 
 
913
 
    def _iter_conflicts(self):
914
740
        conflicted = set()
915
741
        for path in (s[0] for s in self.list_files()):
916
742
            stem = get_conflicted_stem(path)
921
747
                yield stem
922
748
 
923
749
    @needs_write_lock
924
 
    def pull(self, source, overwrite=False, stop_revision=None):
925
 
        top_pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
750
    def pull(self, source, overwrite=False):
 
751
        from bzrlib.merge import merge_inner
926
752
        source.lock_read()
927
753
        try:
928
 
            pp = ProgressPhase("Pull phase", 2, top_pb)
929
 
            pp.next_phase()
930
754
            old_revision_history = self.branch.revision_history()
931
 
            basis_tree = self.basis_tree()
932
 
            count = self.branch.pull(source, overwrite, stop_revision)
 
755
            count = self.branch.pull(source, overwrite)
933
756
            new_revision_history = self.branch.revision_history()
934
757
            if new_revision_history != old_revision_history:
935
 
                pp.next_phase()
936
758
                if len(old_revision_history):
937
759
                    other_revision = old_revision_history[-1]
938
760
                else:
939
761
                    other_revision = None
940
762
                repository = self.branch.repository
941
 
                pb = bzrlib.ui.ui_factory.nested_progress_bar()
942
 
                try:
943
 
                    merge_inner(self.branch,
944
 
                                self.branch.basis_tree(),
945
 
                                basis_tree, 
946
 
                                this_tree=self, 
947
 
                                pb=pb)
948
 
                finally:
949
 
                    pb.finished()
 
763
                merge_inner(self.branch,
 
764
                            self.branch.basis_tree(), 
 
765
                            repository.revision_tree(other_revision),
 
766
                            this_tree=self)
950
767
                self.set_last_revision(self.branch.last_revision())
951
768
            return count
952
769
        finally:
953
770
            source.unlock()
954
 
            top_pb.finished()
955
771
 
956
772
    def extras(self):
957
773
        """Yield all unknown files in this WorkingTree.
981
797
                subp = appendpath(path, subf)
982
798
                yield subp
983
799
 
984
 
    def _translate_ignore_rule(self, rule):
985
 
        """Translate a single ignore rule to a regex.
986
 
 
987
 
        There are two types of ignore rules.  Those that do not contain a / are
988
 
        matched against the tail of the filename (that is, they do not care
989
 
        what directory the file is in.)  Rules which do contain a slash must
990
 
        match the entire path.  As a special case, './' at the start of the
991
 
        string counts as a slash in the string but is removed before matching
992
 
        (e.g. ./foo.c, ./src/foo.c)
993
 
 
994
 
        :return: The translated regex.
995
 
        """
996
 
        if rule[:2] in ('./', '.\\'):
997
 
            # rootdir rule
998
 
            result = fnmatch.translate(rule[2:])
999
 
        elif '/' in rule or '\\' in rule:
1000
 
            # path prefix 
1001
 
            result = fnmatch.translate(rule)
1002
 
        else:
1003
 
            # default rule style.
1004
 
            result = "(?:.*/)?(?!.*/)" + fnmatch.translate(rule)
1005
 
        assert result[-1] == '$', "fnmatch.translate did not add the expected $"
1006
 
        return "(" + result + ")"
1007
 
 
1008
 
    def _combine_ignore_rules(self, rules):
1009
 
        """Combine a list of ignore rules into a single regex object.
1010
 
 
1011
 
        Each individual rule is combined with | to form a big regex, which then
1012
 
        has $ added to it to form something like ()|()|()$. The group index for
1013
 
        each subregex's outermost group is placed in a dictionary mapping back 
1014
 
        to the rule. This allows quick identification of the matching rule that
1015
 
        triggered a match.
1016
 
        :return: a list of the compiled regex and the matching-group index 
1017
 
        dictionaries. We return a list because python complains if you try to 
1018
 
        combine more than 100 regexes.
1019
 
        """
1020
 
        result = []
1021
 
        groups = {}
1022
 
        next_group = 0
1023
 
        translated_rules = []
1024
 
        for rule in rules:
1025
 
            translated_rule = self._translate_ignore_rule(rule)
1026
 
            compiled_rule = re.compile(translated_rule)
1027
 
            groups[next_group] = rule
1028
 
            next_group += compiled_rule.groups
1029
 
            translated_rules.append(translated_rule)
1030
 
            if next_group == 99:
1031
 
                result.append((re.compile("|".join(translated_rules)), groups))
1032
 
                groups = {}
1033
 
                next_group = 0
1034
 
                translated_rules = []
1035
 
        if len(translated_rules):
1036
 
            result.append((re.compile("|".join(translated_rules)), groups))
1037
 
        return result
1038
800
 
1039
801
    def ignored_files(self):
1040
802
        """Yield list of PATH, IGNORE_PATTERN"""
1043
805
            if pat != None:
1044
806
                yield subp, pat
1045
807
 
 
808
 
1046
809
    def get_ignore_list(self):
1047
810
        """Return list of ignore patterns.
1048
811
 
1056
819
            f = self.get_file_byname(bzrlib.IGNORE_FILENAME)
1057
820
            l.extend([line.rstrip("\n\r") for line in f.readlines()])
1058
821
        self._ignorelist = l
1059
 
        self._ignore_regex = self._combine_ignore_rules(l)
1060
822
        return l
1061
823
 
1062
 
    def _get_ignore_rules_as_regex(self):
1063
 
        """Return a regex of the ignore rules and a mapping dict.
1064
 
 
1065
 
        :return: (ignore rules compiled regex, dictionary mapping rule group 
1066
 
        indices to original rule.)
1067
 
        """
1068
 
        if getattr(self, '_ignorelist', None) is None:
1069
 
            self.get_ignore_list()
1070
 
        return self._ignore_regex
1071
824
 
1072
825
    def is_ignored(self, filename):
1073
826
        r"""Check whether the filename matches an ignore pattern.
1087
840
        # treat dotfiles correctly and allows * to match /.
1088
841
        # Eventually it should be replaced with something more
1089
842
        # accurate.
1090
 
    
1091
 
        rules = self._get_ignore_rules_as_regex()
1092
 
        for regex, mapping in rules:
1093
 
            match = regex.match(filename)
1094
 
            if match is not None:
1095
 
                # one or more of the groups in mapping will have a non-None group 
1096
 
                # match.
1097
 
                groups = match.groups()
1098
 
                rules = [mapping[group] for group in 
1099
 
                    mapping if groups[group] is not None]
1100
 
                return rules[0]
1101
 
        return None
 
843
        
 
844
        for pat in self.get_ignore_list():
 
845
            if '/' in pat or '\\' in pat:
 
846
                
 
847
                # as a special case, you can put ./ at the start of a
 
848
                # pattern; this is good to match in the top-level
 
849
                # only;
 
850
                
 
851
                if (pat[:2] == './') or (pat[:2] == '.\\'):
 
852
                    newpat = pat[2:]
 
853
                else:
 
854
                    newpat = pat
 
855
                if fnmatch.fnmatchcase(filename, newpat):
 
856
                    return pat
 
857
            else:
 
858
                if fnmatch.fnmatchcase(splitpath(filename)[-1], pat):
 
859
                    return pat
 
860
        else:
 
861
            return None
1102
862
 
1103
863
    def kind(self, file_id):
1104
864
        return file_kind(self.id2abspath(file_id))
1105
865
 
1106
 
    @needs_read_lock
1107
 
    def last_revision(self):
1108
 
        """Return the last revision id of this working tree.
1109
 
 
1110
 
        In early branch formats this was == the branch last_revision,
1111
 
        but that cannot be relied upon - for working tree operations,
1112
 
        always use tree.last_revision().
1113
 
        """
1114
 
        return self.branch.last_revision()
1115
 
 
1116
 
    def is_locked(self):
1117
 
        return self._control_files.is_locked()
1118
 
 
1119
866
    def lock_read(self):
1120
867
        """See Branch.lock_read, and WorkingTree.unlock."""
1121
 
        self.branch.lock_read()
1122
 
        try:
1123
 
            return self._control_files.lock_read()
1124
 
        except:
1125
 
            self.branch.unlock()
1126
 
            raise
 
868
        return self.branch.lock_read()
1127
869
 
1128
870
    def lock_write(self):
1129
871
        """See Branch.lock_write, and WorkingTree.unlock."""
1130
 
        self.branch.lock_write()
1131
 
        try:
1132
 
            return self._control_files.lock_write()
1133
 
        except:
1134
 
            self.branch.unlock()
1135
 
            raise
1136
 
 
1137
 
    def get_physical_lock_status(self):
1138
 
        return self._control_files.get_physical_lock_status()
1139
 
 
1140
 
    def _basis_inventory_name(self):
1141
 
        return 'basis-inventory'
1142
 
 
1143
 
    @needs_write_lock
1144
 
    def set_last_revision(self, new_revision):
1145
 
        """Change the last revision in the working tree."""
1146
 
        if self._change_last_revision(new_revision):
1147
 
            self._cache_basis_inventory(new_revision)
1148
 
 
1149
 
    def _change_last_revision(self, new_revision):
1150
 
        """Template method part of set_last_revision to perform the change.
1151
 
        
1152
 
        This is used to allow WorkingTree3 instances to not affect branch
1153
 
        when their last revision is set.
1154
 
        """
1155
 
        if new_revision is None:
1156
 
            self.branch.set_revision_history([])
1157
 
            return False
1158
 
        # current format is locked in with the branch
1159
 
        revision_history = self.branch.revision_history()
1160
 
        try:
1161
 
            position = revision_history.index(new_revision)
1162
 
        except ValueError:
1163
 
            raise errors.NoSuchRevision(self.branch, new_revision)
1164
 
        self.branch.set_revision_history(revision_history[:position + 1])
1165
 
        return True
1166
 
 
1167
 
    def _cache_basis_inventory(self, new_revision):
1168
 
        """Cache new_revision as the basis inventory."""
1169
 
        try:
1170
 
            # this double handles the inventory - unpack and repack - 
1171
 
            # but is easier to understand. We can/should put a conditional
1172
 
            # in here based on whether the inventory is in the latest format
1173
 
            # - perhaps we should repack all inventories on a repository
1174
 
            # upgrade ?
1175
 
            inv = self.branch.repository.get_inventory(new_revision)
1176
 
            inv.revision_id = new_revision
1177
 
            xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1178
 
 
1179
 
            path = self._basis_inventory_name()
1180
 
            self._control_files.put_utf8(path, xml)
 
872
        return self.branch.lock_write()
 
873
 
 
874
    def _basis_inventory_name(self, revision_id):
 
875
        return 'basis-inventory.%s' % revision_id
 
876
 
 
877
    def set_last_revision(self, new_revision, old_revision=None):
 
878
        if old_revision is not None:
 
879
            try:
 
880
                path = self._basis_inventory_name(old_revision)
 
881
                path = self.branch.control_files._escape(path)
 
882
                self.branch.control_files._transport.delete(path)
 
883
            except NoSuchFile:
 
884
                pass
 
885
        try:
 
886
            xml = self.branch.repository.get_inventory_xml(new_revision)
 
887
            path = self._basis_inventory_name(new_revision)
 
888
            self.branch.control_files.put_utf8(path, xml)
1181
889
        except WeaveRevisionNotPresent:
1182
890
            pass
1183
891
 
1184
 
    def read_basis_inventory(self):
 
892
    def read_basis_inventory(self, revision_id):
1185
893
        """Read the cached basis inventory."""
1186
 
        path = self._basis_inventory_name()
1187
 
        return self._control_files.get_utf8(path).read()
 
894
        path = self._basis_inventory_name(revision_id)
 
895
        return self.branch.control_files.get_utf8(path).read()
1188
896
        
1189
897
    @needs_read_lock
1190
898
    def read_working_inventory(self):
1191
899
        """Read the working inventory."""
1192
900
        # ElementTree does its own conversion from UTF-8, so open in
1193
901
        # binary.
1194
 
        result = bzrlib.xml5.serializer_v5.read_inventory(
 
902
        return bzrlib.xml5.serializer_v5.read_inventory(
1195
903
            self._control_files.get('inventory'))
1196
 
        self._set_inventory(result)
1197
 
        return result
1198
904
 
1199
905
    @needs_write_lock
1200
906
    def remove(self, files, verbose=False):
1238
944
        self._write_inventory(inv)
1239
945
 
1240
946
    @needs_write_lock
1241
 
    def revert(self, filenames, old_tree=None, backups=True, 
1242
 
               pb=DummyProgress()):
 
947
    def revert(self, filenames, old_tree=None, backups=True):
1243
948
        from transform import revert
1244
 
        from conflicts import resolve
1245
949
        if old_tree is None:
1246
 
            old_tree = self.basis_tree()
1247
 
        conflicts = revert(self, old_tree, filenames, backups, pb)
 
950
            old_tree = self.branch.basis_tree()
 
951
        revert(self, old_tree, filenames, backups)
1248
952
        if not len(filenames):
1249
953
            self.set_pending_merges([])
1250
 
            resolve(self)
1251
 
        else:
1252
 
            resolve(self, filenames, ignore_misses=True)
1253
 
        return conflicts
1254
954
 
1255
 
    # XXX: This method should be deprecated in favour of taking in a proper
1256
 
    # new Inventory object.
1257
955
    @needs_write_lock
1258
956
    def set_inventory(self, new_inventory_list):
1259
957
        from bzrlib.inventory import (Inventory,
1287
985
        inv._byid[inv.root.file_id] = inv.root
1288
986
        for fid in inv:
1289
987
            entry = inv[fid]
1290
 
            if entry.parent_id == orig_root_id:
 
988
            if entry.parent_id in (None, orig_root_id):
1291
989
                entry.parent_id = inv.root.file_id
1292
990
        self._write_inventory(inv)
1293
991
 
1305
1003
        # of a nasty hack; probably it's better to have a transaction object,
1306
1004
        # which can do some finalization when it's either successfully or
1307
1005
        # unsuccessfully completed.  (Denys's original patch did that.)
1308
 
        # RBC 20060206 hookinhg into transaction will couple lock and transaction
1309
 
        # wrongly. Hookinh into unllock on the control files object is fine though.
1310
 
        
1311
 
        # TODO: split this per format so there is no ugly if block
1312
 
        if self._hashcache.needs_write and (
1313
 
            # dedicated lock files
1314
 
            self._control_files._lock_count==1 or 
1315
 
            # shared lock files
1316
 
            (self._control_files is self.branch.control_files and 
1317
 
             self._control_files._lock_count==3)):
 
1006
        if self._hashcache.needs_write and self.branch.control_files._lock_count==1:
1318
1007
            self._hashcache.write()
1319
 
        # reverse order of locking.
1320
 
        try:
1321
 
            return self._control_files.unlock()
1322
 
        finally:
1323
 
            self.branch.unlock()
1324
 
 
1325
 
    @needs_write_lock
1326
 
    def update(self):
1327
 
        """Update a working tree along its branch.
1328
 
 
1329
 
        This will update the branch if its bound too, which means we have multiple trees involved:
1330
 
        The new basis tree of the master.
1331
 
        The old basis tree of the branch.
1332
 
        The old basis tree of the working tree.
1333
 
        The current working tree state.
1334
 
        pathologically all three may be different, and non ancestors of each other.
1335
 
        Conceptually we want to:
1336
 
        Preserve the wt.basis->wt.state changes
1337
 
        Transform the wt.basis to the new master basis.
1338
 
        Apply a merge of the old branch basis to get any 'local' changes from it into the tree.
1339
 
        Restore the wt.basis->wt.state changes.
1340
 
 
1341
 
        There isn't a single operation at the moment to do that, so we:
1342
 
        Merge current state -> basis tree of the master w.r.t. the old tree basis.
1343
 
        Do a 'normal' merge of the old branch basis if it is relevant.
1344
 
        """
1345
 
        old_tip = self.branch.update()
1346
 
        if old_tip is not None:
1347
 
            self.add_pending_merge(old_tip)
1348
 
        self.branch.lock_read()
1349
 
        try:
1350
 
            result = 0
1351
 
            if self.last_revision() != self.branch.last_revision():
1352
 
                # merge tree state up to new branch tip.
1353
 
                basis = self.basis_tree()
1354
 
                to_tree = self.branch.basis_tree()
1355
 
                result += merge_inner(self.branch,
1356
 
                                      to_tree,
1357
 
                                      basis,
1358
 
                                      this_tree=self)
1359
 
                self.set_last_revision(self.branch.last_revision())
1360
 
            if old_tip and old_tip != self.last_revision():
1361
 
                # our last revision was not the prior branch last reivison
1362
 
                # and we have converted that last revision to a pending merge.
1363
 
                # base is somewhere between the branch tip now
1364
 
                # and the now pending merge
1365
 
                from bzrlib.revision import common_ancestor
1366
 
                try:
1367
 
                    base_rev_id = common_ancestor(self.branch.last_revision(),
1368
 
                                                  old_tip,
1369
 
                                                  self.branch.repository)
1370
 
                except errors.NoCommonAncestor:
1371
 
                    base_rev_id = None
1372
 
                base_tree = self.branch.repository.revision_tree(base_rev_id)
1373
 
                other_tree = self.branch.repository.revision_tree(old_tip)
1374
 
                result += merge_inner(self.branch,
1375
 
                                      other_tree,
1376
 
                                      base_tree,
1377
 
                                      this_tree=self)
1378
 
            return result
1379
 
        finally:
1380
 
            self.branch.unlock()
 
1008
        return self.branch.unlock()
1381
1009
 
1382
1010
    @needs_write_lock
1383
1011
    def _write_inventory(self, inv):
1388
1016
        self._control_files.put('inventory', sio)
1389
1017
        self._set_inventory(inv)
1390
1018
        mutter('wrote working inventory')
1391
 
 
1392
 
    def set_conflicts(self, arg):
1393
 
        raise UnsupportedOperation(self.set_conflicts, self)
1394
 
 
1395
 
    @needs_read_lock
1396
 
    def conflicts(self):
1397
 
        conflicts = ConflictList()
1398
 
        for conflicted in self._iter_conflicts():
1399
 
            text = True
1400
 
            try:
1401
 
                if file_kind(self.abspath(conflicted)) != "file":
1402
 
                    text = False
1403
 
            except OSError, e:
1404
 
                if e.errno == errno.ENOENT:
1405
 
                    text = False
1406
 
                else:
1407
 
                    raise
1408
 
            if text is True:
1409
 
                for suffix in ('.THIS', '.OTHER'):
1410
 
                    try:
1411
 
                        kind = file_kind(self.abspath(conflicted+suffix))
1412
 
                    except OSError, e:
1413
 
                        if e.errno == errno.ENOENT:
1414
 
                            text = False
1415
 
                            break
1416
 
                        else:
1417
 
                            raise
1418
 
                    if kind != "file":
1419
 
                        text = False
1420
 
                        break
1421
 
            ctype = {True: 'text conflict', False: 'contents conflict'}[text]
1422
 
            conflicts.append(Conflict.factory(ctype, path=conflicted,
1423
 
                             file_id=self.path2id(conflicted)))
1424
 
        return conflicts
1425
 
 
1426
 
 
1427
 
class WorkingTree3(WorkingTree):
1428
 
    """This is the Format 3 working tree.
1429
 
 
1430
 
    This differs from the base WorkingTree by:
1431
 
     - having its own file lock
1432
 
     - having its own last-revision property.
1433
 
 
1434
 
    This is new in bzr 0.8
1435
 
    """
1436
 
 
1437
 
    @needs_read_lock
1438
 
    def last_revision(self):
1439
 
        """See WorkingTree.last_revision."""
1440
 
        try:
1441
 
            return self._control_files.get_utf8('last-revision').read()
1442
 
        except NoSuchFile:
1443
 
            return None
1444
 
 
1445
 
    def _change_last_revision(self, revision_id):
1446
 
        """See WorkingTree._change_last_revision."""
1447
 
        if revision_id is None or revision_id == NULL_REVISION:
1448
 
            try:
1449
 
                self._control_files._transport.delete('last-revision')
1450
 
            except errors.NoSuchFile:
1451
 
                pass
1452
 
            return False
1453
 
        else:
1454
 
            try:
1455
 
                self.branch.revision_history().index(revision_id)
1456
 
            except ValueError:
1457
 
                raise errors.NoSuchRevision(self.branch, revision_id)
1458
 
            self._control_files.put_utf8('last-revision', revision_id)
1459
 
            return True
1460
 
 
1461
 
    @needs_write_lock
1462
 
    def set_conflicts(self, conflicts):
1463
 
        self._put_rio('conflicts', conflicts.to_stanzas(), 
1464
 
                      CONFLICT_HEADER_1)
1465
 
 
1466
 
    @needs_read_lock
1467
 
    def conflicts(self):
1468
 
        try:
1469
 
            confile = self._control_files.get('conflicts')
1470
 
        except NoSuchFile:
1471
 
            return ConflictList()
1472
 
        try:
1473
 
            if confile.next() != CONFLICT_HEADER_1 + '\n':
1474
 
                raise ConflictFormatError()
1475
 
        except StopIteration:
1476
 
            raise ConflictFormatError()
1477
 
        return ConflictList.from_stanzas(RioReader(confile))
1478
 
 
1479
 
 
 
1019
            
 
1020
 
 
1021
CONFLICT_SUFFIXES = ('.THIS', '.BASE', '.OTHER')
1480
1022
def get_conflicted_stem(path):
1481
1023
    for suffix in CONFLICT_SUFFIXES:
1482
1024
        if path.endswith(suffix):
1483
1025
            return path[:-len(suffix)]
1484
 
 
1485
 
@deprecated_function(zero_eight)
1486
 
def is_control_file(filename):
1487
 
    """See WorkingTree.is_control_filename(filename)."""
1488
 
    ## FIXME: better check
1489
 
    filename = normpath(filename)
1490
 
    while filename != '':
1491
 
        head, tail = os.path.split(filename)
1492
 
        ## mutter('check %r for control file' % ((head, tail),))
1493
 
        if tail == '.bzr':
1494
 
            return True
1495
 
        if filename == head:
1496
 
            break
1497
 
        filename = head
1498
 
    return False
1499
 
 
1500
 
 
1501
 
class WorkingTreeFormat(object):
1502
 
    """An encapsulation of the initialization and open routines for a format.
1503
 
 
1504
 
    Formats provide three things:
1505
 
     * An initialization routine,
1506
 
     * a format string,
1507
 
     * an open routine.
1508
 
 
1509
 
    Formats are placed in an dict by their format string for reference 
1510
 
    during workingtree opening. Its not required that these be instances, they
1511
 
    can be classes themselves with class methods - it simply depends on 
1512
 
    whether state is needed for a given format or not.
1513
 
 
1514
 
    Once a format is deprecated, just deprecate the initialize and open
1515
 
    methods on the format class. Do not deprecate the object, as the 
1516
 
    object will be created every time regardless.
1517
 
    """
1518
 
 
1519
 
    _default_format = None
1520
 
    """The default format used for new trees."""
1521
 
 
1522
 
    _formats = {}
1523
 
    """The known formats."""
1524
 
 
1525
 
    @classmethod
1526
 
    def find_format(klass, a_bzrdir):
1527
 
        """Return the format for the working tree object in a_bzrdir."""
1528
 
        try:
1529
 
            transport = a_bzrdir.get_workingtree_transport(None)
1530
 
            format_string = transport.get("format").read()
1531
 
            return klass._formats[format_string]
1532
 
        except NoSuchFile:
1533
 
            raise errors.NoWorkingTree(base=transport.base)
1534
 
        except KeyError:
1535
 
            raise errors.UnknownFormatError(format_string)
1536
 
 
1537
 
    @classmethod
1538
 
    def get_default_format(klass):
1539
 
        """Return the current default format."""
1540
 
        return klass._default_format
1541
 
 
1542
 
    def get_format_string(self):
1543
 
        """Return the ASCII format string that identifies this format."""
1544
 
        raise NotImplementedError(self.get_format_string)
1545
 
 
1546
 
    def get_format_description(self):
1547
 
        """Return the short description for this format."""
1548
 
        raise NotImplementedError(self.get_format_description)
1549
 
 
1550
 
    def is_supported(self):
1551
 
        """Is this format supported?
1552
 
 
1553
 
        Supported formats can be initialized and opened.
1554
 
        Unsupported formats may not support initialization or committing or 
1555
 
        some other features depending on the reason for not being supported.
1556
 
        """
1557
 
        return True
1558
 
 
1559
 
    @classmethod
1560
 
    def register_format(klass, format):
1561
 
        klass._formats[format.get_format_string()] = format
1562
 
 
1563
 
    @classmethod
1564
 
    def set_default_format(klass, format):
1565
 
        klass._default_format = format
1566
 
 
1567
 
    @classmethod
1568
 
    def unregister_format(klass, format):
1569
 
        assert klass._formats[format.get_format_string()] is format
1570
 
        del klass._formats[format.get_format_string()]
1571
 
 
1572
 
 
1573
 
 
1574
 
class WorkingTreeFormat2(WorkingTreeFormat):
1575
 
    """The second working tree format. 
1576
 
 
1577
 
    This format modified the hash cache from the format 1 hash cache.
1578
 
    """
1579
 
 
1580
 
    def get_format_description(self):
1581
 
        """See WorkingTreeFormat.get_format_description()."""
1582
 
        return "Working tree format 2"
1583
 
 
1584
 
    def stub_initialize_remote(self, control_files):
1585
 
        """As a special workaround create critical control files for a remote working tree
1586
 
        
1587
 
        This ensures that it can later be updated and dealt with locally,
1588
 
        since BzrDirFormat6 and BzrDirFormat5 cannot represent dirs with 
1589
 
        no working tree.  (See bug #43064).
1590
 
        """
1591
 
        sio = StringIO()
1592
 
        inv = Inventory()
1593
 
        bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
1594
 
        sio.seek(0)
1595
 
        control_files.put('inventory', sio)
1596
 
 
1597
 
        control_files.put_utf8('pending-merges', '')
1598
 
        
1599
 
 
1600
 
    def initialize(self, a_bzrdir, revision_id=None):
1601
 
        """See WorkingTreeFormat.initialize()."""
1602
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
1603
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
1604
 
        branch = a_bzrdir.open_branch()
1605
 
        if revision_id is not None:
1606
 
            branch.lock_write()
1607
 
            try:
1608
 
                revision_history = branch.revision_history()
1609
 
                try:
1610
 
                    position = revision_history.index(revision_id)
1611
 
                except ValueError:
1612
 
                    raise errors.NoSuchRevision(branch, revision_id)
1613
 
                branch.set_revision_history(revision_history[:position + 1])
1614
 
            finally:
1615
 
                branch.unlock()
1616
 
        revision = branch.last_revision()
1617
 
        inv = Inventory() 
1618
 
        wt = WorkingTree(a_bzrdir.root_transport.base,
1619
 
                         branch,
1620
 
                         inv,
1621
 
                         _internal=True,
1622
 
                         _format=self,
1623
 
                         _bzrdir=a_bzrdir)
1624
 
        wt._write_inventory(inv)
1625
 
        wt.set_root_id(inv.root.file_id)
1626
 
        wt.set_last_revision(revision)
1627
 
        wt.set_pending_merges([])
1628
 
        build_tree(wt.basis_tree(), wt)
1629
 
        return wt
1630
 
 
1631
 
    def __init__(self):
1632
 
        super(WorkingTreeFormat2, self).__init__()
1633
 
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
1634
 
 
1635
 
    def open(self, a_bzrdir, _found=False):
1636
 
        """Return the WorkingTree object for a_bzrdir
1637
 
 
1638
 
        _found is a private parameter, do not use it. It is used to indicate
1639
 
               if format probing has already been done.
1640
 
        """
1641
 
        if not _found:
1642
 
            # we are being called directly and must probe.
1643
 
            raise NotImplementedError
1644
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
1645
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
1646
 
        return WorkingTree(a_bzrdir.root_transport.base,
1647
 
                           _internal=True,
1648
 
                           _format=self,
1649
 
                           _bzrdir=a_bzrdir)
1650
 
 
1651
 
 
1652
 
class WorkingTreeFormat3(WorkingTreeFormat):
1653
 
    """The second working tree format updated to record a format marker.
1654
 
 
1655
 
    This format:
1656
 
        - exists within a metadir controlling .bzr
1657
 
        - includes an explicit version marker for the workingtree control
1658
 
          files, separate from the BzrDir format
1659
 
        - modifies the hash cache format
1660
 
        - is new in bzr 0.8
1661
 
        - uses a LockDir to guard access to the repository
1662
 
    """
1663
 
 
1664
 
    def get_format_string(self):
1665
 
        """See WorkingTreeFormat.get_format_string()."""
1666
 
        return "Bazaar-NG Working Tree format 3"
1667
 
 
1668
 
    def get_format_description(self):
1669
 
        """See WorkingTreeFormat.get_format_description()."""
1670
 
        return "Working tree format 3"
1671
 
 
1672
 
    _lock_file_name = 'lock'
1673
 
    _lock_class = LockDir
1674
 
 
1675
 
    def _open_control_files(self, a_bzrdir):
1676
 
        transport = a_bzrdir.get_workingtree_transport(None)
1677
 
        return LockableFiles(transport, self._lock_file_name, 
1678
 
                             self._lock_class)
1679
 
 
1680
 
    def initialize(self, a_bzrdir, revision_id=None):
1681
 
        """See WorkingTreeFormat.initialize().
1682
 
        
1683
 
        revision_id allows creating a working tree at a differnet
1684
 
        revision than the branch is at.
1685
 
        """
1686
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
1687
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
1688
 
        transport = a_bzrdir.get_workingtree_transport(self)
1689
 
        control_files = self._open_control_files(a_bzrdir)
1690
 
        control_files.create_lock()
1691
 
        control_files.lock_write()
1692
 
        control_files.put_utf8('format', self.get_format_string())
1693
 
        branch = a_bzrdir.open_branch()
1694
 
        if revision_id is None:
1695
 
            revision_id = branch.last_revision()
1696
 
        inv = Inventory() 
1697
 
        wt = WorkingTree3(a_bzrdir.root_transport.base,
1698
 
                         branch,
1699
 
                         inv,
1700
 
                         _internal=True,
1701
 
                         _format=self,
1702
 
                         _bzrdir=a_bzrdir,
1703
 
                         _control_files=control_files)
1704
 
        wt.lock_write()
1705
 
        try:
1706
 
            wt._write_inventory(inv)
1707
 
            wt.set_root_id(inv.root.file_id)
1708
 
            wt.set_last_revision(revision_id)
1709
 
            wt.set_pending_merges([])
1710
 
            build_tree(wt.basis_tree(), wt)
1711
 
        finally:
1712
 
            wt.unlock()
1713
 
            control_files.unlock()
1714
 
        return wt
1715
 
 
1716
 
    def __init__(self):
1717
 
        super(WorkingTreeFormat3, self).__init__()
1718
 
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1719
 
 
1720
 
    def open(self, a_bzrdir, _found=False):
1721
 
        """Return the WorkingTree object for a_bzrdir
1722
 
 
1723
 
        _found is a private parameter, do not use it. It is used to indicate
1724
 
               if format probing has already been done.
1725
 
        """
1726
 
        if not _found:
1727
 
            # we are being called directly and must probe.
1728
 
            raise NotImplementedError
1729
 
        if not isinstance(a_bzrdir.transport, LocalTransport):
1730
 
            raise errors.NotLocalUrl(a_bzrdir.transport.base)
1731
 
        control_files = self._open_control_files(a_bzrdir)
1732
 
        return WorkingTree3(a_bzrdir.root_transport.base,
1733
 
                           _internal=True,
1734
 
                           _format=self,
1735
 
                           _bzrdir=a_bzrdir,
1736
 
                           _control_files=control_files)
1737
 
 
1738
 
    def __str__(self):
1739
 
        return self.get_format_string()
1740
 
 
1741
 
 
1742
 
# formats which have no format string are not discoverable
1743
 
# and not independently creatable, so are not registered.
1744
 
__default_format = WorkingTreeFormat3()
1745
 
WorkingTreeFormat.register_format(__default_format)
1746
 
WorkingTreeFormat.set_default_format(__default_format)
1747
 
_legacy_formats = [WorkingTreeFormat2(),
1748
 
                   ]
1749
 
 
1750
 
 
1751
 
class WorkingTreeTestProviderAdapter(object):
1752
 
    """A tool to generate a suite testing multiple workingtree formats at once.
1753
 
 
1754
 
    This is done by copying the test once for each transport and injecting
1755
 
    the transport_server, transport_readonly_server, and workingtree_format
1756
 
    classes into each copy. Each copy is also given a new id() to make it
1757
 
    easy to identify.
1758
 
    """
1759
 
 
1760
 
    def __init__(self, transport_server, transport_readonly_server, formats):
1761
 
        self._transport_server = transport_server
1762
 
        self._transport_readonly_server = transport_readonly_server
1763
 
        self._formats = formats
1764
 
    
1765
 
    def adapt(self, test):
1766
 
        from bzrlib.tests import TestSuite
1767
 
        result = TestSuite()
1768
 
        for workingtree_format, bzrdir_format in self._formats:
1769
 
            new_test = deepcopy(test)
1770
 
            new_test.transport_server = self._transport_server
1771
 
            new_test.transport_readonly_server = self._transport_readonly_server
1772
 
            new_test.bzrdir_format = bzrdir_format
1773
 
            new_test.workingtree_format = workingtree_format
1774
 
            def make_new_test_id():
1775
 
                new_id = "%s(%s)" % (new_test.id(), workingtree_format.__class__.__name__)
1776
 
                return lambda: new_id
1777
 
            new_test.id = make_new_test_id()
1778
 
            result.addTest(new_test)
1779
 
        return result